2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Julien Desfossez <julien.desfossez@polymtl.ca>
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License
7 * as published by the Free Software Foundation; either version 2
8 * of the License, or (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
21 #ifndef _LIBLTTSESSIONDCOMM_H
22 #define _LIBLTTSESSIONDCOMM_H
25 #include <uuid/uuid.h>
28 * FIXME: 32, 64bit enums -> uint32_t uint64_t for data exchange.
32 #define LTTNG_RUNDIR "/var/run/lttng"
34 /* Default unix socket path */
35 #define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK LTTNG_RUNDIR "/client-ltt-sessiond"
36 #define DEFAULT_GLOBAL_APPS_UNIX_SOCK LTTNG_RUNDIR "/apps-ltt-sessiond"
37 #define DEFAULT_HOME_APPS_UNIX_SOCK "%s/.apps-ltt-sessiond"
38 #define DEFAULT_HOME_CLIENT_UNIX_SOCK "%s/.client-ltt-sessiond"
40 /* Kernel consumer path */
41 #define KCONSUMERD_PATH LTTNG_RUNDIR "/kconsumerd"
42 #define KCONSUMERD_CMD_SOCK_PATH KCONSUMERD_PATH "/command"
43 #define KCONSUMERD_ERR_SOCK_PATH KCONSUMERD_PATH "/error"
45 /* Queue size of listen(2) */
48 /* Get the error code index from 0 since
49 * LTTCOMM_OK start at 1000
51 #define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_OK)
53 enum lttcomm_sessiond_command
{
55 LTTNG_DESTROY_SESSION
,
56 LTTNG_FORCE_SUBBUF_SWITCH
,
57 LTTNG_GET_ALL_SESSION
,
59 LTTNG_GET_SUBBUF_NUM_SIZE
,
63 LTTNG_LIST_TRACE_EVENTS
,
67 LTTNG_SET_SUBBUF_SIZE
,
81 enum lttcomm_return_code
{
82 LTTCOMM_OK
= 1000, /* Ok */
83 LTTCOMM_ERR
, /* Unknown Error */
84 LTTCOMM_UND
, /* Undefine command */
85 LTTCOMM_ALLOC_FAIL
, /* Trace allocation fail */
86 LTTCOMM_NO_SESSION
, /* No session found */
87 LTTCOMM_CREATE_FAIL
, /* Create trace fail */
88 LTTCOMM_SESSION_FAIL
, /* Create session fail */
89 LTTCOMM_START_FAIL
, /* Start tracing fail */
90 LTTCOMM_STOP_FAIL
, /* Stop tracing fail */
91 LTTCOMM_LIST_FAIL
, /* Listing apps fail */
92 LTTCOMM_NO_APPS
, /* No traceable application */
93 LTTCOMM_NO_SESS
, /* No sessions available */
94 LTTCOMM_NO_TRACE
, /* No trace exist */
95 LTTCOMM_FATAL
, /* Session daemon had a fatal error */
96 LTTCOMM_NO_TRACEABLE
, /* Error for non traceable app */
97 LTTCOMM_SELECT_SESS
, /* Must select a session */
98 LTTCOMM_EXIST_SESS
, /* Session name already exist */
99 LTTCOMM_NR
, /* Last element */
102 /* commands for kconsumerd */
103 enum lttcomm_consumerd_command
{
104 LTTCOMM_ADD_STREAM
= 1100,
105 LTTCOMM_UPDATE_STREAM
, /* pause, delete, start depending on fd state */
106 LTTCOMM_STOP
, /* delete all */
109 /* state of each fd in consumerd */
110 enum lttcomm_kconsumerd_fd_state
{
117 * Data structure for ltt-session received message
119 struct lttcomm_session_msg
{
120 /* Common data to almost all command */
121 enum lttcomm_sessiond_command cmd_type
;
123 char trace_name
[NAME_MAX
];
124 char session_name
[NAME_MAX
];
132 char channel
[NAME_MAX
];
133 char marker
[NAME_MAX
];
137 char sock_path
[PATH_MAX
];
141 unsigned int subbuf_num
;
142 char channel
[NAME_MAX
];
144 /* SET_SUBBUF_SIZE */
146 unsigned int subbuf_size
;
147 char channel
[NAME_MAX
];
153 * Data structure for the response from sessiond to the lttng client.
155 * This data structure is the control struct use in
156 * the header of the transmission. NEVER put variable
159 struct lttcomm_lttng_header
{
160 enum lttcomm_sessiond_command cmd_type
;
161 enum lttcomm_return_code ret_code
;
164 char trace_name
[NAME_MAX
];
165 unsigned int payload_size
;
169 * Data structures for the kconsumerd communications
171 * The header structure is sent to the kconsumerd daemon to inform
172 * how many lttcomm_kconsumerd_msg it is about to receive
174 struct lttcomm_kconsumerd_header
{
175 unsigned int payload_size
;
176 enum lttcomm_consumerd_command cmd_type
;
177 enum lttcomm_return_code ret_code
;
180 /* lttcomm_kconsumerd_msg represents a file descriptor to consume the
181 * data and a path name to write it
183 struct lttcomm_kconsumerd_msg
{
184 char path_name
[PATH_MAX
];
186 enum lttcomm_kconsumerd_fd_state state
;
189 extern int lttcomm_create_unix_sock(const char *pathname
);
190 extern int lttcomm_connect_unix_sock(const char *pathname
);
191 extern int lttcomm_accept_unix_sock(int sock
);
192 extern int lttcomm_listen_unix_sock(int sock
);
193 extern int lttcomm_close_unix_sock(int sock
);
194 extern ssize_t
lttcomm_recv_unix_sock(int sock
, void *buf
, size_t len
);
195 extern ssize_t
lttcomm_send_unix_sock(int sock
, void *buf
, size_t len
);
196 extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code
);
198 #endif /* _LIBLTTSESSIONDCOMM_H */