initterm.h revision f25c2612832b605961e651736ef27c3833960c0f
49d36b55bcf206ced156a303dab448a75fac001bvboxsync/** @file
c97989161fbe75bc14cea477a5443bbf474dd3advboxsync * innotek Portable Runtime - Runtime Init/Term.
49d36b55bcf206ced156a303dab448a75fac001bvboxsync */
49d36b55bcf206ced156a303dab448a75fac001bvboxsync
49d36b55bcf206ced156a303dab448a75fac001bvboxsync/*
c97989161fbe75bc14cea477a5443bbf474dd3advboxsync * Copyright (C) 2006-2007 innotek GmbH
49d36b55bcf206ced156a303dab448a75fac001bvboxsync *
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * available from http://www.virtualbox.org. This file is free software;
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * you can redistribute it and/or modify it under the terms of the GNU
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * General Public License as published by the Free Software Foundation,
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * in version 2 as it comes in the "COPYING" file of the VirtualBox OSE
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * distribution. VirtualBox OSE is distributed in the hope that it will
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * be useful, but WITHOUT ANY WARRANTY of any kind.
49d36b55bcf206ced156a303dab448a75fac001bvboxsync *
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * If you received this file as part of a commercial VirtualBox
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * distribution, then only the terms of your commercial VirtualBox
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * license agreement apply instead of the previous paragraph.
49d36b55bcf206ced156a303dab448a75fac001bvboxsync */
49d36b55bcf206ced156a303dab448a75fac001bvboxsync
49d36b55bcf206ced156a303dab448a75fac001bvboxsync#ifndef __iprt_initterm_h__
49d36b55bcf206ced156a303dab448a75fac001bvboxsync#define __iprt_initterm_h__
49d36b55bcf206ced156a303dab448a75fac001bvboxsync
49d36b55bcf206ced156a303dab448a75fac001bvboxsync#include <iprt/cdefs.h>
49d36b55bcf206ced156a303dab448a75fac001bvboxsync#include <iprt/types.h>
49d36b55bcf206ced156a303dab448a75fac001bvboxsync
49d36b55bcf206ced156a303dab448a75fac001bvboxsync
49d36b55bcf206ced156a303dab448a75fac001bvboxsync__BEGIN_DECLS
49d36b55bcf206ced156a303dab448a75fac001bvboxsync
c97989161fbe75bc14cea477a5443bbf474dd3advboxsync/** @defgroup grp_rt innotek Portable Runtime APIs
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * @{
49d36b55bcf206ced156a303dab448a75fac001bvboxsync */
49d36b55bcf206ced156a303dab448a75fac001bvboxsync
49d36b55bcf206ced156a303dab448a75fac001bvboxsync/** @defgroup grp_rt_initterm Init / Term
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * @{
49d36b55bcf206ced156a303dab448a75fac001bvboxsync */
49d36b55bcf206ced156a303dab448a75fac001bvboxsync
49d36b55bcf206ced156a303dab448a75fac001bvboxsync#ifdef IN_RING3
49d36b55bcf206ced156a303dab448a75fac001bvboxsync/**
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * Initalizes the runtime library.
49d36b55bcf206ced156a303dab448a75fac001bvboxsync *
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * @returns iprt status code.
49d36b55bcf206ced156a303dab448a75fac001bvboxsync *
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * @param fInitSUPLib Set if SUPInit() shall be called during init (default).
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * Clear if not to call it.
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * @param cbReserve The number of bytes of contiguous memory that should be reserved by
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * the runtime / support library.
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * Set this to 0 if no reservation is required. (default)
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * Set this to ~(size_t)0 if the maximum amount supported by the VM is to be
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * attempted reserved, or the maximum available.
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * This argument only applies if fInitSUPLib is true and we're in ring-3 HC.
49d36b55bcf206ced156a303dab448a75fac001bvboxsync */
49d36b55bcf206ced156a303dab448a75fac001bvboxsyncRTR3DECL(int) RTR3Init(
49d36b55bcf206ced156a303dab448a75fac001bvboxsync#ifdef __cplusplus
49d36b55bcf206ced156a303dab448a75fac001bvboxsync bool fInitSUPLib = true,
49d36b55bcf206ced156a303dab448a75fac001bvboxsync size_t cbReserve = 0
49d36b55bcf206ced156a303dab448a75fac001bvboxsync#else
49d36b55bcf206ced156a303dab448a75fac001bvboxsync bool fInitSUPLib,
49d36b55bcf206ced156a303dab448a75fac001bvboxsync size_t cbReserve
49d36b55bcf206ced156a303dab448a75fac001bvboxsync#endif
49d36b55bcf206ced156a303dab448a75fac001bvboxsync );
49d36b55bcf206ced156a303dab448a75fac001bvboxsync
49d36b55bcf206ced156a303dab448a75fac001bvboxsync/**
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * Terminates the runtime library.
49d36b55bcf206ced156a303dab448a75fac001bvboxsync */
49d36b55bcf206ced156a303dab448a75fac001bvboxsyncRTR3DECL(void) RTR3Term(void);
49d36b55bcf206ced156a303dab448a75fac001bvboxsync#endif
49d36b55bcf206ced156a303dab448a75fac001bvboxsync
49d36b55bcf206ced156a303dab448a75fac001bvboxsync
49d36b55bcf206ced156a303dab448a75fac001bvboxsync#ifdef IN_RING0
49d36b55bcf206ced156a303dab448a75fac001bvboxsync/**
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * Initalizes the ring-0 driver runtime library.
49d36b55bcf206ced156a303dab448a75fac001bvboxsync *
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * @returns iprt status code.
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * @param fReserved Flags reserved for the future.
49d36b55bcf206ced156a303dab448a75fac001bvboxsync */
49d36b55bcf206ced156a303dab448a75fac001bvboxsyncRTR0DECL(int) RTR0Init(unsigned fReserved);
49d36b55bcf206ced156a303dab448a75fac001bvboxsync
49d36b55bcf206ced156a303dab448a75fac001bvboxsync/**
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * Terminates the ring-0 driver runtime library.
49d36b55bcf206ced156a303dab448a75fac001bvboxsync */
49d36b55bcf206ced156a303dab448a75fac001bvboxsyncRTR0DECL(void) RTR0Term(void);
49d36b55bcf206ced156a303dab448a75fac001bvboxsync#endif
49d36b55bcf206ced156a303dab448a75fac001bvboxsync
f25c2612832b605961e651736ef27c3833960c0fvboxsync#ifdef IN_GC
f25c2612832b605961e651736ef27c3833960c0fvboxsync/**
f25c2612832b605961e651736ef27c3833960c0fvboxsync * Initalizes the guest context runtime library.
f25c2612832b605961e651736ef27c3833960c0fvboxsync *
f25c2612832b605961e651736ef27c3833960c0fvboxsync * @returns iprt status code.
f25c2612832b605961e651736ef27c3833960c0fvboxsync *
f25c2612832b605961e651736ef27c3833960c0fvboxsync * @param u64ProgramStartNanoTS The startup timestamp.
f25c2612832b605961e651736ef27c3833960c0fvboxsync */
f25c2612832b605961e651736ef27c3833960c0fvboxsyncRTGCDECL(int) RTGCInit(uint64_t u64ProgramStartNanoTS);
f25c2612832b605961e651736ef27c3833960c0fvboxsync
f25c2612832b605961e651736ef27c3833960c0fvboxsync/**
f25c2612832b605961e651736ef27c3833960c0fvboxsync * Terminates the guest context runtime library.
f25c2612832b605961e651736ef27c3833960c0fvboxsync */
f25c2612832b605961e651736ef27c3833960c0fvboxsyncRTGCDECL(void) RTGCTerm(void);
f25c2612832b605961e651736ef27c3833960c0fvboxsync#endif
f25c2612832b605961e651736ef27c3833960c0fvboxsync
f25c2612832b605961e651736ef27c3833960c0fvboxsync
49d36b55bcf206ced156a303dab448a75fac001bvboxsync/** @} */
49d36b55bcf206ced156a303dab448a75fac001bvboxsync
49d36b55bcf206ced156a303dab448a75fac001bvboxsync/** @} */
49d36b55bcf206ced156a303dab448a75fac001bvboxsync
49d36b55bcf206ced156a303dab448a75fac001bvboxsync__END_DECLS
49d36b55bcf206ced156a303dab448a75fac001bvboxsync
49d36b55bcf206ced156a303dab448a75fac001bvboxsync
49d36b55bcf206ced156a303dab448a75fac001bvboxsync#endif
49d36b55bcf206ced156a303dab448a75fac001bvboxsync