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