4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/* $Id$ */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/** @file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * VirtualBox COM API - Global Declarations and Definitions.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/*
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Copyright (C) 2008-2011 Oracle Corporation
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * available from http://www.virtualbox.org. This file is free software;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * you can redistribute it and/or modify it under the terms of the GNU
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * General Public License (GPL) as published by the Free Software
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#ifndef ____H_GLOBAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define ____H_GLOBAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/* interface definitions */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include "VBox/com/VirtualBox.h"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <VBox/ostypes.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <iprt/types.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define VBOXOSHINT_NONE 0
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define VBOXOSHINT_64BIT RT_BIT(0)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define VBOXOSHINT_HWVIRTEX RT_BIT(1)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define VBOXOSHINT_IOAPIC RT_BIT(2)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define VBOXOSHINT_EFI RT_BIT(3)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define VBOXOSHINT_PAE RT_BIT(4)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define VBOXOSHINT_USBHID RT_BIT(5)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define VBOXOSHINT_HPET RT_BIT(6)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define VBOXOSHINT_USBTABLET RT_BIT(7)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define VBOXOSHINT_RTCUTC RT_BIT(8)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define VBOXOSHINT_ACCEL2D RT_BIT(9)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define VBOXOSHINT_ACCEL3D RT_BIT(10)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define VBOXOSHINT_FLOPPY RT_BIT(11)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define VBOXOSHINT_NOUSB RT_BIT(12)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define VBOXOSHINT_TFRESET RT_BIT(13)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/** The VBoxVRDP kludge extension pack name.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * This is not a valid extension pack name (dashes are not allowed), and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * hence will not conflict with real extension packs.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define VBOXVRDP_KLUDGE_EXTPACK_NAME "Built-in-VBoxVRDP"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Contains global static definitions that can be referenced by all COM classes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * regardless of the apartment.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncclass Global
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync{
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncpublic:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /** Represents OS Type <-> string mappings. */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync struct OSType
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync const char *familyId; /* utf-8 */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync const char *familyDescription; /* utf-8 */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync const char *id; /* utf-8, VM config file value */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync const char *description; /* utf-8 */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync const VBOXOSTYPE osType;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync const uint32_t osHint;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync const uint32_t recommendedRAM;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync const uint32_t recommendedVRAM;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync const uint64_t recommendedHDD;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync const NetworkAdapterType_T networkAdapterType;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync const uint32_t numSerialEnabled;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync const StorageControllerType_T dvdStorageControllerType;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync const StorageBus_T dvdStorageBusType;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync const StorageControllerType_T hdStorageControllerType;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync const StorageBus_T hdStorageBusType;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync const ChipsetType_T chipsetType;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync const AudioControllerType_T audioControllerType;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync };
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync static const OSType sOSTypes[];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync static uint32_t cOSTypes;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Maps VBOXOSTYPE to the OS type which is used in VM configs.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync static const char *OSTypeId(VBOXOSTYPE aOSType);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Get the network adapter limit for each chipset type.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync static uint32_t getMaxNetworkAdapters(ChipsetType_T aChipsetType);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Returns @c true if the given machine state is an online state. This is a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * recommended way to detect if the VM is online (being executed in a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * dedicated process) or not. Note that some online states are also
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * transitional states (see #IsTransitional()).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync static bool IsOnline(MachineState_T aState)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return aState >= MachineState_FirstOnline &&
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync aState <= MachineState_LastOnline;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Returns @c true if the given machine state is a transient state. This is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * a recommended way to detect if the VM is performing some potentially
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * lengthy operation (such as starting, stopping, saving, deleting
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * snapshot, etc.). Note some (but not all) transitional states are also
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * online states (see #IsOnline()).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync static bool IsTransient(MachineState_T aState)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return aState >= MachineState_FirstTransient &&
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync aState <= MachineState_LastTransient;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Shortcut to <tt>IsOnline(aState) || IsTransient(aState)</tt>. When it returns
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * @false, the VM is turned off (no VM process) and not busy with
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * another exclusive operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync static bool IsOnlineOrTransient(MachineState_T aState)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return IsOnline(aState) || IsTransient(aState);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Stringify a machine state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * @returns Pointer to a read only string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * @param aState Valid machine state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync static const char *stringifyMachineState(MachineState_T aState);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Stringify a session state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * @returns Pointer to a read only string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * @param aState Valid session state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync static const char *stringifySessionState(SessionState_T aState);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Stringify a device type.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * @returns Pointer to a read only string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * @param aType The device type.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync static const char *stringifyDeviceType(DeviceType_T aType);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Stringify a reason.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * @returns Pointer to a read only string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * @param aReason The reason code.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync static const char *stringifyReason(Reason_T aReason);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Try convert a COM status code to a VirtualBox status code (VBox/err.h).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * @returns VBox status code.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * @param aComStatus COM status code.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync static int vboxStatusCodeFromCOM(HRESULT aComStatus);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Try convert a VirtualBox status code (VBox/err.h) to a COM status code.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * This is mainly intended for dealing with vboxStatusCodeFromCOM() return
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * values. If used on anything else, it won't be able to cope with most of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * input!
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * @returns COM status code.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * @param aVBoxStatus VBox status code.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync static HRESULT vboxStatusCodeToCOM(int aVBoxStatus);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync};
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#endif /* !____H_GLOBAL */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/* vi: set tabstop=4 shiftwidth=4 expandtab: */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync