LINDEBUGFS(5)

✨ NAME ✨

okay bestie, say hi to lindebugfs(5): it's the Linux file system for debugging. Yes, the name is literally doing the most and explaining itself. We love that for us. 💅

🦋 SYNOPSIS 🦋

lindebugfs              /sys/kernel/debug       lindebugfs      rw 0 0

🌸 DESCRIPTION 🌸

The debug file system — debugfs for short — makes process debugging easier by giving you a simple API for data transfer between the kernel and user space. It is not a general-purpose file system and should not be used as a storage medium. Like, not even a little. 🙈

Instead, developers can implement the debugfs interface in their code to generate debug information about their program at runtime. FreeBSD's lindebugfs uses the pseudofs(9) file system construction kit to model itself after Linux's debugfs. The lindebugfs API is intended for use with programs that take advantage of FreeBSD's LinuxKPI compatibility layer. ✨

When mounted, lindebugfs will populate with pseudo files from any running process that calls debugfs_create_file(). Since lindebugfs is a pseudo file system, file contents will be generated dynamically based on program provided file operations. The current lindebugfs implementation formally supports seq_file and simple_attr_file virtual file formats. 🎀

🔥 EXAMPLES 🔥

Load the lindebugfs kernel module:

kldload lindebugfs

Mount the lindebugfs file system on /sys/kernel/debug:

mount -t lindebugfs lindebugfs /sys/kernel/debug

🌈 SEE ALSO 🌈

• linprocfs(5)
• linsysfs(5)
• pseudofs(9)
• linux(4)
• pseudofs(9) — yes bestie, it appears twice in the original, and we are keeping both because details are sacred 💅

👑 HISTORY 👑

The lindebugfs file system first appeared in FreeBSD 12.1. ⭐

🫶 AUTHORS 🫶

The initial implementation for lindebugfs was created by Matthew Macy. This manual page was written by Jake Freeland. 💖

---

💖 lil footer moment: this page is from Debian, dated August 10, 2022. That's the source/version and date, bestie — now go debug something cute. 🫶✨