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 /* 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 /* Default directory where the trace are written in per domain */
  48 #define DEFAULT_KERNEL_TRACE_DIR                "/kernel"
  49 #define DEFAULT_UST_TRACE_DIR                   "/ust"
  50
  51 /* Subpath for per PID or UID sessions. */
  52 #define DEFAULT_UST_TRACE_PID_PATH               "/pid"
  53 #define DEFAULT_UST_TRACE_UID_PATH               "/uid/%d/%u-bit"
  54
  55 /*
  56  * Default session name for the lttng command line. This default value will
  57  * get the date and time appended (%Y%m%d-%H%M%S) to it.
  58  */
  59 #define DEFAULT_SESSION_NAME                    "auto"
  60
  61 /* Default consumer paths */
  62 #define DEFAULT_CONSUMERD_RUNDIR                "%s"
  63
  64 /* Kernel consumer path */
  65 #define DEFAULT_KCONSUMERD_PATH                 DEFAULT_CONSUMERD_RUNDIR "/kconsumerd"
  66 #define DEFAULT_KCONSUMERD_CMD_SOCK_PATH        DEFAULT_KCONSUMERD_PATH "/command"
  67 #define DEFAULT_KCONSUMERD_ERR_SOCK_PATH        DEFAULT_KCONSUMERD_PATH "/error"
  68
  69 /* UST 64-bit consumer path */
  70 #define DEFAULT_USTCONSUMERD64_PATH             DEFAULT_CONSUMERD_RUNDIR "/ustconsumerd64"
  71 #define DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH    DEFAULT_USTCONSUMERD64_PATH "/command"
  72 #define DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH    DEFAULT_USTCONSUMERD64_PATH "/error"
  73
  74 /* UST 32-bit consumer path */
  75 #define DEFAULT_USTCONSUMERD32_PATH             DEFAULT_CONSUMERD_RUNDIR "/ustconsumerd32"
  76 #define DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH    DEFAULT_USTCONSUMERD32_PATH "/command"
  77 #define DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH    DEFAULT_USTCONSUMERD32_PATH "/error"
  78
  79 /* Relayd path */
  80 #define DEFAULT_RELAYD_RUNDIR                   "%s"
  81 #define DEFAULT_RELAYD_PATH                     DEFAULT_RELAYD_RUNDIR "/relayd"
  82
  83 /* Default lttng run directory */
  84 #define DEFAULT_LTTNG_HOME_ENV_VAR              "LTTNG_HOME"
  85 #define DEFAULT_LTTNG_FALLBACK_HOME_ENV_VAR     "HOME"
  86 #define DEFAULT_LTTNG_RUNDIR                    CONFIG_LTTNG_SYSTEM_RUNDIR
  87 #define DEFAULT_LTTNG_HOME_RUNDIR               "%s/.lttng"
  88 #define DEFAULT_LTTNG_SESSIOND_PIDFILE          "lttng-sessiond.pid"
  89 #define DEFAULT_LTTNG_SESSIOND_AGENTPORT_FILE   "agent.port"
  90 #define DEFAULT_LTTNG_SESSIOND_LOCKFILE         "lttng-sessiond.lck"
  91
  92 /* Default probes list */
  93 #define DEFAULT_LTTNG_KMOD_PROBES               "LTTNG_KMOD_PROBES"
  94
  95 /* Default extra probes list */
  96 #define DEFAULT_LTTNG_EXTRA_KMOD_PROBES         "LTTNG_EXTRA_KMOD_PROBES"
  97
  98 /* Default unix socket path */
  99 #define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK         DEFAULT_LTTNG_RUNDIR "/client-lttng-sessiond"
 100 #define DEFAULT_HOME_CLIENT_UNIX_SOCK           DEFAULT_LTTNG_HOME_RUNDIR "/client-lttng-sessiond"
 101 #define DEFAULT_GLOBAL_HEALTH_UNIX_SOCK         DEFAULT_LTTNG_RUNDIR "/sessiond-health"
 102 #define DEFAULT_HOME_HEALTH_UNIX_SOCK           DEFAULT_LTTNG_HOME_RUNDIR "/sessiond-health"
 103
 104 /* Default consumer health unix socket path */
 105 #define DEFAULT_GLOBAL_USTCONSUMER32_HEALTH_UNIX_SOCK   DEFAULT_LTTNG_RUNDIR "/ustconsumerd32/health"
 106 #define DEFAULT_HOME_USTCONSUMER32_HEALTH_UNIX_SOCK     DEFAULT_LTTNG_HOME_RUNDIR "/ustconsumerd32/health"
 107 #define DEFAULT_GLOBAL_USTCONSUMER64_HEALTH_UNIX_SOCK   DEFAULT_LTTNG_RUNDIR "/ustconsumerd64/health"
 108 #define DEFAULT_HOME_USTCONSUMER64_HEALTH_UNIX_SOCK     DEFAULT_LTTNG_HOME_RUNDIR "/ustconsumerd64/health"
 109 #define DEFAULT_GLOBAL_KCONSUMER_HEALTH_UNIX_SOCK       DEFAULT_LTTNG_RUNDIR "/kconsumerd/health"
 110 #define DEFAULT_HOME_KCONSUMER_HEALTH_UNIX_SOCK         DEFAULT_LTTNG_HOME_RUNDIR "/kconsumerd/health"
 111
 112 /* Default relay health unix socket path */
 113 #define DEFAULT_GLOBAL_RELAY_HEALTH_UNIX_SOCK           DEFAULT_LTTNG_RUNDIR "/relayd/health-%d"
 114 #define DEFAULT_HOME_RELAY_HEALTH_UNIX_SOCK             DEFAULT_LTTNG_HOME_RUNDIR "/relayd/health-%d"
 115
 116 /* Default daemon configuration file path */
 117 #define DEFAULT_SYSTEM_CONFIGPATH               CONFIG_LTTNG_SYSTEM_CONFIGDIR \
 118         "/lttng"
 119
 120 #define DEFAULT_DAEMON_CONFIG_FILE              "lttng.conf"
 121 #define DEFAULT_DAEMON_HOME_CONFIGPATH          DEFAULT_LTTNG_HOME_RUNDIR "/" \
 122         DEFAULT_DAEMON_CONFIG_FILE
 123 #define DEFAULT_DAEMON_SYSTEM_CONFIGPATH        DEFAULT_SYSTEM_CONFIGPATH "/" \
 124         DEFAULT_DAEMON_CONFIG_FILE
 125
 126 /* Default session configuration file path */
 127 #define DEFAULT_SESSION_PATH                    "sessions"
 128 /* Auto load session in that directory. */
 129 #define DEFAULT_SESSION_CONFIG_AUTOLOAD         "auto"
 130 #define DEFAULT_SESSION_HOME_CONFIGPATH         DEFAULT_LTTNG_HOME_RUNDIR "/" \
 131         DEFAULT_SESSION_PATH
 132 #define DEFAULT_SESSION_SYSTEM_CONFIGPATH       DEFAULT_SYSTEM_CONFIGPATH "/" \
 133         DEFAULT_SESSION_PATH
 134 #define DEFAULT_SESSION_CONFIG_FILE_EXTENSION   ".lttng"
 135 #define DEFAULT_SESSION_CONFIG_XSD_FILENAME     "session.xsd"
 136 #define DEFAULT_SESSION_CONFIG_XSD_PATH         CONFIG_LTTNG_SYSTEM_DATADIR "/xml/lttng/"
 137 #define DEFAULT_SESSION_CONFIG_XSD_PATH_ENV     "LTTNG_SESSION_CONFIG_XSD_PATH"
 138
 139 #define DEFAULT_GLOBAL_APPS_UNIX_SOCK \
 140         DEFAULT_LTTNG_RUNDIR "/" LTTNG_UST_SOCK_FILENAME
 141 #define DEFAULT_HOME_APPS_UNIX_SOCK \
 142         DEFAULT_LTTNG_HOME_RUNDIR "/" LTTNG_UST_SOCK_FILENAME
 143 #define DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH \
 144         "/" LTTNG_UST_WAIT_FILENAME
 145 #define DEFAULT_HOME_APPS_WAIT_SHM_PATH \
 146         DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH "-%d"
 147
 148 /*
 149  * Value taken from the hard limit allowed by the kernel when using setrlimit
 150  * with RLIMIT_NOFILE on an Intel i7 CPU and Linux 3.0.3.
 151  */
 152 #define DEFAULT_POLL_SIZE 65535
 153
 154 /*
 155  * Format is %s_%d respectively channel name and CPU number. Eigth bytes
 156  * are added here to add space for the CPU number. I guess 2^8 CPUs is more
 157  * than enough. We might end up with quantum computing in a cell phone when
 158  * reaching this limit.
 159  */
 160 #define DEFAULT_STREAM_NAME_LEN        LTTNG_SYMBOL_NAME_LEN + 8
 161
 162 /* Default channel attributes */
 163 #define DEFAULT_CHANNEL_NAME            "channel0"
 164 /* Default JUL domain channel name. */
 165 #define DEFAULT_JUL_CHANNEL_NAME        "lttng_jul_channel"
 166 /* Default JUL tracepoint name. This is a wildcard for the JUL domain. */
 167 #define DEFAULT_JUL_EVENT_COMPONENT     "lttng_jul"
 168 #define DEFAULT_JUL_EVENT_NAME          DEFAULT_JUL_EVENT_COMPONENT ":*"
 169
 170 /* Default log4j domain channel name. */
 171 #define DEFAULT_LOG4J_CHANNEL_NAME        "lttng_log4j_channel"
 172 /* Default log4j tracepoint name. This is a wildcard for the log4j domain. */
 173 #define DEFAULT_LOG4J_EVENT_COMPONENT     "lttng_log4j"
 174 #define DEFAULT_LOG4J_EVENT_NAME          DEFAULT_LOG4J_EVENT_COMPONENT ":*"
 175
 176 /* Default Python domain channel name. */
 177 #define DEFAULT_PYTHON_CHANNEL_NAME       "lttng_python_channel"
 178 /* Default Python tracepoint name. This is a wildcard for the python domain. */
 179 #define DEFAULT_PYTHON_EVENT_COMPONENT    "lttng_python"
 180 #define DEFAULT_PYTHON_EVENT_NAME         DEFAULT_PYTHON_EVENT_COMPONENT ":*"
 181
 182 #define DEFAULT_CHANNEL_OVERWRITE       0
 183 #define DEFAULT_CHANNEL_TRACEFILE_SIZE  0
 184 #define DEFAULT_CHANNEL_TRACEFILE_COUNT 0
 185
 186 /* Must always be a power of 2 */
 187 #define _DEFAULT_CHANNEL_SUBBUF_SIZE    4096    /* bytes */
 188 /* Must always be a power of 2 */
 189 #define _DEFAULT_CHANNEL_SUBBUF_NUM             4
 190 #define _DEFAULT_CHANNEL_SWITCH_TIMER   0       /* usec */
 191 #define _DEFAULT_CHANNEL_LIVE_TIMER     0       /* usec */
 192 #define _DEFAULT_CHANNEL_READ_TIMER             200000  /* usec */
 193 #define _DEFAULT_CHANNEL_OUTPUT                 LTTNG_EVENT_MMAP
 194
 195 /* Metadata channel defaults. */
 196 #define DEFAULT_METADATA_SUBBUF_SIZE    4096
 197 #define DEFAULT_METADATA_SUBBUF_NUM     2
 198 #define DEFAULT_METADATA_CACHE_SIZE     4096
 199 #define DEFAULT_METADATA_SWITCH_TIMER   _DEFAULT_CHANNEL_SWITCH_TIMER
 200 #define DEFAULT_METADATA_READ_TIMER             0
 201 #define DEFAULT_METADATA_OUTPUT                 _DEFAULT_CHANNEL_OUTPUT
 202
 203 /* Kernel has different defaults */
 204
 205 /* DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE must always be a power of 2 */
 206 #define DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE              262144    /* bytes */
 207 /*
 208  * DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM must always be a power of 2.
 209  * Update help manually if override.
 210  */
 211 #define DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM               _DEFAULT_CHANNEL_SUBBUF_NUM
 212 /* See lttng-kernel.h enum lttng_kernel_output for channel output */
 213 #define DEFAULT_KERNEL_CHANNEL_OUTPUT                   LTTNG_EVENT_SPLICE
 214 #define DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER             _DEFAULT_CHANNEL_SWITCH_TIMER
 215 #define DEFAULT_KERNEL_CHANNEL_READ_TIMER               _DEFAULT_CHANNEL_READ_TIMER
 216 #define DEFAULT_KERNEL_CHANNEL_LIVE_TIMER               _DEFAULT_CHANNEL_LIVE_TIMER
 217
 218 /* User space defaults */
 219
 220 /* Must be a power of 2 */
 221 #define DEFAULT_UST_PID_CHANNEL_SUBBUF_SIZE             _DEFAULT_CHANNEL_SUBBUF_SIZE
 222 #define DEFAULT_UST_UID_CHANNEL_SUBBUF_SIZE             131072  /* bytes */
 223 /* Must be a power of 2. Update help manuall if override. */
 224 #define DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM              _DEFAULT_CHANNEL_SUBBUF_NUM
 225 #define DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM              _DEFAULT_CHANNEL_SUBBUF_NUM
 226 /* See lttng-ust.h enum lttng_ust_output */
 227 #define DEFAULT_UST_PID_CHANNEL_OUTPUT                  _DEFAULT_CHANNEL_OUTPUT
 228 #define DEFAULT_UST_UID_CHANNEL_OUTPUT                  _DEFAULT_CHANNEL_OUTPUT
 229 /* Timers in usec. */
 230 #define DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER    _DEFAULT_CHANNEL_SWITCH_TIMER
 231 #define DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER    _DEFAULT_CHANNEL_SWITCH_TIMER
 232 #define DEFAULT_UST_PID_CHANNEL_LIVE_TIMER      _DEFAULT_CHANNEL_LIVE_TIMER
 233 #define DEFAULT_UST_UID_CHANNEL_LIVE_TIMER      _DEFAULT_CHANNEL_LIVE_TIMER
 234
 235 #define DEFAULT_UST_PID_CHANNEL_READ_TIMER      0  /* usec */
 236 #define DEFAULT_UST_UID_CHANNEL_READ_TIMER      0  /* usec */
 237
 238 /*
 239  * Default timeout value for the sem_timedwait() call. Blocking forever is not
 240  * wanted so a timeout is used to control the data flow and not freeze the
 241  * session daemon.
 242  */
 243 #define DEFAULT_SEM_WAIT_TIMEOUT            30    /* in seconds */
 244
 245 /* Default bind addresses for network services. */
 246 #define DEFAULT_NETWORK_CONTROL_BIND_ADDRESS    "0.0.0.0"
 247 #define DEFAULT_NETWORK_DATA_BIND_ADDRESS       "0.0.0.0"
 248 #define DEFAULT_NETWORK_VIEWER_BIND_ADDRESS     "localhost"
 249 #define DEFAULT_AGENT_BIND_ADDRESS              "localhost"
 250
 251 /* Default network ports for trace streaming support. */
 252 #define DEFAULT_NETWORK_CONTROL_PORT        5342
 253 #define DEFAULT_NETWORK_DATA_PORT           5343
 254 #define DEFAULT_NETWORK_VIEWER_PORT         5344
 255
 256 /* Agent registration TCP port. */
 257 #define DEFAULT_AGENT_TCP_PORT              5345
 258
 259 /*
 260  * If a thread stalls for this amount of time, it will be considered bogus (bad
 261  * health).
 262  */
 263 #define DEFAULT_HEALTH_CHECK_DELTA_S        20
 264 #define DEFAULT_HEALTH_CHECK_DELTA_NS       0
 265
 266 /*
 267  * Wait period before retrying the lttng_data_pending command in the lttng
 268  * stop command of liblttng-ctl.
 269  */
 270 #define DEFAULT_DATA_AVAILABILITY_WAIT_TIME 200000  /* usec */
 271
 272 /*
 273  * Wait period before retrying the lttng_consumer_flushed_cache when
 274  * the consumer receives metadata.
 275  */
 276 #define DEFAULT_METADATA_AVAILABILITY_WAIT_TIME 200000  /* usec */
 277
 278 /*
 279  * The usual value for the maximum TCP SYN retries time and TCP FIN timeout is
 280  * 180 and 60 seconds on most Linux system and the default value since kernel
 281  * 2.2 thus using the highest value. See tcp(7) for more details.
 282  */
 283 #define DEFAULT_INET_TCP_TIMEOUT                        180     /* sec */
 284
 285 /*
 286  * Default receiving and sending timeout for an application socket.
 287  */
 288 #define DEFAULT_APP_SOCKET_RW_TIMEOUT       5  /* sec */
 289 #define DEFAULT_APP_SOCKET_TIMEOUT_ENV      "LTTNG_APP_SOCKET_TIMEOUT"
 290
 291 #define DEFAULT_UST_STREAM_FD_NUM                       2 /* Number of fd per UST stream. */
 292
 293 #define DEFAULT_SNAPSHOT_NAME                           "snapshot"
 294 #define DEFAULT_SNAPSHOT_MAX_SIZE                       0 /* Unlimited. */
 295
 296 /* Suffix of an index file. */
 297 #define DEFAULT_INDEX_FILE_SUFFIX                       ".idx"
 298 #define DEFAULT_INDEX_DIR                                       "index"
 299
 300 /* Default lttng command live timer value in usec. */
 301 #define DEFAULT_LTTNG_LIVE_TIMER                        1000000
 302
 303 /* Default runas worker name */
 304 #define DEFAULT_RUN_AS_WORKER_NAME                      "lttng-runas"
 305
 306 extern size_t default_channel_subbuf_size;
 307 extern size_t default_metadata_subbuf_size;
 308 extern size_t default_ust_pid_channel_subbuf_size;
 309 extern size_t default_ust_uid_channel_subbuf_size;
 310 extern size_t default_kernel_channel_subbuf_size;
 311
 312 /*
 313  * Returns the default subbuf size.
 314  *
 315  * This function depends on a value that is set at constructor time, so it is
 316  * unsafe to call it from another constructor.
 317  */
 318 static inline
 319 size_t default_get_channel_subbuf_size(void)
 320 {
 321         return default_channel_subbuf_size;
 322 }
 323
 324 /*
 325  * Returns the default metadata subbuf size.
 326  *
 327  * This function depends on a value that is set at constructor time, so it is
 328  * unsafe to call it from another constructor.
 329  */
 330 static inline
 331 size_t default_get_metadata_subbuf_size(void)
 332 {
 333         return default_metadata_subbuf_size;
 334 }
 335
 336 /*
 337  * Returns the default subbuf size for the kernel domain.
 338  *
 339  * This function depends on a value that is set at constructor time, so it is
 340  * unsafe to call it from another constructor.
 341  */
 342 static inline
 343 size_t default_get_kernel_channel_subbuf_size(void)
 344 {
 345         return default_kernel_channel_subbuf_size;
 346 }
 347
 348 /*
 349  * Returns the default subbuf size for the UST domain per PID.
 350  *
 351  * This function depends on a value that is set at constructor time, so it is
 352  * unsafe to call it from another constructor.
 353  */
 354 static inline
 355 size_t default_get_ust_pid_channel_subbuf_size(void)
 356 {
 357         return default_ust_pid_channel_subbuf_size;
 358 }
 359
 360 /*
 361  * Returns the default subbuf size for the UST domain per UID.
 362  *
 363  * This function depends on a value that is set at constructor time, so it is
 364  * unsafe to call it from another constructor.
 365  */
 366 static inline
 367 size_t default_get_ust_uid_channel_subbuf_size(void)
 368 {
 369         return default_ust_uid_channel_subbuf_size;
 370 }
 371
 372 #endif /* _DEFAULTS_H */