include/linux/sysfs.h

   1 /*
   2  * sysfs.h - definitions for the device driver filesystem
   3  *
   4  * Copyright (c) 2001,2002 Patrick Mochel
   5  * Copyright (c) 2004 Silicon Graphics, Inc.
   6  * Copyright (c) 2007 SUSE Linux Products GmbH
   7  * Copyright (c) 2007 Tejun Heo <teheo@suse.de>
   8  *
   9  * Please see Documentation/filesystems/sysfs.txt for more information.
  10  */
  11
  12 #ifndef _SYSFS_H_
  13 #define _SYSFS_H_
  14
  15 #include <linux/compiler.h>
  16 #include <linux/errno.h>
  17 #include <linux/list.h>
  18 #include <linux/lockdep.h>
  19 #include <linux/kobject_ns.h>
  20 #include <linux/atomic.h>
  21
  22 struct kobject;
  23 struct module;
  24 enum kobj_ns_type;
  25
  26 struct attribute {
  27         const char              *name;
  28         umode_t                 mode;
  29 #ifdef CONFIG_DEBUG_LOCK_ALLOC
  30         bool                    ignore_lockdep:1;
  31         struct lock_class_key   *key;
  32         struct lock_class_key   skey;
  33 #endif
  34 };
  35
  36 /**
  37  *      sysfs_attr_init - initialize a dynamically allocated sysfs attribute
  38  *      @attr: struct attribute to initialize
  39  *
  40  *      Initialize a dynamically allocated struct attribute so we can
  41  *      make lockdep happy.  This is a new requirement for attributes
  42  *      and initially this is only needed when lockdep is enabled.
  43  *      Lockdep gives a nice error when your attribute is added to
  44  *      sysfs if you don't have this.
  45  */
  46 #ifdef CONFIG_DEBUG_LOCK_ALLOC
  47 #define sysfs_attr_init(attr)                           \
  48 do {                                                    \
  49         static struct lock_class_key __key;             \
  50                                                         \
  51         (attr)->key = &__key;                           \
  52 } while(0)
  53 #else
  54 #define sysfs_attr_init(attr) do {} while(0)
  55 #endif
  56
  57 struct attribute_group {
  58         const char              *name;
  59         umode_t                 (*is_visible)(struct kobject *,
  60                                               struct attribute *, int);
  61         struct attribute        **attrs;
  62 };
  63
  64
  65
  66 /**
  67  * Use these macros to make defining attributes easier. See include/linux/device.h
  68  * for examples..
  69  */
  70
  71 #define __ATTR(_name,_mode,_show,_store) { \
  72         .attr = {.name = __stringify(_name), .mode = _mode },   \
  73         .show   = _show,                                        \
  74         .store  = _store,                                       \
  75 }
  76
  77 #define __ATTR_RO(_name) { \
  78         .attr   = { .name = __stringify(_name), .mode = 0444 }, \
  79         .show   = _name##_show,                                 \
  80 }
  81
  82 #define __ATTR_RW(_name) __ATTR(_name, 0644, _name##_show, _name##_store)
  83
  84 #define __ATTR_NULL { .attr = { .name = NULL } }
  85
  86 #ifdef CONFIG_DEBUG_LOCK_ALLOC
  87 #define __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) {    \
  88         .attr = {.name = __stringify(_name), .mode = _mode,     \
  89                         .ignore_lockdep = true },               \
  90         .show           = _show,                                \
  91         .store          = _store,                               \
  92 }
  93 #else
  94 #define __ATTR_IGNORE_LOCKDEP   __ATTR
  95 #endif
  96
  97 #define ATTRIBUTE_GROUPS(name)                                  \
  98 static const struct attribute_group name##_group = {            \
  99         .attrs = name##_attrs,                                  \
 100 };                                                              \
 101 static const struct attribute_group *name##_groups[] = {        \
 102         &name##_group,                                          \
 103         NULL,                                                   \
 104 }
 105
 106 #define attr_name(_attr) (_attr).attr.name
 107
 108 struct file;
 109 struct vm_area_struct;
 110
 111 struct bin_attribute {
 112         struct attribute        attr;
 113         size_t                  size;
 114         void                    *private;
 115         ssize_t (*read)(struct file *, struct kobject *, struct bin_attribute *,
 116                         char *, loff_t, size_t);
 117         ssize_t (*write)(struct file *,struct kobject *, struct bin_attribute *,
 118                          char *, loff_t, size_t);
 119         int (*mmap)(struct file *, struct kobject *, struct bin_attribute *attr,
 120                     struct vm_area_struct *vma);
 121 };
 122
 123 /**
 124  *      sysfs_bin_attr_init - initialize a dynamically allocated bin_attribute
 125  *      @attr: struct bin_attribute to initialize
 126  *
 127  *      Initialize a dynamically allocated struct bin_attribute so we
 128  *      can make lockdep happy.  This is a new requirement for
 129  *      attributes and initially this is only needed when lockdep is
 130  *      enabled.  Lockdep gives a nice error when your attribute is
 131  *      added to sysfs if you don't have this.
 132  */
 133 #define sysfs_bin_attr_init(bin_attr) sysfs_attr_init(&(bin_attr)->attr)
 134
 135 struct sysfs_ops {
 136         ssize_t (*show)(struct kobject *, struct attribute *,char *);
 137         ssize_t (*store)(struct kobject *,struct attribute *,const char *, size_t);
 138         const void *(*namespace)(struct kobject *, const struct attribute *);
 139 };
 140
 141 struct sysfs_dirent;
 142
 143 #ifdef CONFIG_SYSFS
 144
 145 int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *),
 146                             void *data, struct module *owner);
 147
 148 int __must_check sysfs_create_dir(struct kobject *kobj);
 149 void sysfs_remove_dir(struct kobject *kobj);
 150 int __must_check sysfs_rename_dir(struct kobject *kobj, const char *new_name);
 151 int __must_check sysfs_move_dir(struct kobject *kobj,
 152                                 struct kobject *new_parent_kobj);
 153
 154 int __must_check sysfs_create_file(struct kobject *kobj,
 155                                    const struct attribute *attr);
 156 int __must_check sysfs_create_files(struct kobject *kobj,
 157                                    const struct attribute **attr);
 158 int __must_check sysfs_chmod_file(struct kobject *kobj,
 159                                   const struct attribute *attr, umode_t mode);
 160 void sysfs_remove_file(struct kobject *kobj, const struct attribute *attr);
 161 void sysfs_remove_files(struct kobject *kobj, const struct attribute **attr);
 162
 163 int __must_check sysfs_create_bin_file(struct kobject *kobj,
 164                                        const struct bin_attribute *attr);
 165 void sysfs_remove_bin_file(struct kobject *kobj,
 166                            const struct bin_attribute *attr);
 167
 168 int __must_check sysfs_create_link(struct kobject *kobj, struct kobject *target,
 169                                    const char *name);
 170 int __must_check sysfs_create_link_nowarn(struct kobject *kobj,
 171                                           struct kobject *target,
 172                                           const char *name);
 173 void sysfs_remove_link(struct kobject *kobj, const char *name);
 174
 175 int sysfs_rename_link(struct kobject *kobj, struct kobject *target,
 176                         const char *old_name, const char *new_name);
 177
 178 void sysfs_delete_link(struct kobject *dir, struct kobject *targ,
 179                         const char *name);
 180
 181 int __must_check sysfs_create_group(struct kobject *kobj,
 182                                     const struct attribute_group *grp);
 183 int sysfs_update_group(struct kobject *kobj,
 184                        const struct attribute_group *grp);
 185 void sysfs_remove_group(struct kobject *kobj,
 186                         const struct attribute_group *grp);
 187 int sysfs_add_file_to_group(struct kobject *kobj,
 188                         const struct attribute *attr, const char *group);
 189 void sysfs_remove_file_from_group(struct kobject *kobj,
 190                         const struct attribute *attr, const char *group);
 191 int sysfs_merge_group(struct kobject *kobj,
 192                        const struct attribute_group *grp);
 193 void sysfs_unmerge_group(struct kobject *kobj,
 194                        const struct attribute_group *grp);
 195 int sysfs_add_link_to_group(struct kobject *kobj, const char *group_name,
 196                             struct kobject *target, const char *link_name);
 197 void sysfs_remove_link_from_group(struct kobject *kobj, const char *group_name,
 198                                   const char *link_name);
 199
 200 void sysfs_notify(struct kobject *kobj, const char *dir, const char *attr);
 201 void sysfs_notify_dirent(struct sysfs_dirent *sd);
 202 struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
 203                                       const void *ns,
 204                                       const unsigned char *name);
 205 struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd);
 206 void sysfs_put(struct sysfs_dirent *sd);
 207
 208 int __must_check sysfs_init(void);
 209
 210 #else /* CONFIG_SYSFS */
 211
 212 static inline int sysfs_schedule_callback(struct kobject *kobj,
 213                 void (*func)(void *), void *data, struct module *owner)
 214 {
 215         return -ENOSYS;
 216 }
 217
 218 static inline int sysfs_create_dir(struct kobject *kobj)
 219 {
 220         return 0;
 221 }
 222
 223 static inline void sysfs_remove_dir(struct kobject *kobj)
 224 {
 225 }
 226
 227 static inline int sysfs_rename_dir(struct kobject *kobj, const char *new_name)
 228 {
 229         return 0;
 230 }
 231
 232 static inline int sysfs_move_dir(struct kobject *kobj,
 233                                  struct kobject *new_parent_kobj)
 234 {
 235         return 0;
 236 }
 237
 238 static inline int sysfs_create_file(struct kobject *kobj,
 239                                     const struct attribute *attr)
 240 {
 241         return 0;
 242 }
 243
 244 static inline int sysfs_create_files(struct kobject *kobj,
 245                                     const struct attribute **attr)
 246 {
 247         return 0;
 248 }
 249
 250 static inline int sysfs_chmod_file(struct kobject *kobj,
 251                                    const struct attribute *attr, umode_t mode)
 252 {
 253         return 0;
 254 }
 255
 256 static inline void sysfs_remove_file(struct kobject *kobj,
 257                                      const struct attribute *attr)
 258 {
 259 }
 260
 261 static inline void sysfs_remove_files(struct kobject *kobj,
 262                                      const struct attribute **attr)
 263 {
 264 }
 265
 266 static inline int sysfs_create_bin_file(struct kobject *kobj,
 267                                         const struct bin_attribute *attr)
 268 {
 269         return 0;
 270 }
 271
 272 static inline void sysfs_remove_bin_file(struct kobject *kobj,
 273                                          const struct bin_attribute *attr)
 274 {
 275 }
 276
 277 static inline int sysfs_create_link(struct kobject *kobj,
 278                                     struct kobject *target, const char *name)
 279 {
 280         return 0;
 281 }
 282
 283 static inline int sysfs_create_link_nowarn(struct kobject *kobj,
 284                                            struct kobject *target,
 285                                            const char *name)
 286 {
 287         return 0;
 288 }
 289
 290 static inline void sysfs_remove_link(struct kobject *kobj, const char *name)
 291 {
 292 }
 293
 294 static inline int sysfs_rename_link(struct kobject *k, struct kobject *t,
 295                                     const char *old_name, const char *new_name)
 296 {
 297         return 0;
 298 }
 299
 300 static inline void sysfs_delete_link(struct kobject *k, struct kobject *t,
 301                                      const char *name)
 302 {
 303 }
 304
 305 static inline int sysfs_create_group(struct kobject *kobj,
 306                                      const struct attribute_group *grp)
 307 {
 308         return 0;
 309 }
 310
 311 static inline int sysfs_update_group(struct kobject *kobj,
 312                                 const struct attribute_group *grp)
 313 {
 314         return 0;
 315 }
 316
 317 static inline void sysfs_remove_group(struct kobject *kobj,
 318                                       const struct attribute_group *grp)
 319 {
 320 }
 321
 322 static inline int sysfs_add_file_to_group(struct kobject *kobj,
 323                 const struct attribute *attr, const char *group)
 324 {
 325         return 0;
 326 }
 327
 328 static inline void sysfs_remove_file_from_group(struct kobject *kobj,
 329                 const struct attribute *attr, const char *group)
 330 {
 331 }
 332
 333 static inline int sysfs_merge_group(struct kobject *kobj,
 334                        const struct attribute_group *grp)
 335 {
 336         return 0;
 337 }
 338
 339 static inline void sysfs_unmerge_group(struct kobject *kobj,
 340                        const struct attribute_group *grp)
 341 {
 342 }
 343
 344 static inline int sysfs_add_link_to_group(struct kobject *kobj,
 345                 const char *group_name, struct kobject *target,
 346                 const char *link_name)
 347 {
 348         return 0;
 349 }
 350
 351 static inline void sysfs_remove_link_from_group(struct kobject *kobj,
 352                 const char *group_name, const char *link_name)
 353 {
 354 }
 355
 356 static inline void sysfs_notify(struct kobject *kobj, const char *dir,
 357                                 const char *attr)
 358 {
 359 }
 360 static inline void sysfs_notify_dirent(struct sysfs_dirent *sd)
 361 {
 362 }
 363 static inline
 364 struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
 365                                       const void *ns,
 366                                       const unsigned char *name)
 367 {
 368         return NULL;
 369 }
 370 static inline struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd)
 371 {
 372         return NULL;
 373 }
 374 static inline void sysfs_put(struct sysfs_dirent *sd)
 375 {
 376 }
 377
 378 static inline int __must_check sysfs_init(void)
 379 {
 380         return 0;
 381 }
 382
 383 #endif /* CONFIG_SYSFS */
 384
 385 #endif /* _SYSFS_H_ */