]> git.ipfire.org Git - thirdparty/kernel/stable.git/blame - include/linux/kobject.h
bpf: move tmp variable into ax register in interpreter
[thirdparty/kernel/stable.git] / include / linux / kobject.h
CommitLineData
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>
1da177e4 30
312c004d 31#define UEVENT_HELPER_PATH_LEN 256
7eff2e7a
KS
32#define UEVENT_NUM_ENVP 32 /* number of env pointers */
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 37extern char uevent_helper[];
86d56134 38#endif
0296b228 39
312c004d
KS
40/* counter to tag the uevent, read only except for the kobject core */
41extern 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 53enum 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,
60a96a59 62 KOBJ_MAX
0296b228
KS
63};
64
1da177e4 65struct kobject {
af5ca3f4 66 const char *name;
1da177e4 67 struct list_head entry;
79a6ee42
GKH
68 struct kobject *parent;
69 struct kset *kset;
70 struct kobj_type *ktype;
f7025709 71 struct kernfs_node *sd; /* sysfs directory entry */
a231934b 72 struct kref kref;
c817a67e
RK
73#ifdef CONFIG_DEBUG_KOBJECT_RELEASE
74 struct delayed_work release;
75#endif
0f4dafc0 76 unsigned int state_initialized:1;
0f4dafc0
KS
77 unsigned int state_in_sysfs:1;
78 unsigned int state_add_uevent_sent:1;
79 unsigned int state_remove_uevent_sent:1;
f67f129e 80 unsigned int uevent_suppress:1;
1da177e4
LT
81};
82
b9075fa9
JP
83extern __printf(2, 3)
84int kobject_set_name(struct kobject *kobj, const char *name, ...);
8db14860
NI
85extern __printf(2, 0)
86int kobject_set_name_vargs(struct kobject *kobj, const char *fmt,
87 va_list vargs);
1da177e4 88
79a6ee42 89static inline const char *kobject_name(const struct kobject *kobj)
1da177e4 90{
af5ca3f4 91 return kobj->name;
1da177e4
LT
92}
93
f9cb074b 94extern void kobject_init(struct kobject *kobj, struct kobj_type *ktype);
b9075fa9
JP
95extern __printf(3, 4) __must_check
96int kobject_add(struct kobject *kobj, struct kobject *parent,
97 const char *fmt, ...);
98extern __printf(4, 5) __must_check
99int kobject_init_and_add(struct kobject *kobj,
100 struct kobj_type *ktype, struct kobject *parent,
101 const char *fmt, ...);
c11c4154 102
79a6ee42 103extern void kobject_del(struct kobject *kobj);
1da177e4 104
43968d2f 105extern struct kobject * __must_check kobject_create(void);
3f9e3ee9
GKH
106extern struct kobject * __must_check kobject_create_and_add(const char *name,
107 struct kobject *parent);
108
4a7fb636 109extern int __must_check kobject_rename(struct kobject *, const char *new_name);
8a82472f 110extern int __must_check kobject_move(struct kobject *, struct kobject *);
1da177e4 111
79a6ee42 112extern struct kobject *kobject_get(struct kobject *kobj);
c70c176f
JK
113extern struct kobject * __must_check kobject_get_unless_zero(
114 struct kobject *kobj);
79a6ee42 115extern void kobject_put(struct kobject *kobj);
1da177e4 116
e34ff490 117extern const void *kobject_namespace(struct kobject *kobj);
79a6ee42 118extern char *kobject_get_path(struct kobject *kobj, gfp_t flag);
1da177e4 119
2f4da60e
BH
120/**
121 * kobject_has_children - Returns whether a kobject has children.
122 * @kobj: the object to test
123 *
124 * This will return whether a kobject has other kobjects as children.
125 *
126 * It does NOT account for the presence of attribute files, only sub
127 * directories. It also assumes there is no concurrent addition or
128 * removal of such children, and thus relies on external locking.
129 */
130static inline bool kobject_has_children(struct kobject *kobj)
131{
132 WARN_ON_ONCE(kref_read(&kobj->kref) == 0);
133
134 return kobj->sd && kobj->sd->dir.subdirs;
135}
136
1da177e4 137struct kobj_type {
79a6ee42 138 void (*release)(struct kobject *kobj);
52cf25d0 139 const struct sysfs_ops *sysfs_ops;
79a6ee42 140 struct attribute **default_attrs;
bc451f20
EB
141 const struct kobj_ns_type_operations *(*child_ns_type)(struct kobject *kobj);
142 const void *(*namespace)(struct kobject *kobj);
1da177e4
LT
143};
144
7eff2e7a 145struct kobj_uevent_env {
bcccff93 146 char *argv[3];
7eff2e7a
KS
147 char *envp[UEVENT_NUM_ENVP];
148 int envp_idx;
149 char buf[UEVENT_BUFFER_SIZE];
150 int buflen;
151};
152
a5615648 153struct kset_uevent_ops {
9cd43611
ER
154 int (* const filter)(struct kset *kset, struct kobject *kobj);
155 const char *(* const name)(struct kset *kset, struct kobject *kobj);
156 int (* const uevent)(struct kset *kset, struct kobject *kobj,
7eff2e7a 157 struct kobj_uevent_env *env);
a5615648 158};
1da177e4 159
23b5212c
KS
160struct kobj_attribute {
161 struct attribute attr;
162 ssize_t (*show)(struct kobject *kobj, struct kobj_attribute *attr,
163 char *buf);
164 ssize_t (*store)(struct kobject *kobj, struct kobj_attribute *attr,
165 const char *buf, size_t count);
166};
167
52cf25d0 168extern const struct sysfs_ops kobj_sysfs_ops;
23b5212c 169
bc451f20 170struct sock;
be867b19 171
6adf7554
GKH
172/**
173 * struct kset - a set of kobjects of a specific type, belonging to a specific subsystem.
1da177e4 174 *
6adf7554
GKH
175 * A kset defines a group of kobjects. They can be individually
176 * different "types" but overall these kobjects all want to be grouped
177 * together and operated on in the same manner. ksets are used to
178 * define the attribute callbacks and other common events that happen to
179 * a kobject.
1da177e4 180 *
6adf7554
GKH
181 * @list: the list of all kobjects for this kset
182 * @list_lock: a lock for iterating over the kobjects
183 * @kobj: the embedded kobject for this kset (recursion, isn't it fun...)
184 * @uevent_ops: the set of uevent operations for this kset. These are
185 * called whenever a kobject has something happen to it so that the kset
186 * can add new environment variables, or filter out the uevents if so
187 * desired.
1da177e4 188 */
1da177e4 189struct kset {
79a6ee42
GKH
190 struct list_head list;
191 spinlock_t list_lock;
192 struct kobject kobj;
9cd43611 193 const struct kset_uevent_ops *uevent_ops;
3859a271 194} __randomize_layout;
1da177e4 195
79a6ee42
GKH
196extern void kset_init(struct kset *kset);
197extern int __must_check kset_register(struct kset *kset);
198extern void kset_unregister(struct kset *kset);
b727c702 199extern struct kset * __must_check kset_create_and_add(const char *name,
9cd43611 200 const struct kset_uevent_ops *u,
b727c702 201 struct kobject *parent_kobj);
1da177e4 202
79a6ee42 203static inline struct kset *to_kset(struct kobject *kobj)
1da177e4 204{
79a6ee42 205 return kobj ? container_of(kobj, struct kset, kobj) : NULL;
1da177e4
LT
206}
207
79a6ee42 208static inline struct kset *kset_get(struct kset *k)
1da177e4
LT
209{
210 return k ? to_kset(kobject_get(&k->kobj)) : NULL;
211}
212
79a6ee42 213static inline void kset_put(struct kset *k)
1da177e4
LT
214{
215 kobject_put(&k->kobj);
216}
217
3514faca 218static inline struct kobj_type *get_ktype(struct kobject *kobj)
1da177e4 219{
3514faca 220 return kobj->ktype;
1da177e4
LT
221}
222
79a6ee42 223extern struct kobject *kset_find_obj(struct kset *, const char *);
1da177e4 224
0ff21e46
GKH
225/* The global /sys/kernel/ kobject for people to chain off of */
226extern struct kobject *kernel_kobj;
ff7ea79c
NA
227/* The global /sys/kernel/mm/ kobject for people to chain off of */
228extern struct kobject *mm_kobj;
2d72fc00
GKH
229/* The global /sys/hypervisor/ kobject for people to chain off of */
230extern struct kobject *hypervisor_kobj;
d76e15fb
GKH
231/* The global /sys/power/ kobject for people to chain off of */
232extern struct kobject *power_kobj;
f62ed9e3
GKH
233/* The global /sys/firmware/ kobject for people to chain off of */
234extern struct kobject *firmware_kobj;
1da177e4 235
542cfce6
AK
236int kobject_uevent(struct kobject *kobj, enum kobject_action action);
237int kobject_uevent_env(struct kobject *kobj, enum kobject_action action,
8a82472f 238 char *envp[]);
f36776fa 239int kobject_synth_uevent(struct kobject *kobj, const char *buf, size_t count);
0296b228 240
b9075fa9
JP
241__printf(2, 3)
242int add_uevent_var(struct kobj_uevent_env *env, const char *format, ...);
5c5daf65 243
1da177e4 244#endif /* _KOBJECT_H_ */