include/linux/sysfs.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * sysfs.h - definitions for the device driver filesystem
   4  *
   5  * Copyright (c) 2001,2002 Patrick Mochel
   6  * Copyright (c) 2004 Silicon Graphics, Inc.
   7  * Copyright (c) 2007 SUSE Linux Products GmbH
   8  * Copyright (c) 2007 Tejun Heo <teheo@suse.de>
   9  *
  10  * Please see Documentation/filesystems/sysfs.txt for more information.
  11  */
  12
  13 #ifndef _SYSFS_H_
  14 #define _SYSFS_H_
  15
  16 #include <linux/kernfs.h>
  17 #include <linux/compiler.h>
  18 #include <linux/errno.h>
  19 #include <linux/list.h>
  20 #include <linux/lockdep.h>
  21 #include <linux/kobject_ns.h>
  22 #include <linux/stat.h>
  23 #include <linux/atomic.h>
  24
  25 struct kobject;
  26 struct module;
  27 struct bin_attribute;
  28 enum kobj_ns_type;
  29
  30 struct attribute {
  31         const char              *name;
  32         umode_t                 mode;
  33 #ifdef CONFIG_DEBUG_LOCK_ALLOC
  34         bool                    ignore_lockdep:1;
  35         struct lock_class_key   *key;
  36         struct lock_class_key   skey;
  37 #endif
  38 };
  39
  40 /**
  41  *      sysfs_attr_init - initialize a dynamically allocated sysfs attribute
  42  *      @attr: struct attribute to initialize
  43  *
  44  *      Initialize a dynamically allocated struct attribute so we can
  45  *      make lockdep happy.  This is a new requirement for attributes
  46  *      and initially this is only needed when lockdep is enabled.
  47  *      Lockdep gives a nice error when your attribute is added to
  48  *      sysfs if you don't have this.
  49  */
  50 #ifdef CONFIG_DEBUG_LOCK_ALLOC
  51 #define sysfs_attr_init(attr)                           \
  52 do {                                                    \
  53         static struct lock_class_key __key;             \
  54                                                         \
  55         (attr)->key = &__key;                           \
  56 } while (0)
  57 #else
  58 #define sysfs_attr_init(attr) do {} while (0)
  59 #endif
  60
  61 /**
  62  * struct attribute_group - data structure used to declare an attribute group.
  63  * @name:       Optional: Attribute group name
  64  *              If specified, the attribute group will be created in
  65  *              a new subdirectory with this name.
  66  * @is_visible: Optional: Function to return permissions associated with an
  67  *              attribute of the group. Will be called repeatedly for each
  68  *              non-binary attribute in the group. Only read/write
  69  *              permissions as well as SYSFS_PREALLOC are accepted. Must
  70  *              return 0 if an attribute is not visible. The returned value
  71  *              will replace static permissions defined in struct attribute.
  72  * @is_bin_visible:
  73  *              Optional: Function to return permissions associated with a
  74  *              binary attribute of the group. Will be called repeatedly
  75  *              for each binary attribute in the group. Only read/write
  76  *              permissions as well as SYSFS_PREALLOC are accepted. Must
  77  *              return 0 if a binary attribute is not visible. The returned
  78  *              value will replace static permissions defined in
  79  *              struct bin_attribute.
  80  * @attrs:      Pointer to NULL terminated list of attributes.
  81  * @bin_attrs:  Pointer to NULL terminated list of binary attributes.
  82  *              Either attrs or bin_attrs or both must be provided.
  83  */
  84 struct attribute_group {
  85         const char              *name;
  86         umode_t                 (*is_visible)(struct kobject *,
  87                                               struct attribute *, int);
  88         umode_t                 (*is_bin_visible)(struct kobject *,
  89                                                   struct bin_attribute *, int);
  90         struct attribute        **attrs;
  91         struct bin_attribute    **bin_attrs;
  92 };
  93
  94 /*
  95  * Use these macros to make defining attributes easier.
  96  * See include/linux/device.h for examples..
  97  */
  98
  99 #define SYSFS_PREALLOC 010000
 100
 101 #define __ATTR(_name, _mode, _show, _store) {                           \
 102         .attr = {.name = __stringify(_name),                            \
 103                  .mode = VERIFY_OCTAL_PERMISSIONS(_mode) },             \
 104         .show   = _show,                                                \
 105         .store  = _store,                                               \
 106 }
 107
 108 #define __ATTR_PREALLOC(_name, _mode, _show, _store) {                  \
 109         .attr = {.name = __stringify(_name),                            \
 110                  .mode = SYSFS_PREALLOC | VERIFY_OCTAL_PERMISSIONS(_mode) },\
 111         .show   = _show,                                                \
 112         .store  = _store,                                               \
 113 }
 114
 115 #define __ATTR_RO(_name) {                                              \
 116         .attr   = { .name = __stringify(_name), .mode = 0444 },         \
 117         .show   = _name##_show,                                         \
 118 }
 119
 120 #define __ATTR_RO_MODE(_name, _mode) {                                  \
 121         .attr   = { .name = __stringify(_name),                         \
 122                     .mode = VERIFY_OCTAL_PERMISSIONS(_mode) },          \
 123         .show   = _name##_show,                                         \
 124 }
 125
 126 #define __ATTR_WO(_name) {                                              \
 127         .attr   = { .name = __stringify(_name), .mode = 0200 },         \
 128         .store  = _name##_store,                                        \
 129 }
 130
 131 #define __ATTR_RW(_name) __ATTR(_name, 0644, _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 = 0444 },         \
 195         .read   = _name##_read,                                         \
 196         .size   = _size,                                                \
 197 }
 198
 199 #define __BIN_ATTR_WO(_name, _size) {                                   \
 200         .attr   = { .name = __stringify(_name), .mode = 0200 },         \
 201         .write  = _name##_write,                                        \
 202         .size   = _size,                                                \
 203 }
 204
 205 #define __BIN_ATTR_RW(_name, _size)                                     \
 206         __BIN_ATTR(_name, 0644, _name##_read, _name##_write, _size)
 207
 208 #define __BIN_ATTR_NULL __ATTR_NULL
 209
 210 #define BIN_ATTR(_name, _mode, _read, _write, _size)                    \
 211 struct bin_attribute bin_attr_##_name = __BIN_ATTR(_name, _mode, _read, \
 212                                         _write, _size)
 213
 214 #define BIN_ATTR_RO(_name, _size)                                       \
 215 struct bin_attribute bin_attr_##_name = __BIN_ATTR_RO(_name, _size)
 216
 217 #define BIN_ATTR_WO(_name, _size)                                       \
 218 struct bin_attribute bin_attr_##_name = __BIN_ATTR_WO(_name, _size)
 219
 220 #define BIN_ATTR_RW(_name, _size)                                       \
 221 struct bin_attribute bin_attr_##_name = __BIN_ATTR_RW(_name, _size)
 222
 223 struct sysfs_ops {
 224         ssize_t (*show)(struct kobject *, struct attribute *, char *);
 225         ssize_t (*store)(struct kobject *, struct attribute *, const char *, size_t);
 226 };
 227
 228 #ifdef CONFIG_SYSFS
 229
 230 int __must_check sysfs_create_dir_ns(struct kobject *kobj, const void *ns);
 231 void sysfs_remove_dir(struct kobject *kobj);
 232 int __must_check sysfs_rename_dir_ns(struct kobject *kobj, const char *new_name,
 233                                      const void *new_ns);
 234 int __must_check sysfs_move_dir_ns(struct kobject *kobj,
 235                                    struct kobject *new_parent_kobj,
 236                                    const void *new_ns);
 237 int __must_check sysfs_create_mount_point(struct kobject *parent_kobj,
 238                                           const char *name);
 239 void sysfs_remove_mount_point(struct kobject *parent_kobj,
 240                               const char *name);
 241
 242 int __must_check sysfs_create_file_ns(struct kobject *kobj,
 243                                       const struct attribute *attr,
 244                                       const void *ns);
 245 int __must_check sysfs_create_files(struct kobject *kobj,
 246                                    const struct attribute * const *attr);
 247 int __must_check sysfs_chmod_file(struct kobject *kobj,
 248                                   const struct attribute *attr, umode_t mode);
 249 struct kernfs_node *sysfs_break_active_protection(struct kobject *kobj,
 250                                                   const struct attribute *attr);
 251 void sysfs_unbreak_active_protection(struct kernfs_node *kn);
 252 void sysfs_remove_file_ns(struct kobject *kobj, const struct attribute *attr,
 253                           const void *ns);
 254 bool sysfs_remove_file_self(struct kobject *kobj, const struct attribute *attr);
 255 void sysfs_remove_files(struct kobject *kobj, const struct attribute * const *attr);
 256
 257 int __must_check sysfs_create_bin_file(struct kobject *kobj,
 258                                        const struct bin_attribute *attr);
 259 void sysfs_remove_bin_file(struct kobject *kobj,
 260                            const struct bin_attribute *attr);
 261
 262 int __must_check sysfs_create_link(struct kobject *kobj, struct kobject *target,
 263                                    const char *name);
 264 int __must_check sysfs_create_link_nowarn(struct kobject *kobj,
 265                                           struct kobject *target,
 266                                           const char *name);
 267 void sysfs_remove_link(struct kobject *kobj, const char *name);
 268
 269 int sysfs_rename_link_ns(struct kobject *kobj, struct kobject *target,
 270                          const char *old_name, const char *new_name,
 271                          const void *new_ns);
 272
 273 void sysfs_delete_link(struct kobject *dir, struct kobject *targ,
 274                         const char *name);
 275
 276 int __must_check sysfs_create_group(struct kobject *kobj,
 277                                     const struct attribute_group *grp);
 278 int __must_check sysfs_create_groups(struct kobject *kobj,
 279                                      const struct attribute_group **groups);
 280 int __must_check sysfs_update_groups(struct kobject *kobj,
 281                                      const struct attribute_group **groups);
 282 int sysfs_update_group(struct kobject *kobj,
 283                        const struct attribute_group *grp);
 284 void sysfs_remove_group(struct kobject *kobj,
 285                         const struct attribute_group *grp);
 286 void sysfs_remove_groups(struct kobject *kobj,
 287                          const struct attribute_group **groups);
 288 int sysfs_add_file_to_group(struct kobject *kobj,
 289                         const struct attribute *attr, const char *group);
 290 void sysfs_remove_file_from_group(struct kobject *kobj,
 291                         const struct attribute *attr, const char *group);
 292 int sysfs_merge_group(struct kobject *kobj,
 293                        const struct attribute_group *grp);
 294 void sysfs_unmerge_group(struct kobject *kobj,
 295                        const struct attribute_group *grp);
 296 int sysfs_add_link_to_group(struct kobject *kobj, const char *group_name,
 297                             struct kobject *target, const char *link_name);
 298 void sysfs_remove_link_from_group(struct kobject *kobj, const char *group_name,
 299                                   const char *link_name);
 300 int __compat_only_sysfs_link_entry_to_kobj(struct kobject *kobj,
 301                                       struct kobject *target_kobj,
 302                                       const char *target_name);
 303
 304 void sysfs_notify(struct kobject *kobj, const char *dir, const char *attr);
 305
 306 int __must_check sysfs_init(void);
 307
 308 static inline void sysfs_enable_ns(struct kernfs_node *kn)
 309 {
 310         return kernfs_enable_ns(kn);
 311 }
 312
 313 __printf(2, 3)
 314 int sysfs_emit(char *buf, const char *fmt, ...);
 315 __printf(3, 4)
 316 int sysfs_emit_at(char *buf, int at, const char *fmt, ...);
 317
 318 #else /* CONFIG_SYSFS */
 319
 320 static inline int sysfs_create_dir_ns(struct kobject *kobj, const void *ns)
 321 {
 322         return 0;
 323 }
 324
 325 static inline void sysfs_remove_dir(struct kobject *kobj)
 326 {
 327 }
 328
 329 static inline int sysfs_rename_dir_ns(struct kobject *kobj,
 330                                       const char *new_name, const void *new_ns)
 331 {
 332         return 0;
 333 }
 334
 335 static inline int sysfs_move_dir_ns(struct kobject *kobj,
 336                                     struct kobject *new_parent_kobj,
 337                                     const void *new_ns)
 338 {
 339         return 0;
 340 }
 341
 342 static inline int sysfs_create_mount_point(struct kobject *parent_kobj,
 343                                            const char *name)
 344 {
 345         return 0;
 346 }
 347
 348 static inline void sysfs_remove_mount_point(struct kobject *parent_kobj,
 349                                             const char *name)
 350 {
 351 }
 352
 353 static inline int sysfs_create_file_ns(struct kobject *kobj,
 354                                        const struct attribute *attr,
 355                                        const void *ns)
 356 {
 357         return 0;
 358 }
 359
 360 static inline int sysfs_create_files(struct kobject *kobj,
 361                                     const struct attribute * const *attr)
 362 {
 363         return 0;
 364 }
 365
 366 static inline int sysfs_chmod_file(struct kobject *kobj,
 367                                    const struct attribute *attr, umode_t mode)
 368 {
 369         return 0;
 370 }
 371
 372 static inline struct kernfs_node *
 373 sysfs_break_active_protection(struct kobject *kobj,
 374                               const struct attribute *attr)
 375 {
 376         return NULL;
 377 }
 378
 379 static inline void sysfs_unbreak_active_protection(struct kernfs_node *kn)
 380 {
 381 }
 382
 383 static inline void sysfs_remove_file_ns(struct kobject *kobj,
 384                                         const struct attribute *attr,
 385                                         const void *ns)
 386 {
 387 }
 388
 389 static inline bool sysfs_remove_file_self(struct kobject *kobj,
 390                                           const struct attribute *attr)
 391 {
 392         return false;
 393 }
 394
 395 static inline void sysfs_remove_files(struct kobject *kobj,
 396                                      const struct attribute * const *attr)
 397 {
 398 }
 399
 400 static inline int sysfs_create_bin_file(struct kobject *kobj,
 401                                         const struct bin_attribute *attr)
 402 {
 403         return 0;
 404 }
 405
 406 static inline void sysfs_remove_bin_file(struct kobject *kobj,
 407                                          const struct bin_attribute *attr)
 408 {
 409 }
 410
 411 static inline int sysfs_create_link(struct kobject *kobj,
 412                                     struct kobject *target, const char *name)
 413 {
 414         return 0;
 415 }
 416
 417 static inline int sysfs_create_link_nowarn(struct kobject *kobj,
 418                                            struct kobject *target,
 419                                            const char *name)
 420 {
 421         return 0;
 422 }
 423
 424 static inline void sysfs_remove_link(struct kobject *kobj, const char *name)
 425 {
 426 }
 427
 428 static inline int sysfs_rename_link_ns(struct kobject *k, struct kobject *t,
 429                                        const char *old_name,
 430                                        const char *new_name, const void *ns)
 431 {
 432         return 0;
 433 }
 434
 435 static inline void sysfs_delete_link(struct kobject *k, struct kobject *t,
 436                                      const char *name)
 437 {
 438 }
 439
 440 static inline int sysfs_create_group(struct kobject *kobj,
 441                                      const struct attribute_group *grp)
 442 {
 443         return 0;
 444 }
 445
 446 static inline int sysfs_create_groups(struct kobject *kobj,
 447                                       const struct attribute_group **groups)
 448 {
 449         return 0;
 450 }
 451
 452 static inline int sysfs_update_groups(struct kobject *kobj,
 453                                       const struct attribute_group **groups)
 454 {
 455         return 0;
 456 }
 457
 458 static inline int sysfs_update_group(struct kobject *kobj,
 459                                 const struct attribute_group *grp)
 460 {
 461         return 0;
 462 }
 463
 464 static inline void sysfs_remove_group(struct kobject *kobj,
 465                                       const struct attribute_group *grp)
 466 {
 467 }
 468
 469 static inline void sysfs_remove_groups(struct kobject *kobj,
 470                                        const struct attribute_group **groups)
 471 {
 472 }
 473
 474 static inline int sysfs_add_file_to_group(struct kobject *kobj,
 475                 const struct attribute *attr, const char *group)
 476 {
 477         return 0;
 478 }
 479
 480 static inline void sysfs_remove_file_from_group(struct kobject *kobj,
 481                 const struct attribute *attr, const char *group)
 482 {
 483 }
 484
 485 static inline int sysfs_merge_group(struct kobject *kobj,
 486                        const struct attribute_group *grp)
 487 {
 488         return 0;
 489 }
 490
 491 static inline void sysfs_unmerge_group(struct kobject *kobj,
 492                        const struct attribute_group *grp)
 493 {
 494 }
 495
 496 static inline int sysfs_add_link_to_group(struct kobject *kobj,
 497                 const char *group_name, struct kobject *target,
 498                 const char *link_name)
 499 {
 500         return 0;
 501 }
 502
 503 static inline void sysfs_remove_link_from_group(struct kobject *kobj,
 504                 const char *group_name, const char *link_name)
 505 {
 506 }
 507
 508 static inline int __compat_only_sysfs_link_entry_to_kobj(
 509         struct kobject *kobj,
 510         struct kobject *target_kobj,
 511         const char *target_name)
 512 {
 513         return 0;
 514 }
 515
 516 static inline void sysfs_notify(struct kobject *kobj, const char *dir,
 517                                 const char *attr)
 518 {
 519 }
 520
 521 static inline int __must_check sysfs_init(void)
 522 {
 523         return 0;
 524 }
 525
 526 static inline void sysfs_enable_ns(struct kernfs_node *kn)
 527 {
 528 }
 529
 530 __printf(2, 3)
 531 static inline int sysfs_emit(char *buf, const char *fmt, ...)
 532 {
 533         return 0;
 534 }
 535
 536 __printf(3, 4)
 537 static inline int sysfs_emit_at(char *buf, int at, const char *fmt, ...)
 538 {
 539         return 0;
 540 }
 541 #endif /* CONFIG_SYSFS */
 542
 543 static inline int __must_check sysfs_create_file(struct kobject *kobj,
 544                                                  const struct attribute *attr)
 545 {
 546         return sysfs_create_file_ns(kobj, attr, NULL);
 547 }
 548
 549 static inline void sysfs_remove_file(struct kobject *kobj,
 550                                      const struct attribute *attr)
 551 {
 552         sysfs_remove_file_ns(kobj, attr, NULL);
 553 }
 554
 555 static inline int sysfs_rename_link(struct kobject *kobj, struct kobject *target,
 556                                     const char *old_name, const char *new_name)
 557 {
 558         return sysfs_rename_link_ns(kobj, target, old_name, new_name, NULL);
 559 }
 560
 561 static inline void sysfs_notify_dirent(struct kernfs_node *kn)
 562 {
 563         kernfs_notify(kn);
 564 }
 565
 566 static inline struct kernfs_node *sysfs_get_dirent(struct kernfs_node *parent,
 567                                                    const char *name)
 568 {
 569         return kernfs_find_and_get(parent, name);
 570 }
 571
 572 static inline struct kernfs_node *sysfs_get(struct kernfs_node *kn)
 573 {
 574         kernfs_get(kn);
 575         return kn;
 576 }
 577
 578 static inline void sysfs_put(struct kernfs_node *kn)
 579 {
 580         kernfs_put(kn);
 581 }
 582
 583 #endif /* _SYSFS_H_ */