Generic Netlink詳解

netlink socket是一種用於用戶態進程和內核態進程之間的通信機制。它通過為內核模塊提供一組特殊的API，並為用戶程序提供了一組標准的socket接口的方式，實現了全雙工的通訊連接。

Netlink的特點：

• 雙向傳輸，異步通信
• 用戶空間中使用標准socket API
• 內核空間中使用專門的API
• 支持多播
• 可由內核端發起通信
• 支持32種協議類型

netlink僅支持32種協議類型，這在實際應用中可能並不足夠。因此產生了generic netlink（以下簡稱為genl）。
generic netlink支持1023個子協議號，彌補了netlink協議類型較少的缺陷。支持協議號自動分配。它基於netlink，但是在內核中，generic netlink的接口與netlink並不相同。

1. Generic Netlink框架概述

圖1表示了Generic Netlink框架。Kernel socket API向用戶空間和內核空間分別提供接口。
Netlink子系統(1)是所有genl通信的基礎。Netlink子系統中收到的所有Generic類型的netlink數據都被送到genl總線(2)上；從內核發出的數據也經由genl總線送至netlink子系統，再打包送至用戶空間。
Generic Netlink控制器(4)作為內核的一部分，負責動態地分配genl通道(即genl family id)，並管理genl任務。genl控制器是一個特殊的genl內核用戶，它負責監聽genl bus上的通信通道。genl通信建立在一系列的通信通道的基礎上，每個genl family對應多個通道，這些通道由genl控制器動態分配。

      +---------------------+ +---------------------+ | (3) application "A" | | (3) application "B" | +------+--------------+ +--------------+------+ | | \ / \ / | | +-------+--------------------------------+-------+ | : : | user-space =====+ : (5) Kernel socket API : +================ | : : | kernel-space +--------+-------------------------------+-------+ | | +-----+-------------------------------+----+ | (1) Netlink subsystem | +---------------------+--------------------+ | +---------------------+--------------------+ | (2) Generic Netlink bus | +--+--------------------------+-------+----+ | | | +-------+---------+ | | | (4) Controller | / \ +-----------------+ / \ | | +------------------+--+ +--+------------------+ | (3) kernel user "X" | | (3) kernel user "Y" | +---------------------+ +---------------------+ 

圖1：generic netlink框架

2 Generic Netlink相關結構體
2.1 genl family
Generic Netlink是基於客戶端-服務端模型的通信機制。服務端注冊family（family是對genl服務的各項定義的集合）。控制器和客戶端都通過已注冊的信息與服務端通信。
genl family的結構體如下：

struct genl_family
{
      unsigned int id; unsigned int hdrsize; char name[GENL_NAMSIZ]; unsigned int version; unsigned int maxattr; struct nlattr ** attrbuf; struct list_head ops_list; struct list_head family_list; };

對此結構體元素具體解釋如下：

* id: family id。當新注冊一個family的時候，應該用GENL_ID_GENERATE宏(0x0)，表示請控制器自動為family分配的一個id。0x10保留供genl控制器使用。
* hdrsize: 用戶自定議頭部長度。即圖2中User Msg的長度。如果沒有用戶自定義頭部，這個值被賦為0。
* version: 版本號，一般填1即可。
* name: family名，要求不同的family使用不同的名字。以便控制器進行正確的查找。
* maxattr：genl使用netlink標准的attr來傳輸數據。此字段定義了最大attr類型數。（注意：不是一次傳輸多少個attr，而是一共 有多少種attr，因此，這個值可以被設為0，為0代表不區分所收到的數據的attr type）。在接收數據時，可以根據attr type，獲得指定的attr type的數據在整體數據中的位置。

* struct nlattr **attrbuf
* struct list_head ops_list
* struct list_head family_list
以上的三個字段為私有字段，由系統自動配置，開發者不需要做配置。

圖2 genl報文與linux中各變量的對應關系

圖3 genl報文格式

2.2 genl_ops 結構體

