2 * SPDX-License-Identifier: BSD-2-Clause
4 * Copyright (c) 2016-2018, Matthew Macy <mmacy@freebsd.org>
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
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.
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
29 #include <sys/cdefs.h>
30 #include <sys/param.h>
31 #include <sys/systm.h>
32 #include <sys/queue.h>
33 #include <sys/blist.h>
36 #include <sys/filedesc.h>
37 #include <sys/kernel.h>
38 #include <sys/linker.h>
39 #include <sys/malloc.h>
40 #include <sys/mount.h>
41 #include <sys/mutex.h>
43 #include <sys/resourcevar.h>
46 #include <sys/socket.h>
47 #include <sys/vnode.h>
49 #include <sys/pciio.h>
51 #include <dev/pci/pcivar.h>
52 #include <dev/pci/pcireg.h>
58 #include <vm/vm_map.h>
59 #include <vm/vm_param.h>
60 #include <vm/vm_object.h>
61 #include <vm/swap_pager.h>
63 #include <machine/bus.h>
65 #include <compat/linux/linux_ioctl.h>
66 #include <compat/linux/linux_mib.h>
67 #include <compat/linux/linux_util.h>
68 #include <fs/pseudofs/pseudofs.h>
70 #include <asm/atomic.h>
71 #include <linux/compat.h>
72 #include <linux/debugfs.h>
75 MALLOC_DEFINE(M_DFSINT, "debugfsint", "Linux debugfs internal");
77 static struct pfs_node *debugfs_root;
79 #define DM_SYMLINK 0x1
84 struct dentry dm_dnode;
85 const struct file_operations *dm_fops;
92 debugfs_attr(PFS_ATTR_ARGS)
94 struct dentry_meta *dm;
98 vap->va_mode = dm->dm_mode;
103 debugfs_destroy(PFS_DESTROY_ARGS)
105 struct dentry_meta *dm;
108 if (dm->dm_type == DM_SYMLINK)
109 free(dm->dm_data, M_DFSINT);
116 debugfs_fill(PFS_FILL_ARGS)
118 struct dentry_meta *d;
119 struct linux_file lf = {};
125 if ((rc = linux_set_current_flags(curthread, M_NOWAIT)))
129 vn.v_data = d->dm_data;
131 rc = d->dm_fops->open(&vn, &lf);
134 printf("%s:%d open failed with %d\n", __FUNCTION__, __LINE__, rc);
140 if (uio->uio_rw == UIO_READ && d->dm_fops->read) {
142 buf = (char *) malloc(sb->s_size, M_DFSINT, M_ZERO | M_NOWAIT);
144 rc = d->dm_fops->read(&lf, buf, sb->s_size, &off);
146 sbuf_bcpy(sb, buf, strlen(buf));
150 } else if (uio->uio_rw == UIO_WRITE && d->dm_fops->write) {
152 rc = d->dm_fops->write(&lf, sbuf_data(sb), sbuf_len(sb), &off);
155 if (d->dm_fops->release)
156 d->dm_fops->release(&vn, &lf);
158 single_release(&vn, &lf);
162 printf("%s:%d read/write failed with %d\n", __FUNCTION__, __LINE__, rc);
170 debugfs_fill_data(PFS_FILL_ARGS)
172 struct dentry_meta *dm;
175 sbuf_printf(sb, "%s", (char *)dm->dm_data);
180 debugfs_create_file(const char *name, umode_t mode,
181 struct dentry *parent, void *data,
182 const struct file_operations *fops)
184 struct dentry_meta *dm;
185 struct dentry *dnode;
186 struct pfs_node *pnode;
189 dm = malloc(sizeof(*dm), M_DFSINT, M_NOWAIT | M_ZERO);
192 dnode = &dm->dm_dnode;
196 dm->dm_type = DM_FILE;
198 pnode = parent->d_pfs_node;
200 pnode = debugfs_root;
202 flags = fops->write ? PFS_RDWR : PFS_RD;
203 dnode->d_pfs_node = pfs_create_file(pnode, name, debugfs_fill,
204 debugfs_attr, NULL, debugfs_destroy, flags | PFS_NOWAIT);
205 if (dnode->d_pfs_node == NULL) {
209 dnode->d_pfs_node->pn_data = dm;
215 debugfs_create_file_size(const char *name, umode_t mode,
216 struct dentry *parent, void *data,
217 const struct file_operations *fops,
218 loff_t file_size __unused)
221 return debugfs_create_file(name, mode, parent, data, fops);
225 * NOTE: Files created with the _unsafe moniker will not be protected from
226 * debugfs core file removals. It is the responsibility of @fops to protect
227 * its file using debugfs_file_get() and debugfs_file_put().
229 * FreeBSD's LinuxKPI lindebugfs does not perform file removals at the time
230 * of writing. Therefore there is no difference between functions with _unsafe
231 * and functions without _unsafe when using lindebugfs. Functions with _unsafe
232 * exist only for Linux compatibility.
235 debugfs_create_file_unsafe(const char *name, umode_t mode,
236 struct dentry *parent, void *data,
237 const struct file_operations *fops)
240 return (debugfs_create_file(name, mode, parent, data, fops));
244 debugfs_create_mode_unsafe(const char *name, umode_t mode,
245 struct dentry *parent, void *data,
246 const struct file_operations *fops,
247 const struct file_operations *fops_ro,
248 const struct file_operations *fops_wo)
250 umode_t read = mode & S_IRUGO;
251 umode_t write = mode & S_IWUGO;
254 return (debugfs_create_file_unsafe(name, mode, parent, data, fops_ro));
257 return (debugfs_create_file_unsafe(name, mode, parent, data, fops_wo));
259 return (debugfs_create_file_unsafe(name, mode, parent, data, fops));
263 debugfs_create_dir(const char *name, struct dentry *parent)
265 struct dentry_meta *dm;
266 struct dentry *dnode;
267 struct pfs_node *pnode;
269 dm = malloc(sizeof(*dm), M_DFSINT, M_NOWAIT | M_ZERO);
272 dnode = &dm->dm_dnode;
274 dm->dm_type = DM_DIR;
276 pnode = parent->d_pfs_node;
278 pnode = debugfs_root;
280 dnode->d_pfs_node = pfs_create_dir(pnode, name, debugfs_attr, NULL, debugfs_destroy, PFS_RD | PFS_NOWAIT);
281 if (dnode->d_pfs_node == NULL) {
285 dnode->d_pfs_node->pn_data = dm;
290 debugfs_create_symlink(const char *name, struct dentry *parent,
293 struct dentry_meta *dm;
294 struct dentry *dnode;
295 struct pfs_node *pnode;
298 data = strdup_flags(dest, M_DFSINT, M_NOWAIT);
301 dm = malloc(sizeof(*dm), M_DFSINT, M_NOWAIT | M_ZERO);
304 dnode = &dm->dm_dnode;
306 dm->dm_type = DM_SYMLINK;
309 pnode = parent->d_pfs_node;
311 pnode = debugfs_root;
313 dnode->d_pfs_node = pfs_create_link(pnode, name, &debugfs_fill_data, NULL, NULL, NULL, PFS_NOWAIT);
314 if (dnode->d_pfs_node == NULL)
316 dnode->d_pfs_node->pn_data = dm;
321 free(data, M_DFSINT);
326 debugfs_remove(struct dentry *dnode)
331 pfs_destroy(dnode->d_pfs_node);
335 debugfs_remove_recursive(struct dentry *dnode)
340 pfs_destroy(dnode->d_pfs_node);
344 debugfs_bool_get(void *data, uint64_t *ullval)
357 debugfs_bool_set(void *data, uint64_t ullval)
369 DEFINE_DEBUGFS_ATTRIBUTE(fops_bool, debugfs_bool_get, debugfs_bool_set, "%llu\n");
370 DEFINE_DEBUGFS_ATTRIBUTE(fops_bool_ro, debugfs_bool_get, NULL, "%llu\n");
371 DEFINE_DEBUGFS_ATTRIBUTE(fops_bool_wo, NULL, debugfs_bool_set, "%llu\n");
374 debugfs_create_bool(const char *name, umode_t mode, struct dentry *parent, bool *value)
377 debugfs_create_mode_unsafe(name, mode, parent, value, &fops_bool,
378 &fops_bool_ro, &fops_bool_wo);
383 debugfs_u8_get(void *data, uint64_t *value)
385 uint8_t *u8data = data;
391 debugfs_u8_set(void *data, uint64_t value)
393 uint8_t *u8data = data;
394 *u8data = (uint8_t)value;
398 DEFINE_DEBUGFS_ATTRIBUTE(fops_u8, debugfs_u8_get, debugfs_u8_set, "%u\n");
399 DEFINE_DEBUGFS_ATTRIBUTE(fops_u8_ro, debugfs_u8_get, NULL, "%u\n");
400 DEFINE_DEBUGFS_ATTRIBUTE(fops_u8_wo, NULL, debugfs_u8_set, "%u\n");
403 debugfs_create_u8(const char *name, umode_t mode, struct dentry *parent, uint8_t *value)
406 debugfs_create_mode_unsafe(name, mode, parent, value, &fops_u8,
407 &fops_u8_ro, &fops_u8_wo);
410 DEFINE_DEBUGFS_ATTRIBUTE(fops_x8, debugfs_u8_get, debugfs_u8_set, "0x%016llx\n");
411 DEFINE_DEBUGFS_ATTRIBUTE(fops_x8_ro, debugfs_u8_get, NULL, "0x%016llx\n");
412 DEFINE_DEBUGFS_ATTRIBUTE(fops_x8_wo, NULL, debugfs_u8_set, "0x%016llx\n");
415 debugfs_create_x8(const char *name, umode_t mode, struct dentry *parent, uint8_t *value)
418 debugfs_create_mode_unsafe(name, mode, parent, value, &fops_x8,
419 &fops_x8_ro, &fops_x8_wo);
424 debugfs_u16_get(void *data, uint64_t *value)
426 uint16_t *u16data = data;
432 debugfs_u16_set(void *data, uint64_t value)
434 uint16_t *u16data = data;
435 *u16data = (uint16_t)value;
439 DEFINE_DEBUGFS_ATTRIBUTE(fops_u16, debugfs_u16_get, debugfs_u16_set, "%u\n");
440 DEFINE_DEBUGFS_ATTRIBUTE(fops_u16_ro, debugfs_u16_get, NULL, "%u\n");
441 DEFINE_DEBUGFS_ATTRIBUTE(fops_u16_wo, NULL, debugfs_u16_set, "%u\n");
444 debugfs_create_u16(const char *name, umode_t mode, struct dentry *parent, uint16_t *value)
447 debugfs_create_mode_unsafe(name, mode, parent, value, &fops_u16,
448 &fops_u16_ro, &fops_u16_wo);
451 DEFINE_DEBUGFS_ATTRIBUTE(fops_x16, debugfs_u16_get, debugfs_u16_set, "0x%016llx\n");
452 DEFINE_DEBUGFS_ATTRIBUTE(fops_x16_ro, debugfs_u16_get, NULL, "0x%016llx\n");
453 DEFINE_DEBUGFS_ATTRIBUTE(fops_x16_wo, NULL, debugfs_u16_set, "0x%016llx\n");
456 debugfs_create_x16(const char *name, umode_t mode, struct dentry *parent, uint16_t *value)
459 debugfs_create_mode_unsafe(name, mode, parent, value, &fops_x16,
460 &fops_x16_ro, &fops_x16_wo);
465 debugfs_u32_get(void *data, uint64_t *value)
467 uint32_t *u32data = data;
473 debugfs_u32_set(void *data, uint64_t value)
475 uint32_t *u32data = data;
476 *u32data = (uint32_t)value;
480 DEFINE_DEBUGFS_ATTRIBUTE(fops_u32, debugfs_u32_get, debugfs_u32_set, "%u\n");
481 DEFINE_DEBUGFS_ATTRIBUTE(fops_u32_ro, debugfs_u32_get, NULL, "%u\n");
482 DEFINE_DEBUGFS_ATTRIBUTE(fops_u32_wo, NULL, debugfs_u32_set, "%u\n");
485 debugfs_create_u32(const char *name, umode_t mode, struct dentry *parent, uint32_t *value)
488 debugfs_create_mode_unsafe(name, mode, parent, value, &fops_u32,
489 &fops_u32_ro, &fops_u32_wo);
492 DEFINE_DEBUGFS_ATTRIBUTE(fops_x32, debugfs_u32_get, debugfs_u32_set, "0x%016llx\n");
493 DEFINE_DEBUGFS_ATTRIBUTE(fops_x32_ro, debugfs_u32_get, NULL, "0x%016llx\n");
494 DEFINE_DEBUGFS_ATTRIBUTE(fops_x32_wo, NULL, debugfs_u32_set, "0x%016llx\n");
497 debugfs_create_x32(const char *name, umode_t mode, struct dentry *parent, uint32_t *value)
500 debugfs_create_mode_unsafe(name, mode, parent, value, &fops_x32,
501 &fops_x32_ro, &fops_x32_wo);
506 debugfs_u64_get(void *data, uint64_t *value)
508 uint64_t *u64data = data;
514 debugfs_u64_set(void *data, uint64_t value)
516 uint64_t *u64data = data;
517 *u64data = (uint64_t)value;
521 DEFINE_DEBUGFS_ATTRIBUTE(fops_u64, debugfs_u64_get, debugfs_u64_set, "%u\n");
522 DEFINE_DEBUGFS_ATTRIBUTE(fops_u64_ro, debugfs_u64_get, NULL, "%u\n");
523 DEFINE_DEBUGFS_ATTRIBUTE(fops_u64_wo, NULL, debugfs_u64_set, "%u\n");
526 debugfs_create_u64(const char *name, umode_t mode, struct dentry *parent, uint64_t *value)
529 debugfs_create_mode_unsafe(name, mode, parent, value, &fops_u64,
530 &fops_u64_ro, &fops_u64_wo);
533 DEFINE_DEBUGFS_ATTRIBUTE(fops_x64, debugfs_u64_get, debugfs_u64_set, "0x%016llx\n");
534 DEFINE_DEBUGFS_ATTRIBUTE(fops_x64_ro, debugfs_u64_get, NULL, "0x%016llx\n");
535 DEFINE_DEBUGFS_ATTRIBUTE(fops_x64_wo, NULL, debugfs_u64_set, "0x%016llx\n");
538 debugfs_create_x64(const char *name, umode_t mode, struct dentry *parent, uint64_t *value)
541 debugfs_create_mode_unsafe(name, mode, parent, value, &fops_x64,
542 &fops_x64_ro, &fops_x64_wo);
547 debugfs_ulong_get(void *data, uint64_t *value)
549 uint64_t *uldata = data;
555 debugfs_ulong_set(void *data, uint64_t value)
557 uint64_t *uldata = data;
562 DEFINE_DEBUGFS_ATTRIBUTE(fops_ulong, debugfs_ulong_get, debugfs_ulong_set, "%llu\n");
563 DEFINE_DEBUGFS_ATTRIBUTE(fops_ulong_ro, debugfs_ulong_get, NULL, "%llu\n");
564 DEFINE_DEBUGFS_ATTRIBUTE(fops_ulong_wo, NULL, debugfs_ulong_set, "%llu\n");
567 debugfs_create_ulong(const char *name, umode_t mode, struct dentry *parent, unsigned long *value)
570 debugfs_create_mode_unsafe(name, mode, parent, value, &fops_ulong,
571 &fops_ulong_ro, &fops_ulong_wo);
576 debugfs_atomic_t_get(void *data, uint64_t *value)
578 atomic_t *atomic_data = data;
579 *value = atomic_read(atomic_data);
584 debugfs_atomic_t_set(void *data, uint64_t value)
586 atomic_t *atomic_data = data;
587 atomic_set(atomic_data, (int)value);
591 DEFINE_DEBUGFS_ATTRIBUTE(fops_atomic_t, debugfs_atomic_t_get, debugfs_atomic_t_set, "%d\n");
592 DEFINE_DEBUGFS_ATTRIBUTE(fops_atomic_t_ro, debugfs_atomic_t_get, NULL, "%d\n");
593 DEFINE_DEBUGFS_ATTRIBUTE(fops_atomic_t_wo, NULL, debugfs_atomic_t_set, "%d\n");
596 debugfs_create_atomic_t(const char *name, umode_t mode, struct dentry *parent, atomic_t *value)
599 debugfs_create_mode_unsafe(name, mode, parent, value, &fops_atomic_t,
600 &fops_atomic_t_ro, &fops_atomic_t_wo);
605 fops_blob_read(struct file *filp, char __user *ubuf, size_t read_size, loff_t *ppos)
607 struct debugfs_blob_wrapper *blob;
609 blob = filp->private_data;
612 if (blob->size == 0 || blob->data == NULL)
615 return (simple_read_from_buffer(ubuf, read_size, ppos, blob->data, blob->size));
619 fops_blob_open(struct inode *inode, struct file *filp)
622 return (simple_open(inode, filp));
625 static const struct file_operations __fops_blob_ro = {
626 .owner = THIS_MODULE,
627 .open = fops_blob_open,
628 .read = fops_blob_read,
633 debugfs_create_blob(const char *name, umode_t mode, struct dentry *parent,
634 struct debugfs_blob_wrapper *value)
636 /* Blobs are read-only. */
637 return (debugfs_create_file(name, mode & 0444, parent, value, &__fops_blob_ro));
642 lindebugfs_init(PFS_INIT_ARGS)
645 debugfs_root = pi->pi_root;
647 (void)debugfs_create_symlink("kcov", NULL, "/dev/kcov");
653 lindebugfs_uninit(PFS_INIT_ARGS)
659 PSEUDOFS(lindebugfs, 1, VFCF_JAIL);
660 MODULE_DEPEND(lindebugfs, linuxkpi, 1, 1, 1);