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 /* Default lttng run directory */
  80 #define DEFAULT_LTTNG_HOME_ENV_VAR              "LTTNG_HOME"
  81 #define DEFAULT_LTTNG_FALLBACK_HOME_ENV_VAR     "HOME"
  82 #define DEFAULT_LTTNG_RUNDIR                    "/var/run/lttng"
  83 #define DEFAULT_LTTNG_HOME_RUNDIR               "%s/.lttng"
  84 #define DEFAULT_LTTNG_SESSIOND_PIDFILE          "lttng-sessiond.pid"
  85
  86 /* Default unix socket path */
  87 #define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK         DEFAULT_LTTNG_RUNDIR "/client-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 #define DEFAULT_GLOBAL_APPS_UNIX_SOCK \
  93         DEFAULT_LTTNG_RUNDIR "/" LTTNG_UST_SOCK_FILENAME
  94 #define DEFAULT_HOME_APPS_UNIX_SOCK \
  95         DEFAULT_LTTNG_HOME_RUNDIR "/" LTTNG_UST_SOCK_FILENAME
  96 #define DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH \
  97         "/" LTTNG_UST_WAIT_FILENAME
  98 #define DEFAULT_HOME_APPS_WAIT_SHM_PATH \
  99         DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH "-%d"
 100
 101 /*
 102  * Value taken from the hard limit allowed by the kernel when using setrlimit
 103  * with RLIMIT_NOFILE on an Intel i7 CPU and Linux 3.0.3.
 104  */
 105 #define DEFAULT_POLL_SIZE 65535
 106
 107 /*
 108  * Format is %s_%d respectively channel name and CPU number. Eigth bytes
 109  * are added here to add space for the CPU number. I guess 2^8 CPUs is more
 110  * than enough. We might end up with quantum computing in a cell phone when
 111  * reaching this limit.
 112  */
 113 #define DEFAULT_STREAM_NAME_LEN        LTTNG_SYMBOL_NAME_LEN + 8
 114
 115 /* Default channel attributes */
 116 #define DEFAULT_CHANNEL_NAME            "channel0"
 117 #define DEFAULT_CHANNEL_OVERWRITE       0
 118 #define DEFAULT_CHANNEL_TRACEFILE_SIZE  0
 119 #define DEFAULT_CHANNEL_TRACEFILE_COUNT 0
 120
 121 /* Must always be a power of 2 */
 122 #define _DEFAULT_CHANNEL_SUBBUF_SIZE    4096    /* bytes */
 123 /* Must always be a power of 2 */
 124 #define _DEFAULT_CHANNEL_SUBBUF_NUM             4
 125 #define _DEFAULT_CHANNEL_SWITCH_TIMER   0       /* usec */
 126 #define _DEFAULT_CHANNEL_READ_TIMER             200000  /* usec */
 127 #define _DEFAULT_CHANNEL_OUTPUT                 LTTNG_EVENT_MMAP
 128
 129 /* Metadata channel defaults. */
 130 #define DEFAULT_METADATA_SUBBUF_SIZE    4096
 131 #define DEFAULT_METADATA_SUBBUF_NUM     2
 132 #define DEFAULT_METADATA_CACHE_SIZE     4096
 133 #define DEFAULT_METADATA_SWITCH_TIMER   _DEFAULT_CHANNEL_SWITCH_TIMER
 134 #define DEFAULT_METADATA_READ_TIMER             0
 135 #define DEFAULT_METADATA_OUTPUT                 _DEFAULT_CHANNEL_OUTPUT
 136
 137 /* Kernel has different defaults */
 138
 139 /* DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE must always be a power of 2 */
 140 #define DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE              262144    /* bytes */
 141 /*
 142  * DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM must always be a power of 2.
 143  * Update help manually if override.
 144  */
 145 #define DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM               _DEFAULT_CHANNEL_SUBBUF_NUM
 146 /* See lttng-kernel.h enum lttng_kernel_output for channel output */
 147 #define DEFAULT_KERNEL_CHANNEL_OUTPUT                   LTTNG_EVENT_SPLICE
 148 #define DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER             _DEFAULT_CHANNEL_SWITCH_TIMER
 149 #define DEFAULT_KERNEL_CHANNEL_READ_TIMER               _DEFAULT_CHANNEL_READ_TIMER
 150
 151 /* User space defaults */
 152
 153 /* Must be a power of 2 */
 154 #define DEFAULT_UST_PID_CHANNEL_SUBBUF_SIZE             _DEFAULT_CHANNEL_SUBBUF_SIZE
 155 #define DEFAULT_UST_UID_CHANNEL_SUBBUF_SIZE             131072  /* bytes */
 156 /* Must be a power of 2. Update help manuall if override. */
 157 #define DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM              _DEFAULT_CHANNEL_SUBBUF_NUM
 158 #define DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM              _DEFAULT_CHANNEL_SUBBUF_NUM
 159 /* See lttng-ust.h enum lttng_ust_output */
 160 #define DEFAULT_UST_PID_CHANNEL_OUTPUT                  _DEFAULT_CHANNEL_OUTPUT
 161 #define DEFAULT_UST_UID_CHANNEL_OUTPUT                  _DEFAULT_CHANNEL_OUTPUT
 162 /* Timers in usec. */
 163 #define DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER    _DEFAULT_CHANNEL_SWITCH_TIMER
 164 #define DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER    _DEFAULT_CHANNEL_SWITCH_TIMER
 165
 166 #define DEFAULT_UST_PID_CHANNEL_READ_TIMER      0  /* usec */
 167 #define DEFAULT_UST_UID_CHANNEL_READ_TIMER      0  /* usec */
 168
 169 /*
 170  * Default timeout value for the sem_timedwait() call. Blocking forever is not
 171  * wanted so a timeout is used to control the data flow and not freeze the
 172  * session daemon.
 173  */
 174 #define DEFAULT_SEM_WAIT_TIMEOUT            30    /* in seconds */
 175
 176 /* Default network ports for trace streaming support */
 177 #define DEFAULT_NETWORK_CONTROL_PORT        5342
 178 #define DEFAULT_NETWORK_DATA_PORT           5343
 179
 180 /*
 181  * If a thread stalls for this amount of time, it will be considered bogus (bad
 182  * health).
 183  */
 184 #define DEFAULT_HEALTH_CHECK_DELTA_S        20
 185 #define DEFAULT_HEALTH_CHECK_DELTA_NS       0
 186
 187 /*
 188  * Wait period before retrying the lttng_data_pending command in the lttng
 189  * stop command of liblttng-ctl.
 190  */
 191 #define DEFAULT_DATA_AVAILABILITY_WAIT_TIME 200000  /* usec */
 192
 193 /*
 194  * Wait period before retrying the lttng_consumer_flushed_cache when
 195  * the consumer receives metadata.
 196  */
 197 #define DEFAULT_METADATA_AVAILABILITY_WAIT_TIME 200000  /* usec */
 198
 199 /*
 200  * Default receiving and sending timeout for an application socket.
 201  */
 202 #define DEFAULT_APP_SOCKET_RW_TIMEOUT       5  /* sec */
 203 #define DEFAULT_APP_SOCKET_TIMEOUT_ENV      "LTTNG_APP_SOCKET_TIMEOUT"
 204
 205 #define DEFAULT_UST_STREAM_FD_NUM                       2 /* Number of fd per UST stream. */
 206
 207 #define DEFAULT_SNAPSHOT_NAME                           "snapshot"
 208 #define DEFAULT_SNAPSHOT_MAX_SIZE                       0 /* Unlimited. */
 209
 210 extern size_t default_channel_subbuf_size;
 211 extern size_t default_metadata_subbuf_size;
 212 extern size_t default_ust_pid_channel_subbuf_size;
 213 extern size_t default_ust_uid_channel_subbuf_size;
 214 extern size_t default_kernel_channel_subbuf_size;
 215
 216 /*
 217  * Returns the default subbuf size.
 218  *
 219  * This function depends on a value that is set at constructor time, so it is
 220  * unsafe to call it from another constructor.
 221  */
 222 static inline
 223 size_t default_get_channel_subbuf_size(void)
 224 {
 225         return default_channel_subbuf_size;
 226 }
 227
 228 /*
 229  * Returns the default metadata subbuf size.
 230  *
 231  * This function depends on a value that is set at constructor time, so it is
 232  * unsafe to call it from another constructor.
 233  */
 234 static inline
 235 size_t default_get_metadata_subbuf_size(void)
 236 {
 237         return default_metadata_subbuf_size;
 238 }
 239
 240 /*
 241  * Returns the default subbuf size for the kernel domain.
 242  *
 243  * This function depends on a value that is set at constructor time, so it is
 244  * unsafe to call it from another constructor.
 245  */
 246 static inline
 247 size_t default_get_kernel_channel_subbuf_size(void)
 248 {
 249         return default_kernel_channel_subbuf_size;
 250 }
 251
 252 /*
 253  * Returns the default subbuf size for the UST domain per PID.
 254  *
 255  * This function depends on a value that is set at constructor time, so it is
 256  * unsafe to call it from another constructor.
 257  */
 258 static inline
 259 size_t default_get_ust_pid_channel_subbuf_size(void)
 260 {
 261         return default_ust_pid_channel_subbuf_size;
 262 }
 263
 264 /*
 265  * Returns the default subbuf size for the UST domain per UID.
 266  *
 267  * This function depends on a value that is set at constructor time, so it is
 268  * unsafe to call it from another constructor.
 269  */
 270 static inline
 271 size_t default_get_ust_uid_channel_subbuf_size(void)
 272 {
 273         return default_ust_uid_channel_subbuf_size;
 274 }
 275
 276 #endif /* _DEFAULTS_H */