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_HOST_NAME_MAX 64
34 /* Flags in reply to get_next_index and get_packet. */
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),
42 enum lttng_viewer_command
{
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,
51 enum lttng_viewer_attach_return_code
{
52 LTTNG_VIEWER_ATTACH_OK
= 1, /* The attach command succeeded. */
53 LTTNG_VIEWER_ATTACH_ALREADY
= 2, /* A viewer is already attached. */
54 LTTNG_VIEWER_ATTACH_UNK
= 3, /* The session ID is unknown. */
55 LTTNG_VIEWER_ATTACH_NOT_LIVE
= 4, /* The session is not live. */
56 LTTNG_VIEWER_ATTACH_SEEK_ERR
= 5, /* Seek error. */
59 enum lttng_viewer_next_index_return_code
{
60 LTTNG_VIEWER_INDEX_OK
= 1, /* Index is available. */
61 LTTNG_VIEWER_INDEX_RETRY
= 2, /* Index not yet available. */
62 LTTNG_VIEWER_INDEX_HUP
= 3, /* Index closed (trace destroyed). */
63 LTTNG_VIEWER_INDEX_ERR
= 4, /* Unknow error. */
64 LTTNG_VIEWER_INDEX_INACTIVE
= 5, /* Inactive stream beacon. */
65 LTTNG_VIEWER_INDEX_EOF
= 6, /* End of index file. */
68 enum lttng_viewer_get_packet_return_code
{
69 LTTNG_VIEWER_GET_PACKET_OK
= 1,
70 LTTNG_VIEWER_GET_PACKET_RETRY
= 2,
71 LTTNG_VIEWER_GET_PACKET_ERR
= 3,
72 LTTNG_VIEWER_GET_PACKET_EOF
= 4,
75 enum lttng_viewer_get_metadata_return_code
{
76 LTTNG_VIEWER_METADATA_OK
= 1,
77 LTTNG_VIEWER_NO_NEW_METADATA
= 2,
78 LTTNG_VIEWER_METADATA_ERR
= 3,
81 enum lttng_viewer_connection_type
{
82 LTTNG_VIEWER_CLIENT_COMMAND
= 1,
83 LTTNG_VIEWER_CLIENT_NOTIFICATION
= 2,
86 enum lttng_viewer_seek
{
87 /* Receive the trace packets from the beginning. */
88 LTTNG_VIEWER_SEEK_BEGINNING
= 1,
89 /* Receive the trace packets from now. */
90 LTTNG_VIEWER_SEEK_LAST
= 2,
93 struct lttng_viewer_session
{
98 char hostname
[LTTNG_VIEWER_HOST_NAME_MAX
];
99 char session_name
[LTTNG_VIEWER_NAME_MAX
];
100 } __attribute__((__packed__
));
102 struct lttng_viewer_stream
{
104 uint64_t ctf_trace_id
;
106 char path_name
[LTTNG_VIEWER_PATH_MAX
];
107 char channel_name
[LTTNG_VIEWER_NAME_MAX
];
108 } __attribute__((__packed__
));
110 struct lttng_viewer_cmd
{
111 uint64_t data_size
; /* data size following this header */
112 uint32_t cmd
; /* enum lttcomm_relayd_command */
113 uint32_t cmd_version
; /* command version */
114 } __attribute__((__packed__
));
117 * LTTNG_VIEWER_CONNECT payload.
119 struct lttng_viewer_connect
{
120 /* session ID assigned by the relay for command connections */
121 uint64_t viewer_session_id
;
124 uint32_t type
; /* enum lttng_viewer_connection_type */
125 } __attribute__((__packed__
));
128 * LTTNG_VIEWER_LIST_SESSIONS payload.
130 struct lttng_viewer_list_sessions
{
131 uint32_t sessions_count
;
132 char session_list
[]; /* struct lttng_viewer_session */
133 } __attribute__((__packed__
));
136 * LTTNG_VIEWER_ATTACH_SESSION payload.
138 struct lttng_viewer_attach_session_request
{
140 uint64_t offset
; /* unused for now */
141 uint32_t seek
; /* enum lttng_viewer_seek */
142 } __attribute__((__packed__
));
144 struct lttng_viewer_attach_session_response
{
145 /* enum lttng_viewer_attach_return_code */
147 uint32_t streams_count
;
148 /* struct lttng_viewer_stream */
150 } __attribute__((__packed__
));
153 * LTTNG_VIEWER_GET_NEXT_INDEX payload.
155 struct lttng_viewer_get_next_index
{
157 } __attribute__ ((__packed__
));
159 struct lttng_viewer_index
{
161 uint64_t packet_size
;
162 uint64_t content_size
;
163 uint64_t timestamp_begin
;
164 uint64_t timestamp_end
;
165 uint64_t events_discarded
;
167 uint32_t status
; /* enum lttng_viewer_next_index_return_code */
168 uint32_t flags
; /* LTTNG_VIEWER_FLAG_* */
169 } __attribute__ ((__packed__
));
172 * LTTNG_VIEWER_GET_PACKET payload.
174 struct lttng_viewer_get_packet
{
178 } __attribute__((__packed__
));
180 struct lttng_viewer_trace_packet
{
181 uint32_t status
; /* enum lttng_viewer_get_packet_return_code */
183 uint32_t flags
; /* LTTNG_VIEWER_FLAG_* */
185 } __attribute__((__packed__
));
188 * LTTNG_VIEWER_GET_METADATA payload.
190 struct lttng_viewer_get_metadata
{
192 } __attribute__((__packed__
));
194 struct lttng_viewer_metadata_packet
{
196 uint32_t status
; /* enum lttng_viewer_get_metadata_return_code */
198 } __attribute__((__packed__
));
200 #endif /* LTTNG_VIEWER_H */