oracular (3) posix_trace_start.3posix.gz

Provided by: manpages-posix-dev_2017a-2_all bug

PROLOG
       This  manual  page  is part of the POSIX Programmer's Manual.  The Linux implementation of this interface
       may differ (consult the corresponding Linux manual page for details of Linux behavior), or the  interface
       may not be implemented on Linux.


NAME
       posix_trace_start, posix_trace_stop — trace start and stop (TRACING)


SYNOPSIS
       #include <trace.h>

       int posix_trace_start(trace_id_t trid);
       int posix_trace_stop (trace_id_t trid);


DESCRIPTION
       The  posix_trace_start()  and  posix_trace_stop() functions, respectively, shall start and stop the trace
       stream identified by the argument trid.

       The effect of calling the posix_trace_start() function shall be recorded  in  the  trace  stream  as  the
       POSIX_TRACE_START system trace event and the status of the trace stream shall become POSIX_TRACE_RUNNING.
       If the trace stream is in progress when this function is called, the POSIX_TRACE_START system trace event
       shall  not  be  recorded  and  the  trace  stream shall continue to run. If the trace stream is full, the
       POSIX_TRACE_START system trace event shall not be recorded and the status of the trace stream  shall  not
       be changed.

       The  effect  of  calling  the  posix_trace_stop()  function  shall be recorded in the trace stream as the
       POSIX_TRACE_STOP  system  trace   event   and   the   status   of   the   trace   stream   shall   become
       POSIX_TRACE_SUSPENDED.    If   the   trace  stream  is  suspended  when  this  function  is  called,  the
       POSIX_TRACE_STOP system trace event shall not be recorded and the trace stream shall remain suspended. If
       the trace stream is full, the POSIX_TRACE_STOP system trace event shall not be recorded and the status of
       the trace stream shall not be changed.


RETURN VALUE
       Upon successful completion, these functions shall return a value of zero. Otherwise,  they  shall  return
       the corresponding error number.


ERRORS
       These functions shall fail if:

       EINVAL The  value  of  the  argument trid does not correspond to an active trace stream and thus no trace
              stream was started or stopped.

       EINTR  The operation was interrupted by a signal and thus the trace stream was not necessarily started or
              stopped.

       The following sections are informative.


EXAMPLES
       None.


APPLICATION USAGE
       None.


RATIONALE
       None.


FUTURE DIRECTIONS
       The posix_trace_start() and posix_trace_stop() functions may be removed in a future version.


SEE ALSO
       posix_trace_create()

       The Base Definitions volume of POSIX.1‐2017, <trace.h>


       Portions of this text are reprinted and reproduced in electronic form from IEEE Std 1003.1-2017, Standard
       for Information  Technology  --  Portable  Operating  System  Interface  (POSIX),  The  Open  Group  Base
       Specifications  Issue  7, 2018 Edition, Copyright (C) 2018 by the Institute of Electrical and Electronics
       Engineers, Inc and The Open Group.  In the event of any discrepancy between this version and the original
       IEEE  and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document.
       The original Standard can be obtained online at http://www.opengroup.org/unix/online.html .

       Any typographical or formatting errors that appear in this page are most likely to have  been  introduced
       during   the   conversion  of  the  source  files  to  man  page  format.  To  report  such  errors,  see
       https://www.kernel.org/doc/man-pages/reporting_bugs.html .