[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 <src/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_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"

/* 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_READ_TIMER	CONFIG_DEFAULT_KERNEL_CHANNEL_READ_TIMER
#define DEFAULT_KERNEL_CHANNEL_LIVE_TIMER	CONFIG_DEFAULT_KERNEL_CHANNEL_LIVE_TIMER

/* 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_READ_TIMER      CONFIG_DEFAULT_UST_PID_CHANNEL_READ_TIMER
#define DEFAULT_UST_UID_CHANNEL_READ_TIMER      CONFIG_DEFAULT_UST_UID_CHANNEL_READ_TIMER

/*
 * 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. */
#define DEFAULT_AGENT_TCP_PORT              CONFIG_DEFAULT_AGENT_TCP_PORT

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

/*
 * 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		"http://lttng.org/xml/ns/lttng-mi"

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

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