1 #ifndef LTTNG_VIEWER_ABI_H
2 #define LTTNG_VIEWER_ABI_H
5 * Copyright (C) 2013 - Julien Desfossez <jdesfossez@efficios.com>
6 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
7 * David Goulet <dgoulet@efficios.com>
9 * Permission is hereby granted, free of charge, to any person obtaining a copy
10 * of this software and associated documentation files (the "Software"), to deal
11 * in the Software without restriction, including without limitation the rights
12 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 * copies of the Software, and to permit persons to whom the Software is
14 * furnished to do so, subject to the following conditions:
16 * The above copyright notice and this permission notice shall be included in
17 * all copies or substantial portions of the Software.
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
30 #define LTTNG_VIEWER_PATH_MAX 4096
31 #define LTTNG_VIEWER_NAME_MAX 255
32 #define LTTNG_VIEWER_HOST_NAME_MAX 64
34 /* Flags in reply to get_next_index and get_packet. */
36 /* New metadata is required to read this packet. */
37 LTTNG_VIEWER_FLAG_NEW_METADATA
= (1 << 0),
38 /* New stream got added to the trace. */
39 LTTNG_VIEWER_FLAG_NEW_STREAM
= (1 << 1),
42 enum lttng_viewer_command
{
43 LTTNG_VIEWER_CONNECT
= 1,
44 LTTNG_VIEWER_LIST_SESSIONS
= 2,
45 LTTNG_VIEWER_ATTACH_SESSION
= 3,
46 LTTNG_VIEWER_GET_NEXT_INDEX
= 4,
47 LTTNG_VIEWER_GET_PACKET
= 5,
48 LTTNG_VIEWER_GET_METADATA
= 6,
49 LTTNG_VIEWER_GET_NEW_STREAMS
= 7,
50 LTTNG_VIEWER_CREATE_SESSION
= 8,
51 LTTNG_VIEWER_DETACH_SESSION
= 9,
54 enum lttng_viewer_attach_return_code
{
55 LTTNG_VIEWER_ATTACH_OK
= 1, /* The attach command succeeded. */
56 LTTNG_VIEWER_ATTACH_ALREADY
= 2, /* A viewer is already attached. */
57 LTTNG_VIEWER_ATTACH_UNK
= 3, /* The session ID is unknown. */
58 LTTNG_VIEWER_ATTACH_NOT_LIVE
= 4, /* The session is not live. */
59 LTTNG_VIEWER_ATTACH_SEEK_ERR
= 5, /* Seek error. */
60 LTTNG_VIEWER_ATTACH_NO_SESSION
= 6, /* No viewer session created. */
63 enum lttng_viewer_next_index_return_code
{
64 LTTNG_VIEWER_INDEX_OK
= 1, /* Index is available. */
65 LTTNG_VIEWER_INDEX_RETRY
= 2, /* Index not yet available. */
66 LTTNG_VIEWER_INDEX_HUP
= 3, /* Index closed (trace destroyed). */
67 LTTNG_VIEWER_INDEX_ERR
= 4, /* Unknow error. */
68 LTTNG_VIEWER_INDEX_INACTIVE
= 5, /* Inactive stream beacon. */
69 LTTNG_VIEWER_INDEX_EOF
= 6, /* End of index file. */
72 enum lttng_viewer_get_packet_return_code
{
73 LTTNG_VIEWER_GET_PACKET_OK
= 1,
74 LTTNG_VIEWER_GET_PACKET_RETRY
= 2,
75 LTTNG_VIEWER_GET_PACKET_ERR
= 3,
76 LTTNG_VIEWER_GET_PACKET_EOF
= 4,
79 enum lttng_viewer_get_metadata_return_code
{
80 LTTNG_VIEWER_METADATA_OK
= 1,
81 LTTNG_VIEWER_NO_NEW_METADATA
= 2,
82 LTTNG_VIEWER_METADATA_ERR
= 3,
85 enum lttng_viewer_connection_type
{
86 LTTNG_VIEWER_CLIENT_COMMAND
= 1,
87 LTTNG_VIEWER_CLIENT_NOTIFICATION
= 2,
90 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
{
98 LTTNG_VIEWER_NEW_STREAMS_OK
= 1, /* If new streams are being sent. */
99 LTTNG_VIEWER_NEW_STREAMS_NO_NEW
= 2, /* If no new streams are available. */
100 LTTNG_VIEWER_NEW_STREAMS_ERR
= 3, /* Error. */
101 LTTNG_VIEWER_NEW_STREAMS_HUP
= 4, /* Session closed. */
104 enum lttng_viewer_create_session_return_code
{
105 LTTNG_VIEWER_CREATE_SESSION_OK
= 1,
106 LTTNG_VIEWER_CREATE_SESSION_ERR
= 2,
109 enum lttng_viewer_detach_session_return_code
{
110 LTTNG_VIEWER_DETACH_SESSION_OK
= 1,
111 LTTNG_VIEWER_DETACH_SESSION_UNK
= 2,
112 LTTNG_VIEWER_DETACH_SESSION_ERR
= 3,
115 struct lttng_viewer_session
{
120 char hostname
[LTTNG_VIEWER_HOST_NAME_MAX
];
121 char session_name
[LTTNG_VIEWER_NAME_MAX
];
122 } __attribute__((__packed__
));
124 struct lttng_viewer_stream
{
126 uint64_t ctf_trace_id
;
127 uint32_t metadata_flag
;
128 char path_name
[LTTNG_VIEWER_PATH_MAX
];
129 char channel_name
[LTTNG_VIEWER_NAME_MAX
];
130 } __attribute__((__packed__
));
132 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
{
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
{
153 uint32_t sessions_count
;
154 char session_list
[]; /* struct lttng_viewer_session */
155 } __attribute__((__packed__
));
158 * LTTNG_VIEWER_ATTACH_SESSION payload.
160 struct lttng_viewer_attach_session_request
{
162 uint64_t offset
; /* unused for now */
163 uint32_t seek
; /* enum lttng_viewer_seek */
164 } __attribute__((__packed__
));
166 struct lttng_viewer_attach_session_response
{
167 /* enum lttng_viewer_attach_return_code */
169 uint32_t streams_count
;
170 /* struct lttng_viewer_stream */
172 } __attribute__((__packed__
));
175 * LTTNG_VIEWER_GET_NEXT_INDEX payload.
177 struct lttng_viewer_get_next_index
{
179 } __attribute__ ((__packed__
));
181 struct lttng_viewer_index
{
183 uint64_t packet_size
;
184 uint64_t content_size
;
185 uint64_t timestamp_begin
;
186 uint64_t timestamp_end
;
187 uint64_t events_discarded
;
189 uint32_t status
; /* enum lttng_viewer_next_index_return_code */
190 uint32_t flags
; /* LTTNG_VIEWER_FLAG_* */
191 } __attribute__ ((__packed__
));
194 * LTTNG_VIEWER_GET_PACKET payload.
196 struct lttng_viewer_get_packet
{
200 } __attribute__((__packed__
));
202 struct lttng_viewer_trace_packet
{
203 uint32_t status
; /* enum lttng_viewer_get_packet_return_code */
205 uint32_t flags
; /* LTTNG_VIEWER_FLAG_* */
207 } __attribute__((__packed__
));
210 * LTTNG_VIEWER_GET_METADATA payload.
212 struct lttng_viewer_get_metadata
{
214 } __attribute__((__packed__
));
216 struct lttng_viewer_metadata_packet
{
218 uint32_t status
; /* enum lttng_viewer_get_metadata_return_code */
220 } __attribute__((__packed__
));
223 * LTTNG_VIEWER_GET_NEW_STREAMS payload.
225 struct lttng_viewer_new_streams_request
{
227 } __attribute__((__packed__
));
229 struct lttng_viewer_new_streams_response
{
230 /* enum lttng_viewer_new_streams_return_code */
232 uint32_t streams_count
;
233 /* struct lttng_viewer_stream */
235 } __attribute__((__packed__
));
237 struct lttng_viewer_create_session_response
{
238 /* enum lttng_viewer_create_session_return_code */
240 } __attribute__((__packed__
));
243 * LTTNG_VIEWER_DETACH_SESSION payload.
245 struct lttng_viewer_detach_session_request
{
247 } __attribute__((__packed__
));
249 struct lttng_viewer_detach_session_response
{
250 /* enum lttng_viewer_detach_session_return_code */
252 } __attribute__((__packed__
));
254 #endif /* LTTNG_VIEWER_ABI_H */