blob: 8c0862e413064c32a6df043e8d27f0d8530b2849 [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 {
Arnd Bergmanncbedead2018-06-19 17:27:59 +020034 u64 last_write_time_sec;
35 u64 last_change_time_sec;
36 u32 last_write_time_nsec;
37 u32 last_change_time_nsec;
38 u64 eof;
David Howells402cb8d2018-04-04 13:41:28 +010039};
40
41/*
42 * cache.c
43 */
Suresh Jayaramanf579cf32010-07-05 18:11:50 +053044extern struct fscache_netfs cifs_fscache_netfs;
Suresh Jayaraman488f1d2d2010-07-05 18:12:15 +053045extern const struct fscache_cookie_def cifs_fscache_server_index_def;
Suresh Jayaramand03382c2010-07-05 18:12:27 +053046extern const struct fscache_cookie_def cifs_fscache_super_index_def;
Suresh Jayaraman9451a9a2010-07-05 18:12:45 +053047extern const struct fscache_cookie_def cifs_fscache_inode_object_def;
48
Suresh Jayaramanf579cf32010-07-05 18:11:50 +053049extern int cifs_fscache_register(void);
50extern void cifs_fscache_unregister(void);
David Howells402cb8d2018-04-04 13:41:28 +010051extern char *extract_sharename(const char *);
Suresh Jayaramanf579cf32010-07-05 18:11:50 +053052
Suresh Jayaraman488f1d2d2010-07-05 18:12:15 +053053/*
54 * fscache.c
55 */
56extern void cifs_fscache_get_client_cookie(struct TCP_Server_Info *);
57extern void cifs_fscache_release_client_cookie(struct TCP_Server_Info *);
Steve French96daf2b2011-05-27 04:34:02 +000058extern void cifs_fscache_get_super_cookie(struct cifs_tcon *);
59extern void cifs_fscache_release_super_cookie(struct cifs_tcon *);
Suresh Jayaraman488f1d2d2010-07-05 18:12:15 +053060
Suresh Jayaraman9451a9a2010-07-05 18:12:45 +053061extern void cifs_fscache_release_inode_cookie(struct inode *);
62extern void cifs_fscache_set_inode_cookie(struct inode *, struct file *);
63extern void cifs_fscache_reset_inode_cookie(struct inode *);
64
Suresh Jayaraman85f2d6b2010-07-05 18:13:00 +053065extern void __cifs_fscache_invalidate_page(struct page *, struct inode *);
66extern int cifs_fscache_release_page(struct page *page, gfp_t gfp);
Suresh Jayaraman566982362010-07-05 18:13:25 +053067extern int __cifs_readpage_from_fscache(struct inode *, struct page *);
68extern int __cifs_readpages_from_fscache(struct inode *,
69 struct address_space *,
70 struct list_head *,
71 unsigned *);
David Howells54afa992013-09-04 17:10:39 +000072extern void __cifs_fscache_readpages_cancel(struct inode *, struct list_head *);
Suresh Jayaraman85f2d6b2010-07-05 18:13:00 +053073
Suresh Jayaraman9dc06552010-07-05 18:13:11 +053074extern void __cifs_readpage_to_fscache(struct inode *, struct page *);
75
Suresh Jayaraman85f2d6b2010-07-05 18:13:00 +053076static inline void cifs_fscache_invalidate_page(struct page *page,
77 struct inode *inode)
78{
79 if (PageFsCache(page))
80 __cifs_fscache_invalidate_page(page, inode);
81}
82
Suresh Jayaraman566982362010-07-05 18:13:25 +053083static inline int cifs_readpage_from_fscache(struct inode *inode,
84 struct page *page)
85{
86 if (CIFS_I(inode)->fscache)
87 return __cifs_readpage_from_fscache(inode, page);
88
89 return -ENOBUFS;
90}
91
92static inline int cifs_readpages_from_fscache(struct inode *inode,
93 struct address_space *mapping,
94 struct list_head *pages,
95 unsigned *nr_pages)
96{
97 if (CIFS_I(inode)->fscache)
98 return __cifs_readpages_from_fscache(inode, mapping, pages,
99 nr_pages);
100 return -ENOBUFS;
101}
102
Suresh Jayaraman9dc06552010-07-05 18:13:11 +0530103static inline void cifs_readpage_to_fscache(struct inode *inode,
104 struct page *page)
105{
106 if (PageFsCache(page))
107 __cifs_readpage_to_fscache(inode, page);
108}
109
David Howells54afa992013-09-04 17:10:39 +0000110static inline void cifs_fscache_readpages_cancel(struct inode *inode,
111 struct list_head *pages)
112{
113 if (CIFS_I(inode)->fscache)
114 return __cifs_fscache_readpages_cancel(inode, pages);
115}
116
Suresh Jayaramanf579cf32010-07-05 18:11:50 +0530117#else /* CONFIG_CIFS_FSCACHE */
118static inline int cifs_fscache_register(void) { return 0; }
119static inline void cifs_fscache_unregister(void) {}
120
Suresh Jayaraman488f1d2d2010-07-05 18:12:15 +0530121static inline void
122cifs_fscache_get_client_cookie(struct TCP_Server_Info *server) {}
123static inline void
Steve Frenchc5e04a32010-07-16 04:18:36 +0000124cifs_fscache_release_client_cookie(struct TCP_Server_Info *server) {}
Steve French96daf2b2011-05-27 04:34:02 +0000125static inline void cifs_fscache_get_super_cookie(struct cifs_tcon *tcon) {}
Suresh Jayaramand03382c2010-07-05 18:12:27 +0530126static inline void
Steve French96daf2b2011-05-27 04:34:02 +0000127cifs_fscache_release_super_cookie(struct cifs_tcon *tcon) {}
Suresh Jayaraman488f1d2d2010-07-05 18:12:15 +0530128
Suresh Jayaraman9451a9a2010-07-05 18:12:45 +0530129static inline void cifs_fscache_release_inode_cookie(struct inode *inode) {}
130static inline void cifs_fscache_set_inode_cookie(struct inode *inode,
131 struct file *filp) {}
132static inline void cifs_fscache_reset_inode_cookie(struct inode *inode) {}
Steve Frenchd0e6f442010-07-16 04:24:54 +0000133static inline int cifs_fscache_release_page(struct page *page, gfp_t gfp)
Suresh Jayaraman85f2d6b2010-07-05 18:13:00 +0530134{
135 return 1; /* May release page */
136}
Suresh Jayaraman9451a9a2010-07-05 18:12:45 +0530137
Steve Frenchd0e6f442010-07-16 04:24:54 +0000138static inline void cifs_fscache_invalidate_page(struct page *page,
139 struct inode *inode) {}
Suresh Jayaraman566982362010-07-05 18:13:25 +0530140static inline int
141cifs_readpage_from_fscache(struct inode *inode, struct page *page)
142{
143 return -ENOBUFS;
144}
145
146static inline int cifs_readpages_from_fscache(struct inode *inode,
147 struct address_space *mapping,
148 struct list_head *pages,
149 unsigned *nr_pages)
150{
151 return -ENOBUFS;
152}
153
Suresh Jayaraman9dc06552010-07-05 18:13:11 +0530154static inline void cifs_readpage_to_fscache(struct inode *inode,
155 struct page *page) {}
Suresh Jayaraman9451a9a2010-07-05 18:12:45 +0530156
David Howells54afa992013-09-04 17:10:39 +0000157static inline void cifs_fscache_readpages_cancel(struct inode *inode,
158 struct list_head *pages)
159{
160}
161
Suresh Jayaramanf579cf32010-07-05 18:11:50 +0530162#endif /* CONFIG_CIFS_FSCACHE */
163
164#endif /* _CIFS_FSCACHE_H */