93f325c6236a4f703a34b736f453f503320fc5f1
[oweals/busybox.git] / libbb / xfuncs_printf.c
1 /* vi: set sw=4 ts=4: */
2 /*
3  * Utility routines.
4  *
5  * Copyright (C) 1999-2004 by Erik Andersen <andersen@codepoet.org>
6  * Copyright (C) 2006 Rob Landley
7  * Copyright (C) 2006 Denys Vlasenko
8  *
9  * Licensed under GPLv2, see file LICENSE in this source tree.
10  */
11 /* We need to have separate xfuncs.c and xfuncs_printf.c because
12  * with current linkers, even with section garbage collection,
13  * if *.o module references any of XXXprintf functions, you pull in
14  * entire printf machinery. Even if you do not use the function
15  * which uses XXXprintf.
16  *
17  * xfuncs.c contains functions (not necessarily xfuncs)
18  * which do not pull in printf, directly or indirectly.
19  * xfunc_printf.c contains those which do.
20  */
21 #include "libbb.h"
22
23
24 /* All the functions starting with "x" call bb_error_msg_and_die() if they
25  * fail, so callers never need to check for errors.  If it returned, it
26  * succeeded. */
27
28 void FAST_FUNC bb_die_memory_exhausted(void)
29 {
30         bb_simple_error_msg_and_die(bb_msg_memory_exhausted);
31 }
32
33 #ifndef DMALLOC
34 /* dmalloc provides variants of these that do abort() on failure.
35  * Since dmalloc's prototypes overwrite the impls here as they are
36  * included after these prototypes in libbb.h, all is well.
37  */
38 // Warn if we can't allocate size bytes of memory.
39 void* FAST_FUNC malloc_or_warn(size_t size)
40 {
41         void *ptr = malloc(size);
42         if (ptr == NULL && size != 0)
43                 bb_simple_error_msg(bb_msg_memory_exhausted);
44         return ptr;
45 }
46
47 // Die if we can't allocate size bytes of memory.
48 void* FAST_FUNC xmalloc(size_t size)
49 {
50         void *ptr = malloc(size);
51         if (ptr == NULL && size != 0)
52                 bb_die_memory_exhausted();
53         return ptr;
54 }
55
56 // Die if we can't resize previously allocated memory.  (This returns a pointer
57 // to the new memory, which may or may not be the same as the old memory.
58 // It'll copy the contents to a new chunk and free the old one if necessary.)
59 void* FAST_FUNC xrealloc(void *ptr, size_t size)
60 {
61         ptr = realloc(ptr, size);
62         if (ptr == NULL && size != 0)
63                 bb_die_memory_exhausted();
64         return ptr;
65 }
66 #endif /* DMALLOC */
67
68 // Die if we can't allocate and zero size bytes of memory.
69 void* FAST_FUNC xzalloc(size_t size)
70 {
71         void *ptr = xmalloc(size);
72         memset(ptr, 0, size);
73         return ptr;
74 }
75
76 // Die if we can't copy a string to freshly allocated memory.
77 char* FAST_FUNC xstrdup(const char *s)
78 {
79         char *t;
80
81         if (s == NULL)
82                 return NULL;
83
84         t = strdup(s);
85
86         if (t == NULL)
87                 bb_die_memory_exhausted();
88
89         return t;
90 }
91
92 // Die if we can't allocate n+1 bytes (space for the null terminator) and copy
93 // the (possibly truncated to length n) string into it.
94 char* FAST_FUNC xstrndup(const char *s, int n)
95 {
96         int m;
97         char *t;
98
99         if (ENABLE_DEBUG && s == NULL)
100                 bb_simple_error_msg_and_die("xstrndup bug");
101
102         /* We can just xmalloc(n+1) and strncpy into it, */
103         /* but think about xstrndup("abc", 10000) wastage! */
104         m = n;
105         t = (char*) s;
106         while (m) {
107                 if (!*t) break;
108                 m--;
109                 t++;
110         }
111         n -= m;
112         t = xmalloc(n + 1);
113         t[n] = '\0';
114
115         return memcpy(t, s, n);
116 }
117
118 void* FAST_FUNC xmemdup(const void *s, int n)
119 {
120         return memcpy(xmalloc(n), s, n);
121 }
122
123 // Die if we can't open a file and return a FILE* to it.
124 // Notice we haven't got xfread(), This is for use with fscanf() and friends.
125 FILE* FAST_FUNC xfopen(const char *path, const char *mode)
126 {
127         FILE *fp = fopen(path, mode);
128         if (fp == NULL)
129                 bb_perror_msg_and_die("can't open '%s'", path);
130         return fp;
131 }
132
133 // Die if we can't open a file and return a fd.
134 int FAST_FUNC xopen3(const char *pathname, int flags, int mode)
135 {
136         int ret;
137
138         ret = open(pathname, flags, mode);
139         if (ret < 0) {
140                 bb_perror_msg_and_die("can't open '%s'", pathname);
141         }
142         return ret;
143 }
144
145 // Die if we can't open a file and return a fd.
146 int FAST_FUNC xopen(const char *pathname, int flags)
147 {
148         return xopen3(pathname, flags, 0666);
149 }
150
151 // Warn if we can't open a file and return a fd.
152 int FAST_FUNC open3_or_warn(const char *pathname, int flags, int mode)
153 {
154         int ret;
155
156         ret = open(pathname, flags, mode);
157         if (ret < 0) {
158                 bb_perror_msg("can't open '%s'", pathname);
159         }
160         return ret;
161 }
162
163 // Warn if we can't open a file and return a fd.
164 int FAST_FUNC open_or_warn(const char *pathname, int flags)
165 {
166         return open3_or_warn(pathname, flags, 0666);
167 }
168
169 /* Die if we can't open an existing file readonly with O_NONBLOCK
170  * and return the fd.
171  * Note that for ioctl O_RDONLY is sufficient.
172  */
173 int FAST_FUNC xopen_nonblocking(const char *pathname)
174 {
175         return xopen(pathname, O_RDONLY | O_NONBLOCK);
176 }
177
178 int FAST_FUNC xopen_as_uid_gid(const char *pathname, int flags, uid_t u, gid_t g)
179 {
180         int fd;
181         uid_t old_euid = geteuid();
182         gid_t old_egid = getegid();
183
184         xsetegid(g);
185         xseteuid(u);
186
187         fd = xopen(pathname, flags);
188
189         xseteuid(old_euid);
190         xsetegid(old_egid);
191
192         return fd;
193 }
194
195 void FAST_FUNC xunlink(const char *pathname)
196 {
197         if (unlink(pathname))
198                 bb_perror_msg_and_die("can't remove file '%s'", pathname);
199 }
200
201 void FAST_FUNC xrename(const char *oldpath, const char *newpath)
202 {
203         if (rename(oldpath, newpath))
204                 bb_perror_msg_and_die("can't move '%s' to '%s'", oldpath, newpath);
205 }
206
207 int FAST_FUNC rename_or_warn(const char *oldpath, const char *newpath)
208 {
209         int n = rename(oldpath, newpath);
210         if (n)
211                 bb_perror_msg("can't move '%s' to '%s'", oldpath, newpath);
212         return n;
213 }
214
215 void FAST_FUNC xpipe(int filedes[2])
216 {
217         if (pipe(filedes))
218                 bb_simple_perror_msg_and_die("can't create pipe");
219 }
220
221 void FAST_FUNC xdup2(int from, int to)
222 {
223         if (dup2(from, to) != to)
224                 bb_simple_perror_msg_and_die("can't duplicate file descriptor");
225                 //              " %d to %d", from, to);
226 }
227
228 // "Renumber" opened fd
229 void FAST_FUNC xmove_fd(int from, int to)
230 {
231         if (from == to)
232                 return;
233         xdup2(from, to);
234         close(from);
235 }
236
237 // Die with an error message if we can't write the entire buffer.
238 void FAST_FUNC xwrite(int fd, const void *buf, size_t count)
239 {
240         if (count) {
241                 ssize_t size = full_write(fd, buf, count);
242                 if ((size_t)size != count) {
243                         /*
244                          * Two cases: write error immediately;
245                          * or some writes succeeded, then we hit an error.
246                          * In either case, errno is set.
247                          */
248                         bb_simple_perror_msg_and_die(
249                                 size >= 0 ? "short write" : "write error"
250                         );
251                 }
252         }
253 }
254 void FAST_FUNC xwrite_str(int fd, const char *str)
255 {
256         xwrite(fd, str, strlen(str));
257 }
258
259 void FAST_FUNC xclose(int fd)
260 {
261         if (close(fd))
262                 bb_simple_perror_msg_and_die("close failed");
263 }
264
265 // Die with an error message if we can't lseek to the right spot.
266 off_t FAST_FUNC xlseek(int fd, off_t offset, int whence)
267 {
268         off_t off = lseek(fd, offset, whence);
269         if (off == (off_t)-1) {
270                 bb_perror_msg_and_die("lseek(%"OFF_FMT"u, %d)", offset, whence);
271         }
272         return off;
273 }
274
275 int FAST_FUNC xmkstemp(char *template)
276 {
277         int fd = mkstemp(template);
278         if (fd < 0)
279                 bb_perror_msg_and_die("can't create temp file '%s'", template);
280         return fd;
281 }
282
283 // Die with supplied filename if this FILE* has ferror set.
284 void FAST_FUNC die_if_ferror(FILE *fp, const char *fn)
285 {
286         if (ferror(fp)) {
287                 /* ferror doesn't set useful errno */
288                 bb_error_msg_and_die("%s: I/O error", fn);
289         }
290 }
291
292 // Die with an error message if stdout has ferror set.
293 void FAST_FUNC die_if_ferror_stdout(void)
294 {
295         die_if_ferror(stdout, bb_msg_standard_output);
296 }
297
298 int FAST_FUNC fflush_all(void)
299 {
300         return fflush(NULL);
301 }
302
303
304 int FAST_FUNC bb_putchar(int ch)
305 {
306         return putchar(ch);
307 }
308
309 /* Die with an error message if we can't copy an entire FILE* to stdout,
310  * then close that file. */
311 void FAST_FUNC xprint_and_close_file(FILE *file)
312 {
313         fflush_all();
314         // copyfd outputs error messages for us.
315         if (bb_copyfd_eof(fileno(file), STDOUT_FILENO) == -1)
316                 xfunc_die();
317
318         fclose(file);
319 }
320
321 // Die with an error message if we can't malloc() enough space and do an
322 // sprintf() into that space.
323 char* FAST_FUNC xasprintf(const char *format, ...)
324 {
325         va_list p;
326         int r;
327         char *string_ptr;
328
329         va_start(p, format);
330         r = vasprintf(&string_ptr, format, p);
331         va_end(p);
332
333         if (r < 0)
334                 bb_die_memory_exhausted();
335         return string_ptr;
336 }
337
338 void FAST_FUNC xsetenv(const char *key, const char *value)
339 {
340         if (setenv(key, value, 1))
341                 bb_die_memory_exhausted();
342 }
343
344 /* Handles "VAR=VAL" strings, even those which are part of environ
345  * _right now_
346  */
347 void FAST_FUNC bb_unsetenv(const char *var)
348 {
349         char onstack[128 - 16]; /* smaller stack setup code on x86 */
350         char *tp;
351
352         tp = strchr(var, '=');
353         if (tp) {
354                 /* In case var was putenv'ed, we can't replace '='
355                  * with NUL and unsetenv(var) - it won't work,
356                  * env is modified by the replacement, unsetenv
357                  * sees "VAR" instead of "VAR=VAL" and does not remove it!
358                  * Horror :(
359                  */
360                 unsigned sz = tp - var;
361                 if (sz < sizeof(onstack)) {
362                         ((char*)mempcpy(onstack, var, sz))[0] = '\0';
363                         tp = NULL;
364                         var = onstack;
365                 } else {
366                         /* unlikely: very long var name */
367                         var = tp = xstrndup(var, sz);
368                 }
369         }
370         unsetenv(var);
371         free(tp);
372 }
373
374 void FAST_FUNC bb_unsetenv_and_free(char *var)
375 {
376         bb_unsetenv(var);
377         free(var);
378 }
379
380 // Die with an error message if we can't set gid.  (Because resource limits may
381 // limit this user to a given number of processes, and if that fills up the
382 // setgid() will fail and we'll _still_be_root_, which is bad.)
383 void FAST_FUNC xsetgid(gid_t gid)
384 {
385         if (setgid(gid)) bb_simple_perror_msg_and_die("setgid");
386 }
387
388 // Die with an error message if we can't set uid.  (See xsetgid() for why.)
389 void FAST_FUNC xsetuid(uid_t uid)
390 {
391         if (setuid(uid)) bb_simple_perror_msg_and_die("setuid");
392 }
393
394 void FAST_FUNC xsetegid(gid_t egid)
395 {
396         if (setegid(egid)) bb_simple_perror_msg_and_die("setegid");
397 }
398
399 void FAST_FUNC xseteuid(uid_t euid)
400 {
401         if (seteuid(euid)) bb_simple_perror_msg_and_die("seteuid");
402 }
403
404 // Die if we can't chdir to a new path.
405 void FAST_FUNC xchdir(const char *path)
406 {
407         if (chdir(path))
408                 bb_perror_msg_and_die("can't change directory to '%s'", path);
409 }
410
411 void FAST_FUNC xfchdir(int fd)
412 {
413         if (fchdir(fd))
414                 bb_simple_perror_msg_and_die("fchdir");
415 }
416
417 void FAST_FUNC xchroot(const char *path)
418 {
419         if (chroot(path))
420                 bb_perror_msg_and_die("can't change root directory to '%s'", path);
421         xchdir("/");
422 }
423
424 // Print a warning message if opendir() fails, but don't die.
425 DIR* FAST_FUNC warn_opendir(const char *path)
426 {
427         DIR *dp;
428
429         dp = opendir(path);
430         if (!dp)
431                 bb_perror_msg("can't open '%s'", path);
432         return dp;
433 }
434
435 // Die with an error message if opendir() fails.
436 DIR* FAST_FUNC xopendir(const char *path)
437 {
438         DIR *dp;
439
440         dp = opendir(path);
441         if (!dp)
442                 bb_perror_msg_and_die("can't open '%s'", path);
443         return dp;
444 }
445
446 // Die with an error message if we can't open a new socket.
447 int FAST_FUNC xsocket(int domain, int type, int protocol)
448 {
449         int r = socket(domain, type, protocol);
450
451         if (r < 0) {
452                 /* Hijack vaguely related config option */
453 #if ENABLE_VERBOSE_RESOLUTION_ERRORS
454                 const char *s = "INET";
455 # ifdef AF_PACKET
456                 if (domain == AF_PACKET) s = "PACKET";
457 # endif
458 # ifdef AF_NETLINK
459                 if (domain == AF_NETLINK) s = "NETLINK";
460 # endif
461 IF_FEATURE_IPV6(if (domain == AF_INET6) s = "INET6";)
462                 bb_perror_msg_and_die("socket(AF_%s,%d,%d)", s, type, protocol);
463 #else
464                 bb_simple_perror_msg_and_die("socket");
465 #endif
466         }
467
468         return r;
469 }
470
471 // Die with an error message if we can't bind a socket to an address.
472 void FAST_FUNC xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen)
473 {
474         if (bind(sockfd, my_addr, addrlen)) bb_simple_perror_msg_and_die("bind");
475 }
476
477 // Die with an error message if we can't listen for connections on a socket.
478 void FAST_FUNC xlisten(int s, int backlog)
479 {
480         if (listen(s, backlog)) bb_simple_perror_msg_and_die("listen");
481 }
482
483 /* Die with an error message if sendto failed.
484  * Return bytes sent otherwise  */
485 ssize_t FAST_FUNC xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
486                                 socklen_t tolen)
487 {
488         ssize_t ret = sendto(s, buf, len, 0, to, tolen);
489         if (ret < 0) {
490                 if (ENABLE_FEATURE_CLEAN_UP)
491                         close(s);
492                 bb_simple_perror_msg_and_die("sendto");
493         }
494         return ret;
495 }
496
497 // xstat() - a stat() which dies on failure with meaningful error message
498 void FAST_FUNC xstat(const char *name, struct stat *stat_buf)
499 {
500         if (stat(name, stat_buf))
501                 bb_perror_msg_and_die("can't stat '%s'", name);
502 }
503
504 void FAST_FUNC xfstat(int fd, struct stat *stat_buf, const char *errmsg)
505 {
506         /* errmsg is usually a file name, but not always:
507          * xfstat may be called in a spot where file name is no longer
508          * available, and caller may give e.g. "can't stat input file" string.
509          */
510         if (fstat(fd, stat_buf))
511                 bb_simple_perror_msg_and_die(errmsg);
512 }
513
514 // selinux_or_die() - die if SELinux is disabled.
515 void FAST_FUNC selinux_or_die(void)
516 {
517 #if ENABLE_SELINUX
518         int rc = is_selinux_enabled();
519         if (rc == 0) {
520                 bb_simple_error_msg_and_die("SELinux is disabled");
521         } else if (rc < 0) {
522                 bb_simple_error_msg_and_die("is_selinux_enabled() failed");
523         }
524 #else
525         bb_simple_error_msg_and_die("SELinux support is disabled");
526 #endif
527 }
528
529 int FAST_FUNC ioctl_or_perror_and_die(int fd, unsigned request, void *argp, const char *fmt,...)
530 {
531         int ret;
532         va_list p;
533
534         ret = ioctl(fd, request, argp);
535         if (ret < 0) {
536                 va_start(p, fmt);
537                 bb_verror_msg(fmt, p, strerror(errno));
538                 /* xfunc_die can actually longjmp, so be nice */
539                 va_end(p);
540                 xfunc_die();
541         }
542         return ret;
543 }
544
545 int FAST_FUNC ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...)
546 {
547         va_list p;
548         int ret = ioctl(fd, request, argp);
549
550         if (ret < 0) {
551                 va_start(p, fmt);
552                 bb_verror_msg(fmt, p, strerror(errno));
553                 va_end(p);
554         }
555         return ret;
556 }
557
558 #if ENABLE_IOCTL_HEX2STR_ERROR
559 int FAST_FUNC bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name)
560 {
561         int ret;
562
563         ret = ioctl(fd, request, argp);
564         if (ret < 0)
565                 bb_simple_perror_msg(ioctl_name);
566         return ret;
567 }
568 int FAST_FUNC bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name)
569 {
570         int ret;
571
572         ret = ioctl(fd, request, argp);
573         if (ret < 0)
574                 bb_simple_perror_msg_and_die(ioctl_name);
575         return ret;
576 }
577 #else
578 int FAST_FUNC bb_ioctl_or_warn(int fd, unsigned request, void *argp)
579 {
580         int ret;
581
582         ret = ioctl(fd, request, argp);
583         if (ret < 0)
584                 bb_perror_msg("ioctl %#x failed", request);
585         return ret;
586 }
587 int FAST_FUNC bb_xioctl(int fd, unsigned request, void *argp)
588 {
589         int ret;
590
591         ret = ioctl(fd, request, argp);
592         if (ret < 0)
593                 bb_perror_msg_and_die("ioctl %#x failed", request);
594         return ret;
595 }
596 #endif
597
598 char* FAST_FUNC xmalloc_ttyname(int fd)
599 {
600         char buf[128];
601         int r = ttyname_r(fd, buf, sizeof(buf) - 1);
602         if (r)
603                 return NULL;
604         return xstrdup(buf);
605 }
606
607 void FAST_FUNC generate_uuid(uint8_t *buf)
608 {
609         /* http://www.ietf.org/rfc/rfc4122.txt
610          *  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
611          * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
612          * |                          time_low                             |
613          * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
614          * |       time_mid                |         time_hi_and_version   |
615          * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
616          * |clk_seq_and_variant            |         node (0-1)            |
617          * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
618          * |                         node (2-5)                            |
619          * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
620          * IOW, uuid has this layout:
621          * uint32_t time_low (big endian)
622          * uint16_t time_mid (big endian)
623          * uint16_t time_hi_and_version (big endian)
624          *  version is a 4-bit field:
625          *   1 Time-based
626          *   2 DCE Security, with embedded POSIX UIDs
627          *   3 Name-based (MD5)
628          *   4 Randomly generated
629          *   5 Name-based (SHA-1)
630          * uint16_t clk_seq_and_variant (big endian)
631          *  variant is a 3-bit field:
632          *   0xx Reserved, NCS backward compatibility
633          *   10x The variant specified in rfc4122
634          *   110 Reserved, Microsoft backward compatibility
635          *   111 Reserved for future definition
636          * uint8_t node[6]
637          *
638          * For version 4, these bits are set/cleared:
639          * time_hi_and_version & 0x0fff | 0x4000
640          * clk_seq_and_variant & 0x3fff | 0x8000
641          */
642         pid_t pid;
643         int i;
644
645         i = open("/dev/urandom", O_RDONLY);
646         if (i >= 0) {
647                 read(i, buf, 16);
648                 close(i);
649         }
650         /* Paranoia. /dev/urandom may be missing.
651          * rand() is guaranteed to generate at least [0, 2^15) range,
652          * but lowest bits in some libc are not so "random".  */
653         srand(monotonic_us()); /* pulls in printf */
654         pid = getpid();
655         while (1) {
656                 for (i = 0; i < 16; i++)
657                         buf[i] ^= rand() >> 5;
658                 if (pid == 0)
659                         break;
660                 srand(pid);
661                 pid = 0;
662         }
663
664         /* version = 4 */
665         buf[4 + 2    ] = (buf[4 + 2    ] & 0x0f) | 0x40;
666         /* variant = 10x */
667         buf[4 + 2 + 2] = (buf[4 + 2 + 2] & 0x3f) | 0x80;
668 }
669
670 #if BB_MMU
671 pid_t FAST_FUNC xfork(void)
672 {
673         pid_t pid;
674         pid = fork();
675         if (pid < 0) /* wtf? */
676                 bb_simple_perror_msg_and_die("vfork"+1);
677         return pid;
678 }
679 #endif
680
681 void FAST_FUNC xvfork_parent_waits_and_exits(void)
682 {
683         pid_t pid;
684
685         fflush_all();
686         pid = xvfork();
687         if (pid > 0) {
688                 /* Parent */
689                 int exit_status = wait_for_exitstatus(pid);
690                 if (WIFSIGNALED(exit_status))
691                         kill_myself_with_sig(WTERMSIG(exit_status));
692                 _exit(WEXITSTATUS(exit_status));
693         }
694         /* Child continues */
695 }