VBoxGuestLib.h revision a8e1fc1b96d1436189fdb4530d31f20b88b70ea1
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * VBoxGuestLib - VirtualBox Guest Additions Library.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Copyright (C) 2006-2009 Sun Microsystems, Inc.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * available from http://www.virtualbox.org. This file is free software;
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * you can redistribute it and/or modify it under the terms of the GNU
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * General Public License (GPL) as published by the Free Software
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * The contents of this file may alternatively be used under the terms
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * of the Common Development and Distribution License Version 1.0
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * VirtualBox OSE distribution, in which case the provisions of the
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * CDDL are applicable instead of those of the GPL.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * You may elect to license modified versions of this file under the
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * terms and conditions of either the GPL or the CDDL or both.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Clara, CA 95054 USA or visit http://www.sun.com if you need
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * additional information or have any questions.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync/** @defgroup grp_guest_lib VirtualBox Guest Additions Library
223cf005b18af2c21352a70693ebaf0582f68ebcvboxsync/** @page pg_guest_lib VirtualBox Guest Library
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * This is a library for abstracting the additions driver interface. There are
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * multiple versions of the library depending on the context. The main
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * distinction is between kernel and user mode where the interfaces are very
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * different.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @section sec_guest_lib_ring0 Ring-0
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * In ring-0 there are two version:
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * - VBOX_LIB_VBGL_R0_BASE / VBoxGuestR0LibBase for the VBoxGuest main driver,
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * who is responsible for managing the VMMDev virtual hardware.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * - VBOX_LIB_VBGL_R0 / VBoxGuestR0Lib for other (client) guest drivers.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * The library source code and the header have a define VBGL_VBOXGUEST, which is
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * defined for VBoxGuest and undefined for other drivers. Drivers must choose
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * right library in their makefiles and set VBGL_VBOXGUEST accordingly.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * The libraries consists of:
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * - common code to be used by both VBoxGuest and other drivers;
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * - VBoxGuest specific code;
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * - code for other drivers which communicate with VBoxGuest via an IOCTL.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @section sec_guest_lib_ring3 Ring-3
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * There are more variants of the library here:
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * - VBOX_LIB_VBGL_R3 / VBoxGuestR3Lib for programs.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * - VBOX_LIB_VBGL_R3_XFREE86 / VBoxGuestR3LibXFree86 for old style XFree
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * drivers which uses special loader and or symbol resolving strategy.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * - VBOX_LIB_VBGL_R3_SHARED / VBoxGuestR3LibShared for shared objects / DLLs /
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync/** @defgroup grp_guest_lib_r0 Ring-0 interface.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync#if defined(IN_RING0) && !defined(IN_RING0_AGNOSTIC)
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync/** @def DECLR0VBGL
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Declare a VBGL ring-0 API with the right calling convention and visibilitiy.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param type Return type. */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsynctypedef uint32_t VBGLIOPORT; /**< @todo r=bird: We have RTIOPORT (uint16_t) for this. */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * The library initialization function to be used by the main
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * VBoxGuest system driver.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @return VBox status code.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncDECLVBGL(int) VbglInit (VBGLIOPORT portVMMDev, struct VMMDevMemory *pVMMDevMemory);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * The library initialization function to be used by all drivers
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * other than the main VBoxGuest system driver.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @return VBox status code.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * The library termination function.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync/** @name Generic request functions.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Allocate memory for generic request and initialize the request header.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param ppReq pointer to resulting memory address.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param cbSize size of memory block required for the request.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param reqType the generic request type.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @return VBox status code.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncDECLVBGL(int) VbglGRAlloc (VMMDevRequestHeader **ppReq, uint32_t cbSize, VMMDevRequestType reqType);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Perform the generic request.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pReq pointer the request structure.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @return VBox status code.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncDECLVBGL(int) VbglGRPerform (VMMDevRequestHeader *pReq);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Free the generic request memory.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pReq pointer the request structure.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @return VBox status code.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncDECLVBGL(void) VbglGRFree (VMMDevRequestHeader *pReq);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Verify the generic request header.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pReq pointer the request header structure.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param cbReq size of the request memory block. It should be equal to the request size
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * for fixed size requests. It can be greater than the request size for
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * variable size requests.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @return VBox status code.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncDECLVBGL(int) VbglGRVerify (const VMMDevRequestHeader *pReq, size_t cbReq);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Callback function called from HGCM helpers when a wait for request
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * completion IRQ is required.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @returns VINF_SUCCESS, VERR_INTERRUPT or VERR_TIMEOUT.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pvData VBoxGuest pointer to be passed to callback.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param u32Data VBoxGuest 32 bit value to be passed to callback.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsynctypedef DECLVBGL(int) FNVBGLHGCMCALLBACK(VMMDevHGCMRequestHeader *pHeader, void *pvData, uint32_t u32Data);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync/** Pointer to a FNVBGLHGCMCALLBACK. */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Perform a connect request. That is locate required service and
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * obtain a client identifier for future access.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @note This function can NOT handle cancelled requests!
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pConnectInfo The request data.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pfnAsyncCallback Required pointer to function that is calledwhen
aaeb2e2f6ed5b164f1dec9a16a7adeb84f64cf31vboxsync * host returns VINF_HGCM_ASYNC_EXECUTE. VBoxGuest
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * implements waiting for an IRQ in this function.
aaeb2e2f6ed5b164f1dec9a16a7adeb84f64cf31vboxsync * @param pvAsyncData An arbitrary VBoxGuest pointer to be passed to callback.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param u32AsyncData An arbitrary VBoxGuest 32 bit value to be passed to callback.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @return VBox status code.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncDECLR0VBGL(int) VbglR0HGCMInternalConnect (VBoxGuestHGCMConnectInfo *pConnectInfo,
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync PFNVBGLHGCMCALLBACK pfnAsyncCallback, void *pvAsyncData, uint32_t u32AsyncData);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Perform a disconnect request. That is tell the host that
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * the client will not call the service anymore.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @note This function can NOT handle cancelled requests!
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pDisconnectInfo The request data.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pfnAsyncCallback Required pointer to function that is called when
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * host returns VINF_HGCM_ASYNC_EXECUTE. VBoxGuest
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * implements waiting for an IRQ in this function.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pvAsyncData An arbitrary VBoxGuest pointer to be passed to callback.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param u32AsyncData An arbitrary VBoxGuest 32 bit value to be passed to
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * callback.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @return VBox status code.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncDECLR0VBGL(int) VbglR0HGCMInternalDisconnect (VBoxGuestHGCMDisconnectInfo *pDisconnectInfo,
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync PFNVBGLHGCMCALLBACK pfnAsyncCallback, void *pvAsyncData, uint32_t u32AsyncData);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync/** Call a HGCM service.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @note This function can deal with cancelled requests.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pCallInfo The request data.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param fFlags Flags, see VBGLR0_HGCMCALL_F_XXX.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pfnAsyncCallback Required pointer to function that is called when
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * host returns VINF_HGCM_ASYNC_EXECUTE. VBoxGuest
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * implements waiting for an IRQ in this function.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pvAsyncData An arbitrary VBoxGuest pointer to be passed to callback.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param u32AsyncData An arbitrary VBoxGuest 32 bit value to be passed to callback.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @return VBox status code.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncDECLR0VBGL(int) VbglR0HGCMInternalCall (VBoxGuestHGCMCallInfo *pCallInfo, uint32_t cbCallInfo, uint32_t fFlags,
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync PFNVBGLHGCMCALLBACK pfnAsyncCallback, void *pvAsyncData, uint32_t u32AsyncData);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync/** Call a HGCM service. (32 bits packet structure in a 64 bits guest)
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @note This function can deal with cancelled requests.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pCallInfo The request data.
223cf005b18af2c21352a70693ebaf0582f68ebcvboxsync * @param fFlags Flags, see VBGLR0_HGCMCALL_F_XXX.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pfnAsyncCallback Required pointer to function that is called when
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * host returns VINF_HGCM_ASYNC_EXECUTE. VBoxGuest
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * implements waiting for an IRQ in this function.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pvAsyncData An arbitrary VBoxGuest pointer to be passed to callback.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param u32AsyncData An arbitrary VBoxGuest 32 bit value to be passed to callback.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @return VBox status code.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncDECLR0VBGL(int) VbglR0HGCMInternalCall32 (VBoxGuestHGCMCallInfo *pCallInfo, uint32_t cbCallInfo, uint32_t fFlags,
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync PFNVBGLHGCMCALLBACK pfnAsyncCallback, void *pvAsyncData, uint32_t u32AsyncData);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync/** @name VbglR0HGCMInternalCall flags
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync/** User mode request.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Indicates that only user mode addresses are permitted as parameters. */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync/** Kernel mode request.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Indicates that kernel mode addresses are permitted as parameters. Whether or
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * not user mode addresses are permitted is, unfortunately, OS specific. The
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * following OSes allows user mode addresses: Windows, TODO.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync/** Mode mask. */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync# else /* !VBGL_VBOXGUEST */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync/** @name HGCM functions
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Connect to a service.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pHandle Pointer to variable that will hold a handle to be used
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * further in VbglHGCMCall and VbglHGCMClose.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pData Connection information structure.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @return VBox status code.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncDECLVBGL(int) VbglHGCMConnect (VBGLHGCMHANDLE *pHandle, VBoxGuestHGCMConnectInfo *pData);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Connect to a service.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param handle Handle of the connection.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pData Disconnect request information structure.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @return VBox status code.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncDECLVBGL(int) VbglHGCMDisconnect (VBGLHGCMHANDLE handle, VBoxGuestHGCMDisconnectInfo *pData);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Call to a service.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param handle Handle of the connection.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pData Call request information structure, including function parameters.
223cf005b18af2c21352a70693ebaf0582f68ebcvboxsync * @param cbData Length in bytes of data.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @return VBox status code.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncDECLVBGL(int) VbglHGCMCall (VBGLHGCMHANDLE handle, VBoxGuestHGCMCallInfo *pData, uint32_t cbData);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Call to a service with timeout.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param handle Handle of the connection.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pData Call request information structure, including function parameters.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param cbData Length in bytes of data.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param cMillies Timeout in milliseconds. Use RT_INDEFINITE_WAIT to wait forever.
223cf005b18af2c21352a70693ebaf0582f68ebcvboxsync * @return VBox status code.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncDECLVBGL(int) VbglHGCMCallTimed (VBGLHGCMHANDLE handle,
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync VBoxGuestHGCMCallInfoTimed *pData, uint32_t cbData);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync# endif /* !VBGL_VBOXGUEST */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync# endif /* VBOX_WITH_HGCM */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Initialize the heap.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @return VBox error code.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Shutdown the heap.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Allocate a memory block.
223cf005b18af2c21352a70693ebaf0582f68ebcvboxsync * @param cbSize Size of block to be allocated.
223cf005b18af2c21352a70693ebaf0582f68ebcvboxsync * @return Virtual address of allocated memory block.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncDECLVBGL(void *) VbglPhysHeapAlloc (uint32_t cbSize);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Get physical address of memory block pointed by
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * the virtual address.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @note WARNING!
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * The function does not acquire the Heap mutex!
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * When calling the function make sure that
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * the pointer is a valid one and is not being
223cf005b18af2c21352a70693ebaf0582f68ebcvboxsync * deallocated.
223cf005b18af2c21352a70693ebaf0582f68ebcvboxsync * This function can NOT be used for verifying
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * if the given pointer is a valid one allocated
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * from the heap.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param p Virtual address of memory block.
223cf005b18af2c21352a70693ebaf0582f68ebcvboxsync * @return Physical memory block.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncDECLVBGL(RTCCPHYS) VbglPhysHeapGetPhysAddr (void *p);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Free a memory block.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param p Virtual address of memory block.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncDECLVBGL(int) VbglQueryVMMDevMemory (VMMDevMemory **ppVMMDevMemory);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync#endif /* IN_RING0 && !IN_RING0_AGNOSTIC */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync/** @defgroup grp_guest_lib_r3 Ring-3 interface.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync/** @def VBGLR3DECL
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Ring 3 VBGL declaration.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param type The return type of the function declaration.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync/** @name General-purpose functions
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVBGLR3DECL(int) VbglR3GetHostTime(PRTTIMESPEC pTime);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVBGLR3DECL(int) VbglR3WriteLog(const char *pch, size_t cb);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVBGLR3DECL(int) VbglR3CtlFilterMask(uint32_t fOr, uint32_t fNot);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVBGLR3DECL(int) VbglR3Daemonize(bool fNoChDir, bool fNoClose);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVBGLR3DECL(int) VbglR3PidFile(const char *pszPath, PRTFILE phFile);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVBGLR3DECL(void) VbglR3ClosePidFile(const char *pszPath, RTFILE hFile);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVBGLR3DECL(int) VbglR3SetGuestCaps(uint32_t fOr, uint32_t fNot);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVBGLR3DECL(int) VbglR3WaitEvent(uint32_t fMask, uint32_t cMillies, uint32_t *pfEvents);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVBGLR3DECL(int) VbglR3GetAdditionsVersion(char **ppszVer, char **ppszRev);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync/** @name Shared clipboard
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVBGLR3DECL(int) VbglR3ClipboardConnect(uint32_t *pu32ClientId);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVBGLR3DECL(int) VbglR3ClipboardDisconnect(uint32_t u32ClientId);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVBGLR3DECL(int) VbglR3ClipboardGetHostMsg(uint32_t u32ClientId, uint32_t *pMsg, uint32_t *pfFormats);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVBGLR3DECL(int) VbglR3ClipboardReadData(uint32_t u32ClientId, uint32_t fFormat, void *pv, uint32_t cb, uint32_t *pcb);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVBGLR3DECL(int) VbglR3ClipboardReportFormats(uint32_t u32ClientId, uint32_t fFormats);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVBGLR3DECL(int) VbglR3ClipboardWriteData(uint32_t u32ClientId, uint32_t fFormat, void *pv, uint32_t cb);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync/** @name Seamless mode
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVBGLR3DECL(int) VbglR3SeamlessWaitEvent(VMMDevSeamlessMode *pMode);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVBGLR3DECL(int) VbglR3SeamlessSendRects(uint32_t cRects, PRTRECT pRects);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync/** @name Mouse
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVBGLR3DECL(int) VbglR3GetMouseStatus(uint32_t *pfFeatures, uint32_t *px, uint32_t *py);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVBGLR3DECL(int) VbglR3SetMouseStatus(uint32_t fFeatures);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync/** @name Video
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVBGLR3DECL(int) VbglR3VideoAccelEnable(bool fEnable);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVBGLR3DECL(int) VbglR3SetPointerShape(uint32_t fFlags, uint32_t xHot, uint32_t yHot, uint32_t cx, uint32_t cy, const void *pvImg, size_t cbImg);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVBGLR3DECL(int) VbglR3SetPointerShapeReq(struct VMMDevReqMousePointer *pReq);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync/** @name Display
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVBGLR3DECL(int) VbglR3GetDisplayChangeRequest(uint32_t *pcx, uint32_t *pcy, uint32_t *pcBits, uint32_t *piDisplay, bool fAck);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVBGLR3DECL(bool) VbglR3HostLikesVideoMode(uint32_t cx, uint32_t cy, uint32_t cBits);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVBGLR3DECL(int) VbglR3SaveVideoMode(const char *pszName, uint32_t cx, uint32_t cy, uint32_t cBits);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVBGLR3DECL(int) VbglR3RetrieveVideoMode(const char *pszName, uint32_t *pcx, uint32_t *pcy, uint32_t *pcBits);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync/** @name Guest properties
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync/** @todo Docs. */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsynctypedef struct VBGLR3GUESTPROPENUM VBGLR3GUESTPROPENUM;
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync/** @todo Docs. */
b9ca93dd1ad44cb8b27679dc5624be2f7b7f7af5vboxsyncVBGLR3DECL(int) VbglR3GuestPropConnect(uint32_t *pu32ClientId);
b9ca93dd1ad44cb8b27679dc5624be2f7b7f7af5vboxsyncVBGLR3DECL(int) VbglR3GuestPropDisconnect(uint32_t u32ClientId);
b9ca93dd1ad44cb8b27679dc5624be2f7b7f7af5vboxsyncVBGLR3DECL(int) VbglR3GuestPropWrite(uint32_t u32ClientId, const char *pszName, const char *pszValue, const char *pszFlags);
b9ca93dd1ad44cb8b27679dc5624be2f7b7f7af5vboxsyncVBGLR3DECL(int) VbglR3GuestPropWriteValue(uint32_t u32ClientId, const char *pszName, const char *pszValue);
b9ca93dd1ad44cb8b27679dc5624be2f7b7f7af5vboxsyncVBGLR3DECL(int) VbglR3GuestPropWriteValueV(uint32_t u32ClientId, const char *pszName, const char *pszValueFormat, va_list va);
b9ca93dd1ad44cb8b27679dc5624be2f7b7f7af5vboxsyncVBGLR3DECL(int) VbglR3GuestPropWriteValueF(uint32_t u32ClientId, const char *pszName, const char *pszValueFormat, ...);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVBGLR3DECL(int) VbglR3GuestPropRead(uint32_t u32ClientId, const char *pszName, void *pvBuf, uint32_t cbBuf, char **ppszValue, uint64_t *pu64Timestamp, char **ppszFlags, uint32_t *pcbBufActual);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVBGLR3DECL(int) VbglR3GuestPropReadValue(uint32_t ClientId, const char *pszName, char *pszValue, uint32_t cchValue, uint32_t *pcchValueActual);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVBGLR3DECL(int) VbglR3GuestPropReadValueAlloc(uint32_t u32ClientId, const char *pszName, char **ppszValue);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVBGLR3DECL(void) VbglR3GuestPropReadValueFree(char *pszValue);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVBGLR3DECL(int) VbglR3GuestPropEnumRaw(uint32_t u32ClientId, const char *paszPatterns, char *pcBuf, uint32_t cbBuf, uint32_t *pcbBufActual);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVBGLR3DECL(int) VbglR3GuestPropEnum(uint32_t u32ClientId, char const * const *ppaszPatterns, uint32_t cPatterns, PVBGLR3GUESTPROPENUM *ppHandle,
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync char const **ppszName, char const **ppszValue, uint64_t *pu64Timestamp, char const **ppszFlags);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVBGLR3DECL(int) VbglR3GuestPropEnumNext(PVBGLR3GUESTPROPENUM pHandle, char const **ppszName, char const **ppszValue, uint64_t *pu64Timestamp,
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync char const **ppszFlags);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVBGLR3DECL(void) VbglR3GuestPropEnumFree(PVBGLR3GUESTPROPENUM pHandle);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVBGLR3DECL(int) VbglR3GuestPropDelSet(uint32_t u32ClientId, char const * const *papszPatterns, uint32_t cPatterns);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVBGLR3DECL(int) VbglR3GuestPropWait(uint32_t u32ClientId, const char *pszPatterns, void *pvBuf, uint32_t cbBuf, uint64_t u64Timestamp, uint32_t cMillies, char ** ppszName, char **ppszValue, uint64_t *pu64Timestamp, char **ppszFlags, uint32_t *pcbBufActual);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync/** @name Host version handling
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVBGLR3DECL(int) VbglR3HostVersionCompare(const char *pszVer1, const char *pszVer2);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVBGLR3DECL(int) VbglR3HostVersionCheckForUpdate(uint32_t u32ClientId, bool *bUpdate, char **ppszHostVersion, char **ppszGuestVersion);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVBGLR3DECL(int) VbglR3HostVersionLastCheckedLoad(uint32_t u32ClientId, char **ppszVer);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVBGLR3DECL(int) VbglR3HostVersionLastCheckedStore(uint32_t u32ClientId, const char *pszVer);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync# endif /* VBOX_WITH_GUEST_PROPS defined */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync/** @name User credentials handling
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVBGLR3DECL(bool) VbglR3CredentialsAreAvailable(void);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVBGLR3DECL(int) VbglR3CredentialsRetrieve(char **ppszUser, char **ppszPassword, char **ppszDomain);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync#endif /* IN_RING3 */