Driver core: exclude kobject_uevent.c for !CONFIG_HOTPLUG
[safe/jmp/linux-2.6] / include / linux / kobject.h
index 7f7403a..0777b3f 100644 (file)
 #include <linux/types.h>
 #include <linux/list.h>
 #include <linux/sysfs.h>
+#include <linux/compiler.h>
 #include <linux/spinlock.h>
-#include <linux/rwsem.h>
 #include <linux/kref.h>
-#include <linux/kobject_uevent.h>
 #include <linux/kernel.h>
+#include <linux/wait.h>
 #include <asm/atomic.h>
 
-#define KOBJ_NAME_LEN  20
+#define KOBJ_NAME_LEN                  20
+#define UEVENT_HELPER_PATH_LEN         256
+#define UEVENT_NUM_ENVP                        32      /* number of env pointers */
+#define UEVENT_BUFFER_SIZE             2048    /* buffer for the variables */
 
-/* counter to tag the hotplug event, read only except for the kobject core */
-extern u64 hotplug_seqnum;
+/* path to the userspace helper executed on an event */
+extern char uevent_helper[];
+
+/* counter to tag the uevent, read only except for the kobject core */
+extern u64 uevent_seqnum;
+
+/*
+ * The actions here must match the index to the string array
+ * in lib/kobject_uevent.c
+ *
+ * Do not add new actions here without checking with the driver-core
+ * maintainers. Action strings are not meant to express subsystem
+ * or device specific properties. In most cases you want to send a
+ * kobject_uevent_env(kobj, KOBJ_CHANGE, env) with additional event
+ * specific variables added to the event environment.
+ */
+enum kobject_action {
+       KOBJ_ADD,
+       KOBJ_REMOVE,
+       KOBJ_CHANGE,
+       KOBJ_MOVE,
+       KOBJ_ONLINE,
+       KOBJ_OFFLINE,
+       KOBJ_MAX
+};
 
 struct kobject {
        const char              * k_name;
-       char                    name[KOBJ_NAME_LEN];
        struct kref             kref;
        struct list_head        entry;
        struct kobject          * parent;
        struct kset             * kset;
        struct kobj_type        * ktype;
-       struct dentry           * dentry;
+       struct sysfs_dirent     * sd;
+       wait_queue_head_t       poll;
 };
 
 extern int kobject_set_name(struct kobject *, const char *, ...)
@@ -54,17 +80,22 @@ static inline const char * kobject_name(const struct kobject * kobj)
 extern void kobject_init(struct kobject *);
 extern void kobject_cleanup(struct kobject *);
 
-extern int kobject_add(struct kobject *);
+extern int __must_check kobject_add(struct kobject *);
 extern void kobject_del(struct kobject *);
 
-extern int kobject_rename(struct kobject *, const char *new_name);
+extern int __must_check kobject_rename(struct kobject *, const char *new_name);
+extern int __must_check kobject_move(struct kobject *, struct kobject *);
 
-extern int kobject_register(struct kobject *);
+extern int __must_check kobject_register(struct kobject *);
 extern void kobject_unregister(struct kobject *);
 
 extern struct kobject * kobject_get(struct kobject *);
 extern void kobject_put(struct kobject *);
 
