'\" t
.\"     Title: libtracefs
.\"    Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 01/15/2021
.\"    Manual: libtracefs Manual
.\"    Source: libtracefs 1.0.2
.\"  Language: English
.\"
.TH "LIBTRACEFS" "3" "01/15/2021" "libtracefs 1\&.0\&.2" "libtracefs Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
tracefs_file_exists, tracefs_dir_exists, tracefs_instance_get_file, tracefs_instance_get_dir, tracefs_instance_file_write, tracefs_instance_file_read \- Work with files in tracing instances\&.
.SH "SYNOPSIS"
.sp
.nf
\fB#include <tracefs\&.h>\fR

bool \fBtracefs_file_exists\fR(struct tracefs_instance *\fIinstance\fR, char *\fIname\fR);
bool \fBtracefs_dir_exists\fR(struct tracefs_instance *\fIinstance\fR, char *\fIname\fR);
char *\fBtracefs_instance_get_file\fR(struct tracefs_instance *\fIinstance\fR, const char *\fIfile\fR);
char *\fBtracefs_instance_get_dir\fR(struct tracefs_instance *\fIinstance\fR);
int \fBtracefs_instance_file_write\fR(struct tracefs_instance *\fIinstance\fR, const char *\fIfile\fR, const char *\fIstr\fR);
char *\fBtracefs_instance_file_read\fR(struct tracefs_instance *\fIinstance\fR, const char *\fIfile\fR, int *\fIpsize\fR);
.fi
.SH "DESCRIPTION"
.sp
This set of APIs can be used to work with trace files in all trace instances\&. Each of these APIs take an \fIinstance\fR argument, that can be NULL to act on the top level instance\&. Otherwise, it acts on an instance created with \fBtracefs_insance_create\fR(3)
.sp
The \fItracefs_file_exists()\fR function checks if a file with \fIname\fR exists in \fIinstance\fR\&.
.sp
The \fItracefs_dir_exists()\fR function checks if a directory with \fIname\fR exists in \fIinstance\fR\&.
.sp
The \fItracefs_instance_get_file()\fR function returns the full path of the file with given \fIname\fR in \fIinstance\fR\&. Note, it does not check if the file exists in the instance\&.
.sp
The \fItracefs_instance_get_dir()\fR function returns the full path of the directory with given \fIname\fR in \fIinstance\fR\&. Note, it does not check if the directory exists in the instance\&.
.sp
The \fItracefs_instance_file_write()\fR function writes a string \fIstr\fR in a \fIfile\fR from the given \fIinstance\fR, without the terminating NULL character\&.
.sp
The \fItracefs_instance_file_read()\fR function reads the content of a \fIfile\fR from the given \fIinstance\fR\&.
.SH "RETURN VALUE"
.sp
The \fItracefs_file_exists()\fR and \fItracefs_dir_exists()\fR functions return true if the file / directory exist in the given instance or false if it does not exist\&.
.sp
The \fItracefs_instance_get_file()\fR and \fItracefs_instance_get_dir()\fR functions return a string or NULL in case of an error\&. The returned string must be freed with \fItracefs_put_tracing_file()\fR\&.
.sp
The \fItracefs_instance_file_write()\fR function returns the number of written bytes, or \-1 in case of an error\&.
.sp
The \fItracefs_instance_file_read()\fR function returns a pointer to a NULL terminated string, read from the file, or NULL in case of an error\&. The returned string must be freed with free()\&.
.SH "EXAMPLE"
.sp
.if n \{\
.RS 4
.\}
.nf
#include <tracefs\&.h>

struct tracefs_instance *inst = tracefs_instance_create("foo");
        if (!inst) {
                /* Error creating a new trace instance */
                \&.\&.\&.
        }

        if (tracefs_file_exists(inst,"trace_clock")) {
                /* The instance foo supports trace clock */
                char *path, *clock;
                int size;

                path =  = tracefs_instance_get_file(inst, "trace_clock")
                if (!path) {
                        /* Error getting the path to trace_clock file in instance foo */
                        \&.\&.\&.
                }
                \&.\&.\&.
                tracefs_put_tracing_file(path);

                clock = tracefs_instance_file_read(inst, "trace_clock", &size);
                if (!clock) {
                        /* Failed to read trace_clock file in instance foo */
                        \&.\&.\&.
                }
                \&.\&.\&.
                free(clock);

                if (tracefs_instance_file_write(inst, "trace_clock", "global") != strlen("global")) {
                        /* Failed to set gloabl trace clock in instance foo */
                        \&.\&.\&.
                }
        } else {
                /* The instance foo does not support trace clock */
        }

        if (tracefs_dir_exists(inst,"options")) {
                /* The instance foo supports trace options */
                char *path = tracefs_instance_get_file(inst, "options");
                if (!path) {
                        /* Error getting the path to options directory in instance foo */
                        \&.\&.\&.
                }

                tracefs_put_tracing_file(path);
        } else {
                /* The instance foo does not support trace options */
        }

        \&.\&.\&.

        if (tracefs_instance_is_new(inst))
                tracefs_instance_destroy(inst);
        else
                tracefs_instance_free(inst);
.fi
.if n \{\
.RE
.\}
.SH "FILES"
.sp
.if n \{\
.RS 4
.\}
.nf
\fBtracefs\&.h\fR
        Header file to include in order to have access to the library APIs\&.
\fB\-ltracefs\fR
        Linker switch to add when building a program that uses the library\&.
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.sp
\fIlibtracefs(3)\fR, \fIlibtraceevent(3)\fR, \fItrace\-cmd(1)\fR
.SH "AUTHOR"
.sp
.if n \{\
.RS 4
.\}
.nf
\fBSteven Rostedt\fR <\m[blue]\fBrostedt@goodmis\&.org\fR\m[]\&\s-2\u[1]\d\s+2>
\fBTzvetomir Stoyanov\fR <\m[blue]\fBtz\&.stoyanov@gmail\&.com\fR\m[]\&\s-2\u[2]\d\s+2>
.fi
.if n \{\
.RE
.\}
.SH "REPORTING BUGS"
.sp
Report bugs to <\m[blue]\fBlinux\-trace\-devel@vger\&.kernel\&.org\fR\m[]\&\s-2\u[3]\d\s+2>
.SH "LICENSE"
.sp
libtracefs is Free Software licensed under the GNU LGPL 2\&.1
.SH "RESOURCES"
.sp
\m[blue]\fBhttps://git\&.kernel\&.org/pub/scm/libs/libtrace/libtracefs\&.git/\fR\m[]
.SH "COPYING"
.sp
Copyright (C) 2020 VMware, Inc\&. Free use of this software is granted under the terms of the GNU Public License (GPL)\&.
.SH "NOTES"
.IP " 1." 4
rostedt@goodmis.org
.RS 4
\%mailto:rostedt@goodmis.org
.RE
.IP " 2." 4
tz.stoyanov@gmail.com
.RS 4
\%mailto:tz.stoyanov@gmail.com
.RE
.IP " 3." 4
linux-trace-devel@vger.kernel.org
.RS 4
\%mailto:linux-trace-devel@vger.kernel.org
.RE