VirtualBox

source: vbox/trunk/src/VBox/ValidationKit/bootsectors/bs3kit/bs3kit.h@ 74946

Last change on this file since 74946 was 72146, checked in by vboxsync, 7 years ago

bs3kit: Made g_fBs3TrapNoV86Assist only apply to #GP assist, not to the V86 syscall stuff.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 161.3 KB
Line 
1/* $Id: bs3kit.h 72146 2018-05-07 15:22:35Z vboxsync $ */
2/** @file
3 * BS3Kit - structures, symbols, macros and stuff.
4 */
5
6/*
7 * Copyright (C) 2007-2017 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 *
17 * The contents of this file may alternatively be used under the terms
18 * of the Common Development and Distribution License Version 1.0
19 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
20 * VirtualBox OSE distribution, in which case the provisions of the
21 * CDDL are applicable instead of those of the GPL.
22 *
23 * You may elect to license modified versions of this file under the
24 * terms and conditions of either the GPL or the CDDL or both.
25 */
26
27#ifndef ___bs3kit_h
28#define ___bs3kit_h
29
30#ifndef DOXYGEN_RUNNING
31# undef IN_RING0
32# define IN_RING0
33#endif
34
35#define RT_NO_STRICT /* Don't drag in IPRT assertion code in inline code we may use (asm.h). */
36#include <iprt/cdefs.h>
37#include <iprt/types.h>
38
39#ifndef DOXYGEN_RUNNING
40# undef IN_RING0
41#endif
42
43/*
44 * Make asm.h and friend compatible with our 64-bit assembly config (ASM_CALL64_MSC).
45 */
46#if defined(__GNUC__) && ARCH_BITS == 64
47# undef DECLASM
48# ifdef __cplusplus
49# define DECLASM(type) extern "C" type BS3_CALL
50# else
51# define DECLASM(type) type BS3_CALL
52# endif
53#endif
54
55
56/*
57 * Work around ms_abi trouble in the gcc camp (gcc bugzilla #50818).
58 * ASSUMES all va_lists are in functions with
59 */
60#if defined(__GNUC__) && ARCH_BITS == 64
61# undef va_list
62# undef va_start
63# undef va_end
64# undef va_copy
65# define va_list __builtin_ms_va_list
66# define va_start(a_Va, a_Arg) __builtin_ms_va_start(a_Va, a_Arg)
67# define va_end(a_Va) __builtin_ms_va_end(a_Va)
68# define va_copy(a_DstVa, a_SrcVa) __builtin_ms_va_copy(a_DstVa, a_SrcVa)
69#endif
70
71
72/** @def BS3_USE_ALT_16BIT_TEXT_SEG
73 * @ingroup grp_bs3kit
74 * Combines the BS3_USE_RM_TEXT_SEG, BS3_USE_X0_TEXT_SEG, and
75 * BS3_USE_X1_TEXT_SEG indicators into a single one.
76 */
77#if defined(BS3_USE_RM_TEXT_SEG) || defined(BS3_USE_X0_TEXT_SEG) || defined(BS3_USE_X1_TEXT_SEG) || defined(DOXYGEN_RUNNING)
78# define BS3_USE_ALT_16BIT_TEXT_SEG
79#else
80# undef BS3_USE_ALT_16BIT_TEXT_SEG
81#endif
82
83/** @def BS3_USE_X0_TEXT_SEG
84 * @ingroup grp_bs3kit
85 * Emit 16-bit code to the BS3X0TEXT16 segment - ignored for 32-bit and 64-bit.
86 *
87 * Calling directly into the BS3X0TEXT16 segment is only possible in real-mode
88 * and v8086 mode. In protected mode the real far pointer have to be converted
89 * to a protected mode pointer that uses BS3_SEL_X0TEXT16_CS, Bs3TestDoModes and
90 * associates does this automatically.
91 */
92#ifdef DOXYGEN_RUNNING
93# define BS3_USE_X0_TEXT_SEG
94#endif
95
96/** @def BS3_USE_X1_TEXT_SEG
97 * @ingroup grp_bs3kit
98 * Emit 16-bit code to the BS3X1TEXT16 segment - ignored for 32-bit and 64-bit.
99 *
100 * Calling directly into the BS3X1TEXT16 segment is only possible in real-mode
101 * and v8086 mode. In protected mode the real far pointer have to be converted
102 * to a protected mode pointer that uses BS3_SEL_X1TEXT16_CS, Bs3TestDoModes and
103 * associates does this automatically.
104 */
105#ifdef DOXYGEN_RUNNING
106# define BS3_USE_X1_TEXT_SEG
107#endif
108
109/** @def BS3_USE_RM_TEXT_SEG
110 * @ingroup grp_bs3kit
111 * Emit 16-bit code to the BS3RMTEXT16 segment - ignored for 32-bit and 64-bit.
112 *
113 * This segment is normally used for real-mode only code, though
114 * BS3_SEL_RMTEXT16_CS can be used to call it from protected mode. Unlike the
115 * BS3X0TEXT16 and BS3X1TEXT16 segments which are empty by default, this segment
116 * is used by common BS3Kit code.
117 */
118#ifdef DOXYGEN_RUNNING
119# define BS3_USE_X0_TEXT_SEG
120#endif
121
122/** @def BS3_MODEL_FAR_CODE
123 * @ingroup grp_bs3kit
124 * Default compiler model indicates far code.
125 */
126#ifdef DOXYGEN_RUNNING
127# define BS3_MODEL_FAR_CODE
128#elif !defined(BS3_MODEL_FAR_CODE) && (defined(__LARGE__) || defined(__MEDIUM__) || defined(__HUGE__)) && ARCH_BITS == 16
129# define BS3_MODEL_FAR_CODE
130#endif
131
132
133/*
134 * We normally don't want the noreturn / aborts attributes as they mess up stack traces.
135 *
136 * Note! pragma aux <fnname> aborts can only be used with functions
137 * implemented in C and functions that does not have parameters.
138 */
139#define BS3_KIT_WITH_NO_RETURN
140#ifndef BS3_KIT_WITH_NO_RETURN
141# undef DECL_NO_RETURN
142# define DECL_NO_RETURN(type) type
143#endif
144
145
146/*
147 * We may want to reuse some IPRT code in the common name space, so we
148 * redefine the RT_MANGLER to work like BS3_CMN_NM. (We cannot use
149 * BS3_CMN_NM yet, as we need to include IPRT headers with function
150 * declarations before we can define it. Thus the duplciate effort.)
151 */
152#if ARCH_BITS == 16
153# undef RTCALL
154# if defined(BS3_USE_ALT_16BIT_TEXT_SEG)
155# define RTCALL __cdecl __far
156# define RT_MANGLER(a_Name) RT_CONCAT(a_Name,_f16)
157# else
158# define RTCALL __cdecl __near
159# define RT_MANGLER(a_Name) RT_CONCAT(a_Name,_c16)
160# endif
161#else
162# define RT_MANGLER(a_Name) RT_CONCAT3(a_Name,_c,ARCH_BITS)
163#endif
164#include <iprt/mangling.h>
165#include <iprt/x86.h>
166#include <iprt/err.h>
167
168/*
169 * Include data symbol mangling (function mangling/mapping must be done
170 * after the protypes).
171 */
172#include "bs3kit-mangling-data.h"
173
174
175
176RT_C_DECLS_BEGIN
177
178/** @defgroup grp_bs3kit BS3Kit - Boot Sector Kit \#3
179 *
180 * The BS3Kit is a framework for bare metal floppy/usb image tests,
181 * see the @ref pg_bs3kit "doc page" for more.
182 *
183 * @{ */
184
185/** @name Execution modes.
186 * @{ */
187#define BS3_MODE_INVALID UINT8_C(0x00)
188#define BS3_MODE_RM UINT8_C(0x01) /**< real mode. */
189#define BS3_MODE_PE16 UINT8_C(0x11) /**< 16-bit protected mode kernel+tss, running 16-bit code, unpaged. */
190#define BS3_MODE_PE16_32 UINT8_C(0x12) /**< 16-bit protected mode kernel+tss, running 32-bit code, unpaged. */
191#define BS3_MODE_PE16_V86 UINT8_C(0x18) /**< 16-bit protected mode kernel+tss, running virtual 8086 mode code, unpaged. */
192#define BS3_MODE_PE32 UINT8_C(0x22) /**< 32-bit protected mode kernel+tss, running 32-bit code, unpaged. */
193#define BS3_MODE_PE32_16 UINT8_C(0x21) /**< 32-bit protected mode kernel+tss, running 16-bit code, unpaged. */
194#define BS3_MODE_PEV86 UINT8_C(0x28) /**< 32-bit protected mode kernel+tss, running virtual 8086 mode code, unpaged. */
195#define BS3_MODE_PP16 UINT8_C(0x31) /**< 16-bit protected mode kernel+tss, running 16-bit code, paged. */
196#define BS3_MODE_PP16_32 UINT8_C(0x32) /**< 16-bit protected mode kernel+tss, running 32-bit code, paged. */
197#define BS3_MODE_PP16_V86 UINT8_C(0x38) /**< 16-bit protected mode kernel+tss, running virtual 8086 mode code, paged. */
198#define BS3_MODE_PP32 UINT8_C(0x42) /**< 32-bit protected mode kernel+tss, running 32-bit code, paged. */
199#define BS3_MODE_PP32_16 UINT8_C(0x41) /**< 32-bit protected mode kernel+tss, running 16-bit code, paged. */
200#define BS3_MODE_PPV86 UINT8_C(0x48) /**< 32-bit protected mode kernel+tss, running virtual 8086 mode code, paged. */
201#define BS3_MODE_PAE16 UINT8_C(0x51) /**< 16-bit protected mode kernel+tss, running 16-bit code, PAE paging. */
202#define BS3_MODE_PAE16_32 UINT8_C(0x52) /**< 16-bit protected mode kernel+tss, running 32-bit code, PAE paging. */
203#define BS3_MODE_PAE16_V86 UINT8_C(0x58) /**< 16-bit protected mode kernel+tss, running virtual 8086 mode, PAE paging. */
204#define BS3_MODE_PAE32 UINT8_C(0x62) /**< 32-bit protected mode kernel+tss, running 32-bit code, PAE paging. */
205#define BS3_MODE_PAE32_16 UINT8_C(0x61) /**< 32-bit protected mode kernel+tss, running 16-bit code, PAE paging. */
206#define BS3_MODE_PAEV86 UINT8_C(0x68) /**< 32-bit protected mode kernel+tss, running virtual 8086 mode, PAE paging. */
207#define BS3_MODE_LM16 UINT8_C(0x71) /**< 16-bit long mode (paged), kernel+tss always 64-bit. */
208#define BS3_MODE_LM32 UINT8_C(0x72) /**< 32-bit long mode (paged), kernel+tss always 64-bit. */
209#define BS3_MODE_LM64 UINT8_C(0x74) /**< 64-bit long mode (paged), kernel+tss always 64-bit. */
210
211#define BS3_MODE_CODE_MASK UINT8_C(0x0f) /**< Running code mask. */
212#define BS3_MODE_CODE_16 UINT8_C(0x01) /**< Running 16-bit code. */
213#define BS3_MODE_CODE_32 UINT8_C(0x02) /**< Running 32-bit code. */
214#define BS3_MODE_CODE_64 UINT8_C(0x04) /**< Running 64-bit code. */
215#define BS3_MODE_CODE_V86 UINT8_C(0x08) /**< Running 16-bit virtual 8086 code. */
216
217#define BS3_MODE_SYS_MASK UINT8_C(0xf0) /**< kernel+tss mask. */
218#define BS3_MODE_SYS_RM UINT8_C(0x00) /**< Real mode kernel+tss. */
219#define BS3_MODE_SYS_PE16 UINT8_C(0x10) /**< 16-bit protected mode kernel+tss. */
220#define BS3_MODE_SYS_PE32 UINT8_C(0x20) /**< 32-bit protected mode kernel+tss. */
221#define BS3_MODE_SYS_PP16 UINT8_C(0x30) /**< 16-bit paged protected mode kernel+tss. */
222#define BS3_MODE_SYS_PP32 UINT8_C(0x40) /**< 32-bit paged protected mode kernel+tss. */
223#define BS3_MODE_SYS_PAE16 UINT8_C(0x50) /**< 16-bit PAE paged protected mode kernel+tss. */
224#define BS3_MODE_SYS_PAE32 UINT8_C(0x60) /**< 32-bit PAE paged protected mode kernel+tss. */
225#define BS3_MODE_SYS_LM UINT8_C(0x70) /**< 64-bit (paged) long mode protected mode kernel+tss. */
226
227/** Whether the mode has paging enabled. */
228#define BS3_MODE_IS_PAGED(a_fMode) ((a_fMode) >= BS3_MODE_PP16)
229/** Whether the mode has legacy paging enabled (legacy as opposed to PAE or
230 * long mode). */
231#define BS3_MODE_IS_LEGACY_PAGING(a_fMode) ((a_fMode) >= BS3_MODE_PP16 && (a_fMode) < BS3_MODE_PAE16)
232
233/** Whether the mode is running v8086 code. */
234#define BS3_MODE_IS_V86(a_fMode) (((a_fMode) & BS3_MODE_CODE_MASK) == BS3_MODE_CODE_V86)
235/** Whether the we're executing in real mode or v8086 mode. */
236#define BS3_MODE_IS_RM_OR_V86(a_fMode) ((a_fMode) == BS3_MODE_RM || BS3_MODE_IS_V86(a_fMode))
237/** Whether the mode is running 16-bit code, except v8086. */
238#define BS3_MODE_IS_16BIT_CODE_NO_V86(a_fMode) (((a_fMode) & BS3_MODE_CODE_MASK) == BS3_MODE_CODE_16)
239/** Whether the mode is running 16-bit code (includes v8086). */
240#define BS3_MODE_IS_16BIT_CODE(a_fMode) (BS3_MODE_IS_16BIT_CODE_NO_V86(a_fMode) || BS3_MODE_IS_V86(a_fMode))
241/** Whether the mode is running 32-bit code. */
242#define BS3_MODE_IS_32BIT_CODE(a_fMode) (((a_fMode) & BS3_MODE_CODE_MASK) == BS3_MODE_CODE_32)
243/** Whether the mode is running 64-bit code. */
244#define BS3_MODE_IS_64BIT_CODE(a_fMode) (((a_fMode) & BS3_MODE_CODE_MASK) == BS3_MODE_CODE_64)
245
246/** Whether the system is in real mode. */
247#define BS3_MODE_IS_RM_SYS(a_fMode) (((a_fMode) & BS3_MODE_SYS_MASK) == BS3_MODE_SYS_RM)
248/** Whether the system is some 16-bit mode that isn't real mode. */
249#define BS3_MODE_IS_16BIT_SYS_NO_RM(a_fMode) ( ((a_fMode) & BS3_MODE_SYS_MASK) == BS3_MODE_SYS_PE16 \
250 || ((a_fMode) & BS3_MODE_SYS_MASK) == BS3_MODE_SYS_PP16 \
251 || ((a_fMode) & BS3_MODE_SYS_MASK) == BS3_MODE_SYS_PAE16)
252/** Whether the system is some 16-bit mode (includes real mode). */
253#define BS3_MODE_IS_16BIT_SYS(a_fMode) (BS3_MODE_IS_16BIT_SYS_NO_RM(a_fMode) || BS3_MODE_IS_RM_SYS(a_fMode))
254/** Whether the system is some 32-bit mode. */
255#define BS3_MODE_IS_32BIT_SYS(a_fMode) ( ((a_fMode) & BS3_MODE_SYS_MASK) == BS3_MODE_SYS_PE32 \
256 || ((a_fMode) & BS3_MODE_SYS_MASK) == BS3_MODE_SYS_PP32 \
257 || ((a_fMode) & BS3_MODE_SYS_MASK) == BS3_MODE_SYS_PAE32)
258/** Whether the system is long mode. */
259#define BS3_MODE_IS_64BIT_SYS(a_fMode) (((a_fMode) & BS3_MODE_SYS_MASK) == BS3_MODE_SYS_LM)
260
261/** Whether the system is in protected mode (with or without paging).
262 * @note Long mode is not included. */
263#define BS3_MODE_IS_PM_SYS(a_fMode) ((a_fMode) >= BS3_MODE_SYS_PE16 && (a_fMode) < BS3_MODE_SYS_LM)
264
265/** @todo testcase: How would long-mode handle a 16-bit TSS loaded prior to the switch? (mainly stack switching wise) Hopefully, it will tripple fault, right? */
266/** @} */
267
268
269/** @name BS3_ADDR_XXX - Static Memory Allocation
270 * @{ */
271/** The flat load address for the code after the bootsector. */
272#define BS3_ADDR_LOAD 0x10000
273/** Where we save the boot registers during init.
274 * Located right before the code. */
275#define BS3_ADDR_REG_SAVE (BS3_ADDR_LOAD - sizeof(BS3REGCTX) - 8)
276/** Where the stack starts (initial RSP value).
277 * Located 16 bytes (assumed by boot sector) before the saved registers.
278 * SS.BASE=0. The size is a little short of 32KB */
279#define BS3_ADDR_STACK (BS3_ADDR_REG_SAVE - 16)
280/** The ring-0 stack (8KB) for ring transitions. */
281#define BS3_ADDR_STACK_R0 0x06000
282/** The ring-1 stack (8KB) for ring transitions. */
283#define BS3_ADDR_STACK_R1 0x04000
284/** The ring-2 stack (8KB) for ring transitions. */
285#define BS3_ADDR_STACK_R2 0x02000
286/** IST1 ring-0 stack for long mode (4KB), used for double faults elsewhere. */
287#define BS3_ADDR_STACK_R0_IST1 0x09000
288/** IST2 ring-0 stack for long mode (3KB), used for spare 0 stack elsewhere. */
289#define BS3_ADDR_STACK_R0_IST2 0x08000
290/** IST3 ring-0 stack for long mode (1KB). */
291#define BS3_ADDR_STACK_R0_IST3 0x07400
292/** IST4 ring-0 stack for long mode (1KB), used for spare 1 stack elsewhere. */
293#define BS3_ADDR_STACK_R0_IST4 0x07000
294/** IST5 ring-0 stack for long mode (1KB). */
295#define BS3_ADDR_STACK_R0_IST5 0x06c00
296/** IST6 ring-0 stack for long mode (1KB). */
297#define BS3_ADDR_STACK_R0_IST6 0x06800
298/** IST7 ring-0 stack for long mode (1KB). */
299#define BS3_ADDR_STACK_R0_IST7 0x06400
300
301/** The base address of the BS3TEXT16 segment (same as BS3_LOAD_ADDR).
302 * @sa BS3_SEL_TEXT16 */
303#define BS3_ADDR_BS3TEXT16 0x10000
304/** The base address of the BS3SYSTEM16 segment.
305 * @sa BS3_SEL_SYSTEM16 */
306#define BS3_ADDR_BS3SYSTEM16 0x20000
307/** The base address of the BS3DATA16/BS3KIT_GRPNM_DATA16 segment.
308 * @sa BS3_SEL_DATA16 */
309#define BS3_ADDR_BS3DATA16 0x29000
310/** @} */
311
312/** @name BS3_SEL_XXX - GDT selector assignments.
313 *
314 * The real mode segment numbers for BS16TEXT, BS16DATA and BS16SYSTEM are
315 * present in the GDT, this allows the 16-bit C/C++ and assembly code to
316 * continue using the real mode segment values in ring-0 protected mode.
317 *
318 * The three segments have fixed locations:
319 * | segment | flat address | real mode segment |
320 * | ----------- | ------------ | ----------------- |
321 * | BS3TEXT16 | 0x00010000 | 1000h |
322 * | BS3SYSTEM16 | 0x00020000 | 2000h |
323 * | BS3DATA16 | 0x00029000 | 2900h |
324 *
325 * This means that we've got a lot of GDT space to play around with.
326 *
327 * @{ */
328#define BS3_SEL_LDT 0x0010 /**< The LDT selector for Bs3Ldt. */
329#define BS3_SEL_TSS16 0x0020 /**< The 16-bit TSS selector. */
330#define BS3_SEL_TSS16_DF 0x0028 /**< The 16-bit TSS selector for double faults. */
331#define BS3_SEL_TSS16_SPARE0 0x0030 /**< The 16-bit TSS selector for testing. */
332#define BS3_SEL_TSS16_SPARE1 0x0038 /**< The 16-bit TSS selector for testing. */
333#define BS3_SEL_TSS32 0x0040 /**< The 32-bit TSS selector. */
334#define BS3_SEL_TSS32_DF 0x0048 /**< The 32-bit TSS selector for double faults. */
335#define BS3_SEL_TSS32_SPARE0 0x0050 /**< The 32-bit TSS selector for testing. */
336#define BS3_SEL_TSS32_SPARE1 0x0058 /**< The 32-bit TSS selector for testing. */
337#define BS3_SEL_TSS32_IOBP_IRB 0x0060 /**< The 32-bit TSS selector with I/O permission and interrupt redirection bitmaps. */
338#define BS3_SEL_TSS32_IRB 0x0068 /**< The 32-bit TSS selector with only interrupt redirection bitmap (IOPB stripped by limit). */
339#define BS3_SEL_TSS64 0x0070 /**< The 64-bit TSS selector. */
340#define BS3_SEL_TSS64_SPARE0 0x0080 /**< The 64-bit TSS selector. */
341#define BS3_SEL_TSS64_SPARE1 0x0090 /**< The 64-bit TSS selector. */
342#define BS3_SEL_TSS64_IOBP 0x00a0 /**< The 64-bit TSS selector. */
343
344#define BS3_SEL_RMTEXT16_CS 0x00e0 /**< Conforming code selector for accessing the BS3RMTEXT16 segment. Runtime config. */
345#define BS3_SEL_X0TEXT16_CS 0x00e8 /**< Conforming code selector for accessing the BS3X0TEXT16 segment. Runtime config. */
346#define BS3_SEL_X1TEXT16_CS 0x00f0 /**< Conforming code selector for accessing the BS3X1TEXT16 segment. Runtime config. */
347#define BS3_SEL_VMMDEV_MMIO16 0x00f8 /**< Selector for accessing the VMMDev MMIO segment at 0100000h from 16-bit code. */
348
349/** Checks if @a uSel is in the BS3_SEL_RX_XXX range. */
350#define BS3_SEL_IS_IN_RING_RANGE(uSel) ( (unsigned)(uSel - BS3_SEL_R0_FIRST) < (unsigned)(4 << BS3_SEL_RING_SHIFT) )
351#define BS3_SEL_RING_SHIFT 8 /**< For the formula: BS3_SEL_R0_XXX + ((cs & 3) << BS3_SEL_RING_SHIFT) */
352#define BS3_SEL_RING_SUB_MASK 0x00f8 /**< Mask for getting the sub-selector. For use with BS3_SEL_R*_FIRST. */
353
354/** Checks if @a uSel is in the BS3_SEL_R0_XXX range. */
355#define BS3_SEL_IS_IN_R0_RANGE(uSel) ( (unsigned)(uSel - BS3_SEL_R0_FIRST) < (unsigned)(1 << BS3_SEL_RING_SHIFT) )
356#define BS3_SEL_R0_FIRST 0x0100 /**< The first selector in the ring-0 block. */
357#define BS3_SEL_R0_CS16 0x0100 /**< ring-0: 16-bit code selector, base 0x10000. */
358#define BS3_SEL_R0_DS16 0x0108 /**< ring-0: 16-bit data selector, base 0x23000. */
359#define BS3_SEL_R0_SS16 0x0110 /**< ring-0: 16-bit stack selector, base 0x00000. */
360#define BS3_SEL_R0_CS32 0x0118 /**< ring-0: 32-bit flat code selector. */
361#define BS3_SEL_R0_DS32 0x0120 /**< ring-0: 32-bit flat data selector. */
362#define BS3_SEL_R0_SS32 0x0128 /**< ring-0: 32-bit flat stack selector. */
363#define BS3_SEL_R0_CS64 0x0130 /**< ring-0: 64-bit flat code selector. */
364#define BS3_SEL_R0_DS64 0x0138 /**< ring-0: 64-bit flat data & stack selector. */
365#define BS3_SEL_R0_CS16_EO 0x0140 /**< ring-0: 16-bit execute-only code selector, not accessed, 0xfffe limit, CS16 base. */
366#define BS3_SEL_R0_CS16_CNF 0x0148 /**< ring-0: 16-bit conforming code selector, not accessed, 0xfffe limit, CS16 base. */
367#define BS3_SEL_R0_CS16_CNF_EO 0x0150 /**< ring-0: 16-bit execute-only conforming code selector, not accessed, 0xfffe limit, CS16 base. */
368#define BS3_SEL_R0_CS32_EO 0x0158 /**< ring-0: 32-bit execute-only code selector, not accessed, flat. */
369#define BS3_SEL_R0_CS32_CNF 0x0160 /**< ring-0: 32-bit conforming code selector, not accessed, flat. */
370#define BS3_SEL_R0_CS32_CNF_EO 0x0168 /**< ring-0: 32-bit execute-only conforming code selector, not accessed, flat. */
371#define BS3_SEL_R0_CS64_EO 0x0170 /**< ring-0: 64-bit execute-only code selector, not accessed, flat. */
372#define BS3_SEL_R0_CS64_CNF 0x0178 /**< ring-0: 64-bit conforming code selector, not accessed, flat. */
373#define BS3_SEL_R0_CS64_CNF_EO 0x0180 /**< ring-0: 64-bit execute-only conforming code selector, not accessed, flat. */
374
375#define BS3_SEL_R1_FIRST 0x0200 /**< The first selector in the ring-1 block. */
376#define BS3_SEL_R1_CS16 0x0200 /**< ring-1: 16-bit code selector, base 0x10000. */
377#define BS3_SEL_R1_DS16 0x0208 /**< ring-1: 16-bit data selector, base 0x23000. */
378#define BS3_SEL_R1_SS16 0x0210 /**< ring-1: 16-bit stack selector, base 0x00000. */
379#define BS3_SEL_R1_CS32 0x0218 /**< ring-1: 32-bit flat code selector. */
380#define BS3_SEL_R1_DS32 0x0220 /**< ring-1: 32-bit flat data selector. */
381#define BS3_SEL_R1_SS32 0x0228 /**< ring-1: 32-bit flat stack selector. */
382#define BS3_SEL_R1_CS64 0x0230 /**< ring-1: 64-bit flat code selector. */
383#define BS3_SEL_R1_DS64 0x0238 /**< ring-1: 64-bit flat data & stack selector. */
384#define BS3_SEL_R1_CS16_EO 0x0240 /**< ring-1: 16-bit execute-only code selector, not accessed, 0xfffe limit, CS16 base. */
385#define BS3_SEL_R1_CS16_CNF 0x0248 /**< ring-1: 16-bit conforming code selector, not accessed, 0xfffe limit, CS16 base. */
386#define BS3_SEL_R1_CS16_CNF_EO 0x0250 /**< ring-1: 16-bit execute-only conforming code selector, not accessed, 0xfffe limit, CS16 base. */
387#define BS3_SEL_R1_CS32_EO 0x0258 /**< ring-1: 32-bit execute-only code selector, not accessed, flat. */
388#define BS3_SEL_R1_CS32_CNF 0x0260 /**< ring-1: 32-bit conforming code selector, not accessed, flat. */
389#define BS3_SEL_R1_CS32_CNF_EO 0x0268 /**< ring-1: 32-bit execute-only conforming code selector, not accessed, flat. */
390#define BS3_SEL_R1_CS64_EO 0x0270 /**< ring-1: 64-bit execute-only code selector, not accessed, flat. */
391#define BS3_SEL_R1_CS64_CNF 0x0278 /**< ring-1: 64-bit conforming code selector, not accessed, flat. */
392#define BS3_SEL_R1_CS64_CNF_EO 0x0280 /**< ring-1: 64-bit execute-only conforming code selector, not accessed, flat. */
393
394#define BS3_SEL_R2_FIRST 0x0300 /**< The first selector in the ring-2 block. */
395#define BS3_SEL_R2_CS16 0x0300 /**< ring-2: 16-bit code selector, base 0x10000. */
396#define BS3_SEL_R2_DS16 0x0308 /**< ring-2: 16-bit data selector, base 0x23000. */
397#define BS3_SEL_R2_SS16 0x0310 /**< ring-2: 16-bit stack selector, base 0x00000. */
398#define BS3_SEL_R2_CS32 0x0318 /**< ring-2: 32-bit flat code selector. */
399#define BS3_SEL_R2_DS32 0x0320 /**< ring-2: 32-bit flat data selector. */
400#define BS3_SEL_R2_SS32 0x0328 /**< ring-2: 32-bit flat stack selector. */
401#define BS3_SEL_R2_CS64 0x0330 /**< ring-2: 64-bit flat code selector. */
402#define BS3_SEL_R2_DS64 0x0338 /**< ring-2: 64-bit flat data & stack selector. */
403#define BS3_SEL_R2_CS16_EO 0x0340 /**< ring-2: 16-bit execute-only code selector, not accessed, 0xfffe limit, CS16 base. */
404#define BS3_SEL_R2_CS16_CNF 0x0348 /**< ring-2: 16-bit conforming code selector, not accessed, 0xfffe limit, CS16 base. */
405#define BS3_SEL_R2_CS16_CNF_EO 0x0350 /**< ring-2: 16-bit execute-only conforming code selector, not accessed, 0xfffe limit, CS16 base. */
406#define BS3_SEL_R2_CS32_EO 0x0358 /**< ring-2: 32-bit execute-only code selector, not accessed, flat. */
407#define BS3_SEL_R2_CS32_CNF 0x0360 /**< ring-2: 32-bit conforming code selector, not accessed, flat. */
408#define BS3_SEL_R2_CS32_CNF_EO 0x0368 /**< ring-2: 32-bit execute-only conforming code selector, not accessed, flat. */
409#define BS3_SEL_R2_CS64_EO 0x0370 /**< ring-2: 64-bit execute-only code selector, not accessed, flat. */
410#define BS3_SEL_R2_CS64_CNF 0x0378 /**< ring-2: 64-bit conforming code selector, not accessed, flat. */
411#define BS3_SEL_R2_CS64_CNF_EO 0x0380 /**< ring-2: 64-bit execute-only conforming code selector, not accessed, flat. */
412
413#define BS3_SEL_R3_FIRST 0x0400 /**< The first selector in the ring-3 block. */
414#define BS3_SEL_R3_CS16 0x0400 /**< ring-3: 16-bit code selector, base 0x10000. */
415#define BS3_SEL_R3_DS16 0x0408 /**< ring-3: 16-bit data selector, base 0x23000. */
416#define BS3_SEL_R3_SS16 0x0410 /**< ring-3: 16-bit stack selector, base 0x00000. */
417#define BS3_SEL_R3_CS32 0x0418 /**< ring-3: 32-bit flat code selector. */
418#define BS3_SEL_R3_DS32 0x0420 /**< ring-3: 32-bit flat data selector. */
419#define BS3_SEL_R3_SS32 0x0428 /**< ring-3: 32-bit flat stack selector. */
420#define BS3_SEL_R3_CS64 0x0430 /**< ring-3: 64-bit flat code selector. */
421#define BS3_SEL_R3_DS64 0x0438 /**< ring-3: 64-bit flat data & stack selector. */
422#define BS3_SEL_R3_CS16_EO 0x0440 /**< ring-3: 16-bit execute-only code selector, not accessed, 0xfffe limit, CS16 base. */
423#define BS3_SEL_R3_CS16_CNF 0x0448 /**< ring-3: 16-bit conforming code selector, not accessed, 0xfffe limit, CS16 base. */
424#define BS3_SEL_R3_CS16_CNF_EO 0x0450 /**< ring-3: 16-bit execute-only conforming code selector, not accessed, 0xfffe limit, CS16 base. */
425#define BS3_SEL_R3_CS32_EO 0x0458 /**< ring-3: 32-bit execute-only code selector, not accessed, flat. */
426#define BS3_SEL_R3_CS32_CNF 0x0460 /**< ring-3: 32-bit conforming code selector, not accessed, flat. */
427#define BS3_SEL_R3_CS32_CNF_EO 0x0468 /**< ring-3: 32-bit execute-only conforming code selector, not accessed, flat. */
428#define BS3_SEL_R3_CS64_EO 0x0470 /**< ring-3: 64-bit execute-only code selector, not accessed, flat. */
429#define BS3_SEL_R3_CS64_CNF 0x0478 /**< ring-3: 64-bit conforming code selector, not accessed, flat. */
430#define BS3_SEL_R3_CS64_CNF_EO 0x0480 /**< ring-3: 64-bit execute-only conforming code selector, not accessed, flat. */
431
432#define BS3_SEL_R3_LAST 0x04f8 /**< ring-3: Last of the BS3_SEL_RX_XXX range. */
433
434#define BS3_SEL_SPARE_FIRST 0x0500 /**< The first selector in the spare block */
435#define BS3_SEL_SPARE_00 0x0500 /**< Spare selector number 00h. */
436#define BS3_SEL_SPARE_01 0x0508 /**< Spare selector number 01h. */
437#define BS3_SEL_SPARE_02 0x0510 /**< Spare selector number 02h. */
438#define BS3_SEL_SPARE_03 0x0518 /**< Spare selector number 03h. */
439#define BS3_SEL_SPARE_04 0x0520 /**< Spare selector number 04h. */
440#define BS3_SEL_SPARE_05 0x0528 /**< Spare selector number 05h. */
441#define BS3_SEL_SPARE_06 0x0530 /**< Spare selector number 06h. */
442#define BS3_SEL_SPARE_07 0x0538 /**< Spare selector number 07h. */
443#define BS3_SEL_SPARE_08 0x0540 /**< Spare selector number 08h. */
444#define BS3_SEL_SPARE_09 0x0548 /**< Spare selector number 09h. */
445#define BS3_SEL_SPARE_0a 0x0550 /**< Spare selector number 0ah. */
446#define BS3_SEL_SPARE_0b 0x0558 /**< Spare selector number 0bh. */
447#define BS3_SEL_SPARE_0c 0x0560 /**< Spare selector number 0ch. */
448#define BS3_SEL_SPARE_0d 0x0568 /**< Spare selector number 0dh. */
449#define BS3_SEL_SPARE_0e 0x0570 /**< Spare selector number 0eh. */
450#define BS3_SEL_SPARE_0f 0x0578 /**< Spare selector number 0fh. */
451#define BS3_SEL_SPARE_10 0x0580 /**< Spare selector number 10h. */
452#define BS3_SEL_SPARE_11 0x0588 /**< Spare selector number 11h. */
453#define BS3_SEL_SPARE_12 0x0590 /**< Spare selector number 12h. */
454#define BS3_SEL_SPARE_13 0x0598 /**< Spare selector number 13h. */
455#define BS3_SEL_SPARE_14 0x05a0 /**< Spare selector number 14h. */
456#define BS3_SEL_SPARE_15 0x05a8 /**< Spare selector number 15h. */
457#define BS3_SEL_SPARE_16 0x05b0 /**< Spare selector number 16h. */
458#define BS3_SEL_SPARE_17 0x05b8 /**< Spare selector number 17h. */
459#define BS3_SEL_SPARE_18 0x05c0 /**< Spare selector number 18h. */
460#define BS3_SEL_SPARE_19 0x05c8 /**< Spare selector number 19h. */
461#define BS3_SEL_SPARE_1a 0x05d0 /**< Spare selector number 1ah. */
462#define BS3_SEL_SPARE_1b 0x05d8 /**< Spare selector number 1bh. */
463#define BS3_SEL_SPARE_1c 0x05e0 /**< Spare selector number 1ch. */
464#define BS3_SEL_SPARE_1d 0x05e8 /**< Spare selector number 1dh. */
465#define BS3_SEL_SPARE_1e 0x05f0 /**< Spare selector number 1eh. */
466#define BS3_SEL_SPARE_1f 0x05f8 /**< Spare selector number 1fh. */
467
468#define BS3_SEL_TILED 0x0600 /**< 16-bit data tiling: First - base=0x00000000, limit=64KB, DPL=3. */
469#define BS3_SEL_TILED_LAST 0x0df8 /**< 16-bit data tiling: Last - base=0x00ff0000, limit=64KB, DPL=3. */
470#define BS3_SEL_TILED_AREA_SIZE 0x001000000 /**< 16-bit data tiling: Size of addressable area, in bytes. (16 MB) */
471
472#define BS3_SEL_FREE_PART1 0x0e00 /**< Free selector space - part \#1. */
473#define BS3_SEL_FREE_PART1_LAST 0x0ff8 /**< Free selector space - part \#1, last entry. */
474
475#define BS3_SEL_TEXT16 0x1000 /**< The BS3TEXT16 selector. */
476
477#define BS3_SEL_FREE_PART2 0x1008 /**< Free selector space - part \#2. */
478#define BS3_SEL_FREE_PART2_LAST 0x17f8 /**< Free selector space - part \#2, last entry. */
479
480#define BS3_SEL_TILED_R0 0x1800 /**< 16-bit data/stack tiling: First - base=0x00000000, limit=64KB, DPL=0. */
481#define BS3_SEL_TILED_R0_LAST 0x1ff8 /**< 16-bit data/stack tiling: Last - base=0x00ff0000, limit=64KB, DPL=0. */
482
483#define BS3_SEL_SYSTEM16 0x2000 /**< The BS3SYSTEM16 selector. */
484
485#define BS3_SEL_FREE_PART3 0x2008 /**< Free selector space - part \#3. */
486#define BS3_SEL_FREE_PART3_LAST 0x28f8 /**< Free selector space - part \#3, last entry. */
487
488#define BS3_SEL_DATA16 0x2900 /**< The BS3DATA16/BS3KIT_GRPNM_DATA16 selector. */
489
490#define BS3_SEL_FREE_PART4 0x2908 /**< Free selector space - part \#4. */
491#define BS3_SEL_FREE_PART4_LAST 0x2f98 /**< Free selector space - part \#4, last entry. */
492
493#define BS3_SEL_PRE_TEST_PAGE_08 0x2fa0 /**< Selector located 8 selectors before the test page. */
494#define BS3_SEL_PRE_TEST_PAGE_07 0x2fa8 /**< Selector located 7 selectors before the test page. */
495#define BS3_SEL_PRE_TEST_PAGE_06 0x2fb0 /**< Selector located 6 selectors before the test page. */
496#define BS3_SEL_PRE_TEST_PAGE_05 0x2fb8 /**< Selector located 5 selectors before the test page. */
497#define BS3_SEL_PRE_TEST_PAGE_04 0x2fc0 /**< Selector located 4 selectors before the test page. */
498#define BS3_SEL_PRE_TEST_PAGE_03 0x2fc8 /**< Selector located 3 selectors before the test page. */
499#define BS3_SEL_PRE_TEST_PAGE_02 0x2fd0 /**< Selector located 2 selectors before the test page. */
500#define BS3_SEL_PRE_TEST_PAGE_01 0x2fd8 /**< Selector located 1 selector before the test page. */
501#define BS3_SEL_TEST_PAGE 0x2fe0 /**< Start of the test page intended for playing around with paging and GDT. */
502#define BS3_SEL_TEST_PAGE_00 0x2fe0 /**< Test page selector number 00h (convenience). */
503#define BS3_SEL_TEST_PAGE_01 0x2fe8 /**< Test page selector number 01h (convenience). */
504#define BS3_SEL_TEST_PAGE_02 0x2ff0 /**< Test page selector number 02h (convenience). */
505#define BS3_SEL_TEST_PAGE_03 0x2ff8 /**< Test page selector number 03h (convenience). */
506#define BS3_SEL_TEST_PAGE_04 0x3000 /**< Test page selector number 04h (convenience). */
507#define BS3_SEL_TEST_PAGE_05 0x3008 /**< Test page selector number 05h (convenience). */
508#define BS3_SEL_TEST_PAGE_06 0x3010 /**< Test page selector number 06h (convenience). */
509#define BS3_SEL_TEST_PAGE_07 0x3018 /**< Test page selector number 07h (convenience). */
510#define BS3_SEL_TEST_PAGE_LAST 0x3fd0 /**< The last selector in the spare page. */
511
512#define BS3_SEL_GDT_LIMIT 0x3fd8 /**< The GDT limit. */
513/** @} */
514
515
516/** @def BS3_FAR
517 * For indicating far pointers in 16-bit code.
518 * Does nothing in 32-bit and 64-bit code. */
519/** @def BS3_NEAR
520 * For indicating near pointers in 16-bit code.
521 * Does nothing in 32-bit and 64-bit code. */
522/** @def BS3_FAR_CODE
523 * For indicating far 16-bit functions.
524 * Does nothing in 32-bit and 64-bit code. */
525/** @def BS3_NEAR_CODE
526 * For indicating near 16-bit functions.
527 * Does nothing in 32-bit and 64-bit code. */
528/** @def BS3_FAR_DATA
529 * For indicating far 16-bit external data, i.e. in a segment other than DATA16.
530 * Does nothing in 32-bit and 64-bit code. */
531#ifdef M_I86
532# define BS3_FAR __far
533# define BS3_NEAR __near
534# define BS3_FAR_CODE __far
535# define BS3_NEAR_CODE __near
536# define BS3_FAR_DATA __far
537#else
538# define BS3_FAR
539# define BS3_NEAR
540# define BS3_FAR_CODE
541# define BS3_NEAR_CODE
542# define BS3_FAR_DATA
543#endif
544
545#if ARCH_BITS == 16 || defined(DOXYGEN_RUNNING)
546/** @def BS3_FP_SEG
547 * Get the selector (segment) part of a far pointer.
548 *
549 * @returns selector.
550 * @param a_pv Far pointer.
551 */
552# define BS3_FP_SEG(a_pv) ((uint16_t)(__segment)(void BS3_FAR *)(a_pv))
553/** @def BS3_FP_OFF
554 * Get the segment offset part of a far pointer.
555 *
556 * For sake of convenience, this works like a uintptr_t cast in 32-bit and
557 * 64-bit code.
558 *
559 * @returns offset.
560 * @param a_pv Far pointer.
561 */
562# define BS3_FP_OFF(a_pv) ((uint16_t)(void __near *)(a_pv))
563/** @def BS3_FP_MAKE
564 * Create a far pointer.
565 *
566 * @returns Far pointer.
567 * @param a_uSeg The selector/segment.
568 * @param a_off The offset into the segment.
569 */
570# define BS3_FP_MAKE(a_uSeg, a_off) (((__segment)(a_uSeg)) :> ((void __near *)(a_off)))
571#else
572# define BS3_FP_OFF(a_pv) ((uintptr_t)(a_pv))
573#endif
574
575/** @def BS3_MAKE_PROT_R0PTR_FROM_FLAT
576 * Creates a protected mode pointer from a flat address.
577 *
578 * For sake of convenience, this macro also works in 32-bit and 64-bit mode,
579 * only there it doesn't return a far pointer but a flat point.
580 *
581 * @returns far void pointer if 16-bit code, near/flat void pointer in 32-bit
582 * and 64-bit.
583 * @param a_uFlat Flat address in the first 16MB. */
584#if ARCH_BITS == 16
585# define BS3_MAKE_PROT_R0PTR_FROM_FLAT(a_uFlat) \
586 BS3_FP_MAKE(((uint16_t)(a_uFlat >> 16) << 3) + BS3_SEL_TILED, (uint16_t)(a_uFlat))
587#else
588# define BS3_MAKE_PROT_R0PTR_FROM_FLAT(a_uFlat) ((void *)(uintptr_t)(a_uFlat))
589#endif
590
591/** @def BS3_MAKE_PROT_R0PTR_FROM_REAL
592 * Creates a protected mode pointer from a far real mode address.
593 *
594 * For sake of convenience, this macro also works in 32-bit and 64-bit mode,
595 * only there it doesn't return a far pointer but a flat point.
596 *
597 * @returns far void pointer if 16-bit code, near/flat void pointer in 32-bit
598 * and 64-bit.
599 * @param a_uSeg The selector/segment.
600 * @param a_off The offset into the segment.
601 */
602#if ARCH_BITS == 16
603# define BS3_MAKE_PROT_R0PTR_FROM_REAL(a_uSeg, a_off) BS3_MAKE_PROT_R0PTR_FROM_FLAT(((uint32_t)(a_uSeg) << 4) + (uint16_t)(a_off))
604#else
605# define BS3_MAKE_PROT_R0PTR_FROM_REAL(a_uSeg, a_off) ( (void *)(uintptr_t)(((uint32_t)(a_uSeg) << 4) + (uint16_t)(a_off)) )
606#endif
607
608
609/** @def BS3_CALL
610 * The calling convension used by BS3 functions. */
611#if ARCH_BITS != 64
612# define BS3_CALL __cdecl
613#elif !defined(_MSC_VER)
614# define BS3_CALL __attribute__((__ms_abi__))
615#else
616# define BS3_CALL
617#endif
618
619/** @def IN_BS3KIT
620 * Indicates that we're in the same link job as the BS3Kit code. */
621#ifdef DOXYGEN_RUNNING
622# define IN_BS3KIT
623#endif
624
625/** @def BS3_DECL
626 * Declares a BS3Kit function with default far/near.
627 *
628 * Until we outgrow BS3TEXT16, we use all near functions in 16-bit.
629 *
630 * @param a_Type The return type. */
631#if ARCH_BITS != 16 || !defined(BS3_USE_ALT_16BIT_TEXT_SEG)
632# define BS3_DECL(a_Type) BS3_DECL_NEAR(a_Type)
633#else
634# define BS3_DECL(a_Type) BS3_DECL_FAR(a_Type)
635#endif
636
637/** @def BS3_DECL_NEAR
638 * Declares a BS3Kit function, always near everywhere.
639 *
640 * Until we outgrow BS3TEXT16, we use all near functions in 16-bit.
641 *
642 * @param a_Type The return type. */
643#ifdef IN_BS3KIT
644# define BS3_DECL_NEAR(a_Type) DECLEXPORT(a_Type) BS3_NEAR_CODE BS3_CALL
645#else
646# define BS3_DECL_NEAR(a_Type) DECLIMPORT(a_Type) BS3_NEAR_CODE BS3_CALL
647#endif
648
649/** @def BS3_DECL_FAR
650 * Declares a BS3Kit function, far 16-bit, otherwise near.
651 *
652 * Until we outgrow BS3TEXT16, we use all near functions in 16-bit.
653 *
654 * @param a_Type The return type. */
655#ifdef IN_BS3KIT
656# define BS3_DECL_FAR(a_Type) DECLEXPORT(a_Type) BS3_FAR_CODE BS3_CALL
657#else
658# define BS3_DECL_FAR(a_Type) DECLIMPORT(a_Type) BS3_FAR_CODE BS3_CALL
659#endif
660
661/** @def BS3_DECL_CALLBACK
662 * Declares a BS3Kit callback function (typically static).
663 *
664 * @param a_Type The return type. */
665#ifdef IN_BS3KIT
666# define BS3_DECL_CALLBACK(a_Type) a_Type BS3_FAR_CODE BS3_CALL
667#else
668# define BS3_DECL_CALLBACK(a_Type) a_Type BS3_FAR_CODE BS3_CALL
669#endif
670
671/** @def BS3_DECL_NEAR_CALLBACK
672 * Declares a near BS3Kit callback function (typically static).
673 *
674 * 16-bit users must be in CGROUP16!
675 *
676 * @param a_Type The return type. */
677#ifdef IN_BS3KIT
678# define BS3_DECL_NEAR_CALLBACK(a_Type) a_Type BS3_NEAR_CODE BS3_CALL
679#else
680# define BS3_DECL_NEAR_CALLBACK(a_Type) a_Type BS3_NEAR_CODE BS3_CALL
681#endif
682
683/**
684 * Constructs a common name.
685 *
686 * Example: BS3_CMN_NM(Bs3Shutdown)
687 *
688 * @param a_Name The name of the function or global variable.
689 */
690#define BS3_CMN_NM(a_Name) RT_CONCAT3(a_Name,_c,ARCH_BITS)
691
692/**
693 * Constructs a common function name, far in 16-bit code.
694 *
695 * Example: BS3_CMN_FAR_NM(Bs3Shutdown)
696 *
697 * @param a_Name The name of the function.
698 */
699#if ARCH_BITS == 16
700# define BS3_CMN_FAR_NM(a_Name) RT_CONCAT(a_Name,_f16)
701#else
702# define BS3_CMN_FAR_NM(a_Name) RT_CONCAT3(a_Name,_c,ARCH_BITS)
703#endif
704
705/**
706 * Constructs a common function name, far or near as defined by the source.
707 *
708 * Which to use in 16-bit mode is defined by BS3_USE_ALT_16BIT_TEXT_SEG. In
709 * 32-bit and 64-bit mode there are no far symbols, only near ones.
710 *
711 * Example: BS3_CMN_FN_NM(Bs3Shutdown)
712 *
713 * @param a_Name The name of the function.
714 */
715#if ARCH_BITS != 16 || !defined(BS3_USE_ALT_16BIT_TEXT_SEG)
716# define BS3_CMN_FN_NM(a_Name) BS3_CMN_NM(a_Name)
717#else
718# define BS3_CMN_FN_NM(a_Name) BS3_CMN_FAR_NM(a_Name)
719#endif
720
721
722/**
723 * Constructs a data name.
724 *
725 * This glosses over the underscore prefix usage of our 16-bit, 32-bit and
726 * 64-bit compilers.
727 *
728 * Example: @code{.c}
729 * \#define Bs3Gdt BS3_DATA_NM(Bs3Gdt)
730 * extern X86DESC BS3_FAR_DATA Bs3Gdt
731 * @endcode
732 *
733 * @param a_Name The name of the global variable.
734 * @remarks Mainly used in bs3kit-mangling.h, internal headers and templates.
735 */
736//converter does this now//#if ARCH_BITS == 64
737//converter does this now//# define BS3_DATA_NM(a_Name) RT_CONCAT(_,a_Name)
738//converter does this now//#else
739# define BS3_DATA_NM(a_Name) a_Name
740//converter does this now//#endif
741
742/**
743 * Template for creating a pointer union type.
744 * @param a_BaseName The base type name.
745 * @param a_Modifiers The type modifier.
746 */
747#define BS3_PTR_UNION_TEMPLATE(a_BaseName, a_Modifiers) \
748 typedef union a_BaseName \
749 { \
750 /** Pointer into the void. */ \
751 a_Modifiers void BS3_FAR *pv; \
752 /** As a signed integer. */ \
753 intptr_t i; \
754 /** As an unsigned integer. */ \
755 uintptr_t u; \
756 /** Pointer to char value. */ \
757 a_Modifiers char BS3_FAR *pch; \
758 /** Pointer to char value. */ \
759 a_Modifiers unsigned char BS3_FAR *puch; \
760 /** Pointer to a int value. */ \
761 a_Modifiers int BS3_FAR *pi; \
762 /** Pointer to a unsigned int value. */ \
763 a_Modifiers unsigned int BS3_FAR *pu; \
764 /** Pointer to a long value. */ \
765 a_Modifiers long BS3_FAR *pl; \
766 /** Pointer to a long value. */ \
767 a_Modifiers unsigned long BS3_FAR *pul; \
768 /** Pointer to a memory size value. */ \
769 a_Modifiers size_t BS3_FAR *pcb; \
770 /** Pointer to a byte value. */ \
771 a_Modifiers uint8_t BS3_FAR *pb; \
772 /** Pointer to a 8-bit unsigned value. */ \
773 a_Modifiers uint8_t BS3_FAR *pu8; \
774 /** Pointer to a 16-bit unsigned value. */ \
775 a_Modifiers uint16_t BS3_FAR *pu16; \
776 /** Pointer to a 32-bit unsigned value. */ \
777 a_Modifiers uint32_t BS3_FAR *pu32; \
778 /** Pointer to a 64-bit unsigned value. */ \
779 a_Modifiers uint64_t BS3_FAR *pu64; \
780 /** Pointer to a UTF-16 character. */ \
781 a_Modifiers RTUTF16 BS3_FAR *pwc; \
782 /** Pointer to a UUID character. */ \
783 a_Modifiers RTUUID BS3_FAR *pUuid; \
784 } a_BaseName; \
785 /** Pointer to a pointer union. */ \
786 typedef a_BaseName *RT_CONCAT(P,a_BaseName)
787BS3_PTR_UNION_TEMPLATE(BS3PTRUNION, RT_NOTHING);
788BS3_PTR_UNION_TEMPLATE(BS3CPTRUNION, const);
789BS3_PTR_UNION_TEMPLATE(BS3VPTRUNION, volatile);
790BS3_PTR_UNION_TEMPLATE(BS3CVPTRUNION, const volatile);
791
792/** Generic far function type. */
793typedef BS3_DECL_FAR(void) FNBS3FAR(void);
794/** Generic far function pointer type. */
795typedef FNBS3FAR *FPFNBS3FAR;
796
797/** Generic near function type. */
798typedef BS3_DECL_NEAR(void) FNBS3NEAR(void);
799/** Generic near function pointer type. */
800typedef FNBS3NEAR *PFNBS3NEAR;
801
802/** Generic far 16:16 function pointer type for address conversion functions. */
803#if ARCH_BITS == 16
804typedef FPFNBS3FAR PFNBS3FARADDRCONV;
805#else
806typedef uint32_t PFNBS3FARADDRCONV;
807#endif
808
809/** The system call vector. */
810#define BS3_TRAP_SYSCALL UINT8_C(0x20)
811
812/** @name System call numbers (ax).
813 * Paramenters are generally passed in registers specific to each system call,
814 * however cx:xSI is used for passing a pointer parameter.
815 * @{ */
816/** Print char (cl). */
817#define BS3_SYSCALL_PRINT_CHR UINT16_C(0x0001)
818/** Print string (pointer in cx:xSI, length in dx). */
819#define BS3_SYSCALL_PRINT_STR UINT16_C(0x0002)
820/** Switch to ring-0. */
821#define BS3_SYSCALL_TO_RING0 UINT16_C(0x0003)
822/** Switch to ring-1. */
823#define BS3_SYSCALL_TO_RING1 UINT16_C(0x0004)
824/** Switch to ring-2. */
825#define BS3_SYSCALL_TO_RING2 UINT16_C(0x0005)
826/** Switch to ring-3. */
827#define BS3_SYSCALL_TO_RING3 UINT16_C(0x0006)
828/** Restore context (pointer in cx:xSI, flags in dx). */
829#define BS3_SYSCALL_RESTORE_CTX UINT16_C(0x0007)
830/** Set DRx register (value in ESI, register number in dl). */
831#define BS3_SYSCALL_SET_DRX UINT16_C(0x0008)
832/** Get DRx register (register number in dl, value returned in ax:dx). */
833#define BS3_SYSCALL_GET_DRX UINT16_C(0x0009)
834/** Set CRx register (value in ESI, register number in dl). */
835#define BS3_SYSCALL_SET_CRX UINT16_C(0x000a)
836/** Get CRx register (register number in dl, value returned in ax:dx). */
837#define BS3_SYSCALL_GET_CRX UINT16_C(0x000b)
838/** Set the task register (value in ESI). */
839#define BS3_SYSCALL_SET_TR UINT16_C(0x000c)
840/** Get the task register (value returned in ax). */
841#define BS3_SYSCALL_GET_TR UINT16_C(0x000d)
842/** Set the LDT register (value in ESI). */
843#define BS3_SYSCALL_SET_LDTR UINT16_C(0x000e)
844/** Get the LDT register (value returned in ax). */
845#define BS3_SYSCALL_GET_LDTR UINT16_C(0x000f)
846/** The last system call value. */
847#define BS3_SYSCALL_LAST BS3_SYSCALL_GET_LDTR
848/** @} */
849
850
851
852/** @defgroup grp_bs3kit_system System Structures
853 * @{ */
854/** The GDT, indexed by BS3_SEL_XXX shifted by 3. */
855extern X86DESC BS3_FAR_DATA Bs3Gdt[(BS3_SEL_GDT_LIMIT + 1) / 8];
856
857extern X86DESC64 BS3_FAR_DATA Bs3Gdt_Ldt; /**< @see BS3_SEL_LDT */
858extern X86DESC BS3_FAR_DATA Bs3Gdte_Tss16; /**< @see BS3_SEL_TSS16 */
859extern X86DESC BS3_FAR_DATA Bs3Gdte_Tss16DoubleFault; /**< @see BS3_SEL_TSS16_DF */
860extern X86DESC BS3_FAR_DATA Bs3Gdte_Tss16Spare0; /**< @see BS3_SEL_TSS16_SPARE0 */
861extern X86DESC BS3_FAR_DATA Bs3Gdte_Tss16Spare1; /**< @see BS3_SEL_TSS16_SPARE1 */
862extern X86DESC BS3_FAR_DATA Bs3Gdte_Tss32; /**< @see BS3_SEL_TSS32 */
863extern X86DESC BS3_FAR_DATA Bs3Gdte_Tss32DoubleFault; /**< @see BS3_SEL_TSS32_DF */
864extern X86DESC BS3_FAR_DATA Bs3Gdte_Tss32Spare0; /**< @see BS3_SEL_TSS32_SPARE0 */
865extern X86DESC BS3_FAR_DATA Bs3Gdte_Tss32Spare1; /**< @see BS3_SEL_TSS32_SPARE1 */
866extern X86DESC BS3_FAR_DATA Bs3Gdte_Tss32IobpIntRedirBm; /**< @see BS3_SEL_TSS32_IOBP_IRB */
867extern X86DESC BS3_FAR_DATA Bs3Gdte_Tss32IntRedirBm; /**< @see BS3_SEL_TSS32_IRB */
868extern X86DESC BS3_FAR_DATA Bs3Gdte_Tss64; /**< @see BS3_SEL_TSS64 */
869extern X86DESC BS3_FAR_DATA Bs3Gdte_Tss64Spare0; /**< @see BS3_SEL_TSS64_SPARE0 */
870extern X86DESC BS3_FAR_DATA Bs3Gdte_Tss64Spare1; /**< @see BS3_SEL_TSS64_SPARE1 */
871extern X86DESC BS3_FAR_DATA Bs3Gdte_Tss64Iobp; /**< @see BS3_SEL_TSS64_IOBP */
872extern X86DESC BS3_FAR_DATA Bs3Gdte_RMTEXT16_CS; /**< @see BS3_SEL_RMTEXT16_CS */
873extern X86DESC BS3_FAR_DATA Bs3Gdte_X0TEXT16_CS; /**< @see BS3_SEL_X0TEXT16_CS */
874extern X86DESC BS3_FAR_DATA Bs3Gdte_X1TEXT16_CS; /**< @see BS3_SEL_X1TEXT16_CS */
875extern X86DESC BS3_FAR_DATA Bs3Gdte_R0_MMIO16; /**< @see BS3_SEL_VMMDEV_MMIO16 */
876
877extern X86DESC BS3_FAR_DATA Bs3Gdte_R0_First; /**< @see BS3_SEL_R0_FIRST */
878extern X86DESC BS3_FAR_DATA Bs3Gdte_R0_CS16; /**< @see BS3_SEL_R0_CS16 */
879extern X86DESC BS3_FAR_DATA Bs3Gdte_R0_DS16; /**< @see BS3_SEL_R0_DS16 */
880extern X86DESC BS3_FAR_DATA Bs3Gdte_R0_SS16; /**< @see BS3_SEL_R0_SS16 */
881extern X86DESC BS3_FAR_DATA Bs3Gdte_R0_CS32; /**< @see BS3_SEL_R0_CS32 */
882extern X86DESC BS3_FAR_DATA Bs3Gdte_R0_DS32; /**< @see BS3_SEL_R0_DS32 */
883extern X86DESC BS3_FAR_DATA Bs3Gdte_R0_SS32; /**< @see BS3_SEL_R0_SS32 */
884extern X86DESC BS3_FAR_DATA Bs3Gdte_R0_CS64; /**< @see BS3_SEL_R0_CS64 */
885extern X86DESC BS3_FAR_DATA Bs3Gdte_R0_DS64; /**< @see BS3_SEL_R0_DS64 */
886extern X86DESC BS3_FAR_DATA Bs3Gdte_R0_CS16_EO; /**< @see BS3_SEL_R0_CS16_EO */
887extern X86DESC BS3_FAR_DATA Bs3Gdte_R0_CS16_CNF; /**< @see BS3_SEL_R0_CS16_CNF */
888extern X86DESC BS3_FAR_DATA Bs3Gdte_R0_CS16_CND_EO; /**< @see BS3_SEL_R0_CS16_CNF_EO */
889extern X86DESC BS3_FAR_DATA Bs3Gdte_R0_CS32_EO; /**< @see BS3_SEL_R0_CS32_EO */
890extern X86DESC BS3_FAR_DATA Bs3Gdte_R0_CS32_CNF; /**< @see BS3_SEL_R0_CS32_CNF */
891extern X86DESC BS3_FAR_DATA Bs3Gdte_R0_CS32_CNF_EO; /**< @see BS3_SEL_R0_CS32_CNF_EO */
892extern X86DESC BS3_FAR_DATA Bs3Gdte_R0_CS64_EO; /**< @see BS3_SEL_R0_CS64_EO */
893extern X86DESC BS3_FAR_DATA Bs3Gdte_R0_CS64_CNF; /**< @see BS3_SEL_R0_CS64_CNF */
894extern X86DESC BS3_FAR_DATA Bs3Gdte_R0_CS64_CNF_EO; /**< @see BS3_SEL_R0_CS64_CNF_EO */
895
896extern X86DESC BS3_FAR_DATA Bs3Gdte_R1_First; /**< @see BS3_SEL_R1_FIRST */
897extern X86DESC BS3_FAR_DATA Bs3Gdte_R1_CS16; /**< @see BS3_SEL_R1_CS16 */
898extern X86DESC BS3_FAR_DATA Bs3Gdte_R1_DS16; /**< @see BS3_SEL_R1_DS16 */
899extern X86DESC BS3_FAR_DATA Bs3Gdte_R1_SS16; /**< @see BS3_SEL_R1_SS16 */
900extern X86DESC BS3_FAR_DATA Bs3Gdte_R1_CS32; /**< @see BS3_SEL_R1_CS32 */
901extern X86DESC BS3_FAR_DATA Bs3Gdte_R1_DS32; /**< @see BS3_SEL_R1_DS32 */
902extern X86DESC BS3_FAR_DATA Bs3Gdte_R1_SS32; /**< @see BS3_SEL_R1_SS32 */
903extern X86DESC BS3_FAR_DATA Bs3Gdte_R1_CS64; /**< @see BS3_SEL_R1_CS64 */
904extern X86DESC BS3_FAR_DATA Bs3Gdte_R1_DS64; /**< @see BS3_SEL_R1_DS64 */
905extern X86DESC BS3_FAR_DATA Bs3Gdte_R1_CS16_EO; /**< @see BS3_SEL_R1_CS16_EO */
906extern X86DESC BS3_FAR_DATA Bs3Gdte_R1_CS16_CNF; /**< @see BS3_SEL_R1_CS16_CNF */
907extern X86DESC BS3_FAR_DATA Bs3Gdte_R1_CS16_CND_EO; /**< @see BS3_SEL_R1_CS16_CNF_EO */
908extern X86DESC BS3_FAR_DATA Bs3Gdte_R1_CS32_EO; /**< @see BS3_SEL_R1_CS32_EO */
909extern X86DESC BS3_FAR_DATA Bs3Gdte_R1_CS32_CNF; /**< @see BS3_SEL_R1_CS32_CNF */
910extern X86DESC BS3_FAR_DATA Bs3Gdte_R1_CS32_CNF_EO; /**< @see BS3_SEL_R1_CS32_CNF_EO */
911extern X86DESC BS3_FAR_DATA Bs3Gdte_R1_CS64_EO; /**< @see BS3_SEL_R1_CS64_EO */
912extern X86DESC BS3_FAR_DATA Bs3Gdte_R1_CS64_CNF; /**< @see BS3_SEL_R1_CS64_CNF */
913extern X86DESC BS3_FAR_DATA Bs3Gdte_R1_CS64_CNF_EO; /**< @see BS3_SEL_R1_CS64_CNF_EO */
914
915extern X86DESC BS3_FAR_DATA Bs3Gdte_R2_First; /**< @see BS3_SEL_R2_FIRST */
916extern X86DESC BS3_FAR_DATA Bs3Gdte_R2_CS16; /**< @see BS3_SEL_R2_CS16 */
917extern X86DESC BS3_FAR_DATA Bs3Gdte_R2_DS16; /**< @see BS3_SEL_R2_DS16 */
918extern X86DESC BS3_FAR_DATA Bs3Gdte_R2_SS16; /**< @see BS3_SEL_R2_SS16 */
919extern X86DESC BS3_FAR_DATA Bs3Gdte_R2_CS32; /**< @see BS3_SEL_R2_CS32 */
920extern X86DESC BS3_FAR_DATA Bs3Gdte_R2_DS32; /**< @see BS3_SEL_R2_DS32 */
921extern X86DESC BS3_FAR_DATA Bs3Gdte_R2_SS32; /**< @see BS3_SEL_R2_SS32 */
922extern X86DESC BS3_FAR_DATA Bs3Gdte_R2_CS64; /**< @see BS3_SEL_R2_CS64 */
923extern X86DESC BS3_FAR_DATA Bs3Gdte_R2_DS64; /**< @see BS3_SEL_R2_DS64 */
924extern X86DESC BS3_FAR_DATA Bs3Gdte_R2_CS16_EO; /**< @see BS3_SEL_R2_CS16_EO */
925extern X86DESC BS3_FAR_DATA Bs3Gdte_R2_CS16_CNF; /**< @see BS3_SEL_R2_CS16_CNF */
926extern X86DESC BS3_FAR_DATA Bs3Gdte_R2_CS16_CND_EO; /**< @see BS3_SEL_R2_CS16_CNF_EO */
927extern X86DESC BS3_FAR_DATA Bs3Gdte_R2_CS32_EO; /**< @see BS3_SEL_R2_CS32_EO */
928extern X86DESC BS3_FAR_DATA Bs3Gdte_R2_CS32_CNF; /**< @see BS3_SEL_R2_CS32_CNF */
929extern X86DESC BS3_FAR_DATA Bs3Gdte_R2_CS32_CNF_EO; /**< @see BS3_SEL_R2_CS32_CNF_EO */
930extern X86DESC BS3_FAR_DATA Bs3Gdte_R2_CS64_EO; /**< @see BS3_SEL_R2_CS64_EO */
931extern X86DESC BS3_FAR_DATA Bs3Gdte_R2_CS64_CNF; /**< @see BS3_SEL_R2_CS64_CNF */
932extern X86DESC BS3_FAR_DATA Bs3Gdte_R2_CS64_CNF_EO; /**< @see BS3_SEL_R2_CS64_CNF_EO */
933
934extern X86DESC BS3_FAR_DATA Bs3Gdte_R3_First; /**< @see BS3_SEL_R3_FIRST */
935extern X86DESC BS3_FAR_DATA Bs3Gdte_R3_CS16; /**< @see BS3_SEL_R3_CS16 */
936extern X86DESC BS3_FAR_DATA Bs3Gdte_R3_DS16; /**< @see BS3_SEL_R3_DS16 */
937extern X86DESC BS3_FAR_DATA Bs3Gdte_R3_SS16; /**< @see BS3_SEL_R3_SS16 */
938extern X86DESC BS3_FAR_DATA Bs3Gdte_R3_CS32; /**< @see BS3_SEL_R3_CS32 */
939extern X86DESC BS3_FAR_DATA Bs3Gdte_R3_DS32; /**< @see BS3_SEL_R3_DS32 */
940extern X86DESC BS3_FAR_DATA Bs3Gdte_R3_SS32; /**< @see BS3_SEL_R3_SS32 */
941extern X86DESC BS3_FAR_DATA Bs3Gdte_R3_CS64; /**< @see BS3_SEL_R3_CS64 */
942extern X86DESC BS3_FAR_DATA Bs3Gdte_R3_DS64; /**< @see BS3_SEL_R3_DS64 */
943extern X86DESC BS3_FAR_DATA Bs3Gdte_R3_CS16_EO; /**< @see BS3_SEL_R3_CS16_EO */
944extern X86DESC BS3_FAR_DATA Bs3Gdte_R3_CS16_CNF; /**< @see BS3_SEL_R3_CS16_CNF */
945extern X86DESC BS3_FAR_DATA Bs3Gdte_R3_CS16_CND_EO; /**< @see BS3_SEL_R3_CS16_CNF_EO */
946extern X86DESC BS3_FAR_DATA Bs3Gdte_R3_CS32_EO; /**< @see BS3_SEL_R3_CS32_EO */
947extern X86DESC BS3_FAR_DATA Bs3Gdte_R3_CS32_CNF; /**< @see BS3_SEL_R3_CS32_CNF */
948extern X86DESC BS3_FAR_DATA Bs3Gdte_R3_CS32_CNF_EO; /**< @see BS3_SEL_R3_CS32_CNF_EO */
949extern X86DESC BS3_FAR_DATA Bs3Gdte_R3_CS64_EO; /**< @see BS3_SEL_R3_CS64_EO */
950extern X86DESC BS3_FAR_DATA Bs3Gdte_R3_CS64_CNF; /**< @see BS3_SEL_R3_CS64_CNF */
951extern X86DESC BS3_FAR_DATA Bs3Gdte_R3_CS64_CNF_EO; /**< @see BS3_SEL_R3_CS64_CNF_EO */
952
953extern X86DESC BS3_FAR_DATA Bs3GdteSpare00; /**< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_00 */
954extern X86DESC BS3_FAR_DATA Bs3GdteSpare01; /**< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_01 */
955extern X86DESC BS3_FAR_DATA Bs3GdteSpare02; /**< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_02 */
956extern X86DESC BS3_FAR_DATA Bs3GdteSpare03; /**< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_03 */
957extern X86DESC BS3_FAR_DATA Bs3GdteSpare04; /**< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_04 */
958extern X86DESC BS3_FAR_DATA Bs3GdteSpare05; /**< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_05 */
959extern X86DESC BS3_FAR_DATA Bs3GdteSpare06; /**< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_06 */
960extern X86DESC BS3_FAR_DATA Bs3GdteSpare07; /**< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_07 */
961extern X86DESC BS3_FAR_DATA Bs3GdteSpare08; /**< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_08 */
962extern X86DESC BS3_FAR_DATA Bs3GdteSpare09; /**< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_09 */
963extern X86DESC BS3_FAR_DATA Bs3GdteSpare0a; /**< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_0a */
964extern X86DESC BS3_FAR_DATA Bs3GdteSpare0b; /**< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_0b */
965extern X86DESC BS3_FAR_DATA Bs3GdteSpare0c; /**< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_0c */
966extern X86DESC BS3_FAR_DATA Bs3GdteSpare0d; /**< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_0d */
967extern X86DESC BS3_FAR_DATA Bs3GdteSpare0e; /**< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_0e */
968extern X86DESC BS3_FAR_DATA Bs3GdteSpare0f; /**< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_0f */
969extern X86DESC BS3_FAR_DATA Bs3GdteSpare10; /**< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_10 */
970extern X86DESC BS3_FAR_DATA Bs3GdteSpare11; /**< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_11 */
971extern X86DESC BS3_FAR_DATA Bs3GdteSpare12; /**< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_12 */
972extern X86DESC BS3_FAR_DATA Bs3GdteSpare13; /**< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_13 */
973extern X86DESC BS3_FAR_DATA Bs3GdteSpare14; /**< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_14 */
974extern X86DESC BS3_FAR_DATA Bs3GdteSpare15; /**< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_15 */
975extern X86DESC BS3_FAR_DATA Bs3GdteSpare16; /**< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_16 */
976extern X86DESC BS3_FAR_DATA Bs3GdteSpare17; /**< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_17 */
977extern X86DESC BS3_FAR_DATA Bs3GdteSpare18; /**< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_18 */
978extern X86DESC BS3_FAR_DATA Bs3GdteSpare19; /**< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_19 */
979extern X86DESC BS3_FAR_DATA Bs3GdteSpare1a; /**< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_1a */
980extern X86DESC BS3_FAR_DATA Bs3GdteSpare1b; /**< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_1b */
981extern X86DESC BS3_FAR_DATA Bs3GdteSpare1c; /**< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_1c */
982extern X86DESC BS3_FAR_DATA Bs3GdteSpare1d; /**< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_1d */
983extern X86DESC BS3_FAR_DATA Bs3GdteSpare1e; /**< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_1e */
984extern X86DESC BS3_FAR_DATA Bs3GdteSpare1f; /**< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_1f */
985
986/** GDTs setting up the tiled 16-bit access to the first 16 MBs of memory.
987 * @see BS3_SEL_TILED, BS3_SEL_TILED_LAST, BS3_SEL_TILED_AREA_SIZE */
988extern X86DESC BS3_FAR_DATA Bs3GdteTiled[256];
989/** Free GDTes, part \#1. */
990extern X86DESC BS3_FAR_DATA Bs3GdteFreePart1[64];
991/** The BS3TEXT16/BS3CLASS16CODE GDT entry. @see BS3_SEL_TEXT16 */
992extern X86DESC BS3_FAR_DATA Bs3Gdte_CODE16;
993/** Free GDTes, part \#2. */
994extern X86DESC BS3_FAR_DATA Bs3GdteFreePart2[511];
995/** The BS3SYSTEM16 GDT entry. */
996extern X86DESC BS3_FAR_DATA Bs3Gdte_SYSTEM16;
997/** Free GDTes, part \#3. */
998extern X86DESC BS3_FAR_DATA Bs3GdteFreePart3[223];
999/** The BS3DATA16/BS3KIT_GRPNM_DATA16 GDT entry. */
1000extern X86DESC BS3_FAR_DATA Bs3Gdte_DATA16;
1001
1002/** Free GDTes, part \#4. */
1003extern X86DESC BS3_FAR_DATA Bs3GdteFreePart4[211];
1004
1005extern X86DESC BS3_FAR_DATA Bs3GdtePreTestPage08; /**< GDT entry 8 selectors prior to the test page, testcase resource. @see BS3_SEL_PRE_TEST_PAGE_08 */
1006extern X86DESC BS3_FAR_DATA Bs3GdtePreTestPage07; /**< GDT entry 7 selectors prior to the test page, testcase resource. @see BS3_SEL_PRE_TEST_PAGE_07 */
1007extern X86DESC BS3_FAR_DATA Bs3GdtePreTestPage06; /**< GDT entry 6 selectors prior to the test page, testcase resource. @see BS3_SEL_PRE_TEST_PAGE_06 */
1008extern X86DESC BS3_FAR_DATA Bs3GdtePreTestPage05; /**< GDT entry 5 selectors prior to the test page, testcase resource. @see BS3_SEL_PRE_TEST_PAGE_05 */
1009extern X86DESC BS3_FAR_DATA Bs3GdtePreTestPage04; /**< GDT entry 4 selectors prior to the test page, testcase resource. @see BS3_SEL_PRE_TEST_PAGE_04 */
1010extern X86DESC BS3_FAR_DATA Bs3GdtePreTestPage03; /**< GDT entry 3 selectors prior to the test page, testcase resource. @see BS3_SEL_PRE_TEST_PAGE_03 */
1011extern X86DESC BS3_FAR_DATA Bs3GdtePreTestPage02; /**< GDT entry 2 selectors prior to the test page, testcase resource. @see BS3_SEL_PRE_TEST_PAGE_02 */
1012extern X86DESC BS3_FAR_DATA Bs3GdtePreTestPage01; /**< GDT entry 1 selectors prior to the test page, testcase resource. @see BS3_SEL_PRE_TEST_PAGE_01 */
1013/** Array of GDT entries starting on a page boundrary and filling (almost) the
1014 * whole page. This is for playing with paging and GDT usage.
1015 * @see BS3_SEL_TEST_PAGE */
1016extern X86DESC BS3_FAR_DATA Bs3GdteTestPage[2043];
1017extern X86DESC BS3_FAR_DATA Bs3GdteTestPage00; /**< GDT entry 0 on the test page (convenience). @see BS3_SEL_TEST_PAGE_00 */
1018extern X86DESC BS3_FAR_DATA Bs3GdteTestPage01; /**< GDT entry 1 on the test page (convenience). @see BS3_SEL_TEST_PAGE_01 */
1019extern X86DESC BS3_FAR_DATA Bs3GdteTestPage02; /**< GDT entry 2 on the test page (convenience). @see BS3_SEL_TEST_PAGE_02 */
1020extern X86DESC BS3_FAR_DATA Bs3GdteTestPage03; /**< GDT entry 3 on the test page (convenience). @see BS3_SEL_TEST_PAGE_03 */
1021extern X86DESC BS3_FAR_DATA Bs3GdteTestPage04; /**< GDT entry 4 on the test page (convenience). @see BS3_SEL_TEST_PAGE_04 */
1022extern X86DESC BS3_FAR_DATA Bs3GdteTestPage05; /**< GDT entry 5 on the test page (convenience). @see BS3_SEL_TEST_PAGE_05 */
1023extern X86DESC BS3_FAR_DATA Bs3GdteTestPage06; /**< GDT entry 6 on the test page (convenience). @see BS3_SEL_TEST_PAGE_06 */
1024extern X86DESC BS3_FAR_DATA Bs3GdteTestPage07; /**< GDT entry 7 on the test page (convenience). @see BS3_SEL_TEST_PAGE_07 */
1025
1026/** The end of the GDT (exclusive - contains eye-catcher string). */
1027extern X86DESC BS3_FAR_DATA Bs3GdtEnd;
1028
1029/** The default 16-bit TSS. */
1030extern X86TSS16 BS3_FAR_DATA Bs3Tss16;
1031extern X86TSS16 BS3_FAR_DATA Bs3Tss16DoubleFault;
1032extern X86TSS16 BS3_FAR_DATA Bs3Tss16Spare0;
1033extern X86TSS16 BS3_FAR_DATA Bs3Tss16Spare1;
1034/** The default 32-bit TSS. */
1035extern X86TSS32 BS3_FAR_DATA Bs3Tss32;
1036extern X86TSS32 BS3_FAR_DATA Bs3Tss32DoubleFault;
1037extern X86TSS32 BS3_FAR_DATA Bs3Tss32Spare0;
1038extern X86TSS32 BS3_FAR_DATA Bs3Tss32Spare1;
1039/** The default 64-bit TSS. */
1040extern X86TSS64 BS3_FAR_DATA Bs3Tss64;
1041extern X86TSS64 BS3_FAR_DATA Bs3Tss64Spare0;
1042extern X86TSS64 BS3_FAR_DATA Bs3Tss64Spare1;
1043extern X86TSS64 BS3_FAR_DATA Bs3Tss64WithIopb;
1044extern X86TSS32 BS3_FAR_DATA Bs3Tss32WithIopb;
1045/** Interrupt redirection bitmap used by Bs3Tss32WithIopb. */
1046extern uint8_t BS3_FAR_DATA Bs3SharedIntRedirBm[32];
1047/** I/O permission bitmap used by Bs3Tss32WithIopb and Bs3Tss64WithIopb. */
1048extern uint8_t BS3_FAR_DATA Bs3SharedIobp[8192+2];
1049/** End of the I/O permission bitmap (exclusive). */
1050extern uint8_t BS3_FAR_DATA Bs3SharedIobpEnd;
1051/** 16-bit IDT. */
1052extern X86DESC BS3_FAR_DATA Bs3Idt16[256];
1053/** 32-bit IDT. */
1054extern X86DESC BS3_FAR_DATA Bs3Idt32[256];
1055/** 64-bit IDT. */
1056extern X86DESC64 BS3_FAR_DATA Bs3Idt64[256];
1057/** Structure for the LIDT instruction for loading the 16-bit IDT. */
1058extern X86XDTR64 BS3_FAR_DATA Bs3Lidt_Idt16;
1059/** Structure for the LIDT instruction for loading the 32-bit IDT. */
1060extern X86XDTR64 BS3_FAR_DATA Bs3Lidt_Idt32;
1061/** Structure for the LIDT instruction for loading the 64-bit IDT. */
1062extern X86XDTR64 BS3_FAR_DATA Bs3Lidt_Idt64;
1063/** Structure for the LIDT instruction for loading the real mode interrupt
1064 * vector table. */
1065extern X86XDTR64 BS3_FAR_DATA Bs3Lidt_Ivt;
1066/** Structure for the LGDT instruction for loading the current GDT. */
1067extern X86XDTR64 BS3_FAR_DATA Bs3Lgdt_Gdt;
1068/** Structure for the LGDT instruction for loading the default GDT. */
1069extern X86XDTR64 BS3_FAR_DATA Bs3LgdtDef_Gdt;
1070/** The LDT (all entries are empty, fill in for testing). */
1071extern X86DESC BS3_FAR_DATA Bs3Ldt[116];
1072/** The end of the LDT (exclusive). */
1073extern X86DESC BS3_FAR_DATA Bs3LdtEnd;
1074
1075/** @} */
1076
1077
1078/** @name Segment start and end markers, sizes.
1079 * @{ */
1080/** Start of the BS3TEXT16 segment. */
1081extern uint8_t BS3_FAR_DATA Bs3Text16_StartOfSegment;
1082/** End of the BS3TEXT16 segment. */
1083extern uint8_t BS3_FAR_DATA Bs3Text16_EndOfSegment;
1084/** The size of the BS3TEXT16 segment. */
1085extern uint16_t BS3_FAR_DATA Bs3Text16_Size;
1086
1087/** Start of the BS3SYSTEM16 segment. */
1088extern uint8_t BS3_FAR_DATA Bs3System16_StartOfSegment;
1089/** End of the BS3SYSTEM16 segment. */
1090extern uint8_t BS3_FAR_DATA Bs3System16_EndOfSegment;
1091
1092/** Start of the BS3DATA16/BS3KIT_GRPNM_DATA16 segment. */
1093extern uint8_t BS3_FAR_DATA Bs3Data16_StartOfSegment;
1094/** End of the BS3DATA16/BS3KIT_GRPNM_DATA16 segment. */
1095extern uint8_t BS3_FAR_DATA Bs3Data16_EndOfSegment;
1096
1097/** Start of the BS3RMTEXT16 segment. */
1098extern uint8_t BS3_FAR_DATA Bs3RmText16_StartOfSegment;
1099/** End of the BS3RMTEXT16 segment. */
1100extern uint8_t BS3_FAR_DATA Bs3RmText16_EndOfSegment;
1101/** The size of the BS3RMTEXT16 segment. */
1102extern uint16_t BS3_FAR_DATA Bs3RmText16_Size;
1103/** The flat start address of the BS3X0TEXT16 segment. */
1104extern uint32_t BS3_FAR_DATA Bs3RmText16_FlatAddr;
1105
1106/** Start of the BS3X0TEXT16 segment. */
1107extern uint8_t BS3_FAR_DATA Bs3X0Text16_StartOfSegment;
1108/** End of the BS3X0TEXT16 segment. */
1109extern uint8_t BS3_FAR_DATA Bs3X0Text16_EndOfSegment;
1110/** The size of the BS3X0TEXT16 segment. */
1111extern uint16_t BS3_FAR_DATA Bs3X0Text16_Size;
1112/** The flat start address of the BS3X0TEXT16 segment. */
1113extern uint32_t BS3_FAR_DATA Bs3X0Text16_FlatAddr;
1114
1115/** Start of the BS3X1TEXT16 segment. */
1116extern uint8_t BS3_FAR_DATA Bs3X1Text16_StartOfSegment;
1117/** End of the BS3X1TEXT16 segment. */
1118extern uint8_t BS3_FAR_DATA Bs3X1Text16_EndOfSegment;
1119/** The size of the BS3X1TEXT16 segment. */
1120extern uint16_t BS3_FAR_DATA Bs3X1Text16_Size;
1121/** The flat start address of the BS3X1TEXT16 segment. */
1122extern uint32_t BS3_FAR_DATA Bs3X1Text16_FlatAddr;
1123
1124/** Start of the BS3TEXT32 segment. */
1125extern uint8_t BS3_FAR_DATA Bs3Text32_StartOfSegment;
1126/** Start of the BS3TEXT32 segment. */
1127extern uint8_t BS3_FAR_DATA Bs3Text32_EndOfSegment;
1128
1129/** Start of the BS3DATA32 segment. */
1130extern uint8_t BS3_FAR_DATA Bs3Data32_StartOfSegment;
1131/** Start of the BS3DATA32 segment. */
1132extern uint8_t BS3_FAR_DATA Bs3Data32_EndOfSegment;
1133
1134/** Start of the BS3TEXT64 segment. */
1135extern uint8_t BS3_FAR_DATA Bs3Text64_StartOfSegment;
1136/** Start of the BS3TEXT64 segment. */
1137extern uint8_t BS3_FAR_DATA Bs3Text64_EndOfSegment;
1138
1139/** Start of the BS3DATA64 segment. */
1140extern uint8_t BS3_FAR_DATA Bs3Data64_StartOfSegment;
1141/** Start of the BS3DATA64 segment. */
1142extern uint8_t BS3_FAR_DATA Bs3Data64_EndOfSegment;
1143
1144/** The size of the Data16, Text32, Text64, Data32 and Data64 blob. */
1145extern uint32_t BS3_FAR_DATA Bs3Data16Thru64Text32And64_TotalSize;
1146/** The total image size (from Text16 thu Data64). */
1147extern uint32_t BS3_FAR_DATA Bs3TotalImageSize;
1148/** @} */
1149
1150
1151/** Lower case hex digits. */
1152extern char const g_achBs3HexDigits[16+1];
1153/** Upper case hex digits. */
1154extern char const g_achBs3HexDigitsUpper[16+1];
1155
1156
1157/** The current mode (BS3_MODE_XXX) of CPU \#0. */
1158extern uint8_t g_bBs3CurrentMode;
1159
1160/** Hint for 16-bit trap handlers regarding the high word of EIP. */
1161extern uint32_t g_uBs3TrapEipHint;
1162
1163/** Set to disable special V8086 \#GP and \#UD handling in Bs3TrapDefaultHandler.
1164 * This is useful for getting */
1165extern bool volatile g_fBs3TrapNoV86Assist;
1166
1167/** Copy of the original real-mode interrupt vector table. */
1168extern RTFAR16 g_aBs3RmIvtOriginal[256];
1169
1170
1171#ifdef __WATCOMC__
1172/**
1173 * Executes the SMSW instruction and returns the value.
1174 *
1175 * @returns Machine status word.
1176 */
1177uint16_t Bs3AsmSmsw(void);
1178# pragma aux Bs3AsmSmsw = \
1179 ".286" \
1180 "smsw ax" \
1181 value [ax] modify exact [ax] nomemory;
1182#endif
1183
1184
1185/** @defgroup bs3kit_cross_ptr Cross Context Pointer Type
1186 *
1187 * The cross context pointer type is
1188 *
1189 * @{ */
1190
1191/**
1192 * Cross context pointer base type.
1193 */
1194typedef union BS3XPTR
1195{
1196 /** The flat pointer. */
1197 uint32_t uFlat;
1198 /** 16-bit view. */
1199 struct
1200 {
1201 uint16_t uLow;
1202 uint16_t uHigh;
1203 } u;
1204#if ARCH_BITS == 16
1205 /** 16-bit near pointer. */
1206 void __near *pvNear;
1207#elif ARCH_BITS == 32
1208 /** 32-bit pointer. */
1209 void *pvRaw;
1210#endif
1211} BS3XPTR;
1212AssertCompileSize(BS3XPTR, 4);
1213
1214
1215/** @def BS3_XPTR_DEF_INTERNAL
1216 * Internal worker.
1217 *
1218 * @param a_Scope RT_NOTHING if structure or global, static or extern
1219 * otherwise.
1220 * @param a_Type The type we're pointing to.
1221 * @param a_Name The member or variable name.
1222 * @internal
1223 */
1224#if ARCH_BITS == 16
1225# define BS3_XPTR_DEF_INTERNAL(a_Scope, a_Type, a_Name) \
1226 a_Scope union \
1227 { \
1228 BS3XPTR XPtr; \
1229 a_Type __near *pNearTyped; \
1230 } a_Name
1231#elif ARCH_BITS == 32
1232# define BS3_XPTR_DEF_INTERNAL(a_Scope, a_Type, a_Name) \
1233 a_Scope union \
1234 { \
1235 BS3XPTR XPtr; \
1236 a_Type *pTyped; \
1237 } a_Name
1238#elif ARCH_BITS == 64
1239# define BS3_XPTR_DEF_INTERNAL(a_Scope, a_Type, a_Name) \
1240 a_Scope union \
1241 { \
1242 BS3XPTR XPtr; \
1243 } a_Name
1244#else
1245# error "ARCH_BITS"
1246#endif
1247
1248/** @def BS3_XPTR_MEMBER
1249 * Defines a pointer member that can be shared by all CPU modes.
1250 *
1251 * @param a_Type The type we're pointing to.
1252 * @param a_Name The member or variable name.
1253 */
1254#define BS3_XPTR_MEMBER(a_Type, a_Name) BS3_XPTR_DEF_INTERNAL(RT_NOTHING, a_Type, a_Name)
1255
1256/** @def BS3_XPTR_AUTO
1257 * Defines a pointer static variable for working with an XPTR.
1258 *
1259 * This is typically used to convert flat pointers into context specific
1260 * pointers.
1261 *
1262 * @param a_Type The type we're pointing to.
1263 * @param a_Name The member or variable name.
1264 */
1265#define BS3_XPTR_AUTO(a_Type, a_Name) BS3_XPTR_DEF_INTERNAL(RT_NOTHING, a_Type, a_Name)
1266
1267/** @def BS3_XPTR_SET_FLAT
1268 * Sets a cross context pointer.
1269 *
1270 * @param a_Type The type we're pointing to.
1271 * @param a_Name The member or variable name.
1272 * @param a_uFlatPtr The flat pointer value to assign. If the x-pointer is
1273 * used in real mode, this must be less than 1MB.
1274 * Otherwise the limit is 16MB (due to selector tiling).
1275 */
1276#define BS3_XPTR_SET_FLAT(a_Type, a_Name, a_uFlatPtr) \
1277 do { a_Name.XPtr.uFlat = (a_uFlatPtr); } while (0)
1278
1279/** @def BS3_XPTR_GET_FLAT
1280 * Gets the flat address of a cross context pointer.
1281 *
1282 * @returns 32-bit flat pointer.
1283 * @param a_Type The type we're pointing to.
1284 * @param a_Name The member or variable name.
1285 */
1286#define BS3_XPTR_GET_FLAT(a_Type, a_Name) (a_Name.XPtr.uFlat)
1287
1288/** @def BS3_XPTR_GET_FLAT_LOW
1289 * Gets the low 16 bits of the flat address.
1290 *
1291 * @returns Low 16 bits of the flat pointer.
1292 * @param a_Type The type we're pointing to.
1293 * @param a_Name The member or variable name.
1294 */
1295#define BS3_XPTR_GET_FLAT_LOW(a_Type, a_Name) (a_Name.XPtr.u.uLow)
1296
1297
1298#if ARCH_BITS == 16
1299
1300/**
1301 * Gets the current ring number.
1302 * @returns Ring number.
1303 */
1304DECLINLINE(uint16_t) Bs3Sel16GetCurRing(void);
1305# pragma aux Bs3Sel16GetCurRing = \
1306 "mov ax, ss" \
1307 "and ax, 3" \
1308 value [ax] modify exact [ax] nomemory;
1309
1310/**
1311 * Converts the high word of a flat pointer into a 16-bit selector.
1312 *
1313 * This makes use of the tiled area. It also handles real mode.
1314 *
1315 * @returns Segment selector value.
1316 * @param uHigh The high part of flat pointer.
1317 * @sa BS3_XPTR_GET, BS3_XPTR_SET
1318 */
1319DECLINLINE(__segment) Bs3Sel16HighFlatPtrToSelector(uint16_t uHigh)
1320{
1321 if (!BS3_MODE_IS_RM_OR_V86(g_bBs3CurrentMode))
1322 return (__segment)(((uHigh << 3) + BS3_SEL_TILED) | Bs3Sel16GetCurRing());
1323 return (__segment)(uHigh << 12);
1324}
1325
1326#endif /* ARCH_BITS == 16 */
1327
1328/** @def BS3_XPTR_GET
1329 * Gets the current context pointer value.
1330 *
1331 * @returns Usable pointer.
1332 * @param a_Type The type we're pointing to.
1333 * @param a_Name The member or variable name.
1334 */
1335#if ARCH_BITS == 16
1336# define BS3_XPTR_GET(a_Type, a_Name) \
1337 ((a_Type BS3_FAR *)BS3_FP_MAKE(Bs3Sel16HighFlatPtrToSelector((a_Name).XPtr.u.uHigh), (a_Name).pNearTyped))
1338#elif ARCH_BITS == 32
1339# define BS3_XPTR_GET(a_Type, a_Name) ((a_Name).pTyped)
1340#elif ARCH_BITS == 64
1341# define BS3_XPTR_GET(a_Type, a_Name) ((a_Type *)(uintptr_t)(a_Name).XPtr.uFlat)
1342#else
1343# error "ARCH_BITS"
1344#endif
1345
1346/** @def BS3_XPTR_SET
1347 * Gets the current context pointer value.
1348 *
1349 * @returns Usable pointer.
1350 * @param a_Type The type we're pointing to.
1351 * @param a_Name The member or variable name.
1352 * @param a_pValue The new pointer value, current context pointer.
1353 */
1354#if ARCH_BITS == 16
1355# define BS3_XPTR_SET(a_Type, a_Name, a_pValue) \
1356 do { \
1357 a_Type BS3_FAR *pTypeCheck = (a_pValue); \
1358 if (BS3_MODE_IS_RM_OR_V86(g_bBs3CurrentMode)) \
1359 (a_Name).XPtr.uFlat = BS3_FP_OFF(pTypeCheck) + ((uint32_t)BS3_FP_SEG(pTypeCheck) << 4); \
1360 else \
1361 { \
1362 (a_Name).XPtr.u.uLow = BS3_FP_OFF(pTypeCheck); \
1363 (a_Name).XPtr.u.uHigh = ((BS3_FP_SEG(pTypeCheck) & UINT16_C(0xfff8)) - BS3_SEL_TILED) >> 3; \
1364 } \
1365 } while (0)
1366#elif ARCH_BITS == 32
1367# define BS3_XPTR_SET(a_Type, a_Name, a_pValue) \
1368 do { (a_Name).pTyped = (a_pValue); } while (0)
1369#elif ARCH_BITS == 64
1370# define BS3_XPTR_SET(a_Type, a_Name, a_pValue) \
1371 do { \
1372 a_Type *pTypeCheck = (a_pValue); \
1373 (a_Name).XPtr.uFlat = (uint32_t)(uintptr_t)pTypeCheck; \
1374 } while (0)
1375#else
1376# error "ARCH_BITS"
1377#endif
1378
1379
1380/** @def BS3_XPTR_IS_NULL
1381 * Checks if the cross context pointer is NULL.
1382 *
1383 * @returns true if NULL, false if not.
1384 * @param a_Type The type we're pointing to.
1385 * @param a_Name The member or variable name.
1386 */
1387#define BS3_XPTR_IS_NULL(a_Type, a_Name) ((a_Name).XPtr.uFlat == 0)
1388
1389/**
1390 * Gets a working pointer from a flat address.
1391 *
1392 * @returns Current context pointer.
1393 * @param uFlatPtr The flat address to convert (32-bit or 64-bit).
1394 */
1395DECLINLINE(void BS3_FAR *) Bs3XptrFlatToCurrent(RTCCUINTXREG uFlatPtr)
1396{
1397 BS3_XPTR_AUTO(void, pTmp);
1398 BS3_XPTR_SET_FLAT(void, pTmp, uFlatPtr);
1399 return BS3_XPTR_GET(void, pTmp);
1400}
1401
1402/** @} */
1403
1404
1405
1406/** @defgroup grp_bs3kit_cmn Common Functions and Data
1407 *
1408 * The common functions comes in three variations: 16-bit, 32-bit and 64-bit.
1409 * Templated code uses the #BS3_CMN_NM macro to mangle the name according to the
1410 * desired
1411 *
1412 * @{
1413 */
1414
1415/** @def BS3_CMN_PROTO_INT
1416 * Internal macro for prototyping all the variations of a common function.
1417 * @param a_RetType The return type.
1418 * @param a_Name The function basename.
1419 * @param a_Params The parameter list (in parentheses).
1420 * @sa BS3_CMN_PROTO_STUB, BS3_CMN_PROTO_NOSB
1421 */
1422#if ARCH_BITS == 16
1423# ifndef BS3_USE_ALT_16BIT_TEXT_SEG
1424# define BS3_CMN_PROTO_INT(a_RetType, a_Name, a_Params) \
1425 BS3_DECL_NEAR(a_RetType) BS3_CMN_NM(a_Name) a_Params; \
1426 BS3_DECL_FAR(a_RetType) BS3_CMN_FAR_NM(a_Name) a_Params
1427# else
1428# define BS3_CMN_PROTO_INT(a_RetType, a_Name, a_Params) \
1429 BS3_DECL_FAR(a_RetType) BS3_CMN_FAR_NM(a_Name) a_Params
1430# endif
1431#else
1432# define BS3_CMN_PROTO_INT(a_RetType, a_Name, a_Params) \
1433 BS3_DECL_NEAR(a_RetType) BS3_CMN_NM(a_Name) a_Params
1434#endif
1435
1436/** @def BS3_CMN_PROTO_STUB
1437 * Macro for prototyping all the variations of a common function with automatic
1438 * near -> far stub.
1439 *
1440 * @param a_RetType The return type.
1441 * @param a_Name The function basename.
1442 * @param a_Params The parameter list (in parentheses).
1443 * @sa BS3_CMN_PROTO_NOSB
1444 */
1445#define BS3_CMN_PROTO_STUB(a_RetType, a_Name, a_Params) BS3_CMN_PROTO_INT(a_RetType, a_Name, a_Params)
1446
1447/** @def BS3_CMN_PROTO_NOSB
1448 * Macro for prototyping all the variations of a common function without any
1449 * near > far stub.
1450 *
1451 * @param a_RetType The return type.
1452 * @param a_Name The function basename.
1453 * @param a_Params The parameter list (in parentheses).
1454 * @sa BS3_CMN_PROTO_STUB
1455 */
1456#define BS3_CMN_PROTO_NOSB(a_RetType, a_Name, a_Params) BS3_CMN_PROTO_INT(a_RetType, a_Name, a_Params)
1457
1458/** @def BS3_CMN_PROTO_FARSTUB
1459 * Macro for prototyping all the variations of a common function with automatic
1460 * far -> near stub.
1461 *
1462 * @param a_cbParam16 The size of the 16-bit parameter list in bytes.
1463 * @param a_RetType The return type.
1464 * @param a_Name The function basename.
1465 * @param a_Params The parameter list (in parentheses).
1466 * @sa BS3_CMN_PROTO_STUB
1467 */
1468#define BS3_CMN_PROTO_FARSTUB(a_cbParam16, a_RetType, a_Name, a_Params) BS3_CMN_PROTO_INT(a_RetType, a_Name, a_Params)
1469
1470
1471/** @def BS3_CMN_DEF
1472 * Macro for defining a common function.
1473 *
1474 * This makes 16-bit common function far, while 32-bit and 64-bit are near.
1475 *
1476 * @param a_RetType The return type.
1477 * @param a_Name The function basename.
1478 * @param a_Params The parameter list (in parentheses).
1479 */
1480#if ARCH_BITS == 16
1481# define BS3_CMN_DEF(a_RetType, a_Name, a_Params) \
1482 BS3_DECL_FAR(a_RetType) BS3_CMN_FAR_NM(a_Name) a_Params
1483#else
1484# define BS3_CMN_DEF(a_RetType, a_Name, a_Params) \
1485 BS3_DECL_NEAR(a_RetType) BS3_CMN_NM(a_Name) a_Params
1486#endif
1487
1488/** @def BS3_ASSERT
1489 * Assert that an expression is true.
1490 *
1491 * Calls Bs3Panic if false and it's a strict build. Does nothing in
1492 * non-strict builds. */
1493#ifdef BS3_STRICT
1494# define BS3_ASSERT(a_Expr) do { if (!!(a_Expr)) { /* likely */ } else { Bs3Panic(); } } while (0) /**< @todo later */
1495#else
1496# define BS3_ASSERT(a_Expr) do { } while (0)
1497#endif
1498
1499/**
1500 * Panic, never return.
1501 *
1502 * The current implementation will only halt the CPU.
1503 */
1504BS3_CMN_PROTO_NOSB(DECL_NO_RETURN(void), Bs3Panic,(void));
1505#if !defined(BS3_KIT_WITH_NO_RETURN) && defined(__WATCOMC__)
1506# pragma aux Bs3Panic_c16 __aborts
1507# pragma aux Bs3Panic_f16 __aborts
1508# pragma aux Bs3Panic_c32 __aborts
1509#endif
1510
1511
1512/**
1513 * Translate a mode into a string.
1514 *
1515 * @returns Pointer to read-only mode name string.
1516 * @param bMode The mode value (BS3_MODE_XXX).
1517 */
1518BS3_CMN_PROTO_STUB(const char BS3_FAR *, Bs3GetModeName,(uint8_t bMode));
1519
1520/**
1521 * Translate a mode into a short lower case string.
1522 *
1523 * @returns Pointer to read-only short mode name string.
1524 * @param bMode The mode value (BS3_MODE_XXX).
1525 */
1526BS3_CMN_PROTO_STUB(const char BS3_FAR *, Bs3GetModeNameShortLower,(uint8_t bMode));
1527
1528/** CPU vendors. */
1529typedef enum BS3CPUVENDOR
1530{
1531 BS3CPUVENDOR_INVALID = 0,
1532 BS3CPUVENDOR_INTEL,
1533 BS3CPUVENDOR_AMD,
1534 BS3CPUVENDOR_VIA,
1535 BS3CPUVENDOR_CYRIX,
1536 BS3CPUVENDOR_UNKNOWN,
1537 BS3CPUVENDOR_END
1538} BS3CPUVENDOR;
1539
1540/**
1541 * Tries to detect the CPU vendor.
1542 *
1543 * @returns CPU vendor.
1544 */
1545BS3_CMN_PROTO_STUB(BS3CPUVENDOR, Bs3GetCpuVendor,(void));
1546
1547/**
1548 * Shutdown the system, never returns.
1549 *
1550 * This currently only works for VMs. When running on real systems it will
1551 * just halt the CPU.
1552 */
1553BS3_CMN_PROTO_NOSB(void, Bs3Shutdown,(void));
1554
1555/**
1556 * Prints a 32-bit unsigned value as decimal to the screen.
1557 *
1558 * @param uValue The 32-bit value.
1559 */
1560BS3_CMN_PROTO_NOSB(void, Bs3PrintU32,(uint32_t uValue));
1561
1562/**
1563 * Prints a 32-bit unsigned value as hex to the screen.
1564 *
1565 * @param uValue The 32-bit value.
1566 */
1567BS3_CMN_PROTO_NOSB(void, Bs3PrintX32,(uint32_t uValue));
1568
1569/**
1570 * Formats and prints a string to the screen.
1571 *
1572 * See #Bs3StrFormatV for supported format types.
1573 *
1574 * @param pszFormat The format string.
1575 * @param ... Format arguments.
1576 */
1577BS3_CMN_PROTO_STUB(size_t, Bs3Printf,(const char BS3_FAR *pszFormat, ...));
1578
1579/**
1580 * Formats and prints a string to the screen, va_list version.
1581 *
1582 * See #Bs3StrFormatV for supported format types.
1583 *
1584 * @param pszFormat The format string.
1585 * @param va Format arguments.
1586 */
1587BS3_CMN_PROTO_STUB(size_t, Bs3PrintfV,(const char BS3_FAR *pszFormat, va_list BS3_FAR va));
1588
1589/**
1590 * Prints a string to the screen.
1591 *
1592 * @param pszString The string to print.
1593 */
1594BS3_CMN_PROTO_STUB(void, Bs3PrintStr,(const char BS3_FAR *pszString));
1595
1596/**
1597 * Prints a string to the screen.
1598 *
1599 * @param pszString The string to print. Any terminator charss will be printed.
1600 * @param cchString The exact number of characters to print.
1601 */
1602BS3_CMN_PROTO_NOSB(void, Bs3PrintStrN,(const char BS3_FAR *pszString, size_t cchString));
1603
1604/**
1605 * Prints a char to the screen.
1606 *
1607 * @param ch The character to print.
1608 */
1609BS3_CMN_PROTO_NOSB(void, Bs3PrintChr,(char ch));
1610
1611
1612/**
1613 * An output function for #Bs3StrFormatV.
1614 *
1615 * @returns Number of characters written.
1616 * @param ch The character to write. Zero in the final call.
1617 * @param pvUser User argument supplied to #Bs3StrFormatV.
1618 */
1619typedef BS3_DECL_CALLBACK(size_t) FNBS3STRFORMATOUTPUT(char ch, void BS3_FAR *pvUser);
1620/** Pointer to an output function for #Bs3StrFormatV. */
1621typedef FNBS3STRFORMATOUTPUT *PFNBS3STRFORMATOUTPUT;
1622
1623/**
1624 * Formats a string, sending the output to @a pfnOutput.
1625 *
1626 * Supported types:
1627 * - %RI8, %RI16, %RI32, %RI64
1628 * - %RU8, %RU16, %RU32, %RU64
1629 * - %RX8, %RX16, %RX32, %RX64
1630 * - %i, %d
1631 * - %u
1632 * - %x
1633 * - %c
1634 * - %p (far pointer)
1635 * - %s (far pointer)
1636 *
1637 * @returns Sum of @a pfnOutput return values.
1638 * @param pszFormat The format string.
1639 * @param va Format arguments.
1640 * @param pfnOutput The output function.
1641 * @param pvUser The user argument for the output function.
1642 */
1643BS3_CMN_PROTO_STUB(size_t, Bs3StrFormatV,(const char BS3_FAR *pszFormat, va_list BS3_FAR va,
1644 PFNBS3STRFORMATOUTPUT pfnOutput, void BS3_FAR *pvUser));
1645
1646/**
1647 * Formats a string into a buffer.
1648 *
1649 * See #Bs3StrFormatV for supported format types.
1650 *
1651 * @returns The length of the formatted string (excluding terminator).
1652 * This will be higher or equal to @c cbBuf in case of an overflow.
1653 * @param pszBuf The output buffer.
1654 * @param cbBuf The size of the output buffer.
1655 * @param pszFormat The format string.
1656 * @param va Format arguments.
1657 */
1658BS3_CMN_PROTO_STUB(size_t, Bs3StrPrintfV,(char BS3_FAR *pszBuf, size_t cbBuf, const char BS3_FAR *pszFormat, va_list BS3_FAR va));
1659
1660/**
1661 * Formats a string into a buffer.
1662 *
1663 * See #Bs3StrFormatV for supported format types.
1664 *
1665 * @returns The length of the formatted string (excluding terminator).
1666 * This will be higher or equal to @c cbBuf in case of an overflow.
1667 * @param pszBuf The output buffer.
1668 * @param cbBuf The size of the output buffer.
1669 * @param pszFormat The format string.
1670 * @param ... Format arguments.
1671 */
1672BS3_CMN_PROTO_STUB(size_t, Bs3StrPrintf,(char BS3_FAR *pszBuf, size_t cbBuf, const char BS3_FAR *pszFormat, ...));
1673
1674
1675/**
1676 * Finds the length of a zero terminated string.
1677 *
1678 * @returns String length in chars/bytes.
1679 * @param pszString The string to examine.
1680 */
1681BS3_CMN_PROTO_STUB(size_t, Bs3StrLen,(const char BS3_FAR *pszString));
1682
1683/**
1684 * Finds the length of a zero terminated string, but with a max length.
1685 *
1686 * @returns String length in chars/bytes, or @a cchMax if no zero-terminator
1687 * was found before we reached the limit.
1688 * @param pszString The string to examine.
1689 * @param cchMax The max length to examine.
1690 */
1691BS3_CMN_PROTO_STUB(size_t, Bs3StrNLen,(const char BS3_FAR *pszString, size_t cchMax));
1692
1693/**
1694 * CRT style unsafe strcpy.
1695 *
1696 * @returns pszDst.
1697 * @param pszDst The destination buffer. Must be large enough to
1698 * hold the source string.
1699 * @param pszSrc The source string.
1700 */
1701BS3_CMN_PROTO_STUB(char BS3_FAR *, Bs3StrCpy,(char BS3_FAR *pszDst, const char BS3_FAR *pszSrc));
1702
1703/**
1704 * CRT style memcpy.
1705 *
1706 * @returns pvDst
1707 * @param pvDst The destination buffer.
1708 * @param pvSrc The source buffer.
1709 * @param cbToCopy The number of bytes to copy.
1710 */
1711BS3_CMN_PROTO_STUB(void BS3_FAR *, Bs3MemCpy,(void BS3_FAR *pvDst, const void BS3_FAR *pvSrc, size_t cbToCopy));
1712
1713/**
1714 * GNU (?) style mempcpy.
1715 *
1716 * @returns pvDst + cbCopy
1717 * @param pvDst The destination buffer.
1718 * @param pvSrc The source buffer.
1719 * @param cbToCopy The number of bytes to copy.
1720 */
1721BS3_CMN_PROTO_STUB(void BS3_FAR *, Bs3MemPCpy,(void BS3_FAR *pvDst, const void BS3_FAR *pvSrc, size_t cbToCopy));
1722
1723/**
1724 * CRT style memmove (overlapping buffers is fine).
1725 *
1726 * @returns pvDst
1727 * @param pvDst The destination buffer.
1728 * @param pvSrc The source buffer.
1729 * @param cbToCopy The number of bytes to copy.
1730 */
1731BS3_CMN_PROTO_STUB(void BS3_FAR *, Bs3MemMove,(void BS3_FAR *pvDst, const void BS3_FAR *pvSrc, size_t cbToCopy));
1732
1733/**
1734 * BSD style bzero.
1735 *
1736 * @param pvDst The buffer to be zeroed.
1737 * @param cbDst The number of bytes to zero.
1738 */
1739BS3_CMN_PROTO_NOSB(void, Bs3MemZero,(void BS3_FAR *pvDst, size_t cbDst));
1740
1741/**
1742 * CRT style memset.
1743 *
1744 * @param pvDst The buffer to be fill.
1745 * @param bFiller The filler byte.
1746 * @param cbDst The number of bytes to fill.
1747 */
1748BS3_CMN_PROTO_NOSB(void, Bs3MemSet,(void BS3_FAR *pvDst, uint8_t bFiller, size_t cbDst));
1749
1750/**
1751 * CRT style memchr.
1752 *
1753 * @param pvHaystack The memory to scan for @a bNeedle.
1754 * @param bNeedle The byte to search for.
1755 * @param cbHaystack The amount of memory to search.
1756 */
1757BS3_CMN_PROTO_NOSB(void BS3_FAR *, Bs3MemChr,(void const BS3_FAR *pvHaystack, uint8_t bNeedle, size_t cbHaystack));
1758
1759/**
1760 * CRT style memcmp.
1761 *
1762 * @returns 0 if equal. Negative if the left side is 'smaller' than the right
1763 * side, and positive in the other case.
1764 * @param pv1 The left hand memory.
1765 * @param pv2 The right hand memory.
1766 * @param cb The number of bytes to compare.
1767 */
1768BS3_CMN_PROTO_NOSB(int, Bs3MemCmp,(void const BS3_FAR *pv1, void const BS3_FAR *pv2, size_t cb));
1769
1770BS3_CMN_PROTO_STUB(void, Bs3UInt64Div,(RTUINT64U uDividend, RTUINT64U uDivisor, RTUINT64U BS3_FAR *paQuotientReminder));
1771BS3_CMN_PROTO_STUB(void, Bs3UInt32Div,(RTUINT32U uDividend, RTUINT32U uDivisor, RTUINT32U BS3_FAR *paQuotientReminder));
1772
1773
1774/**
1775 * Converts a protected mode 32-bit far pointer to a 32-bit flat address.
1776 *
1777 * @returns 32-bit flat address.
1778 * @param off The segment offset.
1779 * @param uSel The protected mode segment selector.
1780 */
1781BS3_CMN_PROTO_STUB(uint32_t, Bs3SelProtFar32ToFlat32,(uint32_t off, uint16_t uSel));
1782
1783/**
1784 * Converts a current mode 32-bit far pointer to a 32-bit flat address.
1785 *
1786 * @returns 32-bit flat address.
1787 * @param off The segment offset.
1788 * @param uSel The current mode segment selector.
1789 */
1790BS3_CMN_PROTO_STUB(uint32_t, Bs3SelFar32ToFlat32,(uint32_t off, uint16_t uSel));
1791
1792/**
1793 * Wrapper around Bs3SelFar32ToFlat32 that makes it easier to use in tight
1794 * assembly spots.
1795 *
1796 * @returns 32-bit flat address.
1797 * @param off The segment offset.
1798 * @param uSel The current mode segment selector.
1799 * @remarks All register are preserved, except return.
1800 * @remarks No 20h scratch space required in 64-bit mode.
1801 */
1802BS3_CMN_PROTO_FARSTUB(6, uint32_t, Bs3SelFar32ToFlat32NoClobber,(uint32_t off, uint16_t uSel));
1803
1804/**
1805 * Converts a real mode code segment to a protected mode code segment selector.
1806 *
1807 * @returns protected mode segment selector.
1808 * @param uRealSeg Real mode code segment.
1809 * @remarks All register are preserved, except return and parameter.
1810 */
1811BS3_CMN_PROTO_NOSB(uint16_t, Bs3SelRealModeCodeToProtMode,(uint16_t uRealSeg));
1812
1813/**
1814 * Converts a real mode code segment to a protected mode code segment selector.
1815 *
1816 * @returns protected mode segment selector.
1817 * @param uProtSel Real mode code segment.
1818 * @remarks All register are preserved, except return and parameter.
1819 */
1820BS3_CMN_PROTO_NOSB(uint16_t, Bs3SelProtModeCodeToRealMode,(uint16_t uProtSel));
1821
1822/**
1823 * Converts a flat code address to a real mode segment and offset.
1824 *
1825 * @returns Far real mode address (high 16-bit is segment, low is offset).
1826 * @param uFlatAddr Flat code address.
1827 * @remarks All register are preserved, except return and parameter.
1828 */
1829BS3_CMN_PROTO_NOSB(uint32_t, Bs3SelFlatCodeToRealMode,(uint32_t uFlatAddr));
1830
1831/**
1832 * Converts a flat code address to a protected mode 16-bit far pointer (ring-0).
1833 *
1834 * @returns Far 16-bit protected mode address (high 16-bit is segment selector,
1835 * low is segment offset).
1836 * @param uFlatAddr Flat code address.
1837 * @remarks All register are preserved, except return and parameter.
1838 */
1839BS3_CMN_PROTO_NOSB(uint32_t, Bs3SelFlatCodeToProtFar16,(uint32_t uFlatAddr));
1840
1841/**
1842 * Converts a far 16:16 real mode (code) address to a flat address.
1843 *
1844 * @returns 32-bit flat address.
1845 * @param uFar1616 Far real mode address (high 16-bit is segment, low
1846 * is offset).
1847 * @remarks All register are preserved, except return.
1848 * @remarks No 20h scratch space required in 64-bit mode.
1849 * @remarks Exactly the same as Bs3SelRealModeDataToFlat, except for param.
1850 */
1851BS3_CMN_PROTO_FARSTUB(4, uint32_t, Bs3SelRealModeCodeToFlat,(PFNBS3FARADDRCONV uFar1616));
1852
1853/**
1854 * Converts a flat data address to a real mode segment and offset.
1855 *
1856 * @returns Far real mode address (high 16-bit is segment, low is offset)
1857 * @param uFlatAddr Flat code address.
1858 * @remarks All register are preserved, except return.
1859 * @remarks No 20h scratch space required in 64-bit mode.
1860 */
1861BS3_CMN_PROTO_FARSTUB(4, uint32_t, Bs3SelFlatDataToRealMode,(uint32_t uFlatAddr));
1862
1863/**
1864 * Converts a flat data address to a real mode segment and offset.
1865 *
1866 * @returns Far 16-bit protected mode address (high 16-bit is segment selector,
1867 * low is segment offset).
1868 * @param uFlatAddr Flat code address.
1869 * @remarks All register are preserved, except return.
1870 * @remarks No 20h scratch space required in 64-bit mode.
1871 */
1872BS3_CMN_PROTO_FARSTUB(4, uint32_t, Bs3SelFlatDataToProtFar16,(uint32_t uFlatAddr));
1873
1874/**
1875 * Converts a far 16:16 data address to a real mode segment and offset.
1876 *
1877 * @returns Far real mode address (high 16-bit is segment, low is offset)
1878 * @param uFar1616 Far 16-bit protected mode address (high 16-bit is
1879 * segment selector, low is segment offset).
1880 * @remarks All register are preserved, except return.
1881 * @remarks No 20h scratch space required in 64-bit mode.
1882 */
1883BS3_CMN_PROTO_FARSTUB(4, uint32_t, Bs3SelProtFar16DataToRealMode,(uint32_t uFar1616));
1884
1885/**
1886 * Converts a far 16:16 real mode address to a 16-bit protected mode address.
1887 *
1888 * @returns Far real mode address (high 16-bit is segment, low is offset)
1889 * @param uFar1616 Far real mode address (high 16-bit is segment, low
1890 * is offset).
1891 * @remarks All register are preserved, except return.
1892 * @remarks No 20h scratch space required in 64-bit mode.
1893 */
1894BS3_CMN_PROTO_FARSTUB(4, uint32_t, Bs3SelRealModeDataToProtFar16,(uint32_t uFar1616));
1895
1896/**
1897 * Converts a far 16:16 data address to a flat 32-bit address.
1898 *
1899 * @returns 32-bit flat address.
1900 * @param uFar1616 Far 16-bit protected mode address (high 16-bit is
1901 * segment selector, low is segment offset).
1902 * @remarks All register are preserved, except return.
1903 * @remarks No 20h scratch space required in 64-bit mode.
1904 */
1905BS3_CMN_PROTO_FARSTUB(4, uint32_t, Bs3SelProtFar16DataToFlat,(uint32_t uFar1616));
1906
1907/**
1908 * Converts a far 16:16 real mode address to a flat address.
1909 *
1910 * @returns 32-bit flat address.
1911 * @param uFar1616 Far real mode address (high 16-bit is segment, low
1912 * is offset).
1913 * @remarks All register are preserved, except return.
1914 * @remarks No 20h scratch space required in 64-bit mode.
1915 */
1916BS3_CMN_PROTO_FARSTUB(4, uint32_t, Bs3SelRealModeDataToFlat,(uint32_t uFar1616));
1917
1918/**
1919 * Gets a flat address from a working poitner.
1920 *
1921 * @returns flat address (32-bit or 64-bit).
1922 * @param pv Current context pointer.
1923 */
1924DECLINLINE(RTCCUINTXREG) Bs3SelPtrToFlat(void BS3_FAR *pv)
1925{
1926#if ARCH_BITS == 16
1927 return BS3_CMN_FN_NM(Bs3SelFar32ToFlat32)(BS3_FP_OFF(pv), BS3_FP_SEG(pv));
1928#else
1929 return (uintptr_t)pv;
1930#endif
1931}
1932
1933/**
1934 * Sets up a 16-bit read-write data selector with ring-3 access and 64KB limit.
1935 *
1936 * @param pDesc Pointer to the descriptor table entry.
1937 * @param uBaseAddr The base address of the descriptor.
1938 */
1939BS3_CMN_PROTO_STUB(void, Bs3SelSetup16BitData,(X86DESC BS3_FAR *pDesc, uint32_t uBaseAddr));
1940
1941/**
1942 * Sets up a 16-bit execute-read selector with a 64KB limit.
1943 *
1944 * @param pDesc Pointer to the descriptor table entry.
1945 * @param uBaseAddr The base address of the descriptor.
1946 * @param bDpl The descriptor privilege level.
1947 */
1948BS3_CMN_PROTO_STUB(void, Bs3SelSetup16BitCode,(X86DESC BS3_FAR *pDesc, uint32_t uBaseAddr, uint8_t bDpl));
1949
1950
1951/**
1952 * Slab control structure list head.
1953 *
1954 * The slabs on the list must all have the same chunk size.
1955 */
1956typedef struct BS3SLABHEAD
1957{
1958 /** Pointer to the first slab. */
1959 BS3_XPTR_MEMBER(struct BS3SLABCTL, pFirst);
1960 /** The allocation chunk size. */
1961 uint16_t cbChunk;
1962 /** Number of slabs in the list. */
1963 uint16_t cSlabs;
1964 /** Number of chunks in the list. */
1965 uint32_t cChunks;
1966 /** Number of free chunks. */
1967 uint32_t cFreeChunks;
1968} BS3SLABHEAD;
1969AssertCompileSize(BS3SLABHEAD, 16);
1970/** Pointer to a slab list head. */
1971typedef BS3SLABHEAD BS3_FAR *PBS3SLABHEAD;
1972
1973/**
1974 * Allocation slab control structure.
1975 *
1976 * This may live at the start of the slab for 4KB slabs, while in a separate
1977 * static location for the larger ones.
1978 */
1979typedef struct BS3SLABCTL
1980{
1981 /** Pointer to the next slab control structure in this list. */
1982 BS3_XPTR_MEMBER(struct BS3SLABCTL, pNext);
1983 /** Pointer to the slab list head. */
1984 BS3_XPTR_MEMBER(BS3SLABHEAD, pHead);
1985 /** The base address of the slab. */
1986 BS3_XPTR_MEMBER(uint8_t, pbStart);
1987 /** Number of chunks in this slab. */
1988 uint16_t cChunks;
1989 /** Number of currently free chunks. */
1990 uint16_t cFreeChunks;
1991 /** The chunk size. */
1992 uint16_t cbChunk;
1993 /** The shift count corresponding to cbChunk.
1994 * This is for turning a chunk number into a byte offset and vice versa. */
1995 uint16_t cChunkShift;
1996 /** Bitmap where set bits indicates allocated blocks (variable size,
1997 * multiple of 4). */
1998 uint8_t bmAllocated[4];
1999} BS3SLABCTL;
2000/** Pointer to a bs3kit slab control structure. */
2001typedef BS3SLABCTL BS3_FAR *PBS3SLABCTL;
2002
2003/** The chunks must all be in the same 16-bit segment tile. */
2004#define BS3_SLAB_ALLOC_F_SAME_TILE UINT16_C(0x0001)
2005
2006/**
2007 * Initializes a slab.
2008 *
2009 * @param pSlabCtl The slab control structure to initialize.
2010 * @param cbSlabCtl The size of the slab control structure.
2011 * @param uFlatSlabPtr The base address of the slab.
2012 * @param cbSlab The size of the slab.
2013 * @param cbChunk The chunk size.
2014 */
2015BS3_CMN_PROTO_STUB(void, Bs3SlabInit,(PBS3SLABCTL pSlabCtl, size_t cbSlabCtl, uint32_t uFlatSlabPtr,
2016 uint32_t cbSlab, uint16_t cbChunk));
2017
2018/**
2019 * Allocates one chunk from a slab.
2020 *
2021 * @returns Pointer to a chunk on success, NULL if we're out of chunks.
2022 * @param pSlabCtl The slab constrol structure to allocate from.
2023 */
2024BS3_CMN_PROTO_STUB(void BS3_FAR *, Bs3SlabAlloc,(PBS3SLABCTL pSlabCtl));
2025
2026/**
2027 * Allocates one or more chunks rom a slab.
2028 *
2029 * @returns Pointer to the request number of chunks on success, NULL if we're
2030 * out of chunks.
2031 * @param pSlabCtl The slab constrol structure to allocate from.
2032 * @param cChunks The number of contiguous chunks we want.
2033 * @param fFlags Flags, see BS3_SLAB_ALLOC_F_XXX
2034 */
2035BS3_CMN_PROTO_STUB(void BS3_FAR *, Bs3SlabAllocEx,(PBS3SLABCTL pSlabCtl, uint16_t cChunks, uint16_t fFlags));
2036
2037/**
2038 * Frees one or more chunks from a slab.
2039 *
2040 * @returns Number of chunks actually freed. When correctly used, this will
2041 * match the @a cChunks parameter, of course.
2042 * @param pSlabCtl The slab constrol structure to free from.
2043 * @param uFlatChunkPtr The flat address of the chunks to free.
2044 * @param cChunks The number of contiguous chunks to free.
2045 */
2046BS3_CMN_PROTO_STUB(uint16_t, Bs3SlabFree,(PBS3SLABCTL pSlabCtl, uint32_t uFlatChunkPtr, uint16_t cChunks));
2047
2048
2049/**
2050 * Initializes the given slab list head.
2051 *
2052 * @param pHead The slab list head.
2053 * @param cbChunk The chunk size.
2054 */
2055BS3_CMN_PROTO_STUB(void, Bs3SlabListInit,(PBS3SLABHEAD pHead, uint16_t cbChunk));
2056
2057/**
2058 * Adds an initialized slab control structure to the list.
2059 *
2060 * @param pHead The slab list head to add it to.
2061 * @param pSlabCtl The slab control structure to add.
2062 */
2063BS3_CMN_PROTO_STUB(void, Bs3SlabListAdd,(PBS3SLABHEAD pHead, PBS3SLABCTL pSlabCtl));
2064
2065/**
2066 * Allocates one chunk.
2067 *
2068 * @returns Pointer to a chunk on success, NULL if we're out of chunks.
2069 * @param pHead The slab list to allocate from.
2070 */
2071BS3_CMN_PROTO_STUB(void BS3_FAR *, Bs3SlabListAlloc,(PBS3SLABHEAD pHead));
2072
2073/**
2074 * Allocates one or more chunks.
2075 *
2076 * @returns Pointer to the request number of chunks on success, NULL if we're
2077 * out of chunks.
2078 * @param pHead The slab list to allocate from.
2079 * @param cChunks The number of contiguous chunks we want.
2080 * @param fFlags Flags, see BS3_SLAB_ALLOC_F_XXX
2081 */
2082BS3_CMN_PROTO_STUB(void BS3_FAR *, Bs3SlabListAllocEx,(PBS3SLABHEAD pHead, uint16_t cChunks, uint16_t fFlags));
2083
2084/**
2085 * Frees one or more chunks from a slab list.
2086 *
2087 * @param pHead The slab list to allocate from.
2088 * @param pvChunks Pointer to the first chunk to free.
2089 * @param cChunks The number of contiguous chunks to free.
2090 */
2091BS3_CMN_PROTO_STUB(void, Bs3SlabListFree,(PBS3SLABHEAD pHead, void BS3_FAR *pvChunks, uint16_t cChunks));
2092
2093/**
2094 * Allocation addressing constraints.
2095 */
2096typedef enum BS3MEMKIND
2097{
2098 /** Invalid zero type. */
2099 BS3MEMKIND_INVALID = 0,
2100 /** Real mode addressable memory. */
2101 BS3MEMKIND_REAL,
2102 /** Memory addressable using the 16-bit protected mode tiling. */
2103 BS3MEMKIND_TILED,
2104 /** Memory addressable using 32-bit flat addressing. */
2105 BS3MEMKIND_FLAT32,
2106 /** Memory addressable using 64-bit flat addressing. */
2107 BS3MEMKIND_FLAT64,
2108 /** End of valid types. */
2109 BS3MEMKIND_END,
2110} BS3MEMKIND;
2111
2112/**
2113 * Allocates low memory.
2114 *
2115 * @returns Pointer to a chunk on success, NULL if we're out of chunks.
2116 * @param enmKind The kind of addressing constraints imposed on the
2117 * allocation.
2118 * @param cb How much to allocate. Must be 4KB or less.
2119 */
2120BS3_CMN_PROTO_STUB(void BS3_FAR *, Bs3MemAlloc,(BS3MEMKIND enmKind, size_t cb));
2121
2122/**
2123 * Allocates zero'ed memory.
2124 *
2125 * @param enmKind The kind of addressing constraints imposed on the
2126 * allocation.
2127 * @param cb How much to allocate. Must be 4KB or less.
2128 */
2129BS3_CMN_PROTO_STUB(void BS3_FAR *, Bs3MemAllocZ,(BS3MEMKIND enmKind, size_t cb));
2130
2131/**
2132 * Frees memory.
2133 *
2134 * @returns Pointer to a chunk on success, NULL if we're out of chunks.
2135 * @param pv The memory to free (returned by #Bs3MemAlloc).
2136 * @param cb The size of the allocation.
2137 */
2138BS3_CMN_PROTO_STUB(void, Bs3MemFree,(void BS3_FAR *pv, size_t cb));
2139
2140/**
2141 * Allocates a page with non-present pages on each side.
2142 *
2143 * @returns Pointer to the usable page. NULL on failure. Use
2144 * Bs3MemGuardedTestPageFree to free the allocation.
2145 * @param enmKind The kind of addressing constraints imposed on the
2146 * allocation.
2147 */
2148BS3_CMN_PROTO_STUB(void BS3_FAR *, Bs3MemGuardedTestPageAlloc,(BS3MEMKIND enmKind));
2149
2150/**
2151 * Allocates a page with pages on each side to the @a fPte specification.
2152 *
2153 * @returns Pointer to the usable page. NULL on failure. Use
2154 * Bs3MemGuardedTestPageFree to free the allocation.
2155 * @param enmKind The kind of addressing constraints imposed on the
2156 * allocation.
2157 * @param fPte The page table entry specification for the guard pages.
2158 */
2159BS3_CMN_PROTO_STUB(void BS3_FAR *, Bs3MemGuardedTestPageAllocEx,(BS3MEMKIND enmKind, uint64_t fPte));
2160
2161/**
2162 * Frees guarded page allocated by Bs3MemGuardedTestPageAlloc or
2163 * Bs3MemGuardedTestPageAllocEx.
2164 *
2165 * @param pvGuardedPage Pointer returned by Bs3MemGuardedTestPageAlloc or
2166 * Bs3MemGuardedTestPageAllocEx. NULL is ignored.
2167 */
2168BS3_CMN_PROTO_STUB(void, Bs3MemGuardedTestPageFree,(void BS3_FAR *pvGuardedPage));
2169
2170/**
2171 * Print all heap info.
2172 */
2173BS3_CMN_PROTO_STUB(void, Bs3MemPrintInfo, (void));
2174
2175/** Highes RAM byte below 4G. */
2176extern uint32_t g_uBs3EndOfRamBelow4G;
2177
2178
2179/**
2180 * Enables the A20 gate.
2181 */
2182BS3_CMN_PROTO_NOSB(void, Bs3A20Enable,(void));
2183
2184/**
2185 * Enables the A20 gate via the keyboard controller
2186 */
2187BS3_CMN_PROTO_NOSB(void, Bs3A20EnableViaKbd,(void));
2188
2189/**
2190 * Enables the A20 gate via the PS/2 control port A.
2191 */
2192BS3_CMN_PROTO_NOSB(void, Bs3A20EnableViaPortA,(void));
2193
2194/**
2195 * Disables the A20 gate.
2196 */
2197BS3_CMN_PROTO_NOSB(void, Bs3A20Disable,(void));
2198
2199/**
2200 * Disables the A20 gate via the keyboard controller
2201 */
2202BS3_CMN_PROTO_NOSB(void, Bs3A20DisableViaKbd,(void));
2203
2204/**
2205 * Disables the A20 gate via the PS/2 control port A.
2206 */
2207BS3_CMN_PROTO_NOSB(void, Bs3A20DisableViaPortA,(void));
2208
2209
2210/**
2211 * Initializes root page tables for page protected mode (PP16, PP32).
2212 *
2213 * @returns IPRT status code.
2214 * @remarks Must not be called in real-mode!
2215 */
2216BS3_CMN_PROTO_STUB(int, Bs3PagingInitRootForPP,(void));
2217
2218/**
2219 * Initializes root page tables for PAE page protected mode (PAE16, PAE32).
2220 *
2221 * @returns IPRT status code.
2222 * @remarks The default long mode page tables depends on the PAE ones.
2223 * @remarks Must not be called in real-mode!
2224 */
2225BS3_CMN_PROTO_STUB(int, Bs3PagingInitRootForPAE,(void));
2226
2227/**
2228 * Initializes root page tables for long mode (LM16, LM32, LM64).
2229 *
2230 * @returns IPRT status code.
2231 * @remarks The default long mode page tables depends on the PAE ones.
2232 * @remarks Must not be called in real-mode!
2233 */
2234BS3_CMN_PROTO_STUB(int, Bs3PagingInitRootForLM,(void));
2235
2236/**
2237 * Modifies the page table protection of an address range.
2238 *
2239 * This only works on the lowest level of the page tables in the current mode.
2240 *
2241 * Since we generally use the largest pages available when setting up the
2242 * initial page tables, this function will usually have to allocate and create
2243 * more tables. This may fail if we're low on memory.
2244 *
2245 * @returns IPRT status code.
2246 * @param uFlat The flat address of the first page in the range (rounded
2247 * down nearest page boundrary).
2248 * @param cb The range size from @a pv (rounded up to nearest page boundrary).
2249 * @param fSet Mask of zero or more X86_PTE_XXX values to set for the range.
2250 * @param fClear Mask of zero or more X86_PTE_XXX values to clear for the range.
2251 */
2252BS3_CMN_PROTO_STUB(int, Bs3PagingProtect,(uint64_t uFlat, uint64_t cb, uint64_t fSet, uint64_t fClear));
2253
2254/**
2255 * Modifies the page table protection of an address range.
2256 *
2257 * This only works on the lowest level of the page tables in the current mode.
2258 *
2259 * Since we generally use the largest pages available when setting up the
2260 * initial page tables, this function will usually have to allocate and create
2261 * more tables. This may fail if we're low on memory.
2262 *
2263 * @returns IPRT status code.
2264 * @param pv The address of the first page in the range (rounded
2265 * down nearest page boundrary).
2266 * @param cb The range size from @a pv (rounded up to nearest page boundrary).
2267 * @param fSet Mask of zero or more X86_PTE_XXX values to set for the range.
2268 * @param fClear Mask of zero or more X86_PTE_XXX values to clear for the range.
2269 */
2270BS3_CMN_PROTO_STUB(int, Bs3PagingProtectPtr,(void BS3_FAR *pv, size_t cb, uint64_t fSet, uint64_t fClear));
2271
2272/**
2273 * Aliases (maps) one or more contiguous physical pages to a virtual range.
2274 *
2275 * @returns VBox status code.
2276 * @retval VERR_INVALID_PARAMETER if we're in legacy paging mode and @a uDst or
2277 * @a uPhysToAlias are not compatible with legacy paging.
2278 * @retval VERR_OUT_OF_RANGE if we cannot traverse the page tables in this mode
2279 * (typically real mode or v86, maybe 16-bit PE).
2280 * @retval VERR_NO_MEMORY if we cannot allocate page tables for splitting up
2281 * the necessary large pages. No aliasing was performed.
2282 *
2283 * @param uDst The virtual address to map it at. Rounded down
2284 * to the nearest page (@a cbHowMuch is adjusted
2285 * up).
2286 * @param uPhysToAlias The physical address of the first page in the
2287 * (contiguous) range to map. Chopped down to
2288 * nearest page boundrary (@a cbHowMuch is not
2289 * adjusted).
2290 * @param cbHowMuch How much to map. Rounded up to nearest page.
2291 * @param fPte The PTE flags.
2292 */
2293BS3_CMN_PROTO_STUB(int, Bs3PagingAlias,(uint64_t uDst, uint64_t uPhysToAlias, uint32_t cbHowMuch, uint64_t fPte));
2294
2295/**
2296 * Unaliases memory, i.e. restores the 1:1 mapping.
2297 *
2298 * @returns VBox status code. Cannot fail if @a uDst and @a cbHowMuch specify
2299 * the range of a successful Bs3PagingAlias call, however it may run
2300 * out of memory if it's breaking new ground.
2301 *
2302 * @param uDst The virtual address to restore to 1:1 mapping.
2303 * Rounded down to the nearest page (@a cbHowMuch
2304 * is adjusted up).
2305 * @param cbHowMuch How much to restore. Rounded up to nearest page.
2306 */
2307BS3_CMN_PROTO_STUB(int, Bs3PagingUnalias,(uint64_t uDst, uint32_t cbHowMuch));
2308
2309/**
2310 * Get the pointer to the PTE for the given address.
2311 *
2312 * @returns Pointer to the PTE.
2313 * @param uFlat The flat address of the page which PTE we want.
2314 * @param prc Where to return additional error info. Optional.
2315 */
2316BS3_CMN_PROTO_STUB(void BS3_FAR *, Bs3PagingGetPte,(uint64_t uFlat, int *prc));
2317
2318/**
2319 * Paging information for an address.
2320 */
2321typedef struct BS3PAGINGINFO4ADDR
2322{
2323 /** The depth of the system's paging mode.
2324 * This is always 2 for legacy, 3 for PAE and 4 for long mode. */
2325 uint8_t cEntries;
2326 /** The size of the page structures (the entires). */
2327 uint8_t cbEntry;
2328 /** Flags defined for future fun, currently zero. */
2329 uint16_t fFlags;
2330 /** Union display different view on the entry pointers. */
2331 union
2332 {
2333 /** Pointer to the page structure entries, starting with the PTE as 0.
2334 * If large pages are involved, the first entry will be NULL (first two if 1GB
2335 * page). Same if the address is invalid on a higher level. */
2336 uint8_t BS3_FAR *apbEntries[4];
2337 /** Alternative view for legacy mode. */
2338 struct
2339 {
2340 X86PTE BS3_FAR *pPte;
2341 X86PDE BS3_FAR *pPde;
2342 void *pvUnused2;
2343 void *pvUnused3;
2344 } Legacy;
2345 /** Alternative view for PAE and Long mode. */
2346 struct
2347 {
2348 X86PTEPAE BS3_FAR *pPte;
2349 X86PDEPAE BS3_FAR *pPde;
2350 X86PDPE BS3_FAR *pPdpe;
2351 X86PML4E BS3_FAR *pPml4e;
2352 } Pae;
2353 } u;
2354} BS3PAGINGINFO4ADDR;
2355/** Pointer to paging information for and address. */
2356typedef BS3PAGINGINFO4ADDR BS3_FAR *PBS3PAGINGINFO4ADDR;
2357
2358/**
2359 * Queries paging information about the given virtual address.
2360 *
2361 * @returns VBox status code.
2362 * @param uFlat The flat address to query information about.
2363 * @param pPgInfo Where to return the information.
2364 */
2365BS3_CMN_PROTO_STUB(int, Bs3PagingQueryAddressInfo,(uint64_t uFlat, PBS3PAGINGINFO4ADDR pPgInfo));
2366
2367
2368/** The physical / flat address of the buffer backing the canonical traps.
2369 * This buffer is spread equally on each side of the 64-bit non-canonical
2370 * address divide. Non-64-bit code can use this to setup trick shots and
2371 * inspect their results. */
2372extern uint32_t g_uBs3PagingCanonicalTrapsAddr;
2373/** The size of the buffer at g_uPagingCanonicalTraps (both sides). */
2374extern uint16_t g_cbBs3PagingCanonicalTraps;
2375/** The size of one trap buffer (low or high).
2376 * This is g_cbBs3PagingCanonicalTraps divided by two. */
2377extern uint16_t g_cbBs3PagingOneCanonicalTrap;
2378
2379/**
2380 * Sets up the 64-bit canonical address space trap buffers, if neceessary.
2381 *
2382 * @returns Pointer to the buffers (i.e. the first page of the low one) on
2383 * success. NULL on failure.
2384 */
2385BS3_CMN_PROTO_STUB(void BS3_FAR *, Bs3PagingSetupCanonicalTraps,(void));
2386
2387/**
2388 * Waits for the keyboard controller to become ready.
2389 */
2390BS3_CMN_PROTO_NOSB(void, Bs3KbdWait,(void));
2391
2392/**
2393 * Sends a read command to the keyboard controller and gets the result.
2394 *
2395 * The caller is responsible for making sure the keyboard controller is ready
2396 * for a command (call #Bs3KbdWait if unsure).
2397 *
2398 * @returns The value read is returned (in al).
2399 * @param bCmd The read command.
2400 */
2401BS3_CMN_PROTO_NOSB(uint8_t, Bs3KbdRead,(uint8_t bCmd));
2402
2403/**
2404 * Sends a write command to the keyboard controller and then sends the data.
2405 *
2406 * The caller is responsible for making sure the keyboard controller is ready
2407 * for a command (call #Bs3KbdWait if unsure).
2408 *
2409 * @param bCmd The write command.
2410 * @param bData The data to write.
2411 */
2412BS3_CMN_PROTO_NOSB(void, Bs3KbdWrite,(uint8_t bCmd, uint8_t bData));
2413
2414
2415/**
2416 * Configures the PIC, once only.
2417 *
2418 * Subsequent calls to this function will not do anything.
2419 *
2420 * The PIC will be programmed to use IDT/IVT vectors 0x70 thru 0x7f, auto
2421 * end-of-interrupt, and all IRQs masked. The individual PIC users will have to
2422 * use #Bs3PicUpdateMask unmask their IRQ once they've got all the handlers
2423 * installed.
2424 */
2425BS3_CMN_PROTO_STUB(void, Bs3PicSetup,(void));
2426
2427/**
2428 * Updates the PIC masks.
2429 *
2430 * @returns The new mask - master in low, slave in high byte.
2431 * @param fAndMask Things to keep as-is. Master in low, slave in high byte.
2432 * @param fOrMask Things to start masking. Ditto wrt bytes.
2433 */
2434BS3_CMN_PROTO_STUB(uint16_t, Bs3PicUpdateMask,(uint16_t fAndMask, uint16_t fOrMask));
2435
2436/**
2437 * Disables all IRQs on the PIC.
2438 */
2439BS3_CMN_PROTO_STUB(void, Bs3PicMaskAll,(void));
2440
2441
2442/**
2443 * Sets up the PIT for periodic callback.
2444 *
2445 * @param cHzDesired The desired Hz. Zero means max interval length
2446 * (18.2Hz). Plase check the various PIT globals for
2447 * the actual interval length.
2448 */
2449BS3_CMN_PROTO_STUB(void, Bs3PitSetupAndEnablePeriodTimer,(uint16_t cHzDesired));
2450
2451/**
2452 * Disables the PIT if active.
2453 */
2454BS3_CMN_PROTO_STUB(void, Bs3PitDisable,(void));
2455
2456/** Nano seconds (approx) since last the PIT timer was started. */
2457extern uint64_t volatile g_cBs3PitNs;
2458/** Milliseconds seconds (very approx) since last the PIT timer was started. */
2459extern uint64_t volatile g_cBs3PitMs;
2460/** Number of ticks since last the PIT timer was started. */
2461extern uint32_t volatile g_cBs3PitTicks;
2462/** The current interval in nanon seconds. */
2463extern uint32_t g_cBs3PitIntervalNs;
2464/** The current interval in milliseconds (approximately).
2465 * This is 0 if not yet started (used for checking the state internally). */
2466extern uint16_t volatile g_cBs3PitIntervalMs;
2467/** The current PIT frequency (approximately). 0 if not yet started. */
2468extern uint16_t g_cBs3PitIntervalHz;
2469
2470
2471/**
2472 * Call 16-bit prot mode function from v8086 mode.
2473 *
2474 * This switches from v8086 mode to 16-bit protected mode (code) and executed
2475 * @a fpfnCall with @a cbParams bytes of parameters pushed on the stack.
2476 * Afterwards it switches back to v8086 mode and returns a 16-bit status code.
2477 *
2478 * @returns 16-bit status code if the function returned anything.
2479 * @param fpfnCall Far real mode pointer to the function to call.
2480 * @param cbParams The size of the parameter list, in bytes.
2481 * @param ... The parameters.
2482 * @sa Bs3SwitchTo32BitAndCallC
2483 */
2484BS3_CMN_PROTO_STUB(int, Bs3SwitchFromV86To16BitAndCallC,(FPFNBS3FAR fpfnCall, unsigned cbParams, ...));
2485
2486
2487/**
2488 * BS3 integer register.
2489 */
2490typedef union BS3REG
2491{
2492 /** 8-bit unsigned integer. */
2493 uint8_t u8;
2494 /** 16-bit unsigned integer. */
2495 uint16_t u16;
2496 /** 32-bit unsigned integer. */
2497 uint32_t u32;
2498 /** 64-bit unsigned integer. */
2499 uint64_t u64;
2500 /** Full unsigned integer. */
2501 uint64_t u;
2502 /** High/low byte view. */
2503 struct
2504 {
2505 uint8_t bLo;
2506 uint8_t bHi;
2507 } b;
2508 /** 8-bit view. */
2509 uint8_t au8[8];
2510 /** 16-bit view. */
2511 uint16_t au16[4];
2512 /** 32-bit view. */
2513 uint32_t au32[2];
2514} BS3REG;
2515/** Pointer to an integer register. */
2516typedef BS3REG BS3_FAR *PBS3REG;
2517/** Pointer to a const integer register. */
2518typedef BS3REG const BS3_FAR *PCBS3REG;
2519
2520/**
2521 * Register context (without FPU).
2522 */
2523typedef struct BS3REGCTX
2524{
2525 BS3REG rax; /**< 0x00 */
2526 BS3REG rcx; /**< 0x08 */
2527 BS3REG rdx; /**< 0x10 */
2528 BS3REG rbx; /**< 0x18 */
2529 BS3REG rsp; /**< 0x20 */
2530 BS3REG rbp; /**< 0x28 */
2531 BS3REG rsi; /**< 0x30 */
2532 BS3REG rdi; /**< 0x38 */
2533 BS3REG r8; /**< 0x40 */
2534 BS3REG r9; /**< 0x48 */
2535 BS3REG r10; /**< 0x50 */
2536 BS3REG r11; /**< 0x58 */
2537 BS3REG r12; /**< 0x60 */
2538 BS3REG r13; /**< 0x68 */
2539 BS3REG r14; /**< 0x70 */
2540 BS3REG r15; /**< 0x78 */
2541 BS3REG rflags; /**< 0x80 */
2542 BS3REG rip; /**< 0x88 */
2543 uint16_t cs; /**< 0x90 */
2544 uint16_t ds; /**< 0x92 */
2545 uint16_t es; /**< 0x94 */
2546 uint16_t fs; /**< 0x96 */
2547 uint16_t gs; /**< 0x98 */
2548 uint16_t ss; /**< 0x9a */
2549 uint16_t tr; /**< 0x9c */
2550 uint16_t ldtr; /**< 0x9e */
2551 uint8_t bMode; /**< 0xa0: BS3_MODE_XXX. */
2552 uint8_t bCpl; /**< 0xa1: 0-3, 0 is used for real mode. */
2553 uint8_t fbFlags; /**< 0xa2: BS3REG_CTX_F_XXX */
2554 uint8_t abPadding[5]; /**< 0xa3 */
2555 BS3REG cr0; /**< 0xa8 */
2556 BS3REG cr2; /**< 0xb0 */
2557 BS3REG cr3; /**< 0xb8 */
2558 BS3REG cr4; /**< 0xc0 */
2559 uint64_t uUnused; /**< 0xc8 */
2560} BS3REGCTX;
2561AssertCompileSize(BS3REGCTX, 0xd0);
2562/** Pointer to a register context. */
2563typedef BS3REGCTX BS3_FAR *PBS3REGCTX;
2564/** Pointer to a const register context. */
2565typedef BS3REGCTX const BS3_FAR *PCBS3REGCTX;
2566
2567/** @name BS3REG_CTX_F_XXX - BS3REGCTX::fbFlags masks.
2568 * @{ */
2569/** The CR0 is MSW (only low 16-bit). */
2570#define BS3REG_CTX_F_NO_CR0_IS_MSW UINT8_C(0x01)
2571/** No CR2 and CR3 values. Not in CPL 0 or CPU too old for CR2 & CR3. */
2572#define BS3REG_CTX_F_NO_CR2_CR3 UINT8_C(0x02)
2573/** No CR4 value. The CPU is too old for CR4. */
2574#define BS3REG_CTX_F_NO_CR4 UINT8_C(0x04)
2575/** No TR and LDTR values. Context gathered in real mode or v8086 mode. */
2576#define BS3REG_CTX_F_NO_TR_LDTR UINT8_C(0x08)
2577/** The context doesn't have valid values for AMD64 GPR extensions. */
2578#define BS3REG_CTX_F_NO_AMD64 UINT8_C(0x10)
2579/** @} */
2580
2581/**
2582 * Saves the current register context.
2583 *
2584 * @param pRegCtx Where to store the register context.
2585 */
2586BS3_CMN_PROTO_NOSB(void, Bs3RegCtxSave,(PBS3REGCTX pRegCtx));
2587
2588/**
2589 * Switch to the specified CPU bitcount, reserve additional stack and save the
2590 * CPU context.
2591 *
2592 * This is for writing more flexible test drivers that can test more than the
2593 * CPU bitcount (16-bit, 32-bit, 64-bit, and virtual 8086) of the driver itself.
2594 * For instance a 32-bit driver can do V86 and 16-bit testing, thus saving more
2595 * precious and problematic 16-bit code.
2596 *
2597 * @param pRegCtx Where to store the register context.
2598 * @param bBitMode Bit mode to switch to, BS3_MODE_CODE_XXX. Only
2599 * BS3_MODE_CODE_MASK is used, other bits are ignored
2600 * to make it possible to pass a full mode value.
2601 * @param cbExtraStack Number of bytes of additional stack to allocate.
2602 */
2603BS3_CMN_PROTO_FARSTUB(8, void, Bs3RegCtxSaveEx,(PBS3REGCTX pRegCtx, uint8_t bBitMode, uint16_t cbExtraStack));
2604
2605/**
2606 * Transforms a register context to a different ring.
2607 *
2608 * @param pRegCtx The register context.
2609 * @param bRing The target ring (0..3).
2610 */
2611BS3_CMN_PROTO_STUB(void, Bs3RegCtxConvertToRingX,(PBS3REGCTX pRegCtx, uint8_t bRing));
2612
2613/**
2614 * Restores a register context.
2615 *
2616 * @param pRegCtx The register context to be restored and resumed.
2617 * @param fFlags BS3REGCTXRESTORE_F_XXX.
2618 *
2619 * @remarks Will switch to ring-0.
2620 * @remarks Does not return.
2621 */
2622BS3_CMN_PROTO_NOSB(DECL_NO_RETURN(void), Bs3RegCtxRestore,(PCBS3REGCTX pRegCtx, uint16_t fFlags));
2623#if !defined(BS3_KIT_WITH_NO_RETURN) && defined(__WATCOMC__)
2624# pragma aux Bs3RegCtxRestore_c16 "_Bs3RegCtxRestore_aborts_c16" __aborts
2625# pragma aux Bs3RegCtxRestore_f16 "_Bs3RegCtxRestore_aborts_f16" __aborts
2626# pragma aux Bs3RegCtxRestore_c32 "_Bs3RegCtxRestore_aborts_c32" __aborts
2627#endif
2628
2629/** @name Flags for Bs3RegCtxRestore
2630 * @{ */
2631/** Skip restoring the CRx registers. */
2632#define BS3REGCTXRESTORE_F_SKIP_CRX UINT16_C(0x0001)
2633/** Sets g_fBs3TrapNoV86Assist. */
2634#define BS3REGCTXRESTORE_F_NO_V86_ASSIST UINT16_C(0x0002)
2635/** @} */
2636
2637/**
2638 * Prints the register context.
2639 *
2640 * @param pRegCtx The register context to be printed.
2641 */
2642BS3_CMN_PROTO_STUB(void, Bs3RegCtxPrint,(PCBS3REGCTX pRegCtx));
2643
2644/**
2645 * Sets a GPR and segment register to point at the same location as @a uFlat.
2646 *
2647 * @param pRegCtx The register context.
2648 * @param pGpr The general purpose register to set (points within
2649 * @a pRegCtx).
2650 * @param pSel The selector register (points within @a pRegCtx).
2651 * @param uFlat Flat location address.
2652 */
2653BS3_CMN_PROTO_STUB(void, Bs3RegCtxSetGrpSegFromFlat,(PBS3REGCTX pRegCtx, PBS3REG pGpr, PRTSEL pSel, RTCCUINTXREG uFlat));
2654
2655/**
2656 * Sets a GPR and segment register to point at the same location as @a ovPtr.
2657 *
2658 * @param pRegCtx The register context.
2659 * @param pGpr The general purpose register to set (points within
2660 * @a pRegCtx).
2661 * @param pSel The selector register (points within @a pRegCtx).
2662 * @param pvPtr Current context pointer.
2663 */
2664BS3_CMN_PROTO_STUB(void, Bs3RegCtxSetGrpSegFromCurPtr,(PBS3REGCTX pRegCtx, PBS3REG pGpr, PRTSEL pSel, void BS3_FAR *pvPtr));
2665
2666/**
2667 * Sets a GPR and DS to point at the same location as @a ovPtr.
2668 *
2669 * @param pRegCtx The register context.
2670 * @param pGpr The general purpose register to set (points within
2671 * @a pRegCtx).
2672 * @param pvPtr Current context pointer.
2673 */
2674BS3_CMN_PROTO_STUB(void, Bs3RegCtxSetGrpDsFromCurPtr,(PBS3REGCTX pRegCtx, PBS3REG pGpr, void BS3_FAR *pvPtr));
2675
2676/**
2677 * Sets CS:RIP to point at the same piece of code as @a uFlatCode.
2678 *
2679 * @param pRegCtx The register context.
2680 * @param uFlatCode Flat code pointer
2681 * @sa Bs3RegCtxSetRipCsFromLnkPtr, Bs3RegCtxSetRipCsFromCurPtr
2682 */
2683BS3_CMN_PROTO_STUB(void, Bs3RegCtxSetRipCsFromFlat,(PBS3REGCTX pRegCtx, RTCCUINTXREG uFlatCode));
2684
2685/**
2686 * Sets CS:RIP to point at the same piece of code as @a pfnCode.
2687 *
2688 * The 16-bit edition of this function expects a far 16:16 address as written by
2689 * the linker (i.e. real mode).
2690 *
2691 * @param pRegCtx The register context.
2692 * @param pfnCode Pointer to the code. In 32-bit and 64-bit mode this is a
2693 * flat address, while in 16-bit it's a far 16:16 address
2694 * as fixed up by the linker (real mode selector). This
2695 * address is converted to match the mode of the context.
2696 * @sa Bs3RegCtxSetRipCsFromCurPtr, Bs3RegCtxSetRipCsFromFlat
2697 */
2698BS3_CMN_PROTO_STUB(void, Bs3RegCtxSetRipCsFromLnkPtr,(PBS3REGCTX pRegCtx, FPFNBS3FAR pfnCode));
2699
2700/**
2701 * Sets CS:RIP to point at the same piece of code as @a pfnCode.
2702 *
2703 * @param pRegCtx The register context.
2704 * @param pfnCode Pointer to the code. Current mode pointer.
2705 * @sa Bs3RegCtxSetRipCsFromLnkPtr, Bs3RegCtxSetRipCsFromFlat
2706 */
2707BS3_CMN_PROTO_STUB(void, Bs3RegCtxSetRipCsFromCurPtr,(PBS3REGCTX pRegCtx, FPFNBS3FAR pfnCode));
2708
2709
2710/**
2711 * The method to be used to save and restore the extended context.
2712 */
2713typedef enum BS3EXTCTXMETHOD
2714{
2715 BS3EXTCTXMETHOD_INVALID = 0,
2716 BS3EXTCTXMETHOD_ANCIENT, /**< Ancient fnsave/frstor format. */
2717 BS3EXTCTXMETHOD_FXSAVE, /**< fxsave/fxrstor format. */
2718 BS3EXTCTXMETHOD_XSAVE, /**< xsave/xrstor format. */
2719 BS3EXTCTXMETHOD_END,
2720} BS3EXTCTXMETHOD;
2721
2722
2723/**
2724 * Extended CPU context (FPU, SSE, AVX, ++).
2725 *
2726 * @remarks Also in bs3kit.inc
2727 */
2728typedef struct BS3EXTCTX
2729{
2730 /** Dummy/magic value. */
2731 uint16_t u16Magic;
2732 /** The size of the structure. */
2733 uint16_t cb;
2734 /** The method used to save and restore the context (BS3EXTCTXMETHOD). */
2735 uint8_t enmMethod;
2736 uint8_t abPadding0[3];
2737 /** Nominal XSAVE_C_XXX. */
2738 uint64_t fXcr0Nominal;
2739 /** The saved XCR0 mask (restored after xrstor). */
2740 uint64_t fXcr0Saved;
2741
2742 /** Explicit alignment padding. */
2743 uint8_t abPadding[64 - 2 - 2 - 1 - 3 - 8 - 8];
2744
2745 /** The context, variable size (see above).
2746 * This must be aligned on a 64 byte boundrary. */
2747 union
2748 {
2749 /** fnsave/frstor. */
2750 X86FPUSTATE Ancient;
2751 /** fxsave/fxrstor */
2752 X86FXSTATE x87;
2753 /** xsave/xrstor */
2754 X86XSAVEAREA x;
2755 /** Byte array view. */
2756 uint8_t ab[sizeof(X86XSAVEAREA)];
2757 } Ctx;
2758} BS3EXTCTX;
2759AssertCompileMemberAlignment(BS3EXTCTX, Ctx, 64);
2760/** Pointer to an extended CPU context. */
2761typedef BS3EXTCTX BS3_FAR *PBS3EXTCTX;
2762/** Pointer to a const extended CPU context. */
2763typedef BS3EXTCTX const BS3_FAR *PCBS3EXTCTX;
2764
2765/** Magic value for BS3EXTCTX. */
2766#define BS3EXTCTX_MAGIC UINT16_C(0x1980)
2767
2768/**
2769 * Allocates and initializes the extended CPU context structure.
2770 *
2771 * @returns The new extended CPU context structure.
2772 * @param enmKind The kind of allocation to make.
2773 */
2774BS3_CMN_PROTO_STUB(PBS3EXTCTX, Bs3ExtCtxAlloc,(BS3MEMKIND enmKind));
2775
2776/**
2777 * Frees an extended CPU context structure.
2778 *
2779 * @param pExtCtx The extended CPU context (returned by
2780 * Bs3ExtCtxAlloc).
2781 */
2782BS3_CMN_PROTO_STUB(void, Bs3ExtCtxFree,(PBS3EXTCTX pExtCtx));
2783
2784/**
2785 * Get the size required for a BS3EXTCTX structure.
2786 *
2787 * @returns size in bytes of the whole structure.
2788 * @param pfFlags Where to return flags for Bs3ExtCtxInit.
2789 * @note Use Bs3ExtCtxAlloc when possible.
2790 */
2791BS3_CMN_PROTO_STUB(uint16_t, Bs3ExtCtxGetSize,(uint64_t *pfFlags));
2792
2793/**
2794 * Initializes the extended CPU context structure.
2795 * @returns pExtCtx
2796 * @param pExtCtx The extended CPU context.
2797 * @param cbExtCtx The size of the @a pExtCtx allocation.
2798 * @param fFlags XSAVE_C_XXX flags.
2799 */
2800BS3_CMN_PROTO_STUB(PBS3EXTCTX, Bs3ExtCtxInit,(PBS3EXTCTX pExtCtx, uint16_t cbExtCtx, uint64_t fFlags));
2801
2802/**
2803 * Saves the extended CPU state to the given structure.
2804 *
2805 * @param pExtCtx The extended CPU context.
2806 * @remarks All GPRs preserved.
2807 */
2808BS3_CMN_PROTO_FARSTUB(4, void, Bs3ExtCtxSave,(PBS3EXTCTX pExtCtx));
2809
2810/**
2811 * Restores the extended CPU state from the given structure.
2812 *
2813 * @param pExtCtx The extended CPU context.
2814 * @remarks All GPRs preserved.
2815 */
2816BS3_CMN_PROTO_FARSTUB(4, void, Bs3ExtCtxRestore,(PBS3EXTCTX pExtCtx));
2817
2818/**
2819 * Copies the state from one context to another.
2820 *
2821 * @returns pDst
2822 * @param pDst The destination extended CPU context.
2823 * @param pSrc The source extended CPU context.
2824 */
2825BS3_CMN_PROTO_STUB(PBS3EXTCTX, Bs3ExtCtxCopy,(PBS3EXTCTX pDst, PCBS3EXTCTX pSrc));
2826
2827
2828/** @name Debug register accessors for V8086 mode (works everwhere).
2829 * @{ */
2830BS3_CMN_PROTO_NOSB(RTCCUINTXREG, Bs3RegGetDr0,(void));
2831BS3_CMN_PROTO_NOSB(RTCCUINTXREG, Bs3RegGetDr1,(void));
2832BS3_CMN_PROTO_NOSB(RTCCUINTXREG, Bs3RegGetDr2,(void));
2833BS3_CMN_PROTO_NOSB(RTCCUINTXREG, Bs3RegGetDr3,(void));
2834BS3_CMN_PROTO_NOSB(RTCCUINTXREG, Bs3RegGetDr6,(void));
2835BS3_CMN_PROTO_NOSB(RTCCUINTXREG, Bs3RegGetDr7,(void));
2836
2837BS3_CMN_PROTO_NOSB(void, Bs3RegSetDr0,(RTCCUINTXREG uValue));
2838BS3_CMN_PROTO_NOSB(void, Bs3RegSetDr1,(RTCCUINTXREG uValue));
2839BS3_CMN_PROTO_NOSB(void, Bs3RegSetDr2,(RTCCUINTXREG uValue));
2840BS3_CMN_PROTO_NOSB(void, Bs3RegSetDr3,(RTCCUINTXREG uValue));
2841BS3_CMN_PROTO_NOSB(void, Bs3RegSetDr6,(RTCCUINTXREG uValue));
2842BS3_CMN_PROTO_NOSB(void, Bs3RegSetDr7,(RTCCUINTXREG uValue));
2843
2844BS3_CMN_PROTO_NOSB(RTCCUINTXREG, Bs3RegGetDrX,(uint8_t iReg));
2845BS3_CMN_PROTO_NOSB(void, Bs3RegSetDrX,(uint8_t iReg, RTCCUINTXREG uValue));
2846/** @} */
2847
2848
2849/** @name Control register accessors for V8086 mode (works everwhere).
2850 * @{ */
2851BS3_CMN_PROTO_NOSB(RTCCUINTXREG, Bs3RegGetCr0,(void));
2852BS3_CMN_PROTO_NOSB(RTCCUINTXREG, Bs3RegGetCr2,(void));
2853BS3_CMN_PROTO_NOSB(RTCCUINTXREG, Bs3RegGetCr3,(void));
2854BS3_CMN_PROTO_NOSB(RTCCUINTXREG, Bs3RegGetCr4,(void));
2855BS3_CMN_PROTO_NOSB(uint16_t, Bs3RegGetTr,(void));
2856BS3_CMN_PROTO_NOSB(uint16_t, Bs3RegGetLdtr,(void));
2857
2858BS3_CMN_PROTO_NOSB(void, Bs3RegSetCr0,(RTCCUINTXREG uValue));
2859BS3_CMN_PROTO_NOSB(void, Bs3RegSetCr2,(RTCCUINTXREG uValue));
2860BS3_CMN_PROTO_NOSB(void, Bs3RegSetCr3,(RTCCUINTXREG uValue));
2861BS3_CMN_PROTO_NOSB(void, Bs3RegSetCr4,(RTCCUINTXREG uValue));
2862BS3_CMN_PROTO_NOSB(void, Bs3RegSetTr,(uint16_t uValue));
2863BS3_CMN_PROTO_NOSB(void, Bs3RegSetLdtr,(uint16_t uValue));
2864/** @} */
2865
2866
2867/**
2868 * Trap frame.
2869 */
2870typedef struct BS3TRAPFRAME
2871{
2872 /** 0x00: Exception/interrupt number. */
2873 uint8_t bXcpt;
2874 /** 0x01: The size of the IRET frame. */
2875 uint8_t cbIretFrame;
2876 /** 0x02: The handler CS. */
2877 uint16_t uHandlerCs;
2878 /** 0x04: The handler SS. */
2879 uint16_t uHandlerSs;
2880 /** 0x06: Explicit alignment. */
2881 uint16_t usAlignment;
2882 /** 0x08: The handler RSP (pointer to the iret frame, skipping ErrCd). */
2883 uint64_t uHandlerRsp;
2884 /** 0x10: The handler RFLAGS value. */
2885 uint64_t fHandlerRfl;
2886 /** 0x18: The error code (if applicable). */
2887 uint64_t uErrCd;
2888 /** 0x20: The register context. */
2889 BS3REGCTX Ctx;
2890} BS3TRAPFRAME;
2891AssertCompileSize(BS3TRAPFRAME, 0x20 + 0xd0);
2892/** Pointer to a trap frame. */
2893typedef BS3TRAPFRAME BS3_FAR *PBS3TRAPFRAME;
2894/** Pointer to a const trap frame. */
2895typedef BS3TRAPFRAME const BS3_FAR *PCBS3TRAPFRAME;
2896
2897
2898/**
2899 * Re-initializes the trap handling for the current mode.
2900 *
2901 * Useful after a test that messes with the IDT/IVT.
2902 *
2903 * @sa Bs3TrapInit
2904 */
2905BS3_CMN_PROTO_STUB(void, Bs3TrapReInit,(void));
2906
2907/**
2908 * Initializes real mode and v8086 trap handling.
2909 *
2910 * @remarks Does not install RM/V86 trap handling, just initializes the
2911 * structures.
2912 */
2913BS3_CMN_PROTO_STUB(void, Bs3TrapRmV86Init,(void));
2914
2915/**
2916 * Initializes real mode and v8086 trap handling, extended version.
2917 *
2918 * @param f386Plus Set if the CPU is 80386 or later and
2919 * extended registers should be saved. Once initialized
2920 * with this parameter set to @a true, the effect cannot be
2921 * reversed.
2922 *
2923 * @remarks Does not install RM/V86 trap handling, just initializes the
2924 * structures.
2925 */
2926BS3_CMN_PROTO_STUB(void, Bs3TrapRmV86InitEx,(bool f386Plus));
2927
2928/**
2929 * Initializes 16-bit (protected mode) trap handling.
2930 *
2931 * @remarks Does not install 16-bit trap handling, just initializes the
2932 * structures.
2933 */
2934BS3_CMN_PROTO_STUB(void, Bs3Trap16Init,(void));
2935
2936/**
2937 * Initializes 16-bit (protected mode) trap handling, extended version.
2938 *
2939 * @param f386Plus Set if the CPU is 80386 or later and
2940 * extended registers should be saved. Once initialized
2941 * with this parameter set to @a true, the effect cannot be
2942 * reversed.
2943 *
2944 * @remarks Does not install 16-bit trap handling, just initializes the
2945 * structures.
2946 */
2947BS3_CMN_PROTO_STUB(void, Bs3Trap16InitEx,(bool f386Plus));
2948
2949/**
2950 * Initializes 32-bit trap handling.
2951 *
2952 * @remarks Does not install 32-bit trap handling, just initializes the
2953 * structures.
2954 */
2955BS3_CMN_PROTO_STUB(void, Bs3Trap32Init,(void));
2956
2957/**
2958 * Initializes 64-bit trap handling
2959 *
2960 * @remarks Does not install 64-bit trap handling, just initializes the
2961 * structures.
2962 */
2963BS3_CMN_PROTO_STUB(void, Bs3Trap64Init,(void));
2964
2965/**
2966 * Modifies the real-mode / V86 IVT entry specified by @a iIvt.
2967 *
2968 * @param iIvt The index of the IDT entry to set.
2969 * @param uSeg The handler real-mode segment.
2970 * @param off The handler offset.
2971 */
2972BS3_CMN_PROTO_STUB(void, Bs3TrapRmV86SetGate,(uint8_t iIvt, uint16_t uSeg, uint16_t off));
2973
2974/**
2975 * Modifies the 16-bit IDT entry (protected mode) specified by @a iIdt.
2976 *
2977 * @param iIdt The index of the IDT entry to set.
2978 * @param bType The gate type (X86_SEL_TYPE_SYS_XXX).
2979 * @param bDpl The DPL.
2980 * @param uSel The handler selector.
2981 * @param off The handler offset (if applicable).
2982 * @param cParams The parameter count (for call gates).
2983 */
2984BS3_CMN_PROTO_STUB(void, Bs3Trap16SetGate,(uint8_t iIdt, uint8_t bType, uint8_t bDpl,
2985 uint16_t uSel, uint16_t off, uint8_t cParams));
2986
2987/** The address of Bs3Trap16GenericEntries.
2988 * Bs3Trap16GenericEntries is an array of interrupt/trap/whatever entry
2989 * points, 8 bytes each, that will create a register frame and call the generic
2990 * C compatible trap handlers. */
2991extern uint32_t g_Bs3Trap16GenericEntriesFlatAddr;
2992
2993/**
2994 * Modifies the 32-bit IDT entry specified by @a iIdt.
2995 *
2996 * @param iIdt The index of the IDT entry to set.
2997 * @param bType The gate type (X86_SEL_TYPE_SYS_XXX).
2998 * @param bDpl The DPL.
2999 * @param uSel The handler selector.
3000 * @param off The handler offset (if applicable).
3001 * @param cParams The parameter count (for call gates).
3002 */
3003BS3_CMN_PROTO_STUB(void, Bs3Trap32SetGate,(uint8_t iIdt, uint8_t bType, uint8_t bDpl,
3004 uint16_t uSel, uint32_t off, uint8_t cParams));
3005
3006/** The address of Bs3Trap32GenericEntries.
3007 * Bs3Trap32GenericEntries is an array of interrupt/trap/whatever entry
3008 * points, 10 bytes each, that will create a register frame and call the generic
3009 * C compatible trap handlers. */
3010extern uint32_t g_Bs3Trap32GenericEntriesFlatAddr;
3011
3012/**
3013 * Modifies the 64-bit IDT entry specified by @a iIdt.
3014 *
3015 * @param iIdt The index of the IDT entry to set.
3016 * @param bType The gate type (X86_SEL_TYPE_SYS_XXX).
3017 * @param bDpl The DPL.
3018 * @param uSel The handler selector.
3019 * @param off The handler offset (if applicable).
3020 * @param bIst The interrupt stack to use.
3021 */
3022BS3_CMN_PROTO_STUB(void, Bs3Trap64SetGate,(uint8_t iIdt, uint8_t bType, uint8_t bDpl, uint16_t uSel, uint64_t off, uint8_t bIst));
3023
3024/** The address of Bs3Trap64GenericEntries.
3025 * Bs3Trap64GenericEntries is an array of interrupt/trap/whatever entry
3026 * points, 8 bytes each, that will create a register frame and call the generic
3027 * C compatible trap handlers. */
3028extern uint32_t g_Bs3Trap64GenericEntriesFlatAddr;
3029
3030/**
3031 * Adjusts the DPL the IDT entry specified by @a iIdt.
3032 *
3033 * The change is applied to the 16-bit, 32-bit and 64-bit IDTs.
3034 *
3035 * @returns Old DPL (from 64-bit IDT).
3036 * @param iIdt The index of the IDT and IVT entry to set.
3037 * @param bDpl The DPL.
3038 */
3039BS3_CMN_PROTO_STUB(uint8_t, Bs3TrapSetDpl,(uint8_t iIdt, uint8_t bDpl));
3040
3041/**
3042 * C-style trap handler.
3043 *
3044 * The caller will resume the context in @a pTrapFrame upon return.
3045 *
3046 * @param pTrapFrame The trap frame. Registers can be modified.
3047 * @note The 16-bit versions must be in CGROUP16!
3048 */
3049typedef BS3_DECL_NEAR_CALLBACK(void) FNBS3TRAPHANDLER(PBS3TRAPFRAME pTrapFrame);
3050/** Pointer to a trap handler (current template context). */
3051typedef FNBS3TRAPHANDLER *PFNBS3TRAPHANDLER;
3052
3053#if ARCH_BITS == 16
3054/** @copydoc FNBS3TRAPHANDLER */
3055typedef FNBS3FAR FNBS3TRAPHANDLER32;
3056/** @copydoc FNBS3TRAPHANDLER */
3057typedef FNBS3FAR FNBS3TRAPHANDLER64;
3058#else
3059/** @copydoc FNBS3TRAPHANDLER */
3060typedef FNBS3TRAPHANDLER FNBS3TRAPHANDLER32;
3061/** @copydoc FNBS3TRAPHANDLER */
3062typedef FNBS3TRAPHANDLER FNBS3TRAPHANDLER64;
3063#endif
3064/** @copydoc PFNBS3TRAPHANDLER */
3065typedef FNBS3TRAPHANDLER32 *PFNBS3TRAPHANDLER32;
3066/** @copydoc PFNBS3TRAPHANDLER */
3067typedef FNBS3TRAPHANDLER64 *PFNBS3TRAPHANDLER64;
3068
3069
3070/**
3071 * C-style trap handler, near 16-bit (CGROUP16).
3072 *
3073 * The caller will resume the context in @a pTrapFrame upon return.
3074 *
3075 * @param pTrapFrame The trap frame. Registers can be modified.
3076 */
3077typedef BS3_DECL_NEAR_CALLBACK(void) FNBS3TRAPHANDLER16(PBS3TRAPFRAME pTrapFrame);
3078/** Pointer to a trap handler (current template context). */
3079typedef FNBS3TRAPHANDLER16 *PFNBS3TRAPHANDLER16;
3080
3081/**
3082 * C-style trap handler, near 16-bit (CGROUP16).
3083 *
3084 * The caller will resume the context in @a pTrapFrame upon return.
3085 *
3086 * @param pTrapFrame The trap frame. Registers can be modified.
3087 */
3088typedef BS3_DECL_CALLBACK(void) FNBS3TRAPHANDLER3264(PBS3TRAPFRAME pTrapFrame);
3089/** Pointer to a trap handler (current template context). */
3090typedef FNBS3TRAPHANDLER3264 *FPFNBS3TRAPHANDLER3264;
3091
3092
3093/**
3094 * Sets a trap handler (C/C++/assembly) for the current bitcount.
3095 *
3096 * @returns Previous handler.
3097 * @param iIdt The index of the IDT entry to set.
3098 * @param pfnHandler Pointer to the handler.
3099 * @sa Bs3TrapSetHandlerEx
3100 */
3101BS3_CMN_PROTO_STUB(PFNBS3TRAPHANDLER, Bs3TrapSetHandler,(uint8_t iIdt, PFNBS3TRAPHANDLER pfnHandler));
3102
3103/**
3104 * Sets a trap handler (C/C++/assembly) for all the bitcounts.
3105 *
3106 * @param iIdt The index of the IDT and IVT entry to set.
3107 * @param pfnHandler16 Pointer to the 16-bit handler. (Assumes linker addresses.)
3108 * @param pfnHandler32 Pointer to the 32-bit handler. (Assumes linker addresses.)
3109 * @param pfnHandler64 Pointer to the 64-bit handler. (Assumes linker addresses.)
3110 * @sa Bs3TrapSetHandler
3111 */
3112BS3_CMN_PROTO_STUB(void, Bs3TrapSetHandlerEx,(uint8_t iIdt, PFNBS3TRAPHANDLER16 pfnHandler16,
3113 PFNBS3TRAPHANDLER32 pfnHandler32, PFNBS3TRAPHANDLER64 pfnHandler64));
3114
3115/**
3116 * Default C/C++ trap handler.
3117 *
3118 * This will check trap record and panic if no match was found.
3119 *
3120 * @param pTrapFrame Trap frame of the trap to handle.
3121 */
3122BS3_CMN_PROTO_STUB(void, Bs3TrapDefaultHandler,(PBS3TRAPFRAME pTrapFrame));
3123
3124/**
3125 * Prints the trap frame (to screen).
3126 * @param pTrapFrame Trap frame to print.
3127 */
3128BS3_CMN_PROTO_STUB(void, Bs3TrapPrintFrame,(PCBS3TRAPFRAME pTrapFrame));
3129
3130/**
3131 * Sets up a long jump from a trap handler.
3132 *
3133 * The long jump will only be performed onced, but will catch any kind of trap,
3134 * fault, interrupt or irq.
3135 *
3136 * @retval true on the initial call.
3137 * @retval false on trap return.
3138 * @param pTrapFrame Where to store the trap information when
3139 * returning @c false.
3140 * @sa #Bs3TrapUnsetJmp
3141 */
3142BS3_CMN_PROTO_NOSB(DECL_RETURNS_TWICE(bool),Bs3TrapSetJmp,(PBS3TRAPFRAME pTrapFrame));
3143
3144/**
3145 * Combination of #Bs3TrapSetJmp and #Bs3RegCtxRestore.
3146 *
3147 * @param pCtxRestore The context to restore.
3148 * @param pTrapFrame Where to store the trap information.
3149 */
3150BS3_CMN_PROTO_STUB(void, Bs3TrapSetJmpAndRestore,(PCBS3REGCTX pCtxRestore, PBS3TRAPFRAME pTrapFrame));
3151
3152/**
3153 * Disables a previous #Bs3TrapSetJmp call.
3154 */
3155BS3_CMN_PROTO_STUB(void, Bs3TrapUnsetJmp,(void));
3156
3157
3158/**
3159 * The current test step.
3160 */
3161extern uint16_t g_usBs3TestStep;
3162
3163/**
3164 * Equivalent to RTTestCreate + RTTestBanner.
3165 *
3166 * @param pszTest The test name.
3167 */
3168BS3_CMN_PROTO_STUB(void, Bs3TestInit,(const char BS3_FAR *pszTest));
3169
3170
3171/**
3172 * Equivalent to RTTestSummaryAndDestroy.
3173 */
3174BS3_CMN_PROTO_STUB(void, Bs3TestTerm,(void));
3175
3176/**
3177 * Equivalent to RTTestISub.
3178 */
3179BS3_CMN_PROTO_STUB(void, Bs3TestSub,(const char BS3_FAR *pszSubTest));
3180
3181/**
3182 * Equivalent to RTTestIFailedF.
3183 */
3184BS3_CMN_PROTO_STUB(void, Bs3TestSubF,(const char BS3_FAR *pszFormat, ...));
3185
3186/**
3187 * Equivalent to RTTestISubV.
3188 */
3189BS3_CMN_PROTO_STUB(void, Bs3TestSubV,(const char BS3_FAR *pszFormat, va_list BS3_FAR va));
3190
3191/**
3192 * Equivalent to RTTestISubDone.
3193 */
3194BS3_CMN_PROTO_STUB(void, Bs3TestSubDone,(void));
3195
3196/**
3197 * Equivalent to RTTestSubErrorCount.
3198 */
3199BS3_CMN_PROTO_STUB(uint16_t, Bs3TestSubErrorCount,(void));
3200
3201/**
3202 * Equivalent to RTTestIPrintf with RTTESTLVL_ALWAYS.
3203 *
3204 * @param pszFormat What to print, format string. Explicit newline char.
3205 * @param ... String format arguments.
3206 */
3207BS3_CMN_PROTO_STUB(void, Bs3TestPrintf,(const char BS3_FAR *pszFormat, ...));
3208
3209/**
3210 * Equivalent to RTTestIPrintfV with RTTESTLVL_ALWAYS.
3211 *
3212 * @param pszFormat What to print, format string. Explicit newline char.
3213 * @param va String format arguments.
3214 */
3215BS3_CMN_PROTO_STUB(void, Bs3TestPrintfV,(const char BS3_FAR *pszFormat, va_list BS3_FAR va));
3216
3217/**
3218 * Same as Bs3TestPrintf, except no guest screen echo.
3219 *
3220 * @param pszFormat What to print, format string. Explicit newline char.
3221 * @param ... String format arguments.
3222 */
3223BS3_CMN_PROTO_STUB(void, Bs3TestHostPrintf,(const char BS3_FAR *pszFormat, ...));
3224
3225/**
3226 * Same as Bs3TestPrintfV, except no guest screen echo.
3227 *
3228 * @param pszFormat What to print, format string. Explicit newline char.
3229 * @param va String format arguments.
3230 */
3231BS3_CMN_PROTO_STUB(void, Bs3TestHostPrintfV,(const char BS3_FAR *pszFormat, va_list BS3_FAR va));
3232
3233/**
3234 * Equivalent to RTTestIFailed.
3235 * @returns false.
3236 */
3237BS3_CMN_PROTO_STUB(bool, Bs3TestFailed,(const char BS3_FAR *pszMessage));
3238
3239/**
3240 * Equivalent to RTTestIFailedF.
3241 * @returns false.
3242 */
3243BS3_CMN_PROTO_STUB(bool, Bs3TestFailedF,(const char BS3_FAR *pszFormat, ...));
3244
3245/**
3246 * Equivalent to RTTestIFailedV.
3247 * @returns false.
3248 */
3249BS3_CMN_PROTO_STUB(bool, Bs3TestFailedV,(const char BS3_FAR *pszFormat, va_list BS3_FAR va));
3250
3251/**
3252 * Equivalent to RTTestISkipped.
3253 *
3254 * @param pszWhy Optional reason why it's being skipped.
3255 */
3256BS3_CMN_PROTO_STUB(void, Bs3TestSkipped,(const char BS3_FAR *pszWhy));
3257
3258/**
3259 * Equivalent to RTTestISkippedF.
3260 *
3261 * @param pszFormat Optional reason why it's being skipped.
3262 * @param ... Format arguments.
3263 */
3264BS3_CMN_PROTO_STUB(void, Bs3TestSkippedF,(const char BS3_FAR *pszFormat, ...));
3265
3266/**
3267 * Equivalent to RTTestISkippedV.
3268 *
3269 * @param pszFormat Optional reason why it's being skipped.
3270 * @param va Format arguments.
3271 */
3272BS3_CMN_PROTO_STUB(void, Bs3TestSkippedV,(const char BS3_FAR *pszFormat, va_list BS3_FAR va));
3273
3274/**
3275 * Compares two register contexts, with PC and SP adjustments.
3276 *
3277 * Differences will be reported as test failures.
3278 *
3279 * @returns true if equal, false if not.
3280 * @param pActualCtx The actual register context.
3281 * @param pExpectedCtx Expected register context.
3282 * @param cbPcAdjust Program counter adjustment (applied to @a pExpectedCtx).
3283 * @param cbSpAdjust Stack pointer adjustment (applied to @a pExpectedCtx).
3284 * @param fExtraEfl Extra EFLAGS to OR into @a pExepctedCtx.
3285 * @param pszMode CPU mode or some other helpful text.
3286 * @param idTestStep Test step identifier.
3287 */
3288BS3_CMN_PROTO_STUB(bool, Bs3TestCheckRegCtxEx,(PCBS3REGCTX pActualCtx, PCBS3REGCTX pExpectedCtx, uint16_t cbPcAdjust,
3289 int16_t cbSpAdjust, uint32_t fExtraEfl, const char *pszMode, uint16_t idTestStep));
3290
3291/**
3292 * Performs the testing for the given mode.
3293 *
3294 * This is called with the CPU already switch to that mode.
3295 *
3296 * @returns 0 on success or directly Bs3TestFailed calls, non-zero to indicate
3297 * where the test when wrong. Special value BS3TESTDOMODE_SKIPPED
3298 * should be returned to indicate that the test has been skipped.
3299 * @param bMode The current CPU mode.
3300 */
3301typedef BS3_DECL_CALLBACK(uint8_t) FNBS3TESTDOMODE(uint8_t bMode);
3302/** Pointer (far) to a test (for 32-bit and 64-bit code, will be flatten). */
3303typedef FNBS3TESTDOMODE *PFNBS3TESTDOMODE;
3304
3305/** Special FNBS3TESTDOMODE return code for indicating a skipped mode test. */
3306#define BS3TESTDOMODE_SKIPPED UINT8_MAX
3307
3308/**
3309 * Mode sub-test entry.
3310 *
3311 * This can only be passed around to functions with the same bit count, as it
3312 * contains function pointers. In 16-bit mode, the 16-bit pointers are near and
3313 * implies BS3TEXT16, whereas the 32-bit and 64-bit pointers are far real mode
3314 * addresses that will be converted to flat address prior to calling them.
3315 * Similarly, in 32-bit and 64-bit the addresses are all flat and the 16-bit
3316 * ones will be converted to BS3TEXT16 based addresses prior to calling.
3317 */
3318typedef struct BS3TESTMODEENTRY
3319{
3320 /** The sub-test name to be passed to Bs3TestSub if not NULL. */
3321 const char * BS3_FAR pszSubTest;
3322
3323 PFNBS3TESTDOMODE pfnDoRM;
3324
3325 PFNBS3TESTDOMODE pfnDoPE16;
3326 PFNBS3TESTDOMODE pfnDoPE16_32;
3327 PFNBS3TESTDOMODE pfnDoPE16_V86;
3328 PFNBS3TESTDOMODE pfnDoPE32;
3329 PFNBS3TESTDOMODE pfnDoPE32_16;
3330 PFNBS3TESTDOMODE pfnDoPEV86;
3331
3332 PFNBS3TESTDOMODE pfnDoPP16;
3333 PFNBS3TESTDOMODE pfnDoPP16_32;
3334 PFNBS3TESTDOMODE pfnDoPP16_V86;
3335 PFNBS3TESTDOMODE pfnDoPP32;
3336 PFNBS3TESTDOMODE pfnDoPP32_16;
3337 PFNBS3TESTDOMODE pfnDoPPV86;
3338
3339 PFNBS3TESTDOMODE pfnDoPAE16;
3340 PFNBS3TESTDOMODE pfnDoPAE16_32;
3341 PFNBS3TESTDOMODE pfnDoPAE16_V86;
3342 PFNBS3TESTDOMODE pfnDoPAE32;
3343 PFNBS3TESTDOMODE pfnDoPAE32_16;
3344 PFNBS3TESTDOMODE pfnDoPAEV86;
3345
3346 PFNBS3TESTDOMODE pfnDoLM16;
3347 PFNBS3TESTDOMODE pfnDoLM32;
3348 PFNBS3TESTDOMODE pfnDoLM64;
3349
3350} BS3TESTMODEENTRY;
3351/** Pointer to a mode sub-test entry. */
3352typedef BS3TESTMODEENTRY const *PCBS3TESTMODEENTRY;
3353
3354/** @def BS3TESTMODEENTRY_CMN
3355 * Produces a BS3TESTMODEENTRY initializer for common (c16,c32,c64) test
3356 * functions. */
3357#define BS3TESTMODEENTRY_CMN(a_szTest, a_BaseNm) \
3358 { /*pszSubTest =*/ a_szTest, \
3359 /*RM*/ RT_CONCAT(a_BaseNm, _c16), \
3360 /*PE16*/ RT_CONCAT(a_BaseNm, _c16), \
3361 /*PE16_32*/ RT_CONCAT(a_BaseNm, _c32), \
3362 /*PE16_V86*/ RT_CONCAT(a_BaseNm, _c16), \
3363 /*PE32*/ RT_CONCAT(a_BaseNm, _c32), \
3364 /*PE32_16*/ RT_CONCAT(a_BaseNm, _c16), \
3365 /*PEV86*/ RT_CONCAT(a_BaseNm, _c16), \
3366 /*PP16*/ RT_CONCAT(a_BaseNm, _c16), \
3367 /*PP16_32*/ RT_CONCAT(a_BaseNm, _c32), \
3368 /*PP16_V86*/ RT_CONCAT(a_BaseNm, _c16), \
3369 /*PP32*/ RT_CONCAT(a_BaseNm, _c32), \
3370 /*PP32_16*/ RT_CONCAT(a_BaseNm, _c16), \
3371 /*PPV86*/ RT_CONCAT(a_BaseNm, _c16), \
3372 /*PAE16*/ RT_CONCAT(a_BaseNm, _c16), \
3373 /*PAE16_32*/ RT_CONCAT(a_BaseNm, _c32), \
3374 /*PAE16_V86*/ RT_CONCAT(a_BaseNm, _c16), \
3375 /*PAE32*/ RT_CONCAT(a_BaseNm, _c32), \
3376 /*PAE32_16*/ RT_CONCAT(a_BaseNm, _c16), \
3377 /*PAEV86*/ RT_CONCAT(a_BaseNm, _c16), \
3378 /*LM16*/ RT_CONCAT(a_BaseNm, _c16), \
3379 /*LM32*/ RT_CONCAT(a_BaseNm, _c32), \
3380 /*LM64*/ RT_CONCAT(a_BaseNm, _c64), \
3381 }
3382
3383/** @def BS3TESTMODE_PROTOTYPES_CMN
3384 * A set of standard protypes to go with #BS3TESTMODEENTRY_CMN. */
3385#define BS3TESTMODE_PROTOTYPES_CMN(a_BaseNm) \
3386 FNBS3TESTDOMODE /*BS3_FAR_CODE*/ RT_CONCAT(a_BaseNm, _c16); \
3387 FNBS3TESTDOMODE /*BS3_FAR_CODE*/ RT_CONCAT(a_BaseNm, _c32); \
3388 FNBS3TESTDOMODE /*BS3_FAR_CODE*/ RT_CONCAT(a_BaseNm, _c64)
3389
3390/** @def BS3TESTMODEENTRY_CMN_64
3391 * Produces a BS3TESTMODEENTRY initializer for common 64-bit test functions. */
3392#define BS3TESTMODEENTRY_CMN_64(a_szTest, a_BaseNm) \
3393 { /*pszSubTest =*/ a_szTest, \
3394 /*RM*/ NULL, \
3395 /*PE16*/ NULL, \
3396 /*PE16_32*/ NULL, \
3397 /*PE16_V86*/ NULL, \
3398 /*PE32*/ NULL, \
3399 /*PE32_16*/ NULL, \
3400 /*PEV86*/ NULL, \
3401 /*PP16*/ NULL, \
3402 /*PP16_32*/ NULL, \
3403 /*PP16_V86*/ NULL, \
3404 /*PP32*/ NULL, \
3405 /*PP32_16*/ NULL, \
3406 /*PPV86*/ NULL, \
3407 /*PAE16*/ NULL, \
3408 /*PAE16_32*/ NULL, \
3409 /*PAE16_V86*/ NULL, \
3410 /*PAE32*/ NULL, \
3411 /*PAE32_16*/ NULL, \
3412 /*PAEV86*/ NULL, \
3413 /*LM16*/ NULL, \
3414 /*LM32*/ NULL, \
3415 /*LM64*/ RT_CONCAT(a_BaseNm, _c64), \
3416 }
3417
3418/** @def BS3TESTMODE_PROTOTYPES_CMN
3419 * Standard protype to go with #BS3TESTMODEENTRY_CMN_64. */
3420#define BS3TESTMODE_PROTOTYPES_CMN_64(a_BaseNm) \
3421 FNBS3TESTDOMODE /*BS3_FAR_CODE*/ RT_CONCAT(a_BaseNm, _c64)
3422
3423/** @def BS3TESTMODEENTRY_MODE
3424 * Produces a BS3TESTMODEENTRY initializer for a full set of mode test
3425 * functions. */
3426#define BS3TESTMODEENTRY_MODE(a_szTest, a_BaseNm) \
3427 { /*pszSubTest =*/ a_szTest, \
3428 /*RM*/ RT_CONCAT(a_BaseNm, _rm), \
3429 /*PE16*/ RT_CONCAT(a_BaseNm, _pe16), \
3430 /*PE16_32*/ RT_CONCAT(a_BaseNm, _pe16_32), \
3431 /*PE16_V86*/ RT_CONCAT(a_BaseNm, _pe16_v86), \
3432 /*PE32*/ RT_CONCAT(a_BaseNm, _pe32), \
3433 /*PE32_16*/ RT_CONCAT(a_BaseNm, _pe32_16), \
3434 /*PEV86*/ RT_CONCAT(a_BaseNm, _pev86), \
3435 /*PP16*/ RT_CONCAT(a_BaseNm, _pp16), \
3436 /*PP16_32*/ RT_CONCAT(a_BaseNm, _pp16_32), \
3437 /*PP16_V86*/ RT_CONCAT(a_BaseNm, _pp16_v86), \
3438 /*PP32*/ RT_CONCAT(a_BaseNm, _pp32), \
3439 /*PP32_16*/ RT_CONCAT(a_BaseNm, _pp32_16), \
3440 /*PPV86*/ RT_CONCAT(a_BaseNm, _ppv86), \
3441 /*PAE16*/ RT_CONCAT(a_BaseNm, _pae16), \
3442 /*PAE16_32*/ RT_CONCAT(a_BaseNm, _pae16_32), \
3443 /*PAE16_V86*/ RT_CONCAT(a_BaseNm, _pae16_v86), \
3444 /*PAE32*/ RT_CONCAT(a_BaseNm, _pae32), \
3445 /*PAE32_16*/ RT_CONCAT(a_BaseNm, _pae32_16), \
3446 /*PAEV86*/ RT_CONCAT(a_BaseNm, _paev86), \
3447 /*LM16*/ RT_CONCAT(a_BaseNm, _lm16), \
3448 /*LM32*/ RT_CONCAT(a_BaseNm, _lm32), \
3449 /*LM64*/ RT_CONCAT(a_BaseNm, _lm64), \
3450 }
3451
3452/** @def BS3TESTMODE_PROTOTYPES_MODE
3453 * A set of standard protypes to go with #BS3TESTMODEENTRY_MODE. */
3454#define BS3TESTMODE_PROTOTYPES_MODE(a_BaseNm) \
3455 FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _rm); \
3456 FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pe16); \
3457 FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pe16_32); \
3458 FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pe16_v86); \
3459 FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pe32); \
3460 FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pe32_16); \
3461 FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pev86); \
3462 FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pp16); \
3463 FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pp16_32); \
3464 FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pp16_v86); \
3465 FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pp32); \
3466 FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pp32_16); \
3467 FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _ppv86); \
3468 FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pae16); \
3469 FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pae16_32); \
3470 FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pae16_v86); \
3471 FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pae32); \
3472 FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pae32_16); \
3473 FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _paev86); \
3474 FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _lm16); \
3475 FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _lm32); \
3476 FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _lm64)
3477
3478
3479/**
3480 * Mode sub-test entry, max bit-count driven
3481 *
3482 * This is an alternative to BS3TESTMODEENTRY where a few workers (test drivers)
3483 * does all the work, using faster 32-bit and 64-bit code where possible. This
3484 * avoids executing workers in V8086 mode. It allows for modifying and checking
3485 * 64-bit register content when testing LM16 and LM32.
3486 *
3487 * The 16-bit workers are only used for real mode and 16-bit protected mode.
3488 * So, the 16-bit version of the code template can be stripped of anything
3489 * related to paging and/or v8086, saving code space.
3490 */
3491typedef struct BS3TESTMODEBYMAXENTRY
3492{
3493 /** The sub-test name to be passed to Bs3TestSub if not NULL. */
3494 const char * BS3_FAR pszSubTest;
3495
3496 PFNBS3TESTDOMODE pfnDoRM;
3497 PFNBS3TESTDOMODE pfnDoPE16;
3498 PFNBS3TESTDOMODE pfnDoPE16_32;
3499 PFNBS3TESTDOMODE pfnDoPE32;
3500 PFNBS3TESTDOMODE pfnDoPP16_32;
3501 PFNBS3TESTDOMODE pfnDoPP32;
3502 PFNBS3TESTDOMODE pfnDoPAE16_32;
3503 PFNBS3TESTDOMODE pfnDoPAE32;
3504 PFNBS3TESTDOMODE pfnDoLM64;
3505
3506 bool fDoRM : 1;
3507
3508 bool fDoPE16 : 1;
3509 bool fDoPE16_32 : 1;
3510 bool fDoPE16_V86 : 1;
3511 bool fDoPE32 : 1;
3512 bool fDoPE32_16 : 1;
3513 bool fDoPEV86 : 1;
3514
3515 bool fDoPP16 : 1;
3516 bool fDoPP16_32 : 1;
3517 bool fDoPP16_V86 : 1;
3518 bool fDoPP32 : 1;
3519 bool fDoPP32_16 : 1;
3520 bool fDoPPV86 : 1;
3521
3522 bool fDoPAE16 : 1;
3523 bool fDoPAE16_32 : 1;
3524 bool fDoPAE16_V86 : 1;
3525 bool fDoPAE32 : 1;
3526 bool fDoPAE32_16 : 1;
3527 bool fDoPAEV86 : 1;
3528
3529 bool fDoLM16 : 1;
3530 bool fDoLM32 : 1;
3531 bool fDoLM64 : 1;
3532
3533} BS3TESTMODEBYMAXENTRY;
3534/** Pointer to a mode-by-max sub-test entry. */
3535typedef BS3TESTMODEBYMAXENTRY const *PCBS3TESTMODEBYMAXENTRY;
3536
3537/** @def BS3TESTMODEBYMAXENTRY_CMN
3538 * Produces a BS3TESTMODEBYMAXENTRY initializer for common (c16,c32,c64) test
3539 * functions. */
3540#define BS3TESTMODEBYMAXENTRY_CMN(a_szTest, a_BaseNm) \
3541 { /*pszSubTest =*/ a_szTest, \
3542 /*RM*/ RT_CONCAT(a_BaseNm, _c16), \
3543 /*PE16*/ RT_CONCAT(a_BaseNm, _c16), \
3544 /*PE16_32*/ RT_CONCAT(a_BaseNm, _c32), \
3545 /*PE32*/ RT_CONCAT(a_BaseNm, _c32), \
3546 /*PP16_32*/ RT_CONCAT(a_BaseNm, _c32), \
3547 /*PP32*/ RT_CONCAT(a_BaseNm, _c32), \
3548 /*PAE16_32*/ RT_CONCAT(a_BaseNm, _c32), \
3549 /*PAE32*/ RT_CONCAT(a_BaseNm, _c32), \
3550 /*LM64*/ RT_CONCAT(a_BaseNm, _c64), \
3551 /*fDoRM*/ true, \
3552 /*fDoPE16*/ true, \
3553 /*fDoPE16_32*/ true, \
3554 /*fDoPE16_V86*/ true, \
3555 /*fDoPE32*/ true, \
3556 /*fDoPE32_16*/ true, \
3557 /*fDoPEV86*/ true, \
3558 /*fDoPP16*/ true, \
3559 /*fDoPP16_32*/ true, \
3560 /*fDoPP16_V86*/ true, \
3561 /*fDoPP32*/ true, \
3562 /*fDoPP32_16*/ true, \
3563 /*fDoPPV86*/ true, \
3564 /*fDoPAE16*/ true, \
3565 /*fDoPAE16_32*/ true, \
3566 /*fDoPAE16_V86*/ true, \
3567 /*fDoPAE32*/ true, \
3568 /*fDoPAE32_16*/ true, \
3569 /*fDoPAEV86*/ true, \
3570 /*fDoLM16*/ true, \
3571 /*fDoLM32*/ true, \
3572 /*fDoLM64*/ true, \
3573 }
3574
3575/** @def BS3TESTMODEBYMAX_PROTOTYPES_CMN
3576 * A set of standard protypes to go with #BS3TESTMODEBYMAXENTRY_CMN. */
3577#define BS3TESTMODEBYMAX_PROTOTYPES_CMN(a_BaseNm) \
3578 FNBS3TESTDOMODE /*BS3_FAR_CODE*/ RT_CONCAT(a_BaseNm, _c16); \
3579 FNBS3TESTDOMODE /*BS3_FAR_CODE*/ RT_CONCAT(a_BaseNm, _c32); \
3580 FNBS3TESTDOMODE /*BS3_FAR_CODE*/ RT_CONCAT(a_BaseNm, _c64)
3581
3582
3583/** @def BS3TESTMODEBYMAXENTRY_MODE
3584 * Produces a BS3TESTMODEBYMAXENTRY initializer for a full set of mode test
3585 * functions. */
3586#define BS3TESTMODEBYMAXENTRY_MODE(a_szTest, a_BaseNm) \
3587 { /*pszSubTest =*/ a_szTest, \
3588 /*RM*/ RT_CONCAT(a_BaseNm, _rm), \
3589 /*PE16*/ RT_CONCAT(a_BaseNm, _pe16), \
3590 /*PE16_32*/ RT_CONCAT(a_BaseNm, _pe16_32), \
3591 /*PE32*/ RT_CONCAT(a_BaseNm, _pe32), \
3592 /*PP16_32*/ RT_CONCAT(a_BaseNm, _pp16_32), \
3593 /*PP32*/ RT_CONCAT(a_BaseNm, _pp32), \
3594 /*PAE16_32*/ RT_CONCAT(a_BaseNm, _pae16_32), \
3595 /*PAE32*/ RT_CONCAT(a_BaseNm, _pae32), \
3596 /*LM64*/ RT_CONCAT(a_BaseNm, _lm64), \
3597 /*fDoRM*/ true, \
3598 /*fDoPE16*/ true, \
3599 /*fDoPE16_32*/ true, \
3600 /*fDoPE16_V86*/ true, \
3601 /*fDoPE32*/ true, \
3602 /*fDoPE32_16*/ true, \
3603 /*fDoPEV86*/ true, \
3604 /*fDoPP16*/ true, \
3605 /*fDoPP16_32*/ true, \
3606 /*fDoPP16_V86*/ true, \
3607 /*fDoPP32*/ true, \
3608 /*fDoPP32_16*/ true, \
3609 /*fDoPPV86*/ true, \
3610 /*fDoPAE16*/ true, \
3611 /*fDoPAE16_32*/ true, \
3612 /*fDoPAE16_V86*/ true, \
3613 /*fDoPAE32*/ true, \
3614 /*fDoPAE32_16*/ true, \
3615 /*fDoPAEV86*/ true, \
3616 /*fDoLM16*/ true, \
3617 /*fDoLM32*/ true, \
3618 /*fDoLM64*/ true, \
3619 }
3620
3621/** @def BS3TESTMODEBYMAX_PROTOTYPES_MODE
3622 * A set of standard protypes to go with #BS3TESTMODEBYMAXENTRY_MODE. */
3623#define BS3TESTMODEBYMAX_PROTOTYPES_MODE(a_BaseNm) \
3624 FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _rm); \
3625 FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pe16); \
3626 FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pe16_32); \
3627 FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pe32); \
3628 FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pp16_32); \
3629 FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pp32); \
3630 FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pae16_32); \
3631 FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pae32); \
3632 FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _lm64)
3633
3634
3635/**
3636 * One worker drives all modes.
3637 *
3638 * This is an alternative to BS3TESTMODEENTRY where one worker, typically
3639 * 16-bit, does all the test driver work. It's called repeatedly from all
3640 * the modes being tested.
3641 */
3642typedef struct BS3TESTMODEBYONEENTRY
3643{
3644 const char * BS3_FAR pszSubTest;
3645 PFNBS3TESTDOMODE pfnWorker;
3646 /** BS3TESTMODEBYONEENTRY_F_XXX. */
3647 uint32_t fFlags;
3648} BS3TESTMODEBYONEENTRY;
3649/** Pointer to a mode-by-one sub-test entry. */
3650typedef BS3TESTMODEBYONEENTRY const *PCBS3TESTMODEBYONEENTRY;
3651
3652/** @name BS3TESTMODEBYONEENTRY_F_XXX - flags.
3653 * @{ */
3654/** Only test modes that has paging enabled. */
3655#define BS3TESTMODEBYONEENTRY_F_ONLY_PAGING RT_BIT_32(0)
3656/** @} */
3657
3658
3659/**
3660 * Sets the full GDTR register.
3661 *
3662 * @param cbLimit The limit.
3663 * @param uBase The base address - 24, 32 or 64 bit depending on the
3664 * CPU mode.
3665 */
3666BS3_CMN_PROTO_NOSB(void, Bs3UtilSetFullGdtr,(uint16_t cbLimit, uint64_t uBase));
3667
3668/**
3669 * Sets the full IDTR register.
3670 *
3671 * @param cbLimit The limit.
3672 * @param uBase The base address - 24, 32 or 64 bit depending on the
3673 * CPU mode.
3674 */
3675BS3_CMN_PROTO_NOSB(void, Bs3UtilSetFullIdtr,(uint16_t cbLimit, uint64_t uBase));
3676
3677
3678/** @} */
3679
3680
3681/**
3682 * Initializes all of boot sector kit \#3.
3683 */
3684BS3_DECL(void) Bs3InitAll_rm(void);
3685
3686/**
3687 * Initializes the REAL and TILED memory pools.
3688 *
3689 * For proper operation on OLDer CPUs, call #Bs3CpuDetect_mmm first.
3690 */
3691BS3_DECL_FAR(void) Bs3InitMemory_rm_far(void);
3692
3693/**
3694 * Initialized the X0TEXT16 and X1TEXT16 GDT entries.
3695 */
3696BS3_DECL_FAR(void) Bs3InitGdt_rm_far(void);
3697
3698
3699
3700/** @defgroup grp_bs3kit_mode Mode Specific Functions and Data
3701 *
3702 * The mode specific functions come in bit count variations and CPU mode
3703 * variations. The bs3kit-template-header.h/mac defines the BS3_NM macro to
3704 * mangle a function or variable name according to the target CPU mode. In
3705 * non-templated code, it's common to spell the name out in full.
3706 *
3707 * @{
3708 */
3709
3710
3711/** @def BS3_MODE_PROTO_INT
3712 * Internal macro for emitting prototypes for mode functions.
3713 *
3714 * @param a_RetType The return type.
3715 * @param a_Name The function basename.
3716 * @param a_Params The parameter list (in parentheses).
3717 * @sa BS3_MODE_PROTO_STUB, BS3_MODE_PROTO_NOSB
3718 */
3719#define BS3_MODE_PROTO_INT(a_RetType, a_Name, a_Params) \
3720 BS3_DECL_NEAR(a_RetType) RT_CONCAT(a_Name,_rm) a_Params; \
3721 BS3_DECL_NEAR(a_RetType) RT_CONCAT(a_Name,_pe16) a_Params; \
3722 BS3_DECL_NEAR(a_RetType) RT_CONCAT(a_Name,_pe16_32) a_Params; \
3723 BS3_DECL_NEAR(a_RetType) RT_CONCAT(a_Name,_pe16_v86) a_Params; \
3724 BS3_DECL_NEAR(a_RetType) RT_CONCAT(a_Name,_pe32) a_Params; \
3725 BS3_DECL_NEAR(a_RetType) RT_CONCAT(a_Name,_pe32_16) a_Params; \
3726 BS3_DECL_NEAR(a_RetType) RT_CONCAT(a_Name,_pev86) a_Params; \
3727 BS3_DECL_NEAR(a_RetType) RT_CONCAT(a_Name,_pp16) a_Params; \
3728 BS3_DECL_NEAR(a_RetType) RT_CONCAT(a_Name,_pp16_32) a_Params; \
3729 BS3_DECL_NEAR(a_RetType) RT_CONCAT(a_Name,_pp16_v86) a_Params; \
3730 BS3_DECL_NEAR(a_RetType) RT_CONCAT(a_Name,_pp32) a_Params; \
3731 BS3_DECL_NEAR(a_RetType) RT_CONCAT(a_Name,_pp32_16) a_Params; \
3732 BS3_DECL_NEAR(a_RetType) RT_CONCAT(a_Name,_ppv86) a_Params; \
3733 BS3_DECL_NEAR(a_RetType) RT_CONCAT(a_Name,_pae16) a_Params; \
3734 BS3_DECL_NEAR(a_RetType) RT_CONCAT(a_Name,_pae16_32) a_Params; \
3735 BS3_DECL_NEAR(a_RetType) RT_CONCAT(a_Name,_pae16_v86) a_Params; \
3736 BS3_DECL_NEAR(a_RetType) RT_CONCAT(a_Name,_pae32) a_Params; \
3737 BS3_DECL_NEAR(a_RetType) RT_CONCAT(a_Name,_pae32_16) a_Params; \
3738 BS3_DECL_NEAR(a_RetType) RT_CONCAT(a_Name,_paev86) a_Params; \
3739 BS3_DECL_NEAR(a_RetType) RT_CONCAT(a_Name,_lm16) a_Params; \
3740 BS3_DECL_NEAR(a_RetType) RT_CONCAT(a_Name,_lm32) a_Params; \
3741 BS3_DECL_NEAR(a_RetType) RT_CONCAT(a_Name,_lm64) a_Params; \
3742 BS3_DECL_FAR(a_RetType) RT_CONCAT(a_Name,_rm_far) a_Params; \
3743 BS3_DECL_FAR(a_RetType) RT_CONCAT(a_Name,_pe16_far) a_Params; \
3744 BS3_DECL_FAR(a_RetType) RT_CONCAT(a_Name,_pe16_v86_far) a_Params; \
3745 BS3_DECL_FAR(a_RetType) RT_CONCAT(a_Name,_pe32_16_far) a_Params; \
3746 BS3_DECL_FAR(a_RetType) RT_CONCAT(a_Name,_pev86_far) a_Params; \
3747 BS3_DECL_FAR(a_RetType) RT_CONCAT(a_Name,_pp16_far) a_Params; \
3748 BS3_DECL_FAR(a_RetType) RT_CONCAT(a_Name,_pp16_v86_far) a_Params; \
3749 BS3_DECL_FAR(a_RetType) RT_CONCAT(a_Name,_pp32_16_far) a_Params; \
3750 BS3_DECL_FAR(a_RetType) RT_CONCAT(a_Name,_ppv86_far) a_Params; \
3751 BS3_DECL_FAR(a_RetType) RT_CONCAT(a_Name,_pae16_far) a_Params; \
3752 BS3_DECL_FAR(a_RetType) RT_CONCAT(a_Name,_pae16_v86_far)a_Params; \
3753 BS3_DECL_FAR(a_RetType) RT_CONCAT(a_Name,_pae32_16_far) a_Params; \
3754 BS3_DECL_FAR(a_RetType) RT_CONCAT(a_Name,_paev86_far) a_Params; \
3755 BS3_DECL_FAR(a_RetType) RT_CONCAT(a_Name,_lm16_far) a_Params
3756
3757/** @def BS3_MODE_PROTO_STUB
3758 * Macro for prototyping all the variations of a mod function with automatic
3759 * near -> far stub.
3760 *
3761 * @param a_RetType The return type.
3762 * @param a_Name The function basename.
3763 * @param a_Params The parameter list (in parentheses).
3764 * @sa BS3_MODE_PROTO_STUB, BS3_MODE_PROTO_NOSB
3765 */
3766#define BS3_MODE_PROTO_STUB(a_RetType, a_Name, a_Params) BS3_MODE_PROTO_INT(a_RetType, a_Name, a_Params)
3767
3768/** @def BS3_MODE_PROTO_STUB
3769 * Macro for prototyping all the variations of a mod function without any
3770 * near -> far stub.
3771 *
3772 * @param a_RetType The return type.
3773 * @param a_Name The function basename.
3774 * @param a_Params The parameter list (in parentheses).
3775 * @sa BS3_MODE_PROTO_STUB, BS3_MODE_PROTO_NOSB
3776 */
3777#define BS3_MODE_PROTO_NOSB(a_RetType, a_Name, a_Params) BS3_MODE_PROTO_INT(a_RetType, a_Name, a_Params)
3778
3779
3780/**
3781 * Macro for reducing typing.
3782 *
3783 * Doxygen knows how to expand this, well, kind of.
3784 *
3785 * @remarks Variables instantiated in assembly code should define two labels,
3786 * with and without leading underscore. Variables instantiated from
3787 * C/C++ code doesn't need to as the object file convert does this for
3788 * 64-bit object files.
3789 */
3790#define BS3_MODE_EXPAND_EXTERN_DATA16(a_VarType, a_VarName, a_Suffix) \
3791 extern a_VarType BS3_FAR_DATA RT_CONCAT(a_VarName,_rm) a_Suffix; \
3792 extern a_VarType BS3_FAR_DATA RT_CONCAT(a_VarName,_pe16) a_Suffix; \
3793 extern a_VarType BS3_FAR_DATA RT_CONCAT(a_VarName,_pe16_32) a_Suffix; \
3794 extern a_VarType BS3_FAR_DATA RT_CONCAT(a_VarName,_pe16_v86) a_Suffix; \
3795 extern a_VarType BS3_FAR_DATA RT_CONCAT(a_VarName,_pe32) a_Suffix; \
3796 extern a_VarType BS3_FAR_DATA RT_CONCAT(a_VarName,_pe32_16) a_Suffix; \
3797 extern a_VarType BS3_FAR_DATA RT_CONCAT(a_VarName,_pev86) a_Suffix; \
3798 extern a_VarType BS3_FAR_DATA RT_CONCAT(a_VarName,_pp16) a_Suffix; \
3799 extern a_VarType BS3_FAR_DATA RT_CONCAT(a_VarName,_pp16_32) a_Suffix; \
3800 extern a_VarType BS3_FAR_DATA RT_CONCAT(a_VarName,_pp16_v86) a_Suffix; \
3801 extern a_VarType BS3_FAR_DATA RT_CONCAT(a_VarName,_pp32) a_Suffix; \
3802 extern a_VarType BS3_FAR_DATA RT_CONCAT(a_VarName,_pp32_16) a_Suffix; \
3803 extern a_VarType BS3_FAR_DATA RT_CONCAT(a_VarName,_ppv86) a_Suffix; \
3804 extern a_VarType BS3_FAR_DATA RT_CONCAT(a_VarName,_pae16) a_Suffix; \
3805 extern a_VarType BS3_FAR_DATA RT_CONCAT(a_VarName,_pae16_32) a_Suffix; \
3806 extern a_VarType BS3_FAR_DATA RT_CONCAT(a_VarName,_pae16_v86)a_Suffix; \
3807 extern a_VarType BS3_FAR_DATA RT_CONCAT(a_VarName,_pae32) a_Suffix; \
3808 extern a_VarType BS3_FAR_DATA RT_CONCAT(a_VarName,_pae32_16) a_Suffix; \
3809 extern a_VarType BS3_FAR_DATA RT_CONCAT(a_VarName,_paev86) a_Suffix; \
3810 extern a_VarType BS3_FAR_DATA RT_CONCAT(a_VarName,_lm16) a_Suffix; \
3811 extern a_VarType BS3_FAR_DATA RT_CONCAT(a_VarName,_lm32) a_Suffix; \
3812 extern a_VarType BS3_FAR_DATA RT_CONCAT(a_VarName,_lm64) a_Suffix
3813
3814
3815/** The TMPL_MODE_STR value for each mode.
3816 * These are all in DATA16 so they can be accessed from any code. */
3817BS3_MODE_EXPAND_EXTERN_DATA16(const char, g_szBs3ModeName, []);
3818/** The TMPL_MODE_LNAME value for each mode.
3819 * These are all in DATA16 so they can be accessed from any code. */
3820BS3_MODE_EXPAND_EXTERN_DATA16(const char, g_szBs3ModeNameShortLower, []);
3821
3822
3823/**
3824 * Basic CPU detection.
3825 *
3826 * This sets the #g_uBs3CpuDetected global variable to the return value.
3827 *
3828 * @returns BS3CPU_XXX value with the BS3CPU_F_CPUID flag set depending on
3829 * capabilities.
3830 */
3831BS3_MODE_PROTO_NOSB(uint8_t, Bs3CpuDetect,(void));
3832
3833/** @name BS3CPU_XXX - CPU detected by BS3CpuDetect_c16() and friends.
3834 * @{ */
3835#define BS3CPU_8086 UINT16_C(0x0001) /**< Both 8086 and 8088. */
3836#define BS3CPU_V20 UINT16_C(0x0002) /**< Both NEC V20, V30 and relatives. */
3837#define BS3CPU_80186 UINT16_C(0x0003) /**< Both 80186 and 80188. */
3838#define BS3CPU_80286 UINT16_C(0x0004)
3839#define BS3CPU_80386 UINT16_C(0x0005)
3840#define BS3CPU_80486 UINT16_C(0x0006)
3841#define BS3CPU_Pentium UINT16_C(0x0007)
3842#define BS3CPU_PPro UINT16_C(0x0008)
3843#define BS3CPU_PProOrNewer UINT16_C(0x0009)
3844/** CPU type mask. This is a full byte so it's possible to use byte access
3845 * without and AND'ing to get the type value. */
3846#define BS3CPU_TYPE_MASK UINT16_C(0x00ff)
3847/** Flag indicating that the CPUID instruction is supported by the CPU. */
3848#define BS3CPU_F_CPUID UINT16_C(0x0100)
3849/** Flag indicating that extend CPUID leaves are available (at least two). */
3850#define BS3CPU_F_CPUID_EXT_LEAVES UINT16_C(0x0200)
3851/** Flag indicating that the CPU supports PAE. */
3852#define BS3CPU_F_PAE UINT16_C(0x0400)
3853/** Flag indicating that the CPU supports the page size extension (4MB pages). */
3854#define BS3CPU_F_PSE UINT16_C(0x0800)
3855/** Flag indicating that the CPU supports long mode. */
3856#define BS3CPU_F_LONG_MODE UINT16_C(0x1000)
3857/** Flag indicating that the CPU supports NX. */
3858#define BS3CPU_F_NX UINT16_C(0x2000)
3859/** @} */
3860
3861/** The return value of #Bs3CpuDetect_mmm. (Initial value is BS3CPU_TYPE_MASK.) */
3862extern uint16_t g_uBs3CpuDetected;
3863
3864/**
3865 * Call 32-bit prot mode C function.
3866 *
3867 * This switches to 32-bit mode and calls the 32-bit @a fpfnCall C code with @a
3868 * cbParams on the stack, then returns in the original mode. When called in
3869 * real mode, this will switch to PE32.
3870 *
3871 * @returns 32-bit status code if the function returned anything.
3872 * @param fpfnCall Address of the 32-bit C function to call. When
3873 * called from 16-bit code, this is a far real mode
3874 * function pointer, i.e. as fixed up by the linker.
3875 * In 32-bit and 64-bit code, this is a flat address.
3876 * @param cbParams The size of the parameter list, in bytes.
3877 * @param ... The parameters.
3878 * @sa Bs3SwitchFromV86To16BitAndCallC
3879 *
3880 * @remarks WARNING! This probably doesn't work in 64-bit mode yet.
3881 * Only tested for 16-bit real mode.
3882 */
3883BS3_MODE_PROTO_STUB(int32_t, Bs3SwitchTo32BitAndCallC,(FPFNBS3FAR fpfnCall, unsigned cbParams, ...));
3884
3885/**
3886 * Initializes trap handling for the current system.
3887 *
3888 * Calls the appropriate Bs3Trap16Init, Bs3Trap32Init or Bs3Trap64Init function.
3889 */
3890BS3_MODE_PROTO_STUB(void, Bs3TrapInit,(void));
3891
3892/**
3893 * Executes the array of tests in every possibly mode.
3894 *
3895 * @param paEntries The mode sub-test entries.
3896 * @param cEntries The number of sub-test entries.
3897 */
3898BS3_MODE_PROTO_NOSB(void, Bs3TestDoModes,(PCBS3TESTMODEENTRY paEntries, size_t cEntries));
3899
3900/**
3901 * Executes the array of tests in every possibly mode, unified driver.
3902 *
3903 * This requires much less code space than Bs3TestDoModes as there is only one
3904 * instace of each sub-test driver code, instead of 3 (cmn) or 22 (per-mode)
3905 * copies.
3906 *
3907 * @param paEntries The mode sub-test-by-one entries.
3908 * @param cEntries The number of sub-test-by-one entries.
3909 * @param fFlags Reserved for the future, MBZ.
3910 */
3911BS3_MODE_PROTO_NOSB(void, Bs3TestDoModesByOne,(PCBS3TESTMODEBYONEENTRY paEntries, size_t cEntries, uint32_t fFlags));
3912
3913/**
3914 * Executes the array of tests in every possibly mode, using the max bit-count
3915 * worker for each.
3916 *
3917 * @param paEntries The mode sub-test entries.
3918 * @param cEntries The number of sub-test entries.
3919 */
3920BS3_MODE_PROTO_NOSB(void, Bs3TestDoModesByMax,(PCBS3TESTMODEBYMAXENTRY paEntries, size_t cEntries));
3921
3922
3923/** @} */
3924
3925/** @} */
3926
3927RT_C_DECLS_END
3928
3929
3930/*
3931 * Include default function symbol mangling.
3932 */
3933#include "bs3kit-mangling-code.h"
3934
3935/*
3936 * Change 16-bit text segment if requested.
3937 */
3938#if defined(BS3_USE_ALT_16BIT_TEXT_SEG) && ARCH_BITS == 16 && !defined(BS3_DONT_CHANGE_TEXT_SEG)
3939# if (defined(BS3_USE_RM_TEXT_SEG) + defined(BS3_USE_X0_TEXT_SEG) + defined(BS3_USE_X1_TEXT_SEG)) != 1
3940# error "Cannot set more than one alternative 16-bit text segment!"
3941# elif defined(BS3_USE_RM_TEXT_SEG)
3942# pragma code_seg("BS3RMTEXT16", "BS3CLASS16RMCODE")
3943# elif defined(BS3_USE_X0_TEXT_SEG)
3944# pragma code_seg("BS3X0TEXT16", "BS3CLASS16X0CODE")
3945# elif defined(BS3_USE_X1_TEXT_SEG)
3946# pragma code_seg("BS3X1TEXT16", "BS3CLASS16X1CODE")
3947# else
3948# error "Huh? Which alternative text segment did you want again?"
3949# endif
3950#endif
3951
3952#endif
3953
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette