/* lib.c - reusable stuff. * * Functions with the x prefix are wrappers for library functions. They either * succeed or kill the program with an error message, but never return failure. * They usually have the same arguments and return value as the function they * wrap. * * Copyright 2006 Rob Landley */ #include "toys.h" // Strcpy with size checking: exit if there's not enough space for the string. void xstrcpy(char *dest, char *src, size_t size) { if (strlen(src)+1 > size) error_exit("xstrcpy"); strcpy(dest, src); } void verror_msg(char *msg, int err, va_list va) { char *s = ": %s"; fprintf(stderr, "%s: ", toys.which->name); if (msg) vfprintf(stderr, msg, va); else s+=2; if (err) fprintf(stderr, s, strerror(err)); putc('\n', stderr); if (!toys.exitval) toys.exitval++; } void error_msg(char *msg, ...) { va_list va; va_start(va, msg); verror_msg(msg, 0, va); va_end(va); } void perror_msg(char *msg, ...) { va_list va; va_start(va, msg); verror_msg(msg, errno, va); va_end(va); } // Die with an error message. void error_exit(char *msg, ...) { va_list va; if (CFG_HELP && toys.exithelp) { *toys.optargs=*toys.argv; USE_HELP(help_main();) // dear gcc: shut up. fprintf(stderr,"\n"); } va_start(va, msg); verror_msg(msg, 0, va); va_end(va); if (toys.rebound) longjmp(*toys.rebound, 1); else exit(toys.exitval); } // Die with an error message and strerror(errno) void perror_exit(char *msg, ...) { va_list va; va_start(va, msg); verror_msg(msg, errno, va); va_end(va); if (toys.rebound) longjmp(*toys.rebound, 1); else exit(toys.exitval); } // Die unless we can allocate memory. void *xmalloc(size_t size) { void *ret = malloc(size); if (!ret) error_exit("xmalloc"); return ret; } // Die unless we can allocate prezeroed memory. void *xzalloc(size_t size) { void *ret = xmalloc(size); memset(ret, 0, size); return ret; } // Die unless we can change the size of an existing allocation, possibly // moving it. (Notice different arguments from libc function.) void *xrealloc(void *ptr, size_t size) { ptr = realloc(ptr, size); if (!ptr) error_exit("xrealloc"); return ptr; } // Die unless we can allocate a copy of this many bytes of string. char *xstrndup(char *s, size_t n) { char *ret = xmalloc(++n); strncpy(ret, s, n); ret[--n]=0; return ret; } // Die unless we can allocate a copy of this string. char *xstrdup(char *s) { return xstrndup(s, strlen(s)); } // Die unless we can allocate enough space to sprintf() into. char *xmsprintf(char *format, ...) { va_list va, va2; int len; char *ret; va_start(va, format); va_copy(va2, va); // How long is it? len = vsnprintf(0, 0, format, va); len++; va_end(va); // Allocate and do the sprintf() ret = xmalloc(len); vsnprintf(ret, len, format, va2); va_end(va2); return ret; } void xprintf(char *format, ...) { va_list va; va_start(va, format); vprintf(format, va); if (ferror(stdout)) perror_exit("write"); } void xputs(char *s) { if (EOF == puts(s) || fflush(stdout)) perror_exit("write"); } void xputc(char c) { if (EOF == fputc(c, stdout) || fflush(stdout)) perror_exit("write"); } void xflush(void) { if (fflush(stdout)) perror_exit("write");; } // Die unless we can exec argv[] (or run builtin command). Note that anything // with a path isn't a builtin, so /bin/sh won't match the builtin sh. void xexec(char **argv) { toy_exec(argv); execvp(argv[0], argv); perror_exit("exec %s", argv[0]); } void xaccess(char *path, int flags) { if (access(path, flags)) perror_exit("Can't access '%s'", path); } // Die unless we can delete a file. (File must exist to be deleted.) void xunlink(char *path) { if (unlink(path)) perror_exit("unlink '%s'", path); } // Die unless we can open/create a file, returning file descriptor. int xcreate(char *path, int flags, int mode) { int fd = open(path, flags, mode); if (fd == -1) perror_exit("%s", path); return fd; } // Die unless we can open a file, returning file descriptor. int xopen(char *path, int flags) { return xcreate(path, flags, 0); } void xclose(int fd) { if (close(fd)) perror_exit("xclose"); } int xdup(int fd) { if (fd != -1) { fd = dup(fd); if (fd == -1) perror_exit("xdup"); } return fd; } // Die unless we can open/create a file, returning FILE *. FILE *xfopen(char *path, char *mode) { FILE *f = fopen(path, mode); if (!f) perror_exit("No file %s", path); return f; } // Keep reading until full or EOF ssize_t readall(int fd, void *buf, size_t len) { size_t count = 0; while (count= lseek(fd, offset, SEEK_END) && offset+and == lseek(fd, offset+and, SEEK_SET)) return 0; else { char buf[4096]; while (offset>0) { int try = offset>sizeof(buf) ? sizeof(buf) : offset, or; or = readall(fd, buf, try); if (or < 0) perror_msg("lskip to %lld", (long long)offset); else offset -= try; if (or < try) break; } return offset; } } char *xgetcwd(void) { char *buf = getcwd(NULL, 0); if (!buf) perror_exit("xgetcwd"); return buf; } void xstat(char *path, struct stat *st) { if(stat(path, st)) perror_exit("Can't stat %s", path); } // Split a path into linked list of components, tracking head and tail of list. // Filters out // entries with no contents. struct string_list **splitpath(char *path, struct string_list **list) { char *new = path; *list = 0; do { int len; if (*path && *path != '/') continue; len = path-new; if (len > 0) { *list = xmalloc(sizeof(struct string_list) + len + 1); (*list)->next = 0; strncpy((*list)->str, new, len); (*list)->str[len] = 0; list = &(*list)->next; } new = path+1; } while (*path++); return list; } // Cannonicalize path, even to file with one or more missing components at end. // if exact, require last path component to exist char *xabspath(char *path, int exact) { struct string_list *todo, *done = 0; int try = 9999, dirfd = open("/", 0);; char buf[4096], *ret; // If this isn't an absolute path, start with cwd. if (*path != '/') { char *temp = xgetcwd(); splitpath(path, splitpath(temp, &todo)); free(temp); } else splitpath(path, &todo); // Iterate through path components while (todo) { struct string_list *new = llist_pop(&todo), **tail; ssize_t len; if (!try--) { errno = ELOOP; goto error; } // Removable path componenents. if (!strcmp(new->str, ".") || !strcmp(new->str, "..")) { int x = new->str[1]; free(new); if (x) { if (done) free(llist_pop(&done)); len = 0; } else continue; // Is this a symlink? } else len=readlinkat(dirfd, new->str, buf, 4096); if (len>4095) goto error; if (len<1) { int fd; char *s = ".."; // For .. just move dirfd if (len) { // Not a symlink: add to linked list, move dirfd, fail if error if ((exact || todo) && errno != EINVAL) goto error; new->next = done; done = new; s = new->str; } fd = openat(dirfd, s, 0); if (fd == -1 && (exact || todo || errno != ENOENT)) goto error; close(dirfd); dirfd = fd; continue; } // If this symlink is to an absolute path, discard existing resolved path buf[len] = 0; if (*buf == '/') { llist_traverse(done, free); done=0; close(dirfd); dirfd = open("/", 0); } free(new); // prepend components of new path. Note symlink to "/" will leave new NULL tail = splitpath(buf, &new); // symlink to "/" will return null and leave tail alone if (new) { *tail = todo; todo = new; } } close(dirfd); // At this point done has the path, in reverse order. Reverse list while // calculating buffer length. try = 2; while (done) { struct string_list *temp = llist_pop(&done);; if (todo) try++; try += strlen(temp->str); temp->next = todo; todo = temp; } // Assemble return buffer ret = xmalloc(try); *ret = '/'; ret [try = 1] = 0; while (todo) { if (try>1) ret[try++] = '/'; try = stpcpy(ret+try, todo->str) - ret; free(llist_pop(&todo)); } return ret; error: close(dirfd); llist_traverse(todo, free); llist_traverse(done, free); return NULL; } // Resolve all symlinks, returning malloc() memory. char *xrealpath(char *path) { char *new = realpath(path, NULL); if (!new) perror_exit("realpath '%s'", path); return new; } void xchdir(char *path) { if (chdir(path)) error_exit("chdir '%s'", path); } // Ensure entire path exists. // If mode != -1 set permissions on newly created dirs. // Requires that path string be writable (for temporary null terminators). void xmkpath(char *path, int mode) { char *p, old; mode_t mask; int rc; struct stat st; for (p = path; ; p++) { if (!*p || *p == '/') { old = *p; *p = rc = 0; if (stat(path, &st) || !S_ISDIR(st.st_mode)) { if (mode != -1) { mask=umask(0); rc = mkdir(path, mode); umask(mask); } else rc = mkdir(path, 0777); } *p = old; if(rc) perror_exit("mkpath '%s'", path); } if (!*p) break; } } // setuid() can fail (for example, too many processes belonging to that user), // which opens a security hole if the process continues as the original user. void xsetuid(uid_t uid) { if (setuid(uid)) perror_exit("xsetuid"); } // Find all file in a colon-separated path with access type "type" (generally // X_OK or R_OK). Returns a list of absolute paths to each file found, in // order. struct string_list *find_in_path(char *path, char *filename) { struct string_list *rlist = NULL, **prlist=&rlist; char *cwd = xgetcwd(); for (;;) { char *next = path ? strchr(path, ':') : NULL; int len = next ? next-path : strlen(path); struct string_list *rnext; struct stat st; rnext = xmalloc(sizeof(void *) + strlen(filename) + (len ? len : strlen(cwd)) + 2); if (!len) sprintf(rnext->str, "%s/%s", cwd, filename); else { char *res = rnext->str; strncpy(res, path, len); res += len; *(res++) = '/'; strcpy(res, filename); } // Confirm it's not a directory. if (!stat(rnext->str, &st) && S_ISREG(st.st_mode)) { *prlist = rnext; rnext->next = NULL; prlist = &(rnext->next); } else free(rnext); if (!next) break; path += len; path++; } free(cwd); return rlist; } // Convert unsigned int to ascii, writing into supplied buffer. A truncated // result contains the first few digits of the result ala strncpy, and is // always null terminated (unless buflen is 0). void utoa_to_buf(unsigned n, char *buf, unsigned buflen) { int i, out = 0; if (buflen) { for (i=1000000000; i; i/=10) { int res = n/i; if ((res || out || i == 1) && --buflen>0) { out++; n -= res*i; *buf++ = '0' + res; } } *buf = 0; } } // Convert signed integer to ascii, using utoa_to_buf() void itoa_to_buf(int n, char *buf, unsigned buflen) { if (buflen && n<0) { n = -n; *buf++ = '-'; buflen--; } utoa_to_buf((unsigned)n, buf, buflen); } // This static buffer is used by both utoa() and itoa(), calling either one a // second time will overwrite the previous results. // // The longest 32 bit integer is -2 billion plus a null terminator: 12 bytes. // Note that int is always 32 bits on any remotely unix-like system, see // http://www.unix.org/whitepapers/64bit.html for details. static char itoa_buf[12]; // Convert unsigned integer to ascii, returning a static buffer. char *utoa(unsigned n) { utoa_to_buf(n, itoa_buf, sizeof(itoa_buf)); return itoa_buf; } char *itoa(int n) { itoa_to_buf(n, itoa_buf, sizeof(itoa_buf)); return itoa_buf; } // atol() with the kilo/mega/giga/tera/peta/exa extensions. // (zetta and yotta don't fit in 64 bits.) long atolx(char *numstr) { char *c, *suffixes="bkmgtpe", *end; long val = strtol(numstr, &c, 0); if (*c) { if (c != numstr && (end = strchr(suffixes, tolower(*c)))) { int shift = end-suffixes; if (shift--) val *= 1024L<<(shift*10); } else { while (isspace(*c)) c++; if (*c) error_exit("not integer: %s", numstr); } } return val; } int numlen(long l) { int len = 0; while (l) { l /= 10; len++; } return len; } int stridx(char *haystack, char needle) { char *off; if (!needle) return -1; off = strchr(haystack, needle); if (!off) return -1; return off-haystack; } // Return how long the file at fd is, if there's any way to determine it. off_t fdlength(int fd) { off_t bottom = 0, top = 0, pos, old; int size; // If the ioctl works for this, return it. if (ioctl(fd, BLKGETSIZE, &size) >= 0) return size*512L; // If not, do a binary search for the last location we can read. (Some // block devices don't do BLKGETSIZE right.) This should probably have // a CONFIG option... old = lseek(fd, 0, SEEK_CUR); do { char temp; pos = bottom + (top - bottom) / 2; // If we can read from the current location, it's bigger. if (lseek(fd, pos, 0)>=0 && read(fd, &temp, 1)==1) { if (bottom == top) bottom = top = (top+1) * 2; else bottom = pos; // If we can't, it's smaller. } else { if (bottom == top) { if (!top) return 0; bottom = top/2; } else top = pos; } } while (bottom + 1 != top); lseek(fd, old, SEEK_SET); return pos + 1; } // This can return null (meaning file not found). It just won't return null // for memory allocation reasons. char *xreadlink(char *name) { int len, size = 0; char *buf = 0; // Grow by 64 byte chunks until it's big enough. for(;;) { size +=64; buf = xrealloc(buf, size); len = readlink(name, buf, size); if (len<0) { free(buf); return 0; } if (len(fd = open(*argv, flags, permissions)) && !failok) { perror_msg("%s", *argv); toys.exitval = 1; continue; } function(fd, *argv); if (flags == O_RDONLY) close(fd); } while (*++argv); } // Call loopfiles_rw with O_RDONLY and !failok (common case). void loopfiles(char **argv, void (*function)(int fd, char *name)) { loopfiles_rw(argv, O_RDONLY, 0, 0, function); } // Slow, but small. char *get_rawline(int fd, long *plen, char end) { char c, *buf = NULL; long len = 0; for (;;) { if (1>read(fd, &c, 1)) break; if (!(len & 63)) buf=xrealloc(buf, len+65); if ((buf[len++]=c) == end) break; } if (buf) buf[len]=0; if (plen) *plen = len; return buf; } char *get_line(int fd) { long len; char *buf = get_rawline(fd, &len, '\n'); if (buf && buf[--len]=='\n') buf[len]=0; return buf; } // Copy the rest of in to out and close both files. void xsendfile(int in, int out) { long len; char buf[4096]; if (in<0) return; for (;;) { len = xread(in, buf, 4096); if (len<1) break; xwrite(out, buf, len); } } int wfchmodat(int fd, char *name, mode_t mode) { int rc = fchmodat(fd, name, mode, 0); if (rc) { perror_msg("chmod '%s' to %04o", name, mode); toys.exitval=1; } return rc; } static char *tempfile2zap; static void tempfile_handler(int i) { if (1 < (long)tempfile2zap) unlink(tempfile2zap); _exit(1); } // Open a temporary file to copy an existing file into. int copy_tempfile(int fdin, char *name, char **tempname) { struct stat statbuf; int fd; *tempname = xstrndup(name, strlen(name)+6); strcat(*tempname,"XXXXXX"); if(-1 == (fd = mkstemp(*tempname))) error_exit("no temp file"); if (!tempfile2zap) sigatexit(tempfile_handler); tempfile2zap = *tempname; // Set permissions of output file fstat(fdin, &statbuf); fchmod(fd, statbuf.st_mode); return fd; } // Abort the copy and delete the temporary file. void delete_tempfile(int fdin, int fdout, char **tempname) { close(fdin); close(fdout); unlink(*tempname); tempfile2zap = (char *)1; free(*tempname); *tempname = NULL; } // Copy the rest of the data and replace the original with the copy. void replace_tempfile(int fdin, int fdout, char **tempname) { char *temp = xstrdup(*tempname); temp[strlen(temp)-6]=0; if (fdin != -1) { xsendfile(fdin, fdout); xclose(fdin); } xclose(fdout); rename(*tempname, temp); tempfile2zap = (char *)1; free(*tempname); free(temp); *tempname = NULL; } // Create a 256 entry CRC32 lookup table. void crc_init(unsigned int *crc_table, int little_endian) { unsigned int i; // Init the CRC32 table (big endian) for (i=0; i<256; i++) { unsigned int j, c = little_endian ? i : i<<24; for (j=8; j; j--) if (little_endian) c = (c&1) ? (c>>1)^0xEDB88320 : c>>1; else c=c&0x80000000 ? (c<<1)^0x04c11db7 : (c<<1); crc_table[i] = c; } } // Quick and dirty query size of terminal, doesn't do ANSI probe fallback. // set *x=0 and *y=0 before calling to detect failure to set either, or // x=80 y=25 to provide defaults void terminal_size(unsigned *x, unsigned *y) { struct winsize ws; int i; //memset(&ws, 0, sizeof(ws)); for (i=0; i<3; i++) { if (ioctl(i, TIOCGWINSZ, &ws)) continue; if (x) *x = ws.ws_col; if (y) *y = ws.ws_row; } if (x) { char *s = getenv("COLUMNS"); i = s ? atoi(s) : 0; if (i>0) *x = i; } if (y) { char *s = getenv("ROWS"); i = s ? atoi(s) : 0; if (i>0) *y = i; } } int yesno(char *prompt, int def) { char buf; fprintf(stderr, "%s (%c/%c):", prompt, def ? 'Y' : 'y', def ? 'n' : 'N'); fflush(stderr); while (fread(&buf, 1, 1, stdin)) { int new; // The letter changes the value, the newline (or space) returns it. if (isspace(buf)) break; if (-1 != (new = stridx("ny", tolower(buf)))) def = new; } return def; } // Execute a callback for each PID that matches a process name from a list. void for_each_pid_with_name_in(char **names, int (*callback)(pid_t pid, char *name)) { DIR *dp; struct dirent *entry; char cmd[sizeof(toybuf)], path[64]; char **curname; if (!(dp = opendir("/proc"))) perror_exit("opendir"); while ((entry = readdir(dp))) { int fd, n; if (!isdigit(*entry->d_name)) continue; if (sizeof(path) <= snprintf(path, sizeof(path), "/proc/%s/cmdline", entry->d_name)) continue; if (-1 == (fd=open(path, O_RDONLY))) continue; n = read(fd, cmd, sizeof(cmd)); close(fd); if (n<1) continue; for (curname = names; *curname; curname++) if (!strcmp(basename(cmd), *curname)) if (!callback(atol(entry->d_name), *curname)) goto done; } done: closedir(dp); } struct signame { int num; char *name; }; // Signals required by POSIX 2008: // http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/signal.h.html #define SIGNIFY(x) {SIG##x, #x} static struct signame signames[] = { SIGNIFY(ABRT), SIGNIFY(ALRM), SIGNIFY(BUS), SIGNIFY(FPE), SIGNIFY(HUP), SIGNIFY(ILL), SIGNIFY(INT), SIGNIFY(KILL), SIGNIFY(PIPE), SIGNIFY(QUIT), SIGNIFY(SEGV), SIGNIFY(TERM), SIGNIFY(USR1), SIGNIFY(USR2), SIGNIFY(SYS), SIGNIFY(TRAP), SIGNIFY(VTALRM), SIGNIFY(XCPU), SIGNIFY(XFSZ), // Start of non-terminal signals SIGNIFY(CHLD), SIGNIFY(CONT), SIGNIFY(STOP), SIGNIFY(TSTP), SIGNIFY(TTIN), SIGNIFY(TTOU), SIGNIFY(URG) }; // not in posix: SIGNIFY(STKFLT), SIGNIFY(WINCH), SIGNIFY(IO), SIGNIFY(PWR) // obsolete: SIGNIFY(PROF) SIGNIFY(POLL) // Install the same handler on every signal that defaults to killing the process void sigatexit(void *handler) { int i; for (i=0; signames[i].num != SIGCHLD; i++) signal(signames[i].num, handler); } // Convert name to signal number. If name == NULL print names. int sig_to_num(char *pidstr) { int i; if (pidstr) { char *s; i = strtol(pidstr, &s, 10); if (!*s) return i; if (!strncasecmp(pidstr, "sig", 3)) pidstr+=3; } for (i = 0; i < sizeof(signames)/sizeof(struct signame); i++) if (!pidstr) xputs(signames[i].name); else if (!strcasecmp(pidstr, signames[i].name)) return signames[i].num; return -1; } char *num_to_sig(int sig) { int i; for (i=0; i>(3*(s-whys)))&7; str++; } // Are we ready to do a thing yet? if (*str && *(str++) != ',') goto barf; // Ok, apply the bits to the mode. for (i=0; i<4; i++) { for (j=0; j<3; j++) { mode_t bit = 0; int where = 1<<((3*i)+j); if (amask & where) continue; // Figure out new value at this location if (i == 3) { // suid/sticky bit. if (j) { if ((dowhat & 8) && (dowho&(8|(1<= 1024) { frac = size%1024; size /= 1024; index++; } frac = (frac/102) + ((frac%102)?1:0); if(frac >= 10) { size += 1; frac = 0; } if(frac) return xmsprintf("%llu.%u%c", size, frac, units[index]); else return xmsprintf("%llu%c", size, units[index]); } return NULL; //not reached } // strtoul with exit on error unsigned long xstrtoul(const char *nptr, char **endptr, int base) { unsigned long l; errno = 0; l = strtoul(nptr, endptr, base); if (errno) perror_exit("xstrtoul"); return l; } /* * used to get the interger value. */ unsigned long get_int_value(const char *numstr, unsigned lowrange, unsigned highrange) { unsigned long rvalue = 0; char *ptr; if(*numstr == '-' || *numstr == '+' || isspace(*numstr)) perror_exit("invalid number '%s'", numstr); errno = 0; rvalue = strtoul(numstr, &ptr, 10); if(errno || numstr == ptr) perror_exit("invalid number '%s'", numstr); if(*ptr) perror_exit("invalid number '%s'", numstr); if(rvalue >= lowrange && rvalue <= highrange) return rvalue; else { perror_exit("invalid number '%s'", numstr); return rvalue; //Not reachable; to avoid waring message. } }