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