struct genl_ops
{
      u8                      cmd;
      unsigned int flags; struct nla_policy *policy; int (*doit)(struct sk_buff *skb, struct genl_info *info); int (*dumpit)(struct sk_buff *skb, struct netlink_callback *cb); struct list_head ops_list; };

•   cmd: 命令名。用於識別各genl_ops
•   flag: 各種設置屬性，以“或”連接。在需要admin特權級別時，使用GENL_ADMIN_PERM
•   policy：定義了attr規則。如果此指針非空，genl在觸發事件處理程序之前，會使用這個字段來對幀中的attr做校驗（見nlmsg_parse函數）。該字段可以為空，表示在觸發事件處理程序之前，不做校驗。
  

        policy是一個struct nla_policy的數組。struct nla_policy結構體表示如下：

struct nla_policy
        {
            u16             type;
            u16             len;
        };

        其中，type字段表示attr中的數據類型，可被配置為：
       NLA_UNSPEC--未定義
       NLA_U8, NLA_U16, NLA_U32, NLA_U64為8bits, 16bits, 32bits, 64bits的無符號整型
       NLA_STRING--字符串
       NLA_NUL_STRING--空終止符字符串
       NLA_NESTED--attr流

       len字段的意思是：如果在type字段配置的是字符串有關的值，要把len設置為字符串的最大長度（不包含結尾的'\0'）。如果type字段未設置或被設置為NLA_UNSPEC，那么這里要設置為attr的payload部分的長度。

• doit：這是一個回調函數。在generic netlink收到數據時觸發，運行在進程上下文。

        doit傳入兩個參數，skb為觸發此回調函數的socket buffer。第二個參數是一個genl_info結構體，定義如下：

struct genl_info
        {
             u32                     snd_seq;
             u32                     snd_pid;
             struct nlmsghdr * nlhdr; struct genlmsghdr * genlhdr; void * userhdr; struct nlattr ** attrs; };

                 * snd_seq：發送序號                

                 * snd_pid：發送客戶端的PID               

                 * nlhdr：netlink header的指針                

                 * genlmsghdr：genl頭部的指針（即family頭部）                

                 * userhdr：用戶自定義頭部指針                

                * attrs：attrs，如果定義了genl_ops->policy，這里的attrs是被policy過濾以后的結果。在完成了操作以后，如果 執行正確，返回0；否則，返回一個負數。負數的返回值會觸發NLMSG_ERROR消息。當genl_ops的flag標志被添加了 NLMSG_ERROR時，即使doit返回0，也會觸發NLMSG_ERROR消息。

• dumpit

這是一個回調函數，當genl_ops的flag標志被添加了NLM_F_DUMP以后，每次收到genl消息即會回觸發這個函數。 dumpit與doit的區別是:dumpit的第一個參數skb不會攜帶從客戶端發來的數據。相反地，開發者應該在skb中填入需要傳給客戶端的數據， 然后，並skb的數據長度（可以用skb->len）return。skb中攜帶的數據會被自動送到客戶端。只要dumpit的返回值大於 0，dumpit函數就會再次被調用，並被要求在skb中填入數據。當服務端沒有數據要傳給客戶端時，dumpit要返回0。如果函數中出錯，要求返回一 個負值。關於doit和dumpit的觸發過程，可以查看源碼中的genl_rcv_msg函數。

• ops_list

為私有字段，由系統自動配置，開發者不需要做配置。

3 Generic Netlink服務端（內核）初始化

初始化Generic Netlink的過程分為以下四步：定義family，定義operation，注冊family，注冊operation。下面通過一個簡單例子來說明 如何完成Generic Netlink的初始化。我們首先創建一個genl_family結構體的實例。我們在這里定義一個名為"DOC_EXMPL"的family

/* attribute type */
  enum { DOC_EXMPL_A_UNSPEC, DOC_EXMPL_A_MSG, __DOC_EXMPL_A_MAX, }; #define DOC_EXMPL_A_MAX (__DOC_EXMPL_A_MAX - 1) /* family definition */ static struct genl_family doc_exmpl_gnl_family = { .id = GENL_ID_GENERATE, .hdrsize = 0, .name = "DOC_EXMPL", .version = 1, .maxattr = DOC_EXMPL_A_MAX, };

