[Rime 协议栈] 包属性 packetbuf_attr

概述

  包属性其实属于下一篇博客《Rime 协议栈: 缓冲区管理 packetbuf management》的一部分,但是它比较难以理解,所以单独抽出一篇博客对它做介绍。
  为了兼容其他协议,Rime不定义任何头部格式,而用包属性代替。一种属性是一种头部字段的抽象。当Rime协议栈中的子协议要发送一个包时,会传递一个属性链表下来。属性链表里包含了若干个属性,这些属性最终会被转换成头部的字段。
  该部分代码位于:contiki/core/net/packetbuf.[ch]

相关定义

packetbuf_attrs packetbuf_addrs

  Rime中定义了关于包属性的数组:

1
2
struct packetbuf_attr packetbuf_attrs[PACKETBUF_NUM_ATTRS];
struct packetbuf_addr packetbuf_addrs[PACKETBUF_NUM_ADDRS];

  其中,struct packetbuf_attr和struct packetbuf_addr分别定义为

1
2
3
4
5
6
7
8
typedef uint16_t packetbuf_attr_t;

struct packetbuf_attr {
packetbuf_attr_t val; // 一个16位无符号整型
};
struct packetbuf_addr {
linkaddr_t addr; // 上一篇博客介绍的节点地址,16位或者64位
};

  数组的大小分别定义为:

1
2
3
4
5
6
#if NETSTACK_CONF_WITH_RIME
#define PACKETBUF_NUM_ADDRS 4
#else /* NETSTACK_CONF_WITH_RIME */
#define PACKETBUF_NUM_ADDRS 2
#endif /* NETSTACK_CONF_WITH_RIME */
#define PACKETBUF_NUM_ATTRS (PACKETBUF_ATTR_MAX - PACKETBUF_NUM_ADDRS)

  为什么PACKETBUF_NUM_ATTRS定义为PACKETBUF_ATTR_MAX - PACKETBUF_NUM_ADDRS?
  这是因为在定义属性的枚举变量时,将ADDR也当做了一种特殊属性,这样做的好处是可以将ADDR和ATTR统一处理(统一放在属性链表中,当Rime协议栈中的子协议将属性链表传递下来时,统一写到缓冲区packetbuf的头部)。请看下面

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
enum {
PACKETBUF_ATTR_NONE,

...

/* Scope 2 attributes: used between end-to-end nodes. */
#if NETSTACK_CONF_WITH_RIME
PACKETBUF_ATTR_HOPS,
PACKETBUF_ATTR_TTL,
PACKETBUF_ATTR_EPACKET_ID,
PACKETBUF_ATTR_EPACKET_TYPE,
PACKETBUF_ATTR_ERELIABLE, // 其实ATTR在这里就定义完了
#endif /* NETSTACK_CONF_WITH_RIME */

/* These must be last */
PACKETBUF_ADDR_SENDER, // 这里是ADDR的定义
PACKETBUF_ADDR_RECEIVER,
#if NETSTACK_CONF_WITH_RIME
PACKETBUF_ADDR_ESENDER,
PACKETBUF_ADDR_ERECEIVER,
#endif /* NETSTACK_CONF_WITH_RIME */

PACKETBUF_ATTR_MAX // 这里才是PACKETBUF_ATTR_MAX,包含ATTR+ADDR,所以ATTR=MAX-ADDR
};

struct packetbuf_attrlist

  前面说了,Rime协议栈的子协议在发送包时会传递一个属性链表下来,它的定义为:

1
2
3
4
struct packetbuf_attrlist {
uint8_t type;
uint8_t len; // 单位是bit
};

  type:属性的类型。它直接对应于属性数组packetbuf_attrs或者packetbuf_addrs的下标
  len:该属性的长度。需要注意的是,此处长度的单位是位,而不是字节。属性的类型是packetbuf_attr_t,即uint16_t,因此可以推断,len的取值范围应该是0~16。(本宝宝好厉害呀,居然想到这儿了~~~)

相关函数

packetbuf_attr_clear

1
2
3
4
5
6
7
8
9
void packetbuf_attr_clear(void)
{
int i;
memset(packetbuf_attrs, 0, sizeof(packetbuf_attrs));
//其实也可以用memset(packetbuf_addrs, 0, sizeof(packetbuf_addrs))吧?
for(i = 0; i < PACKETBUF_NUM_ADDRS; ++i) {
linkaddr_copy(&packetbuf_addrs[i].addr, &linkaddr_null);
}
}

  很简单,清空两个属性数组packetbuf_attrs和packetbuf_addrs。

packetbuf_attr_copyto

1
2
3
4
5
void packetbuf_attr_copyto(struct packetbuf_attr *attrs, struct packetbuf_addr *addrs)
{
memcpy(attrs, packetbuf_attrs, sizeof(packetbuf_attrs));
memcpy(addrs, packetbuf_addrs, sizeof(packetbuf_addrs));
}

  很简单,将两个属性数组的内容拷贝给attrs和addrs

packetbuf_attr_copyfrom

1
2
3
4
5
6
void
packetbuf_attr_copyfrom(struct packetbuf_attr *attrs, struct packetbuf_addr *addrs)
{
memcpy(packetbuf_attrs, attrs, sizeof(packetbuf_attrs));
memcpy(packetbuf_addrs, addrs, sizeof(packetbuf_addrs));
}

  很简单,从attrs和addrs拷贝到两个属性数组中。

packetbuf_set_attr

int packetbuf_set_attr(uint8_t type, const packetbuf_attr_t val)
{
packetbuf_attrs[type].val = val;
return 1;
}
  很简单,设置属性数组中对应属性的值。

packetbuf_attr

1
2
3
4
5
packetbuf_attr_t
packetbuf_attr(uint8_t type)
{
return packetbuf_attrs[type].val;
}

  很简单,返回属性数组中对于属性的值。

packetbuf_set_addr

1
2
3
4
5
int packetbuf_set_addr(uint8_t type, const linkaddr_t *addr)
{
linkaddr_copy(&packetbuf_addrs[type - PACKETBUF_ADDR_FIRST].addr, addr);
return 1;
}

  很简单,设置属性数组中对应属性的值。

packetbuf_addr

1
2
3
4
const linkaddr_t *packetbuf_addr(uint8_t type)
{
return &packetbuf_addrs[type - PACKETBUF_ADDR_FIRST].addr;
}

  很简单,返回属性数组中对于属性的值。

小结

  这么抽象的东西,居然把它给阐释清楚了,我得意的笑~~
  但是说实话,初次接触时,难免会有很多地方难以理解,没关系,在继续看完我的后续几篇博客后,整个路就完全通了,然后大家都可以嘚瑟了O(∩_∩)O哈哈~