GuestFileImpl.h revision 15c6c4ce0082362b8b81e15c3605f2d3aca69a21
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync/* $Id$ */
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync/** @file
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * VirtualBox Main - Guest file handling.
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync */
c7814cf6e1240a519cbec0441e033d0e2470ed00vboxsync
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync/*
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * Copyright (C) 2012-2013 Oracle Corporation
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync *
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * available from http://www.virtualbox.org. This file is free software;
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * you can redistribute it and/or modify it under the terms of the GNU
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * General Public License (GPL) as published by the Free Software
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync */
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync#ifndef ____H_GUESTFILEIMPL
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync#define ____H_GUESTFILEIMPL
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync#include "VirtualBoxBase.h"
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync#include "EventImpl.h"
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync#include "GuestFsObjInfoImpl.h"
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync#include "GuestCtrlImplPrivate.h"
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync
e4f367251aede667a6de69baa54ef9eb5f150871vboxsyncclass Console;
e4f367251aede667a6de69baa54ef9eb5f150871vboxsyncclass GuestSession;
e4f367251aede667a6de69baa54ef9eb5f150871vboxsyncclass GuestProcess;
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync/**
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * TODO
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync */
e4f367251aede667a6de69baa54ef9eb5f150871vboxsyncclass ATL_NO_VTABLE GuestFile :
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync public VirtualBoxBase,
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync public GuestObject,
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync VBOX_SCRIPTABLE_IMPL(IGuestFile)
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync{
e4f367251aede667a6de69baa54ef9eb5f150871vboxsyncpublic:
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync /** @name COM and internal init/term/mapping cruft.
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * @{ */
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT(GuestFile, IGuestFile)
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync DECLARE_NOT_AGGREGATABLE(GuestFile)
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync DECLARE_PROTECT_FINAL_CONSTRUCT()
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync BEGIN_COM_MAP(GuestFile)
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync VBOX_DEFAULT_INTERFACE_ENTRIES(IGuestFile)
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync COM_INTERFACE_ENTRY(IFile)
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync END_COM_MAP()
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync DECLARE_EMPTY_CTOR_DTOR(GuestFile)
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync int init(Console *pConsole, GuestSession *pSession, ULONG uFileID, const GuestFileOpenInfo &openInfo);
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync void uninit(void);
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync HRESULT FinalConstruct(void);
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync void FinalRelease(void);
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync /** @} */
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync /** @name IFile interface.
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * @{ */
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync STDMETHOD(COMGETTER(CreationMode))(ULONG *aCreationMode);
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync STDMETHOD(COMGETTER(Disposition))(ULONG *aDisposition);
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync STDMETHOD(COMGETTER(EventSource))(IEventSource ** aEventSource);
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync STDMETHOD(COMGETTER(FileName))(BSTR *aFileName);
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync STDMETHOD(COMGETTER(InitialSize))(LONG64 *aInitialSize);
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync STDMETHOD(COMGETTER(Offset))(LONG64 *aOffset);
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync STDMETHOD(COMGETTER(OpenMode))(ULONG *aOpenMode);
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync STDMETHOD(COMGETTER(Status))(FileStatus_T *aStatus);
e170d0511a1456f1677c93e03a78d7162ae82472vboxsync
e170d0511a1456f1677c93e03a78d7162ae82472vboxsync STDMETHOD(Close)(void);
5af981fb39925101cec5e22afb746e2125b55ce4vboxsync STDMETHOD(QueryInfo)(IFsObjInfo **aInfo);
5af981fb39925101cec5e22afb746e2125b55ce4vboxsync STDMETHOD(Read)(ULONG aToRead, ULONG aTimeoutMS, ComSafeArrayOut(BYTE, aData));
c5abe3ea9c7ac6dec34f42af30612534bea951ffvboxsync STDMETHOD(ReadAt)(LONG64 aOffset, ULONG aToRead, ULONG aTimeoutMS, ComSafeArrayOut(BYTE, aData));
c5abe3ea9c7ac6dec34f42af30612534bea951ffvboxsync STDMETHOD(Seek)(LONG64 aOffset, FileSeekType_T aType);
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync STDMETHOD(SetACL)(IN_BSTR aACL);
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync STDMETHOD(Write)(ComSafeArrayIn(BYTE, aData), ULONG aTimeoutMS, ULONG *aWritten);
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync STDMETHOD(WriteAt)(LONG64 aOffset, ComSafeArrayIn(BYTE, aData), ULONG aTimeoutMS, ULONG *aWritten);
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync /** @} */
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync
e4f367251aede667a6de69baa54ef9eb5f150871vboxsyncpublic:
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync /** @name Public internal methods.
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * @{ */
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync int callbackDispatcher(PVBOXGUESTCTRLHOSTCBCTX pCbCtx, PVBOXGUESTCTRLHOSTCALLBACK pSvcCb);
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync int closeFile(int *pGuestRc);
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync static uint32_t getDispositionFromString(const Utf8Str &strDisposition);
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync EventSource *getEventSource(void) { return mEventSource; }
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync static uint32_t getOpenModeFromString(const Utf8Str &strOpenMode);
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync static Utf8Str guestErrorToString(int guestRc);
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync int onFileNotify(PVBOXGUESTCTRLHOSTCBCTX pCbCtx, PVBOXGUESTCTRLHOSTCALLBACK pSvcCbData);
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync int onGuestDisconnected(PVBOXGUESTCTRLHOSTCBCTX pCbCtx, PVBOXGUESTCTRLHOSTCALLBACK pSvcCbData);
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync int openFile(int *pGuestRc);
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync int readData(uint32_t uSize, uint32_t uTimeoutMS, void* pvData, uint32_t cbData, uint32_t* pcbRead);
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync int readDataAt(uint64_t uOffset, uint32_t uSize, uint32_t uTimeoutMS, void* pvData, size_t cbData, size_t* pcbRead);
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync int seekAt(uint64_t uOffset, GUEST_FILE_SEEKTYPE eSeekType, uint32_t uTimeoutMS, uint64_t *puOffset);
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync static HRESULT setErrorExternal(VirtualBoxBase *pInterface, int guestRc);
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync int setFileStatus(FileStatus_T fileStatus, int fileRc);
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync int waitForEvents(uint32_t uTimeoutMS, ComSafeArrayIn(VBoxEventType_T, pEvents), VBoxEventType_T *pType, IEvent **ppEvent);
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync int waitForOffsetChange(uint32_t uTimeoutMS, uint64_t *puOffset);
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync int waitForRead(uint32_t uTimeoutMS, void *pvData, size_t cbData, uint32_t *pcbRead);
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync int waitForStatusChange(uint32_t uTimeoutMS, FileStatus_T *pFileStatus);
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync int waitForWrite(uint32_t uTimeoutMS, uint32_t *pcbWritten);
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync int writeData(uint32_t uTimeoutMS, void *pvData, uint32_t cbData, uint32_t *pcbWritten);
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync int writeDataAt(uint64_t uOffset, uint32_t uTimeoutMS, void *pvData, uint32_t cbData, uint32_t *pcbWritten);
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync /** @} */
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync
e4f367251aede667a6de69baa54ef9eb5f150871vboxsyncprivate:
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync /** The internal console object. */
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync Console *mConsole;
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync /** The associate session this file belongs to. */
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync GuestSession *mSession;
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync /** This can safely be used without holding any locks.
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * An AutoCaller suffices to prevent it being destroy while in use and
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * internally there is a lock providing the necessary serialization. */
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync const ComObjPtr<EventSource> mEventSource;
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync struct Data
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync {
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync /** All related callbacks to this file. */
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync GuestCtrlCallbacks mCallbacks;
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync /** The file's open info. */
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync GuestFileOpenInfo mOpenInfo;
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync /** The file's initial size on open. */
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync uint64_t mInitialSize;
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync /** The file's internal ID. */
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync uint32_t mID;
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync /** The current file status. */
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync FileStatus_T mStatus;
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync /** The file's current offset. */
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync uint64_t mOffCurrent;
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync } mData;
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync};
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync#endif /* !____H_GUESTFILEIMPL */
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync