1 // SPDX-License-Identifier: LGPL-2.1
3 * fs/cifs/fscache.c - CIFS filesystem cache interface
5 * Copyright (c) 2010 Novell, Inc.
6 * Author(s): Suresh Jayaraman <sjayaraman@suse.de>
11 #include "cifs_debug.h"
12 #include "cifs_fs_sb.h"
13 #include "cifsproto.h"
16 * Key layout of CIFS server cache index object
18 struct cifs_server_key {
20 uint16_t family; /* address family */
21 __be16 port; /* IP port */
24 struct in_addr ipv4_addr;
25 struct in6_addr ipv6_addr;
30 * Get a cookie for a server object keyed by {IPaddress,port,family} tuple
32 void cifs_fscache_get_client_cookie(struct TCP_Server_Info *server)
34 const struct sockaddr *sa = (struct sockaddr *) &server->dstaddr;
35 const struct sockaddr_in *addr = (struct sockaddr_in *) sa;
36 const struct sockaddr_in6 *addr6 = (struct sockaddr_in6 *) sa;
37 struct cifs_server_key key;
38 uint16_t key_len = sizeof(key.hdr);
40 memset(&key, 0, sizeof(key));
43 * Should not be a problem as sin_family/sin6_family overlays
46 key.hdr.family = sa->sa_family;
47 switch (sa->sa_family) {
49 key.hdr.port = addr->sin_port;
50 key.ipv4_addr = addr->sin_addr;
51 key_len += sizeof(key.ipv4_addr);
55 key.hdr.port = addr6->sin6_port;
56 key.ipv6_addr = addr6->sin6_addr;
57 key_len += sizeof(key.ipv6_addr);
61 cifs_dbg(VFS, "Unknown network family '%d'\n", sa->sa_family);
62 server->fscache = NULL;
67 fscache_acquire_cookie(cifs_fscache_netfs.primary_index,
68 &cifs_fscache_server_index_def,
72 cifs_dbg(FYI, "%s: (0x%p/0x%p)\n",
73 __func__, server, server->fscache);
76 void cifs_fscache_release_client_cookie(struct TCP_Server_Info *server)
78 cifs_dbg(FYI, "%s: (0x%p/0x%p)\n",
79 __func__, server, server->fscache);
80 fscache_relinquish_cookie(server->fscache, NULL, false);
81 server->fscache = NULL;
84 void cifs_fscache_get_super_cookie(struct cifs_tcon *tcon)
86 struct TCP_Server_Info *server = tcon->ses->server;
88 struct cifs_fscache_super_auxdata auxdata;
90 sharename = extract_sharename(tcon->treeName);
91 if (IS_ERR(sharename)) {
92 cifs_dbg(FYI, "%s: couldn't extract sharename\n", __func__);
97 memset(&auxdata, 0, sizeof(auxdata));
98 auxdata.resource_id = tcon->resource_id;
99 auxdata.vol_create_time = tcon->vol_create_time;
100 auxdata.vol_serial_number = tcon->vol_serial_number;
103 fscache_acquire_cookie(server->fscache,
104 &cifs_fscache_super_index_def,
105 sharename, strlen(sharename),
106 &auxdata, sizeof(auxdata),
109 cifs_dbg(FYI, "%s: (0x%p/0x%p)\n",
110 __func__, server->fscache, tcon->fscache);
113 void cifs_fscache_release_super_cookie(struct cifs_tcon *tcon)
115 struct cifs_fscache_super_auxdata auxdata;
117 memset(&auxdata, 0, sizeof(auxdata));
118 auxdata.resource_id = tcon->resource_id;
119 auxdata.vol_create_time = tcon->vol_create_time;
120 auxdata.vol_serial_number = tcon->vol_serial_number;
122 cifs_dbg(FYI, "%s: (0x%p)\n", __func__, tcon->fscache);
123 fscache_relinquish_cookie(tcon->fscache, &auxdata, false);
124 tcon->fscache = NULL;
127 static void cifs_fscache_acquire_inode_cookie(struct cifsInodeInfo *cifsi,
128 struct cifs_tcon *tcon)
130 struct cifs_fscache_inode_auxdata auxdata;
132 memset(&auxdata, 0, sizeof(auxdata));
133 auxdata.eof = cifsi->server_eof;
134 auxdata.last_write_time_sec = cifsi->vfs_inode.i_mtime.tv_sec;
135 auxdata.last_change_time_sec = cifsi->vfs_inode.i_ctime.tv_sec;
136 auxdata.last_write_time_nsec = cifsi->vfs_inode.i_mtime.tv_nsec;
137 auxdata.last_change_time_nsec = cifsi->vfs_inode.i_ctime.tv_nsec;
140 fscache_acquire_cookie(tcon->fscache,
141 &cifs_fscache_inode_object_def,
142 &cifsi->uniqueid, sizeof(cifsi->uniqueid),
143 &auxdata, sizeof(auxdata),
144 cifsi, cifsi->vfs_inode.i_size, true);
147 static void cifs_fscache_enable_inode_cookie(struct inode *inode)
149 struct cifsInodeInfo *cifsi = CIFS_I(inode);
150 struct cifs_sb_info *cifs_sb = CIFS_SB(inode->i_sb);
151 struct cifs_tcon *tcon = cifs_sb_master_tcon(cifs_sb);
156 if (!(cifs_sb->mnt_cifs_flags & CIFS_MOUNT_FSCACHE))
159 cifs_fscache_acquire_inode_cookie(cifsi, tcon);
161 cifs_dbg(FYI, "%s: got FH cookie (0x%p/0x%p)\n",
162 __func__, tcon->fscache, cifsi->fscache);
165 void cifs_fscache_release_inode_cookie(struct inode *inode)
167 struct cifs_fscache_inode_auxdata auxdata;
168 struct cifsInodeInfo *cifsi = CIFS_I(inode);
170 if (cifsi->fscache) {
171 memset(&auxdata, 0, sizeof(auxdata));
172 auxdata.eof = cifsi->server_eof;
173 auxdata.last_write_time_sec = cifsi->vfs_inode.i_mtime.tv_sec;
174 auxdata.last_change_time_sec = cifsi->vfs_inode.i_ctime.tv_sec;
175 auxdata.last_write_time_nsec = cifsi->vfs_inode.i_mtime.tv_nsec;
176 auxdata.last_change_time_nsec = cifsi->vfs_inode.i_ctime.tv_nsec;
178 cifs_dbg(FYI, "%s: (0x%p)\n", __func__, cifsi->fscache);
179 fscache_relinquish_cookie(cifsi->fscache, &auxdata, false);
180 cifsi->fscache = NULL;
184 static void cifs_fscache_disable_inode_cookie(struct inode *inode)
186 struct cifsInodeInfo *cifsi = CIFS_I(inode);
188 if (cifsi->fscache) {
189 cifs_dbg(FYI, "%s: (0x%p)\n", __func__, cifsi->fscache);
190 fscache_uncache_all_inode_pages(cifsi->fscache, inode);
191 fscache_relinquish_cookie(cifsi->fscache, NULL, true);
192 cifsi->fscache = NULL;
196 void cifs_fscache_set_inode_cookie(struct inode *inode, struct file *filp)
198 if ((filp->f_flags & O_ACCMODE) != O_RDONLY)
199 cifs_fscache_disable_inode_cookie(inode);
201 cifs_fscache_enable_inode_cookie(inode);
204 void cifs_fscache_reset_inode_cookie(struct inode *inode)
206 struct cifsInodeInfo *cifsi = CIFS_I(inode);
207 struct cifs_sb_info *cifs_sb = CIFS_SB(inode->i_sb);
208 struct cifs_tcon *tcon = cifs_sb_master_tcon(cifs_sb);
209 struct fscache_cookie *old = cifsi->fscache;
211 if (cifsi->fscache) {
212 /* retire the current fscache cache and get a new one */
213 fscache_relinquish_cookie(cifsi->fscache, NULL, true);
215 cifs_fscache_acquire_inode_cookie(cifsi, tcon);
216 cifs_dbg(FYI, "%s: new cookie 0x%p oldcookie 0x%p\n",
217 __func__, cifsi->fscache, old);
221 int cifs_fscache_release_page(struct page *page, gfp_t gfp)
223 if (PageFsCache(page)) {
224 struct inode *inode = page->mapping->host;
225 struct cifsInodeInfo *cifsi = CIFS_I(inode);
227 cifs_dbg(FYI, "%s: (0x%p/0x%p)\n",
228 __func__, page, cifsi->fscache);
229 if (!fscache_maybe_release_page(cifsi->fscache, page, gfp))
236 static void cifs_readpage_from_fscache_complete(struct page *page, void *ctx,
239 cifs_dbg(FYI, "%s: (0x%p/%d)\n", __func__, page, error);
241 SetPageUptodate(page);
246 * Retrieve a page from FS-Cache
248 int __cifs_readpage_from_fscache(struct inode *inode, struct page *page)
252 cifs_dbg(FYI, "%s: (fsc:%p, p:%p, i:0x%p\n",
253 __func__, CIFS_I(inode)->fscache, page, inode);
254 ret = fscache_read_or_alloc_page(CIFS_I(inode)->fscache, page,
255 cifs_readpage_from_fscache_complete,
260 case 0: /* page found in fscache, read submitted */
261 cifs_dbg(FYI, "%s: submitted\n", __func__);
263 case -ENOBUFS: /* page won't be cached */
264 case -ENODATA: /* page not in cache */
265 cifs_dbg(FYI, "%s: %d\n", __func__, ret);
269 cifs_dbg(VFS, "unknown error ret = %d\n", ret);
275 * Retrieve a set of pages from FS-Cache
277 int __cifs_readpages_from_fscache(struct inode *inode,
278 struct address_space *mapping,
279 struct list_head *pages,
284 cifs_dbg(FYI, "%s: (0x%p/%u/0x%p)\n",
285 __func__, CIFS_I(inode)->fscache, *nr_pages, inode);
286 ret = fscache_read_or_alloc_pages(CIFS_I(inode)->fscache, mapping,
288 cifs_readpage_from_fscache_complete,
290 mapping_gfp_mask(mapping));
292 case 0: /* read submitted to the cache for all pages */
293 cifs_dbg(FYI, "%s: submitted\n", __func__);
296 case -ENOBUFS: /* some pages are not cached and can't be */
297 case -ENODATA: /* some pages are not cached */
298 cifs_dbg(FYI, "%s: no page\n", __func__);
302 cifs_dbg(FYI, "unknown error ret = %d\n", ret);
308 void __cifs_readpage_to_fscache(struct inode *inode, struct page *page)
310 struct cifsInodeInfo *cifsi = CIFS_I(inode);
313 cifs_dbg(FYI, "%s: (fsc: %p, p: %p, i: %p)\n",
314 __func__, cifsi->fscache, page, inode);
315 ret = fscache_write_page(cifsi->fscache, page,
316 cifsi->vfs_inode.i_size, GFP_KERNEL);
318 fscache_uncache_page(cifsi->fscache, page);
321 void __cifs_fscache_readpages_cancel(struct inode *inode, struct list_head *pages)
323 cifs_dbg(FYI, "%s: (fsc: %p, i: %p)\n",
324 __func__, CIFS_I(inode)->fscache, inode);
325 fscache_readpages_cancel(CIFS_I(inode)->fscache, pages);
328 void __cifs_fscache_invalidate_page(struct page *page, struct inode *inode)
330 struct cifsInodeInfo *cifsi = CIFS_I(inode);
331 struct fscache_cookie *cookie = cifsi->fscache;
333 cifs_dbg(FYI, "%s: (0x%p/0x%p)\n", __func__, page, cookie);
334 fscache_wait_on_page_write(cookie, page);
335 fscache_uncache_page(cookie, page);