1 // SPDX-License-Identifier: GPL-2.0
3 * (C) 2001 Clemson University and The University of Chicago
5 * See COPYING in top-level directory.
9 * Linux VFS file operations.
13 #include "orangefs-kernel.h"
14 #include "orangefs-bufmap.h"
16 #include <linux/pagemap.h>
18 static int flush_racache(struct inode *inode)
20 struct orangefs_inode_s *orangefs_inode = ORANGEFS_I(inode);
21 struct orangefs_kernel_op_s *new_op;
24 gossip_debug(GOSSIP_UTILS_DEBUG,
25 "%s: %pU: Handle is %pU | fs_id %d\n", __func__,
26 get_khandle_from_ino(inode), &orangefs_inode->refn.khandle,
27 orangefs_inode->refn.fs_id);
29 new_op = op_alloc(ORANGEFS_VFS_OP_RA_FLUSH);
32 new_op->upcall.req.ra_cache_flush.refn = orangefs_inode->refn;
34 ret = service_operation(new_op, "orangefs_flush_racache",
35 get_interruptible_flag(inode));
37 gossip_debug(GOSSIP_UTILS_DEBUG, "%s: got return value of %d\n",
45 * Copy to client-core's address space from the buffers specified
46 * by the iovec upto total_size bytes.
47 * NOTE: the iovector can either contain addresses which
48 * can futher be kernel-space or user-space addresses.
49 * or it can pointers to struct page's
51 static int precopy_buffers(int buffer_index,
52 struct iov_iter *iter,
57 * copy data from application/kernel by pulling it out
63 ret = orangefs_bufmap_copy_from_iovec(iter,
67 gossip_err("%s: Failed to copy-in buffers. Please make sure that the pvfs2-client is running. %ld\n",
73 gossip_err("%s: Failed to copy-in buffers. Please make sure that the pvfs2-client is running. %ld\n",
80 * Copy from client-core's address space to the buffers specified
81 * by the iovec upto total_size bytes.
82 * NOTE: the iovector can either contain addresses which
83 * can futher be kernel-space or user-space addresses.
84 * or it can pointers to struct page's
86 static int postcopy_buffers(int buffer_index,
87 struct iov_iter *iter,
92 * copy data to application/kernel by pushing it out to
93 * the iovec. NOTE; target buffers can be addresses or
94 * struct page pointers.
97 ret = orangefs_bufmap_copy_to_iovec(iter,
101 gossip_err("%s: Failed to copy-out buffers. Please make sure that the pvfs2-client is running (%ld)\n",
109 * Post and wait for the I/O upcall to finish
111 static ssize_t wait_for_direct_io(enum ORANGEFS_io_type type, struct inode *inode,
112 loff_t *offset, struct iov_iter *iter,
113 size_t total_size, loff_t readahead_size)
115 struct orangefs_inode_s *orangefs_inode = ORANGEFS_I(inode);
116 struct orangefs_khandle *handle = &orangefs_inode->refn.khandle;
117 struct orangefs_kernel_op_s *new_op = NULL;
118 int buffer_index = -1;
121 new_op = op_alloc(ORANGEFS_VFS_OP_FILE_IO);
125 /* synchronous I/O */
126 new_op->upcall.req.io.readahead_size = readahead_size;
127 new_op->upcall.req.io.io_type = type;
128 new_op->upcall.req.io.refn = orangefs_inode->refn;
130 populate_shared_memory:
131 /* get a shared buffer index */
132 buffer_index = orangefs_bufmap_get();
133 if (buffer_index < 0) {
135 gossip_debug(GOSSIP_FILE_DEBUG,
136 "%s: orangefs_bufmap_get failure (%zd)\n",
140 gossip_debug(GOSSIP_FILE_DEBUG,
141 "%s(%pU): GET op %p -> buffer_index %d\n",
147 new_op->uses_shared_memory = 1;
148 new_op->upcall.req.io.buf_index = buffer_index;
149 new_op->upcall.req.io.count = total_size;
150 new_op->upcall.req.io.offset = *offset;
152 gossip_debug(GOSSIP_FILE_DEBUG,
153 "%s(%pU): offset: %llu total_size: %zd\n",
159 * Stage 1: copy the buffers into client-core's address space
160 * precopy_buffers only pertains to writes.
162 if (type == ORANGEFS_IO_WRITE) {
163 ret = precopy_buffers(buffer_index,
170 gossip_debug(GOSSIP_FILE_DEBUG,
171 "%s(%pU): Calling post_io_request with tag (%llu)\n",
176 /* Stage 2: Service the I/O operation */
177 ret = service_operation(new_op,
178 type == ORANGEFS_IO_WRITE ?
181 get_interruptible_flag(inode));
184 * If service_operation() returns -EAGAIN #and# the operation was
185 * purged from orangefs_request_list or htable_ops_in_progress, then
186 * we know that the client was restarted, causing the shared memory
187 * area to be wiped clean. To restart a write operation in this
188 * case, we must re-copy the data from the user's iovec to a NEW
189 * shared memory location. To restart a read operation, we must get
190 * a new shared memory location.
192 if (ret == -EAGAIN && op_state_purged(new_op)) {
193 orangefs_bufmap_put(buffer_index);
195 if (type == ORANGEFS_IO_WRITE)
196 iov_iter_revert(iter, total_size);
197 gossip_debug(GOSSIP_FILE_DEBUG,
198 "%s:going to repopulate_shared_memory.\n",
200 goto populate_shared_memory;
206 * We can't return EINTR if any data was written,
207 * it's not POSIX. It is minimally acceptable
208 * to give a partial write, the way NFS does.
210 * It would be optimal to return all or nothing,
211 * but if a userspace write is bigger than
212 * an IO buffer, and the interrupt occurs
213 * between buffer writes, that would not be
216 switch (new_op->op_state - OP_VFS_STATE_GIVEN_UP) {
218 * If the op was waiting when the interrupt
219 * occurred, then the client-core did not
222 case OP_VFS_STATE_WAITING:
229 * If the op was in progress when the interrupt
230 * occurred, then the client-core was able to
233 case OP_VFS_STATE_INPROGR:
237 gossip_err("%s: unexpected op state :%d:.\n",
243 gossip_debug(GOSSIP_FILE_DEBUG,
244 "%s: got EINTR, state:%d: %p\n",
249 gossip_err("%s: error in %s handle %pU, returning %zd\n",
251 type == ORANGEFS_IO_READ ?
252 "read from" : "write to",
255 if (orangefs_cancel_op_in_progress(new_op))
262 * Stage 3: Post copy buffers from client-core's address space
263 * postcopy_buffers only pertains to reads.
265 if (type == ORANGEFS_IO_READ) {
266 ret = postcopy_buffers(buffer_index,
268 new_op->downcall.resp.io.amt_complete);
272 gossip_debug(GOSSIP_FILE_DEBUG,
273 "%s(%pU): Amount %s, returned by the sys-io call:%d\n",
276 type == ORANGEFS_IO_READ ? "read" : "written",
277 (int)new_op->downcall.resp.io.amt_complete);
279 ret = new_op->downcall.resp.io.amt_complete;
282 if (buffer_index >= 0) {
283 orangefs_bufmap_put(buffer_index);
284 gossip_debug(GOSSIP_FILE_DEBUG,
285 "%s(%pU): PUT buffer_index %d\n",
286 __func__, handle, buffer_index);
294 * Common entry point for read/write/readv/writev
295 * This function will dispatch it to either the direct I/O
296 * or buffered I/O path depending on the mount options and/or
297 * augmented/extended metadata attached to the file.
298 * Note: File extended attributes override any mount options.
300 static ssize_t do_readv_writev(enum ORANGEFS_io_type type, struct file *file,
301 loff_t *offset, struct iov_iter *iter)
303 struct inode *inode = file->f_mapping->host;
304 struct orangefs_inode_s *orangefs_inode = ORANGEFS_I(inode);
305 struct orangefs_khandle *handle = &orangefs_inode->refn.khandle;
306 size_t count = iov_iter_count(iter);
307 ssize_t total_count = 0;
308 ssize_t ret = -EINVAL;
310 gossip_debug(GOSSIP_FILE_DEBUG,
311 "%s-BEGIN(%pU): count(%d) after estimate_max_iovecs.\n",
316 if (type == ORANGEFS_IO_WRITE) {
317 gossip_debug(GOSSIP_FILE_DEBUG,
318 "%s(%pU): proceeding with offset : %llu, "
331 while (iov_iter_count(iter)) {
332 size_t each_count = iov_iter_count(iter);
335 /* how much to transfer in this loop iteration */
336 if (each_count > orangefs_bufmap_size_query())
337 each_count = orangefs_bufmap_size_query();
339 gossip_debug(GOSSIP_FILE_DEBUG,
340 "%s(%pU): size of each_count(%d)\n",
344 gossip_debug(GOSSIP_FILE_DEBUG,
345 "%s(%pU): BEFORE wait_for_io: offset is %d\n",
350 ret = wait_for_direct_io(type, inode, offset, iter,
352 gossip_debug(GOSSIP_FILE_DEBUG,
353 "%s(%pU): return from wait_for_io:%d\n",
365 gossip_debug(GOSSIP_FILE_DEBUG,
366 "%s(%pU): AFTER wait_for_io: offset is %d\n",
372 * if we got a short I/O operations,
373 * fall out and return what we got so far
375 if (amt_complete < each_count)
383 if (type == ORANGEFS_IO_READ) {
386 SetMtimeFlag(orangefs_inode);
387 inode->i_mtime = current_time(inode);
388 mark_inode_dirty_sync(inode);
392 gossip_debug(GOSSIP_FILE_DEBUG,
393 "%s(%pU): Value(%d) returned.\n",
402 * Read data from a specified offset in a file (referenced by inode).
403 * Data may be placed either in a user or kernel buffer.
405 ssize_t orangefs_inode_read(struct inode *inode,
406 struct iov_iter *iter,
408 loff_t readahead_size)
410 struct orangefs_inode_s *orangefs_inode = ORANGEFS_I(inode);
411 size_t count = iov_iter_count(iter);
413 ssize_t ret = -EINVAL;
415 orangefs_stats.reads++;
417 bufmap_size = orangefs_bufmap_size_query();
418 if (count > bufmap_size) {
419 gossip_debug(GOSSIP_FILE_DEBUG,
420 "%s: count is too large (%zd/%zd)!\n",
421 __func__, count, bufmap_size);
425 gossip_debug(GOSSIP_FILE_DEBUG,
426 "%s(%pU) %zd@%llu\n",
428 &orangefs_inode->refn.khandle,
432 ret = wait_for_direct_io(ORANGEFS_IO_READ, inode, offset, iter,
433 count, readahead_size);
437 gossip_debug(GOSSIP_FILE_DEBUG,
438 "%s(%pU): Value(%zd) returned.\n",
440 &orangefs_inode->refn.khandle,
446 static ssize_t orangefs_file_read_iter(struct kiocb *iocb, struct iov_iter *iter)
448 struct file *file = iocb->ki_filp;
449 loff_t pos = *(&iocb->ki_pos);
452 BUG_ON(iocb->private);
454 gossip_debug(GOSSIP_FILE_DEBUG, "orangefs_file_read_iter\n");
456 orangefs_stats.reads++;
458 rc = do_readv_writev(ORANGEFS_IO_READ, file, &pos, iter);
464 static ssize_t orangefs_file_write_iter(struct kiocb *iocb, struct iov_iter *iter)
466 struct file *file = iocb->ki_filp;
470 BUG_ON(iocb->private);
472 gossip_debug(GOSSIP_FILE_DEBUG, "orangefs_file_write_iter\n");
474 inode_lock(file->f_mapping->host);
476 /* Make sure generic_write_checks sees an up to date inode size. */
477 if (file->f_flags & O_APPEND) {
478 rc = orangefs_inode_getattr(file->f_mapping->host, 0, 1,
483 gossip_err("%s: orangefs_inode_getattr failed, "
484 "rc:%zd:.\n", __func__, rc);
489 if (file->f_pos > i_size_read(file->f_mapping->host))
490 orangefs_i_size_write(file->f_mapping->host, file->f_pos);
492 rc = generic_write_checks(iocb, iter);
495 gossip_err("%s: generic_write_checks failed, rc:%zd:.\n",
501 * if we are appending, generic_write_checks would have updated
502 * pos to the end of the file, so we will wait till now to set
505 pos = *(&iocb->ki_pos);
507 rc = do_readv_writev(ORANGEFS_IO_WRITE,
512 gossip_err("%s: do_readv_writev failed, rc:%zd:.\n",
518 orangefs_stats.writes++;
522 inode_unlock(file->f_mapping->host);
527 * Perform a miscellaneous operation on a file.
529 static long orangefs_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
535 gossip_debug(GOSSIP_FILE_DEBUG,
536 "orangefs_ioctl: called with cmd %d\n",
540 * we understand some general ioctls on files, such as the immutable
543 if (cmd == FS_IOC_GETFLAGS) {
545 ret = orangefs_inode_getxattr(file_inode(file),
546 "user.pvfs2.meta_hint",
548 if (ret < 0 && ret != -ENODATA)
550 else if (ret == -ENODATA)
553 gossip_debug(GOSSIP_FILE_DEBUG,
554 "orangefs_ioctl: FS_IOC_GETFLAGS: %llu\n",
555 (unsigned long long)uval);
556 return put_user(uval, (int __user *)arg);
557 } else if (cmd == FS_IOC_SETFLAGS) {
559 if (get_user(uval, (int __user *)arg))
562 * ORANGEFS_MIRROR_FL is set internally when the mirroring mode
563 * is turned on for a file. The user is not allowed to turn
564 * on this bit, but the bit is present if the user first gets
565 * the flags and then updates the flags with some new
566 * settings. So, we ignore it in the following edit. bligon.
568 if ((uval & ~ORANGEFS_MIRROR_FL) &
569 (~(FS_IMMUTABLE_FL | FS_APPEND_FL | FS_NOATIME_FL))) {
570 gossip_err("orangefs_ioctl: the FS_IOC_SETFLAGS only supports setting one of FS_IMMUTABLE_FL|FS_APPEND_FL|FS_NOATIME_FL\n");
574 gossip_debug(GOSSIP_FILE_DEBUG,
575 "orangefs_ioctl: FS_IOC_SETFLAGS: %llu\n",
576 (unsigned long long)val);
577 ret = orangefs_inode_setxattr(file_inode(file),
578 "user.pvfs2.meta_hint",
579 &val, sizeof(val), 0);
586 * Memory map a region of a file.
588 static int orangefs_file_mmap(struct file *file, struct vm_area_struct *vma)
590 gossip_debug(GOSSIP_FILE_DEBUG,
591 "orangefs_file_mmap: called on %s\n",
593 (char *)file->f_path.dentry->d_name.name :
596 /* set the sequential readahead hint */
597 vma->vm_flags |= VM_SEQ_READ;
598 vma->vm_flags &= ~VM_RAND_READ;
600 /* Use readonly mmap since we cannot support writable maps. */
601 return generic_file_readonly_mmap(file, vma);
604 #define mapping_nrpages(idata) ((idata)->nrpages)
607 * Called to notify the module that there are no more references to
608 * this file (i.e. no processes have it open).
610 * \note Not called when each file is closed.
612 static int orangefs_file_release(struct inode *inode, struct file *file)
614 gossip_debug(GOSSIP_FILE_DEBUG,
615 "orangefs_file_release: called on %pD\n",
618 orangefs_flush_inode(inode);
621 * remove all associated inode pages from the page cache and
622 * readahead cache (if any); this forces an expensive refresh of
623 * data for the next caller of mmap (or 'get_block' accesses)
625 if (file_inode(file) &&
626 file_inode(file)->i_mapping &&
627 mapping_nrpages(&file_inode(file)->i_data)) {
628 if (orangefs_features & ORANGEFS_FEATURE_READAHEAD) {
629 gossip_debug(GOSSIP_INODE_DEBUG,
630 "calling flush_racache on %pU\n",
631 get_khandle_from_ino(inode));
632 flush_racache(inode);
633 gossip_debug(GOSSIP_INODE_DEBUG,
634 "flush_racache finished\n");
636 truncate_inode_pages(file_inode(file)->i_mapping,
643 * Push all data for a specific file onto permanent storage.
645 static int orangefs_fsync(struct file *file,
651 struct orangefs_inode_s *orangefs_inode =
652 ORANGEFS_I(file_inode(file));
653 struct orangefs_kernel_op_s *new_op = NULL;
655 new_op = op_alloc(ORANGEFS_VFS_OP_FSYNC);
658 new_op->upcall.req.fsync.refn = orangefs_inode->refn;
660 ret = service_operation(new_op,
662 get_interruptible_flag(file_inode(file)));
664 gossip_debug(GOSSIP_FILE_DEBUG,
665 "orangefs_fsync got return value of %d\n",
670 orangefs_flush_inode(file_inode(file));
675 * Change the file pointer position for an instance of an open file.
677 * \note If .llseek is overriden, we must acquire lock as described in
678 * Documentation/filesystems/Locking.
680 * Future upgrade could support SEEK_DATA and SEEK_HOLE but would
681 * require much changes to the FS
683 static loff_t orangefs_file_llseek(struct file *file, loff_t offset, int origin)
686 struct inode *inode = file_inode(file);
688 if (origin == SEEK_END) {
690 * revalidate the inode's file size.
691 * NOTE: We are only interested in file size here,
692 * so we set mask accordingly.
694 ret = orangefs_inode_getattr(file->f_mapping->host, 0, 1,
699 gossip_debug(GOSSIP_FILE_DEBUG,
700 "%s:%s:%d calling make bad inode\n",
708 gossip_debug(GOSSIP_FILE_DEBUG,
709 "orangefs_file_llseek: offset is %ld | origin is %d"
710 " | inode size is %lu\n",
713 (unsigned long)i_size_read(inode));
715 return generic_file_llseek(file, offset, origin);
719 * Support local locks (locks that only this kernel knows about)
720 * if Orangefs was mounted -o local_lock.
722 static int orangefs_lock(struct file *filp, int cmd, struct file_lock *fl)
726 if (ORANGEFS_SB(file_inode(filp)->i_sb)->flags & ORANGEFS_OPT_LOCAL_LOCK) {
727 if (cmd == F_GETLK) {
729 posix_test_lock(filp, fl);
731 rc = posix_lock_file(filp, fl, NULL);
738 /** ORANGEFS implementation of VFS file operations */
739 const struct file_operations orangefs_file_operations = {
740 .llseek = orangefs_file_llseek,
741 .read_iter = orangefs_file_read_iter,
742 .write_iter = orangefs_file_write_iter,
743 .lock = orangefs_lock,
744 .unlocked_ioctl = orangefs_ioctl,
745 .mmap = orangefs_file_mmap,
746 .open = generic_file_open,
747 .release = orangefs_file_release,
748 .fsync = orangefs_fsync,