LIBTRACEFS(3)

πŸ’– NAME πŸ’–

okay so welcome to the libtracefs(3) manual page, bestie πŸ’– this one is all about finding and setting the locations of the trace directory and the files inside it. The whole squad is here: tracefs_get_tracing_file, tracefs_put_tracing_file, tracefs_tracing_dir, tracefs_debug_dir, tracefs_set_tracing_dir, and tracefs_tracing_dir_is_mounted β€” literally finding and setting locations of trace directory and files, periodt ✨


🌸 SYNOPSIS 🌸

#include <tracefs.h>

char *tracefs_get_tracing_file(const char *name);
void tracefs_put_tracing_file(char *name);
const char *tracefs_tracing_dir(void);
const char *tracefs_debug_dir(void);
int tracefs_set_tracing_dir(char *tracing_dir)
int tracefs_tracing_dir_is_mounted(bool mount, const char **path);

πŸ¦‹ DESCRIPTION πŸ¦‹

This set of APIs is your little map to the full path of the trace file system mount point and the trace files chilling inside it πŸ—ΊοΈβœ¨

The tracefs_set_tracing_dir() function sets a custom location for the system’s tracing directory mount point. Usually the library auto-detects it using the information from the /proc/mounts file. Use this API only if the mount point is not standard and cannot be detected by the library β€” like, don’t just use it for funsies, bestie. The tracing_dir argument can be NULL; in that case the custom location is deleted and the library auto-detection logic is used again. Slay, back to default πŸ’…

The tracefs_get_tracing_file() function returns the full path of the file with the given name in the trace file system. Here’s the tea though: it works only with files in the tracefs main directory, and it is not trace instance aware. It is recommended to use tracefs_instance_get_file() and tracefs_instance_get_dir() instead. The returned string must be freed with tracefs_put_tracing_file() 🫢

The tracefs_put_tracing_file() function frees the trace file name returned by tracefs_get_tracing_file(). That’s its whole job and it ate, no notes πŸ’€

The tracefs_tracing_dir() function returns the full path to the trace file system. In the first function call, the mount point of the tracing file system is located, cached, and returned. It will mount it if it is not mounted. On any subsequent call, the cached path is returned. The return string must not be freed. Do not free it, okay? That’s the rule πŸŽ€

The tracefs_debug_dir() is similar to tracefs_tracing_dir() except that it will return where the debugfs file system is mounted. If it is not mounted, it will try to mount it. The return string must not be freed. Same vibe, different filesystem, iconic πŸ¦‹

tracefs_tracing_dir_is_mounted() returns 1 if the tracing directory is already mounted and 0 if it is not. If mount is true, it will try to mount it if it is not, and returns 0 if it successfully mounted it and -1 if it did not. If path is set, it will be assigned to the path where it mounted it. path is internal and should not be freed. Internal means hands off, bestie πŸ™ˆ


πŸ”₯ RETURN VALUE πŸ”₯

  • tracefs_set_tracing_dir() β€” returns 0 on success, -1 otherwise.
  • tracefs_get_tracing_file() β€” returns a string or NULL in case of an error. The returned string must be freed with tracefs_put_tracing_file().
  • tracefs_tracing_dir() β€” returns a constant string or NULL in case of an error. The returned string must not be freed.
  • tracefs_debug_dir() β€” returns a constant string or NULL in case of an error. The returned string must not be freed.
  • tracefs_tracing_dir_is_mounted() β€” returns 1 if the tracing directory is already mounted, 0 if it is not, and -1 on error.

⭐ EXAMPLE ⭐

okay here’s the little demo, copied exactly because we do not mess with code in this house πŸ’…

#include <tracefs.h>
...
char *trace_on = tracefs_get_tracing_file("tracing_on");
        if (trace_on) {
                ...
                tracefs_put_tracing_file(trace_on);
        }
...
const char *trace_dir = tracefs_tracing_dir();

πŸŽ€ FILES πŸŽ€

  • tracefs.h β€” header file to include in order to have access to the library APIs.
  • -ltracefs β€” linker switch to add when building a program that uses the library.

🌈 SEE ALSO 🌈


πŸ‘‘ AUTHOR πŸ‘‘

  • Steven Rostedt <rostedt@goodmis.org[1]>
  • Tzvetomir Stoyanov <tz.stoyanov@gmail.com[2]>

πŸ’œ REPORTING BUGS πŸ’œ

Report bugs to <linux-trace-devel@vger.kernel.org[3]> β€” they’re ready for your bug reports, bestie 🫢


🌸 LICENSE 🌸

libtracefs is Free Software licensed under the GNU LGPL 2.1 ✨


🧚 RESOURCES 🧚

https://git.kernel.org/pub/scm/libs/libtrace/libtracefs.git/


πŸ“ COPYING πŸ“

Copyright (C) 2020 VMware, Inc. Free use of this software is granted under the terms of the GNU Public License (GPL).


πŸ’– NOTES πŸ’–

  1. rostedt@goodmis.org β€” mailto:rostedt@goodmis.org
  2. tz.stoyanov@gmail.com β€” mailto:tz.stoyanov@gmail.com
  3. linux-trace-devel@vger.kernel.org β€” mailto:linux-trace-devel@vger.kernel.org

and that’s the footer vibe, bestie: libtracefs 1.8.4, dated 10/21/2026 β€” periodt πŸ’…βœ¨

πŸ“¦ where this page comes from