1 /* lib.c - various reusable stuff.
3 * Copyright 2006 Rob Landley <rob@landley.net>
8 void verror_msg(char *msg, int err, va_list va)
12 fprintf(stderr, "%s: ", toys.which->name);
13 if (msg) vfprintf(stderr, msg, va);
15 if (err) fprintf(stderr, s, strerror(err));
16 if (msg || err) putc('\n', stderr);
17 if (!toys.exitval) toys.exitval++;
20 // These functions don't collapse together because of the va_stuff.
22 void error_msg(char *msg, ...)
27 verror_msg(msg, 0, va);
31 void perror_msg(char *msg, ...)
36 verror_msg(msg, errno, va);
40 // Die with an error message.
41 void error_exit(char *msg, ...)
46 verror_msg(msg, 0, va);
52 // Exit with an error message after showing help text.
53 void help_exit(char *msg, ...)
57 if (CFG_TOYBOX_HELP) show_help(stderr);
61 verror_msg(msg, 0, va);
68 // Die with an error message and strerror(errno)
69 void perror_exit(char *msg, ...)
74 verror_msg(msg, errno, va);
80 // Keep reading until full or EOF
81 ssize_t readall(int fd, void *buf, size_t len)
86 int i = read(fd, (char *)buf+count, len-count);
95 // Keep writing until done or EOF
96 ssize_t writeall(int fd, void *buf, size_t len)
100 int i = write(fd, count+(char *)buf, len-count);
108 // skip this many bytes of input. Return 0 for success, >0 means this much
109 // left after input skipped.
110 off_t lskip(int fd, off_t offset)
112 off_t cur = lseek(fd, 0, SEEK_CUR);
115 off_t end = lseek(fd, 0, SEEK_END) - cur;
117 if (end > 0 && end < offset) return offset - end;
119 if (end == lseek(fd, end, SEEK_SET)) return 0;
120 perror_exit("lseek");
124 int try = offset>sizeof(libbuf) ? sizeof(libbuf) : offset, or;
126 or = readall(fd, libbuf, try);
127 if (or < 0) perror_exit("lskip to %lld", (long long)offset);
135 // flags: 1=make last dir (with mode lastmode, otherwise skips last component)
136 // 2=make path (already exists is ok)
138 // returns 0 = path ok, 1 = error
139 int mkpathat(int atfd, char *dir, mode_t lastmode, int flags)
144 // mkdir -p one/two/three is not an error if the path already exists,
145 // but is if "three" is a file. The others we dereference and catch
146 // not-a-directory along the way, but the last one we must explicitly
147 // test for. Might as well do it up front.
149 if (!fstatat(atfd, dir, &buf, 0) && !S_ISDIR(buf.st_mode)) {
154 for (s = dir; ;s++) {
156 mode_t mode = (0777&~toys.old_umask)|0300;
158 // find next '/', but don't try to mkdir "" at start of absolute path
159 if (*s == '/' && (flags&2) && s != dir) {
162 } else if (*s) continue;
164 // Use the mode from the -m option only for the last directory.
166 if (flags&1) mode = lastmode;
170 if (mkdirat(atfd, dir, mode)) {
171 if (!(flags&2) || errno != EEXIST) return 1;
173 fprintf(stderr, "%s: created directory '%s'\n", toys.which->name, dir);
175 if (!(*s = save)) break;
181 // Split a path into linked list of components, tracking head and tail of list.
182 // Filters out // entries with no contents.
183 struct string_list **splitpath(char *path, struct string_list **list)
191 if (*path && *path != '/') continue;
194 *list = xmalloc(sizeof(struct string_list) + len + 1);
196 memcpy((*list)->str, new, len);
197 (*list)->str[len] = 0;
198 list = &(*list)->next;
206 // Find all file in a colon-separated path with access type "type" (generally
207 // X_OK or R_OK). Returns a list of absolute paths to each file found, in
210 struct string_list *find_in_path(char *path, char *filename)
212 struct string_list *rlist = NULL, **prlist=&rlist;
219 char *next = strchr(path, ':');
220 int len = next ? next-path : strlen(path);
221 struct string_list *rnext;
224 rnext = xmalloc(sizeof(void *) + strlen(filename)
225 + (len ? len : strlen(cwd)) + 2);
226 if (!len) sprintf(rnext->str, "%s/%s", cwd, filename);
228 char *res = rnext->str;
230 memcpy(res, path, len);
233 strcpy(res, filename);
236 // Confirm it's not a directory.
237 if (!stat(rnext->str, &st) && S_ISREG(st.st_mode)) {
240 prlist = &(rnext->next);
252 long estrtol(char *str, char **end, int base)
256 return strtol(str, end, base);
259 long xstrtol(char *str, char **end, int base)
261 long l = estrtol(str, end, base);
263 if (errno) perror_exit("%s", str);
268 // atol() with the kilo/mega/giga/tera/peta/exa extensions.
269 // (zetta and yotta don't fit in 64 bits.)
270 long atolx(char *numstr)
272 char *c, *suffixes="cbkmgtpe", *end;
275 val = xstrtol(numstr, &c, 0);
277 if (c != numstr && (end = strchr(suffixes, tolower(*c)))) {
278 int shift = end-suffixes-2;
279 if (shift >= 0) val *= 1024L<<(shift*10);
281 while (isspace(*c)) c++;
282 if (*c) error_exit("not integer: %s", numstr);
289 long atolx_range(char *numstr, long low, long high)
291 long val = atolx(numstr);
293 if (val < low) error_exit("%ld < %ld", val, low);
294 if (val > high) error_exit("%ld > %ld", val, high);
299 int stridx(char *haystack, char needle)
303 if (!needle) return -1;
304 off = strchr(haystack, needle);
310 char *strlower(char *s)
314 if (!CFG_TOYBOX_I18N) {
315 try = new = xstrdup(s);
316 for (; *s; s++) *(new++) = tolower(*s);
318 // I can't guarantee the string _won't_ expand during reencoding, so...?
319 try = new = xmalloc(strlen(s)*2+1);
323 int len = mbrtowc(&c, s, MB_CUR_MAX, 0);
325 if (len < 1) *(new++) = *(s++);
328 // squash title case too
331 // if we had a valid utf8 sequence, convert it to lower case, and can't
332 // encode back to utf8, something is wrong with your libc. But just
333 // in case somebody finds an exploit...
334 len = wcrtomb(new, c, 0);
335 if (len < 1) error_exit("bad utf8 %x", (int)c);
345 // Remove trailing \n
348 char *p = strrchr(s, '\n');
350 if (p && !p[1]) *p = 0;
356 char *from = "\\abefnrtv", *to = "\\\a\b\033\f\n\r\t\v";
357 int idx = stridx(from, c);
359 return (idx == -1) ? 0 : to[idx];
362 // If *a starts with b, advance *a past it and return 1, else return 0;
363 int strstart(char **a, char *b)
365 int len = strlen(b), i = !strncmp(*a, b, len);
372 // Return how long the file at fd is, if there's any way to determine it.
373 off_t fdlength(int fd)
376 off_t base = 0, range = 1, expand = 1, old;
378 if (!fstat(fd, &st) && S_ISREG(st.st_mode)) return st.st_size;
380 // If the ioctl works for this, return it.
381 // TODO: is blocksize still always 512, or do we stat for it?
382 // unsigned int size;
383 // if (ioctl(fd, BLKGETSIZE, &size) >= 0) return size*512L;
385 // If not, do a binary search for the last location we can read. (Some
386 // block devices don't do BLKGETSIZE right.) This should probably have
387 // a CONFIG option...
389 // If not, do a binary search for the last location we can read.
391 old = lseek(fd, 0, SEEK_CUR);
394 off_t pos = base + range / 2;
396 if (lseek(fd, pos, 0)>=0 && read(fd, &temp, 1)==1) {
397 off_t delta = (pos + 1) - base;
400 if (expand) range = (expand <<= 1) - base;
408 lseek(fd, old, SEEK_SET);
413 // Read contents of file as a single nul-terminated string.
414 // malloc new one if buf=len=0
415 char *readfileat(int dirfd, char *name, char *ibuf, off_t len)
420 if (-1 == (fd = openat(dirfd, name, O_RDONLY))) return 0;
423 // proc files don't report a length, so try 1 page minimum.
424 if (len<4096) len = 4096;
426 if (!ibuf) buf = xmalloc(len+1);
429 len = readall(fd, buf, len-1);
432 if (ibuf != buf) free(buf);
439 char *readfile(char *name, char *ibuf, off_t len)
441 return readfileat(AT_FDCWD, name, ibuf, len);
444 // Sleep for this many thousandths of a second
445 void msleep(long miliseconds)
449 ts.tv_sec = miliseconds/1000;
450 ts.tv_nsec = (miliseconds%1000)*1000000;
454 // Inefficient, but deals with unaligned access
455 int64_t peek_le(void *ptr, unsigned size)
461 for (i=0; i<size; i++) ret |= ((int64_t)c[i])<<i;
466 int64_t peek_be(void *ptr, unsigned size)
471 while (size--) ret = (ret<<8)|c[size];
476 int64_t peek(void *ptr, unsigned size)
478 return IS_BIG_ENDIAN ? peek_be(ptr, size) : peek_le(ptr, size);
481 void poke(void *ptr, uint64_t val, int size)
484 volatile uint64_t *p = (uint64_t *)ptr;
486 } else if (size & 4) {
487 volatile int *p = (int *)ptr;
489 } else if (size & 2) {
490 volatile short *p = (short *)ptr;
493 volatile char *p = (char *)ptr;
498 // Iterate through an array of files, opening each one and calling a function
499 // on that filehandle and name. The special filename "-" means stdin if
500 // flags is O_RDONLY, stdout otherwise. An empty argument list calls
501 // function() on just stdin/stdout.
503 // Note: pass O_CLOEXEC to automatically close filehandles when function()
504 // returns, otherwise filehandles must be closed by function()
505 void loopfiles_rw(char **argv, int flags, int permissions, int failok,
506 void (*function)(int fd, char *name))
510 // If no arguments, read from stdin.
511 if (!*argv) function((flags & O_ACCMODE) != O_RDONLY ? 1 : 0, "-");
513 // Filename "-" means read from stdin.
514 // Inability to open a file prints a warning, but doesn't exit.
516 if (!strcmp(*argv, "-")) fd=0;
517 else if (0>(fd = open(*argv, flags, permissions)) && !failok) {
518 perror_msg("%s", *argv);
523 if (flags & O_CLOEXEC) close(fd);
527 // Call loopfiles_rw with O_RDONLY|O_CLOEXEC and !failok (common case).
528 void loopfiles(char **argv, void (*function)(int fd, char *name))
530 loopfiles_rw(argv, O_RDONLY|O_CLOEXEC, 0, 0, function);
535 char *get_rawline(int fd, long *plen, char end)
541 if (1>read(fd, &c, 1)) break;
542 if (!(len & 63)) buf=xrealloc(buf, len+65);
543 if ((buf[len++]=c) == end) break;
546 if (plen) *plen = len;
551 char *get_line(int fd)
554 char *buf = get_rawline(fd, &len, '\n');
556 if (buf && buf[--len]=='\n') buf[len]=0;
561 int wfchmodat(int fd, char *name, mode_t mode)
563 int rc = fchmodat(fd, name, mode, 0);
566 perror_msg("chmod '%s' to %04o", name, mode);
572 static char *tempfile2zap;
573 static void tempfile_handler(int i)
575 if (1 < (long)tempfile2zap) unlink(tempfile2zap);
579 // Open a temporary file to copy an existing file into.
580 int copy_tempfile(int fdin, char *name, char **tempname)
585 *tempname = xmprintf("%s%s", name, "XXXXXX");
586 if(-1 == (fd = mkstemp(*tempname))) error_exit("no temp file");
587 if (!tempfile2zap) sigatexit(tempfile_handler);
588 tempfile2zap = *tempname;
590 // Set permissions of output file
592 fstat(fdin, &statbuf);
593 fchmod(fd, statbuf.st_mode);
598 // Abort the copy and delete the temporary file.
599 void delete_tempfile(int fdin, int fdout, char **tempname)
603 if (*tempname) unlink(*tempname);
604 tempfile2zap = (char *)1;
609 // Copy the rest of the data and replace the original with the copy.
610 void replace_tempfile(int fdin, int fdout, char **tempname)
612 char *temp = xstrdup(*tempname);
614 temp[strlen(temp)-6]=0;
616 xsendfile(fdin, fdout);
620 rename(*tempname, temp);
621 tempfile2zap = (char *)1;
627 // Create a 256 entry CRC32 lookup table.
629 void crc_init(unsigned int *crc_table, int little_endian)
633 // Init the CRC32 table (big endian)
634 for (i=0; i<256; i++) {
635 unsigned int j, c = little_endian ? i : i<<24;
637 if (little_endian) c = (c&1) ? (c>>1)^0xEDB88320 : c>>1;
638 else c=c&0x80000000 ? (c<<1)^0x04c11db7 : (c<<1);
645 void base64_init(char *p)
649 for (i = 'A'; i != ':'; i++) {
650 if (i == 'Z'+1) i = 'a';
651 if (i == 'z'+1) i = '0';
662 fprintf(stderr, " (%c/%c):", def ? 'Y' : 'y', def ? 'n' : 'N');
664 while (fread(&buf, 1, 1, stdin)) {
667 // The letter changes the value, the newline (or space) returns it.
668 if (isspace(buf)) break;
669 if (-1 != (new = stridx("ny", tolower(buf)))) def = new;
680 // Signals required by POSIX 2008:
681 // http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/signal.h.html
683 #define SIGNIFY(x) {SIG##x, #x}
685 static struct signame signames[] = {
686 SIGNIFY(ABRT), SIGNIFY(ALRM), SIGNIFY(BUS),
687 SIGNIFY(FPE), SIGNIFY(HUP), SIGNIFY(ILL), SIGNIFY(INT), SIGNIFY(KILL),
688 SIGNIFY(PIPE), SIGNIFY(QUIT), SIGNIFY(SEGV), SIGNIFY(TERM),
689 SIGNIFY(USR1), SIGNIFY(USR2), SIGNIFY(SYS), SIGNIFY(TRAP),
690 SIGNIFY(VTALRM), SIGNIFY(XCPU), SIGNIFY(XFSZ),
692 // Start of non-terminal signals
694 SIGNIFY(CHLD), SIGNIFY(CONT), SIGNIFY(STOP), SIGNIFY(TSTP),
695 SIGNIFY(TTIN), SIGNIFY(TTOU), SIGNIFY(URG)
698 // not in posix: SIGNIFY(STKFLT), SIGNIFY(WINCH), SIGNIFY(IO), SIGNIFY(PWR)
699 // obsolete: SIGNIFY(PROF) SIGNIFY(POLL)
701 // Handler that sets toys.signal, and writes to toys.signalfd if set
702 void generic_signal(int sig)
707 writeall(toys.signalfd, &c, 1);
712 // Install the same handler on every signal that defaults to killing the process
713 void sigatexit(void *handler)
716 for (i=0; signames[i].num != SIGCHLD; i++) signal(signames[i].num, handler);
719 // Convert name to signal number. If name == NULL print names.
720 int sig_to_num(char *pidstr)
727 i = estrtol(pidstr, &s, 10);
728 if (!errno && !*s) return i;
730 if (!strncasecmp(pidstr, "sig", 3)) pidstr+=3;
732 for (i = 0; i < sizeof(signames)/sizeof(struct signame); i++)
733 if (!pidstr) xputs(signames[i].name);
734 else if (!strcasecmp(pidstr, signames[i].name)) return signames[i].num;
739 char *num_to_sig(int sig)
743 for (i=0; i<sizeof(signames)/sizeof(struct signame); i++)
744 if (signames[i].num == sig) return signames[i].name;
748 // premute mode bits based on posix mode strings.
749 mode_t string_to_mode(char *modestr, mode_t mode)
751 char *whos = "ogua", *hows = "=+-", *whats = "xwrstX", *whys = "ogu",
753 mode_t extrabits = mode & ~(07777);
757 mode = estrtol(str, &s, 8);
758 if (errno || *s || (mode & ~(07777))) goto barf;
760 return mode | extrabits;
763 // Gaze into the bin of permission...
765 int i, j, dowho, dohow, dowhat, amask;
767 dowho = dohow = dowhat = amask = 0;
769 // Find the who, how, and what stanzas, in that order
770 while (*str && (s = strchr(whos, *str))) {
771 dowho |= 1<<(s-whos);
774 // If who isn't specified, like "a" but honoring umask.
777 umask(amask=umask(0));
779 if (!*str || !(s = strchr(hows, *str))) goto barf;
782 if (!dohow) goto barf;
783 while (*str && (s = strchr(whats, *str))) {
784 dowhat |= 1<<(s-whats);
788 // Convert X to x for directory or if already executable somewhere
789 if ((dowhat&32) && (S_ISDIR(mode) || (mode&0111))) dowhat |= 1;
791 // Copy mode from another category?
792 if (!dowhat && *str && (s = strchr(whys, *str))) {
793 dowhat = (mode>>(3*(s-whys)))&7;
797 // Are we ready to do a thing yet?
798 if (*str && *(str++) != ',') goto barf;
800 // Ok, apply the bits to the mode.
801 for (i=0; i<4; i++) {
802 for (j=0; j<3; j++) {
804 int where = 1<<((3*i)+j);
806 if (amask & where) continue;
808 // Figure out new value at this location
812 if ((dowhat & 8) && (dowho&(8|(1<<i)))) bit++;
813 } else if (dowhat & 16) bit++;
815 if (!(dowho&(8|(1<<i)))) continue;
816 if (dowhat&(1<<j)) bit++;
819 // When selection active, modify bit
821 if (dohow == '=' || (bit && dohow == '-')) mode &= ~where;
822 if (bit && dohow != '-') mode |= where;
829 return mode|extrabits;
831 error_exit("bad mode '%s'", modestr);
834 // Format access mode into a drwxrwxrwx string
835 void mode_to_string(mode_t mode, char *buf)
841 for (i=0; i<9; i++) {
844 if (!c && (mode & (1<<((d=i/3)+9)))) {
846 if (!bit) c &= ~0x20;
847 } else c = bit ? "xwr"[c] : '-';
851 if (S_ISDIR(mode)) c = 'd';
852 else if (S_ISBLK(mode)) c = 'b';
853 else if (S_ISCHR(mode)) c = 'c';
854 else if (S_ISLNK(mode)) c = 'l';
855 else if (S_ISFIFO(mode)) c = 'p';
856 else if (S_ISSOCK(mode)) c = 's';
861 char *basename_r(char *name)
863 char *s = strrchr(name, '/');
869 // Execute a callback for each PID that matches a process name from a list.
870 void names_to_pid(char **names, int (*callback)(pid_t pid, char *name))
873 struct dirent *entry;
875 if (!(dp = opendir("/proc"))) perror_exit("opendir");
877 while ((entry = readdir(dp))) {
879 char *cmd, **curname;
881 if (!(u = atoi(entry->d_name))) continue;
882 sprintf(libbuf, "/proc/%u/cmdline", u);
883 if (!(cmd = readfile(libbuf, libbuf, sizeof(libbuf)))) continue;
885 for (curname = names; *curname; curname++)
886 if (**curname == '/' ? !strcmp(cmd, *curname)
887 : !strcmp(basename_r(cmd), basename_r(*curname)))
888 if (callback(u, *curname)) break;
894 // display first few digits of number with power of two units
895 int human_readable(char *buf, unsigned long long num, int style)
897 unsigned long long snap = 0;
898 int len, unit, divisor = (style&HR_1000) ? 1000 : 1024;
900 // Divide rounding up until we have 3 or fewer digits. Since the part we
901 // print is decimal, the test is 999 even when we divide by 1024.
902 // We can't run out of units because 2<<64 is 18 exabytes.
903 // test 5675 is 5.5k not 5.6k.
904 for (unit = 0; num > 999; unit++) num = ((snap = num)+(divisor/2))/divisor;
905 len = sprintf(buf, "%llu", num);
906 if (unit && len == 1) {
907 // Redo rounding for 1.2M case, this works with and without HR_1000.
910 snap = ((snap*100)+50)/divisor;
912 len = sprintf(buf, "%llu.%llu", num, snap);
914 if (style & HR_SPACE) buf[len++] = ' ';
916 unit = " kMGTPE"[unit];
918 if (!(style&HR_1000)) unit = toupper(unit);
920 } else if (style & HR_B) buf[len++] = 'B';
926 // The qsort man page says you can use alphasort, the posix committee
927 // disagreed, and doubled down: http://austingroupbugs.net/view.php?id=142
928 // So just do our own. (The const is entirely to humor the stupid compiler.)
929 int qstrcmp(const void *a, const void *b)
931 return strcmp(*(char **)a, *(char **)b);
934 int xpoll(struct pollfd *fds, int nfds, int timeout)
939 if (0>(i = poll(fds, nfds, timeout))) {
940 if (errno != EINTR && errno != ENOMEM) perror_exit("xpoll");
941 else if (timeout>0) timeout--;