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_ABI_HOST_NAME_MAX 64
34 /* Flags in reply to get_next_index and get_packet. */
35 /* New metadata is required to read this packet. */
36 #define LTTNG_VIEWER_FLAG_NEW_METADATA (1 << 0)
37 /* New stream got added to the trace. */
38 #define LTTNG_VIEWER_FLAG_NEW_STREAM (1 << 1)
40 enum lttng_viewer_command
{
42 VIEWER_LIST_SESSIONS
= 2,
43 VIEWER_ATTACH_SESSION
= 3,
44 VIEWER_GET_NEXT_INDEX
= 4,
45 VIEWER_GET_PACKET
= 5,
46 VIEWER_GET_METADATA
= 6,
47 VIEWER_GET_NEW_STREAMS
= 7,
50 enum lttng_viewer_attach_return_code
{
51 VIEWER_ATTACH_OK
= 1, /* If the attach command succeeded. */
52 VIEWER_ATTACH_ALREADY
= 2, /* If a viewer is already attached. */
53 VIEWER_ATTACH_UNK
= 3, /* If the session ID is unknown. */
54 VIEWER_ATTACH_NOT_LIVE
= 4, /* If the session is not live. */
55 VIEWER_ATTACH_SEEK_ERR
= 5, /* Seek error. */
58 enum lttng_viewer_next_index_return_code
{
59 VIEWER_INDEX_OK
= 1, /* Index is available. */
60 VIEWER_INDEX_RETRY
= 2, /* Index not yet available. */
61 VIEWER_INDEX_HUP
= 3, /* Index closed (trace destroyed). */
62 VIEWER_INDEX_ERR
= 4, /* Unknow error. */
63 VIEWER_INDEX_INACTIVE
= 5, /* Inactive stream beacon. */
64 VIEWER_INDEX_EOF
= 6, /* End of index file. */
67 enum lttng_viewer_get_packet_return_code
{
68 VIEWER_GET_PACKET_OK
= 1,
69 VIEWER_GET_PACKET_RETRY
= 2,
70 VIEWER_GET_PACKET_ERR
= 3,
71 VIEWER_GET_PACKET_EOF
= 4,
74 enum lttng_viewer_get_metadata_return_code
{
75 VIEWER_METADATA_OK
= 1,
76 VIEWER_NO_NEW_METADATA
= 2,
77 VIEWER_METADATA_ERR
= 3,
80 enum lttng_viewer_connection_type
{
81 VIEWER_CLIENT_COMMAND
= 1,
82 VIEWER_CLIENT_NOTIFICATION
= 2,
85 enum lttng_viewer_seek
{
86 /* Receive the trace packets from the beginning. */
87 VIEWER_SEEK_BEGINNING
= 1,
88 /* Receive the trace packets from now. */
92 enum lttng_viewer_new_streams_return_code
{
93 VIEWER_NEW_STREAMS_OK
= 1, /* If new streams are being sent. */
94 VIEWER_NEW_STREAMS_NO_NEW
= 2, /* If no new streams are available. */
95 VIEWER_NEW_STREAMS_ERR
= 3, /* Error. */
98 struct lttng_viewer_session
{
103 char hostname
[LTTNG_VIEWER_ABI_HOST_NAME_MAX
];
104 char session_name
[LTTNG_VIEWER_NAME_MAX
];
105 } __attribute__((__packed__
));
107 struct lttng_viewer_stream
{
109 uint64_t ctf_trace_id
;
111 char path_name
[LTTNG_VIEWER_PATH_MAX
];
112 char channel_name
[LTTNG_VIEWER_NAME_MAX
];
113 } __attribute__((__packed__
));
115 struct lttng_viewer_cmd
{
116 uint64_t data_size
; /* data size following this header */
117 uint32_t cmd
; /* enum lttcomm_relayd_command */
118 uint32_t cmd_version
; /* command version */
119 } __attribute__((__packed__
));
124 struct lttng_viewer_connect
{
125 /* session ID assigned by the relay for command connections */
126 uint64_t viewer_session_id
;
129 uint32_t type
; /* enum lttng_viewer_connection_type */
130 } __attribute__((__packed__
));
133 * VIEWER_LIST_SESSIONS payload.
135 struct lttng_viewer_list_sessions
{
136 uint32_t sessions_count
;
137 char session_list
[]; /* struct lttng_viewer_session */
138 } __attribute__((__packed__
));
141 * VIEWER_ATTACH_SESSION payload.
143 struct lttng_viewer_attach_session_request
{
145 uint64_t offset
; /* unused for now */
146 uint32_t seek
; /* enum lttng_viewer_seek */
147 } __attribute__((__packed__
));
149 struct lttng_viewer_attach_session_response
{
150 /* enum lttng_viewer_attach_return_code */
152 uint32_t streams_count
;
153 /* struct lttng_viewer_stream */
155 } __attribute__((__packed__
));
158 * VIEWER_GET_NEXT_INDEX payload.
160 struct lttng_viewer_get_next_index
{
162 } __attribute__ ((__packed__
));
164 struct lttng_viewer_index
{
166 uint64_t packet_size
;
167 uint64_t content_size
;
168 uint64_t timestamp_begin
;
169 uint64_t timestamp_end
;
170 uint64_t events_discarded
;
172 /* enum lttng_viewer_next_index_return_code */
174 uint32_t flags
; /* LTTNG_VIEWER_FLAG_* */
175 } __attribute__ ((__packed__
));
178 * VIEWER_GET_PACKET payload.
180 struct lttng_viewer_get_packet
{
184 } __attribute__((__packed__
));
186 struct lttng_viewer_trace_packet
{
187 /* enum lttng_viewer_get_packet_return_code */
190 uint32_t flags
; /* LTTNG_VIEWER_FLAG_* */
192 } __attribute__((__packed__
));
195 * VIEWER_GET_METADATA payload.
197 struct lttng_viewer_get_metadata
{
199 } __attribute__((__packed__
));
201 struct lttng_viewer_metadata_packet
{
203 /* enum lttng_viewer_get_metadata_return_code */
206 } __attribute__((__packed__
));
209 * VIEWER_GET_NEW_STREAMS payload.
211 struct lttng_viewer_new_streams_request
{
213 } __attribute__((__packed__
));
215 struct lttng_viewer_new_streams_response
{
216 /* enum lttng_viewer_new_streams_return_code */
218 uint32_t streams_count
;
219 /* struct lttng_viewer_stream */
221 } __attribute__((__packed__
));
224 #endif /* LTTNG_VIEWER_ABI_H */