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. */
21 /* New metadata is required to read this packet. */
22 LTTNG_VIEWER_FLAG_NEW_METADATA
= (1 << 0),
23 /* New stream got added to the trace. */
24 LTTNG_VIEWER_FLAG_NEW_STREAM
= (1 << 1),
27 enum lttng_viewer_command
{
28 LTTNG_VIEWER_CONNECT
= 1,
29 LTTNG_VIEWER_LIST_SESSIONS
= 2,
30 LTTNG_VIEWER_ATTACH_SESSION
= 3,
31 LTTNG_VIEWER_GET_NEXT_INDEX
= 4,
32 LTTNG_VIEWER_GET_PACKET
= 5,
33 LTTNG_VIEWER_GET_METADATA
= 6,
34 LTTNG_VIEWER_GET_NEW_STREAMS
= 7,
35 LTTNG_VIEWER_CREATE_SESSION
= 8,
36 LTTNG_VIEWER_DETACH_SESSION
= 9,
39 enum lttng_viewer_attach_return_code
{
40 LTTNG_VIEWER_ATTACH_OK
= 1, /* The attach command succeeded. */
41 LTTNG_VIEWER_ATTACH_ALREADY
= 2, /* A viewer is already attached. */
42 LTTNG_VIEWER_ATTACH_UNK
= 3, /* The session ID is unknown. */
43 LTTNG_VIEWER_ATTACH_NOT_LIVE
= 4, /* The session is not live. */
44 LTTNG_VIEWER_ATTACH_SEEK_ERR
= 5, /* Seek error. */
45 LTTNG_VIEWER_ATTACH_NO_SESSION
= 6, /* No viewer session created. */
48 enum lttng_viewer_detach_session_return_code
{
49 LTTNG_VIEWER_DETACH_SESSION_OK
= 1,
50 LTTNG_VIEWER_DETACH_SESSION_UNK
= 2,
51 LTTNG_VIEWER_DETACH_SESSION_ERR
= 3,
54 enum lttng_viewer_next_index_return_code
{
55 LTTNG_VIEWER_INDEX_OK
= 1, /* Index is available. */
56 LTTNG_VIEWER_INDEX_RETRY
= 2, /* Index not yet available. */
57 LTTNG_VIEWER_INDEX_HUP
= 3, /* Index closed (trace destroyed). */
58 LTTNG_VIEWER_INDEX_ERR
= 4, /* Unknow error. */
59 LTTNG_VIEWER_INDEX_INACTIVE
= 5, /* Inactive stream beacon. */
60 LTTNG_VIEWER_INDEX_EOF
= 6, /* End of index file. */
63 enum lttng_viewer_get_packet_return_code
{
64 LTTNG_VIEWER_GET_PACKET_OK
= 1,
65 LTTNG_VIEWER_GET_PACKET_RETRY
= 2,
66 LTTNG_VIEWER_GET_PACKET_ERR
= 3,
67 LTTNG_VIEWER_GET_PACKET_EOF
= 4,
70 enum lttng_viewer_get_metadata_return_code
{
71 LTTNG_VIEWER_METADATA_OK
= 1,
72 LTTNG_VIEWER_NO_NEW_METADATA
= 2,
73 LTTNG_VIEWER_METADATA_ERR
= 3,
76 enum lttng_viewer_connection_type
{
77 LTTNG_VIEWER_CLIENT_COMMAND
= 1,
78 LTTNG_VIEWER_CLIENT_MESSAGE
= 2,
81 enum lttng_viewer_seek
{
82 /* Receive the trace packets from the beginning. */
83 LTTNG_VIEWER_SEEK_BEGINNING
= 1,
84 /* Receive the trace packets from now. */
85 LTTNG_VIEWER_SEEK_LAST
= 2,
88 enum lttng_viewer_new_streams_return_code
{
89 LTTNG_VIEWER_NEW_STREAMS_OK
= 1, /* If new streams are being sent. */
90 LTTNG_VIEWER_NEW_STREAMS_NO_NEW
= 2, /* If no new streams are available. */
91 LTTNG_VIEWER_NEW_STREAMS_ERR
= 3, /* Error. */
92 LTTNG_VIEWER_NEW_STREAMS_HUP
= 4, /* Session closed. */
95 enum lttng_viewer_create_session_return_code
{
96 LTTNG_VIEWER_CREATE_SESSION_OK
= 1,
97 LTTNG_VIEWER_CREATE_SESSION_ERR
= 2,
100 struct lttng_viewer_session
{
105 char hostname
[LTTNG_VIEWER_HOST_NAME_MAX
];
106 char session_name
[LTTNG_VIEWER_NAME_MAX
];
107 } __attribute__((__packed__
));
109 struct lttng_viewer_stream
{
111 uint64_t ctf_trace_id
;
112 uint32_t metadata_flag
;
113 char path_name
[LTTNG_VIEWER_PATH_MAX
];
114 char channel_name
[LTTNG_VIEWER_NAME_MAX
];
115 } __attribute__((__packed__
));
117 struct lttng_viewer_cmd
{
118 uint64_t data_size
; /* data size following this header */
119 uint32_t cmd
; /* enum lttcomm_relayd_command */
120 uint32_t cmd_version
; /* command version */
121 } __attribute__((__packed__
));
124 * LTTNG_VIEWER_CONNECT payload.
126 struct lttng_viewer_connect
{
127 /* session ID assigned by the relay for command connections */
128 uint64_t viewer_session_id
;
131 uint32_t type
; /* enum lttng_viewer_connection_type */
132 } __attribute__((__packed__
));
135 * LTTNG_VIEWER_LIST_SESSIONS payload.
137 struct lttng_viewer_list_sessions
{
138 uint32_t sessions_count
;
139 char session_list
[]; /* struct lttng_viewer_session */
140 } __attribute__((__packed__
));
143 * LTTNG_VIEWER_ATTACH_SESSION payload.
145 struct lttng_viewer_attach_session_request
{
147 uint64_t offset
; /* unused for now */
148 uint32_t seek
; /* enum lttng_viewer_seek */
149 } __attribute__((__packed__
));
151 struct lttng_viewer_attach_session_response
{
152 /* enum lttng_viewer_attach_return_code */
154 uint32_t streams_count
;
155 /* struct lttng_viewer_stream */
157 } __attribute__((__packed__
));
160 * LTTNG_VIEWER_GET_NEXT_INDEX payload.
162 struct lttng_viewer_get_next_index
{
164 } __attribute__ ((__packed__
));
166 struct lttng_viewer_index
{
168 uint64_t packet_size
;
169 uint64_t content_size
;
170 uint64_t timestamp_begin
;
171 uint64_t timestamp_end
;
172 uint64_t events_discarded
;
174 uint32_t status
; /* enum lttng_viewer_next_index_return_code */
175 uint32_t flags
; /* LTTNG_VIEWER_FLAG_* */
176 } __attribute__ ((__packed__
));
179 * LTTNG_VIEWER_GET_PACKET payload.
181 struct lttng_viewer_get_packet
{
185 } __attribute__((__packed__
));
187 struct lttng_viewer_trace_packet
{
188 uint32_t status
; /* enum lttng_viewer_get_packet_return_code */
190 uint32_t flags
; /* LTTNG_VIEWER_FLAG_* */
192 } __attribute__((__packed__
));
195 * LTTNG_VIEWER_GET_METADATA payload.
197 struct lttng_viewer_get_metadata
{
199 } __attribute__((__packed__
));
201 struct lttng_viewer_metadata_packet
{
203 uint32_t status
; /* enum lttng_viewer_get_metadata_return_code */
205 } __attribute__((__packed__
));
208 * LTTNG_VIEWER_GET_NEW_STREAMS payload.
210 struct lttng_viewer_new_streams_request
{
212 } __attribute__((__packed__
));
214 struct lttng_viewer_new_streams_response
{
215 /* enum lttng_viewer_new_streams_return_code */
217 uint32_t streams_count
;
218 /* struct lttng_viewer_stream */
220 } __attribute__((__packed__
));
222 struct lttng_viewer_create_session_response
{
223 /* enum lttng_viewer_create_session_return_code */
225 } __attribute__((__packed__
));
228 * LTTNG_VIEWER_DETACH_SESSION payload.
230 struct lttng_viewer_detach_session_request
{
232 } __attribute__((__packed__
));
234 struct lttng_viewer_detach_session_response
{
235 /* enum lttng_viewer_detach_session_return_code */
237 } __attribute__((__packed__
));
239 #endif /* LTTNG_VIEWER_ABI_H */