kobject.c 26.6 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4
/*
 * kobject.c - library routines for handling generic kernel objects
 *
 * Copyright (c) 2002-2003 Patrick Mochel <mochel@osdl.org>
5 6
 * Copyright (c) 2006-2007 Greg Kroah-Hartman <greg@kroah.com>
 * Copyright (c) 2006-2007 Novell Inc.
L
Linus Torvalds 已提交
7 8 9 10 11 12 13 14 15
 *
 * This file is released under the GPLv2.
 *
 *
 * Please see the file Documentation/kobject.txt for critical information
 * about using the kobject interface.
 */

#include <linux/kobject.h>
16
#include <linux/kobj_completion.h>
L
Linus Torvalds 已提交
17
#include <linux/string.h>
18
#include <linux/export.h>
L
Linus Torvalds 已提交
19
#include <linux/stat.h>
T
Tim Schmielau 已提交
20
#include <linux/slab.h>
L
Linus Torvalds 已提交
21

22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
/**
 * kobject_namespace - return @kobj's namespace tag
 * @kobj: kobject in question
 *
 * Returns namespace tag of @kobj if its parent has namespace ops enabled
 * and thus @kobj should have a namespace tag associated with it.  Returns
 * %NULL otherwise.
 */
const void *kobject_namespace(struct kobject *kobj)
{
	const struct kobj_ns_type_operations *ns_ops = kobj_ns_ops(kobj);

	if (!ns_ops || ns_ops->type == KOBJ_NS_TYPE_NONE)
		return NULL;

37
	return kobj->ktype->namespace(kobj);
38 39
}

40 41 42
/*
 * populate_dir - populate directory with attributes.
 * @kobj: object we're working on.
L
Linus Torvalds 已提交
43
 *
44 45 46 47
 * Most subsystems have a set of default attributes that are associated
 * with an object that registers with them.  This is a helper called during
 * object registration that loops through the default attributes of the
 * subsystem and creates attributes files for them in sysfs.
L
Linus Torvalds 已提交
48
 */
49
static int populate_dir(struct kobject *kobj)
L
Linus Torvalds 已提交
50
{
51 52
	struct kobj_type *t = get_ktype(kobj);
	struct attribute *attr;
L
Linus Torvalds 已提交
53 54
	int error = 0;
	int i;
55

L
Linus Torvalds 已提交
56 57
	if (t && t->default_attrs) {
		for (i = 0; (attr = t->default_attrs[i]) != NULL; i++) {
58 59
			error = sysfs_create_file(kobj, attr);
			if (error)
L
Linus Torvalds 已提交
60 61 62 63 64 65
				break;
		}
	}
	return error;
}

66
static int create_dir(struct kobject *kobj)
L
Linus Torvalds 已提交
67
{
68 69 70
	int error;

	error = sysfs_create_dir_ns(kobj, kobject_namespace(kobj));
71 72 73 74
	if (!error) {
		error = populate_dir(kobj);
		if (error)
			sysfs_remove_dir(kobj);
L
Linus Torvalds 已提交
75
	}
76 77 78 79 80 81 82

	/*
	 * @kobj->sd may be deleted by an ancestor going away.  Hold an
	 * extra reference so that it stays until @kobj is gone.
	 */
	sysfs_get(kobj->sd);

L
Linus Torvalds 已提交
83 84 85 86 87 88
	return error;
}

static int get_kobj_path_length(struct kobject *kobj)
{
	int length = 1;
89
	struct kobject *parent = kobj;
L
Linus Torvalds 已提交
90

91
	/* walk up the ancestors until we hit the one pointing to the
L
Linus Torvalds 已提交
92 93 94 95
	 * root.
	 * Add 1 to strlen for leading '/' of each level.
	 */
	do {
96 97
		if (kobject_name(parent) == NULL)
			return 0;
L
Linus Torvalds 已提交
98 99 100 101 102 103 104 105
		length += strlen(kobject_name(parent)) + 1;
		parent = parent->parent;
	} while (parent);
	return length;
}

static void fill_kobj_path(struct kobject *kobj, char *path, int length)
{
106
	struct kobject *parent;
L
Linus Torvalds 已提交
107 108 109 110 111 112

	--length;
	for (parent = kobj; parent; parent = parent->parent) {
		int cur = strlen(kobject_name(parent));
		/* back up enough to print this name with '/' */
		length -= cur;
113
		strncpy(path + length, kobject_name(parent), cur);
L
Linus Torvalds 已提交
114 115 116
		*(path + --length) = '/';
	}

117
	pr_debug("kobject: '%s' (%p): %s: path = '%s'\n", kobject_name(kobj),
118
		 kobj, __func__, path);
L
Linus Torvalds 已提交
119 120 121
}

/**
122
 * kobject_get_path - generate and return the path associated with a given kobj and kset pair.
L
Linus Torvalds 已提交
123 124 125
 *
 * @kobj:	kobject in question, with which to build the path
 * @gfp_mask:	the allocation type used to allocate the path
126 127
 *
 * The result must be freed by the caller with kfree().
L
Linus Torvalds 已提交
128
 */
