1POSIX_TRACE_EVENTSET_ADD(3P)POSIX Programmer's ManuaPlOSIX_TRACE_EVENTSET_ADD(3P)
2
3
4

PROLOG

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

NAME

12       posix_trace_eventset_add, posix_trace_eventset_del,
13       posix_trace_eventset_empty, posix_trace_eventset_fill,
14       posix_trace_eventset_ismember — manipulate trace event type sets (TRAC‐
15       ING)
16

SYNOPSIS

18       #include <trace.h>
19
20       int posix_trace_eventset_add(trace_event_id_t event_id,
21           trace_event_set_t *set);
22       int posix_trace_eventset_del(trace_event_id_t event_id,
23           trace_event_set_t *set);
24       int posix_trace_eventset_empty(trace_event_set_t *set);
25       int posix_trace_eventset_fill(trace_event_set_t *set, int what);
26       int posix_trace_eventset_ismember(trace_event_id_t event_id,
27           const trace_event_set_t *restrict set, int *restrict ismember);
28

DESCRIPTION

30       These  primitives manipulate sets of trace event types. They operate on
31       data objects addressable by the application, not on the  current  trace
32       event filter of any trace stream.
33
34       The  posix_trace_eventset_add()  and  posix_trace_eventset_del()  func‐
35       tions, respectively, shall add or delete  the  individual  trace  event
36       type  specified  by  the  value of the argument event_id to or from the
37       trace event type set pointed to by the argument set.   Adding  a  trace
38       event type already in the set or deleting a trace event type not in the
39       set shall not be considered an error.
40
41       The posix_trace_eventset_empty() function shall  initialize  the  trace
42       event type set pointed to by the set argument such that all trace event
43       types defined, both system and user, shall be excluded from the set.
44
45       The posix_trace_eventset_fill() function  shall  initialize  the  trace
46       event  type  set  pointed  to by the argument set, such that the set of
47       trace event types defined by the argument what shall be included in the
48       set. The value of the argument what shall consist of one of the follow‐
49       ing values, as defined in the <trace.h> header:
50
51       POSIX_TRACE_WOPID_EVENTS
52             All the process-independent implementation-defined  system  trace
53             event types are included in the set.
54
55       POSIX_TRACE_SYSTEM_EVENTS
56             All  the  implementation-defined  system  trace  event  types are
57             included in the set, as are those defined in POSIX.1‐2008.
58
59       POSIX_TRACE_ALL_EVENTS
60             All trace event types defined, both system and user, are included
61             in the set.
62
63       Applications   shall   call   either   posix_trace_eventset_empty()  or
64       posix_trace_eventset_fill() at least  once  for  each  object  of  type
65       trace_event_set_t  prior  to  any  other use of that object. If such an
66       object is not initialized in this way, but is nonetheless  supplied  as
67       an    argument    to    any    of    the    posix_trace_eventset_add(),
68       posix_trace_eventset_del(),  or  posix_trace_eventset_ismember()  func‐
69       tions, the results are undefined.
70
71       The  posix_trace_eventset_ismember()  function  shall  test whether the
72       trace event type specified by the value of the argument event_id  is  a
73       member  of  the set pointed to by the argument set.  The value returned
74       in the object pointed to by ismember argument  is  zero  if  the  trace
75       event  type identifier is not a member of the set and a value different
76       from zero if it is a member of the set.
77

RETURN VALUE

79       Upon successful completion, these functions shall  return  a  value  of
80       zero. Otherwise, they shall return the corresponding error number.
81

ERRORS

83       These functions may fail if:
84
85       EINVAL The value of one of the arguments is invalid.
86
87       The following sections are informative.
88

EXAMPLES

90       None.
91

APPLICATION USAGE

93       None.
94

RATIONALE

96       None.
97

FUTURE DIRECTIONS

99       The       posix_trace_eventset_add(),       posix_trace_eventset_del(),
100       posix_trace_eventset_empty(),     posix_trace_eventset_fill(),      and
101       posix_trace_eventset_ismember()  functions  may  be removed in a future
102       version.
103

SEE ALSO

105       posix_trace_eventid_equal(), posix_trace_get_filter()
106
107       The Base Definitions volume of POSIX.1‐2017, <trace.h>
108
110       Portions of this text are reprinted and reproduced in  electronic  form
111       from  IEEE Std 1003.1-2017, Standard for Information Technology -- Por‐
112       table Operating System Interface (POSIX), The Open Group Base  Specifi‐
113       cations  Issue  7, 2018 Edition, Copyright (C) 2018 by the Institute of
114       Electrical and Electronics Engineers, Inc and The Open Group.   In  the
115       event of any discrepancy between this version and the original IEEE and
116       The Open Group Standard, the original IEEE and The Open Group  Standard
117       is  the  referee document. The original Standard can be obtained online
118       at http://www.opengroup.org/unix/online.html .
119
120       Any typographical or formatting errors that appear  in  this  page  are
121       most likely to have been introduced during the conversion of the source
122       files to man page format. To report such errors,  see  https://www.ker
123       nel.org/doc/man-pages/reporting_bugs.html .
124
125
126
127IEEE/The Open Group                  2017         POSIX_TRACE_EVENTSET_ADD(3P)
Impressum