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 file_update_time(file
);
388 * Must invalidate to ensure write loop doesn't
389 * prevent kernel from reading updated
390 * attribute. Size probably changed because of
391 * the write, and other clients could update
392 * any other attribute.
394 orangefs_inode
->getattr_time
= jiffies
- 1;
398 gossip_debug(GOSSIP_FILE_DEBUG
,
399 "%s(%pU): Value(%d) returned.\n",
408 * Read data from a specified offset in a file (referenced by inode).
409 * Data may be placed either in a user or kernel buffer.
411 ssize_t
orangefs_inode_read(struct inode
*inode
,
412 struct iov_iter
*iter
,
414 loff_t readahead_size
)
416 struct orangefs_inode_s
*orangefs_inode
= ORANGEFS_I(inode
);
417 size_t count
= iov_iter_count(iter
);
419 ssize_t ret
= -EINVAL
;
421 orangefs_stats
.reads
++;
423 bufmap_size
= orangefs_bufmap_size_query();
424 if (count
> bufmap_size
) {
425 gossip_debug(GOSSIP_FILE_DEBUG
,
426 "%s: count is too large (%zd/%zd)!\n",
427 __func__
, count
, bufmap_size
);
431 gossip_debug(GOSSIP_FILE_DEBUG
,
432 "%s(%pU) %zd@%llu\n",
434 &orangefs_inode
->refn
.khandle
,
438 ret
= wait_for_direct_io(ORANGEFS_IO_READ
, inode
, offset
, iter
,
439 count
, readahead_size
);
443 gossip_debug(GOSSIP_FILE_DEBUG
,
444 "%s(%pU): Value(%zd) returned.\n",
446 &orangefs_inode
->refn
.khandle
,
452 static ssize_t
orangefs_file_read_iter(struct kiocb
*iocb
, struct iov_iter
*iter
)
454 struct file
*file
= iocb
->ki_filp
;
455 loff_t pos
= iocb
->ki_pos
;
458 BUG_ON(iocb
->private);
460 gossip_debug(GOSSIP_FILE_DEBUG
, "orangefs_file_read_iter\n");
462 orangefs_stats
.reads
++;
464 rc
= do_readv_writev(ORANGEFS_IO_READ
, file
, &pos
, iter
);
470 static ssize_t
orangefs_file_write_iter(struct kiocb
*iocb
, struct iov_iter
*iter
)
472 struct file
*file
= iocb
->ki_filp
;
476 BUG_ON(iocb
->private);
478 gossip_debug(GOSSIP_FILE_DEBUG
, "orangefs_file_write_iter\n");
480 inode_lock(file
->f_mapping
->host
);
482 /* Make sure generic_write_checks sees an up to date inode size. */
483 if (file
->f_flags
& O_APPEND
) {
484 rc
= orangefs_inode_getattr(file
->f_mapping
->host
, 0, 1,
489 gossip_err("%s: orangefs_inode_getattr failed, "
490 "rc:%zd:.\n", __func__
, rc
);
495 rc
= generic_write_checks(iocb
, iter
);
498 gossip_err("%s: generic_write_checks failed, rc:%zd:.\n",
504 * if we are appending, generic_write_checks would have updated
505 * pos to the end of the file, so we will wait till now to set
510 rc
= do_readv_writev(ORANGEFS_IO_WRITE
,
515 gossip_err("%s: do_readv_writev failed, rc:%zd:.\n",
521 orangefs_stats
.writes
++;
525 inode_unlock(file
->f_mapping
->host
);
530 * Perform a miscellaneous operation on a file.
532 static long orangefs_ioctl(struct file
*file
, unsigned int cmd
, unsigned long arg
)
538 gossip_debug(GOSSIP_FILE_DEBUG
,
539 "orangefs_ioctl: called with cmd %d\n",
543 * we understand some general ioctls on files, such as the immutable
546 if (cmd
== FS_IOC_GETFLAGS
) {
548 ret
= orangefs_inode_getxattr(file_inode(file
),
549 "user.pvfs2.meta_hint",
551 if (ret
< 0 && ret
!= -ENODATA
)
553 else if (ret
== -ENODATA
)
556 gossip_debug(GOSSIP_FILE_DEBUG
,
557 "orangefs_ioctl: FS_IOC_GETFLAGS: %llu\n",
558 (unsigned long long)uval
);
559 return put_user(uval
, (int __user
*)arg
);
560 } else if (cmd
== FS_IOC_SETFLAGS
) {
562 if (get_user(uval
, (int __user
*)arg
))
565 * ORANGEFS_MIRROR_FL is set internally when the mirroring mode
566 * is turned on for a file. The user is not allowed to turn
567 * on this bit, but the bit is present if the user first gets
568 * the flags and then updates the flags with some new
569 * settings. So, we ignore it in the following edit. bligon.
571 if ((uval
& ~ORANGEFS_MIRROR_FL
) &
572 (~(FS_IMMUTABLE_FL
| FS_APPEND_FL
| FS_NOATIME_FL
))) {
573 gossip_err("orangefs_ioctl: the FS_IOC_SETFLAGS only supports setting one of FS_IMMUTABLE_FL|FS_APPEND_FL|FS_NOATIME_FL\n");
577 gossip_debug(GOSSIP_FILE_DEBUG
,
578 "orangefs_ioctl: FS_IOC_SETFLAGS: %llu\n",
579 (unsigned long long)val
);
580 ret
= orangefs_inode_setxattr(file_inode(file
),
581 "user.pvfs2.meta_hint",
582 &val
, sizeof(val
), 0);
589 * Memory map a region of a file.
591 static int orangefs_file_mmap(struct file
*file
, struct vm_area_struct
*vma
)
593 gossip_debug(GOSSIP_FILE_DEBUG
,
594 "orangefs_file_mmap: called on %s\n",
596 (char *)file
->f_path
.dentry
->d_name
.name
:
599 /* set the sequential readahead hint */
600 vma
->vm_flags
|= VM_SEQ_READ
;
601 vma
->vm_flags
&= ~VM_RAND_READ
;
603 /* Use readonly mmap since we cannot support writable maps. */
604 return generic_file_readonly_mmap(file
, vma
);
607 #define mapping_nrpages(idata) ((idata)->nrpages)
610 * Called to notify the module that there are no more references to
611 * this file (i.e. no processes have it open).
613 * \note Not called when each file is closed.
615 static int orangefs_file_release(struct inode
*inode
, struct file
*file
)
617 gossip_debug(GOSSIP_FILE_DEBUG
,
618 "orangefs_file_release: called on %pD\n",
622 * remove all associated inode pages from the page cache and
623 * readahead cache (if any); this forces an expensive refresh of
624 * data for the next caller of mmap (or 'get_block' accesses)
626 if (file_inode(file
) &&
627 file_inode(file
)->i_mapping
&&
628 mapping_nrpages(&file_inode(file
)->i_data
)) {
629 if (orangefs_features
& ORANGEFS_FEATURE_READAHEAD
) {
630 gossip_debug(GOSSIP_INODE_DEBUG
,
631 "calling flush_racache on %pU\n",
632 get_khandle_from_ino(inode
));
633 flush_racache(inode
);
634 gossip_debug(GOSSIP_INODE_DEBUG
,
635 "flush_racache finished\n");
637 truncate_inode_pages(file_inode(file
)->i_mapping
,
644 * Push all data for a specific file onto permanent storage.
646 static int orangefs_fsync(struct file
*file
,
652 struct orangefs_inode_s
*orangefs_inode
=
653 ORANGEFS_I(file_inode(file
));
654 struct orangefs_kernel_op_s
*new_op
= NULL
;
656 new_op
= op_alloc(ORANGEFS_VFS_OP_FSYNC
);
659 new_op
->upcall
.req
.fsync
.refn
= orangefs_inode
->refn
;
661 ret
= service_operation(new_op
,
663 get_interruptible_flag(file_inode(file
)));
665 gossip_debug(GOSSIP_FILE_DEBUG
,
666 "orangefs_fsync got return value of %d\n",
674 * Change the file pointer position for an instance of an open file.
676 * \note If .llseek is overriden, we must acquire lock as described in
677 * Documentation/filesystems/Locking.
679 * Future upgrade could support SEEK_DATA and SEEK_HOLE but would
680 * require much changes to the FS
682 static loff_t
orangefs_file_llseek(struct file
*file
, loff_t offset
, int origin
)
685 struct inode
*inode
= file_inode(file
);
687 if (origin
== SEEK_END
) {
689 * revalidate the inode's file size.
690 * NOTE: We are only interested in file size here,
691 * so we set mask accordingly.
693 ret
= orangefs_inode_getattr(file
->f_mapping
->host
, 0, 1,
698 gossip_debug(GOSSIP_FILE_DEBUG
,
699 "%s:%s:%d calling make bad inode\n",
707 gossip_debug(GOSSIP_FILE_DEBUG
,
708 "orangefs_file_llseek: offset is %ld | origin is %d"
709 " | inode size is %lu\n",
712 (unsigned long)i_size_read(inode
));
714 return generic_file_llseek(file
, offset
, origin
);
718 * Support local locks (locks that only this kernel knows about)
719 * if Orangefs was mounted -o local_lock.
721 static int orangefs_lock(struct file
*filp
, int cmd
, struct file_lock
*fl
)
725 if (ORANGEFS_SB(file_inode(filp
)->i_sb
)->flags
& ORANGEFS_OPT_LOCAL_LOCK
) {
726 if (cmd
== F_GETLK
) {
728 posix_test_lock(filp
, fl
);
730 rc
= posix_lock_file(filp
, fl
, NULL
);
737 /** ORANGEFS implementation of VFS file operations */
738 const struct file_operations orangefs_file_operations
= {
739 .llseek
= orangefs_file_llseek
,
740 .read_iter
= orangefs_file_read_iter
,
741 .write_iter
= orangefs_file_write_iter
,
742 .lock
= orangefs_lock
,
743 .unlocked_ioctl
= orangefs_ioctl
,
744 .mmap
= orangefs_file_mmap
,
745 .open
= generic_file_open
,
746 .release
= orangefs_file_release
,
747 .fsync
= orangefs_fsync
,