VirtualBox

source: vbox/trunk/include/VBox/vmm/cfgm.h@ 79629

Last change on this file since 79629 was 76585, checked in by vboxsync, 6 years ago

*: scm --fix-header-guard-endif
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 12.3 KB
Line 
1/** @file
2 * CFGM - Configuration Manager.
3 */
4
5/*
6 * Copyright (C) 2006-2019 Oracle Corporation
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 VBOX_INCLUDED_vmm_cfgm_h
27#define VBOX_INCLUDED_vmm_cfgm_h
28#ifndef RT_WITHOUT_PRAGMA_ONCE
29# pragma once
30#endif
31
32#include <VBox/types.h>
33#include <iprt/stdarg.h>
34
35/** @defgroup grp_cfgm The Configuration Manager API
36 * @ingroup grp_vmm
37 * @{
38 */
39
40/**
41 * Configuration manager value type.
42 */
43typedef enum CFGMVALUETYPE
44{
45 /** Integer value. */
46 CFGMVALUETYPE_INTEGER = 1,
47 /** String value. */
48 CFGMVALUETYPE_STRING,
49 /** Bytestring value. */
50 CFGMVALUETYPE_BYTES
51} CFGMVALUETYPE;
52/** Pointer to configuration manager property type. */
53typedef CFGMVALUETYPE *PCFGMVALUETYPE;
54
55
56
57RT_C_DECLS_BEGIN
58
59#ifdef IN_RING3
60/** @defgroup grp_cfgm_r3 The CFGM Host Context Ring-3 API
61 * @{
62 */
63
64typedef enum CFGMCONFIGTYPE
65{
66 /** pvConfig points to nothing, use defaults. */
67 CFGMCONFIGTYPE_NONE = 0,
68 /** pvConfig points to a IMachine interface. */
69 CFGMCONFIGTYPE_IMACHINE
70} CFGMCONFIGTYPE;
71
72
73/**
74 * CFGM init callback for constructing the configuration tree.
75 *
76 * This is called from the emulation thread, and the one interfacing the VM
77 * can make any necessary per-thread initializations at this point.
78 *
79 * @returns VBox status code.
80 * @param pUVM The user mode VM handle.
81 * @param pVM The cross context VM structure.
82 * @param pvUser The argument supplied to VMR3Create().
83 */
84typedef DECLCALLBACK(int) FNCFGMCONSTRUCTOR(PUVM pUVM, PVM pVM, void *pvUser);
85/** Pointer to a FNCFGMCONSTRUCTOR(). */
86typedef FNCFGMCONSTRUCTOR *PFNCFGMCONSTRUCTOR;
87
88VMMR3DECL(int) CFGMR3Init(PVM pVM, PFNCFGMCONSTRUCTOR pfnCFGMConstructor, void *pvUser);
89VMMR3DECL(int) CFGMR3Term(PVM pVM);
90VMMR3DECL(int) CFGMR3ConstructDefaultTree(PVM pVM);
91
92VMMR3DECL(PCFGMNODE) CFGMR3CreateTree(PUVM pUVM);
93VMMR3DECL(int) CFGMR3DestroyTree(PCFGMNODE pRoot);
94VMMR3DECL(void) CFGMR3Dump(PCFGMNODE pRoot);
95VMMR3DECL(int) CFGMR3DuplicateSubTree(PCFGMNODE pRoot, PCFGMNODE *ppCopy);
96VMMR3DECL(int) CFGMR3ReplaceSubTree(PCFGMNODE pRoot, PCFGMNODE pNewRoot);
97VMMR3DECL(int) CFGMR3InsertSubTree(PCFGMNODE pNode, const char *pszName, PCFGMNODE pSubTree, PCFGMNODE *ppChild);
98VMMR3DECL(int) CFGMR3InsertNode(PCFGMNODE pNode, const char *pszName, PCFGMNODE *ppChild);
99VMMR3DECL(int) CFGMR3InsertNodeF(PCFGMNODE pNode, PCFGMNODE *ppChild,
100 const char *pszNameFormat, ...) RT_IPRT_FORMAT_ATTR(3, 4);
101VMMR3DECL(int) CFGMR3InsertNodeFV(PCFGMNODE pNode, PCFGMNODE *ppChild,
102 const char *pszNameFormat, va_list Args) RT_IPRT_FORMAT_ATTR(3, 0);
103VMMR3DECL(void) CFGMR3SetRestrictedRoot(PCFGMNODE pNode);
104VMMR3DECL(void) CFGMR3RemoveNode(PCFGMNODE pNode);
105VMMR3DECL(int) CFGMR3InsertInteger(PCFGMNODE pNode, const char *pszName, uint64_t u64Integer);
106VMMR3DECL(int) CFGMR3InsertString(PCFGMNODE pNode, const char *pszName, const char *pszString);
107VMMR3DECL(int) CFGMR3InsertStringN(PCFGMNODE pNode, const char *pszName, const char *pszString, size_t cchString);
108VMMR3DECL(int) CFGMR3InsertStringF(PCFGMNODE pNode, const char *pszName,
109 const char *pszFormat, ...) RT_IPRT_FORMAT_ATTR(3, 4);
110VMMR3DECL(int) CFGMR3InsertStringFV(PCFGMNODE pNode, const char *pszName,
111 const char *pszFormat, va_list va) RT_IPRT_FORMAT_ATTR(3, 0);
112VMMR3DECL(int) CFGMR3InsertStringW(PCFGMNODE pNode, const char *pszName, PCRTUTF16 pwszValue);
113VMMR3DECL(int) CFGMR3InsertBytes(PCFGMNODE pNode, const char *pszName, const void *pvBytes, size_t cbBytes);
114VMMR3DECL(int) CFGMR3InsertValue(PCFGMNODE pNode, PCFGMLEAF pValue);
115VMMR3DECL(int) CFGMR3RemoveValue(PCFGMNODE pNode, const char *pszName);
116
117/** @name CFGMR3CopyTree flags.
118 * @{ */
119/** Reserved value disposition \#0. */
120#define CFGM_COPY_FLAGS_RESERVED_VALUE_DISP_0 UINT32_C(0x00000000)
121/** Reserved value disposition \#1. */
122#define CFGM_COPY_FLAGS_RESERVED_VALUE_DISP_1 UINT32_C(0x00000001)
123/** Replace exiting values. */
124#define CFGM_COPY_FLAGS_REPLACE_VALUES UINT32_C(0x00000002)
125/** Ignore exiting values. */
126#define CFGM_COPY_FLAGS_IGNORE_EXISTING_VALUES UINT32_C(0x00000003)
127/** Value disposition mask. */
128#define CFGM_COPY_FLAGS_VALUE_DISP_MASK UINT32_C(0x00000003)
129
130/** Replace exiting keys. */
131#define CFGM_COPY_FLAGS_RESERVED_KEY_DISP UINT32_C(0x00000000)
132/** Replace exiting keys. */
133#define CFGM_COPY_FLAGS_MERGE_KEYS UINT32_C(0x00000010)
134/** Replace exiting keys. */
135#define CFGM_COPY_FLAGS_REPLACE_KEYS UINT32_C(0x00000020)
136/** Ignore existing keys. */
137#define CFGM_COPY_FLAGS_IGNORE_EXISTING_KEYS UINT32_C(0x00000030)
138/** Key disposition. */
139#define CFGM_COPY_FLAGS_KEY_DISP_MASK UINT32_C(0x00000030)
140/** @} */
141VMMR3DECL(int) CFGMR3CopyTree(PCFGMNODE pDstTree, PCFGMNODE pSrcTree, uint32_t fFlags);
142
143VMMR3DECL(bool) CFGMR3Exists( PCFGMNODE pNode, const char *pszName);
144VMMR3DECL(int) CFGMR3QueryType( PCFGMNODE pNode, const char *pszName, PCFGMVALUETYPE penmType);
145VMMR3DECL(int) CFGMR3QuerySize( PCFGMNODE pNode, const char *pszName, size_t *pcb);
146VMMR3DECL(int) CFGMR3QueryInteger( PCFGMNODE pNode, const char *pszName, uint64_t *pu64);
147VMMR3DECL(int) CFGMR3QueryIntegerDef( PCFGMNODE pNode, const char *pszName, uint64_t *pu64, uint64_t u64Def);
148VMMR3DECL(int) CFGMR3QueryString( PCFGMNODE pNode, const char *pszName, char *pszString, size_t cchString);
149VMMR3DECL(int) CFGMR3QueryStringDef( PCFGMNODE pNode, const char *pszName, char *pszString, size_t cchString, const char *pszDef);
150VMMR3DECL(int) CFGMR3QueryBytes( PCFGMNODE pNode, const char *pszName, void *pvData, size_t cbData);
151
152
153/** @name Helpers
154 * @{
155 */
156VMMR3DECL(int) CFGMR3QueryU64( PCFGMNODE pNode, const char *pszName, uint64_t *pu64);
157VMMR3DECL(int) CFGMR3QueryU64Def( PCFGMNODE pNode, const char *pszName, uint64_t *pu64, uint64_t u64Def);
158VMMR3DECL(int) CFGMR3QueryS64( PCFGMNODE pNode, const char *pszName, int64_t *pi64);
159VMMR3DECL(int) CFGMR3QueryS64Def( PCFGMNODE pNode, const char *pszName, int64_t *pi64, int64_t i64Def);
160VMMR3DECL(int) CFGMR3QueryU32( PCFGMNODE pNode, const char *pszName, uint32_t *pu32);
161VMMR3DECL(int) CFGMR3QueryU32Def( PCFGMNODE pNode, const char *pszName, uint32_t *pu32, uint32_t u32Def);
162VMMR3DECL(int) CFGMR3QueryS32( PCFGMNODE pNode, const char *pszName, int32_t *pi32);
163VMMR3DECL(int) CFGMR3QueryS32Def( PCFGMNODE pNode, const char *pszName, int32_t *pi32, int32_t i32Def);
164VMMR3DECL(int) CFGMR3QueryU16( PCFGMNODE pNode, const char *pszName, uint16_t *pu16);
165VMMR3DECL(int) CFGMR3QueryU16Def( PCFGMNODE pNode, const char *pszName, uint16_t *pu16, uint16_t u16Def);
166VMMR3DECL(int) CFGMR3QueryS16( PCFGMNODE pNode, const char *pszName, int16_t *pi16);
167VMMR3DECL(int) CFGMR3QueryS16Def( PCFGMNODE pNode, const char *pszName, int16_t *pi16, int16_t i16Def);
168VMMR3DECL(int) CFGMR3QueryU8( PCFGMNODE pNode, const char *pszName, uint8_t *pu8);
169VMMR3DECL(int) CFGMR3QueryU8Def( PCFGMNODE pNode, const char *pszName, uint8_t *pu8, uint8_t u8Def);
170VMMR3DECL(int) CFGMR3QueryS8( PCFGMNODE pNode, const char *pszName, int8_t *pi8);
171VMMR3DECL(int) CFGMR3QueryS8Def( PCFGMNODE pNode, const char *pszName, int8_t *pi8, int8_t i8Def);
172VMMR3DECL(int) CFGMR3QueryBool( PCFGMNODE pNode, const char *pszName, bool *pf);
173VMMR3DECL(int) CFGMR3QueryBoolDef( PCFGMNODE pNode, const char *pszName, bool *pf, bool fDef);
174VMMR3DECL(int) CFGMR3QueryPort( PCFGMNODE pNode, const char *pszName, PRTIOPORT pPort);
175VMMR3DECL(int) CFGMR3QueryPortDef( PCFGMNODE pNode, const char *pszName, PRTIOPORT pPort, RTIOPORT PortDef);
176VMMR3DECL(int) CFGMR3QueryUInt( PCFGMNODE pNode, const char *pszName, unsigned int *pu);
177VMMR3DECL(int) CFGMR3QueryUIntDef( PCFGMNODE pNode, const char *pszName, unsigned int *pu, unsigned int uDef);
178VMMR3DECL(int) CFGMR3QuerySInt( PCFGMNODE pNode, const char *pszName, signed int *pi);
179VMMR3DECL(int) CFGMR3QuerySIntDef( PCFGMNODE pNode, const char *pszName, signed int *pi, signed int iDef);
180VMMR3DECL(int) CFGMR3QueryPtr( PCFGMNODE pNode, const char *pszName, void **ppv);
181VMMR3DECL(int) CFGMR3QueryPtrDef( PCFGMNODE pNode, const char *pszName, void **ppv, void *pvDef);
182VMMR3DECL(int) CFGMR3QueryGCPtr( PCFGMNODE pNode, const char *pszName, PRTGCPTR pGCPtr);
183VMMR3DECL(int) CFGMR3QueryGCPtrDef( PCFGMNODE pNode, const char *pszName, PRTGCPTR pGCPtr, RTGCPTR GCPtrDef);
184VMMR3DECL(int) CFGMR3QueryGCPtrU( PCFGMNODE pNode, const char *pszName, PRTGCUINTPTR pGCPtr);
185VMMR3DECL(int) CFGMR3QueryGCPtrUDef( PCFGMNODE pNode, const char *pszName, PRTGCUINTPTR pGCPtr, RTGCUINTPTR GCPtrDef);
186VMMR3DECL(int) CFGMR3QueryGCPtrS( PCFGMNODE pNode, const char *pszName, PRTGCINTPTR pGCPtr);
187VMMR3DECL(int) CFGMR3QueryGCPtrSDef( PCFGMNODE pNode, const char *pszName, PRTGCINTPTR pGCPtr, RTGCINTPTR GCPtrDef);
188VMMR3DECL(int) CFGMR3QueryStringAlloc( PCFGMNODE pNode, const char *pszName, char **ppszString);
189VMMR3DECL(int) CFGMR3QueryStringAllocDef(PCFGMNODE pNode, const char *pszName, char **ppszString, const char *pszDef);
190
191/** @} */
192
193/** @name Tree Navigation and Enumeration.
194 * @{
195 */
196VMMR3DECL(PCFGMNODE) CFGMR3GetRoot(PVM pVM);
197VMMR3DECL(PCFGMNODE) CFGMR3GetRootU(PUVM pUVM);
198VMMR3DECL(PCFGMNODE) CFGMR3GetParent(PCFGMNODE pNode);
199VMMR3DECL(PCFGMNODE) CFGMR3GetParentEx(PVM pVM, PCFGMNODE pNode);
200VMMR3DECL(PCFGMNODE) CFGMR3GetChild(PCFGMNODE pNode, const char *pszPath);
201VMMR3DECL(PCFGMNODE) CFGMR3GetChildF(PCFGMNODE pNode, const char *pszPathFormat, ...) RT_IPRT_FORMAT_ATTR(2, 3);
202VMMR3DECL(PCFGMNODE) CFGMR3GetChildFV(PCFGMNODE pNode, const char *pszPathFormat, va_list Args) RT_IPRT_FORMAT_ATTR(3, 0);
203VMMR3DECL(PCFGMNODE) CFGMR3GetFirstChild(PCFGMNODE pNode);
204VMMR3DECL(PCFGMNODE) CFGMR3GetNextChild(PCFGMNODE pCur);
205VMMR3DECL(int) CFGMR3GetName(PCFGMNODE pCur, char *pszName, size_t cchName);
206VMMR3DECL(size_t) CFGMR3GetNameLen(PCFGMNODE pCur);
207VMMR3DECL(bool) CFGMR3AreChildrenValid(PCFGMNODE pNode, const char *pszzValid);
208VMMR3DECL(PCFGMLEAF) CFGMR3GetFirstValue(PCFGMNODE pCur);
209VMMR3DECL(PCFGMLEAF) CFGMR3GetNextValue(PCFGMLEAF pCur);
210VMMR3DECL(int) CFGMR3GetValueName(PCFGMLEAF pCur, char *pszName, size_t cchName);
211VMMR3DECL(size_t) CFGMR3GetValueNameLen(PCFGMLEAF pCur);
212VMMR3DECL(CFGMVALUETYPE) CFGMR3GetValueType(PCFGMLEAF pCur);
213VMMR3DECL(bool) CFGMR3AreValuesValid(PCFGMNODE pNode, const char *pszzValid);
214VMMR3DECL(int) CFGMR3ValidateConfig(PCFGMNODE pNode, const char *pszNode,
215 const char *pszValidValues, const char *pszValidNodes,
216 const char *pszWho, uint32_t uInstance);
217
218/** @} */
219
220
221/** @} */
222#endif /* IN_RING3 */
223
224
225RT_C_DECLS_END
226
227/** @} */
228
229#endif /* !VBOX_INCLUDED_vmm_cfgm_h */
230
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