SAFE public projects git trees. - safe/jmp/linux-2.6/blob - include/linux/kobject.h

   1 /*
   2  * kobject.h - generic kernel object infrastructure.
   3  *
   4  * Copyright (c) 2002-2003 Patrick Mochel
   5  * Copyright (c) 2002-2003 Open Source Development Labs
   6  * Copyright (c) 2006-2008 Greg Kroah-Hartman <greg@kroah.com>
   7  * Copyright (c) 2006-2008 Novell Inc.
   8  *
   9  * This file is released under the GPLv2.
  10  *
  11  * Please read Documentation/kobject.txt before using the kobject
  12  * interface, ESPECIALLY the parts about reference counts and object
  13  * destructors.
  14  */
  15
  16 #ifndef _KOBJECT_H_
  17 #define _KOBJECT_H_
  18
  19 #include <linux/types.h>
  20 #include <linux/list.h>
  21 #include <linux/sysfs.h>
  22 #include <linux/compiler.h>
  23 #include <linux/spinlock.h>
  24 #include <linux/kref.h>
  25 #include <linux/kernel.h>
  26 #include <linux/wait.h>
  27 #include <asm/atomic.h>
  28
  29 #define UEVENT_HELPER_PATH_LEN          256
  30 #define UEVENT_NUM_ENVP                 32      /* number of env pointers */
  31 #define UEVENT_BUFFER_SIZE              2048    /* buffer for the variables */
  32
  33 /* path to the userspace helper executed on an event */
  34 extern char uevent_helper[];
  35
  36 /* counter to tag the uevent, read only except for the kobject core */
  37 extern u64 uevent_seqnum;
  38
  39 /*
  40  * The actions here must match the index to the string array
  41  * in lib/kobject_uevent.c
  42  *
  43  * Do not add new actions here without checking with the driver-core
  44  * maintainers. Action strings are not meant to express subsystem
  45  * or device specific properties. In most cases you want to send a
  46  * kobject_uevent_env(kobj, KOBJ_CHANGE, env) with additional event
  47  * specific variables added to the event environment.
  48  */
  49 enum kobject_action {
  50         KOBJ_ADD,
  51         KOBJ_REMOVE,
  52         KOBJ_CHANGE,
  53         KOBJ_MOVE,
  54         KOBJ_ONLINE,
  55         KOBJ_OFFLINE,
  56         KOBJ_MAX
  57 };
  58
  59 struct kobject {
  60         const char              *name;
  61         struct list_head        entry;
  62         struct kobject          *parent;
  63         struct kset             *kset;
  64         struct kobj_type        *ktype;
  65         struct sysfs_dirent     *sd;
  66         struct kref             kref;
  67         unsigned int state_initialized:1;
  68         unsigned int state_in_sysfs:1;
  69         unsigned int state_add_uevent_sent:1;
  70         unsigned int state_remove_uevent_sent:1;
  71 };
  72
  73 extern int kobject_set_name(struct kobject *kobj, const char *name, ...)
  74                             __attribute__((format(printf, 2, 3)));
  75 extern int kobject_set_name_vargs(struct kobject *kobj, const char *fmt,
  76                                   va_list vargs);
  77
  78 static inline const char *kobject_name(const struct kobject *kobj)
  79 {
  80         return kobj->name;
  81 }
  82
  83 extern void kobject_init(struct kobject *kobj, struct kobj_type *ktype);
  84 extern int __must_check kobject_add(struct kobject *kobj,
  85                                     struct kobject *parent,
  86                                     const char *fmt, ...);
  87 extern int __must_check kobject_init_and_add(struct kobject *kobj,
  88                                              struct kobj_type *ktype,
  89                                              struct kobject *parent,
  90                                              const char *fmt, ...);
  91
  92 extern void kobject_del(struct kobject *kobj);
  93
  94 extern struct kobject * __must_check kobject_create(void);
  95 extern struct kobject * __must_check kobject_create_and_add(const char *name,
  96                                                 struct kobject *parent);
  97
  98 extern int __must_check kobject_rename(struct kobject *, const char *new_name);
  99 extern int __must_check kobject_move(struct kobject *, struct kobject *);
 100
 101 extern struct kobject *kobject_get(struct kobject *kobj);
 102 extern void kobject_put(struct kobject *kobj);
 103
 104 extern char *kobject_get_path(struct kobject *kobj, gfp_t flag);
 105
 106 struct kobj_type {
 107         void (*release)(struct kobject *kobj);
 108         struct sysfs_ops *sysfs_ops;
 109         struct attribute **default_attrs;
 110 };
 111
 112 struct kobj_uevent_env {
 113         char *envp[UEVENT_NUM_ENVP];
 114         int envp_idx;
 115         char buf[UEVENT_BUFFER_SIZE];
 116         int buflen;
 117 };
 118
 119 struct kset_uevent_ops {
 120         int (*filter)(struct kset *kset, struct kobject *kobj);
 121         const char *(*name)(struct kset *kset, struct kobject *kobj);
 122         int (*uevent)(struct kset *kset, struct kobject *kobj,
 123                       struct kobj_uevent_env *env);
 124 };
 125
 126 struct kobj_attribute {
 127         struct attribute attr;
 128         ssize_t (*show)(struct kobject *kobj, struct kobj_attribute *attr,
 129                         char *buf);
 130         ssize_t (*store)(struct kobject *kobj, struct kobj_attribute *attr,
 131                          const char *buf, size_t count);
 132 };
 133
 134 extern struct sysfs_ops kobj_sysfs_ops;
 135
 136 /**
 137  * struct kset - a set of kobjects of a specific type, belonging to a specific subsystem.
 138  *
 139  * A kset defines a group of kobjects.  They can be individually
 140  * different "types" but overall these kobjects all want to be grouped
 141  * together and operated on in the same manner.  ksets are used to
 142  * define the attribute callbacks and other common events that happen to
 143  * a kobject.
 144  *
 145  * @list: the list of all kobjects for this kset
 146  * @list_lock: a lock for iterating over the kobjects
 147  * @kobj: the embedded kobject for this kset (recursion, isn't it fun...)
 148  * @uevent_ops: the set of uevent operations for this kset.  These are
 149  * called whenever a kobject has something happen to it so that the kset
 150  * can add new environment variables, or filter out the uevents if so
 151  * desired.
 152  */
 153 struct kset {
 154         struct list_head list;
 155         spinlock_t list_lock;
 156         struct kobject kobj;
 157         struct kset_uevent_ops *uevent_ops;
 158 };
 159
 160 extern void kset_init(struct kset *kset);
 161 extern int __must_check kset_register(struct kset *kset);
 162 extern void kset_unregister(struct kset *kset);
 163 extern struct kset * __must_check kset_create_and_add(const char *name,
 164                                                 struct kset_uevent_ops *u,
 165                                                 struct kobject *parent_kobj);
 166
 167 static inline struct kset *to_kset(struct kobject *kobj)
 168 {
 169         return kobj ? container_of(kobj, struct kset, kobj) : NULL;
 170 }
 171
 172 static inline struct kset *kset_get(struct kset *k)
 173 {
 174         return k ? to_kset(kobject_get(&k->kobj)) : NULL;
 175 }
 176
 177 static inline void kset_put(struct kset *k)
 178 {
 179         kobject_put(&k->kobj);
 180 }
 181
 182 static inline struct kobj_type *get_ktype(struct kobject *kobj)
 183 {
 184         return kobj->ktype;
 185 }
 186
 187 extern struct kobject *kset_find_obj(struct kset *, const char *);
 188
 189 /* The global /sys/kernel/ kobject for people to chain off of */
 190 extern struct kobject *kernel_kobj;
 191 /* The global /sys/kernel/mm/ kobject for people to chain off of */
 192 extern struct kobject *mm_kobj;
 193 /* The global /sys/hypervisor/ kobject for people to chain off of */
 194 extern struct kobject *hypervisor_kobj;
 195 /* The global /sys/power/ kobject for people to chain off of */
 196 extern struct kobject *power_kobj;
 197 /* The global /sys/firmware/ kobject for people to chain off of */
 198 extern struct kobject *firmware_kobj;
 199
 200 #if defined(CONFIG_HOTPLUG)
 201 int kobject_uevent(struct kobject *kobj, enum kobject_action action);
 202 int kobject_uevent_env(struct kobject *kobj, enum kobject_action action,
 203                         char *envp[]);
 204
 205 int add_uevent_var(struct kobj_uevent_env *env, const char *format, ...)
 206         __attribute__((format (printf, 2, 3)));
 207
 208 int kobject_action_type(const char *buf, size_t count,
 209                         enum kobject_action *type);
 210 #else
 211 static inline int kobject_uevent(struct kobject *kobj,
 212                                  enum kobject_action action)
 213 { return 0; }
 214 static inline int kobject_uevent_env(struct kobject *kobj,
 215                                       enum kobject_action action,
 216                                       char *envp[])
 217 { return 0; }
 218
 219 static inline int add_uevent_var(struct kobj_uevent_env *env,
 220                                  const char *format, ...)
 221 { return 0; }
 222
 223 static inline int kobject_action_type(const char *buf, size_t count,
 224                                       enum kobject_action *type)
 225 { return -EINVAL; }
 226 #endif
 227
 228 #endif /* _KOBJECT_H_ */