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