PDMAsyncCompletionFile.cpp@ 22336

Last change on this file since 22336 was 22309, checked in by vboxsync, 15 years ago
PDMAsyncCompletion: Add first part of the cache for file I/O
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 25.3 KB

Line
1	/* $Id: PDMAsyncCompletionFile.cpp 22309 2009-08-17 20:59:28Z vboxsync $ */
2	/** @file
3	* PDM Async I/O - Transport data asynchronous in R3 using EMT.
4	*/
5
6	/*
7	* Copyright (C) 2006-2008 Sun Microsystems, Inc.
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	* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
18	* Clara, CA 95054 USA or visit http://www.sun.com if you need
19	* additional information or have any questions.
20	*/
21
22
23
24	/*******************************************************************************
25	* Header Files *
26	*******************************************************************************/
27	#define LOG_GROUP LOG_GROUP_PDM_ASYNC_COMPLETION
28	#include "PDMInternal.h"
29	#include <VBox/pdm.h>
30	#include <VBox/mm.h>
31	#include <VBox/vm.h>
32	#include <VBox/err.h>
33
34	#include <VBox/log.h>
35	#include <iprt/asm.h>
36	#include <iprt/assert.h>
37	#include <iprt/thread.h>
38	#include <iprt/mem.h>
39	#include <iprt/critsect.h>
40	#include <iprt/file.h>
41	#include <iprt/semaphore.h>
42	#include <iprt/string.h>
43
44	#include "PDMAsyncCompletionFileInternal.h"
45
46	/**
47	* Frees a task.
48	*
49	* @returns nothing.
50	* @param pEndpoint Pointer to the endpoint the segment was for.
51	* @param pTask The task to free.
52	*/
53	void pdmacFileTaskFree(PPDMASYNCCOMPLETIONENDPOINTFILE pEndpoint,
54	PPDMACTASKFILE pTask)
55	{
56	PPDMASYNCCOMPLETIONEPCLASSFILE pEpClass = (PPDMASYNCCOMPLETIONEPCLASSFILE)pEndpoint->Core.pEpClass;
57
58	LogFlowFunc((": pEndpoint=%p pTask=%p\n", pEndpoint, pTask));
59
60	/* Try the per endpoint cache first. */
61	if (pEndpoint->cTasksCached < pEpClass->cTasksCacheMax)
62	{
63	/* Add it to the list. */
64	pEndpoint->pTasksFreeTail->pNext = pTask;
65	pEndpoint->pTasksFreeTail = pTask;
66	ASMAtomicIncU32(&pEndpoint->cTasksCached);
67	}
68	else if (false)
69	{
70	/* Bigger class cache */
71	}
72	else
73	{
74	Log(("Freeing task %p because all caches are full\n", pTask));
75	MMR3HeapFree(pTask);
76	}
77	}
78
79	/**
80	* Allocates a task segment
81	*
82	* @returns Pointer to the new task segment or NULL
83	* @param pEndpoint Pointer to the endpoint
84	*/
85	PPDMACTASKFILE pdmacFileTaskAlloc(PPDMASYNCCOMPLETIONENDPOINTFILE pEndpoint)
86	{
87	PPDMACTASKFILE pTask = NULL;
88
89	/* Try the small per endpoint cache first. */
90	if (pEndpoint->pTasksFreeHead == pEndpoint->pTasksFreeTail)
91	{
92	/* Try the bigger endpoint class cache. */
93	PPDMASYNCCOMPLETIONEPCLASSFILE pEndpointClass = (PPDMASYNCCOMPLETIONEPCLASSFILE)pEndpoint->Core.pEpClass;
94
95	#if 0
96	/* We start with the assigned slot id to distribute the load when allocating new tasks. */
97	unsigned iSlot = pEndpoint->iSlotStart;
98	do
99	{
100	pTask = (PPDMASYNCCOMPLETIONTASK)ASMAtomicXchgPtr((void * volatile *)&pEndpointClass->apTaskCache[iSlot], NULL);
101	if (pTask)
102	break;
103
104	iSlot = (iSlot + 1) % RT_ELEMENTS(pEndpointClass->apTaskCache);
105	} while (iSlot != pEndpoint->iSlotStart);
106	#endif
107	if (!pTask)
108	{
109	/*
110	* Allocate completely new.
111	* If this fails we return NULL.
112	*/
113	int rc = MMR3HeapAllocZEx(pEndpointClass->Core.pVM, MM_TAG_PDM_ASYNC_COMPLETION,
114	sizeof(PDMACTASKFILE),
115	(void **)&pTask);
116	if (RT_FAILURE(rc))
117	pTask = NULL;
118
119	LogFlow(("Allocated task %p\n", pTask));
120	}
121	#if 0
122	else
123	{
124	/* Remove the first element and put the rest into the slot again. */
125	PPDMASYNCCOMPLETIONTASK pTaskHeadNew = pTask->pNext;
126
127	pTaskHeadNew->pPrev = NULL;
128
129	/* Put back into the list adding any new tasks. */
130	while (true)
131	{
132	bool fChanged = ASMAtomicCmpXchgPtr((void * volatile *)&pEndpointClass->apTaskCache[iSlot], pTaskHeadNew, NULL);
133
134	if (fChanged)
135	break;
136
137	PPDMASYNCCOMPLETIONTASK pTaskHead = (PPDMASYNCCOMPLETIONTASK)ASMAtomicXchgPtr((void * volatile *)&pEndpointClass->apTaskCache[iSlot], NULL);
138
139	/* The new task could be taken inbetween */
140	if (pTaskHead)
141	{
142	/* Go to the end of the probably much shorter new list. */
143	PPDMASYNCCOMPLETIONTASK pTaskTail = pTaskHead;
144	while (pTaskTail->pNext)
145	pTaskTail = pTaskTail->pNext;
146
147	/* Concatenate */
148	pTaskTail->pNext = pTaskHeadNew;
149
150	pTaskHeadNew = pTaskHead;
151	}
152	/* Another round trying to change the list. */
153	}
154	/* We got a task from the global cache so decrement the counter */
155	ASMAtomicDecU32(&pEndpointClass->cTasksCached);
156	}
157	#endif
158	}
159	else
160	{
161	/* Grab a free task from the head. */
162	AssertMsg(pEndpoint->cTasksCached > 0, ("No tasks cached but list contains more than one element\n"));
163
164	pTask = pEndpoint->pTasksFreeHead;
165	pEndpoint->pTasksFreeHead = pTask->pNext;
166	ASMAtomicDecU32(&pEndpoint->cTasksCached);
167	}
168
169	pTask->pNext = NULL;
170
171	return pTask;
172	}
173
174	PPDMACTASKFILE pdmacFileEpGetNewTasks(PPDMASYNCCOMPLETIONENDPOINTFILE pEndpoint)
175	{
176	PPDMACTASKFILE pTasks = NULL;
177
178	/*
179	* Get pending tasks.
180	*/
181	pTasks = (PPDMACTASKFILE)ASMAtomicXchgPtr((void * volatile *)&pEndpoint->pTasksNewHead, NULL);
182
183	/* Reverse the list to process in FIFO order. */
184	if (pTasks)
185	{
186	PPDMACTASKFILE pTask = pTasks;
187
188	pTasks = NULL;
189
190	while (pTask)
191	{
192	PPDMACTASKFILE pCur = pTask;
193	pTask = pTask->pNext;
194	pCur->pNext = pTasks;
195	pTasks = pCur;
196	}
197	}
198
199	return pTasks;
200	}
201
202	static void pdmacFileAioMgrWakeup(PPDMACEPFILEMGR pAioMgr)
203	{
204	bool fWokenUp = ASMAtomicXchgBool(&pAioMgr->fWokenUp, true);
205
206	if (!fWokenUp)
207	{
208	int rc = VINF_SUCCESS;
209	bool fWaitingEventSem = ASMAtomicReadBool(&pAioMgr->fWaitingEventSem);
210
211	if (fWaitingEventSem)
212	rc = RTSemEventSignal(pAioMgr->EventSem);
213
214	AssertRC(rc);
215	}
216	}
217
218	static int pdmacFileAioMgrWaitForBlockingEvent(PPDMACEPFILEMGR pAioMgr, PDMACEPFILEAIOMGRBLOCKINGEVENT enmEvent)
219	{
220	int rc = VINF_SUCCESS;
221
222	ASMAtomicWriteU32((volatile uint32_t *)&pAioMgr->enmBlockingEvent, enmEvent);
223	ASMAtomicXchgBool(&pAioMgr->fBlockingEventPending, true);
224
225	/* Wakeup the async I/O manager */
226	pdmacFileAioMgrWakeup(pAioMgr);
227
228	/* Wait for completion. */
229	rc = RTSemEventWait(pAioMgr->EventSemBlock, RT_INDEFINITE_WAIT);
230	AssertRC(rc);
231
232	ASMAtomicXchgBool(&pAioMgr->fBlockingEventPending, false);
233	ASMAtomicWriteU32((volatile uint32_t *)&pAioMgr->enmBlockingEvent, PDMACEPFILEAIOMGRBLOCKINGEVENT_INVALID);
234
235	return rc;
236	}
237
238	static int pdmacFileAioMgrAddEndpoint(PPDMACEPFILEMGR pAioMgr, PPDMASYNCCOMPLETIONENDPOINTFILE pEndpoint)
239	{
240	int rc;
241
242	rc = RTCritSectEnter(&pAioMgr->CritSectBlockingEvent);
243	AssertRCReturn(rc, rc);
244
245	ASMAtomicWritePtr((void * volatile *)&pAioMgr->BlockingEventData.AddEndpoint.pEndpoint, pEndpoint);
246	rc = pdmacFileAioMgrWaitForBlockingEvent(pAioMgr, PDMACEPFILEAIOMGRBLOCKINGEVENT_ADD_ENDPOINT);
247
248	RTCritSectLeave(&pAioMgr->CritSectBlockingEvent);
249
250	if (RT_SUCCESS(rc))
251	ASMAtomicWritePtr((void * volatile *)&pEndpoint->pAioMgr, pAioMgr);
252
253	return rc;
254	}
255
256	static int pdmacFileAioMgrRemoveEndpoint(PPDMACEPFILEMGR pAioMgr, PPDMASYNCCOMPLETIONENDPOINTFILE pEndpoint)
257	{
258	int rc;
259
260	rc = RTCritSectEnter(&pAioMgr->CritSectBlockingEvent);
261	AssertRCReturn(rc, rc);
262
263	ASMAtomicWritePtr((void * volatile *)&pAioMgr->BlockingEventData.RemoveEndpoint.pEndpoint, pEndpoint);
264	rc = pdmacFileAioMgrWaitForBlockingEvent(pAioMgr, PDMACEPFILEAIOMGRBLOCKINGEVENT_REMOVE_ENDPOINT);
265
266	RTCritSectLeave(&pAioMgr->CritSectBlockingEvent);
267
268	return rc;
269	}
270
271	static int pdmacFileAioMgrCloseEndpoint(PPDMACEPFILEMGR pAioMgr, PPDMASYNCCOMPLETIONENDPOINTFILE pEndpoint)
272	{
273	int rc;
274
275	rc = RTCritSectEnter(&pAioMgr->CritSectBlockingEvent);
276	AssertRCReturn(rc, rc);
277
278	ASMAtomicWritePtr((void * volatile *)&pAioMgr->BlockingEventData.CloseEndpoint.pEndpoint, pEndpoint);
279	rc = pdmacFileAioMgrWaitForBlockingEvent(pAioMgr, PDMACEPFILEAIOMGRBLOCKINGEVENT_CLOSE_ENDPOINT);
280
281	RTCritSectLeave(&pAioMgr->CritSectBlockingEvent);
282
283	return rc;
284	}
285
286	static int pdmacFileAioMgrShutdown(PPDMACEPFILEMGR pAioMgr)
287	{
288	int rc;
289
290	rc = RTCritSectEnter(&pAioMgr->CritSectBlockingEvent);
291	AssertRCReturn(rc, rc);
292
293	rc = pdmacFileAioMgrWaitForBlockingEvent(pAioMgr, PDMACEPFILEAIOMGRBLOCKINGEVENT_SHUTDOWN);
294
295	RTCritSectLeave(&pAioMgr->CritSectBlockingEvent);
296
297	return rc;
298	}
299
300	int pdmacFileEpAddTask(PPDMASYNCCOMPLETIONENDPOINTFILE pEndpoint, PPDMACTASKFILE pTask)
301	{
302	PPDMACTASKFILE pNext;
303	do
304	{
305	pNext = pEndpoint->pTasksNewHead;
306	pTask->pNext = pNext;
307	} while (!ASMAtomicCmpXchgPtr((void * volatile )&pEndpoint->pTasksNewHead, (void )pTask, (void *)pNext));
308
309	pdmacFileAioMgrWakeup((PPDMACEPFILEMGR)ASMAtomicReadPtr((void * volatile *)&pEndpoint->pAioMgr));
310
311	return VINF_SUCCESS;
312	}
313
314	void pdmacFileEpTaskCompleted(PPDMACTASKFILE pTask, void *pvUser)
315	{
316	PPDMASYNCCOMPLETIONTASKFILE pTaskFile = (PPDMASYNCCOMPLETIONTASKFILE)pvUser;
317
318	if (pTask->enmTransferType == PDMACTASKFILETRANSFER_FLUSH)
319	{
320	pdmR3AsyncCompletionCompleteTask(&pTaskFile->Core);
321	}
322	else
323	{
324	uint32_t uOld = ASMAtomicSubU32(&pTaskFile->cbTransferLeft, pTask->DataSeg.cbSeg);
325
326	if (!(uOld - pTask->DataSeg.cbSeg)
327	&& !ASMAtomicXchgBool(&pTaskFile->fCompleted, true))
328	pdmR3AsyncCompletionCompleteTask(&pTaskFile->Core);
329	}
330	}
331
332	int pdmacFileEpTaskInitiate(PPDMASYNCCOMPLETIONTASK pTask,
333	PPDMASYNCCOMPLETIONENDPOINT pEndpoint, RTFOFF off,
334	PCPDMDATASEG paSegments, size_t cSegments,
335	size_t cbTransfer, PDMACTASKFILETRANSFER enmTransfer)
336	{
337	int rc = VINF_SUCCESS;
338	PPDMASYNCCOMPLETIONENDPOINTFILE pEpFile = (PPDMASYNCCOMPLETIONENDPOINTFILE)pEndpoint;
339	PPDMASYNCCOMPLETIONTASKFILE pTaskFile = (PPDMASYNCCOMPLETIONTASKFILE)pTask;
340	PPDMACEPFILEMGR pAioMgr = pEpFile->pAioMgr;
341
342	Assert( (enmTransfer == PDMACTASKFILETRANSFER_READ)
343	\|\| (enmTransfer == PDMACTASKFILETRANSFER_WRITE));
344
345	pTaskFile->cbTransferLeft = cbTransfer;
346
347	for (unsigned i = 0; i < cSegments; i++)
348	{
349	PPDMACTASKFILE pIoTask = pdmacFileTaskAlloc(pEpFile);
350	AssertPtr(pIoTask);
351
352	pIoTask->pEndpoint = pEpFile;
353	pIoTask->enmTransferType = enmTransfer;
354	pIoTask->Off = off;
355	pIoTask->DataSeg.cbSeg = paSegments[i].cbSeg;
356	pIoTask->DataSeg.pvSeg = paSegments[i].pvSeg;
357	pIoTask->pvUser = pTaskFile;
358	pIoTask->pfnCompleted = pdmacFileEpTaskCompleted;
359
360	/* Send it off to the I/O manager. */
361	pdmacFileEpAddTask(pEpFile, pIoTask);
362	off += paSegments[i].cbSeg;
363	cbTransfer -= paSegments[i].cbSeg;
364	}
365
366	AssertMsg(!cbTransfer, ("Incomplete transfer %u bytes left\n", cbTransfer));
367
368	return VINF_SUCCESS;
369	}
370
371	/**
372	* Creates a new async I/O manager.
373	*
374	* @returns VBox status code.
375	* @param pEpClass Pointer to the endpoint class data.
376	* @param ppAioMgr Where to store the pointer to the new async I/O manager on success.
377	*/
378	static int pdmacFileAioMgrCreate(PPDMASYNCCOMPLETIONEPCLASSFILE pEpClass, PPPDMACEPFILEMGR ppAioMgr)
379	{
380	int rc = VINF_SUCCESS;
381	PPDMACEPFILEMGR pAioMgrNew;
382
383	LogFlowFunc((": Entered\n"));
384
385	rc = MMR3HeapAllocZEx(pEpClass->Core.pVM, MM_TAG_PDM_ASYNC_COMPLETION, sizeof(PDMACEPFILEMGR), (void **)&pAioMgrNew);
386	if (RT_SUCCESS(rc))
387	{
388	pAioMgrNew->fFailsafe = pEpClass->fFailsafe;
389
390	rc = RTSemEventCreate(&pAioMgrNew->EventSem);
391	if (RT_SUCCESS(rc))
392	{
393	rc = RTSemEventCreate(&pAioMgrNew->EventSemBlock);
394	if (RT_SUCCESS(rc))
395	{
396	rc = RTCritSectInit(&pAioMgrNew->CritSectBlockingEvent);
397	if (RT_SUCCESS(rc))
398	{
399	/* Init the rest of the manager. */
400	if (!pAioMgrNew->fFailsafe)
401	rc = pdmacFileAioMgrNormalInit(pAioMgrNew);
402
403	if (RT_SUCCESS(rc))
404	{
405	pAioMgrNew->enmState = PDMACEPFILEMGRSTATE_RUNNING;
406
407	rc = RTThreadCreateF(&pAioMgrNew->Thread,
408	pAioMgrNew->fFailsafe
409	? pdmacFileAioMgrFailsafe
410	: pdmacFileAioMgrNormal,
411	pAioMgrNew,
412	0,
413	RTTHREADTYPE_IO,
414	0,
415	"AioMgr%d-%s", pEpClass->cAioMgrs,
416	pAioMgrNew->fFailsafe
417	? "F"
418	: "N");
419	if (RT_SUCCESS(rc))
420	{
421	/* Link it into the list. */
422	RTCritSectEnter(&pEpClass->CritSect);
423	pAioMgrNew->pNext = pEpClass->pAioMgrHead;
424	if (pEpClass->pAioMgrHead)
425	pEpClass->pAioMgrHead->pPrev = pAioMgrNew;
426	pEpClass->pAioMgrHead = pAioMgrNew;
427	pEpClass->cAioMgrs++;
428	RTCritSectLeave(&pEpClass->CritSect);
429
430	*ppAioMgr = pAioMgrNew;
431
432	Log(("PDMAC: Successfully created new file AIO Mgr {%s}\n", RTThreadGetName(pAioMgrNew->Thread)));
433	return VINF_SUCCESS;
434	}
435	pdmacFileAioMgrNormalDestroy(pAioMgrNew);
436	}
437	RTCritSectDelete(&pAioMgrNew->CritSectBlockingEvent);
438	}
439	RTSemEventDestroy(pAioMgrNew->EventSem);
440	}
441	RTSemEventDestroy(pAioMgrNew->EventSemBlock);
442	}
443	MMR3HeapFree(pAioMgrNew);
444	}
445
446	LogFlowFunc((": Leave rc=%Rrc\n", rc));
447
448	return rc;
449	}
450
451	/**
452	* Destroys a async I/O manager.
453	*
454	* @returns nothing.
455	* @param pAioMgr The async I/O manager to destroy.
456	*/
457	static void pdmacFileAioMgrDestroy(PPDMASYNCCOMPLETIONEPCLASSFILE pEpClassFile, PPDMACEPFILEMGR pAioMgr)
458	{
459	int rc = pdmacFileAioMgrShutdown(pAioMgr);
460	AssertRC(rc);
461
462	/* Unlink from the list. */
463	rc = RTCritSectEnter(&pEpClassFile->CritSect);
464	AssertRC(rc);
465
466	PPDMACEPFILEMGR pPrev = pAioMgr->pPrev;
467	PPDMACEPFILEMGR pNext = pAioMgr->pNext;
468
469	if (pPrev)
470	pPrev->pNext = pNext;
471	else
472	pEpClassFile->pAioMgrHead = pNext;
473
474	if (pNext)
475	pNext->pPrev = pPrev;
476
477	pEpClassFile->cAioMgrs--;
478
479	rc = RTCritSectLeave(&pEpClassFile->CritSect);
480	AssertRC(rc);
481
482	/* Free the ressources. */
483	RTCritSectDelete(&pAioMgr->CritSectBlockingEvent);
484	RTSemEventDestroy(pAioMgr->EventSem);
485	if (!pAioMgr->fFailsafe)
486	pdmacFileAioMgrNormalDestroy(pAioMgr);
487
488	MMR3HeapFree(pAioMgr);
489	}
490
491	static int pdmacFileInitialize(PPDMASYNCCOMPLETIONEPCLASS pClassGlobals, PCFGMNODE pCfgNode)
492	{
493	int rc = VINF_SUCCESS;
494	RTFILEAIOLIMITS AioLimits; /** < Async I/O limitations. */
495
496	PPDMASYNCCOMPLETIONEPCLASSFILE pEpClassFile = (PPDMASYNCCOMPLETIONEPCLASSFILE)pClassGlobals;
497
498	rc = RTFileAioGetLimits(&AioLimits);
499	if (RT_FAILURE(rc))
500	{
501	LogRel(("AIO: Async I/O manager not supported (rc=%Rrc). Falling back to failsafe manager\n",
502	rc));
503	pEpClassFile->fFailsafe = true;
504	}
505	else
506	{
507	pEpClassFile->uBitmaskAlignment = ~((RTR3UINTPTR)AioLimits.cbBufferAlignment - 1);
508	pEpClassFile->cReqsOutstandingMax = AioLimits.cReqsOutstandingMax;
509	pEpClassFile->fFailsafe = false;
510	}
511
512	/* Init critical section. */
513	rc = RTCritSectInit(&pEpClassFile->CritSect);
514	if (RT_SUCCESS(rc))
515	{
516	/* Init cache structure */
517	rc = pdmacFileCacheInit(pEpClassFile, pCfgNode);
518	if (RT_FAILURE(rc))
519	RTCritSectDelete(&pEpClassFile->CritSect);
520	}
521
522	return rc;
523	}
524
525	static void pdmacFileTerminate(PPDMASYNCCOMPLETIONEPCLASS pClassGlobals)
526	{
527	PPDMASYNCCOMPLETIONEPCLASSFILE pEpClassFile = (PPDMASYNCCOMPLETIONEPCLASSFILE)pClassGlobals;
528
529	/* All endpoints should be closed at this point. */
530	AssertMsg(!pEpClassFile->Core.pEndpointsHead, ("There are still endpoints left\n"));
531
532	/* Destroy all left async I/O managers. */
533	while (pEpClassFile->pAioMgrHead)
534	pdmacFileAioMgrDestroy(pEpClassFile, pEpClassFile->pAioMgrHead);
535
536	RTCritSectDelete(&pEpClassFile->CritSect);
537	}
538
539	static int pdmacFileEpInitialize(PPDMASYNCCOMPLETIONENDPOINT pEndpoint,
540	const char *pszUri, uint32_t fFlags)
541	{
542	int rc = VINF_SUCCESS;
543	PPDMASYNCCOMPLETIONENDPOINTFILE pEpFile = (PPDMASYNCCOMPLETIONENDPOINTFILE)pEndpoint;
544	PPDMASYNCCOMPLETIONEPCLASSFILE pEpClassFile = (PPDMASYNCCOMPLETIONEPCLASSFILE)pEndpoint->pEpClass;
545
546	AssertMsgReturn((fFlags & ~(PDMACEP_FILE_FLAGS_READ_ONLY \| PDMACEP_FILE_FLAGS_CACHING)) == 0,
547	("PDMAsyncCompletion: Invalid flag specified\n"), VERR_INVALID_PARAMETER);
548
549	unsigned fFileFlags = fFlags & PDMACEP_FILE_FLAGS_READ_ONLY
550	? RTFILE_O_READ \| RTFILE_O_OPEN \| RTFILE_O_DENY_NONE
551	: RTFILE_O_READWRITE \| RTFILE_O_OPEN \| RTFILE_O_DENY_WRITE;
552
553	if (!pEpClassFile->fFailsafe)
554	{
555	fFileFlags \|= (RTFILE_O_ASYNC_IO \| RTFILE_O_WRITE_THROUGH);
556
557	/*
558	* We only disable the cache if the size of the file is a multiple of 512.
559	* Certain hosts like Windows, Linux and Solaris require that transfer sizes
560	* are aligned to the volume sector size.
561	* If not we just make sure that the data is written to disk with RTFILE_O_WRITE_THROUGH
562	* which will trash the host cache but ensures that the host cache will not
563	* contain dirty buffers.
564	*/
565	RTFILE File = NIL_RTFILE;
566
567	rc = RTFileOpen(&File, pszUri, RTFILE_O_OPEN \| RTFILE_O_READ \| RTFILE_O_DENY_NONE);
568	if (RT_SUCCESS(rc))
569	{
570	uint64_t cbSize;
571
572	rc = RTFileGetSize(File, &cbSize);
573	if (RT_SUCCESS(rc) && ((cbSize % 512) == 0))
574	{
575	fFileFlags &= ~RTFILE_O_WRITE_THROUGH;
576	fFileFlags \|= RTFILE_O_NO_CACHE;
577	}
578
579	RTFileClose(File);
580	}
581	}
582
583	pEpFile->fFlags = fFileFlags;
584
585	/* Open with final flags. */
586	rc = RTFileOpen(&pEpFile->File, pszUri, fFileFlags);
587	if (RT_SUCCESS(rc))
588	{
589	/* Initialize the segment cache */
590	rc = MMR3HeapAllocZEx(pEpClassFile->Core.pVM, MM_TAG_PDM_ASYNC_COMPLETION,
591	sizeof(PDMACTASKFILE),
592	(void **)&pEpFile->pTasksFreeHead);
593	if (RT_SUCCESS(rc))
594	{
595	PPDMACEPFILEMGR pAioMgr = NULL;
596
597	pEpFile->pTasksFreeTail = pEpFile->pTasksFreeHead;
598	pEpFile->cTasksCached = 0;
599
600	if (pEpClassFile->fFailsafe)
601	{
602	/* Safe mode. Every file has its own async I/O manager. */
603	rc = pdmacFileAioMgrCreate(pEpClassFile, &pAioMgr);
604	AssertRC(rc);
605	}
606	else
607	{
608	if (fFlags & PDMACEP_FILE_FLAGS_CACHING)
609	{
610	pEpFile->fCaching = true;
611	rc = pdmacFileEpCacheInit(pEpFile, pEpClassFile);
612	if (RT_FAILURE(rc))
613	{
614	LogRel(("AIOMgr: Endpoint for \"%s\" was opened with caching but initializing cache failed. Disabled caching\n", pszUri));
615	pEpFile->fCaching = false;
616	}
617	}
618
619	/* Check for an idling one or create new if not found */
620	if (!pEpClassFile->pAioMgrHead)
621	{
622	rc = pdmacFileAioMgrCreate(pEpClassFile, &pAioMgr);
623	AssertRC(rc);
624	}
625	else
626	{
627	pAioMgr = pEpClassFile->pAioMgrHead;
628	}
629	}
630
631	pEpFile->enmState = PDMASYNCCOMPLETIONENDPOINTFILESTATE_ACTIVE;
632
633	/* Assign the endpoint to the thread. */
634	rc = pdmacFileAioMgrAddEndpoint(pAioMgr, pEpFile);
635	if (RT_FAILURE(rc))
636	MMR3HeapFree(pEpFile->pTasksFreeHead);
637	}
638
639	if (RT_FAILURE(rc))
640	RTFileClose(pEpFile->File);
641	}
642
643	return rc;
644	}
645
646	static int pdmacFileEpClose(PPDMASYNCCOMPLETIONENDPOINT pEndpoint)
647	{
648	PPDMASYNCCOMPLETIONENDPOINTFILE pEpFile = (PPDMASYNCCOMPLETIONENDPOINTFILE)pEndpoint;
649	PPDMASYNCCOMPLETIONEPCLASSFILE pEpClassFile = (PPDMASYNCCOMPLETIONEPCLASSFILE)pEndpoint->pEpClass;
650
651	/* Make sure that all tasks finished for this endpoint. */
652	int rc = pdmacFileAioMgrCloseEndpoint(pEpFile->pAioMgr, pEpFile);
653	AssertRC(rc);
654
655	/*
656	* If the async I/O manager is in failsafe mode this is the only endpoint
657	* he processes and thus can be destroyed now.
658	*/
659	if (pEpFile->pAioMgr->fFailsafe)
660	pdmacFileAioMgrDestroy(pEpClassFile, pEpFile->pAioMgr);
661
662	/* Free cached tasks. */
663	PPDMACTASKFILE pTask = pEpFile->pTasksFreeHead;
664
665	while (pTask)
666	{
667	PPDMACTASKFILE pTaskFree = pTask;
668	pTask = pTask->pNext;
669	MMR3HeapFree(pTaskFree);
670	}
671
672	/* Free the cached data. */
673	if (pEpFile->fCaching)
674	pdmacFileEpCacheDestroy(pEpFile);
675
676	return VINF_SUCCESS;
677	}
678
679	static int pdmacFileEpRead(PPDMASYNCCOMPLETIONTASK pTask,
680	PPDMASYNCCOMPLETIONENDPOINT pEndpoint, RTFOFF off,
681	PCPDMDATASEG paSegments, size_t cSegments,
682	size_t cbRead)
683	{
684	PPDMASYNCCOMPLETIONENDPOINTFILE pEpFile = (PPDMASYNCCOMPLETIONENDPOINTFILE)pEndpoint;
685
686	if (pEpFile->fCaching)
687	return pdmacFileEpCacheRead(pEpFile, (PPDMASYNCCOMPLETIONTASKFILE)pTask,
688	off, paSegments, cSegments, cbRead);
689	else
690	return pdmacFileEpTaskInitiate(pTask, pEndpoint, off, paSegments, cSegments, cbRead,
691	PDMACTASKFILETRANSFER_READ);
692	}
693
694	static int pdmacFileEpWrite(PPDMASYNCCOMPLETIONTASK pTask,
695	PPDMASYNCCOMPLETIONENDPOINT pEndpoint, RTFOFF off,
696	PCPDMDATASEG paSegments, size_t cSegments,
697	size_t cbWrite)
698	{
699	PPDMASYNCCOMPLETIONENDPOINTFILE pEpFile = (PPDMASYNCCOMPLETIONENDPOINTFILE)pEndpoint;
700
701	if (RT_UNLIKELY(pEpFile->fReadonly))
702	return VERR_NOT_SUPPORTED;
703
704	if (pEpFile->fCaching)
705	return pdmacFileEpCacheWrite(pEpFile, (PPDMASYNCCOMPLETIONTASKFILE)pTask,
706	off, paSegments, cSegments, cbWrite);
707	else
708	return pdmacFileEpTaskInitiate(pTask, pEndpoint, off, paSegments, cSegments, cbWrite,
709	PDMACTASKFILETRANSFER_WRITE);
710	}
711
712	static int pdmacFileEpFlush(PPDMASYNCCOMPLETIONTASK pTask,
713	PPDMASYNCCOMPLETIONENDPOINT pEndpoint)
714	{
715	PPDMASYNCCOMPLETIONENDPOINTFILE pEpFile = (PPDMASYNCCOMPLETIONENDPOINTFILE)pEndpoint;
716	PPDMASYNCCOMPLETIONTASKFILE pTaskFile = (PPDMASYNCCOMPLETIONTASKFILE)pTask;
717
718	if (RT_UNLIKELY(pEpFile->fReadonly))
719	return VERR_NOT_SUPPORTED;
720
721	pTaskFile->cbTransferLeft = 0;
722
723	PPDMACTASKFILE pIoTask = pdmacFileTaskAlloc(pEpFile);
724	AssertPtr(pIoTask);
725
726	pIoTask->pEndpoint = pEpFile;
727	pIoTask->enmTransferType = PDMACTASKFILETRANSFER_FLUSH;
728	pIoTask->pvUser = pTaskFile;
729	pIoTask->pfnCompleted = pdmacFileEpTaskCompleted;
730	pdmacFileEpAddTask(pEpFile, pIoTask);
731
732	return VINF_SUCCESS;
733	}
734
735	static int pdmacFileEpGetSize(PPDMASYNCCOMPLETIONENDPOINT pEndpoint, uint64_t *pcbSize)
736	{
737	PPDMASYNCCOMPLETIONENDPOINTFILE pEpFile = (PPDMASYNCCOMPLETIONENDPOINTFILE)pEndpoint;
738
739	return RTFileGetSize(pEpFile->File, pcbSize);
740	}
741
742	const PDMASYNCCOMPLETIONEPCLASSOPS g_PDMAsyncCompletionEndpointClassFile =
743	{
744	/* u32Version */
745	PDMAC_EPCLASS_OPS_VERSION,
746	/* pcszName */
747	"File",
748	/* enmClassType */
749	PDMASYNCCOMPLETIONEPCLASSTYPE_FILE,
750	/* cbEndpointClassGlobal */
751	sizeof(PDMASYNCCOMPLETIONEPCLASSFILE),
752	/* cbEndpoint */
753	sizeof(PDMASYNCCOMPLETIONENDPOINTFILE),
754	/* cbTask */
755	sizeof(PDMASYNCCOMPLETIONTASKFILE),
756	/* pfnInitialize */
757	pdmacFileInitialize,
758	/* pfnTerminate */
759	pdmacFileTerminate,
760	/* pfnEpInitialize. */
761	pdmacFileEpInitialize,
762	/* pfnEpClose */
763	pdmacFileEpClose,
764	/* pfnEpRead */
765	pdmacFileEpRead,
766	/* pfnEpWrite */
767	pdmacFileEpWrite,
768	/* pfnEpFlush */
769	pdmacFileEpFlush,
770	/* pfnEpGetSize */
771	pdmacFileEpGetSize,
772	/* u32VersionEnd */
773	PDMAC_EPCLASS_OPS_VERSION
774	};
775

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/VMM/PDMAsyncCompletionFile.cpp@ 22336

Download in other formats: