tar: live within system-supplied limits on file descriptors

[chaz/tar] / src / tar.h

diff --git a/src/tar.h b/src/tar.h
index a759a8581a0536f3c3e78466a43630a980179417..ce9850c968533db8b49ddc0b9f78e81c6333cabc 100644 (file)
--- a/src/tar.h
+++ b/src/tar.h
@@ -1,11 +1,11 @@
 /* GNU tar Archive Format description.
 
    Copyright (C) 1988, 1989, 1991, 1992, 1993, 1994, 1995, 1996, 1997,
 /* GNU tar Archive Format description.
 
    Copyright (C) 1988, 1989, 1991, 1992, 1993, 1994, 1995, 1996, 1997,

-   2000, 2001, 2003, 2004, 2005 Free Software Foundation, Inc.
+   2000, 2001, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.

 
    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
 
    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; either version 2, or (at your option) any later
+   Free Software Foundation; either version 3, or (at your option) any later

    version.
 
    This program is distributed in the hope that it will be useful, but
    version.
 
    This program is distributed in the hope that it will be useful, but


@@ -165,6 +165,7 @@ struct oldgnu_header
    'A' Solaris Access Control List
    'E' Solaris Extended Attribute File
    'I' Inode only, as in 'star'
    'A' Solaris Access Control List
    'E' Solaris Extended Attribute File
    'I' Inode only, as in 'star'

+   'N' Obsolete GNU tar, for file names that do not fit into the main header.

    'X' POSIX 1003.1-2001 eXtended (VU version)  */
 
 /* This is a dir entry that contains the names of files that were in the
    'X' POSIX 1003.1-2001 eXtended (VU version)  */
 
 /* This is a dir entry that contains the names of files that were in the


@@ -180,9 +181,6 @@ struct oldgnu_header
 /* This is the continuation of a file that began on another volume.  */
 #define GNUTYPE_MULTIVOL 'M'
 
 /* This is the continuation of a file that began on another volume.  */
 #define GNUTYPE_MULTIVOL 'M'
 

-/* For storing filenames that do not fit into the main header.  */
-#define GNUTYPE_NAMES 'N'
-

 /* This is for sparse files.  */
 #define GNUTYPE_SPARSE 'S'
 
 /* This is for sparse files.  */
 #define GNUTYPE_SPARSE 'S'
 


@@ -192,8 +190,7 @@ struct oldgnu_header
 /* Solaris extended header */
 #define SOLARIS_XHDTYPE 'X'
 
 /* Solaris extended header */
 #define SOLARIS_XHDTYPE 'X'
 

-\f
-/* Jörg Schilling star header */
+/* J@"org Schilling star header */

 
 struct star_header
 {                              /* byte offset */
 
 struct star_header
 {                              /* byte offset */


@@ -221,7 +218,8 @@ struct star_header
 #define SPARSES_IN_STAR_HEADER      4
 #define SPARSES_IN_STAR_EXT_HEADER  21
 
 #define SPARSES_IN_STAR_HEADER      4
 #define SPARSES_IN_STAR_EXT_HEADER  21
 

-struct star_in_header {
+struct star_in_header
+{

   char fill[345];       /*   0  Everything that is before t_prefix */
   char prefix[1];       /* 345  t_name prefix */
   char fill2;           /* 346  */
   char fill[345];       /*   0  Everything that is before t_prefix */
   char prefix[1];       /* 345  t_name prefix */
   char fill2;           /* 346  */


@@ -236,11 +234,13 @@ struct star_in_header {
   char xmagic[4];       /* 508  "tar" */
 };
 
   char xmagic[4];       /* 508  "tar" */
 };
 

-struct star_ext_header {
+struct star_ext_header
+{

   struct sparse sp[SPARSES_IN_STAR_EXT_HEADER];
   char isextended;
 };
 
   struct sparse sp[SPARSES_IN_STAR_EXT_HEADER];
   char isextended;
 };
 

+/* END */

 \f
 
 /* tar Header Block, overall structure.  */
 \f
 
 /* tar Header Block, overall structure.  */


@@ -263,10 +263,18 @@ enum archive_format
 
 /* Information about a sparse file.  */
 struct sp_array
 
 /* Information about a sparse file.  */
 struct sp_array

-  {
-    off_t offset;
-    size_t numbytes;
-  };
+{
+  off_t offset;
+  off_t numbytes;
+};
+
+struct xheader
+{
+  struct obstack *stk;
+  size_t size;
+  char *buffer;
+  uintmax_t string_length;
+};

 
 struct tar_stat_info
 {
 
 struct tar_stat_info
 {


@@ -293,17 +301,42 @@ struct tar_stat_info
   bool   is_sparse;         /* Is the file sparse */
 
   /* For sparse files: */
   bool   is_sparse;         /* Is the file sparse */
 
   /* For sparse files: */

+  unsigned sparse_major;
+  unsigned sparse_minor;

   size_t sparse_map_avail;  /* Index to the first unused element in
                               sparse_map array. Zero if the file is
                               not sparse */
   size_t sparse_map_size;   /* Size of the sparse map */
   struct sp_array *sparse_map;
 
   size_t sparse_map_avail;  /* Index to the first unused element in
                               sparse_map array. Zero if the file is
                               not sparse */
   size_t sparse_map_size;   /* Size of the sparse map */
   struct sp_array *sparse_map;
 

+  /* Extended headers */
+  struct xheader xhdr;
+

   /* For dumpdirs */
   bool is_dumpdir;          /* Is the member a dumpdir? */
   bool skipped;             /* The member contents is already read
                               (for GNUTYPE_DUMPDIR) */
   /* For dumpdirs */
   bool is_dumpdir;          /* Is the member a dumpdir? */
   bool skipped;             /* The member contents is already read
                               (for GNUTYPE_DUMPDIR) */

-  char *dumpdir;            /* Contents of the dump directory */    
+  char *dumpdir;            /* Contents of the dump directory */
+
+  /* Parent directory, if creating an archive.  This is null if the
+     file is at the top level.  */
+  struct tar_stat_info *parent;
+
+  /* Directory stream.  If this is not null, it is in control of FD,
+     and should be closed instead of FD.  */
+  DIR *dirstream;
+
+  /* File descriptor, if creating an archive, and if a directory or a
+     regular file or a contiguous file.
+
+     It is zero if no file descriptor is available, either because it
+     was never needed or because it was open and then closed to
+     conserve on file descriptors.  (Standard input is never used
+     here, so zero cannot be a valid file descriptor.)
+
+     It is negative if it could not be reopened after it was closed.
+     Negate it to find out what errno was when the reopen failed.  */
+  int fd;

 };
 
 union block
 };
 
 union block


@@ -316,5 +349,3 @@ union block
   struct star_in_header star_in_header;
   struct star_ext_header star_ext_header;
 };
   struct star_in_header star_in_header;
   struct star_ext_header star_ext_header;
 };

-
-/* End of Format description.  */