VirtualBox

source: vbox/trunk/src/VBox/VMM/VMMR3/PDMAsyncCompletion.cpp@ 39025

Last change on this file since 39025 was 39014, checked in by vboxsync, 13 years ago

PDMAsyncCompletion.cpp: Addressed out of bound indexing of StatTaskRunTimesSec and did some code cleanup reducing the file by some 110+ lines.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 53.1 KB
Line 
1/* $Id: PDMAsyncCompletion.cpp 39014 2011-10-18 10:18:06Z vboxsync $ */
2/** @file
3 * PDM Async I/O - Transport data asynchronous in R3 using EMT.
4 */
5
6/*
7 * Copyright (C) 2006-2011 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 */
17
18
19/*******************************************************************************
20* Header Files *
21*******************************************************************************/
22#define LOG_GROUP LOG_GROUP_PDM_ASYNC_COMPLETION
23#include "PDMInternal.h"
24#include <VBox/vmm/pdm.h>
25#include <VBox/vmm/mm.h>
26#include <VBox/vmm/rem.h>
27#include <VBox/vmm/vm.h>
28#include <VBox/vmm/uvm.h>
29#include <VBox/err.h>
30
31#include <VBox/log.h>
32#include <iprt/asm.h>
33#include <iprt/assert.h>
34#include <iprt/thread.h>
35#include <iprt/mem.h>
36#include <iprt/critsect.h>
37#include <iprt/tcp.h>
38#include <iprt/path.h>
39#include <iprt/string.h>
40
41#include <VBox/vmm/pdmasynccompletion.h>
42#include "PDMAsyncCompletionInternal.h"
43
44
45/*******************************************************************************
46* Structures and Typedefs *
47*******************************************************************************/
48/**
49 * Async I/O type.
50 */
51typedef enum PDMASYNCCOMPLETIONTEMPLATETYPE
52{
53 /** Device . */
54 PDMASYNCCOMPLETIONTEMPLATETYPE_DEV = 1,
55 /** Driver consumer. */
56 PDMASYNCCOMPLETIONTEMPLATETYPE_DRV,
57 /** Internal consumer. */
58 PDMASYNCCOMPLETIONTEMPLATETYPE_INTERNAL,
59 /** Usb consumer. */
60 PDMASYNCCOMPLETIONTEMPLATETYPE_USB
61} PDMASYNCTEMPLATETYPE;
62
63/**
64 * PDM Async I/O template.
65 */
66typedef struct PDMASYNCCOMPLETIONTEMPLATE
67{
68 /** Pointer to the next template in the list. */
69 R3PTRTYPE(PPDMASYNCCOMPLETIONTEMPLATE) pNext;
70 /** Pointer to the previous template in the list. */
71 R3PTRTYPE(PPDMASYNCCOMPLETIONTEMPLATE) pPrev;
72 /** Type specific data. */
73 union
74 {
75 /** PDMASYNCCOMPLETIONTEMPLATETYPE_DEV */
76 struct
77 {
78 /** Pointer to consumer function. */
79 R3PTRTYPE(PFNPDMASYNCCOMPLETEDEV) pfnCompleted;
80 /** Pointer to the device instance owning the template. */
81 R3PTRTYPE(PPDMDEVINS) pDevIns;
82 } Dev;
83 /** PDMASYNCCOMPLETIONTEMPLATETYPE_DRV */
84 struct
85 {
86 /** Pointer to consumer function. */
87 R3PTRTYPE(PFNPDMASYNCCOMPLETEDRV) pfnCompleted;
88 /** Pointer to the driver instance owning the template. */
89 R3PTRTYPE(PPDMDRVINS) pDrvIns;
90 /** User argument given during template creation.
91 * This is only here to make things much easier
92 * for DrVVD. */
93 void *pvTemplateUser;
94 } Drv;
95 /** PDMASYNCCOMPLETIONTEMPLATETYPE_INTERNAL */
96 struct
97 {
98 /** Pointer to consumer function. */
99 R3PTRTYPE(PFNPDMASYNCCOMPLETEINT) pfnCompleted;
100 /** Pointer to user data. */
101 R3PTRTYPE(void *) pvUser;
102 } Int;
103 /** PDMASYNCCOMPLETIONTEMPLATETYPE_USB */
104 struct
105 {
106 /** Pointer to consumer function. */
107 R3PTRTYPE(PFNPDMASYNCCOMPLETEUSB) pfnCompleted;
108 /** Pointer to the usb instance owning the template. */
109 R3PTRTYPE(PPDMUSBINS) pUsbIns;
110 } Usb;
111 } u;
112 /** Template type. */
113 PDMASYNCCOMPLETIONTEMPLATETYPE enmType;
114 /** Pointer to the VM. */
115 R3PTRTYPE(PVM) pVM;
116 /** Use count of the template. */
117 volatile uint32_t cUsed;
118} PDMASYNCCOMPLETIONTEMPLATE;
119
120/**
121 * Bandwidth control manager instance data
122 */
123typedef struct PDMACBWMGR
124{
125 /** Pointer to the next manager in the list. */
126 struct PDMACBWMGR *pNext;
127 /** Pointer to the shared UVM structure. */
128 PPDMASYNCCOMPLETIONEPCLASS pEpClass;
129 /** Identifier of the manager. */
130 char *pszId;
131 /** Maximum number of bytes the endpoints are allowed to transfer (Max is 4GB/s currently) */
132 volatile uint32_t cbTransferPerSecMax;
133 /** Number of bytes we start with */
134 volatile uint32_t cbTransferPerSecStart;
135 /** Step after each update */
136 volatile uint32_t cbTransferPerSecStep;
137 /** Number of bytes we are allowed to transfer till the next update.
138 * Reset by the refresh timer. */
139 volatile uint32_t cbTransferAllowed;
140 /** Timestamp of the last update */
141 volatile uint64_t tsUpdatedLast;
142 /** Reference counter - How many endpoints are associated with this manager. */
143 volatile uint32_t cRefs;
144} PDMACBWMGR;
145/** Pointer to a bandwidth control manager pointer. */
146typedef PPDMACBWMGR *PPPDMACBWMGR;
147
148
149/*******************************************************************************
150* Internal Functions *
151*******************************************************************************/
152static void pdmR3AsyncCompletionPutTask(PPDMASYNCCOMPLETIONENDPOINT pEndpoint, PPDMASYNCCOMPLETIONTASK pTask);
153
154
155/**
156 * Internal worker for the creation apis
157 *
158 * @returns VBox status.
159 * @param pVM VM handle.
160 * @param ppTemplate Where to store the template handle.
161 */
162static int pdmR3AsyncCompletionTemplateCreate(PVM pVM, PPPDMASYNCCOMPLETIONTEMPLATE ppTemplate,
163 PDMASYNCCOMPLETIONTEMPLATETYPE enmType)
164{
165 PUVM pUVM = pVM->pUVM;
166
167 AssertPtrReturn(ppTemplate, VERR_INVALID_POINTER);
168
169 PPDMASYNCCOMPLETIONTEMPLATE pTemplate;
170 int rc = MMR3HeapAllocZEx(pVM, MM_TAG_PDM_ASYNC_COMPLETION, sizeof(PDMASYNCCOMPLETIONTEMPLATE), (void **)&pTemplate);
171 if (RT_FAILURE(rc))
172 return rc;
173
174 /*
175 * Initialize fields.
176 */
177 pTemplate->pVM = pVM;
178 pTemplate->cUsed = 0;
179 pTemplate->enmType = enmType;
180
181 /*
182 * Add template to the global VM template list.
183 */
184 RTCritSectEnter(&pUVM->pdm.s.ListCritSect);
185 pTemplate->pNext = pUVM->pdm.s.pAsyncCompletionTemplates;
186 if (pUVM->pdm.s.pAsyncCompletionTemplates)
187 pUVM->pdm.s.pAsyncCompletionTemplates->pPrev = pTemplate;
188 pUVM->pdm.s.pAsyncCompletionTemplates = pTemplate;
189 RTCritSectLeave(&pUVM->pdm.s.ListCritSect);
190
191 *ppTemplate = pTemplate;
192 return VINF_SUCCESS;
193}
194
195/**
196 * Creates a async completion template for a device instance.
197 *
198 * The template is used when creating new completion tasks.
199 *
200 * @returns VBox status code.
201 * @param pVM Pointer to the shared VM structure.
202 * @param pDevIns The device instance.
203 * @param ppTemplate Where to store the template pointer on success.
204 * @param pfnCompleted The completion callback routine.
205 * @param pszDesc Description.
206 */
207VMMR3DECL(int) PDMR3AsyncCompletionTemplateCreateDevice(PVM pVM, PPDMDEVINS pDevIns, PPPDMASYNCCOMPLETIONTEMPLATE ppTemplate, PFNPDMASYNCCOMPLETEDEV pfnCompleted, const char *pszDesc)
208{
209 LogFlow(("%s: pDevIns=%p ppTemplate=%p pfnCompleted=%p pszDesc=%s\n",
210 __FUNCTION__, pDevIns, ppTemplate, pfnCompleted, pszDesc));
211
212 /*
213 * Validate input.
214 */
215 VM_ASSERT_EMT(pVM);
216 AssertPtrReturn(pfnCompleted, VERR_INVALID_POINTER);
217 AssertPtrReturn(ppTemplate, VERR_INVALID_POINTER);
218
219 /*
220 * Create the template.
221 */
222 PPDMASYNCCOMPLETIONTEMPLATE pTemplate;
223 int rc = pdmR3AsyncCompletionTemplateCreate(pVM, &pTemplate, PDMASYNCCOMPLETIONTEMPLATETYPE_DEV);
224 if (RT_SUCCESS(rc))
225 {
226 pTemplate->u.Dev.pDevIns = pDevIns;
227 pTemplate->u.Dev.pfnCompleted = pfnCompleted;
228
229 *ppTemplate = pTemplate;
230 Log(("PDM: Created device template %p: pfnCompleted=%p pDevIns=%p\n",
231 pTemplate, pfnCompleted, pDevIns));
232 }
233
234 return rc;
235}
236
237/**
238 * Creates a async completion template for a driver instance.
239 *
240 * The template is used when creating new completion tasks.
241 *
242 * @returns VBox status code.
243 * @param pVM Pointer to the shared VM structure.
244 * @param pDrvIns The driver instance.
245 * @param ppTemplate Where to store the template pointer on success.
246 * @param pfnCompleted The completion callback routine.
247 * @param pvTemplateUser Template user argument
248 * @param pszDesc Description.
249 */
250VMMR3DECL(int) PDMR3AsyncCompletionTemplateCreateDriver(PVM pVM, PPDMDRVINS pDrvIns, PPPDMASYNCCOMPLETIONTEMPLATE ppTemplate, PFNPDMASYNCCOMPLETEDRV pfnCompleted, void *pvTemplateUser, const char *pszDesc)
251{
252 LogFlow(("%s: pDrvIns=%p ppTemplate=%p pfnCompleted=%p pszDesc=%s\n",
253 __FUNCTION__, pDrvIns, ppTemplate, pfnCompleted, pszDesc));
254
255 /*
256 * Validate input.
257 */
258 AssertPtrReturn(pfnCompleted, VERR_INVALID_POINTER);
259 AssertPtrReturn(ppTemplate, VERR_INVALID_POINTER);
260
261 /*
262 * Create the template.
263 */
264 PPDMASYNCCOMPLETIONTEMPLATE pTemplate;
265 int rc = pdmR3AsyncCompletionTemplateCreate(pVM, &pTemplate, PDMASYNCCOMPLETIONTEMPLATETYPE_DRV);
266 if (RT_SUCCESS(rc))
267 {
268 pTemplate->u.Drv.pDrvIns = pDrvIns;
269 pTemplate->u.Drv.pfnCompleted = pfnCompleted;
270 pTemplate->u.Drv.pvTemplateUser = pvTemplateUser;
271
272 *ppTemplate = pTemplate;
273 Log(("PDM: Created driver template %p: pfnCompleted=%p pDrvIns=%p\n",
274 pTemplate, pfnCompleted, pDrvIns));
275 }
276
277 return rc;
278}
279
280/**
281 * Creates a async completion template for a USB device instance.
282 *
283 * The template is used when creating new completion tasks.
284 *
285 * @returns VBox status code.
286 * @param pVM Pointer to the shared VM structure.
287 * @param pUsbIns The USB device instance.
288 * @param ppTemplate Where to store the template pointer on success.
289 * @param pfnCompleted The completion callback routine.
290 * @param pszDesc Description.
291 */
292VMMR3DECL(int) PDMR3AsyncCompletionTemplateCreateUsb(PVM pVM, PPDMUSBINS pUsbIns, PPPDMASYNCCOMPLETIONTEMPLATE ppTemplate, PFNPDMASYNCCOMPLETEUSB pfnCompleted, const char *pszDesc)
293{
294 LogFlow(("%s: pUsbIns=%p ppTemplate=%p pfnCompleted=%p pszDesc=%s\n",
295 __FUNCTION__, pUsbIns, ppTemplate, pfnCompleted, pszDesc));
296
297 /*
298 * Validate input.
299 */
300 VM_ASSERT_EMT(pVM);
301 AssertPtrReturn(pfnCompleted, VERR_INVALID_POINTER);
302 AssertPtrReturn(ppTemplate, VERR_INVALID_POINTER);
303
304 /*
305 * Create the template.
306 */
307 PPDMASYNCCOMPLETIONTEMPLATE pTemplate;
308 int rc = pdmR3AsyncCompletionTemplateCreate(pVM, &pTemplate, PDMASYNCCOMPLETIONTEMPLATETYPE_USB);
309 if (RT_SUCCESS(rc))
310 {
311 pTemplate->u.Usb.pUsbIns = pUsbIns;
312 pTemplate->u.Usb.pfnCompleted = pfnCompleted;
313
314 *ppTemplate = pTemplate;
315 Log(("PDM: Created usb template %p: pfnCompleted=%p pDevIns=%p\n",
316 pTemplate, pfnCompleted, pUsbIns));
317 }
318
319 return rc;
320}
321
322/**
323 * Creates a async completion template for internally by the VMM.
324 *
325 * The template is used when creating new completion tasks.
326 *
327 * @returns VBox status code.
328 * @param pVM Pointer to the shared VM structure.
329 * @param ppTemplate Where to store the template pointer on success.
330 * @param pfnCompleted The completion callback routine.
331 * @param pvUser2 The 2nd user argument for the callback.
332 * @param pszDesc Description.
333 */
334VMMR3DECL(int) PDMR3AsyncCompletionTemplateCreateInternal(PVM pVM, PPPDMASYNCCOMPLETIONTEMPLATE ppTemplate, PFNPDMASYNCCOMPLETEINT pfnCompleted, void *pvUser2, const char *pszDesc)
335{
336 LogFlow(("%s: ppTemplate=%p pfnCompleted=%p pvUser2=%p pszDesc=%s\n",
337 __FUNCTION__, ppTemplate, pfnCompleted, pvUser2, pszDesc));
338
339 /*
340 * Validate input.
341 */
342 VM_ASSERT_EMT(pVM);
343 AssertPtrReturn(pfnCompleted, VERR_INVALID_POINTER);
344 AssertPtrReturn(ppTemplate, VERR_INVALID_POINTER);
345
346 /*
347 * Create the template.
348 */
349 PPDMASYNCCOMPLETIONTEMPLATE pTemplate;
350 int rc = pdmR3AsyncCompletionTemplateCreate(pVM, &pTemplate, PDMASYNCCOMPLETIONTEMPLATETYPE_INTERNAL);
351 if (RT_SUCCESS(rc))
352 {
353 pTemplate->u.Int.pvUser = pvUser2;
354 pTemplate->u.Int.pfnCompleted = pfnCompleted;
355
356 *ppTemplate = pTemplate;
357 Log(("PDM: Created internal template %p: pfnCompleted=%p pvUser2=%p\n",
358 pTemplate, pfnCompleted, pvUser2));
359 }
360
361 return rc;
362}
363
364/**
365 * Destroys the specified async completion template.
366 *
367 * @returns VBox status codes:
368 * @retval VINF_SUCCESS on success.
369 * @retval VERR_PDM_ASYNC_TEMPLATE_BUSY if the template is still in use.
370 *
371 * @param pTemplate The template in question.
372 */
373VMMR3DECL(int) PDMR3AsyncCompletionTemplateDestroy(PPDMASYNCCOMPLETIONTEMPLATE pTemplate)
374{
375 LogFlow(("%s: pTemplate=%p\n", __FUNCTION__, pTemplate));
376
377 if (!pTemplate)
378 {
379 AssertMsgFailed(("pTemplate is NULL!\n"));
380 return VERR_INVALID_PARAMETER;
381 }
382
383 /*
384 * Check if the template is still used.
385 */
386 if (pTemplate->cUsed > 0)
387 {
388 AssertMsgFailed(("Template is still in use\n"));
389 return VERR_PDM_ASYNC_TEMPLATE_BUSY;
390 }
391
392 /*
393 * Unlink the template from the list.
394 */
395 PUVM pUVM = pTemplate->pVM->pUVM;
396 RTCritSectEnter(&pUVM->pdm.s.ListCritSect);
397
398 PPDMASYNCCOMPLETIONTEMPLATE pPrev = pTemplate->pPrev;
399 PPDMASYNCCOMPLETIONTEMPLATE pNext = pTemplate->pNext;
400
401 if (pPrev)
402 pPrev->pNext = pNext;
403 else
404 pUVM->pdm.s.pAsyncCompletionTemplates = pNext;
405
406 if (pNext)
407 pNext->pPrev = pPrev;
408
409 RTCritSectLeave(&pUVM->pdm.s.ListCritSect);
410
411 /*
412 * Free the template.
413 */
414 MMR3HeapFree(pTemplate);
415
416 return VINF_SUCCESS;
417}
418
419/**
420 * Destroys all the specified async completion templates for the given device instance.
421 *
422 * @returns VBox status codes:
423 * @retval VINF_SUCCESS on success.
424 * @retval VERR_PDM_ASYNC_TEMPLATE_BUSY if one or more of the templates are still in use.
425 *
426 * @param pVM Pointer to the shared VM structure.
427 * @param pDevIns The device instance.
428 */
429VMMR3DECL(int) PDMR3AsyncCompletionTemplateDestroyDevice(PVM pVM, PPDMDEVINS pDevIns)
430{
431 LogFlow(("%s: pDevIns=%p\n", __FUNCTION__, pDevIns));
432
433 /*
434 * Validate input.
435 */
436 if (!pDevIns)
437 return VERR_INVALID_PARAMETER;
438 VM_ASSERT_EMT(pVM);
439
440 /*
441 * Unlink it.
442 */
443 PUVM pUVM = pVM->pUVM;
444 RTCritSectEnter(&pUVM->pdm.s.ListCritSect);
445 PPDMASYNCCOMPLETIONTEMPLATE pTemplate = pUVM->pdm.s.pAsyncCompletionTemplates;
446 while (pTemplate)
447 {
448 if ( pTemplate->enmType == PDMASYNCCOMPLETIONTEMPLATETYPE_DEV
449 && pTemplate->u.Dev.pDevIns == pDevIns)
450 {
451 PPDMASYNCCOMPLETIONTEMPLATE pTemplateDestroy = pTemplate;
452 pTemplate = pTemplate->pNext;
453 int rc = PDMR3AsyncCompletionTemplateDestroy(pTemplateDestroy);
454 if (RT_FAILURE(rc))
455 {
456 RTCritSectLeave(&pUVM->pdm.s.ListCritSect);
457 return rc;
458 }
459 }
460 else
461 pTemplate = pTemplate->pNext;
462 }
463
464 RTCritSectLeave(&pUVM->pdm.s.ListCritSect);
465 return VINF_SUCCESS;
466}
467
468/**
469 * Destroys all the specified async completion templates for the given driver instance.
470 *
471 * @returns VBox status codes:
472 * @retval VINF_SUCCESS on success.
473 * @retval VERR_PDM_ASYNC_TEMPLATE_BUSY if one or more of the templates are still in use.
474 *
475 * @param pVM Pointer to the shared VM structure.
476 * @param pDrvIns The driver instance.
477 */
478VMMR3DECL(int) PDMR3AsyncCompletionTemplateDestroyDriver(PVM pVM, PPDMDRVINS pDrvIns)
479{
480 LogFlow(("%s: pDevIns=%p\n", __FUNCTION__, pDrvIns));
481
482 /*
483 * Validate input.
484 */
485 if (!pDrvIns)
486 return VERR_INVALID_PARAMETER;
487 VM_ASSERT_EMT(pVM);
488
489 /*
490 * Unlink it.
491 */
492 PUVM pUVM = pVM->pUVM;
493 RTCritSectEnter(&pUVM->pdm.s.ListCritSect);
494 PPDMASYNCCOMPLETIONTEMPLATE pTemplate = pUVM->pdm.s.pAsyncCompletionTemplates;
495 while (pTemplate)
496 {
497 if ( pTemplate->enmType == PDMASYNCCOMPLETIONTEMPLATETYPE_DRV
498 && pTemplate->u.Drv.pDrvIns == pDrvIns)
499 {
500 PPDMASYNCCOMPLETIONTEMPLATE pTemplateDestroy = pTemplate;
501 pTemplate = pTemplate->pNext;
502 int rc = PDMR3AsyncCompletionTemplateDestroy(pTemplateDestroy);
503 if (RT_FAILURE(rc))
504 {
505 RTCritSectLeave(&pUVM->pdm.s.ListCritSect);
506 return rc;
507 }
508 }
509 else
510 pTemplate = pTemplate->pNext;
511 }
512
513 RTCritSectLeave(&pUVM->pdm.s.ListCritSect);
514 return VINF_SUCCESS;
515}
516
517/**
518 * Destroys all the specified async completion templates for the given USB device instance.
519 *
520 * @returns VBox status codes:
521 * @retval VINF_SUCCESS on success.
522 * @retval VERR_PDM_ASYNC_TEMPLATE_BUSY if one or more of the templates are still in use.
523 *
524 * @param pVM Pointer to the shared VM structure.
525 * @param pUsbIns The USB device instance.
526 */
527VMMR3DECL(int) PDMR3AsyncCompletionTemplateDestroyUsb(PVM pVM, PPDMUSBINS pUsbIns)
528{
529 LogFlow(("%s: pUsbIns=%p\n", __FUNCTION__, pUsbIns));
530
531 /*
532 * Validate input.
533 */
534 if (!pUsbIns)
535 return VERR_INVALID_PARAMETER;
536 VM_ASSERT_EMT(pVM);
537
538 /*
539 * Unlink it.
540 */
541 PUVM pUVM = pVM->pUVM;
542 RTCritSectEnter(&pUVM->pdm.s.ListCritSect);
543 PPDMASYNCCOMPLETIONTEMPLATE pTemplate = pUVM->pdm.s.pAsyncCompletionTemplates;
544 while (pTemplate)
545 {
546 if ( pTemplate->enmType == PDMASYNCCOMPLETIONTEMPLATETYPE_USB
547 && pTemplate->u.Usb.pUsbIns == pUsbIns)
548 {
549 PPDMASYNCCOMPLETIONTEMPLATE pTemplateDestroy = pTemplate;
550 pTemplate = pTemplate->pNext;
551 int rc = PDMR3AsyncCompletionTemplateDestroy(pTemplateDestroy);
552 if (RT_FAILURE(rc))
553 {
554 RTCritSectLeave(&pUVM->pdm.s.ListCritSect);
555 return rc;
556 }
557 }
558 else
559 pTemplate = pTemplate->pNext;
560 }
561
562 RTCritSectLeave(&pUVM->pdm.s.ListCritSect);
563 return VINF_SUCCESS;
564}
565
566
567static PPDMACBWMGR pdmacBwMgrFindById(PPDMASYNCCOMPLETIONEPCLASS pEpClass, const char *pcszId)
568{
569 PPDMACBWMGR pBwMgr = NULL;
570
571 if (RT_VALID_PTR(pcszId))
572 {
573 int rc = RTCritSectEnter(&pEpClass->CritSect); AssertRC(rc);
574
575 pBwMgr = pEpClass->pBwMgrsHead;
576 while ( pBwMgr
577 && RTStrCmp(pBwMgr->pszId, pcszId))
578 pBwMgr = pBwMgr->pNext;
579
580 rc = RTCritSectLeave(&pEpClass->CritSect); AssertRC(rc);
581 }
582
583 return pBwMgr;
584}
585
586static void pdmacBwMgrLink(PPDMACBWMGR pBwMgr)
587{
588 PPDMASYNCCOMPLETIONEPCLASS pEpClass = pBwMgr->pEpClass;
589 int rc = RTCritSectEnter(&pEpClass->CritSect); AssertRC(rc);
590
591 pBwMgr->pNext = pEpClass->pBwMgrsHead;
592 pEpClass->pBwMgrsHead = pBwMgr;
593
594 rc = RTCritSectLeave(&pEpClass->CritSect); AssertRC(rc);
595}
596
597static void pdmacBwMgrUnlink(PPDMACBWMGR pBwMgr)
598{
599 PPDMASYNCCOMPLETIONEPCLASS pEpClass = pBwMgr->pEpClass;
600 int rc = RTCritSectEnter(&pEpClass->CritSect); AssertRC(rc);
601
602 if (pBwMgr == pEpClass->pBwMgrsHead)
603 pEpClass->pBwMgrsHead = pBwMgr->pNext;
604 else
605 {
606 PPDMACBWMGR pPrev = pEpClass->pBwMgrsHead;
607 while ( pPrev
608 && pPrev->pNext != pBwMgr)
609 pPrev = pPrev->pNext;
610
611 AssertPtr(pPrev);
612 pPrev->pNext = pBwMgr->pNext;
613 }
614
615 rc = RTCritSectLeave(&pEpClass->CritSect); AssertRC(rc);
616}
617
618static int pdmacAsyncCompletionBwMgrCreate(PPDMASYNCCOMPLETIONEPCLASS pEpClass, const char *pcszBwMgr, uint32_t cbTransferPerSecMax,
619 uint32_t cbTransferPerSecStart, uint32_t cbTransferPerSecStep)
620{
621 LogFlowFunc(("pEpClass=%#p pcszBwMgr=%#p{%s} cbTransferPerSecMax=%u cbTransferPerSecStart=%u cbTransferPerSecStep=%u\n",
622 pEpClass, pcszBwMgr, cbTransferPerSecMax, cbTransferPerSecStart, cbTransferPerSecStep));
623
624 AssertPtrReturn(pEpClass, VERR_INVALID_POINTER);
625 AssertPtrReturn(pcszBwMgr, VERR_INVALID_POINTER);
626 AssertReturn(*pcszBwMgr != '\0', VERR_INVALID_PARAMETER);
627
628 int rc;
629 PPDMACBWMGR pBwMgr = pdmacBwMgrFindById(pEpClass, pcszBwMgr);
630 if (!pBwMgr)
631 {
632 rc = MMR3HeapAllocZEx(pEpClass->pVM, MM_TAG_PDM_ASYNC_COMPLETION,
633 sizeof(PDMACBWMGR),
634 (void **)&pBwMgr);
635 if (RT_SUCCESS(rc))
636 {
637 pBwMgr->pszId = RTStrDup(pcszBwMgr);
638 if (pBwMgr->pszId)
639 {
640 pBwMgr->pEpClass = pEpClass;
641 pBwMgr->cRefs = 0;
642
643 /* Init I/O flow control. */
644 pBwMgr->cbTransferPerSecMax = cbTransferPerSecMax;
645 pBwMgr->cbTransferPerSecStart = cbTransferPerSecStart;
646 pBwMgr->cbTransferPerSecStep = cbTransferPerSecStep;
647
648 pBwMgr->cbTransferAllowed = pBwMgr->cbTransferPerSecStart;
649 pBwMgr->tsUpdatedLast = RTTimeSystemNanoTS();
650
651 pdmacBwMgrLink(pBwMgr);
652 rc = VINF_SUCCESS;
653 }
654 else
655 {
656 rc = VERR_NO_MEMORY;
657 MMR3HeapFree(pBwMgr);
658 }
659 }
660 }
661 else
662 rc = VERR_ALREADY_EXISTS;
663
664 LogFlowFunc(("returns rc=%Rrc\n", rc));
665 return rc;
666}
667
668DECLINLINE(void) pdmacBwMgrRef(PPDMACBWMGR pBwMgr)
669{
670 ASMAtomicIncU32(&pBwMgr->cRefs);
671}
672
673DECLINLINE(void) pdmacBwMgrUnref(PPDMACBWMGR pBwMgr)
674{
675 Assert(pBwMgr->cRefs > 0);
676 ASMAtomicDecU32(&pBwMgr->cRefs);
677}
678
679bool pdmacEpIsTransferAllowed(PPDMASYNCCOMPLETIONENDPOINT pEndpoint, uint32_t cbTransfer, RTMSINTERVAL *pmsWhenNext)
680{
681 bool fAllowed = true;
682 PPDMACBWMGR pBwMgr = ASMAtomicReadPtrT(&pEndpoint->pBwMgr, PPDMACBWMGR);
683
684 LogFlowFunc(("pEndpoint=%p pBwMgr=%p cbTransfer=%u\n", pEndpoint, pBwMgr, cbTransfer));
685
686 if (pBwMgr)
687 {
688 uint32_t cbOld = ASMAtomicSubU32(&pBwMgr->cbTransferAllowed, cbTransfer);
689 if (RT_LIKELY(cbOld >= cbTransfer))
690 fAllowed = true;
691 else
692 {
693 fAllowed = false;
694
695 /* We are out of resources Check if we can update again. */
696 uint64_t tsNow = RTTimeSystemNanoTS();
697 uint64_t tsUpdatedLast = ASMAtomicUoReadU64(&pBwMgr->tsUpdatedLast);
698
699 if (tsNow - tsUpdatedLast >= (1000*1000*1000))
700 {
701 if (ASMAtomicCmpXchgU64(&pBwMgr->tsUpdatedLast, tsNow, tsUpdatedLast))
702 {
703 if (pBwMgr->cbTransferPerSecStart < pBwMgr->cbTransferPerSecMax)
704 {
705 pBwMgr->cbTransferPerSecStart = RT_MIN(pBwMgr->cbTransferPerSecMax, pBwMgr->cbTransferPerSecStart + pBwMgr->cbTransferPerSecStep);
706 LogFlow(("AIOMgr: Increasing maximum bandwidth to %u bytes/sec\n", pBwMgr->cbTransferPerSecStart));
707 }
708
709 /* Update */
710 ASMAtomicWriteU32(&pBwMgr->cbTransferAllowed, pBwMgr->cbTransferPerSecStart - cbTransfer);
711 fAllowed = true;
712 LogFlow(("AIOMgr: Refreshed bandwidth\n"));
713 }
714 }
715 else
716 {
717 ASMAtomicAddU32(&pBwMgr->cbTransferAllowed, cbTransfer);
718 *pmsWhenNext = ((1000*1000*1000) - (tsNow - tsUpdatedLast)) / (1000*1000);
719 }
720 }
721 }
722
723 LogFlowFunc(("fAllowed=%RTbool\n", fAllowed));
724 return fAllowed;
725}
726
727void pdmR3AsyncCompletionCompleteTask(PPDMASYNCCOMPLETIONTASK pTask, int rc, bool fCallCompletionHandler)
728{
729 LogFlow(("%s: pTask=%#p fCallCompletionHandler=%RTbool\n", __FUNCTION__, pTask, fCallCompletionHandler));
730
731 if (fCallCompletionHandler)
732 {
733 PPDMASYNCCOMPLETIONTEMPLATE pTemplate = pTask->pEndpoint->pTemplate;
734
735 switch (pTemplate->enmType)
736 {
737 case PDMASYNCCOMPLETIONTEMPLATETYPE_DEV:
738 pTemplate->u.Dev.pfnCompleted(pTemplate->u.Dev.pDevIns, pTask->pvUser, rc);
739 break;
740
741 case PDMASYNCCOMPLETIONTEMPLATETYPE_DRV:
742 pTemplate->u.Drv.pfnCompleted(pTemplate->u.Drv.pDrvIns, pTemplate->u.Drv.pvTemplateUser, pTask->pvUser, rc);
743 break;
744
745 case PDMASYNCCOMPLETIONTEMPLATETYPE_USB:
746 pTemplate->u.Usb.pfnCompleted(pTemplate->u.Usb.pUsbIns, pTask->pvUser, rc);
747 break;
748
749 case PDMASYNCCOMPLETIONTEMPLATETYPE_INTERNAL:
750 pTemplate->u.Int.pfnCompleted(pTemplate->pVM, pTask->pvUser, pTemplate->u.Int.pvUser, rc);
751 break;
752
753 default:
754 AssertMsgFailed(("Unknown template type!\n"));
755 }
756 }
757
758 pdmR3AsyncCompletionPutTask(pTask->pEndpoint, pTask);
759}
760
761/**
762 * Worker initializing a endpoint class.
763 *
764 * @returns VBox status code.
765 * @param pVM Pointer to the shared VM instance data.
766 * @param pEpClass Pointer to the endpoint class structure.
767 * @param pCfgHandle Pointer to the the CFGM tree.
768 */
769int pdmR3AsyncCompletionEpClassInit(PVM pVM, PCPDMASYNCCOMPLETIONEPCLASSOPS pEpClassOps, PCFGMNODE pCfgHandle)
770{
771 /* Validate input. */
772 AssertPtrReturn(pEpClassOps, VERR_INVALID_POINTER);
773 AssertReturn(pEpClassOps->u32Version == PDMAC_EPCLASS_OPS_VERSION, VERR_VERSION_MISMATCH);
774 AssertReturn(pEpClassOps->u32VersionEnd == PDMAC_EPCLASS_OPS_VERSION, VERR_VERSION_MISMATCH);
775
776 LogFlowFunc((": pVM=%p pEpClassOps=%p{%s}\n", pVM, pEpClassOps, pEpClassOps->pcszName));
777
778 /* Allocate global class data. */
779 PPDMASYNCCOMPLETIONEPCLASS pEndpointClass = NULL;
780
781 int rc = MMR3HeapAllocZEx(pVM, MM_TAG_PDM_ASYNC_COMPLETION,
782 pEpClassOps->cbEndpointClassGlobal,
783 (void **)&pEndpointClass);
784 if (RT_SUCCESS(rc))
785 {
786 /* Initialize common data. */
787 pEndpointClass->pVM = pVM;
788 pEndpointClass->pEndpointOps = pEpClassOps;
789
790 rc = RTCritSectInit(&pEndpointClass->CritSect);
791 if (RT_SUCCESS(rc))
792 {
793 PCFGMNODE pCfgNodeClass = CFGMR3GetChild(pCfgHandle, pEpClassOps->pcszName);
794
795 /* Create task cache */
796 rc = RTMemCacheCreate(&pEndpointClass->hMemCacheTasks, pEpClassOps->cbTask,
797 0, UINT32_MAX, NULL, NULL, NULL, 0);
798 if (RT_SUCCESS(rc))
799 {
800 /* Call the specific endpoint class initializer. */
801 rc = pEpClassOps->pfnInitialize(pEndpointClass, pCfgNodeClass);
802 if (RT_SUCCESS(rc))
803 {
804 /* Create all bandwidth groups for resource control. */
805 PCFGMNODE pCfgBwGrp = CFGMR3GetChild(pCfgNodeClass, "BwGroups");
806
807 if (pCfgBwGrp)
808 {
809 for (PCFGMNODE pCur = CFGMR3GetFirstChild(pCfgBwGrp); pCur; pCur = CFGMR3GetNextChild(pCur))
810 {
811 uint32_t cbMax, cbStart, cbStep;
812 size_t cchName = CFGMR3GetNameLen(pCur) + 1;
813 char *pszBwGrpId = (char *)RTMemAllocZ(cchName);
814
815 if (!pszBwGrpId)
816 {
817 rc = VERR_NO_MEMORY;
818 break;
819 }
820
821 rc = CFGMR3GetName(pCur, pszBwGrpId, cchName);
822 AssertRC(rc);
823
824 if (RT_SUCCESS(rc))
825 rc = CFGMR3QueryU32(pCur, "Max", &cbMax);
826 if (RT_SUCCESS(rc))
827 rc = CFGMR3QueryU32Def(pCur, "Start", &cbStart, cbMax);
828 if (RT_SUCCESS(rc))
829 rc = CFGMR3QueryU32Def(pCur, "Step", &cbStep, 0);
830 if (RT_SUCCESS(rc))
831 rc = pdmacAsyncCompletionBwMgrCreate(pEndpointClass, pszBwGrpId, cbMax, cbStart, cbStep);
832
833 RTMemFree(pszBwGrpId);
834
835 if (RT_FAILURE(rc))
836 break;
837 }
838 }
839
840 if (RT_SUCCESS(rc))
841 {
842 PUVM pUVM = pVM->pUVM;
843 AssertMsg(!pUVM->pdm.s.apAsyncCompletionEndpointClass[pEpClassOps->enmClassType],
844 ("Endpoint class was already initialized\n"));
845
846 pUVM->pdm.s.apAsyncCompletionEndpointClass[pEpClassOps->enmClassType] = pEndpointClass;
847 LogFlowFunc((": Initialized endpoint class \"%s\" rc=%Rrc\n", pEpClassOps->pcszName, rc));
848 return VINF_SUCCESS;
849 }
850 }
851 RTMemCacheDestroy(pEndpointClass->hMemCacheTasks);
852 }
853 RTCritSectDelete(&pEndpointClass->CritSect);
854 }
855 MMR3HeapFree(pEndpointClass);
856 }
857
858 LogFlowFunc((": Failed to initialize endpoint class rc=%Rrc\n", rc));
859
860 return rc;
861}
862
863/**
864 * Worker terminating all endpoint classes.
865 *
866 * @returns nothing
867 * @param pEndpointClass Pointer to the endpoint class to terminate.
868 *
869 * @remarks This method ensures that any still open endpoint is closed.
870 */
871static void pdmR3AsyncCompletionEpClassTerminate(PPDMASYNCCOMPLETIONEPCLASS pEndpointClass)
872{
873 PVM pVM = pEndpointClass->pVM;
874
875 /* Close all still open endpoints. */
876 while (pEndpointClass->pEndpointsHead)
877 PDMR3AsyncCompletionEpClose(pEndpointClass->pEndpointsHead);
878
879 /* Destroy the bandwidth managers. */
880 PPDMACBWMGR pBwMgr = pEndpointClass->pBwMgrsHead;
881 while (pBwMgr)
882 {
883 PPDMACBWMGR pFree = pBwMgr;
884 pBwMgr = pBwMgr->pNext;
885 MMR3HeapFree(pFree);
886 }
887
888 /* Call the termination callback of the class. */
889 pEndpointClass->pEndpointOps->pfnTerminate(pEndpointClass);
890
891 RTMemCacheDestroy(pEndpointClass->hMemCacheTasks);
892 RTCritSectDelete(&pEndpointClass->CritSect);
893
894 /* Free the memory of the class finally and clear the entry in the class array. */
895 pVM->pUVM->pdm.s.apAsyncCompletionEndpointClass[pEndpointClass->pEndpointOps->enmClassType] = NULL;
896 MMR3HeapFree(pEndpointClass);
897}
898
899/**
900 * Initialize the async completion manager.
901 *
902 * @returns VBox status code
903 * @param pVM Pointer to the shared VM structure.
904 */
905int pdmR3AsyncCompletionInit(PVM pVM)
906{
907 LogFlowFunc((": pVM=%p\n", pVM));
908
909 VM_ASSERT_EMT(pVM);
910
911 PCFGMNODE pCfgRoot = CFGMR3GetRoot(pVM);
912 PCFGMNODE pCfgAsyncCompletion = CFGMR3GetChild(CFGMR3GetChild(pCfgRoot, "PDM"), "AsyncCompletion");
913
914 int rc = pdmR3AsyncCompletionEpClassInit(pVM, &g_PDMAsyncCompletionEndpointClassFile, pCfgAsyncCompletion);
915 LogFlowFunc((": pVM=%p rc=%Rrc\n", pVM, rc));
916 return rc;
917}
918
919/**
920 * Terminates the async completion manager.
921 *
922 * @returns VBox status code
923 * @param pVM Pointer to the shared VM structure.
924 */
925int pdmR3AsyncCompletionTerm(PVM pVM)
926{
927 LogFlowFunc((": pVM=%p\n", pVM));
928 PUVM pUVM = pVM->pUVM;
929
930 for (size_t i = 0; i < RT_ELEMENTS(pUVM->pdm.s.apAsyncCompletionEndpointClass); i++)
931 if (pUVM->pdm.s.apAsyncCompletionEndpointClass[i])
932 pdmR3AsyncCompletionEpClassTerminate(pUVM->pdm.s.apAsyncCompletionEndpointClass[i]);
933
934 return VINF_SUCCESS;
935}
936
937/**
938 * Resume worker for the async completion manager.
939 *
940 * @returns nothing.
941 * @param pVM Pointer to the shared VM structure.
942 */
943void pdmR3AsyncCompletionResume(PVM pVM)
944{
945 LogFlowFunc((": pVM=%p\n", pVM));
946 PUVM pUVM = pVM->pUVM;
947
948 /* Log the bandwidth groups and all assigned endpoints. */
949 for (size_t i = 0; i < RT_ELEMENTS(pUVM->pdm.s.apAsyncCompletionEndpointClass); i++)
950 if (pUVM->pdm.s.apAsyncCompletionEndpointClass[i])
951 {
952 PPDMASYNCCOMPLETIONEPCLASS pEpClass = pUVM->pdm.s.apAsyncCompletionEndpointClass[i];
953 PPDMACBWMGR pBwMgr = pEpClass->pBwMgrsHead;
954 PPDMASYNCCOMPLETIONENDPOINT pEp;
955
956 if (pBwMgr)
957 LogRel(("AIOMgr: Bandwidth groups for class '%s'\n", i == PDMASYNCCOMPLETIONEPCLASSTYPE_FILE
958 ? "File" : "<Unknown>"));
959
960 while (pBwMgr)
961 {
962 LogRel(("AIOMgr: Id: %s\n", pBwMgr->pszId));
963 LogRel(("AIOMgr: Max: %u B/s\n", pBwMgr->cbTransferPerSecMax));
964 LogRel(("AIOMgr: Start: %u B/s\n", pBwMgr->cbTransferPerSecStart));
965 LogRel(("AIOMgr: Step: %u B/s\n", pBwMgr->cbTransferPerSecStep));
966 LogRel(("AIOMgr: Endpoints:\n"));
967
968 pEp = pEpClass->pEndpointsHead;
969 while (pEp)
970 {
971 if (pEp->pBwMgr == pBwMgr)
972 LogRel(("AIOMgr: %s\n", pEp->pszUri));
973
974 pEp = pEp->pNext;
975 }
976
977 pBwMgr = pBwMgr->pNext;
978 }
979
980 /* Print all endpoints without assigned bandwidth groups. */
981 pEp = pEpClass->pEndpointsHead;
982 if (pEp)
983 LogRel(("AIOMgr: Endpoints without assigned bandwidth groups:\n"));
984
985 while (pEp)
986 {
987 if (!pEp->pBwMgr)
988 LogRel(("AIOMgr: %s\n", pEp->pszUri));
989
990 pEp = pEp->pNext;
991 }
992 }
993}
994
995/**
996 * Tries to get a free task from the endpoint or class cache
997 * allocating the task if it fails.
998 *
999 * @returns Pointer to a new and initialized task or NULL
1000 * @param pEndpoint The endpoint the task is for.
1001 * @param pvUser Opaque user data for the task.
1002 */
1003static PPDMASYNCCOMPLETIONTASK pdmR3AsyncCompletionGetTask(PPDMASYNCCOMPLETIONENDPOINT pEndpoint, void *pvUser)
1004{
1005 PPDMASYNCCOMPLETIONEPCLASS pEndpointClass = pEndpoint->pEpClass;
1006 PPDMASYNCCOMPLETIONTASK pTask = (PPDMASYNCCOMPLETIONTASK)RTMemCacheAlloc(pEndpointClass->hMemCacheTasks);
1007 if (RT_LIKELY(pTask))
1008 {
1009 /* Initialize common parts. */
1010 pTask->pvUser = pvUser;
1011 pTask->pEndpoint = pEndpoint;
1012 /* Clear list pointers for safety. */
1013 pTask->pPrev = NULL;
1014 pTask->pNext = NULL;
1015 pTask->tsNsStart = RTTimeNanoTS();
1016#ifdef VBOX_WITH_STATISTICS
1017 STAM_COUNTER_INC(&pEndpoint->StatIoOpsStarted);
1018#endif
1019 }
1020
1021 return pTask;
1022}
1023
1024/**
1025 * Puts a task in one of the caches.
1026 *
1027 * @returns nothing.
1028 * @param pEndpoint The endpoint the task belongs to.
1029 * @param pTask The task to cache.
1030 */
1031static void pdmR3AsyncCompletionPutTask(PPDMASYNCCOMPLETIONENDPOINT pEndpoint, PPDMASYNCCOMPLETIONTASK pTask)
1032{
1033 PPDMASYNCCOMPLETIONEPCLASS pEndpointClass = pEndpoint->pEpClass;
1034 uint64_t cNsRun = RTTimeNanoTS() - pTask->tsNsStart;
1035
1036 if (RT_UNLIKELY(cNsRun >= RT_NS_10SEC))
1037 LogRel(("AsyncCompletion: Task %#p completed after %llu seconds\n", pTask, cNsRun / RT_NS_1SEC));
1038
1039#ifdef VBOX_WITH_STATISTICS
1040 PSTAMCOUNTER pStatCounter;
1041 if (cNsRun < RT_NS_1US)
1042 pStatCounter = &pEndpoint->StatTaskRunTimesNs[cNsRun / (RT_NS_1US / 10)];
1043 else if (cNsRun < RT_NS_1MS)
1044 pStatCounter = &pEndpoint->StatTaskRunTimesUs[cNsRun / (RT_NS_1MS / 10)];
1045 else if (cNsRun < RT_NS_1SEC)
1046 pStatCounter = &pEndpoint->StatTaskRunTimesMs[cNsRun / (RT_NS_1SEC / 10)];
1047 else if (cNsRun < RT_NS_1SEC_64*100)
1048 pStatCounter = &pEndpoint->StatTaskRunTimesSec[cNsRun / (RT_NS_1SEC_64*100 / 10)];
1049 else
1050 pStatCounter = &pEndpoint->StatTaskRunOver100Sec;
1051 STAM_COUNTER_INC(pStatCounter);
1052
1053 STAM_COUNTER_INC(&pEndpoint->StatIoOpsCompleted);
1054 pEndpoint->cIoOpsCompleted++;
1055 uint64_t tsMsCur = RTTimeMilliTS();
1056 uint64_t tsInterval = tsMsCur - pEndpoint->tsIntervalStartMs;
1057 if (tsInterval >= 1000)
1058 {
1059 pEndpoint->StatIoOpsPerSec.c = pEndpoint->cIoOpsCompleted / (tsInterval / 1000);
1060 pEndpoint->tsIntervalStartMs = tsMsCur;
1061 pEndpoint->cIoOpsCompleted = 0;
1062 }
1063#endif /* VBOX_WITH_STATISTICS */
1064
1065 RTMemCacheFree(pEndpointClass->hMemCacheTasks, pTask);
1066}
1067
1068static PPDMASYNCCOMPLETIONENDPOINT pdmR3AsyncCompletionFindEndpointWithUri(PPDMASYNCCOMPLETIONEPCLASS pEndpointClass,
1069 const char *pszUri)
1070{
1071 PPDMASYNCCOMPLETIONENDPOINT pEndpoint = pEndpointClass->pEndpointsHead;
1072
1073 while (pEndpoint)
1074 {
1075 if (!RTStrCmp(pEndpoint->pszUri, pszUri))
1076 return pEndpoint;
1077
1078 pEndpoint = pEndpoint->pNext;
1079 }
1080
1081 return NULL;
1082}
1083
1084VMMR3DECL(int) PDMR3AsyncCompletionEpCreateForFile(PPPDMASYNCCOMPLETIONENDPOINT ppEndpoint,
1085 const char *pszFilename, uint32_t fFlags,
1086 PPDMASYNCCOMPLETIONTEMPLATE pTemplate)
1087{
1088 LogFlowFunc((": ppEndpoint=%p pszFilename=%p{%s} fFlags=%u pTemplate=%p\n",
1089 ppEndpoint, pszFilename, pszFilename, fFlags, pTemplate));
1090
1091 /* Sanity checks. */
1092 AssertPtrReturn(ppEndpoint, VERR_INVALID_POINTER);
1093 AssertPtrReturn(pszFilename, VERR_INVALID_POINTER);
1094 AssertPtrReturn(pTemplate, VERR_INVALID_POINTER);
1095
1096 /* Check that the flags are valid. */
1097 AssertReturn(((~(PDMACEP_FILE_FLAGS_READ_ONLY | PDMACEP_FILE_FLAGS_DONT_LOCK | PDMACEP_FILE_FLAGS_HOST_CACHE_ENABLED) & fFlags) == 0),
1098 VERR_INVALID_PARAMETER);
1099
1100 PVM pVM = pTemplate->pVM;
1101 PUVM pUVM = pVM->pUVM;
1102 PPDMASYNCCOMPLETIONEPCLASS pEndpointClass = pUVM->pdm.s.apAsyncCompletionEndpointClass[PDMASYNCCOMPLETIONEPCLASSTYPE_FILE];
1103 PPDMASYNCCOMPLETIONENDPOINT pEndpoint = NULL;
1104
1105 AssertMsg(pEndpointClass, ("File endpoint class was not initialized\n"));
1106
1107 /* Search for a already opened endpoint for this file. */
1108 pEndpoint = pdmR3AsyncCompletionFindEndpointWithUri(pEndpointClass, pszFilename);
1109 if (pEndpoint)
1110 {
1111 /* Endpoint found. */
1112 pEndpoint->cUsers++;
1113
1114 *ppEndpoint = pEndpoint;
1115 return VINF_SUCCESS;
1116 }
1117
1118 /* Create an endpoint. */
1119 int rc = MMR3HeapAllocZEx(pVM, MM_TAG_PDM_ASYNC_COMPLETION,
1120 pEndpointClass->pEndpointOps->cbEndpoint,
1121 (void **)&pEndpoint);
1122 if (RT_SUCCESS(rc))
1123 {
1124
1125 /* Initialize common parts. */
1126 pEndpoint->pNext = NULL;
1127 pEndpoint->pPrev = NULL;
1128 pEndpoint->pEpClass = pEndpointClass;
1129 pEndpoint->pTemplate = pTemplate;
1130 pEndpoint->pszUri = RTStrDup(pszFilename);
1131 pEndpoint->cUsers = 1;
1132 pEndpoint->pBwMgr = NULL;
1133
1134 if ( pEndpoint->pszUri
1135 && RT_SUCCESS(rc))
1136 {
1137 /* Call the initializer for the endpoint. */
1138 rc = pEndpointClass->pEndpointOps->pfnEpInitialize(pEndpoint, pszFilename, fFlags);
1139 if (RT_SUCCESS(rc))
1140 {
1141 /* Link it into the list of endpoints. */
1142 rc = RTCritSectEnter(&pEndpointClass->CritSect);
1143 AssertMsg(RT_SUCCESS(rc), ("Failed to enter critical section rc=%Rrc\n", rc));
1144
1145 pEndpoint->pNext = pEndpointClass->pEndpointsHead;
1146 if (pEndpointClass->pEndpointsHead)
1147 pEndpointClass->pEndpointsHead->pPrev = pEndpoint;
1148
1149 pEndpointClass->pEndpointsHead = pEndpoint;
1150 pEndpointClass->cEndpoints++;
1151
1152 rc = RTCritSectLeave(&pEndpointClass->CritSect);
1153 AssertMsg(RT_SUCCESS(rc), ("Failed to enter critical section rc=%Rrc\n", rc));
1154
1155 /* Reference the template. */
1156 ASMAtomicIncU32(&pTemplate->cUsed);
1157
1158#ifdef VBOX_WITH_STATISTICS
1159 /* Init the statistics part */
1160 for (unsigned i = 0; i < RT_ELEMENTS(pEndpoint->StatTaskRunTimesNs); i++)
1161 {
1162 rc = STAMR3RegisterF(pVM, &pEndpoint->StatTaskRunTimesNs[i], STAMTYPE_COUNTER,
1163 STAMVISIBILITY_USED,
1164 STAMUNIT_OCCURENCES,
1165 "Nanosecond resolution runtime statistics",
1166 "/PDM/AsyncCompletion/File/%s/TaskRun1Ns-%u-%u",
1167 RTPathFilename(pEndpoint->pszUri),
1168 i*100, i*100+100-1);
1169 if (RT_FAILURE(rc))
1170 break;
1171 }
1172
1173 if (RT_SUCCESS(rc))
1174 {
1175 for (unsigned i = 0; i < RT_ELEMENTS(pEndpoint->StatTaskRunTimesUs); i++)
1176 {
1177 rc = STAMR3RegisterF(pVM, &pEndpoint->StatTaskRunTimesUs[i], STAMTYPE_COUNTER,
1178 STAMVISIBILITY_USED,
1179 STAMUNIT_OCCURENCES,
1180 "Microsecond resolution runtime statistics",
1181 "/PDM/AsyncCompletion/File/%s/TaskRun2MicroSec-%u-%u",
1182 RTPathFilename(pEndpoint->pszUri),
1183 i*100, i*100+100-1);
1184 if (RT_FAILURE(rc))
1185 break;
1186 }
1187 }
1188
1189 if (RT_SUCCESS(rc))
1190 {
1191 for (unsigned i = 0; i < RT_ELEMENTS(pEndpoint->StatTaskRunTimesMs); i++)
1192 {
1193 rc = STAMR3RegisterF(pVM, &pEndpoint->StatTaskRunTimesMs[i], STAMTYPE_COUNTER,
1194 STAMVISIBILITY_USED,
1195 STAMUNIT_OCCURENCES,
1196 "Milliseconds resolution runtime statistics",
1197 "/PDM/AsyncCompletion/File/%s/TaskRun3Ms-%u-%u",
1198 RTPathFilename(pEndpoint->pszUri),
1199 i*100, i*100+100-1);
1200 if (RT_FAILURE(rc))
1201 break;
1202 }
1203 }
1204
1205 if (RT_SUCCESS(rc))
1206 {
1207 for (unsigned i = 0; i < RT_ELEMENTS(pEndpoint->StatTaskRunTimesMs); i++)
1208 {
1209 rc = STAMR3RegisterF(pVM, &pEndpoint->StatTaskRunTimesSec[i], STAMTYPE_COUNTER,
1210 STAMVISIBILITY_USED,
1211 STAMUNIT_OCCURENCES,
1212 "Second resolution runtime statistics",
1213 "/PDM/AsyncCompletion/File/%s/TaskRun4Sec-%u-%u",
1214 RTPathFilename(pEndpoint->pszUri),
1215 i*10, i*10+10-1);
1216 if (RT_FAILURE(rc))
1217 break;
1218 }
1219 }
1220
1221 if (RT_SUCCESS(rc))
1222 {
1223 rc = STAMR3RegisterF(pVM, &pEndpoint->StatTaskRunOver100Sec, STAMTYPE_COUNTER,
1224 STAMVISIBILITY_USED,
1225 STAMUNIT_OCCURENCES,
1226 "Tasks which ran more than 100sec",
1227 "/PDM/AsyncCompletion/File/%s/TaskRunSecGreater100Sec",
1228 RTPathFilename(pEndpoint->pszUri));
1229 }
1230
1231 if (RT_SUCCESS(rc))
1232 {
1233 rc = STAMR3RegisterF(pVM, &pEndpoint->StatIoOpsPerSec, STAMTYPE_COUNTER,
1234 STAMVISIBILITY_ALWAYS,
1235 STAMUNIT_OCCURENCES,
1236 "Processed I/O operations per second",
1237 "/PDM/AsyncCompletion/File/%s/IoOpsPerSec",
1238 RTPathFilename(pEndpoint->pszUri));
1239 }
1240
1241 if (RT_SUCCESS(rc))
1242 {
1243 rc = STAMR3RegisterF(pVM, &pEndpoint->StatIoOpsStarted, STAMTYPE_COUNTER,
1244 STAMVISIBILITY_ALWAYS,
1245 STAMUNIT_OCCURENCES,
1246 "Started I/O operations for this endpoint",
1247 "/PDM/AsyncCompletion/File/%s/IoOpsStarted",
1248 RTPathFilename(pEndpoint->pszUri));
1249 }
1250
1251 if (RT_SUCCESS(rc))
1252 {
1253 rc = STAMR3RegisterF(pVM, &pEndpoint->StatIoOpsCompleted, STAMTYPE_COUNTER,
1254 STAMVISIBILITY_ALWAYS,
1255 STAMUNIT_OCCURENCES,
1256 "Completed I/O operations for this endpoint",
1257 "/PDM/AsyncCompletion/File/%s/IoOpsCompleted",
1258 RTPathFilename(pEndpoint->pszUri));
1259 }
1260 /** @todo why bother maintaing rc when it's just ignored /
1261 logged and not returned? */
1262
1263 pEndpoint->tsIntervalStartMs = RTTimeMilliTS();
1264#endif
1265
1266 *ppEndpoint = pEndpoint;
1267
1268 LogFlowFunc((": Created endpoint for %s: rc=%Rrc\n", pszFilename, rc));
1269 return VINF_SUCCESS;
1270 }
1271 RTStrFree(pEndpoint->pszUri);
1272 }
1273 MMR3HeapFree(pEndpoint);
1274 }
1275
1276 LogFlowFunc((": Creation of endpoint for %s failed: rc=%Rrc\n", pszFilename, rc));
1277 return rc;
1278}
1279
1280VMMR3DECL(void) PDMR3AsyncCompletionEpClose(PPDMASYNCCOMPLETIONENDPOINT pEndpoint)
1281{
1282 LogFlowFunc((": pEndpoint=%p\n", pEndpoint));
1283
1284 /* Sanity checks. */
1285 AssertReturnVoid(VALID_PTR(pEndpoint));
1286
1287 pEndpoint->cUsers--;
1288
1289 /* If the last user closed the endpoint we will free it. */
1290 if (!pEndpoint->cUsers)
1291 {
1292 PPDMASYNCCOMPLETIONEPCLASS pEndpointClass = pEndpoint->pEpClass;
1293 pEndpointClass->pEndpointOps->pfnEpClose(pEndpoint);
1294
1295 /* Drop reference from the template. */
1296 ASMAtomicDecU32(&pEndpoint->pTemplate->cUsed);
1297
1298 /* Unlink the endpoint from the list. */
1299 int rc = RTCritSectEnter(&pEndpointClass->CritSect);
1300 AssertMsg(RT_SUCCESS(rc), ("Failed to enter critical section rc=%Rrc\n", rc));
1301
1302 PPDMASYNCCOMPLETIONENDPOINT pEndpointNext = pEndpoint->pNext;
1303 PPDMASYNCCOMPLETIONENDPOINT pEndpointPrev = pEndpoint->pPrev;
1304
1305 if (pEndpointPrev)
1306 pEndpointPrev->pNext = pEndpointNext;
1307 else
1308 pEndpointClass->pEndpointsHead = pEndpointNext;
1309 if (pEndpointNext)
1310 pEndpointNext->pPrev = pEndpointPrev;
1311
1312 pEndpointClass->cEndpoints--;
1313
1314 rc = RTCritSectLeave(&pEndpointClass->CritSect);
1315 AssertMsg(RT_SUCCESS(rc), ("Failed to enter critical section rc=%Rrc\n", rc));
1316
1317#ifdef VBOX_WITH_STATISTICS
1318 /* Deregister the statistics part */
1319 PVM pVM = pEndpointClass->pVM;
1320
1321 for (unsigned i = 0; i < RT_ELEMENTS(pEndpoint->StatTaskRunTimesNs); i++)
1322 STAMR3Deregister(pVM, &pEndpoint->StatTaskRunTimesNs[i]);
1323 for (unsigned i = 0; i < RT_ELEMENTS(pEndpoint->StatTaskRunTimesUs); i++)
1324 STAMR3Deregister(pVM, &pEndpoint->StatTaskRunTimesUs[i]);
1325 for (unsigned i = 0; i < RT_ELEMENTS(pEndpoint->StatTaskRunTimesMs); i++)
1326 STAMR3Deregister(pVM, &pEndpoint->StatTaskRunTimesMs[i]);
1327 for (unsigned i = 0; i < RT_ELEMENTS(pEndpoint->StatTaskRunTimesMs); i++)
1328 STAMR3Deregister(pVM, &pEndpoint->StatTaskRunTimesSec[i]);
1329
1330 STAMR3Deregister(pVM, &pEndpoint->StatTaskRunOver100Sec);
1331 STAMR3Deregister(pVM, &pEndpoint->StatIoOpsPerSec);
1332 STAMR3Deregister(pVM, &pEndpoint->StatIoOpsStarted);
1333 STAMR3Deregister(pVM, &pEndpoint->StatIoOpsCompleted);
1334#endif
1335
1336 RTStrFree(pEndpoint->pszUri);
1337 MMR3HeapFree(pEndpoint);
1338 }
1339}
1340
1341VMMR3DECL(int) PDMR3AsyncCompletionEpRead(PPDMASYNCCOMPLETIONENDPOINT pEndpoint, RTFOFF off,
1342 PCRTSGSEG paSegments, unsigned cSegments,
1343 size_t cbRead, void *pvUser,
1344 PPPDMASYNCCOMPLETIONTASK ppTask)
1345{
1346 AssertPtrReturn(pEndpoint, VERR_INVALID_POINTER);
1347 AssertPtrReturn(paSegments, VERR_INVALID_POINTER);
1348 AssertPtrReturn(ppTask, VERR_INVALID_POINTER);
1349 AssertReturn(cSegments > 0, VERR_INVALID_PARAMETER);
1350 AssertReturn(cbRead > 0, VERR_INVALID_PARAMETER);
1351 AssertReturn(off >= 0, VERR_INVALID_PARAMETER);
1352
1353 PPDMASYNCCOMPLETIONTASK pTask;
1354
1355 pTask = pdmR3AsyncCompletionGetTask(pEndpoint, pvUser);
1356 if (!pTask)
1357 return VERR_NO_MEMORY;
1358
1359 int rc = pEndpoint->pEpClass->pEndpointOps->pfnEpRead(pTask, pEndpoint, off,
1360 paSegments, cSegments, cbRead);
1361 if (RT_SUCCESS(rc))
1362 *ppTask = pTask;
1363 else
1364 pdmR3AsyncCompletionPutTask(pEndpoint, pTask);
1365
1366 return rc;
1367}
1368
1369VMMR3DECL(int) PDMR3AsyncCompletionEpWrite(PPDMASYNCCOMPLETIONENDPOINT pEndpoint, RTFOFF off,
1370 PCRTSGSEG paSegments, unsigned cSegments,
1371 size_t cbWrite, void *pvUser,
1372 PPPDMASYNCCOMPLETIONTASK ppTask)
1373{
1374 AssertPtrReturn(pEndpoint, VERR_INVALID_POINTER);
1375 AssertPtrReturn(paSegments, VERR_INVALID_POINTER);
1376 AssertPtrReturn(ppTask, VERR_INVALID_POINTER);
1377 AssertReturn(cSegments > 0, VERR_INVALID_PARAMETER);
1378 AssertReturn(cbWrite > 0, VERR_INVALID_PARAMETER);
1379 AssertReturn(off >= 0, VERR_INVALID_PARAMETER);
1380
1381 PPDMASYNCCOMPLETIONTASK pTask;
1382
1383 pTask = pdmR3AsyncCompletionGetTask(pEndpoint, pvUser);
1384 if (!pTask)
1385 return VERR_NO_MEMORY;
1386
1387 int rc = pEndpoint->pEpClass->pEndpointOps->pfnEpWrite(pTask, pEndpoint, off,
1388 paSegments, cSegments, cbWrite);
1389 if (RT_SUCCESS(rc))
1390 {
1391 *ppTask = pTask;
1392 }
1393 else
1394 pdmR3AsyncCompletionPutTask(pEndpoint, pTask);
1395
1396 return rc;
1397}
1398
1399VMMR3DECL(int) PDMR3AsyncCompletionEpFlush(PPDMASYNCCOMPLETIONENDPOINT pEndpoint,
1400 void *pvUser,
1401 PPPDMASYNCCOMPLETIONTASK ppTask)
1402{
1403 AssertPtrReturn(pEndpoint, VERR_INVALID_POINTER);
1404 AssertPtrReturn(ppTask, VERR_INVALID_POINTER);
1405
1406 PPDMASYNCCOMPLETIONTASK pTask;
1407
1408 pTask = pdmR3AsyncCompletionGetTask(pEndpoint, pvUser);
1409 if (!pTask)
1410 return VERR_NO_MEMORY;
1411
1412 int rc = pEndpoint->pEpClass->pEndpointOps->pfnEpFlush(pTask, pEndpoint);
1413 if (RT_SUCCESS(rc))
1414 *ppTask = pTask;
1415 else
1416 pdmR3AsyncCompletionPutTask(pEndpoint, pTask);
1417
1418 return rc;
1419}
1420
1421VMMR3DECL(int) PDMR3AsyncCompletionEpGetSize(PPDMASYNCCOMPLETIONENDPOINT pEndpoint,
1422 uint64_t *pcbSize)
1423{
1424 AssertPtrReturn(pEndpoint, VERR_INVALID_POINTER);
1425 AssertPtrReturn(pcbSize, VERR_INVALID_POINTER);
1426
1427 if (pEndpoint->pEpClass->pEndpointOps->pfnEpGetSize)
1428 return pEndpoint->pEpClass->pEndpointOps->pfnEpGetSize(pEndpoint, pcbSize);
1429 return VERR_NOT_SUPPORTED;
1430}
1431
1432VMMR3DECL(int) PDMR3AsyncCompletionEpSetSize(PPDMASYNCCOMPLETIONENDPOINT pEndpoint,
1433 uint64_t cbSize)
1434{
1435 AssertPtrReturn(pEndpoint, VERR_INVALID_POINTER);
1436
1437 if (pEndpoint->pEpClass->pEndpointOps->pfnEpSetSize)
1438 return pEndpoint->pEpClass->pEndpointOps->pfnEpSetSize(pEndpoint, cbSize);
1439 return VERR_NOT_SUPPORTED;
1440}
1441
1442VMMR3DECL(int) PDMR3AsyncCompletionEpSetBwMgr(PPDMASYNCCOMPLETIONENDPOINT pEndpoint,
1443 const char *pcszBwMgr)
1444{
1445 AssertPtrReturn(pEndpoint, VERR_INVALID_POINTER);
1446 PPDMACBWMGR pBwMgrOld = NULL;
1447 PPDMACBWMGR pBwMgrNew = NULL;
1448
1449 int rc = VINF_SUCCESS;
1450 if (pcszBwMgr)
1451 {
1452 pBwMgrNew = pdmacBwMgrFindById(pEndpoint->pEpClass, pcszBwMgr);
1453 if (pBwMgrNew)
1454 pdmacBwMgrRef(pBwMgrNew);
1455 else
1456 rc = VERR_NOT_FOUND;
1457 }
1458
1459 if (RT_SUCCESS(rc))
1460 {
1461 pBwMgrOld = ASMAtomicXchgPtrT(&pEndpoint->pBwMgr, pBwMgrNew, PPDMACBWMGR);
1462 if (pBwMgrOld)
1463 pdmacBwMgrUnref(pBwMgrOld);
1464 }
1465
1466 return rc;
1467}
1468
1469VMMR3DECL(int) PDMR3AsyncCompletionTaskCancel(PPDMASYNCCOMPLETIONTASK pTask)
1470{
1471 return VERR_NOT_IMPLEMENTED;
1472}
1473
1474VMMR3DECL(int) PDMR3AsyncCompletionBwMgrSetMaxForFile(PVM pVM, const char *pcszBwMgr, uint32_t cbMaxNew)
1475{
1476 AssertPtrReturn(pVM, VERR_INVALID_POINTER);
1477 AssertPtrReturn(pcszBwMgr, VERR_INVALID_POINTER);
1478
1479 int rc = VINF_SUCCESS;
1480 PPDMASYNCCOMPLETIONEPCLASS pEpClass = pVM->pUVM->pdm.s.apAsyncCompletionEndpointClass[PDMASYNCCOMPLETIONEPCLASSTYPE_FILE];
1481 PPDMACBWMGR pBwMgr = pdmacBwMgrFindById(pEpClass, pcszBwMgr);
1482 if (pBwMgr)
1483 {
1484 /*
1485 * Set the new value for the start and max value to let the manager pick up
1486 * the new limit immediately.
1487 */
1488 ASMAtomicXchgU32(&pBwMgr->cbTransferPerSecMax, cbMaxNew);
1489 ASMAtomicXchgU32(&pBwMgr->cbTransferPerSecStart, cbMaxNew);
1490 }
1491 else
1492 rc = VERR_NOT_FOUND;
1493
1494 return rc;
1495}
1496
Note: See TracBrowser for help on using the repository browser.

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