]>
Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * kobject.h - generic kernel object infrastructure. | |
3 | * | |
f0e7e1bd GKH |
4 | * Copyright (c) 2002-2003 Patrick Mochel |
5 | * Copyright (c) 2002-2003 Open Source Development Labs | |
79a6ee42 GKH |
6 | * Copyright (c) 2006-2008 Greg Kroah-Hartman <greg@kroah.com> |
7 | * Copyright (c) 2006-2008 Novell Inc. | |
1da177e4 LT |
8 | * |
9 | * This file is released under the GPLv2. | |
10 | * | |
1da177e4 LT |
11 | * Please read Documentation/kobject.txt before using the kobject |
12 | * interface, ESPECIALLY the parts about reference counts and object | |
79a6ee42 | 13 | * destructors. |
1da177e4 LT |
14 | */ |
15 | ||
16 | #ifndef _KOBJECT_H_ | |
17 | #define _KOBJECT_H_ | |
18 | ||
1da177e4 LT |
19 | #include <linux/types.h> |
20 | #include <linux/list.h> | |
21 | #include <linux/sysfs.h> | |
4a7fb636 | 22 | #include <linux/compiler.h> |
1da177e4 | 23 | #include <linux/spinlock.h> |
1da177e4 | 24 | #include <linux/kref.h> |
8488a38f | 25 | #include <linux/kobject_ns.h> |
1da177e4 | 26 | #include <linux/kernel.h> |
4508a7a7 | 27 | #include <linux/wait.h> |
60063497 | 28 | #include <linux/atomic.h> |
c817a67e | 29 | #include <linux/workqueue.h> |
4e5feafc | 30 | #include <linux/uidgid.h> |
1da177e4 | 31 | |
312c004d | 32 | #define UEVENT_HELPER_PATH_LEN 256 |
7eff2e7a KS |
33 | #define UEVENT_NUM_ENVP 32 /* number of env pointers */ |
34 | #define UEVENT_BUFFER_SIZE 2048 /* buffer for the variables */ | |
0296b228 | 35 | |
86d56134 | 36 | #ifdef CONFIG_UEVENT_HELPER |
0296b228 | 37 | /* path to the userspace helper executed on an event */ |
312c004d | 38 | extern char uevent_helper[]; |
86d56134 | 39 | #endif |
0296b228 | 40 | |
312c004d KS |
41 | /* counter to tag the uevent, read only except for the kobject core */ |
42 | extern u64 uevent_seqnum; | |
1da177e4 | 43 | |
60a96a59 KS |
44 | /* |
45 | * The actions here must match the index to the string array | |
46 | * in lib/kobject_uevent.c | |
47 | * | |
48 | * Do not add new actions here without checking with the driver-core | |
49 | * maintainers. Action strings are not meant to express subsystem | |
50 | * or device specific properties. In most cases you want to send a | |
51 | * kobject_uevent_env(kobj, KOBJ_CHANGE, env) with additional event | |
52 | * specific variables added to the event environment. | |
53 | */ | |
0296b228 | 54 | enum kobject_action { |
60a96a59 KS |
55 | KOBJ_ADD, |
56 | KOBJ_REMOVE, | |
57 | KOBJ_CHANGE, | |
58 | KOBJ_MOVE, | |
59 | KOBJ_ONLINE, | |
60 | KOBJ_OFFLINE, | |
1455cf8d DT |
61 | KOBJ_BIND, |
62 | KOBJ_UNBIND, | |
60a96a59 | 63 | KOBJ_MAX |
0296b228 KS |
64 | }; |
65 | ||
1da177e4 | 66 | struct kobject { |
af5ca3f4 | 67 | const char *name; |
1da177e4 | 68 | struct list_head entry; |
79a6ee42 GKH |
69 | struct kobject *parent; |
70 | struct kset *kset; | |
71 | struct kobj_type *ktype; | |
f7025709 | 72 | struct kernfs_node *sd; /* sysfs directory entry */ |
a231934b | 73 | struct kref kref; |
c817a67e RK |
74 | #ifdef CONFIG_DEBUG_KOBJECT_RELEASE |
75 | struct delayed_work release; | |
76 | #endif | |
0f4dafc0 | 77 | unsigned int state_initialized:1; |
0f4dafc0 KS |
78 | unsigned int state_in_sysfs:1; |
79 | unsigned int state_add_uevent_sent:1; | |
80 | unsigned int state_remove_uevent_sent:1; | |
f67f129e | 81 | unsigned int uevent_suppress:1; |
1da177e4 LT |
82 | }; |
83 | ||
b9075fa9 JP |
84 | extern __printf(2, 3) |
85 | int kobject_set_name(struct kobject *kobj, const char *name, ...); | |
8db14860 NI |
86 | extern __printf(2, 0) |
87 | int kobject_set_name_vargs(struct kobject *kobj, const char *fmt, | |
88 | va_list vargs); | |
1da177e4 | 89 | |
79a6ee42 | 90 | static inline const char *kobject_name(const struct kobject *kobj) |
1da177e4 | 91 | { |
af5ca3f4 | 92 | return kobj->name; |
1da177e4 LT |
93 | } |
94 | ||
f9cb074b | 95 | extern void kobject_init(struct kobject *kobj, struct kobj_type *ktype); |
b9075fa9 JP |
96 | extern __printf(3, 4) __must_check |
97 | int kobject_add(struct kobject *kobj, struct kobject *parent, | |
98 | const char *fmt, ...); | |
99 | extern __printf(4, 5) __must_check | |
100 | int kobject_init_and_add(struct kobject *kobj, | |
101 | struct kobj_type *ktype, struct kobject *parent, | |
102 | const char *fmt, ...); | |
c11c4154 | 103 | |
79a6ee42 | 104 | extern void kobject_del(struct kobject *kobj); |
1da177e4 | 105 | |
43968d2f | 106 | extern struct kobject * __must_check kobject_create(void); |
3f9e3ee9 GKH |
107 | extern struct kobject * __must_check kobject_create_and_add(const char *name, |
108 | struct kobject *parent); | |
109 | ||
4a7fb636 | 110 | extern int __must_check kobject_rename(struct kobject *, const char *new_name); |
8a82472f | 111 | extern int __must_check kobject_move(struct kobject *, struct kobject *); |
1da177e4 | 112 | |
79a6ee42 | 113 | extern struct kobject *kobject_get(struct kobject *kobj); |
c70c176f JK |
114 | extern struct kobject * __must_check kobject_get_unless_zero( |
115 | struct kobject *kobj); | |
79a6ee42 | 116 | extern void kobject_put(struct kobject *kobj); |
1da177e4 | 117 | |
e34ff490 | 118 | extern const void *kobject_namespace(struct kobject *kobj); |
4e5feafc DT |
119 | extern void kobject_get_ownership(struct kobject *kobj, |
120 | kuid_t *uid, kgid_t *gid); | |
79a6ee42 | 121 | extern char *kobject_get_path(struct kobject *kobj, gfp_t flag); |
1da177e4 | 122 | |
926c106a BH |
123 | /** |
124 | * kobject_has_children - Returns whether a kobject has children. | |
125 | * @kobj: the object to test | |
126 | * | |
127 | * This will return whether a kobject has other kobjects as children. | |
128 | * | |
129 | * It does NOT account for the presence of attribute files, only sub | |
130 | * directories. It also assumes there is no concurrent addition or | |
131 | * removal of such children, and thus relies on external locking. | |
132 | */ | |
133 | static inline bool kobject_has_children(struct kobject *kobj) | |
134 | { | |
135 | WARN_ON_ONCE(kref_read(&kobj->kref) == 0); | |
136 | ||
137 | return kobj->sd && kobj->sd->dir.subdirs; | |
138 | } | |
139 | ||
1da177e4 | 140 | struct kobj_type { |
79a6ee42 | 141 | void (*release)(struct kobject *kobj); |
52cf25d0 | 142 | const struct sysfs_ops *sysfs_ops; |
79a6ee42 | 143 | struct attribute **default_attrs; |
bc451f20 EB |
144 | const struct kobj_ns_type_operations *(*child_ns_type)(struct kobject *kobj); |
145 | const void *(*namespace)(struct kobject *kobj); | |
4e5feafc | 146 | void (*get_ownership)(struct kobject *kobj, kuid_t *uid, kgid_t *gid); |
1da177e4 LT |
147 | }; |
148 | ||
7eff2e7a | 149 | struct kobj_uevent_env { |
bcccff93 | 150 | char *argv[3]; |
7eff2e7a KS |
151 | char *envp[UEVENT_NUM_ENVP]; |
152 | int envp_idx; | |
153 | char buf[UEVENT_BUFFER_SIZE]; | |
154 | int buflen; | |
155 | }; | |
156 | ||
a5615648 | 157 | struct kset_uevent_ops { |
9cd43611 ER |
158 | int (* const filter)(struct kset *kset, struct kobject *kobj); |
159 | const char *(* const name)(struct kset *kset, struct kobject *kobj); | |
160 | int (* const uevent)(struct kset *kset, struct kobject *kobj, | |
7eff2e7a | 161 | struct kobj_uevent_env *env); |
a5615648 | 162 | }; |
1da177e4 | 163 | |
23b5212c KS |
164 | struct kobj_attribute { |
165 | struct attribute attr; | |
166 | ssize_t (*show)(struct kobject *kobj, struct kobj_attribute *attr, | |
167 | char *buf); | |
168 | ssize_t (*store)(struct kobject *kobj, struct kobj_attribute *attr, | |
169 | const char *buf, size_t count); | |
170 | }; | |
171 | ||
52cf25d0 | 172 | extern const struct sysfs_ops kobj_sysfs_ops; |
23b5212c | 173 | |
bc451f20 | 174 | struct sock; |
be867b19 | 175 | |
6adf7554 GKH |
176 | /** |
177 | * struct kset - a set of kobjects of a specific type, belonging to a specific subsystem. | |
1da177e4 | 178 | * |
6adf7554 GKH |
179 | * A kset defines a group of kobjects. They can be individually |
180 | * different "types" but overall these kobjects all want to be grouped | |
181 | * together and operated on in the same manner. ksets are used to | |
182 | * define the attribute callbacks and other common events that happen to | |
183 | * a kobject. | |
1da177e4 | 184 | * |
6adf7554 GKH |
185 | * @list: the list of all kobjects for this kset |
186 | * @list_lock: a lock for iterating over the kobjects | |
187 | * @kobj: the embedded kobject for this kset (recursion, isn't it fun...) | |
188 | * @uevent_ops: the set of uevent operations for this kset. These are | |
189 | * called whenever a kobject has something happen to it so that the kset | |
190 | * can add new environment variables, or filter out the uevents if so | |
191 | * desired. | |
1da177e4 | 192 | */ |
1da177e4 | 193 | struct kset { |
79a6ee42 GKH |
194 | struct list_head list; |
195 | spinlock_t list_lock; | |
196 | struct kobject kobj; | |
9cd43611 | 197 | const struct kset_uevent_ops *uevent_ops; |
3859a271 | 198 | } __randomize_layout; |
1da177e4 | 199 | |
79a6ee42 GKH |
200 | extern void kset_init(struct kset *kset); |
201 | extern int __must_check kset_register(struct kset *kset); | |
202 | extern void kset_unregister(struct kset *kset); | |
b727c702 | 203 | extern struct kset * __must_check kset_create_and_add(const char *name, |
9cd43611 | 204 | const struct kset_uevent_ops *u, |
b727c702 | 205 | struct kobject *parent_kobj); |
1da177e4 | 206 | |
79a6ee42 | 207 | static inline struct kset *to_kset(struct kobject *kobj) |
1da177e4 | 208 | { |
79a6ee42 | 209 | return kobj ? container_of(kobj, struct kset, kobj) : NULL; |
1da177e4 LT |
210 | } |
211 | ||
79a6ee42 | 212 | static inline struct kset *kset_get(struct kset *k) |
1da177e4 LT |
213 | { |
214 | return k ? to_kset(kobject_get(&k->kobj)) : NULL; | |
215 | } | |
216 | ||
79a6ee42 | 217 | static inline void kset_put(struct kset *k) |
1da177e4 LT |
218 | { |
219 | kobject_put(&k->kobj); | |
220 | } | |
221 | ||
3514faca | 222 | static inline struct kobj_type *get_ktype(struct kobject *kobj) |
1da177e4 | 223 | { |
3514faca | 224 | return kobj->ktype; |
1da177e4 LT |
225 | } |
226 | ||
79a6ee42 | 227 | extern struct kobject *kset_find_obj(struct kset *, const char *); |
1da177e4 | 228 | |
0ff21e46 GKH |
229 | /* The global /sys/kernel/ kobject for people to chain off of */ |
230 | extern struct kobject *kernel_kobj; | |
ff7ea79c NA |
231 | /* The global /sys/kernel/mm/ kobject for people to chain off of */ |
232 | extern struct kobject *mm_kobj; | |
2d72fc00 GKH |
233 | /* The global /sys/hypervisor/ kobject for people to chain off of */ |
234 | extern struct kobject *hypervisor_kobj; | |
d76e15fb GKH |
235 | /* The global /sys/power/ kobject for people to chain off of */ |
236 | extern struct kobject *power_kobj; | |
f62ed9e3 GKH |
237 | /* The global /sys/firmware/ kobject for people to chain off of */ |
238 | extern struct kobject *firmware_kobj; | |
1da177e4 | 239 | |
542cfce6 AK |
240 | int kobject_uevent(struct kobject *kobj, enum kobject_action action); |
241 | int kobject_uevent_env(struct kobject *kobj, enum kobject_action action, | |
8a82472f | 242 | char *envp[]); |
f36776fa | 243 | int kobject_synth_uevent(struct kobject *kobj, const char *buf, size_t count); |
0296b228 | 244 | |
b9075fa9 JP |
245 | __printf(2, 3) |
246 | int add_uevent_var(struct kobj_uevent_env *env, const char *format, ...); | |
5c5daf65 | 247 | |
1da177e4 | 248 | #endif /* _KOBJECT_H_ */ |