SYNOPSIS

#include <tracefs.h>

bool tracefs_file_exists(struct tracefs_instance *instance, char *name);
bool tracefs_dir_exists(struct tracefs_instance *instance, char *name);
char *tracefs_instance_get_file(struct tracefs_instance *instance, const char *file);
char *tracefs_instance_get_dir(struct tracefs_instance *instance);
int tracefs_instance_file_write(struct tracefs_instance *instance, const char *file, const char *str);
char *tracefs_instance_file_read(struct tracefs_instance *instance, char *file, int *psize);

DESCRIPTION

This set of APIs can be used to work with trace files in all trace instances. Each of these APIs take an instance argument, that can be NULL to act on the top level instance. Otherwise, it acts on an instance created with tracefs_insance_create(3)

The tracefs_file_exists() function checks if a file with name exists in instance.

The tracefs_dir_exists() function checks if a directory with name exists in instance.

The tracefs_instance_get_file() function returns the full path of the file with given name in instance. Note, it does not check if the file exists in the instance.

The tracefs_instance_get_dir() function returns the full path of the directory with given name in instance. Note, it does not check if the directory exists in the instance.

The tracefs_instance_file_write() function writes a string str in a file from the given instance, without the terminating NULL character.

The tracefs_instance_file_read() function reads the content of a file from the given instance.

RETURN VALUE

The tracefs_file_exists() and tracefs_dir_exists() functions return true if the file / directory exist in the given instance or false if it does not exist.

The tracefs_instance_get_file() and tracefs_instance_get_dir() functions return a string or NULL in case of an error. The returned string must be freed with tracefs_put_tracing_file().

The tracefs_instance_file_write() function returns the number of written bytes, or -1 in case of an error.

The tracefs_instance_file_read() 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().

EXAMPLE

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

libtracefs(3), libtraceevent(3), trace-cmd(1)

AUTHOR

Steven Rostedt <rostedt@goodmis.org>
Tzvetomir Stoyanov <tz.stoyanov@gmail.com>

REPORTING BUGS

LICENSE

libtracefs is Free Software licensed under the GNU LGPL 2.1

RESOURCES

COPYING

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