selftest/Samba4: make use of get_cmd_env_vars() to setup all relevant env variables
[samba.git] / source3 / modules / vfs_preopen.c
index c897ddeeee4fcdec24d2985bcc69b4c5b2ec83bd..d1327f64e581f8d1a448a919357bdd7677954519 100644 (file)
@@ -32,6 +32,9 @@ static int vfs_preopen_debug_level = DBGC_VFS;
 #undef DBGC_CLASS
 #define DBGC_CLASS vfs_preopen_debug_level
 
+#define PREOPEN_MAX_DIGITS 19
+#define PREOPEN_MAX_NUMBER (uint64_t)9999999999999999999ULL
+
 struct preopen_state;
 
 struct preopen_helper {
@@ -49,17 +52,26 @@ struct preopen_state {
        size_t to_read;         /* How many bytes to read in children? */
        int queue_max;
 
+       int queue_dbglvl;       /* DBGLVL_DEBUG by default */
+       int nomatch_dbglvl;     /* DBGLVL_INFO by default */
+       int match_dbglvl;       /* DBGLVL_INFO by default */
+       int reset_dbglvl;       /* DBGLVL_INFO by default */
+       int nodigits_dbglvl;    /* DBGLVL_WARNING by default */
+       int founddigits_dbglvl; /* DBGLVL_NOTICE by default */
+       int push_dbglvl;        /* DBGLVL_NOTICE by default */
+
        char *template_fname;   /* Filename to be sent to children */
        size_t number_start;    /* start offset into "template_fname" */
        int num_digits;         /* How many digits is the number long? */
 
-       int fnum_sent;          /* last fname sent to children */
+       uint64_t fnum_sent;     /* last fname sent to children */
 
-       int fnum_queue_end;     /* last fname to be sent, based on
+       uint64_t fnum_queue_end;/* last fname to be sent, based on
                                 * last open call + preopen:queuelen
                                 */
 
        struct samba_path_matching *preopen_names;
+       ssize_t last_match_idx; /* remember the last match */
 };
 
 static void preopen_helper_destroy(struct preopen_helper *c)
@@ -78,6 +90,16 @@ static void preopen_queue_run(struct preopen_state *state)
        char *pdelimiter;
        char delimiter;
 
+       DBG_PREFIX(state->queue_dbglvl, ("START: "
+                  "last_fname[%s] start_offset=%zu num_digits=%d "
+                  "last_pushed_num=%"PRIu64" queue_end_num=%"PRIu64" num_helpers=%d\n",
+                  state->template_fname,
+                  state->number_start,
+                  state->num_digits,
+                  state->fnum_sent,
+                  state->fnum_queue_end,
+                  state->num_helpers));
+
        pdelimiter = state->template_fname + state->number_start
                + state->num_digits;
        delimiter = *pdelimiter;
@@ -96,15 +118,27 @@ static void preopen_queue_run(struct preopen_state *state)
                }
                if (helper == state->num_helpers) {
                        /* everyone is busy */
+                       DBG_PREFIX(state->queue_dbglvl, ("BUSY: "
+                                  "template_fname[%s] start_offset=%zu num_digits=%d "
+                                  "last_pushed_num=%"PRIu64" queue_end_num=%"PRIu64"\n",
+                                  state->template_fname,
+                                  state->number_start,
+                                  state->num_digits,
+                                  state->fnum_sent,
+                                  state->fnum_queue_end));
                        return;
                }
 
                snprintf(state->template_fname + state->number_start,
                         state->num_digits + 1,
-                        "%.*lu", state->num_digits,
-                        (long unsigned int)(state->fnum_sent + 1));
+                        "%.*llu", state->num_digits,
+                        (long long unsigned int)(state->fnum_sent + 1));
                *pdelimiter = delimiter;
 
+               DBG_PREFIX(state->push_dbglvl, (
+                          "PUSH: fullpath[%s] to helper(idx=%d)\n",
+                          state->template_fname, helper));
+
                to_write = talloc_get_size(state->template_fname);
                written = write_data(state->helpers[helper].fd,
                                     state->template_fname, to_write);
@@ -115,6 +149,14 @@ static void preopen_queue_run(struct preopen_state *state)
                }
                state->fnum_sent += 1;
        }
