~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/include/linux/kobject.h

Version: ~ [ linux-5.12-rc1 ] ~ [ linux-5.11.2 ] ~ [ linux-5.10.19 ] ~ [ linux-5.9.16 ] ~ [ linux-5.8.18 ] ~ [ linux-5.7.19 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.101 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.177 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.222 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.258 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.258 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.18.140 ] ~ [ linux-3.16.85 ] ~ [ linux-3.14.79 ] ~ [ linux-3.12.74 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

  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  * Copyright (c) 2006-2008 Greg Kroah-Hartman <greg@kroah.com>
  7  * Copyright (c) 2006-2008 Novell Inc.
  8  *
  9  * This file is released under the GPLv2.
 10  *
 11  * Please read Documentation/kobject.txt before using the kobject
 12  * interface, ESPECIALLY the parts about reference counts and object
 13  * destructors.
 14  */
 15 
 16 #ifndef _KOBJECT_H_
 17 #define _KOBJECT_H_
 18 
 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 
 31 #define UEVENT_HELPER_PATH_LEN          256
 32 #define UEVENT_NUM_ENVP                 32      /* number of env pointers */
 33 #define UEVENT_BUFFER_SIZE              2048    /* buffer for the variables */
 34 
 35 #ifdef CONFIG_UEVENT_HELPER
 36 /* path to the userspace helper executed on an event */
 37 extern char uevent_helper[];
 38 #endif
 39 
 40 /* counter to tag the uevent, read only except for the kobject core */
 41 extern u64 uevent_seqnum;
 42 
 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  */
 53 enum kobject_action {
 54         KOBJ_ADD,
 55         KOBJ_REMOVE,
 56         KOBJ_CHANGE,
 57         KOBJ_MOVE,
 58         KOBJ_ONLINE,
 59         KOBJ_OFFLINE,
 60         KOBJ_MAX
 61 };
 62 
 63 struct kobject {
 64         const char              *name;
 65         struct list_head        entry;
 66         struct kobject          *parent;
 67         struct kset             *kset;
 68         struct kobj_type        *ktype;
 69         struct kernfs_node      *sd;
 70         struct kref             kref;
 71 #ifdef CONFIG_DEBUG_KOBJECT_RELEASE
 72         struct delayed_work     release;
 73 #endif
 74         unsigned int state_initialized:1;
 75         unsigned int state_in_sysfs:1;
 76         unsigned int state_add_uevent_sent:1;
 77         unsigned int state_remove_uevent_sent:1;
 78         unsigned int uevent_suppress:1;
 79 };
 80 
 81 extern __printf(2, 3)
 82 int kobject_set_name(struct kobject *kobj, const char *name, ...);
 83 extern int kobject_set_name_vargs(struct kobject *kobj, const char *fmt,
 84                                   va_list vargs);
 85 
 86 static inline const char *kobject_name(const struct kobject *kobj)
 87 {
 88         return kobj->name;
 89 }
 90 
 91 extern void kobject_init(struct kobject *kobj, struct kobj_type *ktype);
 92 extern __printf(3, 4) __must_check
 93 int kobject_add(struct kobject *kobj, struct kobject *parent,
 94                 const char *fmt, ...);
 95 extern __printf(4, 5) __must_check
 96 int kobject_init_and_add(struct kobject *kobj,
 97                          struct kobj_type *ktype, struct kobject *parent,
 98                          const char *fmt, ...);
 99 
100 extern void kobject_del(struct kobject *kobj);
101 
102 extern struct kobject * __must_check kobject_create(void);
103 extern struct kobject * __must_check kobject_create_and_add(const char *name,
104                                                 struct kobject *parent);
105 
106 extern int __must_check kobject_rename(struct kobject *, const char *new_name);
107 extern int __must_check kobject_move(struct kobject *, struct kobject *);
108 
109 extern struct kobject *kobject_get(struct kobject *kobj);
110 extern struct kobject * __must_check kobject_get_unless_zero(
111                                                 struct kobject *kobj);
112 extern void kobject_put(struct kobject *kobj);
113 
114 extern const void *kobject_namespace(struct kobject *kobj);
115 extern char *kobject_get_path(struct kobject *kobj, gfp_t flag);
116 
117 struct kobj_type {
118         void (*release)(struct kobject *kobj);
119         const struct sysfs_ops *sysfs_ops;
120         struct attribute **default_attrs;
121         const struct kobj_ns_type_operations *(*child_ns_type)(struct kobject *kobj);
122         const void *(*namespace)(struct kobject *kobj);
123 };
124 
125 struct kobj_uevent_env {
126         char *argv[3];
127         char *envp[UEVENT_NUM_ENVP];
128         int envp_idx;
129         char buf[UEVENT_BUFFER_SIZE];
130         int buflen;
131 };
132 
133 struct kset_uevent_ops {
134         int (* const filter)(struct kset *kset, struct kobject *kobj);
135         const char *(* const name)(struct kset *kset, struct kobject *kobj);
136         int (* const uevent)(struct kset *kset, struct kobject *kobj,
137                       struct kobj_uevent_env *env);
138 };
139 
140 struct kobj_attribute {
141         struct attribute attr;
142         ssize_t (*show)(struct kobject *kobj, struct kobj_attribute *attr,
143                         char *buf);
144         ssize_t (*store)(struct kobject *kobj, struct kobj_attribute *attr,
145                          const char *buf, size_t count);
146 };
147 
148 extern const struct sysfs_ops kobj_sysfs_ops;
149 
150 struct sock;
151 
152 /**
153  * struct kset - a set of kobjects of a specific type, belonging to a specific subsystem.
154  *
155  * A kset defines a group of kobjects.  They can be individually
156  * different "types" but overall these kobjects all want to be grouped
157  * together and operated on in the same manner.  ksets are used to
158  * define the attribute callbacks and other common events that happen to
159  * a kobject.
160  *
161  * @list: the list of all kobjects for this kset
162  * @list_lock: a lock for iterating over the kobjects
163  * @kobj: the embedded kobject for this kset (recursion, isn't it fun...)
164  * @uevent_ops: the set of uevent operations for this kset.  These are
165  * called whenever a kobject has something happen to it so that the kset
166  * can add new environment variables, or filter out the uevents if so
167  * desired.
168  */
169 struct kset {
170         struct list_head list;
171         spinlock_t list_lock;
172         struct kobject kobj;
173         const struct kset_uevent_ops *uevent_ops;
174 };
175 
176 extern void kset_init(struct kset *kset);
177 extern int __must_check kset_register(struct kset *kset);
178 extern void kset_unregister(struct kset *kset);
179 extern struct kset * __must_check kset_create_and_add(const char *name,
180                                                 const struct kset_uevent_ops *u,
181                                                 struct kobject *parent_kobj);
182 
183 static inline struct kset *to_kset(struct kobject *kobj)
184 {
185         return kobj ? container_of(kobj, struct kset, kobj) : NULL;
186 }
187 
188 static inline struct kset *kset_get(struct kset *k)
189 {
190         return k ? to_kset(kobject_get(&k->kobj)) : NULL;
191 }
192 
193 static inline void kset_put(struct kset *k)
194 {
195         kobject_put(&k->kobj);
196 }
197 
198 static inline struct kobj_type *get_ktype(struct kobject *kobj)
199 {
200         return kobj->ktype;
201 }
202 
203 extern struct kobject *kset_find_obj(struct kset *, const char *);
204 
205 /* The global /sys/kernel/ kobject for people to chain off of */
206 extern struct kobject *kernel_kobj;
207 /* The global /sys/kernel/mm/ kobject for people to chain off of */
208 extern struct kobject *mm_kobj;
209 /* The global /sys/hypervisor/ kobject for people to chain off of */
210 extern struct kobject *hypervisor_kobj;
211 /* The global /sys/power/ kobject for people to chain off of */
212 extern struct kobject *power_kobj;
213 /* The global /sys/firmware/ kobject for people to chain off of */
214 extern struct kobject *firmware_kobj;
215 
216 int kobject_uevent(struct kobject *kobj, enum kobject_action action);
217 int kobject_uevent_env(struct kobject *kobj, enum kobject_action action,
218                         char *envp[]);
219 
220 __printf(2, 3)
221 int add_uevent_var(struct kobj_uevent_env *env, const char *format, ...);
222 
223 int kobject_action_type(const char *buf, size_t count,
224                         enum kobject_action *type);
225 
226 #endif /* _KOBJECT_H_ */
227 

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp