Gitiles
Code Review Sign In
gerrit.openfyde.cn / chromium.googlesource.com / chromiumos / third_party / mesa / 74a6a6819609d23525b93245647373ca5a8966f2 / . / docs / install.html
blob: df5fcd3f7b23fdd5a53090f64bd34448fd8629b0 [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 Velikov0fa854ae2016-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 Velikov0fa854ae2016-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 Velikov0fa854ae2016-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 Velikov0fa854ae2016-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 Velikov0fa854ae2016-06-29 13:13:25 +0100[diff] [blame]45</li>
46<li>Android Build system when building as native Android component. Autoconf
47is used when when building ARC.
48</li>
49</ul>
50
51
Erik Faye-Lund9e5bc2c2019-05-28 14:03:08 +0200[diff] [blame]52<h4>Compiler</h4>
Emil Velikov0fa854ae2016-06-29 13:13:25 +0100[diff] [blame]53<p>
54The following compilers are known to work, if you know of others or you're
55willing 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.
Jose Fonseca52ca3212018-09-07 13:27:47 +0100[diff] [blame]61<li>Microsoft Visual Studio 2015 or later is required, for building on Windows.
Emil Velikov0fa854ae2016-06-29 13:13:25 +0100[diff] [blame]62</ul>
63
64
Erik Faye-Lund9e5bc2c2019-05-28 14:03:08 +0200[diff] [blame]65<h4>Third party/extra tools.</h4>
Emil Velikov0fa854ae2016-06-29 13:13:25 +0100[diff] [blame]66<p>
Emil Velikov0fa854ae2016-06-29 13:13:25 +0100[diff] [blame]67<strong>Note</strong>: These should not be required, when building from a release tarball. If
68you think you've spotted a bug let developers know by filing a
69<a href="bugs.html">bug report</a>.
70</p>
71
72
Brian Paul32a11e52011-04-04 11:30:46 -0600[diff] [blame]73<ul>
Eric Engestrom30cf9ff2017-02-09 02:10:17 +0000[diff] [blame]74<li><a href="https://www.python.org/">Python</a> - Python is required.
Dylan Baker4c329642018-12-20 13:43:29 -0800[diff] [blame]75When building with scons 2.7 is required.
76When building with meson 3.5 or newer is required.
Brian Paul75688252014-05-19 07:54:30 -0600[diff] [blame]77</li>
Samuel Iglesias Gonsalvez2b37bea2014-11-21 08:53:21 +0100[diff] [blame]78<li><a href="http://www.makotemplates.org/">Python Mako module</a> -
Emil Velikove39b9162018-08-16 17:57:10 +0100[diff] [blame]79Python Mako module is required. Version 0.8.0 or later should work.
Samuel Iglesias Gonsalvez2b37bea2014-11-21 08:53:21 +0100[diff] [blame]80</li>
Emil Velikov0fa854ae2016-06-29 13:13:25 +0100[diff] [blame]81<li>lex / yacc - for building the Mesa IR and GLSL compiler.
82<div>
83On Linux systems, flex and bison versions 2.5.35 and 2.4.1, respectively,
84(or later) should work.
Brian Paul4f869e92012-03-05 13:02:59 -0700[diff] [blame]85On Windows with MinGW, install flex and bison with:
86<pre>mingw-get install msys-flex msys-bison</pre>
Jose Fonseca9c1c6572015-03-19 13:30:19 +0000[diff] [blame]87For MSVC on Windows, install
88<a href="http://winflexbison.sourceforge.net/">Win flex-bison</a>.
Emil Velikov0fa854ae2016-06-29 13:13:25 +0100[diff] [blame]89</div>
Brian Paul32a11e52011-04-04 11:30:46 -0600[diff] [blame]90</ul>
Emil Velikov0fa854ae2016-06-29 13:13:25 +0100[diff] [blame]91<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]92
93
Emil Velikov0fa854ae2016-06-29 13:13:25 +0100[diff] [blame]94<h3 id="prereq-dri">1.2 Requirements</h3>
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]95
96<p>
Emil Velikov0fa854ae2016-06-29 13:13:25 +0100[diff] [blame]97The requirements depends on the features selected at configure stage.
98Check/install the respective -devel package as prompted by the configure error
99message.
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]100</p>
101
Alex Hultmanc3fe44c2012-03-16 09:46:42 -0600[diff] [blame]102<p>
Emil Velikov0fa854ae2016-06-29 13:13:25 +0100[diff] [blame]103Here are some common ways to retrieve most/all of the dependencies based on
104the packaging tool used by your distro.
Andreas Bolldf2be222012-06-12 09:05:22 +0200[diff] [blame]105</p>
Emil Velikov0fa854ae2016-06-29 13:13:25 +0100[diff] [blame]106
Alex Hultmanc3fe44c2012-03-16 09:46:42 -0600[diff] [blame]107<pre>
Emil Velikov0fa854ae2016-06-29 13:13:25 +0100[diff] [blame]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
Alex Hultmanc3fe44c2012-03-16 09:46:42 -0600[diff] [blame]113</pre>
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]114
Erik Faye-Lund269474b2019-05-06 12:57:15 +0200[diff] [blame]115<h2 id="meson">2. Building with meson</h2>
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]116
117<p>
Dylan Baker40ec5fe2018-12-20 11:27:52 -0800[diff] [blame]118Meson 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>
123The general approach is:
124</p>
125<pre>
126 meson builddir/
127 ninja -C builddir/
128 sudo ninja -C builddir/ install
129</pre>
130<p>
131Please read the <a href="meson.html">detailed meson instructions</a>
132for more information
133</p>
134
Erik Faye-Lund269474b2019-05-06 12:57:15 +0200[diff] [blame]135<h2 id="autoconf">3. Building with autoconf (Linux/Unix/X11)</h2>
Dylan Baker40ec5fe2018-12-20 11:27:52 -0800[diff] [blame]136
137<p>
Dylan Bakerb165ac92019-04-08 12:56:51 -0700[diff] [blame]138 Autoconf support was removed in Mesa 19.1.0. Please use meson instead.
Brian Paul7103a182012-04-19 09:56:36 -0600[diff] [blame]139</p>
140
141
142
Erik Faye-Lund269474b2019-05-06 12:57:15 +0200[diff] [blame]143<h2 id="scons">4. Building with SCons (Windows/Linux)</h2>
Brian Paul7103a182012-04-19 09:56:36 -0600[diff] [blame]144
145<p>
146To build Mesa with SCons on Linux or Windows do
147</p>
148<pre>
149 scons
150</pre>
151<p>
152The build output will be placed in
153build/<i>platform</i>-<i>machine</i>-<i>debug</i>/..., where <i>platform</i> is for
154example linux or windows, <i>machine</i> is x86 or x86_64, optionally followed
155by -debug for debug builds.
156</p>
157
158<p>
159To build Mesa with SCons for Windows on Linux using the MinGW crosscompiler toolchain do
160</p>
161<pre>
Jose Fonseca17b28252015-03-03 14:52:15 +0000[diff] [blame]162 scons platform=windows toolchain=crossmingw machine=x86 libgl-gdi
Brian Paul7103a182012-04-19 09:56:36 -0600[diff] [blame]163</pre>
164<p>
165This will create:
166</p>
167<ul>
Jose Fonseca17b28252015-03-03 14:52:15 +0000[diff] [blame]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
Brian Paul7103a182012-04-19 09:56:36 -0600[diff] [blame]169</ul>
170<p>
171Put them all in the same directory to test them.
Emil Velikov0fa854ae2016-06-29 13:13:25 +0100[diff] [blame]172
173Additional information is available in <a href="README.WIN32">README.WIN32</a>.
174
Brian Paul7103a182012-04-19 09:56:36 -0600[diff] [blame]175</p>
176
177
178
Erik Faye-Lund269474b2019-05-06 12:57:15 +0200[diff] [blame]179<h2 id="android">5. Building with AOSP (Android)</h2>
Brian Paul7103a182012-04-19 09:56:36 -0600[diff] [blame]180
181<p>
Emil Velikov0fa854ae2016-06-29 13:13:25 +0100[diff] [blame]182Currently one can build Mesa for Android as part of the AOSP project, yet
183your experience might vary.
Brian Paul7103a182012-04-19 09:56:36 -0600[diff] [blame]184</p>
185
Emil Velikov0fa854ae2016-06-29 13:13:25 +0100[diff] [blame]186<p>
187In order to achieve that one should update their local manifest to point to the
Eric Engestrom077879c2017-02-26 23:58:03 +0000[diff] [blame]188upstream repo, set the appropriate BOARD_GPU_DRIVERS and build the
Emil Velikov0fa854ae2016-06-29 13:13:25 +0100[diff] [blame]189libGLES_mesa library.
190</p>
Brian Paul7103a182012-04-19 09:56:36 -0600[diff] [blame]191
Emil Velikov0fa854ae2016-06-29 13:13:25 +0100[diff] [blame]192<p>
193FINISHME: Improve on the instructions add references to Rob H repos/Jenkins,
194Android-x86 and/or other resources.
195</p>
Brian Paul7103a182012-04-19 09:56:36 -0600[diff] [blame]196
197
Erik Faye-Lund269474b2019-05-06 12:57:15 +0200[diff] [blame]198<h2 id="libs">6. Library Information</h2>
Brian Paul7103a182012-04-19 09:56:36 -0600[diff] [blame]199
200<p>
201When compilation has finished, look in the top-level <code>lib/</code>
202(or <code>lib64/</code>) directory.
203You'll see a set of library files similar to this:
204</p>
205<pre>
Erik Faye-Lund13b99002019-04-18 13:57:03 +0200[diff] [blame]206lrwxrwxrwx 1 brian users 10 Mar 26 07:53 libGL.so -&gt; libGL.so.1*
207lrwxrwxrwx 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]208-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]209lrwxrwxrwx 1 brian users 14 Mar 26 07:53 libOSMesa.so -&gt; libOSMesa.so.6*
210lrwxrwxrwx 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]211-rwxr-xr-x 1 brian users 23871 Mar 26 07:53 libOSMesa.so.6.1.060100*
212</pre>
213
214<p>
Erik Faye-Lund74a6a682019-05-28 14:07:48 +0200[diff] [blame^]215<b>libGL</b> is the main OpenGL library (i.e. Mesa), while <b>libOSMesa</b>
216is the OSMesa (Off-Screen) interface library.
Brian Paul7103a182012-04-19 09:56:36 -0600[diff] [blame]217</p>
218
219<p>
220If 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
Brian Paul7103a182012-04-19 09:56:36 -0600[diff] [blame]226-rwxr-xr-x 1 brian users 11757388 Jul 21 12:12 radeon_dri.so
227</pre>
228
229<p>
230If you built with Gallium support, look in lib/gallium/ for Gallium-based
231versions of libGL and device drivers.
232</p>
233
234
Erik Faye-Lund269474b2019-05-06 12:57:15 +0200[diff] [blame]235<h2 id="pkg-config">7. Building OpenGL programs with pkg-config</h2>
Brian5bba58c2007-09-12 10:11:49 -0600[diff] [blame]236
237<p>
Eric Engestrom46d68832019-04-24 13:16:57 +0100[diff] [blame]238Running <code>ninja install</code> will install package configuration files
Brian5bba58c2007-09-12 10:11:49 -0600[diff] [blame]239for the pkg-config utility.
240</p>
241
242<p>
243When compiling your OpenGL application you can use pkg-config to determine
244the proper compiler and linker flags.
245</p>
246
247<p>
248For 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<br>
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]255
Andreas Bollb5da52a2012-09-18 18:57:02 +0200[diff] [blame]256</div>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]257</body>
258</html>