[deliverable/linux.git] / include / linux / kobject.h

/*
 * kobject.h - generic kernel object infrastructure.
 *
 * Copyright (c) 2002-2003	Patrick Mochel
 * Copyright (c) 2002-2003	Open Source Development Labs
 *
 * This file is released under the GPLv2.
 *
 * 
 * Please read Documentation/kobject.txt before using the kobject
 * interface, ESPECIALLY the parts about reference counts and object
 * destructors. 
 */

#ifndef _KOBJECT_H_
#define _KOBJECT_H_

#ifdef __KERNEL__

#include <linux/types.h>
#include <linux/list.h>
#include <linux/sysfs.h>
#include <linux/compiler.h>
#include <linux/spinlock.h>
#include <linux/kref.h>
#include <linux/kernel.h>
#include <linux/wait.h>
#include <asm/atomic.h>

#define KOBJ_NAME_LEN			20
#define UEVENT_HELPER_PATH_LEN		256
#define UEVENT_NUM_ENVP			32	/* number of env pointers */
#define UEVENT_BUFFER_SIZE		2048	/* buffer for the variables */

/* path to the userspace helper executed on an event */
extern char uevent_helper[];

/* counter to tag the uevent, read only except for the kobject core */
extern u64 uevent_seqnum;

/*
 * The actions here must match the index to the string array
 * in lib/kobject_uevent.c
 *
 * Do not add new actions here without checking with the driver-core
 * maintainers. Action strings are not meant to express subsystem
 * or device specific properties. In most cases you want to send a
 * kobject_uevent_env(kobj, KOBJ_CHANGE, env) with additional event
 * specific variables added to the event environment.
 */
enum kobject_action {
	KOBJ_ADD,
	KOBJ_REMOVE,
	KOBJ_CHANGE,
	KOBJ_MOVE,
	KOBJ_ONLINE,
	KOBJ_OFFLINE,
	KOBJ_MAX
};

/* The list of strings defining the valid kobject actions as specified above */
extern const char *kobject_actions[];

struct kobject {
	const char		* k_name;
	char			name[KOBJ_NAME_LEN];
	struct kref		kref;
	struct list_head	entry;
	struct kobject		* parent;
	struct kset		* kset;
	struct kobj_type	* ktype;
	struct sysfs_dirent	* sd;
	wait_queue_head_t	poll;
};

extern int kobject_set_name(struct kobject *, const char *, ...)
	__attribute__((format(printf,2,3)));

static inline const char * kobject_name(const struct kobject * kobj)
{
	return kobj->k_name;
}

extern void kobject_init(struct kobject *);
extern void kobject_cleanup(struct kobject *);

extern int __must_check kobject_add(struct kobject *);
extern int __must_check kobject_shadow_add(struct kobject *kobj,
					   struct sysfs_dirent *shadow_parent);
extern void kobject_del(struct kobject *);

extern int __must_check kobject_rename(struct kobject *, const char *new_name);
extern int __must_check kobject_shadow_rename(struct kobject *kobj,
					      struct sysfs_dirent *new_parent,
					      const char *new_name);
extern int __must_check kobject_move(struct kobject *, struct kobject *);

extern int __must_check kobject_register(struct kobject *);
extern void kobject_unregister(struct kobject *);

extern struct kobject * kobject_get(struct kobject *);
extern void kobject_put(struct kobject *);

extern struct kobject *kobject_kset_add_dir(struct kset *kset,
					    struct kobject *, const char *);
extern struct kobject *kobject_add_dir(struct kobject *, const char *);

extern char * kobject_get_path(struct kobject *, gfp_t);

struct kobj_type {
	void (*release)(struct kobject *);
	struct sysfs_ops	* sysfs_ops;
	struct attribute	** default_attrs;
};

struct kobj_uevent_env {
	char *envp[UEVENT_NUM_ENVP];
	int envp_idx;
	char buf[UEVENT_BUFFER_SIZE];
	int buflen;
};

struct kset_uevent_ops {
	int (*filter)(struct kset *kset, struct kobject *kobj);
	const char *(*name)(struct kset *kset, struct kobject *kobj);
	int (*uevent)(struct kset *kset, struct kobject *kobj,
		      struct kobj_uevent_env *env);
};

/*
 *	struct kset - a set of kobjects of a specific type, belonging
 *	to a specific subsystem.
 *
 *	All kobjects of a kset should be embedded in an identical 
 *	type. This type may have a descriptor, which the kset points
 *	to. This allows there to exist sets of objects of the same
 *	type in different subsystems.
 *
 *	A subsystem does not have to be a list of only one type 
 *	of object; multiple ksets can belong to one subsystem. All 
 *	ksets of a subsystem share the subsystem's lock.
 *
 *	Each kset can support specific event variables; it can
 *	supress the event generation or add subsystem specific
 *	variables carried with the event.
 */
struct kset {
	struct kobj_type	* ktype;
	struct list_head	list;
	spinlock_t		list_lock;
	struct kobject		kobj;
	struct kset_uevent_ops	* uevent_ops;
};


extern void kset_init(struct kset * k);
extern int __must_check kset_add(struct kset * k);
extern int __must_check kset_register(struct kset * k);
extern void kset_unregister(struct kset * k);

static inline struct kset * to_kset(struct kobject * kobj)
{
	return kobj ? container_of(kobj,struct kset,kobj) : NULL;
}

static inline struct kset * kset_get(struct kset * k)
{
	return k ? to_kset(kobject_get(&k->kobj)) : NULL;
}

static inline void kset_put(struct kset * k)
{
	kobject_put(&k->kobj);
}

static inline struct kobj_type * get_ktype(struct kobject * k)
{
	if (k->kset && k->kset->ktype)
		return k->kset->ktype;
	else 
		return k->ktype;
}

extern struct kobject * kset_find_obj(struct kset *, const char *);


/*
 * Use this when initializing an embedded kset with no other 
 * fields to initialize.
 */
#define set_kset_name(str)	.kset = { .kobj = { .name = str } }


#define decl_subsys(_name,_type,_uevent_ops) \
struct kset _name##_subsys = { \
	.kobj = { .name = __stringify(_name) }, \
	.ktype = _type, \
	.uevent_ops =_uevent_ops, \
}
#define decl_subsys_name(_varname,_name,_type,_uevent_ops) \
struct kset _varname##_subsys = { \
	.kobj = { .name = __stringify(_name) }, \
	.ktype = _type, \
	.uevent_ops =_uevent_ops, \
}

/* The global /sys/kernel/ subsystem for people to chain off of */
extern struct kset kernel_subsys;
/* The global /sys/hypervisor/ subsystem  */
extern struct kset hypervisor_subsys;

/*
 * Helpers for setting the kset of registered objects.
 * Often, a registered object belongs to a kset embedded in a 
 * subsystem. These do no magic, just make the resulting code
 * easier to follow. 
 */

/**
 *	kobj_set_kset_s(obj,subsys) - set kset for embedded kobject.
 *	@obj:		ptr to some object type.
 *	@subsys:	a subsystem object (not a ptr).
 *
 *	Can be used for any object type with an embedded ->kobj.
 */

#define kobj_set_kset_s(obj,subsys) \
	(obj)->kobj.kset = &(subsys)

/**
 *	kset_set_kset_s(obj,subsys) - set kset for embedded kset.
 *	@obj:		ptr to some object type.
 *	@subsys:	a subsystem object (not a ptr).
 *
 *	Can be used for any object type with an embedded ->kset.
 *	Sets the kset of @obj's  embedded kobject (via its embedded
 *	kset) to @subsys.kset. This makes @obj a member of that 
 *	kset.
 */

#define kset_set_kset_s(obj,subsys) \
	(obj)->kset.kobj.kset = &(subsys)

/**
 *	subsys_set_kset(obj,subsys) - set kset for subsystem
 *	@obj:		ptr to some object type.
 *	@_subsys:	a subsystem object (not a ptr).
 *
 *	Can be used for any object type with an embedded ->subsys.
 *	Sets the kset of @obj's kobject to @subsys.kset. This makes
 *	the object a member of that kset.
 */

#define subsys_set_kset(obj,_subsys) \
	(obj)->subsys.kobj.kset = &(_subsys)

extern void subsystem_init(struct kset *);
extern int __must_check subsystem_register(struct kset *);
extern void subsystem_unregister(struct kset *);

static inline struct kset *subsys_get(struct kset *s)
{
	if (s)
		return kset_get(s);
	return NULL;
}

static inline void subsys_put(struct kset *s)
{
	kset_put(s);
}

struct subsys_attribute {
	struct attribute attr;
	ssize_t (*show)(struct kset *, char *);
	ssize_t (*store)(struct kset *, const char *, size_t);
};

extern int __must_check subsys_create_file(struct kset *,
					struct subsys_attribute *);

#if defined(CONFIG_HOTPLUG)
int kobject_uevent(struct kobject *kobj, enum kobject_action action);
int kobject_uevent_env(struct kobject *kobj, enum kobject_action action,
			char *envp[]);