A
Al Viro 已提交
129
char *kobject_get_path(struct kobject *kobj, gfp_t gfp_mask)
L
Linus Torvalds 已提交
130 131 132 133 134
{
	char *path;
	int len;

	len = get_kobj_path_length(kobj);
135 136
	if (len == 0)
		return NULL;
137
	path = kzalloc(len, gfp_mask);
L
Linus Torvalds 已提交
138 139 140 141 142 143
	if (!path)
		return NULL;
	fill_kobj_path(kobj, path, len);

	return path;
}
144
EXPORT_SYMBOL_GPL(kobject_get_path);
L
Linus Torvalds 已提交
145

146 147
/* add the kobject to its kset's list */
static void kobj_kset_join(struct kobject *kobj)
L
Linus Torvalds 已提交
148
{
149
	if (!kobj->kset)
150
		return;
151 152 153 154 155

	kset_get(kobj->kset);
	spin_lock(&kobj->kset->list_lock);
	list_add_tail(&kobj->entry, &kobj->kset->list);
	spin_unlock(&kobj->kset->list_lock);
L
Linus Torvalds 已提交
156 157
}

158 159 160 161 162
/* remove the kobject from its kset's list */
static void kobj_kset_leave(struct kobject *kobj)
{
	if (!kobj->kset)
		return;
L
Linus Torvalds 已提交
163

164 165 166 167 168
	spin_lock(&kobj->kset->list_lock);
	list_del_init(&kobj->entry);
	spin_unlock(&kobj->kset->list_lock);
	kset_put(kobj->kset);
}
L
Linus Torvalds 已提交
169

170
static void kobject_init_internal(struct kobject *kobj)
L
Linus Torvalds 已提交
171
{
172 173 174 175
	if (!kobj)
		return;
	kref_init(&kobj->kref);
	INIT_LIST_HEAD(&kobj->entry);
176 177 178 179
	kobj->state_in_sysfs = 0;
	kobj->state_add_uevent_sent = 0;
	kobj->state_remove_uevent_sent = 0;
	kobj->state_initialized = 1;
L
Linus Torvalds 已提交
180 181
}

182

183
static int kobject_add_internal(struct kobject *kobj)
L
Linus Torvalds 已提交
184 185
{
	int error = 0;
186
	struct kobject *parent;
L
Linus Torvalds 已提交
187

188
	if (!kobj)
L
Linus Torvalds 已提交
189
		return -ENOENT;
190

191
	if (!kobj->name || !kobj->name[0]) {
A
Arjan van de Ven 已提交
192
		WARN(1, "kobject: (%p): attempted to be registered with empty "
193
			 "name!\n", kobj);
194 195
		return -EINVAL;
	}
L
Linus Torvalds 已提交
196

197
	parent = kobject_get(kobj->parent);
L
Linus Torvalds 已提交
198

199
	/* join kset if set, use it as parent if we do not already have one */
L
Linus Torvalds 已提交
200
	if (kobj->kset) {
201
		if (!parent)
L
Linus Torvalds 已提交
202
			parent = kobject_get(&kobj->kset->kobj);
203
		kobj_kset_join(kobj);
204
		kobj->parent = parent;
L
Linus Torvalds 已提交
205 206
	}

207
	pr_debug("kobject: '%s' (%p): %s: parent: '%s', set: '%s'\n",
208
		 kobject_name(kobj), kobj, __func__,
209
		 parent ? kobject_name(parent) : "<NULL>",
210
		 kobj->kset ? kobject_name(&kobj->kset->kobj) : "<NULL>");
211

212
	error = create_dir(kobj);
L
Linus Torvalds 已提交
213
	if (error) {
214 215 216
		kobj_kset_leave(kobj);
		kobject_put(parent);
		kobj->parent = NULL;
217 218 219

		/* be noisy on error issues */
		if (error == -EEXIST)
220 221 222 223
			WARN(1, "%s failed for %s with "
			     "-EEXIST, don't try to register things with "
			     "the same name in the same directory.\n",
			     __func__, kobject_name(kobj));
224
		else
225 226 227
			WARN(1, "%s failed for %s (error: %d parent: %s)\n",
			     __func__, kobject_name(kobj), error,
			     parent ? kobject_name(parent) : "'none'");
228 229
	} else
		kobj->state_in_sysfs = 1;
L
Linus Torvalds 已提交
230 231 232 233

	return error;
}

234 235 236 237 238 239
/**
 * kobject_set_name_vargs - Set the name of an kobject
 * @kobj: struct kobject to set the name of
 * @fmt: format string used to build the name
 * @vargs: vargs to format the string.
 */
240
int kobject_set_name_vargs(struct kobject *kobj, const char *fmt,
241 242
				  va_list vargs)
{
243 244
	const char *old_name = kobj->name;
	char *s;
245

246 247 248
	if (kobj->name && !fmt)
		return 0;

249 250 251
	kobj->name = kvasprintf(GFP_KERNEL, fmt, vargs);
	if (!kobj->name)
		return -ENOMEM;
252

253
	/* ewww... some of these buggers have '/' in the name ... */
254
	while ((s = strchr(kobj->name, '/')))
255 256 257
		s[0] = '!';

	kfree(old_name);
258 259
	return 0;
}
L
Linus Torvalds 已提交
260 261

