Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / mesa3d / a73c59b7a6f45aeca32134873f893af178b354b8 / . / docs / vmware-guest.html
blob: 62c8445791cac69bf77ab47d2d09054768f0fc8e [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
Andreas Bolla73c59b2012-09-18 19:31:28 +0200[diff] [blame^]21<a href="http://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>
30End users shouldn't have to go through all these steps once the driver is
31included in newer Linux distributions.
32</p>
33
Brian Paul548526f2012-01-13 13:45:58 -0700[diff] [blame]34<p>
35For more information about the X components see these wiki pages at x.org:
36</p>
37<ul>
Andreas Bolla73c59b2012-09-18 19:31:28 +0200[diff] [blame^]38<li><a href="http://wiki.x.org/wiki/vmware">
Brian Paul548526f2012-01-13 13:45:58 -0700[diff] [blame]39Driver Overview</a>
Andreas Bolla73c59b2012-09-18 19:31:28 +0200[diff] [blame^]40<li><a href="http://wiki.x.org/wiki/vmware/vmware3D">
Brian Paul548526f2012-01-13 13:45:58 -0700[diff] [blame]41xf86-video-vmware Details</a>
42</ul>
Brian Paul27915702012-01-13 10:54:22 -0700[diff] [blame]43
44
45<h2>Components</h2>
46
47The components involved in this include:
48<ul>
49<li>Linux kernel module: vmwgfx
50<li>X server 2D driver: xf86-video-vmware
51<li>User-space libdrm library
52<li>Mesa/gallium OpenGL driver: "svga"
53</ul>
54
55
56<h2>Prerequisites</h2>
57
58<ul>
59<li>Kernel version at least 2.6.25
60<li>Xserver version at least 1.7
61<li>Ubuntu: For ubuntu you need to install a number of build dependencies.
62 <pre>
63 sudo apt-get install git-core
64 sudo apt-get install automake libtool libpthread-stubs0-dev
Brian Paul481011f2012-01-16 09:59:20 -0700[diff] [blame]65 sudo apt-get install xserver-xorg-dev x11proto-xinerama-dev libx11-xcb-dev
66 sudo apt-get install libxcb-glx0-dev libxrender-dev
Brian Paul27915702012-01-13 10:54:22 -0700[diff] [blame]67 sudo apt-get build-dep libgl1-mesa-dri libxcb-glx0-dev
68 </pre>
69<li>Fedora: For Fedora you also need to install a number of build dependencies.
70 <pre>
71 sudo yum install mesa-libGL-devel xorg-x11-server-devel xorg-x11-util-macros
Brian Paul481011f2012-01-16 09:59:20 -0700[diff] [blame]72 sudo yum install libXrender-devel.i686
Brian Paul27915702012-01-13 10:54:22 -0700[diff] [blame]73 sudo yum install automake gcc libtool expat-devel kernel-devel git-core
Brian Paul481011f2012-01-16 09:59:20 -0700[diff] [blame]74 sudo yum install makedepend flex bison
Brian Paul27915702012-01-13 10:54:22 -0700[diff] [blame]75 </pre>
76</ul>
77
78<p>
79Depending on your Linux distro, other packages may be needed.
80The configure scripts should tell you what's missing.
81</p>
82
83
84
85<h2>Getting the Latest Source Code</h2>
86
87Begin by saving your current directory location:
88 <pre>
89 export TOP=$PWD
90 </pre>
91
92<ul>
93<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.
94 <pre>
95 git clone git://anongit.freedesktop.org/git/mesa/mesa
96 </pre>
97<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.
98 <pre>
99 git clone git://anongit.freedesktop.org/git/mesa/vmwgfx
100 </pre>
101
102<li>libdrm, A user-space library that interfaces with drm. Most distros ship with this driver. Safest bet is really to replace the system one. Optionally you can point LIBDRM_CFLAGS and LIBDRM_LIBS to the libdrm-2.4.22 package in toolchain. But here, we replace:
103 <pre>
104 git clone git://anongit.freedesktop.org/git/mesa/drm
105 </pre>
106<li>xf86-video-vmware. The chainloading driver, vmware_drv.so, the legacy driver vmwlegacy_drv.so, and the vmwgfx driver vmwgfx_drv.so.
107 <pre>
108 git clone git://anongit.freedesktop.org/git/xorg/driver/xf86-video-vmware
109 </pre>
110</ul>
111
112
113<h2>Building the Code</h2>
114
115<ul>
116<li>Build libdrm: If you're on a 32-bit system, you should skip the --libdir configure option. Note also the comment about toolchain libdrm above.
117 <pre>
118 cd $TOP/drm
119 ./autogen.sh --prefix=/usr --enable-vmwgfx-experimental-api --libdir=/usr/lib64
120 make
121 sudo make install
122 </pre>
123<li>Build Mesa and the vmwgfx_dri.so driver, the vmwgfx_drv.so xorg driver, the X acceleration library libxatracker.
124The vmwgfx_dri.so is used by the OpenGL libraries during direct rendering,
125and by the Xorg server during accelerated indirect GL rendering.
126The libxatracker library is used exclusively by the X server to do render,
127copy and video acceleration:
128<br>
129The following configure options doesn't build the EGL system.
130<br>
131As before, if you're on a 32-bit system, you should skip the --libdir
132configure option.
133 <pre>
134 cd $TOP/mesa
135 ./autogen.sh --prefix=/usr --libdir=/usr/lib64 --with-gallium-drivers=svga --with-dri-drivers= --enable-xa
136 make
137 sudo make install
138 </pre>
139
140Note that you may have to install other packages that Mesa depends upon
141if they're not installed in your system. You should be told what's missing.
142<br>
143<br>
144
145<li>xf86-video-vmware: Now, once libxatracker is installed, we proceed with building and replacing the current Xorg driver. First check if your system is 32- or 64-bit. If you're building for a 32-bit system, you will not be needing the --libdir=/usr/lib64 option to autogen.
146 <pre>
147 cd $TOP/xf86-video-vmware
148 ./autogen.sh --prefix=/usr --libdir=/usr/lib64
149 make
150 sudo make install
151 </pre>
152<li>vmwgfx kernel module. First make sure that any old version of this kernel module is removed from the system by issuing
153 <pre>
154 sudo rm /lib/modules/`uname -r`/kernel/drivers/gpu/drm/vmwgfx.ko*
155 </pre>
156Then
157 <pre>
158 cd $TOP/vmwgfx
159 make
160 sudo make install
161 sudo cp 00-vmwgfx.rules /etc/udev/rules.d
162 sudo depmod -ae
163 </pre>
164</ul>
165
166
167Now try to load the kernel module by issuing
168 <pre>
169 sudo modprobe vmwgfx</pre>
170Then type
171 <pre>
172 dmesg</pre>
173to watch the debug output. It should contain a number of lines prefixed with "[vmwgfx]".
174
175<p>
176Then restart the Xserver (or reboot).
177The lines starting with "vmwlegacy" or "VMWARE" in the file /var/log/Xorg.0.log
178should now have been replaced with lines starting with "vmwgfx", indicating that
179the new Xorg driver is in use.
180</p>
181
182
183<h2>Running OpenGL Programs</h2>
184
185<p>
186In a shell, run 'glxinfo' and look for the following to verify that the
187driver is working:
188</p>
189
190<pre>
191OpenGL vendor string: VMware, Inc.
192OpenGL renderer string: Gallium 0.4 on SVGA3D; build: RELEASE;
193OpenGL version string: 2.1 Mesa 8.0
194</pre>
195
Andreas Bolldf2be222012-06-12 09:05:22 +0200[diff] [blame]196<p>
Brian Paul27915702012-01-13 10:54:22 -0700[diff] [blame]197If you don't see this, try setting this environment variable:
198 <pre>
199 export LIBGL_DEBUG=verbose</pre>
Andreas Bolldf2be222012-06-12 09:05:22 +0200[diff] [blame]200<p>
Brian Paul27915702012-01-13 10:54:22 -0700[diff] [blame]201then rerun glxinfo and examine the output for error messages.
202</p>
203
Andreas Bollb5da52a2012-09-18 18:57:02 +0200[diff] [blame]204</div>
Brian Paul27915702012-01-13 10:54:22 -0700[diff] [blame]205</body>
206</html>