Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / mesa3d / d69c790c228a809021e2091440e69e19280d108a / . / docs / meson.html
blob: f08598cb7af3e29aca675797cbbeb30042a99ce5 [file] [log] [blame]
Dylan Bakerbc17ac52017-10-17 12:19:49 -0700[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>Compilation and Installation using Meson</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>Compilation and Installation using Meson</h1>
18
Eric Engestromb0319d02018-11-29 13:16:42 +0000[diff] [blame]19<ul>
Brian Paul45c6da52019-03-07 20:39:49 -0700[diff] [blame]20 <li><a href="#intro">Introduction</a></li>
Eric Engestromb0319d02018-11-29 13:16:42 +0000[diff] [blame]21 <li><a href="#basic">Basic Usage</a></li>
Brian Paul45c6da52019-03-07 20:39:49 -0700[diff] [blame]22 <li><a href="#advanced">Advanced Usage</a></li>
Eric Engestromb0319d02018-11-29 13:16:42 +0000[diff] [blame]23 <li><a href="#cross-compilation">Cross-compilation and 32-bit builds</a></li>
24</ul>
25
Brian Paul45c6da52019-03-07 20:39:49 -0700[diff] [blame]26<h2 id="intro">1. Introduction</h2>
Dylan Bakerbc17ac52017-10-17 12:19:49 -0700[diff] [blame]27
Brian Paul45c6da52019-03-07 20:39:49 -0700[diff] [blame]28<p>For general information about Meson see the
29<a href="http://mesonbuild.com/">Meson website</a>.</p>
Dylan Bakerbc17ac52017-10-17 12:19:49 -0700[diff] [blame]30
Brian Paul45c6da52019-03-07 20:39:49 -0700[diff] [blame]31<p><strong>Mesa's Meson build system is generally considered stable and ready
32for production.</strong></p>
33
34<p>The Meson build of Mesa is tested on Linux, macOS, Cygwin and Haiku, FreeBSD,
Dylan Baker1da60662018-09-18 09:01:45 -0700[diff] [blame]35DragonflyBSD, NetBSD, and should work on OpenBSD.</p>
Dylan Baker2aad12b2018-03-01 11:32:56 -0800[diff] [blame]36
Brian Paul45c6da52019-03-07 20:39:49 -0700[diff] [blame]37<p>If Meson is not already installed on your system, you can typically
38install it with your package installer. For example:</p>
39<pre>
40sudo apt-get install meson # Ubuntu
41</pre>
42or
43<pre>
44sudo dnf install meson # Fedora
45</pre>
46
Erik Faye-Lund13b99002019-04-18 13:57:03 +0200[diff] [blame]47<p><strong>Mesa requires Meson &gt;= 0.45.0 to build.</strong>
Dylan Baker2aad12b2018-03-01 11:32:56 -0800[diff] [blame]48
49Some older versions of meson do not check that they are too old and will error
50out in odd ways.
51</p>
Dylan Bakerbc17ac52017-10-17 12:19:49 -0700[diff] [blame]52
Brian Paul45c6da52019-03-07 20:39:49 -0700[diff] [blame]53<p>You'll also need <a href="https://ninja-build.org/">Ninja</a>.
54If it's not already installed, use apt-get or dnf to install
55the <em>ninja-build</em> package.
56</p>
57
58<h2 id="basic">2. Basic Usage</h2>
59
Dylan Bakerbc17ac52017-10-17 12:19:49 -0700[diff] [blame]60<p>
61The meson program is used to configure the source directory and generates
62either a ninja build file or Visual Studio® build files. The latter must
Brian Paul45c6da52019-03-07 20:39:49 -0700[diff] [blame]63be enabled via the <code>--backend</code> switch, as ninja is the default
64backend on all
65operating systems.
Dylan Bakerbc17ac52017-10-17 12:19:49 -0700[diff] [blame]66</p>
67
Brian Paul45c6da52019-03-07 20:39:49 -0700[diff] [blame]68<p>
69Meson only supports out-of-tree builds, and must be passed a
70directory to put built and generated sources into. We'll call that directory
71"build" here.
72It's recommended to create a
73<a href="http://mesonbuild.com/Using-multiple-build-directories.html">
74separate build directory</a> for each configuration you might want to use.
75</p>
76
77
78
Brian Paul45c6da52019-03-07 20:39:49 -0700[diff] [blame]79<p>Basic configuration is done with:</p>
80
Dylan Bakerbc17ac52017-10-17 12:19:49 -0700[diff] [blame]81<pre>
Brian Paul45c6da52019-03-07 20:39:49 -0700[diff] [blame]82meson build/
Dylan Bakerbc17ac52017-10-17 12:19:49 -0700[diff] [blame]83</pre>
84
85<p>
Brian Paul45c6da52019-03-07 20:39:49 -0700[diff] [blame]86This will create the build directory.
87If any dependencies are missing, you can install them, or try to remove
88the dependency with a Meson configuration option (see below).
Eric Engestromc4c5c902019-01-17 16:26:26 +0000[diff] [blame]89</p>
Dylan Bakerbc17ac52017-10-17 12:19:49 -0700[diff] [blame]90
Eric Engestromc4c5c902019-01-17 16:26:26 +0000[diff] [blame]91<p>
Brian Paul45c6da52019-03-07 20:39:49 -0700[diff] [blame]92To review the options which Meson chose, run:
93</p>
94<pre>
95meson configure build/
96</pre>
97
98<p>
99Meson does not currently support listing configuration options before
100running "meson build/" but this feature is being discussed upstream.
Eric Engestrom00be88a2019-01-17 18:04:42 +0000[diff] [blame]101For now, we have a <code>bin/meson-options.py</code> script that prints
102the options for you.
103If that script doesn't work for some reason, you can always look in the
Brian Paule547a1c2019-03-11 19:58:04 -0600[diff] [blame]104<a href="https://gitlab.freedesktop.org/mesa/mesa/blob/master/meson_options.txt">
105meson_options.txt</a> file at the root of the project.
Dylan Bakerbc17ac52017-10-17 12:19:49 -0700[diff] [blame]106</p>
107
Dylan Bakerbc17ac52017-10-17 12:19:49 -0700[diff] [blame]108<p>
Brian Paul45c6da52019-03-07 20:39:49 -0700[diff] [blame]109With additional arguments <code>meson configure</code> can be used to change
110options for a previously configured build directory.
111All options passed to this command are in the form
112<code>-D "option"="value"</code>.
113For example:
Dylan Bakerbc17ac52017-10-17 12:19:49 -0700[diff] [blame]114</p>
115
116<pre>
Brian Paul45c6da52019-03-07 20:39:49 -0700[diff] [blame]117meson configure build/ -Dprefix=/tmp/install -Dglx=true
Dylan Bakerbc17ac52017-10-17 12:19:49 -0700[diff] [blame]118</pre>
119
120<p>
Eric Engestrom57fbc2a2018-05-14 16:39:42 +0100[diff] [blame]121Note that options taking lists (such as <code>platforms</code>) are
122<a href="http://mesonbuild.com/Build-options.html#using-build-options">a bit
123more complicated</a>, but the simplest form compatible with Mesa options
124is to use a comma to separate values (<code>-D platforms=drm,wayland</code>)
125and brackets to represent an empty list (<code>-D platforms=[]</code>).
126</p>
127
128<p>
Dylan Bakerbc17ac52017-10-17 12:19:49 -0700[diff] [blame]129Once you've run the initial <code>meson</code> command successfully you can use
Brian Paul45c6da52019-03-07 20:39:49 -0700[diff] [blame]130your configured backend to build the project in your build directory:
Dylan Bakerbc17ac52017-10-17 12:19:49 -0700[diff] [blame]131</p>
132
133<pre>
Brian Paul45c6da52019-03-07 20:39:49 -0700[diff] [blame]134ninja -C build/
Dylan Bakerbc17ac52017-10-17 12:19:49 -0700[diff] [blame]135</pre>
136
137<p>
Brian Paul45c6da52019-03-07 20:39:49 -0700[diff] [blame]138The next step is to install the Mesa libraries, drivers, etc.
139This also finishes up some final steps of the build process (such as creating
140symbolic links for drivers). To install:
Dylan Bakerbc17ac52017-10-17 12:19:49 -0700[diff] [blame]141</p>
142
Brian Paul45c6da52019-03-07 20:39:49 -0700[diff] [blame]143<pre>
144ninja -C build/ install
145</pre>
146
Dylan Bakera8004ef2018-10-22 19:33:08 -0700[diff] [blame]147<p>
Eric Engestrom88ed5f62019-04-24 13:19:51 +0100[diff] [blame]148Note: autotools automatically updated translation files (used by the DRI
Brian Paul45c6da52019-03-07 20:39:49 -0700[diff] [blame]149configuration tool) as part of the build process,
150Meson does not do this. Instead, you will need do this:
Dylan Bakera8004ef2018-10-22 19:33:08 -0700[diff] [blame]151</p>
Brian Paul45c6da52019-03-07 20:39:49 -0700[diff] [blame]152<pre>
153ninja -C build/ xmlpool-pot xmlpool-update-po xmlpool-gmo
154</pre>
155
156<h2 id="advanced">3. Advanced Usage</h2>
Dylan Bakera8004ef2018-10-22 19:33:08 -0700[diff] [blame]157
Eric Engestrom67c55072018-05-14 16:45:31 +0100[diff] [blame]158<dl>
Brian Paul45c6da52019-03-07 20:39:49 -0700[diff] [blame]159
160<dt>Installation Location</dt>
161<dd>
162<p>
163Meson default to installing libGL.so in your system's main lib/ directory
164and DRI drivers to a dri/ subdirectory.
165</p>
166<p>
167Developers will often want to install Mesa to a testing directory rather
168than the system library directory.
169This can be done with the --prefix option. For example:
170</p>
Brian Paul16fb82d2019-03-08 10:31:11 -0700[diff] [blame]171<pre>
Brian Paul45c6da52019-03-07 20:39:49 -0700[diff] [blame]172meson --prefix="${PWD}/build/install" build/
Brian Paul16fb82d2019-03-08 10:31:11 -0700[diff] [blame]173</pre>
Brian Paul45c6da52019-03-07 20:39:49 -0700[diff] [blame]174<p>
175will put the final libraries and drivers into the build/install/
176directory.
177Then you can set LD_LIBRARY_PATH and LIBGL_DRIVERS_PATH to that location
178to run/test the driver.
179</p>
Brian Paul16fb82d2019-03-08 10:31:11 -0700[diff] [blame]180<p>
181Meson also honors <code>DESTDIR</code> for installs.
182</p>
Brian Paul45c6da52019-03-07 20:39:49 -0700[diff] [blame]183</dd>
184
Brian Paul16fb82d2019-03-08 10:31:11 -0700[diff] [blame]185<dt>Compiler Options</dt>
186<dd>
187<p>Meson supports the common CFLAGS, CXXFLAGS, etc. environment
188variables but their use is discouraged because of the many caveats
189in using them.
190</p>
191<p>Instead, it is recomended to use <code>-D${lang}_args</code> and
192<code>-D${lang}_link_args</code>. Among the benefits of these options
Dylan Baker0ff7eed2018-12-19 13:27:27 -0800[diff] [blame]193is that they are guaranteed to persist across rebuilds and reconfigurations.
Brian Paul16fb82d2019-03-08 10:31:11 -0700[diff] [blame]194</p>
Erik Faye-Lund8ef86c92019-04-18 16:13:44 +0200[diff] [blame]195<p>
Brian Paul16fb82d2019-03-08 10:31:11 -0700[diff] [blame]196This example sets -fmax-errors for compiling C sources and -DMAGIC=123
197for C++ sources:
198</p>
Brian Paul16fb82d2019-03-08 10:31:11 -0700[diff] [blame]199<pre>
200meson builddir/ -Dc_args=-fmax-errors=10 -Dcpp_args=-DMAGIC=123
201</pre>
Brian Paul16fb82d2019-03-08 10:31:11 -0700[diff] [blame]202</dd>
Dylan Bakerbc17ac52017-10-17 12:19:49 -0700[diff] [blame]203
Brian Paul16fb82d2019-03-08 10:31:11 -0700[diff] [blame]204
205<dt>Compiler Specification</dt>
206<dd>
207<p>
208Meson supports the standard CC and CXX environment variables for
209changing the default compiler. Note that Meson does not allow
210changing the compilers in a configured builddir so you will need
Dylan Baker0ff7eed2018-12-19 13:27:27 -0800[diff] [blame]211to create a new build dir for a different compiler.
Dylan Bakerbc17ac52017-10-17 12:19:49 -0700[diff] [blame]212</p>
Brian Paul16fb82d2019-03-08 10:31:11 -0700[diff] [blame]213<p>
214This is an example of specifying the clang compilers and cleaning
215the build directory before reconfiguring with an extra C option:
216</p>
Dylan Bakerbc17ac52017-10-17 12:19:49 -0700[diff] [blame]217<pre>
Brian Paul16fb82d2019-03-08 10:31:11 -0700[diff] [blame]218CC=clang CXX=clang++ meson build-clang
219ninja -C build-clang
220ninja -C build-clang clean
221meson configure build -Dc_args="-Wno-typedef-redefinition"
222ninja -C build-clang
Dylan Bakerbc17ac52017-10-17 12:19:49 -0700[diff] [blame]223</pre>
Dylan Bakere0829f92018-09-18 09:07:25 -0700[diff] [blame]224<p>
225The default compilers depends on your operating system. Meson supports most of
226the popular compilers, a complete list is available
227<a href="http://mesonbuild.com/Reference-tables.html#compiler-ids">here</a>.
228</p>
Dylan Bakerbc17ac52017-10-17 12:19:49 -0700[diff] [blame]229</dd>
230
Brian Paul45c6da52019-03-07 20:39:49 -0700[diff] [blame]231<dt>LLVM</dt>
Dylan Bakerbe56f8a2018-09-18 09:09:47 -0700[diff] [blame]232<dd><p>Meson includes upstream logic to wrap llvm-config using its standard
Dylan Bakera57dbe62018-12-20 11:46:08 -0800[diff] [blame]233dependency interface.
Dylan Bakerbc17ac52017-10-17 12:19:49 -0700[diff] [blame]234</p></dd>
Dylan Bakera57dbe62018-12-20 11:46:08 -0800[diff] [blame]235
236<dd><p>
237As of meson 0.49.0 meson also has the concept of a
238<a href="https://mesonbuild.com/Native-environments.html">"native file"</a>,
239these files provide information about the native build environment (as opposed
240to a cross build environment). They are ini formatted and can override where to
241find llvm-config:
242
243custom-llvm.ini
244<pre>
245 [binaries]
246 llvm-config = '/usr/local/bin/llvm/llvm-config'
247</pre>
248
249Then configure meson:
250
251<pre>
252 meson builddir/ --native-file custom-llvm.ini
253</pre>
254</p></dd>
255
256<dd><p>
257For selecting llvm-config for cross compiling a
258<a href="https://mesonbuild.com/Cross-compilation.html#defining-the-environment">"cross file"</a>
259should be used. It uses the same format as the native file above:
260
261cross-llvm.ini
262<pre>
263 [binaries]
264 ...
265 llvm-config = '/usr/lib/llvm-config-32'
266</pre>
267
268Then configure meson:
269
270<pre>
271 meson builddir/ --cross-file cross-llvm.ini
272</pre>
273
274See the <a href="#cross-compilation">Cross Compilation</a> section for more information.
275</dd></p>
276
277<dd><p>
278For older versions of meson <code>$PATH</code> (or <code>%PATH%</code> on
279windows) will be searched for llvm-config (and llvm-config$version and
280llvm-config-$version), you can override this environment variable to control
281the search: <code>PATH=/path/with/llvm-config:$PATH meson build</code>.
282</dd></p>
Dylan Bakerbc17ac52017-10-17 12:19:49 -0700[diff] [blame]283</dl>
284
Dylan Baker2aad12b2018-03-01 11:32:56 -0800[diff] [blame]285<dl>
Dylan Bakerbc17ac52017-10-17 12:19:49 -0700[diff] [blame]286<dt><code>PKG_CONFIG_PATH</code></dt>
287<dd><p>The
288<code>pkg-config</code> utility is a hard requirement for configuring and
Dylan Baker2aad12b2018-03-01 11:32:56 -0800[diff] [blame]289building Mesa on Unix-like systems. It is used to search for external libraries
290on the system. This environment variable is used to control the search path for
291<code>pkg-config</code>. For instance, setting
292<code>PKG_CONFIG_PATH=/usr/X11R6/lib/pkgconfig</code> will search for package
293metadata in <code>/usr/X11R6</code> before the standard directories.</p>
Dylan Bakerbc17ac52017-10-17 12:19:49 -0700[diff] [blame]294</dd>
295</dl>
296
297<p>
298One of the oddities of meson is that some options are different when passed to
299the <code>meson</code> than to <code>meson configure</code>. These options are
300passed as --option=foo to <code>meson</code>, but -Doption=foo to <code>meson
301configure</code>. Mesa defined options are always passed as -Doption=foo.
Eric Engestrom67c55072018-05-14 16:45:31 +0100[diff] [blame]302</p>
Dylan Bakerbc17ac52017-10-17 12:19:49 -0700[diff] [blame]303
304<p>For those coming from autotools be aware of the following:</p>
305
306<dl>
307<dt><code>--buildtype/-Dbuildtype</code></dt>
308<dd><p>This option will set the compiler debug/optimisation levels to aid
309debugging the Mesa libraries.</p>
310
Eric Engestrom37d44e22018-05-14 16:47:57 +0100[diff] [blame]311<p>Note that in meson this defaults to <code>debugoptimized</code>, and
312not setting it to <code>release</code> will yield non-optimal
313performance and binary size. Not using <code>debug</code> may interfere
314with debugging as some code and validation will be optimized away.
Dylan Bakerbc17ac52017-10-17 12:19:49 -0700[diff] [blame]315</p>
316
Eric Engestrom37d44e22018-05-14 16:47:57 +0100[diff] [blame]317<p> For those wishing to pass their own optimization flags, use the <code>plain</code>
Dylan Baker2aad12b2018-03-01 11:32:56 -0800[diff] [blame]318buildtype, which causes meson to inject no additional compiler arguments, only
319those in the C/CXXFLAGS and those that mesa itself defines.</p>
Dylan Bakerbc17ac52017-10-17 12:19:49 -0700[diff] [blame]320</dd>
321</dl>
322
323<dl>
324<dt><code>-Db_ndebug</code></dt>
Eric Engestrom37d44e22018-05-14 16:47:57 +0100[diff] [blame]325<dd><p>This option controls assertions in meson projects. When set to <code>false</code>
Dylan Bakerbc17ac52017-10-17 12:19:49 -0700[diff] [blame]326(the default) assertions are enabled, when set to true they are disabled. This
327is unrelated to the <code>buildtype</code>; setting the latter to
328<code>release</code> will not turn off assertions.
329</p>
330</dd>
331</dl>
Eric Engestrom67c55072018-05-14 16:45:31 +0100[diff] [blame]332
Brian Paul45c6da52019-03-07 20:39:49 -0700[diff] [blame]333<h2 id="cross-compilation">4. Cross-compilation and 32-bit builds</h2>
Eric Engestromb0319d02018-11-29 13:16:42 +0000[diff] [blame]334
335<p><a href="https://mesonbuild.com/Cross-compilation.html">Meson supports
336cross-compilation</a> by specifying a number of binary paths and
337settings in a file and passing this file to <code>meson</code> or
338<code>meson configure</code> with the <code>--cross-file</code>
339parameter.</p>
340
341<p>This file can live at any location, but you can use the bare filename
342(without the folder path) if you put it in $XDG_DATA_HOME/meson/cross or
343~/.local/share/meson/cross</p>
344
345<p>Below are a few example of cross files, but keep in mind that you
346will likely have to alter them for your system.</p>
347
348<p>
Eric Engestrom393a7562019-01-03 16:01:18 +0000[diff] [blame]349Those running on ArchLinux can use the AUR-maintained packages for some
350of those, as they'll have the right values for your system:
Erik Faye-Lund92917e82019-04-18 15:38:01 +0200[diff] [blame]351</p>
Eric Engestrom393a7562019-01-03 16:01:18 +0000[diff] [blame]352<ul>
353 <li><a href="https://aur.archlinux.org/packages/meson-cross-x86-linux-gnu">meson-cross-x86-linux-gnu</a></li>
354 <li><a href="https://aur.archlinux.org/packages/meson-cross-aarch64-linux-gnu">meson-cross-aarch64-linux-gnu</a></li>
355</ul>
Eric Engestrom393a7562019-01-03 16:01:18 +0000[diff] [blame]356
357<p>
Eric Engestromb0319d02018-11-29 13:16:42 +0000[diff] [blame]35832-bit build on x86 linux:
Erik Faye-Lund41573d42019-04-18 16:12:08 +0200[diff] [blame]359</p>
Eric Engestromb0319d02018-11-29 13:16:42 +0000[diff] [blame]360<pre>
361[binaries]
362c = '/usr/bin/gcc'
363cpp = '/usr/bin/g++'
364ar = '/usr/bin/gcc-ar'
365strip = '/usr/bin/strip'
366pkgconfig = '/usr/bin/pkg-config-32'
367llvm-config = '/usr/bin/llvm-config32'
368
369[properties]
370c_args = ['-m32']
371c_link_args = ['-m32']
372cpp_args = ['-m32']
373cpp_link_args = ['-m32']
374
375[host_machine]
376system = 'linux'
377cpu_family = 'x86'
378cpu = 'i686'
379endian = 'little'
380</pre>
Eric Engestromb0319d02018-11-29 13:16:42 +0000[diff] [blame]381
382<p>
38364-bit build on ARM linux:
Erik Faye-Lund41573d42019-04-18 16:12:08 +0200[diff] [blame]384</p>
Eric Engestromb0319d02018-11-29 13:16:42 +0000[diff] [blame]385<pre>
386[binaries]
387c = '/usr/bin/aarch64-linux-gnu-gcc'
388cpp = '/usr/bin/aarch64-linux-gnu-g++'
Eric Engestrom8b363bc2019-01-03 15:44:42 +0000[diff] [blame]389ar = '/usr/bin/aarch64-linux-gnu-gcc-ar'
Eric Engestromb0319d02018-11-29 13:16:42 +0000[diff] [blame]390strip = '/usr/bin/aarch64-linux-gnu-strip'
391pkgconfig = '/usr/bin/aarch64-linux-gnu-pkg-config'
392exe_wrapper = '/usr/bin/qemu-aarch64-static'
393
394[host_machine]
395system = 'linux'
Eric Engestrom8b363bc2019-01-03 15:44:42 +0000[diff] [blame]396cpu_family = 'aarch64'
Eric Engestromb0319d02018-11-29 13:16:42 +0000[diff] [blame]397cpu = 'aarch64'
398endian = 'little'
399</pre>
Eric Engestromb0319d02018-11-29 13:16:42 +0000[diff] [blame]400
401<p>
40264-bit build on x86 windows:
Erik Faye-Lund41573d42019-04-18 16:12:08 +0200[diff] [blame]403</p>
Eric Engestromb0319d02018-11-29 13:16:42 +0000[diff] [blame]404<pre>
405[binaries]
406c = '/usr/bin/x86_64-w64-mingw32-gcc'
407cpp = '/usr/bin/x86_64-w64-mingw32-g++'
408ar = '/usr/bin/x86_64-w64-mingw32-ar'
409strip = '/usr/bin/x86_64-w64-mingw32-strip'
410pkgconfig = '/usr/bin/x86_64-w64-mingw32-pkg-config'
411exe_wrapper = 'wine'
412
413[host_machine]
414system = 'windows'
415cpu_family = 'x86_64'
416cpu = 'i686'
417endian = 'little'
418</pre>
Eric Engestromb0319d02018-11-29 13:16:42 +0000[diff] [blame]419
Eric Engestrom67c55072018-05-14 16:45:31 +0100[diff] [blame]420</div>
421</body>
422</html>