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