sysfs: Document sysfs_attr_init and sysfs_bin_attr_init
[safe/jmp/linux-2.6] / include / linux / sysfs.h
index d9cd2d3..5b8f80f 100644 (file)
@@ -3,6 +3,8 @@
  *
  * Copyright (c) 2001,2002 Patrick Mochel
  * Copyright (c) 2004 Silicon Graphics, Inc.
+ * Copyright (c) 2007 SUSE Linux Products GmbH
+ * Copyright (c) 2007 Tejun Heo <teheo@suse.de>
  *
  * Please see Documentation/filesystems/sysfs.txt for more information.
  */
 #ifndef _SYSFS_H_
 #define _SYSFS_H_
 
+#include <linux/compiler.h>
+#include <linux/errno.h>
+#include <linux/list.h>
+#include <linux/lockdep.h>
 #include <asm/atomic.h>
 
 struct kobject;
 struct module;
 
+/* FIXME
+ * The *owner field is no longer used.
+ * x86 tree has been cleaned up. The owner
+ * attribute is still left for other arches.
+ */
 struct attribute {
-       const char              * name;
-       struct module           * owner;
+       const char              *name;
+       struct module           *owner;
        mode_t                  mode;
+#ifdef CONFIG_DEBUG_LOCK_ALLOC
+       struct lock_class_key   *key;
+       struct lock_class_key   skey;
+#endif
 };
 
+/**
+ *     sysfs_attr_init - initialize a dynamically allocated sysfs attribute
+ *     @attr: struct attribute to initialize
+ *
+ *     Initialize a dynamically allocated struct attribute so we can
+ *     make lockdep happy.  This is a new requirement for attributes
+ *     and initially this is only needed when lockdep is enabled.
+ *     Lockdep gives a nice error when your attribute is added to
+ *     sysfs if you don't have this.
+ */
+#ifdef CONFIG_DEBUG_LOCK_ALLOC
+#define sysfs_attr_init(attr)                          \
+do {                                                   \
+       static struct lock_class_key __key;             \
+                                                       \
+       (attr)->key = &__key;                           \
+} while(0)
+#else
+#define sysfs_attr_init(attr) do {} while(0)
+#endif
+
 struct attribute_group {
-       const char              * name;
-       struct attribute        ** attrs;
+       const char              *name;
+       mode_t                  (*is_visible)(struct kobject *,
+                                             struct attribute *, int);
+       struct attribute        **attrs;
 };
 
 
@@ -34,14 +72,14 @@ struct attribute_group {
  */
 
 #define __ATTR(_name,_mode,_show,_store) { \
-       .attr = {.name = __stringify(_name), .mode = _mode, .owner = THIS_MODULE },     \
+       .attr = {.name = __stringify(_name), .mode = _mode },   \
        .show   = _show,                                        \
        .store  = _store,                                       \
 }
 
 #define __ATTR_RO(_name) { \
-       .attr   = { .name = __stringify(_name), .mode = 0444, .owner = THIS_MODULE },   \
-       .show   = _name##_show, \
+       .attr   = { .name = __stringify(_name), .mode = 0444 }, \
+       .show   = _name##_show,                                 \
 }
 
 #define __ATTR_NULL { .attr = { .name = NULL } }
@@ -54,134 +92,225 @@ struct bin_attribute {
        struct attribute        attr;
        size_t                  size;
        void                    *private;
-       ssize_t (*read)(struct kobject *, char *, loff_t, size_t);
-       ssize_t (*write)(struct kobject *, char *, loff_t, size_t);
+       ssize_t (*read)(struct kobject *, struct bin_attribute *,
+                       char *, loff_t, size_t);
+       ssize_t (*write)(struct kobject *, struct bin_attribute *,
+                        char *, loff_t, size_t);
        int (*mmap)(struct kobject *, struct bin_attribute *attr,
                    struct vm_area_struct *vma);
 };
 
+/**
+ *     sysfs_bin_attr_init - initialize a dynamically allocated bin_attribute
+ *     @attr: struct bin_attribute to initialize
+ *
+ *     Initialize a dynamically allocated struct bin_attribute so we
+ *     can make lockdep happy.  This is a new requirement for
+ *     attributes and initially this is only needed when lockdep is
+ *     enabled.  Lockdep gives a nice error when your attribute is
+ *     added to sysfs if you don't have this.
+ */
+#define sysfs_bin_attr_init(bin_attr) sysfs_attr_init(&bin_attr->attr)
+
 struct sysfs_ops {
        ssize_t (*show)(struct kobject *, struct attribute *,char *);
        ssize_t (*store)(struct kobject *,struct attribute *,const char *, size_t);
 };
 