以上，我們定義了一個僅有一種attribuste type的family。.id被配置為GENL_ID_GENERATE，指示genl控制器自動分配一個id。

第二步為family創建operations。我們至少要創建一個genl_ops結構體的實例。

/* doit handler */
  int doc_exmpl_echo(struct sk_buff *skb, struct genl_info *info) { /* message handling code goes here; return 0 on success, negative * values on failure */ } /* attribute policy */ static struct nla_policy doc_exmpl_genl_policy = [DOC_EXMPL_A_MAX + 1] = { [DOC_EXMPL_A_MSG] = { .type = NLA_NUL_STRING }, } /* commands */ enum { DOC_EXMPL_C_UNSPEC, DOC_EXMPL_C_ECHO, __DOC_EXMPL_C_ECHO, }; #define DOC_EXMPL_C_MAX (__DOC_EXMPL_C_MAX - 1) /* operation definition */ struct genl_ops doc_exmpl_gnl_ops_echo = { .cmd = DOC_EXMPL_C_ECHO, .flags = 0, .policy = doc_exmpl_genl_policy, .doit = genl_recv_doit, .dumpit = NULL, }

這里，我們把attribute policy設為NLA_NUL_STRING，表示attr中數據的屬性為無NULL結尾的字符串。控制器在收到數據時會自動完成這一類型檢查。

我們定義一個operation，它的id為DOC_EXMPL_C_ECHO，把上述的policy配置給它。一旦本family的genl消息在被總到genl總線上，doit函數（doc_exmpl_echo）會被調用。

接下來兩步是注冊family和注冊operations。

genl_register_family(&doc_exmpl_gnl_family);

genl_register_ops(&doc_exmpl_gnl_family, &doc_exmpl_gnl_ops_echo);

在完成genl操作后，記對完成對family的注銷操作。

genl_unregister_family(&doc_exmpl_gnl_family);

4 Generic Netlink客戶端（用戶空間）初始化

Generic Netlink在用戶空間的初始化和通常的socket通信一致。大致分為兩步，創建socket，把socket綁定到地址上（bind）。

下面也通過一個例子簡要說明一下用戶空間genl初始化的過程。

struct sockaddr_nl saddr;
    int                sock;
    sock = socket(AF_NETLINK, SOCK_RAW, NETLINK_GENERIC); if (sock < 0) { return -1; } memset(&saddr, 0, sizeof(saddr)); saddr.nl_family = AF_NETLINK; saddr.nl_pid = getpid(); if (bind(sock, (struct sockaddr*)&saddr, sizeof(saddr)) < 0) { printf("bind fail!\n"); close(*p_sock); return -1; }

上述代碼中，我們先創建一個socket，注意，第一個參數必須為AF_NETLINK 或 PF_NETLINK，表示創建netlink socket，第二個參數必須是SOCK_RAW或SOCK_DGRAM， 第三個參數指定netlink協議類型，我們要使用generic netlink，那么就要將其設置為：NETLINK_GENERIC。

接下來，對於genl不可缺少的一步就是獲取family id。family id是服務端注冊family時，由控制器自動分配的。此時客戶端尚不知道family id為多少，因此需要向客戶端請求family id。

下面是一段獲取family id的函數

static int genl_get_family_id(int sd, char *family_name) { msgtemplate_t ans; int id, rc; struct nlattr *na; int rep_len; rc = genl_send_msg(sd, GENL_ID_CTRL, 0, CTRL_CMD_GETFAMILY, 1, CTRL_ATTR_FAMILY_NAME, (void *)family_name, strlen(family_name)+1); rep_len = recv(sd, &ans, sizeof(ans), 0); if (rep_len < 0) { return 0; } if (ans.n.nlmsg_type == NLMSG_ERROR || !NLMSG_OK((&ans.n), rep_len)) { return 0; } na = (struct nlattr *) GENLMSG_DATA(&ans); na = (struct nlattr *) ((char *) na + NLA_ALIGN(na->nla_len)); if (na->nla_type == CTRL_ATTR_FAMILY_ID) { id = *(__u16 *) NLA_DATA(na); } else { id = 0; } return id; }

