blob: caa3f411f15d0c48958e40d5369b4e16b9456b15 [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
19#ifdef __KERNEL__
20
21#include <linux/types.h>
22#include <linux/list.h>
23#include <linux/sysfs.h>
Andrew Morton4a7fb632006-08-14 22:43:17 -070024#include <linux/compiler.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#include <linux/spinlock.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070026#include <linux/kref.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/kernel.h>
NeilBrown4508a7a2006-03-20 17:53:53 +110028#include <linux/wait.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <asm/atomic.h>
30
Kay Sievers312c0042005-11-16 09:00:00 +010031#define KOBJ_NAME_LEN 20
32#define UEVENT_HELPER_PATH_LEN 256
Kay Sievers7eff2e72007-08-14 15:15:12 +020033#define UEVENT_NUM_ENVP 32 /* number of env pointers */
34#define UEVENT_BUFFER_SIZE 2048 /* buffer for the variables */
Kay Sievers0296b222005-11-11 05:33:52 +010035
36/* path to the userspace helper executed on an event */
Kay Sievers312c0042005-11-16 09:00:00 +010037extern char uevent_helper[];
Kay Sievers0296b222005-11-11 05:33:52 +010038
Kay Sievers312c0042005-11-16 09:00:00 +010039/* counter to tag the uevent, read only except for the kobject core */
40extern u64 uevent_seqnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
Kay Sievers60a96a52007-07-08 22:29:26 +020042/*
43 * The actions here must match the index to the string array
44 * in lib/kobject_uevent.c
45 *
46 * Do not add new actions here without checking with the driver-core
47 * maintainers. Action strings are not meant to express subsystem
48 * or device specific properties. In most cases you want to send a
49 * kobject_uevent_env(kobj, KOBJ_CHANGE, env) with additional event
50 * specific variables added to the event environment.
51 */
Kay Sievers0296b222005-11-11 05:33:52 +010052enum kobject_action {
Kay Sievers60a96a52007-07-08 22:29:26 +020053 KOBJ_ADD,
54 KOBJ_REMOVE,
55 KOBJ_CHANGE,
56 KOBJ_MOVE,
57 KOBJ_ONLINE,
58 KOBJ_OFFLINE,
59 KOBJ_MAX
Kay Sievers0296b222005-11-11 05:33:52 +010060};
61
Linus Torvalds1da177e2005-04-16 15:20:36 -070062struct kobject {
Kay Sieversaf5ca3f2007-12-20 02:09:39 +010063 const char *name;
Linus Torvalds1da177e2005-04-16 15:20:36 -070064 struct kref kref;
65 struct list_head entry;
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -080066 struct kobject *parent;
67 struct kset *kset;
68 struct kobj_type *ktype;
69 struct sysfs_dirent *sd;
Kay Sievers0f4dafc2007-12-19 01:40:42 +010070 unsigned int state_initialized:1;
Kay Sievers0f4dafc2007-12-19 01:40:42 +010071 unsigned int state_in_sysfs:1;
72 unsigned int state_add_uevent_sent:1;
73 unsigned int state_remove_uevent_sent:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -070074};
75
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -080076extern int kobject_set_name(struct kobject *kobj, const char *name, ...)
77 __attribute__((format(printf, 2, 3)));
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);
109 struct sysfs_ops *sysfs_ops;
110 struct attribute **default_attrs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111};
112
Kay Sievers7eff2e72007-08-14 15:15:12 +0200113struct kobj_uevent_env {
114 char *envp[UEVENT_NUM_ENVP];
115 int envp_idx;
116 char buf[UEVENT_BUFFER_SIZE];
117 int buflen;
118};
119
Randy Dunlapa5615642007-07-27 09:36:26 -0700120struct kset_uevent_ops {
121 int (*filter)(struct kset *kset, struct kobject *kobj);
122 const char *(*name)(struct kset *kset, struct kobject *kobj);
Kay Sievers7eff2e72007-08-14 15:15:12 +0200123 int (*uevent)(struct kset *kset, struct kobject *kobj,
124 struct kobj_uevent_env *env);
Randy Dunlapa5615642007-07-27 09:36:26 -0700125};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126
Kay Sievers23b52122007-11-02 13:47:53 +0100127struct kobj_attribute {
128 struct attribute attr;
129 ssize_t (*show)(struct kobject *kobj, struct kobj_attribute *attr,
130 char *buf);
131 ssize_t (*store)(struct kobject *kobj, struct kobj_attribute *attr,
132 const char *buf, size_t count);
133};
134
135extern struct sysfs_ops kobj_sysfs_ops;
136
Greg Kroah-Hartman6adf7552007-09-27 14:48:53 -0700137/**
138 * struct kset - a set of kobjects of a specific type, belonging to a specific subsystem.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139 *
Greg Kroah-Hartman6adf7552007-09-27 14:48:53 -0700140 * A kset defines a group of kobjects. They can be individually
141 * different "types" but overall these kobjects all want to be grouped
142 * together and operated on in the same manner. ksets are used to
143 * define the attribute callbacks and other common events that happen to
144 * a kobject.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145 *
Greg Kroah-Hartman6adf7552007-09-27 14:48:53 -0700146 * @list: the list of all kobjects for this kset
147 * @list_lock: a lock for iterating over the kobjects
148 * @kobj: the embedded kobject for this kset (recursion, isn't it fun...)
149 * @uevent_ops: the set of uevent operations for this kset. These are
150 * called whenever a kobject has something happen to it so that the kset
151 * can add new environment variables, or filter out the uevents if so
152 * desired.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154struct kset {
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800155 struct list_head list;
156 spinlock_t list_lock;
157 struct kobject kobj;
158 struct kset_uevent_ops *uevent_ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159};
160
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800161extern void kset_init(struct kset *kset);
162extern int __must_check kset_register(struct kset *kset);
163extern void kset_unregister(struct kset *kset);
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700164extern struct kset * __must_check kset_create_and_add(const char *name,
165 struct kset_uevent_ops *u,
166 struct kobject *parent_kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800168static inline struct kset *to_kset(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169{
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800170 return kobj ? container_of(kobj, struct kset, kobj) : NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171}
172
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800173static inline struct kset *kset_get(struct kset *k)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174{
175 return k ? to_kset(kobject_get(&k->kobj)) : NULL;
176}
177
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800178static inline void kset_put(struct kset *k)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179{
180 kobject_put(&k->kobj);
181}
182
Greg Kroah-Hartman3514fac2007-10-16 10:11:44 -0600183static inline struct kobj_type *get_ktype(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184{
Greg Kroah-Hartman3514fac2007-10-16 10:11:44 -0600185 return kobj->ktype;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186}
187
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800188extern struct kobject *kset_find_obj(struct kset *, const char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189
Greg Kroah-Hartman0ff21e42007-11-06 10:36:58 -0800190/* The global /sys/kernel/ kobject for people to chain off of */
191extern struct kobject *kernel_kobj;
Greg Kroah-Hartman2d72fc02007-11-01 09:29:06 -0600192/* The global /sys/hypervisor/ kobject for people to chain off of */
193extern struct kobject *hypervisor_kobj;
Greg Kroah-Hartmand76e15f2007-11-27 11:28:26 -0800194/* The global /sys/power/ kobject for people to chain off of */
195extern struct kobject *power_kobj;
Greg Kroah-Hartmanf62ed9e2007-11-05 13:16:15 -0800196/* The global /sys/firmware/ kobject for people to chain off of */
197extern struct kobject *firmware_kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198
Kay Sievers4d17ffd2006-04-25 15:37:26 +0200199#if defined(CONFIG_HOTPLUG)
Aneesh Kumar K.V542cfce2006-12-19 13:01:27 -0800200int kobject_uevent(struct kobject *kobj, enum kobject_action action);
201int kobject_uevent_env(struct kobject *kobj, enum kobject_action action,
Cornelia Huck8a824722006-11-20 17:07:51 +0100202 char *envp[]);
Kay Sievers0296b222005-11-11 05:33:52 +0100203
Kay Sievers7eff2e72007-08-14 15:15:12 +0200204int add_uevent_var(struct kobj_uevent_env *env, const char *format, ...)
205 __attribute__((format (printf, 2, 3)));
Kay Sievers5c5daf62007-08-12 20:43:55 +0200206
207int kobject_action_type(const char *buf, size_t count,
208 enum kobject_action *type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209#else
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800210static inline int kobject_uevent(struct kobject *kobj,
211 enum kobject_action action)
Aneesh Kumar K.V542cfce2006-12-19 13:01:27 -0800212{ return 0; }
213static inline int kobject_uevent_env(struct kobject *kobj,
Cornelia Huck8a824722006-11-20 17:07:51 +0100214 enum kobject_action action,
215 char *envp[])
Aneesh Kumar K.V542cfce2006-12-19 13:01:27 -0800216{ return 0; }
Kay Sievers5f123fb2005-11-11 14:43:07 +0100217
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800218static inline int add_uevent_var(struct kobj_uevent_env *env,
219 const char *format, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220{ return 0; }
Kay Sievers5c5daf62007-08-12 20:43:55 +0200221
222static inline int kobject_action_type(const char *buf, size_t count,
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800223 enum kobject_action *type)
Kay Sievers5c5daf62007-08-12 20:43:55 +0200224{ return -EINVAL; }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225#endif
226
227#endif /* __KERNEL__ */
228#endif /* _KOBJECT_H_ */