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