VirtualBox

source: vbox/trunk/include/iprt/initterm.h@ 3810

Last change on this file since 3810 was 3630, checked in by vboxsync, 17 years ago

iprt_hdr_h -> _iprt_hdr_h

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 2.6 KB
Line 
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__BEGIN_DECLS
28
29/** @defgroup grp_rt innotek Portable Runtime APIs
30 * @{
31 */
32
33/** @defgroup grp_rt_initterm Init / Term
34 * @{
35 */
36
37#ifdef IN_RING3
38/**
39 * Initalizes the runtime library.
40 *
41 * @returns iprt status code.
42 *
43 * @param fInitSUPLib Set if SUPInit() shall be called during init (default).
44 * Clear if not to call it.
45 * @param cbReserve The number of bytes of contiguous memory that should be reserved by
46 * the runtime / support library.
47 * Set this to 0 if no reservation is required. (default)
48 * Set this to ~(size_t)0 if the maximum amount supported by the VM is to be
49 * attempted reserved, or the maximum available.
50 * This argument only applies if fInitSUPLib is true and we're in ring-3 HC.
51 */
52RTR3DECL(int) RTR3Init(
53#ifdef __cplusplus
54 bool fInitSUPLib = true,
55 size_t cbReserve = 0
56#else
57 bool fInitSUPLib,
58 size_t cbReserve
59#endif
60 );
61
62/**
63 * Terminates the runtime library.
64 */
65RTR3DECL(void) RTR3Term(void);
66#endif
67
68
69#ifdef IN_RING0
70/**
71 * Initalizes the ring-0 driver runtime library.
72 *
73 * @returns iprt status code.
74 * @param fReserved Flags reserved for the future.
75 */
76RTR0DECL(int) RTR0Init(unsigned fReserved);
77
78/**
79 * Terminates the ring-0 driver runtime library.
80 */
81RTR0DECL(void) RTR0Term(void);
82#endif
83
84#ifdef IN_GC
85/**
86 * Initalizes the guest context runtime library.
87 *
88 * @returns iprt status code.
89 *
90 * @param u64ProgramStartNanoTS The startup timestamp.
91 */
92RTGCDECL(int) RTGCInit(uint64_t u64ProgramStartNanoTS);
93
94/**
95 * Terminates the guest context runtime library.
96 */
97RTGCDECL(void) RTGCTerm(void);
98#endif
99
100
101/** @} */
102
103/** @} */
104
105__END_DECLS
106
107
108#endif
109
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