Commit | Line | Data |
---|---|---|
7cdc2bab | 1 | /* |
0235b0db | 2 | * SPDX-License-Identifier: MIT |
7cdc2bab | 3 | * |
0235b0db MJ |
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> | |
7cdc2bab MD |
7 | */ |
8 | ||
0235b0db MJ |
9 | #ifndef LTTNG_VIEWER_ABI_H |
10 | #define LTTNG_VIEWER_ABI_H | |
11 | ||
3c22a242 | 12 | #include <stdint.h> |
578e048b | 13 | #include "compat/limits.h" |
7cdc2bab MD |
14 | |
15 | #define LTTNG_VIEWER_PATH_MAX 4096 | |
16 | #define LTTNG_VIEWER_NAME_MAX 255 | |
17 | #define LTTNG_VIEWER_HOST_NAME_MAX 64 | |
18 | ||
19 | /* Flags in reply to get_next_index and get_packet. */ | |
20 | enum { | |
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), | |
25 | }; | |
26 | ||
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, | |
37 | }; | |
38 | ||
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. */ | |
46 | }; | |
47 | ||
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, | |
52 | }; | |
53 | ||
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. */ | |
61 | }; | |
62 | ||
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, | |
68 | }; | |
69 | ||
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, | |
74 | }; | |
75 | ||
76 | enum lttng_viewer_connection_type { | |
77 | LTTNG_VIEWER_CLIENT_COMMAND = 1, | |
d6e69534 | 78 | LTTNG_VIEWER_CLIENT_MESSAGE = 2, |
7cdc2bab MD |
79 | }; |
80 | ||
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, | |
86 | }; | |
87 | ||
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. */ | |
93 | }; | |
94 | ||
95 | enum lttng_viewer_create_session_return_code { | |
96 | LTTNG_VIEWER_CREATE_SESSION_OK = 1, | |
97 | LTTNG_VIEWER_CREATE_SESSION_ERR = 2, | |
98 | }; | |
99 | ||
100 | struct lttng_viewer_session { | |
101 | uint64_t id; | |
102 | uint32_t live_timer; | |
103 | uint32_t clients; | |
104 | uint32_t streams; | |
105 | char hostname[LTTNG_VIEWER_HOST_NAME_MAX]; | |
106 | char session_name[LTTNG_VIEWER_NAME_MAX]; | |
107 | } __attribute__((__packed__)); | |
108 | ||
109 | struct lttng_viewer_stream { | |
110 | uint64_t id; | |
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__)); | |
116 | ||
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__)); | |
122 | ||
123 | /* | |
124 | * LTTNG_VIEWER_CONNECT payload. | |
125 | */ | |
126 | struct lttng_viewer_connect { | |
127 | /* session ID assigned by the relay for command connections */ | |
128 | uint64_t viewer_session_id; | |
129 | uint32_t major; | |
130 | uint32_t minor; | |
131 | uint32_t type; /* enum lttng_viewer_connection_type */ | |
132 | } __attribute__((__packed__)); | |
133 | ||
134 | /* | |
135 | * LTTNG_VIEWER_LIST_SESSIONS payload. | |
136 | */ | |
137 | struct lttng_viewer_list_sessions { | |
138 | uint32_t sessions_count; | |
139 | char session_list[]; /* struct lttng_viewer_session */ | |
140 | } __attribute__((__packed__)); | |
141 | ||
142 | /* | |
143 | * LTTNG_VIEWER_ATTACH_SESSION payload. | |
144 | */ | |
145 | struct lttng_viewer_attach_session_request { | |
146 | uint64_t session_id; | |
147 | uint64_t offset; /* unused for now */ | |
148 | uint32_t seek; /* enum lttng_viewer_seek */ | |
149 | } __attribute__((__packed__)); | |
150 | ||
151 | struct lttng_viewer_attach_session_response { | |
152 | /* enum lttng_viewer_attach_return_code */ | |
153 | uint32_t status; | |
154 | uint32_t streams_count; | |
155 | /* struct lttng_viewer_stream */ | |
156 | char stream_list[]; | |
157 | } __attribute__((__packed__)); | |
158 | ||
159 | /* | |
160 | * LTTNG_VIEWER_GET_NEXT_INDEX payload. | |
161 | */ | |
162 | struct lttng_viewer_get_next_index { | |
163 | uint64_t stream_id; | |
164 | } __attribute__ ((__packed__)); | |
165 | ||
166 | struct lttng_viewer_index { | |
167 | uint64_t offset; | |
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; | |
173 | uint64_t stream_id; | |
174 | uint32_t status; /* enum lttng_viewer_next_index_return_code */ | |
175 | uint32_t flags; /* LTTNG_VIEWER_FLAG_* */ | |
176 | } __attribute__ ((__packed__)); | |
177 | ||
178 | /* | |
179 | * LTTNG_VIEWER_GET_PACKET payload. | |
180 | */ | |
181 | struct lttng_viewer_get_packet { | |
182 | uint64_t stream_id; | |
183 | uint64_t offset; | |
184 | uint32_t len; | |
185 | } __attribute__((__packed__)); | |
186 | ||
187 | struct lttng_viewer_trace_packet { | |
188 | uint32_t status; /* enum lttng_viewer_get_packet_return_code */ | |
189 | uint32_t len; | |
190 | uint32_t flags; /* LTTNG_VIEWER_FLAG_* */ | |
191 | char data[]; | |
192 | } __attribute__((__packed__)); | |
193 | ||
194 | /* | |
195 | * LTTNG_VIEWER_GET_METADATA payload. | |
196 | */ | |
197 | struct lttng_viewer_get_metadata { | |
198 | uint64_t stream_id; | |
199 | } __attribute__((__packed__)); | |
200 | ||
201 | struct lttng_viewer_metadata_packet { | |
202 | uint64_t len; | |
203 | uint32_t status; /* enum lttng_viewer_get_metadata_return_code */ | |
204 | char data[]; | |
205 | } __attribute__((__packed__)); | |
206 | ||
207 | /* | |
208 | * LTTNG_VIEWER_GET_NEW_STREAMS payload. | |
209 | */ | |
210 | struct lttng_viewer_new_streams_request { | |
211 | uint64_t session_id; | |
212 | } __attribute__((__packed__)); | |
213 | ||
214 | struct lttng_viewer_new_streams_response { | |
215 | /* enum lttng_viewer_new_streams_return_code */ | |
216 | uint32_t status; | |
217 | uint32_t streams_count; | |
218 | /* struct lttng_viewer_stream */ | |
219 | char stream_list[]; | |
220 | } __attribute__((__packed__)); | |
221 | ||
222 | struct lttng_viewer_create_session_response { | |
223 | /* enum lttng_viewer_create_session_return_code */ | |
224 | uint32_t status; | |
225 | } __attribute__((__packed__)); | |
226 | ||
227 | /* | |
228 | * LTTNG_VIEWER_DETACH_SESSION payload. | |
229 | */ | |
230 | struct lttng_viewer_detach_session_request { | |
231 | uint64_t session_id; | |
232 | } __attribute__((__packed__)); | |
233 | ||
234 | struct lttng_viewer_detach_session_response { | |
235 | /* enum lttng_viewer_detach_session_return_code */ | |
236 | uint32_t status; | |
237 | } __attribute__((__packed__)); | |
238 | ||
239 | #endif /* LTTNG_VIEWER_ABI_H */ |