libbb: new function bb_die_memory_exhausted
[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_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_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_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_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_perror_msg_and_die("can't duplicate file descriptor");
225 }
226
227 // "Renumber" opened fd
228 void FAST_FUNC xmove_fd(int from, int to)
229 {
230         if (from == to)
231                 return;
232         xdup2(from, to);
233         close(from);
234 }
235
236 // Die with an error message if we can't write the entire buffer.
237 void FAST_FUNC xwrite(int fd, const void *buf, size_t count)
238 {
239         if (count) {
240                 ssize_t size = full_write(fd, buf, count);
241                 if ((size_t)size != count) {
242                         /*
243                          * Two cases: write error immediately;
244                          * or some writes succeeded, then we hit an error.
245                          * In either case, errno is set.
246                          */
247                         bb_perror_msg_and_die(
248                                 size >= 0 ? "short write" : "write error"
249                         );
250                 }
251         }
252 }
253 void FAST_FUNC xwrite_str(int fd, const char *str)
254 {
255         xwrite(fd, str, strlen(str));
256 }
257
258 void FAST_FUNC xclose(int fd)
259 {
260         if (close(fd))
261                 bb_perror_msg_and_die("close failed");
262 }
263
264 // Die with an error message if we can't lseek to the right spot.
265 off_t FAST_FUNC xlseek(int fd, off_t offset, int whence)
266 {
267         off_t off = lseek(fd, offset, whence);
268         if (off == (off_t)-1) {
269                 if (whence == SEEK_SET)
270                         bb_perror_msg_and_die("lseek(%"OFF_FMT"u)", offset);
271                 bb_perror_msg_and_die("lseek");
272         }
273         return off;
274 }
275
276 int FAST_FUNC xmkstemp(char *template)
277 {
278         int fd = mkstemp(template);
279         if (fd < 0)
280                 bb_perror_msg_and_die("can't create temp file '%s'", template);
281         return fd;
282 }
283
284 // Die with supplied filename if this FILE* has ferror set.
285 void FAST_FUNC die_if_ferror(FILE *fp, const char *fn)
286 {
287         if (ferror(fp)) {
288                 /* ferror doesn't set useful errno */
289                 bb_error_msg_and_die("%s: I/O error", fn);
290         }
291 }
292
293 // Die with an error message if stdout has ferror set.
294 void FAST_FUNC die_if_ferror_stdout(void)
295 {
296         die_if_ferror(stdout, bb_msg_standard_output);
297 }
298
299 int FAST_FUNC fflush_all(void)
300 {
301         return fflush(NULL);
302 }
303
304
305 int FAST_FUNC bb_putchar(int ch)
306 {
307         return putchar(ch);
308 }
309
310 /* Die with an error message if we can't copy an entire FILE* to stdout,
311  * then close that file. */
312 void FAST_FUNC xprint_and_close_file(FILE *file)
313 {
314         fflush_all();
315         // copyfd outputs error messages for us.
316         if (bb_copyfd_eof(fileno(file), STDOUT_FILENO) == -1)
317                 xfunc_die();
318
319         fclose(file);
320 }
321
322 // Die with an error message if we can't malloc() enough space and do an
323 // sprintf() into that space.
324 char* FAST_FUNC xasprintf(const char *format, ...)
325 {
326         va_list p;
327         int r;
328         char *string_ptr;
329
330         va_start(p, format);
331         r = vasprintf(&string_ptr, format, p);
332         va_end(p);
333
334         if (r < 0)
335                 bb_die_memory_exhausted();
336         return string_ptr;
337 }
338
339 void FAST_FUNC xsetenv(const char *key, const char *value)
340 {
341         if (setenv(key, value, 1))
342                 bb_die_memory_exhausted();
343 }
344
345 /* Handles "VAR=VAL" strings, even those which are part of environ
346  * _right now_
347  */
348 void FAST_FUNC bb_unsetenv(const char *var)
349 {
350         char onstack[128 - 16]; /* smaller stack setup code on x86 */
351         char *tp;
352
353         tp = strchr(var, '=');
354         if (tp) {
355                 /* In case var was putenv'ed, we can't replace '='
356                  * with NUL and unsetenv(var) - it won't work,
357                  * env is modified by the replacement, unsetenv
358                  * sees "VAR" instead of "VAR=VAL" and does not remove it!
359                  * Horror :(
360                  */
361                 unsigned sz = tp - var;
362                 if (sz < sizeof(onstack)) {
363                         ((char*)mempcpy(onstack, var, sz))[0] = '\0';
364                         tp = NULL;
365                         var = onstack;
366                 } else {
367                         /* unlikely: very long var name */
368                         var = tp = xstrndup(var, sz);
369                 }
370         }
371         unsetenv(var);
372         free(tp);
373 }
374
375 void FAST_FUNC bb_unsetenv_and_free(char *var)
376 {
377         bb_unsetenv(var);
378         free(var);
379 }
380
381 // Die with an error message if we can't set gid.  (Because resource limits may
382 // limit this user to a given number of processes, and if that fills up the
383 // setgid() will fail and we'll _still_be_root_, which is bad.)
384 void FAST_FUNC xsetgid(gid_t gid)
385 {
386         if (setgid(gid)) bb_perror_msg_and_die("setgid");
387 }
388
389 // Die with an error message if we can't set uid.  (See xsetgid() for why.)
390 void FAST_FUNC xsetuid(uid_t uid)
391 {
392         if (setuid(uid)) bb_perror_msg_and_die("setuid");
393 }
394
395 void FAST_FUNC xsetegid(gid_t egid)
396 {
397         if (setegid(egid)) bb_perror_msg_and_die("setegid");
398 }
399
400 void FAST_FUNC xseteuid(uid_t euid)
401 {
402         if (seteuid(euid)) bb_perror_msg_and_die("seteuid");
403 }
404
405 // Die if we can't chdir to a new path.
406 void FAST_FUNC xchdir(const char *path)
407 {
408         if (chdir(path))
409                 bb_perror_msg_and_die("can't change directory to '%s'", path);
410 }
411
412 void FAST_FUNC xfchdir(int fd)
413 {
414         if (fchdir(fd))
415                 bb_perror_msg_and_die("fchdir");
416 }
417
418 void FAST_FUNC xchroot(const char *path)
419 {
420         if (chroot(path))
421                 bb_perror_msg_and_die("can't change root directory to '%s'", path);
422         xchdir("/");
423 }
424
425 // Print a warning message if opendir() fails, but don't die.
426 DIR* FAST_FUNC warn_opendir(const char *path)
427 {
428         DIR *dp;
429
430         dp = opendir(path);
431         if (!dp)
432                 bb_perror_msg("can't open '%s'", path);
433         return dp;
434 }
435
436 // Die with an error message if opendir() fails.
437 DIR* FAST_FUNC xopendir(const char *path)
438 {
439         DIR *dp;
440
441         dp = opendir(path);
442         if (!dp)
443                 bb_perror_msg_and_die("can't open '%s'", path);
444         return dp;
445 }
446
447 // Die with an error message if we can't open a new socket.
448 int FAST_FUNC xsocket(int domain, int type, int protocol)
449 {
450         int r = socket(domain, type, protocol);
451
452         if (r < 0) {
453                 /* Hijack vaguely related config option */
454 #if ENABLE_VERBOSE_RESOLUTION_ERRORS
455                 const char *s = "INET";
456 # ifdef AF_PACKET
457                 if (domain == AF_PACKET) s = "PACKET";
458 # endif
459 # ifdef AF_NETLINK
460                 if (domain == AF_NETLINK) s = "NETLINK";
461 # endif
462 IF_FEATURE_IPV6(if (domain == AF_INET6) s = "INET6";)
463                 bb_perror_msg_and_die("socket(AF_%s,%d,%d)", s, type, protocol);
464 #else
465                 bb_perror_msg_and_die("socket");
466 #endif
467         }
468
469         return r;
470 }
471
472 // Die with an error message if we can't bind a socket to an address.
473 void FAST_FUNC xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen)
474 {
475         if (bind(sockfd, my_addr, addrlen)) bb_perror_msg_and_die("bind");
476 }
477
478 // Die with an error message if we can't listen for connections on a socket.
479 void FAST_FUNC xlisten(int s, int backlog)
480 {
481         if (listen(s, backlog)) bb_perror_msg_and_die("listen");
482 }
483
484 /* Die with an error message if sendto failed.
485  * Return bytes sent otherwise  */
486 ssize_t FAST_FUNC xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
487                                 socklen_t tolen)
488 {
489         ssize_t ret = sendto(s, buf, len, 0, to, tolen);
490         if (ret < 0) {
491                 if (ENABLE_FEATURE_CLEAN_UP)
492                         close(s);
493                 bb_perror_msg_and_die("sendto");
494         }
495         return ret;
496 }
497
498 // xstat() - a stat() which dies on failure with meaningful error message
499 void FAST_FUNC xstat(const char *name, struct stat *stat_buf)
500 {
501         if (stat(name, stat_buf))
502                 bb_perror_msg_and_die("can't stat '%s'", name);
503 }
504
505 void FAST_FUNC xfstat(int fd, struct stat *stat_buf, const char *errmsg)
506 {
507         /* errmsg is usually a file name, but not always:
508          * xfstat may be called in a spot where file name is no longer
509          * available, and caller may give e.g. "can't stat input file" string.
510          */
511         if (fstat(fd, stat_buf))
512                 bb_simple_perror_msg_and_die(errmsg);
513 }
514
515 // selinux_or_die() - die if SELinux is disabled.
516 void FAST_FUNC selinux_or_die(void)
517 {
518 #if ENABLE_SELINUX
519         int rc = is_selinux_enabled();
520         if (rc == 0) {
521                 bb_error_msg_and_die("SELinux is disabled");
522         } else if (rc < 0) {
523                 bb_error_msg_and_die("is_selinux_enabled() failed");
524         }
525 #else
526         bb_error_msg_and_die("SELinux support is disabled");
527 #endif
528 }
529
530 int FAST_FUNC ioctl_or_perror_and_die(int fd, unsigned request, void *argp, const char *fmt,...)
531 {
532         int ret;
533         va_list p;
534
535         ret = ioctl(fd, request, argp);
536         if (ret < 0) {
537                 va_start(p, fmt);
538                 bb_verror_msg(fmt, p, strerror(errno));
539                 /* xfunc_die can actually longjmp, so be nice */
540                 va_end(p);
541                 xfunc_die();
542         }
543         return ret;
544 }
545
546 int FAST_FUNC ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...)
547 {
548         va_list p;
549         int ret = ioctl(fd, request, argp);
550
551         if (ret < 0) {
552                 va_start(p, fmt);
553                 bb_verror_msg(fmt, p, strerror(errno));
554                 va_end(p);
555         }
556         return ret;
557 }
558
559 #if ENABLE_IOCTL_HEX2STR_ERROR
560 int FAST_FUNC bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name)
561 {
562         int ret;
563
564         ret = ioctl(fd, request, argp);
565         if (ret < 0)
566                 bb_simple_perror_msg(ioctl_name);
567         return ret;
568 }
569 int FAST_FUNC bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name)
570 {
571         int ret;
572
573         ret = ioctl(fd, request, argp);
574         if (ret < 0)
575                 bb_simple_perror_msg_and_die(ioctl_name);
576         return ret;
577 }
578 #else
579 int FAST_FUNC bb_ioctl_or_warn(int fd, unsigned request, void *argp)
580 {
581         int ret;
582
583         ret = ioctl(fd, request, argp);
584         if (ret < 0)
585                 bb_perror_msg("ioctl %#x failed", request);
586         return ret;
587 }
588 int FAST_FUNC bb_xioctl(int fd, unsigned request, void *argp)
589 {
590         int ret;
591
592         ret = ioctl(fd, request, argp);
593         if (ret < 0)
594                 bb_perror_msg_and_die("ioctl %#x failed", request);
595         return ret;
596 }
597 #endif
598
599 char* FAST_FUNC xmalloc_ttyname(int fd)
600 {
601         char buf[128];
602         int r = ttyname_r(fd, buf, sizeof(buf) - 1);
603         if (r)
604                 return NULL;
605         return xstrdup(buf);
606 }
607
608 void FAST_FUNC generate_uuid(uint8_t *buf)
609 {
610         /* http://www.ietf.org/rfc/rfc4122.txt
611          *  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
612          * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
613          * |                          time_low                             |
614          * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
615          * |       time_mid                |         time_hi_and_version   |
616          * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
617          * |clk_seq_and_variant            |         node (0-1)            |
618          * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
619          * |                         node (2-5)                            |
620          * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
621          * IOW, uuid has this layout:
622          * uint32_t time_low (big endian)
623          * uint16_t time_mid (big endian)
624          * uint16_t time_hi_and_version (big endian)
625          *  version is a 4-bit field:
626          *   1 Time-based
627          *   2 DCE Security, with embedded POSIX UIDs
628          *   3 Name-based (MD5)
629          *   4 Randomly generated
630          *   5 Name-based (SHA-1)
631          * uint16_t clk_seq_and_variant (big endian)
632          *  variant is a 3-bit field:
633          *   0xx Reserved, NCS backward compatibility
634          *   10x The variant specified in rfc4122
635          *   110 Reserved, Microsoft backward compatibility
636          *   111 Reserved for future definition
637          * uint8_t node[6]
638          *
639          * For version 4, these bits are set/cleared:
640          * time_hi_and_version & 0x0fff | 0x4000
641          * clk_seq_and_variant & 0x3fff | 0x8000
642          */
643         pid_t pid;
644         int i;
645
646         i = open("/dev/urandom", O_RDONLY);
647         if (i >= 0) {
648                 read(i, buf, 16);
649                 close(i);
650         }
651         /* Paranoia. /dev/urandom may be missing.
652          * rand() is guaranteed to generate at least [0, 2^15) range,
653          * but lowest bits in some libc are not so "random".  */
654         srand(monotonic_us()); /* pulls in printf */
655         pid = getpid();
656         while (1) {
657                 for (i = 0; i < 16; i++)
658                         buf[i] ^= rand() >> 5;
659                 if (pid == 0)
660                         break;
661                 srand(pid);
662                 pid = 0;
663         }
664
665         /* version = 4 */
666         buf[4 + 2    ] = (buf[4 + 2    ] & 0x0f) | 0x40;
667         /* variant = 10x */
668         buf[4 + 2 + 2] = (buf[4 + 2 + 2] & 0x3f) | 0x80;
669 }
670
671 #if BB_MMU
672 pid_t FAST_FUNC xfork(void)
673 {
674         pid_t pid;
675         pid = fork();
676         if (pid < 0) /* wtf? */
677                 bb_perror_msg_and_die("vfork"+1);
678         return pid;
679 }
680 #endif
681
682 void FAST_FUNC xvfork_parent_waits_and_exits(void)
683 {
684         pid_t pid;
685
686         fflush_all();
687         pid = xvfork();
688         if (pid > 0) {
689                 /* Parent */
690                 int exit_status = wait_for_exitstatus(pid);
691                 if (WIFSIGNALED(exit_status))
692                         kill_myself_with_sig(WTERMSIG(exit_status));
693                 _exit(WEXITSTATUS(exit_status));
694         }
695         /* Child continues */
696 }