设备驱动中的kset(kernel-4.7)

koject分析中绕不开kset结构，kset是kobject扩展，它包含一个kobject的链表，可以方便地表示sysfs中目录与子目录的关系。kset结构体定义在include/linux/kobject.h文件中，其内容如下：

struct sock;

/**
 * struct kset - a set of kobjects of a specific type, belonging to a specific subsystem.
 *
 * A kset defines a group of kobjects.  They can be individually
 * different "types" but overall these kobjects all want to be grouped
 * together and operated on in the same manner.  ksets are used to
 * define the attribute callbacks and other common events that happen to
 * a kobject.
 *
 * @list: the list of all kobjects for this kset
 * @list_lock: a lock for iterating over the kobjects
 * @kobj: the embedded kobject for this kset (recursion, isn't it fun...)
 * @uevent_ops: the set of uevent operations for this kset.  These are
 * called whenever a kobject has something happen to it so that the kset
 * can add new environment variables, or filter out the uevents if so
 * desired.
 */
struct kset {
    struct list_head list;//用于将该kset下的所有kobject链接成一个链表
    spinlock_t list_lock; //自旋锁，在遍历该kset下的kobject时用来加锁
    struct kobject kobj; //表示该kset的一个kobject
    const struct kset_uevent_ops *uevent_ops;
};

kset结构体中的uevent_ops是一组函数指针，当kset中的某个kobject状态发生变化需要通知用户空间时，就通过这些函数来完成。uevent_ops是struct kset_uevent_ops类型，该结构体定义在include/linux/kobject.h文件中，其定义如下：

struct kset_uevent_ops {
    int (* const filter)(struct kset *kset, struct kobject *kobj);
    const char *(* const name)(struct kset *kset, struct kobject *kobj);
    int (* const uevent)(struct kset *kset, struct kobject *kobj,
              struct kobj_uevent_env *env);
};

---

kset的创建和注册
要创建并注册一个kset，使用的是kset_create_and_add函数，该函数定义在lib/kobject.c文件中，其内容如下：

/**
 * kset_create_and_add - create a struct kset dynamically and add it to sysfs
 *
 * @name: the name for the kset
 * @uevent_ops: a struct kset_uevent_ops for the kset
 * @parent_kobj: the parent kobject of this kset, if any.
 *
 * This function creates a kset structure dynamically and registers it
 * with sysfs.  When you are finished with this structure, call
 * kset_unregister() and the structure will be dynamically freed when it
 * is no longer being used.
 *
 * If the kset was not able to be created, NULL will be returned.
 */
struct kset *kset_create_and_add(const char *name,
                 const struct kset_uevent_ops *uevent_ops,
                 struct kobject *parent_kobj)
{
    struct kset *kset;
    int error;

    kset = kset_create(name, uevent_ops, parent_kobj);
    if (!kset)
        return NULL;
    error = kset_register(kset);
    if (error) {
        kfree(kset);
        return NULL;
    }
    return kset;
}

kset_create_and_add函数的作用是动态创建一个kset结构并把它注册到sysfs文件系统中 。
三个参数为：

• name是kset的名字，它会被赋值给kset.kobj.name。
• uevent_ops是struct kset_uevent_ops变量，它会被赋值给kset.uevent_ops。
• parent_kobj是该kset的父kobject，它会被赋值给kset.kobj.parent。

函数中调用kset_create函数动态创建kset结构并对其进行初始化，该函数定义在lib/kobject.c文件中，其内容如下：

/**
 * kset_create - create a struct kset dynamically
 *
 * @name: the name for the kset
 * @uevent_ops: a struct kset_uevent_ops for the kset
 * @parent_kobj: the parent kobject of this kset, if any.
 *
 * This function creates a kset structure dynamically.  This structure can
 * then be registered with the system and show up in sysfs with a call to
 * kset_register().  When you are finished with this structure, if
 * kset_register() has been called, call kset_unregister() and the
 * structure will be dynamically freed when it is no longer being used.
 *
 * If the kset was not able to be created, NULL will be returned.
 */
static struct kset *kset_create(const char *name,
                const struct kset_uevent_ops *uevent_ops,
                struct kobject *parent_kobj)
{
    struct kset *kset;
    int retval;

