VirtualBox

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

Last change on this file since 93015 was 93015, checked in by vboxsync, 3 years ago

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