usr.bin/tail/reverse.c

   1 /*-
   2  * Copyright (c) 1991, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * This code is derived from software contributed to Berkeley by
   6  * Edward Sze-Tyan Wang.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  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  * 3. All advertising materials mentioning features or use of this software
  17  *    must display the following acknowledgement:
  18  *      This product includes software developed by the University of
  19  *      California, Berkeley and its contributors.
  20  * 4. Neither the name of the University nor the names of its contributors
  21  *    may be used to endorse or promote products derived from this software
  22  *    without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34  * SUCH DAMAGE.
  35  *
  36  * @(#)reverse.c        8.1 (Berkeley) 6/6/93
  37  * $FreeBSD: src/usr.bin/tail/reverse.c,v 1.9.2.3 2001/12/19 20:29:31 iedowse Exp $
  38  * $DragonFly: src/usr.bin/tail/reverse.c,v 1.2 2003/06/17 04:29:32 dillon Exp $
  39  */
  40
  41 #include <sys/param.h>
  42 #include <sys/stat.h>
  43 #include <sys/mman.h>
  44
  45 #include <limits.h>
  46 #include <errno.h>
  47 #include <unistd.h>
  48 #include <stdio.h>
  49 #include <stdlib.h>
  50 #include <string.h>
  51 #include <err.h>
  52 #include "extern.h"
  53
  54 static void r_buf __P((FILE *));
  55 static void r_reg __P((FILE *, enum STYLE, off_t, struct stat *));
  56
  57 /*
  58  * reverse -- display input in reverse order by line.
  59  *
  60  * There are six separate cases for this -- regular and non-regular
  61  * files by bytes, lines or the whole file.
  62  *
  63  * BYTES        display N bytes
  64  *      REG     mmap the file and display the lines
  65  *      NOREG   cyclically read characters into a wrap-around buffer
  66  *
  67  * LINES        display N lines
  68  *      REG     mmap the file and display the lines
  69  *      NOREG   cyclically read lines into a wrap-around array of buffers
  70  *
  71  * FILE         display the entire file
  72  *      REG     mmap the file and display the lines
  73  *      NOREG   cyclically read input into a linked list of buffers
  74  */
  75 void
  76 reverse(fp, style, off, sbp)
  77         FILE *fp;
  78         enum STYLE style;
  79         off_t off;
  80         struct stat *sbp;
  81 {
  82         if (style != REVERSE && off == 0)
  83                 return;
  84
  85         if (S_ISREG(sbp->st_mode))
  86                 r_reg(fp, style, off, sbp);
  87         else
  88                 switch(style) {
  89                 case FBYTES:
  90                 case RBYTES:
  91                         bytes(fp, off);
  92                         break;
  93                 case FLINES:
  94                 case RLINES:
  95                         lines(fp, off);
  96                         break;
  97                 case REVERSE:
  98                         r_buf(fp);
  99                         break;
 100                 }
 101 }
 102
 103 /*
 104  * r_reg -- display a regular file in reverse order by line.
 105  */
 106 static void
 107 r_reg(fp, style, off, sbp)
 108         FILE *fp;
 109         enum STYLE style;
 110         off_t off;
 111         struct stat *sbp;
 112 {
 113         struct mapinfo map;
 114         off_t curoff, size, lineend;
 115         int i;
 116
 117         if (!(size = sbp->st_size))
 118                 return;
 119
 120         map.start = NULL;
 121         map.mapoff = map.maxoff = size;
 122         map.fd = fileno(fp);
 123
 124         /*
 125          * Last char is special, ignore whether newline or not. Note that
 126          * size == 0 is dealt with above, and size == 1 sets curoff to -1.
 127          */
 128         curoff = size - 2;
 129         lineend = size;
 130         while (curoff >= 0) {
 131                 if (curoff < map.mapoff || curoff >= map.mapoff + map.maplen) {
 132                         if (maparound(&map, curoff) != 0) {
 133                                 ierr();
 134                                 return;
 135                         }
 136                 }
 137                 for (i = curoff - map.mapoff; i >= 0; i--) {
 138                         if (style == RBYTES && --off == 0)
 139                                 break;
 140                         if (map.start[i] == '\n')
 141                                 break;
 142                 }
 143                 /* `i' is either the map offset of a '\n', or -1. */
 144                 curoff = map.mapoff + i;
 145                 if (i < 0)
 146                         continue;
 147
 148                 /* Print the line and update offsets. */
 149                 if (mapprint(&map, curoff + 1, lineend - curoff - 1) != 0) {
 150                         ierr();
 151                         return;
 152                 }
 153                 lineend = curoff + 1;
 154                 curoff--;
 155
 156                 if (style == RLINES)
 157                         off--;
 158
 159                 if (off == 0 && style != REVERSE) {
 160                         /* Avoid printing anything below. */
 161                         curoff = 0;
 162                         break;
 163                 }
 164         }
 165         if (curoff < 0 && mapprint(&map, 0, lineend) != 0) {
 166                 ierr();
 167                 return;
 168         }
 169         if (map.start != NULL && munmap(map.start, map.maplen))
 170                 ierr();
 171 }
 172
 173 typedef struct bf {
 174         struct bf *next;
 175         struct bf *prev;
 176         int len;
 177         char *l;
 178 } BF;
 179
 180 /*
 181  * r_buf -- display a non-regular file in reverse order by line.
 182  *
 183  * This is the function that saves the entire input, storing the data in a
 184  * doubly linked list of buffers and then displays them in reverse order.
 185  * It has the usual nastiness of trying to find the newlines, as there's no
 186  * guarantee that a newline occurs anywhere in the file, let alone in any
 187  * particular buffer.  If we run out of memory, input is discarded (and the
 188  * user warned).
 189  */
 190 static void
 191 r_buf(fp)
 192         FILE *fp;
 193 {
 194         BF *mark, *tl, *tr;
 195         int ch, len, llen;
 196         char *p;
 197         off_t enomem;
 198
 199 #define BSZ     (128 * 1024)
 200         for (mark = NULL, enomem = 0;;) {
 201                 /*
 202                  * Allocate a new block and link it into place in a doubly
 203                  * linked list.  If out of memory, toss the LRU block and
 204                  * keep going.
 205                  */
 206                 if (enomem || (tl = malloc(sizeof(BF))) == NULL ||
 207                     (tl->l = malloc(BSZ)) == NULL) {
 208                         if (!mark)
 209                                 err(1, "malloc");
 210                         tl = enomem ? tl->next : mark;
 211                         enomem += tl->len;
 212                 } else if (mark) {
 213                         tl->next = mark;
 214                         tl->prev = mark->prev;
 215                         mark->prev->next = tl;
 216                         mark->prev = tl;
 217                 } else
 218                         mark->next = mark->prev = (mark = tl);
 219
 220                 /* Fill the block with input data. */
 221                 for (p = tl->l, len = 0;
 222                     len < BSZ && (ch = getc(fp)) != EOF; ++len)
 223                         *p++ = ch;
 224
 225                 if (ferror(fp)) {
 226                         ierr();
 227                         return;
 228                 }
 229
 230                 /*
 231                  * If no input data for this block and we tossed some data,
 232                  * recover it.
 233                  */
 234                 if (!len) {
 235                         if (enomem)
 236                                 enomem -= tl->len;
 237                         tl = tl->prev;
 238                         break;
 239                 }
 240
 241                 tl->len = len;
 242                 if (ch == EOF)
 243                         break;
 244         }
 245
 246         if (enomem) {
 247                 warnx("warning: %qd bytes discarded", enomem);
 248                 rval = 1;
 249         }
 250
 251         /*
 252          * Step through the blocks in the reverse order read.  The last char
 253          * is special, ignore whether newline or not.
 254          */
 255         for (mark = tl;;) {
 256                 for (p = tl->l + (len = tl->len) - 1, llen = 0; len--;
 257                     --p, ++llen)
 258                         if (*p == '\n') {
 259                                 if (llen) {
 260                                         WR(p + 1, llen);
 261                                         llen = 0;
 262                                 }
 263                                 if (tl == mark)
 264                                         continue;
 265                                 for (tr = tl->next; tr->len; tr = tr->next) {
 266                                         WR(tr->l, tr->len);
 267                                         tr->len = 0;
 268                                         if (tr == mark)
 269                                                 break;
 270                                 }
 271                         }
 272                 tl->len = llen;
 273                 if ((tl = tl->prev) == mark)
 274                         break;
 275         }
 276         tl = tl->next;
 277         if (tl->len) {
 278                 WR(tl->l, tl->len);
 279                 tl->len = 0;
 280         }
 281         while ((tl = tl->next)->len) {
 282                 WR(tl->l, tl->len);
 283                 tl->len = 0;
 284         }
 285 }