Commit | Line | Data |
---|---|---|
c4e361a4 JD |
1 | #ifndef LTTNG_VIEWER_H |
2 | #define LTTNG_VIEWER_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 JD |
28 | #include <limits.h> |
29 | ||
30 | #define LTTNG_VIEWER_PATH_MAX 4096 | |
31 | #define LTTNG_VIEWER_NAME_MAX 255 | |
c4e361a4 | 32 | #define LTTNG_VIEWER_HOST_NAME_MAX 64 |
d3e2ba59 JD |
33 | |
34 | /* Flags in reply to get_next_index and get_packet. */ | |
c4e361a4 JD |
35 | enum { |
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), | |
40 | }; | |
d3e2ba59 JD |
41 | |
42 | enum lttng_viewer_command { | |
c4e361a4 JD |
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, | |
d3e2ba59 JD |
50 | }; |
51 | ||
52 | enum lttng_viewer_attach_return_code { | |
c4e361a4 JD |
53 | LTTNG_VIEWER_ATTACH_OK = 1, /* The attach command succeeded. */ |
54 | LTTNG_VIEWER_ATTACH_ALREADY = 2, /* A viewer is already attached. */ | |
55 | LTTNG_VIEWER_ATTACH_UNK = 3, /* The session ID is unknown. */ | |
56 | LTTNG_VIEWER_ATTACH_NOT_LIVE = 4, /* The session is not live. */ | |
57 | LTTNG_VIEWER_ATTACH_SEEK_ERR = 5, /* Seek error. */ | |
d3e2ba59 JD |
58 | }; |
59 | ||
60 | enum lttng_viewer_next_index_return_code { | |
c4e361a4 JD |
61 | LTTNG_VIEWER_INDEX_OK = 1, /* Index is available. */ |
62 | LTTNG_VIEWER_INDEX_RETRY = 2, /* Index not yet available. */ | |
63 | LTTNG_VIEWER_INDEX_HUP = 3, /* Index closed (trace destroyed). */ | |
64 | LTTNG_VIEWER_INDEX_ERR = 4, /* Unknow error. */ | |
65 | LTTNG_VIEWER_INDEX_INACTIVE = 5, /* Inactive stream beacon. */ | |
66 | LTTNG_VIEWER_INDEX_EOF = 6, /* End of index file. */ | |
d3e2ba59 JD |
67 | }; |
68 | ||
69 | enum lttng_viewer_get_packet_return_code { | |
c4e361a4 JD |
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, | |
d3e2ba59 JD |
74 | }; |
75 | ||
76 | enum lttng_viewer_get_metadata_return_code { | |
c4e361a4 JD |
77 | LTTNG_VIEWER_METADATA_OK = 1, |
78 | LTTNG_VIEWER_NO_NEW_METADATA = 2, | |
79 | LTTNG_VIEWER_METADATA_ERR = 3, | |
d3e2ba59 JD |
80 | }; |
81 | ||
82 | enum lttng_viewer_connection_type { | |
c4e361a4 JD |
83 | LTTNG_VIEWER_CLIENT_COMMAND = 1, |
84 | LTTNG_VIEWER_CLIENT_NOTIFICATION = 2, | |
d3e2ba59 JD |
85 | }; |
86 | ||
87 | enum lttng_viewer_seek { | |
ddea0ada | 88 | /* Receive the trace packets from the beginning. */ |
c4e361a4 | 89 | LTTNG_VIEWER_SEEK_BEGINNING = 1, |
ddea0ada | 90 | /* Receive the trace packets from now. */ |
c4e361a4 | 91 | LTTNG_VIEWER_SEEK_LAST = 2, |
d3e2ba59 JD |
92 | }; |
93 | ||
80e8027a | 94 | enum lttng_viewer_new_streams_return_code { |
c4e361a4 JD |
95 | LTTNG_VIEWER_NEW_STREAMS_OK = 1, /* If new streams are being sent. */ |
96 | LTTNG_VIEWER_NEW_STREAMS_NO_NEW = 2, /* If no new streams are available. */ | |
97 | LTTNG_VIEWER_NEW_STREAMS_ERR = 3, /* Error. */ | |
80e8027a JD |
98 | }; |
99 | ||
d3e2ba59 JD |
100 | struct lttng_viewer_session { |
101 | uint64_t id; | |
d3e2ba59 JD |
102 | uint32_t live_timer; |
103 | uint32_t clients; | |
87b576ec | 104 | uint32_t streams; |
c4e361a4 | 105 | char hostname[LTTNG_VIEWER_HOST_NAME_MAX]; |
ddea0ada | 106 | char session_name[LTTNG_VIEWER_NAME_MAX]; |
d3e2ba59 JD |
107 | } __attribute__((__packed__)); |
108 | ||
109 | struct lttng_viewer_stream { | |
110 | uint64_t id; | |
111 | uint64_t ctf_trace_id; | |
ddea0ada | 112 | int metadata_flag; |
d3e2ba59 JD |
113 | char path_name[LTTNG_VIEWER_PATH_MAX]; |
114 | char channel_name[LTTNG_VIEWER_NAME_MAX]; | |
d3e2ba59 JD |
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 | /* | |
c4e361a4 | 124 | * LTTNG_VIEWER_CONNECT payload. |
d3e2ba59 JD |
125 | */ |
126 | struct lttng_viewer_connect { | |
ddea0ada JD |
127 | /* session ID assigned by the relay for command connections */ |
128 | uint64_t viewer_session_id; | |
d3e2ba59 JD |
129 | uint32_t major; |
130 | uint32_t minor; | |
c4e361a4 | 131 | uint32_t type; /* enum lttng_viewer_connection_type */ |
d3e2ba59 JD |
132 | } __attribute__((__packed__)); |
133 | ||
134 | /* | |
c4e361a4 | 135 | * LTTNG_VIEWER_LIST_SESSIONS payload. |
d3e2ba59 JD |
136 | */ |
137 | struct lttng_viewer_list_sessions { | |
138 | uint32_t sessions_count; | |
c4e361a4 | 139 | char session_list[]; /* struct lttng_viewer_session */ |
d3e2ba59 JD |
140 | } __attribute__((__packed__)); |
141 | ||
142 | /* | |
c4e361a4 | 143 | * LTTNG_VIEWER_ATTACH_SESSION payload. |
d3e2ba59 JD |
144 | */ |
145 | struct lttng_viewer_attach_session_request { | |
146 | uint64_t session_id; | |
d3e2ba59 | 147 | uint64_t offset; /* unused for now */ |
ddea0ada | 148 | uint32_t seek; /* enum lttng_viewer_seek */ |
d3e2ba59 JD |
149 | } __attribute__((__packed__)); |
150 | ||
151 | struct lttng_viewer_attach_session_response { | |
ddea0ada JD |
152 | /* enum lttng_viewer_attach_return_code */ |
153 | uint32_t status; | |
d3e2ba59 | 154 | uint32_t streams_count; |
ddea0ada JD |
155 | /* struct lttng_viewer_stream */ |
156 | char stream_list[]; | |
d3e2ba59 JD |
157 | } __attribute__((__packed__)); |
158 | ||
159 | /* | |
c4e361a4 | 160 | * LTTNG_VIEWER_GET_NEXT_INDEX payload. |
d3e2ba59 JD |
161 | */ |
162 | struct lttng_viewer_get_next_index { | |
163 | uint64_t stream_id; | |
164 | } __attribute__ ((__packed__)); | |
165 | ||
166 | struct lttng_viewer_index { | |
d3e2ba59 JD |
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; | |
c4e361a4 JD |
174 | uint32_t status; /* enum lttng_viewer_next_index_return_code */ |
175 | uint32_t flags; /* LTTNG_VIEWER_FLAG_* */ | |
d3e2ba59 JD |
176 | } __attribute__ ((__packed__)); |
177 | ||
178 | /* | |
c4e361a4 | 179 | * LTTNG_VIEWER_GET_PACKET payload. |
d3e2ba59 JD |
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 { | |
c4e361a4 | 188 | uint32_t status; /* enum lttng_viewer_get_packet_return_code */ |
d3e2ba59 | 189 | uint32_t len; |
c4e361a4 | 190 | uint32_t flags; /* LTTNG_VIEWER_FLAG_* */ |
d3e2ba59 JD |
191 | char data[]; |
192 | } __attribute__((__packed__)); | |
193 | ||
194 | /* | |
c4e361a4 | 195 | * LTTNG_VIEWER_GET_METADATA payload. |
d3e2ba59 JD |
196 | */ |
197 | struct lttng_viewer_get_metadata { | |
198 | uint64_t stream_id; | |
199 | } __attribute__((__packed__)); | |
200 | ||
201 | struct lttng_viewer_metadata_packet { | |
d3e2ba59 | 202 | uint64_t len; |
c4e361a4 | 203 | uint32_t status; /* enum lttng_viewer_get_metadata_return_code */ |
d3e2ba59 JD |
204 | char data[]; |
205 | } __attribute__((__packed__)); | |
206 | ||
80e8027a | 207 | /* |
c4e361a4 | 208 | * LTTNG_VIEWER_GET_NEW_STREAMS payload. |
80e8027a JD |
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 | ||
c4e361a4 | 222 | #endif /* LTTNG_VIEWER_H */ |