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 /**
  61  * struct attribute_group - data structure used to declare an attribute group.
  62  * @name:       Optional: Attribute group name
  63  *              If specified, the attribute group will be created in
  64  *              a new subdirectory with this name.
  65  * @is_visible: Optional: Function to return permissions associated with an
  66  *              attribute of the group. Will be called repeatedly for each
  67  *              non-binary attribute in the group. Only read/write
  68  *              permissions as well as SYSFS_PREALLOC are accepted. Must
  69  *              return 0 if an attribute is not visible. The returned value
  70  *              will replace static permissions defined in struct attribute.
  71  * @is_bin_visible:
  72  *              Optional: Function to return permissions associated with a
  73  *              binary attribute of the group. Will be called repeatedly
  74  *              for each binary attribute in the group. Only read/write
  75  *              permissions as well as SYSFS_PREALLOC are accepted. Must
  76  *              return 0 if a binary attribute is not visible. The returned
  77  *              value will replace static permissions defined in
  78  *              struct bin_attribute.
  79  * @attrs:      Pointer to NULL terminated list of attributes.
  80  * @bin_attrs:  Pointer to NULL terminated list of binary attributes.
  81  *              Either attrs or bin_attrs or both must be provided.
  82  */
  83 struct attribute_group {
  84         const char              *name;
  85         umode_t                 (*is_visible)(struct kobject *,
  86                                               struct attribute *, int);
  87         umode_t                 (*is_bin_visible)(struct kobject *,
  88                                                   struct bin_attribute *, int);
  89         struct attribute        **attrs;
  90         struct bin_attribute    **bin_attrs;
  91 };
  92
  93 /**
  94  * Use these macros to make defining attributes easier. See include/linux/device.h
  95  * for examples..
  96  */
  97
  98 #define SYSFS_PREALLOC 010000
  99
 100 #define __ATTR(_name, _mode, _show, _store) {                           \
 101         .attr = {.name = __stringify(_name),                            \
 102                  .mode = VERIFY_OCTAL_PERMISSIONS(_mode) },             \
 103         .show   = _show,                                                \
 104         .store  = _store,                                               \
 105 }
 106
 107 #define __ATTR_PREALLOC(_name, _mode, _show, _store) {                  \
 108         .attr = {.name = __stringify(_name),                            \
 109                  .mode = SYSFS_PREALLOC | VERIFY_OCTAL_PERMISSIONS(_mode) },\
 110         .show   = _show,                                                \
 111         .store  = _store,                                               \
 112 }
 113
 114 #define __ATTR_RO(_name) {                                              \
 115         .attr   = { .name = __stringify(_name), .mode = S_IRUGO },      \
 116         .show   = _name##_show,                                         \
 117 }
 118
 119 #define __ATTR_RO_MODE(_name, _mode) {                                  \
 120         .attr   = { .name = __stringify(_name),                         \
 121                     .mode = VERIFY_OCTAL_PERMISSIONS(_mode) },          \
 122         .show   = _name##_show,                                         \
 123 }
 124
 125 #define __ATTR_WO(_name) {                                              \
 126         .attr   = { .name = __stringify(_name), .mode = S_IWUSR },      \
 127         .store  = _name##_store,                                        \
 128 }
 129
 130 #define __ATTR_RW(_name) __ATTR(_name, (S_IWUSR | S_IRUGO),             \
 131                          _name##_show, _name##_store)
 132
 133 #define __ATTR_NULL { .attr = { .name = NULL } }
 134
 135 #ifdef CONFIG_DEBUG_LOCK_ALLOC
 136 #define __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) {    \
 137         .attr = {.name = __stringify(_name), .mode = _mode,     \
 138                         .ignore_lockdep = true },               \
 139         .show           = _show,                                \
 140         .store          = _store,                               \
 141 }
 142 #else
 143 #define __ATTR_IGNORE_LOCKDEP   __ATTR
 144 #endif
 145
 146 #define __ATTRIBUTE_GROUPS(_name)                               \
 147 static const struct attribute_group *_name##_groups[] = {       \
 148         &_name##_group,                                         \
 149         NULL,                                                   \
 150 }
 151
 152 #define ATTRIBUTE_GROUPS(_name)                                 \
 153 static const struct attribute_group _name##_group = {           \
 154         .attrs = _name##_attrs,                                 \
 155 };                                                              \
 156 __ATTRIBUTE_GROUPS(_name)
 157
 158 struct file;
 159 struct vm_area_struct;
 160
 161 struct bin_attribute {
 162         struct attribute        attr;
 163         size_t                  size;
 164         void                    *private;
 165         ssize_t (*read)(struct file *, struct kobject *, struct bin_attribute *,
 166                         char *, loff_t, size_t);
 167         ssize_t (*write)(struct file *, struct kobject *, struct bin_attribute *,
 168                          char *, loff_t, size_t);
 169         int (*mmap)(struct file *, struct kobject *, struct bin_attribute *attr,
 170                     struct vm_area_struct *vma);
 171 };
 172
 173 /**
 174  *      sysfs_bin_attr_init - initialize a dynamically allocated bin_attribute
 175  *      @attr: struct bin_attribute to initialize
 176  *
 177  *      Initialize a dynamically allocated struct bin_attribute so we
 178  *      can make lockdep happy.  This is a new requirement for
 179  *      attributes and initially this is only needed when lockdep is
 180  *      enabled.  Lockdep gives a nice error when your attribute is
 181  *      added to sysfs if you don't have this.
 182  */
 183 #define sysfs_bin_attr_init(bin_attr) sysfs_attr_init(&(bin_attr)->attr)
 184
 185 /* macros to create static binary attributes easier */
 186 #define __BIN_ATTR(_name, _mode, _read, _write, _size) {                \
 187         .attr = { .name = __stringify(_name), .mode = _mode },          \
 188         .read   = _read,                                                \
 189         .write  = _write,                                               \
 190         .size   = _size,                                                \
 191 }
 192
 193 #define __BIN_ATTR_RO(_name, _size) {                                   \
 194         .attr   = { .name = __stringify(_name), .mode = S_IRUGO },      \
 195         .read   = _name##_read,                                         \
 196         .size   = _size,                                                \
 197 }
 198
 199 #define __BIN_ATTR_RW(_name, _size) __BIN_ATTR(_name,                   \
 200                                    (S_IWUSR | S_IRUGO), _name##_read,   \
 201                                    _name##_write, _size)
 202
 203 #define __BIN_ATTR_NULL __ATTR_NULL
 204
 205 #define BIN_ATTR(_name, _mode, _read, _write, _size)                    \
 206 struct bin_attribute bin_attr_##_name = __BIN_ATTR(_name, _mode, _read, \
 207                                         _write, _size)
 208
 209 #define BIN_ATTR_RO(_name, _size)                                       \
 210 struct bin_attribute bin_attr_##_name = __BIN_ATTR_RO(_name, _size)
 211
 212 #define BIN_ATTR_RW(_name, _size)                                       \
 213 struct bin_attribute bin_attr_##_name = __BIN_ATTR_RW(_name, _size)
 214
 215 struct sysfs_ops {
 216         ssize_t (*show)(struct kobject *, struct attribute *, char *);
 217         ssize_t (*store)(struct kobject *, struct attribute *, const char *, size_t);
 218 };
 219
 220 #ifdef CONFIG_SYSFS
 221
 222 int __must_check sysfs_create_dir_ns(struct kobject *kobj, const void *ns);
 223 void sysfs_remove_dir(struct kobject *kobj);
 224 int __must_check sysfs_rename_dir_ns(struct kobject *kobj, const char *new_name,
 225                                      const void *new_ns);
 226 int __must_check sysfs_move_dir_ns(struct kobject *kobj,
 227                                    struct kobject *new_parent_kobj,
 228                                    const void *new_ns);
 229 int __must_check sysfs_create_mount_point(struct kobject *parent_kobj,
 230                                           const char *name);
 231 void sysfs_remove_mount_point(struct kobject *parent_kobj,
 232                               const char *name);
 233
 234 int __must_check sysfs_create_file_ns(struct kobject *kobj,
 235                                       const struct attribute *attr,
 236                                       const void *ns);
 237 int __must_check sysfs_create_files(struct kobject *kobj,
 238                                    const struct attribute **attr);
 239 int __must_check sysfs_chmod_file(struct kobject *kobj,
 240                                   const struct attribute *attr, umode_t mode);
 241 struct kernfs_node *sysfs_break_active_protection(struct kobject *kobj,
 242                                                   const struct attribute *attr);
 243 void sysfs_unbreak_active_protection(struct kernfs_node *kn);
 244 void sysfs_remove_file_ns(struct kobject *kobj, const struct attribute *attr,
 245                           const void *ns);
 246 bool sysfs_remove_file_self(struct kobject *kobj, const struct attribute *attr);
 247 void sysfs_remove_files(struct kobject *kobj, const struct attribute **attr);
 248
 249 int __must_check sysfs_create_bin_file(struct kobject *kobj,
 250                                        const struct bin_attribute *attr);
 251 void sysfs_remove_bin_file(struct kobject *kobj,
 252                            const struct bin_attribute *attr);
 253
 254 int __must_check sysfs_create_link(struct kobject *kobj, struct kobject *target,
 255                                    const char *name);
 256 int __must_check sysfs_create_link_nowarn(struct kobject *kobj,
 257                                           struct kobject *target,
 258                                           const char *name);
 259 void sysfs_remove_link(struct kobject *kobj, const char *name);
 260
 261 int sysfs_rename_link_ns(struct kobject *kobj, struct kobject *target,
 262                          const char *old_name, const char *new_name,
 263                          const void *new_ns);
 264
 265 void sysfs_delete_link(struct kobject *dir, struct kobject *targ,
 266                         const char *name);
 267
 268 int __must_check sysfs_create_group(struct kobject *kobj,
 269                                     const struct attribute_group *grp);
 270 int __must_check sysfs_create_groups(struct kobject *kobj,
 271                                      const struct attribute_group **groups);
 272 int sysfs_update_group(struct kobject *kobj,
 273                        const struct attribute_group *grp);
 274 void sysfs_remove_group(struct kobject *kobj,
 275                         const struct attribute_group *grp);
 276 void sysfs_remove_groups(struct kobject *kobj,
 277                          const struct attribute_group **groups);
 278 int sysfs_add_file_to_group(struct kobject *kobj,
 279                         const struct attribute *attr, const char *group);
 280 void sysfs_remove_file_from_group(struct kobject *kobj,
 281                         const struct attribute *attr, const char *group);
 282 int sysfs_merge_group(struct kobject *kobj,
 283                        const struct attribute_group *grp);
 284 void sysfs_unmerge_group(struct kobject *kobj,
 285                        const struct attribute_group *grp);
 286 int sysfs_add_link_to_group(struct kobject *kobj, const char *group_name,
 287                             struct kobject *target, const char *link_name);
 288 void sysfs_remove_link_from_group(struct kobject *kobj, const char *group_name,
 289                                   const char *link_name);
 290 int __compat_only_sysfs_link_entry_to_kobj(struct kobject *kobj,
 291                                       struct kobject *target_kobj,
 292                                       const char *target_name);
 293
 294 void sysfs_notify(struct kobject *kobj, const char *dir, const char *attr);
 295
 296 int __must_check sysfs_init(void);
 297
 298 static inline void sysfs_enable_ns(struct kernfs_node *kn)
 299 {
 300         return kernfs_enable_ns(kn);
 301 }
 302
 303 __printf(2, 3)
 304 int sysfs_emit(char *buf, const char *fmt, ...);
 305 __printf(3, 4)
 306 int sysfs_emit_at(char *buf, int at, const char *fmt, ...);
 307
 308 #else /* CONFIG_SYSFS */
 309
 310 static inline int sysfs_create_dir_ns(struct kobject *kobj, const void *ns)
 311 {
 312         return 0;
 313 }
 314
 315 static inline void sysfs_remove_dir(struct kobject *kobj)
 316 {
 317 }
 318
 319 static inline int sysfs_rename_dir_ns(struct kobject *kobj,
 320                                       const char *new_name, const void *new_ns)
 321 {
 322         return 0;
 323 }
 324
 325 static inline int sysfs_move_dir_ns(struct kobject *kobj,
 326                                     struct kobject *new_parent_kobj,
 327                                     const void *new_ns)
 328 {
 329         return 0;
 330 }
 331
 332 static inline int sysfs_create_mount_point(struct kobject *parent_kobj,
 333                                            const char *name)
 334 {
 335         return 0;
 336 }
 337
 338 static inline void sysfs_remove_mount_point(struct kobject *parent_kobj,
 339                                             const char *name)
 340 {
 341 }
 342
 343 static inline int sysfs_create_file_ns(struct kobject *kobj,
 344                                        const struct attribute *attr,
 345                                        const void *ns)
 346 {
 347         return 0;
 348 }
 349
 350 static inline int sysfs_create_files(struct kobject *kobj,
 351                                     const struct attribute **attr)
 352 {
 353         return 0;
 354 }
 355
 356 static inline int sysfs_chmod_file(struct kobject *kobj,
 357                                    const struct attribute *attr, umode_t mode)
 358 {
 359         return 0;
 360 }
 361
 362 static inline struct kernfs_node *
 363 sysfs_break_active_protection(struct kobject *kobj,
 364                               const struct attribute *attr)
 365 {
 366         return NULL;
 367 }
 368
 369 static inline void sysfs_unbreak_active_protection(struct kernfs_node *kn)
 370 {
 371 }
 372
 373 static inline void sysfs_remove_file_ns(struct kobject *kobj,
 374                                         const struct attribute *attr,
 375                                         const void *ns)
 376 {
 377 }
 378
 379 static inline bool sysfs_remove_file_self(struct kobject *kobj,
 380                                           const struct attribute *attr)
 381 {
 382         return false;
 383 }
 384
 385 static inline void sysfs_remove_files(struct kobject *kobj,
 386                                      const struct attribute **attr)
 387 {
 388 }
 389
 390 static inline int sysfs_create_bin_file(struct kobject *kobj,
 391                                         const struct bin_attribute *attr)
 392 {
 393         return 0;
 394 }
 395
 396 static inline void sysfs_remove_bin_file(struct kobject *kobj,
 397                                          const struct bin_attribute *attr)
 398 {
 399 }
 400
 401 static inline int sysfs_create_link(struct kobject *kobj,
 402                                     struct kobject *target, const char *name)
 403 {
 404         return 0;
 405 }
 406
 407 static inline int sysfs_create_link_nowarn(struct kobject *kobj,
 408                                            struct kobject *target,
 409                                            const char *name)
 410 {
 411         return 0;
 412 }
 413
 414 static inline void sysfs_remove_link(struct kobject *kobj, const char *name)
 415 {
 416 }
 417
 418 static inline int sysfs_rename_link_ns(struct kobject *k, struct kobject *t,
 419                                        const char *old_name,
 420                                        const char *new_name, const void *ns)
 421 {
 422         return 0;
 423 }
 424
 425 static inline void sysfs_delete_link(struct kobject *k, struct kobject *t,
 426                                      const char *name)
 427 {
 428 }
 429
 430 static inline int sysfs_create_group(struct kobject *kobj,
 431                                      const struct attribute_group *grp)
 432 {
 433         return 0;
 434 }
 435
 436 static inline int sysfs_create_groups(struct kobject *kobj,
 437                                       const struct attribute_group **groups)
 438 {
 439         return 0;
 440 }
 441
 442 static inline int sysfs_update_group(struct kobject *kobj,
 443                                 const struct attribute_group *grp)
 444 {
 445         return 0;
 446 }
 447
 448 static inline void sysfs_remove_group(struct kobject *kobj,
 449                                       const struct attribute_group *grp)
 450 {
 451 }
 452
 453 static inline void sysfs_remove_groups(struct kobject *kobj,
 454                                        const struct attribute_group **groups)
 455 {
 456 }
 457
 458 static inline int sysfs_add_file_to_group(struct kobject *kobj,
 459                 const struct attribute *attr, const char *group)
 460 {
 461         return 0;
 462 }
 463
 464 static inline void sysfs_remove_file_from_group(struct kobject *kobj,
 465                 const struct attribute *attr, const char *group)
 466 {
 467 }
 468
 469 static inline int sysfs_merge_group(struct kobject *kobj,
 470                        const struct attribute_group *grp)
 471 {
 472         return 0;
 473 }
 474
 475 static inline void sysfs_unmerge_group(struct kobject *kobj,
 476                        const struct attribute_group *grp)
 477 {
 478 }
 479
 480 static inline int sysfs_add_link_to_group(struct kobject *kobj,
 481                 const char *group_name, struct kobject *target,
 482                 const char *link_name)
 483 {
 484         return 0;
 485 }
 486
 487 static inline void sysfs_remove_link_from_group(struct kobject *kobj,
 488                 const char *group_name, const char *link_name)
 489 {
 490 }
 491
 492 static inline int __compat_only_sysfs_link_entry_to_kobj(
 493         struct kobject *kobj,
 494         struct kobject *target_kobj,
 495         const char *target_name)
 496 {
 497         return 0;
 498 }
 499
 500 static inline void sysfs_notify(struct kobject *kobj, const char *dir,
 501                                 const char *attr)
 502 {
 503 }
 504
 505 static inline int __must_check sysfs_init(void)
 506 {
 507         return 0;
 508 }
 509
 510 static inline void sysfs_enable_ns(struct kernfs_node *kn)
 511 {
 512 }
 513
 514 __printf(2, 3)
 515 static inline int sysfs_emit(char *buf, const char *fmt, ...)
 516 {
 517         return 0;
 518 }
 519
 520 __printf(3, 4)
 521 static inline int sysfs_emit_at(char *buf, int at, const char *fmt, ...)
 522 {
 523         return 0;
 524 }
 525 #endif /* CONFIG_SYSFS */
 526
 527 static inline int __must_check sysfs_create_file(struct kobject *kobj,
 528                                                  const struct attribute *attr)
 529 {
 530         return sysfs_create_file_ns(kobj, attr, NULL);
 531 }
 532
 533 static inline void sysfs_remove_file(struct kobject *kobj,
 534                                      const struct attribute *attr)
 535 {
 536         sysfs_remove_file_ns(kobj, attr, NULL);
 537 }
 538
 539 static inline int sysfs_rename_link(struct kobject *kobj, struct kobject *target,
 540                                     const char *old_name, const char *new_name)
 541 {
 542         return sysfs_rename_link_ns(kobj, target, old_name, new_name, NULL);
 543 }
 544
 545 static inline void sysfs_notify_dirent(struct kernfs_node *kn)
 546 {
 547         kernfs_notify(kn);
 548 }
 549
 550 static inline struct kernfs_node *sysfs_get_dirent(struct kernfs_node *parent,
 551                                                    const unsigned char *name)
 552 {
 553         return kernfs_find_and_get(parent, name);
 554 }
 555
 556 static inline struct kernfs_node *sysfs_get(struct kernfs_node *kn)
 557 {
 558         kernfs_get(kn);
 559         return kn;
 560 }
 561
 562 static inline void sysfs_put(struct kernfs_node *kn)
 563 {
 564         kernfs_put(kn);
 565 }
 566
 567 #endif /* _SYSFS_H_ */