VirtualBox

source: vbox/trunk/src/VBox/VMM/VMMR3/PDMBlkCache.cpp@ 57446

Last change on this file since 57446 was 57389, checked in by vboxsync, 9 years ago

VMM: DECLCALLBACK
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 98.9 KB
Line 
1/* $Id: PDMBlkCache.cpp 57389 2015-08-17 14:24:02Z vboxsync $ */
2/** @file
3 * PDM Block Cache.
4 */
5
6/*
7 * Copyright (C) 2006-2015 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/** @page pg_pdm_block_cache PDM Block Cache - The I/O cache
19 * This component implements an I/O cache based on the 2Q cache algorithm.
20 */
21
22
23/*********************************************************************************************************************************
24* Header Files *
25*********************************************************************************************************************************/
26#define LOG_GROUP LOG_GROUP_PDM_BLK_CACHE
27#include "PDMInternal.h"
28#include <iprt/asm.h>
29#include <iprt/mem.h>
30#include <iprt/path.h>
31#include <iprt/string.h>
32#include <VBox/log.h>
33#include <VBox/vmm/stam.h>
34#include <VBox/vmm/uvm.h>
35#include <VBox/vmm/vm.h>
36
37#include "PDMBlkCacheInternal.h"
38
39#ifdef VBOX_STRICT
40# define PDMACFILECACHE_IS_CRITSECT_OWNER(Cache) \
41 do \
42 { \
43 AssertMsg(RTCritSectIsOwner(&Cache->CritSect), \
44 ("Thread does not own critical section\n"));\
45 } while (0)
46
47# define PDMACFILECACHE_EP_IS_SEMRW_WRITE_OWNER(pEpCache) \
48 do \
49 { \
50 AssertMsg(RTSemRWIsWriteOwner(pEpCache->SemRWEntries), \
51 ("Thread is not exclusive owner of the per endpoint RW semaphore\n")); \
52 } while (0)
53
54# define PDMACFILECACHE_EP_IS_SEMRW_READ_OWNER(pEpCache) \
55 do \
56 { \
57 AssertMsg(RTSemRWIsReadOwner(pEpCache->SemRWEntries), \
58 ("Thread is not read owner of the per endpoint RW semaphore\n")); \
59 } while (0)
60
61#else
62# define PDMACFILECACHE_IS_CRITSECT_OWNER(Cache) do { } while (0)
63# define PDMACFILECACHE_EP_IS_SEMRW_WRITE_OWNER(pEpCache) do { } while (0)
64# define PDMACFILECACHE_EP_IS_SEMRW_READ_OWNER(pEpCache) do { } while (0)
65#endif
66
67#define PDM_BLK_CACHE_SAVED_STATE_VERSION 1
68
69
70/*********************************************************************************************************************************
71* Internal Functions *
72*********************************************************************************************************************************/
73
74static PPDMBLKCACHEENTRY pdmBlkCacheEntryAlloc(PPDMBLKCACHE pBlkCache,
75 uint64_t off, size_t cbData, uint8_t *pbBuffer);
76static bool pdmBlkCacheAddDirtyEntry(PPDMBLKCACHE pBlkCache, PPDMBLKCACHEENTRY pEntry);
77
78/**
79 * Decrement the reference counter of the given cache entry.
80 *
81 * @returns nothing.
82 * @param pEntry The entry to release.
83 */
84DECLINLINE(void) pdmBlkCacheEntryRelease(PPDMBLKCACHEENTRY pEntry)
85{
86 AssertMsg(pEntry->cRefs > 0, ("Trying to release a not referenced entry\n"));
87 ASMAtomicDecU32(&pEntry->cRefs);
88}
89
90/**
91 * Increment the reference counter of the given cache entry.
92 *
93 * @returns nothing.
94 * @param pEntry The entry to reference.
95 */
96DECLINLINE(void) pdmBlkCacheEntryRef(PPDMBLKCACHEENTRY pEntry)
97{
98 ASMAtomicIncU32(&pEntry->cRefs);
99}
100
101#ifdef VBOX_STRICT
102static void pdmBlkCacheValidate(PPDMBLKCACHEGLOBAL pCache)
103{
104 /* Amount of cached data should never exceed the maximum amount. */
105 AssertMsg(pCache->cbCached <= pCache->cbMax,
106 ("Current amount of cached data exceeds maximum\n"));
107
108 /* The amount of cached data in the LRU and FRU list should match cbCached */
109 AssertMsg(pCache->LruRecentlyUsedIn.cbCached + pCache->LruFrequentlyUsed.cbCached == pCache->cbCached,
110 ("Amount of cached data doesn't match\n"));
111
112 AssertMsg(pCache->LruRecentlyUsedOut.cbCached <= pCache->cbRecentlyUsedOutMax,
113 ("Paged out list exceeds maximum\n"));
114}
115#endif
116
117DECLINLINE(void) pdmBlkCacheLockEnter(PPDMBLKCACHEGLOBAL pCache)
118{
119 RTCritSectEnter(&pCache->CritSect);
120#ifdef VBOX_STRICT
121 pdmBlkCacheValidate(pCache);
122#endif
123}
124
125DECLINLINE(void) pdmBlkCacheLockLeave(PPDMBLKCACHEGLOBAL pCache)
126{
127#ifdef VBOX_STRICT
128 pdmBlkCacheValidate(pCache);
129#endif
130 RTCritSectLeave(&pCache->CritSect);
131}
132
133DECLINLINE(void) pdmBlkCacheSub(PPDMBLKCACHEGLOBAL pCache, uint32_t cbAmount)
134{
135 PDMACFILECACHE_IS_CRITSECT_OWNER(pCache);
136 pCache->cbCached -= cbAmount;
137}
138
139DECLINLINE(void) pdmBlkCacheAdd(PPDMBLKCACHEGLOBAL pCache, uint32_t cbAmount)
140{
141 PDMACFILECACHE_IS_CRITSECT_OWNER(pCache);
142 pCache->cbCached += cbAmount;
143}
144
145DECLINLINE(void) pdmBlkCacheListAdd(PPDMBLKLRULIST pList, uint32_t cbAmount)
146{
147 pList->cbCached += cbAmount;
148}
149
150DECLINLINE(void) pdmBlkCacheListSub(PPDMBLKLRULIST pList, uint32_t cbAmount)
151{
152 pList->cbCached -= cbAmount;
153}
154
155#ifdef PDMACFILECACHE_WITH_LRULIST_CHECKS
156/**
157 * Checks consistency of a LRU list.
158 *
159 * @returns nothing
160 * @param pList The LRU list to check.
161 * @param pNotInList Element which is not allowed to occur in the list.
162 */
163static void pdmBlkCacheCheckList(PPDMBLKLRULIST pList, PPDMBLKCACHEENTRY pNotInList)
164{
165 PPDMBLKCACHEENTRY pCurr = pList->pHead;
166
167 /* Check that there are no double entries and no cycles in the list. */
168 while (pCurr)
169 {
170 PPDMBLKCACHEENTRY pNext = pCurr->pNext;
171
172 while (pNext)
173 {
174 AssertMsg(pCurr != pNext,
175 ("Entry %#p is at least two times in list %#p or there is a cycle in the list\n",
176 pCurr, pList));
177 pNext = pNext->pNext;
178 }
179
180 AssertMsg(pCurr != pNotInList, ("Not allowed entry %#p is in list\n", pCurr));
181
182 if (!pCurr->pNext)
183 AssertMsg(pCurr == pList->pTail, ("End of list reached but last element is not list tail\n"));
184
185 pCurr = pCurr->pNext;
186 }
187}
188#endif
189
190/**
191 * Unlinks a cache entry from the LRU list it is assigned to.
192 *
193 * @returns nothing.
194 * @param pEntry The entry to unlink.
195 */
196static void pdmBlkCacheEntryRemoveFromList(PPDMBLKCACHEENTRY pEntry)
197{
198 PPDMBLKLRULIST pList = pEntry->pList;
199 PPDMBLKCACHEENTRY pPrev, pNext;
200
201 LogFlowFunc((": Deleting entry %#p from list %#p\n", pEntry, pList));
202
203 AssertPtr(pList);
204
205#ifdef PDMACFILECACHE_WITH_LRULIST_CHECKS
206 pdmBlkCacheCheckList(pList, NULL);
207#endif
208
209 pPrev = pEntry->pPrev;
210 pNext = pEntry->pNext;
211
212 AssertMsg(pEntry != pPrev, ("Entry links to itself as previous element\n"));
213 AssertMsg(pEntry != pNext, ("Entry links to itself as next element\n"));
214
215 if (pPrev)
216 pPrev->pNext = pNext;
217 else
218 {
219 pList->pHead = pNext;
220
221 if (pNext)
222 pNext->pPrev = NULL;
223 }
224
225 if (pNext)
226 pNext->pPrev = pPrev;
227 else
228 {
229 pList->pTail = pPrev;
230
231 if (pPrev)
232 pPrev->pNext = NULL;
233 }
234
235 pEntry->pList = NULL;
236 pEntry->pPrev = NULL;
237 pEntry->pNext = NULL;
238 pdmBlkCacheListSub(pList, pEntry->cbData);
239#ifdef PDMACFILECACHE_WITH_LRULIST_CHECKS
240 pdmBlkCacheCheckList(pList, pEntry);
241#endif
242}
243
244/**
245 * Adds a cache entry to the given LRU list unlinking it from the currently
246 * assigned list if needed.
247 *
248 * @returns nothing.
249 * @param pList List to the add entry to.
250 * @param pEntry Entry to add.
251 */
252static void pdmBlkCacheEntryAddToList(PPDMBLKLRULIST pList, PPDMBLKCACHEENTRY pEntry)
253{
254 LogFlowFunc((": Adding entry %#p to list %#p\n", pEntry, pList));
255#ifdef PDMACFILECACHE_WITH_LRULIST_CHECKS
256 pdmBlkCacheCheckList(pList, NULL);
257#endif
258
259 /* Remove from old list if needed */
260 if (pEntry->pList)
261 pdmBlkCacheEntryRemoveFromList(pEntry);
262
263 pEntry->pNext = pList->pHead;
264 if (pList->pHead)
265 pList->pHead->pPrev = pEntry;
266 else
267 {
268 Assert(!pList->pTail);
269 pList->pTail = pEntry;
270 }
271
272 pEntry->pPrev = NULL;
273 pList->pHead = pEntry;
274 pdmBlkCacheListAdd(pList, pEntry->cbData);
275 pEntry->pList = pList;
276#ifdef PDMACFILECACHE_WITH_LRULIST_CHECKS
277 pdmBlkCacheCheckList(pList, NULL);
278#endif
279}
280
281/**
282 * Destroys a LRU list freeing all entries.
283 *
284 * @returns nothing
285 * @param pList Pointer to the LRU list to destroy.
286 *
287 * @note The caller must own the critical section of the cache.
288 */
289static void pdmBlkCacheDestroyList(PPDMBLKLRULIST pList)
290{
291 while (pList->pHead)
292 {
293 PPDMBLKCACHEENTRY pEntry = pList->pHead;
294
295 pList->pHead = pEntry->pNext;
296
297 AssertMsg(!(pEntry->fFlags & (PDMBLKCACHE_ENTRY_IO_IN_PROGRESS | PDMBLKCACHE_ENTRY_IS_DIRTY)),
298 ("Entry is dirty and/or still in progress fFlags=%#x\n", pEntry->fFlags));
299
300 RTMemPageFree(pEntry->pbData, pEntry->cbData);
301 RTMemFree(pEntry);
302 }
303}
304
305/**
306 * Tries to remove the given amount of bytes from a given list in the cache
307 * moving the entries to one of the given ghosts lists
308 *
309 * @returns Amount of data which could be freed.
310 * @param pCache Pointer to the global cache data.
311 * @param cbData The amount of the data to free.
312 * @param pListSrc The source list to evict data from.
313 * @param pGhostListSrc The ghost list removed entries should be moved to
314 * NULL if the entry should be freed.
315 * @param fReuseBuffer Flag whether a buffer should be reused if it has the same size
316 * @param ppbBuf Where to store the address of the buffer if an entry with the
317 * same size was found and fReuseBuffer is true.
318 *
319 * @note This function may return fewer bytes than requested because entries
320 * may be marked as non evictable if they are used for I/O at the
321 * moment.
322 */
323static size_t pdmBlkCacheEvictPagesFrom(PPDMBLKCACHEGLOBAL pCache, size_t cbData,
324 PPDMBLKLRULIST pListSrc, PPDMBLKLRULIST pGhostListDst,
325 bool fReuseBuffer, uint8_t **ppbBuffer)
326{
327 size_t cbEvicted = 0;
328
329 PDMACFILECACHE_IS_CRITSECT_OWNER(pCache);
330
331 AssertMsg(cbData > 0, ("Evicting 0 bytes not possible\n"));
332 AssertMsg( !pGhostListDst
333 || (pGhostListDst == &pCache->LruRecentlyUsedOut),
334 ("Destination list must be NULL or the recently used but paged out list\n"));
335
336 if (fReuseBuffer)
337 {
338 AssertPtr(ppbBuffer);
339 *ppbBuffer = NULL;
340 }
341
342 /* Start deleting from the tail. */
343 PPDMBLKCACHEENTRY pEntry = pListSrc->pTail;
344
345 while ((cbEvicted < cbData) && pEntry)
346 {
347 PPDMBLKCACHEENTRY pCurr = pEntry;
348
349 pEntry = pEntry->pPrev;
350
351 /* We can't evict pages which are currently in progress or dirty but not in progress */
352 if ( !(pCurr->fFlags & PDMBLKCACHE_NOT_EVICTABLE)
353 && (ASMAtomicReadU32(&pCurr->cRefs) == 0))
354 {
355 /* Ok eviction candidate. Grab the endpoint semaphore and check again
356 * because somebody else might have raced us. */
357 PPDMBLKCACHE pBlkCache = pCurr->pBlkCache;
358 RTSemRWRequestWrite(pBlkCache->SemRWEntries, RT_INDEFINITE_WAIT);
359
360 if (!(pCurr->fFlags & PDMBLKCACHE_NOT_EVICTABLE)
361 && (ASMAtomicReadU32(&pCurr->cRefs) == 0))
362 {
363 LogFlow(("Evicting entry %#p (%u bytes)\n", pCurr, pCurr->cbData));
364
365 if (fReuseBuffer && pCurr->cbData == cbData)
366 {
367 STAM_COUNTER_INC(&pCache->StatBuffersReused);
368 *ppbBuffer = pCurr->pbData;
369 }
370 else if (pCurr->pbData)
371 RTMemPageFree(pCurr->pbData, pCurr->cbData);
372
373 pCurr->pbData = NULL;
374 cbEvicted += pCurr->cbData;
375
376 pdmBlkCacheEntryRemoveFromList(pCurr);
377 pdmBlkCacheSub(pCache, pCurr->cbData);
378
379 if (pGhostListDst)
380 {
381 RTSemRWReleaseWrite(pBlkCache->SemRWEntries);
382
383 PPDMBLKCACHEENTRY pGhostEntFree = pGhostListDst->pTail;
384
385 /* We have to remove the last entries from the paged out list. */
386 while ( pGhostListDst->cbCached + pCurr->cbData > pCache->cbRecentlyUsedOutMax
387 && pGhostEntFree)
388 {
389 PPDMBLKCACHEENTRY pFree = pGhostEntFree;
390 PPDMBLKCACHE pBlkCacheFree = pFree->pBlkCache;
391
392 pGhostEntFree = pGhostEntFree->pPrev;
393
394 RTSemRWRequestWrite(pBlkCacheFree->SemRWEntries, RT_INDEFINITE_WAIT);
395
396 if (ASMAtomicReadU32(&pFree->cRefs) == 0)
397 {
398 pdmBlkCacheEntryRemoveFromList(pFree);
399
400 STAM_PROFILE_ADV_START(&pCache->StatTreeRemove, Cache);
401 RTAvlrU64Remove(pBlkCacheFree->pTree, pFree->Core.Key);
402 STAM_PROFILE_ADV_STOP(&pCache->StatTreeRemove, Cache);
403
404 RTMemFree(pFree);
405 }
406
407 RTSemRWReleaseWrite(pBlkCacheFree->SemRWEntries);
408 }
409
410 if (pGhostListDst->cbCached + pCurr->cbData > pCache->cbRecentlyUsedOutMax)
411 {
412 /* Couldn't remove enough entries. Delete */
413 STAM_PROFILE_ADV_START(&pCache->StatTreeRemove, Cache);
414 RTAvlrU64Remove(pCurr->pBlkCache->pTree, pCurr->Core.Key);
415 STAM_PROFILE_ADV_STOP(&pCache->StatTreeRemove, Cache);
416
417 RTMemFree(pCurr);
418 }
419 else
420 pdmBlkCacheEntryAddToList(pGhostListDst, pCurr);
421 }
422 else
423 {
424 /* Delete the entry from the AVL tree it is assigned to. */
425 STAM_PROFILE_ADV_START(&pCache->StatTreeRemove, Cache);
426 RTAvlrU64Remove(pCurr->pBlkCache->pTree, pCurr->Core.Key);
427 STAM_PROFILE_ADV_STOP(&pCache->StatTreeRemove, Cache);
428
429 RTSemRWReleaseWrite(pBlkCache->SemRWEntries);
430 RTMemFree(pCurr);
431 }
432 }
433
434 }
435 else
436 LogFlow(("Entry %#p (%u bytes) is still in progress and can't be evicted\n", pCurr, pCurr->cbData));
437 }
438
439 return cbEvicted;
440}
441
442static bool pdmBlkCacheReclaim(PPDMBLKCACHEGLOBAL pCache, size_t cbData, bool fReuseBuffer, uint8_t **ppbBuffer)
443{
444 size_t cbRemoved = 0;
445
446 if ((pCache->cbCached + cbData) < pCache->cbMax)
447 return true;
448 else if ((pCache->LruRecentlyUsedIn.cbCached + cbData) > pCache->cbRecentlyUsedInMax)
449 {
450 /* Try to evict as many bytes as possible from A1in */
451 cbRemoved = pdmBlkCacheEvictPagesFrom(pCache, cbData, &pCache->LruRecentlyUsedIn,
452 &pCache->LruRecentlyUsedOut, fReuseBuffer, ppbBuffer);
453
454 /*
455 * If it was not possible to remove enough entries
456 * try the frequently accessed cache.
457 */
458 if (cbRemoved < cbData)
459 {
460 Assert(!fReuseBuffer || !*ppbBuffer); /* It is not possible that we got a buffer with the correct size but we didn't freed enough data. */
461
462 /*
463 * If we removed something we can't pass the reuse buffer flag anymore because
464 * we don't need to evict that much data
465 */
466 if (!cbRemoved)
467 cbRemoved += pdmBlkCacheEvictPagesFrom(pCache, cbData, &pCache->LruFrequentlyUsed,
468 NULL, fReuseBuffer, ppbBuffer);
469 else
470 cbRemoved += pdmBlkCacheEvictPagesFrom(pCache, cbData - cbRemoved, &pCache->LruFrequentlyUsed,
471 NULL, false, NULL);
472 }
473 }
474 else
475 {
476 /* We have to remove entries from frequently access list. */
477 cbRemoved = pdmBlkCacheEvictPagesFrom(pCache, cbData, &pCache->LruFrequentlyUsed,
478 NULL, fReuseBuffer, ppbBuffer);
479 }
480
481 LogFlowFunc((": removed %u bytes, requested %u\n", cbRemoved, cbData));
482 return (cbRemoved >= cbData);
483}
484
485DECLINLINE(int) pdmBlkCacheEnqueue(PPDMBLKCACHE pBlkCache, uint64_t off, size_t cbXfer, PPDMBLKCACHEIOXFER pIoXfer)
486{
487 int rc = VINF_SUCCESS;
488
489 LogFlowFunc(("%s: Enqueuing hIoXfer=%#p enmXferDir=%d\n",
490 __FUNCTION__, pIoXfer, pIoXfer->enmXferDir));
491
492 switch (pBlkCache->enmType)
493 {
494 case PDMBLKCACHETYPE_DEV:
495 {
496 rc = pBlkCache->u.Dev.pfnXferEnqueue(pBlkCache->u.Dev.pDevIns,
497 pIoXfer->enmXferDir,
498 off, cbXfer,
499 &pIoXfer->SgBuf, pIoXfer);
500 break;
501 }
502 case PDMBLKCACHETYPE_DRV:
503 {
504 rc = pBlkCache->u.Drv.pfnXferEnqueue(pBlkCache->u.Drv.pDrvIns,
505 pIoXfer->enmXferDir,
506 off, cbXfer,
507 &pIoXfer->SgBuf, pIoXfer);
508 break;
509 }
510 case PDMBLKCACHETYPE_USB:
511 {
512 rc = pBlkCache->u.Usb.pfnXferEnqueue(pBlkCache->u.Usb.pUsbIns,
513 pIoXfer->enmXferDir,
514 off, cbXfer,
515 &pIoXfer->SgBuf, pIoXfer);
516 break;
517 }
518 case PDMBLKCACHETYPE_INTERNAL:
519 {
520 rc = pBlkCache->u.Int.pfnXferEnqueue(pBlkCache->u.Int.pvUser,
521 pIoXfer->enmXferDir,
522 off, cbXfer,
523 &pIoXfer->SgBuf, pIoXfer);
524 break;
525 }
526 default:
527 AssertMsgFailed(("Unknown block cache type!\n"));
528 }
529
530 LogFlowFunc(("%s: returns rc=%Rrc\n", __FUNCTION__, rc));
531 return rc;
532}
533
534/**
535 * Initiates a read I/O task for the given entry.
536 *
537 * @returns VBox status code.
538 * @param pEntry The entry to fetch the data to.
539 */
540static int pdmBlkCacheEntryReadFromMedium(PPDMBLKCACHEENTRY pEntry)
541{
542 PPDMBLKCACHE pBlkCache = pEntry->pBlkCache;
543 LogFlowFunc((": Reading data into cache entry %#p\n", pEntry));
544
545 /* Make sure no one evicts the entry while it is accessed. */
546 pEntry->fFlags |= PDMBLKCACHE_ENTRY_IO_IN_PROGRESS;
547
548 PPDMBLKCACHEIOXFER pIoXfer = (PPDMBLKCACHEIOXFER)RTMemAllocZ(sizeof(PDMBLKCACHEIOXFER));
549 if (RT_UNLIKELY(!pIoXfer))
550 return VERR_NO_MEMORY;
551
552 AssertMsg(pEntry->pbData, ("Entry is in ghost state\n"));
553
554 pIoXfer->fIoCache = true;
555 pIoXfer->pEntry = pEntry;
556 pIoXfer->SgSeg.pvSeg = pEntry->pbData;
557 pIoXfer->SgSeg.cbSeg = pEntry->cbData;
558 pIoXfer->enmXferDir = PDMBLKCACHEXFERDIR_READ;
559 RTSgBufInit(&pIoXfer->SgBuf, &pIoXfer->SgSeg, 1);
560
561 return pdmBlkCacheEnqueue(pBlkCache, pEntry->Core.Key, pEntry->cbData, pIoXfer);
562}
563
564/**
565 * Initiates a write I/O task for the given entry.
566 *
567 * @returns nothing.
568 * @param pEntry The entry to read the data from.
569 */
570static int pdmBlkCacheEntryWriteToMedium(PPDMBLKCACHEENTRY pEntry)
571{
572 PPDMBLKCACHE pBlkCache = pEntry->pBlkCache;
573 LogFlowFunc((": Writing data from cache entry %#p\n", pEntry));
574
575 /* Make sure no one evicts the entry while it is accessed. */
576 pEntry->fFlags |= PDMBLKCACHE_ENTRY_IO_IN_PROGRESS;
577
578 PPDMBLKCACHEIOXFER pIoXfer = (PPDMBLKCACHEIOXFER)RTMemAllocZ(sizeof(PDMBLKCACHEIOXFER));
579 if (RT_UNLIKELY(!pIoXfer))
580 return VERR_NO_MEMORY;
581
582 AssertMsg(pEntry->pbData, ("Entry is in ghost state\n"));
583
584 pIoXfer->fIoCache = true;
585 pIoXfer->pEntry = pEntry;
586 pIoXfer->SgSeg.pvSeg = pEntry->pbData;
587 pIoXfer->SgSeg.cbSeg = pEntry->cbData;
588 pIoXfer->enmXferDir = PDMBLKCACHEXFERDIR_WRITE;
589 RTSgBufInit(&pIoXfer->SgBuf, &pIoXfer->SgSeg, 1);
590
591 return pdmBlkCacheEnqueue(pBlkCache, pEntry->Core.Key, pEntry->cbData, pIoXfer);
592}
593
594/**
595 * Passthrough a part of a request directly to the I/O manager
596 * handling the endpoint.
597 *
598 * @returns VBox status code.
599 * @param pEndpoint The endpoint.
600 * @param pTask The task.
601 * @param pIoMemCtx The I/O memory context to use.
602 * @param offStart Offset to start transfer from.
603 * @param cbData Amount of data to transfer.
604 * @param enmTransferType The transfer type (read/write)
605 */
606static int pdmBlkCacheRequestPassthrough(PPDMBLKCACHE pBlkCache, PPDMBLKCACHEREQ pReq,
607 PRTSGBUF pSgBuf, uint64_t offStart, size_t cbData,
608 PDMBLKCACHEXFERDIR enmXferDir)
609{
610
611 PPDMBLKCACHEIOXFER pIoXfer = (PPDMBLKCACHEIOXFER)RTMemAllocZ(sizeof(PDMBLKCACHEIOXFER));
612 if (RT_UNLIKELY(!pIoXfer))
613 return VERR_NO_MEMORY;
614
615 ASMAtomicIncU32(&pReq->cXfersPending);
616 pIoXfer->fIoCache = false;
617 pIoXfer->pReq = pReq;
618 pIoXfer->enmXferDir = enmXferDir;
619 if (pSgBuf)
620 {
621 RTSgBufClone(&pIoXfer->SgBuf, pSgBuf);
622 RTSgBufAdvance(pSgBuf, cbData);
623 }
624
625 return pdmBlkCacheEnqueue(pBlkCache, offStart, cbData, pIoXfer);
626}
627
628/**
629 * Commit a single dirty entry to the endpoint
630 *
631 * @returns nothing
632 * @param pEntry The entry to commit.
633 */
634static void pdmBlkCacheEntryCommit(PPDMBLKCACHEENTRY pEntry)
635{
636 AssertMsg( (pEntry->fFlags & PDMBLKCACHE_ENTRY_IS_DIRTY)
637 && !(pEntry->fFlags & PDMBLKCACHE_ENTRY_IO_IN_PROGRESS),
638 ("Invalid flags set for entry %#p\n", pEntry));
639
640 pdmBlkCacheEntryWriteToMedium(pEntry);
641}
642
643/**
644 * Commit all dirty entries for a single endpoint.
645 *
646 * @returns nothing.
647 * @param pBlkCache The endpoint cache to commit.
648 */
649static void pdmBlkCacheCommit(PPDMBLKCACHE pBlkCache)
650{
651 uint32_t cbCommitted = 0;
652
653 /* Return if the cache was suspended. */
654 if (pBlkCache->fSuspended)
655 return;
656
657 RTSemRWRequestWrite(pBlkCache->SemRWEntries, RT_INDEFINITE_WAIT);
658
659 /* The list is moved to a new header to reduce locking overhead. */
660 RTLISTANCHOR ListDirtyNotCommitted;
661
662 RTListInit(&ListDirtyNotCommitted);
663 RTSpinlockAcquire(pBlkCache->LockList);
664 RTListMove(&ListDirtyNotCommitted, &pBlkCache->ListDirtyNotCommitted);
665 RTSpinlockRelease(pBlkCache->LockList);
666
667 if (!RTListIsEmpty(&ListDirtyNotCommitted))
668 {
669 PPDMBLKCACHEENTRY pEntry = RTListGetFirst(&ListDirtyNotCommitted, PDMBLKCACHEENTRY, NodeNotCommitted);
670
671 while (!RTListNodeIsLast(&ListDirtyNotCommitted, &pEntry->NodeNotCommitted))
672 {
673 PPDMBLKCACHEENTRY pNext = RTListNodeGetNext(&pEntry->NodeNotCommitted, PDMBLKCACHEENTRY,
674 NodeNotCommitted);
675 pdmBlkCacheEntryCommit(pEntry);
676 cbCommitted += pEntry->cbData;
677 RTListNodeRemove(&pEntry->NodeNotCommitted);
678 pEntry = pNext;
679 }
680
681 /* Commit the last endpoint */
682 Assert(RTListNodeIsLast(&ListDirtyNotCommitted, &pEntry->NodeNotCommitted));
683 pdmBlkCacheEntryCommit(pEntry);
684 cbCommitted += pEntry->cbData;
685 RTListNodeRemove(&pEntry->NodeNotCommitted);
686 AssertMsg(RTListIsEmpty(&ListDirtyNotCommitted),
687 ("Committed all entries but list is not empty\n"));
688 }
689
690 RTSemRWReleaseWrite(pBlkCache->SemRWEntries);
691 AssertMsg(pBlkCache->pCache->cbDirty >= cbCommitted,
692 ("Number of committed bytes exceeds number of dirty bytes\n"));
693 uint32_t cbDirtyOld = ASMAtomicSubU32(&pBlkCache->pCache->cbDirty, cbCommitted);
694
695 /* Reset the commit timer if we don't have any dirty bits. */
696 if ( !(cbDirtyOld - cbCommitted)
697 && pBlkCache->pCache->u32CommitTimeoutMs != 0)
698 TMTimerStop(pBlkCache->pCache->pTimerCommit);
699}
700
701/**
702 * Commit all dirty entries in the cache.
703 *
704 * @returns nothing.
705 * @param pCache The global cache instance.
706 */
707static void pdmBlkCacheCommitDirtyEntries(PPDMBLKCACHEGLOBAL pCache)
708{
709 bool fCommitInProgress = ASMAtomicXchgBool(&pCache->fCommitInProgress, true);
710
711 if (!fCommitInProgress)
712 {
713 pdmBlkCacheLockEnter(pCache);
714 Assert(!RTListIsEmpty(&pCache->ListUsers));
715
716 PPDMBLKCACHE pBlkCache = RTListGetFirst(&pCache->ListUsers, PDMBLKCACHE, NodeCacheUser);
717 AssertPtr(pBlkCache);
718
719 while (!RTListNodeIsLast(&pCache->ListUsers, &pBlkCache->NodeCacheUser))
720 {
721 pdmBlkCacheCommit(pBlkCache);
722
723 pBlkCache = RTListNodeGetNext(&pBlkCache->NodeCacheUser, PDMBLKCACHE,
724 NodeCacheUser);
725 }
726
727 /* Commit the last endpoint */
728 Assert(RTListNodeIsLast(&pCache->ListUsers, &pBlkCache->NodeCacheUser));
729 pdmBlkCacheCommit(pBlkCache);
730
731 pdmBlkCacheLockLeave(pCache);
732 ASMAtomicWriteBool(&pCache->fCommitInProgress, false);
733 }
734}
735
736/**
737 * Adds the given entry as a dirty to the cache.
738 *
739 * @returns Flag whether the amount of dirty bytes in the cache exceeds the threshold
740 * @param pBlkCache The endpoint cache the entry belongs to.
741 * @param pEntry The entry to add.
742 */
743static bool pdmBlkCacheAddDirtyEntry(PPDMBLKCACHE pBlkCache, PPDMBLKCACHEENTRY pEntry)
744{
745 bool fDirtyBytesExceeded = false;
746 PPDMBLKCACHEGLOBAL pCache = pBlkCache->pCache;
747
748 /* If the commit timer is disabled we commit right away. */
749 if (pCache->u32CommitTimeoutMs == 0)
750 {
751 pEntry->fFlags |= PDMBLKCACHE_ENTRY_IS_DIRTY;
752 pdmBlkCacheEntryCommit(pEntry);
753 }
754 else if (!(pEntry->fFlags & PDMBLKCACHE_ENTRY_IS_DIRTY))
755 {
756 pEntry->fFlags |= PDMBLKCACHE_ENTRY_IS_DIRTY;
757
758 RTSpinlockAcquire(pBlkCache->LockList);
759 RTListAppend(&pBlkCache->ListDirtyNotCommitted, &pEntry->NodeNotCommitted);
760 RTSpinlockRelease(pBlkCache->LockList);
761
762 uint32_t cbDirty = ASMAtomicAddU32(&pCache->cbDirty, pEntry->cbData);
763
764 /* Prevent committing if the VM was suspended. */
765 if (RT_LIKELY(!ASMAtomicReadBool(&pCache->fIoErrorVmSuspended)))
766 fDirtyBytesExceeded = (cbDirty + pEntry->cbData >= pCache->cbCommitDirtyThreshold);
767 else if (!cbDirty && pCache->u32CommitTimeoutMs > 0)
768 {
769 /* Arm the commit timer. */
770 TMTimerSetMillies(pCache->pTimerCommit, pCache->u32CommitTimeoutMs);
771 }
772 }
773
774 return fDirtyBytesExceeded;
775}
776
777static PPDMBLKCACHE pdmR3BlkCacheFindById(PPDMBLKCACHEGLOBAL pBlkCacheGlobal, const char *pcszId)
778{
779 bool fFound = false;
780 PPDMBLKCACHE pBlkCache = NULL;
781
782 RTListForEach(&pBlkCacheGlobal->ListUsers, pBlkCache, PDMBLKCACHE, NodeCacheUser)
783 {
784 if (!RTStrCmp(pBlkCache->pszId, pcszId))
785 {
786 fFound = true;
787 break;
788 }
789 }
790
791 return fFound ? pBlkCache : NULL;
792}
793
794/**
795 * Commit timer callback.
796 */
797static DECLCALLBACK(void) pdmBlkCacheCommitTimerCallback(PVM pVM, PTMTIMER pTimer, void *pvUser)
798{
799 PPDMBLKCACHEGLOBAL pCache = (PPDMBLKCACHEGLOBAL)pvUser;
800 NOREF(pVM); NOREF(pTimer);
801
802 LogFlowFunc(("Commit interval expired, commiting dirty entries\n"));
803
804 if ( ASMAtomicReadU32(&pCache->cbDirty) > 0
805 && !ASMAtomicReadBool(&pCache->fIoErrorVmSuspended))
806 pdmBlkCacheCommitDirtyEntries(pCache);
807
808 LogFlowFunc(("Entries committed, going to sleep\n"));
809}
810
811static DECLCALLBACK(int) pdmR3BlkCacheSaveExec(PVM pVM, PSSMHANDLE pSSM)
812{
813 PPDMBLKCACHEGLOBAL pBlkCacheGlobal = pVM->pUVM->pdm.s.pBlkCacheGlobal;
814
815 AssertPtr(pBlkCacheGlobal);
816
817 pdmBlkCacheLockEnter(pBlkCacheGlobal);
818
819 SSMR3PutU32(pSSM, pBlkCacheGlobal->cRefs);
820
821 /* Go through the list and save all dirty entries. */
822 PPDMBLKCACHE pBlkCache;
823 RTListForEach(&pBlkCacheGlobal->ListUsers, pBlkCache, PDMBLKCACHE, NodeCacheUser)
824 {
825 uint32_t cEntries = 0;
826 PPDMBLKCACHEENTRY pEntry;
827
828 RTSemRWRequestRead(pBlkCache->SemRWEntries, RT_INDEFINITE_WAIT);
829 SSMR3PutU32(pSSM, (uint32_t)strlen(pBlkCache->pszId));
830 SSMR3PutStrZ(pSSM, pBlkCache->pszId);
831
832 /* Count the number of entries to safe. */
833 RTListForEach(&pBlkCache->ListDirtyNotCommitted, pEntry, PDMBLKCACHEENTRY, NodeNotCommitted)
834 {
835 cEntries++;
836 }
837
838 SSMR3PutU32(pSSM, cEntries);
839
840 /* Walk the list of all dirty entries and save them. */
841 RTListForEach(&pBlkCache->ListDirtyNotCommitted, pEntry, PDMBLKCACHEENTRY, NodeNotCommitted)
842 {
843 /* A few sanity checks. */
844 AssertMsg(!pEntry->cRefs, ("The entry is still referenced\n"));
845 AssertMsg(pEntry->fFlags & PDMBLKCACHE_ENTRY_IS_DIRTY, ("Entry is not dirty\n"));
846 AssertMsg(!(pEntry->fFlags & ~PDMBLKCACHE_ENTRY_IS_DIRTY), ("Invalid flags set\n"));
847 AssertMsg(!pEntry->pWaitingHead && !pEntry->pWaitingTail, ("There are waiting requests\n"));
848 AssertMsg( pEntry->pList == &pBlkCacheGlobal->LruRecentlyUsedIn
849 || pEntry->pList == &pBlkCacheGlobal->LruFrequentlyUsed,
850 ("Invalid list\n"));
851 AssertMsg(pEntry->cbData == pEntry->Core.KeyLast - pEntry->Core.Key + 1,
852 ("Size and range do not match\n"));
853
854 /* Save */
855 SSMR3PutU64(pSSM, pEntry->Core.Key);
856 SSMR3PutU32(pSSM, pEntry->cbData);
857 SSMR3PutMem(pSSM, pEntry->pbData, pEntry->cbData);
858 }
859
860 RTSemRWReleaseRead(pBlkCache->SemRWEntries);
861 }
862
863 pdmBlkCacheLockLeave(pBlkCacheGlobal);
864
865 /* Terminator */
866 return SSMR3PutU32(pSSM, UINT32_MAX);
867}
868
869static DECLCALLBACK(int) pdmR3BlkCacheLoadExec(PVM pVM, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass)
870{
871 PPDMBLKCACHEGLOBAL pBlkCacheGlobal = pVM->pUVM->pdm.s.pBlkCacheGlobal;
872 uint32_t cRefs;
873
874 NOREF(uPass);
875 AssertPtr(pBlkCacheGlobal);
876
877 pdmBlkCacheLockEnter(pBlkCacheGlobal);
878
879 if (uVersion != PDM_BLK_CACHE_SAVED_STATE_VERSION)
880 return VERR_SSM_UNSUPPORTED_DATA_UNIT_VERSION;
881
882 SSMR3GetU32(pSSM, &cRefs);
883
884 /*
885 * Fewer users in the saved state than in the current VM are allowed
886 * because that means that there are only new ones which don't have any saved state
887 * which can get lost.
888 * More saved state entries than registered cache users are only allowed if the
889 * missing users don't have any data saved in the cache.
890 */
891 int rc = VINF_SUCCESS;
892 char *pszId = NULL;
893
894 while ( cRefs > 0
895 && RT_SUCCESS(rc))
896 {
897 PPDMBLKCACHE pBlkCache = NULL;
898 uint32_t cbId = 0;
899
900 SSMR3GetU32(pSSM, &cbId);
901 Assert(cbId > 0);
902
903 cbId++; /* Include terminator */
904 pszId = (char *)RTMemAllocZ(cbId * sizeof(char));
905 if (!pszId)
906 {
907 rc = VERR_NO_MEMORY;
908 break;
909 }
910
911 rc = SSMR3GetStrZ(pSSM, pszId, cbId);
912 AssertRC(rc);
913
914 /* Search for the block cache with the provided id. */
915 pBlkCache = pdmR3BlkCacheFindById(pBlkCacheGlobal, pszId);
916
917 /* Get the entries */
918 uint32_t cEntries;
919 SSMR3GetU32(pSSM, &cEntries);
920
921 if (!pBlkCache && (cEntries > 0))
922 {
923 rc = SSMR3SetCfgError(pSSM, RT_SRC_POS,
924 N_("The VM is missing a block device and there is data in the cache. Please make sure the source and target VMs have compatible storage configurations"));
925 break;
926 }
927
928 RTMemFree(pszId);
929 pszId = NULL;
930
931 while (cEntries > 0)
932 {
933 PPDMBLKCACHEENTRY pEntry;
934 uint64_t off;
935 uint32_t cbEntry;
936
937 SSMR3GetU64(pSSM, &off);
938 SSMR3GetU32(pSSM, &cbEntry);
939
940 pEntry = pdmBlkCacheEntryAlloc(pBlkCache, off, cbEntry, NULL);
941 if (!pEntry)
942 {
943 rc = VERR_NO_MEMORY;
944 break;
945 }
946
947 rc = SSMR3GetMem(pSSM, pEntry->pbData, cbEntry);
948 if (RT_FAILURE(rc))
949 {
950 RTMemFree(pEntry->pbData);
951 RTMemFree(pEntry);
952 break;
953 }
954
955 /* Insert into the tree. */
956 bool fInserted = RTAvlrU64Insert(pBlkCache->pTree, &pEntry->Core);
957 Assert(fInserted); NOREF(fInserted);
958
959 /* Add to the dirty list. */
960 pdmBlkCacheAddDirtyEntry(pBlkCache, pEntry);
961 pdmBlkCacheEntryAddToList(&pBlkCacheGlobal->LruRecentlyUsedIn, pEntry);
962 pdmBlkCacheAdd(pBlkCacheGlobal, cbEntry);
963 pdmBlkCacheEntryRelease(pEntry);
964 cEntries--;
965 }
966
967 cRefs--;
968 }
969
970 if (pszId)
971 RTMemFree(pszId);
972
973 if (cRefs && RT_SUCCESS(rc))
974 rc = SSMR3SetCfgError(pSSM, RT_SRC_POS,
975 N_("Unexpected error while restoring state. Please make sure the source and target VMs have compatible storage configurations"));
976
977 pdmBlkCacheLockLeave(pBlkCacheGlobal);
978
979 if (RT_SUCCESS(rc))
980 {
981 uint32_t u32 = 0;
982 rc = SSMR3GetU32(pSSM, &u32);
983 if (RT_SUCCESS(rc))
984 AssertMsgReturn(u32 == UINT32_MAX, ("%#x\n", u32), VERR_SSM_DATA_UNIT_FORMAT_CHANGED);
985 }
986
987 return rc;
988}
989
990int pdmR3BlkCacheInit(PVM pVM)
991{
992 int rc = VINF_SUCCESS;
993 PUVM pUVM = pVM->pUVM;
994 PPDMBLKCACHEGLOBAL pBlkCacheGlobal;
995
996 LogFlowFunc((": pVM=%p\n", pVM));
997
998 VM_ASSERT_EMT(pVM);
999
1000 PCFGMNODE pCfgRoot = CFGMR3GetRoot(pVM);
1001 PCFGMNODE pCfgBlkCache = CFGMR3GetChild(CFGMR3GetChild(pCfgRoot, "PDM"), "BlkCache");
1002
1003 pBlkCacheGlobal = (PPDMBLKCACHEGLOBAL)RTMemAllocZ(sizeof(PDMBLKCACHEGLOBAL));
1004 if (!pBlkCacheGlobal)
1005 return VERR_NO_MEMORY;
1006
1007 RTListInit(&pBlkCacheGlobal->ListUsers);
1008 pBlkCacheGlobal->pVM = pVM;
1009 pBlkCacheGlobal->cRefs = 0;
1010 pBlkCacheGlobal->cbCached = 0;
1011 pBlkCacheGlobal->fCommitInProgress = false;
1012
1013 /* Initialize members */
1014 pBlkCacheGlobal->LruRecentlyUsedIn.pHead = NULL;
1015 pBlkCacheGlobal->LruRecentlyUsedIn.pTail = NULL;
1016 pBlkCacheGlobal->LruRecentlyUsedIn.cbCached = 0;
1017
1018 pBlkCacheGlobal->LruRecentlyUsedOut.pHead = NULL;
1019 pBlkCacheGlobal->LruRecentlyUsedOut.pTail = NULL;
1020 pBlkCacheGlobal->LruRecentlyUsedOut.cbCached = 0;
1021
1022 pBlkCacheGlobal->LruFrequentlyUsed.pHead = NULL;
1023 pBlkCacheGlobal->LruFrequentlyUsed.pTail = NULL;
1024 pBlkCacheGlobal->LruFrequentlyUsed.cbCached = 0;
1025
1026 do
1027 {
1028 rc = CFGMR3QueryU32Def(pCfgBlkCache, "CacheSize", &pBlkCacheGlobal->cbMax, 5 * _1M);
1029 AssertLogRelRCBreak(rc);
1030 LogFlowFunc(("Maximum number of bytes cached %u\n", pBlkCacheGlobal->cbMax));
1031
1032 pBlkCacheGlobal->cbRecentlyUsedInMax = (pBlkCacheGlobal->cbMax / 100) * 25; /* 25% of the buffer size */
1033 pBlkCacheGlobal->cbRecentlyUsedOutMax = (pBlkCacheGlobal->cbMax / 100) * 50; /* 50% of the buffer size */
1034 LogFlowFunc(("cbRecentlyUsedInMax=%u cbRecentlyUsedOutMax=%u\n",
1035 pBlkCacheGlobal->cbRecentlyUsedInMax, pBlkCacheGlobal->cbRecentlyUsedOutMax));
1036
1037 /** @todo r=aeichner: Experiment to find optimal default values */
1038 rc = CFGMR3QueryU32Def(pCfgBlkCache, "CacheCommitIntervalMs", &pBlkCacheGlobal->u32CommitTimeoutMs, 10000 /* 10sec */);
1039 AssertLogRelRCBreak(rc);
1040 rc = CFGMR3QueryU32Def(pCfgBlkCache, "CacheCommitThreshold", &pBlkCacheGlobal->cbCommitDirtyThreshold, pBlkCacheGlobal->cbMax / 2);
1041 AssertLogRelRCBreak(rc);
1042 } while (0);
1043
1044 if (RT_SUCCESS(rc))
1045 {
1046 STAMR3Register(pVM, &pBlkCacheGlobal->cbMax,
1047 STAMTYPE_U32, STAMVISIBILITY_ALWAYS,
1048 "/PDM/BlkCache/cbMax",
1049 STAMUNIT_BYTES,
1050 "Maximum cache size");
1051 STAMR3Register(pVM, &pBlkCacheGlobal->cbCached,
1052 STAMTYPE_U32, STAMVISIBILITY_ALWAYS,
1053 "/PDM/BlkCache/cbCached",
1054 STAMUNIT_BYTES,
1055 "Currently used cache");
1056 STAMR3Register(pVM, &pBlkCacheGlobal->LruRecentlyUsedIn.cbCached,
1057 STAMTYPE_U32, STAMVISIBILITY_ALWAYS,
1058 "/PDM/BlkCache/cbCachedMruIn",
1059 STAMUNIT_BYTES,
1060 "Number of bytes cached in MRU list");
1061 STAMR3Register(pVM, &pBlkCacheGlobal->LruRecentlyUsedOut.cbCached,
1062 STAMTYPE_U32, STAMVISIBILITY_ALWAYS,
1063 "/PDM/BlkCache/cbCachedMruOut",
1064 STAMUNIT_BYTES,
1065 "Number of bytes cached in FRU list");
1066 STAMR3Register(pVM, &pBlkCacheGlobal->LruFrequentlyUsed.cbCached,
1067 STAMTYPE_U32, STAMVISIBILITY_ALWAYS,
1068 "/PDM/BlkCache/cbCachedFru",
1069 STAMUNIT_BYTES,
1070 "Number of bytes cached in FRU ghost list");
1071
1072#ifdef VBOX_WITH_STATISTICS
1073 STAMR3Register(pVM, &pBlkCacheGlobal->cHits,
1074 STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS,
1075 "/PDM/BlkCache/CacheHits",
1076 STAMUNIT_COUNT, "Number of hits in the cache");
1077 STAMR3Register(pVM, &pBlkCacheGlobal->cPartialHits,
1078 STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS,
1079 "/PDM/BlkCache/CachePartialHits",
1080 STAMUNIT_COUNT, "Number of partial hits in the cache");
1081 STAMR3Register(pVM, &pBlkCacheGlobal->cMisses,
1082 STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS,
1083 "/PDM/BlkCache/CacheMisses",
1084 STAMUNIT_COUNT, "Number of misses when accessing the cache");
1085 STAMR3Register(pVM, &pBlkCacheGlobal->StatRead,
1086 STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS,
1087 "/PDM/BlkCache/CacheRead",
1088 STAMUNIT_BYTES, "Number of bytes read from the cache");
1089 STAMR3Register(pVM, &pBlkCacheGlobal->StatWritten,
1090 STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS,
1091 "/PDM/BlkCache/CacheWritten",
1092 STAMUNIT_BYTES, "Number of bytes written to the cache");
1093 STAMR3Register(pVM, &pBlkCacheGlobal->StatTreeGet,
1094 STAMTYPE_PROFILE_ADV, STAMVISIBILITY_ALWAYS,
1095 "/PDM/BlkCache/CacheTreeGet",
1096 STAMUNIT_TICKS_PER_CALL, "Time taken to access an entry in the tree");
1097 STAMR3Register(pVM, &pBlkCacheGlobal->StatTreeInsert,
1098 STAMTYPE_PROFILE_ADV, STAMVISIBILITY_ALWAYS,
1099 "/PDM/BlkCache/CacheTreeInsert",
1100 STAMUNIT_TICKS_PER_CALL, "Time taken to insert an entry in the tree");
1101 STAMR3Register(pVM, &pBlkCacheGlobal->StatTreeRemove,
1102 STAMTYPE_PROFILE_ADV, STAMVISIBILITY_ALWAYS,
1103 "/PDM/BlkCache/CacheTreeRemove",
1104 STAMUNIT_TICKS_PER_CALL, "Time taken to remove an entry an the tree");
1105 STAMR3Register(pVM, &pBlkCacheGlobal->StatBuffersReused,
1106 STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS,
1107 "/PDM/BlkCache/CacheBuffersReused",
1108 STAMUNIT_COUNT, "Number of times a buffer could be reused");
1109#endif
1110
1111 /* Initialize the critical section */
1112 rc = RTCritSectInit(&pBlkCacheGlobal->CritSect);
1113 }
1114
1115 if (RT_SUCCESS(rc))
1116 {
1117 /* Create the commit timer */
1118 if (pBlkCacheGlobal->u32CommitTimeoutMs > 0)
1119 rc = TMR3TimerCreateInternal(pVM, TMCLOCK_REAL,
1120 pdmBlkCacheCommitTimerCallback,
1121 pBlkCacheGlobal,
1122 "BlkCache-Commit",
1123 &pBlkCacheGlobal->pTimerCommit);
1124
1125 if (RT_SUCCESS(rc))
1126 {
1127 /* Register saved state handler. */
1128 rc = SSMR3RegisterInternal(pVM, "pdmblkcache", 0, PDM_BLK_CACHE_SAVED_STATE_VERSION, pBlkCacheGlobal->cbMax,
1129 NULL, NULL, NULL,
1130 NULL, pdmR3BlkCacheSaveExec, NULL,
1131 NULL, pdmR3BlkCacheLoadExec, NULL);
1132 if (RT_SUCCESS(rc))
1133 {
1134 LogRel(("BlkCache: Cache successfully initialized. Cache size is %u bytes\n", pBlkCacheGlobal->cbMax));
1135 LogRel(("BlkCache: Cache commit interval is %u ms\n", pBlkCacheGlobal->u32CommitTimeoutMs));
1136 LogRel(("BlkCache: Cache commit threshold is %u bytes\n", pBlkCacheGlobal->cbCommitDirtyThreshold));
1137 pUVM->pdm.s.pBlkCacheGlobal = pBlkCacheGlobal;
1138 return VINF_SUCCESS;
1139 }
1140 }
1141
1142 RTCritSectDelete(&pBlkCacheGlobal->CritSect);
1143 }
1144
1145 if (pBlkCacheGlobal)
1146 RTMemFree(pBlkCacheGlobal);
1147
1148 LogFlowFunc((": returns rc=%Rrc\n", rc));
1149 return rc;
1150}
1151
1152void pdmR3BlkCacheTerm(PVM pVM)
1153{
1154 PPDMBLKCACHEGLOBAL pBlkCacheGlobal = pVM->pUVM->pdm.s.pBlkCacheGlobal;
1155
1156 if (pBlkCacheGlobal)
1157 {
1158 /* Make sure no one else uses the cache now */
1159 pdmBlkCacheLockEnter(pBlkCacheGlobal);
1160
1161 /* Cleanup deleting all cache entries waiting for in progress entries to finish. */
1162 pdmBlkCacheDestroyList(&pBlkCacheGlobal->LruRecentlyUsedIn);
1163 pdmBlkCacheDestroyList(&pBlkCacheGlobal->LruRecentlyUsedOut);
1164 pdmBlkCacheDestroyList(&pBlkCacheGlobal->LruFrequentlyUsed);
1165
1166 pdmBlkCacheLockLeave(pBlkCacheGlobal);
1167
1168 RTCritSectDelete(&pBlkCacheGlobal->CritSect);
1169 RTMemFree(pBlkCacheGlobal);
1170 pVM->pUVM->pdm.s.pBlkCacheGlobal = NULL;
1171 }
1172}
1173
1174int pdmR3BlkCacheResume(PVM pVM)
1175{
1176 PPDMBLKCACHEGLOBAL pBlkCacheGlobal = pVM->pUVM->pdm.s.pBlkCacheGlobal;
1177
1178 LogFlowFunc(("pVM=%#p\n", pVM));
1179
1180 if ( pBlkCacheGlobal
1181 && ASMAtomicXchgBool(&pBlkCacheGlobal->fIoErrorVmSuspended, false))
1182 {
1183 /* The VM was suspended because of an I/O error, commit all dirty entries. */
1184 pdmBlkCacheCommitDirtyEntries(pBlkCacheGlobal);
1185 }
1186
1187 return VINF_SUCCESS;
1188}
1189
1190static int pdmR3BlkCacheRetain(PVM pVM, PPPDMBLKCACHE ppBlkCache, const char *pcszId)
1191{
1192 int rc = VINF_SUCCESS;
1193 PPDMBLKCACHE pBlkCache = NULL;
1194 PPDMBLKCACHEGLOBAL pBlkCacheGlobal = pVM->pUVM->pdm.s.pBlkCacheGlobal;
1195
1196 if (!pBlkCacheGlobal)
1197 return VERR_NOT_SUPPORTED;
1198
1199 /*
1200 * Check that no other user cache has the same id first,
1201 * Unique id's are necessary in case the state is saved.
1202 */
1203 pdmBlkCacheLockEnter(pBlkCacheGlobal);
1204
1205 pBlkCache = pdmR3BlkCacheFindById(pBlkCacheGlobal, pcszId);
1206
1207 if (!pBlkCache)
1208 {
1209 pBlkCache = (PPDMBLKCACHE)RTMemAllocZ(sizeof(PDMBLKCACHE));
1210
1211 if (pBlkCache)
1212 pBlkCache->pszId = RTStrDup(pcszId);
1213
1214 if ( pBlkCache
1215 && pBlkCache->pszId)
1216 {
1217 pBlkCache->fSuspended = false;
1218 pBlkCache->pCache = pBlkCacheGlobal;
1219 RTListInit(&pBlkCache->ListDirtyNotCommitted);
1220
1221 rc = RTSpinlockCreate(&pBlkCache->LockList, RTSPINLOCK_FLAGS_INTERRUPT_UNSAFE, "pdmR3BlkCacheRetain");
1222 if (RT_SUCCESS(rc))
1223 {
1224 rc = RTSemRWCreate(&pBlkCache->SemRWEntries);
1225 if (RT_SUCCESS(rc))
1226 {
1227 pBlkCache->pTree = (PAVLRU64TREE)RTMemAllocZ(sizeof(AVLRFOFFTREE));
1228 if (pBlkCache->pTree)
1229 {
1230#ifdef VBOX_WITH_STATISTICS
1231 STAMR3RegisterF(pBlkCacheGlobal->pVM, &pBlkCache->StatWriteDeferred,
1232 STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS,
1233 STAMUNIT_COUNT, "Number of deferred writes",
1234 "/PDM/BlkCache/%s/Cache/DeferredWrites", pBlkCache->pszId);
1235#endif
1236
1237 /* Add to the list of users. */
1238 pBlkCacheGlobal->cRefs++;
1239 RTListAppend(&pBlkCacheGlobal->ListUsers, &pBlkCache->NodeCacheUser);
1240 pdmBlkCacheLockLeave(pBlkCacheGlobal);
1241
1242 *ppBlkCache = pBlkCache;
1243 LogFlowFunc(("returns success\n"));
1244 return VINF_SUCCESS;
1245 }
1246
1247 rc = VERR_NO_MEMORY;
1248 RTSemRWDestroy(pBlkCache->SemRWEntries);
1249 }
1250
1251 RTSpinlockDestroy(pBlkCache->LockList);
1252 }
1253
1254 RTStrFree(pBlkCache->pszId);
1255 }
1256 else
1257 rc = VERR_NO_MEMORY;
1258
1259 if (pBlkCache)
1260 RTMemFree(pBlkCache);
1261 }
1262 else
1263 rc = VERR_ALREADY_EXISTS;
1264
1265 pdmBlkCacheLockLeave(pBlkCacheGlobal);
1266
1267 LogFlowFunc(("Leave rc=%Rrc\n", rc));
1268 return rc;
1269}
1270
1271VMMR3DECL(int) PDMR3BlkCacheRetainDriver(PVM pVM, PPDMDRVINS pDrvIns, PPPDMBLKCACHE ppBlkCache,
1272 PFNPDMBLKCACHEXFERCOMPLETEDRV pfnXferComplete,
1273 PFNPDMBLKCACHEXFERENQUEUEDRV pfnXferEnqueue,
1274 PFNPDMBLKCACHEXFERENQUEUEDISCARDDRV pfnXferEnqueueDiscard,
1275 const char *pcszId)
1276{
1277 int rc = VINF_SUCCESS;
1278 PPDMBLKCACHE pBlkCache;
1279
1280 rc = pdmR3BlkCacheRetain(pVM, &pBlkCache, pcszId);
1281 if (RT_SUCCESS(rc))
1282 {
1283 pBlkCache->enmType = PDMBLKCACHETYPE_DRV;
1284 pBlkCache->u.Drv.pfnXferComplete = pfnXferComplete;
1285 pBlkCache->u.Drv.pfnXferEnqueue = pfnXferEnqueue;
1286 pBlkCache->u.Drv.pfnXferEnqueueDiscard = pfnXferEnqueueDiscard;
1287 pBlkCache->u.Drv.pDrvIns = pDrvIns;
1288 *ppBlkCache = pBlkCache;
1289 }
1290
1291 LogFlowFunc(("Leave rc=%Rrc\n", rc));
1292 return rc;
1293}
1294
1295VMMR3DECL(int) PDMR3BlkCacheRetainDevice(PVM pVM, PPDMDEVINS pDevIns, PPPDMBLKCACHE ppBlkCache,
1296 PFNPDMBLKCACHEXFERCOMPLETEDEV pfnXferComplete,
1297 PFNPDMBLKCACHEXFERENQUEUEDEV pfnXferEnqueue,
1298 PFNPDMBLKCACHEXFERENQUEUEDISCARDDEV pfnXferEnqueueDiscard,
1299 const char *pcszId)
1300{
1301 int rc = VINF_SUCCESS;
1302 PPDMBLKCACHE pBlkCache;
1303
1304 rc = pdmR3BlkCacheRetain(pVM, &pBlkCache, pcszId);
1305 if (RT_SUCCESS(rc))
1306 {
1307 pBlkCache->enmType = PDMBLKCACHETYPE_DEV;
1308 pBlkCache->u.Dev.pfnXferComplete = pfnXferComplete;
1309 pBlkCache->u.Dev.pfnXferEnqueue = pfnXferEnqueue;
1310 pBlkCache->u.Dev.pfnXferEnqueueDiscard = pfnXferEnqueueDiscard;
1311 pBlkCache->u.Dev.pDevIns = pDevIns;
1312 *ppBlkCache = pBlkCache;
1313 }
1314
1315 LogFlowFunc(("Leave rc=%Rrc\n", rc));
1316 return rc;
1317
1318}
1319
1320VMMR3DECL(int) PDMR3BlkCacheRetainUsb(PVM pVM, PPDMUSBINS pUsbIns, PPPDMBLKCACHE ppBlkCache,
1321 PFNPDMBLKCACHEXFERCOMPLETEUSB pfnXferComplete,
1322 PFNPDMBLKCACHEXFERENQUEUEUSB pfnXferEnqueue,
1323 PFNPDMBLKCACHEXFERENQUEUEDISCARDUSB pfnXferEnqueueDiscard,
1324 const char *pcszId)
1325{
1326 int rc = VINF_SUCCESS;
1327 PPDMBLKCACHE pBlkCache;
1328
1329 rc = pdmR3BlkCacheRetain(pVM, &pBlkCache, pcszId);
1330 if (RT_SUCCESS(rc))
1331 {
1332 pBlkCache->enmType = PDMBLKCACHETYPE_USB;
1333 pBlkCache->u.Usb.pfnXferComplete = pfnXferComplete;
1334 pBlkCache->u.Usb.pfnXferEnqueue = pfnXferEnqueue;
1335 pBlkCache->u.Usb.pfnXferEnqueueDiscard = pfnXferEnqueueDiscard;
1336 pBlkCache->u.Usb.pUsbIns = pUsbIns;
1337 *ppBlkCache = pBlkCache;
1338 }
1339
1340 LogFlowFunc(("Leave rc=%Rrc\n", rc));
1341 return rc;
1342
1343}
1344
1345VMMR3DECL(int) PDMR3BlkCacheRetainInt(PVM pVM, void *pvUser, PPPDMBLKCACHE ppBlkCache,
1346 PFNPDMBLKCACHEXFERCOMPLETEINT pfnXferComplete,
1347 PFNPDMBLKCACHEXFERENQUEUEINT pfnXferEnqueue,
1348 PFNPDMBLKCACHEXFERENQUEUEDISCARDINT pfnXferEnqueueDiscard,
1349 const char *pcszId)
1350{
1351 int rc = VINF_SUCCESS;
1352 PPDMBLKCACHE pBlkCache;
1353
1354 rc = pdmR3BlkCacheRetain(pVM, &pBlkCache, pcszId);
1355 if (RT_SUCCESS(rc))
1356 {
1357 pBlkCache->enmType = PDMBLKCACHETYPE_INTERNAL;
1358 pBlkCache->u.Int.pfnXferComplete = pfnXferComplete;
1359 pBlkCache->u.Int.pfnXferEnqueue = pfnXferEnqueue;
1360 pBlkCache->u.Int.pfnXferEnqueueDiscard = pfnXferEnqueueDiscard;
1361 pBlkCache->u.Int.pvUser = pvUser;
1362 *ppBlkCache = pBlkCache;
1363 }
1364
1365 LogFlowFunc(("Leave rc=%Rrc\n", rc));
1366 return rc;
1367
1368}
1369
1370/**
1371 * Callback for the AVL destroy routine. Frees a cache entry for this endpoint.
1372 *
1373 * @returns IPRT status code.
1374 * @param pNode The node to destroy.
1375 * @param pvUser Opaque user data.
1376 */
1377static DECLCALLBACK(int) pdmBlkCacheEntryDestroy(PAVLRU64NODECORE pNode, void *pvUser)
1378{
1379 PPDMBLKCACHEENTRY pEntry = (PPDMBLKCACHEENTRY)pNode;
1380 PPDMBLKCACHEGLOBAL pCache = (PPDMBLKCACHEGLOBAL)pvUser;
1381 PPDMBLKCACHE pBlkCache = pEntry->pBlkCache;
1382
1383 while (ASMAtomicReadU32(&pEntry->fFlags) & PDMBLKCACHE_ENTRY_IO_IN_PROGRESS)
1384 {
1385 /* Leave the locks to let the I/O thread make progress but reference the entry to prevent eviction. */
1386 pdmBlkCacheEntryRef(pEntry);
1387 RTSemRWReleaseWrite(pBlkCache->SemRWEntries);
1388 pdmBlkCacheLockLeave(pCache);
1389
1390 RTThreadSleep(250);
1391
1392 /* Re-enter all locks */
1393 pdmBlkCacheLockEnter(pCache);
1394 RTSemRWRequestWrite(pBlkCache->SemRWEntries, RT_INDEFINITE_WAIT);
1395 pdmBlkCacheEntryRelease(pEntry);
1396 }
1397
1398 AssertMsg(!(pEntry->fFlags & PDMBLKCACHE_ENTRY_IO_IN_PROGRESS),
1399 ("Entry is dirty and/or still in progress fFlags=%#x\n", pEntry->fFlags));
1400
1401 bool fUpdateCache = pEntry->pList == &pCache->LruFrequentlyUsed
1402 || pEntry->pList == &pCache->LruRecentlyUsedIn;
1403
1404 pdmBlkCacheEntryRemoveFromList(pEntry);
1405
1406 if (fUpdateCache)
1407 pdmBlkCacheSub(pCache, pEntry->cbData);
1408
1409 RTMemPageFree(pEntry->pbData, pEntry->cbData);
1410 RTMemFree(pEntry);
1411
1412 return VINF_SUCCESS;
1413}
1414
1415/**
1416 * Destroys all cache resources used by the given endpoint.
1417 *
1418 * @returns nothing.
1419 * @param pEndpoint The endpoint to the destroy.
1420 */
1421VMMR3DECL(void) PDMR3BlkCacheRelease(PPDMBLKCACHE pBlkCache)
1422{
1423 PPDMBLKCACHEGLOBAL pCache = pBlkCache->pCache;
1424
1425 /*
1426 * Commit all dirty entries now (they are waited on for completion during the
1427 * destruction of the AVL tree below).
1428 * The exception is if the VM was paused because of an I/O error before.
1429 */
1430 if (!ASMAtomicReadBool(&pCache->fIoErrorVmSuspended))
1431 pdmBlkCacheCommit(pBlkCache);
1432
1433 /* Make sure nobody is accessing the cache while we delete the tree. */
1434 pdmBlkCacheLockEnter(pCache);
1435 RTSemRWRequestWrite(pBlkCache->SemRWEntries, RT_INDEFINITE_WAIT);
1436 RTAvlrU64Destroy(pBlkCache->pTree, pdmBlkCacheEntryDestroy, pCache);
1437 RTSemRWReleaseWrite(pBlkCache->SemRWEntries);
1438
1439 RTSpinlockDestroy(pBlkCache->LockList);
1440
1441 pCache->cRefs--;
1442 RTListNodeRemove(&pBlkCache->NodeCacheUser);
1443
1444 pdmBlkCacheLockLeave(pCache);
1445
1446 RTSemRWDestroy(pBlkCache->SemRWEntries);
1447
1448#ifdef VBOX_WITH_STATISTICS
1449 STAMR3DeregisterF(pCache->pVM->pUVM, "/PDM/BlkCache/%s/Cache/DeferredWrites", pBlkCache->pszId);
1450#endif
1451
1452 RTStrFree(pBlkCache->pszId);
1453 RTMemFree(pBlkCache);
1454}
1455
1456VMMR3DECL(void) PDMR3BlkCacheReleaseDevice(PVM pVM, PPDMDEVINS pDevIns)
1457{
1458 LogFlow(("%s: pDevIns=%p\n", __FUNCTION__, pDevIns));
1459
1460 /*
1461 * Validate input.
1462 */
1463 if (!pDevIns)
1464 return;
1465 VM_ASSERT_EMT(pVM);
1466
1467 PPDMBLKCACHEGLOBAL pBlkCacheGlobal = pVM->pUVM->pdm.s.pBlkCacheGlobal;
1468 PPDMBLKCACHE pBlkCache, pBlkCacheNext;
1469
1470 /* Return silently if not supported. */
1471 if (!pBlkCacheGlobal)
1472 return;
1473
1474 pdmBlkCacheLockEnter(pBlkCacheGlobal);
1475
1476 RTListForEachSafe(&pBlkCacheGlobal->ListUsers, pBlkCache, pBlkCacheNext, PDMBLKCACHE, NodeCacheUser)
1477 {
1478 if ( pBlkCache->enmType == PDMBLKCACHETYPE_DEV
1479 && pBlkCache->u.Dev.pDevIns == pDevIns)
1480 PDMR3BlkCacheRelease(pBlkCache);
1481 }
1482
1483 pdmBlkCacheLockLeave(pBlkCacheGlobal);
1484}
1485
1486VMMR3DECL(void) PDMR3BlkCacheReleaseDriver(PVM pVM, PPDMDRVINS pDrvIns)
1487{
1488 LogFlow(("%s: pDrvIns=%p\n", __FUNCTION__, pDrvIns));
1489
1490 /*
1491 * Validate input.
1492 */
1493 if (!pDrvIns)
1494 return;
1495 VM_ASSERT_EMT(pVM);
1496
1497 PPDMBLKCACHEGLOBAL pBlkCacheGlobal = pVM->pUVM->pdm.s.pBlkCacheGlobal;
1498 PPDMBLKCACHE pBlkCache, pBlkCacheNext;
1499
1500 /* Return silently if not supported. */
1501 if (!pBlkCacheGlobal)
1502 return;
1503
1504 pdmBlkCacheLockEnter(pBlkCacheGlobal);
1505
1506 RTListForEachSafe(&pBlkCacheGlobal->ListUsers, pBlkCache, pBlkCacheNext, PDMBLKCACHE, NodeCacheUser)
1507 {
1508 if ( pBlkCache->enmType == PDMBLKCACHETYPE_DRV
1509 && pBlkCache->u.Drv.pDrvIns == pDrvIns)
1510 PDMR3BlkCacheRelease(pBlkCache);
1511 }
1512
1513 pdmBlkCacheLockLeave(pBlkCacheGlobal);
1514}
1515
1516VMMR3DECL(void) PDMR3BlkCacheReleaseUsb(PVM pVM, PPDMUSBINS pUsbIns)
1517{
1518 LogFlow(("%s: pUsbIns=%p\n", __FUNCTION__, pUsbIns));
1519
1520 /*
1521 * Validate input.
1522 */
1523 if (!pUsbIns)
1524 return;
1525 VM_ASSERT_EMT(pVM);
1526
1527 PPDMBLKCACHEGLOBAL pBlkCacheGlobal = pVM->pUVM->pdm.s.pBlkCacheGlobal;
1528 PPDMBLKCACHE pBlkCache, pBlkCacheNext;
1529
1530 /* Return silently if not supported. */
1531 if (!pBlkCacheGlobal)
1532 return;
1533
1534 pdmBlkCacheLockEnter(pBlkCacheGlobal);
1535
1536 RTListForEachSafe(&pBlkCacheGlobal->ListUsers, pBlkCache, pBlkCacheNext, PDMBLKCACHE, NodeCacheUser)
1537 {
1538 if ( pBlkCache->enmType == PDMBLKCACHETYPE_USB
1539 && pBlkCache->u.Usb.pUsbIns == pUsbIns)
1540 PDMR3BlkCacheRelease(pBlkCache);
1541 }
1542
1543 pdmBlkCacheLockLeave(pBlkCacheGlobal);
1544}
1545
1546static PPDMBLKCACHEENTRY pdmBlkCacheGetCacheEntryByOffset(PPDMBLKCACHE pBlkCache, uint64_t off)
1547{
1548 STAM_PROFILE_ADV_START(&pBlkCache->pCache->StatTreeGet, Cache);
1549
1550 RTSemRWRequestRead(pBlkCache->SemRWEntries, RT_INDEFINITE_WAIT);
1551 PPDMBLKCACHEENTRY pEntry = (PPDMBLKCACHEENTRY)RTAvlrU64RangeGet(pBlkCache->pTree, off);
1552 if (pEntry)
1553 pdmBlkCacheEntryRef(pEntry);
1554 RTSemRWReleaseRead(pBlkCache->SemRWEntries);
1555
1556 STAM_PROFILE_ADV_STOP(&pBlkCache->pCache->StatTreeGet, Cache);
1557
1558 return pEntry;
1559}
1560
1561/**
1562 * Return the best fit cache entries for the given offset.
1563 *
1564 * @returns nothing.
1565 * @param pBlkCache The endpoint cache.
1566 * @param off The offset.
1567 * @param pEntryAbove Where to store the pointer to the best fit entry above the
1568 * the given offset. NULL if not required.
1569 */
1570static void pdmBlkCacheGetCacheBestFitEntryByOffset(PPDMBLKCACHE pBlkCache, uint64_t off,
1571 PPDMBLKCACHEENTRY *ppEntryAbove)
1572{
1573 STAM_PROFILE_ADV_START(&pBlkCache->pCache->StatTreeGet, Cache);
1574
1575 RTSemRWRequestRead(pBlkCache->SemRWEntries, RT_INDEFINITE_WAIT);
1576 if (ppEntryAbove)
1577 {
1578 *ppEntryAbove = (PPDMBLKCACHEENTRY)RTAvlrU64GetBestFit(pBlkCache->pTree, off, true /*fAbove*/);
1579 if (*ppEntryAbove)
1580 pdmBlkCacheEntryRef(*ppEntryAbove);
1581 }
1582
1583 RTSemRWReleaseRead(pBlkCache->SemRWEntries);
1584
1585 STAM_PROFILE_ADV_STOP(&pBlkCache->pCache->StatTreeGet, Cache);
1586}
1587
1588static void pdmBlkCacheInsertEntry(PPDMBLKCACHE pBlkCache, PPDMBLKCACHEENTRY pEntry)
1589{
1590 STAM_PROFILE_ADV_START(&pBlkCache->pCache->StatTreeInsert, Cache);
1591 RTSemRWRequestWrite(pBlkCache->SemRWEntries, RT_INDEFINITE_WAIT);
1592 bool fInserted = RTAvlrU64Insert(pBlkCache->pTree, &pEntry->Core);
1593 AssertMsg(fInserted, ("Node was not inserted into tree\n")); NOREF(fInserted);
1594 STAM_PROFILE_ADV_STOP(&pBlkCache->pCache->StatTreeInsert, Cache);
1595 RTSemRWReleaseWrite(pBlkCache->SemRWEntries);
1596}
1597
1598/**
1599 * Allocates and initializes a new entry for the cache.
1600 * The entry has a reference count of 1.
1601 *
1602 * @returns Pointer to the new cache entry or NULL if out of memory.
1603 * @param pBlkCache The cache the entry belongs to.
1604 * @param off Start offset.
1605 * @param cbData Size of the cache entry.
1606 * @param pbBuffer Pointer to the buffer to use.
1607 * NULL if a new buffer should be allocated.
1608 * The buffer needs to have the same size of the entry.
1609 */
1610static PPDMBLKCACHEENTRY pdmBlkCacheEntryAlloc(PPDMBLKCACHE pBlkCache,
1611 uint64_t off, size_t cbData, uint8_t *pbBuffer)
1612{
1613 AssertReturn(cbData <= UINT32_MAX, NULL);
1614 PPDMBLKCACHEENTRY pEntryNew = (PPDMBLKCACHEENTRY)RTMemAllocZ(sizeof(PDMBLKCACHEENTRY));
1615
1616 if (RT_UNLIKELY(!pEntryNew))
1617 return NULL;
1618
1619 pEntryNew->Core.Key = off;
1620 pEntryNew->Core.KeyLast = off + cbData - 1;
1621 pEntryNew->pBlkCache = pBlkCache;
1622 pEntryNew->fFlags = 0;
1623 pEntryNew->cRefs = 1; /* We are using it now. */
1624 pEntryNew->pList = NULL;
1625 pEntryNew->cbData = (uint32_t)cbData;
1626 pEntryNew->pWaitingHead = NULL;
1627 pEntryNew->pWaitingTail = NULL;
1628 if (pbBuffer)
1629 pEntryNew->pbData = pbBuffer;
1630 else
1631 pEntryNew->pbData = (uint8_t *)RTMemPageAlloc(cbData);
1632
1633 if (RT_UNLIKELY(!pEntryNew->pbData))
1634 {
1635 RTMemFree(pEntryNew);
1636 return NULL;
1637 }
1638
1639 return pEntryNew;
1640}
1641
1642/**
1643 * Checks that a set of flags is set/clear acquiring the R/W semaphore
1644 * in exclusive mode.
1645 *
1646 * @returns true if the flag in fSet is set and the one in fClear is clear.
1647 * false otherwise.
1648 * The R/W semaphore is only held if true is returned.
1649 *
1650 * @param pBlkCache The endpoint cache instance data.
1651 * @param pEntry The entry to check the flags for.
1652 * @param fSet The flag which is tested to be set.
1653 * @param fClear The flag which is tested to be clear.
1654 */
1655DECLINLINE(bool) pdmBlkCacheEntryFlagIsSetClearAcquireLock(PPDMBLKCACHE pBlkCache,
1656 PPDMBLKCACHEENTRY pEntry,
1657 uint32_t fSet, uint32_t fClear)
1658{
1659 uint32_t fFlags = ASMAtomicReadU32(&pEntry->fFlags);
1660 bool fPassed = ((fFlags & fSet) && !(fFlags & fClear));
1661
1662 if (fPassed)
1663 {
1664 /* Acquire the lock and check again because the completion callback might have raced us. */
1665 RTSemRWRequestWrite(pBlkCache->SemRWEntries, RT_INDEFINITE_WAIT);
1666
1667 fFlags = ASMAtomicReadU32(&pEntry->fFlags);
1668 fPassed = ((fFlags & fSet) && !(fFlags & fClear));
1669
1670 /* Drop the lock if we didn't passed the test. */
1671 if (!fPassed)
1672 RTSemRWReleaseWrite(pBlkCache->SemRWEntries);
1673 }
1674
1675 return fPassed;
1676}
1677
1678/**
1679 * Adds a segment to the waiting list for a cache entry
1680 * which is currently in progress.
1681 *
1682 * @returns nothing.
1683 * @param pEntry The cache entry to add the segment to.
1684 * @param pSeg The segment to add.
1685 */
1686DECLINLINE(void) pdmBlkCacheEntryAddWaiter(PPDMBLKCACHEENTRY pEntry,
1687 PPDMBLKCACHEWAITER pWaiter)
1688{
1689 pWaiter->pNext = NULL;
1690
1691 if (pEntry->pWaitingHead)
1692 {
1693 AssertPtr(pEntry->pWaitingTail);
1694
1695 pEntry->pWaitingTail->pNext = pWaiter;
1696 pEntry->pWaitingTail = pWaiter;
1697 }
1698 else
1699 {
1700 Assert(!pEntry->pWaitingTail);
1701
1702 pEntry->pWaitingHead = pWaiter;
1703 pEntry->pWaitingTail = pWaiter;
1704 }
1705}
1706
1707/**
1708 * Add a buffer described by the I/O memory context
1709 * to the entry waiting for completion.
1710 *
1711 * @returns VBox status code.
1712 * @param pEntry The entry to add the buffer to.
1713 * @param pTask Task associated with the buffer.
1714 * @param pIoMemCtx The memory context to use.
1715 * @param offDiff Offset from the start of the buffer
1716 * in the entry.
1717 * @param cbData Amount of data to wait for onthis entry.
1718 * @param fWrite Flag whether the task waits because it wants to write
1719 * to the cache entry.
1720 */
1721static int pdmBlkCacheEntryWaitersAdd(PPDMBLKCACHEENTRY pEntry,
1722 PPDMBLKCACHEREQ pReq,
1723 PRTSGBUF pSgBuf, uint64_t offDiff,
1724 size_t cbData, bool fWrite)
1725{
1726 PPDMBLKCACHEWAITER pWaiter = (PPDMBLKCACHEWAITER)RTMemAllocZ(sizeof(PDMBLKCACHEWAITER));
1727 if (!pWaiter)
1728 return VERR_NO_MEMORY;
1729
1730 ASMAtomicIncU32(&pReq->cXfersPending);
1731 pWaiter->pReq = pReq;
1732 pWaiter->offCacheEntry = offDiff;
1733 pWaiter->cbTransfer = cbData;
1734 pWaiter->fWrite = fWrite;
1735 RTSgBufClone(&pWaiter->SgBuf, pSgBuf);
1736 RTSgBufAdvance(pSgBuf, cbData);
1737
1738 pdmBlkCacheEntryAddWaiter(pEntry, pWaiter);
1739
1740 return VINF_SUCCESS;
1741}
1742
1743/**
1744 * Calculate aligned offset and size for a new cache entry which do not
1745 * intersect with an already existing entry and the file end.
1746 *
1747 * @returns The number of bytes the entry can hold of the requested amount
1748 * of bytes.
1749 * @param pEndpoint The endpoint.
1750 * @param pBlkCache The endpoint cache.
1751 * @param off The start offset.
1752 * @param cb The number of bytes the entry needs to hold at
1753 * least.
1754 * @param pcbEntry Where to store the number of bytes the entry can hold.
1755 * Can be less than given because of other entries.
1756 */
1757static uint32_t pdmBlkCacheEntryBoundariesCalc(PPDMBLKCACHE pBlkCache,
1758 uint64_t off, uint32_t cb,
1759 uint32_t *pcbEntry)
1760{
1761 /* Get the best fit entries around the offset */
1762 PPDMBLKCACHEENTRY pEntryAbove = NULL;
1763 pdmBlkCacheGetCacheBestFitEntryByOffset(pBlkCache, off, &pEntryAbove);
1764
1765 /* Log the info */
1766 LogFlow(("%sest fit entry above off=%llu (BestFit=%llu BestFitEnd=%llu BestFitSize=%u)\n",
1767 pEntryAbove ? "B" : "No b",
1768 off,
1769 pEntryAbove ? pEntryAbove->Core.Key : 0,
1770 pEntryAbove ? pEntryAbove->Core.KeyLast : 0,
1771 pEntryAbove ? pEntryAbove->cbData : 0));
1772
1773 uint32_t cbNext;
1774 uint32_t cbInEntry;
1775 if ( pEntryAbove
1776 && off + cb > pEntryAbove->Core.Key)
1777 {
1778 cbInEntry = (uint32_t)(pEntryAbove->Core.Key - off);
1779 cbNext = (uint32_t)(pEntryAbove->Core.Key - off);
1780 }
1781 else
1782 {
1783 cbInEntry = cb;
1784 cbNext = cb;
1785 }
1786
1787 /* A few sanity checks */
1788 AssertMsg(!pEntryAbove || off + cbNext <= pEntryAbove->Core.Key,
1789 ("Aligned size intersects with another cache entry\n"));
1790 Assert(cbInEntry <= cbNext);
1791
1792 if (pEntryAbove)
1793 pdmBlkCacheEntryRelease(pEntryAbove);
1794
1795 LogFlow(("off=%llu cbNext=%u\n", off, cbNext));
1796
1797 *pcbEntry = cbNext;
1798
1799 return cbInEntry;
1800}
1801
1802/**
1803 * Create a new cache entry evicting data from the cache if required.
1804 *
1805 * @returns Pointer to the new cache entry or NULL
1806 * if not enough bytes could be evicted from the cache.
1807 * @param pEndpoint The endpoint.
1808 * @param pBlkCache The endpoint cache.
1809 * @param off The offset.
1810 * @param cb Number of bytes the cache entry should have.
1811 * @param pcbData Where to store the number of bytes the new
1812 * entry can hold. May be lower than actually requested
1813 * due to another entry intersecting the access range.
1814 */
1815static PPDMBLKCACHEENTRY pdmBlkCacheEntryCreate(PPDMBLKCACHE pBlkCache,
1816 uint64_t off, size_t cb,
1817 size_t *pcbData)
1818{
1819 uint32_t cbEntry = 0;
1820
1821 *pcbData = pdmBlkCacheEntryBoundariesCalc(pBlkCache, off, (uint32_t)cb, &cbEntry);
1822 AssertReturn(cb <= UINT32_MAX, NULL);
1823
1824 PPDMBLKCACHEGLOBAL pCache = pBlkCache->pCache;
1825 pdmBlkCacheLockEnter(pCache);
1826
1827 PPDMBLKCACHEENTRY pEntryNew = NULL;
1828 uint8_t *pbBuffer = NULL;
1829 bool fEnough = pdmBlkCacheReclaim(pCache, cbEntry, true, &pbBuffer);
1830 if (fEnough)
1831 {
1832 LogFlow(("Evicted enough bytes (%u requested). Creating new cache entry\n", cbEntry));
1833
1834 pEntryNew = pdmBlkCacheEntryAlloc(pBlkCache, off, cbEntry, pbBuffer);
1835 if (RT_LIKELY(pEntryNew))
1836 {
1837 pdmBlkCacheEntryAddToList(&pCache->LruRecentlyUsedIn, pEntryNew);
1838 pdmBlkCacheAdd(pCache, cbEntry);
1839 pdmBlkCacheLockLeave(pCache);
1840
1841 pdmBlkCacheInsertEntry(pBlkCache, pEntryNew);
1842
1843 AssertMsg( (off >= pEntryNew->Core.Key)
1844 && (off + *pcbData <= pEntryNew->Core.KeyLast + 1),
1845 ("Overflow in calculation off=%llu\n", off));
1846 }
1847 else
1848 pdmBlkCacheLockLeave(pCache);
1849 }
1850 else
1851 pdmBlkCacheLockLeave(pCache);
1852
1853 return pEntryNew;
1854}
1855
1856static PPDMBLKCACHEREQ pdmBlkCacheReqAlloc(void *pvUser)
1857{
1858 PPDMBLKCACHEREQ pReq = (PPDMBLKCACHEREQ)RTMemAlloc(sizeof(PDMBLKCACHEREQ));
1859
1860 if (RT_LIKELY(pReq))
1861 {
1862 pReq->pvUser = pvUser;
1863 pReq->rcReq = VINF_SUCCESS;
1864 pReq->cXfersPending = 0;
1865 }
1866
1867 return pReq;
1868}
1869
1870static void pdmBlkCacheReqComplete(PPDMBLKCACHE pBlkCache, PPDMBLKCACHEREQ pReq)
1871{
1872 switch (pBlkCache->enmType)
1873 {
1874 case PDMBLKCACHETYPE_DEV:
1875 {
1876 pBlkCache->u.Dev.pfnXferComplete(pBlkCache->u.Dev.pDevIns,
1877 pReq->pvUser, pReq->rcReq);
1878 break;
1879 }
1880 case PDMBLKCACHETYPE_DRV:
1881 {
1882 pBlkCache->u.Drv.pfnXferComplete(pBlkCache->u.Drv.pDrvIns,
1883 pReq->pvUser, pReq->rcReq);
1884 break;
1885 }
1886 case PDMBLKCACHETYPE_USB:
1887 {
1888 pBlkCache->u.Usb.pfnXferComplete(pBlkCache->u.Usb.pUsbIns,
1889 pReq->pvUser, pReq->rcReq);
1890 break;
1891 }
1892 case PDMBLKCACHETYPE_INTERNAL:
1893 {
1894 pBlkCache->u.Int.pfnXferComplete(pBlkCache->u.Int.pvUser,
1895 pReq->pvUser, pReq->rcReq);
1896 break;
1897 }
1898 default:
1899 AssertMsgFailed(("Unknown block cache type!\n"));
1900 }
1901
1902 RTMemFree(pReq);
1903}
1904
1905static bool pdmBlkCacheReqUpdate(PPDMBLKCACHE pBlkCache, PPDMBLKCACHEREQ pReq,
1906 int rcReq, bool fCallHandler)
1907{
1908 if (RT_FAILURE(rcReq))
1909 ASMAtomicCmpXchgS32(&pReq->rcReq, rcReq, VINF_SUCCESS);
1910
1911 AssertMsg(pReq->cXfersPending > 0, ("No transfers are pending for this request\n"));
1912 uint32_t cXfersPending = ASMAtomicDecU32(&pReq->cXfersPending);
1913
1914 if (!cXfersPending)
1915 {
1916 if (fCallHandler)
1917 pdmBlkCacheReqComplete(pBlkCache, pReq);
1918 return true;
1919 }
1920
1921 LogFlowFunc(("pReq=%#p cXfersPending=%u\n", pReq, cXfersPending));
1922 return false;
1923}
1924
1925VMMR3DECL(int) PDMR3BlkCacheRead(PPDMBLKCACHE pBlkCache, uint64_t off,
1926 PCRTSGBUF pcSgBuf, size_t cbRead, void *pvUser)
1927{
1928 int rc = VINF_SUCCESS;
1929 PPDMBLKCACHEGLOBAL pCache = pBlkCache->pCache;
1930 PPDMBLKCACHEENTRY pEntry;
1931 PPDMBLKCACHEREQ pReq;
1932
1933 LogFlowFunc((": pBlkCache=%#p{%s} off=%llu pcSgBuf=%#p cbRead=%u pvUser=%#p\n",
1934 pBlkCache, pBlkCache->pszId, off, pcSgBuf, cbRead, pvUser));
1935
1936 AssertPtrReturn(pBlkCache, VERR_INVALID_POINTER);
1937 AssertReturn(!pBlkCache->fSuspended, VERR_INVALID_STATE);
1938
1939 RTSGBUF SgBuf;
1940 RTSgBufClone(&SgBuf, pcSgBuf);
1941
1942 /* Allocate new request structure. */
1943 pReq = pdmBlkCacheReqAlloc(pvUser);
1944 if (RT_UNLIKELY(!pReq))
1945 return VERR_NO_MEMORY;
1946
1947 /* Increment data transfer counter to keep the request valid while we access it. */
1948 ASMAtomicIncU32(&pReq->cXfersPending);
1949
1950 while (cbRead)
1951 {
1952 size_t cbToRead;
1953
1954 pEntry = pdmBlkCacheGetCacheEntryByOffset(pBlkCache, off);
1955
1956 /*
1957 * If there is no entry we try to create a new one eviciting unused pages
1958 * if the cache is full. If this is not possible we will pass the request through
1959 * and skip the caching (all entries may be still in progress so they can't
1960 * be evicted)
1961 * If we have an entry it can be in one of the LRU lists where the entry
1962 * contains data (recently used or frequently used LRU) so we can just read
1963 * the data we need and put the entry at the head of the frequently used LRU list.
1964 * In case the entry is in one of the ghost lists it doesn't contain any data.
1965 * We have to fetch it again evicting pages from either T1 or T2 to make room.
1966 */
1967 if (pEntry)
1968 {
1969 uint64_t offDiff = off - pEntry->Core.Key;
1970
1971 AssertMsg(off >= pEntry->Core.Key,
1972 ("Overflow in calculation off=%llu OffsetAligned=%llu\n",
1973 off, pEntry->Core.Key));
1974
1975 AssertPtr(pEntry->pList);
1976
1977 cbToRead = RT_MIN(pEntry->cbData - offDiff, cbRead);
1978
1979 AssertMsg(off + cbToRead <= pEntry->Core.Key + pEntry->Core.KeyLast + 1,
1980 ("Buffer of cache entry exceeded off=%llu cbToRead=%d\n",
1981 off, cbToRead));
1982
1983 cbRead -= cbToRead;
1984
1985 if (!cbRead)
1986 STAM_COUNTER_INC(&pCache->cHits);
1987 else
1988 STAM_COUNTER_INC(&pCache->cPartialHits);
1989
1990 STAM_COUNTER_ADD(&pCache->StatRead, cbToRead);
1991
1992 /* Ghost lists contain no data. */
1993 if ( (pEntry->pList == &pCache->LruRecentlyUsedIn)
1994 || (pEntry->pList == &pCache->LruFrequentlyUsed))
1995 {
1996 if (pdmBlkCacheEntryFlagIsSetClearAcquireLock(pBlkCache, pEntry,
1997 PDMBLKCACHE_ENTRY_IO_IN_PROGRESS,
1998 PDMBLKCACHE_ENTRY_IS_DIRTY))
1999 {
2000 /* Entry didn't completed yet. Append to the list */
2001 pdmBlkCacheEntryWaitersAdd(pEntry, pReq,
2002 &SgBuf, offDiff, cbToRead,
2003 false /* fWrite */);
2004 RTSemRWReleaseWrite(pBlkCache->SemRWEntries);
2005 }
2006 else
2007 {
2008 /* Read as much as we can from the entry. */
2009 RTSgBufCopyFromBuf(&SgBuf, pEntry->pbData + offDiff, cbToRead);
2010 }
2011
2012 /* Move this entry to the top position */
2013 if (pEntry->pList == &pCache->LruFrequentlyUsed)
2014 {
2015 pdmBlkCacheLockEnter(pCache);
2016 pdmBlkCacheEntryAddToList(&pCache->LruFrequentlyUsed, pEntry);
2017 pdmBlkCacheLockLeave(pCache);
2018 }
2019 /* Release the entry */
2020 pdmBlkCacheEntryRelease(pEntry);
2021 }
2022 else
2023 {
2024 uint8_t *pbBuffer = NULL;
2025
2026 LogFlow(("Fetching data for ghost entry %#p from file\n", pEntry));
2027
2028 pdmBlkCacheLockEnter(pCache);
2029 pdmBlkCacheEntryRemoveFromList(pEntry); /* Remove it before we remove data, otherwise it may get freed when evicting data. */
2030 bool fEnough = pdmBlkCacheReclaim(pCache, pEntry->cbData, true, &pbBuffer);
2031
2032 /* Move the entry to Am and fetch it to the cache. */
2033 if (fEnough)
2034 {
2035 pdmBlkCacheEntryAddToList(&pCache->LruFrequentlyUsed, pEntry);
2036 pdmBlkCacheAdd(pCache, pEntry->cbData);
2037 pdmBlkCacheLockLeave(pCache);
2038
2039 if (pbBuffer)
2040 pEntry->pbData = pbBuffer;
2041 else
2042 pEntry->pbData = (uint8_t *)RTMemPageAlloc(pEntry->cbData);
2043 AssertPtr(pEntry->pbData);
2044
2045 pdmBlkCacheEntryWaitersAdd(pEntry, pReq,
2046 &SgBuf, offDiff, cbToRead,
2047 false /* fWrite */);
2048 pdmBlkCacheEntryReadFromMedium(pEntry);
2049 /* Release the entry */
2050 pdmBlkCacheEntryRelease(pEntry);
2051 }
2052 else
2053 {
2054 RTSemRWRequestWrite(pBlkCache->SemRWEntries, RT_INDEFINITE_WAIT);
2055 STAM_PROFILE_ADV_START(&pCache->StatTreeRemove, Cache);
2056 RTAvlrU64Remove(pBlkCache->pTree, pEntry->Core.Key);
2057 STAM_PROFILE_ADV_STOP(&pCache->StatTreeRemove, Cache);
2058 RTSemRWReleaseWrite(pBlkCache->SemRWEntries);
2059
2060 pdmBlkCacheLockLeave(pCache);
2061
2062 RTMemFree(pEntry);
2063
2064 pdmBlkCacheRequestPassthrough(pBlkCache, pReq,
2065 &SgBuf, off, cbToRead,
2066 PDMBLKCACHEXFERDIR_READ);
2067 }
2068 }
2069 }
2070 else
2071 {
2072#ifdef VBOX_WITH_IO_READ_CACHE
2073 /* No entry found for this offset. Create a new entry and fetch the data to the cache. */
2074 PPDMBLKCACHEENTRY pEntryNew = pdmBlkCacheEntryCreate(pBlkCache,
2075 off, cbRead,
2076 &cbToRead);
2077
2078 cbRead -= cbToRead;
2079
2080 if (pEntryNew)
2081 {
2082 if (!cbRead)
2083 STAM_COUNTER_INC(&pCache->cMisses);
2084 else
2085 STAM_COUNTER_INC(&pCache->cPartialHits);
2086
2087 pdmBlkCacheEntryWaitersAdd(pEntryNew, pReq,
2088 &SgBuf,
2089 off - pEntryNew->Core.Key,
2090 cbToRead,
2091 false /* fWrite */);
2092 pdmBlkCacheEntryReadFromMedium(pEntryNew);
2093 pdmBlkCacheEntryRelease(pEntryNew); /* it is protected by the I/O in progress flag now. */
2094 }
2095 else
2096 {
2097 /*
2098 * There is not enough free space in the cache.
2099 * Pass the request directly to the I/O manager.
2100 */
2101 LogFlow(("Couldn't evict %u bytes from the cache. Remaining request will be passed through\n", cbToRead));
2102
2103 pdmBlkCacheRequestPassthrough(pBlkCache, pReq,
2104 &SgBuf, off, cbToRead,
2105 PDMBLKCACHEXFERDIR_READ);
2106 }
2107#else
2108 /* Clip read size if necessary. */
2109 PPDMBLKCACHEENTRY pEntryAbove;
2110 pdmBlkCacheGetCacheBestFitEntryByOffset(pBlkCache, off, &pEntryAbove);
2111
2112 if (pEntryAbove)
2113 {
2114 if (off + cbRead > pEntryAbove->Core.Key)
2115 cbToRead = pEntryAbove->Core.Key - off;
2116 else
2117 cbToRead = cbRead;
2118
2119 pdmBlkCacheEntryRelease(pEntryAbove);
2120 }
2121 else
2122 cbToRead = cbRead;
2123
2124 cbRead -= cbToRead;
2125 pdmBlkCacheRequestPassthrough(pBlkCache, pReq,
2126 &SgBuf, off, cbToRead,
2127 PDMBLKCACHEXFERDIR_READ);
2128#endif
2129 }
2130 off += cbToRead;
2131 }
2132
2133 if (!pdmBlkCacheReqUpdate(pBlkCache, pReq, rc, false))
2134 rc = VINF_AIO_TASK_PENDING;
2135 else
2136 {
2137 rc = pReq->rcReq;
2138 RTMemFree(pReq);
2139 }
2140
2141 LogFlowFunc((": Leave rc=%Rrc\n", rc));
2142
2143 return rc;
2144}
2145
2146VMMR3DECL(int) PDMR3BlkCacheWrite(PPDMBLKCACHE pBlkCache, uint64_t off,
2147 PCRTSGBUF pcSgBuf, size_t cbWrite, void *pvUser)
2148{
2149 int rc = VINF_SUCCESS;
2150 PPDMBLKCACHEGLOBAL pCache = pBlkCache->pCache;
2151 PPDMBLKCACHEENTRY pEntry;
2152 PPDMBLKCACHEREQ pReq;
2153
2154 LogFlowFunc((": pBlkCache=%#p{%s} off=%llu pcSgBuf=%#p cbWrite=%u pvUser=%#p\n",
2155 pBlkCache, pBlkCache->pszId, off, pcSgBuf, cbWrite, pvUser));
2156
2157 AssertPtrReturn(pBlkCache, VERR_INVALID_POINTER);
2158 AssertReturn(!pBlkCache->fSuspended, VERR_INVALID_STATE);
2159
2160 RTSGBUF SgBuf;
2161 RTSgBufClone(&SgBuf, pcSgBuf);
2162
2163 /* Allocate new request structure. */
2164 pReq = pdmBlkCacheReqAlloc(pvUser);
2165 if (RT_UNLIKELY(!pReq))
2166 return VERR_NO_MEMORY;
2167
2168 /* Increment data transfer counter to keep the request valid while we access it. */
2169 ASMAtomicIncU32(&pReq->cXfersPending);
2170
2171 while (cbWrite)
2172 {
2173 size_t cbToWrite;
2174
2175 pEntry = pdmBlkCacheGetCacheEntryByOffset(pBlkCache, off);
2176 if (pEntry)
2177 {
2178 /* Write the data into the entry and mark it as dirty */
2179 AssertPtr(pEntry->pList);
2180
2181 uint64_t offDiff = off - pEntry->Core.Key;
2182
2183 AssertMsg(off >= pEntry->Core.Key,
2184 ("Overflow in calculation off=%llu OffsetAligned=%llu\n",
2185 off, pEntry->Core.Key));
2186
2187 cbToWrite = RT_MIN(pEntry->cbData - offDiff, cbWrite);
2188 cbWrite -= cbToWrite;
2189
2190 if (!cbWrite)
2191 STAM_COUNTER_INC(&pCache->cHits);
2192 else
2193 STAM_COUNTER_INC(&pCache->cPartialHits);
2194
2195 STAM_COUNTER_ADD(&pCache->StatWritten, cbToWrite);
2196
2197 /* Ghost lists contain no data. */
2198 if ( (pEntry->pList == &pCache->LruRecentlyUsedIn)
2199 || (pEntry->pList == &pCache->LruFrequentlyUsed))
2200 {
2201 /* Check if the entry is dirty. */
2202 if (pdmBlkCacheEntryFlagIsSetClearAcquireLock(pBlkCache, pEntry,
2203 PDMBLKCACHE_ENTRY_IS_DIRTY,
2204 0))
2205 {
2206 /* If it is already dirty but not in progress just update the data. */
2207 if (!(pEntry->fFlags & PDMBLKCACHE_ENTRY_IO_IN_PROGRESS))
2208 RTSgBufCopyToBuf(&SgBuf, pEntry->pbData + offDiff, cbToWrite);
2209 else
2210 {
2211 /* The data isn't written to the file yet */
2212 pdmBlkCacheEntryWaitersAdd(pEntry, pReq,
2213 &SgBuf, offDiff, cbToWrite,
2214 true /* fWrite */);
2215 STAM_COUNTER_INC(&pBlkCache->StatWriteDeferred);
2216 }
2217
2218 RTSemRWReleaseWrite(pBlkCache->SemRWEntries);
2219 }
2220 else /* Dirty bit not set */
2221 {
2222 /*
2223 * Check if a read is in progress for this entry.
2224 * We have to defer processing in that case.
2225 */
2226 if (pdmBlkCacheEntryFlagIsSetClearAcquireLock(pBlkCache, pEntry,
2227 PDMBLKCACHE_ENTRY_IO_IN_PROGRESS,
2228 0))
2229 {
2230 pdmBlkCacheEntryWaitersAdd(pEntry, pReq,
2231 &SgBuf, offDiff, cbToWrite,
2232 true /* fWrite */);
2233 STAM_COUNTER_INC(&pBlkCache->StatWriteDeferred);
2234 RTSemRWReleaseWrite(pBlkCache->SemRWEntries);
2235 }
2236 else /* I/O in progress flag not set */
2237 {
2238 /* Write as much as we can into the entry and update the file. */
2239 RTSgBufCopyToBuf(&SgBuf, pEntry->pbData + offDiff, cbToWrite);
2240
2241 bool fCommit = pdmBlkCacheAddDirtyEntry(pBlkCache, pEntry);
2242 if (fCommit)
2243 pdmBlkCacheCommitDirtyEntries(pCache);
2244 }
2245 } /* Dirty bit not set */
2246
2247 /* Move this entry to the top position */
2248 if (pEntry->pList == &pCache->LruFrequentlyUsed)
2249 {
2250 pdmBlkCacheLockEnter(pCache);
2251 pdmBlkCacheEntryAddToList(&pCache->LruFrequentlyUsed, pEntry);
2252 pdmBlkCacheLockLeave(pCache);
2253 }
2254
2255 pdmBlkCacheEntryRelease(pEntry);
2256 }
2257 else /* Entry is on the ghost list */
2258 {
2259 uint8_t *pbBuffer = NULL;
2260
2261 pdmBlkCacheLockEnter(pCache);
2262 pdmBlkCacheEntryRemoveFromList(pEntry); /* Remove it before we remove data, otherwise it may get freed when evicting data. */
2263 bool fEnough = pdmBlkCacheReclaim(pCache, pEntry->cbData, true, &pbBuffer);
2264
2265 if (fEnough)
2266 {
2267 /* Move the entry to Am and fetch it to the cache. */
2268 pdmBlkCacheEntryAddToList(&pCache->LruFrequentlyUsed, pEntry);
2269 pdmBlkCacheAdd(pCache, pEntry->cbData);
2270 pdmBlkCacheLockLeave(pCache);
2271
2272 if (pbBuffer)
2273 pEntry->pbData = pbBuffer;
2274 else
2275 pEntry->pbData = (uint8_t *)RTMemPageAlloc(pEntry->cbData);
2276 AssertPtr(pEntry->pbData);
2277
2278 pdmBlkCacheEntryWaitersAdd(pEntry, pReq,
2279 &SgBuf, offDiff, cbToWrite,
2280 true /* fWrite */);
2281 STAM_COUNTER_INC(&pBlkCache->StatWriteDeferred);
2282 pdmBlkCacheEntryReadFromMedium(pEntry);
2283
2284 /* Release the reference. If it is still needed the I/O in progress flag should protect it now. */
2285 pdmBlkCacheEntryRelease(pEntry);
2286 }
2287 else
2288 {
2289 RTSemRWRequestWrite(pBlkCache->SemRWEntries, RT_INDEFINITE_WAIT);
2290 STAM_PROFILE_ADV_START(&pCache->StatTreeRemove, Cache);
2291 RTAvlrU64Remove(pBlkCache->pTree, pEntry->Core.Key);
2292 STAM_PROFILE_ADV_STOP(&pCache->StatTreeRemove, Cache);
2293 RTSemRWReleaseWrite(pBlkCache->SemRWEntries);
2294
2295 pdmBlkCacheLockLeave(pCache);
2296
2297 RTMemFree(pEntry);
2298 pdmBlkCacheRequestPassthrough(pBlkCache, pReq,
2299 &SgBuf, off, cbToWrite,
2300 PDMBLKCACHEXFERDIR_WRITE);
2301 }
2302 }
2303 }
2304 else /* No entry found */
2305 {
2306 /*
2307 * No entry found. Try to create a new cache entry to store the data in and if that fails
2308 * write directly to the file.
2309 */
2310 PPDMBLKCACHEENTRY pEntryNew = pdmBlkCacheEntryCreate(pBlkCache,
2311 off, cbWrite,
2312 &cbToWrite);
2313
2314 cbWrite -= cbToWrite;
2315
2316 if (pEntryNew)
2317 {
2318 uint64_t offDiff = off - pEntryNew->Core.Key;
2319
2320 STAM_COUNTER_INC(&pCache->cHits);
2321
2322 /*
2323 * Check if it is possible to just write the data without waiting
2324 * for it to get fetched first.
2325 */
2326 if (!offDiff && pEntryNew->cbData == cbToWrite)
2327 {
2328 RTSgBufCopyToBuf(&SgBuf, pEntryNew->pbData, cbToWrite);
2329
2330 bool fCommit = pdmBlkCacheAddDirtyEntry(pBlkCache, pEntryNew);
2331 if (fCommit)
2332 pdmBlkCacheCommitDirtyEntries(pCache);
2333 STAM_COUNTER_ADD(&pCache->StatWritten, cbToWrite);
2334 }
2335 else
2336 {
2337 /* Defer the write and fetch the data from the endpoint. */
2338 pdmBlkCacheEntryWaitersAdd(pEntryNew, pReq,
2339 &SgBuf, offDiff, cbToWrite,
2340 true /* fWrite */);
2341 STAM_COUNTER_INC(&pBlkCache->StatWriteDeferred);
2342 pdmBlkCacheEntryReadFromMedium(pEntryNew);
2343 }
2344
2345 pdmBlkCacheEntryRelease(pEntryNew);
2346 }
2347 else
2348 {
2349 /*
2350 * There is not enough free space in the cache.
2351 * Pass the request directly to the I/O manager.
2352 */
2353 LogFlow(("Couldn't evict %u bytes from the cache. Remaining request will be passed through\n", cbToWrite));
2354
2355 STAM_COUNTER_INC(&pCache->cMisses);
2356
2357 pdmBlkCacheRequestPassthrough(pBlkCache, pReq,
2358 &SgBuf, off, cbToWrite,
2359 PDMBLKCACHEXFERDIR_WRITE);
2360 }
2361 }
2362
2363 off += cbToWrite;
2364 }
2365
2366 if (!pdmBlkCacheReqUpdate(pBlkCache, pReq, rc, false))
2367 rc = VINF_AIO_TASK_PENDING;
2368 else
2369 {
2370 rc = pReq->rcReq;
2371 RTMemFree(pReq);
2372 }
2373
2374 LogFlowFunc((": Leave rc=%Rrc\n", rc));
2375
2376 return rc;
2377}
2378
2379VMMR3DECL(int) PDMR3BlkCacheFlush(PPDMBLKCACHE pBlkCache, void *pvUser)
2380{
2381 int rc = VINF_SUCCESS;
2382 PPDMBLKCACHEREQ pReq;
2383
2384 LogFlowFunc((": pBlkCache=%#p{%s}\n", pBlkCache, pBlkCache->pszId));
2385
2386 AssertPtrReturn(pBlkCache, VERR_INVALID_POINTER);
2387 AssertReturn(!pBlkCache->fSuspended, VERR_INVALID_STATE);
2388
2389 /* Commit dirty entries in the cache. */
2390 pdmBlkCacheCommit(pBlkCache);
2391
2392 /* Allocate new request structure. */
2393 pReq = pdmBlkCacheReqAlloc(pvUser);
2394 if (RT_UNLIKELY(!pReq))
2395 return VERR_NO_MEMORY;
2396
2397 rc = pdmBlkCacheRequestPassthrough(pBlkCache, pReq, NULL, 0, 0,
2398 PDMBLKCACHEXFERDIR_FLUSH);
2399 AssertRC(rc);
2400
2401 LogFlowFunc((": Leave rc=%Rrc\n", rc));
2402 return VINF_AIO_TASK_PENDING;
2403}
2404
2405VMMR3DECL(int) PDMR3BlkCacheDiscard(PPDMBLKCACHE pBlkCache, PCRTRANGE paRanges,
2406 unsigned cRanges, void *pvUser)
2407{
2408 int rc = VINF_SUCCESS;
2409 PPDMBLKCACHEGLOBAL pCache = pBlkCache->pCache;
2410 PPDMBLKCACHEENTRY pEntry;
2411 PPDMBLKCACHEREQ pReq;
2412
2413 LogFlowFunc((": pBlkCache=%#p{%s} paRanges=%#p cRanges=%u pvUser=%#p\n",
2414 pBlkCache, pBlkCache->pszId, paRanges, cRanges, pvUser));
2415
2416 AssertPtrReturn(pBlkCache, VERR_INVALID_POINTER);
2417 AssertReturn(!pBlkCache->fSuspended, VERR_INVALID_STATE);
2418
2419 /* Allocate new request structure. */
2420 pReq = pdmBlkCacheReqAlloc(pvUser);
2421 if (RT_UNLIKELY(!pReq))
2422 return VERR_NO_MEMORY;
2423
2424 /* Increment data transfer counter to keep the request valid while we access it. */
2425 ASMAtomicIncU32(&pReq->cXfersPending);
2426
2427 for (unsigned i = 0; i < cRanges; i++)
2428 {
2429 uint64_t offCur = paRanges[i].offStart;
2430 size_t cbLeft = paRanges[i].cbRange;
2431
2432 while (cbLeft)
2433 {
2434 size_t cbThisDiscard = 0;
2435
2436 pEntry = pdmBlkCacheGetCacheEntryByOffset(pBlkCache, offCur);
2437
2438 if (pEntry)
2439 {
2440 /* Write the data into the entry and mark it as dirty */
2441 AssertPtr(pEntry->pList);
2442
2443 uint64_t offDiff = offCur - pEntry->Core.Key;
2444
2445 AssertMsg(offCur >= pEntry->Core.Key,
2446 ("Overflow in calculation offCur=%llu OffsetAligned=%llu\n",
2447 offCur, pEntry->Core.Key));
2448
2449 cbThisDiscard = RT_MIN(pEntry->cbData - offDiff, cbLeft);
2450
2451 /* Ghost lists contain no data. */
2452 if ( (pEntry->pList == &pCache->LruRecentlyUsedIn)
2453 || (pEntry->pList == &pCache->LruFrequentlyUsed))
2454 {
2455 /* Check if the entry is dirty. */
2456 if (pdmBlkCacheEntryFlagIsSetClearAcquireLock(pBlkCache, pEntry,
2457 PDMBLKCACHE_ENTRY_IS_DIRTY,
2458 0))
2459 {
2460 /* If it is dirty but not yet in progress remove it. */
2461 if (!(pEntry->fFlags & PDMBLKCACHE_ENTRY_IO_IN_PROGRESS))
2462 {
2463 pdmBlkCacheLockEnter(pCache);
2464 pdmBlkCacheEntryRemoveFromList(pEntry);
2465
2466 STAM_PROFILE_ADV_START(&pCache->StatTreeRemove, Cache);
2467 RTAvlrU64Remove(pBlkCache->pTree, pEntry->Core.Key);
2468 STAM_PROFILE_ADV_STOP(&pCache->StatTreeRemove, Cache);
2469
2470 pdmBlkCacheLockLeave(pCache);
2471
2472 RTMemFree(pEntry);
2473 }
2474 else
2475 {
2476#if 0
2477 /* The data isn't written to the file yet */
2478 pdmBlkCacheEntryWaitersAdd(pEntry, pReq,
2479 &SgBuf, offDiff, cbToWrite,
2480 true /* fWrite */);
2481 STAM_COUNTER_INC(&pBlkCache->StatWriteDeferred);
2482#endif
2483 }
2484
2485 RTSemRWReleaseWrite(pBlkCache->SemRWEntries);
2486 pdmBlkCacheEntryRelease(pEntry);
2487 }
2488 else /* Dirty bit not set */
2489 {
2490 /*
2491 * Check if a read is in progress for this entry.
2492 * We have to defer processing in that case.
2493 */
2494 if(pdmBlkCacheEntryFlagIsSetClearAcquireLock(pBlkCache, pEntry,
2495 PDMBLKCACHE_ENTRY_IO_IN_PROGRESS,
2496 0))
2497 {
2498#if 0
2499 pdmBlkCacheEntryWaitersAdd(pEntry, pReq,
2500 &SgBuf, offDiff, cbToWrite,
2501 true /* fWrite */);
2502#endif
2503 STAM_COUNTER_INC(&pBlkCache->StatWriteDeferred);
2504 RTSemRWReleaseWrite(pBlkCache->SemRWEntries);
2505 pdmBlkCacheEntryRelease(pEntry);
2506 }
2507 else /* I/O in progress flag not set */
2508 {
2509 pdmBlkCacheLockEnter(pCache);
2510 pdmBlkCacheEntryRemoveFromList(pEntry);
2511
2512 RTSemRWRequestWrite(pBlkCache->SemRWEntries, RT_INDEFINITE_WAIT);
2513 STAM_PROFILE_ADV_START(&pCache->StatTreeRemove, Cache);
2514 RTAvlrU64Remove(pBlkCache->pTree, pEntry->Core.Key);
2515 STAM_PROFILE_ADV_STOP(&pCache->StatTreeRemove, Cache);
2516 RTSemRWReleaseWrite(pBlkCache->SemRWEntries);
2517
2518 pdmBlkCacheLockLeave(pCache);
2519
2520 RTMemFree(pEntry);
2521 }
2522 } /* Dirty bit not set */
2523 }
2524 else /* Entry is on the ghost list just remove cache entry. */
2525 {
2526 pdmBlkCacheLockEnter(pCache);
2527 pdmBlkCacheEntryRemoveFromList(pEntry);
2528
2529 RTSemRWRequestWrite(pBlkCache->SemRWEntries, RT_INDEFINITE_WAIT);
2530 STAM_PROFILE_ADV_START(&pCache->StatTreeRemove, Cache);
2531 RTAvlrU64Remove(pBlkCache->pTree, pEntry->Core.Key);
2532 STAM_PROFILE_ADV_STOP(&pCache->StatTreeRemove, Cache);
2533 RTSemRWReleaseWrite(pBlkCache->SemRWEntries);
2534
2535 pdmBlkCacheLockLeave(pCache);
2536
2537 RTMemFree(pEntry);
2538 }
2539 }
2540 /* else: no entry found. */
2541
2542 offCur += cbThisDiscard;
2543 cbLeft -= cbThisDiscard;
2544 }
2545 }
2546
2547 if (!pdmBlkCacheReqUpdate(pBlkCache, pReq, rc, false))
2548 rc = VINF_AIO_TASK_PENDING;
2549 else
2550 {
2551 rc = pReq->rcReq;
2552 RTMemFree(pReq);
2553 }
2554
2555 LogFlowFunc((": Leave rc=%Rrc\n", rc));
2556
2557 return rc;
2558}
2559
2560/**
2561 * Completes a task segment freeing all resources and completes the task handle
2562 * if everything was transferred.
2563 *
2564 * @returns Next task segment handle.
2565 * @param pTaskSeg Task segment to complete.
2566 * @param rc Status code to set.
2567 */
2568static PPDMBLKCACHEWAITER pdmBlkCacheWaiterComplete(PPDMBLKCACHE pBlkCache,
2569 PPDMBLKCACHEWAITER pWaiter,
2570 int rc)
2571{
2572 PPDMBLKCACHEWAITER pNext = pWaiter->pNext;
2573 PPDMBLKCACHEREQ pReq = pWaiter->pReq;
2574
2575 pdmBlkCacheReqUpdate(pBlkCache, pReq, rc, true);
2576
2577 RTMemFree(pWaiter);
2578
2579 return pNext;
2580}
2581
2582static void pdmBlkCacheIoXferCompleteEntry(PPDMBLKCACHE pBlkCache, PPDMBLKCACHEIOXFER hIoXfer, int rcIoXfer)
2583{
2584 PPDMBLKCACHEENTRY pEntry = hIoXfer->pEntry;
2585 PPDMBLKCACHEGLOBAL pCache = pBlkCache->pCache;
2586
2587 /* Reference the entry now as we are clearing the I/O in progress flag
2588 * which protected the entry till now. */
2589 pdmBlkCacheEntryRef(pEntry);
2590
2591 RTSemRWRequestWrite(pBlkCache->SemRWEntries, RT_INDEFINITE_WAIT);
2592 pEntry->fFlags &= ~PDMBLKCACHE_ENTRY_IO_IN_PROGRESS;
2593
2594 /* Process waiting segment list. The data in entry might have changed in-between. */
2595 bool fDirty = false;
2596 PPDMBLKCACHEWAITER pComplete = pEntry->pWaitingHead;
2597 PPDMBLKCACHEWAITER pCurr = pComplete;
2598
2599 AssertMsg((pCurr && pEntry->pWaitingTail) || (!pCurr && !pEntry->pWaitingTail),
2600 ("The list tail was not updated correctly\n"));
2601 pEntry->pWaitingTail = NULL;
2602 pEntry->pWaitingHead = NULL;
2603
2604 if (hIoXfer->enmXferDir == PDMBLKCACHEXFERDIR_WRITE)
2605 {
2606 /*
2607 * An error here is difficult to handle as the original request completed already.
2608 * The error is logged for now and the VM is paused.
2609 * If the user continues the entry is written again in the hope
2610 * the user fixed the problem and the next write succeeds.
2611 */
2612 if (RT_FAILURE(rcIoXfer))
2613 {
2614 LogRel(("I/O cache: Error while writing entry at offset %llu (%u bytes) to medium \"%s\" (rc=%Rrc)\n",
2615 pEntry->Core.Key, pEntry->cbData, pBlkCache->pszId, rcIoXfer));
2616
2617 if (!ASMAtomicXchgBool(&pCache->fIoErrorVmSuspended, true))
2618 {
2619 int rc = VMSetRuntimeError(pCache->pVM, VMSETRTERR_FLAGS_SUSPEND | VMSETRTERR_FLAGS_NO_WAIT, "BLKCACHE_IOERR",
2620 N_("The I/O cache encountered an error while updating data in medium \"%s\" (rc=%Rrc). "
2621 "Make sure there is enough free space on the disk and that the disk is working properly. "
2622 "Operation can be resumed afterwards"),
2623 pBlkCache->pszId, rcIoXfer);
2624 AssertRC(rc);
2625 }
2626
2627 /* Mark the entry as dirty again to get it added to the list later on. */
2628 fDirty = true;
2629 }
2630
2631 pEntry->fFlags &= ~PDMBLKCACHE_ENTRY_IS_DIRTY;
2632
2633 while (pCurr)
2634 {
2635 AssertMsg(pCurr->fWrite, ("Completed write entries should never have read tasks attached\n"));
2636
2637 RTSgBufCopyToBuf(&pCurr->SgBuf, pEntry->pbData + pCurr->offCacheEntry, pCurr->cbTransfer);
2638 fDirty = true;
2639 pCurr = pCurr->pNext;
2640 }
2641 }
2642 else
2643 {
2644 AssertMsg(hIoXfer->enmXferDir == PDMBLKCACHEXFERDIR_READ, ("Invalid transfer type\n"));
2645 AssertMsg(!(pEntry->fFlags & PDMBLKCACHE_ENTRY_IS_DIRTY),
2646 ("Invalid flags set\n"));
2647
2648 while (pCurr)
2649 {
2650 if (pCurr->fWrite)
2651 {
2652 RTSgBufCopyToBuf(&pCurr->SgBuf, pEntry->pbData + pCurr->offCacheEntry, pCurr->cbTransfer);
2653 fDirty = true;
2654 }
2655 else
2656 RTSgBufCopyFromBuf(&pCurr->SgBuf, pEntry->pbData + pCurr->offCacheEntry, pCurr->cbTransfer);
2657
2658 pCurr = pCurr->pNext;
2659 }
2660 }
2661
2662 bool fCommit = false;
2663 if (fDirty)
2664 fCommit = pdmBlkCacheAddDirtyEntry(pBlkCache, pEntry);
2665
2666 RTSemRWReleaseWrite(pBlkCache->SemRWEntries);
2667
2668 /* Dereference so that it isn't protected anymore except we issued anyother write for it. */
2669 pdmBlkCacheEntryRelease(pEntry);
2670
2671 if (fCommit)
2672 pdmBlkCacheCommitDirtyEntries(pCache);
2673
2674 /* Complete waiters now. */
2675 while (pComplete)
2676 pComplete = pdmBlkCacheWaiterComplete(pBlkCache, pComplete, rcIoXfer);
2677}
2678
2679VMMR3DECL(void) PDMR3BlkCacheIoXferComplete(PPDMBLKCACHE pBlkCache, PPDMBLKCACHEIOXFER hIoXfer, int rcIoXfer)
2680{
2681 LogFlowFunc(("pBlkCache=%#p hIoXfer=%#p rcIoXfer=%Rrc\n", pBlkCache, hIoXfer, rcIoXfer));
2682
2683 if (hIoXfer->fIoCache)
2684 pdmBlkCacheIoXferCompleteEntry(pBlkCache, hIoXfer, rcIoXfer);
2685 else
2686 pdmBlkCacheReqUpdate(pBlkCache, hIoXfer->pReq, rcIoXfer, true);
2687 RTMemFree(hIoXfer);
2688}
2689
2690/**
2691 * Callback for the AVL do with all routine. Waits for a cachen entry to finish any pending I/O.
2692 *
2693 * @returns IPRT status code.
2694 * @param pNode The node to destroy.
2695 * @param pvUser Opaque user data.
2696 */
2697static DECLCALLBACK(int) pdmBlkCacheEntryQuiesce(PAVLRU64NODECORE pNode, void *pvUser)
2698{
2699 PPDMBLKCACHEENTRY pEntry = (PPDMBLKCACHEENTRY)pNode;
2700 PPDMBLKCACHE pBlkCache = pEntry->pBlkCache;
2701 NOREF(pvUser);
2702
2703 while (ASMAtomicReadU32(&pEntry->fFlags) & PDMBLKCACHE_ENTRY_IO_IN_PROGRESS)
2704 {
2705 /* Leave the locks to let the I/O thread make progress but reference the entry to prevent eviction. */
2706 pdmBlkCacheEntryRef(pEntry);
2707 RTSemRWReleaseWrite(pBlkCache->SemRWEntries);
2708
2709 RTThreadSleep(1);
2710
2711 /* Re-enter all locks and drop the reference. */
2712 RTSemRWRequestWrite(pBlkCache->SemRWEntries, RT_INDEFINITE_WAIT);
2713 pdmBlkCacheEntryRelease(pEntry);
2714 }
2715
2716 AssertMsg(!(pEntry->fFlags & PDMBLKCACHE_ENTRY_IO_IN_PROGRESS),
2717 ("Entry is dirty and/or still in progress fFlags=%#x\n", pEntry->fFlags));
2718
2719 return VINF_SUCCESS;
2720}
2721
2722VMMR3DECL(int) PDMR3BlkCacheSuspend(PPDMBLKCACHE pBlkCache)
2723{
2724 int rc = VINF_SUCCESS;
2725 LogFlowFunc(("pBlkCache=%#p\n", pBlkCache));
2726
2727 AssertPtrReturn(pBlkCache, VERR_INVALID_POINTER);
2728
2729 if (!ASMAtomicReadBool(&pBlkCache->pCache->fIoErrorVmSuspended))
2730 pdmBlkCacheCommit(pBlkCache); /* Can issue new I/O requests. */
2731 ASMAtomicXchgBool(&pBlkCache->fSuspended, true);
2732
2733 /* Wait for all I/O to complete. */
2734 RTSemRWRequestWrite(pBlkCache->SemRWEntries, RT_INDEFINITE_WAIT);
2735 rc = RTAvlrU64DoWithAll(pBlkCache->pTree, true, pdmBlkCacheEntryQuiesce, NULL);
2736 AssertRC(rc);
2737 RTSemRWReleaseWrite(pBlkCache->SemRWEntries);
2738
2739 return rc;
2740}
2741
2742VMMR3DECL(int) PDMR3BlkCacheResume(PPDMBLKCACHE pBlkCache)
2743{
2744 LogFlowFunc(("pBlkCache=%#p\n", pBlkCache));
2745
2746 AssertPtrReturn(pBlkCache, VERR_INVALID_POINTER);
2747
2748 ASMAtomicXchgBool(&pBlkCache->fSuspended, false);
2749
2750 return VINF_SUCCESS;
2751}
2752
2753VMMR3DECL(int) PDMR3BlkCacheClear(PPDMBLKCACHE pBlkCache)
2754{
2755 int rc = VINF_SUCCESS;
2756 PPDMBLKCACHEGLOBAL pCache = pBlkCache->pCache;
2757
2758 /*
2759 * Commit all dirty entries now (they are waited on for completion during the
2760 * destruction of the AVL tree below).
2761 * The exception is if the VM was paused because of an I/O error before.
2762 */
2763 if (!ASMAtomicReadBool(&pCache->fIoErrorVmSuspended))
2764 pdmBlkCacheCommit(pBlkCache);
2765
2766 /* Make sure nobody is accessing the cache while we delete the tree. */
2767 pdmBlkCacheLockEnter(pCache);
2768 RTSemRWRequestWrite(pBlkCache->SemRWEntries, RT_INDEFINITE_WAIT);
2769 RTAvlrU64Destroy(pBlkCache->pTree, pdmBlkCacheEntryDestroy, pCache);
2770 RTSemRWReleaseWrite(pBlkCache->SemRWEntries);
2771
2772 pdmBlkCacheLockLeave(pCache);
2773 return rc;
2774}
2775
Note: See TracBrowser for help on using the repository browser.

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