]> git.cameronkatri.com Git - mandoc.git/blob - read.c
Fix a regression caused by the insertion of two new tokens,
[mandoc.git] / read.c
1 /* $Id: read.c,v 1.219 2020/04/24 12:02:33 schwarze Exp $ */
2 /*
3 * Copyright (c) 2010-2020 Ingo Schwarze <schwarze@openbsd.org>
4 * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
5 * Copyright (c) 2010, 2012 Joerg Sonnenberger <joerg@netbsd.org>
6 *
7 * Permission to use, copy, modify, and distribute this software for any
8 * purpose with or without fee is hereby granted, provided that the above
9 * copyright notice and this permission notice appear in all copies.
10 *
11 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
12 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
14 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18 *
19 * Top-level functions of the mandoc(3) parser:
20 * Parser and input encoding selection, decompression,
21 * handling of input bytes, characters, lines, and files,
22 * handling of roff(7) loops and file inclusion,
23 * and steering of the various parsers.
24 */
25 #include "config.h"
26
27 #include <sys/types.h>
28 #include <sys/mman.h>
29 #include <sys/stat.h>
30
31 #include <assert.h>
32 #include <ctype.h>
33 #include <errno.h>
34 #include <fcntl.h>
35 #include <stdarg.h>
36 #include <stdio.h>
37 #include <stdlib.h>
38 #include <string.h>
39 #include <unistd.h>
40 #include <zlib.h>
41
42 #include "mandoc_aux.h"
43 #include "mandoc.h"
44 #include "roff.h"
45 #include "mdoc.h"
46 #include "man.h"
47 #include "mandoc_parse.h"
48 #include "libmandoc.h"
49 #include "roff_int.h"
50 #include "tag.h"
51
52 #define REPARSE_LIMIT 1000
53
54 struct mparse {
55 struct roff *roff; /* roff parser (!NULL) */
56 struct roff_man *man; /* man parser */
57 struct buf *primary; /* buffer currently being parsed */
58 struct buf *secondary; /* copy of top level input */
59 struct buf *loop; /* open .while request line */
60 const char *os_s; /* default operating system */
61 int options; /* parser options */
62 int gzip; /* current input file is gzipped */
63 int filenc; /* encoding of the current file */
64 int reparse_count; /* finite interp. stack */
65 int line; /* line number in the file */
66 };
67
68 static void choose_parser(struct mparse *);
69 static void free_buf_list(struct buf *);
70 static void resize_buf(struct buf *, size_t);
71 static int mparse_buf_r(struct mparse *, struct buf, size_t, int);
72 static int read_whole_file(struct mparse *, int, struct buf *, int *);
73 static void mparse_end(struct mparse *);
74
75
76 static void
77 resize_buf(struct buf *buf, size_t initial)
78 {
79
80 buf->sz = buf->sz > initial/2 ? 2 * buf->sz : initial;
81 buf->buf = mandoc_realloc(buf->buf, buf->sz);
82 }
83
84 static void
85 free_buf_list(struct buf *buf)
86 {
87 struct buf *tmp;
88
89 while (buf != NULL) {
90 tmp = buf;
91 buf = tmp->next;
92 free(tmp->buf);
93 free(tmp);
94 }
95 }
96
97 static void
98 choose_parser(struct mparse *curp)
99 {
100 char *cp, *ep;
101 int format;
102
103 /*
104 * If neither command line arguments -mdoc or -man select
105 * a parser nor the roff parser found a .Dd or .TH macro
106 * yet, look ahead in the main input buffer.
107 */
108
109 if ((format = roff_getformat(curp->roff)) == 0) {
110 cp = curp->primary->buf;
111 ep = cp + curp->primary->sz;
112 while (cp < ep) {
113 if (*cp == '.' || *cp == '\'') {
114 cp++;
115 if (cp[0] == 'D' && cp[1] == 'd') {
116 format = MPARSE_MDOC;
117 break;
118 }
119 if (cp[0] == 'T' && cp[1] == 'H') {
120 format = MPARSE_MAN;
121 break;
122 }
123 }
124 cp = memchr(cp, '\n', ep - cp);
125 if (cp == NULL)
126 break;
127 cp++;
128 }
129 }
130
131 if (format == MPARSE_MDOC) {
132 curp->man->meta.macroset = MACROSET_MDOC;
133 if (curp->man->mdocmac == NULL)
134 curp->man->mdocmac = roffhash_alloc(MDOC_Dd, MDOC_MAX);
135 } else {
136 curp->man->meta.macroset = MACROSET_MAN;
137 if (curp->man->manmac == NULL)
138 curp->man->manmac = roffhash_alloc(MAN_TH, MAN_MAX);
139 }
140 curp->man->meta.first->tok = TOKEN_NONE;
141 }
142
143 /*
144 * Main parse routine for a buffer.
145 * It assumes encoding and line numbering are already set up.
146 * It can recurse directly (for invocations of user-defined
147 * macros, inline equations, and input line traps)
148 * and indirectly (for .so file inclusion).
149 */
150 static int
151 mparse_buf_r(struct mparse *curp, struct buf blk, size_t i, int start)
152 {
153 struct buf ln;
154 struct buf *firstln, *lastln, *thisln, *loop;
155 char *cp;
156 size_t pos; /* byte number in the ln buffer */
157 int line_result, result;
158 int of;
159 int lnn; /* line number in the real file */
160 int fd;
161 int inloop; /* Saw .while on this level. */
162 unsigned char c;
163
164 ln.sz = 256;
165 ln.buf = mandoc_malloc(ln.sz);
166 ln.next = NULL;
167 firstln = lastln = loop = NULL;
168 lnn = curp->line;
169 pos = 0;
170 inloop = 0;
171 result = ROFF_CONT;
172
173 while (i < blk.sz && (blk.buf[i] != '\0' || pos != 0)) {
174 if (start) {
175 curp->line = lnn;
176 curp->reparse_count = 0;
177
178 if (lnn < 3 &&
179 curp->filenc & MPARSE_UTF8 &&
180 curp->filenc & MPARSE_LATIN1)
181 curp->filenc = preconv_cue(&blk, i);
182 }
183
184 while (i < blk.sz && (start || blk.buf[i] != '\0')) {
185
186 /*
187 * When finding an unescaped newline character,
188 * leave the character loop to process the line.
189 * Skip a preceding carriage return, if any.
190 */
191
192 if ('\r' == blk.buf[i] && i + 1 < blk.sz &&
193 '\n' == blk.buf[i + 1])
194 ++i;
195 if ('\n' == blk.buf[i]) {
196 ++i;
197 ++lnn;
198 break;
199 }
200
201 /*
202 * Make sure we have space for the worst
203 * case of 12 bytes: "\\[u10ffff]\n\0"
204 */
205
206 if (pos + 12 > ln.sz)
207 resize_buf(&ln, 256);
208
209 /*
210 * Encode 8-bit input.
211 */
212
213 c = blk.buf[i];
214 if (c & 0x80) {
215 if ( ! (curp->filenc && preconv_encode(
216 &blk, &i, &ln, &pos, &curp->filenc))) {
217 mandoc_msg(MANDOCERR_CHAR_BAD,
218 curp->line, pos, "0x%x", c);
219 ln.buf[pos++] = '?';
220 i++;
221 }
222 continue;
223 }
224
225 /*
226 * Exclude control characters.
227 */
228
229 if (c == 0x7f || (c < 0x20 && c != 0x09)) {
230 mandoc_msg(c == 0x00 || c == 0x04 ||
231 c > 0x0a ? MANDOCERR_CHAR_BAD :
232 MANDOCERR_CHAR_UNSUPP,
233 curp->line, pos, "0x%x", c);
234 i++;
235 if (c != '\r')
236 ln.buf[pos++] = '?';
237 continue;
238 }
239
240 ln.buf[pos++] = blk.buf[i++];
241 }
242 ln.buf[pos] = '\0';
243
244 /*
245 * Maintain a lookaside buffer of all lines.
246 * parsed from this input source.
247 */
248
249 thisln = mandoc_malloc(sizeof(*thisln));
250 thisln->buf = mandoc_strdup(ln.buf);
251 thisln->sz = strlen(ln.buf) + 1;
252 thisln->next = NULL;
253 if (firstln == NULL) {
254 firstln = lastln = thisln;
255 if (curp->secondary == NULL)
256 curp->secondary = firstln;
257 } else {
258 lastln->next = thisln;
259 lastln = thisln;
260 }
261
262 /* XXX Ugly hack to mark the end of the input. */
263
264 if (i == blk.sz || blk.buf[i] == '\0') {
265 if (pos + 2 > ln.sz)
266 resize_buf(&ln, 256);
267 ln.buf[pos++] = '\n';
268 ln.buf[pos] = '\0';
269 }
270
271 /*
272 * A significant amount of complexity is contained by
273 * the roff preprocessor. It's line-oriented but can be
274 * expressed on one line, so we need at times to
275 * readjust our starting point and re-run it. The roff
276 * preprocessor can also readjust the buffers with new
277 * data, so we pass them in wholesale.
278 */
279
280 of = 0;
281 rerun:
282 line_result = roff_parseln(curp->roff, curp->line, &ln, &of);
283
284 /* Process options. */
285
286 if (line_result & ROFF_APPEND)
287 assert(line_result == (ROFF_IGN | ROFF_APPEND));
288
289 if (line_result & ROFF_USERCALL)
290 assert((line_result & ROFF_MASK) == ROFF_REPARSE);
291
292 if (line_result & ROFF_USERRET) {
293 assert(line_result == (ROFF_IGN | ROFF_USERRET));
294 if (start == 0) {
295 /* Return from the current macro. */
296 result = ROFF_USERRET;
297 goto out;
298 }
299 }
300
301 switch (line_result & ROFF_LOOPMASK) {
302 case ROFF_IGN:
303 break;
304 case ROFF_WHILE:
305 if (curp->loop != NULL) {
306 if (loop == curp->loop)
307 break;
308 mandoc_msg(MANDOCERR_WHILE_NEST,
309 curp->line, pos, NULL);
310 }
311 curp->loop = thisln;
312 loop = NULL;
313 inloop = 1;
314 break;
315 case ROFF_LOOPCONT:
316 case ROFF_LOOPEXIT:
317 if (curp->loop == NULL) {
318 mandoc_msg(MANDOCERR_WHILE_FAIL,
319 curp->line, pos, NULL);
320 break;
321 }
322 if (inloop == 0) {
323 mandoc_msg(MANDOCERR_WHILE_INTO,
324 curp->line, pos, NULL);
325 curp->loop = loop = NULL;
326 break;
327 }
328 if (line_result & ROFF_LOOPCONT)
329 loop = curp->loop;
330 else {
331 curp->loop = loop = NULL;
332 inloop = 0;
333 }
334 break;
335 default:
336 abort();
337 }
338
339 /* Process the main instruction from the roff parser. */
340
341 switch (line_result & ROFF_MASK) {
342 case ROFF_IGN:
343 break;
344 case ROFF_CONT:
345 if (curp->man->meta.macroset == MACROSET_NONE)
346 choose_parser(curp);
347 if ((curp->man->meta.macroset == MACROSET_MDOC ?
348 mdoc_parseln(curp->man, curp->line, ln.buf, of) :
349 man_parseln(curp->man, curp->line, ln.buf, of)
350 ) == 2)
351 goto out;
352 break;
353 case ROFF_RERUN:
354 goto rerun;
355 case ROFF_REPARSE:
356 if (++curp->reparse_count > REPARSE_LIMIT) {
357 /* Abort and return to the top level. */
358 result = ROFF_IGN;
359 mandoc_msg(MANDOCERR_ROFFLOOP,
360 curp->line, pos, NULL);
361 goto out;
362 }
363 result = mparse_buf_r(curp, ln, of, 0);
364 if (line_result & ROFF_USERCALL) {
365 roff_userret(curp->roff);
366 /* Continue normally. */
367 if (result & ROFF_USERRET)
368 result = ROFF_CONT;
369 }
370 if (start == 0 && result != ROFF_CONT)
371 goto out;
372 break;
373 case ROFF_SO:
374 if ( ! (curp->options & MPARSE_SO) &&
375 (i >= blk.sz || blk.buf[i] == '\0')) {
376 curp->man->meta.sodest =
377 mandoc_strdup(ln.buf + of);
378 goto out;
379 }
380 if ((fd = mparse_open(curp, ln.buf + of)) != -1) {
381 mparse_readfd(curp, fd, ln.buf + of);
382 close(fd);
383 } else {
384 mandoc_msg(MANDOCERR_SO_FAIL,
385 curp->line, of, ".so %s: %s",
386 ln.buf + of, strerror(errno));
387 ln.sz = mandoc_asprintf(&cp,
388 ".sp\nSee the file %s.\n.sp",
389 ln.buf + of);
390 free(ln.buf);
391 ln.buf = cp;
392 of = 0;
393 mparse_buf_r(curp, ln, of, 0);
394 }
395 break;
396 default:
397 abort();
398 }
399
400 /* Start the next input line. */
401
402 if (loop != NULL &&
403 (line_result & ROFF_LOOPMASK) == ROFF_IGN)
404 loop = loop->next;
405
406 if (loop != NULL) {
407 if ((line_result & ROFF_APPEND) == 0)
408 *ln.buf = '\0';
409 if (ln.sz < loop->sz)
410 resize_buf(&ln, loop->sz);
411 (void)strlcat(ln.buf, loop->buf, ln.sz);
412 of = 0;
413 goto rerun;
414 }
415
416 pos = (line_result & ROFF_APPEND) ? strlen(ln.buf) : 0;
417 }
418 out:
419 if (inloop) {
420 if (result != ROFF_USERRET)
421 mandoc_msg(MANDOCERR_WHILE_OUTOF,
422 curp->line, pos, NULL);
423 curp->loop = NULL;
424 }
425 free(ln.buf);
426 if (firstln != curp->secondary)
427 free_buf_list(firstln);
428 return result;
429 }
430
431 static int
432 read_whole_file(struct mparse *curp, int fd, struct buf *fb, int *with_mmap)
433 {
434 struct stat st;
435 gzFile gz;
436 size_t off;
437 ssize_t ssz;
438 int gzerrnum, retval;
439
440 if (fstat(fd, &st) == -1) {
441 mandoc_msg(MANDOCERR_FSTAT, 0, 0, "%s", strerror(errno));
442 return -1;
443 }
444
445 /*
446 * If we're a regular file, try just reading in the whole entry
447 * via mmap(). This is faster than reading it into blocks, and
448 * since each file is only a few bytes to begin with, I'm not
449 * concerned that this is going to tank any machines.
450 */
451
452 if (curp->gzip == 0 && S_ISREG(st.st_mode)) {
453 if (st.st_size > 0x7fffffff) {
454 mandoc_msg(MANDOCERR_TOOLARGE, 0, 0, NULL);
455 return -1;
456 }
457 *with_mmap = 1;
458 fb->sz = (size_t)st.st_size;
459 fb->buf = mmap(NULL, fb->sz, PROT_READ, MAP_SHARED, fd, 0);
460 if (fb->buf != MAP_FAILED)
461 return 0;
462 }
463
464 if (curp->gzip) {
465 /*
466 * Duplicating the file descriptor is required
467 * because we will have to call gzclose(3)
468 * to free memory used internally by zlib,
469 * but that will also close the file descriptor,
470 * which this function must not do.
471 */
472 if ((fd = dup(fd)) == -1) {
473 mandoc_msg(MANDOCERR_DUP, 0, 0,
474 "%s", strerror(errno));
475 return -1;
476 }
477 if ((gz = gzdopen(fd, "rb")) == NULL) {
478 mandoc_msg(MANDOCERR_GZDOPEN, 0, 0,
479 "%s", strerror(errno));
480 close(fd);
481 return -1;
482 }
483 } else
484 gz = NULL;
485
486 /*
487 * If this isn't a regular file (like, say, stdin), then we must
488 * go the old way and just read things in bit by bit.
489 */
490
491 *with_mmap = 0;
492 off = 0;
493 retval = -1;
494 fb->sz = 0;
495 fb->buf = NULL;
496 for (;;) {
497 if (off == fb->sz) {
498 if (fb->sz == (1U << 31)) {
499 mandoc_msg(MANDOCERR_TOOLARGE, 0, 0, NULL);
500 break;
501 }
502 resize_buf(fb, 65536);
503 }
504 ssz = curp->gzip ?
505 gzread(gz, fb->buf + (int)off, fb->sz - off) :
506 read(fd, fb->buf + (int)off, fb->sz - off);
507 if (ssz == 0) {
508 fb->sz = off;
509 retval = 0;
510 break;
511 }
512 if (ssz == -1) {
513 if (curp->gzip)
514 (void)gzerror(gz, &gzerrnum);
515 mandoc_msg(MANDOCERR_READ, 0, 0, "%s",
516 curp->gzip && gzerrnum != Z_ERRNO ?
517 zError(gzerrnum) : strerror(errno));
518 break;
519 }
520 off += (size_t)ssz;
521 }
522
523 if (curp->gzip && (gzerrnum = gzclose(gz)) != Z_OK)
524 mandoc_msg(MANDOCERR_GZCLOSE, 0, 0, "%s",
525 gzerrnum == Z_ERRNO ? strerror(errno) :
526 zError(gzerrnum));
527 if (retval == -1) {
528 free(fb->buf);
529 fb->buf = NULL;
530 }
531 return retval;
532 }
533
534 static void
535 mparse_end(struct mparse *curp)
536 {
537 if (curp->man->meta.macroset == MACROSET_NONE)
538 curp->man->meta.macroset = MACROSET_MAN;
539 if (curp->man->meta.macroset == MACROSET_MDOC)
540 mdoc_endparse(curp->man);
541 else
542 man_endparse(curp->man);
543 roff_endparse(curp->roff);
544 }
545
546 /*
547 * Read the whole file into memory and call the parsers.
548 * Called recursively when an .so request is encountered.
549 */
550 void
551 mparse_readfd(struct mparse *curp, int fd, const char *filename)
552 {
553 static int recursion_depth;
554
555 struct buf blk;
556 struct buf *save_primary;
557 const char *save_filename, *cp;
558 size_t offset;
559 int save_filenc, save_lineno;
560 int with_mmap;
561
562 if (recursion_depth > 64) {
563 mandoc_msg(MANDOCERR_ROFFLOOP, curp->line, 0, NULL);
564 return;
565 } else if (recursion_depth == 0 &&
566 (cp = strrchr(filename, '.')) != NULL &&
567 cp[1] >= '1' && cp[1] <= '9')
568 curp->man->filesec = cp[1];
569 else
570 curp->man->filesec = '\0';
571
572 if (read_whole_file(curp, fd, &blk, &with_mmap) == -1)
573 return;
574
575 /*
576 * Save some properties of the parent file.
577 */
578
579 save_primary = curp->primary;
580 save_filenc = curp->filenc;
581 save_lineno = curp->line;
582 save_filename = mandoc_msg_getinfilename();
583
584 curp->primary = &blk;
585 curp->filenc = curp->options & (MPARSE_UTF8 | MPARSE_LATIN1);
586 curp->line = 1;
587 mandoc_msg_setinfilename(filename);
588
589 /* Skip an UTF-8 byte order mark. */
590 if (curp->filenc & MPARSE_UTF8 && blk.sz > 2 &&
591 (unsigned char)blk.buf[0] == 0xef &&
592 (unsigned char)blk.buf[1] == 0xbb &&
593 (unsigned char)blk.buf[2] == 0xbf) {
594 offset = 3;
595 curp->filenc &= ~MPARSE_LATIN1;
596 } else
597 offset = 0;
598
599 recursion_depth++;
600 mparse_buf_r(curp, blk, offset, 1);
601 if (--recursion_depth == 0)
602 mparse_end(curp);
603
604 /*
605 * Clean up and restore saved parent properties.
606 */
607
608 if (with_mmap)
609 munmap(blk.buf, blk.sz);
610 else
611 free(blk.buf);
612
613 curp->primary = save_primary;
614 curp->filenc = save_filenc;
615 curp->line = save_lineno;
616 if (save_filename != NULL)
617 mandoc_msg_setinfilename(save_filename);
618 }
619
620 int
621 mparse_open(struct mparse *curp, const char *file)
622 {
623 char *cp;
624 int fd, save_errno;
625
626 cp = strrchr(file, '.');
627 curp->gzip = (cp != NULL && ! strcmp(cp + 1, "gz"));
628
629 /* First try to use the filename as it is. */
630
631 if ((fd = open(file, O_RDONLY)) != -1)
632 return fd;
633
634 /*
635 * If that doesn't work and the filename doesn't
636 * already end in .gz, try appending .gz.
637 */
638
639 if ( ! curp->gzip) {
640 save_errno = errno;
641 mandoc_asprintf(&cp, "%s.gz", file);
642 fd = open(cp, O_RDONLY);
643 free(cp);
644 errno = save_errno;
645 if (fd != -1) {
646 curp->gzip = 1;
647 return fd;
648 }
649 }
650
651 /* Neither worked, give up. */
652
653 return -1;
654 }
655
656 struct mparse *
657 mparse_alloc(int options, enum mandoc_os os_e, const char *os_s)
658 {
659 struct mparse *curp;
660
661 curp = mandoc_calloc(1, sizeof(struct mparse));
662
663 curp->options = options;
664 curp->os_s = os_s;
665
666 curp->roff = roff_alloc(options);
667 curp->man = roff_man_alloc(curp->roff, curp->os_s,
668 curp->options & MPARSE_QUICK ? 1 : 0);
669 if (curp->options & MPARSE_MDOC) {
670 curp->man->meta.macroset = MACROSET_MDOC;
671 if (curp->man->mdocmac == NULL)
672 curp->man->mdocmac = roffhash_alloc(MDOC_Dd, MDOC_MAX);
673 } else if (curp->options & MPARSE_MAN) {
674 curp->man->meta.macroset = MACROSET_MAN;
675 if (curp->man->manmac == NULL)
676 curp->man->manmac = roffhash_alloc(MAN_TH, MAN_MAX);
677 }
678 curp->man->meta.first->tok = TOKEN_NONE;
679 curp->man->meta.os_e = os_e;
680 tag_alloc();
681 return curp;
682 }
683
684 void
685 mparse_reset(struct mparse *curp)
686 {
687 tag_free();
688 roff_reset(curp->roff);
689 roff_man_reset(curp->man);
690 free_buf_list(curp->secondary);
691 curp->secondary = NULL;
692 curp->gzip = 0;
693 tag_alloc();
694 }
695
696 void
697 mparse_free(struct mparse *curp)
698 {
699 tag_free();
700 roffhash_free(curp->man->mdocmac);
701 roffhash_free(curp->man->manmac);
702 roff_man_free(curp->man);
703 roff_free(curp->roff);
704 free_buf_list(curp->secondary);
705 free(curp);
706 }
707
708 struct roff_meta *
709 mparse_result(struct mparse *curp)
710 {
711 roff_state_reset(curp->man);
712 if (curp->options & MPARSE_VALIDATE) {
713 if (curp->man->meta.macroset == MACROSET_MDOC)
714 mdoc_validate(curp->man);
715 else
716 man_validate(curp->man);
717 tag_postprocess(curp->man, curp->man->meta.first);
718 }
719 return &curp->man->meta;
720 }
721
722 void
723 mparse_copy(const struct mparse *p)
724 {
725 struct buf *buf;
726
727 for (buf = p->secondary; buf != NULL; buf = buf->next)
728 puts(buf->buf);
729 }