xref: /freebsd/sys/compat/linuxkpi/common/include/linux/kobject.h (revision 895f86f15fbf6540071feb9328c3c50ed1f027b8)
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  * $FreeBSD$
30  */
31 #ifndef	_LINUX_KOBJECT_H_
32 #define	_LINUX_KOBJECT_H_
33 
34 #include <machine/stdarg.h>
35 
36 #include <linux/kernel.h>
37 #include <linux/kref.h>
38 #include <linux/slab.h>
39 
40 struct kobject;
41 struct sysctl_oid;
42 
43 struct kobj_type {
44 	void (*release)(struct kobject *kobj);
45 	const struct sysfs_ops *sysfs_ops;
46 	struct attribute **default_attrs;
47 };
48 
49 extern struct kobj_type kfree_type;
50 
51 struct kobject {
52 	struct kobject		*parent;
53 	char			*name;
54 	struct kref		kref;
55 	struct kobj_type	*ktype;
56 	struct list_head	entry;
57 	struct sysctl_oid	*oidp;
58 };
59 
60 extern struct kobject *mm_kobj;
61 
62 struct attribute {
63 	const char 	*name;
64 	struct module	*owner;
65 	mode_t		mode;
66 };
67 
68 struct kobj_attribute {
69         struct attribute attr;
70         ssize_t (*show)(struct kobject *kobj, struct kobj_attribute *attr,
71                         char *buf);
72         ssize_t (*store)(struct kobject *kobj, struct kobj_attribute *attr,
73                          const char *buf, size_t count);
74 };
75 
76 static inline void
77 kobject_init(struct kobject *kobj, struct kobj_type *ktype)
78 {
79 
80 	kref_init(&kobj->kref);
81 	INIT_LIST_HEAD(&kobj->entry);
82 	kobj->ktype = ktype;
83 	kobj->oidp = NULL;
84 }
85 
86 static inline void kobject_put(struct kobject *kobj);
87 void kobject_release(struct kref *kref);
88 
89 static inline void
90 kobject_put(struct kobject *kobj)
91 {
92 
93 	if (kobj)
94 		kref_put(&kobj->kref, kobject_release);
95 }
96 
97 static inline struct kobject *
98 kobject_get(struct kobject *kobj)
99 {
100 
101 	if (kobj)
102 		kref_get(&kobj->kref);
103 	return kobj;
104 }
105 
106 static inline int
107 kobject_set_name_vargs(struct kobject *kobj, const char *fmt, va_list args)
108 {
109 	char *old;
110 	char *name;
111 
112 	old = kobj->name;
113 
114 	if (old && !fmt)
115 		return 0;
116 
117 	name = kzalloc(MAXPATHLEN, GFP_KERNEL);
118 	if (!name)
119 		return -ENOMEM;
120 	vsnprintf(name, MAXPATHLEN, fmt, args);
121 	kobj->name = name;
122 	kfree(old);
123 	for (; *name != '\0'; name++)
124 		if (*name == '/')
125 			*name = '!';
126 	return (0);
127 }
128 
129 int	kobject_add(struct kobject *kobj, struct kobject *parent,
130 	    const char *fmt, ...);
131 
132 static inline struct kobject *
133 kobject_create(void)
134 {
135 	struct kobject *kobj;
136 
137 	kobj = kzalloc(sizeof(*kobj), GFP_KERNEL);
138 	if (kobj == NULL)
139 		return (NULL);
140 	kobject_init(kobj, &kfree_type);
141 
142 	return (kobj);
143 }
144 
145 static inline struct kobject *
146 kobject_create_and_add(const char *name, struct kobject *parent)
147 {
148 	struct kobject *kobj;
149 
150 	kobj = kobject_create();
151 	if (kobj == NULL)
152 		return (NULL);
153 	if (kobject_add(kobj, parent, "%s", name) == 0)
154 		return (kobj);
155 	kobject_put(kobj);
156 
157 	return (NULL);
158 }
159 
160 
161 static inline char *
162 kobject_name(const struct kobject *kobj)
163 {
164 
165 	return kobj->name;
166 }
167 
168 int	kobject_set_name(struct kobject *kobj, const char *fmt, ...);
169 int	kobject_init_and_add(struct kobject *kobj, struct kobj_type *ktype,
170 	    struct kobject *parent, const char *fmt, ...);
171 
172 #endif /* _LINUX_KOBJECT_H_ */
173