| 1 | /* $Id: filesystem.h 62477 2016-07-22 18:27:37Z vboxsync $ */
|
|---|
| 2 | /** @file
|
|---|
| 3 | * IPRT - Filesystem implementations.
|
|---|
| 4 | */
|
|---|
| 5 |
|
|---|
| 6 | /*
|
|---|
| 7 | * Copyright (C) 2012-2016 Oracle Corporation
|
|---|
| 8 | *
|
|---|
| 9 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
|---|
| 10 | * available from http://www.virtualbox.org. This file is free software;
|
|---|
| 11 | * you can redistribute it and/or modify it under the terms of the GNU
|
|---|
| 12 | * General Public License (GPL) as published by the Free Software
|
|---|
| 13 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
|---|
| 14 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
|---|
| 15 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
|---|
| 16 | *
|
|---|
| 17 | * The contents of this file may alternatively be used under the terms
|
|---|
| 18 | * of the Common Development and Distribution License Version 1.0
|
|---|
| 19 | * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
|
|---|
| 20 | * VirtualBox OSE distribution, in which case the provisions of the
|
|---|
| 21 | * CDDL are applicable instead of those of the GPL.
|
|---|
| 22 | *
|
|---|
| 23 | * You may elect to license modified versions of this file under the
|
|---|
| 24 | * terms and conditions of either the GPL or the CDDL or both.
|
|---|
| 25 | */
|
|---|
| 26 |
|
|---|
| 27 | #ifndef ___internal_filesystem_h
|
|---|
| 28 | #define ___internal_filesystem_h
|
|---|
| 29 |
|
|---|
| 30 | #include <iprt/types.h>
|
|---|
| 31 | #include <iprt/err.h>
|
|---|
| 32 | #include <iprt/assert.h>
|
|---|
| 33 | #include <iprt/vfslowlevel.h>
|
|---|
| 34 | #include "internal/magics.h"
|
|---|
| 35 |
|
|---|
| 36 | RT_C_DECLS_BEGIN
|
|---|
| 37 |
|
|---|
| 38 | /*******************************************************************************
|
|---|
| 39 | * Structures and Typedefs *
|
|---|
| 40 | *******************************************************************************/
|
|---|
| 41 |
|
|---|
| 42 | /** Filesystem format specific initialization structure. */
|
|---|
| 43 | typedef DECLCALLBACK(int) FNRTFILESYSTEMINIT(void *pvThis, RTVFSFILE hVfsFile);
|
|---|
| 44 | /** Pointer to a format specific initialization structure. */
|
|---|
| 45 | typedef FNRTFILESYSTEMINIT *PFNRTFILESYSTEMINIT;
|
|---|
| 46 |
|
|---|
| 47 | #define RTFILESYSTEM_MATCH_SCORE_UNSUPPORTED 0
|
|---|
| 48 | #define RTFILESYSTEM_MATCH_SCORE_SUPPORTED UINT32_MAX
|
|---|
| 49 |
|
|---|
| 50 | /**
|
|---|
| 51 | * Filesystem descriptor.
|
|---|
| 52 | */
|
|---|
| 53 | typedef struct RTFILESYSTEMDESC
|
|---|
| 54 | {
|
|---|
| 55 | /** Size of the filesystem specific state in bytes. */
|
|---|
| 56 | size_t cbFs;
|
|---|
| 57 | /** Pointer to the VFS vtable. */
|
|---|
| 58 | RTVFSOPS VfsOps;
|
|---|
| 59 |
|
|---|
| 60 | /**
|
|---|
| 61 | * Probes the underlying for a known filesystem.
|
|---|
| 62 | *
|
|---|
| 63 | * @returns IPRT status code.
|
|---|
| 64 | * @param hVfsFile VFS file handle of the underlying medium.
|
|---|
| 65 | * @param puScore Where to store the match score on success.
|
|---|
| 66 | */
|
|---|
| 67 | DECLCALLBACKMEMBER(int, pfnProbe) (RTVFSFILE hVfsFile, uint32_t *puScore);
|
|---|
| 68 |
|
|---|
| 69 | /**
|
|---|
| 70 | * Initializes the given filesystem state.
|
|---|
| 71 | *
|
|---|
| 72 | * @returns IPRT status code.
|
|---|
| 73 | * @param pvThis Uninitialized filesystem state.
|
|---|
| 74 | * @param hVfsFile VFS file handle of the underlying medium.
|
|---|
| 75 | */
|
|---|
| 76 | DECLCALLBACKMEMBER(int, pfnInit) (void *pvThis, RTVFSFILE hVfsFile);
|
|---|
| 77 |
|
|---|
| 78 | } RTFILESYSTEMDESC;
|
|---|
| 79 | /** Pointer to a filesystem descriptor. */
|
|---|
| 80 | typedef RTFILESYSTEMDESC *PRTFILESYSTEMDESC;
|
|---|
| 81 | typedef const RTFILESYSTEMDESC *PCRTFILESYSTEMDESC;
|
|---|
| 82 |
|
|---|
| 83 | extern DECLHIDDEN(RTFILESYSTEMDESC const) g_rtFsExt;
|
|---|
| 84 |
|
|---|
| 85 | RT_C_DECLS_END
|
|---|
| 86 |
|
|---|
| 87 | #endif /* !__internal_filesystem_h */
|
|---|
| 88 |
|
|---|
