[lttng-tools.git] / src / common / defaults.hpp

/*
 * Copyright (C) 2011 EfficiOS Inc.
 * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 * Copyright (C) 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * SPDX-License-Identifier: GPL-2.0-only
 *
 */

#ifndef _DEFAULTS_H
#define _DEFAULTS_H

#include <common/macros.hpp>

#include <pthread.h>

/* Default unix group name for tracing. */
#define DEFAULT_TRACING_GROUP "tracing"

/*
 * This value is defined in the CTF specification (see
 * git://git.efficios.com/ctf.git in the file
 * common-trace-format-specification.txt.
 */
#define DEFAULT_METADATA_NAME "metadata"

/* Environment variable to set session daemon binary path. */
#define DEFAULT_SESSIOND_PATH_ENV "LTTNG_SESSIOND_PATH"

/* Environment variable to set man pager binary path. */
#define DEFAULT_MAN_BIN_PATH_ENV "LTTNG_MAN_BIN_PATH"

/* Environment variable to set man manpath. */
#define DEFAULT_MANPATH "LTTNG_MANPATH"

/* Default man pager binary path. */
#define DEFAULT_MAN_BIN_PATH "/usr/bin/man"

/* Default trace output directory name */
#define DEFAULT_TRACE_DIR_NAME "lttng-traces"

/* Default size of a hash table */
#define DEFAULT_HT_SIZE 4

/* Default session daemon paths */
#define DEFAULT_HOME_DIR	 "/tmp"
#define DEFAULT_UST_SOCK_DIR	 DEFAULT_HOME_DIR "/ust-app-socks"
#define DEFAULT_GLOBAL_APPS_PIPE DEFAULT_UST_SOCK_DIR "/global"
#define DEFAULT_TRACE_OUTPUT	 DEFAULT_HOME_DIR "/lttng"

/* Default directory where the trace are written in per domain */
#define DEFAULT_KERNEL_TRACE_DIR "kernel"
#define DEFAULT_UST_TRACE_DIR	 "ust"

/* Subpath for per PID or UID sessions. */
#define DEFAULT_UST_TRACE_PID_PATH "pid"
#define DEFAULT_UST_TRACE_UID_PATH "uid/%d/%u-bit"

/*
 * Default session name for the lttng command line. This default value will
 * get the date and time appended (%Y%m%d-%H%M%S) to it.
 */
#define DEFAULT_SESSION_NAME "auto"

/* Default consumer paths */
#define DEFAULT_CONSUMERD_FILE "lttng-consumerd"

/* Default consumer paths */
#define DEFAULT_CONSUMERD_RUNDIR "%s"

/* Kernel consumer path */
#define DEFAULT_KCONSUMERD_PATH		 DEFAULT_CONSUMERD_RUNDIR "/kconsumerd"
#define DEFAULT_KCONSUMERD_CMD_SOCK_PATH DEFAULT_KCONSUMERD_PATH "/command"
#define DEFAULT_KCONSUMERD_ERR_SOCK_PATH DEFAULT_KCONSUMERD_PATH "/error"

/* UST 64-bit consumer path */
#define DEFAULT_USTCONSUMERD64_PATH	     DEFAULT_CONSUMERD_RUNDIR "/ustconsumerd64"
#define DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH DEFAULT_USTCONSUMERD64_PATH "/command"
#define DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH DEFAULT_USTCONSUMERD64_PATH "/error"

/* UST 32-bit consumer path */
#define DEFAULT_USTCONSUMERD32_PATH	     DEFAULT_CONSUMERD_RUNDIR "/ustconsumerd32"
#define DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH DEFAULT_USTCONSUMERD32_PATH "/command"
#define DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH DEFAULT_USTCONSUMERD32_PATH "/error"

/* Relayd path */
#define DEFAULT_RELAYD_RUNDIR "%s"
#define DEFAULT_RELAYD_PATH   DEFAULT_RELAYD_RUNDIR "/relayd"

#define DEFAULT_RELAYD_MIN_FD_POOL_SIZE 100
/*
 * The file descriptor pool size needs a reserve buffer to accommodates the
 * indirect use of short-lived file descriptors. For instance, glibc will
 * create a socket (and thus, use an fd) during calls to gethostname() or
 * when querying the user's group. Other calls also probably make use of
 * short-lived FDs.
 *
 * The theoritical maximal reserve corresponds to the number of threads as,
 * in the worst case, they could all be making such calls.
 *
 * This value must be less than DEFAULT_RELAYD_MIN_FD_POOL_SIZE.
 */
#define DEFAULT_RELAYD_FD_POOL_SIZE_RESERVE 10

/* Default lttng run directory */
#define DEFAULT_LTTNG_HOME_ENV_VAR	      "LTTNG_HOME"
#define DEFAULT_LTTNG_FALLBACK_HOME_ENV_VAR   "HOME"
#define DEFAULT_LTTNG_RUNDIR		      CONFIG_LTTNG_SYSTEM_RUNDIR
#define DEFAULT_LTTNG_HOME_RUNDIR	      "%s/.lttng"
#define DEFAULT_LTTNG_SESSIOND_PIDFILE	      "lttng-sessiond.pid"
#define DEFAULT_LTTNG_SESSIOND_AGENTPORT_FILE "agent.port"
#define DEFAULT_LTTNG_SESSIOND_LOCKFILE	      "lttng-sessiond.lck"

/* Default probes list */
#define DEFAULT_LTTNG_KMOD_PROBES "LTTNG_KMOD_PROBES"

/* Default extra probes list */
#define DEFAULT_LTTNG_EXTRA_KMOD_PROBES "LTTNG_EXTRA_KMOD_PROBES"

