VirtualBox

source: vbox/trunk/src/VBox/Additions/WINNT/VBoxGuest/NTLegacy.cpp@ 10759

Last change on this file since 10759 was 8781, checked in by vboxsync, 17 years ago

Windows guest HGCM optimization: use a preallocated timeout variable.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 12.4 KB
Line 
1/** @file
2 *
3 * VBoxGuest -- VirtualBox Win32 guest support driver
4 *
5 * Copyright (C) 2006-2007 Sun Microsystems, Inc.
6 *
7 * This file is part of VirtualBox Open Source Edition (OSE), as
8 * available from http://www.virtualbox.org. This file is free software;
9 * you can redistribute it and/or modify it under the terms of the GNU
10 * General Public License (GPL) as published by the Free Software
11 * Foundation, in version 2 as it comes in the "COPYING" file of the
12 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
13 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
14 *
15 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
16 * Clara, CA 95054 USA or visit http://www.sun.com if you need
17 * additional information or have any questions.
18 */
19
20// enable backdoor logging
21//#define LOG_ENABLED
22
23/*******************************************************************************
24* Header Files *
25*******************************************************************************/
26#include "NTLegacy.h"
27#include "Helper.h"
28
29#include <VBox/VBoxGuestLib.h>
30
31/*******************************************************************************
32* Defined Constants And Macros *
33*******************************************************************************/
34
35
36/*******************************************************************************
37* Internal Functions *
38*******************************************************************************/
39extern "C"
40{
41static NTSTATUS findPCIDevice(PULONG pBusNumber, PPCI_SLOT_NUMBER pSlotNumber);
42static void freeDeviceResources(PDRIVER_OBJECT pDrvObj, PDEVICE_OBJECT pDevObj);
43}
44
45#ifdef ALLOC_PRAGMA
46#pragma alloc_text (INIT, ntCreateDevice)
47#pragma alloc_text (INIT, findPCIDevice)
48#pragma alloc_text (INIT, freeDeviceResources)
49#endif
50
51/**
52 * Helper function to create the device object
53 *
54 * @returns NT status code
55 * @param
56 */
57NTSTATUS ntCreateDevice(PDRIVER_OBJECT pDrvObj, PDEVICE_OBJECT pDevObj, PUNICODE_STRING pRegPath)
58{
59 ULONG busNumber, slotNumber;
60// ULONG i;
61 NTSTATUS rc = STATUS_SUCCESS;
62
63 dprintf(("VBoxGuest::ntCreateDevice: entered\n"));
64
65 // find our virtual PCI device
66 rc = findPCIDevice(&busNumber, (PCI_SLOT_NUMBER*)&slotNumber);
67 if (!NT_SUCCESS(rc))
68 {
69 dprintf(("VBoxGuest::createDevice: device not found, returning\n"));
70 return rc;
71 }
72
73 /*
74 * Create device.
75 */
76 PDEVICE_OBJECT deviceObject = NULL;
77 UNICODE_STRING DevName;
78 RtlInitUnicodeString(&DevName, VBOXGUEST_DEVICE_NAME_NT);
79 rc = IoCreateDevice(pDrvObj, sizeof(VBOXGUESTDEVEXT), &DevName, FILE_DEVICE_UNKNOWN, 0, FALSE, &deviceObject);
80 if (!NT_SUCCESS(rc))
81 {
82 dprintf(("VBoxGuest::ntCreateDevice: IoCreateDevice failed with rc=%#x!\n", rc));
83 return rc;
84 }
85 dprintf(("VBoxGuest::ntCreateDevice: device created\n"));
86 UNICODE_STRING DosName;
87 RtlInitUnicodeString(&DosName, VBOXGUEST_DEVICE_NAME_DOS);
88 rc = IoCreateSymbolicLink(&DosName, &DevName);
89 if (!NT_SUCCESS(rc))
90 {
91 dprintf(("VBoxGuest::ntCreateDevice: IoCreateSymbolicLink failed with rc=%#x!\n", rc));
92 IoDeleteDevice(deviceObject);
93 return rc;
94 }
95 dprintf(("VBoxGuest::ntCreateDevice: symlink created\n"));
96
97 /*
98 * Setup the device extension.
99 */
100 PVBOXGUESTDEVEXT pDevExt = (PVBOXGUESTDEVEXT)deviceObject->DeviceExtension;
101 RtlZeroMemory(pDevExt, sizeof(VBOXGUESTDEVEXT));
102
103 if (pDevObj)
104 {
105 pDevExt->nextLowerDriver = IoAttachDeviceToDeviceStack(deviceObject, pDevObj);
106 if (pDevExt->nextLowerDriver == NULL)
107 {
108 dprintf(("VBoxGuest::ntCreateDevice: IoAttachDeviceToDeviceStack did not give a nextLowerDrive\n"));
109 IoDeleteSymbolicLink(&DosName);
110 IoDeleteDevice(deviceObject);
111 return STATUS_NO_SUCH_DEVICE;
112 }
113 }
114 // store a reference to ourself
115 pDevExt->deviceObject = deviceObject;
116 // store bus and slot number we've queried before
117 pDevExt->busNumber = busNumber;
118 pDevExt->slotNumber = slotNumber;
119
120 //
121 // let's have a look at what our PCI adapter offers
122 //
123 dprintf(("VBoxGuest::ntCreateDevice: starting to scan PCI resources of VBoxGuest\n"));
124 // assign the PCI resources
125 PCM_RESOURCE_LIST resourceList;
126 UNICODE_STRING classNameString;
127 RtlInitUnicodeString(&classNameString, L"VBoxGuestAdapter");
128 rc = HalAssignSlotResources(pRegPath, &classNameString,
129 pDrvObj, pDevObj,
130 PCIBus, busNumber, slotNumber,
131 &resourceList);
132 if (!NT_SUCCESS(rc))
133 {
134 dprintf(("VBoxGuest::ntCreateDevice: HalAssignSlotResources failed with rc=%#x!\n", rc));
135 freeDeviceResources(pDrvObj, pDevObj);
136 return rc;
137 }
138
139 rc = VBoxScanPCIResourceList(resourceList, pDevExt);
140
141 rc = VbglInit (pDevExt->startPortAddress, pDevExt->pVMMDevMemory);
142 if (!VBOX_SUCCESS(rc))
143 {
144 dprintf(("VBoxGuest::START_DEVICE: VbglInit failed. rc = %d\n", rc));
145 }
146
147
148 rc = VbglGRAlloc ((VMMDevRequestHeader **)&pDevExt->irqAckEvents, sizeof (VMMDevEvents), VMMDevReq_AcknowledgeEvents);
149 if (!VBOX_SUCCESS(rc))
150 {
151 dprintf(("VBoxGuest::START_DEVICE: VbglAlloc failed. rc = %d\n", rc));
152 }
153
154#if 0
155 //
156 // now proceed to the busmaster DMA stuff
157 //
158
159 DEVICE_DESCRIPTION deviceDescription;
160 ULONG numberOfMapRegisters;
161 deviceDescription.Version = DEVICE_DESCRIPTION_VERSION;
162 deviceDescription.Master = TRUE;
163 deviceDescription.ScatterGather = TRUE;
164 deviceDescription.BusNumber = pDevExt->busNumber;
165 deviceDescription.InterfaceType = PCIBus;
166 deviceDescription.MaximumLength = MAXIMUM_TRANSFER_LENGTH;
167 pDevExt->adapterObject = HalGetAdapter(&deviceDescription, &numberOfMapRegisters);
168 if (pDevExt->adapterObject == NULL)
169 {
170 dprintf(("VBoxGuest::ntCreateDevice: HalGetAdapter failed!\n"));
171 freeDeviceResources(pDrvObj, pDevObj);
172 return rc;
173 }
174
175 // @todo allocate S/G buffer
176#endif
177
178
179 //
180 // it's time to map the I/O and memory spaces
181 //
182
183 // Map physical address of VMMDev memory
184 rc = hlpVBoxMapVMMDevMemory (pDevExt);
185 if (!NT_SUCCESS(rc))
186 {
187 dprintf(("VBoxGuest::ntCreateDevice: Unable to map VMMDev Memory, rc=%#x!\n", rc));
188 freeDeviceResources(pDrvObj, pDevObj);
189 return rc;
190 }
191
192 //
193 // now we need an ISR and DPC
194 //
195
196 // register DPC routine
197 dprintf(("VBoxGuest::ntCreateDevice: initializing DPC...\n"));
198 IoInitializeDpcRequest(pDevExt->deviceObject, VBoxGuestDpcHandler);
199 // get an interrupt vector
200 ULONG vector;
201 KIRQL irql;
202 KAFFINITY affinity;
203 // only proceed if the device provides an interrupt
204 if (pDevExt->interruptLevel || pDevExt->interruptVector)
205 {
206 vector = HalGetInterruptVector(PCIBus,
207 pDevExt->busNumber,
208 pDevExt->interruptLevel,
209 pDevExt->interruptVector,
210 &irql,
211 &affinity);
212 dprintf(("VBoxGuest::ntCreateDevice: HalGetInterruptVector returns vector %u\n", vector));
213 rc = IoConnectInterrupt(&pDevExt->interruptObject, // out: interrupt object
214 (PKSERVICE_ROUTINE)VBoxGuestIsrHandler, // ISR
215 pDevExt, // context
216 NULL, // optional spinlock
217 vector, // interrupt vector
218 irql, // interrupt level
219 irql, // interrupt level
220 pDevExt->interruptMode, // LevelSensitive or Latched
221 TRUE, // shareable interrupt
222 affinity, // CPU affinity
223 FALSE); // don't save FPU stack
224 if (!NT_SUCCESS(rc))
225 {
226 dprintf(("VBoxGuest::ntCreateDevice: Unable to connect interrupt, rc=%#x!\n", rc));
227 pDevExt->interruptObject = NULL;
228 freeDeviceResources(pDrvObj, pDevObj);
229 return rc;
230 }
231 dprintf(("VBoxGuest::ntCreateDevice: IRQ connected!\n"));
232 }
233
234 if (NT_SUCCESS(rc))
235 {
236 // create our thread to inform the VBoxMouse driver
237 rc = createThreads(pDevExt);
238 }
239
240 if (NT_SUCCESS(rc))
241 {
242 // initialize the event notification semaphore
243 KeInitializeEvent(&pDevExt->keventNotification, NotificationEvent, FALSE);
244
245 /* Preallocated constant timeout 250ms for HGCM async waiter. */
246 pDevExt->HGCMWaitTimeout.QuadPart = 250;
247 pDevExt->HGCMWaitTimeout.QuadPart *= -10000; /* relative in 100ns units */
248 }
249
250 rc = hlpVBoxReportGuestInfo (pDevExt);
251 if (!NT_SUCCESS(rc))
252 {
253 dprintf(("VBoxGuest::AddDevice: could not report information to host, rc = %d, exiting!\n", rc));
254 freeDeviceResources(pDrvObj, pDevObj);
255 return STATUS_UNSUCCESSFUL;
256 }
257
258 /** @todo cleanup on failure */
259
260 VBoxInitMemBalloon(pDevExt);
261
262 // ready to rumble!
263 pDevExt->devState = WORKING;
264 dprintf(("returning from createDevice with rc = 0x%x\n", rc));
265 return rc;
266}
267
268
269/**
270 * Helper function to handle the PCI device lookup
271 *
272 * @returns NT error codes
273 */
274static NTSTATUS findPCIDevice(PULONG pBusNumber, PPCI_SLOT_NUMBER pSlotNumber)
275{
276 NTSTATUS rc;
277
278 ULONG busNumber;
279 ULONG deviceNumber;
280 ULONG functionNumber;
281 PCI_SLOT_NUMBER slotNumber;
282 PCI_COMMON_CONFIG pciData;
283
284 dprintf(("findPCIDevice\n"));
285
286 rc = STATUS_DEVICE_DOES_NOT_EXIST;
287 slotNumber.u.AsULONG = 0;
288 // scan each bus
289 for (busNumber = 0; busNumber < PCI_MAX_BUSES; busNumber++)
290 {
291 // scan each device
292 for (deviceNumber = 0; deviceNumber < PCI_MAX_DEVICES; deviceNumber++)
293 {
294 slotNumber.u.bits.DeviceNumber = deviceNumber;
295 // scan each function (not really required...)
296 for (functionNumber = 0; functionNumber < PCI_MAX_FUNCTION; functionNumber++)
297 {
298 slotNumber.u.bits.FunctionNumber = functionNumber;
299 // have a look at what's in this slot
300 if (!HalGetBusData(PCIConfiguration, busNumber, slotNumber.u.AsULONG,
301 &pciData, sizeof(ULONG)))
302 {
303 // no such bus, we're done with it
304 deviceNumber = PCI_MAX_DEVICES;
305 break;
306 }
307
308 if (pciData.VendorID == PCI_INVALID_VENDORID)
309 {
310 // we have to proceed to the next function
311 continue;
312 }
313
314 // check if it's another device
315 if ((pciData.VendorID != VMMDEV_VENDORID) ||
316 (pciData.DeviceID != VMMDEV_DEVICEID))
317 {
318 continue;
319 }
320
321 // Hooray, we've found it!
322 dprintf(("device found!\n"));
323 *pBusNumber = busNumber;
324 *pSlotNumber = slotNumber;
325 rc = STATUS_SUCCESS;
326 }
327 }
328 }
329
330 return rc;
331}
332
333/**
334 * Helper function to cleanup resources
335 *
336 * @param pDrvObj Driver object.
337 * @param pDevObj Device object.
338 */
339static void freeDeviceResources(PDRIVER_OBJECT pDrvObj, PDEVICE_OBJECT pDevObj)
340{
341 PVBOXGUESTDEVEXT pDevExt = (PVBOXGUESTDEVEXT)pDevObj->DeviceExtension;
342
343 // if there's no device extension, we're screwed
344 if (!pDevExt)
345 {
346 dprintf(("freeDeviceResources: FATAL ERROR! device extension pointer is NULL! Not freeing resources!\n"));
347 return;
348 }
349
350 // indicate that the device is no longer ready
351 pDevExt->devState = STOPPED;
352
353 // disconnect interrupts
354 if (pDevExt->interruptObject)
355 {
356 IoDisconnectInterrupt(pDevExt->interruptObject);
357 }
358
359 // unmap mem/io resources
360 hlpVBoxUnmapVMMDevMemory (pDevExt);
361
362 VBoxCleanupMemBalloon(pDevExt);
363}
364
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette