blob: c7e3ac251e1616c5ec9b5a0ae0103088c483f9fa [file] [log] [blame]
Suresh Jayaramanf579cf32010-07-05 18:11:50 +05301/*
2 * fs/cifs/fscache.h - CIFS filesystem cache interface definitions
3 *
4 * Copyright (c) 2010 Novell, Inc.
5 * Authors(s): Suresh Jayaraman (sjayaraman@suse.de>
6 *
7 * This library is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU Lesser General Public License as published
9 * by the Free Software Foundation; either version 2.1 of the License, or
10 * (at your option) any later version.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
15 * the GNU Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public License
18 * along with this library; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 */
21#ifndef _CIFS_FSCACHE_H
22#define _CIFS_FSCACHE_H
23
24#include <linux/fscache.h>
25
Suresh Jayaraman488f1d2d2010-07-05 18:12:15 +053026#include "cifsglob.h"
27
Suresh Jayaramanf579cf32010-07-05 18:11:50 +053028#ifdef CONFIG_CIFS_FSCACHE
29
David Howells402cb8d2018-04-04 13:41:28 +010030/*
31 * Auxiliary data attached to CIFS inode within the cache
32 */
33struct cifs_fscache_inode_auxdata {
34 struct timespec last_write_time;
35 struct timespec last_change_time;
36 u64 eof;
37};
38
39/*
40 * cache.c
41 */
Suresh Jayaramanf579cf32010-07-05 18:11:50 +053042extern struct fscache_netfs cifs_fscache_netfs;
Suresh Jayaraman488f1d2d2010-07-05 18:12:15 +053043extern const struct fscache_cookie_def cifs_fscache_server_index_def;
Suresh Jayaramand03382c2010-07-05 18:12:27 +053044extern const struct fscache_cookie_def cifs_fscache_super_index_def;
Suresh Jayaraman9451a9a2010-07-05 18:12:45 +053045extern const struct fscache_cookie_def cifs_fscache_inode_object_def;
46
Suresh Jayaramanf579cf32010-07-05 18:11:50 +053047extern int cifs_fscache_register(void);
48extern void cifs_fscache_unregister(void);
David Howells402cb8d2018-04-04 13:41:28 +010049extern char *extract_sharename(const char *);
Suresh Jayaramanf579cf32010-07-05 18:11:50 +053050
Suresh Jayaraman488f1d2d2010-07-05 18:12:15 +053051/*
52 * fscache.c
53 */
54extern void cifs_fscache_get_client_cookie(struct TCP_Server_Info *);
55extern void cifs_fscache_release_client_cookie(struct TCP_Server_Info *);
Steve French96daf2b2011-05-27 04:34:02 +000056extern void cifs_fscache_get_super_cookie(struct cifs_tcon *);
57extern void cifs_fscache_release_super_cookie(struct cifs_tcon *);
Suresh Jayaraman488f1d2d2010-07-05 18:12:15 +053058
Suresh Jayaraman9451a9a2010-07-05 18:12:45 +053059extern void cifs_fscache_release_inode_cookie(struct inode *);
60extern void cifs_fscache_set_inode_cookie(struct inode *, struct file *);
61extern void cifs_fscache_reset_inode_cookie(struct inode *);
62
Suresh Jayaraman85f2d6b2010-07-05 18:13:00 +053063extern void __cifs_fscache_invalidate_page(struct page *, struct inode *);
64extern int cifs_fscache_release_page(struct page *page, gfp_t gfp);
Suresh Jayaraman566982362010-07-05 18:13:25 +053065extern int __cifs_readpage_from_fscache(struct inode *, struct page *);
66extern int __cifs_readpages_from_fscache(struct inode *,
67 struct address_space *,
68 struct list_head *,
69 unsigned *);
David Howells54afa992013-09-04 17:10:39 +000070extern void __cifs_fscache_readpages_cancel(struct inode *, struct list_head *);
Suresh Jayaraman85f2d6b2010-07-05 18:13:00 +053071
Suresh Jayaraman9dc06552010-07-05 18:13:11 +053072extern void __cifs_readpage_to_fscache(struct inode *, struct page *);
73
Suresh Jayaraman85f2d6b2010-07-05 18:13:00 +053074static inline void cifs_fscache_invalidate_page(struct page *page,
75 struct inode *inode)
76{
77 if (PageFsCache(page))
78 __cifs_fscache_invalidate_page(page, inode);
79}
80
Suresh Jayaraman566982362010-07-05 18:13:25 +053081static inline int cifs_readpage_from_fscache(struct inode *inode,
82 struct page *page)
83{
84 if (CIFS_I(inode)->fscache)
85 return __cifs_readpage_from_fscache(inode, page);
86
87 return -ENOBUFS;
88}
89
90static inline int cifs_readpages_from_fscache(struct inode *inode,
91 struct address_space *mapping,
92 struct list_head *pages,
93 unsigned *nr_pages)
94{
95 if (CIFS_I(inode)->fscache)
96 return __cifs_readpages_from_fscache(inode, mapping, pages,
97 nr_pages);
98 return -ENOBUFS;
99}
100
Suresh Jayaraman9dc06552010-07-05 18:13:11 +0530101static inline void cifs_readpage_to_fscache(struct inode *inode,
102 struct page *page)
103{
104 if (PageFsCache(page))
105 __cifs_readpage_to_fscache(inode, page);
106}
107
David Howells54afa992013-09-04 17:10:39 +0000108static inline void cifs_fscache_readpages_cancel(struct inode *inode,
109 struct list_head *pages)
110{
111 if (CIFS_I(inode)->fscache)
112 return __cifs_fscache_readpages_cancel(inode, pages);
113}
114
Suresh Jayaramanf579cf32010-07-05 18:11:50 +0530115#else /* CONFIG_CIFS_FSCACHE */
116static inline int cifs_fscache_register(void) { return 0; }
117static inline void cifs_fscache_unregister(void) {}
118
Suresh Jayaraman488f1d2d2010-07-05 18:12:15 +0530119static inline void
120cifs_fscache_get_client_cookie(struct TCP_Server_Info *server) {}
121static inline void
Steve Frenchc5e04a32010-07-16 04:18:36 +0000122cifs_fscache_release_client_cookie(struct TCP_Server_Info *server) {}
Steve French96daf2b2011-05-27 04:34:02 +0000123static inline void cifs_fscache_get_super_cookie(struct cifs_tcon *tcon) {}
Suresh Jayaramand03382c2010-07-05 18:12:27 +0530124static inline void
Steve French96daf2b2011-05-27 04:34:02 +0000125cifs_fscache_release_super_cookie(struct cifs_tcon *tcon) {}
Suresh Jayaraman488f1d2d2010-07-05 18:12:15 +0530126
Suresh Jayaraman9451a9a2010-07-05 18:12:45 +0530127static inline void cifs_fscache_release_inode_cookie(struct inode *inode) {}
128static inline void cifs_fscache_set_inode_cookie(struct inode *inode,
129 struct file *filp) {}
130static inline void cifs_fscache_reset_inode_cookie(struct inode *inode) {}
Steve Frenchd0e6f442010-07-16 04:24:54 +0000131static inline int cifs_fscache_release_page(struct page *page, gfp_t gfp)
Suresh Jayaraman85f2d6b2010-07-05 18:13:00 +0530132{
133 return 1; /* May release page */
134}
Suresh Jayaraman9451a9a2010-07-05 18:12:45 +0530135
Steve Frenchd0e6f442010-07-16 04:24:54 +0000136static inline void cifs_fscache_invalidate_page(struct page *page,
137 struct inode *inode) {}
Suresh Jayaraman566982362010-07-05 18:13:25 +0530138static inline int
139cifs_readpage_from_fscache(struct inode *inode, struct page *page)
140{
141 return -ENOBUFS;
142}
143
144static inline int cifs_readpages_from_fscache(struct inode *inode,
145 struct address_space *mapping,
146 struct list_head *pages,
147 unsigned *nr_pages)
148{
149 return -ENOBUFS;
150}
151
Suresh Jayaraman9dc06552010-07-05 18:13:11 +0530152static inline void cifs_readpage_to_fscache(struct inode *inode,
153 struct page *page) {}
Suresh Jayaraman9451a9a2010-07-05 18:12:45 +0530154
David Howells54afa992013-09-04 17:10:39 +0000155static inline void cifs_fscache_readpages_cancel(struct inode *inode,
156 struct list_head *pages)
157{
158}
159
Suresh Jayaramanf579cf32010-07-05 18:11:50 +0530160#endif /* CONFIG_CIFS_FSCACHE */
161
162#endif /* _CIFS_FSCACHE_H */