blob: fc615a97e2d363df686f6111988cf686d8e03dfa [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>
David Howells8488a382010-08-11 15:01:02 +010025#include <linux/kobject_ns.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070026#include <linux/kernel.h>
NeilBrown4508a7a2006-03-20 17:53:53 +110027#include <linux/wait.h>
Arun Sharma600634972011-07-26 16:09:06 -070028#include <linux/atomic.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029
Kay Sievers312c0042005-11-16 09:00:00 +010030#define UEVENT_HELPER_PATH_LEN 256
Kay Sievers7eff2e72007-08-14 15:15:12 +020031#define UEVENT_NUM_ENVP 32 /* number of env pointers */
32#define UEVENT_BUFFER_SIZE 2048 /* buffer for the variables */
Kay Sievers0296b222005-11-11 05:33:52 +010033
34/* path to the userspace helper executed on an event */
Kay Sievers312c0042005-11-16 09:00:00 +010035extern char uevent_helper[];
Kay Sievers0296b222005-11-11 05:33:52 +010036
Kay Sievers312c0042005-11-16 09:00:00 +010037/* counter to tag the uevent, read only except for the kobject core */
38extern u64 uevent_seqnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
Kay Sievers60a96a52007-07-08 22:29:26 +020040/*
41 * The actions here must match the index to the string array
42 * in lib/kobject_uevent.c
43 *
44 * Do not add new actions here without checking with the driver-core
45 * maintainers. Action strings are not meant to express subsystem
46 * or device specific properties. In most cases you want to send a
47 * kobject_uevent_env(kobj, KOBJ_CHANGE, env) with additional event
48 * specific variables added to the event environment.
49 */
Kay Sievers0296b222005-11-11 05:33:52 +010050enum kobject_action {
Kay Sievers60a96a52007-07-08 22:29:26 +020051 KOBJ_ADD,
52 KOBJ_REMOVE,
53 KOBJ_CHANGE,
54 KOBJ_MOVE,
55 KOBJ_ONLINE,
56 KOBJ_OFFLINE,
57 KOBJ_MAX
Kay Sievers0296b222005-11-11 05:33:52 +010058};
59
Linus Torvalds1da177e2005-04-16 15:20:36 -070060struct kobject {
Kay Sieversaf5ca3f2007-12-20 02:09:39 +010061 const char *name;
Linus Torvalds1da177e2005-04-16 15:20:36 -070062 struct list_head entry;
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -080063 struct kobject *parent;
64 struct kset *kset;
65 struct kobj_type *ktype;
66 struct sysfs_dirent *sd;
Richard Kennedya2319342008-06-02 11:07:25 +010067 struct kref kref;
Kay Sievers0f4dafc2007-12-19 01:40:42 +010068 unsigned int state_initialized:1;
Kay Sievers0f4dafc2007-12-19 01:40:42 +010069 unsigned int state_in_sysfs:1;
70 unsigned int state_add_uevent_sent:1;
71 unsigned int state_remove_uevent_sent:1;
Ming Leif67f1292009-03-01 21:10:49 +080072 unsigned int uevent_suppress:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -070073};
74
Joe Perchesb9075fa2011-10-31 17:11:33 -070075extern __printf(2, 3)
76int kobject_set_name(struct kobject *kobj, const char *name, ...);
Kay Sievers1fa5ae82009-01-25 15:17:37 +010077extern int kobject_set_name_vargs(struct kobject *kobj, const char *fmt,
78 va_list vargs);
Linus Torvalds1da177e2005-04-16 15:20:36 -070079
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -080080static inline const char *kobject_name(const struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -070081{
Kay Sieversaf5ca3f2007-12-20 02:09:39 +010082 return kobj->name;
Linus Torvalds1da177e2005-04-16 15:20:36 -070083}
84
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -070085extern void kobject_init(struct kobject *kobj, struct kobj_type *ktype);
Joe Perchesb9075fa2011-10-31 17:11:33 -070086extern __printf(3, 4) __must_check
87int kobject_add(struct kobject *kobj, struct kobject *parent,
88 const char *fmt, ...);
89extern __printf(4, 5) __must_check
90int kobject_init_and_add(struct kobject *kobj,
91 struct kobj_type *ktype, struct kobject *parent,
92 const char *fmt, ...);
Greg Kroah-Hartmanc11c4152007-12-03 21:31:08 -080093
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -080094extern void kobject_del(struct kobject *kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -070095
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -080096extern struct kobject * __must_check kobject_create(void);
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -080097extern struct kobject * __must_check kobject_create_and_add(const char *name,
98 struct kobject *parent);
99
Andrew Morton4a7fb632006-08-14 22:43:17 -0700100extern int __must_check kobject_rename(struct kobject *, const char *new_name);
Cornelia Huck8a824722006-11-20 17:07:51 +0100101extern int __must_check kobject_move(struct kobject *, struct kobject *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800103extern struct kobject *kobject_get(struct kobject *kobj);
104extern void kobject_put(struct kobject *kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800106extern char *kobject_get_path(struct kobject *kobj, gfp_t flag);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107
108struct kobj_type {
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800109 void (*release)(struct kobject *kobj);
Emese Revfy52cf25d2010-01-19 02:58:23 +0100110 const struct sysfs_ops *sysfs_ops;
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800111 struct attribute **default_attrs;
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700112 const struct kobj_ns_type_operations *(*child_ns_type)(struct kobject *kobj);
113 const void *(*namespace)(struct kobject *kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114};
115
Kay Sievers7eff2e72007-08-14 15:15:12 +0200116struct kobj_uevent_env {
117 char *envp[UEVENT_NUM_ENVP];
118 int envp_idx;
119 char buf[UEVENT_BUFFER_SIZE];
120 int buflen;
121};
122
Randy Dunlapa5615642007-07-27 09:36:26 -0700123struct kset_uevent_ops {
Emese Revfy9cd43612009-12-31 14:52:51 +0100124 int (* const filter)(struct kset *kset, struct kobject *kobj);
125 const char *(* const name)(struct kset *kset, struct kobject *kobj);
126 int (* const uevent)(struct kset *kset, struct kobject *kobj,
Kay Sievers7eff2e72007-08-14 15:15:12 +0200127 struct kobj_uevent_env *env);
Randy Dunlapa5615642007-07-27 09:36:26 -0700128};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129
Kay Sievers23b52122007-11-02 13:47:53 +0100130struct kobj_attribute {
131 struct attribute attr;
132 ssize_t (*show)(struct kobject *kobj, struct kobj_attribute *attr,
133 char *buf);
134 ssize_t (*store)(struct kobject *kobj, struct kobj_attribute *attr,
135 const char *buf, size_t count);
136};
137
Emese Revfy52cf25d2010-01-19 02:58:23 +0100138extern const struct sysfs_ops kobj_sysfs_ops;
Kay Sievers23b52122007-11-02 13:47:53 +0100139
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700140struct sock;
Serge E. Hallynbe867b12010-05-03 16:23:15 -0500141
Greg Kroah-Hartman6adf7552007-09-27 14:48:53 -0700142/**
143 * struct kset - a set of kobjects of a specific type, belonging to a specific subsystem.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144 *
Greg Kroah-Hartman6adf7552007-09-27 14:48:53 -0700145 * A kset defines a group of kobjects. They can be individually
146 * different "types" but overall these kobjects all want to be grouped
147 * together and operated on in the same manner. ksets are used to
148 * define the attribute callbacks and other common events that happen to
149 * a kobject.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150 *
Greg Kroah-Hartman6adf7552007-09-27 14:48:53 -0700151 * @list: the list of all kobjects for this kset
152 * @list_lock: a lock for iterating over the kobjects
153 * @kobj: the embedded kobject for this kset (recursion, isn't it fun...)
154 * @uevent_ops: the set of uevent operations for this kset. These are
155 * called whenever a kobject has something happen to it so that the kset
156 * can add new environment variables, or filter out the uevents if so
157 * desired.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159struct kset {
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800160 struct list_head list;
161 spinlock_t list_lock;
162 struct kobject kobj;
Emese Revfy9cd43612009-12-31 14:52:51 +0100163 const struct kset_uevent_ops *uevent_ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164};
165
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800166extern void kset_init(struct kset *kset);
167extern int __must_check kset_register(struct kset *kset);
168extern void kset_unregister(struct kset *kset);
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700169extern struct kset * __must_check kset_create_and_add(const char *name,
Emese Revfy9cd43612009-12-31 14:52:51 +0100170 const struct kset_uevent_ops *u,
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700171 struct kobject *parent_kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800173static inline struct kset *to_kset(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174{
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800175 return kobj ? container_of(kobj, struct kset, kobj) : NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176}
177
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800178static inline struct kset *kset_get(struct kset *k)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179{
180 return k ? to_kset(kobject_get(&k->kobj)) : NULL;
181}
182
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800183static inline void kset_put(struct kset *k)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184{
185 kobject_put(&k->kobj);
186}
187
Greg Kroah-Hartman3514fac2007-10-16 10:11:44 -0600188static inline struct kobj_type *get_ktype(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189{
Greg Kroah-Hartman3514fac2007-10-16 10:11:44 -0600190 return kobj->ktype;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191}
192
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800193extern struct kobject *kset_find_obj(struct kset *, const char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194
Greg Kroah-Hartman0ff21e42007-11-06 10:36:58 -0800195/* The global /sys/kernel/ kobject for people to chain off of */
196extern struct kobject *kernel_kobj;
Nishanth Aravamudanff7ea792008-07-23 21:27:39 -0700197/* The global /sys/kernel/mm/ kobject for people to chain off of */
198extern struct kobject *mm_kobj;
Greg Kroah-Hartman2d72fc02007-11-01 09:29:06 -0600199/* The global /sys/hypervisor/ kobject for people to chain off of */
200extern struct kobject *hypervisor_kobj;
Greg Kroah-Hartmand76e15f2007-11-27 11:28:26 -0800201/* The global /sys/power/ kobject for people to chain off of */
202extern struct kobject *power_kobj;
Greg Kroah-Hartmanf62ed9e2007-11-05 13:16:15 -0800203/* The global /sys/firmware/ kobject for people to chain off of */
204extern struct kobject *firmware_kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205
Kay Sievers4d17ffd2006-04-25 15:37:26 +0200206#if defined(CONFIG_HOTPLUG)
Aneesh Kumar K.V542cfce2006-12-19 13:01:27 -0800207int kobject_uevent(struct kobject *kobj, enum kobject_action action);
208int kobject_uevent_env(struct kobject *kobj, enum kobject_action action,
Cornelia Huck8a824722006-11-20 17:07:51 +0100209 char *envp[]);
Kay Sievers0296b222005-11-11 05:33:52 +0100210
Joe Perchesb9075fa2011-10-31 17:11:33 -0700211__printf(2, 3)
212int add_uevent_var(struct kobj_uevent_env *env, const char *format, ...);
Kay Sievers5c5daf62007-08-12 20:43:55 +0200213
214int kobject_action_type(const char *buf, size_t count,
215 enum kobject_action *type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216#else
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800217static inline int kobject_uevent(struct kobject *kobj,
218 enum kobject_action action)
Aneesh Kumar K.V542cfce2006-12-19 13:01:27 -0800219{ return 0; }
220static inline int kobject_uevent_env(struct kobject *kobj,
Cornelia Huck8a824722006-11-20 17:07:51 +0100221 enum kobject_action action,
222 char *envp[])
Aneesh Kumar K.V542cfce2006-12-19 13:01:27 -0800223{ return 0; }
Kay Sievers5f123fb2005-11-11 14:43:07 +0100224
Joe Perchesb9075fa2011-10-31 17:11:33 -0700225static inline __printf(2, 3)
Randy Dunlapb38360a2011-02-06 21:57:18 -0800226int add_uevent_var(struct kobj_uevent_env *env, const char *format, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227{ return 0; }
Kay Sievers5c5daf62007-08-12 20:43:55 +0200228
229static inline int kobject_action_type(const char *buf, size_t count,
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800230 enum kobject_action *type)
Kay Sievers5c5daf62007-08-12 20:43:55 +0200231{ return -EINVAL; }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232#endif
233
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234#endif /* _KOBJECT_H_ */