Initial import of kconsumerd and libkernelctl
[lttng-tools.git] / liblttsessiondcomm / liblttsessiondcomm.h
1 /*
2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Julien Desfossez <julien.desfossez@polymtl.ca>
4 *
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.
9 *
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.
14 *
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.
18 *
19 */
20
21 #ifndef _LIBLTTSESSIONDCOMM_H
22 #define _LIBLTTSESSIONDCOMM_H
23
24 #include <limits.h>
25 #include <uuid/uuid.h>
26
27 #include "lttng-share.h"
28
29 #define LTTNG_RUNDIR "/var/run/lttng"
30
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"
36
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"
41
42 /* Queue size of listen(2) */
43 #define MAX_LISTEN 10
44
45 /* Get the error code index from 0 since
46 * LTTCOMM_OK start at 1000
47 */
48 #define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_OK)
49
50 enum lttcomm_sessiond_command {
51 LTTNG_CREATE_SESSION,
52 LTTNG_DESTROY_SESSION,
53 LTTNG_FORCE_SUBBUF_SWITCH,
54 LTTNG_GET_ALL_SESSION,
55 LTTNG_GET_SOCK_PATH,
56 LTTNG_GET_SUBBUF_NUM_SIZE,
57 LTTNG_LIST_MARKERS,
58 LTTNG_LIST_SESSIONS,
59 LTTNG_LIST_TRACES,
60 LTTNG_LIST_TRACE_EVENTS,
61 LTTNG_SETUP_TRACE,
62 LTTNG_SET_SOCK_PATH,
63 LTTNG_SET_SUBBUF_NUM,
64 LTTNG_SET_SUBBUF_SIZE,
65 UST_ALLOC_TRACE,
66 UST_CREATE_TRACE,
67 UST_DESTROY_TRACE,
68 UST_DISABLE_MARKER,
69 UST_ENABLE_MARKER,
70 UST_LIST_APPS,
71 UST_START_TRACE,
72 UST_STOP_TRACE,
73 };
74
75 /*
76 * lttcomm error code.
77 */
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 */
97 KCONSUMERD_COMMAND_SOCK_READY, /* when kconsumerd command socket ready */
98 KCONSUMERD_SUCCESS_RECV_FD, /* success on receiving fds */
99 KCONSUMERD_ERROR_RECV_FD, /* error on receiving fds */
100 KCONSUMERD_POLL_ERROR, /* Error in polling thread in kconsumerd */
101 KCONSUMERD_POLL_NVAL, /* Poll on closed fd */
102 KCONSUMERD_POLL_HUP, /* All fds have hungup */
103 KCONSUMERD_EXIT_SUCCESS, /* kconsumerd exiting normally */
104 KCONSUMERD_EXIT_FAILURE, /* kconsumerd exiting on error */
105 KCONSUMERD_OUTFD_ERROR, /* error opening the tracefile */
106 };
107
108 /* commands for kconsumerd */
109 enum lttcomm_consumerd_command {
110 LTTCOMM_ADD_STREAM = 1100,
111 LTTCOMM_UPDATE_STREAM, /* pause, delete, start depending on fd state */
112 LTTCOMM_STOP, /* delete all */
113 };
114
115 /* state of each fd in consumerd */
116 enum lttcomm_kconsumerd_fd_state {
117 ACTIVE_FD,
118 PAUSE_FD,
119 DELETE_FD,
120 };
121
122 /*
123 * Data structure received from lttng client to session daemon.
124 */
125 struct lttcomm_session_msg {
126 u32 cmd_type; /* enum lttcomm_sessiond_command */
127 uuid_t session_uuid;
128 char trace_name[NAME_MAX];
129 char session_name[NAME_MAX];
130 u32 pid; /* pid_t */
131 union {
132 struct {
133 int auto_session;
134 } create_session;
135 /* Marker data */
136 struct {
137 char channel[NAME_MAX];
138 char marker[NAME_MAX];
139 } marker;
140 /* SET_SOCK_PATH */
141 struct {
142 char sock_path[PATH_MAX];
143 } sock_path;
144 /* SET_SUBBUF_NUM */
145 struct {
146 unsigned int subbuf_num;
147 char channel[NAME_MAX];
148 } subbuf_num;
149 /* SET_SUBBUF_SIZE */
150 struct {
151 unsigned int subbuf_size;
152 char channel[NAME_MAX];
153 } subbuf_size;
154 } u;
155 };
156
157 /*
158 * Data structure for the response from sessiond to the lttng client.
159 */
160 struct lttcomm_lttng_msg {
161 u32 cmd_type; /* enum lttcomm_sessiond_command */
162 u32 ret_code; /* enum lttcomm_return_code */
163 u32 pid; /* pid_t */
164 u32 trace_name_offset;
165 u32 data_size;
166 uuid_t session_uuid;
167 /* Contains: trace_name + data */
168 char payload[];
169 };
170
171 /*
172 * Data structures for the kconsumerd communications
173 *
174 * The header structure is sent to the kconsumerd daemon to inform
175 * how many lttcomm_kconsumerd_msg it is about to receive
176 */
177 struct lttcomm_kconsumerd_header {
178 u32 payload_size;
179 u32 cmd_type; /* enum lttcomm_consumerd_command */
180 u32 ret_code; /* enum lttcomm_return_code */
181 };
182
183 /* lttcomm_kconsumerd_msg represents a file descriptor to consume the
184 * data and a path name to write it
185 */
186 struct lttcomm_kconsumerd_msg {
187 char path_name[PATH_MAX];
188 int fd;
189 u32 state; /* enum lttcomm_kconsumerd_fd_state */
190 unsigned long max_sb_size; /* the subbuffer size for this channel */
191 };
192
193 extern int lttcomm_create_unix_sock(const char *pathname);
194 extern int lttcomm_connect_unix_sock(const char *pathname);
195 extern int lttcomm_accept_unix_sock(int sock);
196 extern int lttcomm_listen_unix_sock(int sock);
197 extern int lttcomm_close_unix_sock(int sock);
198 extern ssize_t lttcomm_recv_unix_sock(int sock, void *buf, size_t len);
199 extern ssize_t lttcomm_send_unix_sock(int sock, void *buf, size_t len);
200 extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
201
202 #endif /* _LIBLTTSESSIONDCOMM_H */
This page took 0.048591 seconds and 4 git commands to generate.