filesystem.h revision 16d88d830ef752a36859782df24431321e0b882b
16d88d830ef752a36859782df24431321e0b882bvboxsync/* $Id$ */
16d88d830ef752a36859782df24431321e0b882bvboxsync/** @file
16d88d830ef752a36859782df24431321e0b882bvboxsync * IPRT - Filesystem implementations.
16d88d830ef752a36859782df24431321e0b882bvboxsync */
16d88d830ef752a36859782df24431321e0b882bvboxsync
16d88d830ef752a36859782df24431321e0b882bvboxsync/*
16d88d830ef752a36859782df24431321e0b882bvboxsync * Copyright (C) 2012 Oracle Corporation
16d88d830ef752a36859782df24431321e0b882bvboxsync *
16d88d830ef752a36859782df24431321e0b882bvboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
16d88d830ef752a36859782df24431321e0b882bvboxsync * available from http://www.virtualbox.org. This file is free software;
16d88d830ef752a36859782df24431321e0b882bvboxsync * you can redistribute it and/or modify it under the terms of the GNU
16d88d830ef752a36859782df24431321e0b882bvboxsync * General Public License (GPL) as published by the Free Software
16d88d830ef752a36859782df24431321e0b882bvboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
16d88d830ef752a36859782df24431321e0b882bvboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
16d88d830ef752a36859782df24431321e0b882bvboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16d88d830ef752a36859782df24431321e0b882bvboxsync *
16d88d830ef752a36859782df24431321e0b882bvboxsync * The contents of this file may alternatively be used under the terms
16d88d830ef752a36859782df24431321e0b882bvboxsync * of the Common Development and Distribution License Version 1.0
16d88d830ef752a36859782df24431321e0b882bvboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
16d88d830ef752a36859782df24431321e0b882bvboxsync * VirtualBox OSE distribution, in which case the provisions of the
16d88d830ef752a36859782df24431321e0b882bvboxsync * CDDL are applicable instead of those of the GPL.
16d88d830ef752a36859782df24431321e0b882bvboxsync *
16d88d830ef752a36859782df24431321e0b882bvboxsync * You may elect to license modified versions of this file under the
16d88d830ef752a36859782df24431321e0b882bvboxsync * terms and conditions of either the GPL or the CDDL or both.
16d88d830ef752a36859782df24431321e0b882bvboxsync */
16d88d830ef752a36859782df24431321e0b882bvboxsync
16d88d830ef752a36859782df24431321e0b882bvboxsync#ifndef ___internal_filesystem_h
16d88d830ef752a36859782df24431321e0b882bvboxsync#define ___internal_filesystem_h
16d88d830ef752a36859782df24431321e0b882bvboxsync
16d88d830ef752a36859782df24431321e0b882bvboxsync#include <iprt/types.h>
16d88d830ef752a36859782df24431321e0b882bvboxsync#include <iprt/err.h>
16d88d830ef752a36859782df24431321e0b882bvboxsync#include <iprt/assert.h>
16d88d830ef752a36859782df24431321e0b882bvboxsync#include "internal/magics.h"
16d88d830ef752a36859782df24431321e0b882bvboxsync
16d88d830ef752a36859782df24431321e0b882bvboxsyncRT_C_DECLS_BEGIN
16d88d830ef752a36859782df24431321e0b882bvboxsync
16d88d830ef752a36859782df24431321e0b882bvboxsync/** A filesystem format handle. */
16d88d830ef752a36859782df24431321e0b882bvboxsynctypedef struct RTFILESYSTEMFMTINT *RTFILESYSTEMFMT;
16d88d830ef752a36859782df24431321e0b882bvboxsync/** Pointer to a filesystem format handle. */
16d88d830ef752a36859782df24431321e0b882bvboxsynctypedef RTFILESYSTEMFMT *PRTFILESYSTEMFMT;
16d88d830ef752a36859782df24431321e0b882bvboxsync/** NIL filesystem format handle. */
16d88d830ef752a36859782df24431321e0b882bvboxsync#define NIL_RTFILESYSTEMFMT ((RTFILESYSTEMFMT)~0)
16d88d830ef752a36859782df24431321e0b882bvboxsync
16d88d830ef752a36859782df24431321e0b882bvboxsync/** A medium handle. */
16d88d830ef752a36859782df24431321e0b882bvboxsynctypedef struct RTFILESYSTEMMEDIUMINT *RTFILESYSTEMMEDIUM;
16d88d830ef752a36859782df24431321e0b882bvboxsync/** Pointer to a medium handle. */
16d88d830ef752a36859782df24431321e0b882bvboxsynctypedef RTFILESYSTEMMEDIUM *PRTFILESYSTEMMEDIUM;
16d88d830ef752a36859782df24431321e0b882bvboxsync
16d88d830ef752a36859782df24431321e0b882bvboxsync/** Score to indicate that the backend can't handle the format at all */
16d88d830ef752a36859782df24431321e0b882bvboxsync#define RTFILESYSTEM_MATCH_SCORE_UNSUPPORTED 0
16d88d830ef752a36859782df24431321e0b882bvboxsync/** Score to indicate that a backend supports the format
16d88d830ef752a36859782df24431321e0b882bvboxsync * but there can be other backends. */
16d88d830ef752a36859782df24431321e0b882bvboxsync#define RTFILESYSTEM_MATCH_SCORE_SUPPORTED (UINT32_MAX/2)
16d88d830ef752a36859782df24431321e0b882bvboxsync/** Score to indicate a perfect match. */
16d88d830ef752a36859782df24431321e0b882bvboxsync#define RTFILESYSTEM_MATCH_SCORE_PERFECT UINT32_MAX
16d88d830ef752a36859782df24431321e0b882bvboxsync
16d88d830ef752a36859782df24431321e0b882bvboxsync/**
16d88d830ef752a36859782df24431321e0b882bvboxsync * Filesystem format operations.
16d88d830ef752a36859782df24431321e0b882bvboxsync */
16d88d830ef752a36859782df24431321e0b882bvboxsynctypedef struct RTFILESYSTEMFMTOPS
16d88d830ef752a36859782df24431321e0b882bvboxsync{
16d88d830ef752a36859782df24431321e0b882bvboxsync /** Name of the format. */
16d88d830ef752a36859782df24431321e0b882bvboxsync const char *pcszFmt;
16d88d830ef752a36859782df24431321e0b882bvboxsync
16d88d830ef752a36859782df24431321e0b882bvboxsync /**
16d88d830ef752a36859782df24431321e0b882bvboxsync * Probes the given disk for known structures.
16d88d830ef752a36859782df24431321e0b882bvboxsync *
16d88d830ef752a36859782df24431321e0b882bvboxsync * @returns IPRT status code.
16d88d830ef752a36859782df24431321e0b882bvboxsync * @param hMedium Medium handle.
16d88d830ef752a36859782df24431321e0b882bvboxsync * @param puScore Where to store the match score on success.
16d88d830ef752a36859782df24431321e0b882bvboxsync */
16d88d830ef752a36859782df24431321e0b882bvboxsync DECLCALLBACKMEMBER(int, pfnProbe)(RTFILESYSTEMMEDIUM hMedium, uint32_t *puScore);
16d88d830ef752a36859782df24431321e0b882bvboxsync
16d88d830ef752a36859782df24431321e0b882bvboxsync /**
16d88d830ef752a36859782df24431321e0b882bvboxsync * Opens the format to set up all structures.
16d88d830ef752a36859782df24431321e0b882bvboxsync *
16d88d830ef752a36859782df24431321e0b882bvboxsync * @returns IPRT status code.
16d88d830ef752a36859782df24431321e0b882bvboxsync * @param hMedium Medium handle.
16d88d830ef752a36859782df24431321e0b882bvboxsync * @param phFileSysFmt Where to store the filesystem format instance on success.
16d88d830ef752a36859782df24431321e0b882bvboxsync */
16d88d830ef752a36859782df24431321e0b882bvboxsync DECLCALLBACKMEMBER(int, pfnOpen)(RTFILESYSTEMMEDIUM hMedium, PRTFILESYSTEMFMT phFsFmt);
16d88d830ef752a36859782df24431321e0b882bvboxsync
16d88d830ef752a36859782df24431321e0b882bvboxsync /**
16d88d830ef752a36859782df24431321e0b882bvboxsync * Closes the filesystem format.
16d88d830ef752a36859782df24431321e0b882bvboxsync *
16d88d830ef752a36859782df24431321e0b882bvboxsync * @returns IPRT status code.
16d88d830ef752a36859782df24431321e0b882bvboxsync * @param hFsFmt The format specific filesystem handle.
16d88d830ef752a36859782df24431321e0b882bvboxsync */
16d88d830ef752a36859782df24431321e0b882bvboxsync DECLCALLBACKMEMBER(int, pfnClose)(RTFILESYSTEMFMT hFsFmt);
16d88d830ef752a36859782df24431321e0b882bvboxsync
16d88d830ef752a36859782df24431321e0b882bvboxsync /**
16d88d830ef752a36859782df24431321e0b882bvboxsync * Returns block size of the given filesystem.
16d88d830ef752a36859782df24431321e0b882bvboxsync *
16d88d830ef752a36859782df24431321e0b882bvboxsync * @returns Block size of filesystem.
16d88d830ef752a36859782df24431321e0b882bvboxsync * @param hFsFmt The format specific filesystem handle.
16d88d830ef752a36859782df24431321e0b882bvboxsync */
16d88d830ef752a36859782df24431321e0b882bvboxsync DECLCALLBACKMEMBER(uint64_t, pfnGetBlockSize)(RTFILESYSTEMFMT hFsFmt);
16d88d830ef752a36859782df24431321e0b882bvboxsync
16d88d830ef752a36859782df24431321e0b882bvboxsync /**
16d88d830ef752a36859782df24431321e0b882bvboxsync * Query the use of the given range in the filesystem.
16d88d830ef752a36859782df24431321e0b882bvboxsync *
16d88d830ef752a36859782df24431321e0b882bvboxsync * @returns IPRT status code.
16d88d830ef752a36859782df24431321e0b882bvboxsync * @param hFsFmt The format specific filesystem handle.
16d88d830ef752a36859782df24431321e0b882bvboxsync * @param offStart Start offset to check.
16d88d830ef752a36859782df24431321e0b882bvboxsync * @param cb Size of the range to check.
16d88d830ef752a36859782df24431321e0b882bvboxsync * @param pfUsed Where to store whether the range is in use
16d88d830ef752a36859782df24431321e0b882bvboxsync * by the filesystem.
16d88d830ef752a36859782df24431321e0b882bvboxsync */
16d88d830ef752a36859782df24431321e0b882bvboxsync DECLCALLBACKMEMBER(int, pfnQueryRangeUse)(RTFILESYSTEMFMT hFsFmt, uint64_t offStart,
16d88d830ef752a36859782df24431321e0b882bvboxsync size_t cb, bool *pfUsed);
16d88d830ef752a36859782df24431321e0b882bvboxsync
16d88d830ef752a36859782df24431321e0b882bvboxsync} RTFILESYSTEMFMTOPS;
16d88d830ef752a36859782df24431321e0b882bvboxsync/** Pointer to a filesystem format ops table. */
16d88d830ef752a36859782df24431321e0b882bvboxsynctypedef RTFILESYSTEMFMTOPS *PRTFILESYSTEMFMTOPS;
16d88d830ef752a36859782df24431321e0b882bvboxsync/** Pointer to a const filesystem format ops table. */
16d88d830ef752a36859782df24431321e0b882bvboxsynctypedef const RTFILESYSTEMFMTOPS *PCRTFILESYSTEMFMTOPS;
16d88d830ef752a36859782df24431321e0b882bvboxsync
16d88d830ef752a36859782df24431321e0b882bvboxsync/** Converts a LBA number to the byte offset. */
16d88d830ef752a36859782df24431321e0b882bvboxsync#define RTFILESYSTEM_LBA2BYTE(lba, disk) ((lba) * (disk)->cbSector)
16d88d830ef752a36859782df24431321e0b882bvboxsync/** Converts a Byte offset to the LBA number. */
16d88d830ef752a36859782df24431321e0b882bvboxsync#define RTFILESYSTEM_BYTE2LBA(off, disk) ((off) / (disk)->cbSector)
16d88d830ef752a36859782df24431321e0b882bvboxsync
16d88d830ef752a36859782df24431321e0b882bvboxsync/**
16d88d830ef752a36859782df24431321e0b882bvboxsync * Return size of the medium in bytes.
16d88d830ef752a36859782df24431321e0b882bvboxsync *
16d88d830ef752a36859782df24431321e0b882bvboxsync * @returns Size of the medium in bytes.
16d88d830ef752a36859782df24431321e0b882bvboxsync * @param hMedium The medium handle.
16d88d830ef752a36859782df24431321e0b882bvboxsync */
16d88d830ef752a36859782df24431321e0b882bvboxsyncDECLHIDDEN(uint64_t) rtFilesystemMediumGetSize(RTFILESYSTEMMEDIUM hMedium);
16d88d830ef752a36859782df24431321e0b882bvboxsync
16d88d830ef752a36859782df24431321e0b882bvboxsync/**
16d88d830ef752a36859782df24431321e0b882bvboxsync * Read from the medium at the given offset.
16d88d830ef752a36859782df24431321e0b882bvboxsync *
16d88d830ef752a36859782df24431321e0b882bvboxsync * @returns IPRT status code.
16d88d830ef752a36859782df24431321e0b882bvboxsync * @param hMedium The medium handle to read from.
16d88d830ef752a36859782df24431321e0b882bvboxsync * @param off Start offset.
16d88d830ef752a36859782df24431321e0b882bvboxsync * @param pvBuf Destination buffer.
16d88d830ef752a36859782df24431321e0b882bvboxsync * @param cbRead How much to read.
16d88d830ef752a36859782df24431321e0b882bvboxsync */
16d88d830ef752a36859782df24431321e0b882bvboxsyncDECLHIDDEN(int) rtFilesystemMediumRead(RTFILESYSTEMMEDIUM hMedium, uint64_t off,
16d88d830ef752a36859782df24431321e0b882bvboxsync void *pvBuf, size_t cbRead);
16d88d830ef752a36859782df24431321e0b882bvboxsync
16d88d830ef752a36859782df24431321e0b882bvboxsync/**
16d88d830ef752a36859782df24431321e0b882bvboxsync * Write to the disk at the given offset.
16d88d830ef752a36859782df24431321e0b882bvboxsync *
16d88d830ef752a36859782df24431321e0b882bvboxsync * @returns IPRT status code.
16d88d830ef752a36859782df24431321e0b882bvboxsync * @param hMedium The medium handle to write to.
16d88d830ef752a36859782df24431321e0b882bvboxsync * @param off Start offset.
16d88d830ef752a36859782df24431321e0b882bvboxsync * @param pvBuf Source buffer.
16d88d830ef752a36859782df24431321e0b882bvboxsync * @param cbWrite How much to write.
16d88d830ef752a36859782df24431321e0b882bvboxsync */
16d88d830ef752a36859782df24431321e0b882bvboxsyncDECLHIDDEN(int) rtFilesystemMediumWrite(RTFILESYSTEMMEDIUM hMedium, uint64_t off,
16d88d830ef752a36859782df24431321e0b882bvboxsync const void *pvBuf, size_t cbWrite);
16d88d830ef752a36859782df24431321e0b882bvboxsync
16d88d830ef752a36859782df24431321e0b882bvboxsyncRT_C_DECLS_END
16d88d830ef752a36859782df24431321e0b882bvboxsync
16d88d830ef752a36859782df24431321e0b882bvboxsync#endif /* !__internal_filesystem_h */
16d88d830ef752a36859782df24431321e0b882bvboxsync