2 Unix SMB/CIFS implementation.
4 Copyright (C) Andrew Tridgell 1992-2000
5 Copyright (C) Jeremy Allison 1999-2000
6 Copyright (C) Andrew Bartlett <abartlet@samba.org> 2003
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 extern BOOL case_sensitive;
27 /****************************************************************************
28 Stat cache code used in unix_convert.
29 *****************************************************************************/
33 char *translated_path;
34 size_t translated_path_length;
35 char names[2]; /* This is extended via malloc... */
38 #define INIT_STAT_CACHE_SIZE 512
39 static hash_table stat_cache;
42 * Add an entry into the stat cache.
44 * @param full_orig_name The original name as specified by the client
45 * @param orig_translated_path The name on our filesystem.
47 * @note Only the first strlen(orig_translated_path) characters are stored
48 * into the cache. This means that full_orig_name will be internally
53 void stat_cache_add( const char *full_orig_name, const char *orig_translated_path)
55 stat_cache_entry *scp;
56 stat_cache_entry *found_scp;
57 char *translated_path;
58 size_t translated_path_length;
61 size_t original_path_length;
63 hash_element *hash_elem;
69 * Don't cache trivial valid directory entries such as . and ..
72 if((*full_orig_name == '\0') || (full_orig_name[0] == '.' &&
73 ((full_orig_name[1] == '\0') ||
74 (full_orig_name[1] == '.' && full_orig_name[1] == '\0'))))
78 * If we are in case insentive mode, we don't need to
79 * store names that need no translation - else, it
83 if(case_sensitive && (strcmp(full_orig_name, orig_translated_path) == 0))
87 * Remove any trailing '/' characters from the
91 translated_path = strdup(orig_translated_path);
95 translated_path_length = strlen(translated_path);
97 if(translated_path[translated_path_length-1] == '/') {
98 translated_path[translated_path_length-1] = '\0';
99 translated_path_length--;
103 original_path = strdup(full_orig_name);
105 original_path = strdup_upper(full_orig_name);
108 if (!original_path) {
109 SAFE_FREE(translated_path);
113 original_path_length = strlen(original_path);
115 if(original_path[original_path_length-1] == '/') {
116 original_path[original_path_length-1] = '\0';
117 original_path_length--;
120 if (original_path_length != translated_path_length) {
121 if (original_path_length < translated_path_length) {
122 DEBUG(0, ("OOPS - tried to store stat cache entry for werid length paths [%s] %u and [%s] %u)!\n",
123 original_path, original_path_length, translated_path, translated_path_length));
124 SAFE_FREE(original_path);
125 SAFE_FREE(translated_path);
129 /* we only want to store the first part of original_path,
130 up to the length of translated_path */
132 original_path[translated_path_length] = '\0';
133 original_path_length = translated_path_length;
137 * Check this name doesn't exist in the cache before we
141 if ((hash_elem = hash_lookup(&stat_cache, original_path))) {
142 found_scp = (stat_cache_entry *)(hash_elem->value);
143 if (strcmp((found_scp->translated_path), orig_translated_path) == 0) {
144 /* already in hash table */
145 SAFE_FREE(original_path);
146 SAFE_FREE(translated_path);
149 /* hash collision - remove before we re-add */
150 hash_remove(&stat_cache, hash_elem);
157 if((scp = (stat_cache_entry *)malloc(sizeof(stat_cache_entry)
158 +original_path_length
159 +translated_path_length)) == NULL) {
160 DEBUG(0,("stat_cache_add: Out of memory !\n"));
161 SAFE_FREE(original_path);
162 SAFE_FREE(translated_path);
166 scp->original_path = scp->names;
167 /* pointer into the structure... */
168 scp->translated_path = scp->names + original_path_length + 1;
169 safe_strcpy(scp->original_path, original_path, original_path_length);
170 safe_strcpy(scp->translated_path, translated_path, translated_path_length);
171 scp->translated_path_length = translated_path_length;
173 hash_insert(&stat_cache, (char *)scp, original_path);
175 SAFE_FREE(original_path);
176 SAFE_FREE(translated_path);
178 DEBUG(5,("stat_cache_add: Added entry %s -> %s\n", scp->original_path, scp->translated_path));
182 * Look through the stat cache for an entry
184 * The hash-table's internals will promote it to the top if found.
186 * @param conn A connection struct to do the stat() with.
187 * @param name The path we are attempting to cache, modified by this routine
188 * to be correct as far as the cache can tell us
189 * @param dirpath The path as far as the stat cache told us.
190 * @param start A pointer into name, for where to 'start' in fixing the rest of the name up.
191 * @param psd A stat buffer, NOT from the cache, but just a side-effect.
193 * @return True if we translated (and did a scuccessful stat on) the entire name.
197 BOOL stat_cache_lookup(connection_struct *conn, pstring name, pstring dirpath,
198 char **start, SMB_STRUCT_STAT *pst)
200 stat_cache_entry *scp;
203 hash_element *hash_elem;
205 BOOL sizechanged = False;
206 unsigned int num_components = 0;
208 if (!lp_stat_cache())
211 namelen = strlen(name);
215 DO_PROFILE_INC(statcache_lookups);
218 * Don't lookup trivial valid directory entries.
220 if((*name == '\0') || (strcmp(name, ".") == 0) || (strcmp(name, "..") == 0)) {
221 DO_PROFILE_INC(statcache_misses);
225 if (case_sensitive) {
226 chk_name = strdup(name);
228 DEBUG(0, ("stat_cache_lookup: strdup failed!\n"));
233 chk_name = strdup_upper(name);
235 DEBUG(0, ("stat_cache_lookup: strdup_upper failed!\n"));
240 * In some language encodings the length changes
241 * if we uppercase. We need to treat this differently
244 if (strlen(chk_name) != namelen)
249 hash_elem = hash_lookup(&stat_cache, chk_name);
250 if(hash_elem == NULL) {
252 * Didn't find it - remove last component for next try.
254 sp = strrchr_m(chk_name, '/');
258 * Count the number of times we have done this,
259 * we'll need it when reconstructing the string.
266 * We reached the end of the name - no match.
268 DO_PROFILE_INC(statcache_misses);
272 if((*chk_name == '\0') || (strcmp(chk_name, ".") == 0)
273 || (strcmp(chk_name, "..") == 0)) {
274 DO_PROFILE_INC(statcache_misses);
279 scp = (stat_cache_entry *)(hash_elem->value);
280 DO_PROFILE_INC(statcache_hits);
281 if(SMB_VFS_STAT(conn,scp->translated_path, pst) != 0) {
282 /* Discard this entry - it doesn't exist in the filesystem. */
283 hash_remove(&stat_cache, hash_elem);
289 memcpy(name, scp->translated_path, MIN(sizeof(pstring)-1, scp->translated_path_length));
290 } else if (num_components == 0) {
291 pstrcpy(name, scp->translated_path);
293 sp = strnrchr_m(name, '/', num_components);
295 pstring last_component;
296 pstrcpy(last_component, sp);
297 pstrcpy(name, scp->translated_path);
298 pstrcat(name, last_component);
300 pstrcpy(name, scp->translated_path);
304 /* set pointer for 'where to start' on fixing the rest of the name */
305 *start = &name[scp->translated_path_length];
309 pstrcpy(dirpath, scp->translated_path);
311 return (namelen == scp->translated_path_length);
316 /*************************************************************************** **
317 * Initializes or clears the stat cache.
322 * ************************************************************************** **
324 BOOL reset_stat_cache( void )
326 static BOOL initialised;
327 if (!lp_stat_cache())
331 hash_clear(&stat_cache);
334 initialised = hash_table_init( &stat_cache, INIT_STAT_CACHE_SIZE,
335 (compare_function)(strcmp));