source: x/installing/mesa.xml@ 6d90301

12.0 12.1 gimp3 ken/TL2024 ken/tuningfonts lazarus lxqt plabs/newcss python3.11 rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/for-12.3 xry111/llvm18 xry111/spidermonkey128
Last change on this file since 6d90301 was 14891a90, checked in by Xi Ruoyao <xry111@…>, 14 months ago

treewide: More "User Notes" clean up

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