Rename Python agent event name to omit "user"
[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"
1b2ef7fe 91#define DEFAULT_LTTNG_SESSIOND_AGENTPORT_FILE "agent.port"
c9cb3e7d 92#define DEFAULT_LTTNG_SESSIOND_LOCKFILE "lttng-sessiond.lck"
990570ed 93
fbb9748b
JG
94/* Default probes list */
95#define DEFAULT_LTTNG_KMOD_PROBES "LTTNG_KMOD_PROBES"
96
c9d42407
PP
97/* Default extra probes list */
98#define DEFAULT_LTTNG_EXTRA_KMOD_PROBES "LTTNG_EXTRA_KMOD_PROBES"
99
990570ed 100/* Default unix socket path */
60922cb0 101#define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/client-lttng-sessiond"
60922cb0 102#define DEFAULT_HOME_CLIENT_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/client-lttng-sessiond"
6c71277b
MD
103#define DEFAULT_GLOBAL_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/sessiond-health"
104#define DEFAULT_HOME_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/sessiond-health"
990570ed 105
5c635c72 106/* Default consumer health unix socket path */
6c71277b
MD
107#define DEFAULT_GLOBAL_USTCONSUMER32_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/ustconsumerd32/health"
108#define DEFAULT_HOME_USTCONSUMER32_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/ustconsumerd32/health"
109#define DEFAULT_GLOBAL_USTCONSUMER64_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/ustconsumerd64/health"
110#define DEFAULT_HOME_USTCONSUMER64_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/ustconsumerd64/health"
111#define DEFAULT_GLOBAL_KCONSUMER_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/kconsumerd/health"
112#define DEFAULT_HOME_KCONSUMER_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/kconsumerd/health"
5c635c72 113
65931c8b
MD
114/* Default relay health unix socket path */
115#define DEFAULT_GLOBAL_RELAY_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/relayd/health-%d"
116#define DEFAULT_HOME_RELAY_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/relayd/health-%d"
117
1501a7f3 118/* Default daemon configuration file path */
fb198a11
JG
119#define DEFAULT_SYSTEM_CONFIGPATH CONFIG_LTTNG_SYSTEM_CONFIGDIR \
120 "/lttng"
121
1501a7f3
JG
122#define DEFAULT_DAEMON_CONFIG_FILE "lttng.conf"
123#define DEFAULT_DAEMON_HOME_CONFIGPATH DEFAULT_LTTNG_HOME_RUNDIR "/" \
124 DEFAULT_DAEMON_CONFIG_FILE
fb198a11
JG
125#define DEFAULT_DAEMON_SYSTEM_CONFIGPATH DEFAULT_SYSTEM_CONFIGPATH "/" \
126 DEFAULT_DAEMON_CONFIG_FILE
127
128/* Default session configuration file path */
129#define DEFAULT_SESSION_PATH "sessions"
ab38c13f
DG
130/* Auto load session in that directory. */
131#define DEFAULT_SESSION_CONFIG_AUTOLOAD "auto"
fb198a11
JG
132#define DEFAULT_SESSION_HOME_CONFIGPATH DEFAULT_LTTNG_HOME_RUNDIR "/" \
133 DEFAULT_SESSION_PATH
134#define DEFAULT_SESSION_SYSTEM_CONFIGPATH DEFAULT_SYSTEM_CONFIGPATH "/" \
135 DEFAULT_SESSION_PATH
136#define DEFAULT_SESSION_CONFIG_FILE_EXTENSION ".lttng"
54e399cb
JG
137#define DEFAULT_SESSION_CONFIG_XSD_FILENAME "session.xsd"
138#define DEFAULT_SESSION_CONFIG_XSD_PATH CONFIG_LTTNG_SYSTEM_DATADIR "/xml/lttng/"
139#define DEFAULT_SESSION_CONFIG_XSD_PATH_ENV "LTTNG_SESSION_CONFIG_XSD_PATH"
1501a7f3 140
d0b96690
DG
141#define DEFAULT_GLOBAL_APPS_UNIX_SOCK \
142 DEFAULT_LTTNG_RUNDIR "/" LTTNG_UST_SOCK_FILENAME
143#define DEFAULT_HOME_APPS_UNIX_SOCK \
144 DEFAULT_LTTNG_HOME_RUNDIR "/" LTTNG_UST_SOCK_FILENAME
145#define DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH \
146 "/" LTTNG_UST_WAIT_FILENAME
147#define DEFAULT_HOME_APPS_WAIT_SHM_PATH \
148 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH "-%d"
149
990570ed
DG
150/*
151 * Value taken from the hard limit allowed by the kernel when using setrlimit
152 * with RLIMIT_NOFILE on an Intel i7 CPU and Linux 3.0.3.
153 */
154#define DEFAULT_POLL_SIZE 65535
155
ce2a9e76
DG
156/*
157 * Format is %s_%d respectively channel name and CPU number. Eigth bytes
158 * are added here to add space for the CPU number. I guess 2^8 CPUs is more
159 * than enough. We might end up with quantum computing in a cell phone when
160 * reaching this limit.
161 */
162#define DEFAULT_STREAM_NAME_LEN LTTNG_SYMBOL_NAME_LEN + 8
163
f3ed775e 164/* Default channel attributes */
3817e7df 165#define DEFAULT_CHANNEL_NAME "channel0"
0475c50c 166/* Default JUL domain channel name. */
f20baf8e
DG
167#define DEFAULT_JUL_CHANNEL_NAME "lttng_jul_channel"
168/* Default JUL tracepoint name. This is a wildcard for the JUL domain. */
d1ec8e20 169#define DEFAULT_JUL_EVENT_NAME "lttng_jul:*"
da6c3a50
DG
170
171/* Default log4j domain channel name. */
172#define DEFAULT_LOG4J_CHANNEL_NAME "lttng_log4j_channel"
173/* Default log4j tracepoint name. This is a wildcard for the log4j domain. */
d1ec8e20 174#define DEFAULT_LOG4J_EVENT_NAME "lttng_log4j:*"
da6c3a50 175
0e115563
DG
176/* Default Python domain channel name. */
177#define DEFAULT_PYTHON_CHANNEL_NAME "lttng_python_channel"
178/* Default Python tracepoint name. This is a wildcard for the python domain. */
e7c82272 179#define DEFAULT_PYTHON_EVENT_NAME "lttng_python:*"
0e115563 180
0a9c6494
DG
181#define DEFAULT_CHANNEL_OVERWRITE 0
182#define DEFAULT_CHANNEL_TRACEFILE_SIZE 0
183#define DEFAULT_CHANNEL_TRACEFILE_COUNT 0
184
185/* Must always be a power of 2 */
186#define _DEFAULT_CHANNEL_SUBBUF_SIZE 4096 /* bytes */
187/* Must always be a power of 2 */
188#define _DEFAULT_CHANNEL_SUBBUF_NUM 4
189#define _DEFAULT_CHANNEL_SWITCH_TIMER 0 /* usec */
ecc48a90 190#define _DEFAULT_CHANNEL_LIVE_TIMER 0 /* usec */
0a9c6494
DG
191#define _DEFAULT_CHANNEL_READ_TIMER 200000 /* usec */
192#define _DEFAULT_CHANNEL_OUTPUT LTTNG_EVENT_MMAP
193
194/* Metadata channel defaults. */
3817e7df
DG
195#define DEFAULT_METADATA_SUBBUF_SIZE 4096
196#define DEFAULT_METADATA_SUBBUF_NUM 2
331744e3 197#define DEFAULT_METADATA_CACHE_SIZE 4096
0a9c6494
DG
198#define DEFAULT_METADATA_SWITCH_TIMER _DEFAULT_CHANNEL_SWITCH_TIMER
199#define DEFAULT_METADATA_READ_TIMER 0
200#define DEFAULT_METADATA_OUTPUT _DEFAULT_CHANNEL_OUTPUT
e6ddca71 201
b389abbe
MD
202/* Kernel has different defaults */
203
204/* DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE must always be a power of 2 */
0a9c6494 205#define DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE 262144 /* bytes */
9f778c9a
MD
206/*
207 * DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM must always be a power of 2.
208 * Update help manually if override.
209 */
0a9c6494 210#define DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM _DEFAULT_CHANNEL_SUBBUF_NUM
b389abbe 211/* See lttng-kernel.h enum lttng_kernel_output for channel output */
0a9c6494
DG
212#define DEFAULT_KERNEL_CHANNEL_OUTPUT LTTNG_EVENT_SPLICE
213#define DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER _DEFAULT_CHANNEL_SWITCH_TIMER
214#define DEFAULT_KERNEL_CHANNEL_READ_TIMER _DEFAULT_CHANNEL_READ_TIMER
ecc48a90 215#define DEFAULT_KERNEL_CHANNEL_LIVE_TIMER _DEFAULT_CHANNEL_LIVE_TIMER
6bb9e85f 216
0b0dd29a
DG
217/* User space defaults */
218
219/* Must be a power of 2 */
0a9c6494
DG
220#define DEFAULT_UST_PID_CHANNEL_SUBBUF_SIZE _DEFAULT_CHANNEL_SUBBUF_SIZE
221#define DEFAULT_UST_UID_CHANNEL_SUBBUF_SIZE 131072 /* bytes */
9f778c9a 222/* Must be a power of 2. Update help manuall if override. */
0a9c6494
DG
223#define DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM _DEFAULT_CHANNEL_SUBBUF_NUM
224#define DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM _DEFAULT_CHANNEL_SUBBUF_NUM
28ca4a8b 225/* See lttng-ust.h enum lttng_ust_output */
0a9c6494
DG
226#define DEFAULT_UST_PID_CHANNEL_OUTPUT _DEFAULT_CHANNEL_OUTPUT
227#define DEFAULT_UST_UID_CHANNEL_OUTPUT _DEFAULT_CHANNEL_OUTPUT
228/* Timers in usec. */
229#define DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER _DEFAULT_CHANNEL_SWITCH_TIMER
230#define DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER _DEFAULT_CHANNEL_SWITCH_TIMER
ecc48a90
JD
231#define DEFAULT_UST_PID_CHANNEL_LIVE_TIMER _DEFAULT_CHANNEL_LIVE_TIMER
232#define DEFAULT_UST_UID_CHANNEL_LIVE_TIMER _DEFAULT_CHANNEL_LIVE_TIMER
0b0dd29a 233
0a9c6494
DG
234#define DEFAULT_UST_PID_CHANNEL_READ_TIMER 0 /* usec */
235#define DEFAULT_UST_UID_CHANNEL_READ_TIMER 0 /* usec */
6bb9e85f 236
ee0b0061
DG
237/*
238 * Default timeout value for the sem_timedwait() call. Blocking forever is not
239 * wanted so a timeout is used to control the data flow and not freeze the
240 * session daemon.
241 */
242#define DEFAULT_SEM_WAIT_TIMEOUT 30 /* in seconds */
243
fa91dc52
MD
244/* Default bind addresses for network services. */
245#define DEFAULT_NETWORK_CONTROL_BIND_ADDRESS "0.0.0.0"
246#define DEFAULT_NETWORK_DATA_BIND_ADDRESS "0.0.0.0"
247#define DEFAULT_NETWORK_VIEWER_BIND_ADDRESS "localhost"
022d91ba 248#define DEFAULT_AGENT_BIND_ADDRESS "localhost"
fa91dc52
MD
249
250/* Default network ports for trace streaming support. */
3a5713da
DG
251#define DEFAULT_NETWORK_CONTROL_PORT 5342
252#define DEFAULT_NETWORK_DATA_PORT 5343
d3e2ba59 253#define DEFAULT_NETWORK_VIEWER_PORT 5344
3a5713da 254
022d91ba
DG
255/* Agent registration TCP port. */
256#define DEFAULT_AGENT_TCP_PORT 5345
4d076222 257
8809eec0
MD
258/*
259 * If a thread stalls for this amount of time, it will be considered bogus (bad
260 * health).
261 */
262#define DEFAULT_HEALTH_CHECK_DELTA_S 20
263#define DEFAULT_HEALTH_CHECK_DELTA_NS 0
264
38ee087f 265/*
6d805429 266 * Wait period before retrying the lttng_data_pending command in the lttng
38ee087f
DG
267 * stop command of liblttng-ctl.
268 */
269#define DEFAULT_DATA_AVAILABILITY_WAIT_TIME 200000 /* usec */
270
331744e3
JD
271/*
272 * Wait period before retrying the lttng_consumer_flushed_cache when
273 * the consumer receives metadata.
274 */
275#define DEFAULT_METADATA_AVAILABILITY_WAIT_TIME 200000 /* usec */
276
d831c249
DG
277/*
278 * The usual value for the maximum TCP SYN retries time and TCP FIN timeout is
279 * 180 and 60 seconds on most Linux system and the default value since kernel
280 * 2.2 thus using the highest value. See tcp(7) for more details.
281 */
282#define DEFAULT_INET_TCP_TIMEOUT 180 /* sec */
283
ae9e45b3
DG
284/*
285 * Default receiving and sending timeout for an application socket.
286 */
287#define DEFAULT_APP_SOCKET_RW_TIMEOUT 5 /* sec */
288#define DEFAULT_APP_SOCKET_TIMEOUT_ENV "LTTNG_APP_SOCKET_TIMEOUT"
289
ffe60014 290#define DEFAULT_UST_STREAM_FD_NUM 2 /* Number of fd per UST stream. */
8b3bd7a3 291
da3c9ec1 292#define DEFAULT_SNAPSHOT_NAME "snapshot"
27babd3a 293#define DEFAULT_SNAPSHOT_MAX_SIZE 0 /* Unlimited. */
da3c9ec1 294
309167d2
JD
295/* Suffix of an index file. */
296#define DEFAULT_INDEX_FILE_SUFFIX ".idx"
1c20f0e2 297#define DEFAULT_INDEX_DIR "index"
309167d2 298
d73c5802
DG
299/* Default lttng command live timer value in usec. */
300#define DEFAULT_LTTNG_LIVE_TIMER 1000000
301
8b3bd7a3
SM
302extern size_t default_channel_subbuf_size;
303extern size_t default_metadata_subbuf_size;
0a9c6494
DG
304extern size_t default_ust_pid_channel_subbuf_size;
305extern size_t default_ust_uid_channel_subbuf_size;
8b3bd7a3
SM
306extern size_t default_kernel_channel_subbuf_size;
307
8b3bd7a3
SM
308/*
309 * Returns the default subbuf size.
310 *
311 * This function depends on a value that is set at constructor time, so it is
312 * unsafe to call it from another constructor.
313 */
314static inline
315size_t default_get_channel_subbuf_size(void)
316{
317 return default_channel_subbuf_size;
318}
319
320/*
321 * Returns the default metadata subbuf size.
322 *
323 * This function depends on a value that is set at constructor time, so it is
324 * unsafe to call it from another constructor.
325 */
326static inline
327size_t default_get_metadata_subbuf_size(void)
328{
329 return default_metadata_subbuf_size;
330}
331
332/*
333 * Returns the default subbuf size for the kernel domain.
334 *
335 * This function depends on a value that is set at constructor time, so it is
336 * unsafe to call it from another constructor.
337 */
338static inline
339size_t default_get_kernel_channel_subbuf_size(void)
340{
341 return default_kernel_channel_subbuf_size;
342}
343
344/*
0a9c6494
DG
345 * Returns the default subbuf size for the UST domain per PID.
346 *
347 * This function depends on a value that is set at constructor time, so it is
348 * unsafe to call it from another constructor.
349 */
350static inline
351size_t default_get_ust_pid_channel_subbuf_size(void)
352{
353 return default_ust_pid_channel_subbuf_size;
354}
355
356/*
357 * Returns the default subbuf size for the UST domain per UID.
8b3bd7a3
SM
358 *
359 * This function depends on a value that is set at constructor time, so it is
360 * unsafe to call it from another constructor.
361 */
362static inline
0a9c6494 363size_t default_get_ust_uid_channel_subbuf_size(void)
8b3bd7a3 364{
0a9c6494 365 return default_ust_uid_channel_subbuf_size;
8b3bd7a3
SM
366}
367
990570ed 368#endif /* _DEFAULTS_H */
This page took 0.054394 seconds and 4 git commands to generate.