2 * (C) 2001 Clemson University and The University of Chicago
4 * See COPYING in top-level directory.
8 * Linux VFS file operations.
12 #include "orangefs-kernel.h"
13 #include "orangefs-bufmap.h"
15 #include <linux/pagemap.h>
17 static int flush_racache(struct inode *inode)
19 struct orangefs_inode_s *orangefs_inode = ORANGEFS_I(inode);
20 struct orangefs_kernel_op_s *new_op;
23 gossip_debug(GOSSIP_UTILS_DEBUG,
24 "%s: %pU: Handle is %pU | fs_id %d\n", __func__,
25 get_khandle_from_ino(inode), &orangefs_inode->refn.khandle,
26 orangefs_inode->refn.fs_id);
28 new_op = op_alloc(ORANGEFS_VFS_OP_RA_FLUSH);
31 new_op->upcall.req.ra_cache_flush.refn = orangefs_inode->refn;
33 ret = service_operation(new_op, "orangefs_flush_racache",
34 get_interruptible_flag(inode));
36 gossip_debug(GOSSIP_UTILS_DEBUG, "%s: got return value of %d\n",
44 * Copy to client-core's address space from the buffers specified
45 * by the iovec upto total_size bytes.
46 * NOTE: the iovector can either contain addresses which
47 * can futher be kernel-space or user-space addresses.
48 * or it can pointers to struct page's
50 static int precopy_buffers(int buffer_index,
51 struct iov_iter *iter,
56 * copy data from application/kernel by pulling it out
62 ret = orangefs_bufmap_copy_from_iovec(iter,
66 gossip_err("%s: Failed to copy-in buffers. Please make sure that the pvfs2-client is running. %ld\n",
72 gossip_err("%s: Failed to copy-in buffers. Please make sure that the pvfs2-client is running. %ld\n",
79 * Copy from client-core's address space to the buffers specified
80 * by the iovec upto total_size bytes.
81 * NOTE: the iovector can either contain addresses which
82 * can futher be kernel-space or user-space addresses.
83 * or it can pointers to struct page's
85 static int postcopy_buffers(int buffer_index,
86 struct iov_iter *iter,
91 * copy data to application/kernel by pushing it out to
92 * the iovec. NOTE; target buffers can be addresses or
93 * struct page pointers.
96 ret = orangefs_bufmap_copy_to_iovec(iter,
100 gossip_err("%s: Failed to copy-out buffers. Please make sure that the pvfs2-client is running (%ld)\n",
108 * Post and wait for the I/O upcall to finish
110 static ssize_t wait_for_direct_io(enum ORANGEFS_io_type type, struct inode *inode,
111 loff_t *offset, struct iov_iter *iter,
112 size_t total_size, loff_t readahead_size)
114 struct orangefs_inode_s *orangefs_inode = ORANGEFS_I(inode);
115 struct orangefs_khandle *handle = &orangefs_inode->refn.khandle;
116 struct orangefs_kernel_op_s *new_op = NULL;
117 int buffer_index = -1;
120 new_op = op_alloc(ORANGEFS_VFS_OP_FILE_IO);
124 /* synchronous I/O */
125 new_op->upcall.req.io.readahead_size = readahead_size;
126 new_op->upcall.req.io.io_type = type;
127 new_op->upcall.req.io.refn = orangefs_inode->refn;
129 populate_shared_memory:
130 /* get a shared buffer index */
131 buffer_index = orangefs_bufmap_get();
132 if (buffer_index < 0) {
134 gossip_debug(GOSSIP_FILE_DEBUG,
135 "%s: orangefs_bufmap_get failure (%zd)\n",
139 gossip_debug(GOSSIP_FILE_DEBUG,
140 "%s(%pU): GET op %p -> buffer_index %d\n",
146 new_op->uses_shared_memory = 1;
147 new_op->upcall.req.io.buf_index = buffer_index;
148 new_op->upcall.req.io.count = total_size;
149 new_op->upcall.req.io.offset = *offset;
151 gossip_debug(GOSSIP_FILE_DEBUG,
152 "%s(%pU): offset: %llu total_size: %zd\n",
158 * Stage 1: copy the buffers into client-core's address space
159 * precopy_buffers only pertains to writes.
161 if (type == ORANGEFS_IO_WRITE) {
162 ret = precopy_buffers(buffer_index,
169 gossip_debug(GOSSIP_FILE_DEBUG,
170 "%s(%pU): Calling post_io_request with tag (%llu)\n",
175 /* Stage 2: Service the I/O operation */
176 ret = service_operation(new_op,
177 type == ORANGEFS_IO_WRITE ?
180 get_interruptible_flag(inode));
183 * If service_operation() returns -EAGAIN #and# the operation was
184 * purged from orangefs_request_list or htable_ops_in_progress, then
185 * we know that the client was restarted, causing the shared memory
186 * area to be wiped clean. To restart a write operation in this
187 * case, we must re-copy the data from the user's iovec to a NEW
188 * shared memory location. To restart a read operation, we must get
189 * a new shared memory location.
191 if (ret == -EAGAIN && op_state_purged(new_op)) {
192 orangefs_bufmap_put(buffer_index);
194 if (type == ORANGEFS_IO_WRITE)
195 iov_iter_revert(iter, total_size);
196 gossip_debug(GOSSIP_FILE_DEBUG,
197 "%s:going to repopulate_shared_memory.\n",
199 goto populate_shared_memory;
205 * We can't return EINTR if any data was written,
206 * it's not POSIX. It is minimally acceptable
207 * to give a partial write, the way NFS does.
209 * It would be optimal to return all or nothing,
210 * but if a userspace write is bigger than
211 * an IO buffer, and the interrupt occurs
212 * between buffer writes, that would not be
215 switch (new_op->op_state - OP_VFS_STATE_GIVEN_UP) {
217 * If the op was waiting when the interrupt
218 * occurred, then the client-core did not
221 case OP_VFS_STATE_WAITING:
228 * If the op was in progress when the interrupt
229 * occurred, then the client-core was able to
232 case OP_VFS_STATE_INPROGR:
236 gossip_err("%s: unexpected op state :%d:.\n",
242 gossip_debug(GOSSIP_FILE_DEBUG,
243 "%s: got EINTR, state:%d: %p\n",
248 gossip_err("%s: error in %s handle %pU, returning %zd\n",
250 type == ORANGEFS_IO_READ ?
251 "read from" : "write to",
254 if (orangefs_cancel_op_in_progress(new_op))
261 * Stage 3: Post copy buffers from client-core's address space
262 * postcopy_buffers only pertains to reads.
264 if (type == ORANGEFS_IO_READ) {
265 ret = postcopy_buffers(buffer_index,
267 new_op->downcall.resp.io.amt_complete);
271 gossip_debug(GOSSIP_FILE_DEBUG,
272 "%s(%pU): Amount %s, returned by the sys-io call:%d\n",
275 type == ORANGEFS_IO_READ ? "read" : "written",
276 (int)new_op->downcall.resp.io.amt_complete);
278 ret = new_op->downcall.resp.io.amt_complete;
281 if (buffer_index >= 0) {
282 orangefs_bufmap_put(buffer_index);
283 gossip_debug(GOSSIP_FILE_DEBUG,
284 "%s(%pU): PUT buffer_index %d\n",
285 __func__, handle, buffer_index);
293 * Common entry point for read/write/readv/writev
294 * This function will dispatch it to either the direct I/O
295 * or buffered I/O path depending on the mount options and/or
296 * augmented/extended metadata attached to the file.
297 * Note: File extended attributes override any mount options.
299 static ssize_t do_readv_writev(enum ORANGEFS_io_type type, struct file *file,
300 loff_t *offset, struct iov_iter *iter)
302 struct inode *inode = file->f_mapping->host;
303 struct orangefs_inode_s *orangefs_inode = ORANGEFS_I(inode);
304 struct orangefs_khandle *handle = &orangefs_inode->refn.khandle;
305 size_t count = iov_iter_count(iter);
306 ssize_t total_count = 0;
307 ssize_t ret = -EINVAL;
309 gossip_debug(GOSSIP_FILE_DEBUG,
310 "%s-BEGIN(%pU): count(%d) after estimate_max_iovecs.\n",
315 if (type == ORANGEFS_IO_WRITE) {
316 gossip_debug(GOSSIP_FILE_DEBUG,
317 "%s(%pU): proceeding with offset : %llu, "
330 while (iov_iter_count(iter)) {
331 size_t each_count = iov_iter_count(iter);
334 /* how much to transfer in this loop iteration */
335 if (each_count > orangefs_bufmap_size_query())
336 each_count = orangefs_bufmap_size_query();
338 gossip_debug(GOSSIP_FILE_DEBUG,
339 "%s(%pU): size of each_count(%d)\n",
343 gossip_debug(GOSSIP_FILE_DEBUG,
344 "%s(%pU): BEFORE wait_for_io: offset is %d\n",
349 ret = wait_for_direct_io(type, inode, offset, iter,
351 gossip_debug(GOSSIP_FILE_DEBUG,
352 "%s(%pU): return from wait_for_io:%d\n",
364 gossip_debug(GOSSIP_FILE_DEBUG,
365 "%s(%pU): AFTER wait_for_io: offset is %d\n",
371 * if we got a short I/O operations,
372 * fall out and return what we got so far
374 if (amt_complete < each_count)
382 if (type == ORANGEFS_IO_READ) {
385 SetMtimeFlag(orangefs_inode);
386 inode->i_mtime = current_time(inode);
387 mark_inode_dirty_sync(inode);
391 gossip_debug(GOSSIP_FILE_DEBUG,
392 "%s(%pU): Value(%d) returned.\n",
401 * Read data from a specified offset in a file (referenced by inode).
402 * Data may be placed either in a user or kernel buffer.
404 ssize_t orangefs_inode_read(struct inode *inode,
405 struct iov_iter *iter,
407 loff_t readahead_size)
409 struct orangefs_inode_s *orangefs_inode = ORANGEFS_I(inode);
410 size_t count = iov_iter_count(iter);
412 ssize_t ret = -EINVAL;
414 orangefs_stats.reads++;
416 bufmap_size = orangefs_bufmap_size_query();
417 if (count > bufmap_size) {
418 gossip_debug(GOSSIP_FILE_DEBUG,
419 "%s: count is too large (%zd/%zd)!\n",
420 __func__, count, bufmap_size);
424 gossip_debug(GOSSIP_FILE_DEBUG,
425 "%s(%pU) %zd@%llu\n",
427 &orangefs_inode->refn.khandle,
431 ret = wait_for_direct_io(ORANGEFS_IO_READ, inode, offset, iter,
432 count, readahead_size);
436 gossip_debug(GOSSIP_FILE_DEBUG,
437 "%s(%pU): Value(%zd) returned.\n",
439 &orangefs_inode->refn.khandle,
445 static ssize_t orangefs_file_read_iter(struct kiocb *iocb, struct iov_iter *iter)
447 struct file *file = iocb->ki_filp;
448 loff_t pos = *(&iocb->ki_pos);
451 BUG_ON(iocb->private);
453 gossip_debug(GOSSIP_FILE_DEBUG, "orangefs_file_read_iter\n");
455 orangefs_stats.reads++;
457 rc = do_readv_writev(ORANGEFS_IO_READ, file, &pos, iter);
463 static ssize_t orangefs_file_write_iter(struct kiocb *iocb, struct iov_iter *iter)
465 struct file *file = iocb->ki_filp;
469 BUG_ON(iocb->private);
471 gossip_debug(GOSSIP_FILE_DEBUG, "orangefs_file_write_iter\n");
473 inode_lock(file->f_mapping->host);
475 /* Make sure generic_write_checks sees an up to date inode size. */
476 if (file->f_flags & O_APPEND) {
477 rc = orangefs_inode_getattr(file->f_mapping->host, 0, 1,
482 gossip_err("%s: orangefs_inode_getattr failed, "
483 "rc:%zd:.\n", __func__, rc);
488 if (file->f_pos > i_size_read(file->f_mapping->host))
489 orangefs_i_size_write(file->f_mapping->host, file->f_pos);
491 rc = generic_write_checks(iocb, iter);
494 gossip_err("%s: generic_write_checks failed, rc:%zd:.\n",
500 * if we are appending, generic_write_checks would have updated
501 * pos to the end of the file, so we will wait till now to set
504 pos = *(&iocb->ki_pos);
506 rc = do_readv_writev(ORANGEFS_IO_WRITE,
511 gossip_err("%s: do_readv_writev failed, rc:%zd:.\n",
517 orangefs_stats.writes++;
521 inode_unlock(file->f_mapping->host);
526 * Perform a miscellaneous operation on a file.
528 static long orangefs_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
534 gossip_debug(GOSSIP_FILE_DEBUG,
535 "orangefs_ioctl: called with cmd %d\n",
539 * we understand some general ioctls on files, such as the immutable
542 if (cmd == FS_IOC_GETFLAGS) {
544 ret = orangefs_inode_getxattr(file_inode(file),
545 "user.pvfs2.meta_hint",
547 if (ret < 0 && ret != -ENODATA)
549 else if (ret == -ENODATA)
552 gossip_debug(GOSSIP_FILE_DEBUG,
553 "orangefs_ioctl: FS_IOC_GETFLAGS: %llu\n",
554 (unsigned long long)uval);
555 return put_user(uval, (int __user *)arg);
556 } else if (cmd == FS_IOC_SETFLAGS) {
558 if (get_user(uval, (int __user *)arg))
561 * ORANGEFS_MIRROR_FL is set internally when the mirroring mode
562 * is turned on for a file. The user is not allowed to turn
563 * on this bit, but the bit is present if the user first gets
564 * the flags and then updates the flags with some new
565 * settings. So, we ignore it in the following edit. bligon.
567 if ((uval & ~ORANGEFS_MIRROR_FL) &
568 (~(FS_IMMUTABLE_FL | FS_APPEND_FL | FS_NOATIME_FL))) {
569 gossip_err("orangefs_ioctl: the FS_IOC_SETFLAGS only supports setting one of FS_IMMUTABLE_FL|FS_APPEND_FL|FS_NOATIME_FL\n");
573 gossip_debug(GOSSIP_FILE_DEBUG,
574 "orangefs_ioctl: FS_IOC_SETFLAGS: %llu\n",
575 (unsigned long long)val);
576 ret = orangefs_inode_setxattr(file_inode(file),
577 "user.pvfs2.meta_hint",
578 &val, sizeof(val), 0);
585 * Memory map a region of a file.
587 static int orangefs_file_mmap(struct file *file, struct vm_area_struct *vma)
589 gossip_debug(GOSSIP_FILE_DEBUG,
590 "orangefs_file_mmap: called on %s\n",
592 (char *)file->f_path.dentry->d_name.name :
595 /* set the sequential readahead hint */
596 vma->vm_flags |= VM_SEQ_READ;
597 vma->vm_flags &= ~VM_RAND_READ;
599 /* Use readonly mmap since we cannot support writable maps. */
600 return generic_file_readonly_mmap(file, vma);
603 #define mapping_nrpages(idata) ((idata)->nrpages)
606 * Called to notify the module that there are no more references to
607 * this file (i.e. no processes have it open).
609 * \note Not called when each file is closed.
611 static int orangefs_file_release(struct inode *inode, struct file *file)
613 gossip_debug(GOSSIP_FILE_DEBUG,
614 "orangefs_file_release: called on %pD\n",
617 orangefs_flush_inode(inode);
620 * remove all associated inode pages from the page cache and
621 * readahead cache (if any); this forces an expensive refresh of
622 * data for the next caller of mmap (or 'get_block' accesses)
624 if (file_inode(file) &&
625 file_inode(file)->i_mapping &&
626 mapping_nrpages(&file_inode(file)->i_data)) {
627 if (orangefs_features & ORANGEFS_FEATURE_READAHEAD) {
628 gossip_debug(GOSSIP_INODE_DEBUG,
629 "calling flush_racache on %pU\n",
630 get_khandle_from_ino(inode));
631 flush_racache(inode);
632 gossip_debug(GOSSIP_INODE_DEBUG,
633 "flush_racache finished\n");
635 truncate_inode_pages(file_inode(file)->i_mapping,
642 * Push all data for a specific file onto permanent storage.
644 static int orangefs_fsync(struct file *file,
650 struct orangefs_inode_s *orangefs_inode =
651 ORANGEFS_I(file_inode(file));
652 struct orangefs_kernel_op_s *new_op = NULL;
655 filemap_write_and_wait_range(file->f_mapping, start, end);
657 new_op = op_alloc(ORANGEFS_VFS_OP_FSYNC);
660 new_op->upcall.req.fsync.refn = orangefs_inode->refn;
662 ret = service_operation(new_op,
664 get_interruptible_flag(file_inode(file)));
666 gossip_debug(GOSSIP_FILE_DEBUG,
667 "orangefs_fsync got return value of %d\n",
672 orangefs_flush_inode(file_inode(file));
677 * Change the file pointer position for an instance of an open file.
679 * \note If .llseek is overriden, we must acquire lock as described in
680 * Documentation/filesystems/Locking.
682 * Future upgrade could support SEEK_DATA and SEEK_HOLE but would
683 * require much changes to the FS
685 static loff_t orangefs_file_llseek(struct file *file, loff_t offset, int origin)
688 struct inode *inode = file_inode(file);
690 if (origin == SEEK_END) {
692 * revalidate the inode's file size.
693 * NOTE: We are only interested in file size here,
694 * so we set mask accordingly.
696 ret = orangefs_inode_getattr(file->f_mapping->host, 0, 1,
701 gossip_debug(GOSSIP_FILE_DEBUG,
702 "%s:%s:%d calling make bad inode\n",
710 gossip_debug(GOSSIP_FILE_DEBUG,
711 "orangefs_file_llseek: offset is %ld | origin is %d"
712 " | inode size is %lu\n",
715 (unsigned long)i_size_read(inode));
717 return generic_file_llseek(file, offset, origin);
721 * Support local locks (locks that only this kernel knows about)
722 * if Orangefs was mounted -o local_lock.
724 static int orangefs_lock(struct file *filp, int cmd, struct file_lock *fl)
728 if (ORANGEFS_SB(file_inode(filp)->i_sb)->flags & ORANGEFS_OPT_LOCAL_LOCK) {
729 if (cmd == F_GETLK) {
731 posix_test_lock(filp, fl);
733 rc = posix_lock_file(filp, fl, NULL);
740 /** ORANGEFS implementation of VFS file operations */
741 const struct file_operations orangefs_file_operations = {
742 .llseek = orangefs_file_llseek,
743 .read_iter = orangefs_file_read_iter,
744 .write_iter = orangefs_file_write_iter,
745 .lock = orangefs_lock,
746 .unlocked_ioctl = orangefs_ioctl,
747 .mmap = orangefs_file_mmap,
748 .open = generic_file_open,
749 .release = orangefs_file_release,
750 .fsync = orangefs_fsync,