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>
54d2d2606d7c83a456819cd038a73e0f9a600ca4vboxsync#include <iprt/vfslowlevel.h>
16d88d830ef752a36859782df24431321e0b882bvboxsync#include "internal/magics.h"
16d88d830ef752a36859782df24431321e0b882bvboxsync
16d88d830ef752a36859782df24431321e0b882bvboxsyncRT_C_DECLS_BEGIN
16d88d830ef752a36859782df24431321e0b882bvboxsync
54d2d2606d7c83a456819cd038a73e0f9a600ca4vboxsync/*******************************************************************************
54d2d2606d7c83a456819cd038a73e0f9a600ca4vboxsync* Structures and Typedefs *
54d2d2606d7c83a456819cd038a73e0f9a600ca4vboxsync*******************************************************************************/
16d88d830ef752a36859782df24431321e0b882bvboxsync
54d2d2606d7c83a456819cd038a73e0f9a600ca4vboxsync/** Filesystem format specific initialization structure. */
54d2d2606d7c83a456819cd038a73e0f9a600ca4vboxsynctypedef DECLCALLBACK(int) FNRTFILESYSTEMINIT(void *pvThis, RTVFSFILE hVfsFile);
54d2d2606d7c83a456819cd038a73e0f9a600ca4vboxsync/** Pointer to a format specific initialization structure. */
54d2d2606d7c83a456819cd038a73e0f9a600ca4vboxsynctypedef FNRTFILESYSTEMINIT *PFNRTFILESYSTEMINIT;
16d88d830ef752a36859782df24431321e0b882bvboxsync
16d88d830ef752a36859782df24431321e0b882bvboxsync#define RTFILESYSTEM_MATCH_SCORE_UNSUPPORTED 0
54d2d2606d7c83a456819cd038a73e0f9a600ca4vboxsync#define RTFILESYSTEM_MATCH_SCORE_SUPPORTED UINT32_MAX
16d88d830ef752a36859782df24431321e0b882bvboxsync
16d88d830ef752a36859782df24431321e0b882bvboxsync/**
54d2d2606d7c83a456819cd038a73e0f9a600ca4vboxsync * Filesystem descriptor.
16d88d830ef752a36859782df24431321e0b882bvboxsync */
54d2d2606d7c83a456819cd038a73e0f9a600ca4vboxsynctypedef struct RTFILESYSTEMDESC
16d88d830ef752a36859782df24431321e0b882bvboxsync{
54d2d2606d7c83a456819cd038a73e0f9a600ca4vboxsync /** Size of the filesystem specific state in bytes. */
54d2d2606d7c83a456819cd038a73e0f9a600ca4vboxsync size_t cbFs;
54d2d2606d7c83a456819cd038a73e0f9a600ca4vboxsync /** Pointer to the VFS vtable. */
54d2d2606d7c83a456819cd038a73e0f9a600ca4vboxsync RTVFSOPS VfsOps;
16d88d830ef752a36859782df24431321e0b882bvboxsync
16d88d830ef752a36859782df24431321e0b882bvboxsync /**
54d2d2606d7c83a456819cd038a73e0f9a600ca4vboxsync * Probes the underlying for a known filesystem.
16d88d830ef752a36859782df24431321e0b882bvboxsync *
16d88d830ef752a36859782df24431321e0b882bvboxsync * @returns IPRT status code.
54d2d2606d7c83a456819cd038a73e0f9a600ca4vboxsync * @param hVfsFile VFS file handle of the underlying medium.
54d2d2606d7c83a456819cd038a73e0f9a600ca4vboxsync * @param puScore Where to store the match score on success.
16d88d830ef752a36859782df24431321e0b882bvboxsync */
54d2d2606d7c83a456819cd038a73e0f9a600ca4vboxsync DECLCALLBACKMEMBER(int, pfnProbe) (RTVFSFILE hVfsFile, uint32_t *puScore);
16d88d830ef752a36859782df24431321e0b882bvboxsync
16d88d830ef752a36859782df24431321e0b882bvboxsync /**
54d2d2606d7c83a456819cd038a73e0f9a600ca4vboxsync * Initializes the given filesystem state.
16d88d830ef752a36859782df24431321e0b882bvboxsync *
16d88d830ef752a36859782df24431321e0b882bvboxsync * @returns IPRT status code.
54d2d2606d7c83a456819cd038a73e0f9a600ca4vboxsync * @param pvThis Uninitialized filesystem state.
54d2d2606d7c83a456819cd038a73e0f9a600ca4vboxsync * @param hVfsFile VFS file handle of the underlying medium.
16d88d830ef752a36859782df24431321e0b882bvboxsync */
54d2d2606d7c83a456819cd038a73e0f9a600ca4vboxsync DECLCALLBACKMEMBER(int, pfnInit) (void *pvThis, RTVFSFILE hVfsFile);
16d88d830ef752a36859782df24431321e0b882bvboxsync
54d2d2606d7c83a456819cd038a73e0f9a600ca4vboxsync} RTFILESYSTEMDESC;
54d2d2606d7c83a456819cd038a73e0f9a600ca4vboxsync/** Pointer to a filesystem descriptor. */
54d2d2606d7c83a456819cd038a73e0f9a600ca4vboxsynctypedef RTFILESYSTEMDESC *PRTFILESYSTEMDESC;
54d2d2606d7c83a456819cd038a73e0f9a600ca4vboxsynctypedef const RTFILESYSTEMDESC *PCRTFILESYSTEMDESC;
16d88d830ef752a36859782df24431321e0b882bvboxsync
54d2d2606d7c83a456819cd038a73e0f9a600ca4vboxsyncextern DECLHIDDEN(RTFILESYSTEMDESC const) g_rtFsExt;
16d88d830ef752a36859782df24431321e0b882bvboxsync
16d88d830ef752a36859782df24431321e0b882bvboxsyncRT_C_DECLS_END
16d88d830ef752a36859782df24431321e0b882bvboxsync
16d88d830ef752a36859782df24431321e0b882bvboxsync#endif /* !__internal_filesystem_h */
16d88d830ef752a36859782df24431321e0b882bvboxsync