Use compiler-agnostic defines to silence warning
[lttng-tools.git] / src / common / defaults.hpp
CommitLineData
9bda164d 1/*
21cf9b6b 2 * Copyright (C) 2011 EfficiOS Inc.
ab5be9fa
MJ
3 * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 * Copyright (C) 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
9bda164d 5 *
ab5be9fa 6 * SPDX-License-Identifier: GPL-2.0-only
9bda164d 7 *
9bda164d
DG
8 */
9
990570ed
DG
10#ifndef _DEFAULTS_H
11#define _DEFAULTS_H
e848fc76 12
c9e313bc 13#include <common/macros.hpp>
78d8fb4f 14
28f23191
JG
15#include <pthread.h>
16
bbccc3d2 17/* Default unix group name for tracing. */
28f23191 18#define DEFAULT_TRACING_GROUP "tracing"
bbccc3d2 19
30079b6b
DG
20/*
21 * This value is defined in the CTF specification (see
22 * git://git.efficios.com/ctf.git in the file
23 * common-trace-format-specification.txt.
24 */
28f23191 25#define DEFAULT_METADATA_NAME "metadata"
30079b6b 26
bbccc3d2 27/* Environment variable to set session daemon binary path. */
28f23191 28#define DEFAULT_SESSIOND_PATH_ENV "LTTNG_SESSIOND_PATH"
bbccc3d2 29
4ba92f18 30/* Environment variable to set man pager binary path. */
28f23191 31#define DEFAULT_MAN_BIN_PATH_ENV "LTTNG_MAN_BIN_PATH"
4ba92f18 32
ef4a570d
OD
33/* Environment variable to set man manpath. */
34#define DEFAULT_MANPATH "LTTNG_MANPATH"
35
4ba92f18 36/* Default man pager binary path. */
28f23191 37#define DEFAULT_MAN_BIN_PATH "/usr/bin/man"
4ba92f18 38
bbccc3d2 39/* Default trace output directory name */
28f23191 40#define DEFAULT_TRACE_DIR_NAME "lttng-traces"
bbccc3d2 41
f6a9efaa 42/* Default size of a hash table */
28f23191 43#define DEFAULT_HT_SIZE 4
60922cb0
DG
44
45/* Default session daemon paths */
28f23191
JG
46#define DEFAULT_HOME_DIR "/tmp"
47#define DEFAULT_UST_SOCK_DIR DEFAULT_HOME_DIR "/ust-app-socks"
48#define DEFAULT_GLOBAL_APPS_PIPE DEFAULT_UST_SOCK_DIR "/global"
49#define DEFAULT_TRACE_OUTPUT DEFAULT_HOME_DIR "/lttng"
60922cb0 50
00e2e675 51/* Default directory where the trace are written in per domain */
28f23191
JG
52#define DEFAULT_KERNEL_TRACE_DIR "kernel"
53#define DEFAULT_UST_TRACE_DIR "ust"
00e2e675 54
7972aab2 55/* Subpath for per PID or UID sessions. */
28f23191
JG
56#define DEFAULT_UST_TRACE_PID_PATH "pid"
57#define DEFAULT_UST_TRACE_UID_PATH "uid/%d/%u-bit"
7972aab2 58
a4b92340
DG
59/*
60 * Default session name for the lttng command line. This default value will
61 * get the date and time appended (%Y%m%d-%H%M%S) to it.
62 */
28f23191 63#define DEFAULT_SESSION_NAME "auto"
a4b92340 64
60922cb0 65/* Default consumer paths */
28f23191 66#define DEFAULT_CONSUMERD_FILE "lttng-consumerd"
e6142f2e
JG
67
68/* Default consumer paths */
28f23191 69#define DEFAULT_CONSUMERD_RUNDIR "%s"
60922cb0
DG
70
71/* Kernel consumer path */
28f23191
JG
72#define DEFAULT_KCONSUMERD_PATH DEFAULT_CONSUMERD_RUNDIR "/kconsumerd"
73#define DEFAULT_KCONSUMERD_CMD_SOCK_PATH DEFAULT_KCONSUMERD_PATH "/command"
74#define DEFAULT_KCONSUMERD_ERR_SOCK_PATH DEFAULT_KCONSUMERD_PATH "/error"
60922cb0
DG
75
76/* UST 64-bit consumer path */
28f23191
JG
77#define DEFAULT_USTCONSUMERD64_PATH DEFAULT_CONSUMERD_RUNDIR "/ustconsumerd64"
78#define DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH DEFAULT_USTCONSUMERD64_PATH "/command"
79#define DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH DEFAULT_USTCONSUMERD64_PATH "/error"
60922cb0
DG
80
81/* UST 32-bit consumer path */
28f23191
JG
82#define DEFAULT_USTCONSUMERD32_PATH DEFAULT_CONSUMERD_RUNDIR "/ustconsumerd32"
83#define DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH DEFAULT_USTCONSUMERD32_PATH "/command"
84#define DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH DEFAULT_USTCONSUMERD32_PATH "/error"
60922cb0 85
65931c8b 86/* Relayd path */
28f23191
JG
87#define DEFAULT_RELAYD_RUNDIR "%s"
88#define DEFAULT_RELAYD_PATH DEFAULT_RELAYD_RUNDIR "/relayd"
65931c8b 89
28f23191 90#define DEFAULT_RELAYD_MIN_FD_POOL_SIZE 100
5c0551f9 91/*
d49487dc 92 * The file descriptor pool size needs a reserve buffer to accommodates the
5c0551f9
JG
93 * indirect use of short-lived file descriptors. For instance, glibc will
94 * create a socket (and thus, use an fd) during calls to gethostname() or
95 * when querying the user's group. Other calls also probably make use of
96 * short-lived FDs.
97 *
98 * The theoritical maximal reserve corresponds to the number of threads as,
99 * in the worst case, they could all be making such calls.
100 *
101 * This value must be less than DEFAULT_RELAYD_MIN_FD_POOL_SIZE.
102 */
28f23191 103#define DEFAULT_RELAYD_FD_POOL_SIZE_RESERVE 10
896010e3 104
990570ed 105/* Default lttng run directory */
28f23191
JG
106#define DEFAULT_LTTNG_HOME_ENV_VAR "LTTNG_HOME"
107#define DEFAULT_LTTNG_FALLBACK_HOME_ENV_VAR "HOME"
108#define DEFAULT_LTTNG_RUNDIR CONFIG_LTTNG_SYSTEM_RUNDIR
109#define DEFAULT_LTTNG_HOME_RUNDIR "%s/.lttng"
110#define DEFAULT_LTTNG_SESSIOND_PIDFILE "lttng-sessiond.pid"
111#define DEFAULT_LTTNG_SESSIOND_AGENTPORT_FILE "agent.port"
112#define DEFAULT_LTTNG_SESSIOND_LOCKFILE "lttng-sessiond.lck"
990570ed 113
fbb9748b 114/* Default probes list */
28f23191 115#define DEFAULT_LTTNG_KMOD_PROBES "LTTNG_KMOD_PROBES"
fbb9748b 116
c9d42407 117/* Default extra probes list */
28f23191 118#define DEFAULT_LTTNG_EXTRA_KMOD_PROBES "LTTNG_EXTRA_KMOD_PROBES"
c9d42407 119
990570ed 120/* Default unix socket path */
28f23191
JG
121#define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/client-lttng-sessiond"
122#define DEFAULT_HOME_CLIENT_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/client-lttng-sessiond"
123#define DEFAULT_GLOBAL_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/sessiond-health"
124#define DEFAULT_HOME_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/sessiond-health"
125#define DEFAULT_GLOBAL_NOTIFICATION_CHANNEL_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/sessiond-notification"
126#define DEFAULT_HOME_NOTIFICATION_CHANNEL_UNIX_SOCK \
127 DEFAULT_LTTNG_HOME_RUNDIR "/sessiond-notification"
990570ed 128
5c635c72 129/* Default consumer health unix socket path */
28f23191
JG
130#define DEFAULT_GLOBAL_USTCONSUMER32_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/ustconsumerd32/health"
131#define DEFAULT_HOME_USTCONSUMER32_HEALTH_UNIX_SOCK \
132 DEFAULT_LTTNG_HOME_RUNDIR "/ustconsumerd32/health"
133#define DEFAULT_GLOBAL_USTCONSUMER64_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/ustconsumerd64/health"
134#define DEFAULT_HOME_USTCONSUMER64_HEALTH_UNIX_SOCK \
135 DEFAULT_LTTNG_HOME_RUNDIR "/ustconsumerd64/health"
136#define DEFAULT_GLOBAL_KCONSUMER_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/kconsumerd/health"
137#define DEFAULT_HOME_KCONSUMER_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/kconsumerd/health"
5c635c72 138
65931c8b 139/* Default relay health unix socket path */
28f23191
JG
140#define DEFAULT_GLOBAL_RELAY_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/relayd/health-%d"
141#define DEFAULT_HOME_RELAY_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/relayd/health-%d"
65931c8b 142
1501a7f3 143/* Default daemon configuration file path */
28f23191
JG
144#define DEFAULT_SYSTEM_CONFIGPATH \
145 CONFIG_LTTNG_SYSTEM_CONFIGDIR \
fb198a11
JG
146 "/lttng"
147
28f23191
JG
148#define DEFAULT_DAEMON_CONFIG_FILE "lttng.conf"
149#define DEFAULT_DAEMON_HOME_CONFIGPATH DEFAULT_LTTNG_HOME_RUNDIR "/" DEFAULT_DAEMON_CONFIG_FILE
150#define DEFAULT_DAEMON_SYSTEM_CONFIGPATH DEFAULT_SYSTEM_CONFIGPATH "/" DEFAULT_DAEMON_CONFIG_FILE
fb198a11
JG
151
152/* Default session configuration file path */
28f23191 153#define DEFAULT_SESSION_PATH "sessions"
ab38c13f 154/* Auto load session in that directory. */
28f23191
JG
155#define DEFAULT_SESSION_CONFIG_AUTOLOAD "auto"
156#define DEFAULT_SESSION_HOME_CONFIGPATH DEFAULT_LTTNG_HOME_RUNDIR "/" DEFAULT_SESSION_PATH
157#define DEFAULT_SESSION_SYSTEM_CONFIGPATH DEFAULT_SYSTEM_CONFIGPATH "/" DEFAULT_SESSION_PATH
158#define DEFAULT_SESSION_CONFIG_FILE_EXTENSION ".lttng"
159#define DEFAULT_SESSION_CONFIG_XSD_FILENAME "session.xsd"
160#define DEFAULT_SESSION_CONFIG_XSD_PATH CONFIG_LTTNG_SYSTEM_DATADIR "/xml/lttng/"
161#define DEFAULT_SESSION_CONFIG_XSD_PATH_ENV "LTTNG_SESSION_CONFIG_XSD_PATH"
162
163#define DEFAULT_GLOBAL_APPS_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/" LTTNG_UST_SOCK_FILENAME
164#define DEFAULT_HOME_APPS_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/" LTTNG_UST_SOCK_FILENAME
165#define DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH "/" LTTNG_UST_WAIT_FILENAME
166#define DEFAULT_HOME_APPS_WAIT_SHM_PATH DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH "-%d"
d0b96690 167
990570ed
DG
168/*
169 * Value taken from the hard limit allowed by the kernel when using setrlimit
170 * with RLIMIT_NOFILE on an Intel i7 CPU and Linux 3.0.3.
171 */
172#define DEFAULT_POLL_SIZE 65535
173
ce2a9e76
DG
174/*
175 * Format is %s_%d respectively channel name and CPU number. Eigth bytes
176 * are added here to add space for the CPU number. I guess 2^8 CPUs is more
177 * than enough. We might end up with quantum computing in a cell phone when
178 * reaching this limit.
179 */
5c7248cd 180#define DEFAULT_STREAM_NAME_LEN (LTTNG_SYMBOL_NAME_LEN + 8)
ce2a9e76 181
f3ed775e 182/* Default channel attributes */
28f23191 183#define DEFAULT_CHANNEL_NAME "channel0"
0475c50c 184/* Default JUL domain channel name. */
28f23191 185#define DEFAULT_JUL_CHANNEL_NAME "lttng_jul_channel"
f20baf8e 186/* Default JUL tracepoint name. This is a wildcard for the JUL domain. */
28f23191
JG
187#define DEFAULT_JUL_EVENT_COMPONENT "lttng_jul"
188#define DEFAULT_JUL_EVENT_NAME DEFAULT_JUL_EVENT_COMPONENT ":*"
da6c3a50
DG
189
190/* Default log4j domain channel name. */
28f23191 191#define DEFAULT_LOG4J_CHANNEL_NAME "lttng_log4j_channel"
da6c3a50 192/* Default log4j tracepoint name. This is a wildcard for the log4j domain. */
28f23191
JG
193#define DEFAULT_LOG4J_EVENT_COMPONENT "lttng_log4j"
194#define DEFAULT_LOG4J_EVENT_NAME DEFAULT_LOG4J_EVENT_COMPONENT ":*"
da6c3a50 195
47abf22b
MJ
196/* Default log4j2 domain channel name. */
197#define DEFAULT_LOG4J2_CHANNEL_NAME "lttng_log4j2_channel"
198/* Default log4j tracepoint name. This is a wildcard for the log4j2 domain. */
199#define DEFAULT_LOG4J2_EVENT_COMPONENT "lttng_log4j2"
200#define DEFAULT_LOG4J2_EVENT_NAME DEFAULT_LOG4J2_EVENT_COMPONENT ":*"
201
0e115563 202/* Default Python domain channel name. */
28f23191 203#define DEFAULT_PYTHON_CHANNEL_NAME "lttng_python_channel"
0e115563 204/* Default Python tracepoint name. This is a wildcard for the python domain. */
28f23191
JG
205#define DEFAULT_PYTHON_EVENT_COMPONENT "lttng_python"
206#define DEFAULT_PYTHON_EVENT_NAME DEFAULT_PYTHON_EVENT_COMPONENT ":*"
0e115563 207
5c7248cd 208#define DEFAULT_CHANNEL_OVERWRITE (-1)
28f23191 209#define DEFAULT_CHANNEL_TRACEFILE_SIZE CONFIG_DEFAULT_CHANNEL_TRACEFILE_SIZE
7659d490
PP
210#define DEFAULT_CHANNEL_TRACEFILE_COUNT CONFIG_DEFAULT_CHANNEL_TRACEFILE_COUNT
211
28f23191
JG
212#define _DEFAULT_CHANNEL_SUBBUF_SIZE CONFIG_DEFAULT_CHANNEL_SUBBUF_SIZE
213#define _DEFAULT_CHANNEL_OUTPUT LTTNG_EVENT_MMAP
0a9c6494
DG
214
215/* Metadata channel defaults. */
28f23191
JG
216#define DEFAULT_METADATA_SUBBUF_SIZE CONFIG_DEFAULT_METADATA_SUBBUF_SIZE
217#define DEFAULT_METADATA_SUBBUF_NUM CONFIG_DEFAULT_METADATA_SUBBUF_NUM
218#define DEFAULT_METADATA_CACHE_SIZE CONFIG_DEFAULT_METADATA_CACHE_SIZE
219#define DEFAULT_METADATA_SWITCH_TIMER 0
220#define DEFAULT_METADATA_READ_TIMER 0
221#define DEFAULT_METADATA_OVERWRITE 0
222#define DEFAULT_METADATA_OUTPUT LTTNG_EVENT_MMAP
e6ddca71 223
b389abbe
MD
224/* Kernel has different defaults */
225
226/* DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE must always be a power of 2 */
28f23191 227#define DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE CONFIG_DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE
9f778c9a
MD
228/*
229 * DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM must always be a power of 2.
230 * Update help manually if override.
231 */
28f23191 232#define DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM CONFIG_DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM
b389abbe 233/* See lttng-kernel.h enum lttng_kernel_output for channel output */
28f23191 234#define DEFAULT_KERNEL_CHANNEL_OUTPUT LTTNG_EVENT_SPLICE
7659d490 235#define DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER CONFIG_DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER
e9404c27 236#define DEFAULT_KERNEL_CHANNEL_MONITOR_TIMER CONFIG_DEFAULT_KERNEL_CHANNEL_MONITOR_TIMER
7659d490
PP
237#define DEFAULT_KERNEL_CHANNEL_READ_TIMER CONFIG_DEFAULT_KERNEL_CHANNEL_READ_TIMER
238#define DEFAULT_KERNEL_CHANNEL_LIVE_TIMER CONFIG_DEFAULT_KERNEL_CHANNEL_LIVE_TIMER
28f23191 239#define DEFAULT_KERNEL_CHANNEL_BLOCKING_TIMEOUT CONFIG_DEFAULT_KERNEL_CHANNEL_BLOCKING_TIMEOUT
6bb9e85f 240
0b0dd29a
DG
241/* User space defaults */
242
243/* Must be a power of 2 */
28f23191
JG
244#define DEFAULT_UST_PID_CHANNEL_SUBBUF_SIZE CONFIG_DEFAULT_UST_PID_CHANNEL_SUBBUF_SIZE
245#define DEFAULT_UST_UID_CHANNEL_SUBBUF_SIZE CONFIG_DEFAULT_UST_UID_CHANNEL_SUBBUF_SIZE
9f778c9a 246/* Must be a power of 2. Update help manuall if override. */
28f23191
JG
247#define DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM CONFIG_DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM
248#define DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM CONFIG_DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM
28ca4a8b 249/* See lttng-ust.h enum lttng_ust_output */
28f23191
JG
250#define DEFAULT_UST_PID_CHANNEL_OUTPUT _DEFAULT_CHANNEL_OUTPUT
251#define DEFAULT_UST_UID_CHANNEL_OUTPUT _DEFAULT_CHANNEL_OUTPUT
0a9c6494 252/* Timers in usec. */
28f23191
JG
253#define DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER CONFIG_DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER
254#define DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER CONFIG_DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER
255#define DEFAULT_UST_PID_CHANNEL_LIVE_TIMER CONFIG_DEFAULT_UST_PID_CHANNEL_LIVE_TIMER
256#define DEFAULT_UST_UID_CHANNEL_LIVE_TIMER CONFIG_DEFAULT_UST_UID_CHANNEL_LIVE_TIMER
257#define DEFAULT_UST_PID_CHANNEL_MONITOR_TIMER CONFIG_DEFAULT_UST_PID_CHANNEL_MONITOR_TIMER
258#define DEFAULT_UST_UID_CHANNEL_MONITOR_TIMER CONFIG_DEFAULT_UST_UID_CHANNEL_MONITOR_TIMER
0b0dd29a 259
28f23191
JG
260#define DEFAULT_UST_PID_CHANNEL_READ_TIMER CONFIG_DEFAULT_UST_PID_CHANNEL_READ_TIMER
261#define DEFAULT_UST_UID_CHANNEL_READ_TIMER CONFIG_DEFAULT_UST_UID_CHANNEL_READ_TIMER
6bb9e85f 262
28f23191
JG
263#define DEFAULT_UST_PID_CHANNEL_BLOCKING_TIMEOUT CONFIG_DEFAULT_UST_PID_CHANNEL_BLOCKING_TIMEOUT
264#define DEFAULT_UST_UID_CHANNEL_BLOCKING_TIMEOUT CONFIG_DEFAULT_UST_UID_CHANNEL_BLOCKING_TIMEOUT
491d1539 265
ee0b0061
DG
266/*
267 * Default timeout value for the sem_timedwait() call. Blocking forever is not
268 * wanted so a timeout is used to control the data flow and not freeze the
269 * session daemon.
270 */
28f23191 271#define DEFAULT_SEM_WAIT_TIMEOUT 30 /* in seconds */
ee0b0061 272
fa91dc52 273/* Default bind addresses for network services. */
28f23191
JG
274#define DEFAULT_NETWORK_CONTROL_BIND_ADDRESS CONFIG_DEFAULT_NETWORK_CONTROL_BIND_ADDRESS
275#define DEFAULT_NETWORK_DATA_BIND_ADDRESS CONFIG_DEFAULT_NETWORK_DATA_BIND_ADDRESS
276#define DEFAULT_NETWORK_VIEWER_BIND_ADDRESS CONFIG_DEFAULT_NETWORK_VIEWER_BIND_ADDRESS
277#define DEFAULT_AGENT_BIND_ADDRESS CONFIG_DEFAULT_AGENT_BIND_ADDRESS
fa91dc52
MD
278
279/* Default network ports for trace streaming support. */
28f23191
JG
280#define DEFAULT_NETWORK_CONTROL_PORT CONFIG_DEFAULT_NETWORK_CONTROL_PORT
281#define DEFAULT_NETWORK_DATA_PORT CONFIG_DEFAULT_NETWORK_DATA_PORT
282#define DEFAULT_NETWORK_VIEWER_PORT CONFIG_DEFAULT_NETWORK_VIEWER_PORT
3a5713da 283
2288467f 284/* Agent registration TCP port range. */
28f23191
JG
285#define DEFAULT_AGENT_TCP_PORT_RANGE_BEGIN CONFIG_DEFAULT_AGENT_TCP_PORT_RANGE_BEGIN
286#define DEFAULT_AGENT_TCP_PORT_RANGE_END CONFIG_DEFAULT_AGENT_TCP_PORT_RANGE_END
4d076222 287
90aa04a1 288/* Number of buckets in the event notifier error count map. */
28f23191
JG
289#define DEFAULT_EVENT_NOTIFIER_ERROR_COUNT_MAP_SIZE \
290 CONFIG_DEFAULT_EVENT_NOTIFIER_ERROR_COUNT_MAP_SIZE
90aa04a1 291
8809eec0
MD
292/*
293 * If a thread stalls for this amount of time, it will be considered bogus (bad
294 * health).
295 */
28f23191
JG
296#define DEFAULT_HEALTH_CHECK_DELTA_S 20
297#define DEFAULT_HEALTH_CHECK_DELTA_NS 0
8809eec0 298
38ee087f 299/*
6d805429 300 * Wait period before retrying the lttng_data_pending command in the lttng
38ee087f
DG
301 * stop command of liblttng-ctl.
302 */
28f23191 303#define DEFAULT_DATA_AVAILABILITY_WAIT_TIME_US 200000 /* usec */
38ee087f 304
331744e3
JD
305/*
306 * Wait period before retrying the lttng_consumer_flushed_cache when
307 * the consumer receives metadata.
308 */
28f23191 309#define DEFAULT_METADATA_AVAILABILITY_WAIT_TIME 200000 /* usec */
331744e3 310
d831c249
DG
311/*
312 * The usual value for the maximum TCP SYN retries time and TCP FIN timeout is
313 * 180 and 60 seconds on most Linux system and the default value since kernel
314 * 2.2 thus using the highest value. See tcp(7) for more details.
315 */
28f23191 316#define DEFAULT_INET_TCP_TIMEOUT 180 /* sec */
d831c249 317
715e6fb1
JG
318/* Maximum payload size for a control connection */
319
28f23191
JG
320#define DEFAULT_NETWORK_RELAYD_CTRL_MAX_PAYLOAD_SIZE \
321 CONFIG_DEFAULT_NETWORK_RELAYD_CTRL_MAX_PAYLOAD_SIZE
715e6fb1 322
ae9e45b3
DG
323/*
324 * Default receiving and sending timeout for an application socket.
325 */
28f23191
JG
326#define DEFAULT_APP_SOCKET_RW_TIMEOUT CONFIG_DEFAULT_APP_SOCKET_RW_TIMEOUT
327#define DEFAULT_APP_SOCKET_TIMEOUT_ENV "LTTNG_APP_SOCKET_TIMEOUT"
ae9e45b3 328
28f23191 329#define DEFAULT_UST_STREAM_FD_NUM 2 /* Number of fd per UST stream. */
8b3bd7a3 330
28f23191
JG
331#define DEFAULT_SNAPSHOT_NAME "snapshot"
332#define DEFAULT_SNAPSHOT_MAX_SIZE 0 /* Unlimited. */
da3c9ec1 333
309167d2 334/* Suffix of an index file. */
28f23191
JG
335#define DEFAULT_INDEX_FILE_SUFFIX ".idx"
336#define DEFAULT_INDEX_DIR "index"
309167d2 337
d73c5802 338/* Default lttng command live timer value in usec. */
28f23191 339#define DEFAULT_LTTNG_LIVE_TIMER CONFIG_DEFAULT_LTTNG_LIVE_TIMER
d73c5802 340
7567352f 341/* Default runas worker name */
28f23191 342#define DEFAULT_RUN_AS_WORKER_NAME "lttng-runas"
7567352f 343
41af1adf 344/* Default LTTng MI XML namespace. */
28f23191 345#define DEFAULT_LTTNG_MI_NAMESPACE "https://lttng.org/xml/ns/lttng-mi"
41af1adf 346
4d5fb75f 347/* Default thread stack size; the default mandated by pthread_create(3) */
28f23191 348#define DEFAULT_LTTNG_THREAD_STACK_SIZE 2097152
4d5fb75f 349
a58c490f 350/* Default maximal size of message notification channel message payloads. */
28f23191 351#define DEFAULT_MAX_NOTIFICATION_CLIENT_MESSAGE_PAYLOAD_SIZE 65536
a58c490f 352
3e3665b8 353/* Default maximal size of trace archive location. */
28f23191 354#define DEFAULT_MAX_TRACE_ARCHIVE_LOCATION_PAYLOAD_SIZE 65536
3e3665b8 355
a58c490f 356/* Default maximal size of message notification channel message payloads. */
28f23191 357#define DEFAULT_CLIENT_MAX_QUEUED_NOTIFICATIONS_COUNT 100
f056029c 358
28f23191 359#define DEFAULT_LTTNG_RELAYD_TCP_KEEP_ALIVE_ENV "LTTNG_RELAYD_TCP_KEEP_ALIVE"
f056029c 360#define DEFAULT_LTTNG_RELAYD_TCP_KEEP_ALIVE_IDLE_TIME_ENV "LTTNG_RELAYD_TCP_KEEP_ALIVE_IDLE_TIME"
28f23191
JG
361#define DEFAULT_LTTNG_RELAYD_TCP_KEEP_ALIVE_MAX_PROBE_COUNT_ENV \
362 "LTTNG_RELAYD_TCP_KEEP_ALIVE_MAX_PROBE_COUNT"
363#define DEFAULT_LTTNG_RELAYD_TCP_KEEP_ALIVE_PROBE_INTERVAL_ENV \
364 "LTTNG_RELAYD_TCP_KEEP_ALIVE_PROBE_INTERVAL"
365#define DEFAULT_LTTNG_RELAYD_TCP_KEEP_ALIVE_ABORT_THRESHOLD_ENV \
366 "LTTNG_RELAYD_TCP_KEEP_ALIVE_ABORT_THRESHOLD"
35ab25e5 367#define DEFAULT_LTTNG_RELAYD_DISALLOW_CLEAR_ENV "LTTNG_RELAYD_DISALLOW_CLEAR"
f056029c 368
2a10de3b
JR
369#define DEFAULT_LTTNG_RELAYD_WORKING_DIRECTORY_ENV "LTTNG_RELAYD_WORKING_DIRECTORY"
370
d2956687
JG
371/*
372 * Name of the intermediate directory used to rename the trace chunk of a
373 * session's first rotation.
374 */
28f23191
JG
375#define DEFAULT_CHUNK_TMP_OLD_DIRECTORY ".tmp_old_chunk"
376#define DEFAULT_CHUNK_TMP_NEW_DIRECTORY ".tmp_new_chunk"
377#define DEFAULT_ARCHIVED_TRACE_CHUNKS_DIRECTORY "archives"
378#define DEFAULT_UNLINKED_FILES_DIRECTORY ".unlinked"
d2956687 379
d88744a4
JD
380/*
381 * Default timer value in usec for the rotate pending polling check on the
382 * relay when a rotation has completed on the consumer.
383 */
28f23191 384#define DEFAULT_ROTATE_PENDING_TIMER CONFIG_DEFAULT_ROTATE_PENDING_TIMER
d88744a4 385
8b3bd7a3
SM
386/*
387 * Returns the default subbuf size.
388 *
389 * This function depends on a value that is set at constructor time, so it is
390 * unsafe to call it from another constructor.
391 */
cd9adb8b 392size_t default_get_channel_subbuf_size();
8b3bd7a3
SM
393
394/*
395 * Returns the default metadata subbuf size.
396 *
397 * This function depends on a value that is set at constructor time, so it is
398 * unsafe to call it from another constructor.
399 */
cd9adb8b 400size_t default_get_metadata_subbuf_size();
8b3bd7a3
SM
401
402/*
403 * Returns the default subbuf size for the kernel domain.
404 *
405 * This function depends on a value that is set at constructor time, so it is
406 * unsafe to call it from another constructor.
407 */
cd9adb8b 408size_t default_get_kernel_channel_subbuf_size();
8b3bd7a3
SM
409
410/*
0a9c6494
DG
411 * Returns the default subbuf size for the UST domain per PID.
412 *
413 * This function depends on a value that is set at constructor time, so it is
414 * unsafe to call it from another constructor.
415 */
cd9adb8b 416size_t default_get_ust_pid_channel_subbuf_size();
0a9c6494
DG
417
418/*
419 * Returns the default subbuf size for the UST domain per UID.
8b3bd7a3
SM
420 *
421 * This function depends on a value that is set at constructor time, so it is
422 * unsafe to call it from another constructor.
423 */
cd9adb8b 424size_t default_get_ust_uid_channel_subbuf_size();
8b3bd7a3 425
1a1a34b4
MJ
426/*
427 * Get the default pthread_attr to use on thread creation.
428 *
429 * Some libc, such as musl, don't honor the limit set for the stack size and use
430 * their own empirically chosen static value. This function checks if the
431 * current stack size is smaller than the stack size limit and if so returns a
432 * pthread_attr_t pointer where the thread stack size is set to the soft stack
433 * size limit.
434 */
cd9adb8b 435pthread_attr_t *default_pthread_attr();
1a1a34b4 436
990570ed 437#endif /* _DEFAULTS_H */
This page took 0.115337 seconds and 4 git commands to generate.