Commit | Line | Data |
---|---|---|
1e26e04e JD |
1 | #ifndef LTTNG_VIEWER_ABI_H |
2 | #define LTTNG_VIEWER_ABI_H | |
ddea0ada | 3 | |
d3e2ba59 JD |
4 | /* |
5 | * Copyright (C) 2013 - Julien Desfossez <jdesfossez@efficios.com> | |
c404302f | 6 | * Mathieu Desnoyers <mathieu.desnoyers@efficios.com> |
d3e2ba59 JD |
7 | * David Goulet <dgoulet@efficios.com> |
8 | * | |
c404302f JD |
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: | |
d3e2ba59 | 15 | * |
c404302f JD |
16 | * The above copyright notice and this permission notice shall be included in |
17 | * all copies or substantial portions of the Software. | |
d3e2ba59 | 18 | * |
c404302f JD |
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 | |
25 | * SOFTWARE. | |
d3e2ba59 JD |
26 | */ |
27 | ||
d3e2ba59 | 28 | #include <limits.h> |
62d07d1c | 29 | #include <common/macros.h> |
d3e2ba59 JD |
30 | |
31 | #define LTTNG_VIEWER_PATH_MAX 4096 | |
32 | #define LTTNG_VIEWER_NAME_MAX 255 | |
c4e361a4 | 33 | #define LTTNG_VIEWER_HOST_NAME_MAX 64 |
d3e2ba59 JD |
34 | |
35 | /* Flags in reply to get_next_index and get_packet. */ | |
c4e361a4 JD |
36 | enum { |
37 | /* New metadata is required to read this packet. */ | |
38 | LTTNG_VIEWER_FLAG_NEW_METADATA = (1 << 0), | |
39 | /* New stream got added to the trace. */ | |
40 | LTTNG_VIEWER_FLAG_NEW_STREAM = (1 << 1), | |
41 | }; | |
d3e2ba59 JD |
42 | |
43 | enum lttng_viewer_command { | |
c4e361a4 JD |
44 | LTTNG_VIEWER_CONNECT = 1, |
45 | LTTNG_VIEWER_LIST_SESSIONS = 2, | |
46 | LTTNG_VIEWER_ATTACH_SESSION = 3, | |
47 | LTTNG_VIEWER_GET_NEXT_INDEX = 4, | |
48 | LTTNG_VIEWER_GET_PACKET = 5, | |
49 | LTTNG_VIEWER_GET_METADATA = 6, | |
50 | LTTNG_VIEWER_GET_NEW_STREAMS = 7, | |
c3b7390b | 51 | LTTNG_VIEWER_CREATE_SESSION = 8, |
d62023be | 52 | LTTNG_VIEWER_DETACH_SESSION = 9, |
d3e2ba59 JD |
53 | }; |
54 | ||
55 | enum lttng_viewer_attach_return_code { | |
c4e361a4 JD |
56 | LTTNG_VIEWER_ATTACH_OK = 1, /* The attach command succeeded. */ |
57 | LTTNG_VIEWER_ATTACH_ALREADY = 2, /* A viewer is already attached. */ | |
58 | LTTNG_VIEWER_ATTACH_UNK = 3, /* The session ID is unknown. */ | |
59 | LTTNG_VIEWER_ATTACH_NOT_LIVE = 4, /* The session is not live. */ | |
60 | LTTNG_VIEWER_ATTACH_SEEK_ERR = 5, /* Seek error. */ | |
c3b7390b | 61 | LTTNG_VIEWER_ATTACH_NO_SESSION = 6, /* No viewer session created. */ |
d3e2ba59 JD |
62 | }; |
63 | ||
64 | enum lttng_viewer_next_index_return_code { | |
c4e361a4 JD |
65 | LTTNG_VIEWER_INDEX_OK = 1, /* Index is available. */ |
66 | LTTNG_VIEWER_INDEX_RETRY = 2, /* Index not yet available. */ | |
67 | LTTNG_VIEWER_INDEX_HUP = 3, /* Index closed (trace destroyed). */ | |
68 | LTTNG_VIEWER_INDEX_ERR = 4, /* Unknow error. */ | |
69 | LTTNG_VIEWER_INDEX_INACTIVE = 5, /* Inactive stream beacon. */ | |
70 | LTTNG_VIEWER_INDEX_EOF = 6, /* End of index file. */ | |
d3e2ba59 JD |
71 | }; |
72 | ||
73 | enum lttng_viewer_get_packet_return_code { | |
c4e361a4 JD |
74 | LTTNG_VIEWER_GET_PACKET_OK = 1, |
75 | LTTNG_VIEWER_GET_PACKET_RETRY = 2, | |
76 | LTTNG_VIEWER_GET_PACKET_ERR = 3, | |
77 | LTTNG_VIEWER_GET_PACKET_EOF = 4, | |
d3e2ba59 JD |
78 | }; |
79 | ||
80 | enum lttng_viewer_get_metadata_return_code { | |
c4e361a4 JD |
81 | LTTNG_VIEWER_METADATA_OK = 1, |
82 | LTTNG_VIEWER_NO_NEW_METADATA = 2, | |
83 | LTTNG_VIEWER_METADATA_ERR = 3, | |
d3e2ba59 JD |
84 | }; |
85 | ||
86 | enum lttng_viewer_connection_type { | |
c4e361a4 JD |
87 | LTTNG_VIEWER_CLIENT_COMMAND = 1, |
88 | LTTNG_VIEWER_CLIENT_NOTIFICATION = 2, | |
d3e2ba59 JD |
89 | }; |
90 | ||
91 | enum lttng_viewer_seek { | |
ddea0ada | 92 | /* Receive the trace packets from the beginning. */ |
c4e361a4 | 93 | LTTNG_VIEWER_SEEK_BEGINNING = 1, |
ddea0ada | 94 | /* Receive the trace packets from now. */ |
c4e361a4 | 95 | LTTNG_VIEWER_SEEK_LAST = 2, |
d3e2ba59 JD |
96 | }; |
97 | ||
80e8027a | 98 | enum lttng_viewer_new_streams_return_code { |
c4e361a4 JD |
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. */ | |
4479f682 | 102 | LTTNG_VIEWER_NEW_STREAMS_HUP = 4, /* Session closed. */ |
80e8027a JD |
103 | }; |
104 | ||
c3b7390b JD |
105 | enum lttng_viewer_create_session_return_code { |
106 | LTTNG_VIEWER_CREATE_SESSION_OK = 1, | |
107 | LTTNG_VIEWER_CREATE_SESSION_ERR = 2, | |
108 | }; | |
109 | ||
d62023be JD |
110 | enum lttng_viewer_detach_session_return_code { |
111 | LTTNG_VIEWER_DETACH_SESSION_OK = 1, | |
112 | LTTNG_VIEWER_DETACH_SESSION_UNK = 2, | |
113 | LTTNG_VIEWER_DETACH_SESSION_ERR = 3, | |
114 | }; | |
115 | ||
d3e2ba59 JD |
116 | struct lttng_viewer_session { |
117 | uint64_t id; | |
d3e2ba59 JD |
118 | uint32_t live_timer; |
119 | uint32_t clients; | |
87b576ec | 120 | uint32_t streams; |
c4e361a4 | 121 | char hostname[LTTNG_VIEWER_HOST_NAME_MAX]; |
ddea0ada | 122 | char session_name[LTTNG_VIEWER_NAME_MAX]; |
62d07d1c | 123 | } LTTNG_PACKED; |
d3e2ba59 JD |
124 | |
125 | struct lttng_viewer_stream { | |
126 | uint64_t id; | |
127 | uint64_t ctf_trace_id; | |
94143186 | 128 | uint32_t metadata_flag; |
d3e2ba59 JD |
129 | char path_name[LTTNG_VIEWER_PATH_MAX]; |
130 | char channel_name[LTTNG_VIEWER_NAME_MAX]; | |
62d07d1c | 131 | } LTTNG_PACKED; |
d3e2ba59 JD |
132 | |
133 | struct lttng_viewer_cmd { | |
134 | uint64_t data_size; /* data size following this header */ | |
135 | uint32_t cmd; /* enum lttcomm_relayd_command */ | |
136 | uint32_t cmd_version; /* command version */ | |
62d07d1c | 137 | } LTTNG_PACKED; |
d3e2ba59 JD |
138 | |
139 | /* | |
c4e361a4 | 140 | * LTTNG_VIEWER_CONNECT payload. |
d3e2ba59 JD |
141 | */ |
142 | struct lttng_viewer_connect { | |
ddea0ada JD |
143 | /* session ID assigned by the relay for command connections */ |
144 | uint64_t viewer_session_id; | |
d3e2ba59 JD |
145 | uint32_t major; |
146 | uint32_t minor; | |
c4e361a4 | 147 | uint32_t type; /* enum lttng_viewer_connection_type */ |
62d07d1c | 148 | } LTTNG_PACKED; |
d3e2ba59 JD |
149 | |
150 | /* | |
c4e361a4 | 151 | * LTTNG_VIEWER_LIST_SESSIONS payload. |
d3e2ba59 JD |
152 | */ |
153 | struct lttng_viewer_list_sessions { | |
154 | uint32_t sessions_count; | |
c4e361a4 | 155 | char session_list[]; /* struct lttng_viewer_session */ |
62d07d1c | 156 | } LTTNG_PACKED; |
d3e2ba59 JD |
157 | |
158 | /* | |
c4e361a4 | 159 | * LTTNG_VIEWER_ATTACH_SESSION payload. |
d3e2ba59 JD |
160 | */ |
161 | struct lttng_viewer_attach_session_request { | |
162 | uint64_t session_id; | |
d3e2ba59 | 163 | uint64_t offset; /* unused for now */ |
ddea0ada | 164 | uint32_t seek; /* enum lttng_viewer_seek */ |
62d07d1c | 165 | } LTTNG_PACKED; |
d3e2ba59 JD |
166 | |
167 | struct lttng_viewer_attach_session_response { | |
ddea0ada JD |
168 | /* enum lttng_viewer_attach_return_code */ |
169 | uint32_t status; | |
d3e2ba59 | 170 | uint32_t streams_count; |
ddea0ada JD |
171 | /* struct lttng_viewer_stream */ |
172 | char stream_list[]; | |
62d07d1c | 173 | } LTTNG_PACKED; |
d3e2ba59 JD |
174 | |
175 | /* | |
c4e361a4 | 176 | * LTTNG_VIEWER_GET_NEXT_INDEX payload. |
d3e2ba59 JD |
177 | */ |
178 | struct lttng_viewer_get_next_index { | |
179 | uint64_t stream_id; | |
180 | } __attribute__ ((__packed__)); | |
181 | ||
182 | struct lttng_viewer_index { | |
d3e2ba59 JD |
183 | uint64_t offset; |
184 | uint64_t packet_size; | |
185 | uint64_t content_size; | |
186 | uint64_t timestamp_begin; | |
187 | uint64_t timestamp_end; | |
188 | uint64_t events_discarded; | |
189 | uint64_t stream_id; | |
c4e361a4 JD |
190 | uint32_t status; /* enum lttng_viewer_next_index_return_code */ |
191 | uint32_t flags; /* LTTNG_VIEWER_FLAG_* */ | |
d3e2ba59 JD |
192 | } __attribute__ ((__packed__)); |
193 | ||
194 | /* | |
c4e361a4 | 195 | * LTTNG_VIEWER_GET_PACKET payload. |
d3e2ba59 JD |
196 | */ |
197 | struct lttng_viewer_get_packet { | |
198 | uint64_t stream_id; | |
199 | uint64_t offset; | |
200 | uint32_t len; | |
62d07d1c | 201 | } LTTNG_PACKED; |
d3e2ba59 JD |
202 | |
203 | struct lttng_viewer_trace_packet { | |
c4e361a4 | 204 | uint32_t status; /* enum lttng_viewer_get_packet_return_code */ |
d3e2ba59 | 205 | uint32_t len; |
c4e361a4 | 206 | uint32_t flags; /* LTTNG_VIEWER_FLAG_* */ |
d3e2ba59 | 207 | char data[]; |
62d07d1c | 208 | } LTTNG_PACKED; |
d3e2ba59 JD |
209 | |
210 | /* | |
c4e361a4 | 211 | * LTTNG_VIEWER_GET_METADATA payload. |
d3e2ba59 JD |
212 | */ |
213 | struct lttng_viewer_get_metadata { | |
214 | uint64_t stream_id; | |
62d07d1c | 215 | } LTTNG_PACKED; |
d3e2ba59 JD |
216 | |
217 | struct lttng_viewer_metadata_packet { | |
d3e2ba59 | 218 | uint64_t len; |
c4e361a4 | 219 | uint32_t status; /* enum lttng_viewer_get_metadata_return_code */ |
d3e2ba59 | 220 | char data[]; |
62d07d1c | 221 | } LTTNG_PACKED; |
d3e2ba59 | 222 | |
80e8027a | 223 | /* |
c4e361a4 | 224 | * LTTNG_VIEWER_GET_NEW_STREAMS payload. |
80e8027a JD |
225 | */ |
226 | struct lttng_viewer_new_streams_request { | |
227 | uint64_t session_id; | |
62d07d1c | 228 | } LTTNG_PACKED; |
80e8027a JD |
229 | |
230 | struct lttng_viewer_new_streams_response { | |
231 | /* enum lttng_viewer_new_streams_return_code */ | |
232 | uint32_t status; | |
233 | uint32_t streams_count; | |
234 | /* struct lttng_viewer_stream */ | |
235 | char stream_list[]; | |
62d07d1c | 236 | } LTTNG_PACKED; |
80e8027a | 237 | |
c3b7390b JD |
238 | struct lttng_viewer_create_session_response { |
239 | /* enum lttng_viewer_create_session_return_code */ | |
240 | uint32_t status; | |
62d07d1c | 241 | } LTTNG_PACKED; |
c3b7390b | 242 | |
d62023be JD |
243 | /* |
244 | * LTTNG_VIEWER_DETACH_SESSION payload. | |
245 | */ | |
246 | struct lttng_viewer_detach_session_request { | |
247 | uint64_t session_id; | |
62d07d1c | 248 | } LTTNG_PACKED; |
d62023be JD |
249 | |
250 | struct lttng_viewer_detach_session_response { | |
251 | /* enum lttng_viewer_detach_session_return_code */ | |
252 | uint32_t status; | |
62d07d1c | 253 | } LTTNG_PACKED; |
d62023be | 254 | |
1e26e04e | 255 | #endif /* LTTNG_VIEWER_ABI_H */ |