VBoxHeadless.cpp revision 69de62149f0673ca641639dc41580719ba182d81
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * VBoxHeadless - The VirtualBox Headless frontend for running VMs on servers.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Copyright (C) 2006-2012 Oracle Corporation
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * available from http://www.virtualbox.org. This file is free software;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * you can redistribute it and/or modify it under the terms of the GNU
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * General Public License (GPL) as published by the Free Software
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncusing namespace com;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync//#define VBOX_WITH_SAVESTATE_ON_SIGNAL
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync////////////////////////////////////////////////////////////////////////////////
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync Log(("VBoxHeadless: ERROR: " m " [rc=0x%08X]\n", rc)); \
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync } while (0)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync////////////////////////////////////////////////////////////////////////////////
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/* global weak references (for event handlers) */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/* flag whether frontend should terminate */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncstatic volatile bool g_fTerminateFE = false;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync////////////////////////////////////////////////////////////////////////////////
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Handler for VirtualBoxClient events.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync STDMETHOD(HandleEvent)(VBoxEventType_T aType, IEvent *aEvent)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync ComPtr<IVBoxSVCAvailabilityChangedEvent> pVSACEv = aEvent;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync LogRel(("VBoxHeadless: VBoxSVC became unavailable, exiting.\n"));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTPrintf("VBoxSVC became unavailable, exiting.\n");
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /* Terminate the VM as cleanly as possible given that VBoxSVC
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * is no longer present. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Handler for global events.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync STDMETHOD(HandleEvent)(VBoxEventType_T aType, IEvent *aEvent)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync ComPtr<IGuestPropertyChangedEvent> pChangedEvent = aEvent;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync hrc = gConsole->COMGETTER(Machine)(pMachine.asOutParam());
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync hrc = pMachine->COMGETTER(Id)(gpMachineId.asOutParam());
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync hrc = pChangedEvent->COMGETTER(MachineId)(machineId.asOutParam());
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync hrc = pChangedEvent->COMGETTER(Name)(strKey.asOutParam());
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync LogRelFlow(("Guest property \"%s\" has been changed\n", utf8Key.c_str()));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync if (utf8Key.equals("/VirtualBox/GuestInfo/OS/NoLoggedInUsers"))
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync pChangedEvent->COMGETTER(Value)(strValue.asOutParam());
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync LogRelFlow(("Guest indicates that there %s logged in users\n",
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /* Check if this is our machine and the "disconnect on logout feature" is enabled. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /* Does the machine handle VRDP disconnects? */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync hrc = pMachine->GetExtraData(Bstr("VRDP/DisconnectOnGuestLogout").raw(),
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync fProcessDisconnectOnGuestLogout = utf8Discon.equals("1")
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync LogRelFlow(("VRDE: hrc=%Rhrc: Host %s disconnecting clients (current host state known: %s)\n",
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync hrc, fProcessDisconnectOnGuestLogout ? "will handle" : "does not handle",
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync mfNoLoggedInUsers ? "No users logged in" : "Users logged in"));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync if (!mfNoLoggedInUsers) /* Only if the property really changes. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /* Guest property got deleted due to reset,
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * so it has no value anymore. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /* Guest property got deleted due to reset,
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * take the shortcut without touching the mfNoLoggedInUsers
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * state. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync LogRelFlow(("VRDE: szNoLoggedInUsers=%s, mfNoLoggedInUsers=%RTbool, fDropConnection=%RTbool\n",
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync utf8Value.c_str(), mfNoLoggedInUsers, fDropConnection));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /* If there is a connection, drop it. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync hrc = gConsole->COMGETTER(VRDEServerInfo)(info.asOutParam());
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync LogRelFlow(("VRDE: connected clients=%RU32\n", cClients));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync hrc = pMachine->COMGETTER(VRDEServer)(vrdeServer.asOutParam());
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync LogRel(("VRDE: the guest user has logged out, disconnecting remote clients.\n"));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync HRESULT hrc2 = vrdeServer->COMSETTER(Enabled)(TRUE);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Handler for machine events.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync STDMETHOD(HandleEvent)(VBoxEventType_T aType, IEvent *aEvent)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync ComPtr<IMouseCapabilityChangedEvent> mccev = aEvent;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync mccev->COMGETTER(SupportsAbsolute)(&fSupportsAbsolute);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /* Emit absolute mouse event to actually enable the host mouse cursor. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync mouse->PutMouseEventAbsolute(-1, -1, 0, 0 /* Horizontal wheel */, 0);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /* Terminate any event wait operation if the machine has been
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync if (machineState < MachineState_Running && !m_fIgnorePowerOffEvents)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync ComPtr<IVRDEServerInfoChangedEvent> rdicev = aEvent;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync gConsole->COMGETTER(VRDEServerInfo)(info.asOutParam());
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync else if (port == 0)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTPrintf("VRDE server is listening on port %d.\n", port);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsynctypedef ListenerImpl<VirtualBoxClientEventListener> VirtualBoxClientEventListenerImpl;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsynctypedef ListenerImpl<VirtualBoxEventListener> VirtualBoxEventListenerImpl;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsynctypedef ListenerImpl<ConsoleEventListener> ConsoleEventListenerImpl;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVBOX_LISTENER_DECLARE(VirtualBoxClientEventListenerImpl)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** @todo Deal with nested signals, multithreaded signal dispatching (esp. on windows),
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * and multiple signals (both SIGINT and SIGTERM in some order).
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Consider processing the signal request asynchronously since there are lots of things
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * which aren't safe (like RTPrintf and printf IIRC) in a signal context. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync HRESULT rc = gConsole->SaveState(progress.asOutParam());
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTPrintf("-- Error saving state, lrc=%d (%#x)\n", lrc, lrc);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync#endif /* VBOX_WITH_SAVESTATE_ON_SIGNAL */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync////////////////////////////////////////////////////////////////////////////////
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync " -s, -startvm, --startvm <name|uuid> Start given VM (required argument)\n"
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync " -v, -vrde, --vrde on|off|config Enable (default) or disable the VRDE\n"
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync " server or don't change the setting\n"
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync " -e, -vrdeproperty, --vrdeproperty <name=[value]> Set a VRDE property:\n"
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync " \"TCP/Ports\" - comma-separated list of ports\n"
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync " the VRDE server can bind to. Use a dash between\n"
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync " two port numbers to specify a range\n"
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync " \"TCP/Address\" - interface IP the VRDE server\n"
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync " will bind to\n"
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync " --settingspw <pw> Specify the settings password\n"
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync " --settingspwfile <file> Specify a file containing the settings password\n"
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync " -c, -capture, --capture Record the VM screen output to a file\n"
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync " -w, --width Frame width when recording\n"
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync " -h, --height Frame height when recording\n"
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync " -r, --bitrate Recording bit rate when recording\n"
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync " -f, --filename File name when recording. The codec used\n"
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync " will be chosen based on the file extension\n"
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Parse the environment for variables which can influence the VIDEOREC settings.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * purely for backwards compatibility.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pulFrameWidth may be updated with a desired frame width
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pulFrameHeight may be updated with a desired frame height
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pulBitRate may be updated with a desired bit rate
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param ppszFileName may be updated with a desired file name
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncstatic void parse_environ(unsigned long *pulFrameWidth, unsigned long *pulFrameHeight,
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync unsigned long *pulBitRate, const char **ppszFileName)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync if ((pszEnvTemp = RTEnvGet("VBOX_CAPTUREWIDTH")) != 0)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync unsigned long ulFrameWidth = strtoul(pszEnvTemp, 0, 10);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync LogError("VBoxHeadless: ERROR: invalid VBOX_CAPTUREWIDTH environment variable", 0);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync if ((pszEnvTemp = RTEnvGet("VBOX_CAPTUREHEIGHT")) != 0)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync unsigned long ulFrameHeight = strtoul(pszEnvTemp, 0, 10);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync LogError("VBoxHeadless: ERROR: invalid VBOX_CAPTUREHEIGHT environment variable", 0);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync if ((pszEnvTemp = RTEnvGet("VBOX_CAPTUREBITRATE")) != 0)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync unsigned long ulBitRate = strtoul(pszEnvTemp, 0, 10);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync LogError("VBoxHeadless: ERROR: invalid VBOX_CAPTUREBITRATE environment variable", 0);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync if ((pszEnvTemp = RTEnvGet("VBOX_CAPTUREFILE")) != 0)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync#endif /* VBOX_WITH_VIDEO_REC defined */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncstatic RTEXITCODE readPasswordFile(const char *pszFilename, com::Utf8Str *pPasswd)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync vrc = RTStrmReadEx(pStrm, szPasswd, sizeof(szPasswd)-1, &cbFile);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTPrintf("Provided password in file '%s' is too long\n", pszFilename);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync unsigned i;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync for (i = 0; i < cbFile && !RT_C_IS_CNTRL(szPasswd[i]); i++)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTPrintf("Cannot read password from file '%s': %Rrc\n", pszFilename, vrc);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTPrintf("Cannot open password file '%s' (%Rrc)\n", pszFilename, vrc);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncstatic RTEXITCODE settingsPasswordFile(ComPtr<IVirtualBox> virtualBox, const char *pszFilename)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTEXITCODE rcExit = readPasswordFile(pszFilename, &passwd);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync CHECK_ERROR(virtualBox, SetSettingsSecret(com::Bstr(passwd).raw()));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync// Required for ATL
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Entry point.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncextern "C" DECLEXPORT(int) TrustedMain(int argc, char **argv, char **envp)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync unsigned fRawR0 = ~0U;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync unsigned fRawR3 = ~0U;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync unsigned fPATM = ~0U;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync unsigned fCSAM = ~0U;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync unsigned fVIDEOREC = 0;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync#endif /* VBOX_WITH_VIDEO_REC */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTPrintf (VBOX_PRODUCT " Headless Interface " VBOX_VERSION_STRING "\n"
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync "All rights reserved.\n\n");
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /* Parse the environment */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync parse_environ(&ulFrameWidth, &ulFrameHeight, &ulBitRate, &pszFileNameParam);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync { "-vrdpport", 'p', RTGETOPT_REQ_STRING }, /* VRDE: deprecated. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync { "--vrdpport", 'p', RTGETOPT_REQ_STRING }, /* VRDE: deprecated. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync { "-vrdpaddress", 'a', RTGETOPT_REQ_STRING }, /* VRDE: deprecated. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync { "--vrdpaddress", 'a', RTGETOPT_REQ_STRING }, /* VRDE: deprecated. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync { "-vrdp", 'v', RTGETOPT_REQ_STRING }, /* VRDE: deprecated. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync { "--vrdp", 'v', RTGETOPT_REQ_STRING }, /* VRDE: deprecated. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync { "--settingspw", OPT_SETTINGSPW, RTGETOPT_REQ_STRING },
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync { "--settingspwfile", OPT_SETTINGSPW_FILE, RTGETOPT_REQ_STRING },
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync { "--height", 'h', RTGETOPT_REQ_UINT32 }, /* great choice of short option! */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync#endif /* VBOX_WITH_VIDEO_REC defined */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync // parse the command line
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTGetOptInit(&GetState, argc, argv, s_aOptions, RT_ELEMENTS(s_aOptions), 1, 0 /* fFlags */);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTPrintf("Warning: '-p' or '-vrdpport' are deprecated. Use '-e \"TCP/Ports=%s\"'\n", ValueUnion.psz);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTPrintf("Warning: '-a' or '-vrdpaddress' are deprecated. Use '-e \"TCP/Address=%s\"'\n", ValueUnion.psz);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync if (cVRDEProperties < RT_ELEMENTS(aVRDEProperties))
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync aVRDEProperties[cVRDEProperties++] = ValueUnion.psz;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTPrintf("Warning: too many VRDE properties. Ignored: '%s'\n", ValueUnion.psz);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync#endif /* VBOX_WITH_VIDEO_REC defined */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync if ((GetState.pDef->fFlags & RTGETOPT_REQ_MASK) != RTGETOPT_REQ_NOTHING)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /* nothing to do */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTPrintf("%sr%s\n", RTBldCfgVersion(), RTBldCfgRevisionStr());
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync if (ulFrameWidth < 512 || ulFrameWidth > 2048 || ulFrameWidth % 2)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync LogError("VBoxHeadless: ERROR: please specify an even frame width between 512 and 2048", 0);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync if (ulFrameHeight < 384 || ulFrameHeight > 1536 || ulFrameHeight % 2)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync LogError("VBoxHeadless: ERROR: please specify an even frame height between 384 and 1536", 0);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync LogError("VBoxHeadless: ERROR: please specify an even bitrate between 300000 and 1000000", 0);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /* Make sure we only have %d or %u (or none) in the file name specified */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync char *pcPercent = (char*)strchr(pszFileNameParam, '%');
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync if (pcPercent != 0 && *(pcPercent + 1) != 'd' && *(pcPercent + 1) != 'u')
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync LogError("VBoxHeadless: ERROR: Only %%d and %%u are allowed in the capture file name.", -1);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /* And no more than one % in the name */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync if (pcPercent != 0 && strchr(pcPercent + 1, '%') != 0)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync LogError("VBoxHeadless: ERROR: Only one format modifier is allowed in the capture file name.", -1);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTStrPrintf(&pszMPEGFile[0], RTPATH_MAX, pszFileNameParam, RTProcSelf());
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync#endif /* defined VBOX_WITH_VIDEO_REC */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync com::GetVBoxUserHomeDirectory(szHome, sizeof(szHome));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTPrintf("Failed to initialize COM because the global settings directory '%s' is not accessible!", szHome);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTPrintf("VBoxHeadless: ERROR: failed to initialize COM!\n");
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync ComObjPtr<ConsoleEventListenerImpl> consoleListener;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync rc = pVirtualBoxClient.createInprocObject(CLSID_VirtualBoxClient);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTPrintf("VBoxHeadless: ERROR: failed to create the VirtualBoxClient object!\n");
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync if (!info.isFullAvailable() && !info.isBasicAvailable())
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTPrintf("Most likely, the VirtualBox COM server is not running or failed to start.\n");
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync rc = pVirtualBoxClient->COMGETTER(VirtualBox)(virtualBox.asOutParam());
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTPrintf("Failed to get VirtualBox object (rc=%Rhrc)!\n", rc);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync rc = pVirtualBoxClient->COMGETTER(Session)(session.asOutParam());
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTPrintf("Failed to get session object (rc=%Rhrc)!\n", rc);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync CHECK_ERROR(virtualBox, SetSettingsSecret(Bstr(pcszSettingsPw).raw()));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync int rcExit = settingsPasswordFile(virtualBox, pcszSettingsPwFile);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync rc = virtualBox->FindMachine(Bstr(pcszNameOrUUID).raw(), m.asOutParam());
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync Log(("VBoxHeadless: Opening a session with machine (id={%s})...\n",
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync // open a session
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync CHECK_ERROR_BREAK(m, LockMachine(session, LockType_VM));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /* get the console */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync CHECK_ERROR_BREAK(session, COMGETTER(Console)(console.asOutParam()));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /* get the mutable machine */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync CHECK_ERROR_BREAK(console, COMGETTER(Machine)(machine.asOutParam()));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync CHECK_ERROR_BREAK(console, COMGETTER(Display)(display.asOutParam()));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync Log2(("VBoxHeadless: loading VBoxVideoRecFB and libvpx shared library\n"));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync rrc = SUPR3HardenedLdrLoadAppPriv("VBoxVideoRecFB", &hLdrVideoRecFB, RTLDRLOAD_FLAGS_LOCAL, &ErrInfo.Core);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync Log2(("VBoxHeadless: looking up symbol VBoxRegisterVideoRecFB\n"));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync rrc = RTLdrGetSymbol(hLdrVideoRecFB, "VBoxRegisterVideoRecFB",
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync reinterpret_cast<void **>(&pfnRegisterVideoRecFB));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync LogError("Failed to load the video capture extension, possibly due to a damaged file\n", rrc);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync LogError("Failed to load the video capture extension\n", rrc); /** @todo stupid function, no formatting options. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync Log2(("VBoxHeadless: calling pfnRegisterVideoRecFB\n"));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync rcc = pfnRegisterVideoRecFB(ulFrameWidth, ulFrameHeight, ulBitRate,
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync LogError("Failed to initialise video capturing - make sure that the file format\n"
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync "you wish to use is supported on your system\n", rcc);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync display->SetFramebuffer(VBOX_VIDEO_PRIMARY_SCREEN, pFramebuffer);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync#endif /* defined(VBOX_WITH_VIDEO_REC) */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync for (uScreenId = 0; uScreenId < cMonitors; uScreenId++)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /* Already registered. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync VRDPFramebuffer *pVRDPFramebuffer = new VRDPFramebuffer();
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTPrintf("Error: could not create framebuffer object %d\n", uScreenId);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync display->SetFramebuffer(uScreenId, pVRDPFramebuffer);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync // fill in remaining slots with null framebuffers
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync for (uScreenId = 0; uScreenId < cMonitors; uScreenId++)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /* get the machine debugger (isn't necessarily available) */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync console->COMGETTER(Debugger)(machineDebugger.asOutParam());
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTPrintf("Error: No debugger object; -%srawr0 cannot be executed!\n", fRawR0 ? "" : "no");
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync machineDebugger->COMSETTER(RecompileSupervisor)(!fRawR0);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTPrintf("Error: No debugger object; -%srawr3 cannot be executed!\n", fRawR3 ? "" : "no");
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync machineDebugger->COMSETTER(RecompileUser)(!fRawR3);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTPrintf("Error: No debugger object; -%spatm cannot be executed!\n", fPATM ? "" : "no");
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTPrintf("Error: No debugger object; -%scsam cannot be executed!\n", fCSAM ? "" : "no");
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /* initialize global references */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /* VirtualBoxClient events registration. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync CHECK_ERROR(pVirtualBoxClient, COMGETTER(EventSource)(pES.asOutParam()));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync ComObjPtr<VirtualBoxClientEventListenerImpl> listener;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync listener->init(new VirtualBoxClientEventListener());
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync eventTypes.push_back(VBoxEventType_OnVBoxSVCAvailabilityChanged);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync CHECK_ERROR(pES, RegisterListener(vboxClientListener, ComSafeArrayAsInParam(eventTypes), true));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /* Console events registration. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync CHECK_ERROR(console, COMGETTER(EventSource)(es.asOutParam()));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync eventTypes.push_back(VBoxEventType_OnMouseCapabilityChanged);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync eventTypes.push_back(VBoxEventType_OnStateChanged);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync eventTypes.push_back(VBoxEventType_OnVRDEServerInfoChanged);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync eventTypes.push_back(VBoxEventType_OnCanShowWindow);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync CHECK_ERROR(es, RegisterListener(consoleListener, ComSafeArrayAsInParam(eventTypes), true));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /* default is to enable the remote desktop server (backward compatibility) */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync CHECK_ERROR_BREAK(machine, COMGETTER(VRDEServer)(vrdeServer.asOutParam()));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync CHECK_ERROR_BREAK(vrdeServer, COMGETTER(Enabled)(&fVRDEEnabled));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /* -vrdeServer on|off|config */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync if (!strcmp(vrdeEnabled, "off") || !strcmp(vrdeEnabled, "disable"))
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync else if (strcmp(vrdeEnabled, "on") && strcmp(vrdeEnabled, "enable"))
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTPrintf("-vrdeServer requires an argument (on|off|config)\n");
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /* set VRDE port if requested by the user */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync CHECK_ERROR_BREAK(vrdeServer, SetVRDEProperty(Bstr("TCP/Ports").raw(), bstr.raw()));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /* set VRDE address if requested by the user */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync CHECK_ERROR_BREAK(vrdeServer, SetVRDEProperty(Bstr("TCP/Address").raw(), Bstr(vrdeAddress).raw()));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /* Set VRDE properties. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync for (unsigned i = 0; i < cVRDEProperties; i++)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /* Parse 'name=value' */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync CHECK_ERROR_BREAK(vrdeServer, SetVRDEProperty(bstrName.raw(), bstrValue.raw()));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTPrintf("Error: Invalid VRDE property '%s'\n", aVRDEProperties[i]);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTPrintf("Error: Failed to allocate memory for VRDE property '%s'\n", aVRDEProperties[i]);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /* enable VRDE server (only if currently disabled) */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync CHECK_ERROR_BREAK(vrdeServer, COMSETTER(Enabled)(TRUE));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /* disable VRDE server (only if currently enabled */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync CHECK_ERROR_BREAK(vrdeServer, COMSETTER(Enabled)(FALSE));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /* Disable the host clipboard before powering up */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync Log(("VBoxHeadless: Powering up the machine...\n"));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync CHECK_ERROR_BREAK(console, PowerUp(progress.asOutParam()));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Wait for the result because there can be errors.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * It's vital to process events while waiting (teleportation deadlocks),
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * so we'll poll for the completion instead of waiting on it.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /* Process pending events, then wait for new ones. Note, this
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * processes NULL events signalling event loop termination. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /* Figure out if the operation completed with a failed status
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * and print the error message. Terminate immediately, and let
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * the cleanup code take care of potentially pending events. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTPrintf("Error: failed to start machine. Error message: %ls\n", info.getText().raw());
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTPrintf("Error: failed to start machine. No error message available!\n");
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /* VirtualBox events registration. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync CHECK_ERROR(virtualBox, COMGETTER(EventSource)(es.asOutParam()));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync eventTypes.push_back(VBoxEventType_OnGuestPropertyChanged);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync CHECK_ERROR(es, RegisterListener(vboxListener, ComSafeArrayAsInParam(eventTypes), true));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync && RT_SUCCESS(gEventQ->processEventQueue(RT_INDEFINITE_WAIT)))
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /* nothing */ ;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync Log(("VBoxHeadless: event loop has terminated...\n"));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync#endif /* defined(VBOX_WITH_VIDEO_REC) */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /* we don't have to disable VRDE here because we don't save the settings of the VM */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Get the machine state.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync MachineState_T machineState = MachineState_Aborted;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Turn off the VM if it's running
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /** @todo power off paused VMs too? */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync consoleListener->getWrapped()->ignorePowerOffEvents(true);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync CHECK_ERROR_BREAK(gConsole, PowerDown(pProgress.asOutParam()));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync CHECK_ERROR_BREAK(pProgress, WaitForCompletion(-1));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync CHECK_ERROR_BREAK(pProgress, COMGETTER(Completed)(&completed));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync CHECK_ERROR_BREAK(pProgress, COMGETTER(ResultCode)(&hrc));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTPrintf("VBoxHeadless: ERROR: Failed to power down VM!");
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync if (!info.isFullAvailable() && !info.isBasicAvailable())
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync } while (0);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /* VirtualBox callback unregistration. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync CHECK_ERROR(virtualBox, COMGETTER(EventSource)(es.asOutParam()));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /* Console callback unregistration. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync CHECK_ERROR(gConsole, COMGETTER(EventSource)(es.asOutParam()));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync CHECK_ERROR(es, UnregisterListener(consoleListener));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /* VirtualBoxClient callback unregistration. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync CHECK_ERROR(pVirtualBoxClient, COMGETTER(EventSource)(pES.asOutParam()));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync CHECK_ERROR(pES, UnregisterListener(vboxClientListener));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /* No more access to the 'console' object, which will be uninitialized by the next session->Close call. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Close the session. This will also uninitialize the console and
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * unregister the callback we've registered before.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /* Must be before com::Shutdown */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Main entry point.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync // initialize VBox Runtime
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync int rc = RTR3InitExe(argc, &argv, RTR3INIT_FLAGS_SUPLIB);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTPrintf("Cannot access the kernel driver. Make sure the kernel module has been \n"
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync "loaded successfully. Aborting ...\n");
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync#endif /* !VBOX_WITH_HARDENING */