1 /* lib.c - various reusable stuff. 2 * 3 * Copyright 2006 Rob Landley <rob (at) landley.net> 4 */ 5 6 #define SYSLOG_NAMES 7 #include "toys.h" 8 9 void verror_msg(char *msg, int err, va_list va) 10 { 11 char *s = ": %s"; 12 13 fprintf(stderr, "%s: ", toys.which->name); 14 if (msg) vfprintf(stderr, msg, va); 15 else s+=2; 16 if (err>0) fprintf(stderr, s, strerror(err)); 17 if (err<0 && CFG_TOYBOX_HELP) 18 fprintf(stderr, " (see \"%s --help\")", toys.which->name); 19 if (msg || err) putc('\n', stderr); 20 if (!toys.exitval) toys.exitval++; 21 } 22 23 // These functions don't collapse together because of the va_stuff. 24 25 void error_msg(char *msg, ...) 26 { 27 va_list va; 28 29 va_start(va, msg); 30 verror_msg(msg, 0, va); 31 va_end(va); 32 } 33 34 void perror_msg(char *msg, ...) 35 { 36 va_list va; 37 38 va_start(va, msg); 39 verror_msg(msg, errno, va); 40 va_end(va); 41 } 42 43 // Die with an error message. 44 void error_exit(char *msg, ...) 45 { 46 va_list va; 47 48 va_start(va, msg); 49 verror_msg(msg, 0, va); 50 va_end(va); 51 52 xexit(); 53 } 54 55 // Die with an error message and strerror(errno) 56 void perror_exit(char *msg, ...) 57 { 58 // Die silently if our pipeline exited. 59 if (errno != EPIPE) { 60 va_list va; 61 62 va_start(va, msg); 63 verror_msg(msg, errno, va); 64 va_end(va); 65 } 66 67 xexit(); 68 } 69 70 // Exit with an error message after showing help text. 71 void help_exit(char *msg, ...) 72 { 73 va_list va; 74 75 if (!msg) show_help(stdout); 76 else { 77 va_start(va, msg); 78 verror_msg(msg, -1, va); 79 va_end(va); 80 } 81 82 xexit(); 83 } 84 85 // If you want to explicitly disable the printf() behavior (because you're 86 // printing user-supplied data, or because android's static checker produces 87 // false positives for 'char *s = x ? "blah1" : "blah2"; printf(s);' and it's 88 // -Werror there for policy reasons). 89 void error_msg_raw(char *msg) 90 { 91 error_msg("%s", msg); 92 } 93 94 void perror_msg_raw(char *msg) 95 { 96 perror_msg("%s", msg); 97 } 98 99 void error_exit_raw(char *msg) 100 { 101 error_exit("%s", msg); 102 } 103 104 void perror_exit_raw(char *msg) 105 { 106 perror_exit("%s", msg); 107 } 108 109 // Keep reading until full or EOF 110 ssize_t readall(int fd, void *buf, size_t len) 111 { 112 size_t count = 0; 113 114 while (count<len) { 115 int i = read(fd, (char *)buf+count, len-count); 116 if (!i) break; 117 if (i<0) return i; 118 count += i; 119 } 120 121 return count; 122 } 123 124 // Keep writing until done or EOF 125 ssize_t writeall(int fd, void *buf, size_t len) 126 { 127 size_t count = 0; 128 129 while (count<len) { 130 int i = write(fd, count+(char *)buf, len-count); 131 if (i<1) return i; 132 count += i; 133 } 134 135 return count; 136 } 137 138 // skip this many bytes of input. Return 0 for success, >0 means this much 139 // left after input skipped. 140 off_t lskip(int fd, off_t offset) 141 { 142 off_t cur = lseek(fd, 0, SEEK_CUR); 143 144 if (cur != -1) { 145 off_t end = lseek(fd, 0, SEEK_END) - cur; 146 147 if (end > 0 && end < offset) return offset - end; 148 end = offset+cur; 149 if (end == lseek(fd, end, SEEK_SET)) return 0; 150 perror_exit("lseek"); 151 } 152 153 while (offset>0) { 154 int try = offset>sizeof(libbuf) ? sizeof(libbuf) : offset, or; 155 156 or = readall(fd, libbuf, try); 157 if (or < 0) perror_exit("lskip to %lld", (long long)offset); 158 else offset -= or; 159 if (or < try) break; 160 } 161 162 return offset; 163 } 164 165 // flags: 1=make last dir (with mode lastmode, otherwise skips last component) 166 // 2=make path (already exists is ok) 167 // 4=verbose 168 // returns 0 = path ok, 1 = error 169 int mkpathat(int atfd, char *dir, mode_t lastmode, int flags) 170 { 171 struct stat buf; 172 char *s; 173 174 // mkdir -p one/two/three is not an error if the path already exists, 175 // but is if "three" is a file. The others we dereference and catch 176 // not-a-directory along the way, but the last one we must explicitly 177 // test for. Might as well do it up front. 178 179 if (!fstatat(atfd, dir, &buf, 0) && !S_ISDIR(buf.st_mode)) { 180 errno = EEXIST; 181 return 1; 182 } 183 184 for (s = dir; ;s++) { 185 char save = 0; 186 mode_t mode = (0777&~toys.old_umask)|0300; 187 188 // find next '/', but don't try to mkdir "" at start of absolute path 189 if (*s == '/' && (flags&2) && s != dir) { 190 save = *s; 191 *s = 0; 192 } else if (*s) continue; 193 194 // Use the mode from the -m option only for the last directory. 195 if (!save) { 196 if (flags&1) mode = lastmode; 197 else break; 198 } 199 200 if (mkdirat(atfd, dir, mode)) { 201 if (!(flags&2) || errno != EEXIST) return 1; 202 } else if (flags&4) 203 fprintf(stderr, "%s: created directory '%s'\n", toys.which->name, dir); 204 205 if (!(*s = save)) break; 206 } 207 208 return 0; 209 } 210 211 // The common case 212 int mkpath(char *dir) 213 { 214 return mkpathat(AT_FDCWD, dir, 0, MKPATHAT_MAKE); 215 } 216 217 // Split a path into linked list of components, tracking head and tail of list. 218 // Filters out // entries with no contents. 219 struct string_list **splitpath(char *path, struct string_list **list) 220 { 221 char *new = path; 222 223 *list = 0; 224 do { 225 int len; 226 227 if (*path && *path != '/') continue; 228 len = path-new; 229 if (len > 0) { 230 *list = xmalloc(sizeof(struct string_list) + len + 1); 231 (*list)->next = 0; 232 memcpy((*list)->str, new, len); 233 (*list)->str[len] = 0; 234 list = &(*list)->next; 235 } 236 new = path+1; 237 } while (*path++); 238 239 return list; 240 } 241 242 // Find all file in a colon-separated path with access type "type" (generally 243 // X_OK or R_OK). Returns a list of absolute paths to each file found, in 244 // order. 245 246 struct string_list *find_in_path(char *path, char *filename) 247 { 248 struct string_list *rlist = NULL, **prlist=&rlist; 249 char *cwd; 250 251 if (!path) return 0; 252 253 cwd = xgetcwd(); 254 for (;;) { 255 char *res, *next = strchr(path, ':'); 256 int len = next ? next-path : strlen(path); 257 struct string_list *rnext; 258 struct stat st; 259 260 rnext = xmalloc(sizeof(void *) + strlen(filename) 261 + (len ? len : strlen(cwd)) + 2); 262 if (!len) sprintf(rnext->str, "%s/%s", cwd, filename); 263 else { 264 memcpy(res = rnext->str, path, len); 265 res += len; 266 *(res++) = '/'; 267 strcpy(res, filename); 268 } 269 270 // Confirm it's not a directory. 271 if (!stat(rnext->str, &st) && S_ISREG(st.st_mode)) { 272 *prlist = rnext; 273 rnext->next = NULL; 274 prlist = &(rnext->next); 275 } else free(rnext); 276 277 if (!next) break; 278 path += len; 279 path++; 280 } 281 free(cwd); 282 283 return rlist; 284 } 285 286 long long estrtol(char *str, char **end, int base) 287 { 288 errno = 0; 289 290 return strtoll(str, end, base); 291 } 292 293 long long xstrtol(char *str, char **end, int base) 294 { 295 long long l = estrtol(str, end, base); 296 297 if (errno) perror_exit_raw(str); 298 299 return l; 300 } 301 302 // atol() with the kilo/mega/giga/tera/peta/exa extensions, plus word and block. 303 // (zetta and yotta don't fit in 64 bits.) 304 long long atolx(char *numstr) 305 { 306 char *c = numstr, *suffixes="cwbkmgtpe", *end; 307 long long val; 308 309 val = xstrtol(numstr, &c, 0); 310 if (c != numstr && *c && (end = strchr(suffixes, tolower(*c)))) { 311 int shift = end-suffixes-2; 312 ++c; 313 if (shift==-1) val *= 2; 314 else if (!shift) val *= 512; 315 else if (shift>0) { 316 if (*c && tolower(*c++)=='d') while (shift--) val *= 1000; 317 else val *= 1LL<<(shift*10); 318 } 319 } 320 while (isspace(*c)) c++; 321 if (c==numstr || *c) error_exit("not integer: %s", numstr); 322 323 return val; 324 } 325 326 long long atolx_range(char *numstr, long long low, long long high) 327 { 328 long long val = atolx(numstr); 329 330 if (val < low) error_exit("%lld < %lld", val, low); 331 if (val > high) error_exit("%lld > %lld", val, high); 332 333 return val; 334 } 335 336 int stridx(char *haystack, char needle) 337 { 338 char *off; 339 340 if (!needle) return -1; 341 off = strchr(haystack, needle); 342 if (!off) return -1; 343 344 return off-haystack; 345 } 346 347 // Convert utf8 sequence to a unicode wide character 348 int utf8towc(wchar_t *wc, char *str, unsigned len) 349 { 350 unsigned result, mask, first; 351 char *s, c; 352 353 // fast path ASCII 354 if (len && *str<128) return !!(*wc = *str); 355 356 result = first = *(s = str++); 357 if (result<0xc2 || result>0xf4) return -1; 358 for (mask = 6; (first&0xc0)==0xc0; mask += 5, first <<= 1) { 359 if (!--len) return -2; 360 if (((c = *(str++))&0xc0) != 0x80) return -1; 361 result = (result<<6)|(c&0x3f); 362 } 363 result &= (1<<mask)-1; 364 c = str-s; 365 366 // Avoid overlong encodings 367 if (result<(unsigned []){0x80,0x800,0x10000}[c-2]) return -1; 368 369 // Limit unicode so it can't encode anything UTF-16 can't. 370 if (result>0x10ffff || (result>=0xd800 && result<=0xdfff)) return -1; 371 *wc = result; 372 373 return str-s; 374 } 375 376 char *strlower(char *s) 377 { 378 char *try, *new; 379 380 if (!CFG_TOYBOX_I18N) { 381 try = new = xstrdup(s); 382 for (; *s; s++) *(new++) = tolower(*s); 383 } else { 384 // I can't guarantee the string _won't_ expand during reencoding, so...? 385 try = new = xmalloc(strlen(s)*2+1); 386 387 while (*s) { 388 wchar_t c; 389 int len = utf8towc(&c, s, MB_CUR_MAX); 390 391 if (len < 1) *(new++) = *(s++); 392 else { 393 s += len; 394 // squash title case too 395 c = towlower(c); 396 397 // if we had a valid utf8 sequence, convert it to lower case, and can't 398 // encode back to utf8, something is wrong with your libc. But just 399 // in case somebody finds an exploit... 400 len = wcrtomb(new, c, 0); 401 if (len < 1) error_exit("bad utf8 %x", (int)c); 402 new += len; 403 } 404 } 405 *new = 0; 406 } 407 408 return try; 409 } 410 411 // strstr but returns pointer after match 412 char *strafter(char *haystack, char *needle) 413 { 414 char *s = strstr(haystack, needle); 415 416 return s ? s+strlen(needle) : s; 417 } 418 419 // Remove trailing \n 420 char *chomp(char *s) 421 { 422 char *p = strrchr(s, '\n'); 423 424 if (p && !p[1]) *p = 0; 425 return s; 426 } 427 428 int unescape(char c) 429 { 430 char *from = "\\abefnrtv", *to = "\\\a\b\033\f\n\r\t\v"; 431 int idx = stridx(from, c); 432 433 return (idx == -1) ? 0 : to[idx]; 434 } 435 436 // If string ends with suffix return pointer to start of suffix in string, 437 // else NULL 438 char *strend(char *str, char *suffix) 439 { 440 long a = strlen(str), b = strlen(suffix); 441 442 if (a>b && !strcmp(str += a-b, suffix)) return str; 443 444 return 0; 445 } 446 447 // If *a starts with b, advance *a past it and return 1, else return 0; 448 int strstart(char **a, char *b) 449 { 450 int len = strlen(b), i = !strncmp(*a, b, len); 451 452 if (i) *a += len; 453 454 return i; 455 } 456 457 // Return how long the file at fd is, if there's any way to determine it. 458 off_t fdlength(int fd) 459 { 460 struct stat st; 461 off_t base = 0, range = 1, expand = 1, old; 462 463 if (!fstat(fd, &st) && S_ISREG(st.st_mode)) return st.st_size; 464 465 // If the ioctl works for this, return it. 466 // TODO: is blocksize still always 512, or do we stat for it? 467 // unsigned int size; 468 // if (ioctl(fd, BLKGETSIZE, &size) >= 0) return size*512L; 469 470 // If not, do a binary search for the last location we can read. (Some 471 // block devices don't do BLKGETSIZE right.) This should probably have 472 // a CONFIG option... 473 474 // If not, do a binary search for the last location we can read. 475 476 old = lseek(fd, 0, SEEK_CUR); 477 do { 478 char temp; 479 off_t pos = base + range / 2; 480 481 if (lseek(fd, pos, 0)>=0 && read(fd, &temp, 1)==1) { 482 off_t delta = (pos + 1) - base; 483 484 base += delta; 485 if (expand) range = (expand <<= 1) - base; 486 else range -= delta; 487 } else { 488 expand = 0; 489 range = pos - base; 490 } 491 } while (range > 0); 492 493 lseek(fd, old, SEEK_SET); 494 495 return base; 496 } 497 498 // Read contents of file as a single nul-terminated string. 499 // measure file size if !len, allocate buffer if !buf 500 // Existing buffers need len in *plen 501 // Returns amount of data read in *plen 502 char *readfileat(int dirfd, char *name, char *ibuf, off_t *plen) 503 { 504 off_t len, rlen; 505 int fd; 506 char *buf, *rbuf; 507 508 // Unsafe to probe for size with a supplied buffer, don't ever do that. 509 if (CFG_TOYBOX_DEBUG && (ibuf ? !*plen : *plen)) error_exit("bad readfileat"); 510 511 if (-1 == (fd = openat(dirfd, name, O_RDONLY))) return 0; 512 513 // If we dunno the length, probe it. If we can't probe, start with 1 page. 514 if (!*plen) { 515 if ((len = fdlength(fd))>0) *plen = len; 516 else len = 4096; 517 } else len = *plen-1; 518 519 if (!ibuf) buf = xmalloc(len+1); 520 else buf = ibuf; 521 522 for (rbuf = buf;;) { 523 rlen = readall(fd, rbuf, len); 524 if (*plen || rlen<len) break; 525 526 // If reading unknown size, expand buffer by 1.5 each time we fill it up. 527 rlen += rbuf-buf; 528 buf = xrealloc(buf, len = (rlen*3)/2); 529 rbuf = buf+rlen; 530 len -= rlen; 531 } 532 *plen = len = rlen+(rbuf-buf); 533 close(fd); 534 535 if (rlen<0) { 536 if (ibuf != buf) free(buf); 537 buf = 0; 538 } else buf[len] = 0; 539 540 return buf; 541 } 542 543 char *readfile(char *name, char *ibuf, off_t len) 544 { 545 return readfileat(AT_FDCWD, name, ibuf, &len); 546 } 547 548 // Sleep for this many thousandths of a second 549 void msleep(long milliseconds) 550 { 551 struct timespec ts; 552 553 ts.tv_sec = milliseconds/1000; 554 ts.tv_nsec = (milliseconds%1000)*1000000; 555 nanosleep(&ts, &ts); 556 } 557 558 // Adjust timespec by nanosecond offset 559 void nanomove(struct timespec *ts, long long offset) 560 { 561 long long nano = ts->tv_nsec + offset, secs = nano/1000000000; 562 563 ts->tv_sec += secs; 564 nano %= 1000000000; 565 if (nano<0) { 566 ts->tv_sec--; 567 nano += 1000000000; 568 } 569 ts->tv_nsec = nano; 570 } 571 572 // return difference between two timespecs in nanosecs 573 long long nanodiff(struct timespec *old, struct timespec *new) 574 { 575 return (new->tv_sec - old->tv_sec)*1000000000LL+(new->tv_nsec - old->tv_nsec); 576 } 577 578 // return 1<<x of highest bit set 579 int highest_bit(unsigned long l) 580 { 581 int i; 582 583 for (i = 0; l; i++) l >>= 1; 584 585 return i-1; 586 } 587 588 // Inefficient, but deals with unaligned access 589 int64_t peek_le(void *ptr, unsigned size) 590 { 591 int64_t ret = 0; 592 char *c = ptr; 593 int i; 594 595 for (i=0; i<size; i++) ret |= ((int64_t)c[i])<<(i*8); 596 return ret; 597 } 598 599 int64_t peek_be(void *ptr, unsigned size) 600 { 601 int64_t ret = 0; 602 char *c = ptr; 603 int i; 604 605 for (i=0; i<size; i++) ret = (ret<<8)|(c[i]&0xff); 606 return ret; 607 } 608 609 int64_t peek(void *ptr, unsigned size) 610 { 611 return (IS_BIG_ENDIAN ? peek_be : peek_le)(ptr, size); 612 } 613 614 void poke_le(void *ptr, long long val, unsigned size) 615 { 616 char *c = ptr; 617 618 while (size--) { 619 *c++ = val&255; 620 val >>= 8; 621 } 622 } 623 624 void poke_be(void *ptr, long long val, unsigned size) 625 { 626 char *c = ptr + size; 627 628 while (size--) { 629 *--c = val&255; 630 val >>=8; 631 } 632 } 633 634 void poke(void *ptr, long long val, unsigned size) 635 { 636 (IS_BIG_ENDIAN ? poke_be : poke_le)(ptr, val, size); 637 } 638 639 // Iterate through an array of files, opening each one and calling a function 640 // on that filehandle and name. The special filename "-" means stdin if 641 // flags is O_RDONLY, stdout otherwise. An empty argument list calls 642 // function() on just stdin/stdout. 643 // 644 // Note: pass O_CLOEXEC to automatically close filehandles when function() 645 // returns, otherwise filehandles must be closed by function(). 646 // pass WARN_ONLY to produce warning messages about files it couldn't 647 // open/create, and skip them. Otherwise function is called with fd -1. 648 void loopfiles_rw(char **argv, int flags, int permissions, 649 void (*function)(int fd, char *name)) 650 { 651 int fd, failok = !(flags&WARN_ONLY); 652 653 flags &= ~WARN_ONLY; 654 655 // If no arguments, read from stdin. 656 if (!*argv) function((flags & O_ACCMODE) != O_RDONLY ? 1 : 0, "-"); 657 else do { 658 // Filename "-" means read from stdin. 659 // Inability to open a file prints a warning, but doesn't exit. 660 661 if (!strcmp(*argv, "-")) fd = 0; 662 else if (0>(fd = notstdio(open(*argv, flags, permissions))) && !failok) { 663 perror_msg_raw(*argv); 664 continue; 665 } 666 function(fd, *argv); 667 if ((flags & O_CLOEXEC) && fd) close(fd); 668 } while (*++argv); 669 } 670 671 // Call loopfiles_rw with O_RDONLY|O_CLOEXEC|WARN_ONLY (common case) 672 void loopfiles(char **argv, void (*function)(int fd, char *name)) 673 { 674 loopfiles_rw(argv, O_RDONLY|O_CLOEXEC|WARN_ONLY, 0, function); 675 } 676 677 // glue to call dl_lines() from loopfiles 678 static void (*do_lines_bridge)(char **pline, long len); 679 static void loopfile_lines_bridge(int fd, char *name) 680 { 681 do_lines(fd, '\n', do_lines_bridge); 682 } 683 684 void loopfiles_lines(char **argv, void (*function)(char **pline, long len)) 685 { 686 do_lines_bridge = function; 687 loopfiles(argv, loopfile_lines_bridge); 688 } 689 690 // Slow, but small. 691 692 char *get_rawline(int fd, long *plen, char end) 693 { 694 char c, *buf = NULL; 695 long len = 0; 696 697 for (;;) { 698 if (1>read(fd, &c, 1)) break; 699 if (!(len & 63)) buf=xrealloc(buf, len+65); 700 if ((buf[len++]=c) == end) break; 701 } 702 if (buf) buf[len]=0; 703 if (plen) *plen = len; 704 705 return buf; 706 } 707 708 char *get_line(int fd) 709 { 710 long len; 711 char *buf = get_rawline(fd, &len, '\n'); 712 713 if (buf && buf[--len]=='\n') buf[len]=0; 714 715 return buf; 716 } 717 718 int wfchmodat(int fd, char *name, mode_t mode) 719 { 720 int rc = fchmodat(fd, name, mode, 0); 721 722 if (rc) { 723 perror_msg("chmod '%s' to %04o", name, mode); 724 toys.exitval=1; 725 } 726 return rc; 727 } 728 729 static char *tempfile2zap; 730 static void tempfile_handler(void) 731 { 732 if (1 < (long)tempfile2zap) unlink(tempfile2zap); 733 } 734 735 // Open a temporary file to copy an existing file into. 736 int copy_tempfile(int fdin, char *name, char **tempname) 737 { 738 struct stat statbuf; 739 int fd = xtempfile(name, tempname), ignored __attribute__((__unused__)); 740 741 // Record tempfile for exit cleanup if interrupted 742 if (!tempfile2zap) sigatexit(tempfile_handler); 743 tempfile2zap = *tempname; 744 745 // Set permissions of output file. 746 if (!fstat(fdin, &statbuf)) fchmod(fd, statbuf.st_mode); 747 748 // We chmod before chown, which strips the suid bit. Caller has to explicitly 749 // switch it back on if they want to keep suid. 750 751 // Suppress warn-unused-result. Both gcc and clang clutch their pearls about 752 // this but it's _supposed_ to fail when we're not root. 753 ignored = fchown(fd, statbuf.st_uid, statbuf.st_gid); 754 755 return fd; 756 } 757 758 // Abort the copy and delete the temporary file. 759 void delete_tempfile(int fdin, int fdout, char **tempname) 760 { 761 close(fdin); 762 close(fdout); 763 if (*tempname) unlink(*tempname); 764 tempfile2zap = (char *)1; 765 free(*tempname); 766 *tempname = NULL; 767 } 768 769 // Copy the rest of the data and replace the original with the copy. 770 void replace_tempfile(int fdin, int fdout, char **tempname) 771 { 772 char *temp = xstrdup(*tempname); 773 774 temp[strlen(temp)-6]=0; 775 if (fdin != -1) { 776 xsendfile(fdin, fdout); 777 xclose(fdin); 778 } 779 xclose(fdout); 780 xrename(*tempname, temp); 781 tempfile2zap = (char *)1; 782 free(*tempname); 783 free(temp); 784 *tempname = NULL; 785 } 786 787 // Create a 256 entry CRC32 lookup table. 788 789 void crc_init(unsigned int *crc_table, int little_endian) 790 { 791 unsigned int i; 792 793 // Init the CRC32 table (big endian) 794 for (i=0; i<256; i++) { 795 unsigned int j, c = little_endian ? i : i<<24; 796 for (j=8; j; j--) 797 if (little_endian) c = (c&1) ? (c>>1)^0xEDB88320 : c>>1; 798 else c=c&0x80000000 ? (c<<1)^0x04c11db7 : (c<<1); 799 crc_table[i] = c; 800 } 801 } 802 803 // Init base64 table 804 805 void base64_init(char *p) 806 { 807 int i; 808 809 for (i = 'A'; i != ':'; i++) { 810 if (i == 'Z'+1) i = 'a'; 811 if (i == 'z'+1) i = '0'; 812 *(p++) = i; 813 } 814 *(p++) = '+'; 815 *(p++) = '/'; 816 } 817 818 int yesno(int def) 819 { 820 char buf; 821 822 fprintf(stderr, " (%c/%c):", def ? 'Y' : 'y', def ? 'n' : 'N'); 823 fflush(stderr); 824 while (fread(&buf, 1, 1, stdin)) { 825 int new; 826 827 // The letter changes the value, the newline (or space) returns it. 828 if (isspace(buf)) break; 829 if (-1 != (new = stridx("ny", tolower(buf)))) def = new; 830 } 831 832 return def; 833 } 834 835 struct signame { 836 int num; 837 char *name; 838 }; 839 840 // Signals required by POSIX 2008: 841 // http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/signal.h.html 842 843 #define SIGNIFY(x) {SIG##x, #x} 844 845 static struct signame signames[] = { 846 SIGNIFY(ABRT), SIGNIFY(ALRM), SIGNIFY(BUS), 847 SIGNIFY(FPE), SIGNIFY(HUP), SIGNIFY(ILL), SIGNIFY(INT), SIGNIFY(KILL), 848 SIGNIFY(PIPE), SIGNIFY(QUIT), SIGNIFY(SEGV), SIGNIFY(TERM), 849 SIGNIFY(USR1), SIGNIFY(USR2), SIGNIFY(SYS), SIGNIFY(TRAP), 850 SIGNIFY(VTALRM), SIGNIFY(XCPU), SIGNIFY(XFSZ), 851 852 // Start of non-terminal signals 853 854 SIGNIFY(CHLD), SIGNIFY(CONT), SIGNIFY(STOP), SIGNIFY(TSTP), 855 SIGNIFY(TTIN), SIGNIFY(TTOU), SIGNIFY(URG) 856 }; 857 858 // not in posix: SIGNIFY(STKFLT), SIGNIFY(WINCH), SIGNIFY(IO), SIGNIFY(PWR) 859 // obsolete: SIGNIFY(PROF) SIGNIFY(POLL) 860 861 // Handler that sets toys.signal, and writes to toys.signalfd if set 862 void generic_signal(int sig) 863 { 864 if (toys.signalfd) { 865 char c = sig; 866 867 writeall(toys.signalfd, &c, 1); 868 } 869 toys.signal = sig; 870 } 871 872 void exit_signal(int sig) 873 { 874 if (sig) toys.exitval = sig|128; 875 xexit(); 876 } 877 878 // Install the same handler on every signal that defaults to killing the 879 // process, calling the handler on the way out. Calling multiple times 880 // adds the handlers to a list, to be called in order. 881 void sigatexit(void *handler) 882 { 883 struct arg_list *al; 884 int i; 885 886 for (i=0; signames[i].num != SIGCHLD; i++) 887 if (signames[i].num != SIGKILL) 888 xsignal(signames[i].num, handler ? exit_signal : SIG_DFL); 889 890 if (handler) { 891 al = xmalloc(sizeof(struct arg_list)); 892 al->next = toys.xexit; 893 al->arg = handler; 894 toys.xexit = al; 895 } else { 896 llist_traverse(toys.xexit, free); 897 toys.xexit = 0; 898 } 899 } 900 901 // Convert name to signal number. If name == NULL print names. 902 int sig_to_num(char *pidstr) 903 { 904 int i; 905 906 if (pidstr) { 907 char *s; 908 909 i = estrtol(pidstr, &s, 10); 910 if (!errno && !*s) return i; 911 912 if (!strncasecmp(pidstr, "sig", 3)) pidstr+=3; 913 } 914 for (i=0; i<ARRAY_LEN(signames); i++) 915 if (!pidstr) xputs(signames[i].name); 916 else if (!strcasecmp(pidstr, signames[i].name)) return signames[i].num; 917 918 return -1; 919 } 920 921 char *num_to_sig(int sig) 922 { 923 int i; 924 925 for (i=0; i<ARRAY_LEN(signames); i++) 926 if (signames[i].num == sig) return signames[i].name; 927 return NULL; 928 } 929 930 // premute mode bits based on posix mode strings. 931 mode_t string_to_mode(char *modestr, mode_t mode) 932 { 933 char *whos = "ogua", *hows = "=+-", *whats = "xwrstX", *whys = "ogu", 934 *s, *str = modestr; 935 mode_t extrabits = mode & ~(07777); 936 937 // Handle octal mode 938 if (isdigit(*str)) { 939 mode = estrtol(str, &s, 8); 940 if (errno || *s || (mode & ~(07777))) goto barf; 941 942 return mode | extrabits; 943 } 944 945 // Gaze into the bin of permission... 946 for (;;) { 947 int i, j, dowho, dohow, dowhat, amask; 948 949 dowho = dohow = dowhat = amask = 0; 950 951 // Find the who, how, and what stanzas, in that order 952 while (*str && (s = strchr(whos, *str))) { 953 dowho |= 1<<(s-whos); 954 str++; 955 } 956 // If who isn't specified, like "a" but honoring umask. 957 if (!dowho) { 958 dowho = 8; 959 umask(amask=umask(0)); 960 } 961 if (!*str || !(s = strchr(hows, *str))) goto barf; 962 dohow = *(str++); 963 964 if (!dohow) goto barf; 965 while (*str && (s = strchr(whats, *str))) { 966 dowhat |= 1<<(s-whats); 967 str++; 968 } 969 970 // Convert X to x for directory or if already executable somewhere 971 if ((dowhat&32) && (S_ISDIR(mode) || (mode&0111))) dowhat |= 1; 972 973 // Copy mode from another category? 974 if (!dowhat && *str && (s = strchr(whys, *str))) { 975 dowhat = (mode>>(3*(s-whys)))&7; 976 str++; 977 } 978 979 // Are we ready to do a thing yet? 980 if (*str && *(str++) != ',') goto barf; 981 982 // Ok, apply the bits to the mode. 983 for (i=0; i<4; i++) { 984 for (j=0; j<3; j++) { 985 mode_t bit = 0; 986 int where = 1<<((3*i)+j); 987 988 if (amask & where) continue; 989 990 // Figure out new value at this location 991 if (i == 3) { 992 // suid/sticky bit. 993 if (j) { 994 if ((dowhat & 8) && (dowho&(8|(1<<i)))) bit++; 995 } else if (dowhat & 16) bit++; 996 } else { 997 if (!(dowho&(8|(1<<i)))) continue; 998 if (dowhat&(1<<j)) bit++; 999 } 1000 1001 // When selection active, modify bit 1002 1003 if (dohow == '=' || (bit && dohow == '-')) mode &= ~where; 1004 if (bit && dohow != '-') mode |= where; 1005 } 1006 } 1007 1008 if (!*str) break; 1009 } 1010 1011 return mode|extrabits; 1012 barf: 1013 error_exit("bad mode '%s'", modestr); 1014 } 1015 1016 // Format access mode into a drwxrwxrwx string 1017 void mode_to_string(mode_t mode, char *buf) 1018 { 1019 char c, d; 1020 int i, bit; 1021 1022 buf[10]=0; 1023 for (i=0; i<9; i++) { 1024 bit = mode & (1<<i); 1025 c = i%3; 1026 if (!c && (mode & (1<<((d=i/3)+9)))) { 1027 c = "tss"[d]; 1028 if (!bit) c &= ~0x20; 1029 } else c = bit ? "xwr"[c] : '-'; 1030 buf[9-i] = c; 1031 } 1032 1033 if (S_ISDIR(mode)) c = 'd'; 1034 else if (S_ISBLK(mode)) c = 'b'; 1035 else if (S_ISCHR(mode)) c = 'c'; 1036 else if (S_ISLNK(mode)) c = 'l'; 1037 else if (S_ISFIFO(mode)) c = 'p'; 1038 else if (S_ISSOCK(mode)) c = 's'; 1039 else c = '-'; 1040 *buf = c; 1041 } 1042 1043 // dirname() can modify its argument or return a pointer to a constant string 1044 // This always returns a malloc() copy of everyting before last (run of ) '/'. 1045 char *getdirname(char *name) 1046 { 1047 char *s = xstrdup(name), *ss = strrchr(s, '/'); 1048 1049 while (*ss && *ss == '/' && s != ss) *ss-- = 0; 1050 1051 return s; 1052 } 1053 1054 // basename() can modify its argument or return a pointer to a constant string 1055 // This just gives after the last '/' or the whole stirng if no / 1056 char *getbasename(char *name) 1057 { 1058 char *s = strrchr(name, '/'); 1059 1060 if (s) return s+1; 1061 1062 return name; 1063 } 1064 1065 // Return pointer to xabspath(file) if file is under dir, else 0 1066 char *fileunderdir(char *file, char *dir) 1067 { 1068 char *s1 = xabspath(dir, 1), *s2 = xabspath(file, -1), *ss = s2; 1069 int rc = s1 && s2 && strstart(&ss, s1) && (!s1[1] || s2[strlen(s1)] == '/'); 1070 1071 free(s1); 1072 if (!rc) free(s2); 1073 1074 return rc ? s2 : 0; 1075 } 1076 1077 // Execute a callback for each PID that matches a process name from a list. 1078 void names_to_pid(char **names, int (*callback)(pid_t pid, char *name)) 1079 { 1080 DIR *dp; 1081 struct dirent *entry; 1082 1083 if (!(dp = opendir("/proc"))) perror_exit("no /proc"); 1084 1085 while ((entry = readdir(dp))) { 1086 unsigned u = atoi(entry->d_name); 1087 char *cmd = 0, *comm, **cur; 1088 off_t len; 1089 1090 if (!u) continue; 1091 1092 // Comm is original name of executable (argv[0] could be #! interpreter) 1093 // but it's limited to 15 characters 1094 sprintf(libbuf, "/proc/%u/comm", u); 1095 len = sizeof(libbuf); 1096 if (!(comm = readfileat(AT_FDCWD, libbuf, libbuf, &len)) || !len) 1097 continue; 1098 if (libbuf[len-1] == '\n') libbuf[--len] = 0; 1099 1100 for (cur = names; *cur; cur++) { 1101 struct stat st1, st2; 1102 char *bb = getbasename(*cur); 1103 off_t len = strlen(bb); 1104 1105 // Fast path: only matching a filename (no path) that fits in comm. 1106 // `len` must be 14 or less because with a full 15 bytes we don't 1107 // know whether the name fit or was truncated. 1108 if (len<=14 && bb==*cur && !strcmp(comm, bb)) goto match; 1109 1110 // If we have a path to existing file only match if same inode 1111 if (bb!=*cur && !stat(*cur, &st1)) { 1112 char buf[32]; 1113 1114 sprintf(buf, "/proc/%u/exe", u); 1115 if (stat(buf, &st2)) continue; 1116 if (st1.st_dev != st2.st_dev || st1.st_ino != st2.st_ino) continue; 1117 goto match; 1118 } 1119 1120 // Nope, gotta read command line to confirm 1121 if (!cmd) { 1122 sprintf(cmd = libbuf+16, "/proc/%u/cmdline", u); 1123 len = sizeof(libbuf)-17; 1124 if (!(cmd = readfileat(AT_FDCWD, cmd, cmd, &len))) continue; 1125 // readfile only guarantees one null terminator and we need two 1126 // (yes the kernel should do this for us, don't care) 1127 cmd[len] = 0; 1128 } 1129 if (!strcmp(bb, getbasename(cmd))) goto match; 1130 if (bb!=*cur && !strcmp(bb, getbasename(cmd+strlen(cmd)+1))) goto match; 1131 continue; 1132 match: 1133 if (callback(u, *cur)) break; 1134 } 1135 } 1136 closedir(dp); 1137 } 1138 1139 // display first few digits of number with power of two units 1140 int human_readable(char *buf, unsigned long long num, int style) 1141 { 1142 unsigned long long snap = 0; 1143 int len, unit, divisor = (style&HR_1000) ? 1000 : 1024; 1144 1145 // Divide rounding up until we have 3 or fewer digits. Since the part we 1146 // print is decimal, the test is 999 even when we divide by 1024. 1147 // We can't run out of units because 2<<64 is 18 exabytes. 1148 // test 5675 is 5.5k not 5.6k. 1149 for (unit = 0; num > 999; unit++) num = ((snap = num)+(divisor/2))/divisor; 1150 len = sprintf(buf, "%llu", num); 1151 if (unit && len == 1) { 1152 // Redo rounding for 1.2M case, this works with and without HR_1000. 1153 num = snap/divisor; 1154 snap -= num*divisor; 1155 snap = ((snap*100)+50)/divisor; 1156 snap /= 10; 1157 len = sprintf(buf, "%llu.%llu", num, snap); 1158 } 1159 if (style & HR_SPACE) buf[len++] = ' '; 1160 if (unit) { 1161 unit = " kMGTPE"[unit]; 1162 1163 if (!(style&HR_1000)) unit = toupper(unit); 1164 buf[len++] = unit; 1165 } else if (style & HR_B) buf[len++] = 'B'; 1166 buf[len] = 0; 1167 1168 return len; 1169 } 1170 1171 // The qsort man page says you can use alphasort, the posix committee 1172 // disagreed, and doubled down: http://austingroupbugs.net/view.php?id=142 1173 // So just do our own. (The const is entirely to humor the stupid compiler.) 1174 int qstrcmp(const void *a, const void *b) 1175 { 1176 return strcmp(*(char **)a, *(char **)b); 1177 } 1178 1179 // See https://tools.ietf.org/html/rfc4122, specifically section 4.4 1180 // "Algorithms for Creating a UUID from Truly Random or Pseudo-Random 1181 // Numbers". 1182 void create_uuid(char *uuid) 1183 { 1184 // "Set all the ... bits to randomly (or pseudo-randomly) chosen values". 1185 xgetrandom(uuid, 16, 0); 1186 1187 // "Set the four most significant bits ... of the time_hi_and_version 1188 // field to the 4-bit version number [4]". 1189 uuid[6] = (uuid[6] & 0x0F) | 0x40; 1190 // "Set the two most significant bits (bits 6 and 7) of 1191 // clock_seq_hi_and_reserved to zero and one, respectively". 1192 uuid[8] = (uuid[8] & 0x3F) | 0x80; 1193 } 1194 1195 char *show_uuid(char *uuid) 1196 { 1197 char *out = libbuf; 1198 int i; 1199 1200 for (i=0; i<16; i++) out+=sprintf(out, "-%02x"+!(0x550&(1<<i)), uuid[i]); 1201 *out = 0; 1202 1203 return libbuf; 1204 } 1205 1206 // Returns pointer to letter at end, 0 if none. *start = initial % 1207 char *next_printf(char *s, char **start) 1208 { 1209 for (; *s; s++) { 1210 if (*s != '%') continue; 1211 if (*++s == '%') continue; 1212 if (start) *start = s-1; 1213 while (0 <= stridx("0'#-+ ", *s)) s++; 1214 while (isdigit(*s)) s++; 1215 if (*s == '.') s++; 1216 while (isdigit(*s)) s++; 1217 1218 return s; 1219 } 1220 1221 return 0; 1222 } 1223 1224 int dev_minor(int dev) 1225 { 1226 return ((dev&0xfff00000)>>12)|(dev&0xff); 1227 } 1228 1229 int dev_major(int dev) 1230 { 1231 return (dev&0xfff00)>>8; 1232 } 1233 1234 int dev_makedev(int major, int minor) 1235 { 1236 return (minor&0xff)|((major&0xfff)<<8)|((minor&0xfff00)<<12); 1237 } 1238 1239 // Return cached passwd entries. 1240 struct passwd *bufgetpwuid(uid_t uid) 1241 { 1242 struct pwuidbuf_list { 1243 struct pwuidbuf_list *next; 1244 struct passwd pw; 1245 } *list = 0; 1246 struct passwd *temp; 1247 static struct pwuidbuf_list *pwuidbuf; 1248 unsigned size = 256; 1249 1250 // If we already have this one, return it. 1251 for (list = pwuidbuf; list; list = list->next) 1252 if (list->pw.pw_uid == uid) return &(list->pw); 1253 1254 for (;;) { 1255 list = xrealloc(list, size *= 2); 1256 errno = getpwuid_r(uid, &list->pw, sizeof(*list)+(char *)list, 1257 size-sizeof(*list), &temp); 1258 if (errno != ERANGE) break; 1259 } 1260 1261 if (!temp) { 1262 free(list); 1263 1264 return 0; 1265 } 1266 list->next = pwuidbuf; 1267 pwuidbuf = list; 1268 1269 return &list->pw; 1270 } 1271 1272 // Return cached group entries. 1273 struct group *bufgetgrgid(gid_t gid) 1274 { 1275 struct grgidbuf_list { 1276 struct grgidbuf_list *next; 1277 struct group gr; 1278 } *list = 0; 1279 struct group *temp; 1280 static struct grgidbuf_list *grgidbuf; 1281 unsigned size = 256; 1282 1283 for (list = grgidbuf; list; list = list->next) 1284 if (list->gr.gr_gid == gid) return &(list->gr); 1285 1286 for (;;) { 1287 list = xrealloc(list, size *= 2); 1288 errno = getgrgid_r(gid, &list->gr, sizeof(*list)+(char *)list, 1289 size-sizeof(*list), &temp); 1290 if (errno != ERANGE) break; 1291 } 1292 if (!temp) { 1293 free(list); 1294 1295 return 0; 1296 } 1297 list->next = grgidbuf; 1298 grgidbuf = list; 1299 1300 return &list->gr; 1301 } 1302 1303 // Always null terminates, returns 0 for failure, len for success 1304 int readlinkat0(int dirfd, char *path, char *buf, int len) 1305 { 1306 if (!len) return 0; 1307 1308 len = readlinkat(dirfd, path, buf, len-1); 1309 if (len<1) return 0; 1310 buf[len] = 0; 1311 1312 return len; 1313 } 1314 1315 int readlink0(char *path, char *buf, int len) 1316 { 1317 return readlinkat0(AT_FDCWD, path, buf, len); 1318 } 1319 1320 // Do regex matching handling embedded NUL bytes in string (hence extra len 1321 // argument). Note that neither the pattern nor the match can currently include 1322 // NUL bytes (even with wildcards) and string must be null terminated at 1323 // string[len]. But this can find a match after the first NUL. 1324 int regexec0(regex_t *preg, char *string, long len, int nmatch, 1325 regmatch_t pmatch[], int eflags) 1326 { 1327 char *s = string; 1328 1329 for (;;) { 1330 long ll = 0; 1331 int rc; 1332 1333 while (len && !*s) { 1334 s++; 1335 len--; 1336 } 1337 while (s[ll] && ll<len) ll++; 1338 1339 rc = regexec(preg, s, nmatch, pmatch, eflags); 1340 if (!rc) { 1341 for (rc = 0; rc<nmatch && pmatch[rc].rm_so!=-1; rc++) { 1342 pmatch[rc].rm_so += s-string; 1343 pmatch[rc].rm_eo += s-string; 1344 } 1345 1346 return 0; 1347 } 1348 if (ll==len) return rc; 1349 1350 s += ll; 1351 len -= ll; 1352 } 1353 } 1354 1355 // Return user name or string representation of number, returned buffer 1356 // lasts until next call. 1357 char *getusername(uid_t uid) 1358 { 1359 struct passwd *pw = bufgetpwuid(uid); 1360 static char unum[12]; 1361 1362 sprintf(unum, "%u", (unsigned)uid); 1363 return pw ? pw->pw_name : unum; 1364 } 1365 1366 // Return group name or string representation of number, returned buffer 1367 // lasts until next call. 1368 char *getgroupname(gid_t gid) 1369 { 1370 struct group *gr = bufgetgrgid(gid); 1371 static char gnum[12]; 1372 1373 sprintf(gnum, "%u", (unsigned)gid); 1374 return gr ? gr->gr_name : gnum; 1375 } 1376 1377 // Iterate over lines in file, calling function. Function can write 0 to 1378 // the line pointer if they want to keep it, or 1 to terminate processing, 1379 // otherwise line is freed. Passed file descriptor is closed at the end. 1380 // At EOF calls function(0, 0) 1381 void do_lines(int fd, char delim, void (*call)(char **pline, long len)) 1382 { 1383 FILE *fp = fd ? xfdopen(fd, "r") : stdin; 1384 1385 for (;;) { 1386 char *line = 0; 1387 ssize_t len; 1388 1389 len = getdelim(&line, (void *)&len, delim, fp); 1390 if (len > 0) { 1391 call(&line, len); 1392 if (line == (void *)1) break; 1393 free(line); 1394 } else break; 1395 } 1396 call(0, 0); 1397 1398 if (fd) fclose(fp); 1399 } 1400 1401 // Returns the number of bytes taken by the environment variables. For use 1402 // when calculating the maximum bytes of environment+argument data that can 1403 // be passed to exec for find(1) and xargs(1). 1404 long environ_bytes() 1405 { 1406 long bytes = sizeof(char *); 1407 char **ev; 1408 1409 for (ev = environ; *ev; ev++) bytes += sizeof(char *) + strlen(*ev) + 1; 1410 1411 return bytes; 1412 } 1413 1414 // Return unix time in milliseconds 1415 long long millitime(void) 1416 { 1417 struct timespec ts; 1418 1419 clock_gettime(CLOCK_MONOTONIC, &ts); 1420 return ts.tv_sec*1000+ts.tv_nsec/1000000; 1421 } 1422 1423 // Formats `ts` in ISO format ("2018-06-28 15:08:58.846386216 -0700"). 1424 char *format_iso_time(char *buf, size_t len, struct timespec *ts) 1425 { 1426 char *s = buf; 1427 1428 s += strftime(s, len, "%F %T", localtime(&(ts->tv_sec))); 1429 s += sprintf(s, ".%09ld ", ts->tv_nsec); 1430 s += strftime(s, len-strlen(buf), "%z", localtime(&(ts->tv_sec))); 1431 1432 return buf; 1433 } 1434 1435 // reset environment for a user, optionally clearing most of it 1436 void reset_env(struct passwd *p, int clear) 1437 { 1438 int i; 1439 1440 if (clear) { 1441 char *s, *stuff[] = {"TERM", "DISPLAY", "COLORTERM", "XAUTHORITY"}; 1442 1443 for (i=0; i<ARRAY_LEN(stuff); i++) 1444 stuff[i] = (s = getenv(stuff[i])) ? xmprintf("%s=%s", stuff[i], s) : 0; 1445 clearenv(); 1446 for (i=0; i < ARRAY_LEN(stuff); i++) if (stuff[i]) putenv(stuff[i]); 1447 if (chdir(p->pw_dir)) { 1448 perror_msg("chdir %s", p->pw_dir); 1449 xchdir("/"); 1450 } 1451 } else { 1452 char **ev1, **ev2; 1453 1454 // remove LD_*, IFS, ENV, and BASH_ENV from environment 1455 for (ev1 = ev2 = environ;;) { 1456 while (*ev2 && (strstart(ev2, "LD_") || strstart(ev2, "IFS=") || 1457 strstart(ev2, "ENV=") || strstart(ev2, "BASH_ENV="))) ev2++; 1458 if (!(*ev1++ = *ev2++)) break; 1459 } 1460 } 1461 1462 setenv("PATH", _PATH_DEFPATH, 1); 1463 setenv("HOME", p->pw_dir, 1); 1464 setenv("SHELL", p->pw_shell, 1); 1465 setenv("USER", p->pw_name, 1); 1466 setenv("LOGNAME", p->pw_name, 1); 1467 } 1468 1469 // Syslog with the openlog/closelog, autodetecting daemon status via no tty 1470 1471 void loggit(int priority, char *format, ...) 1472 { 1473 int i, facility = LOG_DAEMON; 1474 va_list va; 1475 1476 for (i = 0; i<3; i++) if (isatty(i)) facility = LOG_AUTH; 1477 openlog(toys.which->name, LOG_PID, facility); 1478 va_start(va, format); 1479 vsyslog(priority, format, va); 1480 va_end(va); 1481 closelog(); 1482 } 1483