Contiki学习笔记：protothread状态

Jelline

摘要：

    本文结合Contiki OS实例分析protothread四种状态：PT_WAITING、PT_YIELDED、PT_EXITED、PT_ENDED，并给出Contiki事件相关函数与protothread状态，最后给出系统编程的参考API。

一、PT四种状态

1. #define PT_WAITING 0
   
2. #define PT_YIELDED 1
   
3. #define PT_EXITED  2
   
4. #define PT_ENDED   3

Contiki事件相关函数与protothread状态关系如下图(注-没有包含所有函数)：

1.1 PT_WAITING

宏PROCESS_WAIT_UNTIL(c)用到了PT_WAITING，该宏用于挂起进程直到条件c成立，源码如下：

1. #define PROCESS_WAIT_UNTIL(c) PT_WAIT_UNTIL(process_pt, c)

宏PROCESS_WAIT_UNTIL(c) 不保证进程会让出执行权，源码注释如下：

1. This macro does not guarantee that the process yields, and should therefore be used with care. In most cases, PROCESS_WAIT_EVENT(),PROCESS_WAIT_EVENT_UNTIL(), PROCESS_YIELD() or PROCESS_YIELD_UNTIL() should be used instead.

宏PT_WAIT_UNTIL展开如下：

1. #define PT_WAIT_UNTIL(pt, condition)     \
   
2.   do
   
3.   {                        \
   
4.     LC_SET((pt)->lc);                \
   
5.     if(!(condition))
   
6.     {                \
   
7.       return PT_WAITING;            \
   
8.     }                        \
   
9.   } while(0)

在PT_RESTART宏也用到了PT_WAITING，源码如下：

1. //Restart the protothread.
   
2. #define PT_RESTART(pt)                \
   
3.   do
   
4.   {                        \
   
5.     PT_INIT(pt);                \
   
6.     return PT_WAITING;            \
   
7.   } while(0)

1.2 PT_YIELDED

(1) PT_YIELD_FLAG = 0 

    表示条件不满足，主动让出执行权。PT_END(pt)、PT_YIELD(pt) 、PT_YIELD_UNTIL(pt, cond)将PT_YIELD_FLAG设置成0

(2) PT_YIELD_FLAG =1

    表示条件满足，继续执行后续代码。在PT_BEGIN(pt)将PT_YIELD_FLAG设置成1

为了便好理解PT_YIELD_FLAG，以PROCESS_WAIT_EVENT宏作为分析对象，源代码如下：

1. #define PROCESS_WAIT_EVENT()    PROCESS_YIELD()
2. #define PROCESS_YIELD()         PT_YIELD(process_pt)
4. #define PT_YIELD(pt) \
5. do
6. { \
7. PT_YIELD_FLAG = 0; \
8. LC_SET((pt)->lc); \
9. if(PT_YIELD_FLAG == 0)
10. { \
11. return PT_YIELDED; \
12. } \
13. } while(0)
15. #define LC_SET(s) s = __LINE__; case __LINE__: //保存程序断点，下次再运行该进程直接跳到case __LINE__

    PROCESS_WAIT_EVENT宏用于等待一个事件发生，如果检测到PT_YIELD_FLAG为1，就继续执行PROCESS_WAIT_EVENT宏后面的代码。若PT_YIELD_FLAG为0了，就直接返回PT_YIELDED，从博文《Contiki学习笔记：启动一个进程process_start》第三部分call_process函数，可知并没有退出进程，只是把进程状态设为PROCESS_STATE_RUNNING。call_process(struct process *p, process_event_t ev, process_data_t data)函数部分代码如下：

1. ret = p->thread(&p->pt, ev, data); //才真正执行PROCESS_THREAD(name, ev, data)定义的内容
   
2. if (ret == PT_EXITED || ret == PT_ENDED || ev == PROCESS_EVENT_EXIT)
   
3. {
   
4.   exit_process(p, p); //如果返回值表示退出、结尾或者遇到PROCESS_EVENT_EXIT，进程退出
   
5. }
   
6. else
   
7. {
   
8.   p->state = PROCESS_STATE_RUNNING; //进程挂起等待事件
   
9. }

    这有个疑问，什么时候把PT_YIELD_FLAG 设为1，才能以继续执行PROCESS_WAIT_EVENT宏后面的代码。我也纳闷，在整个源码，只找到PT_BEGIN宏将其设1。从源码分析，该进程没有机会执行PROCESS_WAIT_EVENT宏后面的内容，只有其他进程传递一个事件PROCESS_EVENT_EXIT让其退出，即process_post(&hello_world_process, PROCESS_EVENT_EXIT, NULL)。但实际编辑，只要向该进程传递一个普通事件，即可执行PROCESS_WAIT_EVENT宏后面的代码。很是不解，求助中……。(实例见附录)

1.3 PT_EXITED

宏PROCESS_EXIT(让当前进程退出，自己结束自己的生命)用到了PT_EXITED，源码如下：

1. #define PT_EXIT(pt)                \
   
2.   do
   
3.   {                        \
   
4.     PT_INIT(pt);                \
   
5.     return PT_EXITED;            \
   
6.   } while(0)

    执行进程主体thread时(call_process函数)，会返回结果，如果结果是PT_EXITED或者1.4的PT_ENDED，则进程退出(exit_process函数)，部分源码如下：

1.4 PT_ENDED

这个就不陌生了，在宏PROCESS_END展开就有这么一句return PT_ENDED，一层层展开如下：

1. #define PROCESS_END() PT_END(process_pt)
   
2. 
   
3. #define PT_END(pt) LC_END((pt)->lc); PT_YIELD_FLAG = 0; \
   
4.                    PT_INIT(pt); return PT_ENDED; }

二、编程指南

    理解上述内容后，相信对多个进程间事件如何交互比较清楚了，在实际编程过程，可以参考如下两个网址，分别列出了pt及process头文件的API：

[1] Contiki 2.5: core/sys/process.h File Reference

[2] Contiki 2.5: core/sys/pt.h File Reference

附PROCESS_EVENT_EXIT测试用例：

1. //filename:process_wait_event_test.c
   
2. #include "contiki.h"
   
3. #include "debug-uart.h"
   
4. 
   
5. PROCESS(hello_world_process, "Hello world");
   
6. PROCESS(post_event_process, "Post event");
   
7. 
   
8. AUTOSTART_PROCESSES(&hello_world_process, &post_event_process);
   
9. 
   
10. PROCESS_THREAD(hello_world_process, ev, data)
    
11. {
    
12.   PROCESS_BEGIN();
    
13.   usart_puts("Hello, world!\n");
    
14.   
    
15.   while(1)
    
16.   {
    
17.     //usart_puts("while.Before wait event!\n");
    
18.     PROCESS_WAIT_EVENT();
    
19.     usart_puts("Have been posted an event!\n");
    
20.   }
    
21.   
    
22.   PROCESS_END();
    
23. }
    
24. 
    
25. 
    
26. PROCESS_THREAD(post_event_process, ev, data)
    
27. {
    
28.   PROCESS_BEGIN();
    
29.   usart_puts("Post event!\n");
    
30.   
    
31.   static process_event_t event_post;
    
32.   event_post = process_alloc_event();
    
33.   
    
34.   process_post(&hello_world_process, event_post, NULL);
    
35.   //process_post(&hello_world_process, PROCESS_EVENT_EXIT, NULL);
    
36.   
    
37.   PROCESS_END();
    
38. }