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/spinlock.h>
24 #include <linux/rwsem.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
33 /* path to the userspace helper executed on an event */
34 extern char uevent_helper
[];
36 /* counter to tag the uevent, read only except for the kobject core */
37 extern u64 uevent_seqnum
;
39 /* the actions here must match the proper string in lib/kobject_uevent.c */
40 typedef int __bitwise kobject_action_t
;
42 KOBJ_ADD
= (__force kobject_action_t
) 0x01, /* exclusive to core */
43 KOBJ_REMOVE
= (__force kobject_action_t
) 0x02, /* exclusive to core */
44 KOBJ_CHANGE
= (__force kobject_action_t
) 0x03, /* device state change */
45 KOBJ_MOUNT
= (__force kobject_action_t
) 0x04, /* mount event for block devices (broken) */
46 KOBJ_UMOUNT
= (__force kobject_action_t
) 0x05, /* umount event for block devices (broken) */
47 KOBJ_OFFLINE
= (__force kobject_action_t
) 0x06, /* device offline */
48 KOBJ_ONLINE
= (__force kobject_action_t
) 0x07, /* device online */
49 KOBJ_UNDOCK
= (__force kobject_action_t
) 0x08, /* undocking */
50 KOBJ_DOCK
= (__force kobject_action_t
) 0x09, /* dock */
55 char name
[KOBJ_NAME_LEN
];
57 struct list_head entry
;
58 struct kobject
* parent
;
60 struct kobj_type
* ktype
;
61 struct dentry
* dentry
;
62 wait_queue_head_t poll
;
65 extern int kobject_set_name(struct kobject
*, const char *, ...)
66 __attribute__((format(printf
,2,3)));
68 static inline const char * kobject_name(const struct kobject
* kobj
)
73 extern void kobject_init(struct kobject
*);
74 extern void kobject_cleanup(struct kobject
*);
76 extern int kobject_add(struct kobject
*);
77 extern void kobject_del(struct kobject
*);
79 extern int kobject_rename(struct kobject
*, const char *new_name
);
81 extern int kobject_register(struct kobject
*);
82 extern void kobject_unregister(struct kobject
*);
84 extern struct kobject
* kobject_get(struct kobject
*);
85 extern void kobject_put(struct kobject
*);
87 extern struct kobject
*kobject_add_dir(struct kobject
*, const char *);
89 extern char * kobject_get_path(struct kobject
*, gfp_t
);
92 void (*release
)(struct kobject
*);
93 struct sysfs_ops
* sysfs_ops
;
94 struct attribute
** default_attrs
;
99 * kset - a set of kobjects of a specific type, belonging
100 * to a specific subsystem.
102 * All kobjects of a kset should be embedded in an identical
103 * type. This type may have a descriptor, which the kset points
104 * to. This allows there to exist sets of objects of the same
105 * type in different subsystems.
107 * A subsystem does not have to be a list of only one type
108 * of object; multiple ksets can belong to one subsystem. All
109 * ksets of a subsystem share the subsystem's lock.
111 * Each kset can support specific event variables; it can
112 * supress the event generation or add subsystem specific
113 * variables carried with the event.
115 struct kset_uevent_ops
{
116 int (*filter
)(struct kset
*kset
, struct kobject
*kobj
);
117 const char *(*name
)(struct kset
*kset
, struct kobject
*kobj
);
118 int (*uevent
)(struct kset
*kset
, struct kobject
*kobj
, char **envp
,
119 int num_envp
, char *buffer
, int buffer_size
);
123 struct subsystem
* subsys
;
124 struct kobj_type
* ktype
;
125 struct list_head list
;
126 spinlock_t list_lock
;
128 struct kset_uevent_ops
* uevent_ops
;
132 extern void kset_init(struct kset
* k
);
133 extern int kset_add(struct kset
* k
);
134 extern int kset_register(struct kset
* k
);
135 extern void kset_unregister(struct kset
* k
);
137 static inline struct kset
* to_kset(struct kobject
* kobj
)
139 return kobj
? container_of(kobj
,struct kset
,kobj
) : NULL
;
142 static inline struct kset
* kset_get(struct kset
* k
)
144 return k
? to_kset(kobject_get(&k
->kobj
)) : NULL
;
147 static inline void kset_put(struct kset
* k
)
149 kobject_put(&k
->kobj
);
152 static inline struct kobj_type
* get_ktype(struct kobject
* k
)
154 if (k
->kset
&& k
->kset
->ktype
)
155 return k
->kset
->ktype
;
160 extern struct kobject
* kset_find_obj(struct kset
*, const char *);
164 * Use this when initializing an embedded kset with no other
165 * fields to initialize.
167 #define set_kset_name(str) .kset = { .kobj = { .name = str } }
173 struct rw_semaphore rwsem
;
176 #define decl_subsys(_name,_type,_uevent_ops) \
177 struct subsystem _name##_subsys = { \
179 .kobj = { .name = __stringify(_name) }, \
181 .uevent_ops =_uevent_ops, \
184 #define decl_subsys_name(_varname,_name,_type,_uevent_ops) \
185 struct subsystem _varname##_subsys = { \
187 .kobj = { .name = __stringify(_name) }, \
189 .uevent_ops =_uevent_ops, \
193 /* The global /sys/kernel/ subsystem for people to chain off of */
194 extern struct subsystem kernel_subsys
;
195 /* The global /sys/hypervisor/ subsystem */
196 extern struct subsystem hypervisor_subsys
;
199 * Helpers for setting the kset of registered objects.
200 * Often, a registered object belongs to a kset embedded in a
201 * subsystem. These do no magic, just make the resulting code
206 * kobj_set_kset_s(obj,subsys) - set kset for embedded kobject.
207 * @obj: ptr to some object type.
208 * @subsys: a subsystem object (not a ptr).
210 * Can be used for any object type with an embedded ->kobj.
213 #define kobj_set_kset_s(obj,subsys) \
214 (obj)->kobj.kset = &(subsys).kset
217 * kset_set_kset_s(obj,subsys) - set kset for embedded kset.
218 * @obj: ptr to some object type.
219 * @subsys: a subsystem object (not a ptr).
221 * Can be used for any object type with an embedded ->kset.
222 * Sets the kset of @obj's embedded kobject (via its embedded
223 * kset) to @subsys.kset. This makes @obj a member of that
227 #define kset_set_kset_s(obj,subsys) \
228 (obj)->kset.kobj.kset = &(subsys).kset
231 * subsys_set_kset(obj,subsys) - set kset for subsystem
232 * @obj: ptr to some object type.
233 * @subsys: a subsystem object (not a ptr).
235 * Can be used for any object type with an embedded ->subsys.
236 * Sets the kset of @obj's kobject to @subsys.kset. This makes
237 * the object a member of that kset.
240 #define subsys_set_kset(obj,_subsys) \
241 (obj)->subsys.kset.kobj.kset = &(_subsys).kset
243 extern void subsystem_init(struct subsystem
*);
244 extern int subsystem_register(struct subsystem
*);
245 extern void subsystem_unregister(struct subsystem
*);
247 static inline struct subsystem
* subsys_get(struct subsystem
* s
)
249 return s
? container_of(kset_get(&s
->kset
),struct subsystem
,kset
) : NULL
;
252 static inline void subsys_put(struct subsystem
* s
)
257 struct subsys_attribute
{
258 struct attribute attr
;
259 ssize_t (*show
)(struct subsystem
*, char *);
260 ssize_t (*store
)(struct subsystem
*, const char *, size_t);
263 extern int subsys_create_file(struct subsystem
* , struct subsys_attribute
*);
265 #if defined(CONFIG_HOTPLUG)
266 void kobject_uevent(struct kobject
*kobj
, enum kobject_action action
);
268 int add_uevent_var(char **envp
, int num_envp
, int *cur_index
,
269 char *buffer
, int buffer_size
, int *cur_len
,
270 const char *format
, ...)
271 __attribute__((format (printf
, 7, 8)));
273 static inline void kobject_uevent(struct kobject
*kobj
, enum kobject_action action
) { }
275 static inline int add_uevent_var(char **envp
, int num_envp
, int *cur_index
,
276 char *buffer
, int buffer_size
, int *cur_len
,
277 const char *format
, ...)
281 #endif /* __KERNEL__ */
282 #endif /* _KOBJECT_H_ */