libnl概述

Posted 2021-03-21 hshy

以下三个库都基于其核心库libnl：

libnl-route：用于和Kernel中的Routing子系统交互。

libnl-nf：用于和Kernel中的Netfilter子系统交互。

libnl-genl：用于和Kernel中的Generic Netlink模块交互。 

 

本节介绍libnl中的一些常用API。详细内容还请读者参考其官方网站中的文档，地址为http://www.infradead.org/~tgr/libnl/doc/api/group__cb.html

1 结构体

  libnl以面向对象的方式重新封装了netlink原有的API。

( 1）netlink message消息结构体 

struct nl_msg{

        int                  nm_protocol;

        int                  nm_flags;

        struct sockaddr_nl   nm_src;

        struct sockaddr_nl   nm_dst;

        struct ucred         nm_creds;

        struct nlmsghdr *    nm_nlh;

        size_t               nm_size;

        int                  nm_refcnt;

};

 

（2）netlink socket结构体

    netlink socket以及其包含具体文件描述符的相关属性通过结构体struct nl_sock表示

struct nl_sock{

   struct sockaddr_nl    s_local;

   struct sockaddr_nl    s_peer;

   int                   s_fd;

   int                   s_proto;

   unsigned int          s_seq_next;

   unsigned int          s_seq_expect;

   int                   s_flags;

   struct nl_cb *        s_cb;

};

       1）使用前首先要分配nl_sock：

           struct nl_sock *nl_socket_alloc(void)； //分配新的netlink socket，返回新分配的nl_sock地址或者NULL

           struct nl_sock *nl_socket_alloc_cb(struct nl_cb *cb);  //根据给定的回调函数nl_cb分配新的nl_sock，返回新分配的nl_sock地址或者NULL

       2） 使用后需释放：

           void nl_socket_free(struct nl_sock *sk)；

       3）连接：

           int nl_connect(struct nl_sock *sk, int protocol);  //nl_connet将通过bind函数将netlink socket和protocol对应的模块进行绑定：

       4）关闭：

           void nl_close(struct nl_sock *sk)；

       5）发送：

           int nl_sendto(struct nl_sock *sk, void *buf, size_t size); //发送buffer数据到nl_sock

           int nl_sendmsg(struct nl_sock *sk, struct nl_msg *msg, struct msghdr *hdr); //发送nl_msg数据，指定msghdr

           int nl_send(struct nl_sock *sk, struct nl_msg *msg)；

 

（3） 回调处理

 linbl还可为每个nl_sock设置消息处理回调函数，当该socket上收到消息后，就会回调此函数进行处理。 回调函数及参数封装在结构体struct nl_cb中

struct nl_cb{

   nl_recvmsg_msg_cb_t      cb_set[NL_CB_TYPE_MAX+1];

   void * cb_args[NL_CB_TYPE_MAX+1];

   nl_recvmsg_err_cb_t      cb_err;

   void *cb_err_arg;

 

   /** May be used to replace nl_recvmsgs with your own implementation in all internal calls to nl_recvmsgs. */

  int  (*cb_recvmsgs_ow)(struct nl_sock *,     struct nl_cb *);

 

   /** Overwrite internal calls to nl_recv, must return the number of octets read and allocate a buffer for the received data. */

  int   (*cb_recv_ow)(struct nl_sock *, struct sockaddr_nl *,   unsigned char **, struct ucred **);

 

   /** Overwrites internal calls to nl_send, must send the netlink message. */

  int    (*cb_send_ow)(struct nl_sock *,  struct nl_msg *);

  int   cb_refcnt;

};

设置回调：void nl_socket_set_cb(struct nl_sock *sk, struct nl_cb *cb);

获取该nl_sock设置的回调函数信息：struct nl_cb *nl_socket_get_cb(const struct nl_sock *sk);

 

注意，libnl库对nl_cb函数进行细分归类

/*

  1）回调函数的返回值包括以下：

enum nl_cb_action {

  NL_OK,   //表示处理正常。

  NL_SKIP,  //表示停止当前netlink消息分析，转而去分析接收buffer中下一条netlink消息（消息分 片的情况）。

  NL_STOP, //表示停止此次接收buffer中的消息分析。

}；

 

 

 2）消息回调函数的类型：

enum  nl_cb_kind {

  NL_CB_DEFAULT,  //默认回调处理函数

  NL_CB_VERBOSE,  //默认处理函数，打印错误信息

  NL_CB_DEBUG,    //debug 处理函数

  NL_CB_CUSTOM, //用户自定义处理函数

  __NL_CB_KIND_MAX

}；

 

 

3）type类型

可用于处理底层不同netlink消息的情况。   例如，当收到的netlink消息无效时，将调用NL_CB_INVALIDE设置的回调函数进行处理。

enum  nl_cb_type {

  NL_CB_VALID,  //有效消息

  NL_CB_FINISH, //multipart消息结尾

  NL_CB_OVERRUN, //数据丢失报告

  NL_CB_SKIPPED, //跳过处理消息

  NL_CB_ACK,      //确认消息

  NL_CB_MSG_IN,   //所有接收到的消息

  NL_CB_MSG_OUT,   //所有发出的消息，除nl_sendto()外

  NL_CB_INVALID,   //无效消息

  NL_CB_SEQ_CHECK,  

  NL_CB_SEND_ACK,

  NL_CB_DUMP_INTR,

  __NL_CB_TYPE_MAX

}；

#include <netlink/handlers.h>  // 必须包含此头文件

1）初始化

  struct nl_cb *nl_cb_alloc(enum nl_cb_kind kind)；//分配新的nl_cb，返回新nl_cb地址或者NULL

  struct nl_cb *nl_cb_clone(struct nl_cb *orig) ;   //根据给定nl_cb复制新的nl_cb

2）设置

   int nl_cb_set(struct nl_cb *cb, enum nl_cb_type type, enum nl_cb_kind kind,   nl_recvmsg_msg_cb_t func, void *arg); //设置给定kind_type的callback

   int nl_cb_err(struct nl_cb *cb, enum nl_cb_kind kind,   nl_recvmsg_err_cb_t func, void * arg);  //设置错误callback

3）修改给定nl_sock的callbacks：

   int nl_socket_modify_cb(struct nl_sock *sk,   enum nl_cb_type type, enum nl_cb_kind kind,   nl_recvmsg_msg_cb_t func, void *arg); //

 

 

 2 libnl中的消息处理

libnl定义了自己的消息结构体struct nl_msg。不过它也提供API直接处理netlink的消息。常用的API如下。

#include <netlink/msg.h>   // 必须包含这个头文件

// 计算netlink消息体中对应部分的长度

int nlmsg_size(int payloadlen);  // 请参考图来理解这两个函数返回值的意义

int nlmsg_total_size(int payloadlen);

 

其他可直接处理netlink消息的API如下。

struct nlmsghdr *nlmsg_next(struct nlmsghdr *hdr, int *remaining);

int nlmsg_ok(const struct nlmsghdr *hdr, int remaining);

/*定义一个消息处理的for循环宏，其值等于

for (int rem = len, pos = head; nlmsg_ok(pos, rem);

      pos = nlmsg_next(pos, &rem))

*/

#define nlmsg_for_each(pos,head,en)   

 

开发者也可以通过libnl定义的消息结构体nl_msg进行相关操作，和nl_msg有关的API如下。

struct nl_msg *nlmsg_alloc(void);

void nlmsg_free(struct nl_msg *msg);

// nl_msg内部肯定会指向一个netlink消息头实例，下面这个函数用于填充netlink消息头

struct nlmsghdr *nlmsg_put(struct nl_msg *msg,   uint32_t port, uint32_t seqnr,  int nlmsg_type, int payload, int nlmsg_flags);

 

（3）libnl中的消息发送和接收

netlink直接利用系统调用（如send、recv、sendmsg、recvmsg等）进行数据收发，而libnl封装了自己特有的数据收发API。其中和发送有关的几个主要API如下。

// 直接发送netlink消息

int nl_sendto (struct nl_sock *sk, void *buf, size_t size)

 

// 发送nl_msg消息

int nl_send (struct nl_sock *sk, struct nl_msg *msg)

int nl_send_simple(struct nl_sock *sk, int type,  int flags,void *buf, size_t size);

 

常用的数据接收API如下。

// 核心接收函数。nla参数用于存储发送端的地址信息。creds用于存储权限相关的信息

int nl_recv(struct nl_sock *sk, struct sockaddr_nl *nla,   unsigned char **buf, struct ucred **creds)

// 内部通过nl_recv接收消息，然后通过cb回调结构体中的回调函数传给接收者

int nl_recvmsgs (struct nl_sock *sk, struct nl_cb *cb)

 

（4）libnl-genl API介绍

  libnl-genl封装了对generic netlink模块的处理，它基于libnl。Linux中关于generic netlink的说明几乎没有，建议大家参考libnl中的说明。

其中，genlmsghdr的原型如下。

struct genlmsghdr {

 __u8 cmd;  // cmd和version都和具体的案例有关

 __u8 version;

 __u16 reserved; // 保留

};

 

genl常用的API如下。

// 和libnl的nl_connect类型，只不过协议类型为GENERIC_NETLINK

int genl_connect (struct nl_sock *sk)

 

// genlmsg_put用于填充图中的nlmsghdr、genlmsghder和用户自定义的消息头。详细内容见下文

void* genlmsg_put (struct nl_msg *msg, uint32_t port, uint32_t seq, int family, int hdrlen, int flags, uint8_t cmd, uint8_t version)

 

// 用于获取genl消息中携带的nlattr内容

struct nlattr* genlmsg_attrdata(const struct genlmsghdr *gnlh,int hdrlen)   

 

另外，genl还有几个比较重要的API，它们和genl机制的内核实现有关，这里仅简单介绍其中几点内容。为实现genl机制，内核创建了一个虚拟的Generic Netlink Bus。所有genl的使用者（包含内核模块或用户空间进程）都会注册到此Bus上。这些使用者注册时，都需要填充一个名为genl_family的数据结构，该结构是一种身份标示。所以某一方只要设置好genlmsg_put中的family参数，数据就能传递到对应的模块。

 

family是一个整型，可读性较差，所以genl使用者往往会指定一个字符串作为family name。而family name和family的对应关系则由genl中另外一个重要模块去处理。这个模块就是genl中的Controller，它也是Generic Bus使用者。其family name为“nlctrl”，只不过它的family是固定的，目前取值为16（一般为它定义一个NETLINK_GENERIC宏）。Controller的一个重要作用就是为其他注册者建立family name和family之间关系，也就是动态为其他注册者分配family编号。另外，Controller也支持查询，即返回当前Kernel中注册的所有genl模块的family name和family的值。

 

对用户空间程序来说，只要知道family的值，就可和指定模块进行通信了。libnl-genl封装了上述操作，并提供了几个常用的API。

// 根据family name字符串去查询family，该函数内部实现将发送查询消息给Controller

  int  genl_ctrl_resolve (struct nl_sock *sk, const char *name)

 

/*

  如果每次都向Controller去查询family编号将严重影响效率，所以libnl-genl会把查询到的信息   缓存起来。

  下面这个函数将分配一个nl_cache列表，其内容存储了当前注册到Generic Netlink Bus上所有注册者的信息。

*/

int genl_ctrl_alloc_cache (struct nl_sock *sk, struct nl_cache **result)

 

// 根据family name从缓存中获取对应的genl_family信息

struct genl_family * genl_ctrl_search_by_name (struct nl_cache *cache, const char *name)

 

提示　相比直接使用netlink API，libnl对开发者更加友好，即使libnl封装得再好，netlink编程依然不是一件轻松的事情。目前为止，笔者还没有找到一篇文档能全面描述netlink中的protocol及对应的多播组、genl中Controller模块所支持的命令等至关重要的知识点。当年在Windows平台做开发时，微软为开发者提供的编程文档中不仅有原理性说明，还有很多编程技巧。这些内容对开发者而言都是无价之宝。不过，指望Linux重新修订、增补文档无疑是一件异想天开的事情。在此笔者也只能希望读者们在学习过程中注意收集资料并和大家一起分享了。