lttng-load(1): use lists to explain the input path behaviour
[lttng-tools.git] / src / common / defaults.h
CommitLineData
9bda164d 1/*
e848fc76
DG
2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
78d8fb4f 4 * 2015 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
9bda164d 5 *
d14d33bf
AM
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.
9bda164d 9 *
e848fc76
DG
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
d14d33bf 12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
e848fc76 13 * more details.
9bda164d 14 *
d14d33bf
AM
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.
9bda164d
DG
18 */
19
990570ed
DG
20#ifndef _DEFAULTS_H
21#define _DEFAULTS_H
e848fc76 22
78d8fb4f
JG
23#include <src/common/macros.h>
24
bbccc3d2
DG
25/* Default unix group name for tracing. */
26#define DEFAULT_TRACING_GROUP "tracing"
27
30079b6b
DG
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
bbccc3d2
DG
35/* Environment variable to set session daemon binary path. */
36#define DEFAULT_SESSIOND_PATH_ENV "LTTNG_SESSIOND_PATH"
37
4ba92f18
PP
38/* Environment variable to set man pager binary path. */
39#define DEFAULT_MAN_BIN_PATH_ENV "LTTNG_MAN_BIN_PATH"
40
41/* Default man pager binary path. */
42#define DEFAULT_MAN_BIN_PATH "/usr/bin/man"
43
bbccc3d2
DG
44/* Default trace output directory name */
45#define DEFAULT_TRACE_DIR_NAME "lttng-traces"
46
f6a9efaa 47/* Default size of a hash table */
60922cb0
DG
48#define DEFAULT_HT_SIZE 4
49
50/* Default session daemon paths */
51#define DEFAULT_HOME_DIR "/tmp"
52#define DEFAULT_UST_SOCK_DIR DEFAULT_HOME_DIR "/ust-app-socks"
53#define DEFAULT_GLOBAL_APPS_PIPE DEFAULT_UST_SOCK_DIR "/global"
54#define DEFAULT_TRACE_OUTPUT DEFAULT_HOME_DIR "/lttng"
55
00e2e675
DG
56/* Default directory where the trace are written in per domain */
57#define DEFAULT_KERNEL_TRACE_DIR "/kernel"
58#define DEFAULT_UST_TRACE_DIR "/ust"
59
7972aab2
DG
60/* Subpath for per PID or UID sessions. */
61#define DEFAULT_UST_TRACE_PID_PATH "/pid"
62#define DEFAULT_UST_TRACE_UID_PATH "/uid/%d/%u-bit"
63
a4b92340
DG
64/*
65 * Default session name for the lttng command line. This default value will
66 * get the date and time appended (%Y%m%d-%H%M%S) to it.
67 */
07424f16 68#define DEFAULT_SESSION_NAME "auto"
a4b92340 69
60922cb0
DG
70/* Default consumer paths */
71#define DEFAULT_CONSUMERD_RUNDIR "%s"
72
73/* Kernel consumer path */
74#define DEFAULT_KCONSUMERD_PATH DEFAULT_CONSUMERD_RUNDIR "/kconsumerd"
75#define DEFAULT_KCONSUMERD_CMD_SOCK_PATH DEFAULT_KCONSUMERD_PATH "/command"
76#define DEFAULT_KCONSUMERD_ERR_SOCK_PATH DEFAULT_KCONSUMERD_PATH "/error"
77
78/* UST 64-bit consumer path */
79#define DEFAULT_USTCONSUMERD64_PATH DEFAULT_CONSUMERD_RUNDIR "/ustconsumerd64"
80#define DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH DEFAULT_USTCONSUMERD64_PATH "/command"
81#define DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH DEFAULT_USTCONSUMERD64_PATH "/error"
82
83/* UST 32-bit consumer path */
84#define DEFAULT_USTCONSUMERD32_PATH DEFAULT_CONSUMERD_RUNDIR "/ustconsumerd32"
85#define DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH DEFAULT_USTCONSUMERD32_PATH "/command"
86#define DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH DEFAULT_USTCONSUMERD32_PATH "/error"
87
65931c8b
MD
88/* Relayd path */
89#define DEFAULT_RELAYD_RUNDIR "%s"
90#define DEFAULT_RELAYD_PATH DEFAULT_RELAYD_RUNDIR "/relayd"
91
990570ed 92/* Default lttng run directory */
feb0f3e5
AM
93#define DEFAULT_LTTNG_HOME_ENV_VAR "LTTNG_HOME"
94#define DEFAULT_LTTNG_FALLBACK_HOME_ENV_VAR "HOME"
d386c872 95#define DEFAULT_LTTNG_RUNDIR CONFIG_LTTNG_SYSTEM_RUNDIR
60922cb0 96#define DEFAULT_LTTNG_HOME_RUNDIR "%s/.lttng"
35f90c40 97#define DEFAULT_LTTNG_SESSIOND_PIDFILE "lttng-sessiond.pid"
1b2ef7fe 98#define DEFAULT_LTTNG_SESSIOND_AGENTPORT_FILE "agent.port"
c9cb3e7d 99#define DEFAULT_LTTNG_SESSIOND_LOCKFILE "lttng-sessiond.lck"
990570ed 100
fbb9748b
JG
101/* Default probes list */
102#define DEFAULT_LTTNG_KMOD_PROBES "LTTNG_KMOD_PROBES"
103
c9d42407
PP
104/* Default extra probes list */
105#define DEFAULT_LTTNG_EXTRA_KMOD_PROBES "LTTNG_EXTRA_KMOD_PROBES"
106
990570ed 107/* Default unix socket path */
60922cb0 108#define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/client-lttng-sessiond"
60922cb0 109#define DEFAULT_HOME_CLIENT_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/client-lttng-sessiond"
6c71277b
MD
110#define DEFAULT_GLOBAL_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/sessiond-health"
111#define DEFAULT_HOME_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/sessiond-health"
990570ed 112
5c635c72 113/* Default consumer health unix socket path */
6c71277b
MD
114#define DEFAULT_GLOBAL_USTCONSUMER32_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/ustconsumerd32/health"
115#define DEFAULT_HOME_USTCONSUMER32_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/ustconsumerd32/health"
116#define DEFAULT_GLOBAL_USTCONSUMER64_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/ustconsumerd64/health"
117#define DEFAULT_HOME_USTCONSUMER64_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/ustconsumerd64/health"
118#define DEFAULT_GLOBAL_KCONSUMER_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/kconsumerd/health"
119#define DEFAULT_HOME_KCONSUMER_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/kconsumerd/health"
5c635c72 120
65931c8b
MD
121/* Default relay health unix socket path */
122#define DEFAULT_GLOBAL_RELAY_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/relayd/health-%d"
123#define DEFAULT_HOME_RELAY_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/relayd/health-%d"
124
1501a7f3 125/* Default daemon configuration file path */
fb198a11
JG
126#define DEFAULT_SYSTEM_CONFIGPATH CONFIG_LTTNG_SYSTEM_CONFIGDIR \
127 "/lttng"
128
1501a7f3
JG
129#define DEFAULT_DAEMON_CONFIG_FILE "lttng.conf"
130#define DEFAULT_DAEMON_HOME_CONFIGPATH DEFAULT_LTTNG_HOME_RUNDIR "/" \
131 DEFAULT_DAEMON_CONFIG_FILE
fb198a11
JG
132#define DEFAULT_DAEMON_SYSTEM_CONFIGPATH DEFAULT_SYSTEM_CONFIGPATH "/" \
133 DEFAULT_DAEMON_CONFIG_FILE
134
135/* Default session configuration file path */
136#define DEFAULT_SESSION_PATH "sessions"
ab38c13f
DG
137/* Auto load session in that directory. */
138#define DEFAULT_SESSION_CONFIG_AUTOLOAD "auto"
fb198a11
JG
139#define DEFAULT_SESSION_HOME_CONFIGPATH DEFAULT_LTTNG_HOME_RUNDIR "/" \
140 DEFAULT_SESSION_PATH
141#define DEFAULT_SESSION_SYSTEM_CONFIGPATH DEFAULT_SYSTEM_CONFIGPATH "/" \
142 DEFAULT_SESSION_PATH
143#define DEFAULT_SESSION_CONFIG_FILE_EXTENSION ".lttng"
54e399cb
JG
144#define DEFAULT_SESSION_CONFIG_XSD_FILENAME "session.xsd"
145#define DEFAULT_SESSION_CONFIG_XSD_PATH CONFIG_LTTNG_SYSTEM_DATADIR "/xml/lttng/"
146#define DEFAULT_SESSION_CONFIG_XSD_PATH_ENV "LTTNG_SESSION_CONFIG_XSD_PATH"
1501a7f3 147
d0b96690
DG
148#define DEFAULT_GLOBAL_APPS_UNIX_SOCK \
149 DEFAULT_LTTNG_RUNDIR "/" LTTNG_UST_SOCK_FILENAME
150#define DEFAULT_HOME_APPS_UNIX_SOCK \
151 DEFAULT_LTTNG_HOME_RUNDIR "/" LTTNG_UST_SOCK_FILENAME
152#define DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH \
153 "/" LTTNG_UST_WAIT_FILENAME
154#define DEFAULT_HOME_APPS_WAIT_SHM_PATH \
155 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH "-%d"
156
990570ed
DG
157/*
158 * Value taken from the hard limit allowed by the kernel when using setrlimit
159 * with RLIMIT_NOFILE on an Intel i7 CPU and Linux 3.0.3.
160 */
161#define DEFAULT_POLL_SIZE 65535
162
ce2a9e76
DG
163/*
164 * Format is %s_%d respectively channel name and CPU number. Eigth bytes
165 * are added here to add space for the CPU number. I guess 2^8 CPUs is more
166 * than enough. We might end up with quantum computing in a cell phone when
167 * reaching this limit.
168 */
169#define DEFAULT_STREAM_NAME_LEN LTTNG_SYMBOL_NAME_LEN + 8
170
f3ed775e 171/* Default channel attributes */
3817e7df 172#define DEFAULT_CHANNEL_NAME "channel0"
0475c50c 173/* Default JUL domain channel name. */
f20baf8e
DG
174#define DEFAULT_JUL_CHANNEL_NAME "lttng_jul_channel"
175/* Default JUL tracepoint name. This is a wildcard for the JUL domain. */
dac8e046
JG
176#define DEFAULT_JUL_EVENT_COMPONENT "lttng_jul"
177#define DEFAULT_JUL_EVENT_NAME DEFAULT_JUL_EVENT_COMPONENT ":*"
da6c3a50
DG
178
179/* Default log4j domain channel name. */
180#define DEFAULT_LOG4J_CHANNEL_NAME "lttng_log4j_channel"
181/* Default log4j tracepoint name. This is a wildcard for the log4j domain. */
dac8e046
JG
182#define DEFAULT_LOG4J_EVENT_COMPONENT "lttng_log4j"
183#define DEFAULT_LOG4J_EVENT_NAME DEFAULT_LOG4J_EVENT_COMPONENT ":*"
da6c3a50 184
0e115563
DG
185/* Default Python domain channel name. */
186#define DEFAULT_PYTHON_CHANNEL_NAME "lttng_python_channel"
187/* Default Python tracepoint name. This is a wildcard for the python domain. */
dac8e046
JG
188#define DEFAULT_PYTHON_EVENT_COMPONENT "lttng_python"
189#define DEFAULT_PYTHON_EVENT_NAME DEFAULT_PYTHON_EVENT_COMPONENT ":*"
0e115563 190
0a9c6494
DG
191#define DEFAULT_CHANNEL_OVERWRITE 0
192#define DEFAULT_CHANNEL_TRACEFILE_SIZE 0
193#define DEFAULT_CHANNEL_TRACEFILE_COUNT 0
194
195/* Must always be a power of 2 */
196#define _DEFAULT_CHANNEL_SUBBUF_SIZE 4096 /* bytes */
197/* Must always be a power of 2 */
198#define _DEFAULT_CHANNEL_SUBBUF_NUM 4
199#define _DEFAULT_CHANNEL_SWITCH_TIMER 0 /* usec */
ecc48a90 200#define _DEFAULT_CHANNEL_LIVE_TIMER 0 /* usec */
0a9c6494
DG
201#define _DEFAULT_CHANNEL_READ_TIMER 200000 /* usec */
202#define _DEFAULT_CHANNEL_OUTPUT LTTNG_EVENT_MMAP
203
204/* Metadata channel defaults. */
3817e7df
DG
205#define DEFAULT_METADATA_SUBBUF_SIZE 4096
206#define DEFAULT_METADATA_SUBBUF_NUM 2
331744e3 207#define DEFAULT_METADATA_CACHE_SIZE 4096
0a9c6494
DG
208#define DEFAULT_METADATA_SWITCH_TIMER _DEFAULT_CHANNEL_SWITCH_TIMER
209#define DEFAULT_METADATA_READ_TIMER 0
210#define DEFAULT_METADATA_OUTPUT _DEFAULT_CHANNEL_OUTPUT
e6ddca71 211
b389abbe
MD
212/* Kernel has different defaults */
213
214/* DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE must always be a power of 2 */
0a9c6494 215#define DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE 262144 /* bytes */
9f778c9a
MD
216/*
217 * DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM must always be a power of 2.
218 * Update help manually if override.
219 */
0a9c6494 220#define DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM _DEFAULT_CHANNEL_SUBBUF_NUM
b389abbe 221/* See lttng-kernel.h enum lttng_kernel_output for channel output */
0a9c6494
DG
222#define DEFAULT_KERNEL_CHANNEL_OUTPUT LTTNG_EVENT_SPLICE
223#define DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER _DEFAULT_CHANNEL_SWITCH_TIMER
224#define DEFAULT_KERNEL_CHANNEL_READ_TIMER _DEFAULT_CHANNEL_READ_TIMER
ecc48a90 225#define DEFAULT_KERNEL_CHANNEL_LIVE_TIMER _DEFAULT_CHANNEL_LIVE_TIMER
6bb9e85f 226
0b0dd29a
DG
227/* User space defaults */
228
229/* Must be a power of 2 */
0a9c6494
DG
230#define DEFAULT_UST_PID_CHANNEL_SUBBUF_SIZE _DEFAULT_CHANNEL_SUBBUF_SIZE
231#define DEFAULT_UST_UID_CHANNEL_SUBBUF_SIZE 131072 /* bytes */
9f778c9a 232/* Must be a power of 2. Update help manuall if override. */
0a9c6494
DG
233#define DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM _DEFAULT_CHANNEL_SUBBUF_NUM
234#define DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM _DEFAULT_CHANNEL_SUBBUF_NUM
28ca4a8b 235/* See lttng-ust.h enum lttng_ust_output */
0a9c6494
DG
236#define DEFAULT_UST_PID_CHANNEL_OUTPUT _DEFAULT_CHANNEL_OUTPUT
237#define DEFAULT_UST_UID_CHANNEL_OUTPUT _DEFAULT_CHANNEL_OUTPUT
238/* Timers in usec. */
239#define DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER _DEFAULT_CHANNEL_SWITCH_TIMER
240#define DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER _DEFAULT_CHANNEL_SWITCH_TIMER
ecc48a90
JD
241#define DEFAULT_UST_PID_CHANNEL_LIVE_TIMER _DEFAULT_CHANNEL_LIVE_TIMER
242#define DEFAULT_UST_UID_CHANNEL_LIVE_TIMER _DEFAULT_CHANNEL_LIVE_TIMER
0b0dd29a 243
0a9c6494
DG
244#define DEFAULT_UST_PID_CHANNEL_READ_TIMER 0 /* usec */
245#define DEFAULT_UST_UID_CHANNEL_READ_TIMER 0 /* usec */
6bb9e85f 246
ee0b0061
DG
247/*
248 * Default timeout value for the sem_timedwait() call. Blocking forever is not
249 * wanted so a timeout is used to control the data flow and not freeze the
250 * session daemon.
251 */
252#define DEFAULT_SEM_WAIT_TIMEOUT 30 /* in seconds */
253
fa91dc52
MD
254/* Default bind addresses for network services. */
255#define DEFAULT_NETWORK_CONTROL_BIND_ADDRESS "0.0.0.0"
256#define DEFAULT_NETWORK_DATA_BIND_ADDRESS "0.0.0.0"
257#define DEFAULT_NETWORK_VIEWER_BIND_ADDRESS "localhost"
022d91ba 258#define DEFAULT_AGENT_BIND_ADDRESS "localhost"
fa91dc52
MD
259
260/* Default network ports for trace streaming support. */
3a5713da
DG
261#define DEFAULT_NETWORK_CONTROL_PORT 5342
262#define DEFAULT_NETWORK_DATA_PORT 5343
d3e2ba59 263#define DEFAULT_NETWORK_VIEWER_PORT 5344
3a5713da 264
022d91ba
DG
265/* Agent registration TCP port. */
266#define DEFAULT_AGENT_TCP_PORT 5345
4d076222 267
8809eec0
MD
268/*
269 * If a thread stalls for this amount of time, it will be considered bogus (bad
270 * health).
271 */
272#define DEFAULT_HEALTH_CHECK_DELTA_S 20
273#define DEFAULT_HEALTH_CHECK_DELTA_NS 0
274
38ee087f 275/*
6d805429 276 * Wait period before retrying the lttng_data_pending command in the lttng
38ee087f
DG
277 * stop command of liblttng-ctl.
278 */
279#define DEFAULT_DATA_AVAILABILITY_WAIT_TIME 200000 /* usec */
280
331744e3
JD
281/*
282 * Wait period before retrying the lttng_consumer_flushed_cache when
283 * the consumer receives metadata.
284 */
285#define DEFAULT_METADATA_AVAILABILITY_WAIT_TIME 200000 /* usec */
286
d831c249
DG
287/*
288 * The usual value for the maximum TCP SYN retries time and TCP FIN timeout is
289 * 180 and 60 seconds on most Linux system and the default value since kernel
290 * 2.2 thus using the highest value. See tcp(7) for more details.
291 */
292#define DEFAULT_INET_TCP_TIMEOUT 180 /* sec */
293
ae9e45b3
DG
294/*
295 * Default receiving and sending timeout for an application socket.
296 */
297#define DEFAULT_APP_SOCKET_RW_TIMEOUT 5 /* sec */
298#define DEFAULT_APP_SOCKET_TIMEOUT_ENV "LTTNG_APP_SOCKET_TIMEOUT"
299
ffe60014 300#define DEFAULT_UST_STREAM_FD_NUM 2 /* Number of fd per UST stream. */
8b3bd7a3 301
da3c9ec1 302#define DEFAULT_SNAPSHOT_NAME "snapshot"
27babd3a 303#define DEFAULT_SNAPSHOT_MAX_SIZE 0 /* Unlimited. */
da3c9ec1 304
309167d2
JD
305/* Suffix of an index file. */
306#define DEFAULT_INDEX_FILE_SUFFIX ".idx"
1c20f0e2 307#define DEFAULT_INDEX_DIR "index"
309167d2 308
d73c5802
DG
309/* Default lttng command live timer value in usec. */
310#define DEFAULT_LTTNG_LIVE_TIMER 1000000
311
7567352f
MD
312/* Default runas worker name */
313#define DEFAULT_RUN_AS_WORKER_NAME "lttng-runas"
314
41af1adf
JG
315/* Default LTTng MI XML namespace. */
316#define DEFAULT_LTTNG_MI_NAMESPACE "http://lttng.org/xml/ns/lttng-mi"
317
8b3bd7a3
SM
318/*
319 * Returns the default 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 */
78d8fb4f
JG
324LTTNG_HIDDEN
325size_t default_get_channel_subbuf_size(void);
8b3bd7a3
SM
326
327/*
328 * Returns the default metadata subbuf size.
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 */
78d8fb4f
JG
333LTTNG_HIDDEN
334size_t default_get_metadata_subbuf_size(void);
8b3bd7a3
SM
335
336/*
337 * Returns the default subbuf size for the kernel domain.
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 */
78d8fb4f
JG
342LTTNG_HIDDEN
343size_t default_get_kernel_channel_subbuf_size(void);
8b3bd7a3
SM
344
345/*
0a9c6494
DG
346 * Returns the default subbuf size for the UST domain per PID.
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 */
78d8fb4f
JG
351LTTNG_HIDDEN
352size_t default_get_ust_pid_channel_subbuf_size(void);
0a9c6494
DG
353
354/*
355 * Returns the default subbuf size for the UST domain per UID.
8b3bd7a3
SM
356 *
357 * This function depends on a value that is set at constructor time, so it is
358 * unsafe to call it from another constructor.
359 */
78d8fb4f
JG
360LTTNG_HIDDEN
361size_t default_get_ust_uid_channel_subbuf_size(void);
8b3bd7a3 362
990570ed 363#endif /* _DEFAULTS_H */
This page took 0.092274 seconds and 4 git commands to generate.