1 /*-
2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3 *
4 * Copyright (c) 2016-2018, Matthew Macy <mmacy@freebsd.org>
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 * SUCH DAMAGE.
26 *
27 */
28
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
31
32 #include <sys/param.h>
33 #include <sys/systm.h>
34 #include <sys/queue.h>
35 #include <sys/blist.h>
36 #include <sys/conf.h>
37 #include <sys/exec.h>
38 #include <sys/filedesc.h>
39 #include <sys/kernel.h>
40 #include <sys/linker.h>
41 #include <sys/malloc.h>
42 #include <sys/mount.h>
43 #include <sys/mutex.h>
44 #include <sys/proc.h>
45 #include <sys/resourcevar.h>
46 #include <sys/sbuf.h>
47 #include <sys/smp.h>
48 #include <sys/socket.h>
49 #include <sys/vnode.h>
50 #include <sys/bus.h>
51 #include <sys/pciio.h>
52
53 #include <dev/pci/pcivar.h>
54 #include <dev/pci/pcireg.h>
55
56 #include <net/if.h>
57
58 #include <vm/vm.h>
59 #include <vm/pmap.h>
60 #include <vm/vm_map.h>
61 #include <vm/vm_param.h>
62 #include <vm/vm_object.h>
63 #include <vm/swap_pager.h>
64
65 #include <machine/bus.h>
66
67 #include <compat/linux/linux_ioctl.h>
68 #include <compat/linux/linux_mib.h>
69 #include <compat/linux/linux_util.h>
70 #include <fs/pseudofs/pseudofs.h>
71
72 #include <linux/debugfs.h>
73 #include <linux/seq_file.h>
74 #include <linux/compat.h>
75
76 MALLOC_DEFINE(M_DFSINT, "debugfsint", "Linux debugfs internal");
77
78 static struct pfs_node *debugfs_root;
79
80 #define DM_SYMLINK 0x1
81 #define DM_DIR 0x2
82 #define DM_FILE 0x3
83
84 struct dentry_meta {
85 struct dentry dm_dnode;
86 const struct file_operations *dm_fops;
87 void *dm_data;
88 umode_t dm_mode;
89 int dm_type;
90 };
91
92 static int
93 debugfs_attr(PFS_ATTR_ARGS)
94 {
95 struct dentry_meta *dm;
96
97 dm = pn->pn_data;
98
99 vap->va_mode = dm->dm_mode;
100 return (0);
101 }
102
103 static int
104 debugfs_destroy(PFS_DESTROY_ARGS)
105 {
106 struct dentry_meta *dm;
107
108 dm = pn->pn_data;
109 if (dm->dm_type == DM_SYMLINK)
110 free(dm->dm_data, M_DFSINT);
111
112 free(dm, M_DFSINT);
113 return (0);
114 }
115
116 static int
117 debugfs_fill(PFS_FILL_ARGS)
118 {
119 struct dentry_meta *d;
120 struct linux_file lf;
121 struct seq_file *sf;
122 struct vnode vn;
123 void *buf;
124 int rc;
125 size_t len;
126 off_t off;
127
128 d = pn->pn_data;
129
130 if ((rc = linux_set_current_flags(curthread, M_NOWAIT)))
131 return (rc);
132 vn.v_data = d->dm_data;
133 buf = uio->uio_iov[0].iov_base;
134 len = min(uio->uio_iov[0].iov_len, uio->uio_resid);
135 off = 0;
136 lf.private_data = NULL;
137 rc = d->dm_fops->open(&vn, &lf);
138 if (rc < 0) {
139 #ifdef INVARIANTS
140 printf("%s:%d open failed with %d\n", __FUNCTION__, __LINE__, rc);
141 #endif
142 return (-rc);
143 }
144 sf = lf.private_data;
145 sf->buf = sb;
146 if (uio->uio_rw == UIO_READ)
147 rc = d->dm_fops->read(&lf, NULL, len, &off);
148 else
149 rc = d->dm_fops->write(&lf, buf, len, &off);
150 if (d->dm_fops->release)
151 d->dm_fops->release(&vn, &lf);
152 else
153 single_release(&vn, &lf);
154
155 if (rc < 0) {
156 #ifdef INVARIANTS
157 printf("%s:%d read/write failed with %d\n", __FUNCTION__, __LINE__, rc);
158 #endif
159 return (-rc);
160 }
161 return (0);
162 }
163
164 static int
165 debugfs_fill_data(PFS_FILL_ARGS)
166 {
167 struct dentry_meta *dm;
168
169 dm = pn->pn_data;
170 sbuf_printf(sb, "%s", (char *)dm->dm_data);
171 return (0);
172 }
173
174 struct dentry *
175 debugfs_create_file(const char *name, umode_t mode,
176 struct dentry *parent, void *data,
177 const struct file_operations *fops)
178 {
179 struct dentry_meta *dm;
180 struct dentry *dnode;
181 struct pfs_node *pnode;
182 int flags;
183
184 dm = malloc(sizeof(*dm), M_DFSINT, M_NOWAIT | M_ZERO);
185 if (dm == NULL)
186 return (NULL);
187 dnode = &dm->dm_dnode;
188 dm->dm_fops = fops;
189 dm->dm_data = data;
190 dm->dm_mode = mode;
191 dm->dm_type = DM_FILE;
192 if (parent != NULL)
193 pnode = parent->d_pfs_node;
194 else
195 pnode = debugfs_root;
196
197 flags = fops->write ? PFS_RDWR : PFS_RD;
198 dnode->d_pfs_node = pfs_create_file(pnode, name, debugfs_fill,
199 debugfs_attr, NULL, debugfs_destroy, flags | PFS_NOWAIT);
200 if (dnode->d_pfs_node == NULL) {
201 free(dm, M_DFSINT);
202 return (NULL);
203 }
204 dnode->d_pfs_node->pn_data = dm;
205
206 return (dnode);
207 }
208
209 struct dentry *
210 debugfs_create_dir(const char *name, struct dentry *parent)
211 {
212 struct dentry_meta *dm;
213 struct dentry *dnode;
214 struct pfs_node *pnode;
215
216 dm = malloc(sizeof(*dm), M_DFSINT, M_NOWAIT | M_ZERO);
217 if (dm == NULL)
218 return (NULL);
219 dnode = &dm->dm_dnode;
220 dm->dm_mode = 0700;
221 dm->dm_type = DM_DIR;
222 if (parent != NULL)
223 pnode = parent->d_pfs_node;
224 else
225 pnode = debugfs_root;
226
227 dnode->d_pfs_node = pfs_create_dir(pnode, name, debugfs_attr, NULL, debugfs_destroy, PFS_RD | PFS_NOWAIT);
228 if (dnode->d_pfs_node == NULL) {
229 free(dm, M_DFSINT);
230 return (NULL);
231 }
232 dnode->d_pfs_node->pn_data = dm;
233 return (dnode);
234 }
235
236 struct dentry *
237 debugfs_create_symlink(const char *name, struct dentry *parent,
238 const char *dest)
239 {
240 struct dentry_meta *dm;
241 struct dentry *dnode;
242 struct pfs_node *pnode;
243 void *data;
244
245 data = strdup_flags(dest, M_DFSINT, M_NOWAIT);
246 if (data == NULL)
247 return (NULL);
248 dm = malloc(sizeof(*dm), M_DFSINT, M_NOWAIT | M_ZERO);
249 if (dm == NULL)
250 goto fail1;
251 dnode = &dm->dm_dnode;
252 dm->dm_mode = 0700;
253 dm->dm_type = DM_SYMLINK;
254 dm->dm_data = data;
255 if (parent != NULL)
256 pnode = parent->d_pfs_node;
257 else
258 pnode = debugfs_root;
259
260 dnode->d_pfs_node = pfs_create_link(pnode, name, &debugfs_fill_data, NULL, NULL, NULL, PFS_NOWAIT);
261 if (dnode->d_pfs_node == NULL)
262 goto fail;
263 dnode->d_pfs_node->pn_data = dm;
264 return (dnode);
265 fail:
266 free(dm, M_DFSINT);
267 fail1:
268 free(data, M_DFSINT);
269 return (NULL);
270 }
271
272 void
273 debugfs_remove(struct dentry *dnode)
274 {
275 if (dnode == NULL)
276 return;
277
278 pfs_destroy(dnode->d_pfs_node);
279 }
280
281 void
282 debugfs_remove_recursive(struct dentry *dnode)
283 {
284 if (dnode == NULL)
285 return;
286
287 pfs_destroy(dnode->d_pfs_node);
288 }
289
290
291 static int
292 debugfs_init(PFS_INIT_ARGS)
293 {
294
295 debugfs_root = pi->pi_root;
296 return (0);
297 }
298
299 static int
300 debugfs_uninit(PFS_INIT_ARGS)
301 {
302 return (0);
303 }
304
305 #ifdef PR_ALLOW_MOUNT_LINSYSFS
306 PSEUDOFS(debugfs, 1, PR_ALLOW_MOUNT_LINSYSFS);
307 #else
308 PSEUDOFS(debugfs, 1, VFCF_JAIL);
309 #endif
Cache object: 63fb77a0c7566f64b7099caefdab6d08
|