Tests: Add test_utils_expand_path to unit tests
[lttng-tools.git] / src / bin / lttng-relayd / lttng-viewer.h
CommitLineData
d3e2ba59
JD
1/*
2 * Copyright (C) 2013 - Julien Desfossez <jdesfossez@efficios.com>
c404302f 3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
d3e2ba59
JD
4 * David Goulet <dgoulet@efficios.com>
5 *
c404302f
JD
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
d3e2ba59 12 *
c404302f
JD
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
d3e2ba59 15 *
c404302f
JD
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 * SOFTWARE.
d3e2ba59
JD
23 */
24
25#ifndef LTTNG_VIEWER_H
26#define LTTNG_VIEWER_H
27
28#include <limits.h>
29
30#define LTTNG_VIEWER_PATH_MAX 4096
31#define LTTNG_VIEWER_NAME_MAX 255
32#define LTTNG_VIEWER_HOST_NAME_MAX 64
33
34/* Flags in reply to get_next_index and get_packet. */
35/* New metadata is required to read this packet. */
36#define LTTNG_VIEWER_FLAG_NEW_METADATA (1 << 0)
37/* New stream got added to the trace */
38#define LTTNG_VIEWER_FLAG_NEW_STREAM (1 << 1)
39
40enum lttng_viewer_command {
41 VIEWER_CONNECT = 1,
42 VIEWER_LIST_SESSIONS = 2,
43 VIEWER_ATTACH_SESSION = 3,
44 VIEWER_GET_NEXT_INDEX = 4,
45 VIEWER_GET_PACKET = 5,
46 VIEWER_GET_METADATA = 6,
47};
48
49enum lttng_viewer_attach_return_code {
50 VIEWER_ATTACH_OK = 1, /* If the attach command succeeded. */
51 VIEWER_ATTACH_ALREADY = 2, /* If a viewer is already attached. */
52 VIEWER_ATTACH_UNK = 3, /* If the session ID is unknown. */
53 VIEWER_ATTACH_NOT_LIVE = 4, /* If the session is not live. */
54 VIEWER_ATTACH_SEEK_ERR = 5, /* Seek error. */
55};
56
57enum lttng_viewer_next_index_return_code {
58 VIEWER_INDEX_OK = 1, /* Index is available. */
59 VIEWER_INDEX_RETRY = 2, /* Index not yet available. */
60 VIEWER_INDEX_HUP = 3, /* Index closed (trace destroyed). */
61 VIEWER_INDEX_ERR = 4, /* Unknow error. */
62 VIEWER_INDEX_INACTIVE = 5, /* Inactive stream beacon. */
6b6b9a5a 63 VIEWER_INDEX_EOF = 6, /* End of index file. */
d3e2ba59
JD
64};
65
66enum lttng_viewer_get_packet_return_code {
67 VIEWER_GET_PACKET_OK = 1,
68 VIEWER_GET_PACKET_RETRY = 2,
69 VIEWER_GET_PACKET_ERR = 3,
6b6b9a5a 70 VIEWER_GET_PACKET_EOF = 4,
d3e2ba59
JD
71};
72
73enum lttng_viewer_get_metadata_return_code {
74 VIEWER_METADATA_OK = 1,
75 VIEWER_NO_NEW_METADATA = 2,
76 VIEWER_METADATA_ERR = 3,
77};
78
79enum lttng_viewer_connection_type {
80 VIEWER_CLIENT_COMMAND = 1,
81 VIEWER_CLIENT_NOTIFICATION = 2,
82};
83
84enum lttng_viewer_seek {
85 VIEWER_SEEK_BEGINNING = 1, /* Receive the trace packets from the beginning. */
86 VIEWER_SEEK_LAST = 2, /* Receive the trace packets from now. */
87};
88
89struct lttng_viewer_session {
90 uint64_t id;
91 char hostname[LTTNG_VIEWER_HOST_NAME_MAX];
92 char session_name[LTTNG_VIEWER_NAME_MAX];
93 uint32_t live_timer;
94 uint32_t clients;
87b576ec 95 uint32_t streams;
d3e2ba59
JD
96} __attribute__((__packed__));
97
98struct lttng_viewer_stream {
99 uint64_t id;
100 uint64_t ctf_trace_id;
101 char path_name[LTTNG_VIEWER_PATH_MAX];
102 char channel_name[LTTNG_VIEWER_NAME_MAX];
103 int metadata_flag;
104} __attribute__((__packed__));
105
106struct lttng_viewer_cmd {
107 uint64_t data_size; /* data size following this header */
108 uint32_t cmd; /* enum lttcomm_relayd_command */
109 uint32_t cmd_version; /* command version */
110} __attribute__((__packed__));
111
112/*
113 * CONNECT payload.
114 */
115struct lttng_viewer_connect {
116 uint32_t major;
117 uint32_t minor;
118 uint32_t type; /* enum lttng_viewer_connection_type */
119 uint64_t viewer_session_id; /* session ID assigned by the relay for command connections */
120} __attribute__((__packed__));
121
122/*
123 * VIEWER_LIST_SESSIONS payload.
124 */
125struct lttng_viewer_list_sessions {
126 uint32_t sessions_count;
127 char session_list[]; /* struct lttng_viewer_session */
128} __attribute__((__packed__));
129
130/*
131 * VIEWER_ATTACH_SESSION payload.
132 */
133struct lttng_viewer_attach_session_request {
134 uint64_t session_id;
135 uint32_t seek; /* enum lttng_viewer_seek */
136 uint64_t offset; /* unused for now */
137} __attribute__((__packed__));
138
139struct lttng_viewer_attach_session_response {
140 uint32_t status; /* enum lttng_viewer_attach_return_code */
141 uint32_t streams_count;
142 char stream_list[]; /* struct lttng_viewer_stream */
143} __attribute__((__packed__));
144
145/*
146 * VIEWER_GET_NEXT_INDEX payload.
147 */
148struct lttng_viewer_get_next_index {
149 uint64_t stream_id;
150} __attribute__ ((__packed__));
151
152struct lttng_viewer_index {
153 uint32_t status; /* enum lttng_viewer_next_index_return_code */
154 uint64_t offset;
155 uint64_t packet_size;
156 uint64_t content_size;
157 uint64_t timestamp_begin;
158 uint64_t timestamp_end;
159 uint64_t events_discarded;
160 uint64_t stream_id;
161 uint32_t flags; /* LTTNG_VIEWER_FLAG_* */
162} __attribute__ ((__packed__));
163
164/*
165 * VIEWER_GET_PACKET payload.
166 */
167struct lttng_viewer_get_packet {
168 uint64_t stream_id;
169 uint64_t offset;
170 uint32_t len;
171} __attribute__((__packed__));
172
173struct lttng_viewer_trace_packet {
174 uint32_t status; /* enum lttng_viewer_get_packet_return_code */
175 uint32_t len;
176 uint32_t flags; /* LTTNG_VIEWER_FLAG_* */
177 char data[];
178} __attribute__((__packed__));
179
180/*
181 * VIEWER_GET_METADATA payload.
182 */
183struct lttng_viewer_get_metadata {
184 uint64_t stream_id;
185} __attribute__((__packed__));
186
187struct lttng_viewer_metadata_packet {
188 uint32_t status; /* enum lttng_viewer_get_metadata_return_code */
189 uint64_t len;
190 char data[];
191} __attribute__((__packed__));
192
193#endif /* LTTNG_VIEWER_H */
This page took 0.030031 seconds and 4 git commands to generate.