    kset = kzalloc(sizeof(*kset), GFP_KERNEL);//为kset结构分配内存空间
    if (!kset)
        return NULL; 
    //将name参数赋值给kset.kobj.name。它对应kset在sysfs文件系统中的目录名
    retval = kobject_set_name(&kset->kobj, "%s", name);
    if (retval) {
        kfree(kset);
        return NULL;
    } 
    kset->uevent_ops = uevent_ops; //将uevent_ops赋值给kset->uevent_ops
    kset->kobj.parent = parent_kobj;//将parent_kobj 赋值给kset->kobj.parent

    /*
     * The kobject of this kset will have a type of kset_ktype and belong to
     * no kset itself.  That way we can properly free it when it is
     * finished being used.
     */
    kset->kobj.ktype = &kset_ktype;
    kset->kobj.kset = NULL;

    return kset;
}

由函数中的英文注释可以知道，kset.kobj.ktype被赋于一个kset_ktype类型，并且kset.kobj.kset为NULL，即该kset不属于任何其它kset。这样可以保证在不再继续使用该kset时可以正确的释放它。这里来看一下kset_ktype的定义，它定义在lib/kobject.c文件中，其内容如下 :

static struct kobj_type kset_ktype = {
    .sysfs_ops  = &kobj_sysfs_ops,
    .release = kset_release,
};

其中，kobj_sysfs_ops定义在lib/kobject.c文件中，其内容如下：

const struct sysfs_ops kobj_sysfs_ops = {
    .show   = kobj_attr_show,
    .store  = kobj_attr_store,
}; 

如果用户空间程序要对kset对应的sysfs文件系统下的属性文件进行读操作时，kobj_attr_show函数会被调用。
如果用户空间程序要对kset对应的sysfs文件系统下的属性文件进行写操作时，kobj_attr_store函数会被调用。
查看kobj_attr_show 函数，该函数定义在lib/kobject.c文件中，其内容如下 :

/* default kobject attribute operations */
static ssize_t kobj_attr_show(struct kobject *kobj, struct attribute *attr,
                  char *buf)
{
    struct kobj_attribute *kattr;
    ssize_t ret = -EIO;

    kattr = container_of(attr, struct kobj_attribute, attr);
    if (kattr->show)
        ret = kattr->show(kobj, kattr, buf);
    return ret;
}

在该函数中，通过container_of取得包含attr变量的struct kobj_attribute变量kattr，然后调用kattr->show()函数。
kobj_attr_store函数与kobj_attr_show函数类似，同样定义在lib/kobject.c文件中：

static ssize_t kobj_attr_store(struct kobject *kobj, struct attribute *attr,
                   const char *buf, size_t count)
{
    struct kobj_attribute *kattr;
    ssize_t ret = -EIO;

    kattr = container_of(attr, struct kobj_attribute, attr);
    if (kattr->store)
        ret = kattr->store(kobj, kattr, buf, count);
    return ret;
}

同样，该函数中，通过container_of取得包含attr变量的struct kobj_attribute变量kattr，然后调用kattr->store()函数。
由此可以看出，如果用户空间程序要对kset对应的sysfs文件系统下的属性文件进行读写操作时，就会转而调用包含相应attribute的kobj_attribute结构体的show/store函数。

---

回到kset_create_and_add函数，该函数中还调用kset_register(kset)函数注册kset，该函数定义在lib/kobject.c文件中，其内容如下

/**
 * kset_register - initialize and add a kset.
 * @k: kset.
 */
int kset_register(struct kset *k)
{
    int err;

    if (!k)
        return -EINVAL;

    kset_init(k); //对kset进行初始化
    err = kobject_add_internal(&k->kobj);//将kset.kobj加入到kobject层次结构和sysfs文件系统中
    if (err)
        return err;
    kobject_uevent(&k->kobj, KOBJ_ADD);
    return 0;
}

kset的初始化是通过调用kset_init函数完成的，该函数定义在lib/kobject.c文件中，其内容如下：

/**
 * kset_init - initialize a kset for use
 * @k: kset
 */
void kset_init(struct kset *k)
{
    kobject_init_internal(&k->kobj);
    INIT_LIST_HEAD(&k->list);
    spin_lock_init(&k->list_lock);
}

kset_init只是简单初始化kset.kobj，kset.list，和kset.list_lock。

kset_register调用kobject_uevent(&k->kobj, KOBJ_ADD)，通知用户空间添加了一个kobject，即kset.kobj。kobject_uevent函数定义在lib/kobject_uevent.c文件中，其内容如下：

