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

/*
 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
 *                      Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *               2015 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License, version 2 only,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef _DEFAULTS_H
#define _DEFAULTS_H

#include <pthread.h>
#include <common/macros.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"

/* 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"

/* 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	CONFIG_DEFAULT_METADATA_SWITCH_TIMER
#define DEFAULT_METADATA_READ_TIMER	CONFIG_DEFAULT_METADATA_READ_TIMER
#define DEFAULT_METADATA_OUTPUT			_DEFAULT_CHANNEL_OUTPUT

/* 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

/*
 * 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 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 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"

/*
 * 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.
 */
LTTNG_HIDDEN
size_t default_get_channel_subbuf_size(void);

/*
 * 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.
 */
LTTNG_HIDDEN
size_t default_get_metadata_subbuf_size(void);

/*
 * 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.
 */
LTTNG_HIDDEN
size_t default_get_kernel_channel_subbuf_size(void);

/*
 * 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.
 */
LTTNG_HIDDEN
size_t default_get_ust_pid_channel_subbuf_size(void);

/*
 * 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.
 */
LTTNG_HIDDEN
size_t default_get_ust_uid_channel_subbuf_size(void);

/*
 * 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.
 */
LTTNG_HIDDEN
pthread_attr_t *default_pthread_attr(void);

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