VBoxServiceVMInfo.cpp revision 741a0ea8ed7567b7784172852371782a5562c5a5
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * VBoxVMInfo - Virtual machine (guest) information for the host.
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * Copyright (C) 2009 Sun Microsystems, Inc.
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * available from http://www.virtualbox.org. This file is free software;
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * you can redistribute it and/or modify it under the terms of the GNU
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * General Public License (GPL) as published by the Free Software
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * Clara, CA 95054 USA or visit http://www.sun.com if you need
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * additional information or have any questions.
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync/*******************************************************************************
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync* Header Files *
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync*******************************************************************************/
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync/*******************************************************************************
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync* Global Variables *
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync*******************************************************************************/
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync/** The vminfo interval (millseconds). */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync/** The semaphore we're blocking on. */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsyncstatic RTSEMEVENTMULTI g_VMInfoEvent = NIL_RTSEMEVENTMULTI;
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync/** The guest property service client ID. */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync/** Number of logged in users in OS. */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync/** Function prototypes for dynamic loading. */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsyncfnWTSGetActiveConsoleSessionId g_pfnWTSGetActiveConsoleSessionId = NULL;
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync/** External functions. */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsyncextern int VboxServiceWinGetAddsVersion(uint32_t uiClientID);
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsyncextern int VboxServiceWinGetComponentVersions(uint32_t uiClientID);
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync/** @copydoc VBOXSERVICE::pfnPreInit */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsyncstatic DECLCALLBACK(int) VBoxServiceVMInfoPreInit(void)
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync/** @copydoc VBOXSERVICE::pfnOption */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsyncstatic DECLCALLBACK(int) VBoxServiceVMInfoOption(const char **ppszShort, int argc, char **argv, int *pi)
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync /* no short options */;
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync/** @copydoc VBOXSERVICE::pfnInit */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsyncstatic DECLCALLBACK(int) VBoxServiceVMInfoInit(void)
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * If not specified, find the right interval default.
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * Then create the event sem to block on.
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync /* Get function pointers. */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync g_pfnWTSGetActiveConsoleSessionId = (fnWTSGetActiveConsoleSessionId)GetProcAddress(hKernel32, "WTSGetActiveConsoleSessionId");
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync rc = VbglR3GuestPropConnect(&g_VMInfoGuestPropSvcClientID);
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync VBoxServiceVerbose(3, "Property Service Client ID: %#x\n", g_VMInfoGuestPropSvcClientID);
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync VBoxServiceError("Failed to connect to the guest property service! Error: %Rrc\n", rc);
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync/** @copydoc VBOXSERVICE::pfnWorker */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsyncDECLCALLBACK(int) VBoxServiceVMInfoWorker(bool volatile *pfShutdown)
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * Tell the control thread that it can continue
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * spawning services.
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync /* Required for network information (must be called per thread). */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync VBoxServiceError("WSAStartup failed! Error: %Rrc\n", RTErrConvertFromWin32(WSAGetLastError()));
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync#endif /* !RT_OS_WINDOWS */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync /* First get information that won't change while the OS is running. */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync rc = RTSystemQueryOSInfo(RTSYSOSINFO_PRODUCT, szInfo, sizeof(szInfo));
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync VboxServiceWriteProp(g_VMInfoGuestPropSvcClientID, "GuestInfo/OS/Product", szInfo);
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync rc = RTSystemQueryOSInfo(RTSYSOSINFO_RELEASE, szInfo, sizeof(szInfo));
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync VboxServiceWriteProp(g_VMInfoGuestPropSvcClientID, "GuestInfo/OS/Release", szInfo);
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync rc = RTSystemQueryOSInfo(RTSYSOSINFO_VERSION, szInfo, sizeof(szInfo));
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync VboxServiceWriteProp(g_VMInfoGuestPropSvcClientID, "GuestInfo/OS/Version", szInfo);
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync rc = RTSystemQueryOSInfo(RTSYSOSINFO_SERVICE_PACK, szInfo, sizeof(szInfo));
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync VboxServiceWriteProp(g_VMInfoGuestPropSvcClientID, "GuestInfo/OS/ServicePack", szInfo);
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync /* Retrieve version information about Guest Additions and installed files (components). */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync rc = VboxServiceWinGetAddsVersion(g_VMInfoGuestPropSvcClientID);
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync rc = VboxServiceWinGetComponentVersions(g_VMInfoGuestPropSvcClientID);
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync /* VboxServiceGetAddsVersion !RT_OS_WINDOWS */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync VboxServiceWriteProp(g_VMInfoGuestPropSvcClientID, "GuestAdd/Version", VBOX_VERSION_STRING);
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync RTStrPrintf(szRevision, sizeof(szRevision), "%u", VBOX_SVN_REV);
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync VboxServiceWriteProp(g_VMInfoGuestPropSvcClientID, "GuestAdd/Revision", szRevision);
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync /* Now enter the loop retrieving runtime data continuously. */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync unsigned cErrors = 0;
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync /* Enumerate logged in users. */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync /* This function can report stale or orphaned interactive logon sessions of already logged
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync off users (especially in Windows 2000). */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync r = ::LsaEnumerateLogonSessions(&ulCount, &pSessions);
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync VBoxServiceVerbose(3, "Users: Found %ld users.\n", ulCount);
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync VBoxServiceError("LsaEnumerate failed %lu\n", LsaNtStatusToWinError(r));
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync DWORD dwNumOfProcLUIDs = VboxServiceVMInfoWinGetLUIDsFromProcesses(&pLuid);
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync ZeroMemory (&userInfo, sizeof(VBOXSERVICEVMINFOUSER));
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync for (int i = 0; i<(int)ulCount; i++)
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync if (VboxServiceVMInfoWinIsLoggedIn(&userInfo, &pSessions[i], pLuid, dwNumOfProcLUIDs))
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync #endif /* TARGET_NT4 */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync VBoxServiceError("Could not set UTMP file! Error: %ld", errno);
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync /* Make sure we don't add user names which are not
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * part of type USER_PROCESS and don't add same users twice. */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync /** @todo Do we really want to filter out double user names? (Same user logged in twice) */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync#endif /* !RT_OS_WINDOWS */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync VboxServiceWriteProp(g_VMInfoGuestPropSvcClientID, "GuestInfo/OS/LoggedInUsersList", (uiUserCount > 0) ? szUserList : NULL);
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync VboxServiceWritePropInt(g_VMInfoGuestPropSvcClientID, "GuestInfo/OS/LoggedInUsers", uiUserCount);
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync if (g_VMInfoLoggedInUsers != uiUserCount || g_VMInfoLoggedInUsers == UINT32_MAX)
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync /* Update this property ONLY if there is a real change from no users to
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * users or vice versa. The only exception is that the initialization
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * forces an update, but only once. This ensures consistent property
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * settings even if the VM aborted previously. */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync VboxServiceWriteProp(g_VMInfoGuestPropSvcClientID, "GuestInfo/OS/NoLoggedInUsers", "true");
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync VboxServiceWriteProp(g_VMInfoGuestPropSvcClientID, "GuestInfo/OS/NoLoggedInUsers", "false");
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync /* Get network configuration. */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync /** @todo Throw this code into a separate function/module? */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync SOCKET sd = WSASocket(AF_INET, SOCK_DGRAM, 0, 0, 0, 0);
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync VBoxServiceError("Failed to get a socket: Error %d\n", WSAGetLastError());
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync unsigned long nBytesReturned = 0;
0a7c9cc36ee176228eab4150144ad2561b0c4647vboxsync VBoxServiceError("Failed to WSAIoctl() on socket: Error: %d\n", WSAGetLastError());
0a7c9cc36ee176228eab4150144ad2561b0c4647vboxsync nNumInterfaces = nBytesReturned / sizeof(INTERFACE_INFO);
0a7c9cc36ee176228eab4150144ad2561b0c4647vboxsync VBoxServiceError("Failed to get a socket: Error %d\n", errno);
0a7c9cc36ee176228eab4150144ad2561b0c4647vboxsync VBoxServiceError("Failed to ioctl(SIOCGIFCONF) on socket: Error %d\n", errno);
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync RTStrPrintf(szPropPath, sizeof(szPropPath), "GuestInfo/Net/Count");
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync VboxServiceWritePropInt(g_VMInfoGuestPropSvcClientID, szPropPath, (nNumInterfaces > 1 ? nNumInterfaces-1 : 0));
0a7c9cc36ee176228eab4150144ad2561b0c4647vboxsync /** @todo Use GetAdaptersInfo() and GetAdapterAddresses (IPv4 + IPv6) for more information. */
0a7c9cc36ee176228eab4150144ad2561b0c4647vboxsync for (int i = 0; i < nNumInterfaces; ++i)
0a7c9cc36ee176228eab4150144ad2561b0c4647vboxsync if (InterfaceList[i].iiFlags & IFF_LOOPBACK) /* Skip loopback device. */
0a7c9cc36ee176228eab4150144ad2561b0c4647vboxsync pAddress = (sockaddr_in *)&(InterfaceList[i].iiAddress);
0a7c9cc36ee176228eab4150144ad2561b0c4647vboxsync VBoxServiceError("Failed to ioctl(SIOCGIFFLAGS) on socket: Error %d\n", errno);
0a7c9cc36ee176228eab4150144ad2561b0c4647vboxsync if (ifrequest[i].ifr_flags & IFF_LOOPBACK) /* Skip loopback device. */
0a7c9cc36ee176228eab4150144ad2561b0c4647vboxsync pAddress = ((sockaddr_in *)&ifrequest[i].ifr_addr);
0a7c9cc36ee176228eab4150144ad2561b0c4647vboxsync RTStrPrintf(szPropPath, sizeof(szPropPath), "GuestInfo/Net/%d/V4/IP", iCurIface);
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync VboxServiceWriteProp(g_VMInfoGuestPropSvcClientID, szPropPath, inet_ntoa(pAddress->sin_addr));
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync pAddress = (sockaddr_in *) & (InterfaceList[i].iiBroadcastAddress);
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync VBoxServiceError("Failed to ioctl(SIOCGIFBRDADDR) on socket: Error %d\n", errno);
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync pAddress = (sockaddr_in *)&ifrequest[i].ifr_broadaddr;
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync RTStrPrintf(szPropPath, sizeof(szPropPath), "GuestInfo/Net/%d/V4/Broadcast", iCurIface);
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync VboxServiceWriteProp(g_VMInfoGuestPropSvcClientID, szPropPath, inet_ntoa(pAddress->sin_addr));
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync pAddress = (sockaddr_in *)&(InterfaceList[i].iiNetmask);
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync VBoxServiceError("Failed to ioctl(SIOCGIFBRDADDR) on socket: Error %d\n", errno);
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync pAddress = (sockaddr_in *)&ifrequest[i].ifr_netmask;
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync RTStrPrintf(szPropPath, sizeof(szPropPath), "GuestInfo/Net/%d/V4/Netmask", iCurIface);
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync VboxServiceWriteProp(g_VMInfoGuestPropSvcClientID, szPropPath, inet_ntoa(pAddress->sin_addr));
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync RTStrPrintf(szPropPath, sizeof(szPropPath), "GuestInfo/Net/%d/Status", iCurIface);
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync VboxServiceWriteProp(g_VMInfoGuestPropSvcClientID, szPropPath, szTemp);
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync#endif /* !RT_OS_WINDOWS */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * Block for a while.
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * The event semaphore takes care of ignoring interruptions and it
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * allows us to implement service wakeup later.
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync int rc2 = RTSemEventMultiWait(g_VMInfoEvent, g_VMInfoInterval);
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync VBoxServiceError("RTSemEventMultiWait failed; rc2=%Rrc\n", rc2);
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync#endif /* !RT_OS_WINDOWS */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync/** @copydoc VBOXSERVICE::pfnStop */
359f2915f947abde1bba4358eada89941ee87cccvboxsyncstatic DECLCALLBACK(void) VBoxServiceVMInfoStop(void)
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync/** @copydoc VBOXSERVICE::pfnTerm */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsyncstatic DECLCALLBACK(void) VBoxServiceVMInfoTerm(void)
359f2915f947abde1bba4358eada89941ee87cccvboxsync /** @todo temporary solution: Zap all values which are not valid
359f2915f947abde1bba4358eada89941ee87cccvboxsync * anymore when VM goes down (reboot/shutdown ). Needs to
359f2915f947abde1bba4358eada89941ee87cccvboxsync * be replaced with "temporary properties" later.
359f2915f947abde1bba4358eada89941ee87cccvboxsync * @todo r=bird: This code isn't called on non-Windows systems. We need
359f2915f947abde1bba4358eada89941ee87cccvboxsync * a more formal way of shutting down the service for that to work.
359f2915f947abde1bba4358eada89941ee87cccvboxsync rc = VboxServiceWriteProp(g_VMInfoGuestPropSvcClientID, "GuestInfo/OS/LoggedInUsersList", NULL);
359f2915f947abde1bba4358eada89941ee87cccvboxsync rc = VboxServiceWritePropInt(g_VMInfoGuestPropSvcClientID, "GuestInfo/OS/LoggedInUsers", 0);
359f2915f947abde1bba4358eada89941ee87cccvboxsync VboxServiceWriteProp(g_VMInfoGuestPropSvcClientID, "GuestInfo/OS/NoLoggedInUsers", "true");
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync const char *apszPat[1] = { "/VirtualBox/GuestInfo/Net/*" };
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync rc = VbglR3GuestPropDelSet(g_VMInfoGuestPropSvcClientID, &apszPat[0], RT_ELEMENTS(apszPat));
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync rc = VboxServiceWritePropInt(g_VMInfoGuestPropSvcClientID, "GuestInfo/Net/Count", 0);
359f2915f947abde1bba4358eada89941ee87cccvboxsync /* Disconnect from guest properties service. */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync rc = VbglR3GuestPropDisconnect(g_VMInfoGuestPropSvcClientID);
359f2915f947abde1bba4358eada89941ee87cccvboxsync VBoxServiceError("Failed to disconnect from guest property service! Error: %Rrc\n", rc);
359f2915f947abde1bba4358eada89941ee87cccvboxsync * The 'vminfo' service description.
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync /* pszName. */
359f2915f947abde1bba4358eada89941ee87cccvboxsync /* pszDescription. */
359f2915f947abde1bba4358eada89941ee87cccvboxsync "Virtual Machine Information",
359f2915f947abde1bba4358eada89941ee87cccvboxsync /* pszUsage. */
359f2915f947abde1bba4358eada89941ee87cccvboxsync "[--vminfo-interval <ms>]"
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync /* pszOptions. */
359f2915f947abde1bba4358eada89941ee87cccvboxsync " --vminfo-interval Specifies the interval at which to retrieve the\n"
359f2915f947abde1bba4358eada89941ee87cccvboxsync " VM information. The default is 10000 ms.\n"
359f2915f947abde1bba4358eada89941ee87cccvboxsync /* methods */