818332f54f146adc52e812a51c2677cb2649647c
[lttng-tools.git] / src / common / defaults.h
1 /*
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>
5 *
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.
9 *
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
13 * more details.
14 *
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.
18 */
19
20 #ifndef _DEFAULTS_H
21 #define _DEFAULTS_H
22
23 #include <pthread.h>
24 #include <src/common/macros.h>
25
26 /* Default unix group name for tracing. */
27 #define DEFAULT_TRACING_GROUP "tracing"
28
29 /*
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.
33 */
34 #define DEFAULT_METADATA_NAME "metadata"
35
36 /* Environment variable to set session daemon binary path. */
37 #define DEFAULT_SESSIOND_PATH_ENV "LTTNG_SESSIOND_PATH"
38
39 /* Environment variable to set man pager binary path. */
40 #define DEFAULT_MAN_BIN_PATH_ENV "LTTNG_MAN_BIN_PATH"
41
42 /* Default man pager binary path. */
43 #define DEFAULT_MAN_BIN_PATH "/usr/bin/man"
44
45 /* Default trace output directory name */
46 #define DEFAULT_TRACE_DIR_NAME "lttng-traces"
47
48 /* Default size of a hash table */
49 #define DEFAULT_HT_SIZE 4
50
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"
56
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"
60
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"
64
65 /*
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.
68 */
69 #define DEFAULT_SESSION_NAME "auto"
70
71 /* Default consumer paths */
72 #define DEFAULT_CONSUMERD_RUNDIR "%s"
73
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"
78
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"
83
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"
88
89 /* Relayd path */
90 #define DEFAULT_RELAYD_RUNDIR "%s"
91 #define DEFAULT_RELAYD_PATH DEFAULT_RELAYD_RUNDIR "/relayd"
92
93 /* Default lttng run directory */
94 #define DEFAULT_LTTNG_HOME_ENV_VAR "LTTNG_HOME"
95 #define DEFAULT_LTTNG_FALLBACK_HOME_ENV_VAR "HOME"
96 #define DEFAULT_LTTNG_RUNDIR CONFIG_LTTNG_SYSTEM_RUNDIR
97 #define DEFAULT_LTTNG_HOME_RUNDIR "%s/.lttng"
98 #define DEFAULT_LTTNG_SESSIOND_PIDFILE "lttng-sessiond.pid"
99 #define DEFAULT_LTTNG_SESSIOND_AGENTPORT_FILE "agent.port"
100 #define DEFAULT_LTTNG_SESSIOND_LOCKFILE "lttng-sessiond.lck"
101
102 /* Default probes list */
103 #define DEFAULT_LTTNG_KMOD_PROBES "LTTNG_KMOD_PROBES"
104
105 /* Default extra probes list */
106 #define DEFAULT_LTTNG_EXTRA_KMOD_PROBES "LTTNG_EXTRA_KMOD_PROBES"
107
108 /* Default unix socket path */
109 #define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/client-lttng-sessiond"
110 #define DEFAULT_HOME_CLIENT_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/client-lttng-sessiond"
111 #define DEFAULT_GLOBAL_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/sessiond-health"
112 #define DEFAULT_HOME_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/sessiond-health"
113 #define DEFAULT_GLOBAL_NOTIFICATION_CHANNEL_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/sessiond-notification"
114 #define DEFAULT_HOME_NOTIFICATION_CHANNEL_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/sessiond-notification"
115
116 /* Default consumer health unix socket path */
117 #define DEFAULT_GLOBAL_USTCONSUMER32_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/ustconsumerd32/health"
118 #define DEFAULT_HOME_USTCONSUMER32_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/ustconsumerd32/health"
119 #define DEFAULT_GLOBAL_USTCONSUMER64_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/ustconsumerd64/health"
120 #define DEFAULT_HOME_USTCONSUMER64_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/ustconsumerd64/health"
121 #define DEFAULT_GLOBAL_KCONSUMER_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/kconsumerd/health"
122 #define DEFAULT_HOME_KCONSUMER_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/kconsumerd/health"
123
124 /* Default relay health unix socket path */
125 #define DEFAULT_GLOBAL_RELAY_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/relayd/health-%d"
126 #define DEFAULT_HOME_RELAY_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/relayd/health-%d"
127
128 /* Default daemon configuration file path */
129 #define DEFAULT_SYSTEM_CONFIGPATH CONFIG_LTTNG_SYSTEM_CONFIGDIR \
130 "/lttng"
131
132 #define DEFAULT_DAEMON_CONFIG_FILE "lttng.conf"
133 #define DEFAULT_DAEMON_HOME_CONFIGPATH DEFAULT_LTTNG_HOME_RUNDIR "/" \
134 DEFAULT_DAEMON_CONFIG_FILE
135 #define DEFAULT_DAEMON_SYSTEM_CONFIGPATH DEFAULT_SYSTEM_CONFIGPATH "/" \
136 DEFAULT_DAEMON_CONFIG_FILE
137
138 /* Default session configuration file path */
139 #define DEFAULT_SESSION_PATH "sessions"
140 /* Auto load session in that directory. */
141 #define DEFAULT_SESSION_CONFIG_AUTOLOAD "auto"
142 #define DEFAULT_SESSION_HOME_CONFIGPATH DEFAULT_LTTNG_HOME_RUNDIR "/" \
143 DEFAULT_SESSION_PATH
144 #define DEFAULT_SESSION_SYSTEM_CONFIGPATH DEFAULT_SYSTEM_CONFIGPATH "/" \
145 DEFAULT_SESSION_PATH
146 #define DEFAULT_SESSION_CONFIG_FILE_EXTENSION ".lttng"
147 #define DEFAULT_SESSION_CONFIG_XSD_FILENAME "session.xsd"
148 #define DEFAULT_SESSION_CONFIG_XSD_PATH CONFIG_LTTNG_SYSTEM_DATADIR "/xml/lttng/"
149 #define DEFAULT_SESSION_CONFIG_XSD_PATH_ENV "LTTNG_SESSION_CONFIG_XSD_PATH"
150
151 #define DEFAULT_GLOBAL_APPS_UNIX_SOCK \
152 DEFAULT_LTTNG_RUNDIR "/" LTTNG_UST_SOCK_FILENAME
153 #define DEFAULT_HOME_APPS_UNIX_SOCK \
154 DEFAULT_LTTNG_HOME_RUNDIR "/" LTTNG_UST_SOCK_FILENAME
155 #define DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH \
156 "/" LTTNG_UST_WAIT_FILENAME
157 #define DEFAULT_HOME_APPS_WAIT_SHM_PATH \
158 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH "-%d"
159
160 /*
161 * Value taken from the hard limit allowed by the kernel when using setrlimit
162 * with RLIMIT_NOFILE on an Intel i7 CPU and Linux 3.0.3.
163 */
164 #define DEFAULT_POLL_SIZE 65535
165
166 /*
167 * Format is %s_%d respectively channel name and CPU number. Eigth bytes
168 * are added here to add space for the CPU number. I guess 2^8 CPUs is more
169 * than enough. We might end up with quantum computing in a cell phone when
170 * reaching this limit.
171 */
172 #define DEFAULT_STREAM_NAME_LEN LTTNG_SYMBOL_NAME_LEN + 8
173
174 /* Default channel attributes */
175 #define DEFAULT_CHANNEL_NAME "channel0"
176 /* Default JUL domain channel name. */
177 #define DEFAULT_JUL_CHANNEL_NAME "lttng_jul_channel"
178 /* Default JUL tracepoint name. This is a wildcard for the JUL domain. */
179 #define DEFAULT_JUL_EVENT_COMPONENT "lttng_jul"
180 #define DEFAULT_JUL_EVENT_NAME DEFAULT_JUL_EVENT_COMPONENT ":*"
181
182 /* Default log4j domain channel name. */
183 #define DEFAULT_LOG4J_CHANNEL_NAME "lttng_log4j_channel"
184 /* Default log4j tracepoint name. This is a wildcard for the log4j domain. */
185 #define DEFAULT_LOG4J_EVENT_COMPONENT "lttng_log4j"
186 #define DEFAULT_LOG4J_EVENT_NAME DEFAULT_LOG4J_EVENT_COMPONENT ":*"
187
188 /* Default Python domain channel name. */
189 #define DEFAULT_PYTHON_CHANNEL_NAME "lttng_python_channel"
190 /* Default Python tracepoint name. This is a wildcard for the python domain. */
191 #define DEFAULT_PYTHON_EVENT_COMPONENT "lttng_python"
192 #define DEFAULT_PYTHON_EVENT_NAME DEFAULT_PYTHON_EVENT_COMPONENT ":*"
193
194 #define DEFAULT_CHANNEL_OVERWRITE -1
195 #define DEFAULT_CHANNEL_TRACEFILE_SIZE CONFIG_DEFAULT_CHANNEL_TRACEFILE_SIZE
196 #define DEFAULT_CHANNEL_TRACEFILE_COUNT CONFIG_DEFAULT_CHANNEL_TRACEFILE_COUNT
197
198 #define _DEFAULT_CHANNEL_SUBBUF_SIZE CONFIG_DEFAULT_CHANNEL_SUBBUF_SIZE
199 #define _DEFAULT_CHANNEL_OUTPUT LTTNG_EVENT_MMAP
200
201 /* Metadata channel defaults. */
202 #define DEFAULT_METADATA_SUBBUF_SIZE CONFIG_DEFAULT_METADATA_SUBBUF_SIZE
203 #define DEFAULT_METADATA_SUBBUF_NUM CONFIG_DEFAULT_METADATA_SUBBUF_NUM
204 #define DEFAULT_METADATA_CACHE_SIZE CONFIG_DEFAULT_METADATA_CACHE_SIZE
205 #define DEFAULT_METADATA_SWITCH_TIMER CONFIG_DEFAULT_METADATA_SWITCH_TIMER
206 #define DEFAULT_METADATA_READ_TIMER CONFIG_DEFAULT_METADATA_READ_TIMER
207 #define DEFAULT_METADATA_OUTPUT _DEFAULT_CHANNEL_OUTPUT
208
209 /* Kernel has different defaults */
210
211 /* DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE must always be a power of 2 */
212 #define DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE CONFIG_DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE
213 /*
214 * DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM must always be a power of 2.
215 * Update help manually if override.
216 */
217 #define DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM CONFIG_DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM
218 /* See lttng-kernel.h enum lttng_kernel_output for channel output */
219 #define DEFAULT_KERNEL_CHANNEL_OUTPUT LTTNG_EVENT_SPLICE
220 #define DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER CONFIG_DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER
221 #define DEFAULT_KERNEL_CHANNEL_READ_TIMER CONFIG_DEFAULT_KERNEL_CHANNEL_READ_TIMER
222 #define DEFAULT_KERNEL_CHANNEL_LIVE_TIMER CONFIG_DEFAULT_KERNEL_CHANNEL_LIVE_TIMER
223
224 /* User space defaults */
225
226 /* Must be a power of 2 */
227 #define DEFAULT_UST_PID_CHANNEL_SUBBUF_SIZE CONFIG_DEFAULT_UST_PID_CHANNEL_SUBBUF_SIZE
228 #define DEFAULT_UST_UID_CHANNEL_SUBBUF_SIZE CONFIG_DEFAULT_UST_UID_CHANNEL_SUBBUF_SIZE
229 /* Must be a power of 2. Update help manuall if override. */
230 #define DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM CONFIG_DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM
231 #define DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM CONFIG_DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM
232 /* See lttng-ust.h enum lttng_ust_output */
233 #define DEFAULT_UST_PID_CHANNEL_OUTPUT _DEFAULT_CHANNEL_OUTPUT
234 #define DEFAULT_UST_UID_CHANNEL_OUTPUT _DEFAULT_CHANNEL_OUTPUT
235 /* Timers in usec. */
236 #define DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER CONFIG_DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER
237 #define DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER CONFIG_DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER
238 #define DEFAULT_UST_PID_CHANNEL_LIVE_TIMER CONFIG_DEFAULT_UST_PID_CHANNEL_LIVE_TIMER
239 #define DEFAULT_UST_UID_CHANNEL_LIVE_TIMER CONFIG_DEFAULT_UST_UID_CHANNEL_LIVE_TIMER
240
241 #define DEFAULT_UST_PID_CHANNEL_READ_TIMER CONFIG_DEFAULT_UST_PID_CHANNEL_READ_TIMER
242 #define DEFAULT_UST_UID_CHANNEL_READ_TIMER CONFIG_DEFAULT_UST_UID_CHANNEL_READ_TIMER
243
244 /*
245 * Default timeout value for the sem_timedwait() call. Blocking forever is not
246 * wanted so a timeout is used to control the data flow and not freeze the
247 * session daemon.
248 */
249 #define DEFAULT_SEM_WAIT_TIMEOUT 30 /* in seconds */
250
251 /* Default bind addresses for network services. */
252 #define DEFAULT_NETWORK_CONTROL_BIND_ADDRESS CONFIG_DEFAULT_NETWORK_CONTROL_BIND_ADDRESS
253 #define DEFAULT_NETWORK_DATA_BIND_ADDRESS CONFIG_DEFAULT_NETWORK_DATA_BIND_ADDRESS
254 #define DEFAULT_NETWORK_VIEWER_BIND_ADDRESS CONFIG_DEFAULT_NETWORK_VIEWER_BIND_ADDRESS
255 #define DEFAULT_AGENT_BIND_ADDRESS CONFIG_DEFAULT_AGENT_BIND_ADDRESS
256
257 /* Default network ports for trace streaming support. */
258 #define DEFAULT_NETWORK_CONTROL_PORT CONFIG_DEFAULT_NETWORK_CONTROL_PORT
259 #define DEFAULT_NETWORK_DATA_PORT CONFIG_DEFAULT_NETWORK_DATA_PORT
260 #define DEFAULT_NETWORK_VIEWER_PORT CONFIG_DEFAULT_NETWORK_VIEWER_PORT
261
262 /* Agent registration TCP port. */
263 #define DEFAULT_AGENT_TCP_PORT CONFIG_DEFAULT_AGENT_TCP_PORT
264
265 /*
266 * If a thread stalls for this amount of time, it will be considered bogus (bad
267 * health).
268 */
269 #define DEFAULT_HEALTH_CHECK_DELTA_S 20
270 #define DEFAULT_HEALTH_CHECK_DELTA_NS 0
271
272 /*
273 * Wait period before retrying the lttng_data_pending command in the lttng
274 * stop command of liblttng-ctl.
275 */
276 #define DEFAULT_DATA_AVAILABILITY_WAIT_TIME 200000 /* usec */
277
278 /*
279 * Wait period before retrying the lttng_consumer_flushed_cache when
280 * the consumer receives metadata.
281 */
282 #define DEFAULT_METADATA_AVAILABILITY_WAIT_TIME 200000 /* usec */
283
284 /*
285 * The usual value for the maximum TCP SYN retries time and TCP FIN timeout is
286 * 180 and 60 seconds on most Linux system and the default value since kernel
287 * 2.2 thus using the highest value. See tcp(7) for more details.
288 */
289 #define DEFAULT_INET_TCP_TIMEOUT 180 /* sec */
290
291 /*
292 * Default receiving and sending timeout for an application socket.
293 */
294 #define DEFAULT_APP_SOCKET_RW_TIMEOUT CONFIG_DEFAULT_APP_SOCKET_RW_TIMEOUT
295 #define DEFAULT_APP_SOCKET_TIMEOUT_ENV "LTTNG_APP_SOCKET_TIMEOUT"
296
297 #define DEFAULT_UST_STREAM_FD_NUM 2 /* Number of fd per UST stream. */
298
299 #define DEFAULT_SNAPSHOT_NAME "snapshot"
300 #define DEFAULT_SNAPSHOT_MAX_SIZE 0 /* Unlimited. */
301
302 /* Suffix of an index file. */
303 #define DEFAULT_INDEX_FILE_SUFFIX ".idx"
304 #define DEFAULT_INDEX_DIR "index"
305
306 /* Default lttng command live timer value in usec. */
307 #define DEFAULT_LTTNG_LIVE_TIMER CONFIG_DEFAULT_LTTNG_LIVE_TIMER
308
309 /* Default runas worker name */
310 #define DEFAULT_RUN_AS_WORKER_NAME "lttng-runas"
311
312 /* Default LTTng MI XML namespace. */
313 #define DEFAULT_LTTNG_MI_NAMESPACE "http://lttng.org/xml/ns/lttng-mi"
314
315 /* Default thread stack size; the default mandated by pthread_create(3) */
316 #define DEFAULT_LTTNG_THREAD_STACK_SIZE 2097152
317
318 /* Default maximal size of message notification channel message payloads. */
319 #define DEFAULT_MAX_NOTIFICATION_CLIENT_MESSAGE_PAYLOAD_SIZE 65536
320
321 /* Default maximal size of message notification channel message payloads. */
322 #define DEFAULT_CLIENT_MAX_QUEUED_NOTIFICATIONS_COUNT 100
323
324 /*
325 * Returns the default subbuf size.
326 *
327 * This function depends on a value that is set at constructor time, so it is
328 * unsafe to call it from another constructor.
329 */
330 LTTNG_HIDDEN
331 size_t default_get_channel_subbuf_size(void);
332
333 /*
334 * Returns the default metadata subbuf size.
335 *
336 * This function depends on a value that is set at constructor time, so it is
337 * unsafe to call it from another constructor.
338 */
339 LTTNG_HIDDEN
340 size_t default_get_metadata_subbuf_size(void);
341
342 /*
343 * Returns the default subbuf size for the kernel domain.
344 *
345 * This function depends on a value that is set at constructor time, so it is
346 * unsafe to call it from another constructor.
347 */
348 LTTNG_HIDDEN
349 size_t default_get_kernel_channel_subbuf_size(void);
350
351 /*
352 * Returns the default subbuf size for the UST domain per PID.
353 *
354 * This function depends on a value that is set at constructor time, so it is
355 * unsafe to call it from another constructor.
356 */
357 LTTNG_HIDDEN
358 size_t default_get_ust_pid_channel_subbuf_size(void);
359
360 /*
361 * Returns the default subbuf size for the UST domain per UID.
362 *
363 * This function depends on a value that is set at constructor time, so it is
364 * unsafe to call it from another constructor.
365 */
366 LTTNG_HIDDEN
367 size_t default_get_ust_uid_channel_subbuf_size(void);
368
369 /*
370 * Get the default pthread_attr to use on thread creation.
371 *
372 * Some libc, such as musl, don't honor the limit set for the stack size and use
373 * their own empirically chosen static value. This function checks if the
374 * current stack size is smaller than the stack size limit and if so returns a
375 * pthread_attr_t pointer where the thread stack size is set to the soft stack
376 * size limit.
377 */
378 LTTNG_HIDDEN
379 pthread_attr_t *default_pthread_attr(void);
380
381 #endif /* _DEFAULTS_H */
This page took 0.055892 seconds and 4 git commands to generate.