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