sysfs API总结

    sysfs是表现设备驱动模型的文件系统，它的目录层次实际反映的是对象的层次。为了配合这种目录，linux专门提供了两个结构作为sysfs的骨架，它们就是struct kobject和struct kset。我们知道，sysfs是完全虚拟的，它的每个目录其实都对应着一个kobject，要想知道这个目录下有哪些子目录，就要用到kset。从面向对象的角度来讲，kset继承了kobject的功能，既可以表示sysfs中的一个目录，还可以包含下层目录。对于kobject和kset，会在其它文章中专门分析到，这里简单描述只是为了更好地介绍sysfs提供的API。

    sysfs模块提供给外界的接口完全展现在include/linux/sysfs.h中。

[cpp] 
   ​​ view plain​​
   ​​copy​​
   ​​print​​
   ​​?​​
1. struct
2. const char
3. struct
4.     mode_t          mode;  
5. };  
6.   
7. struct
8. const char
9. struct
10. struct attribute *, int);  
11. struct
12. };      

之前说过普通文件是kobject目录的属性展现。struct attribute就是属性的通用结构，其它部分在使用时还可以把struct attribute内嵌到更大的属性结构中。struct attribute_group是提供一组属性的集合，这样集中的管理更为方便。

[cpp] 
   ​​ view plain​​
   ​​copy​​
   ​​print​​
   ​​?​​
 
1. #define __ATTR(_name,_mode,_show,_store) { \
2.     .attr = {.name = __stringify(_name), .mode = _mode },   \  
3.     .show   = _show,                    \  
4.     .store  = _store,                   \  
5. }  
6.   
7. #define __ATTR_RO(_name) { \
8.     .attr   = { .name = __stringify(_name), .mode = 0444 }, \  
9.     .show   = _name##_show,                 \  
10. }  
11.   
12. #define __ATTR_NULL { .attr = { .name = NULL } }
13.   
14. #define attr_name(_attr) (_attr).attr.name      

以上的宏是为了静态初始化属性时更为方便，我们简单将其忽略。

[cpp] 
   ​​ view plain​​
   ​​copy​​
   ​​print​​
   ​​?​​
1. struct
2. struct
3. size_t
4. void            *private;  
5. struct kobject *, struct
6. char *, loff_t, size_t);  
7. struct kobject *, struct
8. char *, loff_t, size_t);  
9. int (*mmap)(struct kobject *, struct
10. struct
11. };      

struct attribute是通用的属性结构，而struct bin_attribute就是为二进制属性专门设计的，它在sysfs中表现为二进制文件，大多数是设备配置参数的映射。struct bin_attribute恰恰就是把struct attribute内嵌到更大结构的样例。

[cpp] 
   ​​ view plain​​
   ​​copy​​
   ​​print​​
   ​​?​​
1. struct
2. struct kobject *, struct attribute *,char
3. struct kobject *,struct attribute *,const char *, size_t);  
4. };      

struct sysfs_ops中包含show和store两个函数指针，它们分别在sysfs文件读和文件写时调用。

[cpp] 
   ​​ view plain​​
   ​​copy​​
   ​​print​​
   ​​?​​
1. int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void
2. void *data, struct      

sysfs_schedule_callback()会创建一个工作队列，稍后调用func(data)。本来sysfs中的属性读写函数是无法删除属性文件或者kobject目录的，因为调用函数时是加锁的，要删除也需要加锁。但这里可以通过工作队列回调的方式实现。

[cpp] 
   ​​ view plain​​
   ​​copy​​
   ​​print​​
   ​​?​​