+extern struct kobject *kobject_kset_add_dir(struct kset *kset,
+                                           struct kobject *, const char *);
+extern struct kobject *kobject_add_dir(struct kobject *, const char *);
+
 extern char * kobject_get_path(struct kobject *, gfp_t);
 
 struct kobj_type {
@@ -73,9 +104,22 @@ struct kobj_type {
        struct attribute        ** default_attrs;
 };
 
+struct kobj_uevent_env {
+       char *envp[UEVENT_NUM_ENVP];
+       int envp_idx;
+       char buf[UEVENT_BUFFER_SIZE];
+       int buflen;
+};
 
-/**
- *     kset - a set of kobjects of a specific type, belonging
+struct kset_uevent_ops {
+       int (*filter)(struct kset *kset, struct kobject *kobj);
+       const char *(*name)(struct kset *kset, struct kobject *kobj);
+       int (*uevent)(struct kset *kset, struct kobject *kobj,
+                     struct kobj_uevent_env *env);
+};
+
+/*
+ *     struct kset - a set of kobjects of a specific type, belonging
  *     to a specific subsystem.
  *
  *     All kobjects of a kset should be embedded in an identical 
@@ -87,31 +131,22 @@ struct kobj_type {
  *     of object; multiple ksets can belong to one subsystem. All 
  *     ksets of a subsystem share the subsystem's lock.
  *
- *      Each kset can support hotplugging; if it does, it will be given
- *      the opportunity to filter out specific kobjects from being
- *      reported, as well as to add its own "data" elements to the
- *      environment being passed to the hotplug helper.
+ *     Each kset can support specific event variables; it can
+ *     supress the event generation or add subsystem specific
+ *     variables carried with the event.
  */
-struct kset_hotplug_ops {
-       int (*filter)(struct kset *kset, struct kobject *kobj);
-       const char *(*name)(struct kset *kset, struct kobject *kobj);
-       int (*hotplug)(struct kset *kset, struct kobject *kobj, char **envp,
-                       int num_envp, char *buffer, int buffer_size);
-};
-
 struct kset {
-       struct subsystem        * subsys;
        struct kobj_type        * ktype;
        struct list_head        list;
        spinlock_t              list_lock;
        struct kobject          kobj;
-       struct kset_hotplug_ops * hotplug_ops;
+       struct kset_uevent_ops  * uevent_ops;
 };
 
 
 extern void kset_init(struct kset * k);
-extern int kset_add(struct kset * k);
-extern int kset_register(struct kset * k);
+extern int __must_check kset_add(struct kset * k);
+extern int __must_check kset_register(struct kset * k);
 extern void kset_unregister(struct kset * k);
 
 static inline struct kset * to_kset(struct kobject * kobj)
@@ -140,40 +175,32 @@ static inline struct kobj_type * get_ktype(struct kobject * k)
 extern struct kobject * kset_find_obj(struct kset *, const char *);
 
 
-/**
+/*
  * Use this when initializing an embedded kset with no other 
  * fields to initialize.
  */
-#define set_kset_name(str)     .kset = { .kobj = { .name = str } }
+#define set_kset_name(str)     .kset = { .kobj = { .k_name = str } }
 
 
-
-struct subsystem {
-       struct kset             kset;
-       struct rw_semaphore     rwsem;
-};
-
-#define decl_subsys(_name,_type,_hotplug_ops) \
-struct subsystem _name##_subsys = { \
-       .kset = { \
-               .kobj = { .name = __stringify(_name) }, \
-               .ktype = _type, \
-               .hotplug_ops =_hotplug_ops, \
-       } \
+#define decl_subsys(_name,_type,_uevent_ops) \
+struct kset _name##_subsys = { \
+       .kobj = { .k_name = __stringify(_name) }, \
+       .ktype = _type, \
+       .uevent_ops =_uevent_ops, \
 }
-#define decl_subsys_name(_varname,_name,_type,_hotplug_ops) \
-struct subsystem _varname##_subsys = { \
-       .kset = { \
-               .kobj = { .name = __stringify(_name) }, \
-               .ktype = _type, \
-               .hotplug_ops =_hotplug_ops, \
-       } \
+#define decl_subsys_name(_varname,_name,_type,_uevent_ops) \
+struct kset _varname##_subsys = { \
+       .kobj = { .k_name = __stringify(_name) }, \
+       .ktype = _type, \
+       .uevent_ops =_uevent_ops, \
 }
 
 /* The global /sys/kernel/ subsystem for people to chain off of */
-extern struct subsystem kernel_subsys;
+extern struct kset kernel_subsys;
+/* The global /sys/hypervisor/ subsystem  */
+extern struct kset hypervisor_subsys;
 
-/**
+/*
  * Helpers for setting the kset of registered objects.
  * Often, a registered object belongs to a kset embedded in a 
  * subsystem. These do no magic, just make the resulting code
@@ -189,70 +216,45 @@ extern struct subsystem kernel_subsys;
  */
 
 #define kobj_set_kset_s(obj,subsys) \
