man0p/trace.h.0p

   1 .\" Copyright (c) 2001-2003 The Open Group, All Rights Reserved
   2 .TH "<trace.h>" P 2003 "IEEE/The Open Group" "POSIX Programmer's Manual"
   3 .\" <trace.h>
   4 .SH NAME
   5 trace.h \- tracing
   6 .SH SYNOPSIS
   7 .LP
   8 \fB#include <trace.h> \fP
   9 .SH DESCRIPTION
  10 .LP
  11 The \fI<trace.h>\fP header shall define the \fBposix_trace_event_info\fP
  12 structure that includes at least the following
  13 members:
  14 .sp
  15 .RS
  16 .nf
  17
  18 \fBtrace_event_id_t  posix_event_id
  19 pid_t             posix_pid
  20 void             *posix_prog_address
  21 int               posix_truncation_status
  22 struct timespec   posix_timestamp
  23
  24 pthread_t         posix_thread_id
  25
  26 \fP
  27 .fi
  28 .RE
  29 .LP
  30 The \fI<trace.h>\fP header shall define the \fBposix_trace_status_info\fP
  31 structure that includes at least the following
  32 members:
  33 .sp
  34 .RS
  35 .nf
  36
  37 \fBint     posix_stream_status
  38 int     posix_stream_full_status
  39 int     posix_stream_overrun_status
  40
  41 int     posix_stream_flush_status
  42 int     posix_stream_flush_error
  43 int     posix_log_overrun_status
  44 int     posix_log_full_status
  45
  46 \fP
  47 .fi
  48 .RE
  49 .LP
  50 The \fI<trace.h>\fP header shall define the following symbols:
  51 .LP
  52 .sp
  53 POSIX_TRACE_ALL_EVENTS
  54 .br
  55 .sp
  56 POSIX_TRACE_APPEND
  57 .br
  58 .sp
  59 .sp
  60 POSIX_TRACE_CLOSE_FOR_CHILD
  61 .br
  62 .sp
  63 .sp
  64 POSIX_TRACE_FILTER
  65 .br
  66 .sp
  67 .sp
  68 POSIX_TRACE_FLUSH
  69 .br
  70 POSIX_TRACE_FLUSH_START
  71 .br
  72 POSIX_TRACE_FLUSH_STOP
  73 .br
  74 POSIX_TRACE_FLUSHING
  75 .br
  76 .sp
  77 POSIX_TRACE_FULL
  78 .br
  79 POSIX_TRACE_LOOP
  80 .br
  81 POSIX_TRACE_NO_OVERRUN
  82 .br
  83 .sp
  84 POSIX_TRACE_NOT_FLUSHING
  85 .br
  86 .sp
  87 POSIX_TRACE_NOT_FULL
  88 .br
  89 .sp
  90 POSIX_TRACE_INHERITED
  91 .br
  92 .sp
  93 POSIX_TRACE_NOT_TRUNCATED
  94 .br
  95 POSIX_TRACE_OVERFLOW
  96 .br
  97 POSIX_TRACE_OVERRUN
  98 .br
  99 POSIX_TRACE_RESUME
 100 .br
 101 POSIX_TRACE_RUNNING
 102 .br
 103 POSIX_TRACE_START
 104 .br
 105 POSIX_TRACE_STOP
 106 .br
 107 POSIX_TRACE_SUSPENDED
 108 .br
 109 POSIX_TRACE_SYSTEM_EVENTS
 110 .br
 111 POSIX_TRACE_TRUNCATED_READ
 112 .br
 113 POSIX_TRACE_TRUNCATED_RECORD
 114 .br
 115 POSIX_TRACE_UNNAMED_USER_EVENT
 116 .br
 117 POSIX_TRACE_UNTIL_FULL
 118 .br
 119 POSIX_TRACE_WOPID_EVENTS
 120 .br
 121 .LP
 122 The following types shall be defined as described in \fI<sys/types.h>\fP
 123 :
 124 .LP
 125 .sp
 126 \fBtrace_attr_t\fP
 127 .br
 128 \fBtrace_id_t\fP
 129 .br
 130 \fBtrace_event_id_t\fP
 131 .br
 132 .sp
 133 \fBtrace_event_set_t\fP
 134 .br
 135 .sp
 136 .LP
 137 The following shall be declared as functions and may also be defined
 138 as macros. Function prototypes shall be provided.
 139 .sp
 140 .RS
 141 .nf
 142
 143 \fBint  posix_trace_attr_destroy(trace_attr_t *);
 144 int  posix_trace_attr_getclockres(const trace_attr_t *,
 145          struct timespec *);
 146 int  posix_trace_attr_getcreatetime(const trace_attr_t *,
 147          struct timespec *);
 148 int  posix_trace_attr_getgenversion(const trace_attr_t *, char *);
 149
 150 int  posix_trace_attr_getinherited(const trace_attr_t *restrict,
 151          int *restrict);
 152
 153
 154 int  posix_trace_attr_getlogfullpolicy(const trace_attr_t *restrict,
 155          int *restrict);
 156 int  posix_trace_attr_getlogsize(const trace_attr_t *restrict,
 157          size_t *restrict);
 158
 159 int  posix_trace_attr_getmaxdatasize(const trace_attr_t *restrict,
 160          size_t *restrict);
 161 int  posix_trace_attr_getmaxsystemeventsize(const trace_attr_t *restrict,
 162          size_t *restrict);
 163 int  posix_trace_attr_getmaxusereventsize(const trace_attr_t *restrict,
 164          size_t, size_t *restrict);
 165 int  posix_trace_attr_getname(const trace_attr_t *, char *);
 166 int  posix_trace_attr_getstreamfullpolicy(const trace_attr_t *restrict,
 167          int *restrict);
 168 int  posix_trace_attr_getstreamsize(const trace_attr_t *restrict,
 169          size_t *restrict);
 170 int  posix_trace_attr_init(trace_attr_t *);
 171
 172 int  posix_trace_attr_setinherited(trace_attr_t *, int);
 173
 174
 175 int  posix_trace_attr_setlogfullpolicy(trace_attr_t *, int);
 176 int  posix_trace_attr_setlogsize(trace_attr_t *, size_t);
 177
 178 int  posix_trace_attr_setmaxdatasize(trace_attr_t *, size_t);
 179 int  posix_trace_attr_setname(trace_attr_t *, const char *);
 180 int  posix_trace_attr_setstreamsize(trace_attr_t *, size_t);
 181 int  posix_trace_attr_setstreamfullpolicy(trace_attr_t *, int);
 182 int  posix_trace_clear(trace_id_t);
 183
 184 int  posix_trace_close(trace_id_t);
 185
 186 int  posix_trace_create(pid_t, const trace_attr_t *restrict,
 187          trace_id_t *restrict);
 188
 189 int  posix_trace_create_withlog(pid_t, const trace_attr_t *restrict,
 190          int, trace_id_t *restrict);
 191
 192 void posix_trace_event(trace_event_id_t, const void *restrict, size_t);
 193 int  posix_trace_eventid_equal(trace_id_t, trace_event_id_t,
 194          trace_event_id_t);
 195 int  posix_trace_eventid_get_name(trace_id_t, trace_event_id_t, char *);
 196 int  posix_trace_eventid_open(const char *restrict,
 197          trace_event_id_t *restrict);
 198
 199 int  posix_trace_eventset_add(trace_event_id_t, trace_event_set_t *);
 200 int  posix_trace_eventset_del(trace_event_id_t, trace_event_set_t *);
 201 int  posix_trace_eventset_empty(trace_event_set_t *);
 202 int  posix_trace_eventset_fill(trace_event_set_t *, int);
 203 int  posix_trace_eventset_ismember(trace_event_id_t,
 204          const trace_event_set_t *restrict, int *restrict);
 205
 206 int  posix_trace_eventtypelist_getnext_id(trace_id_t,
 207          trace_event_id_t *restrict, int *restrict);
 208 int  posix_trace_eventtypelist_rewind(trace_id_t);
 209
 210 int  posix_trace_flush(trace_id_t);
 211
 212 int  posix_trace_get_attr(trace_id_t, trace_attr_t *);
 213
 214 int  posix_trace_get_filter(trace_id_t, trace_event_set_t *);
 215
 216 int  posix_trace_get_status(trace_id_t,
 217          struct posix_trace_status_info *);
 218 int  posix_trace_getnext_event(trace_id_t,
 219          struct posix_trace_event_info *restrict , void *restrict,
 220          size_t, size_t *restrict, int *restrict);
 221
 222 int  posix_trace_open(int, trace_id_t *);
 223 int  posix_trace_rewind(trace_id_t);
 224
 225
 226 int  posix_trace_set_filter(trace_id_t, const trace_event_set_t *, int);
 227
 228 int  posix_trace_shutdown(trace_id_t);
 229 int  posix_trace_start(trace_id_t);
 230 int  posix_trace_stop(trace_id_t);
 231
 232 int  posix_trace_timedgetnext_event(trace_id_t,
 233          struct posix_trace_event_info *restrict, void *restrict,
 234          size_t, size_t *restrict, int *restrict,
 235          const struct timespec *restrict);
 236
 237
 238 int  posix_trace_trid_eventid_open(trace_id_t, const char *restrict,
 239          trace_event_id_t *restrict);
 240
 241 int  posix_trace_trygetnext_event(trace_id_t,
 242          struct posix_trace_event_info *restrict, void *restrict, size_t,
 243          size_t *restrict, int *restrict);
 244 \fP
 245 .fi
 246 .RE
 247 .LP
 248 \fIThe following sections are informative.\fP
 249 .SH APPLICATION USAGE
 250 .LP
 251 None.
 252 .SH RATIONALE
 253 .LP
 254 None.
 255 .SH FUTURE DIRECTIONS
 256 .LP
 257 None.
 258 .SH SEE ALSO
 259 .LP
 260 \fI<sys/types.h>\fP , the System Interfaces volume of IEEE\ Std\ 1003.1-2001,
 261 Section 2.11, Tracing, \fIposix_trace_attr_destroy\fP(), \fIposix_trace_attr_getclockres\fP(),
 262 \fIposix_trace_attr_getcreatetime\fP(), \fIposix_trace_attr_getgenversion\fP(),
 263 \fIposix_trace_attr_getinherited\fP(), \fIposix_trace_attr_getlogfullpolicy\fP(),
 264 \fIposix_trace_attr_getlogsize\fP(), \fIposix_trace_attr_getmaxdatasize\fP(),
 265 \fIposix_trace_attr_getmaxsystemeventsize\fP(), \fIposix_trace_attr_getmaxusereventsize\fP(),
 266 \fIposix_trace_attr_getname\fP(), \fIposix_trace_attr_getstreamfullpolicy\fP(),
 267 \fIposix_trace_attr_getstreamsize\fP(), \fIposix_trace_attr_init\fP(),
 268 \fIposix_trace_attr_setinherited\fP(), \fIposix_trace_attr_setlogfullpolicy\fP(),
 269 \fIposix_trace_attr_setlogsize\fP(), \fIposix_trace_attr_setmaxdatasize\fP(),
 270 \fIposix_trace_attr_setname\fP(), \fIposix_trace_attr_setstreamsize\fP(),
 271 \fIposix_trace_attr_setstreamfullpolicy\fP(), \fIposix_trace_clear\fP(),
 272 \fIposix_trace_close\fP(), \fIposix_trace_create\fP(), \fIposix_trace_create_withlog\fP(),
 273 \fIposix_trace_event\fP(), \fIposix_trace_eventid_equal\fP(), \fIposix_trace_eventid_get_name\fP(),
 274 \fIposix_trace_eventid_open\fP(), \fIposix_trace_eventtypelist_getnext_id\fP(),
 275 \fIposix_trace_eventtypelist_rewind\fP(), \fIposix_trace_eventset_add\fP(),
 276 \fIposix_trace_eventset_del\fP(), \fIposix_trace_eventset_empty\fP(),
 277 \fIposix_trace_eventset_fill\fP(), \fIposix_trace_eventset_ismember\fP(),
 278 \fIposix_trace_flush\fP(), \fIposix_trace_get_attr\fP(), \fIposix_trace_get_filter\fP(),
 279 \fIposix_trace_get_status\fP(), \fIposix_trace_getnext_event\fP(),
 280 \fIposix_trace_open\fP(), \fIposix_trace_rewind\fP(), \fIposix_trace_set_filter\fP(),
 281 \fIposix_trace_shutdown\fP(), \fIposix_trace_start\fP(), \fIposix_trace_stop\fP(),
 282 \fIposix_trace_timedgetnext_event\fP(), \fIposix_trace_trid_eventid_open\fP(),
 283 \fIposix_trace_trygetnext_event\fP()
 284 .SH COPYRIGHT
 285 Portions of this text are reprinted and reproduced in electronic form
 286 from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology
 287 -- Portable Operating System Interface (POSIX), The Open Group Base
 288 Specifications Issue 6, Copyright (C) 2001-2003 by the Institute of
 289 Electrical and Electronics Engineers, Inc and The Open Group. In the
 290 event of any discrepancy between this version and the original IEEE and
 291 The Open Group Standard, the original IEEE and The Open Group Standard
 292 is the referee document. The original Standard can be obtained online at
 293 http://www.opengroup.org/unix/online.html .