1. int __must_check sysfs_create_dir(struct
2. void sysfs_remove_dir(struct
3. int __must_check sysfs_rename_dir(struct kobject *kobj, const char
4. int __must_check sysfs_move_dir(struct
5. struct      

sysfs_create_dir()创建一个kobject对应的目录，目录名就是kobj->name。

sysfs_remove_dir()删除kobj对应的目录。删除一个目录也会相应地删除目录下的文件及子目录。

sysfs_rename_dir()修改kobj对应目录的名称。

sysfs_move_dir()将kobj对应的目录移到new_parent_kobj对应的目录下。

[cpp] 
   ​​ view plain​​
   ​​copy​​
   ​​print​​
   ​​?​​
1. int __must_check sysfs_create_file(struct
2. const struct
3. int __must_check sysfs_chmod_file(struct kobject *kobj, struct
4.                   mode_t mode);  
5. void sysfs_remove_file(struct kobject *kobj, const struct      

sysfs_create_file()在kobj对应的目录下创建attr对应的属性文件。

sysfs_chmod_file()修改attr对应的属性文件的读写权限。

sysfs_remove_file()在kobj对应的目录下删除attr对应的属性文件。

[cpp] 
   ​​ view plain​​
   ​​copy​​
   ​​print​​
   ​​?​​ 
1. int __must_check sysfs_create_bin_file(struct
2. struct
3. void sysfs_remove_bin_file(struct kobject *kobj, struct      

sysfs_create_bin_file()在kobj目录下创建attr对应的二进制属性文件。

sysfs_remove_bin_file()在kobj目录下删除attr对应的二进制属性文件。

[cpp] 
   ​​ view plain​​
   ​​copy​​
   ​​print​​
   ​​?​​
1. int __must_check sysfs_create_link(struct kobject *kobj, struct
2. const char
3. int __must_check sysfs_create_link_nowarn(struct
4. struct
5. const char
6. void sysfs_remove_link(struct kobject *kobj, const char      

sysfs_create_link()在kobj目录下创建指向target目录的软链接，name为软链接文件名称。

sysfs_create_link_nowarn()与sysfs_create_link()功能相同，只是在软链接文件已存在时不会出现警告。

sysfs_remove_link()删除kobj目录下名为name的软链接文件。

[cpp] 
   ​​ view plain​​
   ​​copy​​
   ​​print​​
   ​​?​​
1. int __must_check sysfs_create_group(struct
2. const struct
3. int sysfs_update_group(struct
4. const struct
5. void sysfs_remove_group(struct
6. const struct
7. int sysfs_add_file_to_group(struct
8. const struct attribute *attr, const char
9. void sysfs_remove_file_from_group(struct
10. const struct attribute *attr, const char      

sysfs_create_group()在kobj目录下创建一个属性集合，并显示集合中的属性文件。如果文件已存在，会报错。

sysfs_update_group()在kobj目录下创建一个属性集合，并显示集合中的属性文件。文件已存在也不会报错。sysfs_update_group()也用于group改动影响到文件显示时调用。

sysfs_remove_group()在kobj目录下删除一个属性集合，并删除集合中的属性文件。

sysfs_add_file_to_group()将一个属性attr加入kobj目录下已存在的的属性集合group。

sysfs_remove_file_from_group()将属性attr从kobj目录下的属性集合group中删除。

[cpp] 
   ​​ view plain​​
   ​​copy​​
   ​​print​​
   ​​?​​
1. void sysfs_notify(struct kobject *kobj, const char *dir, const char
2. void sysfs_notify_dirent(struct      

sysfs_notify()和sysfs_notify_dirent()都是用来唤醒在属性文件上调用select()或poll()而阻塞的用户进程。

[cpp] 
   ​​ view plain​​
   ​​copy​​
   ​​print​​
   ​​?​​
 
1. struct sysfs_dirent *sysfs_get_dirent(struct
2. const unsigned char
3. struct sysfs_dirent *sysfs_get(struct
4. void sysfs_put(struct      

sysfs_get()增加目录或文件的引用计数。

sysfs_put()减少目录或文件的引用计数，并在降为零时删除相应的文件或目录，这种删除又会减少上层目录的引用计数。

sysfs_get_dirent()是增加目录parent_sd中名为name的目录或文件的引用计数。

虽然同样是引用计数，同样在降为零时有删除动作，但却并非使用kref。这种操作更多地继承了文件系统管理时的传统。

[cpp] 
   ​​ view plain​​
   ​​copy​​
   ​​print​​
   ​​?​​
1. void sysfs_printk_last_file(void);  
2. int __must_check sysfs_init(void);      

sysfs_printk_last_file()是在sysfs崩溃时打印最后一个访问到的文件路径。

sysfs_init()是在sysfs模块初始化时调用的。

这两个函数都与我们没有什么关系。