Enforce const-correctness in UNIX socket wrappers
[lttng-tools.git] / src / common / defaults.h
1 /*
2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 * 2015 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License, version 2 only,
8 * as published by the Free Software Foundation.
9 *
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18 */
19
20 #ifndef _DEFAULTS_H
21 #define _DEFAULTS_H
22
23 #include <src/common/macros.h>
24
25 /* Default unix group name for tracing. */
26 #define DEFAULT_TRACING_GROUP "tracing"
27
28 /*
29 * This value is defined in the CTF specification (see
30 * git://git.efficios.com/ctf.git in the file
31 * common-trace-format-specification.txt.
32 */
33 #define DEFAULT_METADATA_NAME "metadata"
34
35 /* Environment variable to set session daemon binary path. */
36 #define DEFAULT_SESSIOND_PATH_ENV "LTTNG_SESSIOND_PATH"
37
38 /* Default trace output directory name */
39 #define DEFAULT_TRACE_DIR_NAME "lttng-traces"
40
41 /* Default size of a hash table */
42 #define DEFAULT_HT_SIZE 4
43
44 /* Default session daemon paths */
45 #define DEFAULT_HOME_DIR "/tmp"
46 #define DEFAULT_UST_SOCK_DIR DEFAULT_HOME_DIR "/ust-app-socks"
47 #define DEFAULT_GLOBAL_APPS_PIPE DEFAULT_UST_SOCK_DIR "/global"
48 #define DEFAULT_TRACE_OUTPUT DEFAULT_HOME_DIR "/lttng"
49
50 /* Default directory where the trace are written in per domain */
51 #define DEFAULT_KERNEL_TRACE_DIR "/kernel"
52 #define DEFAULT_UST_TRACE_DIR "/ust"
53
54 /* Subpath for per PID or UID sessions. */
55 #define DEFAULT_UST_TRACE_PID_PATH "/pid"
56 #define DEFAULT_UST_TRACE_UID_PATH "/uid/%d/%u-bit"
57
58 /*
59 * Default session name for the lttng command line. This default value will
60 * get the date and time appended (%Y%m%d-%H%M%S) to it.
61 */
62 #define DEFAULT_SESSION_NAME "auto"
63
64 /* Default consumer paths */
65 #define DEFAULT_CONSUMERD_RUNDIR "%s"
66
67 /* Kernel consumer path */
68 #define DEFAULT_KCONSUMERD_PATH DEFAULT_CONSUMERD_RUNDIR "/kconsumerd"
69 #define DEFAULT_KCONSUMERD_CMD_SOCK_PATH DEFAULT_KCONSUMERD_PATH "/command"
70 #define DEFAULT_KCONSUMERD_ERR_SOCK_PATH DEFAULT_KCONSUMERD_PATH "/error"
71
72 /* UST 64-bit consumer path */
73 #define DEFAULT_USTCONSUMERD64_PATH DEFAULT_CONSUMERD_RUNDIR "/ustconsumerd64"
74 #define DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH DEFAULT_USTCONSUMERD64_PATH "/command"
75 #define DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH DEFAULT_USTCONSUMERD64_PATH "/error"
76
77 /* UST 32-bit consumer path */
78 #define DEFAULT_USTCONSUMERD32_PATH DEFAULT_CONSUMERD_RUNDIR "/ustconsumerd32"
79 #define DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH DEFAULT_USTCONSUMERD32_PATH "/command"
80 #define DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH DEFAULT_USTCONSUMERD32_PATH "/error"
81
82 /* Relayd path */
83 #define DEFAULT_RELAYD_RUNDIR "%s"
84 #define DEFAULT_RELAYD_PATH DEFAULT_RELAYD_RUNDIR "/relayd"
85
86 /* Default lttng run directory */
87 #define DEFAULT_LTTNG_HOME_ENV_VAR "LTTNG_HOME"
88 #define DEFAULT_LTTNG_FALLBACK_HOME_ENV_VAR "HOME"
89 #define DEFAULT_LTTNG_RUNDIR CONFIG_LTTNG_SYSTEM_RUNDIR
90 #define DEFAULT_LTTNG_HOME_RUNDIR "%s/.lttng"
91 #define DEFAULT_LTTNG_SESSIOND_PIDFILE "lttng-sessiond.pid"
92 #define DEFAULT_LTTNG_SESSIOND_AGENTPORT_FILE "agent.port"
93 #define DEFAULT_LTTNG_SESSIOND_LOCKFILE "lttng-sessiond.lck"
94
95 /* Default probes list */
96 #define DEFAULT_LTTNG_KMOD_PROBES "LTTNG_KMOD_PROBES"
97
98 /* Default extra probes list */
99 #define DEFAULT_LTTNG_EXTRA_KMOD_PROBES "LTTNG_EXTRA_KMOD_PROBES"
100
101 /* Default unix socket path */
102 #define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/client-lttng-sessiond"
103 #define DEFAULT_HOME_CLIENT_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/client-lttng-sessiond"
104 #define DEFAULT_GLOBAL_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/sessiond-health"
105 #define DEFAULT_HOME_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/sessiond-health"
106
107 /* Default consumer health unix socket path */
108 #define DEFAULT_GLOBAL_USTCONSUMER32_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/ustconsumerd32/health"
109 #define DEFAULT_HOME_USTCONSUMER32_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/ustconsumerd32/health"
110 #define DEFAULT_GLOBAL_USTCONSUMER64_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/ustconsumerd64/health"
111 #define DEFAULT_HOME_USTCONSUMER64_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/ustconsumerd64/health"
112 #define DEFAULT_GLOBAL_KCONSUMER_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/kconsumerd/health"
113 #define DEFAULT_HOME_KCONSUMER_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/kconsumerd/health"
114
115 /* Default relay health unix socket path */
116 #define DEFAULT_GLOBAL_RELAY_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/relayd/health-%d"
117 #define DEFAULT_HOME_RELAY_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/relayd/health-%d"
118
119 /* Default daemon configuration file path */
120 #define DEFAULT_SYSTEM_CONFIGPATH CONFIG_LTTNG_SYSTEM_CONFIGDIR \
121 "/lttng"
122
123 #define DEFAULT_DAEMON_CONFIG_FILE "lttng.conf"
124 #define DEFAULT_DAEMON_HOME_CONFIGPATH DEFAULT_LTTNG_HOME_RUNDIR "/" \
125 DEFAULT_DAEMON_CONFIG_FILE
126 #define DEFAULT_DAEMON_SYSTEM_CONFIGPATH DEFAULT_SYSTEM_CONFIGPATH "/" \
127 DEFAULT_DAEMON_CONFIG_FILE
128
129 /* Default session configuration file path */
130 #define DEFAULT_SESSION_PATH "sessions"
131 /* Auto load session in that directory. */
132 #define DEFAULT_SESSION_CONFIG_AUTOLOAD "auto"
133 #define DEFAULT_SESSION_HOME_CONFIGPATH DEFAULT_LTTNG_HOME_RUNDIR "/" \
134 DEFAULT_SESSION_PATH
135 #define DEFAULT_SESSION_SYSTEM_CONFIGPATH DEFAULT_SYSTEM_CONFIGPATH "/" \
136 DEFAULT_SESSION_PATH
137 #define DEFAULT_SESSION_CONFIG_FILE_EXTENSION ".lttng"
138 #define DEFAULT_SESSION_CONFIG_XSD_FILENAME "session.xsd"
139 #define DEFAULT_SESSION_CONFIG_XSD_PATH CONFIG_LTTNG_SYSTEM_DATADIR "/xml/lttng/"
140 #define DEFAULT_SESSION_CONFIG_XSD_PATH_ENV "LTTNG_SESSION_CONFIG_XSD_PATH"
141
142 #define DEFAULT_GLOBAL_APPS_UNIX_SOCK \
143 DEFAULT_LTTNG_RUNDIR "/" LTTNG_UST_SOCK_FILENAME
144 #define DEFAULT_HOME_APPS_UNIX_SOCK \
145 DEFAULT_LTTNG_HOME_RUNDIR "/" LTTNG_UST_SOCK_FILENAME
146 #define DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH \
147 "/" LTTNG_UST_WAIT_FILENAME
148 #define DEFAULT_HOME_APPS_WAIT_SHM_PATH \
149 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH "-%d"
150
151 /*
152 * Value taken from the hard limit allowed by the kernel when using setrlimit
153 * with RLIMIT_NOFILE on an Intel i7 CPU and Linux 3.0.3.
154 */
155 #define DEFAULT_POLL_SIZE 65535
156
157 /*
158 * Format is %s_%d respectively channel name and CPU number. Eigth bytes
159 * are added here to add space for the CPU number. I guess 2^8 CPUs is more
160 * than enough. We might end up with quantum computing in a cell phone when
161 * reaching this limit.
162 */
163 #define DEFAULT_STREAM_NAME_LEN LTTNG_SYMBOL_NAME_LEN + 8
164
165 /* Default channel attributes */
166 #define DEFAULT_CHANNEL_NAME "channel0"
167 /* Default JUL domain channel name. */
168 #define DEFAULT_JUL_CHANNEL_NAME "lttng_jul_channel"
169 /* Default JUL tracepoint name. This is a wildcard for the JUL domain. */
170 #define DEFAULT_JUL_EVENT_COMPONENT "lttng_jul"
171 #define DEFAULT_JUL_EVENT_NAME DEFAULT_JUL_EVENT_COMPONENT ":*"
172
173 /* Default log4j domain channel name. */
174 #define DEFAULT_LOG4J_CHANNEL_NAME "lttng_log4j_channel"
175 /* Default log4j tracepoint name. This is a wildcard for the log4j domain. */
176 #define DEFAULT_LOG4J_EVENT_COMPONENT "lttng_log4j"
177 #define DEFAULT_LOG4J_EVENT_NAME DEFAULT_LOG4J_EVENT_COMPONENT ":*"
178
179 /* Default Python domain channel name. */
180 #define DEFAULT_PYTHON_CHANNEL_NAME "lttng_python_channel"
181 /* Default Python tracepoint name. This is a wildcard for the python domain. */
182 #define DEFAULT_PYTHON_EVENT_COMPONENT "lttng_python"
183 #define DEFAULT_PYTHON_EVENT_NAME DEFAULT_PYTHON_EVENT_COMPONENT ":*"
184
185 #define DEFAULT_CHANNEL_OVERWRITE 0
186 #define DEFAULT_CHANNEL_TRACEFILE_SIZE 0
187 #define DEFAULT_CHANNEL_TRACEFILE_COUNT 0
188
189 /* Must always be a power of 2 */
190 #define _DEFAULT_CHANNEL_SUBBUF_SIZE 4096 /* bytes */
191 /* Must always be a power of 2 */
192 #define _DEFAULT_CHANNEL_SUBBUF_NUM 4
193 #define _DEFAULT_CHANNEL_SWITCH_TIMER 0 /* usec */
194 #define _DEFAULT_CHANNEL_LIVE_TIMER 0 /* usec */
195 #define _DEFAULT_CHANNEL_READ_TIMER 200000 /* usec */
196 #define _DEFAULT_CHANNEL_OUTPUT LTTNG_EVENT_MMAP
197
198 /* Metadata channel defaults. */
199 #define DEFAULT_METADATA_SUBBUF_SIZE 4096
200 #define DEFAULT_METADATA_SUBBUF_NUM 2
201 #define DEFAULT_METADATA_CACHE_SIZE 4096
202 #define DEFAULT_METADATA_SWITCH_TIMER _DEFAULT_CHANNEL_SWITCH_TIMER
203 #define DEFAULT_METADATA_READ_TIMER 0
204 #define DEFAULT_METADATA_OUTPUT _DEFAULT_CHANNEL_OUTPUT
205
206 /* Kernel has different defaults */
207
208 /* DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE must always be a power of 2 */
209 #define DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE 262144 /* bytes */
210 /*
211 * DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM must always be a power of 2.
212 * Update help manually if override.
213 */
214 #define DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM _DEFAULT_CHANNEL_SUBBUF_NUM
215 /* See lttng-kernel.h enum lttng_kernel_output for channel output */
216 #define DEFAULT_KERNEL_CHANNEL_OUTPUT LTTNG_EVENT_SPLICE
217 #define DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER _DEFAULT_CHANNEL_SWITCH_TIMER
218 #define DEFAULT_KERNEL_CHANNEL_READ_TIMER _DEFAULT_CHANNEL_READ_TIMER
219 #define DEFAULT_KERNEL_CHANNEL_LIVE_TIMER _DEFAULT_CHANNEL_LIVE_TIMER
220
221 /* User space defaults */
222
223 /* Must be a power of 2 */
224 #define DEFAULT_UST_PID_CHANNEL_SUBBUF_SIZE _DEFAULT_CHANNEL_SUBBUF_SIZE
225 #define DEFAULT_UST_UID_CHANNEL_SUBBUF_SIZE 131072 /* bytes */
226 /* Must be a power of 2. Update help manuall if override. */
227 #define DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM _DEFAULT_CHANNEL_SUBBUF_NUM
228 #define DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM _DEFAULT_CHANNEL_SUBBUF_NUM
229 /* See lttng-ust.h enum lttng_ust_output */
230 #define DEFAULT_UST_PID_CHANNEL_OUTPUT _DEFAULT_CHANNEL_OUTPUT
231 #define DEFAULT_UST_UID_CHANNEL_OUTPUT _DEFAULT_CHANNEL_OUTPUT
232 /* Timers in usec. */
233 #define DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER _DEFAULT_CHANNEL_SWITCH_TIMER
234 #define DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER _DEFAULT_CHANNEL_SWITCH_TIMER
235 #define DEFAULT_UST_PID_CHANNEL_LIVE_TIMER _DEFAULT_CHANNEL_LIVE_TIMER
236 #define DEFAULT_UST_UID_CHANNEL_LIVE_TIMER _DEFAULT_CHANNEL_LIVE_TIMER
237
238 #define DEFAULT_UST_PID_CHANNEL_READ_TIMER 0 /* usec */
239 #define DEFAULT_UST_UID_CHANNEL_READ_TIMER 0 /* usec */
240
241 /*
242 * Default timeout value for the sem_timedwait() call. Blocking forever is not
243 * wanted so a timeout is used to control the data flow and not freeze the
244 * session daemon.
245 */
246 #define DEFAULT_SEM_WAIT_TIMEOUT 30 /* in seconds */
247
248 /* Default bind addresses for network services. */
249 #define DEFAULT_NETWORK_CONTROL_BIND_ADDRESS "0.0.0.0"
250 #define DEFAULT_NETWORK_DATA_BIND_ADDRESS "0.0.0.0"
251 #define DEFAULT_NETWORK_VIEWER_BIND_ADDRESS "localhost"
252 #define DEFAULT_AGENT_BIND_ADDRESS "localhost"
253
254 /* Default network ports for trace streaming support. */
255 #define DEFAULT_NETWORK_CONTROL_PORT 5342
256 #define DEFAULT_NETWORK_DATA_PORT 5343
257 #define DEFAULT_NETWORK_VIEWER_PORT 5344
258
259 /* Agent registration TCP port. */
260 #define DEFAULT_AGENT_TCP_PORT 5345
261
262 /*
263 * If a thread stalls for this amount of time, it will be considered bogus (bad
264 * health).
265 */
266 #define DEFAULT_HEALTH_CHECK_DELTA_S 20
267 #define DEFAULT_HEALTH_CHECK_DELTA_NS 0
268
269 /*
270 * Wait period before retrying the lttng_data_pending command in the lttng
271 * stop command of liblttng-ctl.
272 */
273 #define DEFAULT_DATA_AVAILABILITY_WAIT_TIME 200000 /* usec */
274
275 /*
276 * Wait period before retrying the lttng_consumer_flushed_cache when
277 * the consumer receives metadata.
278 */
279 #define DEFAULT_METADATA_AVAILABILITY_WAIT_TIME 200000 /* usec */
280
281 /*
282 * The usual value for the maximum TCP SYN retries time and TCP FIN timeout is
283 * 180 and 60 seconds on most Linux system and the default value since kernel
284 * 2.2 thus using the highest value. See tcp(7) for more details.
285 */
286 #define DEFAULT_INET_TCP_TIMEOUT 180 /* sec */
287
288 /*
289 * Default receiving and sending timeout for an application socket.
290 */
291 #define DEFAULT_APP_SOCKET_RW_TIMEOUT 5 /* sec */
292 #define DEFAULT_APP_SOCKET_TIMEOUT_ENV "LTTNG_APP_SOCKET_TIMEOUT"
293
294 #define DEFAULT_UST_STREAM_FD_NUM 2 /* Number of fd per UST stream. */
295
296 #define DEFAULT_SNAPSHOT_NAME "snapshot"
297 #define DEFAULT_SNAPSHOT_MAX_SIZE 0 /* Unlimited. */
298
299 /* Suffix of an index file. */
300 #define DEFAULT_INDEX_FILE_SUFFIX ".idx"
301 #define DEFAULT_INDEX_DIR "index"
302
303 /* Default lttng command live timer value in usec. */
304 #define DEFAULT_LTTNG_LIVE_TIMER 1000000
305
306 /* Default runas worker name */
307 #define DEFAULT_RUN_AS_WORKER_NAME "lttng-runas"
308
309 /*
310 * Returns the default subbuf size.
311 *
312 * This function depends on a value that is set at constructor time, so it is
313 * unsafe to call it from another constructor.
314 */
315 LTTNG_HIDDEN
316 size_t default_get_channel_subbuf_size(void);
317
318 /*
319 * Returns the default metadata subbuf size.
320 *
321 * This function depends on a value that is set at constructor time, so it is
322 * unsafe to call it from another constructor.
323 */
324 LTTNG_HIDDEN
325 size_t default_get_metadata_subbuf_size(void);
326
327 /*
328 * Returns the default subbuf size for the kernel domain.
329 *
330 * This function depends on a value that is set at constructor time, so it is
331 * unsafe to call it from another constructor.
332 */
333 LTTNG_HIDDEN
334 size_t default_get_kernel_channel_subbuf_size(void);
335
336 /*
337 * Returns the default subbuf size for the UST domain per PID.
338 *
339 * This function depends on a value that is set at constructor time, so it is
340 * unsafe to call it from another constructor.
341 */
342 LTTNG_HIDDEN
343 size_t default_get_ust_pid_channel_subbuf_size(void);
344
345 /*
346 * Returns the default subbuf size for the UST domain per UID.
347 *
348 * This function depends on a value that is set at constructor time, so it is
349 * unsafe to call it from another constructor.
350 */
351 LTTNG_HIDDEN
352 size_t default_get_ust_uid_channel_subbuf_size(void);
353
354 #endif /* _DEFAULTS_H */
This page took 0.037399 seconds and 4 git commands to generate.