在這個函數中，調用genl_send_msg（這個函數會在下文中介紹並給出源碼）發送請求family id的消息，並調用recv接收服務端的反饋消息。這個消息中即包含了family id。

這個函數的第一個參數是已創建好的socket。第二個參數是family name，注意這里family name需要與服務端注冊famile時的name字段一致。該函數返回值即是family id以下是一個調用示例。
int fid = genl_get_family_id(sock, "DOC_EXMPL");

5 Generic Netlink通信
這一節對如何使用Generic Netlink完成內核空間與用戶空間的通信做介紹。並把我的示例代碼貢獻出來。

示例代碼呈現了內核（服務端）和用戶空間（客戶端）收發數據的過程。
5.1 內核發送數據
以下是內核端發送數據的源碼。在genl_msg_send_to_user中，調用genl_msg_prepare_usr_msg和 genl_msg_mk_usr_msg來准備socket buffer，為數據加上各種數據頭（參考圖2）。genlmsg_end把整個數據打包完成，通過genlmsg_unicast完成單播發送。

/** 
* genl_msg_send_to_user - 通過generic netlink發送數據到netlink 
*
* @data: 發送數據緩存 * @len: 數據長度 單位：byte * @pid: 發送到的客戶端pid * * return: * 0: 成功 * -1: 失敗 */ int genl_msg_send_to_user(void *data, int len, pid_t pid) { struct sk_buff *skb; size_t size; void *head; int rc; size = nla_total_size(len); /* total length of attribute including padding */ rc = genl_msg_prepare_usr_msg(DOC_EXMPL_C_ECHO, size, pid, &skb); if (rc) { return rc; } rc = genl_msg_mk_usr_msg(skb, DOC_EXMPL_A_MSG, data, len); if (rc) { kfree_skb(skb); return rc; } head = genlmsg_data(nlmsg_data(nlmsg_hdr(skb))); rc = genlmsg_end(skb, head); if (rc < 0) { kfree_skb(skb); return rc; } rc = genlmsg_unicast(&init_net, skb, pid); if (rc < 0) { return rc; } return 0; } static inline int genl_msg_mk_usr_msg(struct sk_buff *skb, int type, void *data, int len) { int rc; /* add a netlink attribute to a socket buffer */ if ((rc = nla_put(skb, type, len, data)) != 0) { return rc; } return 0; } static inline int genl_msg_prepare_usr_msg(u8 cmd, size_t size, pid_t pid, struct sk_buff **skbp) { struct sk_buff *skb; /* create a new netlink msg */ skb = genlmsg_new(size, GFP_KERNEL); if (skb == NULL) { return -ENOMEM; } /* Add a new netlink message to an skb */ genlmsg_put(skb, pid, 0, &genl_family, 0, cmd); *skbp = skb; return 0; }

5.2 用戶空間接收數據
客戶端調用通用的recv函數即可完成從內核來的數據的接收。需要注意的是，接收到的數據包含幾級的header（圖3），我們需要准確地定位到我們所需數據的位置。

當沒有用戶自定義頭部（即圖3中的User Msg，在注冊family時把hdrsize置0）時，可以構建這樣的數據結構用於接收數據。這樣，收到的數據中的netlink header和genl header就被很容易地剝離開來。

typedef struct msgtemplate { struct nlmsghdr n; struct genlmsghdr g; char data[MAX_MSG_SIZE]; } msgtemplate_t;

下面是客戶端接收數據函數的源碼：

#define GENLMSG_DATA(glh) ((void *)(NLMSG_DATA(glh) + GENL_HDRLEN)) #define NLA_DATA(na) ((void *)((char *)(na) + NLA_HDRLEN)) void genl_rcv_msg(int fid, int sock, char **string) { int ret; struct msgtemplate msg; struct nlattr *na; ret = recv(sock, &msg, sizeof(msg), 0); if (ret < 0) { return; } //printf("received length %d\n", ret); if (msg.n.nlmsg_type == NLMSG_ERROR || !NLMSG_OK((&msg.n), ret)) { return; } if (msg.n.nlmsg_type == fid && fid != 0) { na = (struct nlattr *) GENLMSG_DATA(&msg); *string = (char *)NLA_DATA(na); } }