/* Default unix socket path */
#define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK		      DEFAULT_LTTNG_RUNDIR "/client-lttng-sessiond"
#define DEFAULT_HOME_CLIENT_UNIX_SOCK		      DEFAULT_LTTNG_HOME_RUNDIR "/client-lttng-sessiond"
#define DEFAULT_GLOBAL_HEALTH_UNIX_SOCK		      DEFAULT_LTTNG_RUNDIR "/sessiond-health"
#define DEFAULT_HOME_HEALTH_UNIX_SOCK		      DEFAULT_LTTNG_HOME_RUNDIR "/sessiond-health"
#define DEFAULT_GLOBAL_NOTIFICATION_CHANNEL_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/sessiond-notification"
#define DEFAULT_HOME_NOTIFICATION_CHANNEL_UNIX_SOCK \
	DEFAULT_LTTNG_HOME_RUNDIR "/sessiond-notification"

/* Default consumer health unix socket path */
#define DEFAULT_GLOBAL_USTCONSUMER32_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/ustconsumerd32/health"
#define DEFAULT_HOME_USTCONSUMER32_HEALTH_UNIX_SOCK \
	DEFAULT_LTTNG_HOME_RUNDIR "/ustconsumerd32/health"
#define DEFAULT_GLOBAL_USTCONSUMER64_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/ustconsumerd64/health"
#define DEFAULT_HOME_USTCONSUMER64_HEALTH_UNIX_SOCK \
	DEFAULT_LTTNG_HOME_RUNDIR "/ustconsumerd64/health"
#define DEFAULT_GLOBAL_KCONSUMER_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/kconsumerd/health"
#define DEFAULT_HOME_KCONSUMER_HEALTH_UNIX_SOCK	  DEFAULT_LTTNG_HOME_RUNDIR "/kconsumerd/health"

/* Default relay health unix socket path */
#define DEFAULT_GLOBAL_RELAY_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/relayd/health-%d"
#define DEFAULT_HOME_RELAY_HEALTH_UNIX_SOCK   DEFAULT_LTTNG_HOME_RUNDIR "/relayd/health-%d"

/* Default daemon configuration file path */
#define DEFAULT_SYSTEM_CONFIGPATH     \
	CONFIG_LTTNG_SYSTEM_CONFIGDIR \
	"/lttng"

#define DEFAULT_DAEMON_CONFIG_FILE	 "lttng.conf"
#define DEFAULT_DAEMON_HOME_CONFIGPATH	 DEFAULT_LTTNG_HOME_RUNDIR "/" DEFAULT_DAEMON_CONFIG_FILE
#define DEFAULT_DAEMON_SYSTEM_CONFIGPATH DEFAULT_SYSTEM_CONFIGPATH "/" DEFAULT_DAEMON_CONFIG_FILE

/* Default session configuration file path */
#define DEFAULT_SESSION_PATH "sessions"
/* Auto load session in that directory. */
#define DEFAULT_SESSION_CONFIG_AUTOLOAD	      "auto"
#define DEFAULT_SESSION_HOME_CONFIGPATH	      DEFAULT_LTTNG_HOME_RUNDIR "/" DEFAULT_SESSION_PATH
#define DEFAULT_SESSION_SYSTEM_CONFIGPATH     DEFAULT_SYSTEM_CONFIGPATH "/" DEFAULT_SESSION_PATH
#define DEFAULT_SESSION_CONFIG_FILE_EXTENSION ".lttng"
#define DEFAULT_SESSION_CONFIG_XSD_FILENAME   "session.xsd"
#define DEFAULT_SESSION_CONFIG_XSD_PATH	      CONFIG_LTTNG_SYSTEM_DATADIR "/xml/lttng/"
#define DEFAULT_SESSION_CONFIG_XSD_PATH_ENV   "LTTNG_SESSION_CONFIG_XSD_PATH"

#define DEFAULT_GLOBAL_APPS_UNIX_SOCK	  DEFAULT_LTTNG_RUNDIR "/" LTTNG_UST_SOCK_FILENAME
#define DEFAULT_HOME_APPS_UNIX_SOCK	  DEFAULT_LTTNG_HOME_RUNDIR "/" LTTNG_UST_SOCK_FILENAME
#define DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH "/" LTTNG_UST_WAIT_FILENAME
#define DEFAULT_HOME_APPS_WAIT_SHM_PATH	  DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH "-%d"

/*
 * Value taken from the hard limit allowed by the kernel when using setrlimit
 * with RLIMIT_NOFILE on an Intel i7 CPU and Linux 3.0.3.
 */
#define DEFAULT_POLL_SIZE 65535

/*
 * Format is %s_%d respectively channel name and CPU number. Eigth bytes
 * are added here to add space for the CPU number. I guess 2^8 CPUs is more
 * than enough. We might end up with quantum computing in a cell phone when
 * reaching this limit.
 */
#define DEFAULT_STREAM_NAME_LEN (LTTNG_SYMBOL_NAME_LEN + 8)

/* Default channel attributes */
#define DEFAULT_CHANNEL_NAME "channel0"
/* Default JUL domain channel name. */
#define DEFAULT_JUL_CHANNEL_NAME "lttng_jul_channel"
/* Default JUL tracepoint name. This is a wildcard for the JUL domain. */
#define DEFAULT_JUL_EVENT_COMPONENT "lttng_jul"
#define DEFAULT_JUL_EVENT_NAME	    DEFAULT_JUL_EVENT_COMPONENT ":*"

/* Default log4j domain channel name. */
#define DEFAULT_LOG4J_CHANNEL_NAME "lttng_log4j_channel"
/* Default log4j tracepoint name. This is a wildcard for the log4j domain. */
#define DEFAULT_LOG4J_EVENT_COMPONENT "lttng_log4j"
#define DEFAULT_LOG4J_EVENT_NAME      DEFAULT_LOG4J_EVENT_COMPONENT ":*"

