common/VBoxGuestLib/VBoxGuestR3LibGuestCtrl.cpp

	VBoxGuestR3LibGuestCtrl.cpp revision ba8183e1a0c699f5b5131a03e157fc7e39ed3009
26456d1900aba0e903e6e1beec552396618322e2vboxsync/* $Id$ */
ad27e1d5e48ca41245120c331cc88b50464813cevboxsync/** @file
5c65eaa08f2ec993a19c9bef6e5463918e40e0ebvboxsync * VBoxGuestR3Lib - Ring-3 Support Library for VirtualBox guest additions, guest control.
26456d1900aba0e903e6e1beec552396618322e2vboxsync */
26456d1900aba0e903e6e1beec552396618322e2vboxsync
26456d1900aba0e903e6e1beec552396618322e2vboxsync/*
26456d1900aba0e903e6e1beec552396618322e2vboxsync * Copyright (C) 2010 Sun Microsystems, Inc.
26456d1900aba0e903e6e1beec552396618322e2vboxsync *
26456d1900aba0e903e6e1beec552396618322e2vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
26456d1900aba0e903e6e1beec552396618322e2vboxsync * available from http://www.virtualbox.org. This file is free software;
26456d1900aba0e903e6e1beec552396618322e2vboxsync * you can redistribute it and/or modify it under the terms of the GNU
26456d1900aba0e903e6e1beec552396618322e2vboxsync * General Public License (GPL) as published by the Free Software
26456d1900aba0e903e6e1beec552396618322e2vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
26456d1900aba0e903e6e1beec552396618322e2vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
26456d1900aba0e903e6e1beec552396618322e2vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
26456d1900aba0e903e6e1beec552396618322e2vboxsync *
26456d1900aba0e903e6e1beec552396618322e2vboxsync * The contents of this file may alternatively be used under the terms
26456d1900aba0e903e6e1beec552396618322e2vboxsync * of the Common Development and Distribution License Version 1.0
26456d1900aba0e903e6e1beec552396618322e2vboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
26456d1900aba0e903e6e1beec552396618322e2vboxsync * VirtualBox OSE distribution, in which case the provisions of the
26456d1900aba0e903e6e1beec552396618322e2vboxsync * CDDL are applicable instead of those of the GPL.
26456d1900aba0e903e6e1beec552396618322e2vboxsync *
26456d1900aba0e903e6e1beec552396618322e2vboxsync * You may elect to license modified versions of this file under the
26456d1900aba0e903e6e1beec552396618322e2vboxsync * terms and conditions of either the GPL or the CDDL or both.
26456d1900aba0e903e6e1beec552396618322e2vboxsync *
26456d1900aba0e903e6e1beec552396618322e2vboxsync * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
26456d1900aba0e903e6e1beec552396618322e2vboxsync * Clara, CA 95054 USA or visit http://www.sun.com if you need
26456d1900aba0e903e6e1beec552396618322e2vboxsync * additional information or have any questions.
26456d1900aba0e903e6e1beec552396618322e2vboxsync */
26456d1900aba0e903e6e1beec552396618322e2vboxsync
26456d1900aba0e903e6e1beec552396618322e2vboxsync
26456d1900aba0e903e6e1beec552396618322e2vboxsync/*******************************************************************************
26456d1900aba0e903e6e1beec552396618322e2vboxsync*   Header Files                                                               *
26456d1900aba0e903e6e1beec552396618322e2vboxsync*******************************************************************************/
26456d1900aba0e903e6e1beec552396618322e2vboxsync#include <iprt/string.h>
26456d1900aba0e903e6e1beec552396618322e2vboxsync#include <iprt/mem.h>
26456d1900aba0e903e6e1beec552396618322e2vboxsync#include <iprt/assert.h>
26456d1900aba0e903e6e1beec552396618322e2vboxsync#include <iprt/cpp/autores.h>
26456d1900aba0e903e6e1beec552396618322e2vboxsync#include <iprt/stdarg.h>
26456d1900aba0e903e6e1beec552396618322e2vboxsync#include <VBox/log.h>
26456d1900aba0e903e6e1beec552396618322e2vboxsync#include <VBox/HostServices/GuestControlSvc.h>
26456d1900aba0e903e6e1beec552396618322e2vboxsync
26456d1900aba0e903e6e1beec552396618322e2vboxsync#include "VBGLR3Internal.h"
26456d1900aba0e903e6e1beec552396618322e2vboxsync
26456d1900aba0e903e6e1beec552396618322e2vboxsync
26456d1900aba0e903e6e1beec552396618322e2vboxsync/*******************************************************************************
26456d1900aba0e903e6e1beec552396618322e2vboxsync*   Structures and Typedefs                                                    *
26456d1900aba0e903e6e1beec552396618322e2vboxsync*******************************************************************************/
26456d1900aba0e903e6e1beec552396618322e2vboxsync
26456d1900aba0e903e6e1beec552396618322e2vboxsyncusing namespace guestControl;
26456d1900aba0e903e6e1beec552396618322e2vboxsync
26456d1900aba0e903e6e1beec552396618322e2vboxsync/**
26456d1900aba0e903e6e1beec552396618322e2vboxsync * Connects to the guest control service.
26456d1900aba0e903e6e1beec552396618322e2vboxsync *
26456d1900aba0e903e6e1beec552396618322e2vboxsync * @returns VBox status code
26456d1900aba0e903e6e1beec552396618322e2vboxsync * @param   pu32ClientId    Where to put the client id on success. The client id
26456d1900aba0e903e6e1beec552396618322e2vboxsync *                          must be passed to all the other calls to the service.
26456d1900aba0e903e6e1beec552396618322e2vboxsync */
26456d1900aba0e903e6e1beec552396618322e2vboxsyncVBGLR3DECL(int) VbglR3GuestCtrlConnect(uint32_t *pu32ClientId)
26456d1900aba0e903e6e1beec552396618322e2vboxsync{
26456d1900aba0e903e6e1beec552396618322e2vboxsync    VBoxGuestHGCMConnectInfo Info;
26456d1900aba0e903e6e1beec552396618322e2vboxsync    Info.result = VERR_WRONG_ORDER;
26456d1900aba0e903e6e1beec552396618322e2vboxsync    Info.Loc.type = VMMDevHGCMLoc_LocalHost_Existing;
26456d1900aba0e903e6e1beec552396618322e2vboxsync    RT_ZERO(Info.Loc.u);
26456d1900aba0e903e6e1beec552396618322e2vboxsync    strcpy(Info.Loc.u.host.achName, "VBoxGuestControlSvc");
26456d1900aba0e903e6e1beec552396618322e2vboxsync    Info.u32ClientID = UINT32_MAX;  /* try make valgrid shut up. */
26456d1900aba0e903e6e1beec552396618322e2vboxsync
26456d1900aba0e903e6e1beec552396618322e2vboxsync    int rc = vbglR3DoIOCtl(VBOXGUEST_IOCTL_HGCM_CONNECT, &Info, sizeof(Info));
26456d1900aba0e903e6e1beec552396618322e2vboxsync    if (RT_SUCCESS(rc))
26456d1900aba0e903e6e1beec552396618322e2vboxsync    {
26456d1900aba0e903e6e1beec552396618322e2vboxsync        rc = Info.result;
26456d1900aba0e903e6e1beec552396618322e2vboxsync        if (RT_SUCCESS(rc))
26456d1900aba0e903e6e1beec552396618322e2vboxsync            *pu32ClientId = Info.u32ClientID;
26456d1900aba0e903e6e1beec552396618322e2vboxsync    }
26456d1900aba0e903e6e1beec552396618322e2vboxsync    return rc;
26456d1900aba0e903e6e1beec552396618322e2vboxsync}
26456d1900aba0e903e6e1beec552396618322e2vboxsync
26456d1900aba0e903e6e1beec552396618322e2vboxsync
26456d1900aba0e903e6e1beec552396618322e2vboxsync/**
26456d1900aba0e903e6e1beec552396618322e2vboxsync * Disconnect from the guest control service.
26456d1900aba0e903e6e1beec552396618322e2vboxsync *
26456d1900aba0e903e6e1beec552396618322e2vboxsync * @returns VBox status code.
26456d1900aba0e903e6e1beec552396618322e2vboxsync * @param   u32ClientId     The client id returned by VbglR3GuestCtrlConnect().
26456d1900aba0e903e6e1beec552396618322e2vboxsync */
26456d1900aba0e903e6e1beec552396618322e2vboxsyncVBGLR3DECL(int) VbglR3GuestCtrlDisconnect(uint32_t u32ClientId)
26456d1900aba0e903e6e1beec552396618322e2vboxsync{
26456d1900aba0e903e6e1beec552396618322e2vboxsync    VBoxGuestHGCMDisconnectInfo Info;
26456d1900aba0e903e6e1beec552396618322e2vboxsync    Info.result = VERR_WRONG_ORDER;
26456d1900aba0e903e6e1beec552396618322e2vboxsync    Info.u32ClientID = u32ClientId;
26456d1900aba0e903e6e1beec552396618322e2vboxsync
26456d1900aba0e903e6e1beec552396618322e2vboxsync    int rc = vbglR3DoIOCtl(VBOXGUEST_IOCTL_HGCM_DISCONNECT, &Info, sizeof(Info));
26456d1900aba0e903e6e1beec552396618322e2vboxsync    if (RT_SUCCESS(rc))
26456d1900aba0e903e6e1beec552396618322e2vboxsync        rc = Info.result;
26456d1900aba0e903e6e1beec552396618322e2vboxsync    return rc;
}


