1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
|
/* $Id$ */
/** @file
* fsw_base.h - Base definitions switch.
*/
/*
* Copyright (C) 2010-2022 Oracle and/or its affiliates.
*
* This file is part of VirtualBox base platform packages, as
* available from https://www.virtualbox.org.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation, in version 3 of the
* License.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see <https://www.gnu.org/licenses>.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
* in the VirtualBox 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.
*
* SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
* ---------------------------------------------------------------------------
* This code is based on:
*
* Copyright (c) 2006 Christoph Pfisterer
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the
* distribution.
*
* * Neither the name of Christoph Pfisterer nor the names of the
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef _FSW_BASE_H_
#define _FSW_BASE_H_
#ifdef VBOX
#include "VBoxFswParam.h"
#endif
#ifndef FSW_DEBUG_LEVEL
/**
* Global debugging level. Can be set locally for the scope of a single
* file by defining the macro before fsw_base.h is included.
*/
#define FSW_DEBUG_LEVEL 1
#endif
#ifdef HOST_EFI
#include "fsw_efi_base.h"
#endif
#ifdef HOST_POSIX
#include "fsw_posix_base.h"
#endif
// message printing
#if FSW_DEBUG_LEVEL >= 1
#define FSW_MSG_ASSERT(params) FSW_MSGFUNC params
#else
#define FSW_MSG_ASSERT(params)
#endif
#if FSW_DEBUG_LEVEL >= 2
#define FSW_MSG_DEBUG(params) FSW_MSGFUNC params
#else
#define FSW_MSG_DEBUG(params)
#endif
#if FSW_DEBUG_LEVEL >= 3
#define FSW_MSG_DEBUGV(params) FSW_MSGFUNC params
#else
#define FSW_MSG_DEBUGV(params)
#endif
// Documentation for system-dependent defines
/**
* \typedef fsw_s8
* Signed 8-bit integer.
*/
/**
* \typedef fsw_u8
* Unsigned 8-bit integer.
*/
/**
* \typedef fsw_s16
* Signed 16-bit integer.
*/
/**
* \typedef fsw_u16
* Unsigned 16-bit integer.
*/
/**
* \typedef fsw_s32
* Signed 32-bit integer.
*/
/**
* \typedef fsw_u32
* Unsigned 32-bit integer.
*/
/**
* \typedef fsw_s64
* Signed 64-bit integer.
*/
/**
* \typedef fsw_u64
* Unsigned 64-bit integer.
*/
/**
* \def fsw_alloc(size,ptrptr)
* Allocate memory on the heap. This function or macro allocates \a size
* bytes of memory using host-specific methods. The address of the
* allocated memory block is stored into the pointer variable pointed
* to by \a ptrptr. A status code is returned; FSW_SUCCESS if the block
* was allocated or FSW_OUT_OF_MEMORY if there is not enough memory
* to allocated the requested block.
*/
/**
* \def fsw_free(ptr)
* Release allocated memory. This function or macro returns an allocated
* memory block to the heap for reuse. Does not return a status.
*/
/**
* \def fsw_memcpy(dest,src,size)
* Copies a block of memory from \a src to \a dest. The two memory blocks
* must not overlap, or the result of the operation will be undefined.
* Does not return a status.
*/
/**
* \def fsw_memeq(dest,src,size)
* Compares two blocks of memory for equality. Returns boolean true if the
* memory blocks are equal, boolean false if they are different.
*/
/**
* \def fsw_memzero(dest,size)
* Initializes a block of memory with zeros. Does not return a status.
*/
#endif
|
