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>
27 #include "lttng-share.h"
29 #define LTTNG_RUNDIR "/var/run/lttng"
31 /* Default unix socket path */
32 #define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK LTTNG_RUNDIR "/client-ltt-sessiond"
33 #define DEFAULT_GLOBAL_APPS_UNIX_SOCK LTTNG_RUNDIR "/apps-ltt-sessiond"
34 #define DEFAULT_HOME_APPS_UNIX_SOCK "%s/.apps-ltt-sessiond"
35 #define DEFAULT_HOME_CLIENT_UNIX_SOCK "%s/.client-ltt-sessiond"
37 /* Kernel consumer path */
38 #define KCONSUMERD_PATH LTTNG_RUNDIR "/kconsumerd"
39 #define KCONSUMERD_CMD_SOCK_PATH KCONSUMERD_PATH "/command"
40 #define KCONSUMERD_ERR_SOCK_PATH KCONSUMERD_PATH "/error"
42 /* Queue size of listen(2) */
45 /* Get the error code index from 0 since
46 * LTTCOMM_OK start at 1000
48 #define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_OK)
50 enum lttcomm_sessiond_command
{
52 LTTNG_DESTROY_SESSION
,
53 LTTNG_FORCE_SUBBUF_SWITCH
,
54 LTTNG_GET_ALL_SESSION
,
56 LTTNG_GET_SUBBUF_NUM_SIZE
,
60 LTTNG_LIST_TRACE_EVENTS
,
64 LTTNG_SET_SUBBUF_SIZE
,
78 enum lttcomm_return_code
{
79 LTTCOMM_OK
= 1000, /* Ok */
80 LTTCOMM_ERR
, /* Unknown Error */
81 LTTCOMM_UND
, /* Undefine command */
82 LTTCOMM_ALLOC_FAIL
, /* Trace allocation fail */
83 LTTCOMM_NO_SESSION
, /* No session found */
84 LTTCOMM_CREATE_FAIL
, /* Create trace fail */
85 LTTCOMM_SESSION_FAIL
, /* Create session fail */
86 LTTCOMM_START_FAIL
, /* Start tracing fail */
87 LTTCOMM_STOP_FAIL
, /* Stop tracing fail */
88 LTTCOMM_LIST_FAIL
, /* Listing apps fail */
89 LTTCOMM_NO_APPS
, /* No traceable application */
90 LTTCOMM_NO_SESS
, /* No sessions available */
91 LTTCOMM_NO_TRACE
, /* No trace exist */
92 LTTCOMM_FATAL
, /* Session daemon had a fatal error */
93 LTTCOMM_NO_TRACEABLE
, /* Error for non traceable app */
94 LTTCOMM_SELECT_SESS
, /* Must select a session */
95 LTTCOMM_EXIST_SESS
, /* Session name already exist */
96 LTTCOMM_NR
, /* Last element */
99 /* commands for kconsumerd */
100 enum lttcomm_consumerd_command
{
101 LTTCOMM_ADD_STREAM
= 1100,
102 LTTCOMM_UPDATE_STREAM
, /* pause, delete, start depending on fd state */
103 LTTCOMM_STOP
, /* delete all */
106 /* state of each fd in consumerd */
107 enum lttcomm_kconsumerd_fd_state
{
114 * Data structure received from lttng client to session daemon.
116 struct lttcomm_session_msg
{
117 u32 cmd_type
; /* enum lttcomm_sessiond_command */
119 char trace_name
[NAME_MAX
];
120 char session_name
[NAME_MAX
];
128 char channel
[NAME_MAX
];
129 char marker
[NAME_MAX
];
133 char sock_path
[PATH_MAX
];
137 unsigned int subbuf_num
;
138 char channel
[NAME_MAX
];
140 /* SET_SUBBUF_SIZE */
142 unsigned int subbuf_size
;
143 char channel
[NAME_MAX
];
149 * Data structure for the response from sessiond to the lttng client.
151 struct lttcomm_lttng_msg
{
152 u32 cmd_type
; /* enum lttcomm_sessiond_command */
153 u32 ret_code
; /* enum lttcomm_return_code */
155 u32 trace_name_offset
;
158 /* Contains: trace_name + data */
163 * Data structures for the kconsumerd communications
165 * The header structure is sent to the kconsumerd daemon to inform
166 * how many lttcomm_kconsumerd_msg it is about to receive
168 struct lttcomm_kconsumerd_header
{
170 u32 cmd_type
; /* enum lttcomm_consumerd_command */
171 u32 ret_code
; /* enum lttcomm_return_code */
174 /* lttcomm_kconsumerd_msg represents a file descriptor to consume the
175 * data and a path name to write it
177 struct lttcomm_kconsumerd_msg
{
178 char path_name
[PATH_MAX
];
180 u32 state
; /* enum lttcomm_kconsumerd_fd_state */
183 extern int lttcomm_create_unix_sock(const char *pathname
);
184 extern int lttcomm_connect_unix_sock(const char *pathname
);
185 extern int lttcomm_accept_unix_sock(int sock
);
186 extern int lttcomm_listen_unix_sock(int sock
);
187 extern int lttcomm_close_unix_sock(int sock
);
188 extern ssize_t
lttcomm_recv_unix_sock(int sock
, void *buf
, size_t len
);
189 extern ssize_t
lttcomm_send_unix_sock(int sock
, void *buf
, size_t len
);
190 extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code
);
192 #endif /* _LIBLTTSESSIONDCOMM_H */