cfgm.h revision 0b74a2f80aba476dc8be8bc1c63891fc53945986
e5bfc5c34142a7550be3564a8e01a037b1db5b31vboxsync * CFGM - Configuration Manager.
e5bfc5c34142a7550be3564a8e01a037b1db5b31vboxsync * Copyright (C) 2006-2010 Oracle Corporation
e5bfc5c34142a7550be3564a8e01a037b1db5b31vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
e5bfc5c34142a7550be3564a8e01a037b1db5b31vboxsync * available from http://www.virtualbox.org. This file is free software;
e5bfc5c34142a7550be3564a8e01a037b1db5b31vboxsync * you can redistribute it and/or modify it under the terms of the GNU
e5bfc5c34142a7550be3564a8e01a037b1db5b31vboxsync * 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.
e5bfc5c34142a7550be3564a8e01a037b1db5b31vboxsync/** @defgroup grp_cfgm The Configuration Manager API
e5bfc5c34142a7550be3564a8e01a037b1db5b31vboxsync * Configuration manager value type.
e5bfc5c34142a7550be3564a8e01a037b1db5b31vboxsync /** Integer value. */
e5bfc5c34142a7550be3564a8e01a037b1db5b31vboxsync /** String value. */
e5bfc5c34142a7550be3564a8e01a037b1db5b31vboxsync /** Bytestring value. */
e5bfc5c34142a7550be3564a8e01a037b1db5b31vboxsync/** Pointer to configuration manager property type. */
e5bfc5c34142a7550be3564a8e01a037b1db5b31vboxsync/** @defgroup grp_cfgm_r3 The CFGM Host Context Ring-3 API
e5bfc5c34142a7550be3564a8e01a037b1db5b31vboxsync * @ingroup grp_cfgm
e5bfc5c34142a7550be3564a8e01a037b1db5b31vboxsync /** pvConfig points to nothing, use defaults. */
e5bfc5c34142a7550be3564a8e01a037b1db5b31vboxsync /** pvConfig points to a IMachine interface. */
e5bfc5c34142a7550be3564a8e01a037b1db5b31vboxsync * CFGM init callback for constructing the configuration tree.
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsync * This is called from the emulation thread, and the one interfacing the VM
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsync * can make any necessary per-thread initializations at this point.
44bb1f16ce587f939ae4479fbaab6f3bd6de5835vboxsync * @returns VBox status code.
66fcb39649c3b5ba2787165459f2e357ed1638edvboxsync * @param pVM VM handle.
e5bfc5c34142a7550be3564a8e01a037b1db5b31vboxsync * @param pvUser The argument supplied to VMR3Create().
e5bfc5c34142a7550be3564a8e01a037b1db5b31vboxsynctypedef DECLCALLBACK(int) FNCFGMCONSTRUCTOR(PVM pVM, void *pvUser);
e5bfc5c34142a7550be3564a8e01a037b1db5b31vboxsync/** Pointer to a FNCFGMCONSTRUCTOR(). */
e5bfc5c34142a7550be3564a8e01a037b1db5b31vboxsyncVMMR3DECL(int) CFGMR3Init(PVM pVM, PFNCFGMCONSTRUCTOR pfnCFGMConstructor, void *pvUser);
e5bfc5c34142a7550be3564a8e01a037b1db5b31vboxsyncVMMR3DECL(int) CFGMR3InsertSubTree(PCFGMNODE pNode, const char *pszName, PCFGMNODE pSubTree, PCFGMNODE *ppChild);
e5bfc5c34142a7550be3564a8e01a037b1db5b31vboxsyncVMMR3DECL(int) CFGMR3InsertNode(PCFGMNODE pNode, const char *pszName, PCFGMNODE *ppChild);
e5bfc5c34142a7550be3564a8e01a037b1db5b31vboxsyncVMMR3DECL(int) CFGMR3InsertNodeF(PCFGMNODE pNode, PCFGMNODE *ppChild, const char *pszNameFormat, ...);
e5bfc5c34142a7550be3564a8e01a037b1db5b31vboxsyncVMMR3DECL(int) CFGMR3InsertNodeFV(PCFGMNODE pNode, PCFGMNODE *ppChild, const char *pszNameFormat, va_list Args);
d534750e38f9bab40fd4ab06d176fea25ec91c44vboxsyncVMMR3DECL(void) CFGMR3SetRestrictedRoot(PCFGMNODE pNode);
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsyncVMMR3DECL(int) CFGMR3InsertInteger(PCFGMNODE pNode, const char *pszName, uint64_t u64Integer);
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsyncVMMR3DECL(int) CFGMR3InsertString(PCFGMNODE pNode, const char *pszName, const char *pszString);
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsyncVMMR3DECL(int) CFGMR3InsertStringN(PCFGMNODE pNode, const char *pszName, const char *pszString, size_t cchString);
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsyncVMMR3DECL(int) CFGMR3InsertStringF(PCFGMNODE pNode, const char *pszName, const char *pszFormat, ...);
44bb1f16ce587f939ae4479fbaab6f3bd6de5835vboxsyncVMMR3DECL(int) CFGMR3InsertStringFV(PCFGMNODE pNode, const char *pszName, const char *pszFormat, va_list va);
44bb1f16ce587f939ae4479fbaab6f3bd6de5835vboxsyncVMMR3DECL(int) CFGMR3InsertStringW(PCFGMNODE pNode, const char *pszName, PCRTUTF16 pwszValue);
44bb1f16ce587f939ae4479fbaab6f3bd6de5835vboxsyncVMMR3DECL(int) CFGMR3InsertBytes(PCFGMNODE pNode, const char *pszName, const void *pvBytes, size_t cbBytes);
44bb1f16ce587f939ae4479fbaab6f3bd6de5835vboxsyncVMMR3DECL(int) CFGMR3RemoveValue(PCFGMNODE pNode, const char *pszName);
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsyncVMMR3DECL(int) CFGMR3QueryType( PCFGMNODE pNode, const char *pszName, PCFGMVALUETYPE penmType);
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsyncVMMR3DECL(int) CFGMR3QuerySize( PCFGMNODE pNode, const char *pszName, size_t *pcb);
44bb1f16ce587f939ae4479fbaab6f3bd6de5835vboxsyncVMMR3DECL(int) CFGMR3QueryInteger( PCFGMNODE pNode, const char *pszName, uint64_t *pu64);
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsyncVMMR3DECL(int) CFGMR3QueryIntegerDef( PCFGMNODE pNode, const char *pszName, uint64_t *pu64, uint64_t u64Def);
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsyncVMMR3DECL(int) CFGMR3QueryString( PCFGMNODE pNode, const char *pszName, char *pszString, size_t cchString);
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsyncVMMR3DECL(int) CFGMR3QueryStringDef( PCFGMNODE pNode, const char *pszName, char *pszString, size_t cchString, const char *pszDef);
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsyncVMMR3DECL(int) CFGMR3QueryBytes( PCFGMNODE pNode, const char *pszName, void *pvData, size_t cbData);
d534750e38f9bab40fd4ab06d176fea25ec91c44vboxsync/** @name Helpers
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsyncVMMR3DECL(int) CFGMR3QueryU64( PCFGMNODE pNode, const char *pszName, uint64_t *pu64);
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsyncVMMR3DECL(int) CFGMR3QueryU64Def( PCFGMNODE pNode, const char *pszName, uint64_t *pu64, uint64_t u64Def);
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsyncVMMR3DECL(int) CFGMR3QueryS64( PCFGMNODE pNode, const char *pszName, int64_t *pi64);
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsyncVMMR3DECL(int) CFGMR3QueryS64Def( PCFGMNODE pNode, const char *pszName, int64_t *pi64, int64_t i64Def);
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsyncVMMR3DECL(int) CFGMR3QueryU32( PCFGMNODE pNode, const char *pszName, uint32_t *pu32);
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsyncVMMR3DECL(int) CFGMR3QueryU32Def( PCFGMNODE pNode, const char *pszName, uint32_t *pu32, uint32_t u32Def);
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsyncVMMR3DECL(int) CFGMR3QueryS32( PCFGMNODE pNode, const char *pszName, int32_t *pi32);
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsyncVMMR3DECL(int) CFGMR3QueryS32Def( PCFGMNODE pNode, const char *pszName, int32_t *pi32, int32_t i32Def);
e5bfc5c34142a7550be3564a8e01a037b1db5b31vboxsyncVMMR3DECL(int) CFGMR3QueryU16( PCFGMNODE pNode, const char *pszName, uint16_t *pu16);
e5bfc5c34142a7550be3564a8e01a037b1db5b31vboxsyncVMMR3DECL(int) CFGMR3QueryU16Def( PCFGMNODE pNode, const char *pszName, uint16_t *pu16, uint16_t u16Def);
e5bfc5c34142a7550be3564a8e01a037b1db5b31vboxsyncVMMR3DECL(int) CFGMR3QueryS16( PCFGMNODE pNode, const char *pszName, int16_t *pi16);
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsyncVMMR3DECL(int) CFGMR3QueryS16Def( PCFGMNODE pNode, const char *pszName, int16_t *pi16, int16_t i16Def);
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsyncVMMR3DECL(int) CFGMR3QueryU8( PCFGMNODE pNode, const char *pszName, uint8_t *pu8);
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsyncVMMR3DECL(int) CFGMR3QueryU8Def( PCFGMNODE pNode, const char *pszName, uint8_t *pu8, uint8_t u8Def);
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsyncVMMR3DECL(int) CFGMR3QueryS8( PCFGMNODE pNode, const char *pszName, int8_t *pi8);
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsyncVMMR3DECL(int) CFGMR3QueryS8Def( PCFGMNODE pNode, const char *pszName, int8_t *pi8, int8_t i8Def);
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsyncVMMR3DECL(int) CFGMR3QueryBool( PCFGMNODE pNode, const char *pszName, bool *pf);
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsyncVMMR3DECL(int) CFGMR3QueryBoolDef( PCFGMNODE pNode, const char *pszName, bool *pf, bool fDef);
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsyncVMMR3DECL(int) CFGMR3QueryPort( PCFGMNODE pNode, const char *pszName, PRTIOPORT pPort);
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsyncVMMR3DECL(int) CFGMR3QueryPortDef( PCFGMNODE pNode, const char *pszName, PRTIOPORT pPort, RTIOPORT PortDef);
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsyncVMMR3DECL(int) CFGMR3QueryUInt( PCFGMNODE pNode, const char *pszName, unsigned int *pu);
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsyncVMMR3DECL(int) CFGMR3QueryUIntDef( PCFGMNODE pNode, const char *pszName, unsigned int *pu, unsigned int uDef);
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsyncVMMR3DECL(int) CFGMR3QuerySInt( PCFGMNODE pNode, const char *pszName, signed int *pi);
d534750e38f9bab40fd4ab06d176fea25ec91c44vboxsyncVMMR3DECL(int) CFGMR3QuerySIntDef( PCFGMNODE pNode, const char *pszName, signed int *pi, signed int iDef);
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsyncVMMR3DECL(int) CFGMR3QueryPtr( PCFGMNODE pNode, const char *pszName, void **ppv);
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsyncVMMR3DECL(int) CFGMR3QueryPtrDef( PCFGMNODE pNode, const char *pszName, void **ppv, void *pvDef);
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsyncVMMR3DECL(int) CFGMR3QueryGCPtr( PCFGMNODE pNode, const char *pszName, PRTGCPTR pGCPtr);
44bb1f16ce587f939ae4479fbaab6f3bd6de5835vboxsyncVMMR3DECL(int) CFGMR3QueryGCPtrDef( PCFGMNODE pNode, const char *pszName, PRTGCPTR pGCPtr, RTGCPTR GCPtrDef);
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsyncVMMR3DECL(int) CFGMR3QueryGCPtrU( PCFGMNODE pNode, const char *pszName, PRTGCUINTPTR pGCPtr);
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsyncVMMR3DECL(int) CFGMR3QueryGCPtrUDef( PCFGMNODE pNode, const char *pszName, PRTGCUINTPTR pGCPtr, RTGCUINTPTR GCPtrDef);
d534750e38f9bab40fd4ab06d176fea25ec91c44vboxsyncVMMR3DECL(int) CFGMR3QueryGCPtrS( PCFGMNODE pNode, const char *pszName, PRTGCINTPTR pGCPtr);
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsyncVMMR3DECL(int) CFGMR3QueryGCPtrSDef( PCFGMNODE pNode, const char *pszName, PRTGCINTPTR pGCPtr, RTGCINTPTR GCPtrDef);
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsyncVMMR3DECL(int) CFGMR3QueryStringAlloc( PCFGMNODE pNode, const char *pszName, char **ppszString);
d534750e38f9bab40fd4ab06d176fea25ec91c44vboxsyncVMMR3DECL(int) CFGMR3QueryStringAllocDef(PCFGMNODE pNode, const char *pszName, char **ppszString, const char *pszDef);
44bb1f16ce587f939ae4479fbaab6f3bd6de5835vboxsync/** @name Tree Navigation and Enumeration.
44bb1f16ce587f939ae4479fbaab6f3bd6de5835vboxsyncVMMR3DECL(PCFGMNODE) CFGMR3GetParent(PCFGMNODE pNode);
d534750e38f9bab40fd4ab06d176fea25ec91c44vboxsyncVMMR3DECL(PCFGMNODE) CFGMR3GetParentEx(PVM pVM, PCFGMNODE pNode);
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsyncVMMR3DECL(PCFGMNODE) CFGMR3GetChild(PCFGMNODE pNode, const char *pszPath);
d534750e38f9bab40fd4ab06d176fea25ec91c44vboxsyncVMMR3DECL(PCFGMNODE) CFGMR3GetChildF(PCFGMNODE pNode, const char *pszPathFormat, ...);
d534750e38f9bab40fd4ab06d176fea25ec91c44vboxsyncVMMR3DECL(PCFGMNODE) CFGMR3GetChildFV(PCFGMNODE pNode, const char *pszPathFormat, va_list Args);
d534750e38f9bab40fd4ab06d176fea25ec91c44vboxsyncVMMR3DECL(PCFGMNODE) CFGMR3GetFirstChild(PCFGMNODE pNode);
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsyncVMMR3DECL(PCFGMNODE) CFGMR3GetNextChild(PCFGMNODE pCur);
e5bfc5c34142a7550be3564a8e01a037b1db5b31vboxsyncVMMR3DECL(int) CFGMR3GetName(PCFGMNODE pCur, char *pszName, size_t cchName);
e5bfc5c34142a7550be3564a8e01a037b1db5b31vboxsyncVMMR3DECL(bool) CFGMR3AreChildrenValid(PCFGMNODE pNode, const char *pszzValid);
d534750e38f9bab40fd4ab06d176fea25ec91c44vboxsyncVMMR3DECL(PCFGMLEAF) CFGMR3GetFirstValue(PCFGMNODE pCur);
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsyncVMMR3DECL(PCFGMLEAF) CFGMR3GetNextValue(PCFGMLEAF pCur);
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsyncVMMR3DECL(int) CFGMR3GetValueName(PCFGMLEAF pCur, char *pszName, size_t cchName);
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsyncVMMR3DECL(size_t) CFGMR3GetValueNameLen(PCFGMLEAF pCur);
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsyncVMMR3DECL(CFGMVALUETYPE) CFGMR3GetValueType(PCFGMLEAF pCur);
d534750e38f9bab40fd4ab06d176fea25ec91c44vboxsyncVMMR3DECL(bool) CFGMR3AreValuesValid(PCFGMNODE pNode, const char *pszzValid);
e5bfc5c34142a7550be3564a8e01a037b1db5b31vboxsyncVMMR3DECL(int) CFGMR3ValidateConfig(PCFGMNODE pNode, const char *pszNode,
e5bfc5c34142a7550be3564a8e01a037b1db5b31vboxsync const char *pszValidValues, const char *pszValidNodes,
e5f6ad85110ebdc7256808a0a3a8ce330370be6avboxsync#endif /* IN_RING3 */