usr.bin/ar/ar.h

   1 /*-
   2  * Copyright (c) 2007 Kai Wang
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer
  10  *    in this position and unchanged.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
  16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18  * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
  19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  *
  26  * $FreeBSD$
  27  */
  28
  29 #define BSDAR_VERSION   "1.1.0"
  30
  31 /*
  32  * ar(1) options.
  33  */
  34 #define AR_A    0x0001          /* position-after */
  35 #define AR_B    0x0002          /* position-before */
  36 #define AR_C    0x0004          /* creating new archive */
  37 #define AR_CC   0x0008          /* do not overwrite when extracting */
  38 #define AR_J    0x0010          /* bzip2 compression */
  39 #define AR_O    0x0020          /* preserve original mtime when extracting */
  40 #define AR_S    0x0040          /* write archive symbol table */
  41 #define AR_SS   0x0080          /* do not write archive symbol table */
  42 #define AR_TR   0x0100          /* only keep first 15 chars for member name */
  43 #define AR_U    0x0200          /* only extract or update newer members.*/
  44 #define AR_V    0x0400          /* verbose mode */
  45 #define AR_Z    0x0800          /* gzip compression */
  46 #define AR_D    0x1000          /* insert dummy mode, mtime, uid and gid */
  47
  48 #define DEF_BLKSZ 10240         /* default block size */
  49
  50 /*
  51  * Convenient wrapper for general libarchive error handling.
  52  */
  53 #define AC(CALL) do {                                   \
  54         if ((CALL))                                     \
  55                 bsdar_errc(bsdar, EX_SOFTWARE, 0, "%s", \
  56                     archive_error_string(a));           \
  57 } while (0)
  58
  59 /*
  60  * In-memory representation of archive member(object).
  61  */
  62 struct ar_obj {
  63         char             *name;         /* member name */
  64         void             *maddr;        /* mmap start address */
  65         uid_t             uid;          /* user id */
  66         gid_t             gid;          /* group id */
  67         mode_t            md;           /* octal file permissions */
  68         size_t            size;         /* member size */
  69         time_t            mtime;        /* modification time */
  70         int               fd;           /* file descriptor */
  71         dev_t             dev;          /* inode's device */
  72         ino_t             ino;          /* inode's number */
  73
  74         TAILQ_ENTRY(ar_obj) objs;
  75 };
  76
  77 /*
  78  * Structure encapsulates the "global" data for "ar" program.
  79  */
  80 struct bsdar {
  81         const char       *filename;     /* archive name. */
  82         const char       *addlib;       /* target of ADDLIB. */
  83         const char       *posarg;       /* position arg for modifiers -a, -b. */
  84         char              mode;         /* program mode */
  85         int               options;      /* command line options */
  86
  87         const char       *progname;     /* program name */
  88         int               argc;
  89         char            **argv;
  90
  91         /*
  92          * Fields for the archive string table.
  93          */
  94         char             *as;           /* buffer for archive string table. */
  95         size_t            as_sz;        /* current size of as table. */
  96         size_t            as_cap;       /* capacity of as table buffer. */
  97
  98         /*
  99          * Fields for the archive symbol table.
 100          */
 101         uint32_t          s_cnt;        /* current number of symbols. */
 102         uint32_t         *s_so;         /* symbol offset table. */
 103         size_t            s_so_cap;     /* capacity of so table buffer. */
 104         char             *s_sn;         /* symbol name table */
 105         size_t            s_sn_cap;     /* capacity of sn table buffer. */
 106         size_t            s_sn_sz;      /* current size of sn table. */
 107         /* Current member's offset (relative to the end of pseudo members.) */
 108         off_t             rela_off;
 109
 110         TAILQ_HEAD(, ar_obj) v_obj;     /* object(member) list */
 111 };
 112
 113 void    bsdar_errc(struct bsdar *, int _eval, int _code,
 114             const char *fmt, ...) __dead2;
 115 void    bsdar_warnc(struct bsdar *, int _code, const char *fmt, ...);
 116 void    ar_mode_d(struct bsdar *bsdar);
 117 void    ar_mode_m(struct bsdar *bsdar);
 118 void    ar_mode_p(struct bsdar *bsdar);
 119 void    ar_mode_q(struct bsdar *bsdar);
 120 void    ar_mode_r(struct bsdar *bsdar);
 121 void    ar_mode_s(struct bsdar *bsdar);
 122 void    ar_mode_t(struct bsdar *bsdar);
 123 void    ar_mode_x(struct bsdar *bsdar);
 124 void    ar_mode_A(struct bsdar *bsdar);
 125 void    ar_mode_script(struct bsdar *ar);