以上函數中，第一個參數為family id，第二個參數為socket，第三個參數為待接收數據的buffer。

5.3 用戶空間發送數據
客戶端發送數據簡單地說就是調用通用的socket API---sendto來發送數據

/** 
* genl_send_msg - 通過generic netlink給內核發送數據 
*
* @sd: 客戶端socket * @nlmsg_type: family_id * @nlmsg_pid: 客戶端pid * @genl_cmd: 命令類型 * @genl_version: genl版本號 * @nla_type: netlink attr類型 * @nla_data: 發送的數據 * @nla_len: 發送數據長度 * * return: * 0: 成功 * -1: 失敗 */ int genl_send_msg(int sd, u_int16_t nlmsg_type, u_int32_t nlmsg_pid, u_int8_t genl_cmd, u_int8_t genl_version, u_int16_t nla_type, void *nla_data, int nla_len) { struct nlattr *na; struct sockaddr_nl nladdr; int r, buflen; char *buf; msgtemplate_t msg; if (nlmsg_type == 0) { return 0; } msg.n.nlmsg_len = NLMSG_LENGTH(GENL_HDRLEN); msg.n.nlmsg_type = nlmsg_type; msg.n.nlmsg_flags = NLM_F_REQUEST; msg.n.nlmsg_seq = 0; /* * nlmsg_pid是發送進程的端口號。 * Linux內核不關心這個字段，僅用於跟蹤消息。 */ msg.n.nlmsg_pid = nlmsg_pid; msg.g.cmd = genl_cmd; msg.g.version = genl_version; na = (struct nlattr *) GENLMSG_DATA(&msg); na->nla_type = nla_type; na->nla_len = nla_len + 1 + NLA_HDRLEN; memcpy(NLA_DATA(na), nla_data, nla_len); msg.n.nlmsg_len += NLMSG_ALIGN(na->nla_len); buf = (char *) &msg; buflen = msg.n.nlmsg_len ; memset(&nladdr, 0, sizeof(nladdr)); nladdr.nl_family = AF_NETLINK; while ((r = sendto(sd, buf, buflen, 0, (struct sockaddr *) &nladdr , sizeof(nladdr))) < buflen) { if (r > 0) { buf += r; buflen -= r; } else if (errno != EAGAIN) { return -1; } } return 0; }

5.4 內核接收數據
內核端一旦收到generic netlink數據，會觸發doit函數運行（上文第3節有提及doit的初始化方法）。

doit傳入兩個參數，skb即是接收到的數據，info包含了Genl消息的一些常用指針。這兩個結構體字段詳見內核源碼。

skb收到的數據還包括了多層的包頭，以下程序中的nlmsg_hdr，nlmsg_data，genlmsg_data，nla_data即是把這些包頭層層剝開，para->string指向的數據即是用用戶空間傳來的“純數據”。

int genl_recv_doit(struct sk_buff *skb, struct genl_info *info) { /* doit 沒有運行在中斷上下文 */ static int kthread_num = 0; struct nlmsghdr *nlhdr; struct genlmsghdr *genlhdr; struct nlattr *nlh; struct thread_para *para; /* 給線程傳遞參數的結構體 */ nlhdr = nlmsg_hdr(skb); genlhdr = nlmsg_data(nlhdr); nlh = genlmsg_data(genlhdr); /* 配置給新開線程所傳的參數 */ /* para 在線程函數thread_string_proc中釋放 */ para = (struct thread_para *)kmalloc(sizeof(struct thread_para), GFP_KERNEL); para->string = nla_data(nlh); para->pid = nlhdr->nlmsg_pid; /* 每收到一個字符串開辟一個線程 */ kthread_run(thread_string_proc, (void *)(para), "kthread %d", kthread_num++); return 0; }

 

http://www.tuicool.com/articles/jE7nim