sysfs.h 6.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244
  1. /*
  2. * fs/sysfs/sysfs.h - sysfs internal header file
  3. *
  4. * Copyright (c) 2001-3 Patrick Mochel
  5. * Copyright (c) 2007 SUSE Linux Products GmbH
  6. * Copyright (c) 2007 Tejun Heo <teheo@suse.de>
  7. *
  8. * This file is released under the GPLv2.
  9. */
  10. #include <linux/lockdep.h>
  11. #include <linux/kobject_ns.h>
  12. #include <linux/fs.h>
  13. #include <linux/rbtree.h>
  14. struct sysfs_open_dirent;
  15. /* type-specific structures for sysfs_dirent->s_* union members */
  16. struct sysfs_elem_dir {
  17. struct kobject *kobj;
  18. unsigned long subdirs;
  19. /* children rbtree starts here and goes through sd->s_rb */
  20. struct rb_root children;
  21. };
  22. struct sysfs_elem_symlink {
  23. struct sysfs_dirent *target_sd;
  24. };
  25. struct sysfs_elem_attr {
  26. struct attribute *attr;
  27. struct sysfs_open_dirent *open;
  28. };
  29. struct sysfs_elem_bin_attr {
  30. struct bin_attribute *bin_attr;
  31. struct hlist_head buffers;
  32. };
  33. struct sysfs_inode_attrs {
  34. struct iattr ia_iattr;
  35. void *ia_secdata;
  36. u32 ia_secdata_len;
  37. };
  38. /*
  39. * sysfs_dirent - the building block of sysfs hierarchy. Each and
  40. * every sysfs node is represented by single sysfs_dirent.
  41. *
  42. * As long as s_count reference is held, the sysfs_dirent itself is
  43. * accessible. Dereferencing s_elem or any other outer entity
  44. * requires s_active reference.
  45. */
  46. struct sysfs_dirent {
  47. atomic_t s_count;
  48. atomic_t s_active;
  49. #ifdef CONFIG_DEBUG_LOCK_ALLOC
  50. struct lockdep_map dep_map;
  51. #endif
  52. struct sysfs_dirent *s_parent;
  53. const char *s_name;
  54. struct rb_node s_rb;
  55. union {
  56. struct completion *completion;
  57. struct sysfs_dirent *removed_list;
  58. } u;
  59. const void *s_ns; /* namespace tag */
  60. unsigned int s_hash; /* ns + name hash */
  61. union {
  62. struct sysfs_elem_dir s_dir;
  63. struct sysfs_elem_symlink s_symlink;
  64. struct sysfs_elem_attr s_attr;
  65. struct sysfs_elem_bin_attr s_bin_attr;
  66. };
  67. unsigned short s_flags;
  68. umode_t s_mode;
  69. unsigned int s_ino;
  70. struct sysfs_inode_attrs *s_iattr;
  71. };
  72. #define SD_DEACTIVATED_BIAS INT_MIN
  73. #define SYSFS_TYPE_MASK 0x00ff
  74. #define SYSFS_DIR 0x0001
  75. #define SYSFS_KOBJ_ATTR 0x0002
  76. #define SYSFS_KOBJ_BIN_ATTR 0x0004
  77. #define SYSFS_KOBJ_LINK 0x0008
  78. #define SYSFS_COPY_NAME (SYSFS_DIR | SYSFS_KOBJ_LINK)
  79. #define SYSFS_ACTIVE_REF (SYSFS_KOBJ_ATTR | SYSFS_KOBJ_BIN_ATTR)
  80. /* identify any namespace tag on sysfs_dirents */
  81. #define SYSFS_NS_TYPE_MASK 0xf00
  82. #define SYSFS_NS_TYPE_SHIFT 8
  83. #define SYSFS_FLAG_MASK ~(SYSFS_NS_TYPE_MASK|SYSFS_TYPE_MASK)
  84. #define SYSFS_FLAG_REMOVED 0x02000
  85. static inline unsigned int sysfs_type(struct sysfs_dirent *sd)
  86. {
  87. return sd->s_flags & SYSFS_TYPE_MASK;
  88. }
  89. /*
  90. * Return any namespace tags on this dirent.
  91. * enum kobj_ns_type is defined in linux/kobject.h
  92. */
  93. static inline enum kobj_ns_type sysfs_ns_type(struct sysfs_dirent *sd)
  94. {
  95. return (sd->s_flags & SYSFS_NS_TYPE_MASK) >> SYSFS_NS_TYPE_SHIFT;
  96. }
  97. #ifdef CONFIG_DEBUG_LOCK_ALLOC
  98. #define sysfs_dirent_init_lockdep(sd) \
  99. do { \
  100. struct attribute *attr = sd->s_attr.attr; \
  101. struct lock_class_key *key = attr->key; \
  102. if (!key) \
  103. key = &attr->skey; \
  104. \
  105. lockdep_init_map(&sd->dep_map, "s_active", key, 0); \
  106. } while(0)
  107. #else
  108. #define sysfs_dirent_init_lockdep(sd) do {} while(0)
  109. #endif
  110. /*
  111. * Context structure to be used while adding/removing nodes.
  112. */
  113. struct sysfs_addrm_cxt {
  114. struct sysfs_dirent *parent_sd;
  115. struct sysfs_dirent *removed;
  116. };
  117. /*
  118. * mount.c
  119. */
  120. /*
  121. * Each sb is associated with a set of namespace tags (i.e.
  122. * the network namespace of the task which mounted this sysfs
  123. * instance).
  124. */
  125. struct sysfs_super_info {
  126. void *ns[KOBJ_NS_TYPES];
  127. };
  128. #define sysfs_info(SB) ((struct sysfs_super_info *)(SB->s_fs_info))
  129. extern struct sysfs_dirent sysfs_root;
  130. extern struct kmem_cache *sysfs_dir_cachep;
  131. /*
  132. * dir.c
  133. */
  134. extern struct mutex sysfs_mutex;
  135. extern spinlock_t sysfs_assoc_lock;
  136. extern const struct file_operations sysfs_dir_operations;
  137. extern const struct inode_operations sysfs_dir_inode_operations;
  138. struct dentry *sysfs_get_dentry(struct sysfs_dirent *sd);
  139. struct sysfs_dirent *sysfs_get_active(struct sysfs_dirent *sd);
  140. void sysfs_put_active(struct sysfs_dirent *sd);
  141. void sysfs_addrm_start(struct sysfs_addrm_cxt *acxt,
  142. struct sysfs_dirent *parent_sd);
  143. int __sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd);
  144. int sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd);
  145. void sysfs_remove_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd);
  146. void sysfs_addrm_finish(struct sysfs_addrm_cxt *acxt);
  147. struct sysfs_dirent *sysfs_find_dirent(struct sysfs_dirent *parent_sd,
  148. const void *ns,
  149. const unsigned char *name);
  150. struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
  151. const void *ns,
  152. const unsigned char *name);
  153. struct sysfs_dirent *sysfs_new_dirent(const char *name, umode_t mode, int type);
  154. void release_sysfs_dirent(struct sysfs_dirent *sd);
  155. int sysfs_create_subdir(struct kobject *kobj, const char *name,
  156. struct sysfs_dirent **p_sd);
  157. void sysfs_remove_subdir(struct sysfs_dirent *sd);
  158. int sysfs_rename(struct sysfs_dirent *sd,
  159. struct sysfs_dirent *new_parent_sd, const void *ns, const char *new_name);
  160. static inline struct sysfs_dirent *__sysfs_get(struct sysfs_dirent *sd)
  161. {
  162. if (sd) {
  163. WARN_ON(!atomic_read(&sd->s_count));
  164. atomic_inc(&sd->s_count);
  165. }
  166. return sd;
  167. }
  168. #define sysfs_get(sd) __sysfs_get(sd)
  169. static inline void __sysfs_put(struct sysfs_dirent *sd)
  170. {
  171. if (sd && atomic_dec_and_test(&sd->s_count))
  172. release_sysfs_dirent(sd);
  173. }
  174. #define sysfs_put(sd) __sysfs_put(sd)
  175. /*
  176. * inode.c
  177. */
  178. struct inode *sysfs_get_inode(struct super_block *sb, struct sysfs_dirent *sd);
  179. void sysfs_evict_inode(struct inode *inode);
  180. int sysfs_sd_setattr(struct sysfs_dirent *sd, struct iattr *iattr);
  181. int sysfs_permission(struct inode *inode, int mask);
  182. int sysfs_setattr(struct dentry *dentry, struct iattr *iattr);
  183. int sysfs_getattr(struct vfsmount *mnt, struct dentry *dentry, struct kstat *stat);
  184. int sysfs_setxattr(struct dentry *dentry, const char *name, const void *value,
  185. size_t size, int flags);
  186. int sysfs_hash_and_remove(struct sysfs_dirent *dir_sd, const void *ns, const char *name);
  187. int sysfs_inode_init(void);
  188. /*
  189. * file.c
  190. */
  191. extern const struct file_operations sysfs_file_operations;
  192. int sysfs_add_file(struct sysfs_dirent *dir_sd,
  193. const struct attribute *attr, int type);
  194. int sysfs_add_file_mode(struct sysfs_dirent *dir_sd,
  195. const struct attribute *attr, int type, umode_t amode);
  196. /*
  197. * bin.c
  198. */
  199. extern const struct file_operations bin_fops;
  200. void unmap_bin_file(struct sysfs_dirent *attr_sd);
  201. /*
  202. * symlink.c
  203. */
  204. extern const struct inode_operations sysfs_symlink_inode_operations;
  205. int sysfs_create_link_sd(struct sysfs_dirent *sd, struct kobject *target,
  206. const char *name);