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 "compat/limits.h" /* IWYU pragma: keep */
16 #define LTTNG_VIEWER_PATH_MAX 4096
17 #define LTTNG_VIEWER_NAME_MAX 255
18 #define LTTNG_VIEWER_HOST_NAME_MAX 64
20 /* Flags in reply to get_next_index and get_packet. */
23 /* New metadata is required to read this packet. */
24 LTTNG_VIEWER_FLAG_NEW_METADATA = (1 << 0),
25 /* New stream got added to the trace. */
26 LTTNG_VIEWER_FLAG_NEW_STREAM = (1 << 1),
29 enum lttng_viewer_command
31 LTTNG_VIEWER_CONNECT = 1,
32 LTTNG_VIEWER_LIST_SESSIONS = 2,
33 LTTNG_VIEWER_ATTACH_SESSION = 3,
34 LTTNG_VIEWER_GET_NEXT_INDEX = 4,
35 LTTNG_VIEWER_GET_PACKET = 5,
36 LTTNG_VIEWER_GET_METADATA = 6,
37 LTTNG_VIEWER_GET_NEW_STREAMS = 7,
38 LTTNG_VIEWER_CREATE_SESSION = 8,
39 LTTNG_VIEWER_DETACH_SESSION = 9,
42 enum lttng_viewer_attach_return_code
44 LTTNG_VIEWER_ATTACH_OK = 1, /* The attach command succeeded. */
45 LTTNG_VIEWER_ATTACH_ALREADY = 2, /* A viewer is already attached. */
46 LTTNG_VIEWER_ATTACH_UNK = 3, /* The session ID is unknown. */
47 LTTNG_VIEWER_ATTACH_NOT_LIVE = 4, /* The session is not live. */
48 LTTNG_VIEWER_ATTACH_SEEK_ERR = 5, /* Seek error. */
49 LTTNG_VIEWER_ATTACH_NO_SESSION = 6, /* No viewer session created. */
52 enum lttng_viewer_detach_session_return_code
54 LTTNG_VIEWER_DETACH_SESSION_OK = 1,
55 LTTNG_VIEWER_DETACH_SESSION_UNK = 2,
56 LTTNG_VIEWER_DETACH_SESSION_ERR = 3,
59 enum lttng_viewer_next_index_return_code
61 LTTNG_VIEWER_INDEX_OK = 1, /* Index is available. */
62 LTTNG_VIEWER_INDEX_RETRY = 2, /* Index not yet available. */
63 LTTNG_VIEWER_INDEX_HUP = 3, /* Index closed (trace destroyed). */
64 LTTNG_VIEWER_INDEX_ERR = 4, /* Unknow error. */
65 LTTNG_VIEWER_INDEX_INACTIVE = 5, /* Inactive stream beacon. */
66 LTTNG_VIEWER_INDEX_EOF = 6, /* End of index file. */
69 enum lttng_viewer_get_packet_return_code
71 LTTNG_VIEWER_GET_PACKET_OK = 1,
72 LTTNG_VIEWER_GET_PACKET_RETRY = 2,
73 LTTNG_VIEWER_GET_PACKET_ERR = 3,
74 LTTNG_VIEWER_GET_PACKET_EOF = 4,
77 enum lttng_viewer_get_metadata_return_code
79 LTTNG_VIEWER_METADATA_OK = 1,
80 LTTNG_VIEWER_NO_NEW_METADATA = 2,
81 LTTNG_VIEWER_METADATA_ERR = 3,
84 enum lttng_viewer_connection_type
86 LTTNG_VIEWER_CLIENT_COMMAND = 1,
87 LTTNG_VIEWER_CLIENT_MESSAGE = 2,
90 enum lttng_viewer_seek
92 /* Receive the trace packets from the beginning. */
93 LTTNG_VIEWER_SEEK_BEGINNING = 1,
94 /* Receive the trace packets from now. */
95 LTTNG_VIEWER_SEEK_LAST = 2,
98 enum lttng_viewer_new_streams_return_code
100 LTTNG_VIEWER_NEW_STREAMS_OK = 1, /* If new streams are being sent. */
101 LTTNG_VIEWER_NEW_STREAMS_NO_NEW = 2, /* If no new streams are available. */
102 LTTNG_VIEWER_NEW_STREAMS_ERR = 3, /* Error. */
103 LTTNG_VIEWER_NEW_STREAMS_HUP = 4, /* Session closed. */
106 enum lttng_viewer_create_session_return_code
108 LTTNG_VIEWER_CREATE_SESSION_OK = 1,
109 LTTNG_VIEWER_CREATE_SESSION_ERR = 2,
112 struct lttng_viewer_session
118 char hostname[LTTNG_VIEWER_HOST_NAME_MAX];
119 char session_name[LTTNG_VIEWER_NAME_MAX];
120 } __attribute__((__packed__));
122 struct lttng_viewer_stream
125 uint64_t ctf_trace_id;
126 uint32_t metadata_flag;
127 char path_name[LTTNG_VIEWER_PATH_MAX];
128 char channel_name[LTTNG_VIEWER_NAME_MAX];
129 } __attribute__((__packed__));
131 struct lttng_viewer_cmd
133 uint64_t data_size; /* data size following this header */
134 uint32_t cmd; /* enum lttcomm_relayd_command */
135 uint32_t cmd_version; /* command version */
136 } __attribute__((__packed__));
139 * LTTNG_VIEWER_CONNECT payload.
141 struct lttng_viewer_connect
143 /* session ID assigned by the relay for command connections */
144 uint64_t viewer_session_id;
147 uint32_t type; /* enum lttng_viewer_connection_type */
148 } __attribute__((__packed__));
151 * LTTNG_VIEWER_LIST_SESSIONS payload.
153 struct lttng_viewer_list_sessions
155 uint32_t sessions_count;
156 char session_list[]; /* struct lttng_viewer_session */
157 } __attribute__((__packed__));
160 * LTTNG_VIEWER_ATTACH_SESSION payload.
162 struct lttng_viewer_attach_session_request
165 uint64_t offset; /* unused for now */
166 uint32_t seek; /* enum lttng_viewer_seek */
167 } __attribute__((__packed__));
169 struct lttng_viewer_attach_session_response
171 /* enum lttng_viewer_attach_return_code */
173 uint32_t streams_count;
174 /* struct lttng_viewer_stream */
176 } __attribute__((__packed__));
179 * LTTNG_VIEWER_GET_NEXT_INDEX payload.
181 struct lttng_viewer_get_next_index
184 } __attribute__((__packed__));
186 struct lttng_viewer_index
189 uint64_t packet_size;
190 uint64_t content_size;
191 uint64_t timestamp_begin;
192 uint64_t timestamp_end;
193 uint64_t events_discarded;
195 uint32_t status; /* enum lttng_viewer_next_index_return_code */
196 uint32_t flags; /* LTTNG_VIEWER_FLAG_* */
197 } __attribute__((__packed__));
200 * LTTNG_VIEWER_GET_PACKET payload.
202 struct lttng_viewer_get_packet
207 } __attribute__((__packed__));
209 struct lttng_viewer_trace_packet
211 uint32_t status; /* enum lttng_viewer_get_packet_return_code */
213 uint32_t flags; /* LTTNG_VIEWER_FLAG_* */
215 } __attribute__((__packed__));
218 * LTTNG_VIEWER_GET_METADATA payload.
220 struct lttng_viewer_get_metadata
223 } __attribute__((__packed__));
225 struct lttng_viewer_metadata_packet
228 uint32_t status; /* enum lttng_viewer_get_metadata_return_code */
230 } __attribute__((__packed__));
233 * LTTNG_VIEWER_GET_NEW_STREAMS payload.
235 struct lttng_viewer_new_streams_request
238 } __attribute__((__packed__));
240 struct lttng_viewer_new_streams_response
242 /* enum lttng_viewer_new_streams_return_code */
244 uint32_t streams_count;
245 /* struct lttng_viewer_stream */
247 } __attribute__((__packed__));
249 struct lttng_viewer_create_session_response
251 /* enum lttng_viewer_create_session_return_code */
253 } __attribute__((__packed__));
256 * LTTNG_VIEWER_DETACH_SESSION payload.
258 struct lttng_viewer_detach_session_request
261 } __attribute__((__packed__));
263 struct lttng_viewer_detach_session_response
265 /* enum lttng_viewer_detach_session_return_code */
267 } __attribute__((__packed__));
269 #endif /* LTTNG_VIEWER_ABI_H */