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
13 #include "compat/limits.h"
15 #define LTTNG_VIEWER_PATH_MAX 4096
16 #define LTTNG_VIEWER_NAME_MAX 255
17 #define LTTNG_VIEWER_HOST_NAME_MAX 64
19 /* Flags in reply to get_next_index and get_packet. */
22 /* New metadata is required to read this packet. */
23 LTTNG_VIEWER_FLAG_NEW_METADATA = (1 << 0),
24 /* New stream got added to the trace. */
25 LTTNG_VIEWER_FLAG_NEW_STREAM = (1 << 1),
28 enum lttng_viewer_command
30 LTTNG_VIEWER_CONNECT = 1,
31 LTTNG_VIEWER_LIST_SESSIONS = 2,
32 LTTNG_VIEWER_ATTACH_SESSION = 3,
33 LTTNG_VIEWER_GET_NEXT_INDEX = 4,
34 LTTNG_VIEWER_GET_PACKET = 5,
35 LTTNG_VIEWER_GET_METADATA = 6,
36 LTTNG_VIEWER_GET_NEW_STREAMS = 7,
37 LTTNG_VIEWER_CREATE_SESSION = 8,
38 LTTNG_VIEWER_DETACH_SESSION = 9,
41 enum lttng_viewer_attach_return_code
43 LTTNG_VIEWER_ATTACH_OK = 1, /* The attach command succeeded. */
44 LTTNG_VIEWER_ATTACH_ALREADY = 2, /* A viewer is already attached. */
45 LTTNG_VIEWER_ATTACH_UNK = 3, /* The session ID is unknown. */
46 LTTNG_VIEWER_ATTACH_NOT_LIVE = 4, /* The session is not live. */
47 LTTNG_VIEWER_ATTACH_SEEK_ERR = 5, /* Seek error. */
48 LTTNG_VIEWER_ATTACH_NO_SESSION = 6, /* No viewer session created. */
51 enum lttng_viewer_detach_session_return_code
53 LTTNG_VIEWER_DETACH_SESSION_OK = 1,
54 LTTNG_VIEWER_DETACH_SESSION_UNK = 2,
55 LTTNG_VIEWER_DETACH_SESSION_ERR = 3,
58 enum lttng_viewer_next_index_return_code
60 LTTNG_VIEWER_INDEX_OK = 1, /* Index is available. */
61 LTTNG_VIEWER_INDEX_RETRY = 2, /* Index not yet available. */
62 LTTNG_VIEWER_INDEX_HUP = 3, /* Index closed (trace destroyed). */
63 LTTNG_VIEWER_INDEX_ERR = 4, /* Unknow error. */
64 LTTNG_VIEWER_INDEX_INACTIVE = 5, /* Inactive stream beacon. */
65 LTTNG_VIEWER_INDEX_EOF = 6, /* End of index file. */
68 enum lttng_viewer_get_packet_return_code
70 LTTNG_VIEWER_GET_PACKET_OK = 1,
71 LTTNG_VIEWER_GET_PACKET_RETRY = 2,
72 LTTNG_VIEWER_GET_PACKET_ERR = 3,
73 LTTNG_VIEWER_GET_PACKET_EOF = 4,
76 enum lttng_viewer_get_metadata_return_code
78 LTTNG_VIEWER_METADATA_OK = 1,
79 LTTNG_VIEWER_NO_NEW_METADATA = 2,
80 LTTNG_VIEWER_METADATA_ERR = 3,
83 enum lttng_viewer_connection_type
85 LTTNG_VIEWER_CLIENT_COMMAND = 1,
86 LTTNG_VIEWER_CLIENT_MESSAGE = 2,
89 enum lttng_viewer_seek
91 /* Receive the trace packets from the beginning. */
92 LTTNG_VIEWER_SEEK_BEGINNING = 1,
93 /* Receive the trace packets from now. */
94 LTTNG_VIEWER_SEEK_LAST = 2,
97 enum lttng_viewer_new_streams_return_code
99 LTTNG_VIEWER_NEW_STREAMS_OK = 1, /* If new streams are being sent. */
100 LTTNG_VIEWER_NEW_STREAMS_NO_NEW = 2, /* If no new streams are available. */
101 LTTNG_VIEWER_NEW_STREAMS_ERR = 3, /* Error. */
102 LTTNG_VIEWER_NEW_STREAMS_HUP = 4, /* Session closed. */
105 enum lttng_viewer_create_session_return_code
107 LTTNG_VIEWER_CREATE_SESSION_OK = 1,
108 LTTNG_VIEWER_CREATE_SESSION_ERR = 2,
111 struct lttng_viewer_session
117 char hostname[LTTNG_VIEWER_HOST_NAME_MAX];
118 char session_name[LTTNG_VIEWER_NAME_MAX];
119 } __attribute__((__packed__));
121 struct lttng_viewer_stream
124 uint64_t ctf_trace_id;
125 uint32_t metadata_flag;
126 char path_name[LTTNG_VIEWER_PATH_MAX];
127 char channel_name[LTTNG_VIEWER_NAME_MAX];
128 } __attribute__((__packed__));
130 struct lttng_viewer_cmd
132 uint64_t data_size; /* data size following this header */
133 uint32_t cmd; /* enum lttcomm_relayd_command */
134 uint32_t cmd_version; /* command version */
135 } __attribute__((__packed__));
138 * LTTNG_VIEWER_CONNECT payload.
140 struct lttng_viewer_connect
142 /* session ID assigned by the relay for command connections */
143 uint64_t viewer_session_id;
146 uint32_t type; /* enum lttng_viewer_connection_type */
147 } __attribute__((__packed__));
150 * LTTNG_VIEWER_LIST_SESSIONS payload.
152 struct lttng_viewer_list_sessions
154 uint32_t sessions_count;
155 char session_list[]; /* struct lttng_viewer_session */
156 } __attribute__((__packed__));
159 * LTTNG_VIEWER_ATTACH_SESSION payload.
161 struct lttng_viewer_attach_session_request
164 uint64_t offset; /* unused for now */
165 uint32_t seek; /* enum lttng_viewer_seek */
166 } __attribute__((__packed__));
168 struct lttng_viewer_attach_session_response
170 /* enum lttng_viewer_attach_return_code */
172 uint32_t streams_count;
173 /* struct lttng_viewer_stream */
175 } __attribute__((__packed__));
178 * LTTNG_VIEWER_GET_NEXT_INDEX payload.
180 struct lttng_viewer_get_next_index
183 } __attribute__((__packed__));
185 struct lttng_viewer_index
188 uint64_t packet_size;
189 uint64_t content_size;
190 uint64_t timestamp_begin;
191 uint64_t timestamp_end;
192 uint64_t events_discarded;
194 uint32_t status; /* enum lttng_viewer_next_index_return_code */
195 uint32_t flags; /* LTTNG_VIEWER_FLAG_* */
196 } __attribute__((__packed__));
199 * LTTNG_VIEWER_GET_PACKET payload.
201 struct lttng_viewer_get_packet
206 } __attribute__((__packed__));
208 struct lttng_viewer_trace_packet
210 uint32_t status; /* enum lttng_viewer_get_packet_return_code */
212 uint32_t flags; /* LTTNG_VIEWER_FLAG_* */
214 } __attribute__((__packed__));
217 * LTTNG_VIEWER_GET_METADATA payload.
219 struct lttng_viewer_get_metadata
222 } __attribute__((__packed__));
224 struct lttng_viewer_metadata_packet
227 uint32_t status; /* enum lttng_viewer_get_metadata_return_code */
229 } __attribute__((__packed__));
232 * LTTNG_VIEWER_GET_NEW_STREAMS payload.
234 struct lttng_viewer_new_streams_request
237 } __attribute__((__packed__));
239 struct lttng_viewer_new_streams_response
241 /* enum lttng_viewer_new_streams_return_code */
243 uint32_t streams_count;
244 /* struct lttng_viewer_stream */
246 } __attribute__((__packed__));
248 struct lttng_viewer_create_session_response
250 /* enum lttng_viewer_create_session_return_code */
252 } __attribute__((__packed__));
255 * LTTNG_VIEWER_DETACH_SESSION payload.
257 struct lttng_viewer_detach_session_request
260 } __attribute__((__packed__));
262 struct lttng_viewer_detach_session_response
264 /* enum lttng_viewer_detach_session_return_code */
266 } __attribute__((__packed__));
268 #endif /* LTTNG_VIEWER_ABI_H */