HT support for keys with two uint64_t
[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
990570ed 81/* Default lttng run directory */
feb0f3e5
AM
82#define DEFAULT_LTTNG_HOME_ENV_VAR "LTTNG_HOME"
83#define DEFAULT_LTTNG_FALLBACK_HOME_ENV_VAR "HOME"
d386c872 84#define DEFAULT_LTTNG_RUNDIR CONFIG_LTTNG_SYSTEM_RUNDIR
60922cb0 85#define DEFAULT_LTTNG_HOME_RUNDIR "%s/.lttng"
35f90c40 86#define DEFAULT_LTTNG_SESSIOND_PIDFILE "lttng-sessiond.pid"
990570ed
DG
87
88/* Default unix socket path */
60922cb0 89#define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/client-lttng-sessiond"
60922cb0 90#define DEFAULT_HOME_CLIENT_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/client-lttng-sessiond"
44a5e5eb
DG
91#define DEFAULT_GLOBAL_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/health.sock"
92#define DEFAULT_HOME_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/health.sock"
990570ed 93
d0b96690
DG
94#define DEFAULT_GLOBAL_APPS_UNIX_SOCK \
95 DEFAULT_LTTNG_RUNDIR "/" LTTNG_UST_SOCK_FILENAME
96#define DEFAULT_HOME_APPS_UNIX_SOCK \
97 DEFAULT_LTTNG_HOME_RUNDIR "/" LTTNG_UST_SOCK_FILENAME
98#define DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH \
99 "/" LTTNG_UST_WAIT_FILENAME
100#define DEFAULT_HOME_APPS_WAIT_SHM_PATH \
101 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH "-%d"
102
990570ed
DG
103/*
104 * Value taken from the hard limit allowed by the kernel when using setrlimit
105 * with RLIMIT_NOFILE on an Intel i7 CPU and Linux 3.0.3.
106 */
107#define DEFAULT_POLL_SIZE 65535
108
ce2a9e76
DG
109/*
110 * Format is %s_%d respectively channel name and CPU number. Eigth bytes
111 * are added here to add space for the CPU number. I guess 2^8 CPUs is more
112 * than enough. We might end up with quantum computing in a cell phone when
113 * reaching this limit.
114 */
115#define DEFAULT_STREAM_NAME_LEN LTTNG_SYMBOL_NAME_LEN + 8
116
f3ed775e 117/* Default channel attributes */
3817e7df 118#define DEFAULT_CHANNEL_NAME "channel0"
0a9c6494
DG
119#define DEFAULT_CHANNEL_OVERWRITE 0
120#define DEFAULT_CHANNEL_TRACEFILE_SIZE 0
121#define DEFAULT_CHANNEL_TRACEFILE_COUNT 0
122
123/* Must always be a power of 2 */
124#define _DEFAULT_CHANNEL_SUBBUF_SIZE 4096 /* bytes */
125/* Must always be a power of 2 */
126#define _DEFAULT_CHANNEL_SUBBUF_NUM 4
127#define _DEFAULT_CHANNEL_SWITCH_TIMER 0 /* usec */
ecc48a90 128#define _DEFAULT_CHANNEL_LIVE_TIMER 0 /* usec */
0a9c6494
DG
129#define _DEFAULT_CHANNEL_READ_TIMER 200000 /* usec */
130#define _DEFAULT_CHANNEL_OUTPUT LTTNG_EVENT_MMAP
131
132/* Metadata channel defaults. */
3817e7df
DG
133#define DEFAULT_METADATA_SUBBUF_SIZE 4096
134#define DEFAULT_METADATA_SUBBUF_NUM 2
331744e3 135#define DEFAULT_METADATA_CACHE_SIZE 4096
0a9c6494
DG
136#define DEFAULT_METADATA_SWITCH_TIMER _DEFAULT_CHANNEL_SWITCH_TIMER
137#define DEFAULT_METADATA_READ_TIMER 0
138#define DEFAULT_METADATA_OUTPUT _DEFAULT_CHANNEL_OUTPUT
e6ddca71 139
b389abbe
MD
140/* Kernel has different defaults */
141
142/* DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE must always be a power of 2 */
0a9c6494 143#define DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE 262144 /* bytes */
9f778c9a
MD
144/*
145 * DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM must always be a power of 2.
146 * Update help manually if override.
147 */
0a9c6494 148#define DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM _DEFAULT_CHANNEL_SUBBUF_NUM
b389abbe 149/* See lttng-kernel.h enum lttng_kernel_output for channel output */
0a9c6494
DG
150#define DEFAULT_KERNEL_CHANNEL_OUTPUT LTTNG_EVENT_SPLICE
151#define DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER _DEFAULT_CHANNEL_SWITCH_TIMER
152#define DEFAULT_KERNEL_CHANNEL_READ_TIMER _DEFAULT_CHANNEL_READ_TIMER
ecc48a90 153#define DEFAULT_KERNEL_CHANNEL_LIVE_TIMER _DEFAULT_CHANNEL_LIVE_TIMER
6bb9e85f 154
0b0dd29a
DG
155/* User space defaults */
156
157/* Must be a power of 2 */
0a9c6494
DG
158#define DEFAULT_UST_PID_CHANNEL_SUBBUF_SIZE _DEFAULT_CHANNEL_SUBBUF_SIZE
159#define DEFAULT_UST_UID_CHANNEL_SUBBUF_SIZE 131072 /* bytes */
9f778c9a 160/* Must be a power of 2. Update help manuall if override. */
0a9c6494
DG
161#define DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM _DEFAULT_CHANNEL_SUBBUF_NUM
162#define DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM _DEFAULT_CHANNEL_SUBBUF_NUM
28ca4a8b 163/* See lttng-ust.h enum lttng_ust_output */
0a9c6494
DG
164#define DEFAULT_UST_PID_CHANNEL_OUTPUT _DEFAULT_CHANNEL_OUTPUT
165#define DEFAULT_UST_UID_CHANNEL_OUTPUT _DEFAULT_CHANNEL_OUTPUT
166/* Timers in usec. */
167#define DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER _DEFAULT_CHANNEL_SWITCH_TIMER
168#define DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER _DEFAULT_CHANNEL_SWITCH_TIMER
ecc48a90
JD
169#define DEFAULT_UST_PID_CHANNEL_LIVE_TIMER _DEFAULT_CHANNEL_LIVE_TIMER
170#define DEFAULT_UST_UID_CHANNEL_LIVE_TIMER _DEFAULT_CHANNEL_LIVE_TIMER
0b0dd29a 171
0a9c6494
DG
172#define DEFAULT_UST_PID_CHANNEL_READ_TIMER 0 /* usec */
173#define DEFAULT_UST_UID_CHANNEL_READ_TIMER 0 /* usec */
6bb9e85f 174
ee0b0061
DG
175/*
176 * Default timeout value for the sem_timedwait() call. Blocking forever is not
177 * wanted so a timeout is used to control the data flow and not freeze the
178 * session daemon.
179 */
180#define DEFAULT_SEM_WAIT_TIMEOUT 30 /* in seconds */
181
3a5713da
DG
182/* Default network ports for trace streaming support */
183#define DEFAULT_NETWORK_CONTROL_PORT 5342
184#define DEFAULT_NETWORK_DATA_PORT 5343
185
8809eec0
MD
186/*
187 * If a thread stalls for this amount of time, it will be considered bogus (bad
188 * health).
189 */
190#define DEFAULT_HEALTH_CHECK_DELTA_S 20
191#define DEFAULT_HEALTH_CHECK_DELTA_NS 0
192
38ee087f 193/*
6d805429 194 * Wait period before retrying the lttng_data_pending command in the lttng
38ee087f
DG
195 * stop command of liblttng-ctl.
196 */
197#define DEFAULT_DATA_AVAILABILITY_WAIT_TIME 200000 /* usec */
198
331744e3
JD
199/*
200 * Wait period before retrying the lttng_consumer_flushed_cache when
201 * the consumer receives metadata.
202 */
203#define DEFAULT_METADATA_AVAILABILITY_WAIT_TIME 200000 /* usec */
204
d831c249
DG
205/*
206 * The usual value for the maximum TCP SYN retries time and TCP FIN timeout is
207 * 180 and 60 seconds on most Linux system and the default value since kernel
208 * 2.2 thus using the highest value. See tcp(7) for more details.
209 */
210#define DEFAULT_INET_TCP_TIMEOUT 180 /* sec */
211
ae9e45b3
DG
212/*
213 * Default receiving and sending timeout for an application socket.
214 */
215#define DEFAULT_APP_SOCKET_RW_TIMEOUT 5 /* sec */
216#define DEFAULT_APP_SOCKET_TIMEOUT_ENV "LTTNG_APP_SOCKET_TIMEOUT"
217
ffe60014 218#define DEFAULT_UST_STREAM_FD_NUM 2 /* Number of fd per UST stream. */
8b3bd7a3 219
da3c9ec1 220#define DEFAULT_SNAPSHOT_NAME "snapshot"
27babd3a 221#define DEFAULT_SNAPSHOT_MAX_SIZE 0 /* Unlimited. */
da3c9ec1 222
309167d2
JD
223/* Suffix of an index file. */
224#define DEFAULT_INDEX_FILE_SUFFIX ".idx"
225
8b3bd7a3
SM
226extern size_t default_channel_subbuf_size;
227extern size_t default_metadata_subbuf_size;
0a9c6494
DG
228extern size_t default_ust_pid_channel_subbuf_size;
229extern size_t default_ust_uid_channel_subbuf_size;
8b3bd7a3
SM
230extern size_t default_kernel_channel_subbuf_size;
231
8b3bd7a3
SM
232/*
233 * Returns the default subbuf size.
234 *
235 * This function depends on a value that is set at constructor time, so it is
236 * unsafe to call it from another constructor.
237 */
238static inline
239size_t default_get_channel_subbuf_size(void)
240{
241 return default_channel_subbuf_size;
242}
243
244/*
245 * Returns the default metadata subbuf size.
246 *
247 * This function depends on a value that is set at constructor time, so it is
248 * unsafe to call it from another constructor.
249 */
250static inline
251size_t default_get_metadata_subbuf_size(void)
252{
253 return default_metadata_subbuf_size;
254}
255
256/*
257 * Returns the default subbuf size for the kernel domain.
258 *
259 * This function depends on a value that is set at constructor time, so it is
260 * unsafe to call it from another constructor.
261 */
262static inline
263size_t default_get_kernel_channel_subbuf_size(void)
264{
265 return default_kernel_channel_subbuf_size;
266}
267
268/*
0a9c6494
DG
269 * Returns the default subbuf size for the UST domain per PID.
270 *
271 * This function depends on a value that is set at constructor time, so it is
272 * unsafe to call it from another constructor.
273 */
274static inline
275size_t default_get_ust_pid_channel_subbuf_size(void)
276{
277 return default_ust_pid_channel_subbuf_size;
278}
279
280/*
281 * Returns the default subbuf size for the UST domain per UID.
8b3bd7a3
SM
282 *
283 * This function depends on a value that is set at constructor time, so it is
284 * unsafe to call it from another constructor.
285 */
286static inline
0a9c6494 287size_t default_get_ust_uid_channel_subbuf_size(void)
8b3bd7a3 288{
0a9c6494 289 return default_ust_uid_channel_subbuf_size;
8b3bd7a3
SM
290}
291
990570ed 292#endif /* _DEFAULTS_H */
This page took 0.044391 seconds and 4 git commands to generate.