/**
 * Gets a host message.
 *
 * This will block until a message becomes available.
 *
 * @returns VBox status code.
 * @param   u32ClientId     The client id returned by VbglR3GuestCtrlConnect().
 * @param   puMsg           Where to store the message id.
 * @param   puNumParms      Where to store the number  of parameters which will be received
 *                          in a second call to the host.
 */
VBGLR3DECL(int) VbglR3GuestCtrlGetHostMsg(uint32_t u32ClientId, uint32_t *puMsg, uint32_t *puNumParms)
{
    VBoxGuestCtrlHGCMMsgType Msg;

    Msg.hdr.result = VERR_WRONG_ORDER;
    Msg.hdr.u32ClientID = u32ClientId;
    Msg.hdr.u32Function = GUEST_GET_HOST_MSG; /* Tell the host we want our next command. */
    Msg.hdr.cParms = 2;

    VbglHGCMParmUInt32Set(&Msg.msg, 0);
    VbglHGCMParmUInt32Set(&Msg.num_parms, 0);

    int rc = vbglR3DoIOCtl(VBOXGUEST_IOCTL_HGCM_CALL(sizeof(Msg)), &Msg, sizeof(Msg));
    if (RT_SUCCESS(rc))
    {
        rc = Msg.hdr.result;
        if (RT_SUCCESS(rc))
        {
            rc = VbglHGCMParmUInt32Get(&Msg.msg, puMsg);
            if (RT_SUCCESS(rc))
                rc = VbglHGCMParmUInt32Get(&Msg.num_parms, puNumParms);
            /* Ok, so now we know what message type and how much parameters there are. */
        }
    }
    return rc;
}


