]>
git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blob - include/linux/kobject.h
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-2008 Greg Kroah-Hartman <greg@kroah.com>
7 * Copyright (c) 2006-2008 Novell Inc.
9 * This file is released under the GPLv2.
11 * Please read Documentation/kobject.txt before using the kobject
12 * interface, ESPECIALLY the parts about reference counts and object
19 #include <linux/types.h>
20 #include <linux/list.h>
21 #include <linux/sysfs.h>
22 #include <linux/compiler.h>
23 #include <linux/spinlock.h>
24 #include <linux/kref.h>
25 #include <linux/kobject_ns.h>
26 #include <linux/kernel.h>
27 #include <linux/wait.h>
28 #include <linux/atomic.h>
29 #include <linux/workqueue.h>
30 #include <linux/uidgid.h>
32 #define UEVENT_HELPER_PATH_LEN 256
33 #define UEVENT_NUM_ENVP 32 /* number of env pointers */
34 #define UEVENT_BUFFER_SIZE 2048 /* buffer for the variables */
36 #ifdef CONFIG_UEVENT_HELPER
37 /* path to the userspace helper executed on an event */
38 extern char uevent_helper
[];
41 /* counter to tag the uevent, read only except for the kobject core */
42 extern u64 uevent_seqnum
;
45 * The actions here must match the index to the string array
46 * in lib/kobject_uevent.c
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.
68 struct list_head entry
;
69 struct kobject
*parent
;
71 struct kobj_type
*ktype
;
72 struct kernfs_node
*sd
; /* sysfs directory entry */
74 #ifdef CONFIG_DEBUG_KOBJECT_RELEASE
75 struct delayed_work release
;
77 unsigned int state_initialized
:1;
78 unsigned int state_in_sysfs
:1;
79 unsigned int state_add_uevent_sent
:1;
80 unsigned int state_remove_uevent_sent
:1;
81 unsigned int uevent_suppress
:1;
85 int kobject_set_name(struct kobject
*kobj
, const char *name
, ...);
87 int kobject_set_name_vargs(struct kobject
*kobj
, const char *fmt
,
90 static inline const char *kobject_name(const struct kobject
*kobj
)
95 extern void kobject_init(struct kobject
*kobj
, struct kobj_type
*ktype
);
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
, ...);
104 extern void kobject_del(struct kobject
*kobj
);
106 extern struct kobject
* __must_check
kobject_create(void);
107 extern struct kobject
* __must_check
kobject_create_and_add(const char *name
,
108 struct kobject
*parent
);
110 extern int __must_check
kobject_rename(struct kobject
*, const char *new_name
);
111 extern int __must_check
kobject_move(struct kobject
*, struct kobject
*);
113 extern struct kobject
*kobject_get(struct kobject
*kobj
);
114 extern struct kobject
* __must_check
kobject_get_unless_zero(
115 struct kobject
*kobj
);
116 extern void kobject_put(struct kobject
*kobj
);
118 extern const void *kobject_namespace(struct kobject
*kobj
);
119 extern void kobject_get_ownership(struct kobject
*kobj
,
120 kuid_t
*uid
, kgid_t
*gid
);
121 extern char *kobject_get_path(struct kobject
*kobj
, gfp_t flag
);
124 * kobject_has_children - Returns whether a kobject has children.
125 * @kobj: the object to test
127 * This will return whether a kobject has other kobjects as children.
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.
133 static inline bool kobject_has_children(struct kobject
*kobj
)
135 WARN_ON_ONCE(kref_read(&kobj
->kref
) == 0);
137 return kobj
->sd
&& kobj
->sd
->dir
.subdirs
;
141 void (*release
)(struct kobject
*kobj
);
142 const struct sysfs_ops
*sysfs_ops
;
143 struct attribute
**default_attrs
;
144 const struct kobj_ns_type_operations
*(*child_ns_type
)(struct kobject
*kobj
);
145 const void *(*namespace)(struct kobject
*kobj
);
146 void (*get_ownership
)(struct kobject
*kobj
, kuid_t
*uid
, kgid_t
*gid
);
149 struct kobj_uevent_env
{
151 char *envp
[UEVENT_NUM_ENVP
];
153 char buf
[UEVENT_BUFFER_SIZE
];
157 struct kset_uevent_ops
{
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
,
161 struct kobj_uevent_env
*env
);
164 struct kobj_attribute
{
165 struct attribute attr
;
166 ssize_t (*show
)(struct kobject
*kobj
, struct kobj_attribute
*attr
,
168 ssize_t (*store
)(struct kobject
*kobj
, struct kobj_attribute
*attr
,
169 const char *buf
, size_t count
);
172 extern const struct sysfs_ops kobj_sysfs_ops
;
177 * struct kset - a set of kobjects of a specific type, belonging to a specific subsystem.
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
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
194 struct list_head list
;
195 spinlock_t list_lock
;
197 const struct kset_uevent_ops
*uevent_ops
;
198 } __randomize_layout
;
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
);
203 extern struct kset
* __must_check
kset_create_and_add(const char *name
,
204 const struct kset_uevent_ops
*u
,
205 struct kobject
*parent_kobj
);
207 static inline struct kset
*to_kset(struct kobject
*kobj
)
209 return kobj
? container_of(kobj
, struct kset
, kobj
) : NULL
;
212 static inline struct kset
*kset_get(struct kset
*k
)
214 return k
? to_kset(kobject_get(&k
->kobj
)) : NULL
;
217 static inline void kset_put(struct kset
*k
)
219 kobject_put(&k
->kobj
);
222 static inline struct kobj_type
*get_ktype(struct kobject
*kobj
)
227 extern struct kobject
*kset_find_obj(struct kset
*, const char *);
229 /* The global /sys/kernel/ kobject for people to chain off of */
230 extern struct kobject
*kernel_kobj
;
231 /* The global /sys/kernel/mm/ kobject for people to chain off of */
232 extern struct kobject
*mm_kobj
;
233 /* The global /sys/hypervisor/ kobject for people to chain off of */
234 extern struct kobject
*hypervisor_kobj
;
235 /* The global /sys/power/ kobject for people to chain off of */
236 extern struct kobject
*power_kobj
;
237 /* The global /sys/firmware/ kobject for people to chain off of */
238 extern struct kobject
*firmware_kobj
;
240 int kobject_uevent(struct kobject
*kobj
, enum kobject_action action
);
241 int kobject_uevent_env(struct kobject
*kobj
, enum kobject_action action
,
243 int kobject_synth_uevent(struct kobject
*kobj
, const char *buf
, size_t count
);
246 int add_uevent_var(struct kobj_uevent_env
*env
, const char *format
, ...);
248 #endif /* _KOBJECT_H_ */