2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 * 2015 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
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.
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
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.
24 #include <common/macros.h>
26 /* Default unix group name for tracing. */
27 #define DEFAULT_TRACING_GROUP "tracing"
30 * This value is defined in the CTF specification (see
31 * git://git.efficios.com/ctf.git in the file
32 * common-trace-format-specification.txt.
34 #define DEFAULT_METADATA_NAME "metadata"
36 /* Environment variable to set session daemon binary path. */
37 #define DEFAULT_SESSIOND_PATH_ENV "LTTNG_SESSIOND_PATH"
39 /* Environment variable to set man pager binary path. */
40 #define DEFAULT_MAN_BIN_PATH_ENV "LTTNG_MAN_BIN_PATH"
42 /* Default man pager binary path. */
43 #define DEFAULT_MAN_BIN_PATH "/usr/bin/man"
45 /* Default trace output directory name */
46 #define DEFAULT_TRACE_DIR_NAME "lttng-traces"
48 /* Default size of a hash table */
49 #define DEFAULT_HT_SIZE 4
51 /* Default session daemon paths */
52 #define DEFAULT_HOME_DIR "/tmp"
53 #define DEFAULT_UST_SOCK_DIR DEFAULT_HOME_DIR "/ust-app-socks"
54 #define DEFAULT_GLOBAL_APPS_PIPE DEFAULT_UST_SOCK_DIR "/global"
55 #define DEFAULT_TRACE_OUTPUT DEFAULT_HOME_DIR "/lttng"
57 /* Default directory where the trace are written in per domain */
58 #define DEFAULT_KERNEL_TRACE_DIR "/kernel"
59 #define DEFAULT_UST_TRACE_DIR "/ust"
61 /* Subpath for per PID or UID sessions. */
62 #define DEFAULT_UST_TRACE_PID_PATH "/pid"
63 #define DEFAULT_UST_TRACE_UID_PATH "/uid/%d/%u-bit"
66 * Default session name for the lttng command line. This default value will
67 * get the date and time appended (%Y%m%d-%H%M%S) to it.
69 #define DEFAULT_SESSION_NAME "auto"
71 /* Default consumer paths */
72 #define DEFAULT_CONSUMERD_RUNDIR "%s"
74 /* Kernel consumer path */
75 #define DEFAULT_KCONSUMERD_PATH DEFAULT_CONSUMERD_RUNDIR "/kconsumerd"
76 #define DEFAULT_KCONSUMERD_CMD_SOCK_PATH DEFAULT_KCONSUMERD_PATH "/command"
77 #define DEFAULT_KCONSUMERD_ERR_SOCK_PATH DEFAULT_KCONSUMERD_PATH "/error"
79 /* UST 64-bit consumer path */
80 #define DEFAULT_USTCONSUMERD64_PATH DEFAULT_CONSUMERD_RUNDIR "/ustconsumerd64"
81 #define DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH DEFAULT_USTCONSUMERD64_PATH "/command"
82 #define DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH DEFAULT_USTCONSUMERD64_PATH "/error"
84 /* UST 32-bit consumer path */
85 #define DEFAULT_USTCONSUMERD32_PATH DEFAULT_CONSUMERD_RUNDIR "/ustconsumerd32"
86 #define DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH DEFAULT_USTCONSUMERD32_PATH "/command"
87 #define DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH DEFAULT_USTCONSUMERD32_PATH "/error"
90 #define DEFAULT_RELAYD_RUNDIR "%s"
91 #define DEFAULT_RELAYD_PATH DEFAULT_RELAYD_RUNDIR "/relayd"
93 #define DEFAULT_RELAYD_MIN_FD_POOL_SIZE 100
95 * The file descriptor pool size needs a reserve buffer to accomodate the
96 * indirect use of short-lived file descriptors. For instance, glibc will
97 * create a socket (and thus, use an fd) during calls to gethostname() or
98 * when querying the user's group. Other calls also probably make use of
101 * The theoritical maximal reserve corresponds to the number of threads as,
102 * in the worst case, they could all be making such calls.
104 * This value must be less than DEFAULT_RELAYD_MIN_FD_POOL_SIZE.
106 #define DEFAULT_RELAYD_FD_POOL_SIZE_RESERVE 10
108 /* Default lttng run directory */
109 #define DEFAULT_LTTNG_HOME_ENV_VAR "LTTNG_HOME"
110 #define DEFAULT_LTTNG_FALLBACK_HOME_ENV_VAR "HOME"
111 #define DEFAULT_LTTNG_RUNDIR CONFIG_LTTNG_SYSTEM_RUNDIR
112 #define DEFAULT_LTTNG_HOME_RUNDIR "%s/.lttng"
113 #define DEFAULT_LTTNG_SESSIOND_PIDFILE "lttng-sessiond.pid"
114 #define DEFAULT_LTTNG_SESSIOND_AGENTPORT_FILE "agent.port"
115 #define DEFAULT_LTTNG_SESSIOND_LOCKFILE "lttng-sessiond.lck"
117 /* Default probes list */
118 #define DEFAULT_LTTNG_KMOD_PROBES "LTTNG_KMOD_PROBES"
120 /* Default extra probes list */
121 #define DEFAULT_LTTNG_EXTRA_KMOD_PROBES "LTTNG_EXTRA_KMOD_PROBES"
123 /* Default unix socket path */
124 #define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/client-lttng-sessiond"
125 #define DEFAULT_HOME_CLIENT_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/client-lttng-sessiond"
126 #define DEFAULT_GLOBAL_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/sessiond-health"
127 #define DEFAULT_HOME_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/sessiond-health"
129 /* Default consumer health unix socket path */
130 #define DEFAULT_GLOBAL_USTCONSUMER32_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/ustconsumerd32/health"
131 #define DEFAULT_HOME_USTCONSUMER32_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/ustconsumerd32/health"
132 #define DEFAULT_GLOBAL_USTCONSUMER64_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/ustconsumerd64/health"
133 #define DEFAULT_HOME_USTCONSUMER64_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/ustconsumerd64/health"
134 #define DEFAULT_GLOBAL_KCONSUMER_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/kconsumerd/health"
135 #define DEFAULT_HOME_KCONSUMER_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/kconsumerd/health"
137 /* Default relay health unix socket path */
138 #define DEFAULT_GLOBAL_RELAY_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/relayd/health-%d"
139 #define DEFAULT_HOME_RELAY_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/relayd/health-%d"
141 /* Default daemon configuration file path */
142 #define DEFAULT_SYSTEM_CONFIGPATH CONFIG_LTTNG_SYSTEM_CONFIGDIR \
145 #define DEFAULT_DAEMON_CONFIG_FILE "lttng.conf"
146 #define DEFAULT_DAEMON_HOME_CONFIGPATH DEFAULT_LTTNG_HOME_RUNDIR "/" \
147 DEFAULT_DAEMON_CONFIG_FILE
148 #define DEFAULT_DAEMON_SYSTEM_CONFIGPATH DEFAULT_SYSTEM_CONFIGPATH "/" \
149 DEFAULT_DAEMON_CONFIG_FILE
151 /* Default session configuration file path */
152 #define DEFAULT_SESSION_PATH "sessions"
153 /* Auto load session in that directory. */
154 #define DEFAULT_SESSION_CONFIG_AUTOLOAD "auto"
155 #define DEFAULT_SESSION_HOME_CONFIGPATH DEFAULT_LTTNG_HOME_RUNDIR "/" \
157 #define DEFAULT_SESSION_SYSTEM_CONFIGPATH DEFAULT_SYSTEM_CONFIGPATH "/" \
159 #define DEFAULT_SESSION_CONFIG_FILE_EXTENSION ".lttng"
160 #define DEFAULT_SESSION_CONFIG_XSD_FILENAME "session.xsd"
161 #define DEFAULT_SESSION_CONFIG_XSD_PATH CONFIG_LTTNG_SYSTEM_DATADIR "/xml/lttng/"
162 #define DEFAULT_SESSION_CONFIG_XSD_PATH_ENV "LTTNG_SESSION_CONFIG_XSD_PATH"
164 #define DEFAULT_GLOBAL_APPS_UNIX_SOCK \
165 DEFAULT_LTTNG_RUNDIR "/" LTTNG_UST_SOCK_FILENAME
166 #define DEFAULT_HOME_APPS_UNIX_SOCK \
167 DEFAULT_LTTNG_HOME_RUNDIR "/" LTTNG_UST_SOCK_FILENAME
168 #define DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH \
169 "/" LTTNG_UST_WAIT_FILENAME
170 #define DEFAULT_HOME_APPS_WAIT_SHM_PATH \
171 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH "-%d"
174 * Value taken from the hard limit allowed by the kernel when using setrlimit
175 * with RLIMIT_NOFILE on an Intel i7 CPU and Linux 3.0.3.
177 #define DEFAULT_POLL_SIZE 65535
180 * Format is %s_%d respectively channel name and CPU number. Eigth bytes
181 * are added here to add space for the CPU number. I guess 2^8 CPUs is more
182 * than enough. We might end up with quantum computing in a cell phone when
183 * reaching this limit.
185 #define DEFAULT_STREAM_NAME_LEN LTTNG_SYMBOL_NAME_LEN + 8
187 /* Default channel attributes */
188 #define DEFAULT_CHANNEL_NAME "channel0"
189 /* Default JUL domain channel name. */
190 #define DEFAULT_JUL_CHANNEL_NAME "lttng_jul_channel"
191 /* Default JUL tracepoint name. This is a wildcard for the JUL domain. */
192 #define DEFAULT_JUL_EVENT_COMPONENT "lttng_jul"
193 #define DEFAULT_JUL_EVENT_NAME DEFAULT_JUL_EVENT_COMPONENT ":*"
195 /* Default log4j domain channel name. */
196 #define DEFAULT_LOG4J_CHANNEL_NAME "lttng_log4j_channel"
197 /* Default log4j tracepoint name. This is a wildcard for the log4j domain. */
198 #define DEFAULT_LOG4J_EVENT_COMPONENT "lttng_log4j"
199 #define DEFAULT_LOG4J_EVENT_NAME DEFAULT_LOG4J_EVENT_COMPONENT ":*"
201 /* Default Python domain channel name. */
202 #define DEFAULT_PYTHON_CHANNEL_NAME "lttng_python_channel"
203 /* Default Python tracepoint name. This is a wildcard for the python domain. */
204 #define DEFAULT_PYTHON_EVENT_COMPONENT "lttng_python"
205 #define DEFAULT_PYTHON_EVENT_NAME DEFAULT_PYTHON_EVENT_COMPONENT ":*"
207 #define DEFAULT_CHANNEL_OVERWRITE -1
208 #define DEFAULT_CHANNEL_TRACEFILE_SIZE CONFIG_DEFAULT_CHANNEL_TRACEFILE_SIZE
209 #define DEFAULT_CHANNEL_TRACEFILE_COUNT CONFIG_DEFAULT_CHANNEL_TRACEFILE_COUNT
211 #define _DEFAULT_CHANNEL_SUBBUF_SIZE CONFIG_DEFAULT_CHANNEL_SUBBUF_SIZE
212 #define _DEFAULT_CHANNEL_OUTPUT LTTNG_EVENT_MMAP
214 /* Metadata channel defaults. */
215 #define DEFAULT_METADATA_SUBBUF_SIZE CONFIG_DEFAULT_METADATA_SUBBUF_SIZE
216 #define DEFAULT_METADATA_SUBBUF_NUM CONFIG_DEFAULT_METADATA_SUBBUF_NUM
217 #define DEFAULT_METADATA_CACHE_SIZE CONFIG_DEFAULT_METADATA_CACHE_SIZE
218 #define DEFAULT_METADATA_SWITCH_TIMER CONFIG_DEFAULT_METADATA_SWITCH_TIMER
219 #define DEFAULT_METADATA_READ_TIMER CONFIG_DEFAULT_METADATA_READ_TIMER
220 #define DEFAULT_METADATA_OUTPUT _DEFAULT_CHANNEL_OUTPUT
222 /* Kernel has different defaults */
224 /* DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE must always be a power of 2 */
225 #define DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE CONFIG_DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE
227 * DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM must always be a power of 2.
228 * Update help manually if override.
230 #define DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM CONFIG_DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM
231 /* See lttng-kernel.h enum lttng_kernel_output for channel output */
232 #define DEFAULT_KERNEL_CHANNEL_OUTPUT LTTNG_EVENT_SPLICE
233 #define DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER CONFIG_DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER
234 #define DEFAULT_KERNEL_CHANNEL_READ_TIMER CONFIG_DEFAULT_KERNEL_CHANNEL_READ_TIMER
235 #define DEFAULT_KERNEL_CHANNEL_LIVE_TIMER CONFIG_DEFAULT_KERNEL_CHANNEL_LIVE_TIMER
237 /* User space defaults */
239 /* Must be a power of 2 */
240 #define DEFAULT_UST_PID_CHANNEL_SUBBUF_SIZE CONFIG_DEFAULT_UST_PID_CHANNEL_SUBBUF_SIZE
241 #define DEFAULT_UST_UID_CHANNEL_SUBBUF_SIZE CONFIG_DEFAULT_UST_UID_CHANNEL_SUBBUF_SIZE
242 /* Must be a power of 2. Update help manuall if override. */
243 #define DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM CONFIG_DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM
244 #define DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM CONFIG_DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM
245 /* See lttng-ust.h enum lttng_ust_output */
246 #define DEFAULT_UST_PID_CHANNEL_OUTPUT _DEFAULT_CHANNEL_OUTPUT
247 #define DEFAULT_UST_UID_CHANNEL_OUTPUT _DEFAULT_CHANNEL_OUTPUT
248 /* Timers in usec. */
249 #define DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER CONFIG_DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER
250 #define DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER CONFIG_DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER
251 #define DEFAULT_UST_PID_CHANNEL_LIVE_TIMER CONFIG_DEFAULT_UST_PID_CHANNEL_LIVE_TIMER
252 #define DEFAULT_UST_UID_CHANNEL_LIVE_TIMER CONFIG_DEFAULT_UST_UID_CHANNEL_LIVE_TIMER
254 #define DEFAULT_UST_PID_CHANNEL_READ_TIMER CONFIG_DEFAULT_UST_PID_CHANNEL_READ_TIMER
255 #define DEFAULT_UST_UID_CHANNEL_READ_TIMER CONFIG_DEFAULT_UST_UID_CHANNEL_READ_TIMER
258 * Default timeout value for the sem_timedwait() call. Blocking forever is not
259 * wanted so a timeout is used to control the data flow and not freeze the
262 #define DEFAULT_SEM_WAIT_TIMEOUT 30 /* in seconds */
264 /* Default bind addresses for network services. */
265 #define DEFAULT_NETWORK_CONTROL_BIND_ADDRESS CONFIG_DEFAULT_NETWORK_CONTROL_BIND_ADDRESS
266 #define DEFAULT_NETWORK_DATA_BIND_ADDRESS CONFIG_DEFAULT_NETWORK_DATA_BIND_ADDRESS
267 #define DEFAULT_NETWORK_VIEWER_BIND_ADDRESS CONFIG_DEFAULT_NETWORK_VIEWER_BIND_ADDRESS
268 #define DEFAULT_AGENT_BIND_ADDRESS CONFIG_DEFAULT_AGENT_BIND_ADDRESS
270 /* Default network ports for trace streaming support. */
271 #define DEFAULT_NETWORK_CONTROL_PORT CONFIG_DEFAULT_NETWORK_CONTROL_PORT
272 #define DEFAULT_NETWORK_DATA_PORT CONFIG_DEFAULT_NETWORK_DATA_PORT
273 #define DEFAULT_NETWORK_VIEWER_PORT CONFIG_DEFAULT_NETWORK_VIEWER_PORT
275 /* Agent registration TCP port. */
276 #define DEFAULT_AGENT_TCP_PORT CONFIG_DEFAULT_AGENT_TCP_PORT
279 * If a thread stalls for this amount of time, it will be considered bogus (bad
282 #define DEFAULT_HEALTH_CHECK_DELTA_S 20
283 #define DEFAULT_HEALTH_CHECK_DELTA_NS 0
286 * Wait period before retrying the lttng_data_pending command in the lttng
287 * stop command of liblttng-ctl.
289 #define DEFAULT_DATA_AVAILABILITY_WAIT_TIME 200000 /* usec */
292 * Wait period before retrying the lttng_consumer_flushed_cache when
293 * the consumer receives metadata.
295 #define DEFAULT_METADATA_AVAILABILITY_WAIT_TIME 200000 /* usec */
298 * The usual value for the maximum TCP SYN retries time and TCP FIN timeout is
299 * 180 and 60 seconds on most Linux system and the default value since kernel
300 * 2.2 thus using the highest value. See tcp(7) for more details.
302 #define DEFAULT_INET_TCP_TIMEOUT 180 /* sec */
304 /* Maximum payload size for a control connection */
306 #define DEFAULT_NETWORK_RELAYD_CTRL_MAX_PAYLOAD_SIZE 134217728
309 * Default receiving and sending timeout for an application socket.
311 #define DEFAULT_APP_SOCKET_RW_TIMEOUT CONFIG_DEFAULT_APP_SOCKET_RW_TIMEOUT
312 #define DEFAULT_APP_SOCKET_TIMEOUT_ENV "LTTNG_APP_SOCKET_TIMEOUT"
314 #define DEFAULT_UST_STREAM_FD_NUM 2 /* Number of fd per UST stream. */
316 #define DEFAULT_SNAPSHOT_NAME "snapshot"
317 #define DEFAULT_SNAPSHOT_MAX_SIZE 0 /* Unlimited. */
319 /* Suffix of an index file. */
320 #define DEFAULT_INDEX_FILE_SUFFIX ".idx"
321 #define DEFAULT_INDEX_DIR "index"
323 /* Default lttng command live timer value in usec. */
324 #define DEFAULT_LTTNG_LIVE_TIMER CONFIG_DEFAULT_LTTNG_LIVE_TIMER
326 /* Default runas worker name */
327 #define DEFAULT_RUN_AS_WORKER_NAME "lttng-runas"
329 /* Default LTTng MI XML namespace. */
330 #define DEFAULT_LTTNG_MI_NAMESPACE "https://lttng.org/xml/ns/lttng-mi"
332 /* Default thread stack size; the default mandated by pthread_create(3) */
333 #define DEFAULT_LTTNG_THREAD_STACK_SIZE 2097152
335 #define DEFAULT_LTTNG_RELAYD_TCP_KEEP_ALIVE_ENV "LTTNG_RELAYD_TCP_KEEP_ALIVE"
336 #define DEFAULT_LTTNG_RELAYD_TCP_KEEP_ALIVE_IDLE_TIME_ENV "LTTNG_RELAYD_TCP_KEEP_ALIVE_IDLE_TIME"
337 #define DEFAULT_LTTNG_RELAYD_TCP_KEEP_ALIVE_MAX_PROBE_COUNT_ENV "LTTNG_RELAYD_TCP_KEEP_ALIVE_MAX_PROBE_COUNT"
338 #define DEFAULT_LTTNG_RELAYD_TCP_KEEP_ALIVE_PROBE_INTERVAL_ENV "LTTNG_RELAYD_TCP_KEEP_ALIVE_PROBE_INTERVAL"
339 #define DEFAULT_LTTNG_RELAYD_TCP_KEEP_ALIVE_ABORT_THRESHOLD_ENV "LTTNG_RELAYD_TCP_KEEP_ALIVE_ABORT_THRESHOLD"
341 #define DEFAULT_LTTNG_RELAYD_WORKING_DIRECTORY_ENV "LTTNG_RELAYD_WORKING_DIRECTORY"
344 * Returns the default subbuf size.
346 * This function depends on a value that is set at constructor time, so it is
347 * unsafe to call it from another constructor.
350 size_t default_get_channel_subbuf_size(void);
353 * Returns the default metadata subbuf size.
355 * This function depends on a value that is set at constructor time, so it is
356 * unsafe to call it from another constructor.
359 size_t default_get_metadata_subbuf_size(void);
362 * Returns the default subbuf size for the kernel domain.
364 * This function depends on a value that is set at constructor time, so it is
365 * unsafe to call it from another constructor.
368 size_t default_get_kernel_channel_subbuf_size(void);
371 * Returns the default subbuf size for the UST domain per PID.
373 * This function depends on a value that is set at constructor time, so it is
374 * unsafe to call it from another constructor.
377 size_t default_get_ust_pid_channel_subbuf_size(void);
380 * Returns the default subbuf size for the UST domain per UID.
382 * This function depends on a value that is set at constructor time, so it is
383 * unsafe to call it from another constructor.
386 size_t default_get_ust_uid_channel_subbuf_size(void);
389 * Get the default pthread_attr to use on thread creation.
391 * Some libc, such as musl, don't honor the limit set for the stack size and use
392 * their own empirically chosen static value. This function checks if the
393 * current stack size is smaller than the stack size limit and if so returns a
394 * pthread_attr_t pointer where the thread stack size is set to the soft stack
398 pthread_attr_t
*default_pthread_attr(void);
400 #endif /* _DEFAULTS_H */
This page took 0.040831 seconds and 5 git commands to generate.