VirtualBox

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

Last change on this file since 35212 was 35009, checked in by vboxsync, 14 years ago

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