/* Default Python domain channel name. */
#define DEFAULT_PYTHON_CHANNEL_NAME "lttng_python_channel"
/* Default Python tracepoint name. This is a wildcard for the python domain. */
#define DEFAULT_PYTHON_EVENT_COMPONENT "lttng_python"
#define DEFAULT_PYTHON_EVENT_NAME      DEFAULT_PYTHON_EVENT_COMPONENT ":*"

#define DEFAULT_CHANNEL_OVERWRITE	(-1)
#define DEFAULT_CHANNEL_TRACEFILE_SIZE	CONFIG_DEFAULT_CHANNEL_TRACEFILE_SIZE
#define DEFAULT_CHANNEL_TRACEFILE_COUNT CONFIG_DEFAULT_CHANNEL_TRACEFILE_COUNT

#define _DEFAULT_CHANNEL_SUBBUF_SIZE CONFIG_DEFAULT_CHANNEL_SUBBUF_SIZE
#define _DEFAULT_CHANNEL_OUTPUT	     LTTNG_EVENT_MMAP

/* Metadata channel defaults. */
#define DEFAULT_METADATA_SUBBUF_SIZE  CONFIG_DEFAULT_METADATA_SUBBUF_SIZE
#define DEFAULT_METADATA_SUBBUF_NUM   CONFIG_DEFAULT_METADATA_SUBBUF_NUM
#define DEFAULT_METADATA_CACHE_SIZE   CONFIG_DEFAULT_METADATA_CACHE_SIZE
#define DEFAULT_METADATA_SWITCH_TIMER 0
#define DEFAULT_METADATA_READ_TIMER   0
#define DEFAULT_METADATA_OVERWRITE    0
#define DEFAULT_METADATA_OUTPUT	      LTTNG_EVENT_MMAP

/* Kernel has different defaults */

/* DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE must always be a power of 2 */
#define DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE CONFIG_DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE
/*
 * DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM must always be a power of 2.
 * Update help manually if override.
 */
#define DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM CONFIG_DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM
/* See lttng-kernel.h enum lttng_kernel_output for channel output */
#define DEFAULT_KERNEL_CHANNEL_OUTPUT		LTTNG_EVENT_SPLICE
#define DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER	CONFIG_DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER
#define DEFAULT_KERNEL_CHANNEL_MONITOR_TIMER	CONFIG_DEFAULT_KERNEL_CHANNEL_MONITOR_TIMER
#define DEFAULT_KERNEL_CHANNEL_READ_TIMER	CONFIG_DEFAULT_KERNEL_CHANNEL_READ_TIMER
#define DEFAULT_KERNEL_CHANNEL_LIVE_TIMER	CONFIG_DEFAULT_KERNEL_CHANNEL_LIVE_TIMER
#define DEFAULT_KERNEL_CHANNEL_BLOCKING_TIMEOUT CONFIG_DEFAULT_KERNEL_CHANNEL_BLOCKING_TIMEOUT

/* User space defaults */

/* Must be a power of 2 */
#define DEFAULT_UST_PID_CHANNEL_SUBBUF_SIZE CONFIG_DEFAULT_UST_PID_CHANNEL_SUBBUF_SIZE
#define DEFAULT_UST_UID_CHANNEL_SUBBUF_SIZE CONFIG_DEFAULT_UST_UID_CHANNEL_SUBBUF_SIZE
/* Must be a power of 2. Update help manuall if override. */
#define DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM CONFIG_DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM
#define DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM CONFIG_DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM
/* See lttng-ust.h enum lttng_ust_output */
#define DEFAULT_UST_PID_CHANNEL_OUTPUT _DEFAULT_CHANNEL_OUTPUT
#define DEFAULT_UST_UID_CHANNEL_OUTPUT _DEFAULT_CHANNEL_OUTPUT
/* Timers in usec. */
#define DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER  CONFIG_DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER
#define DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER  CONFIG_DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER
#define DEFAULT_UST_PID_CHANNEL_LIVE_TIMER    CONFIG_DEFAULT_UST_PID_CHANNEL_LIVE_TIMER
#define DEFAULT_UST_UID_CHANNEL_LIVE_TIMER    CONFIG_DEFAULT_UST_UID_CHANNEL_LIVE_TIMER
#define DEFAULT_UST_PID_CHANNEL_MONITOR_TIMER CONFIG_DEFAULT_UST_PID_CHANNEL_MONITOR_TIMER
#define DEFAULT_UST_UID_CHANNEL_MONITOR_TIMER CONFIG_DEFAULT_UST_UID_CHANNEL_MONITOR_TIMER

#define DEFAULT_UST_PID_CHANNEL_READ_TIMER CONFIG_DEFAULT_UST_PID_CHANNEL_READ_TIMER
#define DEFAULT_UST_UID_CHANNEL_READ_TIMER CONFIG_DEFAULT_UST_UID_CHANNEL_READ_TIMER

#define DEFAULT_UST_PID_CHANNEL_BLOCKING_TIMEOUT CONFIG_DEFAULT_UST_PID_CHANNEL_BLOCKING_TIMEOUT
#define DEFAULT_UST_UID_CHANNEL_BLOCKING_TIMEOUT CONFIG_DEFAULT_UST_UID_CHANNEL_BLOCKING_TIMEOUT

/*
 * Default timeout value for the sem_timedwait() call. Blocking forever is not
 * wanted so a timeout is used to control the data flow and not freeze the
 * session daemon.
 */
#define DEFAULT_SEM_WAIT_TIMEOUT 30 /* in seconds */

/* Default bind addresses for network services. */
#define DEFAULT_NETWORK_CONTROL_BIND_ADDRESS CONFIG_DEFAULT_NETWORK_CONTROL_BIND_ADDRESS
#define DEFAULT_NETWORK_DATA_BIND_ADDRESS    CONFIG_DEFAULT_NETWORK_DATA_BIND_ADDRESS
#define DEFAULT_NETWORK_VIEWER_BIND_ADDRESS  CONFIG_DEFAULT_NETWORK_VIEWER_BIND_ADDRESS
#define DEFAULT_AGENT_BIND_ADDRESS	     CONFIG_DEFAULT_AGENT_BIND_ADDRESS

/* Default network ports for trace streaming support. */
#define DEFAULT_NETWORK_CONTROL_PORT CONFIG_DEFAULT_NETWORK_CONTROL_PORT
#define DEFAULT_NETWORK_DATA_PORT    CONFIG_DEFAULT_NETWORK_DATA_PORT
#define DEFAULT_NETWORK_VIEWER_PORT  CONFIG_DEFAULT_NETWORK_VIEWER_PORT

/* Agent registration TCP port range. */
#define DEFAULT_AGENT_TCP_PORT_RANGE_BEGIN CONFIG_DEFAULT_AGENT_TCP_PORT_RANGE_BEGIN
#define DEFAULT_AGENT_TCP_PORT_RANGE_END   CONFIG_DEFAULT_AGENT_TCP_PORT_RANGE_END

/* Number of buckets in the event notifier error count map. */
#define DEFAULT_EVENT_NOTIFIER_ERROR_COUNT_MAP_SIZE \
	CONFIG_DEFAULT_EVENT_NOTIFIER_ERROR_COUNT_MAP_SIZE

/*
 * If a thread stalls for this amount of time, it will be considered bogus (bad
 * health).
 */
#define DEFAULT_HEALTH_CHECK_DELTA_S  20
#define DEFAULT_HEALTH_CHECK_DELTA_NS 0

/*
 * Wait period before retrying the lttng_data_pending command in the lttng
 * stop command of liblttng-ctl.
 */
#define DEFAULT_DATA_AVAILABILITY_WAIT_TIME_US 200000 /* usec */

/*
 * Wait period before retrying the lttng_consumer_flushed_cache when
 * the consumer receives metadata.
 */
#define DEFAULT_METADATA_AVAILABILITY_WAIT_TIME 200000 /* usec */

/*
 * The usual value for the maximum TCP SYN retries time and TCP FIN timeout is
 * 180 and 60 seconds on most Linux system and the default value since kernel
 * 2.2 thus using the highest value. See tcp(7) for more details.
 */
#define DEFAULT_INET_TCP_TIMEOUT 180 /* sec */

/* Maximum payload size for a control connection */

#define DEFAULT_NETWORK_RELAYD_CTRL_MAX_PAYLOAD_SIZE \
	CONFIG_DEFAULT_NETWORK_RELAYD_CTRL_MAX_PAYLOAD_SIZE

/*
 * Default receiving and sending timeout for an application socket.
 */
#define DEFAULT_APP_SOCKET_RW_TIMEOUT  CONFIG_DEFAULT_APP_SOCKET_RW_TIMEOUT
#define DEFAULT_APP_SOCKET_TIMEOUT_ENV "LTTNG_APP_SOCKET_TIMEOUT"

#define DEFAULT_UST_STREAM_FD_NUM 2 /* Number of fd per UST stream. */

#define DEFAULT_SNAPSHOT_NAME	  "snapshot"
#define DEFAULT_SNAPSHOT_MAX_SIZE 0 /* Unlimited. */

/* Suffix of an index file. */
#define DEFAULT_INDEX_FILE_SUFFIX ".idx"
#define DEFAULT_INDEX_DIR	  "index"

/* Default lttng command live timer value in usec. */
#define DEFAULT_LTTNG_LIVE_TIMER CONFIG_DEFAULT_LTTNG_LIVE_TIMER

/* Default runas worker name */
#define DEFAULT_RUN_AS_WORKER_NAME "lttng-runas"

/* Default LTTng MI XML namespace. */
#define DEFAULT_LTTNG_MI_NAMESPACE "https://lttng.org/xml/ns/lttng-mi"

/* Default thread stack size; the default mandated by pthread_create(3) */
#define DEFAULT_LTTNG_THREAD_STACK_SIZE 2097152

/* Default maximal size of message notification channel message payloads. */
#define DEFAULT_MAX_NOTIFICATION_CLIENT_MESSAGE_PAYLOAD_SIZE 65536

/* Default maximal size of trace archive location. */
#define DEFAULT_MAX_TRACE_ARCHIVE_LOCATION_PAYLOAD_SIZE 65536

/* Default maximal size of message notification channel message payloads. */
#define DEFAULT_CLIENT_MAX_QUEUED_NOTIFICATIONS_COUNT 100

#define DEFAULT_LTTNG_RELAYD_TCP_KEEP_ALIVE_ENV		  "LTTNG_RELAYD_TCP_KEEP_ALIVE"
#define DEFAULT_LTTNG_RELAYD_TCP_KEEP_ALIVE_IDLE_TIME_ENV "LTTNG_RELAYD_TCP_KEEP_ALIVE_IDLE_TIME"
#define DEFAULT_LTTNG_RELAYD_TCP_KEEP_ALIVE_MAX_PROBE_COUNT_ENV \
	"LTTNG_RELAYD_TCP_KEEP_ALIVE_MAX_PROBE_COUNT"
#define DEFAULT_LTTNG_RELAYD_TCP_KEEP_ALIVE_PROBE_INTERVAL_ENV \
	"LTTNG_RELAYD_TCP_KEEP_ALIVE_PROBE_INTERVAL"
#define DEFAULT_LTTNG_RELAYD_TCP_KEEP_ALIVE_ABORT_THRESHOLD_ENV \
	"LTTNG_RELAYD_TCP_KEEP_ALIVE_ABORT_THRESHOLD"
#define DEFAULT_LTTNG_RELAYD_DISALLOW_CLEAR_ENV "LTTNG_RELAYD_DISALLOW_CLEAR"

