Commit | Line | Data |
---|---|---|
67c5b804 MD |
1 | #ifndef _LTTNG_SESSIOND_COMM_H |
2 | #define _LTTNG_SESSIOND_COMM_H | |
3 | ||
4 | /* | |
5 | * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca> | |
6 | * Julien Desfossez <julien.desfossez@polymtl.ca> | |
7 | * Mathieu Desnoyers <mathieu.desnoyers@efficios.com> | |
8 | * | |
9 | * This program is free software; you can redistribute it and/or | |
10 | * modify it under the terms of the GNU General Public License | |
11 | * as published by the Free Software Foundation; only version 2 | |
12 | * of the License. | |
13 | * | |
14 | * This program is distributed in the hope that it will be useful, | |
15 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
17 | * GNU General Public License for more details. | |
18 | * | |
19 | * You should have received a copy of the GNU General Public License | |
20 | * along with this program; if not, write to the Free Software | |
21 | * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. | |
22 | */ | |
23 | ||
24 | /* | |
25 | * This header is meant for liblttng and libust internal use ONLY. | |
26 | * These declarations should NOT be considered stable API. | |
27 | */ | |
28 | ||
29 | #include <limits.h> | |
30 | #include <lttng/lttng.h> | |
31 | ||
32 | #define LTTNG_RUNDIR "/var/run/lttng" | |
33 | ||
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" | |
39 | ||
40 | /* Queue size of listen(2) */ | |
41 | #define MAX_LISTEN 10 | |
42 | ||
43 | /* Get the error code index from 0 since | |
44 | * LTTCOMM_OK start at 1000 | |
45 | */ | |
46 | #define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_OK) | |
47 | ||
e7723462 | 48 | enum lttcomm_ust_command { |
67c5b804 MD |
49 | /* Tracer command */ |
50 | LTTNG_ADD_CONTEXT, | |
51 | LTTNG_CALIBRATE, | |
52 | LTTNG_DISABLE_CHANNEL, | |
53 | LTTNG_DISABLE_EVENT, | |
54 | LTTNG_DISABLE_ALL_EVENT, | |
55 | LTTNG_ENABLE_CHANNEL, | |
56 | LTTNG_ENABLE_EVENT, | |
57 | LTTNG_ENABLE_ALL_EVENT, | |
58 | /* Session daemon command */ | |
59 | LTTNG_CREATE_SESSION, | |
60 | LTTNG_DESTROY_SESSION, | |
61 | LTTNG_LIST_CHANNELS, | |
62 | LTTNG_LIST_DOMAINS, | |
63 | LTTNG_LIST_EVENTS, | |
64 | LTTNG_LIST_SESSIONS, | |
65 | LTTNG_LIST_TRACEPOINTS, | |
66 | LTTNG_START_TRACE, | |
67 | LTTNG_STOP_TRACE, | |
68 | }; | |
69 | ||
70 | /* | |
71 | * lttcomm error code. | |
72 | */ | |
73 | enum lttcomm_return_code { | |
74 | LTTCOMM_OK = 1000, /* Ok */ | |
75 | LTTCOMM_ERR, /* Unknown Error */ | |
76 | LTTCOMM_UND, /* Undefine command */ | |
77 | LTTCOMM_NOT_IMPLEMENTED, /* Command not implemented */ | |
78 | LTTCOMM_UNKNOWN_DOMAIN, /* Tracing domain not known */ | |
79 | LTTCOMM_ALLOC_FAIL, /* Trace allocation fail */ | |
80 | LTTCOMM_NO_SESSION, /* No session found */ | |
81 | LTTCOMM_CREATE_FAIL, /* Create trace fail */ | |
82 | LTTCOMM_SESSION_FAIL, /* Create session fail */ | |
83 | LTTCOMM_START_FAIL, /* Start tracing fail */ | |
84 | LTTCOMM_STOP_FAIL, /* Stop tracing fail */ | |
85 | LTTCOMM_LIST_FAIL, /* Listing apps fail */ | |
86 | LTTCOMM_NO_APPS, /* No traceable application */ | |
87 | LTTCOMM_SESS_NOT_FOUND, /* Session name not found */ | |
88 | LTTCOMM_NO_TRACE, /* No trace exist */ | |
89 | LTTCOMM_FATAL, /* Session daemon had a fatal error */ | |
90 | LTTCOMM_NO_TRACEABLE, /* Error for non traceable app */ | |
91 | LTTCOMM_SELECT_SESS, /* Must select a session */ | |
92 | LTTCOMM_EXIST_SESS, /* Session name already exist */ | |
93 | LTTCOMM_NO_EVENT, /* No event found */ | |
94 | LTTCOMM_KERN_NA, /* Kernel tracer unavalable */ | |
95 | LTTCOMM_KERN_EVENT_EXIST, /* Kernel event already exists */ | |
96 | LTTCOMM_KERN_SESS_FAIL, /* Kernel create session failed */ | |
97 | LTTCOMM_KERN_CHAN_FAIL, /* Kernel create channel failed */ | |
98 | LTTCOMM_KERN_CHAN_NOT_FOUND, /* Kernel channel not found */ | |
99 | LTTCOMM_KERN_CHAN_DISABLE_FAIL, /* Kernel disable channel failed */ | |
100 | LTTCOMM_KERN_CHAN_ENABLE_FAIL, /* Kernel enable channel failed */ | |
101 | LTTCOMM_KERN_CONTEXT_FAIL, /* Kernel add context failed */ | |
102 | LTTCOMM_KERN_ENABLE_FAIL, /* Kernel enable event failed */ | |
103 | LTTCOMM_KERN_DISABLE_FAIL, /* Kernel disable event failed */ | |
104 | LTTCOMM_KERN_META_FAIL, /* Kernel open metadata failed */ | |
105 | LTTCOMM_KERN_START_FAIL, /* Kernel start trace failed */ | |
106 | LTTCOMM_KERN_STOP_FAIL, /* Kernel stop trace failed */ | |
107 | LTTCOMM_KERN_CONSUMER_FAIL, /* Kernel consumer start failed */ | |
108 | LTTCOMM_KERN_STREAM_FAIL, /* Kernel create stream failed */ | |
109 | LTTCOMM_KERN_DIR_FAIL, /* Kernel trace directory creation failed */ | |
110 | LTTCOMM_KERN_DIR_EXIST, /* Kernel trace directory exist */ | |
111 | LTTCOMM_KERN_NO_SESSION, /* No kernel session found */ | |
112 | LTTCOMM_KERN_LIST_FAIL, /* Kernel listing events failed */ | |
113 | KCONSUMERD_COMMAND_SOCK_READY, /* when kconsumerd command socket ready */ | |
114 | KCONSUMERD_SUCCESS_RECV_FD, /* success on receiving fds */ | |
115 | KCONSUMERD_ERROR_RECV_FD, /* error on receiving fds */ | |
116 | KCONSUMERD_POLL_ERROR, /* Error in polling thread in kconsumerd */ | |
117 | KCONSUMERD_POLL_NVAL, /* Poll on closed fd */ | |
118 | KCONSUMERD_POLL_HUP, /* All fds have hungup */ | |
119 | KCONSUMERD_EXIT_SUCCESS, /* kconsumerd exiting normally */ | |
120 | KCONSUMERD_EXIT_FAILURE, /* kconsumerd exiting on error */ | |
121 | KCONSUMERD_OUTFD_ERROR, /* error opening the tracefile */ | |
122 | KCONSUMERD_SPLICE_EBADF, /* EBADF from splice(2) */ | |
123 | KCONSUMERD_SPLICE_EINVAL, /* EINVAL from splice(2) */ | |
124 | KCONSUMERD_SPLICE_ENOMEM, /* ENOMEM from splice(2) */ | |
125 | KCONSUMERD_SPLICE_ESPIPE, /* ESPIPE from splice(2) */ | |
126 | /* MUST be last element */ | |
127 | LTTCOMM_NR, /* Last element */ | |
128 | }; | |
129 | ||
130 | /* | |
e7723462 | 131 | * Data structure for the commands sent from sessiond to UST. |
67c5b804 | 132 | */ |
e7723462 MD |
133 | struct lttcomm_ust_msg { |
134 | uint32_t cmd_type; /* enum lttcomm_ust_command */ | |
67c5b804 | 135 | union { |
67c5b804 MD |
136 | } u; |
137 | }; | |
138 | ||
9eb62b9c MD |
139 | /* |
140 | * Data structure for the response from UST to the session daemon. | |
141 | * cmd_type is sent back in the reply for validation. | |
142 | */ | |
e7723462 | 143 | struct lttcomm_ust_reply { |
9eb62b9c MD |
144 | uint32_t cmd_type; /* enum lttcomm_sessiond_command */ |
145 | uint32_t ret_code; /* enum enum lttcomm_return_code */ | |
146 | union { | |
147 | struct { | |
148 | uint32_t handle; /* session handle */ | |
149 | } session; | |
150 | struct { | |
151 | uint32_t handle; /* channel handle */ | |
152 | } channel; | |
153 | struct { | |
154 | uint32_t handle; /* event handle */ | |
155 | } event; | |
156 | } u; | |
157 | }; | |
158 | ||
67c5b804 MD |
159 | /* |
160 | * Data structures for the kconsumerd communications | |
161 | * | |
162 | * The header structure is sent to the kconsumerd daemon to inform | |
163 | * how many lttcomm_kconsumerd_msg it is about to receive | |
164 | */ | |
165 | struct lttcomm_kconsumerd_header { | |
166 | uint32_t payload_size; | |
167 | uint32_t cmd_type; /* enum kconsumerd_command */ | |
168 | }; | |
169 | ||
67c5b804 MD |
170 | extern int lttcomm_create_unix_sock(const char *pathname); |
171 | extern int lttcomm_connect_unix_sock(const char *pathname); | |
172 | extern int lttcomm_accept_unix_sock(int sock); | |
173 | extern int lttcomm_listen_unix_sock(int sock); | |
174 | extern int lttcomm_close_unix_sock(int sock); | |
175 | /* Send fd(s) over a unix socket. */ | |
176 | extern ssize_t lttcomm_send_fds_unix_sock(int sock, void *buf, int *fds, | |
177 | size_t nb_fd, size_t len); | |
178 | extern ssize_t lttcomm_recv_unix_sock(int sock, void *buf, size_t len); | |
179 | extern ssize_t lttcomm_send_unix_sock(int sock, void *buf, size_t len); | |
180 | extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code); | |
181 | ||
182 | #endif /* _LTTNG_SESSIOND_COMM_H */ |