docs/envvars.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html lang="en">
   3 <head>
   4   <meta http-equiv="content-type" content="text/html; charset=utf-8">
   5   <title>Environment Variables</title>
   6   <link rel="stylesheet" type="text/css" href="mesa.css">
   7 </head>
   8 <body>
   9
  10 <div class="header">
  11   <h1>The Mesa 3D Graphics Library</h1>
  12 </div>
  13
  14 <iframe src="contents.html"></iframe>
  15 <div class="content">
  16
  17 <h1>Environment Variables</h1>
  18
  19 <p>
  20 Normally, no environment variables need to be set.  Most of the environment
  21 variables used by Mesa/Gallium are for debugging purposes, but they can
  22 sometimes be useful for debugging end-user issues.
  23 </p>
  24
  25
  26 <h2>LibGL environment variables</h2>
  27
  28 <ul>
  29 <li>LIBGL_DEBUG - If defined debug information will be printed to stderr.
  30    If set to 'verbose' additional information will be printed.
  31 <li>LIBGL_DRIVERS_PATH - colon-separated list of paths to search for DRI drivers
  32 <li>LIBGL_ALWAYS_INDIRECT - if set to `true`, forces an indirect rendering context/connection.
  33 <li>LIBGL_ALWAYS_SOFTWARE - if set to `true`, always use software rendering
  34 <li>LIBGL_NO_DRAWARRAYS - if set to `true`, do not use DrawArrays GLX protocol (for debugging)
  35 <li>LIBGL_SHOW_FPS - print framerate to stdout based on the number of glXSwapBuffers
  36     calls per second.
  37 <li>LIBGL_DRI3_DISABLE - disable DRI3 if set to `true`.
  38 </ul>
  39
  40
  41
  42 <h2>Core Mesa environment variables</h2>
  43
  44 <ul>
  45 <li>MESA_NO_ASM - if set, disables all assembly language optimizations
  46 <li>MESA_NO_MMX - if set, disables Intel MMX optimizations
  47 <li>MESA_NO_3DNOW - if set, disables AMD 3DNow! optimizations
  48 <li>MESA_NO_SSE - if set, disables Intel SSE optimizations
  49 <li>MESA_NO_ERROR - if set to 1, error checking is disabled as per KHR_no_error.
  50    This will result in undefined behaviour for invalid use of the api, but
  51    can reduce CPU use for apps that are known to be error free.</li>
  52 <li>MESA_DEBUG - if set, error messages are printed to stderr.  For example,
  53    if the application generates a GL_INVALID_ENUM error, a corresponding error
  54    message indicating where the error occurred, and possibly why, will be
  55    printed to stderr.<br>
  56
  57    For release builds, MESA_DEBUG defaults to off (no debug output).
  58
  59    MESA_DEBUG accepts the following comma-separated list of named
  60    flags, which adds extra behaviour to just set MESA_DEBUG=1:
  61    <ul>
  62      <li>silent - turn off debug messages. Only useful for debug builds.</li>
  63      <li>flush - flush after each drawing command</li>
  64      <li>incomplete_tex - extra debug messages when a texture is incomplete</li>
  65      <li>incomplete_fbo - extra debug messages when a fbo is incomplete</li>
  66      <li>context - create a debug context (see GLX_CONTEXT_DEBUG_BIT_ARB) and
  67          print error and performance messages to stderr (or MESA_LOG_FILE).</li>
  68    </ul>
  69 <li>MESA_LOG_FILE - specifies a file name for logging all errors, warnings,
  70 etc., rather than stderr
  71 <li>MESA_TEX_PROG - if set, implement conventional texture env modes with
  72 fragment programs (intended for developers only)
  73 <li>MESA_TNL_PROG - if set, implement conventional vertex transformation
  74 operations with vertex programs (intended for developers only).
  75 Setting this variable automatically sets the MESA_TEX_PROG variable as well.
  76 <li>MESA_EXTENSION_OVERRIDE - can be used to enable/disable extensions.
  77 A value such as "GL_EXT_foo -GL_EXT_bar" will enable the GL_EXT_foo extension
  78 and disable the GL_EXT_bar extension.
  79 <li>MESA_EXTENSION_MAX_YEAR - The GL_EXTENSIONS string returned by Mesa is sorted
  80 by extension year.
  81 If this variable is set to year X, only extensions defined on or before year
  82 X will be reported.
  83 This is to work-around a bug in some games where the extension string is
  84 copied into a fixed-size buffer without truncating.
  85 If the extension string is too long, the buffer overrun can cause the game
  86 to crash.
  87 This is a work-around for that.
  88 <li>MESA_GL_VERSION_OVERRIDE - changes the value returned by
  89 glGetString(GL_VERSION) and possibly the GL API type.
  90 <ul>
  91 <li> The format should be MAJOR.MINOR[FC]
  92 <li> FC is an optional suffix that indicates a forward compatible context.
  93 This is only valid for versions &gt;= 3.0.
  94 <li> GL versions &lt; 3.0 are set to a compatibility (non-Core) profile
  95 <li> GL versions = 3.0, see below
  96 <li> GL versions &gt; 3.0 are set to a Core profile
  97 <li> Examples: 2.1, 3.0, 3.0FC, 3.1, 3.1FC
  98 <ul>
  99 <li> 2.1 - select a compatibility (non-Core) profile with GL version 2.1
 100 <li> 3.0 - select a compatibility (non-Core) profile with GL version 3.0
 101 <li> 3.0FC - select a Core+Forward Compatible profile with GL version 3.0
 102 <li> 3.1 - select a Core profile with GL version 3.1
 103 <li> 3.1FC - select a Core+Forward Compatible profile with GL version 3.1
 104 </ul>
 105 <li> Mesa may not really implement all the features of the given version.
 106 (for developers only)
 107 </ul>
 108 <li>MESA_GLES_VERSION_OVERRIDE - changes the value returned by
 109 glGetString(GL_VERSION) for OpenGL ES.
 110 <ul>
 111 <li> The format should be MAJOR.MINOR
 112 <li> Examples: 2.0, 3.0, 3.1
 113 <li> Mesa may not really implement all the features of the given version.
 114 (for developers only)
 115 </ul>
 116 <li>MESA_GLSL_VERSION_OVERRIDE - changes the value returned by
 117 glGetString(GL_SHADING_LANGUAGE_VERSION). Valid values are integers, such as
 118 "130".  Mesa will not really implement all the features of the given language version
 119 if it's higher than what's normally reported. (for developers only)
 120 <li>MESA_GLSL_CACHE_DISABLE - if set to `true`, disables the GLSL shader cache
 121 <li>MESA_GLSL_CACHE_MAX_SIZE - if set, determines the maximum size of
 122 the on-disk cache of compiled GLSL programs. Should be set to a number
 123 optionally followed by 'K', 'M', or 'G' to specify a size in
 124 kilobytes, megabytes, or gigabytes. By default, gigabytes will be
 125 assumed. And if unset, a maximum size of 1GB will be used. Note: A separate
 126 cache might be created for each architecture that Mesa is installed for on
 127 your system. For example under the default settings you may end up with a 1GB
 128 cache for x86_64 and another 1GB cache for i386.
 129 <li>MESA_GLSL_CACHE_DIR - if set, determines the directory to be used
 130 for the on-disk cache of compiled GLSL programs. If this variable is
 131 not set, then the cache will be stored in $XDG_CACHE_HOME/mesa (if
 132 that variable is set), or else within .cache/mesa within the user's
 133 home directory.
 134 <li>MESA_GLSL - <a href="shading.html#envvars">shading language compiler options</a>
 135 <li>MESA_NO_MINMAX_CACHE - when set, the minmax index cache is globally disabled.
 136 <li>MESA_SHADER_CAPTURE_PATH - see <a href="shading.html#capture">Capturing Shaders</a></li>
 137 <li>MESA_SHADER_DUMP_PATH and MESA_SHADER_READ_PATH - see <a href="shading.html#replacement">Experimenting with Shader Replacements</a></li>
 138 <li>MESA_VK_VERSION_OVERRIDE - changes the Vulkan physical device version
 139     as returned in VkPhysicalDeviceProperties::apiVersion.
 140   <ul>
 141     <li>The format should be MAJOR.MINOR[.PATCH]</li>
 142     <li>This will not let you force a version higher than the driver's
 143         instance versionas advertised by vkEnumerateInstanceVersion</li>
 144     <li>This can be very useful for debugging but some features may not be
 145         implemented correctly. (For developers only)</li>
 146   </ul>
 147 </li>
 148 </ul>
 149
 150
 151 <h2>Mesa Xlib driver environment variables</h2>
 152
 153 <p>
 154 The following are only applicable to the Mesa Xlib software driver.
 155 See the <a href="xlibdriver.html">Xlib software driver page</a> for details.
 156 </p>
 157 <ul>
 158 <li>MESA_RGB_VISUAL - specifies the X visual and depth for RGB mode
 159 <li>MESA_CI_VISUAL - specifies the X visual and depth for CI mode
 160 <li>MESA_BACK_BUFFER - specifies how to implement the back color buffer,
 161     either "pixmap" or "ximage"
 162 <li>MESA_GAMMA - gamma correction coefficients for red, green, blue channels
 163 <li>MESA_XSYNC - enable synchronous X behavior (for debugging only)
 164 <li>MESA_GLX_FORCE_CI - if set, force GLX to treat 8bpp visuals as CI visuals
 165 <li>MESA_GLX_FORCE_ALPHA - if set, forces RGB windows to have an alpha channel.
 166 <li>MESA_GLX_DEPTH_BITS - specifies default number of bits for depth buffer.
 167 <li>MESA_GLX_ALPHA_BITS - specifies default number of bits for alpha channel.
 168 </ul>
 169
 170
 171 <h2>i945/i965 driver environment variables (non-Gallium)</h2>
 172
 173 <ul>
 174 <li>INTEL_NO_HW - if set to 1, prevents batches from being submitted to the hardware.
 175    This is useful for debugging hangs, etc.</li>
 176 <li>INTEL_DEBUG - a comma-separated list of named flags, which do various things:
 177 <ul>
 178    <li>ann - annotate IR in assembly dumps</li>
 179    <li>aub - dump batches into an AUB trace for use with simulation tools</li>
 180    <li>bat - emit batch information</li>
 181    <li>blit - emit messages about blit operations</li>
 182    <li>blorp - emit messages about the blorp operations (blits &amp; clears)</li>
 183    <li>buf - emit messages about buffer objects</li>
 184    <li>clip - emit messages about the clip unit (for old gens, includes the CLIP program)</li>
 185    <li>color - use color in output</li>
 186    <li>cs - dump shader assembly for compute shaders</li>
 187    <li>do32 - generate compute shader SIMD32 programs even if workgroup size doesn't exceed the SIMD16 limit</li>
 188    <li>dri - emit messages about the DRI interface</li>
 189    <li>fbo - emit messages about framebuffers</li>
 190    <li>fs - dump shader assembly for fragment shaders</li>
 191    <li>gs - dump shader assembly for geometry shaders</li>
 192    <li>hex - print instruction hex dump with the disassembly</li>
 193    <li>l3 - emit messages about the new L3 state during transitions</li>
 194    <li>miptree - emit messages about miptrees</li>
 195    <li>no8 - don't generate SIMD8 fragment shader</li>
 196    <li>no16 - suppress generation of 16-wide fragment shaders. useful for debugging broken shaders</li>
 197    <li>nocompact - disable instruction compaction</li>
 198    <li>nodualobj - suppress generation of dual-object geometry shader code</li>
 199    <li>norbc - disable single sampled render buffer compression</li>
 200    <li>optimizer - dump shader assembly to files at each optimization pass and iteration that make progress</li>
 201    <li>perf - emit messages about performance issues</li>
 202    <li>perfmon - emit messages about AMD_performance_monitor</li>
 203    <li>pix - emit messages about pixel operations</li>
 204    <li>prim - emit messages about drawing primitives</li>
 205    <li>reemit - mark all state dirty on each draw call</li>
 206    <li>sf - emit messages about the strips &amp; fans unit (for old gens, includes the SF program)</li>
 207    <li>shader_time - record how much GPU time is spent in each shader</li>
 208    <li>spill_fs - force spilling of all registers in the scalar backend (useful to debug spilling code)</li>
 209    <li>spill_vec4 - force spilling of all registers in the vec4 backend (useful to debug spilling code)</li>
 210    <li>state - emit messages about state flag tracking</li>
 211    <li>submit - emit batchbuffer usage statistics</li>
 212    <li>sync - after sending each batch, emit a message and wait for that batch to finish rendering</li>
 213    <li>tcs - dump shader assembly for tessellation control shaders</li>
 214    <li>tes - dump shader assembly for tessellation evaluation shaders</li>
 215    <li>tex - emit messages about textures.</li>
 216    <li>urb - emit messages about URB setup</li>
 217    <li>vert - emit messages about vertex assembly</li>
 218    <li>vs - dump shader assembly for vertex shaders</li>
 219 </ul>
 220 <li>INTEL_SCALAR_VS (or TCS, TES, GS) - force scalar/vec4 mode for a shader stage (Gen8-9 only)</li>
 221 <li>INTEL_PRECISE_TRIG - if set to 1, true or yes, then the driver prefers
 222    accuracy over performance in trig functions.</li>
 223 </ul>
 224
 225
 226 <h2>Radeon driver environment variables (radeon, r200, and r300g)</h2>
 227
 228 <ul>
 229 <li>RADEON_NO_TCL - if set, disable hardware-accelerated Transform/Clip/Lighting.
 230 </ul>
 231
 232
 233 <h2>EGL environment variables</h2>
 234
 235 <p>
 236 Mesa EGL supports different sets of environment variables.  See the
 237 <a href="egl.html">Mesa EGL</a> page for the details.
 238 </p>
 239
 240
 241 <h2>Gallium environment variables</h2>
 242
 243 <ul>
 244 <li>GALLIUM_HUD - draws various information on the screen, like framerate,
 245     cpu load, driver statistics, performance counters, etc.
 246     Set GALLIUM_HUD=help and run e.g. glxgears for more info.
 247 <li>GALLIUM_HUD_PERIOD - sets the hud update rate in seconds (float). Use zero
 248     to update every frame. The default period is 1/2 second.
 249 <li>GALLIUM_HUD_VISIBLE - control default visibility, defaults to true.
 250 <li>GALLIUM_HUD_TOGGLE_SIGNAL - toggle visibility via user specified signal.
 251     Especially useful to toggle hud at specific points of application and
 252     disable for unencumbered viewing the rest of the time. For example, set
 253     GALLIUM_HUD_VISIBLE to false and GALLIUM_HUD_TOGGLE_SIGNAL to 10 (SIGUSR1).
 254     Use kill -10 <pid> to toggle the hud as desired.
 255 <li>GALLIUM_HUD_DUMP_DIR - specifies a directory for writing the displayed
 256     hud values into files.
 257 <li>GALLIUM_DRIVER - useful in combination with LIBGL_ALWAYS_SOFTWARE=true for
 258     choosing one of the software renderers "softpipe", "llvmpipe" or "swr".
 259 <li>GALLIUM_LOG_FILE - specifies a file for logging all errors, warnings, etc.
 260     rather than stderr.
 261 <li>GALLIUM_PRINT_OPTIONS - if non-zero, print all the Gallium environment
 262     variables which are used, and their current values.
 263 <li>GALLIUM_DUMP_CPU - if non-zero, print information about the CPU on start-up
 264 <li>TGSI_PRINT_SANITY - if set, do extra sanity checking on TGSI shaders and
 265     print any errors to stderr.
 266 <LI>DRAW_FSE - ???
 267 <LI>DRAW_NO_FSE - ???
 268 <li>DRAW_USE_LLVM - if set to zero, the draw module will not use LLVM to execute
 269     shaders, vertex fetch, etc.
 270 <li>ST_DEBUG - controls debug output from the Mesa/Gallium state tracker.
 271 Setting to "tgsi", for example, will print all the TGSI shaders.
 272 See src/mesa/state_tracker/st_debug.c for other options.
 273 </ul>
 274
 275 <h3>Clover state tracker environment variables</h3>
 276
 277 <ul>
 278 <li>CLOVER_EXTRA_BUILD_OPTIONS - allows specifying additional compiler and linker
 279     options. Specified options are appended after the options set by the OpenCL
 280     program in clBuildProgram.
 281 <li>CLOVER_EXTRA_COMPILE_OPTIONS - allows specifying additional compiler
 282     options. Specified options are appended after the options set by the OpenCL
 283     program in clCompileProgram.
 284 <li>CLOVER_EXTRA_LINK_OPTIONS - allows specifying additional linker
 285     options. Specified options are appended after the options set by the OpenCL
 286     program in clLinkProgram.
 287 </ul>
 288
 289
 290 <h3>Softpipe driver environment variables</h3>
 291 <ul>
 292 <li>SOFTPIPE_DUMP_FS - if set, the softpipe driver will print fragment shaders
 293     to stderr
 294 <li>SOFTPIPE_DUMP_GS - if set, the softpipe driver will print geometry shaders
 295     to stderr
 296 <li>SOFTPIPE_NO_RAST - if set, rasterization is no-op'd.  For profiling purposes.
 297 <li>SOFTPIPE_USE_LLVM - if set, the softpipe driver will try to use LLVM JIT for
 298     vertex shading processing.
 299 </ul>
 300
 301
 302 <h3>LLVMpipe driver environment variables</h3>
 303 <ul>
 304 <li>LP_NO_RAST - if set LLVMpipe will no-op rasterization
 305 <li>LP_DEBUG - a comma-separated list of debug options is accepted.  See the
 306     source code for details.
 307 <li>LP_PERF - a comma-separated list of options to selectively no-op various
 308     parts of the driver.  See the source code for details.
 309 <li>LP_NUM_THREADS - an integer indicating how many threads to use for rendering.
 310     Zero turns off threading completely.  The default value is the number of CPU
 311     cores present.
 312 </ul>
 313
 314 <h3>VMware SVGA driver environment variables</h3>
 315 <ul>
 316 <li>SVGA_FORCE_SWTNL - force use of software vertex transformation
 317 <li>SVGA_NO_SWTNL - don't allow software vertex transformation fallbacks
 318 (will often result in incorrect rendering).
 319 <li>SVGA_DEBUG - for dumping shaders, constant buffers, etc.  See the code
 320 for details.
 321 <li>SVGA_EXTRA_LOGGING - if set, enables extra logging to the vmware.log file,
 322 such as the OpenGL program's name and command line arguments.
 323 <li>See the driver code for other, lesser-used variables.
 324 </ul>
 325
 326
 327 <h3>VA-API state tracker environment variables</h3>
 328 <ul>
 329 <li>VAAPI_MPEG4_ENABLED - enable MPEG4 for VA-API, disabled by default.
 330 </ul>
 331
 332
 333 <h3>VC4 driver environment variables</h3>
 334 <ul>
 335 <li>VC4_DEBUG - a comma-separated list of named flags, which do various things:
 336 <ul>
 337    <li>cl - dump command list during creation</li>
 338    <li>qpu - dump generated QPU instructions</li>
 339    <li>qir - dump QPU IR during program compile</li>
 340    <li>nir - dump NIR during program compile</li>
 341    <li>tgsi - dump TGSI during program compile</li>
 342    <li>shaderdb - dump program compile information for shader-db analysis</li>
 343    <li>perf - print during performance-related events</li>
 344    <li>norast - skip actual hardware execution of commands</li>
 345    <li>always_flush - flush after each draw call</li>
 346    <li>always_sync - wait for finish after each flush</li>
 347    <li>dump - write a GPU command stream trace file (VC4 simulator only)</li>
 348 </ul>
 349 </ul>
 350
 351
 352 <p>
 353 Other Gallium drivers have their own environment variables.  These may change
 354 frequently so the source code should be consulted for details.
 355 </p>
 356
 357 </div>
 358 </body>
 359 </html>