/**
 * kobject_uevent - notify userspace by sending an uevent
 *
 * @action: action that is happening
 * @kobj: struct kobject that the action is happening to
 *
 * Returns 0 if kobject_uevent() is completed with success or the
 * corresponding error when it fails.
 */
int kobject_uevent(struct kobject *kobj, enum kobject_action action)
{
    return kobject_uevent_env(kobj, action, NULL);
}

kobject_uevent函数的作用是通过发送一个uevent通知用户空间内核中发生了某些事情。至于发生了什么事情，由第二个参数action指定，action是enum kobject_action类型变量，定义在include/linux/kobject.h文件中，其内容如下：

/*
 * The actions here must match the index to the string array
 * in lib/kobject_uevent.c
 *
 * Do not add new actions here without checking with the driver-core
 * maintainers. Action strings are not meant to express subsystem
 * or device specific properties. In most cases you want to send a
 * kobject_uevent_env(kobj, KOBJ_CHANGE, env) with additional event
 * specific variables added to the event environment.
 */
enum kobject_action {
    KOBJ_ADD,
    KOBJ_REMOVE,
    KOBJ_CHANGE,
    KOBJ_MOVE,
    KOBJ_ONLINE,
    KOBJ_OFFLINE,
    KOBJ_MAX
};

可见，一共有这7种事件可以通知用户空间。

在kobject_uevent函数中，调用kobject_uevent_env函数来发送uevent，该函数定义在lib/kobject_uevent.c文件中，其内容如下：

/**
 * kobject_uevent_env - send an uevent with environmental data
 *
 * @action: action that is happening
 * @kobj: struct kobject that the action is happening to
 * @envp_ext: pointer to environmental data
 *
 * Returns 0 if kobject_uevent_env() is completed with success or the
 * corresponding error when it fails.
 */
