kobject.c 21.2 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 16 17 18
 *
 * 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>
#include <linux/string.h>
#include <linux/module.h>
#include <linux/stat.h>
T
Tim Schmielau 已提交
19
#include <linux/slab.h>
L
Linus Torvalds 已提交
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48

/**
 *	populate_dir - populate directory with attributes.
 *	@kobj:	object we're working on.
 *
 *	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.
 *
 */

static int populate_dir(struct kobject * kobj)
{
	struct kobj_type * t = get_ktype(kobj);
	struct attribute * attr;
	int error = 0;
	int i;
	
	if (t && t->default_attrs) {
		for (i = 0; (attr = t->default_attrs[i]) != NULL; i++) {
			if ((error = sysfs_create_file(kobj,attr)))
				break;
		}
	}
	return error;
}

49
static int create_dir(struct kobject * kobj)
L
Linus Torvalds 已提交
50 51 52
{
	int error = 0;
	if (kobject_name(kobj)) {
53
		error = sysfs_create_dir(kobj);
L
Linus Torvalds 已提交
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
		if (!error) {
			if ((error = populate_dir(kobj)))
				sysfs_remove_dir(kobj);
		}
	}
	return error;
}

static inline struct kobject * to_kobj(struct list_head * entry)
{
	return container_of(entry,struct kobject,entry);
}

