blob: 7d0c8b3afc7ea8d35626455b7f8fcd974c4ec3af [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
73#define ORANGEFS_SEEK_END 0x00000002
74#define ORANGEFS_MAX_NUM_OPTIONS 0x00000004
75#define ORANGEFS_MAX_MOUNT_OPT_LEN 0x00000080
76#define ORANGEFS_MAX_FSKEY_LEN 64
Mike Marshallf7ab0932015-07-17 10:38:11 -040077
Mike Marshallcf0c2772016-01-19 12:04:40 -050078#define MAX_DEV_REQ_UPSIZE (2 * sizeof(__s32) + \
Yi Liu8bb8aef2015-11-24 15:12:14 -050079sizeof(__u64) + sizeof(struct orangefs_upcall_s))
Mike Marshallcf0c2772016-01-19 12:04:40 -050080#define MAX_DEV_REQ_DOWNSIZE (2 * sizeof(__s32) + \
Yi Liu8bb8aef2015-11-24 15:12:14 -050081sizeof(__u64) + sizeof(struct orangefs_downcall_s))
Mike Marshallf7ab0932015-07-17 10:38:11 -040082
Mike Marshallf7ab0932015-07-17 10:38:11 -040083/*
Yi Liu8bb8aef2015-11-24 15:12:14 -050084 * valid orangefs kernel operation states
Mike Marshallf7ab0932015-07-17 10:38:11 -040085 *
86 * unknown - op was just initialized
87 * waiting - op is on request_list (upward bound)
88 * inprogr - op is in progress (waiting for downcall)
89 * serviced - op has matching downcall; ok
90 * purged - op has to start a timer since client-core
91 * exited uncleanly before servicing op
Al Viroed42fe02016-01-22 19:47:47 -050092 * given up - submitter has given up waiting for it
Mike Marshallf7ab0932015-07-17 10:38:11 -040093 */
Yi Liu8bb8aef2015-11-24 15:12:14 -050094enum orangefs_vfs_op_states {
Mike Marshallf7ab0932015-07-17 10:38:11 -040095 OP_VFS_STATE_UNKNOWN = 0,
96 OP_VFS_STATE_WAITING = 1,
97 OP_VFS_STATE_INPROGR = 2,
98 OP_VFS_STATE_SERVICED = 4,
99 OP_VFS_STATE_PURGED = 8,
Al Viroed42fe02016-01-22 19:47:47 -0500100 OP_VFS_STATE_GIVEN_UP = 16,
Mike Marshallf7ab0932015-07-17 10:38:11 -0400101};
102
Mike Marshallf7ab0932015-07-17 10:38:11 -0400103/*
104 * Defines for controlling whether I/O upcalls are for async or sync operations
105 */
Yi Liu8bb8aef2015-11-24 15:12:14 -0500106enum ORANGEFS_async_io_type {
107 ORANGEFS_VFS_SYNC_IO = 0,
108 ORANGEFS_VFS_ASYNC_IO = 1,
Mike Marshallf7ab0932015-07-17 10:38:11 -0400109};
110
111/*
112 * An array of client_debug_mask will be built to hold debug keyword/mask
113 * values fetched from userspace.
114 */
115struct client_debug_mask {
116 char *keyword;
117 __u64 mask1;
118 __u64 mask2;
119};
120
121/*
Yi Liu8bb8aef2015-11-24 15:12:14 -0500122 * orangefs kernel memory related flags
Mike Marshallf7ab0932015-07-17 10:38:11 -0400123 */
124
Yi Liu8bb8aef2015-11-24 15:12:14 -0500125#if ((defined ORANGEFS_KERNEL_DEBUG) && (defined CONFIG_DEBUG_SLAB))
126#define ORANGEFS_CACHE_CREATE_FLAGS SLAB_RED_ZONE
Mike Marshallf7ab0932015-07-17 10:38:11 -0400127#else
Yi Liu8bb8aef2015-11-24 15:12:14 -0500128#define ORANGEFS_CACHE_CREATE_FLAGS 0
129#endif /* ((defined ORANGEFS_KERNEL_DEBUG) && (defined CONFIG_DEBUG_SLAB)) */
Mike Marshallf7ab0932015-07-17 10:38:11 -0400130
Yi Liu8bb8aef2015-11-24 15:12:14 -0500131#define ORANGEFS_GFP_FLAGS (GFP_KERNEL)
132#define ORANGEFS_BUFMAP_GFP_FLAGS (GFP_KERNEL)
Mike Marshallf7ab0932015-07-17 10:38:11 -0400133
Yi Liu8bb8aef2015-11-24 15:12:14 -0500134/* orangefs xattr and acl related defines */
135#define ORANGEFS_XATTR_INDEX_POSIX_ACL_ACCESS 1
136#define ORANGEFS_XATTR_INDEX_POSIX_ACL_DEFAULT 2
137#define ORANGEFS_XATTR_INDEX_TRUSTED 3
138#define ORANGEFS_XATTR_INDEX_DEFAULT 4
Mike Marshallf7ab0932015-07-17 10:38:11 -0400139
Mike Marshallfef8b672015-12-17 14:31:24 -0500140#define ORANGEFS_XATTR_NAME_ACL_ACCESS XATTR_NAME_POSIX_ACL_ACCESS
141#define ORANGEFS_XATTR_NAME_ACL_DEFAULT XATTR_NAME_POSIX_ACL_DEFAULT
Yi Liu8bb8aef2015-11-24 15:12:14 -0500142#define ORANGEFS_XATTR_NAME_TRUSTED_PREFIX "trusted."
143#define ORANGEFS_XATTR_NAME_DEFAULT_PREFIX ""
Mike Marshallf7ab0932015-07-17 10:38:11 -0400144
Yi Liu8bb8aef2015-11-24 15:12:14 -0500145/* these functions are defined in orangefs-utils.c */
Mike Marshallf7ab0932015-07-17 10:38:11 -0400146int orangefs_prepare_cdm_array(char *debug_array_string);
147int orangefs_prepare_debugfs_help_string(int);
148
Yi Liu8bb8aef2015-11-24 15:12:14 -0500149/* defined in orangefs-debugfs.c */
150int orangefs_client_debug_init(void);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400151
152void debug_string_to_mask(char *, void *, int);
153void do_c_mask(int, char *, struct client_debug_mask **);
154void do_k_mask(int, char *, __u64 **);
155
156void debug_mask_to_string(void *, int);
157void do_k_string(void *, int);
158void do_c_string(void *, int);
159int check_amalgam_keyword(void *, int);
160int keyword_is_amalgam(char *);
161
Yi Liu8bb8aef2015-11-24 15:12:14 -0500162/*these variables are defined in orangefs-mod.c */
163extern char kernel_debug_string[ORANGEFS_MAX_DEBUG_STRING_LEN];
164extern char client_debug_string[ORANGEFS_MAX_DEBUG_STRING_LEN];
165extern char client_debug_array_string[ORANGEFS_MAX_DEBUG_STRING_LEN];
Mike Marshallf7ab0932015-07-17 10:38:11 -0400166extern unsigned int kernel_mask_set_mod_init;
167
Yi Liu8bb8aef2015-11-24 15:12:14 -0500168extern int orangefs_init_acl(struct inode *inode, struct inode *dir);
169extern const struct xattr_handler *orangefs_xattr_handlers[];
Mike Marshallf7ab0932015-07-17 10:38:11 -0400170
Yi Liu8bb8aef2015-11-24 15:12:14 -0500171extern struct posix_acl *orangefs_get_acl(struct inode *inode, int type);
172extern int orangefs_set_acl(struct inode *inode, struct posix_acl *acl, int type);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400173
Mike Marshallf7ab0932015-07-17 10:38:11 -0400174/*
175 * Redefine xtvec structure so that we could move helper functions out of
176 * the define
177 */
178struct xtvec {
179 __kernel_off_t xtv_off; /* must be off_t */
180 __kernel_size_t xtv_len; /* must be size_t */
181};
182
183/*
Yi Liu8bb8aef2015-11-24 15:12:14 -0500184 * orangefs data structures
Mike Marshallf7ab0932015-07-17 10:38:11 -0400185 */
Yi Liu8bb8aef2015-11-24 15:12:14 -0500186struct orangefs_kernel_op_s {
187 enum orangefs_vfs_op_states op_state;
Mike Marshallf7ab0932015-07-17 10:38:11 -0400188 __u64 tag;
189
190 /*
191 * Set uses_shared_memory to 1 if this operation uses shared memory.
192 * If true, then a retry on the op must also get a new shared memory
Al Viro78699e22016-02-11 23:07:19 -0500193 * buffer and re-populate it. Cancels don't care - it only matters
194 * for service_operation() retry logics and cancels don't go through
195 * it anymore.
Mike Marshallf7ab0932015-07-17 10:38:11 -0400196 */
Al Viro78699e22016-02-11 23:07:19 -0500197 union {
198 int uses_shared_memory;
199 int slot_to_free;
200 };
Mike Marshallf7ab0932015-07-17 10:38:11 -0400201
Yi Liu8bb8aef2015-11-24 15:12:14 -0500202 struct orangefs_upcall_s upcall;
203 struct orangefs_downcall_s downcall;
Mike Marshallf7ab0932015-07-17 10:38:11 -0400204
Al Virod2d87a32016-02-13 10:15:22 -0500205 struct completion waitq;
Mike Marshallf7ab0932015-07-17 10:38:11 -0400206 spinlock_t lock;
207
Mike Marshallc817e262016-01-13 11:29:05 -0500208 atomic_t ref_count;
209
Mike Marshallf7ab0932015-07-17 10:38:11 -0400210 /* VFS aio fields */
211
Mike Marshallf7ab0932015-07-17 10:38:11 -0400212 int attempts;
213
214 struct list_head list;
215};
216
Al Viro60831942016-01-21 23:17:37 -0500217#define set_op_state_waiting(op) ((op)->op_state = OP_VFS_STATE_WAITING)
218#define set_op_state_inprogress(op) ((op)->op_state = OP_VFS_STATE_INPROGR)
Mike Marshall2d4cae02016-02-04 13:48:16 -0500219#define set_op_state_given_up(op) ((op)->op_state = OP_VFS_STATE_GIVEN_UP)
Al Viro60831942016-01-21 23:17:37 -0500220static inline void set_op_state_serviced(struct orangefs_kernel_op_s *op)
221{
222 op->op_state = OP_VFS_STATE_SERVICED;
Al Virod2d87a32016-02-13 10:15:22 -0500223 complete(&op->waitq);
Al Viro60831942016-01-21 23:17:37 -0500224}
Al Viro60831942016-01-21 23:17:37 -0500225
226#define op_state_waiting(op) ((op)->op_state & OP_VFS_STATE_WAITING)
227#define op_state_in_progress(op) ((op)->op_state & OP_VFS_STATE_INPROGR)
228#define op_state_serviced(op) ((op)->op_state & OP_VFS_STATE_SERVICED)
229#define op_state_purged(op) ((op)->op_state & OP_VFS_STATE_PURGED)
Al Viroed42fe02016-01-22 19:47:47 -0500230#define op_state_given_up(op) ((op)->op_state & OP_VFS_STATE_GIVEN_UP)
Al Viro78699e22016-02-11 23:07:19 -0500231#define op_is_cancel(op) ((op)->upcall.type == ORANGEFS_VFS_OP_CANCEL)
Al Viroed42fe02016-01-22 19:47:47 -0500232
233static inline void get_op(struct orangefs_kernel_op_s *op)
234{
235 atomic_inc(&op->ref_count);
236 gossip_debug(GOSSIP_DEV_DEBUG,
237 "(get) Alloced OP (%p:%llu)\n", op, llu(op->tag));
238}
239
240void __op_release(struct orangefs_kernel_op_s *op);
241
242static inline void op_release(struct orangefs_kernel_op_s *op)
243{
244 if (atomic_dec_and_test(&op->ref_count)) {
245 gossip_debug(GOSSIP_DEV_DEBUG,
246 "(put) Releasing OP (%p:%llu)\n", op, llu((op)->tag));
247 __op_release(op);
248 }
249}
Al Viro60831942016-01-21 23:17:37 -0500250
Al Viro78699e22016-02-11 23:07:19 -0500251extern void orangefs_bufmap_put(int);
252static inline void put_cancel(struct orangefs_kernel_op_s *op)
253{
254 orangefs_bufmap_put(op->slot_to_free);
255 op_release(op);
256}
257
258static inline void set_op_state_purged(struct orangefs_kernel_op_s *op)
259{
260 spin_lock(&op->lock);
261 if (unlikely(op_is_cancel(op))) {
Al Viro05a50a52016-02-18 18:59:44 -0500262 list_del_init(&op->list);
Al Viro78699e22016-02-11 23:07:19 -0500263 spin_unlock(&op->lock);
264 put_cancel(op);
265 } else {
266 op->op_state |= OP_VFS_STATE_PURGED;
Al Virod2d87a32016-02-13 10:15:22 -0500267 complete(&op->waitq);
Al Viro78699e22016-02-11 23:07:19 -0500268 spin_unlock(&op->lock);
269 }
270}
271
Yi Liu8bb8aef2015-11-24 15:12:14 -0500272/* per inode private orangefs info */
273struct orangefs_inode_s {
274 struct orangefs_object_kref refn;
275 char link_target[ORANGEFS_NAME_MAX];
Mike Marshallf7ab0932015-07-17 10:38:11 -0400276 __s64 blksize;
277 /*
278 * Reading/Writing Extended attributes need to acquire the appropriate
Yi Liu8bb8aef2015-11-24 15:12:14 -0500279 * reader/writer semaphore on the orangefs_inode_s structure.
Mike Marshallf7ab0932015-07-17 10:38:11 -0400280 */
281 struct rw_semaphore xattr_sem;
282
283 struct inode vfs_inode;
284 sector_t last_failed_block_index_read;
285
286 /*
287 * State of in-memory attributes not yet flushed to disk associated
288 * with this object
289 */
290 unsigned long pinode_flags;
Mike Marshallf7ab0932015-07-17 10:38:11 -0400291};
292
293#define P_ATIME_FLAG 0
294#define P_MTIME_FLAG 1
295#define P_CTIME_FLAG 2
296#define P_MODE_FLAG 3
297
298#define ClearAtimeFlag(pinode) clear_bit(P_ATIME_FLAG, &(pinode)->pinode_flags)
299#define SetAtimeFlag(pinode) set_bit(P_ATIME_FLAG, &(pinode)->pinode_flags)
300#define AtimeFlag(pinode) test_bit(P_ATIME_FLAG, &(pinode)->pinode_flags)
301
302#define ClearMtimeFlag(pinode) clear_bit(P_MTIME_FLAG, &(pinode)->pinode_flags)
303#define SetMtimeFlag(pinode) set_bit(P_MTIME_FLAG, &(pinode)->pinode_flags)
304#define MtimeFlag(pinode) test_bit(P_MTIME_FLAG, &(pinode)->pinode_flags)
305
306#define ClearCtimeFlag(pinode) clear_bit(P_CTIME_FLAG, &(pinode)->pinode_flags)
307#define SetCtimeFlag(pinode) set_bit(P_CTIME_FLAG, &(pinode)->pinode_flags)
308#define CtimeFlag(pinode) test_bit(P_CTIME_FLAG, &(pinode)->pinode_flags)
309
310#define ClearModeFlag(pinode) clear_bit(P_MODE_FLAG, &(pinode)->pinode_flags)
311#define SetModeFlag(pinode) set_bit(P_MODE_FLAG, &(pinode)->pinode_flags)
312#define ModeFlag(pinode) test_bit(P_MODE_FLAG, &(pinode)->pinode_flags)
313
Yi Liu8bb8aef2015-11-24 15:12:14 -0500314/* per superblock private orangefs info */
315struct orangefs_sb_info_s {
316 struct orangefs_khandle root_khandle;
Mike Marshallf7ab0932015-07-17 10:38:11 -0400317 __s32 fs_id;
318 int id;
319 int flags;
Yi Liu8bb8aef2015-11-24 15:12:14 -0500320#define ORANGEFS_OPT_INTR 0x01
321#define ORANGEFS_OPT_LOCAL_LOCK 0x02
322 char devname[ORANGEFS_MAX_SERVER_ADDR_LEN];
Mike Marshallf7ab0932015-07-17 10:38:11 -0400323 struct super_block *sb;
324 int mount_pending;
325 struct list_head list;
326};
327
328/*
Mike Marshallf7ab0932015-07-17 10:38:11 -0400329 * structure that holds the state of any async I/O operation issued
330 * through the VFS. Needed especially to handle cancellation requests
331 * or even completion notification so that the VFS client-side daemon
332 * can free up its vfs_request slots.
333 */
Yi Liu8bb8aef2015-11-24 15:12:14 -0500334struct orangefs_kiocb_s {
Mike Marshallf7ab0932015-07-17 10:38:11 -0400335 /* the pointer to the task that initiated the AIO */
336 struct task_struct *tsk;
337
338 /* pointer to the kiocb that kicked this operation */
339 struct kiocb *kiocb;
340
341 /* buffer index that was used for the I/O */
Yi Liu8bb8aef2015-11-24 15:12:14 -0500342 struct orangefs_bufmap *bufmap;
Mike Marshallf7ab0932015-07-17 10:38:11 -0400343 int buffer_index;
344
Yi Liu8bb8aef2015-11-24 15:12:14 -0500345 /* orangefs kernel operation type */
346 struct orangefs_kernel_op_s *op;
Mike Marshallf7ab0932015-07-17 10:38:11 -0400347
348 /* The user space buffers from/to which I/O is being staged */
349 struct iovec *iov;
350
351 /* number of elements in the iovector */
352 unsigned long nr_segs;
353
354 /* set to indicate the type of the operation */
355 int rw;
356
357 /* file offset */
358 loff_t offset;
359
360 /* and the count in bytes */
361 size_t bytes_to_be_copied;
362
363 ssize_t bytes_copied;
364 int needs_cleanup;
365};
366
Yi Liu8bb8aef2015-11-24 15:12:14 -0500367struct orangefs_stats {
Mike Marshallf7ab0932015-07-17 10:38:11 -0400368 unsigned long cache_hits;
369 unsigned long cache_misses;
370 unsigned long reads;
371 unsigned long writes;
372};
373
Yi Liu8bb8aef2015-11-24 15:12:14 -0500374extern struct orangefs_stats g_orangefs_stats;
Mike Marshallf7ab0932015-07-17 10:38:11 -0400375
376/*
Mike Marshall54804942015-10-05 13:44:24 -0400377 * NOTE: See Documentation/filesystems/porting for information
378 * on implementing FOO_I and properly accessing fs private data
379 */
Yi Liu8bb8aef2015-11-24 15:12:14 -0500380static inline struct orangefs_inode_s *ORANGEFS_I(struct inode *inode)
Mike Marshallf7ab0932015-07-17 10:38:11 -0400381{
Yi Liu8bb8aef2015-11-24 15:12:14 -0500382 return container_of(inode, struct orangefs_inode_s, vfs_inode);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400383}
384
Yi Liu8bb8aef2015-11-24 15:12:14 -0500385static inline struct orangefs_sb_info_s *ORANGEFS_SB(struct super_block *sb)
Mike Marshallf7ab0932015-07-17 10:38:11 -0400386{
Yi Liu8bb8aef2015-11-24 15:12:14 -0500387 return (struct orangefs_sb_info_s *) sb->s_fs_info;
Mike Marshallf7ab0932015-07-17 10:38:11 -0400388}
389
390/* ino_t descends from "unsigned long", 8 bytes, 64 bits. */
Yi Liu8bb8aef2015-11-24 15:12:14 -0500391static inline ino_t orangefs_khandle_to_ino(struct orangefs_khandle *khandle)
Mike Marshallf7ab0932015-07-17 10:38:11 -0400392{
393 union {
394 unsigned char u[8];
395 __u64 ino;
396 } ihandle;
397
398 ihandle.u[0] = khandle->u[0] ^ khandle->u[4];
399 ihandle.u[1] = khandle->u[1] ^ khandle->u[5];
400 ihandle.u[2] = khandle->u[2] ^ khandle->u[6];
401 ihandle.u[3] = khandle->u[3] ^ khandle->u[7];
402 ihandle.u[4] = khandle->u[12] ^ khandle->u[8];
403 ihandle.u[5] = khandle->u[13] ^ khandle->u[9];
404 ihandle.u[6] = khandle->u[14] ^ khandle->u[10];
405 ihandle.u[7] = khandle->u[15] ^ khandle->u[11];
406
407 return ihandle.ino;
408}
409
Yi Liu8bb8aef2015-11-24 15:12:14 -0500410static inline struct orangefs_khandle *get_khandle_from_ino(struct inode *inode)
Mike Marshallf7ab0932015-07-17 10:38:11 -0400411{
Yi Liu8bb8aef2015-11-24 15:12:14 -0500412 return &(ORANGEFS_I(inode)->refn.khandle);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400413}
414
415static inline __s32 get_fsid_from_ino(struct inode *inode)
416{
Yi Liu8bb8aef2015-11-24 15:12:14 -0500417 return ORANGEFS_I(inode)->refn.fs_id;
Mike Marshallf7ab0932015-07-17 10:38:11 -0400418}
419
420static inline ino_t get_ino_from_khandle(struct inode *inode)
421{
Yi Liu8bb8aef2015-11-24 15:12:14 -0500422 struct orangefs_khandle *khandle;
Mike Marshallf7ab0932015-07-17 10:38:11 -0400423 ino_t ino;
424
425 khandle = get_khandle_from_ino(inode);
Yi Liu8bb8aef2015-11-24 15:12:14 -0500426 ino = orangefs_khandle_to_ino(khandle);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400427 return ino;
428}
429
430static inline ino_t get_parent_ino_from_dentry(struct dentry *dentry)
431{
432 return get_ino_from_khandle(dentry->d_parent->d_inode);
433}
434
435static inline int is_root_handle(struct inode *inode)
436{
437 gossip_debug(GOSSIP_DCACHE_DEBUG,
438 "%s: root handle: %pU, this handle: %pU:\n",
439 __func__,
Yi Liu8bb8aef2015-11-24 15:12:14 -0500440 &ORANGEFS_SB(inode->i_sb)->root_khandle,
Mike Marshallf7ab0932015-07-17 10:38:11 -0400441 get_khandle_from_ino(inode));
442
Yi Liu8bb8aef2015-11-24 15:12:14 -0500443 if (ORANGEFS_khandle_cmp(&(ORANGEFS_SB(inode->i_sb)->root_khandle),
Mike Marshallf7ab0932015-07-17 10:38:11 -0400444 get_khandle_from_ino(inode)))
445 return 0;
446 else
447 return 1;
448}
449
Yi Liu8bb8aef2015-11-24 15:12:14 -0500450static inline int match_handle(struct orangefs_khandle resp_handle,
Mike Marshallf7ab0932015-07-17 10:38:11 -0400451 struct inode *inode)
452{
453 gossip_debug(GOSSIP_DCACHE_DEBUG,
454 "%s: one handle: %pU, another handle:%pU:\n",
455 __func__,
456 &resp_handle,
457 get_khandle_from_ino(inode));
458
Yi Liu8bb8aef2015-11-24 15:12:14 -0500459 if (ORANGEFS_khandle_cmp(&resp_handle, get_khandle_from_ino(inode)))
Mike Marshallf7ab0932015-07-17 10:38:11 -0400460 return 0;
461 else
462 return 1;
463}
464
465/*
Yi Liu8bb8aef2015-11-24 15:12:14 -0500466 * defined in orangefs-cache.c
Mike Marshallf7ab0932015-07-17 10:38:11 -0400467 */
468int op_cache_initialize(void);
469int op_cache_finalize(void);
Yi Liu8bb8aef2015-11-24 15:12:14 -0500470struct orangefs_kernel_op_s *op_alloc(__s32 type);
Al Viro78699e22016-02-11 23:07:19 -0500471void orangefs_new_tag(struct orangefs_kernel_op_s *op);
Yi Liu8bb8aef2015-11-24 15:12:14 -0500472char *get_opname_string(struct orangefs_kernel_op_s *new_op);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400473
Yi Liu8bb8aef2015-11-24 15:12:14 -0500474int orangefs_inode_cache_initialize(void);
475int orangefs_inode_cache_finalize(void);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400476
Mike Marshallf7ab0932015-07-17 10:38:11 -0400477/*
Yi Liu8bb8aef2015-11-24 15:12:14 -0500478 * defined in orangefs-mod.c
Mike Marshallf7ab0932015-07-17 10:38:11 -0400479 */
480void purge_inprogress_ops(void);
481
482/*
483 * defined in waitqueue.c
484 */
Mike Marshallf7ab0932015-07-17 10:38:11 -0400485void purge_waiting_ops(void);
486
487/*
488 * defined in super.c
489 */
Yi Liu8bb8aef2015-11-24 15:12:14 -0500490struct dentry *orangefs_mount(struct file_system_type *fst,
Mike Marshallf7ab0932015-07-17 10:38:11 -0400491 int flags,
492 const char *devname,
493 void *data);
494
Yi Liu8bb8aef2015-11-24 15:12:14 -0500495void orangefs_kill_sb(struct super_block *sb);
496int orangefs_remount(struct super_block *sb);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400497
498int fsid_key_table_initialize(void);
499void fsid_key_table_finalize(void);
500
501/*
502 * defined in inode.c
503 */
Yi Liu8bb8aef2015-11-24 15:12:14 -0500504__u32 convert_to_orangefs_mask(unsigned long lite_mask);
505struct inode *orangefs_new_inode(struct super_block *sb,
Mike Marshallf7ab0932015-07-17 10:38:11 -0400506 struct inode *dir,
507 int mode,
508 dev_t dev,
Yi Liu8bb8aef2015-11-24 15:12:14 -0500509 struct orangefs_object_kref *ref);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400510
Yi Liu8bb8aef2015-11-24 15:12:14 -0500511int orangefs_setattr(struct dentry *dentry, struct iattr *iattr);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400512
Yi Liu8bb8aef2015-11-24 15:12:14 -0500513int orangefs_getattr(struct vfsmount *mnt,
Mike Marshallf7ab0932015-07-17 10:38:11 -0400514 struct dentry *dentry,
515 struct kstat *kstat);
516
Martin Brandenburg933287d2016-01-30 13:46:54 -0500517int orangefs_permission(struct inode *inode, int mask);
518
Mike Marshallf7ab0932015-07-17 10:38:11 -0400519/*
520 * defined in xattr.c
521 */
Yi Liu8bb8aef2015-11-24 15:12:14 -0500522int orangefs_setxattr(struct dentry *dentry,
Mike Marshallf7ab0932015-07-17 10:38:11 -0400523 const char *name,
524 const void *value,
525 size_t size,
526 int flags);
527
Yi Liu8bb8aef2015-11-24 15:12:14 -0500528ssize_t orangefs_getxattr(struct dentry *dentry,
Mike Marshallf7ab0932015-07-17 10:38:11 -0400529 const char *name,
530 void *buffer,
531 size_t size);
532
Yi Liu8bb8aef2015-11-24 15:12:14 -0500533ssize_t orangefs_listxattr(struct dentry *dentry, char *buffer, size_t size);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400534
535/*
536 * defined in namei.c
537 */
Yi Liu8bb8aef2015-11-24 15:12:14 -0500538struct inode *orangefs_iget(struct super_block *sb,
539 struct orangefs_object_kref *ref);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400540
Yi Liu8bb8aef2015-11-24 15:12:14 -0500541ssize_t orangefs_inode_read(struct inode *inode,
542 struct iov_iter *iter,
543 loff_t *offset,
544 loff_t readahead_size);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400545
546/*
Yi Liu8bb8aef2015-11-24 15:12:14 -0500547 * defined in devorangefs-req.c
Mike Marshallf7ab0932015-07-17 10:38:11 -0400548 */
Yi Liu8bb8aef2015-11-24 15:12:14 -0500549int orangefs_dev_init(void);
550void orangefs_dev_cleanup(void);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400551int is_daemon_in_service(void);
Al Viro78699e22016-02-11 23:07:19 -0500552bool __is_daemon_in_service(void);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400553int fs_mount_pending(__s32 fsid);
554
555/*
Yi Liu8bb8aef2015-11-24 15:12:14 -0500556 * defined in orangefs-utils.c
Mike Marshallf7ab0932015-07-17 10:38:11 -0400557 */
Yi Liu8bb8aef2015-11-24 15:12:14 -0500558__s32 fsid_of_op(struct orangefs_kernel_op_s *op);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400559
Yi Liu8bb8aef2015-11-24 15:12:14 -0500560int orangefs_flush_inode(struct inode *inode);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400561
Yi Liu8bb8aef2015-11-24 15:12:14 -0500562ssize_t orangefs_inode_getxattr(struct inode *inode,
Mike Marshallf7ab0932015-07-17 10:38:11 -0400563 const char *prefix,
564 const char *name,
565 void *buffer,
566 size_t size);
567
Yi Liu8bb8aef2015-11-24 15:12:14 -0500568int orangefs_inode_setxattr(struct inode *inode,
Mike Marshallf7ab0932015-07-17 10:38:11 -0400569 const char *prefix,
570 const char *name,
571 const void *value,
572 size_t size,
573 int flags);
574
Martin Brandenburg99109822016-01-28 10:19:40 -0500575int orangefs_inode_getattr(struct inode *inode, __u32 mask, int check);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400576
Yi Liu8bb8aef2015-11-24 15:12:14 -0500577int orangefs_inode_setattr(struct inode *inode, struct iattr *iattr);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400578
Yi Liu8bb8aef2015-11-24 15:12:14 -0500579void orangefs_make_bad_inode(struct inode *inode);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400580
Yi Liu8bb8aef2015-11-24 15:12:14 -0500581int orangefs_unmount_sb(struct super_block *sb);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400582
Al Viro78699e22016-02-11 23:07:19 -0500583bool orangefs_cancel_op_in_progress(struct orangefs_kernel_op_s *op);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400584
Yi Liu8bb8aef2015-11-24 15:12:14 -0500585static inline __u64 orangefs_convert_time_field(const struct timespec *ts)
Al Viro57141562015-10-08 22:02:00 -0400586{
587 return (__u64)ts->tv_sec;
588}
Mike Marshallf7ab0932015-07-17 10:38:11 -0400589
Yi Liu8bb8aef2015-11-24 15:12:14 -0500590int orangefs_normalize_to_errno(__s32 error_code);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400591
592extern struct mutex devreq_mutex;
593extern struct mutex request_mutex;
594extern int debug;
595extern int op_timeout_secs;
596extern int slot_timeout_secs;
Yi Liu8bb8aef2015-11-24 15:12:14 -0500597extern struct list_head orangefs_superblocks;
598extern spinlock_t orangefs_superblocks_lock;
599extern struct list_head orangefs_request_list;
600extern spinlock_t orangefs_request_list_lock;
601extern wait_queue_head_t orangefs_request_list_waitq;
Mike Marshallf7ab0932015-07-17 10:38:11 -0400602extern struct list_head *htable_ops_in_progress;
603extern spinlock_t htable_ops_in_progress_lock;
604extern int hash_table_size;
605
Yi Liu8bb8aef2015-11-24 15:12:14 -0500606extern const struct address_space_operations orangefs_address_operations;
607extern struct backing_dev_info orangefs_backing_dev_info;
608extern struct inode_operations orangefs_file_inode_operations;
609extern const struct file_operations orangefs_file_operations;
610extern struct inode_operations orangefs_symlink_inode_operations;
611extern struct inode_operations orangefs_dir_inode_operations;
612extern const struct file_operations orangefs_dir_operations;
613extern const struct dentry_operations orangefs_dentry_operations;
614extern const struct file_operations orangefs_devreq_file_operations;
Mike Marshallf7ab0932015-07-17 10:38:11 -0400615
Yi Liu8bb8aef2015-11-24 15:12:14 -0500616extern wait_queue_head_t orangefs_bufmap_init_waitq;
Mike Marshallf7ab0932015-07-17 10:38:11 -0400617
618/*
619 * misc convenience macros
620 */
Mike Marshallf7ab0932015-07-17 10:38:11 -0400621
Yi Liu8bb8aef2015-11-24 15:12:14 -0500622#define ORANGEFS_OP_INTERRUPTIBLE 1 /* service_operation() is interruptible */
623#define ORANGEFS_OP_PRIORITY 2 /* service_operation() is high priority */
624#define ORANGEFS_OP_CANCELLATION 4 /* this is a cancellation */
625#define ORANGEFS_OP_NO_SEMAPHORE 8 /* don't acquire semaphore */
626#define ORANGEFS_OP_ASYNC 16 /* Queue it, but don't wait */
Mike Marshallf7ab0932015-07-17 10:38:11 -0400627
Yi Liu8bb8aef2015-11-24 15:12:14 -0500628int service_operation(struct orangefs_kernel_op_s *op,
Mike Marshallf7ab0932015-07-17 10:38:11 -0400629 const char *op_name,
630 int flags);
631
Mike Marshallf7ab0932015-07-17 10:38:11 -0400632#define get_interruptible_flag(inode) \
Yi Liu8bb8aef2015-11-24 15:12:14 -0500633 ((ORANGEFS_SB(inode->i_sb)->flags & ORANGEFS_OPT_INTR) ? \
634 ORANGEFS_OP_INTERRUPTIBLE : 0)
Mike Marshallf7ab0932015-07-17 10:38:11 -0400635
Yi Liu8bb8aef2015-11-24 15:12:14 -0500636#define add_orangefs_sb(sb) \
Mike Marshallf7ab0932015-07-17 10:38:11 -0400637do { \
638 gossip_debug(GOSSIP_SUPER_DEBUG, \
Yi Liu8bb8aef2015-11-24 15:12:14 -0500639 "Adding SB %p to orangefs superblocks\n", \
640 ORANGEFS_SB(sb)); \
641 spin_lock(&orangefs_superblocks_lock); \
642 list_add_tail(&ORANGEFS_SB(sb)->list, &orangefs_superblocks); \
643 spin_unlock(&orangefs_superblocks_lock); \
Mike Marshallf7ab0932015-07-17 10:38:11 -0400644} while (0)
645
Yi Liu8bb8aef2015-11-24 15:12:14 -0500646#define remove_orangefs_sb(sb) \
Mike Marshallf7ab0932015-07-17 10:38:11 -0400647do { \
648 struct list_head *tmp = NULL; \
649 struct list_head *tmp_safe = NULL; \
Yi Liu8bb8aef2015-11-24 15:12:14 -0500650 struct orangefs_sb_info_s *orangefs_sb = NULL; \
Mike Marshallf7ab0932015-07-17 10:38:11 -0400651 \
Yi Liu8bb8aef2015-11-24 15:12:14 -0500652 spin_lock(&orangefs_superblocks_lock); \
653 list_for_each_safe(tmp, tmp_safe, &orangefs_superblocks) { \
654 orangefs_sb = list_entry(tmp, \
655 struct orangefs_sb_info_s, \
Mike Marshallf7ab0932015-07-17 10:38:11 -0400656 list); \
Yi Liu8bb8aef2015-11-24 15:12:14 -0500657 if (orangefs_sb && (orangefs_sb->sb == sb)) { \
Mike Marshallf7ab0932015-07-17 10:38:11 -0400658 gossip_debug(GOSSIP_SUPER_DEBUG, \
Yi Liu8bb8aef2015-11-24 15:12:14 -0500659 "Removing SB %p from orangefs superblocks\n", \
660 orangefs_sb); \
661 list_del(&orangefs_sb->list); \
Mike Marshallf7ab0932015-07-17 10:38:11 -0400662 break; \
663 } \
664 } \
Yi Liu8bb8aef2015-11-24 15:12:14 -0500665 spin_unlock(&orangefs_superblocks_lock); \
Mike Marshallf7ab0932015-07-17 10:38:11 -0400666} while (0)
667
Yi Liu8bb8aef2015-11-24 15:12:14 -0500668#define orangefs_lock_inode(inode) spin_lock(&inode->i_lock)
669#define orangefs_unlock_inode(inode) spin_unlock(&inode->i_lock)
Mike Marshallf7ab0932015-07-17 10:38:11 -0400670
671#define fill_default_sys_attrs(sys_attr, type, mode) \
672do { \
673 sys_attr.owner = from_kuid(current_user_ns(), current_fsuid()); \
674 sys_attr.group = from_kgid(current_user_ns(), current_fsgid()); \
675 sys_attr.size = 0; \
Yi Liu8bb8aef2015-11-24 15:12:14 -0500676 sys_attr.perms = ORANGEFS_util_translate_mode(mode); \
Mike Marshallf7ab0932015-07-17 10:38:11 -0400677 sys_attr.objtype = type; \
Yi Liu8bb8aef2015-11-24 15:12:14 -0500678 sys_attr.mask = ORANGEFS_ATTR_SYS_ALL_SETABLE; \
Mike Marshallf7ab0932015-07-17 10:38:11 -0400679} while (0)
680
Yi Liu8bb8aef2015-11-24 15:12:14 -0500681#define orangefs_inode_lock(__i) mutex_lock(&(__i)->i_mutex)
Mike Marshallf7ab0932015-07-17 10:38:11 -0400682
Yi Liu8bb8aef2015-11-24 15:12:14 -0500683#define orangefs_inode_unlock(__i) mutex_unlock(&(__i)->i_mutex)
Mike Marshallf7ab0932015-07-17 10:38:11 -0400684
Yi Liu8bb8aef2015-11-24 15:12:14 -0500685static inline void orangefs_i_size_write(struct inode *inode, loff_t i_size)
Mike Marshallf7ab0932015-07-17 10:38:11 -0400686{
687#if BITS_PER_LONG == 32 && defined(CONFIG_SMP)
Arnd Bergmanneb57bcc2015-12-21 14:49:29 +0100688 orangefs_inode_lock(inode);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400689#endif
690 i_size_write(inode, i_size);
691#if BITS_PER_LONG == 32 && defined(CONFIG_SMP)
Yi Liu8bb8aef2015-11-24 15:12:14 -0500692 orangefs_inode_unlock(inode);
Mike Marshallf7ab0932015-07-17 10:38:11 -0400693#endif
694}
695
696static inline unsigned int diff(struct timeval *end, struct timeval *begin)
697{
698 if (end->tv_usec < begin->tv_usec) {
699 end->tv_usec += 1000000;
700 end->tv_sec--;
701 }
702 end->tv_sec -= begin->tv_sec;
703 end->tv_usec -= begin->tv_usec;
704 return (end->tv_sec * 1000000) + end->tv_usec;
705}
706
Yi Liu8bb8aef2015-11-24 15:12:14 -0500707#endif /* __ORANGEFSKERNEL_H */