2 * kobject.h - generic kernel object infrastructure.
4 * Copyright (c) 2002-2003 Patrick Mochel
5 * Copyright (c) 2002-2003 Open Source Development Labs
7 * This file is released under the GPLv2.
10 * Please read Documentation/kobject.txt before using the kobject
11 * interface, ESPECIALLY the parts about reference counts and object
20 #include <linux/types.h>
21 #include <linux/list.h>
22 #include <linux/sysfs.h>
23 #include <linux/compiler.h>
24 #include <linux/spinlock.h>
25 #include <linux/kref.h>
26 #include <linux/kernel.h>
27 #include <linux/wait.h>
28 #include <asm/atomic.h>
30 #define KOBJ_NAME_LEN 20
31 #define UEVENT_HELPER_PATH_LEN 256
32 #define UEVENT_NUM_ENVP 32 /* number of env pointers */
33 #define UEVENT_BUFFER_SIZE 2048 /* buffer for the variables */
35 /* path to the userspace helper executed on an event */
36 extern char uevent_helper[];
38 /* counter to tag the uevent, read only except for the kobject core */
39 extern u64 uevent_seqnum;
42 * The actions here must match the index to the string array
43 * in lib/kobject_uevent.c
45 * Do not add new actions here without checking with the driver-core
46 * maintainers. Action strings are not meant to express subsystem
47 * or device specific properties. In most cases you want to send a
48 * kobject_uevent_env(kobj, KOBJ_CHANGE, env) with additional event
49 * specific variables added to the event environment.
61 /* The list of strings defining the valid kobject actions as specified above */
62 extern const char *kobject_actions[];
67 struct list_head entry;
68 struct kobject * parent;
70 struct kobj_type * ktype;
71 struct sysfs_dirent * sd;
72 wait_queue_head_t poll;
75 extern int kobject_set_name(struct kobject *, const char *, ...)
76 __attribute__((format(printf,2,3)));
78 static inline const char * kobject_name(const struct kobject * kobj)
83 extern void kobject_init(struct kobject *);
84 extern void kobject_cleanup(struct kobject *);
86 extern int __must_check kobject_add(struct kobject *);
87 extern void kobject_del(struct kobject *);
89 extern int __must_check kobject_rename(struct kobject *, const char *new_name);
90 extern int __must_check kobject_move(struct kobject *, struct kobject *);
92 extern int __must_check kobject_register(struct kobject *);
93 extern void kobject_unregister(struct kobject *);
95 extern struct kobject * kobject_get(struct kobject *);
96 extern void kobject_put(struct kobject *);
98 extern struct kobject *kobject_kset_add_dir(struct kset *kset,
99 struct kobject *, const char *);
100 extern struct kobject *kobject_add_dir(struct kobject *, const char *);
102 extern char * kobject_get_path(struct kobject *, gfp_t);
105 void (*release)(struct kobject *);
106 struct sysfs_ops * sysfs_ops;
107 struct attribute ** default_attrs;
110 struct kobj_uevent_env {
111 char *envp[UEVENT_NUM_ENVP];
113 char buf[UEVENT_BUFFER_SIZE];
117 struct kset_uevent_ops {
118 int (*filter)(struct kset *kset, struct kobject *kobj);
119 const char *(*name)(struct kset *kset, struct kobject *kobj);
120 int (*uevent)(struct kset *kset, struct kobject *kobj,
121 struct kobj_uevent_env *env);
125 * struct kset - a set of kobjects of a specific type, belonging
126 * to a specific subsystem.
128 * All kobjects of a kset should be embedded in an identical
129 * type. This type may have a descriptor, which the kset points
130 * to. This allows there to exist sets of objects of the same
131 * type in different subsystems.
133 * A subsystem does not have to be a list of only one type
134 * of object; multiple ksets can belong to one subsystem. All
135 * ksets of a subsystem share the subsystem's lock.
137 * Each kset can support specific event variables; it can
138 * supress the event generation or add subsystem specific
139 * variables carried with the event.
142 struct kobj_type * ktype;
143 struct list_head list;
144 spinlock_t list_lock;
146 struct kset_uevent_ops * uevent_ops;
150 extern void kset_init(struct kset * k);
151 extern int __must_check kset_add(struct kset * k);
152 extern int __must_check kset_register(struct kset * k);
153 extern void kset_unregister(struct kset * k);
155 static inline struct kset * to_kset(struct kobject * kobj)
157 return kobj ? container_of(kobj,struct kset,kobj) : NULL;
160 static inline struct kset * kset_get(struct kset * k)
162 return k ? to_kset(kobject_get(&k->kobj)) : NULL;
165 static inline void kset_put(struct kset * k)
167 kobject_put(&k->kobj);
170 static inline struct kobj_type * get_ktype(struct kobject * k)
172 if (k->kset && k->kset->ktype)
173 return k->kset->ktype;
178 extern struct kobject * kset_find_obj(struct kset *, const char *);
182 * Use this when initializing an embedded kset with no other
183 * fields to initialize.
185 #define set_kset_name(str) .kset = { .kobj = { .k_name = str } }
188 #define decl_subsys(_name,_type,_uevent_ops) \
189 struct kset _name##_subsys = { \
190 .kobj = { .k_name = __stringify(_name) }, \
192 .uevent_ops =_uevent_ops, \
194 #define decl_subsys_name(_varname,_name,_type,_uevent_ops) \
195 struct kset _varname##_subsys = { \
196 .kobj = { .k_name = __stringify(_name) }, \
198 .uevent_ops =_uevent_ops, \
201 /* The global /sys/kernel/ subsystem for people to chain off of */
202 extern struct kset kernel_subsys;
203 /* The global /sys/hypervisor/ subsystem */
204 extern struct kset hypervisor_subsys;
207 * Helpers for setting the kset of registered objects.
208 * Often, a registered object belongs to a kset embedded in a
209 * subsystem. These do no magic, just make the resulting code
214 * kobj_set_kset_s(obj,subsys) - set kset for embedded kobject.
215 * @obj: ptr to some object type.
216 * @subsys: a subsystem object (not a ptr).
218 * Can be used for any object type with an embedded ->kobj.
221 #define kobj_set_kset_s(obj,subsys) \
222 (obj)->kobj.kset = &(subsys)
224 extern void subsystem_init(struct kset *);
225 extern int __must_check subsystem_register(struct kset *);
226 extern void subsystem_unregister(struct kset *);
228 struct subsys_attribute {
229 struct attribute attr;
230 ssize_t (*show)(struct kset *, char *);
231 ssize_t (*store)(struct kset *, const char *, size_t);
234 extern int __must_check subsys_create_file(struct kset *,
235 struct subsys_attribute *);
237 #if defined(CONFIG_HOTPLUG)
238 int kobject_uevent(struct kobject *kobj, enum kobject_action action);
239 int kobject_uevent_env(struct kobject *kobj, enum kobject_action action,
242 int add_uevent_var(struct kobj_uevent_env *env, const char *format, ...)
243 __attribute__((format (printf, 2, 3)));
245 static inline int kobject_uevent(struct kobject *kobj, enum kobject_action action)
247 static inline int kobject_uevent_env(struct kobject *kobj,
248 enum kobject_action action,
252 static inline int add_uevent_var(struct kobj_uevent_env *env, const char *format, ...)
256 #endif /* __KERNEL__ */
257 #endif /* _KOBJECT_H_ */