static int get_kobj_path_length(struct kobject *kobj)
{
	int length = 1;
	struct kobject * parent = kobj;

	/* walk up the ancestors until we hit the one pointing to the 
	 * root.
	 * Add 1 to strlen for leading '/' of each level.
	 */
	do {
77 78
		if (kobject_name(parent) == NULL)
			return 0;
L
Linus Torvalds 已提交
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
		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)
{
	struct kobject * parent;

	--length;
	for (parent = kobj; parent; parent = parent->parent) {
		int cur = strlen(kobject_name(parent));
		/* back up enough to print this name with '/' */
		length -= cur;
		strncpy (path + length, kobject_name(parent), cur);
		*(path + --length) = '/';
	}

98 99
	pr_debug("kobject: '%s' (%p): %s: path = '%s'\n", kobject_name(kobj),
		 kobj, __FUNCTION__,path);
L
Linus Torvalds 已提交
100 101 102
}

/**
103
 * kobject_get_path - generate and return the path associated with a given kobj and kset pair.
L
Linus Torvalds 已提交
104 105 106
 *
 * @kobj:	kobject in question, with which to build the path
 * @gfp_mask:	the allocation type used to allocate the path
107 108
 *
 * The result must be freed by the caller with kfree().
L
Linus Torvalds 已提交
109
 */
A
Al Viro 已提交
110
char *kobject_get_path(struct kobject *kobj, gfp_t gfp_mask)
L
Linus Torvalds 已提交
111 112 113 114 115
{
	char *path;
	int len;

	len = get_kobj_path_length(kobj);
116 117
	if (len == 0)
		return NULL;
118
	path = kzalloc(len, gfp_mask);
L
Linus Torvalds 已提交
119 120 121 122 123 124
	if (!path)
		return NULL;
	fill_kobj_path(kobj, path, len);

	return path;
}
125
EXPORT_SYMBOL_GPL(kobject_get_path);
L
Linus Torvalds 已提交
126

127 128
/* add the kobject to its kset's list */
static void kobj_kset_join(struct kobject *kobj)
L
Linus Torvalds 已提交
129
{
130
	if (!kobj->kset)
131
		return;
132 133 134 135 136

	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 已提交
137 138
}

139 140 141 142 143
/* remove the kobject from its kset's list */
static void kobj_kset_leave(struct kobject *kobj)
{
	if (!kobj->kset)
		return;
L
Linus Torvalds 已提交
144

145 146 147 148 149
	spin_lock(&kobj->kset->list_lock);
	list_del_init(&kobj->entry);
	spin_unlock(&kobj->kset->list_lock);
	kset_put(kobj->kset);
}
L
Linus Torvalds 已提交
150

151
static void kobject_init_internal(struct kobject * kobj)
L
Linus Torvalds 已提交
152
{
153 154 155 156
	if (!kobj)
		return;
	kref_init(&kobj->kref);
	INIT_LIST_HEAD(&kobj->entry);
L
Linus Torvalds 已提交
157 158
}

159

160
static int kobject_add_internal(struct kobject *kobj)
L
Linus Torvalds 已提交
161 162 163 164
{
	int error = 0;
	struct kobject * parent;

165
	if (!kobj)
L
Linus Torvalds 已提交
166
		return -ENOENT;
167 168 169

	if (!kobj->k_name || !kobj->k_name[0]) {
		pr_debug("kobject: (%p): attempted to be registered with empty "
170
			 "name!\n", kobj);
171 172 173
		WARN_ON(1);
		return -EINVAL;
	}
L
Linus Torvalds 已提交
174

175
	parent = kobject_get(kobj->parent);
L
Linus Torvalds 已提交
176

177
	/* join kset if set, use it as parent if we do not already have one */
L
Linus Torvalds 已提交
178
	if (kobj->kset) {
179
		if (!parent)
L
Linus Torvalds 已提交
180
			parent = kobject_get(&kobj->kset->kobj);
181
		kobj_kset_join(kobj);
182
		kobj->parent = parent;
L
Linus Torvalds 已提交
183 184
	}

185 186 187 188 189
	pr_debug("kobject: '%s' (%p): %s: parent: '%s', set: '%s'\n",
		 kobject_name(kobj), kobj, __FUNCTION__,
		 parent ? kobject_name(parent) : "<NULL>",
		 kobj->kset ? kobject_name(&kobj->kset->kobj) : "<NULL>" );

190
	error = create_dir(kobj);
L
Linus Torvalds 已提交
191
	if (error) {
192 193 194
		kobj_kset_leave(kobj);
		kobject_put(parent);
		kobj->parent = NULL;
195 196 197

		/* be noisy on error issues */
		if (error == -EEXIST)
198
			printk(KERN_ERR "%s failed for %s with "
199 200
			       "-EEXIST, don't try to register things with "
			       "the same name in the same directory.\n",
201
			       __FUNCTION__, kobject_name(kobj));
202
		else
203 204
			printk(KERN_ERR "%s failed for %s (%d)\n",
			       __FUNCTION__, kobject_name(kobj), error);
205
		dump_stack();
206 207
	} else
		kobj->state_in_sysfs = 1;
L
Linus Torvalds 已提交
208 209 210 211

	return error;
}

212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230
/**
 * 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.
 */
static int kobject_set_name_vargs(struct kobject *kobj, const char *fmt,
				  va_list vargs)
{
	va_list aq;
	char *name;

	va_copy(aq, vargs);
	name = kvasprintf(GFP_KERNEL, fmt, vargs);
	va_end(aq);

	if (!name)
		return -ENOMEM;

231

232 233 234 235 236
	/* Free the old name, if necessary. */
	kfree(kobj->k_name);

	/* Now, set the new name */
	kobj->k_name = name;
237
	kobj->state_name_set = 1;
238 239 240

	return 0;
}
L
Linus Torvalds 已提交
241 242

/**
243
 * kobject_set_name - Set the name of a kobject
244
 * @kobj: struct kobject to set the name of
245
 * @fmt: format string used to build the name
L
Linus Torvalds 已提交
246
 *
247 248 249
 * 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 已提交
250
 */
251
int kobject_set_name(struct kobject *kobj, const char *fmt, ...)
L
Linus Torvalds 已提交
252 253
{
	va_list args;
254
	int retval;
L
Linus Torvalds 已提交
255

256
	va_start(args, fmt);
257
	retval = kobject_set_name_vargs(kobj, fmt, args);
L
Linus Torvalds 已提交
258 259
	va_end(args);

260
	return retval;
L
Linus Torvalds 已提交
261 262 263
}
EXPORT_SYMBOL(kobject_set_name);

264
/**
265
 * kobject_init - initialize a kobject structure
266 267 268 269 270 271 272 273 274 275
 * @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.
 */
276
void kobject_init(struct kobject *kobj, struct kobj_type *ktype)
277 278 279 280 281 282 283 284 285 286 287
{
	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;
	}
288
	if (kobj->state_initialized) {
289
		/* do not error out as sometimes we can recover */
290 291
		printk(KERN_ERR "kobject (%p): tried to init an initialized "
		       "object, something is seriously wrong.\n", kobj);
292 293 294 295 296 297
		dump_stack();
	}

	kref_init(&kobj->kref);
	INIT_LIST_HEAD(&kobj->entry);
	kobj->ktype = ktype;
298 299 300 301 302
	kobj->state_name_set = 0;
	kobj->state_in_sysfs = 0;
	kobj->state_add_uevent_sent = 0;
	kobj->state_remove_uevent_sent = 0;
	kobj->state_initialized = 1;
303 304 305
	return;

error:
306
	printk(KERN_ERR "kobject (%p): %s\n", kobj, err_str);
307 308
	dump_stack();
}
309
EXPORT_SYMBOL(kobject_init);
310

