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