FreeRTOS（十一）：其他任务 API 函数

学过了 FreeRTOS 的任务管理，但是真正涉及到的与任务相关的 API 函数只有那么几个：任务的创建、删除、挂起、恢复。

FreeRTOS 还有很多与任务相关的 API 函数，不过这些 API 函数大多都是辅助函数了，本文我们就来看一下这些与任务相关的其他的 API 函数。

这些函数不需要大家记住，只需要大家知道有这个功能可以使用，用到了再细查。知识框架的建立很重要，很多时候不是需要你背出来，只需要你知道有这个东西，在设计的时候就不会有局限性。

1、函数 uxTaskPriorityGet()

此函数用来获取指定任务的优先级，要使用此函数的话宏 INCLUDE_uxTaskPriorityGet 应 该定义为 1。

2、函数 vTaskPrioritySet()

此 函 数 用 于 改 变 某 一 个 任 务 的 任 务 优 先 级 ， 要 使 用 此 函 数 的 话 宏 INCLUDE_vTaskPrioritySet 应该定义为 1。

3、uxTaskGetSystemState()

此函数用于获取系统中所有任务的任务壮态，每个任务的壮态信息保存在一个 TaskStatus_t 类型的结构体里面，这个结构体里面包含了任务的任务句柄、任务名字、堆栈、优先级等信息， 要使用此函数的话宏 configUSE_TRACE_FACILITY 应该定义为 1。

4、函数 vTaskGetInfo()

此函数也是用来获取任务壮态的，但是是获取指定的单个任务的壮态的，任务的壮态信息 填充到参数 pxTaskStatus 中，这个参数也是 TaskStatus_t 类型的。要使用此函数的话宏 configUSE_TRACE_FACILITY 要定义为 1。

5、函数 xTaskGetApplicationTaskTag()

此函数用于获取任务的 Tag(标签)值，任务控制块中有个成员变量 pxTaskTag 来保存任务的 标签值。标签的功能由用户自行决定，此函数就是用来获取这个标签值的，FreeRTOS 系统内核 是不会使用到这个标签的。要使用此函数的话宏 configUSE_APPLICATION_TASK_TAG 必须为 1。

6、函数 xTaskGetCurrentTaskHandle()

此函数用于获取当前任务的任务句柄，其实获取到的就是任务控制块，在前面讲解任务创 建 函 数 的 时 候 说 过 任 务 句 柄 就 是 任 务 控制。如 果 要 使 用 此 函 数 的 话 宏INCLUDE_xTaskGetCurrentTaskHandle 应该为 1。

7、函数 xTaskGetHandle()

此函数根据任务名字获取任务的任务句柄，在使用函数 xTaskCreate()或 xTaskCreateStatic()创建任务的时候都会给任务分配一个任务名，函数 xTaskGetHandle()就是使用这个任务名字来 查询其对应的任务句柄的。要使用此函数的话宏 INCLUDE_xTaskGetHandle 应该设置为 1。

8、函数 xTaskGetIdleTaskHandle()

此 函 数 用 于 返 回 空 闲 任 务 的 任 务 句 柄 ， 要 使 用 此 函 数 的 话 宏 INCLUDE_xTaskGetIdleTaskHandle 必须为 1。

9、函数 uxTaskGetStackHighWaterMark()

每个任务都有自己的堆栈，堆栈的总大小在创建任务的时候就确定了，此函数用于检查任务从创建好到现在的历史剩余最小值，这个值越小说明任务堆栈溢出的可能性就越大！FreeRTOS 把这个历史剩余最小值叫做“高水位线”。此函数相对来说会多耗费一点时间，所以在代码调试阶段可以使用，产品发布的时候最好不要使用。要使用此函数的话宏INCLUDE_uxTaskGetStackHighWaterMark 必须为 1。

10、函数 eTaskGetState()

此函数用于查询某个任务的运行壮态，比如：运行态、阻塞态、挂起态、就绪态等，返回值是个枚举类型。要使用此函数的话宏 INCLUDE_eTaskGetState 必须为 1。

11、函数 pcTaskGetName()

根据某个任务的任务句柄来查询这个任务对应的任务名。

12、函数 xTaskGetTickCount()

此函数用于查询任务调度器从启动到现在时间计数器 xTickCount 的值。xTickCount 是系统 的时钟节拍值，并不是真实的时间值。每个滴答定时器中断 xTickCount 就会加 1，一秒钟滴答 定时器中断多少次取决于宏 configTICK_RATE_HZ。理论上 xTickCount 存在溢出的问题，但是 这个溢出对于 FreeRTOS 的内核没有影响，但是如果用户的应用程序有使用到的话就要考虑溢 出了。什么时候溢出取决于宏 configUSE_16_BIT_TICKS，当此宏为 1 的时候 xTixkCount 就是个 16 位的变量，当为 0 的时候就是个 32 位的变量。

13、函数 xTaskGetTickCountFromISR()

此函数是 xTaskGetTickCount()的中断级版本，用于在中断服务函数中获取时间计数器xTickCount 的值。

14、函数 xTaskGetSchedulerState()

此函数用于获取 FreeRTOS 的任务调度器运行情况：运行？关闭？还是挂起！要使用此函数的话宏 INCLUDE_xTaskGetSchedulerState 必须为 1。

15、函数 uxTaskGetNumberOfTasks()

此函数用于查询系统当前存在的任务数量。

16、函数 vTaskList()

此函数会创建一个表格来描述每个任务的详细信息。

17、函数 vTaskGetRunTimeStats()

FreeRTOS 可以通过相关的配置来统计任务的运行时间信息，任务的运行时间信息提供了每个任务获取到 CPU 使用权总的时间。函数 vTaskGetRunTimeStats()会将统计到的信息填充到一个表里面，表里面提供了每个任务的运行时间和其所占总时间的百分比。

18、函数 vTaskSetApplicationTaskTag()

此函数是为高级用户准备的，此函数用于设置某个任务的标签值 ，这个标签值的具体函数和用法由用户自行决定，FreeRTOS 内核不会使用这个标签值，如果要使用此函数的话宏configUSE_APPLICATION_TASK_TAG 必须为 1。

19、函数 SetThreadLocalStoragePointer()

此函数用于设置线程本地存储指针的值，每个任务都有它自己的指针数组来作为线程本地存储，使用这些线程本地存储可以用来在任务控制块中存储一些应用信息，这些信息只属于任务自己的。

20、函数 GetThreadLocalStoragePointer()

此函数用于获取线程本地存储指针的值， 如 果 要 使 用 此 函 数 的 话 宏configNUM_THREAD_LOCAL_STORAGE_POINTERS 不能为 0。