• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /* xwrap.c - wrappers around existing library functions.
2  *
3  * Functions with the x prefix are wrappers that either succeed or kill the
4  * program with an error message, but never return failure. They usually have
5  * the same arguments and return value as the function they wrap.
6  *
7  * Copyright 2006 Rob Landley <rob@landley.net>
8  */
9 
10 #include "toys.h"
11 
12 // strcpy and strncat with size checking. Size is the total space in "dest",
13 // including null terminator. Exit if there's not enough space for the string
14 // (including space for the null terminator), because silently truncating is
15 // still broken behavior. (And leaving the string unterminated is INSANE.)
xstrncpy(char * dest,char * src,size_t size)16 void xstrncpy(char *dest, char *src, size_t size)
17 {
18   if (strlen(src)+1 > size) error_exit("'%s' > %ld bytes", src, (long)size);
19   strcpy(dest, src);
20 }
21 
xstrncat(char * dest,char * src,size_t size)22 void xstrncat(char *dest, char *src, size_t size)
23 {
24   long len = strlen(dest);
25 
26   if (len+strlen(src)+1 > size)
27     error_exit("'%s%s' > %ld bytes", dest, src, (long)size);
28   strcpy(dest+len, src);
29 }
30 
31 // We replaced exit(), _exit(), and atexit() with xexit(), _xexit(), and
32 // sigatexit(). This gives _xexit() the option to siglongjmp(toys.rebound, 1)
33 // instead of exiting, lets xexit() report stdout flush failures to stderr
34 // and change the exit code to indicate error, lets our toys.exit function
35 // change happen for signal exit paths and lets us remove the functions
36 // after we've called them.
37 
_xexit(void)38 void _xexit(void)
39 {
40   if (toys.rebound) siglongjmp(*toys.rebound, 1);
41 
42   _exit(toys.exitval);
43 }
44 
xexit(void)45 void xexit(void)
46 {
47   // Call toys.xexit functions in reverse order added.
48   while (toys.xexit) {
49     struct arg_list *al = llist_pop(&toys.xexit);
50 
51     // typecast xexit->arg to a function pointer, then call it using invalid
52     // signal 0 to let signal handlers tell actual signal from regular exit.
53     ((void (*)(int))(al->arg))(0);
54 
55     free(al);
56   }
57   xflush(1);
58   _xexit();
59 }
60 
xmmap(void * addr,size_t length,int prot,int flags,int fd,off_t off)61 void *xmmap(void *addr, size_t length, int prot, int flags, int fd, off_t off)
62 {
63   void *ret = mmap(addr, length, prot, flags, fd, off);
64   if (ret == MAP_FAILED) perror_exit("mmap");
65   return ret;
66 }
67 
68 // Die unless we can allocate memory.
xmalloc(size_t size)69 void *xmalloc(size_t size)
70 {
71   void *ret = malloc(size);
72   if (!ret) error_exit("xmalloc(%ld)", (long)size);
73 
74   return ret;
75 }
76 
77 // Die unless we can allocate prezeroed memory.
xzalloc(size_t size)78 void *xzalloc(size_t size)
79 {
80   void *ret = xmalloc(size);
81   memset(ret, 0, size);
82   return ret;
83 }
84 
85 // Die unless we can change the size of an existing allocation, possibly
86 // moving it.  (Notice different arguments from libc function.)
xrealloc(void * ptr,size_t size)87 void *xrealloc(void *ptr, size_t size)
88 {
89   ptr = realloc(ptr, size);
90   if (!ptr) error_exit("xrealloc");
91 
92   return ptr;
93 }
94 
95 // Die unless we can allocate a copy of this many bytes of string.
xstrndup(char * s,size_t n)96 char *xstrndup(char *s, size_t n)
97 {
98   char *ret = strndup(s, n);
99 
100   if (!ret) error_exit("xstrndup");
101 
102   return ret;
103 }
104 
105 // Die unless we can allocate a copy of this string.
xstrdup(char * s)106 char *xstrdup(char *s)
107 {
108   return xstrndup(s, strlen(s));
109 }
110 
xmemdup(void * s,long len)111 void *xmemdup(void *s, long len)
112 {
113   void *ret = xmalloc(len);
114   memcpy(ret, s, len);
115 
116   return ret;
117 }
118 
119 // Die unless we can allocate enough space to sprintf() into.
xmprintf(char * format,...)120 char *xmprintf(char *format, ...)
121 {
122   va_list va, va2;
123   int len;
124   char *ret;
125 
126   va_start(va, format);
127   va_copy(va2, va);
128 
129   // How long is it?
130   len = vsnprintf(0, 0, format, va);
131   len++;
132   va_end(va);
133 
134   // Allocate and do the sprintf()
135   ret = xmalloc(len);
136   vsnprintf(ret, len, format, va2);
137   va_end(va2);
138 
139   return ret;
140 }
141 
142 // if !flush just check for error on stdout without flushing
xflush(int flush)143 void xflush(int flush)
144 {
145   if ((flush && fflush(0)) || ferror(stdout))
146     if (!toys.exitval) perror_msg("write");
147 }
148 
xprintf(char * format,...)149 void xprintf(char *format, ...)
150 {
151   va_list va;
152   va_start(va, format);
153 
154   vprintf(format, va);
155   va_end(va);
156   xflush(0);
157 }
158 
159 // Put string with length (does not append newline)
xputsl(char * s,int len)160 void xputsl(char *s, int len)
161 {
162   int out;
163 
164   while (len != (out = fwrite(s, 1, len, stdout))) {
165     if (out<1) perror_exit("write");
166     len -= out;
167     s += out;
168   }
169   xflush(0);
170 }
171 
172 // xputs with no newline
xputsn(char * s)173 void xputsn(char *s)
174 {
175   xputsl(s, strlen(s));
176 }
177 
178 // Write string to stdout with newline, flushing and checking for errors
xputs(char * s)179 void xputs(char *s)
180 {
181   puts(s);
182   xflush(0);
183 }
184 
xputc(char c)185 void xputc(char c)
186 {
187   if (EOF == fputc(c, stdout)) perror_exit("write");
188   xflush(0);
189 }
190 
191 // This is called through the XVFORK macro because parent/child of vfork
192 // share a stack, so child returning from a function would stomp the return
193 // address parent would need. Solution: make vfork() an argument so processes
194 // diverge before function gets called.
xvforkwrap(pid_t pid)195 pid_t __attribute__((returns_twice)) xvforkwrap(pid_t pid)
196 {
197   if (pid == -1) perror_exit("vfork");
198 
199   // Signal to xexec() and friends that we vforked so can't recurse
200   if (!pid) toys.stacktop = 0;
201 
202   return pid;
203 }
204 
205 // Die unless we can exec argv[] (or run builtin command).  Note that anything
206 // with a path isn't a builtin, so /bin/sh won't match the builtin sh.
xexec(char ** argv)207 void xexec(char **argv)
208 {
209   // Only recurse to builtin when we have multiplexer and !vfork context.
210   if (CFG_TOYBOX && !CFG_TOYBOX_NORECURSE && toys.stacktop && **argv != '/')
211     toy_exec(argv);
212   execvp(argv[0], argv);
213 
214   toys.exitval = 126+(errno == ENOENT);
215   perror_msg("exec %s", argv[0]);
216   if (!toys.stacktop) _exit(toys.exitval);
217   xexit();
218 }
219 
220 // Spawn child process, capturing stdin/stdout.
221 // argv[]: command to exec. If null, child re-runs original program with
222 //         toys.stacktop zeroed.
223 // pipes[2]: Filehandle to move to stdin/stdout of new process.
224 //           If -1, replace with pipe handle connected to stdin/stdout.
225 //           NULL treated as {0, 1}, I.E. leave stdin/stdout as is
226 // return: pid of child process
xpopen_both(char ** argv,int * pipes)227 pid_t xpopen_both(char **argv, int *pipes)
228 {
229   int cestnepasun[4], pid;
230 
231   // Make the pipes?
232   memset(cestnepasun, 0, sizeof(cestnepasun));
233   if (pipes) for (pid = 0; pid < 2; pid++) {
234     if (pipes[pid] != -1) continue;
235     if (pipe(cestnepasun+(2*pid))) perror_exit("pipe");
236   }
237 
238   if (!(pid = CFG_TOYBOX_FORK ? xfork() : XVFORK())) {
239     // Child process: Dance of the stdin/stdout redirection.
240     // cestnepasun[1]->cestnepasun[0] and cestnepasun[3]->cestnepasun[2]
241     if (pipes) {
242       // if we had no stdin/out, pipe handles could overlap, so test for it
243       // and free up potentially overlapping pipe handles before reuse
244 
245       // in child, close read end of output pipe, use write end as new stdout
246       if (cestnepasun[2]) {
247         close(cestnepasun[2]);
248         pipes[1] = cestnepasun[3];
249       }
250 
251       // in child, close write end of input pipe, use read end as new stdin
252       if (cestnepasun[1]) {
253         close(cestnepasun[1]);
254         pipes[0] = cestnepasun[0];
255       }
256 
257       // If swapping stdin/stdout, dup a filehandle that gets closed before use
258       if (!pipes[1]) pipes[1] = dup(0);
259 
260       // Are we redirecting stdin?
261       if (pipes[0]) {
262         dup2(pipes[0], 0);
263         close(pipes[0]);
264       }
265 
266       // Are we redirecting stdout?
267       if (pipes[1] != 1) {
268         dup2(pipes[1], 1);
269         close(pipes[1]);
270       }
271     }
272     if (argv) xexec(argv);
273 
274     // In fork() case, force recursion because we know it's us.
275     if (CFG_TOYBOX_FORK) {
276       toy_init(toys.which, toys.argv);
277       toys.stacktop = 0;
278       toys.which->toy_main();
279       xexit();
280     // In vfork() case, exec /proc/self/exe with high bit of first letter set
281     // to tell main() we reentered.
282     } else {
283       char *s = "/proc/self/exe";
284 
285       // We did a nommu-friendly vfork but must exec to continue.
286       // setting high bit of argv[0][0] to let new process know
287       **toys.argv |= 0x80;
288       execv(s, toys.argv);
289       perror_msg_raw(s);
290 
291       _exit(127);
292     }
293   }
294 
295   // Parent process: vfork had a shared environment, clean up.
296   if (!CFG_TOYBOX_FORK) **toys.argv &= 0x7f;
297 
298   if (pipes) {
299     if (cestnepasun[1]) {
300       pipes[0] = cestnepasun[1];
301       close(cestnepasun[0]);
302     }
303     if (cestnepasun[2]) {
304       pipes[1] = cestnepasun[2];
305       close(cestnepasun[3]);
306     }
307   }
308 
309   return pid;
310 }
311 
312 // Wait for child process to exit, then return adjusted exit code.
xwaitpid(pid_t pid)313 int xwaitpid(pid_t pid)
314 {
315   int status;
316 
317   while (-1 == waitpid(pid, &status, 0) && errno == EINTR);
318 
319   return WIFEXITED(status) ? WEXITSTATUS(status) : WTERMSIG(status)+128;
320 }
321 
xpclose_both(pid_t pid,int * pipes)322 int xpclose_both(pid_t pid, int *pipes)
323 {
324   if (pipes) {
325     close(pipes[0]);
326     close(pipes[1]);
327   }
328 
329   return xwaitpid(pid);
330 }
331 
332 // Wrapper to xpopen with a pipe for just one of stdin/stdout
xpopen(char ** argv,int * pipe,int isstdout)333 pid_t xpopen(char **argv, int *pipe, int isstdout)
334 {
335   int pipes[2], pid;
336 
337   pipes[0] = isstdout ? 0 : -1;
338   pipes[1] = isstdout ? -1 : 1;
339   pid = xpopen_both(argv, pipes);
340   *pipe = pid ? pipes[!!isstdout] : -1;
341 
342   return pid;
343 }
344 
xpclose(pid_t pid,int pipe)345 int xpclose(pid_t pid, int pipe)
346 {
347   close(pipe);
348 
349   return xpclose_both(pid, 0);
350 }
351 
352 // Call xpopen and wait for it to finish, keeping existing stdin/stdout.
xrun(char ** argv)353 int xrun(char **argv)
354 {
355   return xpclose_both(xpopen_both(argv, 0), 0);
356 }
357 
xaccess(char * path,int flags)358 void xaccess(char *path, int flags)
359 {
360   if (access(path, flags)) perror_exit("Can't access '%s'", path);
361 }
362 
363 // Die unless we can delete a file.  (File must exist to be deleted.)
xunlink(char * path)364 void xunlink(char *path)
365 {
366   if (unlink(path)) perror_exit("unlink '%s'", path);
367 }
368 
369 // Die unless we can open/create a file, returning file descriptor.
370 // The meaning of O_CLOEXEC is reversed (it defaults on, pass it to disable)
371 // and WARN_ONLY tells us not to exit.
xcreate_stdio(char * path,int flags,int mode)372 int xcreate_stdio(char *path, int flags, int mode)
373 {
374   int fd = open(path, (flags^O_CLOEXEC)&~WARN_ONLY, mode);
375 
376   if (fd == -1) ((mode&WARN_ONLY) ? perror_msg_raw : perror_exit_raw)(path);
377   return fd;
378 }
379 
380 // Die unless we can open a file, returning file descriptor.
xopen_stdio(char * path,int flags)381 int xopen_stdio(char *path, int flags)
382 {
383   return xcreate_stdio(path, flags, 0);
384 }
385 
xpipe(int * pp)386 void xpipe(int *pp)
387 {
388   if (pipe(pp)) perror_exit("xpipe");
389 }
390 
xclose(int fd)391 void xclose(int fd)
392 {
393   if (fd != -1 && close(fd)) perror_exit("xclose");
394 }
395 
xdup(int fd)396 int xdup(int fd)
397 {
398   if (fd != -1) {
399     fd = dup(fd);
400     if (fd == -1) perror_exit("xdup");
401   }
402   return fd;
403 }
404 
405 // Move file descriptor above stdin/stdout/stderr, using /dev/null to consume
406 // old one. (We should never be called with stdin/stdout/stderr closed, but...)
notstdio(int fd)407 int notstdio(int fd)
408 {
409   if (fd<0) return fd;
410 
411   while (fd<3) {
412     int fd2 = xdup(fd);
413 
414     close(fd);
415     xopen_stdio("/dev/null", O_RDWR);
416     fd = fd2;
417   }
418 
419   return fd;
420 }
421 
xrename(char * from,char * to)422 void xrename(char *from, char *to)
423 {
424   if (rename(from, to)) perror_exit("rename %s -> %s", from, to);
425 }
426 
xtempfile(char * name,char ** tempname)427 int xtempfile(char *name, char **tempname)
428 {
429   int fd;
430 
431    *tempname = xmprintf("%s%s", name, "XXXXXX");
432   if(-1 == (fd = mkstemp(*tempname))) error_exit("no temp file");
433 
434   return fd;
435 }
436 
437 // Create a file but don't return stdin/stdout/stderr
xcreate(char * path,int flags,int mode)438 int xcreate(char *path, int flags, int mode)
439 {
440   return notstdio(xcreate_stdio(path, flags, mode));
441 }
442 
443 // Open a file descriptor NOT in stdin/stdout/stderr
xopen(char * path,int flags)444 int xopen(char *path, int flags)
445 {
446   return notstdio(xopen_stdio(path, flags));
447 }
448 
449 // Open read only, treating "-" as a synonym for stdin, defaulting to warn only
openro(char * path,int flags)450 int openro(char *path, int flags)
451 {
452   if (!strcmp(path, "-")) return 0;
453 
454   return xopen(path, flags^WARN_ONLY);
455 }
456 
457 // Open read only, treating "-" as a synonym for stdin.
xopenro(char * path)458 int xopenro(char *path)
459 {
460   return openro(path, O_RDONLY|WARN_ONLY);
461 }
462 
xfdopen(int fd,char * mode)463 FILE *xfdopen(int fd, char *mode)
464 {
465   FILE *f = fdopen(fd, mode);
466 
467   if (!f) perror_exit("xfdopen");
468 
469   return f;
470 }
471 
472 // Die unless we can open/create a file, returning FILE *.
xfopen(char * path,char * mode)473 FILE *xfopen(char *path, char *mode)
474 {
475   FILE *f = fopen(path, mode);
476   if (!f) perror_exit("No file %s", path);
477   return f;
478 }
479 
480 // Die if there's an error other than EOF.
xread(int fd,void * buf,size_t len)481 size_t xread(int fd, void *buf, size_t len)
482 {
483   ssize_t ret = read(fd, buf, len);
484   if (ret < 0) perror_exit("xread");
485 
486   return ret;
487 }
488 
xreadall(int fd,void * buf,size_t len)489 void xreadall(int fd, void *buf, size_t len)
490 {
491   if (len != readall(fd, buf, len)) perror_exit("xreadall");
492 }
493 
494 // There's no xwriteall(), just xwrite().  When we read, there may or may not
495 // be more data waiting.  When we write, there is data and it had better go
496 // somewhere.
497 
xwrite(int fd,void * buf,size_t len)498 void xwrite(int fd, void *buf, size_t len)
499 {
500   if (len != writeall(fd, buf, len)) perror_exit("xwrite");
501 }
502 
503 // Die if lseek fails, probably due to being called on a pipe.
504 
xlseek(int fd,off_t offset,int whence)505 off_t xlseek(int fd, off_t offset, int whence)
506 {
507   offset = lseek(fd, offset, whence);
508   if (offset<0) perror_exit("lseek");
509 
510   return offset;
511 }
512 
xgetcwd(void)513 char *xgetcwd(void)
514 {
515   char *buf = getcwd(NULL, 0);
516   if (!buf) perror_exit("xgetcwd");
517 
518   return buf;
519 }
520 
xstat(char * path,struct stat * st)521 void xstat(char *path, struct stat *st)
522 {
523   if(stat(path, st)) perror_exit("Can't stat %s", path);
524 }
525 
526 // Canonicalize path, even to file with one or more missing components at end.
527 // Returns allocated string for pathname or NULL if doesn't exist
528 // exact = 1 file must exist, 0 dir must exist, -1 show theoretical location
xabspath(char * path,int exact)529 char *xabspath(char *path, int exact)
530 {
531   struct string_list *todo, *done = 0;
532   int try = 9999, dirfd = open("/", O_PATH), missing = 0;
533   char *ret;
534 
535   // If this isn't an absolute path, start with cwd.
536   if (*path != '/') {
537     char *temp = xgetcwd();
538 
539     splitpath(path, splitpath(temp, &todo));
540     free(temp);
541   } else splitpath(path, &todo);
542 
543   // Iterate through path components in todo, prepend processed ones to done.
544   while (todo) {
545     struct string_list *new = llist_pop(&todo), **tail;
546     ssize_t len;
547 
548     // Eventually break out of endless loops
549     if (!try--) {
550       errno = ELOOP;
551       goto error;
552     }
553 
554     // Removable path componenents.
555     if (!strcmp(new->str, ".") || !strcmp(new->str, "..")) {
556       int x = new->str[1];
557 
558       free(new);
559       if (!x) continue;
560       if (done) free(llist_pop(&done));
561       len = 0;
562 
563       if (missing) missing--;
564       else {
565         if (-1 == (x = openat(dirfd, "..", O_PATH))) goto error;
566         close(dirfd);
567         dirfd = x;
568       }
569       continue;
570     }
571 
572     // Is this a symlink?
573     len = readlinkat(dirfd, new->str, libbuf, sizeof(libbuf));
574     if (len>4095) goto error;
575 
576     // Not a symlink: add to linked list, move dirfd, fail if error
577     if (len<1) {
578       int fd;
579 
580       new->next = done;
581       done = new;
582       if (errno == EINVAL && !todo) break;
583       if (errno == ENOENT && exact<0) {
584         missing++;
585         continue;
586       }
587       if (errno != EINVAL && (exact || todo)) goto error;
588 
589       fd = openat(dirfd, new->str, O_PATH);
590       if (fd == -1 && (exact || todo || errno != ENOENT)) goto error;
591       close(dirfd);
592       dirfd = fd;
593       continue;
594     }
595 
596     // If this symlink is to an absolute path, discard existing resolved path
597     libbuf[len] = 0;
598     if (*libbuf == '/') {
599       llist_traverse(done, free);
600       done=0;
601       close(dirfd);
602       dirfd = open("/", O_PATH);
603     }
604     free(new);
605 
606     // prepend components of new path. Note symlink to "/" will leave new NULL
607     tail = splitpath(libbuf, &new);
608 
609     // symlink to "/" will return null and leave tail alone
610     if (new) {
611       *tail = todo;
612       todo = new;
613     }
614   }
615   close(dirfd);
616 
617   // At this point done has the path, in reverse order. Reverse list while
618   // calculating buffer length.
619 
620   try = 2;
621   while (done) {
622     struct string_list *temp = llist_pop(&done);
623 
624     if (todo) try++;
625     try += strlen(temp->str);
626     temp->next = todo;
627     todo = temp;
628   }
629 
630   // Assemble return buffer
631 
632   ret = xmalloc(try);
633   *ret = '/';
634   ret [try = 1] = 0;
635   while (todo) {
636     if (try>1) ret[try++] = '/';
637     try = stpcpy(ret+try, todo->str) - ret;
638     free(llist_pop(&todo));
639   }
640 
641   return ret;
642 
643 error:
644   close(dirfd);
645   llist_traverse(todo, free);
646   llist_traverse(done, free);
647 
648   return 0;
649 }
650 
xchdir(char * path)651 void xchdir(char *path)
652 {
653   if (chdir(path)) perror_exit("chdir '%s'", path);
654 }
655 
xchroot(char * path)656 void xchroot(char *path)
657 {
658   if (chroot(path)) error_exit("chroot '%s'", path);
659   xchdir("/");
660 }
661 
xgetpwuid(uid_t uid)662 struct passwd *xgetpwuid(uid_t uid)
663 {
664   struct passwd *pwd = getpwuid(uid);
665   if (!pwd) error_exit("bad uid %ld", (long)uid);
666   return pwd;
667 }
668 
xgetgrgid(gid_t gid)669 struct group *xgetgrgid(gid_t gid)
670 {
671   struct group *group = getgrgid(gid);
672 
673   if (!group) perror_exit("gid %ld", (long)gid);
674   return group;
675 }
676 
xgetuid(char * name)677 unsigned xgetuid(char *name)
678 {
679   struct passwd *up = getpwnam(name);
680   char *s = 0;
681   long uid;
682 
683   if (up) return up->pw_uid;
684 
685   uid = estrtol(name, &s, 10);
686   if (!errno && s && !*s && uid>=0 && uid<=UINT_MAX) return uid;
687 
688   error_exit("bad user '%s'", name);
689 }
690 
xgetgid(char * name)691 unsigned xgetgid(char *name)
692 {
693   struct group *gr = getgrnam(name);
694   char *s = 0;
695   long gid;
696 
697   if (gr) return gr->gr_gid;
698 
699   gid = estrtol(name, &s, 10);
700   if (!errno && s && !*s && gid>=0 && gid<=UINT_MAX) return gid;
701 
702   error_exit("bad group '%s'", name);
703 }
704 
xgetpwnam(char * name)705 struct passwd *xgetpwnam(char *name)
706 {
707   struct passwd *up = getpwnam(name);
708 
709   if (!up) perror_exit("user '%s'", name);
710   return up;
711 }
712 
xgetgrnam(char * name)713 struct group *xgetgrnam(char *name)
714 {
715   struct group *gr = getgrnam(name);
716 
717   if (!gr) perror_exit("group '%s'", name);
718   return gr;
719 }
720 
721 // setuid() can fail (for example, too many processes belonging to that user),
722 // which opens a security hole if the process continues as the original user.
723 
xsetuser(struct passwd * pwd)724 void xsetuser(struct passwd *pwd)
725 {
726   if (initgroups(pwd->pw_name, pwd->pw_gid) || setgid(pwd->pw_uid)
727       || setuid(pwd->pw_uid)) perror_exit("xsetuser '%s'", pwd->pw_name);
728 }
729 
730 // This can return null (meaning file not found).  It just won't return null
731 // for memory allocation reasons.
xreadlink(char * name)732 char *xreadlink(char *name)
733 {
734   int len, size = 0;
735   char *buf = 0;
736 
737   // Grow by 64 byte chunks until it's big enough.
738   for(;;) {
739     size +=64;
740     buf = xrealloc(buf, size);
741     len = readlink(name, buf, size);
742 
743     if (len<0) {
744       free(buf);
745       return 0;
746     }
747     if (len<size) {
748       buf[len]=0;
749       return buf;
750     }
751   }
752 }
753 
xreadfile(char * name,char * buf,off_t len)754 char *xreadfile(char *name, char *buf, off_t len)
755 {
756   if (!(buf = readfile(name, buf, len))) perror_exit("Bad '%s'", name);
757 
758   return buf;
759 }
760 
761 // The data argument to ioctl() is actually long, but it's usually used as
762 // a pointer. If you need to feed in a number, do (void *)(long) typecast.
xioctl(int fd,int request,void * data)763 int xioctl(int fd, int request, void *data)
764 {
765   int rc;
766 
767   errno = 0;
768   rc = ioctl(fd, request, data);
769   if (rc == -1 && errno) perror_exit("ioctl %x", request);
770 
771   return rc;
772 }
773 
774 // Open a /var/run/NAME.pid file, dying if we can't write it or if it currently
775 // exists and is this executable.
xpidfile(char * name)776 void xpidfile(char *name)
777 {
778   char pidfile[256], spid[32];
779   int i, fd;
780   pid_t pid;
781 
782   sprintf(pidfile, "/var/run/%s.pid", name);
783   // Try three times to open the sucker.
784   for (i=0; i<3; i++) {
785     fd = open(pidfile, O_CREAT|O_EXCL|O_WRONLY, 0644);
786     if (fd != -1) break;
787 
788     // If it already existed, read it.  Loop for race condition.
789     fd = open(pidfile, O_RDONLY);
790     if (fd == -1) continue;
791 
792     // Is the old program still there?
793     spid[xread(fd, spid, sizeof(spid)-1)] = 0;
794     close(fd);
795     pid = atoi(spid);
796     if (pid < 1 || (kill(pid, 0) && errno == ESRCH)) unlink(pidfile);
797 
798     // An else with more sanity checking might be nice here.
799   }
800 
801   if (i == 3) error_exit("xpidfile %s", name);
802 
803   xwrite(fd, spid, sprintf(spid, "%ld\n", (long)getpid()));
804   close(fd);
805 }
806 
807 // Return bytes copied from in to out. If bytes <0 copy all of in to out.
808 // If consuemd isn't null, amount read saved there (return is written or error)
sendfile_len(int in,int out,long long bytes,long long * consumed)809 long long sendfile_len(int in, int out, long long bytes, long long *consumed)
810 {
811   long long total = 0, len;
812 
813   if (consumed) *consumed = 0;
814   if (in<0) return 0;
815   while (bytes != total) {
816     len = bytes-total;
817     if (bytes<0 || len>sizeof(libbuf)) len = sizeof(libbuf);
818 
819     len = read(in, libbuf, len);
820     if (!len && errno==EAGAIN) continue;
821     if (len<1) break;
822     if (consumed) *consumed += len;
823     if (writeall(out, libbuf, len) != len) return -1;
824     total += len;
825   }
826 
827   return total;
828 }
829 
830 // error_exit if we couldn't copy all bytes
xsendfile_len(int in,int out,long long bytes)831 long long xsendfile_len(int in, int out, long long bytes)
832 {
833   long long len = sendfile_len(in, out, bytes, 0);
834 
835   if (bytes != -1 && bytes != len) {
836     if (out == 1 && len<0) xexit();
837     error_exit("short %s", (len<0) ? "write" : "read");
838   }
839 
840   return len;
841 }
842 
843 // warn and pad with zeroes if we couldn't copy all bytes
xsendfile_pad(int in,int out,long long len)844 void xsendfile_pad(int in, int out, long long len)
845 {
846   len -= xsendfile_len(in, out, len);
847   if (len) {
848     perror_msg("short read");
849     memset(libbuf, 0, sizeof(libbuf));
850     while (len) {
851       int i = len>sizeof(libbuf) ? sizeof(libbuf) : len;
852 
853       xwrite(out, libbuf, i);
854       len -= i;
855     }
856   }
857 }
858 
859 // copy all of in to out
xsendfile(int in,int out)860 long long xsendfile(int in, int out)
861 {
862   return xsendfile_len(in, out, -1);
863 }
864 
xstrtod(char * s)865 double xstrtod(char *s)
866 {
867   char *end;
868   double d;
869 
870   errno = 0;
871   d = strtod(s, &end);
872   if (!errno && *end) errno = E2BIG;
873   if (errno) perror_exit("strtod %s", s);
874 
875   return d;
876 }
877 
878 // parse fractional seconds with optional s/m/h/d suffix
xparsetime(char * arg,long zeroes,long * fraction)879 long xparsetime(char *arg, long zeroes, long *fraction)
880 {
881   long l, fr = 0, mask = 1;
882   char *end;
883 
884   if (*arg != '.' && !isdigit(*arg)) error_exit("Not a number '%s'", arg);
885   l = strtoul(arg, &end, 10);
886   if (*end == '.') {
887     end++;
888     while (zeroes--) {
889       fr *= 10;
890       mask *= 10;
891       if (isdigit(*end)) fr += *end++-'0';
892     }
893     while (isdigit(*end)) end++;
894   }
895 
896   // Parse suffix
897   if (*end) {
898     int ismhd[]={1,60,3600,86400}, i = stridx("smhd", *end);
899 
900     if (i == -1 || *(end+1)) error_exit("Unknown suffix '%s'", end);
901     l *= ismhd[i];
902     fr *= ismhd[i];
903     l += fr/mask;
904     fr %= mask;
905   }
906   if (fraction) *fraction = fr;
907 
908   return l;
909 }
910 
xparsemillitime(char * arg)911 long long xparsemillitime(char *arg)
912 {
913   long l, ll;
914 
915   l = xparsetime(arg, 3, &ll);
916 
917   return (l*1000LL)+ll;
918 }
919 
xparsetimespec(char * arg,struct timespec * ts)920 void xparsetimespec(char *arg, struct timespec *ts)
921 {
922   ts->tv_sec = xparsetime(arg, 9, &ts->tv_nsec);
923 }
924 
925 
926 // Compile a regular expression into a regex_t
xregcomp(regex_t * preg,char * regex,int cflags)927 void xregcomp(regex_t *preg, char *regex, int cflags)
928 {
929   int rc;
930 
931   // BSD regex implementations don't support the empty regex (which isn't
932   // allowed in the POSIX grammar), but glibc does. Fake it for BSD.
933   if (!*regex) {
934     regex = "()";
935     cflags |= REG_EXTENDED;
936   }
937 
938   if ((rc = regcomp(preg, regex, cflags))) {
939     regerror(rc, preg, libbuf, sizeof(libbuf));
940     error_exit("bad regex: %s", libbuf);
941   }
942 }
943 
xtzset(char * new)944 char *xtzset(char *new)
945 {
946   char *old = getenv("TZ");
947 
948   if (old) old = xstrdup(old);
949   if (new ? setenv("TZ", new, 1) : unsetenv("TZ")) perror_exit("setenv");
950   tzset();
951 
952   return old;
953 }
954 
955 // Set a signal handler
xsignal_flags(int signal,void * handler,int flags)956 void xsignal_flags(int signal, void *handler, int flags)
957 {
958   struct sigaction *sa = (void *)libbuf;
959 
960   memset(sa, 0, sizeof(struct sigaction));
961   sa->sa_handler = handler;
962   sa->sa_flags = flags;
963 
964   if (sigaction(signal, sa, 0)) perror_exit("xsignal %d", signal);
965 }
966 
xsignal(int signal,void * handler)967 void xsignal(int signal, void *handler)
968 {
969   xsignal_flags(signal, handler, 0);
970 }
971 
972 
xvali_date(struct tm * tm,char * str)973 time_t xvali_date(struct tm *tm, char *str)
974 {
975   time_t t;
976 
977   if (tm && (unsigned)tm->tm_sec<=60 && (unsigned)tm->tm_min<=59
978      && (unsigned)tm->tm_hour<=23 && tm->tm_mday && (unsigned)tm->tm_mday<=31
979      && (unsigned)tm->tm_mon<=11 && (t = mktime(tm)) != -1) return t;
980 
981   error_exit("bad date %s", str);
982 }
983 
984 // Parse date string (relative to current *t). Sets time_t and nanoseconds.
xparsedate(char * str,time_t * t,unsigned * nano,int endian)985 void xparsedate(char *str, time_t *t, unsigned *nano, int endian)
986 {
987   struct tm tm;
988   time_t now = *t;
989   int len = 0, i = 0;
990   // Formats with seconds come first. Posix can't agree on whether 12 digits
991   // has year before (touch -t) or year after (date), so support both.
992   char *s = str, *p, *oldtz = 0, *formats[] = {"%Y-%m-%d %T", "%Y-%m-%dT%T",
993     "%H:%M:%S", "%Y-%m-%d %H:%M", "%Y-%m-%d", "%H:%M", "%m%d%H%M",
994     endian ? "%m%d%H%M%y" : "%y%m%d%H%M",
995     endian ? "%m%d%H%M%C%y" : "%C%y%m%d%H%M"};
996 
997   *nano = 0;
998 
999   // Parse @UNIXTIME[.FRACTION]
1000   if (*str == '@') {
1001     long long ll;
1002 
1003     // Collect seconds and nanoseconds.
1004     // &ll is not just t because we can't guarantee time_t is 64 bit (yet).
1005     sscanf(s, "@%lld%n", &ll, &len);
1006     if (s[len]=='.') {
1007       s += len+1;
1008       for (len = 0; len<9; len++) {
1009         *nano *= 10;
1010         if (isdigit(*s)) *nano += *s++-'0';
1011       }
1012     }
1013     *t = ll;
1014     if (!s[len]) return;
1015     xvali_date(0, str);
1016   }
1017 
1018   // Trailing Z means UTC timezone, don't expect libc to know this.
1019   // (Trimming it off here means it won't show up in error messages.)
1020   if ((i = strlen(str)) && toupper(str[i-1])=='Z') {
1021     str[--i] = 0;
1022     oldtz = getenv("TZ");
1023     if (oldtz) oldtz = xstrdup(oldtz);
1024     setenv("TZ", "UTC0", 1);
1025   }
1026 
1027   // Try each format
1028   for (i = 0; i<ARRAY_LEN(formats); i++) {
1029     localtime_r(&now, &tm);
1030     tm.tm_hour = tm.tm_min = tm.tm_sec = 0;
1031     tm.tm_isdst = -endian;
1032 
1033     if ((p = strptime(s, formats[i], &tm))) {
1034       if (*p == '.') {
1035         p++;
1036         // If format didn't already specify seconds, grab seconds
1037         if (i>2) {
1038           len = 0;
1039           sscanf(p, "%2u%n", &tm.tm_sec, &len);
1040           p += len;
1041         }
1042         // nanoseconds
1043         for (len = 0; len<9; len++) {
1044           *nano *= 10;
1045           if (isdigit(*p)) *nano += *p++-'0';
1046         }
1047       }
1048 
1049       if (!*p) break;
1050     }
1051   }
1052 
1053   // Sanity check field ranges
1054   *t = xvali_date((i!=ARRAY_LEN(formats)) ? &tm : 0, str);
1055 
1056   if (oldtz) setenv("TZ", oldtz, 1);
1057   free(oldtz);
1058 }
1059 
xgetline(FILE * fp,int * len)1060 char *xgetline(FILE *fp, int *len)
1061 {
1062   char *new = 0;
1063   size_t linelen = 0;
1064 
1065   errno = 0;
1066   if (1>(linelen = getline(&new, &linelen, fp))) {
1067     if (errno) perror_msg("getline");
1068     new = 0;
1069   } else if (new[linelen-1] == '\n') new[--linelen] = 0;
1070   if (len) *len = linelen;
1071 
1072   return new;
1073 }
1074