2005-04-16 16:20:36 -06:00
|
|
|
/*
|
|
|
|
* kobject.h - generic kernel object infrastructure.
|
|
|
|
*
|
2007-09-27 15:48:53 -06:00
|
|
|
* Copyright (c) 2002-2003 Patrick Mochel
|
|
|
|
* Copyright (c) 2002-2003 Open Source Development Labs
|
2008-01-24 22:27:06 -07:00
|
|
|
* Copyright (c) 2006-2008 Greg Kroah-Hartman <greg@kroah.com>
|
|
|
|
* Copyright (c) 2006-2008 Novell Inc.
|
2005-04-16 16:20:36 -06:00
|
|
|
*
|
|
|
|
* 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
|
2008-01-24 22:27:06 -07:00
|
|
|
* destructors.
|
2005-04-16 16:20:36 -06:00
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef _KOBJECT_H_
|
|
|
|
#define _KOBJECT_H_
|
|
|
|
|
|
|
|
#include <linux/types.h>
|
|
|
|
#include <linux/list.h>
|
|
|
|
#include <linux/sysfs.h>
|
2006-08-14 23:43:17 -06:00
|
|
|
#include <linux/compiler.h>
|
2005-04-16 16:20:36 -06:00
|
|
|
#include <linux/spinlock.h>
|
|
|
|
#include <linux/kref.h>
|
2010-08-11 08:01:02 -06:00
|
|
|
#include <linux/kobject_ns.h>
|
2005-04-16 16:20:36 -06:00
|
|
|
#include <linux/kernel.h>
|
2006-03-19 23:53:53 -07:00
|
|
|
#include <linux/wait.h>
|
2011-07-26 17:09:06 -06:00
|
|
|
#include <linux/atomic.h>
|
2005-04-16 16:20:36 -06:00
|
|
|
|
2005-11-16 01:00:00 -07:00
|
|
|
#define UEVENT_HELPER_PATH_LEN 256
|
2007-08-14 07:15:12 -06:00
|
|
|
#define UEVENT_NUM_ENVP 32 /* number of env pointers */
|
|
|
|
#define UEVENT_BUFFER_SIZE 2048 /* buffer for the variables */
|
2005-11-10 21:33:52 -07:00
|
|
|
|
|
|
|
/* path to the userspace helper executed on an event */
|
2005-11-16 01:00:00 -07:00
|
|
|
extern char uevent_helper[];
|
2005-11-10 21:33:52 -07:00
|
|
|
|
2005-11-16 01:00:00 -07:00
|
|
|
/* counter to tag the uevent, read only except for the kobject core */
|
|
|
|
extern u64 uevent_seqnum;
|
2005-04-16 16:20:36 -06:00
|
|
|
|
2007-07-08 14:29:26 -06:00
|
|
|
/*
|
|
|
|
* 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.
|
|
|
|
*/
|
2005-11-10 21:33:52 -07:00
|
|
|
enum kobject_action {
|
2007-07-08 14:29:26 -06:00
|
|
|
KOBJ_ADD,
|
|
|
|
KOBJ_REMOVE,
|
|
|
|
KOBJ_CHANGE,
|
|
|
|
KOBJ_MOVE,
|
|
|
|
KOBJ_ONLINE,
|
|
|
|
KOBJ_OFFLINE,
|
|
|
|
KOBJ_MAX
|
2005-11-10 21:33:52 -07:00
|
|
|
};
|
|
|
|
|
2005-04-16 16:20:36 -06:00
|
|
|
struct kobject {
|
2007-12-19 18:09:39 -07:00
|
|
|
const char *name;
|
2005-04-16 16:20:36 -06:00
|
|
|
struct list_head entry;
|
2008-01-24 22:27:06 -07:00
|
|
|
struct kobject *parent;
|
|
|
|
struct kset *kset;
|
|
|
|
struct kobj_type *ktype;
|
|
|
|
struct sysfs_dirent *sd;
|
2008-06-02 04:07:25 -06:00
|
|
|
struct kref kref;
|
2007-12-18 17:40:42 -07:00
|
|
|
unsigned int state_initialized:1;
|
|
|
|
unsigned int state_in_sysfs:1;
|
|
|
|
unsigned int state_add_uevent_sent:1;
|
|
|
|
unsigned int state_remove_uevent_sent:1;
|
2009-03-01 06:10:49 -07:00
|
|
|
unsigned int uevent_suppress:1;
|
2005-04-16 16:20:36 -06:00
|
|
|
};
|
|
|
|
|
2011-10-31 18:11:33 -06:00
|
|
|
extern __printf(2, 3)
|
|
|
|
int kobject_set_name(struct kobject *kobj, const char *name, ...);
|
2009-01-25 07:17:37 -07:00
|
|
|
extern int kobject_set_name_vargs(struct kobject *kobj, const char *fmt,
|
|
|
|
va_list vargs);
|
2005-04-16 16:20:36 -06:00
|
|
|
|
2008-01-24 22:27:06 -07:00
|
|
|
static inline const char *kobject_name(const struct kobject *kobj)
|
2005-04-16 16:20:36 -06:00
|
|
|
{
|
2007-12-19 18:09:39 -07:00
|
|
|
return kobj->name;
|
2005-04-16 16:20:36 -06:00
|
|
|
}
|
|
|
|
|
2007-12-17 23:05:35 -07:00
|
|
|
extern void kobject_init(struct kobject *kobj, struct kobj_type *ktype);
|
2011-10-31 18:11:33 -06:00
|
|
|
extern __printf(3, 4) __must_check
|
|
|
|
int kobject_add(struct kobject *kobj, struct kobject *parent,
|
|
|
|
const char *fmt, ...);
|
|
|
|
extern __printf(4, 5) __must_check
|
|
|
|
int kobject_init_and_add(struct kobject *kobj,
|
|
|
|
struct kobj_type *ktype, struct kobject *parent,
|
|
|
|
const char *fmt, ...);
|
2007-12-03 22:31:08 -07:00
|
|
|
|
2008-01-24 22:27:06 -07:00
|
|
|
extern void kobject_del(struct kobject *kobj);
|
2005-04-16 16:20:36 -06:00
|
|
|
|
2007-11-05 23:24:43 -07:00
|
|
|
extern struct kobject * __must_check kobject_create(void);
|
2007-11-05 14:16:15 -07:00
|
|
|
extern struct kobject * __must_check kobject_create_and_add(const char *name,
|
|
|
|
struct kobject *parent);
|
|
|
|
|
2006-08-14 23:43:17 -06:00
|
|
|
extern int __must_check kobject_rename(struct kobject *, const char *new_name);
|
2006-11-20 09:07:51 -07:00
|
|
|
extern int __must_check kobject_move(struct kobject *, struct kobject *);
|
2005-04-16 16:20:36 -06:00
|
|
|
|
2008-01-24 22:27:06 -07:00
|
|
|
extern struct kobject *kobject_get(struct kobject *kobj);
|
|
|
|
extern void kobject_put(struct kobject *kobj);
|
2005-04-16 16:20:36 -06:00
|
|
|
|
2008-01-24 22:27:06 -07:00
|
|
|
extern char *kobject_get_path(struct kobject *kobj, gfp_t flag);
|
2005-04-16 16:20:36 -06:00
|
|
|
|
|
|
|
struct kobj_type {
|
2008-01-24 22:27:06 -07:00
|
|
|
void (*release)(struct kobject *kobj);
|
2010-01-18 18:58:23 -07:00
|
|
|
const struct sysfs_ops *sysfs_ops;
|
2008-01-24 22:27:06 -07:00
|
|
|
struct attribute **default_attrs;
|
2010-03-30 12:31:25 -06:00
|
|
|
const struct kobj_ns_type_operations *(*child_ns_type)(struct kobject *kobj);
|
|
|
|
const void *(*namespace)(struct kobject *kobj);
|
2005-04-16 16:20:36 -06:00
|
|
|
};
|
|
|
|
|
2007-08-14 07:15:12 -06:00
|
|
|
struct kobj_uevent_env {
|
|
|
|
char *envp[UEVENT_NUM_ENVP];
|
|
|
|
int envp_idx;
|
|
|
|
char buf[UEVENT_BUFFER_SIZE];
|
|
|
|
int buflen;
|
|
|
|
};
|
|
|
|
|
2007-07-27 10:36:26 -06:00
|
|
|
struct kset_uevent_ops {
|
2009-12-31 06:52:51 -07:00
|
|
|
int (* const filter)(struct kset *kset, struct kobject *kobj);
|
|
|
|
const char *(* const name)(struct kset *kset, struct kobject *kobj);
|
|
|
|
int (* const uevent)(struct kset *kset, struct kobject *kobj,
|
2007-08-14 07:15:12 -06:00
|
|
|
struct kobj_uevent_env *env);
|
2007-07-27 10:36:26 -06:00
|
|
|
};
|
2005-04-16 16:20:36 -06:00
|
|
|
|
2007-11-02 06:47:53 -06:00
|
|
|
struct kobj_attribute {
|
|
|
|
struct attribute attr;
|
|
|
|
ssize_t (*show)(struct kobject *kobj, struct kobj_attribute *attr,
|
|
|
|
char *buf);
|
|
|
|
ssize_t (*store)(struct kobject *kobj, struct kobj_attribute *attr,
|
|
|
|
const char *buf, size_t count);
|
|
|
|
};
|
|
|
|
|
2010-01-18 18:58:23 -07:00
|
|
|
extern const struct sysfs_ops kobj_sysfs_ops;
|
2007-11-02 06:47:53 -06:00
|
|
|
|
2010-03-30 12:31:25 -06:00
|
|
|
struct sock;
|
2010-05-03 15:23:15 -06:00
|
|
|
|
2007-09-27 15:48:53 -06:00
|
|
|
/**
|
|
|
|
* struct kset - a set of kobjects of a specific type, belonging to a specific subsystem.
|
2005-04-16 16:20:36 -06:00
|
|
|
*
|
2007-09-27 15:48:53 -06:00
|
|
|
* A kset defines a group of kobjects. They can be individually
|
|
|
|
* different "types" but overall these kobjects all want to be grouped
|
|
|
|
* together and operated on in the same manner. ksets are used to
|
|
|
|
* define the attribute callbacks and other common events that happen to
|
|
|
|
* a kobject.
|
2005-04-16 16:20:36 -06:00
|
|
|
*
|
2007-09-27 15:48:53 -06:00
|
|
|
* @list: the list of all kobjects for this kset
|
|
|
|
* @list_lock: a lock for iterating over the kobjects
|
|
|
|
* @kobj: the embedded kobject for this kset (recursion, isn't it fun...)
|
|
|
|
* @uevent_ops: the set of uevent operations for this kset. These are
|
|
|
|
* called whenever a kobject has something happen to it so that the kset
|
|
|
|
* can add new environment variables, or filter out the uevents if so
|
|
|
|
* desired.
|
2005-04-16 16:20:36 -06:00
|
|
|
*/
|
|
|
|
struct kset {
|
2008-01-24 22:27:06 -07:00
|
|
|
struct list_head list;
|
|
|
|
spinlock_t list_lock;
|
|
|
|
struct kobject kobj;
|
2009-12-31 06:52:51 -07:00
|
|
|
const struct kset_uevent_ops *uevent_ops;
|
2005-04-16 16:20:36 -06:00
|
|
|
};
|
|
|
|
|
2008-01-24 22:27:06 -07:00
|
|
|
extern void kset_init(struct kset *kset);
|
|
|
|
extern int __must_check kset_register(struct kset *kset);
|
|
|
|
extern void kset_unregister(struct kset *kset);
|
2007-09-27 15:48:53 -06:00
|
|
|
extern struct kset * __must_check kset_create_and_add(const char *name,
|
2009-12-31 06:52:51 -07:00
|
|
|
const struct kset_uevent_ops *u,
|
2007-09-27 15:48:53 -06:00
|
|
|
struct kobject *parent_kobj);
|
2005-04-16 16:20:36 -06:00
|
|
|
|
2008-01-24 22:27:06 -07:00
|
|
|
static inline struct kset *to_kset(struct kobject *kobj)
|
2005-04-16 16:20:36 -06:00
|
|
|
{
|
2008-01-24 22:27:06 -07:00
|
|
|
return kobj ? container_of(kobj, struct kset, kobj) : NULL;
|
2005-04-16 16:20:36 -06:00
|
|
|
}
|
|
|
|
|
2008-01-24 22:27:06 -07:00
|
|
|
static inline struct kset *kset_get(struct kset *k)
|
2005-04-16 16:20:36 -06:00
|
|
|
{
|
|
|
|
return k ? to_kset(kobject_get(&k->kobj)) : NULL;
|
|
|
|
}
|
|
|
|
|
2008-01-24 22:27:06 -07:00
|
|
|
static inline void kset_put(struct kset *k)
|
2005-04-16 16:20:36 -06:00
|
|
|
{
|
|
|
|
kobject_put(&k->kobj);
|
|
|
|
}
|
|
|
|
|
2007-10-16 10:11:44 -06:00
|
|
|
static inline struct kobj_type *get_ktype(struct kobject *kobj)
|
2005-04-16 16:20:36 -06:00
|
|
|
{
|
2007-10-16 10:11:44 -06:00
|
|
|
return kobj->ktype;
|
2005-04-16 16:20:36 -06:00
|
|
|
}
|
|
|
|
|
2008-01-24 22:27:06 -07:00
|
|
|
extern struct kobject *kset_find_obj(struct kset *, const char *);
|
2005-04-16 16:20:36 -06:00
|
|
|
|
2007-11-06 11:36:58 -07:00
|
|
|
/* The global /sys/kernel/ kobject for people to chain off of */
|
|
|
|
extern struct kobject *kernel_kobj;
|
2008-07-23 22:27:39 -06:00
|
|
|
/* The global /sys/kernel/mm/ kobject for people to chain off of */
|
|
|
|
extern struct kobject *mm_kobj;
|
2007-11-01 09:29:06 -06:00
|
|
|
/* The global /sys/hypervisor/ kobject for people to chain off of */
|
|
|
|
extern struct kobject *hypervisor_kobj;
|
2007-11-27 12:28:26 -07:00
|
|
|
/* The global /sys/power/ kobject for people to chain off of */
|
|
|
|
extern struct kobject *power_kobj;
|
2007-11-05 14:16:15 -07:00
|
|
|
/* The global /sys/firmware/ kobject for people to chain off of */
|
|
|
|
extern struct kobject *firmware_kobj;
|
2005-04-16 16:20:36 -06:00
|
|
|
|
2006-04-25 07:37:26 -06:00
|
|
|
#if defined(CONFIG_HOTPLUG)
|
2006-12-19 14:01:27 -07:00
|
|
|
int kobject_uevent(struct kobject *kobj, enum kobject_action action);
|
|
|
|
int kobject_uevent_env(struct kobject *kobj, enum kobject_action action,
|
2006-11-20 09:07:51 -07:00
|
|
|
char *envp[]);
|
2005-11-10 21:33:52 -07:00
|
|
|
|
2011-10-31 18:11:33 -06:00
|
|
|
__printf(2, 3)
|
|
|
|
int add_uevent_var(struct kobj_uevent_env *env, const char *format, ...);
|
2007-08-12 12:43:55 -06:00
|
|
|
|
|
|
|
int kobject_action_type(const char *buf, size_t count,
|
|
|
|
enum kobject_action *type);
|
2005-04-16 16:20:36 -06:00
|
|
|
#else
|
2008-01-24 22:27:06 -07:00
|
|
|
static inline int kobject_uevent(struct kobject *kobj,
|
|
|
|
enum kobject_action action)
|
2006-12-19 14:01:27 -07:00
|
|
|
{ return 0; }
|
|
|
|
static inline int kobject_uevent_env(struct kobject *kobj,
|
2006-11-20 09:07:51 -07:00
|
|
|
enum kobject_action action,
|
|
|
|
char *envp[])
|
2006-12-19 14:01:27 -07:00
|
|
|
{ return 0; }
|
2005-11-11 06:43:07 -07:00
|
|
|
|
2011-10-31 18:11:33 -06:00
|
|
|
static inline __printf(2, 3)
|
2011-02-06 22:57:18 -07:00
|
|
|
int add_uevent_var(struct kobj_uevent_env *env, const char *format, ...)
|
kobject: fix oops with "input0: bad kobj_uevent_env content in show_uevent()"
Fengguang Wu <fengguang.wu@intel.com> writes:
> After the __devinit* removal series, I can still get kernel panic in
> show_uevent(). So there are more sources of bug..
>
> Debug patch:
>
> @@ -343,8 +343,11 @@ static ssize_t show_uevent(struct device
> goto out;
>
> /* copy keys to file */
> - for (i = 0; i < env->envp_idx; i++)
> + dev_err(dev, "uevent %d env[%d]: %s/.../%s\n", env->buflen, env->envp_idx, top_kobj->name, dev->kobj.name);
> + for (i = 0; i < env->envp_idx; i++) {
> + printk(KERN_ERR "uevent %d env[%d]: %s\n", (int)count, i, env->envp[i]);
> count += sprintf(&buf[count], "%s\n", env->envp[i]);
> + }
>
> Oops message, the env[] is again not properly initilized:
>
> [ 44.068623] input input0: uevent 61 env[805306368]: input0/.../input0
> [ 44.069552] uevent 0 env[0]: (null)
This is a completely different CONFIG_HOTPLUG problem, only
demonstrating another reason why CONFIG_HOTPLUG should go away. I had a
hard time trying to disable it anyway ;-)
The problem this time is lots of code assuming that a call to
add_uevent_var() will guarantee that env->buflen > 0. This is not true
if CONFIG_HOTPLUG is unset. So things like this end up overwriting
env->envp_idx because the array index is -1:
if (add_uevent_var(env, "MODALIAS="))
return -ENOMEM;
len = input_print_modalias(&env->buf[env->buflen - 1],
sizeof(env->buf) - env->buflen,
dev, 0);
Don't know what the best action is, given that there seem to be a *lot*
of this around the kernel. This patch "fixes" the problem for me, but I
don't know if it can be considered an appropriate fix.
[ It is the correct fix for now, for 3.7 forcing CONFIG_HOTPLUG to
always be on is the longterm fix, but it's too late for 3.6 and older
kernels to resolve this that way - gregkh ]
Reported-by: Fengguang Wu <fengguang.wu@intel.com>
Signed-off-by: Bjørn Mork <bjorn@mork.no>
Tested-by: Fengguang Wu <fengguang.wu@intel.com>
Cc: stable <stable@vger.kernel.org>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
2012-09-02 07:41:34 -06:00
|
|
|
{ return -ENOMEM; }
|
2007-08-12 12:43:55 -06:00
|
|
|
|
|
|
|
static inline int kobject_action_type(const char *buf, size_t count,
|
2008-01-24 22:27:06 -07:00
|
|
|
enum kobject_action *type)
|
2007-08-12 12:43:55 -06:00
|
|
|
{ return -EINVAL; }
|
2005-04-16 16:20:36 -06:00
|
|
|
#endif
|
|
|
|
|
|
|
|
#endif /* _KOBJECT_H_ */
|