1
2
3
4
5
6
7
8
9
10
11
12
13
14#ifndef _LINUX_FSCACHE_CACHE_H
15#define _LINUX_FSCACHE_CACHE_H
16
17#include <linux/fscache.h>
18#include <linux/sched.h>
19#include <linux/workqueue.h>
20
21#define NR_MAXCACHES BITS_PER_LONG
22
23struct fscache_cache;
24struct fscache_cache_ops;
25struct fscache_object;
26struct fscache_operation;
27
28enum fscache_obj_ref_trace {
29 fscache_obj_get_add_to_deps,
30 fscache_obj_get_queue,
31 fscache_obj_put_alloc_fail,
32 fscache_obj_put_attach_fail,
33 fscache_obj_put_drop_obj,
34 fscache_obj_put_enq_dep,
35 fscache_obj_put_queue,
36 fscache_obj_put_work,
37 fscache_obj_ref__nr_traces
38};
39
40
41
42
43struct fscache_cache_tag {
44 struct list_head link;
45 struct fscache_cache *cache;
46 unsigned long flags;
47#define FSCACHE_TAG_RESERVED 0
48 atomic_t usage;
49 char name[];
50};
51
52
53
54
55struct fscache_cache {
56 const struct fscache_cache_ops *ops;
57 struct fscache_cache_tag *tag;
58 struct kobject *kobj;
59 struct list_head link;
60 size_t max_index_size;
61 char identifier[36];
62
63
64 struct work_struct op_gc;
65 struct list_head object_list;
66 struct list_head op_gc_list;
67 spinlock_t object_list_lock;
68 spinlock_t op_gc_list_lock;
69 atomic_t object_count;
70 struct fscache_object *fsdef;
71 unsigned long flags;
72#define FSCACHE_IOERROR 0
73#define FSCACHE_CACHE_WITHDRAWN 1
74};
75
76extern wait_queue_head_t fscache_cache_cleared_wq;
77
78
79
80
81
82
83typedef void (*fscache_operation_release_t)(struct fscache_operation *op);
84typedef void (*fscache_operation_processor_t)(struct fscache_operation *op);
85typedef void (*fscache_operation_cancel_t)(struct fscache_operation *op);
86
87enum fscache_operation_state {
88 FSCACHE_OP_ST_BLANK,
89 FSCACHE_OP_ST_INITIALISED,
90 FSCACHE_OP_ST_PENDING,
91 FSCACHE_OP_ST_IN_PROGRESS,
92 FSCACHE_OP_ST_COMPLETE,
93 FSCACHE_OP_ST_CANCELLED,
94 FSCACHE_OP_ST_DEAD
95};
96
97struct fscache_operation {
98 struct work_struct work;
99 struct list_head pend_link;
100 struct fscache_object *object;
101
102 unsigned long flags;
103#define FSCACHE_OP_TYPE 0x000f
104#define FSCACHE_OP_ASYNC 0x0001
105#define FSCACHE_OP_MYTHREAD 0x0002
106#define FSCACHE_OP_WAITING 4
107#define FSCACHE_OP_EXCLUSIVE 5
108#define FSCACHE_OP_DEC_READ_CNT 6
109#define FSCACHE_OP_UNUSE_COOKIE 7
110#define FSCACHE_OP_KEEP_FLAGS 0x00f0
111
112 enum fscache_operation_state state;
113 atomic_t usage;
114 unsigned debug_id;
115
116
117
118
119 fscache_operation_processor_t processor;
120
121
122 fscache_operation_cancel_t cancel;
123
124
125 fscache_operation_release_t release;
126};
127
128extern atomic_t fscache_op_debug_id;
129extern void fscache_op_work_func(struct work_struct *work);
130
131extern void fscache_enqueue_operation(struct fscache_operation *);
132extern void fscache_op_complete(struct fscache_operation *, bool);
133extern void fscache_put_operation(struct fscache_operation *);
134extern void fscache_operation_init(struct fscache_cookie *,
135 struct fscache_operation *,
136 fscache_operation_processor_t,
137 fscache_operation_cancel_t,
138 fscache_operation_release_t);
139
140
141
142
143struct fscache_retrieval {
144 struct fscache_operation op;
145 struct fscache_cookie *cookie;
146 struct address_space *mapping;
147 fscache_rw_complete_t end_io_func;
148 void *context;
149 struct list_head to_do;
150 atomic_t n_pages;
151};
152
153typedef int (*fscache_page_retrieval_func_t)(struct fscache_retrieval *op,
154 struct page *page,
155 gfp_t gfp);
156
157typedef int (*fscache_pages_retrieval_func_t)(struct fscache_retrieval *op,
158 struct list_head *pages,
159 unsigned *nr_pages,
160 gfp_t gfp);
161
162
163
164
165
166
167
168static inline
169struct fscache_retrieval *fscache_get_retrieval(struct fscache_retrieval *op)
170{
171 atomic_inc(&op->op.usage);
172 return op;
173}
174
175
176
177
178
179
180
181static inline void fscache_enqueue_retrieval(struct fscache_retrieval *op)
182{
183 fscache_enqueue_operation(&op->op);
184}
185
186
187
188
189
190
191static inline void fscache_retrieval_complete(struct fscache_retrieval *op,
192 int n_pages)
193{
194 if (atomic_sub_return_relaxed(n_pages, &op->n_pages) <= 0)
195 fscache_op_complete(&op->op, false);
196}
197
198
199
200
201
202
203
204static inline void fscache_put_retrieval(struct fscache_retrieval *op)
205{
206 fscache_put_operation(&op->op);
207}
208
209
210
211
212
213
214
215
216struct fscache_storage {
217 struct fscache_operation op;
218 pgoff_t store_limit;
219};
220
221
222
223
224struct fscache_cache_ops {
225
226 const char *name;
227
228
229 struct fscache_object *(*alloc_object)(struct fscache_cache *cache,
230 struct fscache_cookie *cookie);
231
232
233
234
235 int (*lookup_object)(struct fscache_object *object);
236
237
238 void (*lookup_complete)(struct fscache_object *object);
239
240
241 struct fscache_object *(*grab_object)(struct fscache_object *object,
242 enum fscache_obj_ref_trace why);
243
244
245 int (*pin_object)(struct fscache_object *object);
246
247
248 void (*unpin_object)(struct fscache_object *object);
249
250
251
252 int (*check_consistency)(struct fscache_operation *op);
253
254
255 void (*update_object)(struct fscache_object *object);
256
257
258 void (*invalidate_object)(struct fscache_operation *op);
259
260
261
262 void (*drop_object)(struct fscache_object *object);
263
264
265 void (*put_object)(struct fscache_object *object,
266 enum fscache_obj_ref_trace why);
267
268
269 void (*sync_cache)(struct fscache_cache *cache);
270
271
272
273 int (*attr_changed)(struct fscache_object *object);
274
275
276 int (*reserve_space)(struct fscache_object *object, loff_t i_size);
277
278
279
280 fscache_page_retrieval_func_t read_or_alloc_page;
281
282
283
284 fscache_pages_retrieval_func_t read_or_alloc_pages;
285
286
287
288 fscache_page_retrieval_func_t allocate_page;
289
290
291
292 fscache_pages_retrieval_func_t allocate_pages;
293
294
295 int (*write_page)(struct fscache_storage *op, struct page *page);
296
297
298
299
300
301 void (*uncache_page)(struct fscache_object *object,
302 struct page *page);
303
304
305 void (*dissociate_pages)(struct fscache_cache *cache);
306
307
308 int (*begin_read_operation)(struct netfs_read_request *rreq,
309 struct fscache_retrieval *op);
310};
311
312extern struct fscache_cookie fscache_fsdef_index;
313
314
315
316
317enum {
318 FSCACHE_OBJECT_EV_NEW_CHILD,
319 FSCACHE_OBJECT_EV_PARENT_READY,
320 FSCACHE_OBJECT_EV_UPDATE,
321 FSCACHE_OBJECT_EV_INVALIDATE,
322 FSCACHE_OBJECT_EV_CLEARED,
323 FSCACHE_OBJECT_EV_ERROR,
324 FSCACHE_OBJECT_EV_KILL,
325 NR_FSCACHE_OBJECT_EVENTS
326};
327
328#define FSCACHE_OBJECT_EVENTS_MASK ((1UL << NR_FSCACHE_OBJECT_EVENTS) - 1)
329
330
331
332
333struct fscache_transition {
334 unsigned long events;
335 const struct fscache_state *transit_to;
336};
337
338struct fscache_state {
339 char name[24];
340 char short_name[8];
341 const struct fscache_state *(*work)(struct fscache_object *object,
342 int event);
343 const struct fscache_transition transitions[];
344};
345
346
347
348
349struct fscache_object {
350 const struct fscache_state *state;
351 const struct fscache_transition *oob_table;
352 int debug_id;
353 int n_children;
354 int n_ops;
355 int n_obj_ops;
356 int n_in_progress;
357 int n_exclusive;
358 atomic_t n_reads;
359 spinlock_t lock;
360
361 unsigned long lookup_jif;
362 unsigned long oob_event_mask;
363 unsigned long event_mask;
364 unsigned long events;
365
366
367 unsigned long flags;
368#define FSCACHE_OBJECT_LOCK 0
369#define FSCACHE_OBJECT_PENDING_WRITE 1
370#define FSCACHE_OBJECT_WAITING 2
371#define FSCACHE_OBJECT_IS_LIVE 3
372#define FSCACHE_OBJECT_IS_LOOKED_UP 4
373#define FSCACHE_OBJECT_IS_AVAILABLE 5
374#define FSCACHE_OBJECT_RETIRED 6
375#define FSCACHE_OBJECT_KILLED_BY_CACHE 7
376#define FSCACHE_OBJECT_RUN_AFTER_DEAD 8
377
378 struct list_head cache_link;
379 struct hlist_node cookie_link;
380 struct fscache_cache *cache;
381 struct fscache_cookie *cookie;
382 struct fscache_object *parent;
383 struct work_struct work;
384 struct list_head dependents;
385 struct list_head dep_link;
386 struct list_head pending_ops;
387 pgoff_t store_limit;
388 loff_t store_limit_l;
389};
390
391extern void fscache_object_init(struct fscache_object *, struct fscache_cookie *,
392 struct fscache_cache *);
393extern void fscache_object_destroy(struct fscache_object *);
394
395extern void fscache_object_lookup_negative(struct fscache_object *object);
396extern void fscache_obtained_object(struct fscache_object *object);
397
398static inline bool fscache_object_is_live(struct fscache_object *object)
399{
400 return test_bit(FSCACHE_OBJECT_IS_LIVE, &object->flags);
401}
402
403static inline bool fscache_object_is_dying(struct fscache_object *object)
404{
405 return !fscache_object_is_live(object);
406}
407
408static inline bool fscache_object_is_available(struct fscache_object *object)
409{
410 return test_bit(FSCACHE_OBJECT_IS_AVAILABLE, &object->flags);
411}
412
413static inline bool fscache_cache_is_broken(struct fscache_object *object)
414{
415 return test_bit(FSCACHE_IOERROR, &object->cache->flags);
416}
417
418static inline bool fscache_object_is_active(struct fscache_object *object)
419{
420 return fscache_object_is_available(object) &&
421 fscache_object_is_live(object) &&
422 !fscache_cache_is_broken(object);
423}
424
425
426
427
428
429
430
431static inline void fscache_object_destroyed(struct fscache_cache *cache)
432{
433 if (atomic_dec_and_test(&cache->object_count))
434 wake_up_all(&fscache_cache_cleared_wq);
435}
436
437
438
439
440
441
442
443
444static inline void fscache_object_lookup_error(struct fscache_object *object)
445{
446 set_bit(FSCACHE_OBJECT_EV_ERROR, &object->events);
447}
448
449
450
451
452
453
454
455
456
457
458
459
460static inline
461void fscache_set_store_limit(struct fscache_object *object, loff_t i_size)
462{
463 object->store_limit_l = i_size;
464 object->store_limit = i_size >> PAGE_SHIFT;
465 if (i_size & ~PAGE_MASK)
466 object->store_limit++;
467}
468
469
470
471
472
473
474
475
476
477
478static inline void fscache_end_io(struct fscache_retrieval *op,
479 struct page *page, int error)
480{
481 op->end_io_func(page, op->context, error);
482}
483
484static inline void __fscache_use_cookie(struct fscache_cookie *cookie)
485{
486 atomic_inc(&cookie->n_active);
487}
488
489
490
491
492
493
494
495
496static inline bool fscache_use_cookie(struct fscache_object *object)
497{
498 struct fscache_cookie *cookie = object->cookie;
499 return atomic_inc_not_zero(&cookie->n_active) != 0;
500}
501
502static inline bool __fscache_unuse_cookie(struct fscache_cookie *cookie)
503{
504 return atomic_dec_and_test(&cookie->n_active);
505}
506
507static inline void __fscache_wake_unused_cookie(struct fscache_cookie *cookie)
508{
509 wake_up_var(&cookie->n_active);
510}
511
512
513
514
515
516
517
518
519static inline void fscache_unuse_cookie(struct fscache_object *object)
520{
521 struct fscache_cookie *cookie = object->cookie;
522 if (__fscache_unuse_cookie(cookie))
523 __fscache_wake_unused_cookie(cookie);
524}
525
526
527
528
529extern __printf(3, 4)
530void fscache_init_cache(struct fscache_cache *cache,
531 const struct fscache_cache_ops *ops,
532 const char *idfmt, ...);
533
534extern int fscache_add_cache(struct fscache_cache *cache,
535 struct fscache_object *fsdef,
536 const char *tagname);
537extern void fscache_withdraw_cache(struct fscache_cache *cache);
538
539extern void fscache_io_error(struct fscache_cache *cache);
540
541extern void fscache_mark_page_cached(struct fscache_retrieval *op,
542 struct page *page);
543
544extern void fscache_mark_pages_cached(struct fscache_retrieval *op,
545 struct pagevec *pagevec);
546
547extern bool fscache_object_sleep_till_congested(signed long *timeoutp);
548
549extern enum fscache_checkaux fscache_check_aux(struct fscache_object *object,
550 const void *data,
551 uint16_t datalen,
552 loff_t object_size);
553
554extern void fscache_object_retrying_stale(struct fscache_object *object);
555
556enum fscache_why_object_killed {
557 FSCACHE_OBJECT_IS_STALE,
558 FSCACHE_OBJECT_NO_SPACE,
559 FSCACHE_OBJECT_WAS_RETIRED,
560 FSCACHE_OBJECT_WAS_CULLED,
561};
562extern void fscache_object_mark_killed(struct fscache_object *object,
563 enum fscache_why_object_killed why);
564
565#endif
566