/**
 * Allocates and gets host data, based on the message id.
 *
 * This will block until data becomes available.
 *
 * @returns VBox status code.
 * @param   u32ClientId     The client id returned by VbglR3GuestCtrlConnect().
 * @param   ppvData
 * @param   uNumParms
 */
VBGLR3DECL(int) VbglR3GuestCtrlGetHostCmdExec(uint32_t u32ClientId, uint32_t uNumParms,
                                              char    *pszCmd,      uint32_t cbCmd,
                                              uint32_t *puFlags,
                                              char *pszArgs,        uint32_t cbArgs,  uint32_t *puNumArgs,
                                              char *pszEnv,         uint32_t *pcbEnv, uint32_t *puNumEnvVars,
                                              char *pszStdIn,       uint32_t cbStdIn,
                                              char *pszStdOut,      uint32_t cbStdOut,
                                              char *pszStdErr,      uint32_t cbStdErr,
                                              char *pszUser,        uint32_t cbUser,
                                              char *pszPassword,    uint32_t cbPassword,
                                              uint32_t *puTimeLimit)
{
    VBoxGuestCtrlHGCMMsgExecCmd Msg;

    Msg.hdr.result = VERR_WRONG_ORDER;
    Msg.hdr.u32ClientID = u32ClientId;
    Msg.hdr.u32Function = GUEST_GET_HOST_MSG_DATA; /* Tell the host we want the actual data of a command. */
    Msg.hdr.cParms = uNumParms;

    VbglHGCMParmPtrSet(&Msg.cmd, pszCmd, cbCmd);
    VbglHGCMParmUInt32Set(&Msg.flags, 0);
    VbglHGCMParmUInt32Set(&Msg.num_args, 0);
    VbglHGCMParmPtrSet(&Msg.args, pszArgs, cbArgs);
    VbglHGCMParmUInt32Set(&Msg.num_env, 0);
    VbglHGCMParmPtrSet(&Msg.env, pszEnv, *pcbEnv);
    VbglHGCMParmPtrSet(&Msg.std_in, pszStdIn, cbStdIn);
    VbglHGCMParmPtrSet(&Msg.std_out, pszStdOut, cbStdOut);
    VbglHGCMParmPtrSet(&Msg.std_err, pszStdErr, cbStdErr);
    VbglHGCMParmPtrSet(&Msg.username, pszUser, cbUser);
    VbglHGCMParmPtrSet(&Msg.password, pszPassword, cbPassword);
    VbglHGCMParmUInt32Set(&Msg.timeout, 0);

    int rc = vbglR3DoIOCtl(VBOXGUEST_IOCTL_HGCM_CALL(sizeof(Msg)), &Msg, sizeof(Msg));
    if (RT_SUCCESS(rc))
    {
        rc = Msg.hdr.result;
    }
    return rc;
}