1 .\" SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3 .\" Copyright (c) 2022, Jake Freeland <jfree@freebsd.org>
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\" notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\" notice, this list of conditions and the following disclaimer in the
12 .\" documentation and/or other materials provided with the distribution.
14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 .Nd Linux file system for debugging
34 lindebugfs /sys/kernel/debug lindebugfs rw 0 0
37 The debug file system, or debugfs, makes process debugging easier by
38 providing a simple API for data transfer between the kernel and user
40 Debugfs is not a general-purpose file system and should not be used as
42 Instead, developers can implement the debugfs interface in their code
43 to generate debug information about their program at runtime.
48 file system construction kit to model itself after Linux's debugfs.
51 API is intended for use with programs that take advantage of FreeBSD's
52 LinuxKPI compatibility layer.
56 will populate with pseudo files from any running process that calls
57 .Nm debugfs_create_file() .
60 is a pseudo file system, file contents will be generated dynamically
61 based on program provided file operations.
64 implementation formally supports seq_file and simple_attr_file virtual
71 .Dl "kldload lindebugfs"
76 .Pa /sys/kernel/debug :
78 .Dl "mount -t lindebugfs lindebugfs /sys/kernel/debug"
88 file system first appeared in
92 The initial implementation for
94 was created by Matthew Macy.
95 This manual page was written by Jake Freeland.