1/*-
2 * Copyright (c) 2010 Isilon Systems, Inc.
3 * Copyright (c) 2010 iX Systems, Inc.
4 * Copyright (c) 2010 Panasas, Inc.
5 * Copyright (c) 2013, 2014 Mellanox Technologies, Ltd.
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 *    notice unmodified, this list of conditions, and the following
13 *    disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 *    notice, this list of conditions and the following disclaimer in the
16 *    documentation and/or other materials provided with the distribution.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */
29#ifndef	_LINUX_KOBJECT_H_
30#define	_LINUX_KOBJECT_H_
31
32#include <machine/stdarg.h>
33
34#include <linux/kernel.h>
35#include <linux/kref.h>
36#include <linux/slab.h>
37
38struct kobject;
39struct sysctl_oid;
40
41struct kobj_type {
42	void (*release)(struct kobject *kobj);
43	const struct sysfs_ops *sysfs_ops;
44	struct attribute **default_attrs;
45};
46
47extern struct kobj_type kfree_type;
48
49struct kobject {
50	struct kobject		*parent;
51	char			*name;
52	struct kref		kref;
53	struct kobj_type	*ktype;
54	struct list_head	entry;
55	struct sysctl_oid	*oidp;
56};
57
58extern struct kobject *mm_kobj;
59
60static inline void
61kobject_init(struct kobject *kobj, struct kobj_type *ktype)
62{
63
64	kref_init(&kobj->kref);
65	INIT_LIST_HEAD(&kobj->entry);
66	kobj->ktype = ktype;
67	kobj->oidp = NULL;
68}
69
70static inline void kobject_put(struct kobject *kobj);
71void kobject_release(struct kref *kref);
72
73static inline void
74kobject_put(struct kobject *kobj)
75{
76
77	if (kobj)
78		kref_put(&kobj->kref, kobject_release);
79}
80
81static inline struct kobject *
82kobject_get(struct kobject *kobj)
83{
84
85	if (kobj)
86		kref_get(&kobj->kref);
87	return kobj;
88}
89
90int	kobject_set_name_vargs(struct kobject *kobj, const char *fmt, va_list);
91int	kobject_add(struct kobject *kobj, struct kobject *parent,
92	    const char *fmt, ...);
93
94static inline struct kobject *
95kobject_create(void)
96{
97	struct kobject *kobj;
98
99	kobj = kzalloc(sizeof(*kobj), GFP_KERNEL);
100	if (kobj == NULL)
101		return (NULL);
102	kobject_init(kobj, &kfree_type);
103
104	return (kobj);
105}
106
107static inline struct kobject *
108kobject_create_and_add(const char *name, struct kobject *parent)
109{
110	struct kobject *kobj;
111
112	kobj = kobject_create();
113	if (kobj == NULL)
114		return (NULL);
115	if (kobject_add(kobj, parent, "%s", name) == 0)
116		return (kobj);
117	kobject_put(kobj);
118
119	return (NULL);
120}
121
122
123static inline char *
124kobject_name(const struct kobject *kobj)
125{
126
127	return kobj->name;
128}
129
130int	kobject_set_name(struct kobject *kobj, const char *fmt, ...);
131int	kobject_init_and_add(struct kobject *kobj, struct kobj_type *ktype,
132	    struct kobject *parent, const char *fmt, ...);
133
134/* sysfs.h calles for 'kobject' which is defined here,
135 * so we need to add the include only after the 'kobject' def.
136 */
137#include <linux/sysfs.h>
138
139struct kobj_attribute {
140        struct attribute attr;
141        ssize_t (*show)(struct kobject *kobj, struct kobj_attribute *attr,
142                        char *buf);
143        ssize_t (*store)(struct kobject *kobj, struct kobj_attribute *attr,
144                         const char *buf, size_t count);
145};
146
147#endif /* _LINUX_KOBJECT_H_ */
148