[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

/* 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
};

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;
};


/**
 *	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_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, char **envp,
			int num_envp, char *buffer, int buffer_size);
};

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