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 void sysfs_remove_files(struct kobject *kobj, const struct attribute **attr);
 203
 204 int __must_check sysfs_create_bin_file(struct kobject *kobj,
 205                                        const struct bin_attribute *attr);
 206 void sysfs_remove_bin_file(struct kobject *kobj,
 207                            const struct bin_attribute *attr);
 208
 209 int __must_check sysfs_create_link(struct kobject *kobj, struct kobject *target,
 210                                    const char *name);
 211 int __must_check sysfs_create_link_nowarn(struct kobject *kobj,
 212                                           struct kobject *target,
 213                                           const char *name);
 214 void sysfs_remove_link(struct kobject *kobj, const char *name);
 215
 216 int sysfs_rename_link_ns(struct kobject *kobj, struct kobject *target,
 217                          const char *old_name, const char *new_name,
 218                          const void *new_ns);
 219
 220 void sysfs_delete_link(struct kobject *dir, struct kobject *targ,
 221                         const char *name);
 222
 223 int __must_check sysfs_create_group(struct kobject *kobj,
 224                                     const struct attribute_group *grp);
 225 int __must_check sysfs_create_groups(struct kobject *kobj,
 226                                      const struct attribute_group **groups);
 227 int sysfs_update_group(struct kobject *kobj,
 228                        const struct attribute_group *grp);
 229 void sysfs_remove_group(struct kobject *kobj,
 230                         const struct attribute_group *grp);
 231 void sysfs_remove_groups(struct kobject *kobj,
 232                          const struct attribute_group **groups);
 233 int sysfs_add_file_to_group(struct kobject *kobj,
 234                         const struct attribute *attr, const char *group);
 235 void sysfs_remove_file_from_group(struct kobject *kobj,
 236                         const struct attribute *attr, const char *group);
 237 int sysfs_merge_group(struct kobject *kobj,
 238                        const struct attribute_group *grp);
 239 void sysfs_unmerge_group(struct kobject *kobj,
 240                        const struct attribute_group *grp);
 241 int sysfs_add_link_to_group(struct kobject *kobj, const char *group_name,
 242                             struct kobject *target, const char *link_name);
 243 void sysfs_remove_link_from_group(struct kobject *kobj, const char *group_name,
 244                                   const char *link_name);
 245
 246 void sysfs_notify(struct kobject *kobj, const char *dir, const char *attr);
 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_ns(struct kobject *kobj, const void *ns)
 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_ns(struct kobject *kobj,
 268                                       const char *new_name, const void *new_ns)
 269 {
 270         return 0;
 271 }
 272
 273 static inline int sysfs_move_dir_ns(struct kobject *kobj,
 274                                     struct kobject *new_parent_kobj,
 275                                     const void *new_ns)
 276 {
 277         return 0;
 278 }
 279
 280 static inline int sysfs_create_file_ns(struct kobject *kobj,
 281                                        const struct attribute *attr,
 282                                        const void *ns)
 283 {
 284         return 0;
 285 }
 286
 287 static inline int sysfs_create_files(struct kobject *kobj,
 288                                     const struct attribute **attr)
 289 {
 290         return 0;
 291 }
 292
 293 static inline int sysfs_chmod_file(struct kobject *kobj,
 294                                    const struct attribute *attr, umode_t mode)
 295 {
 296         return 0;
 297 }
 298
 299 static inline void sysfs_remove_file_ns(struct kobject *kobj,
 300                                         const struct attribute *attr,
 301                                         const void *ns)
 302 {
 303 }
 304
 305 static inline void sysfs_remove_files(struct kobject *kobj,
 306                                      const struct attribute **attr)
 307 {
 308 }
 309
 310 static inline int sysfs_create_bin_file(struct kobject *kobj,
 311                                         const struct bin_attribute *attr)
 312 {
 313         return 0;
 314 }
 315
 316 static inline void sysfs_remove_bin_file(struct kobject *kobj,
 317                                          const struct bin_attribute *attr)
 318 {
 319 }
 320
 321 static inline int sysfs_create_link(struct kobject *kobj,
 322                                     struct kobject *target, const char *name)
 323 {
 324         return 0;
 325 }
 326
 327 static inline int sysfs_create_link_nowarn(struct kobject *kobj,
 328                                            struct kobject *target,
 329                                            const char *name)
 330 {
 331         return 0;
 332 }
 333
 334 static inline void sysfs_remove_link(struct kobject *kobj, const char *name)
 335 {
 336 }
 337
 338 static inline int sysfs_rename_link_ns(struct kobject *k, struct kobject *t,
 339                                        const char *old_name,
 340                                        const char *new_name, const void *ns)
 341 {
 342         return 0;
 343 }
 344
 345 static inline void sysfs_delete_link(struct kobject *k, struct kobject *t,
 346                                      const char *name)
 347 {
 348 }
 349
 350 static inline int sysfs_create_group(struct kobject *kobj,
 351                                      const struct attribute_group *grp)
 352 {
 353         return 0;
 354 }
 355
 356 static inline int sysfs_create_groups(struct kobject *kobj,
 357                                       const struct attribute_group **groups)
 358 {
 359         return 0;
 360 }
 361
 362 static inline int sysfs_update_group(struct kobject *kobj,
 363                                 const struct attribute_group *grp)
 364 {
 365         return 0;
 366 }
 367
 368 static inline void sysfs_remove_group(struct kobject *kobj,
 369                                       const struct attribute_group *grp)
 370 {
 371 }
 372
 373 static inline void sysfs_remove_groups(struct kobject *kobj,
 374                                        const struct attribute_group **groups)
 375 {
 376 }
 377
 378 static inline int sysfs_add_file_to_group(struct kobject *kobj,
 379                 const struct attribute *attr, const char *group)
 380 {
 381         return 0;
 382 }
 383
 384 static inline void sysfs_remove_file_from_group(struct kobject *kobj,
 385                 const struct attribute *attr, const char *group)
 386 {
 387 }
 388
 389 static inline int sysfs_merge_group(struct kobject *kobj,
 390                        const struct attribute_group *grp)
 391 {
 392         return 0;
 393 }
 394
 395 static inline void sysfs_unmerge_group(struct kobject *kobj,
 396                        const struct attribute_group *grp)
 397 {
 398 }
 399
 400 static inline int sysfs_add_link_to_group(struct kobject *kobj,
 401                 const char *group_name, struct kobject *target,
 402                 const char *link_name)
 403 {
 404         return 0;
 405 }
 406
 407 static inline void sysfs_remove_link_from_group(struct kobject *kobj,
 408                 const char *group_name, const char *link_name)
 409 {
 410 }
 411
 412 static inline void sysfs_notify(struct kobject *kobj, const char *dir,
 413                                 const char *attr)
 414 {
 415 }
 416
 417 static inline int __must_check sysfs_init(void)
 418 {
 419         return 0;
 420 }
 421
 422 #endif /* CONFIG_SYSFS */
 423
 424 static inline int __must_check sysfs_create_file(struct kobject *kobj,
 425                                                  const struct attribute *attr)
 426 {
 427         return sysfs_create_file_ns(kobj, attr, NULL);
 428 }
 429
 430 static inline void sysfs_remove_file(struct kobject *kobj,
 431                                      const struct attribute *attr)
 432 {
 433         return sysfs_remove_file_ns(kobj, attr, NULL);
 434 }
 435
 436 static inline int sysfs_rename_link(struct kobject *kobj, struct kobject *target,
 437                                     const char *old_name, const char *new_name)
 438 {
 439         return sysfs_rename_link_ns(kobj, target, old_name, new_name, NULL);
 440 }
 441
 442 static inline void sysfs_notify_dirent(struct kernfs_node *kn)
 443 {
 444         kernfs_notify(kn);
 445 }
 446
 447 static inline struct kernfs_node *sysfs_get_dirent(struct kernfs_node *parent,
 448                                                    const unsigned char *name)
 449 {
 450         return kernfs_find_and_get(parent, name);
 451 }
 452
 453 static inline struct kernfs_node *sysfs_get(struct kernfs_node *kn)
 454 {
 455         kernfs_get(kn);
 456         return kn;
 457 }
 458
 459 static inline void sysfs_put(struct kernfs_node *kn)
 460 {
 461         kernfs_put(kn);
 462 }
 463
 464 #endif /* _SYSFS_H_ */