Chinaunix首页 | 论坛 | 博客
  • 博客访问: 1311081
  • 博文数量: 124
  • 博客积分: 4078
  • 博客等级: 中校
  • 技术积分: 3936
  • 用 户 组: 普通用户
  • 注册时间: 2010-07-21 11:28
个人简介

新博客:http://sparkandshine.net/

文章分类

全部博文(124)

分类: 嵌入式

2011-09-23 21:24:42

摘要:

    本文剖析Contiki最简单的实例hello_world,深入源码分析,详解了本实例用到的各个宏,进而给出一份完整展开的代码。最后把本实例用到的宏总结成API,并给出了创建一个进程的模型。


一、Hello World概览

hello_world.c用于向串口打印"Hello World",源代码如下,

  1. //filename:hello_world.c

  2. #include "contiki.h"
  3. #include "debug-uart.h" /* For usart_puts()*/
  4. #include <stdio.h> /* For printf() */

  5. PROCESS(hello_world_process, "Hello world"); /*参照二*/
  6. AUTOSTART_PROCESSES(&hello_world_process); /*参照三*/

  7. /*Define the process code*/
  8. PROCESS_THREAD(hello_world_process, ev, data) /*参见四*/
  9. {
  10.     PROCESS_BEGIN(); /*参照5.1*/

  11.     usart_puts("Hello, world!\n"); /*向串口打印字符串"Hello,world"*/

  12.     PROCESS_END(); /*参考5.2*/
  13. }

接下来逐句分析。

二、PROCESS宏

PROCESS宏完成两个功能:

(1) 声明一个函数,该函数是进程的执行体,即进程的thread函数指针所指的函数

(2) 定义一个进程

