Blame - docs/install.html - platform/external/mesa3d

blob: e31c7728cfba7ffeafa1bc0c7ca267d88f9ba6a8 [file] [log] [blame]

Andreas Boll	ecd5c7c	2012-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 Paul	0b27ace	2003-03-08 17:38:57 +0000	[diff] [blame]	9
Andreas Boll	b5da52a	2012-09-18 18:57:02 +0200	[diff] [blame]	10	<div class="header">
Erik Faye-Lund	ecdab0d	2019-05-06 13:26:47 +0200	[diff] [blame]	11	The Mesa 3D Graphics Library
Andreas Boll	b5da52a	2012-09-18 18:57:02 +0200	[diff] [blame]	12	</div>
				13
				14	<iframe src="contents.html"></iframe>
				15	<div class="content">
				16
Andreas Boll	ecd5c7c	2012-06-12 09:05:03 +0200	[diff] [blame]	17	<h1>Compiling and Installing</h1>
Brian Paul	5f37abf	2003-09-05 14:47:07 +0000	[diff] [blame]	18
				19	<ol>
Brian Paul	7103a18	2012-04-19 09:56:36 -0600	[diff] [blame]	20	<li><a href="#prereq-general">Prerequisites for building</a>
Brian Paul	49a3fab	2008-12-30 07:57:16 -0700	[diff] [blame]	21	<ul>
Brian Paul	7103a18	2012-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 Paul	49a3fab	2008-12-30 07:57:16 -0700	[diff] [blame]	24	</ul>
Dylan Baker	40ec5fe	2018-12-20 11:27:52 -0800	[diff] [blame]	25	<li><a href="#meson">Building with meson</a>
Brian Paul	adc58e9	2012-06-01 09:19:36 -0600	[diff] [blame]	26	<li><a href="#scons">Building with SCons (Windows/Linux)</a>
Emil Velikov	0fa854a	2016-06-29 13:13:25 +0100	[diff] [blame]	27	<li><a href="#android">Building with AOSP (Android)</a>
Brian Paul	7103a18	2012-04-19 09:56:36 -0600	[diff] [blame]	28	<li><a href="#libs">Library Information</a>
Andreas Boll	df2be22	2012-06-12 09:05:22 +0200	[diff] [blame]	29	<li><a href="#pkg-config">Building OpenGL programs with pkg-config</a>
Brian Paul	5f37abf	2003-09-05 14:47:07 +0000	[diff] [blame]	30	</ol>
Brian Paul	0b27ace	2003-03-08 17:38:57 +0000	[diff] [blame]	31
Brian Paul	8bd70a7	2008-05-27 13:27:57 -0600	[diff] [blame]	32
Erik Faye-Lund	269474b	2019-05-06 12:57:15 +0200	[diff] [blame]	33	<h2 id="prereq-general">1. Prerequisites for building</h2>
Brian Paul	32a11e5	2011-04-04 11:30:46 -0600	[diff] [blame]	34
Erik Faye-Lund	269474b	2019-05-06 12:57:15 +0200	[diff] [blame]	35	<h3>1.1 General</h3>
Emil Velikov	0fa854a	2016-06-29 13:13:25 +0100	[diff] [blame]	36
Erik Faye-Lund	9e5bc2c	2019-05-28 14:03:08 +0200	[diff] [blame]	37	<h4>Build system</h4>
Emil Velikov	0fa854a	2016-06-29 13:13:25 +0100	[diff] [blame]	38
				39	<ul>
Dylan Baker	44c5e63	2019-06-11 11:25:31 -0700	[diff] [blame]	40	<li><a href="https://mesonbuild.com">meson</a> is required when building on *nix platforms and is supported on windows.
				41	<li><a href="http://www.scons.org/">SCons</a> is an alternative for building on
				42	Windows and Linux.
