linux netlink詳解4-Generic Netlink初始化創建

1 概述

Generic Netlink 是內核專門為了擴展netlink協議簇而設計的“通用netlink協議簇”。由於netlink協議最多支持32個協議簇，目前Linux4.1的內核中已經使用其中21個，對於用戶需要定制特殊的協議類型略顯不夠，而且用戶還需自行在include/linux/netlink.h中添加簇定義，但有時不方便，為此Linux設計了這種通用Netlink協議簇，用戶可在此之上定義更多類型的子協議。Generic Netlink使用NETLINK_GENERIC類型協議簇，同樣基於netlink子系統。具體框架如下：                                                              Genetlink消息基於這個消息結構類型並定制化為如下結構：

              

其中family頭對於Genetlink來說就是Generic消息頭genlmsghdr，接下來是可選的用戶特定消息頭，最后才是可選的有效載荷，即一個個消息屬性實例。Genetlink消息是命令驅動式的，即每一條消息的genlmsghdr中都指明了當前消息的cmd消息命令，這些消息cmd命令由用戶自行定義。內核在接收到用戶的genl消息后，首先會對命令cmd做判斷，找到對應的消息處理結構（可能會執行attr有效性檢查），然后才會去調用消息處理回調函數從消息載荷區中讀取並處理其所需要的的attr屬性載荷。

2 主要數據

2.1 struct genlmsghdr

Generic Netlink消息頭結構。Generic Netlink消息頭比較簡單，僅包含了兩個字段。其中cmd表示消息命令，對於用戶自己定義的每個子協議類型都需要定義特定的消息命令集，這里該字段表示當前消息的消息命令；version字段表示版本控制，可以在在不破壞向后兼容性的情況下修改消息的格式，可以不使用該字段；最后的reserved字段保留。

struct genlmsghdr {
    __u8    cmd;
    __u8    version;
    __u16    reserved;
};

2.2 struct genl_family

Generic Netlink Family結構：struct genl_family，內核中完成注冊。Generic Netlink按照family進行管理，用戶需注冊自己定義的genl_family結構，同時內核使用一個哈希表family_ht對已經注冊的genl family進行管理。

struct genl_family {
    unsigned int        id;//genl family的ID號，一般由內核進行分配，取值范圍為GENL_MIN_ID~GENL_MAX_ID（16~1023），其中GENL_ID_CTRL為控制器的family ID，不可另行分配，該familyID全局唯一並且在family_ht中的位置也由該值確定
    unsigned int        hdrsize;//用戶私有報頭的長度，即可選的user msg header長度，若沒有則為0
    char            name[GENL_NAMSIZ];//genl family的名稱，必須是獨一無二且用戶層已知的（用戶通過它來向控制查找family id）
    unsigned int        version;//版本號
    unsigned int        maxattr;//消息屬性attr最大的類型數（即該genl family所支持的最大attr屬性類型的種類個數）
    bool            netnsok;//指示當前簇是否能夠處理網絡命名空間
    bool            parallel_ops;
    int            (*pre_doit)(const struct genl_ops *ops,
                        struct sk_buff *skb,
                        struct genl_info *info);//調用genl_ops結構中處理消息函數doit()前調用的鈎子函數，一般用於執行一些前置的當前簇通用化處理，例如對臨界區加鎖等
    void            (*post_doit)(const struct genl_ops *ops,
                         struct sk_buff *skb,
                         struct genl_info *info);//調用genl_ops結構中處理消息函數doit()后調用的鈎子函數，一般執行pre_doit函數相反的操作
        /*在綁定/解綁定socket到一個特定的genl netlink組播組中調用,目前內核中沒有相關使用*/
    int            (*mcast_bind)(struct net *net, int group);
    void            (*mcast_unbind)(struct net *net, int group);
    struct nlattr **    attrbuf;    /* 保存拷貝的attr屬性緩存*/
    const struct genl_ops *    ops;        /* 保存genl family命令處理結構即命令的個數*/
    const struct genl_multicast_group *mcgrps; /* 保存當前簇使用的組播組及組播地址的個數*/
    unsigned int        n_ops;        /* 保存genl family命令處理結構即命令的個數*/
    unsigned int        n_mcgrps;    /* 保存當前簇使用的組播組及組播地址的個數 */
    unsigned int        mcgrp_offset;    /* private */
    struct list_head    family_list;    /* 鏈表結構，用於將當前當前簇鏈入全局family_ht散列表中*/
    struct module        *module;
}