311 312 313 314 315 316 317 318 319 320 321 322 323 324
static int kobject_add_varg(struct kobject *kobj, struct kobject *parent,
			    const char *fmt, va_list vargs)
{
	va_list aq;
	int retval;

	va_copy(aq, vargs);
	retval = kobject_set_name_vargs(kobj, fmt, aq);
	va_end(aq);
	if (retval) {
		printk(KERN_ERR "kobject: can not set name properly!\n");
		return retval;
	}
	kobj->parent = parent;
325
	return kobject_add_internal(kobj);
326 327 328
}

/**
329
 * kobject_add - the main kobject add function
330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347
 * @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.
 *
348
 * Note, no "add" uevent will be created with this call, the caller should set
349 350 351 352
 * 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.
 */
353 354
int kobject_add(struct kobject *kobj, struct kobject *parent,
		const char *fmt, ...)
355 356 357 358 359 360 361
{
	va_list args;
	int retval;

	if (!kobj)
		return -EINVAL;

362 363 364 365 366 367 368
	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;
	}
369 370 371 372 373 374
	va_start(args, fmt);
	retval = kobject_add_varg(kobj, parent, fmt, args);
	va_end(args);

	return retval;
}
375
EXPORT_SYMBOL(kobject_add);
376

377 378 379 380 381 382 383
/**
 * 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.
 *
384
 * This function combines the call to kobject_init() and
385 386
 * kobject_add().  The same type of error handling after a call to
 * kobject_add() and kobject lifetime rules are the same here.
387 388 389 390 391 392 393
 */
int kobject_init_and_add(struct kobject *kobj, struct kobj_type *ktype,
			 struct kobject *parent, const char *fmt, ...)
{
	va_list args;
	int retval;

394
	kobject_init(kobj, ktype);
395 396 397 398 399 400 401 402 403

	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 已提交
404 405 406 407 408 409
/**
 *	kobject_rename - change the name of an object
 *	@kobj:	object in question.
 *	@new_name: object's new name
 */

410
int kobject_rename(struct kobject * kobj, const char *new_name)
L
Linus Torvalds 已提交
411 412
{
	int error = 0;
413 414 415
	const char *devpath = NULL;
	char *devpath_string = NULL;
	char *envp[2];
L
Linus Torvalds 已提交
416 417 418 419

	kobj = kobject_get(kobj);
	if (!kobj)
		return -EINVAL;
420 421
	if (!kobj->parent)
		return -EINVAL;
422

423 424 425 426 427
	/* see if this name is already in use */
	if (kobj->kset) {
		struct kobject *temp_kobj;
		temp_kobj = kset_find_obj(kobj->kset, new_name);
		if (temp_kobj) {
J
Johannes Berg 已提交
428 429
			printk(KERN_WARNING "kobject '%s' cannot be renamed "
			       "to '%s' as '%s' is already in existence.\n",
430 431 432 433 434 435
			       kobject_name(kobj), new_name, new_name);
			kobject_put(temp_kobj);
			return -EINVAL;
		}
	}

436 437 438 439 440 441 442 443 444 445 446 447 448 449
	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;

450
	error = sysfs_rename_dir(kobj, new_name);
451 452 453 454 455 456 457 458 459 460

	/* 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. */
	if (!error)
		kobject_uevent_env(kobj, KOBJ_MOVE, envp);

out:
	kfree(devpath_string);
	kfree(devpath);
461 462 463 464 465
	kobject_put(kobj);

	return error;
}

466 467 468
/**
 *	kobject_move - move object to another parent
 *	@kobj:	object in question.
469
 *	@new_parent: object's new parent (can be NULL)
470 471 472 473 474 475 476 477 478 479 480 481 482 483 484
 */

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) {
485 486
		if (kobj->kset)
			new_parent = kobject_get(&kobj->kset->kobj);
487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506
	}
	/* 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;
	error = sysfs_move_dir(kobj, new_parent);
	if (error)
		goto out;
	old_parent = kobj->parent;
	kobj->parent = new_parent;
507
	new_parent = NULL;
508 509 510
	kobject_put(old_parent);
	kobject_uevent_env(kobj, KOBJ_MOVE, envp);
out:
511
	kobject_put(new_parent);
512 513 514 515 516 517
	kobject_put(kobj);
	kfree(devpath_string);
	kfree(devpath);
	return error;
}

L
Linus Torvalds 已提交
518 519 520 521 522 523 524
/**
 *	kobject_del - unlink kobject from hierarchy.
 * 	@kobj:	object.
 */

