4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * fsw_base.h - Base definitions switch.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Copyright (C) 2010 Oracle Corporation
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * available from http://www.virtualbox.org. This file is free software;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * you can redistribute it and/or modify it under the terms of the GNU
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * General Public License (GPL) as published by the Free Software
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * The contents of this file may alternatively be used under the terms
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * of the Common Development and Distribution License Version 1.0
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * VirtualBox OSE distribution, in which case the provisions of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * CDDL are applicable instead of those of the GPL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * You may elect to license modified versions of this file under the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * terms and conditions of either the GPL or the CDDL or both.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * This code is based on:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Copyright (c) 2006 Christoph Pfisterer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Redistribution and use in source and binary forms, with or without
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * modification, are permitted provided that the following conditions are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * * Redistributions of source code must retain the above copyright
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * notice, this list of conditions and the following disclaimer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * * Redistributions in binary form must reproduce the above copyright
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * notice, this list of conditions and the following disclaimer in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * documentation and/or other materials provided with the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * distribution.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * * Neither the name of Christoph Pfisterer nor the names of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * contributors may be used to endorse or promote products derived
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * from this software without specific prior written permission.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Global debugging level. Can be set locally for the scope of a single
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * file by defining the macro before fsw_base.h is included.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// message printing
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Documentation for system-dependent defines
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * \typedef fsw_s8
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Signed 8-bit integer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * \typedef fsw_u8
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Unsigned 8-bit integer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * \typedef fsw_s16
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Signed 16-bit integer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * \typedef fsw_u16
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Unsigned 16-bit integer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * \typedef fsw_s32
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Signed 32-bit integer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * \typedef fsw_u32
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Unsigned 32-bit integer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * \typedef fsw_s64
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Signed 64-bit integer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * \typedef fsw_u64
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Unsigned 64-bit integer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * \def fsw_alloc(size,ptrptr)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Allocate memory on the heap. This function or macro allocates \a size
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * bytes of memory using host-specific methods. The address of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * allocated memory block is stored into the pointer variable pointed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * to by \a ptrptr. A status code is returned; FSW_SUCCESS if the block
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * was allocated or FSW_OUT_OF_MEMORY if there is not enough memory
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * to allocated the requested block.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * \def fsw_free(ptr)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Release allocated memory. This function or macro returns an allocated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * memory block to the heap for reuse. Does not return a status.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * \def fsw_memcpy(dest,src,size)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Copies a block of memory from \a src to \a dest. The two memory blocks
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * must not overlap, or the result of the operation will be undefined.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Does not return a status.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * \def fsw_memeq(dest,src,size)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Compares two blocks of memory for equality. Returns boolean true if the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * memory blocks are equal, boolean false if they are different.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * \def fsw_memzero(dest,size)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Initializes a block of memory with zeros. Does not return a status.