Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /* |
| 2 | * kobject.c - library routines for handling generic kernel objects |
| 3 | * |
| 4 | * Copyright (c) 2002-2003 Patrick Mochel <mochel@osdl.org> |
Greg Kroah-Hartman | f0e7e1b | 2007-09-27 14:48:53 -0700 | [diff] [blame] | 5 | * Copyright (c) 2006-2007 Greg Kroah-Hartman <greg@kroah.com> |
| 6 | * Copyright (c) 2006-2007 Novell Inc. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 7 | * |
| 8 | * This file is released under the GPLv2. |
| 9 | * |
| 10 | * |
| 11 | * Please see the file Documentation/kobject.txt for critical information |
| 12 | * about using the kobject interface. |
| 13 | */ |
| 14 | |
| 15 | #include <linux/kobject.h> |
| 16 | #include <linux/string.h> |
Paul Gortmaker | 8bc3bcc | 2011-11-16 21:29:17 -0500 | [diff] [blame] | 17 | #include <linux/export.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 18 | #include <linux/stat.h> |
Tim Schmielau | 4e57b68 | 2005-10-30 15:03:48 -0800 | [diff] [blame] | 19 | #include <linux/slab.h> |
Bjorn Helgaas | 89c86a6 | 2013-12-05 17:37:51 -0700 | [diff] [blame] | 20 | #include <linux/random.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 21 | |
Tejun Heo | e34ff49 | 2013-09-11 22:29:05 -0400 | [diff] [blame] | 22 | /** |
| 23 | * kobject_namespace - return @kobj's namespace tag |
| 24 | * @kobj: kobject in question |
| 25 | * |
| 26 | * Returns namespace tag of @kobj if its parent has namespace ops enabled |
| 27 | * and thus @kobj should have a namespace tag associated with it. Returns |
| 28 | * %NULL otherwise. |
| 29 | */ |
| 30 | const void *kobject_namespace(struct kobject *kobj) |
| 31 | { |
| 32 | const struct kobj_ns_type_operations *ns_ops = kobj_ns_ops(kobj); |
| 33 | |
| 34 | if (!ns_ops || ns_ops->type == KOBJ_NS_TYPE_NONE) |
| 35 | return NULL; |
| 36 | |
Linus Torvalds | a1212d2 | 2013-11-07 20:47:28 +0900 | [diff] [blame] | 37 | return kobj->ktype->namespace(kobj); |
Tejun Heo | e34ff49 | 2013-09-11 22:29:05 -0400 | [diff] [blame] | 38 | } |
| 39 | |
Greg Kroah-Hartman | e374a2b | 2008-01-24 21:59:04 -0800 | [diff] [blame] | 40 | /* |
| 41 | * populate_dir - populate directory with attributes. |
| 42 | * @kobj: object we're working on. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 43 | * |
Greg Kroah-Hartman | e374a2b | 2008-01-24 21:59:04 -0800 | [diff] [blame] | 44 | * Most subsystems have a set of default attributes that are associated |
| 45 | * with an object that registers with them. This is a helper called during |
| 46 | * object registration that loops through the default attributes of the |
| 47 | * subsystem and creates attributes files for them in sysfs. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 48 | */ |
Greg Kroah-Hartman | e374a2b | 2008-01-24 21:59:04 -0800 | [diff] [blame] | 49 | static int populate_dir(struct kobject *kobj) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 50 | { |
Greg Kroah-Hartman | e374a2b | 2008-01-24 21:59:04 -0800 | [diff] [blame] | 51 | struct kobj_type *t = get_ktype(kobj); |
| 52 | struct attribute *attr; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 53 | int error = 0; |
| 54 | int i; |
Greg Kroah-Hartman | e374a2b | 2008-01-24 21:59:04 -0800 | [diff] [blame] | 55 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 56 | if (t && t->default_attrs) { |
| 57 | for (i = 0; (attr = t->default_attrs[i]) != NULL; i++) { |
Greg Kroah-Hartman | e374a2b | 2008-01-24 21:59:04 -0800 | [diff] [blame] | 58 | error = sysfs_create_file(kobj, attr); |
| 59 | if (error) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 60 | break; |
| 61 | } |
| 62 | } |
| 63 | return error; |
| 64 | } |
| 65 | |
Greg Kroah-Hartman | e374a2b | 2008-01-24 21:59:04 -0800 | [diff] [blame] | 66 | static int create_dir(struct kobject *kobj) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 67 | { |
Tejun Heo | c84a3b2 | 2013-11-23 18:01:46 -0500 | [diff] [blame] | 68 | const struct kobj_ns_type_operations *ops; |
Tejun Heo | e34ff49 | 2013-09-11 22:29:05 -0400 | [diff] [blame] | 69 | int error; |
| 70 | |
| 71 | error = sysfs_create_dir_ns(kobj, kobject_namespace(kobj)); |
Tejun Heo | c84a3b2 | 2013-11-23 18:01:46 -0500 | [diff] [blame] | 72 | if (error) |
| 73 | return error; |
| 74 | |
| 75 | error = populate_dir(kobj); |
| 76 | if (error) { |
| 77 | sysfs_remove_dir(kobj); |
| 78 | return error; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 79 | } |
Tejun Heo | 26ea12d | 2013-09-18 17:15:36 -0400 | [diff] [blame] | 80 | |
| 81 | /* |
| 82 | * @kobj->sd may be deleted by an ancestor going away. Hold an |
| 83 | * extra reference so that it stays until @kobj is gone. |
| 84 | */ |
| 85 | sysfs_get(kobj->sd); |
| 86 | |
Tejun Heo | c84a3b2 | 2013-11-23 18:01:46 -0500 | [diff] [blame] | 87 | /* |
| 88 | * If @kobj has ns_ops, its children need to be filtered based on |
| 89 | * their namespace tags. Enable namespace support on @kobj->sd. |
| 90 | */ |
| 91 | ops = kobj_child_ns_ops(kobj); |
| 92 | if (ops) { |
| 93 | BUG_ON(ops->type <= KOBJ_NS_TYPE_NONE); |
| 94 | BUG_ON(ops->type >= KOBJ_NS_TYPES); |
| 95 | BUG_ON(!kobj_ns_type_registered(ops->type)); |
| 96 | |
Tejun Heo | fa4cd45 | 2014-02-07 13:32:07 -0500 | [diff] [blame] | 97 | sysfs_enable_ns(kobj->sd); |
Tejun Heo | c84a3b2 | 2013-11-23 18:01:46 -0500 | [diff] [blame] | 98 | } |
| 99 | |
| 100 | return 0; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 101 | } |
| 102 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 103 | static int get_kobj_path_length(struct kobject *kobj) |
| 104 | { |
| 105 | int length = 1; |
Greg Kroah-Hartman | e374a2b | 2008-01-24 21:59:04 -0800 | [diff] [blame] | 106 | struct kobject *parent = kobj; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 107 | |
Greg Kroah-Hartman | e374a2b | 2008-01-24 21:59:04 -0800 | [diff] [blame] | 108 | /* walk up the ancestors until we hit the one pointing to the |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 109 | * root. |
| 110 | * Add 1 to strlen for leading '/' of each level. |
| 111 | */ |
| 112 | do { |
Chuck Ebbert | b365b3d | 2006-01-12 20:02:00 -0500 | [diff] [blame] | 113 | if (kobject_name(parent) == NULL) |
| 114 | return 0; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 115 | length += strlen(kobject_name(parent)) + 1; |
| 116 | parent = parent->parent; |
| 117 | } while (parent); |
| 118 | return length; |
| 119 | } |
| 120 | |
| 121 | static void fill_kobj_path(struct kobject *kobj, char *path, int length) |
| 122 | { |
Greg Kroah-Hartman | e374a2b | 2008-01-24 21:59:04 -0800 | [diff] [blame] | 123 | struct kobject *parent; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 124 | |
| 125 | --length; |
| 126 | for (parent = kobj; parent; parent = parent->parent) { |
| 127 | int cur = strlen(kobject_name(parent)); |
| 128 | /* back up enough to print this name with '/' */ |
| 129 | length -= cur; |
Greg Kroah-Hartman | e374a2b | 2008-01-24 21:59:04 -0800 | [diff] [blame] | 130 | strncpy(path + length, kobject_name(parent), cur); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 131 | *(path + --length) = '/'; |
| 132 | } |
| 133 | |
Greg Kroah-Hartman | 9f66fa2 | 2007-11-28 23:49:41 -0800 | [diff] [blame] | 134 | pr_debug("kobject: '%s' (%p): %s: path = '%s'\n", kobject_name(kobj), |
Harvey Harrison | 810304d | 2008-04-30 00:55:08 -0700 | [diff] [blame] | 135 | kobj, __func__, path); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 136 | } |
| 137 | |
| 138 | /** |
Robert P. J. Day | 72fd4a3 | 2007-02-10 01:45:59 -0800 | [diff] [blame] | 139 | * kobject_get_path - generate and return the path associated with a given kobj and kset pair. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 140 | * |
| 141 | * @kobj: kobject in question, with which to build the path |
| 142 | * @gfp_mask: the allocation type used to allocate the path |
Robert P. J. Day | 72fd4a3 | 2007-02-10 01:45:59 -0800 | [diff] [blame] | 143 | * |
| 144 | * The result must be freed by the caller with kfree(). |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 145 | */ |
Al Viro | fd4f2df | 2005-10-21 03:18:50 -0400 | [diff] [blame] | 146 | char *kobject_get_path(struct kobject *kobj, gfp_t gfp_mask) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 147 | { |
| 148 | char *path; |
| 149 | int len; |
| 150 | |
| 151 | len = get_kobj_path_length(kobj); |
Chuck Ebbert | b365b3d | 2006-01-12 20:02:00 -0500 | [diff] [blame] | 152 | if (len == 0) |
| 153 | return NULL; |
Burman Yan | 4668edc | 2006-12-06 20:38:51 -0800 | [diff] [blame] | 154 | path = kzalloc(len, gfp_mask); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 155 | if (!path) |
| 156 | return NULL; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 157 | fill_kobj_path(kobj, path, len); |
| 158 | |
| 159 | return path; |
| 160 | } |
Dmitry Torokhov | 80fc9f5 | 2006-10-11 01:43:58 -0400 | [diff] [blame] | 161 | EXPORT_SYMBOL_GPL(kobject_get_path); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 162 | |
Kay Sievers | 0f4dafc | 2007-12-19 01:40:42 +0100 | [diff] [blame] | 163 | /* add the kobject to its kset's list */ |
| 164 | static void kobj_kset_join(struct kobject *kobj) |
| 165 | { |
| 166 | if (!kobj->kset) |
| 167 | return; |
| 168 | |
| 169 | kset_get(kobj->kset); |
| 170 | spin_lock(&kobj->kset->list_lock); |
| 171 | list_add_tail(&kobj->entry, &kobj->kset->list); |
| 172 | spin_unlock(&kobj->kset->list_lock); |
| 173 | } |
| 174 | |
| 175 | /* remove the kobject from its kset's list */ |
| 176 | static void kobj_kset_leave(struct kobject *kobj) |
| 177 | { |
| 178 | if (!kobj->kset) |
| 179 | return; |
| 180 | |
| 181 | spin_lock(&kobj->kset->list_lock); |
| 182 | list_del_init(&kobj->entry); |
| 183 | spin_unlock(&kobj->kset->list_lock); |
| 184 | kset_put(kobj->kset); |
| 185 | } |
| 186 | |
Greg Kroah-Hartman | e374a2b | 2008-01-24 21:59:04 -0800 | [diff] [blame] | 187 | static void kobject_init_internal(struct kobject *kobj) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 188 | { |
Greg Kroah-Hartman | 31b9025a | 2007-01-18 12:23:51 -0800 | [diff] [blame] | 189 | if (!kobj) |
| 190 | return; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 191 | kref_init(&kobj->kref); |
| 192 | INIT_LIST_HEAD(&kobj->entry); |
Greg Kroah-Hartman | a4573c4 | 2008-02-26 09:36:38 -0800 | [diff] [blame] | 193 | kobj->state_in_sysfs = 0; |
| 194 | kobj->state_add_uevent_sent = 0; |
| 195 | kobj->state_remove_uevent_sent = 0; |
| 196 | kobj->state_initialized = 1; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 197 | } |
| 198 | |
| 199 | |
Greg Kroah-Hartman | 9e7bbcc | 2007-12-17 23:05:35 -0700 | [diff] [blame] | 200 | static int kobject_add_internal(struct kobject *kobj) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 201 | { |
| 202 | int error = 0; |
Greg Kroah-Hartman | e374a2b | 2008-01-24 21:59:04 -0800 | [diff] [blame] | 203 | struct kobject *parent; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 204 | |
Kay Sievers | 0f4dafc | 2007-12-19 01:40:42 +0100 | [diff] [blame] | 205 | if (!kobj) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 206 | return -ENOENT; |
Kay Sievers | 0f4dafc | 2007-12-19 01:40:42 +0100 | [diff] [blame] | 207 | |
Kay Sievers | af5ca3f4 | 2007-12-20 02:09:39 +0100 | [diff] [blame] | 208 | if (!kobj->name || !kobj->name[0]) { |
Arjan van de Ven | d955c78 | 2008-07-25 01:45:55 -0700 | [diff] [blame] | 209 | WARN(1, "kobject: (%p): attempted to be registered with empty " |
Greg Kroah-Hartman | 9f66fa2 | 2007-11-28 23:49:41 -0800 | [diff] [blame] | 210 | "name!\n", kobj); |
Greg Kroah-Hartman | c171fef | 2006-01-20 14:08:59 -0800 | [diff] [blame] | 211 | return -EINVAL; |
| 212 | } |
Kay Sievers | 0f4dafc | 2007-12-19 01:40:42 +0100 | [diff] [blame] | 213 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 214 | parent = kobject_get(kobj->parent); |
| 215 | |
Kay Sievers | 0f4dafc | 2007-12-19 01:40:42 +0100 | [diff] [blame] | 216 | /* join kset if set, use it as parent if we do not already have one */ |
| 217 | if (kobj->kset) { |
| 218 | if (!parent) |
| 219 | parent = kobject_get(&kobj->kset->kobj); |
| 220 | kobj_kset_join(kobj); |
| 221 | kobj->parent = parent; |
| 222 | } |
| 223 | |
Greg Kroah-Hartman | 9f66fa2 | 2007-11-28 23:49:41 -0800 | [diff] [blame] | 224 | pr_debug("kobject: '%s' (%p): %s: parent: '%s', set: '%s'\n", |
Harvey Harrison | 810304d | 2008-04-30 00:55:08 -0700 | [diff] [blame] | 225 | kobject_name(kobj), kobj, __func__, |
Greg Kroah-Hartman | 9f66fa2 | 2007-11-28 23:49:41 -0800 | [diff] [blame] | 226 | parent ? kobject_name(parent) : "<NULL>", |
Greg Kroah-Hartman | e374a2b | 2008-01-24 21:59:04 -0800 | [diff] [blame] | 227 | kobj->kset ? kobject_name(&kobj->kset->kobj) : "<NULL>"); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 228 | |
Eric W. Biederman | 90bc613 | 2007-07-31 19:15:08 +0900 | [diff] [blame] | 229 | error = create_dir(kobj); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 230 | if (error) { |
Kay Sievers | 0f4dafc | 2007-12-19 01:40:42 +0100 | [diff] [blame] | 231 | kobj_kset_leave(kobj); |
| 232 | kobject_put(parent); |
| 233 | kobj->parent = NULL; |
Greg Kroah-Hartman | dcd0da0 | 2006-03-20 13:17:13 -0800 | [diff] [blame] | 234 | |
| 235 | /* be noisy on error issues */ |
| 236 | if (error == -EEXIST) |
Dan Williams | 282029c | 2012-04-06 13:41:15 -0700 | [diff] [blame] | 237 | WARN(1, "%s failed for %s with " |
| 238 | "-EEXIST, don't try to register things with " |
| 239 | "the same name in the same directory.\n", |
| 240 | __func__, kobject_name(kobj)); |
Greg Kroah-Hartman | dcd0da0 | 2006-03-20 13:17:13 -0800 | [diff] [blame] | 241 | else |
Dan Williams | 282029c | 2012-04-06 13:41:15 -0700 | [diff] [blame] | 242 | WARN(1, "%s failed for %s (error: %d parent: %s)\n", |
| 243 | __func__, kobject_name(kobj), error, |
| 244 | parent ? kobject_name(parent) : "'none'"); |
Kay Sievers | 0f4dafc | 2007-12-19 01:40:42 +0100 | [diff] [blame] | 245 | } else |
| 246 | kobj->state_in_sysfs = 1; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 247 | |
| 248 | return error; |
| 249 | } |
| 250 | |
Eric W. Biederman | b592fcf | 2007-01-24 12:35:52 -0700 | [diff] [blame] | 251 | /** |
Greg Kroah-Hartman | 663a474 | 2007-11-29 18:32:47 -0500 | [diff] [blame] | 252 | * kobject_set_name_vargs - Set the name of an kobject |
| 253 | * @kobj: struct kobject to set the name of |
Greg Kroah-Hartman | 8c4606b | 2007-12-04 14:45:47 +0800 | [diff] [blame] | 254 | * @fmt: format string used to build the name |
Greg Kroah-Hartman | 663a474 | 2007-11-29 18:32:47 -0500 | [diff] [blame] | 255 | * @vargs: vargs to format the string. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 256 | */ |
Kay Sievers | 1fa5ae8 | 2009-01-25 15:17:37 +0100 | [diff] [blame] | 257 | int kobject_set_name_vargs(struct kobject *kobj, const char *fmt, |
Greg Kroah-Hartman | 663a474 | 2007-11-29 18:32:47 -0500 | [diff] [blame] | 258 | va_list vargs) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 259 | { |
Rasmus Villemoes | f773f32 | 2015-11-06 16:31:23 -0800 | [diff] [blame] | 260 | const char *s; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 261 | |
Kay Sievers | 8a577ff | 2009-04-18 15:05:45 -0700 | [diff] [blame] | 262 | if (kobj->name && !fmt) |
| 263 | return 0; |
| 264 | |
Rasmus Villemoes | f773f32 | 2015-11-06 16:31:23 -0800 | [diff] [blame] | 265 | s = kvasprintf_const(GFP_KERNEL, fmt, vargs); |
Rasmus Villemoes | 2abf114 | 2015-06-25 15:02:30 -0700 | [diff] [blame] | 266 | if (!s) |
Kay Sievers | a4ca661 | 2008-04-30 02:06:29 +0200 | [diff] [blame] | 267 | return -ENOMEM; |
Greg Kroah-Hartman | 663a474 | 2007-11-29 18:32:47 -0500 | [diff] [blame] | 268 | |
Rasmus Villemoes | f773f32 | 2015-11-06 16:31:23 -0800 | [diff] [blame] | 269 | /* |
| 270 | * ewww... some of these buggers have '/' in the name ... If |
| 271 | * that's the case, we need to make sure we have an actual |
| 272 | * allocated copy to modify, since kvasprintf_const may have |
| 273 | * returned something from .rodata. |
| 274 | */ |
| 275 | if (strchr(s, '/')) { |
| 276 | char *t; |
| 277 | |
| 278 | t = kstrdup(s, GFP_KERNEL); |
| 279 | kfree_const(s); |
| 280 | if (!t) |
| 281 | return -ENOMEM; |
| 282 | strreplace(t, '/', '!'); |
| 283 | s = t; |
| 284 | } |
| 285 | kfree_const(kobj->name); |
Rasmus Villemoes | 2abf114 | 2015-06-25 15:02:30 -0700 | [diff] [blame] | 286 | kobj->name = s; |
Kay Sievers | 9f255651 | 2008-05-06 22:24:04 +0200 | [diff] [blame] | 287 | |
Greg Kroah-Hartman | 663a474 | 2007-11-29 18:32:47 -0500 | [diff] [blame] | 288 | return 0; |
| 289 | } |
| 290 | |
| 291 | /** |
| 292 | * kobject_set_name - Set the name of a kobject |
| 293 | * @kobj: struct kobject to set the name of |
| 294 | * @fmt: format string used to build the name |
| 295 | * |
| 296 | * This sets the name of the kobject. If you have already added the |
| 297 | * kobject to the system, you must call kobject_rename() in order to |
| 298 | * change the name of the kobject. |
| 299 | */ |
| 300 | int kobject_set_name(struct kobject *kobj, const char *fmt, ...) |
| 301 | { |
Kay Sievers | a4ca661 | 2008-04-30 02:06:29 +0200 | [diff] [blame] | 302 | va_list vargs; |
Greg Kroah-Hartman | 663a474 | 2007-11-29 18:32:47 -0500 | [diff] [blame] | 303 | int retval; |
| 304 | |
Kay Sievers | a4ca661 | 2008-04-30 02:06:29 +0200 | [diff] [blame] | 305 | va_start(vargs, fmt); |
| 306 | retval = kobject_set_name_vargs(kobj, fmt, vargs); |
| 307 | va_end(vargs); |
Greg Kroah-Hartman | 663a474 | 2007-11-29 18:32:47 -0500 | [diff] [blame] | 308 | |
| 309 | return retval; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 310 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 311 | EXPORT_SYMBOL(kobject_set_name); |
| 312 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 313 | /** |
Greg Kroah-Hartman | f9cb074 | 2007-12-17 23:05:35 -0700 | [diff] [blame] | 314 | * kobject_init - initialize a kobject structure |
Greg Kroah-Hartman | e86000d | 2007-12-03 21:31:08 -0800 | [diff] [blame] | 315 | * @kobj: pointer to the kobject to initialize |
| 316 | * @ktype: pointer to the ktype for this kobject. |
| 317 | * |
| 318 | * This function will properly initialize a kobject such that it can then |
| 319 | * be passed to the kobject_add() call. |
| 320 | * |
| 321 | * After this function is called, the kobject MUST be cleaned up by a call |
| 322 | * to kobject_put(), not by a call to kfree directly to ensure that all of |
| 323 | * the memory is cleaned up properly. |
| 324 | */ |
Greg Kroah-Hartman | f9cb074 | 2007-12-17 23:05:35 -0700 | [diff] [blame] | 325 | void kobject_init(struct kobject *kobj, struct kobj_type *ktype) |
Greg Kroah-Hartman | e86000d | 2007-12-03 21:31:08 -0800 | [diff] [blame] | 326 | { |
| 327 | char *err_str; |
| 328 | |
| 329 | if (!kobj) { |
| 330 | err_str = "invalid kobject pointer!"; |
| 331 | goto error; |
| 332 | } |
| 333 | if (!ktype) { |
| 334 | err_str = "must have a ktype to be initialized properly!\n"; |
| 335 | goto error; |
| 336 | } |
Kay Sievers | 0f4dafc | 2007-12-19 01:40:42 +0100 | [diff] [blame] | 337 | if (kobj->state_initialized) { |
Greg Kroah-Hartman | e86000d | 2007-12-03 21:31:08 -0800 | [diff] [blame] | 338 | /* do not error out as sometimes we can recover */ |
Kay Sievers | 0f4dafc | 2007-12-19 01:40:42 +0100 | [diff] [blame] | 339 | printk(KERN_ERR "kobject (%p): tried to init an initialized " |
| 340 | "object, something is seriously wrong.\n", kobj); |
Greg Kroah-Hartman | e86000d | 2007-12-03 21:31:08 -0800 | [diff] [blame] | 341 | dump_stack(); |
| 342 | } |
| 343 | |
Greg Kroah-Hartman | a4573c4 | 2008-02-26 09:36:38 -0800 | [diff] [blame] | 344 | kobject_init_internal(kobj); |
Greg Kroah-Hartman | e86000d | 2007-12-03 21:31:08 -0800 | [diff] [blame] | 345 | kobj->ktype = ktype; |
| 346 | return; |
| 347 | |
| 348 | error: |
Kay Sievers | 0f4dafc | 2007-12-19 01:40:42 +0100 | [diff] [blame] | 349 | printk(KERN_ERR "kobject (%p): %s\n", kobj, err_str); |
Greg Kroah-Hartman | e86000d | 2007-12-03 21:31:08 -0800 | [diff] [blame] | 350 | dump_stack(); |
| 351 | } |
Greg Kroah-Hartman | f9cb074 | 2007-12-17 23:05:35 -0700 | [diff] [blame] | 352 | EXPORT_SYMBOL(kobject_init); |
Greg Kroah-Hartman | e86000d | 2007-12-03 21:31:08 -0800 | [diff] [blame] | 353 | |
Nicolas Iooss | 8db1486 | 2015-07-17 16:23:42 -0700 | [diff] [blame] | 354 | static __printf(3, 0) int kobject_add_varg(struct kobject *kobj, |
| 355 | struct kobject *parent, |
| 356 | const char *fmt, va_list vargs) |
Greg Kroah-Hartman | 244f6ce | 2007-12-03 21:31:08 -0800 | [diff] [blame] | 357 | { |
Greg Kroah-Hartman | 244f6ce | 2007-12-03 21:31:08 -0800 | [diff] [blame] | 358 | int retval; |
| 359 | |
Kay Sievers | a4ca661 | 2008-04-30 02:06:29 +0200 | [diff] [blame] | 360 | retval = kobject_set_name_vargs(kobj, fmt, vargs); |
Greg Kroah-Hartman | 244f6ce | 2007-12-03 21:31:08 -0800 | [diff] [blame] | 361 | if (retval) { |
| 362 | printk(KERN_ERR "kobject: can not set name properly!\n"); |
| 363 | return retval; |
| 364 | } |
| 365 | kobj->parent = parent; |
Greg Kroah-Hartman | 9e7bbcc | 2007-12-17 23:05:35 -0700 | [diff] [blame] | 366 | return kobject_add_internal(kobj); |
Greg Kroah-Hartman | 244f6ce | 2007-12-03 21:31:08 -0800 | [diff] [blame] | 367 | } |
| 368 | |
| 369 | /** |
Greg Kroah-Hartman | b2d6db5 | 2007-12-17 23:05:35 -0700 | [diff] [blame] | 370 | * kobject_add - the main kobject add function |
Greg Kroah-Hartman | 244f6ce | 2007-12-03 21:31:08 -0800 | [diff] [blame] | 371 | * @kobj: the kobject to add |
| 372 | * @parent: pointer to the parent of the kobject. |
| 373 | * @fmt: format to name the kobject with. |
| 374 | * |
| 375 | * The kobject name is set and added to the kobject hierarchy in this |
| 376 | * function. |
| 377 | * |
| 378 | * If @parent is set, then the parent of the @kobj will be set to it. |
| 379 | * If @parent is NULL, then the parent of the @kobj will be set to the |
Bart Van Assche | 9705710 | 2014-01-04 14:20:04 +0100 | [diff] [blame] | 380 | * kobject associated with the kset assigned to this kobject. If no kset |
Greg Kroah-Hartman | 244f6ce | 2007-12-03 21:31:08 -0800 | [diff] [blame] | 381 | * is assigned to the kobject, then the kobject will be located in the |
| 382 | * root of the sysfs tree. |
| 383 | * |
| 384 | * If this function returns an error, kobject_put() must be called to |
| 385 | * properly clean up the memory associated with the object. |
Greg Kroah-Hartman | 244f6ce | 2007-12-03 21:31:08 -0800 | [diff] [blame] | 386 | * Under no instance should the kobject that is passed to this function |
| 387 | * be directly freed with a call to kfree(), that can leak memory. |
| 388 | * |
Kay Sievers | 0f4dafc | 2007-12-19 01:40:42 +0100 | [diff] [blame] | 389 | * Note, no "add" uevent will be created with this call, the caller should set |
Greg Kroah-Hartman | 244f6ce | 2007-12-03 21:31:08 -0800 | [diff] [blame] | 390 | * up all of the necessary sysfs files for the object and then call |
| 391 | * kobject_uevent() with the UEVENT_ADD parameter to ensure that |
| 392 | * userspace is properly notified of this kobject's creation. |
| 393 | */ |
Greg Kroah-Hartman | b2d6db5 | 2007-12-17 23:05:35 -0700 | [diff] [blame] | 394 | int kobject_add(struct kobject *kobj, struct kobject *parent, |
| 395 | const char *fmt, ...) |
Greg Kroah-Hartman | 244f6ce | 2007-12-03 21:31:08 -0800 | [diff] [blame] | 396 | { |
| 397 | va_list args; |
| 398 | int retval; |
| 399 | |
| 400 | if (!kobj) |
| 401 | return -EINVAL; |
| 402 | |
Kay Sievers | 0f4dafc | 2007-12-19 01:40:42 +0100 | [diff] [blame] | 403 | if (!kobj->state_initialized) { |
| 404 | printk(KERN_ERR "kobject '%s' (%p): tried to add an " |
| 405 | "uninitialized object, something is seriously wrong.\n", |
| 406 | kobject_name(kobj), kobj); |
| 407 | dump_stack(); |
| 408 | return -EINVAL; |
| 409 | } |
Greg Kroah-Hartman | 244f6ce | 2007-12-03 21:31:08 -0800 | [diff] [blame] | 410 | va_start(args, fmt); |
| 411 | retval = kobject_add_varg(kobj, parent, fmt, args); |
| 412 | va_end(args); |
| 413 | |
| 414 | return retval; |
| 415 | } |
Greg Kroah-Hartman | b2d6db5 | 2007-12-17 23:05:35 -0700 | [diff] [blame] | 416 | EXPORT_SYMBOL(kobject_add); |
Greg Kroah-Hartman | 244f6ce | 2007-12-03 21:31:08 -0800 | [diff] [blame] | 417 | |
Greg Kroah-Hartman | e86000d | 2007-12-03 21:31:08 -0800 | [diff] [blame] | 418 | /** |
Greg Kroah-Hartman | c11c4154 | 2007-12-03 21:31:08 -0800 | [diff] [blame] | 419 | * kobject_init_and_add - initialize a kobject structure and add it to the kobject hierarchy |
| 420 | * @kobj: pointer to the kobject to initialize |
| 421 | * @ktype: pointer to the ktype for this kobject. |
| 422 | * @parent: pointer to the parent of this kobject. |
| 423 | * @fmt: the name of the kobject. |
| 424 | * |
Greg Kroah-Hartman | f9cb074 | 2007-12-17 23:05:35 -0700 | [diff] [blame] | 425 | * This function combines the call to kobject_init() and |
Greg Kroah-Hartman | b2d6db5 | 2007-12-17 23:05:35 -0700 | [diff] [blame] | 426 | * kobject_add(). The same type of error handling after a call to |
| 427 | * kobject_add() and kobject lifetime rules are the same here. |
Greg Kroah-Hartman | c11c4154 | 2007-12-03 21:31:08 -0800 | [diff] [blame] | 428 | */ |
| 429 | int kobject_init_and_add(struct kobject *kobj, struct kobj_type *ktype, |
| 430 | struct kobject *parent, const char *fmt, ...) |
| 431 | { |
| 432 | va_list args; |
| 433 | int retval; |
| 434 | |
Greg Kroah-Hartman | f9cb074 | 2007-12-17 23:05:35 -0700 | [diff] [blame] | 435 | kobject_init(kobj, ktype); |
Greg Kroah-Hartman | c11c4154 | 2007-12-03 21:31:08 -0800 | [diff] [blame] | 436 | |
| 437 | va_start(args, fmt); |
| 438 | retval = kobject_add_varg(kobj, parent, fmt, args); |
| 439 | va_end(args); |
| 440 | |
| 441 | return retval; |
| 442 | } |
| 443 | EXPORT_SYMBOL_GPL(kobject_init_and_add); |
| 444 | |
| 445 | /** |
Greg Kroah-Hartman | e374a2b | 2008-01-24 21:59:04 -0800 | [diff] [blame] | 446 | * kobject_rename - change the name of an object |
| 447 | * @kobj: object in question. |
| 448 | * @new_name: object's new name |
Eric W. Biederman | 030c1d2 | 2008-05-08 14:41:00 -0700 | [diff] [blame] | 449 | * |
| 450 | * It is the responsibility of the caller to provide mutual |
| 451 | * exclusion between two different calls of kobject_rename |
| 452 | * on the same kobject and to ensure that new_name is valid and |
| 453 | * won't conflict with other kobjects. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 454 | */ |
Greg Kroah-Hartman | e374a2b | 2008-01-24 21:59:04 -0800 | [diff] [blame] | 455 | int kobject_rename(struct kobject *kobj, const char *new_name) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 456 | { |
| 457 | int error = 0; |
Jean Tourrilhes | ca2f37d | 2007-03-07 10:49:30 -0800 | [diff] [blame] | 458 | const char *devpath = NULL; |
Eric W. Biederman | 0b4a4fe | 2008-07-03 18:05:28 -0700 | [diff] [blame] | 459 | const char *dup_name = NULL, *name; |
Jean Tourrilhes | ca2f37d | 2007-03-07 10:49:30 -0800 | [diff] [blame] | 460 | char *devpath_string = NULL; |
| 461 | char *envp[2]; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 462 | |
| 463 | kobj = kobject_get(kobj); |
| 464 | if (!kobj) |
| 465 | return -EINVAL; |
Eric W. Biederman | b592fcf | 2007-01-24 12:35:52 -0700 | [diff] [blame] | 466 | if (!kobj->parent) |
| 467 | return -EINVAL; |
Jean Tourrilhes | ca2f37d | 2007-03-07 10:49:30 -0800 | [diff] [blame] | 468 | |
| 469 | devpath = kobject_get_path(kobj, GFP_KERNEL); |
| 470 | if (!devpath) { |
| 471 | error = -ENOMEM; |
| 472 | goto out; |
| 473 | } |
| 474 | devpath_string = kmalloc(strlen(devpath) + 15, GFP_KERNEL); |
| 475 | if (!devpath_string) { |
| 476 | error = -ENOMEM; |
| 477 | goto out; |
| 478 | } |
| 479 | sprintf(devpath_string, "DEVPATH_OLD=%s", devpath); |
| 480 | envp[0] = devpath_string; |
| 481 | envp[1] = NULL; |
Jean Tourrilhes | ca2f37d | 2007-03-07 10:49:30 -0800 | [diff] [blame] | 482 | |
Rasmus Villemoes | f773f32 | 2015-11-06 16:31:23 -0800 | [diff] [blame] | 483 | name = dup_name = kstrdup_const(new_name, GFP_KERNEL); |
Eric W. Biederman | 0b4a4fe | 2008-07-03 18:05:28 -0700 | [diff] [blame] | 484 | if (!name) { |
| 485 | error = -ENOMEM; |
| 486 | goto out; |
| 487 | } |
| 488 | |
Tejun Heo | e34ff49 | 2013-09-11 22:29:05 -0400 | [diff] [blame] | 489 | error = sysfs_rename_dir_ns(kobj, new_name, kobject_namespace(kobj)); |
Eric W. Biederman | 0b4a4fe | 2008-07-03 18:05:28 -0700 | [diff] [blame] | 490 | if (error) |
| 491 | goto out; |
| 492 | |
| 493 | /* Install the new kobject name */ |
| 494 | dup_name = kobj->name; |
| 495 | kobj->name = name; |
Jean Tourrilhes | ca2f37d | 2007-03-07 10:49:30 -0800 | [diff] [blame] | 496 | |
| 497 | /* This function is mostly/only used for network interface. |
| 498 | * Some hotplug package track interfaces by their name and |
| 499 | * therefore want to know when the name is changed by the user. */ |
Eric W. Biederman | 0b4a4fe | 2008-07-03 18:05:28 -0700 | [diff] [blame] | 500 | kobject_uevent_env(kobj, KOBJ_MOVE, envp); |
Jean Tourrilhes | ca2f37d | 2007-03-07 10:49:30 -0800 | [diff] [blame] | 501 | |
| 502 | out: |
Rasmus Villemoes | f773f32 | 2015-11-06 16:31:23 -0800 | [diff] [blame] | 503 | kfree_const(dup_name); |
Jean Tourrilhes | ca2f37d | 2007-03-07 10:49:30 -0800 | [diff] [blame] | 504 | kfree(devpath_string); |
| 505 | kfree(devpath); |
Eric W. Biederman | b592fcf | 2007-01-24 12:35:52 -0700 | [diff] [blame] | 506 | kobject_put(kobj); |
| 507 | |
| 508 | return error; |
| 509 | } |
Alex Chiang | 8344b56 | 2008-06-10 15:30:42 -0600 | [diff] [blame] | 510 | EXPORT_SYMBOL_GPL(kobject_rename); |
Eric W. Biederman | b592fcf | 2007-01-24 12:35:52 -0700 | [diff] [blame] | 511 | |
| 512 | /** |
Greg Kroah-Hartman | e374a2b | 2008-01-24 21:59:04 -0800 | [diff] [blame] | 513 | * kobject_move - move object to another parent |
| 514 | * @kobj: object in question. |
| 515 | * @new_parent: object's new parent (can be NULL) |
Cornelia Huck | 8a82472 | 2006-11-20 17:07:51 +0100 | [diff] [blame] | 516 | */ |
Cornelia Huck | 8a82472 | 2006-11-20 17:07:51 +0100 | [diff] [blame] | 517 | int kobject_move(struct kobject *kobj, struct kobject *new_parent) |
| 518 | { |
| 519 | int error; |
| 520 | struct kobject *old_parent; |
| 521 | const char *devpath = NULL; |
| 522 | char *devpath_string = NULL; |
| 523 | char *envp[2]; |
| 524 | |
| 525 | kobj = kobject_get(kobj); |
| 526 | if (!kobj) |
| 527 | return -EINVAL; |
| 528 | new_parent = kobject_get(new_parent); |
| 529 | if (!new_parent) { |
Cornelia Huck | c744aeae | 2007-01-08 20:16:44 +0100 | [diff] [blame] | 530 | if (kobj->kset) |
| 531 | new_parent = kobject_get(&kobj->kset->kobj); |
Cornelia Huck | 8a82472 | 2006-11-20 17:07:51 +0100 | [diff] [blame] | 532 | } |
Tejun Heo | e34ff49 | 2013-09-11 22:29:05 -0400 | [diff] [blame] | 533 | |
Cornelia Huck | 8a82472 | 2006-11-20 17:07:51 +0100 | [diff] [blame] | 534 | /* old object path */ |
| 535 | devpath = kobject_get_path(kobj, GFP_KERNEL); |
| 536 | if (!devpath) { |
| 537 | error = -ENOMEM; |
| 538 | goto out; |
| 539 | } |
| 540 | devpath_string = kmalloc(strlen(devpath) + 15, GFP_KERNEL); |
| 541 | if (!devpath_string) { |
| 542 | error = -ENOMEM; |
| 543 | goto out; |
| 544 | } |
| 545 | sprintf(devpath_string, "DEVPATH_OLD=%s", devpath); |
| 546 | envp[0] = devpath_string; |
| 547 | envp[1] = NULL; |
Tejun Heo | e34ff49 | 2013-09-11 22:29:05 -0400 | [diff] [blame] | 548 | error = sysfs_move_dir_ns(kobj, new_parent, kobject_namespace(kobj)); |
Cornelia Huck | 8a82472 | 2006-11-20 17:07:51 +0100 | [diff] [blame] | 549 | if (error) |
| 550 | goto out; |
| 551 | old_parent = kobj->parent; |
| 552 | kobj->parent = new_parent; |
Dmitriy Monakhov | 9e993ef | 2007-03-03 16:11:21 +0300 | [diff] [blame] | 553 | new_parent = NULL; |
Cornelia Huck | 8a82472 | 2006-11-20 17:07:51 +0100 | [diff] [blame] | 554 | kobject_put(old_parent); |
| 555 | kobject_uevent_env(kobj, KOBJ_MOVE, envp); |
| 556 | out: |
Dmitriy Monakhov | 9e993ef | 2007-03-03 16:11:21 +0300 | [diff] [blame] | 557 | kobject_put(new_parent); |
Cornelia Huck | 8a82472 | 2006-11-20 17:07:51 +0100 | [diff] [blame] | 558 | kobject_put(kobj); |
| 559 | kfree(devpath_string); |
| 560 | kfree(devpath); |
| 561 | return error; |
| 562 | } |
Anand Jain | 24199d2 | 2015-02-12 07:03:37 +0800 | [diff] [blame] | 563 | EXPORT_SYMBOL_GPL(kobject_move); |
Cornelia Huck | 8a82472 | 2006-11-20 17:07:51 +0100 | [diff] [blame] | 564 | |
| 565 | /** |
Greg Kroah-Hartman | e374a2b | 2008-01-24 21:59:04 -0800 | [diff] [blame] | 566 | * kobject_del - unlink kobject from hierarchy. |
| 567 | * @kobj: object. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 568 | */ |
Greg Kroah-Hartman | e374a2b | 2008-01-24 21:59:04 -0800 | [diff] [blame] | 569 | void kobject_del(struct kobject *kobj) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 570 | { |
Tejun Heo | 324a56e | 2013-12-11 14:11:53 -0500 | [diff] [blame] | 571 | struct kernfs_node *sd; |
Tejun Heo | 26ea12d | 2013-09-18 17:15:36 -0400 | [diff] [blame] | 572 | |
Greg Kroah-Hartman | 31b9025a | 2007-01-18 12:23:51 -0800 | [diff] [blame] | 573 | if (!kobj) |
| 574 | return; |
Kay Sievers | 0f4dafc | 2007-12-19 01:40:42 +0100 | [diff] [blame] | 575 | |
Tejun Heo | 26ea12d | 2013-09-18 17:15:36 -0400 | [diff] [blame] | 576 | sd = kobj->sd; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 577 | sysfs_remove_dir(kobj); |
Tejun Heo | 26ea12d | 2013-09-18 17:15:36 -0400 | [diff] [blame] | 578 | sysfs_put(sd); |
| 579 | |
Kay Sievers | 0f4dafc | 2007-12-19 01:40:42 +0100 | [diff] [blame] | 580 | kobj->state_in_sysfs = 0; |
| 581 | kobj_kset_leave(kobj); |
| 582 | kobject_put(kobj->parent); |
| 583 | kobj->parent = NULL; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 584 | } |
Gabriel Somlo | fa40ae3 | 2015-08-10 15:51:43 -0400 | [diff] [blame] | 585 | EXPORT_SYMBOL(kobject_del); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 586 | |
| 587 | /** |
Greg Kroah-Hartman | e374a2b | 2008-01-24 21:59:04 -0800 | [diff] [blame] | 588 | * kobject_get - increment refcount for object. |
| 589 | * @kobj: object. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 590 | */ |
Greg Kroah-Hartman | e374a2b | 2008-01-24 21:59:04 -0800 | [diff] [blame] | 591 | struct kobject *kobject_get(struct kobject *kobj) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 592 | { |
Ethan Zhao | d82d54a | 2015-03-12 13:04:16 +0900 | [diff] [blame] | 593 | if (kobj) { |
| 594 | if (!kobj->state_initialized) |
| 595 | WARN(1, KERN_WARNING "kobject: '%s' (%p): is not " |
| 596 | "initialized, yet kobject_get() is being " |
| 597 | "called.\n", kobject_name(kobj), kobj); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 598 | kref_get(&kobj->kref); |
Ethan Zhao | d82d54a | 2015-03-12 13:04:16 +0900 | [diff] [blame] | 599 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 600 | return kobj; |
| 601 | } |
Gabriel Somlo | fa40ae3 | 2015-08-10 15:51:43 -0400 | [diff] [blame] | 602 | EXPORT_SYMBOL(kobject_get); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 603 | |
Anatol Pomozov | 2d864e4 | 2013-05-07 15:37:48 -0700 | [diff] [blame] | 604 | static struct kobject * __must_check kobject_get_unless_zero(struct kobject *kobj) |
Linus Torvalds | a49b7e8 | 2013-04-13 15:15:30 -0700 | [diff] [blame] | 605 | { |
| 606 | if (!kref_get_unless_zero(&kobj->kref)) |
| 607 | kobj = NULL; |
| 608 | return kobj; |
| 609 | } |
| 610 | |
Greg Kroah-Hartman | 18041f47 | 2007-12-03 21:31:08 -0800 | [diff] [blame] | 611 | /* |
| 612 | * kobject_cleanup - free kobject resources. |
| 613 | * @kobj: object to cleanup |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 614 | */ |
Greg Kroah-Hartman | 18041f47 | 2007-12-03 21:31:08 -0800 | [diff] [blame] | 615 | static void kobject_cleanup(struct kobject *kobj) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 616 | { |
Kay Sievers | 0f4dafc | 2007-12-19 01:40:42 +0100 | [diff] [blame] | 617 | struct kobj_type *t = get_ktype(kobj); |
Kay Sievers | af5ca3f4 | 2007-12-20 02:09:39 +0100 | [diff] [blame] | 618 | const char *name = kobj->name; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 619 | |
Russell King | c817a67 | 2013-06-27 15:06:14 +0100 | [diff] [blame] | 620 | pr_debug("kobject: '%s' (%p): %s, parent %p\n", |
| 621 | kobject_name(kobj), kobj, __func__, kobj->parent); |
Kay Sievers | 0f4dafc | 2007-12-19 01:40:42 +0100 | [diff] [blame] | 622 | |
| 623 | if (t && !t->release) |
| 624 | pr_debug("kobject: '%s' (%p): does not have a release() " |
| 625 | "function, it is broken and must be fixed.\n", |
| 626 | kobject_name(kobj), kobj); |
| 627 | |
| 628 | /* send "remove" if the caller did not do it but sent "add" */ |
| 629 | if (kobj->state_add_uevent_sent && !kobj->state_remove_uevent_sent) { |
| 630 | pr_debug("kobject: '%s' (%p): auto cleanup 'remove' event\n", |
| 631 | kobject_name(kobj), kobj); |
| 632 | kobject_uevent(kobj, KOBJ_REMOVE); |
| 633 | } |
| 634 | |
| 635 | /* remove from sysfs if the caller did not do it */ |
| 636 | if (kobj->state_in_sysfs) { |
| 637 | pr_debug("kobject: '%s' (%p): auto cleanup kobject_del\n", |
| 638 | kobject_name(kobj), kobj); |
| 639 | kobject_del(kobj); |
| 640 | } |
| 641 | |
Greg Kroah-Hartman | ce2c9cb | 2007-09-12 15:06:57 -0700 | [diff] [blame] | 642 | if (t && t->release) { |
Kay Sievers | 0f4dafc | 2007-12-19 01:40:42 +0100 | [diff] [blame] | 643 | pr_debug("kobject: '%s' (%p): calling ktype release\n", |
| 644 | kobject_name(kobj), kobj); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 645 | t->release(kobj); |
Kay Sievers | 0f4dafc | 2007-12-19 01:40:42 +0100 | [diff] [blame] | 646 | } |
| 647 | |
| 648 | /* free name if we allocated it */ |
Kay Sievers | af5ca3f4 | 2007-12-20 02:09:39 +0100 | [diff] [blame] | 649 | if (name) { |
Kay Sievers | 0f4dafc | 2007-12-19 01:40:42 +0100 | [diff] [blame] | 650 | pr_debug("kobject: '%s': free name\n", name); |
Rasmus Villemoes | f773f32 | 2015-11-06 16:31:23 -0800 | [diff] [blame] | 651 | kfree_const(name); |
Greg Kroah-Hartman | ce2c9cb | 2007-09-12 15:06:57 -0700 | [diff] [blame] | 652 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 653 | } |
| 654 | |
Russell King | c817a67 | 2013-06-27 15:06:14 +0100 | [diff] [blame] | 655 | #ifdef CONFIG_DEBUG_KOBJECT_RELEASE |
| 656 | static void kobject_delayed_cleanup(struct work_struct *work) |
| 657 | { |
| 658 | kobject_cleanup(container_of(to_delayed_work(work), |
| 659 | struct kobject, release)); |
| 660 | } |
| 661 | #endif |
| 662 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 663 | static void kobject_release(struct kref *kref) |
| 664 | { |
Russell King | c817a67 | 2013-06-27 15:06:14 +0100 | [diff] [blame] | 665 | struct kobject *kobj = container_of(kref, struct kobject, kref); |
| 666 | #ifdef CONFIG_DEBUG_KOBJECT_RELEASE |
Bjorn Helgaas | 89c86a6 | 2013-12-05 17:37:51 -0700 | [diff] [blame] | 667 | unsigned long delay = HZ + HZ * (get_random_int() & 0x3); |
| 668 | pr_info("kobject: '%s' (%p): %s, parent %p (delayed %ld)\n", |
| 669 | kobject_name(kobj), kobj, __func__, kobj->parent, delay); |
Russell King | c817a67 | 2013-06-27 15:06:14 +0100 | [diff] [blame] | 670 | INIT_DELAYED_WORK(&kobj->release, kobject_delayed_cleanup); |
Bjorn Helgaas | 89c86a6 | 2013-12-05 17:37:51 -0700 | [diff] [blame] | 671 | |
| 672 | schedule_delayed_work(&kobj->release, delay); |
Russell King | c817a67 | 2013-06-27 15:06:14 +0100 | [diff] [blame] | 673 | #else |
| 674 | kobject_cleanup(kobj); |
| 675 | #endif |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 676 | } |
| 677 | |
| 678 | /** |
Greg Kroah-Hartman | e374a2b | 2008-01-24 21:59:04 -0800 | [diff] [blame] | 679 | * kobject_put - decrement refcount for object. |
| 680 | * @kobj: object. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 681 | * |
Greg Kroah-Hartman | e374a2b | 2008-01-24 21:59:04 -0800 | [diff] [blame] | 682 | * Decrement the refcount, and if 0, call kobject_cleanup(). |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 683 | */ |
Greg Kroah-Hartman | e374a2b | 2008-01-24 21:59:04 -0800 | [diff] [blame] | 684 | void kobject_put(struct kobject *kobj) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 685 | { |
Greg Kroah-Hartman | c1ebdae | 2008-02-26 09:36:38 -0800 | [diff] [blame] | 686 | if (kobj) { |
Arjan van de Ven | d955c78 | 2008-07-25 01:45:55 -0700 | [diff] [blame] | 687 | if (!kobj->state_initialized) |
| 688 | WARN(1, KERN_WARNING "kobject: '%s' (%p): is not " |
Greg Kroah-Hartman | c1ebdae | 2008-02-26 09:36:38 -0800 | [diff] [blame] | 689 | "initialized, yet kobject_put() is being " |
| 690 | "called.\n", kobject_name(kobj), kobj); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 691 | kref_put(&kobj->kref, kobject_release); |
Greg Kroah-Hartman | c1ebdae | 2008-02-26 09:36:38 -0800 | [diff] [blame] | 692 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 693 | } |
Gabriel Somlo | fa40ae3 | 2015-08-10 15:51:43 -0400 | [diff] [blame] | 694 | EXPORT_SYMBOL(kobject_put); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 695 | |
Greg Kroah-Hartman | 3f9e3ee | 2007-11-05 13:16:15 -0800 | [diff] [blame] | 696 | static void dynamic_kobj_release(struct kobject *kobj) |
Jun'ichi Nomura | 7423172 | 2006-03-13 17:14:25 -0500 | [diff] [blame] | 697 | { |
Harvey Harrison | 810304d | 2008-04-30 00:55:08 -0700 | [diff] [blame] | 698 | pr_debug("kobject: (%p): %s\n", kobj, __func__); |
Jun'ichi Nomura | 7423172 | 2006-03-13 17:14:25 -0500 | [diff] [blame] | 699 | kfree(kobj); |
| 700 | } |
| 701 | |
Greg Kroah-Hartman | 3f9e3ee | 2007-11-05 13:16:15 -0800 | [diff] [blame] | 702 | static struct kobj_type dynamic_kobj_ktype = { |
Kay Sievers | 386f275 | 2007-11-02 13:47:53 +0100 | [diff] [blame] | 703 | .release = dynamic_kobj_release, |
| 704 | .sysfs_ops = &kobj_sysfs_ops, |
Jun'ichi Nomura | 7423172 | 2006-03-13 17:14:25 -0500 | [diff] [blame] | 705 | }; |
| 706 | |
Greg Kroah-Hartman | 43968d2 | 2007-11-05 22:24:43 -0800 | [diff] [blame] | 707 | /** |
Greg Kroah-Hartman | 3f9e3ee | 2007-11-05 13:16:15 -0800 | [diff] [blame] | 708 | * kobject_create - create a struct kobject dynamically |
| 709 | * |
| 710 | * This function creates a kobject structure dynamically and sets it up |
| 711 | * to be a "dynamic" kobject with a default release function set up. |
| 712 | * |
| 713 | * If the kobject was not able to be created, NULL will be returned. |
Greg Kroah-Hartman | 43968d2 | 2007-11-05 22:24:43 -0800 | [diff] [blame] | 714 | * The kobject structure returned from here must be cleaned up with a |
Greg Kroah-Hartman | f9cb074 | 2007-12-17 23:05:35 -0700 | [diff] [blame] | 715 | * call to kobject_put() and not kfree(), as kobject_init() has |
Greg Kroah-Hartman | 43968d2 | 2007-11-05 22:24:43 -0800 | [diff] [blame] | 716 | * already been called on this structure. |
Greg Kroah-Hartman | 3f9e3ee | 2007-11-05 13:16:15 -0800 | [diff] [blame] | 717 | */ |
Greg Kroah-Hartman | 43968d2 | 2007-11-05 22:24:43 -0800 | [diff] [blame] | 718 | struct kobject *kobject_create(void) |
Greg Kroah-Hartman | 3f9e3ee | 2007-11-05 13:16:15 -0800 | [diff] [blame] | 719 | { |
| 720 | struct kobject *kobj; |
| 721 | |
| 722 | kobj = kzalloc(sizeof(*kobj), GFP_KERNEL); |
| 723 | if (!kobj) |
| 724 | return NULL; |
| 725 | |
Greg Kroah-Hartman | f9cb074 | 2007-12-17 23:05:35 -0700 | [diff] [blame] | 726 | kobject_init(kobj, &dynamic_kobj_ktype); |
Greg Kroah-Hartman | 3f9e3ee | 2007-11-05 13:16:15 -0800 | [diff] [blame] | 727 | return kobj; |
| 728 | } |
| 729 | |
| 730 | /** |
| 731 | * kobject_create_and_add - create a struct kobject dynamically and register it with sysfs |
| 732 | * |
Zhi Yong Wu | 9ff1f83 | 2012-05-07 10:48:25 +0800 | [diff] [blame] | 733 | * @name: the name for the kobject |
Greg Kroah-Hartman | 3f9e3ee | 2007-11-05 13:16:15 -0800 | [diff] [blame] | 734 | * @parent: the parent kobject of this kobject, if any. |
| 735 | * |
Dave Young | f70701a | 2008-01-28 16:58:00 +0800 | [diff] [blame] | 736 | * This function creates a kobject structure dynamically and registers it |
Greg Kroah-Hartman | 3f9e3ee | 2007-11-05 13:16:15 -0800 | [diff] [blame] | 737 | * with sysfs. When you are finished with this structure, call |
Greg Kroah-Hartman | 78a2d90 | 2007-12-20 08:13:05 -0800 | [diff] [blame] | 738 | * kobject_put() and the structure will be dynamically freed when |
Greg Kroah-Hartman | 3f9e3ee | 2007-11-05 13:16:15 -0800 | [diff] [blame] | 739 | * it is no longer being used. |
| 740 | * |
| 741 | * If the kobject was not able to be created, NULL will be returned. |
| 742 | */ |
| 743 | struct kobject *kobject_create_and_add(const char *name, struct kobject *parent) |
| 744 | { |
| 745 | struct kobject *kobj; |
| 746 | int retval; |
| 747 | |
| 748 | kobj = kobject_create(); |
| 749 | if (!kobj) |
| 750 | return NULL; |
| 751 | |
Greg Kroah-Hartman | b2d6db5 | 2007-12-17 23:05:35 -0700 | [diff] [blame] | 752 | retval = kobject_add(kobj, parent, "%s", name); |
Greg Kroah-Hartman | 3f9e3ee | 2007-11-05 13:16:15 -0800 | [diff] [blame] | 753 | if (retval) { |
| 754 | printk(KERN_WARNING "%s: kobject_add error: %d\n", |
Harvey Harrison | 810304d | 2008-04-30 00:55:08 -0700 | [diff] [blame] | 755 | __func__, retval); |
Greg Kroah-Hartman | 3f9e3ee | 2007-11-05 13:16:15 -0800 | [diff] [blame] | 756 | kobject_put(kobj); |
| 757 | kobj = NULL; |
| 758 | } |
| 759 | return kobj; |
| 760 | } |
| 761 | EXPORT_SYMBOL_GPL(kobject_create_and_add); |
| 762 | |
Jun'ichi Nomura | 7423172 | 2006-03-13 17:14:25 -0500 | [diff] [blame] | 763 | /** |
Greg Kroah-Hartman | e374a2b | 2008-01-24 21:59:04 -0800 | [diff] [blame] | 764 | * kset_init - initialize a kset for use |
| 765 | * @k: kset |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 766 | */ |
Greg Kroah-Hartman | e374a2b | 2008-01-24 21:59:04 -0800 | [diff] [blame] | 767 | void kset_init(struct kset *k) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 768 | { |
Greg Kroah-Hartman | e1543dd | 2007-12-17 23:05:35 -0700 | [diff] [blame] | 769 | kobject_init_internal(&k->kobj); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 770 | INIT_LIST_HEAD(&k->list); |
| 771 | spin_lock_init(&k->list_lock); |
| 772 | } |
| 773 | |
Kay Sievers | 23b5212 | 2007-11-02 13:47:53 +0100 | [diff] [blame] | 774 | /* default kobject attribute operations */ |
| 775 | static ssize_t kobj_attr_show(struct kobject *kobj, struct attribute *attr, |
| 776 | char *buf) |
| 777 | { |
| 778 | struct kobj_attribute *kattr; |
| 779 | ssize_t ret = -EIO; |
| 780 | |
| 781 | kattr = container_of(attr, struct kobj_attribute, attr); |
| 782 | if (kattr->show) |
| 783 | ret = kattr->show(kobj, kattr, buf); |
| 784 | return ret; |
| 785 | } |
| 786 | |
| 787 | static ssize_t kobj_attr_store(struct kobject *kobj, struct attribute *attr, |
| 788 | const char *buf, size_t count) |
| 789 | { |
| 790 | struct kobj_attribute *kattr; |
| 791 | ssize_t ret = -EIO; |
| 792 | |
| 793 | kattr = container_of(attr, struct kobj_attribute, attr); |
| 794 | if (kattr->store) |
| 795 | ret = kattr->store(kobj, kattr, buf, count); |
| 796 | return ret; |
| 797 | } |
| 798 | |
Emese Revfy | 52cf25d | 2010-01-19 02:58:23 +0100 | [diff] [blame] | 799 | const struct sysfs_ops kobj_sysfs_ops = { |
Kay Sievers | 23b5212 | 2007-11-02 13:47:53 +0100 | [diff] [blame] | 800 | .show = kobj_attr_show, |
| 801 | .store = kobj_attr_store, |
| 802 | }; |
Jeff Mahoney | 29dfe2d | 2013-11-01 13:06:56 -0400 | [diff] [blame] | 803 | EXPORT_SYMBOL_GPL(kobj_sysfs_ops); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 804 | |
| 805 | /** |
Greg Kroah-Hartman | e374a2b | 2008-01-24 21:59:04 -0800 | [diff] [blame] | 806 | * kset_register - initialize and add a kset. |
| 807 | * @k: kset. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 808 | */ |
Greg Kroah-Hartman | e374a2b | 2008-01-24 21:59:04 -0800 | [diff] [blame] | 809 | int kset_register(struct kset *k) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 810 | { |
Kay Sievers | 80f03e3 | 2007-05-26 11:21:36 +0200 | [diff] [blame] | 811 | int err; |
| 812 | |
Greg Kroah-Hartman | 31b9025a | 2007-01-18 12:23:51 -0800 | [diff] [blame] | 813 | if (!k) |
| 814 | return -EINVAL; |
Kay Sievers | 80f03e3 | 2007-05-26 11:21:36 +0200 | [diff] [blame] | 815 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 816 | kset_init(k); |
Greg Kroah-Hartman | 12e339a | 2002-04-09 12:14:34 -0700 | [diff] [blame] | 817 | err = kobject_add_internal(&k->kobj); |
Kay Sievers | 80f03e3 | 2007-05-26 11:21:36 +0200 | [diff] [blame] | 818 | if (err) |
| 819 | return err; |
| 820 | kobject_uevent(&k->kobj, KOBJ_ADD); |
| 821 | return 0; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 822 | } |
Gabriel Somlo | fa40ae3 | 2015-08-10 15:51:43 -0400 | [diff] [blame] | 823 | EXPORT_SYMBOL(kset_register); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 824 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 825 | /** |
Greg Kroah-Hartman | e374a2b | 2008-01-24 21:59:04 -0800 | [diff] [blame] | 826 | * kset_unregister - remove a kset. |
| 827 | * @k: kset. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 828 | */ |
Greg Kroah-Hartman | e374a2b | 2008-01-24 21:59:04 -0800 | [diff] [blame] | 829 | void kset_unregister(struct kset *k) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 830 | { |
Greg Kroah-Hartman | 31b9025a | 2007-01-18 12:23:51 -0800 | [diff] [blame] | 831 | if (!k) |
| 832 | return; |
Bjorn Helgaas | 35a5fe6 | 2013-12-05 17:38:00 -0700 | [diff] [blame] | 833 | kobject_del(&k->kobj); |
Greg Kroah-Hartman | 78a2d90 | 2007-12-20 08:13:05 -0800 | [diff] [blame] | 834 | kobject_put(&k->kobj); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 835 | } |
Gabriel Somlo | fa40ae3 | 2015-08-10 15:51:43 -0400 | [diff] [blame] | 836 | EXPORT_SYMBOL(kset_unregister); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 837 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 838 | /** |
Greg Kroah-Hartman | e374a2b | 2008-01-24 21:59:04 -0800 | [diff] [blame] | 839 | * kset_find_obj - search for object in kset. |
| 840 | * @kset: kset we're looking in. |
| 841 | * @name: object's name. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 842 | * |
Greg Kroah-Hartman | e374a2b | 2008-01-24 21:59:04 -0800 | [diff] [blame] | 843 | * Lock kset via @kset->subsys, and iterate over @kset->list, |
| 844 | * looking for a matching kobject. If matching object is found |
| 845 | * take a reference and return the object. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 846 | */ |
Greg Kroah-Hartman | e374a2b | 2008-01-24 21:59:04 -0800 | [diff] [blame] | 847 | struct kobject *kset_find_obj(struct kset *kset, const char *name) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 848 | { |
Robert P. J. Day | c6a2a3d | 2008-03-27 01:13:34 -0400 | [diff] [blame] | 849 | struct kobject *k; |
Greg Kroah-Hartman | e374a2b | 2008-01-24 21:59:04 -0800 | [diff] [blame] | 850 | struct kobject *ret = NULL; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 851 | |
| 852 | spin_lock(&kset->list_lock); |
Robin Holt | c25d1df | 2010-09-29 14:00:54 -0500 | [diff] [blame] | 853 | |
Robert P. J. Day | c6a2a3d | 2008-03-27 01:13:34 -0400 | [diff] [blame] | 854 | list_for_each_entry(k, &kset->list, entry) { |
Greg Kroah-Hartman | e374a2b | 2008-01-24 21:59:04 -0800 | [diff] [blame] | 855 | if (kobject_name(k) && !strcmp(kobject_name(k), name)) { |
Linus Torvalds | a49b7e8 | 2013-04-13 15:15:30 -0700 | [diff] [blame] | 856 | ret = kobject_get_unless_zero(k); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 857 | break; |
| 858 | } |
| 859 | } |
Robin Holt | c25d1df | 2010-09-29 14:00:54 -0500 | [diff] [blame] | 860 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 861 | spin_unlock(&kset->list_lock); |
| 862 | return ret; |
| 863 | } |
| 864 | |
Greg Kroah-Hartman | b727c70 | 2007-09-27 14:48:53 -0700 | [diff] [blame] | 865 | static void kset_release(struct kobject *kobj) |
| 866 | { |
| 867 | struct kset *kset = container_of(kobj, struct kset, kobj); |
Greg Kroah-Hartman | 9f66fa2 | 2007-11-28 23:49:41 -0800 | [diff] [blame] | 868 | pr_debug("kobject: '%s' (%p): %s\n", |
Harvey Harrison | 810304d | 2008-04-30 00:55:08 -0700 | [diff] [blame] | 869 | kobject_name(kobj), kobj, __func__); |
Greg Kroah-Hartman | b727c70 | 2007-09-27 14:48:53 -0700 | [diff] [blame] | 870 | kfree(kset); |
| 871 | } |
| 872 | |
Kay Sievers | 386f275 | 2007-11-02 13:47:53 +0100 | [diff] [blame] | 873 | static struct kobj_type kset_ktype = { |
| 874 | .sysfs_ops = &kobj_sysfs_ops, |
Greg Kroah-Hartman | b727c70 | 2007-09-27 14:48:53 -0700 | [diff] [blame] | 875 | .release = kset_release, |
| 876 | }; |
| 877 | |
| 878 | /** |
| 879 | * kset_create - create a struct kset dynamically |
| 880 | * |
| 881 | * @name: the name for the kset |
| 882 | * @uevent_ops: a struct kset_uevent_ops for the kset |
| 883 | * @parent_kobj: the parent kobject of this kset, if any. |
| 884 | * |
| 885 | * This function creates a kset structure dynamically. This structure can |
| 886 | * then be registered with the system and show up in sysfs with a call to |
| 887 | * kset_register(). When you are finished with this structure, if |
| 888 | * kset_register() has been called, call kset_unregister() and the |
| 889 | * structure will be dynamically freed when it is no longer being used. |
| 890 | * |
| 891 | * If the kset was not able to be created, NULL will be returned. |
| 892 | */ |
| 893 | static struct kset *kset_create(const char *name, |
Emese Revfy | 9cd4361 | 2009-12-31 14:52:51 +0100 | [diff] [blame] | 894 | const struct kset_uevent_ops *uevent_ops, |
Greg Kroah-Hartman | b727c70 | 2007-09-27 14:48:53 -0700 | [diff] [blame] | 895 | struct kobject *parent_kobj) |
| 896 | { |
| 897 | struct kset *kset; |
Dave Young | d9cd8f3 | 2009-05-11 14:17:45 +0800 | [diff] [blame] | 898 | int retval; |
Greg Kroah-Hartman | b727c70 | 2007-09-27 14:48:53 -0700 | [diff] [blame] | 899 | |
| 900 | kset = kzalloc(sizeof(*kset), GFP_KERNEL); |
| 901 | if (!kset) |
| 902 | return NULL; |
Kees Cook | b7165eb | 2013-06-06 13:52:19 -0700 | [diff] [blame] | 903 | retval = kobject_set_name(&kset->kobj, "%s", name); |
Dave Young | d9cd8f3 | 2009-05-11 14:17:45 +0800 | [diff] [blame] | 904 | if (retval) { |
| 905 | kfree(kset); |
| 906 | return NULL; |
| 907 | } |
Greg Kroah-Hartman | b727c70 | 2007-09-27 14:48:53 -0700 | [diff] [blame] | 908 | kset->uevent_ops = uevent_ops; |
| 909 | kset->kobj.parent = parent_kobj; |
| 910 | |
| 911 | /* |
Kay Sievers | 386f275 | 2007-11-02 13:47:53 +0100 | [diff] [blame] | 912 | * The kobject of this kset will have a type of kset_ktype and belong to |
Greg Kroah-Hartman | b727c70 | 2007-09-27 14:48:53 -0700 | [diff] [blame] | 913 | * no kset itself. That way we can properly free it when it is |
| 914 | * finished being used. |
| 915 | */ |
Kay Sievers | 386f275 | 2007-11-02 13:47:53 +0100 | [diff] [blame] | 916 | kset->kobj.ktype = &kset_ktype; |
Greg Kroah-Hartman | b727c70 | 2007-09-27 14:48:53 -0700 | [diff] [blame] | 917 | kset->kobj.kset = NULL; |
| 918 | |
| 919 | return kset; |
| 920 | } |
| 921 | |
| 922 | /** |
| 923 | * kset_create_and_add - create a struct kset dynamically and add it to sysfs |
| 924 | * |
| 925 | * @name: the name for the kset |
| 926 | * @uevent_ops: a struct kset_uevent_ops for the kset |
| 927 | * @parent_kobj: the parent kobject of this kset, if any. |
| 928 | * |
| 929 | * This function creates a kset structure dynamically and registers it |
| 930 | * with sysfs. When you are finished with this structure, call |
| 931 | * kset_unregister() and the structure will be dynamically freed when it |
| 932 | * is no longer being used. |
| 933 | * |
| 934 | * If the kset was not able to be created, NULL will be returned. |
| 935 | */ |
| 936 | struct kset *kset_create_and_add(const char *name, |
Emese Revfy | 9cd4361 | 2009-12-31 14:52:51 +0100 | [diff] [blame] | 937 | const struct kset_uevent_ops *uevent_ops, |
Greg Kroah-Hartman | b727c70 | 2007-09-27 14:48:53 -0700 | [diff] [blame] | 938 | struct kobject *parent_kobj) |
| 939 | { |
| 940 | struct kset *kset; |
| 941 | int error; |
| 942 | |
| 943 | kset = kset_create(name, uevent_ops, parent_kobj); |
| 944 | if (!kset) |
| 945 | return NULL; |
| 946 | error = kset_register(kset); |
| 947 | if (error) { |
| 948 | kfree(kset); |
| 949 | return NULL; |
| 950 | } |
| 951 | return kset; |
| 952 | } |
| 953 | EXPORT_SYMBOL_GPL(kset_create_and_add); |
| 954 | |
Eric W. Biederman | bc451f2 | 2010-03-30 11:31:25 -0700 | [diff] [blame] | 955 | |
| 956 | static DEFINE_SPINLOCK(kobj_ns_type_lock); |
| 957 | static const struct kobj_ns_type_operations *kobj_ns_ops_tbl[KOBJ_NS_TYPES]; |
| 958 | |
| 959 | int kobj_ns_type_register(const struct kobj_ns_type_operations *ops) |
| 960 | { |
| 961 | enum kobj_ns_type type = ops->type; |
| 962 | int error; |
| 963 | |
| 964 | spin_lock(&kobj_ns_type_lock); |
| 965 | |
| 966 | error = -EINVAL; |
| 967 | if (type >= KOBJ_NS_TYPES) |
| 968 | goto out; |
| 969 | |
| 970 | error = -EINVAL; |
| 971 | if (type <= KOBJ_NS_TYPE_NONE) |
| 972 | goto out; |
| 973 | |
| 974 | error = -EBUSY; |
| 975 | if (kobj_ns_ops_tbl[type]) |
| 976 | goto out; |
| 977 | |
| 978 | error = 0; |
| 979 | kobj_ns_ops_tbl[type] = ops; |
| 980 | |
| 981 | out: |
| 982 | spin_unlock(&kobj_ns_type_lock); |
| 983 | return error; |
| 984 | } |
| 985 | |
| 986 | int kobj_ns_type_registered(enum kobj_ns_type type) |
| 987 | { |
| 988 | int registered = 0; |
| 989 | |
| 990 | spin_lock(&kobj_ns_type_lock); |
| 991 | if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES)) |
| 992 | registered = kobj_ns_ops_tbl[type] != NULL; |
| 993 | spin_unlock(&kobj_ns_type_lock); |
| 994 | |
| 995 | return registered; |
| 996 | } |
| 997 | |
| 998 | const struct kobj_ns_type_operations *kobj_child_ns_ops(struct kobject *parent) |
| 999 | { |
| 1000 | const struct kobj_ns_type_operations *ops = NULL; |
| 1001 | |
Pankaj Dubey | 41fb96a | 2014-09-24 16:25:54 +0530 | [diff] [blame] | 1002 | if (parent && parent->ktype && parent->ktype->child_ns_type) |
Eric W. Biederman | bc451f2 | 2010-03-30 11:31:25 -0700 | [diff] [blame] | 1003 | ops = parent->ktype->child_ns_type(parent); |
| 1004 | |
| 1005 | return ops; |
| 1006 | } |
| 1007 | |
| 1008 | const struct kobj_ns_type_operations *kobj_ns_ops(struct kobject *kobj) |
| 1009 | { |
| 1010 | return kobj_child_ns_ops(kobj->parent); |
| 1011 | } |
| 1012 | |
Eric W. Biederman | 7dc5dbc | 2013-03-25 20:07:01 -0700 | [diff] [blame] | 1013 | bool kobj_ns_current_may_mount(enum kobj_ns_type type) |
| 1014 | { |
Eric W. Biederman | 730d7d3 | 2013-09-23 14:41:17 -0700 | [diff] [blame] | 1015 | bool may_mount = true; |
Eric W. Biederman | 7dc5dbc | 2013-03-25 20:07:01 -0700 | [diff] [blame] | 1016 | |
| 1017 | spin_lock(&kobj_ns_type_lock); |
| 1018 | if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) && |
| 1019 | kobj_ns_ops_tbl[type]) |
| 1020 | may_mount = kobj_ns_ops_tbl[type]->current_may_mount(); |
| 1021 | spin_unlock(&kobj_ns_type_lock); |
| 1022 | |
| 1023 | return may_mount; |
| 1024 | } |
Eric W. Biederman | bc451f2 | 2010-03-30 11:31:25 -0700 | [diff] [blame] | 1025 | |
Al Viro | a685e08 | 2011-06-08 21:13:01 -0400 | [diff] [blame] | 1026 | void *kobj_ns_grab_current(enum kobj_ns_type type) |
Eric W. Biederman | bc451f2 | 2010-03-30 11:31:25 -0700 | [diff] [blame] | 1027 | { |
Al Viro | a685e08 | 2011-06-08 21:13:01 -0400 | [diff] [blame] | 1028 | void *ns = NULL; |
Eric W. Biederman | bc451f2 | 2010-03-30 11:31:25 -0700 | [diff] [blame] | 1029 | |
| 1030 | spin_lock(&kobj_ns_type_lock); |
| 1031 | if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) && |
| 1032 | kobj_ns_ops_tbl[type]) |
Al Viro | a685e08 | 2011-06-08 21:13:01 -0400 | [diff] [blame] | 1033 | ns = kobj_ns_ops_tbl[type]->grab_current_ns(); |
Eric W. Biederman | bc451f2 | 2010-03-30 11:31:25 -0700 | [diff] [blame] | 1034 | spin_unlock(&kobj_ns_type_lock); |
| 1035 | |
| 1036 | return ns; |
| 1037 | } |
| 1038 | |
| 1039 | const void *kobj_ns_netlink(enum kobj_ns_type type, struct sock *sk) |
| 1040 | { |
| 1041 | const void *ns = NULL; |
| 1042 | |
| 1043 | spin_lock(&kobj_ns_type_lock); |
| 1044 | if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) && |
| 1045 | kobj_ns_ops_tbl[type]) |
| 1046 | ns = kobj_ns_ops_tbl[type]->netlink_ns(sk); |
| 1047 | spin_unlock(&kobj_ns_type_lock); |
| 1048 | |
| 1049 | return ns; |
| 1050 | } |
| 1051 | |
| 1052 | const void *kobj_ns_initial(enum kobj_ns_type type) |
| 1053 | { |
| 1054 | const void *ns = NULL; |
| 1055 | |
| 1056 | spin_lock(&kobj_ns_type_lock); |
| 1057 | if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) && |
| 1058 | kobj_ns_ops_tbl[type]) |
| 1059 | ns = kobj_ns_ops_tbl[type]->initial_ns(); |
| 1060 | spin_unlock(&kobj_ns_type_lock); |
| 1061 | |
| 1062 | return ns; |
| 1063 | } |
| 1064 | |
Al Viro | a685e08 | 2011-06-08 21:13:01 -0400 | [diff] [blame] | 1065 | void kobj_ns_drop(enum kobj_ns_type type, void *ns) |
Eric W. Biederman | bc451f2 | 2010-03-30 11:31:25 -0700 | [diff] [blame] | 1066 | { |
Al Viro | a685e08 | 2011-06-08 21:13:01 -0400 | [diff] [blame] | 1067 | spin_lock(&kobj_ns_type_lock); |
| 1068 | if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) && |
| 1069 | kobj_ns_ops_tbl[type] && kobj_ns_ops_tbl[type]->drop_ns) |
| 1070 | kobj_ns_ops_tbl[type]->drop_ns(ns); |
| 1071 | spin_unlock(&kobj_ns_type_lock); |
Eric W. Biederman | bc451f2 | 2010-03-30 11:31:25 -0700 | [diff] [blame] | 1072 | } |