GuestFileImpl.cpp revision c55bf74b54ecdfb5ebc4e5d90b620d0fee31737e
/* $Id$ */
/** @file
* VirtualBox Main - Guest file handling.
*/
/*
* Copyright (C) 2012-2013 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* you can redistribute it and/or modify it under the terms of the GNU
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*/
/*******************************************************************************
* Header Files *
*******************************************************************************/
#include "GuestErrorInfoImpl.h"
#include "GuestFileImpl.h"
#include "GuestSessionImpl.h"
#include "GuestCtrlImplPrivate.h"
#include "ConsoleImpl.h"
#include "Global.h"
#include "AutoCaller.h"
#include "VBoxEvents.h"
#include <iprt/cpp/utils.h> /* For unconst(). */
#include <iprt/file.h>
#include <VBox/com/array.h>
#ifdef LOG_GROUP
#undef LOG_GROUP
#endif
#define LOG_GROUP LOG_GROUP_GUEST_CONTROL
#include <VBox/log.h>
// constructor / destructor
/////////////////////////////////////////////////////////////////////////////
DEFINE_EMPTY_CTOR_DTOR(GuestFile)
HRESULT GuestFile::FinalConstruct(void)
{
LogFlowThisFunc(("\n"));
return BaseFinalConstruct();
}
void GuestFile::FinalRelease(void)
{
LogFlowThisFuncEnter();
uninit();
BaseFinalRelease();
LogFlowThisFuncLeave();
}
// public initializer/uninitializer for internal purposes only
/////////////////////////////////////////////////////////////////////////////
/**
* Initializes a file object but does *not* open the file on the guest
* yet. This is done in the dedidcated openFile call.
*
* @return IPRT status code.
* @param pConsole Pointer to console object.
* @param pSession Pointer to session object.
* @param uFileID Host-based file ID (part of the context ID).
* @param openInfo File opening information.
*/
int GuestFile::init(Console *pConsole, GuestSession *pSession, ULONG uFileID, const GuestFileOpenInfo &openInfo)
{
LogFlowThisFunc(("pConsole=%p, pSession=%p, uFileID=%RU32, strPath=%s\n",
pConsole, pSession, uFileID, openInfo.mFileName.c_str()));
AssertPtrReturn(pConsole, VERR_INVALID_POINTER);
AssertPtrReturn(pSession, VERR_INVALID_POINTER);
/* Enclose the state transition NotReady->InInit->Ready. */
AutoInitSpan autoInitSpan(this);
AssertReturn(autoInitSpan.isOk(), VERR_OBJECT_DESTROYED);
int vrc = bindToSession(pConsole, pSession, uFileID /* Object ID */);
if (RT_SUCCESS(vrc))
{
mData.mID = 0;
mData.mInitialSize = 0;
mData.mStatus = FileStatus_Undefined;
unconst(mEventSource).createObject();
HRESULT hr = mEventSource->init(static_cast<IGuestFile*>(this));
if (FAILED(hr))
vrc = VERR_COM_UNEXPECTED;
}
if (RT_SUCCESS(vrc))
{
/* Confirm a successful initialization when it's the case. */
autoInitSpan.setSucceeded();
}
else
autoInitSpan.setFailed();
LogFlowFuncLeaveRC(vrc);
return vrc;
}
/**
* Uninitializes the instance.
* Called from FinalRelease().
*/
void GuestFile::uninit(void)
{
LogFlowThisFunc(("\n"));
/* Enclose the state transition Ready->InUninit->NotReady. */
AutoUninitSpan autoUninitSpan(this);
if (autoUninitSpan.uninitDone())
return;
#ifdef VBOX_WITH_GUEST_CONTROL
unconst(mEventSource).setNull();
#endif
LogFlowThisFuncLeave();
}
// implementation of public getters/setters for attributes
/////////////////////////////////////////////////////////////////////////////
STDMETHODIMP GuestFile::COMGETTER(CreationMode)(ULONG *aCreationMode)
{
#ifndef VBOX_WITH_GUEST_CONTROL
ReturnComNotImplemented();
#else
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
CheckComArgOutPointerValid(aCreationMode);
AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
*aCreationMode = mData.mOpenInfo.mCreationMode;
return S_OK;
#endif /* VBOX_WITH_GUEST_CONTROL */
}
/** @todo For 4.3: Change ULONG* to BSTR* ?*/
STDMETHODIMP GuestFile::COMGETTER(Disposition)(ULONG *aDisposition)
{
#ifndef VBOX_WITH_GUEST_CONTROL
ReturnComNotImplemented();
#else
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
CheckComArgOutPointerValid(aDisposition);
AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
*aDisposition = getDispositionFromString(mData.mOpenInfo.mDisposition);
return S_OK;
#endif /* VBOX_WITH_GUEST_CONTROL */
}
STDMETHODIMP GuestFile::COMGETTER(FileName)(BSTR *aFileName)
{
#ifndef VBOX_WITH_GUEST_CONTROL
ReturnComNotImplemented();
#else
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
CheckComArgOutPointerValid(aFileName);
AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
mData.mOpenInfo.mFileName.cloneTo(aFileName);
return S_OK;
#endif /* VBOX_WITH_GUEST_CONTROL */
}
STDMETHODIMP GuestFile::COMGETTER(InitialSize)(LONG64 *aInitialSize)
{
#ifndef VBOX_WITH_GUEST_CONTROL
ReturnComNotImplemented();
#else
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
CheckComArgOutPointerValid(aInitialSize);
AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
*aInitialSize = mData.mInitialSize;
return S_OK;
#endif /* VBOX_WITH_GUEST_CONTROL */
}
STDMETHODIMP GuestFile::COMGETTER(Offset)(LONG64 *aOffset)
{
#ifndef VBOX_WITH_GUEST_CONTROL
ReturnComNotImplemented();
#else
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
CheckComArgOutPointerValid(aOffset);
AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
*aOffset = mData.mOffCurrent;
return S_OK;
#endif /* VBOX_WITH_GUEST_CONTROL */
}
/** @todo For 4.3: Change ULONG* to BSTR* ?*/
STDMETHODIMP GuestFile::COMGETTER(OpenMode)(ULONG *aOpenMode)
{
#ifndef VBOX_WITH_GUEST_CONTROL
ReturnComNotImplemented();
#else
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
CheckComArgOutPointerValid(aOpenMode);
AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
*aOpenMode = getOpenModeFromString(mData.mOpenInfo.mOpenMode);
return S_OK;
#endif /* VBOX_WITH_GUEST_CONTROL */
}
STDMETHODIMP GuestFile::COMGETTER(Status)(FileStatus_T *aStatus)
{
#ifndef VBOX_WITH_GUEST_CONTROL
ReturnComNotImplemented();
#else
LogFlowThisFuncEnter();
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
*aStatus = mData.mStatus;
return S_OK;
#endif /* VBOX_WITH_GUEST_CONTROL */
}
// private methods
/////////////////////////////////////////////////////////////////////////////
int GuestFile::callbackDispatcher(PVBOXGUESTCTRLHOSTCBCTX pCbCtx, PVBOXGUESTCTRLHOSTCALLBACK pSvcCb)
{
#ifdef DEBUG
LogFlowThisFunc(("strName=%s, uContextID=%RU32, uFunction=%RU32, pSvcCb=%p\n",
mData.mOpenInfo.mFileName.c_str(), pCbCtx->uContextID, pCbCtx->uFunction, pSvcCb));
#endif
AssertPtrReturn(pSvcCb, VERR_INVALID_POINTER);
AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
int vrc;
switch (pCbCtx->uFunction)
{
case GUEST_DISCONNECTED:
vrc = onGuestDisconnected(pCbCtx, pSvcCb);
break;
case GUEST_FILE_NOTIFY:
vrc = onFileNotify(pCbCtx, pSvcCb);
break;
default:
/* Silently ignore not implemented functions. */
vrc = VERR_NOT_SUPPORTED;
break;
}
#ifdef DEBUG
LogFlowFuncLeaveRC(vrc);
#endif
return vrc;
}
int GuestFile::closeFile(int *pGuestRc)
{
LogFlowThisFunc(("strFile=%s\n", mData.mOpenInfo.mFileName.c_str()));
uint32_t uContextID;
int vrc = generateContextID(mSession->getId(), mObjectID,
&uContextID);
if (RT_SUCCESS(vrc))
{
/* Prepare HGCM call. */
VBOXHGCMSVCPARM paParms[4];
int i = 0;
paParms[i++].setUInt32(mData.mID /* Guest file ID */);
vrc = sendCommand(HOST_FILE_CLOSE, i, paParms);
if (RT_SUCCESS(vrc))
vrc = waitForStatusChange(30 * 1000 /* Timeout in ms */,
NULL /* FileStatus */);
}
LogFlowFuncLeaveRC(vrc);
return vrc;
}
/* static */
uint32_t GuestFile::getDispositionFromString(const Utf8Str &strDisposition)
{
return 0; /** @todo Implement me! */
}
/* static */
uint32_t GuestFile::getOpenModeFromString(const Utf8Str &strOpenMode)
{
uint32_t uOpenMode = 0;
const char *pc = strOpenMode.c_str();
while (*pc != '\0')
{
switch (*pc++)
{
case 'r':
uOpenMode |= RTFILE_O_READ;
break;
case 'w':
uOpenMode |= RTFILE_O_WRITE;
break;
default:
/* Silently skip unknown values. */
break;
}
}
return uOpenMode;
}
/* static */
Utf8Str GuestFile::guestErrorToString(int guestRc)
{
Utf8Str strError;
/** @todo pData->u32Flags: int vs. uint32 -- IPRT errors are *negative* !!! */
switch (guestRc)
{
case VERR_INVALID_VM_HANDLE:
strError += Utf8StrFmt(tr("VMM device is not available (is the VM running?)"));
break;
case VERR_HGCM_SERVICE_NOT_FOUND:
strError += Utf8StrFmt(tr("The guest execution service is not available"));
break;
case VERR_TIMEOUT:
strError += Utf8StrFmt(tr("The guest did not respond within time"));
break;
case VERR_CANCELLED:
strError += Utf8StrFmt(tr("The session operation was canceled"));
break;
case VERR_MAX_PROCS_REACHED:
strError += Utf8StrFmt(tr("Maximum number of concurrent guest files has been reached"));
break;
case VERR_NOT_EQUAL: /** @todo Imprecise to the user; can mean anything and all. */
strError += Utf8StrFmt(tr("Unable to retrieve requested information"));
break;
case VERR_NOT_FOUND:
strError += Utf8StrFmt(tr("The guest execution service is not ready (yet)"));
break;
default:
strError += Utf8StrFmt("%Rrc", guestRc);
break;
}
return strError;
}
int GuestFile::onFileNotify(PVBOXGUESTCTRLHOSTCBCTX pCbCtx, PVBOXGUESTCTRLHOSTCALLBACK pSvcCbData)
{
AssertPtrReturn(pCbCtx, VERR_INVALID_POINTER);
AssertPtrReturn(pSvcCbData, VERR_INVALID_POINTER);
if (pSvcCbData->mParms < 3)
return VERR_INVALID_PARAMETER;
int vrc = VINF_SUCCESS;
int idx = 0; /* Current parameter index. */
CALLBACKDATA_FILE_NOTIFY dataCb;
/* pSvcCb->mpaParms[0] always contains the context ID. */
pSvcCbData->mpaParms[idx++].getUInt32(&dataCb.uType);
pSvcCbData->mpaParms[idx++].getUInt32(&dataCb.rc);
int guestRc = (int)dataCb.rc; /* uint32_t vs. int. */
switch (dataCb.uType)
{
case GUEST_FILE_NOTIFYTYPE_ERROR:
{
AssertMsg(mData.mStatus != FileStatus_Error, ("File status already set to error\n"));
int rc2 = setFileStatus(FileStatus_Error, guestRc);
AssertRC(rc2);
break;
}
case GUEST_FILE_NOTIFYTYPE_OPEN:
{
if (pSvcCbData->mParms == 4)
{
pSvcCbData->mpaParms[idx++].getUInt32(&dataCb.u.open.uHandle);
AssertMsg(mData.mID == 0, ("File ID already set to %RU32\n", mData.mID));
mData.mID = dataCb.u.open.uHandle;
AssertMsg(mData.mID == VBOX_GUESTCTRL_CONTEXTID_GET_OBJECT(pCbCtx->uContextID),
("File ID %RU32 does not match context ID %RU32\n", mData.mID,
VBOX_GUESTCTRL_CONTEXTID_GET_OBJECT(pCbCtx->uContextID)));
/* Set the process status. */
int rc2 = setFileStatus(FileStatus_Open, guestRc);
if (RT_SUCCESS(vrc))
vrc = rc2;
}
else
vrc = VERR_NOT_SUPPORTED;
break;
}
case GUEST_FILE_NOTIFYTYPE_CLOSE:
{
int rc2 = setFileStatus(FileStatus_Closed, guestRc);
AssertRC(rc2);
break;
}
case GUEST_FILE_NOTIFYTYPE_READ:
if (pSvcCbData->mParms == 4)
{
pSvcCbData->mpaParms[idx++].getPointer(&dataCb.u.read.pvData,
&dataCb.u.read.cbData);
uint32_t cbRead = dataCb.u.read.cbData;
if (cbRead)
{
mData.mOffCurrent += cbRead;
com::SafeArray<BYTE> data((size_t)cbRead);
data.initFrom((BYTE*)dataCb.u.read.pvData, cbRead);
fireGuestFileReadEvent(mEventSource, mSession, this, mData.mOffCurrent,
cbRead, ComSafeArrayAsInParam(data));
}
}
else
vrc = VERR_NOT_SUPPORTED;
break;
case GUEST_FILE_NOTIFYTYPE_WRITE:
if (pSvcCbData->mParms == 4)
{
pSvcCbData->mpaParms[idx++].getUInt32(&dataCb.u.write.cbWritten);
mData.mOffCurrent += dataCb.u.write.cbWritten;
if (dataCb.u.write.cbWritten)
fireGuestFileWriteEvent(mEventSource, mSession, this, mData.mOffCurrent,
dataCb.u.write.cbWritten);
}
else
vrc = VERR_NOT_SUPPORTED;
break;
case GUEST_FILE_NOTIFYTYPE_SEEK:
if (pSvcCbData->mParms == 4)
{
pSvcCbData->mpaParms[idx++].getUInt64(&dataCb.u.seek.uOffActual);
mData.mOffCurrent = dataCb.u.seek.uOffActual;
if (dataCb.u.seek.uOffActual)
fireGuestFileOffsetChangedEvent(mEventSource, mSession, this,
mData.mOffCurrent, 0 /* Processed */);
}
else
vrc = VERR_NOT_SUPPORTED;
break;
case GUEST_FILE_NOTIFYTYPE_TELL:
if (pSvcCbData->mParms == 4)
{
pSvcCbData->mpaParms[idx++].getUInt64(&dataCb.u.tell.uOffActual);
if (mData.mOffCurrent != dataCb.u.tell.uOffActual)
{
mData.mOffCurrent = dataCb.u.tell.uOffActual;
fireGuestFileOffsetChangedEvent(mEventSource, mSession, this,
mData.mOffCurrent, 0 /* Processed */);
}
}
else
vrc = VERR_NOT_SUPPORTED;
break;
default:
vrc = VERR_NOT_SUPPORTED;
break;
}
LogFlowThisFunc(("strName=%s, uType=%RU32, guestRc=%Rrc\n",
mData.mOpenInfo.mFileName.c_str(), dataCb.uType, dataCb.rc));
if (RT_SUCCESS(vrc))
{
/* Nothing to do here yet. */
}
else if (vrc == VERR_NOT_SUPPORTED)
{
/* Also let the callback know. */
guestRc = VERR_NOT_SUPPORTED;
}
LogFlowFuncLeaveRC(vrc);
return vrc;
}
int GuestFile::onGuestDisconnected(PVBOXGUESTCTRLHOSTCBCTX pCbCtx, PVBOXGUESTCTRLHOSTCALLBACK pSvcCbData)
{
AssertPtrReturn(pCbCtx, VERR_INVALID_POINTER);
AssertPtrReturn(pSvcCbData, VERR_INVALID_POINTER);
LogFlowThisFunc(("strFile=%s\n",
mData.mOpenInfo.mFileName.c_str()));
int vrc = setFileStatus(FileStatus_Down, VINF_SUCCESS);
LogFlowFuncLeaveRC(vrc);
return vrc;
}
int GuestFile::openFile(int *pGuestRc)
{
LogFlowThisFunc(("strFile=%s, strOpenMode=%s, strDisposition=%s, uCreationMode=%RU32\n",
mData.mOpenInfo.mFileName.c_str(), mData.mOpenInfo.mOpenMode.c_str(),
mData.mOpenInfo.mDisposition.c_str(), mData.mOpenInfo.mCreationMode));
/* Prepare HGCM call. */
VBOXHGCMSVCPARM paParms[8];
int i = 0;
paParms[i++].setPointer((void*)mData.mOpenInfo.mFileName.c_str(),
(ULONG)mData.mOpenInfo.mFileName.length() + 1);
paParms[i++].setPointer((void*)mData.mOpenInfo.mOpenMode.c_str(),
(ULONG)mData.mOpenInfo.mOpenMode.length() + 1);
paParms[i++].setPointer((void*)mData.mOpenInfo.mDisposition.c_str(),
(ULONG)mData.mOpenInfo.mDisposition.length() + 1);
paParms[i++].setUInt32(mData.mOpenInfo.mCreationMode);
paParms[i++].setUInt64(mData.mOpenInfo.mInitialOffset);
int vrc = sendCommand(HOST_FILE_OPEN, i, paParms);
if (RT_SUCCESS(vrc))
vrc = waitForStatusChange(30 * 1000 /* Timeout in ms */,
NULL /* FileStatus */);
LogFlowFuncLeaveRC(vrc);
return vrc;
}
int GuestFile::readData(uint32_t uSize, uint32_t uTimeoutMS,
void* pvData, uint32_t cbData, uint32_t* pcbRead)
{
LogFlowThisFunc(("uSize=%RU32, uTimeoutMS=%RU32, pvData=%p, cbData=%zu\n",
uSize, uTimeoutMS, pvData, cbData));
uint32_t uContextID;
int vrc = generateContextID(mSession->getId(), mObjectID,
&uContextID);
if (RT_SUCCESS(vrc))
{
/* Prepare HGCM call. */
VBOXHGCMSVCPARM paParms[4];
int i = 0;
paParms[i++].setUInt32(mData.mID /* File handle */);
paParms[i++].setUInt32(uSize /* Size (in bytes) to read */);
uint32_t cbRead;
vrc = sendCommand(HOST_FILE_READ, i, paParms);
if (RT_SUCCESS(vrc))
vrc = waitForRead(uTimeoutMS, pvData, cbData, &cbRead);
if (RT_SUCCESS(vrc))
{
LogFlowThisFunc(("cbRead=%RU32\n", cbRead));
if (pcbRead)
*pcbRead = cbRead;
}
}
LogFlowFuncLeaveRC(vrc);
return vrc;
}
int GuestFile::readDataAt(uint64_t uOffset, uint32_t uSize, uint32_t uTimeoutMS,
void* pvData, size_t cbData, size_t* pcbRead)
{
LogFlowThisFunc(("uOffset=%RU64, uSize=%RU32, uTimeoutMS=%RU32, pvData=%p, cbData=%zu\n",
uOffset, uSize, uTimeoutMS, pvData, cbData));
uint32_t uContextID;
int vrc = generateContextID(mSession->getId(), mObjectID,
&uContextID);
if (RT_SUCCESS(vrc))
{
/* Prepare HGCM call. */
VBOXHGCMSVCPARM paParms[4];
int i = 0;
paParms[i++].setUInt32(mData.mID /* File handle */);
paParms[i++].setUInt64(uOffset /* Offset (in bytes) to start reading */);
paParms[i++].setUInt32(uSize /* Size (in bytes) to read */);
uint32_t cbRead;
int vrc = sendCommand(HOST_FILE_READ_AT, i, paParms);
if (RT_SUCCESS(vrc))
vrc = waitForRead(uTimeoutMS, pvData, cbData, &cbRead);
if (RT_SUCCESS(vrc))
{
LogFlowThisFunc(("cbRead=%RU32\n", cbRead));
if (pcbRead)
*pcbRead = cbRead;
}
}
LogFlowFuncLeaveRC(vrc);
return vrc;
}
int GuestFile::seekAt(uint64_t uOffset, GUEST_FILE_SEEKTYPE eSeekType,
uint32_t uTimeoutMS, uint64_t *puOffset)
{
LogFlowThisFunc(("uOffset=%RU64, uTimeoutMS=%RU32\n",
uOffset, uTimeoutMS));
/* Prepare HGCM call. */
VBOXHGCMSVCPARM paParms[4];
int i = 0;
paParms[i++].setUInt32(mData.mID /* File handle */);
paParms[i++].setUInt32(eSeekType /* Seek method */);
paParms[i++].setUInt64(uOffset /* Offset (in bytes) to start reading */);
int vrc = sendCommand(HOST_FILE_SEEK, i, paParms);
if (RT_SUCCESS(vrc))
vrc = waitForOffsetChange(uTimeoutMS, puOffset);
LogFlowFuncLeaveRC(vrc);
return vrc;
}
/* static */
HRESULT GuestFile::setErrorExternal(VirtualBoxBase *pInterface, int guestRc)
{
AssertPtr(pInterface);
AssertMsg(RT_FAILURE(guestRc), ("Guest rc does not indicate a failure when setting error\n"));
return pInterface->setError(VBOX_E_IPRT_ERROR, GuestFile::guestErrorToString(guestRc).c_str());
}
/* Does not do locking; caller is responsible for that! */
int GuestFile::setFileStatus(FileStatus_T fileStatus, int fileRc)
{
LogFlowThisFunc(("oldStatus=%ld, newStatus=%ld, fileRc=%Rrc\n",
mData.mStatus, fileStatus, fileRc));
#ifdef VBOX_STRICT
if (fileStatus == FileStatus_Error)
{
AssertMsg(RT_FAILURE(fileRc), ("Guest rc must be an error (%Rrc)\n", fileRc));
}
else
AssertMsg(RT_SUCCESS(fileRc), ("Guest rc must not be an error (%Rrc)\n", fileRc));
#endif
if (mData.mStatus != fileStatus)
{
mData.mStatus = fileStatus;
ComObjPtr<GuestErrorInfo> errorInfo;
HRESULT hr = errorInfo.createObject();
ComAssertComRC(hr);
if (RT_FAILURE(fileRc))
{
int rc2 = errorInfo->init(fileRc, guestErrorToString(fileRc));
AssertRC(rc2);
}
fireGuestFileStateChangedEvent(mEventSource, mSession,
this, mData.mStatus, errorInfo);
}
return VINF_SUCCESS;
}
int GuestFile::waitForOffsetChange(uint32_t uTimeoutMS, uint64_t *puOffset)
{
return VINF_SUCCESS;
}
int GuestFile::waitForRead(uint32_t uTimeoutMS, void* pvData, size_t cbData, uint32_t *pcbRead)
{
return VINF_SUCCESS;
}
int GuestFile::waitForStatusChange(uint32_t uTimeoutMS, FileStatus_T *pFileStatus)
{
int vrc;
/** @todo Parameter validation. */
ComPtr<IEventListener> pListener;
HRESULT hr = mEventSource->CreateListener(pListener.asOutParam());
if (SUCCEEDED(hr))
{
com::SafeArray <VBoxEventType_T> eventTypes(1);
eventTypes.push_back(VBoxEventType_OnGuestFileStateChanged);
hr = mEventSource->RegisterListener(pListener, ComSafeArrayAsInParam(eventTypes), false);
}
else
vrc = VERR_COM_UNEXPECTED;
if (SUCCEEDED(hr))
{
LogFlowThisFunc(("Waiting for guest file status change event (timeout=%RU32ms) ...\n",
uTimeoutMS));
vrc = VINF_SUCCESS;
uint64_t u64Started = RTTimeMilliTS();
bool fSignalled = false;
do
{
unsigned cMsWait;
if (uTimeoutMS == RT_INDEFINITE_WAIT)
cMsWait = 1000;
else
{
uint64_t cMsElapsed = RTTimeMilliTS() - u64Started;
if (cMsElapsed >= uTimeoutMS)
break; /* timed out */
cMsWait = RT_MIN(1000, uTimeoutMS - (uint32_t)cMsElapsed);
}
ComPtr<IEvent> pEvent;
hr = mEventSource->GetEvent(pListener, cMsWait, pEvent.asOutParam());
if ( SUCCEEDED(hr)
&& !pEvent.isNull())
{
VBoxEventType_T aType;
hr = pEvent->COMGETTER(Type)(&aType);
ComAssertComRC(hr);
switch (aType)
{
case VBoxEventType_OnGuestFileStateChanged:
{
ComPtr<IGuestFileStateChangedEvent> pChangedEvent = pEvent;
Assert(!pChangedEvent.isNull());
ComPtr<IGuestFile> pFile;
pChangedEvent->COMGETTER(File)(pFile.asOutParam());
Assert(!pFile.isNull());
if (pFile != this)
continue;
}
default:
AssertMsgFailed(("Unhandled event type %ld\n", aType));
break;
}
fSignalled = true;
break;
}
} while (!fSignalled);
if ( RT_SUCCESS(vrc)
&& !fSignalled)
{
vrc = VERR_TIMEOUT;
}
mEventSource->UnregisterListener(pListener);
}
else
vrc = VERR_COM_UNEXPECTED;
LogFlowFuncLeaveRC(vrc);
return vrc;
}
int GuestFile::waitForWrite(uint32_t uTimeoutMS, uint32_t *pcbWritten)
{
return VINF_SUCCESS;
}
int GuestFile::writeData(uint32_t uTimeoutMS, void *pvData, uint32_t cbData,
uint32_t *pcbWritten)
{
AssertPtrReturn(pvData, VERR_INVALID_POINTER);
AssertReturn(cbData, VERR_INVALID_PARAMETER);
LogFlowThisFunc(("uTimeoutMS=%RU32, pvData=%p, cbData=%zu\n",
uTimeoutMS, pvData, cbData));
uint32_t uContextID;
int vrc = generateContextID(mSession->getId(), mObjectID,
&uContextID);
if (RT_SUCCESS(vrc))
{
/* Prepare HGCM call. */
VBOXHGCMSVCPARM paParms[8];
int i = 0;
paParms[i++].setUInt32(uContextID);
paParms[i++].setUInt32(mData.mID /* File handle */);
paParms[i++].setUInt32(cbData /* Size (in bytes) to write */);
paParms[i++].setPointer(pvData, cbData);
uint32_t cbWritten;
vrc = sendCommand(HOST_FILE_WRITE, i, paParms);
if (RT_SUCCESS(vrc))
vrc = waitForWrite(uTimeoutMS, &cbWritten);
if (RT_SUCCESS(vrc))
{
LogFlowThisFunc(("cbWritten=%RU32\n", cbWritten));
if (cbWritten)
*pcbWritten = cbWritten;
}
}
LogFlowFuncLeaveRC(vrc);
return vrc;
}
int GuestFile::writeDataAt(uint64_t uOffset, uint32_t uTimeoutMS,
void *pvData, uint32_t cbData, uint32_t *pcbWritten)
{
AssertPtrReturn(pvData, VERR_INVALID_POINTER);
AssertReturn(cbData, VERR_INVALID_PARAMETER);
LogFlowThisFunc(("uOffset=%RU64, uTimeoutMS=%RU32, pvData=%p, cbData=%zu\n",
uOffset, uTimeoutMS, pvData, cbData));
uint32_t uContextID;
int vrc = generateContextID(mSession->getId(), mObjectID,
&uContextID);
if (RT_SUCCESS(vrc))
{
/* Prepare HGCM call. */
VBOXHGCMSVCPARM paParms[8];
int i = 0;
paParms[i++].setUInt32(mData.mID /* File handle */);
paParms[i++].setUInt64(uOffset /* Offset where to starting writing */);
paParms[i++].setUInt32(cbData /* Size (in bytes) to write */);
paParms[i++].setPointer(pvData, cbData);
vrc = sendCommand(HOST_FILE_WRITE_AT, i, paParms);
if (RT_SUCCESS(vrc))
{
uint32_t cbWritten;
vrc = sendCommand(HOST_FILE_WRITE, i, paParms);
if (RT_SUCCESS(vrc))
vrc = waitForWrite(uTimeoutMS, &cbWritten);
if (RT_SUCCESS(vrc))
{
LogFlowThisFunc(("cbWritten=%RU32\n", cbWritten));
if (cbWritten)
*pcbWritten = cbWritten;
}
}
}
LogFlowFuncLeaveRC(vrc);
return vrc;
}
// implementation of public methods
/////////////////////////////////////////////////////////////////////////////
STDMETHODIMP GuestFile::Close(void)
{
#ifndef VBOX_WITH_GUEST_CONTROL
ReturnComNotImplemented();
#else
LogFlowThisFuncEnter();
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
/* Close file on guest. */
int guestRc;
int rc = closeFile(&guestRc);
/* On failure don't return here, instead do all the cleanup
* work first and then return an error. */
AssertPtr(mSession);
int rc2 = mSession->fileRemoveFromList(this);
if (RT_SUCCESS(rc))
rc = rc2;
/*
* Release autocaller before calling uninit.
*/
autoCaller.release();
uninit();
LogFlowFuncLeaveRC(rc);
if (RT_FAILURE(rc))
{
if (rc == VERR_GSTCTL_GUEST_ERROR)
return GuestFile::setErrorExternal(this, guestRc);
return setError(VBOX_E_IPRT_ERROR,
tr("Closing guest file failed with %Rrc\n"), rc);
}
return S_OK;
#endif /* VBOX_WITH_GUEST_CONTROL */
}
STDMETHODIMP GuestFile::QueryInfo(IFsObjInfo **aInfo)
{
#ifndef VBOX_WITH_GUEST_CONTROL
ReturnComNotImplemented();
#else
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
ReturnComNotImplemented();
#endif /* VBOX_WITH_GUEST_CONTROL */
}
STDMETHODIMP GuestFile::Read(ULONG aToRead, ULONG aTimeoutMS, ComSafeArrayOut(BYTE, aData))
{
#ifndef VBOX_WITH_GUEST_CONTROL
ReturnComNotImplemented();
#else
if (aToRead == 0)
return setError(E_INVALIDARG, tr("The size to read is zero"));
CheckComArgOutSafeArrayPointerValid(aData);
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
com::SafeArray<BYTE> data((size_t)aToRead);
Assert(data.size() >= aToRead);
HRESULT hr = S_OK;
uint32_t cbRead;
int vrc = readData(aToRead, aTimeoutMS,
data.raw(), aToRead, &cbRead);
if (RT_SUCCESS(vrc))
{
if (data.size() != cbRead)
data.resize(cbRead);
data.detachTo(ComSafeArrayOutArg(aData));
}
else
{
switch (vrc)
{
default:
hr = setError(VBOX_E_IPRT_ERROR,
tr("Reading from file \"%s\" failed: %Rrc"),
mData.mOpenInfo.mFileName.c_str(), vrc);
break;
}
}
LogFlowThisFunc(("rc=%Rrc, cbRead=%RU64\n", vrc, cbRead));
LogFlowFuncLeaveRC(vrc);
return hr;
#endif /* VBOX_WITH_GUEST_CONTROL */
}
STDMETHODIMP GuestFile::ReadAt(LONG64 aOffset, ULONG aToRead, ULONG aTimeoutMS, ComSafeArrayOut(BYTE, aData))
{
#ifndef VBOX_WITH_GUEST_CONTROL
ReturnComNotImplemented();
#else
if (aToRead == 0)
return setError(E_INVALIDARG, tr("The size to read is zero"));
CheckComArgOutSafeArrayPointerValid(aData);
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
com::SafeArray<BYTE> data((size_t)aToRead);
Assert(data.size() >= aToRead);
HRESULT hr = S_OK;
size_t cbRead;
int vrc = readDataAt(aOffset, aToRead, aTimeoutMS,
data.raw(), aToRead, &cbRead);
if (RT_SUCCESS(vrc))
{
if (data.size() != cbRead)
data.resize(cbRead);
data.detachTo(ComSafeArrayOutArg(aData));
}
else
{
switch (vrc)
{
default:
hr = setError(VBOX_E_IPRT_ERROR,
tr("Reading from file \"%s\" (at offset %RU64) failed: %Rrc"),
mData.mOpenInfo.mFileName.c_str(), aOffset, vrc);
break;
}
}
LogFlowThisFunc(("rc=%Rrc, cbRead=%RU64\n", vrc, cbRead));
LogFlowFuncLeaveRC(vrc);
return hr;
#endif /* VBOX_WITH_GUEST_CONTROL */
}
STDMETHODIMP GuestFile::Seek(LONG64 aOffset, FileSeekType_T aType)
{
#ifndef VBOX_WITH_GUEST_CONTROL
ReturnComNotImplemented();
#else
LogFlowThisFuncEnter();
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
HRESULT hr = S_OK;
GUEST_FILE_SEEKTYPE eSeekType;
switch (aType)
{
case FileSeekType_Set:
eSeekType = GUEST_FILE_SEEKTYPE_BEGIN;
break;
case FileSeekType_Current:
eSeekType = GUEST_FILE_SEEKTYPE_CURRENT;
break;
default:
return setError(E_INVALIDARG, tr("Invalid seek type specified"));
break;
}
int vrc = seekAt(aOffset, eSeekType,
30 * 1000 /* 30s timeout */, NULL /* puOffset */);
if (RT_FAILURE(vrc))
{
switch (vrc)
{
default:
hr = setError(VBOX_E_IPRT_ERROR,
tr("Seeking file \"%s\" (to offset %RU64) failed: %Rrc"),
mData.mOpenInfo.mFileName.c_str(), aOffset, vrc);
break;
}
}
LogFlowFuncLeaveRC(vrc);
return hr;
#endif /* VBOX_WITH_GUEST_CONTROL */
}
STDMETHODIMP GuestFile::SetACL(IN_BSTR aACL)
{
#ifndef VBOX_WITH_GUEST_CONTROL
ReturnComNotImplemented();
#else
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
ReturnComNotImplemented();
#endif /* VBOX_WITH_GUEST_CONTROL */
}
STDMETHODIMP GuestFile::Write(ComSafeArrayIn(BYTE, aData), ULONG aTimeoutMS, ULONG *aWritten)
{
#ifndef VBOX_WITH_GUEST_CONTROL
ReturnComNotImplemented();
#else
LogFlowThisFuncEnter();
CheckComArgOutPointerValid(aWritten);
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
HRESULT hr = S_OK;
com::SafeArray<BYTE> data(ComSafeArrayInArg(aData));
int vrc = writeData(aTimeoutMS, data.raw(), (uint32_t)data.size(),
(uint32_t*)aWritten);
if (RT_FAILURE(vrc))
{
switch (vrc)
{
default:
hr = setError(VBOX_E_IPRT_ERROR,
tr("Writing to file \"%s\" failed: %Rrc"),
mData.mOpenInfo.mFileName.c_str(), vrc);
break;
}
}
LogFlowThisFunc(("rc=%Rrc, aWritten=%RU32\n", vrc, aWritten));
LogFlowFuncLeaveRC(vrc);
return hr;
#endif /* VBOX_WITH_GUEST_CONTROL */
}
STDMETHODIMP GuestFile::WriteAt(LONG64 aOffset, ComSafeArrayIn(BYTE, aData), ULONG aTimeoutMS, ULONG *aWritten)
{
#ifndef VBOX_WITH_GUEST_CONTROL
ReturnComNotImplemented();
#else
LogFlowThisFuncEnter();
CheckComArgOutPointerValid(aWritten);
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
HRESULT hr = S_OK;
com::SafeArray<BYTE> data(ComSafeArrayInArg(aData));
int vrc = writeData(aTimeoutMS, data.raw(), (uint32_t)data.size(),
(uint32_t*)aWritten);
if (RT_FAILURE(vrc))
{
switch (vrc)
{
default:
hr = setError(VBOX_E_IPRT_ERROR,
tr("Writing to file \"%s\" (at offset %RU64) failed: %Rrc"),
mData.mOpenInfo.mFileName.c_str(), aOffset, vrc);
break;
}
}
LogFlowThisFunc(("rc=%Rrc, aWritten=%RU32\n", vrc, aWritten));
LogFlowFuncLeaveRC(vrc);
return hr;
#endif /* VBOX_WITH_GUEST_CONTROL */
}