os_mem.c

avr ucos 代码 测试环境：source insight WINAVR 4个进程

/*
*********************************************************************************************************
*                                                uC/OS-II
*                                          The Real-Time Kernel
*                                            MEMORY MANAGEMENT
*
*                          (c) Copyright 1992-2002, Jean J. Labrosse, Weston, FL
*                                           All Rights Reserved
*
* File : OS_MEM.C
* By   : Jean J. Labrosse
*********************************************************************************************************
*/

#ifndef  OS_MASTER_FILE
#include "includes.h"
#endif

#if (OS_MEM_EN > 0) && (OS_MAX_MEM_PART > 0)//允许包含内在管理代码且内在分区数大于0
/*
*********************************************************************************************************
*                                        CREATE A MEMORY PARTITION
*
* Description : Create a fixed-sized memory partition that will be managed by uC/OS-II.
*
* Arguments   : addr     is the starting address of the memory partition
*
*               nblks    is the number of memory blocks to create from the partition.
*
*               blksize  is the size (in bytes) of each block in the memory partition.
*
*               err      is a pointer to a variable containing an error message which will be set by
*                        this function to either:
*
*                        OS_NO_ERR            if the memory partition has been created correctly.
*                        OS_MEM_INVALID_ADDR  you are specifying an invalid address for the memory 
*                                             storage of the partition.
*                        OS_MEM_INVALID_PART  no free partitions available
*                        OS_MEM_INVALID_BLKS  user specified an invalid number of blocks (must be >= 2)
*                        OS_MEM_INVALID_SIZE  user specified an invalid block size
*                                             (must be greater than the size of a pointer)
* Returns    : != (OS_MEM *)0  is the partition was created
*              == (OS_MEM *)0  if the partition was not created because of invalid arguments or, no
*                              free partition is available.
*********************************************************************************************************
*/
/*
*********************************************************************************************************
                                                           建立一个内存分区
描述：建立一个可由ucosII管理的大小固定的内存块
参数：addr ：内存分区的起始地址
          nblks：从分割区中要建立内在块的数目
          blksize：内在分割区中每块内存的大小（用字节表示）
           err：是由下列函数决定的，包含错误信息的可变指针：
               OS_NO_ERR：如果内存块建立正确
               OS_MEM_INVALID_ADDR：你为分割区的内在空间指定了不可用地址
               OS_MEM_INVALID_PART：没有多余的区域了。
               OS_MEM_INVALID_BLKS：用户指定分割数目不合法（必须大于等于2）
               OS_MEM_INVALID_SIZE：用户指定了非法的内存块大小（必须大于指针的大小）
返回： != (OS_MEM *)0：分区已经建立
            == (OS_MEM *)0：因为非法参数或者没有空余块而没有建立分区

*********************************************************************************************************
*/


