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