Add default subbuf sizes getter functions
[lttng-tools.git] / src / common / defaults.h
CommitLineData
9bda164d 1/*
e848fc76
DG
2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
9bda164d 4 *
d14d33bf
AM
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.
9bda164d 8 *
e848fc76
DG
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
d14d33bf 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
e848fc76 12 * more details.
9bda164d 13 *
d14d33bf
AM
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.
9bda164d
DG
17 */
18
990570ed
DG
19#ifndef _DEFAULTS_H
20#define _DEFAULTS_H
e848fc76 21
bbccc3d2
DG
22/* Default unix group name for tracing. */
23#define DEFAULT_TRACING_GROUP "tracing"
24
25/* Environment variable to set session daemon binary path. */
26#define DEFAULT_SESSIOND_PATH_ENV "LTTNG_SESSIOND_PATH"
27
28/* Default trace output directory name */
29#define DEFAULT_TRACE_DIR_NAME "lttng-traces"
30
f6a9efaa 31/* Default size of a hash table */
60922cb0
DG
32#define DEFAULT_HT_SIZE 4
33
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"
39
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"
42
00e2e675
DG
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"
46
a4b92340
DG
47/*
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.
50 */
07424f16 51#define DEFAULT_SESSION_NAME "auto"
a4b92340 52
60922cb0
DG
53/* Default consumer paths */
54#define DEFAULT_CONSUMERD_RUNDIR "%s"
55
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"
60
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"
65
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"
70
f6a9efaa 71
990570ed 72/* Default lttng run directory */
60922cb0
DG
73#define DEFAULT_LTTNG_RUNDIR "/var/run/lttng"
74#define DEFAULT_LTTNG_HOME_RUNDIR "%s/.lttng"
990570ed
DG
75
76/* Default unix socket path */
60922cb0
DG
77#define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/client-lttng-sessiond"
78#define DEFAULT_GLOBAL_APPS_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/apps-lttng-sessiond"
79#define DEFAULT_HOME_APPS_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/apps-lttng-sessiond"
80#define DEFAULT_HOME_CLIENT_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/client-lttng-sessiond"
44a5e5eb
DG
81#define DEFAULT_GLOBAL_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/health.sock"
82#define DEFAULT_HOME_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/health.sock"
990570ed
DG
83
84/*
85 * Value taken from the hard limit allowed by the kernel when using setrlimit
86 * with RLIMIT_NOFILE on an Intel i7 CPU and Linux 3.0.3.
87 */
88#define DEFAULT_POLL_SIZE 65535
89
ce2a9e76
DG
90/*
91 * Format is %s_%d respectively channel name and CPU number. Eigth bytes
92 * are added here to add space for the CPU number. I guess 2^8 CPUs is more
93 * than enough. We might end up with quantum computing in a cell phone when
94 * reaching this limit.
95 */
96#define DEFAULT_STREAM_NAME_LEN LTTNG_SYMBOL_NAME_LEN + 8
97
f3ed775e 98/* Default channel attributes */
3817e7df
DG
99#define DEFAULT_CHANNEL_NAME "channel0"
100#define DEFAULT_CHANNEL_OVERWRITE 0 /* usec */
7d452e12 101/* DEFAULT_CHANNEL_SUBBUF_SIZE must always be a power of 2 */
3817e7df 102#define DEFAULT_CHANNEL_SUBBUF_SIZE 4096 /* bytes */
7d452e12 103/* DEFAULT_CHANNEL_SUBBUF_NUM must always be a power of 2 */
9f778c9a 104#define DEFAULT_CHANNEL_SUBBUF_NUM 4
3817e7df 105#define DEFAULT_CHANNEL_SWITCH_TIMER 0 /* usec */
b389abbe 106#define DEFAULT_CHANNEL_READ_TIMER 200 /* usec */
3817e7df 107#define DEFAULT_CHANNEL_OUTPUT LTTNG_EVENT_MMAP
b389abbe 108
3817e7df
DG
109#define DEFAULT_METADATA_SUBBUF_SIZE 4096
110#define DEFAULT_METADATA_SUBBUF_NUM 2
e6ddca71 111
b389abbe
MD
112/* Kernel has different defaults */
113
114/* DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE must always be a power of 2 */
3817e7df 115#define DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE 262144 /* bytes */
9f778c9a
MD
116/*
117 * DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM must always be a power of 2.
118 * Update help manually if override.
119 */
120#define DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM DEFAULT_CHANNEL_SUBBUF_NUM
b389abbe 121/* See lttng-kernel.h enum lttng_kernel_output for channel output */
3817e7df 122#define DEFAULT_KERNEL_CHANNEL_OUTPUT LTTNG_EVENT_SPLICE
f3ed775e 123
0b0dd29a
DG
124/* User space defaults */
125
126/* Must be a power of 2 */
127#define DEFAULT_UST_CHANNEL_SUBBUF_SIZE 4096 /* bytes */
9f778c9a
MD
128/* Must be a power of 2. Update help manuall if override. */
129#define DEFAULT_UST_CHANNEL_SUBBUF_NUM DEFAULT_CHANNEL_SUBBUF_NUM
28ca4a8b 130/* See lttng-ust.h enum lttng_ust_output */
d41f73b7 131#define DEFAULT_UST_CHANNEL_OUTPUT LTTNG_EVENT_MMAP
0b0dd29a 132
ee0b0061
DG
133/*
134 * Default timeout value for the sem_timedwait() call. Blocking forever is not
135 * wanted so a timeout is used to control the data flow and not freeze the
136 * session daemon.
137 */
138#define DEFAULT_SEM_WAIT_TIMEOUT 30 /* in seconds */
139
3a5713da
DG
140/* Default network ports for trace streaming support */
141#define DEFAULT_NETWORK_CONTROL_PORT 5342
142#define DEFAULT_NETWORK_DATA_PORT 5343
143
8809eec0
MD
144/*
145 * If a thread stalls for this amount of time, it will be considered bogus (bad
146 * health).
147 */
148#define DEFAULT_HEALTH_CHECK_DELTA_S 20
149#define DEFAULT_HEALTH_CHECK_DELTA_NS 0
150
38ee087f 151/*
6d805429 152 * Wait period before retrying the lttng_data_pending command in the lttng
38ee087f
DG
153 * stop command of liblttng-ctl.
154 */
155#define DEFAULT_DATA_AVAILABILITY_WAIT_TIME 200000 /* usec */
156
ae9e45b3
DG
157/*
158 * Default receiving and sending timeout for an application socket.
159 */
160#define DEFAULT_APP_SOCKET_RW_TIMEOUT 5 /* sec */
161#define DEFAULT_APP_SOCKET_TIMEOUT_ENV "LTTNG_APP_SOCKET_TIMEOUT"
162
8b3bd7a3
SM
163
164extern size_t default_channel_subbuf_size;
165extern size_t default_metadata_subbuf_size;
166extern size_t default_ust_channel_subbuf_size;
167extern size_t default_kernel_channel_subbuf_size;
168
169
170/*
171 * Returns the default subbuf size.
172 *
173 * This function depends on a value that is set at constructor time, so it is
174 * unsafe to call it from another constructor.
175 */
176static inline
177size_t default_get_channel_subbuf_size(void)
178{
179 return default_channel_subbuf_size;
180}
181
182/*
183 * Returns the default metadata subbuf size.
184 *
185 * This function depends on a value that is set at constructor time, so it is
186 * unsafe to call it from another constructor.
187 */
188static inline
189size_t default_get_metadata_subbuf_size(void)
190{
191 return default_metadata_subbuf_size;
192}
193
194/*
195 * Returns the default subbuf size for the kernel domain.
196 *
197 * This function depends on a value that is set at constructor time, so it is
198 * unsafe to call it from another constructor.
199 */
200static inline
201size_t default_get_kernel_channel_subbuf_size(void)
202{
203 return default_kernel_channel_subbuf_size;
204}
205
206/*
207 * Returns the default subbuf size for the UST domain.
208 *
209 * This function depends on a value that is set at constructor time, so it is
210 * unsafe to call it from another constructor.
211 */
212static inline
213size_t default_get_ust_channel_subbuf_size(void)
214{
215 return default_ust_channel_subbuf_size;
216}
217
990570ed 218#endif /* _DEFAULTS_H */
This page took 0.058727 seconds and 4 git commands to generate.