initterm.h revision 0120c35c41a827e23a6e04fbd59299a187e0b22c
5b281ba489ca18f0380d7efc7a5108b606cce449vboxsync * IPRT - Runtime Init/Term.
c58f1213e628a545081c70e26c6b67a841cff880vboxsync * Copyright (C) 2006-2007 Sun Microsystems, Inc.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * available from http://www.virtualbox.org. This file is free software;
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * you can redistribute it and/or modify it under the terms of the GNU
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * General Public License (GPL) as published by the Free Software
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * The contents of this file may alternatively be used under the terms
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * of the Common Development and Distribution License Version 1.0
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * VirtualBox OSE distribution, in which case the provisions of the
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * CDDL are applicable instead of those of the GPL.
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * You may elect to license modified versions of this file under the
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * terms and conditions of either the GPL or the CDDL or both.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
154e1d5579ca6c8bee571a8d1ced5d76a0234030vboxsync * Clara, CA 95054 USA or visit http://www.sun.com if you need
154e1d5579ca6c8bee571a8d1ced5d76a0234030vboxsync * additional information or have any questions.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync/** @defgroup grp_rt IPRT APIs
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync/** @defgroup grp_rt_initterm Init / Term
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * Initializes the runtime library.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * @returns iprt status code.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * Initializes the runtime library and try initialize SUPLib too.
cb13ee8e628d04a773894bf4f9e8047d74f2ee21vboxsync * @returns IPRT status code.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * @param pszProgramPath The path to the program file.
40af749e457b7d704c869ea986a042f0d4b6e09avboxsync * @remarks Failure to initialize SUPLib is ignored.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * Initializes the runtime library passing it the program path.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * @returns IPRT status code.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * @param pszProgramPath The path to the program file.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsyncRTR3DECL(int) RTR3InitWithProgramPath(const char *pszProgramPath);
cb13ee8e628d04a773894bf4f9e8047d74f2ee21vboxsync * Initializes the runtime library passing it the program path,
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * and try initialize SUPLib too (failures ignored).
40af749e457b7d704c869ea986a042f0d4b6e09avboxsync * @returns IPRT status code.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * @param pszProgramPath The path to the program file.
cb13ee8e628d04a773894bf4f9e8047d74f2ee21vboxsync * @remarks Failure to initialize SUPLib is ignored.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsyncRTR3DECL(int) RTR3InitAndSUPLibWithProgramPath(const char *pszProgramPath);
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * Initializes the runtime library and possibly also SUPLib too.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * Avoid this interface, it's not considered stable.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * @returns IPRT status code.
cb13ee8e628d04a773894bf4f9e8047d74f2ee21vboxsync * @param iVersion The interface version. Must be 0 atm.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * @param pszProgramPath The program path. Pass NULL if we're to figure it out ourselves.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * @param fInitSUPLib Whether to initialize the support library or not.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsyncRTR3DECL(int) RTR3InitEx(uint32_t iVersion, const char *pszProgramPath, bool fInitSUPLib);
cb13ee8e628d04a773894bf4f9e8047d74f2ee21vboxsync * Terminates the runtime library.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync#endif /* IN_RING3 */
cb13ee8e628d04a773894bf4f9e8047d74f2ee21vboxsync * Initalizes the ring-0 driver runtime library.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * @returns iprt status code.
40af749e457b7d704c869ea986a042f0d4b6e09avboxsync * @param fReserved Flags reserved for the future.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * Terminates the ring-0 driver runtime library.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * Initializes the raw-mode context runtime library.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @returns iprt status code.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @param u64ProgramStartNanoTS The startup timestamp.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsyncRTGCDECL(int) RTRCInit(uint64_t u64ProgramStartNanoTS);
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * Terminates the raw-mode context runtime library.