1 /* AFS filesystem file handling
3 * Copyright (C) 2002, 2007 Red Hat, Inc. All Rights Reserved.
4 * Written by David Howells (dhowells@redhat.com)
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
12 #include <linux/kernel.h>
13 #include <linux/module.h>
14 #include <linux/init.h>
15 #include <linux/slab.h>
17 #include <linux/pagemap.h>
18 #include <linux/writeback.h>
21 static int afs_readpage(struct file *file, struct page *page);
22 static void afs_invalidatepage(struct page *page, unsigned long offset);
23 static int afs_releasepage(struct page *page, gfp_t gfp_flags);
24 static int afs_launder_page(struct page *page);
26 static int afs_readpages(struct file *filp, struct address_space *mapping,
27 struct list_head *pages, unsigned nr_pages);
29 const struct file_operations afs_file_operations = {
31 .release = afs_release,
32 .llseek = generic_file_llseek,
34 .write = do_sync_write,
35 .aio_read = generic_file_aio_read,
36 .aio_write = afs_file_write,
37 .mmap = generic_file_readonly_mmap,
38 .splice_read = generic_file_splice_read,
44 const struct inode_operations afs_file_inode_operations = {
45 .getattr = afs_getattr,
46 .setattr = afs_setattr,
47 .permission = afs_permission,
50 const struct address_space_operations afs_fs_aops = {
51 .readpage = afs_readpage,
52 .readpages = afs_readpages,
53 .set_page_dirty = afs_set_page_dirty,
54 .launder_page = afs_launder_page,
55 .releasepage = afs_releasepage,
56 .invalidatepage = afs_invalidatepage,
57 .write_begin = afs_write_begin,
58 .write_end = afs_write_end,
59 .writepage = afs_writepage,
60 .writepages = afs_writepages,
64 * open an AFS file or directory and attach a key to it
66 int afs_open(struct inode *inode, struct file *file)
68 struct afs_vnode *vnode = AFS_FS_I(inode);
72 _enter("{%x:%u},", vnode->fid.vid, vnode->fid.vnode);
74 key = afs_request_key(vnode->volume->cell);
76 _leave(" = %ld [key]", PTR_ERR(key));
80 ret = afs_validate(vnode, key);
82 _leave(" = %d [val]", ret);
86 file->private_data = key;
92 * release an AFS file or directory and discard its key
94 int afs_release(struct inode *inode, struct file *file)
96 struct afs_vnode *vnode = AFS_FS_I(inode);
98 _enter("{%x:%u},", vnode->fid.vid, vnode->fid.vnode);
100 key_put(file->private_data);
105 #ifdef CONFIG_AFS_FSCACHE
107 * deal with notification that a page was read from the cache
109 static void afs_file_readpage_read_complete(struct page *page,
113 _enter("%p,%p,%d", page, data, error);
115 /* if the read completes with an error, we just unlock the page and let
116 * the VM reissue the readpage */
118 SetPageUptodate(page);
124 * AFS read page from file, directory or symlink
126 static int afs_readpage(struct file *file, struct page *page)
128 struct afs_vnode *vnode;
135 inode = page->mapping->host;
137 ASSERT(file != NULL);
138 key = file->private_data;
141 _enter("{%x},{%lu},{%lu}", key_serial(key), inode->i_ino, page->index);
143 vnode = AFS_FS_I(inode);
145 BUG_ON(!PageLocked(page));
148 if (test_bit(AFS_VNODE_DELETED, &vnode->flags))
152 #ifdef CONFIG_AFS_FSCACHE
153 ret = fscache_read_or_alloc_page(vnode->cache,
155 afs_file_readpage_read_complete,
162 /* read BIO submitted (page in cache) */
166 /* page not yet cached */
168 _debug("cache said ENODATA");
171 /* page will not be cached */
173 _debug("cache said ENOBUFS");
176 offset = page->index << PAGE_CACHE_SHIFT;
177 len = min_t(size_t, i_size_read(inode) - offset, PAGE_SIZE);
179 /* read the contents of the file from the server into the
181 ret = afs_vnode_fetch_data(vnode, key, offset, len, page);
183 if (ret == -ENOENT) {
184 _debug("got NOENT from server"
185 " - marking file deleted and stale");
186 set_bit(AFS_VNODE_DELETED, &vnode->flags);
190 #ifdef CONFIG_AFS_FSCACHE
191 fscache_uncache_page(vnode->cache, page);
193 BUG_ON(PageFsCache(page));
197 SetPageUptodate(page);
199 /* send the page to the cache */
200 #ifdef CONFIG_AFS_FSCACHE
201 if (PageFsCache(page) &&
202 fscache_write_page(vnode->cache, page, GFP_KERNEL) != 0) {
203 fscache_uncache_page(vnode->cache, page);
204 BUG_ON(PageFsCache(page));
216 _leave(" = %d", ret);
221 * read a set of pages
223 static int afs_readpages(struct file *file, struct address_space *mapping,
224 struct list_head *pages, unsigned nr_pages)
226 struct afs_vnode *vnode;
229 _enter(",{%lu},,%d", mapping->host->i_ino, nr_pages);
231 vnode = AFS_FS_I(mapping->host);
232 if (vnode->flags & AFS_VNODE_DELETED) {
233 _leave(" = -ESTALE");
237 /* attempt to read as many of the pages as possible */
238 #ifdef CONFIG_AFS_FSCACHE
239 ret = fscache_read_or_alloc_pages(vnode->cache,
243 afs_file_readpage_read_complete,
245 mapping_gfp_mask(mapping));
251 /* all pages are being read from the cache */
253 BUG_ON(!list_empty(pages));
254 BUG_ON(nr_pages != 0);
255 _leave(" = 0 [reading all]");
258 /* there were pages that couldn't be read from the cache */
265 _leave(" = %d", ret);
269 /* load the missing pages from the network */
270 ret = read_cache_pages(mapping, pages, (void *) afs_readpage, file);
272 _leave(" = %d [netting]", ret);
277 * write back a dirty page
279 static int afs_launder_page(struct page *page)
281 _enter("{%lu}", page->index);
287 * invalidate part or all of a page
288 * - release a page and clean up its private data if offset is 0 (indicating
291 static void afs_invalidatepage(struct page *page, unsigned long offset)
293 struct afs_writeback *wb = (struct afs_writeback *) page_private(page);
295 _enter("{%lu},%lu", page->index, offset);
297 BUG_ON(!PageLocked(page));
299 /* we clean up only if the entire page is being invalidated */
301 #ifdef CONFIG_AFS_FSCACHE
302 if (PageFsCache(page)) {
303 struct afs_vnode *vnode = AFS_FS_I(page->mapping->host);
304 fscache_wait_on_page_write(vnode->cache, page);
305 fscache_uncache_page(vnode->cache, page);
306 ClearPageFsCache(page);
310 if (PagePrivate(page)) {
311 if (wb && !PageWriteback(page)) {
312 set_page_private(page, 0);
313 afs_put_writeback(wb);
316 if (!page_private(page))
317 ClearPagePrivate(page);
325 * release a page and clean up its private state if it's not busy
326 * - return true if the page can now be released, false if not
328 static int afs_releasepage(struct page *page, gfp_t gfp_flags)
330 struct afs_writeback *wb = (struct afs_writeback *) page_private(page);
331 struct afs_vnode *vnode = AFS_FS_I(page->mapping->host);
333 _enter("{{%x:%u}[%lu],%lx},%x",
334 vnode->fid.vid, vnode->fid.vnode, page->index, page->flags,
337 /* deny if page is being written to the cache and the caller hasn't
339 #ifdef CONFIG_AFS_FSCACHE
340 if (PageFsCache(page)) {
341 if (fscache_check_page_write(vnode->cache, page)) {
342 if (!(gfp_flags & __GFP_WAIT)) {
343 _leave(" = F [cache busy]");
346 fscache_wait_on_page_write(vnode->cache, page);
349 fscache_uncache_page(vnode->cache, page);
350 ClearPageFsCache(page);
354 if (PagePrivate(page)) {
356 set_page_private(page, 0);
357 afs_put_writeback(wb);
359 ClearPagePrivate(page);
362 /* indicate that the page can be released */