d1e4adfcd9846c70f28eb08e08f4ac76197438bf
[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 /* Default lttng run directory */
82 #define DEFAULT_LTTNG_HOME_ENV_VAR "LTTNG_HOME"
83 #define DEFAULT_LTTNG_FALLBACK_HOME_ENV_VAR "HOME"
84 #define DEFAULT_LTTNG_RUNDIR CONFIG_LTTNG_SYSTEM_RUNDIR
85 #define DEFAULT_LTTNG_HOME_RUNDIR "%s/.lttng"
86 #define DEFAULT_LTTNG_SESSIOND_PIDFILE "lttng-sessiond.pid"
87
88 /* Default unix socket path */
89 #define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/client-lttng-sessiond"
90 #define DEFAULT_HOME_CLIENT_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/client-lttng-sessiond"
91 #define DEFAULT_GLOBAL_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/health.sock"
92 #define DEFAULT_HOME_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/health.sock"
93
94 #define DEFAULT_GLOBAL_APPS_UNIX_SOCK \
95 DEFAULT_LTTNG_RUNDIR "/" LTTNG_UST_SOCK_FILENAME
96 #define DEFAULT_HOME_APPS_UNIX_SOCK \
97 DEFAULT_LTTNG_HOME_RUNDIR "/" LTTNG_UST_SOCK_FILENAME
98 #define DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH \
99 "/" LTTNG_UST_WAIT_FILENAME
100 #define DEFAULT_HOME_APPS_WAIT_SHM_PATH \
101 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH "-%d"
102
103 /*
104 * Value taken from the hard limit allowed by the kernel when using setrlimit
105 * with RLIMIT_NOFILE on an Intel i7 CPU and Linux 3.0.3.
106 */
107 #define DEFAULT_POLL_SIZE 65535
108
109 /*
110 * Format is %s_%d respectively channel name and CPU number. Eigth bytes
111 * are added here to add space for the CPU number. I guess 2^8 CPUs is more
112 * than enough. We might end up with quantum computing in a cell phone when
113 * reaching this limit.
114 */
115 #define DEFAULT_STREAM_NAME_LEN LTTNG_SYMBOL_NAME_LEN + 8
116
117 /* Default channel attributes */
118 #define DEFAULT_CHANNEL_NAME "channel0"
119 #define DEFAULT_CHANNEL_OVERWRITE 0
120 #define DEFAULT_CHANNEL_TRACEFILE_SIZE 0
121 #define DEFAULT_CHANNEL_TRACEFILE_COUNT 0
122
123 /* Must always be a power of 2 */
124 #define _DEFAULT_CHANNEL_SUBBUF_SIZE 4096 /* bytes */
125 /* Must always be a power of 2 */
126 #define _DEFAULT_CHANNEL_SUBBUF_NUM 4
127 #define _DEFAULT_CHANNEL_SWITCH_TIMER 0 /* usec */
128 #define _DEFAULT_CHANNEL_READ_TIMER 200000 /* usec */
129 #define _DEFAULT_CHANNEL_OUTPUT LTTNG_EVENT_MMAP
130
131 /* Metadata channel defaults. */
132 #define DEFAULT_METADATA_SUBBUF_SIZE 4096
133 #define DEFAULT_METADATA_SUBBUF_NUM 2
134 #define DEFAULT_METADATA_CACHE_SIZE 4096
135 #define DEFAULT_METADATA_SWITCH_TIMER _DEFAULT_CHANNEL_SWITCH_TIMER
136 #define DEFAULT_METADATA_READ_TIMER 0
137 #define DEFAULT_METADATA_OUTPUT _DEFAULT_CHANNEL_OUTPUT
138
139 /* Kernel has different defaults */
140
141 /* DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE must always be a power of 2 */
142 #define DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE 262144 /* bytes */
143 /*
144 * DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM must always be a power of 2.
145 * Update help manually if override.
146 */
147 #define DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM _DEFAULT_CHANNEL_SUBBUF_NUM
148 /* See lttng-kernel.h enum lttng_kernel_output for channel output */
149 #define DEFAULT_KERNEL_CHANNEL_OUTPUT LTTNG_EVENT_SPLICE
150 #define DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER _DEFAULT_CHANNEL_SWITCH_TIMER
151 #define DEFAULT_KERNEL_CHANNEL_READ_TIMER _DEFAULT_CHANNEL_READ_TIMER
152
153 /* User space defaults */
154
155 /* Must be a power of 2 */
156 #define DEFAULT_UST_PID_CHANNEL_SUBBUF_SIZE _DEFAULT_CHANNEL_SUBBUF_SIZE
157 #define DEFAULT_UST_UID_CHANNEL_SUBBUF_SIZE 131072 /* bytes */
158 /* Must be a power of 2. Update help manuall if override. */
159 #define DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM _DEFAULT_CHANNEL_SUBBUF_NUM
160 #define DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM _DEFAULT_CHANNEL_SUBBUF_NUM
161 /* See lttng-ust.h enum lttng_ust_output */
162 #define DEFAULT_UST_PID_CHANNEL_OUTPUT _DEFAULT_CHANNEL_OUTPUT
163 #define DEFAULT_UST_UID_CHANNEL_OUTPUT _DEFAULT_CHANNEL_OUTPUT
164 /* Timers in usec. */
165 #define DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER _DEFAULT_CHANNEL_SWITCH_TIMER
166 #define DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER _DEFAULT_CHANNEL_SWITCH_TIMER
167
168 #define DEFAULT_UST_PID_CHANNEL_READ_TIMER 0 /* usec */
169 #define DEFAULT_UST_UID_CHANNEL_READ_TIMER 0 /* usec */
170
171 /*
172 * Default timeout value for the sem_timedwait() call. Blocking forever is not
173 * wanted so a timeout is used to control the data flow and not freeze the
174 * session daemon.
175 */
176 #define DEFAULT_SEM_WAIT_TIMEOUT 30 /* in seconds */
177
178 /* Default network ports for trace streaming support */
179 #define DEFAULT_NETWORK_CONTROL_PORT 5342
180 #define DEFAULT_NETWORK_DATA_PORT 5343
181
182 /*
183 * If a thread stalls for this amount of time, it will be considered bogus (bad
184 * health).
185 */
186 #define DEFAULT_HEALTH_CHECK_DELTA_S 20
187 #define DEFAULT_HEALTH_CHECK_DELTA_NS 0
188
189 /*
190 * Wait period before retrying the lttng_data_pending command in the lttng
191 * stop command of liblttng-ctl.
192 */
193 #define DEFAULT_DATA_AVAILABILITY_WAIT_TIME 200000 /* usec */
194
195 /*
196 * Wait period before retrying the lttng_consumer_flushed_cache when
197 * the consumer receives metadata.
198 */
199 #define DEFAULT_METADATA_AVAILABILITY_WAIT_TIME 200000 /* usec */
200
201 /*
202 * The usual value for the maximum TCP SYN retries time and TCP FIN timeout is
203 * 180 and 60 seconds on most Linux system and the default value since kernel
204 * 2.2 thus using the highest value. See tcp(7) for more details.
205 */
206 #define DEFAULT_INET_TCP_TIMEOUT 180 /* sec */
207
208 /*
209 * Default receiving and sending timeout for an application socket.
210 */
211 #define DEFAULT_APP_SOCKET_RW_TIMEOUT 5 /* sec */
212 #define DEFAULT_APP_SOCKET_TIMEOUT_ENV "LTTNG_APP_SOCKET_TIMEOUT"
213
214 #define DEFAULT_UST_STREAM_FD_NUM 2 /* Number of fd per UST stream. */
215
216 #define DEFAULT_SNAPSHOT_NAME "snapshot"
217 #define DEFAULT_SNAPSHOT_MAX_SIZE 0 /* Unlimited. */
218
219 /* Suffix of an index file. */
220 #define DEFAULT_INDEX_FILE_SUFFIX ".idx"
221
222 extern size_t default_channel_subbuf_size;
223 extern size_t default_metadata_subbuf_size;
224 extern size_t default_ust_pid_channel_subbuf_size;
225 extern size_t default_ust_uid_channel_subbuf_size;
226 extern size_t default_kernel_channel_subbuf_size;
227
228 /*
229 * Returns the default subbuf size.
230 *
231 * This function depends on a value that is set at constructor time, so it is
232 * unsafe to call it from another constructor.
233 */
234 static inline
235 size_t default_get_channel_subbuf_size(void)
236 {
237 return default_channel_subbuf_size;
238 }
239
240 /*
241 * Returns the default metadata subbuf size.
242 *
243 * This function depends on a value that is set at constructor time, so it is
244 * unsafe to call it from another constructor.
245 */
246 static inline
247 size_t default_get_metadata_subbuf_size(void)
248 {
249 return default_metadata_subbuf_size;
250 }
251
252 /*
253 * Returns the default subbuf size for the kernel domain.
254 *
255 * This function depends on a value that is set at constructor time, so it is
256 * unsafe to call it from another constructor.
257 */
258 static inline
259 size_t default_get_kernel_channel_subbuf_size(void)
260 {
261 return default_kernel_channel_subbuf_size;
262 }
263
264 /*
265 * Returns the default subbuf size for the UST domain per PID.
266 *
267 * This function depends on a value that is set at constructor time, so it is
268 * unsafe to call it from another constructor.
269 */
270 static inline
271 size_t default_get_ust_pid_channel_subbuf_size(void)
272 {
273 return default_ust_pid_channel_subbuf_size;
274 }
275
276 /*
277 * Returns the default subbuf size for the UST domain per UID.
278 *
279 * This function depends on a value that is set at constructor time, so it is
280 * unsafe to call it from another constructor.
281 */
282 static inline
283 size_t default_get_ust_uid_channel_subbuf_size(void)
284 {
285 return default_ust_uid_channel_subbuf_size;
286 }
287
288 #endif /* _DEFAULTS_H */
This page took 0.051292 seconds and 3 git commands to generate.