ltt-context: document that pointers may change
[lttng-ust.git] / include / ust / lttng-ust-abi.h
CommitLineData
9f3fdbc6
MD
1#ifndef _LTTNG_UST_ABI_H
2#define _LTTNG_UST_ABI_H
3
4/*
5 * lttng-ust-abi.h
6 *
7 * Copyright 2010-2011 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
8 *
9 * LTTng-UST ABI header
10 *
11 * Dual LGPL v2.1/GPL v2 license.
12 */
13
14#define LTTNG_UST_SYM_NAME_LEN 128
15
16enum lttng_ust_instrumentation {
17 LTTNG_UST_TRACEPOINT = 0,
18};
19
20/*
21 * LTTng consumer mode
22 */
23enum lttng_ust_output {
24 LTTNG_UST_MMAP = 0,
25};
26
27/*
28 * LTTng DebugFS ABI structures.
29 */
30
31struct lttng_ust_channel {
32 int overwrite; /* 1: overwrite, 0: discard */
33 uint64_t subbuf_size; /* in bytes */
34 uint64_t num_subbuf;
35 unsigned int switch_timer_interval; /* usecs */
36 unsigned int read_timer_interval; /* usecs */
37 enum lttng_ust_output output; /* mmap */
38};
39
40struct lttng_ust_event {
41 char name[LTTNG_UST_SYM_NAME_LEN]; /* event name */
42 enum lttng_ust_instrumentation instrumentation;
43 /* Per instrumentation type configuration */
44 union {
45 } u;
46};
47
48struct lttng_ust_tracer_version {
49 uint32_t version;
50 uint32_t patchlevel;
51 uint32_t sublevel;
52};
53
54enum lttng_ust_context_type {
55 LTTNG_UST_CONTEXT_VTID = 0,
56};
57
58struct lttng_ust_context {
59 enum lttng_ust_context_type ctx;
60 union {
61 } u;
62};
63
64#define _UST_CMD(minor) (minor)
65#define _UST_CMDR(minor, type) (minor)
66#define _UST_CMDW(minor, type) (minor)
67
68/* LTTng-UST commands */
69#define LTTNG_UST_SESSION _UST_CMD(0x40)
70#define LTTNG_UST_TRACER_VERSION \
71 _UST_CMDR(0x41, struct lttng_ust_tracer_version)
72#define LTTNG_UST_TRACEPOINT_LIST _UST_CMD(0x42)
73#define LTTNG_UST_WAIT_QUIESCENT _UST_CMD(0x43)
74
75/* Session FD ioctl */
76#define LTTNG_UST_METADATA \
77 _UST_CMDW(0x50, struct lttng_ust_channel)
78#define LTTNG_UST_CHANNEL \
79 _UST_CMDW(0x51, struct lttng_ust_channel)
80#define LTTNG_UST_SESSION_START _UST_CMD(0x52)
81#define LTTNG_UST_SESSION_STOP _UST_CMD(0x53)
82
83/* Channel FD ioctl */
84#define LTTNG_UST_STREAM _UST_CMD(0x60)
85#define LTTNG_UST_EVENT \
86 _UST_CMDW(0x61, struct lttng_ust_event)
87
88/* Event and Channel FD ioctl */
89#define LTTNG_UST_CONTEXT \
90 _UST_CMDW(0x70, struct lttng_ust_context)
91
92/* Event, Channel and Session ioctl */
93#define LTTNG_UST_ENABLE _UST_CMD(0x80)
94#define LTTNG_UST_DISABLE _UST_CMD(0x81)
95
96#endif /* _LTTNG_UST_ABI_H */
This page took 0.027534 seconds and 4 git commands to generate.