Fix: don't start the relayd with a wrong --output dir
[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
bbccc3d2
DG
22/* Default unix group name for tracing. */
23#define DEFAULT_TRACING_GROUP "tracing"
24
30079b6b
DG
25/*
26 * This value is defined in the CTF specification (see
27 * git://git.efficios.com/ctf.git in the file
28 * common-trace-format-specification.txt.
29 */
30#define DEFAULT_METADATA_NAME "metadata"
31
bbccc3d2
DG
32/* Environment variable to set session daemon binary path. */
33#define DEFAULT_SESSIOND_PATH_ENV "LTTNG_SESSIOND_PATH"
34
35/* Default trace output directory name */
36#define DEFAULT_TRACE_DIR_NAME "lttng-traces"
37
f6a9efaa 38/* Default size of a hash table */
60922cb0
DG
39#define DEFAULT_HT_SIZE 4
40
41/* Default session daemon paths */
42#define DEFAULT_HOME_DIR "/tmp"
43#define DEFAULT_UST_SOCK_DIR DEFAULT_HOME_DIR "/ust-app-socks"
44#define DEFAULT_GLOBAL_APPS_PIPE DEFAULT_UST_SOCK_DIR "/global"
45#define DEFAULT_TRACE_OUTPUT DEFAULT_HOME_DIR "/lttng"
46
00e2e675
DG
47/* Default directory where the trace are written in per domain */
48#define DEFAULT_KERNEL_TRACE_DIR "/kernel"
49#define DEFAULT_UST_TRACE_DIR "/ust"
50
7972aab2
DG
51/* Subpath for per PID or UID sessions. */
52#define DEFAULT_UST_TRACE_PID_PATH "/pid"
53#define DEFAULT_UST_TRACE_UID_PATH "/uid/%d/%u-bit"
54
a4b92340
DG
55/*
56 * Default session name for the lttng command line. This default value will
57 * get the date and time appended (%Y%m%d-%H%M%S) to it.
58 */
07424f16 59#define DEFAULT_SESSION_NAME "auto"
a4b92340 60
60922cb0
DG
61/* Default consumer paths */
62#define DEFAULT_CONSUMERD_RUNDIR "%s"
63
64/* Kernel consumer path */
65#define DEFAULT_KCONSUMERD_PATH DEFAULT_CONSUMERD_RUNDIR "/kconsumerd"
66#define DEFAULT_KCONSUMERD_CMD_SOCK_PATH DEFAULT_KCONSUMERD_PATH "/command"
67#define DEFAULT_KCONSUMERD_ERR_SOCK_PATH DEFAULT_KCONSUMERD_PATH "/error"
68
69/* UST 64-bit consumer path */
70#define DEFAULT_USTCONSUMERD64_PATH DEFAULT_CONSUMERD_RUNDIR "/ustconsumerd64"
71#define DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH DEFAULT_USTCONSUMERD64_PATH "/command"
72#define DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH DEFAULT_USTCONSUMERD64_PATH "/error"
73
74/* UST 32-bit consumer path */
75#define DEFAULT_USTCONSUMERD32_PATH DEFAULT_CONSUMERD_RUNDIR "/ustconsumerd32"
76#define DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH DEFAULT_USTCONSUMERD32_PATH "/command"
77#define DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH DEFAULT_USTCONSUMERD32_PATH "/error"
78
990570ed 79/* Default lttng run directory */
60922cb0
DG
80#define DEFAULT_LTTNG_RUNDIR "/var/run/lttng"
81#define DEFAULT_LTTNG_HOME_RUNDIR "%s/.lttng"
35f90c40 82#define DEFAULT_LTTNG_SESSIOND_PIDFILE "lttng-sessiond.pid"
990570ed
DG
83
84/* Default unix socket path */
60922cb0 85#define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/client-lttng-sessiond"
60922cb0 86#define DEFAULT_HOME_CLIENT_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/client-lttng-sessiond"
44a5e5eb
DG
87#define DEFAULT_GLOBAL_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/health.sock"
88#define DEFAULT_HOME_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/health.sock"
990570ed 89
d0b96690
DG
90#define DEFAULT_GLOBAL_APPS_UNIX_SOCK \
91 DEFAULT_LTTNG_RUNDIR "/" LTTNG_UST_SOCK_FILENAME
92#define DEFAULT_HOME_APPS_UNIX_SOCK \
93 DEFAULT_LTTNG_HOME_RUNDIR "/" LTTNG_UST_SOCK_FILENAME
94#define DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH \
95 "/" LTTNG_UST_WAIT_FILENAME
96#define DEFAULT_HOME_APPS_WAIT_SHM_PATH \
97 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH "-%d"
98
990570ed
DG
99/*
100 * Value taken from the hard limit allowed by the kernel when using setrlimit
101 * with RLIMIT_NOFILE on an Intel i7 CPU and Linux 3.0.3.
102 */
103#define DEFAULT_POLL_SIZE 65535
104
ce2a9e76
DG
105/*
106 * Format is %s_%d respectively channel name and CPU number. Eigth bytes
107 * are added here to add space for the CPU number. I guess 2^8 CPUs is more
108 * than enough. We might end up with quantum computing in a cell phone when
109 * reaching this limit.
110 */
111#define DEFAULT_STREAM_NAME_LEN LTTNG_SYMBOL_NAME_LEN + 8
112
f3ed775e 113/* Default channel attributes */
3817e7df
DG
114#define DEFAULT_CHANNEL_NAME "channel0"
115#define DEFAULT_CHANNEL_OVERWRITE 0 /* usec */
7d452e12 116/* DEFAULT_CHANNEL_SUBBUF_SIZE must always be a power of 2 */
3817e7df 117#define DEFAULT_CHANNEL_SUBBUF_SIZE 4096 /* bytes */
7d452e12 118/* DEFAULT_CHANNEL_SUBBUF_NUM must always be a power of 2 */
9f778c9a 119#define DEFAULT_CHANNEL_SUBBUF_NUM 4
3817e7df 120#define DEFAULT_CHANNEL_SWITCH_TIMER 0 /* usec */
6bb9e85f 121#define DEFAULT_CHANNEL_READ_TIMER 200000 /* usec */
3817e7df 122#define DEFAULT_CHANNEL_OUTPUT LTTNG_EVENT_MMAP
b389abbe 123
3817e7df
DG
124#define DEFAULT_METADATA_SUBBUF_SIZE 4096
125#define DEFAULT_METADATA_SUBBUF_NUM 2
331744e3 126#define DEFAULT_METADATA_CACHE_SIZE 4096
e6ddca71 127
b389abbe
MD
128/* Kernel has different defaults */
129
130/* DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE must always be a power of 2 */
3817e7df 131#define DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE 262144 /* bytes */
9f778c9a
MD
132/*
133 * DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM must always be a power of 2.
134 * Update help manually if override.
135 */
136#define DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM DEFAULT_CHANNEL_SUBBUF_NUM
b389abbe 137/* See lttng-kernel.h enum lttng_kernel_output for channel output */
3817e7df 138#define DEFAULT_KERNEL_CHANNEL_OUTPUT LTTNG_EVENT_SPLICE
1624d5b7
JD
139/* By default, unlimited tracefile size */
140#define DEFAULT_KERNEL_CHANNEL_TRACEFILE_SIZE 0
141/* By default, unlimited tracefile count */
142#define DEFAULT_KERNEL_CHANNEL_TRACEFILE_COUNT 0
f3ed775e 143
6bb9e85f
MD
144#define DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER \
145 DEFAULT_CHANNEL_SWITCH_TIMER
146#define DEFAULT_KERNEL_CHANNEL_READ_TIMER 200000 /* usec */
147
0b0dd29a
DG
148/* User space defaults */
149
150/* Must be a power of 2 */
151#define DEFAULT_UST_CHANNEL_SUBBUF_SIZE 4096 /* bytes */
9f778c9a
MD
152/* Must be a power of 2. Update help manuall if override. */
153#define DEFAULT_UST_CHANNEL_SUBBUF_NUM DEFAULT_CHANNEL_SUBBUF_NUM
28ca4a8b 154/* See lttng-ust.h enum lttng_ust_output */
d41f73b7 155#define DEFAULT_UST_CHANNEL_OUTPUT LTTNG_EVENT_MMAP
1624d5b7
JD
156/* By default, unlimited tracefile size */
157#define DEFAULT_UST_CHANNEL_TRACEFILE_SIZE 0
158/* By default, unlimited tracefile count */
159#define DEFAULT_UST_CHANNEL_TRACEFILE_COUNT 0
0b0dd29a 160
6bb9e85f
MD
161#define DEFAULT_UST_CHANNEL_SWITCH_TIMER \
162 DEFAULT_CHANNEL_SWITCH_TIMER
163#define DEFAULT_UST_CHANNEL_READ_TIMER 0 /* usec */
164
ee0b0061
DG
165/*
166 * Default timeout value for the sem_timedwait() call. Blocking forever is not
167 * wanted so a timeout is used to control the data flow and not freeze the
168 * session daemon.
169 */
170#define DEFAULT_SEM_WAIT_TIMEOUT 30 /* in seconds */
171
3a5713da
DG
172/* Default network ports for trace streaming support */
173#define DEFAULT_NETWORK_CONTROL_PORT 5342
174#define DEFAULT_NETWORK_DATA_PORT 5343
175
8809eec0
MD
176/*
177 * If a thread stalls for this amount of time, it will be considered bogus (bad
178 * health).
179 */
180#define DEFAULT_HEALTH_CHECK_DELTA_S 20
181#define DEFAULT_HEALTH_CHECK_DELTA_NS 0
182
38ee087f 183/*
6d805429 184 * Wait period before retrying the lttng_data_pending command in the lttng
38ee087f
DG
185 * stop command of liblttng-ctl.
186 */
187#define DEFAULT_DATA_AVAILABILITY_WAIT_TIME 200000 /* usec */
188
331744e3
JD
189/*
190 * Wait period before retrying the lttng_consumer_flushed_cache when
191 * the consumer receives metadata.
192 */
193#define DEFAULT_METADATA_AVAILABILITY_WAIT_TIME 200000 /* usec */
194
ae9e45b3
DG
195/*
196 * Default receiving and sending timeout for an application socket.
197 */
198#define DEFAULT_APP_SOCKET_RW_TIMEOUT 5 /* sec */
199#define DEFAULT_APP_SOCKET_TIMEOUT_ENV "LTTNG_APP_SOCKET_TIMEOUT"
200
ffe60014 201#define DEFAULT_UST_STREAM_FD_NUM 2 /* Number of fd per UST stream. */
8b3bd7a3
SM
202
203extern size_t default_channel_subbuf_size;
204extern size_t default_metadata_subbuf_size;
205extern size_t default_ust_channel_subbuf_size;
206extern size_t default_kernel_channel_subbuf_size;
207
208
209/*
210 * Returns the default subbuf size.
211 *
212 * This function depends on a value that is set at constructor time, so it is
213 * unsafe to call it from another constructor.
214 */
215static inline
216size_t default_get_channel_subbuf_size(void)
217{
218 return default_channel_subbuf_size;
219}
220
221/*
222 * Returns the default metadata subbuf size.
223 *
224 * This function depends on a value that is set at constructor time, so it is
225 * unsafe to call it from another constructor.
226 */
227static inline
228size_t default_get_metadata_subbuf_size(void)
229{
230 return default_metadata_subbuf_size;
231}
232
233/*
234 * Returns the default subbuf size for the kernel domain.
235 *
236 * This function depends on a value that is set at constructor time, so it is
237 * unsafe to call it from another constructor.
238 */
239static inline
240size_t default_get_kernel_channel_subbuf_size(void)
241{
242 return default_kernel_channel_subbuf_size;
243}
244
245/*
246 * Returns the default subbuf size for the UST domain.
247 *
248 * This function depends on a value that is set at constructor time, so it is
249 * unsafe to call it from another constructor.
250 */
251static inline
252size_t default_get_ust_channel_subbuf_size(void)
253{
254 return default_ust_channel_subbuf_size;
255}
256
990570ed 257#endif /* _DEFAULTS_H */
This page took 0.062879 seconds and 4 git commands to generate.