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.
22 /* Default unix group name for tracing. */
23 #define DEFAULT_TRACING_GROUP "tracing"
26 * This value is defined in the CTF specification (see
27 * git://git.efficios.com/ctf.git in the file
28 * common-trace-format-specification.txt.
30 #define DEFAULT_METADATA_NAME "metadata"
32 /* Environment variable to set session daemon binary path. */
33 #define DEFAULT_SESSIOND_PATH_ENV "LTTNG_SESSIOND_PATH"
35 /* Default trace output directory name */
36 #define DEFAULT_TRACE_DIR_NAME "lttng-traces"
38 /* Default size of a hash table */
39 #define DEFAULT_HT_SIZE 4
41 /* Default session daemon paths */
42 #define DEFAULT_HOME_DIR "/tmp"
43 #define DEFAULT_UST_SOCK_DIR DEFAULT_HOME_DIR "/ust-app-socks"
44 #define DEFAULT_GLOBAL_APPS_PIPE DEFAULT_UST_SOCK_DIR "/global"
45 #define DEFAULT_TRACE_OUTPUT DEFAULT_HOME_DIR "/lttng"
47 /* Default directory where the trace are written in per domain */
48 #define DEFAULT_KERNEL_TRACE_DIR "/kernel"
49 #define DEFAULT_UST_TRACE_DIR "/ust"
52 * Default session name for the lttng command line. This default value will
53 * get the date and time appended (%Y%m%d-%H%M%S) to it.
55 #define DEFAULT_SESSION_NAME "auto"
57 /* Default consumer paths */
58 #define DEFAULT_CONSUMERD_RUNDIR "%s"
60 /* Kernel consumer path */
61 #define DEFAULT_KCONSUMERD_PATH DEFAULT_CONSUMERD_RUNDIR "/kconsumerd"
62 #define DEFAULT_KCONSUMERD_CMD_SOCK_PATH DEFAULT_KCONSUMERD_PATH "/command"
63 #define DEFAULT_KCONSUMERD_ERR_SOCK_PATH DEFAULT_KCONSUMERD_PATH "/error"
65 /* UST 64-bit consumer path */
66 #define DEFAULT_USTCONSUMERD64_PATH DEFAULT_CONSUMERD_RUNDIR "/ustconsumerd64"
67 #define DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH DEFAULT_USTCONSUMERD64_PATH "/command"
68 #define DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH DEFAULT_USTCONSUMERD64_PATH "/error"
70 /* UST 32-bit consumer path */
71 #define DEFAULT_USTCONSUMERD32_PATH DEFAULT_CONSUMERD_RUNDIR "/ustconsumerd32"
72 #define DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH DEFAULT_USTCONSUMERD32_PATH "/command"
73 #define DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH DEFAULT_USTCONSUMERD32_PATH "/error"
76 /* Default lttng run directory */
77 #define DEFAULT_LTTNG_RUNDIR "/var/run/lttng"
78 #define DEFAULT_LTTNG_HOME_RUNDIR "%s/.lttng"
79 #define DEFAULT_LTTNG_SESSIOND_PIDFILE "lttng-sessiond.pid"
81 /* Default unix socket path */
82 #define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/client-lttng-sessiond"
83 #define DEFAULT_HOME_CLIENT_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/client-lttng-sessiond"
84 #define DEFAULT_GLOBAL_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/health.sock"
85 #define DEFAULT_HOME_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/health.sock"
87 #ifdef HAVE_LIBLTTNG_UST_CTL
88 #define DEFAULT_GLOBAL_APPS_UNIX_SOCK \
89 DEFAULT_LTTNG_RUNDIR "/" LTTNG_UST_SOCK_FILENAME
90 #define DEFAULT_HOME_APPS_UNIX_SOCK \
91 DEFAULT_LTTNG_HOME_RUNDIR "/" LTTNG_UST_SOCK_FILENAME
92 #define DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH \
93 "/" LTTNG_UST_WAIT_FILENAME
94 #define DEFAULT_HOME_APPS_WAIT_SHM_PATH \
95 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH "-%d"
98 #define DEFAULT_GLOBAL_APPS_UNIX_SOCK
99 #define DEFAULT_HOME_APPS_UNIX_SOCK
100 #endif /* HAVE_LIBLTTNG_UST_CTL */
103 * Value taken from the hard limit allowed by the kernel when using setrlimit
104 * with RLIMIT_NOFILE on an Intel i7 CPU and Linux 3.0.3.
106 #define DEFAULT_POLL_SIZE 65535
109 * Format is %s_%d respectively channel name and CPU number. Eigth bytes
110 * are added here to add space for the CPU number. I guess 2^8 CPUs is more
111 * than enough. We might end up with quantum computing in a cell phone when
112 * reaching this limit.
114 #define DEFAULT_STREAM_NAME_LEN LTTNG_SYMBOL_NAME_LEN + 8
116 /* Default channel attributes */
117 #define DEFAULT_CHANNEL_NAME "channel0"
118 #define DEFAULT_CHANNEL_OVERWRITE 0 /* usec */
119 /* DEFAULT_CHANNEL_SUBBUF_SIZE must always be a power of 2 */
120 #define DEFAULT_CHANNEL_SUBBUF_SIZE 4096 /* bytes */
121 /* DEFAULT_CHANNEL_SUBBUF_NUM must always be a power of 2 */
122 #define DEFAULT_CHANNEL_SUBBUF_NUM 4
123 #define DEFAULT_CHANNEL_SWITCH_TIMER 0 /* usec */
124 #define DEFAULT_CHANNEL_READ_TIMER 200000 /* usec */
125 #define DEFAULT_CHANNEL_OUTPUT LTTNG_EVENT_MMAP
127 #define DEFAULT_METADATA_SUBBUF_SIZE 4096
128 #define DEFAULT_METADATA_SUBBUF_NUM 2
130 /* Kernel has different defaults */
132 /* DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE must always be a power of 2 */
133 #define DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE 262144 /* bytes */
135 * DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM must always be a power of 2.
136 * Update help manually if override.
138 #define DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM DEFAULT_CHANNEL_SUBBUF_NUM
139 /* See lttng-kernel.h enum lttng_kernel_output for channel output */
140 #define DEFAULT_KERNEL_CHANNEL_OUTPUT LTTNG_EVENT_SPLICE
142 #define DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER \
143 DEFAULT_CHANNEL_SWITCH_TIMER
144 #define DEFAULT_KERNEL_CHANNEL_READ_TIMER 200000 /* usec */
146 /* User space defaults */
148 /* Must be a power of 2 */
149 #define DEFAULT_UST_CHANNEL_SUBBUF_SIZE 4096 /* bytes */
150 /* Must be a power of 2. Update help manuall if override. */
151 #define DEFAULT_UST_CHANNEL_SUBBUF_NUM DEFAULT_CHANNEL_SUBBUF_NUM
152 /* See lttng-ust.h enum lttng_ust_output */
153 #define DEFAULT_UST_CHANNEL_OUTPUT LTTNG_EVENT_MMAP
155 #define DEFAULT_UST_CHANNEL_SWITCH_TIMER \
156 DEFAULT_CHANNEL_SWITCH_TIMER
157 #define DEFAULT_UST_CHANNEL_READ_TIMER 0 /* usec */
160 * Default timeout value for the sem_timedwait() call. Blocking forever is not
161 * wanted so a timeout is used to control the data flow and not freeze the
164 #define DEFAULT_SEM_WAIT_TIMEOUT 30 /* in seconds */
166 /* Default network ports for trace streaming support */
167 #define DEFAULT_NETWORK_CONTROL_PORT 5342
168 #define DEFAULT_NETWORK_DATA_PORT 5343
171 * If a thread stalls for this amount of time, it will be considered bogus (bad
174 #define DEFAULT_HEALTH_CHECK_DELTA_S 20
175 #define DEFAULT_HEALTH_CHECK_DELTA_NS 0
178 * Wait period before retrying the lttng_data_pending command in the lttng
179 * stop command of liblttng-ctl.
181 #define DEFAULT_DATA_AVAILABILITY_WAIT_TIME 200000 /* usec */
184 * Default receiving and sending timeout for an application socket.
186 #define DEFAULT_APP_SOCKET_RW_TIMEOUT 5 /* sec */
187 #define DEFAULT_APP_SOCKET_TIMEOUT_ENV "LTTNG_APP_SOCKET_TIMEOUT"
189 #define DEFAULT_UST_STREAM_FD_NUM 2 /* Number of fd per UST stream. */
191 extern size_t default_channel_subbuf_size
;
192 extern size_t default_metadata_subbuf_size
;
193 extern size_t default_ust_channel_subbuf_size
;
194 extern size_t default_kernel_channel_subbuf_size
;
198 * Returns the default subbuf size.
200 * This function depends on a value that is set at constructor time, so it is
201 * unsafe to call it from another constructor.
204 size_t default_get_channel_subbuf_size(void)
206 return default_channel_subbuf_size
;
210 * Returns the default metadata subbuf size.
212 * This function depends on a value that is set at constructor time, so it is
213 * unsafe to call it from another constructor.
216 size_t default_get_metadata_subbuf_size(void)
218 return default_metadata_subbuf_size
;
222 * Returns the default subbuf size for the kernel domain.
224 * This function depends on a value that is set at constructor time, so it is
225 * unsafe to call it from another constructor.
228 size_t default_get_kernel_channel_subbuf_size(void)
230 return default_kernel_channel_subbuf_size
;
234 * Returns the default subbuf size for the UST domain.
236 * This function depends on a value that is set at constructor time, so it is
237 * unsafe to call it from another constructor.
240 size_t default_get_ust_channel_subbuf_size(void)
242 return default_ust_channel_subbuf_size
;
245 #endif /* _DEFAULTS_H */