VBoxGuestR3LibSharedFolders.cpp revision 5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync/* $Id$ */
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync/** @file
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync * VBoxGuestR3Lib - Ring-3 Support Library for VirtualBox guest additions, shared folders.
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync */
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync/*
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync * Copyright (C) 2010 Oracle Corporation
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync *
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync * available from http://www.virtualbox.org. This file is free software;
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync * you can redistribute it and/or modify it under the terms of the GNU
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync * General Public License (GPL) as published by the Free Software
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync *
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync * The contents of this file may alternatively be used under the terms
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync * of the Common Development and Distribution License Version 1.0
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync * VirtualBox OSE distribution, in which case the provisions of the
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync * CDDL are applicable instead of those of the GPL.
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync *
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync * You may elect to license modified versions of this file under the
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync * terms and conditions of either the GPL or the CDDL or both.
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync */
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync/*******************************************************************************
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync* Header Files *
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync*******************************************************************************/
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync#include <iprt/string.h>
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync#include <iprt/mem.h>
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync#include <iprt/assert.h>
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync#include <iprt/cpp/autores.h>
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync#include <iprt/stdarg.h>
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync#include <VBox/log.h>
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync#include <VBox/shflsvc.h> /** @todo File should be moved to VBox/HostServices/SharedFolderSvc.h */
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync#include "VBGLR3Internal.h"
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync/**
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync * Connects to the shared folder service.
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync *
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync * @returns VBox status code
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync * @param pu32ClientId Where to put the client id on success. The client id
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync * must be passed to all the other calls to the service.
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync */
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsyncVBGLR3DECL(int) VbglR3SharedFolderConnect(uint32_t *pu32ClientId)
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync{
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync VBoxGuestHGCMConnectInfo Info;
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync Info.result = VERR_WRONG_ORDER;
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync Info.Loc.type = VMMDevHGCMLoc_LocalHost_Existing;
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync RT_ZERO(Info.Loc.u);
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync strcpy(Info.Loc.u.host.achName, "VBoxSharedFolders");
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync Info.u32ClientID = UINT32_MAX; /* try make valgrid shut up. */
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync int rc = vbglR3DoIOCtl(VBOXGUEST_IOCTL_HGCM_CONNECT, &Info, sizeof(Info));
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync if (RT_SUCCESS(rc))
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync {
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync rc = Info.result;
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync if (RT_SUCCESS(rc))
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync *pu32ClientId = Info.u32ClientID;
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync }
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync return rc;
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync}
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync/**
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync * Disconnect from the shared folder service.
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync *
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync * @returns VBox status code.
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync * @param u32ClientId The client id returned by VbglR3InfoSvcConnect().
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync */
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsyncVBGLR3DECL(int) VbglR3SharedFolderDisconnect(uint32_t u32ClientId)
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync{
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync VBoxGuestHGCMDisconnectInfo Info;
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync Info.result = VERR_WRONG_ORDER;
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync Info.u32ClientID = u32ClientId;
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync int rc = vbglR3DoIOCtl(VBOXGUEST_IOCTL_HGCM_DISCONNECT, &Info, sizeof(Info));
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync if (RT_SUCCESS(rc))
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync rc = Info.result;
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync return rc;
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync}
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync/**
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync * Get the list of available shared folders.
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync *
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync * @returns VBox status code.
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync * @param u32ClientId The client id returned by VbglR3InvsSvcConnect().
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync * @param bAutoMountOnly Flag whether only auto-mounted shared folders should be reported.
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync * @param paMappings Pointer to a preallocated array which will retrieve the mapping info.
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync * @param cbMappings Size (in bytes) of the provided array.
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync * @param pcMapCount Number of mappings returned.
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync */
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsyncVBGLR3DECL(int) VbglR3SharedFolderGetMappings(uint32_t u32ClientId, bool bAutoMountOnly,
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync VBGLR3SHAREDFOLDERMAPPING paMappings[], uint32_t cbMappings,
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync uint32_t *pcMapCount)
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync{
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync int rc;
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync AssertPtr(pcMapCount);
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync VBoxSFQueryMappings Msg;
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync Msg.callInfo.result = VERR_WRONG_ORDER;
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync Msg.callInfo.u32ClientID = u32ClientId;
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync Msg.callInfo.u32Function = SHFL_FN_QUERY_MAPPINGS;
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync Msg.callInfo.cParms = 3;
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync /* Set the mapping flags. */
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync uint32_t u32Flags = 0; /* @todo SHFL_MF_UTF8 is not implemented yet. */
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync if (bAutoMountOnly) /* We only want the mappings which get auto-mounted. */
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync u32Flags |= SHFL_MF_AUTOMOUNT;
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync VbglHGCMParmUInt32Set(&Msg.flags, u32Flags);
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync /* Init the rest of the message. */
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync VbglHGCMParmUInt32Set(&Msg.numberOfMappings, *pcMapCount);
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync VbglHGCMParmPtrSet(&Msg.mappings, &paMappings[0], cbMappings);
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync rc = vbglR3DoIOCtl(VBOXGUEST_IOCTL_HGCM_CALL(sizeof(Msg)), &Msg, sizeof(Msg));
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync if (RT_SUCCESS(rc))
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync {
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync VbglHGCMParmUInt32Get(&Msg.numberOfMappings, pcMapCount);
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync rc = Msg.callInfo.result;
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync }
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync return rc;
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync}
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync/**
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync * Get the real name of a shared folder.
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync *
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync * @returns VBox status code.
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync * @param u32ClientId The client id returned by VbglR3InvsSvcConnect().
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync * @param u32Root Root ID of shared folder to get the name for.
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync * @param ppszName Name of the shared folder.
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync * @param pcbLen Length (in bytes) of shared folder name.
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync */
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsyncVBGLR3DECL(int) VbglR3SharedFolderGetName(uint32_t u32ClientId, uint32_t u32Root,
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync char **ppszName, uint32_t *pcbLen)
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync{
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync int rc;
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync AssertPtr(ppszName);
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync AssertPtr(pcbLen);
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync VBoxSFQueryMapName Msg;
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync Msg.callInfo.result = VERR_WRONG_ORDER;
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync Msg.callInfo.u32ClientID = u32ClientId;
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync Msg.callInfo.u32Function = SHFL_FN_QUERY_MAP_NAME;
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync Msg.callInfo.cParms = 2;
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync uint32_t cbString = sizeof(SHFLSTRING) + SHFL_MAX_LEN;
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync PSHFLSTRING pString = (PSHFLSTRING)RTMemAlloc(cbString);
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync if (pString)
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync {
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync RT_ZERO(*pString);
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync ShflStringInitBuffer(pString, SHFL_MAX_LEN);
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync VbglHGCMParmUInt32Set(&Msg.root, u32Root);
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync VbglHGCMParmPtrSet(&Msg.name, pString, cbString);
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync rc = vbglR3DoIOCtl(VBOXGUEST_IOCTL_HGCM_CALL(sizeof(Msg)), &Msg, sizeof(Msg));
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync if (RT_SUCCESS(rc))
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync {
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync *ppszName = NULL;
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync rc = RTUtf16ToUtf8Ex((PCRTUTF16)&pString->String.ucs2, RTSTR_MAX,
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync ppszName, (size_t)pcbLen, NULL);
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync if (RT_SUCCESS(rc))
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync rc = Msg.callInfo.result;
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync }
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync RTMemFree(pString);
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync }
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync else
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync rc = VERR_INVALID_PARAMETER;
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync return rc;
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync}
5923a1e1a9eff5786a4dc5a281e11b7dc4fd0811vboxsync