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> |
1da177e4 LT |
28 | #include <asm/atomic.h> |
29 | ||
312c004d | 30 | #define UEVENT_HELPER_PATH_LEN 256 |
7eff2e7a KS |
31 | #define UEVENT_NUM_ENVP 32 /* number of env pointers */ |
32 | #define UEVENT_BUFFER_SIZE 2048 /* buffer for the variables */ | |
0296b228 KS |
33 | |
34 | /* path to the userspace helper executed on an event */ | |
312c004d | 35 | extern char uevent_helper[]; |
0296b228 | 36 | |
312c004d KS |
37 | /* counter to tag the uevent, read only except for the kobject core */ |
38 | extern u64 uevent_seqnum; | |
1da177e4 | 39 | |
60a96a59 KS |
40 | /* |
41 | * The actions here must match the index to the string array | |
42 | * in lib/kobject_uevent.c | |
43 | * | |
44 | * Do not add new actions here without checking with the driver-core | |
45 | * maintainers. Action strings are not meant to express subsystem | |
46 | * or device specific properties. In most cases you want to send a | |
47 | * kobject_uevent_env(kobj, KOBJ_CHANGE, env) with additional event | |
48 | * specific variables added to the event environment. | |
49 | */ | |
0296b228 | 50 | enum kobject_action { |
60a96a59 KS |
51 | KOBJ_ADD, |
52 | KOBJ_REMOVE, | |
53 | KOBJ_CHANGE, | |
54 | KOBJ_MOVE, | |
55 | KOBJ_ONLINE, | |
56 | KOBJ_OFFLINE, | |
57 | KOBJ_MAX | |
0296b228 KS |
58 | }; |
59 | ||
1da177e4 | 60 | struct kobject { |
af5ca3f4 | 61 | const char *name; |
1da177e4 | 62 | struct list_head entry; |
79a6ee42 GKH |
63 | struct kobject *parent; |
64 | struct kset *kset; | |
65 | struct kobj_type *ktype; | |
66 | struct sysfs_dirent *sd; | |
a231934b | 67 | struct kref kref; |
0f4dafc0 | 68 | unsigned int state_initialized:1; |
0f4dafc0 KS |
69 | unsigned int state_in_sysfs:1; |
70 | unsigned int state_add_uevent_sent:1; | |
71 | unsigned int state_remove_uevent_sent:1; | |
f67f129e | 72 | unsigned int uevent_suppress:1; |
1da177e4 LT |
73 | }; |
74 | ||
79a6ee42 GKH |
75 | extern int kobject_set_name(struct kobject *kobj, const char *name, ...) |
76 | __attribute__((format(printf, 2, 3))); | |
1fa5ae85 KS |
77 | extern int kobject_set_name_vargs(struct kobject *kobj, const char *fmt, |
78 | va_list vargs); | |
1da177e4 | 79 | |
79a6ee42 | 80 | static inline const char *kobject_name(const struct kobject *kobj) |
1da177e4 | 81 | { |
af5ca3f4 | 82 | return kobj->name; |
1da177e4 LT |
83 | } |
84 | ||
f9cb074b | 85 | extern void kobject_init(struct kobject *kobj, struct kobj_type *ktype); |
b2d6db58 GKH |
86 | extern int __must_check kobject_add(struct kobject *kobj, |
87 | struct kobject *parent, | |
9b99b7f8 BVA |
88 | const char *fmt, ...) |
89 | __attribute__((format(printf, 3, 4))); | |
c11c4154 GKH |
90 | extern int __must_check kobject_init_and_add(struct kobject *kobj, |
91 | struct kobj_type *ktype, | |
92 | struct kobject *parent, | |
9b99b7f8 BVA |
93 | const char *fmt, ...) |
94 | __attribute__((format(printf, 4, 5))); | |
c11c4154 | 95 | |
79a6ee42 | 96 | extern void kobject_del(struct kobject *kobj); |
1da177e4 | 97 | |
43968d2f | 98 | extern struct kobject * __must_check kobject_create(void); |
3f9e3ee9 GKH |
99 | extern struct kobject * __must_check kobject_create_and_add(const char *name, |
100 | struct kobject *parent); | |
101 | ||
4a7fb636 | 102 | extern int __must_check kobject_rename(struct kobject *, const char *new_name); |
8a82472f | 103 | extern int __must_check kobject_move(struct kobject *, struct kobject *); |
1da177e4 | 104 | |
79a6ee42 GKH |
105 | extern struct kobject *kobject_get(struct kobject *kobj); |
106 | extern void kobject_put(struct kobject *kobj); | |
1da177e4 | 107 | |
79a6ee42 | 108 | extern char *kobject_get_path(struct kobject *kobj, gfp_t flag); |
1da177e4 LT |
109 | |
110 | struct kobj_type { | |
79a6ee42 | 111 | void (*release)(struct kobject *kobj); |
52cf25d0 | 112 | const struct sysfs_ops *sysfs_ops; |
79a6ee42 | 113 | struct attribute **default_attrs; |
bc451f20 EB |
114 | const struct kobj_ns_type_operations *(*child_ns_type)(struct kobject *kobj); |
115 | const void *(*namespace)(struct kobject *kobj); | |
1da177e4 LT |
116 | }; |
117 | ||
7eff2e7a KS |
118 | struct kobj_uevent_env { |
119 | char *envp[UEVENT_NUM_ENVP]; | |
120 | int envp_idx; | |
121 | char buf[UEVENT_BUFFER_SIZE]; | |
122 | int buflen; | |
123 | }; | |
124 | ||
a5615648 | 125 | struct kset_uevent_ops { |
9cd43611 ER |
126 | int (* const filter)(struct kset *kset, struct kobject *kobj); |
127 | const char *(* const name)(struct kset *kset, struct kobject *kobj); | |
128 | int (* const uevent)(struct kset *kset, struct kobject *kobj, | |
7eff2e7a | 129 | struct kobj_uevent_env *env); |
a5615648 | 130 | }; |
1da177e4 | 131 | |
23b5212c KS |
132 | struct kobj_attribute { |
133 | struct attribute attr; | |
134 | ssize_t (*show)(struct kobject *kobj, struct kobj_attribute *attr, | |
135 | char *buf); | |
136 | ssize_t (*store)(struct kobject *kobj, struct kobj_attribute *attr, | |
137 | const char *buf, size_t count); | |
138 | }; | |
139 | ||
52cf25d0 | 140 | extern const struct sysfs_ops kobj_sysfs_ops; |
23b5212c | 141 | |
bc451f20 | 142 | struct sock; |
be867b19 | 143 | |
6adf7554 GKH |
144 | /** |
145 | * struct kset - a set of kobjects of a specific type, belonging to a specific subsystem. | |
1da177e4 | 146 | * |
6adf7554 GKH |
147 | * A kset defines a group of kobjects. They can be individually |
148 | * different "types" but overall these kobjects all want to be grouped | |
149 | * together and operated on in the same manner. ksets are used to | |
150 | * define the attribute callbacks and other common events that happen to | |
151 | * a kobject. | |
1da177e4 | 152 | * |
6adf7554 GKH |
153 | * @list: the list of all kobjects for this kset |
154 | * @list_lock: a lock for iterating over the kobjects | |
155 | * @kobj: the embedded kobject for this kset (recursion, isn't it fun...) | |
156 | * @uevent_ops: the set of uevent operations for this kset. These are | |
157 | * called whenever a kobject has something happen to it so that the kset | |
158 | * can add new environment variables, or filter out the uevents if so | |
159 | * desired. | |
1da177e4 | 160 | */ |
1da177e4 | 161 | struct kset { |
79a6ee42 GKH |
162 | struct list_head list; |
163 | spinlock_t list_lock; | |
164 | struct kobject kobj; | |
9cd43611 | 165 | const struct kset_uevent_ops *uevent_ops; |
1da177e4 LT |
166 | }; |
167 | ||
79a6ee42 GKH |
168 | extern void kset_init(struct kset *kset); |
169 | extern int __must_check kset_register(struct kset *kset); | |
170 | extern void kset_unregister(struct kset *kset); | |
b727c702 | 171 | extern struct kset * __must_check kset_create_and_add(const char *name, |
9cd43611 | 172 | const struct kset_uevent_ops *u, |
b727c702 | 173 | struct kobject *parent_kobj); |
1da177e4 | 174 | |
79a6ee42 | 175 | static inline struct kset *to_kset(struct kobject *kobj) |
1da177e4 | 176 | { |
79a6ee42 | 177 | return kobj ? container_of(kobj, struct kset, kobj) : NULL; |
1da177e4 LT |
178 | } |
179 | ||
79a6ee42 | 180 | static inline struct kset *kset_get(struct kset *k) |
1da177e4 LT |
181 | { |
182 | return k ? to_kset(kobject_get(&k->kobj)) : NULL; | |
183 | } | |
184 | ||
79a6ee42 | 185 | static inline void kset_put(struct kset *k) |
1da177e4 LT |
186 | { |
187 | kobject_put(&k->kobj); | |
188 | } | |
189 | ||
3514faca | 190 | static inline struct kobj_type *get_ktype(struct kobject *kobj) |
1da177e4 | 191 | { |
3514faca | 192 | return kobj->ktype; |
1da177e4 LT |
193 | } |
194 | ||
79a6ee42 | 195 | extern struct kobject *kset_find_obj(struct kset *, const char *); |
c25d1dfb RH |
196 | extern struct kobject *kset_find_obj_hinted(struct kset *, const char *, |
197 | struct kobject *); | |
1da177e4 | 198 | |
0ff21e46 GKH |
199 | /* The global /sys/kernel/ kobject for people to chain off of */ |
200 | extern struct kobject *kernel_kobj; | |
ff7ea79c NA |
201 | /* The global /sys/kernel/mm/ kobject for people to chain off of */ |
202 | extern struct kobject *mm_kobj; | |
2d72fc00 GKH |
203 | /* The global /sys/hypervisor/ kobject for people to chain off of */ |
204 | extern struct kobject *hypervisor_kobj; | |
d76e15fb GKH |
205 | /* The global /sys/power/ kobject for people to chain off of */ |
206 | extern struct kobject *power_kobj; | |
f62ed9e3 GKH |
207 | /* The global /sys/firmware/ kobject for people to chain off of */ |
208 | extern struct kobject *firmware_kobj; | |
1da177e4 | 209 | |
4d17ffda | 210 | #if defined(CONFIG_HOTPLUG) |
542cfce6 AK |
211 | int kobject_uevent(struct kobject *kobj, enum kobject_action action); |
212 | int kobject_uevent_env(struct kobject *kobj, enum kobject_action action, | |
8a82472f | 213 | char *envp[]); |
0296b228 | 214 | |
7eff2e7a KS |
215 | int add_uevent_var(struct kobj_uevent_env *env, const char *format, ...) |
216 | __attribute__((format (printf, 2, 3))); | |
5c5daf65 KS |
217 | |
218 | int kobject_action_type(const char *buf, size_t count, | |
219 | enum kobject_action *type); | |
1da177e4 | 220 | #else |
79a6ee42 GKH |
221 | static inline int kobject_uevent(struct kobject *kobj, |
222 | enum kobject_action action) | |
542cfce6 AK |
223 | { return 0; } |
224 | static inline int kobject_uevent_env(struct kobject *kobj, | |
8a82472f CH |
225 | enum kobject_action action, |
226 | char *envp[]) | |
542cfce6 | 227 | { return 0; } |
5f123fbd | 228 | |
b38360a2 RD |
229 | static inline __attribute__((format(printf, 2, 3))) |
230 | int add_uevent_var(struct kobj_uevent_env *env, const char *format, ...) | |
1da177e4 | 231 | { return 0; } |
5c5daf65 KS |
232 | |
233 | static inline int kobject_action_type(const char *buf, size_t count, | |
79a6ee42 | 234 | enum kobject_action *type) |
5c5daf65 | 235 | { return -EINVAL; } |
1da177e4 LT |
236 | #endif |
237 | ||
1da177e4 | 238 | #endif /* _KOBJECT_H_ */ |