sysfs 的實作與應用詳解

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

struct kobject {
    const char *name;                           // 物件的文字名稱，可利用 sysfs 導出至 user space
    struct list_head entry;                     // 雙向鏈結串列，用於將若干 kobject 放置到一個鏈結串列中
    struct kobject *parent;                     // 用於 kobject 的階層結構
    struct kset *kset;                          // 用於將物件與其他物件放置到一個集合時
    struct kobj_type *ktype;                    // 提供包含 kobject 的資料結構的更多詳細資訊
    struct sysfs_dirent *sd;                    // 用於 kobject 與 sysfs 間的關聯
    struct kref kref;                           // 管理 reference count
    unsigned int state_initialized : 1;         // 是否已經初始化
    unsigned int state_in_sysfs : 1;            // 是否已在 sysfs 呈現
    unsigned int state_add_uevent_sent : 1;     // 紀錄 add uevent 是否發送
    unsigned int state_remove_uevent_sent : 1;  // 若有 add uevent 沒有 remove uevent 會補發 remove uevent
    unsigned int uevent_suppress : 1;           // 若為 1，在設備發生變化時不發送 uevent
};

1
2
3
4
5

struct kobj_type {
    void (*release)(struct kobject *kobj);  // 當 kobject 的 reference counting == 0 時呼叫
    const struct sysfs_ops *sysfs_ops;      // 描述 sysfs 的讀寫行為
    struct attribute **default_attrs;       // 指向一個 struct attribute 陣列，用於定義與此 kobject 的預設屬性 (sysfs 下的檔案)
};

1
2
3
4
5
6

struct kset {
    struct list_head list;                     // 所有屬於目前集合的 kobject 的鏈結串列
    spinlock_t list_lock;                      // 用於保護 list
    struct kobject kobj;                       // kset 即為使用 kobject 的第一個例子，用於管理 kset 本身
    const struct kset_uevent_ops *uevent_ops;  // function pointer，用於將集合的狀態資訊傳遞給 user space
};

1
2
3

struct kref {
    atomic_t refcount; // 當 refcount == 0 時，可以釋放該物件的記憶體
};

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22

struct sysfs_dirent {
    atomic_t s_count;   // 當引用到 sysfs 節點時 + 1，不需要時 - 1
    atomic_t s_active;  // 規避掉 user 打開 sysfs 節點，就可以防止核心刪除 kobject 對應的實體的問題
#ifdef CONFIG_DEBUG_LOCK_ALLOC
    struct lockdep_map dep_map;
#endif
    struct sysfs_dirent *s_parent;
    struct sysfs_dirent *s_sibling;  // 連結同一父節點的所有子節點
    const char *s_name;              // 檔案、目錄、符號連結的名稱

    union {
        struct sysfs_elem_dir s_dir;
        struct sysfs_elem_symlink s_symlink;
        struct sysfs_elem_attr s_attr;
        struct sysfs_elem_bin_attr s_bin_attr;
    };

    unsigned int s_flags;               // 低 8 位用作設定 sysfs 資料項目的型態(目錄、普通屬性、二進位屬性、符號連結)，剩餘位元用於標記位元
    unsigned short s_mode;              // 目錄項目的存取權限
    ino_t s_ino;                        // inode index
    struct sysfs_inode_attrs *s_iattr;  // sysfs_dirent 的基本屬性，如 timestamp
};

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19

struct sysfs_elem_dir {  // 目錄
    struct kobject *kobj;
    /* children list starts here and goes through sd->s_sibling */
    struct sysfs_dirent *children;  // 子節點鏈結的表頭，將所有子節點用 s_sibling 連結起來，依 s_ino 遞減排列
};

struct sysfs_elem_symlink {          // 符號連結
    struct sysfs_dirent *target_sd;  // 指向目標的 sysfs_dirent
};

struct sysfs_elem_attr {     // 普通屬性
    struct attribute *attr;  // 指向屬性
    struct sysfs_open_dirent *open;
};

struct sysfs_elem_bin_attr {         // 二進位屬性
    struct bin_attribute *bin_attr;  // 指向屬性
    struct hlist_head buffers;
};

1
2
3
4
5
6
7
8
9

struct attribute {
    const char *name;      // 屬性名稱，在 sysfs 用作檔名
    struct module *owner;  // 屬性的所有者所屬的 module 實體
    mode_t mode;           // 存取權限
#ifdef CONFIG_DEBUG_LOCK_ALLOC
    struct lock_class_key *key;
    struct lock_class_key skey;
#endif
};

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

struct bin_attribute {
    struct attribute attr;
    size_t size;    // 二進位資料長度
    void *private;  // 通常指向資料實際的位置
    ssize_t (*read)(struct kobject *, struct bin_attribute *,
                    char *, loff_t, size_t);
    ssize_t (*write)(struct kobject *, struct bin_attribute *,
                     char *, loff_t, size_t);
    int (*mmap)(struct kobject *, struct bin_attribute *attr,
                struct vm_area_struct *vma);
};

1
2
3
4

struct sysfs_ops {
    ssize_t (*show)(struct kobject *, struct attribute *, char *);
    ssize_t (*store)(struct kobject *, struct attribute *, const char *, size_t);
};