| 1 | /** @file
|
|---|
| 2 | * IPRT - Extensible Archiver (XAR) format.
|
|---|
| 3 | */
|
|---|
| 4 |
|
|---|
| 5 | /*
|
|---|
| 6 | * Copyright (C) 2013-2022 Oracle Corporation
|
|---|
| 7 | *
|
|---|
| 8 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
|---|
| 9 | * available from http://www.virtualbox.org. This file is free software;
|
|---|
| 10 | * you can redistribute it and/or modify it under the terms of the GNU
|
|---|
| 11 | * General Public License (GPL) as published by the Free Software
|
|---|
| 12 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
|---|
| 13 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
|---|
| 14 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
|---|
| 15 | *
|
|---|
| 16 | * The contents of this file may alternatively be used under the terms
|
|---|
| 17 | * of the Common Development and Distribution License Version 1.0
|
|---|
| 18 | * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
|
|---|
| 19 | * VirtualBox OSE distribution, in which case the provisions of the
|
|---|
| 20 | * CDDL are applicable instead of those of the GPL.
|
|---|
| 21 | *
|
|---|
| 22 | * You may elect to license modified versions of this file under the
|
|---|
| 23 | * terms and conditions of either the GPL or the CDDL or both.
|
|---|
| 24 | */
|
|---|
| 25 |
|
|---|
| 26 | #ifndef IPRT_INCLUDED_formats_xar_h
|
|---|
| 27 | #define IPRT_INCLUDED_formats_xar_h
|
|---|
| 28 | #ifndef RT_WITHOUT_PRAGMA_ONCE
|
|---|
| 29 | # pragma once
|
|---|
| 30 | #endif
|
|---|
| 31 |
|
|---|
| 32 | #include <iprt/types.h>
|
|---|
| 33 | #include <iprt/assertcompile.h>
|
|---|
| 34 |
|
|---|
| 35 |
|
|---|
| 36 | /** @defgroup grp_rt_formats_xar Extensible Archive (XAR) format
|
|---|
| 37 | * @ingroup grp_rt_formats
|
|---|
| 38 | *
|
|---|
| 39 | * @{ */
|
|---|
| 40 |
|
|---|
| 41 | #pragma pack(4) /* Misdesigned header, not 8-byte aligned size. */
|
|---|
| 42 | typedef struct XARHEADER
|
|---|
| 43 | {
|
|---|
| 44 | /** The magic number 'xar!' (XAR_HEADER_MAGIC). */
|
|---|
| 45 | uint32_t u32Magic;
|
|---|
| 46 | /** The size of this header structure. */
|
|---|
| 47 | uint16_t cbHeader;
|
|---|
| 48 | /** The header version structure. */
|
|---|
| 49 | uint16_t uVersion;
|
|---|
| 50 | /** The size of the compressed table of content (TOC). */
|
|---|
| 51 | uint64_t cbTocCompressed;
|
|---|
| 52 | /** The size of the table of context (TOC) when not compressed. */
|
|---|
| 53 | uint64_t cbTocUncompressed;
|
|---|
| 54 | /** Which cryptographic hash function is used (XAR_HASH_XXX). */
|
|---|
| 55 | uint32_t uHashFunction;
|
|---|
| 56 | } XARHEADER;
|
|---|
| 57 | #pragma pack()
|
|---|
| 58 | AssertCompileSize(XARHEADER, 28);
|
|---|
| 59 | /** Pointer to a XAR header. */
|
|---|
| 60 | typedef XARHEADER *PXARHEADER;
|
|---|
| 61 | /** Pointer to a const XAR header. */
|
|---|
| 62 | typedef XARHEADER const *PCXARHEADER;
|
|---|
| 63 |
|
|---|
| 64 | /** XAR magic value (on disk endian). */
|
|---|
| 65 | #define XAR_HEADER_MAGIC RT_H2LE_U32(RT_MAKE_U32_FROM_U8('x', 'a', 'r', '!'))
|
|---|
| 66 | /** The current header version value (host endian). */
|
|---|
| 67 | #define XAR_HEADER_VERSION 1
|
|---|
| 68 |
|
|---|
| 69 | /** @name XAR hashing functions.
|
|---|
| 70 | * @{ */
|
|---|
| 71 | #define XAR_HASH_NONE 0
|
|---|
| 72 | #define XAR_HASH_SHA1 1
|
|---|
| 73 | #define XAR_HASH_MD5 2
|
|---|
| 74 | #define XAR_HASH_MAX 2
|
|---|
| 75 | /** @} */
|
|---|
| 76 |
|
|---|
| 77 | /** @} */
|
|---|
| 78 |
|
|---|
| 79 | #endif /* !IPRT_INCLUDED_formats_xar_h */
|
|---|
| 80 |
|
|---|
