e6660f4933111b0649ffa77483102881f4e75c3bvboxsync/* $Id$ */
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync/** @file
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync * VBoxGuestR3Lib - Ring-3 Support Library for VirtualBox guest additions, Logging.
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync */
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync/*
e64031e20c39650a7bc902a3e1aba613b9415deevboxsync * Copyright (C) 2007-2010 Oracle Corporation
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync *
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync * available from http://www.virtualbox.org. This file is free software;
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync * you can redistribute it and/or modify it under the terms of the GNU
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync * General Public License (GPL) as published by the Free Software
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync *
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync * The contents of this file may alternatively be used under the terms
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync * of the Common Development and Distribution License Version 1.0
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync * VirtualBox OSE distribution, in which case the provisions of the
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync * CDDL are applicable instead of those of the GPL.
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync *
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync * You may elect to license modified versions of this file under the
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync * terms and conditions of either the GPL or the CDDL or both.
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync */
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync/*******************************************************************************
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync* Header Files *
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync*******************************************************************************/
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync#include <iprt/mem.h>
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync#include "VBGLR3Internal.h"
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync/**
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync * Write to the backdoor logger from ring 3 guest code.
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync *
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync * @returns IPRT status code.
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync *
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync * @param pch The string to log. Does not need to be terminated.
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync * @param cch The number of chars (bytes) to log.
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync *
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync * @remarks This currently does not accept more than 255 bytes of data at
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync * one time. It should probably be rewritten to use pass a pointer
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync * in the IOCtl.
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync */
e6660f4933111b0649ffa77483102881f4e75c3bvboxsyncVBGLR3DECL(int) VbglR3WriteLog(const char *pch, size_t cch)
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync{
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync /*
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync * Quietly skip NULL strings.
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync * (Happens in the RTLogBackdoorPrintf case.)
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync */
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync if (!cch)
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync return VINF_SUCCESS;
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync if (!VALID_PTR(pch))
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync return VERR_INVALID_POINTER;
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync#ifdef RT_OS_WINDOWS
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync /*
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync * Duplicate the string as it may be read only (a C string).
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync */
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync void *pvTmp = RTMemDup(pch, cch);
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync if (!pvTmp)
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync return VERR_NO_MEMORY;
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync int rc = vbglR3DoIOCtl(VBOXGUEST_IOCTL_LOG(cch), pvTmp, cch);
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync RTMemFree(pvTmp);
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync return rc;
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync#elif 0 /** @todo Several OSes could take this route (solaris and freebsd for instance). */
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync /*
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync * Handle the entire request in one go.
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync */
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync return vbglR3DoIOCtl(VBOXGUEST_IOCTL_LOG(cch), pvTmp, cch);
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync#else
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync /*
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync * *BSD does not accept more than 4KB per ioctl request, while
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync * Linux can't express sizes above 8KB, so, split it up into 2KB chunks.
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync */
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync# define STEP 2048
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync int rc = VINF_SUCCESS;
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync for (size_t off = 0; off < cch && RT_SUCCESS(rc); off += STEP)
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync {
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync size_t cbStep = RT_MIN(cch - off, STEP);
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync rc = vbglR3DoIOCtl(VBOXGUEST_IOCTL_LOG(cbStep), (char *)pch + off, cbStep);
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync }
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync# undef STEP
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync return rc;
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync#endif
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync}
e6660f4933111b0649ffa77483102881f4e75c3bvboxsync