/**
262
 * kobject_set_name - Set the name of a kobject
263
 * @kobj: struct kobject to set the name of
264
 * @fmt: format string used to build the name
L
Linus Torvalds 已提交
265
 *
266 267 268
 * This sets the name of the kobject.  If you have already added the
 * kobject to the system, you must call kobject_rename() in order to
 * change the name of the kobject.
L
Linus Torvalds 已提交
269
 */
270
int kobject_set_name(struct kobject *kobj, const char *fmt, ...)
L
Linus Torvalds 已提交
271
{
272
	va_list vargs;
273
	int retval;
L
Linus Torvalds 已提交
274

275 276 277
	va_start(vargs, fmt);
	retval = kobject_set_name_vargs(kobj, fmt, vargs);
	va_end(vargs);
L
Linus Torvalds 已提交
278

279
	return retval;
L
Linus Torvalds 已提交
280 281 282
}
EXPORT_SYMBOL(kobject_set_name);

283
/**
284
 * kobject_init - initialize a kobject structure
285 286 287 288 289 290 291 292 293 294
 * @kobj: pointer to the kobject to initialize
 * @ktype: pointer to the ktype for this kobject.
 *
 * This function will properly initialize a kobject such that it can then
 * be passed to the kobject_add() call.
 *
 * After this function is called, the kobject MUST be cleaned up by a call
 * to kobject_put(), not by a call to kfree directly to ensure that all of
 * the memory is cleaned up properly.
 */
295
void kobject_init(struct kobject *kobj, struct kobj_type *ktype)
296 297 298 299 300 301 302 303 304 305 306
{
	char *err_str;

	if (!kobj) {
		err_str = "invalid kobject pointer!";
		goto error;
	}
	if (!ktype) {
		err_str = "must have a ktype to be initialized properly!\n";
		goto error;
	}
307
	if (kobj->state_initialized) {
308
		/* do not error out as sometimes we can recover */
309 310
		printk(KERN_ERR "kobject (%p): tried to init an initialized "
		       "object, something is seriously wrong.\n", kobj);
311 312 313
		dump_stack();
	}

314
	kobject_init_internal(kobj);
315 316 317 318
	kobj->ktype = ktype;
	return;

error:
319
	printk(KERN_ERR "kobject (%p): %s\n", kobj, err_str);
320 321
	dump_stack();
}
322
EXPORT_SYMBOL(kobject_init);
323

324 325 326 327 328
static int kobject_add_varg(struct kobject *kobj, struct kobject *parent,
			    const char *fmt, va_list vargs)
{
	int retval;

329
	retval = kobject_set_name_vargs(kobj, fmt, vargs);
330 331 332 333 334
	if (retval) {
		printk(KERN_ERR "kobject: can not set name properly!\n");
		return retval;
	}
	kobj->parent = parent;
335
	return kobject_add_internal(kobj);
336 337 338
}

/**
339
 * kobject_add - the main kobject add function
340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357
 * @kobj: the kobject to add
 * @parent: pointer to the parent of the kobject.
 * @fmt: format to name the kobject with.
 *
 * The kobject name is set and added to the kobject hierarchy in this
 * function.
 *
 * If @parent is set, then the parent of the @kobj will be set to it.
 * If @parent is NULL, then the parent of the @kobj will be set to the
 * kobject associted with the kset assigned to this kobject.  If no kset
 * is assigned to the kobject, then the kobject will be located in the
 * root of the sysfs tree.
 *
 * If this function returns an error, kobject_put() must be called to
 * properly clean up the memory associated with the object.
 * Under no instance should the kobject that is passed to this function
 * be directly freed with a call to kfree(), that can leak memory.
 *
358
 * Note, no "add" uevent will be created with this call, the caller should set
359 360 361 362
 * up all of the necessary sysfs files for the object and then call
 * kobject_uevent() with the UEVENT_ADD parameter to ensure that
 * userspace is properly notified of this kobject's creation.
 */
363 364
int kobject_add(struct kobject *kobj, struct kobject *parent,
		const char *fmt, ...)
365 366 367 368 369 370 371
{
	va_list args;
	int retval;

	if (!kobj)
		return -EINVAL;

372 373 374 375 376 377 378
	if (!kobj->state_initialized) {
		printk(KERN_ERR "kobject '%s' (%p): tried to add an "
		       "uninitialized object, something is seriously wrong.\n",
		       kobject_name(kobj), kobj);
		dump_stack();
		return -EINVAL;
	}
379 380 381 382 383 384
	va_start(args, fmt);
	retval = kobject_add_varg(kobj, parent, fmt, args);
	va_end(args);

	return retval;
}
385
EXPORT_SYMBOL(kobject_add);
386

