src/common/defaults.h

   1 /*
   2  * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
   3  *                      Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   4  *               2015 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License, version 2 only,
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  13  * more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18  */
  19
  20 #ifndef _DEFAULTS_H
  21 #define _DEFAULTS_H
  22
  23 #include <pthread.h>
  24 #include <src/common/macros.h>
  25
  26 /* Default unix group name for tracing. */
  27 #define DEFAULT_TRACING_GROUP                   "tracing"
  28
  29 /*
  30  * This value is defined in the CTF specification (see
  31  * git://git.efficios.com/ctf.git in the file
  32  * common-trace-format-specification.txt.
  33  */
  34 #define DEFAULT_METADATA_NAME                   "metadata"
  35
  36 /* Environment variable to set session daemon binary path. */
  37 #define DEFAULT_SESSIOND_PATH_ENV               "LTTNG_SESSIOND_PATH"
  38
  39 /* Environment variable to set man pager binary path. */
  40 #define DEFAULT_MAN_BIN_PATH_ENV                "LTTNG_MAN_BIN_PATH"
  41
  42 /* Default man pager binary path. */
  43 #define DEFAULT_MAN_BIN_PATH                    "/usr/bin/man"
  44
  45 /* Default trace output directory name */
  46 #define DEFAULT_TRACE_DIR_NAME                  "lttng-traces"
  47
  48 /* Default size of a hash table */
  49 #define DEFAULT_HT_SIZE                         4
  50
  51 /* Default session daemon paths */
  52 #define DEFAULT_HOME_DIR                                                "/tmp"
  53 #define DEFAULT_UST_SOCK_DIR                    DEFAULT_HOME_DIR "/ust-app-socks"
  54 #define DEFAULT_GLOBAL_APPS_PIPE                DEFAULT_UST_SOCK_DIR "/global"
  55 #define DEFAULT_TRACE_OUTPUT                    DEFAULT_HOME_DIR "/lttng"
  56
  57 /* Default directory where the trace are written in per domain */
  58 #define DEFAULT_KERNEL_TRACE_DIR                "/kernel"
  59 #define DEFAULT_UST_TRACE_DIR                   "/ust"
  60
  61 /* Subpath for per PID or UID sessions. */
  62 #define DEFAULT_UST_TRACE_PID_PATH               "/pid"
  63 #define DEFAULT_UST_TRACE_UID_PATH               "/uid/%d/%u-bit"
  64
  65 /*
  66  * Default session name for the lttng command line. This default value will
  67  * get the date and time appended (%Y%m%d-%H%M%S) to it.
  68  */
  69 #define DEFAULT_SESSION_NAME                    "auto"
  70
  71 /* Default consumer paths */
  72 #define DEFAULT_CONSUMERD_RUNDIR                "%s"
  73
  74 /* Kernel consumer path */
  75 #define DEFAULT_KCONSUMERD_PATH                 DEFAULT_CONSUMERD_RUNDIR "/kconsumerd"
  76 #define DEFAULT_KCONSUMERD_CMD_SOCK_PATH        DEFAULT_KCONSUMERD_PATH "/command"
  77 #define DEFAULT_KCONSUMERD_ERR_SOCK_PATH        DEFAULT_KCONSUMERD_PATH "/error"
  78
  79 /* UST 64-bit consumer path */
  80 #define DEFAULT_USTCONSUMERD64_PATH             DEFAULT_CONSUMERD_RUNDIR "/ustconsumerd64"
  81 #define DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH    DEFAULT_USTCONSUMERD64_PATH "/command"
  82 #define DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH    DEFAULT_USTCONSUMERD64_PATH "/error"
  83
  84 /* UST 32-bit consumer path */
  85 #define DEFAULT_USTCONSUMERD32_PATH             DEFAULT_CONSUMERD_RUNDIR "/ustconsumerd32"
  86 #define DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH    DEFAULT_USTCONSUMERD32_PATH "/command"
  87 #define DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH    DEFAULT_USTCONSUMERD32_PATH "/error"
  88
  89 /* Relayd path */
  90 #define DEFAULT_RELAYD_RUNDIR                   "%s"
  91 #define DEFAULT_RELAYD_PATH                     DEFAULT_RELAYD_RUNDIR "/relayd"
  92
  93 /* Default lttng run directory */
  94 #define DEFAULT_LTTNG_HOME_ENV_VAR              "LTTNG_HOME"
  95 #define DEFAULT_LTTNG_FALLBACK_HOME_ENV_VAR     "HOME"
  96 #define DEFAULT_LTTNG_RUNDIR                    CONFIG_LTTNG_SYSTEM_RUNDIR
  97 #define DEFAULT_LTTNG_HOME_RUNDIR               "%s/.lttng"
  98 #define DEFAULT_LTTNG_SESSIOND_PIDFILE          "lttng-sessiond.pid"
  99 #define DEFAULT_LTTNG_SESSIOND_AGENTPORT_FILE   "agent.port"
 100 #define DEFAULT_LTTNG_SESSIOND_LOCKFILE         "lttng-sessiond.lck"
 101
 102 /* Default probes list */
 103 #define DEFAULT_LTTNG_KMOD_PROBES               "LTTNG_KMOD_PROBES"
 104
 105 /* Default extra probes list */
 106 #define DEFAULT_LTTNG_EXTRA_KMOD_PROBES         "LTTNG_EXTRA_KMOD_PROBES"
 107
 108 /* Default unix socket path */
 109 #define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK         DEFAULT_LTTNG_RUNDIR "/client-lttng-sessiond"
 110 #define DEFAULT_HOME_CLIENT_UNIX_SOCK           DEFAULT_LTTNG_HOME_RUNDIR "/client-lttng-sessiond"
 111 #define DEFAULT_GLOBAL_HEALTH_UNIX_SOCK         DEFAULT_LTTNG_RUNDIR "/sessiond-health"
 112 #define DEFAULT_HOME_HEALTH_UNIX_SOCK           DEFAULT_LTTNG_HOME_RUNDIR "/sessiond-health"
 113
 114 /* Default consumer health unix socket path */
 115 #define DEFAULT_GLOBAL_USTCONSUMER32_HEALTH_UNIX_SOCK   DEFAULT_LTTNG_RUNDIR "/ustconsumerd32/health"
 116 #define DEFAULT_HOME_USTCONSUMER32_HEALTH_UNIX_SOCK     DEFAULT_LTTNG_HOME_RUNDIR "/ustconsumerd32/health"
 117 #define DEFAULT_GLOBAL_USTCONSUMER64_HEALTH_UNIX_SOCK   DEFAULT_LTTNG_RUNDIR "/ustconsumerd64/health"
 118 #define DEFAULT_HOME_USTCONSUMER64_HEALTH_UNIX_SOCK     DEFAULT_LTTNG_HOME_RUNDIR "/ustconsumerd64/health"
 119 #define DEFAULT_GLOBAL_KCONSUMER_HEALTH_UNIX_SOCK       DEFAULT_LTTNG_RUNDIR "/kconsumerd/health"
 120 #define DEFAULT_HOME_KCONSUMER_HEALTH_UNIX_SOCK         DEFAULT_LTTNG_HOME_RUNDIR "/kconsumerd/health"
 121
 122 /* Default relay health unix socket path */
 123 #define DEFAULT_GLOBAL_RELAY_HEALTH_UNIX_SOCK           DEFAULT_LTTNG_RUNDIR "/relayd/health-%d"
 124 #define DEFAULT_HOME_RELAY_HEALTH_UNIX_SOCK             DEFAULT_LTTNG_HOME_RUNDIR "/relayd/health-%d"
 125
 126 /* Default daemon configuration file path */
 127 #define DEFAULT_SYSTEM_CONFIGPATH               CONFIG_LTTNG_SYSTEM_CONFIGDIR \
 128         "/lttng"
 129
 130 #define DEFAULT_DAEMON_CONFIG_FILE              "lttng.conf"
 131 #define DEFAULT_DAEMON_HOME_CONFIGPATH          DEFAULT_LTTNG_HOME_RUNDIR "/" \
 132         DEFAULT_DAEMON_CONFIG_FILE
 133 #define DEFAULT_DAEMON_SYSTEM_CONFIGPATH        DEFAULT_SYSTEM_CONFIGPATH "/" \
 134         DEFAULT_DAEMON_CONFIG_FILE
 135
 136 /* Default session configuration file path */
 137 #define DEFAULT_SESSION_PATH                    "sessions"
 138 /* Auto load session in that directory. */
 139 #define DEFAULT_SESSION_CONFIG_AUTOLOAD         "auto"
 140 #define DEFAULT_SESSION_HOME_CONFIGPATH         DEFAULT_LTTNG_HOME_RUNDIR "/" \
 141         DEFAULT_SESSION_PATH
 142 #define DEFAULT_SESSION_SYSTEM_CONFIGPATH       DEFAULT_SYSTEM_CONFIGPATH "/" \
 143         DEFAULT_SESSION_PATH
 144 #define DEFAULT_SESSION_CONFIG_FILE_EXTENSION   ".lttng"
 145 #define DEFAULT_SESSION_CONFIG_XSD_FILENAME     "session.xsd"
 146 #define DEFAULT_SESSION_CONFIG_XSD_PATH         CONFIG_LTTNG_SYSTEM_DATADIR "/xml/lttng/"
 147 #define DEFAULT_SESSION_CONFIG_XSD_PATH_ENV     "LTTNG_SESSION_CONFIG_XSD_PATH"
 148
 149 #define DEFAULT_GLOBAL_APPS_UNIX_SOCK \
 150         DEFAULT_LTTNG_RUNDIR "/" LTTNG_UST_SOCK_FILENAME
 151 #define DEFAULT_HOME_APPS_UNIX_SOCK \
 152         DEFAULT_LTTNG_HOME_RUNDIR "/" LTTNG_UST_SOCK_FILENAME
 153 #define DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH \
 154         "/" LTTNG_UST_WAIT_FILENAME
 155 #define DEFAULT_HOME_APPS_WAIT_SHM_PATH \
 156         DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH "-%d"
 157
 158 /*
 159  * Value taken from the hard limit allowed by the kernel when using setrlimit
 160  * with RLIMIT_NOFILE on an Intel i7 CPU and Linux 3.0.3.
 161  */
 162 #define DEFAULT_POLL_SIZE 65535
 163
 164 /*
 165  * Format is %s_%d respectively channel name and CPU number. Eigth bytes
 166  * are added here to add space for the CPU number. I guess 2^8 CPUs is more
 167  * than enough. We might end up with quantum computing in a cell phone when
 168  * reaching this limit.
 169  */
 170 #define DEFAULT_STREAM_NAME_LEN        LTTNG_SYMBOL_NAME_LEN + 8
 171
 172 /* Default channel attributes */
 173 #define DEFAULT_CHANNEL_NAME            "channel0"
 174 /* Default JUL domain channel name. */
 175 #define DEFAULT_JUL_CHANNEL_NAME        "lttng_jul_channel"
 176 /* Default JUL tracepoint name. This is a wildcard for the JUL domain. */
 177 #define DEFAULT_JUL_EVENT_COMPONENT     "lttng_jul"
 178 #define DEFAULT_JUL_EVENT_NAME          DEFAULT_JUL_EVENT_COMPONENT ":*"
 179
 180 /* Default log4j domain channel name. */
 181 #define DEFAULT_LOG4J_CHANNEL_NAME        "lttng_log4j_channel"
 182 /* Default log4j tracepoint name. This is a wildcard for the log4j domain. */
 183 #define DEFAULT_LOG4J_EVENT_COMPONENT     "lttng_log4j"
 184 #define DEFAULT_LOG4J_EVENT_NAME          DEFAULT_LOG4J_EVENT_COMPONENT ":*"
 185
 186 /* Default Python domain channel name. */
 187 #define DEFAULT_PYTHON_CHANNEL_NAME       "lttng_python_channel"
 188 /* Default Python tracepoint name. This is a wildcard for the python domain. */
 189 #define DEFAULT_PYTHON_EVENT_COMPONENT    "lttng_python"
 190 #define DEFAULT_PYTHON_EVENT_NAME         DEFAULT_PYTHON_EVENT_COMPONENT ":*"
 191
 192 #define DEFAULT_CHANNEL_OVERWRITE       -1
 193 #define DEFAULT_CHANNEL_TRACEFILE_SIZE  CONFIG_DEFAULT_CHANNEL_TRACEFILE_SIZE
 194 #define DEFAULT_CHANNEL_TRACEFILE_COUNT CONFIG_DEFAULT_CHANNEL_TRACEFILE_COUNT
 195
 196 #define _DEFAULT_CHANNEL_SUBBUF_SIZE   CONFIG_DEFAULT_CHANNEL_SUBBUF_SIZE
 197 #define _DEFAULT_CHANNEL_OUTPUT                 LTTNG_EVENT_MMAP
 198
 199 /* Metadata channel defaults. */
 200 #define DEFAULT_METADATA_SUBBUF_SIZE    CONFIG_DEFAULT_METADATA_SUBBUF_SIZE
 201 #define DEFAULT_METADATA_SUBBUF_NUM     CONFIG_DEFAULT_METADATA_SUBBUF_NUM
 202 #define DEFAULT_METADATA_CACHE_SIZE     CONFIG_DEFAULT_METADATA_CACHE_SIZE
 203 #define DEFAULT_METADATA_SWITCH_TIMER   CONFIG_DEFAULT_METADATA_SWITCH_TIMER
 204 #define DEFAULT_METADATA_READ_TIMER     CONFIG_DEFAULT_METADATA_READ_TIMER
 205 #define DEFAULT_METADATA_OUTPUT                 _DEFAULT_CHANNEL_OUTPUT
 206
 207 /* Kernel has different defaults */
 208
 209 /* DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE must always be a power of 2 */
 210 #define DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE      CONFIG_DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE
 211 /*
 212  * DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM must always be a power of 2.
 213  * Update help manually if override.
 214  */
 215 #define DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM       CONFIG_DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM
 216 /* See lttng-kernel.h enum lttng_kernel_output for channel output */
 217 #define DEFAULT_KERNEL_CHANNEL_OUTPUT                   LTTNG_EVENT_SPLICE
 218 #define DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER     CONFIG_DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER
 219 #define DEFAULT_KERNEL_CHANNEL_READ_TIMER       CONFIG_DEFAULT_KERNEL_CHANNEL_READ_TIMER
 220 #define DEFAULT_KERNEL_CHANNEL_LIVE_TIMER       CONFIG_DEFAULT_KERNEL_CHANNEL_LIVE_TIMER
 221
 222 /* User space defaults */
 223
 224 /* Must be a power of 2 */
 225 #define DEFAULT_UST_PID_CHANNEL_SUBBUF_SIZE     CONFIG_DEFAULT_UST_PID_CHANNEL_SUBBUF_SIZE
 226 #define DEFAULT_UST_UID_CHANNEL_SUBBUF_SIZE     CONFIG_DEFAULT_UST_UID_CHANNEL_SUBBUF_SIZE
 227 /* Must be a power of 2. Update help manuall if override. */
 228 #define DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM      CONFIG_DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM
 229 #define DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM      CONFIG_DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM
 230 /* See lttng-ust.h enum lttng_ust_output */
 231 #define DEFAULT_UST_PID_CHANNEL_OUTPUT                  _DEFAULT_CHANNEL_OUTPUT
 232 #define DEFAULT_UST_UID_CHANNEL_OUTPUT                  _DEFAULT_CHANNEL_OUTPUT
 233 /* Timers in usec. */
 234 #define DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER    CONFIG_DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER
 235 #define DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER    CONFIG_DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER
 236 #define DEFAULT_UST_PID_CHANNEL_LIVE_TIMER      CONFIG_DEFAULT_UST_PID_CHANNEL_LIVE_TIMER
 237 #define DEFAULT_UST_UID_CHANNEL_LIVE_TIMER      CONFIG_DEFAULT_UST_UID_CHANNEL_LIVE_TIMER
 238
 239 #define DEFAULT_UST_PID_CHANNEL_READ_TIMER      CONFIG_DEFAULT_UST_PID_CHANNEL_READ_TIMER
 240 #define DEFAULT_UST_UID_CHANNEL_READ_TIMER      CONFIG_DEFAULT_UST_UID_CHANNEL_READ_TIMER
 241
 242 /*
 243  * Default timeout value for the sem_timedwait() call. Blocking forever is not
 244  * wanted so a timeout is used to control the data flow and not freeze the
 245  * session daemon.
 246  */
 247 #define DEFAULT_SEM_WAIT_TIMEOUT            30    /* in seconds */
 248
 249 /* Default bind addresses for network services. */
 250 #define DEFAULT_NETWORK_CONTROL_BIND_ADDRESS    CONFIG_DEFAULT_NETWORK_CONTROL_BIND_ADDRESS
 251 #define DEFAULT_NETWORK_DATA_BIND_ADDRESS       CONFIG_DEFAULT_NETWORK_DATA_BIND_ADDRESS
 252 #define DEFAULT_NETWORK_VIEWER_BIND_ADDRESS     CONFIG_DEFAULT_NETWORK_VIEWER_BIND_ADDRESS
 253 #define DEFAULT_AGENT_BIND_ADDRESS              CONFIG_DEFAULT_AGENT_BIND_ADDRESS
 254
 255 /* Default network ports for trace streaming support. */
 256 #define DEFAULT_NETWORK_CONTROL_PORT        CONFIG_DEFAULT_NETWORK_CONTROL_PORT
 257 #define DEFAULT_NETWORK_DATA_PORT           CONFIG_DEFAULT_NETWORK_DATA_PORT
 258 #define DEFAULT_NETWORK_VIEWER_PORT         CONFIG_DEFAULT_NETWORK_VIEWER_PORT
 259
 260 /* Agent registration TCP port. */
 261 #define DEFAULT_AGENT_TCP_PORT              CONFIG_DEFAULT_AGENT_TCP_PORT
 262
 263 /*
 264  * If a thread stalls for this amount of time, it will be considered bogus (bad
 265  * health).
 266  */
 267 #define DEFAULT_HEALTH_CHECK_DELTA_S        20
 268 #define DEFAULT_HEALTH_CHECK_DELTA_NS       0
 269
 270 /*
 271  * Wait period before retrying the lttng_data_pending command in the lttng
 272  * stop command of liblttng-ctl.
 273  */
 274 #define DEFAULT_DATA_AVAILABILITY_WAIT_TIME 200000  /* usec */
 275
 276 /*
 277  * Wait period before retrying the lttng_consumer_flushed_cache when
 278  * the consumer receives metadata.
 279  */
 280 #define DEFAULT_METADATA_AVAILABILITY_WAIT_TIME 200000  /* usec */
 281
 282 /*
 283  * The usual value for the maximum TCP SYN retries time and TCP FIN timeout is
 284  * 180 and 60 seconds on most Linux system and the default value since kernel
 285  * 2.2 thus using the highest value. See tcp(7) for more details.
 286  */
 287 #define DEFAULT_INET_TCP_TIMEOUT                        180     /* sec */
 288
 289 /*
 290  * Default receiving and sending timeout for an application socket.
 291  */
 292 #define DEFAULT_APP_SOCKET_RW_TIMEOUT       CONFIG_DEFAULT_APP_SOCKET_RW_TIMEOUT
 293 #define DEFAULT_APP_SOCKET_TIMEOUT_ENV      "LTTNG_APP_SOCKET_TIMEOUT"
 294
 295 #define DEFAULT_UST_STREAM_FD_NUM                       2 /* Number of fd per UST stream. */
 296
 297 #define DEFAULT_SNAPSHOT_NAME                           "snapshot"
 298 #define DEFAULT_SNAPSHOT_MAX_SIZE                       0 /* Unlimited. */
 299
 300 /* Suffix of an index file. */
 301 #define DEFAULT_INDEX_FILE_SUFFIX                       ".idx"
 302 #define DEFAULT_INDEX_DIR                                       "index"
 303
 304 /* Default lttng command live timer value in usec. */
 305 #define DEFAULT_LTTNG_LIVE_TIMER                        CONFIG_DEFAULT_LTTNG_LIVE_TIMER
 306
 307 /* Default runas worker name */
 308 #define DEFAULT_RUN_AS_WORKER_NAME                      "lttng-runas"
 309
 310 /* Default LTTng MI XML namespace. */
 311 #define DEFAULT_LTTNG_MI_NAMESPACE              "http://lttng.org/xml/ns/lttng-mi"
 312
 313 /* Default thread stack size; the default mandated by pthread_create(3) */
 314 #define DEFAULT_LTTNG_THREAD_STACK_SIZE         2097152
 315
 316 /*
 317  * Returns the default subbuf size.
 318  *
 319  * This function depends on a value that is set at constructor time, so it is
 320  * unsafe to call it from another constructor.
 321  */
 322 LTTNG_HIDDEN
 323 size_t default_get_channel_subbuf_size(void);
 324
 325 /*
 326  * Returns the default metadata subbuf size.
 327  *
 328  * This function depends on a value that is set at constructor time, so it is
 329  * unsafe to call it from another constructor.
 330  */
 331 LTTNG_HIDDEN
 332 size_t default_get_metadata_subbuf_size(void);
 333
 334 /*
 335  * Returns the default subbuf size for the kernel domain.
 336  *
 337  * This function depends on a value that is set at constructor time, so it is
 338  * unsafe to call it from another constructor.
 339  */
 340 LTTNG_HIDDEN
 341 size_t default_get_kernel_channel_subbuf_size(void);
 342
 343 /*
 344  * Returns the default subbuf size for the UST domain per PID.
 345  *
 346  * This function depends on a value that is set at constructor time, so it is
 347  * unsafe to call it from another constructor.
 348  */
 349 LTTNG_HIDDEN
 350 size_t default_get_ust_pid_channel_subbuf_size(void);
 351
 352 /*
 353  * Returns the default subbuf size for the UST domain per UID.
 354  *
 355  * This function depends on a value that is set at constructor time, so it is
 356  * unsafe to call it from another constructor.
 357  */
 358 LTTNG_HIDDEN
 359 size_t default_get_ust_uid_channel_subbuf_size(void);
 360
 361 /*
 362  * Get the default pthread_attr to use on thread creation.
 363  *
 364  * Some libc, such as musl, don't honor the limit set for the stack size and use
 365  * their own empirically chosen static value. This function checks if the
 366  * current stack size is smaller than the stack size limit and if so returns a
 367  * pthread_attr_t pointer where the thread stack size is set to the soft stack
 368  * size limit.
 369  */
 370 LTTNG_HIDDEN
 371 pthread_attr_t *default_pthread_attr(void);
 372
 373 #endif /* _DEFAULTS_H */