VirtualBox

source: vbox/trunk/src/VBox/Main/include/MediumImpl.h@ 64613

Last change on this file since 64613 was 62810, checked in by vboxsync, 8 years ago

bugref:8482. The internal implementation of asynchronous task was eliminated from the class MediumImpl. Now the class Medium::Task is inherited from the appropriate class ThreadTask.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 18.2 KB
Line 
1/* $Id: MediumImpl.h 62810 2016-08-01 12:08:07Z vboxsync $ */
2/** @file
3 * VirtualBox COM class implementation
4 */
5
6/*
7 * Copyright (C) 2008-2016 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 */
17
18
19#ifndef ____H_MEDIUMIMPL
20#define ____H_MEDIUMIMPL
21
22#include <VBox/vd.h>
23#include "MediumWrap.h"
24#include "VirtualBoxBase.h"
25#include "AutoCaller.h"
26#include "SecretKeyStore.h"
27class Progress;
28class MediumFormat;
29class MediumLockList;
30
31namespace settings
32{
33 struct Medium;
34}
35
36////////////////////////////////////////////////////////////////////////////////
37
38/**
39 * Medium component class for all media types.
40 */
41class ATL_NO_VTABLE Medium :
42 public MediumWrap
43{
44public:
45 DECLARE_EMPTY_CTOR_DTOR(Medium)
46
47 HRESULT FinalConstruct();
48 void FinalRelease();
49
50 enum HDDOpenMode { OpenReadWrite, OpenReadOnly };
51 // have to use a special enum for the overloaded init() below;
52 // can't use AccessMode_T from XIDL because that's mapped to an int
53 // and would be ambiguous
54
55 // public initializer/uninitializer for internal purposes only
56
57 // initializer to create empty medium (VirtualBox::CreateMedium())
58 HRESULT init(VirtualBox *aVirtualBox,
59 const Utf8Str &aFormat,
60 const Utf8Str &aLocation,
61 const Guid &uuidMachineRegistry,
62 const DeviceType_T aDeviceType);
63
64 // initializer for opening existing media
65 // (VirtualBox::OpenMedium(); Machine::AttachDevice())
66 HRESULT init(VirtualBox *aVirtualBox,
67 const Utf8Str &aLocation,
68 HDDOpenMode enOpenMode,
69 bool fForceNewUuid,
70 DeviceType_T aDeviceType);
71
72 // initializer used when loading settings
73 HRESULT initOne(Medium *aParent,
74 DeviceType_T aDeviceType,
75 const Guid &uuidMachineRegistry,
76 const settings::Medium &data,
77 const Utf8Str &strMachineFolder);
78 HRESULT init(VirtualBox *aVirtualBox,
79 Medium *aParent,
80 DeviceType_T aDeviceType,
81 const Guid &uuidMachineRegistry,
82 const settings::Medium &data,
83 const Utf8Str &strMachineFolder,
84 AutoWriteLock &mediaTreeLock);
85
86 // initializer for host floppy/DVD
87 HRESULT init(VirtualBox *aVirtualBox,
88 DeviceType_T aDeviceType,
89 const Utf8Str &aLocation,
90 const Utf8Str &aDescription = Utf8Str::Empty);
91
92 void uninit();
93
94 void i_deparent();
95 void i_setParent(const ComObjPtr<Medium> &pParent);
96
97 // unsafe methods for internal purposes only (ensure there is
98 // a caller and a read lock before calling them!)
99 const ComObjPtr<Medium>& i_getParent() const;
100 const MediaList& i_getChildren() const;
101
102 const Guid& i_getId() const;
103 MediumState_T i_getState() const;
104 MediumVariant_T i_getVariant() const;
105 bool i_isHostDrive() const;
106 const Utf8Str& i_getLocationFull() const;
107 const Utf8Str& i_getFormat() const;
108 const ComObjPtr<MediumFormat> & i_getMediumFormat() const;
109 bool i_isMediumFormatFile() const;
110 uint64_t i_getSize() const;
111 DeviceType_T i_getDeviceType() const;
112 MediumType_T i_getType() const;
113 Utf8Str i_getName();
114
115 /* handles caller/locking itself */
116 bool i_addRegistry(const Guid &id);
117 /* handles caller/locking itself, caller is responsible for tree lock */
118 bool i_addRegistryRecursive(const Guid &id);
119 /* handles caller/locking itself */
120 bool i_removeRegistry(const Guid& id);
121 /* handles caller/locking itself, caller is responsible for tree lock */
122 bool i_removeRegistryRecursive(const Guid& id);
123 bool i_isInRegistry(const Guid& id);
124 bool i_getFirstRegistryMachineId(Guid &uuid) const;
125 void i_markRegistriesModified();
126
127 HRESULT i_setPropertyDirect(const Utf8Str &aName, const Utf8Str &aValue);
128
129 HRESULT i_addBackReference(const Guid &aMachineId,
130 const Guid &aSnapshotId = Guid::Empty);
131 HRESULT i_removeBackReference(const Guid &aMachineId,
132 const Guid &aSnapshotId = Guid::Empty);
133
134
135 const Guid* i_getFirstMachineBackrefId() const;
136 const Guid* i_getAnyMachineBackref() const;
137 const Guid* i_getFirstMachineBackrefSnapshotId() const;
138 size_t i_getMachineBackRefCount() const;
139
140#ifdef DEBUG
141 void i_dumpBackRefs();
142#endif
143
144 HRESULT i_updatePath(const Utf8Str &strOldPath, const Utf8Str &strNewPath);
145
146 /* handles caller/locking itself */
147 ComObjPtr<Medium> i_getBase(uint32_t *aLevel = NULL);
148 /* handles caller/locking itself */
149 uint32_t i_getDepth();
150
151 bool i_isReadOnly();
152 void i_updateId(const Guid &id);
153
154 void i_saveSettingsOne(settings::Medium &data,
155 const Utf8Str &strHardDiskFolder);
156 HRESULT i_saveSettings(settings::Medium &data,
157 const Utf8Str &strHardDiskFolder);
158
159 HRESULT i_createMediumLockList(bool fFailIfInaccessible,
160 Medium *pToLock,
161 bool fMediumLockWriteAll,
162 Medium *pToBeParent,
163 MediumLockList &mediumLockList);
164
165 HRESULT i_createDiffStorage(ComObjPtr<Medium> &aTarget,
166 MediumVariant_T aVariant,
167 MediumLockList *pMediumLockList,
168 ComObjPtr<Progress> *aProgress,
169 bool aWait);
170 Utf8Str i_getPreferredDiffFormat();
171 MediumVariant_T i_getPreferredDiffVariant();
172
173 HRESULT i_close(AutoCaller &autoCaller);
174 HRESULT i_unlockRead(MediumState_T *aState);
175 HRESULT i_unlockWrite(MediumState_T *aState);
176 HRESULT i_deleteStorage(ComObjPtr<Progress> *aProgress, bool aWait);
177 HRESULT i_markForDeletion();
178 HRESULT i_unmarkForDeletion();
179 HRESULT i_markLockedForDeletion();
180 HRESULT i_unmarkLockedForDeletion();
181
182 HRESULT i_queryPreferredMergeDirection(const ComObjPtr<Medium> &pOther,
183 bool &fMergeForward);
184
185 HRESULT i_prepareMergeTo(const ComObjPtr<Medium> &pTarget,
186 const Guid *aMachineId,
187 const Guid *aSnapshotId,
188 bool fLockMedia,
189 bool &fMergeForward,
190 ComObjPtr<Medium> &pParentForTarget,
191 MediumLockList * &aChildrenToReparent,
192 MediumLockList * &aMediumLockList);
193 HRESULT i_mergeTo(const ComObjPtr<Medium> &pTarget,
194 bool fMergeForward,
195 const ComObjPtr<Medium> &pParentForTarget,
196 MediumLockList *aChildrenToReparent,
197 MediumLockList *aMediumLockList,
198 ComObjPtr<Progress> *aProgress,
199 bool aWait);
200 void i_cancelMergeTo(MediumLockList *aChildrenToReparent,
201 MediumLockList *aMediumLockList);
202
203 HRESULT i_fixParentUuidOfChildren(MediumLockList *pChildrenToReparent);
204
205 HRESULT i_exportFile(const char *aFilename,
206 const ComObjPtr<MediumFormat> &aFormat,
207 MediumVariant_T aVariant,
208 SecretKeyStore *pKeyStore,
209 PVDINTERFACEIO aVDImageIOIf, void *aVDImageIOUser,
210 const ComObjPtr<Progress> &aProgress);
211 HRESULT i_importFile(const char *aFilename,
212 const ComObjPtr<MediumFormat> &aFormat,
213 MediumVariant_T aVariant,
214 RTVFSIOSTREAM hVfsIosSrc,
215 const ComObjPtr<Medium> &aParent,
216 const ComObjPtr<Progress> &aProgress);
217
218 HRESULT i_cloneToEx(const ComObjPtr<Medium> &aTarget, ULONG aVariant,
219 const ComObjPtr<Medium> &aParent, IProgress **aProgress,
220 uint32_t idxSrcImageSame, uint32_t idxDstImageSame);
221
222 const Utf8Str& i_getKeyId();
223
224private:
225
226 // wrapped IMedium properties
227 HRESULT getId(com::Guid &aId);
228 HRESULT getDescription(com::Utf8Str &aDescription);
229 HRESULT setDescription(const com::Utf8Str &aDescription);
230 HRESULT getState(MediumState_T *aState);
231 HRESULT getVariant(std::vector<MediumVariant_T> &aVariant);
232 HRESULT getLocation(com::Utf8Str &aLocation);
233 HRESULT getName(com::Utf8Str &aName);
234 HRESULT getDeviceType(DeviceType_T *aDeviceType);
235 HRESULT getHostDrive(BOOL *aHostDrive);
236 HRESULT getSize(LONG64 *aSize);
237 HRESULT getFormat(com::Utf8Str &aFormat);
238 HRESULT getMediumFormat(ComPtr<IMediumFormat> &aMediumFormat);
239 HRESULT getType(AutoCaller &autoCaller, MediumType_T *aType);
240 HRESULT setType(AutoCaller &autoCaller, MediumType_T aType);
241 HRESULT getAllowedTypes(std::vector<MediumType_T> &aAllowedTypes);
242 HRESULT getParent(AutoCaller &autoCaller, ComPtr<IMedium> &aParent);
243 HRESULT getChildren(AutoCaller &autoCaller, std::vector<ComPtr<IMedium> > &aChildren);
244 HRESULT getBase(AutoCaller &autoCaller, ComPtr<IMedium> &aBase);
245 HRESULT getReadOnly(AutoCaller &autoCaller, BOOL *aReadOnly);
246 HRESULT getLogicalSize(LONG64 *aLogicalSize);
247 HRESULT getAutoReset(BOOL *aAutoReset);
248 HRESULT setAutoReset(BOOL aAutoReset);
249 HRESULT getLastAccessError(com::Utf8Str &aLastAccessError);
250 HRESULT getMachineIds(std::vector<com::Guid> &aMachineIds);
251
252 // wrapped IMedium methods
253 HRESULT setIds(AutoCaller &aAutoCaller,
254 BOOL aSetImageId,
255 const com::Guid &aImageId,
256 BOOL aSetParentId,
257 const com::Guid &aParentId);
258 HRESULT refreshState(AutoCaller &aAutoCaller,
259 MediumState_T *aState);
260 HRESULT getSnapshotIds(const com::Guid &aMachineId,
261 std::vector<com::Guid> &aSnapshotIds);
262 HRESULT lockRead(ComPtr<IToken> &aToken);
263 HRESULT lockWrite(ComPtr<IToken> &aToken);
264 HRESULT close(AutoCaller &aAutoCaller);
265 HRESULT getProperty(const com::Utf8Str &aName,
266 com::Utf8Str &aValue);
267 HRESULT setProperty(const com::Utf8Str &aName,
268 const com::Utf8Str &aValue);
269 HRESULT getProperties(const com::Utf8Str &aNames,
270 std::vector<com::Utf8Str> &aReturnNames,
271 std::vector<com::Utf8Str> &aReturnValues);
272 HRESULT setProperties(const std::vector<com::Utf8Str> &aNames,
273 const std::vector<com::Utf8Str> &aValues);
274 HRESULT createBaseStorage(LONG64 aLogicalSize,
275 const std::vector<MediumVariant_T> &aVariant,
276 ComPtr<IProgress> &aProgress);
277 HRESULT deleteStorage(ComPtr<IProgress> &aProgress);
278 HRESULT createDiffStorage(AutoCaller &autoCaller,
279 const ComPtr<IMedium> &aTarget,
280 const std::vector<MediumVariant_T> &aVariant,
281 ComPtr<IProgress> &aProgress);
282 HRESULT mergeTo(const ComPtr<IMedium> &aTarget,
283 ComPtr<IProgress> &aProgress);
284 HRESULT cloneTo(const ComPtr<IMedium> &aTarget,
285 const std::vector<MediumVariant_T> &aVariant,
286 const ComPtr<IMedium> &aParent,
287 ComPtr<IProgress> &aProgress);
288 HRESULT cloneToBase(const ComPtr<IMedium> &aTarget,
289 const std::vector<MediumVariant_T> &aVariant,
290 ComPtr<IProgress> &aProgress);
291 HRESULT setLocation(const com::Utf8Str &aLocation,
292 ComPtr<IProgress> &aProgress);
293 HRESULT compact(ComPtr<IProgress> &aProgress);
294 HRESULT resize(LONG64 aLogicalSize,
295 ComPtr<IProgress> &aProgress);
296 HRESULT reset(AutoCaller &autoCaller, ComPtr<IProgress> &aProgress);
297 HRESULT changeEncryption(const com::Utf8Str &aCurrentPassword, const com::Utf8Str &aCipher,
298 const com::Utf8Str &aNewPassword, const com::Utf8Str &aNewPasswordId,
299 ComPtr<IProgress> &aProgress);
300 HRESULT getEncryptionSettings(com::Utf8Str &aCipher, com::Utf8Str &aPasswordId);
301 HRESULT checkEncryptionPassword(const com::Utf8Str &aPassword);
302
303 // Private internal nmethods
304 HRESULT i_queryInfo(bool fSetImageId, bool fSetParentId, AutoCaller &autoCaller);
305 HRESULT i_canClose();
306 HRESULT i_unregisterWithVirtualBox();
307 HRESULT i_setStateError();
308 HRESULT i_setLocation(const Utf8Str &aLocation, const Utf8Str &aFormat = Utf8Str::Empty);
309 HRESULT i_setFormat(const Utf8Str &aFormat);
310 VDTYPE i_convertDeviceType();
311 DeviceType_T i_convertToDeviceType(VDTYPE enmType);
312 Utf8Str i_vdError(int aVRC);
313
314 bool i_isPropertyForFilter(const com::Utf8Str &aName);
315
316 HRESULT i_getFilterProperties(std::vector<com::Utf8Str> &aReturnNames,
317 std::vector<com::Utf8Str> &aReturnValues);
318
319 HRESULT i_preparationForMoving(const Utf8Str &aLocation);
320 bool i_isMoveOperation(const ComObjPtr<Medium> &pTarget) const;
321 bool i_resetMoveOperationData();
322 Utf8Str i_getNewLocationForMoving() const;
323
324 static DECLCALLBACK(void) i_vdErrorCall(void *pvUser, int rc, RT_SRC_POS_DECL,
325 const char *pszFormat, va_list va);
326 static DECLCALLBACK(bool) i_vdConfigAreKeysValid(void *pvUser,
327 const char *pszzValid);
328 static DECLCALLBACK(int) i_vdConfigQuerySize(void *pvUser, const char *pszName,
329 size_t *pcbValue);
330 static DECLCALLBACK(int) i_vdConfigQuery(void *pvUser, const char *pszName,
331 char *pszValue, size_t cchValue);
332 static DECLCALLBACK(int) i_vdTcpSocketCreate(uint32_t fFlags, PVDSOCKET pSock);
333 static DECLCALLBACK(int) i_vdTcpSocketDestroy(VDSOCKET Sock);
334 static DECLCALLBACK(int) i_vdTcpClientConnect(VDSOCKET Sock, const char *pszAddress, uint32_t uPort,
335 RTMSINTERVAL cMillies);
336 static DECLCALLBACK(int) i_vdTcpClientClose(VDSOCKET Sock);
337 static DECLCALLBACK(bool) i_vdTcpIsClientConnected(VDSOCKET Sock);
338 static DECLCALLBACK(int) i_vdTcpSelectOne(VDSOCKET Sock, RTMSINTERVAL cMillies);
339 static DECLCALLBACK(int) i_vdTcpRead(VDSOCKET Sock, void *pvBuffer, size_t cbBuffer, size_t *pcbRead);
340 static DECLCALLBACK(int) i_vdTcpWrite(VDSOCKET Sock, const void *pvBuffer, size_t cbBuffer);
341 static DECLCALLBACK(int) i_vdTcpSgWrite(VDSOCKET Sock, PCRTSGBUF pSgBuf);
342 static DECLCALLBACK(int) i_vdTcpFlush(VDSOCKET Sock);
343 static DECLCALLBACK(int) i_vdTcpSetSendCoalescing(VDSOCKET Sock, bool fEnable);
344 static DECLCALLBACK(int) i_vdTcpGetLocalAddress(VDSOCKET Sock, PRTNETADDR pAddr);
345 static DECLCALLBACK(int) i_vdTcpGetPeerAddress(VDSOCKET Sock, PRTNETADDR pAddr);
346
347 static DECLCALLBACK(bool) i_vdCryptoConfigAreKeysValid(void *pvUser,
348 const char *pszzValid);
349 static DECLCALLBACK(int) i_vdCryptoConfigQuerySize(void *pvUser, const char *pszName,
350 size_t *pcbValue);
351 static DECLCALLBACK(int) i_vdCryptoConfigQuery(void *pvUser, const char *pszName,
352 char *pszValue, size_t cchValue);
353
354 static DECLCALLBACK(int) i_vdCryptoKeyRetain(void *pvUser, const char *pszId,
355 const uint8_t **ppbKey, size_t *pcbKey);
356 static DECLCALLBACK(int) i_vdCryptoKeyRelease(void *pvUser, const char *pszId);
357 static DECLCALLBACK(int) i_vdCryptoKeyStorePasswordRetain(void *pvUser, const char *pszId, const char **ppszPassword);
358 static DECLCALLBACK(int) i_vdCryptoKeyStorePasswordRelease(void *pvUser, const char *pszId);
359 static DECLCALLBACK(int) i_vdCryptoKeyStoreSave(void *pvUser, const void *pvKeyStore, size_t cbKeyStore);
360 static DECLCALLBACK(int) i_vdCryptoKeyStoreReturnParameters(void *pvUser, const char *pszCipher,
361 const uint8_t *pbDek, size_t cbDek);
362
363 class Task;
364 class CreateBaseTask;
365 class CreateDiffTask;
366 class CloneTask;
367 class MoveTask;
368 class CompactTask;
369 class ResizeTask;
370 class ResetTask;
371 class DeleteTask;
372 class MergeTask;
373 class ExportTask;
374 class ImportTask;
375 class EncryptTask;
376 friend class Task;
377 friend class CreateBaseTask;
378 friend class CreateDiffTask;
379 friend class CloneTask;
380 friend class MoveTask;
381 friend class CompactTask;
382 friend class ResizeTask;
383 friend class ResetTask;
384 friend class DeleteTask;
385 friend class MergeTask;
386 friend class ExportTask;
387 friend class ImportTask;
388 friend class EncryptTask;
389
390 HRESULT i_taskCreateBaseHandler(Medium::CreateBaseTask &task);
391 HRESULT i_taskCreateDiffHandler(Medium::CreateDiffTask &task);
392 HRESULT i_taskMergeHandler(Medium::MergeTask &task);
393 HRESULT i_taskCloneHandler(Medium::CloneTask &task);
394 HRESULT i_taskMoveHandler(Medium::MoveTask &task);
395 HRESULT i_taskDeleteHandler(Medium::DeleteTask &task);
396 HRESULT i_taskResetHandler(Medium::ResetTask &task);
397 HRESULT i_taskCompactHandler(Medium::CompactTask &task);
398 HRESULT i_taskResizeHandler(Medium::ResizeTask &task);
399 HRESULT i_taskExportHandler(Medium::ExportTask &task);
400 HRESULT i_taskImportHandler(Medium::ImportTask &task);
401 HRESULT i_taskEncryptHandler(Medium::EncryptTask &task);
402
403 struct CryptoFilterSettings;
404 void i_taskEncryptSettingsSetup(CryptoFilterSettings *pSettings, const char *pszCipher,
405 const char *pszKeyStore, const char *pszPassword,
406 bool fCreateKeyStore);
407
408 struct Data; // opaque data struct, defined in MediumImpl.cpp
409 Data *m;
410};
411
412#endif /* ____H_MEDIUMIMPL */
413
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