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