/* $Id$ */
/** @file
* VBoxGuestR3Lib - Ring-3 Support Library for VirtualBox guest additions,
* guest user reporting / utility functions.
*/
/*
* Copyright (C) 2013 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* you can redistribute it and/or modify it under the terms of the GNU
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
* VirtualBox OSE distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*/
/*******************************************************************************
* Header Files *
*******************************************************************************/
#include <iprt/assert.h>
#include <VBox/log.h>
#include <iprt/mem.h>
#include <iprt/string.h>
#include "VBGLR3Internal.h"
/**
* Reports a state change of a specific guest user.
*
* @returns IPRT status value
* @param pszUser Guest user name to report state for.
* @param pszDomain Domain the guest user's account is bound to.
* @param enmState Guest user state to report.
* @param puDetails Pointer to state details. Optional.
* @param cbDetails Size (in bytes) of state details. Pass 0
* if puDetails is NULL.
*/
VBGLR3DECL(int) VbglR3GuestUserReportState(const char *pszUser,
const char *pszDomain,
VBoxGuestUserState enmState,
uint8_t *puDetails,
uint32_t cbDetails)
{
AssertPtrReturn(pszUser, VERR_INVALID_POINTER);
/* pszDomain is optional. */
/* puDetails is optional. */
uint32_t cbBase = sizeof(VMMDevReportGuestUserState);
uint32_t cbUser = strlen(pszUser) + 1; /* Include terminating zero */
uint32_t cbDomain = pszDomain ? strlen(pszDomain) + 1 /* Dito */ : 0;
/* Allocate enough space for all fields. */
unsigned long cbSize =
cbBase
+ cbUser
+ cbDomain
+ cbDetails;
AssertReturn(cbSize, VERR_BUFFER_UNDERFLOW);
VMMDevReportGuestUserState *pReport =
(VMMDevReportGuestUserState *)RTMemAllocZ(cbSize);
if (!pReport)
return VERR_NO_MEMORY;
int rc = vmmdevInitRequest(&pReport->header, VMMDevReq_ReportGuestUserState);
if (RT_SUCCESS(rc))
{
pReport->header.size = cbSize;
pReport->status.state = enmState;
pReport->status.cbUser = cbUser;
pReport->status.cbDomain = cbDomain;
pReport->status.cbDetails = cbDetails;
/*
* Note: cbOffDynamic contains the first dynamic array entry within
* VBoxGuestUserStatus.
* Therefore it's vital to *not* change the order of the struct members
* without altering this code. Don't try this at home.
*/
uint32_t cbOffDynamic =
RT_OFFSETOF(VBoxGuestUserStatus, szUser);
/* pDynamic marks the beginning for the dynamically allocated areas. */
uint8_t *pDynamic = (uint8_t *)&pReport->status;
pDynamic += cbOffDynamic;
AssertPtr(pDynamic);
memcpy(pDynamic, pszUser, cbUser);
if (cbDomain)
memcpy(pDynamic + cbUser, pszDomain, cbDomain);
if (cbDetails)
memcpy(pDynamic + cbUser + cbDomain, puDetails, cbDetails);
rc = vbglR3GRPerform(&pReport->header);
}
RTMemFree(pReport);
return rc;
}