Loading...
1/* NFS filesystem cache interface definitions
2 *
3 * Copyright (C) 2008 Red Hat, Inc. All Rights Reserved.
4 * Written by David Howells (dhowells@redhat.com)
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public Licence
8 * as published by the Free Software Foundation; either version
9 * 2 of the Licence, or (at your option) any later version.
10 */
11
12#ifndef _NFS_FSCACHE_H
13#define _NFS_FSCACHE_H
14
15#include <linux/nfs_fs.h>
16#include <linux/nfs_mount.h>
17#include <linux/nfs4_mount.h>
18#include <linux/fscache.h>
19
20#ifdef CONFIG_NFS_FSCACHE
21
22/*
23 * set of NFS FS-Cache objects that form a superblock key
24 */
25struct nfs_fscache_key {
26 struct rb_node node;
27 struct nfs_client *nfs_client; /* the server */
28
29 /* the elements of the unique key - as used by nfs_compare_super() and
30 * nfs_compare_mount_options() to distinguish superblocks */
31 struct {
32 struct {
33 unsigned long s_flags; /* various flags
34 * (& NFS_MS_MASK) */
35 } super;
36
37 struct {
38 struct nfs_fsid fsid;
39 int flags;
40 unsigned int rsize; /* read size */
41 unsigned int wsize; /* write size */
42 unsigned int acregmin; /* attr cache timeouts */
43 unsigned int acregmax;
44 unsigned int acdirmin;
45 unsigned int acdirmax;
46 } nfs_server;
47
48 struct {
49 rpc_authflavor_t au_flavor;
50 } rpc_auth;
51
52 /* uniquifier - can be used if nfs_server.flags includes
53 * NFS_MOUNT_UNSHARED */
54 u8 uniq_len;
55 char uniquifier[0];
56 } key;
57};
58
59/*
60 * Definition of the auxiliary data attached to NFS inode storage objects
61 * within the cache.
62 *
63 * The contents of this struct are recorded in the on-disk local cache in the
64 * auxiliary data attached to the data storage object backing an inode. This
65 * permits coherency to be managed when a new inode binds to an already extant
66 * cache object.
67 */
68struct nfs_fscache_inode_auxdata {
69 struct timespec mtime;
70 struct timespec ctime;
71 u64 change_attr;
72};
73
74/*
75 * fscache-index.c
76 */
77extern struct fscache_netfs nfs_fscache_netfs;
78extern const struct fscache_cookie_def nfs_fscache_server_index_def;
79extern const struct fscache_cookie_def nfs_fscache_super_index_def;
80extern const struct fscache_cookie_def nfs_fscache_inode_object_def;
81
82extern int nfs_fscache_register(void);
83extern void nfs_fscache_unregister(void);
84
85/*
86 * fscache.c
87 */
88extern void nfs_fscache_get_client_cookie(struct nfs_client *);
89extern void nfs_fscache_release_client_cookie(struct nfs_client *);
90
91extern void nfs_fscache_get_super_cookie(struct super_block *, const char *, int);
92extern void nfs_fscache_release_super_cookie(struct super_block *);
93
94extern void nfs_fscache_init_inode(struct inode *);
95extern void nfs_fscache_clear_inode(struct inode *);
96extern void nfs_fscache_open_file(struct inode *, struct file *);
97
98extern void __nfs_fscache_invalidate_page(struct page *, struct inode *);
99extern int nfs_fscache_release_page(struct page *, gfp_t);
100
101extern int __nfs_readpage_from_fscache(struct nfs_open_context *,
102 struct inode *, struct page *);
103extern int __nfs_readpages_from_fscache(struct nfs_open_context *,
104 struct inode *, struct address_space *,
105 struct list_head *, unsigned *);
106extern void __nfs_readpage_to_fscache(struct inode *, struct page *, int);
107
108/*
109 * wait for a page to complete writing to the cache
110 */
111static inline void nfs_fscache_wait_on_page_write(struct nfs_inode *nfsi,
112 struct page *page)
113{
114 if (PageFsCache(page))
115 fscache_wait_on_page_write(nfsi->fscache, page);
116}
117
118/*
119 * release the caching state associated with a page if undergoing complete page
120 * invalidation
121 */
122static inline void nfs_fscache_invalidate_page(struct page *page,
123 struct inode *inode)
124{
125 if (PageFsCache(page))
126 __nfs_fscache_invalidate_page(page, inode);
127}
128
129/*
130 * Retrieve a page from an inode data storage object.
131 */
132static inline int nfs_readpage_from_fscache(struct nfs_open_context *ctx,
133 struct inode *inode,
134 struct page *page)
135{
136 if (NFS_I(inode)->fscache)
137 return __nfs_readpage_from_fscache(ctx, inode, page);
138 return -ENOBUFS;
139}
140
141/*
142 * Retrieve a set of pages from an inode data storage object.
143 */
144static inline int nfs_readpages_from_fscache(struct nfs_open_context *ctx,
145 struct inode *inode,
146 struct address_space *mapping,
147 struct list_head *pages,
148 unsigned *nr_pages)
149{
150 if (NFS_I(inode)->fscache)
151 return __nfs_readpages_from_fscache(ctx, inode, mapping, pages,
152 nr_pages);
153 return -ENOBUFS;
154}
155
156/*
157 * Store a page newly fetched from the server in an inode data storage object
158 * in the cache.
159 */
160static inline void nfs_readpage_to_fscache(struct inode *inode,
161 struct page *page,
162 int sync)
163{
164 if (PageFsCache(page))
165 __nfs_readpage_to_fscache(inode, page, sync);
166}
167
168/*
169 * Invalidate the contents of fscache for this inode. This will not sleep.
170 */
171static inline void nfs_fscache_invalidate(struct inode *inode)
172{
173 fscache_invalidate(NFS_I(inode)->fscache);
174}
175
176/*
177 * Wait for an object to finish being invalidated.
178 */
179static inline void nfs_fscache_wait_on_invalidate(struct inode *inode)
180{
181 fscache_wait_on_invalidate(NFS_I(inode)->fscache);
182}
183
184/*
185 * indicate the client caching state as readable text
186 */
187static inline const char *nfs_server_fscache_state(struct nfs_server *server)
188{
189 if (server->fscache && (server->options & NFS_OPTION_FSCACHE))
190 return "yes";
191 return "no ";
192}
193
194#else /* CONFIG_NFS_FSCACHE */
195static inline int nfs_fscache_register(void) { return 0; }
196static inline void nfs_fscache_unregister(void) {}
197
198static inline void nfs_fscache_get_client_cookie(struct nfs_client *clp) {}
199static inline void nfs_fscache_release_client_cookie(struct nfs_client *clp) {}
200
201static inline void nfs_fscache_release_super_cookie(struct super_block *sb) {}
202
203static inline void nfs_fscache_init_inode(struct inode *inode) {}
204static inline void nfs_fscache_clear_inode(struct inode *inode) {}
205static inline void nfs_fscache_open_file(struct inode *inode,
206 struct file *filp) {}
207
208static inline int nfs_fscache_release_page(struct page *page, gfp_t gfp)
209{
210 return 1; /* True: may release page */
211}
212static inline void nfs_fscache_invalidate_page(struct page *page,
213 struct inode *inode) {}
214static inline void nfs_fscache_wait_on_page_write(struct nfs_inode *nfsi,
215 struct page *page) {}
216
217static inline int nfs_readpage_from_fscache(struct nfs_open_context *ctx,
218 struct inode *inode,
219 struct page *page)
220{
221 return -ENOBUFS;
222}
223static inline int nfs_readpages_from_fscache(struct nfs_open_context *ctx,
224 struct inode *inode,
225 struct address_space *mapping,
226 struct list_head *pages,
227 unsigned *nr_pages)
228{
229 return -ENOBUFS;
230}
231static inline void nfs_readpage_to_fscache(struct inode *inode,
232 struct page *page, int sync) {}
233
234
235static inline void nfs_fscache_invalidate(struct inode *inode) {}
236static inline void nfs_fscache_wait_on_invalidate(struct inode *inode) {}
237
238static inline const char *nfs_server_fscache_state(struct nfs_server *server)
239{
240 return "no ";
241}
242
243#endif /* CONFIG_NFS_FSCACHE */
244#endif /* _NFS_FSCACHE_H */
1/* SPDX-License-Identifier: GPL-2.0-or-later */
2/* NFS filesystem cache interface definitions
3 *
4 * Copyright (C) 2008 Red Hat, Inc. All Rights Reserved.
5 * Written by David Howells (dhowells@redhat.com)
6 */
7
8#ifndef _NFS_FSCACHE_H
9#define _NFS_FSCACHE_H
10
11#include <linux/nfs_fs.h>
12#include <linux/nfs_mount.h>
13#include <linux/nfs4_mount.h>
14#include <linux/fscache.h>
15
16#ifdef CONFIG_NFS_FSCACHE
17
18/*
19 * set of NFS FS-Cache objects that form a superblock key
20 */
21struct nfs_fscache_key {
22 struct rb_node node;
23 struct nfs_client *nfs_client; /* the server */
24
25 /* the elements of the unique key - as used by nfs_compare_super() and
26 * nfs_compare_mount_options() to distinguish superblocks */
27 struct {
28 struct {
29 unsigned long s_flags; /* various flags
30 * (& NFS_MS_MASK) */
31 } super;
32
33 struct {
34 struct nfs_fsid fsid;
35 int flags;
36 unsigned int rsize; /* read size */
37 unsigned int wsize; /* write size */
38 unsigned int acregmin; /* attr cache timeouts */
39 unsigned int acregmax;
40 unsigned int acdirmin;
41 unsigned int acdirmax;
42 } nfs_server;
43
44 struct {
45 rpc_authflavor_t au_flavor;
46 } rpc_auth;
47
48 /* uniquifier - can be used if nfs_server.flags includes
49 * NFS_MOUNT_UNSHARED */
50 u8 uniq_len;
51 char uniquifier[0];
52 } key;
53};
54
55/*
56 * Definition of the auxiliary data attached to NFS inode storage objects
57 * within the cache.
58 *
59 * The contents of this struct are recorded in the on-disk local cache in the
60 * auxiliary data attached to the data storage object backing an inode. This
61 * permits coherency to be managed when a new inode binds to an already extant
62 * cache object.
63 */
64struct nfs_fscache_inode_auxdata {
65 s64 mtime_sec;
66 s64 mtime_nsec;
67 s64 ctime_sec;
68 s64 ctime_nsec;
69 u64 change_attr;
70};
71
72/*
73 * fscache-index.c
74 */
75extern struct fscache_netfs nfs_fscache_netfs;
76extern const struct fscache_cookie_def nfs_fscache_server_index_def;
77extern const struct fscache_cookie_def nfs_fscache_super_index_def;
78extern const struct fscache_cookie_def nfs_fscache_inode_object_def;
79
80extern int nfs_fscache_register(void);
81extern void nfs_fscache_unregister(void);
82
83/*
84 * fscache.c
85 */
86extern void nfs_fscache_get_client_cookie(struct nfs_client *);
87extern void nfs_fscache_release_client_cookie(struct nfs_client *);
88
89extern void nfs_fscache_get_super_cookie(struct super_block *, const char *, int);
90extern void nfs_fscache_release_super_cookie(struct super_block *);
91
92extern void nfs_fscache_init_inode(struct inode *);
93extern void nfs_fscache_clear_inode(struct inode *);
94extern void nfs_fscache_open_file(struct inode *, struct file *);
95
96extern void __nfs_fscache_invalidate_page(struct page *, struct inode *);
97extern int nfs_fscache_release_page(struct page *, gfp_t);
98
99extern int __nfs_readpage_from_fscache(struct nfs_open_context *,
100 struct inode *, struct page *);
101extern int __nfs_readpages_from_fscache(struct nfs_open_context *,
102 struct inode *, struct address_space *,
103 struct list_head *, unsigned *);
104extern void __nfs_readpage_to_fscache(struct inode *, struct page *, int);
105
106/*
107 * wait for a page to complete writing to the cache
108 */
109static inline void nfs_fscache_wait_on_page_write(struct nfs_inode *nfsi,
110 struct page *page)
111{
112 if (PageFsCache(page))
113 fscache_wait_on_page_write(nfsi->fscache, page);
114}
115
116/*
117 * release the caching state associated with a page if undergoing complete page
118 * invalidation
119 */
120static inline void nfs_fscache_invalidate_page(struct page *page,
121 struct inode *inode)
122{
123 if (PageFsCache(page))
124 __nfs_fscache_invalidate_page(page, inode);
125}
126
127/*
128 * Retrieve a page from an inode data storage object.
129 */
130static inline int nfs_readpage_from_fscache(struct nfs_open_context *ctx,
131 struct inode *inode,
132 struct page *page)
133{
134 if (NFS_I(inode)->fscache)
135 return __nfs_readpage_from_fscache(ctx, inode, page);
136 return -ENOBUFS;
137}
138
139/*
140 * Retrieve a set of pages from an inode data storage object.
141 */
142static inline int nfs_readpages_from_fscache(struct nfs_open_context *ctx,
143 struct inode *inode,
144 struct address_space *mapping,
145 struct list_head *pages,
146 unsigned *nr_pages)
147{
148 if (NFS_I(inode)->fscache)
149 return __nfs_readpages_from_fscache(ctx, inode, mapping, pages,
150 nr_pages);
151 return -ENOBUFS;
152}
153
154/*
155 * Store a page newly fetched from the server in an inode data storage object
156 * in the cache.
157 */
158static inline void nfs_readpage_to_fscache(struct inode *inode,
159 struct page *page,
160 int sync)
161{
162 if (PageFsCache(page))
163 __nfs_readpage_to_fscache(inode, page, sync);
164}
165
166/*
167 * Invalidate the contents of fscache for this inode. This will not sleep.
168 */
169static inline void nfs_fscache_invalidate(struct inode *inode)
170{
171 fscache_invalidate(NFS_I(inode)->fscache);
172}
173
174/*
175 * Wait for an object to finish being invalidated.
176 */
177static inline void nfs_fscache_wait_on_invalidate(struct inode *inode)
178{
179 fscache_wait_on_invalidate(NFS_I(inode)->fscache);
180}
181
182/*
183 * indicate the client caching state as readable text
184 */
185static inline const char *nfs_server_fscache_state(struct nfs_server *server)
186{
187 if (server->fscache)
188 return "yes";
189 return "no ";
190}
191
192#else /* CONFIG_NFS_FSCACHE */
193static inline int nfs_fscache_register(void) { return 0; }
194static inline void nfs_fscache_unregister(void) {}
195
196static inline void nfs_fscache_get_client_cookie(struct nfs_client *clp) {}
197static inline void nfs_fscache_release_client_cookie(struct nfs_client *clp) {}
198
199static inline void nfs_fscache_release_super_cookie(struct super_block *sb) {}
200
201static inline void nfs_fscache_init_inode(struct inode *inode) {}
202static inline void nfs_fscache_clear_inode(struct inode *inode) {}
203static inline void nfs_fscache_open_file(struct inode *inode,
204 struct file *filp) {}
205
206static inline int nfs_fscache_release_page(struct page *page, gfp_t gfp)
207{
208 return 1; /* True: may release page */
209}
210static inline void nfs_fscache_invalidate_page(struct page *page,
211 struct inode *inode) {}
212static inline void nfs_fscache_wait_on_page_write(struct nfs_inode *nfsi,
213 struct page *page) {}
214
215static inline int nfs_readpage_from_fscache(struct nfs_open_context *ctx,
216 struct inode *inode,
217 struct page *page)
218{
219 return -ENOBUFS;
220}
221static inline int nfs_readpages_from_fscache(struct nfs_open_context *ctx,
222 struct inode *inode,
223 struct address_space *mapping,
224 struct list_head *pages,
225 unsigned *nr_pages)
226{
227 return -ENOBUFS;
228}
229static inline void nfs_readpage_to_fscache(struct inode *inode,
230 struct page *page, int sync) {}
231
232
233static inline void nfs_fscache_invalidate(struct inode *inode) {}
234static inline void nfs_fscache_wait_on_invalidate(struct inode *inode) {}
235
236static inline const char *nfs_server_fscache_state(struct nfs_server *server)
237{
238 return "no ";
239}
240
241#endif /* CONFIG_NFS_FSCACHE */
242#endif /* _NFS_FSCACHE_H */