| 1 | /** @file
|
|---|
| 2 | * innotek Portable Runtime - Runtime Init/Term.
|
|---|
| 3 | */
|
|---|
| 4 |
|
|---|
| 5 | /*
|
|---|
| 6 | * Copyright (C) 2006-2007 innotek GmbH
|
|---|
| 7 | *
|
|---|
| 8 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
|---|
| 9 | * available from http://www.virtualbox.org. This file is free software;
|
|---|
| 10 | * you can redistribute it and/or modify it under the terms of the GNU
|
|---|
| 11 | * General Public License as published by the Free Software Foundation,
|
|---|
| 12 | * in version 2 as it comes in the "COPYING" file of the VirtualBox OSE
|
|---|
| 13 | * distribution. VirtualBox OSE is distributed in the hope that it will
|
|---|
| 14 | * be useful, but WITHOUT ANY WARRANTY of any kind.
|
|---|
| 15 | *
|
|---|
| 16 | * If you received this file as part of a commercial VirtualBox
|
|---|
| 17 | * distribution, then only the terms of your commercial VirtualBox
|
|---|
| 18 | * license agreement apply instead of the previous paragraph.
|
|---|
| 19 | */
|
|---|
| 20 |
|
|---|
| 21 | #ifndef __iprt_initterm_h__
|
|---|
| 22 | #define __iprt_initterm_h__
|
|---|
| 23 |
|
|---|
| 24 | #include <iprt/cdefs.h>
|
|---|
| 25 | #include <iprt/types.h>
|
|---|
| 26 |
|
|---|
| 27 |
|
|---|
| 28 | __BEGIN_DECLS
|
|---|
| 29 |
|
|---|
| 30 | /** @defgroup grp_rt innotek Portable Runtime APIs
|
|---|
| 31 | * @{
|
|---|
| 32 | */
|
|---|
| 33 |
|
|---|
| 34 | /** @defgroup grp_rt_initterm Init / Term
|
|---|
| 35 | * @{
|
|---|
| 36 | */
|
|---|
| 37 |
|
|---|
| 38 | #ifdef IN_RING3
|
|---|
| 39 | /**
|
|---|
| 40 | * Initalizes the runtime library.
|
|---|
| 41 | *
|
|---|
| 42 | * @returns iprt status code.
|
|---|
| 43 | *
|
|---|
| 44 | * @param fInitSUPLib Set if SUPInit() shall be called during init (default).
|
|---|
| 45 | * Clear if not to call it.
|
|---|
| 46 | * @param cbReserve The number of bytes of contiguous memory that should be reserved by
|
|---|
| 47 | * the runtime / support library.
|
|---|
| 48 | * Set this to 0 if no reservation is required. (default)
|
|---|
| 49 | * Set this to ~(size_t)0 if the maximum amount supported by the VM is to be
|
|---|
| 50 | * attempted reserved, or the maximum available.
|
|---|
| 51 | * This argument only applies if fInitSUPLib is true and we're in ring-3 HC.
|
|---|
| 52 | */
|
|---|
| 53 | RTR3DECL(int) RTR3Init(
|
|---|
| 54 | #ifdef __cplusplus
|
|---|
| 55 | bool fInitSUPLib = true,
|
|---|
| 56 | size_t cbReserve = 0
|
|---|
| 57 | #else
|
|---|
| 58 | bool fInitSUPLib,
|
|---|
| 59 | size_t cbReserve
|
|---|
| 60 | #endif
|
|---|
| 61 | );
|
|---|
| 62 |
|
|---|
| 63 | /**
|
|---|
| 64 | * Terminates the runtime library.
|
|---|
| 65 | */
|
|---|
| 66 | RTR3DECL(void) RTR3Term(void);
|
|---|
| 67 | #endif
|
|---|
| 68 |
|
|---|
| 69 |
|
|---|
| 70 | #ifdef IN_RING0
|
|---|
| 71 | /**
|
|---|
| 72 | * Initalizes the ring-0 driver runtime library.
|
|---|
| 73 | *
|
|---|
| 74 | * @returns iprt status code.
|
|---|
| 75 | * @param fReserved Flags reserved for the future.
|
|---|
| 76 | */
|
|---|
| 77 | RTR0DECL(int) RTR0Init(unsigned fReserved);
|
|---|
| 78 |
|
|---|
| 79 | /**
|
|---|
| 80 | * Terminates the ring-0 driver runtime library.
|
|---|
| 81 | */
|
|---|
| 82 | RTR0DECL(void) RTR0Term(void);
|
|---|
| 83 | #endif
|
|---|
| 84 |
|
|---|
| 85 | /** @} */
|
|---|
| 86 |
|
|---|
| 87 | /** @} */
|
|---|
| 88 |
|
|---|
| 89 | __END_DECLS
|
|---|
| 90 |
|
|---|
| 91 |
|
|---|
| 92 | #endif
|
|---|
| 93 |
|
|---|
