2 * kobject.h - generic kernel object infrastructure.
4 * Copyright (c) 2002-2003 Patrick Mochel
5 * Copyright (c) 2002-2003 Open Source Development Labs
6 * Copyright (c) 2006-2007 Greg Kroah-Hartman <greg@kroah.com>
7 * Copyright (c) 2006-2007 Novell Inc.
9 * This file is released under the GPLv2.
12 * Please read Documentation/kobject.txt before using the kobject
13 * interface, ESPECIALLY the parts about reference counts and object
22 #include <linux/types.h>
23 #include <linux/list.h>
24 #include <linux/sysfs.h>
25 #include <linux/compiler.h>
26 #include <linux/spinlock.h>
27 #include <linux/kref.h>
28 #include <linux/kernel.h>
29 #include <linux/wait.h>
30 #include <asm/atomic.h>
32 #define KOBJ_NAME_LEN 20
33 #define UEVENT_HELPER_PATH_LEN 256
34 #define UEVENT_NUM_ENVP 32 /* number of env pointers */
35 #define UEVENT_BUFFER_SIZE 2048 /* buffer for the variables */
37 /* path to the userspace helper executed on an event */
38 extern char uevent_helper
[];
40 /* counter to tag the uevent, read only except for the kobject core */
41 extern u64 uevent_seqnum
;
44 * The actions here must match the index to the string array
45 * in lib/kobject_uevent.c
47 * Do not add new actions here without checking with the driver-core
48 * maintainers. Action strings are not meant to express subsystem
49 * or device specific properties. In most cases you want to send a
50 * kobject_uevent_env(kobj, KOBJ_CHANGE, env) with additional event
51 * specific variables added to the event environment.
66 struct list_head entry
;
67 struct kobject
* parent
;
69 struct kobj_type
* ktype
;
70 struct sysfs_dirent
* sd
;
73 extern int kobject_set_name(struct kobject
*, const char *, ...)
74 __attribute__((format(printf
,2,3)));
76 static inline const char * kobject_name(const struct kobject
* kobj
)
81 extern void kobject_init(struct kobject
*);
82 extern void kobject_init_ng(struct kobject
*kobj
, struct kobj_type
*ktype
);
83 extern int __must_check
kobject_add(struct kobject
*);
84 extern int __must_check
kobject_add_ng(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
, ...);
92 extern void kobject_del(struct kobject
*);
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
);
98 extern int __must_check
kobject_rename(struct kobject
*, const char *new_name
);
99 extern int __must_check
kobject_move(struct kobject
*, struct kobject
*);
101 extern int __must_check
kobject_register(struct kobject
*);
102 extern void kobject_unregister(struct kobject
*);
104 extern struct kobject
* kobject_get(struct kobject
*);
105 extern void kobject_put(struct kobject
*);
107 extern char * kobject_get_path(struct kobject
*, gfp_t
);
110 void (*release
)(struct kobject
*);
111 struct sysfs_ops
* sysfs_ops
;
112 struct attribute
** default_attrs
;
115 struct kobj_uevent_env
{
116 char *envp
[UEVENT_NUM_ENVP
];
118 char buf
[UEVENT_BUFFER_SIZE
];
122 struct kset_uevent_ops
{
123 int (*filter
)(struct kset
*kset
, struct kobject
*kobj
);
124 const char *(*name
)(struct kset
*kset
, struct kobject
*kobj
);
125 int (*uevent
)(struct kset
*kset
, struct kobject
*kobj
,
126 struct kobj_uevent_env
*env
);
130 * struct kset - a set of kobjects of a specific type, belonging to a specific subsystem.
132 * A kset defines a group of kobjects. They can be individually
133 * different "types" but overall these kobjects all want to be grouped
134 * together and operated on in the same manner. ksets are used to
135 * define the attribute callbacks and other common events that happen to
138 * @list: the list of all kobjects for this kset
139 * @list_lock: a lock for iterating over the kobjects
140 * @kobj: the embedded kobject for this kset (recursion, isn't it fun...)
141 * @uevent_ops: the set of uevent operations for this kset. These are
142 * called whenever a kobject has something happen to it so that the kset
143 * can add new environment variables, or filter out the uevents if so
147 struct list_head list
;
148 spinlock_t list_lock
;
150 struct kset_uevent_ops
*uevent_ops
;
153 extern void kset_init(struct kset
* k
);
154 extern int __must_check
kset_add(struct kset
* k
);
155 extern int __must_check
kset_register(struct kset
* k
);
156 extern void kset_unregister(struct kset
* k
);
157 extern struct kset
* __must_check
kset_create_and_add(const char *name
,
158 struct kset_uevent_ops
*u
,
159 struct kobject
*parent_kobj
);
161 static inline struct kset
* to_kset(struct kobject
* kobj
)
163 return kobj
? container_of(kobj
,struct kset
,kobj
) : NULL
;
166 static inline struct kset
* kset_get(struct kset
* k
)
168 return k
? to_kset(kobject_get(&k
->kobj
)) : NULL
;
171 static inline void kset_put(struct kset
* k
)
173 kobject_put(&k
->kobj
);
176 static inline struct kobj_type
*get_ktype(struct kobject
*kobj
)
181 extern struct kobject
* kset_find_obj(struct kset
*, const char *);
185 * Use this when initializing an embedded kset with no other
186 * fields to initialize.
188 #define set_kset_name(str) .kset = { .kobj = { .k_name = str } }
191 #define decl_subsys(_name,_uevent_ops) \
192 struct kset _name##_subsys = { \
193 .kobj = { .k_name = __stringify(_name) }, \
194 .uevent_ops =_uevent_ops, \
197 /* The global /sys/kernel/ kset for people to chain off of */
198 extern struct kset
*kernel_kset
;
199 /* The global /sys/hypervisor/ kobject for people to chain off of */
200 extern struct kobject
*hypervisor_kobj
;
202 extern int __must_check
subsystem_register(struct kset
*);
203 extern void subsystem_unregister(struct kset
*);
205 struct subsys_attribute
{
206 struct attribute attr
;
207 ssize_t (*show
)(struct kset
*, char *);
208 ssize_t (*store
)(struct kset
*, const char *, size_t);
211 extern int __must_check
subsys_create_file(struct kset
*,
212 struct subsys_attribute
*);
214 #if defined(CONFIG_HOTPLUG)
215 int kobject_uevent(struct kobject
*kobj
, enum kobject_action action
);
216 int kobject_uevent_env(struct kobject
*kobj
, enum kobject_action action
,
219 int add_uevent_var(struct kobj_uevent_env
*env
, const char *format
, ...)
220 __attribute__((format (printf
, 2, 3)));
222 int kobject_action_type(const char *buf
, size_t count
,
223 enum kobject_action
*type
);
225 static inline int kobject_uevent(struct kobject
*kobj
, enum kobject_action action
)
227 static inline int kobject_uevent_env(struct kobject
*kobj
,
228 enum kobject_action action
,
232 static inline int add_uevent_var(struct kobj_uevent_env
*env
, const char *format
, ...)
235 static inline int kobject_action_type(const char *buf
, size_t count
,
236 enum kobject_action
*type
)
240 #endif /* __KERNEL__ */
241 #endif /* _KOBJECT_H_ */