1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /* General netfs cache on cache files internal defs
4 * Copyright (C) 2007 Red Hat, Inc. All Rights Reserved.
5 * Written by David Howells (dhowells@redhat.com)
12 #define pr_fmt(fmt) "CacheFiles: " fmt
15 #include <linux/fscache-cache.h>
16 #include <linux/timer.h>
17 #include <linux/wait_bit.h>
18 #include <linux/cred.h>
19 #include <linux/workqueue.h>
20 #include <linux/security.h>
22 struct cachefiles_cache
;
23 struct cachefiles_object
;
25 extern unsigned cachefiles_debug
;
26 #define CACHEFILES_DEBUG_KENTER 1
27 #define CACHEFILES_DEBUG_KLEAVE 2
28 #define CACHEFILES_DEBUG_KDEBUG 4
30 #define cachefiles_gfp (__GFP_RECLAIM | __GFP_NORETRY | __GFP_NOMEMALLOC)
35 struct cachefiles_object
{
36 struct fscache_object fscache
; /* fscache handle */
37 struct cachefiles_lookup_data
*lookup_data
; /* cached lookup data */
38 struct dentry
*dentry
; /* the file/dir representing this object */
39 struct dentry
*backer
; /* backing file */
40 loff_t i_size
; /* object size */
42 #define CACHEFILES_OBJECT_ACTIVE 0 /* T if marked active */
43 atomic_t usage
; /* object usage count */
44 uint8_t type
; /* object type */
45 uint8_t new; /* T if object new */
47 struct rb_node active_node
; /* link in active tree (dentry is key) */
50 extern struct kmem_cache
*cachefiles_object_jar
;
53 * Cache files cache definition
55 struct cachefiles_cache
{
56 struct fscache_cache cache
; /* FS-Cache record */
57 struct vfsmount
*mnt
; /* mountpoint holding the cache */
58 struct dentry
*graveyard
; /* directory into which dead objects go */
59 struct file
*cachefilesd
; /* manager daemon handle */
60 const struct cred
*cache_cred
; /* security override for accessing cache */
61 struct mutex daemon_mutex
; /* command serialisation mutex */
62 wait_queue_head_t daemon_pollwq
; /* poll waitqueue for daemon */
63 struct rb_root active_nodes
; /* active nodes (can't be culled) */
64 rwlock_t active_lock
; /* lock for active_nodes */
65 atomic_t gravecounter
; /* graveyard uniquifier */
66 atomic_t f_released
; /* number of objects released lately */
67 atomic_long_t b_released
; /* number of blocks released lately */
68 unsigned frun_percent
; /* when to stop culling (% files) */
69 unsigned fcull_percent
; /* when to start culling (% files) */
70 unsigned fstop_percent
; /* when to stop allocating (% files) */
71 unsigned brun_percent
; /* when to stop culling (% blocks) */
72 unsigned bcull_percent
; /* when to start culling (% blocks) */
73 unsigned bstop_percent
; /* when to stop allocating (% blocks) */
74 unsigned bsize
; /* cache's block size */
75 unsigned bshift
; /* min(ilog2(PAGE_SIZE / bsize), 0) */
76 uint64_t frun
; /* when to stop culling */
77 uint64_t fcull
; /* when to start culling */
78 uint64_t fstop
; /* when to stop allocating */
79 sector_t brun
; /* when to stop culling */
80 sector_t bcull
; /* when to start culling */
81 sector_t bstop
; /* when to stop allocating */
83 #define CACHEFILES_READY 0 /* T if cache prepared */
84 #define CACHEFILES_DEAD 1 /* T if cache dead */
85 #define CACHEFILES_CULLING 2 /* T if cull engaged */
86 #define CACHEFILES_STATE_CHANGED 3 /* T if state changed (poll trigger) */
87 char *rootdirname
; /* name of cache root directory */
88 char *secctx
; /* LSM security context */
89 char *tag
; /* cache binding tag */
93 * backing file read tracking
95 struct cachefiles_one_read
{
96 wait_queue_entry_t monitor
; /* link into monitored waitqueue */
97 struct page
*back_page
; /* backing file page we're waiting for */
98 struct page
*netfs_page
; /* netfs page we're going to fill */
99 struct fscache_retrieval
*op
; /* retrieval op covering this */
100 struct list_head op_link
; /* link in op's todo list */
104 * backing file write tracking
106 struct cachefiles_one_write
{
107 struct page
*netfs_page
; /* netfs page to copy */
108 struct cachefiles_object
*object
;
109 struct list_head obj_link
; /* link in object's lists */
110 fscache_rw_complete_t end_io_func
;
115 * auxiliary data xattr buffer
117 struct cachefiles_xattr
{
123 #include <trace/events/cachefiles.h>
126 * note change of state for daemon
128 static inline void cachefiles_state_changed(struct cachefiles_cache
*cache
)
130 set_bit(CACHEFILES_STATE_CHANGED
, &cache
->flags
);
131 wake_up_all(&cache
->daemon_pollwq
);
137 extern int cachefiles_daemon_bind(struct cachefiles_cache
*cache
, char *args
);
138 extern void cachefiles_daemon_unbind(struct cachefiles_cache
*cache
);
143 extern const struct file_operations cachefiles_daemon_fops
;
145 extern int cachefiles_has_space(struct cachefiles_cache
*cache
,
146 unsigned fnr
, unsigned bnr
);
151 extern const struct fscache_cache_ops cachefiles_cache_ops
;
153 void cachefiles_put_object(struct fscache_object
*_object
,
154 enum fscache_obj_ref_trace why
);
159 extern char *cachefiles_cook_key(const u8
*raw
, int keylen
, uint8_t type
);
164 extern void cachefiles_mark_object_inactive(struct cachefiles_cache
*cache
,
165 struct cachefiles_object
*object
,
167 extern int cachefiles_delete_object(struct cachefiles_cache
*cache
,
168 struct cachefiles_object
*object
);
169 extern int cachefiles_walk_to_object(struct cachefiles_object
*parent
,
170 struct cachefiles_object
*object
,
172 struct cachefiles_xattr
*auxdata
);
173 extern struct dentry
*cachefiles_get_directory(struct cachefiles_cache
*cache
,
177 extern int cachefiles_cull(struct cachefiles_cache
*cache
, struct dentry
*dir
,
180 extern int cachefiles_check_in_use(struct cachefiles_cache
*cache
,
181 struct dentry
*dir
, char *filename
);
186 #ifdef CONFIG_CACHEFILES_HISTOGRAM
187 extern atomic_t cachefiles_lookup_histogram
[HZ
];
188 extern atomic_t cachefiles_mkdir_histogram
[HZ
];
189 extern atomic_t cachefiles_create_histogram
[HZ
];
191 extern int __init
cachefiles_proc_init(void);
192 extern void cachefiles_proc_cleanup(void);
194 void cachefiles_hist(atomic_t histogram
[], unsigned long start_jif
)
196 unsigned long jif
= jiffies
- start_jif
;
199 atomic_inc(&histogram
[jif
]);
203 #define cachefiles_proc_init() (0)
204 #define cachefiles_proc_cleanup() do {} while (0)
205 #define cachefiles_hist(hist, start_jif) do {} while (0)
211 extern int cachefiles_read_or_alloc_page(struct fscache_retrieval
*,
212 struct page
*, gfp_t
);
213 extern int cachefiles_read_or_alloc_pages(struct fscache_retrieval
*,
214 struct list_head
*, unsigned *,
216 extern int cachefiles_allocate_page(struct fscache_retrieval
*, struct page
*,
218 extern int cachefiles_allocate_pages(struct fscache_retrieval
*,
219 struct list_head
*, unsigned *, gfp_t
);
220 extern int cachefiles_write_page(struct fscache_storage
*, struct page
*);
221 extern void cachefiles_uncache_page(struct fscache_object
*, struct page
*);
226 extern int cachefiles_begin_read_operation(struct netfs_read_request
*,
227 struct fscache_retrieval
*);
232 extern int cachefiles_get_security_ID(struct cachefiles_cache
*cache
);
233 extern int cachefiles_determine_cache_security(struct cachefiles_cache
*cache
,
235 const struct cred
**_saved_cred
);
237 static inline void cachefiles_begin_secure(struct cachefiles_cache
*cache
,
238 const struct cred
**_saved_cred
)
240 *_saved_cred
= override_creds(cache
->cache_cred
);
243 static inline void cachefiles_end_secure(struct cachefiles_cache
*cache
,
244 const struct cred
*saved_cred
)
246 revert_creds(saved_cred
);
252 extern int cachefiles_check_object_type(struct cachefiles_object
*object
);
253 extern int cachefiles_set_object_xattr(struct cachefiles_object
*object
,
254 struct cachefiles_xattr
*auxdata
);
255 extern int cachefiles_update_object_xattr(struct cachefiles_object
*object
,
256 struct cachefiles_xattr
*auxdata
);
257 extern int cachefiles_check_auxdata(struct cachefiles_object
*object
);
258 extern int cachefiles_check_object_xattr(struct cachefiles_object
*object
,
259 struct cachefiles_xattr
*auxdata
);
260 extern int cachefiles_remove_object_xattr(struct cachefiles_cache
*cache
,
261 struct dentry
*dentry
);
268 #define cachefiles_io_error(___cache, FMT, ...) \
270 pr_err("I/O Error: " FMT"\n", ##__VA_ARGS__); \
271 fscache_io_error(&(___cache)->cache); \
272 set_bit(CACHEFILES_DEAD, &(___cache)->flags); \
275 #define cachefiles_io_error_obj(object, FMT, ...) \
277 struct cachefiles_cache *___cache; \
279 ___cache = container_of((object)->fscache.cache, \
280 struct cachefiles_cache, cache); \
281 cachefiles_io_error(___cache, FMT, ##__VA_ARGS__); \
288 #define dbgprintk(FMT, ...) \
289 printk(KERN_DEBUG "[%-6.6s] "FMT"\n", current->comm, ##__VA_ARGS__)
291 #define kenter(FMT, ...) dbgprintk("==> %s("FMT")", __func__, ##__VA_ARGS__)
292 #define kleave(FMT, ...) dbgprintk("<== %s()"FMT"", __func__, ##__VA_ARGS__)
293 #define kdebug(FMT, ...) dbgprintk(FMT, ##__VA_ARGS__)
296 #if defined(__KDEBUG)
297 #define _enter(FMT, ...) kenter(FMT, ##__VA_ARGS__)
298 #define _leave(FMT, ...) kleave(FMT, ##__VA_ARGS__)
299 #define _debug(FMT, ...) kdebug(FMT, ##__VA_ARGS__)
301 #elif defined(CONFIG_CACHEFILES_DEBUG)
302 #define _enter(FMT, ...) \
304 if (cachefiles_debug & CACHEFILES_DEBUG_KENTER) \
305 kenter(FMT, ##__VA_ARGS__); \
308 #define _leave(FMT, ...) \
310 if (cachefiles_debug & CACHEFILES_DEBUG_KLEAVE) \
311 kleave(FMT, ##__VA_ARGS__); \
314 #define _debug(FMT, ...) \
316 if (cachefiles_debug & CACHEFILES_DEBUG_KDEBUG) \
317 kdebug(FMT, ##__VA_ARGS__); \
321 #define _enter(FMT, ...) no_printk("==> %s("FMT")", __func__, ##__VA_ARGS__)
322 #define _leave(FMT, ...) no_printk("<== %s()"FMT"", __func__, ##__VA_ARGS__)
323 #define _debug(FMT, ...) no_printk(FMT, ##__VA_ARGS__)
326 #if 1 /* defined(__KDEBUGALL) */
330 if (unlikely(!(X))) { \
332 pr_err("Assertion failed\n"); \
337 #define ASSERTCMP(X, OP, Y) \
339 if (unlikely(!((X) OP (Y)))) { \
341 pr_err("Assertion failed\n"); \
342 pr_err("%lx " #OP " %lx is false\n", \
343 (unsigned long)(X), (unsigned long)(Y)); \
348 #define ASSERTIF(C, X) \
350 if (unlikely((C) && !(X))) { \
352 pr_err("Assertion failed\n"); \
357 #define ASSERTIFCMP(C, X, OP, Y) \
359 if (unlikely((C) && !((X) OP (Y)))) { \
361 pr_err("Assertion failed\n"); \
362 pr_err("%lx " #OP " %lx is false\n", \
363 (unsigned long)(X), (unsigned long)(Y)); \
370 #define ASSERT(X) do {} while (0)
371 #define ASSERTCMP(X, OP, Y) do {} while (0)
372 #define ASSERTIF(C, X) do {} while (0)
373 #define ASSERTIFCMP(C, X, OP, Y) do {} while (0)