387 388 389 390 391 392 393
/**
 * kobject_init_and_add - initialize a kobject structure and add it to the kobject hierarchy
 * @kobj: pointer to the kobject to initialize
 * @ktype: pointer to the ktype for this kobject.
 * @parent: pointer to the parent of this kobject.
 * @fmt: the name of the kobject.
 *
394
 * This function combines the call to kobject_init() and
395 396
 * kobject_add().  The same type of error handling after a call to
 * kobject_add() and kobject lifetime rules are the same here.
397 398 399 400 401 402 403
 */
int kobject_init_and_add(struct kobject *kobj, struct kobj_type *ktype,
			 struct kobject *parent, const char *fmt, ...)
{
	va_list args;
	int retval;

404
	kobject_init(kobj, ktype);
405 406 407 408 409 410 411 412 413

	va_start(args, fmt);
	retval = kobject_add_varg(kobj, parent, fmt, args);
	va_end(args);

	return retval;
}
EXPORT_SYMBOL_GPL(kobject_init_and_add);

L
Linus Torvalds 已提交
414
/**
415 416 417
 * kobject_rename - change the name of an object
 * @kobj: object in question.
 * @new_name: object's new name
418 419 420 421 422
 *
 * It is the responsibility of the caller to provide mutual
 * exclusion between two different calls of kobject_rename
 * on the same kobject and to ensure that new_name is valid and
 * won't conflict with other kobjects.
L
Linus Torvalds 已提交
423
 */
424
int kobject_rename(struct kobject *kobj, const char *new_name)
L
Linus Torvalds 已提交
425 426
{
	int error = 0;
427
	const char *devpath = NULL;
428
	const char *dup_name = NULL, *name;
429 430
	char *devpath_string = NULL;
	char *envp[2];
L
Linus Torvalds 已提交
431 432 433 434

	kobj = kobject_get(kobj);
	if (!kobj)
		return -EINVAL;
435 436
	if (!kobj->parent)
		return -EINVAL;
437 438 439 440 441 442 443 444 445 446 447 448 449 450 451

	devpath = kobject_get_path(kobj, GFP_KERNEL);
	if (!devpath) {
		error = -ENOMEM;
		goto out;
	}
	devpath_string = kmalloc(strlen(devpath) + 15, GFP_KERNEL);
	if (!devpath_string) {
		error = -ENOMEM;
		goto out;
	}
	sprintf(devpath_string, "DEVPATH_OLD=%s", devpath);
	envp[0] = devpath_string;
	envp[1] = NULL;

452 453 454 455 456 457
	name = dup_name = kstrdup(new_name, GFP_KERNEL);
	if (!name) {
		error = -ENOMEM;
		goto out;
	}

458
	error = sysfs_rename_dir_ns(kobj, new_name, kobject_namespace(kobj));
459 460 461 462 463 464
	if (error)
		goto out;

	/* Install the new kobject name */
	dup_name = kobj->name;
	kobj->name = name;
465 466 467 468

	/* This function is mostly/only used for network interface.
	 * Some hotplug package track interfaces by their name and
	 * therefore want to know when the name is changed by the user. */
469
	kobject_uevent_env(kobj, KOBJ_MOVE, envp);
470 471

out:
472
	kfree(dup_name);
473 474
	kfree(devpath_string);
	kfree(devpath);
475 476 477 478
	kobject_put(kobj);

	return error;
}
479
EXPORT_SYMBOL_GPL(kobject_rename);
480

481
/**
482 483 484
 * kobject_move - move object to another parent
 * @kobj: object in question.
 * @new_parent: object's new parent (can be NULL)
485 486 487 488 489 490 491 492 493 494 495 496 497 498
 */
int kobject_move(struct kobject *kobj, struct kobject *new_parent)
{
	int error;
	struct kobject *old_parent;
	const char *devpath = NULL;
	char *devpath_string = NULL;
	char *envp[2];

	kobj = kobject_get(kobj);
	if (!kobj)
		return -EINVAL;
	new_parent = kobject_get(new_parent);
	if (!new_parent) {
499 500
		if (kobj->kset)
			new_parent = kobject_get(&kobj->kset->kobj);
501
	}
502

503 504 505 506 507 508 509 510 511 512 513 514 515 516
	/* old object path */
	devpath = kobject_get_path(kobj, GFP_KERNEL);
	if (!devpath) {
		error = -ENOMEM;
		goto out;
	}
	devpath_string = kmalloc(strlen(devpath) + 15, GFP_KERNEL);
	if (!devpath_string) {
		error = -ENOMEM;
		goto out;
	}
	sprintf(devpath_string, "DEVPATH_OLD=%s", devpath);
	envp[0] = devpath_string;
	envp[1] = NULL;
517
	error = sysfs_move_dir_ns(kobj, new_parent, kobject_namespace(kobj));
518 519 520 521
	if (error)
		goto out;
	old_parent = kobj->parent;
	kobj->parent = new_parent;
522
	new_parent = NULL;
523 524 525
	kobject_put(old_parent);
	kobject_uevent_env(kobj, KOBJ_MOVE, envp);
out:
526
	kobject_put(new_parent);
527 528 529 530 531 532
	kobject_put(kobj);
	kfree(devpath_string);
	kfree(devpath);
	return error;
}