源码展开如下:

  1. //PROCESS(hello_world_process, "Hello world");

  2. #define PROCESS(name, strname) PROCESS_THREAD(name, ev, data); \
  3. struct process name = { NULL, strname, process_thread_##name }

对应参数展开为:

  1. #define PROCESS((hello_world_process, "Hello world")

  2. PROCESS_THREAD(hello_world_process, ev, data); \   /*分析见2.1*/

  3. struct process hello_world_process = { NULL, "Hello world", process_thread_hello_world_process }; /*分析见2.2*/

2.1 PROCESS_THREAD宏

PROCESS_THREAD宏用于定义进程的执行主体,宏展开如下

  1. #define PROCESS_THREAD(name, ev, data) \
  2. static PT_THREAD(process_thread_##name(struct pt *process_pt, process_event_t ev, process_data_t data))

对应参数展开为:

  1. //PROCESS_THREAD(hello_world_process, ev, data);

  2. static PT_THREAD(process_thread_hello_world_process(struct pt *process_pt, process_event_t ev, process_data_t data));  /*分析见2.1.1*/

2.1.1 PT_THREAD宏

PT_THREAD宏用于声明一个protothread,即进程的执行主体,宏展开如下:

  1. #define PT_THREAD(name_args) char name_args

展开之后即为:

  1. //static PT_THREAD(process_thread_hello_world_process(struct pt *process_pt, process_event_t ev, process_data_t data));

  2. static char process_thread_hello_world_process(struct pt *process_pt, process_event_t ev, process_data_t data);

    这下就很清楚了,声明一个静态的函数process_thread_hello_world_process,返回值是char类型。

另,struct pt *process_pt可以直接理解成lc,用于保存当前被中断的地方(保存程序断点),以便下次恢复执行。

2.2 定义一个进程

PROCESS宏展开的第二句,定义一个进程hello_world_process,源码如下:

  1. struct process hello_world_process = { NULL, "Hello world", process_thread_hello_world_process };

结构体process定义如下:

  1. struct process  
  2. {
  3.     struct process *next;
  4.     const char *name;   /*此处略作简化,源代码包含了预编译#if。即可以通过配置,使得进程名称可有可无*/
  5.     PT_THREAD((* thread)(struct pt *, process_event_t, process_data_t));
  6.     struct pt pt;
  7.     unsigned char state, needspoll;
  8. };

    可见进程hello_world_process 的lc、state、needspoll都默认置为0。关于process结构体请参见博文《Contiki学习笔记:主要数据结构之进程》。

三、AUTOSTART_PROCESSES宏

    AUTOSTART_PROCESSES宏实际上是定义一个指针数组,存放Contiki系统运行时需自动启动的进程,宏展开如下:

  1. //AUTOSTART_PROCESSES(&hello_world_process);

  2. #define AUTOSTART_PROCESSES(...) \ struct process * const autostart_processes[] = {__VA_ARGS__, NULL}

    这里用到C99 支持可变参数宏的特性,如:#define debug(…) printf(__VA_ARGS__) ,缺省号代表一个可以变化的参数表,宏展开时,实际的参数就传递给 printf()了。例:debug("Y = %d\n", y); 被替换成printf("Y = %d\n", y); 。那么,AUTOSTART_PROCESSES(&hello_world_process); 实际上被替换成:

  1. struct process * const autostart_processes[] = {&hello_world_process, NULL};

    这样就知道如何让多个进程自启动了,直接在宏AUTOSTART_PROCESSES()加入需自启动的进程地址,比如让hello_process和world_process这两个进程自启动,如下:

  1. AUTOSTART_PROCESSES(&hello_process,&world_process);

    最后一个进程指针设成NULL,则是一种编程技巧,设置一个哨兵(提高算法效率的一个手段),以提高遍历整个数组的效率。

四、PROCESS_THREAD宏

    PROCESS(hello_world_process, "Hello world"); 展开成两句,其中有一句是也是PROCESS_THREAD(hello_world_process, ev, data) ;。这里要注意到分号,是一个函数声明。而这PROCESS_THREAD(hello_world_process, ev, data)没有分号,而是紧跟着"{}",是上述声明函数的实现。关于PROCESS_THREAD宏的分析,最后展开如下,展开过程参见上述2.1。

  1. static char process_thread_hello_world_process(struct pt *process_pt, process_event_t ev, process_data_t data);

温馨提示:在阅读Contiki源码,手动展开宏时,要特别注意分号。

五、PROCESS_BEGIN宏和PROCESS_END宏

    原则上,所有代码都得放在PROCESS_BEGIN宏和PROCESS_END宏之间(如果程序全部使用静态局部变量,这样做总是对的。倘若使用局部变量,情况就比较复杂了,当然,不建议这样做),看完下面宏展开,就知道为什么了。

5.1 PROCESS_BEGIN宏

PROCESS_BEGIN宏一步步展开如下:

  1. #define PROCESS_BEGIN() PT_BEGIN(process_pt)

    process_pt是struct pt*类型,在函数头传递过来的参数(见四),直接理解成lc,用于保存当前被中断的地方,以便下次恢复执行。继续展开:

  1. #define PT_BEGIN(pt) { char PT_YIELD_FLAG = 1; LC_RESUME((pt)->lc)

  2. #define LC_RESUME(s) switch(s) { case 0:

把参数替换,结果如下:

  1. {

  2.     char PT_YIELD_FLAG = 1; /*将PT_YIELD_FLAG置1,类似于关中断???*/

  3.     switch(process_pt->lc) /*程序根据lc的值进行跳转,lc用于保存程序断点*/

  4.     {

  5.         case 0: /*第一次执行从这里开始,可以放一些初始化的东东*/

  6.             ;

    很奇怪是吧,PROCESS_BEGIN宏展开都不是完整的语句,别急,看完下面的PROCESS_END就知道Contiki这些天才们是怎么设计的。

5.2 PROCESS_END宏

PROCESS_END宏一步步展开如下:

  1. #define PROCESS_END() PT_END(process_pt)

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


  3. #define LC_END(s) }

  4. #define PT_INIT(pt) LC_INIT((pt)->lc)
  5. #define LC_INIT(s) s = 0;

  6. #define PT_ENDED 3

整理下,实际上如下代码:

  1.     }
  2.     PT_YIELD_FLAG = 0;

  3.     (process_pt)->pt = 0;
  4.     
  5.     return 3;
  6. }

好了,现在回过头来看,PROCESS_BEGIN宏和PROCESS_END宏是如此的般配,天生一对呀,祝福他们:-)

六、总结

6.1 宏全部展开

根据上述的分析,该实例全部展开的代码如下,再浏览下,是不是有种神清气爽的感觉:-)

  1. #include "contiki.h"
  2. #include "debug-uart.h" /* For usart_puts()*/
  3. #include <stdio.h> /* For printf() */

  4. static char process_thread_hello_world_process(struct pt *process_pt, process_event_t ev, process_data_t data);

  5. struct process hello_world_process = { ((void *)0), "Hello world process", process_thread_hello_world_process};
  6. struct process * const autostart_processes[] = {&hello_world_process, ((void *)0)};

  7. char process_thread_hello_world_process(struct pt *process_pt, process_event_t ev, process_data_t data)
  8. {
  9.     {
  10.         char PT_YIELD_FLAG = 1;
  11.         switch((process_pt)->lc)
  12.         {
  13.             case 0:
  14.                 ;

  15.                 usart_puts("Hello, world!\n");

  16.         };
  17.      }
  18.      PT_YIELD_FLAG = 0;
  19.      (process_pt)->lc = 0;;
  20.      return 3; 
  21. }

