*: add most of the required setup_common_bufsiz() calls
[oweals/busybox.git] / findutils / find.c
index d4b7c8ec888ba84b12b4c92abfbcf56d0e2883a4..d71c697827079c7d12e3c627beae89c33e528377 100644 (file)
 //config:        Support the 'find -exec' option for executing commands based upon
 //config:        the files matched.
 //config:
+//config:config FEATURE_FIND_EXEC_PLUS
+//config:      bool "Enable -exec ... {} +"
+//config:      default y
+//config:      depends on FEATURE_FIND_EXEC
+//config:      help
+//config:        Support the 'find -exec ... {} +' option for executing commands
+//config:        for all matched files at once.
+//config:        Without this option, -exec + is a synonym for -exec ;
+//config:        (IOW: it works correctly, but without expected speedup)
+//config:
 //config:config FEATURE_FIND_USER
 //config:      bool "Enable -user: username/uid matching"
 //config:      default y
 //usage:     "\n       -exec CMD ARG ; Run CMD with all instances of {} replaced by"
 //usage:     "\n                       file name. Fails if CMD exits with nonzero"
 //usage:       )
+//usage:       IF_FEATURE_FIND_EXEC_PLUS(
+//usage:     "\n       -exec CMD ARG + Run CMD with {} replaced by list of file names"
+//usage:       )
 //usage:       IF_FEATURE_FIND_DELETE(
 //usage:     "\n       -delete         Delete current file/directory. Turns on -depth option"
 //usage:       )
 
 #include <fnmatch.h>
 #include "libbb.h"
+#include "common_bufsiz.h"
 #if ENABLE_FEATURE_FIND_REGEX
 # include "xregex.h"
 #endif
 # define FNM_CASEFOLD 0
 #endif
 
-#define dbg(...) ((void)0)
-/* #define dbg(...) bb_error_msg(__VA_ARGS__) */
+#if 1
+# define dbg(...) ((void)0)
+#else
+# define dbg(...) bb_error_msg(__VA_ARGS__)
+#endif
+
 
 /* This is a NOEXEC applet. Be very careful! */
 
@@ -375,7 +393,20 @@ IF_FEATURE_FIND_CONTEXT(ACTS(context, security_context_t context;))
 IF_FEATURE_FIND_PAREN(  ACTS(paren, action ***subexpr;))
 IF_FEATURE_FIND_PRUNE(  ACTS(prune))
 IF_FEATURE_FIND_DELETE( ACTS(delete))
-IF_FEATURE_FIND_EXEC(   ACTS(exec,  char **exec_argv; unsigned *subst_count; int exec_argc;))
+IF_FEATURE_FIND_EXEC(   ACTS(exec,
+                               char **exec_argv; /* -exec ARGS */
+                               unsigned *subst_count;
+                               int exec_argc; /* count of ARGS */
+                               IF_FEATURE_FIND_EXEC_PLUS(
+                                       /*
+                                        * filelist is NULL if "exec ;"
+                                        * non-NULL if "exec +"
+                                        */
+                                       char **filelist;
+                                       int filelist_idx;
+                                       int file_len;
+                               )
+                               ))
 IF_FEATURE_FIND_GROUP(  ACTS(group, gid_t gid;))
 IF_FEATURE_FIND_LINKS(  ACTS(links, char links_char; int links_count;))
 
@@ -389,49 +420,20 @@ struct globals {
        smallint need_print;
        smallint xdev_on;
        recurse_flags_t recurse_flags;
+       IF_FEATURE_FIND_EXEC_PLUS(unsigned max_argv_len;)
 } FIX_ALIASING;
-#define G (*(struct globals*)&bb_common_bufsiz1)
+#define G (*(struct globals*)bb_common_bufsiz1)
 #define INIT_G() do { \
-       struct G_sizecheck { \
-               char G_sizecheck[sizeof(G) > COMMON_BUFSIZE ? -1 : 1]; \
-       }; \
+       setup_common_bufsiz(); \
+       BUILD_BUG_ON(sizeof(G) > COMMON_BUFSIZE); \
        /* we have to zero it out because of NOEXEC */ \
        memset(&G, 0, sizeof(G)); \
        IF_FEATURE_FIND_MAXDEPTH(G.minmaxdepth[1] = INT_MAX;) \
+       IF_FEATURE_FIND_EXEC_PLUS(G.max_argv_len = bb_arg_max() - 2048;) \
        G.need_print = 1; \
        G.recurse_flags = ACTION_RECURSE; \
 } while (0)
 
-#if ENABLE_FEATURE_FIND_EXEC
-static unsigned count_subst(const char *str)
-{
-       unsigned count = 0;
-       while ((str = strstr(str, "{}")) != NULL) {
-               count++;
-               str++;
-       }
-       return count;
-}
-
-
-static char* subst(const char *src, unsigned count, const char* filename)
-{
-       char *buf, *dst, *end;
-       size_t flen = strlen(filename);
-       /* we replace each '{}' with filename: growth by strlen-2 */
-       buf = dst = xmalloc(strlen(src) + count*(flen-2) + 1);
-       while ((end = strstr(src, "{}"))) {
-               memcpy(dst, src, end - src);
-               dst += end - src;
-               src = end + 2;
-               memcpy(dst, filename, flen);
-               dst += flen;
-       }
-       strcpy(dst, src);
-       return buf;
-}
-#endif
-
 /* Return values of ACTFs ('action functions') are a bit mask:
  * bit 1=1: prune (use SKIP constant for setting it)
  * bit 0=1: matched successfully (TRUE)
@@ -482,7 +484,6 @@ static int exec_actions(action ***appp, const char *fileName, const struct stat
        return rc ^ TRUE; /* restore TRUE bit */
 }
 