-struct sysfs_dirent {
-       atomic_t                s_count;
-       struct list_head        s_sibling;
-       struct list_head        s_children;
-       void                    * s_element;
-       int                     s_type;
-       umode_t                 s_mode;
-       struct dentry           * s_dentry;
-};
-
-#define SYSFS_ROOT             0x0001
-#define SYSFS_DIR              0x0002
-#define SYSFS_KOBJ_ATTR        0x0004
-#define SYSFS_KOBJ_BIN_ATTR    0x0008
-#define SYSFS_KOBJ_LINK        0x0020
-#define SYSFS_NOT_PINNED       (SYSFS_KOBJ_ATTR | SYSFS_KOBJ_BIN_ATTR | SYSFS_KOBJ_LINK)
+struct sysfs_dirent;
 
 #ifdef CONFIG_SYSFS
 
-extern int
-sysfs_create_dir(struct kobject *);
+int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *),
+                           void *data, struct module *owner);
+
+int __must_check sysfs_create_dir(struct kobject *kobj);
+void sysfs_remove_dir(struct kobject *kobj);
+int __must_check sysfs_rename_dir(struct kobject *kobj, const char *new_name);
+int __must_check sysfs_move_dir(struct kobject *kobj,
+                               struct kobject *new_parent_kobj);
+
+int __must_check sysfs_create_file(struct kobject *kobj,
+                                  const struct attribute *attr);
+int __must_check sysfs_create_files(struct kobject *kobj,
+                                  const struct attribute **attr);
+int __must_check sysfs_chmod_file(struct kobject *kobj, struct attribute *attr,
+                                 mode_t mode);
+void sysfs_remove_file(struct kobject *kobj, const struct attribute *attr);
+void sysfs_remove_files(struct kobject *kobj, const struct attribute **attr);
+
+int __must_check sysfs_create_bin_file(struct kobject *kobj,
+                                      const struct bin_attribute *attr);
+void sysfs_remove_bin_file(struct kobject *kobj,
+                          const struct bin_attribute *attr);
+
+int __must_check sysfs_create_link(struct kobject *kobj, struct kobject *target,
+                                  const char *name);
+int __must_check sysfs_create_link_nowarn(struct kobject *kobj,
+                                         struct kobject *target,
+                                         const char *name);
+void sysfs_remove_link(struct kobject *kobj, const char *name);
+
+int __must_check sysfs_create_group(struct kobject *kobj,
+                                   const struct attribute_group *grp);
+int sysfs_update_group(struct kobject *kobj,
+                      const struct attribute_group *grp);
+void sysfs_remove_group(struct kobject *kobj,
+                       const struct attribute_group *grp);
+int sysfs_add_file_to_group(struct kobject *kobj,
+                       const struct attribute *attr, const char *group);
+void sysfs_remove_file_from_group(struct kobject *kobj,
+                       const struct attribute *attr, const char *group);
+
+void sysfs_notify(struct kobject *kobj, const char *dir, const char *attr);
+void sysfs_notify_dirent(struct sysfs_dirent *sd);
+struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
+                                     const unsigned char *name);
+struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd);
+void sysfs_put(struct sysfs_dirent *sd);
+void sysfs_printk_last_file(void);
+int __must_check sysfs_init(void);
 
-extern void
-sysfs_remove_dir(struct kobject *);
+#else /* CONFIG_SYSFS */
 
-extern int
-sysfs_rename_dir(struct kobject *, const char *new_name);
+static inline int sysfs_schedule_callback(struct kobject *kobj,
+               void (*func)(void *), void *data, struct module *owner)
+{
+       return -ENOSYS;
+}
 
-extern int
-sysfs_create_file(struct kobject *, const struct attribute *);
+static inline int sysfs_create_dir(struct kobject *kobj)
+{
+       return 0;
+}
 
-extern int
-sysfs_update_file(struct kobject *, const struct attribute *);
+static inline void sysfs_remove_dir(struct kobject *kobj)
+{
+}
 
-extern int
-sysfs_chmod_file(struct kobject *kobj, struct attribute *attr, mode_t mode);
+static inline int sysfs_rename_dir(struct kobject *kobj, const char *new_name)
+{
+       return 0;
+}
 
-extern void
-sysfs_remove_file(struct kobject *, const struct attribute *);
+static inline int sysfs_move_dir(struct kobject *kobj,
+                                struct kobject *new_parent_kobj)
+{
+       return 0;
+}
 