L
Linus Torvalds 已提交
533
/**
534 535
 * kobject_del - unlink kobject from hierarchy.
 * @kobj: object.
L
Linus Torvalds 已提交
536
 */
537
void kobject_del(struct kobject *kobj)
L
Linus Torvalds 已提交
538
{
539 540
	struct sysfs_dirent *sd;

541 542
	if (!kobj)
		return;
543

544
	sd = kobj->sd;
L
Linus Torvalds 已提交
545
	sysfs_remove_dir(kobj);
546 547
	sysfs_put(sd);

548 549 550 551
	kobj->state_in_sysfs = 0;
	kobj_kset_leave(kobj);
	kobject_put(kobj->parent);
	kobj->parent = NULL;
L
Linus Torvalds 已提交
552 553 554
}

/**
555 556
 * kobject_get - increment refcount for object.
 * @kobj: object.
L
Linus Torvalds 已提交
557
 */
558
struct kobject *kobject_get(struct kobject *kobj)
L
Linus Torvalds 已提交
559 560 561 562 563 564
{
	if (kobj)
		kref_get(&kobj->kref);
	return kobj;
}

A
Anatol Pomozov 已提交
565
static struct kobject * __must_check kobject_get_unless_zero(struct kobject *kobj)
566 567 568 569 570 571
{
	if (!kref_get_unless_zero(&kobj->kref))
		kobj = NULL;
	return kobj;
}

572 573 574
/*
 * kobject_cleanup - free kobject resources.
 * @kobj: object to cleanup
L
Linus Torvalds 已提交
575
 */
576
static void kobject_cleanup(struct kobject *kobj)
L
Linus Torvalds 已提交
577
{
578
	struct kobj_type *t = get_ktype(kobj);
579
	const char *name = kobj->name;
L
Linus Torvalds 已提交
580

581 582
	pr_debug("kobject: '%s' (%p): %s, parent %p\n",
		 kobject_name(kobj), kobj, __func__, kobj->parent);
583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602

	if (t && !t->release)
		pr_debug("kobject: '%s' (%p): does not have a release() "
			 "function, it is broken and must be fixed.\n",
			 kobject_name(kobj), kobj);

	/* send "remove" if the caller did not do it but sent "add" */
	if (kobj->state_add_uevent_sent && !kobj->state_remove_uevent_sent) {
		pr_debug("kobject: '%s' (%p): auto cleanup 'remove' event\n",
			 kobject_name(kobj), kobj);
		kobject_uevent(kobj, KOBJ_REMOVE);
	}

	/* remove from sysfs if the caller did not do it */
	if (kobj->state_in_sysfs) {
		pr_debug("kobject: '%s' (%p): auto cleanup kobject_del\n",
			 kobject_name(kobj), kobj);
		kobject_del(kobj);
	}

603
	if (t && t->release) {
604 605
		pr_debug("kobject: '%s' (%p): calling ktype release\n",
			 kobject_name(kobj), kobj);
L
Linus Torvalds 已提交
606
		t->release(kobj);
607 608 609
	}

	/* free name if we allocated it */
610
	if (name) {
611
		pr_debug("kobject: '%s': free name\n", name);
612 613
		kfree(name);
	}
L
Linus Torvalds 已提交
614 615
}

616 617 618 619 620 621 622 623
#ifdef CONFIG_DEBUG_KOBJECT_RELEASE
static void kobject_delayed_cleanup(struct work_struct *work)
{
	kobject_cleanup(container_of(to_delayed_work(work),
				     struct kobject, release));
}
#endif

L
Linus Torvalds 已提交
624 625
static void kobject_release(struct kref *kref)
{
626 627
	struct kobject *kobj = container_of(kref, struct kobject, kref);
#ifdef CONFIG_DEBUG_KOBJECT_RELEASE
628
	pr_info("kobject: '%s' (%p): %s, parent %p (delayed)\n",
629 630 631 632 633 634
		 kobject_name(kobj), kobj, __func__, kobj->parent);
	INIT_DELAYED_WORK(&kobj->release, kobject_delayed_cleanup);
	schedule_delayed_work(&kobj->release, HZ);
#else
	kobject_cleanup(kobj);
#endif
L
Linus Torvalds 已提交
635 636 637
}

/**
638 639
 * kobject_put - decrement refcount for object.
 * @kobj: object.
L
Linus Torvalds 已提交
640
 *
641
 * Decrement the refcount, and if 0, call kobject_cleanup().
L
Linus Torvalds 已提交
642
 */
643
void kobject_put(struct kobject *kobj)
L
Linus Torvalds 已提交
644
{
645
	if (kobj) {
A
Arjan van de Ven 已提交
646 647
		if (!kobj->state_initialized)
			WARN(1, KERN_WARNING "kobject: '%s' (%p): is not "
648 649
			       "initialized, yet kobject_put() is being "
			       "called.\n", kobject_name(kobj), kobj);
L
Linus Torvalds 已提交
650
		kref_put(&kobj->kref, kobject_release);
651
	}
L
Linus Torvalds 已提交
652 653
}

