Path: blob/main/sys/compat/lindebugfs/lindebugfs.c
106139 views
/*-1* SPDX-License-Identifier: BSD-2-Clause2*3* Copyright (c) 2016-2018, Matthew Macy <[email protected]>4*5* Redistribution and use in source and binary forms, with or without6* modification, are permitted provided that the following conditions7* are met:8* 1. Redistributions of source code must retain the above copyright9* notice, this list of conditions and the following disclaimer.10* 2. Redistributions in binary form must reproduce the above copyright11* notice, this list of conditions and the following disclaimer in the12* documentation and/or other materials provided with the distribution.13*14* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND15* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE16* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE17* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE18* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL19* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS20* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)21* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT22* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY23* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF24* SUCH DAMAGE.25*26*/2728#include <sys/param.h>29#include <sys/systm.h>30#include <sys/queue.h>31#include <sys/blist.h>32#include <sys/conf.h>33#include <sys/exec.h>34#include <sys/filedesc.h>35#include <sys/kernel.h>36#include <sys/linker.h>37#include <sys/malloc.h>38#include <sys/mount.h>39#include <sys/mutex.h>40#include <sys/proc.h>41#include <sys/resourcevar.h>42#include <sys/sbuf.h>43#include <sys/smp.h>44#include <sys/socket.h>45#include <sys/vnode.h>46#include <sys/bus.h>47#include <sys/pciio.h>4849#include <dev/pci/pcivar.h>50#include <dev/pci/pcireg.h>5152#include <net/if.h>5354#include <vm/vm.h>55#include <vm/pmap.h>56#include <vm/vm_map.h>57#include <vm/vm_param.h>58#include <vm/vm_object.h>59#include <vm/swap_pager.h>6061#include <machine/bus.h>6263#include <compat/linux/linux_ioctl.h>64#include <compat/linux/linux_mib.h>65#include <compat/linux/linux_util.h>66#include <fs/pseudofs/pseudofs.h>6768#include <asm/atomic.h>69#include <linux/compat.h>70#include <linux/debugfs.h>71#include <linux/fs.h>7273MALLOC_DEFINE(M_DFSINT, "debugfsint", "Linux debugfs internal");7475static struct pfs_node *debugfs_root;7677#define DM_SYMLINK 0x178#define DM_DIR 0x279#define DM_FILE 0x38081struct dentry_meta {82struct dentry dm_dnode;83const struct file_operations *dm_fops;84void *dm_data;85umode_t dm_mode;86int dm_type;87};8889static int90debugfs_attr(PFS_ATTR_ARGS)91{92struct dentry_meta *dm;9394dm = pn->pn_data;9596vap->va_mode = dm->dm_mode;97return (0);98}99100static int101debugfs_destroy(PFS_DESTROY_ARGS)102{103struct dentry_meta *dm;104105dm = pn->pn_data;106if (dm != NULL && dm->dm_type == DM_SYMLINK)107free(dm->dm_data, M_DFSINT);108109free(dm, M_DFSINT);110return (0);111}112113static int114debugfs_fill(PFS_FILL_ARGS)115{116struct dentry_meta *d;117struct linux_file lf = {};118struct vnode vn;119char *buf;120int rc;121off_t off = 0;122123if ((rc = linux_set_current_flags(curthread, M_NOWAIT)))124return (rc);125126d = pn->pn_data;127vn.v_data = d->dm_data;128129rc = d->dm_fops->open(&vn, &lf);130if (rc < 0) {131#ifdef INVARIANTS132printf("%s:%d open failed with %d\n", __func__, __LINE__, rc);133#endif134return (-rc);135}136137rc = -ENODEV;138switch (uio->uio_rw) {139case UIO_READ:140if (d->dm_fops->read != NULL) {141rc = -ENOMEM;142buf = malloc(sb->s_size, M_DFSINT, M_ZERO | M_NOWAIT);143if (buf != NULL) {144rc = d->dm_fops->read(&lf, buf, sb->s_size,145&off);146if (rc > 0)147sbuf_bcpy(sb, buf, strlen(buf));148149free(buf, M_DFSINT);150}151}152break;153case UIO_WRITE:154if (d->dm_fops->write != NULL) {155sbuf_finish(sb);156rc = d->dm_fops->write(&lf, sbuf_data(sb), sbuf_len(sb),157&off);158}159break;160}161162if (d->dm_fops->release)163d->dm_fops->release(&vn, &lf);164165if (rc < 0) {166#ifdef INVARIANTS167printf("%s:%d read/write failed with %d\n", __func__, __LINE__, rc);168#endif169return (-rc);170}171return (0);172}173174static int175debugfs_fill_data(PFS_FILL_ARGS)176{177struct dentry_meta *dm;178179dm = pn->pn_data;180sbuf_printf(sb, "%s", (char *)dm->dm_data);181return (0);182}183184struct dentry *185debugfs_create_file(const char *name, umode_t mode,186struct dentry *parent, void *data,187const struct file_operations *fops)188{189struct dentry_meta *dm;190struct dentry *dnode;191struct pfs_node *pnode;192int flags;193194dm = malloc(sizeof(*dm), M_DFSINT, M_NOWAIT | M_ZERO);195if (dm == NULL)196return (NULL);197dnode = &dm->dm_dnode;198dm->dm_fops = fops;199dm->dm_data = data;200dm->dm_mode = mode;201dm->dm_type = DM_FILE;202if (parent != NULL)203pnode = parent->d_pfs_node;204else205pnode = debugfs_root;206207flags = fops->write ? PFS_RDWR : PFS_RD;208pfs_create_file(pnode, &dnode->d_pfs_node, name, debugfs_fill,209debugfs_attr, NULL, debugfs_destroy, flags | PFS_NOWAIT);210if (dnode->d_pfs_node == NULL) {211free(dm, M_DFSINT);212return (NULL);213}214dnode->d_pfs_node->pn_data = dm;215216return (dnode);217}218219struct dentry *220debugfs_create_file_size(const char *name, umode_t mode,221struct dentry *parent, void *data,222const struct file_operations *fops,223loff_t file_size __unused)224{225226return debugfs_create_file(name, mode, parent, data, fops);227}228229/*230* NOTE: Files created with the _unsafe moniker will not be protected from231* debugfs core file removals. It is the responsibility of @fops to protect232* its file using debugfs_file_get() and debugfs_file_put().233*234* FreeBSD's LinuxKPI lindebugfs does not perform file removals at the time235* of writing. Therefore there is no difference between functions with _unsafe236* and functions without _unsafe when using lindebugfs. Functions with _unsafe237* exist only for Linux compatibility.238*/239struct dentry *240debugfs_create_file_unsafe(const char *name, umode_t mode,241struct dentry *parent, void *data,242const struct file_operations *fops)243{244245return (debugfs_create_file(name, mode, parent, data, fops));246}247248struct dentry *249debugfs_create_mode_unsafe(const char *name, umode_t mode,250struct dentry *parent, void *data,251const struct file_operations *fops,252const struct file_operations *fops_ro,253const struct file_operations *fops_wo)254{255umode_t read = mode & S_IRUGO;256umode_t write = mode & S_IWUGO;257258if (read && !write)259return (debugfs_create_file_unsafe(name, mode, parent, data, fops_ro));260261if (write && !read)262return (debugfs_create_file_unsafe(name, mode, parent, data, fops_wo));263264return (debugfs_create_file_unsafe(name, mode, parent, data, fops));265}266267struct dentry *268debugfs_create_dir(const char *name, struct dentry *parent)269{270struct dentry_meta *dm;271struct dentry *dnode;272struct pfs_node *pnode;273274if (name == NULL)275return (NULL);276277dm = malloc(sizeof(*dm), M_DFSINT, M_NOWAIT | M_ZERO);278if (dm == NULL)279return (NULL);280dnode = &dm->dm_dnode;281dm->dm_mode = 0700;282dm->dm_type = DM_DIR;283if (parent != NULL)284pnode = parent->d_pfs_node;285else286pnode = debugfs_root;287288pfs_create_dir(pnode, &dnode->d_pfs_node, name, debugfs_attr, NULL,289debugfs_destroy, PFS_RD | PFS_NOWAIT);290if (dnode->d_pfs_node == NULL) {291free(dm, M_DFSINT);292return (NULL);293}294dnode->d_pfs_node->pn_data = dm;295return (dnode);296}297298struct dentry *299debugfs_create_symlink(const char *name, struct dentry *parent,300const char *dest)301{302struct dentry_meta *dm;303struct dentry *dnode;304struct pfs_node *pnode;305void *data;306307data = strdup_flags(dest, M_DFSINT, M_NOWAIT);308if (data == NULL)309return (NULL);310dm = malloc(sizeof(*dm), M_DFSINT, M_NOWAIT | M_ZERO);311if (dm == NULL)312goto fail1;313dnode = &dm->dm_dnode;314dm->dm_mode = 0700;315dm->dm_type = DM_SYMLINK;316dm->dm_data = data;317if (parent != NULL)318pnode = parent->d_pfs_node;319else320pnode = debugfs_root;321322pfs_create_link(pnode, &dnode->d_pfs_node, name, &debugfs_fill_data,323NULL, NULL, NULL, PFS_NOWAIT);324if (dnode->d_pfs_node == NULL)325goto fail;326dnode->d_pfs_node->pn_data = dm;327return (dnode);328fail:329free(dm, M_DFSINT);330fail1:331free(data, M_DFSINT);332return (NULL);333}334335struct dentry *336debugfs_lookup(const char *name, struct dentry *parent)337{338struct dentry_meta *dm;339struct dentry *dnode;340struct pfs_node *pnode;341342pnode = pfs_find_node(parent->d_pfs_node, name);343if (pnode == NULL)344return (NULL);345346dm = (struct dentry_meta *)pnode->pn_data;347dnode = &dm->dm_dnode;348349return (dnode);350}351352void353debugfs_remove(struct dentry *dnode)354{355if (dnode == NULL)356return;357358pfs_destroy(dnode->d_pfs_node);359}360361void362debugfs_remove_recursive(struct dentry *dnode)363{364if (dnode == NULL)365return;366367pfs_destroy(dnode->d_pfs_node);368}369370static int371debugfs_bool_get(void *data, uint64_t *ullval)372{373bool *bval = data;374375if (*bval)376*ullval = 1;377else378*ullval = 0;379380return (0);381}382383static int384debugfs_bool_set(void *data, uint64_t ullval)385{386bool *bval = data;387388if (ullval)389*bval = 1;390else391*bval = 0;392393return (0);394}395396DEFINE_DEBUGFS_ATTRIBUTE(fops_bool, debugfs_bool_get, debugfs_bool_set, "%llu\n");397DEFINE_DEBUGFS_ATTRIBUTE(fops_bool_ro, debugfs_bool_get, NULL, "%llu\n");398DEFINE_DEBUGFS_ATTRIBUTE(fops_bool_wo, NULL, debugfs_bool_set, "%llu\n");399400void401debugfs_create_bool(const char *name, umode_t mode, struct dentry *parent, bool *value)402{403404debugfs_create_mode_unsafe(name, mode, parent, value, &fops_bool,405&fops_bool_ro, &fops_bool_wo);406}407408409static int410debugfs_u8_get(void *data, uint64_t *value)411{412uint8_t *u8data = data;413*value = *u8data;414return (0);415}416417static int418debugfs_u8_set(void *data, uint64_t value)419{420uint8_t *u8data = data;421*u8data = (uint8_t)value;422return (0);423}424425DEFINE_DEBUGFS_ATTRIBUTE(fops_u8, debugfs_u8_get, debugfs_u8_set, "%u\n");426DEFINE_DEBUGFS_ATTRIBUTE(fops_u8_ro, debugfs_u8_get, NULL, "%u\n");427DEFINE_DEBUGFS_ATTRIBUTE(fops_u8_wo, NULL, debugfs_u8_set, "%u\n");428429void430debugfs_create_u8(const char *name, umode_t mode, struct dentry *parent, uint8_t *value)431{432433debugfs_create_mode_unsafe(name, mode, parent, value, &fops_u8,434&fops_u8_ro, &fops_u8_wo);435}436437DEFINE_DEBUGFS_ATTRIBUTE(fops_x8, debugfs_u8_get, debugfs_u8_set, "0x%016llx\n");438DEFINE_DEBUGFS_ATTRIBUTE(fops_x8_ro, debugfs_u8_get, NULL, "0x%016llx\n");439DEFINE_DEBUGFS_ATTRIBUTE(fops_x8_wo, NULL, debugfs_u8_set, "0x%016llx\n");440441void442debugfs_create_x8(const char *name, umode_t mode, struct dentry *parent, uint8_t *value)443{444445debugfs_create_mode_unsafe(name, mode, parent, value, &fops_x8,446&fops_x8_ro, &fops_x8_wo);447}448449450static int451debugfs_u16_get(void *data, uint64_t *value)452{453uint16_t *u16data = data;454*value = *u16data;455return (0);456}457458static int459debugfs_u16_set(void *data, uint64_t value)460{461uint16_t *u16data = data;462*u16data = (uint16_t)value;463return (0);464}465466DEFINE_DEBUGFS_ATTRIBUTE(fops_u16, debugfs_u16_get, debugfs_u16_set, "%u\n");467DEFINE_DEBUGFS_ATTRIBUTE(fops_u16_ro, debugfs_u16_get, NULL, "%u\n");468DEFINE_DEBUGFS_ATTRIBUTE(fops_u16_wo, NULL, debugfs_u16_set, "%u\n");469470void471debugfs_create_u16(const char *name, umode_t mode, struct dentry *parent, uint16_t *value)472{473474debugfs_create_mode_unsafe(name, mode, parent, value, &fops_u16,475&fops_u16_ro, &fops_u16_wo);476}477478DEFINE_DEBUGFS_ATTRIBUTE(fops_x16, debugfs_u16_get, debugfs_u16_set, "0x%016llx\n");479DEFINE_DEBUGFS_ATTRIBUTE(fops_x16_ro, debugfs_u16_get, NULL, "0x%016llx\n");480DEFINE_DEBUGFS_ATTRIBUTE(fops_x16_wo, NULL, debugfs_u16_set, "0x%016llx\n");481482void483debugfs_create_x16(const char *name, umode_t mode, struct dentry *parent, uint16_t *value)484{485486debugfs_create_mode_unsafe(name, mode, parent, value, &fops_x16,487&fops_x16_ro, &fops_x16_wo);488}489490491static int492debugfs_u32_get(void *data, uint64_t *value)493{494uint32_t *u32data = data;495*value = *u32data;496return (0);497}498499static int500debugfs_u32_set(void *data, uint64_t value)501{502uint32_t *u32data = data;503*u32data = (uint32_t)value;504return (0);505}506507DEFINE_DEBUGFS_ATTRIBUTE(fops_u32, debugfs_u32_get, debugfs_u32_set, "%u\n");508DEFINE_DEBUGFS_ATTRIBUTE(fops_u32_ro, debugfs_u32_get, NULL, "%u\n");509DEFINE_DEBUGFS_ATTRIBUTE(fops_u32_wo, NULL, debugfs_u32_set, "%u\n");510511void512debugfs_create_u32(const char *name, umode_t mode, struct dentry *parent, uint32_t *value)513{514515debugfs_create_mode_unsafe(name, mode, parent, value, &fops_u32,516&fops_u32_ro, &fops_u32_wo);517}518519DEFINE_DEBUGFS_ATTRIBUTE(fops_x32, debugfs_u32_get, debugfs_u32_set, "0x%016llx\n");520DEFINE_DEBUGFS_ATTRIBUTE(fops_x32_ro, debugfs_u32_get, NULL, "0x%016llx\n");521DEFINE_DEBUGFS_ATTRIBUTE(fops_x32_wo, NULL, debugfs_u32_set, "0x%016llx\n");522523void524debugfs_create_x32(const char *name, umode_t mode, struct dentry *parent, uint32_t *value)525{526527debugfs_create_mode_unsafe(name, mode, parent, value, &fops_x32,528&fops_x32_ro, &fops_x32_wo);529}530531532static int533debugfs_u64_get(void *data, uint64_t *value)534{535uint64_t *u64data = data;536*value = *u64data;537return (0);538}539540static int541debugfs_u64_set(void *data, uint64_t value)542{543uint64_t *u64data = data;544*u64data = (uint64_t)value;545return (0);546}547548DEFINE_DEBUGFS_ATTRIBUTE(fops_u64, debugfs_u64_get, debugfs_u64_set, "%u\n");549DEFINE_DEBUGFS_ATTRIBUTE(fops_u64_ro, debugfs_u64_get, NULL, "%u\n");550DEFINE_DEBUGFS_ATTRIBUTE(fops_u64_wo, NULL, debugfs_u64_set, "%u\n");551552void553debugfs_create_u64(const char *name, umode_t mode, struct dentry *parent, uint64_t *value)554{555556debugfs_create_mode_unsafe(name, mode, parent, value, &fops_u64,557&fops_u64_ro, &fops_u64_wo);558}559560DEFINE_DEBUGFS_ATTRIBUTE(fops_x64, debugfs_u64_get, debugfs_u64_set, "0x%016llx\n");561DEFINE_DEBUGFS_ATTRIBUTE(fops_x64_ro, debugfs_u64_get, NULL, "0x%016llx\n");562DEFINE_DEBUGFS_ATTRIBUTE(fops_x64_wo, NULL, debugfs_u64_set, "0x%016llx\n");563564void565debugfs_create_x64(const char *name, umode_t mode, struct dentry *parent, uint64_t *value)566{567568debugfs_create_mode_unsafe(name, mode, parent, value, &fops_x64,569&fops_x64_ro, &fops_x64_wo);570}571572573static int574debugfs_ulong_get(void *data, uint64_t *value)575{576uint64_t *uldata = data;577*value = *uldata;578return (0);579}580581static int582debugfs_ulong_set(void *data, uint64_t value)583{584uint64_t *uldata = data;585*uldata = value;586return (0);587}588589DEFINE_DEBUGFS_ATTRIBUTE(fops_ulong, debugfs_ulong_get, debugfs_ulong_set, "%llu\n");590DEFINE_DEBUGFS_ATTRIBUTE(fops_ulong_ro, debugfs_ulong_get, NULL, "%llu\n");591DEFINE_DEBUGFS_ATTRIBUTE(fops_ulong_wo, NULL, debugfs_ulong_set, "%llu\n");592593void594debugfs_create_ulong(const char *name, umode_t mode, struct dentry *parent, unsigned long *value)595{596597debugfs_create_mode_unsafe(name, mode, parent, value, &fops_ulong,598&fops_ulong_ro, &fops_ulong_wo);599}600601602static int603debugfs_atomic_t_get(void *data, uint64_t *value)604{605atomic_t *atomic_data = data;606*value = atomic_read(atomic_data);607return (0);608}609610static int611debugfs_atomic_t_set(void *data, uint64_t value)612{613atomic_t *atomic_data = data;614atomic_set(atomic_data, (int)value);615return (0);616}617618DEFINE_DEBUGFS_ATTRIBUTE(fops_atomic_t, debugfs_atomic_t_get, debugfs_atomic_t_set, "%d\n");619DEFINE_DEBUGFS_ATTRIBUTE(fops_atomic_t_ro, debugfs_atomic_t_get, NULL, "%d\n");620DEFINE_DEBUGFS_ATTRIBUTE(fops_atomic_t_wo, NULL, debugfs_atomic_t_set, "%d\n");621622void623debugfs_create_atomic_t(const char *name, umode_t mode, struct dentry *parent, atomic_t *value)624{625626debugfs_create_mode_unsafe(name, mode, parent, value, &fops_atomic_t,627&fops_atomic_t_ro, &fops_atomic_t_wo);628}629630631static int632fops_str_open(struct inode *inode, struct file *filp)633{634635return (simple_open(inode, filp));636}637638static ssize_t639fops_str_read(struct file *filp, char __user *ubuf, size_t read_size,640loff_t *ppos)641{642ssize_t ret;643char *str, *str_with_newline;644size_t str_len, str_with_newline_len;645646if (filp->private_data == NULL)647return (-EINVAL);648649str = *(char **)filp->private_data;650str_len = strlen(str);651652/*653* `str_with_newline` is terminated with a newline, but is not654* NUL-terminated.655*/656str_with_newline_len = str_len + 1;657str_with_newline = kmalloc(str_with_newline_len, GFP_KERNEL);658if (str_with_newline == NULL)659return (-ENOMEM);660661strncpy(str_with_newline, str, str_len);662str_with_newline[str_len] = '\n';663664ret = simple_read_from_buffer(ubuf, read_size, ppos,665str_with_newline, str_with_newline_len);666667kfree(str_with_newline);668669return (ret);670}671672static ssize_t673fops_str_write(struct file *filp, const char *buf, size_t write_size,674loff_t *ppos)675{676char *old, *new;677size_t old_len, new_len;678679if (filp->private_data == NULL)680return (-EINVAL);681682old = *(char **)filp->private_data;683new = NULL;684685/*686* We enforce concatenation of the newly written value to the existing687* value.688*/689old_len = strlen(old);690if (*ppos && *ppos != old_len)691return (-EINVAL);692693new_len = old_len + write_size;694if (new_len + 1 > PAGE_SIZE)695return (-E2BIG);696697new = kmalloc(new_len + 1, GFP_KERNEL);698if (new == NULL)699return (-ENOMEM);700701memcpy(new, old, old_len);702if (copy_from_user(new + old_len, buf, write_size) != 0) {703kfree(new);704return (-EFAULT);705}706707new[new_len] = '\0';708strim(new);709710filp->private_data = &new;711712kfree(old);713714return (write_size);715}716717static const struct file_operations fops_str = {718.owner = THIS_MODULE,719.open = fops_str_open,720.read = fops_str_read,721.write = fops_str_write,722.llseek = no_llseek723};724static const struct file_operations fops_str_ro = {725.owner = THIS_MODULE,726.open = fops_str_open,727.read = fops_str_read,728.llseek = no_llseek729};730static const struct file_operations fops_str_wo = {731.owner = THIS_MODULE,732.open = fops_str_open,733.write = fops_str_write,734.llseek = no_llseek735};736737void738debugfs_create_str(const char *name, umode_t mode, struct dentry *parent,739char **value)740{741debugfs_create_mode_unsafe(name, mode, parent, value,742&fops_str, &fops_str_ro, &fops_str_wo);743}744745746static ssize_t747fops_blob_read(struct file *filp, char __user *ubuf, size_t read_size, loff_t *ppos)748{749struct debugfs_blob_wrapper *blob;750751blob = filp->private_data;752if (blob == NULL)753return (-EINVAL);754if (blob->size == 0 || blob->data == NULL)755return (-EINVAL);756757return (simple_read_from_buffer(ubuf, read_size, ppos, blob->data, blob->size));758}759760static int761fops_blob_open(struct inode *inode, struct file *filp)762{763764return (simple_open(inode, filp));765}766767static const struct file_operations __fops_blob_ro = {768.owner = THIS_MODULE,769.open = fops_blob_open,770.read = fops_blob_read,771.llseek = no_llseek772};773774struct dentry *775debugfs_create_blob(const char *name, umode_t mode, struct dentry *parent,776struct debugfs_blob_wrapper *value)777{778/* Blobs are read-only. */779return (debugfs_create_file(name, mode & 0444, parent, value, &__fops_blob_ro));780}781782783static int784lindebugfs_init(PFS_INIT_ARGS)785{786787debugfs_root = pi->pi_root;788789(void)debugfs_create_symlink("kcov", NULL, "/dev/kcov");790791return (0);792}793794static int795lindebugfs_uninit(PFS_INIT_ARGS)796{797798return (0);799}800801PSEUDOFS(lindebugfs, 1, VFCF_JAIL);802MODULE_DEPEND(lindebugfs, linuxkpi, 1, 1, 1);803804805