void kobject_del(struct kobject * kobj)
{
525 526
	if (!kobj)
		return;
527

L
Linus Torvalds 已提交
528
	sysfs_remove_dir(kobj);
529 530 531 532
	kobj->state_in_sysfs = 0;
	kobj_kset_leave(kobj);
	kobject_put(kobj->parent);
	kobj->parent = NULL;
L
Linus Torvalds 已提交
533 534 535 536 537 538 539 540 541
}

/**
 *	kobject_unregister - remove object from hierarchy and decrement refcount.
 *	@kobj:	object going away.
 */

void kobject_unregister(struct kobject * kobj)
{
542 543
	if (!kobj)
		return;
544 545
	pr_debug("kobject: '%s' (%p): %s\n",
		 kobject_name(kobj), kobj, __FUNCTION__);
546
	kobject_uevent(kobj, KOBJ_REMOVE);
L
Linus Torvalds 已提交
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562
	kobject_del(kobj);
	kobject_put(kobj);
}

/**
 *	kobject_get - increment refcount for object.
 *	@kobj:	object.
 */

struct kobject * kobject_get(struct kobject * kobj)
{
	if (kobj)
		kref_get(&kobj->kref);
	return kobj;
}

563 564 565
/*
 * kobject_cleanup - free kobject resources.
 * @kobj: object to cleanup
L
Linus Torvalds 已提交
566
 */
567
static void kobject_cleanup(struct kobject *kobj)
L
Linus Torvalds 已提交
568
{
569
	struct kobj_type *t = get_ktype(kobj);
570
	const char *name = kobj->k_name;
571
	int name_set = kobj->state_name_set;
L
Linus Torvalds 已提交
572

573 574
	pr_debug("kobject: '%s' (%p): %s\n",
		 kobject_name(kobj), kobj, __FUNCTION__);
575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594

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

595
	if (t && t->release) {
596 597
		pr_debug("kobject: '%s' (%p): calling ktype release\n",
			 kobject_name(kobj), kobj);
L
Linus Torvalds 已提交
598
		t->release(kobj);
599 600 601 602 603
	}

	/* free name if we allocated it */
	if (name_set && name) {
		pr_debug("kobject: '%s': free name\n", name);
604 605
		kfree(name);
	}
L
Linus Torvalds 已提交
606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624
}

static void kobject_release(struct kref *kref)
{
	kobject_cleanup(container_of(kref, struct kobject, kref));
}

/**
 *	kobject_put - decrement refcount for object.
 *	@kobj:	object.
 *
 *	Decrement the refcount, and if 0, call kobject_cleanup().
 */
void kobject_put(struct kobject * kobj)
{
	if (kobj)
		kref_put(&kobj->kref, kobject_release);
}

625
static void dynamic_kobj_release(struct kobject *kobj)
J
Jun'ichi Nomura 已提交
626
{
627
	pr_debug("kobject: (%p): %s\n", kobj, __FUNCTION__);
J
Jun'ichi Nomura 已提交
628 629 630
	kfree(kobj);
}

631
static struct kobj_type dynamic_kobj_ktype = {
632 633
	.release	= dynamic_kobj_release,
	.sysfs_ops	= &kobj_sysfs_ops,
J
Jun'ichi Nomura 已提交
634 635
};

636
/**
637 638 639 640 641 642
 * 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.
643
 * The kobject structure returned from here must be cleaned up with a
644
 * call to kobject_put() and not kfree(), as kobject_init() has
645
 * already been called on this structure.
646
 */
647
struct kobject *kobject_create(void)
648 649 650 651 652 653 654
{
	struct kobject *kobj;

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

655
	kobject_init(kobj, &dynamic_kobj_ktype);
656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680
	return kobj;
}

