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 SYSFS_PREALLOC 010000
  74
  75 #define __ATTR(_name, _mode, _show, _store) {                           \
  76         .attr = {.name = __stringify(_name),                            \
  77                  .mode = VERIFY_OCTAL_PERMISSIONS(_mode) },             \
  78         .show   = _show,                                                \
  79         .store  = _store,                                               \
  80 }
  81
  82 #define __ATTR_PREALLOC(_name, _mode, _show, _store) {                  \
  83         .attr = {.name = __stringify(_name),                            \
  84                  .mode = SYSFS_PREALLOC | VERIFY_OCTAL_PERMISSIONS(_mode) },\
  85         .show   = _show,                                                \
  86         .store  = _store,                                               \
  87 }
  88
  89 #define __ATTR_RO(_name) {                                              \
  90         .attr   = { .name = __stringify(_name), .mode = S_IRUGO },      \
  91         .show   = _name##_show,                                         \
  92 }
  93
  94 #define __ATTR_WO(_name) {                                              \
  95         .attr   = { .name = __stringify(_name), .mode = S_IWUSR },      \
  96         .store  = _name##_store,                                        \
  97 }
  98
  99 #define __ATTR_RW(_name) __ATTR(_name, (S_IWUSR | S_IRUGO),             \
 100                          _name##_show, _name##_store)
 101
 102 #define __ATTR_NULL { .attr = { .name = NULL } }
 103
 104 #ifdef CONFIG_DEBUG_LOCK_ALLOC
 105 #define __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) {    \
 106         .attr = {.name = __stringify(_name), .mode = _mode,     \
 107                         .ignore_lockdep = true },               \
 108         .show           = _show,                                \
 109         .store          = _store,                               \
 110 }
 111 #else
 112 #define __ATTR_IGNORE_LOCKDEP   __ATTR
 113 #endif
 114
 115 #define __ATTRIBUTE_GROUPS(_name)                               \
 116 static const struct attribute_group *_name##_groups[] = {       \
 117         &_name##_group,                                         \
 118         NULL,                                                   \
 119 }
 120
 121 #define ATTRIBUTE_GROUPS(_name)                                 \
 122 static const struct attribute_group _name##_group = {           \
 123         .attrs = _name##_attrs,                                 \
 124 };                                                              \
 125 __ATTRIBUTE_GROUPS(_name)
 126
 127 struct file;
 128 struct vm_area_struct;
 129
 130 struct bin_attribute {
 131         struct attribute        attr;
 132         size_t                  size;
 133         void                    *private;
 134         ssize_t (*read)(struct file *, struct kobject *, struct bin_attribute *,
 135                         char *, loff_t, size_t);
 136         ssize_t (*write)(struct file *, struct kobject *, struct bin_attribute *,
 137                          char *, loff_t, size_t);
 138         int (*mmap)(struct file *, struct kobject *, struct bin_attribute *attr,
 139                     struct vm_area_struct *vma);
 140 };
 141
 142 /**
 143  *      sysfs_bin_attr_init - initialize a dynamically allocated bin_attribute
 144  *      @attr: struct bin_attribute to initialize
 145  *
 146  *      Initialize a dynamically allocated struct bin_attribute so we
 147  *      can make lockdep happy.  This is a new requirement for
 148  *      attributes and initially this is only needed when lockdep is
 149  *      enabled.  Lockdep gives a nice error when your attribute is
 150  *      added to sysfs if you don't have this.
 151  */
 152 #define sysfs_bin_attr_init(bin_attr) sysfs_attr_init(&(bin_attr)->attr)
 153
 154 /* macros to create static binary attributes easier */
 155 #define __BIN_ATTR(_name, _mode, _read, _write, _size) {                \
 156         .attr = { .name = __stringify(_name), .mode = _mode },          \
 157         .read   = _read,                                                \
 158         .write  = _write,                                               \
 159         .size   = _size,                                                \
 160 }
 161
 162 #define __BIN_ATTR_RO(_name, _size) {                                   \
 163         .attr   = { .name = __stringify(_name), .mode = S_IRUGO },      \
 164         .read   = _name##_read,                                         \
 165         .size   = _size,                                                \
 166 }
 167
 168 #define __BIN_ATTR_RW(_name, _size) __BIN_ATTR(_name,                   \
 169                                    (S_IWUSR | S_IRUGO), _name##_read,   \
 170                                    _name##_write, _size)
 171
 172 #define __BIN_ATTR_NULL __ATTR_NULL
 173
 174 #define BIN_ATTR(_name, _mode, _read, _write, _size)                    \
 175 struct bin_attribute bin_attr_##_name = __BIN_ATTR(_name, _mode, _read, \
 176                                         _write, _size)
 177
 178 #define BIN_ATTR_RO(_name, _size)                                       \
 179 struct bin_attribute bin_attr_##_name = __BIN_ATTR_RO(_name, _size)
 180
 181 #define BIN_ATTR_RW(_name, _size)                                       \
 182 struct bin_attribute bin_attr_##_name = __BIN_ATTR_RW(_name, _size)
 183
 184 struct sysfs_ops {
 185         ssize_t (*show)(struct kobject *, struct attribute *, char *);
 186         ssize_t (*store)(struct kobject *, struct attribute *, const char *, size_t);
 187 };
 188
 189 #ifdef CONFIG_SYSFS
 190
 191 int __must_check sysfs_create_dir_ns(struct kobject *kobj, const void *ns);
 192 void sysfs_remove_dir(struct kobject *kobj);
 193 int __must_check sysfs_rename_dir_ns(struct kobject *kobj, const char *new_name,
 194                                      const void *new_ns);
 195 int __must_check sysfs_move_dir_ns(struct kobject *kobj,
 196                                    struct kobject *new_parent_kobj,
 197                                    const void *new_ns);
 198
 199 int __must_check sysfs_create_file_ns(struct kobject *kobj,
 200                                       const struct attribute *attr,
 201                                       const void *ns);
 202 int __must_check sysfs_create_files(struct kobject *kobj,
 203                                    const struct attribute **attr);
 204 int __must_check sysfs_chmod_file(struct kobject *kobj,
 205                                   const struct attribute *attr, umode_t mode);
 206 void sysfs_remove_file_ns(struct kobject *kobj, const struct attribute *attr,
 207                           const void *ns);
 208 bool sysfs_remove_file_self(struct kobject *kobj, const struct attribute *attr);
 209 void sysfs_remove_files(struct kobject *kobj, const struct attribute **attr);
 210
 211 int __must_check sysfs_create_bin_file(struct kobject *kobj,
 212                                        const struct bin_attribute *attr);
 213 void sysfs_remove_bin_file(struct kobject *kobj,
 214                            const struct bin_attribute *attr);
 215
 216 int __must_check sysfs_create_link(struct kobject *kobj, struct kobject *target,
 217                                    const char *name);
 218 int __must_check sysfs_create_link_nowarn(struct kobject *kobj,
 219                                           struct kobject *target,
 220                                           const char *name);
 221 void sysfs_remove_link(struct kobject *kobj, const char *name);
 222
 223 int sysfs_rename_link_ns(struct kobject *kobj, struct kobject *target,
 224                          const char *old_name, const char *new_name,
 225                          const void *new_ns);
 226
 227 void sysfs_delete_link(struct kobject *dir, struct kobject *targ,
 228                         const char *name);
 229
 230 int __must_check sysfs_create_group(struct kobject *kobj,
 231                                     const struct attribute_group *grp);
 232 int __must_check sysfs_create_groups(struct kobject *kobj,
 233                                      const struct attribute_group **groups);
 234 int sysfs_update_group(struct kobject *kobj,
 235                        const struct attribute_group *grp);
 236 void sysfs_remove_group(struct kobject *kobj,
 237                         const struct attribute_group *grp);
 238 void sysfs_remove_groups(struct kobject *kobj,
 239                          const struct attribute_group **groups);
 240 int sysfs_add_file_to_group(struct kobject *kobj,
 241                         const struct attribute *attr, const char *group);
 242 void sysfs_remove_file_from_group(struct kobject *kobj,
 243                         const struct attribute *attr, const char *group);
 244 int sysfs_merge_group(struct kobject *kobj,
 245                        const struct attribute_group *grp);
 246 void sysfs_unmerge_group(struct kobject *kobj,
 247                        const struct attribute_group *grp);
 248 int sysfs_add_link_to_group(struct kobject *kobj, const char *group_name,
 249                             struct kobject *target, const char *link_name);
 250 void sysfs_remove_link_from_group(struct kobject *kobj, const char *group_name,
 251                                   const char *link_name);
 252
 253 void sysfs_notify(struct kobject *kobj, const char *dir, const char *attr);
 254
 255 int __must_check sysfs_init(void);
 256
 257 static inline void sysfs_enable_ns(struct kernfs_node *kn)
 258 {
 259         return kernfs_enable_ns(kn);
 260 }
 261
 262 #else /* CONFIG_SYSFS */
 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         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_ */