File: FileCache.c%2B%2B

package info (click to toggle)
hylafax 1%3A4.2.1-5sarge3
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 6,788 kB
  • ctags: 7,523
  • sloc: sh: 15,597; ansic: 13,040; makefile: 1,772; cpp: 864
file content (257 lines) | stat: -rw-r--r-- 6,415 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
/*	$Id: FileCache.c++,v 1.2 1999/06/13 07:41:12 robert Exp $ */
/*
 * Copyright (c) 1995-1996 Sam Leffler
 * Copyright (c) 1995-1996 Silicon Graphics, Inc.
 * HylaFAX is a trademark of Silicon Graphics
 *
 * Permission to use, copy, modify, distribute, and sell this software and 
 * its documentation for any purpose is hereby granted without fee, provided
 * that (i) the above copyright notices and this permission notice appear in
 * all copies of the software and related documentation, and (ii) the names of
 * Sam Leffler and Silicon Graphics may not be used in any advertising or
 * publicity relating to the software without the specific, prior written
 * permission of Sam Leffler and Silicon Graphics.
 * 
 * THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, 
 * EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY 
 * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.  
 * 
 * IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
 * ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
 * OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
 * WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF 
 * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE 
 * OF THIS SOFTWARE.
 */
#include "FileCache.h"
#include "Sys.h"

u_int FileCache::master = 0;		// master serial number
FileCache* FileCache::cache[4096];	// cache of stat results
#define	CACHESIZE	(sizeof (cache) / sizeof (cache[0]))

					// statistics
u_int FileCache::lookups = 0;		// total # lookups
u_int FileCache::hits = 0;		// # lookups that hit in the cache
u_int FileCache::probes = 0;		// total # probes during lookups
u_int FileCache::displaced = 0;		// # entries reused
u_int FileCache::flushed = 0;		// # entries flushed

void
FileCache::printStats(FILE* fd)
{
    fprintf(fd, "    File cache: %u lookups, %u hits (%.1f%%), %.1f avg probes\r\n"
	, lookups
	, hits
#define	NZ(v)	((v) == 0 ? 1 : (v))
	, (100.*hits)/NZ(lookups)
	, float(lookups+probes)/float(NZ(lookups))
    );
    u_int n = 0;
    u_int space = 0;
    for (u_int i = 0; i < CACHESIZE; i++) {
	const FileCache* fi = cache[i];
	if (fi) {
	    n++;
	    space += sizeof (*fi) + fi->name.length();
	}
    }
    fprintf(fd, "        %u entries (%.1f KB), %u entries displaced, %u entries flushed\r\n"
	, n
	, space / 1024.
	, displaced
	, flushed
    );
}

FileCache::FileCache() {}
FileCache::~FileCache() {}

void
FileCache::reset(void)
{
    for (u_int i = 0; i < CACHESIZE; i++)
	delete cache[i];
    memset(cache, 0, sizeof (cache));
    master = 0;					// doesn't matter???
}

u_int
FileCache::hash(const char* pathname)
{
    u_int h = 0;
    while (*pathname)
	h ^= *pathname++;
    return (h % CACHESIZE);
}

bool
FileCache::lookup(const char* pathname, struct stat& sb, bool addToCache)
{
    lookups++;
    u_int h = hash(pathname);
    u_int maxprobes = 5;
    FileCache* fi = cache[h];
    FileCache* oldest = fi;
    while (fi && --maxprobes) {
	probes++;
	if (fi->name == pathname) {
	    fi->serial = master++;
	    sb = fi->sb;
	    hits++;
	    return (true);
	}
	if (fi->serial < oldest->serial)
	    oldest = fi;
	h = (u_int)(h*h) % CACHESIZE;
	fi = cache[h];
    }
    /*
     * Pathname not found in the cache.
     */
    if (Sys::stat(pathname, sb) < 0)
	return (false);
    if (addToCache && pathname[0] != '.') {
	if (fi) {
	    fi = oldest;
	    displaced++;
	} else
	    fi = cache[h] = new FileCache;
	fi->name = pathname;
	fi->serial = master++;
	fi->sb = sb;
    }
    return (true);
}

/*
 * Update the file mode for any in-cache entry.
 */
bool
FileCache::chmod(const char* pathname, mode_t mode)
{
    if (Sys::chmod(pathname, mode) < 0)
	return (false);
    lookups++;
    u_int h = hash(pathname);
    u_int maxprobes = 5;
    FileCache* fi = cache[h];
    while (fi && --maxprobes) {
	probes++;
	if (fi->name == pathname) {
	    hits++;
	    fi->sb.st_mode = (fi->sb.st_mode&~0777) | (mode&0777);
	    break;
	}
	h = (u_int)(h*h) % CACHESIZE;
	fi = cache[h];
    }
    return (true);
}

/*
 * Update the file ownership for any in-cache entry.
 */
bool
FileCache::chown(const char* pathname, uid_t uid, gid_t gid)
{
    /*
     * For BSD-based systems chown is only permitted
     * by the super-user.  We could optimize this work
     * to not swap the effective uid on System V-based
     * systems but it's not worth it since the majority
     * the calls to chown a file will be done only for
     * BSD-based systems (to deal with the filesystem
     * semantics forcing us to manually set the gid on
     * newly created files.
     */
    uid_t ouid = geteuid();
    (void) seteuid(0);
    bool ok = (Sys::chown(pathname, uid, gid) >= 0);
    (void) seteuid(ouid);
    if (ok) {
	lookups++;
	u_int h = hash(pathname);
	u_int maxprobes = 5;
	FileCache* fi = cache[h];
	while (fi && --maxprobes) {
	    probes++;
	    if (fi->name == pathname) {
		hits++;
		fi->sb.st_uid = uid;
		fi->sb.st_gid = gid;
		break;
	    }
	    h = (u_int)(h*h) % CACHESIZE;
	    fi = cache[h];
	}
    }
    return (ok);
}

/*
 * Like lookup, but if found in the cache, re-do the stat.
 */
bool
FileCache::update(const char* pathname, struct stat& sb, bool addToCache)
{
    lookups++;
    u_int h = hash(pathname);
    u_int maxprobes = 5;
    FileCache* fi = cache[h];
    FileCache* oldest = fi;
    while (fi && --maxprobes) {
	probes++;
	if (fi->name == pathname) {
	    if (Sys::stat(pathname, sb) >= 0) {
		hits++;
		fi->serial = master++;
		fi->sb = sb;
		return (true);
	    } else {
		flushed++;
		cache[h] = NULL;
		delete fi;
		return (false);
	    }
	}
	if (fi->serial < oldest->serial)
	    oldest = fi;
	h = (u_int)(h*h) % CACHESIZE;
	fi = cache[h];
    }
    /*
     * Pathname not found in the cache.
     */
    if (Sys::stat(pathname, sb) < 0)
	return (false);
    if (addToCache && pathname[0] != '.') {
	if (fi) {
	    fi = oldest;
	    displaced++;
	} else
	    fi = cache[h] = new FileCache;
	fi->name = pathname;
	fi->serial = master++;
	fi->sb = sb;
    }
    return (true);
}

void
FileCache::flush(const char* pathname)
{
    u_int h = hash(pathname);
    u_int maxprobes = 5;
    FileCache* fi = cache[h];
    while (fi && --maxprobes) {
	if (fi->name == pathname) {
	    flushed++;
	    cache[h] = NULL;
	    delete fi;
	    break;
	}
	h = (u_int)(h*h) % CACHESIZE;
	fi = cache[h];
    }
}