blob: cf343a852534bee2f3ed02ffd9cce21210caac8f [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * kobject.h - generic kernel object infrastructure.
3 *
Greg Kroah-Hartmanf0e7e1b2007-09-27 14:48:53 -07004 * Copyright (c) 2002-2003 Patrick Mochel
5 * Copyright (c) 2002-2003 Open Source Development Labs
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -08006 * Copyright (c) 2006-2008 Greg Kroah-Hartman <greg@kroah.com>
7 * Copyright (c) 2006-2008 Novell Inc.
Linus Torvalds1da177e2005-04-16 15:20:36 -07008 *
9 * This file is released under the GPLv2.
10 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070011 * Please read Documentation/kobject.txt before using the kobject
12 * interface, ESPECIALLY the parts about reference counts and object
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -080013 * destructors.
Linus Torvalds1da177e2005-04-16 15:20:36 -070014 */
15
16#ifndef _KOBJECT_H_
17#define _KOBJECT_H_
18
Linus Torvalds1da177e2005-04-16 15:20:36 -070019#include <linux/types.h>
20#include <linux/list.h>
21#include <linux/sysfs.h>
Andrew Morton4a7fb632006-08-14 22:43:17 -070022#include <linux/compiler.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070023#include <linux/spinlock.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <linux/kref.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#include <linux/kernel.h>
NeilBrown4508a7a2006-03-20 17:53:53 +110026#include <linux/wait.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <asm/atomic.h>
28
Kay Sievers312c0042005-11-16 09:00:00 +010029#define UEVENT_HELPER_PATH_LEN 256
Kay Sievers7eff2e72007-08-14 15:15:12 +020030#define UEVENT_NUM_ENVP 32 /* number of env pointers */
31#define UEVENT_BUFFER_SIZE 2048 /* buffer for the variables */
Kay Sievers0296b222005-11-11 05:33:52 +010032
33/* path to the userspace helper executed on an event */
Kay Sievers312c0042005-11-16 09:00:00 +010034extern char uevent_helper[];
Kay Sievers0296b222005-11-11 05:33:52 +010035
Kay Sievers312c0042005-11-16 09:00:00 +010036/* counter to tag the uevent, read only except for the kobject core */
37extern u64 uevent_seqnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
Kay Sievers60a96a52007-07-08 22:29:26 +020039/*
40 * The actions here must match the index to the string array
41 * in lib/kobject_uevent.c
42 *
43 * Do not add new actions here without checking with the driver-core
44 * maintainers. Action strings are not meant to express subsystem
45 * or device specific properties. In most cases you want to send a
46 * kobject_uevent_env(kobj, KOBJ_CHANGE, env) with additional event
47 * specific variables added to the event environment.
48 */
Kay Sievers0296b222005-11-11 05:33:52 +010049enum kobject_action {
Kay Sievers60a96a52007-07-08 22:29:26 +020050 KOBJ_ADD,
51 KOBJ_REMOVE,
52 KOBJ_CHANGE,
53 KOBJ_MOVE,
54 KOBJ_ONLINE,
55 KOBJ_OFFLINE,
56 KOBJ_MAX
Kay Sievers0296b222005-11-11 05:33:52 +010057};
58
Linus Torvalds1da177e2005-04-16 15:20:36 -070059struct kobject {
Kay Sieversaf5ca3f2007-12-20 02:09:39 +010060 const char *name;
Linus Torvalds1da177e2005-04-16 15:20:36 -070061 struct list_head entry;
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -080062 struct kobject *parent;
63 struct kset *kset;
64 struct kobj_type *ktype;
65 struct sysfs_dirent *sd;
Richard Kennedya2319342008-06-02 11:07:25 +010066 struct kref kref;
Kay Sievers0f4dafc2007-12-19 01:40:42 +010067 unsigned int state_initialized:1;
Kay Sievers0f4dafc2007-12-19 01:40:42 +010068 unsigned int state_in_sysfs:1;
69 unsigned int state_add_uevent_sent:1;
70 unsigned int state_remove_uevent_sent:1;
Ming Leif67f1292009-03-01 21:10:49 +080071 unsigned int uevent_suppress:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -070072};
73
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -080074extern int kobject_set_name(struct kobject *kobj, const char *name, ...)
75 __attribute__((format(printf, 2, 3)));
Kay Sievers1fa5ae82009-01-25 15:17:37 +010076extern int kobject_set_name_vargs(struct kobject *kobj, const char *fmt,
77 va_list vargs);
Linus Torvalds1da177e2005-04-16 15:20:36 -070078
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -080079static inline const char *kobject_name(const struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -070080{
Kay Sieversaf5ca3f2007-12-20 02:09:39 +010081 return kobj->name;
Linus Torvalds1da177e2005-04-16 15:20:36 -070082}
83
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -070084extern void kobject_init(struct kobject *kobj, struct kobj_type *ktype);
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -070085extern int __must_check kobject_add(struct kobject *kobj,
86 struct kobject *parent,
87 const char *fmt, ...);
Greg Kroah-Hartmanc11c4152007-12-03 21:31:08 -080088extern int __must_check kobject_init_and_add(struct kobject *kobj,
89 struct kobj_type *ktype,
90 struct kobject *parent,
91 const char *fmt, ...);
92
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -080093extern void kobject_del(struct kobject *kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -070094
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -080095extern struct kobject * __must_check kobject_create(void);
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -080096extern struct kobject * __must_check kobject_create_and_add(const char *name,
97 struct kobject *parent);
98
Andrew Morton4a7fb632006-08-14 22:43:17 -070099extern int __must_check kobject_rename(struct kobject *, const char *new_name);
Cornelia Huck8a824722006-11-20 17:07:51 +0100100extern int __must_check kobject_move(struct kobject *, struct kobject *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800102extern struct kobject *kobject_get(struct kobject *kobj);
103extern void kobject_put(struct kobject *kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800105extern char *kobject_get_path(struct kobject *kobj, gfp_t flag);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106
107struct kobj_type {
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800108 void (*release)(struct kobject *kobj);
Emese Revfy52cf25d2010-01-19 02:58:23 +0100109 const struct sysfs_ops *sysfs_ops;
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800110 struct attribute **default_attrs;
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700111 const struct kobj_ns_type_operations *(*child_ns_type)(struct kobject *kobj);
112 const void *(*namespace)(struct kobject *kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113};
114
Kay Sievers7eff2e72007-08-14 15:15:12 +0200115struct kobj_uevent_env {
116 char *envp[UEVENT_NUM_ENVP];
117 int envp_idx;
118 char buf[UEVENT_BUFFER_SIZE];
119 int buflen;
120};
121
Randy Dunlapa5615642007-07-27 09:36:26 -0700122struct kset_uevent_ops {
Emese Revfy9cd43612009-12-31 14:52:51 +0100123 int (* const filter)(struct kset *kset, struct kobject *kobj);
124 const char *(* const name)(struct kset *kset, struct kobject *kobj);
125 int (* const uevent)(struct kset *kset, struct kobject *kobj,
Kay Sievers7eff2e72007-08-14 15:15:12 +0200126 struct kobj_uevent_env *env);
Randy Dunlapa5615642007-07-27 09:36:26 -0700127};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128
Kay Sievers23b52122007-11-02 13:47:53 +0100129struct kobj_attribute {
130 struct attribute attr;
131 ssize_t (*show)(struct kobject *kobj, struct kobj_attribute *attr,
132 char *buf);
133 ssize_t (*store)(struct kobject *kobj, struct kobj_attribute *attr,
134 const char *buf, size_t count);
135};
136
Emese Revfy52cf25d2010-01-19 02:58:23 +0100137extern const struct sysfs_ops kobj_sysfs_ops;
Kay Sievers23b52122007-11-02 13:47:53 +0100138
Serge E. Hallynbe867b12010-05-03 16:23:15 -0500139/*
140 * Namespace types which are used to tag kobjects and sysfs entries.
141 * Network namespace will likely be the first.
142 */
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700143enum kobj_ns_type {
144 KOBJ_NS_TYPE_NONE = 0,
Eric W. Biederman608b4b92010-05-04 17:36:45 -0700145 KOBJ_NS_TYPE_NET,
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700146 KOBJ_NS_TYPES
147};
148
149struct sock;
Serge E. Hallynbe867b12010-05-03 16:23:15 -0500150
151/*
152 * Callbacks so sysfs can determine namespaces
153 * @current_ns: return calling task's namespace
154 * @netlink_ns: return namespace to which a sock belongs (right?)
155 * @initial_ns: return the initial namespace (i.e. init_net_ns)
156 */
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700157struct kobj_ns_type_operations {
158 enum kobj_ns_type type;
159 const void *(*current_ns)(void);
160 const void *(*netlink_ns)(struct sock *sk);
161 const void *(*initial_ns)(void);
162};
163
164int kobj_ns_type_register(const struct kobj_ns_type_operations *ops);
165int kobj_ns_type_registered(enum kobj_ns_type type);
166const struct kobj_ns_type_operations *kobj_child_ns_ops(struct kobject *parent);
167const struct kobj_ns_type_operations *kobj_ns_ops(struct kobject *kobj);
168
169const void *kobj_ns_current(enum kobj_ns_type type);
170const void *kobj_ns_netlink(enum kobj_ns_type type, struct sock *sk);
171const void *kobj_ns_initial(enum kobj_ns_type type);
172void kobj_ns_exit(enum kobj_ns_type type, const void *ns);
173
174
Greg Kroah-Hartman6adf7552007-09-27 14:48:53 -0700175/**
176 * struct kset - a set of kobjects of a specific type, belonging to a specific subsystem.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177 *
Greg Kroah-Hartman6adf7552007-09-27 14:48:53 -0700178 * A kset defines a group of kobjects. They can be individually
179 * different "types" but overall these kobjects all want to be grouped
180 * together and operated on in the same manner. ksets are used to
181 * define the attribute callbacks and other common events that happen to
182 * a kobject.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183 *
Greg Kroah-Hartman6adf7552007-09-27 14:48:53 -0700184 * @list: the list of all kobjects for this kset
185 * @list_lock: a lock for iterating over the kobjects
186 * @kobj: the embedded kobject for this kset (recursion, isn't it fun...)
187 * @uevent_ops: the set of uevent operations for this kset. These are
188 * called whenever a kobject has something happen to it so that the kset
189 * can add new environment variables, or filter out the uevents if so
190 * desired.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192struct kset {
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800193 struct list_head list;
194 spinlock_t list_lock;
195 struct kobject kobj;
Emese Revfy9cd43612009-12-31 14:52:51 +0100196 const struct kset_uevent_ops *uevent_ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197};
198
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800199extern void kset_init(struct kset *kset);
200extern int __must_check kset_register(struct kset *kset);
201extern void kset_unregister(struct kset *kset);
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700202extern struct kset * __must_check kset_create_and_add(const char *name,
Emese Revfy9cd43612009-12-31 14:52:51 +0100203 const struct kset_uevent_ops *u,
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700204 struct kobject *parent_kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800206static inline struct kset *to_kset(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207{
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800208 return kobj ? container_of(kobj, struct kset, kobj) : NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209}
210
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800211static inline struct kset *kset_get(struct kset *k)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212{
213 return k ? to_kset(kobject_get(&k->kobj)) : NULL;
214}
215
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800216static inline void kset_put(struct kset *k)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217{
218 kobject_put(&k->kobj);
219}
220
Greg Kroah-Hartman3514fac2007-10-16 10:11:44 -0600221static inline struct kobj_type *get_ktype(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222{
Greg Kroah-Hartman3514fac2007-10-16 10:11:44 -0600223 return kobj->ktype;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224}
225
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800226extern struct kobject *kset_find_obj(struct kset *, const char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227
Greg Kroah-Hartman0ff21e42007-11-06 10:36:58 -0800228/* The global /sys/kernel/ kobject for people to chain off of */
229extern struct kobject *kernel_kobj;
Nishanth Aravamudanff7ea792008-07-23 21:27:39 -0700230/* The global /sys/kernel/mm/ kobject for people to chain off of */
231extern struct kobject *mm_kobj;
Greg Kroah-Hartman2d72fc02007-11-01 09:29:06 -0600232/* The global /sys/hypervisor/ kobject for people to chain off of */
233extern struct kobject *hypervisor_kobj;
Greg Kroah-Hartmand76e15f2007-11-27 11:28:26 -0800234/* The global /sys/power/ kobject for people to chain off of */
235extern struct kobject *power_kobj;
Greg Kroah-Hartmanf62ed9e2007-11-05 13:16:15 -0800236/* The global /sys/firmware/ kobject for people to chain off of */
237extern struct kobject *firmware_kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238
Kay Sievers4d17ffd2006-04-25 15:37:26 +0200239#if defined(CONFIG_HOTPLUG)
Aneesh Kumar K.V542cfce2006-12-19 13:01:27 -0800240int kobject_uevent(struct kobject *kobj, enum kobject_action action);
241int kobject_uevent_env(struct kobject *kobj, enum kobject_action action,
Cornelia Huck8a824722006-11-20 17:07:51 +0100242 char *envp[]);
Kay Sievers0296b222005-11-11 05:33:52 +0100243
Kay Sievers7eff2e72007-08-14 15:15:12 +0200244int add_uevent_var(struct kobj_uevent_env *env, const char *format, ...)
245 __attribute__((format (printf, 2, 3)));
Kay Sievers5c5daf62007-08-12 20:43:55 +0200246
247int kobject_action_type(const char *buf, size_t count,
248 enum kobject_action *type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249#else
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800250static inline int kobject_uevent(struct kobject *kobj,
251 enum kobject_action action)
Aneesh Kumar K.V542cfce2006-12-19 13:01:27 -0800252{ return 0; }
253static inline int kobject_uevent_env(struct kobject *kobj,
Cornelia Huck8a824722006-11-20 17:07:51 +0100254 enum kobject_action action,
255 char *envp[])
Aneesh Kumar K.V542cfce2006-12-19 13:01:27 -0800256{ return 0; }
Kay Sievers5f123fb2005-11-11 14:43:07 +0100257
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800258static inline int add_uevent_var(struct kobj_uevent_env *env,
259 const char *format, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260{ return 0; }
Kay Sievers5c5daf62007-08-12 20:43:55 +0200261
262static inline int kobject_action_type(const char *buf, size_t count,
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800263 enum kobject_action *type)
Kay Sievers5c5daf62007-08-12 20:43:55 +0200264{ return -EINVAL; }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265#endif
266
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267#endif /* _KOBJECT_H_ */