078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync/** $Id$ */
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync/** @file
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync *
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync * VBox HDD container test utility, async I/O memory backend
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync */
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync/*
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync * Copyright (C) 2011 Oracle Corporation
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync *
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync * available from http://www.virtualbox.org. This file is free software;
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync * you can redistribute it and/or modify it under the terms of the GNU
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync * General Public License (GPL) as published by the Free Software
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync */
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync#ifndef __VDIoBackendMem_h__
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync#define __VDIoBackendMem_h__
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync#include <iprt/sg.h>
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync
14a9673ef19f6d8d49f83050d86cb444a55d4008vboxsync#include "VDDefs.h"
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync/** Memory backend handle. */
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsynctypedef struct VDIOBACKENDMEM *PVDIOBACKENDMEM;
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync/** Pointer to a memory backend handle. */
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsynctypedef PVDIOBACKENDMEM *PPVDIOBACKENDMEM;
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync/**
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync * Completion handler.
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync *
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync * @returns nothing.
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync * @param pvUser Opaque user data.
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync * @param rcReq Completion code for the request.
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync */
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsynctypedef DECLCALLBACK(int) FNVDIOCOMPLETE(void *pvUser, int rcReq);
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync/** Pointer to a completion handler. */
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsynctypedef FNVDIOCOMPLETE *PFNVDIOCOMPLETE;
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync/**
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync * Creates a new memory I/O backend.
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync *
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync * @returns IPRT status code.
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync *
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync * @param ppIoBackend Where to store the handle on success.
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync */
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsyncint VDIoBackendMemCreate(PPVDIOBACKENDMEM ppIoBackend);
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync/**
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync * Destroys a memory I/O backend.
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync *
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync * @returns IPRT status code.
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync *
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync * @param pIoBackend The backend to destroy.
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync */
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsyncint VDIoBackendMemDestroy(PVDIOBACKENDMEM pIoBackend);
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync/**
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync * Enqueues a new I/O request.
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync *
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync * @returns IPRT status code.
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync *
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync * @param pIoBackend The backend which should handle the
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync * transfer.
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync * @param pMemDisk The memory disk the request is for.
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync * @param enmTxDir The transfer direction.
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync * @param off Start offset of the transfer.
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync * @param cbTransfer Size of the transfer.
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync * @param pSgBuf S/G buffer to use.
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync * @param pfnComplete Completion handler to call.
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync * @param pvUser Opaque user data.
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync */
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsyncint VDIoBackendMemTransfer(PVDIOBACKENDMEM pIoBackend, PVDMEMDISK pMemDisk,
14a9673ef19f6d8d49f83050d86cb444a55d4008vboxsync VDIOTXDIR enmTxDir, uint64_t off, size_t cbTransfer,
14a9673ef19f6d8d49f83050d86cb444a55d4008vboxsync PRTSGBUF pSgBuf, PFNVDIOCOMPLETE pfnComplete, void *pvUser);
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync
078c5b8c5c814755aab943bf62cadef7e91c419cvboxsync#endif /* __VDIoBackendMem_h__ */