7.1 什么是列表和列表项
7.1.1 列表
列表是 FreeRTOS 中的一个数据结构，概念上和链表有点类似，列表被用来跟踪 FreeRTOS中的任务。与列表相关的全部东西都在文件 list.c 和 list.h 中。在 list.h 中定义了一个叫 List_t 的结构体，如下：
typedef struct xLIST
{
listFIRST_LIST_INTEGRITY_CHECK_VALUE (1)
configLIST_VOLATILE UBaseType_t uxNumberOfItems; (2)
ListItem_t * configLIST_VOLATILE pxIndex; (3)
MiniListItem_t xListEnd; (4)
listSECOND_LIST_INTEGRITY_CHECK_VALUE (5)
} List_t;(1) 和 (5) 、 这 两 个 都 是 用 来 检 查 列 表 完 整 性 的 ， 需 要 将 宏configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES 设置 为 1，开启以后会向这两个地方分别添加一个变量 xListIntegrityValue1 和 xListIntegrityValue2，在初始化列表的时候会 这两个变量中写入一个特殊的值，默认不开启这个功能。 以后我们在学习列表的时候不讨论这个功能！
(2)、 uxNumberOfItems 用来记录列表中列表项的数量。
(3)、 pxIndex 用来记录当前列表项索引号，用于遍历列表。
(4)、 列表中最后一个列表项，用来表示列表结束，此变量类型为 MiniListItem_t，这是一个迷你列表项，关于列表项稍后讲解。
7.1.2 列表项
列表项就是存放在列表中的项目， FreeRTOS 提供了两种列表项： 列表项和迷你列表项。这两个都在文件 list.h 中有定义，先来看一下列表项，定义如下：
struct xLIST_ITEM
{
listFIRST_LIST_ITEM_INTEGRITY_CHECK_VALUE /*< Set to a known value if configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES is set to 1. */
configLIST_VOLATILE TickType_t xItemValue; /*列表项值。 */
struct xLIST_ITEM * configLIST_VOLATILE pxNext; /* 指向下一个列表项*/
struct xLIST_ITEM * configLIST_VOLATILE pxPrevious; /*指向前一个列表项 */
void * pvOwner; /*< 记录此链表项归谁拥有，通常是任务控制块。 */
void * configLIST_VOLATILE pvContainer; /*< 记录此链表项归谁拥有，通常是任务控制块。 */
listSECOND_LIST_ITEM_INTEGRITY_CHECK_VALUE /*< Set to a known value if
configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES is set to 1*/
};
typedef struct xLIST_ITEM ListItem_t; /* For some reason lint wants this
as two separate definitions. */
(1)和(7)、用法和列表一样，用来检查列表项完整性的。 以后我们在学习列表项的时候不讨论这个功能！
(2)、 xItemValue 为列表项值。
(3)、 pxNext 指向下一个列表项。
(4)、 pxPrevious 指向前一个列表项，和 pxNext 配合起来实现类似双向链表的功能。
(5)、 pvOwner 记录此链表项归谁拥有，通常是任务控制块。
(6)、 pvContainer 用来记录此列表项归哪个列表。注意和 pvOwner 的区别，在前面讲解任务控制块 TCB_t 的时候说了在 TCB_t 中有两个变量 xStateListItem 和 xEventListItem，这两个变量的类型就是 ListItem_t，也就是说这两个成员变量都是列表项。以 xStateListItem 为例，当创建一个任务以后 xStateListItem 的 pvOwner 变量就指向这个任务的任务控制块，表示 xSateListItem属于此任务。当任务就绪态以后 xStateListItem 的变量 pvContainer 就指向就绪列表，表明此列表项在就绪列表中。举个通俗一点的例子：小王在上二年级，他的父亲是老王。如果把小王比作列表项，那么小王的 pvOwner 属性值就是老王，小王的 pvContainer 属性值就是二年级。
7.1.3 迷你列表项
上面我们我们说了列表项，现在来看一下迷你列表项，迷你列表项在文件 list.h 中有定义，如下：
struct xMINI_LIST_ITEM
{
listFIRST_LIST_ITEM_INTEGRITY_CHECK_VALUE /*< Set to a known value if configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES is set to 1. */
configLIST_VOLATILE TickType_t xItemValue;
struct xLIST_ITEM * configLIST_VOLATILE pxNext;
struct xLIST_ITEM * configLIST_VOLATILE pxPrevious;
};
typedef struct xMINI_LIST_ITEM MiniListItem_t; (1)、用于检查迷你列表项的完整性.
(2)、 xItemValue 记录列表列表项值。
(3)、 pxNext 指向下一个列表项。
(4)、 pxPrevious 指向上一个列表项。
可以看出迷你列表项只是比列表项少了几个成员变量，迷你列表项有的成员变量列表项都有的，没感觉有什么本质区别啊？那为什么要弄个迷你列表项出来呢？那是因为有些情况下我们不需要列表项这么全的功能，可能只需要其中的某几个成员变量，如果此时用列表项的话会造成内存浪费！比如上面列表结构体 List_t 中表示最后一个列表项的成员变量 xListEnd 就是MiniListItem_t 类型的。
7.2 列表和列表项的初始化
7.2.1 列表初始化
新创建或者定义的列表需要对其做初始化处理，列表的初始化其实就是初始化列表结构体List_t 中的各个成员变量，列表的初始化通过使函数 vListInitialise()来完成，此函数在 list.c 中有定义，函数如下：
/*******************列表的初始化******************/
void vListInitialise( List_t * const pxList )
{
pxList->pxIndex = ( ListItem_t * ) &( pxList->xListEnd ); (1)
pxList->xListEnd.xItemValue = portMAX_DELAY; (2)
pxList->xListEnd.pxNext = ( ListItem_t * ) &( pxList->xListEnd ); (3)
pxList->xListEnd.pxPrevious = ( ListItem_t * ) &( pxList->xListEnd ); (4)
pxList->uxNumberOfItems = ( UBaseType_t ) 0U; (5)
listSET_LIST_INTEGRITY_CHECK_1_VALUE( pxList ); (6)
listSET_LIST_INTEGRITY_CHECK_2_VALUE( pxList ); (7)
}(1)、 xListEnd 用来表示列表的末尾，而 pxIndex 表示列表项的索引号，此时列表只有一个列表项，那就是 xListEnd，所以
pxIndex 指向 xListEnd。
(2)、 xListEnd 的列表项值初始化为 portMAX_DELAY， portMAX_DELAY 是个宏，在文件portmacro.h 中有定义。根据所使用的 MCU 的不同， portMAX_DELAY 值也不相同，可以为 0xffff或者 0xffffffffUL，本教程中为 0xffffffffUL。
(3)、初始化列表项 xListEnd 的 pxNext 变量，因为此时列表只有一个列表项 xListEnd，因此 pxNext 只能指向自身。
(4)、同(3)一样，初始化 xListEnd 的 pxPrevious 变量，指向 xListEnd 自身。
(5)、由于此时没有其他的列表项，因此 uxNumberOfItems 为 0，注意，这里没有算 xListEnd。
(6) 和 (7) 、 初 始 化 列 表 项 中 用 于 完 整 性 检 查 字 段 ， 只 有 宏configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES 为 1 的时候才有效。 同样的根据所选的MCU 不同其写入的值也不同，可以为 0x5a5a 或者 0x5a5a5a5aUL。 STM32 是 32 位系统写入的是 0x5a5a5a5aUL，列表初始化完以后如图 7.2.1.1 所示：
7.2.2 列表项初始化
同列表一样，列表项在使用的时候也需要初始化，列表项初始化由函数 vListInitialiseItem()来完成， 函数如下：
void vListInitialiseItem( ListItem_t * const pxItem )
{
pxItem->pvContainer = NULL;//初始化 pvContainer 为 NULL
//初始化用于完整性检查的变量，如果开启了这个功能的话。
listSET_FIRST_LIST_ITEM_INTEGRITY_CHECK_VALUE( pxItem );
listSET_SECOND_LIST_ITEM_INTEGRITY_CHECK_VALUE( pxItem );
}列表项的初始化很简单，只是将列表项成员变量 pvContainer 初始化为 NULL，并且给用于完整性检查的变量赋值。 有朋友可能会问，列表项的成员变量比列表要多，怎么初始化函数就这么短？其他的成员变量什么时候初始化呢？这是因为列表项要根据实际使用情况来初始化，比如任务创建函数 xTaskCreate()就会对任务堆栈中的 xStateListItem 和 xEventListItem 这两个列表项中的其他成员变量在做初始化，任务创建过程后面会详细讲解。
7.3 列表项的插入
7.3.1 列表项插入函数分析
列表项的插入操作通过函数 vListInsert()来完成，函数原型如下:
void vListInsert( List_t * const pxList,/*列表项要插入的列表*/
ListItem_t * const pxNewListItem ) /*要插入的列表项*/函数 vListInsert()的参数 pxList 决定了列表项要插入到哪个列表中， pxNewListItem 决定了要插入的列表项，但是这个列表项具体插入到什么地方呢？要插入的位置由列表项中成员变量xItemValue 来决定。 列表项的插入根据 xItemValue 的值按照升序的方式排列！接下来我们来具体看一下函数 vListInsert()的整个运行过程，函数代码如下：
void vListInsert( List_t * const pxList, ListItem_t * const pxNewListItem )
{
ListItem_t *pxIterator;
/*获取要插入的列表项值，即列表项成员变量 xItemValue 的值，因为要根据这个值来确
定列表项要插入的位置。*/
const TickType_t xValueOfInsertion = pxNewListItem->xItemValue;
/*这一行和下一行代码用来检查列表和列表项的完整性的。其实就是检查列表和列表项中用于完整性检查的变量值是否被改变。这些变量的值在列表和列表项初始化的时候就被写入
了，这两行代码需要实现函数 configASSERT()！ */
listTEST_LIST_INTEGRITY( pxList );
listTEST_LIST_ITEM_INTEGRITY( pxNewListItem );
/*要插入列表项，第一步就是要获取该列表项要插入到什么位置！如果要插入的列表项
的值等于 portMAX_DELAY，也就是说列表项值为最大值， 这种情况最好办了，要插入的位置
就是列表最末尾了。 */
if( xValueOfInsertion == portMAX_DELAY )
{
/*获取要插入点，注意！列表中的 xListEnd 用来表示列表末尾，在初始化列表的时候
xListEnd的列表值也是portMAX_DELAY， 此时要插入的列表项的列表值也是portMAX_DELAY。
这两个的顺序该怎么放啊？通过这行代码可以看出要插入的列表项会被放到 xListEnd 前面。*/
pxIterator = pxList->xListEnd.pxPrevious;
}
else
{
/*要插入的列表项的值如果不等于 portMAX_DELAY 那么就需要在列表中一个一个的找
自己的位置，这个 for 循环就是找位置的过程，当找到合适列表项的位置的时候就会跳出。由
于这个 for 循环是用来寻找列表项插入点的，所以 for 循环体里面没有任何东西。 这个查找过程
是按照升序的方式查找列表项插入点的。*/
for( pxIterator = ( ListItem_t * ) &( pxList->xListEnd ); pxIterator->pxNext->xItemValue <= xValueOfInsertion; pxIterator = pxIterator->pxNext )
{
/*空循环，什么也不做*/
}
}
pxNewListItem->pxNext = pxIterator->pxNext; /*经过上面的查找，我们已经找到列表项的插入点了，从本行开始接下来的四行代码就是将列表项插入到列表中， 插入过程和数据结构中双向链表的插入类似。 像 FreeRTOS 这种RTOS 系统和一些协议栈都会大量用到数据结构的知识， 所以建议大家没事的时候多看看数据结构方面的书籍，否则的话看源码会很吃力的。*/
pxNewListItem->pxNext->pxPrevious = pxNewListItem;
pxNewListItem->pxPrevious = pxIterator;
pxIterator->pxNext = pxNewListItem;
/* Remember which list the item is in. This allows fast removal of the
item later. */
pxNewListItem->pvContainer = ( void * ) pxList;/*列表项已经插入到列表中了，那么列表项的成员变量 pvContainer 也该记录此列表项属于哪个列表的了。*/
( pxList->uxNumberOfItems )++;/*列表的成员变量 uxNumberOfItems 加一，表示又添加了一个列表项。*/
}7.3.2 列表项插入过程图示
上一小节我们分析了列表项插入函数 vListInsert()，本小节我们就通过图片来演示一下这个插入过程，本小节我们会向一个空的列表中插入三个列表项， 这三个列表项的值分别为 40， 60和 50。
1、插入值为 40 的列表项
在一个空的列表 List 中插入一个列表值为 40 的列表项 ListItem1，插入完成以后如图 7.3.2.1所示：
注意观察插入完成以后列表 List 和列表项 ListItem1 中各个成员变量之间的变化，比如列表 List 中的 uxNumberOfItems 变为了 1，表示现在列表中有一个列表项。列表项 ListItem1 中的pvContainer 变成了 List，表示此列表项属于列表 List。 通过图 7.3.2.1 可以看出，列表是一个环形的，即环形列表！
2、插入值为 60 的列表项
接着再插入一个值为 60 的列表项 ListItem2，插入完成以后如图 7.3.2.2 所示：
上面再讲解函数 vListInsert()的时候说过了列表项是按照升序的方式插入的，所以 ListItem2肯定是插入到 ListItem1 的后面、 xListEnd 的前面。 同样的，列表 List 的 uxNumberOfItems 再次加一变为 2 了，说明此时列表中有两个列表项。
3、插入值为 50 的列表项
在上面的列表中再插入一个值为 50 的列表项 ListItem3， 插入完成以后如图 7.3.2.3 所示：
按照升序排列的方式， ListItem3 应该放到 ListItem1 和 ListItem2 中间，大家最好通过对照这三幅图片来阅读函数 vListInsert()的源码，这样就会对函数有一个直观的认识。
7.4 列表项末尾插入
7.4.1 列表项末尾插入函数分析
列表末尾插入列表项的操作通过函数 vListInsertEnd ()来完成，函数原型如下：
void vListInsertEnd( List_t * const pxList, //列表要插入的列表
ListItem_t * const pxNewListItem ) //要差人的列表项函数 vListInsertEnd()源码如下：
void vListInsertEnd( List_t * const pxList, ListItem_t * const pxNewListItem )
{
ListItem_t * const pxIndex = pxList->pxIndex;
/*与下面的一行代码完成对列表和列表项的完整性检查 */
listTEST_LIST_INTEGRITY( pxList );
listTEST_LIST_ITEM_INTEGRITY( pxNewListItem );
pxNewListItem->pxNext = pxIndex;（2）
pxNewListItem->pxPrevious = pxIndex->pxPrevious;
mtCOVERAGE_TEST_DELAY();
pxIndex->pxPrevious->pxNext = pxNewListItem;
pxIndex->pxPrevious = pxNewListItem;
pxNewListItem->pvContainer = ( void * ) pxList; （3）
( pxList->uxNumberOfItems )++; （4）
}(2)、从本行开始到(3)之间的代码就是将要插入的列表项插入到列表末尾。 使用函数vListInsert()向列表中插入一个列表项的时候这 个列表项的位置是通过列表项的值，也就是列表项成员变量 xItemValue 来确定。 vListInsertEnd()是往列表的末尾添加列表项 的，我们知道列表中的 xListEnd 成员变量表示列表末尾的，那么函数 vListInsertEnd()插入一个列表项是不是就是插到 xListEnd 的前面或后面啊？这个是不一定的， 这里所谓的末尾要根据列表的成员变量pxIndex 来确定的！ 前面说了列表中的 pxIndex 成员变量是用来遍历列表的， pxIndex 所指向的列表项就是要遍历的开始列表项，也就是说 pxIndex 所指向的列表项 就代表列表头！ 由于是个环形列表，所以新的列表项就应该插入到 pxIndex 所指向的列表项的前面。
(3)、标记新的列表项 pxNewListItem 属于列表 pxList。
(4)、记录列表中的列表项数目的变量加一，更新列表项数目。
7.4.2 列表项末尾插入图示
跟函数 vListInsert()一样，我们也用图片来看一下函数 vListInsertEnd()的插入过程。
1、默认列表
在插入列表项之前我们先准备一个默认列表，如图 7.4.2.1 所示
注意图 7.4.2.1 中列表的 pxIndex 所指向的列表项，这里为 ListItem1，不再是 xListEnd 了
3、插入值为 50 的列表项
在上面的列表中插入一个值为 50 的列表项 ListItem3，插入完成以后如图 7.4.2.2 所示：
列表 List 的 pxIndex 指向列表项 ListItem1，因此调用函数 vListInsertEnd()插入 ListItem3 的话就会在 ListItem1 的前面插入。
7.5 列表项的删除
有列表项的插入，那么必然有列表项的删除，列表项的删除通过函数 uxListRemove()来完成，函数原型如下：
UBaseType_t uxListRemove( ListItem_t * const pxItemToRemove )/*要删除的列表项*/返回值： 返回删除列表项以后的列表剩余列表项数目。
注意，列表项的删除只是将指定的列表项从列表中删除掉，并不会将这个列表项的内存给释放掉！如果这个列表项是动态分配内存的话。函数 uxListRemove()的源码如下：
UBaseType_t uxListRemove( ListItem_t * const pxItemToRemove )
{
List_t * const pxList = ( List_t * ) pxItemToRemove->pvContainer;（1）
pxItemToRemove->pxNext->pxPrevious = pxItemToRemove->pxPrevious; （2）
pxItemToRemove->pxPrevious->pxNext = pxItemToRemove->pxNext;
mtCOVERAGE_TEST_DELAY();
if( pxList->pxIndex == pxItemToRemove )
{
pxList->pxIndex = pxItemToRemove->pxPrevious; （3）
}
else
{
mtCOVERAGE_TEST_MARKER();
}
pxItemToRemove->pvContainer = NULL; （4）
( pxList->uxNumberOfItems )--;
return pxList->uxNumberOfItems; （5）
}1)、 要删除一个列表项我们得先知道这个列表项处于哪个列表中，直接读取列表项中的成员变量 pvContainer 就可以得到此列表项 处于哪个列表中。
(2)、与下面一行完成列表项的删除，其实就是将要删除的列表项的前后两个列表项“连接”在一起。
(3)、 如果列表的 pxIndex 正好指向要删除的列表项，那么在删除列表项以后要重新给pxIndex 找个“对象”啊，这个新的对象就是被 删除的列表项的前一个列表项。
(4)、被删除列表项的成员变量 pvContainer 清零。
(5)、 返回新列表的当前列表项数目。
7.6 列表项的遍历
介绍列表结构体的时候说过列表 List_t 中的成员变量 pxIndex 是用来遍历列表的， FreeRTOS提供了一个函数来完成列表的遍历，这个函数是 listGET_OWNER_OF_NEXT_ENTRY()。 每调用一次这个函数列表的 pxIndex 变量就会指向下一个列表项，并且返回这个列表项的 pxOwner变量值。 这个函数本质上是一个宏，这个宏在文件 list.h 中如下定义：
#define listGET_OWNER_OF_NEXT_ENTRY( pxTCB, pxList ) \ (1)
{
List_t * const pxConstList = ( pxList ); \
( pxConstList )->pxIndex = ( pxConstList )->pxIndex->pxNext; \ (2)
if( ( void * ) ( pxConstList )->pxIndex == ( void * ) &( ( pxConstList )->xListEnd ) )\ (3)
{
( pxConstList )->pxIndex = ( pxConstList )->pxIndex->pxNext; \ (4)
}
( pxTCB ) = ( pxConstList )->pxIndex->pvOwner; \ (5)
}(1)、 pxTCB 用来保存 pxIndex 所指向的列表项的 pvOwner 变量值，也就是这个列表项属于谁的？通常是一个任务的任务控制块。 pxList 表示要遍历的列表。
(2)、 列表的 pxIndex 变量指向下一个列表项。
(3)、如果 pxIndex 指向了列表的 xListEnd 成员变量，表示到了列表末尾。
(4)、如果到了列表末尾的话就跳过 xListEnd， pxIndex 再一次重新指向处于列表头的列表项，这样就完成了一次对列表的遍历。
(5)、将 pxIndex 所指向的新列表项的 pvOwner 赋值给 pxTCB。
此函数用于从多个同优先级的就绪任务中查找下一个要运行的任务。
7.7 列表项的插入和删除实验
1538
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
