[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

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


/* Default lttng run directory */
#define DEFAULT_LTTNG_RUNDIR                    "/var/run/lttng"
#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 "/health.sock"
#define DEFAULT_HOME_HEALTH_UNIX_SOCK           DEFAULT_LTTNG_HOME_RUNDIR "/health.sock"

#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       /* usec */
/* DEFAULT_CHANNEL_SUBBUF_SIZE must always be a power of 2 */
#define DEFAULT_CHANNEL_SUBBUF_SIZE     4096    /* bytes */
/* DEFAULT_CHANNEL_SUBBUF_NUM must always be a power of 2 */
#define DEFAULT_CHANNEL_SUBBUF_NUM      4
#define DEFAULT_CHANNEL_SWITCH_TIMER    0       /* usec */
#define DEFAULT_CHANNEL_READ_TIMER      200000  /* usec */
#define DEFAULT_CHANNEL_OUTPUT          LTTNG_EVENT_MMAP

#define DEFAULT_METADATA_SUBBUF_SIZE    4096
#define DEFAULT_METADATA_SUBBUF_NUM     2

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

/* User space defaults */

/* Must be a power of 2 */
#define DEFAULT_UST_CHANNEL_SUBBUF_SIZE     4096    /* bytes */
/* Must be a power of 2. Update help manuall if override. */
#define DEFAULT_UST_CHANNEL_SUBBUF_NUM      DEFAULT_CHANNEL_SUBBUF_NUM
/* See lttng-ust.h enum lttng_ust_output */
#define DEFAULT_UST_CHANNEL_OUTPUT          LTTNG_EVENT_MMAP

#define DEFAULT_UST_CHANNEL_SWITCH_TIMER	\
		DEFAULT_CHANNEL_SWITCH_TIMER
#define DEFAULT_UST_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

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

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

extern size_t default_channel_subbuf_size;
extern size_t default_metadata_subbuf_size;
extern size_t default_ust_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.
 *
 * 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_channel_subbuf_size(void)
{
	return default_ust_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	/* Default unix group name for tracing. */
	23	#define DEFAULT_TRACING_GROUP "tracing"
	24
	25	/*
	26	* This value is defined in the CTF specification (see
	27	* git://git.efficios.com/ctf.git in the file
	28	* common-trace-format-specification.txt.
	29	*/
	30	#define DEFAULT_METADATA_NAME "metadata"
	31
	32	/* Environment variable to set session daemon binary path. */
	33	#define DEFAULT_SESSIOND_PATH_ENV "LTTNG_SESSIOND_PATH"
	34
	35	/* Default trace output directory name */
	36	#define DEFAULT_TRACE_DIR_NAME "lttng-traces"
	37
	38	/* Default size of a hash table */
	39	#define DEFAULT_HT_SIZE 4
	40
	41	/* Default session daemon paths */
	42	#define DEFAULT_HOME_DIR "/tmp"
	43	#define DEFAULT_UST_SOCK_DIR DEFAULT_HOME_DIR "/ust-app-socks"
	44	#define DEFAULT_GLOBAL_APPS_PIPE DEFAULT_UST_SOCK_DIR "/global"
	45	#define DEFAULT_TRACE_OUTPUT DEFAULT_HOME_DIR "/lttng"
	46
	47	/* Default directory where the trace are written in per domain */
	48	#define DEFAULT_KERNEL_TRACE_DIR "/kernel"
	49	#define DEFAULT_UST_TRACE_DIR "/ust"
	50
	51	/* Subpath for per PID or UID sessions. */
	52	#define DEFAULT_UST_TRACE_PID_PATH "/pid"
	53	#define DEFAULT_UST_TRACE_UID_PATH "/uid/%d/%u-bit"
	54
	55	/*
	56	* Default session name for the lttng command line. This default value will
	57	* get the date and time appended (%Y%m%d-%H%M%S) to it.
	58	*/
	59	#define DEFAULT_SESSION_NAME "auto"
	60
	61	/* Default consumer paths */
	62	#define DEFAULT_CONSUMERD_RUNDIR "%s"
	63
	64	/* Kernel consumer path */
	65	#define DEFAULT_KCONSUMERD_PATH DEFAULT_CONSUMERD_RUNDIR "/kconsumerd"
	66	#define DEFAULT_KCONSUMERD_CMD_SOCK_PATH DEFAULT_KCONSUMERD_PATH "/command"
	67	#define DEFAULT_KCONSUMERD_ERR_SOCK_PATH DEFAULT_KCONSUMERD_PATH "/error"
	68
	69	/* UST 64-bit consumer path */
	70	#define DEFAULT_USTCONSUMERD64_PATH DEFAULT_CONSUMERD_RUNDIR "/ustconsumerd64"
	71	#define DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH DEFAULT_USTCONSUMERD64_PATH "/command"
	72	#define DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH DEFAULT_USTCONSUMERD64_PATH "/error"
	73
	74	/* UST 32-bit consumer path */
	75	#define DEFAULT_USTCONSUMERD32_PATH DEFAULT_CONSUMERD_RUNDIR "/ustconsumerd32"
	76	#define DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH DEFAULT_USTCONSUMERD32_PATH "/command"
	77	#define DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH DEFAULT_USTCONSUMERD32_PATH "/error"
	78
	79
	80	/* Default lttng run directory */
	81	#define DEFAULT_LTTNG_RUNDIR "/var/run/lttng"
	82	#define DEFAULT_LTTNG_HOME_RUNDIR "%s/.lttng"
	83	#define DEFAULT_LTTNG_SESSIOND_PIDFILE "lttng-sessiond.pid"
	84
	85	/* Default unix socket path */
	86	#define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/client-lttng-sessiond"
	87	#define DEFAULT_HOME_CLIENT_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/client-lttng-sessiond"
	88	#define DEFAULT_GLOBAL_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/health.sock"
	89	#define DEFAULT_HOME_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/health.sock"
	90
	91	#define DEFAULT_GLOBAL_APPS_UNIX_SOCK \
	92	DEFAULT_LTTNG_RUNDIR "/" LTTNG_UST_SOCK_FILENAME
	93	#define DEFAULT_HOME_APPS_UNIX_SOCK \
	94	DEFAULT_LTTNG_HOME_RUNDIR "/" LTTNG_UST_SOCK_FILENAME
	95	#define DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH \
	96	"/" LTTNG_UST_WAIT_FILENAME
	97	#define DEFAULT_HOME_APPS_WAIT_SHM_PATH \
	98	DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH "-%d"
	99
	100	/*
	101	* Value taken from the hard limit allowed by the kernel when using setrlimit
	102	* with RLIMIT_NOFILE on an Intel i7 CPU and Linux 3.0.3.
	103	*/
	104	#define DEFAULT_POLL_SIZE 65535
	105
	106	/*
	107	* Format is %s_%d respectively channel name and CPU number. Eigth bytes
	108	* are added here to add space for the CPU number. I guess 2^8 CPUs is more
	109	* than enough. We might end up with quantum computing in a cell phone when
	110	* reaching this limit.
	111	*/
	112	#define DEFAULT_STREAM_NAME_LEN LTTNG_SYMBOL_NAME_LEN + 8
	113
	114	/* Default channel attributes */
	115	#define DEFAULT_CHANNEL_NAME "channel0"
	116	#define DEFAULT_CHANNEL_OVERWRITE 0 /* usec */
	117	/* DEFAULT_CHANNEL_SUBBUF_SIZE must always be a power of 2 */
	118	#define DEFAULT_CHANNEL_SUBBUF_SIZE 4096 /* bytes */
	119	/* DEFAULT_CHANNEL_SUBBUF_NUM must always be a power of 2 */
	120	#define DEFAULT_CHANNEL_SUBBUF_NUM 4
	121	#define DEFAULT_CHANNEL_SWITCH_TIMER 0 /* usec */
	122	#define DEFAULT_CHANNEL_READ_TIMER 200000 /* usec */
	123	#define DEFAULT_CHANNEL_OUTPUT LTTNG_EVENT_MMAP
	124
	125	#define DEFAULT_METADATA_SUBBUF_SIZE 4096
	126	#define DEFAULT_METADATA_SUBBUF_NUM 2
	127
	128	/* Kernel has different defaults */
	129
	130	/* DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE must always be a power of 2 */
	131	#define DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE 262144 /* bytes */
	132	/*
	133	* DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM must always be a power of 2.
	134	* Update help manually if override.
	135	*/
	136	#define DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM DEFAULT_CHANNEL_SUBBUF_NUM
	137	/* See lttng-kernel.h enum lttng_kernel_output for channel output */
	138	#define DEFAULT_KERNEL_CHANNEL_OUTPUT LTTNG_EVENT_SPLICE
	139
	140	#define DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER \
	141	DEFAULT_CHANNEL_SWITCH_TIMER
	142	#define DEFAULT_KERNEL_CHANNEL_READ_TIMER 200000 /* usec */
	143
	144	/* User space defaults */
	145
	146	/* Must be a power of 2 */
	147	#define DEFAULT_UST_CHANNEL_SUBBUF_SIZE 4096 /* bytes */
	148	/* Must be a power of 2. Update help manuall if override. */
	149	#define DEFAULT_UST_CHANNEL_SUBBUF_NUM DEFAULT_CHANNEL_SUBBUF_NUM
	150	/* See lttng-ust.h enum lttng_ust_output */
	151	#define DEFAULT_UST_CHANNEL_OUTPUT LTTNG_EVENT_MMAP
	152
	153	#define DEFAULT_UST_CHANNEL_SWITCH_TIMER \
	154	DEFAULT_CHANNEL_SWITCH_TIMER
	155	#define DEFAULT_UST_CHANNEL_READ_TIMER 0 /* usec */
	156
	157	/*
	158	* Default timeout value for the sem_timedwait() call. Blocking forever is not
	159	* wanted so a timeout is used to control the data flow and not freeze the
	160	* session daemon.
	161	*/
	162	#define DEFAULT_SEM_WAIT_TIMEOUT 30 /* in seconds */
	163
	164	/* Default network ports for trace streaming support */
	165	#define DEFAULT_NETWORK_CONTROL_PORT 5342
	166	#define DEFAULT_NETWORK_DATA_PORT 5343
	167
	168	/*
	169	* If a thread stalls for this amount of time, it will be considered bogus (bad
	170	* health).
	171	*/
	172	#define DEFAULT_HEALTH_CHECK_DELTA_S 20
	173	#define DEFAULT_HEALTH_CHECK_DELTA_NS 0
	174
	175	/*
	176	* Wait period before retrying the lttng_data_pending command in the lttng
	177	* stop command of liblttng-ctl.
	178	*/
	179	#define DEFAULT_DATA_AVAILABILITY_WAIT_TIME 200000 /* usec */
	180
	181	/*
	182	* Default receiving and sending timeout for an application socket.
	183	*/
	184	#define DEFAULT_APP_SOCKET_RW_TIMEOUT 5 /* sec */
	185	#define DEFAULT_APP_SOCKET_TIMEOUT_ENV "LTTNG_APP_SOCKET_TIMEOUT"
	186
	187	#define DEFAULT_UST_STREAM_FD_NUM 2 /* Number of fd per UST stream. */
	188
	189	extern size_t default_channel_subbuf_size;
	190	extern size_t default_metadata_subbuf_size;
	191	extern size_t default_ust_channel_subbuf_size;
	192	extern size_t default_kernel_channel_subbuf_size;
	193
	194
	195	/*
	196	* Returns the default subbuf size.
	197	*
	198	* This function depends on a value that is set at constructor time, so it is
	199	* unsafe to call it from another constructor.
	200	*/
	201	static inline
	202	size_t default_get_channel_subbuf_size(void)
	203	{
	204	return default_channel_subbuf_size;
	205	}
	206
	207	/*
	208	* Returns the default metadata subbuf size.
	209	*
	210	* This function depends on a value that is set at constructor time, so it is
	211	* unsafe to call it from another constructor.
	212	*/
	213	static inline
	214	size_t default_get_metadata_subbuf_size(void)
	215	{
	216	return default_metadata_subbuf_size;
	217	}
	218
	219	/*
	220	* Returns the default subbuf size for the kernel domain.
	221	*
	222	* This function depends on a value that is set at constructor time, so it is
	223	* unsafe to call it from another constructor.
	224	*/
	225	static inline
	226	size_t default_get_kernel_channel_subbuf_size(void)
	227	{
	228	return default_kernel_channel_subbuf_size;
	229	}
	230
	231	/*
	232	* Returns the default subbuf size for the UST domain.
	233	*
	234	* This function depends on a value that is set at constructor time, so it is
	235	* unsafe to call it from another constructor.
	236	*/
	237	static inline
	238	size_t default_get_ust_channel_subbuf_size(void)
	239	{
	240	return default_ust_channel_subbuf_size;
	241	}
	242
	243	#endif /* _DEFAULTS_H */