src/split.c

   1 /* split.c -- split a file into pieces.
   2    Copyright (C) 88, 91, 1995-2004 Free Software Foundation, Inc.
   3
   4    This program is free software; you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation; either version 2, or (at your option)
   7    any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program; if not, write to the Free Software Foundation,
  16    Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  17 \f
  18 /* By tege@sics.se, with rms.
  19
  20    To do:
  21    * Implement -t CHAR or -t REGEX to specify break characters other
  22      than newline. */
  23
  24 #include <config.h>
  25
  26 #include <stdio.h>
  27 #include <getopt.h>
  28 #include <sys/types.h>
  29
  30 #include "system.h"
  31 #include "dirname.h"
  32 #include "error.h"
  33 #include "getpagesize.h"
  34 #include "full-read.h"
  35 #include "full-write.h"
  36 #include "inttostr.h"
  37 #include "posixver.h"
  38 #include "quote.h"
  39 #include "safe-read.h"
  40 #include "xstrtol.h"
  41
  42 /* The official name of this program (e.g., no `g' prefix).  */
  43 #define PROGRAM_NAME "split"
  44
  45 #define AUTHORS "Torbjorn Granlund", "Richard M. Stallman"
  46
  47 #define DEFAULT_SUFFIX_LENGTH 2
  48
  49 /* The name this program was run with. */
  50 char *program_name;
  51
  52 /* Base name of output files.  */
  53 static char const *outbase;
  54
  55 /* Name of output files.  */
  56 static char *outfile;
  57
  58 /* Pointer to the end of the prefix in OUTFILE.
  59    Suffixes are inserted here.  */
  60 static char *outfile_mid;
  61
  62 /* Length of OUTFILE's suffix.  */
  63 static size_t suffix_length = DEFAULT_SUFFIX_LENGTH;
  64
  65 /* Alphabet of characters to use in suffix.  */
  66 static char const *suffix_alphabet = "abcdefghijklmnopqrstuvwxyz";
  67
  68 /* Name of input file.  May be "-".  */
  69 static char *infile;
  70
  71 /* Descriptor on which input file is open.  */
  72 static int input_desc;
  73
  74 /* Descriptor on which output file is open.  */
  75 static int output_desc;
  76
  77 /* If true, print a diagnostic on standard error just before each
  78    output file is opened. */
  79 static bool verbose;
  80
  81 /* For long options that have no equivalent short option, use a
  82    non-character as a pseudo short option, starting with CHAR_MAX + 1.  */
  83 enum
  84 {
  85   VERBOSE_OPTION = CHAR_MAX + 1
  86 };
  87
  88 static struct option const longopts[] =
  89 {
  90   {"bytes", required_argument, NULL, 'b'},
  91   {"lines", required_argument, NULL, 'l'},
  92   {"line-bytes", required_argument, NULL, 'C'},
  93   {"suffix-length", required_argument, NULL, 'a'},
  94   {"numeric-suffixes", no_argument, NULL, 'd'},
  95   {"verbose", no_argument, NULL, VERBOSE_OPTION},
  96   {GETOPT_HELP_OPTION_DECL},
  97   {GETOPT_VERSION_OPTION_DECL},
  98   {NULL, 0, NULL, 0}
  99 };
 100
 101 void
 102 usage (int status)
 103 {
 104   if (status != EXIT_SUCCESS)
 105     fprintf (stderr, _("Try `%s --help' for more information.\n"),
 106              program_name);
 107   else
 108     {
 109       printf (_("\
 110 Usage: %s [OPTION] [INPUT [PREFIX]]\n\
 111 "),
 112               program_name);
 113     fputs (_("\
 114 Output fixed-size pieces of INPUT to PREFIXaa, PREFIXab, ...; default\n\
 115 size is 1000 lines, and default PREFIX is `x'.  With no INPUT, or when INPUT\n\
 116 is -, read standard input.\n\
 117 \n\
 118 "), stdout);
 119       fputs (_("\
 120 Mandatory arguments to long options are mandatory for short options too.\n\
 121 "), stdout);
 122       fprintf (stdout, _("\
 123   -a, --suffix-length=N   use suffixes of length N (default %d)\n\
 124   -b, --bytes=SIZE        put SIZE bytes per output file\n\
 125   -C, --line-bytes=SIZE   put at most SIZE bytes of lines per output file\n\
 126   -d, --numeric-suffixes  use numeric suffixes instead of alphabetic\n\
 127   -l, --lines=NUMBER      put NUMBER lines per output file\n\
 128 "), DEFAULT_SUFFIX_LENGTH);
 129       fputs (_("\
 130       --verbose           print a diagnostic to standard error just\n\
 131                             before each output file is opened\n\
 132 "), stdout);
 133       fputs (HELP_OPTION_DESCRIPTION, stdout);
 134       fputs (VERSION_OPTION_DESCRIPTION, stdout);
 135       fputs (_("\
 136 \n\
 137 SIZE may have a multiplier suffix: b for 512, k for 1K, m for 1 Meg.\n\
 138 "), stdout);
 139       printf (_("\nReport bugs to <%s>.\n"), PACKAGE_BUGREPORT);
 140     }
 141   exit (status);
 142 }
 143
 144 /* Compute the next sequential output file name and store it into the
 145    string `outfile'.  */
 146
 147 static void
 148 next_file_name (void)
 149 {
 150   /* Index in suffix_alphabet of each character in the suffix.  */
 151   static size_t *sufindex;
 152
 153   if (! outfile)
 154     {
 155       /* Allocate and initialize the first file name.  */
 156
 157       size_t outbase_length = strlen (outbase);
 158       size_t outfile_length = outbase_length + suffix_length;
 159       if (outfile_length + 1 < outbase_length)
 160         xalloc_die ();
 161       outfile = xmalloc (outfile_length + 1);
 162       outfile_mid = outfile + outbase_length;
 163       memcpy (outfile, outbase, outbase_length);
 164       memset (outfile_mid, suffix_alphabet[0], suffix_length);
 165       outfile[outfile_length] = 0;
 166       sufindex = xcalloc (suffix_length, sizeof *sufindex);
 167
 168 #if ! _POSIX_NO_TRUNC && HAVE_PATHCONF && defined _PC_NAME_MAX
 169       /* POSIX requires that if the output file name is too long for
 170          its directory, `split' must fail without creating any files.
 171          This must be checked for explicitly on operating systems that
 172          silently truncate file names.  */
 173       {
 174         char *dir = dir_name (outfile);
 175         long name_max = pathconf (dir, _PC_NAME_MAX);
 176         if (0 <= name_max && name_max < base_len (base_name (outfile)))
 177           error (EXIT_FAILURE, ENAMETOOLONG, "%s", outfile);
 178         free (dir);
 179       }
 180 #endif
 181     }
 182   else
 183     {
 184       /* Increment the suffix in place, if possible.  */
 185
 186       size_t i = suffix_length;
 187       while (i-- != 0)
 188         {
 189           sufindex[i]++;
 190           outfile_mid[i] = suffix_alphabet[sufindex[i]];
 191           if (outfile_mid[i])
 192             return;
 193           sufindex[i] = 0;
 194           outfile_mid[i] = suffix_alphabet[sufindex[i]];
 195         }
 196       error (EXIT_FAILURE, 0, _("Output file suffixes exhausted"));
 197     }
 198 }
 199
 200 /* Write BYTES bytes at BP to an output file.
 201    If NEW_FILE_FLAG is true, open the next output file.
 202    Otherwise add to the same output file already in use.  */
 203
 204 static void
 205 cwrite (bool new_file_flag, const char *bp, size_t bytes)
 206 {
 207   if (new_file_flag)
 208     {
 209       if (output_desc >= 0 && close (output_desc) < 0)
 210         error (EXIT_FAILURE, errno, "%s", outfile);
 211
 212       next_file_name ();
 213       if (verbose)
 214         fprintf (stderr, _("creating file `%s'\n"), outfile);
 215       output_desc = open (outfile,
 216                           O_WRONLY | O_CREAT | O_TRUNC | O_BINARY, 0666);
 217       if (output_desc < 0)
 218         error (EXIT_FAILURE, errno, "%s", outfile);
 219     }
 220   if (full_write (output_desc, bp, bytes) != bytes)
 221     error (EXIT_FAILURE, errno, "%s", outfile);
 222 }
 223
 224 /* Split into pieces of exactly N_BYTES bytes.
 225    Use buffer BUF, whose size is BUFSIZE.  */
 226
 227 static void
 228 bytes_split (uintmax_t n_bytes, char *buf, size_t bufsize)
 229 {
 230   size_t n_read;
 231   bool new_file_flag = true;
 232   size_t to_read;
 233   uintmax_t to_write = n_bytes;
 234   char *bp_out;
 235
 236   do
 237     {
 238       n_read = full_read (input_desc, buf, bufsize);
 239       if (n_read == SAFE_READ_ERROR)
 240         error (EXIT_FAILURE, errno, "%s", infile);
 241       bp_out = buf;
 242       to_read = n_read;
 243       for (;;)
 244         {
 245           if (to_read < to_write)
 246             {
 247               if (to_read)      /* do not write 0 bytes! */
 248                 {
 249                   cwrite (new_file_flag, bp_out, to_read);
 250                   to_write -= to_read;
 251                   new_file_flag = false;
 252                 }
 253               break;
 254             }
 255           else
 256             {
 257               size_t w = to_write;
 258               cwrite (new_file_flag, bp_out, w);
 259               bp_out += w;
 260               to_read -= w;
 261               new_file_flag = true;
 262               to_write = n_bytes;
 263             }
 264         }
 265     }
 266   while (n_read == bufsize);
 267 }
 268
 269 /* Split into pieces of exactly N_LINES lines.
 270    Use buffer BUF, whose size is BUFSIZE.  */
 271
 272 static void
 273 lines_split (uintmax_t n_lines, char *buf, size_t bufsize)
 274 {
 275   size_t n_read;
 276   char *bp, *bp_out, *eob;
 277   bool new_file_flag = true;
 278   uintmax_t n = 0;
 279
 280   do
 281     {
 282       n_read = full_read (input_desc, buf, bufsize);
 283       if (n_read == SAFE_READ_ERROR)
 284         error (EXIT_FAILURE, errno, "%s", infile);
 285       bp = bp_out = buf;
 286       eob = bp + n_read;
 287       *eob = '\n';
 288       for (;;)
 289         {
 290           bp = memchr (bp, '\n', eob - bp + 1);
 291           if (bp == eob)
 292             {
 293               if (eob != bp_out) /* do not write 0 bytes! */
 294                 {
 295                   size_t len = eob - bp_out;
 296                   cwrite (new_file_flag, bp_out, len);
 297                   new_file_flag = false;
 298                 }
 299               break;
 300             }
 301
 302           ++bp;
 303           if (++n >= n_lines)
 304             {
 305               cwrite (new_file_flag, bp_out, bp - bp_out);
 306               bp_out = bp;
 307               new_file_flag = true;
 308               n = 0;
 309             }
 310         }
 311     }
 312   while (n_read == bufsize);
 313 }
 314 \f
 315 /* Split into pieces that are as large as possible while still not more
 316    than N_BYTES bytes, and are split on line boundaries except
 317    where lines longer than N_BYTES bytes occur.
 318    FIXME: Allow N_BYTES to be any uintmax_t value, and don't require a
 319    buffer of size N_BYTES, in case N_BYTES is very large.  */
 320
 321 static void
 322 line_bytes_split (size_t n_bytes)
 323 {
 324   size_t n_read;
 325   char *bp;
 326   bool eof = false;
 327   size_t n_buffered = 0;
 328   char *buf = xmalloc (n_bytes);
 329
 330   do
 331     {
 332       /* Fill up the full buffer size from the input file.  */
 333
 334       n_read = full_read (input_desc, buf + n_buffered, n_bytes - n_buffered);
 335       if (n_read == SAFE_READ_ERROR)
 336         error (EXIT_FAILURE, errno, "%s", infile);
 337
 338       n_buffered += n_read;
 339       if (n_buffered != n_bytes)
 340         eof = true;
 341
 342       /* Find where to end this chunk.  */
 343       bp = buf + n_buffered;
 344       if (n_buffered == n_bytes)
 345         {
 346           while (bp > buf && bp[-1] != '\n')
 347             bp--;
 348         }
 349
 350       /* If chunk has no newlines, use all the chunk.  */
 351       if (bp == buf)
 352         bp = buf + n_buffered;
 353
 354       /* Output the chars as one output file.  */
 355       cwrite (true, buf, bp - buf);
 356
 357       /* Discard the chars we just output; move rest of chunk
 358          down to be the start of the next chunk.  Source and
 359          destination probably overlap.  */
 360       n_buffered -= bp - buf;
 361       if (n_buffered > 0)
 362         memmove (buf, bp, n_buffered);
 363     }
 364   while (!eof);
 365   free (buf);
 366 }
 367
 368 #define FAIL_ONLY_ONE_WAY()                                     \
 369   do                                                            \
 370     {                                                           \
 371       error (0, 0, _("cannot split in more than one way"));     \
 372       usage (EXIT_FAILURE);                                     \
 373     }                                                           \
 374   while (0)
 375
 376 int
 377 main (int argc, char **argv)
 378 {
 379   struct stat stat_buf;
 380   enum
 381     {
 382       type_undef, type_bytes, type_byteslines, type_lines, type_digits
 383     } split_type = type_undef;
 384   size_t in_blk_size;           /* optimal block size of input file device */
 385   char *buf;                    /* file i/o buffer */
 386   size_t page_size = getpagesize ();
 387   uintmax_t n_units;
 388   int c;
 389   int digits_optind = 0;
 390
 391   initialize_main (&argc, &argv);
 392   program_name = argv[0];
 393   setlocale (LC_ALL, "");
 394   bindtextdomain (PACKAGE, LOCALEDIR);
 395   textdomain (PACKAGE);
 396
 397   atexit (close_stdout);
 398
 399   /* Parse command line options.  */
 400
 401   infile = "-";
 402   outbase = "x";
 403
 404   while (1)
 405     {
 406       /* This is the argv-index of the option we will read next.  */
 407       int this_optind = optind ? optind : 1;
 408
 409       c = getopt_long (argc, argv, "0123456789C:a:b:dl:", longopts, NULL);
 410       if (c == -1)
 411         break;
 412
 413       switch (c)
 414         {
 415         case 'a':
 416           {
 417             unsigned long tmp;
 418             if (xstrtoul (optarg, NULL, 10, &tmp, "") != LONGINT_OK
 419                 || SIZE_MAX / sizeof (size_t) < tmp)
 420               {
 421                 error (0, 0, _("%s: invalid suffix length"), optarg);
 422                 usage (EXIT_FAILURE);
 423               }
 424             suffix_length = tmp;
 425           }
 426           break;
 427
 428         case 'b':
 429           if (split_type != type_undef)
 430             FAIL_ONLY_ONE_WAY ();
 431           split_type = type_bytes;
 432           if (xstrtoumax (optarg, NULL, 10, &n_units, "bkm") != LONGINT_OK
 433               || n_units == 0)
 434             {
 435               error (0, 0, _("%s: invalid number of bytes"), optarg);
 436               usage (EXIT_FAILURE);
 437             }
 438           break;
 439
 440         case 'l':
 441           if (split_type != type_undef)
 442             FAIL_ONLY_ONE_WAY ();
 443           split_type = type_lines;
 444           if (xstrtoumax (optarg, NULL, 10, &n_units, "") != LONGINT_OK
 445               || n_units == 0)
 446             {
 447               error (0, 0, _("%s: invalid number of lines"), optarg);
 448               usage (EXIT_FAILURE);
 449             }
 450           break;
 451
 452         case 'C':
 453           if (split_type != type_undef)
 454             FAIL_ONLY_ONE_WAY ();
 455           split_type = type_byteslines;
 456           if (xstrtoumax (optarg, NULL, 10, &n_units, "bkm") != LONGINT_OK
 457               || n_units == 0 || SIZE_MAX < n_units)
 458             {
 459               error (0, 0, _("%s: invalid number of bytes"), optarg);
 460               usage (EXIT_FAILURE);
 461             }
 462           break;
 463
 464         case '0':
 465         case '1':
 466         case '2':
 467         case '3':
 468         case '4':
 469         case '5':
 470         case '6':
 471         case '7':
 472         case '8':
 473         case '9':
 474           if (split_type == type_undef)
 475             {
 476               split_type = type_digits;
 477               n_units = 0;
 478             }
 479           if (split_type != type_undef && split_type != type_digits)
 480             FAIL_ONLY_ONE_WAY ();
 481           if (digits_optind != 0 && digits_optind != this_optind)
 482             n_units = 0;        /* More than one number given; ignore other. */
 483           digits_optind = this_optind;
 484           if (UINTMAX_MAX / 10 < n_units
 485               || n_units * 10 + c - '0' < n_units * 10)
 486             {
 487               char buffer[INT_BUFSIZE_BOUND (uintmax_t)];
 488               error (EXIT_FAILURE, 0,
 489                      _("line count option -%s%c... is too large"),
 490                      umaxtostr (n_units, buffer), c);
 491             }
 492           n_units = n_units * 10 + c - '0';
 493           break;
 494
 495         case 'd':
 496           suffix_alphabet = "0123456789";
 497           break;
 498
 499         case VERBOSE_OPTION:
 500           verbose = true;
 501           break;
 502
 503         case_GETOPT_HELP_CHAR;
 504
 505         case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
 506
 507         default:
 508           usage (EXIT_FAILURE);
 509         }
 510     }
 511
 512   if (digits_optind && 200112 <= posix2_version ())
 513     {
 514       char buffer[INT_BUFSIZE_BOUND (uintmax_t)];
 515       char const *a = umaxtostr (n_units, buffer);
 516       error (0, 0, _("`-%s' option is obsolete; use `-l %s'"), a, a);
 517       usage (EXIT_FAILURE);
 518     }
 519
 520   /* Handle default case.  */
 521   if (split_type == type_undef)
 522     {
 523       split_type = type_lines;
 524       n_units = 1000;
 525     }
 526
 527   if (n_units == 0)
 528     {
 529       /* FIXME: be sure to remove this block when removing
 530          support for obsolete options like `-10'.  */
 531       error (0, 0, _("invalid number of lines: 0"));
 532       usage (EXIT_FAILURE);
 533     }
 534
 535   /* Get out the filename arguments.  */
 536
 537   if (optind < argc)
 538     infile = argv[optind++];
 539
 540   if (optind < argc)
 541     outbase = argv[optind++];
 542
 543   if (optind < argc)
 544     {
 545       error (0, 0, _("extra operand %s"), quote (argv[optind]));
 546       usage (EXIT_FAILURE);
 547     }
 548
 549   /* Open the input file.  */
 550   if (STREQ (infile, "-"))
 551     input_desc = STDIN_FILENO;
 552   else
 553     {
 554       input_desc = open (infile, O_RDONLY);
 555       if (input_desc < 0)
 556         error (EXIT_FAILURE, errno, "%s", infile);
 557     }
 558   /* Binary I/O is safer when bytecounts are used.  */
 559   SET_BINARY (input_desc);
 560
 561   /* No output file is open now.  */
 562   output_desc = -1;
 563
 564   /* Get the optimal block size of input device and make a buffer.  */
 565
 566   if (fstat (input_desc, &stat_buf) < 0)
 567     error (EXIT_FAILURE, errno, "%s", infile);
 568   in_blk_size = ST_BLKSIZE (stat_buf);
 569
 570   buf = ptr_align (xmalloc (in_blk_size + 1 + page_size - 1), page_size);
 571
 572   switch (split_type)
 573     {
 574     case type_digits:
 575     case type_lines:
 576       lines_split (n_units, buf, in_blk_size);
 577       break;
 578
 579     case type_bytes:
 580       bytes_split (n_units, buf, in_blk_size);
 581       break;
 582
 583     case type_byteslines:
 584       line_bytes_split (n_units);
 585       break;
 586
 587     default:
 588       abort ();
 589     }
 590
 591   if (close (input_desc) < 0)
 592     error (EXIT_FAILURE, errno, "%s", infile);
 593   if (output_desc >= 0 && close (output_desc) < 0)
 594     error (EXIT_FAILURE, errno, "%s", outfile);
 595
 596   exit (EXIT_SUCCESS);
 597 }