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