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/kernfs.h>
  16 #include <linux/compiler.h>
  17 #include <linux/errno.h>
  18 #include <linux/list.h>
  19 #include <linux/lockdep.h>
  20 #include <linux/kobject_ns.h>
  21 #include <linux/stat.h>
  22 #include <linux/atomic.h>
  23
  24 struct kobject;
  25 struct module;
  26 struct bin_attribute;
  27 enum kobj_ns_type;
  28
  29 struct attribute {
  30         const char              *name;
  31         umode_t                 mode;
  32 #ifdef CONFIG_DEBUG_LOCK_ALLOC
  33         bool                    ignore_lockdep:1;
  34         struct lock_class_key   *key;
  35         struct lock_class_key   skey;
  36 #endif
  37 };
  38
  39 /**
  40  *      sysfs_attr_init - initialize a dynamically allocated sysfs attribute
  41  *      @attr: struct attribute to initialize
  42  *
  43  *      Initialize a dynamically allocated struct attribute so we can
  44  *      make lockdep happy.  This is a new requirement for attributes
  45  *      and initially this is only needed when lockdep is enabled.
  46  *      Lockdep gives a nice error when your attribute is added to
  47  *      sysfs if you don't have this.
  48  */
  49 #ifdef CONFIG_DEBUG_LOCK_ALLOC
  50 #define sysfs_attr_init(attr)                           \
  51 do {                                                    \
  52         static struct lock_class_key __key;             \
  53                                                         \
  54         (attr)->key = &__key;                           \
  55 } while (0)
  56 #else
  57 #define sysfs_attr_init(attr) do {} while (0)
  58 #endif
  59
  60 struct attribute_group {
  61         const char              *name;
  62         umode_t                 (*is_visible)(struct kobject *,
  63                                               struct attribute *, int);
  64         struct attribute        **attrs;
  65         struct bin_attribute    **bin_attrs;
  66 };
  67
  68 /**
  69  * Use these macros to make defining attributes easier. See include/linux/device.h
  70  * for examples..
  71  */
  72
  73 #define __ATTR(_name, _mode, _show, _store) {                           \
  74         .attr = {.name = __stringify(_name),                            \
  75                  .mode = VERIFY_OCTAL_PERMISSIONS(_mode) },             \
  76         .show   = _show,                                                \
  77         .store  = _store,                                               \
  78 }
  79
  80 #define __ATTR_RO(_name) {                                              \
  81         .attr   = { .name = __stringify(_name), .mode = S_IRUGO },      \
  82         .show   = _name##_show,                                         \
  83 }
  84
  85 #define __ATTR_WO(_name) {                                              \
  86         .attr   = { .name = __stringify(_name), .mode = S_IWUSR },      \
  87         .store  = _name##_store,                                        \
  88 }
  89
  90 #define __ATTR_RW(_name) __ATTR(_name, (S_IWUSR | S_IRUGO),             \
  91                          _name##_show, _name##_store)
  92
  93 #define __ATTR_NULL { .attr = { .name = NULL } }
  94
  95 #ifdef CONFIG_DEBUG_LOCK_ALLOC
  96 #define __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) {    \
  97         .attr = {.name = __stringify(_name), .mode = _mode,     \
  98                         .ignore_lockdep = true },               \
  99         .show           = _show,                                \
 100         .store          = _store,                               \
 101 }
 102 #else
 103 #define __ATTR_IGNORE_LOCKDEP   __ATTR
 104 #endif
 105
 106 #define __ATTRIBUTE_GROUPS(_name)                               \
 107 static const struct attribute_group *_name##_groups[] = {       \
 108         &_name##_group,                                         \
 109         NULL,                                                   \
 110 }
 111
 112 #define ATTRIBUTE_GROUPS(_name)                                 \
 113 static const struct attribute_group _name##_group = {           \
 114         .attrs = _name##_attrs,                                 \
 115 };                                                              \
 116 __ATTRIBUTE_GROUPS(_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, _size)
 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 };
 179
 180 #ifdef CONFIG_SYSFS
 181
 182 int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *),
 183                             void *data, struct module *owner);
 184
 185 int __must_check sysfs_create_dir_ns(struct kobject *kobj, const void *ns);
 186 void sysfs_remove_dir(struct kobject *kobj);
 187 int __must_check sysfs_rename_dir_ns(struct kobject *kobj, const char *new_name,
 188                                      const void *new_ns);
 189 int __must_check sysfs_move_dir_ns(struct kobject *kobj,
 190                                    struct kobject *new_parent_kobj,
 191                                    const void *new_ns);
 192
 193 int __must_check sysfs_create_file_ns(struct kobject *kobj,
 194                                       const struct attribute *attr,
 195                                       const void *ns);
 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_ns(struct kobject *kobj, const struct attribute *attr,
 201                           const void *ns);
 202 bool sysfs_remove_file_self(struct kobject *kobj, const struct attribute *attr);
 203 void sysfs_remove_files(struct kobject *kobj, const struct attribute **attr);
 204
 205 int __must_check sysfs_create_bin_file(struct kobject *kobj,
 206                                        const struct bin_attribute *attr);
 207 void sysfs_remove_bin_file(struct kobject *kobj,
 208                            const struct bin_attribute *attr);
 209
 210 int __must_check sysfs_create_link(struct kobject *kobj, struct kobject *target,
 211                                    const char *name);
 212 int __must_check sysfs_create_link_nowarn(struct kobject *kobj,
 213                                           struct kobject *target,
 214                                           const char *name);
 215 void sysfs_remove_link(struct kobject *kobj, const char *name);
 216
 217 int sysfs_rename_link_ns(struct kobject *kobj, struct kobject *target,
 218                          const char *old_name, const char *new_name,
 219                          const void *new_ns);
 220
 221 void sysfs_delete_link(struct kobject *dir, struct kobject *targ,
 222                         const char *name);
 223
 224 int __must_check sysfs_create_group(struct kobject *kobj,
 225                                     const struct attribute_group *grp);
 226 int __must_check sysfs_create_groups(struct kobject *kobj,
 227                                      const struct attribute_group **groups);
 228 int sysfs_update_group(struct kobject *kobj,
 229                        const struct attribute_group *grp);
 230 void sysfs_remove_group(struct kobject *kobj,
 231                         const struct attribute_group *grp);
 232 void sysfs_remove_groups(struct kobject *kobj,
 233                          const struct attribute_group **groups);
 234 int sysfs_add_file_to_group(struct kobject *kobj,
 235                         const struct attribute *attr, const char *group);
 236 void sysfs_remove_file_from_group(struct kobject *kobj,
 237                         const struct attribute *attr, const char *group);
 238 int sysfs_merge_group(struct kobject *kobj,
 239                        const struct attribute_group *grp);
 240 void sysfs_unmerge_group(struct kobject *kobj,
 241                        const struct attribute_group *grp);
 242 int sysfs_add_link_to_group(struct kobject *kobj, const char *group_name,
 243                             struct kobject *target, const char *link_name);
 244 void sysfs_remove_link_from_group(struct kobject *kobj, const char *group_name,
 245                                   const char *link_name);
 246
 247 void sysfs_notify(struct kobject *kobj, const char *dir, const char *attr);
 248
 249 int __must_check sysfs_init(void);
 250
 251 static inline void sysfs_enable_ns(struct kernfs_node *kn)
 252 {
 253         return kernfs_enable_ns(kn);
 254 }
 255
 256 #else /* CONFIG_SYSFS */
 257
 258 static inline int sysfs_schedule_callback(struct kobject *kobj,
 259                 void (*func)(void *), void *data, struct module *owner)
 260 {
 261         return -ENOSYS;
 262 }
 263
 264 static inline int sysfs_create_dir_ns(struct kobject *kobj, const void *ns)
 265 {
 266         return 0;
 267 }
 268
 269 static inline void sysfs_remove_dir(struct kobject *kobj)
 270 {
 271 }
 272
 273 static inline int sysfs_rename_dir_ns(struct kobject *kobj,
 274                                       const char *new_name, const void *new_ns)
 275 {
 276         return 0;
 277 }
 278
 279 static inline int sysfs_move_dir_ns(struct kobject *kobj,
 280                                     struct kobject *new_parent_kobj,
 281                                     const void *new_ns)
 282 {
 283         return 0;
 284 }
 285
 286 static inline int sysfs_create_file_ns(struct kobject *kobj,
 287                                        const struct attribute *attr,
 288                                        const void *ns)
 289 {
 290         return 0;
 291 }
 292
 293 static inline int sysfs_create_files(struct kobject *kobj,
 294                                     const struct attribute **attr)
 295 {
 296         return 0;
 297 }
 298
 299 static inline int sysfs_chmod_file(struct kobject *kobj,
 300                                    const struct attribute *attr, umode_t mode)
 301 {
 302         return 0;
 303 }
 304
 305 static inline void sysfs_remove_file_ns(struct kobject *kobj,
 306                                         const struct attribute *attr,
 307                                         const void *ns)
 308 {
 309 }
 310
 311 static inline bool sysfs_remove_file_self(struct kobject *kobj,
 312                                           const struct attribute *attr)
 313 {
 314         return false;
 315 }
 316
 317 static inline void sysfs_remove_files(struct kobject *kobj,
 318                                      const struct attribute **attr)
 319 {
 320 }
 321
 322 static inline int sysfs_create_bin_file(struct kobject *kobj,
 323                                         const struct bin_attribute *attr)
 324 {
 325         return 0;
 326 }
 327
 328 static inline void sysfs_remove_bin_file(struct kobject *kobj,
 329                                          const struct bin_attribute *attr)
 330 {
 331 }
 332
 333 static inline int sysfs_create_link(struct kobject *kobj,
 334                                     struct kobject *target, const char *name)
 335 {
 336         return 0;
 337 }
 338
 339 static inline int sysfs_create_link_nowarn(struct kobject *kobj,
 340                                            struct kobject *target,
 341                                            const char *name)
 342 {
 343         return 0;
 344 }
 345
 346 static inline void sysfs_remove_link(struct kobject *kobj, const char *name)
 347 {
 348 }
 349
 350 static inline int sysfs_rename_link_ns(struct kobject *k, struct kobject *t,
 351                                        const char *old_name,
 352                                        const char *new_name, const void *ns)
 353 {
 354         return 0;
 355 }
 356
 357 static inline void sysfs_delete_link(struct kobject *k, struct kobject *t,
 358                                      const char *name)
 359 {
 360 }
 361
 362 static inline int sysfs_create_group(struct kobject *kobj,
 363                                      const struct attribute_group *grp)
 364 {
 365         return 0;
 366 }
 367
 368 static inline int sysfs_create_groups(struct kobject *kobj,
 369                                       const struct attribute_group **groups)
 370 {
 371         return 0;
 372 }
 373
 374 static inline int sysfs_update_group(struct kobject *kobj,
 375                                 const struct attribute_group *grp)
 376 {
 377         return 0;
 378 }
 379
 380 static inline void sysfs_remove_group(struct kobject *kobj,
 381                                       const struct attribute_group *grp)
 382 {
 383 }
 384
 385 static inline void sysfs_remove_groups(struct kobject *kobj,
 386                                        const struct attribute_group **groups)
 387 {
 388 }
 389
 390 static inline int sysfs_add_file_to_group(struct kobject *kobj,
 391                 const struct attribute *attr, const char *group)
 392 {
 393         return 0;
 394 }
 395
 396 static inline void sysfs_remove_file_from_group(struct kobject *kobj,
 397                 const struct attribute *attr, const char *group)
 398 {
 399 }
 400
 401 static inline int sysfs_merge_group(struct kobject *kobj,
 402                        const struct attribute_group *grp)
 403 {
 404         return 0;
 405 }
 406
 407 static inline void sysfs_unmerge_group(struct kobject *kobj,
 408                        const struct attribute_group *grp)
 409 {
 410 }
 411
 412 static inline int sysfs_add_link_to_group(struct kobject *kobj,
 413                 const char *group_name, struct kobject *target,
 414                 const char *link_name)
 415 {
 416         return 0;
 417 }
 418
 419 static inline void sysfs_remove_link_from_group(struct kobject *kobj,
 420                 const char *group_name, const char *link_name)
 421 {
 422 }
 423
 424 static inline void sysfs_notify(struct kobject *kobj, const char *dir,
 425                                 const char *attr)
 426 {
 427 }
 428
 429 static inline int __must_check sysfs_init(void)
 430 {
 431         return 0;
 432 }
 433
 434 static inline void sysfs_enable_ns(struct kernfs_node *kn)
 435 {
 436 }
 437
 438 #endif /* CONFIG_SYSFS */
 439
 440 static inline int __must_check sysfs_create_file(struct kobject *kobj,
 441                                                  const struct attribute *attr)
 442 {
 443         return sysfs_create_file_ns(kobj, attr, NULL);
 444 }
 445
 446 static inline void sysfs_remove_file(struct kobject *kobj,
 447                                      const struct attribute *attr)
 448 {
 449         return sysfs_remove_file_ns(kobj, attr, NULL);
 450 }
 451
 452 static inline int sysfs_rename_link(struct kobject *kobj, struct kobject *target,
 453                                     const char *old_name, const char *new_name)
 454 {
 455         return sysfs_rename_link_ns(kobj, target, old_name, new_name, NULL);
 456 }
 457
 458 static inline void sysfs_notify_dirent(struct kernfs_node *kn)
 459 {
 460         kernfs_notify(kn);
 461 }
 462
 463 static inline struct kernfs_node *sysfs_get_dirent(struct kernfs_node *parent,
 464                                                    const unsigned char *name)
 465 {
 466         return kernfs_find_and_get(parent, name);
 467 }
 468
 469 static inline struct kernfs_node *sysfs_get(struct kernfs_node *kn)
 470 {
 471         kernfs_get(kn);
 472         return kn;
 473 }
 474
 475 static inline void sysfs_put(struct kernfs_node *kn)
 476 {
 477         kernfs_put(kn);
 478 }
 479
 480 #endif /* _SYSFS_H_ */