-
 #if !FNM_CASEFOLD
 static char *strcpy_upcase(char *dst, const char *src)
 {
@@ -557,8 +558,8 @@ ACTF(type)
 #if ENABLE_FEATURE_FIND_PERM
 ACTF(perm)
 {
-       /* -perm +mode: at least one of perm_mask bits are set */
-       if (ap->perm_char == '+')
+       /* -perm [+/]mode: at least one of perm_mask bits are set */
+       if (ap->perm_char == '+' || ap->perm_char == '/')
                return (statbuf->st_mode & ap->perm_mask) != 0;
        /* -perm -mode: all of perm_mask are set */
        if (ap->perm_char == '-')
@@ -606,17 +607,57 @@ ACTF(inum)
 }
 #endif
 #if ENABLE_FEATURE_FIND_EXEC
-ACTF(exec)
+static int do_exec(action_exec *ap, const char *fileName)
 {
        int i, rc;
-#if ENABLE_USE_PORTABLE_CODE
-       char **argv = alloca(sizeof(char*) * (ap->exec_argc + 1));
-#else /* gcc 4.3.1 generates smaller code: */
-       char *argv[ap->exec_argc + 1];
-#endif
-       for (i = 0; i < ap->exec_argc; i++)
-               argv[i] = subst(ap->exec_argv[i], ap->subst_count[i], fileName);
-       argv[i] = NULL; /* terminate the list */
+# if ENABLE_FEATURE_FIND_EXEC_PLUS
+       int size = ap->exec_argc + ap->filelist_idx + 1;
+# else
+       int size = ap->exec_argc + 1;
+# endif
+# if ENABLE_USE_PORTABLE_CODE
+       char **argv = alloca(sizeof(char*) * size);
+# else /* gcc 4.3.1 generates smaller code: */
+       char *argv[size];
+# endif
+       char **pp = argv;
+
+       for (i = 0; i < ap->exec_argc; i++) {
+               const char *arg = ap->exec_argv[i];
+
+# if ENABLE_FEATURE_FIND_EXEC_PLUS
+               if (ap->filelist) {
+                       /* Handling "-exec +"
+                        * Only one exec_argv[i] has substitution in it.
+                        * Expand that one exec_argv[i] into file list.
+                        */
+                       if (ap->subst_count[i] == 0) {
+                               *pp++ = xstrdup(arg);
+                       } else {
+                               int j = 0;
+                               while (ap->filelist[j]) {
+                                       /* 2nd arg here should be ap->subst_count[i], but it is always 1: */
+                                       *pp++ = xmalloc_substitute_string(arg, 1, "{}", ap->filelist[j]);
+                                       free(ap->filelist[j]);
+                                       j++;
+                               }
+                       }
+               } else
+# endif
+               {
+                       /* Handling "-exec ;" */
+                       *pp++ = xmalloc_substitute_string(arg, ap->subst_count[i], "{}", fileName);
+               }
+       }
+       *pp = NULL; /* terminate the list */
+
+# if ENABLE_FEATURE_FIND_EXEC_PLUS
+       if (ap->filelist) {
+               ap->filelist[0] = NULL;
+               ap->filelist_idx = 0;
+               ap->file_len = 0;
+       }
+# endif
 
        rc = spawn_and_wait(argv);
        if (rc < 0)
@@ -627,6 +668,48 @@ ACTF(exec)
                free(argv[i++]);
        return rc == 0; /* return 1 if exitcode 0 */
 }
+ACTF(exec)
+{
+# if ENABLE_FEATURE_FIND_EXEC_PLUS
+       if (ap->filelist) {
+               int rc;
+
+               ap->filelist = xrealloc_vector(ap->filelist, 8, ap->filelist_idx);
+               ap->filelist[ap->filelist_idx++] = xstrdup(fileName);
+               ap->file_len += strlen(fileName) + sizeof(char*) + 1;
+               /* If we have lots of files already, exec the command */
+               rc = 1;
+               if (ap->file_len >= G.max_argv_len)
+                       rc = do_exec(ap, NULL);
+               return rc;
+       }
+# endif
+       return do_exec(ap, fileName);
+}
+# if ENABLE_FEATURE_FIND_EXEC_PLUS
+static int flush_exec_plus(void)
+{
+       action *ap;
+       action **app;
+       action ***appp = G.actions;
+       while ((app = *appp++) != NULL) {
+               while ((ap = *app++) != NULL) {
+                       if (ap->f == (action_fp)func_exec) {
+                               action_exec *ae = (void*)ap;
+                               if (ae->filelist_idx != 0) {
+                                       int rc = do_exec(ae, NULL);
+#  if ENABLE_FEATURE_FIND_NOT
+                                       if (ap->invert) rc = !rc;
+#  endif
+                                       if (rc == 0)
+                                               return 1;
+                               }
+                       }
+               }
+       }
+       return 0;
+}
+# endif
 #endif
 #if ENABLE_FEATURE_FIND_USER
 ACTF(user)
@@ -685,7 +768,10 @@ ACTF(delete)
 {
        int rc;
        if (S_ISDIR(statbuf->st_mode)) {
-               rc = rmdir(fileName);
+               /* "find . -delete" skips rmdir(".") */
+               rc = 0;
+               if (NOT_LONE_CHAR(fileName, '.'))
+                       rc = rmdir(fileName);
        } else {
                rc = unlink(fileName);
        }
@@ -798,7 +884,7 @@ static int find_type(const char *type)
                mask = S_IFSOCK;
 
        if (mask == 0 || type[1] != '\0')
-               bb_error_msg_and_die(bb_msg_invalid_arg, type, "-type");
+               bb_error_msg_and_die(bb_msg_invalid_arg_to, type, "-type");
 
        return mask;
 }
@@ -815,6 +901,31 @@ static const char* plus_minus_num(const char* str)
 }
 #endif
 