+       DBG_PREFIX(state->queue_dbglvl, ("END: "
+                  "template_fname[%s] start_offset=%zu num_digits=%d "
+                  "last_pushed_num=%"PRIu64" queue_end_num=%"PRIu64"\n",
+                  state->template_fname,
+                  state->number_start,
+                  state->num_digits,
+                  state->fnum_sent,
+                  state->fnum_queue_end));
 }
 
 static void preopen_helper_readable(struct tevent_context *ev,
@@ -138,7 +180,9 @@ static void preopen_helper_readable(struct tevent_context *ev,
 
        helper->busy = false;
 
+       DBG_PREFIX(state->queue_dbglvl, ("BEFORE: preopen_queue_run\n"));
        preopen_queue_run(state);
+       DBG_PREFIX(state->queue_dbglvl, ("AFTER: preopen_queue_run\n"));
 }
 
 static int preopen_helpers_destructor(struct preopen_state *c)
@@ -334,14 +378,29 @@ static struct preopen_state *preopen_state_get(vfs_handle_struct *handle)
                return NULL;
        }
 
-       status = samba_path_matching_mswild_create(state,
-                                                  true, /* case_sensitive */
-                                                  namelist,
-                                                  &state->preopen_names);
+       state->queue_dbglvl = lp_parm_int(SNUM(handle->conn), "preopen", "queue_log_level", DBGLVL_DEBUG);
+       state->nomatch_dbglvl = lp_parm_int(SNUM(handle->conn), "preopen", "nomatch_log_level", DBGLVL_INFO);
+       state->match_dbglvl = lp_parm_int(SNUM(handle->conn), "preopen", "match_log_level", DBGLVL_INFO);
+       state->reset_dbglvl = lp_parm_int(SNUM(handle->conn), "preopen", "reset_log_level", DBGLVL_INFO);
+       state->nodigits_dbglvl = lp_parm_int(SNUM(handle->conn), "preopen", "nodigits_log_level", DBGLVL_WARNING);
+       state->founddigits_dbglvl = lp_parm_int(SNUM(handle->conn), "preopen", "founddigits_log_level", DBGLVL_NOTICE);
+       state->push_dbglvl = lp_parm_int(SNUM(handle->conn), "preopen", "push_log_level", DBGLVL_NOTICE);
+
+       if (lp_parm_bool(SNUM(handle->conn), "preopen", "posix-basic-regex", false)) {
+               status = samba_path_matching_regex_sub1_create(state,
+                                                              namelist,
+                                                              &state->preopen_names);
+       } else {
+               status = samba_path_matching_mswild_create(state,
+                                                          true, /* case_sensitive */
+                                                          namelist,
+                                                          &state->preopen_names);
+       }
        if (!NT_STATUS_IS_OK(status)) {
                TALLOC_FREE(state);
                return NULL;
        }
