2 * linux/fs/9p/vfs_file.c
4 * This file contians vfs file ops for 9P2000.
6 * Copyright (C) 2004 by Eric Van Hensbergen <ericvh@gmail.com>
7 * Copyright (C) 2002 by Ron Minnich <rminnich@lanl.gov>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2
11 * as published by the Free Software Foundation.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to:
20 * Free Software Foundation
21 * 51 Franklin Street, Fifth Floor
22 * Boston, MA 02111-1301 USA
26 #include <linux/module.h>
27 #include <linux/errno.h>
29 #include <linux/sched.h>
30 #include <linux/file.h>
31 #include <linux/stat.h>
32 #include <linux/string.h>
33 #include <linux/inet.h>
34 #include <linux/list.h>
35 #include <linux/pagemap.h>
36 #include <linux/utsname.h>
37 #include <asm/uaccess.h>
38 #include <linux/idr.h>
39 #include <linux/uio.h>
40 #include <linux/slab.h>
41 #include <net/9p/9p.h>
42 #include <net/9p/client.h>
49 static const struct vm_operations_struct v9fs_file_vm_ops
;
50 static const struct vm_operations_struct v9fs_mmap_file_vm_ops
;
53 * v9fs_file_open - open a file (or directory)
54 * @inode: inode to be opened
55 * @file: file being opened
59 int v9fs_file_open(struct inode
*inode
, struct file
*file
)
62 struct v9fs_inode
*v9inode
;
63 struct v9fs_session_info
*v9ses
;
67 p9_debug(P9_DEBUG_VFS
, "inode: %p file: %p\n", inode
, file
);
68 v9inode
= V9FS_I(inode
);
69 v9ses
= v9fs_inode2v9ses(inode
);
70 if (v9fs_proto_dotl(v9ses
))
71 omode
= v9fs_open_to_dotl_flags(file
->f_flags
);
73 omode
= v9fs_uflags2omode(file
->f_flags
,
74 v9fs_proto_dotu(v9ses
));
75 fid
= file
->private_data
;
77 fid
= v9fs_fid_clone(file
->f_path
.dentry
);
81 err
= p9_client_open(fid
, omode
);
86 if ((file
->f_flags
& O_APPEND
) &&
87 (!v9fs_proto_dotu(v9ses
) && !v9fs_proto_dotl(v9ses
)))
88 generic_file_llseek(file
, 0, SEEK_END
);
91 file
->private_data
= fid
;
92 mutex_lock(&v9inode
->v_mutex
);
93 if ((v9ses
->cache
== CACHE_LOOSE
|| v9ses
->cache
== CACHE_FSCACHE
) &&
94 !v9inode
->writeback_fid
&&
95 ((file
->f_flags
& O_ACCMODE
) != O_RDONLY
)) {
97 * clone a fid and add it to writeback_fid
98 * we do it during open time instead of
99 * page dirty time via write_begin/page_mkwrite
100 * because we want write after unlink usecase
103 fid
= v9fs_writeback_fid(file
->f_path
.dentry
);
106 mutex_unlock(&v9inode
->v_mutex
);
109 v9inode
->writeback_fid
= (void *) fid
;
111 mutex_unlock(&v9inode
->v_mutex
);
112 if (v9ses
->cache
== CACHE_LOOSE
|| v9ses
->cache
== CACHE_FSCACHE
)
113 v9fs_cache_inode_set_cookie(inode
, file
);
116 p9_client_clunk(file
->private_data
);
117 file
->private_data
= NULL
;
122 * v9fs_file_lock - lock a file (or directory)
123 * @filp: file to be locked
125 * @fl: file lock structure
127 * Bugs: this looks like a local only lock, we should extend into 9P
128 * by using open exclusive
131 static int v9fs_file_lock(struct file
*filp
, int cmd
, struct file_lock
*fl
)
134 struct inode
*inode
= file_inode(filp
);
136 p9_debug(P9_DEBUG_VFS
, "filp: %p lock: %p\n", filp
, fl
);
138 /* No mandatory locks */
139 if (__mandatory_lock(inode
) && fl
->fl_type
!= F_UNLCK
)
142 if ((IS_SETLK(cmd
) || IS_SETLKW(cmd
)) && fl
->fl_type
!= F_UNLCK
) {
143 filemap_write_and_wait(inode
->i_mapping
);
144 invalidate_mapping_pages(&inode
->i_data
, 0, -1);
150 static int v9fs_file_do_lock(struct file
*filp
, int cmd
, struct file_lock
*fl
)
152 struct p9_flock flock
;
154 uint8_t status
= P9_LOCK_ERROR
;
156 unsigned char fl_type
;
158 fid
= filp
->private_data
;
161 if ((fl
->fl_flags
& FL_POSIX
) != FL_POSIX
)
164 res
= posix_lock_file_wait(filp
, fl
);
168 /* convert posix lock to p9 tlock args */
169 memset(&flock
, 0, sizeof(flock
));
170 /* map the lock type */
171 switch (fl
->fl_type
) {
173 flock
.type
= P9_LOCK_TYPE_RDLCK
;
176 flock
.type
= P9_LOCK_TYPE_WRLCK
;
179 flock
.type
= P9_LOCK_TYPE_UNLCK
;
182 flock
.start
= fl
->fl_start
;
183 if (fl
->fl_end
== OFFSET_MAX
)
186 flock
.length
= fl
->fl_end
- fl
->fl_start
+ 1;
187 flock
.proc_id
= fl
->fl_pid
;
188 flock
.client_id
= fid
->clnt
->name
;
190 flock
.flags
= P9_LOCK_FLAGS_BLOCK
;
193 * if its a blocked request and we get P9_LOCK_BLOCKED as the status
194 * for lock request, keep on trying
197 res
= p9_client_lock_dotl(fid
, &flock
, &status
);
201 if (status
!= P9_LOCK_BLOCKED
)
203 if (status
== P9_LOCK_BLOCKED
&& !IS_SETLKW(cmd
))
205 if (schedule_timeout_interruptible(P9_LOCK_TIMEOUT
) != 0)
209 /* map 9p status to VFS status */
211 case P9_LOCK_SUCCESS
:
214 case P9_LOCK_BLOCKED
:
218 WARN_ONCE(1, "unknown lock status code: %d\n", status
);
228 * incase server returned error for lock request, revert
231 if (res
< 0 && fl
->fl_type
!= F_UNLCK
) {
232 fl_type
= fl
->fl_type
;
233 fl
->fl_type
= F_UNLCK
;
234 res
= posix_lock_file_wait(filp
, fl
);
235 fl
->fl_type
= fl_type
;
241 static int v9fs_file_getlock(struct file
*filp
, struct file_lock
*fl
)
243 struct p9_getlock glock
;
247 fid
= filp
->private_data
;
250 posix_test_lock(filp
, fl
);
252 * if we have a conflicting lock locally, no need to validate
255 if (fl
->fl_type
!= F_UNLCK
)
258 /* convert posix lock to p9 tgetlock args */
259 memset(&glock
, 0, sizeof(glock
));
260 glock
.type
= P9_LOCK_TYPE_UNLCK
;
261 glock
.start
= fl
->fl_start
;
262 if (fl
->fl_end
== OFFSET_MAX
)
265 glock
.length
= fl
->fl_end
- fl
->fl_start
+ 1;
266 glock
.proc_id
= fl
->fl_pid
;
267 glock
.client_id
= fid
->clnt
->name
;
269 res
= p9_client_getlock_dotl(fid
, &glock
);
272 /* map 9p lock type to os lock type */
273 switch (glock
.type
) {
274 case P9_LOCK_TYPE_RDLCK
:
275 fl
->fl_type
= F_RDLCK
;
277 case P9_LOCK_TYPE_WRLCK
:
278 fl
->fl_type
= F_WRLCK
;
280 case P9_LOCK_TYPE_UNLCK
:
281 fl
->fl_type
= F_UNLCK
;
284 if (glock
.type
!= P9_LOCK_TYPE_UNLCK
) {
285 fl
->fl_start
= glock
.start
;
286 if (glock
.length
== 0)
287 fl
->fl_end
= OFFSET_MAX
;
289 fl
->fl_end
= glock
.start
+ glock
.length
- 1;
290 fl
->fl_pid
= glock
.proc_id
;
292 kfree(glock
.client_id
);
297 * v9fs_file_lock_dotl - lock a file (or directory)
298 * @filp: file to be locked
300 * @fl: file lock structure
304 static int v9fs_file_lock_dotl(struct file
*filp
, int cmd
, struct file_lock
*fl
)
306 struct inode
*inode
= file_inode(filp
);
309 p9_debug(P9_DEBUG_VFS
, "filp: %p cmd:%d lock: %p name: %pD\n",
310 filp
, cmd
, fl
, filp
);
312 /* No mandatory locks */
313 if (__mandatory_lock(inode
) && fl
->fl_type
!= F_UNLCK
)
316 if ((IS_SETLK(cmd
) || IS_SETLKW(cmd
)) && fl
->fl_type
!= F_UNLCK
) {
317 filemap_write_and_wait(inode
->i_mapping
);
318 invalidate_mapping_pages(&inode
->i_data
, 0, -1);
321 if (IS_SETLK(cmd
) || IS_SETLKW(cmd
))
322 ret
= v9fs_file_do_lock(filp
, cmd
, fl
);
323 else if (IS_GETLK(cmd
))
324 ret
= v9fs_file_getlock(filp
, fl
);
332 * v9fs_file_flock_dotl - lock a file
333 * @filp: file to be locked
335 * @fl: file lock structure
339 static int v9fs_file_flock_dotl(struct file
*filp
, int cmd
,
340 struct file_lock
*fl
)
342 struct inode
*inode
= file_inode(filp
);
345 p9_debug(P9_DEBUG_VFS
, "filp: %p cmd:%d lock: %p name: %pD\n",
346 filp
, cmd
, fl
, filp
);
348 /* No mandatory locks */
349 if (__mandatory_lock(inode
) && fl
->fl_type
!= F_UNLCK
)
352 if (!(fl
->fl_flags
& FL_FLOCK
))
355 if ((IS_SETLK(cmd
) || IS_SETLKW(cmd
)) && fl
->fl_type
!= F_UNLCK
) {
356 filemap_write_and_wait(inode
->i_mapping
);
357 invalidate_mapping_pages(&inode
->i_data
, 0, -1);
359 /* Convert flock to posix lock */
360 fl
->fl_flags
|= FL_POSIX
;
361 fl
->fl_flags
^= FL_FLOCK
;
363 if (IS_SETLK(cmd
) | IS_SETLKW(cmd
))
364 ret
= v9fs_file_do_lock(filp
, cmd
, fl
);
372 * v9fs_file_read - read from a file
373 * @filp: file pointer to read
374 * @udata: user data buffer to read data into
375 * @count: size of buffer
376 * @offset: offset at which to read data
381 v9fs_file_read_iter(struct kiocb
*iocb
, struct iov_iter
*to
)
383 struct p9_fid
*fid
= iocb
->ki_filp
->private_data
;
386 p9_debug(P9_DEBUG_VFS
, "count %zu offset %lld\n",
387 iov_iter_count(to
), iocb
->ki_pos
);
389 ret
= p9_client_read(fid
, iocb
->ki_pos
, to
, &err
);
398 * v9fs_file_write - write to a file
399 * @filp: file pointer to write
400 * @data: data buffer to write data from
401 * @count: size of buffer
402 * @offset: offset at which to write data
406 v9fs_file_write_iter(struct kiocb
*iocb
, struct iov_iter
*from
)
408 struct file
*file
= iocb
->ki_filp
;
413 retval
= generic_write_checks(iocb
, from
);
417 origin
= iocb
->ki_pos
;
418 retval
= p9_client_write(file
->private_data
, iocb
->ki_pos
, from
, &err
);
420 struct inode
*inode
= file_inode(file
);
422 unsigned long pg_start
, pg_end
;
423 pg_start
= origin
>> PAGE_CACHE_SHIFT
;
424 pg_end
= (origin
+ retval
- 1) >> PAGE_CACHE_SHIFT
;
425 if (inode
->i_mapping
&& inode
->i_mapping
->nrpages
)
426 invalidate_inode_pages2_range(inode
->i_mapping
,
428 iocb
->ki_pos
+= retval
;
429 i_size
= i_size_read(inode
);
430 if (iocb
->ki_pos
> i_size
) {
431 inode_add_bytes(inode
, iocb
->ki_pos
- i_size
);
432 i_size_write(inode
, iocb
->ki_pos
);
439 static int v9fs_file_fsync(struct file
*filp
, loff_t start
, loff_t end
,
443 struct inode
*inode
= filp
->f_mapping
->host
;
444 struct p9_wstat wstat
;
447 retval
= filemap_write_and_wait_range(inode
->i_mapping
, start
, end
);
451 mutex_lock(&inode
->i_mutex
);
452 p9_debug(P9_DEBUG_VFS
, "filp %p datasync %x\n", filp
, datasync
);
454 fid
= filp
->private_data
;
455 v9fs_blank_wstat(&wstat
);
457 retval
= p9_client_wstat(fid
, &wstat
);
458 mutex_unlock(&inode
->i_mutex
);
463 int v9fs_file_fsync_dotl(struct file
*filp
, loff_t start
, loff_t end
,
467 struct inode
*inode
= filp
->f_mapping
->host
;
470 retval
= filemap_write_and_wait_range(inode
->i_mapping
, start
, end
);
474 mutex_lock(&inode
->i_mutex
);
475 p9_debug(P9_DEBUG_VFS
, "filp %p datasync %x\n", filp
, datasync
);
477 fid
= filp
->private_data
;
479 retval
= p9_client_fsync(fid
, datasync
);
480 mutex_unlock(&inode
->i_mutex
);
486 v9fs_file_mmap(struct file
*filp
, struct vm_area_struct
*vma
)
491 retval
= generic_file_mmap(filp
, vma
);
493 vma
->vm_ops
= &v9fs_file_vm_ops
;
499 v9fs_mmap_file_mmap(struct file
*filp
, struct vm_area_struct
*vma
)
503 struct v9fs_inode
*v9inode
;
506 inode
= file_inode(filp
);
507 v9inode
= V9FS_I(inode
);
508 mutex_lock(&v9inode
->v_mutex
);
509 if (!v9inode
->writeback_fid
&&
510 (vma
->vm_flags
& VM_WRITE
)) {
512 * clone a fid and add it to writeback_fid
513 * we do it during mmap instead of
514 * page dirty time via write_begin/page_mkwrite
515 * because we want write after unlink usecase
518 fid
= v9fs_writeback_fid(filp
->f_path
.dentry
);
520 retval
= PTR_ERR(fid
);
521 mutex_unlock(&v9inode
->v_mutex
);
524 v9inode
->writeback_fid
= (void *) fid
;
526 mutex_unlock(&v9inode
->v_mutex
);
528 retval
= generic_file_mmap(filp
, vma
);
530 vma
->vm_ops
= &v9fs_mmap_file_vm_ops
;
536 v9fs_vm_page_mkwrite(struct vm_area_struct
*vma
, struct vm_fault
*vmf
)
538 struct v9fs_inode
*v9inode
;
539 struct page
*page
= vmf
->page
;
540 struct file
*filp
= vma
->vm_file
;
541 struct inode
*inode
= file_inode(filp
);
544 p9_debug(P9_DEBUG_VFS
, "page %p fid %lx\n",
545 page
, (unsigned long)filp
->private_data
);
547 /* Update file times before taking page lock */
548 file_update_time(filp
);
550 v9inode
= V9FS_I(inode
);
551 /* make sure the cache has finished storing the page */
552 v9fs_fscache_wait_on_page_write(inode
, page
);
553 BUG_ON(!v9inode
->writeback_fid
);
555 if (page
->mapping
!= inode
->i_mapping
)
557 wait_for_stable_page(page
);
559 return VM_FAULT_LOCKED
;
562 return VM_FAULT_NOPAGE
;
566 * v9fs_mmap_file_read - read from a file
567 * @filp: file pointer to read
568 * @data: user data buffer to read data into
569 * @count: size of buffer
570 * @offset: offset at which to read data
574 v9fs_mmap_file_read_iter(struct kiocb
*iocb
, struct iov_iter
*to
)
576 /* TODO: Check if there are dirty pages */
577 return v9fs_file_read_iter(iocb
, to
);
581 * v9fs_mmap_file_write - write to a file
582 * @filp: file pointer to write
583 * @data: data buffer to write data from
584 * @count: size of buffer
585 * @offset: offset at which to write data
589 v9fs_mmap_file_write_iter(struct kiocb
*iocb
, struct iov_iter
*from
)
592 * TODO: invalidate mmaps on filp's inode between
593 * offset and offset+count
595 return v9fs_file_write_iter(iocb
, from
);
598 static void v9fs_mmap_vm_close(struct vm_area_struct
*vma
)
602 struct writeback_control wbc
= {
603 .nr_to_write
= LONG_MAX
,
604 .sync_mode
= WB_SYNC_ALL
,
605 .range_start
= vma
->vm_pgoff
* PAGE_SIZE
,
606 /* absolute end, byte at end included */
607 .range_end
= vma
->vm_pgoff
* PAGE_SIZE
+
608 (vma
->vm_end
- vma
->vm_start
- 1),
612 p9_debug(P9_DEBUG_VFS
, "9p VMA close, %p, flushing", vma
);
614 inode
= file_inode(vma
->vm_file
);
616 if (!mapping_cap_writeback_dirty(inode
->i_mapping
))
620 sync_inode(inode
, &wbc
);
624 static const struct vm_operations_struct v9fs_file_vm_ops
= {
625 .fault
= filemap_fault
,
626 .map_pages
= filemap_map_pages
,
627 .page_mkwrite
= v9fs_vm_page_mkwrite
,
630 static const struct vm_operations_struct v9fs_mmap_file_vm_ops
= {
631 .close
= v9fs_mmap_vm_close
,
632 .fault
= filemap_fault
,
633 .map_pages
= filemap_map_pages
,
634 .page_mkwrite
= v9fs_vm_page_mkwrite
,
638 const struct file_operations v9fs_cached_file_operations
= {
639 .llseek
= generic_file_llseek
,
640 .read_iter
= generic_file_read_iter
,
641 .write_iter
= generic_file_write_iter
,
642 .open
= v9fs_file_open
,
643 .release
= v9fs_dir_release
,
644 .lock
= v9fs_file_lock
,
645 .mmap
= v9fs_file_mmap
,
646 .fsync
= v9fs_file_fsync
,
649 const struct file_operations v9fs_cached_file_operations_dotl
= {
650 .llseek
= generic_file_llseek
,
651 .read_iter
= generic_file_read_iter
,
652 .write_iter
= generic_file_write_iter
,
653 .open
= v9fs_file_open
,
654 .release
= v9fs_dir_release
,
655 .lock
= v9fs_file_lock_dotl
,
656 .flock
= v9fs_file_flock_dotl
,
657 .mmap
= v9fs_file_mmap
,
658 .fsync
= v9fs_file_fsync_dotl
,
661 const struct file_operations v9fs_file_operations
= {
662 .llseek
= generic_file_llseek
,
663 .read_iter
= v9fs_file_read_iter
,
664 .write_iter
= v9fs_file_write_iter
,
665 .open
= v9fs_file_open
,
666 .release
= v9fs_dir_release
,
667 .lock
= v9fs_file_lock
,
668 .mmap
= generic_file_readonly_mmap
,
669 .fsync
= v9fs_file_fsync
,
672 const struct file_operations v9fs_file_operations_dotl
= {
673 .llseek
= generic_file_llseek
,
674 .read_iter
= v9fs_file_read_iter
,
675 .write_iter
= v9fs_file_write_iter
,
676 .open
= v9fs_file_open
,
677 .release
= v9fs_dir_release
,
678 .lock
= v9fs_file_lock_dotl
,
679 .flock
= v9fs_file_flock_dotl
,
680 .mmap
= generic_file_readonly_mmap
,
681 .fsync
= v9fs_file_fsync_dotl
,
684 const struct file_operations v9fs_mmap_file_operations
= {
685 .llseek
= generic_file_llseek
,
686 .read_iter
= v9fs_mmap_file_read_iter
,
687 .write_iter
= v9fs_mmap_file_write_iter
,
688 .open
= v9fs_file_open
,
689 .release
= v9fs_dir_release
,
690 .lock
= v9fs_file_lock
,
691 .mmap
= v9fs_mmap_file_mmap
,
692 .fsync
= v9fs_file_fsync
,
695 const struct file_operations v9fs_mmap_file_operations_dotl
= {
696 .llseek
= generic_file_llseek
,
697 .read_iter
= v9fs_mmap_file_read_iter
,
698 .write_iter
= v9fs_mmap_file_write_iter
,
699 .open
= v9fs_file_open
,
700 .release
= v9fs_dir_release
,
701 .lock
= v9fs_file_lock_dotl
,
702 .flock
= v9fs_file_flock_dotl
,
703 .mmap
= v9fs_mmap_file_mmap
,
704 .fsync
= v9fs_file_fsync_dotl
,