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

/*
 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
 *                      Mathieu Desnoyers <mathieu.desnoyers@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 <config.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"

/* 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_SYS_JUL_EVENT_NAME      "lttng_jul:sys*"
#define DEFAULT_USER_JUL_EVENT_NAME     "lttng_jul:user*"

/* 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_SYS_LOG4J_EVENT_NAME      "lttng_log4j:sys*"
#define DEFAULT_USER_LOG4J_EVENT_NAME     "lttng_log4j:user*"

/* 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_USER_PYTHON_EVENT_NAME    "lttng_python:user*"

#define DEFAULT_CHANNEL_OVERWRITE       0
#define DEFAULT_CHANNEL_TRACEFILE_SIZE  0
#define DEFAULT_CHANNEL_TRACEFILE_COUNT 0

/* Must always be a power of 2 */
#define _DEFAULT_CHANNEL_SUBBUF_SIZE	4096    /* bytes */
/* Must always be a power of 2 */
#define _DEFAULT_CHANNEL_SUBBUF_NUM		4
#define _DEFAULT_CHANNEL_SWITCH_TIMER	0       /* usec */
#define _DEFAULT_CHANNEL_LIVE_TIMER	0       /* usec */
#define _DEFAULT_CHANNEL_READ_TIMER		200000  /* usec */
#define _DEFAULT_CHANNEL_OUTPUT			LTTNG_EVENT_MMAP

/* Metadata channel defaults. */
#define DEFAULT_METADATA_SUBBUF_SIZE    4096
#define DEFAULT_METADATA_SUBBUF_NUM     2
#define DEFAULT_METADATA_CACHE_SIZE     4096
#define DEFAULT_METADATA_SWITCH_TIMER	_DEFAULT_CHANNEL_SWITCH_TIMER
#define DEFAULT_METADATA_READ_TIMER		0
#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		262144    /* bytes */
/*
 * DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM must always be a power of 2.
 * Update help manually if override.
 */
#define DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM		_DEFAULT_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		_DEFAULT_CHANNEL_SWITCH_TIMER
#define DEFAULT_KERNEL_CHANNEL_READ_TIMER		_DEFAULT_CHANNEL_READ_TIMER
#define DEFAULT_KERNEL_CHANNEL_LIVE_TIMER		_DEFAULT_CHANNEL_LIVE_TIMER

/* User space defaults */

/* Must be a power of 2 */
#define DEFAULT_UST_PID_CHANNEL_SUBBUF_SIZE		_DEFAULT_CHANNEL_SUBBUF_SIZE
#define DEFAULT_UST_UID_CHANNEL_SUBBUF_SIZE		131072  /* bytes */
/* Must be a power of 2. Update help manuall if override. */
#define DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM		_DEFAULT_CHANNEL_SUBBUF_NUM
#define DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM		_DEFAULT_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	_DEFAULT_CHANNEL_SWITCH_TIMER
#define DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER	_DEFAULT_CHANNEL_SWITCH_TIMER
#define DEFAULT_UST_PID_CHANNEL_LIVE_TIMER	_DEFAULT_CHANNEL_LIVE_TIMER
#define DEFAULT_UST_UID_CHANNEL_LIVE_TIMER	_DEFAULT_CHANNEL_LIVE_TIMER

#define DEFAULT_UST_PID_CHANNEL_READ_TIMER      0  /* usec */
#define DEFAULT_UST_UID_CHANNEL_READ_TIMER      0  /* usec */

/*
 * 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    "0.0.0.0"
#define DEFAULT_NETWORK_DATA_BIND_ADDRESS       "0.0.0.0"
#define DEFAULT_NETWORK_VIEWER_BIND_ADDRESS     "localhost"
#define DEFAULT_AGENT_BIND_ADDRESS              "localhost"

/* Default network ports for trace streaming support. */
#define DEFAULT_NETWORK_CONTROL_PORT        5342
#define DEFAULT_NETWORK_DATA_PORT           5343
#define DEFAULT_NETWORK_VIEWER_PORT         5344

/* Agent registration TCP port. */
#define DEFAULT_AGENT_TCP_PORT              5345

/*
 * 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       5  /* sec */
#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			1000000

extern size_t default_channel_subbuf_size;
extern size_t default_metadata_subbuf_size;
extern size_t default_ust_pid_channel_subbuf_size;
extern size_t default_ust_uid_channel_subbuf_size;
extern size_t default_kernel_channel_subbuf_size;

/*
 * 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.
 */
static inline
size_t default_get_channel_subbuf_size(void)
{
	return default_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.
 */
static inline
size_t default_get_metadata_subbuf_size(void)
{
	return default_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.
 */
static inline
size_t default_get_kernel_channel_subbuf_size(void)
{
	return default_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.
 */
static inline
size_t default_get_ust_pid_channel_subbuf_size(void)
{
	return default_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.
 */
static inline
size_t default_get_ust_uid_channel_subbuf_size(void)
{
	return default_ust_uid_channel_subbuf_size;
}

#endif /* _DEFAULTS_H */
Commit	Line	Data
	1	/*
	2	* Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
	3	* Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	4	*
	5	* This program is free software; you can redistribute it and/or modify
	6	* it under the terms of the GNU General Public License, version 2 only,
	7	* as published by the Free Software Foundation.
	8	*
	9	* This program is distributed in the hope that it will be useful, but WITHOUT
	10	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	11	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
	12	* more details.
	13	*
	14	* You should have received a copy of the GNU General Public License along
	15	* with this program; if not, write to the Free Software Foundation, Inc.,
	16	* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
	17	*/
	18
	19	#ifndef _DEFAULTS_H
	20	#define _DEFAULTS_H
	21
	22	#include <config.h>
	23
	24	/* Default unix group name for tracing. */
	25	#define DEFAULT_TRACING_GROUP "tracing"
	26
	27	/*
	28	* This value is defined in the CTF specification (see
	29	* git://git.efficios.com/ctf.git in the file
	30	* common-trace-format-specification.txt.
	31	*/
	32	#define DEFAULT_METADATA_NAME "metadata"
	33
	34	/* Environment variable to set session daemon binary path. */
	35	#define DEFAULT_SESSIOND_PATH_ENV "LTTNG_SESSIOND_PATH"
	36
	37	/* Default trace output directory name */
	38	#define DEFAULT_TRACE_DIR_NAME "lttng-traces"
	39
	40	/* Default size of a hash table */
	41	#define DEFAULT_HT_SIZE 4
	42
	43	/* Default session daemon paths */
	44	#define DEFAULT_HOME_DIR "/tmp"
	45	#define DEFAULT_UST_SOCK_DIR DEFAULT_HOME_DIR "/ust-app-socks"
	46	#define DEFAULT_GLOBAL_APPS_PIPE DEFAULT_UST_SOCK_DIR "/global"
	47	#define DEFAULT_TRACE_OUTPUT DEFAULT_HOME_DIR "/lttng"
	48
	49	/* Default directory where the trace are written in per domain */
	50	#define DEFAULT_KERNEL_TRACE_DIR "/kernel"
	51	#define DEFAULT_UST_TRACE_DIR "/ust"
	52
	53	/* Subpath for per PID or UID sessions. */
	54	#define DEFAULT_UST_TRACE_PID_PATH "/pid"
	55	#define DEFAULT_UST_TRACE_UID_PATH "/uid/%d/%u-bit"
	56
	57	/*
	58	* Default session name for the lttng command line. This default value will
	59	* get the date and time appended (%Y%m%d-%H%M%S) to it.
	60	*/
	61	#define DEFAULT_SESSION_NAME "auto"
	62
	63	/* Default consumer paths */
	64	#define DEFAULT_CONSUMERD_RUNDIR "%s"
	65
	66	/* Kernel consumer path */
	67	#define DEFAULT_KCONSUMERD_PATH DEFAULT_CONSUMERD_RUNDIR "/kconsumerd"
	68	#define DEFAULT_KCONSUMERD_CMD_SOCK_PATH DEFAULT_KCONSUMERD_PATH "/command"
	69	#define DEFAULT_KCONSUMERD_ERR_SOCK_PATH DEFAULT_KCONSUMERD_PATH "/error"
	70
	71	/* UST 64-bit consumer path */
	72	#define DEFAULT_USTCONSUMERD64_PATH DEFAULT_CONSUMERD_RUNDIR "/ustconsumerd64"
	73	#define DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH DEFAULT_USTCONSUMERD64_PATH "/command"
	74	#define DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH DEFAULT_USTCONSUMERD64_PATH "/error"
	75
	76	/* UST 32-bit consumer path */
	77	#define DEFAULT_USTCONSUMERD32_PATH DEFAULT_CONSUMERD_RUNDIR "/ustconsumerd32"
	78	#define DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH DEFAULT_USTCONSUMERD32_PATH "/command"
	79	#define DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH DEFAULT_USTCONSUMERD32_PATH "/error"
	80
	81	/* Relayd path */
	82	#define DEFAULT_RELAYD_RUNDIR "%s"
	83	#define DEFAULT_RELAYD_PATH DEFAULT_RELAYD_RUNDIR "/relayd"
	84
	85	/* Default lttng run directory */
	86	#define DEFAULT_LTTNG_HOME_ENV_VAR "LTTNG_HOME"
	87	#define DEFAULT_LTTNG_FALLBACK_HOME_ENV_VAR "HOME"
	88	#define DEFAULT_LTTNG_RUNDIR CONFIG_LTTNG_SYSTEM_RUNDIR
	89	#define DEFAULT_LTTNG_HOME_RUNDIR "%s/.lttng"
	90	#define DEFAULT_LTTNG_SESSIOND_PIDFILE "lttng-sessiond.pid"
	91	#define DEFAULT_LTTNG_SESSIOND_AGENTPORT_FILE "agent.port"
	92	#define DEFAULT_LTTNG_SESSIOND_LOCKFILE "lttng-sessiond.lck"
	93
	94	/* Default probes list */
	95	#define DEFAULT_LTTNG_KMOD_PROBES "LTTNG_KMOD_PROBES"
	96
	97	/* Default extra probes list */
	98	#define DEFAULT_LTTNG_EXTRA_KMOD_PROBES "LTTNG_EXTRA_KMOD_PROBES"
	99
	100	/* Default unix socket path */
	101	#define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/client-lttng-sessiond"
	102	#define DEFAULT_HOME_CLIENT_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/client-lttng-sessiond"
	103	#define DEFAULT_GLOBAL_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/sessiond-health"
	104	#define DEFAULT_HOME_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/sessiond-health"
	105
	106	/* Default consumer health unix socket path */
	107	#define DEFAULT_GLOBAL_USTCONSUMER32_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/ustconsumerd32/health"
	108	#define DEFAULT_HOME_USTCONSUMER32_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/ustconsumerd32/health"
	109	#define DEFAULT_GLOBAL_USTCONSUMER64_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/ustconsumerd64/health"
	110	#define DEFAULT_HOME_USTCONSUMER64_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/ustconsumerd64/health"
	111	#define DEFAULT_GLOBAL_KCONSUMER_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/kconsumerd/health"
	112	#define DEFAULT_HOME_KCONSUMER_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/kconsumerd/health"
	113
	114	/* Default relay health unix socket path */
	115	#define DEFAULT_GLOBAL_RELAY_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/relayd/health-%d"
	116	#define DEFAULT_HOME_RELAY_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/relayd/health-%d"
	117
	118	/* Default daemon configuration file path */
	119	#define DEFAULT_SYSTEM_CONFIGPATH CONFIG_LTTNG_SYSTEM_CONFIGDIR \
	120	"/lttng"
	121
	122	#define DEFAULT_DAEMON_CONFIG_FILE "lttng.conf"
	123	#define DEFAULT_DAEMON_HOME_CONFIGPATH DEFAULT_LTTNG_HOME_RUNDIR "/" \
	124	DEFAULT_DAEMON_CONFIG_FILE
	125	#define DEFAULT_DAEMON_SYSTEM_CONFIGPATH DEFAULT_SYSTEM_CONFIGPATH "/" \
	126	DEFAULT_DAEMON_CONFIG_FILE
	127
	128	/* Default session configuration file path */
	129	#define DEFAULT_SESSION_PATH "sessions"
	130	/* Auto load session in that directory. */
	131	#define DEFAULT_SESSION_CONFIG_AUTOLOAD "auto"
	132	#define DEFAULT_SESSION_HOME_CONFIGPATH DEFAULT_LTTNG_HOME_RUNDIR "/" \
	133	DEFAULT_SESSION_PATH
	134	#define DEFAULT_SESSION_SYSTEM_CONFIGPATH DEFAULT_SYSTEM_CONFIGPATH "/" \
	135	DEFAULT_SESSION_PATH
	136	#define DEFAULT_SESSION_CONFIG_FILE_EXTENSION ".lttng"
	137	#define DEFAULT_SESSION_CONFIG_XSD_FILENAME "session.xsd"
	138	#define DEFAULT_SESSION_CONFIG_XSD_PATH CONFIG_LTTNG_SYSTEM_DATADIR "/xml/lttng/"
	139	#define DEFAULT_SESSION_CONFIG_XSD_PATH_ENV "LTTNG_SESSION_CONFIG_XSD_PATH"
	140
	141	#define DEFAULT_GLOBAL_APPS_UNIX_SOCK \
	142	DEFAULT_LTTNG_RUNDIR "/" LTTNG_UST_SOCK_FILENAME
	143	#define DEFAULT_HOME_APPS_UNIX_SOCK \
	144	DEFAULT_LTTNG_HOME_RUNDIR "/" LTTNG_UST_SOCK_FILENAME
	145	#define DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH \
	146	"/" LTTNG_UST_WAIT_FILENAME
	147	#define DEFAULT_HOME_APPS_WAIT_SHM_PATH \
	148	DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH "-%d"
	149
	150	/*
	151	* Value taken from the hard limit allowed by the kernel when using setrlimit
	152	* with RLIMIT_NOFILE on an Intel i7 CPU and Linux 3.0.3.
	153	*/
	154	#define DEFAULT_POLL_SIZE 65535
	155
	156	/*
	157	* Format is %s_%d respectively channel name and CPU number. Eigth bytes
	158	* are added here to add space for the CPU number. I guess 2^8 CPUs is more
	159	* than enough. We might end up with quantum computing in a cell phone when
	160	* reaching this limit.
	161	*/
	162	#define DEFAULT_STREAM_NAME_LEN LTTNG_SYMBOL_NAME_LEN + 8
	163
	164	/* Default channel attributes */
	165	#define DEFAULT_CHANNEL_NAME "channel0"
	166	/* Default JUL domain channel name. */
	167	#define DEFAULT_JUL_CHANNEL_NAME "lttng_jul_channel"
	168	/* Default JUL tracepoint name. This is a wildcard for the JUL domain. */
	169	#define DEFAULT_SYS_JUL_EVENT_NAME "lttng_jul:sys*"
	170	#define DEFAULT_USER_JUL_EVENT_NAME "lttng_jul:user*"
	171
	172	/* Default log4j domain channel name. */
	173	#define DEFAULT_LOG4J_CHANNEL_NAME "lttng_log4j_channel"
	174	/* Default log4j tracepoint name. This is a wildcard for the log4j domain. */
	175	#define DEFAULT_SYS_LOG4J_EVENT_NAME "lttng_log4j:sys*"
	176	#define DEFAULT_USER_LOG4J_EVENT_NAME "lttng_log4j:user*"
	177
	178	/* Default Python domain channel name. */
	179	#define DEFAULT_PYTHON_CHANNEL_NAME "lttng_python_channel"
	180	/* Default Python tracepoint name. This is a wildcard for the python domain. */
	181	#define DEFAULT_USER_PYTHON_EVENT_NAME "lttng_python:user*"
	182
	183	#define DEFAULT_CHANNEL_OVERWRITE 0
	184	#define DEFAULT_CHANNEL_TRACEFILE_SIZE 0
	185	#define DEFAULT_CHANNEL_TRACEFILE_COUNT 0
	186
	187	/* Must always be a power of 2 */
	188	#define _DEFAULT_CHANNEL_SUBBUF_SIZE 4096 /* bytes */
	189	/* Must always be a power of 2 */
	190	#define _DEFAULT_CHANNEL_SUBBUF_NUM 4
	191	#define _DEFAULT_CHANNEL_SWITCH_TIMER 0 /* usec */
	192	#define _DEFAULT_CHANNEL_LIVE_TIMER 0 /* usec */
	193	#define _DEFAULT_CHANNEL_READ_TIMER 200000 /* usec */
	194	#define _DEFAULT_CHANNEL_OUTPUT LTTNG_EVENT_MMAP
	195
	196	/* Metadata channel defaults. */
	197	#define DEFAULT_METADATA_SUBBUF_SIZE 4096
	198	#define DEFAULT_METADATA_SUBBUF_NUM 2
	199	#define DEFAULT_METADATA_CACHE_SIZE 4096
	200	#define DEFAULT_METADATA_SWITCH_TIMER _DEFAULT_CHANNEL_SWITCH_TIMER
	201	#define DEFAULT_METADATA_READ_TIMER 0
	202	#define DEFAULT_METADATA_OUTPUT _DEFAULT_CHANNEL_OUTPUT
	203
	204	/* Kernel has different defaults */
	205
	206	/* DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE must always be a power of 2 */
	207	#define DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE 262144 /* bytes */
	208	/*
	209	* DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM must always be a power of 2.
	210	* Update help manually if override.
	211	*/
	212	#define DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM _DEFAULT_CHANNEL_SUBBUF_NUM
	213	/* See lttng-kernel.h enum lttng_kernel_output for channel output */
	214	#define DEFAULT_KERNEL_CHANNEL_OUTPUT LTTNG_EVENT_SPLICE
	215	#define DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER _DEFAULT_CHANNEL_SWITCH_TIMER
	216	#define DEFAULT_KERNEL_CHANNEL_READ_TIMER _DEFAULT_CHANNEL_READ_TIMER
	217	#define DEFAULT_KERNEL_CHANNEL_LIVE_TIMER _DEFAULT_CHANNEL_LIVE_TIMER
	218
	219	/* User space defaults */
	220
	221	/* Must be a power of 2 */
	222	#define DEFAULT_UST_PID_CHANNEL_SUBBUF_SIZE _DEFAULT_CHANNEL_SUBBUF_SIZE
	223	#define DEFAULT_UST_UID_CHANNEL_SUBBUF_SIZE 131072 /* bytes */
	224	/* Must be a power of 2. Update help manuall if override. */
	225	#define DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM _DEFAULT_CHANNEL_SUBBUF_NUM
	226	#define DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM _DEFAULT_CHANNEL_SUBBUF_NUM
	227	/* See lttng-ust.h enum lttng_ust_output */
	228	#define DEFAULT_UST_PID_CHANNEL_OUTPUT _DEFAULT_CHANNEL_OUTPUT
	229	#define DEFAULT_UST_UID_CHANNEL_OUTPUT _DEFAULT_CHANNEL_OUTPUT
	230	/* Timers in usec. */
	231	#define DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER _DEFAULT_CHANNEL_SWITCH_TIMER
	232	#define DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER _DEFAULT_CHANNEL_SWITCH_TIMER
	233	#define DEFAULT_UST_PID_CHANNEL_LIVE_TIMER _DEFAULT_CHANNEL_LIVE_TIMER
	234	#define DEFAULT_UST_UID_CHANNEL_LIVE_TIMER _DEFAULT_CHANNEL_LIVE_TIMER
	235
	236	#define DEFAULT_UST_PID_CHANNEL_READ_TIMER 0 /* usec */
	237	#define DEFAULT_UST_UID_CHANNEL_READ_TIMER 0 /* usec */
	238
	239	/*
	240	* Default timeout value for the sem_timedwait() call. Blocking forever is not
	241	* wanted so a timeout is used to control the data flow and not freeze the
	242	* session daemon.
	243	*/
	244	#define DEFAULT_SEM_WAIT_TIMEOUT 30 /* in seconds */
	245
	246	/* Default bind addresses for network services. */
	247	#define DEFAULT_NETWORK_CONTROL_BIND_ADDRESS "0.0.0.0"
	248	#define DEFAULT_NETWORK_DATA_BIND_ADDRESS "0.0.0.0"
	249	#define DEFAULT_NETWORK_VIEWER_BIND_ADDRESS "localhost"
	250	#define DEFAULT_AGENT_BIND_ADDRESS "localhost"
	251
	252	/* Default network ports for trace streaming support. */
	253	#define DEFAULT_NETWORK_CONTROL_PORT 5342
	254	#define DEFAULT_NETWORK_DATA_PORT 5343
	255	#define DEFAULT_NETWORK_VIEWER_PORT 5344
	256
	257	/* Agent registration TCP port. */
	258	#define DEFAULT_AGENT_TCP_PORT 5345
	259
	260	/*
	261	* If a thread stalls for this amount of time, it will be considered bogus (bad
	262	* health).
	263	*/
	264	#define DEFAULT_HEALTH_CHECK_DELTA_S 20
	265	#define DEFAULT_HEALTH_CHECK_DELTA_NS 0
	266
	267	/*
	268	* Wait period before retrying the lttng_data_pending command in the lttng
	269	* stop command of liblttng-ctl.
	270	*/
	271	#define DEFAULT_DATA_AVAILABILITY_WAIT_TIME 200000 /* usec */
	272
	273	/*
	274	* Wait period before retrying the lttng_consumer_flushed_cache when
	275	* the consumer receives metadata.
	276	*/
	277	#define DEFAULT_METADATA_AVAILABILITY_WAIT_TIME 200000 /* usec */
	278
	279	/*
	280	* The usual value for the maximum TCP SYN retries time and TCP FIN timeout is
	281	* 180 and 60 seconds on most Linux system and the default value since kernel
	282	* 2.2 thus using the highest value. See tcp(7) for more details.
	283	*/
	284	#define DEFAULT_INET_TCP_TIMEOUT 180 /* sec */
	285
	286	/*
	287	* Default receiving and sending timeout for an application socket.
	288	*/
	289	#define DEFAULT_APP_SOCKET_RW_TIMEOUT 5 /* sec */
	290	#define DEFAULT_APP_SOCKET_TIMEOUT_ENV "LTTNG_APP_SOCKET_TIMEOUT"
	291
	292	#define DEFAULT_UST_STREAM_FD_NUM 2 /* Number of fd per UST stream. */
	293
	294	#define DEFAULT_SNAPSHOT_NAME "snapshot"
	295	#define DEFAULT_SNAPSHOT_MAX_SIZE 0 /* Unlimited. */
	296
	297	/* Suffix of an index file. */
	298	#define DEFAULT_INDEX_FILE_SUFFIX ".idx"
	299	#define DEFAULT_INDEX_DIR "index"
	300
	301	/* Default lttng command live timer value in usec. */
	302	#define DEFAULT_LTTNG_LIVE_TIMER 1000000
	303
	304	extern size_t default_channel_subbuf_size;
	305	extern size_t default_metadata_subbuf_size;
	306	extern size_t default_ust_pid_channel_subbuf_size;
	307	extern size_t default_ust_uid_channel_subbuf_size;
	308	extern size_t default_kernel_channel_subbuf_size;
	309
	310	/*
	311	* Returns the default subbuf size.
	312	*
	313	* This function depends on a value that is set at constructor time, so it is
	314	* unsafe to call it from another constructor.
	315	*/
	316	static inline
	317	size_t default_get_channel_subbuf_size(void)
	318	{
	319	return default_channel_subbuf_size;
	320	}
	321
	322	/*
	323	* Returns the default metadata subbuf size.
	324	*
	325	* This function depends on a value that is set at constructor time, so it is
	326	* unsafe to call it from another constructor.
	327	*/
	328	static inline
	329	size_t default_get_metadata_subbuf_size(void)
	330	{
	331	return default_metadata_subbuf_size;
	332	}
	333
	334	/*
	335	* Returns the default subbuf size for the kernel domain.
	336	*
	337	* This function depends on a value that is set at constructor time, so it is
	338	* unsafe to call it from another constructor.
	339	*/
	340	static inline
	341	size_t default_get_kernel_channel_subbuf_size(void)
	342	{
	343	return default_kernel_channel_subbuf_size;
	344	}
	345
	346	/*
	347	* Returns the default subbuf size for the UST domain per PID.
	348	*
	349	* This function depends on a value that is set at constructor time, so it is
	350	* unsafe to call it from another constructor.
	351	*/
	352	static inline
	353	size_t default_get_ust_pid_channel_subbuf_size(void)
	354	{
	355	return default_ust_pid_channel_subbuf_size;
	356	}
	357
	358	/*
	359	* Returns the default subbuf size for the UST domain per UID.
	360	*
	361	* This function depends on a value that is set at constructor time, so it is
	362	* unsafe to call it from another constructor.
	363	*/
	364	static inline
	365	size_t default_get_ust_uid_channel_subbuf_size(void)
	366	{
	367	return default_ust_uid_channel_subbuf_size;
	368	}
	369
	370	#endif /* _DEFAULTS_H */