6.2 宏总结

对本实例用到的宏总结如上,以后就直接把宏当API用了。

PROCESS(name, strname)

声明进程 name的主体函数process_thread_##name(进程的thread函数指针所指的函数),并定义一个进程name

AUTOSTART_PROCESSES(...)

定义一个进程指针数组 autostart_processes

PROCESS_THREAD(name, ev, data)

进程name的定义或声明,取决于宏后面是";"还是"{}"

PROCESS_BEGIN()

进程的主体函数从这里开始

PROCESS_END()

进程的主体函数从这里结束

6.3 编程模型

    这实例虽说很简单,但却给出了定义一个进程的模型(还以Hello world为例),实际编程过程中,只需要将usart_puts("Hello, world!\n"); 换成自己需要实现的代码。

  1. //假设进程名称为Hello world
  2. #include "contiki.h"
  3. #include <stdio.h> /* For printf() */

  4. PROCESS(hello_world_process, "Hello world"); //PROCESS(name, strname)
  5. AUTOSTART_PROCESSES(&hello_world_process); //AUTOSTART_PROCESS(...)

  6. /*Define the process code*/
  7. PROCESS_THREAD(hello_world_process, ev, data) //PROCESS_THREAD(name, ev, data)
  8. {
  9.     PROCESS_BEGIN();

  10.     /***这里填入你的代码***/

  11.     PROCESS_END();
  12. }

    注:声明变量最好不要放在PROCESS_BEGIN之前,因为进程再次被调度,总是从头开始执行,直到PROCESS_BEGIN宏中的switch判断才跳转到断点case __LINE__。也就是说,进程被调度总是会执行PROCESS_BEGIN之前的代码。

阅读(13401) | 评论(13) | 转发(1) |
给主人留下些什么吧!~~

Jelline2013-01-06 19:59:47

catch2000: 刚才在整理的时候,
查到发现
__LINE__是C99的标准中规定的宏定义;
至于__func__则是gcc中定义的宏定义,但是它是以const形式实现的。
staticconstchar__func_.....
恩,你研究很透彻,佩服

catch20002013-01-02 22:59:47

刚才在整理的时候,
查到发现
__LINE__是C99的标准中规定的宏定义;
至于__func__则是gcc中定义的宏定义,但是它是以const形式实现的。
staticconstchar__func__[]="function-name";

catch20002013-01-02 21:52:03

Jelline: 后者,我跟你理解是一样的,AUTOSTART_PROCESS通常是写在main函数。

前者,我理解跟你不一样。__LINE__是编译器机制,多个文件也是可以用的,你想哈,那个prot.....
博主你好,
很抱歉一直没有回复。
之前忙着赶进度,没有继续深入看,趁元旦又把protothread的看了一下,发现protothread的切换是在调用此函数时实现的。
A protothread runs within a single C function and cannot span over other functions.A protothread may call normal C functions, but cannot block inside a called function.(contiki-2.6/doc/pt-doc.txt)
从这里看出__LINE__只需要

Jelline2012-12-29 13:59:13

jsjkj: 整理下,实际上如下代码:
    }
    PT_YIELD_FLAG = 0;

    (process_pt)->pt = 0;
    
 .....
恩,你是对的,我确实弄错了,谢谢指正。

在给process赋值时,pt、state、needspoll没赋值,意味着空(想想数组初始化,这种情况,没被初始化的元素被初始化为0)。

struct process hello_world_process = { NULL, "Hello world", process_thread_hello_world_process };

jsjkj2012-12-28 14:43:42

整理下,实际上如下代码:
    }
    PT_YIELD_FLAG = 0;

    (process_pt)->pt = 0;
    
    return 3;
}

其中  (process_pt)->pt = 0; 应该是  (process_pt)->lc = 0;吧,刚开始看时有点懵了,后来看完完全展开后的源码才明白。

另外请问hello_world_process 的lc、state、needspoll都默认置为0 这句怎么理解?我没有看到明显的初始化语句,难道是编译器做的?