2 Unix SMB/CIFS implementation.
4 Copyright (C) Andrew Tridgell 1992-2000
5 Copyright (C) Jeremy Allison 1999-2007
6 Copyright (C) Andrew Bartlett <abartlet@samba.org> 2003
7 Copyright (C) Volker Lendecke 2007
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>.
24 #include "../lib/util/memcache.h"
25 #include "smbd/smbd.h"
28 #include "smbprofile.h"
31 /****************************************************************************
32 Stat cache code used in unix_convert.
33 *****************************************************************************/
36 * Add an entry into the stat cache.
38 * @param full_orig_name The original name as specified by the client
39 * @param orig_translated_path The name on our filesystem.
41 * @note Only the first strlen(orig_translated_path) characters are stored
42 * into the cache. This means that full_orig_name will be internally
47 void stat_cache_add( const char *full_orig_name,
48 char *translated_path,
51 size_t translated_path_length;
53 size_t original_path_length;
55 TALLOC_CTX *ctx = talloc_tos();
57 if (!lp_stat_cache()) {
62 * Don't cache trivial valid directory entries such as . and ..
65 if ((*full_orig_name == '\0')
66 || ISDOT(full_orig_name) || ISDOTDOT(full_orig_name)) {
71 * If we are in case insentive mode, we don't need to
72 * store names that need no translation - else, it
76 if (!case_sensitive && (strcmp(full_orig_name, translated_path) == 0)) {
81 * Remove any trailing '/' characters from the
85 translated_path_length = strlen(translated_path);
87 if(translated_path[translated_path_length-1] == '/') {
88 translated_path_length--;
92 original_path = talloc_strdup(ctx,full_orig_name);
94 original_path = talloc_strdup_upper(ctx,full_orig_name);
101 original_path_length = strlen(original_path);
103 if(original_path[original_path_length-1] == '/') {
104 original_path[original_path_length-1] = '\0';
105 original_path_length--;
108 if (original_path_length != translated_path_length) {
109 if (original_path_length < translated_path_length) {
110 DEBUG(0, ("OOPS - tried to store stat cache entry "
111 "for weird length paths [%s] %lu and [%s] %lu)!\n",
113 (unsigned long)original_path_length,
115 (unsigned long)translated_path_length));
116 TALLOC_FREE(original_path);
120 /* we only want to index by the first part of original_path,
121 up to the length of translated_path */
123 original_path[translated_path_length] = '\0';
124 original_path_length = translated_path_length;
127 /* Ensure we're null terminated. */
128 saved_char = translated_path[translated_path_length];
129 translated_path[translated_path_length] = '\0';
132 * New entry or replace old entry.
136 smbd_memcache(), STAT_CACHE,
137 data_blob_const(original_path, original_path_length),
138 data_blob_const(translated_path, translated_path_length + 1));
140 DEBUG(5,("stat_cache_add: Added entry (%lx:size %x) %s -> %s\n",
141 (unsigned long)translated_path,
142 (unsigned int)translated_path_length,
146 translated_path[translated_path_length] = saved_char;
147 TALLOC_FREE(original_path);
151 * Look through the stat cache for an entry
153 * @param conn A connection struct to do the stat() with.
154 * @param posix_paths Whether to lookup using stat() or lstat()
155 * @param name The path we are attempting to cache, modified by this routine
156 * to be correct as far as the cache can tell us. We assume that
157 * it is a talloc'ed string from top of stack, we free it if
159 * @param dirpath The path as far as the stat cache told us. Also talloced
161 * @param start A pointer into name, for where to 'start' in fixing the rest
163 * @param psd A stat buffer, NOT from the cache, but just a side-effect.
165 * @return True if we translated (and did a scuccessful stat on) the entire
170 bool stat_cache_lookup(connection_struct *conn,
175 SMB_STRUCT_STAT *pst)
179 bool sizechanged = False;
180 unsigned int num_components = 0;
181 char *translated_path;
182 size_t translated_path_length;
185 TALLOC_CTX *ctx = talloc_tos();
186 struct smb_filename smb_fname;
190 *pp_start = *pp_name;
192 if (!lp_stat_cache()) {
197 namelen = strlen(name);
199 DO_PROFILE_INC(statcache_lookups);
202 * Don't lookup trivial valid directory entries.
204 if ((*name == '\0') || ISDOT(name) || ISDOTDOT(name)) {
208 if (conn->case_sensitive) {
209 chk_name = talloc_strdup(ctx,name);
211 DEBUG(0, ("stat_cache_lookup: strdup failed!\n"));
216 chk_name = talloc_strdup_upper(ctx,name);
218 DEBUG(0, ("stat_cache_lookup: talloc_strdup_upper failed!\n"));
223 * In some language encodings the length changes
224 * if we uppercase. We need to treat this differently
227 if (strlen(chk_name) != namelen) {
235 data_val = data_blob_null;
238 smbd_memcache(), STAT_CACHE,
239 data_blob_const(chk_name, strlen(chk_name)),
244 DEBUG(10,("stat_cache_lookup: lookup failed for name [%s]\n",
247 * Didn't find it - remove last component for next try.
249 if (!(sp = strrchr_m(chk_name, '/'))) {
251 * We reached the end of the name - no match.
253 DO_PROFILE_INC(statcache_misses);
254 TALLOC_FREE(chk_name);
261 * Count the number of times we have done this, we'll
262 * need it when reconstructing the string.
269 if ((*chk_name == '\0')
270 || ISDOT(chk_name) || ISDOTDOT(chk_name)) {
271 DO_PROFILE_INC(statcache_misses);
272 TALLOC_FREE(chk_name);
277 translated_path = talloc_strdup(ctx,(char *)data_val.data);
278 if (!translated_path) {
279 smb_panic("talloc failed");
281 translated_path_length = data_val.length - 1;
283 DEBUG(10,("stat_cache_lookup: lookup succeeded for name [%s] "
284 "-> [%s]\n", chk_name, translated_path ));
285 DO_PROFILE_INC(statcache_hits);
287 ZERO_STRUCT(smb_fname);
288 smb_fname.base_name = translated_path;
291 ret = SMB_VFS_LSTAT(conn, &smb_fname);
293 ret = SMB_VFS_STAT(conn, &smb_fname);
297 /* Discard this entry - it doesn't exist in the filesystem. */
298 memcache_delete(smbd_memcache(), STAT_CACHE,
299 data_blob_const(chk_name, strlen(chk_name)));
300 TALLOC_FREE(chk_name);
301 TALLOC_FREE(translated_path);
307 memcpy(*pp_name, translated_path,
308 MIN(namelen, translated_path_length));
310 if (num_components == 0) {
311 name = talloc_strndup(ctx, translated_path,
312 translated_path_length);
316 sp = strnrchr_m(name, '/', num_components);
318 name = talloc_asprintf(ctx,"%.*s%s",
319 (int)translated_path_length,
320 translated_path, sp);
322 name = talloc_strndup(ctx,
324 translated_path_length);
329 * TODO: Get us out of here with a real error message
331 smb_panic("talloc failed");
333 TALLOC_FREE(*pp_name);
338 /* set pointer for 'where to start' on fixing the rest of the name */
339 *pp_start = &name[translated_path_length];
340 if (**pp_start == '/') {
344 *pp_dirpath = translated_path;
345 TALLOC_FREE(chk_name);
346 return (namelen == translated_path_length);
349 /***************************************************************************
350 Tell all smbd's to delete an entry.
351 **************************************************************************/
353 void smbd_send_stat_cache_delete_message(struct messaging_context *msg_ctx,
357 messaging_send_all(msg_ctx,
358 MSG_SMB_STAT_CACHE_DELETE,
364 /***************************************************************************
366 **************************************************************************/
368 void stat_cache_delete(const char *name)
370 char *lname = talloc_strdup_upper(talloc_tos(), name);
375 DEBUG(10,("stat_cache_delete: deleting name [%s] -> %s\n",
378 memcache_delete(smbd_memcache(), STAT_CACHE,
379 data_blob_const(lname, talloc_get_size(lname)-1));
383 /***************************************************************
384 Compute a hash value based on a string key value.
385 The function returns the bucket index number for the hashed key.
386 JRA. Use a djb-algorithm hash for speed.
387 ***************************************************************/
389 unsigned int fast_string_hash(TDB_DATA *key)
393 for (p = (const char *)key->dptr; *p != '\0'; p++) {
394 n = ((n << 5) + n) ^ (unsigned int)(*p);
399 /***************************************************************************
400 Initializes or clears the stat cache.
401 **************************************************************************/
403 bool reset_stat_cache( void )
405 if (!lp_stat_cache())
408 memcache_flush(smbd_memcache(), STAT_CACHE);