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