Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /* |
| 2 | * kobject.h - generic kernel object infrastructure. |
| 3 | * |
| 4 | * Copyright (c) 2002-2003 Patrick Mochel |
| 5 | * Copyright (c) 2002-2003 Open Source Development Labs |
| 6 | * |
| 7 | * This file is released under the GPLv2. |
| 8 | * |
| 9 | * |
| 10 | * Please read Documentation/kobject.txt before using the kobject |
| 11 | * interface, ESPECIALLY the parts about reference counts and object |
| 12 | * destructors. |
| 13 | */ |
| 14 | |
| 15 | #ifndef _KOBJECT_H_ |
| 16 | #define _KOBJECT_H_ |
| 17 | |
| 18 | #ifdef __KERNEL__ |
| 19 | |
| 20 | #include <linux/types.h> |
| 21 | #include <linux/list.h> |
| 22 | #include <linux/sysfs.h> |
Andrew Morton | 4a7fb63 | 2006-08-14 22:43:17 -0700 | [diff] [blame] | 23 | #include <linux/compiler.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 24 | #include <linux/spinlock.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 25 | #include <linux/kref.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 26 | #include <linux/kernel.h> |
NeilBrown | 4508a7a | 2006-03-20 17:53:53 +1100 | [diff] [blame] | 27 | #include <linux/wait.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 28 | #include <asm/atomic.h> |
| 29 | |
Kay Sievers | 312c004 | 2005-11-16 09:00:00 +0100 | [diff] [blame] | 30 | #define KOBJ_NAME_LEN 20 |
| 31 | #define UEVENT_HELPER_PATH_LEN 256 |
Kay Sievers | 0296b22 | 2005-11-11 05:33:52 +0100 | [diff] [blame] | 32 | |
| 33 | /* path to the userspace helper executed on an event */ |
Kay Sievers | 312c004 | 2005-11-16 09:00:00 +0100 | [diff] [blame] | 34 | extern char uevent_helper[]; |
Kay Sievers | 0296b22 | 2005-11-11 05:33:52 +0100 | [diff] [blame] | 35 | |
Kay Sievers | 312c004 | 2005-11-16 09:00:00 +0100 | [diff] [blame] | 36 | /* counter to tag the uevent, read only except for the kobject core */ |
| 37 | extern u64 uevent_seqnum; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 38 | |
Kay Sievers | 0296b22 | 2005-11-11 05:33:52 +0100 | [diff] [blame] | 39 | /* the actions here must match the proper string in lib/kobject_uevent.c */ |
| 40 | typedef int __bitwise kobject_action_t; |
| 41 | enum kobject_action { |
Kay Sievers | 5f123fb | 2005-11-11 14:43:07 +0100 | [diff] [blame] | 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 */ |
Adrian Bunk | 3106d46 | 2007-04-06 12:21:45 +0200 | [diff] [blame] | 45 | KOBJ_OFFLINE = (__force kobject_action_t) 0x04, /* device offline */ |
| 46 | KOBJ_ONLINE = (__force kobject_action_t) 0x05, /* device online */ |
| 47 | KOBJ_MOVE = (__force kobject_action_t) 0x06, /* device move */ |
Kay Sievers | 0296b22 | 2005-11-11 05:33:52 +0100 | [diff] [blame] | 48 | }; |
| 49 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 50 | struct kobject { |
Dmitry Torokhov | f3b4f3c | 2005-04-26 02:32:00 -0500 | [diff] [blame] | 51 | const char * k_name; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 52 | char name[KOBJ_NAME_LEN]; |
| 53 | struct kref kref; |
| 54 | struct list_head entry; |
| 55 | struct kobject * parent; |
| 56 | struct kset * kset; |
| 57 | struct kobj_type * ktype; |
| 58 | struct dentry * dentry; |
NeilBrown | 4508a7a | 2006-03-20 17:53:53 +1100 | [diff] [blame] | 59 | wait_queue_head_t poll; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 60 | }; |
| 61 | |
| 62 | extern int kobject_set_name(struct kobject *, const char *, ...) |
| 63 | __attribute__((format(printf,2,3))); |
| 64 | |
Dmitry Torokhov | f3b4f3c | 2005-04-26 02:32:00 -0500 | [diff] [blame] | 65 | static inline const char * kobject_name(const struct kobject * kobj) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 66 | { |
| 67 | return kobj->k_name; |
| 68 | } |
| 69 | |
| 70 | extern void kobject_init(struct kobject *); |
| 71 | extern void kobject_cleanup(struct kobject *); |
| 72 | |
Andrew Morton | 4a7fb63 | 2006-08-14 22:43:17 -0700 | [diff] [blame] | 73 | extern int __must_check kobject_add(struct kobject *); |
Eric W. Biederman | b592fcf | 2007-01-24 12:35:52 -0700 | [diff] [blame] | 74 | extern int __must_check kobject_shadow_add(struct kobject *, struct dentry *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 75 | extern void kobject_del(struct kobject *); |
| 76 | |
Andrew Morton | 4a7fb63 | 2006-08-14 22:43:17 -0700 | [diff] [blame] | 77 | extern int __must_check kobject_rename(struct kobject *, const char *new_name); |
Eric W. Biederman | b592fcf | 2007-01-24 12:35:52 -0700 | [diff] [blame] | 78 | extern int __must_check kobject_shadow_rename(struct kobject *kobj, |
| 79 | struct dentry *new_parent, |
| 80 | const char *new_name); |
Cornelia Huck | 8a82472 | 2006-11-20 17:07:51 +0100 | [diff] [blame] | 81 | extern int __must_check kobject_move(struct kobject *, struct kobject *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 82 | |
Andrew Morton | 4a7fb63 | 2006-08-14 22:43:17 -0700 | [diff] [blame] | 83 | extern int __must_check kobject_register(struct kobject *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 84 | extern void kobject_unregister(struct kobject *); |
| 85 | |
| 86 | extern struct kobject * kobject_get(struct kobject *); |
| 87 | extern void kobject_put(struct kobject *); |
| 88 | |
Kay Sievers | 8640624 | 2007-03-14 03:25:56 +0100 | [diff] [blame] | 89 | extern struct kobject *kobject_kset_add_dir(struct kset *kset, |
| 90 | struct kobject *, const char *); |
Jun'ichi Nomura | 7423172 | 2006-03-13 17:14:25 -0500 | [diff] [blame] | 91 | extern struct kobject *kobject_add_dir(struct kobject *, const char *); |
| 92 | |
Al Viro | fd4f2df | 2005-10-21 03:18:50 -0400 | [diff] [blame] | 93 | extern char * kobject_get_path(struct kobject *, gfp_t); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 94 | |
| 95 | struct kobj_type { |
| 96 | void (*release)(struct kobject *); |
| 97 | struct sysfs_ops * sysfs_ops; |
| 98 | struct attribute ** default_attrs; |
| 99 | }; |
| 100 | |
| 101 | |
| 102 | /** |
| 103 | * kset - a set of kobjects of a specific type, belonging |
| 104 | * to a specific subsystem. |
| 105 | * |
| 106 | * All kobjects of a kset should be embedded in an identical |
| 107 | * type. This type may have a descriptor, which the kset points |
| 108 | * to. This allows there to exist sets of objects of the same |
| 109 | * type in different subsystems. |
| 110 | * |
| 111 | * A subsystem does not have to be a list of only one type |
| 112 | * of object; multiple ksets can belong to one subsystem. All |
| 113 | * ksets of a subsystem share the subsystem's lock. |
| 114 | * |
Kay Sievers | 312c004 | 2005-11-16 09:00:00 +0100 | [diff] [blame] | 115 | * Each kset can support specific event variables; it can |
| 116 | * supress the event generation or add subsystem specific |
| 117 | * variables carried with the event. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 118 | */ |
Kay Sievers | 312c004 | 2005-11-16 09:00:00 +0100 | [diff] [blame] | 119 | struct kset_uevent_ops { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 120 | int (*filter)(struct kset *kset, struct kobject *kobj); |
Dmitry Torokhov | 419cab3 | 2005-04-26 02:32:54 -0500 | [diff] [blame] | 121 | const char *(*name)(struct kset *kset, struct kobject *kobj); |
Kay Sievers | 312c004 | 2005-11-16 09:00:00 +0100 | [diff] [blame] | 122 | int (*uevent)(struct kset *kset, struct kobject *kobj, char **envp, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 123 | int num_envp, char *buffer, int buffer_size); |
| 124 | }; |
| 125 | |
| 126 | struct kset { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 127 | struct kobj_type * ktype; |
| 128 | struct list_head list; |
| 129 | spinlock_t list_lock; |
| 130 | struct kobject kobj; |
Kay Sievers | 312c004 | 2005-11-16 09:00:00 +0100 | [diff] [blame] | 131 | struct kset_uevent_ops * uevent_ops; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 132 | }; |
| 133 | |
| 134 | |
| 135 | extern void kset_init(struct kset * k); |
Andrew Morton | 4a7fb63 | 2006-08-14 22:43:17 -0700 | [diff] [blame] | 136 | extern int __must_check kset_add(struct kset * k); |
| 137 | extern int __must_check kset_register(struct kset * k); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 138 | extern void kset_unregister(struct kset * k); |
| 139 | |
| 140 | static inline struct kset * to_kset(struct kobject * kobj) |
| 141 | { |
| 142 | return kobj ? container_of(kobj,struct kset,kobj) : NULL; |
| 143 | } |
| 144 | |
| 145 | static inline struct kset * kset_get(struct kset * k) |
| 146 | { |
| 147 | return k ? to_kset(kobject_get(&k->kobj)) : NULL; |
| 148 | } |
| 149 | |
| 150 | static inline void kset_put(struct kset * k) |
| 151 | { |
| 152 | kobject_put(&k->kobj); |
| 153 | } |
| 154 | |
| 155 | static inline struct kobj_type * get_ktype(struct kobject * k) |
| 156 | { |
| 157 | if (k->kset && k->kset->ktype) |
| 158 | return k->kset->ktype; |
| 159 | else |
| 160 | return k->ktype; |
| 161 | } |
| 162 | |
| 163 | extern struct kobject * kset_find_obj(struct kset *, const char *); |
| 164 | |
| 165 | |
| 166 | /** |
| 167 | * Use this when initializing an embedded kset with no other |
| 168 | * fields to initialize. |
| 169 | */ |
| 170 | #define set_kset_name(str) .kset = { .kobj = { .name = str } } |
| 171 | |
| 172 | |
Kay Sievers | 312c004 | 2005-11-16 09:00:00 +0100 | [diff] [blame] | 173 | #define decl_subsys(_name,_type,_uevent_ops) \ |
Greg Kroah-Hartman | 823bccf | 2007-04-13 13:15:19 -0700 | [diff] [blame] | 174 | struct kset _name##_subsys = { \ |
| 175 | .kobj = { .name = __stringify(_name) }, \ |
| 176 | .ktype = _type, \ |
| 177 | .uevent_ops =_uevent_ops, \ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 178 | } |
Kay Sievers | 312c004 | 2005-11-16 09:00:00 +0100 | [diff] [blame] | 179 | #define decl_subsys_name(_varname,_name,_type,_uevent_ops) \ |
Greg Kroah-Hartman | 823bccf | 2007-04-13 13:15:19 -0700 | [diff] [blame] | 180 | struct kset _varname##_subsys = { \ |
| 181 | .kobj = { .name = __stringify(_name) }, \ |
| 182 | .ktype = _type, \ |
| 183 | .uevent_ops =_uevent_ops, \ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 184 | } |
| 185 | |
| 186 | /* The global /sys/kernel/ subsystem for people to chain off of */ |
Greg Kroah-Hartman | 823bccf | 2007-04-13 13:15:19 -0700 | [diff] [blame] | 187 | extern struct kset kernel_subsys; |
Michael Holzheu | 4039483 | 2006-05-09 12:53:49 +0200 | [diff] [blame] | 188 | /* The global /sys/hypervisor/ subsystem */ |
Greg Kroah-Hartman | 823bccf | 2007-04-13 13:15:19 -0700 | [diff] [blame] | 189 | extern struct kset hypervisor_subsys; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 190 | |
| 191 | /** |
| 192 | * Helpers for setting the kset of registered objects. |
| 193 | * Often, a registered object belongs to a kset embedded in a |
| 194 | * subsystem. These do no magic, just make the resulting code |
| 195 | * easier to follow. |
| 196 | */ |
| 197 | |
| 198 | /** |
| 199 | * kobj_set_kset_s(obj,subsys) - set kset for embedded kobject. |
| 200 | * @obj: ptr to some object type. |
| 201 | * @subsys: a subsystem object (not a ptr). |
| 202 | * |
| 203 | * Can be used for any object type with an embedded ->kobj. |
| 204 | */ |
| 205 | |
| 206 | #define kobj_set_kset_s(obj,subsys) \ |
Greg Kroah-Hartman | 823bccf | 2007-04-13 13:15:19 -0700 | [diff] [blame] | 207 | (obj)->kobj.kset = &(subsys) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 208 | |
| 209 | /** |
| 210 | * kset_set_kset_s(obj,subsys) - set kset for embedded kset. |
| 211 | * @obj: ptr to some object type. |
| 212 | * @subsys: a subsystem object (not a ptr). |
| 213 | * |
| 214 | * Can be used for any object type with an embedded ->kset. |
| 215 | * Sets the kset of @obj's embedded kobject (via its embedded |
| 216 | * kset) to @subsys.kset. This makes @obj a member of that |
| 217 | * kset. |
| 218 | */ |
| 219 | |
| 220 | #define kset_set_kset_s(obj,subsys) \ |
Greg Kroah-Hartman | 823bccf | 2007-04-13 13:15:19 -0700 | [diff] [blame] | 221 | (obj)->kset.kobj.kset = &(subsys) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 222 | |
| 223 | /** |
| 224 | * subsys_set_kset(obj,subsys) - set kset for subsystem |
| 225 | * @obj: ptr to some object type. |
| 226 | * @subsys: a subsystem object (not a ptr). |
| 227 | * |
| 228 | * Can be used for any object type with an embedded ->subsys. |
| 229 | * Sets the kset of @obj's kobject to @subsys.kset. This makes |
| 230 | * the object a member of that kset. |
| 231 | */ |
| 232 | |
| 233 | #define subsys_set_kset(obj,_subsys) \ |
Greg Kroah-Hartman | 823bccf | 2007-04-13 13:15:19 -0700 | [diff] [blame] | 234 | (obj)->subsys.kobj.kset = &(_subsys) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 235 | |
Greg Kroah-Hartman | 823bccf | 2007-04-13 13:15:19 -0700 | [diff] [blame] | 236 | extern void subsystem_init(struct kset *); |
| 237 | extern int __must_check subsystem_register(struct kset *); |
| 238 | extern void subsystem_unregister(struct kset *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 239 | |
Greg Kroah-Hartman | 823bccf | 2007-04-13 13:15:19 -0700 | [diff] [blame] | 240 | static inline struct kset *subsys_get(struct kset *s) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 241 | { |
Greg Kroah-Hartman | 823bccf | 2007-04-13 13:15:19 -0700 | [diff] [blame] | 242 | if (s) |
| 243 | return kset_get(s); |
| 244 | return NULL; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 245 | } |
| 246 | |
Greg Kroah-Hartman | 823bccf | 2007-04-13 13:15:19 -0700 | [diff] [blame] | 247 | static inline void subsys_put(struct kset *s) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 248 | { |
Greg Kroah-Hartman | 823bccf | 2007-04-13 13:15:19 -0700 | [diff] [blame] | 249 | kset_put(s); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 250 | } |
| 251 | |
| 252 | struct subsys_attribute { |
| 253 | struct attribute attr; |
Greg Kroah-Hartman | 823bccf | 2007-04-13 13:15:19 -0700 | [diff] [blame] | 254 | ssize_t (*show)(struct kset *, char *); |
| 255 | ssize_t (*store)(struct kset *, const char *, size_t); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 256 | }; |
| 257 | |
Greg Kroah-Hartman | 823bccf | 2007-04-13 13:15:19 -0700 | [diff] [blame] | 258 | extern int __must_check subsys_create_file(struct kset *, |
Andrew Morton | 4a7fb63 | 2006-08-14 22:43:17 -0700 | [diff] [blame] | 259 | struct subsys_attribute *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 260 | |
Kay Sievers | 4d17ffd | 2006-04-25 15:37:26 +0200 | [diff] [blame] | 261 | #if defined(CONFIG_HOTPLUG) |
Aneesh Kumar K.V | 542cfce | 2006-12-19 13:01:27 -0800 | [diff] [blame] | 262 | int kobject_uevent(struct kobject *kobj, enum kobject_action action); |
| 263 | int kobject_uevent_env(struct kobject *kobj, enum kobject_action action, |
Cornelia Huck | 8a82472 | 2006-11-20 17:07:51 +0100 | [diff] [blame] | 264 | char *envp[]); |
Kay Sievers | 0296b22 | 2005-11-11 05:33:52 +0100 | [diff] [blame] | 265 | |
Kay Sievers | 312c004 | 2005-11-16 09:00:00 +0100 | [diff] [blame] | 266 | int add_uevent_var(char **envp, int num_envp, int *cur_index, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 267 | char *buffer, int buffer_size, int *cur_len, |
| 268 | const char *format, ...) |
| 269 | __attribute__((format (printf, 7, 8))); |
| 270 | #else |
Aneesh Kumar K.V | 542cfce | 2006-12-19 13:01:27 -0800 | [diff] [blame] | 271 | static inline int kobject_uevent(struct kobject *kobj, enum kobject_action action) |
| 272 | { return 0; } |
| 273 | static inline int kobject_uevent_env(struct kobject *kobj, |
Cornelia Huck | 8a82472 | 2006-11-20 17:07:51 +0100 | [diff] [blame] | 274 | enum kobject_action action, |
| 275 | char *envp[]) |
Aneesh Kumar K.V | 542cfce | 2006-12-19 13:01:27 -0800 | [diff] [blame] | 276 | { return 0; } |
Kay Sievers | 5f123fb | 2005-11-11 14:43:07 +0100 | [diff] [blame] | 277 | |
Kay Sievers | 312c004 | 2005-11-16 09:00:00 +0100 | [diff] [blame] | 278 | static inline int add_uevent_var(char **envp, int num_envp, int *cur_index, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 279 | char *buffer, int buffer_size, int *cur_len, |
| 280 | const char *format, ...) |
| 281 | { return 0; } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 282 | #endif |
| 283 | |
| 284 | #endif /* __KERNEL__ */ |
| 285 | #endif /* _KOBJECT_H_ */ |