2.3 struct genl_ops

Generic Netlink Family命令處理結構，內核中完成注冊。該結構用於注冊genl family的用戶命令cmd處理函數。對於只向應用層發送消息的簇可以不用實現和注冊該結構。

struct genl_ops {
    const struct nla_policy    *policy;//屬性attr有效性策略，若該字段不為空，在genl執行消息處理函數前會對消息中的attr屬性進行校驗，否則則不做校驗
    int               (*doit)(struct sk_buff *skb,
                       struct genl_info *info);//標准命令回調函數，在當前族中收到數據時觸發調用，函數的第一個入參skb中保存了用戶下發的消息內容
    int               (*start)(struct netlink_callback *cb);
    int               (*dumpit)(struct sk_buff *skb,
                     struct netlink_callback *cb);  --------- 詳解1
    int               (*done)(struct netlink_callback *cb);//轉儲結束后執行的回調函數
    u8            cmd;//簇命令類型，由用戶自行根據需要定義
    u8            internal_flags;//簇私有標識，用於進行一些分支處理，可以不使用
    u8            flags;//操作標識，有以下四種類型,在genetlink.h中定義 ---------- 詳解2
};

詳解1：dumpit：轉儲回調函數，當genl_ops的flag標志被添加了NLM_F_DUMP以后會調用該回調函數，這里的第一個入參skb中不再有用戶下發消息內容，而是要求函數能夠在傳入的skb中填入消息載荷並返回填入數據長度。

詳解2：操作標識，有以下四種類型，在genetlink.h中定義，如下：

#define GENL_ADMIN_PERM        0x01    // 當設置該標識時表示本命令操作需要具有CAP_NET_ADMIN權限 
#define GENL_CMD_CAP_DO        0x02    // 當genl_ops結構中實現了doit()回調函數則設置該標識 
#define GENL_CMD_CAP_DUMP    0x04    // 當genl_ops結構中實現了dumpit()回調函數則設置該標識
#define GENL_CMD_CAP_HASPOL    0x08    //當genl_ops結構中定義了屬性有效性策略（nla_policy）則設置該標識 

2.4 struct genl_info

Generic Netlink Family內核接收消息結構。內核在接收到用戶的genetlink消息后，會對消息解析並封裝成genl_info結構，便於命令回校函數進行處理，其中各字段含義如下：

struct genl_info {
    u32            snd_seq;//消息的發送序號,不強制使用
    u32            snd_portid;//消息發送端socket所綁定的ID
    struct nlmsghdr *    nlhdr;//netlink消息頭
    struct genlmsghdr *    genlhdr;//generic netlink消息頭
    void *            userhdr;//用戶私有報頭
    struct nlattr **    attrs;//netlink屬性，包含了消息的實際載荷
    possible_net_t        _net;//network namespace
    void *            user_ptr[2];//應用指針
};

3 Generic Netlink初始化

Generic Netlink只是中特殊類型的Netlink，本質上還是依賴於netlink的內核機制，相關的函數在genetlink.c中，由genl_init()啟動初始化流程。

3.1 函數genl_init

其定義如下：

static int __init genl_init(void)
{
    int i, err;

    for (i = 0; i < GENL_FAM_TAB_SIZE; i++)
        INIT_LIST_HEAD(&family_ht[i]);//初始化用於保存和維護Generic netlink family的散列表family_ht數組

    err = genl_register_family_with_ops_groups(&genl_ctrl, genl_ctrl_ops,  ----------------- 詳解1 函數詳解見3.2節
                           genl_ctrl_groups);//向內核Generic netlink子系統注冊控制器簇類型的Genetlink Family
    if (err < 0)
        goto problem;

    err = register_pernet_subsys(&genl_pernet_ops);//為當前系統中的網絡命名空間創建Generic Netlink套接字  --------------- 詳解2見3.3節
    if (err)
        goto problem;

    return 0;

problem:
    panic("GENL: Cannot register controller: %d\n", err);
}

詳解1：genl_ctrl : 調用genl_register_family_with_ops_groups向內核Generic netlink子系統注冊控制器簇類型的Genetlink Family。genl_ctrl的定義如下：

/**************************************************************************
 * Controller
 **************************************************************************/

static struct genl_family genl_ctrl = {
    .id = GENL_ID_CTRL,//分配區間的最小值
    .name = "nlctrl",
    .version = 0x2,
    .maxattr = CTRL_ATTR_MAX,//maxattr定義為支持的attr屬性最大個數
    .netnsok = true,//為true表示支持net命名空間
};