+       state->last_match_idx = -1;
 
        if (!SMB_VFS_HANDLE_TEST_DATA(handle)) {
                SMB_VFS_HANDLE_SET_DATA(handle, state, preopen_free_helpers,
@@ -351,14 +410,45 @@ static struct preopen_state *preopen_state_get(vfs_handle_struct *handle)
        return state;
 }
 
-static bool preopen_parse_fname(const char *fname, unsigned long *pnum,
+static bool preopen_parse_fname(const char *fname, uint64_t *pnum,
                                size_t *pstart_idx, int *pnum_digits)
 {
+       char digits[PREOPEN_MAX_DIGITS+1] = { 0, };
        const char *p;
        char *q = NULL;
-       unsigned long num;
+       unsigned long long num;
+       size_t start_idx = 0;
+       int num_digits = -1;
        int error = 0;
 
+       if (*pstart_idx > 0 && *pnum_digits > 0) {
+               /*
+                * If the caller knowns
+                * how many digits are expected
+                * and on what position,
+                * we should copy the exact
+                * subset before we start
+                * parsing the string into a number
+                */
+
+               if (*pnum_digits > PREOPEN_MAX_DIGITS) {
+                       /*
+                        * a string with as much digits as
+                        * PREOPEN_MAX_DIGITS is the longest
+                        * string that would make any sense for us.
+                        *
+                        * The rest will be checked via
+                        * smb_strtoull().
+                        */
+                       return false;
+               }
+               p = fname + *pstart_idx;
+               memcpy(digits, p, *pnum_digits);
+               p = digits;
+               start_idx = *pstart_idx;
+               goto parse;
+       }
+
        p = strrchr_m(fname, '/');
        if (p == NULL) {
                p = fname;
@@ -376,37 +466,83 @@ static bool preopen_parse_fname(const char *fname, unsigned long *pnum,
                return false;
        }
 
-       num = smb_strtoul(p, (char **)&q, 10, &error, SMB_STR_STANDARD);
+       start_idx = (p - fname);
+
+parse:
+       num = smb_strtoull(p, (char **)&q, 10, &error, SMB_STR_STANDARD);
        if (error != 0) {
                return false;
        }
 
-       if (num+1 < num) {
+       if (num >= PREOPEN_MAX_NUMBER) {
                /* overflow */
                return false;
        }
 
+       num_digits = (q - p);
+
+       if (*pnum_digits != -1 && *pnum_digits != num_digits) {
+               /*
+                * If the caller knowns how many digits
+                * it expects we should fail if we got something
+                * different.
+                */
+               return false;
+       }
+
        *pnum = num;
-       *pstart_idx = (p - fname);
-       *pnum_digits = (q - p);
+       *pstart_idx = start_idx;
+       *pnum_digits = num_digits;
        return true;
 }
 
+static uint64_t num_digits_max_value(int num_digits)
+{
+       uint64_t num_max = 1;
+       int i;
+
+       if (num_digits < 1) {
+               return 0;
+       }
+       if (num_digits >= PREOPEN_MAX_DIGITS) {
+               return PREOPEN_MAX_NUMBER;
+       }
+
+       for (i = 0; i < num_digits; i++) {
+               num_max *= 10;
+       }
+
+       /*
+        * We actually want
+        * 9   instead of 10
+        * 99  instead of 100
+        * 999 instead of 1000
+        */
+       return num_max - 1;
+}
+
 static int preopen_openat(struct vfs_handle_struct *handle,
                          const struct files_struct *dirfsp,
                          const struct smb_filename *smb_fname,
                          struct files_struct *fsp,
-                         int flags,
-                         mode_t mode)
+                         const struct vfs_open_how *how)
 {
        const char *dirname = dirfsp->fsp_name->base_name;
        struct preopen_state *state;
        int res;
-       unsigned long num;
+       uint64_t num;
+       uint64_t num_max;
        NTSTATUS status;
+       char *new_template = NULL;
+       size_t new_start = 0;
+       int new_digits = -1;
+       size_t new_end = 0;
        ssize_t match_idx = -1;
+       ssize_t replace_start = -1;
+       ssize_t replace_end = -1;
+       bool need_reset = false;
 
-       DEBUG(10, ("preopen_open called on %s\n", smb_fname_str_dbg(smb_fname)));
+       DBG_DEBUG("called on %s\n", smb_fname_str_dbg(smb_fname));
 
        state = preopen_state_get(handle);
        if (state == NULL) {
@@ -414,21 +550,20 @@ static int preopen_openat(struct vfs_handle_struct *handle,
                                           dirfsp,
                                           smb_fname,
                                           fsp,
-                                          flags,
-                                          mode);
+                                          how);
        }
 
-       res = SMB_VFS_NEXT_OPENAT(handle, dirfsp, smb_fname, fsp, flags, mode);
+       res = SMB_VFS_NEXT_OPENAT(handle, dirfsp, smb_fname, fsp, how);
        if (res == -1) {
                return -1;
        }
 
-       if ((flags & O_ACCMODE) != O_RDONLY) {
+       if ((how->flags & O_ACCMODE) != O_RDONLY) {
                return res;
        }
 
        /*
-        * Make sure we can later contruct an absolute pathname
+        * Make sure we can later construct an absolute pathname
         */
        if (dirname[0] != '/') {
                return res;
@@ -451,30 +586,119 @@ static int preopen_openat(struct vfs_handle_struct *handle,
        status = samba_path_matching_check_last_component(state->preopen_names,
                                                          smb_fname->base_name,
                                                          &match_idx,
-                                                         NULL, /* replace_start */
-                                                         NULL);/* replace_end */
+                                                         &replace_start,
+                                                         &replace_end);
        if (!NT_STATUS_IS_OK(status)) {
                match_idx = -1;
        }
        if (match_idx < 0) {
-               DEBUG(10, ("%s does not match the preopen:names list\n",
-                          smb_fname_str_dbg(smb_fname)));
+               DBG_PREFIX(state->nomatch_dbglvl, (
+                          "No match with the preopen:names list by name[%s]\n",
+                          smb_fname_str_dbg(smb_fname)));
                return res;
        }
 
-       TALLOC_FREE(state->template_fname);
-       state->template_fname = talloc_asprintf(
+       if (replace_start != -1 && replace_end != -1) {
+               DBG_PREFIX(state->match_dbglvl, (
+                          "Pattern(idx=%zd) from preopen:names list matched name[%s] hints(start=%zd,end=%zd)\n",
+                          match_idx, smb_fname_str_dbg(smb_fname), replace_start, replace_end));
+       } else {
+               DBG_PREFIX(state->match_dbglvl, (
+                          "Pattern(idx=%zd) from preopen:names list matched name[%s]\n",
+                          match_idx, smb_fname_str_dbg(smb_fname)));
+       }
+
+       new_template = talloc_asprintf(
                state, "%s/%s",
                dirname, smb_fname->base_name);
-       if (state->template_fname == NULL) {
+       if (new_template == NULL) {
+               DBG_ERR("talloc_asprintf(%s/%s) failed\n",
+                       dirname, smb_fname_str_dbg(smb_fname));
                return res;
        }
 
-       if (!preopen_parse_fname(state->template_fname, &num,
-                                &state->number_start, &state->num_digits)) {
-               TALLOC_FREE(state->template_fname);
+       if (replace_start != -1 && replace_end != -1) {
+               size_t dirofs = strlen(dirname) + 1;
+               new_start = dirofs + replace_start;
+               new_digits = replace_end - replace_start;
+       }
+
+       if (!preopen_parse_fname(new_template, &num,
+                                &new_start, &new_digits)) {
+               DBG_PREFIX(state->nodigits_dbglvl, (
+                          "Pattern(idx=%zd) no valid digits found on fullpath[%s]\n",
+                          match_idx, new_template));
+               TALLOC_FREE(new_template);
                return res;
        }
+       new_end = new_start + new_digits;
+
+       DBG_PREFIX(state->founddigits_dbglvl, (
+                  "Pattern(idx=%zd) found num_digits[%d] start_offset[%zd] parsed_num[%"PRIu64"] fullpath[%s]\n",
+                  match_idx, new_digits, new_start, num, new_template));
+
+       if (state->last_match_idx != match_idx) {
+               /*
+                * If a different pattern caused the match
+                * we better reset the queue
+                */
+               if (state->last_match_idx != -1) {
+                       DBG_PREFIX(state->reset_dbglvl, ("RESET: "
+                                  "pattern changed from idx=%zd to idx=%zd by fullpath[%s]\n",
+                                  state->last_match_idx, match_idx, new_template));
+               }
+               need_reset = true;
+       } else if (state->number_start != new_start) {
+               /*
+                * If the digits started at a different position
+                * we better reset the queue
+                */
+               DBG_PREFIX(state->reset_dbglvl, ("RESET: "
+                          "start_offset changed from byte=%zd to byte=%zd by fullpath[%s]\n",
+                          state->number_start, new_start, new_template));
+               need_reset = true;
+       } else if (state->num_digits != new_digits) {
+               /*
+                * If number of digits changed
+                * we better reset the queue
+                */
+               DBG_PREFIX(state->reset_dbglvl, ("RESET: "
+                          "num_digits changed %d to %d by fullpath[%s]\n",
+                          state->num_digits, new_digits, new_template));
+               need_reset = true;
+       } else if (strncmp(state->template_fname, new_template, new_start) != 0) {
+               /*
+                * If name before the digits changed
+                * we better reset the queue
+                */
+               DBG_PREFIX(state->reset_dbglvl, ("RESET: "
+                          "leading pathprefix[%.*s] changed by fullpath[%s]\n",
+                          (int)state->number_start, state->template_fname, new_template));
+               need_reset = true;
+       } else if (strcmp(state->template_fname + new_end, new_template + new_end) != 0) {
+               /*
+                * If name after the digits changed
+                * we better reset the queue
+                */
+               DBG_PREFIX(state->reset_dbglvl, ("RESET: "
+                          "trailing suffix[%s] changed by fullpath[%s]\n",
+                          state->template_fname + new_end, new_template));
+               need_reset = true;
+       }
+
+       if (need_reset) {
+               /*
+                * Reset the queue
+                */
+               state->fnum_sent = 0;
+               state->fnum_queue_end = 0;
+               state->last_match_idx = match_idx;
+       }
+
+       TALLOC_FREE(state->template_fname);
+       state->template_fname = new_template;
+       state->number_start = new_start;
+       state->num_digits = new_digits;
 
        if (num > state->fnum_sent) {
                /*
@@ -494,9 +718,12 @@ static int preopen_openat(struct vfs_handle_struct *handle,
                state->fnum_sent = num;
        }
 
-       state->fnum_queue_end = num + state->queue_max;
+       num_max = num_digits_max_value(state->num_digits);
+       state->fnum_queue_end = MIN(num_max, num + state->queue_max);
 
+       DBG_PREFIX(state->queue_dbglvl, ("BEFORE: preopen_queue_run\n"));
        preopen_queue_run(state);
+       DBG_PREFIX(state->queue_dbglvl, ("AFTER: preopen_queue_run\n"));
 
        return res;
 }