Emil Velikov	0fa854a	2016-06-29 13:13:25 +0100	[diff] [blame]	43	</li>
Dylan Baker	5d11a82	2019-09-30 11:02:09 -0700	[diff] [blame]	44	<li>Android Build system when building as native Android component. Meson
Emil Velikov	0fa854a	2016-06-29 13:13:25 +0100	[diff] [blame]	45	is used when when building ARC.
				46	</li>
				47	</ul>
				48
Erik Faye-Lund	9e5bc2c	2019-05-28 14:03:08 +0200	[diff] [blame]	49	<h4>Compiler</h4>
Emil Velikov	0fa854a	2016-06-29 13:13:25 +0100	[diff] [blame]	50	<p>
				51	The following compilers are known to work, if you know of others or you're
				52	willing to maintain support for other compiler get in touch.
				53	</p>
				54
				55	<ul>
				56	<li>GCC 4.2.0 or later (some parts of Mesa may require later versions)
				57	<li>clang - exact minimum requirement is currently unknown.
Jose Fonseca	52ca321	2018-09-07 13:27:47 +0100	[diff] [blame]	58	<li>Microsoft Visual Studio 2015 or later is required, for building on Windows.
Emil Velikov	0fa854a	2016-06-29 13:13:25 +0100	[diff] [blame]	59	</ul>
				60
				61
Erik Faye-Lund	9e5bc2c	2019-05-28 14:03:08 +0200	[diff] [blame]	62	<h4>Third party/extra tools.</h4>
Emil Velikov	0fa854a	2016-06-29 13:13:25 +0100	[diff] [blame]	63
Brian Paul	32a11e5	2011-04-04 11:30:46 -0600	[diff] [blame]	64	<ul>
Eric Engestrom	30cf9ff	2017-02-09 02:10:17 +0000	[diff] [blame]	65	<li><a href="https://www.python.org/">Python</a> - Python is required.
Dylan Baker	4c32964	2018-12-20 13:43:29 -0800	[diff] [blame]	66	When building with scons 2.7 is required.
				67	When building with meson 3.5 or newer is required.
Brian Paul	7568825	2014-05-19 07:54:30 -0600	[diff] [blame]	68	</li>
Samuel Iglesias Gonsalvez	2b37bea	2014-11-21 08:53:21 +0100	[diff] [blame]	69	<li><a href="http://www.makotemplates.org/">Python Mako module</a> -
Emil Velikov	e39b916	2018-08-16 17:57:10 +0100	[diff] [blame]	70	Python Mako module is required. Version 0.8.0 or later should work.
Samuel Iglesias Gonsalvez	2b37bea	2014-11-21 08:53:21 +0100	[diff] [blame]	71	</li>
Emil Velikov	0fa854a	2016-06-29 13:13:25 +0100	[diff] [blame]	72	<li>lex / yacc - for building the Mesa IR and GLSL compiler.
Erik Faye-Lund	c0dfe8c	2019-06-06 11:19:08 +0200	[diff] [blame]	73	<p>
Emil Velikov	0fa854a	2016-06-29 13:13:25 +0100	[diff] [blame]	74	On Linux systems, flex and bison versions 2.5.35 and 2.4.1, respectively,
				75	(or later) should work.
Brian Paul	4f869e9	2012-03-05 13:02:59 -0700	[diff] [blame]	76	On Windows with MinGW, install flex and bison with:
Erik Faye-Lund	a0d25c4	2020-01-16 17:21:50 +0100	[diff] [blame]	77	</p>
Brian Paul	4f869e9	2012-03-05 13:02:59 -0700	[diff] [blame]	78	<pre>mingw-get install msys-flex msys-bison</pre>
Erik Faye-Lund	a0d25c4	2020-01-16 17:21:50 +0100	[diff] [blame]	79	<p>
Jose Fonseca	9c1c657	2015-03-19 13:30:19 +0000	[diff] [blame]	80	For MSVC on Windows, install
				81	<a href="http://winflexbison.sourceforge.net/">Win flex-bison</a>.