int kobject_uevent_env(struct kobject *kobj, enum kobject_action action,
               char *envp_ext[])
{
    struct kobj_uevent_env *env;
    const char *action_string = kobject_actions[action];
    const char *devpath = NULL;
    const char *subsystem;
    struct kobject *top_kobj;
    struct kset *kset;
    const struct kset_uevent_ops *uevent_ops;
    int i = 0;
    int retval = 0;
#ifdef CONFIG_NET
    struct uevent_sock *ue_sk;
#endif

    pr_debug("kobject: '%s' (%p): %s\n",
         kobject_name(kobj), kobj, __func__);

    /* search the kset we belong to */
    top_kobj = kobj;
    while (!top_kobj->kset && top_kobj->parent)
        top_kobj = top_kobj->parent;

    if (!top_kobj->kset) {
        pr_debug("kobject: '%s' (%p): %s: attempted to send uevent "
             "without kset!\n", kobject_name(kobj), kobj,
             __func__);
        return -EINVAL;
    }

    kset = top_kobj->kset;
    uevent_ops = kset->uevent_ops;

    /* skip the event, if uevent_suppress is set*/
    if (kobj->uevent_suppress) { //如果kobj->uevent_suppress被设置为1，则不发送uevent,退出
        pr_debug("kobject: '%s' (%p): %s: uevent_suppress "
                 "caused the event to drop!\n",
                 kobject_name(kobj), kobj, __func__);
        return 0;
    }
    /* skip the event, if the filter returns zero. */
    if (uevent_ops && uevent_ops->filter)
    //下面判断如果为0，则kobj希望发送的uevent被顶层kset过滤掉了，不再发送。
        if (!uevent_ops->filter(kset, kobj)) {
            pr_debug("kobject: '%s' (%p): %s: filter function "
                 "caused the event to drop!\n",
                 kobject_name(kobj), kobj, __func__);
            return 0;
        }

    /* originating subsystem */
    if (uevent_ops && uevent_ops->name)
        subsystem = uevent_ops->name(kset, kobj);
    else
        subsystem = kobject_name(&kset->kobj);
    if (!subsystem) {
        pr_debug("kobject: '%s' (%p): %s: unset subsystem caused the "
             "event to drop!\n", kobject_name(kobj), kobj,
             __func__);
        return 0;
    }

    /* environment buffer */
    //分配struct kobj_uevent_env变量空间给env
    env = kzalloc(sizeof(struct kobj_uevent_env), GFP_KERNEL);
    if (!env)
        return -ENOMEM;

    /* complete object path */ 
    //调用kobject_get_path取得kobject的绝对路径
    devpath = kobject_get_path(kobj, GFP_KERNEL);
    if (!devpath) {
        retval = -ENOENT;
        goto exit;
    }

    /* default keys */ 
    //调用add_uevent_var函数将ACTION、DEVPATH、SUBSYSTEM三个默认环境变量添加到env中
    retval = add_uevent_var(env, "ACTION=%s", action_string);
    if (retval)
        goto exit;
    retval = add_uevent_var(env, "DEVPATH=%s", devpath);
    if (retval)
        goto exit;
    retval = add_uevent_var(env, "SUBSYSTEM=%s", subsystem);
    if (retval)
        goto exit;

    /* keys passed in from the caller */ 
    //如果调用kobject_uevent_env函数时，通过第三个参数envp_ext传递进来了其它相关环境变量，也通过add_uevent_var函数添加到env
    if (envp_ext) {
        for (i = 0; envp_ext[i]; i++) {
            retval = add_uevent_var(env, "%s", envp_ext[i]);
            if (retval)
                goto exit;
        }
    }

    /* let the kset specific function add its stuff */ 
//如果uevent_ops->uevent不为空，则调用uevent_ops->uevent，kset可以通过该函数完成自己特定的功能
    if (uevent_ops && uevent_ops->uevent) {
        retval = uevent_ops->uevent(kset, kobj, env);
        if (retval) {
            pr_debug("kobject: '%s' (%p): %s: uevent() returned "
                 "%d\n", kobject_name(kobj), kobj,
                 __func__, retval);
            goto exit;
        }
    }

    /*
     * Mark "add" and "remove" events in the object to ensure proper
     * events to userspace during automatic cleanup. If the object did
     * send an "add" event, "remove" will automatically generated by
     * the core, if not already done by the caller. 
     * 如果action是KOBJ_ADD，则设置kobj->state_add_uevent_sent为1。
     * 如果action是KOBJ_REMOVE，则设置kobj->state_remove_uevent_sent为1
     */
    if (action == KOBJ_ADD)
        kobj->state_add_uevent_sent = 1;
    else if (action == KOBJ_REMOVE)
        kobj->state_remove_uevent_sent = 1;

    mutex_lock(&uevent_sock_mutex);
    /* we will send an event, so request a new sequence number */ 
    //将SEQNUM环境变量添加到env中
    retval = add_uevent_var(env, "SEQNUM=%llu", (unsigned long long)++uevent_seqnum);
    if (retval) {
        mutex_unlock(&uevent_sock_mutex);
        goto exit;
    }

#if defined(CONFIG_NET) 
    //通过udev的方式向用户空间广播当前kset对象中的uevent事件
    /* send netlink message */
    list_for_each_entry(ue_sk, &uevent_sock_list, list) {
        struct sock *uevent_sock = ue_sk->sk;
        struct sk_buff *skb;
        size_t len;

        if (!netlink_has_listeners(uevent_sock, 1))
            continue;

        /* allocate message with the maximum possible size */
        len = strlen(action_string) + strlen(devpath) + 2;
        skb = alloc_skb(len + env->buflen, GFP_KERNEL);
        if (skb) {
            char *scratch;

            /* add header */
            scratch = skb_put(skb, len);
            sprintf(scratch, "%s@%s", action_string, devpath);

            /* copy keys to our continuous event payload buffer */
            for (i = 0; i < env->envp_idx; i++) {
                len = strlen(env->envp[i]) + 1;
                scratch = skb_put(skb, len);
                strcpy(scratch, env->envp[i]);
            }

            NETLINK_CB(skb).dst_group = 1;
            retval = netlink_broadcast_filtered(uevent_sock, skb,
                                0, 1, GFP_KERNEL,
                                kobj_bcast_filter,
                                kobj);
            /* ENOBUFS should be handled in userspace */
            if (retval == -ENOBUFS || retval == -ESRCH)
                retval = 0;
        } else
            retval = -ENOMEM;
    }
#endif
    mutex_unlock(&uevent_sock_mutex);

#ifdef CONFIG_UEVENT_HELPER 
//在内核空间启动一个用户空间进程/sbin/hotplug，通过给该进程传递内核设定的环境变量的方式来通知用户空间kset对象中的uevent事件
    /* call uevent_helper, usually only enabled during early boot */
    if (uevent_helper[0] && !kobj_usermode_filter(kobj)) {
        struct subprocess_info *info;

        retval = add_uevent_var(env, "HOME=/");
        if (retval)
            goto exit;
        retval = add_uevent_var(env,
                    "PATH=/sbin:/bin:/usr/sbin:/usr/bin");
        if (retval)
            goto exit;
        retval = init_uevent_argv(env, subsystem);
        if (retval)
            goto exit;

        retval = -ENOMEM;
        info = call_usermodehelper_setup(env->argv[0], env->argv,
                         env->envp, GFP_KERNEL,
                         NULL, cleanup_uevent_env, env);
        if (info) {
            retval = call_usermodehelper_exec(info, UMH_NO_WAIT);
            env = NULL; /* freed by cleanup_uevent_env */
        }
    }
#endif

exit:
    kfree(devpath);
    kfree(env);
    return retval;
}

