/* $Id: GuestSessionImpl.h 69496 2017-10-28 14:55:58Z vboxsync $ */ /** @file * VirtualBox Main - Guest session handling. */ /* * Copyright (C) 2012-2017 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. */ #ifndef ____H_GUESTSESSIONIMPL #define ____H_GUESTSESSIONIMPL #include "GuestSessionWrap.h" #include "EventImpl.h" #include "GuestCtrlImplPrivate.h" #include "GuestProcessImpl.h" #include "GuestDirectoryImpl.h" #include "GuestFileImpl.h" #include "GuestFsObjInfoImpl.h" #include "ThreadTask.h" #include /* For UpdateAdditions. */ class Guest; class GuestSessionTaskInternalOpen; /** * Abstract base class for a lenghtly per-session operation which * runs in a Main worker thread. */ class GuestSessionTask : public ThreadTask { public: GuestSessionTask(GuestSession *pSession); virtual ~GuestSessionTask(void); public: virtual int Run(void) = 0; void handler() { int vrc = Run(); NOREF(vrc); /** @todo * * r=bird: what was your idea WRT to Run status code and async tasks? * */ } int RunAsync(const Utf8Str &strDesc, ComObjPtr &pProgress); HRESULT Init(const Utf8Str &strTaskDesc) { HRESULT hr = S_OK; setTaskDesc(strTaskDesc); hr = createAndSetProgressObject(); return hr; } const ComObjPtr& GetProgressObject() const {return mProgress;} protected: int getGuestProperty(const ComObjPtr &pGuest, const Utf8Str &strPath, Utf8Str &strValue); int setProgress(ULONG uPercent); int setProgressSuccess(void); HRESULT setProgressErrorMsg(HRESULT hr, const Utf8Str &strMsg); inline void setTaskDesc(const Utf8Str &strTaskDesc) throw() { mDesc = strTaskDesc; } HRESULT createAndSetProgressObject(); protected: Utf8Str mDesc; GuestSession *mSession; /** Progress object for getting updated when running * asynchronously. Optional. */ ComObjPtr mProgress; }; /** * Task for opening a guest session. */ class SessionTaskOpen : public GuestSessionTask { public: SessionTaskOpen(GuestSession *pSession, uint32_t uFlags, uint32_t uTimeoutMS); virtual ~SessionTaskOpen(void); int Run(void); protected: /** Session creation flags. */ uint32_t mFlags; /** Session creation timeout (in ms). */ uint32_t mTimeoutMS; }; /** * Task for copying files from host to the guest. */ class SessionTaskCopyTo : public GuestSessionTask { public: SessionTaskCopyTo(GuestSession *pSession, const Utf8Str &strSource, const Utf8Str &strDest, uint32_t uFlags); SessionTaskCopyTo(GuestSession *pSession, PRTFILE pSourceFile, size_t cbSourceOffset, uint64_t cbSourceSize, const Utf8Str &strDest, uint32_t uFlags); virtual ~SessionTaskCopyTo(void); int Run(void); protected: Utf8Str mSource; PRTFILE mSourceFile; size_t mSourceOffset; uint64_t mSourceSize; Utf8Str mDest; uint32_t mCopyFileFlags; }; /** * Task for copying files from guest to the host. */ class SessionTaskCopyFrom : public GuestSessionTask { public: SessionTaskCopyFrom(GuestSession *pSession, const Utf8Str &strSource, const Utf8Str &strDest, uint32_t uFlags); virtual ~SessionTaskCopyFrom(void); int Run(void); protected: Utf8Str mSource; Utf8Str mDest; uint32_t mFlags; }; /** * Task for automatically updating the Guest Additions on the guest. */ class SessionTaskUpdateAdditions : public GuestSessionTask { public: SessionTaskUpdateAdditions(GuestSession *pSession, const Utf8Str &strSource, const ProcessArguments &aArguments, uint32_t uFlags); virtual ~SessionTaskUpdateAdditions(void); int Run(void); protected: /** * Suported OS types for automatic updating. */ enum eOSType { eOSType_Unknown = 0, eOSType_Windows = 1, eOSType_Linux = 2, eOSType_Solaris = 3 }; /** * Structure representing a file to * get off the .ISO, copied to the guest. */ struct InstallerFile { InstallerFile(const Utf8Str &aSource, const Utf8Str &aDest, uint32_t aFlags = 0) : strSource(aSource), strDest(aDest), fFlags(aFlags) { } InstallerFile(const Utf8Str &aSource, const Utf8Str &aDest, uint32_t aFlags, const GuestProcessStartupInfo &aStartupInfo) : strSource(aSource), strDest(aDest), fFlags(aFlags), mProcInfo(aStartupInfo) { mProcInfo.mExecutable = strDest; if (mProcInfo.mName.isEmpty()) mProcInfo.mName = strDest; } /** Source file on .ISO. */ Utf8Str strSource; /** Destination file on the guest. */ Utf8Str strDest; /** File flags. */ uint32_t fFlags; /** Optional arguments if this file needs to be * executed. */ GuestProcessStartupInfo mProcInfo; }; int i_addProcessArguments(ProcessArguments &aArgumentsDest, const ProcessArguments &aArgumentsSource); int i_copyFileToGuest(GuestSession *pSession, PRTISOFSFILE pISO, Utf8Str const &strFileSource, const Utf8Str &strFileDest, bool fOptional, uint32_t *pcbSize); int i_runFileOnGuest(GuestSession *pSession, GuestProcessStartupInfo &procInfo); /** Files to handle. */ std::vector mFiles; /** The (optionally) specified Guest Additions .ISO on the host * which will be used for the updating process. */ Utf8Str mSource; /** (Optional) installer command line arguments. */ ProcessArguments mArguments; /** Update flags. */ uint32_t mFlags; }; /** * Guest session implementation. */ class ATL_NO_VTABLE GuestSession : public GuestSessionWrap, public GuestBase { public: /** @name COM and internal init/term/mapping cruft. * @{ */ DECLARE_EMPTY_CTOR_DTOR(GuestSession) int init(Guest *pGuest, const GuestSessionStartupInfo &ssInfo, const GuestCredentials &guestCreds); void uninit(void); HRESULT FinalConstruct(void); void FinalRelease(void); /** @} */ private: /** Wrapped @name IGuestSession properties. * @{ */ HRESULT getUser(com::Utf8Str &aUser); HRESULT getDomain(com::Utf8Str &aDomain); HRESULT getName(com::Utf8Str &aName); HRESULT getId(ULONG *aId); HRESULT getTimeout(ULONG *aTimeout); HRESULT setTimeout(ULONG aTimeout); HRESULT getProtocolVersion(ULONG *aProtocolVersion); HRESULT getStatus(GuestSessionStatus_T *aStatus); HRESULT getEnvironmentChanges(std::vector &aEnvironmentChanges); HRESULT setEnvironmentChanges(const std::vector &aEnvironmentChanges); HRESULT getEnvironmentBase(std::vector &aEnvironmentBase); HRESULT getProcesses(std::vector > &aProcesses); HRESULT getPathStyle(PathStyle_T *aPathStyle); HRESULT getCurrentDirectory(com::Utf8Str &aCurrentDirectory); HRESULT setCurrentDirectory(const com::Utf8Str &aCurrentDirectory); HRESULT getDirectories(std::vector > &aDirectories); HRESULT getFiles(std::vector > &aFiles); HRESULT getEventSource(ComPtr &aEventSource); /** @} */ /** Wrapped @name IGuestSession methods. * @{ */ HRESULT close(); HRESULT directoryCopy(const com::Utf8Str &aSource, const com::Utf8Str &aDestination, const std::vector &aFlags, ComPtr &aProgress); HRESULT directoryCopyFromGuest(const com::Utf8Str &aSource, const com::Utf8Str &aDestination, const std::vector &aFlags, ComPtr &aProgress); HRESULT directoryCopyToGuest(const com::Utf8Str &aSource, const com::Utf8Str &aDestination, const std::vector &aFlags, ComPtr &aProgress); HRESULT directoryCreate(const com::Utf8Str &aPath, ULONG aMode, const std::vector &aFlags); HRESULT directoryCreateTemp(const com::Utf8Str &aTemplateName, ULONG aMode, const com::Utf8Str &aPath, BOOL aSecure, com::Utf8Str &aDirectory); HRESULT directoryExists(const com::Utf8Str &aPath, BOOL aFollowSymlinks, BOOL *aExists); HRESULT directoryOpen(const com::Utf8Str &aPath, const com::Utf8Str &aFilter, const std::vector &aFlags, ComPtr &aDirectory); HRESULT directoryRemove(const com::Utf8Str &aPath); HRESULT directoryRemoveRecursive(const com::Utf8Str &aPath, const std::vector &aFlags, ComPtr &aProgress); HRESULT environmentScheduleSet(const com::Utf8Str &aName, const com::Utf8Str &aValue); HRESULT environmentScheduleUnset(const com::Utf8Str &aName); HRESULT environmentGetBaseVariable(const com::Utf8Str &aName, com::Utf8Str &aValue); HRESULT environmentDoesBaseVariableExist(const com::Utf8Str &aName, BOOL *aExists); HRESULT fileCopy(const com::Utf8Str &aSource, const com::Utf8Str &aDestination, const std::vector &aFlags, ComPtr &aProgress); HRESULT fileCopyToGuest(const com::Utf8Str &aSource, const com::Utf8Str &aDestination, const std::vector &aFlags, ComPtr &aProgress); HRESULT fileCopyFromGuest(const com::Utf8Str &aSource, const com::Utf8Str &aDestination, const std::vector &aFlags, ComPtr &aProgress); HRESULT fileCreateTemp(const com::Utf8Str &aTemplateName, ULONG aMode, const com::Utf8Str &aPath, BOOL aSecure, ComPtr &aFile); HRESULT fileExists(const com::Utf8Str &aPath, BOOL aFollowSymlinks, BOOL *aExists); HRESULT fileOpen(const com::Utf8Str &aPath, FileAccessMode_T aAccessMode, FileOpenAction_T aOpenAction, ULONG aCreationMode, ComPtr &aFile); HRESULT fileOpenEx(const com::Utf8Str &aPath, FileAccessMode_T aAccessMode, FileOpenAction_T aOpenAction, FileSharingMode_T aSharingMode, ULONG aCreationMode, const std::vector &aFlags, ComPtr &aFile); HRESULT fileQuerySize(const com::Utf8Str &aPath, BOOL aFollowSymlinks, LONG64 *aSize); HRESULT fsObjExists(const com::Utf8Str &aPath, BOOL aFollowSymlinks, BOOL *pfExists); HRESULT fsObjQueryInfo(const com::Utf8Str &aPath, BOOL aFollowSymlinks, ComPtr &aInfo); HRESULT fsObjRemove(const com::Utf8Str &aPath); HRESULT fsObjRename(const com::Utf8Str &aOldPath, const com::Utf8Str &aNewPath, const std::vector &aFlags); HRESULT fsObjMove(const com::Utf8Str &aSource, const com::Utf8Str &aDestination, const std::vector &aFlags, ComPtr &aProgress); HRESULT fsObjSetACL(const com::Utf8Str &aPath, BOOL aFollowSymlinks, const com::Utf8Str &aAcl, ULONG aMode); HRESULT processCreate(const com::Utf8Str &aCommand, const std::vector &aArguments, const std::vector &aEnvironment, const std::vector &aFlags, ULONG aTimeoutMS, ComPtr &aGuestProcess); HRESULT processCreateEx(const com::Utf8Str &aCommand, const std::vector &aArguments, const std::vector &aEnvironment, const std::vector &aFlags, ULONG aTimeoutMS, ProcessPriority_T aPriority, const std::vector &aAffinity, ComPtr &aGuestProcess); HRESULT processGet(ULONG aPid, ComPtr &aGuestProcess); HRESULT symlinkCreate(const com::Utf8Str &aSource, const com::Utf8Str &aTarget, SymlinkType_T aType); HRESULT symlinkExists(const com::Utf8Str &aSymlink, BOOL *aExists); HRESULT symlinkRead(const com::Utf8Str &aSymlink, const std::vector &aFlags, com::Utf8Str &aTarget); HRESULT waitFor(ULONG aWaitFor, ULONG aTimeoutMS, GuestSessionWaitResult_T *aReason); HRESULT waitForArray(const std::vector &aWaitFor, ULONG aTimeoutMS, GuestSessionWaitResult_T *aReason); /** @} */ /** Map of guest directories. The key specifies the internal directory ID. */ typedef std::map > SessionDirectories; /** Map of guest files. The key specifies the internal file ID. */ typedef std::map > SessionFiles; /** Map of guest processes. The key specifies the internal process number. * To retrieve the process' guest PID use the Id() method of the IProcess interface. */ typedef std::map > SessionProcesses; public: /** @name Public internal methods. * @todo r=bird: Most of these are public for no real reason... * @{ */ int i_closeSession(uint32_t uFlags, uint32_t uTimeoutMS, int *pGuestRc); inline bool i_directoryExists(uint32_t uDirID, ComObjPtr *pDir); int i_directoryRemoveFromList(GuestDirectory *pDirectory); int i_directoryRemoveInternal(const Utf8Str &strPath, uint32_t uFlags, int *pGuestRc); int i_directoryCreateInternal(const Utf8Str &strPath, uint32_t uMode, uint32_t uFlags, int *pGuestRc); int i_objectCreateTempInternal(const Utf8Str &strTemplate, const Utf8Str &strPath, bool fDirectory, Utf8Str &strName, int *pGuestRc); int i_directoryOpenInternal(const GuestDirectoryOpenInfo &openInfo, ComObjPtr &pDirectory, int *pGuestRc); int i_directoryQueryInfoInternal(const Utf8Str &strPath, bool fFollowSymlinks, GuestFsObjData &objData, int *pGuestRc); int i_dispatchToDirectory(PVBOXGUESTCTRLHOSTCBCTX pCtxCb, PVBOXGUESTCTRLHOSTCALLBACK pSvcCb); int i_dispatchToFile(PVBOXGUESTCTRLHOSTCBCTX pCtxCb, PVBOXGUESTCTRLHOSTCALLBACK pSvcCb); int i_dispatchToObject(PVBOXGUESTCTRLHOSTCBCTX pCtxCb, PVBOXGUESTCTRLHOSTCALLBACK pSvcCb); int i_dispatchToProcess(PVBOXGUESTCTRLHOSTCBCTX pCtxCb, PVBOXGUESTCTRLHOSTCALLBACK pSvcCb); int i_dispatchToThis(PVBOXGUESTCTRLHOSTCBCTX pCtxCb, PVBOXGUESTCTRLHOSTCALLBACK pSvcCb); inline bool i_fileExists(uint32_t uFileID, ComObjPtr *pFile); int i_fileRemoveFromList(GuestFile *pFile); int i_fileRemoveInternal(const Utf8Str &strPath, int *pGuestRc); int i_fileOpenInternal(const GuestFileOpenInfo &openInfo, ComObjPtr &pFile, int *pGuestRc); int i_fileQueryInfoInternal(const Utf8Str &strPath, bool fFollowSymlinks, GuestFsObjData &objData, int *pGuestRc); int i_fileQuerySizeInternal(const Utf8Str &strPath, bool fFollowSymlinks, int64_t *pllSize, int *pGuestRc); int i_fsQueryInfoInternal(const Utf8Str &strPath, bool fFollowSymlinks, GuestFsObjData &objData, int *pGuestRc); const GuestCredentials &i_getCredentials(void); EventSource *i_getEventSource(void) { return mEventSource; } Utf8Str i_getName(void); ULONG i_getId(void) { return mData.mSession.mID; } static Utf8Str i_guestErrorToString(int guestRc); HRESULT i_isReadyExternal(void); int i_onRemove(void); int i_onSessionStatusChange(PVBOXGUESTCTRLHOSTCBCTX pCbCtx, PVBOXGUESTCTRLHOSTCALLBACK pSvcCbData); int i_startSessionInternal(int *pGuestRc); int i_startSessionAsync(void); static void i_startSessionThreadTask(GuestSessionTaskInternalOpen *pTask); Guest *i_getParent(void) { return mParent; } uint32_t i_getProtocolVersion(void) { return mData.mProtocolVersion; } int i_pathRenameInternal(const Utf8Str &strSource, const Utf8Str &strDest, uint32_t uFlags, int *pGuestRc); int i_processRemoveFromList(GuestProcess *pProcess); int i_processCreateExInternal(GuestProcessStartupInfo &procInfo, ComObjPtr &pProgress); inline bool i_processExists(uint32_t uProcessID, ComObjPtr *pProcess); inline int i_processGetByPID(ULONG uPID, ComObjPtr *pProcess); int i_sendCommand(uint32_t uFunction, uint32_t uParms, PVBOXHGCMSVCPARM paParms); static HRESULT i_setErrorExternal(VirtualBoxBase *pInterface, int guestRc); int i_setSessionStatus(GuestSessionStatus_T sessionStatus, int sessionRc); int i_signalWaiters(GuestSessionWaitResult_T enmWaitResult, int rc /*= VINF_SUCCESS */); int i_determineProtocolVersion(void); int i_waitFor(uint32_t fWaitFlags, ULONG uTimeoutMS, GuestSessionWaitResult_T &waitResult, int *pGuestRc); int i_waitForStatusChange(GuestWaitEvent *pEvent, uint32_t fWaitFlags, uint32_t uTimeoutMS, GuestSessionStatus_T *pSessionStatus, int *pGuestRc); /** @} */ private: /** Pointer to the parent (Guest). */ Guest *mParent; /** * The session's event source. This source is used for * serving the internal listener as well as all other * external listeners that may register to it. * * Note: This can safely be used without holding any locks. * An AutoCaller suffices to prevent it being destroy while in use and * internally there is a lock providing the necessary serialization. */ const ComObjPtr mEventSource; struct Data { /** The session credentials. */ GuestCredentials mCredentials; /** The session's startup info. */ GuestSessionStartupInfo mSession; /** The session's current status. */ GuestSessionStatus_T mStatus; /** The set of environment changes for the session for use when * creating new guest processes. */ GuestEnvironmentChanges mEnvironmentChanges; /** Pointer to the immutable base environment for the session. * @note This is not allocated until the guest reports it to the host. It is * also shared with child processes. */ GuestEnvironment const *mpBaseEnvironment; /** Directory objects bound to this session. */ SessionDirectories mDirectories; /** File objects bound to this session. */ SessionFiles mFiles; /** Process objects bound to this session. */ SessionProcesses mProcesses; /** Guest control protocol version to be used. * Guest Additions < VBox 4.3 have version 1, * any newer version will have version 2. */ uint32_t mProtocolVersion; /** Session timeout (in ms). */ uint32_t mTimeout; /** Total number of session objects (processes, * files, ...). */ uint32_t mNumObjects; /** The last returned session status * returned from the guest side. */ int mRC; Data(void) : mpBaseEnvironment(NULL) { } Data(const Data &rThat) : mCredentials(rThat.mCredentials) , mSession(rThat.mSession) , mStatus(rThat.mStatus) , mEnvironmentChanges(rThat.mEnvironmentChanges) , mpBaseEnvironment(NULL) , mDirectories(rThat.mDirectories) , mFiles(rThat.mFiles) , mProcesses(rThat.mProcesses) , mProtocolVersion(rThat.mProtocolVersion) , mTimeout(rThat.mTimeout) , mNumObjects(rThat.mNumObjects) , mRC(rThat.mRC) { } ~Data(void) { if (mpBaseEnvironment) { mpBaseEnvironment->releaseConst(); mpBaseEnvironment = NULL; } } } mData; }; #endif /* !____H_GUESTSESSIONIMPL */