Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / mesa3d / ae44845affebede222dce104bf320465d22bd3c6 / . / docs / vmware-guest.html
blob: b19a7da15883f77662e48f7e76b55b92bcaf884f [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>VMware guest GL driver</title>
6 <link rel="stylesheet" type="text/css" href="mesa.css">
7</head>
Brian Paul27915702012-01-13 10:54:22 -0700[diff] [blame]8<body>
9
Andreas Bollb5da52a2012-09-18 18:57:02 +0200[diff] [blame]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
Brian Paul27915702012-01-13 10:54:22 -0700[diff] [blame]17<h1>VMware guest GL driver</h1>
18
19<p>
Brian Paul7028e6d2012-02-09 18:06:06 -0700[diff] [blame]20This page describes how to build, install and use the
Eric Engestrom30cf9ff2017-02-09 02:10:17 +0000[diff] [blame]21<a href="https://www.vmware.com/">VMware</a> guest GL driver
Brian Paul27915702012-01-13 10:54:22 -0700[diff] [blame]22(aka the SVGA or SVGA3D driver) for Linux using the latest source code.
23This driver gives a Linux virtual machine access to the host's GPU for
24hardware-accelerated 3D.
25VMware Workstation running on Linux or Windows and VMware Fusion running on
26MacOS are all supported.
27</p>
28
29<p>
Brian Paul4fd31482015-08-13 13:50:13 -0700[diff] [blame]30With the August 2015 Workstation 12 / Fusion 8 releases, OpenGL 3.3
31is supported in the guest.
32This requires:
33<ul>
34<li>The VM is configured for virtual hardware version 12.
35<li>The host OS, GPU and graphics driver supports DX11 (Windows) or
36 OpenGL 4.0 (Linux, Mac)
37<li>On Linux, the vmwgfx kernel module must be version 2.9.0 or later.
38<li>A recent version of Mesa with the updated svga gallium driver.
39</ul>
40</p>
41
42<p>
43Otherwise, OpenGL 2.1 is supported.
44</p>
45
46<p>
47OpenGL 3.3 support can be disabled by setting the environment variable
48SVGA_VGPU10=0.
49You will then have OpenGL 2.1 support.
50This may be useful to work around application bugs (such as incorrect use
51of the OpenGL 3.x core profile).
52</p>
53
54<p>
Brian Paulc47207d2014-01-07 10:50:21 -0700[diff] [blame]55Most modern Linux distros include the SVGA3D driver so end users shouldn't
56be concerned with this information.
57But if your distro lacks the driver or you want to update to the latest code
58these instructions explain what to do.
Brian Paul27915702012-01-13 10:54:22 -0700[diff] [blame]59</p>
60
Brian Paul548526f2012-01-13 13:45:58 -0700[diff] [blame]61<p>
62For more information about the X components see these wiki pages at x.org:
63</p>
64<ul>
Eric Engestrom30cf9ff2017-02-09 02:10:17 +0000[diff] [blame]65<li><a href="https://wiki.x.org/wiki/vmware">
Brian Paul548526f2012-01-13 13:45:58 -0700[diff] [blame]66Driver Overview</a>
Eric Engestrom30cf9ff2017-02-09 02:10:17 +0000[diff] [blame]67<li><a href="https://wiki.x.org/wiki/vmware/vmware3D">
Brian Paul548526f2012-01-13 13:45:58 -0700[diff] [blame]68xf86-video-vmware Details</a>
69</ul>
Brian Paul27915702012-01-13 10:54:22 -0700[diff] [blame]70
71
72<h2>Components</h2>
73
74The components involved in this include:
75<ul>
76<li>Linux kernel module: vmwgfx
77<li>X server 2D driver: xf86-video-vmware
78<li>User-space libdrm library
79<li>Mesa/gallium OpenGL driver: "svga"
80</ul>
81
Brian Paulc47207d2014-01-07 10:50:21 -0700[diff] [blame]82<p>
83All of these components reside in the guest Linux virtual machine.
84On the host, all you're doing is running VMware
Eric Engestrom30cf9ff2017-02-09 02:10:17 +0000[diff] [blame]85<a href="https://www.vmware.com/products/workstation/">Workstation</a> or
86<a href="https://www.vmware.com/products/fusion/">Fusion</a>.
Brian Paulc47207d2014-01-07 10:50:21 -0700[diff] [blame]87</p>
88
Brian Paul27915702012-01-13 10:54:22 -0700[diff] [blame]89
90<h2>Prerequisites</h2>
91
92<ul>
93<li>Kernel version at least 2.6.25
94<li>Xserver version at least 1.7
95<li>Ubuntu: For ubuntu you need to install a number of build dependencies.
96 <pre>
97 sudo apt-get install git-core
98 sudo apt-get install automake libtool libpthread-stubs0-dev
Brian Paul481011f2012-01-16 09:59:20 -0700[diff] [blame]99 sudo apt-get install xserver-xorg-dev x11proto-xinerama-dev libx11-xcb-dev
100 sudo apt-get install libxcb-glx0-dev libxrender-dev
Brian Paul27915702012-01-13 10:54:22 -0700[diff] [blame]101 sudo apt-get build-dep libgl1-mesa-dri libxcb-glx0-dev
102 </pre>
103<li>Fedora: For Fedora you also need to install a number of build dependencies.
104 <pre>
105 sudo yum install mesa-libGL-devel xorg-x11-server-devel xorg-x11-util-macros
Brian Paul481011f2012-01-16 09:59:20 -0700[diff] [blame]106 sudo yum install libXrender-devel.i686
Brian Paul27915702012-01-13 10:54:22 -0700[diff] [blame]107 sudo yum install automake gcc libtool expat-devel kernel-devel git-core
Brian Paul481011f2012-01-16 09:59:20 -0700[diff] [blame]108 sudo yum install makedepend flex bison
Brian Paul27915702012-01-13 10:54:22 -0700[diff] [blame]109 </pre>
110</ul>
111
112<p>
113Depending on your Linux distro, other packages may be needed.
114The configure scripts should tell you what's missing.
115</p>
116
117
118
119<h2>Getting the Latest Source Code</h2>
120
121Begin by saving your current directory location:
122 <pre>
123 export TOP=$PWD
124 </pre>
125
126<ul>
127<li>Mesa/Gallium master branch. This code is used to build libGL, and the direct rendering svga driver for libGL, vmwgfx_dri.so, and the X acceleration library libxatracker.so.x.x.x.
128 <pre>
129 git clone git://anongit.freedesktop.org/git/mesa/mesa
130 </pre>
131<li>VMware Linux guest kernel module. Note that this repo contains the complete DRM and TTM code. The vmware-specific driver is really only the files prefixed with vmwgfx.
132 <pre>
133 git clone git://anongit.freedesktop.org/git/mesa/vmwgfx
134 </pre>
Brian Paul133383f2013-01-15 13:00:09 -0700[diff] [blame]135<li>libdrm, a user-space library that interfaces with drm.
136Most distros ship with this but it's safest to install a newer version.
137To get the latest code from git:
Brian Paul27915702012-01-13 10:54:22 -0700[diff] [blame]138 <pre>
139 git clone git://anongit.freedesktop.org/git/mesa/drm
140 </pre>
141<li>xf86-video-vmware. The chainloading driver, vmware_drv.so, the legacy driver vmwlegacy_drv.so, and the vmwgfx driver vmwgfx_drv.so.
142 <pre>
143 git clone git://anongit.freedesktop.org/git/xorg/driver/xf86-video-vmware
144 </pre>
145</ul>
146
147
148<h2>Building the Code</h2>
149
150<ul>
Brian Paul00046392015-11-13 07:59:42 -0700[diff] [blame]151<li>
152Determine where the GL-related libraries reside on your system and set
153the LIBDIR environment variable accordingly.
154<br><br>
155For 32-bit Ubuntu systems:
156<pre>
157 export LIBDIR=/usr/lib/i386-linux-gnu
158</pre>
159For 64-bit Ubuntu systems:
160<pre>
161 export LIBDIR=/usr/lib/x86_64-linux-gnu
162</pre>
163For 32-bit Fedora systems:
164<pre>
165 export LIBDIR=/usr/lib
166</pre>
167For 64-bit Fedora systems:
168<pre>
169 export LIBDIR=/usr/lib64
170</pre>
171
172</li>
173
174<li>Build libdrm:
Brian Paul27915702012-01-13 10:54:22 -0700[diff] [blame]175 <pre>
176 cd $TOP/drm
Brian Paul00046392015-11-13 07:59:42 -0700[diff] [blame]177 ./autogen.sh --prefix=/usr --libdir=${LIBDIR}
Brian Paul27915702012-01-13 10:54:22 -0700[diff] [blame]178 make
179 sudo make install
180 </pre>
181<li>Build Mesa and the vmwgfx_dri.so driver, the vmwgfx_drv.so xorg driver, the X acceleration library libxatracker.
182The vmwgfx_dri.so is used by the OpenGL libraries during direct rendering,
183and by the Xorg server during accelerated indirect GL rendering.
184The libxatracker library is used exclusively by the X server to do render,
185copy and video acceleration:
186<br>
187The following configure options doesn't build the EGL system.
Brian Paul27915702012-01-13 10:54:22 -0700[diff] [blame]188 <pre>
189 cd $TOP/mesa
Brian Paul00046392015-11-13 07:59:42 -0700[diff] [blame]190 ./autogen.sh --prefix=/usr --libdir=${LIBDIR} --with-gallium-drivers=svga --with-dri-drivers=swrast --enable-xa --disable-dri3 --enable-glx-tls
Brian Paul27915702012-01-13 10:54:22 -0700[diff] [blame]191 make
192 sudo make install
193 </pre>
194
195Note that you may have to install other packages that Mesa depends upon
196if they're not installed in your system. You should be told what's missing.
197<br>
198<br>
199
Brian Paul00046392015-11-13 07:59:42 -0700[diff] [blame]200<li>xf86-video-vmware: Now, once libxatracker is installed, we proceed with
201building and replacing the current Xorg driver.
202First check if your system is 32- or 64-bit.
Brian Paul27915702012-01-13 10:54:22 -0700[diff] [blame]203 <pre>
204 cd $TOP/xf86-video-vmware
Brian Paul00046392015-11-13 07:59:42 -0700[diff] [blame]205 ./autogen.sh --prefix=/usr --libdir=${LIBDIR}
Brian Paul27915702012-01-13 10:54:22 -0700[diff] [blame]206 make
207 sudo make install
208 </pre>
Brian Paul00046392015-11-13 07:59:42 -0700[diff] [blame]209
Brian Paul27915702012-01-13 10:54:22 -0700[diff] [blame]210<li>vmwgfx kernel module. First make sure that any old version of this kernel module is removed from the system by issuing
Brian Paul00046392015-11-13 07:59:42 -0700[diff] [blame]211<pre>
Brian Paul27915702012-01-13 10:54:22 -0700[diff] [blame]212 sudo rm /lib/modules/`uname -r`/kernel/drivers/gpu/drm/vmwgfx.ko*
Brian Paul00046392015-11-13 07:59:42 -0700[diff] [blame]213</pre>
214Build and install:
215<pre>
Brian Paul27915702012-01-13 10:54:22 -0700[diff] [blame]216 cd $TOP/vmwgfx
217 make
218 sudo make install
Brian Paul00046392015-11-13 07:59:42 -0700[diff] [blame]219 sudo depmod -a
220</pre>
221If you're using a Ubuntu OS:
222<pre>
223 sudo update-initramfs -u
224</pre>
225If you're using a Fedora OS:
226<pre>
227 sudo dracut --force
228</pre>
229Add 'vmwgfx' to the /etc/modules file:
230<pre>
231 echo vmwgfx | sudo tee -a /etc/modules
232</pre>
Brian Pauld83336c2013-01-28 17:44:46 -0700[diff] [blame]233
234Note: some distros put DRM kernel drivers in different directories.
235For example, sometimes vmwgfx.ko might be found in
236<code>/lib/modules/{version}/extra/vmwgfx.ko</code> or in
237<code>/lib/modules/{version}/kernel/drivers/gpu/drm/vmwgfx/vmwgfx.ko</code>.
238<p>
239After installing vmwgfx.ko you might want to run the following command to
240check that the new kernel module is in the expected place:
241<pre>
242 find /lib/modules -name vmwgfx.ko -exec ls -l '{}' \;
243</pre>
244If you see the kernel module listed in more than one place, you may need to
245move things around.
246<p>
247Finally, if you update your kernel you'll probably have to rebuild and
248reinstall the vmwgfx.ko module again.
Brian Paul27915702012-01-13 10:54:22 -0700[diff] [blame]249</ul>
250
251
252Now try to load the kernel module by issuing
253 <pre>
254 sudo modprobe vmwgfx</pre>
255Then type
256 <pre>
257 dmesg</pre>
258to watch the debug output. It should contain a number of lines prefixed with "[vmwgfx]".
259
260<p>
261Then restart the Xserver (or reboot).
262The lines starting with "vmwlegacy" or "VMWARE" in the file /var/log/Xorg.0.log
263should now have been replaced with lines starting with "vmwgfx", indicating that
264the new Xorg driver is in use.
265</p>
266
267
268<h2>Running OpenGL Programs</h2>
269
270<p>
271In a shell, run 'glxinfo' and look for the following to verify that the
272driver is working:
273</p>
274
275<pre>
276OpenGL vendor string: VMware, Inc.
277OpenGL renderer string: Gallium 0.4 on SVGA3D; build: RELEASE;
278OpenGL version string: 2.1 Mesa 8.0
279</pre>
280
Andreas Bolldf2be222012-06-12 09:05:22 +0200[diff] [blame]281<p>
Brian Paul27915702012-01-13 10:54:22 -0700[diff] [blame]282If you don't see this, try setting this environment variable:
283 <pre>
284 export LIBGL_DEBUG=verbose</pre>
Andreas Bolldf2be222012-06-12 09:05:22 +0200[diff] [blame]285<p>
Brian Paul27915702012-01-13 10:54:22 -0700[diff] [blame]286then rerun glxinfo and examine the output for error messages.
287</p>
288
Brian Paul4fd31482015-08-13 13:50:13 -0700[diff] [blame]289<p>
290If OpenGL 3.3 is not working (you only get OpenGL 2.1):
291</p>
292<ul>
293<li>Make sure the VM uses hardware version 12.
294<li>Make sure the vmwgfx kernel module is version 2.9.0 or later.
295<li>Check the vmware.log file for errors.
296<li>Run 'dmesg | grep vmwgfx' and look for "DX: yes".
297
298
Andreas Bollb5da52a2012-09-18 18:57:02 +0200[diff] [blame]299</div>
Brian Paul27915702012-01-13 10:54:22 -0700[diff] [blame]300</body>
301</html>