VirtualBox

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

Last change on this file since 42338 was 42125, checked in by vboxsync, 13 years ago

optional encrypted store of the iSCSI initiator secret
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 13.7 KB
Line 
1/* $Id: MediumImpl.h 42125 2012-07-12 10:39:18Z vboxsync $ */
2
3/** @file
4 *
5 * VirtualBox COM class implementation
6 */
7
8/*
9 * Copyright (C) 2008-2012 Oracle Corporation
10 *
11 * This file is part of VirtualBox Open Source Edition (OSE), as
12 * available from http://www.virtualbox.org. This file is free software;
13 * you can redistribute it and/or modify it under the terms of the GNU
14 * General Public License (GPL) as published by the Free Software
15 * Foundation, in version 2 as it comes in the "COPYING" file of the
16 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
17 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
18 */
19
20#ifndef ____H_MEDIUMIMPL
21#define ____H_MEDIUMIMPL
22
23#include <VBox/vd.h>
24
25#include "VirtualBoxBase.h"
26#include "MediumLock.h"
27
28class Progress;
29class MediumFormat;
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 VirtualBoxBase,
43 VBOX_SCRIPTABLE_IMPL(IMedium)
44{
45public:
46 VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT(Medium, IMedium)
47
48 DECLARE_NOT_AGGREGATABLE(Medium)
49
50 DECLARE_PROTECT_FINAL_CONSTRUCT()
51
52 BEGIN_COM_MAP(Medium)
53 VBOX_DEFAULT_INTERFACE_ENTRIES(IMedium)
54 END_COM_MAP()
55
56 DECLARE_EMPTY_CTOR_DTOR(Medium)
57
58 HRESULT FinalConstruct();
59 void FinalRelease();
60
61 enum HDDOpenMode { OpenReadWrite, OpenReadOnly };
62 // have to use a special enum for the overloaded init() below;
63 // can't use AccessMode_T from XIDL because that's mapped to an int
64 // and would be ambiguous
65
66 // public initializer/uninitializer for internal purposes only
67
68 // initializer to create empty medium (VirtualBox::CreateHardDisk())
69 HRESULT init(VirtualBox *aVirtualBox,
70 const Utf8Str &aFormat,
71 const Utf8Str &aLocation,
72 const Guid &uuidMachineRegistry);
73
74 // initializer for opening existing media
75 // (VirtualBox::OpenMedium(); Machine::AttachDevice())
76 HRESULT init(VirtualBox *aVirtualBox,
77 const Utf8Str &aLocation,
78 HDDOpenMode enOpenMode,
79 bool fForceNewUuid,
80 DeviceType_T aDeviceType);
81
82 // initializer used when loading settings
83 HRESULT init(VirtualBox *aVirtualBox,
84 Medium *aParent,
85 DeviceType_T aDeviceType,
86 const Guid &uuidMachineRegistry,
87 const settings::Medium &data,
88 const Utf8Str &strMachineFolder);
89
90 // initializer for host floppy/DVD
91 HRESULT init(VirtualBox *aVirtualBox,
92 DeviceType_T aDeviceType,
93 const Utf8Str &aLocation,
94 const Utf8Str &aDescription = Utf8Str::Empty);
95
96 void uninit();
97
98 void deparent();
99 void setParent(const ComObjPtr<Medium> &pParent);
100
101 // IMedium properties
102 STDMETHOD(COMGETTER(Id))(BSTR *aId);
103 STDMETHOD(COMGETTER(Description))(BSTR *aDescription);
104 STDMETHOD(COMSETTER(Description))(IN_BSTR aDescription);
105 STDMETHOD(COMGETTER(State))(MediumState_T *aState);
106 STDMETHOD(COMGETTER(Variant))(ULONG *aVariant);
107 STDMETHOD(COMGETTER(Location))(BSTR *aLocation);
108 STDMETHOD(COMSETTER(Location))(IN_BSTR aLocation);
109 STDMETHOD(COMGETTER(Name))(BSTR *aName);
110 STDMETHOD(COMGETTER(DeviceType))(DeviceType_T *aDeviceType);
111 STDMETHOD(COMGETTER(HostDrive))(BOOL *aHostDrive);
112 STDMETHOD(COMGETTER(Size))(LONG64 *aSize);
113 STDMETHOD(COMGETTER(Format))(BSTR *aFormat);
114 STDMETHOD(COMGETTER(MediumFormat))(IMediumFormat **aMediumFormat);
115 STDMETHOD(COMGETTER(Type))(MediumType_T *aType);
116 STDMETHOD(COMSETTER(Type))(MediumType_T aType);
117 STDMETHOD(COMGETTER(AllowedTypes))(ComSafeArrayOut(MediumType_T, aAllowedTypes));
118 STDMETHOD(COMGETTER(Parent))(IMedium **aParent);
119 STDMETHOD(COMGETTER(Children))(ComSafeArrayOut(IMedium *, aChildren));
120 STDMETHOD(COMGETTER(Base))(IMedium **aBase);
121 STDMETHOD(COMGETTER(ReadOnly))(BOOL *aReadOnly);
122 STDMETHOD(COMGETTER(LogicalSize))(LONG64 *aLogicalSize);
123 STDMETHOD(COMGETTER(AutoReset))(BOOL *aAutoReset);
124 STDMETHOD(COMSETTER(AutoReset))(BOOL aAutoReset);
125 STDMETHOD(COMGETTER(LastAccessError))(BSTR *aLastAccessError);
126 STDMETHOD(COMGETTER(MachineIds))(ComSafeArrayOut(BSTR, aMachineIds));
127
128 // IMedium methods
129 STDMETHOD(SetIDs)(BOOL aSetImageId, IN_BSTR aImageId,
130 BOOL aSetParentId, IN_BSTR aParentId);
131 STDMETHOD(RefreshState)(MediumState_T *aState);
132 STDMETHOD(GetSnapshotIds)(IN_BSTR aMachineId,
133 ComSafeArrayOut(BSTR, aSnapshotIds));
134 STDMETHOD(LockRead)(MediumState_T *aState);
135 STDMETHOD(UnlockRead)(MediumState_T *aState);
136 STDMETHOD(LockWrite)(MediumState_T *aState);
137 STDMETHOD(UnlockWrite)(MediumState_T *aState);
138 STDMETHOD(Close)();
139 STDMETHOD(GetProperty)(IN_BSTR aName, BSTR *aValue);
140 STDMETHOD(SetProperty)(IN_BSTR aName, IN_BSTR aValue);
141 STDMETHOD(GetProperties)(IN_BSTR aNames,
142 ComSafeArrayOut(BSTR, aReturnNames),
143 ComSafeArrayOut(BSTR, aReturnValues));
144 STDMETHOD(SetProperties)(ComSafeArrayIn(IN_BSTR, aNames),
145 ComSafeArrayIn(IN_BSTR, aValues));
146 STDMETHOD(CreateBaseStorage)(LONG64 aLogicalSize,
147 ULONG aVariant,
148 IProgress **aProgress);
149 STDMETHOD(DeleteStorage)(IProgress **aProgress);
150 STDMETHOD(CreateDiffStorage)(IMedium *aTarget,
151 ULONG aVariant,
152 IProgress **aProgress);
153 STDMETHOD(MergeTo)(IMedium *aTarget, IProgress **aProgress);
154 STDMETHOD(CloneTo)(IMedium *aTarget, ULONG aVariant,
155 IMedium *aParent, IProgress **aProgress);
156 STDMETHOD(Compact)(IProgress **aProgress);
157 STDMETHOD(Resize)(LONG64 aLogicalSize, IProgress **aProgress);
158 STDMETHOD(Reset)(IProgress **aProgress);
159
160 // unsafe methods for internal purposes only (ensure there is
161 // a caller and a read lock before calling them!)
162 const ComObjPtr<Medium>& getParent() const;
163 const MediaList& getChildren() const;
164
165 const Guid& getId() const;
166 MediumState_T getState() const;
167 MediumVariant_T getVariant() const;
168 bool isHostDrive() const;
169 const Utf8Str& getLocationFull() const;
170 const Utf8Str& getFormat() const;
171 const ComObjPtr<MediumFormat> & getMediumFormat() const;
172 bool isMediumFormatFile() const;
173 uint64_t getSize() const;
174 DeviceType_T getDeviceType() const;
175 MediumType_T getType() const;
176 Utf8Str getName();
177
178 /* handles caller/locking itself */
179 bool addRegistry(const Guid& id, bool fRecurse);
180 /* handles caller/locking itself */
181 bool removeRegistry(const Guid& id, bool fRecurse);
182 bool isInRegistry(const Guid& id);
183 bool getFirstRegistryMachineId(Guid &uuid) const;
184 void markRegistriesModified();
185
186 HRESULT setPropertyDirect(const Utf8Str &aName, const Utf8Str &aValue);
187
188 HRESULT addBackReference(const Guid &aMachineId,
189 const Guid &aSnapshotId = Guid::Empty);
190 HRESULT removeBackReference(const Guid &aMachineId,
191 const Guid &aSnapshotId = Guid::Empty);
192
193
194 const Guid* getFirstMachineBackrefId() const;
195 const Guid* getAnyMachineBackref() const;
196 const Guid* getFirstMachineBackrefSnapshotId() const;
197 size_t getMachineBackRefCount() const;
198
199#ifdef DEBUG
200 void dumpBackRefs();
201#endif
202
203 HRESULT updatePath(const Utf8Str &strOldPath, const Utf8Str &strNewPath);
204
205 ComObjPtr<Medium> getBase(uint32_t *aLevel = NULL);
206
207 bool isReadOnly();
208 void updateId(const Guid &id);
209
210 HRESULT saveSettings(settings::Medium &data,
211 const Utf8Str &strHardDiskFolder);
212
213 HRESULT createMediumLockList(bool fFailIfInaccessible,
214 bool fMediumLockWrite,
215 Medium *pToBeParent,
216 MediumLockList &mediumLockList);
217
218 HRESULT createDiffStorage(ComObjPtr<Medium> &aTarget,
219 MediumVariant_T aVariant,
220 MediumLockList *pMediumLockList,
221 ComObjPtr<Progress> *aProgress,
222 bool aWait);
223 Utf8Str getPreferredDiffFormat();
224
225 HRESULT close(AutoCaller &autoCaller);
226 HRESULT deleteStorage(ComObjPtr<Progress> *aProgress, bool aWait);
227 HRESULT markForDeletion();
228 HRESULT unmarkForDeletion();
229 HRESULT markLockedForDeletion();
230 HRESULT unmarkLockedForDeletion();
231
232 HRESULT prepareMergeTo(const ComObjPtr<Medium> &pTarget,
233 const Guid *aMachineId,
234 const Guid *aSnapshotId,
235 bool fLockMedia,
236 bool &fMergeForward,
237 ComObjPtr<Medium> &pParentForTarget,
238 MediaList &aChildrenToReparent,
239 MediumLockList * &aMediumLockList);
240 HRESULT mergeTo(const ComObjPtr<Medium> &pTarget,
241 bool fMergeForward,
242 const ComObjPtr<Medium> &pParentForTarget,
243 const MediaList &aChildrenToReparent,
244 MediumLockList *aMediumLockList,
245 ComObjPtr<Progress> *aProgress,
246 bool aWait);
247 void cancelMergeTo(const MediaList &aChildrenToReparent,
248 MediumLockList *aMediumLockList);
249
250 HRESULT fixParentUuidOfChildren(const MediaList &childrenToReparent);
251
252 HRESULT exportFile(const char *aFilename,
253 const ComObjPtr<MediumFormat> &aFormat,
254 MediumVariant_T aVariant,
255 PVDINTERFACEIO aVDImageIOIf, void *aVDImageIOUser,
256 const ComObjPtr<Progress> &aProgress);
257 HRESULT importFile(const char *aFilename,
258 const ComObjPtr<MediumFormat> &aFormat,
259 MediumVariant_T aVariant,
260 PVDINTERFACEIO aVDImageIOIf, void *aVDImageIOUser,
261 const ComObjPtr<Medium> &aParent,
262 const ComObjPtr<Progress> &aProgress);
263
264 HRESULT cloneToEx(const ComObjPtr<Medium> &aTarget, ULONG aVariant,
265 const ComObjPtr<Medium> &aParent, IProgress **aProgress,
266 uint32_t idxSrcImageSame, uint32_t idxDstImageSame);
267
268private:
269
270 HRESULT queryInfo(bool fSetImageId, bool fSetParentId);
271
272 HRESULT canClose();
273 HRESULT unregisterWithVirtualBox();
274
275 HRESULT setStateError();
276
277 HRESULT setLocation(const Utf8Str &aLocation, const Utf8Str &aFormat = Utf8Str::Empty);
278 HRESULT setFormat(const Utf8Str &aFormat);
279
280 VDTYPE convertDeviceType();
281 DeviceType_T convertToDeviceType(VDTYPE enmType);
282
283 Utf8Str vdError(int aVRC);
284
285 static DECLCALLBACK(void) vdErrorCall(void *pvUser, int rc, RT_SRC_POS_DECL,
286 const char *pszFormat, va_list va);
287
288 static DECLCALLBACK(bool) vdConfigAreKeysValid(void *pvUser,
289 const char *pszzValid);
290 static DECLCALLBACK(int) vdConfigQuerySize(void *pvUser, const char *pszName,
291 size_t *pcbValue);
292 static DECLCALLBACK(int) vdConfigQuery(void *pvUser, const char *pszName,
293 char *pszValue, size_t cchValue);
294
295 static DECLCALLBACK(int) vdTcpSocketCreate(uint32_t fFlags, PVDSOCKET pSock);
296 static DECLCALLBACK(int) vdTcpSocketDestroy(VDSOCKET Sock);
297 static DECLCALLBACK(int) vdTcpClientConnect(VDSOCKET Sock, const char *pszAddress, uint32_t uPort);
298 static DECLCALLBACK(int) vdTcpClientClose(VDSOCKET Sock);
299 static DECLCALLBACK(bool) vdTcpIsClientConnected(VDSOCKET Sock);
300 static DECLCALLBACK(int) vdTcpSelectOne(VDSOCKET Sock, RTMSINTERVAL cMillies);
301 static DECLCALLBACK(int) vdTcpRead(VDSOCKET Sock, void *pvBuffer, size_t cbBuffer, size_t *pcbRead);
302 static DECLCALLBACK(int) vdTcpWrite(VDSOCKET Sock, const void *pvBuffer, size_t cbBuffer);
303 static DECLCALLBACK(int) vdTcpSgWrite(VDSOCKET Sock, PCRTSGBUF pSgBuf);
304 static DECLCALLBACK(int) vdTcpFlush(VDSOCKET Sock);
305 static DECLCALLBACK(int) vdTcpSetSendCoalescing(VDSOCKET Sock, bool fEnable);
306 static DECLCALLBACK(int) vdTcpGetLocalAddress(VDSOCKET Sock, PRTNETADDR pAddr);
307 static DECLCALLBACK(int) vdTcpGetPeerAddress(VDSOCKET Sock, PRTNETADDR pAddr);
308
309 class Task;
310 class CreateBaseTask;
311 class CreateDiffTask;
312 class CloneTask;
313 class CompactTask;
314 class ResizeTask;
315 class ResetTask;
316 class DeleteTask;
317 class MergeTask;
318 class ExportTask;
319 class ImportTask;
320 friend class Task;
321 friend class CreateBaseTask;
322 friend class CreateDiffTask;
323 friend class CloneTask;
324 friend class CompactTask;
325 friend class ResizeTask;
326 friend class ResetTask;
327 friend class DeleteTask;
328 friend class MergeTask;
329 friend class ExportTask;
330 friend class ImportTask;
331
332 HRESULT startThread(Medium::Task *pTask);
333 HRESULT runNow(Medium::Task *pTask);
334
335 HRESULT taskCreateBaseHandler(Medium::CreateBaseTask &task);
336 HRESULT taskCreateDiffHandler(Medium::CreateDiffTask &task);
337 HRESULT taskMergeHandler(Medium::MergeTask &task);
338 HRESULT taskCloneHandler(Medium::CloneTask &task);
339 HRESULT taskDeleteHandler(Medium::DeleteTask &task);
340 HRESULT taskResetHandler(Medium::ResetTask &task);
341 HRESULT taskCompactHandler(Medium::CompactTask &task);
342 HRESULT taskResizeHandler(Medium::ResizeTask &task);
343 HRESULT taskExportHandler(Medium::ExportTask &task);
344 HRESULT taskImportHandler(Medium::ImportTask &task);
345
346 struct Data; // opaque data struct, defined in MediumImpl.cpp
347 Data *m;
348};
349
350#endif /* ____H_MEDIUMIMPL */
351
Note: See TracBrowser for help on using the repository browser.

© 2025 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette