VBoxServiceInternal.h revision a7014c99617f226a35a6a46a5b4bddcc6e0c17e0
/* $Id$ */
/** @file
* VBoxService - Guest Additions Services.
*/
/*
* Copyright (C) 2007-2011 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.
*/
#ifndef ___VBoxServiceInternal_h
#define ___VBoxServiceInternal_h
#include <stdio.h>
#ifdef RT_OS_WINDOWS
# include <Windows.h>
# include <process.h> /* Needed for file version information. */
#endif
#include <iprt/critsect.h>
#include <VBox/VBoxGuestLib.h>
/**
* A service descriptor.
*/
typedef struct
{
/** The short service name. */
const char *pszName;
/** The longer service name. */
const char *pszDescription;
/** The usage options stuff for the --help screen. */
const char *pszUsage;
/** The option descriptions for the --help screen. */
const char *pszOptions;
/**
* Called before parsing arguments.
* @returns VBox status code.
*/
DECLCALLBACKMEMBER(int, pfnPreInit)(void);
/**
* Tries to parse the given command line option.
*
* @returns 0 if we parsed, -1 if it didn't and anything else means exit.
* @param ppszShort If not NULL it points to the short option iterator. a short argument.
* If NULL examine argv[*pi].
* @param argc The argument count.
* @param argv The argument vector.
* @param pi The argument vector index. Update if any value(s) are eaten.
*/
/**
* Called before parsing arguments.
* @returns VBox status code.
*/
DECLCALLBACKMEMBER(int, pfnInit)(void);
/** Called from the worker thread.
*
* @returns VBox status code.
* @retval VINF_SUCCESS if exitting because *pfTerminate was set.
* @param pfTerminate Pointer to a per service termination flag to check
* before and after blocking.
*/
/**
* Stop an service.
*/
DECLCALLBACKMEMBER(void, pfnStop)(void);
/**
* Does termination cleanups.
*
* @remarks This may be called even if pfnInit hasn't been called!
*/
DECLCALLBACKMEMBER(void, pfnTerm)(void);
} VBOXSERVICE;
/** Pointer to a VBOXSERVICE. */
typedef VBOXSERVICE *PVBOXSERVICE;
/** Pointer to a const VBOXSERVICE. */
typedef VBOXSERVICE const *PCVBOXSERVICE;
/** The service name.
* @note Used on windows to name the service as well as the global mutex. */
#define VBOXSERVICE_NAME "VBoxService"
#ifdef RT_OS_WINDOWS
/** The friendly service name. */
# define VBOXSERVICE_FRIENDLY_NAME "VirtualBox Guest Additions Service"
/** The service description (only W2K+ atm) */
# define VBOXSERVICE_DESCRIPTION "Manages VM runtime information, time synchronization, guest control execution and miscellaneous utilities for guest operating systems."
/** The following constant may be defined by including NtStatus.h. */
#endif /* RT_OS_WINDOWS */
#ifdef VBOX_WITH_GUEST_CONTROL
/**
* Pipe IDs for handling the guest process poll set.
*/
typedef enum VBOXSERVICECTRLPIPEID
{
/** Pipe for reading from guest process' stdout. */
/** Pipe for reading from guest process' stderr. */
/** Notification pipe for waking up the guest process
* control thread. */
/**
* Request types to perform on a started guest process.
*/
typedef enum VBOXSERVICECTRLREQUESTTYPE
{
/** Unknown request. */
/** Main control thread asked used to quit. */
/** Performs reading from stdout. */
/** Performs reading from stderr. */
/** Performs writing to stdin. */
/** Same as VBOXSERVICECTRLREQUEST_STDIN_WRITE, but
* marks the end of input. */
* @todo Implement this! */
/** Gently ask process to terminate.
* @todo Implement this! */
/** Ask the process in which status it
* currently is.
* @todo Implement this! */
/**
* Structure to perform a request on a started guest
* process. Needed for letting the main guest control thread
* to communicate (and wait) for a certain operation which
* will be done in context of the started guest process thread.
*/
typedef struct VBOXSERVICECTRLREQUEST
{
/** Event semaphore to serialize access. */
/** The request type to handle. */
/** Payload size; on input, this contains the (maximum) amount
* of data the caller wants to write or to read. On output,
void *pvData;
/** The context ID which is required to complete the
* request. Not used at the moment. */
/** The overall result of the operation. */
int rc;
/** Pointer to request. */
/**
* Structure for holding data for one (started) guest process.
*/
typedef struct VBOXSERVICECTRLTHREAD
{
/** Node. */
/** The worker thread. */
/** Shutdown indicator; will be set when the thread
* needs (or is asked) to shutdown. */
bool volatile fShutdown;
/** Indicator set by the service thread exiting. */
bool volatile fStopped;
/** Whether the service was started or not. */
bool fStarted;
/** Client ID. */
/** Context ID. */
/** Critical section for thread-safe use. */
/** @todo Document me! */
char *pszCmd;
char **papszArgs;
char **papszEnv;
/** Name of specified user account to run the
* guest process under. */
char *pszUser;
/** Password of specified user account. */
char *pszPassword;
/** Overall time limit (in ms) that the guest process
* is allowed to run. 0 for indefinite time. */
/** Pointer to the current IPC request being
* processed. */
/** StdIn pipe for addressing writes to the
* guest process' stdin.*/
/** The notification pipe associated with this guest process.
* This is NIL_RTPIPE for output pipes. */
/** The other end of hNotificationPipeW. */
/** Pointer to thread data. */
typedef VBOXSERVICECTRLTHREAD *PVBOXSERVICECTRLTHREAD;
#endif /* VBOX_WITH_GUEST_CONTROL */
#ifdef VBOX_WITH_GUEST_PROPS
/**
* A guest property cache.
*/
typedef struct VBOXSERVICEVEPROPCACHE
{
/** The client ID for HGCM communication. */
/** Head in a list of VBOXSERVICEVEPROPCACHEENTRY nodes. */
/** Critical section for thread-safe use. */
/** Pointer to a guest property cache. */
/**
* An entry in the property cache (VBOXSERVICEVEPROPCACHE).
*/
typedef struct VBOXSERVICEVEPROPCACHEENTRY
{
/** Node to successor.
* @todo r=bird: This is not really the node to the successor, but
* rather the OUR node in the list. If it helps, remember that
* its a doubly linked list. */
/** Name (and full path) of guest property. */
char *pszName;
/** The last value stored (for reference). */
char *pszValue;
/** Reset value to write if property is temporary. If NULL, it will be
* deleted. */
char *pszValueReset;
/** Flags. */
/** Pointer to a cached guest property. */
#endif /* VBOX_WITH_GUEST_PROPS */
extern char *g_pszProgName;
extern int g_cVerbosity;
extern uint32_t g_DefaultInterval;
extern VBOXSERVICE g_TimeSync;
extern VBOXSERVICE g_Clipboard;
extern VBOXSERVICE g_Control;
extern VBOXSERVICE g_VMInfo;
extern VBOXSERVICE g_CpuHotPlug;
#ifdef VBOXSERVICE_MANAGEMENT
extern VBOXSERVICE g_MemBalloon;
extern VBOXSERVICE g_VMStatistics;
#endif
#ifdef VBOX_WITH_PAGE_SHARING
extern VBOXSERVICE g_PageSharing;
#endif
#ifdef VBOX_WITH_SHARED_FOLDERS
extern VBOXSERVICE g_AutoMount;
#endif
#ifdef DEBUG
#endif
extern int VBoxServiceStartServices(void);
extern int VBoxServiceStopServices(void);
extern void VBoxServiceMainWait(void);
#ifdef RT_OS_WINDOWS
extern RTEXITCODE VBoxServiceWinInstall(void);
extern RTEXITCODE VBoxServiceWinUninstall(void);
extern RTEXITCODE VBoxServiceWinEnterCtrlDispatcher(void);
#endif
#ifdef VBOXSERVICE_TOOLBOX
#endif
#ifdef RT_OS_WINDOWS
# ifdef VBOX_WITH_GUEST_PROPS
# endif /* VBOX_WITH_GUEST_PROPS */
#endif /* RT_OS_WINDOWS */
#ifdef VBOX_WITH_GUEST_CONTROL
/* Guest control functions. */
/* Guest process functions. */
void* pbData,
extern int VBoxServiceControlThreadWaitForShutdown(const PVBOXSERVICECTRLTHREAD pThread, RTMSINTERVAL msTimeout);
#endif /* VBOX_WITH_GUEST_CONTROL */
#ifdef VBOXSERVICE_MANAGEMENT
#endif
#if defined(VBOX_WITH_PAGE_SHARING) && defined(RT_OS_WINDOWS)
extern RTEXITCODE VBoxServicePageSharingInitFork(void);
#endif
#endif