X-Git-Url: https://git.exim.org/exim.git/blobdiff_plain/19897d528de779d4d3804fd7d10c235e8b50a53e..86ede124f0ce622b4f73e05504abc11fece021e3:/src/src/search.c diff --git a/src/src/search.c b/src/src/search.c index 86363a210..9d1a10a5a 100644 --- a/src/src/search.c +++ b/src/src/search.c @@ -1,10 +1,8 @@ -/* $Cambridge: exim/src/src/search.c,v 1.6 2007/08/29 14:02:22 ph10 Exp $ */ - /************************************************* * Exim - an Internet mail transport agent * *************************************************/ -/* Copyright (c) University of Cambridge 1995 - 2007 */ +/* Copyright (c) University of Cambridge 1995 - 2015 */ /* See the file NOTICE for conditions of use and distribution. */ /* A set of functions to search databases in various formats. An open @@ -43,7 +41,7 @@ static int open_filecount = 0; /* Allow us to reset store used for lookups and lookup caching */ -static void *search_reset_point = NULL; +static rmark search_reset_point = NULL; @@ -64,14 +62,14 @@ Returns: +ve => valid lookup name; value is offset in lookup_list */ int -search_findtype(uschar *name, int len) +search_findtype(const uschar *name, int len) { int bot = 0; int top = lookup_list_count; while (top > bot) { int mid = (top + bot)/2; - int c = Ustrncmp(name, lookup_list[mid].name, len); + int c = Ustrncmp(name, lookup_list[mid]->name, len); /* If c == 0 we have matched the incoming name with the start of the search type name. However, some search types are substrings of others (e.g. nis and @@ -81,9 +79,9 @@ while (top > bot) are testing. By leaving c == 0 when the lengths are different, and doing a > 0 test below, this all falls out correctly. */ - if (c == 0 && Ustrlen(lookup_list[mid].name) == len) + if (c == 0 && Ustrlen(lookup_list[mid]->name) == len) { - if (lookup_list[mid].find != NULL) return mid; + if (lookup_list[mid]->find != NULL) return mid; search_error_message = string_sprintf("lookup type \"%.*s\" is not " "available (not in the binary - check buildtime LOOKUP configuration)", len, name); @@ -123,12 +121,12 @@ Returns: +ve => valid lookup name; value is offset in lookup_list */ int -search_findtype_partial(uschar *name, int *ptypeptr, uschar **ptypeaff, +search_findtype_partial(const uschar *name, int *ptypeptr, const uschar **ptypeaff, int *afflen, int *starflags) { int len, stype; int pv = -1; -uschar *ss = name; +const uschar *ss = name; *starflags = 0; *ptypeaff = NULL; @@ -237,8 +235,8 @@ if (t->left != NULL) tidyup_subtree(t->left); if (t->right != NULL) tidyup_subtree(t->right); if (c != NULL && c->handle != NULL && - lookup_list[c->search_type].close != NULL) - lookup_list[c->search_type].close(c->handle); + lookup_list[c->search_type]->close != NULL) + lookup_list[c->search_type]->close(c->handle); } @@ -251,15 +249,14 @@ Returns: nothing void search_tidyup(void) { -int i; int old_pool = store_pool; -DEBUG(D_lookup) debug_printf("search_tidyup called\n"); +DEBUG(D_lookup) debug_printf_indent("search_tidyup called\n"); /* Close individually each cached open file. */ store_pool = POOL_SEARCH; -if (search_tree != NULL) +if (search_tree) { tidyup_subtree(search_tree); search_tree = NULL; @@ -269,11 +266,10 @@ open_filecount = 0; /* Call the general tidyup entry for any drivers that have one. */ -for (i = 0; i < lookup_list_count; i++) - if (lookup_list[i].tidy != NULL) (lookup_list[i].tidy)(); +for (int i = 0; i < lookup_list_count; i++) if (lookup_list[i]->tidy) + (lookup_list[i]->tidy)(); -if (search_reset_point != NULL) store_reset(search_reset_point); -search_reset_point = NULL; +if (search_reset_point) search_reset_point = store_reset(search_reset_point); store_pool = old_pool; } @@ -335,17 +331,17 @@ search_open(uschar *filename, int search_type, int modemask, uid_t *owners, void *handle; tree_node *t; search_cache *c; -lookup_info *lk = lookup_list + search_type; +lookup_info *lk = lookup_list[search_type]; uschar keybuffer[256]; int old_pool = store_pool; /* Change to the search store pool and remember our reset point */ store_pool = POOL_SEARCH; -if (search_reset_point == NULL) search_reset_point = store_get(0); +if (!search_reset_point) search_reset_point = store_mark(); -DEBUG(D_lookup) debug_printf("search_open: %s \"%s\"\n", lk->name, - (filename == NULL)? US"NULL" : filename); +DEBUG(D_lookup) debug_printf_indent("search_open: %s \"%s\"\n", lk->name, + filename ? filename : US"NULL"); /* See if we already have this open for this type of search, and if so, pass back the tree block as the handle. The key for the tree node is the search @@ -353,18 +349,18 @@ type plus '0' concatenated with the file name. There may be entries in the tree with closed files if a lot of files have been opened. */ sprintf(CS keybuffer, "%c%.254s", search_type + '0', - (filename == NULL)? US"" : filename); + filename ? filename : US""); -if ((t = tree_search(search_tree, keybuffer)) != NULL) +if ((t = tree_search(search_tree, keybuffer))) { c = (search_cache *)(t->data.ptr); - if (c->handle != NULL) + if (c->handle) { - DEBUG(D_lookup) debug_printf(" cached open\n"); + DEBUG(D_lookup) debug_printf_indent(" cached open\n"); store_pool = old_pool; return t; } - DEBUG(D_lookup) debug_printf(" cached closed\n"); + DEBUG(D_lookup) debug_printf_indent(" cached closed\n"); } /* Otherwise, we need to open the file or database - each search type has its @@ -375,20 +371,19 @@ recently used one. */ if (lk->type == lookup_absfile && open_filecount >= lookup_open_max) { - if (open_bot == NULL) + if (!open_bot) log_write(0, LOG_MAIN|LOG_PANIC, "too many lookups open, but can't find " "one to close"); else { search_cache *c = (search_cache *)(open_bot->data.ptr); - DEBUG(D_lookup) debug_printf("Too many lookup files open\n closing %s\n", + DEBUG(D_lookup) debug_printf_indent("Too many lookup files open\n closing %s\n", open_bot->name); - open_bot = c->up; - if (open_bot != NULL) + if ((open_bot = c->up)) ((search_cache *)(open_bot->data.ptr))->down = NULL; else open_top = NULL; - ((lookup_list + c->search_type)->close)(c->handle); + ((lookup_list[c->search_type])->close)(c->handle); c->handle = NULL; open_filecount--; } @@ -397,16 +392,15 @@ if (lk->type == lookup_absfile && open_filecount >= lookup_open_max) /* If opening is successful, call the file-checking function if there is one, and if all is still well, enter the open database into the tree. */ -handle = (lk->open)(filename, &search_error_message); -if (handle == NULL) +if (!(handle = (lk->open)(filename, &search_error_message))) { store_pool = old_pool; return NULL; } -if (lk->check != NULL && - !lk->check(handle, filename, modemask, owners, owngroups, - &search_error_message)) +if ( lk->check + && !lk->check(handle, filename, modemask, owners, owngroups, + &search_error_message)) { lk->close(handle); store_pool = old_pool; @@ -421,10 +415,10 @@ if (lk->type == lookup_absfile) open_filecount++; insert a new entry. On re-use, leave any cached lookup data and the lookup count alone. */ -if (t == NULL) +if (!t) { - t = store_get(sizeof(tree_node) + Ustrlen(keybuffer)); - t->data.ptr = c = store_get(sizeof(search_cache)); + t = store_get(sizeof(tree_node) + Ustrlen(keybuffer), FALSE); + t->data.ptr = c = store_get(sizeof(search_cache), FALSE); c->item_cache = NULL; Ustrcpy(t->name, keybuffer); tree_insertnode(&search_tree, t); @@ -466,9 +460,10 @@ Returns: a pointer to a dynamic string containing the answer, static uschar * internal_search_find(void *handle, uschar *filename, uschar *keystring) { -tree_node *t = (tree_node *)handle; -search_cache *c = (search_cache *)(t->data.ptr); -uschar *data = NULL; +tree_node * t = (tree_node *)handle; +search_cache * c = (search_cache *)(t->data.ptr); +expiring_data * e = NULL; /* compiler quietening */ +uschar * data = NULL; int search_type = t->name[0] - '0'; int old_pool = store_pool; @@ -476,11 +471,11 @@ int old_pool = store_pool; the callers don't have to test for NULL, set an empty string. */ search_error_message = US""; -search_find_defer = FALSE; +f.search_find_defer = FALSE; -DEBUG(D_lookup) debug_printf("internal_search_find: file=\"%s\"\n " +DEBUG(D_lookup) debug_printf_indent("internal_search_find: file=\"%s\"\n " "type=%s key=\"%s\"\n", filename, - lookup_list[search_type].name, keystring); + lookup_list[search_type]->name, keystring); /* Insurance. If the keystring is empty, just fail. */ @@ -493,29 +488,36 @@ store_pool = POOL_SEARCH; /* Look up the data for the key, unless it is already in the cache for this file. No need to check c->item_cache for NULL, tree_search will do so. */ -if ((t = tree_search(c->item_cache, keystring)) == NULL) +if ( (t = tree_search(c->item_cache, keystring)) + && (!(e = t->data.ptr)->expiry || e->expiry > time(NULL)) + ) + { /* Data was in the cache already; set the pointer from the tree node */ + data = e->data.ptr; + DEBUG(D_lookup) debug_printf_indent("cached data used for lookup of %s%s%s\n", + keystring, + filename ? US"\n in " : US"", filename ? filename : US""); + } +else { - BOOL do_cache = TRUE; + uint do_cache = UINT_MAX; int keylength = Ustrlen(keystring); DEBUG(D_lookup) { - if (filename != NULL) - debug_printf("file lookup required for %s\n in %s\n", - keystring, filename); - else - debug_printf("database lookup required for %s\n", keystring); + if (t) debug_printf_indent("cached data found but past valid time; "); + debug_printf_indent("%s lookup required for %s%s%s\n", + filename ? US"file" : US"database", + keystring, + filename ? US"\n in " : US"", filename ? filename : US""); } /* Call the code for the different kinds of search. DEFER is handled like FAIL, except that search_find_defer is set so the caller can distinguish if necessary. */ - if (lookup_list[search_type].find(c->handle, filename, keystring, keylength, + if (lookup_list[search_type]->find(c->handle, filename, keystring, keylength, &data, &search_error_message, &do_cache) == DEFER) - { - search_find_defer = TRUE; - } + f.search_find_defer = TRUE; /* A record that has been found is now in data, which is either NULL or points to a bit of dynamic store. Cache the result of the lookup if @@ -526,10 +528,22 @@ if ((t = tree_search(c->item_cache, keystring)) == NULL) else if (do_cache) { int len = keylength + 1; - t = store_get(sizeof(tree_node) + len); - memcpy(t->name, keystring, len); - t->data.ptr = data; - tree_insertnode(&c->item_cache, t); + + if (t) /* Previous, out-of-date cache entry. Update with the */ + { /* new result and forget the old one */ + e->expiry = do_cache == UINT_MAX ? 0 : time(NULL)+do_cache; + e->data.ptr = data; + } + else + { + e = store_get(sizeof(expiring_data) + sizeof(tree_node) + len, is_tainted(keystring)); + e->expiry = do_cache == UINT_MAX ? 0 : time(NULL)+do_cache; + e->data.ptr = data; + t = (tree_node *)(e+1); + memcpy(t->name, keystring, len); + t->data.ptr = e; + tree_insertnode(&c->item_cache, t); + } } /* If caching was disabled, empty the cache tree. We just set the cache @@ -537,39 +551,24 @@ if ((t = tree_search(c->item_cache, keystring)) == NULL) else { - DEBUG(D_lookup) debug_printf("lookup forced cache cleanup\n"); + DEBUG(D_lookup) debug_printf_indent("lookup forced cache cleanup\n"); c->item_cache = NULL; } } -/* Data was in the cache already; set the pointer from the tree node */ - -else - { - data = US t->data.ptr; - DEBUG(D_lookup) debug_printf("cached data used for lookup of %s%s%s\n", - keystring, - (filename == NULL)? US"" : US"\n in ", - (filename == NULL)? US"" : filename); - } - -/* Debug: output the answer */ - DEBUG(D_lookup) { - if (data == NULL) - { - if (search_find_defer) debug_printf("lookup deferred: %s\n", - search_error_message); - else debug_printf("lookup failed\n"); - } - else debug_printf("lookup yielded: %s\n", data); + if (data) + debug_printf_indent("lookup yielded: %s\n", data); + else if (f.search_find_defer) + debug_printf_indent("lookup deferred: %s\n", search_error_message); + else debug_printf_indent("lookup failed\n"); } /* Return it in new dynamic store in the regular pool */ store_pool = old_pool; -return (data == NULL)? NULL : string_copy(data); +return data ? string_copy(data) : NULL; } @@ -603,7 +602,7 @@ Returns: a pointer to a dynamic string containing the answer, uschar * search_find(void *handle, uschar *filename, uschar *keystring, int partial, - uschar *affix, int affixlen, int starflags, int *expand_setup) + const uschar *affix, int affixlen, int starflags, int *expand_setup) { tree_node *t = (tree_node *)handle; BOOL set_null_wild = FALSE; @@ -612,7 +611,7 @@ uschar *yield; DEBUG(D_lookup) { if (partial < 0) affixlen = 99; /* So that "NULL" prints */ - debug_printf("search_find: file=\"%s\"\n key=\"%s\" " + debug_printf_indent("search_find: file=\"%s\"\n key=\"%s\" " "partial=%d affix=%.*s starflags=%x\n", (filename == NULL)? US"NULL" : filename, keystring, partial, affixlen, affix, starflags); @@ -621,8 +620,8 @@ DEBUG(D_lookup) /* Arrange to put this database at the top of the LRU chain if it is a type that opens real files. */ -if (open_top != (tree_node *)handle && - lookup_list[t->name[0]-'0'].type == lookup_absfile) +if ( open_top != (tree_node *)handle + && lookup_list[t->name[0]-'0']->type == lookup_absfile) { search_cache *c = (search_cache *)(t->data.ptr); tree_node *up = c->up; @@ -632,32 +631,32 @@ if (open_top != (tree_node *)handle && Otherwise there will be a non-NULL up pointer, since we checked above that this block isn't already at the top of the list. */ - if (up != NULL) + if (up) { ((search_cache *)(up->data.ptr))->down = down; - if (down != NULL) + if (down) ((search_cache *)(down->data.ptr))->up = up; - else open_bot = up; + else + open_bot = up; } /* Now put it at the head of the list. */ c->up = NULL; c->down = open_top; - if (open_top == NULL) open_bot = t; else - ((search_cache *)(open_top->data.ptr))->up = t; + if (!open_top) open_bot = t; + else ((search_cache *)(open_top->data.ptr))->up = t; open_top = t; } DEBUG(D_lookup) { - tree_node *t = open_top; - debug_printf("LRU list:\n"); - while (t != NULL) + debug_printf_indent("LRU list:\n"); + for (tree_node *t = open_top; t; ) { search_cache *c = (search_cache *)(t->data.ptr); - debug_printf(" %s\n", t->name); - if (t == open_bot) debug_printf(" End\n"); + debug_printf_indent(" %s\n", t->name); + if (t == open_bot) debug_printf_indent(" End\n"); t = c->down; } } @@ -666,8 +665,9 @@ DEBUG(D_lookup) entry but could have been partial, flag to set up variables. */ yield = internal_search_find(handle, filename, keystring); -if (search_find_defer) return NULL; -if (yield != NULL) { if (partial >= 0) set_null_wild = TRUE; } +if (f.search_find_defer) return NULL; + +if (yield) { if (partial >= 0) set_null_wild = TRUE; } /* Not matched a complete entry; handle partial lookups, but only if the full search didn't defer. Don't use string_sprintf() to construct the initial key, @@ -684,12 +684,13 @@ else if (partial >= 0) if (affixlen == 0) keystring2 = keystring; else { - keystring2 = store_get(len + affixlen + 1); + keystring2 = store_get(len + affixlen + 1, + is_tainted(keystring) || is_tainted(affix)); Ustrncpy(keystring2, affix, affixlen); Ustrcpy(keystring2 + affixlen, keystring); - DEBUG(D_lookup) debug_printf("trying partial match %s\n", keystring2); + DEBUG(D_lookup) debug_printf_indent("trying partial match %s\n", keystring2); yield = internal_search_find(handle, filename, keystring2); - if (search_find_defer) return NULL; + if (f.search_find_defer) return NULL; } /* The key in its entirety did not match a wild entry; try chopping off @@ -725,15 +726,15 @@ else if (partial >= 0) if (affixlen > 0) Ustrncpy(keystring3, affix, affixlen); } - DEBUG(D_lookup) debug_printf("trying partial match %s\n", keystring3); + DEBUG(D_lookup) debug_printf_indent("trying partial match %s\n", keystring3); yield = internal_search_find(handle, filename, keystring3); - if (search_find_defer) return NULL; - if (yield != NULL) + if (f.search_find_defer) return NULL; + if (yield) { /* First variable is the wild part; second is the fixed part. Take care to get it right when keystring3 is just "*". */ - if (expand_setup != NULL && *expand_setup >= 0) + if (expand_setup && *expand_setup >= 0) { int fixedlength = Ustrlen(keystring3) - affixlen; int wildlength = Ustrlen(keystring) - fixedlength - 1; @@ -754,10 +755,10 @@ else if (partial >= 0) } /* If nothing has been matched, but the option to look for "*@" is set, try -replacing everthing to the left of @ by *. After a match, the wild part +replacing everything to the left of @ by *. After a match, the wild part is set to the string to the left of the @. */ -if (yield == NULL && (starflags & SEARCH_STARAT) != 0) +if (!yield && starflags & SEARCH_STARAT) { uschar *atat = Ustrrchr(keystring, '@'); if (atat != NULL && atat > keystring) @@ -766,12 +767,12 @@ if (yield == NULL && (starflags & SEARCH_STARAT) != 0) savechar = *(--atat); *atat = '*'; - DEBUG(D_lookup) debug_printf("trying default match %s\n", atat); + DEBUG(D_lookup) debug_printf_indent("trying default match %s\n", atat); yield = internal_search_find(handle, filename, atat); *atat = savechar; - if (search_find_defer) return NULL; + if (f.search_find_defer) return NULL; - if (yield != NULL && expand_setup != NULL && *expand_setup >= 0) + if (yield && expand_setup && *expand_setup >= 0) { *expand_setup += 1; expand_nstring[*expand_setup] = keystring; @@ -787,11 +788,11 @@ if (yield == NULL && (starflags & SEARCH_STARAT) != 0) try that. If we do match, the first variable (the wild part) is the whole key, and the second is empty. */ -if (yield == NULL && (starflags & (SEARCH_STAR|SEARCH_STARAT)) != 0) +if (!yield && starflags & (SEARCH_STAR|SEARCH_STARAT)) { - DEBUG(D_lookup) debug_printf("trying to match *\n"); + DEBUG(D_lookup) debug_printf_indent("trying to match *\n"); yield = internal_search_find(handle, filename, US"*"); - if (yield != NULL && expand_setup != NULL && *expand_setup >= 0) + if (yield && expand_setup && *expand_setup >= 0) { *expand_setup += 1; expand_nstring[*expand_setup] = keystring; @@ -809,7 +810,7 @@ chopping off any of the domain components, set up the expansion variables fixed part of the domain. The set_null_wild flag is set only when yield is not NULL. */ -if (set_null_wild && expand_setup != NULL && *expand_setup >= 0) +if (set_null_wild && expand_setup && *expand_setup >= 0) { *expand_setup += 1; expand_nstring[*expand_setup] = keystring;