Fix: application SIGBUS when starting in parallel with sessiond
[lttng-tools.git] / src / common / defaults.h
... / ...
CommitLineData
1/*
2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 *
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.
8 *
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
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
12 * more details.
13 *
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.
17 */
18
19#ifndef _DEFAULTS_H
20#define _DEFAULTS_H
21
22#include <config.h>
23
24/* Default unix group name for tracing. */
25#define DEFAULT_TRACING_GROUP "tracing"
26
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
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
40/* Default size of a hash table */
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
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
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
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 */
61#define DEFAULT_SESSION_NAME "auto"
62
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
81/* Relayd path */
82#define DEFAULT_RELAYD_RUNDIR "%s"
83#define DEFAULT_RELAYD_PATH DEFAULT_RELAYD_RUNDIR "/relayd"
84
85/* Default lttng run directory */
86#define DEFAULT_LTTNG_HOME_ENV_VAR "LTTNG_HOME"
87#define DEFAULT_LTTNG_FALLBACK_HOME_ENV_VAR "HOME"
88#define DEFAULT_LTTNG_RUNDIR CONFIG_LTTNG_SYSTEM_RUNDIR
89#define DEFAULT_LTTNG_HOME_RUNDIR "%s/.lttng"
90#define DEFAULT_LTTNG_SESSIOND_PIDFILE "lttng-sessiond.pid"
91
92/* Default unix socket path */
93#define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/client-lttng-sessiond"
94#define DEFAULT_HOME_CLIENT_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/client-lttng-sessiond"
95#define DEFAULT_GLOBAL_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/sessiond-health"
96#define DEFAULT_HOME_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/sessiond-health"
97
98/* Default consumer health unix socket path */
99#define DEFAULT_GLOBAL_USTCONSUMER32_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/ustconsumerd32/health"
100#define DEFAULT_HOME_USTCONSUMER32_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/ustconsumerd32/health"
101#define DEFAULT_GLOBAL_USTCONSUMER64_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/ustconsumerd64/health"
102#define DEFAULT_HOME_USTCONSUMER64_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/ustconsumerd64/health"
103#define DEFAULT_GLOBAL_KCONSUMER_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/kconsumerd/health"
104#define DEFAULT_HOME_KCONSUMER_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/kconsumerd/health"
105
106/* Default relay health unix socket path */
107#define DEFAULT_GLOBAL_RELAY_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/relayd/health-%d"
108#define DEFAULT_HOME_RELAY_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/relayd/health-%d"
109
110#define DEFAULT_GLOBAL_APPS_UNIX_SOCK \
111 DEFAULT_LTTNG_RUNDIR "/" LTTNG_UST_SOCK_FILENAME
112#define DEFAULT_HOME_APPS_UNIX_SOCK \
113 DEFAULT_LTTNG_HOME_RUNDIR "/" LTTNG_UST_SOCK_FILENAME
114#define DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH \
115 "/" LTTNG_UST_WAIT_FILENAME
116#define DEFAULT_HOME_APPS_WAIT_SHM_PATH \
117 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH "-%d"
118
119/*
120 * Value taken from the hard limit allowed by the kernel when using setrlimit
121 * with RLIMIT_NOFILE on an Intel i7 CPU and Linux 3.0.3.
122 */
123#define DEFAULT_POLL_SIZE 65535
124
125/*
126 * Format is %s_%d respectively channel name and CPU number. Eigth bytes
127 * are added here to add space for the CPU number. I guess 2^8 CPUs is more
128 * than enough. We might end up with quantum computing in a cell phone when
129 * reaching this limit.
130 */
131#define DEFAULT_STREAM_NAME_LEN LTTNG_SYMBOL_NAME_LEN + 8
132
133/* Default channel attributes */
134#define DEFAULT_CHANNEL_NAME "channel0"
135/* Default JUL domain channel name. */
136#define DEFAULT_JUL_CHANNEL_NAME "lttng_jul_channel"
137/* Default JUL tracepoint name. This is a wildcard for the JUL domain. */
138#define DEFAULT_JUL_EVENT_NAME "lttng_jul*"
139/* JUL default channel name. */
140#define DEFAULT_CHANNEL_OVERWRITE 0
141#define DEFAULT_CHANNEL_TRACEFILE_SIZE 0
142#define DEFAULT_CHANNEL_TRACEFILE_COUNT 0
143
144/* Must always be a power of 2 */
145#define _DEFAULT_CHANNEL_SUBBUF_SIZE 4096 /* bytes */
146/* Must always be a power of 2 */
147#define _DEFAULT_CHANNEL_SUBBUF_NUM 4
148#define _DEFAULT_CHANNEL_SWITCH_TIMER 0 /* usec */
149#define _DEFAULT_CHANNEL_LIVE_TIMER 0 /* usec */
150#define _DEFAULT_CHANNEL_READ_TIMER 200000 /* usec */
151#define _DEFAULT_CHANNEL_OUTPUT LTTNG_EVENT_MMAP
152
153/* Metadata channel defaults. */
154#define DEFAULT_METADATA_SUBBUF_SIZE 4096
155#define DEFAULT_METADATA_SUBBUF_NUM 2
156#define DEFAULT_METADATA_CACHE_SIZE 4096
157#define DEFAULT_METADATA_SWITCH_TIMER _DEFAULT_CHANNEL_SWITCH_TIMER
158#define DEFAULT_METADATA_READ_TIMER 0
159#define DEFAULT_METADATA_OUTPUT _DEFAULT_CHANNEL_OUTPUT
160
161/* Kernel has different defaults */
162
163/* DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE must always be a power of 2 */
164#define DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE 262144 /* bytes */
165/*
166 * DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM must always be a power of 2.
167 * Update help manually if override.
168 */
169#define DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM _DEFAULT_CHANNEL_SUBBUF_NUM
170/* See lttng-kernel.h enum lttng_kernel_output for channel output */
171#define DEFAULT_KERNEL_CHANNEL_OUTPUT LTTNG_EVENT_SPLICE
172#define DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER _DEFAULT_CHANNEL_SWITCH_TIMER
173#define DEFAULT_KERNEL_CHANNEL_READ_TIMER _DEFAULT_CHANNEL_READ_TIMER
174#define DEFAULT_KERNEL_CHANNEL_LIVE_TIMER _DEFAULT_CHANNEL_LIVE_TIMER
175
176/* User space defaults */
177
178/* Must be a power of 2 */
179#define DEFAULT_UST_PID_CHANNEL_SUBBUF_SIZE _DEFAULT_CHANNEL_SUBBUF_SIZE
180#define DEFAULT_UST_UID_CHANNEL_SUBBUF_SIZE 131072 /* bytes */
181/* Must be a power of 2. Update help manuall if override. */
182#define DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM _DEFAULT_CHANNEL_SUBBUF_NUM
183#define DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM _DEFAULT_CHANNEL_SUBBUF_NUM
184/* See lttng-ust.h enum lttng_ust_output */
185#define DEFAULT_UST_PID_CHANNEL_OUTPUT _DEFAULT_CHANNEL_OUTPUT
186#define DEFAULT_UST_UID_CHANNEL_OUTPUT _DEFAULT_CHANNEL_OUTPUT
187/* Timers in usec. */
188#define DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER _DEFAULT_CHANNEL_SWITCH_TIMER
189#define DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER _DEFAULT_CHANNEL_SWITCH_TIMER
190#define DEFAULT_UST_PID_CHANNEL_LIVE_TIMER _DEFAULT_CHANNEL_LIVE_TIMER
191#define DEFAULT_UST_UID_CHANNEL_LIVE_TIMER _DEFAULT_CHANNEL_LIVE_TIMER
192
193#define DEFAULT_UST_PID_CHANNEL_READ_TIMER 0 /* usec */
194#define DEFAULT_UST_UID_CHANNEL_READ_TIMER 0 /* usec */
195
196/*
197 * Default timeout value for the sem_timedwait() call. Blocking forever is not
198 * wanted so a timeout is used to control the data flow and not freeze the
199 * session daemon.
200 */
201#define DEFAULT_SEM_WAIT_TIMEOUT 30 /* in seconds */
202
203/* Default network ports for trace streaming support */
204#define DEFAULT_NETWORK_CONTROL_PORT 5342
205#define DEFAULT_NETWORK_DATA_PORT 5343
206#define DEFAULT_NETWORK_VIEWER_PORT 5344
207
208/* JUL registration TCP port. */
209#define DEFAULT_JUL_TCP_PORT 5345
210
211/*
212 * If a thread stalls for this amount of time, it will be considered bogus (bad
213 * health).
214 */
215#define DEFAULT_HEALTH_CHECK_DELTA_S 20
216#define DEFAULT_HEALTH_CHECK_DELTA_NS 0
217
218/*
219 * Wait period before retrying the lttng_data_pending command in the lttng
220 * stop command of liblttng-ctl.
221 */
222#define DEFAULT_DATA_AVAILABILITY_WAIT_TIME 200000 /* usec */
223
224/*
225 * Wait period before retrying the lttng_consumer_flushed_cache when
226 * the consumer receives metadata.
227 */
228#define DEFAULT_METADATA_AVAILABILITY_WAIT_TIME 200000 /* usec */
229
230/*
231 * The usual value for the maximum TCP SYN retries time and TCP FIN timeout is
232 * 180 and 60 seconds on most Linux system and the default value since kernel
233 * 2.2 thus using the highest value. See tcp(7) for more details.
234 */
235#define DEFAULT_INET_TCP_TIMEOUT 180 /* sec */
236
237/*
238 * Default receiving and sending timeout for an application socket.
239 */
240#define DEFAULT_APP_SOCKET_RW_TIMEOUT 5 /* sec */
241#define DEFAULT_APP_SOCKET_TIMEOUT_ENV "LTTNG_APP_SOCKET_TIMEOUT"
242
243#define DEFAULT_UST_STREAM_FD_NUM 2 /* Number of fd per UST stream. */
244
245#define DEFAULT_SNAPSHOT_NAME "snapshot"
246#define DEFAULT_SNAPSHOT_MAX_SIZE 0 /* Unlimited. */
247
248/* Suffix of an index file. */
249#define DEFAULT_INDEX_FILE_SUFFIX ".idx"
250#define DEFAULT_INDEX_DIR "index"
251
252extern size_t default_channel_subbuf_size;
253extern size_t default_metadata_subbuf_size;
254extern size_t default_ust_pid_channel_subbuf_size;
255extern size_t default_ust_uid_channel_subbuf_size;
256extern size_t default_kernel_channel_subbuf_size;
257
258/*
259 * Returns the default subbuf size.
260 *
261 * This function depends on a value that is set at constructor time, so it is
262 * unsafe to call it from another constructor.
263 */
264static inline
265size_t default_get_channel_subbuf_size(void)
266{
267 return default_channel_subbuf_size;
268}
269
270/*
271 * Returns the default metadata subbuf size.
272 *
273 * This function depends on a value that is set at constructor time, so it is
274 * unsafe to call it from another constructor.
275 */
276static inline
277size_t default_get_metadata_subbuf_size(void)
278{
279 return default_metadata_subbuf_size;
280}
281
282/*
283 * Returns the default subbuf size for the kernel domain.
284 *
285 * This function depends on a value that is set at constructor time, so it is
286 * unsafe to call it from another constructor.
287 */
288static inline
289size_t default_get_kernel_channel_subbuf_size(void)
290{
291 return default_kernel_channel_subbuf_size;
292}
293
294/*
295 * Returns the default subbuf size for the UST domain per PID.
296 *
297 * This function depends on a value that is set at constructor time, so it is
298 * unsafe to call it from another constructor.
299 */
300static inline
301size_t default_get_ust_pid_channel_subbuf_size(void)
302{
303 return default_ust_pid_channel_subbuf_size;
304}
305
306/*
307 * Returns the default subbuf size for the UST domain per UID.
308 *
309 * This function depends on a value that is set at constructor time, so it is
310 * unsafe to call it from another constructor.
311 */
312static inline
313size_t default_get_ust_uid_channel_subbuf_size(void)
314{
315 return default_ust_uid_channel_subbuf_size;
316}
317
318#endif /* _DEFAULTS_H */
This page took 0.025674 seconds and 5 git commands to generate.