654
static void dynamic_kobj_release(struct kobject *kobj)
J
Jun'ichi Nomura 已提交
655
{
656
	pr_debug("kobject: (%p): %s\n", kobj, __func__);
J
Jun'ichi Nomura 已提交
657 658 659
	kfree(kobj);
}

660
static struct kobj_type dynamic_kobj_ktype = {
661 662
	.release	= dynamic_kobj_release,
	.sysfs_ops	= &kobj_sysfs_ops,
J
Jun'ichi Nomura 已提交
663 664
};

665
/**
666 667 668 669 670 671
 * kobject_create - create a struct kobject dynamically
 *
 * This function creates a kobject structure dynamically and sets it up
 * to be a "dynamic" kobject with a default release function set up.
 *
 * If the kobject was not able to be created, NULL will be returned.
672
 * The kobject structure returned from here must be cleaned up with a
673
 * call to kobject_put() and not kfree(), as kobject_init() has
674
 * already been called on this structure.
675
 */
676
struct kobject *kobject_create(void)
677 678 679 680 681 682 683
{
	struct kobject *kobj;

	kobj = kzalloc(sizeof(*kobj), GFP_KERNEL);
	if (!kobj)
		return NULL;

684
	kobject_init(kobj, &dynamic_kobj_ktype);
685 686 687 688 689 690
	return kobj;
}

/**
 * kobject_create_and_add - create a struct kobject dynamically and register it with sysfs
 *
Z
Zhi Yong Wu 已提交
691
 * @name: the name for the kobject
692 693
 * @parent: the parent kobject of this kobject, if any.
 *
D
Dave Young 已提交
694
 * This function creates a kobject structure dynamically and registers it
695
 * with sysfs.  When you are finished with this structure, call
696
 * kobject_put() and the structure will be dynamically freed when
697 698 699 700 701 702 703 704 705 706 707 708 709
 * it is no longer being used.
 *
 * If the kobject was not able to be created, NULL will be returned.
 */
struct kobject *kobject_create_and_add(const char *name, struct kobject *parent)
{
	struct kobject *kobj;
	int retval;

	kobj = kobject_create();
	if (!kobj)
		return NULL;

710
	retval = kobject_add(kobj, parent, "%s", name);
711 712
	if (retval) {
		printk(KERN_WARNING "%s: kobject_add error: %d\n",
713
		       __func__, retval);
714 715 716 717 718 719 720
		kobject_put(kobj);
		kobj = NULL;
	}
	return kobj;
}
EXPORT_SYMBOL_GPL(kobject_create_and_add);

L
Linus Torvalds 已提交
721
/**
722 723
 * kset_init - initialize a kset for use
 * @k: kset
L
Linus Torvalds 已提交
724
 */
725
void kset_init(struct kset *k)
L
Linus Torvalds 已提交
726
{
727
	kobject_init_internal(&k->kobj);
L
Linus Torvalds 已提交
728 729 730 731
	INIT_LIST_HEAD(&k->list);
	spin_lock_init(&k->list_lock);
}

732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756
/* default kobject attribute operations */
static ssize_t kobj_attr_show(struct kobject *kobj, struct attribute *attr,
			      char *buf)
{
	struct kobj_attribute *kattr;
	ssize_t ret = -EIO;

	kattr = container_of(attr, struct kobj_attribute, attr);
	if (kattr->show)
		ret = kattr->show(kobj, kattr, buf);
	return ret;
}

static ssize_t kobj_attr_store(struct kobject *kobj, struct attribute *attr,
			       const char *buf, size_t count)
{
	struct kobj_attribute *kattr;
	ssize_t ret = -EIO;

	kattr = container_of(attr, struct kobj_attribute, attr);
	if (kattr->store)
		ret = kattr->store(kobj, kattr, buf, count);
	return ret;
}

757
const struct sysfs_ops kobj_sysfs_ops = {
758 759 760
	.show	= kobj_attr_show,
	.store	= kobj_attr_store,
};
L
Linus Torvalds 已提交
761

762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810
/**
 * kobj_completion_init - initialize a kobj_completion object.
 * @kc: kobj_completion
 * @ktype: type of kobject to initialize
 *
 * kobj_completion structures can be embedded within structures with different
 * lifetime rules.  During the release of the enclosing object, we can
 * wait on the release of the kobject so that we don't free it while it's
 * still busy.
 */
void kobj_completion_init(struct kobj_completion *kc, struct kobj_type *ktype)
{
	init_completion(&kc->kc_unregister);
	kobject_init(&kc->kc_kobj, ktype);
}
EXPORT_SYMBOL_GPL(kobj_completion_init);

/**
 * kobj_completion_release - release a kobj_completion object
 * @kobj: kobject embedded in kobj_completion
 *
 * Used with kobject_release to notify waiters that the kobject has been
 * released.
 */