OS_MEM  *OSMemCreate (void *addr, INT32U nblks, INT32U blksize, INT8U *err)
{
#if OS_CRITICAL_METHOD == 3                           /* Allocate storage for CPU status register      */
    OS_CPU_SR  cpu_sr;//typedef unsigned int OS_CPU_SR
#endif    
    OS_MEM    *pmem;//内存控制块数据结构
    INT8U     *pblk;
    void     **plink;//指向指针的指针
    INT32U     i;


#if OS_ARG_CHK_EN > 0//允许参数检验
    if (addr == (void *)0) {                          /* Must pass a valid address for the memory part. */
        *err = OS_MEM_INVALID_ADDR;//要为内存块建立一个合法地址，即地址要有效
        return ((OS_MEM *)0);//返回
    }
    if (nblks < 2) {                                  /* Must have at least 2 blocks per partition      */
        *err = OS_MEM_INVALID_BLKS;//内存分块太少了，必须最小两块
        return ((OS_MEM *)0);
    }
    if (blksize < sizeof(void *)) {                   /* Must contain space for at least a pointer      */
        *err = OS_MEM_INVALID_SIZE;//每个内存块至少要容不得得下一个指针，因为
        //同一分区中的所有空余内在块是由指针链串联起来的。
        return ((OS_MEM *)0);
    }
#endif
    OS_ENTER_CRITICAL();
    pmem = OSMemFreeList;                             /* Get next free memory partition                */
	//从系统中的空余内存控制块链表中取得一个内存控制块，该项内存
	//控制块中包含相应内在分区的运行状态信息。
    if (OSMemFreeList != (OS_MEM *)0) {               /* See if pool of free partitions was empty      */
		//内存分区的空链表指针是否为空，如不为空，
        OSMemFreeList = (OS_MEM *)OSMemFreeList->OSMemFreeList;//这是什么意思？将空余块赋给空余内存块？
    }
    OS_EXIT_CRITICAL();
    if (pmem == (OS_MEM *)0) {                        /* See if we have a memory partition             */
        *err = OS_MEM_INVALID_PART;//看是否有多余的内存控制块
        return ((OS_MEM *)0);
    }
    plink = (void **)addr;             /* Create linked list of free memory blocks  当条件都满足时    */
    pblk  = (INT8U *)addr + blksize;//所要建立的内存分区内的所有内存块链按成一个单向
    //链表。因为在单向链表中插入和删除元素都是从链表的顶端开始向下执行的。
    for (i = 0; i < (nblks - 1); i++) {
        *plink = (void *)pblk;
        plink  = (void **)pblk;//这两句为什么要这么写？
        pblk   = pblk + blksize;//这个我懂。
    }
    *plink              = (void *)0;                  /* Last memory block points to NULL              */
	//单向链表从上分到下，最后一块指向零。
	//下面这几句是保存相关的信息
    pmem->OSMemAddr     = addr;                       /* Store start address of memory partition       */
    pmem->OSMemFreeList = addr;                       /* Initialize pointer to pool of free blocks     */
    pmem->OSMemNFree    = nblks;                      /* Store number of free blocks in MCB            */
    pmem->OSMemNBlks    = nblks;
    pmem->OSMemBlkSize  = blksize;                    /* Store block size of each memory blocks        */
	//保存每一块内存块的大小
    *err                = OS_NO_ERR;//没有错误
    return (pmem);//操作完成后，返回指向该内存控制块的指针。该指针在以后对该
    //内存分区的操作中使用。
}
/*$PAGE*/
/*
*********************************************************************************************************
*                                          GET A MEMORY BLOCK
*
* Description : Get a memory block from a partition
*
* Arguments   : pmem    is a pointer to the memory partition control block
*
*               err     is a pointer to a variable containing an error message which will be set by this
*                       function to either:
*
*                       OS_NO_ERR           if the memory partition has been created correctly.
*                       OS_MEM_NO_FREE_BLKS if there are no more free memory blocks to allocate to caller
*                       OS_MEM_INVALID_PMEM if you passed a NULL pointer for 'pmem'
*
* Returns     : A pointer to a memory block if no error is detected
*               A pointer to NULL if an error is detected
*********************************************************************************************************
*/
 /*
 *********************************************************************************************************
                                             分配内存块
 描述：从分割区得到一块内存块
 参数：pmem：一个指向内存分割控制块的指针
			err：可以包含以下错误信息的指针：
					OS_NO_ERR：如果内存分割正确创建
					OS_MEM_NO_FREE_BLKS：没有多余的内存控制块调用
					OS_MEM_INVALID_PMEM：如果传一个空指针给"pmem"
 
 返回：如果无错误则返回一个指向内存控制块的指针，如果有错误返回一个空指针	
备注：应用程序应该知道分配内在大小，并在使用的时候不能超过它的大小
应用程序不用的时候，应当将其释放，重新回到相应的相应的内在分区中
 *********************************************************************************************************
*/


void  *OSMemGet (OS_MEM *pmem, INT8U *err)
{//传递指针pmem，它指向希望从中分配到的内存块的内存分区
#if OS_CRITICAL_METHOD == 3                           /* Allocate storage for CPU status register      */
    OS_CPU_SR  cpu_sr;
#endif    
    void      *pblk;


#if OS_ARG_CHK_EN > 0
    if (pmem == (OS_MEM *)0) {                        /* Must point to a valid memory partition         */
        *err = OS_MEM_INVALID_PMEM;//内存块地址为零，不可用
        return ((OS_MEM *)0);
    }
#endif
    OS_ENTER_CRITICAL();
    if (pmem->OSMemNFree > 0) {                       /* See if there are any free memory blocks       */
		//看是不是有多余的内存块
        pblk                = pmem->OSMemFreeList;    /* Yes, point to next free memory block          */
		//有多余的，指向向下一个内存块，即删除第一块
        pmem->OSMemFreeList = *(void **)pblk;         /*      Adjust pointer to new free list          */
       //调整新的链表指针
        pmem->OSMemNFree--;                           /*      One less memory block in this partition  */
	   //块数减一
        OS_EXIT_CRITICAL();
        *err = OS_NO_ERR;                             /*      No error                                 */
		//没有错误
        return (pblk);                                /*      Return memory block to caller            */
		//返回得到的内存块
    }
    OS_EXIT_CRITICAL();
    *err = OS_MEM_NO_FREE_BLKS;                       /* No,  Notify caller of empty memory partition  */
	//没有多余的，
    return ((void *)0);                               /*      Return NULL pointer to caller            */
}
/*$PAGE*/
/*
*********************************************************************************************************