| 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 | /* Default unix group name for tracing. */ |
| 23 | #define DEFAULT_TRACING_GROUP "tracing" |
| 24 | |
| 25 | /* |
| 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. |
| 29 | */ |
| 30 | #define DEFAULT_METADATA_NAME "metadata" |
| 31 | |
| 32 | /* Environment variable to set session daemon binary path. */ |
| 33 | #define DEFAULT_SESSIOND_PATH_ENV "LTTNG_SESSIOND_PATH" |
| 34 | |
| 35 | /* Default trace output directory name */ |
| 36 | #define DEFAULT_TRACE_DIR_NAME "lttng-traces" |
| 37 | |
| 38 | /* Default size of a hash table */ |
| 39 | #define DEFAULT_HT_SIZE 4 |
| 40 | |
| 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" |
| 46 | |
| 47 | #define DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH "/lttng-ust-apps-wait" |
| 48 | #define DEFAULT_HOME_APPS_WAIT_SHM_PATH "/lttng-ust-apps-wait-%u" |
| 49 | |
| 50 | /* Default directory where the trace are written in per domain */ |
| 51 | #define DEFAULT_KERNEL_TRACE_DIR "/kernel" |
| 52 | #define DEFAULT_UST_TRACE_DIR "/ust" |
| 53 | |
| 54 | /* |
| 55 | * Default session name for the lttng command line. This default value will |
| 56 | * get the date and time appended (%Y%m%d-%H%M%S) to it. |
| 57 | */ |
| 58 | #define DEFAULT_SESSION_NAME "auto" |
| 59 | |
| 60 | /* Default consumer paths */ |
| 61 | #define DEFAULT_CONSUMERD_RUNDIR "%s" |
| 62 | |
| 63 | /* Kernel consumer path */ |
| 64 | #define DEFAULT_KCONSUMERD_PATH DEFAULT_CONSUMERD_RUNDIR "/kconsumerd" |
| 65 | #define DEFAULT_KCONSUMERD_CMD_SOCK_PATH DEFAULT_KCONSUMERD_PATH "/command" |
| 66 | #define DEFAULT_KCONSUMERD_ERR_SOCK_PATH DEFAULT_KCONSUMERD_PATH "/error" |
| 67 | |
| 68 | /* UST 64-bit consumer path */ |
| 69 | #define DEFAULT_USTCONSUMERD64_PATH DEFAULT_CONSUMERD_RUNDIR "/ustconsumerd64" |
| 70 | #define DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH DEFAULT_USTCONSUMERD64_PATH "/command" |
| 71 | #define DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH DEFAULT_USTCONSUMERD64_PATH "/error" |
| 72 | |
| 73 | /* UST 32-bit consumer path */ |
| 74 | #define DEFAULT_USTCONSUMERD32_PATH DEFAULT_CONSUMERD_RUNDIR "/ustconsumerd32" |
| 75 | #define DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH DEFAULT_USTCONSUMERD32_PATH "/command" |
| 76 | #define DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH DEFAULT_USTCONSUMERD32_PATH "/error" |
| 77 | |
| 78 | |
| 79 | /* Default lttng run directory */ |
| 80 | #define DEFAULT_LTTNG_RUNDIR "/var/run/lttng" |
| 81 | #define DEFAULT_LTTNG_HOME_RUNDIR "%s/.lttng" |
| 82 | #define DEFAULT_LTTNG_SESSIOND_PIDFILE "lttng-sessiond.pid" |
| 83 | |
| 84 | /* Default unix socket path */ |
| 85 | #define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/client-lttng-sessiond" |
| 86 | #define DEFAULT_GLOBAL_APPS_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/apps-lttng-sessiond" |
| 87 | #define DEFAULT_HOME_APPS_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/apps-lttng-sessiond" |
| 88 | #define DEFAULT_HOME_CLIENT_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/client-lttng-sessiond" |
| 89 | #define DEFAULT_GLOBAL_HEALTH_UNIX_SOCK DEFAULT_LTTNG_RUNDIR "/health.sock" |
| 90 | #define DEFAULT_HOME_HEALTH_UNIX_SOCK DEFAULT_LTTNG_HOME_RUNDIR "/health.sock" |
| 91 | |
| 92 | /* |
| 93 | * Value taken from the hard limit allowed by the kernel when using setrlimit |
| 94 | * with RLIMIT_NOFILE on an Intel i7 CPU and Linux 3.0.3. |
| 95 | */ |
| 96 | #define DEFAULT_POLL_SIZE 65535 |
| 97 | |
| 98 | /* |
| 99 | * Format is %s_%d respectively channel name and CPU number. Eigth bytes |
| 100 | * are added here to add space for the CPU number. I guess 2^8 CPUs is more |
| 101 | * than enough. We might end up with quantum computing in a cell phone when |
| 102 | * reaching this limit. |
| 103 | */ |
| 104 | #define DEFAULT_STREAM_NAME_LEN LTTNG_SYMBOL_NAME_LEN + 8 |
| 105 | |
| 106 | /* Default channel attributes */ |
| 107 | #define DEFAULT_CHANNEL_NAME "channel0" |
| 108 | #define DEFAULT_CHANNEL_OVERWRITE 0 /* usec */ |
| 109 | /* DEFAULT_CHANNEL_SUBBUF_SIZE must always be a power of 2 */ |
| 110 | #define DEFAULT_CHANNEL_SUBBUF_SIZE 4096 /* bytes */ |
| 111 | /* DEFAULT_CHANNEL_SUBBUF_NUM must always be a power of 2 */ |
| 112 | #define DEFAULT_CHANNEL_SUBBUF_NUM 4 |
| 113 | #define DEFAULT_CHANNEL_SWITCH_TIMER 0 /* usec */ |
| 114 | #define DEFAULT_CHANNEL_READ_TIMER 200 /* usec */ |
| 115 | #define DEFAULT_CHANNEL_OUTPUT LTTNG_EVENT_MMAP |
| 116 | |
| 117 | #define DEFAULT_METADATA_SUBBUF_SIZE 4096 |
| 118 | #define DEFAULT_METADATA_SUBBUF_NUM 2 |
| 119 | |
| 120 | /* Kernel has different defaults */ |
| 121 | |
| 122 | /* DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE must always be a power of 2 */ |
| 123 | #define DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE 262144 /* bytes */ |
| 124 | /* |
| 125 | * DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM must always be a power of 2. |
| 126 | * Update help manually if override. |
| 127 | */ |
| 128 | #define DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM DEFAULT_CHANNEL_SUBBUF_NUM |
| 129 | /* See lttng-kernel.h enum lttng_kernel_output for channel output */ |
| 130 | #define DEFAULT_KERNEL_CHANNEL_OUTPUT LTTNG_EVENT_SPLICE |
| 131 | |
| 132 | /* User space defaults */ |
| 133 | |
| 134 | /* Must be a power of 2 */ |
| 135 | #define DEFAULT_UST_CHANNEL_SUBBUF_SIZE 4096 /* bytes */ |
| 136 | /* Must be a power of 2. Update help manuall if override. */ |
| 137 | #define DEFAULT_UST_CHANNEL_SUBBUF_NUM DEFAULT_CHANNEL_SUBBUF_NUM |
| 138 | /* See lttng-ust.h enum lttng_ust_output */ |
| 139 | #define DEFAULT_UST_CHANNEL_OUTPUT LTTNG_EVENT_MMAP |
| 140 | |
| 141 | /* |
| 142 | * Default timeout value for the sem_timedwait() call. Blocking forever is not |
| 143 | * wanted so a timeout is used to control the data flow and not freeze the |
| 144 | * session daemon. |
| 145 | */ |
| 146 | #define DEFAULT_SEM_WAIT_TIMEOUT 30 /* in seconds */ |
| 147 | |
| 148 | /* Default network ports for trace streaming support */ |
| 149 | #define DEFAULT_NETWORK_CONTROL_PORT 5342 |
| 150 | #define DEFAULT_NETWORK_DATA_PORT 5343 |
| 151 | |
| 152 | /* |
| 153 | * If a thread stalls for this amount of time, it will be considered bogus (bad |
| 154 | * health). |
| 155 | */ |
| 156 | #define DEFAULT_HEALTH_CHECK_DELTA_S 20 |
| 157 | #define DEFAULT_HEALTH_CHECK_DELTA_NS 0 |
| 158 | |
| 159 | /* |
| 160 | * Wait period before retrying the lttng_data_pending command in the lttng |
| 161 | * stop command of liblttng-ctl. |
| 162 | */ |
| 163 | #define DEFAULT_DATA_AVAILABILITY_WAIT_TIME 200000 /* usec */ |
| 164 | |
| 165 | /* |
| 166 | * Default receiving and sending timeout for an application socket. |
| 167 | */ |
| 168 | #define DEFAULT_APP_SOCKET_RW_TIMEOUT 5 /* sec */ |
| 169 | #define DEFAULT_APP_SOCKET_TIMEOUT_ENV "LTTNG_APP_SOCKET_TIMEOUT" |
| 170 | |
| 171 | |
| 172 | extern size_t default_channel_subbuf_size; |
| 173 | extern size_t default_metadata_subbuf_size; |
| 174 | extern size_t default_ust_channel_subbuf_size; |
| 175 | extern size_t default_kernel_channel_subbuf_size; |
| 176 | |
| 177 | |
| 178 | /* |
| 179 | * Returns the default subbuf size. |
| 180 | * |
| 181 | * This function depends on a value that is set at constructor time, so it is |
| 182 | * unsafe to call it from another constructor. |
| 183 | */ |
| 184 | static inline |
| 185 | size_t default_get_channel_subbuf_size(void) |
| 186 | { |
| 187 | return default_channel_subbuf_size; |
| 188 | } |
| 189 | |
| 190 | /* |
| 191 | * Returns the default metadata subbuf size. |
| 192 | * |
| 193 | * This function depends on a value that is set at constructor time, so it is |
| 194 | * unsafe to call it from another constructor. |
| 195 | */ |
| 196 | static inline |
| 197 | size_t default_get_metadata_subbuf_size(void) |
| 198 | { |
| 199 | return default_metadata_subbuf_size; |
| 200 | } |
| 201 | |
| 202 | /* |
| 203 | * Returns the default subbuf size for the kernel domain. |
| 204 | * |
| 205 | * This function depends on a value that is set at constructor time, so it is |
| 206 | * unsafe to call it from another constructor. |
| 207 | */ |
| 208 | static inline |
| 209 | size_t default_get_kernel_channel_subbuf_size(void) |
| 210 | { |
| 211 | return default_kernel_channel_subbuf_size; |
| 212 | } |
| 213 | |
| 214 | /* |
| 215 | * Returns the default subbuf size for the UST domain. |
| 216 | * |
| 217 | * This function depends on a value that is set at constructor time, so it is |
| 218 | * unsafe to call it from another constructor. |
| 219 | */ |
| 220 | static inline |
| 221 | size_t default_get_ust_channel_subbuf_size(void) |
| 222 | { |
| 223 | return default_ust_channel_subbuf_size; |
| 224 | } |
| 225 | |
| 226 | #endif /* _DEFAULTS_H */ |