2 * SPDX-License-Identifier: MIT
4 * Copyright (C) 2013 Julien Desfossez <jdesfossez@efficios.com>
5 * Copyright (C) 2013 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
6 * Copyright (C) 2013 David Goulet <dgoulet@efficios.com>
9 #ifndef LTTNG_VIEWER_ABI_H
10 #define LTTNG_VIEWER_ABI_H
14 #include "common/common.h"
15 #include "compat/limits.h" /* IWYU pragma: keep */
16 #include "cpp-common/vendor/fmt/format.h" /* IWYU pragma: keep */
18 #define LTTNG_VIEWER_PATH_MAX 4096
19 #define LTTNG_VIEWER_NAME_MAX 255
20 #define LTTNG_VIEWER_HOST_NAME_MAX 64
22 /* Flags in reply to get_next_index and get_packet. */
25 /* New metadata is required to read this packet. */
26 LTTNG_VIEWER_FLAG_NEW_METADATA = (1 << 0),
27 /* New stream got added to the trace. */
28 LTTNG_VIEWER_FLAG_NEW_STREAM = (1 << 1),
31 enum lttng_viewer_command
33 LTTNG_VIEWER_CONNECT = 1,
34 LTTNG_VIEWER_LIST_SESSIONS = 2,
35 LTTNG_VIEWER_ATTACH_SESSION = 3,
36 LTTNG_VIEWER_GET_NEXT_INDEX = 4,
37 LTTNG_VIEWER_GET_PACKET = 5,
38 LTTNG_VIEWER_GET_METADATA = 6,
39 LTTNG_VIEWER_GET_NEW_STREAMS = 7,
40 LTTNG_VIEWER_CREATE_SESSION = 8,
41 LTTNG_VIEWER_DETACH_SESSION = 9,
44 inline const char *format_as(const lttng_viewer_command cmd) noexcept
47 case LTTNG_VIEWER_CONNECT:
50 case LTTNG_VIEWER_LIST_SESSIONS:
51 return "LIST_SESSIONS";
53 case LTTNG_VIEWER_ATTACH_SESSION:
54 return "ATTACH_SESSION";
56 case LTTNG_VIEWER_GET_NEXT_INDEX:
57 return "GET_NEXT_INDEX";
59 case LTTNG_VIEWER_GET_PACKET:
62 case LTTNG_VIEWER_GET_METADATA:
63 return "GET_METADATA";
65 case LTTNG_VIEWER_GET_NEW_STREAMS:
66 return "GET_NEW_STREAMS";
68 case LTTNG_VIEWER_CREATE_SESSION:
69 return "CREATE_SESSION";
71 case LTTNG_VIEWER_DETACH_SESSION:
72 return "DETACH_SESSION";
78 enum lttng_viewer_attach_return_code
80 LTTNG_VIEWER_ATTACH_OK = 1, /* The attach command succeeded. */
81 LTTNG_VIEWER_ATTACH_ALREADY = 2, /* A viewer is already attached. */
82 LTTNG_VIEWER_ATTACH_UNK = 3, /* The session ID is unknown. */
83 LTTNG_VIEWER_ATTACH_NOT_LIVE = 4, /* The session is not live. */
84 LTTNG_VIEWER_ATTACH_SEEK_ERR = 5, /* Seek error. */
85 LTTNG_VIEWER_ATTACH_NO_SESSION = 6, /* No viewer session created. */
88 enum lttng_viewer_detach_session_return_code
90 LTTNG_VIEWER_DETACH_SESSION_OK = 1,
91 LTTNG_VIEWER_DETACH_SESSION_UNK = 2,
92 LTTNG_VIEWER_DETACH_SESSION_ERR = 3,
95 enum lttng_viewer_next_index_return_code
97 LTTNG_VIEWER_INDEX_OK = 1, /* Index is available. */
98 LTTNG_VIEWER_INDEX_RETRY = 2, /* Index not yet available. */
99 LTTNG_VIEWER_INDEX_HUP = 3, /* Index closed (trace destroyed). */
100 LTTNG_VIEWER_INDEX_ERR = 4, /* Unknow error. */
101 LTTNG_VIEWER_INDEX_INACTIVE = 5, /* Inactive stream beacon. */
102 LTTNG_VIEWER_INDEX_EOF = 6, /* End of index file. */
105 inline const char *format_as(const lttng_viewer_next_index_return_code code) noexcept
108 case LTTNG_VIEWER_INDEX_OK:
111 case LTTNG_VIEWER_INDEX_RETRY:
112 return "INDEX_RETRY";
114 case LTTNG_VIEWER_INDEX_HUP:
117 case LTTNG_VIEWER_INDEX_ERR:
120 case LTTNG_VIEWER_INDEX_INACTIVE:
121 return "INDEX_INACTIVE";
123 case LTTNG_VIEWER_INDEX_EOF:
130 enum lttng_viewer_get_packet_return_code
132 LTTNG_VIEWER_GET_PACKET_OK = 1,
133 LTTNG_VIEWER_GET_PACKET_RETRY = 2,
134 LTTNG_VIEWER_GET_PACKET_ERR = 3,
135 LTTNG_VIEWER_GET_PACKET_EOF = 4,
138 inline const char *format_as(const lttng_viewer_get_packet_return_code code) noexcept
141 case LTTNG_VIEWER_GET_PACKET_OK:
142 return "GET_PACKET_OK";
144 case LTTNG_VIEWER_GET_PACKET_RETRY:
145 return "GET_PACKET_RETRY";
147 case LTTNG_VIEWER_GET_PACKET_ERR:
148 return "GET_PACKET_ERR";
150 case LTTNG_VIEWER_GET_PACKET_EOF:
151 return "GET_PACKET_EOF";
157 enum lttng_viewer_get_metadata_return_code
159 LTTNG_VIEWER_METADATA_OK = 1,
160 LTTNG_VIEWER_NO_NEW_METADATA = 2,
161 LTTNG_VIEWER_METADATA_ERR = 3,
164 enum lttng_viewer_connection_type
166 LTTNG_VIEWER_CLIENT_COMMAND = 1,
167 LTTNG_VIEWER_CLIENT_MESSAGE = 2,
170 enum lttng_viewer_seek
172 /* Receive the trace packets from the beginning. */
173 LTTNG_VIEWER_SEEK_BEGINNING = 1,
174 /* Receive the trace packets from now. */
175 LTTNG_VIEWER_SEEK_LAST = 2,
178 inline const char *format_as(const lttng_viewer_seek seek) noexcept
181 case LTTNG_VIEWER_SEEK_BEGINNING:
182 return "SEEK_BEGINNING";
184 case LTTNG_VIEWER_SEEK_LAST:
191 enum lttng_viewer_new_streams_return_code
193 LTTNG_VIEWER_NEW_STREAMS_OK = 1, /* If new streams are being sent. */
194 LTTNG_VIEWER_NEW_STREAMS_NO_NEW = 2, /* If no new streams are available. */
195 LTTNG_VIEWER_NEW_STREAMS_ERR = 3, /* Error. */
196 LTTNG_VIEWER_NEW_STREAMS_HUP = 4, /* Session closed. */
199 enum lttng_viewer_create_session_return_code
201 LTTNG_VIEWER_CREATE_SESSION_OK = 1,
202 LTTNG_VIEWER_CREATE_SESSION_ERR = 2,
205 struct lttng_viewer_session
211 char hostname[LTTNG_VIEWER_HOST_NAME_MAX];
212 char session_name[LTTNG_VIEWER_NAME_MAX];
213 } __attribute__((__packed__));
215 struct lttng_viewer_stream
218 uint64_t ctf_trace_id;
219 uint32_t metadata_flag;
220 char path_name[LTTNG_VIEWER_PATH_MAX];
221 char channel_name[LTTNG_VIEWER_NAME_MAX];
222 } __attribute__((__packed__));
224 struct lttng_viewer_cmd
226 uint64_t data_size; /* data size following this header */
227 uint32_t cmd; /* enum lttcomm_relayd_command */
228 uint32_t cmd_version; /* command version */
229 } __attribute__((__packed__));
232 * LTTNG_VIEWER_CONNECT payload.
234 struct lttng_viewer_connect
236 /* session ID assigned by the relay for command connections */
237 uint64_t viewer_session_id;
240 uint32_t type; /* enum lttng_viewer_connection_type */
241 } __attribute__((__packed__));
244 * LTTNG_VIEWER_LIST_SESSIONS payload.
246 struct lttng_viewer_list_sessions
248 uint32_t sessions_count;
249 char session_list[]; /* struct lttng_viewer_session */
250 } __attribute__((__packed__));
253 * LTTNG_VIEWER_ATTACH_SESSION payload.
255 struct lttng_viewer_attach_session_request
258 uint64_t offset; /* unused for now */
259 uint32_t seek; /* enum lttng_viewer_seek */
260 } __attribute__((__packed__));
262 struct lttng_viewer_attach_session_response
264 /* enum lttng_viewer_attach_return_code */
266 uint32_t streams_count;
267 /* struct lttng_viewer_stream */
269 } __attribute__((__packed__));
272 * LTTNG_VIEWER_GET_NEXT_INDEX payload.
274 struct lttng_viewer_get_next_index
277 } __attribute__((__packed__));
279 struct lttng_viewer_index
282 uint64_t packet_size;
283 uint64_t content_size;
284 uint64_t timestamp_begin;
285 uint64_t timestamp_end;
286 uint64_t events_discarded;
288 uint32_t status; /* enum lttng_viewer_next_index_return_code */
289 uint32_t flags; /* LTTNG_VIEWER_FLAG_* */
290 } __attribute__((__packed__));
293 * LTTNG_VIEWER_GET_PACKET payload.
295 struct lttng_viewer_get_packet
300 } __attribute__((__packed__));
302 struct lttng_viewer_trace_packet
304 uint32_t status; /* enum lttng_viewer_get_packet_return_code */
306 uint32_t flags; /* LTTNG_VIEWER_FLAG_* */
308 } __attribute__((__packed__));
311 * LTTNG_VIEWER_GET_METADATA payload.
313 struct lttng_viewer_get_metadata
316 } __attribute__((__packed__));
318 struct lttng_viewer_metadata_packet
321 uint32_t status; /* enum lttng_viewer_get_metadata_return_code */
323 } __attribute__((__packed__));
326 * LTTNG_VIEWER_GET_NEW_STREAMS payload.
328 struct lttng_viewer_new_streams_request
331 } __attribute__((__packed__));
333 struct lttng_viewer_new_streams_response
335 /* enum lttng_viewer_new_streams_return_code */
337 uint32_t streams_count;
338 /* struct lttng_viewer_stream */
340 } __attribute__((__packed__));
342 struct lttng_viewer_create_session_response
344 /* enum lttng_viewer_create_session_return_code */
346 } __attribute__((__packed__));
349 * LTTNG_VIEWER_DETACH_SESSION payload.
351 struct lttng_viewer_detach_session_request
354 } __attribute__((__packed__));
356 struct lttng_viewer_detach_session_response
358 /* enum lttng_viewer_detach_session_return_code */
360 } __attribute__((__packed__));
362 #endif /* LTTNG_VIEWER_ABI_H */