docs/install.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>Compiling and Installing</title>
   6   <link rel="stylesheet" type="text/css" href="mesa.css">
   7 </head>
   8 <body>
   9
  10 <div class="header">
  11   The Mesa 3D Graphics Library
  12 </div>
  13
  14 <iframe src="contents.html"></iframe>
  15 <div class="content">
  16
  17 <h1>Compiling and Installing</h1>
  18
  19 <ol>
  20 <li><a href="#prereq-general">Prerequisites for building</a>
  21   <ul>
  22   <li><a href="#prereq-general">General prerequisites</a>
  23   <li><a href="#prereq-dri">For DRI and hardware acceleration</a>
  24   </ul>
  25 <li><a href="#meson">Building with meson</a>
  26 <li><a href="#autoconf">Building with autoconf (Linux/Unix/X11)</a>
  27 <li><a href="#scons">Building with SCons (Windows/Linux)</a>
  28 <li><a href="#android">Building with AOSP (Android)</a>
  29 <li><a href="#libs">Library Information</a>
  30 <li><a href="#pkg-config">Building OpenGL programs with pkg-config</a>
  31 </ol>
  32
  33
  34 <h2 id="prereq-general">1. Prerequisites for building</h2>
  35
  36 <h3>1.1 General</h3>
  37
  38 <h4>Build system</h4>
  39
  40 <ul>
  41 <li><a href="https://mesonbuild.com">meson</a> is required when building on *nix platforms.
  42 <li>Autoconf was removed in 19.1.0, use meson instead
  43 <li><a href="http://www.scons.org/">SCons</a> is required for building on
  44 Windows and optional for Linux (it's an alternative to meson.)
  45 </li>
  46 <li>Android Build system when building as native Android component. Autoconf
  47 is used when when building ARC.
  48 </li>
  49 </ul>
  50
  51
  52 <h4>Compiler</h4>
  53 <p>
  54 The following compilers are known to work, if you know of others or you're
  55 willing to maintain support for other compiler get in touch.
  56 </p>
  57
  58 <ul>
  59 <li>GCC 4.2.0 or later (some parts of Mesa may require later versions)
  60 <li>clang - exact minimum requirement is currently unknown.
  61 <li>Microsoft Visual Studio 2015 or later is required, for building on Windows.
  62 </ul>
  63
  64
  65 <h4>Third party/extra tools.</h4>
  66 <p>
  67 <strong>Note</strong>: These should not be required, when building from a release tarball. If
  68 you think you've spotted a bug let developers know by filing a
  69 <a href="bugs.html">bug report</a>.
  70 </p>
  71
  72
  73 <ul>
  74 <li><a href="https://www.python.org/">Python</a> - Python is required.
  75 When building with scons 2.7 is required.
  76 When building with meson 3.5 or newer is required.
  77 </li>
  78 <li><a href="http://www.makotemplates.org/">Python Mako module</a> -
  79 Python Mako module is required. Version 0.8.0 or later should work.
  80 </li>
  81 <li>lex / yacc - for building the Mesa IR and GLSL compiler.
  82 <p>
  83 On Linux systems, flex and bison versions 2.5.35 and 2.4.1, respectively,
  84 (or later) should work.
  85 On Windows with MinGW, install flex and bison with:
  86 <pre>mingw-get install msys-flex msys-bison</pre>
  87 For MSVC on Windows, install
  88 <a href="http://winflexbison.sourceforge.net/">Win flex-bison</a>.
  89 </p>
  90 </ul>
  91 <p><strong>Note</strong>: Some versions can be buggy (eg. flex 2.6.2) so do try others if things fail.</p>
  92
  93
  94 <h3 id="prereq-dri">1.2 Requirements</h3>
  95
  96 <p>
  97 The requirements depends on the features selected at configure stage.
  98 Check/install the respective -devel package as prompted by the configure error
  99 message.
 100 </p>
 101
 102 <p>
 103 Here are some common ways to retrieve most/all of the dependencies based on
 104 the packaging tool used by your distro.
 105 </p>
 106
 107 <pre>
 108   zypper source-install --build-deps-only Mesa # openSUSE/SLED/SLES
 109   yum-builddep mesa # yum Fedora, OpenSuse(?)
 110   dnf builddep mesa # dnf Fedora
 111   apt-get build-dep mesa # Debian and derivatives
 112   ... # others
 113 </pre>
 114
 115 <h2 id="meson">2. Building with meson</h2>
 116
 117 <p>
 118 Meson is the latest build system in mesa, it is currently able to build for
 119 *nix systems like Linux and BSD, and will be able to build for windows as well.
 120 </p>
 121
 122 <p>
 123 The general approach is:
 124 </p>
 125 <pre>
 126   meson builddir/
 127   ninja -C builddir/
 128   sudo ninja -C builddir/ install
 129 </pre>
 130 <p>
 131 Please read the <a href="meson.html">detailed meson instructions</a>
 132 for more information
 133 </p>
 134
 135 <h2 id="autoconf">3. Building with autoconf (Linux/Unix/X11)</h2>
 136
 137 <p>
 138   Autoconf support was removed in Mesa 19.1.0. Please use meson instead.
 139 </p>
 140
 141
 142
 143 <h2 id="scons">4. Building with SCons (Windows/Linux)</h2>
 144
 145 <p>
 146 To build Mesa with SCons on Linux or Windows do
 147 </p>
 148 <pre>
 149     scons
 150 </pre>
 151 <p>
 152 The build output will be placed in
 153 build/<i>platform</i>-<i>machine</i>-<i>debug</i>/..., where <i>platform</i> is for
 154 example linux or windows, <i>machine</i> is x86 or x86_64, optionally followed
 155 by -debug for debug builds.
 156 </p>
 157
 158 <p>
 159 To build Mesa with SCons for Windows on Linux using the MinGW crosscompiler toolchain do
 160 </p>
 161 <pre>
 162     scons platform=windows toolchain=crossmingw machine=x86 libgl-gdi
 163 </pre>
 164 <p>
 165 This will create:
 166 </p>
 167 <ul>
 168 <li>build/windows-x86-debug/gallium/targets/libgl-gdi/opengl32.dll &mdash; Mesa + Gallium + softpipe (or llvmpipe), binary compatible with Windows's opengl32.dll
 169 </ul>
 170 <p>
 171 Put them all in the same directory to test them.
 172
 173 Additional information is available in <a href="README.WIN32">README.WIN32</a>.
 174
 175 </p>
 176
 177
 178
 179 <h2 id="android">5. Building with AOSP (Android)</h2>
 180
 181 <p>
 182 Currently one can build Mesa for Android as part of the AOSP project, yet
 183 your experience might vary.
 184 </p>
 185
 186 <p>
 187 In order to achieve that one should update their local manifest to point to the
 188 upstream repo, set the appropriate BOARD_GPU_DRIVERS and build the
 189 libGLES_mesa library.
 190 </p>
 191
 192 <p>
 193 FINISHME: Improve on the instructions add references to Rob H repos/Jenkins,
 194 Android-x86 and/or other resources.
 195 </p>
 196
 197
 198 <h2 id="libs">6. Library Information</h2>
 199
 200 <p>
 201 When compilation has finished, look in the top-level <code>lib/</code>
 202 (or <code>lib64/</code>) directory.
 203 You'll see a set of library files similar to this:
 204 </p>
 205 <pre>
 206 lrwxrwxrwx    1 brian    users          10 Mar 26 07:53 libGL.so -&gt; libGL.so.1*
 207 lrwxrwxrwx    1 brian    users          19 Mar 26 07:53 libGL.so.1 -&gt; libGL.so.1.5.060100*
 208 -rwxr-xr-x    1 brian    users     3375861 Mar 26 07:53 libGL.so.1.5.060100*
 209 lrwxrwxrwx    1 brian    users          14 Mar 26 07:53 libOSMesa.so -&gt; libOSMesa.so.6*
 210 lrwxrwxrwx    1 brian    users          23 Mar 26 07:53 libOSMesa.so.6 -&gt; libOSMesa.so.6.1.060100*
 211 -rwxr-xr-x    1 brian    users       23871 Mar 26 07:53 libOSMesa.so.6.1.060100*
 212 </pre>
 213
 214 <p>
 215 <b>libGL</b> is the main OpenGL library (i.e. Mesa), while <b>libOSMesa</b>
 216 is the OSMesa (Off-Screen) interface library.
 217 </p>
 218
 219 <p>
 220 If you built the DRI hardware drivers, you'll also see the DRI drivers:
 221 </p>
 222 <pre>
 223 -rwxr-xr-x   1 brian users 16895413 Jul 21 12:11 i915_dri.so
 224 -rwxr-xr-x   1 brian users 16895413 Jul 21 12:11 i965_dri.so
 225 -rwxr-xr-x   1 brian users 11849858 Jul 21 12:12 r200_dri.so
 226 -rwxr-xr-x   1 brian users 11757388 Jul 21 12:12 radeon_dri.so
 227 </pre>
 228
 229 <p>
 230 If you built with Gallium support, look in lib/gallium/ for Gallium-based
 231 versions of libGL and device drivers.
 232 </p>
 233
 234
 235 <h2 id="pkg-config">7. Building OpenGL programs with pkg-config</h2>
 236
 237 <p>
 238 Running <code>ninja install</code> will install package configuration files
 239 for the pkg-config utility.
 240 </p>
 241
 242 <p>
 243 When compiling your OpenGL application you can use pkg-config to determine
 244 the proper compiler and linker flags.
 245 </p>
 246
 247 <p>
 248 For example, compiling and linking a GLUT application can be done with:
 249 </p>
 250 <pre>
 251    gcc `pkg-config --cflags --libs glut` mydemo.c -o mydemo
 252 </pre>
 253
 254 </div>
 255 </body>
 256 </html>