contrib/elftoolchain/ar/ar.c

   1 /*-
   2  * Copyright (c) 2007 Kai Wang
   3  * Copyright (c) 2007 Tim Kientzle
   4  * Copyright (c) 2007 Joseph Koshy
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer
  12  *    in this position and unchanged.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 /*-
  30  * Copyright (c) 1990, 1993, 1994
  31  *      The Regents of the University of California.  All rights reserved.
  32  *
  33  * This code is derived from software contributed to Berkeley by
  34  * Hugh Smith at The University of Guelph.
  35  *
  36  * Redistribution and use in source and binary forms, with or without
  37  * modification, are permitted provided that the following conditions
  38  * are met:
  39  * 1. Redistributions of source code must retain the above copyright
  40  *    notice, this list of conditions and the following disclaimer.
  41  * 2. Redistributions in binary form must reproduce the above copyright
  42  *    notice, this list of conditions and the following disclaimer in the
  43  *    documentation and/or other materials provided with the distribution.
  44  * 3. Neither the name of the University nor the names of its contributors
  45  *    may be used to endorse or promote products derived from this software
  46  *    without specific prior written permission.
  47  *
  48  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  49  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  50  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  51  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  52  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  53  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  54  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  55  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  56  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  57  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  58  * SUCH DAMAGE.
  59  */
  60
  61 #include <sys/queue.h>
  62 #include <sys/types.h>
  63 #include <archive.h>
  64 #include <errno.h>
  65 #include <getopt.h>
  66 #include <libelftc.h>
  67 #include <libgen.h>
  68 #include <stdio.h>
  69 #include <stdlib.h>
  70 #include <stdint.h>
  71 #include <string.h>
  72
  73 #include "ar.h"
  74
  75 ELFTC_VCSID("$Id: ar.c 3183 2015-04-10 16:18:42Z emaste $");
  76
  77 enum options
  78 {
  79         OPTION_HELP
  80 };
  81
  82 static struct option longopts[] =
  83 {
  84         {"flavor", required_argument, NULL, 'F'},
  85         {"help", no_argument, NULL, OPTION_HELP},
  86         {"version", no_argument, NULL, 'V'},
  87         {NULL, 0, NULL, 0}
  88 };
  89
  90 static void     bsdar_usage(void);
  91 static void     ranlib_usage(void);
  92 static void     set_mode(struct bsdar *bsdar, char opt);
  93 static void     only_mode(struct bsdar *bsdar, const char *opt,
  94                     const char *valid_modes);
  95 static void     bsdar_version(void);
  96
  97 int
  98 main(int argc, char **argv)
  99 {
 100         struct bsdar    *bsdar, bsdar_storage;
 101         char            *arcmd, *argv1_saved;
 102         size_t           len;
 103         int              i, opt;
 104
 105         bsdar = &bsdar_storage;
 106         memset(bsdar, 0, sizeof(*bsdar));
 107
 108         arcmd = argv1_saved = NULL;
 109         bsdar->output = stdout;
 110
 111         if ((bsdar->progname = ELFTC_GETPROGNAME()) == NULL)
 112                 bsdar->progname = "ar";
 113
 114         if (elf_version(EV_CURRENT) == EV_NONE)
 115                 bsdar_errc(bsdar, 0, "ELF library initialization failed: %s",
 116                     elf_errmsg(-1));
 117
 118         /*
 119          * Act like ranlib if our name ends in "ranlib"; this
 120          * accommodates names like "arm-freebsd7.1-ranlib",
 121          * "bsdranlib", etc.
 122          */
 123         len = strlen(bsdar->progname);
 124         if (len >= strlen("ranlib") &&
 125             strcmp(bsdar->progname + len - strlen("ranlib"), "ranlib") == 0) {
 126                 while ((opt = getopt_long(argc, argv, "tDV", longopts,
 127                     NULL)) != -1) {
 128                         switch(opt) {
 129                         case 't':
 130                                 /* Ignored. */
 131                                 break;
 132                         case 'D':
 133                                 bsdar->options |= AR_D;
 134                                 break;
 135                         case 'V':
 136                                 bsdar_version();
 137                                 break;
 138                         case OPTION_HELP:
 139                                 ranlib_usage();
 140                         default:
 141                                 ranlib_usage();
 142                         }
 143                 }
 144                 argv += optind;
 145                 argc -= optind;
 146
 147                 if (*argv == NULL)
 148                         ranlib_usage();
 149
 150                 bsdar->options |= AR_S;
 151                 for (;(bsdar->filename = *argv++) != NULL;)
 152                         ar_write_archive(bsdar, 's');
 153
 154                 exit(EXIT_SUCCESS);
 155         } else {
 156                 if (argc < 2)
 157                         bsdar_usage();
 158
 159                 /*
 160                  * Tack on a leading '-', for old-style usage.
 161                  */
 162                 if (*argv[1] != '-') {
 163                         argv1_saved = argv[1];
 164                         len = strlen(argv[1]) + 2;
 165                         if ((arcmd = malloc(len)) == NULL)
 166                                 bsdar_errc(bsdar, errno, "malloc failed");
 167                         (void) snprintf(arcmd, len, "-%s", argv[1]);
 168                         argv[1] = arcmd;
 169                 }
 170         }
 171
 172         while ((opt = getopt_long(argc, argv, "abCcdDfF:ijlMmopqrSsTtuVvxz",
 173             longopts, NULL)) != -1) {
 174                 switch(opt) {
 175                 case 'a':
 176                         bsdar->options |= AR_A;
 177                         break;
 178                 case 'b':
 179                 case 'i':
 180                         bsdar->options |= AR_B;
 181                         break;
 182                 case 'C':
 183                         bsdar->options |= AR_CC;
 184                         break;
 185                 case 'c':
 186                         bsdar->options |= AR_C;
 187                         break;
 188                 case 'd':
 189                         set_mode(bsdar, opt);
 190                         break;
 191                 case 'D':
 192                         bsdar->options |= AR_D;
 193                         break;
 194                 case 'F':
 195                         if (!strcasecmp(optarg, "svr4") ||
 196                             !strcasecmp(optarg, "gnu"))
 197                                 bsdar->options &= ~AR_BSD;
 198                         else if (!strcasecmp(optarg, "bsd"))
 199                                 bsdar->options |= AR_BSD;
 200                         else
 201                                 bsdar_usage();
 202                         break;
 203                 case 'f':
 204                 case 'T':
 205                         bsdar->options |= AR_TR;
 206                         break;
 207                 case 'j':
 208                         /* ignored */
 209                         break;
 210                 case 'l':
 211                         /* ignored, for GNU ar comptibility */
 212                         break;
 213                 case 'M':
 214                         set_mode(bsdar, opt);
 215                         break;
 216                 case 'm':
 217                         set_mode(bsdar, opt);
 218                         break;
 219                 case 'o':
 220                         bsdar->options |= AR_O;
 221                         break;
 222                 case 'p':
 223                         set_mode(bsdar, opt);
 224                         break;
 225                 case 'q':
 226                         set_mode(bsdar, opt);
 227                         break;
 228                 case 'r':
 229                         set_mode(bsdar, opt);
 230                         break;
 231                 case 'S':
 232                         bsdar->options |= AR_SS;
 233                         break;
 234                 case 's':
 235                         bsdar->options |= AR_S;
 236                         break;
 237                 case 't':
 238                         set_mode(bsdar, opt);
 239                         break;
 240                 case 'u':
 241                         bsdar->options |= AR_U;
 242                         break;
 243                 case 'V':
 244                         bsdar_version();
 245                         break;
 246                 case 'v':
 247                         bsdar->options |= AR_V;
 248                         break;
 249                 case 'x':
 250                         set_mode(bsdar, opt);
 251                         break;
 252                 case 'z':
 253                         /* ignored */
 254                         break;
 255                 case OPTION_HELP:
 256                         bsdar_usage();
 257                 default:
 258                         bsdar_usage();
 259                 }
 260         }
 261
 262         /* Restore argv[1] if we had modified it. */
 263         if (arcmd != NULL) {
 264                 argv[1] = argv1_saved;
 265                 free(arcmd);
 266                 arcmd = argv1_saved = NULL;
 267         }
 268
 269         argv += optind;
 270         argc -= optind;
 271
 272         if (*argv == NULL && bsdar->mode != 'M')
 273                 bsdar_usage();
 274
 275         if (bsdar->options & AR_A && bsdar->options & AR_B)
 276                 bsdar_errc(bsdar, 0,
 277                     "only one of -a and -[bi] options allowed");
 278
 279         if (bsdar->options & AR_J && bsdar->options & AR_Z)
 280                 bsdar_errc(bsdar, 0,
 281                     "only one of -j and -z options allowed");
 282
 283         if (bsdar->options & AR_S && bsdar->options & AR_SS)
 284                 bsdar_errc(bsdar, 0,
 285                     "only one of -s and -S options allowed");
 286
 287         if (bsdar->options & (AR_A | AR_B)) {
 288                 if (*argv == NULL)
 289                         bsdar_errc(bsdar, 0,
 290                             "no position operand specified");
 291                 if ((bsdar->posarg = basename(*argv)) == NULL)
 292                         bsdar_errc(bsdar, errno,
 293                             "basename failed");
 294                 argc--;
 295                 argv++;
 296         }
 297
 298         if (bsdar->options & AR_A)
 299                 only_mode(bsdar, "-a", "mqr");
 300         if (bsdar->options & AR_B)
 301                 only_mode(bsdar, "-b", "mqr");
 302         if (bsdar->options & AR_C)
 303                 only_mode(bsdar, "-c", "qr");
 304         if (bsdar->options & AR_CC)
 305                 only_mode(bsdar, "-C", "x");
 306         if (bsdar->options & AR_D)
 307                 only_mode(bsdar, "-D", "qr");
 308         if (bsdar->options & AR_O)
 309                 only_mode(bsdar, "-o", "x");
 310         if (bsdar->options & AR_SS)
 311                 only_mode(bsdar, "-S", "mqr");
 312         if (bsdar->options & AR_U)
 313                 only_mode(bsdar, "-u", "qrx");
 314
 315         if (bsdar->mode == 'M') {
 316                 ar_mode_script(bsdar);
 317                 exit(EXIT_SUCCESS);
 318         }
 319
 320         if ((bsdar->filename = *argv) == NULL)
 321                 bsdar_usage();
 322
 323         bsdar->argc = --argc;
 324         bsdar->argv = ++argv;
 325
 326         if ((!bsdar->mode || strchr("ptx", bsdar->mode)) &&
 327             bsdar->options & AR_S) {
 328                 ar_write_archive(bsdar, 's');
 329                 if (!bsdar->mode)
 330                         exit(EXIT_SUCCESS);
 331         }
 332
 333         switch(bsdar->mode) {
 334         case 'd': case 'm': case 'q': case 'r':
 335                 ar_write_archive(bsdar, bsdar->mode);
 336                 break;
 337
 338         case 'p': case 't': case 'x':
 339                 ar_read_archive(bsdar, bsdar->mode);
 340                 break;
 341         default:
 342                 bsdar_usage();
 343                 /* NOTREACHED */
 344         }
 345
 346         for (i = 0; i < bsdar->argc; i++)
 347                 if (bsdar->argv[i] != NULL)
 348                         bsdar_warnc(bsdar, 0, "%s: not found in archive",
 349                             bsdar->argv[i]);
 350
 351         exit(EXIT_SUCCESS);
 352 }
 353
 354 static void
 355 set_mode(struct bsdar *bsdar, char opt)
 356 {
 357
 358         if (bsdar->mode != '\0' && bsdar->mode != opt)
 359                 bsdar_errc(bsdar, 0, "Can't specify both -%c and -%c",
 360                     opt, bsdar->mode);
 361         bsdar->mode = opt;
 362 }
 363
 364 static void
 365 only_mode(struct bsdar *bsdar, const char *opt, const char *valid_modes)
 366 {
 367
 368         if (strchr(valid_modes, bsdar->mode) == NULL)
 369                 bsdar_errc(bsdar, 0, "Option %s is not permitted in mode -%c",
 370                     opt, bsdar->mode);
 371 }
 372
 373 #define AR_USAGE_MESSAGE        "\
 374 Usage: %s <command> [options] archive file...\n\
 375   Manage archives.\n\n\
 376   Where <command> is one of:\n\
 377   -d            Delete members from the archive.\n\
 378   -m            Move archive members within the archive.\n\
 379   -p            Write the contents of members to standard output.\n\
 380   -q            Append files to an archive.\n\
 381   -r            Replace (add) files to an archive.\n\
 382   -s            Add an archive symbol to an archive.\n\
 383   -t            List files in an archive.\n\
 384   -x            Extract members from an archive.\n\
 385   -M            Execute MRI librarian commands.\n\
 386   -V            Print a version identifier and exit.\n\n\
 387   Options:\n\
 388   -a MEMBER     Add members after the specified member.\n\
 389   -b MEMBER | -i MEMBER\n\
 390                 Add members before the specified member.\n\
 391   -c            Do not print a message when creating a new archive.\n\
 392   -f | -T       Only use the first fifteen characters of the member name.\n\
 393   -j            (This option is accepted, but is ignored).\n\
 394   -l            (This option is accepted, but is ignored).\n\
 395   -o            Preserve modification times when extracting members.\n\
 396   -u            Conditionally update or extract members.\n\
 397   -v            Be verbose.\n\
 398   -z            (This option is accepted, but is ignored).\n\
 399   -C            Do not overwrite existing files in the file system.\n\
 400   -D            Use fixed metadata, for consistent archive checksums.\n\
 401   -F FORMAT | --flavor=FORMAT\n\
 402                 Create archives with the specified format.\n\
 403   -S            Do not generate an archive symbol table.\n"
 404
 405 static void
 406 bsdar_usage(void)
 407 {
 408         (void) fprintf(stderr, AR_USAGE_MESSAGE, ELFTC_GETPROGNAME());
 409         exit(EXIT_FAILURE);
 410 }
 411
 412 #define RANLIB_USAGE_MESSAGE    "\
 413 Usage: %s [options] archive...\n\
 414   Update or create archive symbol tables.\n\n\
 415   Options:\n\
 416   -t              (This option is accepted, but ignored).\n\
 417   -D              Use fixed metadata, for consistent archive checksums.\n\
 418   -V              Print a version identifier and exit.\n"
 419
 420 static void
 421 ranlib_usage(void)
 422 {
 423         (void)fprintf(stderr, RANLIB_USAGE_MESSAGE, ELFTC_GETPROGNAME());
 424         exit(EXIT_FAILURE);
 425 }
 426
 427 static void
 428 bsdar_version(void)
 429 {
 430         (void)printf("%s (%s, %s)\n", ELFTC_GETPROGNAME(), archive_version_string(),
 431             elftc_version());
 432         exit(EXIT_SUCCESS);
 433 }