VirtualBox

source: vbox/trunk/src/VBox/Devices/Storage/DrvRawImage.cpp@ 33000

Last change on this file since 33000 was 28800, checked in by vboxsync, 14 years ago

Automated rebranding to Oracle copyright/license strings via filemuncher
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 11.5 KB
Line 
1/* $Id: DrvRawImage.cpp 28800 2010-04-27 08:22:32Z vboxsync $ */
2/** @file
3 * VBox storage devices: Raw image driver
4 */
5
6/*
7 * Copyright (C) 2006-2010 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/*******************************************************************************
20* Header Files *
21*******************************************************************************/
22#define LOG_GROUP LOG_GROUP_DRV_RAW_IMAGE
23#include <VBox/pdmdrv.h>
24#include <iprt/assert.h>
25#include <iprt/file.h>
26#include <iprt/string.h>
27#include <iprt/uuid.h>
28
29#include "Builtins.h"
30
31
32/*******************************************************************************
33* Defined Constants And Macros *
34*******************************************************************************/
35/** Converts a pointer to RAWIMAGE::IMedia to a PRDVRAWIMAGE. */
36#define PDMIMEDIA_2_DRVRAWIMAGE(pInterface) ( (PDRVRAWIMAGE)((uintptr_t)pInterface - RT_OFFSETOF(DRVRAWIMAGE, IMedia)) )
37
38/** Converts a pointer to PDMDRVINS::IBase to a PPDMDRVINS. */
39#define PDMIBASE_2_DRVINS(pInterface) ( (PPDMDRVINS)((uintptr_t)pInterface - RT_OFFSETOF(PDMDRVINS, IBase)) )
40
41/** Converts a pointer to PDMDRVINS::IBase to a PVBOXHDD. */
42#define PDMIBASE_2_DRVRAWIMAGE(pInterface) ( PDMINS_2_DATA(PDMIBASE_2_DRVINS(pInterface), PDRVRAWIMAGE) )
43
44
45
46/*******************************************************************************
47* Structures and Typedefs *
48*******************************************************************************/
49/**
50 * Block driver instance data.
51 *
52 * @implements PDMIMEDIA
53 */
54typedef struct DRVRAWIMAGE
55{
56 /** The media interface. */
57 PDMIMEDIA IMedia;
58 /** Pointer to the driver instance. */
59 PPDMDRVINS pDrvIns;
60 /** Pointer to the filename. (Freed by MM) */
61 char *pszFilename;
62 /** File handle of the raw image file. */
63 RTFILE File;
64 /** True if the image is operating in readonly mode. */
65 bool fReadOnly;
66} DRVRAWIMAGE, *PDRVRAWIMAGE;
67
68
69
70/* -=-=-=-=- PDMIMEDIA -=-=-=-=- */
71
72/** @copydoc PDMIMEDIA::pfnGetSize */
73static DECLCALLBACK(uint64_t) drvRawImageGetSize(PPDMIMEDIA pInterface)
74{
75 PDRVRAWIMAGE pThis = PDMIMEDIA_2_DRVRAWIMAGE(pInterface);
76 LogFlow(("drvRawImageGetSize: '%s'\n", pThis->pszFilename));
77
78 uint64_t cbFile;
79 int rc = RTFileGetSize(pThis->File, &cbFile);
80 if (RT_SUCCESS(rc))
81 {
82 LogFlow(("drvRawImageGetSize: returns %lld (%s)\n", cbFile, pThis->pszFilename));
83 return cbFile;
84 }
85
86 AssertMsgFailed(("Error querying Raw image file size, rc=%Rrc. (%s)\n", rc, pThis->pszFilename));
87 return 0;
88}
89
90
91/** @copydoc PDMIMEDIA::pfnBiosGetPCHSGeometry */
92static DECLCALLBACK(int) drvRawImageBiosGetPCHSGeometry(PPDMIMEDIA pInterface, PPDMMEDIAGEOMETRY pPCHSGeometry)
93{
94 return VERR_NOT_IMPLEMENTED;
95}
96
97
98/** @copydoc PDMIMEDIA::pfnBiosSetPCHSGeometry */
99static DECLCALLBACK(int) drvRawImageBiosSetPCHSGeometry(PPDMIMEDIA pInterface, PCPDMMEDIAGEOMETRY pPCHSGeometry)
100{
101 return VERR_NOT_IMPLEMENTED;
102}
103
104
105/** @copydoc PDMIMEDIA::pfnBiosGetLCHSGeometry */
106static DECLCALLBACK(int) drvRawImageBiosGetLCHSGeometry(PPDMIMEDIA pInterface, PPDMMEDIAGEOMETRY pLCHSGeometry)
107{
108 return VERR_NOT_IMPLEMENTED;
109}
110
111
112/** @copydoc PDMIMEDIA::pfnBiosSetLCHSGeometry */
113static DECLCALLBACK(int) drvRawImageBiosSetLCHSGeometry(PPDMIMEDIA pInterface, PCPDMMEDIAGEOMETRY pLCHSGeometry)
114{
115 return VERR_NOT_IMPLEMENTED;
116}
117
118
119/**
120 * Read bits.
121 *
122 * @see PDMIMEDIA::pfnRead for details.
123 */
124static DECLCALLBACK(int) drvRawImageRead(PPDMIMEDIA pInterface, uint64_t off, void *pvBuf, size_t cbRead)
125{
126 PDRVRAWIMAGE pThis = PDMIMEDIA_2_DRVRAWIMAGE(pInterface);
127 LogFlow(("drvRawImageRead: off=%#llx pvBuf=%p cbRead=%#x (%s)\n", off, pvBuf, cbRead, pThis->pszFilename));
128
129 Assert(pThis->File);
130 Assert(pvBuf);
131
132 /*
133 * Seek to the position and read.
134 */
135 int rc = RTFileSeek(pThis->File, off, RTFILE_SEEK_BEGIN, NULL);
136 if (RT_SUCCESS(rc))
137 {
138 rc = RTFileRead(pThis->File, pvBuf, cbRead, NULL);
139 if (RT_SUCCESS(rc))
140 {
141 Log2(("drvRawImageRead: off=%#llx pvBuf=%p cbRead=%#x (%s)\n"
142 "%16.*Rhxd\n",
143 off, pvBuf, cbRead, pThis->pszFilename,
144 cbRead, pvBuf));
145 }
146 else
147 AssertMsgFailed(("RTFileRead(%d, %p, %#x) -> %Rrc (off=%#llx '%s')\n",
148 pThis->File, pvBuf, cbRead, rc, off, pThis->pszFilename));
149 }
150 else
151 AssertMsgFailed(("RTFileSeek(%d,%#llx,) -> %Rrc\n", pThis->File, off, rc));
152 LogFlow(("drvRawImageRead: returns %Rrc\n", rc));
153 return rc;
154}
155
156
157/** @copydoc PDMIMEDIA::pfnWrite */
158static DECLCALLBACK(int) drvRawImageWrite(PPDMIMEDIA pInterface, uint64_t off, const void *pvBuf, size_t cbWrite)
159{
160 PDRVRAWIMAGE pThis = PDMIMEDIA_2_DRVRAWIMAGE(pInterface);
161 LogFlow(("drvRawImageWrite: off=%#llx pvBuf=%p cbWrite=%#x (%s)\n", off, pvBuf, cbWrite, pThis->pszFilename));
162
163 Assert(pThis->File);
164 Assert(pvBuf);
165
166 /*
167 * Seek to the position and write.
168 */
169 int rc = RTFileSeek(pThis->File, off, RTFILE_SEEK_BEGIN, NULL);
170 if (RT_SUCCESS(rc))
171 {
172 rc = RTFileWrite(pThis->File, pvBuf, cbWrite, NULL);
173 if (RT_SUCCESS(rc))
174 {
175 Log2(("drvRawImageWrite: off=%#llx pvBuf=%p cbWrite=%#x (%s)\n"
176 "%16.*Rhxd\n",
177 off, pvBuf, cbWrite, pThis->pszFilename,
178 cbWrite, pvBuf));
179 }
180 else
181 AssertMsgFailed(("RTFileWrite(%d, %p, %#x) -> %Rrc (off=%#llx '%s')\n",
182 pThis->File, pvBuf, cbWrite, rc, off, pThis->pszFilename));
183 }
184 else
185 AssertMsgFailed(("RTFileSeek(%d,%#llx,) -> %Rrc\n", pThis->File, off, rc));
186 LogFlow(("drvRawImageWrite: returns %Rrc\n", rc));
187 return rc;
188}
189
190
191/** @copydoc PDMIMEDIA::pfnFlush */
192static DECLCALLBACK(int) drvRawImageFlush(PPDMIMEDIA pInterface)
193{
194 PDRVRAWIMAGE pThis = PDMIMEDIA_2_DRVRAWIMAGE(pInterface);
195 LogFlow(("drvRawImageFlush: (%s)\n", pThis->pszFilename));
196
197 Assert(pThis->File != NIL_RTFILE);
198 int rc = RTFileFlush(pThis->File);
199 LogFlow(("drvRawImageFlush: returns %Rrc\n", rc));
200 return rc;
201}
202
203
204/** @copydoc PDMIMEDIA::pfnGetUuid */
205static DECLCALLBACK(int) drvRawImageGetUuid(PPDMIMEDIA pInterface, PRTUUID pUuid)
206{
207 LogFlow(("drvRawImageGetUuid: returns VERR_NOT_IMPLEMENTED\n"));
208 return VERR_NOT_IMPLEMENTED;
209}
210
211
212/** @copydoc PDMIMEDIA::pfnIsReadOnly */
213static DECLCALLBACK(bool) drvRawImageIsReadOnly(PPDMIMEDIA pInterface)
214{
215 PDRVRAWIMAGE pThis = PDMIMEDIA_2_DRVRAWIMAGE(pInterface);
216 return pThis->fReadOnly;
217}
218
219
220/* -=-=-=-=- PDMIBASE -=-=-=-=- */
221
222/**
223 * @interface_method_impl{PDMIBASE,pfnQueryInterface}
224 */
225static DECLCALLBACK(void *) drvRawImageQueryInterface(PPDMIBASE pInterface, const char *pszIID)
226{
227 PPDMDRVINS pDrvIns = PDMIBASE_2_DRVINS(pInterface);
228 PDRVRAWIMAGE pThis = PDMINS_2_DATA(pDrvIns, PDRVRAWIMAGE);
229
230 PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASE, &pDrvIns->IBase);
231 PDMIBASE_RETURN_INTERFACE(pszIID, PDMIMEDIA, &pThis->IMedia);
232 return NULL;
233}
234
235/* -=-=-=-=- PDMDRVREG -=-=-=-=- */
236
237/**
238 * Destruct a driver instance.
239 *
240 * Most VM resources are freed by the VM. This callback is provided so that any non-VM
241 * resources can be freed correctly.
242 *
243 * @param pDrvIns The driver instance data.
244 */
245static DECLCALLBACK(void) drvRawImageDestruct(PPDMDRVINS pDrvIns)
246{
247 PDRVRAWIMAGE pThis = PDMINS_2_DATA(pDrvIns, PDRVRAWIMAGE);
248 LogFlow(("drvRawImageDestruct: '%s'\n", pThis->pszFilename));
249 PDMDRV_CHECK_VERSIONS_RETURN_VOID(pDrvIns);
250
251 if (pThis->File != NIL_RTFILE)
252 {
253 RTFileClose(pThis->File);
254 pThis->File = NIL_RTFILE;
255 }
256 if (pThis->pszFilename)
257 MMR3HeapFree(pThis->pszFilename);
258}
259
260
261/**
262 * Construct a raw image driver instance.
263 *
264 * @copydoc FNPDMDRVCONSTRUCT
265 */
266static DECLCALLBACK(int) drvRawImageConstruct(PPDMDRVINS pDrvIns, PCFGMNODE pCfg, uint32_t fFlags)
267{
268 PDRVRAWIMAGE pThis = PDMINS_2_DATA(pDrvIns, PDRVRAWIMAGE);
269 PDMDRV_CHECK_VERSIONS_RETURN(pDrvIns);
270
271 /*
272 * Init the static parts.
273 */
274 pThis->pDrvIns = pDrvIns;
275 pThis->File = NIL_RTFILE;
276 /* IBase */
277 pDrvIns->IBase.pfnQueryInterface = drvRawImageQueryInterface;
278 /* IMedia */
279 pThis->IMedia.pfnRead = drvRawImageRead;
280 pThis->IMedia.pfnWrite = drvRawImageWrite;
281 pThis->IMedia.pfnFlush = drvRawImageFlush;
282 pThis->IMedia.pfnGetSize = drvRawImageGetSize;
283 pThis->IMedia.pfnGetUuid = drvRawImageGetUuid;
284 pThis->IMedia.pfnIsReadOnly = drvRawImageIsReadOnly;
285 pThis->IMedia.pfnBiosGetPCHSGeometry = drvRawImageBiosGetPCHSGeometry;
286 pThis->IMedia.pfnBiosSetPCHSGeometry = drvRawImageBiosSetPCHSGeometry;
287 pThis->IMedia.pfnBiosGetLCHSGeometry = drvRawImageBiosGetLCHSGeometry;
288 pThis->IMedia.pfnBiosSetLCHSGeometry = drvRawImageBiosSetLCHSGeometry;
289
290 /*
291 * Read the configuration.
292 */
293 if (!CFGMR3AreValuesValid(pCfg, "Path\0"))
294 return VERR_PDM_DRVINS_UNKNOWN_CFG_VALUES;
295
296 char *pszName;
297 int rc = CFGMR3QueryStringAlloc(pCfg, "Path", &pszName);
298 if (RT_FAILURE(rc))
299 {
300 AssertMsgFailed(("Configuration error: query for \"Path\" string return %Rrc.\n", rc));
301 return rc;
302 }
303
304 /*
305 * Open the image.
306 */
307 rc = RTFileOpen(&pThis->File, pszName,
308 RTFILE_O_READWRITE | RTFILE_O_OPEN | RTFILE_O_DENY_NONE);
309 if (RT_SUCCESS(rc))
310 {
311 LogFlow(("drvRawImageConstruct: Raw image '%s' opened successfully.\n", pszName));
312 pThis->pszFilename = pszName;
313 pThis->fReadOnly = false;
314 }
315 else
316 {
317 rc = RTFileOpen(&pThis->File, pszName,
318 RTFILE_O_READ | RTFILE_O_OPEN | RTFILE_O_DENY_NONE);
319 if (RT_SUCCESS(rc))
320 {
321 LogFlow(("drvRawImageConstruct: Raw image '%s' opened successfully.\n", pszName));
322 pThis->pszFilename = pszName;
323 pThis->fReadOnly = true;
324 }
325 else
326 {
327 AssertMsgFailed(("Could not open Raw image file %s, rc=%Rrc\n", pszName, rc));
328 MMR3HeapFree(pszName);
329 }
330 }
331
332 return rc;
333}
334
335
336/**
337 * Raw image driver registration record.
338 */
339const PDMDRVREG g_DrvRawImage =
340{
341 /* u32Version */
342 PDM_DRVREG_VERSION,
343 /* szName */
344 "RawImage",
345 /* szRCMod */
346 "",
347 /* szR0Mod */
348 "",
349 /* pszDescription */
350 "Raw image access driver.",
351 /* fFlags */
352 PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT,
353 /* fClass. */
354 PDM_DRVREG_CLASS_MEDIA,
355 /* cMaxInstances */
356 ~0,
357 /* cbInstance */
358 sizeof(DRVRAWIMAGE),
359 /* pfnConstruct */
360 drvRawImageConstruct,
361 /* pfnDestruct */
362 drvRawImageDestruct,
363 /* pfnRelocate */
364 NULL,
365 /* pfnIOCtl */
366 NULL,
367 /* pfnPowerOn */
368 NULL,
369 /* pfnReset */
370 NULL,
371 /* pfnSuspend */
372 NULL,
373 /* pfnResume */
374 NULL,
375 /* pfnAttach */
376 NULL,
377 /* pfnDetach */
378 NULL,
379 /* pfnPowerOff */
380 NULL,
381 /* pfnSoftReset */
382 NULL,
383 /* u32EndVersion */
384 PDM_DRVREG_VERSION
385};
Note: See TracBrowser for help on using the repository browser.

© 2023 Oracle
Contact – Privacy policy – Terms of Use