-       (obj)->kobj.kset = &(subsys).kset
+       (obj)->kobj.kset = &(subsys)
 
-/**
- *     kset_set_kset_s(obj,subsys) - set kset for embedded kset.
- *     @obj:           ptr to some object type.
- *     @subsys:        a subsystem object (not a ptr).
- *
- *     Can be used for any object type with an embedded ->kset.
- *     Sets the kset of @obj's  embedded kobject (via its embedded
- *     kset) to @subsys.kset. This makes @obj a member of that 
- *     kset.
- */
-
-#define kset_set_kset_s(obj,subsys) \
-       (obj)->kset.kobj.kset = &(subsys).kset
-
-/**
- *     subsys_set_kset(obj,subsys) - set kset for subsystem
- *     @obj:           ptr to some object type.
- *     @subsys:        a subsystem object (not a ptr).
- *
- *     Can be used for any object type with an embedded ->subsys.
- *     Sets the kset of @obj's kobject to @subsys.kset. This makes
- *     the object a member of that kset.
- */
-
-#define subsys_set_kset(obj,_subsys) \
-       (obj)->subsys.kset.kobj.kset = &(_subsys).kset
-
-extern void subsystem_init(struct subsystem *);
-extern int subsystem_register(struct subsystem *);
-extern void subsystem_unregister(struct subsystem *);
-
-static inline struct subsystem * subsys_get(struct subsystem * s)
-{
-       return s ? container_of(kset_get(&s->kset),struct subsystem,kset) : NULL;
-}
-
-static inline void subsys_put(struct subsystem * s)
-{
-       kset_put(&s->kset);
-}
+extern void subsystem_init(struct kset *);
+extern int __must_check subsystem_register(struct kset *);
+extern void subsystem_unregister(struct kset *);
 
 struct subsys_attribute {
        struct attribute attr;
-       ssize_t (*show)(struct subsystem *, char *);
-       ssize_t (*store)(struct subsystem *, const char *, size_t); 
+       ssize_t (*show)(struct kset *, char *);
+       ssize_t (*store)(struct kset *, const char *, size_t);
 };
 
-extern int subsys_create_file(struct subsystem * , struct subsys_attribute *);
-extern void subsys_remove_file(struct subsystem * , struct subsys_attribute *);
+extern int __must_check subsys_create_file(struct kset *,
+                                       struct subsys_attribute *);
 
-#ifdef CONFIG_HOTPLUG
-void kobject_hotplug(struct kobject *kobj, enum kobject_action action);
-int add_hotplug_env_var(char **envp, int num_envp, int *cur_index,
-                       char *buffer, int buffer_size, int *cur_len,
-                       const char *format, ...)
-       __attribute__((format (printf, 7, 8)));
+#if defined(CONFIG_HOTPLUG)
+int kobject_uevent(struct kobject *kobj, enum kobject_action action);
+int kobject_uevent_env(struct kobject *kobj, enum kobject_action action,
+                       char *envp[]);
+
+int add_uevent_var(struct kobj_uevent_env *env, const char *format, ...)
+       __attribute__((format (printf, 2, 3)));
+
+int kobject_action_type(const char *buf, size_t count,
+                       enum kobject_action *type);
 #else
-static inline void kobject_hotplug(struct kobject *kobj, enum kobject_action action) { }
-static inline int add_hotplug_env_var(char **envp, int num_envp, int *cur_index, 
-                                     char *buffer, int buffer_size, int *cur_len, 
-                                     const char *format, ...)
+static inline int kobject_uevent(struct kobject *kobj, enum kobject_action action)
+{ return 0; }
+static inline int kobject_uevent_env(struct kobject *kobj,
+                                     enum kobject_action action,
+                                     char *envp[])
 { return 0; }
+
+static inline int add_uevent_var(struct kobj_uevent_env *env, const char *format, ...)
+{ return 0; }
+
+static inline int kobject_action_type(const char *buf, size_t count,
+                       enum kobject_action *type)
+{ return -EINVAL; }
 #endif
 
 #endif /* __KERNEL__ */