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/compiler.h>
  16 #include <linux/errno.h>
  17 #include <linux/list.h>
  18 #include <linux/lockdep.h>
  19 #include <linux/kobject_ns.h>
  20 #include <linux/stat.h>
  21 #include <linux/atomic.h>
  22
  23 struct kobject;
  24 struct module;
  25 struct bin_attribute;
  26 enum kobj_ns_type;
  27
  28 struct attribute {
  29         const char              *name;
  30         umode_t                 mode;
  31 #ifdef CONFIG_DEBUG_LOCK_ALLOC
  32         bool                    ignore_lockdep:1;
  33         struct lock_class_key   *key;
  34         struct lock_class_key   skey;
  35 #endif
  36 };
  37
  38 /**
  39  *      sysfs_attr_init - initialize a dynamically allocated sysfs attribute
  40  *      @attr: struct attribute to initialize
  41  *
  42  *      Initialize a dynamically allocated struct attribute so we can
  43  *      make lockdep happy.  This is a new requirement for attributes
  44  *      and initially this is only needed when lockdep is enabled.
  45  *      Lockdep gives a nice error when your attribute is added to
  46  *      sysfs if you don't have this.
  47  */
  48 #ifdef CONFIG_DEBUG_LOCK_ALLOC
  49 #define sysfs_attr_init(attr)                           \
  50 do {                                                    \
  51         static struct lock_class_key __key;             \
  52                                                         \
  53         (attr)->key = &__key;                           \
  54 } while (0)
  55 #else
  56 #define sysfs_attr_init(attr) do {} while (0)
  57 #endif
  58
  59 struct attribute_group {
  60         const char              *name;
  61         umode_t                 (*is_visible)(struct kobject *,
  62                                               struct attribute *, int);
  63         struct attribute        **attrs;
  64         struct bin_attribute    **bin_attrs;
  65 };
  66
  67 /**
  68  * Use these macros to make defining attributes easier. See include/linux/device.h
  69  * for examples..
  70  */
  71
  72 #define __ATTR(_name, _mode, _show, _store) {                           \
  73         .attr = {.name = __stringify(_name), .mode = _mode },           \
  74         .show   = _show,                                                \
  75         .store  = _store,                                               \
  76 }
  77
  78 #define __ATTR_RO(_name) {                                              \
  79         .attr   = { .name = __stringify(_name), .mode = S_IRUGO },      \
  80         .show   = _name##_show,                                         \
  81 }
  82
  83 #define __ATTR_WO(_name) {                                              \
  84         .attr   = { .name = __stringify(_name), .mode = S_IWUSR },      \
  85         .store  = _name##_store,                                        \
  86 }
  87
  88 #define __ATTR_RW(_name) __ATTR(_name, (S_IWUSR | S_IRUGO),             \
  89                          _name##_show, _name##_store)
  90
  91 #define __ATTR_NULL { .attr = { .name = NULL } }
  92
  93 #ifdef CONFIG_DEBUG_LOCK_ALLOC
  94 #define __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) {    \
  95         .attr = {.name = __stringify(_name), .mode = _mode,     \
  96                         .ignore_lockdep = true },               \
  97         .show           = _show,                                \
  98         .store          = _store,                               \
  99 }
 100 #else
 101 #define __ATTR_IGNORE_LOCKDEP   __ATTR
 102 #endif
 103
 104 #define __ATTRIBUTE_GROUPS(_name)                               \
 105 static const struct attribute_group *_name##_groups[] = {       \
 106         &_name##_group,                                         \
 107         NULL,                                                   \
 108 }
 109
 110 #define ATTRIBUTE_GROUPS(_name)                                 \
 111 static const struct attribute_group _name##_group = {           \
 112         .attrs = _name##_attrs,                                 \
 113 };                                                              \
 114 __ATTRIBUTE_GROUPS(_name)
 115
 116 struct file;
 117 struct vm_area_struct;
 118
 119 struct bin_attribute {
 120         struct attribute        attr;
 121         size_t                  size;
 122         void                    *private;
 123         ssize_t (*read)(struct file *, struct kobject *, struct bin_attribute *,
 124                         char *, loff_t, size_t);
 125         ssize_t (*write)(struct file *, struct kobject *, struct bin_attribute *,
 126                          char *, loff_t, size_t);
 127         int (*mmap)(struct file *, struct kobject *, struct bin_attribute *attr,
 128                     struct vm_area_struct *vma);
 129 };
 130
 131 /**
 132  *      sysfs_bin_attr_init - initialize a dynamically allocated bin_attribute
 133  *      @attr: struct bin_attribute to initialize
 134  *
 135  *      Initialize a dynamically allocated struct bin_attribute so we
 136  *      can make lockdep happy.  This is a new requirement for
 137  *      attributes and initially this is only needed when lockdep is
 138  *      enabled.  Lockdep gives a nice error when your attribute is
 139  *      added to sysfs if you don't have this.
 140  */
 141 #define sysfs_bin_attr_init(bin_attr) sysfs_attr_init(&(bin_attr)->attr)
 142
 143 /* macros to create static binary attributes easier */
 144 #define __BIN_ATTR(_name, _mode, _read, _write, _size) {                \
 145         .attr = { .name = __stringify(_name), .mode = _mode },          \
 146         .read   = _read,                                                \
 147         .write  = _write,                                               \
 148         .size   = _size,                                                \
 149 }
 150
 151 #define __BIN_ATTR_RO(_name, _size) {                                   \
 152         .attr   = { .name = __stringify(_name), .mode = S_IRUGO },      \
 153         .read   = _name##_read,                                         \
 154         .size   = _size,                                                \
 155 }
 156
 157 #define __BIN_ATTR_RW(_name, _size) __BIN_ATTR(_name,                   \
 158                                    (S_IWUSR | S_IRUGO), _name##_read,   \
 159                                    _name##_write, _size)
 160
 161 #define __BIN_ATTR_NULL __ATTR_NULL
 162
 163 #define BIN_ATTR(_name, _mode, _read, _write, _size)                    \
 164 struct bin_attribute bin_attr_##_name = __BIN_ATTR(_name, _mode, _read, \
 165                                         _write, _size)
 166
 167 #define BIN_ATTR_RO(_name, _size)                                       \
 168 struct bin_attribute bin_attr_##_name = __BIN_ATTR_RO(_name, _size)
 169
 170 #define BIN_ATTR_RW(_name, _size)                                       \
 171 struct bin_attribute bin_attr_##_name = __BIN_ATTR_RW(_name, _size)
 172
 173 struct sysfs_ops {
 174         ssize_t (*show)(struct kobject *, struct attribute *, char *);
 175         ssize_t (*store)(struct kobject *, struct attribute *, const char *, size_t);
 176 };
 177
 178 struct sysfs_dirent;
 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(struct kobject *kobj, struct kobject *target,
 217                         const char *old_name, const char *new_name);
 218
 219 void sysfs_delete_link(struct kobject *dir, struct kobject *targ,
 220                         const char *name);
 221
 222 int __must_check sysfs_create_group(struct kobject *kobj,
 223                                     const struct attribute_group *grp);
 224 int __must_check sysfs_create_groups(struct kobject *kobj,
 225                                      const struct attribute_group **groups);
 226 int sysfs_update_group(struct kobject *kobj,
 227                        const struct attribute_group *grp);
 228 void sysfs_remove_group(struct kobject *kobj,
 229                         const struct attribute_group *grp);
 230 void sysfs_remove_groups(struct kobject *kobj,
 231                          const struct attribute_group **groups);
 232 int sysfs_add_file_to_group(struct kobject *kobj,
 233                         const struct attribute *attr, const char *group);
 234 void sysfs_remove_file_from_group(struct kobject *kobj,
 235                         const struct attribute *attr, const char *group);
 236 int sysfs_merge_group(struct kobject *kobj,
 237                        const struct attribute_group *grp);
 238 void sysfs_unmerge_group(struct kobject *kobj,
 239                        const struct attribute_group *grp);
 240 int sysfs_add_link_to_group(struct kobject *kobj, const char *group_name,
 241                             struct kobject *target, const char *link_name);
 242 void sysfs_remove_link_from_group(struct kobject *kobj, const char *group_name,
 243                                   const char *link_name);
 244
 245 void sysfs_notify(struct kobject *kobj, const char *dir, const char *attr);
 246 void sysfs_notify_dirent(struct sysfs_dirent *sd);
 247 struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
 248                                       const void *ns,
 249                                       const unsigned char *name);
 250 struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd);
 251 void sysfs_put(struct sysfs_dirent *sd);
 252
 253 int __must_check sysfs_init(void);
 254
 255 #else /* CONFIG_SYSFS */
 256
 257 static inline int sysfs_schedule_callback(struct kobject *kobj,
 258                 void (*func)(void *), void *data, struct module *owner)
 259 {
 260         return -ENOSYS;
 261 }
 262
 263 static inline int sysfs_create_dir_ns(struct kobject *kobj, const void *ns)
 264 {
 265         return 0;
 266 }
 267
 268 static inline void sysfs_remove_dir(struct kobject *kobj)
 269 {
 270 }
 271
 272 static inline int sysfs_rename_dir_ns(struct kobject *kobj,
 273                                       const char *new_name, const void *new_ns)
 274 {
 275         return 0;
 276 }
 277
 278 static inline int sysfs_move_dir_ns(struct kobject *kobj,
 279                                     struct kobject *new_parent_kobj,
 280                                     const void *new_ns)
 281 {
 282         return 0;
 283 }
 284
 285 static inline int sysfs_create_file_ns(struct kobject *kobj,
 286                                        const struct attribute *attr,
 287                                        const void *ns)
 288 {
 289         return 0;
 290 }
 291
 292 static inline int sysfs_create_files(struct kobject *kobj,
 293                                     const struct attribute **attr)
 294 {
 295         return 0;
 296 }
 297
 298 static inline int sysfs_chmod_file(struct kobject *kobj,
 299                                    const struct attribute *attr, umode_t mode)
 300 {
 301         return 0;
 302 }
 303
 304 static inline void sysfs_remove_file_ns(struct kobject *kobj,
 305                                         const struct attribute *attr,
 306                                         const void *ns)
 307 {
 308 }
 309
 310 static inline void sysfs_remove_files(struct kobject *kobj,
 311                                      const struct attribute **attr)
 312 {
 313 }
 314
 315 static inline int sysfs_create_bin_file(struct kobject *kobj,
 316                                         const struct bin_attribute *attr)
 317 {
 318         return 0;
 319 }
 320
 321 static inline void sysfs_remove_bin_file(struct kobject *kobj,
 322                                          const struct bin_attribute *attr)
 323 {
 324 }
 325
 326 static inline int sysfs_create_link(struct kobject *kobj,
 327                                     struct kobject *target, const char *name)
 328 {
 329         return 0;
 330 }
 331
 332 static inline int sysfs_create_link_nowarn(struct kobject *kobj,
 333                                            struct kobject *target,
 334                                            const char *name)
 335 {
 336         return 0;
 337 }
 338
 339 static inline void sysfs_remove_link(struct kobject *kobj, const char *name)
 340 {
 341 }
 342
 343 static inline int sysfs_rename_link(struct kobject *k, struct kobject *t,
 344                                     const char *old_name, const char *new_name)
 345 {
 346         return 0;
 347 }
 348
 349 static inline void sysfs_delete_link(struct kobject *k, struct kobject *t,
 350                                      const char *name)
 351 {
 352 }
 353
 354 static inline int sysfs_create_group(struct kobject *kobj,
 355                                      const struct attribute_group *grp)
 356 {
 357         return 0;
 358 }
 359
 360 static inline int sysfs_create_groups(struct kobject *kobj,
 361                                       const struct attribute_group **groups)
 362 {
 363         return 0;
 364 }
 365
 366 static inline int sysfs_update_group(struct kobject *kobj,
 367                                 const struct attribute_group *grp)
 368 {
 369         return 0;
 370 }
 371
 372 static inline void sysfs_remove_group(struct kobject *kobj,
 373                                       const struct attribute_group *grp)
 374 {
 375 }
 376
 377 static inline void sysfs_remove_groups(struct kobject *kobj,
 378                                        const struct attribute_group **groups)
 379 {
 380 }
 381
 382 static inline int sysfs_add_file_to_group(struct kobject *kobj,
 383                 const struct attribute *attr, const char *group)
 384 {
 385         return 0;
 386 }
 387
 388 static inline void sysfs_remove_file_from_group(struct kobject *kobj,
 389                 const struct attribute *attr, const char *group)
 390 {
 391 }
 392
 393 static inline int sysfs_merge_group(struct kobject *kobj,
 394                        const struct attribute_group *grp)
 395 {
 396         return 0;
 397 }
 398
 399 static inline void sysfs_unmerge_group(struct kobject *kobj,
 400                        const struct attribute_group *grp)
 401 {
 402 }
 403
 404 static inline int sysfs_add_link_to_group(struct kobject *kobj,
 405                 const char *group_name, struct kobject *target,
 406                 const char *link_name)
 407 {
 408         return 0;
 409 }
 410
 411 static inline void sysfs_remove_link_from_group(struct kobject *kobj,
 412                 const char *group_name, const char *link_name)
 413 {
 414 }
 415
 416 static inline void sysfs_notify(struct kobject *kobj, const char *dir,
 417                                 const char *attr)
 418 {
 419 }
 420 static inline void sysfs_notify_dirent(struct sysfs_dirent *sd)
 421 {
 422 }
 423 static inline
 424 struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
 425                                       const void *ns,
 426                                       const unsigned char *name)
 427 {
 428         return NULL;
 429 }
 430 static inline struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd)
 431 {
 432         return NULL;
 433 }
 434 static inline void sysfs_put(struct sysfs_dirent *sd)
 435 {
 436 }
 437
 438 static inline int __must_check sysfs_init(void)
 439 {
 440         return 0;
 441 }
 442
 443 #endif /* CONFIG_SYSFS */
 444
 445 static inline int __must_check sysfs_create_file(struct kobject *kobj,
 446                                                  const struct attribute *attr)
 447 {
 448         return sysfs_create_file_ns(kobj, attr, NULL);
 449 }
 450
 451 static inline void sysfs_remove_file(struct kobject *kobj,
 452                                      const struct attribute *attr)
 453 {
 454         return sysfs_remove_file_ns(kobj, attr, NULL);
 455 }
 456
 457 #endif /* _SYSFS_H_ */