source: x/installing/mesa.xml@ d08650a

11.1 11.2 11.3 12.0 12.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since d08650a was 43149b8, checked in by Douglas R. Reno <renodr@…>, 2 years ago

Update to Mesa-21.3.6, and fix several multi-threading issues in the
Nouveau driver in Mesa.

  • Property mode set to 100644
File size: 19.5 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY mesa-download-http "https://mesa.freedesktop.org/archive/mesa-&mesa-version;.tar.xz">
8 <!ENTITY mesa-download-ftp "ftp://ftp.freedesktop.org/pub/mesa/mesa-&mesa-version;.tar.xz">
9 <!ENTITY mesa-md5sum "3177e69362d2be742596967e7f87298e">
10 <!ENTITY mesa-size "16 MB">
11 <!ENTITY mesa-buildsize "756 MB (with docs, add 389 MB for tests)">
12 <!ENTITY mesa-time "3.6 SBU (Using parallelism=4; with docs, add 0.5 SBU for tests)">
13]>
14
15<sect1 id="mesa" xreflabel="Mesa-&mesa-version;">
16 <?dbhtml filename="mesa.html"?>
17
18 <sect1info>
19 <date>$Date$</date>
20 </sect1info>
21
22 <title>Mesa-&mesa-version;</title>
23
24 <indexterm zone="mesa">
25 <primary sortas="a-Mesa">Mesa</primary>
26 </indexterm>
27
28 <sect2 role="package">
29 <title>Introduction to Mesa</title>
30
31 <para>
32 <application>Mesa</application> is an OpenGL compatible 3D graphics
33 library.
34 </para>
35
36 <note>
37 <para>
38 <application>Mesa</application> is updated relatively often. You may
39 want to use the latest available &mesa-major-minor;.x mesa version.
40 </para>
41 </note>
42
43 &lfs110a_checked;
44
45 <bridgehead renderas="sect3">Package Information</bridgehead>
46 <itemizedlist spacing="compact">
47 <listitem>
48 <para>
49 Download (HTTP): <ulink url="&mesa-download-http;"/>
50 </para>
51 </listitem>
52 <listitem>
53 <para>
54 Download (FTP): <ulink url="&mesa-download-ftp;"/>
55 </para>
56 </listitem>
57 <listitem>
58 <para>
59 Download MD5 sum: &mesa-md5sum;
60 </para>
61 </listitem>
62 <listitem>
63 <para>
64 Download size: &mesa-size;
65 </para>
66 </listitem>
67 <listitem>
68 <para>
69 Estimated disk space required: &mesa-buildsize;
70 </para>
71 </listitem>
72 <listitem>
73 <para>
74 Estimated build time: &mesa-time;
75 </para>
76 </listitem>
77 </itemizedlist>
78
79 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
80 <itemizedlist spacing="compact">
81 <listitem>
82 <para>
83 Recommended patch:
84 <ulink url="&patch-root;/mesa-&mesa-version;-add_xdemos-1.patch"/>
85 (installs 2 demo programs for testing Mesa - not needed if you
86 install the <ulink url="ftp://ftp.freedesktop.org/pub/mesa/demos/">
87 mesa-demos</ulink> package)
88 </para>
89 </listitem>
90 <listitem>
91 <para>
92 Required patch (for systems with NVIDIA GPUs):
93 <ulink url="&patch-root;/mesa-&mesa-version;-nouveau_fixes-1.patch"/>
94 </para>
95 </listitem>
96 </itemizedlist>
97
98 <bridgehead renderas="sect3">Mesa Dependencies</bridgehead>
99
100 <bridgehead renderas="sect4">Required</bridgehead>
101 <para role="required">
102 <xref linkend="xorg7-lib"/>,
103 <xref linkend="libdrm"/>, and
104 <xref linkend="Mako"/>
105 </para>
106
107 <bridgehead renderas="sect4">Recommended</bridgehead>
108 <para role="recommended">
109
110 <xref role="first" linkend="libva"/> (to provide VA-API support for some
111 gallium drivers, note that there is a circular dependency. You must
112 build <application>libva</application> first without EGL and GLX support,
113 install this package, and rebuild <application>libva</application>),
114 <xref linkend="libvdpau"/> (to build VDPAU drivers),
115 <xref linkend="llvm"/> (required for Gallium3D, nouveau, r300, and radeonsi
116 drivers and for swrast, the software rasterizer which is sometimes referred
117 to as llvmpipe. See <ulink role="nodep"
118 url="https://docs.mesa3d.org/systems.html"/> for more information), and
119 <xref linkend="wayland-protocols"/> (required for
120 <xref role="nodep" linkend='plasma5-build'/>,
121 <!-- <xref role="nodep" linkend='lxqt'/>, -->
122 GNOME, and recommended for <xref role="nodep" linkend='gtk3'/>)
123 </para>
124
125 <bridgehead renderas="sect4">Optional</bridgehead>
126 <para role="optional">
127 <xref linkend="libgcrypt"/>,
128 <xref linkend="lm_sensors"/> <!-- for libsensors according to Meson -->,
129 <xref linkend="nettle"/>,
130 <xref linkend="valgrind"/>,
131 <ulink url="ftp://ftp.freedesktop.org/pub/mesa/demos/">mesa-demos</ulink>
132 (provides more than 300 extra demos to test
133 <application>Mesa</application>; this includes the same programs added by
134 the patch above),
135 <ulink url="http://omxil.sourceforge.net/">Bellagio OpenMAX Integration
136 Layer</ulink> (for mobile platforms),
137 <ulink url="http://www.nongnu.org/libunwind/">libunwind</ulink>,
138 <ulink url="https://github.com/tizonia/tizonia-openmax-il/wiki/Tizonia-OpenMAX-IL/">
139 libtizonia</ulink>, and
140 <ulink url="https://www.vulkan.org/">libvulkan</ulink> (for the zink driver)
141 </para>
142
143 <note>
144 <para>
145 The instructions below assume that
146 <application>LLVM</application> with the r600/amdgpu and host backends
147 and run-time type information (RTTI - needed for nouveau) are installed.
148 You will need to modify the instructions if you
149 choose not to install all of these. For an explanation of Gallium3D see
150 <ulink url="https://en.wikipedia.org/wiki/Gallium3D"/>.
151 </para>
152 </note>
153
154 <para condition="html" role="usernotes">User Notes:
155 <ulink url="&blfs-wiki;/mesalib"/>
156 </para>
157 </sect2>
158
159 <sect2 role="installation">
160 <title>Installation of Mesa</title>
161
162 <para>
163 If you have downloaded the xdemos patch (needed if testing the Xorg
164 installation per BLFS instructions), apply it by running the following
165 command:
166 </para>
167
168<screen><userinput>patch -Np1 -i ../mesa-&mesa-version;-add_xdemos-1.patch</userinput></screen>
169
170 <!-- Note that freedreno, vc4, and virgl all need special support from
171 libdrm - renodr
172 For me, libdrm does not mention virgl, but mesa accepts it. AFAICS
173 freedreno is for qualcom hardware, libdrm will build for it on suitable
174 systems. VC4 is for the Broadcom VC4 used in the raspberry pi - ken -->
175
176 <note>
177 <para>
178 The measurements above, and the Contents below, are for a full build.
179 Many people will not wish to install drivers they cannot use, so the
180 following paragraphs explain how to limit the drivers, and give an
181 example which can be be reduced or amended as necessary.
182 </para>
183 </note>
184
185 <para>
186 Now, select the drivers you wish to install. For the X86 architecture, the
187 available gallium drivers are auto (<emphasis>in 21.2.1 this does not select
188 crocus </emphasis>), <emphasis>or alternatively a choice from</emphasis>
189 crocus, i915, iris, nouveau, r300, r600, radeonsi, svga, swrast, and virgl.
190 The latter can provide acceleration in <xref linkend="qemu"/> if that has
191 been linked against
192 <ulink url="https://gitlab.freedesktop.org/virgl/virglrenderer/~/releases/">virglrenderer</ulink>
193 (you will need a freedesktop.org account to get to that page, you can
194 download the 0.9.1 release without an account from
195 <ulink url="https://gitlab.freedesktop.org/virgl/virglrenderer/-/archive/0.9.1/virglrenderer-0.9.1.tar.bz2">virglrenderer-0.9.1</ulink>).
196<!-- If you wish to build all available gallium drivers,
197 use 'auto'. FIXME : does not build crocus in 21.2.1 -->
198
199 <!-- crocus was added to the default x86/x86_64 drivers for meson in the
200 master branch on 2021-08-31, at some point it will appear in a stable release -->
201 </para>
202
203 <para>
204 The (non-gallium) DRI drivers available in X86 are auto, <emphasis>or
205 alternatively a choice from</emphasis> i915, i965, nouveau, r100, r200,
206 and swrast. Use 'auto' to build all available DRI drivers, or use an
207 empty string (DRI_DRIVERS="") if you wish to only build gallium drivers.
208 </para>
209
210 <para>
211 The platforms ("window systems") available for X86 linux are x11, wayland,
212 <!--drm,--> and surfaceless. By not specifying anything, the meson
213 build-system will build for all these platforms if you have the
214 dependencies, identical to if you had specified '-Dplatforms=auto'.
215 </para>
216
217 <para>
218 Modify the commands below for your desired drivers. The drivers listed
219 below will cover most modern video cards and virtual machines. For help in
220 selecting drivers see <ulink url="https://docs.mesa3d.org/systems.html"/>.
221 <!-- these two don't seem to be mentioned in that mesa link -->
222 For intel drivers, specify crocus for i965 gen 4 through to haswell, iris
223 for broadwell and later.
224 </para>
225
226 <note>
227 <para>
228 Although the nouveau drivers can be built for both gallium and dri, the
229 i915 driver can only be built for one or the other.
230 </para>
231 </note>
232
233<screen><userinput>GALLIUM_DRV="crocus,i915,iris,nouveau,r600,radeonsi,svga,swrast,virgl"
234DRI_DRIVERS="i965,nouveau"</userinput></screen>
235
236 <note>
237 <para>
238 If you are using a NVIDIA GPU in your system, a special patch has been
239 created that allows for proper multi-threading in the Mesa driver. This
240 fixes issues with multi-threaded Qt applications, as well as with
241 starting some GNOME Applications. This patch is also essential if you
242 plan to use KDE Plasma.
243
244 Apply the patch using the following command:
245 </para>
246
247<screen><userinput remap="pre">patch -Np1 -i ../mesa-&mesa-version;-nouveau_fixes-1.patch</userinput></screen>
248 </note>
249
250 <para>
251 Install <application>Mesa</application> by running the following
252 commands:
253 </para>
254
255<screen><userinput>mkdir build &amp;&amp;
256cd build &amp;&amp;
257
258meson --prefix=$XORG_PREFIX \
259 --buildtype=release \
260 -Ddri-drivers=$DRI_DRIVERS \
261 -Dgallium-drivers=$GALLIUM_DRV \
262 -Dgallium-nine=false \
263 -Dglx=dri \
264 -Dvalgrind=disabled \
265 -Dlibunwind=disabled \
266 .. &amp;&amp;
267
268unset GALLIUM_DRV DRI_DRIVERS &amp;&amp;
269
270ninja</userinput></screen>
271
272 <para>
273 If you built the tests (see 'Command Explanations'), to run them issue:
274 <command>ninja test</command>.
275<!-- All tests passed for me for 21.2.4 [pierre]
276 All 33 subtests tests in the mesa:compiler+glsl / glsl compiler warnings
277 suite are known to fail.-->
278 </para>
279
280 <para>
281 Now, as the <systemitem class="username">root</systemitem> user:
282 </para>
283
284<screen role="root"><userinput>ninja install</userinput></screen>
285
286 <para>
287 If desired, install the optional documentation by running
288 the following commands as the
289 <systemitem class="username">root</systemitem> user:
290 </para>
291
292<screen role="root"
293 remap="doc"><userinput>install -v -dm755 /usr/share/doc/mesa-&mesa-version; &amp;&amp;
294cp -rfv ../docs/* /usr/share/doc/mesa-&mesa-version;</userinput></screen>
295
296 </sect2>
297
298 <sect2 role="commands">
299 <title>Command Explanations</title>
300
301 <para>
302 <parameter>--buildtype=release</parameter>: This switch ensures a
303 fully-optimized build, and disables debug assertions which will
304 severely slow down the libraries in certain use-cases. Without this
305 switch, build sizes can span into the 2GB range.
306 </para>
307
308 <para>
309 <parameter>-Ddri-drivers="..."</parameter>: This parameter
310 controls which (non-gallium) dri drivers should be built.
311 </para>
312
313 <para>
314 <parameter>-Dgallium-drivers="..."</parameter>: This parameter
315 controls which Gallium3D drivers should be built.
316 </para>
317
318 <para>
319 <parameter>-Dgallium-nine=false</parameter>: Prevents building
320 support for (MS Windows) games designed for DX9. Set it to true if
321 this support is desired.
322 </para>
323<!--
324 <para>
325 <parameter>-Dosmesa=true</parameter>: This switch enables building
326 the <filename class="libraryfile">libOSMesa</filename> library and
327 provides Gallium3D support in it. It requires the swrast gallium driver.
328 </para>
329-->
330<!--
331 <para>
332 <parameter>-Dplatforms="..."</parameter>: This parameter
333 controls which platforms EGL will be built for. Available
334 linux X86 platforms are drm, x11, wayland, and surfaceless.
335 </para>
336-->
337 <para>
338 <parameter>-Dvalgrind=disabled</parameter>: This parameter disables
339 the usage of Valgrind during the build process. Remove this parameter
340 if you have Valgrind installed, and wish to check for memory leaks.
341 </para>
342
343 <para>
344 <parameter>-Dlibunwind=disabled</parameter>: This parameter disables
345 the usage of libunwind.
346 </para>
347
348<!--
349 <para>
350 <parameter>- -enable-xa</parameter>: This switch enables building the
351 XA X Acceleration API (Required for VMware 3D Driver).
352 </para>
353
354 <para>
355 <parameter>- -enable-gbm</parameter>: This switch enables building the
356 <application>Mesa</application> Graphics Buffer Manager library.
357 </para>
358 These two seem to be automatic in 19.0 - ken
359
360 <para>
361 <parameter>- -enable-glx-tls</parameter>: This switch enables TLS (Thread Local
362 Storage) support in GLX.
363 </para>
364-->
365 <para>
366 <option>-Dbuild-tests=true</option>: This option will cause the test code
367 to be enabled. To run the tests, issue: <command>ninja test</command>.
368 </para>
369
370 <para>
371 <option>-Dvulkan-drivers=...</option>: This option allows choosing which
372 Vulkan drivers are built. Since those drivers depend on the
373 corresponding Gallium3D drivers, do not enable drivers that are not
374 enabled in Gallium3D drivers. Furthermore, since BLFS does not use
375 Vulkan, it is safe to leave the list of Vulkan drivers empty.
376 </para>
377
378 </sect2>
379
380 <sect2 role="content">
381 <title>Contents</title>
382
383 <segmentedlist>
384 <segtitle>Installed Programs</segtitle>
385 <segtitle>Installed Libraries</segtitle><!-- in /usr/lib -->
386 <segtitle>Installed Drivers</segtitle><!-- in /usr/lib/<subdir> -->
387 <segtitle>Installed Directories</segtitle>
388
389 <seglistitem>
390 <seg>
391 glxgears and glxinfo
392 </seg>
393 <seg>
394 libEGL.so,
395 libGL.so,
396 libGLESv1_CM.so,
397 libGLESv2.so,
398<!-- libOSMesa.so,-->
399 libXvMCnouveau.so,
400 libXvMCr600.so,
401 libgbm.so,
402 libglapi.so,
403 <!-- Begin Vulkan drivers -->
404 libvulkan_intel.so,
405 libvulkan_lvp.so,
406 libvulkan_radeon.so, and
407 <!-- End Vulkan drivers -->
408 libxatracker.so,
409 </seg>
410 <seg>
411 <!-- Begin gallium DRI drivers : this is the full set -->
412 d3dadapter9.so (optional), <!-- For Windows games. This is DirectX's
413 Direct3D -->
414 crocus_dri.so,
415<!-- i830_dri.so,-->
416 i915_dri.so,
417 i965_dri.so,
418 iris_dri.so,
419 kms_swrast_dri.so,
420 nouveau_dri.so,
421 nouveau_drv_video.so,
422 nouveau_vieux_dri.so,
423 r200_dri.so (optional),
424 r300_dri.so (optional),
425 r600_dri.so,
426 r600_drv_video.so,
427 radeon_dri.so (optional),
428 radeonsi_dri.so,
429 radeonsi_drv_video.so,
430 swrast_dri.so,
431 virtio_gpu_dri.so,
432 vmwgfx_dri.so,
433 <!-- End DRI Drivers -->
434 <!-- Begin VDPAU drivers -->
435 libvdpau_nouveau.so,
436 libvdpau_r300.so (optional),
437 libvdpau_r600.so, and
438 libvdpau_radeonsi.so
439 <!-- End VDPAU drivers -->
440 (Many of these drivers are hard-linked).
441 </seg>
442 <seg>
443 $XORG_PREFIX/{include/{EGL,GL,GLES,GLES2,GLES3,KHR},lib/{dri,vdpau}},
444 $XORG_PREFIX/include/d3adapter (optional),
445 $XORG_PREFIX/lib/d3d (optional),
446 $XORG_PREFIX/share/drirc.d (contains workarounds for various applications,
447 particularly browsers and games),
448 $XORG_PREFIX/share/vulkan,
449 and
450 /usr/share/doc/mesa-&mesa-version; (optional)
451 </seg>
452 </seglistitem>
453 </segmentedlist>
454
455 <variablelist>
456 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
457 <?dbfo list-presentation="list"?>
458 <?dbhtml list-presentation="table"?>
459
460 <varlistentry id="glxgears">
461 <term><command>glxgears</command></term>
462 <listitem>
463 <para>
464 is a GL demo useful for troubleshooting graphics
465 problems
466 </para>
467 <indexterm zone="mesa glxgears">
468 <primary sortas="b-glxgears">glxgears</primary>
469 </indexterm>
470 </listitem>
471 </varlistentry>
472
473 <varlistentry id="glxinfo">
474 <term><command>glxinfo</command></term>
475 <listitem>
476 <para>
477 is a diagnostic program that displays information about the
478 graphics hardware and installed GL libraries
479 </para>
480 <indexterm zone="mesa glxinfo">
481 <primary sortas="b-glxinfo">glxinfo</primary>
482 </indexterm>
483 </listitem>
484 </varlistentry>
485
486 <varlistentry id="libEGL">
487 <term><filename class="libraryfile">libEGL.so</filename></term>
488 <listitem>
489 <para>
490 provides a native platform graphics interface as
491 defined by the EGL-1.4 specification
492 </para>
493 <indexterm zone="mesa libEGL">
494 <primary sortas="c-libGL">libEGL.so</primary>
495 </indexterm>
496 </listitem>
497 </varlistentry>
498
499 <varlistentry id="libgbm">
500 <term><filename class="libraryfile">libgbm.so</filename></term>
501 <listitem>
502 <para>
503 is the <application>Mesa</application> Graphics Buffer
504 Manager library
505 </para>
506 <indexterm zone="mesa libgbm">
507 <primary sortas="c-libgbm">libgbm.so</primary>
508 </indexterm>
509 </listitem>
510 </varlistentry>
511
512 <varlistentry id="libGLESv1_CM">
513 <term><filename class="libraryfile">libGLESv1_CM.so</filename></term>
514 <listitem>
515 <para>
516 is the <application>Mesa</application> OpenGL ES 1.1 library
517 </para>
518 <indexterm zone="mesa libGLESv1_CM">
519 <primary sortas="c-libGLESv1_CM">libGLESv1_CM.so</primary>
520 </indexterm>
521 </listitem>
522 </varlistentry>
523
524 <varlistentry id="libGLES2">
525 <term><filename class="libraryfile">libGLES2.so</filename></term>
526 <listitem>
527 <para>
528 is the <application>Mesa</application> OpenGL ES 2.0 library
529 </para>
530 <indexterm zone="mesa libGLES2">
531 <primary sortas="c-libGLES2">libGLES2.so</primary>
532 </indexterm>
533 </listitem>
534 </varlistentry>
535
536 <varlistentry id="libGL">
537 <term><filename class="libraryfile">libGL.so</filename></term>
538 <listitem>
539 <para>
540 is the main <application>Mesa</application> OpenGL library
541 </para>
542 <indexterm zone="mesa libGL">
543 <primary sortas="c-libGL">libGL.so</primary>
544 </indexterm>
545 </listitem>
546 </varlistentry>
547<!--
548 <varlistentry id="libOSMesa">
549 <term><filename class="libraryfile">libOSMesa.so</filename></term>
550 <listitem>
551 <para>
552 is the <application>Mesa</application> Off-screen Rendering library
553 </para>
554 <indexterm zone="mesa libOSMesa">
555 <primary sortas="c-libOSMesa">libOSMesa.so</primary>
556 </indexterm>
557 </listitem>
558 </varlistentry>
559-->
560 </variablelist>
561
562 </sect2>
563
564</sect1>
Note: See TracBrowser for help on using the repository browser.