VirtualBox

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

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

The Giant CDDL Dual-License Header Change.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 2.9 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 (GPL) as published by the Free Software
12 * Foundation, in version 2 as it comes in the "COPYING" file of the
13 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15 *
16 * The contents of this file may alternatively be used under the terms
17 * of the Common Development and Distribution License Version 1.0
18 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19 * VirtualBox OSE distribution, in which case the provisions of the
20 * CDDL are applicable instead of those of the GPL.
21 *
22 * You may elect to license modified versions of this file under the
23 * terms and conditions of either the GPL or the CDDL or both.
24 */
25
26#ifndef ___iprt_initterm_h
27#define ___iprt_initterm_h
28
29#include <iprt/cdefs.h>
30#include <iprt/types.h>
31
32__BEGIN_DECLS
33
34/** @defgroup grp_rt innotek Portable Runtime APIs
35 * @{
36 */
37
38/** @defgroup grp_rt_initterm Init / Term
39 * @{
40 */
41
42#ifdef IN_RING3
43/**
44 * Initalizes the runtime library.
45 *
46 * @returns iprt status code.
47 *
48 * @param fInitSUPLib Set if SUPInit() shall be called during init (default).
49 * Clear if not to call it.
50 * @param cbReserve The number of bytes of contiguous memory that should be reserved by
51 * the runtime / support library.
52 * Set this to 0 if no reservation is required. (default)
53 * Set this to ~(size_t)0 if the maximum amount supported by the VM is to be
54 * attempted reserved, or the maximum available.
55 * This argument only applies if fInitSUPLib is true and we're in ring-3 HC.
56 */
57RTR3DECL(int) RTR3Init(
58#ifdef __cplusplus
59 bool fInitSUPLib = true,
60 size_t cbReserve = 0
61#else
62 bool fInitSUPLib,
63 size_t cbReserve
64#endif
65 );
66
67/**
68 * Terminates the runtime library.
69 */
70RTR3DECL(void) RTR3Term(void);
71#endif
72
73
74#ifdef IN_RING0
75/**
76 * Initalizes the ring-0 driver runtime library.
77 *
78 * @returns iprt status code.
79 * @param fReserved Flags reserved for the future.
80 */
81RTR0DECL(int) RTR0Init(unsigned fReserved);
82
83/**
84 * Terminates the ring-0 driver runtime library.
85 */
86RTR0DECL(void) RTR0Term(void);
87#endif
88
89#ifdef IN_GC
90/**
91 * Initalizes the guest context runtime library.
92 *
93 * @returns iprt status code.
94 *
95 * @param u64ProgramStartNanoTS The startup timestamp.
96 */
97RTGCDECL(int) RTGCInit(uint64_t u64ProgramStartNanoTS);
98
99/**
100 * Terminates the guest context runtime library.
101 */
102RTGCDECL(void) RTGCTerm(void);
103#endif
104
105
106/** @} */
107
108/** @} */
109
110__END_DECLS
111
112
113#endif
114
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