X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=src%2Fcommon%2Fdefaults.h;h=37d222a784fd0b3564a35b3a845fb8fe88b956e2;hp=cb37ba556107b096b2ad821bb0a97466669bacc7;hb=5f702b607116a8303cb09fb091d8b9740c06baca;hpb=e7c82272448caa21916b68c9824e32aab5c4a81b diff --git a/src/common/defaults.h b/src/common/defaults.h index cb37ba556..37d222a78 100644 --- a/src/common/defaults.h +++ b/src/common/defaults.h @@ -1,6 +1,7 @@ /* * Copyright (C) 2011 - David Goulet * Mathieu Desnoyers + * 2015 - Jérémie Galarneau * * 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, @@ -19,7 +20,8 @@ #ifndef _DEFAULTS_H #define _DEFAULTS_H -#include +#include +#include /* Default unix group name for tracing. */ #define DEFAULT_TRACING_GROUP "tracing" @@ -34,6 +36,12 @@ /* 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" @@ -166,73 +174,70 @@ /* 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_NAME "lttng_jul:*" +#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_NAME "lttng_log4j:*" +#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_NAME "lttng_python:*" - -#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_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 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_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 262144 /* bytes */ +#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 _DEFAULT_CHANNEL_SUBBUF_NUM +#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 _DEFAULT_CHANNEL_SWITCH_TIMER -#define DEFAULT_KERNEL_CHANNEL_READ_TIMER _DEFAULT_CHANNEL_READ_TIMER -#define DEFAULT_KERNEL_CHANNEL_LIVE_TIMER _DEFAULT_CHANNEL_LIVE_TIMER +#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 _DEFAULT_CHANNEL_SUBBUF_SIZE -#define DEFAULT_UST_UID_CHANNEL_SUBBUF_SIZE 131072 /* bytes */ +#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 _DEFAULT_CHANNEL_SUBBUF_NUM -#define DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM _DEFAULT_CHANNEL_SUBBUF_NUM +#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 _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_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 0 /* usec */ -#define DEFAULT_UST_UID_CHANNEL_READ_TIMER 0 /* usec */ +#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 @@ -242,18 +247,18 @@ #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" +#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 5342 -#define DEFAULT_NETWORK_DATA_PORT 5343 -#define DEFAULT_NETWORK_VIEWER_PORT 5344 +#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 5345 +#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 @@ -284,7 +289,7 @@ /* * Default receiving and sending timeout for an application socket. */ -#define DEFAULT_APP_SOCKET_RW_TIMEOUT 5 /* sec */ +#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. */ @@ -297,13 +302,16 @@ #define DEFAULT_INDEX_DIR "index" /* Default lttng command live timer value in usec. */ -#define DEFAULT_LTTNG_LIVE_TIMER 1000000 +#define DEFAULT_LTTNG_LIVE_TIMER CONFIG_DEFAULT_LTTNG_LIVE_TIMER + +/* Default runas worker name */ +#define DEFAULT_RUN_AS_WORKER_NAME "lttng-runas" -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; +/* 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. @@ -311,11 +319,8 @@ extern size_t default_kernel_channel_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; -} +LTTNG_HIDDEN +size_t default_get_channel_subbuf_size(void); /* * Returns the default metadata subbuf size. @@ -323,11 +328,8 @@ size_t default_get_channel_subbuf_size(void) * 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; -} +LTTNG_HIDDEN +size_t default_get_metadata_subbuf_size(void); /* * Returns the default subbuf size for the kernel domain. @@ -335,11 +337,8 @@ size_t default_get_metadata_subbuf_size(void) * 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; -} +LTTNG_HIDDEN +size_t default_get_kernel_channel_subbuf_size(void); /* * Returns the default subbuf size for the UST domain per PID. @@ -347,11 +346,8 @@ size_t default_get_kernel_channel_subbuf_size(void) * 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; -} +LTTNG_HIDDEN +size_t default_get_ust_pid_channel_subbuf_size(void); /* * Returns the default subbuf size for the UST domain per UID. @@ -359,10 +355,19 @@ size_t default_get_ust_pid_channel_subbuf_size(void) * 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; -} +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 */