summaryrefslogtreecommitdiff
path: root/include/iprt
diff options
context:
space:
mode:
Diffstat (limited to 'include/iprt')
-rw-r--r--include/iprt/formats/tar.h399
-rw-r--r--include/iprt/tar.h184
2 files changed, 399 insertions, 184 deletions
diff --git a/include/iprt/formats/tar.h b/include/iprt/formats/tar.h
new file mode 100644
index 00000000000..4a4235bc2fd
--- /dev/null
+++ b/include/iprt/formats/tar.h
@@ -0,0 +1,399 @@
+/* $Id$ */
+/** @file
+ * IPRT - TAR Virtual Filesystem.
+ */
+
+/*
+ * Copyright (C) 2010-2023 Oracle and/or its affiliates.
+ *
+ * This file is part of VirtualBox base platform packages, as
+ * available from https://www.virtualbox.org.
+ *
+ * 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, in version 3 of the
+ * License.
+ *
+ * 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 <https://www.gnu.org/licenses>.
+ *
+ * The contents of this file may alternatively be used under the terms
+ * of the Common Development and Distribution License Version 1.0
+ * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
+ * in the VirtualBox distribution, in which case the provisions of the
+ * CDDL are applicable instead of those of the GPL.
+ *
+ * You may elect to license modified versions of this file under the
+ * terms and conditions of either the GPL or the CDDL or both.
+ *
+ * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
+ */
+
+#ifndef IPRT_INCLUDED_SRC_common_zip_tar_h
+#define IPRT_INCLUDED_SRC_common_zip_tar_h
+#ifndef RT_WITHOUT_PRAGMA_ONCE
+# pragma once
+#endif
+
+#include <iprt/assert.h>
+
+/** @name RTZIPTARHDRPOSIX::typeflag
+ * @{ */
+#define RTZIPTAR_TF_OLDNORMAL '\0' /**< Normal disk file, Unix compatible */
+#define RTZIPTAR_TF_NORMAL '0' /**< Normal disk file */
+#define RTZIPTAR_TF_LINK '1' /**< Link to previously dumped file */
+#define RTZIPTAR_TF_SYMLINK '2' /**< Symbolic link */
+#define RTZIPTAR_TF_CHR '3' /**< Character special file */
+#define RTZIPTAR_TF_BLK '4' /**< Block special file */
+#define RTZIPTAR_TF_DIR '5' /**< Directory */
+#define RTZIPTAR_TF_FIFO '6' /**< FIFO special file */
+#define RTZIPTAR_TF_CONTIG '7' /**< Contiguous file */
+
+#define RTZIPTAR_TF_X_HDR 'x' /**< Extended header. */
+#define RTZIPTAR_TF_X_GLOBAL 'g' /**< Global extended header. */
+
+#define RTZIPTAR_TF_SOLARIS_XHDR 'X'
+
+#define RTZIPTAR_TF_GNU_DUMPDIR 'D'
+#define RTZIPTAR_TF_GNU_LONGLINK 'K' /**< GNU long link header. */
+#define RTZIPTAR_TF_GNU_LONGNAME 'L' /**< GNU long name header. */
+#define RTZIPTAR_TF_GNU_MULTIVOL 'M'
+#define RTZIPTAR_TF_GNU_SPARSE 'S'
+#define RTZIPTAR_TF_GNU_VOLDHR 'V'
+/** @} */
+
+/** Maximum length of a tar filename, excluding the terminating '\0'. More
+ * does not fit into a tar record. */
+#define RTZIPTAR_NAME_MAX 99
+
+
+/**
+ * The ancient tar header.
+ *
+ * The posix and gnu headers are compatible with the members up to and including
+ * link name, from there on they differ.
+ */
+typedef struct RTZIPTARHDRANCIENT
+{
+ char name[100];
+ char mode[8];
+ char uid[8];
+ char gid[8];
+ char size[12];
+ char mtime[12];
+ char chksum[8];
+ char typeflag;
+ char linkname[100]; /**< Was called linkflag. */
+ char unused[8+64+16+155+12];
+} RTZIPTARHDRANCIENT;
+AssertCompileSize(RTZIPTARHDRANCIENT, 512);
+AssertCompileMemberOffset(RTZIPTARHDRANCIENT, name, 0);
+AssertCompileMemberOffset(RTZIPTARHDRANCIENT, mode, 100);
+AssertCompileMemberOffset(RTZIPTARHDRANCIENT, uid, 108);
+AssertCompileMemberOffset(RTZIPTARHDRANCIENT, gid, 116);
+AssertCompileMemberOffset(RTZIPTARHDRANCIENT, size, 124);
+AssertCompileMemberOffset(RTZIPTARHDRANCIENT, mtime, 136);
+AssertCompileMemberOffset(RTZIPTARHDRANCIENT, chksum, 148);
+AssertCompileMemberOffset(RTZIPTARHDRANCIENT, typeflag, 156);
+AssertCompileMemberOffset(RTZIPTARHDRANCIENT, linkname, 157);
+AssertCompileMemberOffset(RTZIPTARHDRANCIENT, unused, 257);
+
+
+/** The uniform standard tape archive format magic value. */
+#define RTZIPTAR_USTAR_MAGIC "ustar"
+/** The ustar version string.
+ * @remarks The terminator character is not part of the field. */
+#define RTZIPTAR_USTAR_VERSION "00"
+
+/** The GNU magic + version value. */
+#define RTZIPTAR_GNU_MAGIC "ustar "
+
+
+/**
+ * The posix header (according to SuS).
+ */
+typedef struct RTZIPTARHDRPOSIX
+{
+ char name[100];
+ char mode[8];
+ char uid[8];
+ char gid[8];
+ char size[12];
+ char mtime[12];
+ char chksum[8];
+ char typeflag;
+ char linkname[100];
+ char magic[6];
+ char version[2];
+ char uname[32];
+ char gname[32];
+ char devmajor[8];
+ char devminor[8];
+ char prefix[155];
+ char unused[12];
+} RTZIPTARHDRPOSIX;
+AssertCompileSize(RTZIPTARHDRPOSIX, 512);
+AssertCompileMemberOffset(RTZIPTARHDRPOSIX, name, 0);
+AssertCompileMemberOffset(RTZIPTARHDRPOSIX, mode, 100);
+AssertCompileMemberOffset(RTZIPTARHDRPOSIX, uid, 108);
+AssertCompileMemberOffset(RTZIPTARHDRPOSIX, gid, 116);
+AssertCompileMemberOffset(RTZIPTARHDRPOSIX, size, 124);
+AssertCompileMemberOffset(RTZIPTARHDRPOSIX, mtime, 136);
+AssertCompileMemberOffset(RTZIPTARHDRPOSIX, chksum, 148);
+AssertCompileMemberOffset(RTZIPTARHDRPOSIX, typeflag, 156);
+AssertCompileMemberOffset(RTZIPTARHDRPOSIX, linkname, 157);
+AssertCompileMemberOffset(RTZIPTARHDRPOSIX, magic, 257);
+AssertCompileMemberOffset(RTZIPTARHDRPOSIX, version, 263);
+AssertCompileMemberOffset(RTZIPTARHDRPOSIX, uname, 265);
+AssertCompileMemberOffset(RTZIPTARHDRPOSIX, gname, 297);
+AssertCompileMemberOffset(RTZIPTARHDRPOSIX, devmajor, 329);
+AssertCompileMemberOffset(RTZIPTARHDRPOSIX, devminor, 337);
+AssertCompileMemberOffset(RTZIPTARHDRPOSIX, prefix, 345);
+
+/**
+ * GNU sparse data segment descriptor.
+ */
+typedef struct RTZIPTARGNUSPARSE
+{
+ char offset[12]; /**< Absolute offset relative to the start of the file. */
+ char numbytes[12];
+} RTZIPTARGNUSPARSE;
+AssertCompileSize(RTZIPTARGNUSPARSE, 24);
+AssertCompileMemberOffset(RTZIPTARGNUSPARSE, offset, 0);
+AssertCompileMemberOffset(RTZIPTARGNUSPARSE, numbytes, 12);
+/** Pointer to a GNU sparse data segment descriptor. */
+typedef RTZIPTARGNUSPARSE *PRTZIPTARGNUSPARSE;
+/** Pointer to a const GNU sparse data segment descriptor. */
+typedef RTZIPTARGNUSPARSE *PCRTZIPTARGNUSPARSE;
+
+/**
+ * The GNU header.
+ */
+typedef struct RTZIPTARHDRGNU
+{
+ char name[100];
+ char mode[8];
+ char uid[8];
+ char gid[8];
+ char size[12];
+ char mtime[12];
+ char chksum[8];
+ char typeflag;
+ char linkname[100];
+ char magic[8];
+ char uname[32];
+ char gname[32];
+ char devmajor[8];
+ char devminor[8];
+ char atime[12];
+ char ctime[12];
+ char offset[12]; /**< for multi-volume? */
+ char longnames[4]; /**< Seems to be unused. */
+ char unused[1];
+ RTZIPTARGNUSPARSE sparse[4];
+ char isextended; /**< More headers about sparse stuff if binary value 1. */
+ char realsize[12];
+ char unused2[17];
+} RTZIPTARHDRGNU;
+AssertCompileSize(RTZIPTARHDRGNU, 512);
+AssertCompileMemberOffset(RTZIPTARHDRGNU, name, 0);
+AssertCompileMemberOffset(RTZIPTARHDRGNU, mode, 100);
+AssertCompileMemberOffset(RTZIPTARHDRGNU, uid, 108);
+AssertCompileMemberOffset(RTZIPTARHDRGNU, gid, 116);
+AssertCompileMemberOffset(RTZIPTARHDRGNU, size, 124);
+AssertCompileMemberOffset(RTZIPTARHDRGNU, mtime, 136);
+AssertCompileMemberOffset(RTZIPTARHDRGNU, chksum, 148);
+AssertCompileMemberOffset(RTZIPTARHDRGNU, typeflag, 156);
+AssertCompileMemberOffset(RTZIPTARHDRGNU, linkname, 157);
+AssertCompileMemberOffset(RTZIPTARHDRGNU, magic, 257);
+AssertCompileMemberOffset(RTZIPTARHDRGNU, uname, 265);
+AssertCompileMemberOffset(RTZIPTARHDRGNU, gname, 297);
+AssertCompileMemberOffset(RTZIPTARHDRGNU, devmajor, 329);
+AssertCompileMemberOffset(RTZIPTARHDRGNU, devminor, 337);
+AssertCompileMemberOffset(RTZIPTARHDRGNU, atime, 345);
+AssertCompileMemberOffset(RTZIPTARHDRGNU, ctime, 357);
+AssertCompileMemberOffset(RTZIPTARHDRGNU, offset, 369);
+AssertCompileMemberOffset(RTZIPTARHDRGNU, longnames, 381);
+AssertCompileMemberOffset(RTZIPTARHDRGNU, unused, 385);
+AssertCompileMemberOffset(RTZIPTARHDRGNU, sparse, 386);
+AssertCompileMemberOffset(RTZIPTARHDRGNU, isextended,482);
+AssertCompileMemberOffset(RTZIPTARHDRGNU, realsize, 483);
+AssertCompileMemberOffset(RTZIPTARHDRGNU, unused2, 495);
+
+
+/**
+ * GNU sparse header.
+ */
+typedef struct RTZIPTARHDRGNUSPARSE
+{
+ RTZIPTARGNUSPARSE sp[21];
+ char isextended;
+ char unused[7];
+} RTZIPTARHDRGNUSPARSE;
+AssertCompileSize(RTZIPTARHDRGNUSPARSE, 512);
+AssertCompileMemberOffset(RTZIPTARHDRGNUSPARSE, sp, 0);
+AssertCompileMemberOffset(RTZIPTARHDRGNUSPARSE, isextended, 504);
+AssertCompileMemberOffset(RTZIPTARHDRGNUSPARSE, unused, 505);
+
+
+/**
+ * The bits common to posix and GNU.
+ */
+typedef struct RTZIPTARHDRCOMMON
+{
+ char name[100];
+ char mode[8];
+ char uid[8];
+ char gid[8];
+ char size[12];
+ char mtime[12];
+ char chksum[8];
+ char typeflag;
+ char linkname[100];
+ char magic[6];
+ char version[2];
+ char uname[32];
+ char gname[32];
+ char devmajor[8];
+ char devminor[8];
+ char not_common[155+12];
+} RTZIPTARHDRCOMMON;
+AssertCompileMembersSameSizeAndOffset(RTZIPTARHDRCOMMON, name, RTZIPTARHDRPOSIX, name);
+AssertCompileMembersSameSizeAndOffset(RTZIPTARHDRCOMMON, mode, RTZIPTARHDRPOSIX, mode);
+AssertCompileMembersSameSizeAndOffset(RTZIPTARHDRCOMMON, uid, RTZIPTARHDRPOSIX, uid);
+AssertCompileMembersSameSizeAndOffset(RTZIPTARHDRCOMMON, gid, RTZIPTARHDRPOSIX, gid);
+AssertCompileMembersSameSizeAndOffset(RTZIPTARHDRCOMMON, size, RTZIPTARHDRPOSIX, size);
+AssertCompileMembersSameSizeAndOffset(RTZIPTARHDRCOMMON, mtime, RTZIPTARHDRPOSIX, mtime);
+AssertCompileMembersSameSizeAndOffset(RTZIPTARHDRCOMMON, chksum, RTZIPTARHDRPOSIX, chksum);
+AssertCompileMembersSameSizeAndOffset(RTZIPTARHDRCOMMON, typeflag, RTZIPTARHDRPOSIX, typeflag);
+AssertCompileMembersSameSizeAndOffset(RTZIPTARHDRCOMMON, linkname, RTZIPTARHDRPOSIX, linkname);
+AssertCompileMembersSameSizeAndOffset(RTZIPTARHDRCOMMON, magic, RTZIPTARHDRPOSIX, magic);
+AssertCompileMembersSameSizeAndOffset(RTZIPTARHDRCOMMON, version, RTZIPTARHDRPOSIX, version);
+AssertCompileMembersSameSizeAndOffset(RTZIPTARHDRCOMMON, uname, RTZIPTARHDRPOSIX, uname);
+AssertCompileMembersSameSizeAndOffset(RTZIPTARHDRCOMMON, gname, RTZIPTARHDRPOSIX, gname);
+AssertCompileMembersSameSizeAndOffset(RTZIPTARHDRCOMMON, devmajor, RTZIPTARHDRPOSIX, devmajor);
+AssertCompileMembersSameSizeAndOffset(RTZIPTARHDRCOMMON, devminor, RTZIPTARHDRPOSIX, devminor);
+
+AssertCompileMembersSameSizeAndOffset(RTZIPTARHDRCOMMON, name, RTZIPTARHDRGNU, name);
+AssertCompileMembersSameSizeAndOffset(RTZIPTARHDRCOMMON, mode, RTZIPTARHDRGNU, mode);
+AssertCompileMembersSameSizeAndOffset(RTZIPTARHDRCOMMON, uid, RTZIPTARHDRGNU, uid);
+AssertCompileMembersSameSizeAndOffset(RTZIPTARHDRCOMMON, gid, RTZIPTARHDRGNU, gid);
+AssertCompileMembersSameSizeAndOffset(RTZIPTARHDRCOMMON, size, RTZIPTARHDRGNU, size);
+AssertCompileMembersSameSizeAndOffset(RTZIPTARHDRCOMMON, mtime, RTZIPTARHDRGNU, mtime);
+AssertCompileMembersSameSizeAndOffset(RTZIPTARHDRCOMMON, chksum, RTZIPTARHDRGNU, chksum);
+AssertCompileMembersSameSizeAndOffset(RTZIPTARHDRCOMMON, typeflag, RTZIPTARHDRGNU, typeflag);
+AssertCompileMembersSameSizeAndOffset(RTZIPTARHDRCOMMON, linkname, RTZIPTARHDRGNU, linkname);
+AssertCompileMembersAtSameOffset( RTZIPTARHDRCOMMON, magic, RTZIPTARHDRGNU, magic);
+AssertCompileMembersSameSizeAndOffset(RTZIPTARHDRCOMMON, uname, RTZIPTARHDRGNU, uname);
+AssertCompileMembersSameSizeAndOffset(RTZIPTARHDRCOMMON, gname, RTZIPTARHDRGNU, gname);
+AssertCompileMembersSameSizeAndOffset(RTZIPTARHDRCOMMON, devmajor, RTZIPTARHDRGNU, devmajor);
+AssertCompileMembersSameSizeAndOffset(RTZIPTARHDRCOMMON, devminor, RTZIPTARHDRGNU, devminor);
+
+
+
+/**
+ * Tar header union.
+ */
+typedef union RTZIPTARHDR
+{
+ /** Byte view. */
+ char ab[512];
+ /** The standard header. */
+ RTZIPTARHDRANCIENT Ancient;
+ /** The standard header. */
+ RTZIPTARHDRPOSIX Posix;
+ /** The GNU header. */
+ RTZIPTARHDRGNU Gnu;
+ /** The bits common to both GNU and the standard header. */
+ RTZIPTARHDRCOMMON Common;
+ /** GNU sparse header. */
+ RTZIPTARHDRGNUSPARSE GnuSparse;
+} RTZIPTARHDR;
+AssertCompileSize(RTZIPTARHDR, 512);
+/** Pointer to a tar file header. */
+typedef RTZIPTARHDR *PRTZIPTARHDR;
+/** Pointer to a const tar file header. */
+typedef RTZIPTARHDR const *PCRTZIPTARHDR;
+
+
+/**
+ * Tar header type.
+ */
+typedef enum RTZIPTARTYPE
+{
+ /** Invalid type value. */
+ RTZIPTARTYPE_INVALID = 0,
+ /** Posix header. */
+ RTZIPTARTYPE_POSIX,
+ /** The old GNU header, has layout conflicting with posix. */
+ RTZIPTARTYPE_GNU,
+ /** Ancient tar header which does not use anything beyond the magic. */
+ RTZIPTARTYPE_ANCIENT,
+ /** End of the valid type values (this is not valid). */
+ RTZIPTARTYPE_END,
+ /** The usual type blow up. */
+ RTZIPTARTYPE_32BIT_HACK = 0x7fffffff
+} RTZIPTARTYPE;
+typedef RTZIPTARTYPE *PRTZIPTARTYPE;
+
+
+/**
+ * Calculates the TAR header checksums and detects if it's all zeros.
+ *
+ * @returns true if all zeros, false if not.
+ * @param pHdr The header to checksum.
+ * @param pi32Unsigned Where to store the checksum calculated using
+ * unsigned chars. This is the one POSIX specifies.
+ * @param pi32Signed Where to store the checksum calculated using
+ * signed chars.
+ *
+ * @remarks The reason why we calculate the checksum as both signed and unsigned
+ * has to do with various the char C type being signed on some hosts
+ * and unsigned on others.
+ */
+DECLINLINE(bool) rtZipTarCalcChkSum(PCRTZIPTARHDR pHdr, int32_t *pi32Unsigned, int32_t *pi32Signed)
+{
+ int32_t i32Unsigned = 0;
+ int32_t i32Signed = 0;
+
+ /*
+ * Sum up the entire header.
+ */
+ const char *pch = (const char *)pHdr;
+ const char *pchEnd = pch + sizeof(*pHdr);
+ do
+ {
+ i32Unsigned += *(unsigned char *)pch;
+ i32Signed += *(signed char *)pch;
+ } while (++pch != pchEnd);
+
+ /*
+ * Check if it's all zeros and replace the chksum field with spaces.
+ */
+ bool const fZeroHdr = i32Unsigned == 0;
+
+ pch = pHdr->Common.chksum;
+ pchEnd = pch + sizeof(pHdr->Common.chksum);
+ do
+ {
+ i32Unsigned -= *(unsigned char *)pch;
+ i32Signed -= *(signed char *)pch;
+ } while (++pch != pchEnd);
+
+ i32Unsigned += (unsigned char)' ' * sizeof(pHdr->Common.chksum);
+ i32Signed += (signed char)' ' * sizeof(pHdr->Common.chksum);
+
+ *pi32Unsigned = i32Unsigned;
+ if (pi32Signed)
+ *pi32Signed = i32Signed;
+ return fZeroHdr;
+}
+
+
+#endif /* !IPRT_INCLUDED_SRC_common_zip_tar_h */
+
diff --git a/include/iprt/tar.h b/include/iprt/tar.h
deleted file mode 100644
index be6ce0fac7d..00000000000
--- a/include/iprt/tar.h
+++ /dev/null
@@ -1,184 +0,0 @@
-/** @file
- * IPRT - Tar archive I/O.
- */
-
-/*
- * Copyright (C) 2009-2023 Oracle and/or its affiliates.
- *
- * This file is part of VirtualBox base platform packages, as
- * available from https://www.virtualbox.org.
- *
- * 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, in version 3 of the
- * License.
- *
- * 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 <https://www.gnu.org/licenses>.
- *
- * The contents of this file may alternatively be used under the terms
- * of the Common Development and Distribution License Version 1.0
- * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
- * in the VirtualBox distribution, in which case the provisions of the
- * CDDL are applicable instead of those of the GPL.
- *
- * You may elect to license modified versions of this file under the
- * terms and conditions of either the GPL or the CDDL or both.
- *
- * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
- */
-
-#ifndef IPRT_INCLUDED_tar_h
-#define IPRT_INCLUDED_tar_h
-#ifndef RT_WITHOUT_PRAGMA_ONCE
-# pragma once
-#endif
-
-#include <iprt/cdefs.h>
-#include <iprt/types.h>
-#include <iprt/time.h>
-
-RT_C_DECLS_BEGIN
-
-/** @defgroup grp_rt_tar RTTar - Tar archive I/O
- * @ingroup grp_rt
- *
- * @deprecated Only used for legacy code and writing. Migrate new code to the
- * VFS interface, add the write part when needed.
- *
- * @{
- */
-
-/** A tar handle */
-typedef R3PTRTYPE(struct RTTARINTERNAL *) RTTAR;
-/** Pointer to a RTTAR interface handle. */
-typedef RTTAR *PRTTAR;
-/** Nil RTTAR interface handle. */
-#define NIL_RTTAR ((RTTAR)0)
-
-/** A tar file handle */
-typedef R3PTRTYPE(struct RTTARFILEINTERNAL *) RTTARFILE;
-/** Pointer to a RTTARFILE interface handle. */
-typedef RTTARFILE *PRTTARFILE;
-/** Nil RTTARFILE interface handle. */
-#define NIL_RTTARFILE ((RTTARFILE)0)
-
-/** Maximum length of a tar filename, excluding the terminating '\0'. More
- * does not fit into a tar record. */
-#define RTTAR_NAME_MAX 99
-
-/**
- * Creates a Tar archive.
- *
- * Use the mask to specify the access type.
- *
- * @returns IPRT status code.
- *
- * @param phTar Where to store the RTTAR handle.
- * @param pszTarname The file name of the tar archive to create. Should
- * not exist.
- * @param fMode Open flags, i.e a combination of the RTFILE_O_* defines.
- * The ACCESS, ACTION and DENY flags are mandatory!
- */
-RTR3DECL(int) RTTarOpen(PRTTAR phTar, const char *pszTarname, uint32_t fMode);
-
-/**
- * Close the Tar archive.
- *
- * @returns IPRT status code.
- *
- * @param hTar Handle to the RTTAR interface.
- */
-RTR3DECL(int) RTTarClose(RTTAR hTar);
-
-/**
- * Open a file in the Tar archive.
- *
- * @returns IPRT status code.
- *
- * @param hTar The handle of the tar archive.
- * @param phFile Where to store the handle to the opened file.
- * @param pszFilename Path to the file which is to be opened. (UTF-8)
- * @param fOpen Open flags, i.e a combination of the RTFILE_O_* defines.
- * The ACCESS, ACTION flags are mandatory! DENY flags
- * are currently not supported.
- *
- * @remarks Write mode means append mode only. It is not possible to make
- * changes to existing files.
- *
- * @remarks Currently it is not possible to open more than one file in write
- * mode. Although open more than one file in read only mode (even when
- * one file is opened in write mode) is always possible.
- */
-RTR3DECL(int) RTTarFileOpen(RTTAR hTar, PRTTARFILE phFile, const char *pszFilename, uint32_t fOpen);
-
-/**
- * Close the file opened by RTTarFileOpen.
- *
- * @returns IPRT status code.
- *
- * @param hFile The file handle to close.
- */
-RTR3DECL(int) RTTarFileClose(RTTARFILE hFile);
-
-/**
- * Read bytes from a file at a given offset.
- * This function may modify the file position.
- *
- * @returns IPRT status code.
- *
- * @param hFile Handle to the file.
- * @param off Where to read.
- * @param pvBuf Where to put the bytes we read.
- * @param cbToRead How much to read.
- * @param pcbRead Where to return how much we actually read. If NULL
- * an error will be returned for a partial read.
- */
-RTR3DECL(int) RTTarFileReadAt(RTTARFILE hFile, uint64_t off, void *pvBuf, size_t cbToRead, size_t *pcbRead);
-
-/**
- * Write bytes to a file at a given offset.
- * This function may modify the file position.
- *
- * @returns IPRT status code.
- *
- * @param hFile Handle to the file.
- * @param off Where to write.
- * @param pvBuf What to write.
- * @param cbToWrite How much to write.
- * @param pcbWritten Where to return how much we actually wrote. If NULL
- * an error will be returned for a partial write.
- */
-RTR3DECL(int) RTTarFileWriteAt(RTTARFILE hFile, uint64_t off, const void *pvBuf, size_t cbToWrite, size_t *pcbWritten);
-
-/**
- * Query the size of the file.
- *
- * @returns IPRT status code.
- *
- * @param hFile Handle to the file.
- * @param pcbSize Where to store the filesize.
- */
-RTR3DECL(int) RTTarFileGetSize(RTTARFILE hFile, uint64_t *pcbSize);
-
-/**
- * Set the size of the file.
- *
- * @returns IPRT status code.
- *
- * @param hFile Handle to the file.
- * @param cbSize The new file size.
- */
-RTR3DECL(int) RTTarFileSetSize(RTTARFILE hFile, uint64_t cbSize);
-
-/** @} */
-
-RT_C_DECLS_END
-
-#endif /* !IPRT_INCLUDED_tar_h */
-