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