#define DEFAULT_LTTNG_RELAYD_WORKING_DIRECTORY_ENV "LTTNG_RELAYD_WORKING_DIRECTORY"

/*
 * Name of the intermediate directory used to rename the trace chunk of a
 * session's first rotation.
 */
#define DEFAULT_CHUNK_TMP_OLD_DIRECTORY		".tmp_old_chunk"
#define DEFAULT_CHUNK_TMP_NEW_DIRECTORY		".tmp_new_chunk"
#define DEFAULT_ARCHIVED_TRACE_CHUNKS_DIRECTORY "archives"
#define DEFAULT_UNLINKED_FILES_DIRECTORY	".unlinked"

/*
 * Default timer value in usec for the rotate pending polling check on the
 * relay when a rotation has completed on the consumer.
 */
#define DEFAULT_ROTATE_PENDING_TIMER CONFIG_DEFAULT_ROTATE_PENDING_TIMER

/*
 * Returns the default subbuf size.
 *
 * This function depends on a value that is set at constructor time, so it is
 * unsafe to call it from another constructor.
 */
size_t default_get_channel_subbuf_size();

/*
 * Returns the default metadata subbuf size.
 *
 * This function depends on a value that is set at constructor time, so it is
 * unsafe to call it from another constructor.
 */
size_t default_get_metadata_subbuf_size();

/*
 * Returns the default subbuf size for the kernel domain.
 *
 * This function depends on a value that is set at constructor time, so it is
 * unsafe to call it from another constructor.
 */
size_t default_get_kernel_channel_subbuf_size();

/*
 * Returns the default subbuf size for the UST domain per PID.
 *
 * This function depends on a value that is set at constructor time, so it is
 * unsafe to call it from another constructor.
 */
size_t default_get_ust_pid_channel_subbuf_size();

/*
 * Returns the default subbuf size for the UST domain per UID.
 *
 * This function depends on a value that is set at constructor time, so it is
 * unsafe to call it from another constructor.
 */
size_t default_get_ust_uid_channel_subbuf_size();

/*
 * Get the default pthread_attr to use on thread creation.
 *
 * Some libc, such as musl, don't honor the limit set for the stack size and use
 * their own empirically chosen static value. This function checks if the
 * current stack size is smaller than the stack size limit and if so returns a
 * pthread_attr_t pointer where the thread stack size is set to the soft stack
 * size limit.
 */
pthread_attr_t *default_pthread_attr();

