VirtualBox

source: vbox/trunk/src/VBox/Devices/Storage/DrvVD.cpp@ 66192

Last change on this file since 66192 was 66192, checked in by vboxsync, 8 years ago

VD,pdmstorageifs.h: Move media descriptor related definitions to an extra header and include/use that for the PDMIMEDIA interface to avoid duplicating them in several places
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 214.4 KB
Line 
1/* $Id: DrvVD.cpp 66192 2017-03-22 12:45:37Z vboxsync $ */
2/** @file
3 * DrvVD - Generic VBox disk media driver.
4 */
5
6/*
7 * Copyright (C) 2006-2016 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 */
17
18
19/*********************************************************************************************************************************
20* Header files *
21*********************************************************************************************************************************/
22#define LOG_GROUP LOG_GROUP_DRV_VD
23#include <VBox/vd.h>
24#include <VBox/vmm/pdmdrv.h>
25#include <VBox/vmm/pdmstorageifs.h>
26#include <VBox/vmm/pdmasynccompletion.h>
27#include <VBox/vmm/pdmblkcache.h>
28#include <VBox/vmm/ssm.h>
29#include <iprt/asm.h>
30#include <iprt/alloc.h>
31#include <iprt/assert.h>
32#include <iprt/uuid.h>
33#include <iprt/file.h>
34#include <iprt/string.h>
35#include <iprt/tcp.h>
36#include <iprt/semaphore.h>
37#include <iprt/sg.h>
38#include <iprt/poll.h>
39#include <iprt/pipe.h>
40#include <iprt/system.h>
41#include <iprt/memsafer.h>
42#include <iprt/memcache.h>
43#include <iprt/list.h>
44
45#ifdef VBOX_WITH_INIP
46/* All lwip header files are not C++ safe. So hack around this. */
47RT_C_DECLS_BEGIN
48#include <lwip/opt.h>
49#include <lwip/inet.h>
50#include <lwip/tcp.h>
51#include <lwip/sockets.h>
52# if LWIP_IPV6
53# include <lwip/inet6.h>
54# endif
55RT_C_DECLS_END
56#endif /* VBOX_WITH_INIP */
57
58#include "HBDMgmt.h"
59#include "IOBufMgmt.h"
60
61#include "VBoxDD.h"
62
63#ifdef VBOX_WITH_INIP
64/* Small hack to get at lwIP initialized status */
65extern bool DevINIPConfigured(void);
66#endif /* VBOX_WITH_INIP */
67
68
69/** @def VBOX_PERIODIC_FLUSH
70 * Enable support for periodically flushing the VDI to disk. This may prove
71 * useful for those nasty problems with the ultra-slow host filesystems.
72 * If this is enabled, it can be configured via the CFGM key
73 * "VBoxInternal/Devices/piix3ide/0/LUN#<x>/Config/FlushInterval". @verbatim<x>@endverbatim
74 * must be replaced with the correct LUN number of the disk that should
75 * do the periodic flushes. The value of the key is the number of bytes
76 * written between flushes. A value of 0 (the default) denotes no flushes. */
77#define VBOX_PERIODIC_FLUSH
78
79/** @def VBOX_IGNORE_FLUSH
80 * Enable support for ignoring VDI flush requests. This can be useful for
81 * filesystems that show bad guest IDE write performance (especially with
82 * Windows guests). NOTE that this does not disable the flushes caused by
83 * the periodic flush cache feature above.
84 * If this feature is enabled, it can be configured via the CFGM key
85 * "VBoxInternal/Devices/piix3ide/0/LUN#<x>/Config/IgnoreFlush". @verbatim<x>@endverbatim
86 * must be replaced with the correct LUN number of the disk that should
87 * ignore flush requests. The value of the key is a boolean. The default
88 * is to ignore flushes, i.e. true. */
89#define VBOX_IGNORE_FLUSH
90
91
92/*********************************************************************************************************************************
93* Defined types, constants and macros *
94*********************************************************************************************************************************/
95
96/** Converts a pointer to VBOXDISK::IMedia to a PVBOXDISK. */
97#define PDMIMEDIA_2_VBOXDISK(pInterface) \
98 ( (PVBOXDISK)((uintptr_t)pInterface - RT_OFFSETOF(VBOXDISK, IMedia)) )
99
100/** Saved state version of an I/O request .*/
101#define DRVVD_IOREQ_SAVED_STATE_VERSION UINT32_C(1)
102/** Maximum number of request errors in the release log before muting. */
103#define DRVVD_MAX_LOG_REL_ERRORS 100
104
105/** Forward declaration for the dis kcontainer. */
106typedef struct VBOXDISK *PVBOXDISK;
107
108/**
109 * VBox disk container, image information, private part.
110 */
111
112typedef struct VBOXIMAGE
113{
114 /** Pointer to next image. */
115 struct VBOXIMAGE *pNext;
116 /** Pointer to list of VD interfaces. Per-image. */
117 PVDINTERFACE pVDIfsImage;
118 /** Configuration information interface. */
119 VDINTERFACECONFIG VDIfConfig;
120 /** TCP network stack interface. */
121 VDINTERFACETCPNET VDIfTcpNet;
122 /** I/O interface. */
123 VDINTERFACEIO VDIfIo;
124} VBOXIMAGE, *PVBOXIMAGE;
125
126/**
127 * Storage backend data.
128 */
129typedef struct DRVVDSTORAGEBACKEND
130{
131 /** PDM async completion end point. */
132 PPDMASYNCCOMPLETIONENDPOINT pEndpoint;
133 /** The template. */
134 PPDMASYNCCOMPLETIONTEMPLATE pTemplate;
135 /** Event semaphore for synchronous operations. */
136 RTSEMEVENT EventSem;
137 /** Flag whether a synchronous operation is currently pending. */
138 volatile bool fSyncIoPending;
139 /** Return code of the last completed request. */
140 int rcReqLast;
141 /** Callback routine */
142 PFNVDCOMPLETED pfnCompleted;
143} DRVVDSTORAGEBACKEND, *PDRVVDSTORAGEBACKEND;
144
145/**
146 * VD I/O request state.
147 */
148typedef enum VDIOREQSTATE
149{
150 /** Invalid. */
151 VDIOREQSTATE_INVALID = 0,
152 /** The request is not in use and resides on the free list. */
153 VDIOREQSTATE_FREE,
154 /** The request was just allocated and is not active. */
155 VDIOREQSTATE_ALLOCATED,
156 /** The request was allocated and is in use. */
157 VDIOREQSTATE_ACTIVE,
158 /** The request was suspended and is not actively processed. */
159 VDIOREQSTATE_SUSPENDED,
160 /** The request is in the last step of completion and syncs memory. */
161 VDIOREQSTATE_COMPLETING,
162 /** The request completed. */
163 VDIOREQSTATE_COMPLETED,
164 /** The request was aborted but wasn't returned as complete from the storage
165 * layer below us. */
166 VDIOREQSTATE_CANCELED,
167 /** 32bit hack. */
168 VDIOREQSTATE_32BIT_HACK = 0x7fffffff
169} VDIOREQSTATE;
170
171/**
172 * VD I/O Request.
173 */
174typedef struct PDMMEDIAEXIOREQINT
175{
176 /** List node for the list of allocated requests. */
177 RTLISTNODE NdAllocatedList;
178 /** List for requests waiting for I/O memory or on the redo list. */
179 RTLISTNODE NdLstWait;
180 /** I/O request type. */
181 PDMMEDIAEXIOREQTYPE enmType;
182 /** Request state. */
183 volatile VDIOREQSTATE enmState;
184 /** I/O request ID. */
185 PDMMEDIAEXIOREQID uIoReqId;
186 /** Pointer to the disk container. */
187 PVBOXDISK pDisk;
188 /** Flags. */
189 uint32_t fFlags;
190 /** Timestamp when the request was submitted. */
191 uint64_t tsSubmit;
192 /** Type dependent data. */
193 union
194 {
195 /** Read/Write request sepcific data. */
196 struct
197 {
198 /** Start offset of the request. */
199 uint64_t offStart;
200 /** Size of the request. */
201 size_t cbReq;
202 /** Size left for this request. */
203 size_t cbReqLeft;
204 /** Size of the allocated I/O buffer. */
205 size_t cbIoBuf;
206 /** Pointer to the S/G buffer. */
207 PRTSGBUF pSgBuf;
208 /** Flag whether the pointer is a direct buffer or
209 * was allocated by us. */
210 bool fDirectBuf;
211 /** Buffer management data based on the fDirectBuf flag. */
212 union
213 {
214 /** Direct buffer. */
215 struct
216 {
217 /** Segment for the data buffer. */
218 RTSGSEG Seg;
219 /** S/G buffer structure. */
220 RTSGBUF SgBuf;
221 } Direct;
222 /** I/O buffer descriptor. */
223 IOBUFDESC IoBuf;
224 };
225 } ReadWrite;
226 /** Discard specific data. */
227 struct
228 {
229 /** Pointer to array of ranges to discard. */
230 PRTRANGE paRanges;
231 /** Number of ranges to discard. */
232 unsigned cRanges;
233 } Discard;
234 };
235 /** Allocator specific memory - variable size. */
236 uint8_t abAlloc[1];
237} PDMMEDIAEXIOREQINT;
238/** Pointer to a VD I/O request. */
239typedef PDMMEDIAEXIOREQINT *PPDMMEDIAEXIOREQINT;
240
241/**
242 * Structure for holding a list of allocated requests.
243 */
244typedef struct VDLSTIOREQALLOC
245{
246 /** Mutex protecting the table of allocated requests. */
247 RTSEMFASTMUTEX hMtxLstIoReqAlloc;
248 /** List anchor. */
249 RTLISTANCHOR LstIoReqAlloc;
250} VDLSTIOREQALLOC;
251typedef VDLSTIOREQALLOC *PVDLSTIOREQALLOC;
252
253/** Number of bins for allocated requests. */
254#define DRVVD_VDIOREQ_ALLOC_BINS 8
255
256/**
257 * VBox disk container media main structure, private part.
258 *
259 * @implements PDMIMEDIA
260 * @implements PDMIMEDIAEX
261 * @implements PDMIMOUNT
262 * @implements VDINTERFACEERROR
263 * @implements VDINTERFACETCPNET
264 * @implements VDINTERFACEASYNCIO
265 * @implements VDINTERFACECONFIG
266 */
267typedef struct VBOXDISK
268{
269 /** The VBox disk container. */
270 PVBOXHDD pDisk;
271 /** The media interface. */
272 PDMIMEDIA IMedia;
273 /** Media port. */
274 PPDMIMEDIAPORT pDrvMediaPort;
275 /** Pointer to the driver instance. */
276 PPDMDRVINS pDrvIns;
277 /** Flag whether suspend has changed image open mode to read only. */
278 bool fTempReadOnly;
279 /** Flag whether to use the runtime (true) or startup error facility. */
280 bool fErrorUseRuntime;
281 /** Pointer to list of VD interfaces. Per-disk. */
282 PVDINTERFACE pVDIfsDisk;
283 /** Error interface. */
284 VDINTERFACEERROR VDIfError;
285 /** Thread synchronization interface. */
286 VDINTERFACETHREADSYNC VDIfThreadSync;
287
288 /** Flag whether opened disk supports async I/O operations. */
289 bool fAsyncIOSupported;
290 /** Pointer to the list of data we need to keep per image. */
291 PVBOXIMAGE pImages;
292 /** Flag whether the media should allow concurrent open for writing. */
293 bool fShareable;
294 /** Flag whether a merge operation has been set up. */
295 bool fMergePending;
296 /** Synchronization to prevent destruction before merge finishes. */
297 RTSEMFASTMUTEX MergeCompleteMutex;
298 /** Synchronization between merge and other image accesses. */
299 RTSEMRW MergeLock;
300 /** Source image index for merging. */
301 unsigned uMergeSource;
302 /** Target image index for merging. */
303 unsigned uMergeTarget;
304
305 /** Flag whether boot acceleration is enabled. */
306 bool fBootAccelEnabled;
307 /** Flag whether boot acceleration is currently active. */
308 bool fBootAccelActive;
309 /** Size of the disk, used for read truncation. */
310 uint64_t cbDisk;
311 /** Size of the configured buffer. */
312 size_t cbBootAccelBuffer;
313 /** Start offset for which the buffer holds data. */
314 uint64_t offDisk;
315 /** Number of valid bytes in the buffer. */
316 size_t cbDataValid;
317 /** The disk buffer. */
318 uint8_t *pbData;
319 /** Bandwidth group the disk is assigned to. */
320 char *pszBwGroup;
321 /** Flag whether async I/O using the host cache is enabled. */
322 bool fAsyncIoWithHostCache;
323
324 /** I/O interface for a cache image. */
325 VDINTERFACEIO VDIfIoCache;
326 /** Interface list for the cache image. */
327 PVDINTERFACE pVDIfsCache;
328
329 /** The block cache handle if configured. */
330 PPDMBLKCACHE pBlkCache;
331 /** Host block device manager. */
332 HBDMGR hHbdMgr;
333
334 /** Drive type. */
335 PDMMEDIATYPE enmType;
336 /** Locked indicator. */
337 bool fLocked;
338 /** Mountable indicator. */
339 bool fMountable;
340 /** Visible to the BIOS. */
341 bool fBiosVisible;
342 /** Flag whether this medium should be presented as non rotational. */
343 bool fNonRotational;
344#ifdef VBOX_PERIODIC_FLUSH
345 /** HACK: Configuration value for number of bytes written after which to flush. */
346 uint32_t cbFlushInterval;
347 /** HACK: Current count for the number of bytes written since the last flush. */
348 uint32_t cbDataWritten;
349#endif /* VBOX_PERIODIC_FLUSH */
350#ifdef VBOX_IGNORE_FLUSH
351 /** HACK: Disable flushes for this drive. */
352 bool fIgnoreFlush;
353 /** Disable async flushes for this drive. */
354 bool fIgnoreFlushAsync;
355#endif /* VBOX_IGNORE_FLUSH */
356 /** Our mountable interface. */
357 PDMIMOUNT IMount;
358 /** Pointer to the mount notify interface above us. */
359 PPDMIMOUNTNOTIFY pDrvMountNotify;
360 /** Uuid of the drive. */
361 RTUUID Uuid;
362 /** BIOS PCHS Geometry. */
363 PDMMEDIAGEOMETRY PCHSGeometry;
364 /** BIOS LCHS Geometry. */
365 PDMMEDIAGEOMETRY LCHSGeometry;
366 /** Region list. */
367 PVDREGIONLIST pRegionList;
368
369 /** Cryptographic support
370 * @{ */
371 /** Pointer to the CFGM node containing the config of the crypto filter
372 * if enable. */
373 PCFGMNODE pCfgCrypto;
374 /** Config interface for the encryption filter. */
375 VDINTERFACECONFIG VDIfCfg;
376 /** Crypto interface for the encryption filter. */
377 VDINTERFACECRYPTO VDIfCrypto;
378 /** The secret key interface used to retrieve keys. */
379 PPDMISECKEY pIfSecKey;
380 /** The secret key helper interface used to notify about missing keys. */
381 PPDMISECKEYHLP pIfSecKeyHlp;
382 /** @} */
383
384 /** @name IMEDIAEX interface support specific members.
385 * @{ */
386 /** Pointer to the IMEDIAEXPORT interface above us. */
387 PPDMIMEDIAEXPORT pDrvMediaExPort;
388 /** Our extended media interface. */
389 PDMIMEDIAEX IMediaEx;
390 /** Memory cache for the I/O requests. */
391 RTMEMCACHE hIoReqCache;
392 /** I/O buffer manager. */
393 IOBUFMGR hIoBufMgr;
394 /** Active request counter. */
395 volatile uint32_t cIoReqsActive;
396 /** Bins for allocated requests. */
397 VDLSTIOREQALLOC aIoReqAllocBins[DRVVD_VDIOREQ_ALLOC_BINS];
398 /** List of requests for I/O memory to be available - VDIOREQ::NdLstWait. */
399 RTLISTANCHOR LstIoReqIoBufWait;
400 /** Critical section protecting the list of requests waiting for I/O memory. */
401 RTCRITSECT CritSectIoReqsIoBufWait;
402 /** Number of requests waiting for a I/O buffer. */
403 volatile uint32_t cIoReqsWaiting;
404 /** Flag whether we have to resubmit requests on resume because the
405 * VM was suspended due to a recoverable I/O error.
406 */
407 volatile bool fRedo;
408 /** List of requests we have to redo. */
409 RTLISTANCHOR LstIoReqRedo;
410 /** Criticial section protecting the list of waiting requests. */
411 RTCRITSECT CritSectIoReqRedo;
412 /** Number of errors logged so far. */
413 unsigned cErrors;
414 /** @} */
415
416 /** @name Statistics.
417 * @{ */
418 /** How many attempts were made to query a direct buffer pointer from the
419 * device/driver above. */
420 STAMCOUNTER StatQueryBufAttempts;
421 /** How many attempts to query a direct buffer pointer succeeded. */
422 STAMCOUNTER StatQueryBufSuccess;
423 /** Release statistics: number of bytes written. */
424 STAMCOUNTER StatBytesWritten;
425 /** Release statistics: number of bytes read. */
426 STAMCOUNTER StatBytesRead;
427 /** Release statistics: Number of requests submitted. */
428 STAMCOUNTER StatReqsSubmitted;
429 /** Release statistics: Number of requests failed. */
430 STAMCOUNTER StatReqsFailed;
431 /** Release statistics: Number of requests succeeded. */
432 STAMCOUNTER StatReqsSucceeded;
433 /** Release statistics: Number of flush requests. */
434 STAMCOUNTER StatReqsFlush;
435 /** Release statistics: Number of write requests. */
436 STAMCOUNTER StatReqsWrite;
437 /** Release statistics: Number of read requests. */
438 STAMCOUNTER StatReqsRead;
439 /** Release statistics: Number of discard requests. */
440 STAMCOUNTER StatReqsDiscard;
441 /** Release statistics: Number of I/O requests processed per second. */
442 STAMCOUNTER StatReqsPerSec;
443 /** @} */
444} VBOXDISK;
445
446
447/*********************************************************************************************************************************
448* Internal Functions *
449*********************************************************************************************************************************/
450
451static DECLCALLBACK(void) drvvdMediaExIoReqComplete(void *pvUser1, void *pvUser2, int rcReq);
452static void drvvdPowerOffOrDestructOrUnmount(PPDMDRVINS pDrvIns);
453DECLINLINE(void) drvvdMediaExIoReqBufFree(PVBOXDISK pThis, PPDMMEDIAEXIOREQINT pIoReq);
454static int drvvdMediaExIoReqCompleteWorker(PVBOXDISK pThis, PPDMMEDIAEXIOREQINT pIoReq, int rcReq, bool fUpNotify);
455static int drvvdMediaExIoReqReadWriteProcess(PVBOXDISK pThis, PPDMMEDIAEXIOREQINT pIoReq, bool fUpNotify);
456
457/**
458 * Internal: allocate new image descriptor and put it in the list
459 */
460static PVBOXIMAGE drvvdNewImage(PVBOXDISK pThis)
461{
462 AssertPtr(pThis);
463 PVBOXIMAGE pImage = (PVBOXIMAGE)RTMemAllocZ(sizeof(VBOXIMAGE));
464 if (pImage)
465 {
466 pImage->pVDIfsImage = NULL;
467 PVBOXIMAGE *pp = &pThis->pImages;
468 while (*pp != NULL)
469 pp = &(*pp)->pNext;
470 *pp = pImage;
471 pImage->pNext = NULL;
472 }
473
474 return pImage;
475}
476
477/**
478 * Internal: free the list of images descriptors.
479 */
480static void drvvdFreeImages(PVBOXDISK pThis)
481{
482 while (pThis->pImages != NULL)
483 {
484 PVBOXIMAGE p = pThis->pImages;
485 pThis->pImages = pThis->pImages->pNext;
486 RTMemFree(p);
487 }
488}
489
490
491/**
492 * Make the image temporarily read-only.
493 *
494 * @returns VBox status code.
495 * @param pThis The driver instance data.
496 */
497static int drvvdSetReadonly(PVBOXDISK pThis)
498{
499 int rc = VINF_SUCCESS;
500 if ( pThis->pDisk
501 && !VDIsReadOnly(pThis->pDisk))
502 {
503 unsigned uOpenFlags;
504 rc = VDGetOpenFlags(pThis->pDisk, VD_LAST_IMAGE, &uOpenFlags);
505 AssertRC(rc);
506 uOpenFlags |= VD_OPEN_FLAGS_READONLY;
507 rc = VDSetOpenFlags(pThis->pDisk, VD_LAST_IMAGE, uOpenFlags);
508 AssertRC(rc);
509 pThis->fTempReadOnly = true;
510 }
511 return rc;
512}
513
514
515/**
516 * Undo the temporary read-only status of the image.
517 *
518 * @returns VBox status code.
519 * @param pThis The driver instance data.
520 */
521static int drvvdSetWritable(PVBOXDISK pThis)
522{
523 int rc = VINF_SUCCESS;
524 if (pThis->fTempReadOnly)
525 {
526 unsigned uOpenFlags;
527 rc = VDGetOpenFlags(pThis->pDisk, VD_LAST_IMAGE, &uOpenFlags);
528 AssertRC(rc);
529 uOpenFlags &= ~VD_OPEN_FLAGS_READONLY;
530 rc = VDSetOpenFlags(pThis->pDisk, VD_LAST_IMAGE, uOpenFlags);
531 if (RT_SUCCESS(rc))
532 pThis->fTempReadOnly = false;
533 else
534 AssertRC(rc);
535 }
536 return rc;
537}
538
539/*********************************************************************************************************************************
540* Error reporting callback *
541*********************************************************************************************************************************/
542
543static DECLCALLBACK(void) drvvdErrorCallback(void *pvUser, int rc, RT_SRC_POS_DECL,
544 const char *pszFormat, va_list va)
545{
546 PPDMDRVINS pDrvIns = (PPDMDRVINS)pvUser;
547 PVBOXDISK pThis = PDMINS_2_DATA(pDrvIns, PVBOXDISK);
548 if (pThis->fErrorUseRuntime)
549 /* We must not pass VMSETRTERR_FLAGS_FATAL as it could lead to a
550 * deadlock: We are probably executed in a thread context != EMT
551 * and the EM thread would wait until every thread is suspended
552 * but we would wait for the EM thread ... */
553
554 PDMDrvHlpVMSetRuntimeErrorV(pDrvIns, /* fFlags=*/ 0, "DrvVD", pszFormat, va);
555 else
556 PDMDrvHlpVMSetErrorV(pDrvIns, rc, RT_SRC_POS_ARGS, pszFormat, va);
557}
558
559
560/*********************************************************************************************************************************
561* VD Async I/O interface implementation *
562*********************************************************************************************************************************/
563
564#ifdef VBOX_WITH_PDM_ASYNC_COMPLETION
565
566static DECLCALLBACK(void) drvvdAsyncTaskCompleted(PPDMDRVINS pDrvIns, void *pvTemplateUser, void *pvUser, int rcReq)
567{
568 RT_NOREF(pDrvIns);
569 PDRVVDSTORAGEBACKEND pStorageBackend = (PDRVVDSTORAGEBACKEND)pvTemplateUser;
570
571 LogFlowFunc(("pDrvIns=%#p pvTemplateUser=%#p pvUser=%#p rcReq=%d\n",
572 pDrvIns, pvTemplateUser, pvUser, rcReq));
573
574 if (pStorageBackend->fSyncIoPending)
575 {
576 Assert(!pvUser);
577 pStorageBackend->rcReqLast = rcReq;
578 ASMAtomicWriteBool(&pStorageBackend->fSyncIoPending, false);
579 RTSemEventSignal(pStorageBackend->EventSem);
580 }
581 else
582 {
583 int rc;
584
585 AssertPtr(pvUser);
586
587 AssertPtr(pStorageBackend->pfnCompleted);
588 rc = pStorageBackend->pfnCompleted(pvUser, rcReq);
589 AssertRC(rc);
590 }
591}
592
593static DECLCALLBACK(int) drvvdAsyncIOOpen(void *pvUser, const char *pszLocation,
594 uint32_t fOpen,
595 PFNVDCOMPLETED pfnCompleted,
596 void **ppStorage)
597{
598 PVBOXDISK pThis = (PVBOXDISK)pvUser;
599 PDRVVDSTORAGEBACKEND pStorageBackend = NULL;
600 int rc = VINF_SUCCESS;
601
602 /*
603 * Check whether the backend wants to open a block device and try to prepare it
604 * if we didn't claim it yet.
605 *
606 * We only create a block device manager on demand to not waste any resources.
607 */
608 if (HBDMgrIsBlockDevice(pszLocation))
609 {
610 if (pThis->hHbdMgr == NIL_HBDMGR)
611 rc = HBDMgrCreate(&pThis->hHbdMgr);
612
613 if ( RT_SUCCESS(rc)
614 && !HBDMgrIsBlockDeviceClaimed(pThis->hHbdMgr, pszLocation))
615 rc = HBDMgrClaimBlockDevice(pThis->hHbdMgr, pszLocation);
616
617 if (RT_FAILURE(rc))
618 return rc;
619 }
620
621 pStorageBackend = (PDRVVDSTORAGEBACKEND)RTMemAllocZ(sizeof(DRVVDSTORAGEBACKEND));
622 if (pStorageBackend)
623 {
624 pStorageBackend->fSyncIoPending = false;
625 pStorageBackend->rcReqLast = VINF_SUCCESS;
626 pStorageBackend->pfnCompleted = pfnCompleted;
627
628 rc = RTSemEventCreate(&pStorageBackend->EventSem);
629 if (RT_SUCCESS(rc))
630 {
631 rc = PDMDrvHlpAsyncCompletionTemplateCreate(pThis->pDrvIns, &pStorageBackend->pTemplate,
632 drvvdAsyncTaskCompleted, pStorageBackend, "AsyncTaskCompleted");
633 if (RT_SUCCESS(rc))
634 {
635 uint32_t fFlags = (fOpen & RTFILE_O_ACCESS_MASK) == RTFILE_O_READ
636 ? PDMACEP_FILE_FLAGS_READ_ONLY
637 : 0;
638 if (pThis->fShareable)
639 {
640 Assert((fOpen & RTFILE_O_DENY_MASK) == RTFILE_O_DENY_NONE);
641
642 fFlags |= PDMACEP_FILE_FLAGS_DONT_LOCK;
643 }
644 if (pThis->fAsyncIoWithHostCache)
645 fFlags |= PDMACEP_FILE_FLAGS_HOST_CACHE_ENABLED;
646
647 rc = PDMR3AsyncCompletionEpCreateForFile(&pStorageBackend->pEndpoint,
648 pszLocation, fFlags,
649 pStorageBackend->pTemplate);
650
651 if (RT_SUCCESS(rc))
652 {
653 if (pThis->pszBwGroup)
654 rc = PDMR3AsyncCompletionEpSetBwMgr(pStorageBackend->pEndpoint, pThis->pszBwGroup);
655
656 if (RT_SUCCESS(rc))
657 {
658 LogFlow(("drvvdAsyncIOOpen: Successfully opened '%s'; fOpen=%#x pStorage=%p\n",
659 pszLocation, fOpen, pStorageBackend));
660 *ppStorage = pStorageBackend;
661 return VINF_SUCCESS;
662 }
663
664 PDMR3AsyncCompletionEpClose(pStorageBackend->pEndpoint);
665 }
666
667 PDMR3AsyncCompletionTemplateDestroy(pStorageBackend->pTemplate);
668 }
669 RTSemEventDestroy(pStorageBackend->EventSem);
670 }
671 RTMemFree(pStorageBackend);
672 }
673 else
674 rc = VERR_NO_MEMORY;
675
676 return rc;
677}
678
679static DECLCALLBACK(int) drvvdAsyncIOClose(void *pvUser, void *pStorage)
680{
681 RT_NOREF(pvUser);
682 PDRVVDSTORAGEBACKEND pStorageBackend = (PDRVVDSTORAGEBACKEND)pStorage;
683
684 /*
685 * We don't unclaim any block devices on purpose here because they
686 * might get reopened shortly (switching to readonly during suspend)
687 *
688 * Block devices will get unclaimed during destruction of the driver.
689 */
690
691 PDMR3AsyncCompletionEpClose(pStorageBackend->pEndpoint);
692 PDMR3AsyncCompletionTemplateDestroy(pStorageBackend->pTemplate);
693 RTSemEventDestroy(pStorageBackend->EventSem);
694 RTMemFree(pStorageBackend);
695 return VINF_SUCCESS;;
696}
697
698static DECLCALLBACK(int) drvvdAsyncIOReadSync(void *pvUser, void *pStorage, uint64_t uOffset,
699 void *pvBuf, size_t cbRead, size_t *pcbRead)
700{
701 RT_NOREF(pvUser);
702 PDRVVDSTORAGEBACKEND pStorageBackend = (PDRVVDSTORAGEBACKEND)pStorage;
703 RTSGSEG DataSeg;
704 PPDMASYNCCOMPLETIONTASK pTask;
705
706 bool fOld = ASMAtomicXchgBool(&pStorageBackend->fSyncIoPending, true);
707 Assert(!fOld); NOREF(fOld);
708 DataSeg.cbSeg = cbRead;
709 DataSeg.pvSeg = pvBuf;
710
711 int rc = PDMR3AsyncCompletionEpRead(pStorageBackend->pEndpoint, uOffset, &DataSeg, 1, cbRead, NULL, &pTask);
712 if (RT_FAILURE(rc))
713 return rc;
714
715 if (rc == VINF_AIO_TASK_PENDING)
716 {
717 /* Wait */
718 rc = RTSemEventWait(pStorageBackend->EventSem, RT_INDEFINITE_WAIT);
719 AssertRC(rc);
720 }
721 else
722 ASMAtomicXchgBool(&pStorageBackend->fSyncIoPending, false);
723
724 if (pcbRead)
725 *pcbRead = cbRead;
726
727 return pStorageBackend->rcReqLast;
728}
729
730static DECLCALLBACK(int) drvvdAsyncIOWriteSync(void *pvUser, void *pStorage, uint64_t uOffset,
731 const void *pvBuf, size_t cbWrite, size_t *pcbWritten)
732{
733 RT_NOREF(pvUser);
734 PDRVVDSTORAGEBACKEND pStorageBackend = (PDRVVDSTORAGEBACKEND)pStorage;
735 RTSGSEG DataSeg;
736 PPDMASYNCCOMPLETIONTASK pTask;
737
738 bool fOld = ASMAtomicXchgBool(&pStorageBackend->fSyncIoPending, true);
739 Assert(!fOld); NOREF(fOld);
740 DataSeg.cbSeg = cbWrite;
741 DataSeg.pvSeg = (void *)pvBuf;
742
743 int rc = PDMR3AsyncCompletionEpWrite(pStorageBackend->pEndpoint, uOffset, &DataSeg, 1, cbWrite, NULL, &pTask);
744 if (RT_FAILURE(rc))
745 return rc;
746
747 if (rc == VINF_AIO_TASK_PENDING)
748 {
749 /* Wait */
750 rc = RTSemEventWait(pStorageBackend->EventSem, RT_INDEFINITE_WAIT);
751 AssertRC(rc);
752 }
753 else
754 ASMAtomicXchgBool(&pStorageBackend->fSyncIoPending, false);
755
756 if (pcbWritten)
757 *pcbWritten = cbWrite;
758
759 return pStorageBackend->rcReqLast;
760}
761
762static DECLCALLBACK(int) drvvdAsyncIOFlushSync(void *pvUser, void *pStorage)
763{
764 RT_NOREF(pvUser);
765 PDRVVDSTORAGEBACKEND pStorageBackend = (PDRVVDSTORAGEBACKEND)pStorage;
766 PPDMASYNCCOMPLETIONTASK pTask;
767
768 LogFlowFunc(("pvUser=%#p pStorage=%#p\n", pvUser, pStorage));
769
770 bool fOld = ASMAtomicXchgBool(&pStorageBackend->fSyncIoPending, true);
771 Assert(!fOld); NOREF(fOld);
772
773 int rc = PDMR3AsyncCompletionEpFlush(pStorageBackend->pEndpoint, NULL, &pTask);
774 if (RT_FAILURE(rc))
775 return rc;
776
777 if (rc == VINF_AIO_TASK_PENDING)
778 {
779 /* Wait */
780 LogFlowFunc(("Waiting for flush to complete\n"));
781 rc = RTSemEventWait(pStorageBackend->EventSem, RT_INDEFINITE_WAIT);
782 AssertRC(rc);
783 }
784 else
785 ASMAtomicXchgBool(&pStorageBackend->fSyncIoPending, false);
786
787 return pStorageBackend->rcReqLast;
788}
789
790static DECLCALLBACK(int) drvvdAsyncIOReadAsync(void *pvUser, void *pStorage, uint64_t uOffset,
791 PCRTSGSEG paSegments, size_t cSegments,
792 size_t cbRead, void *pvCompletion,
793 void **ppTask)
794{
795 RT_NOREF(pvUser);
796 PDRVVDSTORAGEBACKEND pStorageBackend = (PDRVVDSTORAGEBACKEND)pStorage;
797
798 int rc = PDMR3AsyncCompletionEpRead(pStorageBackend->pEndpoint, uOffset, paSegments, (unsigned)cSegments, cbRead,
799 pvCompletion, (PPPDMASYNCCOMPLETIONTASK)ppTask);
800 if (rc == VINF_AIO_TASK_PENDING)
801 rc = VERR_VD_ASYNC_IO_IN_PROGRESS;
802
803 return rc;
804}
805
806static DECLCALLBACK(int) drvvdAsyncIOWriteAsync(void *pvUser, void *pStorage, uint64_t uOffset,
807 PCRTSGSEG paSegments, size_t cSegments,
808 size_t cbWrite, void *pvCompletion,
809 void **ppTask)
810{
811 RT_NOREF(pvUser);
812 PDRVVDSTORAGEBACKEND pStorageBackend = (PDRVVDSTORAGEBACKEND)pStorage;
813
814 int rc = PDMR3AsyncCompletionEpWrite(pStorageBackend->pEndpoint, uOffset, paSegments, (unsigned)cSegments, cbWrite,
815 pvCompletion, (PPPDMASYNCCOMPLETIONTASK)ppTask);
816 if (rc == VINF_AIO_TASK_PENDING)
817 rc = VERR_VD_ASYNC_IO_IN_PROGRESS;
818
819 return rc;
820}
821
822static DECLCALLBACK(int) drvvdAsyncIOFlushAsync(void *pvUser, void *pStorage,
823 void *pvCompletion, void **ppTask)
824{
825 RT_NOREF(pvUser);
826 PDRVVDSTORAGEBACKEND pStorageBackend = (PDRVVDSTORAGEBACKEND)pStorage;
827
828 int rc = PDMR3AsyncCompletionEpFlush(pStorageBackend->pEndpoint, pvCompletion,
829 (PPPDMASYNCCOMPLETIONTASK)ppTask);
830 if (rc == VINF_AIO_TASK_PENDING)
831 rc = VERR_VD_ASYNC_IO_IN_PROGRESS;
832
833 return rc;
834}
835
836static DECLCALLBACK(int) drvvdAsyncIOGetSize(void *pvUser, void *pStorage, uint64_t *pcbSize)
837{
838 RT_NOREF(pvUser);
839 PDRVVDSTORAGEBACKEND pStorageBackend = (PDRVVDSTORAGEBACKEND)pStorage;
840
841 return PDMR3AsyncCompletionEpGetSize(pStorageBackend->pEndpoint, pcbSize);
842}
843
844static DECLCALLBACK(int) drvvdAsyncIOSetSize(void *pvUser, void *pStorage, uint64_t cbSize)
845{
846 RT_NOREF(pvUser);
847 PDRVVDSTORAGEBACKEND pStorageBackend = (PDRVVDSTORAGEBACKEND)pStorage;
848
849 return PDMR3AsyncCompletionEpSetSize(pStorageBackend->pEndpoint, cbSize);
850}
851
852static DECLCALLBACK(int) drvvdAsyncIOSetAllocationSize(void *pvUser, void *pvStorage, uint64_t cbSize, uint32_t fFlags)
853{
854 RT_NOREF(pvUser, pvStorage, cbSize, fFlags);
855 return VERR_NOT_SUPPORTED;
856}
857
858#endif /* VBOX_WITH_PDM_ASYNC_COMPLETION */
859
860
861/*********************************************************************************************************************************
862* VD Thread Synchronization interface implementation *
863*********************************************************************************************************************************/
864
865static DECLCALLBACK(int) drvvdThreadStartRead(void *pvUser)
866{
867 PVBOXDISK pThis = (PVBOXDISK)pvUser;
868
869 return RTSemRWRequestRead(pThis->MergeLock, RT_INDEFINITE_WAIT);
870}
871
872static DECLCALLBACK(int) drvvdThreadFinishRead(void *pvUser)
873{
874 PVBOXDISK pThis = (PVBOXDISK)pvUser;
875
876 return RTSemRWReleaseRead(pThis->MergeLock);
877}
878
879static DECLCALLBACK(int) drvvdThreadStartWrite(void *pvUser)
880{
881 PVBOXDISK pThis = (PVBOXDISK)pvUser;
882
883 return RTSemRWRequestWrite(pThis->MergeLock, RT_INDEFINITE_WAIT);
884}
885
886static DECLCALLBACK(int) drvvdThreadFinishWrite(void *pvUser)
887{
888 PVBOXDISK pThis = (PVBOXDISK)pvUser;
889
890 return RTSemRWReleaseWrite(pThis->MergeLock);
891}
892
893
894/*********************************************************************************************************************************
895* VD Configuration interface implementation *
896*********************************************************************************************************************************/
897
898static DECLCALLBACK(bool) drvvdCfgAreKeysValid(void *pvUser, const char *pszzValid)
899{
900 return CFGMR3AreValuesValid((PCFGMNODE)pvUser, pszzValid);
901}
902
903static DECLCALLBACK(int) drvvdCfgQuerySize(void *pvUser, const char *pszName, size_t *pcb)
904{
905 return CFGMR3QuerySize((PCFGMNODE)pvUser, pszName, pcb);
906}
907
908static DECLCALLBACK(int) drvvdCfgQuery(void *pvUser, const char *pszName, char *pszString, size_t cchString)
909{
910 return CFGMR3QueryString((PCFGMNODE)pvUser, pszName, pszString, cchString);
911}
912
913static DECLCALLBACK(int) drvvdCfgQueryBytes(void *pvUser, const char *pszName, void *ppvData, size_t cbData)
914{
915 return CFGMR3QueryBytes((PCFGMNODE)pvUser, pszName, ppvData, cbData);
916}
917
918
919/*******************************************************************************
920* VD Crypto interface implementation for the encryption support *
921*******************************************************************************/
922
923static DECLCALLBACK(int) drvvdCryptoKeyRetain(void *pvUser, const char *pszId, const uint8_t **ppbKey, size_t *pcbKey)
924{
925 PVBOXDISK pThis = (PVBOXDISK)pvUser;
926 int rc = VINF_SUCCESS;
927
928 AssertPtr(pThis->pIfSecKey);
929 if (pThis->pIfSecKey)
930 rc = pThis->pIfSecKey->pfnKeyRetain(pThis->pIfSecKey, pszId, ppbKey, pcbKey);
931 else
932 rc = VERR_NOT_SUPPORTED;
933
934 return rc;
935}
936
937static DECLCALLBACK(int) drvvdCryptoKeyRelease(void *pvUser, const char *pszId)
938{
939 PVBOXDISK pThis = (PVBOXDISK)pvUser;
940 int rc = VINF_SUCCESS;
941
942 AssertPtr(pThis->pIfSecKey);
943 if (pThis->pIfSecKey)
944 rc = pThis->pIfSecKey->pfnKeyRelease(pThis->pIfSecKey, pszId);
945 else
946 rc = VERR_NOT_SUPPORTED;
947
948 return rc;
949}
950
951static DECLCALLBACK(int) drvvdCryptoKeyStorePasswordRetain(void *pvUser, const char *pszId, const char **ppszPassword)
952{
953 PVBOXDISK pThis = (PVBOXDISK)pvUser;
954 int rc = VINF_SUCCESS;
955
956 AssertPtr(pThis->pIfSecKey);
957 if (pThis->pIfSecKey)
958 rc = pThis->pIfSecKey->pfnPasswordRetain(pThis->pIfSecKey, pszId, ppszPassword);
959 else
960 rc = VERR_NOT_SUPPORTED;
961
962 return rc;
963}
964
965static DECLCALLBACK(int) drvvdCryptoKeyStorePasswordRelease(void *pvUser, const char *pszId)
966{
967 PVBOXDISK pThis = (PVBOXDISK)pvUser;
968 int rc = VINF_SUCCESS;
969
970 AssertPtr(pThis->pIfSecKey);
971 if (pThis->pIfSecKey)
972 rc = pThis->pIfSecKey->pfnPasswordRelease(pThis->pIfSecKey, pszId);
973 else
974 rc = VERR_NOT_SUPPORTED;
975
976 return rc;
977}
978
979#ifdef VBOX_WITH_INIP
980
981
982/*********************************************************************************************************************************
983* VD TCP network stack interface implementation - INIP case *
984*********************************************************************************************************************************/
985
986/**
987 * vvl: this structure duplicate meaning of sockaddr,
988 * perhaps it'd be better to get rid of it.
989 */
990typedef union INIPSOCKADDRUNION
991{
992 struct sockaddr Addr;
993 struct sockaddr_in Ipv4;
994#if LWIP_IPV6
995 struct sockaddr_in6 Ipv6;
996#endif
997} INIPSOCKADDRUNION;
998
999typedef struct INIPSOCKET
1000{
1001 int hSock;
1002} INIPSOCKET, *PINIPSOCKET;
1003
1004static DECLCALLBACK(int) drvvdINIPFlush(VDSOCKET Sock);
1005
1006/** @interface_method_impl{VDINTERFACETCPNET,pfnSocketCreate} */
1007static DECLCALLBACK(int) drvvdINIPSocketCreate(uint32_t fFlags, PVDSOCKET pSock)
1008{
1009 PINIPSOCKET pSocketInt = NULL;
1010
1011 /*
1012 * The extended select method is not supported because it is impossible to wakeup
1013 * the thread.
1014 */
1015 if (fFlags & VD_INTERFACETCPNET_CONNECT_EXTENDED_SELECT)
1016 return VERR_NOT_SUPPORTED;
1017
1018 pSocketInt = (PINIPSOCKET)RTMemAllocZ(sizeof(INIPSOCKET));
1019 if (pSocketInt)
1020 {
1021 pSocketInt->hSock = INT32_MAX;
1022 *pSock = (VDSOCKET)pSocketInt;
1023 return VINF_SUCCESS;
1024 }
1025
1026 return VERR_NO_MEMORY;
1027}
1028
1029/** @interface_method_impl{VDINTERFACETCPNET,pfnSocketCreate} */
1030static DECLCALLBACK(int) drvvdINIPSocketDestroy(VDSOCKET Sock)
1031{
1032 PINIPSOCKET pSocketInt = (PINIPSOCKET)Sock;
1033
1034 RTMemFree(pSocketInt);
1035 return VINF_SUCCESS;
1036}
1037
1038/** @interface_method_impl{VDINTERFACETCPNET,pfnClientConnect} */
1039static DECLCALLBACK(int) drvvdINIPClientConnect(VDSOCKET Sock, const char *pszAddress, uint32_t uPort,
1040 RTMSINTERVAL cMillies)
1041{
1042 int rc = VINF_SUCCESS;
1043 PINIPSOCKET pSocketInt = (PINIPSOCKET)Sock;
1044 int iInetFamily = PF_INET;
1045 struct in_addr ip;
1046#if LWIP_IPV6
1047 ip6_addr_t ip6;
1048 RT_ZERO(ip6);
1049#endif
1050
1051 NOREF(cMillies); /* LwIP doesn't support connect timeout. */
1052 RT_ZERO(ip); /* Shut up MSC. */
1053
1054 /* Check whether lwIP is set up in this VM instance. */
1055 if (!DevINIPConfigured())
1056 {
1057 LogRelFunc(("no IP stack\n"));
1058 return VERR_NET_HOST_UNREACHABLE;
1059 }
1060 /* Resolve hostname. As there is no standard resolver for lwIP yet,
1061 * just accept numeric IP addresses for now. */
1062#if LWIP_IPV6
1063 if (inet6_aton(pszAddress, &ip6))
1064 iInetFamily = PF_INET6;
1065 else /* concatination with if */
1066#endif
1067 if (!lwip_inet_aton(pszAddress, &ip))
1068 {
1069 LogRelFunc(("cannot resolve IP %s\n", pszAddress));
1070 return VERR_NET_HOST_UNREACHABLE;
1071 }
1072 /* Create socket and connect. */
1073 int iSock = lwip_socket(iInetFamily, SOCK_STREAM, 0);
1074 if (iSock != -1)
1075 {
1076 struct sockaddr *pSockAddr = NULL;
1077 struct sockaddr_in InAddr = {0};
1078#if LWIP_IPV6
1079 struct sockaddr_in6 In6Addr = {0};
1080#endif
1081 if (iInetFamily == PF_INET)
1082 {
1083 InAddr.sin_family = AF_INET;
1084 InAddr.sin_port = htons(uPort);
1085 InAddr.sin_addr = ip;
1086 InAddr.sin_len = sizeof(InAddr);
1087 pSockAddr = (struct sockaddr *)&InAddr;
1088 }
1089#if LWIP_IPV6
1090 else
1091 {
1092 In6Addr.sin6_family = AF_INET6;
1093 In6Addr.sin6_port = htons(uPort);
1094 memcpy(&In6Addr.sin6_addr, &ip6, sizeof(ip6));
1095 In6Addr.sin6_len = sizeof(In6Addr);
1096 pSockAddr = (struct sockaddr *)&In6Addr;
1097 }
1098#endif
1099 if ( pSockAddr
1100 && !lwip_connect(iSock, pSockAddr, pSockAddr->sa_len))
1101 {
1102 pSocketInt->hSock = iSock;
1103 return VINF_SUCCESS;
1104 }
1105 rc = VERR_NET_CONNECTION_REFUSED; /** @todo real solution needed */
1106 lwip_close(iSock);
1107 }
1108 else
1109 rc = VERR_NET_CONNECTION_REFUSED; /** @todo real solution needed */
1110 return rc;
1111}
1112
1113/** @interface_method_impl{VDINTERFACETCPNET,pfnClientClose} */
1114static DECLCALLBACK(int) drvvdINIPClientClose(VDSOCKET Sock)
1115{
1116 PINIPSOCKET pSocketInt = (PINIPSOCKET)Sock;
1117
1118 lwip_close(pSocketInt->hSock);
1119 pSocketInt->hSock = INT32_MAX;
1120 return VINF_SUCCESS; /** @todo real solution needed */
1121}
1122
1123/** @interface_method_impl{VDINTERFACETCPNET,pfnIsClientConnected} */
1124static DECLCALLBACK(bool) drvvdINIPIsClientConnected(VDSOCKET Sock)
1125{
1126 PINIPSOCKET pSocketInt = (PINIPSOCKET)Sock;
1127
1128 return pSocketInt->hSock != INT32_MAX;
1129}
1130
1131/** @interface_method_impl{VDINTERFACETCPNET,pfnSelectOne} */
1132static DECLCALLBACK(int) drvvdINIPSelectOne(VDSOCKET Sock, RTMSINTERVAL cMillies)
1133{
1134 PINIPSOCKET pSocketInt = (PINIPSOCKET)Sock;
1135 fd_set fdsetR;
1136 FD_ZERO(&fdsetR);
1137 FD_SET((uintptr_t)pSocketInt->hSock, &fdsetR);
1138 fd_set fdsetE = fdsetR;
1139
1140 int rc;
1141 if (cMillies == RT_INDEFINITE_WAIT)
1142 rc = lwip_select(pSocketInt->hSock + 1, &fdsetR, NULL, &fdsetE, NULL);
1143 else
1144 {
1145 struct timeval timeout;
1146 timeout.tv_sec = cMillies / 1000;
1147 timeout.tv_usec = (cMillies % 1000) * 1000;
1148 rc = lwip_select(pSocketInt->hSock + 1, &fdsetR, NULL, &fdsetE, &timeout);
1149 }
1150 if (rc > 0)
1151 return VINF_SUCCESS;
1152 if (rc == 0)
1153 return VERR_TIMEOUT;
1154 return VERR_NET_CONNECTION_REFUSED; /** @todo real solution needed */
1155}
1156
1157/** @interface_method_impl{VDINTERFACETCPNET,pfnRead} */
1158static DECLCALLBACK(int) drvvdINIPRead(VDSOCKET Sock, void *pvBuffer, size_t cbBuffer, size_t *pcbRead)
1159{
1160 PINIPSOCKET pSocketInt = (PINIPSOCKET)Sock;
1161
1162 /* Do params checking */
1163 if (!pvBuffer || !cbBuffer)
1164 {
1165 AssertMsgFailed(("Invalid params\n"));
1166 return VERR_INVALID_PARAMETER;
1167 }
1168
1169 /*
1170 * Read loop.
1171 * If pcbRead is NULL we have to fill the entire buffer!
1172 */
1173 size_t cbRead = 0;
1174 size_t cbToRead = cbBuffer;
1175 for (;;)
1176 {
1177 /** @todo this clipping here is just in case (the send function
1178 * needed it, so I added it here, too). Didn't investigate if this
1179 * really has issues. Better be safe than sorry. */
1180 ssize_t cbBytesRead = lwip_recv(pSocketInt->hSock, (char *)pvBuffer + cbRead,
1181 RT_MIN(cbToRead, 32768), 0);
1182 if (cbBytesRead < 0)
1183 return VERR_NET_CONNECTION_REFUSED; /** @todo real solution */
1184 if (cbBytesRead == 0 && errno) /** @todo r=bird: lwip_recv will not touch errno on Windows. This may apply to other hosts as well */
1185 return VERR_NET_CONNECTION_REFUSED; /** @todo real solution */
1186 if (pcbRead)
1187 {
1188 /* return partial data */
1189 *pcbRead = cbBytesRead;
1190 break;
1191 }
1192
1193 /* read more? */
1194 cbRead += cbBytesRead;
1195 if (cbRead == cbBuffer)
1196 break;
1197
1198 /* next */
1199 cbToRead = cbBuffer - cbRead;
1200 }
1201
1202 return VINF_SUCCESS;
1203}
1204
1205/** @interface_method_impl{VDINTERFACETCPNET,pfnWrite} */
1206static DECLCALLBACK(int) drvvdINIPWrite(VDSOCKET Sock, const void *pvBuffer, size_t cbBuffer)
1207{
1208 PINIPSOCKET pSocketInt = (PINIPSOCKET)Sock;
1209
1210 do
1211 {
1212 /** @todo lwip send only supports up to 65535 bytes in a single
1213 * send (stupid limitation buried in the code), so make sure we
1214 * don't get any wraparounds. This should be moved to DevINIP
1215 * stack interface once that's implemented. */
1216 ssize_t cbWritten = lwip_send(pSocketInt->hSock, (void *)pvBuffer,
1217 RT_MIN(cbBuffer, 32768), 0);
1218 if (cbWritten < 0)
1219 return VERR_NET_CONNECTION_REFUSED; /** @todo real solution needed */
1220 AssertMsg(cbBuffer >= (size_t)cbWritten, ("Wrote more than we requested!!! cbWritten=%d cbBuffer=%d\n",
1221 cbWritten, cbBuffer));
1222 cbBuffer -= cbWritten;
1223 pvBuffer = (const char *)pvBuffer + cbWritten;
1224 } while (cbBuffer);
1225
1226 return VINF_SUCCESS;
1227}
1228
1229/** @interface_method_impl{VDINTERFACETCPNET,pfnSgWrite} */
1230static DECLCALLBACK(int) drvvdINIPSgWrite(VDSOCKET Sock, PCRTSGBUF pSgBuf)
1231{
1232 int rc = VINF_SUCCESS;
1233
1234 /* This is an extremely crude emulation, however it's good enough
1235 * for our iSCSI code. INIP has no sendmsg(). */
1236 for (unsigned i = 0; i < pSgBuf->cSegs; i++)
1237 {
1238 rc = drvvdINIPWrite(Sock, pSgBuf->paSegs[i].pvSeg,
1239 pSgBuf->paSegs[i].cbSeg);
1240 if (RT_FAILURE(rc))
1241 break;
1242 }
1243 if (RT_SUCCESS(rc))
1244 drvvdINIPFlush(Sock);
1245
1246 return rc;
1247}
1248
1249/** @interface_method_impl{VDINTERFACETCPNET,pfnFlush} */
1250static DECLCALLBACK(int) drvvdINIPFlush(VDSOCKET Sock)
1251{
1252 PINIPSOCKET pSocketInt = (PINIPSOCKET)Sock;
1253
1254 int fFlag = 1;
1255 lwip_setsockopt(pSocketInt->hSock, IPPROTO_TCP, TCP_NODELAY,
1256 (const char *)&fFlag, sizeof(fFlag));
1257 fFlag = 0;
1258 lwip_setsockopt(pSocketInt->hSock, IPPROTO_TCP, TCP_NODELAY,
1259 (const char *)&fFlag, sizeof(fFlag));
1260 return VINF_SUCCESS;
1261}
1262
1263/** @interface_method_impl{VDINTERFACETCPNET,pfnSetSendCoalescing} */
1264static DECLCALLBACK(int) drvvdINIPSetSendCoalescing(VDSOCKET Sock, bool fEnable)
1265{
1266 PINIPSOCKET pSocketInt = (PINIPSOCKET)Sock;
1267
1268 int fFlag = fEnable ? 0 : 1;
1269 lwip_setsockopt(pSocketInt->hSock, IPPROTO_TCP, TCP_NODELAY,
1270 (const char *)&fFlag, sizeof(fFlag));
1271 return VINF_SUCCESS;
1272}
1273
1274/** @interface_method_impl{VDINTERFACETCPNET,pfnGetLocalAddress} */
1275static DECLCALLBACK(int) drvvdINIPGetLocalAddress(VDSOCKET Sock, PRTNETADDR pAddr)
1276{
1277 PINIPSOCKET pSocketInt = (PINIPSOCKET)Sock;
1278 INIPSOCKADDRUNION u;
1279 socklen_t cbAddr = sizeof(u);
1280 RT_ZERO(u);
1281 if (!lwip_getsockname(pSocketInt->hSock, &u.Addr, &cbAddr))
1282 {
1283 /*
1284 * Convert the address.
1285 */
1286 if ( cbAddr == sizeof(struct sockaddr_in)
1287 && u.Addr.sa_family == AF_INET)
1288 {
1289 RT_ZERO(*pAddr);
1290 pAddr->enmType = RTNETADDRTYPE_IPV4;
1291 pAddr->uPort = RT_N2H_U16(u.Ipv4.sin_port);
1292 pAddr->uAddr.IPv4.u = u.Ipv4.sin_addr.s_addr;
1293 }
1294#if LWIP_IPV6
1295 else if ( cbAddr == sizeof(struct sockaddr_in6)
1296 && u.Addr.sa_family == AF_INET6)
1297 {
1298 RT_ZERO(*pAddr);
1299 pAddr->enmType = RTNETADDRTYPE_IPV6;
1300 pAddr->uPort = RT_N2H_U16(u.Ipv6.sin6_port);
1301 memcpy(&pAddr->uAddr.IPv6, &u.Ipv6.sin6_addr, sizeof(RTNETADDRIPV6));
1302 }
1303#endif
1304 else
1305 return VERR_NET_ADDRESS_FAMILY_NOT_SUPPORTED;
1306 return VINF_SUCCESS;
1307 }
1308 return VERR_NET_OPERATION_NOT_SUPPORTED;
1309}
1310
1311/** @interface_method_impl{VDINTERFACETCPNET,pfnGetPeerAddress} */
1312static DECLCALLBACK(int) drvvdINIPGetPeerAddress(VDSOCKET Sock, PRTNETADDR pAddr)
1313{
1314 PINIPSOCKET pSocketInt = (PINIPSOCKET)Sock;
1315 INIPSOCKADDRUNION u;
1316 socklen_t cbAddr = sizeof(u);
1317 RT_ZERO(u);
1318 if (!lwip_getpeername(pSocketInt->hSock, &u.Addr, &cbAddr))
1319 {
1320 /*
1321 * Convert the address.
1322 */
1323 if ( cbAddr == sizeof(struct sockaddr_in)
1324 && u.Addr.sa_family == AF_INET)
1325 {
1326 RT_ZERO(*pAddr);
1327 pAddr->enmType = RTNETADDRTYPE_IPV4;
1328 pAddr->uPort = RT_N2H_U16(u.Ipv4.sin_port);
1329 pAddr->uAddr.IPv4.u = u.Ipv4.sin_addr.s_addr;
1330 }
1331#if LWIP_IPV6
1332 else if ( cbAddr == sizeof(struct sockaddr_in6)
1333 && u.Addr.sa_family == AF_INET6)
1334 {
1335 RT_ZERO(*pAddr);
1336 pAddr->enmType = RTNETADDRTYPE_IPV6;
1337 pAddr->uPort = RT_N2H_U16(u.Ipv6.sin6_port);
1338 memcpy(&pAddr->uAddr.IPv6, &u.Ipv6.sin6_addr, sizeof(RTNETADDRIPV6));
1339 }
1340#endif
1341 else
1342 return VERR_NET_ADDRESS_FAMILY_NOT_SUPPORTED;
1343 return VINF_SUCCESS;
1344 }
1345 return VERR_NET_OPERATION_NOT_SUPPORTED;
1346}
1347
1348/** @interface_method_impl{VDINTERFACETCPNET,pfnSelectOneEx} */
1349static DECLCALLBACK(int) drvvdINIPSelectOneEx(VDSOCKET Sock, uint32_t fEvents, uint32_t *pfEvents, RTMSINTERVAL cMillies)
1350{
1351 RT_NOREF(Sock, fEvents, pfEvents, cMillies);
1352 AssertMsgFailed(("Not supported!\n"));
1353 return VERR_NOT_SUPPORTED;
1354}
1355
1356/** @interface_method_impl{VDINTERFACETCPNET,pfnPoke} */
1357static DECLCALLBACK(int) drvvdINIPPoke(VDSOCKET Sock)
1358{
1359 RT_NOREF(Sock);
1360 AssertMsgFailed(("Not supported!\n"));
1361 return VERR_NOT_SUPPORTED;
1362}
1363
1364#endif /* VBOX_WITH_INIP */
1365
1366
1367/*********************************************************************************************************************************
1368* VD TCP network stack interface implementation - Host TCP case *
1369*********************************************************************************************************************************/
1370
1371/**
1372 * Socket data.
1373 */
1374typedef struct VDSOCKETINT
1375{
1376 /** IPRT socket handle. */
1377 RTSOCKET hSocket;
1378 /** Pollset with the wakeup pipe and socket. */
1379 RTPOLLSET hPollSet;
1380 /** Pipe endpoint - read (in the pollset). */
1381 RTPIPE hPipeR;
1382 /** Pipe endpoint - write. */
1383 RTPIPE hPipeW;
1384 /** Flag whether the thread was woken up. */
1385 volatile bool fWokenUp;
1386 /** Flag whether the thread is waiting in the select call. */
1387 volatile bool fWaiting;
1388 /** Old event mask. */
1389 uint32_t fEventsOld;
1390} VDSOCKETINT, *PVDSOCKETINT;
1391
1392/** Pollset id of the socket. */
1393#define VDSOCKET_POLL_ID_SOCKET 0
1394/** Pollset id of the pipe. */
1395#define VDSOCKET_POLL_ID_PIPE 1
1396
1397/** @interface_method_impl{VDINTERFACETCPNET,pfnSocketCreate} */
1398static DECLCALLBACK(int) drvvdTcpSocketCreate(uint32_t fFlags, PVDSOCKET phVdSock)
1399{
1400 int rc = VINF_SUCCESS;
1401 int rc2 = VINF_SUCCESS;
1402 PVDSOCKETINT pSockInt = NULL;
1403
1404 pSockInt = (PVDSOCKETINT)RTMemAllocZ(sizeof(VDSOCKETINT));
1405 if (!pSockInt)
1406 return VERR_NO_MEMORY;
1407
1408 pSockInt->hSocket = NIL_RTSOCKET;
1409 pSockInt->hPollSet = NIL_RTPOLLSET;
1410 pSockInt->hPipeR = NIL_RTPIPE;
1411 pSockInt->hPipeW = NIL_RTPIPE;
1412 pSockInt->fWokenUp = false;
1413 pSockInt->fWaiting = false;
1414
1415 if (fFlags & VD_INTERFACETCPNET_CONNECT_EXTENDED_SELECT)
1416 {
1417 /* Init pipe and pollset. */
1418 rc = RTPipeCreate(&pSockInt->hPipeR, &pSockInt->hPipeW, 0);
1419 if (RT_SUCCESS(rc))
1420 {
1421 rc = RTPollSetCreate(&pSockInt->hPollSet);
1422 if (RT_SUCCESS(rc))
1423 {
1424 rc = RTPollSetAddPipe(pSockInt->hPollSet, pSockInt->hPipeR,
1425 RTPOLL_EVT_READ, VDSOCKET_POLL_ID_PIPE);
1426 if (RT_SUCCESS(rc))
1427 {
1428 *phVdSock = pSockInt;
1429 return VINF_SUCCESS;
1430 }
1431
1432 RTPollSetRemove(pSockInt->hPollSet, VDSOCKET_POLL_ID_PIPE);
1433 rc2 = RTPollSetDestroy(pSockInt->hPollSet);
1434 AssertRC(rc2);
1435 }
1436
1437 rc2 = RTPipeClose(pSockInt->hPipeR);
1438 AssertRC(rc2);
1439 rc2 = RTPipeClose(pSockInt->hPipeW);
1440 AssertRC(rc2);
1441 }
1442 }
1443 else
1444 {
1445 *phVdSock = pSockInt;
1446 return VINF_SUCCESS;
1447 }
1448
1449 RTMemFree(pSockInt);
1450
1451 return rc;
1452}
1453
1454/** @interface_method_impl{VDINTERFACETCPNET,pfnSocketDestroy} */
1455static DECLCALLBACK(int) drvvdTcpSocketDestroy(VDSOCKET hVdSock)
1456{
1457 int rc = VINF_SUCCESS;
1458 PVDSOCKETINT pSockInt = (PVDSOCKETINT)hVdSock;
1459
1460 /* Destroy the pipe and pollset if necessary. */
1461 if (pSockInt->hPollSet != NIL_RTPOLLSET)
1462 {
1463 if (pSockInt->hSocket != NIL_RTSOCKET)
1464 {
1465 rc = RTPollSetRemove(pSockInt->hPollSet, VDSOCKET_POLL_ID_SOCKET);
1466 Assert(RT_SUCCESS(rc) || rc == VERR_POLL_HANDLE_ID_NOT_FOUND);
1467 }
1468 rc = RTPollSetRemove(pSockInt->hPollSet, VDSOCKET_POLL_ID_PIPE);
1469 AssertRC(rc);
1470 rc = RTPollSetDestroy(pSockInt->hPollSet);
1471 AssertRC(rc);
1472 rc = RTPipeClose(pSockInt->hPipeR);
1473 AssertRC(rc);
1474 rc = RTPipeClose(pSockInt->hPipeW);
1475 AssertRC(rc);
1476 }
1477
1478 if (pSockInt->hSocket != NIL_RTSOCKET)
1479 rc = RTTcpClientCloseEx(pSockInt->hSocket, false /*fGracefulShutdown*/);
1480
1481 RTMemFree(pSockInt);
1482
1483 return rc;
1484}
1485
1486/** @interface_method_impl{VDINTERFACETCPNET,pfnClientConnect} */
1487static DECLCALLBACK(int) drvvdTcpClientConnect(VDSOCKET hVdSock, const char *pszAddress, uint32_t uPort,
1488 RTMSINTERVAL cMillies)
1489{
1490 int rc = VINF_SUCCESS;
1491 PVDSOCKETINT pSockInt = (PVDSOCKETINT)hVdSock;
1492
1493 rc = RTTcpClientConnectEx(pszAddress, uPort, &pSockInt->hSocket, cMillies, NULL);
1494 if (RT_SUCCESS(rc))
1495 {
1496 /* Add to the pollset if required. */
1497 if (pSockInt->hPollSet != NIL_RTPOLLSET)
1498 {
1499 pSockInt->fEventsOld = RTPOLL_EVT_READ | RTPOLL_EVT_WRITE | RTPOLL_EVT_ERROR;
1500
1501 rc = RTPollSetAddSocket(pSockInt->hPollSet, pSockInt->hSocket,
1502 pSockInt->fEventsOld, VDSOCKET_POLL_ID_SOCKET);
1503 }
1504
1505 if (RT_SUCCESS(rc))
1506 return VINF_SUCCESS;
1507
1508 rc = RTTcpClientCloseEx(pSockInt->hSocket, false /*fGracefulShutdown*/);
1509 }
1510
1511 return rc;
1512}
1513
1514/** @interface_method_impl{VDINTERFACETCPNET,pfnClientClose} */
1515static DECLCALLBACK(int) drvvdTcpClientClose(VDSOCKET hVdSock)
1516{
1517 int rc = VINF_SUCCESS;
1518 PVDSOCKETINT pSockInt = (PVDSOCKETINT)hVdSock;
1519
1520 if (pSockInt->hPollSet != NIL_RTPOLLSET)
1521 {
1522 rc = RTPollSetRemove(pSockInt->hPollSet, VDSOCKET_POLL_ID_SOCKET);
1523 AssertRC(rc);
1524 }
1525
1526 rc = RTTcpClientCloseEx(pSockInt->hSocket, false /*fGracefulShutdown*/);
1527 pSockInt->hSocket = NIL_RTSOCKET;
1528
1529 return rc;
1530}
1531
1532/** @interface_method_impl{VDINTERFACETCPNET,pfnIsClientConnected} */
1533static DECLCALLBACK(bool) drvvdTcpIsClientConnected(VDSOCKET hVdSock)
1534{
1535 PVDSOCKETINT pSockInt = (PVDSOCKETINT)hVdSock;
1536
1537 return pSockInt->hSocket != NIL_RTSOCKET;
1538}
1539
1540/** @interface_method_impl{VDINTERFACETCPNET,pfnSelectOne} */
1541static DECLCALLBACK(int) drvvdTcpSelectOne(VDSOCKET hVdSock, RTMSINTERVAL cMillies)
1542{
1543 PVDSOCKETINT pSockInt = (PVDSOCKETINT)hVdSock;
1544
1545 return RTTcpSelectOne(pSockInt->hSocket, cMillies);
1546}
1547
1548/** @interface_method_impl{VDINTERFACETCPNET,pfnRead} */
1549static DECLCALLBACK(int) drvvdTcpRead(VDSOCKET hVdSock, void *pvBuffer, size_t cbBuffer, size_t *pcbRead)
1550{
1551 PVDSOCKETINT pSockInt = (PVDSOCKETINT)hVdSock;
1552
1553 return RTTcpRead(pSockInt->hSocket, pvBuffer, cbBuffer, pcbRead);
1554}
1555
1556/** @interface_method_impl{VDINTERFACETCPNET,pfnWrite} */
1557static DECLCALLBACK(int) drvvdTcpWrite(VDSOCKET hVdSock, const void *pvBuffer, size_t cbBuffer)
1558{
1559 PVDSOCKETINT pSockInt = (PVDSOCKETINT)hVdSock;
1560
1561 return RTTcpWrite(pSockInt->hSocket, pvBuffer, cbBuffer);
1562}
1563
1564/** @interface_method_impl{VDINTERFACETCPNET,pfnSgWrite} */
1565static DECLCALLBACK(int) drvvdTcpSgWrite(VDSOCKET hVdSock, PCRTSGBUF pSgBuf)
1566{
1567 PVDSOCKETINT pSockInt = (PVDSOCKETINT)hVdSock;
1568
1569 return RTTcpSgWrite(pSockInt->hSocket, pSgBuf);
1570}
1571
1572/** @interface_method_impl{VDINTERFACETCPNET,pfnReadNB} */
1573static DECLCALLBACK(int) drvvdTcpReadNB(VDSOCKET hVdSock, void *pvBuffer, size_t cbBuffer, size_t *pcbRead)
1574{
1575 PVDSOCKETINT pSockInt = (PVDSOCKETINT)hVdSock;
1576
1577 return RTTcpReadNB(pSockInt->hSocket, pvBuffer, cbBuffer, pcbRead);
1578}
1579
1580/** @interface_method_impl{VDINTERFACETCPNET,pfnWriteNB} */
1581static DECLCALLBACK(int) drvvdTcpWriteNB(VDSOCKET hVdSock, const void *pvBuffer, size_t cbBuffer, size_t *pcbWritten)
1582{
1583 PVDSOCKETINT pSockInt = (PVDSOCKETINT)hVdSock;
1584
1585 return RTTcpWriteNB(pSockInt->hSocket, pvBuffer, cbBuffer, pcbWritten);
1586}
1587
1588/** @interface_method_impl{VDINTERFACETCPNET,pfnSgWriteNB} */
1589static DECLCALLBACK(int) drvvdTcpSgWriteNB(VDSOCKET hVdSock, PRTSGBUF pSgBuf, size_t *pcbWritten)
1590{
1591 PVDSOCKETINT pSockInt = (PVDSOCKETINT)hVdSock;
1592
1593 return RTTcpSgWriteNB(pSockInt->hSocket, pSgBuf, pcbWritten);
1594}
1595
1596/** @interface_method_impl{VDINTERFACETCPNET,pfnFlush} */
1597static DECLCALLBACK(int) drvvdTcpFlush(VDSOCKET hVdSock)
1598{
1599 PVDSOCKETINT pSockInt = (PVDSOCKETINT)hVdSock;
1600
1601 return RTTcpFlush(pSockInt->hSocket);
1602}
1603
1604/** @interface_method_impl{VDINTERFACETCPNET,pfnSetSendCoalescing} */
1605static DECLCALLBACK(int) drvvdTcpSetSendCoalescing(VDSOCKET hVdSock, bool fEnable)
1606{
1607 PVDSOCKETINT pSockInt = (PVDSOCKETINT)hVdSock;
1608
1609 return RTTcpSetSendCoalescing(pSockInt->hSocket, fEnable);
1610}
1611
1612/** @interface_method_impl{VDINTERFACETCPNET,pfnGetLocalAddress} */
1613static DECLCALLBACK(int) drvvdTcpGetLocalAddress(VDSOCKET hVdSock, PRTNETADDR pAddr)
1614{
1615 PVDSOCKETINT pSockInt = (PVDSOCKETINT)hVdSock;
1616
1617 return RTTcpGetLocalAddress(pSockInt->hSocket, pAddr);
1618}
1619
1620/** @interface_method_impl{VDINTERFACETCPNET,pfnGetPeerAddress} */
1621static DECLCALLBACK(int) drvvdTcpGetPeerAddress(VDSOCKET hVdSock, PRTNETADDR pAddr)
1622{
1623 PVDSOCKETINT pSockInt = (PVDSOCKETINT)hVdSock;
1624
1625 return RTTcpGetPeerAddress(pSockInt->hSocket, pAddr);
1626}
1627
1628static DECLCALLBACK(int) drvvdTcpSelectOneExPoll(VDSOCKET hVdSock, uint32_t fEvents,
1629 uint32_t *pfEvents, RTMSINTERVAL cMillies)
1630{
1631 int rc = VINF_SUCCESS;
1632 uint32_t id = 0;
1633 uint32_t fEventsRecv = 0;
1634 PVDSOCKETINT pSockInt = (PVDSOCKETINT)hVdSock;
1635
1636 *pfEvents = 0;
1637
1638 if ( pSockInt->fEventsOld != fEvents
1639 && pSockInt->hSocket != NIL_RTSOCKET)
1640 {
1641 uint32_t fPollEvents = 0;
1642
1643 if (fEvents & VD_INTERFACETCPNET_EVT_READ)
1644 fPollEvents |= RTPOLL_EVT_READ;
1645 if (fEvents & VD_INTERFACETCPNET_EVT_WRITE)
1646 fPollEvents |= RTPOLL_EVT_WRITE;
1647 if (fEvents & VD_INTERFACETCPNET_EVT_ERROR)
1648 fPollEvents |= RTPOLL_EVT_ERROR;
1649
1650 rc = RTPollSetEventsChange(pSockInt->hPollSet, VDSOCKET_POLL_ID_SOCKET, fPollEvents);
1651 if (RT_FAILURE(rc))
1652 return rc;
1653
1654 pSockInt->fEventsOld = fEvents;
1655 }
1656
1657 ASMAtomicXchgBool(&pSockInt->fWaiting, true);
1658 if (ASMAtomicXchgBool(&pSockInt->fWokenUp, false))
1659 {
1660 ASMAtomicXchgBool(&pSockInt->fWaiting, false);
1661 return VERR_INTERRUPTED;
1662 }
1663
1664 rc = RTPoll(pSockInt->hPollSet, cMillies, &fEventsRecv, &id);
1665 Assert(RT_SUCCESS(rc) || rc == VERR_TIMEOUT);
1666
1667 ASMAtomicXchgBool(&pSockInt->fWaiting, false);
1668
1669 if (RT_SUCCESS(rc))
1670 {
1671 if (id == VDSOCKET_POLL_ID_SOCKET)
1672 {
1673 fEventsRecv &= RTPOLL_EVT_VALID_MASK;
1674
1675 if (fEventsRecv & RTPOLL_EVT_READ)
1676 *pfEvents |= VD_INTERFACETCPNET_EVT_READ;
1677 if (fEventsRecv & RTPOLL_EVT_WRITE)
1678 *pfEvents |= VD_INTERFACETCPNET_EVT_WRITE;
1679 if (fEventsRecv & RTPOLL_EVT_ERROR)
1680 *pfEvents |= VD_INTERFACETCPNET_EVT_ERROR;
1681 }
1682 else
1683 {
1684 size_t cbRead = 0;
1685 uint8_t abBuf[10];
1686 Assert(id == VDSOCKET_POLL_ID_PIPE);
1687 Assert((fEventsRecv & RTPOLL_EVT_VALID_MASK) == RTPOLL_EVT_READ);
1688
1689 /* We got interrupted, drain the pipe. */
1690 rc = RTPipeRead(pSockInt->hPipeR, abBuf, sizeof(abBuf), &cbRead);
1691 AssertRC(rc);
1692
1693 ASMAtomicXchgBool(&pSockInt->fWokenUp, false);
1694
1695 rc = VERR_INTERRUPTED;
1696 }
1697 }
1698
1699 return rc;
1700}
1701
1702/** @interface_method_impl{VDINTERFACETCPNET,pfnSelectOneEx} */
1703static DECLCALLBACK(int) drvvdTcpSelectOneExNoPoll(VDSOCKET hVdSock, uint32_t fEvents, uint32_t *pfEvents, RTMSINTERVAL cMillies)
1704{
1705 RT_NOREF(cMillies); /** @todo timeouts */
1706 int rc = VINF_SUCCESS;
1707 PVDSOCKETINT pSockInt = (PVDSOCKETINT)hVdSock;
1708
1709 *pfEvents = 0;
1710
1711 ASMAtomicXchgBool(&pSockInt->fWaiting, true);
1712 if (ASMAtomicXchgBool(&pSockInt->fWokenUp, false))
1713 {
1714 ASMAtomicXchgBool(&pSockInt->fWaiting, false);
1715 return VERR_INTERRUPTED;
1716 }
1717
1718 if ( pSockInt->hSocket == NIL_RTSOCKET
1719 || !fEvents)
1720 {
1721 /*
1722 * Only the pipe is configured or the caller doesn't wait for a socket event,
1723 * wait until there is something to read from the pipe.
1724 */
1725 size_t cbRead = 0;
1726 char ch = 0;
1727 rc = RTPipeReadBlocking(pSockInt->hPipeR, &ch, 1, &cbRead);
1728 if (RT_SUCCESS(rc))
1729 {
1730 Assert(cbRead == 1);
1731 rc = VERR_INTERRUPTED;
1732 ASMAtomicXchgBool(&pSockInt->fWokenUp, false);
1733 }
1734 }
1735 else
1736 {
1737 uint32_t fSelectEvents = 0;
1738
1739 if (fEvents & VD_INTERFACETCPNET_EVT_READ)
1740 fSelectEvents |= RTSOCKET_EVT_READ;
1741 if (fEvents & VD_INTERFACETCPNET_EVT_WRITE)
1742 fSelectEvents |= RTSOCKET_EVT_WRITE;
1743 if (fEvents & VD_INTERFACETCPNET_EVT_ERROR)
1744 fSelectEvents |= RTSOCKET_EVT_ERROR;
1745
1746 if (fEvents & VD_INTERFACETCPNET_HINT_INTERRUPT)
1747 {
1748 uint32_t fEventsRecv = 0;
1749
1750 /* Make sure the socket is not in the pollset. */
1751 rc = RTPollSetRemove(pSockInt->hPollSet, VDSOCKET_POLL_ID_SOCKET);
1752 Assert(RT_SUCCESS(rc) || rc == VERR_POLL_HANDLE_ID_NOT_FOUND);
1753
1754 for (;;)
1755 {
1756 uint32_t id = 0;
1757 rc = RTPoll(pSockInt->hPollSet, 5, &fEvents, &id);
1758 if (rc == VERR_TIMEOUT)
1759 {
1760 /* Check the socket. */
1761 rc = RTTcpSelectOneEx(pSockInt->hSocket, fSelectEvents, &fEventsRecv, 0);
1762 if (RT_SUCCESS(rc))
1763 {
1764 if (fEventsRecv & RTSOCKET_EVT_READ)
1765 *pfEvents |= VD_INTERFACETCPNET_EVT_READ;
1766 if (fEventsRecv & RTSOCKET_EVT_WRITE)
1767 *pfEvents |= VD_INTERFACETCPNET_EVT_WRITE;
1768 if (fEventsRecv & RTSOCKET_EVT_ERROR)
1769 *pfEvents |= VD_INTERFACETCPNET_EVT_ERROR;
1770 break; /* Quit */
1771 }
1772 else if (rc != VERR_TIMEOUT)
1773 break;
1774 }
1775 else if (RT_SUCCESS(rc))
1776 {
1777 size_t cbRead = 0;
1778 uint8_t abBuf[10];
1779 Assert(id == VDSOCKET_POLL_ID_PIPE);
1780 Assert((fEventsRecv & RTPOLL_EVT_VALID_MASK) == RTPOLL_EVT_READ);
1781
1782 /* We got interrupted, drain the pipe. */
1783 rc = RTPipeRead(pSockInt->hPipeR, abBuf, sizeof(abBuf), &cbRead);
1784 AssertRC(rc);
1785
1786 ASMAtomicXchgBool(&pSockInt->fWokenUp, false);
1787
1788 rc = VERR_INTERRUPTED;
1789 break;
1790 }
1791 else
1792 break;
1793 }
1794 }
1795 else /* The caller waits for a socket event. */
1796 {
1797 uint32_t fEventsRecv = 0;
1798
1799 /* Loop until we got woken up or a socket event occurred. */
1800 for (;;)
1801 {
1802 /** @todo find an adaptive wait algorithm based on the
1803 * number of wakeups in the past. */
1804 rc = RTTcpSelectOneEx(pSockInt->hSocket, fSelectEvents, &fEventsRecv, 5);
1805 if (rc == VERR_TIMEOUT)
1806 {
1807 /* Check if there is an event pending. */
1808 size_t cbRead = 0;
1809 char ch = 0;
1810 rc = RTPipeRead(pSockInt->hPipeR, &ch, 1, &cbRead);
1811 if (RT_SUCCESS(rc) && rc != VINF_TRY_AGAIN)
1812 {
1813 Assert(cbRead == 1);
1814 rc = VERR_INTERRUPTED;
1815 ASMAtomicXchgBool(&pSockInt->fWokenUp, false);
1816 break; /* Quit */
1817 }
1818 else
1819 Assert(rc == VINF_TRY_AGAIN);
1820 }
1821 else if (RT_SUCCESS(rc))
1822 {
1823 if (fEventsRecv & RTSOCKET_EVT_READ)
1824 *pfEvents |= VD_INTERFACETCPNET_EVT_READ;
1825 if (fEventsRecv & RTSOCKET_EVT_WRITE)
1826 *pfEvents |= VD_INTERFACETCPNET_EVT_WRITE;
1827 if (fEventsRecv & RTSOCKET_EVT_ERROR)
1828 *pfEvents |= VD_INTERFACETCPNET_EVT_ERROR;
1829 break; /* Quit */
1830 }
1831 else
1832 break;
1833 }
1834 }
1835 }
1836
1837 ASMAtomicXchgBool(&pSockInt->fWaiting, false);
1838
1839 return rc;
1840}
1841
1842/** @interface_method_impl{VDINTERFACETCPNET,pfnPoke} */
1843static DECLCALLBACK(int) drvvdTcpPoke(VDSOCKET hVdSock)
1844{
1845 int rc = VINF_SUCCESS;
1846 size_t cbWritten = 0;
1847 PVDSOCKETINT pSockInt = (PVDSOCKETINT)hVdSock;
1848
1849 ASMAtomicXchgBool(&pSockInt->fWokenUp, true);
1850
1851 if (ASMAtomicReadBool(&pSockInt->fWaiting))
1852 {
1853 rc = RTPipeWrite(pSockInt->hPipeW, "", 1, &cbWritten);
1854 Assert(RT_SUCCESS(rc) || cbWritten == 0);
1855 }
1856
1857 return VINF_SUCCESS;
1858}
1859
1860/**
1861 * Checks the prerequisites for encrypted I/O.
1862 *
1863 * @returns VBox status code.
1864 * @param pThis The VD driver instance data.
1865 * @param fSetError Flag whether to set a runtime error.
1866 */
1867static int drvvdKeyCheckPrereqs(PVBOXDISK pThis, bool fSetError)
1868{
1869 if ( pThis->pCfgCrypto
1870 && !pThis->pIfSecKey)
1871 {
1872 AssertPtr(pThis->pIfSecKeyHlp);
1873 pThis->pIfSecKeyHlp->pfnKeyMissingNotify(pThis->pIfSecKeyHlp);
1874
1875 if (fSetError)
1876 {
1877 int rc = PDMDrvHlpVMSetRuntimeError(pThis->pDrvIns, VMSETRTERR_FLAGS_SUSPEND | VMSETRTERR_FLAGS_NO_WAIT, "DrvVD_DEKMISSING",
1878 N_("VD: The DEK for this disk is missing"));
1879 AssertRC(rc);
1880 }
1881 return VERR_VD_DEK_MISSING;
1882 }
1883
1884 return VINF_SUCCESS;
1885}
1886
1887
1888/*********************************************************************************************************************************
1889* Media interface methods *
1890*********************************************************************************************************************************/
1891
1892/** @interface_method_impl{PDMIMEDIA,pfnRead} */
1893static DECLCALLBACK(int) drvvdRead(PPDMIMEDIA pInterface,
1894 uint64_t off, void *pvBuf, size_t cbRead)
1895{
1896 int rc = VINF_SUCCESS;
1897
1898 LogFlowFunc(("off=%#llx pvBuf=%p cbRead=%d\n", off, pvBuf, cbRead));
1899 PVBOXDISK pThis = PDMIMEDIA_2_VBOXDISK(pInterface);
1900
1901 /*
1902 * Check the state.
1903 */
1904 if (!pThis->pDisk)
1905 {
1906 AssertMsgFailed(("Invalid state! Not mounted!\n"));
1907 return VERR_PDM_MEDIA_NOT_MOUNTED;
1908 }
1909
1910 rc = drvvdKeyCheckPrereqs(pThis, true /* fSetError */);
1911 if (RT_FAILURE(rc))
1912 return rc;
1913
1914 STAM_REL_COUNTER_INC(&pThis->StatReqsSubmitted);
1915 STAM_REL_COUNTER_INC(&pThis->StatReqsRead);
1916
1917 if (!pThis->fBootAccelActive)
1918 rc = VDRead(pThis->pDisk, off, pvBuf, cbRead);
1919 else
1920 {
1921 /* Can we serve the request from the buffer? */
1922 if ( off >= pThis->offDisk
1923 && off - pThis->offDisk < pThis->cbDataValid)
1924 {
1925 size_t cbToCopy = RT_MIN(cbRead, pThis->offDisk + pThis->cbDataValid - off);
1926
1927 memcpy(pvBuf, pThis->pbData + (off - pThis->offDisk), cbToCopy);
1928 cbRead -= cbToCopy;
1929 off += cbToCopy;
1930 pvBuf = (char *)pvBuf + cbToCopy;
1931 }
1932
1933 if ( cbRead > 0
1934 && cbRead < pThis->cbBootAccelBuffer)
1935 {
1936 /* Increase request to the buffer size and read. */
1937 pThis->cbDataValid = RT_MIN(pThis->cbDisk - off, pThis->cbBootAccelBuffer);
1938 pThis->offDisk = off;
1939 rc = VDRead(pThis->pDisk, off, pThis->pbData, pThis->cbDataValid);
1940 if (RT_FAILURE(rc))
1941 pThis->cbDataValid = 0;
1942 else
1943 memcpy(pvBuf, pThis->pbData, cbRead);
1944 }
1945 else if (cbRead >= pThis->cbBootAccelBuffer)
1946 {
1947 pThis->fBootAccelActive = false; /* Deactiviate */
1948 }
1949 }
1950
1951 if (RT_SUCCESS(rc))
1952 {
1953 STAM_REL_COUNTER_INC(&pThis->StatReqsSucceeded);
1954 STAM_REL_COUNTER_ADD(&pThis->StatBytesRead, cbRead);
1955 Log2(("%s: off=%#llx pvBuf=%p cbRead=%d\n%.*Rhxd\n", __FUNCTION__,
1956 off, pvBuf, cbRead, cbRead, pvBuf));
1957 }
1958 else
1959 STAM_REL_COUNTER_INC(&pThis->StatReqsFailed);
1960
1961 LogFlowFunc(("returns %Rrc\n", rc));
1962 return rc;
1963}
1964
1965/** @interface_method_impl{PDMIMEDIA,pfnRead} */
1966static DECLCALLBACK(int) drvvdReadPcBios(PPDMIMEDIA pInterface,
1967 uint64_t off, void *pvBuf, size_t cbRead)
1968{
1969 int rc = VINF_SUCCESS;
1970
1971 LogFlowFunc(("off=%#llx pvBuf=%p cbRead=%d\n", off, pvBuf, cbRead));
1972 PVBOXDISK pThis = PDMIMEDIA_2_VBOXDISK(pInterface);
1973
1974 /*
1975 * Check the state.
1976 */
1977 if (!pThis->pDisk)
1978 {
1979 AssertMsgFailed(("Invalid state! Not mounted!\n"));
1980 return VERR_PDM_MEDIA_NOT_MOUNTED;
1981 }
1982
1983 if ( pThis->pCfgCrypto
1984 && !pThis->pIfSecKey)
1985 return VERR_VD_DEK_MISSING;
1986
1987 if (!pThis->fBootAccelActive)
1988 rc = VDRead(pThis->pDisk, off, pvBuf, cbRead);
1989 else
1990 {
1991 /* Can we serve the request from the buffer? */
1992 if ( off >= pThis->offDisk
1993 && off - pThis->offDisk < pThis->cbDataValid)
1994 {
1995 size_t cbToCopy = RT_MIN(cbRead, pThis->offDisk + pThis->cbDataValid - off);
1996
1997 memcpy(pvBuf, pThis->pbData + (off - pThis->offDisk), cbToCopy);
1998 cbRead -= cbToCopy;
1999 off += cbToCopy;
2000 pvBuf = (char *)pvBuf + cbToCopy;
2001 }
2002
2003 if ( cbRead > 0
2004 && cbRead < pThis->cbBootAccelBuffer)
2005 {
2006 /* Increase request to the buffer size and read. */
2007 pThis->cbDataValid = RT_MIN(pThis->cbDisk - off, pThis->cbBootAccelBuffer);
2008 pThis->offDisk = off;
2009 rc = VDRead(pThis->pDisk, off, pThis->pbData, pThis->cbDataValid);
2010 if (RT_FAILURE(rc))
2011 pThis->cbDataValid = 0;
2012 else
2013 memcpy(pvBuf, pThis->pbData, cbRead);
2014 }
2015 else if (cbRead >= pThis->cbBootAccelBuffer)
2016 {
2017 pThis->fBootAccelActive = false; /* Deactiviate */
2018 }
2019 }
2020
2021 if (RT_SUCCESS(rc))
2022 Log2(("%s: off=%#llx pvBuf=%p cbRead=%d\n%.*Rhxd\n", __FUNCTION__,
2023 off, pvBuf, cbRead, cbRead, pvBuf));
2024 LogFlowFunc(("returns %Rrc\n", rc));
2025 return rc;
2026}
2027
2028
2029/** @interface_method_impl{PDMIMEDIA,pfnWrite} */
2030static DECLCALLBACK(int) drvvdWrite(PPDMIMEDIA pInterface,
2031 uint64_t off, const void *pvBuf,
2032 size_t cbWrite)
2033{
2034 LogFlowFunc(("off=%#llx pvBuf=%p cbWrite=%d\n", off, pvBuf, cbWrite));
2035 PVBOXDISK pThis = PDMIMEDIA_2_VBOXDISK(pInterface);
2036 Log2(("%s: off=%#llx pvBuf=%p cbWrite=%d\n%.*Rhxd\n", __FUNCTION__,
2037 off, pvBuf, cbWrite, cbWrite, pvBuf));
2038
2039 /*
2040 * Check the state.
2041 */
2042 if (!pThis->pDisk)
2043 {
2044 AssertMsgFailed(("Invalid state! Not mounted!\n"));
2045 return VERR_PDM_MEDIA_NOT_MOUNTED;
2046 }
2047
2048 /* Set an FTM checkpoint as this operation changes the state permanently. */
2049 PDMDrvHlpFTSetCheckpoint(pThis->pDrvIns, FTMCHECKPOINTTYPE_STORAGE);
2050
2051 int rc = drvvdKeyCheckPrereqs(pThis, true /* fSetError */);
2052 if (RT_FAILURE(rc))
2053 return rc;
2054
2055 /* Invalidate any buffer if boot acceleration is enabled. */
2056 if (pThis->fBootAccelActive)
2057 {
2058 pThis->cbDataValid = 0;
2059 pThis->offDisk = 0;
2060 }
2061
2062 STAM_REL_COUNTER_INC(&pThis->StatReqsSubmitted);
2063 STAM_REL_COUNTER_INC(&pThis->StatReqsWrite);
2064
2065 rc = VDWrite(pThis->pDisk, off, pvBuf, cbWrite);
2066#ifdef VBOX_PERIODIC_FLUSH
2067 if (pThis->cbFlushInterval)
2068 {
2069 pThis->cbDataWritten += (uint32_t)cbWrite;
2070 if (pThis->cbDataWritten > pThis->cbFlushInterval)
2071 {
2072 pThis->cbDataWritten = 0;
2073 VDFlush(pThis->pDisk);
2074 }
2075 }
2076#endif /* VBOX_PERIODIC_FLUSH */
2077
2078 if (RT_SUCCESS(rc))
2079 {
2080 STAM_REL_COUNTER_INC(&pThis->StatReqsSucceeded);
2081 STAM_REL_COUNTER_ADD(&pThis->StatBytesWritten, cbWrite);
2082 }
2083 else
2084 STAM_REL_COUNTER_INC(&pThis->StatReqsFailed);
2085
2086 LogFlowFunc(("returns %Rrc\n", rc));
2087 return rc;
2088}
2089
2090/** @interface_method_impl{PDMIMEDIA,pfnFlush} */
2091static DECLCALLBACK(int) drvvdFlush(PPDMIMEDIA pInterface)
2092{
2093 LogFlowFunc(("\n"));
2094 PVBOXDISK pThis = PDMIMEDIA_2_VBOXDISK(pInterface);
2095
2096 /*
2097 * Check the state.
2098 */
2099 if (!pThis->pDisk)
2100 {
2101 AssertMsgFailed(("Invalid state! Not mounted!\n"));
2102 return VERR_PDM_MEDIA_NOT_MOUNTED;
2103 }
2104
2105#ifdef VBOX_IGNORE_FLUSH
2106 if (pThis->fIgnoreFlush)
2107 return VINF_SUCCESS;
2108#endif /* VBOX_IGNORE_FLUSH */
2109
2110 STAM_REL_COUNTER_INC(&pThis->StatReqsSubmitted);
2111 STAM_REL_COUNTER_INC(&pThis->StatReqsFlush);
2112
2113 int rc = VDFlush(pThis->pDisk);
2114 if (RT_SUCCESS(rc))
2115 STAM_REL_COUNTER_INC(&pThis->StatReqsSucceeded);
2116 else
2117 STAM_REL_COUNTER_INC(&pThis->StatReqsFailed);
2118
2119 LogFlowFunc(("returns %Rrc\n", rc));
2120 return rc;
2121}
2122
2123/** @interface_method_impl{PDMIMEDIA,pfnMerge} */
2124static DECLCALLBACK(int) drvvdMerge(PPDMIMEDIA pInterface,
2125 PFNSIMPLEPROGRESS pfnProgress,
2126 void *pvUser)
2127{
2128 LogFlowFunc(("\n"));
2129 PVBOXDISK pThis = PDMIMEDIA_2_VBOXDISK(pInterface);
2130 int rc = VINF_SUCCESS;
2131
2132 /*
2133 * Check the state.
2134 */
2135 if (!pThis->pDisk)
2136 {
2137 AssertMsgFailed(("Invalid state! Not mounted!\n"));
2138 return VERR_PDM_MEDIA_NOT_MOUNTED;
2139 }
2140
2141 /* Note: There is an unavoidable race between destruction and another
2142 * thread invoking this function. This is handled safely and gracefully by
2143 * atomically invalidating the lock handle in drvvdDestruct. */
2144 int rc2 = RTSemFastMutexRequest(pThis->MergeCompleteMutex);
2145 AssertRC(rc2);
2146 if (RT_SUCCESS(rc2) && pThis->fMergePending)
2147 {
2148 /* Take shortcut: PFNSIMPLEPROGRESS is exactly the same type as
2149 * PFNVDPROGRESS, so there's no need for a conversion function. */
2150 /** @todo maybe introduce a conversion which limits update frequency. */
2151 PVDINTERFACE pVDIfsOperation = NULL;
2152 VDINTERFACEPROGRESS VDIfProgress;
2153 VDIfProgress.pfnProgress = pfnProgress;
2154 rc2 = VDInterfaceAdd(&VDIfProgress.Core, "DrvVD_VDIProgress", VDINTERFACETYPE_PROGRESS,
2155 pvUser, sizeof(VDINTERFACEPROGRESS), &pVDIfsOperation);
2156 AssertRC(rc2);
2157 pThis->fMergePending = false;
2158 rc = VDMerge(pThis->pDisk, pThis->uMergeSource,
2159 pThis->uMergeTarget, pVDIfsOperation);
2160 }
2161 rc2 = RTSemFastMutexRelease(pThis->MergeCompleteMutex);
2162 AssertRC(rc2);
2163 LogFlowFunc(("returns %Rrc\n", rc));
2164 return rc;
2165}
2166
2167/** @interface_method_impl{PDMIMEDIA,pfnSetSecKeyIf} */
2168static DECLCALLBACK(int) drvvdSetSecKeyIf(PPDMIMEDIA pInterface, PPDMISECKEY pIfSecKey, PPDMISECKEYHLP pIfSecKeyHlp)
2169{
2170 LogFlowFunc(("\n"));
2171 PVBOXDISK pThis = PDMIMEDIA_2_VBOXDISK(pInterface);
2172 int rc = VINF_SUCCESS;
2173
2174 if (pThis->pCfgCrypto)
2175 {
2176 PVDINTERFACE pVDIfFilter = NULL;
2177
2178 pThis->pIfSecKeyHlp = pIfSecKeyHlp;
2179
2180 if ( pThis->pIfSecKey
2181 && !pIfSecKey)
2182 {
2183 /* Unload the crypto filter first to make sure it doesn't access the keys anymore. */
2184 rc = VDFilterRemove(pThis->pDisk, VD_FILTER_FLAGS_DEFAULT);
2185 AssertRC(rc);
2186
2187 pThis->pIfSecKey = NULL;
2188 }
2189
2190 if ( pIfSecKey
2191 && RT_SUCCESS(rc))
2192 {
2193 pThis->pIfSecKey = pIfSecKey;
2194
2195 rc = VDInterfaceAdd(&pThis->VDIfCfg.Core, "DrvVD_Config", VDINTERFACETYPE_CONFIG,
2196 pThis->pCfgCrypto, sizeof(VDINTERFACECONFIG), &pVDIfFilter);
2197 AssertRC(rc);
2198
2199 rc = VDInterfaceAdd(&pThis->VDIfCrypto.Core, "DrvVD_Crypto", VDINTERFACETYPE_CRYPTO,
2200 pThis, sizeof(VDINTERFACECRYPTO), &pVDIfFilter);
2201 AssertRC(rc);
2202
2203 /* Load the crypt filter plugin. */
2204 rc = VDFilterAdd(pThis->pDisk, "CRYPT", VD_FILTER_FLAGS_DEFAULT, pVDIfFilter);
2205 if (RT_FAILURE(rc))
2206 pThis->pIfSecKey = NULL;
2207 }
2208 }
2209 else
2210 rc = VERR_NOT_SUPPORTED;
2211
2212 LogFlowFunc(("returns %Rrc\n", rc));
2213 return rc;
2214}
2215
2216/** @interface_method_impl{PDMIMEDIA,pfnGetSize} */
2217static DECLCALLBACK(uint64_t) drvvdGetSize(PPDMIMEDIA pInterface)
2218{
2219 LogFlowFunc(("\n"));
2220 PVBOXDISK pThis = PDMIMEDIA_2_VBOXDISK(pInterface);
2221
2222 /*
2223 * Check the state.
2224 */
2225 if (!pThis->pDisk)
2226 return 0;
2227
2228 uint64_t cb = VDGetSize(pThis->pDisk, VD_LAST_IMAGE);
2229 LogFlowFunc(("returns %#llx (%llu)\n", cb, cb));
2230 return cb;
2231}
2232
2233/** @interface_method_impl{PDMIMEDIA,pfnGetSectorSize} */
2234static DECLCALLBACK(uint32_t) drvvdGetSectorSize(PPDMIMEDIA pInterface)
2235{
2236 LogFlowFunc(("\n"));
2237 PVBOXDISK pThis = PDMIMEDIA_2_VBOXDISK(pInterface);
2238
2239 /*
2240 * Check the state.
2241 */
2242 if (!pThis->pDisk)
2243 return 0;
2244
2245 uint32_t cb = VDGetSectorSize(pThis->pDisk, VD_LAST_IMAGE);
2246 LogFlowFunc(("returns %u\n", cb));
2247 return cb;
2248}
2249
2250/** @interface_method_impl{PDMIMEDIA,pfnIsReadOnly} */
2251static DECLCALLBACK(bool) drvvdIsReadOnly(PPDMIMEDIA pInterface)
2252{
2253 LogFlowFunc(("\n"));
2254 PVBOXDISK pThis = PDMIMEDIA_2_VBOXDISK(pInterface);
2255
2256 /*
2257 * Check the state.
2258 */
2259 if (!pThis->pDisk)
2260 return false;
2261
2262 bool f = VDIsReadOnly(pThis->pDisk);
2263 LogFlowFunc(("returns %d\n", f));
2264 return f;
2265}
2266
2267/** @interface_method_impl{PDMIMEDIA,pfnIsNonRotational} */
2268static DECLCALLBACK(bool) drvvdIsNonRotational(PPDMIMEDIA pInterface)
2269{
2270 LogFlowFunc(("\n"));
2271 PVBOXDISK pThis = PDMIMEDIA_2_VBOXDISK(pInterface);
2272
2273 return pThis->fNonRotational;
2274}
2275
2276/** @interface_method_impl{PDMIMEDIA,pfnBiosGetPCHSGeometry} */
2277static DECLCALLBACK(int) drvvdBiosGetPCHSGeometry(PPDMIMEDIA pInterface,
2278 PPDMMEDIAGEOMETRY pPCHSGeometry)
2279{
2280 LogFlowFunc(("\n"));
2281 PVBOXDISK pThis = PDMIMEDIA_2_VBOXDISK(pInterface);
2282 VDGEOMETRY geo;
2283
2284 /*
2285 * Check the state.
2286 */
2287 if (!pThis->pDisk)
2288 return VERR_PDM_MEDIA_NOT_MOUNTED;
2289
2290 /*
2291 * Use configured/cached values if present.
2292 */
2293 if ( pThis->PCHSGeometry.cCylinders > 0
2294 && pThis->PCHSGeometry.cHeads > 0
2295 && pThis->PCHSGeometry.cSectors > 0)
2296 {
2297 *pPCHSGeometry = pThis->PCHSGeometry;
2298 LogFlow(("%s: returns VINF_SUCCESS {%d,%d,%d}\n", __FUNCTION__, pThis->PCHSGeometry.cCylinders, pThis->PCHSGeometry.cHeads, pThis->PCHSGeometry.cSectors));
2299 return VINF_SUCCESS;
2300 }
2301
2302 int rc = VDGetPCHSGeometry(pThis->pDisk, VD_LAST_IMAGE, &geo);
2303 if (RT_SUCCESS(rc))
2304 {
2305 pPCHSGeometry->cCylinders = geo.cCylinders;
2306 pPCHSGeometry->cHeads = geo.cHeads;
2307 pPCHSGeometry->cSectors = geo.cSectors;
2308 pThis->PCHSGeometry = *pPCHSGeometry;
2309 }
2310 else
2311 {
2312 LogFunc(("geometry not available.\n"));
2313 rc = VERR_PDM_GEOMETRY_NOT_SET;
2314 }
2315 LogFlowFunc(("returns %Rrc (CHS=%d/%d/%d)\n",
2316 rc, pPCHSGeometry->cCylinders, pPCHSGeometry->cHeads, pPCHSGeometry->cSectors));
2317 return rc;
2318}
2319
2320/** @interface_method_impl{PDMIMEDIA,pfnBiosSetPCHSGeometry} */
2321static DECLCALLBACK(int) drvvdBiosSetPCHSGeometry(PPDMIMEDIA pInterface,
2322 PCPDMMEDIAGEOMETRY pPCHSGeometry)
2323{
2324 LogFlowFunc(("CHS=%d/%d/%d\n",
2325 pPCHSGeometry->cCylinders, pPCHSGeometry->cHeads, pPCHSGeometry->cSectors));
2326 PVBOXDISK pThis = PDMIMEDIA_2_VBOXDISK(pInterface);
2327 VDGEOMETRY geo;
2328
2329 /*
2330 * Check the state.
2331 */
2332 if (!pThis->pDisk)
2333 {
2334 AssertMsgFailed(("Invalid state! Not mounted!\n"));
2335 return VERR_PDM_MEDIA_NOT_MOUNTED;
2336 }
2337
2338 geo.cCylinders = pPCHSGeometry->cCylinders;
2339 geo.cHeads = pPCHSGeometry->cHeads;
2340 geo.cSectors = pPCHSGeometry->cSectors;
2341 int rc = VDSetPCHSGeometry(pThis->pDisk, VD_LAST_IMAGE, &geo);
2342 if (rc == VERR_VD_GEOMETRY_NOT_SET)
2343 rc = VERR_PDM_GEOMETRY_NOT_SET;
2344 if (RT_SUCCESS(rc))
2345 pThis->PCHSGeometry = *pPCHSGeometry;
2346 LogFlowFunc(("returns %Rrc\n", rc));
2347 return rc;
2348}
2349
2350/** @interface_method_impl{PDMIMEDIA,pfnBiosGetLCHSGeometry} */
2351static DECLCALLBACK(int) drvvdBiosGetLCHSGeometry(PPDMIMEDIA pInterface,
2352 PPDMMEDIAGEOMETRY pLCHSGeometry)
2353{
2354 LogFlowFunc(("\n"));
2355 PVBOXDISK pThis = PDMIMEDIA_2_VBOXDISK(pInterface);
2356 VDGEOMETRY geo;
2357
2358 /*
2359 * Check the state.
2360 */
2361 if (!pThis->pDisk)
2362 return VERR_PDM_MEDIA_NOT_MOUNTED;
2363
2364 /*
2365 * Use configured/cached values if present.
2366 */
2367 if ( pThis->LCHSGeometry.cCylinders > 0
2368 && pThis->LCHSGeometry.cHeads > 0
2369 && pThis->LCHSGeometry.cSectors > 0)
2370 {
2371 *pLCHSGeometry = pThis->LCHSGeometry;
2372 LogFlow(("%s: returns VINF_SUCCESS {%d,%d,%d}\n", __FUNCTION__, pThis->LCHSGeometry.cCylinders, pThis->LCHSGeometry.cHeads, pThis->LCHSGeometry.cSectors));
2373 return VINF_SUCCESS;
2374 }
2375
2376 int rc = VDGetLCHSGeometry(pThis->pDisk, VD_LAST_IMAGE, &geo);
2377 if (RT_SUCCESS(rc))
2378 {
2379 pLCHSGeometry->cCylinders = geo.cCylinders;
2380 pLCHSGeometry->cHeads = geo.cHeads;
2381 pLCHSGeometry->cSectors = geo.cSectors;
2382 pThis->LCHSGeometry = *pLCHSGeometry;
2383 }
2384 else
2385 {
2386 LogFunc(("geometry not available.\n"));
2387 rc = VERR_PDM_GEOMETRY_NOT_SET;
2388 }
2389 LogFlowFunc(("returns %Rrc (CHS=%d/%d/%d)\n",
2390 rc, pLCHSGeometry->cCylinders, pLCHSGeometry->cHeads, pLCHSGeometry->cSectors));
2391 return rc;
2392}
2393
2394/** @interface_method_impl{PDMIMEDIA,pfnBiosSetLCHSGeometry} */
2395static DECLCALLBACK(int) drvvdBiosSetLCHSGeometry(PPDMIMEDIA pInterface,
2396 PCPDMMEDIAGEOMETRY pLCHSGeometry)
2397{
2398 LogFlowFunc(("CHS=%d/%d/%d\n",
2399 pLCHSGeometry->cCylinders, pLCHSGeometry->cHeads, pLCHSGeometry->cSectors));
2400 PVBOXDISK pThis = PDMIMEDIA_2_VBOXDISK(pInterface);
2401 VDGEOMETRY geo;
2402
2403 /*
2404 * Check the state.
2405 */
2406 if (!pThis->pDisk)
2407 {
2408 AssertMsgFailed(("Invalid state! Not mounted!\n"));
2409 return VERR_PDM_MEDIA_NOT_MOUNTED;
2410 }
2411
2412 geo.cCylinders = pLCHSGeometry->cCylinders;
2413 geo.cHeads = pLCHSGeometry->cHeads;
2414 geo.cSectors = pLCHSGeometry->cSectors;
2415 int rc = VDSetLCHSGeometry(pThis->pDisk, VD_LAST_IMAGE, &geo);
2416 if (rc == VERR_VD_GEOMETRY_NOT_SET)
2417 rc = VERR_PDM_GEOMETRY_NOT_SET;
2418 if (RT_SUCCESS(rc))
2419 pThis->LCHSGeometry = *pLCHSGeometry;
2420 LogFlowFunc(("returns %Rrc\n", rc));
2421 return rc;
2422}
2423
2424/** @interface_method_impl{PDMIMEDIA,pfnBiosIsVisible} */
2425static DECLCALLBACK(bool) drvvdBiosIsVisible(PPDMIMEDIA pInterface)
2426{
2427 PVBOXDISK pThis = PDMIMEDIA_2_VBOXDISK(pInterface);
2428 LogFlow(("drvvdBiosIsVisible: returns %d\n", pThis->fBiosVisible));
2429 return pThis->fBiosVisible;
2430}
2431
2432/** @interface_method_impl{PDMIMEDIA,pfnGetType} */
2433static DECLCALLBACK(PDMMEDIATYPE) drvvdGetType(PPDMIMEDIA pInterface)
2434{
2435 PVBOXDISK pThis = PDMIMEDIA_2_VBOXDISK(pInterface);
2436 LogFlow(("drvvdBiosIsVisible: returns %d\n", pThis->fBiosVisible));
2437 return pThis->enmType;
2438}
2439
2440/** @interface_method_impl{PDMIMEDIA,pfnGetUuid} */
2441static DECLCALLBACK(int) drvvdGetUuid(PPDMIMEDIA pInterface, PRTUUID pUuid)
2442{
2443 LogFlowFunc(("\n"));
2444 PVBOXDISK pThis = PDMIMEDIA_2_VBOXDISK(pInterface);
2445
2446 /*
2447 * Copy the uuid.
2448 */
2449 *pUuid = pThis->Uuid;
2450 LogFlowFunc(("returns {%RTuuid}\n", pUuid));
2451 return VINF_SUCCESS;
2452}
2453
2454/** @interface_method_impl{PDMIMEDIA,pfnDiscard} */
2455static DECLCALLBACK(int) drvvdDiscard(PPDMIMEDIA pInterface, PCRTRANGE paRanges, unsigned cRanges)
2456{
2457 LogFlowFunc(("\n"));
2458 PVBOXDISK pThis = PDMIMEDIA_2_VBOXDISK(pInterface);
2459
2460 STAM_REL_COUNTER_INC(&pThis->StatReqsSubmitted);
2461 STAM_REL_COUNTER_INC(&pThis->StatReqsDiscard);
2462
2463 int rc = VDDiscardRanges(pThis->pDisk, paRanges, cRanges);
2464 if (RT_SUCCESS(rc))
2465 STAM_REL_COUNTER_INC(&pThis->StatReqsSucceeded);
2466 else
2467 STAM_REL_COUNTER_INC(&pThis->StatReqsFailed);
2468
2469 LogFlowFunc(("returns %Rrc\n", rc));
2470 return rc;
2471}
2472
2473/** @interface_method_impl{PDMIMEDIA,pfnGetRegionCount} */
2474static DECLCALLBACK(uint32_t) drvvdGetRegionCount(PPDMIMEDIA pInterface)
2475{
2476 LogFlowFunc(("\n"));
2477 PVBOXDISK pThis = PDMIMEDIA_2_VBOXDISK(pInterface);
2478 uint32_t cRegions = 0;
2479
2480 if (!pThis->pRegionList)
2481 {
2482 int rc = VDQueryRegions(pThis->pDisk, VD_LAST_IMAGE, VD_REGION_LIST_F_LOC_SIZE_BLOCKS,
2483 &pThis->pRegionList);
2484 if (RT_SUCCESS(rc))
2485 cRegions = pThis->pRegionList->cRegions;
2486 }
2487 else
2488 cRegions = pThis->pRegionList->cRegions;
2489
2490 LogFlowFunc(("returns %u\n", cRegions));
2491 return cRegions;
2492}
2493
2494/** @interface_method_impl{PDMIMEDIA,pfnQueryRegionProperties} */
2495static DECLCALLBACK(int) drvvdQueryRegionProperties(PPDMIMEDIA pInterface, uint32_t uRegion, uint64_t *pu64LbaStart,
2496 uint64_t *pcBlocks, uint64_t *pcbBlock,
2497 PVDREGIONDATAFORM penmDataForm)
2498{
2499 LogFlowFunc(("\n"));
2500 int rc = VINF_SUCCESS;
2501 PVBOXDISK pThis = PDMIMEDIA_2_VBOXDISK(pInterface);
2502
2503 if ( pThis->pRegionList
2504 && uRegion < pThis->pRegionList->cRegions)
2505 {
2506 PCVDREGIONDESC pRegion = &pThis->pRegionList->aRegions[uRegion];
2507
2508 if (pu64LbaStart)
2509 *pu64LbaStart = pRegion->offRegion;
2510 if (pcBlocks)
2511 *pcBlocks = pRegion->cRegionBlocksOrBytes;
2512 if (pcbBlock)
2513 *pcbBlock = pRegion->cbBlock;
2514 if (penmDataForm)
2515 *penmDataForm = pRegion->enmDataForm;
2516 }
2517 else
2518 rc = VERR_NOT_FOUND;
2519
2520 LogFlowFunc(("returns %Rrc\n", rc));
2521 return rc;
2522}
2523
2524/** @interface_method_impl{PDMIMEDIA,pfnQueryRegionPropertiesForLba} */
2525static DECLCALLBACK(int) drvvdQueryRegionPropertiesForLba(PPDMIMEDIA pInterface, uint64_t u64LbaStart,
2526 uint64_t *pcBlocks, uint64_t *pcbBlock,
2527 PVDREGIONDATAFORM penmDataForm)
2528{
2529 LogFlowFunc(("\n"));
2530 int rc = VINF_SUCCESS;
2531 PVBOXDISK pThis = PDMIMEDIA_2_VBOXDISK(pInterface);
2532
2533 if (!pThis->pRegionList)
2534 rc = VDQueryRegions(pThis->pDisk, VD_LAST_IMAGE, VD_REGION_LIST_F_LOC_SIZE_BLOCKS,
2535 &pThis->pRegionList);
2536
2537 if (RT_SUCCESS(rc))
2538 {
2539 rc = VERR_NOT_FOUND;
2540
2541 for (uint32_t i = 0; i < pThis->pRegionList->cRegions; i++)
2542 {
2543 PCVDREGIONDESC pRegion = &pThis->pRegionList->aRegions[i];
2544 if ( pRegion->offRegion <= u64LbaStart
2545 && pRegion->offRegion + pRegion->cRegionBlocksOrBytes > u64LbaStart)
2546 {
2547 uint64_t offRegion = u64LbaStart - pRegion->offRegion;
2548
2549 if (pcBlocks)
2550 *pcBlocks = pRegion->cRegionBlocksOrBytes - offRegion;
2551 if (pcbBlock)
2552 *pcbBlock = pRegion->cbBlock;
2553 if (penmDataForm)
2554 *penmDataForm = pRegion->enmDataForm;
2555
2556 rc = VINF_SUCCESS;
2557 }
2558 }
2559 }
2560 else
2561 rc = VERR_NOT_FOUND;
2562
2563 LogFlowFunc(("returns %Rrc\n", rc));
2564 return rc;
2565}
2566
2567/* -=-=-=-=- IMount -=-=-=-=- */
2568
2569/** @interface_method_impl{PDMIMOUNT,pfnUnmount} */
2570static DECLCALLBACK(int) drvvdUnmount(PPDMIMOUNT pInterface, bool fForce, bool fEject)
2571{
2572 RT_NOREF(fEject);
2573 PVBOXDISK pThis = RT_FROM_MEMBER(pInterface, VBOXDISK, IMount);
2574
2575 /*
2576 * Validate state.
2577 */
2578 if (!pThis->pDisk)
2579 {
2580 Log(("drvvdUnmount: Not mounted\n"));
2581 return VERR_PDM_MEDIA_NOT_MOUNTED;
2582 }
2583 if (pThis->fLocked && !fForce)
2584 {
2585 Log(("drvvdUnmount: Locked\n"));
2586 return VERR_PDM_MEDIA_LOCKED;
2587 }
2588
2589 /* Media is no longer locked even if it was previously. */
2590 pThis->fLocked = false;
2591 drvvdPowerOffOrDestructOrUnmount(pThis->pDrvIns);
2592
2593 /*
2594 * Notify driver/device above us.
2595 */
2596 if (pThis->pDrvMountNotify)
2597 pThis->pDrvMountNotify->pfnUnmountNotify(pThis->pDrvMountNotify);
2598 Log(("drvblockUnmount: success\n"));
2599 return VINF_SUCCESS;
2600}
2601
2602
2603/** @interface_method_impl{PDMIMOUNT,pfnIsMounted} */
2604static DECLCALLBACK(bool) drvvdIsMounted(PPDMIMOUNT pInterface)
2605{
2606 PVBOXDISK pThis = RT_FROM_MEMBER(pInterface, VBOXDISK, IMount);
2607 return pThis->pDisk != NULL;
2608}
2609
2610/** @interface_method_impl{PDMIMOUNT,pfnLock} */
2611static DECLCALLBACK(int) drvvdLock(PPDMIMOUNT pInterface)
2612{
2613 PVBOXDISK pThis = RT_FROM_MEMBER(pInterface, VBOXDISK, IMount);
2614 Log(("drvblockLock: %d -> %d\n", pThis->fLocked, true));
2615 pThis->fLocked = true;
2616 return VINF_SUCCESS;
2617}
2618
2619/** @interface_method_impl{PDMIMOUNT,pfnUnlock} */
2620static DECLCALLBACK(int) drvvdUnlock(PPDMIMOUNT pInterface)
2621{
2622 PVBOXDISK pThis = RT_FROM_MEMBER(pInterface, VBOXDISK, IMount);
2623 Log(("drvblockUnlock: %d -> %d\n", pThis->fLocked, false));
2624 pThis->fLocked = false;
2625 return VINF_SUCCESS;
2626}
2627
2628/** @interface_method_impl{PDMIMOUNT,pfnIsLocked} */
2629static DECLCALLBACK(bool) drvvdIsLocked(PPDMIMOUNT pInterface)
2630{
2631 PVBOXDISK pThis = RT_FROM_MEMBER(pInterface, VBOXDISK, IMount);
2632 return pThis->fLocked;
2633}
2634
2635
2636static DECLCALLBACK(void) drvvdBlkCacheReqComplete(void *pvUser1, void *pvUser2, int rcReq)
2637{
2638 PVBOXDISK pThis = (PVBOXDISK)pvUser1;
2639
2640 AssertPtr(pThis->pBlkCache);
2641 PDMR3BlkCacheIoXferComplete(pThis->pBlkCache, (PPDMBLKCACHEIOXFER)pvUser2, rcReq);
2642}
2643
2644
2645/** @copydoc FNPDMBLKCACHEXFERCOMPLETEDRV */
2646static DECLCALLBACK(void) drvvdBlkCacheXferCompleteIoReq(PPDMDRVINS pDrvIns, void *pvUser, int rc)
2647{
2648 PVBOXDISK pThis = PDMINS_2_DATA(pDrvIns, PVBOXDISK);
2649
2650 drvvdMediaExIoReqCompleteWorker(pThis, (PPDMMEDIAEXIOREQINT)pvUser, rc, true /* fUpNotify */);
2651}
2652
2653/** @copydoc FNPDMBLKCACHEXFERENQUEUEDRV */
2654static DECLCALLBACK(int) drvvdBlkCacheXferEnqueue(PPDMDRVINS pDrvIns,
2655 PDMBLKCACHEXFERDIR enmXferDir,
2656 uint64_t off, size_t cbXfer,
2657 PCRTSGBUF pSgBuf, PPDMBLKCACHEIOXFER hIoXfer)
2658{
2659 int rc = VINF_SUCCESS;
2660 PVBOXDISK pThis = PDMINS_2_DATA(pDrvIns, PVBOXDISK);
2661
2662 Assert (!pThis->pCfgCrypto);
2663
2664 switch (enmXferDir)
2665 {
2666 case PDMBLKCACHEXFERDIR_READ:
2667 rc = VDAsyncRead(pThis->pDisk, off, cbXfer, pSgBuf, drvvdBlkCacheReqComplete,
2668 pThis, hIoXfer);
2669 break;
2670 case PDMBLKCACHEXFERDIR_WRITE:
2671 rc = VDAsyncWrite(pThis->pDisk, off, cbXfer, pSgBuf, drvvdBlkCacheReqComplete,
2672 pThis, hIoXfer);
2673 break;
2674 case PDMBLKCACHEXFERDIR_FLUSH:
2675 rc = VDAsyncFlush(pThis->pDisk, drvvdBlkCacheReqComplete, pThis, hIoXfer);
2676 break;
2677 default:
2678 AssertMsgFailed(("Invalid transfer type %d\n", enmXferDir));
2679 rc = VERR_INVALID_PARAMETER;
2680 }
2681
2682 if (rc == VINF_VD_ASYNC_IO_FINISHED)
2683 PDMR3BlkCacheIoXferComplete(pThis->pBlkCache, hIoXfer, VINF_SUCCESS);
2684 else if (RT_FAILURE(rc) && rc != VERR_VD_ASYNC_IO_IN_PROGRESS)
2685 PDMR3BlkCacheIoXferComplete(pThis->pBlkCache, hIoXfer, rc);
2686
2687 return VINF_SUCCESS;
2688}
2689
2690/** @copydoc FNPDMBLKCACHEXFERENQUEUEDISCARDDRV */
2691static DECLCALLBACK(int) drvvdBlkCacheXferEnqueueDiscard(PPDMDRVINS pDrvIns, PCRTRANGE paRanges,
2692 unsigned cRanges, PPDMBLKCACHEIOXFER hIoXfer)
2693{
2694 int rc = VINF_SUCCESS;
2695 PVBOXDISK pThis = PDMINS_2_DATA(pDrvIns, PVBOXDISK);
2696
2697 rc = VDAsyncDiscardRanges(pThis->pDisk, paRanges, cRanges,
2698 drvvdBlkCacheReqComplete, pThis, hIoXfer);
2699
2700 if (rc == VINF_VD_ASYNC_IO_FINISHED)
2701 PDMR3BlkCacheIoXferComplete(pThis->pBlkCache, hIoXfer, VINF_SUCCESS);
2702 else if (RT_FAILURE(rc) && rc != VERR_VD_ASYNC_IO_IN_PROGRESS)
2703 PDMR3BlkCacheIoXferComplete(pThis->pBlkCache, hIoXfer, rc);
2704
2705 return VINF_SUCCESS;
2706}
2707
2708
2709/*********************************************************************************************************************************
2710* Extended media interface methods *
2711*********************************************************************************************************************************/
2712
2713static void drvvdMediaExIoReqWarningDiskFull(PPDMDRVINS pDrvIns)
2714{
2715 int rc;
2716 LogRel(("VD#%u: Host disk full\n", pDrvIns->iInstance));
2717 rc = PDMDrvHlpVMSetRuntimeError(pDrvIns, VMSETRTERR_FLAGS_SUSPEND | VMSETRTERR_FLAGS_NO_WAIT, "DrvVD_DISKFULL",
2718 N_("Host system reported disk full. VM execution is suspended. You can resume after freeing some space"));
2719 AssertRC(rc);
2720}
2721
2722static void drvvdMediaExIoReqWarningFileTooBig(PPDMDRVINS pDrvIns)
2723{
2724 int rc;
2725 LogRel(("VD#%u: File too big\n", pDrvIns->iInstance));
2726 rc = PDMDrvHlpVMSetRuntimeError(pDrvIns, VMSETRTERR_FLAGS_SUSPEND | VMSETRTERR_FLAGS_NO_WAIT, "DrvVD_FILETOOBIG",
2727 N_("Host system reported that the file size limit of the host file system has been exceeded. VM execution is suspended. You need to move your virtual hard disk to a filesystem which allows bigger files"));
2728 AssertRC(rc);
2729}
2730
2731static void drvvdMediaExIoReqWarningISCSI(PPDMDRVINS pDrvIns)
2732{
2733 int rc;
2734 LogRel(("VD#%u: iSCSI target unavailable\n", pDrvIns->iInstance));
2735 rc = PDMDrvHlpVMSetRuntimeError(pDrvIns, VMSETRTERR_FLAGS_SUSPEND | VMSETRTERR_FLAGS_NO_WAIT, "DrvVD_ISCSIDOWN",
2736 N_("The iSCSI target has stopped responding. VM execution is suspended. You can resume when it is available again"));
2737 AssertRC(rc);
2738}
2739
2740static void drvvdMediaExIoReqWarningDekMissing(PPDMDRVINS pDrvIns)
2741{
2742 LogRel(("VD#%u: DEK is missing\n", pDrvIns->iInstance));
2743 int rc = PDMDrvHlpVMSetRuntimeError(pDrvIns, VMSETRTERR_FLAGS_SUSPEND | VMSETRTERR_FLAGS_NO_WAIT, "DrvVD_DEKMISSING",
2744 N_("VD: The DEK for this disk is missing"));
2745 AssertRC(rc);
2746}
2747
2748/**
2749 * Checks whether a given status code indicates a recoverable error
2750 * suspending the VM if it is.
2751 *
2752 * @returns Flag indicating whether the status code is a recoverable error
2753 * (full disk, broken network connection).
2754 * @param pThis VBox disk container instance data.
2755 * @param rc Status code to check.
2756 */
2757bool drvvdMediaExIoReqIsRedoSetWarning(PVBOXDISK pThis, int rc)
2758{
2759 if (rc == VERR_DISK_FULL)
2760 {
2761 if (ASMAtomicCmpXchgBool(&pThis->fRedo, true, false))
2762 drvvdMediaExIoReqWarningDiskFull(pThis->pDrvIns);
2763 return true;
2764 }
2765 if (rc == VERR_FILE_TOO_BIG)
2766 {
2767 if (ASMAtomicCmpXchgBool(&pThis->fRedo, true, false))
2768 drvvdMediaExIoReqWarningFileTooBig(pThis->pDrvIns);
2769 return true;
2770 }
2771 if (rc == VERR_BROKEN_PIPE || rc == VERR_NET_CONNECTION_REFUSED)
2772 {
2773 /* iSCSI connection abort (first error) or failure to reestablish
2774 * connection (second error). Pause VM. On resume we'll retry. */
2775 if (ASMAtomicCmpXchgBool(&pThis->fRedo, true, false))
2776 drvvdMediaExIoReqWarningISCSI(pThis->pDrvIns);
2777 return true;
2778 }
2779 if (rc == VERR_VD_DEK_MISSING)
2780 {
2781 /* Error message already set. */
2782 if (ASMAtomicCmpXchgBool(&pThis->fRedo, true, false))
2783 drvvdMediaExIoReqWarningDekMissing(pThis->pDrvIns);
2784 return true;
2785 }
2786
2787 return false;
2788}
2789
2790/**
2791 * Syncs the memory buffers between the I/O request allocator and the internal buffer.
2792 *
2793 * @returns VBox status code.
2794 * @param pThis VBox disk container instance data.
2795 * @param pIoReq I/O request to sync.
2796 * @param fToIoBuf Flag indicating the sync direction.
2797 * true to copy data from the allocators buffer to our internal buffer.
2798 * false for the other direction.
2799 */
2800DECLINLINE(int) drvvdMediaExIoReqBufSync(PVBOXDISK pThis, PPDMMEDIAEXIOREQINT pIoReq, bool fToIoBuf)
2801{
2802 int rc = VINF_SUCCESS;
2803
2804 Assert(pIoReq->enmType == PDMMEDIAEXIOREQTYPE_READ || pIoReq->enmType == PDMMEDIAEXIOREQTYPE_WRITE);
2805 Assert(pIoReq->ReadWrite.cbIoBuf > 0);
2806
2807 if (!pIoReq->ReadWrite.fDirectBuf)
2808 {
2809 /* Make sure the buffer is reset. */
2810 RTSgBufReset(&pIoReq->ReadWrite.IoBuf.SgBuf);
2811
2812 size_t const offSrc = pIoReq->ReadWrite.cbReq - pIoReq->ReadWrite.cbReqLeft;
2813 Assert((uint32_t)offSrc == offSrc);
2814 if (fToIoBuf)
2815 rc = pThis->pDrvMediaExPort->pfnIoReqCopyToBuf(pThis->pDrvMediaExPort, pIoReq, &pIoReq->abAlloc[0], (uint32_t)offSrc,
2816 &pIoReq->ReadWrite.IoBuf.SgBuf,
2817 RT_MIN(pIoReq->ReadWrite.cbIoBuf, pIoReq->ReadWrite.cbReqLeft));
2818 else
2819 rc = pThis->pDrvMediaExPort->pfnIoReqCopyFromBuf(pThis->pDrvMediaExPort, pIoReq, &pIoReq->abAlloc[0], (uint32_t)offSrc,
2820 &pIoReq->ReadWrite.IoBuf.SgBuf,
2821 (uint32_t)RT_MIN(pIoReq->ReadWrite.cbIoBuf, pIoReq->ReadWrite.cbReqLeft));
2822
2823 RTSgBufReset(&pIoReq->ReadWrite.IoBuf.SgBuf);
2824 }
2825 return rc;
2826}
2827
2828/**
2829 * Hashes the I/O request ID to an index for the allocated I/O request bin.
2830 */
2831DECLINLINE(unsigned) drvvdMediaExIoReqIdHash(PDMMEDIAEXIOREQID uIoReqId)
2832{
2833 return uIoReqId % DRVVD_VDIOREQ_ALLOC_BINS; /** @todo Find something better? */
2834}
2835
2836/**
2837 * Inserts the given I/O request in to the list of allocated I/O requests.
2838 *
2839 * @returns VBox status code.
2840 * @param pThis VBox disk container instance data.
2841 * @param pIoReq I/O request to insert.
2842 */
2843static int drvvdMediaExIoReqInsert(PVBOXDISK pThis, PPDMMEDIAEXIOREQINT pIoReq)
2844{
2845 int rc = VINF_SUCCESS;
2846 unsigned idxBin = drvvdMediaExIoReqIdHash(pIoReq->uIoReqId);
2847
2848 rc = RTSemFastMutexRequest(pThis->aIoReqAllocBins[idxBin].hMtxLstIoReqAlloc);
2849 if (RT_SUCCESS(rc))
2850 {
2851 /* Search for conflicting I/O request ID. */
2852 PPDMMEDIAEXIOREQINT pIt;
2853 RTListForEach(&pThis->aIoReqAllocBins[idxBin].LstIoReqAlloc, pIt, PDMMEDIAEXIOREQINT, NdAllocatedList)
2854 {
2855 if (RT_UNLIKELY( pIt->uIoReqId == pIoReq->uIoReqId
2856 && pIt->enmState != VDIOREQSTATE_CANCELED))
2857 {
2858 rc = VERR_PDM_MEDIAEX_IOREQID_CONFLICT;
2859 break;
2860 }
2861 }
2862 if (RT_SUCCESS(rc))
2863 RTListAppend(&pThis->aIoReqAllocBins[idxBin].LstIoReqAlloc, &pIoReq->NdAllocatedList);
2864 RTSemFastMutexRelease(pThis->aIoReqAllocBins[idxBin].hMtxLstIoReqAlloc);
2865 }
2866
2867 return rc;
2868}
2869
2870/**
2871 * Removes the given I/O request from the list of allocated I/O requests.
2872 *
2873 * @returns VBox status code.
2874 * @param pThis VBox disk container instance data.
2875 * @param pIoReq I/O request to insert.
2876 */
2877static int drvvdMediaExIoReqRemove(PVBOXDISK pThis, PPDMMEDIAEXIOREQINT pIoReq)
2878{
2879 int rc = VINF_SUCCESS;
2880 unsigned idxBin = drvvdMediaExIoReqIdHash(pIoReq->uIoReqId);
2881
2882 rc = RTSemFastMutexRequest(pThis->aIoReqAllocBins[idxBin].hMtxLstIoReqAlloc);
2883 if (RT_SUCCESS(rc))
2884 {
2885 RTListNodeRemove(&pIoReq->NdAllocatedList);
2886 RTSemFastMutexRelease(pThis->aIoReqAllocBins[idxBin].hMtxLstIoReqAlloc);
2887 }
2888
2889 return rc;
2890}
2891
2892/**
2893 * Retires a given I/O request marking it as complete and notiyfing the
2894 * device/driver above about the completion if requested.
2895 *
2896 * @returns VBox status code.
2897 * @param pThis VBox disk container instance data.
2898 * @param pIoReq I/O request to complete.
2899 * @param rcReq The status code the request completed with.
2900 * @param fUpNotify Flag whether to notify the driver/device above us about the completion.
2901 */
2902static void drvvdMediaExIoReqRetire(PVBOXDISK pThis, PPDMMEDIAEXIOREQINT pIoReq, int rcReq, bool fUpNotify)
2903{
2904 LogFlowFunc(("pThis=%#p pIoReq=%#p rcReq=%Rrc fUpNotify=%RTbool\n",
2905 pThis, pIoReq, rcReq, fUpNotify));
2906
2907 bool fXchg = ASMAtomicCmpXchgU32((volatile uint32_t *)&pIoReq->enmState, VDIOREQSTATE_COMPLETING, VDIOREQSTATE_ACTIVE);
2908 if (fXchg)
2909 ASMAtomicDecU32(&pThis->cIoReqsActive);
2910 else
2911 {
2912 Assert(pIoReq->enmState == VDIOREQSTATE_CANCELED);
2913 rcReq = VERR_PDM_MEDIAEX_IOREQ_CANCELED;
2914 }
2915
2916 ASMAtomicXchgU32((volatile uint32_t *)&pIoReq->enmState, VDIOREQSTATE_COMPLETED);
2917 drvvdMediaExIoReqBufFree(pThis, pIoReq);
2918
2919 /*
2920 * Leave a release log entry if the request was active for more than 25 seconds
2921 * (30 seconds is the timeout of the guest).
2922 */
2923 uint64_t tsNow = RTTimeMilliTS();
2924 if (tsNow - pIoReq->tsSubmit >= 25 * 1000)
2925 {
2926 const char *pcszReq = NULL;
2927
2928 switch (pIoReq->enmType)
2929 {
2930 case PDMMEDIAEXIOREQTYPE_READ:
2931 pcszReq = "Read";
2932 break;
2933 case PDMMEDIAEXIOREQTYPE_WRITE:
2934 pcszReq = "Write";
2935 break;
2936 case PDMMEDIAEXIOREQTYPE_FLUSH:
2937 pcszReq = "Flush";
2938 break;
2939 case PDMMEDIAEXIOREQTYPE_DISCARD:
2940 pcszReq = "Discard";
2941 break;
2942 default:
2943 pcszReq = "<Invalid>";
2944 }
2945
2946 LogRel(("VD#%u: %s request was active for %llu seconds\n",
2947 pThis->pDrvIns->iInstance, pcszReq, (tsNow - pIoReq->tsSubmit) / 1000));
2948 }
2949
2950 if (RT_FAILURE(rcReq))
2951 {
2952 /* Log the error. */
2953 if (pThis->cErrors++ < DRVVD_MAX_LOG_REL_ERRORS)
2954 {
2955 if (rcReq == VERR_PDM_MEDIAEX_IOREQ_CANCELED)
2956 {
2957 if (pIoReq->enmType == PDMMEDIAEXIOREQTYPE_FLUSH)
2958 LogRel(("VD#%u: Aborted flush returned rc=%Rrc\n",
2959 pThis->pDrvIns->iInstance, rcReq));
2960 else if (pIoReq->enmType == PDMMEDIAEXIOREQTYPE_DISCARD)
2961 LogRel(("VD#%u: Aborted discard returned rc=%Rrc\n",
2962 pThis->pDrvIns->iInstance, rcReq));
2963 else
2964 LogRel(("VD#%u: Aborted %s (%u bytes left) returned rc=%Rrc\n",
2965 pThis->pDrvIns->iInstance,
2966 pIoReq->enmType == PDMMEDIAEXIOREQTYPE_READ
2967 ? "read"
2968 : "write",
2969 pIoReq->ReadWrite.cbReqLeft, rcReq));
2970 }
2971 else
2972 {
2973 if (pIoReq->enmType == PDMMEDIAEXIOREQTYPE_FLUSH)
2974 LogRel(("VD#%u: Flush returned rc=%Rrc\n",
2975 pThis->pDrvIns->iInstance, rcReq));
2976 else if (pIoReq->enmType == PDMMEDIAEXIOREQTYPE_DISCARD)
2977 LogRel(("VD#%u: Discard returned rc=%Rrc\n",
2978 pThis->pDrvIns->iInstance, rcReq));
2979 else
2980 LogRel(("VD#%u: %s (%u bytes left) returned rc=%Rrc\n",
2981 pThis->pDrvIns->iInstance,
2982 pIoReq->enmType == PDMMEDIAEXIOREQTYPE_READ
2983 ? "Read"
2984 : "Write",
2985 pIoReq->ReadWrite.cbReqLeft, rcReq));
2986 }
2987 }
2988
2989 STAM_REL_COUNTER_INC(&pThis->StatReqsFailed);
2990 }
2991 else
2992 {
2993 STAM_REL_COUNTER_INC(&pThis->StatReqsSucceeded);
2994
2995 switch (pIoReq->enmType)
2996 {
2997 case PDMMEDIAEXIOREQTYPE_READ:
2998 STAM_REL_COUNTER_ADD(&pThis->StatBytesRead, pIoReq->ReadWrite.cbReq);
2999 break;
3000 case PDMMEDIAEXIOREQTYPE_WRITE:
3001 STAM_REL_COUNTER_ADD(&pThis->StatBytesWritten, pIoReq->ReadWrite.cbReq);
3002 break;
3003 default:
3004 break;
3005 }
3006 }
3007
3008 if (fUpNotify)
3009 {
3010 int rc = pThis->pDrvMediaExPort->pfnIoReqCompleteNotify(pThis->pDrvMediaExPort,
3011 pIoReq, &pIoReq->abAlloc[0], rcReq);
3012 AssertRC(rc);
3013 }
3014
3015 LogFlowFunc(("returns\n"));
3016}
3017
3018/**
3019 * I/O request completion worker.
3020 *
3021 * @returns VBox status code.
3022 * @param pThis VBox disk container instance data.
3023 * @param pIoReq I/O request to complete.
3024 * @param rcReq The status code the request completed with.
3025 * @param fUpNotify Flag whether to notify the driver/device above us about the completion.
3026 */
3027static int drvvdMediaExIoReqCompleteWorker(PVBOXDISK pThis, PPDMMEDIAEXIOREQINT pIoReq, int rcReq, bool fUpNotify)
3028{
3029 LogFlowFunc(("pThis=%#p pIoReq=%#p rcReq=%Rrc fUpNotify=%RTbool\n",
3030 pThis, pIoReq, rcReq, fUpNotify));
3031
3032 /*
3033 * For a read we need to sync the memory before continuing to process
3034 * the request further.
3035 */
3036 if ( RT_SUCCESS(rcReq)
3037 && pIoReq->enmType == PDMMEDIAEXIOREQTYPE_READ)
3038 rcReq = drvvdMediaExIoReqBufSync(pThis, pIoReq, false /* fToIoBuf */);
3039
3040 /*
3041 * When the request owner instructs us to handle recoverable errors like full disks
3042 * do it. Mark the request as suspended, notify the owner and put the request on the
3043 * redo list.
3044 */
3045 if ( RT_FAILURE(rcReq)
3046 && (pIoReq->fFlags & PDMIMEDIAEX_F_SUSPEND_ON_RECOVERABLE_ERR)
3047 && drvvdMediaExIoReqIsRedoSetWarning(pThis, rcReq))
3048 {
3049 bool fXchg = ASMAtomicCmpXchgU32((volatile uint32_t *)&pIoReq->enmState, VDIOREQSTATE_SUSPENDED, VDIOREQSTATE_ACTIVE);
3050 if (fXchg)
3051 {
3052 /* Put on redo list and adjust active request counter. */
3053 RTCritSectEnter(&pThis->CritSectIoReqRedo);
3054 RTListAppend(&pThis->LstIoReqRedo, &pIoReq->NdLstWait);
3055 RTCritSectLeave(&pThis->CritSectIoReqRedo);
3056 ASMAtomicDecU32(&pThis->cIoReqsActive);
3057 pThis->pDrvMediaExPort->pfnIoReqStateChanged(pThis->pDrvMediaExPort, pIoReq, &pIoReq->abAlloc[0],
3058 PDMMEDIAEXIOREQSTATE_SUSPENDED);
3059 rcReq = VINF_PDM_MEDIAEX_IOREQ_IN_PROGRESS;
3060 }
3061 else
3062 {
3063 /* Request was canceled inbetween, so don't care and notify the owner about the completed request. */
3064 Assert(pIoReq->enmState == VDIOREQSTATE_CANCELED);
3065 drvvdMediaExIoReqRetire(pThis, pIoReq, rcReq, fUpNotify);
3066 }
3067 }
3068 else
3069 {
3070 if ( pIoReq->enmType == PDMMEDIAEXIOREQTYPE_READ
3071 || pIoReq->enmType == PDMMEDIAEXIOREQTYPE_WRITE)
3072 {
3073 /* Adjust the remaining amount to transfer. */
3074 Assert(pIoReq->ReadWrite.cbIoBuf > 0);
3075
3076 size_t cbReqIo = RT_MIN(pIoReq->ReadWrite.cbReqLeft, pIoReq->ReadWrite.cbIoBuf);
3077 pIoReq->ReadWrite.offStart += cbReqIo;
3078 pIoReq->ReadWrite.cbReqLeft -= cbReqIo;
3079 }
3080
3081 if ( RT_FAILURE(rcReq)
3082 || !pIoReq->ReadWrite.cbReqLeft
3083 || ( pIoReq->enmType != PDMMEDIAEXIOREQTYPE_READ
3084 && pIoReq->enmType != PDMMEDIAEXIOREQTYPE_WRITE))
3085 drvvdMediaExIoReqRetire(pThis, pIoReq, rcReq, fUpNotify);
3086 else
3087 drvvdMediaExIoReqReadWriteProcess(pThis, pIoReq, fUpNotify);
3088 }
3089
3090 LogFlowFunc(("returns %Rrc\n", rcReq));
3091 return rcReq;
3092}
3093
3094
3095/**
3096 * Allocates a memory buffer suitable for I/O for the given request.
3097 *
3098 * @returns VBox status code.
3099 * @retval VINF_PDM_MEDIAEX_IOREQ_IN_PROGRESS if there is no I/O memory available to allocate and
3100 * the request was placed on a waiting list.
3101 * @param pThis VBox disk container instance data.
3102 * @param pIoReq I/O request to allocate memory for.
3103 * @param cb Size of the buffer.
3104 */
3105DECLINLINE(int) drvvdMediaExIoReqBufAlloc(PVBOXDISK pThis, PPDMMEDIAEXIOREQINT pIoReq, size_t cb)
3106{
3107 int rc = VERR_NOT_SUPPORTED;
3108 LogFlowFunc(("pThis=%#p pIoReq=%#p cb=%zu\n", pThis, pIoReq, cb));
3109
3110 if ( cb == _4K
3111 && pThis->pDrvMediaExPort->pfnIoReqQueryBuf)
3112 {
3113 /* Try to get a direct pointer to the buffer first. */
3114 void *pvBuf = NULL;
3115 size_t cbBuf = 0;
3116
3117 STAM_COUNTER_INC(&pThis->StatQueryBufAttempts);
3118 rc = pThis->pDrvMediaExPort->pfnIoReqQueryBuf(pThis->pDrvMediaExPort, pIoReq, &pIoReq->abAlloc[0],
3119 &pvBuf, &cbBuf);
3120 if (RT_SUCCESS(rc))
3121 {
3122 STAM_COUNTER_INC(&pThis->StatQueryBufSuccess);
3123 pIoReq->ReadWrite.cbIoBuf = cbBuf;
3124 pIoReq->ReadWrite.fDirectBuf = true;
3125 pIoReq->ReadWrite.Direct.Seg.pvSeg = pvBuf;
3126 pIoReq->ReadWrite.Direct.Seg.cbSeg = cbBuf;
3127 RTSgBufInit(&pIoReq->ReadWrite.Direct.SgBuf, &pIoReq->ReadWrite.Direct.Seg, 1);
3128 pIoReq->ReadWrite.pSgBuf = &pIoReq->ReadWrite.Direct.SgBuf;
3129 }
3130 }
3131
3132 if (RT_FAILURE(rc))
3133 {
3134 rc = IOBUFMgrAllocBuf(pThis->hIoBufMgr, &pIoReq->ReadWrite.IoBuf, cb, &pIoReq->ReadWrite.cbIoBuf);
3135 if (rc == VERR_NO_MEMORY)
3136 {
3137 LogFlowFunc(("Could not allocate memory for request, deferring\n"));
3138 RTCritSectEnter(&pThis->CritSectIoReqsIoBufWait);
3139 RTListAppend(&pThis->LstIoReqIoBufWait, &pIoReq->NdLstWait);
3140 RTCritSectLeave(&pThis->CritSectIoReqsIoBufWait);
3141 ASMAtomicIncU32(&pThis->cIoReqsWaiting);
3142 rc = VINF_PDM_MEDIAEX_IOREQ_IN_PROGRESS;
3143 }
3144 else
3145 {
3146 LogFlowFunc(("Allocated %zu bytes of memory\n", pIoReq->ReadWrite.cbIoBuf));
3147 Assert(pIoReq->ReadWrite.cbIoBuf > 0);
3148 pIoReq->ReadWrite.fDirectBuf = false;
3149 pIoReq->ReadWrite.pSgBuf = &pIoReq->ReadWrite.IoBuf.SgBuf;
3150 }
3151 }
3152
3153 LogFlowFunc(("returns %Rrc\n", rc));
3154 return rc;
3155}
3156
3157/**
3158 * Wrapper around the various ways to read from the underlying medium (cache, async vs. sync).
3159 *
3160 * @returns VBox status code.
3161 * @param pThis VBox disk container instance data.
3162 * @param pIoReq I/O request to process.
3163 * @param cbReqIo Transfer size.
3164 * @param pcbReqIo Where to store the amount of transferred data.
3165 */
3166static int drvvdMediaExIoReqReadWrapper(PVBOXDISK pThis, PPDMMEDIAEXIOREQINT pIoReq, size_t cbReqIo, size_t *pcbReqIo)
3167{
3168 int rc = VINF_SUCCESS;
3169
3170 LogFlowFunc(("pThis=%#p pIoReq=%#p cbReqIo=%zu pcbReqIo=%#p\n", pThis, pIoReq, cbReqIo, pcbReqIo));
3171
3172 Assert(cbReqIo > 0);
3173
3174 if ( pThis->fAsyncIOSupported
3175 && !(pIoReq->fFlags & PDMIMEDIAEX_F_SYNC))
3176 {
3177 if (pThis->pBlkCache)
3178 {
3179 rc = PDMR3BlkCacheRead(pThis->pBlkCache, pIoReq->ReadWrite.offStart,
3180 pIoReq->ReadWrite.pSgBuf, cbReqIo, pIoReq);
3181 if (rc == VINF_SUCCESS)
3182 rc = VINF_VD_ASYNC_IO_FINISHED;
3183 else if (rc == VINF_AIO_TASK_PENDING)
3184 rc = VERR_VD_ASYNC_IO_IN_PROGRESS;
3185 }
3186 else
3187 rc = VDAsyncRead(pThis->pDisk, pIoReq->ReadWrite.offStart, cbReqIo, pIoReq->ReadWrite.pSgBuf,
3188 drvvdMediaExIoReqComplete, pThis, pIoReq);
3189 }
3190 else
3191 {
3192 void *pvBuf = RTSgBufGetNextSegment(pIoReq->ReadWrite.pSgBuf, &cbReqIo);
3193
3194 Assert(cbReqIo > 0 && VALID_PTR(pvBuf));
3195 rc = VDRead(pThis->pDisk, pIoReq->ReadWrite.offStart, pvBuf, cbReqIo);
3196 if (RT_SUCCESS(rc))
3197 rc = VINF_VD_ASYNC_IO_FINISHED;
3198 }
3199
3200 *pcbReqIo = cbReqIo;
3201
3202 LogFlowFunc(("returns %Rrc *pcbReqIo=%zu\n", rc, *pcbReqIo));
3203 return rc;
3204}
3205
3206/**
3207 * Wrapper around the various ways to write to the underlying medium (cache, async vs. sync).
3208 *
3209 * @returns VBox status code.
3210 * @param pThis VBox disk container instance data.
3211 * @param pIoReq I/O request to process.
3212 * @param cbReqIo Transfer size.
3213 * @param pcbReqIo Where to store the amount of transferred data.
3214 */
3215static int drvvdMediaExIoReqWriteWrapper(PVBOXDISK pThis, PPDMMEDIAEXIOREQINT pIoReq, size_t cbReqIo, size_t *pcbReqIo)
3216{
3217 int rc = VINF_SUCCESS;
3218
3219 Assert(cbReqIo > 0);
3220
3221 LogFlowFunc(("pThis=%#p pIoReq=%#p cbReqIo=%zu pcbReqIo=%#p\n", pThis, pIoReq, cbReqIo, pcbReqIo));
3222
3223 if ( pThis->fAsyncIOSupported
3224 && !(pIoReq->fFlags & PDMIMEDIAEX_F_SYNC))
3225 {
3226 if (pThis->pBlkCache)
3227 {
3228 rc = PDMR3BlkCacheWrite(pThis->pBlkCache, pIoReq->ReadWrite.offStart,
3229 pIoReq->ReadWrite.pSgBuf, cbReqIo, pIoReq);
3230 if (rc == VINF_SUCCESS)
3231 rc = VINF_VD_ASYNC_IO_FINISHED;
3232 else if (rc == VINF_AIO_TASK_PENDING)
3233 rc = VERR_VD_ASYNC_IO_IN_PROGRESS;
3234 }
3235 else
3236 rc = VDAsyncWrite(pThis->pDisk, pIoReq->ReadWrite.offStart, cbReqIo, pIoReq->ReadWrite.pSgBuf,
3237 drvvdMediaExIoReqComplete, pThis, pIoReq);
3238 }
3239 else
3240 {
3241 void *pvBuf = RTSgBufGetNextSegment(pIoReq->ReadWrite.pSgBuf, &cbReqIo);
3242
3243 Assert(cbReqIo > 0 && VALID_PTR(pvBuf));
3244 rc = VDWrite(pThis->pDisk, pIoReq->ReadWrite.offStart, pvBuf, cbReqIo);
3245 if (RT_SUCCESS(rc))
3246 rc = VINF_VD_ASYNC_IO_FINISHED;
3247 }
3248
3249 *pcbReqIo = cbReqIo;
3250
3251 LogFlowFunc(("returns %Rrc *pcbReqIo=%zu\n", rc, *pcbReqIo));
3252 return rc;
3253}
3254
3255/**
3256 * Wrapper around the various ways to flush all data to the underlying medium (cache, async vs. sync).
3257 *
3258 * @returns VBox status code.
3259 * @param pThis VBox disk container instance data.
3260 * @param pIoReq I/O request to process.
3261 */
3262static int drvvdMediaExIoReqFlushWrapper(PVBOXDISK pThis, PPDMMEDIAEXIOREQINT pIoReq)
3263{
3264 int rc = VINF_SUCCESS;
3265
3266 LogFlowFunc(("pThis=%#p pIoReq=%#p\n", pThis, pIoReq));
3267
3268 if ( pThis->fAsyncIOSupported
3269 && !(pIoReq->fFlags & PDMIMEDIAEX_F_SYNC))
3270 {
3271 if (pThis->pBlkCache)
3272 {
3273 rc = PDMR3BlkCacheFlush(pThis->pBlkCache, pIoReq);
3274 if (rc == VINF_SUCCESS)
3275 rc = VINF_VD_ASYNC_IO_FINISHED;
3276 else if (rc == VINF_AIO_TASK_PENDING)
3277 rc = VERR_VD_ASYNC_IO_IN_PROGRESS;
3278 }
3279 else
3280 rc = VDAsyncFlush(pThis->pDisk, drvvdMediaExIoReqComplete, pThis, pIoReq);
3281 }
3282 else
3283 {
3284 rc = VDFlush(pThis->pDisk);
3285 if (RT_SUCCESS(rc))
3286 rc = VINF_VD_ASYNC_IO_FINISHED;
3287 }
3288
3289 LogFlowFunc(("returns %Rrc\n", rc));
3290 return rc;
3291}
3292
3293/**
3294 * Wrapper around the various ways to discard data blocks on the underlying medium (cache, async vs. sync).
3295 *
3296 * @returns VBox status code.
3297 * @param pThis VBox disk container instance data.
3298 * @param pIoReq I/O request to process.
3299 */
3300static int drvvdMediaExIoReqDiscardWrapper(PVBOXDISK pThis, PPDMMEDIAEXIOREQINT pIoReq)
3301{
3302 int rc = VINF_SUCCESS;
3303
3304 LogFlowFunc(("pThis=%#p pIoReq=%#p\n", pThis, pIoReq));
3305
3306 if ( pThis->fAsyncIOSupported
3307 && !(pIoReq->fFlags & PDMIMEDIAEX_F_SYNC))
3308 {
3309 if (pThis->pBlkCache)
3310 {
3311 rc = PDMR3BlkCacheDiscard(pThis->pBlkCache, pIoReq->Discard.paRanges, pIoReq->Discard.cRanges, pIoReq);
3312 if (rc == VINF_SUCCESS)
3313 rc = VINF_VD_ASYNC_IO_FINISHED;
3314 else if (rc == VINF_AIO_TASK_PENDING)
3315 rc = VERR_VD_ASYNC_IO_IN_PROGRESS;
3316 }
3317 else
3318 rc = VDAsyncDiscardRanges(pThis->pDisk, pIoReq->Discard.paRanges, pIoReq->Discard.cRanges,
3319 drvvdMediaExIoReqComplete, pThis, pIoReq);
3320 }
3321 else
3322 {
3323 rc = VDDiscardRanges(pThis->pDisk, pIoReq->Discard.paRanges, pIoReq->Discard.cRanges);
3324 if (RT_SUCCESS(rc))
3325 rc = VINF_VD_ASYNC_IO_FINISHED;
3326 }
3327
3328 LogFlowFunc(("returns %Rrc\n", rc));
3329 return rc;
3330}
3331
3332/**
3333 * Processes a read/write request.
3334 *
3335 * @returns VBox status code.
3336 * @param pThis VBox disk container instance data.
3337 * @param pIoReq I/O request to process.
3338 * @param fUpNotify Flag whether to notify the driver/device above us about the completion.
3339 */
3340static int drvvdMediaExIoReqReadWriteProcess(PVBOXDISK pThis, PPDMMEDIAEXIOREQINT pIoReq, bool fUpNotify)
3341{
3342 int rc = VINF_SUCCESS;
3343
3344 LogFlowFunc(("pThis=%#p pIoReq=%#p fUpNotify=%RTbool\n", pThis, pIoReq, fUpNotify));
3345
3346 Assert(pIoReq->enmType == PDMMEDIAEXIOREQTYPE_READ || pIoReq->enmType == PDMMEDIAEXIOREQTYPE_WRITE);
3347
3348 rc = drvvdKeyCheckPrereqs(pThis, false /* fSetError */);
3349
3350 while ( pIoReq->ReadWrite.cbReqLeft
3351 && rc == VINF_SUCCESS)
3352 {
3353 Assert(pIoReq->ReadWrite.cbIoBuf > 0);
3354
3355 size_t cbReqIo = RT_MIN(pIoReq->ReadWrite.cbReqLeft, pIoReq->ReadWrite.cbIoBuf);
3356
3357 if (pIoReq->enmType == PDMMEDIAEXIOREQTYPE_READ)
3358 rc = drvvdMediaExIoReqReadWrapper(pThis, pIoReq, cbReqIo, &cbReqIo);
3359 else
3360 {
3361 /* Sync memory buffer from the request initiator. */
3362 rc = drvvdMediaExIoReqBufSync(pThis, pIoReq, true /* fToIoBuf */);
3363 if (RT_SUCCESS(rc))
3364 rc = drvvdMediaExIoReqWriteWrapper(pThis, pIoReq, cbReqIo, &cbReqIo);
3365 }
3366
3367 if (rc == VERR_VD_ASYNC_IO_IN_PROGRESS)
3368 rc = VINF_PDM_MEDIAEX_IOREQ_IN_PROGRESS;
3369 else if (rc == VINF_VD_ASYNC_IO_FINISHED)
3370 {
3371 /*
3372 * Don't sync the buffer or update the I/O state for the last chunk as it is done
3373 * already in the completion worker called below.
3374 */
3375 if (cbReqIo < pIoReq->ReadWrite.cbReqLeft)
3376 {
3377 if (pIoReq->enmType == PDMMEDIAEXIOREQTYPE_READ)
3378 rc = drvvdMediaExIoReqBufSync(pThis, pIoReq, false /* fToIoBuf */);
3379 else
3380 rc = VINF_SUCCESS;
3381 pIoReq->ReadWrite.offStart += cbReqIo;
3382 pIoReq->ReadWrite.cbReqLeft -= cbReqIo;
3383 }
3384 else
3385 {
3386 rc = VINF_SUCCESS;
3387 break;
3388 }
3389 }
3390 }
3391
3392 if (rc != VINF_PDM_MEDIAEX_IOREQ_IN_PROGRESS)
3393 rc = drvvdMediaExIoReqCompleteWorker(pThis, pIoReq, rc, fUpNotify);
3394
3395 LogFlowFunc(("returns %Rrc\n", rc));
3396 return rc;
3397}
3398
3399
3400/**
3401 * Frees a I/O memory buffer allocated previously.
3402 *
3403 * @returns nothing.
3404 * @param pThis VBox disk container instance data.
3405 * @param pIoReq I/O request for which to free memory.
3406 */
3407DECLINLINE(void) drvvdMediaExIoReqBufFree(PVBOXDISK pThis, PPDMMEDIAEXIOREQINT pIoReq)
3408{
3409 LogFlowFunc(("pThis=%#p pIoReq=%#p{.cbIoBuf=%zu}\n", pThis, pIoReq, pIoReq->ReadWrite.cbIoBuf));
3410
3411 if ( ( pIoReq->enmType == PDMMEDIAEXIOREQTYPE_READ
3412 || pIoReq->enmType == PDMMEDIAEXIOREQTYPE_WRITE)
3413 && !pIoReq->ReadWrite.fDirectBuf
3414 && pIoReq->ReadWrite.cbIoBuf > 0)
3415 {
3416 IOBUFMgrFreeBuf(&pIoReq->ReadWrite.IoBuf);
3417
3418 uint32_t cIoReqsWaiting = ASMAtomicXchgU32(&pThis->cIoReqsWaiting, 0);
3419 if (cIoReqsWaiting > 0)
3420 {
3421 RTLISTANCHOR LstIoReqProcess;
3422 RTLISTANCHOR LstIoReqCanceled;
3423 RTListInit(&LstIoReqProcess);
3424 RTListInit(&LstIoReqCanceled);
3425
3426 /* Try to process as many requests as possible. */
3427 RTCritSectEnter(&pThis->CritSectIoReqsIoBufWait);
3428 PPDMMEDIAEXIOREQINT pIoReqCur, pIoReqNext;
3429
3430 RTListForEachSafe(&pThis->LstIoReqIoBufWait, pIoReqCur, pIoReqNext, PDMMEDIAEXIOREQINT, NdLstWait)
3431 {
3432 LogFlowFunc(("Found I/O request %#p on waiting list, trying to allocate buffer of size %zu bytes\n",
3433 pIoReqCur, pIoReqCur->ReadWrite.cbReq));
3434
3435 /* Allocate a suitable I/O buffer for this request. */
3436 int rc = IOBUFMgrAllocBuf(pThis->hIoBufMgr, &pIoReqCur->ReadWrite.IoBuf, pIoReqCur->ReadWrite.cbReq,
3437 &pIoReqCur->ReadWrite.cbIoBuf);
3438 if (rc == VINF_SUCCESS)
3439 {
3440 Assert(pIoReqCur->ReadWrite.cbIoBuf > 0);
3441
3442 cIoReqsWaiting--;
3443 RTListNodeRemove(&pIoReqCur->NdLstWait);
3444
3445 pIoReqCur->ReadWrite.fDirectBuf = false;
3446 pIoReqCur->ReadWrite.pSgBuf = &pIoReqCur->ReadWrite.IoBuf.SgBuf;
3447
3448 bool fXchg = ASMAtomicCmpXchgU32((volatile uint32_t *)&pIoReqCur->enmState,
3449 VDIOREQSTATE_ACTIVE, VDIOREQSTATE_ALLOCATED);
3450 if (RT_UNLIKELY(!fXchg))
3451 {
3452 /* Must have been canceled inbetween. */
3453 Assert(pIoReqCur->enmState == VDIOREQSTATE_CANCELED);
3454
3455 /* Free the buffer here already again to let other requests get a chance to allocate the memory. */
3456 IOBUFMgrFreeBuf(&pIoReq->ReadWrite.IoBuf);
3457 pIoReqCur->ReadWrite.cbIoBuf = 0;
3458 RTListAppend(&LstIoReqCanceled, &pIoReqCur->NdLstWait);
3459 }
3460 else
3461 {
3462 ASMAtomicIncU32(&pThis->cIoReqsActive);
3463 RTListAppend(&LstIoReqProcess, &pIoReqCur->NdLstWait);
3464 }
3465 }
3466 else
3467 {
3468 Assert(rc == VERR_NO_MEMORY);
3469 break;
3470 }
3471 }
3472 RTCritSectLeave(&pThis->CritSectIoReqsIoBufWait);
3473
3474 ASMAtomicAddU32(&pThis->cIoReqsWaiting, cIoReqsWaiting);
3475
3476 /* Process the requests we could allocate memory for and the ones which got canceled outside the lock now. */
3477 RTListForEachSafe(&LstIoReqCanceled, pIoReqCur, pIoReqNext, PDMMEDIAEXIOREQINT, NdLstWait)
3478 {
3479 RTListNodeRemove(&pIoReqCur->NdLstWait);
3480 drvvdMediaExIoReqCompleteWorker(pThis, pIoReqCur, VERR_PDM_MEDIAEX_IOREQ_CANCELED, true /* fUpNotify */);
3481 }
3482
3483 RTListForEachSafe(&LstIoReqProcess, pIoReqCur, pIoReqNext, PDMMEDIAEXIOREQINT, NdLstWait)
3484 {
3485 RTListNodeRemove(&pIoReqCur->NdLstWait);
3486 drvvdMediaExIoReqReadWriteProcess(pThis, pIoReqCur, true /* fUpNotify */);
3487 }
3488 }
3489 }
3490
3491 LogFlowFunc(("returns\n"));
3492}
3493
3494
3495/**
3496 * Returns a string description of the given request state.
3497 *
3498 * @returns Pointer to the stringified state.
3499 * @param enmState The state.
3500 */
3501DECLINLINE(const char *) drvvdMediaExIoReqStateStringify(VDIOREQSTATE enmState)
3502{
3503#define STATE2STR(a_State) case VDIOREQSTATE_##a_State: return #a_State
3504 switch (enmState)
3505 {
3506 STATE2STR(INVALID);
3507 STATE2STR(FREE);
3508 STATE2STR(ALLOCATED);
3509 STATE2STR(ACTIVE);
3510 STATE2STR(SUSPENDED);
3511 STATE2STR(COMPLETING);
3512 STATE2STR(COMPLETED);
3513 STATE2STR(CANCELED);
3514 default:
3515 AssertMsgFailed(("Unknown state %u\n", enmState));
3516 return "UNKNOWN";
3517 }
3518#undef STATE2STR
3519}
3520
3521
3522/**
3523 * Returns a string description of the given request type.
3524 *
3525 * @returns Pointer to the stringified type.
3526 * @param enmType The request type.
3527 */
3528DECLINLINE(const char *) drvvdMediaExIoReqTypeStringify(PDMMEDIAEXIOREQTYPE enmType)
3529{
3530#define TYPE2STR(a_Type) case PDMMEDIAEXIOREQTYPE_##a_Type: return #a_Type
3531 switch (enmType)
3532 {
3533 TYPE2STR(INVALID);
3534 TYPE2STR(FLUSH);
3535 TYPE2STR(WRITE);
3536 TYPE2STR(READ);
3537 TYPE2STR(DISCARD);
3538 TYPE2STR(SCSI);
3539 default:
3540 AssertMsgFailed(("Unknown type %u\n", enmType));
3541 return "UNKNOWN";
3542 }
3543#undef TYPE2STR
3544}
3545
3546
3547/**
3548 * Dumps the interesting bits about the given I/O request to the release log.
3549 *
3550 * @returns nothing.
3551 * @param pThis VBox disk container instance data.
3552 * @param pIoReq The I/O request to dump.
3553 */
3554static void drvvdMediaExIoReqLogRel(PVBOXDISK pThis, PPDMMEDIAEXIOREQINT pIoReq)
3555{
3556 uint64_t offStart = 0;
3557 size_t cbReq = 0;
3558 size_t cbLeft = 0;
3559 size_t cbBufSize = 0;
3560 uint64_t tsActive = RTTimeMilliTS() - pIoReq->tsSubmit;
3561
3562 if ( pIoReq->enmType == PDMMEDIAEXIOREQTYPE_READ
3563 || pIoReq->enmType == PDMMEDIAEXIOREQTYPE_WRITE)
3564 {
3565 offStart = pIoReq->ReadWrite.offStart;
3566 cbReq = pIoReq->ReadWrite.cbReq;
3567 cbLeft = pIoReq->ReadWrite.cbReqLeft;
3568 cbBufSize = pIoReq->ReadWrite.cbIoBuf;
3569 }
3570
3571 LogRel(("VD#%u: Request{%#p}:\n"
3572 " Type=%s State=%s Id=%#llx SubmitTs=%llu {%llu} Flags=%#x\n"
3573 " Offset=%llu Size=%zu Left=%zu BufSize=%zu\n",
3574 pThis->pDrvIns->iInstance, pIoReq,
3575 drvvdMediaExIoReqTypeStringify(pIoReq->enmType),
3576 drvvdMediaExIoReqStateStringify(pIoReq->enmState),
3577 pIoReq->uIoReqId, pIoReq->tsSubmit, tsActive, pIoReq->fFlags,
3578 offStart, cbReq, cbLeft, cbBufSize));
3579}
3580
3581
3582/**
3583 * Returns whether the VM is in a running state.
3584 *
3585 * @returns Flag indicating whether the VM is currently in a running state.
3586 * @param pThis VBox disk container instance data.
3587 */
3588DECLINLINE(bool) drvvdMediaExIoReqIsVmRunning(PVBOXDISK pThis)
3589{
3590 VMSTATE enmVmState = PDMDrvHlpVMState(pThis->pDrvIns);
3591 if ( enmVmState == VMSTATE_RESUMING
3592 || enmVmState == VMSTATE_RUNNING
3593 || enmVmState == VMSTATE_RUNNING_LS
3594 || enmVmState == VMSTATE_RUNNING_FT
3595 || enmVmState == VMSTATE_RESETTING
3596 || enmVmState == VMSTATE_RESETTING_LS
3597 || enmVmState == VMSTATE_SOFT_RESETTING
3598 || enmVmState == VMSTATE_SOFT_RESETTING_LS
3599 || enmVmState == VMSTATE_SUSPENDING
3600 || enmVmState == VMSTATE_SUSPENDING_LS
3601 || enmVmState == VMSTATE_SUSPENDING_EXT_LS)
3602 return true;
3603
3604 return false;
3605}
3606
3607/**
3608 * @copydoc FNVDASYNCTRANSFERCOMPLETE
3609 */
3610static DECLCALLBACK(void) drvvdMediaExIoReqComplete(void *pvUser1, void *pvUser2, int rcReq)
3611{
3612 PVBOXDISK pThis = (PVBOXDISK)pvUser1;
3613 PPDMMEDIAEXIOREQINT pIoReq = (PPDMMEDIAEXIOREQINT)pvUser2;
3614
3615 drvvdMediaExIoReqCompleteWorker(pThis, pIoReq, rcReq, true /* fUpNotify */);
3616}
3617
3618/**
3619 * Tries to cancel the given I/O request returning the result.
3620 *
3621 * @returns Flag whether the request was successfully canceled or whether it
3622 * already complete inbetween.
3623 * @param pThis VBox disk container instance data.
3624 * @param pIoReq The I/O request to cancel.
3625 */
3626static bool drvvdMediaExIoReqCancel(PVBOXDISK pThis, PPDMMEDIAEXIOREQINT pIoReq)
3627{
3628 bool fXchg = false;
3629 VDIOREQSTATE enmStateOld = (VDIOREQSTATE)ASMAtomicReadU32((volatile uint32_t *)&pIoReq->enmState);
3630
3631 drvvdMediaExIoReqLogRel(pThis, pIoReq);
3632
3633 /*
3634 * We might have to try canceling the request multiple times if it transitioned from
3635 * ALLOCATED to ACTIVE or to SUSPENDED between reading the state and trying to change it.
3636 */
3637 while ( ( enmStateOld == VDIOREQSTATE_ALLOCATED
3638 || enmStateOld == VDIOREQSTATE_ACTIVE
3639 || enmStateOld == VDIOREQSTATE_SUSPENDED)
3640 && !fXchg)
3641 {
3642 fXchg = ASMAtomicCmpXchgU32((volatile uint32_t *)&pIoReq->enmState, VDIOREQSTATE_CANCELED, enmStateOld);
3643 if (fXchg)
3644 break;
3645
3646 enmStateOld = (VDIOREQSTATE)ASMAtomicReadU32((volatile uint32_t *)&pIoReq->enmState);
3647 }
3648
3649 if (fXchg)
3650 ASMAtomicDecU32(&pThis->cIoReqsActive);
3651
3652 return fXchg;
3653}
3654
3655/**
3656 * @interface_method_impl{PDMIMEDIAEX,pfnQueryFeatures}
3657 */
3658static DECLCALLBACK(int) drvvdQueryFeatures(PPDMIMEDIAEX pInterface, uint32_t *pfFeatures)
3659{
3660 PVBOXDISK pThis = RT_FROM_MEMBER(pInterface, VBOXDISK, IMediaEx);
3661
3662 AssertPtrReturn(pfFeatures, VERR_INVALID_POINTER);
3663
3664 uint32_t fFeatures = 0;
3665 if (pThis->fAsyncIOSupported)
3666 fFeatures |= PDMIMEDIAEX_FEATURE_F_ASYNC;
3667 if (pThis->IMedia.pfnDiscard)
3668 fFeatures |= PDMIMEDIAEX_FEATURE_F_DISCARD;
3669
3670 *pfFeatures = fFeatures;
3671
3672 return VINF_SUCCESS;
3673}
3674
3675
3676/**
3677 * @interface_method_impl{PDMIMEDIAEX,pfnIoReqAllocSizeSet}
3678 */
3679static DECLCALLBACK(int) drvvdIoReqAllocSizeSet(PPDMIMEDIAEX pInterface, size_t cbIoReqAlloc)
3680{
3681 PVBOXDISK pThis = RT_FROM_MEMBER(pInterface, VBOXDISK, IMediaEx);
3682 if (RT_UNLIKELY(pThis->hIoReqCache != NIL_RTMEMCACHE))
3683 return VERR_INVALID_STATE;
3684
3685 return RTMemCacheCreate(&pThis->hIoReqCache, sizeof(PDMMEDIAEXIOREQINT) + cbIoReqAlloc, 0, UINT32_MAX,
3686 NULL, NULL, NULL, 0);
3687}
3688
3689/**
3690 * @interface_method_impl{PDMIMEDIAEX,pfnIoReqAlloc}
3691 */
3692static DECLCALLBACK(int) drvvdIoReqAlloc(PPDMIMEDIAEX pInterface, PPDMMEDIAEXIOREQ phIoReq, void **ppvIoReqAlloc,
3693 PDMMEDIAEXIOREQID uIoReqId, uint32_t fFlags)
3694{
3695 PVBOXDISK pThis = RT_FROM_MEMBER(pInterface, VBOXDISK, IMediaEx);
3696
3697 AssertReturn(!(fFlags & ~PDMIMEDIAEX_F_VALID), VERR_INVALID_PARAMETER);
3698
3699 PPDMMEDIAEXIOREQINT pIoReq = (PPDMMEDIAEXIOREQINT)RTMemCacheAlloc(pThis->hIoReqCache);
3700
3701 if (RT_UNLIKELY(!pIoReq))
3702 return VERR_NO_MEMORY;
3703
3704 pIoReq->uIoReqId = uIoReqId;
3705 pIoReq->fFlags = fFlags;
3706 pIoReq->pDisk = pThis;
3707 pIoReq->enmState = VDIOREQSTATE_ALLOCATED;
3708 pIoReq->enmType = PDMMEDIAEXIOREQTYPE_INVALID;
3709
3710 int rc = drvvdMediaExIoReqInsert(pThis, pIoReq);
3711 if (RT_SUCCESS(rc))
3712 {
3713 *phIoReq = pIoReq;
3714 *ppvIoReqAlloc = &pIoReq->abAlloc[0];
3715 }
3716 else
3717 RTMemCacheFree(pThis->hIoReqCache, pIoReq);
3718
3719 return rc;
3720}
3721
3722/**
3723 * @interface_method_impl{PDMIMEDIAEX,pfnIoReqFree}
3724 */
3725static DECLCALLBACK(int) drvvdIoReqFree(PPDMIMEDIAEX pInterface, PDMMEDIAEXIOREQ hIoReq)
3726{
3727 PVBOXDISK pThis = RT_FROM_MEMBER(pInterface, VBOXDISK, IMediaEx);
3728 PPDMMEDIAEXIOREQINT pIoReq = hIoReq;
3729
3730 if ( pIoReq->enmState != VDIOREQSTATE_COMPLETED
3731 && pIoReq->enmState != VDIOREQSTATE_ALLOCATED)
3732 return VERR_PDM_MEDIAEX_IOREQ_INVALID_STATE;
3733
3734 /* Remove from allocated list. */
3735 int rc = drvvdMediaExIoReqRemove(pThis, pIoReq);
3736 if (RT_FAILURE(rc))
3737 return rc;
3738
3739 /* Free any associated I/O memory. */
3740 drvvdMediaExIoReqBufFree(pThis, pIoReq);
3741
3742 /* For discard request discard the range array. */
3743 if ( pIoReq->enmType == PDMMEDIAEXIOREQTYPE_DISCARD
3744 && pIoReq->Discard.paRanges)
3745 {
3746 RTMemFree(pIoReq->Discard.paRanges);
3747 pIoReq->Discard.paRanges = NULL;
3748 }
3749
3750 pIoReq->enmState = VDIOREQSTATE_FREE;
3751 RTMemCacheFree(pThis->hIoReqCache, pIoReq);
3752 return VINF_SUCCESS;
3753}
3754
3755/**
3756 * @interface_method_impl{PDMIMEDIAEX,pfnIoReqQueryResidual}
3757 */
3758static DECLCALLBACK(int) drvvdIoReqQueryResidual(PPDMIMEDIAEX pInterface, PDMMEDIAEXIOREQ hIoReq, size_t *pcbResidual)
3759{
3760 RT_NOREF1(pInterface);
3761
3762 PPDMMEDIAEXIOREQINT pIoReq = hIoReq;
3763
3764 if (pIoReq->enmState != VDIOREQSTATE_COMPLETED)
3765 return VERR_PDM_MEDIAEX_IOREQ_INVALID_STATE;
3766
3767 if ( pIoReq->enmType != PDMMEDIAEXIOREQTYPE_READ
3768 && pIoReq->enmType != PDMMEDIAEXIOREQTYPE_WRITE
3769 && pIoReq->enmType != PDMMEDIAEXIOREQTYPE_FLUSH)
3770 return VERR_PDM_MEDIAEX_IOREQ_INVALID_STATE;
3771
3772 *pcbResidual = 0; /* No data left to transfer always. */
3773 return VINF_SUCCESS;
3774}
3775
3776/**
3777 * @interface_method_impl{PDMIMEDIAEX,pfnIoReqQueryXferSize}
3778 */
3779static DECLCALLBACK(int) drvvdIoReqQueryXferSize(PPDMIMEDIAEX pInterface, PDMMEDIAEXIOREQ hIoReq, size_t *pcbXfer)
3780{
3781 int rc = VINF_SUCCESS;
3782 RT_NOREF1(pInterface);
3783
3784 PPDMMEDIAEXIOREQINT pIoReq = hIoReq;
3785
3786 if (pIoReq->enmState != VDIOREQSTATE_COMPLETED)
3787 return VERR_PDM_MEDIAEX_IOREQ_INVALID_STATE;
3788
3789 if ( pIoReq->enmType == PDMMEDIAEXIOREQTYPE_READ
3790 || pIoReq->enmType == PDMMEDIAEXIOREQTYPE_WRITE)
3791 *pcbXfer = pIoReq->ReadWrite.cbReq;
3792 else if (pIoReq->enmType == PDMMEDIAEXIOREQTYPE_FLUSH)
3793 *pcbXfer = 0;
3794 else
3795 rc = VERR_PDM_MEDIAEX_IOREQ_INVALID_STATE;
3796
3797 return rc;
3798}
3799
3800/**
3801 * @interface_method_impl{PDMIMEDIAEX,pfnIoReqCancelAll}
3802 */
3803static DECLCALLBACK(int) drvvdIoReqCancelAll(PPDMIMEDIAEX pInterface)
3804{
3805 int rc = VINF_SUCCESS;
3806 PVBOXDISK pThis = RT_FROM_MEMBER(pInterface, VBOXDISK, IMediaEx);
3807
3808 LogRel(("VD#%u: Cancelling all active requests\n", pThis->pDrvIns->iInstance));
3809
3810 for (unsigned idxBin = 0; idxBin < RT_ELEMENTS(pThis->aIoReqAllocBins); idxBin++)
3811 {
3812 rc = RTSemFastMutexRequest(pThis->aIoReqAllocBins[idxBin].hMtxLstIoReqAlloc);
3813 if (RT_SUCCESS(rc))
3814 {
3815 /* Search for I/O request with ID. */
3816 PPDMMEDIAEXIOREQINT pIt;
3817
3818 RTListForEach(&pThis->aIoReqAllocBins[idxBin].LstIoReqAlloc, pIt, PDMMEDIAEXIOREQINT, NdAllocatedList)
3819 {
3820 drvvdMediaExIoReqCancel(pThis, pIt);
3821 }
3822 RTSemFastMutexRelease(pThis->aIoReqAllocBins[idxBin].hMtxLstIoReqAlloc);
3823 }
3824 }
3825
3826 return rc;
3827}
3828
3829/**
3830 * @interface_method_impl{PDMIMEDIAEX,pfnIoReqCancel}
3831 */
3832static DECLCALLBACK(int) drvvdIoReqCancel(PPDMIMEDIAEX pInterface, PDMMEDIAEXIOREQID uIoReqId)
3833{
3834 PVBOXDISK pThis = RT_FROM_MEMBER(pInterface, VBOXDISK, IMediaEx);
3835 unsigned idxBin = drvvdMediaExIoReqIdHash(uIoReqId);
3836
3837 LogRel(("VD#%u: Trying to cancel request %#llx\n", pThis->pDrvIns->iInstance, uIoReqId));
3838
3839 int rc = RTSemFastMutexRequest(pThis->aIoReqAllocBins[idxBin].hMtxLstIoReqAlloc);
3840 if (RT_SUCCESS(rc))
3841 {
3842 /* Search for I/O request with ID. */
3843 PPDMMEDIAEXIOREQINT pIt;
3844 rc = VERR_PDM_MEDIAEX_IOREQID_NOT_FOUND;
3845
3846 RTListForEach(&pThis->aIoReqAllocBins[idxBin].LstIoReqAlloc, pIt, PDMMEDIAEXIOREQINT, NdAllocatedList)
3847 {
3848 if (pIt->uIoReqId == uIoReqId)
3849 {
3850 if (drvvdMediaExIoReqCancel(pThis, pIt))
3851 rc = VINF_SUCCESS;
3852
3853 break;
3854 }
3855 }
3856 RTSemFastMutexRelease(pThis->aIoReqAllocBins[idxBin].hMtxLstIoReqAlloc);
3857 }
3858
3859 return rc;
3860}
3861
3862/**
3863 * @interface_method_impl{PDMIMEDIAEX,pfnIoReqRead}
3864 */
3865static DECLCALLBACK(int) drvvdIoReqRead(PPDMIMEDIAEX pInterface, PDMMEDIAEXIOREQ hIoReq, uint64_t off, size_t cbRead)
3866{
3867 PVBOXDISK pThis = RT_FROM_MEMBER(pInterface, VBOXDISK, IMediaEx);
3868 PPDMMEDIAEXIOREQINT pIoReq = hIoReq;
3869 VDIOREQSTATE enmState = (VDIOREQSTATE)ASMAtomicReadU32((volatile uint32_t *)&pIoReq->enmState);
3870
3871 if (RT_UNLIKELY(enmState == VDIOREQSTATE_CANCELED))
3872 return VERR_PDM_MEDIAEX_IOREQ_CANCELED;
3873
3874 if (RT_UNLIKELY(enmState != VDIOREQSTATE_ALLOCATED))
3875 return VERR_PDM_MEDIAEX_IOREQ_INVALID_STATE;
3876
3877 STAM_REL_COUNTER_INC(&pThis->StatReqsSubmitted);
3878 STAM_REL_COUNTER_INC(&pThis->StatReqsRead);
3879
3880 pIoReq->enmType = PDMMEDIAEXIOREQTYPE_READ;
3881 pIoReq->tsSubmit = RTTimeMilliTS();
3882 pIoReq->ReadWrite.offStart = off;
3883 pIoReq->ReadWrite.cbReq = cbRead;
3884 pIoReq->ReadWrite.cbReqLeft = cbRead;
3885 /* Allocate a suitable I/O buffer for this request. */
3886 int rc = drvvdMediaExIoReqBufAlloc(pThis, pIoReq, cbRead);
3887 if (rc == VINF_SUCCESS)
3888 {
3889 bool fXchg = ASMAtomicCmpXchgU32((volatile uint32_t *)&pIoReq->enmState, VDIOREQSTATE_ACTIVE, VDIOREQSTATE_ALLOCATED);
3890 if (RT_UNLIKELY(!fXchg))
3891 {
3892 /* Must have been canceled inbetween. */
3893 Assert(pIoReq->enmState == VDIOREQSTATE_CANCELED);
3894 return VERR_PDM_MEDIAEX_IOREQ_CANCELED;
3895 }
3896 ASMAtomicIncU32(&pThis->cIoReqsActive);
3897
3898 rc = drvvdMediaExIoReqReadWriteProcess(pThis, pIoReq, false /* fUpNotify */);
3899 }
3900
3901 return rc;
3902}
3903
3904/**
3905 * @interface_method_impl{PDMIMEDIAEX,pfnIoReqWrite}
3906 */
3907static DECLCALLBACK(int) drvvdIoReqWrite(PPDMIMEDIAEX pInterface, PDMMEDIAEXIOREQ hIoReq, uint64_t off, size_t cbWrite)
3908{
3909 PVBOXDISK pThis = RT_FROM_MEMBER(pInterface, VBOXDISK, IMediaEx);
3910 PPDMMEDIAEXIOREQINT pIoReq = hIoReq;
3911 VDIOREQSTATE enmState = (VDIOREQSTATE)ASMAtomicReadU32((volatile uint32_t *)&pIoReq->enmState);
3912
3913 if (RT_UNLIKELY(enmState == VDIOREQSTATE_CANCELED))
3914 return VERR_PDM_MEDIAEX_IOREQ_CANCELED;
3915
3916 if (RT_UNLIKELY(enmState != VDIOREQSTATE_ALLOCATED))
3917 return VERR_PDM_MEDIAEX_IOREQ_INVALID_STATE;
3918
3919 STAM_REL_COUNTER_INC(&pThis->StatReqsSubmitted);
3920 STAM_REL_COUNTER_INC(&pThis->StatReqsWrite);
3921
3922 pIoReq->enmType = PDMMEDIAEXIOREQTYPE_WRITE;
3923 pIoReq->tsSubmit = RTTimeMilliTS();
3924 pIoReq->ReadWrite.offStart = off;
3925 pIoReq->ReadWrite.cbReq = cbWrite;
3926 pIoReq->ReadWrite.cbReqLeft = cbWrite;
3927 /* Allocate a suitable I/O buffer for this request. */
3928 int rc = drvvdMediaExIoReqBufAlloc(pThis, pIoReq, cbWrite);
3929 if (rc == VINF_SUCCESS)
3930 {
3931 bool fXchg = ASMAtomicCmpXchgU32((volatile uint32_t *)&pIoReq->enmState, VDIOREQSTATE_ACTIVE, VDIOREQSTATE_ALLOCATED);
3932 if (RT_UNLIKELY(!fXchg))
3933 {
3934 /* Must have been canceled inbetween. */
3935 Assert(pIoReq->enmState == VDIOREQSTATE_CANCELED);
3936 return VERR_PDM_MEDIAEX_IOREQ_CANCELED;
3937 }
3938 ASMAtomicIncU32(&pThis->cIoReqsActive);
3939
3940 rc = drvvdMediaExIoReqReadWriteProcess(pThis, pIoReq, false /* fUpNotify */);
3941 }
3942
3943 return rc;
3944}
3945
3946/**
3947 * @interface_method_impl{PDMIMEDIAEX,pfnIoReqFlush}
3948 */
3949static DECLCALLBACK(int) drvvdIoReqFlush(PPDMIMEDIAEX pInterface, PDMMEDIAEXIOREQ hIoReq)
3950{
3951 PVBOXDISK pThis = RT_FROM_MEMBER(pInterface, VBOXDISK, IMediaEx);
3952 PPDMMEDIAEXIOREQINT pIoReq = hIoReq;
3953 VDIOREQSTATE enmState = (VDIOREQSTATE)ASMAtomicReadU32((volatile uint32_t *)&pIoReq->enmState);
3954
3955 if (RT_UNLIKELY(enmState == VDIOREQSTATE_CANCELED))
3956 return VERR_PDM_MEDIAEX_IOREQ_CANCELED;
3957
3958 if (RT_UNLIKELY(enmState != VDIOREQSTATE_ALLOCATED))
3959 return VERR_PDM_MEDIAEX_IOREQ_INVALID_STATE;
3960
3961 STAM_REL_COUNTER_INC(&pThis->StatReqsSubmitted);
3962 STAM_REL_COUNTER_INC(&pThis->StatReqsFlush);
3963
3964 pIoReq->enmType = PDMMEDIAEXIOREQTYPE_FLUSH;
3965 pIoReq->tsSubmit = RTTimeMilliTS();
3966 bool fXchg = ASMAtomicCmpXchgU32((volatile uint32_t *)&pIoReq->enmState, VDIOREQSTATE_ACTIVE, VDIOREQSTATE_ALLOCATED);
3967 if (RT_UNLIKELY(!fXchg))
3968 {
3969 /* Must have been canceled inbetween. */
3970 Assert(pIoReq->enmState == VDIOREQSTATE_CANCELED);
3971 return VERR_PDM_MEDIAEX_IOREQ_CANCELED;
3972 }
3973
3974 ASMAtomicIncU32(&pThis->cIoReqsActive);
3975 int rc = drvvdMediaExIoReqFlushWrapper(pThis, pIoReq);
3976 if (rc == VERR_VD_ASYNC_IO_IN_PROGRESS)
3977 rc = VINF_PDM_MEDIAEX_IOREQ_IN_PROGRESS;
3978 else if (rc == VINF_VD_ASYNC_IO_FINISHED)
3979 rc = VINF_SUCCESS;
3980
3981 if (rc != VINF_PDM_MEDIAEX_IOREQ_IN_PROGRESS)
3982 rc = drvvdMediaExIoReqCompleteWorker(pThis, pIoReq, rc, false /* fUpNotify */);
3983
3984 return rc;
3985}
3986
3987/**
3988 * @interface_method_impl{PDMIMEDIAEX,pfnIoReqDiscard}
3989 */
3990static DECLCALLBACK(int) drvvdIoReqDiscard(PPDMIMEDIAEX pInterface, PDMMEDIAEXIOREQ hIoReq, unsigned cRangesMax)
3991{
3992 PVBOXDISK pThis = RT_FROM_MEMBER(pInterface, VBOXDISK, IMediaEx);
3993 PPDMMEDIAEXIOREQINT pIoReq = hIoReq;
3994 VDIOREQSTATE enmState = (VDIOREQSTATE)ASMAtomicReadU32((volatile uint32_t *)&pIoReq->enmState);
3995
3996 if (RT_UNLIKELY(enmState == VDIOREQSTATE_CANCELED))
3997 return VERR_PDM_MEDIAEX_IOREQ_CANCELED;
3998
3999 if (RT_UNLIKELY(enmState != VDIOREQSTATE_ALLOCATED))
4000 return VERR_PDM_MEDIAEX_IOREQ_INVALID_STATE;
4001
4002 STAM_REL_COUNTER_INC(&pThis->StatReqsSubmitted);
4003 STAM_REL_COUNTER_INC(&pThis->StatReqsDiscard);
4004
4005 /* Copy the ranges over now, this can be optimized in the future. */
4006 pIoReq->Discard.paRanges = (PRTRANGE)RTMemAllocZ(cRangesMax * sizeof(RTRANGE));
4007 if (RT_UNLIKELY(!pIoReq->Discard.paRanges))
4008 return VERR_NO_MEMORY;
4009
4010 int rc = pThis->pDrvMediaExPort->pfnIoReqQueryDiscardRanges(pThis->pDrvMediaExPort, pIoReq, &pIoReq->abAlloc[0],
4011 0, cRangesMax, pIoReq->Discard.paRanges,
4012 &pIoReq->Discard.cRanges);
4013 if (RT_SUCCESS(rc))
4014 {
4015 pIoReq->enmType = PDMMEDIAEXIOREQTYPE_DISCARD;
4016 pIoReq->tsSubmit = RTTimeMilliTS();
4017 bool fXchg = ASMAtomicCmpXchgU32((volatile uint32_t *)&pIoReq->enmState, VDIOREQSTATE_ACTIVE, VDIOREQSTATE_ALLOCATED);
4018 if (RT_UNLIKELY(!fXchg))
4019 {
4020 /* Must have been canceled inbetween. */
4021 Assert(pIoReq->enmState == VDIOREQSTATE_CANCELED);
4022 return VERR_PDM_MEDIAEX_IOREQ_CANCELED;
4023 }
4024
4025 ASMAtomicIncU32(&pThis->cIoReqsActive);
4026 rc = drvvdMediaExIoReqDiscardWrapper(pThis, pIoReq);
4027 if (rc == VERR_VD_ASYNC_IO_IN_PROGRESS)
4028 rc = VINF_PDM_MEDIAEX_IOREQ_IN_PROGRESS;
4029 else if (rc == VINF_VD_ASYNC_IO_FINISHED)
4030 rc = VINF_SUCCESS;
4031
4032 if (rc != VINF_PDM_MEDIAEX_IOREQ_IN_PROGRESS)
4033 rc = drvvdMediaExIoReqCompleteWorker(pThis, pIoReq, rc, false /* fUpNotify */);
4034 }
4035
4036 return rc;
4037}
4038
4039/**
4040 * @interface_method_impl{PDMIMEDIAEX,pfnIoReqSendScsiCmd}
4041 */
4042static DECLCALLBACK(int) drvvdIoReqSendScsiCmd(PPDMIMEDIAEX pInterface, PDMMEDIAEXIOREQ hIoReq, uint32_t uLun,
4043 const uint8_t *pbCdb, size_t cbCdb, PDMMEDIAEXIOREQSCSITXDIR enmTxDir,
4044 size_t cbBuf, uint8_t *pabSense, size_t cbSense, uint8_t *pu8ScsiSts,
4045 uint32_t cTimeoutMillies)
4046{
4047 RT_NOREF10(pInterface, uLun, pbCdb, cbCdb, enmTxDir, cbBuf, pabSense, cbSense, pu8ScsiSts, cTimeoutMillies);
4048 PPDMMEDIAEXIOREQINT pIoReq = hIoReq;
4049 VDIOREQSTATE enmState = (VDIOREQSTATE)ASMAtomicReadU32((volatile uint32_t *)&pIoReq->enmState);
4050
4051 if (RT_UNLIKELY(enmState == VDIOREQSTATE_CANCELED))
4052 return VERR_PDM_MEDIAEX_IOREQ_CANCELED;
4053
4054 if (RT_UNLIKELY(enmState != VDIOREQSTATE_ALLOCATED))
4055 return VERR_PDM_MEDIAEX_IOREQ_INVALID_STATE;
4056
4057 return VERR_NOT_SUPPORTED;
4058}
4059
4060/**
4061 * @interface_method_impl{PDMIMEDIAEX,pfnIoReqGetActiveCount}
4062 */
4063static DECLCALLBACK(uint32_t) drvvdIoReqGetActiveCount(PPDMIMEDIAEX pInterface)
4064{
4065 PVBOXDISK pThis = RT_FROM_MEMBER(pInterface, VBOXDISK, IMediaEx);
4066 return ASMAtomicReadU32(&pThis->cIoReqsActive);
4067}
4068
4069/**
4070 * @interface_method_impl{PDMIMEDIAEX,pfnIoReqGetSuspendedCount}
4071 */
4072static DECLCALLBACK(uint32_t) drvvdIoReqGetSuspendedCount(PPDMIMEDIAEX pInterface)
4073{
4074 PVBOXDISK pThis = RT_FROM_MEMBER(pInterface, VBOXDISK, IMediaEx);
4075
4076 AssertReturn(!drvvdMediaExIoReqIsVmRunning(pThis), 0);
4077
4078 uint32_t cIoReqSuspended = 0;
4079 PPDMMEDIAEXIOREQINT pIoReq;
4080 RTCritSectEnter(&pThis->CritSectIoReqRedo);
4081 RTListForEach(&pThis->LstIoReqRedo, pIoReq, PDMMEDIAEXIOREQINT, NdLstWait)
4082 {
4083 cIoReqSuspended++;
4084 }
4085 RTCritSectLeave(&pThis->CritSectIoReqRedo);
4086
4087 return cIoReqSuspended;
4088}
4089
4090/**
4091 * @interface_method_impl{PDMIMEDIAEX,pfnIoReqQuerySuspendedStart}
4092 */
4093static DECLCALLBACK(int) drvvdIoReqQuerySuspendedStart(PPDMIMEDIAEX pInterface, PPDMMEDIAEXIOREQ phIoReq,
4094 void **ppvIoReqAlloc)
4095{
4096 PVBOXDISK pThis = RT_FROM_MEMBER(pInterface, VBOXDISK, IMediaEx);
4097
4098 AssertReturn(!drvvdMediaExIoReqIsVmRunning(pThis), VERR_INVALID_STATE);
4099 AssertReturn(!RTListIsEmpty(&pThis->LstIoReqRedo), VERR_NOT_FOUND);
4100
4101 RTCritSectEnter(&pThis->CritSectIoReqRedo);
4102 PPDMMEDIAEXIOREQINT pIoReq = RTListGetFirst(&pThis->LstIoReqRedo, PDMMEDIAEXIOREQINT, NdLstWait);
4103 *phIoReq = pIoReq;
4104 *ppvIoReqAlloc = &pIoReq->abAlloc[0];
4105 RTCritSectLeave(&pThis->CritSectIoReqRedo);
4106
4107 return VINF_SUCCESS;
4108}
4109
4110/**
4111 * @interface_method_impl{PDMIMEDIAEX,pfnIoReqQuerySuspendedNext}
4112 */
4113static DECLCALLBACK(int) drvvdIoReqQuerySuspendedNext(PPDMIMEDIAEX pInterface, PDMMEDIAEXIOREQ hIoReq,
4114 PPDMMEDIAEXIOREQ phIoReqNext, void **ppvIoReqAllocNext)
4115{
4116 PVBOXDISK pThis = RT_FROM_MEMBER(pInterface, VBOXDISK, IMediaEx);
4117 PPDMMEDIAEXIOREQINT pIoReq = hIoReq;
4118
4119 AssertReturn(!drvvdMediaExIoReqIsVmRunning(pThis), VERR_INVALID_STATE);
4120 AssertPtrReturn(pIoReq, VERR_INVALID_HANDLE);
4121 AssertReturn(!RTListNodeIsLast(&pThis->LstIoReqRedo, &pIoReq->NdLstWait), VERR_NOT_FOUND);
4122
4123 RTCritSectEnter(&pThis->CritSectIoReqRedo);
4124 PPDMMEDIAEXIOREQINT pIoReqNext = RTListNodeGetNext(&pIoReq->NdLstWait, PDMMEDIAEXIOREQINT, NdLstWait);
4125 *phIoReqNext = pIoReqNext;
4126 *ppvIoReqAllocNext = &pIoReqNext->abAlloc[0];
4127 RTCritSectLeave(&pThis->CritSectIoReqRedo);
4128
4129 return VINF_SUCCESS;
4130}
4131
4132/**
4133 * @interface_method_impl{PDMIMEDIAEX,pfnIoReqSuspendedSave}
4134 */
4135static DECLCALLBACK(int) drvvdIoReqSuspendedSave(PPDMIMEDIAEX pInterface, PSSMHANDLE pSSM, PDMMEDIAEXIOREQ hIoReq)
4136{
4137 PVBOXDISK pThis = RT_FROM_MEMBER(pInterface, VBOXDISK, IMediaEx);
4138 PPDMMEDIAEXIOREQINT pIoReq = hIoReq;
4139
4140 AssertReturn(!drvvdMediaExIoReqIsVmRunning(pThis), VERR_INVALID_STATE);
4141 AssertPtrReturn(pIoReq, VERR_INVALID_HANDLE);
4142 AssertReturn(pIoReq->enmState == VDIOREQSTATE_SUSPENDED, VERR_INVALID_STATE);
4143
4144 SSMR3PutU32(pSSM, DRVVD_IOREQ_SAVED_STATE_VERSION);
4145 SSMR3PutU32(pSSM, (uint32_t)pIoReq->enmType);
4146 SSMR3PutU32(pSSM, pIoReq->uIoReqId);
4147 SSMR3PutU32(pSSM, pIoReq->fFlags);
4148 if ( pIoReq->enmType == PDMMEDIAEXIOREQTYPE_READ
4149 || pIoReq->enmType == PDMMEDIAEXIOREQTYPE_WRITE)
4150 {
4151 SSMR3PutU64(pSSM, pIoReq->ReadWrite.offStart);
4152 SSMR3PutU64(pSSM, pIoReq->ReadWrite.cbReq);
4153 SSMR3PutU64(pSSM, pIoReq->ReadWrite.cbReqLeft);
4154 }
4155 else if (pIoReq->enmType == PDMMEDIAEXIOREQTYPE_DISCARD)
4156 {
4157 SSMR3PutU32(pSSM, pIoReq->Discard.cRanges);
4158 for (unsigned i = 0; i < pIoReq->Discard.cRanges; i++)
4159 {
4160 SSMR3PutU64(pSSM, pIoReq->Discard.paRanges[i].offStart);
4161 SSMR3PutU64(pSSM, pIoReq->Discard.paRanges[i].cbRange);
4162 }
4163 }
4164
4165 return SSMR3PutU32(pSSM, UINT32_MAX); /* sanity/terminator */
4166}
4167
4168/**
4169 * @interface_method_impl{PDMIMEDIAEX,pfnIoReqSuspendedLoad}
4170 */
4171static DECLCALLBACK(int) drvvdIoReqSuspendedLoad(PPDMIMEDIAEX pInterface, PSSMHANDLE pSSM, PDMMEDIAEXIOREQ hIoReq)
4172{
4173 PVBOXDISK pThis = RT_FROM_MEMBER(pInterface, VBOXDISK, IMediaEx);
4174 PPDMMEDIAEXIOREQINT pIoReq = hIoReq;
4175
4176 AssertReturn(!drvvdMediaExIoReqIsVmRunning(pThis), VERR_INVALID_STATE);
4177 AssertPtrReturn(pIoReq, VERR_INVALID_HANDLE);
4178 AssertReturn(pIoReq->enmState == VDIOREQSTATE_ALLOCATED, VERR_INVALID_STATE);
4179
4180 uint32_t u32;
4181 uint64_t u64;
4182 int rc = VINF_SUCCESS;
4183 bool fPlaceOnRedoList = true;
4184
4185 SSMR3GetU32(pSSM, &u32);
4186 if (u32 <= DRVVD_IOREQ_SAVED_STATE_VERSION)
4187 {
4188 SSMR3GetU32(pSSM, &u32);
4189 AssertReturn( u32 == PDMMEDIAEXIOREQTYPE_WRITE
4190 || u32 == PDMMEDIAEXIOREQTYPE_READ
4191 || u32 == PDMMEDIAEXIOREQTYPE_DISCARD
4192 || u32 == PDMMEDIAEXIOREQTYPE_FLUSH,
4193 VERR_SSM_DATA_UNIT_FORMAT_CHANGED);
4194 pIoReq->enmType = (PDMMEDIAEXIOREQTYPE)u32;
4195
4196 SSMR3GetU32(pSSM, &u32);
4197 AssertReturn(u32 == pIoReq->uIoReqId, VERR_SSM_DATA_UNIT_FORMAT_CHANGED);
4198
4199 SSMR3GetU32(pSSM, &u32);
4200 AssertReturn(u32 == pIoReq->fFlags, VERR_SSM_DATA_UNIT_FORMAT_CHANGED);
4201
4202 if ( pIoReq->enmType == PDMMEDIAEXIOREQTYPE_READ
4203 || pIoReq->enmType == PDMMEDIAEXIOREQTYPE_WRITE)
4204 {
4205 SSMR3GetU64(pSSM, &pIoReq->ReadWrite.offStart);
4206 SSMR3GetU64(pSSM, &u64);
4207 pIoReq->ReadWrite.cbReq = (size_t)u64;
4208 SSMR3GetU64(pSSM, &u64);
4209 pIoReq->ReadWrite.cbReqLeft = (size_t)u64;
4210
4211 /*
4212 * Try to allocate enough I/O buffer, if this fails for some reason put it onto the
4213 * waiting list instead of the redo list.
4214 */
4215 pIoReq->ReadWrite.cbIoBuf = 0;
4216 rc = IOBUFMgrAllocBuf(pThis->hIoBufMgr, &pIoReq->ReadWrite.IoBuf, pIoReq->ReadWrite.cbReqLeft,
4217 &pIoReq->ReadWrite.cbIoBuf);
4218 if (rc == VERR_NO_MEMORY)
4219 {
4220 pIoReq->enmState = VDIOREQSTATE_ALLOCATED;
4221 ASMAtomicIncU32(&pThis->cIoReqsWaiting);
4222 RTListAppend(&pThis->LstIoReqIoBufWait, &pIoReq->NdLstWait);
4223 fPlaceOnRedoList = false;
4224 rc = VINF_SUCCESS;
4225 }
4226 else
4227 {
4228 pIoReq->ReadWrite.fDirectBuf = false;
4229 pIoReq->ReadWrite.pSgBuf = &pIoReq->ReadWrite.IoBuf.SgBuf;
4230 }
4231 }
4232 else if (pIoReq->enmType == PDMMEDIAEXIOREQTYPE_DISCARD)
4233 {
4234 rc = SSMR3GetU32(pSSM, &pIoReq->Discard.cRanges);
4235 if (RT_SUCCESS(rc))
4236 {
4237 pIoReq->Discard.paRanges = (PRTRANGE)RTMemAllocZ(pIoReq->Discard.cRanges * sizeof(RTRANGE));
4238 if (RT_LIKELY(pIoReq->Discard.paRanges))
4239 {
4240 for (unsigned i = 0; i < pIoReq->Discard.cRanges; i++)
4241 {
4242 SSMR3GetU64(pSSM, &pIoReq->Discard.paRanges[i].offStart);
4243 SSMR3GetU64(pSSM, &u64);
4244 pIoReq->Discard.paRanges[i].cbRange = (size_t)u64;
4245 }
4246 }
4247 else
4248 rc = VERR_NO_MEMORY;
4249 }
4250 }
4251
4252 if (RT_SUCCESS(rc))
4253 rc = SSMR3GetU32(pSSM, &u32); /* sanity/terminator */
4254 if (RT_SUCCESS(rc))
4255 AssertReturn(u32 == UINT32_MAX, VERR_SSM_DATA_UNIT_FORMAT_CHANGED);
4256 if ( RT_SUCCESS(rc)
4257 && fPlaceOnRedoList)
4258 {
4259 /* Mark as suspended */
4260 pIoReq->enmState = VDIOREQSTATE_SUSPENDED;
4261
4262 /* Link into suspended list so it gets kicked off again when we resume. */
4263 RTCritSectEnter(&pThis->CritSectIoReqRedo);
4264 RTListAppend(&pThis->LstIoReqRedo, &pIoReq->NdLstWait);
4265 RTCritSectLeave(&pThis->CritSectIoReqRedo);
4266 }
4267 }
4268
4269 return rc;
4270}
4271
4272/**
4273 * Loads all configured plugins.
4274 *
4275 * @returns VBox status code.
4276 * @param pCfg CFGM node holding plugin list.
4277 */
4278static int drvvdLoadPlugins(PCFGMNODE pCfg)
4279{
4280 PCFGMNODE pCfgPlugins = CFGMR3GetChild(pCfg, "Plugins");
4281
4282 if (pCfgPlugins)
4283 {
4284 PCFGMNODE pPluginCur = CFGMR3GetFirstChild(pCfgPlugins);
4285 while (pPluginCur)
4286 {
4287 int rc = VINF_SUCCESS;
4288 char *pszPluginFilename = NULL;
4289 rc = CFGMR3QueryStringAlloc(pPluginCur, "Path", &pszPluginFilename);
4290 if (RT_SUCCESS(rc))
4291 rc = VDPluginLoadFromFilename(pszPluginFilename);
4292
4293 if (RT_FAILURE(rc))
4294 LogRel(("VD: Failed to load plugin '%s' with %Rrc, continuing\n", pszPluginFilename, rc));
4295
4296 pPluginCur = CFGMR3GetNextChild(pPluginCur);
4297 }
4298 }
4299
4300 return VINF_SUCCESS;
4301}
4302
4303
4304/**
4305 * Sets up the disk filter chain.
4306 *
4307 * @returns VBox status code.
4308 * @param pThis The disk instance.
4309 * @param pCfg CFGM node holding the filter parameters.
4310 */
4311static int drvvdSetupFilters(PVBOXDISK pThis, PCFGMNODE pCfg)
4312{
4313 int rc = VINF_SUCCESS;
4314 PCFGMNODE pCfgFilter = CFGMR3GetChild(pCfg, "Filters");
4315
4316 if (pCfgFilter)
4317 {
4318 PCFGMNODE pCfgFilterConfig = CFGMR3GetChild(pCfgFilter, "VDConfig");
4319 char *pszFilterName = NULL;
4320 VDINTERFACECONFIG VDIfConfig;
4321 PVDINTERFACE pVDIfsFilter = NULL;
4322
4323 rc = CFGMR3QueryStringAlloc(pCfgFilter, "FilterName", &pszFilterName);
4324 if (RT_SUCCESS(rc))
4325 {
4326 VDIfConfig.pfnAreKeysValid = drvvdCfgAreKeysValid;
4327 VDIfConfig.pfnQuerySize = drvvdCfgQuerySize;
4328 VDIfConfig.pfnQuery = drvvdCfgQuery;
4329 VDIfConfig.pfnQueryBytes = drvvdCfgQueryBytes;
4330 rc = VDInterfaceAdd(&VDIfConfig.Core, "DrvVD_Config", VDINTERFACETYPE_CONFIG,
4331 pCfgFilterConfig, sizeof(VDINTERFACECONFIG), &pVDIfsFilter);
4332 AssertRC(rc);
4333
4334 rc = VDFilterAdd(pThis->pDisk, pszFilterName, VD_FILTER_FLAGS_DEFAULT, pVDIfsFilter);
4335
4336 MMR3HeapFree(pszFilterName);
4337 }
4338 }
4339
4340 return rc;
4341}
4342
4343
4344/**
4345 * Translates a PDMMEDIATYPE value into a string.
4346 *
4347 * @returns Read only string.
4348 * @param enmType The type value.
4349 */
4350static const char *drvvdGetTypeName(PDMMEDIATYPE enmType)
4351{
4352 switch (enmType)
4353 {
4354 case PDMMEDIATYPE_ERROR: return "ERROR";
4355 case PDMMEDIATYPE_FLOPPY_360: return "FLOPPY_360";
4356 case PDMMEDIATYPE_FLOPPY_720: return "FLOPPY_720";
4357 case PDMMEDIATYPE_FLOPPY_1_20: return "FLOPPY_1_20";
4358 case PDMMEDIATYPE_FLOPPY_1_44: return "FLOPPY_1_44";
4359 case PDMMEDIATYPE_FLOPPY_2_88: return "FLOPPY_2_88";
4360 case PDMMEDIATYPE_FLOPPY_FAKE_15_6: return "FLOPPY_FAKE_15_6";
4361 case PDMMEDIATYPE_FLOPPY_FAKE_63_5: return "FLOPPY_FAKE_63_5";
4362 case PDMMEDIATYPE_CDROM: return "CDROM";
4363 case PDMMEDIATYPE_DVD: return "DVD";
4364 case PDMMEDIATYPE_HARD_DISK: return "HARD_DISK";
4365 default: return "Unknown";
4366 }
4367}
4368
4369/**
4370 * Returns the appropriate PDMMEDIATYPE for t he given string.
4371 *
4372 * @returns PDMMEDIATYPE
4373 * @param pszType The string representation of the media type.
4374 */
4375static PDMMEDIATYPE drvvdGetMediaTypeFromString(const char *pszType)
4376{
4377 PDMMEDIATYPE enmType = PDMMEDIATYPE_ERROR;
4378
4379 if (!strcmp(pszType, "HardDisk"))
4380 enmType = PDMMEDIATYPE_HARD_DISK;
4381 else if (!strcmp(pszType, "DVD"))
4382 enmType = PDMMEDIATYPE_DVD;
4383 else if (!strcmp(pszType, "CDROM"))
4384 enmType = PDMMEDIATYPE_CDROM;
4385 else if (!strcmp(pszType, "Floppy 2.88"))
4386 enmType = PDMMEDIATYPE_FLOPPY_2_88;
4387 else if (!strcmp(pszType, "Floppy 1.44"))
4388 enmType = PDMMEDIATYPE_FLOPPY_1_44;
4389 else if (!strcmp(pszType, "Floppy 1.20"))
4390 enmType = PDMMEDIATYPE_FLOPPY_1_20;
4391 else if (!strcmp(pszType, "Floppy 720"))
4392 enmType = PDMMEDIATYPE_FLOPPY_720;
4393 else if (!strcmp(pszType, "Floppy 360"))
4394 enmType = PDMMEDIATYPE_FLOPPY_360;
4395 else if (!strcmp(pszType, "Floppy 15.6"))
4396 enmType = PDMMEDIATYPE_FLOPPY_FAKE_15_6;
4397 else if (!strcmp(pszType, "Floppy 63.5"))
4398 enmType = PDMMEDIATYPE_FLOPPY_FAKE_63_5;
4399
4400 return enmType;
4401}
4402
4403/**
4404 * Converts PDMMEDIATYPE to the appropriate VDTYPE.
4405 *
4406 * @returns The VDTYPE.
4407 * @param enmType The PDMMEDIATYPE to convert from.
4408 */
4409static VDTYPE drvvdGetVDFromMediaType(PDMMEDIATYPE enmType)
4410{
4411 if (PDMMEDIATYPE_IS_FLOPPY(enmType))
4412 return VDTYPE_FLOPPY;
4413 else if (enmType == PDMMEDIATYPE_DVD || enmType == PDMMEDIATYPE_CDROM)
4414 return VDTYPE_DVD;
4415 else if (enmType == PDMMEDIATYPE_HARD_DISK)
4416 return VDTYPE_HDD;
4417
4418 AssertMsgFailed(("Invalid media type %d{%s} given!\n", enmType, drvvdGetTypeName(enmType)));
4419 return VDTYPE_HDD;
4420}
4421
4422/**
4423 * Registers statistics associated with the given media driver.
4424 *
4425 * @returns VBox status code.
4426 * @param pThis The media driver instance.
4427 */
4428static int drvvdStatsRegister(PVBOXDISK pThis)
4429{
4430 PPDMDRVINS pDrvIns = pThis->pDrvIns;
4431 uint32_t iInstance, iLUN;
4432 const char *pcszController;
4433
4434 int rc = pThis->pDrvMediaPort->pfnQueryDeviceLocation(pThis->pDrvMediaPort, &pcszController,
4435 &iInstance, &iLUN);
4436 if (RT_SUCCESS(rc))
4437 {
4438 char *pszCtrlUpper = RTStrDup(pcszController);
4439 if (pszCtrlUpper)
4440 {
4441 RTStrToUpper(pszCtrlUpper);
4442
4443 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->StatQueryBufAttempts, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS,
4444 STAMUNIT_COUNT, "Number of attempts to query a direct buffer.",
4445 "/Devices/%s%u/Port%u/QueryBufAttempts", pszCtrlUpper, iInstance, iLUN);
4446 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->StatQueryBufSuccess, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS,
4447 STAMUNIT_COUNT, "Number of succeeded attempts to query a direct buffer.",
4448 "/Devices/%s%u/Port%u/QueryBufSuccess", pszCtrlUpper, iInstance, iLUN);
4449
4450 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->StatBytesRead, STAMTYPE_COUNTER, STAMVISIBILITY_USED, STAMUNIT_BYTES,
4451 "Amount of data read.", "/Devices/%s%u/Port%u/ReadBytes", pszCtrlUpper, iInstance, iLUN);
4452 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->StatBytesWritten, STAMTYPE_COUNTER, STAMVISIBILITY_USED, STAMUNIT_BYTES,
4453 "Amount of data written.", "/Devices/%s%u/Port%u/WrittenBytes", pszCtrlUpper, iInstance, iLUN);
4454
4455 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->StatReqsSubmitted, STAMTYPE_COUNTER, STAMVISIBILITY_USED, STAMUNIT_COUNT,
4456 "Number of I/O requests submitted.", "/Devices/%s%u/Port%u/ReqsSubmitted", pszCtrlUpper, iInstance, iLUN);
4457 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->StatReqsFailed, STAMTYPE_COUNTER, STAMVISIBILITY_USED, STAMUNIT_COUNT,
4458 "Number of I/O requests failed.", "/Devices/%s%u/Port%u/ReqsFailed", pszCtrlUpper, iInstance, iLUN);
4459 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->StatReqsSucceeded, STAMTYPE_COUNTER, STAMVISIBILITY_USED, STAMUNIT_COUNT,
4460 "Number of I/O requests succeeded.", "/Devices/%s%u/Port%u/ReqsSucceeded", pszCtrlUpper, iInstance, iLUN);
4461 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->StatReqsFlush, STAMTYPE_COUNTER, STAMVISIBILITY_USED, STAMUNIT_COUNT,
4462 "Number of flush I/O requests submitted.", "/Devices/%s%u/Port%u/ReqsFlush", pszCtrlUpper, iInstance, iLUN);
4463 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->StatReqsWrite, STAMTYPE_COUNTER, STAMVISIBILITY_USED, STAMUNIT_COUNT,
4464 "Number of write I/O requests submitted.", "/Devices/%s%u/Port%u/ReqsWrite", pszCtrlUpper, iInstance, iLUN);
4465 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->StatReqsRead, STAMTYPE_COUNTER, STAMVISIBILITY_USED, STAMUNIT_COUNT,
4466 "Number of read I/O requests submitted.", "/Devices/%s%u/Port%u/ReqsRead", pszCtrlUpper, iInstance, iLUN);
4467 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->StatReqsDiscard, STAMTYPE_COUNTER, STAMVISIBILITY_USED, STAMUNIT_COUNT,
4468 "Number of discard I/O requests submitted.", "/Devices/%s%u/Port%u/ReqsDiscard", pszCtrlUpper, iInstance, iLUN);
4469
4470 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->StatReqsPerSec, STAMTYPE_COUNTER, STAMVISIBILITY_USED, STAMUNIT_OCCURENCES,
4471 "Number of processed I/O requests per second.", "/Devices/%s%u/Port%u/ReqsPerSec",
4472 pszCtrlUpper, iInstance, iLUN);
4473
4474 RTStrFree(pszCtrlUpper);
4475 }
4476 else
4477 rc = VERR_NO_STR_MEMORY;
4478 }
4479
4480 return rc;
4481}
4482
4483/**
4484 * Deregisters statistics associated with the given media driver.
4485 *
4486 * @returns nothing.
4487 * @param pThis The media driver instance.
4488 */
4489static void drvvdStatsDeregister(PVBOXDISK pThis)
4490{
4491 PPDMDRVINS pDrvIns = pThis->pDrvIns;
4492
4493 PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->StatQueryBufAttempts);
4494 PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->StatQueryBufSuccess);
4495
4496 PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->StatBytesRead);
4497 PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->StatBytesWritten);
4498 PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->StatReqsSubmitted);
4499 PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->StatReqsFailed);
4500 PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->StatReqsSucceeded);
4501 PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->StatReqsFlush);
4502 PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->StatReqsWrite);
4503 PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->StatReqsRead);
4504 PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->StatReqsDiscard);
4505 PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->StatReqsPerSec);
4506}
4507
4508/*********************************************************************************************************************************
4509* Base interface methods *
4510*********************************************************************************************************************************/
4511
4512/**
4513 * @interface_method_impl{PDMIBASE,pfnQueryInterface}
4514 */
4515static DECLCALLBACK(void *) drvvdQueryInterface(PPDMIBASE pInterface, const char *pszIID)
4516{
4517 PPDMDRVINS pDrvIns = PDMIBASE_2_PDMDRV(pInterface);
4518 PVBOXDISK pThis = PDMINS_2_DATA(pDrvIns, PVBOXDISK);
4519
4520 PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASE, &pDrvIns->IBase);
4521 PDMIBASE_RETURN_INTERFACE(pszIID, PDMIMEDIA, &pThis->IMedia);
4522 PDMIBASE_RETURN_INTERFACE(pszIID, PDMIMOUNT, pThis->fMountable ? &pThis->IMount : NULL);
4523 PDMIBASE_RETURN_INTERFACE(pszIID, PDMIMEDIAEX, pThis->pDrvMediaExPort ? &pThis->IMediaEx : NULL);
4524 return NULL;
4525}
4526
4527
4528/*********************************************************************************************************************************
4529* Saved state notification methods *
4530*********************************************************************************************************************************/
4531
4532/**
4533 * Load done callback for re-opening the image writable during teleportation.
4534 *
4535 * This is called both for successful and failed load runs, we only care about
4536 * successful ones.
4537 *
4538 * @returns VBox status code.
4539 * @param pDrvIns The driver instance.
4540 * @param pSSM The saved state handle.
4541 */
4542static DECLCALLBACK(int) drvvdLoadDone(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM)
4543{
4544 PVBOXDISK pThis = PDMINS_2_DATA(pDrvIns, PVBOXDISK);
4545 Assert(!pThis->fErrorUseRuntime);
4546
4547 /* Drop out if we don't have any work to do or if it's a failed load. */
4548 if ( !pThis->fTempReadOnly
4549 || RT_FAILURE(SSMR3HandleGetStatus(pSSM)))
4550 return VINF_SUCCESS;
4551
4552 int rc = drvvdSetWritable(pThis);
4553 if (RT_FAILURE(rc)) /** @todo does the bugger set any errors? */
4554 return SSMR3SetLoadError(pSSM, rc, RT_SRC_POS,
4555 N_("Failed to write lock the images"));
4556 return VINF_SUCCESS;
4557}
4558
4559
4560/*********************************************************************************************************************************
4561* Driver methods *
4562*********************************************************************************************************************************/
4563
4564/**
4565 * Worker for the power off or destruct callback.
4566 *
4567 * @returns nothing.
4568 * @param pDrvIns The driver instance.
4569 */
4570static void drvvdPowerOffOrDestructOrUnmount(PPDMDRVINS pDrvIns)
4571{
4572 PVBOXDISK pThis = PDMINS_2_DATA(pDrvIns, PVBOXDISK);
4573 LogFlowFunc(("\n"));
4574
4575 RTSEMFASTMUTEX mutex;
4576 ASMAtomicXchgHandle(&pThis->MergeCompleteMutex, NIL_RTSEMFASTMUTEX, &mutex);
4577 if (mutex != NIL_RTSEMFASTMUTEX)
4578 {
4579 /* Request the semaphore to wait until a potentially running merge
4580 * operation has been finished. */
4581 int rc = RTSemFastMutexRequest(mutex);
4582 AssertRC(rc);
4583 pThis->fMergePending = false;
4584 rc = RTSemFastMutexRelease(mutex);
4585 AssertRC(rc);
4586 rc = RTSemFastMutexDestroy(mutex);
4587 AssertRC(rc);
4588 }
4589
4590 if (RT_VALID_PTR(pThis->pBlkCache))
4591 {
4592 PDMR3BlkCacheRelease(pThis->pBlkCache);
4593 pThis->pBlkCache = NULL;
4594 }
4595
4596 if (RT_VALID_PTR(pThis->pRegionList))
4597 {
4598 VDRegionListFree(pThis->pRegionList);
4599 pThis->pRegionList = NULL;
4600 }
4601
4602 if (RT_VALID_PTR(pThis->pDisk))
4603 {
4604 VDDestroy(pThis->pDisk);
4605 pThis->pDisk = NULL;
4606 }
4607 drvvdFreeImages(pThis);
4608}
4609
4610/**
4611 * @copydoc FNPDMDRVPOWEROFF
4612 */
4613static DECLCALLBACK(void) drvvdPowerOff(PPDMDRVINS pDrvIns)
4614{
4615 PDMDRV_CHECK_VERSIONS_RETURN_VOID(pDrvIns);
4616 drvvdPowerOffOrDestructOrUnmount(pDrvIns);
4617}
4618
4619/**
4620 * @callback_method_impl{FNPDMDRVRESUME}
4621 *
4622 * VM resume notification that we use to undo what the temporary read-only image
4623 * mode set by drvvdSuspend.
4624 *
4625 * Also switch to runtime error mode if we're resuming after a state load
4626 * without having been powered on first.
4627 *
4628 * @todo The VMSetError vs VMSetRuntimeError mess must be fixed elsewhere,
4629 * we're making assumptions about Main behavior here!
4630 */
4631static DECLCALLBACK(void) drvvdResume(PPDMDRVINS pDrvIns)
4632{
4633 LogFlowFunc(("\n"));
4634 PVBOXDISK pThis = PDMINS_2_DATA(pDrvIns, PVBOXDISK);
4635
4636 drvvdSetWritable(pThis);
4637 pThis->fErrorUseRuntime = true;
4638
4639 if (pThis->pBlkCache)
4640 {
4641 int rc = PDMR3BlkCacheResume(pThis->pBlkCache);
4642 AssertRC(rc);
4643 }
4644
4645 if (pThis->pDrvMediaExPort)
4646 {
4647 /* Kick of any request we have to redo. */
4648 PPDMMEDIAEXIOREQINT pIoReq, pIoReqNext;
4649 RTCritSectEnter(&pThis->CritSectIoReqRedo);
4650 RTListForEachSafe(&pThis->LstIoReqRedo, pIoReq, pIoReqNext, PDMMEDIAEXIOREQINT, NdLstWait)
4651 {
4652 int rc = VINF_SUCCESS;
4653 bool fXchg = ASMAtomicCmpXchgU32((volatile uint32_t *)&pIoReq->enmState, VDIOREQSTATE_ACTIVE, VDIOREQSTATE_SUSPENDED);
4654
4655 RTListNodeRemove(&pIoReq->NdLstWait);
4656 ASMAtomicIncU32(&pThis->cIoReqsActive);
4657
4658 if (fXchg)
4659 {
4660 pThis->pDrvMediaExPort->pfnIoReqStateChanged(pThis->pDrvMediaExPort, pIoReq, &pIoReq->abAlloc[0],
4661 PDMMEDIAEXIOREQSTATE_ACTIVE);
4662 if ( pIoReq->enmType == PDMMEDIAEXIOREQTYPE_READ
4663 || pIoReq->enmType == PDMMEDIAEXIOREQTYPE_WRITE)
4664 rc = drvvdMediaExIoReqReadWriteProcess(pThis, pIoReq, true /* fUpNotify */);
4665 else if (pIoReq->enmType == PDMMEDIAEXIOREQTYPE_FLUSH)
4666 {
4667 rc = drvvdMediaExIoReqFlushWrapper(pThis, pIoReq);
4668 if (rc == VERR_VD_ASYNC_IO_IN_PROGRESS)
4669 rc = VINF_PDM_MEDIAEX_IOREQ_IN_PROGRESS;
4670 else if (rc == VINF_VD_ASYNC_IO_FINISHED)
4671 rc = VINF_SUCCESS;
4672 }
4673 else if (pIoReq->enmType == PDMMEDIAEXIOREQTYPE_DISCARD)
4674 {
4675 rc = drvvdMediaExIoReqDiscardWrapper(pThis, pIoReq);
4676 if (rc == VERR_VD_ASYNC_IO_IN_PROGRESS)
4677 rc = VINF_PDM_MEDIAEX_IOREQ_IN_PROGRESS;
4678 else if (rc == VINF_VD_ASYNC_IO_FINISHED)
4679 rc = VINF_SUCCESS;
4680 }
4681 else
4682 AssertMsgFailed(("Invalid request type %u\n", pIoReq->enmType));
4683
4684 /* The read write process will call the completion callback on its own. */
4685 if ( rc != VINF_PDM_MEDIAEX_IOREQ_IN_PROGRESS
4686 && ( pIoReq->enmType == PDMMEDIAEXIOREQTYPE_DISCARD
4687 || pIoReq->enmType == PDMMEDIAEXIOREQTYPE_FLUSH))
4688 {
4689 Assert( ( pIoReq->enmType != PDMMEDIAEXIOREQTYPE_WRITE
4690 && pIoReq->enmType != PDMMEDIAEXIOREQTYPE_READ)
4691 || !pIoReq->ReadWrite.cbReqLeft
4692 || RT_FAILURE(rc));
4693 drvvdMediaExIoReqCompleteWorker(pThis, pIoReq, rc, true /* fUpNotify */);
4694 }
4695
4696 }
4697 else
4698 {
4699 /* Request was canceled inbetween, so don't care and notify the owner about the completed request. */
4700 Assert(pIoReq->enmState == VDIOREQSTATE_CANCELED);
4701 drvvdMediaExIoReqCompleteWorker(pThis, pIoReq, VERR_PDM_MEDIAEX_IOREQ_CANCELED, true /* fUpNotify */);
4702 }
4703 }
4704 Assert(RTListIsEmpty(&pThis->LstIoReqRedo));
4705 RTCritSectLeave(&pThis->CritSectIoReqRedo);
4706 }
4707}
4708
4709/**
4710 * @callback_method_impl{FNPDMDRVSUSPEND}
4711 *
4712 * When the VM is being suspended, temporarily change to read-only image mode.
4713 *
4714 * This is important for several reasons:
4715 * -# It makes sure that there are no pending writes to the image. Most
4716 * backends implements this by closing and reopening the image in read-only
4717 * mode.
4718 * -# It allows Main to read the images during snapshotting without having
4719 * to account for concurrent writes.
4720 * -# This is essential for making teleportation targets sharing images work
4721 * right. Both with regards to caching and with regards to file sharing
4722 * locks (RTFILE_O_DENY_*). (See also drvvdLoadDone.)
4723 */
4724static DECLCALLBACK(void) drvvdSuspend(PPDMDRVINS pDrvIns)
4725{
4726 LogFlowFunc(("\n"));
4727 PVBOXDISK pThis = PDMINS_2_DATA(pDrvIns, PVBOXDISK);
4728
4729 if (pThis->pBlkCache)
4730 {
4731 int rc = PDMR3BlkCacheSuspend(pThis->pBlkCache);
4732 AssertRC(rc);
4733 }
4734
4735 drvvdSetReadonly(pThis);
4736}
4737
4738/**
4739 * @callback_method_impl{FNPDMDRVPOWERON}
4740 */
4741static DECLCALLBACK(void) drvvdPowerOn(PPDMDRVINS pDrvIns)
4742{
4743 LogFlowFunc(("\n"));
4744 PVBOXDISK pThis = PDMINS_2_DATA(pDrvIns, PVBOXDISK);
4745 drvvdSetWritable(pThis);
4746 pThis->fErrorUseRuntime = true;
4747}
4748
4749/**
4750 * @callback_method_impl{FNPDMDRVRESET}
4751 */
4752static DECLCALLBACK(void) drvvdReset(PPDMDRVINS pDrvIns)
4753{
4754 LogFlowFunc(("\n"));
4755 PVBOXDISK pThis = PDMINS_2_DATA(pDrvIns, PVBOXDISK);
4756
4757 if (pThis->pBlkCache)
4758 {
4759 int rc = PDMR3BlkCacheClear(pThis->pBlkCache);
4760 AssertRC(rc);
4761 }
4762
4763 if (pThis->fBootAccelEnabled)
4764 {
4765 pThis->fBootAccelActive = true;
4766 pThis->cbDataValid = 0;
4767 pThis->offDisk = 0;
4768 }
4769}
4770
4771/**
4772 * @callback_method_impl{FNPDMDRVDESTRUCT}
4773 */
4774static DECLCALLBACK(void) drvvdDestruct(PPDMDRVINS pDrvIns)
4775{
4776 PDMDRV_CHECK_VERSIONS_RETURN_VOID(pDrvIns);
4777 PVBOXDISK pThis = PDMINS_2_DATA(pDrvIns, PVBOXDISK);
4778 LogFlowFunc(("\n"));
4779
4780 /*
4781 * Make sure the block cache and disks are closed when this driver is
4782 * destroyed. This method will get called without calling the power off
4783 * callback first when we reconfigure the driver chain after a snapshot.
4784 */
4785 drvvdPowerOffOrDestructOrUnmount(pDrvIns);
4786 if (pThis->MergeLock != NIL_RTSEMRW)
4787 {
4788 int rc = RTSemRWDestroy(pThis->MergeLock);
4789 AssertRC(rc);
4790 pThis->MergeLock = NIL_RTSEMRW;
4791 }
4792 if (pThis->pbData)
4793 {
4794 RTMemFree(pThis->pbData);
4795 pThis->pbData = NULL;
4796 }
4797 if (pThis->pszBwGroup)
4798 {
4799 MMR3HeapFree(pThis->pszBwGroup);
4800 pThis->pszBwGroup = NULL;
4801 }
4802 if (pThis->hHbdMgr != NIL_HBDMGR)
4803 HBDMgrDestroy(pThis->hHbdMgr);
4804 if (pThis->hIoReqCache != NIL_RTMEMCACHE)
4805 RTMemCacheDestroy(pThis->hIoReqCache);
4806 if (pThis->hIoBufMgr != NIL_IOBUFMGR)
4807 IOBUFMgrDestroy(pThis->hIoBufMgr);
4808 if (RTCritSectIsInitialized(&pThis->CritSectIoReqsIoBufWait))
4809 RTCritSectDelete(&pThis->CritSectIoReqsIoBufWait);
4810 if (RTCritSectIsInitialized(&pThis->CritSectIoReqRedo))
4811 RTCritSectDelete(&pThis->CritSectIoReqRedo);
4812 for (unsigned i = 0; i < RT_ELEMENTS(pThis->aIoReqAllocBins); i++)
4813 if (pThis->aIoReqAllocBins[i].hMtxLstIoReqAlloc != NIL_RTSEMFASTMUTEX)
4814 RTSemFastMutexDestroy(pThis->aIoReqAllocBins[i].hMtxLstIoReqAlloc);
4815
4816 drvvdStatsDeregister(pThis);
4817}
4818
4819/**
4820 * @callback_method_impl{FNPDMDRVCONSTRUCT,
4821 * Construct a VBox disk media driver instance.}
4822 */
4823static DECLCALLBACK(int) drvvdConstruct(PPDMDRVINS pDrvIns, PCFGMNODE pCfg, uint32_t fFlags)
4824{
4825 RT_NOREF(fFlags);
4826 LogFlowFunc(("\n"));
4827 PDMDRV_CHECK_VERSIONS_RETURN(pDrvIns);
4828 PVBOXDISK pThis = PDMINS_2_DATA(pDrvIns, PVBOXDISK);
4829 int rc = VINF_SUCCESS;
4830 char *pszName = NULL; /* The path of the disk image file. */
4831 char *pszFormat = NULL; /* The format backed to use for this image. */
4832 char *pszCachePath = NULL; /* The path to the cache image. */
4833 char *pszCacheFormat = NULL; /* The format backend to use for the cache image. */
4834 bool fReadOnly = false; /* True if the media is read-only. */
4835 bool fMaybeReadOnly = false; /* True if the media may or may not be read-only. */
4836 bool fHonorZeroWrites = false; /* True if zero blocks should be written. */
4837
4838 /*
4839 * Init the static parts.
4840 */
4841 pDrvIns->IBase.pfnQueryInterface = drvvdQueryInterface;
4842 pThis->pDrvIns = pDrvIns;
4843 pThis->fTempReadOnly = false;
4844 pThis->pDisk = NULL;
4845 pThis->fAsyncIOSupported = false;
4846 pThis->fShareable = false;
4847 pThis->fMergePending = false;
4848 pThis->MergeCompleteMutex = NIL_RTSEMFASTMUTEX;
4849 pThis->MergeLock = NIL_RTSEMRW;
4850 pThis->uMergeSource = VD_LAST_IMAGE;
4851 pThis->uMergeTarget = VD_LAST_IMAGE;
4852 pThis->pCfgCrypto = NULL;
4853 pThis->pIfSecKey = NULL;
4854 pThis->hIoReqCache = NIL_RTMEMCACHE;
4855 pThis->hIoBufMgr = NIL_IOBUFMGR;
4856 pThis->pRegionList = NULL;
4857
4858 for (unsigned i = 0; i < RT_ELEMENTS(pThis->aIoReqAllocBins); i++)
4859 pThis->aIoReqAllocBins[i].hMtxLstIoReqAlloc = NIL_RTSEMFASTMUTEX;
4860
4861 /* IMedia */
4862 pThis->IMedia.pfnRead = drvvdRead;
4863 pThis->IMedia.pfnReadPcBios = drvvdReadPcBios;
4864 pThis->IMedia.pfnWrite = drvvdWrite;
4865 pThis->IMedia.pfnFlush = drvvdFlush;
4866 pThis->IMedia.pfnMerge = drvvdMerge;
4867 pThis->IMedia.pfnSetSecKeyIf = drvvdSetSecKeyIf;
4868 pThis->IMedia.pfnGetSize = drvvdGetSize;
4869 pThis->IMedia.pfnGetSectorSize = drvvdGetSectorSize;
4870 pThis->IMedia.pfnIsReadOnly = drvvdIsReadOnly;
4871 pThis->IMedia.pfnIsNonRotational = drvvdIsNonRotational;
4872 pThis->IMedia.pfnBiosGetPCHSGeometry = drvvdBiosGetPCHSGeometry;
4873 pThis->IMedia.pfnBiosSetPCHSGeometry = drvvdBiosSetPCHSGeometry;
4874 pThis->IMedia.pfnBiosGetLCHSGeometry = drvvdBiosGetLCHSGeometry;
4875 pThis->IMedia.pfnBiosSetLCHSGeometry = drvvdBiosSetLCHSGeometry;
4876 pThis->IMedia.pfnBiosIsVisible = drvvdBiosIsVisible;
4877 pThis->IMedia.pfnGetType = drvvdGetType;
4878 pThis->IMedia.pfnGetUuid = drvvdGetUuid;
4879 pThis->IMedia.pfnDiscard = drvvdDiscard;
4880 pThis->IMedia.pfnSendCmd = NULL;
4881 pThis->IMedia.pfnGetRegionCount = drvvdGetRegionCount;
4882 pThis->IMedia.pfnQueryRegionProperties = drvvdQueryRegionProperties;
4883 pThis->IMedia.pfnQueryRegionPropertiesForLba = drvvdQueryRegionPropertiesForLba;
4884
4885 /* IMount */
4886 pThis->IMount.pfnUnmount = drvvdUnmount;
4887 pThis->IMount.pfnIsMounted = drvvdIsMounted;
4888 pThis->IMount.pfnLock = drvvdLock;
4889 pThis->IMount.pfnUnlock = drvvdUnlock;
4890 pThis->IMount.pfnIsLocked = drvvdIsLocked;
4891
4892 /* IMediaEx */
4893 pThis->IMediaEx.pfnQueryFeatures = drvvdQueryFeatures;
4894 pThis->IMediaEx.pfnIoReqAllocSizeSet = drvvdIoReqAllocSizeSet;
4895 pThis->IMediaEx.pfnIoReqAlloc = drvvdIoReqAlloc;
4896 pThis->IMediaEx.pfnIoReqFree = drvvdIoReqFree;
4897 pThis->IMediaEx.pfnIoReqQueryResidual = drvvdIoReqQueryResidual;
4898 pThis->IMediaEx.pfnIoReqQueryXferSize = drvvdIoReqQueryXferSize;
4899 pThis->IMediaEx.pfnIoReqCancelAll = drvvdIoReqCancelAll;
4900 pThis->IMediaEx.pfnIoReqCancel = drvvdIoReqCancel;
4901 pThis->IMediaEx.pfnIoReqRead = drvvdIoReqRead;
4902 pThis->IMediaEx.pfnIoReqWrite = drvvdIoReqWrite;
4903 pThis->IMediaEx.pfnIoReqFlush = drvvdIoReqFlush;
4904 pThis->IMediaEx.pfnIoReqDiscard = drvvdIoReqDiscard;
4905 pThis->IMediaEx.pfnIoReqSendScsiCmd = drvvdIoReqSendScsiCmd;
4906 pThis->IMediaEx.pfnIoReqGetActiveCount = drvvdIoReqGetActiveCount;
4907 pThis->IMediaEx.pfnIoReqGetSuspendedCount = drvvdIoReqGetSuspendedCount;
4908 pThis->IMediaEx.pfnIoReqQuerySuspendedStart = drvvdIoReqQuerySuspendedStart;
4909 pThis->IMediaEx.pfnIoReqQuerySuspendedNext = drvvdIoReqQuerySuspendedNext;
4910 pThis->IMediaEx.pfnIoReqSuspendedSave = drvvdIoReqSuspendedSave;
4911 pThis->IMediaEx.pfnIoReqSuspendedLoad = drvvdIoReqSuspendedLoad;
4912
4913 /* Initialize supported VD interfaces. */
4914 pThis->pVDIfsDisk = NULL;
4915
4916 pThis->VDIfError.pfnError = drvvdErrorCallback;
4917 pThis->VDIfError.pfnMessage = NULL;
4918 rc = VDInterfaceAdd(&pThis->VDIfError.Core, "DrvVD_VDIError", VDINTERFACETYPE_ERROR,
4919 pDrvIns, sizeof(VDINTERFACEERROR), &pThis->pVDIfsDisk);
4920 AssertRC(rc);
4921
4922 /* List of images is empty now. */
4923 pThis->pImages = NULL;
4924
4925 pThis->pDrvMediaPort = PDMIBASE_QUERY_INTERFACE(pDrvIns->pUpBase, PDMIMEDIAPORT);
4926 if (!pThis->pDrvMediaPort)
4927 return PDMDRV_SET_ERROR(pDrvIns, VERR_PDM_MISSING_INTERFACE_ABOVE,
4928 N_("No media port interface above"));
4929
4930 pThis->pDrvMountNotify = PDMIBASE_QUERY_INTERFACE(pDrvIns->pUpBase, PDMIMOUNTNOTIFY);
4931
4932 /*
4933 * Try to attach the optional extended media interface port above and initialize associated
4934 * structures if available.
4935 */
4936 pThis->pDrvMediaExPort = PDMIBASE_QUERY_INTERFACE(pDrvIns->pUpBase, PDMIMEDIAEXPORT);
4937 if (pThis->pDrvMediaExPort)
4938 {
4939 for (unsigned i = 0; i < RT_ELEMENTS(pThis->aIoReqAllocBins); i++)
4940 {
4941 rc = RTSemFastMutexCreate(&pThis->aIoReqAllocBins[i].hMtxLstIoReqAlloc);
4942 if (RT_FAILURE(rc))
4943 break;
4944 RTListInit(&pThis->aIoReqAllocBins[i].LstIoReqAlloc);
4945 }
4946
4947 if (RT_SUCCESS(rc))
4948 rc = RTCritSectInit(&pThis->CritSectIoReqsIoBufWait);
4949
4950 if (RT_SUCCESS(rc))
4951 rc = RTCritSectInit(&pThis->CritSectIoReqRedo);
4952
4953 if (RT_FAILURE(rc))
4954 return PDMDRV_SET_ERROR(pDrvIns, rc, N_("Creating Mutex failed"));
4955
4956 RTListInit(&pThis->LstIoReqIoBufWait);
4957 RTListInit(&pThis->LstIoReqRedo);
4958 }
4959
4960 /* Before we access any VD API load all given plugins. */
4961 rc = drvvdLoadPlugins(pCfg);
4962 if (RT_FAILURE(rc))
4963 return PDMDRV_SET_ERROR(pDrvIns, rc, N_("Loading VD plugins failed"));
4964
4965 /*
4966 * Validate configuration and find all parent images.
4967 * It's sort of up side down from the image dependency tree.
4968 */
4969 bool fHostIP = false;
4970 bool fUseNewIo = false;
4971 bool fUseBlockCache = false;
4972 bool fDiscard = false;
4973 bool fInformAboutZeroBlocks = false;
4974 bool fSkipConsistencyChecks = false;
4975 bool fEmptyDrive = false;
4976 unsigned iLevel = 0;
4977 PCFGMNODE pCurNode = pCfg;
4978 uint32_t cbIoBufMax = 0;
4979
4980 for (;;)
4981 {
4982 bool fValid;
4983
4984 if (pCurNode == pCfg)
4985 {
4986 /* Toplevel configuration additionally contains the global image
4987 * open flags. Some might be converted to per-image flags later. */
4988 fValid = CFGMR3AreValuesValid(pCurNode,
4989 "Format\0Path\0"
4990 "ReadOnly\0MaybeReadOnly\0TempReadOnly\0Shareable\0HonorZeroWrites\0"
4991 "HostIPStack\0UseNewIo\0BootAcceleration\0BootAccelerationBuffer\0"
4992 "SetupMerge\0MergeSource\0MergeTarget\0BwGroup\0Type\0BlockCache\0"
4993 "CachePath\0CacheFormat\0Discard\0InformAboutZeroBlocks\0"
4994 "SkipConsistencyChecks\0"
4995 "Locked\0BIOSVisible\0Cylinders\0Heads\0Sectors\0Mountable\0"
4996 "EmptyDrive\0IoBufMax\0NonRotationalMedium\0"
4997#if defined(VBOX_PERIODIC_FLUSH) || defined(VBOX_IGNORE_FLUSH)
4998 "FlushInterval\0IgnoreFlush\0IgnoreFlushAsync\0"
4999#endif /* !(VBOX_PERIODIC_FLUSH || VBOX_IGNORE_FLUSH) */
5000 );
5001 }
5002 else
5003 {
5004 /* All other image configurations only contain image name and
5005 * the format information. */
5006 fValid = CFGMR3AreValuesValid(pCurNode, "Format\0Path\0"
5007 "MergeSource\0MergeTarget\0");
5008 }
5009 if (!fValid)
5010 {
5011 rc = PDMDrvHlpVMSetError(pDrvIns, VERR_PDM_DRVINS_UNKNOWN_CFG_VALUES,
5012 RT_SRC_POS, N_("DrvVD: Configuration error: keys incorrect at level %d"), iLevel);
5013 break;
5014 }
5015
5016 if (pCurNode == pCfg)
5017 {
5018 rc = CFGMR3QueryBoolDef(pCurNode, "HostIPStack", &fHostIP, true);
5019 if (RT_FAILURE(rc))
5020 {
5021 rc = PDMDRV_SET_ERROR(pDrvIns, rc,
5022 N_("DrvVD: Configuration error: Querying \"HostIPStack\" as boolean failed"));
5023 break;
5024 }
5025
5026 rc = CFGMR3QueryBoolDef(pCurNode, "HonorZeroWrites", &fHonorZeroWrites, false);
5027 if (RT_FAILURE(rc))
5028 {
5029 rc = PDMDRV_SET_ERROR(pDrvIns, rc,
5030 N_("DrvVD: Configuration error: Querying \"HonorZeroWrites\" as boolean failed"));
5031 break;
5032 }
5033
5034 rc = CFGMR3QueryBoolDef(pCurNode, "ReadOnly", &fReadOnly, false);
5035 if (RT_FAILURE(rc))
5036 {
5037 rc = PDMDRV_SET_ERROR(pDrvIns, rc,
5038 N_("DrvVD: Configuration error: Querying \"ReadOnly\" as boolean failed"));
5039 break;
5040 }
5041
5042 rc = CFGMR3QueryBoolDef(pCurNode, "MaybeReadOnly", &fMaybeReadOnly, false);
5043 if (RT_FAILURE(rc))
5044 {
5045 rc = PDMDRV_SET_ERROR(pDrvIns, rc,
5046 N_("DrvVD: Configuration error: Querying \"MaybeReadOnly\" as boolean failed"));
5047 break;
5048 }
5049
5050 rc = CFGMR3QueryBoolDef(pCurNode, "TempReadOnly", &pThis->fTempReadOnly, false);
5051 if (RT_FAILURE(rc))
5052 {
5053 rc = PDMDRV_SET_ERROR(pDrvIns, rc,
5054 N_("DrvVD: Configuration error: Querying \"TempReadOnly\" as boolean failed"));
5055 break;
5056 }
5057 if (fReadOnly && pThis->fTempReadOnly)
5058 {
5059 rc = PDMDRV_SET_ERROR(pDrvIns, VERR_PDM_DRIVER_INVALID_PROPERTIES,
5060 N_("DrvVD: Configuration error: Both \"ReadOnly\" and \"TempReadOnly\" are set"));
5061 break;
5062 }
5063
5064 rc = CFGMR3QueryBoolDef(pCurNode, "Shareable", &pThis->fShareable, false);
5065 if (RT_FAILURE(rc))
5066 {
5067 rc = PDMDRV_SET_ERROR(pDrvIns, rc,
5068 N_("DrvVD: Configuration error: Querying \"Shareable\" as boolean failed"));
5069 break;
5070 }
5071
5072 rc = CFGMR3QueryBoolDef(pCurNode, "UseNewIo", &fUseNewIo, false);
5073 if (RT_FAILURE(rc))
5074 {
5075 rc = PDMDRV_SET_ERROR(pDrvIns, rc,
5076 N_("DrvVD: Configuration error: Querying \"UseNewIo\" as boolean failed"));
5077 break;
5078 }
5079 rc = CFGMR3QueryBoolDef(pCurNode, "SetupMerge", &pThis->fMergePending, false);
5080 if (RT_FAILURE(rc))
5081 {
5082 rc = PDMDRV_SET_ERROR(pDrvIns, rc,
5083 N_("DrvVD: Configuration error: Querying \"SetupMerge\" as boolean failed"));
5084 break;
5085 }
5086 if (fReadOnly && pThis->fMergePending)
5087 {
5088 rc = PDMDRV_SET_ERROR(pDrvIns, VERR_PDM_DRIVER_INVALID_PROPERTIES,
5089 N_("DrvVD: Configuration error: Both \"ReadOnly\" and \"MergePending\" are set"));
5090 break;
5091 }
5092 rc = CFGMR3QueryBoolDef(pCurNode, "BootAcceleration", &pThis->fBootAccelEnabled, false);
5093 if (RT_FAILURE(rc))
5094 {
5095 rc = PDMDRV_SET_ERROR(pDrvIns, rc,
5096 N_("DrvVD: Configuration error: Querying \"BootAcceleration\" as boolean failed"));
5097 break;
5098 }
5099 rc = CFGMR3QueryU32Def(pCurNode, "BootAccelerationBuffer", (uint32_t *)&pThis->cbBootAccelBuffer, 16 * _1K);
5100 if (RT_FAILURE(rc))
5101 {
5102 rc = PDMDRV_SET_ERROR(pDrvIns, rc,
5103 N_("DrvVD: Configuration error: Querying \"BootAccelerationBuffer\" as integer failed"));
5104 break;
5105 }
5106 rc = CFGMR3QueryBoolDef(pCurNode, "BlockCache", &fUseBlockCache, false);
5107 if (RT_FAILURE(rc))
5108 {
5109 rc = PDMDRV_SET_ERROR(pDrvIns, rc,
5110 N_("DrvVD: Configuration error: Querying \"BlockCache\" as boolean failed"));
5111 break;
5112 }
5113 rc = CFGMR3QueryStringAlloc(pCurNode, "BwGroup", &pThis->pszBwGroup);
5114 if (RT_FAILURE(rc) && rc != VERR_CFGM_VALUE_NOT_FOUND)
5115 {
5116 rc = PDMDRV_SET_ERROR(pDrvIns, rc,
5117 N_("DrvVD: Configuration error: Querying \"BwGroup\" as string failed"));
5118 break;
5119 }
5120 else
5121 rc = VINF_SUCCESS;
5122 rc = CFGMR3QueryBoolDef(pCurNode, "Discard", &fDiscard, false);
5123 if (RT_FAILURE(rc))
5124 {
5125 rc = PDMDRV_SET_ERROR(pDrvIns, rc,
5126 N_("DrvVD: Configuration error: Querying \"Discard\" as boolean failed"));
5127 break;
5128 }
5129 if (fReadOnly && fDiscard)
5130 {
5131 rc = PDMDRV_SET_ERROR(pDrvIns, VERR_PDM_DRIVER_INVALID_PROPERTIES,
5132 N_("DrvVD: Configuration error: Both \"ReadOnly\" and \"Discard\" are set"));
5133 break;
5134 }
5135 rc = CFGMR3QueryBoolDef(pCurNode, "InformAboutZeroBlocks", &fInformAboutZeroBlocks, false);
5136 if (RT_FAILURE(rc))
5137 {
5138 rc = PDMDRV_SET_ERROR(pDrvIns, rc,
5139 N_("DrvVD: Configuration error: Querying \"InformAboutZeroBlocks\" as boolean failed"));
5140 break;
5141 }
5142 rc = CFGMR3QueryBoolDef(pCurNode, "SkipConsistencyChecks", &fSkipConsistencyChecks, true);
5143 if (RT_FAILURE(rc))
5144 {
5145 rc = PDMDRV_SET_ERROR(pDrvIns, rc,
5146 N_("DrvVD: Configuration error: Querying \"SKipConsistencyChecks\" as boolean failed"));
5147 break;
5148 }
5149
5150 char *psz = NULL;
5151 rc = CFGMR3QueryStringAlloc(pCfg, "Type", &psz);
5152 if (RT_FAILURE(rc))
5153 return PDMDRV_SET_ERROR(pDrvIns, VERR_PDM_BLOCK_NO_TYPE, N_("Failed to obtain the sub type"));
5154 pThis->enmType = drvvdGetMediaTypeFromString(psz);
5155 if (pThis->enmType == PDMMEDIATYPE_ERROR)
5156 {
5157 PDMDrvHlpVMSetError(pDrvIns, VERR_PDM_BLOCK_UNKNOWN_TYPE, RT_SRC_POS,
5158 N_("Unknown type \"%s\""), psz);
5159 MMR3HeapFree(psz);
5160 return VERR_PDM_BLOCK_UNKNOWN_TYPE;
5161 }
5162 MMR3HeapFree(psz); psz = NULL;
5163
5164 rc = CFGMR3QueryStringAlloc(pCurNode, "CachePath", &pszCachePath);
5165 if (RT_FAILURE(rc) && rc != VERR_CFGM_VALUE_NOT_FOUND)
5166 {
5167 rc = PDMDRV_SET_ERROR(pDrvIns, rc,
5168 N_("DrvVD: Configuration error: Querying \"CachePath\" as string failed"));
5169 break;
5170 }
5171 else
5172 rc = VINF_SUCCESS;
5173
5174 if (pszCachePath)
5175 {
5176 rc = CFGMR3QueryStringAlloc(pCurNode, "CacheFormat", &pszCacheFormat);
5177 if (RT_FAILURE(rc))
5178 {
5179 rc = PDMDRV_SET_ERROR(pDrvIns, rc,
5180 N_("DrvVD: Configuration error: Querying \"CacheFormat\" as string failed"));
5181 break;
5182 }
5183 }
5184
5185 /* Mountable */
5186 rc = CFGMR3QueryBoolDef(pCfg, "Mountable", &pThis->fMountable, false);
5187 if (RT_FAILURE(rc))
5188 return PDMDRV_SET_ERROR(pDrvIns, rc, N_("Failed to query \"Mountable\" from the config"));
5189
5190 /* Locked */
5191 rc = CFGMR3QueryBoolDef(pCfg, "Locked", &pThis->fLocked, false);
5192 if (RT_FAILURE(rc))
5193 return PDMDRV_SET_ERROR(pDrvIns, rc, N_("Failed to query \"Locked\" from the config"));
5194
5195 /* BIOS visible */
5196 rc = CFGMR3QueryBoolDef(pCfg, "BIOSVisible", &pThis->fBiosVisible, true);
5197 if (RT_FAILURE(rc))
5198 return PDMDRV_SET_ERROR(pDrvIns, rc, N_("Failed to query \"BIOSVisible\" from the config"));
5199
5200 /* Cylinders */
5201 rc = CFGMR3QueryU32Def(pCfg, "Cylinders", &pThis->LCHSGeometry.cCylinders, 0);
5202 if (RT_FAILURE(rc))
5203 return PDMDRV_SET_ERROR(pDrvIns, rc, N_("Failed to query \"Cylinders\" from the config"));
5204
5205 /* Heads */
5206 rc = CFGMR3QueryU32Def(pCfg, "Heads", &pThis->LCHSGeometry.cHeads, 0);
5207 if (RT_FAILURE(rc))
5208 return PDMDRV_SET_ERROR(pDrvIns, rc, N_("Failed to query \"Heads\" from the config"));
5209
5210 /* Sectors */
5211 rc = CFGMR3QueryU32Def(pCfg, "Sectors", &pThis->LCHSGeometry.cSectors, 0);
5212 if (RT_FAILURE(rc))
5213 return PDMDRV_SET_ERROR(pDrvIns, rc, N_("Failed to query \"Sectors\" from the config"));
5214
5215 /* Uuid */
5216 rc = CFGMR3QueryStringAlloc(pCfg, "Uuid", &psz);
5217 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
5218 RTUuidClear(&pThis->Uuid);
5219 else if (RT_SUCCESS(rc))
5220 {
5221 rc = RTUuidFromStr(&pThis->Uuid, psz);
5222 if (RT_FAILURE(rc))
5223 {
5224 PDMDrvHlpVMSetError(pDrvIns, rc, RT_SRC_POS, N_("Uuid from string failed on \"%s\""), psz);
5225 MMR3HeapFree(psz);
5226 return rc;
5227 }
5228 MMR3HeapFree(psz); psz = NULL;
5229 }
5230 else
5231 return PDMDRV_SET_ERROR(pDrvIns, rc, N_("Failed to query \"Uuid\" from the config"));
5232
5233#ifdef VBOX_PERIODIC_FLUSH
5234 rc = CFGMR3QueryU32Def(pCfg, "FlushInterval", &pThis->cbFlushInterval, 0);
5235 if (RT_FAILURE(rc))
5236 return PDMDRV_SET_ERROR(pDrvIns, rc, N_("Failed to query \"FlushInterval\" from the config"));
5237#endif /* VBOX_PERIODIC_FLUSH */
5238
5239#ifdef VBOX_IGNORE_FLUSH
5240 rc = CFGMR3QueryBoolDef(pCfg, "IgnoreFlush", &pThis->fIgnoreFlush, true);
5241 if (RT_FAILURE(rc))
5242 return PDMDRV_SET_ERROR(pDrvIns, rc, N_("Failed to query \"IgnoreFlush\" from the config"));
5243
5244 if (pThis->fIgnoreFlush)
5245 LogRel(("DrvVD: Flushes will be ignored\n"));
5246 else
5247 LogRel(("DrvVD: Flushes will be passed to the disk\n"));
5248
5249 rc = CFGMR3QueryBoolDef(pCfg, "IgnoreFlushAsync", &pThis->fIgnoreFlushAsync, false);
5250 if (RT_FAILURE(rc))
5251 return PDMDRV_SET_ERROR(pDrvIns, rc, N_("Failed to query \"IgnoreFlushAsync\" from the config"));
5252
5253 if (pThis->fIgnoreFlushAsync)
5254 LogRel(("DrvVD: Async flushes will be ignored\n"));
5255 else
5256 LogRel(("DrvVD: Async flushes will be passed to the disk\n"));
5257#endif /* VBOX_IGNORE_FLUSH */
5258
5259 rc = CFGMR3QueryBoolDef(pCurNode, "EmptyDrive", &fEmptyDrive, false);
5260 if (RT_FAILURE(rc))
5261 {
5262 rc = PDMDRV_SET_ERROR(pDrvIns, rc,
5263 N_("DrvVD: Configuration error: Querying \"EmptyDrive\" as boolean failed"));
5264 break;
5265 }
5266
5267 rc = CFGMR3QueryU32Def(pCfg, "IoBufMax", &cbIoBufMax, 5 * _1M);
5268 if (RT_FAILURE(rc))
5269 return PDMDRV_SET_ERROR(pDrvIns, rc, N_("Failed to query \"IoBufMax\" from the config"));
5270
5271 rc = CFGMR3QueryBoolDef(pCfg, "NonRotationalMedium", &pThis->fNonRotational, false);
5272 if (RT_FAILURE(rc))
5273 return PDMDRV_SET_ERROR(pDrvIns, rc,
5274 N_("DrvVD configuration error: Querying \"NonRotationalMedium\" as boolean failed"));
5275 }
5276
5277 PCFGMNODE pParent = CFGMR3GetChild(pCurNode, "Parent");
5278 if (!pParent)
5279 break;
5280 pCurNode = pParent;
5281 iLevel++;
5282 }
5283
5284 if (pThis->pDrvMediaExPort)
5285 rc = IOBUFMgrCreate(&pThis->hIoBufMgr, cbIoBufMax, pThis->pCfgCrypto ? IOBUFMGR_F_REQUIRE_NOT_PAGABLE : IOBUFMGR_F_DEFAULT);
5286
5287 if ( !fEmptyDrive
5288 && RT_SUCCESS(rc))
5289 {
5290 /*
5291 * Create the image container and the necessary interfaces.
5292 */
5293 if (RT_SUCCESS(rc))
5294 {
5295 /*
5296 * The image has a bandwidth group but the host cache is enabled.
5297 * Use the async I/O framework but tell it to enable the host cache.
5298 */
5299 if (!fUseNewIo && pThis->pszBwGroup)
5300 {
5301 pThis->fAsyncIoWithHostCache = true;
5302 fUseNewIo = true;
5303 }
5304
5305 /** @todo quick hack to work around problems in the async I/O
5306 * implementation (rw semaphore thread ownership problem)
5307 * while a merge is running. Remove once this is fixed. */
5308 if (pThis->fMergePending)
5309 fUseNewIo = false;
5310
5311 if (RT_SUCCESS(rc) && pThis->fMergePending)
5312 {
5313 rc = RTSemFastMutexCreate(&pThis->MergeCompleteMutex);
5314 if (RT_SUCCESS(rc))
5315 rc = RTSemRWCreate(&pThis->MergeLock);
5316 if (RT_SUCCESS(rc))
5317 {
5318 pThis->VDIfThreadSync.pfnStartRead = drvvdThreadStartRead;
5319 pThis->VDIfThreadSync.pfnFinishRead = drvvdThreadFinishRead;
5320 pThis->VDIfThreadSync.pfnStartWrite = drvvdThreadStartWrite;
5321 pThis->VDIfThreadSync.pfnFinishWrite = drvvdThreadFinishWrite;
5322
5323 rc = VDInterfaceAdd(&pThis->VDIfThreadSync.Core, "DrvVD_ThreadSync", VDINTERFACETYPE_THREADSYNC,
5324 pThis, sizeof(VDINTERFACETHREADSYNC), &pThis->pVDIfsDisk);
5325 }
5326 else
5327 {
5328 rc = PDMDRV_SET_ERROR(pDrvIns, rc,
5329 N_("DrvVD: Failed to create semaphores for \"MergePending\""));
5330 }
5331 }
5332
5333 if (RT_SUCCESS(rc))
5334 {
5335 rc = VDCreate(pThis->pVDIfsDisk, drvvdGetVDFromMediaType(pThis->enmType), &pThis->pDisk);
5336 /* Error message is already set correctly. */
5337 }
5338 }
5339
5340 if (pThis->pDrvMediaExPort && fUseNewIo)
5341 pThis->fAsyncIOSupported = true;
5342
5343 uint64_t tsStart = RTTimeNanoTS();
5344
5345 unsigned iImageIdx = 0;
5346 while (pCurNode && RT_SUCCESS(rc))
5347 {
5348 /* Allocate per-image data. */
5349 PVBOXIMAGE pImage = drvvdNewImage(pThis);
5350 if (!pImage)
5351 {
5352 rc = VERR_NO_MEMORY;
5353 break;
5354 }
5355
5356 /*
5357 * Read the image configuration.
5358 */
5359 rc = CFGMR3QueryStringAlloc(pCurNode, "Path", &pszName);
5360 if (RT_FAILURE(rc))
5361 {
5362 rc = PDMDRV_SET_ERROR(pDrvIns, rc,
5363 N_("DrvVD: Configuration error: Querying \"Path\" as string failed"));
5364 break;
5365 }
5366
5367 rc = CFGMR3QueryStringAlloc(pCurNode, "Format", &pszFormat);
5368 if (RT_FAILURE(rc))
5369 {
5370 rc = PDMDRV_SET_ERROR(pDrvIns, rc,
5371 N_("DrvVD: Configuration error: Querying \"Format\" as string failed"));
5372 break;
5373 }
5374
5375 bool fMergeSource;
5376 rc = CFGMR3QueryBoolDef(pCurNode, "MergeSource", &fMergeSource, false);
5377 if (RT_FAILURE(rc))
5378 {
5379 rc = PDMDRV_SET_ERROR(pDrvIns, rc,
5380 N_("DrvVD: Configuration error: Querying \"MergeSource\" as boolean failed"));
5381 break;
5382 }
5383 if (fMergeSource)
5384 {
5385 if (pThis->uMergeSource == VD_LAST_IMAGE)
5386 pThis->uMergeSource = iImageIdx;
5387 else
5388 {
5389 rc = PDMDRV_SET_ERROR(pDrvIns, VERR_PDM_DRIVER_INVALID_PROPERTIES,
5390 N_("DrvVD: Configuration error: Multiple \"MergeSource\" occurrences"));
5391 break;
5392 }
5393 }
5394
5395 bool fMergeTarget;
5396 rc = CFGMR3QueryBoolDef(pCurNode, "MergeTarget", &fMergeTarget, false);
5397 if (RT_FAILURE(rc))
5398 {
5399 rc = PDMDRV_SET_ERROR(pDrvIns, rc,
5400 N_("DrvVD: Configuration error: Querying \"MergeTarget\" as boolean failed"));
5401 break;
5402 }
5403 if (fMergeTarget)
5404 {
5405 if (pThis->uMergeTarget == VD_LAST_IMAGE)
5406 pThis->uMergeTarget = iImageIdx;
5407 else
5408 {
5409 rc = PDMDRV_SET_ERROR(pDrvIns, VERR_PDM_DRIVER_INVALID_PROPERTIES,
5410 N_("DrvVD: Configuration error: Multiple \"MergeTarget\" occurrences"));
5411 break;
5412 }
5413 }
5414
5415 PCFGMNODE pCfgVDConfig = CFGMR3GetChild(pCurNode, "VDConfig");
5416 pImage->VDIfConfig.pfnAreKeysValid = drvvdCfgAreKeysValid;
5417 pImage->VDIfConfig.pfnQuerySize = drvvdCfgQuerySize;
5418 pImage->VDIfConfig.pfnQuery = drvvdCfgQuery;
5419 pImage->VDIfConfig.pfnQueryBytes = NULL;
5420 rc = VDInterfaceAdd(&pImage->VDIfConfig.Core, "DrvVD_Config", VDINTERFACETYPE_CONFIG,
5421 pCfgVDConfig, sizeof(VDINTERFACECONFIG), &pImage->pVDIfsImage);
5422 AssertRC(rc);
5423
5424 /* Check VDConfig for encryption config. */
5425 if (pCfgVDConfig)
5426 pThis->pCfgCrypto = CFGMR3GetChild(pCfgVDConfig, "CRYPT");
5427
5428 if (pThis->pCfgCrypto)
5429 {
5430 /* Setup VDConfig interface for disk encryption support. */
5431 pThis->VDIfCfg.pfnAreKeysValid = drvvdCfgAreKeysValid;
5432 pThis->VDIfCfg.pfnQuerySize = drvvdCfgQuerySize;
5433 pThis->VDIfCfg.pfnQuery = drvvdCfgQuery;
5434 pThis->VDIfCfg.pfnQueryBytes = NULL;
5435
5436 pThis->VDIfCrypto.pfnKeyRetain = drvvdCryptoKeyRetain;
5437 pThis->VDIfCrypto.pfnKeyRelease = drvvdCryptoKeyRelease;
5438 pThis->VDIfCrypto.pfnKeyStorePasswordRetain = drvvdCryptoKeyStorePasswordRetain;
5439 pThis->VDIfCrypto.pfnKeyStorePasswordRelease = drvvdCryptoKeyStorePasswordRelease;
5440 }
5441
5442 /* Unconditionally insert the TCPNET interface, don't bother to check
5443 * if an image really needs it. Will be ignored. Since the TCPNET
5444 * interface is per image we could make this more flexible in the
5445 * future if we want to. */
5446 /* Construct TCPNET callback table depending on the config. This is
5447 * done unconditionally, as uninterested backends will ignore it. */
5448 if (fHostIP)
5449 {
5450 pImage->VDIfTcpNet.pfnSocketCreate = drvvdTcpSocketCreate;
5451 pImage->VDIfTcpNet.pfnSocketDestroy = drvvdTcpSocketDestroy;
5452 pImage->VDIfTcpNet.pfnClientConnect = drvvdTcpClientConnect;
5453 pImage->VDIfTcpNet.pfnIsClientConnected = drvvdTcpIsClientConnected;
5454 pImage->VDIfTcpNet.pfnClientClose = drvvdTcpClientClose;
5455 pImage->VDIfTcpNet.pfnSelectOne = drvvdTcpSelectOne;
5456 pImage->VDIfTcpNet.pfnRead = drvvdTcpRead;
5457 pImage->VDIfTcpNet.pfnWrite = drvvdTcpWrite;
5458 pImage->VDIfTcpNet.pfnSgWrite = drvvdTcpSgWrite;
5459 pImage->VDIfTcpNet.pfnReadNB = drvvdTcpReadNB;
5460 pImage->VDIfTcpNet.pfnWriteNB = drvvdTcpWriteNB;
5461 pImage->VDIfTcpNet.pfnSgWriteNB = drvvdTcpSgWriteNB;
5462 pImage->VDIfTcpNet.pfnFlush = drvvdTcpFlush;
5463 pImage->VDIfTcpNet.pfnSetSendCoalescing = drvvdTcpSetSendCoalescing;
5464 pImage->VDIfTcpNet.pfnGetLocalAddress = drvvdTcpGetLocalAddress;
5465 pImage->VDIfTcpNet.pfnGetPeerAddress = drvvdTcpGetPeerAddress;
5466
5467 /*
5468 * There is a 15ms delay between receiving the data and marking the socket
5469 * as readable on Windows XP which hurts async I/O performance of
5470 * TCP backends badly. Provide a different select method without
5471 * using poll on XP.
5472 * This is only used on XP because it is not as efficient as the one using poll
5473 * and all other Windows versions are working fine.
5474 */
5475 char szOS[64];
5476 memset(szOS, 0, sizeof(szOS));
5477 rc = RTSystemQueryOSInfo(RTSYSOSINFO_PRODUCT, &szOS[0], sizeof(szOS));
5478
5479 if (RT_SUCCESS(rc) && !strncmp(szOS, "Windows XP", 10))
5480 {
5481 LogRel(("VD: Detected Windows XP, disabled poll based waiting for TCP\n"));
5482 pImage->VDIfTcpNet.pfnSelectOneEx = drvvdTcpSelectOneExNoPoll;
5483 }
5484 else
5485 pImage->VDIfTcpNet.pfnSelectOneEx = drvvdTcpSelectOneExPoll;
5486
5487 pImage->VDIfTcpNet.pfnPoke = drvvdTcpPoke;
5488 }
5489 else
5490 {
5491#ifndef VBOX_WITH_INIP
5492 rc = PDMDrvHlpVMSetError(pDrvIns, VERR_PDM_DRVINS_UNKNOWN_CFG_VALUES,
5493 RT_SRC_POS, N_("DrvVD: Configuration error: TCP over Internal Networking not compiled in"));
5494#else /* VBOX_WITH_INIP */
5495 pImage->VDIfTcpNet.pfnSocketCreate = drvvdINIPSocketCreate;
5496 pImage->VDIfTcpNet.pfnSocketDestroy = drvvdINIPSocketDestroy;
5497 pImage->VDIfTcpNet.pfnClientConnect = drvvdINIPClientConnect;
5498 pImage->VDIfTcpNet.pfnClientClose = drvvdINIPClientClose;
5499 pImage->VDIfTcpNet.pfnIsClientConnected = drvvdINIPIsClientConnected;
5500 pImage->VDIfTcpNet.pfnSelectOne = drvvdINIPSelectOne;
5501 pImage->VDIfTcpNet.pfnRead = drvvdINIPRead;
5502 pImage->VDIfTcpNet.pfnWrite = drvvdINIPWrite;
5503 pImage->VDIfTcpNet.pfnSgWrite = drvvdINIPSgWrite;
5504 pImage->VDIfTcpNet.pfnFlush = drvvdINIPFlush;
5505 pImage->VDIfTcpNet.pfnSetSendCoalescing = drvvdINIPSetSendCoalescing;
5506 pImage->VDIfTcpNet.pfnGetLocalAddress = drvvdINIPGetLocalAddress;
5507 pImage->VDIfTcpNet.pfnGetPeerAddress = drvvdINIPGetPeerAddress;
5508 pImage->VDIfTcpNet.pfnSelectOneEx = drvvdINIPSelectOneEx;
5509 pImage->VDIfTcpNet.pfnPoke = drvvdINIPPoke;
5510#endif /* VBOX_WITH_INIP */
5511 }
5512 rc = VDInterfaceAdd(&pImage->VDIfTcpNet.Core, "DrvVD_TCPNET",
5513 VDINTERFACETYPE_TCPNET, NULL,
5514 sizeof(VDINTERFACETCPNET), &pImage->pVDIfsImage);
5515 AssertRC(rc);
5516
5517 /* Insert the custom I/O interface only if we're told to use new IO.
5518 * Since the I/O interface is per image we could make this more
5519 * flexible in the future if we want to. */
5520 if (fUseNewIo)
5521 {
5522#ifdef VBOX_WITH_PDM_ASYNC_COMPLETION
5523 pImage->VDIfIo.pfnOpen = drvvdAsyncIOOpen;
5524 pImage->VDIfIo.pfnClose = drvvdAsyncIOClose;
5525 pImage->VDIfIo.pfnGetSize = drvvdAsyncIOGetSize;
5526 pImage->VDIfIo.pfnSetSize = drvvdAsyncIOSetSize;
5527 pImage->VDIfIo.pfnSetAllocationSize = drvvdAsyncIOSetAllocationSize;
5528 pImage->VDIfIo.pfnReadSync = drvvdAsyncIOReadSync;
5529 pImage->VDIfIo.pfnWriteSync = drvvdAsyncIOWriteSync;
5530 pImage->VDIfIo.pfnFlushSync = drvvdAsyncIOFlushSync;
5531 pImage->VDIfIo.pfnReadAsync = drvvdAsyncIOReadAsync;
5532 pImage->VDIfIo.pfnWriteAsync = drvvdAsyncIOWriteAsync;
5533 pImage->VDIfIo.pfnFlushAsync = drvvdAsyncIOFlushAsync;
5534#else /* !VBOX_WITH_PDM_ASYNC_COMPLETION */
5535 rc = PDMDrvHlpVMSetError(pDrvIns, VERR_PDM_DRVINS_UNKNOWN_CFG_VALUES,
5536 RT_SRC_POS, N_("DrvVD: Configuration error: Async Completion Framework not compiled in"));
5537#endif /* !VBOX_WITH_PDM_ASYNC_COMPLETION */
5538 if (RT_SUCCESS(rc))
5539 rc = VDInterfaceAdd(&pImage->VDIfIo.Core, "DrvVD_IO", VDINTERFACETYPE_IO,
5540 pThis, sizeof(VDINTERFACEIO), &pImage->pVDIfsImage);
5541 AssertRC(rc);
5542 }
5543
5544 /*
5545 * Open the image.
5546 */
5547 unsigned uOpenFlags;
5548 if (fReadOnly || pThis->fTempReadOnly || iLevel != 0)
5549 uOpenFlags = VD_OPEN_FLAGS_READONLY;
5550 else
5551 uOpenFlags = VD_OPEN_FLAGS_NORMAL;
5552 if (fHonorZeroWrites)
5553 uOpenFlags |= VD_OPEN_FLAGS_HONOR_ZEROES;
5554 if (pThis->fAsyncIOSupported)
5555 uOpenFlags |= VD_OPEN_FLAGS_ASYNC_IO;
5556 if (pThis->fShareable)
5557 uOpenFlags |= VD_OPEN_FLAGS_SHAREABLE;
5558 if (fDiscard && iLevel == 0)
5559 uOpenFlags |= VD_OPEN_FLAGS_DISCARD;
5560 if (fInformAboutZeroBlocks)
5561 uOpenFlags |= VD_OPEN_FLAGS_INFORM_ABOUT_ZERO_BLOCKS;
5562 if ( (uOpenFlags & VD_OPEN_FLAGS_READONLY)
5563 && fSkipConsistencyChecks)
5564 uOpenFlags |= VD_OPEN_FLAGS_SKIP_CONSISTENCY_CHECKS;
5565
5566 /* Try to open backend in async I/O mode first. */
5567 rc = VDOpen(pThis->pDisk, pszFormat, pszName, uOpenFlags, pImage->pVDIfsImage);
5568 if (rc == VERR_NOT_SUPPORTED)
5569 {
5570 pThis->fAsyncIOSupported = false;
5571 uOpenFlags &= ~VD_OPEN_FLAGS_ASYNC_IO;
5572 rc = VDOpen(pThis->pDisk, pszFormat, pszName, uOpenFlags, pImage->pVDIfsImage);
5573 }
5574
5575 if (rc == VERR_VD_DISCARD_NOT_SUPPORTED)
5576 {
5577 fDiscard = false;
5578 uOpenFlags &= ~VD_OPEN_FLAGS_DISCARD;
5579 rc = VDOpen(pThis->pDisk, pszFormat, pszName, uOpenFlags, pImage->pVDIfsImage);
5580 }
5581
5582 if (!fDiscard)
5583 {
5584 pThis->IMedia.pfnDiscard = NULL;
5585 pThis->IMediaEx.pfnIoReqDiscard = NULL;
5586 }
5587
5588 if (RT_SUCCESS(rc))
5589 {
5590 LogFunc(("%d - Opened '%s' in %s mode\n",
5591 iLevel, pszName,
5592 VDIsReadOnly(pThis->pDisk) ? "read-only" : "read-write"));
5593 if ( VDIsReadOnly(pThis->pDisk)
5594 && !fReadOnly
5595 && !fMaybeReadOnly
5596 && !pThis->fTempReadOnly
5597 && iLevel == 0)
5598 {
5599 rc = PDMDrvHlpVMSetError(pDrvIns, VERR_VD_IMAGE_READ_ONLY, RT_SRC_POS,
5600 N_("Failed to open image '%s' for writing due to wrong permissions"),
5601 pszName);
5602 break;
5603 }
5604 }
5605 else
5606 {
5607 rc = PDMDrvHlpVMSetError(pDrvIns, rc, RT_SRC_POS,
5608 N_("Failed to open image '%s' in %s mode"), pszName,
5609 (uOpenFlags & VD_OPEN_FLAGS_READONLY) ? "read-only" : "read-write");
5610 break;
5611 }
5612
5613 MMR3HeapFree(pszName);
5614 pszName = NULL;
5615 MMR3HeapFree(pszFormat);
5616 pszFormat = NULL;
5617
5618 /* next */
5619 iLevel--;
5620 iImageIdx++;
5621 pCurNode = CFGMR3GetParent(pCurNode);
5622 }
5623
5624 LogRel(("VD: Opening the disk took %lld ns\n", RTTimeNanoTS() - tsStart));
5625
5626 /* Open the cache image if set. */
5627 if ( RT_SUCCESS(rc)
5628 && RT_VALID_PTR(pszCachePath))
5629 {
5630 /* Insert the custom I/O interface only if we're told to use new IO.
5631 * Since the I/O interface is per image we could make this more
5632 * flexible in the future if we want to. */
5633 if (fUseNewIo)
5634 {
5635#ifdef VBOX_WITH_PDM_ASYNC_COMPLETION
5636 pThis->VDIfIoCache.pfnOpen = drvvdAsyncIOOpen;
5637 pThis->VDIfIoCache.pfnClose = drvvdAsyncIOClose;
5638 pThis->VDIfIoCache.pfnGetSize = drvvdAsyncIOGetSize;
5639 pThis->VDIfIoCache.pfnSetSize = drvvdAsyncIOSetSize;
5640 pThis->VDIfIoCache.pfnReadSync = drvvdAsyncIOReadSync;
5641 pThis->VDIfIoCache.pfnWriteSync = drvvdAsyncIOWriteSync;
5642 pThis->VDIfIoCache.pfnFlushSync = drvvdAsyncIOFlushSync;
5643 pThis->VDIfIoCache.pfnReadAsync = drvvdAsyncIOReadAsync;
5644 pThis->VDIfIoCache.pfnWriteAsync = drvvdAsyncIOWriteAsync;
5645 pThis->VDIfIoCache.pfnFlushAsync = drvvdAsyncIOFlushAsync;
5646#else /* !VBOX_WITH_PDM_ASYNC_COMPLETION */
5647 rc = PDMDrvHlpVMSetError(pDrvIns, VERR_PDM_DRVINS_UNKNOWN_CFG_VALUES,
5648 RT_SRC_POS, N_("DrvVD: Configuration error: Async Completion Framework not compiled in"));
5649#endif /* !VBOX_WITH_PDM_ASYNC_COMPLETION */
5650 if (RT_SUCCESS(rc))
5651 rc = VDInterfaceAdd(&pThis->VDIfIoCache.Core, "DrvVD_IO", VDINTERFACETYPE_IO,
5652 pThis, sizeof(VDINTERFACEIO), &pThis->pVDIfsCache);
5653 AssertRC(rc);
5654 }
5655
5656 rc = VDCacheOpen(pThis->pDisk, pszCacheFormat, pszCachePath, VD_OPEN_FLAGS_NORMAL, pThis->pVDIfsCache);
5657 if (RT_FAILURE(rc))
5658 rc = PDMDRV_SET_ERROR(pDrvIns, rc, N_("DrvVD: Could not open cache image"));
5659 }
5660
5661 if (RT_VALID_PTR(pszCachePath))
5662 MMR3HeapFree(pszCachePath);
5663 if (RT_VALID_PTR(pszCacheFormat))
5664 MMR3HeapFree(pszCacheFormat);
5665
5666 if ( RT_SUCCESS(rc)
5667 && pThis->fMergePending
5668 && ( pThis->uMergeSource == VD_LAST_IMAGE
5669 || pThis->uMergeTarget == VD_LAST_IMAGE))
5670 {
5671 rc = PDMDRV_SET_ERROR(pDrvIns, VERR_PDM_DRIVER_INVALID_PROPERTIES,
5672 N_("DrvVD: Configuration error: Inconsistent image merge data"));
5673 }
5674
5675 /* Create the block cache if enabled. */
5676 if ( fUseBlockCache
5677 && !pThis->fShareable
5678 && !fDiscard
5679 && !pThis->pCfgCrypto /* Disk encryption disables the block cache for security reasons */
5680 && RT_SUCCESS(rc))
5681 {
5682 /*
5683 * We need a unique ID for the block cache (to identify the owner of data
5684 * blocks in a saved state). UUIDs are not really suitable because
5685 * there are image formats which don't support them. Furthermore it is
5686 * possible that a new diff image was attached after a saved state
5687 * which changes the UUID.
5688 * However the device "name + device instance + LUN" triple the disk is
5689 * attached to is always constant for saved states.
5690 */
5691 char *pszId = NULL;
5692 uint32_t iInstance, iLUN;
5693 const char *pcszController;
5694
5695 rc = pThis->pDrvMediaPort->pfnQueryDeviceLocation(pThis->pDrvMediaPort, &pcszController,
5696 &iInstance, &iLUN);
5697 if (RT_FAILURE(rc))
5698 rc = PDMDRV_SET_ERROR(pDrvIns, VERR_PDM_DRIVER_INVALID_PROPERTIES,
5699 N_("DrvVD: Configuration error: Could not query device data"));
5700 else
5701 {
5702 int cbStr = RTStrAPrintf(&pszId, "%s-%d-%d", pcszController, iInstance, iLUN);
5703
5704 if (cbStr > 0)
5705 {
5706 rc = PDMDrvHlpBlkCacheRetain(pDrvIns, &pThis->pBlkCache,
5707 drvvdBlkCacheXferCompleteIoReq,
5708 drvvdBlkCacheXferEnqueue,
5709 drvvdBlkCacheXferEnqueueDiscard,
5710 pszId);
5711 if (rc == VERR_NOT_SUPPORTED)
5712 {
5713 LogRel(("VD: Block cache is not supported\n"));
5714 rc = VINF_SUCCESS;
5715 }
5716 else
5717 AssertRC(rc);
5718
5719 RTStrFree(pszId);
5720 }
5721 else
5722 rc = PDMDRV_SET_ERROR(pDrvIns, VERR_PDM_DRIVER_INVALID_PROPERTIES,
5723 N_("DrvVD: Out of memory when creating block cache"));
5724 }
5725 }
5726
5727 if (RT_SUCCESS(rc))
5728 rc = drvvdSetupFilters(pThis, pCfg);
5729
5730 /*
5731 * Register a load-done callback so we can undo TempReadOnly config before
5732 * we get to drvvdResume. Automatically deregistered upon destruction.
5733 */
5734 if (RT_SUCCESS(rc))
5735 rc = PDMDrvHlpSSMRegisterEx(pDrvIns, 0 /* version */, 0 /* cbGuess */,
5736 NULL /*pfnLivePrep*/, NULL /*pfnLiveExec*/, NULL /*pfnLiveVote*/,
5737 NULL /*pfnSavePrep*/, NULL /*pfnSaveExec*/, NULL /*pfnSaveDone*/,
5738 NULL /*pfnDonePrep*/, NULL /*pfnLoadExec*/, drvvdLoadDone);
5739
5740 /* Setup the boot acceleration stuff if enabled. */
5741 if (RT_SUCCESS(rc) && pThis->fBootAccelEnabled)
5742 {
5743 pThis->cbDisk = VDGetSize(pThis->pDisk, VD_LAST_IMAGE);
5744 Assert(pThis->cbDisk > 0);
5745 pThis->pbData = (uint8_t *)RTMemAllocZ(pThis->cbBootAccelBuffer);
5746 if (pThis->pbData)
5747 {
5748 pThis->fBootAccelActive = true;
5749 pThis->offDisk = 0;
5750 pThis->cbDataValid = 0;
5751 LogRel(("VD: Boot acceleration enabled\n"));
5752 }
5753 else
5754 LogRel(("VD: Boot acceleration, out of memory, disabled\n"));
5755 }
5756
5757 if ( RTUuidIsNull(&pThis->Uuid)
5758 && pThis->enmType == PDMMEDIATYPE_HARD_DISK)
5759 VDGetUuid(pThis->pDisk, 0, &pThis->Uuid);
5760
5761 /*
5762 * Automatically upgrade the floppy drive if the specified one is too
5763 * small to represent the whole boot time image. (We cannot do this later
5764 * since the BIOS (and others) gets the info via CMOS.)
5765 *
5766 * This trick should make 2.88 images as well as the fake 15.6 and 63.5 MB
5767 * images despite the hardcoded default 1.44 drive.
5768 */
5769 if ( PDMMEDIATYPE_IS_FLOPPY(pThis->enmType)
5770 && pThis->pDisk)
5771 {
5772 uint64_t const cbFloppyImg = VDGetSize(pThis->pDisk, VD_LAST_IMAGE);
5773 PDMMEDIATYPE const enmCfgType = pThis->enmType;
5774 switch (enmCfgType)
5775 {
5776 default:
5777 AssertFailed();
5778 /* fall thru */
5779 case PDMMEDIATYPE_FLOPPY_360:
5780 if (cbFloppyImg > 40 * 2 * 9 * 512)
5781 pThis->enmType = PDMMEDIATYPE_FLOPPY_720;
5782 /* fall thru */
5783 case PDMMEDIATYPE_FLOPPY_720:
5784 if (cbFloppyImg > 80 * 2 * 14 * 512)
5785 pThis->enmType = PDMMEDIATYPE_FLOPPY_1_20;
5786 /* fall thru */
5787 case PDMMEDIATYPE_FLOPPY_1_20:
5788 if (cbFloppyImg > 80 * 2 * 20 * 512)
5789 pThis->enmType = PDMMEDIATYPE_FLOPPY_1_44;
5790 /* fall thru */
5791 case PDMMEDIATYPE_FLOPPY_1_44:
5792 if (cbFloppyImg > 80 * 2 * 24 * 512)
5793 pThis->enmType = PDMMEDIATYPE_FLOPPY_2_88;
5794 /* fall thru */
5795 case PDMMEDIATYPE_FLOPPY_2_88:
5796 if (cbFloppyImg > 80 * 2 * 48 * 512)
5797 pThis->enmType = PDMMEDIATYPE_FLOPPY_FAKE_15_6;
5798 /* fall thru */
5799 case PDMMEDIATYPE_FLOPPY_FAKE_15_6:
5800 if (cbFloppyImg > 255 * 2 * 63 * 512)
5801 pThis->enmType = PDMMEDIATYPE_FLOPPY_FAKE_63_5;
5802 /* fall thru */
5803 case PDMMEDIATYPE_FLOPPY_FAKE_63_5:
5804 if (cbFloppyImg > 255 * 2 * 255 * 512)
5805 LogRel(("Warning: Floppy image is larger that 63.5 MB! (%llu bytes)\n", cbFloppyImg));
5806 break;
5807 }
5808 if (pThis->enmType != enmCfgType)
5809 LogRel(("DrvVD: Automatically upgraded floppy drive from %s to %s to better support the %u byte image\n",
5810 drvvdGetTypeName(enmCfgType), drvvdGetTypeName(pThis->enmType), cbFloppyImg));
5811 }
5812 } /* !fEmptyDrive */
5813
5814 if (RT_SUCCESS(rc))
5815 drvvdStatsRegister(pThis);
5816
5817 if (RT_FAILURE(rc))
5818 {
5819 if (RT_VALID_PTR(pszName))
5820 MMR3HeapFree(pszName);
5821 if (RT_VALID_PTR(pszFormat))
5822 MMR3HeapFree(pszFormat);
5823 /* drvvdDestruct does the rest. */
5824 }
5825
5826 LogFlowFunc(("returns %Rrc\n", rc));
5827 return rc;
5828}
5829
5830/**
5831 * VBox disk container media driver registration record.
5832 */
5833const PDMDRVREG g_DrvVD =
5834{
5835 /* u32Version */
5836 PDM_DRVREG_VERSION,
5837 /* szName */
5838 "VD",
5839 /* szRCMod */
5840 "",
5841 /* szR0Mod */
5842 "",
5843 /* pszDescription */
5844 "Generic VBox disk media driver.",
5845 /* fFlags */
5846 PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT,
5847 /* fClass. */
5848 PDM_DRVREG_CLASS_MEDIA,
5849 /* cMaxInstances */
5850 ~0U,
5851 /* cbInstance */
5852 sizeof(VBOXDISK),
5853 /* pfnConstruct */
5854 drvvdConstruct,
5855 /* pfnDestruct */
5856 drvvdDestruct,
5857 /* pfnRelocate */
5858 NULL,
5859 /* pfnIOCtl */
5860 NULL,
5861 /* pfnPowerOn */
5862 drvvdPowerOn,
5863 /* pfnReset */
5864 drvvdReset,
5865 /* pfnSuspend */
5866 drvvdSuspend,
5867 /* pfnResume */
5868 drvvdResume,
5869 /* pfnAttach */
5870 NULL,
5871 /* pfnDetach */
5872 NULL,
5873 /* pfnPowerOff */
5874 drvvdPowerOff,
5875 /* pfnSoftReset */
5876 NULL,
5877 /* u32EndVersion */
5878 PDM_DRVREG_VERSION
5879};
5880
Note: See TracBrowser for help on using the repository browser.

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