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