maxattr定義為支持的attr屬性最大個數CTRL_ATTR_MAX，定義如下，這里為genetlink控制器定義了以CTRL_ATTR_UNSPEC為開頭到最后的__CTRL_ATTR_MAX中的一共7個attr屬性類型。

enum {
    CTRL_ATTR_UNSPEC,
    CTRL_ATTR_FAMILY_ID,
    CTRL_ATTR_FAMILY_NAME,
    CTRL_ATTR_VERSION,
    CTRL_ATTR_HDRSIZE,
    CTRL_ATTR_MAXATTR,
    CTRL_ATTR_OPS,
    CTRL_ATTR_MCAST_GROUPS,
    __CTRL_ATTR_MAX,
};
 
#define CTRL_ATTR_MAX(__CTRL_ATTR_MAX - 1)

詳解1 genl_ctrl_ops：

這里為控制器類型的genetlink family只定義了一種cmd類型的內核操作接口，即CTRL_CMD_GETFAMILY，它用於應用空間從內核中獲取指定family名稱的ID號。因為該ID號在內核注冊family時由內核進行分配，應用空間一般只知道需要通信的family name，但是要發起通信就必須知道該ID號，所以內核設計了控制器類型的family並定義了CTRL_CMD_GETFAMILY命令的處理接口用於應用程序查找ID號。
然后指明doit和dumpit回調函數為ctrl_getfamily和ctrl_dumpfamily。

static const struct genl_ops genl_ctrl_ops[] = {
    {
        .cmd        = CTRL_CMD_GETFAMILY,
        .doit        = ctrl_getfamily,
        .dumpit        = ctrl_dumpfamily,
        .policy        = ctrl_policy,
    },
};

最后指定attr有效性策略為ctrl_policy：

static const struct nla_policy ctrl_policy[CTRL_ATTR_MAX+1] = {
    [CTRL_ATTR_FAMILY_ID]    = { .type = NLA_U16 },//限定類型為16位無符號數
    [CTRL_ATTR_FAMILY_NAME]    = { .type = NLA_NUL_STRING,
                    .len = GENL_NAMSIZ - 1 },//限定為空結尾的字符串類型並限定了長度
};

詳解1genl_ctrl_groups注冊的組播組

static struct genl_multicast_group genl_ctrl_groups[] = {
{ .name = "notify", },//添加了name為”notify“的組播組
};

3.2 genl_register_family_with_ops_groups函數

#define genl_register_family_with_ops_groups(family, ops, grps)    \
    _genl_register_family_with_ops_grps((family),            \
                        (ops), ARRAY_SIZE(ops),    \
                        (grps), ARRAY_SIZE(grps))

static inline int
_genl_register_family_with_ops_grps(struct genl_family *family,
                    const struct genl_ops *ops, size_t n_ops,
                    const struct genl_multicast_group *mcgrps,
                    size_t n_mcgrps)
{      //初始化了family的ops等字段
    family->module = THIS_MODULE;
    family->ops = ops;
    family->n_ops = n_ops;
    family->mcgrps = mcgrps;
    family->n_mcgrps = n_mcgrps;
    return __genl_register_family(family);
}

函數__genl_register_family