函数中使用了 struct kobj_uevent_env变量空间给env，该结构体用来保存环境变量，它定义在include/linux/kobject.h文件中，其内容如下：

struct kobj_uevent_env {
    char *argv[3];
    char *envp[UEVENT_NUM_ENVP];
    int envp_idx;
    char buf[UEVENT_BUFFER_SIZE];
    int buflen;
}; 

调用kobject_get_path取得kobject的绝对路径。该函数定义在include/linux/kobject.h文件中，其内容如下：

/**
 * kobject_get_path - generate and return the path associated with a given kobj and kset pair.
 *
 * @kobj:   kobject in question, with which to build the path
 * @gfp_mask:   the allocation type used to allocate the path
 *
 * The result must be freed by the caller with kfree().
 */
char *kobject_get_path(struct kobject *kobj, gfp_t gfp_mask)
{
    char *path;
    int len;

    len = get_kobj_path_length(kobj);
    if (len == 0)
        return NULL;
    path = kzalloc(len, gfp_mask);
    if (!path)
        return NULL;
    fill_kobj_path(kobj, path, len);

    return path;
}

还调用add_uevent_var函数将ACTION、DEVPATH、SUBSYSTEM三个默认环境变量添加到env中。add_uevent_var函数定义在lib/kobject_uevent.c文件中，其作用是“add key value string to the environment buffer”：

/**
 * add_uevent_var - add key value string to the environment buffer
 * @env: environment buffer structure
 * @format: printf format for the key=value pair
 *
 * Returns 0 if environment variable was added successfully or -ENOMEM
 * if no space was available.
 */
int add_uevent_var(struct kobj_uevent_env *env, const char *format, ...)
{
    va_list args;
    int len;

    if (env->envp_idx >= ARRAY_SIZE(env->envp)) {
        WARN(1, KERN_ERR "add_uevent_var: too many keys\n");
        return -ENOMEM;
    }

    va_start(args, format);
    len = vsnprintf(&env->buf[env->buflen],
            sizeof(env->buf) - env->buflen,
            format, args);
    va_end(args);

    if (len >= (sizeof(env->buf) - env->buflen)) {
        WARN(1, KERN_ERR "add_uevent_var: buffer size too small\n");
        return -ENOMEM;
    }

    env->envp[env->envp_idx++] = &env->buf[env->buflen];
    env->buflen += len + 1;
    return 0;
}

kobject_uevent_env函数剩下的部分，用来和用户空间进程进行交互（或者在内核空间启动执行一个用户空间程序）。
在Linux中，有两种方式完成这种交互，一个是代码中由CONFIG_NET宏包含的部分，这部分代码通过udev的方式向用户空间广播当前kset对象中的uevent事件。另外一种方式是在内核空间启动一个用户空间进程/sbin/hotplug，通过给该进程传递内核设定的环境变量的方式来通知用户空间kset对象中的uevent事件。
热插拔(hotplug)是指当有设备插入或拨出系统时，内核可以检测到这种状态变化，并通知用户空间加载或移除该设备对应的驱动程序模块。在Linux系统上内核有两种机制可以通知用户空间执行加载或移除操作，一种是udev，另一种是/sbin/hotplug，在Linux发展的早期，只有/sbin/hotplug，它的幕后推手是内核中的call_usermodehelper函数，它能从内核空间启动一个用户空间程序。随着内核的发展，出现了udev机制并逐渐取代了/sbin/hotplug。udev的实现基于内核中的网络机制，它通过创建标准的socket接口来监听来自内核的网络广播包，并对接收到的包进行分析处理。

至此，kobject_uevent_env函数我们就分析完了，同时，kobject_uevent、kset_register、kset_create_and_add函数也分析完成，整个分析过程了解了kset的创建和注册过程。