2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
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.
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
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.
24 /* Default unix group name for tracing. */
25 #define DEFAULT_TRACING_GROUP "tracing"
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.
32 #define DEFAULT_METADATA_NAME "metadata"
34 /* Environment variable to set session daemon binary path. */
35 #define DEFAULT_SESSIOND_PATH_ENV "LTTNG_SESSIOND_PATH"
37 /* Default trace output directory name */
38 #define DEFAULT_TRACE_DIR_NAME "lttng-traces"
40 /* Default size of a hash table */
41 #define DEFAULT_HT_SIZE 4
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"
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"
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"
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.
61 #define DEFAULT_SESSION_NAME "auto"
63 /* Default consumer paths */
64 #define DEFAULT_CONSUMERD_RUNDIR "%s"
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"
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"
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"
82 #define DEFAULT_RELAYD_RUNDIR "%s"
83 #define DEFAULT_RELAYD_PATH DEFAULT_RELAYD_RUNDIR "/relayd"
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"
94 /* Default probes list */
95 #define DEFAULT_LTTNG_KMOD_PROBES "LTTNG_KMOD_PROBES"
97 /* Default unix socket path */
98 #define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/client-lttng-sessiond"
99 #define DEFAULT_HOME_CLIENT_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/client-lttng-sessiond"
100 #define DEFAULT_GLOBAL_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/sessiond-health"
101 #define DEFAULT_HOME_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/sessiond-health"
103 /* Default consumer health unix socket path */
104 #define DEFAULT_GLOBAL_USTCONSUMER32_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/ustconsumerd32/health"
105 #define DEFAULT_HOME_USTCONSUMER32_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/ustconsumerd32/health"
106 #define DEFAULT_GLOBAL_USTCONSUMER64_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/ustconsumerd64/health"
107 #define DEFAULT_HOME_USTCONSUMER64_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/ustconsumerd64/health"
108 #define DEFAULT_GLOBAL_KCONSUMER_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/kconsumerd/health"
109 #define DEFAULT_HOME_KCONSUMER_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/kconsumerd/health"
111 /* Default relay health unix socket path */
112 #define DEFAULT_GLOBAL_RELAY_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/relayd/health-%d"
113 #define DEFAULT_HOME_RELAY_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/relayd/health-%d"
115 /* Default daemon configuration file path */
116 #define DEFAULT_SYSTEM_CONFIGPATH CONFIG_LTTNG_SYSTEM_CONFIGDIR \
119 #define DEFAULT_DAEMON_CONFIG_FILE "lttng.conf"
120 #define DEFAULT_DAEMON_HOME_CONFIGPATH DEFAULT_LTTNG_HOME_RUNDIR "/" \
121 DEFAULT_DAEMON_CONFIG_FILE
122 #define DEFAULT_DAEMON_SYSTEM_CONFIGPATH DEFAULT_SYSTEM_CONFIGPATH "/" \
123 DEFAULT_DAEMON_CONFIG_FILE
125 /* Default session configuration file path */
126 #define DEFAULT_SESSION_PATH "sessions"
127 /* Auto load session in that directory. */
128 #define DEFAULT_SESSION_CONFIG_AUTOLOAD "auto"
129 #define DEFAULT_SESSION_HOME_CONFIGPATH DEFAULT_LTTNG_HOME_RUNDIR "/" \
131 #define DEFAULT_SESSION_SYSTEM_CONFIGPATH DEFAULT_SYSTEM_CONFIGPATH "/" \
133 #define DEFAULT_SESSION_CONFIG_FILE_EXTENSION ".lttng"
134 #define DEFAULT_SESSION_CONFIG_XSD_FILENAME "session.xsd"
135 #define DEFAULT_SESSION_CONFIG_XSD_PATH CONFIG_LTTNG_SYSTEM_DATADIR "/xml/lttng/"
136 #define DEFAULT_SESSION_CONFIG_XSD_PATH_ENV "LTTNG_SESSION_CONFIG_XSD_PATH"
138 #define DEFAULT_GLOBAL_APPS_UNIX_SOCK \
139 DEFAULT_LTTNG_RUNDIR "/" LTTNG_UST_SOCK_FILENAME
140 #define DEFAULT_HOME_APPS_UNIX_SOCK \
141 DEFAULT_LTTNG_HOME_RUNDIR "/" LTTNG_UST_SOCK_FILENAME
142 #define DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH \
143 "/" LTTNG_UST_WAIT_FILENAME
144 #define DEFAULT_HOME_APPS_WAIT_SHM_PATH \
145 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH "-%d"
148 * Value taken from the hard limit allowed by the kernel when using setrlimit
149 * with RLIMIT_NOFILE on an Intel i7 CPU and Linux 3.0.3.
151 #define DEFAULT_POLL_SIZE 65535
154 * Format is %s_%d respectively channel name and CPU number. Eigth bytes
155 * are added here to add space for the CPU number. I guess 2^8 CPUs is more
156 * than enough. We might end up with quantum computing in a cell phone when
157 * reaching this limit.
159 #define DEFAULT_STREAM_NAME_LEN LTTNG_SYMBOL_NAME_LEN + 8
161 /* Default channel attributes */
162 #define DEFAULT_CHANNEL_NAME "channel0"
163 /* Default JUL domain channel name. */
164 #define DEFAULT_JUL_CHANNEL_NAME "lttng_jul_channel"
165 /* Default JUL tracepoint name. This is a wildcard for the JUL domain. */
166 #define DEFAULT_SYS_JUL_EVENT_NAME "lttng_jul:sys*"
167 #define DEFAULT_USER_JUL_EVENT_NAME "lttng_jul:user*"
168 /* JUL default channel name. */
169 #define DEFAULT_CHANNEL_OVERWRITE 0
170 #define DEFAULT_CHANNEL_TRACEFILE_SIZE 0
171 #define DEFAULT_CHANNEL_TRACEFILE_COUNT 0
173 /* Must always be a power of 2 */
174 #define _DEFAULT_CHANNEL_SUBBUF_SIZE 4096 /* bytes */
175 /* Must always be a power of 2 */
176 #define _DEFAULT_CHANNEL_SUBBUF_NUM 4
177 #define _DEFAULT_CHANNEL_SWITCH_TIMER 0 /* usec */
178 #define _DEFAULT_CHANNEL_LIVE_TIMER 0 /* usec */
179 #define _DEFAULT_CHANNEL_READ_TIMER 200000 /* usec */
180 #define _DEFAULT_CHANNEL_OUTPUT LTTNG_EVENT_MMAP
182 /* Metadata channel defaults. */
183 #define DEFAULT_METADATA_SUBBUF_SIZE 4096
184 #define DEFAULT_METADATA_SUBBUF_NUM 2
185 #define DEFAULT_METADATA_CACHE_SIZE 4096
186 #define DEFAULT_METADATA_SWITCH_TIMER _DEFAULT_CHANNEL_SWITCH_TIMER
187 #define DEFAULT_METADATA_READ_TIMER 0
188 #define DEFAULT_METADATA_OUTPUT _DEFAULT_CHANNEL_OUTPUT
190 /* Kernel has different defaults */
192 /* DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE must always be a power of 2 */
193 #define DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE 262144 /* bytes */
195 * DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM must always be a power of 2.
196 * Update help manually if override.
198 #define DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM _DEFAULT_CHANNEL_SUBBUF_NUM
199 /* See lttng-kernel.h enum lttng_kernel_output for channel output */
200 #define DEFAULT_KERNEL_CHANNEL_OUTPUT LTTNG_EVENT_SPLICE
201 #define DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER _DEFAULT_CHANNEL_SWITCH_TIMER
202 #define DEFAULT_KERNEL_CHANNEL_READ_TIMER _DEFAULT_CHANNEL_READ_TIMER
203 #define DEFAULT_KERNEL_CHANNEL_LIVE_TIMER _DEFAULT_CHANNEL_LIVE_TIMER
205 /* User space defaults */
207 /* Must be a power of 2 */
208 #define DEFAULT_UST_PID_CHANNEL_SUBBUF_SIZE _DEFAULT_CHANNEL_SUBBUF_SIZE
209 #define DEFAULT_UST_UID_CHANNEL_SUBBUF_SIZE 131072 /* bytes */
210 /* Must be a power of 2. Update help manuall if override. */
211 #define DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM _DEFAULT_CHANNEL_SUBBUF_NUM
212 #define DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM _DEFAULT_CHANNEL_SUBBUF_NUM
213 /* See lttng-ust.h enum lttng_ust_output */
214 #define DEFAULT_UST_PID_CHANNEL_OUTPUT _DEFAULT_CHANNEL_OUTPUT
215 #define DEFAULT_UST_UID_CHANNEL_OUTPUT _DEFAULT_CHANNEL_OUTPUT
216 /* Timers in usec. */
217 #define DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER _DEFAULT_CHANNEL_SWITCH_TIMER
218 #define DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER _DEFAULT_CHANNEL_SWITCH_TIMER
219 #define DEFAULT_UST_PID_CHANNEL_LIVE_TIMER _DEFAULT_CHANNEL_LIVE_TIMER
220 #define DEFAULT_UST_UID_CHANNEL_LIVE_TIMER _DEFAULT_CHANNEL_LIVE_TIMER
222 #define DEFAULT_UST_PID_CHANNEL_READ_TIMER 0 /* usec */
223 #define DEFAULT_UST_UID_CHANNEL_READ_TIMER 0 /* usec */
226 * Default timeout value for the sem_timedwait() call. Blocking forever is not
227 * wanted so a timeout is used to control the data flow and not freeze the
230 #define DEFAULT_SEM_WAIT_TIMEOUT 30 /* in seconds */
232 /* Default bind addresses for network services. */
233 #define DEFAULT_NETWORK_CONTROL_BIND_ADDRESS "0.0.0.0"
234 #define DEFAULT_NETWORK_DATA_BIND_ADDRESS "0.0.0.0"
235 #define DEFAULT_NETWORK_VIEWER_BIND_ADDRESS "localhost"
236 #define DEFAULT_AGENT_BIND_ADDRESS "localhost"
238 /* Default network ports for trace streaming support. */
239 #define DEFAULT_NETWORK_CONTROL_PORT 5342
240 #define DEFAULT_NETWORK_DATA_PORT 5343
241 #define DEFAULT_NETWORK_VIEWER_PORT 5344
243 /* Agent registration TCP port. */
244 #define DEFAULT_AGENT_TCP_PORT 5345
247 * If a thread stalls for this amount of time, it will be considered bogus (bad
250 #define DEFAULT_HEALTH_CHECK_DELTA_S 20
251 #define DEFAULT_HEALTH_CHECK_DELTA_NS 0
254 * Wait period before retrying the lttng_data_pending command in the lttng
255 * stop command of liblttng-ctl.
257 #define DEFAULT_DATA_AVAILABILITY_WAIT_TIME 200000 /* usec */
260 * Wait period before retrying the lttng_consumer_flushed_cache when
261 * the consumer receives metadata.
263 #define DEFAULT_METADATA_AVAILABILITY_WAIT_TIME 200000 /* usec */
266 * The usual value for the maximum TCP SYN retries time and TCP FIN timeout is
267 * 180 and 60 seconds on most Linux system and the default value since kernel
268 * 2.2 thus using the highest value. See tcp(7) for more details.
270 #define DEFAULT_INET_TCP_TIMEOUT 180 /* sec */
273 * Default receiving and sending timeout for an application socket.
275 #define DEFAULT_APP_SOCKET_RW_TIMEOUT 5 /* sec */
276 #define DEFAULT_APP_SOCKET_TIMEOUT_ENV "LTTNG_APP_SOCKET_TIMEOUT"
278 #define DEFAULT_UST_STREAM_FD_NUM 2 /* Number of fd per UST stream. */
280 #define DEFAULT_SNAPSHOT_NAME "snapshot"
281 #define DEFAULT_SNAPSHOT_MAX_SIZE 0 /* Unlimited. */
283 /* Suffix of an index file. */
284 #define DEFAULT_INDEX_FILE_SUFFIX ".idx"
285 #define DEFAULT_INDEX_DIR "index"
287 /* Default lttng command live timer value in usec. */
288 #define DEFAULT_LTTNG_LIVE_TIMER 1000000
290 extern size_t default_channel_subbuf_size
;
291 extern size_t default_metadata_subbuf_size
;
292 extern size_t default_ust_pid_channel_subbuf_size
;
293 extern size_t default_ust_uid_channel_subbuf_size
;
294 extern size_t default_kernel_channel_subbuf_size
;
297 * Returns the default subbuf size.
299 * This function depends on a value that is set at constructor time, so it is
300 * unsafe to call it from another constructor.
303 size_t default_get_channel_subbuf_size(void)
305 return default_channel_subbuf_size
;
309 * Returns the default metadata subbuf size.
311 * This function depends on a value that is set at constructor time, so it is
312 * unsafe to call it from another constructor.
315 size_t default_get_metadata_subbuf_size(void)
317 return default_metadata_subbuf_size
;
321 * Returns the default subbuf size for the kernel domain.
323 * This function depends on a value that is set at constructor time, so it is
324 * unsafe to call it from another constructor.
327 size_t default_get_kernel_channel_subbuf_size(void)
329 return default_kernel_channel_subbuf_size
;
333 * Returns the default subbuf size for the UST domain per PID.
335 * This function depends on a value that is set at constructor time, so it is
336 * unsafe to call it from another constructor.
339 size_t default_get_ust_pid_channel_subbuf_size(void)
341 return default_ust_pid_channel_subbuf_size
;
345 * Returns the default subbuf size for the UST domain per UID.
347 * This function depends on a value that is set at constructor time, so it is
348 * unsafe to call it from another constructor.
351 size_t default_get_ust_uid_channel_subbuf_size(void)
353 return default_ust_uid_channel_subbuf_size
;
356 #endif /* _DEFAULTS_H */