int add_uevent_var(struct kobj_uevent_env *env, const char *format, ...)
	__attribute__((format (printf, 2, 3)));
#else
static inline int kobject_uevent(struct kobject *kobj, enum kobject_action action)
{ return 0; }
static inline int kobject_uevent_env(struct kobject *kobj,
				      enum kobject_action action,
				      char *envp[])
{ return 0; }

static inline int add_uevent_var(struct kobj_uevent_env *env, const char *format, ...)
{ return 0; }
#endif

#endif /* __KERNEL__ */
#endif /* _KOBJECT_H_ */
Commit	Line	Data
1da177e4 LT	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	*
	7	* This file is released under the GPLv2.
	8	*
	9	*
	10	* Please read Documentation/kobject.txt before using the kobject
	11	* interface, ESPECIALLY the parts about reference counts and object
	12	* destructors.
	13	*/
	14
	15	#ifndef _KOBJECT_H_
	16	#define _KOBJECT_H_
	17
	18	#ifdef __KERNEL__
	19
	20	#include <linux/types.h>
	21	#include <linux/list.h>
	22	#include <linux/sysfs.h>
4a7fb636	23	#include <linux/compiler.h>
1da177e4	24	#include <linux/spinlock.h>
1da177e4	25	#include <linux/kref.h>
1da177e4	26	#include <linux/kernel.h>
4508a7a7	27	#include <linux/wait.h>
1da177e4 LT	28	#include <asm/atomic.h>
1da177e4 LT	29
312c004d KS	30	#define KOBJ_NAME_LEN 20
312c004d KS	31	#define UEVENT_HELPER_PATH_LEN 256
7eff2e7a KS	32	#define UEVENT_NUM_ENVP 32 /* number of env pointers */
7eff2e7a KS	33	#define UEVENT_BUFFER_SIZE 2048 /* buffer for the variables */
0296b228 KS	34
0296b228 KS	35	/* path to the userspace helper executed on an event */
312c004d	36	extern char uevent_helper[];
0296b228	37
312c004d KS	38	/* counter to tag the uevent, read only except for the kobject core */
312c004d KS	39	extern u64 uevent_seqnum;
1da177e4	40
60a96a59 KS	41	/*
	42	* The actions here must match the index to the string array
	43	* in lib/kobject_uevent.c
	44	*
	45	* Do not add new actions here without checking with the driver-core
	46	* maintainers. Action strings are not meant to express subsystem
	47	* or device specific properties. In most cases you want to send a
	48	* kobject_uevent_env(kobj, KOBJ_CHANGE, env) with additional event
	49	* specific variables added to the event environment.
	50	*/
0296b228	51	enum kobject_action {
60a96a59 KS	52	KOBJ_ADD,
	53	KOBJ_REMOVE,
	54	KOBJ_CHANGE,
	55	KOBJ_MOVE,
	56	KOBJ_ONLINE,
	57	KOBJ_OFFLINE,
	58	KOBJ_MAX
0296b228 KS	59	};
0296b228 KS	60
ff2ee8cf GKH	61	/* The list of strings defining the valid kobject actions as specified above */
	62	extern const char *kobject_actions[];
	63
1da177e4	64	struct kobject {
f3b4f3c6	65	const char * k_name;
1da177e4 LT	66	char name[KOBJ_NAME_LEN];
	67	struct kref kref;
	68	struct list_head entry;
	69	struct kobject * parent;
	70	struct kset * kset;
	71	struct kobj_type * ktype;
608e266a	72	struct sysfs_dirent * sd;
4508a7a7	73	wait_queue_head_t poll;
1da177e4 LT	74	};
	75
	76	extern int kobject_set_name(struct kobject , const char , ...)
	77	__attribute__((format(printf,2,3)));
	78
f3b4f3c6	79	static inline const char * kobject_name(const struct kobject * kobj)
1da177e4 LT	80	{
	81	return kobj->k_name;
	82	}
	83
	84	extern void kobject_init(struct kobject *);
	85	extern void kobject_cleanup(struct kobject *);
	86
4a7fb636	87	extern int __must_check kobject_add(struct kobject *);
608e266a TH	88	extern int __must_check kobject_shadow_add(struct kobject *kobj,
608e266a TH	89	struct sysfs_dirent *shadow_parent);
1da177e4 LT	90	extern void kobject_del(struct kobject *);
1da177e4 LT	91
4a7fb636	92	extern int __must_check kobject_rename(struct kobject , const char new_name);
b592fcfe	93	extern int __must_check kobject_shadow_rename(struct kobject *kobj,
608e266a TH	94	struct sysfs_dirent *new_parent,
608e266a TH	95	const char *new_name);
8a82472f	96	extern int __must_check kobject_move(struct kobject , struct kobject );
1da177e4	97
4a7fb636	98	extern int __must_check kobject_register(struct kobject *);
1da177e4 LT	99	extern void kobject_unregister(struct kobject *);
	100
	101	extern struct kobject * kobject_get(struct kobject *);
	102	extern void kobject_put(struct kobject *);
	103
