shell: clarify help text of CONFIG_{SH,BASH}_IS_* options
[oweals/busybox.git] / libbb / appletlib.c
1 /* vi: set sw=4 ts=4: */
2 /*
3  * Utility routines.
4  *
5  * Copyright (C) tons of folks.  Tracking down who wrote what
6  * isn't something I'm going to worry about...  If you wrote something
7  * here, please feel free to acknowledge your work.
8  *
9  * Based in part on code from sash, Copyright (c) 1999 by David I. Bell
10  * Permission has been granted to redistribute this code under GPL.
11  *
12  * Licensed under GPLv2 or later, see file LICENSE in this source tree.
13  */
14
15 /* We are trying to not use printf, this benefits the case when selected
16  * applets are really simple. Example:
17  *
18  * $ ./busybox
19  * ...
20  * Currently defined functions:
21  *         basename, false, true
22  *
23  * $ size busybox
24  *    text    data     bss     dec     hex filename
25  *    4473      52      72    4597    11f5 busybox
26  *
27  * FEATURE_INSTALLER or FEATURE_SUID will still link printf routines in. :(
28  */
29 #include "busybox.h"
30
31 #if !(defined(__FreeBSD__) || defined(__OpenBSD__) || defined(__NetBSD__) \
32     || defined(__APPLE__) \
33     )
34 # include <malloc.h> /* for mallopt */
35 #endif
36
37
38 /* Declare <applet>_main() */
39 #define PROTOTYPES
40 #include "applets.h"
41 #undef PROTOTYPES
42
43 /* Include generated applet names, pointers to <applet>_main, etc */
44 #include "applet_tables.h"
45 /* ...and if applet_tables generator says we have only one applet... */
46 #ifdef SINGLE_APPLET_MAIN
47 # undef ENABLE_FEATURE_INDIVIDUAL
48 # define ENABLE_FEATURE_INDIVIDUAL 1
49 # undef IF_FEATURE_INDIVIDUAL
50 # define IF_FEATURE_INDIVIDUAL(...) __VA_ARGS__
51 #endif
52
53 #include "usage_compressed.h"
54
55 #if ENABLE_SHOW_USAGE && !ENABLE_FEATURE_COMPRESS_USAGE
56 static const char usage_messages[] ALIGN1 = UNPACKED_USAGE;
57 #else
58 # define usage_messages 0
59 #endif
60
61 #if ENABLE_FEATURE_COMPRESS_USAGE
62
63 static const char packed_usage[] ALIGN1 = { PACKED_USAGE };
64 # include "bb_archive.h"
65 static const char *unpack_usage_messages(void)
66 {
67         char *outbuf = NULL;
68         bunzip_data *bd;
69         int i;
70
71         i = start_bunzip(&bd,
72                         /* src_fd: */ -1,
73                         /* inbuf:  */ packed_usage,
74                         /* len:    */ sizeof(packed_usage));
75         /* read_bunzip can longjmp to start_bunzip, and ultimately
76          * end up here with i != 0 on read data errors! Not trivial */
77         if (!i) {
78                 /* Cannot use xmalloc: will leak bd in NOFORK case! */
79                 outbuf = malloc_or_warn(sizeof(UNPACKED_USAGE));
80                 if (outbuf)
81                         read_bunzip(bd, outbuf, sizeof(UNPACKED_USAGE));
82         }
83         dealloc_bunzip(bd);
84         return outbuf;
85 }
86 # define dealloc_usage_messages(s) free(s)
87
88 #else
89
90 # define unpack_usage_messages() usage_messages
91 # define dealloc_usage_messages(s) ((void)(s))
92
93 #endif /* FEATURE_COMPRESS_USAGE */
94
95
96 void FAST_FUNC bb_show_usage(void)
97 {
98         if (ENABLE_SHOW_USAGE) {
99 #ifdef SINGLE_APPLET_STR
100                 /* Imagine that this applet is "true". Dont suck in printf! */
101                 const char *usage_string = unpack_usage_messages();
102
103                 if (*usage_string == '\b') {
104                         full_write2_str("No help available.\n\n");
105                 } else {
106                         full_write2_str("Usage: "SINGLE_APPLET_STR" ");
107                         full_write2_str(usage_string);
108                         full_write2_str("\n\n");
109                 }
110                 if (ENABLE_FEATURE_CLEAN_UP)
111                         dealloc_usage_messages((char*)usage_string);
112 #else
113                 const char *p;
114                 const char *usage_string = p = unpack_usage_messages();
115                 int ap = find_applet_by_name(applet_name);
116
117                 if (ap < 0) /* never happens, paranoia */
118                         xfunc_die();
119                 while (ap) {
120                         while (*p++) continue;
121                         ap--;
122                 }
123                 full_write2_str(bb_banner);
124                 full_write2_str(" multi-call binary.\n");
125                 if (*p == '\b')
126                         full_write2_str("\nNo help available.\n\n");
127                 else {
128                         full_write2_str("\nUsage: ");
129                         full_write2_str(applet_name);
130                         full_write2_str(" ");
131                         full_write2_str(p);
132                         full_write2_str("\n");
133                 }
134                 if (ENABLE_FEATURE_CLEAN_UP)
135                         dealloc_usage_messages((char*)usage_string);
136 #endif
137         }
138         xfunc_die();
139 }
140
141 int FAST_FUNC find_applet_by_name(const char *name)
142 {
143         unsigned i, max;
144         int j;
145         const char *p;
146
147 /* The commented-out word-at-a-time code is ~40% faster, but +160 bytes.
148  * "Faster" here saves ~0.5 microsecond of real time - not worth it.
149  */
150 #if 0 /*BB_UNALIGNED_MEMACCESS_OK && BB_LITTLE_ENDIAN*/
151         uint32_t n32;
152
153         /* Handle all names < 2 chars long early */
154         if (name[0] == '\0')
155                 return -1; /* "" is not a valid applet name */
156         if (name[1] == '\0') {
157                 if (!ENABLE_TEST)
158                         return -1; /* 1-char name is not valid */
159                 if (name[0] != ']')
160                         return -1; /* 1-char name which isn't "[" is not valid */
161                 /* applet "[" is always applet #0: */
162                 return 0;
163         }
164 #endif
165
166         p = applet_names;
167         i = 0;
168 #if KNOWN_APPNAME_OFFSETS <= 0
169         max = NUM_APPLETS;
170 #else
171         max = NUM_APPLETS * KNOWN_APPNAME_OFFSETS;
172         for (j = ARRAY_SIZE(applet_nameofs)-1; j >= 0; j--) {
173                 const char *pp = applet_names + applet_nameofs[j];
174                 if (strcmp(name, pp) >= 0) {
175                         //bb_error_msg("name:'%s' >= pp:'%s'", name, pp);
176                         p = pp;
177                         i = max - NUM_APPLETS;
178                         break;
179                 }
180                 max -= NUM_APPLETS;
181         }
182         max /= (unsigned)KNOWN_APPNAME_OFFSETS;
183         i /= (unsigned)KNOWN_APPNAME_OFFSETS;
184         //bb_error_msg("name:'%s' starting from:'%s' i:%u max:%u", name, p, i, max);
185 #endif
186
187         /* Open-coded linear search without strcmp/strlen calls for speed */
188
189 #if 0 /*BB_UNALIGNED_MEMACCESS_OK && BB_LITTLE_ENDIAN*/
190         /* skip "[\0" name, it's surely not it */
191         if (ENABLE_TEST && LONE_CHAR(p, '['))
192                 i++, p += 2;
193         /* All remaining applet names in p[] are at least 2 chars long */
194         /* name[] is also at least 2 chars long */
195
196         n32 = (name[0] << 0) | (name[1] << 8) | (name[2] << 16);
197         while (i < max) {
198                 uint32_t p32;
199                 char ch;
200
201                 /* Quickly check match of the first 3 bytes */
202                 move_from_unaligned32(p32, p);
203                 p += 3;
204                 if ((p32 & 0x00ffffff) != n32) {
205                         /* Most likely case: 3 first bytes do not match */
206                         i++;
207                         if ((p32 & 0x00ff0000) == '\0')
208                                 continue; // p[2] was NUL
209                         p++;
210                         if ((p32 & 0xff000000) == '\0')
211                                 continue; // p[3] was NUL
212                         /* p[0..3] aren't matching and none is NUL, check the rest */
213                         while (*p++ != '\0')
214                                 continue;
215                         continue;
216                 }
217
218                 /* Unlikely branch: first 3 bytes ([0..2]) match */
219                 if ((p32 & 0x00ff0000) == '\0') {
220                         /* name is 2-byte long, it is full match */
221                         //bb_error_msg("found:'%s' i:%u", name, i);
222                         return i;
223                 }
224                 /* Check remaining bytes [3..NUL] */
225                 ch = (p32 >> 24);
226                 j = 3;
227                 while (ch == name[j]) {
228                         if (ch == '\0') {
229                                 //bb_error_msg("found:'%s' i:%u", name, i);
230                                 return i;
231                         }
232                         ch = *++p;
233                         j++;
234                 }
235                 /* Not a match. Skip it, including NUL */
236                 while (ch != '\0')
237                         ch = *++p;
238                 p++;
239                 i++;
240         }
241         return -1;
242 #else
243         while (i < max) {
244                 char ch;
245                 j = 0;
246                 /* Do we see "name\0" in applet_names[p] position? */
247                 while ((ch = *p) == name[j]) {
248                         if (ch == '\0') {
249                                 //bb_error_msg("found:'%s' i:%u", name, i);
250                                 return i; /* yes */
251                         }
252                         p++;
253                         j++;
254                 }
255                 /* No.
256                  * p => 1st non-matching char in applet_names[],
257                  * skip to and including NUL.
258                  */
259                 while (ch != '\0')
260                         ch = *++p;
261                 p++;
262                 i++;
263         }
264         return -1;
265 #endif
266 }
267
268
269 void lbb_prepare(const char *applet
270                 IF_FEATURE_INDIVIDUAL(, char **argv))
271                                 MAIN_EXTERNALLY_VISIBLE;
272 void lbb_prepare(const char *applet
273                 IF_FEATURE_INDIVIDUAL(, char **argv))
274 {
275 #ifdef __GLIBC__
276         (*(int **)&bb_errno) = __errno_location();
277         barrier();
278 #endif
279         applet_name = applet;
280
281         if (ENABLE_LOCALE_SUPPORT)
282                 setlocale(LC_ALL, "");
283
284 #if ENABLE_FEATURE_INDIVIDUAL
285         /* Redundant for busybox (run_applet_and_exit covers that case)
286          * but needed for "individual applet" mode */
287         if (argv[1]
288          && !argv[2]
289          && strcmp(argv[1], "--help") == 0
290          && !is_prefixed_with(applet, "busybox")
291         ) {
292                 /* Special case. POSIX says "test --help"
293                  * should be no different from e.g. "test --foo".  */
294                 if (!ENABLE_TEST || strcmp(applet_name, "test") != 0)
295                         bb_show_usage();
296         }
297 #endif
298 }
299
300 /* The code below can well be in applets/applets.c, as it is used only
301  * for busybox binary, not "individual" binaries.
302  * However, keeping it here and linking it into libbusybox.so
303  * (together with remaining tiny applets/applets.o)
304  * makes it possible to avoid --whole-archive at link time.
305  * This makes (shared busybox) + libbusybox smaller.
306  * (--gc-sections would be even better....)
307  */
308
309 const char *applet_name;
310 #if !BB_MMU
311 bool re_execed;
312 #endif
313
314
315 /* If not built as a single-applet executable... */
316 #if !defined(SINGLE_APPLET_MAIN)
317
318 IF_FEATURE_SUID(static uid_t ruid;)  /* real uid */
319
320 # if ENABLE_FEATURE_SUID_CONFIG
321
322 static struct suid_config_t {
323         /* next ptr must be first: this struct needs to be llist-compatible */
324         struct suid_config_t *m_next;
325         struct bb_uidgid_t m_ugid;
326         int m_applet;
327         mode_t m_mode;
328 } *suid_config;
329
330 static bool suid_cfg_readable;
331
332 /* libbb candidate */
333 static char *get_trimmed_slice(char *s, char *e)
334 {
335         /* First, consider the value at e to be nul and back up until we
336          * reach a non-space char.  Set the char after that (possibly at
337          * the original e) to nul. */
338         while (e-- > s) {
339                 if (!isspace(*e)) {
340                         break;
341                 }
342         }
343         e[1] = '\0';
344
345         /* Next, advance past all leading space and return a ptr to the
346          * first non-space char; possibly the terminating nul. */
347         return skip_whitespace(s);
348 }
349
350 static void parse_config_file(void)
351 {
352         /* Don't depend on the tools to combine strings. */
353         static const char config_file[] ALIGN1 = "/etc/busybox.conf";
354
355         struct suid_config_t *sct_head;
356         int applet_no;
357         FILE *f;
358         const char *errmsg;
359         unsigned lc;
360         smallint section;
361         struct stat st;
362
363         ruid = getuid();
364         if (ruid == 0) /* run by root - don't need to even read config file */
365                 return;
366
367         if ((stat(config_file, &st) != 0)       /* No config file? */
368          || !S_ISREG(st.st_mode)                /* Not a regular file? */
369          || (st.st_uid != 0)                    /* Not owned by root? */
370          || (st.st_mode & (S_IWGRP | S_IWOTH))  /* Writable by non-root? */
371          || !(f = fopen_for_read(config_file))  /* Cannot open? */
372         ) {
373                 return;
374         }
375
376         suid_cfg_readable = 1;
377         sct_head = NULL;
378         section = lc = 0;
379
380         while (1) {
381                 char buffer[256];
382                 char *s;
383
384                 if (!fgets(buffer, sizeof(buffer), f)) { /* Are we done? */
385                         // Looks like bloat
386                         //if (ferror(f)) {   /* Make sure it wasn't a read error. */
387                         //      errmsg = "reading";
388                         //      goto pe_label;
389                         //}
390                         fclose(f);
391                         suid_config = sct_head; /* Success, so set the pointer. */
392                         return;
393                 }
394
395                 s = buffer;
396                 lc++;                                   /* Got a (partial) line. */
397
398                 /* If a line is too long for our buffer, we consider it an error.
399                  * The following test does mistreat one corner case though.
400                  * If the final line of the file does not end with a newline and
401                  * yet exactly fills the buffer, it will be treated as too long
402                  * even though there isn't really a problem.  But it isn't really
403                  * worth adding code to deal with such an unlikely situation, and
404                  * we do err on the side of caution.  Besides, the line would be
405                  * too long if it did end with a newline. */
406                 if (!strchr(s, '\n') && !feof(f)) {
407                         errmsg = "line too long";
408                         goto pe_label;
409                 }
410
411                 /* Trim leading and trailing whitespace, ignoring comments, and
412                  * check if the resulting string is empty. */
413                 s = get_trimmed_slice(s, strchrnul(s, '#'));
414                 if (!*s) {
415                         continue;
416                 }
417
418                 /* Check for a section header. */
419
420                 if (*s == '[') {
421                         /* Unlike the old code, we ignore leading and trailing
422                          * whitespace for the section name.  We also require that
423                          * there are no stray characters after the closing bracket. */
424                         char *e = strchr(s, ']');
425                         if (!e   /* Missing right bracket? */
426                          || e[1] /* Trailing characters? */
427                          || !*(s = get_trimmed_slice(s+1, e)) /* Missing name? */
428                         ) {
429                                 errmsg = "section header";
430                                 goto pe_label;
431                         }
432                         /* Right now we only have one section so just check it.
433                          * If more sections are added in the future, please don't
434                          * resort to cascading ifs with multiple strcasecmp calls.
435                          * That kind of bloated code is all too common.  A loop
436                          * and a string table would be a better choice unless the
437                          * number of sections is very small. */
438                         if (strcasecmp(s, "SUID") == 0) {
439                                 section = 1;
440                                 continue;
441                         }
442                         section = -1;   /* Unknown section so set to skip. */
443                         continue;
444                 }
445
446                 /* Process sections. */
447
448                 if (section == 1) {             /* SUID */
449                         /* Since we trimmed leading and trailing space above, we're
450                          * now looking for strings of the form
451                          *    <key>[::space::]*=[::space::]*<value>
452                          * where both key and value could contain inner whitespace. */
453
454                         /* First get the key (an applet name in our case). */
455                         char *e = strchr(s, '=');
456                         if (e) {
457                                 s = get_trimmed_slice(s, e);
458                         }
459                         if (!e || !*s) {        /* Missing '=' or empty key. */
460                                 errmsg = "keyword";
461                                 goto pe_label;
462                         }
463
464                         /* Ok, we have an applet name.  Process the rhs if this
465                          * applet is currently built in and ignore it otherwise.
466                          * Note: this can hide config file bugs which only pop
467                          * up when the busybox configuration is changed. */
468                         applet_no = find_applet_by_name(s);
469                         if (applet_no >= 0) {
470                                 unsigned i;
471                                 struct suid_config_t *sct;
472
473                                 /* Note: We currently don't check for duplicates!
474                                  * The last config line for each applet will be the
475                                  * one used since we insert at the head of the list.
476                                  * I suppose this could be considered a feature. */
477                                 sct = xzalloc(sizeof(*sct));
478                                 sct->m_applet = applet_no;
479                                 /*sct->m_mode = 0;*/
480                                 sct->m_next = sct_head;
481                                 sct_head = sct;
482
483                                 /* Get the specified mode. */
484
485                                 e = skip_whitespace(e+1);
486
487                                 for (i = 0; i < 3; i++) {
488                                         /* There are 4 chars for each of user/group/other.
489                                          * "x-xx" instead of "x-" are to make
490                                          * "idx > 3" check catch invalid chars.
491                                          */
492                                         static const char mode_chars[] ALIGN1 = "Ssx-" "Ssx-" "x-xx";
493                                         static const unsigned short mode_mask[] ALIGN2 = {
494                                                 S_ISUID, S_ISUID|S_IXUSR, S_IXUSR, 0, /* Ssx- */
495                                                 S_ISGID, S_ISGID|S_IXGRP, S_IXGRP, 0, /* Ssx- */
496                                                                           S_IXOTH, 0  /*   x- */
497                                         };
498                                         const char *q = strchrnul(mode_chars + 4*i, *e);
499                                         unsigned idx = q - (mode_chars + 4*i);
500                                         if (idx > 3) {
501                                                 errmsg = "mode";
502                                                 goto pe_label;
503                                         }
504                                         sct->m_mode |= mode_mask[q - mode_chars];
505                                         e++;
506                                 }
507
508                                 /* Now get the user/group info. */
509
510                                 s = skip_whitespace(e);
511                                 /* Default is 0.0, else parse USER.GROUP: */
512                                 if (*s) {
513                                         /* We require whitespace between mode and USER.GROUP */
514                                         if ((s == e) || !(e = strchr(s, '.'))) {
515                                                 errmsg = "uid.gid";
516                                                 goto pe_label;
517                                         }
518                                         *e = ':'; /* get_uidgid needs USER:GROUP syntax */
519                                         if (get_uidgid(&sct->m_ugid, s) == 0) {
520                                                 errmsg = "unknown user/group";
521                                                 goto pe_label;
522                                         }
523                                 }
524                         }
525                         continue;
526                 }
527
528                 /* Unknown sections are ignored. */
529
530                 /* Encountering configuration lines prior to seeing a
531                  * section header is treated as an error.  This is how
532                  * the old code worked, but it may not be desirable.
533                  * We may want to simply ignore such lines in case they
534                  * are used in some future version of busybox. */
535                 if (!section) {
536                         errmsg = "keyword outside section";
537                         goto pe_label;
538                 }
539         } /* while (1) */
540
541  pe_label:
542         fclose(f);
543         bb_error_msg("parse error in %s, line %u: %s", config_file, lc, errmsg);
544
545         /* Release any allocated memory before returning. */
546         llist_free((llist_t*)sct_head, NULL);
547 }
548 # else
549 static inline void parse_config_file(void)
550 {
551         IF_FEATURE_SUID(ruid = getuid();)
552 }
553 # endif /* FEATURE_SUID_CONFIG */
554
555
556 # if ENABLE_FEATURE_SUID && NUM_APPLETS > 0
557 #  if ENABLE_FEATURE_SUID_CONFIG
558 /* check if u is member of group g */
559 static int ingroup(uid_t u, gid_t g)
560 {
561         struct group *grp = getgrgid(g);
562         if (grp) {
563                 char **mem;
564                 for (mem = grp->gr_mem; *mem; mem++) {
565                         struct passwd *pwd = getpwnam(*mem);
566                         if (pwd && (pwd->pw_uid == u))
567                                 return 1;
568                 }
569         }
570         return 0;
571 }
572 #  endif
573
574 static void check_suid(int applet_no)
575 {
576         gid_t rgid;  /* real gid */
577
578         if (ruid == 0) /* set by parse_config_file() */
579                 return; /* run by root - no need to check more */
580         rgid = getgid();
581
582 #  if ENABLE_FEATURE_SUID_CONFIG
583         if (suid_cfg_readable) {
584                 uid_t uid;
585                 struct suid_config_t *sct;
586                 mode_t m;
587
588                 for (sct = suid_config; sct; sct = sct->m_next) {
589                         if (sct->m_applet == applet_no)
590                                 goto found;
591                 }
592                 goto check_need_suid;
593  found:
594                 /* Is this user allowed to run this applet? */
595                 m = sct->m_mode;
596                 if (sct->m_ugid.uid == ruid)
597                         /* same uid */
598                         m >>= 6;
599                 else if ((sct->m_ugid.gid == rgid) || ingroup(ruid, sct->m_ugid.gid))
600                         /* same group / in group */
601                         m >>= 3;
602                 if (!(m & S_IXOTH)) /* is x bit not set? */
603                         bb_error_msg_and_die("you have no permission to run this applet");
604
605                 /* We set effective AND saved ids. If saved-id is not set
606                  * like we do below, seteuid(0) can still later succeed! */
607
608                 /* Are we directed to change gid
609                  * (APPLET = *s* USER.GROUP or APPLET = *S* USER.GROUP)?
610                  */
611                 if (sct->m_mode & S_ISGID)
612                         rgid = sct->m_ugid.gid;
613                 /* else: we will set egid = rgid, thus dropping sgid effect */
614                 if (setresgid(-1, rgid, rgid))
615                         bb_perror_msg_and_die("setresgid");
616
617                 /* Are we directed to change uid
618                  * (APPLET = s** USER.GROUP or APPLET = S** USER.GROUP)?
619                  */
620                 uid = ruid;
621                 if (sct->m_mode & S_ISUID)
622                         uid = sct->m_ugid.uid;
623                 /* else: we will set euid = ruid, thus dropping suid effect */
624                 if (setresuid(-1, uid, uid))
625                         bb_perror_msg_and_die("setresuid");
626
627                 goto ret;
628         }
629 #   if !ENABLE_FEATURE_SUID_CONFIG_QUIET
630         {
631                 static bool onetime = 0;
632
633                 if (!onetime) {
634                         onetime = 1;
635                         bb_error_msg("using fallback suid method");
636                 }
637         }
638 #   endif
639  check_need_suid:
640 #  endif
641         if (APPLET_SUID(applet_no) == BB_SUID_REQUIRE) {
642                 /* Real uid is not 0. If euid isn't 0 too, suid bit
643                  * is most probably not set on our executable */
644                 if (geteuid())
645                         bb_error_msg_and_die("must be suid to work properly");
646         } else if (APPLET_SUID(applet_no) == BB_SUID_DROP) {
647                 xsetgid(rgid);  /* drop all privileges */
648                 xsetuid(ruid);
649         }
650 #  if ENABLE_FEATURE_SUID_CONFIG
651  ret: ;
652         llist_free((llist_t*)suid_config, NULL);
653 #  endif
654 }
655 # else
656 #  define check_suid(x) ((void)0)
657 # endif /* FEATURE_SUID */
658
659
660 # if ENABLE_FEATURE_INSTALLER
661 static const char usr_bin [] ALIGN1 = "/usr/bin/";
662 static const char usr_sbin[] ALIGN1 = "/usr/sbin/";
663 static const char *const install_dir[] = {
664         &usr_bin [8], /* "/" */
665         &usr_bin [4], /* "/bin/" */
666         &usr_sbin[4]  /* "/sbin/" */
667 #  if !ENABLE_INSTALL_NO_USR
668         ,usr_bin
669         ,usr_sbin
670 #  endif
671 };
672
673 /* create (sym)links for each applet */
674 static void install_links(const char *busybox, int use_symbolic_links,
675                 char *custom_install_dir)
676 {
677         /* directory table
678          * this should be consistent w/ the enum,
679          * busybox.h::bb_install_loc_t, or else... */
680         int (*lf)(const char *, const char *);
681         char *fpc;
682         const char *appname = applet_names;
683         unsigned i;
684         int rc;
685
686         lf = link;
687         if (use_symbolic_links)
688                 lf = symlink;
689
690         for (i = 0; i < ARRAY_SIZE(applet_main); i++) {
691                 fpc = concat_path_file(
692                                 custom_install_dir ? custom_install_dir : install_dir[APPLET_INSTALL_LOC(i)],
693                                 appname);
694                 // debug: bb_error_msg("%slinking %s to busybox",
695                 //              use_symbolic_links ? "sym" : "", fpc);
696                 rc = lf(busybox, fpc);
697                 if (rc != 0 && errno != EEXIST) {
698                         bb_simple_perror_msg(fpc);
699                 }
700                 free(fpc);
701                 while (*appname++ != '\0')
702                         continue;
703         }
704 }
705 # elif ENABLE_BUSYBOX
706 static void install_links(const char *busybox UNUSED_PARAM,
707                 int use_symbolic_links UNUSED_PARAM,
708                 char *custom_install_dir UNUSED_PARAM)
709 {
710 }
711 # endif
712
713 # if ENABLE_BUSYBOX
714 static void run_applet_and_exit(const char *name, char **argv) NORETURN;
715
716 /* If we were called as "busybox..." */
717 static int busybox_main(char **argv)
718 {
719         if (!argv[1]) {
720                 /* Called without arguments */
721                 const char *a;
722                 int col;
723                 unsigned output_width;
724  help:
725                 output_width = 80;
726                 if (ENABLE_FEATURE_AUTOWIDTH) {
727                         /* Obtain the terminal width */
728                         output_width = get_terminal_width(2);
729                 }
730
731                 dup2(1, 2);
732                 full_write2_str(bb_banner); /* reuse const string */
733                 full_write2_str(" multi-call binary.\n"); /* reuse */
734                 full_write2_str(
735                         "BusyBox is copyrighted by many authors between 1998-2015.\n"
736                         "Licensed under GPLv2. See source distribution for detailed\n"
737                         "copyright notices.\n"
738                         "\n"
739                         "Usage: busybox [function [arguments]...]\n"
740                         "   or: busybox --list"IF_FEATURE_INSTALLER("[-full]")"\n"
741                         IF_FEATURE_INSTALLER(
742                         "   or: busybox --install [-s] [DIR]\n"
743                         )
744                         "   or: function [arguments]...\n"
745                         "\n"
746                         IF_NOT_FEATURE_SH_STANDALONE(
747                         "\tBusyBox is a multi-call binary that combines many common Unix\n"
748                         "\tutilities into a single executable.  Most people will create a\n"
749                         "\tlink to busybox for each function they wish to use and BusyBox\n"
750                         "\twill act like whatever it was invoked as.\n"
751                         )
752                         IF_FEATURE_SH_STANDALONE(
753                         "\tBusyBox is a multi-call binary that combines many common Unix\n"
754                         "\tutilities into a single executable.  The shell in this build\n"
755                         "\tis configured to run built-in utilities without $PATH search.\n"
756                         "\tYou don't need to install a link to busybox for each utility.\n"
757                         "\tTo run external program, use full path (/sbin/ip instead of ip).\n"
758                         )
759                         "\n"
760                         "Currently defined functions:\n"
761                 );
762                 col = 0;
763                 a = applet_names;
764                 /* prevent last comma to be in the very last pos */
765                 output_width--;
766                 while (*a) {
767                         int len2 = strlen(a) + 2;
768                         if (col >= (int)output_width - len2) {
769                                 full_write2_str(",\n");
770                                 col = 0;
771                         }
772                         if (col == 0) {
773                                 col = 6;
774                                 full_write2_str("\t");
775                         } else {
776                                 full_write2_str(", ");
777                         }
778                         full_write2_str(a);
779                         col += len2;
780                         a += len2 - 1;
781                 }
782                 full_write2_str("\n");
783                 return 0;
784         }
785
786         if (is_prefixed_with(argv[1], "--list")) {
787                 unsigned i = 0;
788                 const char *a = applet_names;
789                 dup2(1, 2);
790                 while (*a) {
791 #  if ENABLE_FEATURE_INSTALLER
792                         if (argv[1][6]) /* --list-full? */
793                                 full_write2_str(install_dir[APPLET_INSTALL_LOC(i)] + 1);
794 #  endif
795                         full_write2_str(a);
796                         full_write2_str("\n");
797                         i++;
798                         while (*a++ != '\0')
799                                 continue;
800                 }
801                 return 0;
802         }
803
804         if (ENABLE_FEATURE_INSTALLER && strcmp(argv[1], "--install") == 0) {
805                 int use_symbolic_links;
806                 const char *busybox;
807
808                 busybox = xmalloc_readlink(bb_busybox_exec_path);
809                 if (!busybox) {
810                         /* bb_busybox_exec_path is usually "/proc/self/exe".
811                          * In chroot, readlink("/proc/self/exe") usually fails.
812                          * In such case, better use argv[0] as symlink target
813                          * if it is a full path name.
814                          */
815                         if (argv[0][0] != '/')
816                                 bb_error_msg_and_die("'%s' is not an absolute path", argv[0]);
817                         busybox = argv[0];
818                 }
819                 /* busybox --install [-s] [DIR]:
820                  * -s: make symlinks
821                  * DIR: directory to install links to
822                  */
823                 use_symbolic_links = (argv[2] && strcmp(argv[2], "-s") == 0 && ++argv);
824                 install_links(busybox, use_symbolic_links, argv[2]);
825                 return 0;
826         }
827
828         if (strcmp(argv[1], "--help") == 0) {
829                 /* "busybox --help [<applet>]" */
830                 if (!argv[2])
831                         goto help;
832                 /* convert to "<applet> --help" */
833                 argv[0] = argv[2];
834                 argv[2] = NULL;
835         } else {
836                 /* "busybox <applet> arg1 arg2 ..." */
837                 argv++;
838         }
839         /* We support "busybox /a/path/to/applet args..." too. Allows for
840          * "#!/bin/busybox"-style wrappers */
841         applet_name = bb_get_last_path_component_nostrip(argv[0]);
842         run_applet_and_exit(applet_name, argv);
843 }
844 # endif
845
846 # if NUM_APPLETS > 0
847 void FAST_FUNC run_applet_no_and_exit(int applet_no, char **argv)
848 {
849         int argc = 1;
850
851         while (argv[argc])
852                 argc++;
853
854         /* Reinit some shared global data */
855         xfunc_error_retval = EXIT_FAILURE;
856         applet_name = bb_get_last_path_component_nostrip(argv[0]);
857
858         /* Special case. POSIX says "test --help"
859          * should be no different from e.g. "test --foo".
860          * Thus for "test", we skip --help check.
861          * "true" and "false" are also special.
862          */
863         if (1
864 #  if defined APPLET_NO_test
865          && applet_no != APPLET_NO_test
866 #  endif
867 #  if defined APPLET_NO_true
868          && applet_no != APPLET_NO_true
869 #  endif
870 #  if defined APPLET_NO_false
871          && applet_no != APPLET_NO_false
872 #  endif
873         ) {
874                 if (argc == 2 && strcmp(argv[1], "--help") == 0) {
875                         /* Make "foo --help" exit with 0: */
876                         xfunc_error_retval = 0;
877                         bb_show_usage();
878                 }
879         }
880         if (ENABLE_FEATURE_SUID)
881                 check_suid(applet_no);
882         xfunc_error_retval = applet_main[applet_no](argc, argv);
883         /* Note: applet_main() may also not return (die on a xfunc or such) */
884         xfunc_die();
885 }
886 # endif /* NUM_APPLETS > 0 */
887
888 # if ENABLE_BUSYBOX || NUM_APPLETS > 0
889 static NORETURN void run_applet_and_exit(const char *name, char **argv)
890 {
891 #  if ENABLE_BUSYBOX
892         if (is_prefixed_with(name, "busybox"))
893                 exit(busybox_main(argv));
894 #  endif
895 #  if NUM_APPLETS > 0
896         /* find_applet_by_name() search is more expensive, so goes second */
897         {
898                 int applet = find_applet_by_name(name);
899                 if (applet >= 0)
900                         run_applet_no_and_exit(applet, argv);
901         }
902 #  endif
903
904         /*bb_error_msg_and_die("applet not found"); - links in printf */
905         full_write2_str(applet_name);
906         full_write2_str(": applet not found\n");
907         /* POSIX: "If a command is not found, the exit status shall be 127" */
908         exit(127);
909 }
910 # endif
911
912 #endif /* !defined(SINGLE_APPLET_MAIN) */
913
914
915 #if ENABLE_BUILD_LIBBUSYBOX
916 int lbb_main(char **argv)
917 #else
918 int main(int argc UNUSED_PARAM, char **argv)
919 #endif
920 {
921 #if 0
922         /* TODO: find a use for a block of memory between end of .bss
923          * and end of page. For example, I'm getting "_end:0x812e698 2408 bytes"
924          * - more than 2k of wasted memory (in this particular build)
925          * *per each running process*!
926          * (If your linker does not generate "_end" name, weak attribute
927          * makes &_end == NULL, end_len == 0 here.)
928          */
929         extern char _end[] __attribute__((weak));
930         unsigned end_len = (-(int)_end) & 0xfff;
931         printf("_end:%p %u bytes\n", &_end, end_len);
932 #endif
933
934         /* Tweak malloc for reduced memory consumption */
935 #ifdef M_TRIM_THRESHOLD
936         /* M_TRIM_THRESHOLD is the maximum amount of freed top-most memory
937          * to keep before releasing to the OS
938          * Default is way too big: 256k
939          */
940         mallopt(M_TRIM_THRESHOLD, 8 * 1024);
941 #endif
942 #ifdef M_MMAP_THRESHOLD
943         /* M_MMAP_THRESHOLD is the request size threshold for using mmap()
944          * Default is too big: 256k
945          */
946         mallopt(M_MMAP_THRESHOLD, 32 * 1024 - 256);
947 #endif
948 #if 0 /*def M_TOP_PAD*/
949         /* When the program break is increased, then M_TOP_PAD bytes are added
950          * to the sbrk(2) request. When the heap is trimmed because of free(3),
951          * this much free space is preserved at the top of the heap.
952          * glibc default seems to be way too big: 128k, but need to verify.
953          */
954         mallopt(M_TOP_PAD, 8 * 1024);
955 #endif
956
957 #if !BB_MMU
958         /* NOMMU re-exec trick sets high-order bit in first byte of name */
959         if (argv[0][0] & 0x80) {
960                 re_execed = 1;
961                 argv[0][0] &= 0x7f;
962         }
963 #endif
964
965 #if defined(SINGLE_APPLET_MAIN)
966
967         /* Only one applet is selected in .config */
968         if (argv[1] && is_prefixed_with(argv[0], "busybox")) {
969                 /* "busybox <applet> <params>" should still work as expected */
970                 argv++;
971         }
972         /* applet_names in this case is just "applet\0\0" */
973         lbb_prepare(applet_names IF_FEATURE_INDIVIDUAL(, argv));
974         return SINGLE_APPLET_MAIN(argc, argv);
975
976 #elif !ENABLE_BUSYBOX && NUM_APPLETS == 0
977
978         full_write2_str(bb_basename(argv[0]));
979         full_write2_str(": no applets enabled\n");
980         exit(127);
981
982 #else
983
984         lbb_prepare("busybox" IF_FEATURE_INDIVIDUAL(, argv));
985 # if !ENABLE_BUSYBOX
986         if (argv[1] && is_prefixed_with(bb_basename(argv[0]), "busybox"))
987                 argv++;
988 # endif
989         applet_name = argv[0];
990         if (applet_name[0] == '-')
991                 applet_name++;
992         applet_name = bb_basename(applet_name);
993         parse_config_file(); /* ...maybe, if FEATURE_SUID_CONFIG */
994         run_applet_and_exit(applet_name, argv);
995
996 #endif
997 }