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"
25 /* Environment variable to set session daemon binary path. */
26 #define DEFAULT_SESSIOND_PATH_ENV "LTTNG_SESSIOND_PATH"
28 /* Default trace output directory name */
29 #define DEFAULT_TRACE_DIR_NAME "lttng-traces"
31 /* Default size of a hash table */
32 #define DEFAULT_HT_SIZE 4
34 /* Default session daemon paths */
35 #define DEFAULT_HOME_DIR "/tmp"
36 #define DEFAULT_UST_SOCK_DIR DEFAULT_HOME_DIR "/ust-app-socks"
37 #define DEFAULT_GLOBAL_APPS_PIPE DEFAULT_UST_SOCK_DIR "/global"
38 #define DEFAULT_TRACE_OUTPUT DEFAULT_HOME_DIR "/lttng"
40 #define DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH "/lttng-ust-apps-wait"
41 #define DEFAULT_HOME_APPS_WAIT_SHM_PATH "/lttng-ust-apps-wait-%u"
43 /* Default directory where the trace are written in per domain */
44 #define DEFAULT_KERNEL_TRACE_DIR "/kernel"
45 #define DEFAULT_UST_TRACE_DIR "/ust"
48 * Default session name for the lttng command line. This default value will
49 * get the date and time appended (%Y%m%d-%H%M%S) to it.
51 #define DEFAULT_SESSION_NAME "auto"
53 /* Default consumer paths */
54 #define DEFAULT_CONSUMERD_RUNDIR "%s"
56 /* Kernel consumer path */
57 #define DEFAULT_KCONSUMERD_PATH DEFAULT_CONSUMERD_RUNDIR "/kconsumerd"
58 #define DEFAULT_KCONSUMERD_CMD_SOCK_PATH DEFAULT_KCONSUMERD_PATH "/command"
59 #define DEFAULT_KCONSUMERD_ERR_SOCK_PATH DEFAULT_KCONSUMERD_PATH "/error"
61 /* UST 64-bit consumer path */
62 #define DEFAULT_USTCONSUMERD64_PATH DEFAULT_CONSUMERD_RUNDIR "/ustconsumerd64"
63 #define DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH DEFAULT_USTCONSUMERD64_PATH "/command"
64 #define DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH DEFAULT_USTCONSUMERD64_PATH "/error"
66 /* UST 32-bit consumer path */
67 #define DEFAULT_USTCONSUMERD32_PATH DEFAULT_CONSUMERD_RUNDIR "/ustconsumerd32"
68 #define DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH DEFAULT_USTCONSUMERD32_PATH "/command"
69 #define DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH DEFAULT_USTCONSUMERD32_PATH "/error"
72 /* Default lttng run directory */
73 #define DEFAULT_LTTNG_RUNDIR "/var/run/lttng"
74 #define DEFAULT_LTTNG_HOME_RUNDIR "%s/.lttng"
75 #define DEFAULT_LTTNG_SESSIOND_PIDFILE "lttng-sessiond.pid"
77 /* Default unix socket path */
78 #define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/client-lttng-sessiond"
79 #define DEFAULT_GLOBAL_APPS_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/apps-lttng-sessiond"
80 #define DEFAULT_HOME_APPS_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/apps-lttng-sessiond"
81 #define DEFAULT_HOME_CLIENT_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/client-lttng-sessiond"
82 #define DEFAULT_GLOBAL_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/health.sock"
83 #define DEFAULT_HOME_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/health.sock"
86 * Value taken from the hard limit allowed by the kernel when using setrlimit
87 * with RLIMIT_NOFILE on an Intel i7 CPU and Linux 3.0.3.
89 #define DEFAULT_POLL_SIZE 65535
92 * Format is %s_%d respectively channel name and CPU number. Eigth bytes
93 * are added here to add space for the CPU number. I guess 2^8 CPUs is more
94 * than enough. We might end up with quantum computing in a cell phone when
95 * reaching this limit.
97 #define DEFAULT_STREAM_NAME_LEN LTTNG_SYMBOL_NAME_LEN + 8
99 /* Default channel attributes */
100 #define DEFAULT_CHANNEL_NAME "channel0"
101 #define DEFAULT_CHANNEL_OVERWRITE 0 /* usec */
102 /* DEFAULT_CHANNEL_SUBBUF_SIZE must always be a power of 2 */
103 #define DEFAULT_CHANNEL_SUBBUF_SIZE 4096 /* bytes */
104 /* DEFAULT_CHANNEL_SUBBUF_NUM must always be a power of 2 */
105 #define DEFAULT_CHANNEL_SUBBUF_NUM 4
106 #define DEFAULT_CHANNEL_SWITCH_TIMER 0 /* usec */
107 #define DEFAULT_CHANNEL_READ_TIMER 200 /* usec */
108 #define DEFAULT_CHANNEL_OUTPUT LTTNG_EVENT_MMAP
110 #define DEFAULT_METADATA_SUBBUF_SIZE 4096
111 #define DEFAULT_METADATA_SUBBUF_NUM 2
113 /* Kernel has different defaults */
115 /* DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE must always be a power of 2 */
116 #define DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE 262144 /* bytes */
118 * DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM must always be a power of 2.
119 * Update help manually if override.
121 #define DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM DEFAULT_CHANNEL_SUBBUF_NUM
122 /* See lttng-kernel.h enum lttng_kernel_output for channel output */
123 #define DEFAULT_KERNEL_CHANNEL_OUTPUT LTTNG_EVENT_SPLICE
125 /* User space defaults */
127 /* Must be a power of 2 */
128 #define DEFAULT_UST_CHANNEL_SUBBUF_SIZE 4096 /* bytes */
129 /* Must be a power of 2. Update help manuall if override. */
130 #define DEFAULT_UST_CHANNEL_SUBBUF_NUM DEFAULT_CHANNEL_SUBBUF_NUM
131 /* See lttng-ust.h enum lttng_ust_output */
132 #define DEFAULT_UST_CHANNEL_OUTPUT LTTNG_EVENT_MMAP
135 * Default timeout value for the sem_timedwait() call. Blocking forever is not
136 * wanted so a timeout is used to control the data flow and not freeze the
139 #define DEFAULT_SEM_WAIT_TIMEOUT 30 /* in seconds */
141 /* Default network ports for trace streaming support */
142 #define DEFAULT_NETWORK_CONTROL_PORT 5342
143 #define DEFAULT_NETWORK_DATA_PORT 5343
146 * If a thread stalls for this amount of time, it will be considered bogus (bad
149 #define DEFAULT_HEALTH_CHECK_DELTA_S 20
150 #define DEFAULT_HEALTH_CHECK_DELTA_NS 0
153 * Wait period before retrying the lttng_data_pending command in the lttng
154 * stop command of liblttng-ctl.
156 #define DEFAULT_DATA_AVAILABILITY_WAIT_TIME 200000 /* usec */
159 * Default receiving and sending timeout for an application socket.
161 #define DEFAULT_APP_SOCKET_RW_TIMEOUT 5 /* sec */
162 #define DEFAULT_APP_SOCKET_TIMEOUT_ENV "LTTNG_APP_SOCKET_TIMEOUT"
165 extern size_t default_channel_subbuf_size
;
166 extern size_t default_metadata_subbuf_size
;
167 extern size_t default_ust_channel_subbuf_size
;
168 extern size_t default_kernel_channel_subbuf_size
;
172 * Returns the default subbuf size.
174 * This function depends on a value that is set at constructor time, so it is
175 * unsafe to call it from another constructor.
178 size_t default_get_channel_subbuf_size(void)
180 return default_channel_subbuf_size
;
184 * Returns the default metadata subbuf size.
186 * This function depends on a value that is set at constructor time, so it is
187 * unsafe to call it from another constructor.
190 size_t default_get_metadata_subbuf_size(void)
192 return default_metadata_subbuf_size
;
196 * Returns the default subbuf size for the kernel domain.
198 * This function depends on a value that is set at constructor time, so it is
199 * unsafe to call it from another constructor.
202 size_t default_get_kernel_channel_subbuf_size(void)
204 return default_kernel_channel_subbuf_size
;
208 * Returns the default subbuf size for the UST domain.
210 * This function depends on a value that is set at constructor time, so it is
211 * unsafe to call it from another constructor.
214 size_t default_get_ust_channel_subbuf_size(void)
216 return default_ust_channel_subbuf_size
;
219 #endif /* _DEFAULTS_H */