blob: 2bf12da9baa0666e6c772ede6ff63f4900106fe4 [file] [log] [blame]
Dan Magenheimer077b1f82011-05-26 10:01:36 -06001/*
2 * Cleancache frontend
3 *
4 * This code provides the generic "frontend" layer to call a matching
5 * "backend" driver implementation of cleancache. See
Mike Rapoportad56b732018-03-21 21:22:47 +02006 * Documentation/vm/cleancache.rst for more information.
Dan Magenheimer077b1f82011-05-26 10:01:36 -06007 *
8 * Copyright (C) 2009-2010 Oracle Corp. All rights reserved.
9 * Author: Dan Magenheimer
10 *
11 * This work is licensed under the terms of the GNU GPL, version 2.
12 */
13
14#include <linux/module.h>
15#include <linux/fs.h>
16#include <linux/exportfs.h>
17#include <linux/mm.h>
Dan Magenheimer417fc2c2011-09-21 12:28:04 -040018#include <linux/debugfs.h>
Dan Magenheimer077b1f82011-05-26 10:01:36 -060019#include <linux/cleancache.h>
20
21/*
Vladimir Davydov3cb29d12015-04-14 15:46:48 -070022 * cleancache_ops is set by cleancache_register_ops to contain the pointers
Dan Magenheimer077b1f82011-05-26 10:01:36 -060023 * to the cleancache "backend" implementation functions.
24 */
Julia Lawallb3c6de42016-01-21 16:47:29 +010025static const struct cleancache_ops *cleancache_ops __read_mostly;
Dan Magenheimer077b1f82011-05-26 10:01:36 -060026
Dan Magenheimer417fc2c2011-09-21 12:28:04 -040027/*
Marcin Jabrzyk8fc8f4d2015-01-07 11:14:41 +010028 * Counters available via /sys/kernel/debug/cleancache (if debugfs is
Dan Magenheimer417fc2c2011-09-21 12:28:04 -040029 * properly configured. These are for information only so are not protected
30 * against increment races.
31 */
32static u64 cleancache_succ_gets;
33static u64 cleancache_failed_gets;
34static u64 cleancache_puts;
35static u64 cleancache_invalidates;
Dan Magenheimer077b1f82011-05-26 10:01:36 -060036
Vladimir Davydov3cb29d12015-04-14 15:46:48 -070037static void cleancache_register_ops_sb(struct super_block *sb, void *unused)
38{
39 switch (sb->cleancache_poolid) {
40 case CLEANCACHE_NO_BACKEND:
41 __cleancache_init_fs(sb);
42 break;
43 case CLEANCACHE_NO_BACKEND_SHARED:
44 __cleancache_init_shared_fs(sb);
45 break;
46 }
47}
Dan Magenheimer49a9ab82013-04-30 15:26:56 -070048
49/*
Vladimir Davydov53d85c92015-04-14 15:46:45 -070050 * Register operations for cleancache. Returns 0 on success.
Dan Magenheimer077b1f82011-05-26 10:01:36 -060051 */
Julia Lawallb3c6de42016-01-21 16:47:29 +010052int cleancache_register_ops(const struct cleancache_ops *ops)
Dan Magenheimer077b1f82011-05-26 10:01:36 -060053{
Vladimir Davydov3cb29d12015-04-14 15:46:48 -070054 if (cmpxchg(&cleancache_ops, NULL, ops))
Vladimir Davydov53d85c92015-04-14 15:46:45 -070055 return -EBUSY;
Vladimir Davydov3cb29d12015-04-14 15:46:48 -070056
Konrad Rzeszutek Wilk833f8662013-04-30 15:26:57 -070057 /*
Vladimir Davydov3cb29d12015-04-14 15:46:48 -070058 * A cleancache backend can be built as a module and hence loaded after
59 * a cleancache enabled filesystem has called cleancache_init_fs. To
60 * handle such a scenario, here we call ->init_fs or ->init_shared_fs
61 * for each active super block. To differentiate between local and
62 * shared filesystems, we temporarily initialize sb->cleancache_poolid
63 * to CLEANCACHE_NO_BACKEND or CLEANCACHE_NO_BACKEND_SHARED
64 * respectively in case there is no backend registered at the time
65 * cleancache_init_fs or cleancache_init_shared_fs is called.
66 *
67 * Since filesystems can be mounted concurrently with cleancache
68 * backend registration, we have to be careful to guarantee that all
69 * cleancache enabled filesystems that has been mounted by the time
70 * cleancache_register_ops is called has got and all mounted later will
71 * get cleancache_poolid. This is assured by the following statements
72 * tied together:
73 *
74 * a) iterate_supers skips only those super blocks that has started
75 * ->kill_sb
76 *
77 * b) if iterate_supers encounters a super block that has not finished
78 * ->mount yet, it waits until it is finished
79 *
80 * c) cleancache_init_fs is called from ->mount and
81 * cleancache_invalidate_fs is called from ->kill_sb
82 *
83 * d) we call iterate_supers after cleancache_ops has been set
84 *
85 * From a) it follows that if iterate_supers skips a super block, then
86 * either the super block is already dead, in which case we do not need
87 * to bother initializing cleancache for it, or it was mounted after we
88 * initiated iterate_supers. In the latter case, it must have seen
89 * cleancache_ops set according to d) and initialized cleancache from
90 * ->mount by itself according to c). This proves that we call
91 * ->init_fs at least once for each active super block.
92 *
93 * From b) and c) it follows that if iterate_supers encounters a super
94 * block that has already started ->init_fs, it will wait until ->mount
95 * and hence ->init_fs has finished, then check cleancache_poolid, see
96 * that it has already been set and therefore do nothing. This proves
97 * that we call ->init_fs no more than once for each super block.
98 *
99 * Combined together, the last two paragraphs prove the function
100 * correctness.
101 *
102 * Note that various cleancache callbacks may proceed before this
103 * function is called or even concurrently with it, but since
104 * CLEANCACHE_NO_BACKEND is negative, they will all result in a noop
105 * until the corresponding ->init_fs has been actually called and
106 * cleancache_ops has been set.
Konrad Rzeszutek Wilk833f8662013-04-30 15:26:57 -0700107 */
Vladimir Davydov3cb29d12015-04-14 15:46:48 -0700108 iterate_supers(cleancache_register_ops_sb, NULL);
Vladimir Davydov53d85c92015-04-14 15:46:45 -0700109 return 0;
Dan Magenheimer077b1f82011-05-26 10:01:36 -0600110}
111EXPORT_SYMBOL(cleancache_register_ops);
112
113/* Called by a cleancache-enabled filesystem at time of mount */
114void __cleancache_init_fs(struct super_block *sb)
115{
Vladimir Davydov3cb29d12015-04-14 15:46:48 -0700116 int pool_id = CLEANCACHE_NO_BACKEND;
Dan Magenheimer49a9ab82013-04-30 15:26:56 -0700117
Vladimir Davydov3cb29d12015-04-14 15:46:48 -0700118 if (cleancache_ops) {
119 pool_id = cleancache_ops->init_fs(PAGE_SIZE);
120 if (pool_id < 0)
121 pool_id = CLEANCACHE_NO_POOL;
Dan Magenheimer49a9ab82013-04-30 15:26:56 -0700122 }
Vladimir Davydov3cb29d12015-04-14 15:46:48 -0700123 sb->cleancache_poolid = pool_id;
Dan Magenheimer077b1f82011-05-26 10:01:36 -0600124}
125EXPORT_SYMBOL(__cleancache_init_fs);
126
127/* Called by a cleancache-enabled clustered filesystem at time of mount */
Vladimir Davydov9de16262015-04-14 15:46:42 -0700128void __cleancache_init_shared_fs(struct super_block *sb)
Dan Magenheimer077b1f82011-05-26 10:01:36 -0600129{
Vladimir Davydov3cb29d12015-04-14 15:46:48 -0700130 int pool_id = CLEANCACHE_NO_BACKEND_SHARED;
Dan Magenheimer49a9ab82013-04-30 15:26:56 -0700131
Vladimir Davydov3cb29d12015-04-14 15:46:48 -0700132 if (cleancache_ops) {
Christoph Hellwig85787092017-05-10 15:06:33 +0200133 pool_id = cleancache_ops->init_shared_fs(&sb->s_uuid, PAGE_SIZE);
Vladimir Davydov3cb29d12015-04-14 15:46:48 -0700134 if (pool_id < 0)
135 pool_id = CLEANCACHE_NO_POOL;
Dan Magenheimer49a9ab82013-04-30 15:26:56 -0700136 }
Vladimir Davydov3cb29d12015-04-14 15:46:48 -0700137 sb->cleancache_poolid = pool_id;
Dan Magenheimer077b1f82011-05-26 10:01:36 -0600138}
139EXPORT_SYMBOL(__cleancache_init_shared_fs);
140
141/*
142 * If the filesystem uses exportable filehandles, use the filehandle as
143 * the key, else use the inode number.
144 */
145static int cleancache_get_key(struct inode *inode,
146 struct cleancache_filekey *key)
147{
Al Virob0b03822012-04-02 14:34:06 -0400148 int (*fhfn)(struct inode *, __u32 *fh, int *, struct inode *);
Dan Magenheimer077b1f82011-05-26 10:01:36 -0600149 int len = 0, maxlen = CLEANCACHE_KEY_MAX;
150 struct super_block *sb = inode->i_sb;
151
152 key->u.ino = inode->i_ino;
153 if (sb->s_export_op != NULL) {
154 fhfn = sb->s_export_op->encode_fh;
155 if (fhfn) {
Al Virob0b03822012-04-02 14:34:06 -0400156 len = (*fhfn)(inode, &key->u.fh[0], &maxlen, NULL);
Namjae Jeon94e07a752013-02-17 15:48:11 +0900157 if (len <= FILEID_ROOT || len == FILEID_INVALID)
Dan Magenheimer077b1f82011-05-26 10:01:36 -0600158 return -1;
159 if (maxlen > CLEANCACHE_KEY_MAX)
160 return -1;
161 }
162 }
163 return 0;
164}
165
166/*
167 * "Get" data from cleancache associated with the poolid/inode/index
168 * that were specified when the data was put to cleanache and, if
169 * successful, use it to fill the specified page with data and return 0.
170 * The pageframe is unchanged and returns -1 if the get fails.
171 * Page must be locked by caller.
Dan Magenheimer49a9ab82013-04-30 15:26:56 -0700172 *
173 * The function has two checks before any action is taken - whether
174 * a backend is registered and whether the sb->cleancache_poolid
175 * is correct.
Dan Magenheimer077b1f82011-05-26 10:01:36 -0600176 */
177int __cleancache_get_page(struct page *page)
178{
179 int ret = -1;
180 int pool_id;
181 struct cleancache_filekey key = { .u.key = { 0 } };
182
Konrad Rzeszutek Wilk833f8662013-04-30 15:26:57 -0700183 if (!cleancache_ops) {
Dan Magenheimer49a9ab82013-04-30 15:26:56 -0700184 cleancache_failed_gets++;
Dan Magenheimer077b1f82011-05-26 10:01:36 -0600185 goto out;
Dan Magenheimer49a9ab82013-04-30 15:26:56 -0700186 }
187
Sasha Levin309381fea2014-01-23 15:52:54 -0800188 VM_BUG_ON_PAGE(!PageLocked(page), page);
Vladimir Davydov3cb29d12015-04-14 15:46:48 -0700189 pool_id = page->mapping->host->i_sb->cleancache_poolid;
190 if (pool_id < 0)
Dan Magenheimer49a9ab82013-04-30 15:26:56 -0700191 goto out;
Dan Magenheimer077b1f82011-05-26 10:01:36 -0600192
193 if (cleancache_get_key(page->mapping->host, &key) < 0)
194 goto out;
195
Vladimir Davydov3cb29d12015-04-14 15:46:48 -0700196 ret = cleancache_ops->get_page(pool_id, key, page->index, page);
Dan Magenheimer077b1f82011-05-26 10:01:36 -0600197 if (ret == 0)
198 cleancache_succ_gets++;
199 else
200 cleancache_failed_gets++;
201out:
202 return ret;
203}
204EXPORT_SYMBOL(__cleancache_get_page);
205
206/*
207 * "Put" data from a page to cleancache and associate it with the
208 * (previously-obtained per-filesystem) poolid and the page's,
209 * inode and page index. Page must be locked. Note that a put_page
210 * always "succeeds", though a subsequent get_page may succeed or fail.
Dan Magenheimer49a9ab82013-04-30 15:26:56 -0700211 *
212 * The function has two checks before any action is taken - whether
213 * a backend is registered and whether the sb->cleancache_poolid
214 * is correct.
Dan Magenheimer077b1f82011-05-26 10:01:36 -0600215 */
216void __cleancache_put_page(struct page *page)
217{
218 int pool_id;
219 struct cleancache_filekey key = { .u.key = { 0 } };
220
Konrad Rzeszutek Wilk833f8662013-04-30 15:26:57 -0700221 if (!cleancache_ops) {
Dan Magenheimer49a9ab82013-04-30 15:26:56 -0700222 cleancache_puts++;
223 return;
224 }
225
Sasha Levin309381fea2014-01-23 15:52:54 -0800226 VM_BUG_ON_PAGE(!PageLocked(page), page);
Vladimir Davydov3cb29d12015-04-14 15:46:48 -0700227 pool_id = page->mapping->host->i_sb->cleancache_poolid;
Dan Magenheimer077b1f82011-05-26 10:01:36 -0600228 if (pool_id >= 0 &&
Dan Magenheimer49a9ab82013-04-30 15:26:56 -0700229 cleancache_get_key(page->mapping->host, &key) >= 0) {
Konrad Rzeszutek Wilk833f8662013-04-30 15:26:57 -0700230 cleancache_ops->put_page(pool_id, key, page->index, page);
Dan Magenheimer077b1f82011-05-26 10:01:36 -0600231 cleancache_puts++;
232 }
233}
234EXPORT_SYMBOL(__cleancache_put_page);
235
236/*
Dan Magenheimer31677602011-09-21 11:56:28 -0400237 * Invalidate any data from cleancache associated with the poolid and the
Dan Magenheimer077b1f82011-05-26 10:01:36 -0600238 * page's inode and page index so that a subsequent "get" will fail.
Dan Magenheimer49a9ab82013-04-30 15:26:56 -0700239 *
240 * The function has two checks before any action is taken - whether
241 * a backend is registered and whether the sb->cleancache_poolid
242 * is correct.
Dan Magenheimer077b1f82011-05-26 10:01:36 -0600243 */
Dan Magenheimer31677602011-09-21 11:56:28 -0400244void __cleancache_invalidate_page(struct address_space *mapping,
245 struct page *page)
Dan Magenheimer077b1f82011-05-26 10:01:36 -0600246{
247 /* careful... page->mapping is NULL sometimes when this is called */
Vladimir Davydov3cb29d12015-04-14 15:46:48 -0700248 int pool_id = mapping->host->i_sb->cleancache_poolid;
Dan Magenheimer077b1f82011-05-26 10:01:36 -0600249 struct cleancache_filekey key = { .u.key = { 0 } };
250
Konrad Rzeszutek Wilk833f8662013-04-30 15:26:57 -0700251 if (!cleancache_ops)
Dan Magenheimer49a9ab82013-04-30 15:26:56 -0700252 return;
253
Vladimir Davydov3cb29d12015-04-14 15:46:48 -0700254 if (pool_id >= 0) {
Sasha Levin309381fea2014-01-23 15:52:54 -0800255 VM_BUG_ON_PAGE(!PageLocked(page), page);
Dan Magenheimer077b1f82011-05-26 10:01:36 -0600256 if (cleancache_get_key(mapping->host, &key) >= 0) {
Konrad Rzeszutek Wilk833f8662013-04-30 15:26:57 -0700257 cleancache_ops->invalidate_page(pool_id,
Dan Magenheimer49a9ab82013-04-30 15:26:56 -0700258 key, page->index);
Dan Magenheimer417fc2c2011-09-21 12:28:04 -0400259 cleancache_invalidates++;
Dan Magenheimer077b1f82011-05-26 10:01:36 -0600260 }
261 }
262}
Dan Magenheimer31677602011-09-21 11:56:28 -0400263EXPORT_SYMBOL(__cleancache_invalidate_page);
Dan Magenheimer077b1f82011-05-26 10:01:36 -0600264
265/*
Dan Magenheimer31677602011-09-21 11:56:28 -0400266 * Invalidate all data from cleancache associated with the poolid and the
Dan Magenheimer077b1f82011-05-26 10:01:36 -0600267 * mappings's inode so that all subsequent gets to this poolid/inode
268 * will fail.
Dan Magenheimer49a9ab82013-04-30 15:26:56 -0700269 *
270 * The function has two checks before any action is taken - whether
271 * a backend is registered and whether the sb->cleancache_poolid
272 * is correct.
Dan Magenheimer077b1f82011-05-26 10:01:36 -0600273 */
Dan Magenheimer31677602011-09-21 11:56:28 -0400274void __cleancache_invalidate_inode(struct address_space *mapping)
Dan Magenheimer077b1f82011-05-26 10:01:36 -0600275{
Vladimir Davydov3cb29d12015-04-14 15:46:48 -0700276 int pool_id = mapping->host->i_sb->cleancache_poolid;
Dan Magenheimer077b1f82011-05-26 10:01:36 -0600277 struct cleancache_filekey key = { .u.key = { 0 } };
278
Konrad Rzeszutek Wilk833f8662013-04-30 15:26:57 -0700279 if (!cleancache_ops)
Dan Magenheimer49a9ab82013-04-30 15:26:56 -0700280 return;
281
Dan Magenheimer077b1f82011-05-26 10:01:36 -0600282 if (pool_id >= 0 && cleancache_get_key(mapping->host, &key) >= 0)
Konrad Rzeszutek Wilk833f8662013-04-30 15:26:57 -0700283 cleancache_ops->invalidate_inode(pool_id, key);
Dan Magenheimer077b1f82011-05-26 10:01:36 -0600284}
Dan Magenheimer31677602011-09-21 11:56:28 -0400285EXPORT_SYMBOL(__cleancache_invalidate_inode);
Dan Magenheimer077b1f82011-05-26 10:01:36 -0600286
287/*
288 * Called by any cleancache-enabled filesystem at time of unmount;
Dan Magenheimer49a9ab82013-04-30 15:26:56 -0700289 * note that pool_id is surrendered and may be returned by a subsequent
290 * cleancache_init_fs or cleancache_init_shared_fs.
Dan Magenheimer077b1f82011-05-26 10:01:36 -0600291 */
Dan Magenheimer31677602011-09-21 11:56:28 -0400292void __cleancache_invalidate_fs(struct super_block *sb)
Dan Magenheimer077b1f82011-05-26 10:01:36 -0600293{
Vladimir Davydov3cb29d12015-04-14 15:46:48 -0700294 int pool_id;
Dan Magenheimer49a9ab82013-04-30 15:26:56 -0700295
Vladimir Davydov3cb29d12015-04-14 15:46:48 -0700296 pool_id = sb->cleancache_poolid;
297 sb->cleancache_poolid = CLEANCACHE_NO_POOL;
298
299 if (cleancache_ops && pool_id >= 0)
300 cleancache_ops->invalidate_fs(pool_id);
Dan Magenheimer077b1f82011-05-26 10:01:36 -0600301}
Dan Magenheimer31677602011-09-21 11:56:28 -0400302EXPORT_SYMBOL(__cleancache_invalidate_fs);
Dan Magenheimer077b1f82011-05-26 10:01:36 -0600303
Dan Magenheimer077b1f82011-05-26 10:01:36 -0600304static int __init init_cleancache(void)
305{
Dan Magenheimer417fc2c2011-09-21 12:28:04 -0400306#ifdef CONFIG_DEBUG_FS
307 struct dentry *root = debugfs_create_dir("cleancache", NULL);
308 if (root == NULL)
309 return -ENXIO;
Joe Perches0825a6f2018-06-14 15:27:58 -0700310 debugfs_create_u64("succ_gets", 0444, root, &cleancache_succ_gets);
311 debugfs_create_u64("failed_gets", 0444, root, &cleancache_failed_gets);
312 debugfs_create_u64("puts", 0444, root, &cleancache_puts);
313 debugfs_create_u64("invalidates", 0444, root, &cleancache_invalidates);
Dan Magenheimer417fc2c2011-09-21 12:28:04 -0400314#endif
Dan Magenheimer077b1f82011-05-26 10:01:36 -0600315 return 0;
316}
317module_init(init_cleancache)