Commit | Line | Data |
---|---|---|
ddc64d0a | 1 | // SPDX-License-Identifier: GPL-2.0-only |
1da177e4 LT |
2 | /* |
3 | * net/sunrpc/cache.c | |
4 | * | |
5 | * Generic code for various authentication-related caches | |
6 | * used by sunrpc clients and servers. | |
7 | * | |
8 | * Copyright (C) 2002 Neil Brown <neilb@cse.unsw.edu.au> | |
1da177e4 LT |
9 | */ |
10 | ||
11 | #include <linux/types.h> | |
12 | #include <linux/fs.h> | |
13 | #include <linux/file.h> | |
14 | #include <linux/slab.h> | |
15 | #include <linux/signal.h> | |
16 | #include <linux/sched.h> | |
17 | #include <linux/kmod.h> | |
18 | #include <linux/list.h> | |
19 | #include <linux/module.h> | |
20 | #include <linux/ctype.h> | |
1b2e122d | 21 | #include <linux/string_helpers.h> |
7c0f6ba6 | 22 | #include <linux/uaccess.h> |
1da177e4 LT |
23 | #include <linux/poll.h> |
24 | #include <linux/seq_file.h> | |
25 | #include <linux/proc_fs.h> | |
26 | #include <linux/net.h> | |
27 | #include <linux/workqueue.h> | |
4a3e2f71 | 28 | #include <linux/mutex.h> |
da77005f | 29 | #include <linux/pagemap.h> |
1da177e4 LT |
30 | #include <asm/ioctls.h> |
31 | #include <linux/sunrpc/types.h> | |
32 | #include <linux/sunrpc/cache.h> | |
33 | #include <linux/sunrpc/stats.h> | |
8854e82d | 34 | #include <linux/sunrpc/rpc_pipe_fs.h> |
78a947f5 | 35 | #include <trace/events/sunrpc.h> |
37324e6b | 36 | |
4f42d0d5 | 37 | #include "netns.h" |
37324e6b | 38 | #include "fail.h" |
1da177e4 LT |
39 | |
40 | #define RPCDBG_FACILITY RPCDBG_CACHE | |
41 | ||
d76d1815 | 42 | static bool cache_defer_req(struct cache_req *req, struct cache_head *item); |
1da177e4 LT |
43 | static void cache_revisit_request(struct cache_head *item); |
44 | ||
77862036 | 45 | static void cache_init(struct cache_head *h, struct cache_detail *detail) |
1da177e4 | 46 | { |
f559935e | 47 | time64_t now = seconds_since_boot(); |
129e5824 | 48 | INIT_HLIST_NODE(&h->cache_list); |
1da177e4 | 49 | h->flags = 0; |
baab935f | 50 | kref_init(&h->ref); |
1da177e4 | 51 | h->expiry_time = now + CACHE_NEW_EXPIRY; |
77862036 NB |
52 | if (now <= detail->flush_time) |
53 | /* ensure it isn't already expired */ | |
54 | now = detail->flush_time + 1; | |
1da177e4 LT |
55 | h->last_refresh = now; |
56 | } | |
57 | ||
4ecd55ea VA |
58 | static void cache_fresh_unlocked(struct cache_head *head, |
59 | struct cache_detail *detail); | |
60 | ||
ae74136b TM |
61 | static struct cache_head *sunrpc_cache_find_rcu(struct cache_detail *detail, |
62 | struct cache_head *key, | |
63 | int hash) | |
64 | { | |
65 | struct hlist_head *head = &detail->hash_table[hash]; | |
66 | struct cache_head *tmp; | |
67 | ||
68 | rcu_read_lock(); | |
69 | hlist_for_each_entry_rcu(tmp, head, cache_list) { | |
277f27e2 TM |
70 | if (!detail->match(tmp, key)) |
71 | continue; | |
72 | if (test_bit(CACHE_VALID, &tmp->flags) && | |
73 | cache_is_expired(detail, tmp)) | |
74 | continue; | |
75 | tmp = cache_get_rcu(tmp); | |
76 | rcu_read_unlock(); | |
77 | return tmp; | |
ae74136b TM |
78 | } |
79 | rcu_read_unlock(); | |
80 | return NULL; | |
81 | } | |
82 | ||
809fe3c5 TM |
83 | static void sunrpc_begin_cache_remove_entry(struct cache_head *ch, |
84 | struct cache_detail *cd) | |
85 | { | |
86 | /* Must be called under cd->hash_lock */ | |
87 | hlist_del_init_rcu(&ch->cache_list); | |
88 | set_bit(CACHE_CLEANED, &ch->flags); | |
89 | cd->entries --; | |
90 | } | |
91 | ||
92 | static void sunrpc_end_cache_remove_entry(struct cache_head *ch, | |
93 | struct cache_detail *cd) | |
94 | { | |
95 | cache_fresh_unlocked(ch, cd); | |
96 | cache_put(ch, cd); | |
97 | } | |
98 | ||
b92a8fab TM |
99 | static struct cache_head *sunrpc_cache_add_entry(struct cache_detail *detail, |
100 | struct cache_head *key, | |
101 | int hash) | |
102 | { | |
103 | struct cache_head *new, *tmp, *freeme = NULL; | |
104 | struct hlist_head *head = &detail->hash_table[hash]; | |
15a5f6bd N |
105 | |
106 | new = detail->alloc(); | |
107 | if (!new) | |
108 | return NULL; | |
2f34931f NB |
109 | /* must fully initialise 'new', else |
110 | * we might get lose if we need to | |
111 | * cache_put it soon. | |
112 | */ | |
77862036 | 113 | cache_init(new, detail); |
2f34931f | 114 | detail->init(new, key); |
15a5f6bd | 115 | |
1863d77f | 116 | spin_lock(&detail->hash_lock); |
15a5f6bd N |
117 | |
118 | /* check if entry appeared while we slept */ | |
51cae673 AG |
119 | hlist_for_each_entry_rcu(tmp, head, cache_list, |
120 | lockdep_is_held(&detail->hash_lock)) { | |
277f27e2 TM |
121 | if (!detail->match(tmp, key)) |
122 | continue; | |
123 | if (test_bit(CACHE_VALID, &tmp->flags) && | |
124 | cache_is_expired(detail, tmp)) { | |
125 | sunrpc_begin_cache_remove_entry(tmp, detail); | |
78a947f5 | 126 | trace_cache_entry_expired(detail, tmp); |
277f27e2 TM |
127 | freeme = tmp; |
128 | break; | |
15a5f6bd | 129 | } |
277f27e2 TM |
130 | cache_get(tmp); |
131 | spin_unlock(&detail->hash_lock); | |
132 | cache_put(new, detail); | |
133 | return tmp; | |
15a5f6bd | 134 | } |
129e5824 | 135 | |
ae74136b | 136 | hlist_add_head_rcu(&new->cache_list, head); |
15a5f6bd N |
137 | detail->entries++; |
138 | cache_get(new); | |
1863d77f | 139 | spin_unlock(&detail->hash_lock); |
15a5f6bd | 140 | |
809fe3c5 TM |
141 | if (freeme) |
142 | sunrpc_end_cache_remove_entry(freeme, detail); | |
15a5f6bd N |
143 | return new; |
144 | } | |
15a5f6bd | 145 | |
ae74136b TM |
146 | struct cache_head *sunrpc_cache_lookup_rcu(struct cache_detail *detail, |
147 | struct cache_head *key, int hash) | |
148 | { | |
149 | struct cache_head *ret; | |
150 | ||
151 | ret = sunrpc_cache_find_rcu(detail, key, hash); | |
152 | if (ret) | |
153 | return ret; | |
154 | /* Didn't find anything, insert an empty entry */ | |
155 | return sunrpc_cache_add_entry(detail, key, hash); | |
156 | } | |
157 | EXPORT_SYMBOL_GPL(sunrpc_cache_lookup_rcu); | |
158 | ||
f866a819 | 159 | static void cache_dequeue(struct cache_detail *detail, struct cache_head *ch); |
ebd0cb1a | 160 | |
f559935e | 161 | static void cache_fresh_locked(struct cache_head *head, time64_t expiry, |
77862036 | 162 | struct cache_detail *detail) |
ebd0cb1a | 163 | { |
f559935e | 164 | time64_t now = seconds_since_boot(); |
77862036 NB |
165 | if (now <= detail->flush_time) |
166 | /* ensure it isn't immediately treated as expired */ | |
167 | now = detail->flush_time + 1; | |
ebd0cb1a | 168 | head->expiry_time = expiry; |
77862036 | 169 | head->last_refresh = now; |
fdef7aa5 | 170 | smp_wmb(); /* paired with smp_rmb() in cache_is_valid() */ |
908329f2 | 171 | set_bit(CACHE_VALID, &head->flags); |
ebd0cb1a N |
172 | } |
173 | ||
174 | static void cache_fresh_unlocked(struct cache_head *head, | |
908329f2 | 175 | struct cache_detail *detail) |
ebd0cb1a | 176 | { |
ebd0cb1a N |
177 | if (test_and_clear_bit(CACHE_PENDING, &head->flags)) { |
178 | cache_revisit_request(head); | |
f866a819 | 179 | cache_dequeue(detail, head); |
ebd0cb1a N |
180 | } |
181 | } | |
182 | ||
78a947f5 TM |
183 | static void cache_make_negative(struct cache_detail *detail, |
184 | struct cache_head *h) | |
185 | { | |
186 | set_bit(CACHE_NEGATIVE, &h->flags); | |
187 | trace_cache_entry_make_negative(detail, h); | |
188 | } | |
189 | ||
190 | static void cache_entry_update(struct cache_detail *detail, | |
191 | struct cache_head *h, | |
192 | struct cache_head *new) | |
193 | { | |
194 | if (!test_bit(CACHE_NEGATIVE, &new->flags)) { | |
195 | detail->update(h, new); | |
196 | trace_cache_entry_update(detail, h); | |
197 | } else { | |
198 | cache_make_negative(detail, h); | |
199 | } | |
200 | } | |
201 | ||
15a5f6bd N |
202 | struct cache_head *sunrpc_cache_update(struct cache_detail *detail, |
203 | struct cache_head *new, struct cache_head *old, int hash) | |
204 | { | |
205 | /* The 'old' entry is to be replaced by 'new'. | |
206 | * If 'old' is not VALID, we update it directly, | |
207 | * otherwise we need to replace it | |
208 | */ | |
15a5f6bd N |
209 | struct cache_head *tmp; |
210 | ||
211 | if (!test_bit(CACHE_VALID, &old->flags)) { | |
1863d77f | 212 | spin_lock(&detail->hash_lock); |
15a5f6bd | 213 | if (!test_bit(CACHE_VALID, &old->flags)) { |
78a947f5 | 214 | cache_entry_update(detail, old, new); |
77862036 | 215 | cache_fresh_locked(old, new->expiry_time, detail); |
1863d77f | 216 | spin_unlock(&detail->hash_lock); |
908329f2 | 217 | cache_fresh_unlocked(old, detail); |
15a5f6bd N |
218 | return old; |
219 | } | |
1863d77f | 220 | spin_unlock(&detail->hash_lock); |
15a5f6bd N |
221 | } |
222 | /* We need to insert a new entry */ | |
223 | tmp = detail->alloc(); | |
224 | if (!tmp) { | |
baab935f | 225 | cache_put(old, detail); |
15a5f6bd N |
226 | return NULL; |
227 | } | |
77862036 | 228 | cache_init(tmp, detail); |
15a5f6bd | 229 | detail->init(tmp, old); |
15a5f6bd | 230 | |
1863d77f | 231 | spin_lock(&detail->hash_lock); |
78a947f5 | 232 | cache_entry_update(detail, tmp, new); |
129e5824 | 233 | hlist_add_head(&tmp->cache_list, &detail->hash_table[hash]); |
f2d39586 | 234 | detail->entries++; |
15a5f6bd | 235 | cache_get(tmp); |
77862036 NB |
236 | cache_fresh_locked(tmp, new->expiry_time, detail); |
237 | cache_fresh_locked(old, 0, detail); | |
1863d77f | 238 | spin_unlock(&detail->hash_lock); |
908329f2 N |
239 | cache_fresh_unlocked(tmp, detail); |
240 | cache_fresh_unlocked(old, detail); | |
baab935f | 241 | cache_put(old, detail); |
15a5f6bd N |
242 | return tmp; |
243 | } | |
24c3767e | 244 | EXPORT_SYMBOL_GPL(sunrpc_cache_update); |
1da177e4 | 245 | |
b6040f97 | 246 | static inline int cache_is_valid(struct cache_head *h) |
989a19b9 | 247 | { |
d202cce8 | 248 | if (!test_bit(CACHE_VALID, &h->flags)) |
989a19b9 N |
249 | return -EAGAIN; |
250 | else { | |
251 | /* entry is valid */ | |
252 | if (test_bit(CACHE_NEGATIVE, &h->flags)) | |
253 | return -ENOENT; | |
fdef7aa5 BF |
254 | else { |
255 | /* | |
256 | * In combination with write barrier in | |
257 | * sunrpc_cache_update, ensures that anyone | |
258 | * using the cache entry after this sees the | |
259 | * updated contents: | |
260 | */ | |
261 | smp_rmb(); | |
989a19b9 | 262 | return 0; |
fdef7aa5 | 263 | } |
989a19b9 N |
264 | } |
265 | } | |
e9dc1221 | 266 | |
6bab93f8 BF |
267 | static int try_to_negate_entry(struct cache_detail *detail, struct cache_head *h) |
268 | { | |
269 | int rv; | |
270 | ||
1863d77f | 271 | spin_lock(&detail->hash_lock); |
b6040f97 | 272 | rv = cache_is_valid(h); |
2a1c7f53 | 273 | if (rv == -EAGAIN) { |
78a947f5 | 274 | cache_make_negative(detail, h); |
77862036 NB |
275 | cache_fresh_locked(h, seconds_since_boot()+CACHE_NEW_EXPIRY, |
276 | detail); | |
2a1c7f53 | 277 | rv = -ENOENT; |
6bab93f8 | 278 | } |
1863d77f | 279 | spin_unlock(&detail->hash_lock); |
6bab93f8 | 280 | cache_fresh_unlocked(h, detail); |
2a1c7f53 | 281 | return rv; |
6bab93f8 BF |
282 | } |
283 | ||
1da177e4 LT |
284 | /* |
285 | * This is the generic cache management routine for all | |
286 | * the authentication caches. | |
287 | * It checks the currency of a cache item and will (later) | |
288 | * initiate an upcall to fill it if needed. | |
289 | * | |
290 | * | |
291 | * Returns 0 if the cache_head can be used, or cache_puts it and returns | |
989a19b9 N |
292 | * -EAGAIN if upcall is pending and request has been queued |
293 | * -ETIMEDOUT if upcall failed or request could not be queue or | |
294 | * upcall completed but item is still invalid (implying that | |
295 | * the cache item has been replaced with a newer one). | |
1da177e4 LT |
296 | * -ENOENT if cache entry was negative |
297 | */ | |
298 | int cache_check(struct cache_detail *detail, | |
299 | struct cache_head *h, struct cache_req *rqstp) | |
300 | { | |
301 | int rv; | |
f559935e | 302 | time64_t refresh_age, age; |
1da177e4 LT |
303 | |
304 | /* First decide return status as best we can */ | |
b6040f97 | 305 | rv = cache_is_valid(h); |
1da177e4 LT |
306 | |
307 | /* now see if we want to start an upcall */ | |
308 | refresh_age = (h->expiry_time - h->last_refresh); | |
c5b29f88 | 309 | age = seconds_since_boot() - h->last_refresh; |
1da177e4 LT |
310 | |
311 | if (rqstp == NULL) { | |
312 | if (rv == -EAGAIN) | |
313 | rv = -ENOENT; | |
0bebc633 N |
314 | } else if (rv == -EAGAIN || |
315 | (h->expiry_time != 0 && age > refresh_age/2)) { | |
f559935e | 316 | dprintk("RPC: Want update, refage=%lld, age=%lld\n", |
46121cf7 | 317 | refresh_age, age); |
65286b88 TM |
318 | switch (detail->cache_upcall(detail, h)) { |
319 | case -EINVAL: | |
9d69338c | 320 | rv = try_to_negate_entry(detail, h); |
65286b88 TM |
321 | break; |
322 | case -EAGAIN: | |
323 | cache_fresh_unlocked(h, detail); | |
324 | break; | |
325 | } | |
1da177e4 LT |
326 | } |
327 | ||
989a19b9 | 328 | if (rv == -EAGAIN) { |
d76d1815 BF |
329 | if (!cache_defer_req(rqstp, h)) { |
330 | /* | |
331 | * Request was not deferred; handle it as best | |
332 | * we can ourselves: | |
333 | */ | |
b6040f97 | 334 | rv = cache_is_valid(h); |
989a19b9 N |
335 | if (rv == -EAGAIN) |
336 | rv = -ETIMEDOUT; | |
337 | } | |
338 | } | |
4013edea | 339 | if (rv) |
baab935f | 340 | cache_put(h, detail); |
1da177e4 LT |
341 | return rv; |
342 | } | |
24c3767e | 343 | EXPORT_SYMBOL_GPL(cache_check); |
1da177e4 | 344 | |
1da177e4 LT |
345 | /* |
346 | * caches need to be periodically cleaned. | |
347 | * For this we maintain a list of cache_detail and | |
348 | * a current pointer into that list and into the table | |
349 | * for that entry. | |
350 | * | |
013920eb | 351 | * Each time cache_clean is called it finds the next non-empty entry |
1da177e4 LT |
352 | * in the current table and walks the list in that entry |
353 | * looking for entries that can be removed. | |
354 | * | |
355 | * An entry gets removed if: | |
356 | * - The expiry is before current time | |
357 | * - The last_refresh time is before the flush_time for that cache | |
358 | * | |
359 | * later we might drop old entries with non-NEVER expiry if that table | |
360 | * is getting 'full' for some definition of 'full' | |
361 | * | |
362 | * The question of "how often to scan a table" is an interesting one | |
363 | * and is answered in part by the use of the "nextcheck" field in the | |
364 | * cache_detail. | |
365 | * When a scan of a table begins, the nextcheck field is set to a time | |
366 | * that is well into the future. | |
367 | * While scanning, if an expiry time is found that is earlier than the | |
368 | * current nextcheck time, nextcheck is set to that expiry time. | |
369 | * If the flush_time is ever set to a time earlier than the nextcheck | |
370 | * time, the nextcheck time is then set to that flush_time. | |
371 | * | |
372 | * A table is then only scanned if the current time is at least | |
373 | * the nextcheck time. | |
cca5172a | 374 | * |
1da177e4 LT |
375 | */ |
376 | ||
377 | static LIST_HEAD(cache_list); | |
378 | static DEFINE_SPINLOCK(cache_list_lock); | |
379 | static struct cache_detail *current_detail; | |
380 | static int current_index; | |
381 | ||
65f27f38 | 382 | static void do_cache_clean(struct work_struct *work); |
8eab945c | 383 | static struct delayed_work cache_cleaner; |
1da177e4 | 384 | |
820f9442 | 385 | void sunrpc_init_cache_detail(struct cache_detail *cd) |
ffe9386b | 386 | { |
1863d77f | 387 | spin_lock_init(&cd->hash_lock); |
1da177e4 LT |
388 | INIT_LIST_HEAD(&cd->queue); |
389 | spin_lock(&cache_list_lock); | |
390 | cd->nextcheck = 0; | |
391 | cd->entries = 0; | |
64a38e84 | 392 | atomic_set(&cd->writers, 0); |
1da177e4 LT |
393 | cd->last_close = 0; |
394 | cd->last_warn = -1; | |
395 | list_add(&cd->others, &cache_list); | |
396 | spin_unlock(&cache_list_lock); | |
397 | ||
398 | /* start the cleaning process */ | |
77b00bc0 | 399 | queue_delayed_work(system_power_efficient_wq, &cache_cleaner, 0); |
1da177e4 | 400 | } |
820f9442 | 401 | EXPORT_SYMBOL_GPL(sunrpc_init_cache_detail); |
1da177e4 | 402 | |
820f9442 | 403 | void sunrpc_destroy_cache_detail(struct cache_detail *cd) |
1da177e4 LT |
404 | { |
405 | cache_purge(cd); | |
406 | spin_lock(&cache_list_lock); | |
1863d77f | 407 | spin_lock(&cd->hash_lock); |
1da177e4 LT |
408 | if (current_detail == cd) |
409 | current_detail = NULL; | |
410 | list_del_init(&cd->others); | |
1863d77f | 411 | spin_unlock(&cd->hash_lock); |
1da177e4 | 412 | spin_unlock(&cache_list_lock); |
1da177e4 LT |
413 | if (list_empty(&cache_list)) { |
414 | /* module must be being unloaded so its safe to kill the worker */ | |
4011cd97 | 415 | cancel_delayed_work_sync(&cache_cleaner); |
1da177e4 | 416 | } |
1da177e4 | 417 | } |
820f9442 | 418 | EXPORT_SYMBOL_GPL(sunrpc_destroy_cache_detail); |
1da177e4 LT |
419 | |
420 | /* clean cache tries to find something to clean | |
421 | * and cleans it. | |
422 | * It returns 1 if it cleaned something, | |
423 | * 0 if it didn't find anything this time | |
424 | * -1 if it fell off the end of the list. | |
425 | */ | |
426 | static int cache_clean(void) | |
427 | { | |
428 | int rv = 0; | |
429 | struct list_head *next; | |
430 | ||
431 | spin_lock(&cache_list_lock); | |
432 | ||
433 | /* find a suitable table if we don't already have one */ | |
434 | while (current_detail == NULL || | |
435 | current_index >= current_detail->hash_size) { | |
436 | if (current_detail) | |
437 | next = current_detail->others.next; | |
438 | else | |
439 | next = cache_list.next; | |
440 | if (next == &cache_list) { | |
441 | current_detail = NULL; | |
442 | spin_unlock(&cache_list_lock); | |
443 | return -1; | |
444 | } | |
445 | current_detail = list_entry(next, struct cache_detail, others); | |
c5b29f88 | 446 | if (current_detail->nextcheck > seconds_since_boot()) |
1da177e4 LT |
447 | current_index = current_detail->hash_size; |
448 | else { | |
449 | current_index = 0; | |
c5b29f88 | 450 | current_detail->nextcheck = seconds_since_boot()+30*60; |
1da177e4 LT |
451 | } |
452 | } | |
453 | ||
454 | /* find a non-empty bucket in the table */ | |
455 | while (current_detail && | |
456 | current_index < current_detail->hash_size && | |
129e5824 | 457 | hlist_empty(¤t_detail->hash_table[current_index])) |
1da177e4 LT |
458 | current_index++; |
459 | ||
460 | /* find a cleanable entry in the bucket and clean it, or set to next bucket */ | |
cca5172a | 461 | |
1da177e4 | 462 | if (current_detail && current_index < current_detail->hash_size) { |
129e5824 | 463 | struct cache_head *ch = NULL; |
1da177e4 | 464 | struct cache_detail *d; |
129e5824 KM |
465 | struct hlist_head *head; |
466 | struct hlist_node *tmp; | |
cca5172a | 467 | |
1863d77f | 468 | spin_lock(¤t_detail->hash_lock); |
1da177e4 LT |
469 | |
470 | /* Ok, now to clean this strand */ | |
cca5172a | 471 | |
129e5824 KM |
472 | head = ¤t_detail->hash_table[current_index]; |
473 | hlist_for_each_entry_safe(ch, tmp, head, cache_list) { | |
1da177e4 LT |
474 | if (current_detail->nextcheck > ch->expiry_time) |
475 | current_detail->nextcheck = ch->expiry_time+1; | |
2f50d8b6 | 476 | if (!cache_is_expired(current_detail, ch)) |
1da177e4 | 477 | continue; |
1da177e4 | 478 | |
809fe3c5 | 479 | sunrpc_begin_cache_remove_entry(ch, current_detail); |
78a947f5 | 480 | trace_cache_entry_expired(current_detail, ch); |
1da177e4 | 481 | rv = 1; |
3af4974e | 482 | break; |
1da177e4 | 483 | } |
3af4974e | 484 | |
1863d77f | 485 | spin_unlock(¤t_detail->hash_lock); |
1da177e4 LT |
486 | d = current_detail; |
487 | if (!ch) | |
488 | current_index ++; | |
489 | spin_unlock(&cache_list_lock); | |
809fe3c5 TM |
490 | if (ch) |
491 | sunrpc_end_cache_remove_entry(ch, d); | |
1da177e4 LT |
492 | } else |
493 | spin_unlock(&cache_list_lock); | |
494 | ||
495 | return rv; | |
496 | } | |
497 | ||
498 | /* | |
499 | * We want to regularly clean the cache, so we need to schedule some work ... | |
500 | */ | |
65f27f38 | 501 | static void do_cache_clean(struct work_struct *work) |
1da177e4 | 502 | { |
0aa99c4d | 503 | int delay; |
1da177e4 LT |
504 | |
505 | if (list_empty(&cache_list)) | |
0aa99c4d BF |
506 | return; |
507 | ||
508 | if (cache_clean() == -1) | |
509 | delay = round_jiffies_relative(30*HZ); | |
510 | else | |
511 | delay = 5; | |
1da177e4 | 512 | |
0aa99c4d | 513 | queue_delayed_work(system_power_efficient_wq, &cache_cleaner, delay); |
1da177e4 LT |
514 | } |
515 | ||
516 | ||
cca5172a | 517 | /* |
1da177e4 | 518 | * Clean all caches promptly. This just calls cache_clean |
cca5172a | 519 | * repeatedly until we are sure that every cache has had a chance to |
1da177e4 LT |
520 | * be fully cleaned |
521 | */ | |
522 | void cache_flush(void) | |
523 | { | |
524 | while (cache_clean() != -1) | |
525 | cond_resched(); | |
526 | while (cache_clean() != -1) | |
527 | cond_resched(); | |
528 | } | |
24c3767e | 529 | EXPORT_SYMBOL_GPL(cache_flush); |
1da177e4 LT |
530 | |
531 | void cache_purge(struct cache_detail *detail) | |
532 | { | |
471a930a KM |
533 | struct cache_head *ch = NULL; |
534 | struct hlist_head *head = NULL; | |
471a930a KM |
535 | int i = 0; |
536 | ||
1863d77f | 537 | spin_lock(&detail->hash_lock); |
471a930a | 538 | if (!detail->entries) { |
1863d77f | 539 | spin_unlock(&detail->hash_lock); |
471a930a KM |
540 | return; |
541 | } | |
542 | ||
543 | dprintk("RPC: %d entries in %s cache\n", detail->entries, detail->name); | |
544 | for (i = 0; i < detail->hash_size; i++) { | |
545 | head = &detail->hash_table[i]; | |
43e33924 YW |
546 | while (!hlist_empty(head)) { |
547 | ch = hlist_entry(head->first, struct cache_head, | |
548 | cache_list); | |
809fe3c5 | 549 | sunrpc_begin_cache_remove_entry(ch, detail); |
1863d77f | 550 | spin_unlock(&detail->hash_lock); |
809fe3c5 | 551 | sunrpc_end_cache_remove_entry(ch, detail); |
1863d77f | 552 | spin_lock(&detail->hash_lock); |
471a930a KM |
553 | } |
554 | } | |
1863d77f | 555 | spin_unlock(&detail->hash_lock); |
1da177e4 | 556 | } |
24c3767e | 557 | EXPORT_SYMBOL_GPL(cache_purge); |
1da177e4 LT |
558 | |
559 | ||
560 | /* | |
561 | * Deferral and Revisiting of Requests. | |
562 | * | |
563 | * If a cache lookup finds a pending entry, we | |
564 | * need to defer the request and revisit it later. | |
565 | * All deferred requests are stored in a hash table, | |
566 | * indexed by "struct cache_head *". | |
567 | * As it may be wasteful to store a whole request | |
cca5172a | 568 | * structure, we allow the request to provide a |
1da177e4 LT |
569 | * deferred form, which must contain a |
570 | * 'struct cache_deferred_req' | |
571 | * This cache_deferred_req contains a method to allow | |
572 | * it to be revisited when cache info is available | |
573 | */ | |
574 | ||
575 | #define DFR_HASHSIZE (PAGE_SIZE/sizeof(struct list_head)) | |
576 | #define DFR_HASH(item) ((((long)item)>>4 ^ (((long)item)>>13)) % DFR_HASHSIZE) | |
577 | ||
578 | #define DFR_MAX 300 /* ??? */ | |
579 | ||
580 | static DEFINE_SPINLOCK(cache_defer_lock); | |
581 | static LIST_HEAD(cache_defer_list); | |
11174492 | 582 | static struct hlist_head cache_defer_hash[DFR_HASHSIZE]; |
1da177e4 LT |
583 | static int cache_defer_cnt; |
584 | ||
6610f720 BF |
585 | static void __unhash_deferred_req(struct cache_deferred_req *dreq) |
586 | { | |
11174492 | 587 | hlist_del_init(&dreq->hash); |
e33534d5 N |
588 | if (!list_empty(&dreq->recent)) { |
589 | list_del_init(&dreq->recent); | |
590 | cache_defer_cnt--; | |
591 | } | |
6610f720 BF |
592 | } |
593 | ||
594 | static void __hash_deferred_req(struct cache_deferred_req *dreq, struct cache_head *item) | |
1da177e4 | 595 | { |
1da177e4 LT |
596 | int hash = DFR_HASH(item); |
597 | ||
e33534d5 | 598 | INIT_LIST_HEAD(&dreq->recent); |
11174492 | 599 | hlist_add_head(&dreq->hash, &cache_defer_hash[hash]); |
6610f720 BF |
600 | } |
601 | ||
e33534d5 N |
602 | static void setup_deferral(struct cache_deferred_req *dreq, |
603 | struct cache_head *item, | |
604 | int count_me) | |
1da177e4 | 605 | { |
1da177e4 LT |
606 | |
607 | dreq->item = item; | |
1da177e4 LT |
608 | |
609 | spin_lock(&cache_defer_lock); | |
610 | ||
6610f720 | 611 | __hash_deferred_req(dreq, item); |
1da177e4 | 612 | |
e33534d5 N |
613 | if (count_me) { |
614 | cache_defer_cnt++; | |
615 | list_add(&dreq->recent, &cache_defer_list); | |
1da177e4 | 616 | } |
e33534d5 | 617 | |
1da177e4 LT |
618 | spin_unlock(&cache_defer_lock); |
619 | ||
3211af11 | 620 | } |
f16b6e8d | 621 | |
3211af11 BF |
622 | struct thread_deferred_req { |
623 | struct cache_deferred_req handle; | |
624 | struct completion completion; | |
625 | }; | |
626 | ||
627 | static void cache_restart_thread(struct cache_deferred_req *dreq, int too_many) | |
628 | { | |
629 | struct thread_deferred_req *dr = | |
630 | container_of(dreq, struct thread_deferred_req, handle); | |
631 | complete(&dr->completion); | |
632 | } | |
633 | ||
d29068c4 | 634 | static void cache_wait_req(struct cache_req *req, struct cache_head *item) |
3211af11 BF |
635 | { |
636 | struct thread_deferred_req sleeper; | |
637 | struct cache_deferred_req *dreq = &sleeper.handle; | |
3211af11 BF |
638 | |
639 | sleeper.completion = COMPLETION_INITIALIZER_ONSTACK(sleeper.completion); | |
640 | dreq->revisit = cache_restart_thread; | |
641 | ||
e33534d5 | 642 | setup_deferral(dreq, item, 0); |
3211af11 | 643 | |
d29068c4 | 644 | if (!test_bit(CACHE_PENDING, &item->flags) || |
277f68db | 645 | wait_for_completion_interruptible_timeout( |
3211af11 BF |
646 | &sleeper.completion, req->thread_wait) <= 0) { |
647 | /* The completion wasn't completed, so we need | |
648 | * to clean up | |
649 | */ | |
650 | spin_lock(&cache_defer_lock); | |
11174492 | 651 | if (!hlist_unhashed(&sleeper.handle.hash)) { |
3211af11 BF |
652 | __unhash_deferred_req(&sleeper.handle); |
653 | spin_unlock(&cache_defer_lock); | |
654 | } else { | |
655 | /* cache_revisit_request already removed | |
656 | * this from the hash table, but hasn't | |
657 | * called ->revisit yet. It will very soon | |
658 | * and we need to wait for it. | |
f16b6e8d | 659 | */ |
3211af11 BF |
660 | spin_unlock(&cache_defer_lock); |
661 | wait_for_completion(&sleeper.completion); | |
f16b6e8d | 662 | } |
3211af11 | 663 | } |
3211af11 BF |
664 | } |
665 | ||
e33534d5 | 666 | static void cache_limit_defers(void) |
3211af11 | 667 | { |
e33534d5 N |
668 | /* Make sure we haven't exceed the limit of allowed deferred |
669 | * requests. | |
670 | */ | |
671 | struct cache_deferred_req *discard = NULL; | |
3211af11 | 672 | |
e33534d5 N |
673 | if (cache_defer_cnt <= DFR_MAX) |
674 | return; | |
d29068c4 | 675 | |
e33534d5 N |
676 | spin_lock(&cache_defer_lock); |
677 | ||
678 | /* Consider removing either the first or the last */ | |
679 | if (cache_defer_cnt > DFR_MAX) { | |
8032bf12 | 680 | if (get_random_u32_below(2)) |
e33534d5 N |
681 | discard = list_entry(cache_defer_list.next, |
682 | struct cache_deferred_req, recent); | |
683 | else | |
684 | discard = list_entry(cache_defer_list.prev, | |
685 | struct cache_deferred_req, recent); | |
686 | __unhash_deferred_req(discard); | |
687 | } | |
688 | spin_unlock(&cache_defer_lock); | |
cd68c374 | 689 | if (discard) |
cd68c374 | 690 | discard->revisit(discard, 1); |
e33534d5 | 691 | } |
cd68c374 | 692 | |
37324e6b CL |
693 | #if IS_ENABLED(CONFIG_FAIL_SUNRPC) |
694 | static inline bool cache_defer_immediately(void) | |
695 | { | |
696 | return !fail_sunrpc.ignore_cache_wait && | |
697 | should_fail(&fail_sunrpc.attr, 1); | |
698 | } | |
699 | #else | |
700 | static inline bool cache_defer_immediately(void) | |
701 | { | |
702 | return false; | |
703 | } | |
704 | #endif | |
705 | ||
d76d1815 BF |
706 | /* Return true if and only if a deferred request is queued. */ |
707 | static bool cache_defer_req(struct cache_req *req, struct cache_head *item) | |
e33534d5 N |
708 | { |
709 | struct cache_deferred_req *dreq; | |
d29068c4 | 710 | |
37324e6b | 711 | if (!cache_defer_immediately()) { |
d29068c4 N |
712 | cache_wait_req(req, item); |
713 | if (!test_bit(CACHE_PENDING, &item->flags)) | |
d76d1815 | 714 | return false; |
1da177e4 | 715 | } |
37324e6b | 716 | |
3211af11 BF |
717 | dreq = req->defer(req); |
718 | if (dreq == NULL) | |
d76d1815 | 719 | return false; |
e33534d5 | 720 | setup_deferral(dreq, item, 1); |
d29068c4 N |
721 | if (!test_bit(CACHE_PENDING, &item->flags)) |
722 | /* Bit could have been cleared before we managed to | |
723 | * set up the deferral, so need to revisit just in case | |
724 | */ | |
725 | cache_revisit_request(item); | |
e33534d5 N |
726 | |
727 | cache_limit_defers(); | |
d76d1815 | 728 | return true; |
1da177e4 LT |
729 | } |
730 | ||
731 | static void cache_revisit_request(struct cache_head *item) | |
732 | { | |
733 | struct cache_deferred_req *dreq; | |
734 | struct list_head pending; | |
b67bfe0d | 735 | struct hlist_node *tmp; |
1da177e4 LT |
736 | int hash = DFR_HASH(item); |
737 | ||
738 | INIT_LIST_HEAD(&pending); | |
739 | spin_lock(&cache_defer_lock); | |
cca5172a | 740 | |
b67bfe0d | 741 | hlist_for_each_entry_safe(dreq, tmp, &cache_defer_hash[hash], hash) |
11174492 N |
742 | if (dreq->item == item) { |
743 | __unhash_deferred_req(dreq); | |
744 | list_add(&dreq->recent, &pending); | |
1da177e4 | 745 | } |
11174492 | 746 | |
1da177e4 LT |
747 | spin_unlock(&cache_defer_lock); |
748 | ||
749 | while (!list_empty(&pending)) { | |
750 | dreq = list_entry(pending.next, struct cache_deferred_req, recent); | |
751 | list_del_init(&dreq->recent); | |
752 | dreq->revisit(dreq, 0); | |
753 | } | |
754 | } | |
755 | ||
756 | void cache_clean_deferred(void *owner) | |
757 | { | |
758 | struct cache_deferred_req *dreq, *tmp; | |
759 | struct list_head pending; | |
760 | ||
761 | ||
762 | INIT_LIST_HEAD(&pending); | |
763 | spin_lock(&cache_defer_lock); | |
cca5172a | 764 | |
1da177e4 LT |
765 | list_for_each_entry_safe(dreq, tmp, &cache_defer_list, recent) { |
766 | if (dreq->owner == owner) { | |
6610f720 | 767 | __unhash_deferred_req(dreq); |
e95dffa4 | 768 | list_add(&dreq->recent, &pending); |
1da177e4 LT |
769 | } |
770 | } | |
771 | spin_unlock(&cache_defer_lock); | |
772 | ||
773 | while (!list_empty(&pending)) { | |
774 | dreq = list_entry(pending.next, struct cache_deferred_req, recent); | |
775 | list_del_init(&dreq->recent); | |
776 | dreq->revisit(dreq, 1); | |
777 | } | |
778 | } | |
779 | ||
780 | /* | |
781 | * communicate with user-space | |
782 | * | |
6489a8f4 | 783 | * We have a magic /proc file - /proc/net/rpc/<cachename>/channel. |
a490c681 BF |
784 | * On read, you get a full request, or block. |
785 | * On write, an update request is processed. | |
786 | * Poll works if anything to read, and always allows write. | |
1da177e4 | 787 | * |
cca5172a | 788 | * Implemented by linked list of requests. Each open file has |
a490c681 | 789 | * a ->private that also exists in this list. New requests are added |
1da177e4 LT |
790 | * to the end and may wakeup and preceding readers. |
791 | * New readers are added to the head. If, on read, an item is found with | |
792 | * CACHE_UPCALLING clear, we free it from the list. | |
793 | * | |
794 | */ | |
795 | ||
796 | static DEFINE_SPINLOCK(queue_lock); | |
1da177e4 LT |
797 | |
798 | struct cache_queue { | |
799 | struct list_head list; | |
800 | int reader; /* if 0, then request */ | |
801 | }; | |
802 | struct cache_request { | |
803 | struct cache_queue q; | |
804 | struct cache_head *item; | |
805 | char * buf; | |
806 | int len; | |
807 | int readers; | |
808 | }; | |
809 | struct cache_reader { | |
810 | struct cache_queue q; | |
811 | int offset; /* if non-0, we have a refcnt on next request */ | |
812 | }; | |
813 | ||
d94af6de SK |
814 | static int cache_request(struct cache_detail *detail, |
815 | struct cache_request *crq) | |
816 | { | |
817 | char *bp = crq->buf; | |
818 | int len = PAGE_SIZE; | |
819 | ||
820 | detail->cache_request(detail, crq->item, &bp, &len); | |
821 | if (len < 0) | |
0c217d50 | 822 | return -E2BIG; |
d94af6de SK |
823 | return PAGE_SIZE - len; |
824 | } | |
825 | ||
173912a6 TM |
826 | static ssize_t cache_read(struct file *filp, char __user *buf, size_t count, |
827 | loff_t *ppos, struct cache_detail *cd) | |
1da177e4 LT |
828 | { |
829 | struct cache_reader *rp = filp->private_data; | |
830 | struct cache_request *rq; | |
496ad9aa | 831 | struct inode *inode = file_inode(filp); |
1da177e4 LT |
832 | int err; |
833 | ||
834 | if (count == 0) | |
835 | return 0; | |
836 | ||
5955102c | 837 | inode_lock(inode); /* protect against multiple concurrent |
1da177e4 LT |
838 | * readers on this file */ |
839 | again: | |
840 | spin_lock(&queue_lock); | |
841 | /* need to find next request */ | |
842 | while (rp->q.list.next != &cd->queue && | |
843 | list_entry(rp->q.list.next, struct cache_queue, list) | |
844 | ->reader) { | |
845 | struct list_head *next = rp->q.list.next; | |
846 | list_move(&rp->q.list, next); | |
847 | } | |
848 | if (rp->q.list.next == &cd->queue) { | |
849 | spin_unlock(&queue_lock); | |
5955102c | 850 | inode_unlock(inode); |
0db74d9a | 851 | WARN_ON_ONCE(rp->offset); |
1da177e4 LT |
852 | return 0; |
853 | } | |
854 | rq = container_of(rp->q.list.next, struct cache_request, q.list); | |
0db74d9a | 855 | WARN_ON_ONCE(rq->q.reader); |
1da177e4 LT |
856 | if (rp->offset == 0) |
857 | rq->readers++; | |
858 | spin_unlock(&queue_lock); | |
859 | ||
d94af6de SK |
860 | if (rq->len == 0) { |
861 | err = cache_request(cd, rq); | |
862 | if (err < 0) | |
863 | goto out; | |
864 | rq->len = err; | |
865 | } | |
866 | ||
1da177e4 LT |
867 | if (rp->offset == 0 && !test_bit(CACHE_PENDING, &rq->item->flags)) { |
868 | err = -EAGAIN; | |
869 | spin_lock(&queue_lock); | |
870 | list_move(&rp->q.list, &rq->q.list); | |
871 | spin_unlock(&queue_lock); | |
872 | } else { | |
873 | if (rp->offset + count > rq->len) | |
874 | count = rq->len - rp->offset; | |
875 | err = -EFAULT; | |
876 | if (copy_to_user(buf, rq->buf + rp->offset, count)) | |
877 | goto out; | |
878 | rp->offset += count; | |
879 | if (rp->offset >= rq->len) { | |
880 | rp->offset = 0; | |
881 | spin_lock(&queue_lock); | |
882 | list_move(&rp->q.list, &rq->q.list); | |
883 | spin_unlock(&queue_lock); | |
884 | } | |
885 | err = 0; | |
886 | } | |
887 | out: | |
888 | if (rp->offset == 0) { | |
889 | /* need to release rq */ | |
890 | spin_lock(&queue_lock); | |
891 | rq->readers--; | |
892 | if (rq->readers == 0 && | |
893 | !test_bit(CACHE_PENDING, &rq->item->flags)) { | |
894 | list_del(&rq->q.list); | |
895 | spin_unlock(&queue_lock); | |
baab935f | 896 | cache_put(rq->item, cd); |
1da177e4 LT |
897 | kfree(rq->buf); |
898 | kfree(rq); | |
899 | } else | |
900 | spin_unlock(&queue_lock); | |
901 | } | |
902 | if (err == -EAGAIN) | |
903 | goto again; | |
5955102c | 904 | inode_unlock(inode); |
1da177e4 LT |
905 | return err ? err : count; |
906 | } | |
907 | ||
da77005f TM |
908 | static ssize_t cache_do_downcall(char *kaddr, const char __user *buf, |
909 | size_t count, struct cache_detail *cd) | |
910 | { | |
911 | ssize_t ret; | |
1da177e4 | 912 | |
6d8d1749 DC |
913 | if (count == 0) |
914 | return -EINVAL; | |
da77005f TM |
915 | if (copy_from_user(kaddr, buf, count)) |
916 | return -EFAULT; | |
917 | kaddr[count] = '\0'; | |
918 | ret = cd->cache_parse(cd, kaddr, count); | |
919 | if (!ret) | |
920 | ret = count; | |
921 | return ret; | |
922 | } | |
923 | ||
da77005f TM |
924 | static ssize_t cache_downcall(struct address_space *mapping, |
925 | const char __user *buf, | |
926 | size_t count, struct cache_detail *cd) | |
927 | { | |
4b5cff7e | 928 | char *write_buf; |
da77005f TM |
929 | ssize_t ret = -ENOMEM; |
930 | ||
4b5cff7e RBC |
931 | if (count >= 32768) { /* 32k is max userland buffer, lets check anyway */ |
932 | ret = -EINVAL; | |
933 | goto out; | |
934 | } | |
da77005f | 935 | |
4b5cff7e RBC |
936 | write_buf = kvmalloc(count + 1, GFP_KERNEL); |
937 | if (!write_buf) | |
938 | goto out; | |
da77005f | 939 | |
4b5cff7e RBC |
940 | ret = cache_do_downcall(write_buf, buf, count, cd); |
941 | kvfree(write_buf); | |
942 | out: | |
da77005f | 943 | return ret; |
da77005f | 944 | } |
1da177e4 | 945 | |
173912a6 TM |
946 | static ssize_t cache_write(struct file *filp, const char __user *buf, |
947 | size_t count, loff_t *ppos, | |
948 | struct cache_detail *cd) | |
da77005f TM |
949 | { |
950 | struct address_space *mapping = filp->f_mapping; | |
496ad9aa | 951 | struct inode *inode = file_inode(filp); |
da77005f TM |
952 | ssize_t ret = -EINVAL; |
953 | ||
954 | if (!cd->cache_parse) | |
955 | goto out; | |
956 | ||
5955102c | 957 | inode_lock(inode); |
da77005f | 958 | ret = cache_downcall(mapping, buf, count, cd); |
5955102c | 959 | inode_unlock(inode); |
da77005f TM |
960 | out: |
961 | return ret; | |
1da177e4 LT |
962 | } |
963 | ||
964 | static DECLARE_WAIT_QUEUE_HEAD(queue_wait); | |
965 | ||
ade994f4 | 966 | static __poll_t cache_poll(struct file *filp, poll_table *wait, |
173912a6 | 967 | struct cache_detail *cd) |
1da177e4 | 968 | { |
ade994f4 | 969 | __poll_t mask; |
1da177e4 LT |
970 | struct cache_reader *rp = filp->private_data; |
971 | struct cache_queue *cq; | |
1da177e4 LT |
972 | |
973 | poll_wait(filp, &queue_wait, wait); | |
974 | ||
975 | /* alway allow write */ | |
a9a08845 | 976 | mask = EPOLLOUT | EPOLLWRNORM; |
1da177e4 LT |
977 | |
978 | if (!rp) | |
979 | return mask; | |
980 | ||
981 | spin_lock(&queue_lock); | |
982 | ||
983 | for (cq= &rp->q; &cq->list != &cd->queue; | |
984 | cq = list_entry(cq->list.next, struct cache_queue, list)) | |
985 | if (!cq->reader) { | |
a9a08845 | 986 | mask |= EPOLLIN | EPOLLRDNORM; |
1da177e4 LT |
987 | break; |
988 | } | |
989 | spin_unlock(&queue_lock); | |
990 | return mask; | |
991 | } | |
992 | ||
173912a6 TM |
993 | static int cache_ioctl(struct inode *ino, struct file *filp, |
994 | unsigned int cmd, unsigned long arg, | |
995 | struct cache_detail *cd) | |
1da177e4 LT |
996 | { |
997 | int len = 0; | |
998 | struct cache_reader *rp = filp->private_data; | |
999 | struct cache_queue *cq; | |
1da177e4 LT |
1000 | |
1001 | if (cmd != FIONREAD || !rp) | |
1002 | return -EINVAL; | |
1003 | ||
1004 | spin_lock(&queue_lock); | |
1005 | ||
1006 | /* only find the length remaining in current request, | |
1007 | * or the length of the next request | |
1008 | */ | |
1009 | for (cq= &rp->q; &cq->list != &cd->queue; | |
1010 | cq = list_entry(cq->list.next, struct cache_queue, list)) | |
1011 | if (!cq->reader) { | |
1012 | struct cache_request *cr = | |
1013 | container_of(cq, struct cache_request, q); | |
1014 | len = cr->len - rp->offset; | |
1015 | break; | |
1016 | } | |
1017 | spin_unlock(&queue_lock); | |
1018 | ||
1019 | return put_user(len, (int __user *)arg); | |
1020 | } | |
1021 | ||
173912a6 TM |
1022 | static int cache_open(struct inode *inode, struct file *filp, |
1023 | struct cache_detail *cd) | |
1da177e4 LT |
1024 | { |
1025 | struct cache_reader *rp = NULL; | |
1026 | ||
f7e86ab9 TM |
1027 | if (!cd || !try_module_get(cd->owner)) |
1028 | return -EACCES; | |
1da177e4 LT |
1029 | nonseekable_open(inode, filp); |
1030 | if (filp->f_mode & FMODE_READ) { | |
1da177e4 | 1031 | rp = kmalloc(sizeof(*rp), GFP_KERNEL); |
a7823c79 AK |
1032 | if (!rp) { |
1033 | module_put(cd->owner); | |
1da177e4 | 1034 | return -ENOMEM; |
a7823c79 | 1035 | } |
1da177e4 LT |
1036 | rp->offset = 0; |
1037 | rp->q.reader = 1; | |
64a38e84 | 1038 | |
1da177e4 LT |
1039 | spin_lock(&queue_lock); |
1040 | list_add(&rp->q.list, &cd->queue); | |
1041 | spin_unlock(&queue_lock); | |
1042 | } | |
64a38e84 DW |
1043 | if (filp->f_mode & FMODE_WRITE) |
1044 | atomic_inc(&cd->writers); | |
1da177e4 LT |
1045 | filp->private_data = rp; |
1046 | return 0; | |
1047 | } | |
1048 | ||
173912a6 TM |
1049 | static int cache_release(struct inode *inode, struct file *filp, |
1050 | struct cache_detail *cd) | |
1da177e4 LT |
1051 | { |
1052 | struct cache_reader *rp = filp->private_data; | |
1da177e4 LT |
1053 | |
1054 | if (rp) { | |
1055 | spin_lock(&queue_lock); | |
1056 | if (rp->offset) { | |
1057 | struct cache_queue *cq; | |
1058 | for (cq= &rp->q; &cq->list != &cd->queue; | |
1059 | cq = list_entry(cq->list.next, struct cache_queue, list)) | |
1060 | if (!cq->reader) { | |
1061 | container_of(cq, struct cache_request, q) | |
1062 | ->readers--; | |
1063 | break; | |
1064 | } | |
1065 | rp->offset = 0; | |
1066 | } | |
1067 | list_del(&rp->q.list); | |
1068 | spin_unlock(&queue_lock); | |
1069 | ||
1070 | filp->private_data = NULL; | |
1071 | kfree(rp); | |
1072 | ||
64a38e84 DW |
1073 | } |
1074 | if (filp->f_mode & FMODE_WRITE) { | |
1075 | atomic_dec(&cd->writers); | |
c5b29f88 | 1076 | cd->last_close = seconds_since_boot(); |
1da177e4 | 1077 | } |
f7e86ab9 | 1078 | module_put(cd->owner); |
1da177e4 LT |
1079 | return 0; |
1080 | } | |
1081 | ||
1082 | ||
1083 | ||
f866a819 | 1084 | static void cache_dequeue(struct cache_detail *detail, struct cache_head *ch) |
1da177e4 | 1085 | { |
f9e1aedc N |
1086 | struct cache_queue *cq, *tmp; |
1087 | struct cache_request *cr; | |
1088 | struct list_head dequeued; | |
1089 | ||
1090 | INIT_LIST_HEAD(&dequeued); | |
1da177e4 | 1091 | spin_lock(&queue_lock); |
f9e1aedc | 1092 | list_for_each_entry_safe(cq, tmp, &detail->queue, list) |
1da177e4 | 1093 | if (!cq->reader) { |
f9e1aedc | 1094 | cr = container_of(cq, struct cache_request, q); |
1da177e4 LT |
1095 | if (cr->item != ch) |
1096 | continue; | |
f9e1aedc N |
1097 | if (test_bit(CACHE_PENDING, &ch->flags)) |
1098 | /* Lost a race and it is pending again */ | |
1099 | break; | |
1da177e4 | 1100 | if (cr->readers != 0) |
4013edea | 1101 | continue; |
f9e1aedc | 1102 | list_move(&cr->q.list, &dequeued); |
1da177e4 LT |
1103 | } |
1104 | spin_unlock(&queue_lock); | |
f9e1aedc N |
1105 | while (!list_empty(&dequeued)) { |
1106 | cr = list_entry(dequeued.next, struct cache_request, q.list); | |
1107 | list_del(&cr->q.list); | |
1108 | cache_put(cr->item, detail); | |
1109 | kfree(cr->buf); | |
1110 | kfree(cr); | |
1111 | } | |
1da177e4 LT |
1112 | } |
1113 | ||
1114 | /* | |
1115 | * Support routines for text-based upcalls. | |
1116 | * Fields are separated by spaces. | |
1117 | * Fields are either mangled to quote space tab newline slosh with slosh | |
1118 | * or a hexified with a leading \x | |
1119 | * Record is terminated with newline. | |
1120 | * | |
1121 | */ | |
1122 | ||
1123 | void qword_add(char **bpp, int *lp, char *str) | |
1124 | { | |
1125 | char *bp = *bpp; | |
1126 | int len = *lp; | |
1b2e122d | 1127 | int ret; |
1da177e4 LT |
1128 | |
1129 | if (len < 0) return; | |
1130 | ||
41416f23 RV |
1131 | ret = string_escape_str(str, bp, len, ESCAPE_OCTAL, "\\ \n\t"); |
1132 | if (ret >= len) { | |
1133 | bp += len; | |
1b2e122d | 1134 | len = -1; |
41416f23 RV |
1135 | } else { |
1136 | bp += ret; | |
1b2e122d | 1137 | len -= ret; |
1da177e4 LT |
1138 | *bp++ = ' '; |
1139 | len--; | |
1140 | } | |
1141 | *bpp = bp; | |
1142 | *lp = len; | |
1143 | } | |
24c3767e | 1144 | EXPORT_SYMBOL_GPL(qword_add); |
1da177e4 LT |
1145 | |
1146 | void qword_addhex(char **bpp, int *lp, char *buf, int blen) | |
1147 | { | |
1148 | char *bp = *bpp; | |
1149 | int len = *lp; | |
1150 | ||
1151 | if (len < 0) return; | |
1152 | ||
1153 | if (len > 2) { | |
1154 | *bp++ = '\\'; | |
1155 | *bp++ = 'x'; | |
1156 | len -= 2; | |
1157 | while (blen && len >= 2) { | |
056785ea | 1158 | bp = hex_byte_pack(bp, *buf++); |
1da177e4 LT |
1159 | len -= 2; |
1160 | blen--; | |
1161 | } | |
1162 | } | |
1163 | if (blen || len<1) len = -1; | |
1164 | else { | |
1165 | *bp++ = ' '; | |
1166 | len--; | |
1167 | } | |
1168 | *bpp = bp; | |
1169 | *lp = len; | |
1170 | } | |
24c3767e | 1171 | EXPORT_SYMBOL_GPL(qword_addhex); |
1da177e4 LT |
1172 | |
1173 | static void warn_no_listener(struct cache_detail *detail) | |
1174 | { | |
1175 | if (detail->last_warn != detail->last_close) { | |
1176 | detail->last_warn = detail->last_close; | |
1177 | if (detail->warn_no_listener) | |
2da8ca26 | 1178 | detail->warn_no_listener(detail, detail->last_close != 0); |
1da177e4 LT |
1179 | } |
1180 | } | |
1181 | ||
06497524 BF |
1182 | static bool cache_listeners_exist(struct cache_detail *detail) |
1183 | { | |
64a38e84 | 1184 | if (atomic_read(&detail->writers)) |
06497524 BF |
1185 | return true; |
1186 | if (detail->last_close == 0) | |
1187 | /* This cache was never opened */ | |
1188 | return false; | |
1189 | if (detail->last_close < seconds_since_boot() - 30) | |
1190 | /* | |
1191 | * We allow for the possibility that someone might | |
1192 | * restart a userspace daemon without restarting the | |
1193 | * server; but after 30 seconds, we give up. | |
1194 | */ | |
1195 | return false; | |
1196 | return true; | |
1197 | } | |
1198 | ||
1da177e4 | 1199 | /* |
bc74b4f5 TM |
1200 | * register an upcall request to user-space and queue it up for read() by the |
1201 | * upcall daemon. | |
1202 | * | |
1da177e4 LT |
1203 | * Each request is at most one page long. |
1204 | */ | |
65286b88 | 1205 | static int cache_pipe_upcall(struct cache_detail *detail, struct cache_head *h) |
1da177e4 | 1206 | { |
1da177e4 LT |
1207 | char *buf; |
1208 | struct cache_request *crq; | |
f9e1aedc | 1209 | int ret = 0; |
1da177e4 | 1210 | |
013920eb N |
1211 | if (test_bit(CACHE_CLEANED, &h->flags)) |
1212 | /* Too late to make an upcall */ | |
1213 | return -EAGAIN; | |
1da177e4 LT |
1214 | |
1215 | buf = kmalloc(PAGE_SIZE, GFP_KERNEL); | |
1216 | if (!buf) | |
1217 | return -EAGAIN; | |
1218 | ||
1219 | crq = kmalloc(sizeof (*crq), GFP_KERNEL); | |
1220 | if (!crq) { | |
1221 | kfree(buf); | |
1222 | return -EAGAIN; | |
1223 | } | |
1224 | ||
1da177e4 | 1225 | crq->q.reader = 0; |
1da177e4 | 1226 | crq->buf = buf; |
d94af6de | 1227 | crq->len = 0; |
1da177e4 LT |
1228 | crq->readers = 0; |
1229 | spin_lock(&queue_lock); | |
a6ab1e81 N |
1230 | if (test_bit(CACHE_PENDING, &h->flags)) { |
1231 | crq->item = cache_get(h); | |
f9e1aedc | 1232 | list_add_tail(&crq->q.list, &detail->queue); |
78a947f5 | 1233 | trace_cache_entry_upcall(detail, h); |
a6ab1e81 | 1234 | } else |
f9e1aedc N |
1235 | /* Lost a race, no longer PENDING, so don't enqueue */ |
1236 | ret = -EAGAIN; | |
1da177e4 LT |
1237 | spin_unlock(&queue_lock); |
1238 | wake_up(&queue_wait); | |
f9e1aedc N |
1239 | if (ret == -EAGAIN) { |
1240 | kfree(buf); | |
1241 | kfree(crq); | |
1242 | } | |
1243 | return ret; | |
1da177e4 | 1244 | } |
65286b88 TM |
1245 | |
1246 | int sunrpc_cache_pipe_upcall(struct cache_detail *detail, struct cache_head *h) | |
1247 | { | |
1248 | if (test_and_set_bit(CACHE_PENDING, &h->flags)) | |
1249 | return 0; | |
1250 | return cache_pipe_upcall(detail, h); | |
1251 | } | |
bc74b4f5 | 1252 | EXPORT_SYMBOL_GPL(sunrpc_cache_pipe_upcall); |
1da177e4 | 1253 | |
65286b88 TM |
1254 | int sunrpc_cache_pipe_upcall_timeout(struct cache_detail *detail, |
1255 | struct cache_head *h) | |
1256 | { | |
1257 | if (!cache_listeners_exist(detail)) { | |
1258 | warn_no_listener(detail); | |
78a947f5 | 1259 | trace_cache_entry_no_listener(detail, h); |
65286b88 TM |
1260 | return -EINVAL; |
1261 | } | |
1262 | return sunrpc_cache_pipe_upcall(detail, h); | |
1263 | } | |
1264 | EXPORT_SYMBOL_GPL(sunrpc_cache_pipe_upcall_timeout); | |
1265 | ||
1da177e4 LT |
1266 | /* |
1267 | * parse a message from user-space and pass it | |
1268 | * to an appropriate cache | |
1269 | * Messages are, like requests, separated into fields by | |
1270 | * spaces and dequotes as \xHEXSTRING or embedded \nnn octal | |
1271 | * | |
cca5172a | 1272 | * Message is |
1da177e4 LT |
1273 | * reply cachename expiry key ... content.... |
1274 | * | |
cca5172a | 1275 | * key and content are both parsed by cache |
1da177e4 LT |
1276 | */ |
1277 | ||
1da177e4 LT |
1278 | int qword_get(char **bpp, char *dest, int bufsize) |
1279 | { | |
1280 | /* return bytes copied, or -1 on error */ | |
1281 | char *bp = *bpp; | |
1282 | int len = 0; | |
1283 | ||
1284 | while (*bp == ' ') bp++; | |
1285 | ||
1286 | if (bp[0] == '\\' && bp[1] == 'x') { | |
1287 | /* HEX STRING */ | |
1288 | bp += 2; | |
b7052cd7 | 1289 | while (len < bufsize - 1) { |
e7f483ea AS |
1290 | int h, l; |
1291 | ||
1292 | h = hex_to_bin(bp[0]); | |
1293 | if (h < 0) | |
1294 | break; | |
1295 | ||
1296 | l = hex_to_bin(bp[1]); | |
1297 | if (l < 0) | |
1298 | break; | |
1299 | ||
1300 | *dest++ = (h << 4) | l; | |
1301 | bp += 2; | |
1da177e4 LT |
1302 | len++; |
1303 | } | |
1304 | } else { | |
1305 | /* text with \nnn octal quoting */ | |
1306 | while (*bp != ' ' && *bp != '\n' && *bp && len < bufsize-1) { | |
1307 | if (*bp == '\\' && | |
1308 | isodigit(bp[1]) && (bp[1] <= '3') && | |
1309 | isodigit(bp[2]) && | |
1310 | isodigit(bp[3])) { | |
1311 | int byte = (*++bp -'0'); | |
1312 | bp++; | |
1313 | byte = (byte << 3) | (*bp++ - '0'); | |
1314 | byte = (byte << 3) | (*bp++ - '0'); | |
1315 | *dest++ = byte; | |
1316 | len++; | |
1317 | } else { | |
1318 | *dest++ = *bp++; | |
1319 | len++; | |
1320 | } | |
1321 | } | |
1322 | } | |
1323 | ||
1324 | if (*bp != ' ' && *bp != '\n' && *bp != '\0') | |
1325 | return -1; | |
1326 | while (*bp == ' ') bp++; | |
1327 | *bpp = bp; | |
1328 | *dest = '\0'; | |
1329 | return len; | |
1330 | } | |
24c3767e | 1331 | EXPORT_SYMBOL_GPL(qword_get); |
1da177e4 LT |
1332 | |
1333 | ||
1334 | /* | |
6489a8f4 | 1335 | * support /proc/net/rpc/$CACHENAME/content |
1da177e4 LT |
1336 | * as a seqfile. |
1337 | * We call ->cache_show passing NULL for the item to | |
1338 | * get a header, then pass each real item in the cache | |
1339 | */ | |
1340 | ||
ae74136b | 1341 | static void *__cache_seq_start(struct seq_file *m, loff_t *pos) |
1da177e4 LT |
1342 | { |
1343 | loff_t n = *pos; | |
95c96174 | 1344 | unsigned int hash, entry; |
1da177e4 | 1345 | struct cache_head *ch; |
9936f2ae | 1346 | struct cache_detail *cd = m->private; |
1da177e4 | 1347 | |
1da177e4 LT |
1348 | if (!n--) |
1349 | return SEQ_START_TOKEN; | |
1350 | hash = n >> 32; | |
1351 | entry = n & ((1LL<<32) - 1); | |
1352 | ||
ae74136b | 1353 | hlist_for_each_entry_rcu(ch, &cd->hash_table[hash], cache_list) |
1da177e4 LT |
1354 | if (!entry--) |
1355 | return ch; | |
1356 | n &= ~((1LL<<32) - 1); | |
1357 | do { | |
1358 | hash++; | |
1359 | n += 1LL<<32; | |
cca5172a | 1360 | } while(hash < cd->hash_size && |
129e5824 | 1361 | hlist_empty(&cd->hash_table[hash])); |
1da177e4 LT |
1362 | if (hash >= cd->hash_size) |
1363 | return NULL; | |
1364 | *pos = n+1; | |
ae74136b TM |
1365 | return hlist_entry_safe(rcu_dereference_raw( |
1366 | hlist_first_rcu(&cd->hash_table[hash])), | |
129e5824 | 1367 | struct cache_head, cache_list); |
1da177e4 | 1368 | } |
ae74136b | 1369 | |
d48cf356 | 1370 | static void *cache_seq_next(struct seq_file *m, void *p, loff_t *pos) |
1da177e4 LT |
1371 | { |
1372 | struct cache_head *ch = p; | |
1373 | int hash = (*pos >> 32); | |
9936f2ae | 1374 | struct cache_detail *cd = m->private; |
1da177e4 LT |
1375 | |
1376 | if (p == SEQ_START_TOKEN) | |
1377 | hash = 0; | |
129e5824 | 1378 | else if (ch->cache_list.next == NULL) { |
1da177e4 LT |
1379 | hash++; |
1380 | *pos += 1LL<<32; | |
1381 | } else { | |
1382 | ++*pos; | |
ae74136b TM |
1383 | return hlist_entry_safe(rcu_dereference_raw( |
1384 | hlist_next_rcu(&ch->cache_list)), | |
129e5824 | 1385 | struct cache_head, cache_list); |
1da177e4 LT |
1386 | } |
1387 | *pos &= ~((1LL<<32) - 1); | |
1388 | while (hash < cd->hash_size && | |
129e5824 | 1389 | hlist_empty(&cd->hash_table[hash])) { |
1da177e4 LT |
1390 | hash++; |
1391 | *pos += 1LL<<32; | |
1392 | } | |
1393 | if (hash >= cd->hash_size) | |
1394 | return NULL; | |
1395 | ++*pos; | |
ae74136b TM |
1396 | return hlist_entry_safe(rcu_dereference_raw( |
1397 | hlist_first_rcu(&cd->hash_table[hash])), | |
129e5824 | 1398 | struct cache_head, cache_list); |
1da177e4 LT |
1399 | } |
1400 | ||
ae74136b TM |
1401 | void *cache_seq_start_rcu(struct seq_file *m, loff_t *pos) |
1402 | __acquires(RCU) | |
1403 | { | |
1404 | rcu_read_lock(); | |
1405 | return __cache_seq_start(m, pos); | |
1406 | } | |
1407 | EXPORT_SYMBOL_GPL(cache_seq_start_rcu); | |
1408 | ||
1409 | void *cache_seq_next_rcu(struct seq_file *file, void *p, loff_t *pos) | |
1410 | { | |
1411 | return cache_seq_next(file, p, pos); | |
1412 | } | |
1413 | EXPORT_SYMBOL_GPL(cache_seq_next_rcu); | |
1414 | ||
1415 | void cache_seq_stop_rcu(struct seq_file *m, void *p) | |
1416 | __releases(RCU) | |
1417 | { | |
1418 | rcu_read_unlock(); | |
1419 | } | |
1420 | EXPORT_SYMBOL_GPL(cache_seq_stop_rcu); | |
1421 | ||
1da177e4 LT |
1422 | static int c_show(struct seq_file *m, void *p) |
1423 | { | |
1424 | struct cache_head *cp = p; | |
9936f2ae | 1425 | struct cache_detail *cd = m->private; |
1da177e4 LT |
1426 | |
1427 | if (p == SEQ_START_TOKEN) | |
1428 | return cd->cache_show(m, cd, NULL); | |
1429 | ||
1430 | ifdebug(CACHE) | |
f559935e | 1431 | seq_printf(m, "# expiry=%lld refcnt=%d flags=%lx\n", |
c5b29f88 | 1432 | convert_to_wallclock(cp->expiry_time), |
2c935bc5 | 1433 | kref_read(&cp->ref), cp->flags); |
1da177e4 LT |
1434 | cache_get(cp); |
1435 | if (cache_check(cd, cp, NULL)) | |
1436 | /* cache_check does a cache_put on failure */ | |
9dbc1f45 | 1437 | seq_puts(m, "# "); |
200724a7 N |
1438 | else { |
1439 | if (cache_is_expired(cd, cp)) | |
9dbc1f45 | 1440 | seq_puts(m, "# "); |
1da177e4 | 1441 | cache_put(cp, cd); |
200724a7 | 1442 | } |
1da177e4 LT |
1443 | |
1444 | return cd->cache_show(m, cd, cp); | |
1445 | } | |
1446 | ||
56b3d975 | 1447 | static const struct seq_operations cache_content_op = { |
d48cf356 TM |
1448 | .start = cache_seq_start_rcu, |
1449 | .next = cache_seq_next_rcu, | |
1450 | .stop = cache_seq_stop_rcu, | |
1da177e4 LT |
1451 | .show = c_show, |
1452 | }; | |
1453 | ||
173912a6 TM |
1454 | static int content_open(struct inode *inode, struct file *file, |
1455 | struct cache_detail *cd) | |
1da177e4 | 1456 | { |
9936f2ae KM |
1457 | struct seq_file *seq; |
1458 | int err; | |
1da177e4 | 1459 | |
f7e86ab9 TM |
1460 | if (!cd || !try_module_get(cd->owner)) |
1461 | return -EACCES; | |
9936f2ae KM |
1462 | |
1463 | err = seq_open(file, &cache_content_op); | |
1464 | if (err) { | |
a5990ea1 | 1465 | module_put(cd->owner); |
9936f2ae | 1466 | return err; |
a5990ea1 | 1467 | } |
1da177e4 | 1468 | |
9936f2ae KM |
1469 | seq = file->private_data; |
1470 | seq->private = cd; | |
ec931035 | 1471 | return 0; |
1da177e4 | 1472 | } |
1da177e4 | 1473 | |
f7e86ab9 TM |
1474 | static int content_release(struct inode *inode, struct file *file, |
1475 | struct cache_detail *cd) | |
1476 | { | |
9936f2ae | 1477 | int ret = seq_release(inode, file); |
f7e86ab9 TM |
1478 | module_put(cd->owner); |
1479 | return ret; | |
1480 | } | |
1481 | ||
1482 | static int open_flush(struct inode *inode, struct file *file, | |
1483 | struct cache_detail *cd) | |
1484 | { | |
1485 | if (!cd || !try_module_get(cd->owner)) | |
1486 | return -EACCES; | |
1487 | return nonseekable_open(inode, file); | |
1488 | } | |
1489 | ||
1490 | static int release_flush(struct inode *inode, struct file *file, | |
1491 | struct cache_detail *cd) | |
1492 | { | |
1493 | module_put(cd->owner); | |
1494 | return 0; | |
1495 | } | |
1da177e4 LT |
1496 | |
1497 | static ssize_t read_flush(struct file *file, char __user *buf, | |
173912a6 TM |
1498 | size_t count, loff_t *ppos, |
1499 | struct cache_detail *cd) | |
1da177e4 | 1500 | { |
212ba906 | 1501 | char tbuf[22]; |
01b2969a | 1502 | size_t len; |
1da177e4 | 1503 | |
f559935e | 1504 | len = snprintf(tbuf, sizeof(tbuf), "%llu\n", |
8ccc8691 KM |
1505 | convert_to_wallclock(cd->flush_time)); |
1506 | return simple_read_from_buffer(buf, count, ppos, tbuf, len); | |
1da177e4 LT |
1507 | } |
1508 | ||
173912a6 TM |
1509 | static ssize_t write_flush(struct file *file, const char __user *buf, |
1510 | size_t count, loff_t *ppos, | |
1511 | struct cache_detail *cd) | |
1da177e4 | 1512 | { |
1da177e4 | 1513 | char tbuf[20]; |
3b68e6ee | 1514 | char *ep; |
f559935e | 1515 | time64_t now; |
c5b29f88 | 1516 | |
1da177e4 LT |
1517 | if (*ppos || count > sizeof(tbuf)-1) |
1518 | return -EINVAL; | |
1519 | if (copy_from_user(tbuf, buf, count)) | |
1520 | return -EFAULT; | |
1521 | tbuf[count] = 0; | |
c5b29f88 | 1522 | simple_strtoul(tbuf, &ep, 0); |
1da177e4 LT |
1523 | if (*ep && *ep != '\n') |
1524 | return -EINVAL; | |
3b68e6ee N |
1525 | /* Note that while we check that 'buf' holds a valid number, |
1526 | * we always ignore the value and just flush everything. | |
1527 | * Making use of the number leads to races. | |
1528 | */ | |
1da177e4 | 1529 | |
77862036 | 1530 | now = seconds_since_boot(); |
3b68e6ee N |
1531 | /* Always flush everything, so behave like cache_purge() |
1532 | * Do this by advancing flush_time to the current time, | |
1533 | * or by one second if it has already reached the current time. | |
1534 | * Newly added cache entries will always have ->last_refresh greater | |
1535 | * that ->flush_time, so they don't get flushed prematurely. | |
77862036 | 1536 | */ |
77862036 | 1537 | |
3b68e6ee N |
1538 | if (cd->flush_time >= now) |
1539 | now = cd->flush_time + 1; | |
1540 | ||
1541 | cd->flush_time = now; | |
1542 | cd->nextcheck = now; | |
1da177e4 LT |
1543 | cache_flush(); |
1544 | ||
f69d6d8e JL |
1545 | if (cd->flush) |
1546 | cd->flush(); | |
1547 | ||
1da177e4 LT |
1548 | *ppos += count; |
1549 | return count; | |
1550 | } | |
1551 | ||
173912a6 TM |
1552 | static ssize_t cache_read_procfs(struct file *filp, char __user *buf, |
1553 | size_t count, loff_t *ppos) | |
1554 | { | |
359745d7 | 1555 | struct cache_detail *cd = pde_data(file_inode(filp)); |
173912a6 TM |
1556 | |
1557 | return cache_read(filp, buf, count, ppos, cd); | |
1558 | } | |
1559 | ||
1560 | static ssize_t cache_write_procfs(struct file *filp, const char __user *buf, | |
1561 | size_t count, loff_t *ppos) | |
1562 | { | |
359745d7 | 1563 | struct cache_detail *cd = pde_data(file_inode(filp)); |
173912a6 TM |
1564 | |
1565 | return cache_write(filp, buf, count, ppos, cd); | |
1566 | } | |
1567 | ||
ade994f4 | 1568 | static __poll_t cache_poll_procfs(struct file *filp, poll_table *wait) |
173912a6 | 1569 | { |
359745d7 | 1570 | struct cache_detail *cd = pde_data(file_inode(filp)); |
173912a6 TM |
1571 | |
1572 | return cache_poll(filp, wait, cd); | |
1573 | } | |
1574 | ||
d79b6f4d FW |
1575 | static long cache_ioctl_procfs(struct file *filp, |
1576 | unsigned int cmd, unsigned long arg) | |
173912a6 | 1577 | { |
496ad9aa | 1578 | struct inode *inode = file_inode(filp); |
359745d7 | 1579 | struct cache_detail *cd = pde_data(inode); |
173912a6 | 1580 | |
a6f8dbc6 | 1581 | return cache_ioctl(inode, filp, cmd, arg, cd); |
173912a6 TM |
1582 | } |
1583 | ||
1584 | static int cache_open_procfs(struct inode *inode, struct file *filp) | |
1585 | { | |
359745d7 | 1586 | struct cache_detail *cd = pde_data(inode); |
173912a6 TM |
1587 | |
1588 | return cache_open(inode, filp, cd); | |
1589 | } | |
1590 | ||
1591 | static int cache_release_procfs(struct inode *inode, struct file *filp) | |
1592 | { | |
359745d7 | 1593 | struct cache_detail *cd = pde_data(inode); |
173912a6 TM |
1594 | |
1595 | return cache_release(inode, filp, cd); | |
1596 | } | |
1597 | ||
97a32539 AD |
1598 | static const struct proc_ops cache_channel_proc_ops = { |
1599 | .proc_lseek = no_llseek, | |
1600 | .proc_read = cache_read_procfs, | |
1601 | .proc_write = cache_write_procfs, | |
1602 | .proc_poll = cache_poll_procfs, | |
1603 | .proc_ioctl = cache_ioctl_procfs, /* for FIONREAD */ | |
1604 | .proc_open = cache_open_procfs, | |
1605 | .proc_release = cache_release_procfs, | |
1da177e4 | 1606 | }; |
173912a6 TM |
1607 | |
1608 | static int content_open_procfs(struct inode *inode, struct file *filp) | |
1609 | { | |
359745d7 | 1610 | struct cache_detail *cd = pde_data(inode); |
173912a6 TM |
1611 | |
1612 | return content_open(inode, filp, cd); | |
1613 | } | |
1614 | ||
f7e86ab9 TM |
1615 | static int content_release_procfs(struct inode *inode, struct file *filp) |
1616 | { | |
359745d7 | 1617 | struct cache_detail *cd = pde_data(inode); |
f7e86ab9 TM |
1618 | |
1619 | return content_release(inode, filp, cd); | |
1620 | } | |
1621 | ||
97a32539 AD |
1622 | static const struct proc_ops content_proc_ops = { |
1623 | .proc_open = content_open_procfs, | |
1624 | .proc_read = seq_read, | |
1625 | .proc_lseek = seq_lseek, | |
1626 | .proc_release = content_release_procfs, | |
173912a6 TM |
1627 | }; |
1628 | ||
f7e86ab9 TM |
1629 | static int open_flush_procfs(struct inode *inode, struct file *filp) |
1630 | { | |
359745d7 | 1631 | struct cache_detail *cd = pde_data(inode); |
f7e86ab9 TM |
1632 | |
1633 | return open_flush(inode, filp, cd); | |
1634 | } | |
1635 | ||
1636 | static int release_flush_procfs(struct inode *inode, struct file *filp) | |
1637 | { | |
359745d7 | 1638 | struct cache_detail *cd = pde_data(inode); |
f7e86ab9 TM |
1639 | |
1640 | return release_flush(inode, filp, cd); | |
1641 | } | |
1642 | ||
173912a6 TM |
1643 | static ssize_t read_flush_procfs(struct file *filp, char __user *buf, |
1644 | size_t count, loff_t *ppos) | |
1645 | { | |
359745d7 | 1646 | struct cache_detail *cd = pde_data(file_inode(filp)); |
173912a6 TM |
1647 | |
1648 | return read_flush(filp, buf, count, ppos, cd); | |
1649 | } | |
1650 | ||
1651 | static ssize_t write_flush_procfs(struct file *filp, | |
1652 | const char __user *buf, | |
1653 | size_t count, loff_t *ppos) | |
1654 | { | |
359745d7 | 1655 | struct cache_detail *cd = pde_data(file_inode(filp)); |
173912a6 TM |
1656 | |
1657 | return write_flush(filp, buf, count, ppos, cd); | |
1658 | } | |
1659 | ||
97a32539 AD |
1660 | static const struct proc_ops cache_flush_proc_ops = { |
1661 | .proc_open = open_flush_procfs, | |
1662 | .proc_read = read_flush_procfs, | |
1663 | .proc_write = write_flush_procfs, | |
1664 | .proc_release = release_flush_procfs, | |
1665 | .proc_lseek = no_llseek, | |
1da177e4 | 1666 | }; |
173912a6 | 1667 | |
863d7d9c | 1668 | static void remove_cache_proc_entries(struct cache_detail *cd) |
173912a6 | 1669 | { |
863d7d9c KM |
1670 | if (cd->procfs) { |
1671 | proc_remove(cd->procfs); | |
1672 | cd->procfs = NULL; | |
1673 | } | |
173912a6 TM |
1674 | } |
1675 | ||
1676 | #ifdef CONFIG_PROC_FS | |
593ce16b | 1677 | static int create_cache_proc_entries(struct cache_detail *cd, struct net *net) |
173912a6 TM |
1678 | { |
1679 | struct proc_dir_entry *p; | |
4f42d0d5 | 1680 | struct sunrpc_net *sn; |
173912a6 | 1681 | |
4f42d0d5 | 1682 | sn = net_generic(net, sunrpc_net_id); |
863d7d9c KM |
1683 | cd->procfs = proc_mkdir(cd->name, sn->proc_net_rpc); |
1684 | if (cd->procfs == NULL) | |
173912a6 | 1685 | goto out_nomem; |
173912a6 | 1686 | |
d6444062 | 1687 | p = proc_create_data("flush", S_IFREG | 0600, |
97a32539 | 1688 | cd->procfs, &cache_flush_proc_ops, cd); |
173912a6 TM |
1689 | if (p == NULL) |
1690 | goto out_nomem; | |
1691 | ||
2d438338 | 1692 | if (cd->cache_request || cd->cache_parse) { |
d6444062 | 1693 | p = proc_create_data("channel", S_IFREG | 0600, cd->procfs, |
97a32539 | 1694 | &cache_channel_proc_ops, cd); |
173912a6 TM |
1695 | if (p == NULL) |
1696 | goto out_nomem; | |
1697 | } | |
1698 | if (cd->cache_show) { | |
d6444062 | 1699 | p = proc_create_data("content", S_IFREG | 0400, cd->procfs, |
97a32539 | 1700 | &content_proc_ops, cd); |
173912a6 TM |
1701 | if (p == NULL) |
1702 | goto out_nomem; | |
1703 | } | |
1704 | return 0; | |
1705 | out_nomem: | |
863d7d9c | 1706 | remove_cache_proc_entries(cd); |
173912a6 TM |
1707 | return -ENOMEM; |
1708 | } | |
1709 | #else /* CONFIG_PROC_FS */ | |
593ce16b | 1710 | static int create_cache_proc_entries(struct cache_detail *cd, struct net *net) |
173912a6 TM |
1711 | { |
1712 | return 0; | |
1713 | } | |
1714 | #endif | |
1715 | ||
8eab945c AB |
1716 | void __init cache_initialize(void) |
1717 | { | |
203b42f7 | 1718 | INIT_DEFERRABLE_WORK(&cache_cleaner, do_cache_clean); |
8eab945c AB |
1719 | } |
1720 | ||
593ce16b | 1721 | int cache_register_net(struct cache_detail *cd, struct net *net) |
173912a6 TM |
1722 | { |
1723 | int ret; | |
1724 | ||
1725 | sunrpc_init_cache_detail(cd); | |
593ce16b | 1726 | ret = create_cache_proc_entries(cd, net); |
173912a6 TM |
1727 | if (ret) |
1728 | sunrpc_destroy_cache_detail(cd); | |
1729 | return ret; | |
1730 | } | |
f5c8593b | 1731 | EXPORT_SYMBOL_GPL(cache_register_net); |
593ce16b | 1732 | |
593ce16b | 1733 | void cache_unregister_net(struct cache_detail *cd, struct net *net) |
173912a6 | 1734 | { |
863d7d9c | 1735 | remove_cache_proc_entries(cd); |
173912a6 TM |
1736 | sunrpc_destroy_cache_detail(cd); |
1737 | } | |
f5c8593b | 1738 | EXPORT_SYMBOL_GPL(cache_unregister_net); |
593ce16b | 1739 | |
d34971a6 | 1740 | struct cache_detail *cache_create_net(const struct cache_detail *tmpl, struct net *net) |
0a402d5a SK |
1741 | { |
1742 | struct cache_detail *cd; | |
129e5824 | 1743 | int i; |
0a402d5a SK |
1744 | |
1745 | cd = kmemdup(tmpl, sizeof(struct cache_detail), GFP_KERNEL); | |
1746 | if (cd == NULL) | |
1747 | return ERR_PTR(-ENOMEM); | |
1748 | ||
6396bb22 | 1749 | cd->hash_table = kcalloc(cd->hash_size, sizeof(struct hlist_head), |
0a402d5a SK |
1750 | GFP_KERNEL); |
1751 | if (cd->hash_table == NULL) { | |
1752 | kfree(cd); | |
1753 | return ERR_PTR(-ENOMEM); | |
1754 | } | |
129e5824 KM |
1755 | |
1756 | for (i = 0; i < cd->hash_size; i++) | |
1757 | INIT_HLIST_HEAD(&cd->hash_table[i]); | |
0a402d5a SK |
1758 | cd->net = net; |
1759 | return cd; | |
1760 | } | |
1761 | EXPORT_SYMBOL_GPL(cache_create_net); | |
1762 | ||
1763 | void cache_destroy_net(struct cache_detail *cd, struct net *net) | |
593ce16b | 1764 | { |
0a402d5a SK |
1765 | kfree(cd->hash_table); |
1766 | kfree(cd); | |
593ce16b | 1767 | } |
0a402d5a | 1768 | EXPORT_SYMBOL_GPL(cache_destroy_net); |
8854e82d TM |
1769 | |
1770 | static ssize_t cache_read_pipefs(struct file *filp, char __user *buf, | |
1771 | size_t count, loff_t *ppos) | |
1772 | { | |
496ad9aa | 1773 | struct cache_detail *cd = RPC_I(file_inode(filp))->private; |
8854e82d TM |
1774 | |
1775 | return cache_read(filp, buf, count, ppos, cd); | |
1776 | } | |
1777 | ||
1778 | static ssize_t cache_write_pipefs(struct file *filp, const char __user *buf, | |
1779 | size_t count, loff_t *ppos) | |
1780 | { | |
496ad9aa | 1781 | struct cache_detail *cd = RPC_I(file_inode(filp))->private; |
8854e82d TM |
1782 | |
1783 | return cache_write(filp, buf, count, ppos, cd); | |
1784 | } | |
1785 | ||
ade994f4 | 1786 | static __poll_t cache_poll_pipefs(struct file *filp, poll_table *wait) |
8854e82d | 1787 | { |
496ad9aa | 1788 | struct cache_detail *cd = RPC_I(file_inode(filp))->private; |
8854e82d TM |
1789 | |
1790 | return cache_poll(filp, wait, cd); | |
1791 | } | |
1792 | ||
9918ff26 | 1793 | static long cache_ioctl_pipefs(struct file *filp, |
8854e82d TM |
1794 | unsigned int cmd, unsigned long arg) |
1795 | { | |
496ad9aa | 1796 | struct inode *inode = file_inode(filp); |
8854e82d TM |
1797 | struct cache_detail *cd = RPC_I(inode)->private; |
1798 | ||
a6f8dbc6 | 1799 | return cache_ioctl(inode, filp, cmd, arg, cd); |
8854e82d TM |
1800 | } |
1801 | ||
1802 | static int cache_open_pipefs(struct inode *inode, struct file *filp) | |
1803 | { | |
1804 | struct cache_detail *cd = RPC_I(inode)->private; | |
1805 | ||
1806 | return cache_open(inode, filp, cd); | |
1807 | } | |
1808 | ||
1809 | static int cache_release_pipefs(struct inode *inode, struct file *filp) | |
1810 | { | |
1811 | struct cache_detail *cd = RPC_I(inode)->private; | |
1812 | ||
1813 | return cache_release(inode, filp, cd); | |
1814 | } | |
1815 | ||
1816 | const struct file_operations cache_file_operations_pipefs = { | |
1817 | .owner = THIS_MODULE, | |
1818 | .llseek = no_llseek, | |
1819 | .read = cache_read_pipefs, | |
1820 | .write = cache_write_pipefs, | |
1821 | .poll = cache_poll_pipefs, | |
9918ff26 | 1822 | .unlocked_ioctl = cache_ioctl_pipefs, /* for FIONREAD */ |
8854e82d TM |
1823 | .open = cache_open_pipefs, |
1824 | .release = cache_release_pipefs, | |
1825 | }; | |
1826 | ||
1827 | static int content_open_pipefs(struct inode *inode, struct file *filp) | |
1828 | { | |
1829 | struct cache_detail *cd = RPC_I(inode)->private; | |
1830 | ||
1831 | return content_open(inode, filp, cd); | |
1832 | } | |
1833 | ||
f7e86ab9 TM |
1834 | static int content_release_pipefs(struct inode *inode, struct file *filp) |
1835 | { | |
1836 | struct cache_detail *cd = RPC_I(inode)->private; | |
1837 | ||
1838 | return content_release(inode, filp, cd); | |
1839 | } | |
1840 | ||
8854e82d TM |
1841 | const struct file_operations content_file_operations_pipefs = { |
1842 | .open = content_open_pipefs, | |
1843 | .read = seq_read, | |
1844 | .llseek = seq_lseek, | |
f7e86ab9 | 1845 | .release = content_release_pipefs, |
8854e82d TM |
1846 | }; |
1847 | ||
f7e86ab9 TM |
1848 | static int open_flush_pipefs(struct inode *inode, struct file *filp) |
1849 | { | |
1850 | struct cache_detail *cd = RPC_I(inode)->private; | |
1851 | ||
1852 | return open_flush(inode, filp, cd); | |
1853 | } | |
1854 | ||
1855 | static int release_flush_pipefs(struct inode *inode, struct file *filp) | |
1856 | { | |
1857 | struct cache_detail *cd = RPC_I(inode)->private; | |
1858 | ||
1859 | return release_flush(inode, filp, cd); | |
1860 | } | |
1861 | ||
8854e82d TM |
1862 | static ssize_t read_flush_pipefs(struct file *filp, char __user *buf, |
1863 | size_t count, loff_t *ppos) | |
1864 | { | |
496ad9aa | 1865 | struct cache_detail *cd = RPC_I(file_inode(filp))->private; |
8854e82d TM |
1866 | |
1867 | return read_flush(filp, buf, count, ppos, cd); | |
1868 | } | |
1869 | ||
1870 | static ssize_t write_flush_pipefs(struct file *filp, | |
1871 | const char __user *buf, | |
1872 | size_t count, loff_t *ppos) | |
1873 | { | |
496ad9aa | 1874 | struct cache_detail *cd = RPC_I(file_inode(filp))->private; |
8854e82d TM |
1875 | |
1876 | return write_flush(filp, buf, count, ppos, cd); | |
1877 | } | |
1878 | ||
1879 | const struct file_operations cache_flush_operations_pipefs = { | |
f7e86ab9 | 1880 | .open = open_flush_pipefs, |
8854e82d TM |
1881 | .read = read_flush_pipefs, |
1882 | .write = write_flush_pipefs, | |
f7e86ab9 | 1883 | .release = release_flush_pipefs, |
6038f373 | 1884 | .llseek = no_llseek, |
8854e82d TM |
1885 | }; |
1886 | ||
1887 | int sunrpc_cache_register_pipefs(struct dentry *parent, | |
64f1426f | 1888 | const char *name, umode_t umode, |
8854e82d TM |
1889 | struct cache_detail *cd) |
1890 | { | |
a95e691f AV |
1891 | struct dentry *dir = rpc_create_cache_dir(parent, name, umode, cd); |
1892 | if (IS_ERR(dir)) | |
1893 | return PTR_ERR(dir); | |
863d7d9c | 1894 | cd->pipefs = dir; |
a95e691f | 1895 | return 0; |
8854e82d TM |
1896 | } |
1897 | EXPORT_SYMBOL_GPL(sunrpc_cache_register_pipefs); | |
1898 | ||
1899 | void sunrpc_cache_unregister_pipefs(struct cache_detail *cd) | |
1900 | { | |
863d7d9c KM |
1901 | if (cd->pipefs) { |
1902 | rpc_remove_cache_dir(cd->pipefs); | |
1903 | cd->pipefs = NULL; | |
1904 | } | |
8854e82d TM |
1905 | } |
1906 | EXPORT_SYMBOL_GPL(sunrpc_cache_unregister_pipefs); | |
1907 | ||
2b477c00 NB |
1908 | void sunrpc_cache_unhash(struct cache_detail *cd, struct cache_head *h) |
1909 | { | |
1863d77f | 1910 | spin_lock(&cd->hash_lock); |
2b477c00 | 1911 | if (!hlist_unhashed(&h->cache_list)){ |
809fe3c5 | 1912 | sunrpc_begin_cache_remove_entry(h, cd); |
1863d77f | 1913 | spin_unlock(&cd->hash_lock); |
809fe3c5 | 1914 | sunrpc_end_cache_remove_entry(h, cd); |
2b477c00 | 1915 | } else |
1863d77f | 1916 | spin_unlock(&cd->hash_lock); |
2b477c00 NB |
1917 | } |
1918 | EXPORT_SYMBOL_GPL(sunrpc_cache_unhash); |