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/>.
25 #include "smbd/smbd.h"
28 /****************************************************************************
29 Stat cache code used in unix_convert.
30 *****************************************************************************/
33 * Add an entry into the stat cache.
35 * @param full_orig_name The original name as specified by the client
36 * @param orig_translated_path The name on our filesystem.
38 * @note Only the first strlen(orig_translated_path) characters are stored
39 * into the cache. This means that full_orig_name will be internally
44 void stat_cache_add( const char *full_orig_name,
45 char *translated_path,
48 size_t translated_path_length;
50 size_t original_path_length;
52 TALLOC_CTX *ctx = talloc_tos();
54 if (!lp_stat_cache()) {
59 * Don't cache trivial valid directory entries such as . and ..
62 if ((*full_orig_name == '\0')
63 || ISDOT(full_orig_name) || ISDOTDOT(full_orig_name)) {
68 * If we are in case insentive mode, we don't need to
69 * store names that need no translation - else, it
73 if (case_sensitive && (strcmp(full_orig_name, translated_path) == 0)) {
78 * Remove any trailing '/' characters from the
82 translated_path_length = strlen(translated_path);
84 if(translated_path[translated_path_length-1] == '/') {
85 translated_path_length--;
89 original_path = talloc_strdup(ctx,full_orig_name);
91 original_path = talloc_strdup_upper(ctx,full_orig_name);
98 original_path_length = strlen(original_path);
100 if(original_path[original_path_length-1] == '/') {
101 original_path[original_path_length-1] = '\0';
102 original_path_length--;
105 if (original_path_length != translated_path_length) {
106 if (original_path_length < translated_path_length) {
107 DEBUG(0, ("OOPS - tried to store stat cache entry "
108 "for weird length paths [%s] %lu and [%s] %lu)!\n",
110 (unsigned long)original_path_length,
112 (unsigned long)translated_path_length));
113 TALLOC_FREE(original_path);
117 /* we only want to index by the first part of original_path,
118 up to the length of translated_path */
120 original_path[translated_path_length] = '\0';
121 original_path_length = translated_path_length;
124 /* Ensure we're null terminated. */
125 saved_char = translated_path[translated_path_length];
126 translated_path[translated_path_length] = '\0';
129 * New entry or replace old entry.
133 smbd_memcache(), STAT_CACHE,
134 data_blob_const(original_path, original_path_length),
135 data_blob_const(translated_path, translated_path_length + 1));
137 DEBUG(5,("stat_cache_add: Added entry (%lx:size %x) %s -> %s\n",
138 (unsigned long)translated_path,
139 (unsigned int)translated_path_length,
143 translated_path[translated_path_length] = saved_char;
144 TALLOC_FREE(original_path);
148 * Look through the stat cache for an entry
150 * @param conn A connection struct to do the stat() with.
151 * @param name The path we are attempting to cache, modified by this routine
152 * to be correct as far as the cache can tell us. We assume that
153 * it is a talloc'ed string from top of stack, we free it if
155 * @param dirpath The path as far as the stat cache told us. Also talloced
157 * @param start A pointer into name, for where to 'start' in fixing the rest
159 * @param psd A stat buffer, NOT from the cache, but just a side-effect.
161 * @return True if we translated (and did a scuccessful stat on) the entire
166 bool stat_cache_lookup(connection_struct *conn,
170 SMB_STRUCT_STAT *pst)
174 bool sizechanged = False;
175 unsigned int num_components = 0;
176 char *translated_path;
177 size_t translated_path_length;
180 TALLOC_CTX *ctx = talloc_tos();
181 struct smb_filename smb_fname;
184 *pp_start = *pp_name;
186 if (!lp_stat_cache()) {
191 namelen = strlen(name);
193 DO_PROFILE_INC(statcache_lookups);
196 * Don't lookup trivial valid directory entries.
198 if ((*name == '\0') || ISDOT(name) || ISDOTDOT(name)) {
202 if (conn->case_sensitive) {
203 chk_name = talloc_strdup(ctx,name);
205 DEBUG(0, ("stat_cache_lookup: strdup failed!\n"));
210 chk_name = talloc_strdup_upper(ctx,name);
212 DEBUG(0, ("stat_cache_lookup: talloc_strdup_upper failed!\n"));
217 * In some language encodings the length changes
218 * if we uppercase. We need to treat this differently
221 if (strlen(chk_name) != namelen) {
229 data_val = data_blob_null;
232 smbd_memcache(), STAT_CACHE,
233 data_blob_const(chk_name, strlen(chk_name)),
238 DEBUG(10,("stat_cache_lookup: lookup failed for name [%s]\n",
241 * Didn't find it - remove last component for next try.
243 if (!(sp = strrchr_m(chk_name, '/'))) {
245 * We reached the end of the name - no match.
247 DO_PROFILE_INC(statcache_misses);
248 TALLOC_FREE(chk_name);
255 * Count the number of times we have done this, we'll
256 * need it when reconstructing the string.
263 if ((*chk_name == '\0')
264 || ISDOT(chk_name) || ISDOTDOT(chk_name)) {
265 DO_PROFILE_INC(statcache_misses);
266 TALLOC_FREE(chk_name);
271 translated_path = talloc_strdup(ctx,(char *)data_val.data);
272 if (!translated_path) {
273 smb_panic("talloc failed");
275 translated_path_length = data_val.length - 1;
277 DEBUG(10,("stat_cache_lookup: lookup succeeded for name [%s] "
278 "-> [%s]\n", chk_name, translated_path ));
279 DO_PROFILE_INC(statcache_hits);
281 ZERO_STRUCT(smb_fname);
282 smb_fname.base_name = translated_path;
284 if (SMB_VFS_STAT(conn, &smb_fname) != 0) {
285 /* Discard this entry - it doesn't exist in the filesystem. */
286 memcache_delete(smbd_memcache(), STAT_CACHE,
287 data_blob_const(chk_name, strlen(chk_name)));
288 TALLOC_FREE(chk_name);
289 TALLOC_FREE(translated_path);
295 memcpy(*pp_name, translated_path,
296 MIN(namelen, translated_path_length));
298 if (num_components == 0) {
299 name = talloc_strndup(ctx, translated_path,
300 translated_path_length);
304 sp = strnrchr_m(name, '/', num_components);
306 name = talloc_asprintf(ctx,"%.*s%s",
307 (int)translated_path_length,
308 translated_path, sp);
310 name = talloc_strndup(ctx,
312 translated_path_length);
317 * TODO: Get us out of here with a real error message
319 smb_panic("talloc failed");
321 TALLOC_FREE(*pp_name);
326 /* set pointer for 'where to start' on fixing the rest of the name */
327 *pp_start = &name[translated_path_length];
328 if (**pp_start == '/') {
332 *pp_dirpath = translated_path;
333 TALLOC_FREE(chk_name);
334 return (namelen == translated_path_length);
337 /***************************************************************************
338 Tell all smbd's to delete an entry.
339 **************************************************************************/
341 void send_stat_cache_delete_message(struct messaging_context *msg_ctx,
345 message_send_all(msg_ctx,
346 MSG_SMB_STAT_CACHE_DELETE,
353 /***************************************************************************
355 **************************************************************************/
357 void stat_cache_delete(const char *name)
359 char *lname = talloc_strdup_upper(talloc_tos(), name);
364 DEBUG(10,("stat_cache_delete: deleting name [%s] -> %s\n",
367 memcache_delete(smbd_memcache(), STAT_CACHE,
368 data_blob_const(lname, talloc_get_size(lname)-1));
372 /***************************************************************
373 Compute a hash value based on a string key value.
374 The function returns the bucket index number for the hashed key.
375 JRA. Use a djb-algorithm hash for speed.
376 ***************************************************************/
378 unsigned int fast_string_hash(TDB_DATA *key)
382 for (p = (const char *)key->dptr; *p != '\0'; p++) {
383 n = ((n << 5) + n) ^ (unsigned int)(*p);
388 /***************************************************************************
389 Initializes or clears the stat cache.
390 **************************************************************************/
392 bool reset_stat_cache( void )
394 if (!lp_stat_cache())
397 memcache_flush(smbd_memcache(), STAT_CACHE);