1POSIX_TRACE_GET_FILTER(P)  POSIX Programmer's Manual POSIX_TRACE_GET_FILTER(P)
2
3
4

NAME

6       posix_trace_get_filter,  posix_trace_set_filter  - retrieve and set the
7       filter of an initialized trace stream (TRACING)
8

SYNOPSIS

10       #include <trace.h>
11
12       int posix_trace_get_filter(trace_id_t trid, trace_event_set_t *set);
13       int posix_trace_set_filter(trace_id_t trid,
14              const trace_event_set_t *set, int how);
15
16

DESCRIPTION

18       The posix_trace_get_filter() function shall retrieve, into the argument
19       pointed  to by set, the actual trace event filter from the trace stream
20       specified by trid.
21
22       The posix_trace_set_filter() function shall change the set of  filtered
23       trace  event types after a trace stream identified by the trid argument
24       is created. This function may be called prior  to  starting  the  trace
25       stream,  or while the trace stream is active. By default, if no call is
26       made to posix_trace_set_filter(), all trace events  shall  be  recorded
27       (that is, none of the trace event types are filtered out).
28
29       If  this  function  is called while the trace is in progress, a special
30       system trace event, POSIX_TRACE_FILTER, shall be recorded in the  trace
31       indicating  both the old and the new sets of filtered trace event types
32       (see Trace and Trace Event Filter  Options:  System  Trace  Events  and
33       Trace,  Trace  Log, and Trace Event Filter Options: System Trace Events
34       ).
35
36       If the posix_trace_set_filter() function is interrupted by a signal, an
37       error  shall  be  returned and the filter shall not be changed. In this
38       case, the state of the trace stream shall not be changed.
39
40       The value of the argument how indicates the manner in which the set  is
41       to be changed and shall have one of the following values, as defined in
42       the <trace.h> header:
43
44       POSIX_TRACE_SET_EVENTSET
45
46              The resulting set of trace event types to be filtered  shall  be
47              the trace event type set pointed to by the argument set.
48
49       POSIX_TRACE_ADD_EVENTSET
50
51              The  resulting  set of trace event types to be filtered shall be
52              the union of the current  set  and  the  trace  event  type  set
53              pointed to by the argument set.
54
55       POSIX_TRACE_SUB_EVENTSET
56
57              The  resulting  set of trace event types to be filtered shall be
58              all trace event types in the current set that are not in the set
59              pointed  to by the argument set; that is, remove each element of
60              the specified set from the current filter.
61
62

RETURN VALUE

64       Upon successful completion, these functions shall  return  a  value  of
65       zero. Otherwise, they shall return the corresponding error number.
66
67       The  posix_trace_get_filter() function stores the set of filtered trace
68       event types in set, if successful.
69

ERRORS

71       These functions shall fail if:
72
73       EINVAL The value of the trid argument does not correspond to an  active
74              trace  stream  or the value of the argument pointed to by set is
75              invalid.
76
77       EINTR  The operation was interrupted by a signal.
78
79
80       The following sections are informative.
81

EXAMPLES

83       None.
84

APPLICATION USAGE

86       None.
87

RATIONALE

89       None.
90

FUTURE DIRECTIONS

92       None.
93

SEE ALSO

95       Trace and Trace Event Filter Options:  System  Trace  Events  ,  Trace,
96       Trace  Log,  and  Trace  Event  Filter  Options:  System Trace Events ,
97       posix_trace_eventset_add()   ,   the   Base   Definitions   volume   of
98       IEEE Std 1003.1-2001, <trace.h>
99
101       Portions  of  this text are reprinted and reproduced in electronic form
102       from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology
103       --  Portable  Operating  System  Interface (POSIX), The Open Group Base
104       Specifications Issue 6, Copyright (C) 2001-2003  by  the  Institute  of
105       Electrical  and  Electronics  Engineers, Inc and The Open Group. In the
106       event of any discrepancy between this version and the original IEEE and
107       The  Open Group Standard, the original IEEE and The Open Group Standard
108       is the referee document. The original Standard can be  obtained  online
109       at http://www.opengroup.org/unix/online.html .
110
111
112
113IEEE/The Open Group                  2003            POSIX_TRACE_GET_FILTER(P)
Impressum