1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
|
/* $Id: VBoxServicePropCache.cpp $ */
/** @file
* VBoxServicePropCache - Guest property cache.
*/
/*
* Copyright (C) 2010 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* you can redistribute it and/or modify it under the terms of the GNU
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*/
/*******************************************************************************
* Header Files *
*******************************************************************************/
#include <iprt/assert.h>
#include <iprt/list.h>
#include <iprt/mem.h>
#include <iprt/string.h>
#include <VBox/VBoxGuestLib.h>
#include "VBoxServiceInternal.h"
#include "VBoxServiceUtils.h"
#include "VBoxServicePropCache.h"
/** Internal functions, not for public use. */
PVBOXSERVICEVEPROPCACHEENTRY vboxServicePropCacheFindInternal(PVBOXSERVICEVEPROPCACHE pCache, const char *pszName, uint32_t uFlags);
PVBOXSERVICEVEPROPCACHEENTRY vboxServicePropCacheInsertEntryInternal(PVBOXSERVICEVEPROPCACHE pCache, const char *pszName);
/** @todo Docs */
PVBOXSERVICEVEPROPCACHEENTRY vboxServicePropCacheFindInternal(PVBOXSERVICEVEPROPCACHE pCache, const char *pszName, uint32_t uFlags)
{
AssertPtr(pCache);
AssertPtr(pszName);
/** @todo This is a O(n) lookup, maybe improve this later to O(1) using a
* map.
* r=bird: Use a string space (RTstrSpace*). That is O(log n) in its current
* implementation (AVL tree). However, this is not important at the
* moment. */
PVBOXSERVICEVEPROPCACHEENTRY pNodeIt, pNode = NULL;
if (RT_SUCCESS(RTCritSectEnter(&pCache->CritSect)))
{
RTListForEach(&pCache->NodeHead, pNodeIt, VBOXSERVICEVEPROPCACHEENTRY, NodeSucc)
{
if (strcmp(pNodeIt->pszName, pszName) == 0)
{
pNode = pNodeIt;
break;
}
}
RTCritSectLeave(&pCache->CritSect);
}
return pNode;
}
/** @todo Docs */
PVBOXSERVICEVEPROPCACHEENTRY vboxServicePropCacheInsertEntryInternal(PVBOXSERVICEVEPROPCACHE pCache, const char *pszName)
{
AssertPtr(pszName);
PVBOXSERVICEVEPROPCACHEENTRY pNode = (PVBOXSERVICEVEPROPCACHEENTRY)RTMemAlloc(sizeof(VBOXSERVICEVEPROPCACHEENTRY));
if (pNode)
{
pNode->pszName = RTStrDup(pszName);
pNode->pszValue = NULL;
pNode->fFlags = 0;
pNode->pszValueReset = NULL;
int rc = RTCritSectEnter(&pCache->CritSect);
if (RT_SUCCESS(rc))
{
/*rc =*/ RTListAppend(&pCache->NodeHead, &pNode->NodeSucc);
rc = RTCritSectLeave(&pCache->CritSect);
}
}
return pNode;
}
/** @todo Docs */
int vboxServicePropCacheWritePropF(uint32_t u32ClientId, const char *pszName, uint32_t fFlags, const char *pszValueFormat, ...)
{
AssertPtr(pszName);
int rc;
if (pszValueFormat != NULL)
{
va_list va;
va_start(va, pszValueFormat);
char *pszValue;
if (RTStrAPrintfV(&pszValue, pszValueFormat, va) >= 0)
{
if (fFlags & VBOXSERVICEPROPCACHEFLAG_TRANSIENT)
{
/*
* Because a value can be temporary we have to make sure it also
* gets deleted when the property cache did not have the chance to
* gracefully clean it up (due to a hard VM reset etc), so set this
* guest property using the TRANSRESET flag..
*/
rc = VbglR3GuestPropWrite(u32ClientId, pszName, pszValue, "TRANSRESET");
if (rc == VERR_PARSE_ERROR)
{
/* Host does not support the "TRANSRESET" flag, so only
* use the "TRANSIENT" flag -- better than nothing :-). */
rc = VbglR3GuestPropWrite(u32ClientId, pszName, pszValue, "TRANSIENT");
/** @todo r=bird: Remember that the host doesn't support
* this. */
}
}
else
rc = VbglR3GuestPropWriteValue(u32ClientId, pszName, pszValue /* No transient flags set */);
RTStrFree(pszValue);
}
else
rc = VERR_NO_MEMORY;
va_end(va);
}
else
{
rc = VbglR3GuestPropWriteValue(u32ClientId, pszName, NULL);
}
return rc;
}
/**
* Creates a property cache.
*
* @returns IPRT status code.
* @param pCache Pointer to the cache.
* @param uClientId The HGCM handle of to the guest property service.
*/
int VBoxServicePropCacheCreate(PVBOXSERVICEVEPROPCACHE pCache, uint32_t uClientId)
{
AssertPtr(pCache);
/** @todo Prevent init the cache twice!
* r=bird: Use a magic. */
RTListInit(&pCache->NodeHead);
pCache->uClientID = uClientId;
return RTCritSectInit(&pCache->CritSect);
}
/**
* Updates a cache entry without submitting any changes to the host.
* This is handy for defining default values/flags.
*
* @returns VBox status code.
*
* @param pCache The property cache.
* @param pszName The property name.
* @param fFlags The property flags to set.
* @param pszValueReset The property reset value.
*/
int VBoxServicePropCacheUpdateEntry(PVBOXSERVICEVEPROPCACHE pCache,
const char *pszName, uint32_t fFlags, const char *pszValueReset)
{
AssertPtr(pCache);
AssertPtr(pszName);
PVBOXSERVICEVEPROPCACHEENTRY pNode = vboxServicePropCacheFindInternal(pCache, pszName, 0);
if (pNode == NULL)
pNode = vboxServicePropCacheInsertEntryInternal(pCache, pszName);
int rc;
if (pNode != NULL)
{
rc = RTCritSectEnter(&pCache->CritSect);
if (RT_SUCCESS(rc))
{
pNode->fFlags = fFlags;
if (pszValueReset)
{
if (pNode->pszValueReset)
RTStrFree(pNode->pszValueReset);
pNode->pszValueReset = RTStrDup(pszValueReset);
}
rc = RTCritSectLeave(&pCache->CritSect);
}
}
else
rc = VERR_NO_MEMORY;
return rc;
}
/**
* Updates the local guest property cache and writes it to HGCM if outdated.
*
* @returns VBox status code.
*
* @param pCache The property cache.
* @param pszName The property name.
* @param pszValueFormat The property format string. If this is NULL then
* the property will be deleted (if possible).
* @param ... Format arguments.
*/
int VBoxServicePropCacheUpdate(PVBOXSERVICEVEPROPCACHE pCache, const char *pszName, const char *pszValueFormat, ...)
{
AssertPtr(pCache);
Assert(pCache->uClientID);
AssertPtr(pszName);
/*
* Format the value first.
*/
char *pszValue = NULL;
if (pszValueFormat)
{
va_list va;
va_start(va, pszValueFormat);
RTStrAPrintfV(&pszValue, pszValueFormat, va);
va_end(va);
if (!pszValue)
return VERR_NO_STR_MEMORY;
}
PVBOXSERVICEVEPROPCACHEENTRY pNode = vboxServicePropCacheFindInternal(pCache, pszName, 0);
/* Lock the cache. */
int rc = RTCritSectEnter(&pCache->CritSect);
if (RT_SUCCESS(rc))
{
if (pNode == NULL)
pNode = vboxServicePropCacheInsertEntryInternal(pCache, pszName);
AssertPtr(pNode);
if (pszValue) /* Do we have a value to check for? */
{
bool fUpdate = false;
/* Always update this property, no matter what? */
if (pNode->fFlags & VBOXSERVICEPROPCACHEFLAG_ALWAYS_UPDATE)
fUpdate = true;
/* Did the value change so we have to update? */
else if (pNode->pszValue && strcmp(pNode->pszValue, pszValue) != 0)
fUpdate = true;
/* No value stored at the moment but we have a value now? */
else if (pNode->pszValue == NULL)
fUpdate = true;
if (fUpdate)
{
/* Write the update. */
rc = vboxServicePropCacheWritePropF(pCache->uClientID, pNode->pszName, pNode->fFlags, pszValue);
RTStrFree(pNode->pszValue);
pNode->pszValue = RTStrDup(pszValue);
}
else
rc = VINF_NO_CHANGE; /* No update needed. */
}
else
{
/* No value specified. Deletion (or no action required). */
if (pNode->pszValue) /* Did we have a value before? Then the value needs to be deleted. */
{
/* Delete property (but do not remove from cache) if not deleted yet. */
RTStrFree(pNode->pszValue);
pNode->pszValue = NULL;
rc = vboxServicePropCacheWritePropF(pCache->uClientID, pNode->pszName,
0, /* Flags */ NULL /* Value */);
}
else
rc = VINF_NO_CHANGE; /* No update needed. */
}
/* Release cache. */
RTCritSectLeave(&pCache->CritSect);
}
/* Delete temp stuff. */
RTStrFree(pszValue);
return rc;
}
/**
* Updates all cache values which are matching the specified path.
*
* @returns VBox status code.
*
* @param pCache The property cache.
* @param pszValue The value to set. A NULL will delete the value.
* @param fFlags Flags to set.
* @param pszPathFormat The path format string. May not be null and has
* to be an absolute path.
* @param ... Format arguments.
*/
int VBoxServicePropCacheUpdateByPath(PVBOXSERVICEVEPROPCACHE pCache, const char *pszValue, uint32_t fFlags, const char *pszPathFormat, ...)
{
AssertPtr(pCache);
AssertPtr(pszPathFormat);
int rc = VERR_NOT_FOUND;
PVBOXSERVICEVEPROPCACHEENTRY pNodeIt = NULL;
if (RT_SUCCESS(RTCritSectEnter(&pCache->CritSect)))
{
/*
* Format the value first.
*/
char *pszPath = NULL;
va_list va;
va_start(va, pszPathFormat);
RTStrAPrintfV(&pszPath, pszPathFormat, va);
va_end(va);
if (!pszPath)
{
rc = VERR_NO_STR_MEMORY;
}
else
{
/* Iterate through all nodes and compare their paths. */
RTListForEach(&pCache->NodeHead, pNodeIt, VBOXSERVICEVEPROPCACHEENTRY, NodeSucc)
{
if (RTStrStr(pNodeIt->pszName, pszPath) == pNodeIt->pszName)
{
/** @todo Use some internal function to update the node directly, this is slow atm. */
rc = VBoxServicePropCacheUpdate(pCache, pNodeIt->pszName, pszValue);
}
if (RT_FAILURE(rc))
break;
}
RTStrFree(pszPath);
}
RTCritSectLeave(&pCache->CritSect);
}
return rc;
}
/**
* Flushes the cache by writing every item regardless of its state.
*
* @param pCache The property cache.
*/
int VBoxServicePropCacheFlush(PVBOXSERVICEVEPROPCACHE pCache)
{
AssertPtr(pCache);
int rc = VINF_SUCCESS;
PVBOXSERVICEVEPROPCACHEENTRY pNodeIt = NULL;
if (RT_SUCCESS(RTCritSectEnter(&pCache->CritSect)))
{
RTListForEach(&pCache->NodeHead, pNodeIt, VBOXSERVICEVEPROPCACHEENTRY, NodeSucc)
{
rc = vboxServicePropCacheWritePropF(pCache->uClientID, pNodeIt->pszName,
pNodeIt->fFlags, pNodeIt->pszValue);
if (RT_FAILURE(rc))
break;
}
RTCritSectLeave(&pCache->CritSect);
}
return rc;
}
/**
* Reset all temporary properties and destroy the cache.
*
* @param pCache The property cache.
*/
void VBoxServicePropCacheDestroy(PVBOXSERVICEVEPROPCACHE pCache)
{
AssertPtr(pCache);
Assert(pCache->uClientID);
/* Lock the cache. */
int rc = RTCritSectEnter(&pCache->CritSect);
if (RT_SUCCESS(rc))
{
PVBOXSERVICEVEPROPCACHEENTRY pNode = RTListGetFirst(&pCache->NodeHead, VBOXSERVICEVEPROPCACHEENTRY, NodeSucc);
while (pNode)
{
PVBOXSERVICEVEPROPCACHEENTRY pNext = RTListNodeIsLast(&pCache->NodeHead, &pNode->NodeSucc)
? NULL :
RTListNodeGetNext(&pNode->NodeSucc,
VBOXSERVICEVEPROPCACHEENTRY, NodeSucc);
RTListNodeRemove(&pNode->NodeSucc);
if (pNode->fFlags & VBOXSERVICEPROPCACHEFLAG_TEMPORARY)
{
rc = vboxServicePropCacheWritePropF(pCache->uClientID, pNode->pszName,
pNode->fFlags, pNode->pszValueReset);
}
AssertPtr(pNode->pszName);
RTStrFree(pNode->pszName);
RTStrFree(pNode->pszValue);
RTStrFree(pNode->pszValueReset);
pNode->fFlags = 0;
RTMemFree(pNode);
pNode = pNext;
}
RTCritSectLeave(&pCache->CritSect);
}
/* Destroy critical section. */
RTCritSectDelete(&pCache->CritSect);
}
|