-extern int
-sysfs_create_link(struct kobject * kobj, struct kobject * target, const char * name);
+static inline int sysfs_create_file(struct kobject *kobj,
+                                   const struct attribute *attr)
+{
+       return 0;
+}
 
-extern void
-sysfs_remove_link(struct kobject *, const char * name);
+static inline int sysfs_create_files(struct kobject *kobj,
+                                   const struct attribute **attr)
+{
+       return 0;
+}
 
-int sysfs_create_bin_file(struct kobject * kobj, struct bin_attribute * attr);
-int sysfs_remove_bin_file(struct kobject * kobj, struct bin_attribute * attr);
+static inline int sysfs_chmod_file(struct kobject *kobj,
+                                  struct attribute *attr, mode_t mode)
+{
+       return 0;
+}
 
-int sysfs_create_group(struct kobject *, const struct attribute_group *);
-void sysfs_remove_group(struct kobject *, const struct attribute_group *);
+static inline void sysfs_remove_file(struct kobject *kobj,
+                                    const struct attribute *attr)
+{
+}
 
-#else /* CONFIG_SYSFS */
+static inline void sysfs_remove_files(struct kobject *kobj,
+                                    const struct attribute **attr)
+{
+}
 
-static inline int sysfs_create_dir(struct kobject * k)
+static inline int sysfs_create_bin_file(struct kobject *kobj,
+                                       const struct bin_attribute *attr)
 {
        return 0;
 }
 
-static inline void sysfs_remove_dir(struct kobject * k)
+static inline void sysfs_remove_bin_file(struct kobject *kobj,
+                                        const struct bin_attribute *attr)
 {
-       ;
 }
 
-static inline int sysfs_rename_dir(struct kobject * k, const char *new_name)
+static inline int sysfs_create_link(struct kobject *kobj,
+                                   struct kobject *target, const char *name)
 {
        return 0;
 }
 
-static inline int sysfs_create_file(struct kobject * k, const struct attribute * a)
+static inline int sysfs_create_link_nowarn(struct kobject *kobj,
+                                          struct kobject *target,
+                                          const char *name)
 {
        return 0;
 }
 
-static inline int sysfs_update_file(struct kobject * k, const struct attribute * a)
+static inline void sysfs_remove_link(struct kobject *kobj, const char *name)
+{
+}
+
+static inline int sysfs_create_group(struct kobject *kobj,
+                                    const struct attribute_group *grp)
 {
        return 0;
 }
-static inline int sysfs_chmod_file(struct kobject *kobj, struct attribute *attr, mode_t mode)
+
+static inline int sysfs_update_group(struct kobject *kobj,
+                               const struct attribute_group *grp)
 {
        return 0;
 }
 
-static inline void sysfs_remove_file(struct kobject * k, const struct attribute * a)
+static inline void sysfs_remove_group(struct kobject *kobj,
+                                     const struct attribute_group *grp)
 {
-       ;
 }
 
-static inline int sysfs_create_link(struct kobject * k, struct kobject * t, const char * n)
+static inline int sysfs_add_file_to_group(struct kobject *kobj,
+               const struct attribute *attr, const char *group)
 {
        return 0;
 }
 
-static inline void sysfs_remove_link(struct kobject * k, const char * name)
+static inline void sysfs_remove_file_from_group(struct kobject *kobj,
+               const struct attribute *attr, const char *group)
 {
-       ;
 }
 
-
-static inline int sysfs_create_bin_file(struct kobject * k, struct bin_attribute * a)
+static inline void sysfs_notify(struct kobject *kobj, const char *dir,
+                               const char *attr)
 {
-       return 0;
 }
-
-static inline int sysfs_remove_bin_file(struct kobject * k, struct bin_attribute * a)
+static inline void sysfs_notify_dirent(struct sysfs_dirent *sd)
+{
+}
+static inline
+struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
+                                     const unsigned char *name)
+{
+       return NULL;
+}
+static inline struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd)
+{
+       return NULL;
+}
+static inline void sysfs_put(struct sysfs_dirent *sd)
 {
-       return 0;
 }
 
-static inline int sysfs_create_group(struct kobject * k, const struct attribute_group *g)
+static inline int __must_check sysfs_init(void)
 {
        return 0;
 }
 
-static inline void sysfs_remove_group(struct kobject * k, const struct attribute_group * g)
+static inline void sysfs_printk_last_file(void)
 {
-       ;
 }
 
 #endif /* CONFIG_SYSFS */