[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"

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

#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"
#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 network ports for trace streaming support */
#define DEFAULT_NETWORK_CONTROL_PORT        5342
#define DEFAULT_NETWORK_DATA_PORT           5343
#define DEFAULT_NETWORK_VIEWER_PORT         5344

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

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
	92	/* Default unix socket path */
	93	#define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/client-lttng-sessiond"
	94	#define DEFAULT_HOME_CLIENT_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/client-lttng-sessiond"
	95	#define DEFAULT_GLOBAL_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/sessiond-health"
	96	#define DEFAULT_HOME_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/sessiond-health"
	97
	98	/* Default consumer health unix socket path */
	99	#define DEFAULT_GLOBAL_USTCONSUMER32_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/ustconsumerd32/health"
	100	#define DEFAULT_HOME_USTCONSUMER32_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/ustconsumerd32/health"
	101	#define DEFAULT_GLOBAL_USTCONSUMER64_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/ustconsumerd64/health"
	102	#define DEFAULT_HOME_USTCONSUMER64_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/ustconsumerd64/health"
	103	#define DEFAULT_GLOBAL_KCONSUMER_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/kconsumerd/health"
	104	#define DEFAULT_HOME_KCONSUMER_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/kconsumerd/health"
	105
	106	/* Default relay health unix socket path */
	107	#define DEFAULT_GLOBAL_RELAY_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/relayd/health-%d"
	108	#define DEFAULT_HOME_RELAY_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/relayd/health-%d"
	109
	110	#define DEFAULT_GLOBAL_APPS_UNIX_SOCK \
	111	DEFAULT_LTTNG_RUNDIR "/" LTTNG_UST_SOCK_FILENAME
	112	#define DEFAULT_HOME_APPS_UNIX_SOCK \
	113	DEFAULT_LTTNG_HOME_RUNDIR "/" LTTNG_UST_SOCK_FILENAME
	114	#define DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH \
	115	"/" LTTNG_UST_WAIT_FILENAME
	116	#define DEFAULT_HOME_APPS_WAIT_SHM_PATH \
	117	DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH "-%d"
	118
	119	/*
	120	* Value taken from the hard limit allowed by the kernel when using setrlimit
	121	* with RLIMIT_NOFILE on an Intel i7 CPU and Linux 3.0.3.
	122	*/
	123	#define DEFAULT_POLL_SIZE 65535
	124
	125	/*
	126	* Format is %s_%d respectively channel name and CPU number. Eigth bytes
	127	* are added here to add space for the CPU number. I guess 2^8 CPUs is more
	128	* than enough. We might end up with quantum computing in a cell phone when
	129	* reaching this limit.
	130	*/
	131	#define DEFAULT_STREAM_NAME_LEN LTTNG_SYMBOL_NAME_LEN + 8
	132
	133	/* Default channel attributes */
	134	#define DEFAULT_CHANNEL_NAME "channel0"
	135	#define DEFAULT_CHANNEL_OVERWRITE 0
	136	#define DEFAULT_CHANNEL_TRACEFILE_SIZE 0
	137	#define DEFAULT_CHANNEL_TRACEFILE_COUNT 0
	138
	139	/* Must always be a power of 2 */
	140	#define _DEFAULT_CHANNEL_SUBBUF_SIZE 4096 /* bytes */
	141	/* Must always be a power of 2 */
	142	#define _DEFAULT_CHANNEL_SUBBUF_NUM 4
	143	#define _DEFAULT_CHANNEL_SWITCH_TIMER 0 /* usec */
	144	#define _DEFAULT_CHANNEL_LIVE_TIMER 0 /* usec */
	145	#define _DEFAULT_CHANNEL_READ_TIMER 200000 /* usec */
	146	#define _DEFAULT_CHANNEL_OUTPUT LTTNG_EVENT_MMAP
	147
	148	/* Metadata channel defaults. */
	149	#define DEFAULT_METADATA_SUBBUF_SIZE 4096
	150	#define DEFAULT_METADATA_SUBBUF_NUM 2
	151	#define DEFAULT_METADATA_CACHE_SIZE 4096
	152	#define DEFAULT_METADATA_SWITCH_TIMER _DEFAULT_CHANNEL_SWITCH_TIMER
	153	#define DEFAULT_METADATA_READ_TIMER 0
	154	#define DEFAULT_METADATA_OUTPUT _DEFAULT_CHANNEL_OUTPUT
	155
	156	/* Kernel has different defaults */
	157
	158	/* DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE must always be a power of 2 */
	159	#define DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE 262144 /* bytes */
	160	/*
	161	* DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM must always be a power of 2.
	162	* Update help manually if override.
	163	*/
	164	#define DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM _DEFAULT_CHANNEL_SUBBUF_NUM
	165	/* See lttng-kernel.h enum lttng_kernel_output for channel output */
	166	#define DEFAULT_KERNEL_CHANNEL_OUTPUT LTTNG_EVENT_SPLICE
	167	#define DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER _DEFAULT_CHANNEL_SWITCH_TIMER
	168	#define DEFAULT_KERNEL_CHANNEL_READ_TIMER _DEFAULT_CHANNEL_READ_TIMER
	169	#define DEFAULT_KERNEL_CHANNEL_LIVE_TIMER _DEFAULT_CHANNEL_LIVE_TIMER
	170
	171	/* User space defaults */
	172
	173	/* Must be a power of 2 */
	174	#define DEFAULT_UST_PID_CHANNEL_SUBBUF_SIZE _DEFAULT_CHANNEL_SUBBUF_SIZE
	175	#define DEFAULT_UST_UID_CHANNEL_SUBBUF_SIZE 131072 /* bytes */
	176	/* Must be a power of 2. Update help manuall if override. */
	177	#define DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM _DEFAULT_CHANNEL_SUBBUF_NUM
	178	#define DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM _DEFAULT_CHANNEL_SUBBUF_NUM
	179	/* See lttng-ust.h enum lttng_ust_output */
	180	#define DEFAULT_UST_PID_CHANNEL_OUTPUT _DEFAULT_CHANNEL_OUTPUT
	181	#define DEFAULT_UST_UID_CHANNEL_OUTPUT _DEFAULT_CHANNEL_OUTPUT
	182	/* Timers in usec. */
	183	#define DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER _DEFAULT_CHANNEL_SWITCH_TIMER
	184	#define DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER _DEFAULT_CHANNEL_SWITCH_TIMER
	185	#define DEFAULT_UST_PID_CHANNEL_LIVE_TIMER _DEFAULT_CHANNEL_LIVE_TIMER
	186	#define DEFAULT_UST_UID_CHANNEL_LIVE_TIMER _DEFAULT_CHANNEL_LIVE_TIMER
	187
	188	#define DEFAULT_UST_PID_CHANNEL_READ_TIMER 0 /* usec */
	189	#define DEFAULT_UST_UID_CHANNEL_READ_TIMER 0 /* usec */
	190
	191	/*
	192	* Default timeout value for the sem_timedwait() call. Blocking forever is not
	193	* wanted so a timeout is used to control the data flow and not freeze the
	194	* session daemon.
	195	*/
	196	#define DEFAULT_SEM_WAIT_TIMEOUT 30 /* in seconds */
	197
	198	/* Default network ports for trace streaming support */
	199	#define DEFAULT_NETWORK_CONTROL_PORT 5342
	200	#define DEFAULT_NETWORK_DATA_PORT 5343
	201	#define DEFAULT_NETWORK_VIEWER_PORT 5344
	202
	203	/*
	204	* If a thread stalls for this amount of time, it will be considered bogus (bad
	205	* health).
	206	*/
	207	#define DEFAULT_HEALTH_CHECK_DELTA_S 20
	208	#define DEFAULT_HEALTH_CHECK_DELTA_NS 0
	209
	210	/*
	211	* Wait period before retrying the lttng_data_pending command in the lttng
	212	* stop command of liblttng-ctl.
	213	*/
	214	#define DEFAULT_DATA_AVAILABILITY_WAIT_TIME 200000 /* usec */
	215
	216	/*
	217	* Wait period before retrying the lttng_consumer_flushed_cache when
	218	* the consumer receives metadata.
	219	*/
	220	#define DEFAULT_METADATA_AVAILABILITY_WAIT_TIME 200000 /* usec */
	221
	222	/*
	223	* The usual value for the maximum TCP SYN retries time and TCP FIN timeout is
	224	* 180 and 60 seconds on most Linux system and the default value since kernel
	225	* 2.2 thus using the highest value. See tcp(7) for more details.
	226	*/
	227	#define DEFAULT_INET_TCP_TIMEOUT 180 /* sec */
	228
	229	/*
	230	* Default receiving and sending timeout for an application socket.
	231	*/
	232	#define DEFAULT_APP_SOCKET_RW_TIMEOUT 5 /* sec */
	233	#define DEFAULT_APP_SOCKET_TIMEOUT_ENV "LTTNG_APP_SOCKET_TIMEOUT"
	234
	235	#define DEFAULT_UST_STREAM_FD_NUM 2 /* Number of fd per UST stream. */
	236
	237	#define DEFAULT_SNAPSHOT_NAME "snapshot"
	238	#define DEFAULT_SNAPSHOT_MAX_SIZE 0 /* Unlimited. */
	239
	240	/* Suffix of an index file. */
	241	#define DEFAULT_INDEX_FILE_SUFFIX ".idx"
	242	#define DEFAULT_INDEX_DIR "index"
	243
	244	extern size_t default_channel_subbuf_size;
	245	extern size_t default_metadata_subbuf_size;
	246	extern size_t default_ust_pid_channel_subbuf_size;
	247	extern size_t default_ust_uid_channel_subbuf_size;
	248	extern size_t default_kernel_channel_subbuf_size;
	249
	250	/*
	251	* Returns the default subbuf size.
	252	*
	253	* This function depends on a value that is set at constructor time, so it is
	254	* unsafe to call it from another constructor.
	255	*/
	256	static inline
	257	size_t default_get_channel_subbuf_size(void)
	258	{
	259	return default_channel_subbuf_size;
	260	}
	261
	262	/*
	263	* Returns the default metadata subbuf size.
	264	*
	265	* This function depends on a value that is set at constructor time, so it is
	266	* unsafe to call it from another constructor.
	267	*/
	268	static inline
	269	size_t default_get_metadata_subbuf_size(void)
	270	{
	271	return default_metadata_subbuf_size;
	272	}
	273
	274	/*
	275	* Returns the default subbuf size for the kernel domain.
	276	*
	277	* This function depends on a value that is set at constructor time, so it is
	278	* unsafe to call it from another constructor.
	279	*/
	280	static inline
	281	size_t default_get_kernel_channel_subbuf_size(void)
	282	{
	283	return default_kernel_channel_subbuf_size;
	284	}
	285
	286	/*
	287	* Returns the default subbuf size for the UST domain per PID.
	288	*
	289	* This function depends on a value that is set at constructor time, so it is
	290	* unsafe to call it from another constructor.
	291	*/
	292	static inline
	293	size_t default_get_ust_pid_channel_subbuf_size(void)
	294	{
	295	return default_ust_pid_channel_subbuf_size;
	296	}
	297
	298	/*
	299	* Returns the default subbuf size for the UST domain per UID.
	300	*
	301	* This function depends on a value that is set at constructor time, so it is
	302	* unsafe to call it from another constructor.
	303	*/
	304	static inline
	305	size_t default_get_ust_uid_channel_subbuf_size(void)
	306	{
	307	return default_ust_uid_channel_subbuf_size;
	308	}
	309
	310	#endif /* _DEFAULTS_H */