#endif /* _DEFAULTS_H */
Commit	Line	Data
	1	/*
	2	* Copyright (C) 2011 EfficiOS Inc.
	3	* Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	4	* Copyright (C) 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
	5	*
	6	* SPDX-License-Identifier: GPL-2.0-only
	7	*
	8	*/
	9
	10	#ifndef _DEFAULTS_H
	11	#define _DEFAULTS_H
	12
	13	#include <common/macros.hpp>
	14
	15	#include <pthread.h>
	16
	17	/* Default unix group name for tracing. */
	18	#define DEFAULT_TRACING_GROUP "tracing"
	19
	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	*/
	25	#define DEFAULT_METADATA_NAME "metadata"
	26
	27	/* Environment variable to set session daemon binary path. */
	28	#define DEFAULT_SESSIOND_PATH_ENV "LTTNG_SESSIOND_PATH"
	29
	30	/* Environment variable to set man pager binary path. */
	31	#define DEFAULT_MAN_BIN_PATH_ENV "LTTNG_MAN_BIN_PATH"
	32
	33	/* Environment variable to set man manpath. */
	34	#define DEFAULT_MANPATH "LTTNG_MANPATH"
	35
	36	/* Default man pager binary path. */
	37	#define DEFAULT_MAN_BIN_PATH "/usr/bin/man"
	38
	39	/* Default trace output directory name */
	40	#define DEFAULT_TRACE_DIR_NAME "lttng-traces"
	41
	42	/* Default size of a hash table */
	43	#define DEFAULT_HT_SIZE 4
	44
	45	/* Default session daemon paths */
	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"
	50
	51	/* Default directory where the trace are written in per domain */
	52	#define DEFAULT_KERNEL_TRACE_DIR "kernel"
	53	#define DEFAULT_UST_TRACE_DIR "ust"
	54
	55	/* Subpath for per PID or UID sessions. */
	56	#define DEFAULT_UST_TRACE_PID_PATH "pid"
	57	#define DEFAULT_UST_TRACE_UID_PATH "uid/%d/%u-bit"
	58
	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	*/
	63	#define DEFAULT_SESSION_NAME "auto"
	64
	65	/* Default consumer paths */
	66	#define DEFAULT_CONSUMERD_FILE "lttng-consumerd"
	67
	68	/* Default consumer paths */
	69	#define DEFAULT_CONSUMERD_RUNDIR "%s"
	70
	71	/* Kernel consumer path */
	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"
	75
	76	/* UST 64-bit consumer path */
	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"
	80
	81	/* UST 32-bit consumer path */
	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"
	85
	86	/* Relayd path */
	87	#define DEFAULT_RELAYD_RUNDIR "%s"
	88	#define DEFAULT_RELAYD_PATH DEFAULT_RELAYD_RUNDIR "/relayd"
	89
	90	#define DEFAULT_RELAYD_MIN_FD_POOL_SIZE 100
	91	/*
	92	* The file descriptor pool size needs a reserve buffer to accommodates the
	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	*/
	103	#define DEFAULT_RELAYD_FD_POOL_SIZE_RESERVE 10
	104
	105	/* Default lttng run directory */
	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"
	113
	114	/* Default probes list */
	115	#define DEFAULT_LTTNG_KMOD_PROBES "LTTNG_KMOD_PROBES"
	116
	117	/* Default extra probes list */
	118	#define DEFAULT_LTTNG_EXTRA_KMOD_PROBES "LTTNG_EXTRA_KMOD_PROBES"
	119
	120	/* Default unix socket path */
	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"
	128
	129	/* Default consumer health unix socket path */
	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"
	138
	139	/* Default relay health unix socket path */
	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"
	142
	143	/* Default daemon configuration file path */
	144	#define DEFAULT_SYSTEM_CONFIGPATH \
	145	CONFIG_LTTNG_SYSTEM_CONFIGDIR \
	146	"/lttng"
	147
	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
	151
	152	/* Default session configuration file path */
	153	#define DEFAULT_SESSION_PATH "sessions"
	154	/* Auto load session in that directory. */
	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"
	167
	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
	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	*/
	180	#define DEFAULT_STREAM_NAME_LEN (LTTNG_SYMBOL_NAME_LEN + 8)
	181
	182	/* Default channel attributes */
	183	#define DEFAULT_CHANNEL_NAME "channel0"
	184	/* Default JUL domain channel name. */
	185	#define DEFAULT_JUL_CHANNEL_NAME "lttng_jul_channel"
	186	/* Default JUL tracepoint name. This is a wildcard for the JUL domain. */
	187	#define DEFAULT_JUL_EVENT_COMPONENT "lttng_jul"
	188	#define DEFAULT_JUL_EVENT_NAME DEFAULT_JUL_EVENT_COMPONENT ":*"
	189
	190	/* Default log4j domain channel name. */
	191	#define DEFAULT_LOG4J_CHANNEL_NAME "lttng_log4j_channel"
	192	/* Default log4j tracepoint name. This is a wildcard for the log4j domain. */
	193	#define DEFAULT_LOG4J_EVENT_COMPONENT "lttng_log4j"
	194	#define DEFAULT_LOG4J_EVENT_NAME DEFAULT_LOG4J_EVENT_COMPONENT ":*"
	195
	196	/* Default Python domain channel name. */
	197	#define DEFAULT_PYTHON_CHANNEL_NAME "lttng_python_channel"
	198	/* Default Python tracepoint name. This is a wildcard for the python domain. */
	199	#define DEFAULT_PYTHON_EVENT_COMPONENT "lttng_python"
	200	#define DEFAULT_PYTHON_EVENT_NAME DEFAULT_PYTHON_EVENT_COMPONENT ":*"
	201
	202	#define DEFAULT_CHANNEL_OVERWRITE (-1)
	203	#define DEFAULT_CHANNEL_TRACEFILE_SIZE CONFIG_DEFAULT_CHANNEL_TRACEFILE_SIZE
	204	#define DEFAULT_CHANNEL_TRACEFILE_COUNT CONFIG_DEFAULT_CHANNEL_TRACEFILE_COUNT
	205
	206	#define _DEFAULT_CHANNEL_SUBBUF_SIZE CONFIG_DEFAULT_CHANNEL_SUBBUF_SIZE
	207	#define _DEFAULT_CHANNEL_OUTPUT LTTNG_EVENT_MMAP
	208
	209	/* Metadata channel defaults. */
	210	#define DEFAULT_METADATA_SUBBUF_SIZE CONFIG_DEFAULT_METADATA_SUBBUF_SIZE
	211	#define DEFAULT_METADATA_SUBBUF_NUM CONFIG_DEFAULT_METADATA_SUBBUF_NUM
	212	#define DEFAULT_METADATA_CACHE_SIZE CONFIG_DEFAULT_METADATA_CACHE_SIZE
	213	#define DEFAULT_METADATA_SWITCH_TIMER 0
	214	#define DEFAULT_METADATA_READ_TIMER 0
	215	#define DEFAULT_METADATA_OVERWRITE 0
	216	#define DEFAULT_METADATA_OUTPUT LTTNG_EVENT_MMAP
	217
	218	/* Kernel has different defaults */
	219
	220	/* DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE must always be a power of 2 */
	221	#define DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE CONFIG_DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE
	222	/*
	223	* DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM must always be a power of 2.
	224	* Update help manually if override.
	225	*/
	226	#define DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM CONFIG_DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM
	227	/* See lttng-kernel.h enum lttng_kernel_output for channel output */
	228	#define DEFAULT_KERNEL_CHANNEL_OUTPUT LTTNG_EVENT_SPLICE
	229	#define DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER CONFIG_DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER
	230	#define DEFAULT_KERNEL_CHANNEL_MONITOR_TIMER CONFIG_DEFAULT_KERNEL_CHANNEL_MONITOR_TIMER
	231	#define DEFAULT_KERNEL_CHANNEL_READ_TIMER CONFIG_DEFAULT_KERNEL_CHANNEL_READ_TIMER
	232	#define DEFAULT_KERNEL_CHANNEL_LIVE_TIMER CONFIG_DEFAULT_KERNEL_CHANNEL_LIVE_TIMER
	233	#define DEFAULT_KERNEL_CHANNEL_BLOCKING_TIMEOUT CONFIG_DEFAULT_KERNEL_CHANNEL_BLOCKING_TIMEOUT
	234
	235	/* User space defaults */
	236
	237	/* Must be a power of 2 */
	238	#define DEFAULT_UST_PID_CHANNEL_SUBBUF_SIZE CONFIG_DEFAULT_UST_PID_CHANNEL_SUBBUF_SIZE
	239	#define DEFAULT_UST_UID_CHANNEL_SUBBUF_SIZE CONFIG_DEFAULT_UST_UID_CHANNEL_SUBBUF_SIZE
	240	/* Must be a power of 2. Update help manuall if override. */
	241	#define DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM CONFIG_DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM
	242	#define DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM CONFIG_DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM
	243	/* See lttng-ust.h enum lttng_ust_output */
	244	#define DEFAULT_UST_PID_CHANNEL_OUTPUT _DEFAULT_CHANNEL_OUTPUT
	245	#define DEFAULT_UST_UID_CHANNEL_OUTPUT _DEFAULT_CHANNEL_OUTPUT
	246	/* Timers in usec. */
	247	#define DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER CONFIG_DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER
	248	#define DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER CONFIG_DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER
	249	#define DEFAULT_UST_PID_CHANNEL_LIVE_TIMER CONFIG_DEFAULT_UST_PID_CHANNEL_LIVE_TIMER
	250	#define DEFAULT_UST_UID_CHANNEL_LIVE_TIMER CONFIG_DEFAULT_UST_UID_CHANNEL_LIVE_TIMER
	251	#define DEFAULT_UST_PID_CHANNEL_MONITOR_TIMER CONFIG_DEFAULT_UST_PID_CHANNEL_MONITOR_TIMER
	252	#define DEFAULT_UST_UID_CHANNEL_MONITOR_TIMER CONFIG_DEFAULT_UST_UID_CHANNEL_MONITOR_TIMER
	253
	254	#define DEFAULT_UST_PID_CHANNEL_READ_TIMER CONFIG_DEFAULT_UST_PID_CHANNEL_READ_TIMER
	255	#define DEFAULT_UST_UID_CHANNEL_READ_TIMER CONFIG_DEFAULT_UST_UID_CHANNEL_READ_TIMER
	256
	257	#define DEFAULT_UST_PID_CHANNEL_BLOCKING_TIMEOUT CONFIG_DEFAULT_UST_PID_CHANNEL_BLOCKING_TIMEOUT
	258	#define DEFAULT_UST_UID_CHANNEL_BLOCKING_TIMEOUT CONFIG_DEFAULT_UST_UID_CHANNEL_BLOCKING_TIMEOUT
	259
	260	/*
	261	* Default timeout value for the sem_timedwait() call. Blocking forever is not
	262	* wanted so a timeout is used to control the data flow and not freeze the
	263	* session daemon.
	264	*/
	265	#define DEFAULT_SEM_WAIT_TIMEOUT 30 /* in seconds */
	266
	267	/* Default bind addresses for network services. */
	268	#define DEFAULT_NETWORK_CONTROL_BIND_ADDRESS CONFIG_DEFAULT_NETWORK_CONTROL_BIND_ADDRESS
	269	#define DEFAULT_NETWORK_DATA_BIND_ADDRESS CONFIG_DEFAULT_NETWORK_DATA_BIND_ADDRESS
	270	#define DEFAULT_NETWORK_VIEWER_BIND_ADDRESS CONFIG_DEFAULT_NETWORK_VIEWER_BIND_ADDRESS
	271	#define DEFAULT_AGENT_BIND_ADDRESS CONFIG_DEFAULT_AGENT_BIND_ADDRESS
	272
	273	/* Default network ports for trace streaming support. */
	274	#define DEFAULT_NETWORK_CONTROL_PORT CONFIG_DEFAULT_NETWORK_CONTROL_PORT
	275	#define DEFAULT_NETWORK_DATA_PORT CONFIG_DEFAULT_NETWORK_DATA_PORT
	276	#define DEFAULT_NETWORK_VIEWER_PORT CONFIG_DEFAULT_NETWORK_VIEWER_PORT
	277
	278	/* Agent registration TCP port range. */
	279	#define DEFAULT_AGENT_TCP_PORT_RANGE_BEGIN CONFIG_DEFAULT_AGENT_TCP_PORT_RANGE_BEGIN
	280	#define DEFAULT_AGENT_TCP_PORT_RANGE_END CONFIG_DEFAULT_AGENT_TCP_PORT_RANGE_END
	281
	282	/* Number of buckets in the event notifier error count map. */
	283	#define DEFAULT_EVENT_NOTIFIER_ERROR_COUNT_MAP_SIZE \
	284	CONFIG_DEFAULT_EVENT_NOTIFIER_ERROR_COUNT_MAP_SIZE
	285
	286	/*
	287	* If a thread stalls for this amount of time, it will be considered bogus (bad
	288	* health).
	289	*/
	290	#define DEFAULT_HEALTH_CHECK_DELTA_S 20
	291	#define DEFAULT_HEALTH_CHECK_DELTA_NS 0
	292
	293	/*
	294	* Wait period before retrying the lttng_data_pending command in the lttng
	295	* stop command of liblttng-ctl.
	296	*/
	297	#define DEFAULT_DATA_AVAILABILITY_WAIT_TIME_US 200000 /* usec */
	298
	299	/*
	300	* Wait period before retrying the lttng_consumer_flushed_cache when
	301	* the consumer receives metadata.
	302	*/
	303	#define DEFAULT_METADATA_AVAILABILITY_WAIT_TIME 200000 /* usec */
	304
	305	/*
	306	* The usual value for the maximum TCP SYN retries time and TCP FIN timeout is
	307	* 180 and 60 seconds on most Linux system and the default value since kernel
	308	* 2.2 thus using the highest value. See tcp(7) for more details.
	309	*/
	310	#define DEFAULT_INET_TCP_TIMEOUT 180 /* sec */
	311
	312	/* Maximum payload size for a control connection */
	313
	314	#define DEFAULT_NETWORK_RELAYD_CTRL_MAX_PAYLOAD_SIZE \
	315	CONFIG_DEFAULT_NETWORK_RELAYD_CTRL_MAX_PAYLOAD_SIZE
	316
	317	/*
	318	* Default receiving and sending timeout for an application socket.
	319	*/
	320	#define DEFAULT_APP_SOCKET_RW_TIMEOUT CONFIG_DEFAULT_APP_SOCKET_RW_TIMEOUT
	321	#define DEFAULT_APP_SOCKET_TIMEOUT_ENV "LTTNG_APP_SOCKET_TIMEOUT"
	322
	323	#define DEFAULT_UST_STREAM_FD_NUM 2 /* Number of fd per UST stream. */
	324
	325	#define DEFAULT_SNAPSHOT_NAME "snapshot"
	326	#define DEFAULT_SNAPSHOT_MAX_SIZE 0 /* Unlimited. */
	327
	328	/* Suffix of an index file. */
	329	#define DEFAULT_INDEX_FILE_SUFFIX ".idx"
	330	#define DEFAULT_INDEX_DIR "index"
	331
	332	/* Default lttng command live timer value in usec. */
	333	#define DEFAULT_LTTNG_LIVE_TIMER CONFIG_DEFAULT_LTTNG_LIVE_TIMER
	334
	335	/* Default runas worker name */
	336	#define DEFAULT_RUN_AS_WORKER_NAME "lttng-runas"
	337
	338	/* Default LTTng MI XML namespace. */
	339	#define DEFAULT_LTTNG_MI_NAMESPACE "https://lttng.org/xml/ns/lttng-mi"
	340
	341	/* Default thread stack size; the default mandated by pthread_create(3) */
	342	#define DEFAULT_LTTNG_THREAD_STACK_SIZE 2097152
	343
	344	/* Default maximal size of message notification channel message payloads. */
	345	#define DEFAULT_MAX_NOTIFICATION_CLIENT_MESSAGE_PAYLOAD_SIZE 65536
	346
	347	/* Default maximal size of trace archive location. */
	348	#define DEFAULT_MAX_TRACE_ARCHIVE_LOCATION_PAYLOAD_SIZE 65536
	349
	350	/* Default maximal size of message notification channel message payloads. */
	351	#define DEFAULT_CLIENT_MAX_QUEUED_NOTIFICATIONS_COUNT 100
	352
	353	#define DEFAULT_LTTNG_RELAYD_TCP_KEEP_ALIVE_ENV "LTTNG_RELAYD_TCP_KEEP_ALIVE"
	354	#define DEFAULT_LTTNG_RELAYD_TCP_KEEP_ALIVE_IDLE_TIME_ENV "LTTNG_RELAYD_TCP_KEEP_ALIVE_IDLE_TIME"
	355	#define DEFAULT_LTTNG_RELAYD_TCP_KEEP_ALIVE_MAX_PROBE_COUNT_ENV \
	356	"LTTNG_RELAYD_TCP_KEEP_ALIVE_MAX_PROBE_COUNT"
	357	#define DEFAULT_LTTNG_RELAYD_TCP_KEEP_ALIVE_PROBE_INTERVAL_ENV \
	358	"LTTNG_RELAYD_TCP_KEEP_ALIVE_PROBE_INTERVAL"
	359	#define DEFAULT_LTTNG_RELAYD_TCP_KEEP_ALIVE_ABORT_THRESHOLD_ENV \
	360	"LTTNG_RELAYD_TCP_KEEP_ALIVE_ABORT_THRESHOLD"
	361	#define DEFAULT_LTTNG_RELAYD_DISALLOW_CLEAR_ENV "LTTNG_RELAYD_DISALLOW_CLEAR"
	362
	363	#define DEFAULT_LTTNG_RELAYD_WORKING_DIRECTORY_ENV "LTTNG_RELAYD_WORKING_DIRECTORY"
	364
	365	/*
	366	* Name of the intermediate directory used to rename the trace chunk of a
	367	* session's first rotation.
	368	*/
	369	#define DEFAULT_CHUNK_TMP_OLD_DIRECTORY ".tmp_old_chunk"
	370	#define DEFAULT_CHUNK_TMP_NEW_DIRECTORY ".tmp_new_chunk"
	371	#define DEFAULT_ARCHIVED_TRACE_CHUNKS_DIRECTORY "archives"
	372	#define DEFAULT_UNLINKED_FILES_DIRECTORY ".unlinked"
	373
	374	/*
	375	* Default timer value in usec for the rotate pending polling check on the
	376	* relay when a rotation has completed on the consumer.
	377	*/
	378	#define DEFAULT_ROTATE_PENDING_TIMER CONFIG_DEFAULT_ROTATE_PENDING_TIMER
	379
	380	/*
	381	* Returns the default subbuf size.
	382	*
	383	* This function depends on a value that is set at constructor time, so it is
	384	* unsafe to call it from another constructor.
	385	*/
	386	size_t default_get_channel_subbuf_size();
	387
	388	/*
	389	* Returns the default metadata subbuf size.
	390	*
	391	* This function depends on a value that is set at constructor time, so it is
	392	* unsafe to call it from another constructor.
	393	*/
	394	size_t default_get_metadata_subbuf_size();
	395
	396	/*
	397	* Returns the default subbuf size for the kernel domain.
	398	*
	399	* This function depends on a value that is set at constructor time, so it is
	400	* unsafe to call it from another constructor.
	401	*/
	402	size_t default_get_kernel_channel_subbuf_size();
	403
	404	/*
	405	* Returns the default subbuf size for the UST domain per PID.
	406	*
	407	* This function depends on a value that is set at constructor time, so it is
	408	* unsafe to call it from another constructor.
	409	*/
	410	size_t default_get_ust_pid_channel_subbuf_size();
	411
	412	/*
	413	* Returns the default subbuf size for the UST domain per UID.
	414	*
	415	* This function depends on a value that is set at constructor time, so it is
	416	* unsafe to call it from another constructor.
	417	*/
	418	size_t default_get_ust_uid_channel_subbuf_size();
	419
	420	/*
	421	* Get the default pthread_attr to use on thread creation.
	422	*
	423	* Some libc, such as musl, don't honor the limit set for the stack size and use
	424	* their own empirically chosen static value. This function checks if the
	425	* current stack size is smaller than the stack size limit and if so returns a
	426	* pthread_attr_t pointer where the thread stack size is set to the soft stack
	427	* size limit.
	428	*/
	429	pthread_attr_t *default_pthread_attr();
	430
	431	#endif /* _DEFAULTS_H */