/**
 * kobject_create_and_add - create a struct kobject dynamically and register it with sysfs
 *
 * @name: the name for the kset
 * @parent: the parent kobject of this kobject, if any.
 *
 * This function creates a kset structure dynamically and registers it
 * with sysfs.  When you are finished with this structure, call
 * kobject_unregister() and the structure will be dynamically freed when
 * 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;

681
	retval = kobject_add(kobj, parent, "%s", name);
682 683 684 685 686 687 688 689 690 691
	if (retval) {
		printk(KERN_WARNING "%s: kobject_add error: %d\n",
		       __FUNCTION__, retval);
		kobject_put(kobj);
		kobj = NULL;
	}
	return kobj;
}
EXPORT_SYMBOL_GPL(kobject_create_and_add);

L
Linus Torvalds 已提交
692 693 694 695 696 697 698
/**
 *	kset_init - initialize a kset for use
 *	@k:	kset 
 */

void kset_init(struct kset * k)
{
699
	kobject_init_internal(&k->kobj);
L
Linus Torvalds 已提交
700 701 702 703
	INIT_LIST_HEAD(&k->list);
	spin_lock_init(&k->list_lock);
}

704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732
/* 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;
}

struct sysfs_ops kobj_sysfs_ops = {
	.show	= kobj_attr_show,
	.store	= kobj_attr_store,
};
L
Linus Torvalds 已提交
733 734 735 736 737 738 739 740

/**
 *	kset_register - initialize and add a kset.
 *	@k:	kset.
 */

int kset_register(struct kset * k)
{
741 742
	int err;

743 744
	if (!k)
		return -EINVAL;
745

L
Linus Torvalds 已提交
746
	kset_init(k);
747
	err = kobject_add_internal(&k->kobj);
748 749 750 751
	if (err)
		return err;
	kobject_uevent(&k->kobj, KOBJ_ADD);
	return 0;
L
Linus Torvalds 已提交
752 753 754 755 756 757 758 759 760 761
}


/**
 *	kset_unregister - remove a kset.
 *	@k:	kset.
 */

void kset_unregister(struct kset * k)
{
762 763
	if (!k)
		return;
L
Linus Torvalds 已提交
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
	kobject_unregister(&k->kobj);
}


/**
 *	kset_find_obj - search for object in kset.
 *	@kset:	kset we're looking in.
 *	@name:	object's name.
 *
 *	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.
 */

struct kobject * kset_find_obj(struct kset * kset, const char * name)
{
	struct list_head * entry;
	struct kobject * ret = NULL;

	spin_lock(&kset->list_lock);
	list_for_each(entry,&kset->list) {
		struct kobject * k = to_kobj(entry);
		if (kobject_name(k) && !strcmp(kobject_name(k),name)) {
			ret = kobject_get(k);
			break;
		}
	}
	spin_unlock(&kset->list_lock);
	return ret;
}

795 796 797
static void kset_release(struct kobject *kobj)
{
	struct kset *kset = container_of(kobj, struct kset, kobj);
798 799
	pr_debug("kobject: '%s' (%p): %s\n",
		 kobject_name(kobj), kobj, __FUNCTION__);
800 801 802
	kfree(kset);
}

803 804
static struct kobj_type kset_ktype = {
	.sysfs_ops	= &kobj_sysfs_ops,
805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836
	.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,
				struct kset_uevent_ops *uevent_ops,
				struct kobject *parent_kobj)
{
	struct kset *kset;

	kset = kzalloc(sizeof(*kset), GFP_KERNEL);
	if (!kset)
		return NULL;
	kobject_set_name(&kset->kobj, name);
	kset->uevent_ops = uevent_ops;
	kset->kobj.parent = parent_kobj;

	/*
837
	 * The kobject of this kset will have a type of kset_ktype and belong to
838 839 840
	 * no kset itself.  That way we can properly free it when it is
	 * finished being used.
	 */
841
	kset->kobj.ktype = &kset_ktype;
842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879
	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,
				 struct kset_uevent_ops *uevent_ops,
				 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);

L
Linus Torvalds 已提交
880 881 882 883 884 885 886
EXPORT_SYMBOL(kobject_unregister);
EXPORT_SYMBOL(kobject_get);
EXPORT_SYMBOL(kobject_put);
EXPORT_SYMBOL(kobject_del);

EXPORT_SYMBOL(kset_register);
EXPORT_SYMBOL(kset_unregister);