blob: 633c07a6e3d80530b585c957edc6d5eeae70d042 [file] [log] [blame]
Mike Marshallf7ab0932015-07-17 10:38:11 -04001/*
2 * (C) 2001 Clemson University and The University of Chicago
3 *
4 * See COPYING in top-level directory.
5 */
6
7/*
Yi Liu8bb8aef2015-11-24 15:12:14 -05008 * The ORANGEFS Linux kernel support allows ORANGEFS volumes to be mounted and
Mike Marshallf7ab0932015-07-17 10:38:11 -04009 * accessed through the Linux VFS (i.e. using standard I/O system calls).
10 * This support is only needed on clients that wish to mount the file system.
11 *
12 */
13
14/*
Yi Liu8bb8aef2015-11-24 15:12:14 -050015 * Declarations and macros for the ORANGEFS Linux kernel support.
Mike Marshallf7ab0932015-07-17 10:38:11 -040016 */
17
Yi Liu8bb8aef2015-11-24 15:12:14 -050018#ifndef __ORANGEFSKERNEL_H
19#define __ORANGEFSKERNEL_H
Mike Marshallf7ab0932015-07-17 10:38:11 -040020
21#include <linux/kernel.h>
22#include <linux/moduleparam.h>
23#include <linux/statfs.h>
24#include <linux/backing-dev.h>
25#include <linux/device.h>
26#include <linux/mpage.h>
27#include <linux/namei.h>
28#include <linux/errno.h>
29#include <linux/init.h>
30#include <linux/module.h>
31#include <linux/slab.h>
32#include <linux/types.h>
33#include <linux/fs.h>
34#include <linux/vmalloc.h>
35
36#include <linux/aio.h>
37#include <linux/posix_acl.h>
38#include <linux/posix_acl_xattr.h>
39#include <linux/compat.h>
40#include <linux/mount.h>
41#include <linux/uaccess.h>
42#include <linux/atomic.h>
43#include <linux/uio.h>
44#include <linux/sched.h>
45#include <linux/mm.h>
46#include <linux/wait.h>
47#include <linux/dcache.h>
48#include <linux/pagemap.h>
49#include <linux/poll.h>
50#include <linux/rwsem.h>
51#include <linux/xattr.h>
52#include <linux/exportfs.h>
53
54#include <asm/unaligned.h>
55
Mike Marshall575e9462015-12-04 12:56:14 -050056#include "orangefs-dev-proto.h"
Mike Marshallf7ab0932015-07-17 10:38:11 -040057
Yi Liu8bb8aef2015-11-24 15:12:14 -050058#ifdef ORANGEFS_KERNEL_DEBUG
59#define ORANGEFS_DEFAULT_OP_TIMEOUT_SECS 10
Mike Marshallf7ab0932015-07-17 10:38:11 -040060#else
Yi Liu8bb8aef2015-11-24 15:12:14 -050061#define ORANGEFS_DEFAULT_OP_TIMEOUT_SECS 20
Mike Marshallf7ab0932015-07-17 10:38:11 -040062#endif
63
Yi Liu8bb8aef2015-11-24 15:12:14 -050064#define ORANGEFS_BUFMAP_WAIT_TIMEOUT_SECS 30
Mike Marshallf7ab0932015-07-17 10:38:11 -040065
Yi Liu8bb8aef2015-11-24 15:12:14 -050066#define ORANGEFS_DEFAULT_SLOT_TIMEOUT_SECS 900 /* 15 minutes */
Mike Marshallf7ab0932015-07-17 10:38:11 -040067
Yi Liu8bb8aef2015-11-24 15:12:14 -050068#define ORANGEFS_REQDEVICE_NAME "pvfs2-req"
Mike Marshallf7ab0932015-07-17 10:38:11 -040069
Yi Liu8bb8aef2015-11-24 15:12:14 -050070#define ORANGEFS_DEVREQ_MAGIC 0x20030529
71#define ORANGEFS_LINK_MAX 0x000000FF
72#define ORANGEFS_PURGE_RETRY_COUNT 0x00000005
Yi Liu8bb8aef2015-11-24 15:12:14 -050073#define ORANGEFS_MAX_NUM_OPTIONS 0x00000004
74#define ORANGEFS_MAX_MOUNT_OPT_LEN 0x00000080
75#define ORANGEFS_MAX_FSKEY_LEN 64
Mike Marshallf7ab0932015-07-17 10:38:11 -040076
Mike Marshallcf0c2772016-01-19 12:04:40 -050077#define MAX_DEV_REQ_UPSIZE (2 * sizeof(__s32) + \
Yi Liu8bb8aef2015-11-24 15:12:14 -050078sizeof(__u64) + sizeof(struct orangefs_upcall_s))
Mike Marshallcf0c2772016-01-19 12:04:40 -050079#define MAX_DEV_REQ_DOWNSIZE (2 * sizeof(__s32) + \
Yi Liu8bb8aef2015-11-24 15:12:14 -050080sizeof(__u64) + sizeof(struct orangefs_downcall_s))
Mike Marshallf7ab0932015-07-17 10:38:11 -040081
Mike Marshallf7ab0932015-07-17 10:38:11 -040082/*
Yi Liu8bb8aef2015-11-24 15:12:14 -050083 * valid orangefs kernel operation states
Mike Marshallf7ab0932015-07-17 10:38:11 -040084 *
85 * unknown - op was just initialized
86 * waiting - op is on request_list (upward bound)
87 * inprogr - op is in progress (waiting for downcall)
88 * serviced - op has matching downcall; ok
89 * purged - op has to start a timer since client-core
90 * exited uncleanly before servicing op
Al Viroed42fe02016-01-22 19:47:47 -050091 * given up - submitter has given up waiting for it
Mike Marshallf7ab0932015-07-17 10:38:11 -040092 */
Yi Liu8bb8aef2015-11-24 15:12:14 -050093enum orangefs_vfs_op_states {
Mike Marshallf7ab0932015-07-17 10:38:11 -040094 OP_VFS_STATE_UNKNOWN = 0,
95 OP_VFS_STATE_WAITING = 1,
96 OP_VFS_STATE_INPROGR = 2,
97 OP_VFS_STATE_SERVICED = 4,
98 OP_VFS_STATE_PURGED = 8,
Al Viroed42fe02016-01-22 19:47:47 -050099 OP_VFS_STATE_GIVEN_UP = 16,
Mike Marshallf7ab0932015-07-17 10:38:11 -0400100};
101
Mike Marshallf7ab0932015-07-17 10:38:11 -0400102/*
Mike Marshallf7ab0932015-07-17 10:38:11 -0400103 * An array of client_debug_mask will be built to hold debug keyword/mask
104 * values fetched from userspace.
105 */
106struct client_debug_mask {
107 char *keyword;
108 __u64 mask1;
109 __u64 mask2;
110};
111
112/*
Yi Liu8bb8aef2015-11-24 15:12:14 -0500113 * orangefs kernel memory related flags
Mike Marshallf7ab0932015-07-17 10:38:11 -0400114 */
115
Yi Liu8bb8aef2015-11-24 15:12:14 -0500116#if ((defined ORANGEFS_KERNEL_DEBUG) && (defined CONFIG_DEBUG_SLAB))
117#define ORANGEFS_CACHE_CREATE_FLAGS SLAB_RED_ZONE
Mike Marshallf7ab0932015-07-17 10:38:11 -0400118#else
Yi Liu8bb8aef2015-11-24 15:12:14 -0500119#define ORANGEFS_CACHE_CREATE_FLAGS 0
120#endif /* ((defined ORANGEFS_KERNEL_DEBUG) && (defined CONFIG_DEBUG_SLAB)) */
Mike Marshallf7ab0932015-07-17 10:38:11 -0400121
Yi Liu8bb8aef2015-11-24 15:12:14 -0500122/* these functions are defined in orangefs-utils.c */
Mike Marshallf7ab0932015-07-17 10:38:11 -0400123int orangefs_prepare_cdm_array(char *debug_array_string);
124int orangefs_prepare_debugfs_help_string(int);
125
Yi Liu8bb8aef2015-11-24 15:12:14 -0500126/* defined in orangefs-debugfs.c */
127int orangefs_client_debug_init(void);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400128
129void debug_string_to_mask(char *, void *, int);
130void do_c_mask(int, char *, struct client_debug_mask **);
131void do_k_mask(int, char *, __u64 **);
132
133void debug_mask_to_string(void *, int);
134void do_k_string(void *, int);
135void do_c_string(void *, int);
136int check_amalgam_keyword(void *, int);
137int keyword_is_amalgam(char *);
138
Yi Liu8bb8aef2015-11-24 15:12:14 -0500139/*these variables are defined in orangefs-mod.c */
140extern char kernel_debug_string[ORANGEFS_MAX_DEBUG_STRING_LEN];
141extern char client_debug_string[ORANGEFS_MAX_DEBUG_STRING_LEN];
142extern char client_debug_array_string[ORANGEFS_MAX_DEBUG_STRING_LEN];
Mike Marshallf7ab0932015-07-17 10:38:11 -0400143extern unsigned int kernel_mask_set_mod_init;
144
Yi Liu8bb8aef2015-11-24 15:12:14 -0500145extern int orangefs_init_acl(struct inode *inode, struct inode *dir);
146extern const struct xattr_handler *orangefs_xattr_handlers[];
Mike Marshallf7ab0932015-07-17 10:38:11 -0400147
Yi Liu8bb8aef2015-11-24 15:12:14 -0500148extern struct posix_acl *orangefs_get_acl(struct inode *inode, int type);
149extern int orangefs_set_acl(struct inode *inode, struct posix_acl *acl, int type);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400150
Mike Marshallf7ab0932015-07-17 10:38:11 -0400151/*
152 * Redefine xtvec structure so that we could move helper functions out of
153 * the define
154 */
155struct xtvec {
156 __kernel_off_t xtv_off; /* must be off_t */
157 __kernel_size_t xtv_len; /* must be size_t */
158};
159
160/*
Yi Liu8bb8aef2015-11-24 15:12:14 -0500161 * orangefs data structures
Mike Marshallf7ab0932015-07-17 10:38:11 -0400162 */
Yi Liu8bb8aef2015-11-24 15:12:14 -0500163struct orangefs_kernel_op_s {
164 enum orangefs_vfs_op_states op_state;
Mike Marshallf7ab0932015-07-17 10:38:11 -0400165 __u64 tag;
166
167 /*
Mike Marshalld37c0f32016-02-24 13:24:14 -0500168 * Set uses_shared_memory to non zero if this operation uses
169 * shared memory. If true, then a retry on the op must also
170 * get a new shared memory buffer and re-populate it.
171 * Cancels don't care - it only matters for service_operation()
172 * retry logics and cancels don't go through it anymore. It
173 * safely stays non-zero when we use it as slot_to_free.
Mike Marshallf7ab0932015-07-17 10:38:11 -0400174 */
Al Viro78699e22016-02-11 23:07:19 -0500175 union {
176 int uses_shared_memory;
177 int slot_to_free;
178 };
Mike Marshallf7ab0932015-07-17 10:38:11 -0400179
Yi Liu8bb8aef2015-11-24 15:12:14 -0500180 struct orangefs_upcall_s upcall;
181 struct orangefs_downcall_s downcall;
Mike Marshallf7ab0932015-07-17 10:38:11 -0400182
Al Virod2d87a32016-02-13 10:15:22 -0500183 struct completion waitq;
Mike Marshallf7ab0932015-07-17 10:38:11 -0400184 spinlock_t lock;
185
Mike Marshallf7ab0932015-07-17 10:38:11 -0400186 int attempts;
187
188 struct list_head list;
189};
190
Al Viro60831942016-01-21 23:17:37 -0500191#define set_op_state_waiting(op) ((op)->op_state = OP_VFS_STATE_WAITING)
192#define set_op_state_inprogress(op) ((op)->op_state = OP_VFS_STATE_INPROGR)
Mike Marshall2d4cae02016-02-04 13:48:16 -0500193#define set_op_state_given_up(op) ((op)->op_state = OP_VFS_STATE_GIVEN_UP)
Al Viro60831942016-01-21 23:17:37 -0500194static inline void set_op_state_serviced(struct orangefs_kernel_op_s *op)
195{
196 op->op_state = OP_VFS_STATE_SERVICED;
Al Virod2d87a32016-02-13 10:15:22 -0500197 complete(&op->waitq);
Al Viro60831942016-01-21 23:17:37 -0500198}
Al Viro60831942016-01-21 23:17:37 -0500199
200#define op_state_waiting(op) ((op)->op_state & OP_VFS_STATE_WAITING)
201#define op_state_in_progress(op) ((op)->op_state & OP_VFS_STATE_INPROGR)
202#define op_state_serviced(op) ((op)->op_state & OP_VFS_STATE_SERVICED)
203#define op_state_purged(op) ((op)->op_state & OP_VFS_STATE_PURGED)
Al Viroed42fe02016-01-22 19:47:47 -0500204#define op_state_given_up(op) ((op)->op_state & OP_VFS_STATE_GIVEN_UP)
Al Viro78699e22016-02-11 23:07:19 -0500205#define op_is_cancel(op) ((op)->upcall.type == ORANGEFS_VFS_OP_CANCEL)
Al Viroed42fe02016-01-22 19:47:47 -0500206
Al Viroc1223ca2016-02-18 19:17:51 -0500207void op_release(struct orangefs_kernel_op_s *op);
Al Viro60831942016-01-21 23:17:37 -0500208
Al Viro78699e22016-02-11 23:07:19 -0500209extern void orangefs_bufmap_put(int);
210static inline void put_cancel(struct orangefs_kernel_op_s *op)
211{
212 orangefs_bufmap_put(op->slot_to_free);
213 op_release(op);
214}
215
216static inline void set_op_state_purged(struct orangefs_kernel_op_s *op)
217{
218 spin_lock(&op->lock);
219 if (unlikely(op_is_cancel(op))) {
Al Viro05a50a52016-02-18 18:59:44 -0500220 list_del_init(&op->list);
Al Viro78699e22016-02-11 23:07:19 -0500221 spin_unlock(&op->lock);
222 put_cancel(op);
223 } else {
224 op->op_state |= OP_VFS_STATE_PURGED;
Al Virod2d87a32016-02-13 10:15:22 -0500225 complete(&op->waitq);
Al Viro78699e22016-02-11 23:07:19 -0500226 spin_unlock(&op->lock);
227 }
228}
229
Yi Liu8bb8aef2015-11-24 15:12:14 -0500230/* per inode private orangefs info */
231struct orangefs_inode_s {
232 struct orangefs_object_kref refn;
233 char link_target[ORANGEFS_NAME_MAX];
Mike Marshallf7ab0932015-07-17 10:38:11 -0400234 __s64 blksize;
235 /*
236 * Reading/Writing Extended attributes need to acquire the appropriate
Yi Liu8bb8aef2015-11-24 15:12:14 -0500237 * reader/writer semaphore on the orangefs_inode_s structure.
Mike Marshallf7ab0932015-07-17 10:38:11 -0400238 */
239 struct rw_semaphore xattr_sem;
240
241 struct inode vfs_inode;
242 sector_t last_failed_block_index_read;
243
244 /*
245 * State of in-memory attributes not yet flushed to disk associated
246 * with this object
247 */
248 unsigned long pinode_flags;
Martin Brandenburg71680c12016-06-09 16:32:38 -0400249
250 unsigned long getattr_time;
Mike Marshallf7ab0932015-07-17 10:38:11 -0400251};
252
253#define P_ATIME_FLAG 0
254#define P_MTIME_FLAG 1
255#define P_CTIME_FLAG 2
256#define P_MODE_FLAG 3
257
258#define ClearAtimeFlag(pinode) clear_bit(P_ATIME_FLAG, &(pinode)->pinode_flags)
259#define SetAtimeFlag(pinode) set_bit(P_ATIME_FLAG, &(pinode)->pinode_flags)
260#define AtimeFlag(pinode) test_bit(P_ATIME_FLAG, &(pinode)->pinode_flags)
261
262#define ClearMtimeFlag(pinode) clear_bit(P_MTIME_FLAG, &(pinode)->pinode_flags)
263#define SetMtimeFlag(pinode) set_bit(P_MTIME_FLAG, &(pinode)->pinode_flags)
264#define MtimeFlag(pinode) test_bit(P_MTIME_FLAG, &(pinode)->pinode_flags)
265
266#define ClearCtimeFlag(pinode) clear_bit(P_CTIME_FLAG, &(pinode)->pinode_flags)
267#define SetCtimeFlag(pinode) set_bit(P_CTIME_FLAG, &(pinode)->pinode_flags)
268#define CtimeFlag(pinode) test_bit(P_CTIME_FLAG, &(pinode)->pinode_flags)
269
270#define ClearModeFlag(pinode) clear_bit(P_MODE_FLAG, &(pinode)->pinode_flags)
271#define SetModeFlag(pinode) set_bit(P_MODE_FLAG, &(pinode)->pinode_flags)
272#define ModeFlag(pinode) test_bit(P_MODE_FLAG, &(pinode)->pinode_flags)
273
Yi Liu8bb8aef2015-11-24 15:12:14 -0500274/* per superblock private orangefs info */
275struct orangefs_sb_info_s {
276 struct orangefs_khandle root_khandle;
Mike Marshallf7ab0932015-07-17 10:38:11 -0400277 __s32 fs_id;
278 int id;
279 int flags;
Yi Liu8bb8aef2015-11-24 15:12:14 -0500280#define ORANGEFS_OPT_INTR 0x01
281#define ORANGEFS_OPT_LOCAL_LOCK 0x02
282 char devname[ORANGEFS_MAX_SERVER_ADDR_LEN];
Mike Marshallf7ab0932015-07-17 10:38:11 -0400283 struct super_block *sb;
284 int mount_pending;
285 struct list_head list;
286};
287
288/*
Mike Marshallf7ab0932015-07-17 10:38:11 -0400289 * structure that holds the state of any async I/O operation issued
290 * through the VFS. Needed especially to handle cancellation requests
291 * or even completion notification so that the VFS client-side daemon
292 * can free up its vfs_request slots.
293 */
Yi Liu8bb8aef2015-11-24 15:12:14 -0500294struct orangefs_kiocb_s {
Mike Marshallf7ab0932015-07-17 10:38:11 -0400295 /* the pointer to the task that initiated the AIO */
296 struct task_struct *tsk;
297
298 /* pointer to the kiocb that kicked this operation */
299 struct kiocb *kiocb;
300
301 /* buffer index that was used for the I/O */
Yi Liu8bb8aef2015-11-24 15:12:14 -0500302 struct orangefs_bufmap *bufmap;
Mike Marshallf7ab0932015-07-17 10:38:11 -0400303 int buffer_index;
304
Yi Liu8bb8aef2015-11-24 15:12:14 -0500305 /* orangefs kernel operation type */
306 struct orangefs_kernel_op_s *op;
Mike Marshallf7ab0932015-07-17 10:38:11 -0400307
308 /* The user space buffers from/to which I/O is being staged */
309 struct iovec *iov;
310
311 /* number of elements in the iovector */
312 unsigned long nr_segs;
313
314 /* set to indicate the type of the operation */
315 int rw;
316
317 /* file offset */
318 loff_t offset;
319
320 /* and the count in bytes */
321 size_t bytes_to_be_copied;
322
323 ssize_t bytes_copied;
324 int needs_cleanup;
325};
326
Yi Liu8bb8aef2015-11-24 15:12:14 -0500327struct orangefs_stats {
Mike Marshallf7ab0932015-07-17 10:38:11 -0400328 unsigned long cache_hits;
329 unsigned long cache_misses;
330 unsigned long reads;
331 unsigned long writes;
332};
333
Yi Liu8bb8aef2015-11-24 15:12:14 -0500334extern struct orangefs_stats g_orangefs_stats;
Mike Marshallf7ab0932015-07-17 10:38:11 -0400335
336/*
Mike Marshall54804942015-10-05 13:44:24 -0400337 * NOTE: See Documentation/filesystems/porting for information
338 * on implementing FOO_I and properly accessing fs private data
339 */
Yi Liu8bb8aef2015-11-24 15:12:14 -0500340static inline struct orangefs_inode_s *ORANGEFS_I(struct inode *inode)
Mike Marshallf7ab0932015-07-17 10:38:11 -0400341{
Yi Liu8bb8aef2015-11-24 15:12:14 -0500342 return container_of(inode, struct orangefs_inode_s, vfs_inode);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400343}
344
Yi Liu8bb8aef2015-11-24 15:12:14 -0500345static inline struct orangefs_sb_info_s *ORANGEFS_SB(struct super_block *sb)
Mike Marshallf7ab0932015-07-17 10:38:11 -0400346{
Yi Liu8bb8aef2015-11-24 15:12:14 -0500347 return (struct orangefs_sb_info_s *) sb->s_fs_info;
Mike Marshallf7ab0932015-07-17 10:38:11 -0400348}
349
350/* ino_t descends from "unsigned long", 8 bytes, 64 bits. */
Yi Liu8bb8aef2015-11-24 15:12:14 -0500351static inline ino_t orangefs_khandle_to_ino(struct orangefs_khandle *khandle)
Mike Marshallf7ab0932015-07-17 10:38:11 -0400352{
353 union {
354 unsigned char u[8];
355 __u64 ino;
356 } ihandle;
357
358 ihandle.u[0] = khandle->u[0] ^ khandle->u[4];
359 ihandle.u[1] = khandle->u[1] ^ khandle->u[5];
360 ihandle.u[2] = khandle->u[2] ^ khandle->u[6];
361 ihandle.u[3] = khandle->u[3] ^ khandle->u[7];
362 ihandle.u[4] = khandle->u[12] ^ khandle->u[8];
363 ihandle.u[5] = khandle->u[13] ^ khandle->u[9];
364 ihandle.u[6] = khandle->u[14] ^ khandle->u[10];
365 ihandle.u[7] = khandle->u[15] ^ khandle->u[11];
366
367 return ihandle.ino;
368}
369
Yi Liu8bb8aef2015-11-24 15:12:14 -0500370static inline struct orangefs_khandle *get_khandle_from_ino(struct inode *inode)
Mike Marshallf7ab0932015-07-17 10:38:11 -0400371{
Yi Liu8bb8aef2015-11-24 15:12:14 -0500372 return &(ORANGEFS_I(inode)->refn.khandle);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400373}
374
375static inline __s32 get_fsid_from_ino(struct inode *inode)
376{
Yi Liu8bb8aef2015-11-24 15:12:14 -0500377 return ORANGEFS_I(inode)->refn.fs_id;
Mike Marshallf7ab0932015-07-17 10:38:11 -0400378}
379
380static inline ino_t get_ino_from_khandle(struct inode *inode)
381{
Yi Liu8bb8aef2015-11-24 15:12:14 -0500382 struct orangefs_khandle *khandle;
Mike Marshallf7ab0932015-07-17 10:38:11 -0400383 ino_t ino;
384
385 khandle = get_khandle_from_ino(inode);
Yi Liu8bb8aef2015-11-24 15:12:14 -0500386 ino = orangefs_khandle_to_ino(khandle);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400387 return ino;
388}
389
390static inline ino_t get_parent_ino_from_dentry(struct dentry *dentry)
391{
392 return get_ino_from_khandle(dentry->d_parent->d_inode);
393}
394
395static inline int is_root_handle(struct inode *inode)
396{
397 gossip_debug(GOSSIP_DCACHE_DEBUG,
398 "%s: root handle: %pU, this handle: %pU:\n",
399 __func__,
Yi Liu8bb8aef2015-11-24 15:12:14 -0500400 &ORANGEFS_SB(inode->i_sb)->root_khandle,
Mike Marshallf7ab0932015-07-17 10:38:11 -0400401 get_khandle_from_ino(inode));
402
Yi Liu8bb8aef2015-11-24 15:12:14 -0500403 if (ORANGEFS_khandle_cmp(&(ORANGEFS_SB(inode->i_sb)->root_khandle),
Mike Marshallf7ab0932015-07-17 10:38:11 -0400404 get_khandle_from_ino(inode)))
405 return 0;
406 else
407 return 1;
408}
409
Yi Liu8bb8aef2015-11-24 15:12:14 -0500410static inline int match_handle(struct orangefs_khandle resp_handle,
Mike Marshallf7ab0932015-07-17 10:38:11 -0400411 struct inode *inode)
412{
413 gossip_debug(GOSSIP_DCACHE_DEBUG,
414 "%s: one handle: %pU, another handle:%pU:\n",
415 __func__,
416 &resp_handle,
417 get_khandle_from_ino(inode));
418
Yi Liu8bb8aef2015-11-24 15:12:14 -0500419 if (ORANGEFS_khandle_cmp(&resp_handle, get_khandle_from_ino(inode)))
Mike Marshallf7ab0932015-07-17 10:38:11 -0400420 return 0;
421 else
422 return 1;
423}
424
425/*
Yi Liu8bb8aef2015-11-24 15:12:14 -0500426 * defined in orangefs-cache.c
Mike Marshallf7ab0932015-07-17 10:38:11 -0400427 */
428int op_cache_initialize(void);
429int op_cache_finalize(void);
Yi Liu8bb8aef2015-11-24 15:12:14 -0500430struct orangefs_kernel_op_s *op_alloc(__s32 type);
Al Viro78699e22016-02-11 23:07:19 -0500431void orangefs_new_tag(struct orangefs_kernel_op_s *op);
Yi Liu8bb8aef2015-11-24 15:12:14 -0500432char *get_opname_string(struct orangefs_kernel_op_s *new_op);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400433
Yi Liu8bb8aef2015-11-24 15:12:14 -0500434int orangefs_inode_cache_initialize(void);
435int orangefs_inode_cache_finalize(void);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400436
Mike Marshallf7ab0932015-07-17 10:38:11 -0400437/*
Yi Liu8bb8aef2015-11-24 15:12:14 -0500438 * defined in orangefs-mod.c
Mike Marshallf7ab0932015-07-17 10:38:11 -0400439 */
440void purge_inprogress_ops(void);
441
442/*
443 * defined in waitqueue.c
444 */
Mike Marshallf7ab0932015-07-17 10:38:11 -0400445void purge_waiting_ops(void);
446
447/*
448 * defined in super.c
449 */
Yi Liu8bb8aef2015-11-24 15:12:14 -0500450struct dentry *orangefs_mount(struct file_system_type *fst,
Mike Marshallf7ab0932015-07-17 10:38:11 -0400451 int flags,
452 const char *devname,
453 void *data);
454
Yi Liu8bb8aef2015-11-24 15:12:14 -0500455void orangefs_kill_sb(struct super_block *sb);
Al Viro45996492016-03-25 19:56:34 -0400456int orangefs_remount(struct orangefs_sb_info_s *);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400457
458int fsid_key_table_initialize(void);
459void fsid_key_table_finalize(void);
460
461/*
462 * defined in inode.c
463 */
Yi Liu8bb8aef2015-11-24 15:12:14 -0500464__u32 convert_to_orangefs_mask(unsigned long lite_mask);
465struct inode *orangefs_new_inode(struct super_block *sb,
Mike Marshallf7ab0932015-07-17 10:38:11 -0400466 struct inode *dir,
467 int mode,
468 dev_t dev,
Yi Liu8bb8aef2015-11-24 15:12:14 -0500469 struct orangefs_object_kref *ref);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400470
Yi Liu8bb8aef2015-11-24 15:12:14 -0500471int orangefs_setattr(struct dentry *dentry, struct iattr *iattr);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400472
Yi Liu8bb8aef2015-11-24 15:12:14 -0500473int orangefs_getattr(struct vfsmount *mnt,
Mike Marshallf7ab0932015-07-17 10:38:11 -0400474 struct dentry *dentry,
475 struct kstat *kstat);
476
Martin Brandenburg933287d2016-01-30 13:46:54 -0500477int orangefs_permission(struct inode *inode, int mask);
478
Mike Marshallf7ab0932015-07-17 10:38:11 -0400479/*
480 * defined in xattr.c
481 */
Yi Liu8bb8aef2015-11-24 15:12:14 -0500482int orangefs_setxattr(struct dentry *dentry,
Mike Marshallf7ab0932015-07-17 10:38:11 -0400483 const char *name,
484 const void *value,
485 size_t size,
486 int flags);
487
Yi Liu8bb8aef2015-11-24 15:12:14 -0500488ssize_t orangefs_getxattr(struct dentry *dentry,
Mike Marshallf7ab0932015-07-17 10:38:11 -0400489 const char *name,
490 void *buffer,
491 size_t size);
492
Yi Liu8bb8aef2015-11-24 15:12:14 -0500493ssize_t orangefs_listxattr(struct dentry *dentry, char *buffer, size_t size);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400494
495/*
496 * defined in namei.c
497 */
Yi Liu8bb8aef2015-11-24 15:12:14 -0500498struct inode *orangefs_iget(struct super_block *sb,
499 struct orangefs_object_kref *ref);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400500
Yi Liu8bb8aef2015-11-24 15:12:14 -0500501ssize_t orangefs_inode_read(struct inode *inode,
502 struct iov_iter *iter,
503 loff_t *offset,
504 loff_t readahead_size);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400505
506/*
Yi Liu8bb8aef2015-11-24 15:12:14 -0500507 * defined in devorangefs-req.c
Mike Marshallf7ab0932015-07-17 10:38:11 -0400508 */
Yi Liu8bb8aef2015-11-24 15:12:14 -0500509int orangefs_dev_init(void);
510void orangefs_dev_cleanup(void);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400511int is_daemon_in_service(void);
Al Viro78699e22016-02-11 23:07:19 -0500512bool __is_daemon_in_service(void);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400513
514/*
Yi Liu8bb8aef2015-11-24 15:12:14 -0500515 * defined in orangefs-utils.c
Mike Marshallf7ab0932015-07-17 10:38:11 -0400516 */
Yi Liu8bb8aef2015-11-24 15:12:14 -0500517__s32 fsid_of_op(struct orangefs_kernel_op_s *op);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400518
Yi Liu8bb8aef2015-11-24 15:12:14 -0500519int orangefs_flush_inode(struct inode *inode);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400520
Yi Liu8bb8aef2015-11-24 15:12:14 -0500521ssize_t orangefs_inode_getxattr(struct inode *inode,
Mike Marshallf7ab0932015-07-17 10:38:11 -0400522 const char *name,
523 void *buffer,
524 size_t size);
525
Yi Liu8bb8aef2015-11-24 15:12:14 -0500526int orangefs_inode_setxattr(struct inode *inode,
Mike Marshallf7ab0932015-07-17 10:38:11 -0400527 const char *name,
528 const void *value,
529 size_t size,
530 int flags);
531
Martin Brandenburg71680c12016-06-09 16:32:38 -0400532int orangefs_inode_getattr(struct inode *inode, int new, int bypass);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400533
Martin Brandenburg5859d772016-03-17 15:15:16 -0400534int orangefs_inode_check_changed(struct inode *inode);
535
Yi Liu8bb8aef2015-11-24 15:12:14 -0500536int orangefs_inode_setattr(struct inode *inode, struct iattr *iattr);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400537
Yi Liu8bb8aef2015-11-24 15:12:14 -0500538void orangefs_make_bad_inode(struct inode *inode);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400539
Yi Liu8bb8aef2015-11-24 15:12:14 -0500540int orangefs_unmount_sb(struct super_block *sb);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400541
Al Viro78699e22016-02-11 23:07:19 -0500542bool orangefs_cancel_op_in_progress(struct orangefs_kernel_op_s *op);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400543
Yi Liu8bb8aef2015-11-24 15:12:14 -0500544int orangefs_normalize_to_errno(__s32 error_code);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400545
546extern struct mutex devreq_mutex;
547extern struct mutex request_mutex;
548extern int debug;
549extern int op_timeout_secs;
550extern int slot_timeout_secs;
Martin Brandenburg4cd8f312016-07-25 13:58:24 -0400551extern int dcache_timeout_msecs;
552extern int getattr_timeout_msecs;
Yi Liu8bb8aef2015-11-24 15:12:14 -0500553extern struct list_head orangefs_superblocks;
554extern spinlock_t orangefs_superblocks_lock;
555extern struct list_head orangefs_request_list;
556extern spinlock_t orangefs_request_list_lock;
557extern wait_queue_head_t orangefs_request_list_waitq;
Mike Marshallf7ab0932015-07-17 10:38:11 -0400558extern struct list_head *htable_ops_in_progress;
559extern spinlock_t htable_ops_in_progress_lock;
560extern int hash_table_size;
561
Yi Liu8bb8aef2015-11-24 15:12:14 -0500562extern const struct address_space_operations orangefs_address_operations;
563extern struct backing_dev_info orangefs_backing_dev_info;
Al Viro6f3fc102016-05-14 18:46:32 -0400564extern const struct inode_operations orangefs_file_inode_operations;
Yi Liu8bb8aef2015-11-24 15:12:14 -0500565extern const struct file_operations orangefs_file_operations;
Al Viro6f3fc102016-05-14 18:46:32 -0400566extern const struct inode_operations orangefs_symlink_inode_operations;
567extern const struct inode_operations orangefs_dir_inode_operations;
Yi Liu8bb8aef2015-11-24 15:12:14 -0500568extern const struct file_operations orangefs_dir_operations;
569extern const struct dentry_operations orangefs_dentry_operations;
570extern const struct file_operations orangefs_devreq_file_operations;
Mike Marshallf7ab0932015-07-17 10:38:11 -0400571
Yi Liu8bb8aef2015-11-24 15:12:14 -0500572extern wait_queue_head_t orangefs_bufmap_init_waitq;
Mike Marshallf7ab0932015-07-17 10:38:11 -0400573
574/*
575 * misc convenience macros
576 */
Mike Marshallf7ab0932015-07-17 10:38:11 -0400577
Yi Liu8bb8aef2015-11-24 15:12:14 -0500578#define ORANGEFS_OP_INTERRUPTIBLE 1 /* service_operation() is interruptible */
579#define ORANGEFS_OP_PRIORITY 2 /* service_operation() is high priority */
580#define ORANGEFS_OP_CANCELLATION 4 /* this is a cancellation */
Mike Marshalladcf34a2016-02-24 16:54:27 -0500581#define ORANGEFS_OP_NO_MUTEX 8 /* don't acquire request_mutex */
Yi Liu8bb8aef2015-11-24 15:12:14 -0500582#define ORANGEFS_OP_ASYNC 16 /* Queue it, but don't wait */
Mike Marshallf7ab0932015-07-17 10:38:11 -0400583
Yi Liu8bb8aef2015-11-24 15:12:14 -0500584int service_operation(struct orangefs_kernel_op_s *op,
Mike Marshallf7ab0932015-07-17 10:38:11 -0400585 const char *op_name,
586 int flags);
587
Mike Marshallf7ab0932015-07-17 10:38:11 -0400588#define get_interruptible_flag(inode) \
Yi Liu8bb8aef2015-11-24 15:12:14 -0500589 ((ORANGEFS_SB(inode->i_sb)->flags & ORANGEFS_OPT_INTR) ? \
590 ORANGEFS_OP_INTERRUPTIBLE : 0)
Mike Marshallf7ab0932015-07-17 10:38:11 -0400591
Mike Marshallf7ab0932015-07-17 10:38:11 -0400592#define fill_default_sys_attrs(sys_attr, type, mode) \
593do { \
Jann Horn78fee0b2016-06-25 01:51:52 +0200594 sys_attr.owner = from_kuid(&init_user_ns, current_fsuid()); \
595 sys_attr.group = from_kgid(&init_user_ns, current_fsgid()); \
Yi Liu8bb8aef2015-11-24 15:12:14 -0500596 sys_attr.perms = ORANGEFS_util_translate_mode(mode); \
Martin Brandenburg69a23de2016-02-20 15:28:58 -0500597 sys_attr.mtime = 0; \
598 sys_attr.atime = 0; \
599 sys_attr.ctime = 0; \
Yi Liu8bb8aef2015-11-24 15:12:14 -0500600 sys_attr.mask = ORANGEFS_ATTR_SYS_ALL_SETABLE; \
Mike Marshallf7ab0932015-07-17 10:38:11 -0400601} while (0)
602
Yi Liu8bb8aef2015-11-24 15:12:14 -0500603static inline void orangefs_i_size_write(struct inode *inode, loff_t i_size)
Mike Marshallf7ab0932015-07-17 10:38:11 -0400604{
605#if BITS_PER_LONG == 32 && defined(CONFIG_SMP)
Al Viro5ecfcb22016-04-12 00:43:20 -0400606 inode_lock(inode);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400607#endif
608 i_size_write(inode, i_size);
609#if BITS_PER_LONG == 32 && defined(CONFIG_SMP)
Al Viro5ecfcb22016-04-12 00:43:20 -0400610 inode_unlock(inode);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400611#endif
612}
613
Yi Liu8bb8aef2015-11-24 15:12:14 -0500614#endif /* __ORANGEFSKERNEL_H */