Erik Faye-Lund	c0dfe8c	2019-06-06 11:19:08 +0200	[diff] [blame]	82	</p>
Brian Paul	32a11e5	2011-04-04 11:30:46 -0600	[diff] [blame]	83	</ul>
Emil Velikov	0fa854a	2016-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 Paul	32a11e5	2011-04-04 11:30:46 -0600	[diff] [blame]	85
				86
Emil Velikov	0fa854a	2016-06-29 13:13:25 +0100	[diff] [blame]	87	<h3 id="prereq-dri">1.2 Requirements</h3>
Brian Paul	5f37abf	2003-09-05 14:47:07 +0000	[diff] [blame]	88
				89	<p>
Emil Velikov	0fa854a	2016-06-29 13:13:25 +0100	[diff] [blame]	90	The requirements depends on the features selected at configure stage.
				91	Check/install the respective -devel package as prompted by the configure error
				92	message.
Brian Paul	8bd70a7	2008-05-27 13:27:57 -0600	[diff] [blame]	93	</p>
				94
Alex Hultman	c3fe44c	2012-03-16 09:46:42 -0600	[diff] [blame]	95	<p>
Emil Velikov	0fa854a	2016-06-29 13:13:25 +0100	[diff] [blame]	96	Here are some common ways to retrieve most/all of the dependencies based on
				97	the packaging tool used by your distro.
Andreas Boll	df2be22	2012-06-12 09:05:22 +0200	[diff] [blame]	98	</p>
Emil Velikov	0fa854a	2016-06-29 13:13:25 +0100	[diff] [blame]	99
Alex Hultman	c3fe44c	2012-03-16 09:46:42 -0600	[diff] [blame]	100	<pre>
Emil Velikov	0fa854a	2016-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 Hultman	c3fe44c	2012-03-16 09:46:42 -0600	[diff] [blame]	106	</pre>
Brian Paul	8bd70a7	2008-05-27 13:27:57 -0600	[diff] [blame]	107
Erik Faye-Lund	269474b	2019-05-06 12:57:15 +0200	[diff] [blame]	108	<h2 id="meson">2. Building with meson</h2>
Brian Paul	8bd70a7	2008-05-27 13:27:57 -0600	[diff] [blame]	109
Erik Faye-Lund	750d664	2020-01-16 17:13:12 +0100	[diff] [blame]	110	<p><strong>Meson >= 0.46.0 is required</strong></p>
				111
Dylan Baker	5d11a82	2019-09-30 11:02:09 -0700	[diff] [blame]	112
Brian Paul	8bd70a7	2008-05-27 13:27:57 -0600	[diff] [blame]	113	<p>
Dylan Baker	40ec5fe	2018-12-20 11:27:52 -0800	[diff] [blame]	114	Meson is the latest build system in mesa, it is currently able to build for
Dylan Baker	44c5e63	2019-06-11 11:25:31 -0700	[diff] [blame]	115	*nix systems like Linux and BSD, macOS, Haiku, and Windows.
Dylan Baker	40ec5fe	2018-12-20 11:27:52 -0800	[diff] [blame]	116	</p>
				117
				118	<p>
				119	The general approach is:
				120	</p>
				121	<pre>
				122	meson builddir/
				123	ninja -C builddir/
				124	sudo ninja -C builddir/ install
				125	</pre>
Dylan Baker	44c5e63	2019-06-11 11:25:31 -0700	[diff] [blame]	126
				127	<p>On windows you can also use the visual studio backend</p>
				128	<pre>
				129	meson builddir --backend=vs
				130	cd builddir
				131	msbuild mesa.sln /m
				132	</pre>
				133
Dylan Baker	40ec5fe	2018-12-20 11:27:52 -0800	[diff] [blame]	134	<p>
				135	Please read the <a href="meson.html">detailed meson instructions</a>
				136	for more information
				137	</p>
				138
Brian Paul	7103a18	2012-04-19 09:56:36 -0600	[diff] [blame]	139
				140
