Pileus Git - ~andy/linux/blob - 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 = 0444 }, \
  80         .show   = _name##_show,                                 \
  81 }
  82
  83 #define __ATTR_RW(_name) __ATTR(_name, 0644, _name##_show, _name##_store)
  84
  85 #define __ATTR_NULL { .attr = { .name = NULL } }
  86
  87 #ifdef CONFIG_DEBUG_LOCK_ALLOC
  88 #define __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) {    \
  89         .attr = {.name = __stringify(_name), .mode = _mode,     \
  90                         .ignore_lockdep = true },               \
  91         .show           = _show,                                \
  92         .store          = _store,                               \
  93 }
  94 #else
  95 #define __ATTR_IGNORE_LOCKDEP   __ATTR
  96 #endif
  97
  98 #define __ATTRIBUTE_GROUPS(_name)                               \
  99 static const struct attribute_group *_name##_groups[] = {       \
 100         &_name##_group,                                         \
 101         NULL,                                                   \
 102 }
 103
 104 #define ATTRIBUTE_GROUPS(_name)                                 \
 105 static const struct attribute_group _name##_group = {           \
 106         .attrs = _name##_attrs,                                 \
 107 };                                                              \
 108 __ATTRIBUTE_GROUPS(_name)
 109
 110 #define attr_name(_attr) (_attr).attr.name
 111
 112 struct file;
 113 struct vm_area_struct;
 114
 115 struct bin_attribute {
 116         struct attribute        attr;
 117         size_t                  size;
 118         void                    *private;
 119         ssize_t (*read)(struct file *, struct kobject *, struct bin_attribute *,
 120                         char *, loff_t, size_t);
 121         ssize_t (*write)(struct file *,struct kobject *, struct bin_attribute *,
 122                          char *, loff_t, size_t);
 123         int (*mmap)(struct file *, struct kobject *, struct bin_attribute *attr,
 124                     struct vm_area_struct *vma);
 125 };
 126
 127 /**
 128  *      sysfs_bin_attr_init - initialize a dynamically allocated bin_attribute
 129  *      @attr: struct bin_attribute to initialize
 130  *
 131  *      Initialize a dynamically allocated struct bin_attribute so we
 132  *      can make lockdep happy.  This is a new requirement for
 133  *      attributes and initially this is only needed when lockdep is
 134  *      enabled.  Lockdep gives a nice error when your attribute is
 135  *      added to sysfs if you don't have this.
 136  */
 137 #define sysfs_bin_attr_init(bin_attr) sysfs_attr_init(&(bin_attr)->attr)
 138
 139 /* macros to create static binary attributes easier */
 140 #define __BIN_ATTR(_name, _mode, _read, _write, _size) {                \
 141         .attr = { .name = __stringify(_name), .mode = _mode },          \
 142         .read   = _read,                                                \
 143         .write  = _write,                                               \
 144         .size   = _size,                                                \
 145 }
 146
 147 #define __BIN_ATTR_RO(_name, _size) {                                   \
 148         .attr   = { .name = __stringify(_name), .mode = S_IRUGO },      \
 149         .read   = _name##_read,                                         \
 150         .size   = _size,                                                \
 151 }
 152
 153 #define __BIN_ATTR_RW(_name, _size) __BIN_ATTR(_name,                   \
 154                                    (S_IWUSR | S_IRUGO), _name##_read,   \
 155                                    _name##_write)
 156
 157 #define __BIN_ATTR_NULL __ATTR_NULL
 158
 159 #define BIN_ATTR(_name, _mode, _read, _write, _size)                    \
 160 struct bin_attribute bin_attr_##_name = __BIN_ATTR(_name, _mode, _read, \
 161                                         _write, _size)
 162
 163 #define BIN_ATTR_RO(_name, _size)                                       \
 164 struct bin_attribute bin_attr_##_name = __BIN_ATTR_RO(_name, _size)
 165
 166 #define BIN_ATTR_RW(_name, _size)                                       \
 167 struct bin_attribute bin_attr_##_name = __BIN_ATTR_RW(_name, _size)
 168
 169 struct sysfs_ops {
 170         ssize_t (*show)(struct kobject *, struct attribute *,char *);
 171         ssize_t (*store)(struct kobject *,struct attribute *,const char *, size_t);
 172         const void *(*namespace)(struct kobject *, const struct attribute *);
 173 };
 174
 175 struct sysfs_dirent;
 176
 177 #ifdef CONFIG_SYSFS
 178
 179 int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *),
 180                             void *data, struct module *owner);
 181
 182 int __must_check sysfs_create_dir(struct kobject *kobj);
 183 void sysfs_remove_dir(struct kobject *kobj);
 184 int __must_check sysfs_rename_dir(struct kobject *kobj, const char *new_name);
 185 int __must_check sysfs_move_dir(struct kobject *kobj,
 186                                 struct kobject *new_parent_kobj);
 187
 188 int __must_check sysfs_create_file(struct kobject *kobj,
 189                                    const struct attribute *attr);
 190 int __must_check sysfs_create_files(struct kobject *kobj,
 191                                    const struct attribute **attr);
 192 int __must_check sysfs_chmod_file(struct kobject *kobj,
 193                                   const struct attribute *attr, umode_t mode);
 194 void sysfs_remove_file(struct kobject *kobj, const struct attribute *attr);
 195 void sysfs_remove_files(struct kobject *kobj, const struct attribute **attr);
 196
 197 int __must_check sysfs_create_bin_file(struct kobject *kobj,
 198                                        const struct bin_attribute *attr);
 199 void sysfs_remove_bin_file(struct kobject *kobj,
 200                            const struct bin_attribute *attr);
 201
 202 int __must_check sysfs_create_link(struct kobject *kobj, struct kobject *target,
 203                                    const char *name);
 204 int __must_check sysfs_create_link_nowarn(struct kobject *kobj,
 205                                           struct kobject *target,
 206                                           const char *name);
 207 void sysfs_remove_link(struct kobject *kobj, const char *name);
 208
 209 int sysfs_rename_link(struct kobject *kobj, struct kobject *target,
 210                         const char *old_name, const char *new_name);
 211
 212 void sysfs_delete_link(struct kobject *dir, struct kobject *targ,
 213                         const char *name);
 214
 215 int __must_check sysfs_create_group(struct kobject *kobj,
 216                                     const struct attribute_group *grp);
 217 int sysfs_update_group(struct kobject *kobj,
 218                        const struct attribute_group *grp);
 219 void sysfs_remove_group(struct kobject *kobj,
 220                         const struct attribute_group *grp);
 221 int sysfs_add_file_to_group(struct kobject *kobj,
 222                         const struct attribute *attr, const char *group);
 223 void sysfs_remove_file_from_group(struct kobject *kobj,
 224                         const struct attribute *attr, const char *group);
 225 int sysfs_merge_group(struct kobject *kobj,
 226                        const struct attribute_group *grp);
 227 void sysfs_unmerge_group(struct kobject *kobj,
 228                        const struct attribute_group *grp);
 229 int sysfs_add_link_to_group(struct kobject *kobj, const char *group_name,
 230                             struct kobject *target, const char *link_name);
 231 void sysfs_remove_link_from_group(struct kobject *kobj, const char *group_name,
 232                                   const char *link_name);
 233
 234 void sysfs_notify(struct kobject *kobj, const char *dir, const char *attr);
 235 void sysfs_notify_dirent(struct sysfs_dirent *sd);
 236 struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
 237                                       const void *ns,
 238                                       const unsigned char *name);
 239 struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd);
 240 void sysfs_put(struct sysfs_dirent *sd);
 241
 242 int __must_check sysfs_init(void);
 243
 244 #else /* CONFIG_SYSFS */
 245
 246 static inline int sysfs_schedule_callback(struct kobject *kobj,
 247                 void (*func)(void *), void *data, struct module *owner)
 248 {
 249         return -ENOSYS;
 250 }
 251
 252 static inline int sysfs_create_dir(struct kobject *kobj)
 253 {
 254         return 0;
 255 }
 256
 257 static inline void sysfs_remove_dir(struct kobject *kobj)
 258 {
 259 }
 260
 261 static inline int sysfs_rename_dir(struct kobject *kobj, const char *new_name)
 262 {
 263         return 0;
 264 }
 265
 266 static inline int sysfs_move_dir(struct kobject *kobj,
 267                                  struct kobject *new_parent_kobj)
 268 {
 269         return 0;
 270 }
 271
 272 static inline int sysfs_create_file(struct kobject *kobj,
 273                                     const struct attribute *attr)
 274 {
 275         return 0;
 276 }
 277
 278 static inline int sysfs_create_files(struct kobject *kobj,
 279                                     const struct attribute **attr)
 280 {
 281         return 0;
 282 }
 283
 284 static inline int sysfs_chmod_file(struct kobject *kobj,
 285                                    const struct attribute *attr, umode_t mode)
 286 {
 287         return 0;
 288 }
 289
 290 static inline void sysfs_remove_file(struct kobject *kobj,
 291                                      const struct attribute *attr)
 292 {
 293 }
 294
 295 static inline void sysfs_remove_files(struct kobject *kobj,
 296                                      const struct attribute **attr)
 297 {
 298 }
 299
 300 static inline int sysfs_create_bin_file(struct kobject *kobj,
 301                                         const struct bin_attribute *attr)
 302 {
 303         return 0;
 304 }
 305
 306 static inline void sysfs_remove_bin_file(struct kobject *kobj,
 307                                          const struct bin_attribute *attr)
 308 {
 309 }
 310
 311 static inline int sysfs_create_link(struct kobject *kobj,
 312                                     struct kobject *target, const char *name)
 313 {
 314         return 0;
 315 }
 316
 317 static inline int sysfs_create_link_nowarn(struct kobject *kobj,
 318                                            struct kobject *target,
 319                                            const char *name)
 320 {
 321         return 0;
 322 }
 323
 324 static inline void sysfs_remove_link(struct kobject *kobj, const char *name)
 325 {
 326 }
 327
 328 static inline int sysfs_rename_link(struct kobject *k, struct kobject *t,
 329                                     const char *old_name, const char *new_name)
 330 {
 331         return 0;
 332 }
 333
 334 static inline void sysfs_delete_link(struct kobject *k, struct kobject *t,
 335                                      const char *name)
 336 {
 337 }
 338
 339 static inline int sysfs_create_group(struct kobject *kobj,
 340                                      const struct attribute_group *grp)
 341 {
 342         return 0;
 343 }
 344
 345 static inline int sysfs_update_group(struct kobject *kobj,
 346                                 const struct attribute_group *grp)
 347 {
 348         return 0;
 349 }
 350
 351 static inline void sysfs_remove_group(struct kobject *kobj,
 352                                       const struct attribute_group *grp)
 353 {
 354 }
 355
 356 static inline int sysfs_add_file_to_group(struct kobject *kobj,
 357                 const struct attribute *attr, const char *group)
 358 {
 359         return 0;
 360 }
 361
 362 static inline void sysfs_remove_file_from_group(struct kobject *kobj,
 363                 const struct attribute *attr, const char *group)
 364 {
 365 }
 366
 367 static inline int sysfs_merge_group(struct kobject *kobj,
 368                        const struct attribute_group *grp)
 369 {
 370         return 0;
 371 }
 372
 373 static inline void sysfs_unmerge_group(struct kobject *kobj,
 374                        const struct attribute_group *grp)
 375 {
 376 }
 377
 378 static inline int sysfs_add_link_to_group(struct kobject *kobj,
 379                 const char *group_name, struct kobject *target,
 380                 const char *link_name)
 381 {
 382         return 0;
 383 }
 384
 385 static inline void sysfs_remove_link_from_group(struct kobject *kobj,
 386                 const char *group_name, const char *link_name)
 387 {
 388 }
 389
 390 static inline void sysfs_notify(struct kobject *kobj, const char *dir,
 391                                 const char *attr)
 392 {
 393 }
 394 static inline void sysfs_notify_dirent(struct sysfs_dirent *sd)
 395 {
 396 }
 397 static inline
 398 struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
 399                                       const void *ns,
 400                                       const unsigned char *name)
 401 {
 402         return NULL;
 403 }
 404 static inline struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd)
 405 {
 406         return NULL;
 407 }
 408 static inline void sysfs_put(struct sysfs_dirent *sd)
 409 {
 410 }
 411
 412 static inline int __must_check sysfs_init(void)
 413 {
 414         return 0;
 415 }
 416
 417 #endif /* CONFIG_SYSFS */
 418
 419 #endif /* _SYSFS_H_ */