int __genl_register_family(struct genl_family *family)
{
    int err = -EINVAL, i;
        //對入參的ID號進行判斷，一般來說，為了保證ID號的全局唯一性，程序中一般都設置為GENL_ID_GENERATE，由內核統一分配（當然這里注冊控制器family除外了）。
    if (family->id && family->id < GENL_MIN_ID)
        goto errout;

    if (family->id > GENL_MAX_ID)
        goto errout;

    err = genl_validate_ops(family);//----------- 詳解1
    if (err)
        return err;

    genl_lock_all();

    if (genl_family_find_byname(family->name)) {
        err = -EEXIST;
        goto errout_locked;
    }

    if (family->id == GENL_ID_GENERATE) {//判斷傳入的ID號是否為GENL_ID_GENERATE，若是則由內核分配一個空閑的ID號，否則得確保程序指定的ID號沒有被使用過
        u16 newid = genl_generate_id();

        if (!newid) {
            err = -ENOMEM;
            goto errout_locked;
        }

        family->id = newid;
    } else if (genl_family_find_byid(family->id)) {
        err = -EEXIST;
        goto errout_locked;
    }

    if (family->maxattr && !family->parallel_ops) {// ------------- 詳解2
        family->attrbuf = kmalloc((family->maxattr+1) *
                    sizeof(struct nlattr *), GFP_KERNEL);
        if (family->attrbuf == NULL) {
            err = -ENOMEM;
            goto errout_locked;
        }
    } else
        family->attrbuf = NULL;

    err = genl_validate_assign_mc_groups(family);//---------------- 詳解3
    if (err)
        goto errout_free;

    list_add_tail(&family->family_list, genl_family_chain(family->id));//將family注冊到鏈表中
    genl_unlock_all();

    /* send all events */
    genl_ctrl_event(CTRL_CMD_NEWFAMILY, family, NULL, 0);//---------- 詳解4
    for (i = 0; i < family->n_mcgrps; i++)
        genl_ctrl_event(CTRL_CMD_NEWMCAST_GRP, family,
                &family->mcgrps[i], family->mcgrp_offset + i);

    return 0;

errout_free:
    kfree(family->attrbuf);
errout_locked:
    genl_unlock_all();
errout:
    return err;
}

詳解1：調用genl_validate_ops對ops函數集做校驗，對於每一個注冊的genl_ops結構，其中doit和dumpit回調函數必須至少實現一個，然后其針對的cmd命令不可以出現重復，否則返回錯誤，注冊失敗。然后上鎖開始啟動鏈表操作，首先需要確保的是family name的全局唯一性，因此這里會查找是否有同名的簇已經注冊了，若有就不能再注冊了。

詳解2：接着根據注冊的最大attr參數maxattr，這里對於genl_ctrl來說一共分配了CTRL_ATTR_MAX+1個指針內存空間，以后用於緩存attr屬性（ 注意僅僅是保存屬性的地址而非內容）。

詳解3：調用genl_validate_assign_mc_groups()函數判斷新增組播地址空間，該函數一共做了3件事：（1）判斷注冊family的group組播名的有效性；（2）為該family分配組播地址比特位並將bit偏移保存到family->mcgrp_offset變量中（由於generic netlink中不同類型的family簇共用NETLINK_GENERIC協議類型的group組播地址空間，因此內核特別維護了幾個全局變量mc_groups_longs、mc_groups和mc_group_start用以維護組播地址的比特位，另外對於幾種特殊的family是已經分配了的。無需再行分配，例如這里的crtl控制器）；（3）更新全局nl_table對應的NETLINK_GENERIC協議類型netlink的groups標識。

詳解4：調用genl_ctrl_event()函數向內核的控制器family發送CTRL_CMD_NEWFAMILY和CTRL_CMD_NEWMCAST_GRP命令消息，當然這里本身就是在創建ctrl控制器family，所以該函數不會做任何的事情。

3.3 函數register_pernet_subsys

為當前系統中的網絡命名空間創建Generic Netlink套接字。

int register_pernet_subsys(struct pernet_operations *ops)
{
    int error;
    mutex_lock(&net_mutex);
    error =  register_pernet_operations(first_device, ops);
    mutex_unlock(&net_mutex);
    return error;
}

genl_pernet_ops的定義：

static struct pernet_operations genl_pernet_ops = {
    .init = genl_pernet_init,
    .exit = genl_pernet_exit,
};

static int __net_init genl_pernet_init(struct net *net)
{
    struct netlink_kernel_cfg cfg = {
        .input        = genl_rcv,//指定了消息處理函數為genl_rcv()
        .flags        = NL_CFG_F_NONROOT_RECV,
        .bind        = genl_bind,//套接字綁定函數
        .unbind        = genl_unbind,//解綁定函數
    };

    /* we'll bump the group number right afterwards */
    net->genl_sock = netlink_kernel_create(net, NETLINK_GENERIC, &cfg);//完成內核套接字的注冊 詳解1

    if (!net->genl_sock && net_eq(net, &init_net))
        panic("GENL: Cannot initialize generic netlink\n");

    if (!net->genl_sock)
        return -ENOMEM;

    return 0;
}

詳解1：netlink_kernel_create()函數完成內核套接字的注冊（netlink_kernel_create函數在前文中已分析過），並將生成的套接字賦值到網絡命名空間net的genl_sock中，以后就可以通過net->genl_sock來找到genetlink內核套接字了。

4 generic netlink初始化過程總結

參考博文：https://blog.csdn.net/luckyapple1028/article/details/51172455