| 1 | /* $Id: VBoxServiceInternal.h 21167 2009-07-02 14:11:15Z vboxsync $ */
|
|---|
| 2 | /** @file
|
|---|
| 3 | * VBoxService - Guest Additions Services.
|
|---|
| 4 | */
|
|---|
| 5 |
|
|---|
| 6 | /*
|
|---|
| 7 | * Copyright (C) 2007-2009 Sun Microsystems, Inc.
|
|---|
| 8 | *
|
|---|
| 9 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
|---|
| 10 | * available from http://www.virtualbox.org. This file is free software;
|
|---|
| 11 | * you can redistribute it and/or modify it under the terms of the GNU
|
|---|
| 12 | * General Public License (GPL) as published by the Free Software
|
|---|
| 13 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
|---|
| 14 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
|---|
| 15 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
|---|
| 16 | *
|
|---|
| 17 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
|
|---|
| 18 | * Clara, CA 95054 USA or visit http://www.sun.com if you need
|
|---|
| 19 | * additional information or have any questions.
|
|---|
| 20 | */
|
|---|
| 21 |
|
|---|
| 22 | #ifndef ___VBoxServiceInternal_h
|
|---|
| 23 | #define ___VBoxServiceInternal_h
|
|---|
| 24 |
|
|---|
| 25 | #include <stdio.h>
|
|---|
| 26 | #ifdef RT_OS_WINDOWS
|
|---|
| 27 | # include <Windows.h>
|
|---|
| 28 | # include <tchar.h> /**@todo just drop this, this will be compiled as UTF-8/ANSI. */
|
|---|
| 29 | # include <process.h> /**@todo what's this here for? */
|
|---|
| 30 | #endif
|
|---|
| 31 |
|
|---|
| 32 | /**
|
|---|
| 33 | * A service descriptor.
|
|---|
| 34 | */
|
|---|
| 35 | typedef struct
|
|---|
| 36 | {
|
|---|
| 37 | /** The short service name. */
|
|---|
| 38 | const char *pszName;
|
|---|
| 39 | /** The longer service name. */
|
|---|
| 40 | const char *pszDescription;
|
|---|
| 41 | /** The usage options stuff for the --help screen. */
|
|---|
| 42 | const char *pszUsage;
|
|---|
| 43 | /** The option descriptions for the --help screen. */
|
|---|
| 44 | const char *pszOptions;
|
|---|
| 45 |
|
|---|
| 46 | /**
|
|---|
| 47 | * Called before parsing arguments.
|
|---|
| 48 | * @returns VBox status code.
|
|---|
| 49 | */
|
|---|
| 50 | DECLCALLBACKMEMBER(int, pfnPreInit)(void);
|
|---|
| 51 |
|
|---|
| 52 | /**
|
|---|
| 53 | * Tries to parse the given command line option.
|
|---|
| 54 | *
|
|---|
| 55 | * @returns 0 if we parsed, -1 if it didn't and anything else means exit.
|
|---|
| 56 | * @param ppszShort If not NULL it points to the short option iterator. a short argument.
|
|---|
| 57 | * If NULL examine argv[*pi].
|
|---|
| 58 | * @param argc The argument count.
|
|---|
| 59 | * @param argv The argument vector.
|
|---|
| 60 | * @param pi The argument vector index. Update if any value(s) are eaten.
|
|---|
| 61 | */
|
|---|
| 62 | DECLCALLBACKMEMBER(int, pfnOption)(const char **ppszShort, int argc, char **argv, int *pi);
|
|---|
| 63 |
|
|---|
| 64 | /**
|
|---|
| 65 | * Called before parsing arguments.
|
|---|
| 66 | * @returns VBox status code.
|
|---|
| 67 | */
|
|---|
| 68 | DECLCALLBACKMEMBER(int, pfnInit)(void);
|
|---|
| 69 |
|
|---|
| 70 | /** Called from the worker thread.
|
|---|
| 71 | *
|
|---|
| 72 | * @returns VBox status code.
|
|---|
| 73 | * @retval VINF_SUCCESS if exitting because *pfTerminate was set.
|
|---|
| 74 | * @param pfTerminate Pointer to a per service termination flag to check
|
|---|
| 75 | * before and after blocking.
|
|---|
| 76 | */
|
|---|
| 77 | DECLCALLBACKMEMBER(int, pfnWorker)(bool volatile *pfTerminate);
|
|---|
| 78 |
|
|---|
| 79 | /**
|
|---|
| 80 | * Stop an service.
|
|---|
| 81 | */
|
|---|
| 82 | DECLCALLBACKMEMBER(void, pfnStop)(void);
|
|---|
| 83 |
|
|---|
| 84 | /**
|
|---|
| 85 | * Does termination cleanups.
|
|---|
| 86 | *
|
|---|
| 87 | * @remarks This may be called even if pfnInit hasn't been called!
|
|---|
| 88 | */
|
|---|
| 89 | DECLCALLBACKMEMBER(void, pfnTerm)(void);
|
|---|
| 90 | } VBOXSERVICE;
|
|---|
| 91 | /** Pointer to a VBOXSERVICE. */
|
|---|
| 92 | typedef VBOXSERVICE *PVBOXSERVICE;
|
|---|
| 93 | /** Pointer to a const VBOXSERVICE. */
|
|---|
| 94 | typedef VBOXSERVICE const *PCVBOXSERVICE;
|
|---|
| 95 |
|
|---|
| 96 | #ifdef RT_OS_WINDOWS
|
|---|
| 97 | /** The service name (needed for mutex creation on Windows). */
|
|---|
| 98 | #define VBOXSERVICE_NAME L"VBoxService"
|
|---|
| 99 | /** The friendly service name. */
|
|---|
| 100 | #define VBOXSERVICE_FRIENDLY_NAME L"VBoxService"
|
|---|
| 101 | /** The following constant may be defined by including NtStatus.h. */
|
|---|
| 102 | #define STATUS_SUCCESS ((NTSTATUS)0x00000000L)
|
|---|
| 103 | /** Structure for storing the looked up user information. */
|
|---|
| 104 | typedef struct
|
|---|
| 105 | {
|
|---|
| 106 | TCHAR szUser [_MAX_PATH];
|
|---|
| 107 | TCHAR szAuthenticationPackage [_MAX_PATH];
|
|---|
| 108 | TCHAR szLogonDomain [_MAX_PATH];
|
|---|
| 109 | } VBOXSERVICEVMINFOUSER, *PVBOXSERVICEVMINFOUSER;
|
|---|
| 110 | /** Structure for the file information lookup. */
|
|---|
| 111 | typedef struct
|
|---|
| 112 | {
|
|---|
| 113 | TCHAR* pszFilePath;
|
|---|
| 114 | TCHAR* pszFileName;
|
|---|
| 115 | } VBOXSERVICEVMINFOFILE, *PVBOXSERVICEVMINFOFILE;
|
|---|
| 116 | /** Function prototypes for dynamic loading. */
|
|---|
| 117 | typedef DWORD (WINAPI* fnWTSGetActiveConsoleSessionId)();
|
|---|
| 118 | #endif
|
|---|
| 119 |
|
|---|
| 120 | RT_C_DECLS_BEGIN
|
|---|
| 121 |
|
|---|
| 122 | extern char *g_pszProgName;
|
|---|
| 123 | extern int g_cVerbosity;
|
|---|
| 124 | extern uint32_t g_DefaultInterval;
|
|---|
| 125 |
|
|---|
| 126 | extern int VBoxServiceSyntax(const char *pszFormat, ...);
|
|---|
| 127 | extern int VBoxServiceError(const char *pszFormat, ...);
|
|---|
| 128 | extern void VBoxServiceVerbose(int iLevel, const char *pszFormat, ...);
|
|---|
| 129 | extern int VBoxServiceArgUInt32(int argc, char **argv, const char *psz, int *pi, uint32_t *pu32, uint32_t u32Min, uint32_t u32Max);
|
|---|
| 130 | extern unsigned VBoxServiceGetStartedServices(void);
|
|---|
| 131 | extern int VBoxServiceStartServices(unsigned iMain);
|
|---|
| 132 | extern int VBoxServiceStopServices(void);
|
|---|
| 133 |
|
|---|
| 134 | extern VBOXSERVICE g_TimeSync;
|
|---|
| 135 | extern VBOXSERVICE g_Clipboard;
|
|---|
| 136 | extern VBOXSERVICE g_Control;
|
|---|
| 137 | extern VBOXSERVICE g_VMInfo;
|
|---|
| 138 |
|
|---|
| 139 | #ifdef RT_OS_WINDOWS
|
|---|
| 140 | extern DWORD g_rcWinService;
|
|---|
| 141 | extern SERVICE_STATUS_HANDLE g_hWinServiceStatus;
|
|---|
| 142 | extern SERVICE_TABLE_ENTRY const g_aServiceTable[]; /** @todo generate on the fly, see comment in main() from the enabled sub services. */
|
|---|
| 143 |
|
|---|
| 144 | /** Installs the service into the registry. */
|
|---|
| 145 | extern int VBoxServiceWinInstall(void);
|
|---|
| 146 | /** Uninstalls the service from the registry. */
|
|---|
| 147 | extern int VBoxServiceWinUninstall(void);
|
|---|
| 148 | #ifdef VBOX_WITH_GUEST_PROPS
|
|---|
| 149 | /** Detects wheter a user is logged on based on the enumerated processes. */
|
|---|
| 150 | extern BOOL VboxServiceVMInfoWinIsLoggedIn(VBOXSERVICEVMINFOUSER* a_pUserInfo,
|
|---|
| 151 | PLUID a_pSession,
|
|---|
| 152 | PLUID a_pLuid,
|
|---|
| 153 | DWORD a_dwNumOfProcLUIDs);
|
|---|
| 154 | /** Gets logon user IDs from enumerated processes. */
|
|---|
| 155 | extern DWORD VboxServiceVMInfoWinGetLUIDsFromProcesses(PLUID *ppLuid);
|
|---|
| 156 | #endif /* VBOX_WITH_GUEST_PROPS */
|
|---|
| 157 | #endif /* RT_OS_WINDOWS */
|
|---|
| 158 |
|
|---|
| 159 | RT_C_DECLS_END
|
|---|
| 160 |
|
|---|
| 161 | #endif
|
|---|
| 162 |
|
|---|