void kobj_completion_release(struct kobject *kobj)
{
	struct kobj_completion *kc = kobj_to_kobj_completion(kobj);
	complete(&kc->kc_unregister);
}
EXPORT_SYMBOL_GPL(kobj_completion_release);

/**
 * kobj_completion_del_and_wait - release the kobject and wait for it
 * @kc: kobj_completion object to release
 *
 * Delete the kobject from sysfs and drop the reference count.  Then wait
 * until any other outstanding references are also dropped.  This routine
 * is only necessary once other references may have been taken on the
 * kobject.  Typically this happens when the kobject has been published
 * to sysfs via kobject_add.
 */
void kobj_completion_del_and_wait(struct kobj_completion *kc)
{
	kobject_del(&kc->kc_kobj);
	kobject_put(&kc->kc_kobj);
	wait_for_completion(&kc->kc_unregister);
}
EXPORT_SYMBOL_GPL(kobj_completion_del_and_wait);

L
Linus Torvalds 已提交
811
/**
812 813
 * kset_register - initialize and add a kset.
 * @k: kset.
L
Linus Torvalds 已提交
814
 */
815
int kset_register(struct kset *k)
L
Linus Torvalds 已提交
816
{
817 818
	int err;

819 820
	if (!k)
		return -EINVAL;
821

L
Linus Torvalds 已提交
822
	kset_init(k);
823
	err = kobject_add_internal(&k->kobj);
824 825 826 827
	if (err)
		return err;
	kobject_uevent(&k->kobj, KOBJ_ADD);
	return 0;
L
Linus Torvalds 已提交
828 829 830
}

/**
831 832
 * kset_unregister - remove a kset.
 * @k: kset.
L
Linus Torvalds 已提交
833
 */
834
void kset_unregister(struct kset *k)
L
Linus Torvalds 已提交
835
{
836 837
	if (!k)
		return;
838
	kobject_put(&k->kobj);
L
Linus Torvalds 已提交
839 840 841
}

/**
842 843 844
 * kset_find_obj - search for object in kset.
 * @kset: kset we're looking in.
 * @name: object's name.
L
Linus Torvalds 已提交
845
 *
846 847 848
 * Lock kset via @kset->subsys, and iterate over @kset->list,
 * looking for a matching kobject. If matching object is found
 * take a reference and return the object.
L
Linus Torvalds 已提交
849
 */
850
struct kobject *kset_find_obj(struct kset *kset, const char *name)
L
Linus Torvalds 已提交
851
{
852
	struct kobject *k;
853
	struct kobject *ret = NULL;
L
Linus Torvalds 已提交
854 855

	spin_lock(&kset->list_lock);
856

857
	list_for_each_entry(k, &kset->list, entry) {
858
		if (kobject_name(k) && !strcmp(kobject_name(k), name)) {
859
			ret = kobject_get_unless_zero(k);
L
Linus Torvalds 已提交
860 861 862
			break;
		}
	}
863

L
Linus Torvalds 已提交
864 865 866 867
	spin_unlock(&kset->list_lock);
	return ret;
}

868 869 870
static void kset_release(struct kobject *kobj)
{
	struct kset *kset = container_of(kobj, struct kset, kobj);
871
	pr_debug("kobject: '%s' (%p): %s\n",
872
		 kobject_name(kobj), kobj, __func__);
873 874 875
	kfree(kset);
}

876 877
static struct kobj_type kset_ktype = {
	.sysfs_ops	= &kobj_sysfs_ops,
878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896
	.release = kset_release,
};

/**
 * kset_create - create a struct kset dynamically
 *
 * @name: the name for the kset
 * @uevent_ops: a struct kset_uevent_ops for the kset
 * @parent_kobj: the parent kobject of this kset, if any.
 *
 * This function creates a kset structure dynamically.  This structure can
 * then be registered with the system and show up in sysfs with a call to
 * kset_register().  When you are finished with this structure, if
 * kset_register() has been called, call kset_unregister() and the
 * structure will be dynamically freed when it is no longer being used.
 *
 * If the kset was not able to be created, NULL will be returned.
 */
static struct kset *kset_create(const char *name,
897
				const struct kset_uevent_ops *uevent_ops,
898 899 900
				struct kobject *parent_kobj)
{
	struct kset *kset;
901
	int retval;
902 903 904 905

	kset = kzalloc(sizeof(*kset), GFP_KERNEL);
	if (!kset)
		return NULL;
906
	retval = kobject_set_name(&kset->kobj, "%s", name);
907 908 909 910
	if (retval) {
		kfree(kset);
		return NULL;
	}
911 912 913 914
	kset->uevent_ops = uevent_ops;
	kset->kobj.parent = parent_kobj;

	/*
915
	 * The kobject of this kset will have a type of kset_ktype and belong to
916 917 918
	 * no kset itself.  That way we can properly free it when it is
	 * finished being used.
	 */
919
	kset->kobj.ktype = &kset_ktype;
920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939
	kset->kobj.kset = NULL;

	return kset;
}

/**
 * kset_create_and_add - create a struct kset dynamically and add it to sysfs
 *
 * @name: the name for the kset
 * @uevent_ops: a struct kset_uevent_ops for the kset
 * @parent_kobj: the parent kobject of this kset, if any.
 *
 * This function creates a kset structure dynamically and registers it
 * with sysfs.  When you are finished with this structure, call
 * kset_unregister() and the structure will be dynamically freed when it
 * is no longer being used.
 *
 * If the kset was not able to be created, NULL will be returned.
 */
struct kset *kset_create_and_add(const char *name,
940
				 const struct kset_uevent_ops *uevent_ops,
941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957
				 struct kobject *parent_kobj)
{
	struct kset *kset;
	int error;

	kset = kset_create(name, uevent_ops, parent_kobj);
	if (!kset)
		return NULL;
	error = kset_register(kset);
	if (error) {
		kfree(kset);
		return NULL;
	}
	return kset;
}
EXPORT_SYMBOL_GPL(kset_create_and_add);

958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015

static DEFINE_SPINLOCK(kobj_ns_type_lock);
static const struct kobj_ns_type_operations *kobj_ns_ops_tbl[KOBJ_NS_TYPES];

int kobj_ns_type_register(const struct kobj_ns_type_operations *ops)
{
	enum kobj_ns_type type = ops->type;
	int error;

	spin_lock(&kobj_ns_type_lock);

	error = -EINVAL;
	if (type >= KOBJ_NS_TYPES)
		goto out;

	error = -EINVAL;
	if (type <= KOBJ_NS_TYPE_NONE)
		goto out;

	error = -EBUSY;
	if (kobj_ns_ops_tbl[type])
		goto out;

	error = 0;
	kobj_ns_ops_tbl[type] = ops;

out:
	spin_unlock(&kobj_ns_type_lock);
	return error;
}

int kobj_ns_type_registered(enum kobj_ns_type type)
{
	int registered = 0;

	spin_lock(&kobj_ns_type_lock);
	if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES))
		registered = kobj_ns_ops_tbl[type] != NULL;
	spin_unlock(&kobj_ns_type_lock);

	return registered;
}

const struct kobj_ns_type_operations *kobj_child_ns_ops(struct kobject *parent)
{
	const struct kobj_ns_type_operations *ops = NULL;

	if (parent && parent->ktype->child_ns_type)
		ops = parent->ktype->child_ns_type(parent);

	return ops;
}

const struct kobj_ns_type_operations *kobj_ns_ops(struct kobject *kobj)
{
	return kobj_child_ns_ops(kobj->parent);
}

1016 1017
bool kobj_ns_current_may_mount(enum kobj_ns_type type)
{
1018
	bool may_mount = true;
1019 1020 1021 1022 1023 1024 1025 1026 1027

	spin_lock(&kobj_ns_type_lock);
	if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
	    kobj_ns_ops_tbl[type])
		may_mount = kobj_ns_ops_tbl[type]->current_may_mount();
	spin_unlock(&kobj_ns_type_lock);

	return may_mount;
}
1028

1029
void *kobj_ns_grab_current(enum kobj_ns_type type)
1030
{
1031
	void *ns = NULL;
1032 1033 1034 1035

	spin_lock(&kobj_ns_type_lock);
	if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
	    kobj_ns_ops_tbl[type])
1036
		ns = kobj_ns_ops_tbl[type]->grab_current_ns();
1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067
	spin_unlock(&kobj_ns_type_lock);

	return ns;
}

const void *kobj_ns_netlink(enum kobj_ns_type type, struct sock *sk)
{
	const void *ns = NULL;

	spin_lock(&kobj_ns_type_lock);
	if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
	    kobj_ns_ops_tbl[type])
		ns = kobj_ns_ops_tbl[type]->netlink_ns(sk);
	spin_unlock(&kobj_ns_type_lock);

	return ns;
}

const void *kobj_ns_initial(enum kobj_ns_type type)
{
	const void *ns = NULL;

	spin_lock(&kobj_ns_type_lock);
	if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
	    kobj_ns_ops_tbl[type])
		ns = kobj_ns_ops_tbl[type]->initial_ns();
	spin_unlock(&kobj_ns_type_lock);

	return ns;
}

1068
void kobj_ns_drop(enum kobj_ns_type type, void *ns)
1069
{
1070 1071 1072 1073 1074
	spin_lock(&kobj_ns_type_lock);
	if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
	    kobj_ns_ops_tbl[type] && kobj_ns_ops_tbl[type]->drop_ns)
		kobj_ns_ops_tbl[type]->drop_ns(ns);
	spin_unlock(&kobj_ns_type_lock);
1075 1076
}

L
Linus Torvalds 已提交
1077 1078 1079 1080 1081 1082
EXPORT_SYMBOL(kobject_get);
EXPORT_SYMBOL(kobject_put);
EXPORT_SYMBOL(kobject_del);

EXPORT_SYMBOL(kset_register);
EXPORT_SYMBOL(kset_unregister);