libbb: introduce bb_signals and bb_signals_recursive,
[platform/upstream/busybox.git] / libbb / xfuncs.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 Denis Vlasenko
8  *
9  * Licensed under GPL version 2, see file LICENSE in this tarball for details.
10  */
11
12 #include "libbb.h"
13
14 /* All the functions starting with "x" call bb_error_msg_and_die() if they
15  * fail, so callers never need to check for errors.  If it returned, it
16  * succeeded. */
17
18 #ifndef DMALLOC
19 /* dmalloc provides variants of these that do abort() on failure.
20  * Since dmalloc's prototypes overwrite the impls here as they are
21  * included after these prototypes in libbb.h, all is well.
22  */
23 // Warn if we can't allocate size bytes of memory.
24 void *malloc_or_warn(size_t size)
25 {
26         void *ptr = malloc(size);
27         if (ptr == NULL && size != 0)
28                 bb_error_msg(bb_msg_memory_exhausted);
29         return ptr;
30 }
31
32 // Die if we can't allocate size bytes of memory.
33 void *xmalloc(size_t size)
34 {
35         void *ptr = malloc(size);
36         if (ptr == NULL && size != 0)
37                 bb_error_msg_and_die(bb_msg_memory_exhausted);
38         return ptr;
39 }
40
41 // Die if we can't resize previously allocated memory.  (This returns a pointer
42 // to the new memory, which may or may not be the same as the old memory.
43 // It'll copy the contents to a new chunk and free the old one if necessary.)
44 void *xrealloc(void *ptr, size_t size)
45 {
46         ptr = realloc(ptr, size);
47         if (ptr == NULL && size != 0)
48                 bb_error_msg_and_die(bb_msg_memory_exhausted);
49         return ptr;
50 }
51 #endif /* DMALLOC */
52
53 // Die if we can't allocate and zero size bytes of memory.
54 void *xzalloc(size_t size)
55 {
56         void *ptr = xmalloc(size);
57         memset(ptr, 0, size);
58         return ptr;
59 }
60
61 // Die if we can't copy a string to freshly allocated memory.
62 char * xstrdup(const char *s)
63 {
64         char *t;
65
66         if (s == NULL)
67                 return NULL;
68
69         t = strdup(s);
70
71         if (t == NULL)
72                 bb_error_msg_and_die(bb_msg_memory_exhausted);
73
74         return t;
75 }
76
77 // Die if we can't allocate n+1 bytes (space for the null terminator) and copy
78 // the (possibly truncated to length n) string into it.
79 char * xstrndup(const char *s, int n)
80 {
81         int m;
82         char *t;
83
84         if (ENABLE_DEBUG && s == NULL)
85                 bb_error_msg_and_die("xstrndup bug");
86
87         /* We can just xmalloc(n+1) and strncpy into it, */
88         /* but think about xstrndup("abc", 10000) wastage! */
89         m = n;
90         t = (char*) s;
91         while (m) {
92                 if (!*t) break;
93                 m--;
94                 t++;
95         }
96         n -= m;
97         t = xmalloc(n + 1);
98         t[n] = '\0';
99
100         return memcpy(t, s, n);
101 }
102
103 // Die if we can't open a file and return a FILE * to it.
104 // Notice we haven't got xfread(), This is for use with fscanf() and friends.
105 FILE *xfopen(const char *path, const char *mode)
106 {
107         FILE *fp = fopen(path, mode);
108         if (fp == NULL)
109                 bb_perror_msg_and_die("can't open '%s'", path);
110         return fp;
111 }
112
113 // Die if we can't open a file and return a fd.
114 int xopen3(const char *pathname, int flags, int mode)
115 {
116         int ret;
117
118         ret = open(pathname, flags, mode);
119         if (ret < 0) {
120                 bb_perror_msg_and_die("can't open '%s'", pathname);
121         }
122         return ret;
123 }
124
125 // Die if we can't open an existing file and return a fd.
126 int xopen(const char *pathname, int flags)
127 {
128         return xopen3(pathname, flags, 0666);
129 }
130
131 // Warn if we can't open a file and return a fd.
132 int open3_or_warn(const char *pathname, int flags, int mode)
133 {
134         int ret;
135
136         ret = open(pathname, flags, mode);
137         if (ret < 0) {
138                 bb_perror_msg("can't open '%s'", pathname);
139         }
140         return ret;
141 }
142
143 // Warn if we can't open a file and return a fd.
144 int open_or_warn(const char *pathname, int flags)
145 {
146         return open3_or_warn(pathname, flags, 0666);
147 }
148
149 void xpipe(int filedes[2])
150 {
151         if (pipe(filedes))
152                 bb_perror_msg_and_die("can't create pipe");
153 }
154
155 void xunlink(const char *pathname)
156 {
157         if (unlink(pathname))
158                 bb_perror_msg_and_die("can't remove file '%s'", pathname);
159 }
160
161 // Turn on nonblocking I/O on a fd
162 int ndelay_on(int fd)
163 {
164         return fcntl(fd, F_SETFL, fcntl(fd,F_GETFL) | O_NONBLOCK);
165 }
166
167 int close_on_exec_on(int fd)
168 {
169         return fcntl(fd, F_SETFD, FD_CLOEXEC);
170 }
171
172 int ndelay_off(int fd)
173 {
174         return fcntl(fd, F_SETFL, fcntl(fd,F_GETFL) & ~O_NONBLOCK);
175 }
176
177 void xdup2(int from, int to)
178 {
179         if (dup2(from, to) != to)
180                 bb_perror_msg_and_die("can't duplicate file descriptor");
181 }
182
183 // "Renumber" opened fd
184 void xmove_fd(int from, int to)
185 {
186         if (from == to)
187                 return;
188         xdup2(from, to);
189         close(from);
190 }
191
192 // Die with an error message if we can't write the entire buffer.
193 void xwrite(int fd, const void *buf, size_t count)
194 {
195         if (count) {
196                 ssize_t size = full_write(fd, buf, count);
197                 if (size != count)
198                         bb_error_msg_and_die("short write");
199         }
200 }
201
202 // Die with an error message if we can't lseek to the right spot.
203 off_t xlseek(int fd, off_t offset, int whence)
204 {
205         off_t off = lseek(fd, offset, whence);
206         if (off == (off_t)-1) {
207                 if (whence == SEEK_SET)
208                         bb_perror_msg_and_die("lseek(%"OFF_FMT"u)", offset);
209                 bb_perror_msg_and_die("lseek");
210         }
211         return off;
212 }
213
214 // Die with supplied filename if this FILE * has ferror set.
215 void die_if_ferror(FILE *fp, const char *fn)
216 {
217         if (ferror(fp)) {
218                 /* ferror doesn't set useful errno */
219                 bb_error_msg_and_die("%s: I/O error", fn);
220         }
221 }
222
223 // Die with an error message if stdout has ferror set.
224 void die_if_ferror_stdout(void)
225 {
226         die_if_ferror(stdout, bb_msg_standard_output);
227 }
228
229 // Die with an error message if we have trouble flushing stdout.
230 void xfflush_stdout(void)
231 {
232         if (fflush(stdout)) {
233                 bb_perror_msg_and_die(bb_msg_standard_output);
234         }
235 }
236
237 void xsetenv(const char *key, const char *value)
238 {
239         if (setenv(key, value, 1))
240                 bb_error_msg_and_die(bb_msg_memory_exhausted);
241 }
242
243 /* Converts unsigned long long value into compact 4-char
244  * representation. Examples: "1234", "1.2k", " 27M", "123T"
245  * String is not terminated (buf[4] is untouched) */
246 void smart_ulltoa4(unsigned long long ul, char buf[5], const char *scale)
247 {
248         const char *fmt;
249         char c;
250         unsigned v, u, idx = 0;
251
252         if (ul > 9999) { // do not scale if 9999 or less
253                 ul *= 10;
254                 do {
255                         ul /= 1024;
256                         idx++;
257                 } while (ul >= 10000);
258         }
259         v = ul; // ullong divisions are expensive, avoid them
260
261         fmt = " 123456789";
262         u = v / 10;
263         v = v % 10;
264         if (!idx) {
265                 // 9999 or less: use "1234" format
266                 // u is value/10, v is last digit
267                 c = buf[0] = " 123456789"[u/100];
268                 if (c != ' ') fmt = "0123456789";
269                 c = buf[1] = fmt[u/10%10];
270                 if (c != ' ') fmt = "0123456789";
271                 buf[2] = fmt[u%10];
272                 buf[3] = "0123456789"[v];
273         } else {
274                 // u is value, v is 1/10ths (allows for 9.2M format)
275                 if (u >= 10) {
276                         // value is >= 10: use "123M', " 12M" formats
277                         c = buf[0] = " 123456789"[u/100];
278                         if (c != ' ') fmt = "0123456789";
279                         v = u % 10;
280                         u = u / 10;
281                         buf[1] = fmt[u%10];
282                 } else {
283                         // value is < 10: use "9.2M" format
284                         buf[0] = "0123456789"[u];
285                         buf[1] = '.';
286                 }
287                 buf[2] = "0123456789"[v];
288                 buf[3] = scale[idx]; /* typically scale = " kmgt..." */
289         }
290 }
291
292 /* Converts unsigned long long value into compact 5-char representation.
293  * String is not terminated (buf[5] is untouched) */
294 void smart_ulltoa5(unsigned long long ul, char buf[6], const char *scale)
295 {
296         const char *fmt;
297         char c;
298         unsigned v, u, idx = 0;
299
300         if (ul > 99999) { // do not scale if 99999 or less
301                 ul *= 10;
302                 do {
303                         ul /= 1024;
304                         idx++;
305                 } while (ul >= 100000);
306         }
307         v = ul; // ullong divisions are expensive, avoid them
308
309         fmt = " 123456789";
310         u = v / 10;
311         v = v % 10;
312         if (!idx) {
313                 // 99999 or less: use "12345" format
314                 // u is value/10, v is last digit
315                 c = buf[0] = " 123456789"[u/1000];
316                 if (c != ' ') fmt = "0123456789";
317                 c = buf[1] = fmt[u/100%10];
318                 if (c != ' ') fmt = "0123456789";
319                 c = buf[2] = fmt[u/10%10];
320                 if (c != ' ') fmt = "0123456789";
321                 buf[3] = fmt[u%10];
322                 buf[4] = "0123456789"[v];
323         } else {
324                 // value has been scaled into 0..9999.9 range
325                 // u is value, v is 1/10ths (allows for 92.1M format)
326                 if (u >= 100) {
327                         // value is >= 100: use "1234M', " 123M" formats
328                         c = buf[0] = " 123456789"[u/1000];
329                         if (c != ' ') fmt = "0123456789";
330                         c = buf[1] = fmt[u/100%10];
331                         if (c != ' ') fmt = "0123456789";
332                         v = u % 10;
333                         u = u / 10;
334                         buf[2] = fmt[u%10];
335                 } else {
336                         // value is < 100: use "92.1M" format
337                         c = buf[0] = " 123456789"[u/10];
338                         if (c != ' ') fmt = "0123456789";
339                         buf[1] = fmt[u%10];
340                         buf[2] = '.';
341                 }
342                 buf[3] = "0123456789"[v];
343                 buf[4] = scale[idx]; /* typically scale = " kmgt..." */
344         }
345 }
346
347
348 // Convert unsigned integer to ascii, writing into supplied buffer.
349 // A truncated result contains the first few digits of the result ala strncpy.
350 // Returns a pointer past last generated digit, does _not_ store NUL.
351 void BUG_sizeof_unsigned_not_4(void);
352 char *utoa_to_buf(unsigned n, char *buf, unsigned buflen)
353 {
354         unsigned i, out, res;
355         if (sizeof(unsigned) != 4)
356                 BUG_sizeof_unsigned_not_4();
357         if (buflen) {
358                 out = 0;
359                 for (i = 1000000000; i; i /= 10) {
360                         res = n / i;
361                         if (res || out || i == 1) {
362                                 if (!--buflen) break;
363                                 out++;
364                                 n -= res*i;
365                                 *buf++ = '0' + res;
366                         }
367                 }
368         }
369         return buf;
370 }
371
372 // Convert signed integer to ascii, like utoa_to_buf()
373 char *itoa_to_buf(int n, char *buf, unsigned buflen)
374 {
375         if (buflen && n<0) {
376                 n = -n;
377                 *buf++ = '-';
378                 buflen--;
379         }
380         return utoa_to_buf((unsigned)n, buf, buflen);
381 }
382
383 // The following two functions use a static buffer, so calling either one a
384 // second time will overwrite previous results.
385 //
386 // The largest 32 bit integer is -2 billion plus null terminator, or 12 bytes.
387 // Int should always be 32 bits on any remotely Unix-like system, see
388 // http://www.unix.org/whitepapers/64bit.html for the reasons why.
389
390 static char local_buf[12];
391
392 // Convert unsigned integer to ascii using a static buffer (returned).
393 char *utoa(unsigned n)
394 {
395         *(utoa_to_buf(n, local_buf, sizeof(local_buf))) = '\0';
396
397         return local_buf;
398 }
399
400 // Convert signed integer to ascii using a static buffer (returned).
401 char *itoa(int n)
402 {
403         *(itoa_to_buf(n, local_buf, sizeof(local_buf))) = '\0';
404
405         return local_buf;
406 }
407
408 // Emit a string of hex representation of bytes
409 char *bin2hex(char *p, const char *cp, int count)
410 {
411         while (count) {
412                 unsigned char c = *cp++;
413                 /* put lowercase hex digits */
414                 *p++ = 0x20 | bb_hexdigits_upcase[c >> 4];
415                 *p++ = 0x20 | bb_hexdigits_upcase[c & 0xf];
416                 count--;
417         }
418         return p;
419 }
420
421 // Die with an error message if we can't set gid.  (Because resource limits may
422 // limit this user to a given number of processes, and if that fills up the
423 // setgid() will fail and we'll _still_be_root_, which is bad.)
424 void xsetgid(gid_t gid)
425 {
426         if (setgid(gid)) bb_perror_msg_and_die("setgid");
427 }
428
429 // Die with an error message if we can't set uid.  (See xsetgid() for why.)
430 void xsetuid(uid_t uid)
431 {
432         if (setuid(uid)) bb_perror_msg_and_die("setuid");
433 }
434
435 // Return how long the file at fd is, if there's any way to determine it.
436 #ifdef UNUSED
437 off_t fdlength(int fd)
438 {
439         off_t bottom = 0, top = 0, pos;
440         long size;
441
442         // If the ioctl works for this, return it.
443
444         if (ioctl(fd, BLKGETSIZE, &size) >= 0) return size*512;
445
446         // FIXME: explain why lseek(SEEK_END) is not used here!
447
448         // If not, do a binary search for the last location we can read.  (Some
449         // block devices don't do BLKGETSIZE right.)
450
451         do {
452                 char temp;
453
454                 pos = bottom + (top - bottom) / 2;
455
456                 // If we can read from the current location, it's bigger.
457
458                 if (lseek(fd, pos, SEEK_SET)>=0 && safe_read(fd, &temp, 1)==1) {
459                         if (bottom == top) bottom = top = (top+1) * 2;
460                         else bottom = pos;
461
462                 // If we can't, it's smaller.
463
464                 } else {
465                         if (bottom == top) {
466                                 if (!top) return 0;
467                                 bottom = top/2;
468                         }
469                         else top = pos;
470                 }
471         } while (bottom + 1 != top);
472
473         return pos + 1;
474 }
475 #endif
476
477 int bb_putchar(int ch)
478 {
479         /* time.c needs putc(ch, stdout), not putchar(ch).
480          * it does "stdout = stderr;", but then glibc's putchar()
481          * doesn't work as expected. bad glibc, bad */
482         return putc(ch, stdout);
483 }
484
485 // Die with an error message if we can't malloc() enough space and do an
486 // sprintf() into that space.
487 char *xasprintf(const char *format, ...)
488 {
489         va_list p;
490         int r;
491         char *string_ptr;
492
493 #if 1
494         // GNU extension
495         va_start(p, format);
496         r = vasprintf(&string_ptr, format, p);
497         va_end(p);
498 #else
499         // Bloat for systems that haven't got the GNU extension.
500         va_start(p, format);
501         r = vsnprintf(NULL, 0, format, p);
502         va_end(p);
503         string_ptr = xmalloc(r+1);
504         va_start(p, format);
505         r = vsnprintf(string_ptr, r+1, format, p);
506         va_end(p);
507 #endif
508
509         if (r < 0)
510                 bb_error_msg_and_die(bb_msg_memory_exhausted);
511         return string_ptr;
512 }
513
514 #if 0 /* If we will ever meet a libc which hasn't [f]dprintf... */
515 int fdprintf(int fd, const char *format, ...)
516 {
517         va_list p;
518         int r;
519         char *string_ptr;
520
521 #if 1
522         // GNU extension
523         va_start(p, format);
524         r = vasprintf(&string_ptr, format, p);
525         va_end(p);
526 #else
527         // Bloat for systems that haven't got the GNU extension.
528         va_start(p, format);
529         r = vsnprintf(NULL, 0, format, p) + 1;
530         va_end(p);
531         string_ptr = malloc(r);
532         if (string_ptr) {
533                 va_start(p, format);
534                 r = vsnprintf(string_ptr, r, format, p);
535                 va_end(p);
536         }
537 #endif
538
539         if (r >= 0) {
540                 full_write(fd, string_ptr, r);
541                 free(string_ptr);
542         }
543         return r;
544 }
545 #endif
546
547 // Die with an error message if we can't copy an entire FILE * to stdout, then
548 // close that file.
549 void xprint_and_close_file(FILE *file)
550 {
551         fflush(stdout);
552         // copyfd outputs error messages for us.
553         if (bb_copyfd_eof(fileno(file), 1) == -1)
554                 xfunc_die();
555
556         fclose(file);
557 }
558
559 // Die if we can't chdir to a new path.
560 void xchdir(const char *path)
561 {
562         if (chdir(path))
563                 bb_perror_msg_and_die("chdir(%s)", path);
564 }
565
566 // Print a warning message if opendir() fails, but don't die.
567 DIR *warn_opendir(const char *path)
568 {
569         DIR *dp;
570
571         dp = opendir(path);
572         if (!dp)
573                 bb_perror_msg("can't open '%s'", path);
574         return dp;
575 }
576
577 // Die with an error message if opendir() fails.
578 DIR *xopendir(const char *path)
579 {
580         DIR *dp;
581
582         dp = opendir(path);
583         if (!dp)
584                 bb_perror_msg_and_die("can't open '%s'", path);
585         return dp;
586 }
587
588 // Die with an error message if we can't open a new socket.
589 int xsocket(int domain, int type, int protocol)
590 {
591         int r = socket(domain, type, protocol);
592
593         if (r < 0) {
594                 /* Hijack vaguely related config option */
595 #if ENABLE_VERBOSE_RESOLUTION_ERRORS
596                 const char *s = "INET";
597                 if (domain == AF_PACKET) s = "PACKET";
598                 if (domain == AF_NETLINK) s = "NETLINK";
599 USE_FEATURE_IPV6(if (domain == AF_INET6) s = "INET6";)
600                 bb_perror_msg_and_die("socket(AF_%s)", s);
601 #else
602                 bb_perror_msg_and_die("socket");
603 #endif
604         }
605
606         return r;
607 }
608
609 // Die with an error message if we can't bind a socket to an address.
610 void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen)
611 {
612         if (bind(sockfd, my_addr, addrlen)) bb_perror_msg_and_die("bind");
613 }
614
615 // Die with an error message if we can't listen for connections on a socket.
616 void xlisten(int s, int backlog)
617 {
618         if (listen(s, backlog)) bb_perror_msg_and_die("listen");
619 }
620
621 /* Die with an error message if sendto failed.
622  * Return bytes sent otherwise  */
623 ssize_t xsendto(int s, const  void *buf, size_t len, const struct sockaddr *to,
624                                 socklen_t tolen)
625 {
626         ssize_t ret = sendto(s, buf, len, 0, to, tolen);
627         if (ret < 0) {
628                 if (ENABLE_FEATURE_CLEAN_UP)
629                         close(s);
630                 bb_perror_msg_and_die("sendto");
631         }
632         return ret;
633 }
634
635 // xstat() - a stat() which dies on failure with meaningful error message
636 void xstat(const char *name, struct stat *stat_buf)
637 {
638         if (stat(name, stat_buf))
639                 bb_perror_msg_and_die("can't stat '%s'", name);
640 }
641
642 // selinux_or_die() - die if SELinux is disabled.
643 void selinux_or_die(void)
644 {
645 #if ENABLE_SELINUX
646         int rc = is_selinux_enabled();
647         if (rc == 0) {
648                 bb_error_msg_and_die("SELinux is disabled");
649         } else if (rc < 0) {
650                 bb_error_msg_and_die("is_selinux_enabled() failed");
651         }
652 #else
653         bb_error_msg_and_die("SELinux support is disabled");
654 #endif
655 }
656
657 /* It is perfectly ok to pass in a NULL for either width or for
658  * height, in which case that value will not be set.  */
659 int get_terminal_width_height(int fd, int *width, int *height)
660 {
661         struct winsize win = { 0, 0, 0, 0 };
662         int ret = ioctl(fd, TIOCGWINSZ, &win);
663
664         if (height) {
665                 if (!win.ws_row) {
666                         char *s = getenv("LINES");
667                         if (s) win.ws_row = atoi(s);
668                 }
669                 if (win.ws_row <= 1 || win.ws_row >= 30000)
670                         win.ws_row = 24;
671                 *height = (int) win.ws_row;
672         }
673
674         if (width) {
675                 if (!win.ws_col) {
676                         char *s = getenv("COLUMNS");
677                         if (s) win.ws_col = atoi(s);
678                 }
679                 if (win.ws_col <= 1 || win.ws_col >= 30000)
680                         win.ws_col = 80;
681                 *width = (int) win.ws_col;
682         }
683
684         return ret;
685 }
686
687 void ioctl_or_perror_and_die(int fd, int request, void *argp, const char *fmt,...)
688 {
689         va_list p;
690
691         if (ioctl(fd, request, argp) < 0) {
692                 va_start(p, fmt);
693                 bb_verror_msg(fmt, p, strerror(errno));
694                 /* xfunc_die can actually longjmp, so be nice */
695                 va_end(p);
696                 xfunc_die();
697         }
698 }
699
700 int ioctl_or_perror(int fd, int request, void *argp, const char *fmt,...)
701 {
702         va_list p;
703         int ret = ioctl(fd, request, argp);
704
705         if (ret < 0) {
706                 va_start(p, fmt);
707                 bb_verror_msg(fmt, p, strerror(errno));
708                 va_end(p);
709         }
710         return ret;
711 }
712
713 #if ENABLE_IOCTL_HEX2STR_ERROR
714 int bb_ioctl_or_warn(int fd, int request, void *argp, const char *ioctl_name)
715 {
716         int ret;
717
718         ret = ioctl(fd, request, argp);
719         if (ret < 0)
720                 bb_simple_perror_msg(ioctl_name);
721         return ret;
722 }
723 void bb_xioctl(int fd, int request, void *argp, const char *ioctl_name)
724 {
725         if (ioctl(fd, request, argp) < 0)
726                 bb_simple_perror_msg_and_die(ioctl_name);
727 }
728 #else
729 int bb_ioctl_or_warn(int fd, int request, void *argp)
730 {
731         int ret;
732
733         ret = ioctl(fd, request, argp);
734         if (ret < 0)
735                 bb_perror_msg("ioctl %#x failed", request);
736         return ret;
737 }
738 void bb_xioctl(int fd, int request, void *argp)
739 {
740         if (ioctl(fd, request, argp) < 0)
741                 bb_perror_msg_and_die("ioctl %#x failed", request);
742 }
743 #endif