Eric Engestrom	fa0dcaa	2019-09-30 19:11:22 +0100	[diff] [blame]	141	<h2 id="scons">3. Building with SCons (Windows/Linux)</h2>
Brian Paul	7103a18	2012-04-19 09:56:36 -0600	[diff] [blame]	142
				143	<p>
				144	To build Mesa with SCons on Linux or Windows do
				145	</p>
				146	<pre>
				147	scons
				148	</pre>
				149	<p>
				150	The build output will be placed in
				151	build/<i>platform</i>-<i>machine</i>-<i>debug</i>/..., where <i>platform</i> is for
				152	example linux or windows, <i>machine</i> is x86 or x86_64, optionally followed
				153	by -debug for debug builds.
				154	</p>
				155
				156	<p>
				157	To build Mesa with SCons for Windows on Linux using the MinGW crosscompiler toolchain do
				158	</p>
				159	<pre>
Jose Fonseca	17b2825	2015-03-03 14:52:15 +0000	[diff] [blame]	160	scons platform=windows toolchain=crossmingw machine=x86 libgl-gdi
Brian Paul	7103a18	2012-04-19 09:56:36 -0600	[diff] [blame]	161	</pre>
				162	<p>
				163	This will create:
				164	</p>
				165	<ul>
Jose Fonseca	17b2825	2015-03-03 14:52:15 +0000	[diff] [blame]	166	<li>build/windows-x86-debug/gallium/targets/libgl-gdi/opengl32.dll — Mesa + Gallium + softpipe (or llvmpipe), binary compatible with Windows's opengl32.dll
Brian Paul	7103a18	2012-04-19 09:56:36 -0600	[diff] [blame]	167	</ul>
				168	<p>
				169	Put them all in the same directory to test them.
Emil Velikov	0fa854a	2016-06-29 13:13:25 +0100	[diff] [blame]	170
				171	Additional information is available in <a href="README.WIN32">README.WIN32</a>.
				172
Brian Paul	7103a18	2012-04-19 09:56:36 -0600	[diff] [blame]	173	</p>
				174
				175
				176
Eric Engestrom	fa0dcaa	2019-09-30 19:11:22 +0100	[diff] [blame]	177	<h2 id="android">4. Building with AOSP (Android)</h2>
Brian Paul	7103a18	2012-04-19 09:56:36 -0600	[diff] [blame]	178
				179	<p>
Emil Velikov	0fa854a	2016-06-29 13:13:25 +0100	[diff] [blame]	180	Currently one can build Mesa for Android as part of the AOSP project, yet
				181	your experience might vary.
Brian Paul	7103a18	2012-04-19 09:56:36 -0600	[diff] [blame]	182	</p>
				183
Emil Velikov	0fa854a	2016-06-29 13:13:25 +0100	[diff] [blame]	184	<p>
				185	In order to achieve that one should update their local manifest to point to the
Eric Engestrom	077879c	2017-02-26 23:58:03 +0000	[diff] [blame]	186	upstream repo, set the appropriate BOARD_GPU_DRIVERS and build the
Emil Velikov	0fa854a	2016-06-29 13:13:25 +0100	[diff] [blame]	187	libGLES_mesa library.
				188	</p>
Brian Paul	7103a18	2012-04-19 09:56:36 -0600	[diff] [blame]	189
Emil Velikov	0fa854a	2016-06-29 13:13:25 +0100	[diff] [blame]	190	<p>
				191	FINISHME: Improve on the instructions add references to Rob H repos/Jenkins,
				192	Android-x86 and/or other resources.
				193	</p>
Brian Paul	7103a18	2012-04-19 09:56:36 -0600	[diff] [blame]	194
				195
Eric Engestrom	fa0dcaa	2019-09-30 19:11:22 +0100	[diff] [blame]	196	<h2 id="libs">5. Library Information</h2>
Brian Paul	7103a18	2012-04-19 09:56:36 -0600	[diff] [blame]	197
				198	<p>
				199	When compilation has finished, look in the top-level <code>lib/</code>
				200	(or <code>lib64/</code>) directory.
				201	You'll see a set of library files similar to this:
				202	</p>
				203	<pre>
