| 1 | /* $Id: Global.h 24933 2009-11-25 10:50:21Z vboxsync $ */
|
|---|
| 2 |
|
|---|
| 3 | /** @file
|
|---|
| 4 | *
|
|---|
| 5 | * VirtualBox COM global declarations
|
|---|
| 6 | */
|
|---|
| 7 |
|
|---|
| 8 | /*
|
|---|
| 9 | * Copyright (C) 2008 Sun Microsystems, Inc.
|
|---|
| 10 | *
|
|---|
| 11 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
|---|
| 12 | * available from http://www.virtualbox.org. This file is free software;
|
|---|
| 13 | * you can redistribute it and/or modify it under the terms of the GNU
|
|---|
| 14 | * General Public License (GPL) as published by the Free Software
|
|---|
| 15 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
|---|
| 16 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
|---|
| 17 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
|---|
| 18 | *
|
|---|
| 19 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
|
|---|
| 20 | * Clara, CA 95054 USA or visit http://www.sun.com if you need
|
|---|
| 21 | * additional information or have any questions.
|
|---|
| 22 | */
|
|---|
| 23 |
|
|---|
| 24 | #ifndef ____H_GLOBAL
|
|---|
| 25 | #define ____H_GLOBAL
|
|---|
| 26 |
|
|---|
| 27 | /* generated header */
|
|---|
| 28 | #include "SchemaDefs.h"
|
|---|
| 29 |
|
|---|
| 30 | /* interface definitions */
|
|---|
| 31 | #include "VBox/com/VirtualBox.h"
|
|---|
| 32 |
|
|---|
| 33 | #include <VBox/ostypes.h>
|
|---|
| 34 |
|
|---|
| 35 | #include <iprt/types.h>
|
|---|
| 36 |
|
|---|
| 37 | #define VBOXOSHINT_NONE 0
|
|---|
| 38 | #define VBOXOSHINT_64BIT RT_BIT(0)
|
|---|
| 39 | #define VBOXOSHINT_HWVIRTEX RT_BIT(1)
|
|---|
| 40 | #define VBOXOSHINT_IOAPIC RT_BIT(2)
|
|---|
| 41 |
|
|---|
| 42 | /**
|
|---|
| 43 | * Contains global static definitions that can be referenced by all COM classes
|
|---|
| 44 | * regardless of the apartment.
|
|---|
| 45 | */
|
|---|
| 46 | class Global
|
|---|
| 47 | {
|
|---|
| 48 | public:
|
|---|
| 49 |
|
|---|
| 50 | /** Represents OS Type <-> string mappings. */
|
|---|
| 51 | struct OSType
|
|---|
| 52 | {
|
|---|
| 53 | const char *familyId; /* utf-8 */
|
|---|
| 54 | const char *familyDescription; /* utf-8 */
|
|---|
| 55 | const char *id; /* utf-8 */
|
|---|
| 56 | const char *description; /* utf-8 */
|
|---|
| 57 | const VBOXOSTYPE osType;
|
|---|
| 58 | const uint32_t osHint;
|
|---|
| 59 | const uint32_t recommendedRAM;
|
|---|
| 60 | const uint32_t recommendedVRAM;
|
|---|
| 61 | const uint32_t recommendedHDD;
|
|---|
| 62 | const NetworkAdapterType_T networkAdapterType;
|
|---|
| 63 | const uint32_t numSerialEnabled;
|
|---|
| 64 | };
|
|---|
| 65 |
|
|---|
| 66 | static const OSType sOSTypes[SchemaDefs::OSTypeId_COUNT];
|
|---|
| 67 |
|
|---|
| 68 | static const char *OSTypeId(VBOXOSTYPE aOSType);
|
|---|
| 69 |
|
|---|
| 70 | /**
|
|---|
| 71 | * Returns @c true if the given machine state is an online state. This is a
|
|---|
| 72 | * recommended way to detect if the VM is online (being executed in a
|
|---|
| 73 | * dedicated process) or not. Note that some online states are also
|
|---|
| 74 | * transitional states (see #IsTransitional()).
|
|---|
| 75 | *
|
|---|
| 76 | * @remarks Saving may actually be an offline state according to the
|
|---|
| 77 | * documentation (offline snapshot).
|
|---|
| 78 | */
|
|---|
| 79 | static bool IsOnline(MachineState_T aState)
|
|---|
| 80 | {
|
|---|
| 81 | #if 0
|
|---|
| 82 | return aState >= MachineState_FirstOnline &&
|
|---|
| 83 | aState <= MachineState_LastOnline;
|
|---|
| 84 | #else
|
|---|
| 85 | switch (aState)
|
|---|
| 86 | {
|
|---|
| 87 | case MachineState_Running:
|
|---|
| 88 | case MachineState_Paused:
|
|---|
| 89 | case MachineState_Teleporting:
|
|---|
| 90 | case MachineState_LiveSnapshotting:
|
|---|
| 91 | case MachineState_Stuck:
|
|---|
| 92 | case MachineState_Starting:
|
|---|
| 93 | case MachineState_Stopping:
|
|---|
| 94 | case MachineState_Saving:
|
|---|
| 95 | case MachineState_Restoring:
|
|---|
| 96 | case MachineState_TeleportingPausedVM:
|
|---|
| 97 | case MachineState_TeleportingIn:
|
|---|
| 98 | return true;
|
|---|
| 99 | default:
|
|---|
| 100 | return false;
|
|---|
| 101 | }
|
|---|
| 102 | #endif
|
|---|
| 103 | }
|
|---|
| 104 |
|
|---|
| 105 | /**
|
|---|
| 106 | * Returns @c true if the given machine state is a transient state. This is
|
|---|
| 107 | * a recommended way to detect if the VM is performing some potentially
|
|---|
| 108 | * lengthy operation (such as starting, stopping, saving, discarding
|
|---|
| 109 | * snapshot, etc.). Note some (but not all) transitional states are also
|
|---|
| 110 | * online states (see #IsOnline()).
|
|---|
| 111 | */
|
|---|
| 112 | static bool IsTransient(MachineState_T aState)
|
|---|
| 113 | {
|
|---|
| 114 | #if 0
|
|---|
| 115 | return aState >= MachineState_FirstTransient &&
|
|---|
| 116 | aState <= MachineState_LastTransient;
|
|---|
| 117 | #else
|
|---|
| 118 | switch (aState)
|
|---|
| 119 | {
|
|---|
| 120 | case MachineState_Teleporting:
|
|---|
| 121 | case MachineState_LiveSnapshotting:
|
|---|
| 122 | case MachineState_Starting:
|
|---|
| 123 | case MachineState_Stopping:
|
|---|
| 124 | case MachineState_Saving:
|
|---|
| 125 | case MachineState_Restoring:
|
|---|
| 126 | case MachineState_TeleportingPausedVM:
|
|---|
| 127 | case MachineState_TeleportingIn:
|
|---|
| 128 | case MachineState_RestoringSnapshot:
|
|---|
| 129 | case MachineState_DeletingSnapshot:
|
|---|
| 130 | case MachineState_SettingUp:
|
|---|
| 131 | return true;
|
|---|
| 132 | default:
|
|---|
| 133 | return false;
|
|---|
| 134 | }
|
|---|
| 135 | #endif
|
|---|
| 136 | }
|
|---|
| 137 |
|
|---|
| 138 | /**
|
|---|
| 139 | * Shortcut to <tt>IsOnline(aState) || IsTransient(aState)</tt>. When it returns
|
|---|
| 140 | * @false, the VM is turned off (no VM process) and not busy with
|
|---|
| 141 | * another exclusive operation.
|
|---|
| 142 | */
|
|---|
| 143 | static bool IsOnlineOrTransient(MachineState_T aState)
|
|---|
| 144 | {
|
|---|
| 145 | return IsOnline(aState) || IsTransient(aState);
|
|---|
| 146 | }
|
|---|
| 147 |
|
|---|
| 148 | /**
|
|---|
| 149 | * Stringify a machine state.
|
|---|
| 150 | *
|
|---|
| 151 | * @returns Pointer to a read only string.
|
|---|
| 152 | * @param aState Valid machine state.
|
|---|
| 153 | */
|
|---|
| 154 | static const char *stringifyMachineState(MachineState_T aState);
|
|---|
| 155 |
|
|---|
| 156 | /**
|
|---|
| 157 | * Stringify a session state.
|
|---|
| 158 | *
|
|---|
| 159 | * @returns Pointer to a read only string.
|
|---|
| 160 | * @param aState Valid session state.
|
|---|
| 161 | */
|
|---|
| 162 | static const char *stringifySessionState(SessionState_T aState);
|
|---|
| 163 |
|
|---|
| 164 | /**
|
|---|
| 165 | * Stringify a device type.
|
|---|
| 166 | *
|
|---|
| 167 | * @returns Pointer to a read only string.
|
|---|
| 168 | * @param aType The device type.
|
|---|
| 169 | */
|
|---|
| 170 | static const char *stringifyDeviceType(DeviceType_T aType);
|
|---|
| 171 |
|
|---|
| 172 | /**
|
|---|
| 173 | * Try convert a COM status code to a VirtualBox status code (VBox/err.h).
|
|---|
| 174 | *
|
|---|
| 175 | * @returns VBox status code.
|
|---|
| 176 | * @param aComStatus COM status code.
|
|---|
| 177 | */
|
|---|
| 178 | static int vboxStatusCodeFromCOM(HRESULT aComStatus);
|
|---|
| 179 |
|
|---|
| 180 | /**
|
|---|
| 181 | * Try convert a VirtualBox status code (VBox/err.h) to a COM status code.
|
|---|
| 182 | *
|
|---|
| 183 | * This is mainly inteded for dealing with vboxStatusCodeFromCOM() return
|
|---|
| 184 | * values. If used on anything else, it won't be able to cope with most of the
|
|---|
| 185 | * input!
|
|---|
| 186 | *
|
|---|
| 187 | * @returns COM status code.
|
|---|
| 188 | * @param aVBoxStatus VBox status code.
|
|---|
| 189 | */
|
|---|
| 190 | static HRESULT vboxStatusCodeToCOM(int aVBoxStatus);
|
|---|
| 191 | };
|
|---|
| 192 |
|
|---|
| 193 | #endif /* !____H_GLOBAL */
|
|---|
| 194 | /* vi: set tabstop=4 shiftwidth=4 expandtab: */
|
|---|
