GuestControlSvc.h revision 96ceb3a26c92d45834d00c86eca5c2e7adbde009
/** @file
* Guest control service - Common header for host service and guest clients.
*/
/*
* Copyright (C) 2010 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* 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.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
* VirtualBox OSE distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*/
#include <VBox/VBoxGuest2.h>
/* Everything defined in this file lives in this namespace. */
/******************************************************************************
* Typedefs, constants and inlines *
******************************************************************************/
/**
* Process status when executed in the guest.
*/
enum eProcessStatus
{
/** Process is in an undefined state. */
PROC_STS_UNDEFINED = 0,
/** Process has been started. */
PROC_STS_STARTED = 1,
/** Process terminated normally. */
PROC_STS_TEN = 2,
/** Process terminated via signal. */
PROC_STS_TES = 3,
/** Process terminated abnormally. */
PROC_STS_TEA = 4,
/** Process timed out and was killed. */
PROC_STS_TOK = 5,
/** Process timed out and was not killed successfully. */
PROC_STS_TOA = 6,
PROC_STS_DWN = 7,
/** Something went wrong (error code in flags). */
PROC_STS_ERROR = 8
};
/**
* Input flags, set by the host. This is needed for
* handling flags on the guest side.
* Note: Has to match Main's ProcessInputFlag_* flags!
*/
#define INPUT_FLAG_NONE 0
#define INPUT_FLAG_EOF RT_BIT(0)
/** @name Internal tools built into VBoxService which are used in order to
* accomplish tasks host<->guest.
* @{
*/
#define VBOXSERVICE_TOOL_CAT "vbox_cat"
#define VBOXSERVICE_TOOL_MKDIR "vbox_mkdir"
/** @} */
/**
* Input status, reported by the client.
*/
enum eInputStatus
{
/** Input is in an undefined state. */
INPUT_STS_UNDEFINED = 0,
/** Input was written (partially, see cbProcessed). */
INPUT_STS_WRITTEN = 1,
/** Input failed with an error (see flags for rc). */
INPUT_STS_ERROR = 20,
/** Process has abandoned / terminated input handling. */
INPUT_STS_TERMINATED = 21,
/** Too much input data. */
INPUT_STS_OVERFLOW = 30
};
/**
* Document me.
*/
typedef struct VBoxGuestCtrlCallbackHeader
{
/** Magic number to identify the structure. */
/** Context ID to identify callback data. */
typedef CALLBACKHEADER *PCALLBACKHEADER;
/**
* Data structure to pass to the service extension callback. We use this to
* notify the host of changes to properties.
*/
typedef struct VBoxGuestCtrlCallbackDataExecStatus
{
/** Callback data header. */
/** The process ID (PID). */
/** The process status. */
/** Optional flags, varies, based on u32Status. */
/** Optional data buffer (not used atm). */
void *pvData;
/** Size of optional data buffer (not used atm). */
typedef struct VBoxGuestCtrlCallbackDataExecOut
{
/** Callback data header. */
/** The process ID (PID). */
/** Optional flags (not used atm). */
/** Optional data buffer. */
void *pvData;
/** Size (in bytes) of optional data buffer. */
typedef CALLBACKDATAEXECOUT *PCALLBACKDATAEXECOUT;
typedef struct VBoxGuestCtrlCallbackDataExecInStatus
{
/** Callback data header. */
/** The process ID (PID). */
/** Current input status. */
/** Optional flags. */
/** Size (in bytes) of processed input data. */
typedef struct VBoxGuestCtrlCallbackDataClientDisconnected
{
/** Callback data header. */
enum
{
/** Magic number for sanity checking the CALLBACKDATACLIENTDISCONNECTED structure. */
CALLBACKDATAMAGICCLIENTDISCONNECTED = 0x08041984,
/** Magic number for sanity checking the CALLBACKDATAEXECSTATUS structure. */
CALLBACKDATAMAGICEXECSTATUS = 0x26011982,
/** Magic number for sanity checking the CALLBACKDATAEXECOUT structure. */
CALLBACKDATAMAGICEXECOUT = 0x11061949,
/** Magic number for sanity checking the CALLBACKDATAEXECIN structure. */
CALLBACKDATAMAGICEXECINSTATUS = 0x19091951
};
{
};
/**
* The service functions which are callable by host.
*/
enum eHostFn
{
/**
* The host asks the client to cancel all pending waits and exit.
*/
/**
* The host wants to execute something in the guest. This can be a command line
* or starting a program.
*/
HOST_EXEC_CMD = 100,
/**
* Sends input data for stdin to a running process executed by HOST_EXEC_CMD.
*/
HOST_EXEC_SET_INPUT = 101,
/**
* Gets the current status of a running process, e.g.
*/
HOST_EXEC_GET_OUTPUT = 102
};
/**
* The service functions which are called by guest. The numbers may not change,
* so we hardcode them.
*/
enum eGuestFn
{
/**
* Guest waits for a new message the host wants to process on the guest side.
* This is a blocking call and can be deferred.
*/
GUEST_GET_HOST_MSG = 1,
/**
* Guest asks the host to cancel all pending waits the guest itself waits on.
* This becomes necessary when the guest wants to quit but still waits for
* commands from the host.
*/
/**
* Guest disconnected (terminated normally or due to a crash HGCM
* detected when calling service::clientDisconnect().
*/
GUEST_DISCONNECTED = 3,
/**
* Guests sends output from an executed process.
*/
GUEST_EXEC_SEND_OUTPUT = 100,
/**
* Guest sends a status update of an executed process to the host.
*/
GUEST_EXEC_SEND_STATUS = 101,
/**
* Guests sends an input status notification to the host.
*/
};
/*
* HGCM parameter structures.
*/
#pragma pack (1)
typedef struct VBoxGuestCtrlHGCMMsgType
{
/**
* The returned command the host wants to
* run on the guest.
*/
/** Number of parameters the message needs. */
/**
* Asks the guest control host service to cancel all pending (outstanding)
* waits which were not processed yet. This is handy for a graceful shutdown.
*/
typedef struct VBoxGuestCtrlHGCMMsgCancelPendingWaits
{
/**
* Executes a command inside the guest.
*/
typedef struct VBoxGuestCtrlHGCMMsgExecCmd
{
/** Context ID. */
/** The command to execute on the guest. */
/** Execution flags (see IGuest::ExecuteProcessFlag_*). */
/** Number of arguments. */
/** The actual arguments. */
/** Number of environment value pairs. */
/** Size (in bytes) of environment block, including terminating zeros. */
/** The actual environment block. */
/** The user name to run the executed command under. */
/** The user's password. */
/** Timeout (in msec) which either specifies the
* overall lifetime of the process or how long it
* can take to bring the process up and running -
* (depends on the IGuest::ExecuteProcessFlag_*). */
/**
* Injects input to a previously executed process via stdin.
*/
typedef struct VBoxGuestCtrlHGCMMsgExecIn
{
/** Context ID. */
/** The process ID (PID) to send the input to. */
/** Input flags (see IGuest::ProcessInputFlag_*). */
/** Data buffer. */
/** Actual size of data (in bytes). */
typedef struct VBoxGuestCtrlHGCMMsgExecOut
{
/** Context ID. */
/** The process ID (PID). */
/** Optional flags. */
/** Data buffer. */
typedef struct VBoxGuestCtrlHGCMMsgExecStatus
{
/** Context ID. */
/** The process ID (PID). */
/** The process status. */
/** Optional flags (based on status). */
/** Optional data buffer (not used atm). */
typedef struct VBoxGuestCtrlHGCMMsgExecStatusIn
{
/** Context ID. */
/** The process ID (PID). */
/** Status of the operation. */
/** Optional flags. */
/** Data written. */
#pragma pack ()
/**
* Structure for buffering execution requests in the host service.
*/
typedef struct VBoxGuestCtrlParamBuffer
{
} /* namespace guestControl */
#endif /* !___VBox_HostService_GuestControlService_h */