Erik Faye-Lund	13b9900	2019-04-18 13:57:03 +0200	[diff] [blame]	204	lrwxrwxrwx 1 brian users 10 Mar 26 07:53 libGL.so -> libGL.so.1*
				205	lrwxrwxrwx 1 brian users 19 Mar 26 07:53 libGL.so.1 -> libGL.so.1.5.060100*
Brian Paul	7103a18	2012-04-19 09:56:36 -0600	[diff] [blame]	206	-rwxr-xr-x 1 brian users 3375861 Mar 26 07:53 libGL.so.1.5.060100*
Erik Faye-Lund	13b9900	2019-04-18 13:57:03 +0200	[diff] [blame]	207	lrwxrwxrwx 1 brian users 14 Mar 26 07:53 libOSMesa.so -> libOSMesa.so.6*
				208	lrwxrwxrwx 1 brian users 23 Mar 26 07:53 libOSMesa.so.6 -> libOSMesa.so.6.1.060100*
Brian Paul	7103a18	2012-04-19 09:56:36 -0600	[diff] [blame]	209	-rwxr-xr-x 1 brian users 23871 Mar 26 07:53 libOSMesa.so.6.1.060100*
				210	</pre>
				211
				212	<p>
Erik Faye-Lund	74a6a68	2019-05-28 14:07:48 +0200	[diff] [blame]	213	<b>libGL</b> is the main OpenGL library (i.e. Mesa), while <b>libOSMesa</b>
				214	is the OSMesa (Off-Screen) interface library.
Brian Paul	7103a18	2012-04-19 09:56:36 -0600	[diff] [blame]	215	</p>
				216
				217	<p>
				218	If you built the DRI hardware drivers, you'll also see the DRI drivers:
				219	</p>
				220	<pre>
				221	-rwxr-xr-x 1 brian users 16895413 Jul 21 12:11 i915_dri.so
				222	-rwxr-xr-x 1 brian users 16895413 Jul 21 12:11 i965_dri.so
				223	-rwxr-xr-x 1 brian users 11849858 Jul 21 12:12 r200_dri.so
Brian Paul	7103a18	2012-04-19 09:56:36 -0600	[diff] [blame]	224	-rwxr-xr-x 1 brian users 11757388 Jul 21 12:12 radeon_dri.so
				225	</pre>
				226
				227	<p>
				228	If you built with Gallium support, look in lib/gallium/ for Gallium-based
				229	versions of libGL and device drivers.
				230	</p>
				231
				232
Eric Engestrom	fa0dcaa	2019-09-30 19:11:22 +0100	[diff] [blame]	233	<h2 id="pkg-config">6. Building OpenGL programs with pkg-config</h2>
Brian	5bba58c	2007-09-12 10:11:49 -0600	[diff] [blame]	234
				235	<p>
Eric Engestrom	46d6883	2019-04-24 13:16:57 +0100	[diff] [blame]	236	Running <code>ninja install</code> will install package configuration files
Brian	5bba58c	2007-09-12 10:11:49 -0600	[diff] [blame]	237	for the pkg-config utility.
				238	</p>
				239
				240	<p>
				241	When compiling your OpenGL application you can use pkg-config to determine
				242	the proper compiler and linker flags.
				243	</p>
				244
				245	<p>
				246	For example, compiling and linking a GLUT application can be done with:
				247	</p>
				248	<pre>
				249	gcc `pkg-config --cflags --libs glut` mydemo.c -o mydemo
				250	</pre>
				251
Andreas Boll	b5da52a	2012-09-18 18:57:02 +0200	[diff] [blame]	252	</div>
Brian Paul	0b27ace	2003-03-08 17:38:57 +0000	[diff] [blame]	253	</body>
				254	</html>