blob: 4d800c79475a29fca0cf87c6936174c4ffd509d2 [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>
Russell Kingc817a672013-06-27 15:06:14 +010029#include <linux/workqueue.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030
Kay Sievers312c0042005-11-16 09:00:00 +010031#define UEVENT_HELPER_PATH_LEN 256
Kay Sievers7eff2e72007-08-14 15:15:12 +020032#define UEVENT_NUM_ENVP 32 /* number of env pointers */
33#define UEVENT_BUFFER_SIZE 2048 /* buffer for the variables */
Kay Sievers0296b222005-11-11 05:33:52 +010034
Michael Marineau86d56132014-04-10 14:09:31 -070035#ifdef CONFIG_UEVENT_HELPER
Kay Sievers0296b222005-11-11 05:33:52 +010036/* path to the userspace helper executed on an event */
Kay Sievers312c0042005-11-16 09:00:00 +010037extern char uevent_helper[];
Michael Marineau86d56132014-04-10 14:09:31 -070038#endif
Kay Sievers0296b222005-11-11 05:33:52 +010039
Kay Sievers312c0042005-11-16 09:00:00 +010040/* counter to tag the uevent, read only except for the kobject core */
41extern u64 uevent_seqnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -070042
Kay Sievers60a96a52007-07-08 22:29:26 +020043/*
44 * The actions here must match the index to the string array
45 * in lib/kobject_uevent.c
46 *
47 * Do not add new actions here without checking with the driver-core
48 * maintainers. Action strings are not meant to express subsystem
49 * or device specific properties. In most cases you want to send a
50 * kobject_uevent_env(kobj, KOBJ_CHANGE, env) with additional event
51 * specific variables added to the event environment.
52 */
Kay Sievers0296b222005-11-11 05:33:52 +010053enum kobject_action {
Kay Sievers60a96a52007-07-08 22:29:26 +020054 KOBJ_ADD,
55 KOBJ_REMOVE,
56 KOBJ_CHANGE,
57 KOBJ_MOVE,
58 KOBJ_ONLINE,
59 KOBJ_OFFLINE,
60 KOBJ_MAX
Kay Sievers0296b222005-11-11 05:33:52 +010061};
62
Linus Torvalds1da177e2005-04-16 15:20:36 -070063struct kobject {
Kay Sieversaf5ca3f2007-12-20 02:09:39 +010064 const char *name;
Linus Torvalds1da177e2005-04-16 15:20:36 -070065 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;
Ulf Magnussonf7025702015-09-02 15:40:02 +020069 struct kernfs_node *sd; /* sysfs directory entry */
Richard Kennedya2319342008-06-02 11:07:25 +010070 struct kref kref;
Russell Kingc817a672013-06-27 15:06:14 +010071#ifdef CONFIG_DEBUG_KOBJECT_RELEASE
72 struct delayed_work release;
73#endif
Kay Sievers0f4dafc2007-12-19 01:40:42 +010074 unsigned int state_initialized:1;
Kay Sievers0f4dafc2007-12-19 01:40:42 +010075 unsigned int state_in_sysfs:1;
76 unsigned int state_add_uevent_sent:1;
77 unsigned int state_remove_uevent_sent:1;
Ming Leif67f1292009-03-01 21:10:49 +080078 unsigned int uevent_suppress:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -070079};
80
Joe Perchesb9075fa2011-10-31 17:11:33 -070081extern __printf(2, 3)
82int kobject_set_name(struct kobject *kobj, const char *name, ...);
Nicolas Iooss8db14862015-07-17 16:23:42 -070083extern __printf(2, 0)
84int kobject_set_name_vargs(struct kobject *kobj, const char *fmt,
85 va_list vargs);
Linus Torvalds1da177e2005-04-16 15:20:36 -070086
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -080087static inline const char *kobject_name(const struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -070088{
Kay Sieversaf5ca3f2007-12-20 02:09:39 +010089 return kobj->name;
Linus Torvalds1da177e2005-04-16 15:20:36 -070090}
91
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -070092extern void kobject_init(struct kobject *kobj, struct kobj_type *ktype);
Joe Perchesb9075fa2011-10-31 17:11:33 -070093extern __printf(3, 4) __must_check
94int kobject_add(struct kobject *kobj, struct kobject *parent,
95 const char *fmt, ...);
96extern __printf(4, 5) __must_check
97int kobject_init_and_add(struct kobject *kobj,
98 struct kobj_type *ktype, struct kobject *parent,
99 const char *fmt, ...);
Greg Kroah-Hartmanc11c4152007-12-03 21:31:08 -0800100
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800101extern void kobject_del(struct kobject *kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800103extern struct kobject * __must_check kobject_create(void);
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800104extern struct kobject * __must_check kobject_create_and_add(const char *name,
105 struct kobject *parent);
106
Andrew Morton4a7fb632006-08-14 22:43:17 -0700107extern int __must_check kobject_rename(struct kobject *, const char *new_name);
Cornelia Huck8a824722006-11-20 17:07:51 +0100108extern int __must_check kobject_move(struct kobject *, struct kobject *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800110extern struct kobject *kobject_get(struct kobject *kobj);
Jan Karac70c1762017-03-23 01:37:01 +0100111extern struct kobject * __must_check kobject_get_unless_zero(
112 struct kobject *kobj);
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800113extern void kobject_put(struct kobject *kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114
Tejun Heoe34ff492013-09-11 22:29:05 -0400115extern const void *kobject_namespace(struct kobject *kobj);
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800116extern char *kobject_get_path(struct kobject *kobj, gfp_t flag);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117
118struct kobj_type {
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800119 void (*release)(struct kobject *kobj);
Emese Revfy52cf25d2010-01-19 02:58:23 +0100120 const struct sysfs_ops *sysfs_ops;
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800121 struct attribute **default_attrs;
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700122 const struct kobj_ns_type_operations *(*child_ns_type)(struct kobject *kobj);
123 const void *(*namespace)(struct kobject *kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124};
125
Kay Sievers7eff2e72007-08-14 15:15:12 +0200126struct kobj_uevent_env {
Vladimir Davydovbcccff92014-04-03 14:48:21 -0700127 char *argv[3];
Kay Sievers7eff2e72007-08-14 15:15:12 +0200128 char *envp[UEVENT_NUM_ENVP];
129 int envp_idx;
130 char buf[UEVENT_BUFFER_SIZE];
131 int buflen;
132};
133
Randy Dunlapa5615642007-07-27 09:36:26 -0700134struct kset_uevent_ops {
Emese Revfy9cd43612009-12-31 14:52:51 +0100135 int (* const filter)(struct kset *kset, struct kobject *kobj);
136 const char *(* const name)(struct kset *kset, struct kobject *kobj);
137 int (* const uevent)(struct kset *kset, struct kobject *kobj,
Kay Sievers7eff2e72007-08-14 15:15:12 +0200138 struct kobj_uevent_env *env);
Randy Dunlapa5615642007-07-27 09:36:26 -0700139};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140
Kay Sievers23b52122007-11-02 13:47:53 +0100141struct kobj_attribute {
142 struct attribute attr;
143 ssize_t (*show)(struct kobject *kobj, struct kobj_attribute *attr,
144 char *buf);
145 ssize_t (*store)(struct kobject *kobj, struct kobj_attribute *attr,
146 const char *buf, size_t count);
147};
148
Emese Revfy52cf25d2010-01-19 02:58:23 +0100149extern const struct sysfs_ops kobj_sysfs_ops;
Kay Sievers23b52122007-11-02 13:47:53 +0100150
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700151struct sock;
Serge E. Hallynbe867b12010-05-03 16:23:15 -0500152
Greg Kroah-Hartman6adf7552007-09-27 14:48:53 -0700153/**
154 * struct kset - a set of kobjects of a specific type, belonging to a specific subsystem.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 *
Greg Kroah-Hartman6adf7552007-09-27 14:48:53 -0700156 * A kset defines a group of kobjects. They can be individually
157 * different "types" but overall these kobjects all want to be grouped
158 * together and operated on in the same manner. ksets are used to
159 * define the attribute callbacks and other common events that happen to
160 * a kobject.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161 *
Greg Kroah-Hartman6adf7552007-09-27 14:48:53 -0700162 * @list: the list of all kobjects for this kset
163 * @list_lock: a lock for iterating over the kobjects
164 * @kobj: the embedded kobject for this kset (recursion, isn't it fun...)
165 * @uevent_ops: the set of uevent operations for this kset. These are
166 * called whenever a kobject has something happen to it so that the kset
167 * can add new environment variables, or filter out the uevents if so
168 * desired.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170struct kset {
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800171 struct list_head list;
172 spinlock_t list_lock;
173 struct kobject kobj;
Emese Revfy9cd43612009-12-31 14:52:51 +0100174 const struct kset_uevent_ops *uevent_ops;
Kees Cook3859a272016-10-28 01:22:25 -0700175} __randomize_layout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800177extern void kset_init(struct kset *kset);
178extern int __must_check kset_register(struct kset *kset);
179extern void kset_unregister(struct kset *kset);
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700180extern struct kset * __must_check kset_create_and_add(const char *name,
Emese Revfy9cd43612009-12-31 14:52:51 +0100181 const struct kset_uevent_ops *u,
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700182 struct kobject *parent_kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800184static inline struct kset *to_kset(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185{
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800186 return kobj ? container_of(kobj, struct kset, kobj) : NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187}
188
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800189static inline struct kset *kset_get(struct kset *k)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190{
191 return k ? to_kset(kobject_get(&k->kobj)) : NULL;
192}
193
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800194static inline void kset_put(struct kset *k)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195{
196 kobject_put(&k->kobj);
197}
198
Greg Kroah-Hartman3514fac2007-10-16 10:11:44 -0600199static inline struct kobj_type *get_ktype(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200{
Greg Kroah-Hartman3514fac2007-10-16 10:11:44 -0600201 return kobj->ktype;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202}
203
Greg Kroah-Hartman79a6ee42008-01-24 21:27:06 -0800204extern struct kobject *kset_find_obj(struct kset *, const char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205
Greg Kroah-Hartman0ff21e42007-11-06 10:36:58 -0800206/* The global /sys/kernel/ kobject for people to chain off of */
207extern struct kobject *kernel_kobj;
Nishanth Aravamudanff7ea792008-07-23 21:27:39 -0700208/* The global /sys/kernel/mm/ kobject for people to chain off of */
209extern struct kobject *mm_kobj;
Greg Kroah-Hartman2d72fc02007-11-01 09:29:06 -0600210/* The global /sys/hypervisor/ kobject for people to chain off of */
211extern struct kobject *hypervisor_kobj;
Greg Kroah-Hartmand76e15f2007-11-27 11:28:26 -0800212/* The global /sys/power/ kobject for people to chain off of */
213extern struct kobject *power_kobj;
Greg Kroah-Hartmanf62ed9e2007-11-05 13:16:15 -0800214/* The global /sys/firmware/ kobject for people to chain off of */
215extern struct kobject *firmware_kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216
Aneesh Kumar K.V542cfce2006-12-19 13:01:27 -0800217int kobject_uevent(struct kobject *kobj, enum kobject_action action);
218int kobject_uevent_env(struct kobject *kobj, enum kobject_action action,
Cornelia Huck8a824722006-11-20 17:07:51 +0100219 char *envp[]);
Peter Rajnohaf36776f2017-05-09 15:22:30 +0200220int kobject_synth_uevent(struct kobject *kobj, const char *buf, size_t count);
Kay Sievers0296b222005-11-11 05:33:52 +0100221
Joe Perchesb9075fa2011-10-31 17:11:33 -0700222__printf(2, 3)
223int add_uevent_var(struct kobj_uevent_env *env, const char *format, ...);
Kay Sievers5c5daf62007-08-12 20:43:55 +0200224
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225#endif /* _KOBJECT_H_ */