sysfs API总结

墨蓝 2022-05-22 02:39 151阅读 0赞

sysfs是用于表现设备驱动模型的文件系统，它基于ramfs。要学习linux的设备驱动模型，就要先做好底层工作，总结sysfs提供给外界的API就是其中之一。sysfs文件系统中提供了四类文件的创建与管理，分别是目录、普通文件、软链接文件、二进制文件。目录层次往往代表着设备驱动模型的结构，软链接文件则代表着不同部分间的关系。比如某个设备的目录只出现在/sys/devices下，其它地方涉及到它时只好用软链接文件链接过去，保持了设备唯一的实例。而普通文件和二进制文件往往代表了设备的属性，读写这些文件需要调用相应的属性读写。

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][view plain] [copy][view plain] [print][view plain] [?][view plain]

1.  struct attribute \{  
2.      const char      \*name;  
3.      struct module       \*owner;  
4.      mode\_t          mode;  
5.  \};  
6.    
7.  struct attribute\_group \{  
8.      const char      \*name;  
9.      mode\_t          (\*is\_visible)(struct kobject \*,  
10.                           struct attribute \*, int);  
11.     struct attribute    \*\*attrs;  
12. \};

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

**\[cpp\]** [ view plain][view plain] [copy][view plain] [print][view plain] [?][view plain]

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][view plain] [copy][view plain] [print][view plain] [?][view plain]

1.  struct bin\_attribute \{  
2.      struct attribute    attr;  
3.      size\_t          size;  
4.      void            \*private;  
5.      ssize\_t (\*read)(struct kobject \*, struct bin\_attribute \*,  
6.              char \*, loff\_t, size\_t);  
7.      ssize\_t (\*write)(struct kobject \*, struct bin\_attribute \*,  
8.               char \*, loff\_t, size\_t);  
9.      int (\*mmap)(struct kobject \*, struct bin\_attribute \*attr,  
10.             struct vm\_area\_struct \*vma);  
11. \};

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

**\[cpp\]** [ view plain][view plain] [copy][view plain] [print][view plain] [?][view plain]

1.  struct sysfs\_ops \{  
2.      ssize\_t (\*show)(struct kobject \*, struct attribute \*,char \*);  
3.      ssize\_t (\*store)(struct kobject \*,struct attribute \*,const char \*, size\_t);  
4.  \};

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

**\[cpp\]** [ view plain][view plain] [copy][view plain] [print][view plain] [?][view plain]

1.  int sysfs\_schedule\_callback(struct kobject \*kobj, void (\*func)(void \*),  
2.                  void \*data, struct module \*owner);

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

**\[cpp\]** [ view plain][view plain] [copy][view plain] [print][view plain] [?][view plain]

1.  int \_\_must\_check sysfs\_create\_dir(struct kobject \*kobj);  
2.  void sysfs\_remove\_dir(struct kobject \*kobj);  
3.  int \_\_must\_check sysfs\_rename\_dir(struct kobject \*kobj, const char \*new\_name);  
4.  int \_\_must\_check sysfs\_move\_dir(struct kobject \*kobj,  
5.                  struct kobject \*new\_parent\_kobj);

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

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

sysfs\_rename\_dir()修改kobj对应目录的名称。

sysfs\_move\_dir()将kobj对应的目录移到new\_parent\_kobj对应的目录下。

**\[cpp\]** [ view plain][view plain] [copy][view plain] [print][view plain] [?][view plain]

1.  int \_\_must\_check sysfs\_create\_file(struct kobject \*kobj,  
2.                     const struct attribute \*attr);  
3.  int \_\_must\_check sysfs\_chmod\_file(struct kobject \*kobj, struct attribute \*attr,  
4.                    mode\_t mode);  
5.  void sysfs\_remove\_file(struct kobject \*kobj, const struct attribute \*attr);

sysfs\_create\_file()在kobj对应的目录下创建attr对应的属性文件。

sysfs\_chmod\_file()修改attr对应的属性文件的读写权限。

sysfs\_remove\_file()在kobj对应的目录下删除attr对应的属性文件。

**\[cpp\]** [ view plain][view plain] [copy][view plain] [print][view plain] [?][view plain]

1.  int \_\_must\_check sysfs\_create\_bin\_file(struct kobject \*kobj,  
2.                         struct bin\_attribute \*attr);  
3.  void sysfs\_remove\_bin\_file(struct kobject \*kobj, struct bin\_attribute \*attr);

sysfs\_create\_bin\_file()在kobj目录下创建attr对应的二进制属性文件。

sysfs\_remove\_bin\_file()在kobj目录下删除attr对应的二进制属性文件。

**\[cpp\]** [ view plain][view plain] [copy][view plain] [print][view plain] [?][view plain]

1.  int \_\_must\_check sysfs\_create\_link(struct kobject \*kobj, struct kobject \*target,  
2.                     const char \*name);  
3.  int \_\_must\_check sysfs\_create\_link\_nowarn(struct kobject \*kobj,  
4.                        struct kobject \*target,  
5.                        const char \*name);  
6.  void sysfs\_remove\_link(struct kobject \*kobj, const char \*name);

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

sysfs\_create\_link\_nowarn()与sysfs\_create\_link()功能相同，只是在软链接文件已存在时不会出现警告。

sysfs\_remove\_link()删除kobj目录下名为name的软链接文件。

**\[cpp\]** [ view plain][view plain] [copy][view plain] [print][view plain] [?][view plain]

1.  int \_\_must\_check sysfs\_create\_group(struct kobject \*kobj,  
2.          const struct attribute\_group \*grp);  
3.  int sysfs\_update\_group(struct kobject \*kobj,  
4.           const struct attribute\_group \*grp);  
5.  void sysfs\_remove\_group(struct kobject \*kobj,  
6.     const struct attribute\_group \*grp);  
7.  int sysfs\_add\_file\_to\_group(struct kobject \*kobj,  
8.     const struct attribute \*attr, const char \*group);  
9.  void sysfs\_remove\_file\_from\_group(struct kobject \*kobj,  
10.    const struct attribute \*attr, const char \*group);

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][view plain] [copy][view plain] [print][view plain] [?][view plain]

1.  void sysfs\_notify(struct kobject \*kobj, const char \*dir, const char \*attr);  
2.  void sysfs\_notify\_dirent(struct sysfs\_dirent \*sd);

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

**\[cpp\]** [ view plain][view plain] [copy][view plain] [print][view plain] [?][view plain]

1.  struct sysfs\_dirent \*sysfs\_get\_dirent(struct sysfs\_dirent \*parent\_sd,  
2.                        const unsigned char \*name);  
3.  struct sysfs\_dirent \*sysfs\_get(struct sysfs\_dirent \*sd);  
4.  void sysfs\_put(struct sysfs\_dirent \*sd);

sysfs\_get()增加目录或文件的引用计数。

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

sysfs\_get\_dirent()是增加目录parent\_sd中名为name的目录或文件的引用计数。

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

**\[cpp\]** [ view plain][view plain] [copy][view plain] [print][view plain] [?][view plain]

1.  void sysfs\_printk\_last\_file(void);  
2.  int \_\_must\_check sysfs\_init(void);

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

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

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

[view plain]: http://blog.csdn.net/qb_2008/article/details/6846412#