Page MenuHomePhabricator
Files F4325141

No OneTemporary
Actions

Size
307 KB
Referenced Files
None
Subscribers
None

View Options

This file is larger than 256 KB, so syntax highlighting was skipped.
diff --git a/trunk/NEWS b/trunk/NEWS
index 0dfc292..403f2aa 100644
--- a/trunk/NEWS
+++ b/trunk/NEWS
@@ -1,67 +1,68 @@
This file lists the most important changes to the previous released version.
For a full list of changes please refer to the source files.
New for version 0.7.0:
- Switched build system from autoconf / autoamke to cmake
- Massiv code cleanup
- Input image support is now controlled by external libxmount_input libraries
- - Added support for --offset command line argument
+ - Added support for morphing all input images into a virtual output image using libxmount_morphing libraries
+ - Added support for --offset and --sizelimit command line argument
New for version 0.6.0:
- Added support for split DD input files.
New for version 0.5.0:
- Added support for VHD emulation.
New for version 0.4.6:
- Added support for libewf v2
New for version 0.4.5:
- Show the name of the mounted file in mount output
New for version 0.4.4:
- Fixed a bug that prevents VirtualBox 3.2.8 or above from recognising the
generated VDIs.
New for version 0.4.1:
- Code cleanups and some minor bugfixes
New for version 0.4.0:
- AFFLIB support for input images
- AFFLIB and LIBEWF are now statically linked to xmount
New for version 0.3.2:
- Automatic addition of FUSE's "-o allow_other" option if it is supported.
New for version 0.3.1:
- Some bugfixes for VMDK emulation (Still experimental)
- It is now possible to specify whether VMDK disks are attached to the IDE
or SCSI bus. (Output type vmdk or vmdks)
New for version 0.3.0:
- Added experimental support for VMDK emulation
New for version 0.2.3:
- Virtual write support finally fixed
New for version 0.2.2:
- Fixed yet another bug in virtual write support
New for version 0.2.1:
- Fixed a bug in virtual write support
New for version 0.2.0:
- Name changed from mountewf to xmount
- Support for multiple input image formats (DD and EWF)
- Support for virtual write access
New for version 0.1.2:
- Added random generator initialisation (Makes it possible to use more than 1
mounted vdi in VBox)
New for version 0.1.1:
- Fixed some severe bugs
New for version 0.1.0:
- First release
- Support for emulation of dd and vdi files
diff --git a/trunk/README b/trunk/README
index 2507422..0a9cdf2 100644
--- a/trunk/README
+++ b/trunk/README
@@ -1,194 +1,251 @@
XMOUNT README FILE
Table of contents
0.0 Author and license stuff
1.0 What is xmount? - A short description
- 2.0 A deeper view of things
- 2.1 Emulated DD file
- 2.2 Emulated DMG file
- 2.3 Emulated VDI file
- 2.4 Emulated VMDK file
- 2.5 Emulated VHD file
- 2.6 Virtual write access
- 3.0 Installation instructions
- 3.1 Prerequisits
- 3.1 Install from a package
- 3.2 Install from source
- 4.0 xmount command line parameters
- 4.1 xmount usage examples
+ 2.0 Input image support
+ 2.1 libxmount_input_raw
+ 2.2 libxmount_input_ewf
+ 2.3 libxmount_input_aewf
+ 2.4 libxmount_input_aff
+ 2.5 libxmount_input_aaff
+ 3.0 Morphing support
+ 3.1 libxmount_morphing_combine
+ 3.2 libxmount_morphing_raid
+ 3.3 libxmount_morphing_unallocated
+ 4.0 Output image
+ 4.1 Emulated DD file
+ 4.2 Emulated DMG file
+ 4.3 Emulated VDI file
+ 4.4 Emulated VMDK file
+ 4.5 Emulated VHD file
+ 5.0 Virtual write access
+ 6.0 Installation instructions
+ 6.1 Prerequisits
+ 6.1 Install from a package
+ 6.2 Install from source
+ 7.0 xmount command line parameters
+ 7.1 xmount usage examples
0.0 Author and license stuff
xmount Copyright (c) 2008-2014 by Gillen Daniel <gillen.dan@pinguin.lu>
This program is free software: you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation, either version 3 of the License, or (at your option) any later
version.
This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with
this program. If not, see <http://www.gnu.org/licenses/>.
---
Due to AFFLIB, I have to mention that:
This product includes software developed by Simson L. Garfinkel and Basis
Technology Corp.
1.0 What is xmount? - A short description
xmount allows you to convert on-the-fly between multiple input and output
harddisk image formats. xmount creates a virtual file system using FUSE
(Filesystem in Userspace) that contains a virtual representation of the input
image.
The virtual representation can be in raw DD, Apple's Disk Image format (DMG),
VirtualBox's virtual disk file format (VDI), Microsoft's Virtual Hard Disk
Image format (VHD) or in VmWare's VMDK file format.
Input images can be raw DD, EWF (Expert Witness Compression Format) or AFF
(Advanced Forensic Format) files.
In addition, xmount also supports virtual write access to the output files
that is redirected to a cache file. This makes it possible to boot acquired
harddisk images using QEMU, KVM, VirtualBox, VmWare or alike.
-2.0 A deeper view of things
- 2.1 Emulated DD file
+2.0 Input image support
+ Starting with version 0.7.0, input image support has been moved into external
+ libraries. The following chapters list the officially supported ones. They
+ might not all be available on your system though.
+
+ 2.1 libxmount_input_raw
+ Supports raw DD images ("--in raw" or "--in dd").
+
+ 2.2 libxmount_input_ewf
+ Supports EWF (Expert Witness Compression Format) images ("--in ewf") using
+ Joachim Metz's libewf (https://code.google.com/p/libewf/).
+
+ 2.3 libxmount_input_aewf
+ Supports EWF (Expert Witness Compression Format) images ("--in aewf")
+ generated with Guymager (http://guymager.sourceforge.net/). This library
+ uses an EWF implementation written by Guy Voncken.
+
+ 2.4 libxmount_input_aff
+ Supports AFF (Advanced Forensic Format) images ("--in aff") using Simson
+ Garfinkel's afflib (https://github.com/simsong/AFFLIBv3).
+
+ 2.5 libxmount_input_aaff
+ Supports AFF (Advanced Forensic Format) images ("--in aaff") using an AFF
+ implementation written by Guy Voncken.
+
+3.0 Morphing support
+ Also starting with xmount version 0.7.0, a new concept of input image morphing
+ has been added. Morphing is a process which is applied to the data of all
+ specified input images and produces a single virtual image which can then be
+ converted into an output image. The following chapters list the currently
+ officially supported morphing libraries. As with the input image libs, not all
+ might be available on your system.
+
+ 3.1 libxmount_morphing_combine
+ Using "--morph combine", data from all input images is concatenated into
+ a single image. Images are appended in the same order they are specified on
+ the command line. This morphing type is also the default if no "--morph"
+ option is specified.
+
+ 3.2 libxmount_morphing_raid
+ This morphing library supports emulation of hardware / software raid.
+ Currently, only RAID0 ("--morph raid0") is supported. The used chunk /
+ stripe size in bytes can be specified with "--morphopts raid_chunksize=XXX".
+
+ 3.3 libxmount_morphing_unallocated
+
+
+4.0 Output image
+ 4.1 Emulated DD file
This is the standard data representation used by xmount. It is a file
containing the raw data contained in the input image file. Except for OSx
(see 2.2) this is the default output format when no --out option is
specified.
- 2.2 Emulated DMG file
+ 4.2 Emulated DMG file
This is also a file containing the raw data contained in the input image
file but with a .dmg file extension. On OSx, this is the default output
format when no --out option is specified.
- 2.3 Emulated VDI file
+ 4.3 Emulated VDI file
When using the "--out vdi" command line parameter, a VirtualBox disk file
is emulated. This means that xmount builds a virtual VDI header and prepends
it to the raw data contained in the input image. The VDI file can be used in
VirtualBox as a virtual disk file.
- 2.4 Emulated VMDK file
+ 4.4 Emulated VMDK file
When using the "--out vmdk(s)" command line paramter, a VMWare virtual disk
file will be emulated. This mainly consists in building a VMDK descriptor
file that will access an emulated DD file. You can use this VMDK file to
add your input image as virtual disk to a VMWare virtual machine. "vmdk" is
a VMWare disk attached to the IDE bus and "vmdks" is attached to the SCSI
bus.
When emulating VMDK files to be used in VMWare, you have to enable
"user_allow_other" in /etc/fuse.conf or run xmount and VmWare as root.
WARNING: VMDK support should be considered experimental and currently the
VMDK descriptor file isn't cached.
- 2.5 Emulated VHD file
+ 4.5 Emulated VHD file
When using the "--out vhd" command line parameter, a Virtual Hard Disk Image
file is emulated by appending to the raw data a valid VHD footer. Valid here
means as described in Microsoft's Virtual Hard Disk Image Format specs v1.
- 2.6 Virtual write access
+5.0 Virtual write access
By using the "--cache <cache_file>" command line parameter, xmount allows
you to change data in the emulated image files. All changes are written to a
separate cache file. No data will ever be written to the original input
image files! Write access is limited to change existing data. It isn't
possible to change the emulated image's file size (no append or truncate)!
The same cache file can be used with different output image formats without
loosing changed data.
-3.0 Installation instructions
+6.0 Installation instructions
To install xmount, you can use a prebuild package for your distribution or
you can build xmount from source. The two methods are described in the
following sections.
- 3.1 Prerequisits
+ 6.1 Prerequisits
SYSTEM:
- Linux: Some sort of Linux with a recent kernel (2.6.x or above).
- OSx: OSx 10.6 or above
FUSE:
Your os must support FUSE and have the appropriate libraries installed.
(See http://fuse.sourceforge.net/ for more informations). To be able to
install from source, you also need the FUSE header files. On OSx, you can
use osxfuse instead.
LIBEWF:
To enable EWF input image support. Get it from
http://sourceforge.net/projects/libewf/
LIBAFF:
To enable AFF input image support. Get it from http://www.afflib.org/
- 3.2 Install from a package
+ 6.2 Install from a package
Chances are I provide prebuild binary packages for Debian / Ubuntu. In this
case, you only have to fire up your distribution's package manager and
install xmount. See https://www.pinguin.lu/xmount for more information and
download links.
- 3.3 Install from source
+ 6.3 Install from source
After having checked the prerequisits, you should be able to compile and
install xmount by simply issuing the following commands:
$ mkdir build
$ cd build
$ cmake -DCMAKE_BUILD_TYPE=Release ..
$ make
$ sudo make install
-4.0 xmount command line parameters
+7.0 xmount command line parameters
xmount [[fopts] [mopts]] <ifile> [<ifile> [...]] <mntp>
fopts:
-d : Enable FUSE's and xmount's debug mode.
-s : Run single threaded.
-o no_allow_other : Disable automatic addition of FUSE's allow_other option.
-o <fmopts> : Specify fuse mount options. Will also disable automatic
addition of FUSE's allow_other option!
mopts:
--cache <file> : Enable virtual write support and set cachefile to use.
--in <itype> : Input image format. <itype> can be "dd", "ewf".
--inopts <iopts> : Specify input library specific options.
--info : Print out some infos about used compiler and libraries.
--offset <off> : Move the output image data start <off> bytes into the input
image.
--out <otype> : Output image format.
<otype> can be "dd", "dmg", "vdi", "vhd", "vmdk(s)".
--owcache <file> : Same as --cache <file> but overwrites existing cache.
--rw <file> : Same as --cache <file>. Deprecated!
--version : Same as --info.
INFO: Input and output image type defaults to "dd" if not specified.
ifile:
Input image file. If your input image is split into multiple files, you have
to specify them all!
mntp:
Mount point where virtual files should be located.
iopts:
Some input libraries might support an own set of options to configure / tune
their behaviour. If so, their options can be specified here as comma
sepearated list of key=value pairs.
- 4.1 xmount usage examples
+ 7.1 xmount usage examples
To xmount an EWF harddisk image from your acquired disk as a raw DD image
under /mnt, use the following command:
xmount --in ewf ./acquired_disk.E?? /mnt
To xmount the same ewf image as vdi file, you would use a command like this:
xmount --in ewf --out vdi ./acquired_disk.E?? /mnt
And to enable virtual write support on a raw DD input image xmounted as VDI
file:
xmount --out vdi --cache ./acquired_disk.cache ./acquired_disk.dd /mnt
diff --git a/trunk/libxmount_input/libxmount_input_aaff/libxmount_input_aaff.c b/trunk/libxmount_input/libxmount_input_aaff/libxmount_input_aaff.c
index c35b76f..272896b 100644
--- a/trunk/libxmount_input/libxmount_input_aaff/libxmount_input_aaff.c
+++ b/trunk/libxmount_input/libxmount_input_aaff/libxmount_input_aaff.c
@@ -1,1050 +1,1046 @@
/*******************************************************************************
-* xmount Copyright (c) 2008,2009, 2010, 2011, 2012 *
-* by Gillen Daniel <gillen.dan@pinguin.lu> *
+* xmount Copyright (c) 2008-2014 by Gillen Daniel <gillen.dan@pinguin.lu> *
* *
* This module has been written by Guy Voncken. It contains the functions for *
* accessing simple AFF images created by Guymager. *
* *
-* xmount is a small tool to "fuse mount" various image formats as dd or vdi *
-* files and enable virtual write access. *
-* *
* This program is free software: you can redistribute it and/or modify it *
* under the terms of the GNU General Public License as published by the Free *
* Software Foundation, either version 3 of the License, or (at your option) *
* any later version. *
* *
* This program is distributed in the hope that it will be useful, but WITHOUT *
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or *
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for *
* more details. *
* *
* You should have received a copy of the GNU General Public License along with *
* this program. If not, see <http://www.gnu.org/licenses/>. *
*******************************************************************************/
// Please don't touch source code formatting!
#ifdef LINTING
// #define _LARGEFILE_SOURCE
// #define _FILE_OFFSET_BITS 64
#define AAFF_STANDALONE
#endif
#ifdef AAFF_STANDALONE
#define LOG_STDOUT TRUE
#endif
#include <netinet/in.h>
#include <string.h>
#include <stddef.h>
#include <stdio.h>
#include <stdlib.h>
#include <locale.h>
#include <limits.h>
#include <zlib.h>
#include <time.h>
#include <errno.h>
#include "../libxmount_input.h"
#include "libxmount_input_aaff.h"
static int AaffClose (void *pHandle);
static const char* AaffGetErrorMessage (int ErrNum);
#define AAFF_OPTION_MAXPAGEARRMEM "aaffmaxmem"
#define AAFF_OPTION_LOG "aafflog"
// ----------------------------
// Logging and error handling
// ----------------------------
#define LOG_HEADER_LEN 80
int LogvEntry (const char *pLogFileName, uint8_t LogStdout, const char *pFileName, const char *pFunctionName, int LineNr, const char *pFormat, va_list pArguments)
{
time_t NowT;
struct tm *pNowTM;
FILE *pFile;
int wr;
char *pFullLogFileName = NULL;
const char *pBase;
char LogLineHeader[1024];
pid_t OwnPID;
if (!LogStdout && (pLogFileName==NULL))
return AAFF_OK;
time (&NowT);
pNowTM = localtime (&NowT);
OwnPID = getpid(); // pthread_self()
wr = (int) strftime (&LogLineHeader[0] , sizeof(LogLineHeader) , "%a %d.%b.%Y %H:%M:%S ", pNowTM); //lint !e713
wr += snprintf (&LogLineHeader[wr], sizeof(LogLineHeader)-wr, "%5d ", OwnPID); //lint !e737
if (pFileName && pFunctionName)
{
pBase = strrchr(pFileName, '/');
if (pBase)
pFileName = pBase+1;
wr += snprintf (&LogLineHeader[wr], sizeof(LogLineHeader)-wr, "%s %s %d ", pFileName, pFunctionName, LineNr); //lint !e737
}
// while (wr < LOG_HEADER_LEN)
// LogLineHeader[wr++] = ' ';
if (pLogFileName)
{
wr = asprintf (&pFullLogFileName, "%s_%d", pLogFileName, OwnPID);
if ((wr <= 0) || (pFullLogFileName == NULL))
{
if (LogStdout)
printf ("\nLog file error: Can't build filename");
return AAFF_MEMALLOC_FAILED;
}
else
{
pFile = fopen64 (pFullLogFileName, "a");
if (pFile == NULL)
{
if (LogStdout)
printf ("\nLog file error: Can't be opened");
return AAFF_CANNOT_OPEN_LOGFILE;
}
else
{
fprintf (pFile, "%-*s", LOG_HEADER_LEN, &LogLineHeader[0]);
vfprintf (pFile, pFormat, pArguments);
fprintf (pFile, "\n");
fclose (pFile);
}
free (pFullLogFileName);
}
}
if (LogStdout)
{
printf ("%s", &LogLineHeader[0]);
vprintf (pFormat, pArguments);
printf ("\n");
}
return AAFF_OK;
}
int LogEntry (const char *pLogFileName, uint8_t LogStdout, const char *pFileName, const char *pFunctionName, int LineNr, const char *pFormat, ...)
{
va_list VaList;
int rc;
if (!LogStdout && (pLogFileName==NULL))
return AAFF_OK;
va_start (VaList, pFormat); //lint !e530 Symbol 'VaList' not initialized
rc = LogvEntry (pLogFileName, LogStdout, pFileName, pFunctionName, LineNr, pFormat, VaList);
va_end(VaList);
return rc;
}
// CHK requires existance of pAaff handle
#ifdef AAFF_STANDALONE
#define LOG_ERRORS_ON_STDOUT TRUE
#else
#define LOG_ERRORS_ON_STDOUT pAaff->LogStdout
#endif
#define CHK(ChkVal) \
{ \
int ChkValRc; \
if ((ChkValRc=(ChkVal)) != AAFF_OK) \
{ \
const char *pErr = AaffGetErrorMessage (ChkValRc); \
LogEntry (pAaff->pLogFilename, LOG_ERRORS_ON_STDOUT, __FILE__, __FUNCTION__, __LINE__, "Error %d (%s) occured", ChkValRc, pErr); \
return ChkValRc; \
} \
}
#define LOG(...) \
LogEntry (pAaff->pLogFilename, pAaff->LogStdout, __FILE__, __FUNCTION__, __LINE__, __VA_ARGS__);
// AaffCheckError is called before exiting AaffRead. It should not
// be called elsewehere or else the statistics would become wrong.
static void AaffCheckError (t_pAaff pAaff, int Ret, int *pErrno)
{
*pErrno = 0;
if (Ret != AAFF_OK)
{
if ((Ret >= AAFF_ERROR_ENOMEM_START) && (Ret <= AAFF_ERROR_ENOMEM_END)) *pErrno = ENOMEM;
else if ((Ret >= AAFF_ERROR_EINVAL_START) && (Ret <= AAFF_ERROR_EINVAL_END)) *pErrno = EINVAL;
else *pErrno = EIO; // all other errors
}
}
// ------------------------------------
// Internal functions
// ------------------------------------
uint64_t AaffU64 (char *pData)
{
uint64_t Val=0;
int i;
for (i=4; i<8; i++) Val = (Val << 8) | pData[i];
for (i=0; i<4; i++) Val = (Val << 8) | pData[i];
return Val;
}
static int AaffPageNumberFromSegmentName (char *pSegmentName, uint64_t *pPageNumber)
{
char *pSegmentNamePageNumber;
char *pTail;
pSegmentNamePageNumber = &pSegmentName[strlen(AFF_SEGNAME_PAGE)];
*pPageNumber = strtoull (pSegmentNamePageNumber, &pTail, 10);
if (*pTail != '\0')
return AAFF_INVALID_PAGE_NUMBER; // There should be no extra chars after the number
return AAFF_OK;
}
static inline uint64_t AaffGetCurrentSeekPos (t_Aaff *pAaff)
{
return ftello (pAaff->pFile);
}
static inline uint64_t AaffSetCurrentSeekPos (t_Aaff *pAaff, uint64_t Val, int Whence)
{
if (fseeko (pAaff->pFile, Val, Whence) != 0)
return AAFF_CANNOT_SEEK;
return AAFF_OK;
}
static int AaffReadFile (t_Aaff *pAaff, void *pData, uint32_t DataLen)
{
if (fread (pData, DataLen, 1, pAaff->pFile) != 1)
return AAFF_CANNOT_READ_DATA;
return AAFF_OK;
}
static int AaffRealloc (void **ppBuff, uint32_t *pCurrentLen, uint32_t NewLen)
{
if (NewLen > *pCurrentLen)
{
*ppBuff = realloc (*ppBuff, NewLen);
if (*ppBuff == NULL)
return AAFF_MEMALLOC_FAILED;
*pCurrentLen = NewLen;
}
return AAFF_OK;
}
static int AaffReadSegment (t_pAaff pAaff, char **ppName, uint32_t *pArg, char **ppData, uint32_t *pDataLen)
{
t_AffSegmentHeader Header;
t_AffSegmentFooter Footer;
CHK (AaffReadFile (pAaff, &Header, offsetof(t_AffSegmentHeader, Name)))
if (strcmp (&Header.Magic[0], AFF_SEGMENT_HEADER_MAGIC) != 0)
return AAFF_INVALID_HEADER;
Header.NameLen = ntohl (Header.NameLen );
Header.DataLen = ntohl (Header.DataLen );
Header.Argument = ntohl (Header.Argument);
CHK (AaffRealloc ((void**)&pAaff->pNameBuff, &pAaff->NameBuffLen, Header.NameLen+1)) // alloc +1, as is might be a string which can be more
CHK (AaffRealloc ((void**)&pAaff->pDataBuff, &pAaff->DataBuffLen, Header.DataLen+1)) // easily handled by the calling fn when adding a \0
CHK (AaffReadFile (pAaff, pAaff->pNameBuff, Header.NameLen))
if (Header.DataLen)
CHK (AaffReadFile (pAaff, pAaff->pDataBuff, Header.DataLen))
pAaff->pNameBuff[Header.NameLen] = '\0';
pAaff->pDataBuff[Header.DataLen] = '\0';
if (ppName) *ppName = pAaff->pNameBuff;
if (pArg ) *pArg = Header.Argument;
if (ppData) *ppData = pAaff->pDataBuff;
if (pDataLen) *pDataLen = Header.DataLen;
// Read footer and position file pointer to next segemnt at the same time
// ----------------------------------------------------------------------
CHK (AaffReadFile (pAaff, &Footer, sizeof(Footer)))
if (strcmp (&Footer.Magic[0], AFF_SEGMENT_FOOTER_MAGIC) != 0)
return AAFF_INVALID_FOOTER;
return AAFF_OK;
}
static int AaffReadSegmentPage (t_pAaff pAaff, uint64_t SearchPage, uint64_t *pFoundPage, char **ppData, uint32_t *pDataLen)
{
t_AffSegmentHeader Header;
t_AffSegmentFooter Footer;
char SearchPageStr[128];
int rc = AAFF_OK;
*ppData = NULL;
*pDataLen = 0;
sprintf (SearchPageStr, "page%" PRIu64, SearchPage);
CHK (AaffReadFile (pAaff, &Header, offsetof(t_AffSegmentHeader, Name)))
if (strcmp (&Header.Magic[0], AFF_SEGMENT_HEADER_MAGIC) != 0)
return AAFF_INVALID_HEADER;
Header.NameLen = ntohl (Header.NameLen );
Header.DataLen = ntohl (Header.DataLen );
Header.Argument = ntohl (Header.Argument);
CHK (AaffRealloc ((void**)&pAaff->pNameBuff, &pAaff->NameBuffLen, Header.NameLen+1))
CHK (AaffReadFile (pAaff, pAaff->pNameBuff, Header.NameLen))
pAaff->pNameBuff[Header.NameLen] = '\0';
if (strncmp (pAaff->pNameBuff, AFF_SEGNAME_PAGE, strlen(AFF_SEGNAME_PAGE)) != 0)
return AAFF_WRONG_SEGMENT;
CHK (AaffPageNumberFromSegmentName (pAaff->pNameBuff, pFoundPage))
if (*pFoundPage == SearchPage)
{
unsigned int Len;
uLongf ZLen;
int zrc;
switch (Header.Argument)
{
case AFF_PAGEFLAGS_UNCOMPRESSED:
CHK (AaffReadFile (pAaff, pAaff->pPageBuff, Header.DataLen))
pAaff->PageBuffDataLen = Header.DataLen;
break;
case AFF_PAGEFLAGS_COMPRESSED_ZERO:
CHK (AaffReadFile (pAaff, &Len, sizeof(Len)))
Len = ntohl (Len);
memset (pAaff->pPageBuff, 0, Len);
pAaff->PageBuffDataLen = Len;
break;
case AFF_PAGEFLAGS_COMPRESSED_ZLIB:
CHK (AaffRealloc ((void**)&pAaff->pDataBuff, &pAaff->DataBuffLen, Header.DataLen));
CHK (AaffReadFile (pAaff, pAaff->pDataBuff, Header.DataLen)) // read into pDataBuff
ZLen = pAaff->PageSize; // size of pPageBuff
zrc = uncompress ((unsigned char*)(pAaff->pPageBuff), &ZLen, (unsigned char*)(pAaff->pDataBuff), Header.DataLen); // uncompress into pPageBuff
pAaff->PageBuffDataLen = ZLen;
if (zrc != Z_OK)
return AAFF_UNCOMPRESS_FAILED;
break;
default:
return AAFF_INVALID_PAGE_ARGUMENT;
}
*ppData = pAaff->pPageBuff;
*pDataLen = pAaff->PageBuffDataLen;
pAaff->CurrentPage = *pFoundPage;
rc = AAFF_FOUND;
}
else
{
CHK (AaffSetCurrentSeekPos (pAaff, Header.DataLen, SEEK_CUR))
}
// Read footer and position file pointer to next segemnt at the same time
// ----------------------------------------------------------------------
CHK (AaffReadFile (pAaff, &Footer, sizeof(Footer)))
if (strcmp (&Footer.Magic[0], AFF_SEGMENT_FOOTER_MAGIC) != 0)
return AAFF_INVALID_FOOTER;
return rc;
}
static int AaffReadPage (t_pAaff pAaff, uint64_t Page, char **ppBuffer, uint32_t *pLen)
{
if (Page >= pAaff->TotalPages)
return AAFF_READ_BEYOND_LAST_PAGE;
// Check if it's the current page
// ------------------------------
if (Page == pAaff->CurrentPage)
{
*ppBuffer = pAaff->pPageBuff;
*pLen = pAaff->PageBuffDataLen;
return AAFF_OK;
}
// Set the seek position for starting the search
// ---------------------------------------------
int MaxHops;
if ((pAaff->CurrentPage != AAFF_CURRENTPAGE_NOTSET) &&
(pAaff->CurrentPage+1 == Page)) // The current seek pos already is the correct one
{
MaxHops = 1;
}
else // Find the closest entry in PageSeekArr
{
int64_t Entry;
Entry = Page / pAaff->Interleave;
while (pAaff->pPageSeekArr[Entry] == 0)
{
Entry--;
if (Entry<0)
return AAFF_SEEKARR_CORRUPT;
}
AaffSetCurrentSeekPos (pAaff, pAaff->pPageSeekArr[Entry], SEEK_SET);
MaxHops = Page - (Entry * pAaff->Interleave) +1;
}
// Run through segment list until page is found
// --------------------------------------------
uint64_t Seek;
uint64_t FoundPage=0;
int rc;
LOG ("Searching for page %" PRIu64 ", MaxHops=%d", Page, MaxHops);
while (MaxHops--)
{
Seek = AaffGetCurrentSeekPos (pAaff);
rc = AaffReadSegmentPage (pAaff, Page, &FoundPage, ppBuffer, pLen);
if (rc != AAFF_FOUND)
CHK (rc)
LOG (" %" PRIu64 " (%d)", FoundPage, rc);
if ((FoundPage % pAaff->Interleave) == 0)
pAaff->pPageSeekArr[FoundPage/pAaff->Interleave] = Seek;
if (rc == AAFF_FOUND)
break;
}
if (MaxHops < 0)
return AAFF_PAGE_NOT_FOUND;
return AAFF_OK;
}
// ---------------
// API functions
// ---------------
static int AaffCreateHandle (void **ppHandle, const char *pFormat, uint8_t Debug)
{
t_pAaff pAaff;
*ppHandle = NULL;
pAaff = (t_pAaff) malloc (sizeof(t_Aaff));
if (pAaff == NULL)
return AAFF_MEMALLOC_FAILED;
memset (pAaff, 0, sizeof(t_Aaff));
pAaff->MaxPageArrMem = AAFF_DEFAULT_MAX_PAGE_ARR_MEM;
pAaff->LogStdout = Debug;
*ppHandle = (void*) pAaff;
return AAFF_OK;
}
static int AaffDestroyHandle (void **ppHandle)
{
t_pAaff pAaff = (t_pAaff) *ppHandle;
if (pAaff->pFilename) free (pAaff->pFilename);
if (pAaff->pPageSeekArr) free (pAaff->pPageSeekArr);
if (pAaff->pLibVersion) free (pAaff->pLibVersion);
if (pAaff->pFileType) free (pAaff->pFileType);
if (pAaff->pNameBuff) free (pAaff->pNameBuff);
if (pAaff->pDataBuff) free (pAaff->pDataBuff);
if (pAaff->pPageBuff) free (pAaff->pPageBuff);
if (pAaff->pInfoBuffConst) free (pAaff->pInfoBuffConst);
if (pAaff->pInfoBuff) free (pAaff->pInfoBuff);
memset (pAaff, 0, sizeof(t_Aaff));
free (pAaff);
*ppHandle = NULL;
return AAFF_OK;
}
int AaffOpen (void *pHandle, const char **ppFilenameArr, uint64_t FilenameArrLen)
{
t_pAaff pAaff = (t_pAaff) pHandle;
char Signature[strlen(AFF_HEADER)+1];
uint64_t Seek;
LOG ("Called - Files=%" PRIu64, FilenameArrLen);
if (FilenameArrLen != 1)
CHK (AAFF_SPLIT_IMAGES_NOT_SUPPORTED)
pAaff->pFilename = strdup (ppFilenameArr[0]);
pAaff->pFile = fopen (ppFilenameArr[0],"r");
if(pAaff->pFile==NULL)
{
(void) AaffDestroyHandle ((void**) &pAaff);
CHK (AAFF_FILE_OPEN_FAILED)
}
// Check signature
// ---------------
CHK (AaffReadFile (pAaff, &Signature, sizeof(Signature)))
if (memcmp (Signature, AFF_HEADER, sizeof(Signature)) !=0)
{
(void)AaffClose((void**)&pAaff);
CHK (AAFF_INVALID_SIGNATURE)
}
// Read header segments
// --------------------
char *pName;
uint32_t Arg;
char *pData;
uint32_t DataLen;
const int MAX_HEADER_SEGMENTS = 100;
int Seg;
unsigned int i;
int wr;
int Pos = 0;
const unsigned HexStrLen = 32;
char HexStr[HexStrLen+1];
#define REM (AaffInfoBuffLen-Pos)
pAaff->pInfoBuffConst = (char *) malloc (AaffInfoBuffLen);
pAaff->pInfoBuff = (char *) malloc (AaffInfoBuffLen*2);
// Search for known segments at the image start
for (Seg=0; Seg<MAX_HEADER_SEGMENTS; Seg++)
{
Seek = AaffGetCurrentSeekPos (pAaff);
CHK (AaffReadSegment (pAaff, &pName, &Arg, &pData, &DataLen))
if (strcmp (pName, AFF_SEGNAME_PAGESIZE) == 0 ) pAaff->PageSize = Arg;
else if (strcmp (pName, AFF_SEGNAME_SECTORSIZE) == 0 ) pAaff->SectorSize = Arg;
else if (strcmp (pName, AFF_SEGNAME_SECTORS) == 0 ) pAaff->Sectors = AaffU64(pData);
else if (strcmp (pName, AFF_SEGNAME_IMAGESIZE) == 0 ) pAaff->ImageSize = AaffU64(pData);
else if (strcmp (pName, AFF_SEGNAME_AFFLIB_VERSION) == 0 ) pAaff->pLibVersion = strdup((char*)pData);
else if (strcmp (pName, AFF_SEGNAME_FILETYPE) == 0 ) pAaff->pFileType = strdup((char*)pData);
else if ((strcmp(pName, AFF_SEGNAME_GID) == 0 ) ||
(strcmp(pName, AFF_SEGNAME_BADFLAG) == 0 ))
{
wr=0;
for (i=0; i<GETMIN(DataLen,HexStrLen/2); i++)
wr += sprintf (&HexStr[wr], "%02X", pData[i]);
HexStr[i] = '\0';
Pos += snprintf (&(pAaff->pInfoBuffConst[Pos]), REM,"%-25s %s", pName, HexStr);
if (i<DataLen)
Pos += snprintf (&(pAaff->pInfoBuffConst[Pos]), REM,"...");
Pos += snprintf (&(pAaff->pInfoBuffConst[Pos]), REM,"\n");
}
else if (strncmp(pName,AFF_SEGNAME_PAGE,strlen(AFF_SEGNAME_PAGE))==0)
{
break;
}
else
{
if ((Arg == 0) && DataLen)
Pos += snprintf (&(pAaff->pInfoBuffConst[Pos]), REM,"%-25s %s\n", pName, pData);
}
}
#undef REM
if (Seg >= MAX_HEADER_SEGMENTS)
{
(void) AaffClose ((void**)&pAaff);
CHK (AAFF_TOO_MANY_HEADER_SEGEMENTS)
}
if (strstr (pAaff->pLibVersion, "Guymager") == NULL)
{
(void) AaffClose ((void**)&pAaff);
CHK (AAFF_NOT_CREATED_BY_GUYMAGER)
}
// Prepare page seek array
// -----------------------
uint64_t MaxEntries;
int ArrBytes;
pAaff->TotalPages = pAaff->ImageSize / pAaff->PageSize;
if (pAaff->ImageSize % pAaff->PageSize)
pAaff->TotalPages++;
MaxEntries = (pAaff->MaxPageArrMem*1024*1024) / (sizeof (unsigned long long *) + 1); // +1 in order not to risk a result of 0
MaxEntries = GETMIN (MaxEntries, pAaff->TotalPages);
pAaff->Interleave = pAaff->TotalPages / MaxEntries;
if (pAaff->TotalPages % MaxEntries)
pAaff->Interleave++;
pAaff->PageSeekArrLen = pAaff->TotalPages / pAaff->Interleave;
ArrBytes = pAaff->PageSeekArrLen * sizeof(uint64_t *);
pAaff->pPageSeekArr = (uint64_t*)malloc (ArrBytes);
memset (pAaff->pPageSeekArr, 0, ArrBytes);
CHK (AaffPageNumberFromSegmentName (pName, &pAaff->CurrentPage));
if (pAaff->CurrentPage != 0)
{
(void) AaffClose ((void**)&pAaff);
CHK (AAFF_UNEXPECTED_PAGE_NUMBER)
}
pAaff->pPageSeekArr[0] = Seek;
// Alloc Buffers
// -------------
pAaff->pPageBuff = (char *) malloc (pAaff->PageSize);
pAaff->CurrentPage = AAFF_CURRENTPAGE_NOTSET;
LOG ("Ret");
return AAFF_OK;
}
static int AaffClose (void *pHandle)
{
t_pAaff pAaff = (t_pAaff) pHandle;
int rc = AAFF_OK;
LOG ("Called");
if (fclose (pAaff->pFile))
rc = AAFF_CANNOT_CLOSE_FILE;
LOG ("Ret");
return rc;
}
static int AaffSize (void *pHandle, uint64_t *pSize)
{
t_pAaff pAaff = (t_pAaff) pHandle;
LOG ("Called");
*pSize = pAaff->ImageSize;
LOG ("Ret - Size=%" PRIu64, *pSize);
return AAFF_OK;
}
static int AaffRead (void *pHandle, char *pBuf, off_t Seek, size_t Count, size_t *pRead, int *pErrno)
{
t_pAaff pAaff = (t_pAaff) pHandle;
char *pPageBuffer;
uint64_t Page;
uint64_t Seek64;
uint64_t Remaining;
uint32_t PageLen, Ofs, ToCopy;
int Ret = AAFF_OK;
LOG ("Called - Seek=%'" PRIu64 ",Count=%'" PRIu64, Seek, Count);
*pRead = 0;
*pErrno = 0;
if (Seek < 0)
{
Ret = AAFF_NEGATIVE_SEEK;
goto Leave;
}
Seek64 = Seek;
if (Seek64 >= pAaff->ImageSize) // If calling function asks
goto Leave; // for data beyond end of
if ((Seek64+Count) > pAaff->ImageSize) // image simply return what
Count = pAaff->ImageSize - Seek64; // is possible.
Page = Seek64 / pAaff->PageSize;
Ofs = Seek64 % pAaff->PageSize;
Remaining = Count;
while (Count)
{
Ret = AaffReadPage (pAaff, Page, &pPageBuffer, &PageLen);
if (Ret)
goto Leave;
if (PageLen == 0)
{
Ret = AAFF_PAGE_LENGTH_ZERO;
goto Leave;
}
ToCopy = GETMIN (PageLen-Ofs, Remaining);
memcpy (pBuf, pPageBuffer+Ofs, ToCopy);
Remaining -= ToCopy;
pBuf += ToCopy;
*pRead += ToCopy;
Ofs=0;
Page++;
}
Leave:
AaffCheckError (pAaff, Ret, pErrno);
LOG ("Ret %d - Read=%" PRIu32, Ret, *pRead);
return Ret;
}
static int AaffOptionsHelp (const char **ppHelp)
{
char *pHelp=NULL;
int wr;
wr = asprintf (&pHelp, " %-12s : Maximum amount of RAM cache, in MiB, for image seek offsets. Default: %"PRIu64" MiB\n"
" %-12s : Log file name.\n"
" Specify full path for %s. The given file name is extended by _<pid>.\n",
AAFF_OPTION_MAXPAGEARRMEM, AAFF_DEFAULT_MAX_PAGE_ARR_MEM,
AAFF_OPTION_LOG,
AAFF_OPTION_LOG);
if ((pHelp == NULL) || (wr<=0))
return AAFF_MEMALLOC_FAILED;
*ppHelp = pHelp;
return AAFF_OK;
}
static int AaffOptionsParse (void *pHandle, uint32_t OptionCount, const pts_LibXmountOptions *ppOptions, const char **ppError)
{
pts_LibXmountOptions pOption;
t_pAaff pAaff = (t_pAaff) pHandle;
const char *pError = NULL;
int rc = AAFF_OK;
int Ok;
LOG ("Called - OptionCount=%" PRIu32, OptionCount);
*ppError = NULL;
#define TEST_OPTION_UINT64(Opt,DestField) \
if (strcmp (pOption->p_key, Opt) == 0) \
{ \
pAaff->DestField = StrToUint64 (pOption->p_value, &Ok); \
if (!Ok) \
{ \
pError = "Error in option %s: Invalid value"; \
break; \
} \
LOG ("Option %s set to %" PRIu64, Opt, pAaff->DestField) \
}
for (uint32_t i=0; i<OptionCount; i++)
{
pOption = ppOptions[i];
if (strcmp (pOption->p_key, AAFF_OPTION_LOG) == 0)
{
pAaff->pLogFilename = strdup (pOption->p_value);
rc = LOG ("Logging for libxmount_input_aaff started")
if (rc != AAFF_OK)
{
pError = "Write test to log file failed";
break;
}
pOption->valid = TRUE;
LOG ("Option %s set to %s", AAFF_OPTION_LOG, pAaff->pLogFilename);
}
else TEST_OPTION_UINT64 (AAFF_OPTION_MAXPAGEARRMEM, MaxPageArrMem)
}
#undef TEST_OPTION_UINT64
if (pError)
*ppError = strdup (pError);
LOG ("Ret - rc=%d,Error=%s", rc, *ppError);
return rc;
}
static int AaffGetInfofileContent (void *pHandle, const char **ppInfoBuf)
{
t_pAaff pAaff = (t_pAaff) pHandle;
uint64_t i;
uint64_t Entries = 0;
int Pos = 0;
LOG ("Called");
#define REM (AaffInfoBuffLen-Pos)
Pos += snprintf (&pAaff->pInfoBuff[Pos], REM, "AFF IMAGE INFORMATION");
Pos += snprintf (&pAaff->pInfoBuff[Pos], REM, "\n---------------------");
Pos += snprintf (&pAaff->pInfoBuff[Pos], REM, "\nAFF file %s" , pAaff->pFilename );
Pos += snprintf (&pAaff->pInfoBuff[Pos], REM, "\nPage size %u" , pAaff->PageSize );
Pos += snprintf (&pAaff->pInfoBuff[Pos], REM, "\nSector size %d" , pAaff->SectorSize );
Pos += snprintf (&pAaff->pInfoBuff[Pos], REM, "\nSectors %" PRIu64, pAaff->Sectors);
Pos += snprintf (&pAaff->pInfoBuff[Pos], REM, "\nImage size %" PRIu64 " (%0.1f GiB)", pAaff->ImageSize, pAaff->ImageSize/(1024.0*1024.0*1024.0));
Pos += snprintf (&pAaff->pInfoBuff[Pos], REM, "\nTotal pages %" PRIu64, pAaff->TotalPages);
Pos += snprintf (&pAaff->pInfoBuff[Pos], REM, "\n");
Pos += snprintf (&pAaff->pInfoBuff[Pos], REM, "\n%s", pAaff->pInfoBuffConst);
Pos += snprintf (&pAaff->pInfoBuff[Pos], REM, "\n");
Pos += snprintf (&pAaff->pInfoBuff[Pos], REM, "\nCurrent page ");
if (pAaff->CurrentPage == AAFF_CURRENTPAGE_NOTSET)
Pos += snprintf (&pAaff->pInfoBuff[Pos], REM, "not set");
else Pos += snprintf (&pAaff->pInfoBuff[Pos], REM, "%" PRIu64, pAaff->CurrentPage);
Pos += snprintf (&pAaff->pInfoBuff[Pos], REM, "\nSeek array length %" PRIu64, pAaff->PageSeekArrLen);
Pos += snprintf (&pAaff->pInfoBuff[Pos], REM, "\nSeek interleave %" PRIu64, pAaff->Interleave);
for (i=0; i<pAaff->PageSeekArrLen; i++)
{
if (pAaff->pPageSeekArr[i])
Entries++;
}
Pos += snprintf (&pAaff->pInfoBuff[Pos], REM, "\nSeek array entries %" PRIu64, Entries);
Pos += snprintf (&pAaff->pInfoBuff[Pos], REM, "\n");
#undef REM
*ppInfoBuf = strdup (pAaff->pInfoBuff);
if (*ppInfoBuf == NULL)
CHK (AAFF_MEMALLOC_FAILED)
LOG ("Ret - %d bytes of info", strlen(*ppInfoBuf)+1);
return AAFF_OK;
}
static const char* AaffGetErrorMessage (int ErrNum)
{
const char *pMsg;
#define ADD_ERR(ErrCode) \
case ErrCode: pMsg = #ErrCode; \
break;
switch (ErrNum)
{
ADD_ERR (AAFF_OK)
ADD_ERR (AAFF_FOUND)
ADD_ERR (AAFF_MEMALLOC_FAILED)
ADD_ERR (AAFF_OPTIONS_ERROR)
ADD_ERR (AAFF_SPLIT_IMAGES_NOT_SUPPORTED)
ADD_ERR (AAFF_INVALID_SIGNATURE)
ADD_ERR (AAFF_NOT_CREATED_BY_GUYMAGER)
ADD_ERR (AAFF_CANNOT_OPEN_LOGFILE)
ADD_ERR (AAFF_FILE_OPEN_FAILED)
ADD_ERR (AAFF_CANNOT_READ_DATA)
ADD_ERR (AAFF_INVALID_HEADER)
ADD_ERR (AAFF_INVALID_FOOTER)
ADD_ERR (AAFF_TOO_MANY_HEADER_SEGEMENTS)
ADD_ERR (AAFF_INVALID_PAGE_NUMBER)
ADD_ERR (AAFF_UNEXPECTED_PAGE_NUMBER)
ADD_ERR (AAFF_CANNOT_CLOSE_FILE)
ADD_ERR (AAFF_CANNOT_SEEK)
ADD_ERR (AAFF_WRONG_SEGMENT)
ADD_ERR (AAFF_UNCOMPRESS_FAILED)
ADD_ERR (AAFF_INVALID_PAGE_ARGUMENT)
ADD_ERR (AAFF_SEEKARR_CORRUPT)
ADD_ERR (AAFF_PAGE_NOT_FOUND)
ADD_ERR (AAFF_READ_BEYOND_IMAGE_LENGTH)
ADD_ERR (AAFF_READ_BEYOND_LAST_PAGE)
ADD_ERR (AAFF_PAGE_LENGTH_ZERO)
ADD_ERR (AAFF_NEGATIVE_SEEK)
default:
pMsg = "Unknown error";
}
#undef ARR_ERR
return pMsg;
}
static int AaffFreeBuffer (void *pBuf)
{
free (pBuf);
return AAFF_OK;
}
// ------------------------------------
// LibXmount_Input API implementation
// ------------------------------------
uint8_t LibXmount_Input_GetApiVersion ()
{
return LIBXMOUNT_INPUT_API_VERSION;
}
const char* LibXmount_Input_GetSupportedFormats ()
{
return "aaff\0\0";
}
void LibXmount_Input_GetFunctions(ts_LibXmountInputFunctions *pFunctions)
{
pFunctions->CreateHandle = &AaffCreateHandle;
pFunctions->DestroyHandle = &AaffDestroyHandle;
pFunctions->Open = &AaffOpen;
pFunctions->Close = &AaffClose;
pFunctions->Size = &AaffSize;
pFunctions->Read = &AaffRead;
pFunctions->OptionsHelp = &AaffOptionsHelp;
pFunctions->OptionsParse = &AaffOptionsParse;
pFunctions->GetInfofileContent = &AaffGetInfofileContent;
pFunctions->GetErrorMessage = &AaffGetErrorMessage;
pFunctions->FreeBuffer = &AaffFreeBuffer;
}
// -----------------------------------------------------
// Small main routine for testing
// It converts an aff file to dd
// -----------------------------------------------------
#ifdef AAFF_STANDALONE
#define PRINT_ERROR_AND_EXIT(...) \
{ \
printf (__VA_ARGS__); \
exit (1); \
}
int ParseOptions (t_pAaff pAaff, char *pOptions)
{
pts_LibXmountOptions pOptionArr;
pts_LibXmountOptions *ppOptionArr;
int OptionCount;
char *pSep;
char *pEqual;
char *pTmp;
const char *pError;
char *pOpt;
int rc;
if (pOptions == NULL)
return AAFF_OK;
if (*pOptions == '\0')
return AAFF_OK;
if (*pOptions == ',')
return AAFF_OPTIONS_ERROR;
if (pOptions[strlen(pOptions)-1] == ',')
return AAFF_OPTIONS_ERROR;
pOpt = strdup (pOptions);
// Count number of comma separated options
OptionCount = 1;
pTmp = pOpt;
while ((pTmp = strchr (pTmp, ',')) != NULL)
{
OptionCount++;
pTmp++;
}
// Create and fill option array
pOptionArr = (pts_LibXmountOptions) malloc (OptionCount * sizeof(ts_LibXmountOptions));
if (pOptionArr == NULL)
PRINT_ERROR_AND_EXIT ("Cannot allocate pOptionArr");
memset (pOptionArr, 0, OptionCount * sizeof(ts_LibXmountOptions));
pTmp = pOpt;
for (int i=0; i<OptionCount; i++)
{
pOptionArr[i].p_key = pTmp;
pSep = strchr (pTmp, ',');
if (pSep)
*pSep ='\0';
pEqual = strchr (pTmp, '=');
if (pEqual)
{
*pEqual = '\0';
pOptionArr[i].p_value = pEqual+1;
}
if (pSep != NULL)
pTmp = pSep+1;
}
// Create pointer array and call parse function
ppOptionArr = (pts_LibXmountOptions *)malloc (OptionCount*sizeof (pts_LibXmountOptions));
if (ppOptionArr == NULL)
PRINT_ERROR_AND_EXIT ("Cannot allocate ppOptionArr");
for (int i=0; i<OptionCount; i++)
ppOptionArr[i] = &pOptionArr[i];
rc = AaffOptionsParse ((void*) pAaff, OptionCount, ppOptionArr, &pError);
free (ppOptionArr);
free ( pOptionArr);
free ( pOpt);
if (pError)
PRINT_ERROR_AND_EXIT ("Error while setting options: %s", pError);
CHK (rc)
return AAFF_OK;
}
int main(int argc, const char *argv[])
{
t_pAaff pAaff;
const char *pInfoBuff;
const char *pHelp;
uint64_t Remaining;
uint64_t CurrentPos=0;
int rc;
int Errno;
int Percent;
int PercentOld;
char *pOptions = NULL;
setbuf (stdout, NULL);
setbuf (stderr, NULL);
setlocale (LC_ALL, "");
printf ("AFF to DD converter\n");
if (argc != 3)
{
(void) AaffOptionsHelp (&pHelp);
printf ("Usage: %s <EWF segment file 1> <EWF segment file 2> <...> [-comma_separated_options]\n", argv[0]);
printf ("Possible options:\n%s\n", pHelp);
printf ("The output file will be named dd.\n");
CHK (AaffFreeBuffer ((void*) pHelp))
exit (1);
}
if (argv[argc-1][0] == '-')
{
pOptions = strdup (&(argv[argc-1][1]));
argc--;
}
rc = AaffCreateHandle ((void**) &pAaff, "aaff", LOG_STDOUT);
if (rc != AAFF_OK)
PRINT_ERROR_AND_EXIT ("Cannot create handle, rc=%d\n", rc)
if (pOptions)
CHK (ParseOptions(pAaff, pOptions))
rc = AaffOpen (pAaff, &argv[1], 1);
if (rc)
{
printf ("Error %d while opening file %s\n", rc, argv[1]);
exit (2);
}
CHK (AaffGetInfofileContent ((void*) pAaff, &pInfoBuff))
if (pInfoBuff)
printf ("Contents of info buffer:\n%s\n", pInfoBuff);
CHK (AaffFreeBuffer ((void*)pInfoBuff))
// Create destination file and fill it with data from aff
// ------------------------------------------------------
FILE *pFile;
pFile = fopen (argv[2], "w");
// const unsigned BuffSize = 13; // weird Buffsize for testing
const unsigned BuffSize = 65536;
char *pBuff;
uint64_t ToRead;
uint64_t Read;
Remaining = pAaff->ImageSize;
pBuff = (char *) malloc (BuffSize);
CurrentPos=0;
Errno = 0;
PercentOld = -1;
while (Remaining)
{
ToRead = GETMIN (Remaining, BuffSize);
rc = AaffRead ((void*) pAaff, pBuff, CurrentPos, ToRead, &Read, &Errno);
if ((rc != AAFF_OK) || (Errno != 0))
PRINT_ERROR_AND_EXIT("Error %d while calling AewfRead (Errno %d)\n", rc, Errno);
if (Read != ToRead)
PRINT_ERROR_AND_EXIT("Only %" PRIu64 " out of %" PRIu64 " bytes read\n", Read, ToRead);
if (fwrite (pBuff, Read, 1, pFile) != 1)
{
printf ("Could not write to destinationfile\n");
exit (2);
}
CurrentPos += Read;
Remaining -= Read;
Percent = (100*CurrentPos) / pAaff->ImageSize;
if (Percent != PercentOld)
{
printf ("\r%d%% done...", Percent);
PercentOld = Percent;
}
}
free (pBuff);
fclose (pFile);
return 0;
}
#endif
diff --git a/trunk/libxmount_input/libxmount_input_aaff/libxmount_input_aaff.h b/trunk/libxmount_input/libxmount_input_aaff/libxmount_input_aaff.h
index 07f3cbd..95b7d87 100644
--- a/trunk/libxmount_input/libxmount_input_aaff/libxmount_input_aaff.h
+++ b/trunk/libxmount_input/libxmount_input_aaff/libxmount_input_aaff.h
@@ -1,183 +1,180 @@
/*******************************************************************************
-* xmount Copyright (c) 2008-2013 by Gillen Daniel <gillen.dan@pinguin.lu> *
+* xmount Copyright (c) 2008-2014 by Gillen Daniel <gillen.dan@pinguin.lu> *
* *
* This module has been written by Guy Voncken. It contains the functions for *
* accessing simple AFF images created by Guymager. *
* *
-* xmount is a small tool to "fuse mount" various harddisk image formats as dd, *
-* vdi, vhd or vmdk files and enable virtual write access to them. *
-* *
* This program is free software: you can redistribute it and/or modify it *
* under the terms of the GNU General Public License as published by the Free *
* Software Foundation, either version 3 of the License, or (at your option) *
* any later version. *
* *
* This program is distributed in the hope that it will be useful, but WITHOUT *
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or *
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for *
* more details. *
* *
* You should have received a copy of the GNU General Public License along with *
* this program. If not, see <http://www.gnu.org/licenses/>. *
*******************************************************************************/
// Please don't touch source code formatting!
#ifndef AAFF_H
#define AAFF_H
typedef struct _t_Aaff *t_pAaff;
// ----------------------
// Constant definitions
// ----------------------
#define GETMAX(a,b) ((a)>(b)?(a):(b))
#define GETMIN(a,b) ((a)<(b)?(a):(b))
#define FALSE 0
#define TRUE 1
const uint64_t AAFF_DEFAULT_MAX_PAGE_ARR_MEM = 10; // Default max. memory for caching seek points for fast page access (MiB)
const uint64_t AAFF_CURRENTPAGE_NOTSET = UINT64_MAX;
// -----------------
// AFF definitions
// -----------------
#define AFF_GID_LENGTH 16
#define AFF_SEGARG_U64 2 // Used as argument for segments that contain a 64 bit unsigned in the data field
#define AFF_HEADER "AFF10\r\n"
#define AFF_SEGMENT_HEADER_MAGIC "AFF"
#define AFF_SEGMENT_FOOTER_MAGIC "ATT"
#define AFF_BADSECTOR_HEADER "BAD SECTOR"
#define AFF_FILE_TYPE "AFF"
#define AFF_SEGNAME_BADFLAG "badflag"
#define AFF_SEGNAME_AFFLIB_VERSION "afflib_version"
#define AFF_SEGNAME_FILETYPE "aff_file_type"
#define AFF_SEGNAME_GID "image_gid"
#define AFF_SEGNAME_SECTORS "devicesectors"
#define AFF_SEGNAME_SECTORSIZE "sectorsize"
#define AFF_SEGNAME_IMAGESIZE "imagesize"
#define AFF_SEGNAME_PAGESIZE "pagesize"
#define AFF_SEGNAME_BADSECTORS "badsectors"
#define AFF_SEGNAME_MD5 "md5"
#define AFF_SEGNAME_SHA256 "sha256"
#define AFF_SEGNAME_DURATION "acquisition_seconds"
#define AFF_SEGNAME_PAGE "page"
#define AAFF_SEGNAME_COMMAND_LINE "acquisition_commandline"
#define AAFF_SEGNAME_MACADDR "acquisition_macaddr"
#define AAFF_SEGNAME_DATE "acquisition_date" // Format: YYYY-MM-DD HH:MM:SS TZT
#define AAFF_SEGNAME_DEVICE "acquisition_device"
#define AAFF_SEGNAME_MODEL "device_model"
#define AAFF_SEGNAME_SN "device_sn"
#define AFF_PAGEFLAGS_UNCOMPRESSED 0x0000
#define AFF_PAGEFLAGS_COMPRESSED_ZLIB 0x0001
#define AFF_PAGEFLAGS_COMPRESSED_ZERO 0x0033
#define AAFF_MD5_LEN 16
#define AAFF_SHA256_LEN 32
#define AAFF_BADSECTORMARKER_MAXLEN 65536
typedef struct
{
char Magic[4];
unsigned int NameLen;
unsigned int DataLen;
unsigned int Argument; // Named "flags" in original aff source, named "arg" in afinfo output.
char Name[]; //lint !e1501
} __attribute__ ((packed)) t_AffSegmentHeader;
typedef t_AffSegmentHeader *t_pAffSegmentHeader;
// Between header and footer lie the segment name and the data
typedef struct
{
char Magic[4];
unsigned int SegmentLen;
} __attribute__ ((packed)) t_AffSegmentFooter;
const int AaffInfoBuffLen = 1024*1024;
typedef struct _t_Aaff
{
char *pFilename;
FILE *pFile;
char *pLibVersion; // AFF File Header info
char *pFileType;
unsigned int PageSize;
unsigned int SectorSize;
uint64_t Sectors;
uint64_t ImageSize;
uint64_t TotalPages;
char *pNameBuff; // Buffers
char *pDataBuff;
unsigned int NameBuffLen;
unsigned int DataBuffLen;
uint64_t CurrentPage;
char *pPageBuff; // Length is PageSize, contains data of CurrentPage
unsigned int PageBuffDataLen; // Length of current data in PageBuff (the same for all pages, but the last one might contain less data)
char *pInfoBuff;
char *pInfoBuffConst;
uint64_t *pPageSeekArr;
uint64_t PageSeekArrLen;
uint64_t Interleave; // The number of pages lying between 2 entries in the PageSeekArr
// Options
char *pLogFilename;
uint64_t MaxPageArrMem; // Maximum amount of memory (in MiB) for storing page pointers
uint8_t LogStdout;
} t_Aaff;
// Possible error codes
enum
{
AAFF_OK = 0,
AAFF_FOUND,
AAFF_ERROR_ENOMEM_START=1000,
AAFF_MEMALLOC_FAILED,
AAFF_ERROR_ENOMEM_END,
AAFF_ERROR_EINVAL_START=2000,
AAFF_OPTIONS_ERROR,
AAFF_SPLIT_IMAGES_NOT_SUPPORTED,
AAFF_INVALID_SIGNATURE,
AAFF_NOT_CREATED_BY_GUYMAGER,
AAFF_CANNOT_OPEN_LOGFILE,
AAFF_ERROR_EINVAL_END,
AAFF_ERROR_EIO_START=3000,
AAFF_FILE_OPEN_FAILED,
AAFF_CANNOT_READ_DATA,
AAFF_INVALID_HEADER,
AAFF_INVALID_FOOTER,
AAFF_TOO_MANY_HEADER_SEGEMENTS,
AAFF_INVALID_PAGE_NUMBER,
AAFF_UNEXPECTED_PAGE_NUMBER,
AAFF_CANNOT_CLOSE_FILE,
AAFF_CANNOT_SEEK,
AAFF_WRONG_SEGMENT,
AAFF_UNCOMPRESS_FAILED,
AAFF_INVALID_PAGE_ARGUMENT,
AAFF_SEEKARR_CORRUPT,
AAFF_PAGE_NOT_FOUND,
AAFF_READ_BEYOND_IMAGE_LENGTH,
AAFF_READ_BEYOND_LAST_PAGE,
AAFF_PAGE_LENGTH_ZERO,
AAFF_NEGATIVE_SEEK,
AAFF_ERROR_EIO_END,
};
#endif
diff --git a/trunk/libxmount_input/libxmount_input_aewf/libxmount_input_aewf.c b/trunk/libxmount_input/libxmount_input_aewf/libxmount_input_aewf.c
index 8447319..ae04299 100644
--- a/trunk/libxmount_input/libxmount_input_aewf/libxmount_input_aewf.c
+++ b/trunk/libxmount_input/libxmount_input_aewf/libxmount_input_aewf.c
@@ -1,1530 +1,1530 @@
/*******************************************************************************
* xmount Copyright (c) 2008-2014 by Gillen Daniel <gillen.dan@pinguin.lu> *
* *
* This module has been written by Guy Voncken. It contains the functions for *
* accessing EWF images created by Guymager and others. *
* *
-* xmount is a small tool to "fuse mount" various harddisk image formats as dd, *
-* vdi, vhd or vmdk files and enable virtual write access to them. *
-* *
* This program is free software: you can redistribute it and/or modify it *
* under the terms of the GNU General Public License as published by the Free *
* Software Foundation, either version 3 of the License, or (at your option) *
* any later version. *
* *
* This program is distributed in the hope that it will be useful, but WITHOUT *
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or *
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for *
* more details. *
* *
* You should have received a copy of the GNU General Public License along with *
* this program. If not, see <http://www.gnu.org/licenses/>. *
*******************************************************************************/
// Aewf has been written in order to reduce xmount's memory footprint when
// operating on large EWF images. Before Aewf, xmount exclusively relied on
// libewf for accessing EWF images, resulting in enormous memory consumption.
//
// Aewf uses 2 main structures for handling image access: pAewf->pSegmentArr
// contains everything about the image files (segments) and pAewf->pTableArr
// handles the EWF chunk offset tables.
//
// At the same time, those structures serve as caches for the two most vital
// ressouces, namely the number of segment files opened in parallel and the
// memory consumed by the chunk offset tables.
//
// The max. values for both are configurable, see pAewf->MaxOpenSegments and
// pAewf->MaxTableCache.
// Please don't touch source code formatting!
#ifdef LINTING
// #define _LARGEFILE_SOURCE
// #define _FILE_OFFSET_BITS 64
#define AEWF_STANDALONE
#endif
#include <string.h>
#include <stdio.h>
#include <stdlib.h>
#include <locale.h>
#include <limits.h>
#include <time.h> //lint !e537 !e451 Include file messages
#include <zlib.h>
#include <unistd.h> //lint !e537
#include <wchar.h> //lint !e537 !e451
#include <stdarg.h> //lint !e537 !e451
#include <limits.h> //lint !e537 !e451
#include <errno.h>
#include "../libxmount_input.h"
#include "libxmount_input_aewf.h"
#ifdef AEWF_STANDALONE
#define CREATE_REVERSE_FILE
// #define REVERSE_FILE_USES_SEPARATE_HANDLE
#define LOG_STDOUT TRUE
#endif
//#ifdef AEWF_STANDALONE
// #define _GNU_SOURCE
//#endif
#define AEWF_OPTION_TABLECACHE "aewfmaxmem"
#define AEWF_OPTION_MAXOPENSEGMENTS "aewfmaxfiles"
#define AEWF_OPTION_STATS "aewfstats"
#define AEWF_OPTION_STATSREFRESH "aewfrefresh"
#define AEWF_OPTION_LOG "aewflog"
static int AewfClose (void *pHandle);
static const char* AewfGetErrorMessage (int ErrNum);
const uint64_t AEWF_DEFAULT_TABLECACHE = 10; // MiB
const uint64_t AEWF_DEFAULT_MAXOPENSEGMENTS = 10;
const uint64_t AEWF_DEFAULT_STATSREFRESH = 10;
// ----------------------------
// Logging and error handling
// ----------------------------
#define LOG_HEADER_LEN 80
int LogvEntry (const char *pLogFileName, uint8_t LogStdout, const char *pFileName, const char *pFunctionName, int LineNr, const char *pFormat, va_list pArguments)
{
time_t NowT;
struct tm *pNowTM;
FILE *pFile;
int wr;
char *pFullLogFileName = NULL;
const char *pBase;
char LogLineHeader[1024];
pid_t OwnPID;
if (!LogStdout && (pLogFileName==NULL))
return AEWF_OK;
time (&NowT);
pNowTM = localtime (&NowT);
OwnPID = getpid(); // pthread_self()
wr = (int) strftime (&LogLineHeader[0] , sizeof(LogLineHeader) , "%a %d.%b.%Y %H:%M:%S ", pNowTM); //lint !e713
wr += snprintf (&LogLineHeader[wr], sizeof(LogLineHeader)-wr, "%5d ", OwnPID); //lint !e737
if (pFileName && pFunctionName)
{
pBase = strrchr(pFileName, '/');
if (pBase)
pFileName = pBase+1;
wr += snprintf (&LogLineHeader[wr], sizeof(LogLineHeader)-wr, "%s %s %d ", pFileName, pFunctionName, LineNr); //lint !e737
}
// while (wr < LOG_HEADER_LEN)
// LogLineHeader[wr++] = ' ';
if (pLogFileName)
{
wr = asprintf (&pFullLogFileName, "%s_%d", pLogFileName, OwnPID);
if ((wr <= 0) || (pFullLogFileName == NULL))
{
if (LogStdout)
printf ("\nLog file error: Can't build filename");
return AEWF_MEMALLOC_FAILED;
}
else
{
pFile = fopen64 (pFullLogFileName, "a");
if (pFile == NULL)
{
if (LogStdout)
printf ("\nLog file error: Can't be opened");
return AEWF_CANNOT_OPEN_LOGFILE;
}
else
{
fprintf (pFile, "%-*s", LOG_HEADER_LEN, &LogLineHeader[0]);
vfprintf (pFile, pFormat, pArguments);
fprintf (pFile, "\n");
fclose (pFile);
}
free (pFullLogFileName);
}
}
if (LogStdout)
{
printf ("%s", &LogLineHeader[0]);
vprintf (pFormat, pArguments);
printf ("\n");
}
return AEWF_OK;
}
int LogEntry (const char *pLogFileName, uint8_t LogStdout, const char *pFileName, const char *pFunctionName, int LineNr, const char *pFormat, ...)
{
va_list VaList;
int rc;
if (!LogStdout && (pLogFileName==NULL))
return AEWF_OK;
va_start (VaList, pFormat); //lint !e530 Symbol 'VaList' not initialized
rc = LogvEntry (pLogFileName, LogStdout, pFileName, pFunctionName, LineNr, pFormat, VaList);
va_end(VaList);
return rc;
}
// CHK requires existance of pAewf handle
#ifdef AEWF_STANDALONE
#define LOG_ERRORS_ON_STDOUT TRUE
#else
#define LOG_ERRORS_ON_STDOUT pAewf->LogStdout
#endif
#define CHK(ChkVal) \
{ \
int ChkValRc; \
if ((ChkValRc=(ChkVal)) != AEWF_OK) \
{ \
const char *pErr = AewfGetErrorMessage (ChkValRc); \
LogEntry (pAewf->pLogFilename, LOG_ERRORS_ON_STDOUT, __FILE__, __FUNCTION__, __LINE__, "Error %d (%s) occured", ChkValRc, pErr); \
return ChkValRc; \
} \
}
#define LOG(...) \
LogEntry (pAewf->pLogFilename, pAewf->LogStdout, __FILE__, __FUNCTION__, __LINE__, __VA_ARGS__);
// AewfCheckError is called before exiting AewfRead. It should not
// be called elsewehere or else the statistics would become wrong.
static void AewfCheckError (t_pAewf pAewf, int Ret, int *pErrno)
{
*pErrno = 0;
if (Ret != AEWF_OK)
{
pAewf->Errors++;
pAewf->LastError = Ret;
if ((Ret >= AEWF_ERROR_ENOMEM_START) && (Ret <= AEWF_ERROR_ENOMEM_END)) *pErrno = ENOMEM;
else if ((Ret >= AEWF_ERROR_EINVAL_START) && (Ret <= AEWF_ERROR_EINVAL_END)) *pErrno = EINVAL;
else *pErrno = EIO; // all other errors
}
}
// ------------------------------------
// Internal functions
// ------------------------------------
static int OpenFile (FILE **ppFile, const char *pFilename)
{
*ppFile = fopen (pFilename, "r");
if (*ppFile == NULL)
return AEWF_FILE_OPEN_FAILED;
return AEWF_OK;
}
static int CloseFile (FILE **ppFile)
{
if (fclose (*ppFile))
return AEWF_FILE_CLOSE_FAILED;
*ppFile = NULL;
return AEWF_OK;
}
#define NO_SEEK ULLONG_MAX
static int ReadFilePos (t_pAewf pAewf, FILE *pFile, void *pMem, unsigned int Size, uint64_t Pos)
{
if (Size == 0)
return AEWF_OK;
if (Pos != NO_SEEK)
{
if (fseeko64 (pFile, Pos, SEEK_SET))
return AEWF_FILE_SEEK_FAILED;
}
if (fread (pMem, Size, 1UL, pFile) != 1)
return AEWF_FILE_READ_FAILED;
return AEWF_OK;
}
static int ReadFileAllocPos (t_pAewf pAewf, FILE *pFile, void **ppMem, unsigned int Size, uint64_t Pos)
{
*ppMem = (void*) malloc (Size);
if (*ppMem == NULL)
return AEWF_MEMALLOC_FAILED;
CHK (ReadFilePos (pAewf, pFile, *ppMem, Size, Pos))
return AEWF_OK;
}
static int ReadFileAlloc (t_pAewf pAewf, FILE *pFile, void **ppMem, unsigned int Size)
{
CHK (ReadFileAllocPos (pAewf, pFile, ppMem, Size, NO_SEEK))
return AEWF_OK;
}
static int QsortCompareSegments (const void *pA, const void *pB)
{
const t_pSegment pSegmentA = ((const t_pSegment)pA); //lint !e1773 Attempt to cast way const
const t_pSegment pSegmentB = ((const t_pSegment)pB); //lint !e1773 Attempt to cast way const
return (int)pSegmentA->Number - (int)pSegmentB->Number;
}
static int CreateInfoData (t_pAewf pAewf, t_pAewfSectionVolume pVolume, char *pHeader , unsigned HeaderLen,
char *pHeader2, unsigned Header2Len)
{
char *pInfo1 = NULL;
char *pInfo2 = NULL;
char *pInfo3 = NULL;
char *pInfo4 = NULL;
char *pInfo5 = NULL;
char *pHdr = NULL;
unsigned HdrLen= 0;
char *pText = NULL;
char *pCurrent;
char *pDesc = NULL;
char *pData = NULL;
char *pEnd;
uLongf DstLen0;
int zrc;
const int MaxTextSize = 65536;
unsigned UncompressedLen;
int rc = AEWF_OK;
#define RET_ERR(ErrCode) \
{ \
rc = ErrCode; \
goto CleanUp; \
}
#define ASPRINTF(...) \
{ \
if (asprintf(__VA_ARGS__) < 0) \
RET_ERR (AEWF_ASPRINTF_FAILED) \
}
ASPRINTF(&pInfo1, "Image size %" PRIu64 " (%0.2f GiB)\n"
"Bytes per sector %u\n"
"Sector count %" PRIu64 "\n"
"Sectors per chunk %u\n"
"Chunk count %u\n"
"Error block size %u\n"
"Compression level %u\n"
"Media type %02X\n"
"Cylinders/Heads/Sectors %u/%u/%u\n"
"Media flags %02X\n"
"Palm volume start sector %u\n"
"Smart logs start sector %u\n",
pAewf->ImageSize, pAewf->ImageSize / (1024.0 * 1024.0* 1024.0),
pVolume->BytesPerSector,
pVolume->SectorCount,
pVolume->SectorsPerChunk,
pVolume->ChunkCount,
pVolume->ErrorBlockSize,
pVolume->CompressionLevel,
pVolume->MediaType,
pVolume->CHS_Cylinders, pVolume->CHS_Heads, pVolume->CHS_Sectors,
pVolume->MediaFlags,
pVolume->PalmVolumeStartSector,
pVolume->SmartLogsStartSector);
ASPRINTF (&pInfo2, "AcquirySystemGUID %02X %02X %02X %02X %02X %02X %02X %02X %02X %02X %02X %02X %02X %02X %02X %02X\n",
pVolume->AcquirySystemGUID[ 0], pVolume->AcquirySystemGUID[ 1], pVolume->AcquirySystemGUID[ 2], pVolume->AcquirySystemGUID[ 3],
pVolume->AcquirySystemGUID[ 4], pVolume->AcquirySystemGUID[ 4], pVolume->AcquirySystemGUID[ 6], pVolume->AcquirySystemGUID[ 7],
pVolume->AcquirySystemGUID[ 8], pVolume->AcquirySystemGUID[ 9], pVolume->AcquirySystemGUID[10], pVolume->AcquirySystemGUID[11],
pVolume->AcquirySystemGUID[12], pVolume->AcquirySystemGUID[13], pVolume->AcquirySystemGUID[14], pVolume->AcquirySystemGUID[15]);
if (pHeader2) { pHdr = pHeader2; HdrLen = Header2Len; }
else if (pHeader ) { pHdr = pHeader; HdrLen = HeaderLen; }
if (pHdr)
{
pText = (char *) malloc (MaxTextSize);
if (pText == NULL)
RET_ERR (AEWF_MEMALLOC_FAILED)
DstLen0 = MaxTextSize;
zrc = uncompress ((unsigned char *)pText, &DstLen0, (const Bytef*)pHdr, HdrLen);
UncompressedLen = DstLen0;
if (zrc != Z_OK)
RET_ERR (AEWF_UNCOMPRESS_HEADER_FAILED)
if (pHeader2) // We must convert from silly Windows 2 byte wchar_t to
{ // correct Unix 4 byte wchar_t, before we can convert to UTF8
wchar_t *pTemp = (wchar_t*) malloc ((UncompressedLen/2)*sizeof(wchar_t));
if (pTemp == NULL)
RET_ERR (AEWF_MEMALLOC_FAILED)
for (unsigned i=0; i<(UncompressedLen/2); i++)
pTemp[i] = (wchar_t) (((unsigned char*)pText)[2*i ]) |
(((wchar_t) (((unsigned char*)pText)[2*i+1])) << 8);
(void) wcstombs(pText, pTemp, UncompressedLen/2);
free (pTemp);
}
// Extract descriptor and data lines
// ---------------------------------
pCurrent = pText; // pText may start with BOM (Header2), but that's no problem as
while (pCurrent) // first line anyway never is the "main" line.
{
if (strcasestr(pCurrent, "main") == pCurrent) // The header line is the one that
break; // follows the line beginning with "main"
pCurrent = strstr (pCurrent, "\n");
if (pCurrent)
pCurrent++;
}
if (pCurrent)
{
pDesc = strstr (pCurrent, "\n");
if (pDesc)
{
*pDesc++ = '\0';
pData = strstr (pDesc, "\n");
if (pData)
{
*pData++ = '\0';
pEnd = strstr (pData, "\n");
if (pEnd)
*pEnd = '\0';
}
}
}
// Scan descriptor and data lines
// ------------------------------
char *pCurDesc = pDesc;
char *pCurData = pData;
const char *pField;
char *pTabDesc;
char *pTabData;
char *pValue;
int wr = 0;
time_t Time;
struct tm *pTM;
char TimeBuff[64];
if (pCurDesc && pCurData)
{
pInfo3 = (char *) malloc (strlen (pCurData) + 4096);
if (pInfo3 == NULL)
RET_ERR (AEWF_MEMALLOC_FAILED)
while (*pCurDesc && *pCurData)
{
pTabDesc = strstr (pCurDesc, "\t");
pTabData = strstr (pCurData, "\t");
if (pTabDesc) *pTabDesc = '\0';
if (pTabData) *pTabData = '\0';
if (strcasecmp(pCurDesc, "a" ) == 0) pField = "Description";
else if (strcasecmp(pCurDesc, "c" ) == 0) pField = "Case";
else if (strcasecmp(pCurDesc, "n" ) == 0) pField = "Evidence";
else if (strcasecmp(pCurDesc, "e" ) == 0) pField = "Examiner";
else if (strcasecmp(pCurDesc, "t" ) == 0) pField = "Notes";
else if (strcasecmp(pCurDesc, "md") == 0) pField = "Model";
else if (strcasecmp(pCurDesc, "sn") == 0) pField = "Serial number";
else if (strcasecmp(pCurDesc, "av") == 0) pField = "Imager version";
else if (strcasecmp(pCurDesc, "ov") == 0) pField = "OS version";
else if (strcasecmp(pCurDesc, "m" ) == 0) pField = "Acquired time";
else if (strcasecmp(pCurDesc, "u" ) == 0) pField = "System time";
else if (strcasecmp(pCurDesc, "p" ) == 0) pField = NULL;
else if (strcasecmp(pCurDesc, "dc") == 0) pField = NULL;
else pField = "--";
if (pField)
{
pValue = pCurData;
if (strstr (pField, "time"))
{
size_t w;
Time = atoll (pCurData);
pTM = localtime (&Time);
pValue = &TimeBuff[0];
w = strftime (pValue, sizeof(TimeBuff), "%Y-%m-%d %H:%M:%S (%z)", pTM);
sprintf (&pValue[w], " (epoch %s)", pCurData);
}
wr += sprintf (&pInfo3[wr], "%-17s %s\n", pField, pValue);
}
if (!pTabDesc || !pTabData)
break;
pCurDesc = pTabDesc+1;
pCurData = pTabData+1;
}
}
}
if (pAewf->Segments == 1)
ASPRINTF (&pInfo4, "%"PRIu64" segment file: %s\n",
pAewf->Segments,
pAewf->pSegmentArr[0].pName)
else ASPRINTF (&pInfo4, "%"PRIu64" segment files\n First: %s\n Last: %s\n",
pAewf->Segments,
pAewf->pSegmentArr[0 ].pName,
pAewf->pSegmentArr[pAewf->Segments-1].pName);
ASPRINTF (&pInfo5, "%"PRIu64" tables\n", pAewf->Tables);
if (pInfo3)
ASPRINTF (&pAewf->pInfo, "%s%s\n%s\n%s%s", pInfo1, pInfo2, pInfo3, pInfo4, pInfo5)
else ASPRINTF (&pAewf->pInfo, "%s%s%s%s" , pInfo1, pInfo2, pInfo4, pInfo5)
#undef RET_ERR
#undef ASPRINTF
CleanUp:
if (pText ) free (pText );
if (pInfo1) free (pInfo1);
if (pInfo2) free (pInfo2);
if (pInfo3) free (pInfo3);
if (pInfo4) free (pInfo4);
if (pInfo5) free (pInfo5);
return rc;
}
static int AewfOpenSegment (t_pAewf pAewf, t_pTable pTable)
{
t_pSegment pOldestSegment;
if (pTable->pSegment->pFile != NULL) // is already opened ?
{
pAewf->SegmentCacheHits++;
return AEWF_OK;
}
pAewf->SegmentCacheMisses++;
// Check if another segment file must be closed first
// --------------------------------------------------
while (pAewf->OpenSegments >= pAewf->MaxOpenSegments)
{
pOldestSegment = NULL;
for (unsigned i=0; i<pAewf->Segments; i++)
{
if (pAewf->pSegmentArr[i].pFile == NULL)
continue;
if (pOldestSegment == NULL)
{
pOldestSegment = &pAewf->pSegmentArr[i];
}
else
{
if (pAewf->pSegmentArr[i].LastUsed < pOldestSegment->LastUsed)
pOldestSegment = &pAewf->pSegmentArr[i];
}
}
if (pOldestSegment == NULL)
break;
- LOG ("Closing %s\n", pOldestSegment->pName);
+ LOG ("Closing %s", pOldestSegment->pName);
CHK (CloseFile (&pOldestSegment->pFile))
pAewf->OpenSegments--;
}
// Read the desired table into RAM
// -------------------------------
- LOG ("Opening %s\n", pTable->pSegment->pName);
+ LOG ("Opening %s", pTable->pSegment->pName);
CHK (OpenFile(&pTable->pSegment->pFile, pTable->pSegment->pName))
pAewf->OpenSegments++;
return AEWF_OK;
}
static int AewfLoadEwfTable (t_pAewf pAewf, t_pTable pTable)
{
t_pTable pOldestTable = NULL;
if (pTable->pEwfTable != NULL) // is already loaded?
{
pAewf->TableCacheHits++;
return AEWF_OK;
}
pAewf->TableCacheMisses++;
// Check if another pEwfTable must be given up first
// -------------------------------------------------
while ((pAewf->TableCache + pTable->Size) > pAewf->MaxTableCache)
{
pOldestTable = NULL;
for (unsigned i=0; i<pAewf->Tables; i++)
{
if (pAewf->pTableArr[i].pEwfTable == NULL)
continue;
if (pOldestTable == NULL)
{
pOldestTable = &pAewf->pTableArr[i];
}
else
{
if (pAewf->pTableArr[i].LastUsed < pOldestTable->LastUsed)
pOldestTable = &pAewf->pTableArr[i];
}
}
if (pOldestTable == NULL)
break;
pAewf->TableCache -= pOldestTable->Size;
free (pOldestTable->pEwfTable);
pOldestTable->pEwfTable = NULL;
- LOG ("Releasing table %" PRIu64 " (%lu bytes)\n", pOldestTable->Nr, pOldestTable->Size);
+ LOG ("Releasing table %" PRIu64 " (%lu bytes)", pOldestTable->Nr, pOldestTable->Size);
}
// Read the desired table into RAM
// -------------------------------
LOG ("Loading table %" PRIu64 " (%lu bytes)", pTable->Nr, pTable->Size);
CHK (AewfOpenSegment (pAewf, pTable));
CHK (ReadFileAllocPos (pAewf, pTable->pSegment->pFile, (void**) &pTable->pEwfTable, pTable->Size, pTable->Offset))
pAewf->TableCache += pTable->Size;
pAewf->TablesReadFromImage = pTable->Size;
return AEWF_OK;
}
// AewfReadChunk0 reads exactly one chunk. It expects the EWF table be present
// in memory and the required segment be opened.
static int AewfReadChunk0 (t_pAewf pAewf, t_pTable pTable, uint64_t AbsoluteChunk, unsigned TableChunk)
{
int Compressed;
uint64_t SeekPos;
t_pAewfSectionTable pEwfTable;
unsigned int Offset;
unsigned int ReadLen;
uLongf DstLen0;
int zrc;
uint CalcCRC;
uint *pStoredCRC;
uint64_t ChunkSize;
int Ret = AEWF_OK;
pEwfTable = pTable->pEwfTable;
if (pEwfTable == NULL)
return AEWF_ERROR_EWF_TABLE_NOT_READY;
if (pTable->pSegment->pFile == NULL)
return AEWF_ERROR_EWF_SEGMENT_NOT_READY;
Compressed = pEwfTable->OffsetArray[TableChunk] & AEWF_COMPRESSED;
Offset = pEwfTable->OffsetArray[TableChunk] & ~AEWF_COMPRESSED;
SeekPos = pEwfTable->TableBaseOffset + Offset;
if (TableChunk < (pEwfTable->ChunkCount-1))
ReadLen = (pEwfTable->OffsetArray[TableChunk+1] & ~AEWF_COMPRESSED) - Offset;
else ReadLen = (pTable->SectionSectorsSize - sizeof(t_AewfSection)) - (Offset - (pEwfTable->OffsetArray[0] & ~AEWF_COMPRESSED));
// else ReadLen = pAewf->ChunkBuffSize; // This also works! It looks as if uncompress is able to find out by itself the real size of the input data.
if (ReadLen > pAewf->ChunkBuffSize)
{
LOG ("Chunk too big %u / %u", ReadLen, pAewf->ChunkBuffSize);
return AEWF_CHUNK_TOO_BIG;
}
ChunkSize = pAewf->ChunkSize;
if (AbsoluteChunk == (pAewf->Chunks-1)) // The very last chunk of the image may be smaller than the default
{ // chunk size if the image isn't a multiple of the chunk size.
ChunkSize = pAewf->ImageSize % pAewf->ChunkSize;
if (ChunkSize == 0)
ChunkSize = pAewf->ChunkSize;
}
if (Compressed)
{
CHK (ReadFilePos (pAewf, pTable->pSegment->pFile, pAewf->pChunkBuffCompressed, ReadLen, SeekPos))
DstLen0 = pAewf->ChunkBuffSize;
zrc = uncompress ((unsigned char*)pAewf->pChunkBuffUncompressed, &DstLen0, (const Bytef*)pAewf->pChunkBuffCompressed, ReadLen);
if (zrc != Z_OK)
Ret = AEWF_UNCOMPRESS_FAILED;
if (DstLen0 != ChunkSize)
Ret = AEWF_BAD_UNCOMPRESSED_LENGTH;
}
else
{
CHK (ReadFilePos (pAewf, pTable->pSegment->pFile, pAewf->pChunkBuffUncompressed, ReadLen, SeekPos))
CalcCRC = adler32 (1, (const Bytef *) pAewf->pChunkBuffUncompressed, ChunkSize);
pStoredCRC = (uint *) (pAewf->pChunkBuffUncompressed + ChunkSize); //lint !e826 Suspicious pointer-to-pointer conversion (area too small)
if (CalcCRC != *pStoredCRC)
Ret = AEWF_CHUNK_CRC_ERROR;
}
pAewf->DataReadFromImage += ReadLen;
pAewf->DataReadFromImageRaw += ChunkSize;
if (Ret == AEWF_OK)
{
pAewf->ChunkInBuff = AbsoluteChunk;
pAewf->ChunkBuffUncompressedDataLen = ChunkSize;
}
else
{
pAewf->ChunkInBuff = AEWF_NONE;
pAewf->ChunkBuffUncompressedDataLen = 0;
}
return Ret;
}
static int AewfReadChunk (t_pAewf pAewf, uint64_t AbsoluteChunk, char **ppBuffer, unsigned int *pLen)
{
t_pTable pTable;
int Found=FALSE;
unsigned TableChunk;
unsigned TableNr;
*ppBuffer = pAewf->pChunkBuffUncompressed;
*pLen = 0;
if (pAewf->ChunkInBuff == AbsoluteChunk)
{
*pLen = pAewf->ChunkBuffUncompressedDataLen;
pAewf->ChunkCacheHits++;
return AEWF_OK;
}
pAewf->ChunkCacheMisses++;
// Find table containing desired chunk
// -----------------------------------
for (TableNr=0; TableNr<pAewf->Tables; TableNr++)
{
pTable = &pAewf->pTableArr[TableNr];
Found = (AbsoluteChunk >= pTable->ChunkFrom) &&
(AbsoluteChunk <= pTable->ChunkTo);
if (Found)
break;
}
if (!Found)
CHK (AEWF_CHUNK_NOT_FOUND)
// Load corresponding table and get chunk
// --------------------------------------
pTable->LastUsed = time(NULL); //lint !e771 pTable' (line 640) conceivably not initialized
pTable->pSegment->LastUsed = pTable->LastUsed; // Update LastUsed here, in order not to remove the required data from cache
CHK (AewfLoadEwfTable (pAewf, pTable))
CHK (AewfOpenSegment (pAewf, pTable));
if ((AbsoluteChunk - pTable->ChunkFrom) > UINT_MAX)
CHK (AEWF_ERROR_IN_CHUNK_NUMBER)
TableChunk = AbsoluteChunk - pTable->ChunkFrom;
-// LOG ("table %d / entry %" PRIu64 " (%s)\n", TableNr, TableChunk, pTable->pSegment->pName)
+// LOG ("table %d / entry %" PRIu64 " (%s)", TableNr, TableChunk, pTable->pSegment->pName)
CHK (AewfReadChunk0 (pAewf, pTable, AbsoluteChunk, TableChunk))
*pLen = pAewf->ChunkBuffUncompressedDataLen;
return AEWF_OK;
}
static int UpdateStats (t_pAewf pAewf, int Force)
{
time_t NowT;
pid_t pid;
FILE *pFile;
char *pFilename = NULL;
char *pCurrentWorkDir = NULL;
if (pAewf->pStatsFilename)
{
time (&NowT);
if (((NowT - pAewf->LastStatsUpdate) >= (int)pAewf->StatsRefresh) || Force)
{
pAewf->LastStatsUpdate = NowT;
pid = getpid ();
if (asprintf (&pFilename, "%s_%d", pAewf->pStatsFilename, pid) < 0)
return AEWF_MEMALLOC_FAILED;
pFile = fopen (pFilename, "w");
if (pFile == NULL) // May be the file is locked by someone else, let's retry in 1 second
{
pAewf->LastStatsUpdate = NowT - pAewf->StatsRefresh + 1;
return AEWF_OK;
}
fprintf (pFile, "Image segment files %6"PRIu64"\n" , pAewf->Segments);
fprintf (pFile, "Image tables %6"PRIu64"\n" , pAewf->Tables);
fprintf (pFile, "\n");
fprintf (pFile, "Cache hits misses ratio\n");
fprintf (pFile, "--------------------------------------\n");
fprintf (pFile, "Segment %10" PRIu64 " %10" PRIu64 " %5.1f%%\n", pAewf->SegmentCacheHits, pAewf->SegmentCacheMisses, (100.0*pAewf->SegmentCacheHits)/(pAewf->SegmentCacheHits+pAewf->SegmentCacheMisses));
fprintf (pFile, "Table %10" PRIu64 " %10" PRIu64 " %5.1f%%\n", pAewf->TableCacheHits , pAewf->TableCacheMisses , (100.0*pAewf->TableCacheHits) /(pAewf->TableCacheHits +pAewf->TableCacheMisses ));
fprintf (pFile, "Chunk %10" PRIu64 " %10" PRIu64 " %5.1f%%\n", pAewf->ChunkCacheHits , pAewf->ChunkCacheMisses , (100.0*pAewf->ChunkCacheHits) /(pAewf->ChunkCacheHits +pAewf->ChunkCacheMisses ));
fprintf (pFile, "\n");
fprintf (pFile, "Read operations %10" PRIu64 "\n", pAewf->ReadOperations);
fprintf (pFile, "Errors %10" PRIu64 "\n", pAewf->Errors);
fprintf (pFile, "Open segment files %10" PRIu64"\n" , pAewf->OpenSegments);
fprintf (pFile, "Last error %10d (%s)\n" , pAewf->LastError, AewfGetErrorMessage (pAewf->LastError));
fprintf (pFile, "Data read from image %10.1f MiB (compressed)\n", pAewf->DataReadFromImage / (1024.0*1024.0));
fprintf (pFile, "Data read from image %10.1f MiB (raw)\n" , pAewf->DataReadFromImageRaw / (1024.0*1024.0));
fprintf (pFile, "Data requested by caller %10.1f MiB\n" , pAewf->DataRequestedByCaller/ (1024.0*1024.0));
fprintf (pFile, "Tables read from image %10.1f MiB\n" , pAewf->TablesReadFromImage / (1024.0*1024.0));
- fprintf (pFile, "RAM used as table cache %10.1f MiB\n", pAewf->TableCache/ (1024.0*1024.0));
+ fprintf (pFile, "RAM used as table cache %10.1f MiB\n" , pAewf->TableCache / (1024.0*1024.0));
+ fprintf (pFile, "Size of all image tables %10.1f MiB\n" , pAewf->TotalTableSize / (1024.0*1024.0));
pCurrentWorkDir = getcwd (NULL, 0);
if (pCurrentWorkDir == NULL)
return AEWF_MEMALLOC_FAILED;
fprintf (pFile, "\nCurrent working directory: %s\n", pCurrentWorkDir);
free (pCurrentWorkDir);
(void) fclose (pFile);
free (pFilename);
return AEWF_OK;
}
}
return AEWF_OK;
}
// ---------------
// API functions
// ---------------
static int AewfCreateHandle (void **ppHandle, const char *pFormat, uint8_t Debug)
{
t_pAewf pAewf;
*ppHandle = NULL;
// Create handle and clear it
// --------------------------
pAewf = (t_pAewf) malloc (sizeof(t_Aewf));
if (pAewf == NULL)
return AEWF_MEMALLOC_FAILED;
memset(pAewf,0,sizeof(t_Aewf));
pAewf->ChunkInBuff = AEWF_NONE;
pAewf->pErrorText = NULL;
pAewf->StatsRefresh = 10;
pAewf->SegmentCacheHits = 0;
pAewf->SegmentCacheMisses = 0;
pAewf->TableCacheHits = 0;
pAewf->TableCacheMisses = 0;
pAewf->ChunkCacheHits = 0;
pAewf->ChunkCacheMisses = 0;
pAewf->ReadOperations = 0;
pAewf->DataReadFromImage = 0;
pAewf->DataReadFromImageRaw = 0;
pAewf->DataRequestedByCaller = 0;
pAewf->TablesReadFromImage = 0;
pAewf->ChunksRead = 0;
pAewf->BytesRead = 0;
pAewf->Errors = 0;
pAewf->LastError = AEWF_OK;
pAewf->MaxTableCache = 0;
pAewf->MaxOpenSegments = 0;
pAewf->pStatsFilename = NULL;
pAewf->StatsRefresh = 0;
pAewf->pLogFilename = NULL;
pAewf->LogStdout = Debug;
pAewf->MaxTableCache = AEWF_DEFAULT_TABLECACHE * 1024*1024;
pAewf->MaxOpenSegments = AEWF_DEFAULT_MAXOPENSEGMENTS;
pAewf->StatsRefresh = AEWF_DEFAULT_STATSREFRESH;
*ppHandle = (void*) pAewf;
return AEWF_OK;
}
int AewfDestroyHandle(void **ppHandle)
{
t_pAewf pAewf = (t_pAewf) *ppHandle;
LOG ("Called");
LOG ("Remark: 'Ret' won't be logged"); // Handle gets destroyed, 'ret' logging not possible
if (pAewf->pLogFilename) free(pAewf->pLogFilename);
if (pAewf->pStatsFilename) free(pAewf->pStatsFilename);
memset (pAewf, 0, sizeof(t_Aewf));
free (pAewf);
*ppHandle = NULL;
return AEWF_OK;
}
int AewfOpen (void *pHandle, const char **ppFilenameArr, uint64_t FilenameArrLen)
{
t_pAewf pAewf = (t_pAewf) pHandle;
t_AewfFileHeader FileHeader;
t_AewfSection Section;
FILE *pFile;
t_pSegment pSegment;
t_pTable pTable;
uint64_t Pos;
t_pAewfSectionTable pEwfTable = NULL;
t_pAewfSectionVolume pVolume = NULL;
char *pHeader = NULL;
char *pHeader2 = NULL;
int LastSection;
unsigned int SectionSectorsSize;
unsigned HeaderLen = 0;
unsigned Header2Len = 0;
LOG ("Called - Files=%" PRIu64, FilenameArrLen);
// Create pSegmentArr and put the segment files in it
// --------------------------------------------------
int SegmentArrLen = FilenameArrLen * sizeof(t_Segment);
pAewf->pSegmentArr = (t_pSegment) malloc (SegmentArrLen);
pAewf->Segments = FilenameArrLen;
if (pAewf->pSegmentArr == NULL)
return AEWF_MEMALLOC_FAILED;
memset (pAewf->pSegmentArr, 0, SegmentArrLen);
for (unsigned i=0; i<FilenameArrLen; i++)
{
pSegment = &pAewf->pSegmentArr[i];
pSegment->pName = canonicalize_file_name (ppFilenameArr[i]); // canonicalize_file_name allocates a buffer
+ LOG ("Opening segment %s", ppFilenameArr[i]);
CHK (OpenFile (&pFile, pSegment->pName))
CHK (ReadFilePos (pAewf, pFile, (void*)&FileHeader, sizeof(FileHeader), 0))
-// LOG ("Segment %s - %d \n", ppFilenameArr[i], FileHeader.SegmentNumber);
pSegment->Number = FileHeader.SegmentNumber;
pSegment->LastUsed = 0;
pSegment->pFile = NULL;
CHK (CloseFile (&pFile))
}
// Put segment array into correct sequence and check if segment number are correct
// -------------------------------------------------------------------------------
qsort (pAewf->pSegmentArr, pAewf->Segments, sizeof (t_Segment), &QsortCompareSegments);
for (unsigned i=0; i<pAewf->Segments; i++)
{
if ((i+1) != pAewf->pSegmentArr[i].Number)
return AEWF_INVALID_SEGMENT_NUMBER;
}
// Find all tables in the segment files
// ------------------------------------
- pAewf->pTableArr = NULL;
- pAewf->Tables = 0;
- pAewf->Chunks = 0;
- SectionSectorsSize = 0;
+ pAewf->pTableArr = NULL;
+ pAewf->Tables = 0;
+ pAewf->Chunks = 0;
+ pAewf->TotalTableSize = 0;
+ SectionSectorsSize = 0;
- LOG ("Reading tables\n");
+ LOG ("Reading tables");
for (unsigned i=0; i<pAewf->Segments; i++)
{
pSegment = &pAewf->pSegmentArr[i];
CHK (OpenFile (&pFile, pSegment->pName))
CHK (ReadFilePos (pAewf, pFile, &FileHeader, sizeof(FileHeader), 0))
Pos = sizeof (FileHeader);
LOG ("Segment %s ", pSegment->pName);
do
{
CHK (ReadFilePos (pAewf, pFile, &Section, sizeof (t_AewfSection), Pos))
if (strcasecmp ((char *)Section.Type, "sectors") == 0)
{
SectionSectorsSize = Section.Size;
}
else if (strcasecmp ((char *)Section.Type, "table") == 0)
{
if (pVolume == NULL)
return AEWF_VOLUME_MUST_PRECEDE_TABLES;
if (SectionSectorsSize == 0)
return AEWF_SECTORS_MUST_PRECEDE_TABLES;
pAewf->Tables++;
pAewf->pTableArr = (t_pTable) realloc (pAewf->pTableArr, pAewf->Tables * sizeof (t_Table));
CHK (ReadFileAlloc (pAewf, pFile, (void**) &pEwfTable, sizeof(t_AewfSectionTable))) // No need to read the actual offset table
pTable = &pAewf->pTableArr[pAewf->Tables-1];
pTable->Nr = pAewf->Tables-1;
pTable->pSegment = pSegment;
pTable->Offset = Pos + sizeof (t_AewfSection);
pTable->Size = Section.Size;
pTable->ChunkCount = pEwfTable->ChunkCount;
pTable->LastUsed = 0;
pTable->pEwfTable = NULL;
pTable->ChunkFrom = pAewf->Chunks;
pTable->SectionSectorsSize = SectionSectorsSize;
+ pAewf->TotalTableSize += pTable->Size;
pAewf->Chunks += pTable->ChunkCount;
pTable->ChunkTo = pAewf->Chunks-1;
free (pEwfTable);
pEwfTable = NULL;
SectionSectorsSize = 0;
}
else if ((strcasecmp ((char *)Section.Type, "header") == 0) && (pHeader==NULL))
{
HeaderLen = Section.Size - sizeof(t_AewfSection);
CHK (ReadFileAlloc (pAewf, pFile, (void**) &pHeader, HeaderLen))
}
else if ((strcasecmp ((char *)Section.Type, "header2") == 0) && (pHeader2==NULL))
{
Header2Len = Section.Size - sizeof(t_AewfSection);
CHK (ReadFileAlloc (pAewf, pFile, (void**) &pHeader2, Header2Len))
}
else if ((strcasecmp ((char *)Section.Type, "volume") == 0) && (pVolume==NULL))
{
CHK (ReadFileAlloc (pAewf, pFile, (void**) &pVolume, sizeof(t_AewfSectionVolume)))
pAewf->Sectors = pVolume->SectorCount;
pAewf->SectorSize = pVolume->BytesPerSector;
pAewf->ChunkSize = pVolume->SectorsPerChunk * pVolume->BytesPerSector; //lint !e647 Suspicious truncation
pAewf->ImageSize = pAewf->Sectors * pAewf->SectorSize;
}
LastSection = (Pos == Section.OffsetNextSection);
Pos = Section.OffsetNextSection;
} while (!LastSection);
CHK (CloseFile (&pFile))
}
if (pVolume == NULL)
return AEWF_VOLUME_MISSING;
if (pAewf->Chunks != pVolume->ChunkCount)
{
LOG ("Error: Wrong chunk count: %"PRIu64" / %"PRIu64, pAewf->Chunks, pVolume->ChunkCount);
LOG ("Maybe some segment files are missing. Perhaps you specified E01 instead of E?? or the segments continue beyond extension .EZZ.");
return AEWF_WRONG_CHUNK_COUNT;
}
pAewf->ChunkBuffSize = pAewf->ChunkSize + 4096; // reserve some extra space (for CRC and as compressed data might be slightly larger than uncompressed data with some imagers)
pAewf->pChunkBuffCompressed = (char *) malloc (pAewf->ChunkBuffSize);
pAewf->pChunkBuffUncompressed = (char *) malloc (pAewf->ChunkBuffSize);
if ((pAewf->pChunkBuffCompressed == NULL) ||
(pAewf->pChunkBuffUncompressed == NULL))
return AEWF_MEMALLOC_FAILED;
pAewf->TableCache = 0;
pAewf->OpenSegments = 0;
CHK (CreateInfoData (pAewf, pVolume, pHeader, HeaderLen, pHeader2, Header2Len))
free (pVolume);
free (pHeader);
free (pHeader2);
LOG ("Ret");
return AEWF_OK;
}
static int AewfClose (void *pHandle)
{
t_pAewf pAewf = (t_pAewf) pHandle;
t_pTable pTable;
t_pSegment pSegment;
LOG ("Called");
CHK (UpdateStats (pAewf,TRUE))
for (unsigned i=0; i<pAewf->Tables; i++)
{
pTable = &pAewf->pTableArr[i];
if (pTable->pEwfTable)
free (pTable->pEwfTable);
}
for (unsigned i=0;i<pAewf->Segments;i++)
{
pSegment = &pAewf->pSegmentArr[i];
if (pSegment->pFile)
CHK (CloseFile (&pSegment->pFile));
free (pSegment->pName);
}
free (pAewf->pTableArr);
free (pAewf->pSegmentArr);
free (pAewf->pChunkBuffCompressed);
free (pAewf->pChunkBuffUncompressed);
LOG ("Ret");
return AEWF_OK;
}
static int AewfSize (void *pHandle, uint64_t *pSize)
{
t_pAewf pAewf = (t_pAewf) pHandle;
LOG ("Called");
*pSize = pAewf->ImageSize;
LOG ("Ret - Size=%" PRIu64, *pSize);
return AEWF_OK;
}
static int AewfRead (void *pHandle, char *pBuf, off_t Seek, size_t Count, size_t *pRead, int *pErrno)
{
t_pAewf pAewf = (t_pAewf) pHandle;
char *pChunkBuffer;
uint64_t Seek64;
uint64_t Chunk;
uint64_t Remaining;
unsigned int ChunkLen, Ofs, ToCopy;
int Ret = AEWF_OK;
LOG ("Called - Seek=%'" PRIu64 ",Count=%'" PRIu64, Seek, Count);
*pRead = 0;
*pErrno = 0;
if (Seek < 0)
{
Ret = AEWF_NEGATIVE_SEEK;
goto Leave;
}
Seek64 = Seek;
pAewf->ReadOperations++;
pAewf->DataRequestedByCaller+=Count;
if (Seek64 >= pAewf->ImageSize) // If calling function asks
goto Leave; // for data beyond end of
if ((Seek64+Count) > pAewf->ImageSize) // image simply return what
Count = pAewf->ImageSize - Seek64; // is possible.
Ofs = Seek64 % pAewf->ChunkSize;
Chunk = Seek64 / pAewf->ChunkSize;
Remaining = Count;
while (Remaining)
{
Ret = AewfReadChunk (pAewf, Chunk, &pChunkBuffer, &ChunkLen);
if (Ret)
goto Leave;
if (ChunkLen == 0)
{
Ret = AEWF_CHUNK_LENGTH_ZERO;
goto Leave;
}
ToCopy = GETMIN (ChunkLen-Ofs, Remaining);
memcpy (pBuf, pChunkBuffer+Ofs, ToCopy);
Remaining -= ToCopy;
pBuf += ToCopy;
*pRead += ToCopy;
Ofs = 0;
Chunk++;
}
Leave:
AewfCheckError (pAewf, Ret, pErrno);
CHK (UpdateStats (pAewf, (Ret != AEWF_OK)))
LOG ("Ret %d - Read=%" PRIu32, Ret, *pRead);
return Ret;
}
static int AewfOptionsHelp (const char **ppHelp)
{
char *pHelp=NULL;
int wr;
wr = asprintf (&pHelp, " %-12s : Maximum amount of RAM cache, in MiB, for image offset tables. Default: %"PRIu64" MiB\n"
" %-12s : Maximum number of concurrently opened image segment files. Default: %"PRIu64"\n"
" %-12s : Output statistics at regular intervals to this file.\n"
" %-12s : The update interval, in seconds, for the statistics. Ignored if %s is not set. Default: %"PRIu64"s.\n"
" %-12s : Log file name.\n"
" Specify full paths for %s and %s options. The given file names are extended by _<pid>.\n",
AEWF_OPTION_TABLECACHE, AEWF_DEFAULT_TABLECACHE,
AEWF_OPTION_MAXOPENSEGMENTS, AEWF_DEFAULT_MAXOPENSEGMENTS,
AEWF_OPTION_STATS,
AEWF_OPTION_STATSREFRESH, AEWF_OPTION_STATS, AEWF_DEFAULT_STATSREFRESH,
AEWF_OPTION_LOG,
AEWF_OPTION_STATS, AEWF_OPTION_LOG);
if ((pHelp == NULL) || (wr<=0))
return AEWF_MEMALLOC_FAILED;
*ppHelp = pHelp;
return AEWF_OK;
}
static int AewfOptionsParse (void *pHandle, uint32_t OptionCount, const pts_LibXmountOptions *ppOptions, const char **ppError)
{
pts_LibXmountOptions pOption;
t_pAewf pAewf = (t_pAewf) pHandle;
const char *pError = NULL;
int rc = AEWF_OK;
int Ok;
LOG ("Called - OptionCount=%" PRIu32, OptionCount);
*ppError = NULL;
#define TEST_OPTION_UINT64(Opt,DestField) \
if (strcmp (pOption->p_key, Opt) == 0) \
{ \
pAewf->DestField = StrToUint64 (pOption->p_value, &Ok); \
if (!Ok) \
{ \
pError = "Error in option %s: Invalid value"; \
break; \
} \
LOG ("Option %s set to %" PRIu64, Opt, pAewf->DestField) \
}
for (uint32_t i=0; i<OptionCount; i++)
{
pOption = ppOptions[i];
if (strcmp (pOption->p_key, AEWF_OPTION_LOG) == 0)
{
pAewf->pLogFilename = strdup (pOption->p_value);
rc = LOG ("Logging for libxmount_input_aewf started")
if (rc != AEWF_OK)
{
pError = "Write test to log file failed";
break;
}
pOption->valid = TRUE;
LOG ("Option %s set to %s", AEWF_OPTION_LOG, pAewf->pLogFilename);
}
if (strcmp (pOption->p_key, AEWF_OPTION_STATS) == 0)
{
pAewf->pStatsFilename = strdup (pOption->p_value);
pOption->valid = TRUE;
- LOG ("Option %s set to %s", AEWF_OPTION_LOG, pAewf->pLogFilename);
+ LOG ("Option %s set to %s", AEWF_OPTION_STATS, pAewf->pStatsFilename);
}
else TEST_OPTION_UINT64 (AEWF_OPTION_MAXOPENSEGMENTS, MaxOpenSegments)
else TEST_OPTION_UINT64 (AEWF_OPTION_TABLECACHE , MaxTableCache)
else TEST_OPTION_UINT64 (AEWF_OPTION_STATSREFRESH , StatsRefresh)
}
#undef TEST_OPTION_UINT64
if (pError)
*ppError = strdup (pError);
LOG ("Ret - rc=%d,Error=%s", rc, *ppError);
return rc;
}
static int AewfGetInfofileContent (void *pHandle, const char **ppInfoBuf)
{
t_pAewf pAewf = (t_pAewf) pHandle;
char *pInfo;
LOG ("Called");
pInfo = strdup (pAewf->pInfo);
if (pInfo == NULL)
return AEWF_MEMALLOC_FAILED;
*ppInfoBuf = pInfo;
LOG ("Ret - %d bytes of info", strlen(pInfo)+1);
return AEWF_OK;
}
static const char* AewfGetErrorMessage (int ErrNum)
{
const char *pMsg;
#define ADD_ERR(AewfErrCode) \
case AewfErrCode: pMsg = #AewfErrCode; \
break;
switch (ErrNum)
{
ADD_ERR (AEWF_OK)
ADD_ERR (AEWF_MEMALLOC_FAILED)
ADD_ERR (AEWF_READ_BEYOND_END_OF_IMAGE)
ADD_ERR (AEWF_OPTIONS_ERROR)
ADD_ERR (AEWF_CANNOT_OPEN_LOGFILE)
ADD_ERR (AEWF_FILE_OPEN_FAILED)
ADD_ERR (AEWF_FILE_CLOSE_FAILED)
ADD_ERR (AEWF_FILE_SEEK_FAILED)
ADD_ERR (AEWF_FILE_READ_FAILED)
ADD_ERR (AEWF_READFILE_BAD_MEM)
ADD_ERR (AEWF_INVALID_SEGMENT_NUMBER)
ADD_ERR (AEWF_WRONG_SEGMENT_FILE_COUNT)
ADD_ERR (AEWF_VOLUME_MUST_PRECEDE_TABLES)
ADD_ERR (AEWF_SECTORS_MUST_PRECEDE_TABLES)
ADD_ERR (AEWF_WRONG_CHUNK_COUNT)
ADD_ERR (AEWF_CHUNK_NOT_FOUND)
ADD_ERR (AEWF_VOLUME_MISSING)
ADD_ERR (AEWF_ERROR_EWF_TABLE_NOT_READY)
ADD_ERR (AEWF_ERROR_EWF_SEGMENT_NOT_READY)
ADD_ERR (AEWF_CHUNK_TOO_BIG)
ADD_ERR (AEWF_UNCOMPRESS_FAILED)
ADD_ERR (AEWF_BAD_UNCOMPRESSED_LENGTH)
ADD_ERR (AEWF_CHUNK_CRC_ERROR)
ADD_ERR (AEWF_ERROR_IN_CHUNK_NUMBER)
ADD_ERR (AEWF_VASPRINTF_FAILED)
ADD_ERR (AEWF_UNCOMPRESS_HEADER_FAILED)
ADD_ERR (AEWF_ASPRINTF_FAILED)
ADD_ERR (AEWF_CHUNK_LENGTH_ZERO)
ADD_ERR (AEWF_NEGATIVE_SEEK)
default:
pMsg = "Unknown error";
}
#undef ARR_ERR
return pMsg;
}
static int AewfFreeBuffer (void *pBuf)
{
free (pBuf);
return AEWF_OK;
}
// ------------------------------------
// LibXmount_Input API implementation
// ------------------------------------
uint8_t LibXmount_Input_GetApiVersion ()
{
return LIBXMOUNT_INPUT_API_VERSION;
}
const char* LibXmount_Input_GetSupportedFormats ()
{
return "aewf\0\0"; //lint !e840 Use of nul character in a string literal
}
void LibXmount_Input_GetFunctions (ts_LibXmountInputFunctions *pFunctions)
{
pFunctions->CreateHandle = &AewfCreateHandle;
pFunctions->DestroyHandle = &AewfDestroyHandle;
pFunctions->Open = &AewfOpen;
pFunctions->Close = &AewfClose;
pFunctions->Size = &AewfSize;
pFunctions->Read = &AewfRead;
pFunctions->OptionsHelp = &AewfOptionsHelp;
pFunctions->OptionsParse = &AewfOptionsParse;
pFunctions->GetInfofileContent = &AewfGetInfofileContent;
pFunctions->GetErrorMessage = &AewfGetErrorMessage;
pFunctions->FreeBuffer = &AewfFreeBuffer;
}
// -----------------------------------------------------
// Small main routine for testing
// It converts an EWF file into dd
// -----------------------------------------------------
#ifdef AEWF_STANDALONE
#define PRINT_ERROR_AND_EXIT(...) \
{ \
printf (__VA_ARGS__); \
exit (1); \
}
int ParseOptions (t_pAewf pAewf, char *pOptions)
{
pts_LibXmountOptions pOptionArr;
pts_LibXmountOptions *ppOptionArr;
int OptionCount;
char *pSep;
char *pEqual;
char *pTmp;
const char *pError;
char *pOpt;
int rc;
if (pOptions == NULL)
return AEWF_OK;
if (*pOptions == '\0')
return AEWF_OK;
if (*pOptions == ',')
return AEWF_OPTIONS_ERROR;
if (pOptions[strlen(pOptions)-1] == ',')
return AEWF_OPTIONS_ERROR;
pOpt = strdup (pOptions);
// Count number of comma separated options
OptionCount = 1;
pTmp = pOpt;
while ((pTmp = strchr (pTmp, ',')) != NULL)
{
OptionCount++;
pTmp++;
}
// Create and fill option array
pOptionArr = (pts_LibXmountOptions) malloc (OptionCount * sizeof(ts_LibXmountOptions));
if (pOptionArr == NULL)
PRINT_ERROR_AND_EXIT ("Cannot allocate pOptionArr");
memset (pOptionArr, 0, OptionCount * sizeof(ts_LibXmountOptions));
pTmp = pOpt;
for (int i=0; i<OptionCount; i++)
{
pOptionArr[i].p_key = pTmp;
pSep = strchr (pTmp, ',');
if (pSep)
*pSep ='\0';
pEqual = strchr (pTmp, '=');
if (pEqual)
{
*pEqual = '\0';
pOptionArr[i].p_value = pEqual+1;
}
if (pSep != NULL)
pTmp = pSep+1;
}
// Create pointer array and call AEWF parse function
ppOptionArr = (pts_LibXmountOptions *)malloc (OptionCount*sizeof (pts_LibXmountOptions));
if (ppOptionArr == NULL)
PRINT_ERROR_AND_EXIT ("Cannot allocate ppOptionArr");
for (int i=0; i<OptionCount; i++)
ppOptionArr[i] = &pOptionArr[i];
rc = AewfOptionsParse ((void*) pAewf, OptionCount, ppOptionArr, &pError);
free (ppOptionArr);
free ( pOptionArr);
free ( pOpt);
if (pError)
PRINT_ERROR_AND_EXIT ("Error while setting options: %s", pError);
CHK (rc)
return AEWF_OK;
}
int main(int argc, const char *argv[])
{
t_pAewf pAewf=NULL;
uint64_t TotalSize;
uint64_t Remaining;
uint64_t ToRead;
uint64_t Read;
uint64_t Pos;
unsigned int BuffSize = 13*65536; // A multiple of chunk size for good performance
char Buff[BuffSize];
FILE *pFile;
int Percent;
int PercentOld;
int rc;
int Errno;
char *pOptions = NULL;
const char *pHelp;
const char *pInfoBuff;
#ifdef CREATE_REVERSE_FILE
FILE *pFileRev;
uint64_t PosRev;
#ifdef REVERSE_FILE_USES_SEPARATE_HANDLE
t_pAewf pAewfRev;
#else
#define pAewfRev pAewf
#endif
#endif
setbuf(stdout, NULL);
setbuf(stderr, NULL);
(void) setlocale (LC_ALL, "");
printf ("EWF to DD converter - result file is named dd\n");
printf (" Result file is named dd");
#ifdef CREATE_REVERSE_FILE
printf ("; Also creates a backwards read file named rev");
#ifdef REVERSE_FILE_USES_SEPARATE_HANDLE
printf ("; Uses separate AEWF handle for reverse file");
#else
printf ("; Uses the same AEWF handle for reverse file");
#endif
#endif
printf ("\n");
if (argc < 2)
{
(void) AewfOptionsHelp (&pHelp);
printf ("Usage: %s <EWF segment file 1> <EWF segment file 2> <...> [-comma_separated_options]\n", argv[0]);
printf ("Possible options:\n%s\n", pHelp);
printf ("The output file will be named dd.\n");
CHK (AewfFreeBuffer ((void*) pHelp))
exit (1);
}
if (argv[argc-1][0] == '-')
{
pOptions = strdup (&(argv[argc-1][1]));
argc--;
}
rc = AewfCreateHandle ((void**) &pAewf, "aewf", LOG_STDOUT);
if (rc != AEWF_OK)
PRINT_ERROR_AND_EXIT ("Cannot create handle, rc=%d\n", rc)
if (pOptions)
CHK (ParseOptions(pAewf, pOptions))
rc = AewfOpen (pAewf, &argv[1], argc-1);
if (rc != AEWF_OK)
PRINT_ERROR_AND_EXIT ("Cannot open EWF files, rc=%d\n", rc)
#if defined(CREATE_REVERSE_FILE) && defined(REVERSE_FILE_USES_SEPARATE_HANDLE)
rc = AewfCreateHandle ((void**) &pAewfRev, "aewf", LOG_STDOUT);
if (rc != AEWF_OK)
PRINT_ERROR_AND_EXIT ("Cannot create reverse handle, rc=%d\n", rc)
if (pOptions)
CHK (ParseOptions (pAewfRev, pOptions))
rc = AewfOpen (pAewfRev, &argv[1], argc-1);
if (rc != AEWF_OK)
PRINT_ERROR_AND_EXIT ("Cannot open EWF files, rc=%d\n", rc)
#endif
CHK (AewfGetInfofileContent ((void*) pAewf, &pInfoBuff))
if (pInfoBuff)
printf ("Contents of info buffer:\n%s\n", pInfoBuff);
CHK (AewfFreeBuffer ((void*) pInfoBuff))
CHK (AewfSize (pAewf, &TotalSize))
printf ("Total size: %" PRIu64 " bytes\n", TotalSize);
pFile = fopen ("dd", "w");
if (pFile == NULL)
PRINT_ERROR_AND_EXIT("Cannot open destination file\n");
#ifdef CREATE_REVERSE_FILE
pFileRev = fopen ("rev", "w");
if (pFileRev == NULL)
PRINT_ERROR_AND_EXIT("Cannot open reverse destination file\n");
PosRev = TotalSize;
#endif
Remaining = TotalSize;
Pos = 0;
PercentOld = -1;
Errno = 0;
while (Remaining)
{
// LOG ("Pos %" PRIu64 " -- Remaining %" PRIu64 " ", Pos, Remaining);
ToRead = GETMIN (Remaining, BuffSize);
rc = AewfRead ((void*) pAewf, &Buff[0], Pos, ToRead, &Read, &Errno);
if ((rc != AEWF_OK) || (Errno != 0))
PRINT_ERROR_AND_EXIT("Error %d while calling AewfRead (Errno %d)\n", rc, Errno);
if (Read != ToRead)
PRINT_ERROR_AND_EXIT("Only %" PRIu64 " out of %" PRIu64 " bytes read\n", Read, ToRead);
if (fwrite (Buff, Read, 1, pFile) != 1)
PRINT_ERROR_AND_EXIT("Could not write to destination file\n");
Remaining -= ToRead;
Pos += ToRead;
#ifdef CREATE_REVERSE_FILE
PosRev -= ToRead;
rc = AewfRead ((void*) pAewfRev, &Buff[0], PosRev, ToRead, &Read, &Errno);
if ((rc != AEWF_OK) || (Errno != 0))
PRINT_ERROR_AND_EXIT("Error %d while reverse calling AewfRead (Errno %d)\n", rc, Errno);
if (Read != ToRead)
PRINT_ERROR_AND_EXIT("Only %" PRIu64 " out of %" PRIu64 " bytes read from rev file\n", Read, ToRead);
if (fseeko (pFileRev, PosRev, SEEK_SET))
return AEWF_FILE_SEEK_FAILED;
if (fwrite (Buff, Read, 1, pFileRev) != 1)
PRINT_ERROR_AND_EXIT("Could not write to reverse destination file\n");
#endif
Percent = (100*Pos) / TotalSize;
if (Percent != PercentOld)
{
printf ("\r%d%% done...", Percent);
PercentOld = Percent;
}
}
if (AewfClose (pAewf))
PRINT_ERROR_AND_EXIT("Error while closing AEWF files\n");
if (AewfDestroyHandle ((void**)&pAewf))
PRINT_ERROR_AND_EXIT("Error while destroying AEWF handle\n");
if (fclose (pFile))
PRINT_ERROR_AND_EXIT ("Error while closing destination file\n");
#ifdef CREATE_REVERSE_FILE
#ifdef REVERSE_FILE_USES_SEPARATE_HANDLE
if (AewfClose (pAewfRev))
PRINT_ERROR_AND_EXIT("Error while closing reverse AEWF files\n");
if (AewfDestroyHandle ((void**)&pAewfRev))
PRINT_ERROR_AND_EXIT("Error while destroying reverse AEWF handle\n");
#endif
if (fclose (pFileRev))
PRINT_ERROR_AND_EXIT ("Error while closing reverse destination file\n");
#endif
printf ("\n");
return 0;
}
#endif
diff --git a/trunk/libxmount_input/libxmount_input_aewf/libxmount_input_aewf.h b/trunk/libxmount_input/libxmount_input_aewf/libxmount_input_aewf.h
index 33818cb..f50ca87 100644
--- a/trunk/libxmount_input/libxmount_input_aewf/libxmount_input_aewf.h
+++ b/trunk/libxmount_input/libxmount_input_aewf/libxmount_input_aewf.h
@@ -1,248 +1,246 @@
/*******************************************************************************
* xmount Copyright (c) 2008-2014 by Gillen Daniel <gillen.dan@pinguin.lu> *
* *
* This module has been written by Guy Voncken. It contains the functions for *
* accessing EWF images created by Guymager and others. *
* *
-* xmount is a small tool to "fuse mount" various harddisk image formats as dd, *
-* vdi, vhd or vmdk files and enable virtual write access to them. *
-* *
* This program is free software: you can redistribute it and/or modify it *
* under the terms of the GNU General Public License as published by the Free *
* Software Foundation, either version 3 of the License, or (at your option) *
* any later version. *
* *
* This program is distributed in the hope that it will be useful, but WITHOUT *
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or *
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for *
* more details. *
* *
* You should have received a copy of the GNU General Public License along with *
* this program. If not, see <http://www.gnu.org/licenses/>. *
*******************************************************************************/
// Please don't touch source code formatting!
#ifndef AEWF_H
#define AEWF_H
typedef struct _t_Aewf *t_pAewf;
// ----------------------
// Constant definitions
// ----------------------
#define GETMAX(a,b) ((a)>(b)?(a):(b))
#define GETMIN(a,b) ((a)<(b)?(a):(b))
#define FALSE 0
#define TRUE 1
// ---------------------
// Types and strutures
// ---------------------
typedef struct
{
unsigned char Signature[8];
unsigned char StartOfFields; // 0x01;
unsigned short int SegmentNumber;
unsigned short int EndOfFields; // 0x0000
} __attribute__ ((packed)) t_AewfFileHeader, *t_AewfpFileHeader;
typedef struct
{
unsigned char Type[16];
uint64_t OffsetNextSection;
uint64_t Size;
unsigned char Padding[40];
uint32_t Checksum;
char Data[]; //lint !e1501 data member has zero size
} __attribute__ ((packed)) t_AewfSection, *t_pAewfSection;
typedef struct
{
unsigned char MediaType;
unsigned char Unknown1[3]; // contains 0x00
uint32_t ChunkCount;
uint32_t SectorsPerChunk;
uint32_t BytesPerSector;
uint64_t SectorCount;
uint32_t CHS_Cylinders;
uint32_t CHS_Heads;
uint32_t CHS_Sectors;
unsigned char MediaFlags;
unsigned char Unknown2[3]; // contains 0x00
uint32_t PalmVolumeStartSector;
unsigned char Padding1[4]; // contains 0x00
uint32_t SmartLogsStartSector;
unsigned char CompressionLevel;
unsigned char Unknown3[3]; // contains 0x00
uint32_t ErrorBlockSize;
unsigned char Unknown4[4];
unsigned char AcquirySystemGUID[16];
unsigned char Padding2[963];
unsigned char Reserved [5];
uint32_t Checksum;
} __attribute__ ((packed)) t_AewfSectionVolume, *t_pAewfSectionVolume;
typedef struct
{
uint32_t ChunkCount;
unsigned char Padding1 [4];
uint64_t TableBaseOffset;
unsigned char Padding2 [4];
uint32_t Checksum;
uint32_t OffsetArray[]; //lint !e1501 data member has zero size
} __attribute__ ((packed)) t_AewfSectionTable, *t_pAewfSectionTable;
const uint32_t AEWF_COMPRESSED = 0x80000000;
typedef struct
{
uint32_t FirstSector;
uint32_t NumberOfSectors;
} __attribute__ ((packed)) t_AewfSectionErrorEntry, *t_pAewfSectionErrorEntry;
typedef struct
{
uint32_t NumberOfErrors;
unsigned char Padding[512];
uint32_t Checksum;
t_AewfSectionErrorEntry ErrorArr[0]; //lint !e1501 data member 'ErrorArr' has zero size
uint32_t ChecksumArr;
} __attribute__ ((packed)) t_AewfSectionError, *t_pAewfSectionError;
typedef struct
{
unsigned char MD5[16];
unsigned char Unknown[16];
uint32_t Checksum;
} __attribute__ ((packed)) t_AewfSectionHash, *t_pAewfSectionHash;
typedef struct
{
char *pName;
unsigned Number;
FILE *pFile; // NULL if file is not opened (never read or kicked out form cache)
time_t LastUsed;
} t_Segment, *t_pSegment;
typedef struct
{
uint64_t Nr; // The table's position in the pAewf->pTableArr, for debug output only
uint64_t ChunkFrom; // Number of the chunk referred to by the first entry of this table (very first chunk has number 0)
uint64_t ChunkTo; // Number of the chunk referred to by the last entry of this table
t_pSegment pSegment; // The file segment where the table is located
uint64_t Offset; // The offset of the table inside the segment file (start of t_AewfSectionTable, not of the preceding t_AewfSection)
unsigned long Size; // The length of the table (same as allocated length for pEwfTable)
uint32_t ChunkCount; // The number of chunk; this is the same as pTableData->Chunkcount, however, pTableData might not be available (NULL)
uint32_t SectionSectorsSize; // Silly EWF format has no clean way of knowing size of the last (possibly compressed) chunk of a table
time_t LastUsed; // Last usage of this table, for cache management
t_pAewfSectionTable pEwfTable; // Contains the original EWF table section or NULL, if never read or kicked out from cache
} t_Table, *t_pTable;
#define AEWF_NONE UINT64_MAX
typedef struct _t_Aewf
{
t_pSegment pSegmentArr; // Array of all segment files (in correct order)
t_pTable pTableArr; // Array of all chunk offset tables found in the segment files (in correct order)
uint64_t Segments;
uint64_t Tables;
uint64_t Chunks; // Total number of chunks in all tables
+ uint64_t TotalTableSize; // Total size of all tables
uint64_t TableCache; // Current amount RAM used by tables, in bytes
uint64_t OpenSegments; // Current number of open segment files
uint64_t SectorSize;
uint64_t Sectors;
uint64_t ChunkSize;
uint64_t ImageSize; // Equals to Sectors * SectorSize
char *pChunkBuffCompressed;
char *pChunkBuffUncompressed;
uint64_t ChunkBuffUncompressedDataLen; // This normally always is equal to the chunk size (32K), except maybe for the last chunk, if the image's total size is not a multiple of the chunk size
uint32_t ChunkBuffSize;
uint64_t ChunkInBuff; // Chunk currently residing in pChunkBuffUncompressed (AEWF_NONE if none)
char *pErrorText; // Used for assembling error text during option parsing
time_t LastStatsUpdate;
char *pInfo;
// Statistics
uint64_t SegmentCacheHits;
uint64_t SegmentCacheMisses;
uint64_t TableCacheHits;
uint64_t TableCacheMisses;
uint64_t ChunkCacheHits;
uint64_t ChunkCacheMisses;
uint64_t ReadOperations; // How many times did xmount call the function AewfRead
uint64_t DataReadFromImage; // The data (in bytes) read from the image
uint64_t DataReadFromImageRaw; // The same data (in bytes), after uncompression (if any)
uint64_t DataRequestedByCaller; // How much data was given back to the caller
uint64_t TablesReadFromImage; // The overhead of the table read operations (in bytes)
uint64_t ChunksRead;
uint64_t BytesRead;
uint64_t Errors;
int LastError;
// Options
uint64_t MaxTableCache; // Max. amount of bytes in pTableArr[x].pTableData, in bytes
uint64_t MaxOpenSegments; // Max. number of open files in pSegmentArr
char *pStatsFilename; // Statistics file
uint64_t StatsRefresh; // The time in seconds between update of the stats file
char *pLogFilename;
uint8_t LogStdout;
} t_Aewf;
// ----------------
// Error codes
// ----------------
// AEWF Error codes are automatically mapped to errno codes by means of the groups
// below. AEWF uses these errno codes:
// ENOMEM memory allocation errors
// EINVAL wrong parameter(s) passed to an AEWF function
// EIO all others: AEWF function errors, EWF image errors
enum
{
AEWF_OK = 0,
AEWF_ERROR_ENOMEM_START=1000,
AEWF_MEMALLOC_FAILED,
AEWF_ERROR_ENOMEM_END,
AEWF_ERROR_EINVAL_START=2000,
AEWF_READ_BEYOND_END_OF_IMAGE,
AEWF_OPTIONS_ERROR,
AEWF_CANNOT_OPEN_LOGFILE,
AEWF_ERROR_EINVAL_END,
AEWF_ERROR_EIO_START=3000,
AEWF_FILE_OPEN_FAILED,
AEWF_FILE_CLOSE_FAILED,
AEWF_FILE_SEEK_FAILED,
AEWF_FILE_READ_FAILED,
AEWF_READFILE_BAD_MEM,
AEWF_INVALID_SEGMENT_NUMBER,
AEWF_WRONG_SEGMENT_FILE_COUNT,
AEWF_VOLUME_MUST_PRECEDE_TABLES,
AEWF_SECTORS_MUST_PRECEDE_TABLES,
AEWF_WRONG_CHUNK_COUNT,
AEWF_CHUNK_NOT_FOUND,
AEWF_VOLUME_MISSING,
AEWF_ERROR_EWF_TABLE_NOT_READY,
AEWF_ERROR_EWF_SEGMENT_NOT_READY,
AEWF_CHUNK_TOO_BIG,
AEWF_UNCOMPRESS_FAILED,
AEWF_BAD_UNCOMPRESSED_LENGTH,
AEWF_CHUNK_CRC_ERROR,
AEWF_ERROR_IN_CHUNK_NUMBER,
AEWF_VASPRINTF_FAILED,
AEWF_UNCOMPRESS_HEADER_FAILED,
AEWF_ASPRINTF_FAILED,
AEWF_CHUNK_LENGTH_ZERO,
AEWF_NEGATIVE_SEEK,
AEWF_ERROR_EIO_END,
};
#endif
diff --git a/trunk/libxmount_input/libxmount_input_dd/libxmount_input_dd.c b/trunk/libxmount_input/libxmount_input_dd/libxmount_input_dd.c
index 18ffa5c..2a87ba2 100644
--- a/trunk/libxmount_input/libxmount_input_dd/libxmount_input_dd.c
+++ b/trunk/libxmount_input/libxmount_input_dd/libxmount_input_dd.c
@@ -1,412 +1,325 @@
/*******************************************************************************
-* xmount Copyright (c) 2008-2013 by Gillen Daniel <gillen.dan@pinguin.lu> *
+* xmount Copyright (c) 2008-2014 by Gillen Daniel <gillen.dan@pinguin.lu> *
* *
-* This module has been written by Guy Voncken. It contains the functions for *
-* accessing dd images. Split dd is supported as well. *
+* Mostly based upon code written and copyright 2014 by Guy Voncken. *
* *
* This program is free software: you can redistribute it and/or modify it *
* under the terms of the GNU General Public License as published by the Free *
* Software Foundation, either version 3 of the License, or (at your option) *
* any later version. *
* *
* This program is distributed in the hope that it will be useful, but WITHOUT *
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or *
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for *
* more details. *
* *
* You should have received a copy of the GNU General Public License along with *
* this program. If not, see <http://www.gnu.org/licenses/>. *
*******************************************************************************/
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include "../libxmount_input.h"
#include "libxmount_input_dd.h"
/*******************************************************************************
* LibXmount_Input API implementation
******************************************************************************/
/*
* LibXmount_Input_GetApiVersion
*/
uint8_t LibXmount_Input_GetApiVersion() {
return LIBXMOUNT_INPUT_API_VERSION;
}
/*
* LibXmount_Input_GetSupportedFormats
*/
const char* LibXmount_Input_GetSupportedFormats() {
return "dd\0\0";
}
/*
* LibXmount_Input_GetFunctions
*/
void LibXmount_Input_GetFunctions(ts_LibXmountInputFunctions *p_functions) {
p_functions->CreateHandle=&DdCreateHandle;
p_functions->DestroyHandle=&DdDestroyHandle;
p_functions->Open=&DdOpen;
p_functions->Close=&DdClose;
p_functions->Size=&DdSize;
p_functions->Read=&DdRead;
p_functions->OptionsHelp=&DdOptionsHelp;
p_functions->OptionsParse=&DdOptionsParse;
p_functions->GetInfofileContent=&DdGetInfofileContent;
p_functions->GetErrorMessage=&DdGetErrorMessage;
p_functions->FreeBuffer=&DdFreeBuffer;
}
/*******************************************************************************
* Private
******************************************************************************/
// ---------------------------
// Internal static functions
// ---------------------------
static inline uint64_t DdGetCurrentSeekPos (t_pPiece pPiece)
{
return ftello (pPiece->pFile);
}
static inline int DdSetCurrentSeekPos (t_pPiece pPiece,
uint64_t Val,
int Whence)
{
if (fseeko (pPiece->pFile, Val, Whence) != 0) return DD_CANNOT_SEEK;
return DD_OK;
}
static int DdRead0 (t_pdd pdd, char *pBuffer, uint64_t Seek, uint32_t *pCount)
{
t_pPiece pPiece;
uint64_t i;
// Find correct piece to read from
// -------------------------------
for (i=0; i<pdd->Pieces; i++)
{
pPiece = &pdd->pPieceArr[i];
if (Seek < pPiece->FileSize) break;
Seek -= pPiece->FileSize;
}
if (i >= pdd->Pieces) return DD_READ_BEYOND_END_OF_IMAGE;
// Read from this piece
// --------------------
CHK (DdSetCurrentSeekPos (pPiece, Seek, SEEK_SET))
*pCount = GETMIN (*pCount, pPiece->FileSize - Seek);
if (fread (pBuffer, *pCount, 1, pPiece->pFile) != 1)
{
return DD_CANNOT_READ_DATA;
}
return DD_OK;
}
// ---------------
// API functions
// ---------------
/*
* DdCreateHandle
*/
static int DdCreateHandle(void **pp_handle,
const char *p_format,
uint8_t debug)
{
(void)p_format;
t_pdd p_dd=NULL;
p_dd=(t_pdd)malloc(sizeof(t_dd));
if(p_dd==NULL) return DD_MEMALLOC_FAILED;
memset(p_dd,0,sizeof(t_dd));
*pp_handle=p_dd;
return DD_OK;
}
/*
* DdDestroyHandle
*/
static int DdDestroyHandle(void **pp_handle) {
free(*pp_handle);
*pp_handle=NULL;
return DD_OK;
}
/*
* DdOpen
*/
static int DdOpen(void *p_handle,
const char **pp_filename_arr,
uint64_t filename_arr_len)
{
t_pdd pdd=(t_pdd)p_handle;
t_pPiece pPiece;
pdd->Pieces = filename_arr_len;
pdd->pPieceArr = (t_pPiece) malloc (pdd->Pieces * sizeof(t_Piece));
if (pdd->pPieceArr == NULL) return DD_MEMALLOC_FAILED;
// Need to set everything to 0 in case an error occurs later and DdClose is
// called
memset(pdd->pPieceArr,0,pdd->Pieces * sizeof(t_Piece));
pdd->TotalSize = 0;
for (uint64_t i=0; i < pdd->Pieces; i++)
{
pPiece = &pdd->pPieceArr[i];
pPiece->pFilename = strdup (pp_filename_arr[i]);
if (pPiece->pFilename == NULL)
{
DdClose(p_handle);
return DD_MEMALLOC_FAILED;
}
pPiece->pFile = fopen (pPiece->pFilename, "r");
if (pPiece->pFile == NULL)
{
DdClose(p_handle);
return DD_FILE_OPEN_FAILED;
}
CHK(DdSetCurrentSeekPos(pPiece, 0, SEEK_END))
pPiece->FileSize = DdGetCurrentSeekPos (pPiece);
pdd->TotalSize += pPiece->FileSize;
}
return DD_OK;
}
/*
* DdClose
*/
static int DdClose(void *p_handle) {
t_pdd pdd = (t_pdd)p_handle;
t_pPiece pPiece;
int CloseErrors = 0;
if (pdd->pPieceArr)
{
for (uint64_t i=0; i < pdd->Pieces; i++)
{
pPiece = &pdd->pPieceArr[i];
if (pPiece->pFile) {
if (fclose (pPiece->pFile)) CloseErrors=1;
}
if (pPiece->pFilename) free (pPiece->pFilename);
}
free (pdd->pPieceArr);
}
if (CloseErrors) return DD_CANNOT_CLOSE_FILE;
return DD_OK;
}
/*
* DdSize
*/
static int DdSize(void *p_handle, uint64_t *p_size) {
t_pdd p_dd_handle=(t_pdd)p_handle;
*p_size=p_dd_handle->TotalSize;
return DD_OK;
}
/*
* DdRead
*/
static int DdRead(void *p_handle,
char *p_buf,
off_t seek,
size_t count,
size_t *p_read,
int *p_errno)
{
t_pdd p_dd_handle=(t_pdd)p_handle;
uint32_t remaining=count;
uint32_t to_read;
if((seek+count)>p_dd_handle->TotalSize) {
return DD_READ_BEYOND_END_OF_IMAGE;
}
do {
to_read=remaining;
CHK(DdRead0(p_dd_handle,p_buf,seek,&to_read))
remaining-=to_read;
p_buf+=to_read;
seek+=to_read;
} while(remaining);
*p_read=count;
return DD_OK;
}
/*
* DdOptionsHelp
*/
static int DdOptionsHelp(const char **pp_help) {
*pp_help=NULL;
return DD_OK;
}
/*
* DdOptionsParse
*/
static int DdOptionsParse(void *p_handle,
uint32_t options_count,
const pts_LibXmountOptions *pp_options,
const char **pp_error)
{
return DD_OK;
}
/*
* DdGetInfofileContent
*/
static int DdGetInfofileContent(void *p_handle, const char **pp_info_buf) {
t_pdd p_dd_handle=(t_pdd)p_handle;
int ret;
char *p_info_buf;
- // TODO: TotalSize seems to be incorrect here???
ret=asprintf(&p_info_buf,
"DD image assembled of %" PRIu64 " piece(s)\n"
"%" PRIu64 " bytes in total (%0.3f GiB)\n",
p_dd_handle->Pieces,
p_dd_handle->TotalSize,
p_dd_handle->TotalSize/(1024.0*1024.0*1024.0));
if(ret<0 || *pp_info_buf==NULL) return DD_MEMALLOC_FAILED;
*pp_info_buf=p_info_buf;
return DD_OK;
}
/*
* DdGetErrorMessage
*/
static const char* DdGetErrorMessage(int err_num) {
switch(err_num) {
case DD_MEMALLOC_FAILED:
return "Unable to allocate memory";
break;
case DD_FILE_OPEN_FAILED:
return "Unable to open DD file(s)";
break;
case DD_CANNOT_READ_DATA:
return "Unable to read DD data";
break;
case DD_CANNOT_CLOSE_FILE:
return "Unable to close DD file(s)";
break;
case DD_CANNOT_SEEK:
return "Unable to seek into DD data";
break;
case DD_READ_BEYOND_END_OF_IMAGE:
return "Unable to read DD data: Attempt to read past EOF";
break;
default:
return "Unknown error";
}
}
/*
* DdFreeBuffer
*/
static int DdFreeBuffer(void *p_buf) {
free(p_buf);
return DD_OK;
}
-// -----------------------------------------------------
-// Small main routine for testing
-// It a split dd file to non-split dd
-// -----------------------------------------------------
-
-
-#ifdef DD_MAIN_FOR_TESTING
-
-int main(int argc, const char *argv[])
-{
- t_pdd pdd;
- uint64_t TotalSize;
- uint64_t Remaining;
- uint64_t Read;
- uint64_t Pos;
- uint32_t BuffSize = 1024;
- char Buff[BuffSize];
- FILE *pFile;
- int Percent;
- int PercentOld;
- int rc;
-
- printf ("Split DD to DD converter\n");
- if (argc < 3)
- {
- printf ("Usage: %s <dd part 1> <dd part 2> <...> <dd destination>\n", argv[0]);
- exit (1);
- }
-
- if (DdOpen ((void**)&pdd, argc-2, &argv[1]) != DD_OK)
- {
- printf ("Cannot open split dd file\n");
- exit (1);
- }
- CHK (DdSize ((void*)pdd, &TotalSize))
- printf ("Total size: %llu bytes\n", TotalSize);
- Remaining = TotalSize;
-
- pFile = fopen (argv[argc-1], "w");
- if (pFile == NULL)
- {
- printf ("Cannot open destination file\n");
- exit (1);
- }
-
- Remaining = TotalSize;
- Pos = 0;
- PercentOld = -1;
- while (Remaining)
- {
- Read = GETMIN (Remaining, BuffSize);
- rc = DdRead ((void*)pdd, Pos, &Buff[0], Read);
- if (rc != DD_OK)
- {
- printf ("Error %d while calling DdRead\n", rc);
- exit (1);
- }
-
- if (fwrite (Buff, Read, 1, pFile) != 1)
- {
- printf ("Could not write to destinationfile\n");
- exit (2);
- }
-
- Remaining -= Read;
- Pos += Read;
- Percent = (100*Pos) / TotalSize;
- if (Percent != PercentOld)
- {
- printf ("\r%d%% done...", Percent);
- PercentOld = Percent;
- }
- }
- if (fclose (pFile))
- {
- printf ("Error while closing destinationfile\n");
- exit (3);
- }
-
- printf ("\n");
- return 0;
-}
-
-#endif // DD_MAIN_FOR_TESTING
-
diff --git a/trunk/libxmount_input/libxmount_input_dd/libxmount_input_dd.h b/trunk/libxmount_input/libxmount_input_dd/libxmount_input_dd.h
index f6fb6c8..3a93a95 100644
--- a/trunk/libxmount_input/libxmount_input_dd/libxmount_input_dd.h
+++ b/trunk/libxmount_input/libxmount_input_dd/libxmount_input_dd.h
@@ -1,119 +1,115 @@
/*******************************************************************************
-* xmount Copyright (c) 2008-2013 by Gillen Daniel <gillen.dan@pinguin.lu> *
+* xmount Copyright (c) 2008-2014 by Gillen Daniel <gillen.dan@pinguin.lu> *
* *
-* This module has been written by Guy Voncken. It contains the functions for *
-* accessing dd images. Split dd is supported as well. *
-* *
-* xmount is a small tool to "fuse mount" various harddisk image formats as dd, *
-* vdi, vhd or vmdk files and enable virtual write access to them. *
+* Mostly based upon code written and copyright 2014 by Guy Voncken. *
* *
* This program is free software: you can redistribute it and/or modify it *
* under the terms of the GNU General Public License as published by the Free *
* Software Foundation, either version 3 of the License, or (at your option) *
* any later version. *
* *
* This program is distributed in the hope that it will be useful, but WITHOUT *
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or *
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for *
* more details. *
* *
* You should have received a copy of the GNU General Public License along with *
* this program. If not, see <http://www.gnu.org/licenses/>. *
*******************************************************************************/
#ifndef LIBXMOUNT_INPUT_DD_H
#define LIBXMOUNT_INPUT_DD_H
/*******************************************************************************
* Error codes etc...
******************************************************************************/
enum {
DD_OK=0,
DD_MEMALLOC_FAILED,
DD_FILE_OPEN_FAILED,
DD_CANNOT_READ_DATA,
DD_CANNOT_CLOSE_FILE,
DD_CANNOT_SEEK,
DD_READ_BEYOND_END_OF_IMAGE
};
// ----------------------
// Constant definitions
// ----------------------
#define GETMAX(a,b) ((a)>(b)?(a):(b))
#define GETMIN(a,b) ((a)<(b)?(a):(b))
// ---------------------
// Types and strutures
// ---------------------
typedef struct {
char *pFilename;
uint64_t FileSize;
FILE *pFile;
} t_Piece, *t_pPiece;
typedef struct {
t_pPiece pPieceArr;
uint64_t Pieces;
uint64_t TotalSize;
} t_dd, *t_pdd;
// ----------------
// Error handling
// ----------------
#ifdef DD_DEBUG
#define CHK(ChkVal) \
{ \
int ChkValRc; \
if ((ChkValRc=(ChkVal)) != DD_OK) \
{ \
printf ("Err %d in %s, %d\n", ChkValRc, __FILE__, __LINE__); \
return ChkValRc; \
} \
}
#define DEBUG_PRINTF(pFormat, ...) \
printf (pFormat, ##__VA_ARGS__);
#else
#define CHK(ChkVal) \
{ \
int ChkValRc; \
if ((ChkValRc=(ChkVal)) != DD_OK) \
return ChkValRc; \
}
#define DEBUG_PRINTF(...)
#endif
/*******************************************************************************
* Forward declarations
******************************************************************************/
static int DdCreateHandle(void **pp_handle,
const char *p_format,
uint8_t debug);
static int DdDestroyHandle(void **pp_handle);
static int DdOpen(void *p_handle,
const char **pp_filename_arr,
uint64_t filename_arr_len);
static int DdClose(void *p_handle);
static int DdSize(void *p_handle,
uint64_t *p_size);
static int DdRead(void *p_handle,
char *p_buf,
off_t seek,
size_t count,
size_t *p_read,
int *p_errno);
static int DdOptionsHelp(const char **pp_help);
static int DdOptionsParse(void *p_handle,
uint32_t options_count,
const pts_LibXmountOptions *pp_options,
const char **pp_error);
static int DdGetInfofileContent(void *p_handle,
const char **pp_info_buf);
static const char* DdGetErrorMessage(int err_num);
static int DdFreeBuffer(void *p_buf);
#endif // LIBXMOUNT_INPUT_DD_H
diff --git a/trunk/libxmount_morphing/libxmount_morphing_raid/libxmount_morphing_raid.c b/trunk/libxmount_morphing/libxmount_morphing_raid/libxmount_morphing_raid.c
index a6b5722..0d468ba 100644
--- a/trunk/libxmount_morphing/libxmount_morphing_raid/libxmount_morphing_raid.c
+++ b/trunk/libxmount_morphing/libxmount_morphing_raid/libxmount_morphing_raid.c
@@ -1,374 +1,374 @@
/*******************************************************************************
* xmount Copyright (c) 2008-2014 by Gillen Daniel <gillen.dan@pinguin.lu> *
* *
* This program is free software: you can redistribute it and/or modify it *
* under the terms of the GNU General Public License as published by the Free *
* Software Foundation, either version 3 of the License, or (at your option) *
* any later version. *
* *
* This program is distributed in the hope that it will be useful, but WITHOUT *
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or *
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for *
* more details. *
* *
* You should have received a copy of the GNU General Public License along with *
* this program. If not, see <http://www.gnu.org/licenses/>. *
*******************************************************************************/
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include "../libxmount_morphing.h"
#include "libxmount_morphing_raid.h"
#define LOG_DEBUG(...) { \
LIBXMOUNT_LOG_DEBUG(p_raid_handle->debug,__VA_ARGS__); \
}
/*******************************************************************************
* LibXmount_Morphing API implementation
******************************************************************************/
/*
* LibXmount_Morphing_GetApiVersion
*/
uint8_t LibXmount_Morphing_GetApiVersion() {
return LIBXMOUNT_MORPHING_API_VERSION;
}
/*
* LibXmount_Morphing_GetSupportedFormats
*/
const char* LibXmount_Morphing_GetSupportedTypes() {
return "raid0\0\0";
}
/*
* LibXmount_Morphing_GetFunctions
*/
void LibXmount_Morphing_GetFunctions(ts_LibXmountMorphingFunctions *p_functions)
{
p_functions->CreateHandle=&RaidCreateHandle;
p_functions->DestroyHandle=&RaidDestroyHandle;
p_functions->Morph=&RaidMorph;
p_functions->Size=&RaidSize;
p_functions->Read=&RaidRead;
p_functions->OptionsHelp=&RaidOptionsHelp;
p_functions->OptionsParse=&RaidOptionsParse;
p_functions->GetInfofileContent=&RaidGetInfofileContent;
p_functions->GetErrorMessage=&RaidGetErrorMessage;
p_functions->FreeBuffer=&RaidFreeBuffer;
}
/*******************************************************************************
* Private
******************************************************************************/
/*
* RaidCreateHandle
*/
static int RaidCreateHandle(void **pp_handle,
const char *p_format,
uint8_t debug)
{
pts_RaidHandle p_raid_handle;
// Alloc new handle
p_raid_handle=malloc(sizeof(ts_RaidHandle));
if(p_raid_handle==NULL) return RAID_MEMALLOC_FAILED;
// Init handle values
p_raid_handle->debug=debug;
p_raid_handle->input_images_count=0;
p_raid_handle->chunk_size=RAID_DEFAULT_CHUNKSIZE;
p_raid_handle->chunks_per_image=0;
p_raid_handle->p_input_functions=NULL;
p_raid_handle->morphed_image_size=0;
LOG_DEBUG("Created new LibXmount_Morphing_Raid handle\n");
// Return new handle
*pp_handle=p_raid_handle;
return RAID_OK;
}
/*
* RaidDestroyHandle
*/
static int RaidDestroyHandle(void **pp_handle) {
pts_RaidHandle p_raid_handle=(pts_RaidHandle)*pp_handle;
LOG_DEBUG("Destroying LibXmount_Morphing_Raid handle\n");
// Free handle
free(p_raid_handle);
*pp_handle=NULL;
return RAID_OK;
}
/*
* RaidMorph
*/
static int RaidMorph(void *p_handle,
pts_LibXmountMorphingInputFunctions p_input_functions)
{
pts_RaidHandle p_raid_handle=(pts_RaidHandle)p_handle;
int ret;
uint64_t input_image_size;
uint64_t chunks_per_image;
LOG_DEBUG("Initializing LibXmount_Morphing_Raid\n");
// Set input functions and get image count
p_raid_handle->p_input_functions=p_input_functions;
if(p_raid_handle->
p_input_functions->
ImageCount(&p_raid_handle->input_images_count)!=0)
{
return RAID_CANNOT_GET_IMAGECOUNT;
}
// Calculate chunks per image
for(uint64_t i=0;i<p_raid_handle->input_images_count;i++) {
ret=p_raid_handle->
p_input_functions->
Size(i,&input_image_size);
if(ret!=0) return RAID_CANNOT_GET_IMAGESIZE;
chunks_per_image=input_image_size/p_raid_handle->chunk_size;
LOG_DEBUG("Image %" PRIu64 " can hold a maximum of %" PRIu64 " chunks of %"
PRIu32 " bytes\n",
i,
chunks_per_image,
p_raid_handle->chunk_size);
// The smallest image determines how many chunks are availbale on all images
if(p_raid_handle->chunks_per_image==0) {
p_raid_handle->chunks_per_image=chunks_per_image;
} else if(chunks_per_image<p_raid_handle->chunks_per_image) {
p_raid_handle->chunks_per_image=chunks_per_image;
}
}
LOG_DEBUG("Smallest image holds %" PRIu64 " chunks of %" PRIu32 " bytes\n",
p_raid_handle->chunks_per_image,
p_raid_handle->chunk_size);
// Calculate total raid capacity based on smallest disk
p_raid_handle->morphed_image_size=
p_raid_handle->chunks_per_image*
p_raid_handle->chunk_size*p_raid_handle->input_images_count;
LOG_DEBUG("Total raid capacity is %" PRIu64 " bytes\n",
p_raid_handle->morphed_image_size);
return RAID_OK;
}
/*
* RaidSize
*/
static int RaidSize(void *p_handle, uint64_t *p_size) {
*p_size=((pts_RaidHandle)(p_handle))->morphed_image_size;
return RAID_OK;
}
/*
* RaidRead
*/
static int RaidRead(void *p_handle,
char *p_buf,
off_t offset,
size_t count,
size_t *p_read)
{
pts_RaidHandle p_raid_handle=(pts_RaidHandle)p_handle;
uint64_t cur_chunk;
uint64_t cur_image;
off_t cur_chunk_offset;
off_t cur_image_offset;
size_t cur_count;
int ret;
size_t read;
LOG_DEBUG("Reading %zu bytes at offset %zu from morphed image\n",
count,
offset);
// Make sure read parameters are within morphed image bounds
if(offset>=p_raid_handle->morphed_image_size ||
offset+count>p_raid_handle->morphed_image_size)
{
return RAID_READ_BEYOND_END_OF_IMAGE;
}
// Calculate starting chunk, and chunk offset
cur_chunk=offset/p_raid_handle->chunk_size;
cur_chunk_offset=offset-(cur_chunk*p_raid_handle->chunk_size);
// Init p_read
*p_read=0;
while(count!=0) {
// Calculate image and image offset to read from
cur_image=cur_chunk%p_raid_handle->input_images_count;
cur_image_offset=
(cur_chunk/p_raid_handle->input_images_count)*p_raid_handle->chunk_size;
// Calculate how many bytes to read from current chunk
if(cur_chunk_offset+count>p_raid_handle->chunk_size) {
cur_count=p_raid_handle->chunk_size-cur_chunk_offset;
} else {
cur_count=count;
}
LOG_DEBUG("Reading %zu bytes at offset %zu from image %" PRIu64
" (chunk %" PRIu64 ")\n",
cur_count,
cur_image_offset+cur_chunk_offset,
cur_image,
cur_chunk);
// Read bytes
ret=p_raid_handle->p_input_functions->
Read(cur_image,
p_buf,
cur_image_offset+cur_chunk_offset,
cur_count,
&read);
if(ret!=0 || read!=cur_count) return RAID_CANNOT_READ_DATA;
p_buf+=cur_count;
cur_chunk_offset=0;
count-=cur_count;
cur_chunk++;
(*p_read)+=cur_count;
}
return RAID_OK;
}
/*
* RaidOptionsHelp
*/
static int RaidOptionsHelp(const char **pp_help) {
int ok;
char *p_buf;
ok=asprintf(&p_buf,
" raid_chunksize : Specify the chunk size to use in bytes. "
- "Defaults to 524288 (512k).");
+ "Defaults to 524288 (512k).\n");
if(ok<0 || p_buf==NULL) {
*pp_help=NULL;
return RAID_MEMALLOC_FAILED;
}
*pp_help=p_buf;
return RAID_OK;
}
/*
* RaidOptionsParse
*/
static int RaidOptionsParse(void *p_handle,
uint32_t options_count,
const pts_LibXmountOptions *pp_options,
const char **pp_error)
{
pts_RaidHandle p_raid_handle=(pts_RaidHandle)p_handle;
int ok;
uint32_t uint32value;
char *p_buf;
for(uint32_t i=0;i<options_count;i++) {
if(strcmp(pp_options[i]->p_key,"raid_chunksize")) {
// Convert value to uint32
uint32value=StrToUint32(pp_options[i]->p_value,&ok);
if(ok==0 || uint32value==0) {
// Conversion failed, generate error message and return
ok=asprintf(&p_buf,
"Unable to parse value '%s' of '%s' as valid 32bit number",
pp_options[i]->p_value,
pp_options[i]->p_key);
if(ok<0 || *pp_error==NULL) {
*pp_error=NULL;
return RAID_MEMALLOC_FAILED;
}
*pp_error=p_buf;
return RAID_CANNOT_PARSE_OPTION;
}
LOG_DEBUG("Setting chunk size to %" PRIu32 " bytes\n",uint32value);
// Conversion ok, save value and mark option as valid
p_raid_handle->chunk_size=uint32value;
pp_options[i]->valid=1;
continue;
}
}
return RAID_OK;
}
/*
* RaidGetInfofileContent
*/
static int RaidGetInfofileContent(void *p_handle,
const char **pp_info_buf)
{
pts_RaidHandle p_raid_handle=(pts_RaidHandle)p_handle;
int ret;
char *p_buf;
ret=asprintf(&p_buf,
"Simulating RAID level 0 over %" PRIu64 " disks.\n"
"Chunk size: %" PRIu32 " bytes\n"
"Chunks per disk: %" PRIu64 "\n"
"Total capacity: %" PRIu64 " bytes (%0.3f GiB)\n",
p_raid_handle->input_images_count,
p_raid_handle->chunk_size,
p_raid_handle->chunks_per_image,
p_raid_handle->morphed_image_size,
p_raid_handle->morphed_image_size/(1024.0*1024.0*1024.0));
if(ret<0 || *pp_info_buf==NULL) return RAID_MEMALLOC_FAILED;
*pp_info_buf=p_buf;
return RAID_OK;
}
/*
* RaidGetErrorMessage
*/
static const char* RaidGetErrorMessage(int err_num) {
switch(err_num) {
case RAID_MEMALLOC_FAILED:
return "Unable to allocate memory";
break;
case RAID_CANNOT_GET_IMAGECOUNT:
return "Unable to get input image count";
break;
case RAID_CANNOT_GET_IMAGESIZE:
return "Unable to get input image size";
break;
case RAID_READ_BEYOND_END_OF_IMAGE:
return "Unable to read data: Attempt to read past EOF";
break;
case RAID_CANNOT_READ_DATA:
return "Unable to read data";
break;
case RAID_CANNOT_PARSE_OPTION:
return "Unable to parse library option";
break;
default:
return "Unknown error";
}
}
/*
* RaidFreeBuffer
*/
static void RaidFreeBuffer(void *p_buf) {
free(p_buf);
}
diff --git a/trunk/src/xmount.c b/trunk/src/xmount.c
index 34d921b..178e81f 100755
--- a/trunk/src/xmount.c
+++ b/trunk/src/xmount.c
@@ -1,4062 +1,4106 @@
/*******************************************************************************
* xmount Copyright (c) 2008-2014 by Gillen Daniel <gillen.dan@pinguin.lu> *
* *
* xmount is a small tool to "fuse mount" various harddisk image formats as dd, *
* vdi, vhd or vmdk files and enable virtual write access to them. *
* *
* This program is free software: you can redistribute it and/or modify it *
* under the terms of the GNU General Public License as published by the Free *
* Software Foundation, either version 3 of the License, or (at your option) *
* any later version. *
* *
* This program is distributed in the hope that it will be useful, but WITHOUT *
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or *
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for *
* more details. *
* *
* You should have received a copy of the GNU General Public License along with *
* this program. If not, see <http://www.gnu.org/licenses/>. *
*******************************************************************************/
#include <config.h>
#include <stdio.h>
#include <stdlib.h>
#include <stdint.h>
#include <string.h>
#include <inttypes.h> // For PRI*
#include <errno.h>
#include <dlfcn.h> // For dlopen, dlclose, dlsym
#include <dirent.h> // For opendir, readdir, closedir
#include <unistd.h>
#include <sys/ioctl.h>
#include <sys/stat.h> // For fstat
#include <sys/types.h>
#ifdef HAVE_LINUX_FS_H
#include <linux/fs.h> // For SEEK_* ??
#endif
#if !defined(__APPLE__) && defined(HAVE_GRP_H) && defined(HAVE_PWD_H)
#include <grp.h> // For getgrnam, struct group
#include <pwd.h> // For getpwuid, struct passwd
#endif
#include <pthread.h>
#include <time.h> // For time
#define FUSE_USE_VERSION 26
#include <fuse.h>
#include "xmount.h"
#include "md5.h"
#include "macros.h"
#include "../libxmount/libxmount.h"
#define XMOUNT_COPYRIGHT_NOTICE \
"xmount v%s Copyright (c) 2008-2014 by Gillen Daniel <gillen.dan@pinguin.lu>"
#define LOG_WARNING(...) { \
LIBXMOUNT_LOG_WARNING(__VA_ARGS__); \
}
#define LOG_ERROR(...) { \
LIBXMOUNT_LOG_ERROR(__VA_ARGS__); \
}
#define LOG_DEBUG(...) { \
LIBXMOUNT_LOG_DEBUG(glob_xmount.debug,__VA_ARGS__); \
}
/*******************************************************************************
* Global vars
******************************************************************************/
//! Struct that contains various runtime configuration options
static ts_XmountData glob_xmount;
/*******************************************************************************
* Forward declarations
******************************************************************************/
// Helper functions
static void PrintUsage(char*);
static void CheckFuseSettings();
static int ParseCmdLine(const int, char**);
static int ExtractVirtFileNames(char*);
static int GetMorphedImageSize(uint64_t*);
static int GetVirtImageSize(uint64_t*);
static int GetInputImageData(pts_InputImage, char*, off_t, size_t, size_t*);
static int GetMorphedImageData(char*, off_t, size_t, size_t*);
static int GetVirtImageData(char*, off_t, size_t);
static int SetVdiFileHeaderData(char*, off_t, size_t);
static int SetVhdFileHeaderData(char*, off_t, size_t);
static int SetVirtImageData(const char*, off_t, size_t);
static int CalculateInputImageHash(uint64_t*, uint64_t*);
static int InitVirtVdiHeader();
static int InitVirtVhdHeader();
static int InitVirtualVmdkFile();
static int InitVirtImageInfoFile();
static int InitCacheFile();
static int LoadLibs();
static int FindInputLib(pts_InputImage);
static int FindMorphingLib();
static void InitResources();
static void FreeResources();
static int SplitLibraryParameters(char*, uint32_t*, pts_LibXmountOptions**);
// Functions exported to LibXmount_Morphing
static int LibXmount_Morphing_ImageCount(uint64_t*);
static int LibXmount_Morphing_Size(uint64_t, uint64_t*);
static int LibXmount_Morphing_Read(uint64_t, char*, off_t, size_t, size_t*);
// Functions implementing FUSE functions
static int FuseGetAttr(const char*, struct stat*);
static int FuseMkDir(const char*, mode_t);
static int FuseMkNod(const char*, mode_t, dev_t);
static int FuseReadDir(const char*,
void*,
fuse_fill_dir_t,
off_t,
struct fuse_file_info*);
static int FuseOpen(const char*, struct fuse_file_info*);
static int FuseRead(const char*, char*, size_t, off_t, struct fuse_file_info*);
static int FuseRename(const char*, const char*);
static int FuseRmDir(const char*);
static int FuseUnlink(const char*);
//static int FuseStatFs(const char*, struct statvfs*);
static int FuseWrite(const char *p_path,
const char*,
size_t,
off_t,
struct fuse_file_info*);
/*******************************************************************************
* Helper functions
******************************************************************************/
//! Print usage instructions (cmdline options etc..)
/*!
* \param p_prog_name Program name (argv[0])
*/
static void PrintUsage(char *p_prog_name) {
char *p_buf;
int first;
int ret;
printf("\n" XMOUNT_COPYRIGHT_NOTICE "\n",XMOUNT_VERSION);
printf("\nUsage:\n");
printf(" %s [fopts] <xopts> <mntp>\n\n",p_prog_name);
printf("Options:\n");
printf(" fopts:\n");
printf(" -d : Enable FUSE's and xmount's debug mode.\n");
printf(" -h : Display this help message.\n");
printf(" -s : Run single threaded.\n");
printf(" -o no_allow_other : Disable automatic addition of FUSE's "
"allow_other option.\n");
printf(" -o <fopts> : Specify fuse mount options. Will also disable "
"automatic addition of FUSE's allow_other option!\n");
printf("\n");
printf(" xopts:\n");
printf(" --cache <cfile> : Enable virtual write support.\n");
printf(" <cfile> specifies the cache file to use.\n");
printf(" --in <itype> <ifile> : Input image format and source file(s). "
"May be specified multiple times.\n");
printf(" <itype> can be ");
// List supported input formats
first=1;
for(uint32_t i=0;i<glob_xmount.input.libs_count;i++) {
p_buf=glob_xmount.input.pp_libs[i]->p_supported_input_types;
while(*p_buf!='\0') {
if(first==1) {
printf("\"%s\"",p_buf);
first=0;
} else printf(", \"%s\"",p_buf);
p_buf+=(strlen(p_buf)+1);
}
}
printf(".\n");
printf(" <ifile> specifies the source file. If your image is split into "
"multiple files, you have to specify them all!\n");
printf(" --inopts <iopts> : Specify input library specific options.\n");
printf(" <iopts> specifies a comma separated list of key=value options. "
"See below for details.\n");
printf(" --info : Print out infos about used compiler and libraries.\n");
printf(" --morph <mtype> : Morphing function to apply to input image(s). "
"If not specified, defaults to \"combine\".\n");
printf(" <mtype> can be ");
// List supported morphing functions
first=1;
for(uint32_t i=0;i<glob_xmount.morphing.libs_count;i++) {
p_buf=glob_xmount.morphing.pp_libs[i]->p_supported_morphing_types;
while(*p_buf!='\0') {
if(first==1) {
printf("\"%s\"",p_buf);
first=0;
} else printf(", \"%s\"",p_buf);
p_buf+=(strlen(p_buf)+1);
}
}
printf(".\n");
printf(" --morphopts <mopts> : Specify morphing library specific "
"options.\n");
printf(" <mopts> specifies a comma separated list of key=value options. "
"See below for details.\n");
printf(" --offset <off> : Move the output image data start <off> bytes "
"into the input image(s).\n");
printf(" --out <otype> : Output image format. If not specified, "
"defaults to ");
#ifdef __APPLE__
printf("\"dmg\".\n");
#else
printf("\"dd\".\n");
#endif
printf(" <otype> can be ");
// List supported output formats
printf("\"dd\", \"dmg\", \"vdi\", \"vhd\", \"vmdk\", \"vmdks\".\n");
printf(" --owcache <file> : Same as --cache <file> but overwrites "
"existing cache file.\n");
printf(" --sizelimit <size> : The data end of input image(s) is set to no "
"more than <size> bytes after the data start.\n");
printf(" --version : Same as --info.\n");
printf("\n");
printf(" mntp:\n");
printf(" Mount point where output image should be located.\n");
printf("\n");
printf("Infos:\n");
printf(" * One --in option and a mount point are mandatory!\n");
printf(" * If you specify --in multiple times, data from all images is "
"morphed into one output image using the specified morphing "
"function.\n");
printf(" * For VMDK emulation, you have to uncomment \"user_allow_other\" "
"in /etc/fuse.conf or run xmount as root.\n");
printf("\n");
printf("Input / Morphing library specific options:\n");
printf(" Input / Morphing libraries might support an own set of "
"options to configure / tune their behaviour.\n");
printf(" Libraries supporting this feature (if any) and their "
"options are listed below.\n");
printf("\n");
// List input and morphing lib options
for(uint32_t i=0;i<glob_xmount.input.libs_count;i++) {
ret=glob_xmount.input.pp_libs[i]->
lib_functions.OptionsHelp((const char**)&p_buf);
if(ret!=0) {
LOG_ERROR("Unable to get options help for library '%s': %s!\n",
glob_xmount.input.pp_libs[i]->p_name,
glob_xmount.input.pp_libs[i]->
lib_functions.GetErrorMessage(ret));
}
if(p_buf==NULL) continue;
printf(" - %s\n",glob_xmount.input.pp_libs[i]->p_name);
printf("%s",p_buf);
printf("\n");
ret=glob_xmount.input.pp_libs[i]->lib_functions.FreeBuffer(p_buf);
if(ret!=0) {
LOG_ERROR("Unable to free options help text from library '%s': %s!\n",
glob_xmount.input.pp_libs[i]->p_name,
glob_xmount.input.pp_libs[i]->
lib_functions.GetErrorMessage(ret));
}
}
for(uint32_t i=0;i<glob_xmount.morphing.libs_count;i++) {
ret=glob_xmount.morphing.pp_libs[i]->
lib_functions.OptionsHelp((const char**)&p_buf);
if(ret!=0) {
LOG_ERROR("Unable to get options help for library '%s': %s!\n",
glob_xmount.morphing.pp_libs[i]->p_name,
glob_xmount.morphing.pp_libs[i]->
lib_functions.GetErrorMessage(ret));
}
if(p_buf==NULL) continue;
printf(" - %s\n",glob_xmount.morphing.pp_libs[i]->p_name);
printf("%s",p_buf);
printf("\n");
}
-
- printf("\n");
}
//! Check fuse settings
/*!
* Check if FUSE allows us to pass the -o allow_other parameter. This only works
* if we are root or user_allow_other is set in /etc/fuse.conf.
*
* In addition, this function also checks if the user is member of the fuse
* group which is generally needed to use fuse at all.
*/
static void CheckFuseSettings() {
#if !defined(__APPLE__) && defined(HAVE_GRP_H) && defined(HAVE_PWD_H)
struct group *p_group;
struct passwd *p_passwd;
#endif
int found;
FILE *h_fuse_conf;
char line[256];
glob_xmount.may_set_fuse_allow_other=FALSE;
if(geteuid()==0) {
// Running as root, there should be no problems
glob_xmount.may_set_fuse_allow_other=TRUE;
return;
}
#if !defined(__APPLE__) && defined(HAVE_GRP_H) && defined(HAVE_PWD_H)
// Check if a fuse group exists and if so, make sure user is a member of it.
// Makes only sense on Linux because as far as I know osxfuse has no own group
p_group=getgrnam("fuse");
if(p_group!=NULL) {
// Get effective user name
p_passwd=getpwuid(geteuid());
if(p_passwd==NULL) {
printf("\nWARNING: Unable to determine your effective user name. If "
"mounting works, you can ignore this message.\n\n");
return;
}
// Check if user is member of fuse group
found=FALSE;
while(*(p_group->gr_mem)!=NULL) {
if(strcmp(*(p_group->gr_mem),p_passwd->pw_name)==0) {
found=TRUE;
break;
}
p_group->gr_mem++;
}
if(found==FALSE) {
printf("\nWARNING: You are not a member of the \"fuse\" group. This will "
"prevent you from mounting images using xmount. Please add "
"yourself to the \"fuse\" group using the command "
"\"sudo usermod -a -G fuse %s\" and reboot your system or "
"execute xmount as root.\n\n",
p_passwd->pw_name);
return;
}
} else {
printf("\nWARNING: Your system does not seem to have a \"fuse\" group. If "
"mounting works, you can ignore this message.\n\n");
}
#endif
// Read FUSE's config file /etc/fuse.conf and check for set user_allow_other
h_fuse_conf=(FILE*)FOPEN("/etc/fuse.conf","r");
if(h_fuse_conf!=NULL) {
// Search conf file for set user_allow_others
found=FALSE;
while(fgets(line,sizeof(line),h_fuse_conf)!=NULL) {
// TODO: This works as long as there is no other parameter beginning with
// "user_allow_other" :)
if(strncmp(line,"user_allow_other",16)==0) {
found=TRUE;
break;
}
}
fclose(h_fuse_conf);
if(found==TRUE) {
glob_xmount.may_set_fuse_allow_other=TRUE;
} else {
printf("\nWARNING: FUSE will not allow other users nor root to access "
"your virtual harddisk image. To change this behavior, please "
"add \"user_allow_other\" to /etc/fuse.conf or execute xmount "
"as root.\n\n");
}
} else {
printf("\nWARNING: Unable to open /etc/fuse.conf. If mounting works, you "
"can ignore this message. If you encounter issues, please create "
"the file and add a single line containing the string "
"\"user_allow_other\" or execute xmount as root.\n\n");
return;
}
}
//! Parse command line options
/*!
* \param argc Number of cmdline params
* \param pp_argv Array containing cmdline params
* \return TRUE on success, FALSE on error
*/
+#define SUPPORT_DEPRECATED_IN 1
static int ParseCmdLine(const int argc, char **pp_argv) {
int i=1;
int FuseMinusOControl=TRUE;
int FuseAllowOther=TRUE;
int first;
char *p_buf;
- pts_InputImage p_input_image;
+ pts_InputImage p_input_image=NULL;
int ret;
+#ifdef SUPPORT_DEPRECATED_IN
+ int use_old_in_syntax=FALSE;
+#endif
// add pp_argv[0] to FUSE's argv
XMOUNT_MALLOC(glob_xmount.pp_fuse_argv,char**,sizeof(char*));
XMOUNT_STRSET(glob_xmount.pp_fuse_argv[0],pp_argv[0]);
glob_xmount.fuse_argc=1;
// Parse options
while(i<argc && *pp_argv[i]=='-') {
if(strlen(pp_argv[i])>1 && *(pp_argv[i]+1)!='-') {
// Options beginning with one - are mostly FUSE specific
if(strcmp(pp_argv[i],"-d")==0) {
// Enable FUSE's and xmount's debug mode
XMOUNT_REALLOC(glob_xmount.pp_fuse_argv,
char**,
(glob_xmount.fuse_argc+1)*sizeof(char*));
XMOUNT_STRSET(glob_xmount.pp_fuse_argv[glob_xmount.fuse_argc],
pp_argv[i])
glob_xmount.fuse_argc++;
glob_xmount.debug=TRUE;
} else if(strcmp(pp_argv[i],"-h")==0) {
// Print help message
PrintUsage(pp_argv[0]);
exit(0);
} else if(strcmp(pp_argv[i],"-o")==0) {
// Next parameter specifies fuse / lib mount options
if((argc+1)>i) {
i++;
// As the user specified the -o option, we assume he knows what he is
// doing. We won't append allow_other automatically. And we allow him
// to disable allow_other by passing a single "-o no_allow_other"
// which won't be passed to FUSE as it is xmount specific.
if(strcmp(pp_argv[i],"no_allow_other")!=0) {
glob_xmount.fuse_argc+=2;
XMOUNT_REALLOC(glob_xmount.pp_fuse_argv,
char**,
glob_xmount.fuse_argc*sizeof(char*));
XMOUNT_STRSET(glob_xmount.pp_fuse_argv[glob_xmount.fuse_argc-2],
pp_argv[i-1]);
XMOUNT_STRSET(glob_xmount.pp_fuse_argv[glob_xmount.fuse_argc-1],
pp_argv[i]);
FuseMinusOControl=FALSE;
} else FuseAllowOther=FALSE;
} else {
LOG_ERROR("Couldn't parse mount options!\n")
return FALSE;
}
} else if(strcmp(pp_argv[i],"-s")==0) {
// Enable FUSE's single threaded mode
XMOUNT_REALLOC(glob_xmount.pp_fuse_argv,
char**,
(glob_xmount.fuse_argc+1)*sizeof(char*));
XMOUNT_STRSET(glob_xmount.pp_fuse_argv[glob_xmount.fuse_argc],
pp_argv[i]);
glob_xmount.fuse_argc++;
} else if(strcmp(pp_argv[i],"-V")==0) {
// Display FUSE version info
XMOUNT_REALLOC(glob_xmount.pp_fuse_argv,
char**,
(glob_xmount.fuse_argc+1)*sizeof(char*));
XMOUNT_STRSET(glob_xmount.pp_fuse_argv[glob_xmount.fuse_argc],
pp_argv[i]);
glob_xmount.fuse_argc++;
} else {
LOG_ERROR("Unknown command line option \"%s\"\n",pp_argv[i]);
return FALSE;
}
} else {
// Options beginning with -- are xmount specific
if(strcmp(pp_argv[i],"--cache")==0 || strcmp(pp_argv[i],"--rw")==0) {
// Emulate writable access to mounted image
// Next parameter must be cache file to read/write changes from/to
if((argc+1)>i) {
i++;
XMOUNT_STRSET(glob_xmount.cache.p_cache_file,pp_argv[i])
glob_xmount.output.writable=TRUE;
} else {
LOG_ERROR("You must specify a cache file!\n")
return FALSE;
}
LOG_DEBUG("Enabling virtual write support using cache file \"%s\"\n",
glob_xmount.cache.p_cache_file)
} else if(strcmp(pp_argv[i],"--in")==0) {
// Specify input image type and source files
+#ifdef SUPPORT_DEPRECATED_IN
+ if(use_old_in_syntax==TRUE) {
+ LOG_ERROR("When using the deprecated --in option syntax, it is not "
+ "possible to specify --in multiple times!\n");
+ free(p_input_image->p_type);
+ free(p_input_image);
+ return FALSE;
+ }
+#endif
if((argc+2)>i) {
i++;
// Alloc and init new ts_InputImage struct
XMOUNT_MALLOC(p_input_image,pts_InputImage,sizeof(ts_InputImage));
XMOUNT_STRSET(p_input_image->p_type,pp_argv[i]);
p_input_image->pp_files=NULL;
p_input_image->p_functions=NULL;
p_input_image->p_handle=NULL;
// Parse input image filename(s) and add to p_input_image->pp_files
i++;
p_input_image->files_count=0;
while(i<(argc-1) && strncmp(pp_argv[i],"--",2)!=0) {
p_input_image->files_count++;
XMOUNT_REALLOC(p_input_image->pp_files,
char**,
p_input_image->files_count*sizeof(char*));
XMOUNT_STRSET(p_input_image->pp_files[p_input_image->files_count-1],
pp_argv[i]);
i++;
}
i--;
if(p_input_image->files_count==0) {
+#ifndef SUPPORT_DEPRECATED_IN
LOG_ERROR("No input files specified for \"--in %s\"!\n",
p_input_image->p_type)
free(p_input_image->p_type);
free(p_input_image);
return FALSE;
+#else
+ use_old_in_syntax=TRUE;
+ continue;
+#endif
}
// Add input image struct to input image array
glob_xmount.input.images_count++;
XMOUNT_REALLOC(glob_xmount.input.pp_images,
pts_InputImage*,
glob_xmount.input.images_count*
sizeof(pts_InputImage));
glob_xmount.input.pp_images[glob_xmount.input.images_count-1]=
p_input_image;
} else {
LOG_ERROR("You must specify an input image type and source file!\n");
return FALSE;
}
} else if(strcmp(pp_argv[i],"--inopts")==0) {
// Set input lib options
if((argc+1)>i) {
i++;
if(glob_xmount.input.pp_lib_params==NULL) {
if(SplitLibraryParameters(pp_argv[i],
&(glob_xmount.input.lib_params_count),
&(glob_xmount.input.pp_lib_params)
)==FALSE)
{
LOG_ERROR("Unable to parse input library options '%s'!\n",
pp_argv[i]);
return FALSE;
}
} else {
LOG_ERROR("You can only specify --inopts once!")
return FALSE;
}
} else {
LOG_ERROR("You must specify special options!\n");
return FALSE;
}
} else if(strcmp(pp_argv[i],"--morph")==0) {
// Set morphing lib to use
if((argc+1)>i) {
i++;
if(glob_xmount.morphing.p_morph_type==NULL) {
XMOUNT_STRSET(glob_xmount.morphing.p_morph_type,pp_argv[i]);
} else {
LOG_ERROR("You can only specify --morph once!")
return FALSE;
}
} else {
LOG_ERROR("You must specify morphing type!\n");
return FALSE;
}
} else if(strcmp(pp_argv[i],"--morphopts")==0) {
// Set morphing lib options
if((argc+1)>i) {
i++;
if(glob_xmount.morphing.pp_lib_params==NULL) {
if(SplitLibraryParameters(pp_argv[i],
&(glob_xmount.morphing.lib_params_count),
&(glob_xmount.morphing.pp_lib_params)
)==FALSE)
{
LOG_ERROR("Unable to parse morphing library options '%s'!\n",
pp_argv[i]);
return FALSE;
}
} else {
LOG_ERROR("You can only specify --morphopts once!")
return FALSE;
}
} else {
LOG_ERROR("You must specify special morphing lib params!\n");
return FALSE;
}
} else if(strcmp(pp_argv[i],"--offset")==0) {
// Set input image offset
if((argc+1)>i) {
i++;
glob_xmount.input.image_offset=StrToUint64(pp_argv[i],&ret);
if(ret==0) {
LOG_ERROR("Unable to convert '%s' to a number!\n",pp_argv[i])
return FALSE;
}
} else {
LOG_ERROR("You must specify an offset!\n")
return FALSE;
}
LOG_DEBUG("Setting input image offset to \"%" PRIu64 "\"\n",
glob_xmount.input.image_offset)
} else if(strcmp(pp_argv[i],"--out")==0) {
// Specify output image type
// Next parameter must be image type
if((argc+1)>i) {
i++;
if(strcmp(pp_argv[i],"dd")==0) {
glob_xmount.output.VirtImageType=VirtImageType_DD;
LOG_DEBUG("Setting virtual image type to DD\n")
} else if(strcmp(pp_argv[i],"dmg")==0) {
glob_xmount.output.VirtImageType=VirtImageType_DMG;
LOG_DEBUG("Setting virtual image type to DMG\n")
} else if(strcmp(pp_argv[i],"vdi")==0) {
glob_xmount.output.VirtImageType=VirtImageType_VDI;
LOG_DEBUG("Setting virtual image type to VDI\n")
} else if(strcmp(pp_argv[i],"vhd")==0) {
glob_xmount.output.VirtImageType=VirtImageType_VHD;
LOG_DEBUG("Setting virtual image type to VHD\n")
} else if(strcmp(pp_argv[i],"vmdk")==0) {
glob_xmount.output.VirtImageType=VirtImageType_VMDK;
LOG_DEBUG("Setting virtual image type to VMDK\n")
} else if(strcmp(pp_argv[i],"vmdks")==0) {
glob_xmount.output.VirtImageType=VirtImageType_VMDKS;
LOG_DEBUG("Setting virtual image type to VMDKS\n")
} else {
LOG_ERROR("Unknown output image type \"%s\"!\n",pp_argv[i])
return FALSE;
}
} else {
LOG_ERROR("You must specify an output image type!\n");
return FALSE;
}
} else if(strcmp(pp_argv[i],"--owcache")==0) {
// Enable writable access to mounted image and overwrite existing cache
// Next parameter must be cache file to read/write changes from/to
if((argc+1)>i) {
i++;
XMOUNT_STRSET(glob_xmount.cache.p_cache_file,pp_argv[i])
glob_xmount.output.writable=TRUE;
glob_xmount.cache.overwrite_cache=TRUE;
} else {
LOG_ERROR("You must specify a cache file!\n")
return FALSE;
}
LOG_DEBUG("Enabling virtual write support overwriting cache file %s\n",
glob_xmount.cache.p_cache_file)
} else if(strcmp(pp_argv[i],"--sizelimit")==0) {
// Set input image size limit
if((argc+1)>i) {
i++;
glob_xmount.input.image_size_limit=StrToUint64(pp_argv[i],&ret);
if(ret==0) {
LOG_ERROR("Unable to convert '%s' to a number!\n",pp_argv[i])
return FALSE;
}
} else {
LOG_ERROR("You must specify a size limit!\n")
return FALSE;
}
LOG_DEBUG("Setting input image size limit to \"%" PRIu64 "\"\n",
glob_xmount.input.image_size_limit)
} else if(strcmp(pp_argv[i],"--version")==0 ||
strcmp(pp_argv[i],"--info")==0)
{
// Print xmount info
printf(XMOUNT_COPYRIGHT_NOTICE "\n\n",XMOUNT_VERSION);
#ifdef __GNUC__
printf(" compile timestamp: %s %s\n",__DATE__,__TIME__);
printf(" gcc version: %s\n",__VERSION__);
#endif
printf(" loaded input libraries:\n");
for(uint32_t ii=0;ii<glob_xmount.input.libs_count;ii++) {
printf(" - %s supporting ",glob_xmount.input.pp_libs[ii]->p_name);
p_buf=glob_xmount.input.pp_libs[ii]->p_supported_input_types;
first=TRUE;
while(*p_buf!='\0') {
if(first) {
printf("\"%s\"",p_buf);
first=FALSE;
} else printf(", \"%s\"",p_buf);
p_buf+=(strlen(p_buf)+1);
}
printf("\n");
}
printf(" loaded morphing libraries:\n");
for(uint32_t ii=0;ii<glob_xmount.morphing.libs_count;ii++) {
printf(" - %s supporting ",
glob_xmount.morphing.pp_libs[ii]->p_name);
p_buf=glob_xmount.morphing.pp_libs[ii]->p_supported_morphing_types;
first=TRUE;
while(*p_buf!='\0') {
if(first) {
printf("\"%s\"",p_buf);
first=FALSE;
} else printf(", \"%s\"",p_buf);
p_buf+=(strlen(p_buf)+1);
}
printf("\n");
}
printf("\n");
exit(0);
} else {
LOG_ERROR("Unknown command line option \"%s\"\n",pp_argv[i]);
return FALSE;
}
}
i++;
}
+#ifdef SUPPORT_DEPRECATED_IN
+ if(use_old_in_syntax==TRUE && i<(argc-1)) {
+ LOG_WARNING("You are using a deprecated --in option syntax which will be "
+ "removed in the next release. Please see the man page "
+ "on how to use the new syntax.\n");
+ while(i<(argc-1)) {
+ p_input_image->files_count++;
+ XMOUNT_REALLOC(p_input_image->pp_files,
+ char**,
+ p_input_image->files_count*sizeof(char*));
+ XMOUNT_STRSET(p_input_image->pp_files[p_input_image->files_count-1],
+ pp_argv[i]);
+ i++;
+ }
+ // Add input image struct to input image array
+ glob_xmount.input.images_count++;
+ XMOUNT_REALLOC(glob_xmount.input.pp_images,
+ pts_InputImage*,
+ glob_xmount.input.images_count*sizeof(pts_InputImage));
+ glob_xmount.input.pp_images[glob_xmount.input.images_count-1]=p_input_image;
+ } else if(use_old_in_syntax==TRUE) {
+ free(p_input_image->p_type);
+ free(p_input_image);
+ LOG_ERROR("You must specify an input image type and source file!\n");
+ return FALSE;
+ }
+#endif
+
// Extract mountpoint
if(i==(argc-1)) {
XMOUNT_STRSET(glob_xmount.p_mountpoint,pp_argv[argc-1])
XMOUNT_REALLOC(glob_xmount.pp_fuse_argv,
char**,
(glob_xmount.fuse_argc+1)*sizeof(char*));
XMOUNT_STRSET(glob_xmount.pp_fuse_argv[glob_xmount.fuse_argc],
glob_xmount.p_mountpoint);
glob_xmount.fuse_argc++;
} else {
LOG_ERROR("No mountpoint specified!\n")
return FALSE;
}
if(FuseMinusOControl==TRUE) {
// We control the -o flag, set subtype, fsname and allow_other options
glob_xmount.fuse_argc+=2;
XMOUNT_REALLOC(glob_xmount.pp_fuse_argv,
char**,
glob_xmount.fuse_argc*sizeof(char*));
XMOUNT_STRSET(glob_xmount.pp_fuse_argv[glob_xmount.fuse_argc-2],"-o");
XMOUNT_STRSET(glob_xmount.pp_fuse_argv[glob_xmount.fuse_argc-1],
"subtype=xmount");
if(glob_xmount.input.images_count!=0) {
// Set name of first source file as fsname
XMOUNT_STRAPP(glob_xmount.pp_fuse_argv[glob_xmount.fuse_argc-1],
",fsname=");
XMOUNT_STRAPP(glob_xmount.pp_fuse_argv[glob_xmount.fuse_argc-1],
glob_xmount.input.pp_images[0]->pp_files[0]);
}
if(FuseAllowOther==TRUE) {
// Add "allow_other" option if allowed
if(glob_xmount.may_set_fuse_allow_other) {
XMOUNT_STRAPP(glob_xmount.pp_fuse_argv[glob_xmount.fuse_argc-1],
",allow_other");
}
}
}
return TRUE;
}
//! Extract virtual file name from input image name
/*!
* \param p_orig_name Name of input image (may include a path)
* \return TRUE on success, FALSE on error
*/
static int ExtractVirtFileNames(char *p_orig_name) {
char *tmp;
// Truncate any leading path
tmp=strrchr(p_orig_name,'/');
if(tmp!=NULL) p_orig_name=tmp+1;
// Extract file extension
tmp=strrchr(p_orig_name,'.');
// Set leading '/'
XMOUNT_STRSET(glob_xmount.output.p_virtual_image_path,"/");
XMOUNT_STRSET(glob_xmount.output.p_info_path,"/");
if(glob_xmount.output.VirtImageType==VirtImageType_VMDK ||
glob_xmount.output.VirtImageType==VirtImageType_VMDKS)
{
XMOUNT_STRSET(glob_xmount.output.vmdk.p_virtual_vmdk_path,"/");
}
// Copy filename
if(tmp==NULL) {
// Input image filename has no extension
XMOUNT_STRAPP(glob_xmount.output.p_virtual_image_path,p_orig_name);
XMOUNT_STRAPP(glob_xmount.output.p_info_path,p_orig_name);
if(glob_xmount.output.VirtImageType==VirtImageType_VMDK ||
glob_xmount.output.VirtImageType==VirtImageType_VMDKS)
{
XMOUNT_STRAPP(glob_xmount.output.vmdk.p_virtual_vmdk_path,p_orig_name);
}
XMOUNT_STRAPP(glob_xmount.output.p_info_path,".info");
} else {
XMOUNT_STRNAPP(glob_xmount.output.p_virtual_image_path,p_orig_name,
strlen(p_orig_name)-strlen(tmp));
XMOUNT_STRNAPP(glob_xmount.output.p_info_path,p_orig_name,
strlen(p_orig_name)-strlen(tmp));
if(glob_xmount.output.VirtImageType==VirtImageType_VMDK ||
glob_xmount.output.VirtImageType==VirtImageType_VMDKS)
{
XMOUNT_STRNAPP(glob_xmount.output.vmdk.p_virtual_vmdk_path,p_orig_name,
strlen(p_orig_name)-strlen(tmp));
}
XMOUNT_STRAPP(glob_xmount.output.p_info_path,".info");
}
// Add virtual file extensions
switch(glob_xmount.output.VirtImageType) {
case VirtImageType_DD:
XMOUNT_STRAPP(glob_xmount.output.p_virtual_image_path,".dd");
break;
case VirtImageType_DMG:
XMOUNT_STRAPP(glob_xmount.output.p_virtual_image_path,".dmg");
break;
case VirtImageType_VDI:
XMOUNT_STRAPP(glob_xmount.output.p_virtual_image_path,".vdi");
break;
case VirtImageType_VHD:
XMOUNT_STRAPP(glob_xmount.output.p_virtual_image_path,".vhd");
break;
case VirtImageType_VMDK:
case VirtImageType_VMDKS:
XMOUNT_STRAPP(glob_xmount.output.p_virtual_image_path,".dd");
XMOUNT_STRAPP(glob_xmount.output.vmdk.p_virtual_vmdk_path,".vmdk");
break;
default:
LOG_ERROR("Unknown virtual image type!\n")
return FALSE;
}
LOG_DEBUG("Set virtual image name to \"%s\"\n",
glob_xmount.output.p_virtual_image_path);
LOG_DEBUG("Set virtual image info name to \"%s\"\n",
glob_xmount.output.p_info_path);
if(glob_xmount.output.VirtImageType==VirtImageType_VMDK ||
glob_xmount.output.VirtImageType==VirtImageType_VMDKS)
{
LOG_DEBUG("Set virtual vmdk name to \"%s\"\n",
glob_xmount.output.vmdk.p_virtual_vmdk_path);
}
return TRUE;
}
//! Get size of morphed image
/*!
* \param p_size Buf to save size to
* \return TRUE on success, FALSE on error
*/
static int GetMorphedImageSize(uint64_t *p_size) {
int ret;
ret=glob_xmount.morphing.p_functions->Size(glob_xmount.morphing.p_handle,
p_size);
if(ret!=0) {
LOG_ERROR("Unable to get morphed image size: %s!\n",
glob_xmount.morphing.p_functions->GetErrorMessage(ret));
return FALSE;
}
return TRUE;
}
//! Get size of virtual image
/*!
* \param p_size Pointer to an uint64_t to which the size will be written to
* \return TRUE on success, FALSE on error
*/
static int GetVirtImageSize(uint64_t *p_size) {
if(glob_xmount.output.image_size!=0) {
*p_size=glob_xmount.output.image_size;
return TRUE;
}
switch(glob_xmount.output.VirtImageType) {
case VirtImageType_DD:
case VirtImageType_DMG:
case VirtImageType_VMDK:
case VirtImageType_VMDKS:
// Virtual image is a DD, DMG or VMDK file. Just return the size of the
// original image
if(!GetMorphedImageSize(p_size)) {
LOG_ERROR("Couldn't get size of input image!\n")
return FALSE;
}
break;
case VirtImageType_VDI:
// Virtual image is a VDI file. Get size of original image and add size
// of VDI header etc.
if(!GetMorphedImageSize(p_size)) {
LOG_ERROR("Couldn't get size of input image!\n")
return FALSE;
}
(*p_size)+=(sizeof(ts_VdiFileHeader)+
glob_xmount.output.vdi.vdi_block_map_size);
break;
case VirtImageType_VHD:
// Virtual image is a VHD file. Get size of original image and add size
// of VHD footer.
if(!GetMorphedImageSize(p_size)) {
LOG_ERROR("Couldn't get size of input image!\n")
return FALSE;
}
(*p_size)+=sizeof(ts_VhdFileHeader);
break;
default:
LOG_ERROR("Unsupported image type!\n")
return FALSE;
}
glob_xmount.output.image_size=*p_size;
return TRUE;
}
//! Read data from input image
/*!
* \param p_image Image from which to read data
* \param p_buf Pointer to buffer to write read data to (must be preallocated!)
* \param offset Offset at which data should be read
* \param size Size of data which should be read (size of buffer)
* \param p_read Number of read bytes on success
* \return 0 on success, negated error code on error
*/
static int GetInputImageData(pts_InputImage p_image,
char *p_buf,
off_t offset,
size_t size,
size_t *p_read)
{
int ret;
size_t to_read=0;
int read_errno=0;
LOG_DEBUG("Reading %zu bytes at offset %zu from input image '%s'\n",
size,
offset,
p_image->pp_files[0]);
// Make sure we aren't reading past EOF of image file
if(offset>=p_image->size) {
// Offset is beyond image size
LOG_DEBUG("Offset %zu is at / beyond size of input image '%s'\n",
offset,
p_image->pp_files[0]);
*p_read=0;
return 0;
}
if(offset+size>p_image->size) {
// Attempt to read data past EOF of image file
to_read=p_image->size-offset;
LOG_DEBUG("Attempt to read data past EOF of input image '%s'. "
"Correcting size from %zu to %zu\n",
p_image->pp_files[0],
size,
to_read);
} else to_read=size;
// Read data from image file (adding input image offset if one was specified)
ret=p_image->p_functions->Read(p_image->p_handle,
p_buf,
offset+glob_xmount.input.image_offset,
to_read,
p_read,
&read_errno);
if(ret!=0) {
LOG_ERROR("Couldn't read %zu bytes at offset %zu from input image "
"'%s': %s!\n",
to_read,
offset,
p_image->pp_files[0],
p_image->p_functions->GetErrorMessage(ret));
if(read_errno==0) return -EIO;
else return (read_errno*(-1));
}
return 0;
}
//! Read data from morphed image
/*!
* \param p_buf Pointer to buffer to write read data to (must be preallocated!)
* \param offset Offset at which data should be read
* \param size Size of data which should be read (size of buffer)
* \param p_read Number of read bytes on success
* \return TRUE on success, negated error code on error
*/
static int GetMorphedImageData(char *p_buf,
off_t offset,
size_t size,
size_t *p_read)
{
int ret;
size_t to_read=0;
size_t read;
uint64_t image_size=0;
// Make sure we aren't reading past EOF of image file
if(GetMorphedImageSize(&image_size)!=TRUE) {
LOG_ERROR("Couldn't get size of morphed image!\n");
return -EIO;
}
if(offset>=image_size) {
// Offset is beyond image size
LOG_DEBUG("Offset %zu is at / beyond size of morphed image.\n",offset);
*p_read=0;
return 0;
}
if(offset+size>image_size) {
// Attempt to read data past EOF of morphed image file
to_read=image_size-offset;
LOG_DEBUG("Attempt to read data past EOF of morphed image. Corrected size "
"from %zu to %zu.\n",
size,
to_read);
} else to_read=size;
// Read data from morphed image
ret=glob_xmount.morphing.p_functions->Read(glob_xmount.morphing.p_handle,
p_buf,
offset,
to_read,
&read);
if(ret!=0) {
LOG_ERROR("Couldn't read %zu bytes at offset %zu from morphed image: %s!\n",
to_read,
offset,
glob_xmount.morphing.p_functions->GetErrorMessage(ret));
return -EIO;
}
*p_read=to_read;
return TRUE;
}
//! Read data from virtual image
/*!
* \param p_buf Pointer to buffer to write read data to
* \param offset Offset at which data should be read
* \param size Size of data which should be read
* \return Number of read bytes on success or negated error code on error
*/
static int GetVirtImageData(char *p_buf, off_t offset, size_t size) {
uint32_t cur_block=0;
uint64_t morphed_image_size, virt_image_size;
size_t read, to_read=0, cur_to_read=0;
off_t file_off=offset, block_off=0;
size_t to_read_later=0;
int ret;
// Get virtual image size
if(GetVirtImageSize(&virt_image_size)!=TRUE) {
LOG_ERROR("Couldn't get size of virtual image!\n")
return -EIO;
}
if(offset>=virt_image_size) {
LOG_DEBUG("Offset %zu is at / beyond size of virtual image.\n",offset);
return 0;
}
if(offset+size>virt_image_size) {
LOG_DEBUG("Attempt to read data past EOF of virtual image. Corrected size "
"from %zu to %zu.\n",
size,
virt_image_size-offset);
size=virt_image_size-offset;
}
to_read=size;
// Get morphed image size
if(GetMorphedImageSize(&morphed_image_size)!=TRUE) {
LOG_ERROR("Couldn't get morphed image size!")
return -EIO;
}
// Read virtual image type specific data preceeding morphed image data
switch(glob_xmount.output.VirtImageType) {
case VirtImageType_DD:
case VirtImageType_DMG:
case VirtImageType_VMDK:
case VirtImageType_VMDKS:
break;
case VirtImageType_VDI:
if(file_off<glob_xmount.output.vdi.vdi_header_size) {
if(file_off+to_read>glob_xmount.output.vdi.vdi_header_size) {
cur_to_read=glob_xmount.output.vdi.vdi_header_size-file_off;
} else {
cur_to_read=to_read;
}
if(glob_xmount.output.writable==TRUE &&
glob_xmount.cache.p_cache_header->VdiFileHeaderCached==TRUE)
{
// VDI header was already cached
if(fseeko(glob_xmount.cache.h_cache_file,
glob_xmount.cache.p_cache_header->pVdiFileHeader+file_off,
SEEK_SET)!=0)
{
LOG_ERROR("Couldn't seek to cached VDI header at offset %"
PRIu64 "\n",
glob_xmount.cache.p_cache_header->pVdiFileHeader+file_off)
return -EIO;
}
if(fread(p_buf,cur_to_read,1,glob_xmount.cache.h_cache_file)!=1) {
LOG_ERROR("Couldn't read %zu bytes from cache file at offset %"
PRIu64 "\n",
cur_to_read,
glob_xmount.cache.p_cache_header->pVdiFileHeader+file_off)
return -EIO;
}
LOG_DEBUG("Read %zd bytes from cached VDI header at offset %"
PRIu64 " at cache file offset %" PRIu64 "\n",
cur_to_read,
file_off,
glob_xmount.cache.p_cache_header->pVdiFileHeader+file_off)
} else {
// VDI header isn't cached
memcpy(p_buf,
((char*)glob_xmount.output.vdi.p_vdi_header)+file_off,
cur_to_read);
LOG_DEBUG("Read %zd bytes at offset %" PRIu64
" from virtual VDI header\n",cur_to_read,
file_off)
}
if(to_read==cur_to_read) return to_read;
else {
// Adjust values to read from morphed image
to_read-=cur_to_read;
p_buf+=cur_to_read;
file_off=0;
}
} else file_off-=glob_xmount.output.vdi.vdi_header_size;
break;
case VirtImageType_VHD:
// When emulating VHD, make sure the while loop below only reads data
// available in the morphed image. Any VHD footer data must be read
// afterwards.
if(file_off>=morphed_image_size) {
to_read_later=to_read;
to_read=0;
} else if((file_off+to_read)>morphed_image_size) {
to_read_later=(file_off+to_read)-morphed_image_size;
to_read-=to_read_later;
}
break;
}
// Calculate block to read data from
cur_block=file_off/CACHE_BLOCK_SIZE;
block_off=file_off%CACHE_BLOCK_SIZE;
// Read image data
while(to_read!=0) {
// Calculate how many bytes we have to read from this block
if(block_off+to_read>CACHE_BLOCK_SIZE) {
cur_to_read=CACHE_BLOCK_SIZE-block_off;
} else cur_to_read=to_read;
if(glob_xmount.output.writable==TRUE &&
glob_xmount.cache.p_cache_blkidx[cur_block].Assigned==TRUE)
{
// Write support enabled and need to read altered data from cachefile
if(fseeko(glob_xmount.cache.h_cache_file,
glob_xmount.cache.p_cache_blkidx[cur_block].off_data+block_off,
SEEK_SET)!=0)
{
LOG_ERROR("Couldn't seek to offset %" PRIu64
" in cache file\n")
return -EIO;
}
if(fread(p_buf,cur_to_read,1,glob_xmount.cache.h_cache_file)!=1) {
LOG_ERROR("Couldn't read data from cache file!\n")
return -EIO;
}
LOG_DEBUG("Read %zd bytes at offset %" PRIu64
" from cache file\n",cur_to_read,file_off)
} else {
// No write support or data not cached
ret=GetMorphedImageData(p_buf,file_off,cur_to_read,&read);
if(ret!=TRUE || read!=cur_to_read) {
LOG_ERROR("Couldn't read data from virtual image!\n")
return -EIO;
}
LOG_DEBUG("Read %zu bytes at offset %zu from virtual image file\n",
cur_to_read,
file_off);
}
cur_block++;
block_off=0;
p_buf+=cur_to_read;
to_read-=cur_to_read;
file_off+=cur_to_read;
}
if(to_read_later!=0) {
// Read virtual image type specific data following morphed image data
switch(glob_xmount.output.VirtImageType) {
case VirtImageType_DD:
case VirtImageType_DMG:
case VirtImageType_VMDK:
case VirtImageType_VMDKS:
case VirtImageType_VDI:
break;
case VirtImageType_VHD:
// Micro$oft has choosen to use a footer rather then a header.
if(glob_xmount.output.writable==TRUE &&
glob_xmount.cache.p_cache_header->VhdFileHeaderCached==TRUE)
{
// VHD footer was already cached
if(fseeko(glob_xmount.cache.h_cache_file,
glob_xmount.cache.p_cache_header->pVhdFileHeader+
(file_off-morphed_image_size),
SEEK_SET)!=0)
{
LOG_ERROR("Couldn't seek to cached VHD footer at offset %"
PRIu64 "\n",
glob_xmount.cache.p_cache_header->pVhdFileHeader+
(file_off-morphed_image_size))
return -EIO;
}
if(fread(p_buf,to_read_later,1,glob_xmount.cache.h_cache_file)!=1) {
LOG_ERROR("Couldn't read %zu bytes from cache file at offset %"
PRIu64 "\n",
to_read_later,
glob_xmount.cache.p_cache_header->pVhdFileHeader+
(file_off-morphed_image_size))
return -EIO;
}
LOG_DEBUG("Read %zd bytes from cached VHD footer at offset %"
PRIu64 " at cache file offset %" PRIu64 "\n",
to_read_later,
(file_off-morphed_image_size),
glob_xmount.cache.p_cache_header->pVhdFileHeader+
(file_off-morphed_image_size))
} else {
// VHD header isn't cached
memcpy(p_buf,
((char*)glob_xmount.output.vhd.p_vhd_header)+
(file_off-morphed_image_size),
to_read_later);
LOG_DEBUG("Read %zd bytes at offset %" PRIu64
" from virtual VHD header\n",
to_read_later,
(file_off-morphed_image_size))
}
break;
}
}
return size;
}
//! Write data to virtual VDI file header
/*!
* \param p_buf Buffer containing data to write
* \param offset Offset of changes
* \param size Amount of bytes to write
* \return Number of written bytes on success or "-1" on error
*/
static int SetVdiFileHeaderData(char *p_buf,off_t offset,size_t size) {
if(offset+size>glob_xmount.output.vdi.vdi_header_size) {
size=glob_xmount.output.vdi.vdi_header_size-offset;
}
LOG_DEBUG("Need to cache %zu bytes at offset %" PRIu64
" from VDI header\n",
size,
offset);
if(glob_xmount.cache.p_cache_header->VdiFileHeaderCached==1) {
// Header was already cached
if(fseeko(glob_xmount.cache.h_cache_file,
glob_xmount.cache.p_cache_header->pVdiFileHeader+offset,
SEEK_SET)!=0)
{
LOG_ERROR("Couldn't seek to cached VDI header at address %" PRIu64 "\n",
glob_xmount.cache.p_cache_header->pVdiFileHeader+offset)
return -1;
}
if(fwrite(p_buf,size,1,glob_xmount.cache.h_cache_file)!=1) {
LOG_ERROR("Couldn't write %zu bytes to cache file at offset %"
PRIu64 "\n",
size,
glob_xmount.cache.p_cache_header->pVdiFileHeader+offset)
return -1;
}
LOG_DEBUG("Wrote %zd bytes at offset %" PRIu64 " to cache file\n",
size,
glob_xmount.cache.p_cache_header->pVdiFileHeader+offset)
} else {
// Header wasn't already cached.
if(fseeko(glob_xmount.cache.h_cache_file,
0,
SEEK_END)!=0)
{
LOG_ERROR("Couldn't seek to end of cache file!")
return -1;
}
glob_xmount.cache.p_cache_header->pVdiFileHeader=
ftello(glob_xmount.cache.h_cache_file);
LOG_DEBUG("Caching whole VDI header\n")
if(offset>0) {
// Changes do not begin at offset 0, need to prepend with data from
// VDI header
if(fwrite((char*)glob_xmount.output.vdi.p_vdi_header,
offset,
1,
glob_xmount.cache.h_cache_file)!=1)
{
LOG_ERROR("Error while writing %" PRIu64 " bytes "
"to cache file at offset %" PRIu64 "!\n",
offset,
glob_xmount.cache.p_cache_header->pVdiFileHeader);
return -1;
}
LOG_DEBUG("Prepended changed data with %" PRIu64
" bytes at cache file offset %" PRIu64 "\n",
offset,
glob_xmount.cache.p_cache_header->pVdiFileHeader)
}
// Cache changed data
if(fwrite(p_buf,size,1,glob_xmount.cache.h_cache_file)!=1) {
LOG_ERROR("Couldn't write %zu bytes to cache file at offset %"
PRIu64 "\n",size,
glob_xmount.cache.p_cache_header->pVdiFileHeader+offset)
return -1;
}
LOG_DEBUG("Wrote %zu bytes of changed data to cache file offset %"
PRIu64 "\n",
size,
glob_xmount.cache.p_cache_header->pVdiFileHeader+offset)
if(offset+size!=glob_xmount.output.vdi.vdi_header_size) {
// Need to append data from VDI header to cache whole data struct
if(fwrite(((char*)glob_xmount.output.vdi.p_vdi_header)+offset+size,
glob_xmount.output.vdi.vdi_header_size-(offset+size),
1,
glob_xmount.cache.h_cache_file)!=1)
{
LOG_ERROR("Couldn't write %zu bytes to cache file at offset %"
PRIu64 "\n",
glob_xmount.output.vdi.vdi_header_size-(offset+size),
(uint64_t)(glob_xmount.cache.p_cache_header->pVdiFileHeader+
offset+size));
return -1;
}
LOG_DEBUG("Appended %" PRIu32
" bytes to changed data at cache file offset %" PRIu64 "\n",
glob_xmount.output.vdi.vdi_header_size-(offset+size),
glob_xmount.cache.p_cache_header->pVdiFileHeader+offset+size)
}
// Mark header as cached and update header in cache file
glob_xmount.cache.p_cache_header->VdiFileHeaderCached=1;
if(fseeko(glob_xmount.cache.h_cache_file,0,SEEK_SET)!=0) {
LOG_ERROR("Couldn't seek to offset 0 of cache file!\n")
return -1;
}
if(fwrite((char*)glob_xmount.cache.p_cache_header,
sizeof(ts_CacheFileHeader),
1,
glob_xmount.cache.h_cache_file)!=1)
{
LOG_ERROR("Couldn't write changed cache file header!\n")
return -1;
}
}
// All important data has been written, now flush all buffers to make
// sure data is written to cache file
fflush(glob_xmount.cache.h_cache_file);
#ifndef __APPLE__
ioctl(fileno(glob_xmount.cache.h_cache_file),BLKFLSBUF,0);
#endif
return size;
}
//! Write data to virtual VHD file footer
/*!
* \param p_buf Buffer containing data to write
* \param offset Offset of changes
* \param size Amount of bytes to write
* \return Number of written bytes on success or "-1" on error
*/
static int SetVhdFileHeaderData(char *p_buf,off_t offset,size_t size) {
LOG_DEBUG("Need to cache %zu bytes at offset %" PRIu64
" from VHD footer\n",size,offset)
if(glob_xmount.cache.p_cache_header->VhdFileHeaderCached==1) {
// Header has already been cached
if(fseeko(glob_xmount.cache.h_cache_file,
glob_xmount.cache.p_cache_header->pVhdFileHeader+offset,
SEEK_SET)!=0)
{
LOG_ERROR("Couldn't seek to cached VHD header at address %" PRIu64 "\n",
glob_xmount.cache.p_cache_header->pVhdFileHeader+offset);
return -1;
}
if(fwrite(p_buf,size,1,glob_xmount.cache.h_cache_file)!=1) {
LOG_ERROR("Couldn't write %zu bytes to cache file at offset %"
PRIu64 "\n",
size,
glob_xmount.cache.p_cache_header->pVhdFileHeader+offset);
return -1;
}
LOG_DEBUG("Wrote %zd bytes at offset %" PRIu64 " to cache file\n",
size,
glob_xmount.cache.p_cache_header->pVhdFileHeader+offset);
} else {
// Header hasn't been cached yet.
if(fseeko(glob_xmount.cache.h_cache_file,
0,
SEEK_END)!=0)
{
LOG_ERROR("Couldn't seek to end of cache file!")
return -1;
}
glob_xmount.cache.p_cache_header->pVhdFileHeader=
ftello(glob_xmount.cache.h_cache_file);
LOG_DEBUG("Caching whole VHD header\n")
if(offset>0) {
// Changes do not begin at offset 0, need to prepend with data from
// VHD header
if(fwrite((char*)glob_xmount.output.vhd.p_vhd_header,
offset,
1,
glob_xmount.cache.h_cache_file)!=1)
{
LOG_ERROR("Error while writing %" PRIu64 " bytes "
"to cache file at offset %" PRIu64 "!\n",
offset,
glob_xmount.cache.p_cache_header->pVhdFileHeader);
return -1;
}
LOG_DEBUG("Prepended changed data with %" PRIu64
" bytes at cache file offset %" PRIu64 "\n",
offset,
glob_xmount.cache.p_cache_header->pVhdFileHeader);
}
// Cache changed data
if(fwrite(p_buf,size,1,glob_xmount.cache.h_cache_file)!=1) {
LOG_ERROR("Couldn't write %zu bytes to cache file at offset %"
PRIu64 "\n",
size,
glob_xmount.cache.p_cache_header->pVhdFileHeader+offset);
return -1;
}
LOG_DEBUG("Wrote %zu bytes of changed data to cache file offset %"
PRIu64 "\n",
size,
glob_xmount.cache.p_cache_header->pVhdFileHeader+offset);
if(offset+size!=sizeof(ts_VhdFileHeader)) {
// Need to append data from VHD header to cache whole data struct
if(fwrite(((char*)glob_xmount.output.vhd.p_vhd_header)+offset+size,
sizeof(ts_VhdFileHeader)-(offset+size),
1,
glob_xmount.cache.h_cache_file)!=1)
{
LOG_ERROR("Couldn't write %zu bytes to cache file at offset %"
PRIu64 "\n",
sizeof(ts_VhdFileHeader)-(offset+size),
(uint64_t)(glob_xmount.cache.p_cache_header->pVhdFileHeader+
offset+size))
return -1;
}
LOG_DEBUG("Appended %" PRIu32
" bytes to changed data at cache file offset %" PRIu64 "\n",
sizeof(ts_VhdFileHeader)-(offset+size),
glob_xmount.cache.p_cache_header->pVhdFileHeader+offset+size);
}
// Mark header as cached and update header in cache file
glob_xmount.cache.p_cache_header->VhdFileHeaderCached=1;
if(fseeko(glob_xmount.cache.h_cache_file,0,SEEK_SET)!=0) {
LOG_ERROR("Couldn't seek to offset 0 of cache file!\n")
return -1;
}
if(fwrite((char*)glob_xmount.cache.p_cache_header,
sizeof(ts_CacheFileHeader),
1,
glob_xmount.cache.h_cache_file)!=1)
{
LOG_ERROR("Couldn't write changed cache file header!\n")
return -1;
}
}
// All important data has been written, now flush all buffers to make
// sure data is written to cache file
fflush(glob_xmount.cache.h_cache_file);
#ifndef __APPLE__
ioctl(fileno(glob_xmount.cache.h_cache_file),BLKFLSBUF,0);
#endif
return size;
}
//! Write data to virtual image
/*!
* \param p_buf Buffer containing data to write
* \param offset Offset to start writing at
* \param size Size of data to be written
* \return Number of written bytes on success or "-1" on error
*/
static int SetVirtImageData(const char *p_buf, off_t offset, size_t size) {
uint64_t cur_block=0;
uint64_t virt_image_size;
uint64_t orig_image_size;
size_t to_write=0;
size_t to_write_later=0;
size_t to_write_now=0;
off_t file_offset=offset;
off_t block_offset=0;
char *p_write_buf=(char*)p_buf;
char *p_buf2;
int ret;
size_t read;
// Get virtual image size
if(!GetVirtImageSize(&virt_image_size)) {
LOG_ERROR("Couldn't get virtual image size!\n")
return -1;
}
if(offset>=virt_image_size) {
LOG_ERROR("Attempt to write beyond EOF of virtual image file!\n")
return -1;
}
if(offset+size>virt_image_size) {
LOG_DEBUG("Attempt to write past EOF of virtual image file\n")
size=virt_image_size-offset;
}
to_write=size;
// Get original image size
if(!GetMorphedImageSize(&orig_image_size)) {
LOG_ERROR("Couldn't get morphed image size!\n")
return -1;
}
// Cache virtual image type specific data preceeding original image data
switch(glob_xmount.output.VirtImageType) {
case VirtImageType_DD:
case VirtImageType_DMG:
case VirtImageType_VMDK:
case VirtImageType_VMDKS:
break;
case VirtImageType_VDI:
if(file_offset<glob_xmount.output.vdi.vdi_header_size) {
ret=SetVdiFileHeaderData(p_write_buf,file_offset,to_write);
if(ret==-1) {
LOG_ERROR("Couldn't write data to virtual VDI file header!\n")
return -1;
}
if(ret==to_write) return to_write;
else {
to_write-=ret;
p_write_buf+=ret;
file_offset=0;
}
} else file_offset-=glob_xmount.output.vdi.vdi_header_size;
break;
case VirtImageType_VHD:
// When emulating VHD, make sure the while loop below only writes data
// available in the original image. Any VHD footer data must be written
// afterwards.
if(file_offset>=orig_image_size) {
to_write_later=to_write;
to_write=0;
} else if((file_offset+to_write)>orig_image_size) {
to_write_later=(file_offset+to_write)-orig_image_size;
to_write-=to_write_later;
}
break;
}
// Calculate block to write data to
cur_block=file_offset/CACHE_BLOCK_SIZE;
block_offset=file_offset%CACHE_BLOCK_SIZE;
while(to_write!=0) {
// Calculate how many bytes we have to write to this block
if(block_offset+to_write>CACHE_BLOCK_SIZE) {
to_write_now=CACHE_BLOCK_SIZE-block_offset;
} else to_write_now=to_write;
if(glob_xmount.cache.p_cache_blkidx[cur_block].Assigned==1) {
// Block was already cached
// Seek to data offset in cache file
if(fseeko(glob_xmount.cache.h_cache_file,
glob_xmount.cache.p_cache_blkidx[cur_block].off_data+block_offset,
SEEK_SET)!=0)
{
LOG_ERROR("Couldn't seek to cached block at address %" PRIu64 "\n",
glob_xmount.cache.p_cache_blkidx[cur_block].off_data+
block_offset);
return -1;
}
if(fwrite(p_write_buf,to_write_now,1,glob_xmount.cache.h_cache_file)!=1) {
LOG_ERROR("Error while writing %zu bytes "
"to cache file at offset %" PRIu64 "!\n",
to_write_now,
glob_xmount.cache.p_cache_blkidx[cur_block].off_data+
block_offset);
return -1;
}
LOG_DEBUG("Wrote %zd bytes at offset %" PRIu64
" to cache file\n",to_write_now,
glob_xmount.cache.p_cache_blkidx[cur_block].off_data+
block_offset);
} else {
// Uncached block. Need to cache entire new block
// Seek to end of cache file to append new cache block
fseeko(glob_xmount.cache.h_cache_file,0,SEEK_END);
glob_xmount.cache.p_cache_blkidx[cur_block].off_data=
ftello(glob_xmount.cache.h_cache_file);
if(block_offset!=0) {
// Changed data does not begin at block boundry. Need to prepend
// with data from virtual image file
XMOUNT_MALLOC(p_buf2,char*,block_offset*sizeof(char));
ret=GetMorphedImageData(p_buf2,
file_offset-block_offset,
block_offset,
&read);
if(ret!=TRUE || read!=block_offset) {
LOG_ERROR("Couldn't read data from morphed image!\n")
return -1;
}
if(fwrite(p_buf2,block_offset,1,glob_xmount.cache.h_cache_file)!=1) {
LOG_ERROR("Couldn't writing %" PRIu64 " bytes "
"to cache file at offset %" PRIu64 "!\n",
block_offset,
glob_xmount.cache.p_cache_blkidx[cur_block].off_data);
return -1;
}
LOG_DEBUG("Prepended changed data with %" PRIu64
" bytes from virtual image file at offset %" PRIu64
"\n",block_offset,file_offset-block_offset)
free(p_buf2);
}
if(fwrite(p_write_buf,to_write_now,1,glob_xmount.cache.h_cache_file)!=1) {
LOG_ERROR("Error while writing %zd bytes "
"to cache file at offset %" PRIu64 "!\n",
to_write_now,
glob_xmount.cache.p_cache_blkidx[cur_block].off_data+
block_offset);
return -1;
}
if(block_offset+to_write_now!=CACHE_BLOCK_SIZE) {
// Changed data does not end at block boundry. Need to append
// with data from virtual image file
XMOUNT_MALLOC(p_buf2,char*,(CACHE_BLOCK_SIZE-
(block_offset+to_write_now))*sizeof(char))
memset(p_buf2,0,CACHE_BLOCK_SIZE-(block_offset+to_write_now));
if((file_offset-block_offset)+CACHE_BLOCK_SIZE>orig_image_size) {
// Original image is smaller than full cache block
ret=GetMorphedImageData(p_buf2,
file_offset+to_write_now,
orig_image_size-(file_offset+to_write_now),
&read);
if(ret!=TRUE || read!=orig_image_size-(file_offset+to_write_now)) {
LOG_ERROR("Couldn't read data from virtual image file!\n")
return -1;
}
} else {
ret=GetMorphedImageData(p_buf2,
file_offset+to_write_now,
CACHE_BLOCK_SIZE-(block_offset+to_write_now),
&read);
if(ret!=TRUE || read!=CACHE_BLOCK_SIZE-(block_offset+to_write_now)) {
LOG_ERROR("Couldn't read data from virtual image file!\n")
return -1;
}
}
if(fwrite(p_buf2,
CACHE_BLOCK_SIZE-(block_offset+to_write_now),
1,
glob_xmount.cache.h_cache_file)!=1)
{
LOG_ERROR("Error while writing %zd bytes "
"to cache file at offset %" PRIu64 "!\n",
CACHE_BLOCK_SIZE-(block_offset+to_write_now),
glob_xmount.cache.p_cache_blkidx[cur_block].off_data+
block_offset+to_write_now);
return -1;
}
free(p_buf2);
}
// All important data for this cache block has been written,
// flush all buffers and mark cache block as assigned
fflush(glob_xmount.cache.h_cache_file);
#ifndef __APPLE__
ioctl(fileno(glob_xmount.cache.h_cache_file),BLKFLSBUF,0);
#endif
glob_xmount.cache.p_cache_blkidx[cur_block].Assigned=1;
// Update cache block index entry in cache file
fseeko(glob_xmount.cache.h_cache_file,
sizeof(ts_CacheFileHeader)+
(cur_block*sizeof(ts_CacheFileBlockIndex)),
SEEK_SET);
if(fwrite(&(glob_xmount.cache.p_cache_blkidx[cur_block]),
sizeof(ts_CacheFileBlockIndex),
1,
glob_xmount.cache.h_cache_file)!=1)
{
LOG_ERROR("Couldn't update cache file block index!\n");
return -1;
}
LOG_DEBUG("Updated cache file block index: Number=%" PRIu64
", Data offset=%" PRIu64 "\n",
cur_block,
glob_xmount.cache.p_cache_blkidx[cur_block].off_data);
}
// Flush buffers
fflush(glob_xmount.cache.h_cache_file);
#ifndef __APPLE__
ioctl(fileno(glob_xmount.cache.h_cache_file),BLKFLSBUF,0);
#endif
block_offset=0;
cur_block++;
p_write_buf+=to_write_now;
to_write-=to_write_now;
file_offset+=to_write_now;
}
if(to_write_later!=0) {
// Cache virtual image type specific data preceeding original image data
switch(glob_xmount.output.VirtImageType) {
case VirtImageType_DD:
case VirtImageType_DMG:
case VirtImageType_VMDK:
case VirtImageType_VMDKS:
case VirtImageType_VDI:
break;
case VirtImageType_VHD:
// Micro$oft has choosen to use a footer rather then a header.
ret=SetVhdFileHeaderData(p_write_buf,
file_offset-orig_image_size,
to_write_later);
if(ret==-1) {
LOG_ERROR("Couldn't write data to virtual VHD file footer!\n")
return -1;
}
break;
}
}
return size;
}
//! Calculates an MD5 hash of the first HASH_AMOUNT bytes of the input image
/*!
* \param p_hash_low Pointer to the lower 64 bit of the hash
* \param p_hash_high Pointer to the higher 64 bit of the hash
* \return TRUE on success, FALSE on error
*/
static int CalculateInputImageHash(uint64_t *p_hash_low,
uint64_t *p_hash_high)
{
char hash[16];
md5_state_t md5_state;
char *p_buf;
int ret;
size_t read_data;
XMOUNT_MALLOC(p_buf,char*,HASH_AMOUNT*sizeof(char));
ret=GetMorphedImageData(p_buf,0,HASH_AMOUNT,&read_data);
if(ret!=TRUE || read_data==0) {
LOG_ERROR("Couldn't read data from morphed image file!\n")
free(p_buf);
return FALSE;
}
// Calculate MD5 hash
md5_init(&md5_state);
md5_append(&md5_state,(const md5_byte_t*)p_buf,read_data);
md5_finish(&md5_state,(md5_byte_t*)hash);
// Convert MD5 hash into two 64bit integers
*p_hash_low=*((uint64_t*)hash);
*p_hash_high=*((uint64_t*)(hash+8));
free(p_buf);
return TRUE;
}
//! Build and init virtual VDI file header
/*!
* \return TRUE on success, FALSE on error
*/
static int InitVirtVdiHeader() {
// See http://forums.virtualbox.org/viewtopic.php?t=8046 for a
// "description" of the various header fields
uint64_t image_size;
off_t offset;
uint32_t i,block_entries;
// Get input image size
if(!GetMorphedImageSize(&image_size)) {
LOG_ERROR("Couldn't get morphed image size!\n")
return FALSE;
}
// Calculate how many VDI blocks we need
block_entries=image_size/VDI_IMAGE_BLOCK_SIZE;
if((image_size%VDI_IMAGE_BLOCK_SIZE)!=0) block_entries++;
glob_xmount.output.vdi.vdi_block_map_size=block_entries*sizeof(uint32_t);
LOG_DEBUG("BlockMap: %d (%08X) entries, %d (%08X) bytes!\n",
block_entries,
block_entries,
glob_xmount.output.vdi.vdi_block_map_size,
glob_xmount.output.vdi.vdi_block_map_size)
// Allocate memory for vdi header and block map
glob_xmount.output.vdi.vdi_header_size=
sizeof(ts_VdiFileHeader)+glob_xmount.output.vdi.vdi_block_map_size;
XMOUNT_MALLOC(glob_xmount.output.vdi.p_vdi_header,
pts_VdiFileHeader,
glob_xmount.output.vdi.vdi_header_size);
memset(glob_xmount.output.vdi.p_vdi_header,
0,
glob_xmount.output.vdi.vdi_header_size);
glob_xmount.output.vdi.p_vdi_block_map=
((void*)glob_xmount.output.vdi.p_vdi_header)+sizeof(ts_VdiFileHeader);
// Init header values
strncpy(glob_xmount.output.vdi.p_vdi_header->szFileInfo,
VDI_FILE_COMMENT,
strlen(VDI_FILE_COMMENT)+1);
glob_xmount.output.vdi.p_vdi_header->u32Signature=VDI_IMAGE_SIGNATURE;
glob_xmount.output.vdi.p_vdi_header->u32Version=VDI_IMAGE_VERSION;
// No idea what the following value is for! Testimage had same value
glob_xmount.output.vdi.p_vdi_header->cbHeader=0x00000180;
glob_xmount.output.vdi.p_vdi_header->u32Type=VDI_IMAGE_TYPE_FIXED;
glob_xmount.output.vdi.p_vdi_header->fFlags=VDI_IMAGE_FLAGS;
strncpy(glob_xmount.output.vdi.p_vdi_header->szComment,
VDI_HEADER_COMMENT,
strlen(VDI_HEADER_COMMENT)+1);
glob_xmount.output.vdi.p_vdi_header->offData=
glob_xmount.output.vdi.vdi_header_size;
glob_xmount.output.vdi.p_vdi_header->offBlocks=sizeof(ts_VdiFileHeader);
glob_xmount.output.vdi.p_vdi_header->cCylinders=0; // Legacy info
glob_xmount.output.vdi.p_vdi_header->cHeads=0; // Legacy info
glob_xmount.output.vdi.p_vdi_header->cSectors=0; // Legacy info
glob_xmount.output.vdi.p_vdi_header->cbSector=512; // Legacy info
glob_xmount.output.vdi.p_vdi_header->u32Dummy=0;
glob_xmount.output.vdi.p_vdi_header->cbDisk=image_size;
// Seems as VBox is always using a 1MB blocksize
glob_xmount.output.vdi.p_vdi_header->cbBlock=VDI_IMAGE_BLOCK_SIZE;
glob_xmount.output.vdi.p_vdi_header->cbBlockExtra=0;
glob_xmount.output.vdi.p_vdi_header->cBlocks=block_entries;
glob_xmount.output.vdi.p_vdi_header->cBlocksAllocated=block_entries;
// Use partial MD5 input file hash as creation UUID and generate a random
// modification UUID. VBox won't accept immages where create and modify UUIDS
// aren't set.
glob_xmount.output.vdi.p_vdi_header->uuidCreate_l=
glob_xmount.input.image_hash_lo;
glob_xmount.output.vdi.p_vdi_header->uuidCreate_h=
glob_xmount.input.image_hash_hi;
#define rand64(var) { \
*((uint32_t*)&(var))=rand(); \
*(((uint32_t*)&(var))+1)=rand(); \
}
rand64(glob_xmount.output.vdi.p_vdi_header->uuidModify_l);
rand64(glob_xmount.output.vdi.p_vdi_header->uuidModify_h);
#undef rand64
// Generate block map
i=0;
for(offset=0;offset<glob_xmount.output.vdi.vdi_block_map_size;offset+=4) {
*((uint32_t*)(glob_xmount.output.vdi.p_vdi_block_map+offset))=i;
i++;
}
LOG_DEBUG("VDI header size = %u\n",glob_xmount.output.vdi.vdi_header_size);
return TRUE;
}
//! Build and init virtual VHD file header
/*!
* \return TRUE on success, FALSE on error
*/
static int InitVirtVhdHeader() {
uint64_t orig_image_size=0;
uint16_t i=0;
uint64_t geom_tot_s=0;
uint64_t geom_c_x_h=0;
uint16_t geom_c=0;
uint8_t geom_h=0;
uint8_t geom_s=0;
uint32_t checksum=0;
// Get input image size
if(!GetMorphedImageSize(&orig_image_size)) {
LOG_ERROR("Couldn't get morphed image size!\n")
return FALSE;
}
// Allocate memory for vhd header
XMOUNT_MALLOC(glob_xmount.output.vhd.p_vhd_header,
pts_VhdFileHeader,
sizeof(ts_VhdFileHeader));
memset(glob_xmount.output.vhd.p_vhd_header,0,sizeof(ts_VhdFileHeader));
// Init header values
glob_xmount.output.vhd.p_vhd_header->cookie=VHD_IMAGE_HVAL_COOKIE;
glob_xmount.output.vhd.p_vhd_header->features=VHD_IMAGE_HVAL_FEATURES;
glob_xmount.output.vhd.p_vhd_header->file_format_version=
VHD_IMAGE_HVAL_FILE_FORMAT_VERSION;
glob_xmount.output.vhd.p_vhd_header->data_offset=VHD_IMAGE_HVAL_DATA_OFFSET;
glob_xmount.output.vhd.p_vhd_header->creation_time=
htobe32(time(NULL)-VHD_IMAGE_TIME_CONVERSION_OFFSET);
glob_xmount.output.vhd.p_vhd_header->creator_app=
VHD_IMAGE_HVAL_CREATOR_APPLICATION;
glob_xmount.output.vhd.p_vhd_header->creator_ver=
VHD_IMAGE_HVAL_CREATOR_VERSION;
glob_xmount.output.vhd.p_vhd_header->creator_os=
VHD_IMAGE_HVAL_CREATOR_HOST_OS;
glob_xmount.output.vhd.p_vhd_header->size_original=htobe64(orig_image_size);
glob_xmount.output.vhd.p_vhd_header->size_current=
glob_xmount.output.vhd.p_vhd_header->size_original;
// Convert size to sectors
if(orig_image_size>136899993600) {
// image is larger then CHS values can address.
// Set sectors to max (C65535*H16*S255).
geom_tot_s=267382800;
} else {
// Calculate actual sectors
geom_tot_s=orig_image_size/512;
if((orig_image_size%512)!=0) geom_tot_s++;
}
// Calculate CHS values. This is done according to the VHD specs
if(geom_tot_s>=66059280) { // C65535 * H16 * S63
geom_s=255;
geom_h=16;
geom_c_x_h=geom_tot_s/geom_s;
} else {
geom_s=17;
geom_c_x_h=geom_tot_s/geom_s;
geom_h=(geom_c_x_h+1023)/1024;
if(geom_h<4) geom_h=4;
if(geom_c_x_h>=(geom_h*1024) || geom_h>16) {
geom_s=31;
geom_h=16;
geom_c_x_h=geom_tot_s/geom_s;
}
if(geom_c_x_h>=(geom_h*1024)) {
geom_s=63;
geom_h=16;
geom_c_x_h=geom_tot_s/geom_s;
}
}
geom_c=geom_c_x_h/geom_h;
glob_xmount.output.vhd.p_vhd_header->disk_geometry_c=htobe16(geom_c);
glob_xmount.output.vhd.p_vhd_header->disk_geometry_h=geom_h;
glob_xmount.output.vhd.p_vhd_header->disk_geometry_s=geom_s;
glob_xmount.output.vhd.p_vhd_header->disk_type=VHD_IMAGE_HVAL_DISK_TYPE;
glob_xmount.output.vhd.p_vhd_header->uuid_l=glob_xmount.input.image_hash_lo;
glob_xmount.output.vhd.p_vhd_header->uuid_h=glob_xmount.input.image_hash_hi;
glob_xmount.output.vhd.p_vhd_header->saved_state=0x00;
// Calculate footer checksum
for(i=0;i<sizeof(ts_VhdFileHeader);i++) {
checksum+=*((uint8_t*)(glob_xmount.output.vhd.p_vhd_header)+i);
}
glob_xmount.output.vhd.p_vhd_header->checksum=htobe32(~checksum);
LOG_DEBUG("VHD header size = %u\n",sizeof(ts_VhdFileHeader));
return TRUE;
}
//! Init the virtual VMDK file
/*!
* \return TRUE on success, FALSE on error
*/
static int InitVirtualVmdkFile() {
uint64_t image_size=0;
uint64_t image_blocks=0;
char buf[500];
// Get original image size
if(!GetMorphedImageSize(&image_size)) {
LOG_ERROR("Couldn't get morphed image size!\n")
return FALSE;
}
image_blocks=image_size/512;
if(image_size%512!=0) image_blocks++;
#define VMDK_DESC_FILE "# Disk DescriptorFile\n" \
"version=1\n" \
"CID=fffffffe\n" \
"parentCID=ffffffff\n" \
"createType=\"monolithicFlat\"\n\n" \
"# Extent description\n" \
"RW %" PRIu64 " FLAT \"%s\" 0\n\n" \
"# The Disk Data Base\n" \
"#DDB\n" \
"ddb.virtualHWVersion = \"3\"\n" \
"ddb.adapterType = \"%s\"\n" \
"ddb.geometry.cylinders = \"0\"\n" \
"ddb.geometry.heads = \"0\"\n" \
"ddb.geometry.sectors = \"0\"\n"
if(glob_xmount.output.VirtImageType==VirtImageType_VMDK) {
// VMDK with IDE bus
sprintf(buf,
VMDK_DESC_FILE,
image_blocks,
(glob_xmount.output.p_virtual_image_path)+1,
"ide");
} else if(glob_xmount.output.VirtImageType==VirtImageType_VMDKS){
// VMDK with SCSI bus
sprintf(buf,
VMDK_DESC_FILE,
image_blocks,
(glob_xmount.output.p_virtual_image_path)+1,
"scsi");
} else {
LOG_ERROR("Unknown virtual VMDK file format!\n")
return FALSE;
}
#undef VMDK_DESC_FILE
// Do not use XMOUNT_STRSET here to avoid adding '\0' to the buffer!
XMOUNT_MALLOC(glob_xmount.output.vmdk.p_vmdk_file,char*,strlen(buf))
strncpy(glob_xmount.output.vmdk.p_vmdk_file,buf,strlen(buf));
glob_xmount.output.vmdk.vmdk_file_size=strlen(buf);
return TRUE;
}
//! Create virtual image info file
/*!
* \return TRUE on success, FALSE on error
*/
static int InitVirtImageInfoFile() {
int ret;
char *p_buf;
// Start with static input header
XMOUNT_MALLOC(glob_xmount.output.p_info_file,
char*,
strlen(IMAGE_INFO_INPUT_HEADER)+1);
strncpy(glob_xmount.output.p_info_file,
IMAGE_INFO_INPUT_HEADER,
strlen(IMAGE_INFO_INPUT_HEADER)+1);
// Get and add infos from input lib(s)
for(uint64_t i=0;i<glob_xmount.input.images_count;i++) {
ret=glob_xmount.input.pp_images[i]->p_functions->
GetInfofileContent(glob_xmount.input.pp_images[i]->p_handle,(const char**)&p_buf);
if(ret!=0) {
LOG_ERROR("Unable to get info file content for image '%s': %s!\n",
glob_xmount.input.pp_images[i]->pp_files[0],
glob_xmount.input.pp_images[i]->p_functions->
GetErrorMessage(ret));
return FALSE;
}
// Add infos to main buffer and free p_buf
XMOUNT_STRAPP(glob_xmount.output.p_info_file,"\n--> ");
XMOUNT_STRAPP(glob_xmount.output.p_info_file,
glob_xmount.input.pp_images[i]->pp_files[0]);
XMOUNT_STRAPP(glob_xmount.output.p_info_file," <--\n");
if(p_buf!=NULL) {
XMOUNT_STRAPP(glob_xmount.output.p_info_file,p_buf);
glob_xmount.input.pp_images[i]->p_functions->FreeBuffer(p_buf);
} else {
XMOUNT_STRAPP(glob_xmount.output.p_info_file,"None\n");
}
}
// Add static morphing header
XMOUNT_STRAPP(glob_xmount.output.p_info_file,IMAGE_INFO_MORPHING_HEADER);
// Get and add infos from morphing lib
ret=glob_xmount.morphing.p_functions->
GetInfofileContent(glob_xmount.morphing.p_handle,(const char**)&p_buf);
if(ret!=0) {
LOG_ERROR("Unable to get info file content from morphing lib: %s!\n",
glob_xmount.morphing.p_functions->GetErrorMessage(ret));
return FALSE;
}
if(p_buf!=NULL) {
XMOUNT_STRAPP(glob_xmount.output.p_info_file,p_buf);
glob_xmount.morphing.p_functions->FreeBuffer(p_buf);
} else {
XMOUNT_STRAPP(glob_xmount.output.p_info_file,"None\n");
}
return TRUE;
}
//! Create / load cache file to enable virtual write support
/*!
* \return TRUE on success, FALSE on error
*/
static int InitCacheFile() {
uint64_t image_size=0;
uint64_t blockindex_size=0;
uint64_t cachefile_header_size=0;
uint64_t cachefile_size=0;
uint32_t needed_blocks=0;
uint64_t buf;
if(!glob_xmount.cache.overwrite_cache) {
// Try to open an existing cache file or create a new one
glob_xmount.cache.h_cache_file=(FILE*)FOPEN(glob_xmount.cache.p_cache_file,
"rb+");
if(glob_xmount.cache.h_cache_file==NULL) {
// As the c lib seems to have no possibility to open a file rw wether it
// exists or not (w+ does not work because it truncates an existing file),
// when r+ returns NULL the file could simply not exist
LOG_DEBUG("Cache file does not exist. Creating new one\n")
glob_xmount.cache.h_cache_file=
(FILE*)FOPEN(glob_xmount.cache.p_cache_file,"wb+");
if(glob_xmount.cache.h_cache_file==NULL) {
// There is really a problem opening the file
LOG_ERROR("Couldn't open cache file \"%s\"!\n",
glob_xmount.cache.p_cache_file)
return FALSE;
}
}
} else {
// Overwrite existing cache file or create a new one
glob_xmount.cache.h_cache_file=(FILE*)FOPEN(glob_xmount.cache.p_cache_file,
"wb+");
if(glob_xmount.cache.h_cache_file==NULL) {
LOG_ERROR("Couldn't open cache file \"%s\"!\n",
glob_xmount.cache.p_cache_file)
return FALSE;
}
}
// Get input image size
if(!GetMorphedImageSize(&image_size)) {
LOG_ERROR("Couldn't get morphed image size!\n")
return FALSE;
}
// Calculate how many blocks are needed and how big the buffers must be
// for the actual cache file version
needed_blocks=image_size/CACHE_BLOCK_SIZE;
if((image_size%CACHE_BLOCK_SIZE)!=0) needed_blocks++;
blockindex_size=needed_blocks*sizeof(ts_CacheFileBlockIndex);
cachefile_header_size=sizeof(ts_CacheFileHeader)+blockindex_size;
LOG_DEBUG("Cache blocks: %u (%04X) entries, %zd (%08zX) bytes\n",
needed_blocks,
needed_blocks,
blockindex_size,
blockindex_size)
// Get cache file size
// fseeko64 had massive problems!
if(fseeko(glob_xmount.cache.h_cache_file,0,SEEK_END)!=0) {
LOG_ERROR("Couldn't seek to end of cache file!\n")
return FALSE;
}
// Same here, ftello64 didn't work at all and returned 0 all the times
cachefile_size=ftello(glob_xmount.cache.h_cache_file);
LOG_DEBUG("Cache file has %zd bytes\n",cachefile_size)
if(cachefile_size>0) {
// Cache file isn't empty, parse block header
LOG_DEBUG("Cache file not empty. Parsing block header\n")
if(fseeko(glob_xmount.cache.h_cache_file,0,SEEK_SET)!=0) {
LOG_ERROR("Couldn't seek to beginning of cache file!\n")
return FALSE;
}
// Read and check file signature
if(fread(&buf,8,1,glob_xmount.cache.h_cache_file)!=1 ||
buf!=CACHE_FILE_SIGNATURE)
{
LOG_ERROR("Not an xmount cache file or cache file corrupt!\n")
return FALSE;
}
// Now get cache file version (Has only 32bit!)
if(fread(&buf,4,1,glob_xmount.cache.h_cache_file)!=1) {
LOG_ERROR("Not an xmount cache file or cache file corrupt!\n")
return FALSE;
}
switch((uint32_t)buf) {
case 0x00000001:
// Old v1 cache file.
LOG_ERROR("Unsupported cache file version!\n")
LOG_ERROR("Please use xmount-tool to upgrade your cache file.\n")
return FALSE;
case CUR_CACHE_FILE_VERSION:
// Current version
if(fseeko(glob_xmount.cache.h_cache_file,0,SEEK_SET)!=0) {
LOG_ERROR("Couldn't seek to beginning of cache file!\n")
return FALSE;
}
// Alloc memory for header and block index
XMOUNT_MALLOC(glob_xmount.cache.p_cache_header,
pts_CacheFileHeader,
cachefile_header_size);
memset(glob_xmount.cache.p_cache_header,0,cachefile_header_size);
// Read header and block index from file
if(fread(glob_xmount.cache.p_cache_header,
cachefile_header_size,
1,
glob_xmount.cache.h_cache_file)!=1)
{
// Cache file isn't big enough
LOG_ERROR("Cache file corrupt!\n")
return FALSE;
}
break;
default:
LOG_ERROR("Unknown cache file version!\n")
return FALSE;
}
// Check if cache file has same block size as we do
if(glob_xmount.cache.p_cache_header->BlockSize!=CACHE_BLOCK_SIZE) {
LOG_ERROR("Cache file does not use default cache block size!\n")
return FALSE;
}
// Set pointer to block index
glob_xmount.cache.p_cache_blkidx=
(pts_CacheFileBlockIndex)((void*)glob_xmount.cache.p_cache_header+
glob_xmount.cache.p_cache_header->pBlockIndex);
} else {
// New cache file, generate a new block header
LOG_DEBUG("Cache file is empty. Generating new block header\n");
// Alloc memory for header and block index
XMOUNT_MALLOC(glob_xmount.cache.p_cache_header,
pts_CacheFileHeader,
cachefile_header_size)
memset(glob_xmount.cache.p_cache_header,0,cachefile_header_size);
glob_xmount.cache.p_cache_header->FileSignature=CACHE_FILE_SIGNATURE;
glob_xmount.cache.p_cache_header->CacheFileVersion=CUR_CACHE_FILE_VERSION;
glob_xmount.cache.p_cache_header->BlockSize=CACHE_BLOCK_SIZE;
glob_xmount.cache.p_cache_header->BlockCount=needed_blocks;
//glob_xmount.cache.p_cache_header->UsedBlocks=0;
// The following pointer is only usuable when reading data from cache file
glob_xmount.cache.p_cache_header->pBlockIndex=sizeof(ts_CacheFileHeader);
glob_xmount.cache.p_cache_blkidx=
(pts_CacheFileBlockIndex)((void*)glob_xmount.cache.p_cache_header+
sizeof(ts_CacheFileHeader));
glob_xmount.cache.p_cache_header->VdiFileHeaderCached=FALSE;
glob_xmount.cache.p_cache_header->pVdiFileHeader=0;
glob_xmount.cache.p_cache_header->VmdkFileCached=FALSE;
glob_xmount.cache.p_cache_header->VmdkFileSize=0;
glob_xmount.cache.p_cache_header->pVmdkFile=0;
glob_xmount.cache.p_cache_header->VhdFileHeaderCached=FALSE;
glob_xmount.cache.p_cache_header->pVhdFileHeader=0;
// Write header to file
if(fwrite(glob_xmount.cache.p_cache_header,
cachefile_header_size,
1,
glob_xmount.cache.h_cache_file)!=1)
{
LOG_ERROR("Couldn't write cache file header to file!\n");
return FALSE;
}
}
return TRUE;
}
//! Load input / morphing libs
/*!
* \return TRUE on success, FALSE on error
*/
static int LoadLibs() {
DIR *p_dir=NULL;
struct dirent *p_dirent=NULL;
int base_library_path_len=0;
char *p_library_path=NULL;
void *p_libxmount=NULL;
t_LibXmount_Input_GetApiVersion pfun_input_GetApiVersion;
t_LibXmount_Input_GetSupportedFormats pfun_input_GetSupportedFormats;
t_LibXmount_Input_GetFunctions pfun_input_GetFunctions;
t_LibXmount_Morphing_GetApiVersion pfun_morphing_GetApiVersion;
t_LibXmount_Morphing_GetSupportedTypes pfun_morphing_GetSupportedTypes;
t_LibXmount_Morphing_GetFunctions pfun_morphing_GetFunctions;
const char *p_supported_formats=NULL;
const char *p_buf;
uint32_t supported_formats_len=0;
pts_InputLib p_input_lib=NULL;
pts_MorphingLib p_morphing_lib=NULL;
LOG_DEBUG("Searching for xmount libraries in '%s'.\n",
XMOUNT_LIBRARY_PATH);
// Open lib dir
p_dir=opendir(XMOUNT_LIBRARY_PATH);
if(p_dir==NULL) {
LOG_ERROR("Unable to access xmount library directory '%s'!\n",
XMOUNT_LIBRARY_PATH);
return FALSE;
}
// Construct base library path
base_library_path_len=strlen(XMOUNT_LIBRARY_PATH);
XMOUNT_STRSET(p_library_path,XMOUNT_LIBRARY_PATH);
if(XMOUNT_LIBRARY_PATH[base_library_path_len]!='/') {
base_library_path_len++;
XMOUNT_STRAPP(p_library_path,"/");
}
#define LIBXMOUNT_LOAD(path) { \
p_libxmount=dlopen(path,RTLD_NOW); \
if(p_libxmount==NULL) { \
LOG_ERROR("Unable to load input library '%s': %s!\n", \
path, \
dlerror()); \
continue; \
} \
}
#define LIBXMOUNT_LOAD_SYMBOL(name,pfun) { \
if((pfun=dlsym(p_libxmount,name))==NULL) { \
LOG_ERROR("Unable to load symbol '%s' from library '%s'!\n", \
name, \
p_library_path); \
dlclose(p_libxmount); \
p_libxmount=NULL; \
continue; \
} \
}
// Loop over lib dir
while((p_dirent=readdir(p_dir))!=NULL) {
LOG_DEBUG("Trying to load '%s'\n",p_dirent->d_name);
// Construct full path to found object
p_library_path=realloc(p_library_path,
base_library_path_len+strlen(p_dirent->d_name)+1);
if(p_library_path==NULL) {
LOG_ERROR("Couldn't allocate memory!\n");
exit(1);
}
strcpy(p_library_path+base_library_path_len,p_dirent->d_name);
if(strncmp(p_dirent->d_name,"libxmount_input_",16)==0) {
// Found possible input lib. Try to load it
LIBXMOUNT_LOAD(p_library_path);
// Load library symbols
LIBXMOUNT_LOAD_SYMBOL("LibXmount_Input_GetApiVersion",
pfun_input_GetApiVersion);
// Check library's API version
if(pfun_input_GetApiVersion()!=LIBXMOUNT_INPUT_API_VERSION) {
LOG_DEBUG("Failed! Wrong API version.\n");
LOG_ERROR("Unable to load input library '%s'. Wrong API version\n",
p_library_path);
dlclose(p_libxmount);
continue;
}
LIBXMOUNT_LOAD_SYMBOL("LibXmount_Input_GetSupportedFormats",
pfun_input_GetSupportedFormats);
LIBXMOUNT_LOAD_SYMBOL("LibXmount_Input_GetFunctions",
pfun_input_GetFunctions);
// Construct new entry for our library list
XMOUNT_MALLOC(p_input_lib,pts_InputLib,sizeof(ts_InputLib));
// Initialize lib_functions structure to NULL
memset(&(p_input_lib->lib_functions),
0,
sizeof(ts_LibXmountInputFunctions));
// Set name and handle
XMOUNT_STRSET(p_input_lib->p_name,p_dirent->d_name);
p_input_lib->p_lib=p_libxmount;
// Get and set supported formats
p_supported_formats=pfun_input_GetSupportedFormats();
supported_formats_len=0;
p_buf=p_supported_formats;
while(*p_buf!='\0') {
supported_formats_len+=(strlen(p_buf)+1);
p_buf+=(strlen(p_buf)+1);
}
supported_formats_len++;
XMOUNT_MALLOC(p_input_lib->p_supported_input_types,
char*,
supported_formats_len);
memcpy(p_input_lib->p_supported_input_types,
p_supported_formats,
supported_formats_len);
// Get, set and check lib_functions
pfun_input_GetFunctions(&(p_input_lib->lib_functions));
if(p_input_lib->lib_functions.CreateHandle==NULL ||
p_input_lib->lib_functions.DestroyHandle==NULL ||
p_input_lib->lib_functions.Open==NULL ||
p_input_lib->lib_functions.Close==NULL ||
p_input_lib->lib_functions.Size==NULL ||
p_input_lib->lib_functions.Read==NULL ||
p_input_lib->lib_functions.OptionsHelp==NULL ||
p_input_lib->lib_functions.OptionsParse==NULL ||
p_input_lib->lib_functions.GetInfofileContent==NULL ||
p_input_lib->lib_functions.GetErrorMessage==NULL ||
p_input_lib->lib_functions.FreeBuffer==NULL)
{
LOG_DEBUG("Missing implemention of one or more functions in lib %s!\n",
p_dirent->d_name);
free(p_input_lib->p_supported_input_types);
free(p_input_lib->p_name);
free(p_input_lib);
dlclose(p_libxmount);
continue;
}
// Add entry to the input library list
XMOUNT_REALLOC(glob_xmount.input.pp_libs,
pts_InputLib*,
sizeof(pts_InputLib)*(glob_xmount.input.libs_count+1));
glob_xmount.input.pp_libs[glob_xmount.input.libs_count++]=p_input_lib;
LOG_DEBUG("Input library '%s' loaded successfully\n",p_dirent->d_name);
} if(strncmp(p_dirent->d_name,"libxmount_morphing_",19)==0) {
// Found possible morphing lib. Try to load it
LIBXMOUNT_LOAD(p_library_path);
// Load library symbols
LIBXMOUNT_LOAD_SYMBOL("LibXmount_Morphing_GetApiVersion",
pfun_morphing_GetApiVersion);
// Check library's API version
if(pfun_morphing_GetApiVersion()!=LIBXMOUNT_MORPHING_API_VERSION) {
LOG_DEBUG("Failed! Wrong API version.\n");
LOG_ERROR("Unable to load morphing library '%s'. Wrong API version\n",
p_library_path);
dlclose(p_libxmount);
continue;
}
LIBXMOUNT_LOAD_SYMBOL("LibXmount_Morphing_GetSupportedTypes",
pfun_morphing_GetSupportedTypes);
LIBXMOUNT_LOAD_SYMBOL("LibXmount_Morphing_GetFunctions",
pfun_morphing_GetFunctions);
// Construct new entry for our library list
XMOUNT_MALLOC(p_morphing_lib,pts_MorphingLib,sizeof(ts_MorphingLib));
// Initialize lib_functions structure to NULL
memset(&(p_morphing_lib->lib_functions),
0,
sizeof(ts_LibXmountMorphingFunctions));
// Set name and handle
XMOUNT_STRSET(p_morphing_lib->p_name,p_dirent->d_name);
p_morphing_lib->p_lib=p_libxmount;
// Get and set supported types
p_supported_formats=pfun_morphing_GetSupportedTypes();
supported_formats_len=0;
p_buf=p_supported_formats;
while(*p_buf!='\0') {
supported_formats_len+=(strlen(p_buf)+1);
p_buf+=(strlen(p_buf)+1);
}
supported_formats_len++;
XMOUNT_MALLOC(p_morphing_lib->p_supported_morphing_types,
char*,
supported_formats_len);
memcpy(p_morphing_lib->p_supported_morphing_types,
p_supported_formats,
supported_formats_len);
// Get, set and check lib_functions
pfun_morphing_GetFunctions(&(p_morphing_lib->lib_functions));
if(p_morphing_lib->lib_functions.CreateHandle==NULL ||
p_morphing_lib->lib_functions.DestroyHandle==NULL ||
p_morphing_lib->lib_functions.Morph==NULL ||
p_morphing_lib->lib_functions.Size==NULL ||
p_morphing_lib->lib_functions.Read==NULL ||
p_morphing_lib->lib_functions.OptionsHelp==NULL ||
p_morphing_lib->lib_functions.OptionsParse==NULL ||
p_morphing_lib->lib_functions.GetInfofileContent==NULL ||
p_morphing_lib->lib_functions.GetErrorMessage==NULL ||
p_morphing_lib->lib_functions.FreeBuffer==NULL)
{
LOG_DEBUG("Missing implemention of one or more functions in lib %s!\n",
p_dirent->d_name);
free(p_morphing_lib->p_supported_morphing_types);
free(p_morphing_lib->p_name);
free(p_morphing_lib);
dlclose(p_libxmount);
continue;
}
// Add entry to the input library list
XMOUNT_REALLOC(glob_xmount.morphing.pp_libs,
pts_MorphingLib*,
sizeof(pts_MorphingLib)*
(glob_xmount.morphing.libs_count+1));
glob_xmount.morphing.pp_libs[glob_xmount.morphing.libs_count++]=
p_morphing_lib;
LOG_DEBUG("Morphing library '%s' loaded successfully\n",p_dirent->d_name);
} else {
LOG_DEBUG("Ignoring '%s'.\n",p_dirent->d_name);
continue;
}
}
#undef LIBXMOUNT_LOAD_SYMBOL
#undef LIBXMOUNT_LOAD
LOG_DEBUG("A total of %u input libs and %u morphing libs were loaded.\n",
glob_xmount.input.libs_count,
glob_xmount.morphing.libs_count);
free(p_library_path);
closedir(p_dir);
return ((glob_xmount.input.libs_count>0 &&
glob_xmount.morphing.libs_count>0) ? TRUE : FALSE);
}
//! Search an appropriate input lib for specified input type
/*!
* \param p_input_image Input image to search input lib for
* \return TRUE on success, FALSE on error
*/
static int FindInputLib(pts_InputImage p_input_image) {
char *p_buf;
LOG_DEBUG("Trying to find suitable library for input type '%s'.\n",
p_input_image->p_type);
// Loop over all loaded libs
for(uint32_t i=0;i<glob_xmount.input.libs_count;i++) {
LOG_DEBUG("Checking input library %s\n",
glob_xmount.input.pp_libs[i]->p_name);
p_buf=glob_xmount.input.pp_libs[i]->p_supported_input_types;
while(*p_buf!='\0') {
if(strcmp(p_buf,p_input_image->p_type)==0) {
// Library supports input type, set lib functions
LOG_DEBUG("Input library '%s' pretends to handle that input type.\n",
glob_xmount.input.pp_libs[i]->p_name);
p_input_image->p_functions=
&(glob_xmount.input.pp_libs[i]->lib_functions);
return TRUE;
}
p_buf+=(strlen(p_buf)+1);
}
}
LOG_DEBUG("Couldn't find any suitable library.\n");
// No library supporting input type found
return FALSE;
}
//! Search an appropriate morphing lib for the specified morph type
/*!
* \return TRUE on success, FALSE on error
*/
static int FindMorphingLib() {
char *p_buf;
LOG_DEBUG("Trying to find suitable library for morph type '%s'.\n",
glob_xmount.morphing.p_morph_type);
// Loop over all loaded libs
for(uint32_t i=0;i<glob_xmount.morphing.libs_count;i++) {
LOG_DEBUG("Checking morphing library %s\n",
glob_xmount.morphing.pp_libs[i]->p_name);
p_buf=glob_xmount.morphing.pp_libs[i]->p_supported_morphing_types;
while(*p_buf!='\0') {
if(strcmp(p_buf,glob_xmount.morphing.p_morph_type)==0) {
// Library supports morph type, set lib functions
LOG_DEBUG("Morphing library '%s' pretends to handle that morph type.\n",
glob_xmount.morphing.pp_libs[i]->p_name);
glob_xmount.morphing.p_functions=
&(glob_xmount.morphing.pp_libs[i]->lib_functions);
return TRUE;
}
p_buf+=(strlen(p_buf)+1);
}
}
LOG_DEBUG("Couldn't find any suitable library.\n");
// No library supporting input type found
return FALSE;
}
static void InitResources() {
// Input
glob_xmount.input.libs_count=0;
glob_xmount.input.pp_libs=NULL;
glob_xmount.input.lib_params_count=0;
glob_xmount.input.pp_lib_params=NULL;
glob_xmount.input.images_count=0;
glob_xmount.input.pp_images=NULL;
glob_xmount.input.image_offset=0;
glob_xmount.input.image_size_limit=0;
glob_xmount.input.image_hash_lo=0;
glob_xmount.input.image_hash_hi=0;
// Morphing
glob_xmount.morphing.libs_count=0;
glob_xmount.morphing.pp_libs=NULL;
glob_xmount.morphing.p_morph_type=NULL;
glob_xmount.morphing.lib_params_count=0;
glob_xmount.morphing.pp_lib_params=NULL;
glob_xmount.morphing.p_handle=NULL;
glob_xmount.morphing.p_functions=NULL;
glob_xmount.morphing.input_image_functions.ImageCount=
&LibXmount_Morphing_ImageCount;
glob_xmount.morphing.input_image_functions.Size=&LibXmount_Morphing_Size;
glob_xmount.morphing.input_image_functions.Read=&LibXmount_Morphing_Read;
// Cache
glob_xmount.cache.p_cache_file=NULL;
glob_xmount.cache.h_cache_file=NULL;
glob_xmount.cache.p_cache_header=NULL;
glob_xmount.cache.p_cache_blkidx=NULL;
glob_xmount.cache.overwrite_cache=FALSE;
// Output
#ifndef __APPLE__
glob_xmount.output.VirtImageType=VirtImageType_DD;
#else
glob_xmount.output.VirtImageType=VirtImageType_DMG;
#endif
glob_xmount.output.image_size=0;
glob_xmount.output.writable=FALSE;
glob_xmount.output.p_virtual_image_path=NULL;
glob_xmount.output.p_info_path=NULL;
glob_xmount.output.p_info_file=NULL;
glob_xmount.output.vdi.vdi_header_size=0;
glob_xmount.output.vdi.p_vdi_header=NULL;
glob_xmount.output.vdi.vdi_block_map_size=0;
glob_xmount.output.vdi.p_vdi_block_map=NULL;
glob_xmount.output.vhd.p_vhd_header=NULL;
glob_xmount.output.vmdk.p_virtual_vmdk_path=NULL;
glob_xmount.output.vmdk.p_vmdk_file=NULL;
glob_xmount.output.vmdk.vmdk_file_size=0;
glob_xmount.output.vmdk.p_vmdk_lockdir1=NULL;
glob_xmount.output.vmdk.p_vmdk_lockdir2=NULL;
glob_xmount.output.vmdk.p_vmdk_lockfile_data=NULL;
glob_xmount.output.vmdk.vmdk_lockfile_size=0;
glob_xmount.output.vmdk.p_vmdk_lockfile_name=NULL;
// Misc data
glob_xmount.debug=FALSE;
glob_xmount.may_set_fuse_allow_other=FALSE;
glob_xmount.fuse_argc=0;
glob_xmount.pp_fuse_argv=NULL;
glob_xmount.p_mountpoint=NULL;
}
/*
* FreeResources
*/
static void FreeResources() {
int ret;
LOG_DEBUG("Freeing all resources\n");
// Misc
if(glob_xmount.pp_fuse_argv!=NULL) {
for(int i=0;i<glob_xmount.fuse_argc;i++) free(glob_xmount.pp_fuse_argv[i]);
free(glob_xmount.pp_fuse_argv);
}
if(glob_xmount.p_mountpoint!=NULL) free(glob_xmount.p_mountpoint);
// Output
if(glob_xmount.output.vmdk.p_vmdk_lockfile_name!=NULL)
free(glob_xmount.output.vmdk.p_vmdk_lockfile_name);
if(glob_xmount.output.vmdk.p_vmdk_lockfile_data!=NULL)
free(glob_xmount.output.vmdk.p_vmdk_lockfile_data);
if(glob_xmount.output.vmdk.p_vmdk_lockdir2!=NULL)
free(glob_xmount.output.vmdk.p_vmdk_lockdir2);
if(glob_xmount.output.vmdk.p_vmdk_lockdir1!=NULL)
free(glob_xmount.output.vmdk.p_vmdk_lockdir1);
if(glob_xmount.output.vmdk.p_vmdk_file!=NULL)
free(glob_xmount.output.vmdk.p_vmdk_file);
if(glob_xmount.output.vmdk.p_virtual_vmdk_path!=NULL)
free(glob_xmount.output.vmdk.p_virtual_vmdk_path);
if(glob_xmount.output.p_info_path!=NULL)
free(glob_xmount.output.p_info_path);
if(glob_xmount.output.p_info_file!=NULL)
free(glob_xmount.output.p_info_file);
if(glob_xmount.output.vhd.p_vhd_header!=NULL)
free(glob_xmount.output.vhd.p_vhd_header);
if(glob_xmount.output.vdi.p_vdi_block_map!=NULL)
free(glob_xmount.output.vdi.p_vdi_block_map);
if(glob_xmount.output.vdi.p_vdi_header!=NULL)
free(glob_xmount.output.vdi.p_vdi_header);
if(glob_xmount.output.p_virtual_image_path!=NULL)
free(glob_xmount.output.p_virtual_image_path);
// Cache
if(glob_xmount.cache.h_cache_file!=NULL)
fclose(glob_xmount.cache.h_cache_file);
if(glob_xmount.cache.p_cache_header!=NULL)
free(glob_xmount.cache.p_cache_header);
// glob_xmount.cache.p_cache_blkidx is freed by the above call
if(glob_xmount.cache.p_cache_file!=NULL)
free(glob_xmount.cache.p_cache_file);
// Morphing
if(glob_xmount.morphing.p_functions!=NULL) {
if(glob_xmount.morphing.p_handle!=NULL) {
// Destroy morphing handle
ret=glob_xmount.morphing.p_functions->
DestroyHandle(&(glob_xmount.morphing.p_handle));
if(ret!=0) {
LOG_ERROR("Unable to destroy morphing handle: %s!\n",
glob_xmount.morphing.p_functions->GetErrorMessage(ret));
}
}
}
if(glob_xmount.morphing.pp_lib_params!=NULL) {
for(uint32_t i=0;i<glob_xmount.morphing.lib_params_count;i++)
free(glob_xmount.morphing.pp_lib_params[i]);
free(glob_xmount.morphing.pp_lib_params);
}
if(glob_xmount.morphing.p_morph_type!=NULL)
free(glob_xmount.morphing.p_morph_type);
if(glob_xmount.morphing.pp_libs!=NULL) {
// Unload morphing libs
for(uint32_t i=0;i<glob_xmount.morphing.libs_count;i++) {
if(glob_xmount.morphing.pp_libs[i]==NULL) continue;
if(glob_xmount.morphing.pp_libs[i]->p_supported_morphing_types!=NULL)
free(glob_xmount.morphing.pp_libs[i]->p_supported_morphing_types);
if(glob_xmount.morphing.pp_libs[i]->p_lib!=NULL)
dlclose(glob_xmount.morphing.pp_libs[i]->p_lib);
if(glob_xmount.morphing.pp_libs[i]->p_name!=NULL)
free(glob_xmount.morphing.pp_libs[i]->p_name);
free(glob_xmount.morphing.pp_libs[i]);
}
free(glob_xmount.morphing.pp_libs);
}
// Input
if(glob_xmount.input.pp_images!=NULL) {
// Close all input images
for(uint64_t i=0;i<glob_xmount.input.images_count;i++) {
if(glob_xmount.input.pp_images[i]==NULL) continue;
if(glob_xmount.input.pp_images[i]->p_functions!=NULL) {
if(glob_xmount.input.pp_images[i]->p_handle!=NULL) {
ret=glob_xmount.input.pp_images[i]->p_functions->
Close(glob_xmount.input.pp_images[i]->p_handle);
if(ret!=0) {
LOG_ERROR("Unable to close input image: %s\n",
glob_xmount.input.pp_images[i]->p_functions->
GetErrorMessage(ret));
}
ret=glob_xmount.input.pp_images[i]->p_functions->
DestroyHandle(&(glob_xmount.input.pp_images[i]->p_handle));
if(ret!=0) {
LOG_ERROR("Unable to destroy input image handle: %s\n",
glob_xmount.input.pp_images[i]->p_functions->
GetErrorMessage(ret));
}
}
}
if(glob_xmount.input.pp_images[i]->pp_files!=NULL) {
for(uint64_t ii=0;ii<glob_xmount.input.pp_images[i]->files_count;ii++) {
if(glob_xmount.input.pp_images[i]->pp_files[ii]!=NULL)
free(glob_xmount.input.pp_images[i]->pp_files[ii]);
}
free(glob_xmount.input.pp_images[i]->pp_files);
}
if(glob_xmount.input.pp_images[i]->p_type!=NULL)
free(glob_xmount.input.pp_images[i]->p_type);
free(glob_xmount.input.pp_images[i]);
}
free(glob_xmount.input.pp_images);
}
if(glob_xmount.input.pp_lib_params!=NULL) {
for(uint32_t i=0;i<glob_xmount.input.lib_params_count;i++)
free(glob_xmount.input.pp_lib_params[i]);
free(glob_xmount.input.pp_lib_params);
}
if(glob_xmount.input.pp_libs!=NULL) {
// Unload all input libs
for(uint32_t i=0;i<glob_xmount.input.libs_count;i++) {
if(glob_xmount.input.pp_libs[i]->p_supported_input_types!=NULL)
free(glob_xmount.input.pp_libs[i]->p_supported_input_types);
if(glob_xmount.input.pp_libs[i]->p_lib!=NULL)
dlclose(glob_xmount.input.pp_libs[i]->p_lib);
if(glob_xmount.input.pp_libs[i]->p_name!=NULL)
free(glob_xmount.input.pp_libs[i]->p_name);
free(glob_xmount.input.pp_libs[i]);
}
free(glob_xmount.input.pp_libs);
}
// Before we return, initialize everything in case ReleaseResources would be
// called again.
InitResources();
}
//! Function to split given library options
static int SplitLibraryParameters(char *p_params,
uint32_t *p_ret_opts_count,
pts_LibXmountOptions **ppp_ret_opt)
{
pts_LibXmountOptions p_opts=NULL;
pts_LibXmountOptions *pp_opts=NULL;
uint32_t params_len;
uint32_t opts_count=0;
uint32_t sep_pos=0;
char *p_buf=p_params;
if(p_params==NULL) return FALSE;
// Get params length
params_len=strlen(p_params);
// Return if no params specified
if(params_len==0) {
*ppp_ret_opt=NULL;
p_ret_opts_count=0;
return TRUE;
}
// Split params
while(*p_buf!='\0') {
XMOUNT_MALLOC(p_opts,pts_LibXmountOptions,sizeof(ts_LibXmountOptions));
p_opts->valid=0;
#define FREE_PP_OPTS() { \
if(pp_opts!=NULL) { \
for(uint32_t i=0;i<opts_count;i++) free(pp_opts[i]); \
free(pp_opts); \
} \
}
// Search next assignment operator
sep_pos=0;
while(p_buf[sep_pos]!='\0' && p_buf[sep_pos]!='=') sep_pos++;
if(sep_pos==0 || p_buf[sep_pos]=='\0') {
LOG_ERROR("Library parameter '%s' is missing an assignment operator!\n",
p_buf);
free(p_opts);
FREE_PP_OPTS();
return FALSE;
}
// Save option key
XMOUNT_STRNSET(p_opts->p_key,p_buf,sep_pos);
p_buf+=(sep_pos+1);
// Search next separator
sep_pos=0;
while(p_buf[sep_pos]!='\0' && p_buf[sep_pos]!=',') sep_pos++;
if(sep_pos==0) {
LOG_ERROR("Library parameter '%s' is not of format key=value!\n",
p_opts->p_key);
free(p_opts->p_key);
free(p_opts);
FREE_PP_OPTS();
return FALSE;
}
// Save option value
XMOUNT_STRNSET(p_opts->p_value,p_buf,sep_pos);
p_buf+=sep_pos;
LOG_DEBUG("Extracted library option: '%s' = '%s'\n",
p_opts->p_key,
p_opts->p_value);
#undef FREE_PP_OPTS
// Add current option to return array
XMOUNT_REALLOC(pp_opts,
pts_LibXmountOptions*,
sizeof(pts_LibXmountOptions)*(opts_count+1));
pp_opts[opts_count++]=p_opts;
// If we're not at the end of p_params, skip over separator for next run
if(*p_buf!='\0') p_buf++;
}
LOG_DEBUG("Extracted a total of %" PRIu32 " library options\n",opts_count);
*p_ret_opts_count=opts_count;
*ppp_ret_opt=pp_opts;
return TRUE;
}
/*******************************************************************************
* LibXmount_Morphing function implementation
******************************************************************************/
//! Function to get the amount of input images
/*!
* \param p_count Count of input images
* \return 0 on success
*/
static int LibXmount_Morphing_ImageCount(uint64_t *p_count) {
*p_count=glob_xmount.input.images_count;
return 0;
}
//! Function to get the size of the morphed data
/*!
* \param image Image number
* \param p_size Pointer to store input image's size to
* \return 0 on success
*/
static int LibXmount_Morphing_Size(uint64_t image, uint64_t *p_size) {
if(image>=glob_xmount.input.images_count) return -1;
*p_size=glob_xmount.input.pp_images[image]->size;
return 0;
}
//! Function to read data from input image
/*!
* \param image Image number
* \param p_buf Buffer to store read data to
* \param offset Position at which to start reading
* \param count Amount of bytes to read
* \param p_read Number of read bytes on success
* \return 0 on success or negated error code on error
*/
static int LibXmount_Morphing_Read(uint64_t image,
char *p_buf,
off_t offset,
size_t count,
size_t *p_read)
{
if(image>=glob_xmount.input.images_count) return -EIO;
return GetInputImageData(glob_xmount.input.pp_images[image],
p_buf,
offset,
count,
p_read);
}
/*******************************************************************************
* FUSE function implementation
******************************************************************************/
//! FUSE access implementation
/*!
* \param p_path Path of file to get attributes from
* \param perm Requested permissisons
* \return 0 on success, negated error code on error
*/
/*
static int FuseAccess(const char *path, int perm) {
// TODO: Implement propper file permission handling
// http://www.cs.cf.ac.uk/Dave/C/node20.html
// Values for the second argument to access.
// These may be OR'd together.
//#define R_OK 4 // Test for read permission.
//#define W_OK 2 // Test for write permission.
//#define X_OK 1 // Test for execute permission.
//#define F_OK 0 // Test for existence.
return 0;
}
*/
//! FUSE getattr implementation
/*!
* \param p_path Path of file to get attributes from
* \param p_stat Pointer to stat structure to save attributes to
* \return 0 on success, negated error code on error
*/
static int FuseGetAttr(const char *p_path, struct stat *p_stat) {
memset(p_stat,0,sizeof(struct stat));
if(strcmp(p_path,"/")==0) {
// Attributes of mountpoint
p_stat->st_mode=S_IFDIR | 0777;
p_stat->st_nlink=2;
} else if(strcmp(p_path,glob_xmount.output.p_virtual_image_path)==0) {
// Attributes of virtual image
if(!glob_xmount.output.writable) p_stat->st_mode=S_IFREG | 0444;
else p_stat->st_mode=S_IFREG | 0666;
p_stat->st_nlink=1;
// Get virtual image file size
if(!GetVirtImageSize((uint64_t*)&(p_stat->st_size))) {
LOG_ERROR("Couldn't get image size!\n");
return -ENOENT;
}
if(glob_xmount.output.VirtImageType==VirtImageType_VHD) {
// Make sure virtual image seems to be fully allocated (not sparse file).
// Without this, Windows won't attach the vhd file!
p_stat->st_blocks=p_stat->st_size/512;
if(p_stat->st_size%512!=0) p_stat->st_blocks++;
}
} else if(strcmp(p_path,glob_xmount.output.p_info_path)==0) {
// Attributes of virtual image info file
p_stat->st_mode=S_IFREG | 0444;
p_stat->st_nlink=1;
// Get virtual image info file size
if(glob_xmount.output.p_info_file!=NULL) {
p_stat->st_size=strlen(glob_xmount.output.p_info_file);
} else p_stat->st_size=0;
} else if(glob_xmount.output.VirtImageType==VirtImageType_VMDK ||
glob_xmount.output.VirtImageType==VirtImageType_VMDKS)
{
// Some special files only present when emulating VMDK files
if(strcmp(p_path,glob_xmount.output.vmdk.p_virtual_vmdk_path)==0) {
// Attributes of virtual vmdk file
if(!glob_xmount.output.writable) p_stat->st_mode=S_IFREG | 0444;
else p_stat->st_mode=S_IFREG | 0666;
p_stat->st_nlink=1;
// Get virtual image info file size
if(glob_xmount.output.vmdk.p_vmdk_file!=NULL) {
p_stat->st_size=glob_xmount.output.vmdk.vmdk_file_size;
} else p_stat->st_size=0;
} else if(glob_xmount.output.vmdk.p_vmdk_lockdir1!=NULL &&
strcmp(p_path,glob_xmount.output.vmdk.p_vmdk_lockdir1)==0)
{
p_stat->st_mode=S_IFDIR | 0777;
p_stat->st_nlink=2;
} else if(glob_xmount.output.vmdk.p_vmdk_lockdir2!=NULL &&
strcmp(p_path,glob_xmount.output.vmdk.p_vmdk_lockdir2)==0)
{
p_stat->st_mode=S_IFDIR | 0777;
p_stat->st_nlink=2;
} else if(glob_xmount.output.vmdk.p_vmdk_lockfile_name!=NULL &&
strcmp(p_path,glob_xmount.output.vmdk.p_vmdk_lockfile_name)==0)
{
p_stat->st_mode=S_IFREG | 0666;
if(glob_xmount.output.vmdk.p_vmdk_lockfile_name!=NULL) {
p_stat->st_size=strlen(glob_xmount.output.vmdk.p_vmdk_lockfile_name);
} else p_stat->st_size=0;
} else return -ENOENT;
} else return -ENOENT;
// Set uid and gid of all files to uid and gid of current process
p_stat->st_uid=getuid();
p_stat->st_gid=getgid();
return 0;
}
//! FUSE mkdir implementation
/*!
* \param p_path Directory path
* \param mode Directory permissions
* \return 0 on success, negated error code on error
*/
static int FuseMkDir(const char *p_path, mode_t mode) {
// Only allow creation of VMWare's lock directories
if(glob_xmount.output.VirtImageType==VirtImageType_VMDK ||
glob_xmount.output.VirtImageType==VirtImageType_VMDKS)
{
if(glob_xmount.output.vmdk.p_vmdk_lockdir1==NULL) {
char aVmdkLockDir[strlen(glob_xmount.output.vmdk.p_virtual_vmdk_path)+5];
sprintf(aVmdkLockDir,
"%s.lck",
glob_xmount.output.vmdk.p_virtual_vmdk_path);
if(strcmp(p_path,aVmdkLockDir)==0) {
LOG_DEBUG("Creating virtual directory \"%s\"\n",aVmdkLockDir)
XMOUNT_STRSET(glob_xmount.output.vmdk.p_vmdk_lockdir1,aVmdkLockDir)
return 0;
} else {
LOG_ERROR("Attempt to create illegal directory \"%s\"!\n",p_path)
LOG_DEBUG("Supposed: %s\n",aVmdkLockDir)
return -1;
}
} else if(glob_xmount.output.vmdk.p_vmdk_lockdir2==NULL &&
strncmp(p_path,
glob_xmount.output.vmdk.p_vmdk_lockdir1,
strlen(glob_xmount.output.vmdk.p_vmdk_lockdir1))==0)
{
LOG_DEBUG("Creating virtual directory \"%s\"\n",p_path)
XMOUNT_STRSET(glob_xmount.output.vmdk.p_vmdk_lockdir2,p_path)
return 0;
} else {
LOG_ERROR("Attempt to create illegal directory \"%s\"!\n",p_path)
LOG_DEBUG("Compared to first %u chars of \"%s\"\n",
strlen(glob_xmount.output.vmdk.p_vmdk_lockdir1),
glob_xmount.output.vmdk.p_vmdk_lockdir1)
return -1;
}
}
LOG_ERROR("Attempt to create directory \"%s\" "
"on read-only filesystem!\n",p_path)
return -1;
}
//! FUSE create implementation.
/*!
* Currently only allows to create VMWare's lock file
*
* \param p_path File to create
* \param mode File mode
* \param dev ??? but not used
* \return 0 on success, negated error code on error
*/
static int FuseMkNod(const char *p_path, mode_t mode, dev_t dev) {
if((glob_xmount.output.VirtImageType==VirtImageType_VMDK ||
glob_xmount.output.VirtImageType==VirtImageType_VMDKS) &&
glob_xmount.output.vmdk.p_vmdk_lockdir1!=NULL &&
glob_xmount.output.vmdk.p_vmdk_lockfile_name==NULL)
{
LOG_DEBUG("Creating virtual file \"%s\"\n",p_path)
XMOUNT_STRSET(glob_xmount.output.vmdk.p_vmdk_lockfile_name,p_path);
return 0;
} else {
LOG_ERROR("Attempt to create illegal file \"%s\"\n",p_path)
return -1;
}
}
//! FUSE readdir implementation
/*!
* \param p_path Path from where files should be listed
* \param p_buf Buffer to write file entrys to
* \param filler Function to write dir entrys to buffer
* \param offset ??? but not used
* \param p_fi File info struct
* \return 0 on success, negated error code on error
*/
static int FuseReadDir(const char *p_path,
void *p_buf,
fuse_fill_dir_t filler,
off_t offset,
struct fuse_file_info *p_fi)
{
// Ignore some params
(void)offset;
(void)p_fi;
if(strcmp(p_path,"/")==0) {
// Add std . and .. entrys
filler(p_buf,".",NULL,0);
filler(p_buf,"..",NULL,0);
// Add our virtual files (p+1 to ignore starting "/")
filler(p_buf,glob_xmount.output.p_virtual_image_path+1,NULL,0);
filler(p_buf,glob_xmount.output.p_info_path+1,NULL,0);
if(glob_xmount.output.VirtImageType==VirtImageType_VMDK ||
glob_xmount.output.VirtImageType==VirtImageType_VMDKS)
{
// For VMDK's, we use an additional descriptor file
filler(p_buf,glob_xmount.output.vmdk.p_virtual_vmdk_path+1,NULL,0);
// And there could also be a lock directory
if(glob_xmount.output.vmdk.p_vmdk_lockdir1!=NULL) {
filler(p_buf,glob_xmount.output.vmdk.p_vmdk_lockdir1+1,NULL,0);
}
}
} else if(glob_xmount.output.VirtImageType==VirtImageType_VMDK ||
glob_xmount.output.VirtImageType==VirtImageType_VMDKS)
{
// For VMDK emulation, there could be a lock directory
if(glob_xmount.output.vmdk.p_vmdk_lockdir1!=NULL &&
strcmp(p_path,glob_xmount.output.vmdk.p_vmdk_lockdir1)==0)
{
filler(p_buf,".",NULL,0);
filler(p_buf,"..",NULL,0);
if(glob_xmount.output.vmdk.p_vmdk_lockfile_name!=NULL) {
filler(p_buf,
glob_xmount.output.vmdk.p_vmdk_lockfile_name+
strlen(glob_xmount.output.vmdk.p_vmdk_lockdir1)+1,
NULL,
0);
}
} else if(glob_xmount.output.vmdk.p_vmdk_lockdir2!=NULL &&
strcmp(p_path,glob_xmount.output.vmdk.p_vmdk_lockdir2)==0)
{
filler(p_buf,".",NULL,0);
filler(p_buf,"..",NULL,0);
} else return -ENOENT;
} else return -ENOENT;
return 0;
}
//! FUSE open implementation
/*!
* \param p_path Path to file to open
* \param p_fi File info struct
* \return 0 on success, negated error code on error
*/
static int FuseOpen(const char *p_path, struct fuse_file_info *p_fi) {
#define CHECK_OPEN_PERMS() { \
if(!glob_xmount.output.writable && (p_fi->flags & 3)!=O_RDONLY) { \
LOG_DEBUG("Attempt to open the read-only file \"%s\" for writing.\n", \
p_path) \
return -EACCES; \
} \
return 0; \
}
if(strcmp(p_path,glob_xmount.output.p_virtual_image_path)==0 ||
strcmp(p_path,glob_xmount.output.p_info_path)==0)
{
CHECK_OPEN_PERMS();
} else if(glob_xmount.output.VirtImageType==VirtImageType_VMDK ||
glob_xmount.output.VirtImageType==VirtImageType_VMDKS)
{
if(strcmp(p_path,glob_xmount.output.vmdk.p_virtual_vmdk_path)==0 ||
(glob_xmount.output.vmdk.p_vmdk_lockfile_name!=NULL &&
strcmp(p_path,glob_xmount.output.vmdk.p_vmdk_lockfile_name)==0))
{
CHECK_OPEN_PERMS();
}
}
#undef CHECK_OPEN_PERMS
LOG_DEBUG("Attempt to open inexistant file \"%s\".\n",p_path);
return -ENOENT;
}
//! FUSE read implementation
/*!
* \param p_path Path (relative to mount folder) of file to read data from
* \param p_buf Pre-allocated buffer where read data should be written to
* \param size Number of bytes to read
* \param offset Offset to start reading at
* \param p_fi: File info struct
* \return Read bytes on success, negated error code on error
*/
static int FuseRead(const char *p_path,
char *p_buf,
size_t size,
off_t offset,
struct fuse_file_info *p_fi)
{
(void)p_fi;
int ret;
uint64_t len;
#define READ_MEM_FILE(filebuf,filesize,filetypestr,mutex) { \
len=filesize; \
if(offset<len) { \
if(offset+size>len) { \
LOG_DEBUG("Attempt to read past EOF of virtual " filetypestr " file\n"); \
LOG_DEBUG("Adjusting read size from %u to %u\n",size,len-offset); \
size=len-offset; \
} \
pthread_mutex_lock(&mutex); \
memcpy(p_buf,filebuf+offset,size); \
pthread_mutex_unlock(&mutex); \
LOG_DEBUG("Read %" PRIu64 " bytes at offset %" PRIu64 \
" from virtual " filetypestr " file\n",size,offset); \
ret=size; \
} else { \
LOG_DEBUG("Attempt to read behind EOF of virtual " filetypestr " file\n"); \
ret=0; \
} \
}
if(strcmp(p_path,glob_xmount.output.p_virtual_image_path)==0) {
// Read data from virtual output file
// Wait for other threads to end reading/writing data
pthread_mutex_lock(&(glob_xmount.mutex_image_rw));
// Get requested data
if((ret=GetVirtImageData(p_buf,offset,size))<0) {
LOG_ERROR("Couldn't read data from virtual image file!\n")
}
// Allow other threads to read/write data again
pthread_mutex_unlock(&(glob_xmount.mutex_image_rw));
} else if(strcmp(p_path,glob_xmount.output.p_info_path)==0) {
// Read data from virtual info file
READ_MEM_FILE(glob_xmount.output.p_info_file,
strlen(glob_xmount.output.p_info_file),
"info",
glob_xmount.mutex_info_read);
} else if(strcmp(p_path,glob_xmount.output.vmdk.p_virtual_vmdk_path)==0) {
// Read data from virtual vmdk file
READ_MEM_FILE(glob_xmount.output.vmdk.p_vmdk_file,
glob_xmount.output.vmdk.vmdk_file_size,
"vmdk",
glob_xmount.mutex_image_rw);
} else if(glob_xmount.output.vmdk.p_vmdk_lockfile_name!=NULL &&
strcmp(p_path,glob_xmount.output.vmdk.p_vmdk_lockfile_name)==0)
{
// Read data from virtual lock file
READ_MEM_FILE(glob_xmount.output.vmdk.p_vmdk_lockfile_data,
glob_xmount.output.vmdk.vmdk_lockfile_size,
"vmdk lock",
glob_xmount.mutex_image_rw);
} else {
// Attempt to read non existant file
LOG_DEBUG("Attempt to read from non existant file \"%s\"\n",p_path)
ret=-ENOENT;
}
#undef READ_MEM_FILE
// TODO: Return size of read data!!!!!
return ret;
}
//! FUSE rename implementation
/*!
* \param p_path File to rename
* \param p_npath New filename
* \return 0 on error, negated error code on error
*/
static int FuseRename(const char *p_path, const char *p_npath) {
if(glob_xmount.output.VirtImageType==VirtImageType_VMDK ||
glob_xmount.output.VirtImageType==VirtImageType_VMDKS)
{
if(glob_xmount.output.vmdk.p_vmdk_lockfile_name!=NULL &&
strcmp(p_path,glob_xmount.output.vmdk.p_vmdk_lockfile_name)==0)
{
LOG_DEBUG("Renaming virtual lock file from \"%s\" to \"%s\"\n",
glob_xmount.output.vmdk.p_vmdk_lockfile_name,
p_npath)
XMOUNT_REALLOC(glob_xmount.output.vmdk.p_vmdk_lockfile_name,char*,
(strlen(p_npath)+1)*sizeof(char));
strcpy(glob_xmount.output.vmdk.p_vmdk_lockfile_name,p_npath);
return 0;
}
}
return -ENOENT;
}
//! FUSE rmdir implementation
/*!
* \param p_path Directory to delete
* \return 0 on success, negated error code on error
*/
static int FuseRmDir(const char *p_path) {
// Only VMWare's lock directories can be deleted
if(glob_xmount.output.VirtImageType==VirtImageType_VMDK ||
glob_xmount.output.VirtImageType==VirtImageType_VMDKS)
{
if(glob_xmount.output.vmdk.p_vmdk_lockdir1!=NULL &&
strcmp(p_path,glob_xmount.output.vmdk.p_vmdk_lockdir1)==0)
{
LOG_DEBUG("Deleting virtual lock dir \"%s\"\n",
glob_xmount.output.vmdk.p_vmdk_lockdir1)
free(glob_xmount.output.vmdk.p_vmdk_lockdir1);
glob_xmount.output.vmdk.p_vmdk_lockdir1=NULL;
return 0;
} else if(glob_xmount.output.vmdk.p_vmdk_lockdir2!=NULL &&
strcmp(p_path,glob_xmount.output.vmdk.p_vmdk_lockdir2)==0)
{
LOG_DEBUG("Deleting virtual lock dir \"%s\"\n",
glob_xmount.output.vmdk.p_vmdk_lockdir1)
free(glob_xmount.output.vmdk.p_vmdk_lockdir2);
glob_xmount.output.vmdk.p_vmdk_lockdir2=NULL;
return 0;
}
}
return -1;
}
//! FUSE unlink implementation
/*!
* \param p_path File to delete
* \return 0 on success, negated error code on error
*/
static int FuseUnlink(const char *p_path) {
// Only VMWare's lock file can be deleted
if(glob_xmount.output.VirtImageType==VirtImageType_VMDK ||
glob_xmount.output.VirtImageType==VirtImageType_VMDKS)
{
if(glob_xmount.output.vmdk.p_vmdk_lockfile_name!=NULL &&
strcmp(p_path,glob_xmount.output.vmdk.p_vmdk_lockfile_name)==0)
{
LOG_DEBUG("Deleting virtual file \"%s\"\n",
glob_xmount.output.vmdk.p_vmdk_lockfile_name)
free(glob_xmount.output.vmdk.p_vmdk_lockfile_name);
free(glob_xmount.output.vmdk.p_vmdk_lockfile_data);
glob_xmount.output.vmdk.p_vmdk_lockfile_name=NULL;
glob_xmount.output.vmdk.p_vmdk_lockfile_data=NULL;
glob_xmount.output.vmdk.vmdk_lockfile_size=0;
return 0;
}
}
return -1;
}
//! FUSE statfs implementation
/*!
* \param p_path Get stats for fs that the specified file resides in
* \param stats Stats
* \return 0 on success, negated error code on error
*/
/*
static int FuseStatFs(const char *p_path, struct statvfs *stats) {
struct statvfs CacheFileFsStats;
int ret;
if(glob_xmount.writable==TRUE) {
// If write support is enabled, return stats of fs upon which cache file
// resides in
if((ret=statvfs(glob_xmount.p_cache_file,&CacheFileFsStats))==0) {
memcpy(stats,&CacheFileFsStats,sizeof(struct statvfs));
return 0;
} else {
LOG_ERROR("Couldn't get stats for fs upon which resides \"%s\"\n",
glob_xmount.p_cache_file)
return ret;
}
} else {
// TODO: Return read only
return 0;
}
}
*/
// FUSE write implementation
/*!
* \param p_buf Buffer containing data to write
* \param size Number of bytes to write
* \param offset Offset to start writing at
* \param p_fi: File info struct
*
* Returns:
* Written bytes on success, negated error code on error
*/
static int FuseWrite(const char *p_path,
const char *p_buf,
size_t size,
off_t offset,
struct fuse_file_info *p_fi)
{
(void)p_fi;
uint64_t len;
if(strcmp(p_path,glob_xmount.output.p_virtual_image_path)==0) {
// Wait for other threads to end reading/writing data
pthread_mutex_lock(&(glob_xmount.mutex_image_rw));
// Get virtual image file size
if(!GetVirtImageSize(&len)) {
LOG_ERROR("Couldn't get virtual image size!\n")
pthread_mutex_unlock(&(glob_xmount.mutex_image_rw));
return 0;
}
if(offset<len) {
if(offset+size>len) size=len-offset;
if(SetVirtImageData(p_buf,offset,size)!=size) {
LOG_ERROR("Couldn't write data to virtual image file!\n")
pthread_mutex_unlock(&(glob_xmount.mutex_image_rw));
return 0;
}
} else {
LOG_DEBUG("Attempt to write past EOF of virtual image file\n")
pthread_mutex_unlock(&(glob_xmount.mutex_image_rw));
return 0;
}
// Allow other threads to read/write data again
pthread_mutex_unlock(&(glob_xmount.mutex_image_rw));
} else if(strcmp(p_path,glob_xmount.output.vmdk.p_virtual_vmdk_path)==0) {
pthread_mutex_lock(&(glob_xmount.mutex_image_rw));
len=glob_xmount.output.vmdk.vmdk_file_size;
if((offset+size)>len) {
// Enlarge or create buffer if needed
if(len==0) {
len=offset+size;
XMOUNT_MALLOC(glob_xmount.output.vmdk.p_vmdk_file,
char*,
len*sizeof(char));
} else {
len=offset+size;
XMOUNT_REALLOC(glob_xmount.output.vmdk.p_vmdk_file,
char*,
len*sizeof(char));
}
glob_xmount.output.vmdk.vmdk_file_size=offset+size;
}
// Copy data to buffer
memcpy(glob_xmount.output.vmdk.p_vmdk_file+offset,p_buf,size);
pthread_mutex_unlock(&(glob_xmount.mutex_image_rw));
} else if(glob_xmount.output.vmdk.p_vmdk_lockfile_name!=NULL &&
strcmp(p_path,glob_xmount.output.vmdk.p_vmdk_lockfile_name)==0)
{
pthread_mutex_lock(&(glob_xmount.mutex_image_rw));
if((offset+size)>glob_xmount.output.vmdk.vmdk_lockfile_size) {
// Enlarge or create buffer if needed
if(glob_xmount.output.vmdk.vmdk_lockfile_size==0) {
glob_xmount.output.vmdk.vmdk_lockfile_size=offset+size;
XMOUNT_MALLOC(glob_xmount.output.vmdk.p_vmdk_lockfile_data,char*,
glob_xmount.output.vmdk.vmdk_lockfile_size*sizeof(char))
} else {
glob_xmount.output.vmdk.vmdk_lockfile_size=offset+size;
XMOUNT_REALLOC(glob_xmount.output.vmdk.p_vmdk_lockfile_data,char*,
glob_xmount.output.vmdk.vmdk_lockfile_size*sizeof(char))
}
}
// Copy data to buffer
memcpy(glob_xmount.output.vmdk.p_vmdk_lockfile_data+offset,p_buf,size);
pthread_mutex_unlock(&(glob_xmount.mutex_image_rw));
} else if(strcmp(p_path,glob_xmount.output.p_info_path)==0) {
// Attempt to write data to read only image info file
LOG_DEBUG("Attempt to write data to virtual info file\n");
return -ENOENT;
} else {
// Attempt to write to non existant file
LOG_DEBUG("Attempt to write to the non existant file \"%s\"\n",p_path)
return -ENOENT;
}
return size;
}
/*******************************************************************************
* Main
******************************************************************************/
int main(int argc, char *argv[]) {
struct stat file_stat;
int ret;
int fuse_ret;
char *p_err_msg;
// Set implemented FUSE functions
struct fuse_operations xmount_operations = {
//.access=FuseAccess,
.getattr=FuseGetAttr,
.mkdir=FuseMkDir,
.mknod=FuseMkNod,
.open=FuseOpen,
.readdir=FuseReadDir,
.read=FuseRead,
.rename=FuseRename,
.rmdir=FuseRmDir,
//.statfs=FuseStatFs,
.unlink=FuseUnlink,
.write=FuseWrite
};
// Disable std output / input buffering
setbuf(stdout,NULL);
setbuf(stderr,NULL);
// Init glob_xmount
InitResources();
// Load input and morphing libs
if(!LoadLibs()) {
LOG_ERROR("Unable to load any libraries!\n")
return 1;
}
// Check FUSE settings
CheckFuseSettings();
// Parse command line options
if(ParseCmdLine(argc,argv)!=TRUE) {
PrintUsage(argv[0]);
FreeResources();
return 1;
}
// Check command line options
if(glob_xmount.input.images_count==0) {
LOG_ERROR("No --in command line option specified!\n")
PrintUsage(argv[0]);
FreeResources();
return 1;
}
if(glob_xmount.fuse_argc<2) {
LOG_ERROR("Couldn't parse command line options!\n")
PrintUsage(argv[0]);
FreeResources();
return 1;
}
if(glob_xmount.morphing.p_morph_type==NULL) {
XMOUNT_STRSET(glob_xmount.morphing.p_morph_type,"combine");
}
// Check if mountpoint is a valid dir
if(stat(glob_xmount.p_mountpoint,&file_stat)!=0) {
LOG_ERROR("Unable to stat mount point '%s'!\n",glob_xmount.p_mountpoint);
PrintUsage(argv[0]);
FreeResources();
return 1;
}
if(!S_ISDIR(file_stat.st_mode)) {
LOG_ERROR("Mount point '%s' is not a directory!\n",
glob_xmount.p_mountpoint);
PrintUsage(argv[0]);
FreeResources();
return 1;
}
if(glob_xmount.debug==TRUE) {
LOG_DEBUG("Options passed to FUSE: ")
for(int i=0;i<glob_xmount.fuse_argc;i++) {
printf("%s ",glob_xmount.pp_fuse_argv[i]);
}
printf("\n");
}
// Init mutexes
pthread_mutex_init(&(glob_xmount.mutex_image_rw),NULL);
pthread_mutex_init(&(glob_xmount.mutex_info_read),NULL);
// Load input images
for(uint64_t i=0;i<glob_xmount.input.images_count;i++) {
if(glob_xmount.debug==TRUE) {
if(glob_xmount.input.pp_images[i]->files_count==1) {
LOG_DEBUG("Loading image file \"%s\"...\n",
glob_xmount.input.pp_images[i]->pp_files[0])
} else {
LOG_DEBUG("Loading image files \"%s .. %s\"...\n",
glob_xmount.input.pp_images[i]->pp_files[0],
glob_xmount.input.pp_images[i]->
pp_files[glob_xmount.input.pp_images[i]->files_count-1])
}
}
// Find input lib
if(!FindInputLib(glob_xmount.input.pp_images[i])) {
LOG_ERROR("Unknown input image type '%s' for input image '%s'!\n",
glob_xmount.input.pp_images[i]->p_type,
glob_xmount.input.pp_images[i]->pp_files[0])
PrintUsage(argv[0]);
FreeResources();
return 1;
}
// Init input image handle
ret=glob_xmount.input.pp_images[i]->p_functions->
CreateHandle(&(glob_xmount.input.pp_images[i]->p_handle),
glob_xmount.input.pp_images[i]->p_type,
glob_xmount.debug);
if(ret!=0) {
LOG_ERROR("Unable to init input handle for input image '%s': %s!\n",
glob_xmount.input.pp_images[i]->pp_files[0],
glob_xmount.input.pp_images[i]->p_functions->
GetErrorMessage(ret));
FreeResources();
return 1;
}
// Parse input lib specific options
if(glob_xmount.input.pp_lib_params!=NULL) {
ret=glob_xmount.input.pp_images[i]->p_functions->
OptionsParse(glob_xmount.input.pp_images[i]->p_handle,
glob_xmount.input.lib_params_count,
glob_xmount.input.pp_lib_params,
(const char**)&p_err_msg);
if(ret!=0) {
if(p_err_msg!=NULL) {
LOG_ERROR("Unable to parse input library specific options for image "
"'%s': %s: %s!\n",
glob_xmount.input.pp_images[i]->pp_files[0],
glob_xmount.input.pp_images[i]->p_functions->
GetErrorMessage(ret),
p_err_msg);
glob_xmount.input.pp_images[i]->p_functions->FreeBuffer(p_err_msg);
FreeResources();
return 1;
} else {
LOG_ERROR("Unable to parse input library specific options for image "
"'%s': %s!\n",
glob_xmount.input.pp_images[i]->pp_files[0],
glob_xmount.input.pp_images[i]->p_functions->
GetErrorMessage(ret));
FreeResources();
return 1;
}
}
}
// Open input image
ret=
glob_xmount.input.pp_images[i]->
p_functions->
Open(glob_xmount.input.pp_images[i]->p_handle,
(const char**)(glob_xmount.input.pp_images[i]->pp_files),
glob_xmount.input.pp_images[i]->files_count);
if(ret!=0) {
LOG_ERROR("Unable to open input image file '%s': %s!\n",
glob_xmount.input.pp_images[i]->pp_files[0],
glob_xmount.input.pp_images[i]->p_functions->
GetErrorMessage(ret));
FreeResources();
return 1;
}
// Determine input image size
ret=glob_xmount.input.pp_images[i]->
p_functions->
Size(glob_xmount.input.pp_images[i]->p_handle,
&(glob_xmount.input.pp_images[i]->size));
if(ret!=0) {
LOG_ERROR("Unable to determine size of input image '%s': %s!\n",
glob_xmount.input.pp_images[i]->pp_files[0],
glob_xmount.input.pp_images[i]->
p_functions->GetErrorMessage(ret));
FreeResources();
return 1;
}
// If an offset was specified, check it against offset and change size
if(glob_xmount.input.image_offset!=0) {
if(glob_xmount.input.image_offset>glob_xmount.input.pp_images[i]->size) {
LOG_ERROR("The specified offset is larger than the size of the input "
"image '%s'! (%" PRIu64 " > %" PRIu64 ")\n",
glob_xmount.input.pp_images[i]->pp_files[0],
glob_xmount.input.image_offset,
glob_xmount.input.pp_images[i]->size);
FreeResources();
return 1;
}
glob_xmount.input.pp_images[i]->size-=glob_xmount.input.image_offset;
}
// If a size limit was specified, check it and change size
if(glob_xmount.input.image_size_limit!=0) {
if(glob_xmount.input.pp_images[i]->size<
glob_xmount.input.image_size_limit)
{
LOG_ERROR("The specified size limit is larger than the size of the "
"input image '%s'! (%" PRIu64 " > %" PRIu64 ")\n",
glob_xmount.input.pp_images[i]->pp_files[0],
glob_xmount.input.image_size_limit,
glob_xmount.input.pp_images[i]->size);
FreeResources();
return 1;
}
glob_xmount.input.pp_images[i]->size-=glob_xmount.input.image_size_limit;
}
LOG_DEBUG("Input image loaded successfully\n")
}
// Find morphing lib
if(FindMorphingLib()!=TRUE) {
LOG_ERROR("Unable to find a library supporting the morphing type '%s'!\n",
glob_xmount.morphing.p_morph_type);
FreeResources();
return 1;
}
// Init morphing
ret=glob_xmount.morphing.p_functions->
CreateHandle(&glob_xmount.morphing.p_handle,
glob_xmount.morphing.p_morph_type,
glob_xmount.debug);
if(ret!=0) {
LOG_ERROR("Unable to create morphing handle: %s!\n",
glob_xmount.morphing.p_functions->GetErrorMessage(ret));
FreeResources();
return 1;
}
// Parse morphing lib specific options
if(glob_xmount.morphing.pp_lib_params!=NULL) {
p_err_msg=NULL;
ret=glob_xmount.morphing.p_functions->
OptionsParse(glob_xmount.morphing.p_handle,
glob_xmount.morphing.lib_params_count,
glob_xmount.morphing.pp_lib_params,
(const char**)&p_err_msg);
if(ret!=0) {
if(p_err_msg!=NULL) {
LOG_ERROR("Unable to parse morphing library specific options: %s: %s!\n",
glob_xmount.morphing.p_functions->GetErrorMessage(ret),
p_err_msg);
glob_xmount.morphing.p_functions->FreeBuffer(p_err_msg);
FreeResources();
return 1;
} else {
LOG_ERROR("Unable to parse morphing library specific options: %s!\n",
glob_xmount.morphing.p_functions->GetErrorMessage(ret));
FreeResources();
return 1;
}
}
}
// Morph image
ret=glob_xmount.morphing.p_functions->
Morph(glob_xmount.morphing.p_handle,
&(glob_xmount.morphing.input_image_functions));
if(ret!=0) {
LOG_ERROR("Unable to start morphing: %s!\n",
glob_xmount.morphing.p_functions->GetErrorMessage(ret));
FreeResources();
return 1;
}
// Init random generator
srand(time(NULL));
// Calculate partial MD5 hash of input image file
if(CalculateInputImageHash(&(glob_xmount.input.image_hash_lo),
&(glob_xmount.input.image_hash_hi))==FALSE)
{
LOG_ERROR("Couldn't calculate partial hash of morphed image!\n")
return 1;
}
if(glob_xmount.debug==TRUE) {
LOG_DEBUG("Partial MD5 hash of morphed image: ")
for(int i=0;i<8;i++)
printf("%02hhx",*(((char*)(&(glob_xmount.input.image_hash_lo)))+i));
for(int i=0;i<8;i++)
printf("%02hhx",*(((char*)(&(glob_xmount.input.image_hash_hi)))+i));
printf("\n");
}
if(!ExtractVirtFileNames(glob_xmount.input.pp_images[0]->pp_files[0])) {
LOG_ERROR("Couldn't extract virtual file names!\n");
FreeResources();
return 1;
}
LOG_DEBUG("Virtual file names extracted successfully\n")
// Gather infos for info file
if(!InitVirtImageInfoFile()) {
LOG_ERROR("Couldn't gather infos for virtual image info file!\n")
FreeResources();
return 1;
}
LOG_DEBUG("Virtual image info file build successfully\n")
// Do some virtual image type specific initialisations
switch(glob_xmount.output.VirtImageType) {
case VirtImageType_DD:
case VirtImageType_DMG:
break;
case VirtImageType_VDI:
// When mounting as VDI, we need to construct a vdi header
if(!InitVirtVdiHeader()) {
LOG_ERROR("Couldn't initialize virtual VDI file header!\n")
FreeResources();
return 1;
}
LOG_DEBUG("Virtual VDI file header build successfully\n")
break;
case VirtImageType_VHD:
// When mounting as VHD, we need to construct a vhd footer
if(!InitVirtVhdHeader()) {
LOG_ERROR("Couldn't initialize virtual VHD file footer!\n")
FreeResources();
return 1;
}
LOG_DEBUG("Virtual VHD file footer build successfully\n")
break;
case VirtImageType_VMDK:
case VirtImageType_VMDKS:
// When mounting as VMDK, we need to construct the VMDK descriptor file
if(!InitVirtualVmdkFile()) {
LOG_ERROR("Couldn't initialize virtual VMDK file!\n")
FreeResources();
return 1;
}
break;
}
if(glob_xmount.output.writable) {
// Init cache file and cache file block index
if(!InitCacheFile()) {
LOG_ERROR("Couldn't initialize cache file!\n")
FreeResources();
return 1;
}
LOG_DEBUG("Cache file initialized successfully\n")
}
// Call fuse_main to do the fuse magic
fuse_ret=fuse_main(glob_xmount.fuse_argc,
glob_xmount.pp_fuse_argv,
&xmount_operations,
NULL);
// Destroy mutexes
pthread_mutex_destroy(&(glob_xmount.mutex_image_rw));
pthread_mutex_destroy(&(glob_xmount.mutex_info_read));
// Free allocated memory
FreeResources();
return fuse_ret;
}
/*
----- Change log -----
20090131: v0.1.0 released
* Some minor things have still to be done.
* Mounting ewf as dd: Seems to work. Diff didn't complain about
changes between original dd and emulated dd.
* Mounting ewf as vdi: Seems to work too. VBox accepts the emulated
vdi as valid vdi file and I was able to mount the containing fs
under Debian. INFO: Debian freezed when not using mount -r !!
20090203: v0.1.1 released
* Multiple code improvements. For ex. cleaner vdi header allocation.
* Fixed severe bug in image block calculation. Didn't check for odd
input in conversion from bytes to megabytes.
* Added more debug output
20090210: v0.1.2 released
* Fixed compilation problem (Typo in image_init_info() function).
* Fixed some problems with the debian scripts to be able to build
packages.
* Added random generator initialisation (Makes it possible to use
more than one image in VBox at a time).
20090215: * Added function init_cache_blocks which creates / loads a cache
file used to implement virtual write capability.
20090217: * Implemented the fuse write function. Did already some basic tests
with dd and it seems to work. But there are certainly still some
bugs left as there are also still some TODO's left.
20090226: * Changed program name from mountewf to xmount.
* Began with massive code cleanups to ease full implementation of
virtual write support and to be able to support multiple input
image formats (DD, EWF and AFF are planned for now).
* Added defines for supported input formats so it should be possible
to compile xmount without supporting all input formats. (DD
input images are always supported as these do not require any
additional libs). Input formats should later be en/disabled
by the configure script in function to which libs it detects.
* GetOrigImageSize function added to get the size of the original
image whatever type it is in.
* GetOrigImageData function added to retrieve data from original
image file whatever type it is in.
* GetVirtImageSize function added to get the size of the virtual
image file.
* Cleaned function mountewf_getattr and renamed it to
GetVirtFileAttr
* Cleaned function mountewf_readdir and renamed it to GetVirtFiles
* Cleaned function mountewf_open and renamed it to OpenVirtFile
20090227: * Cleaned function init_info_file and renamed it to
InitVirtImageInfoFile
20090228: * Cleaned function init_cache_blocks and renamed it to
InitCacheFile
* Added LogMessage function to ease error and debug logging (See
also LOG_ERROR and LOG_DEBUG macros in xmount.h)
* Cleaned function init_vdi_header and renamed it to
InitVirtVdiHeader
* Added PrintUsage function to print out xmount usage informations
* Cleaned function parse_cmdline and renamed it to ParseCmdLine
* Cleaned function main
* Added ExtractVirtFileNames function to extract virtual file names
from input image name
* Added function GetVirtImageData to retrieve data from the virtual
image file. This includes reading data from cache file if virtual
write support is enabled.
* Added function ReadVirtFile to replace mountewf_read
20090229: * Fixed a typo in virtual file name creation
* Added function SetVirtImageData to write data to virtual image
file. This includes writing data to cache file and caching entire
new blocks
* Added function WriteVirtFile to replace mountewf_write
20090305: * Solved a problem that made it impossible to access offsets >32bit
20090308: * Added SetVdiFileHeaderData function to handle virtual image type
specific data to be cached. This makes cache files independent
from virtual image type
20090316: v0.2.0 released
20090327: v0.2.1 released
* Fixed a bug in virtual write support. Checking whether data is
cached didn't use semaphores. This could corrupt cache files
when running multi-threaded.
* Added IsVdiFileHeaderCached function to check whether VDI file
header was already cached
* Added IsBlockCached function to check whether a block was already
cached
20090331: v0.2.2 released (Internal release)
* Further changes to semaphores to fix write support bug.
20090410: v0.2.3 released
* Reverted most of the fixes from v0.2.1 and v0.2.2 as those did not
solve the write support bug.
* Removed all semaphores
* Added two pthread mutexes to protect virtual image and virtual
info file.
20090508: * Configure script will now exit when needed libraries aren't found
* Added support for newest libewf beta version 20090506 as it seems
to reduce memory usage when working with EWF files by about 1/2.
* Added LIBEWF_BETA define to adept source to new libewf API.
* Added function InitVirtualVmdkFile to build a VmWare virtual disk
descriptor file.
20090519: * Added function CreateVirtDir implementing FUSE's mkdir to allow
VMWare to create his <iname>.vmdk.lck lock folder. Function does
not allow to create other folders!
* Changed cache file handling as VMDK caching will need new cache
file structure incompatible to the old one.
20090522: v0.3.0 released
* Added function DeleteVirtFile and DeleteVirtDir so VMWare can
remove his lock directories and files.
* Added function RenameVirtFile because VMWare needs to rename his
lock files.
* VMDK support should work now but descriptor file won't get cached
as I didn't implement it yet.
20090604: * Added --cache commandline parameter doing the same as --rw.
* Added --owcache commandline parameter doing the same as --rw but
overwrites any existing cache data. This can be handy for
debugging and testing purposes.
* Added "vmdks" output type. Same as "vmdk" but generates a disk
connected to the SCSI bus rather than the IDE bus.
20090710: v0.3.1 released
20090721: * Added function CheckFuseAllowOther to check wether FUSE supports
the "-o allow_other" option. It is supported when
"user_allow_other" is set in /etc/fuse.conf or when running
xmount as root.
* Automatic addition of FUSE's "-o allow_other" option if it is
supported.
* Added special "-o no_allow_other" command line parameter to
disable automatic addition of the above option.
* Reorganisation of FUSE's and xmount's command line options
processing.
* Added LogWarnMessage function to output a warning message.
20090722: * Added function CalculateInputImageHash to calculate an MD5 hash
of the first input image's HASH_AMOUNT bytes of data. This hash is
used as VDI creation UUID and will later be used to match cache
files to input images.
20090724: v0.3.2 released
20090725: v0.4.0 released
* Added AFF input image support.
* Due to various problems with libewf and libaff packages (Mainly
in Debian and Ubuntu), I decided to include them into xmount's
source tree and link them in statically. This has the advantage
that I can use whatever version I want.
20090727: v0.4.1 released
* Added again the ability to compile xmount with shared libs as the
Debian folks don't like the static ones :)
20090812: * Added TXMountConfData.OrigImageSize and
TXMountConfData.VirtImageSize to save the size of the input and
output image in order to avoid regetting it always from disk.
20090814: * Replaced all malloc and realloc occurences with the two macros
XMOUNT_MALLOC and XMOUNT_REALLOC.
20090816: * Replaced where applicable all occurences of str(n)cpy or
alike with their corresponding macros XMOUNT_STRSET, XMOUNT_STRCPY
and XMOUNT_STRNCPY pendants.
20090907: v0.4.2 released
* Fixed a bug in VMDK lock file access. glob_vmdk_lockfile_size
wasn't reset to 0 when the file was deleted.
* Fixed a bug in VMDK descriptor file access. Had to add
glob_vmdk_file_size to track the size of this file as strlen was
a bad idea :).
20100324: v0.4.3 released
* Changed all header structs to prevent different sizes on i386 and
amd64. See xmount.h for more details.
20100810: v0.4.4 released
* Found a bug in InitVirtVdiHeader(). The 64bit values were
addressed incorrectly while filled with rand(). This leads to an
error message when trying to add a VDI file to VirtualBox 3.2.8.
20110210: * Adding subtype and fsname FUSE options in order to display mounted
source in mount command output.
20110211: v0.4.5 released
20111011: * Changes to deal with libewf v2 API (thx to Joachim Metz)
20111109: v0.4.6 released
* Added support for DMG output type (actually a DD with .dmg file
extension). This type is used as default output type when
using xmount under Mac OS X.
20120130: v0.4.7 released
* Made InitVirtImageInfoFile less picky about missing EWF infos.
20120507: * Added support for VHD output image as requested by various people.
* Statically linked libs updated to 20120504 (libewf) and 3.7.0
(afflib).
20120510: v0.5.0 released
* Added stbuf->st_blocks calculation for VHD images in function
GetVirtFileAttr. This makes Windows not think the emulated
file would be a sparse file. Sparse vhd files are not attachable
in Windows.
20130726: v0.6.0 released
* Added libaaff to replace libaff (thx to Guy Voncken).
* Added libdd to replace raw dd input file handling and finally
support split dd files (thx to Guy Voncken).
20140311: * Added libaewf (thx to Guy Voncken).
20140726: * Added support for dynamically loading of input libs. This should
ease adding support for new input image formats in the future.
* Moved input image functions to their corresponding dynamically
loadable libs.
* Prepended "glob_" to all global vars for better identification.
20140731: * Added --offset option as requested by HPM.
* Began massive code cleanup.
20140803: * Added correct return code handling when calling input lib
functions including getting error messages using GetErrorMessage.
* Added input lib specific option parsing.
* Re-implemented InitVirtImageInfoFile() using input lib's
GetInfofileContent() function.
* Further code cleanups.
20140807: * Further code cleanups.
* Renamed GetVirtFileAttr() to FuseGetAttr()
* Renamed CreateVirtDir() to FuseMkDir()
* Renamed CreateVirtDir() to FuseMkNod()
* Renamed OpenVirtFile() to FuseOpen()
* Renamed GetVirtFiles() to FuseReadDir()
* Renamed ReadVirtFile() to FuseRead()
* Renamed RenameVirtFile() to FuseRename()
* Renamed DeleteVirtDir() to FuseRmDir()
* Renamed DeleteVirtFile() to FuseUnlink()
* Renamed WriteVirtFile() to FuseWrite()
* Fixed bug in CalculateInputImageHash() where always HASH_AMOUNT
bytes were hased even if input image is smaller.
* Fixed a newly introduced bug in FuseRead() and GetVirtImageData()
returning -EIO when trying to read behind EOF. The correct return
value is 0.
20140811: * Renamed CheckFuseAllowOther() to CheckFuseSettings() and added a
check to see if user is part of the fuse group.
20140814: * Replaced cuserid() with getpwuid(geteuid()) in CheckFuseSettings()
as it is deprecated on Linux and not available on OSx.
* Only build fuse group checks from CheckFuseSettings() on Linux.
20140820: * Added libxmount_morphing handling.
* Renamed LoadInputLibs() to LoadLibs() and added code to find and
load morphing libs.
* Added FindMorphingLib() function.
20140821: * Changed command line syntax to support specification of multiple
input images of different types.
* Added code in main() to initialize and open multiple input images.
* Added GetMorphedImageSize() and GetMorphedImageData().
20140822: * Removed GetInputImageSize() as it isn't needed anymore.
* Quick test showed morphing using libxmount_morphing_combine seems
to work.
20140825: * Added InitResources() and FreeResources() functions.
*/

File Metadata

Mime Type
text/x-diff
Expires
Wed, Dec 25, 4:09 AM (1 h, 13 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
1177009
Default Alt Text
(307 KB)

Event Timeline