86406245 KS	104	extern struct kobject kobject_kset_add_dir(struct kset kset,
86406245 KS	105	struct kobject , const char );
7423172a JN	106	extern struct kobject kobject_add_dir(struct kobject , const char *);
7423172a JN	107
fd4f2df2	108	extern char * kobject_get_path(struct kobject *, gfp_t);
1da177e4 LT	109
	110	struct kobj_type {
	111	void (release)(struct kobject );
	112	struct sysfs_ops * sysfs_ops;
	113	struct attribute ** default_attrs;
	114	};
	115
7eff2e7a KS	116	struct kobj_uevent_env {
	117	char *envp[UEVENT_NUM_ENVP];
	118	int envp_idx;
	119	char buf[UEVENT_BUFFER_SIZE];
	120	int buflen;
	121	};
	122
a5615648 RD	123	struct kset_uevent_ops {
	124	int (filter)(struct kset kset, struct kobject *kobj);
	125	const char (name)(struct kset kset, struct kobject kobj);
7eff2e7a KS	126	int (uevent)(struct kset kset, struct kobject *kobj,
7eff2e7a KS	127	struct kobj_uevent_env *env);
a5615648	128	};
1da177e4	129
a5615648 RD	130	/*
a5615648 RD	131	* struct kset - a set of kobjects of a specific type, belonging
1da177e4 LT	132	* to a specific subsystem.
	133	*
	134	* All kobjects of a kset should be embedded in an identical
	135	* type. This type may have a descriptor, which the kset points
	136	* to. This allows there to exist sets of objects of the same
	137	* type in different subsystems.
	138	*
	139	* A subsystem does not have to be a list of only one type
	140	* of object; multiple ksets can belong to one subsystem. All
	141	* ksets of a subsystem share the subsystem's lock.
	142	*
312c004d KS	143	* Each kset can support specific event variables; it can
	144	* supress the event generation or add subsystem specific
	145	* variables carried with the event.
1da177e4	146	*/
1da177e4	147	struct kset {
1da177e4 LT	148	struct kobj_type * ktype;
	149	struct list_head list;
	150	spinlock_t list_lock;
	151	struct kobject kobj;
312c004d	152	struct kset_uevent_ops * uevent_ops;
1da177e4 LT	153	};
	154
	155
	156	extern void kset_init(struct kset * k);
4a7fb636 AM	157	extern int __must_check kset_add(struct kset * k);
4a7fb636 AM	158	extern int __must_check kset_register(struct kset * k);
1da177e4 LT	159	extern void kset_unregister(struct kset * k);
	160
	161	static inline struct kset * to_kset(struct kobject * kobj)
	162	{
	163	return kobj ? container_of(kobj,struct kset,kobj) : NULL;
	164	}
	165
	166	static inline struct kset * kset_get(struct kset * k)
	167	{
	168	return k ? to_kset(kobject_get(&k->kobj)) : NULL;
	169	}
	170
	171	static inline void kset_put(struct kset * k)
	172	{
	173	kobject_put(&k->kobj);
	174	}
	175
	176	static inline struct kobj_type * get_ktype(struct kobject * k)
	177	{
	178	if (k->kset && k->kset->ktype)
	179	return k->kset->ktype;
	180	else
	181	return k->ktype;
	182	}
	183
	184	extern struct kobject * kset_find_obj(struct kset , const char );
	185
	186
a5615648	187	/*
1da177e4 LT	188	* Use this when initializing an embedded kset with no other
	189	* fields to initialize.
	190	*/
	191	#define set_kset_name(str) .kset = { .kobj = { .name = str } }
	192
	193
312c004d	194	#define decl_subsys(_name,_type,_uevent_ops) \
823bccfc GKH	195	struct kset _name##_subsys = { \
	196	.kobj = { .name = __stringify(_name) }, \
	197	.ktype = _type, \
	198	.uevent_ops =_uevent_ops, \
1da177e4	199	}
312c004d	200	#define decl_subsys_name(_varname,_name,_type,_uevent_ops) \
823bccfc GKH	201	struct kset _varname##_subsys = { \
	202	.kobj = { .name = __stringify(_name) }, \
	203	.ktype = _type, \
	204	.uevent_ops =_uevent_ops, \
1da177e4 LT	205	}
	206
	207	/* The global /sys/kernel/ subsystem for people to chain off of */
823bccfc	208	extern struct kset kernel_subsys;
4039483f	209	/* The global /sys/hypervisor/ subsystem */
823bccfc	210	extern struct kset hypervisor_subsys;
1da177e4	211
a5615648	212	/*
1da177e4 LT	213	* Helpers for setting the kset of registered objects.
	214	* Often, a registered object belongs to a kset embedded in a
	215	* subsystem. These do no magic, just make the resulting code
	216	* easier to follow.
	217	*/
	218
	219	/**
	220	* kobj_set_kset_s(obj,subsys) - set kset for embedded kobject.
	221	* @obj: ptr to some object type.
	222	* @subsys: a subsystem object (not a ptr).
	223	*
	224	* Can be used for any object type with an embedded ->kobj.
	225	*/
	226
	227	#define kobj_set_kset_s(obj,subsys) \
823bccfc	228	(obj)->kobj.kset = &(subsys)
1da177e4 LT	229
	230	/**
	231	* kset_set_kset_s(obj,subsys) - set kset for embedded kset.
	232	* @obj: ptr to some object type.
	233	* @subsys: a subsystem object (not a ptr).
	234	*
	235	* Can be used for any object type with an embedded ->kset.
	236	* Sets the kset of @obj's embedded kobject (via its embedded
	237	* kset) to @subsys.kset. This makes @obj a member of that
	238	* kset.
	239	*/
	240
	241	#define kset_set_kset_s(obj,subsys) \
823bccfc	242	(obj)->kset.kobj.kset = &(subsys)
1da177e4 LT	243
	244	/**
	245	* subsys_set_kset(obj,subsys) - set kset for subsystem
	246	* @obj: ptr to some object type.
a5615648	247	* @_subsys: a subsystem object (not a ptr).
1da177e4 LT	248	*
	249	* Can be used for any object type with an embedded ->subsys.
	250	* Sets the kset of @obj's kobject to @subsys.kset. This makes
	251	* the object a member of that kset.
	252	*/
	253
	254	#define subsys_set_kset(obj,_subsys) \
823bccfc	255	(obj)->subsys.kobj.kset = &(_subsys)
1da177e4	256
823bccfc GKH	257	extern void subsystem_init(struct kset *);
	258	extern int __must_check subsystem_register(struct kset *);
	259	extern void subsystem_unregister(struct kset *);
1da177e4	260
823bccfc	261	static inline struct kset subsys_get(struct kset s)
1da177e4	262	{
823bccfc GKH	263	if (s)
	264	return kset_get(s);
	265	return NULL;
1da177e4 LT	266	}
1da177e4 LT	267
823bccfc	268	static inline void subsys_put(struct kset *s)
1da177e4	269	{
823bccfc	270	kset_put(s);
1da177e4 LT	271	}
	272
	273	struct subsys_attribute {
	274	struct attribute attr;
823bccfc GKH	275	ssize_t (show)(struct kset , char *);
823bccfc GKH	276	ssize_t (store)(struct kset , const char *, size_t);
1da177e4 LT	277	};
1da177e4 LT	278
823bccfc	279	extern int __must_check subsys_create_file(struct kset *,
4a7fb636	280	struct subsys_attribute *);
1da177e4	281
4d17ffda	282	#if defined(CONFIG_HOTPLUG)
542cfce6 AK	283	int kobject_uevent(struct kobject *kobj, enum kobject_action action);
542cfce6 AK	284	int kobject_uevent_env(struct kobject *kobj, enum kobject_action action,
8a82472f	285	char *envp[]);
0296b228	286
7eff2e7a KS	287	int add_uevent_var(struct kobj_uevent_env env, const char format, ...)
7eff2e7a KS	288	__attribute__((format (printf, 2, 3)));
1da177e4	289	#else
542cfce6 AK	290	static inline int kobject_uevent(struct kobject *kobj, enum kobject_action action)
	291	{ return 0; }
	292	static inline int kobject_uevent_env(struct kobject *kobj,
8a82472f CH	293	enum kobject_action action,
8a82472f CH	294	char *envp[])
542cfce6	295	{ return 0; }
5f123fbd	296
7eff2e7a	297	static inline int add_uevent_var(struct kobj_uevent_env env, const char format, ...)
1da177e4 LT	298	{ return 0; }
	299	#endif
	300
	301	#endif /* __KERNEL__ */
	302	#endif /* _KOBJECT_H_ */