+/* Say no to GCCism */
+#define USE_NESTED_FUNCTION 0
+
+#if !USE_NESTED_FUNCTION
+struct pp_locals {
+       action*** appp;
+       unsigned cur_group;
+       unsigned cur_action;
+       IF_FEATURE_FIND_NOT( bool invert_flag; )
+};
+static action* alloc_action(struct pp_locals *ppl, int sizeof_struct, action_fp f)
+{
+       action *ap = xzalloc(sizeof_struct);
+       action **app;
+       action ***group = &ppl->appp[ppl->cur_group];
+       *group = app = xrealloc(*group, (ppl->cur_action+2) * sizeof(ppl->appp[0][0]));
+       app[ppl->cur_action++] = ap;
+       app[ppl->cur_action] = NULL;
+       ap->f = f;
+       IF_FEATURE_FIND_NOT( ap->invert = ppl->invert_flag; )
+       IF_FEATURE_FIND_NOT( ppl->invert_flag = 0; )
+       return ap;
+}
+#endif
+
 static action*** parse_params(char **argv)
 {
        enum {
@@ -901,10 +1012,18 @@ static action*** parse_params(char **argv)
        IF_FEATURE_FIND_MAXDEPTH("-mindepth\0""-maxdepth\0")
        ;
 
+#if !USE_NESTED_FUNCTION
+       struct pp_locals ppl;
+#define appp        (ppl.appp       )
+#define cur_group   (ppl.cur_group  )
+#define cur_action  (ppl.cur_action )
+#define invert_flag (ppl.invert_flag)
+#define ALLOC_ACTION(name) (action_##name*)alloc_action(&ppl, sizeof(action_##name), (action_fp) func_##name)
+#else
        action*** appp;
-       unsigned cur_group = 0;
-       unsigned cur_action = 0;
-       IF_FEATURE_FIND_NOT( bool invert_flag = 0; )
+       unsigned cur_group;
+       unsigned cur_action;
+       IF_FEATURE_FIND_NOT( bool invert_flag; )
 
        /* This is the only place in busybox where we use nested function.
         * So far more standard alternatives were bigger. */
@@ -913,7 +1032,7 @@ static action*** parse_params(char **argv)
        action* alloc_action(int sizeof_struct, action_fp f)
        {
                action *ap;
-               appp[cur_group] = xrealloc(appp[cur_group], (cur_action+2) * sizeof(*appp));
+               appp[cur_group] = xrealloc(appp[cur_group], (cur_action+2) * sizeof(appp[0][0]));
                appp[cur_group][cur_action++] = ap = xzalloc(sizeof_struct);
                appp[cur_group][cur_action] = NULL;
                ap->f = f;
@@ -921,9 +1040,12 @@ static action*** parse_params(char **argv)
                IF_FEATURE_FIND_NOT( invert_flag = 0; )
                return ap;
        }
-
 #define ALLOC_ACTION(name) (action_##name*)alloc_action(sizeof(action_##name), (action_fp) func_##name)
+#endif
 
+       cur_group = 0;
+       cur_action = 0;
+       IF_FEATURE_FIND_NOT( invert_flag = 0; )
        appp = xzalloc(2 * sizeof(appp[0])); /* appp[0],[1] == NULL */
 
        while (*argv) {
@@ -949,8 +1071,8 @@ static action*** parse_params(char **argv)
  */
                /* Options */
                if (parm == OPT_FOLLOW) {
-                        dbg("follow enabled: %d", __LINE__);
-                        G.recurse_flags |= ACTION_FOLLOWLINKS | ACTION_DANGLING_OK;
+                       dbg("follow enabled: %d", __LINE__);
+                       G.recurse_flags |= ACTION_FOLLOWLINKS | ACTION_DANGLING_OK;
                }
 #if ENABLE_FEATURE_FIND_XDEV
                else if (parm == OPT_XDEV) {
@@ -988,7 +1110,7 @@ static action*** parse_params(char **argv)
                        dbg("%d", __LINE__);
                        /* start new OR group */
                        cur_group++;
-                       appp = xrealloc(appp, (cur_group+2) * sizeof(*appp));
+                       appp = xrealloc(appp, (cur_group+2) * sizeof(appp[0]));
                        /*appp[cur_group] = NULL; - already NULL */
                        appp[cur_group+1] = NULL;
                        cur_action = 0;
@@ -1031,6 +1153,7 @@ static action*** parse_params(char **argv)
                else if (parm == PARM_exec) {
                        int i;
                        action_exec *ap;
+                       IF_FEATURE_FIND_EXEC_PLUS(int all_subst = 0;)
                        dbg("%d", __LINE__);
                        G.need_print = 0;
                        ap = ALLOC_ACTION(exec);
@@ -1043,10 +1166,13 @@ static action*** parse_params(char **argv)
                                // executes "echo Foo >FILENAME<",
                                // find -exec echo Foo ">{}<" "+"
                                // executes "echo Foo FILENAME1 FILENAME2 FILENAME3...".
-                               // TODO (so far we treat "+" just like ";")
                                if ((argv[0][0] == ';' || argv[0][0] == '+')
                                 && argv[0][1] == '\0'
                                ) {
+# if ENABLE_FEATURE_FIND_EXEC_PLUS
+                                       if (argv[0][0] == '+')
+                                               ap->filelist = xzalloc(sizeof(ap->filelist[0]));
+# endif
                                        break;
                                }
                                argv++;
@@ -1056,8 +1182,17 @@ static action*** parse_params(char **argv)
                                bb_error_msg_and_die(bb_msg_requires_arg, arg);
                        ap->subst_count = xmalloc(ap->exec_argc * sizeof(int));
                        i = ap->exec_argc;
-                       while (i--)
-                               ap->subst_count[i] = count_subst(ap->exec_argv[i]);
+                       while (i--) {
+                               ap->subst_count[i] = count_strstr(ap->exec_argv[i], "{}");
+                               IF_FEATURE_FIND_EXEC_PLUS(all_subst += ap->subst_count[i];)
+                       }
+# if ENABLE_FEATURE_FIND_EXEC_PLUS
+                       /*
+                        * coreutils expects {} to appear only once in "-exec +"
+                        */
+                       if (all_subst != 1 && ap->filelist)
+                               bb_error_msg_and_die("only one '{}' allowed for -exec +");
+# endif
                }
 #endif
 #if ENABLE_FEATURE_FIND_PAREN
@@ -1120,16 +1255,17 @@ static action*** parse_params(char **argv)
 /* -perm BITS   File's mode bits are exactly BITS (octal or symbolic).
  *              Symbolic modes use mode 0 as a point of departure.
  * -perm -BITS  All of the BITS are set in file's mode.
- * -perm +BITS  At least one of the BITS is set in file's mode.
+ * -perm [+/]BITS  At least one of the BITS is set in file's mode.
  */
                else if (parm == PARM_perm) {
                        action_perm *ap;
                        dbg("%d", __LINE__);
                        ap = ALLOC_ACTION(perm);
                        ap->perm_char = arg1[0];
-                       arg1 = plus_minus_num(arg1);
+                       arg1 = (arg1[0] == '/' ? arg1+1 : plus_minus_num(arg1));
                        /*ap->perm_mask = 0; - ALLOC_ACTION did it */
-                       if (!bb_parse_mode(arg1, &ap->perm_mask))
+                       ap->perm_mask = bb_parse_mode(arg1, ap->perm_mask);
+                       if (ap->perm_mask == (mode_t)-1)
                                bb_error_msg_and_die("invalid mode '%s'", arg1);
                }
 #endif
@@ -1246,15 +1382,36 @@ static action*** parse_params(char **argv)
        dbg("exiting %s", __func__);
        return appp;
 #undef ALLOC_ACTION
+#undef appp
+#undef cur_action
+#undef invert_flag
 }
 
 int find_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 int find_main(int argc UNUSED_PARAM, char **argv)
 {
        int i, firstopt, status = EXIT_SUCCESS;
+       char **past_HLP, *saved;
 
        INIT_G();
 
+       /* "find -type f" + getopt("+HLP") => disaster.
+        * Need to avoid getopt running into a non-HLP option.
+        * Do this by temporarily storing NULL there:
+        */
+       past_HLP = argv;
+       for (;;) {
+               saved = *++past_HLP;
+               if (!saved)
+                       break;
+               if (saved[0] != '-')
+                       break;
+               if (!saved[1])
+                       break; /* it is "-" */
+               if ((saved+1)[strspn(saved+1, "HLP")] != '\0')
+                       break;
+       }
+       *past_HLP = NULL;
        /* "+": stop on first non-option */
        i = getopt32(argv, "+HLP");
        if (i & (1<<0))
@@ -1262,7 +1419,8 @@ int find_main(int argc UNUSED_PARAM, char **argv)
        if (i & (1<<1))
                G.recurse_flags |= ACTION_FOLLOWLINKS | ACTION_DANGLING_OK;
        /* -P is default and is ignored */
-       argv += optind;
+       argv = past_HLP; /* same result as "argv += optind;" */
+       *past_HLP = saved;
 
        for (firstopt = 0; argv[firstopt]; firstopt++) {
                if (argv[firstopt][0] == '-')
@@ -1306,9 +1464,10 @@ int find_main(int argc UNUSED_PARAM, char **argv)
                                NULL,           /* user data */
                                0)              /* depth */
                ) {
-                       status = EXIT_FAILURE;
+                       status |= EXIT_FAILURE;
                }
        }
 
+       IF_FEATURE_FIND_EXEC_PLUS(status |= flush_exec_plus();)
        return status;
 }