orangefs-kernel.h 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489
  1. /* SPDX-License-Identifier: GPL-2.0 */
  2. /*
  3. * (C) 2001 Clemson University and The University of Chicago
  4. *
  5. * See COPYING in top-level directory.
  6. */
  7. /*
  8. * The ORANGEFS Linux kernel support allows ORANGEFS volumes to be mounted and
  9. * 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. * Declarations and macros for the ORANGEFS Linux kernel support.
  15. */
  16. #ifndef __ORANGEFSKERNEL_H
  17. #define __ORANGEFSKERNEL_H
  18. #include <linux/kernel.h>
  19. #include <linux/moduleparam.h>
  20. #include <linux/statfs.h>
  21. #include <linux/backing-dev.h>
  22. #include <linux/device.h>
  23. #include <linux/mpage.h>
  24. #include <linux/namei.h>
  25. #include <linux/errno.h>
  26. #include <linux/init.h>
  27. #include <linux/module.h>
  28. #include <linux/slab.h>
  29. #include <linux/types.h>
  30. #include <linux/fs.h>
  31. #include <linux/vmalloc.h>
  32. #include <linux/aio.h>
  33. #include <linux/posix_acl.h>
  34. #include <linux/posix_acl_xattr.h>
  35. #include <linux/compat.h>
  36. #include <linux/mount.h>
  37. #include <linux/uaccess.h>
  38. #include <linux/atomic.h>
  39. #include <linux/uio.h>
  40. #include <linux/sched/signal.h>
  41. #include <linux/mm.h>
  42. #include <linux/wait.h>
  43. #include <linux/dcache.h>
  44. #include <linux/pagemap.h>
  45. #include <linux/poll.h>
  46. #include <linux/rwsem.h>
  47. #include <linux/xattr.h>
  48. #include <linux/exportfs.h>
  49. #include <linux/hashtable.h>
  50. #include <asm/unaligned.h>
  51. #include "orangefs-dev-proto.h"
  52. #define ORANGEFS_DEFAULT_OP_TIMEOUT_SECS 20
  53. #define ORANGEFS_BUFMAP_WAIT_TIMEOUT_SECS 30
  54. #define ORANGEFS_DEFAULT_SLOT_TIMEOUT_SECS 900 /* 15 minutes */
  55. #define ORANGEFS_REQDEVICE_NAME "pvfs2-req"
  56. #define ORANGEFS_DEVREQ_MAGIC 0x20030529
  57. #define ORANGEFS_PURGE_RETRY_COUNT 0x00000005
  58. #define MAX_DEV_REQ_UPSIZE (2 * sizeof(__s32) + \
  59. sizeof(__u64) + sizeof(struct orangefs_upcall_s))
  60. #define MAX_DEV_REQ_DOWNSIZE (2 * sizeof(__s32) + \
  61. sizeof(__u64) + sizeof(struct orangefs_downcall_s))
  62. /*
  63. * valid orangefs kernel operation states
  64. *
  65. * unknown - op was just initialized
  66. * waiting - op is on request_list (upward bound)
  67. * inprogr - op is in progress (waiting for downcall)
  68. * serviced - op has matching downcall; ok
  69. * purged - op has to start a timer since client-core
  70. * exited uncleanly before servicing op
  71. * given up - submitter has given up waiting for it
  72. */
  73. enum orangefs_vfs_op_states {
  74. OP_VFS_STATE_UNKNOWN = 0,
  75. OP_VFS_STATE_WAITING = 1,
  76. OP_VFS_STATE_INPROGR = 2,
  77. OP_VFS_STATE_SERVICED = 4,
  78. OP_VFS_STATE_PURGED = 8,
  79. OP_VFS_STATE_GIVEN_UP = 16,
  80. };
  81. /*
  82. * orangefs kernel memory related flags
  83. */
  84. #if (defined CONFIG_DEBUG_SLAB)
  85. #define ORANGEFS_CACHE_CREATE_FLAGS SLAB_RED_ZONE
  86. #else
  87. #define ORANGEFS_CACHE_CREATE_FLAGS 0
  88. #endif
  89. extern int orangefs_init_acl(struct inode *inode, struct inode *dir);
  90. extern const struct xattr_handler *orangefs_xattr_handlers[];
  91. extern struct posix_acl *orangefs_get_acl(struct inode *inode, int type);
  92. extern int orangefs_set_acl(struct inode *inode, struct posix_acl *acl, int type);
  93. /*
  94. * orangefs data structures
  95. */
  96. struct orangefs_kernel_op_s {
  97. enum orangefs_vfs_op_states op_state;
  98. __u64 tag;
  99. /*
  100. * Set uses_shared_memory to non zero if this operation uses
  101. * shared memory. If true, then a retry on the op must also
  102. * get a new shared memory buffer and re-populate it.
  103. * Cancels don't care - it only matters for service_operation()
  104. * retry logics and cancels don't go through it anymore. It
  105. * safely stays non-zero when we use it as slot_to_free.
  106. */
  107. union {
  108. int uses_shared_memory;
  109. int slot_to_free;
  110. };
  111. struct orangefs_upcall_s upcall;
  112. struct orangefs_downcall_s downcall;
  113. struct completion waitq;
  114. spinlock_t lock;
  115. int attempts;
  116. struct list_head list;
  117. };
  118. #define set_op_state_waiting(op) ((op)->op_state = OP_VFS_STATE_WAITING)
  119. #define set_op_state_inprogress(op) ((op)->op_state = OP_VFS_STATE_INPROGR)
  120. #define set_op_state_given_up(op) ((op)->op_state = OP_VFS_STATE_GIVEN_UP)
  121. static inline void set_op_state_serviced(struct orangefs_kernel_op_s *op)
  122. {
  123. op->op_state = OP_VFS_STATE_SERVICED;
  124. complete(&op->waitq);
  125. }
  126. #define op_state_waiting(op) ((op)->op_state & OP_VFS_STATE_WAITING)
  127. #define op_state_in_progress(op) ((op)->op_state & OP_VFS_STATE_INPROGR)
  128. #define op_state_serviced(op) ((op)->op_state & OP_VFS_STATE_SERVICED)
  129. #define op_state_purged(op) ((op)->op_state & OP_VFS_STATE_PURGED)
  130. #define op_state_given_up(op) ((op)->op_state & OP_VFS_STATE_GIVEN_UP)
  131. #define op_is_cancel(op) ((op)->upcall.type == ORANGEFS_VFS_OP_CANCEL)
  132. void op_release(struct orangefs_kernel_op_s *op);
  133. extern void orangefs_bufmap_put(int);
  134. static inline void put_cancel(struct orangefs_kernel_op_s *op)
  135. {
  136. orangefs_bufmap_put(op->slot_to_free);
  137. op_release(op);
  138. }
  139. static inline void set_op_state_purged(struct orangefs_kernel_op_s *op)
  140. {
  141. spin_lock(&op->lock);
  142. if (unlikely(op_is_cancel(op))) {
  143. list_del_init(&op->list);
  144. spin_unlock(&op->lock);
  145. put_cancel(op);
  146. } else {
  147. op->op_state |= OP_VFS_STATE_PURGED;
  148. complete(&op->waitq);
  149. spin_unlock(&op->lock);
  150. }
  151. }
  152. /* per inode private orangefs info */
  153. struct orangefs_inode_s {
  154. struct orangefs_object_kref refn;
  155. char link_target[ORANGEFS_NAME_MAX];
  156. /*
  157. * Reading/Writing Extended attributes need to acquire the appropriate
  158. * reader/writer semaphore on the orangefs_inode_s structure.
  159. */
  160. struct rw_semaphore xattr_sem;
  161. struct inode vfs_inode;
  162. sector_t last_failed_block_index_read;
  163. unsigned long getattr_time;
  164. unsigned long mapping_time;
  165. int attr_valid;
  166. kuid_t attr_uid;
  167. kgid_t attr_gid;
  168. unsigned long bitlock;
  169. DECLARE_HASHTABLE(xattr_cache, 4);
  170. };
  171. /* per superblock private orangefs info */
  172. struct orangefs_sb_info_s {
  173. struct orangefs_khandle root_khandle;
  174. __s32 fs_id;
  175. int id;
  176. int flags;
  177. #define ORANGEFS_OPT_INTR 0x01
  178. #define ORANGEFS_OPT_LOCAL_LOCK 0x02
  179. char devname[ORANGEFS_MAX_SERVER_ADDR_LEN];
  180. struct super_block *sb;
  181. int mount_pending;
  182. int no_list;
  183. struct list_head list;
  184. };
  185. struct orangefs_stats {
  186. unsigned long cache_hits;
  187. unsigned long cache_misses;
  188. unsigned long reads;
  189. unsigned long writes;
  190. };
  191. struct orangefs_cached_xattr {
  192. struct hlist_node node;
  193. char key[ORANGEFS_MAX_XATTR_NAMELEN];
  194. char val[ORANGEFS_MAX_XATTR_VALUELEN];
  195. ssize_t length;
  196. unsigned long timeout;
  197. };
  198. struct orangefs_write_range {
  199. loff_t pos;
  200. size_t len;
  201. kuid_t uid;
  202. kgid_t gid;
  203. };
  204. extern struct orangefs_stats orangefs_stats;
  205. /*
  206. * NOTE: See Documentation/filesystems/porting.rst for information
  207. * on implementing FOO_I and properly accessing fs private data
  208. */
  209. static inline struct orangefs_inode_s *ORANGEFS_I(struct inode *inode)
  210. {
  211. return container_of(inode, struct orangefs_inode_s, vfs_inode);
  212. }
  213. static inline struct orangefs_sb_info_s *ORANGEFS_SB(struct super_block *sb)
  214. {
  215. return (struct orangefs_sb_info_s *) sb->s_fs_info;
  216. }
  217. /* ino_t descends from "unsigned long", 8 bytes, 64 bits. */
  218. static inline ino_t orangefs_khandle_to_ino(struct orangefs_khandle *khandle)
  219. {
  220. union {
  221. unsigned char u[8];
  222. __u64 ino;
  223. } ihandle;
  224. ihandle.u[0] = khandle->u[0] ^ khandle->u[4];
  225. ihandle.u[1] = khandle->u[1] ^ khandle->u[5];
  226. ihandle.u[2] = khandle->u[2] ^ khandle->u[6];
  227. ihandle.u[3] = khandle->u[3] ^ khandle->u[7];
  228. ihandle.u[4] = khandle->u[12] ^ khandle->u[8];
  229. ihandle.u[5] = khandle->u[13] ^ khandle->u[9];
  230. ihandle.u[6] = khandle->u[14] ^ khandle->u[10];
  231. ihandle.u[7] = khandle->u[15] ^ khandle->u[11];
  232. return ihandle.ino;
  233. }
  234. static inline struct orangefs_khandle *get_khandle_from_ino(struct inode *inode)
  235. {
  236. return &(ORANGEFS_I(inode)->refn.khandle);
  237. }
  238. static inline int is_root_handle(struct inode *inode)
  239. {
  240. gossip_debug(GOSSIP_DCACHE_DEBUG,
  241. "%s: root handle: %pU, this handle: %pU:\n",
  242. __func__,
  243. &ORANGEFS_SB(inode->i_sb)->root_khandle,
  244. get_khandle_from_ino(inode));
  245. if (ORANGEFS_khandle_cmp(&(ORANGEFS_SB(inode->i_sb)->root_khandle),
  246. get_khandle_from_ino(inode)))
  247. return 0;
  248. else
  249. return 1;
  250. }
  251. static inline int match_handle(struct orangefs_khandle resp_handle,
  252. struct inode *inode)
  253. {
  254. gossip_debug(GOSSIP_DCACHE_DEBUG,
  255. "%s: one handle: %pU, another handle:%pU:\n",
  256. __func__,
  257. &resp_handle,
  258. get_khandle_from_ino(inode));
  259. if (ORANGEFS_khandle_cmp(&resp_handle, get_khandle_from_ino(inode)))
  260. return 0;
  261. else
  262. return 1;
  263. }
  264. /*
  265. * defined in orangefs-cache.c
  266. */
  267. int op_cache_initialize(void);
  268. int op_cache_finalize(void);
  269. struct orangefs_kernel_op_s *op_alloc(__s32 type);
  270. void orangefs_new_tag(struct orangefs_kernel_op_s *op);
  271. char *get_opname_string(struct orangefs_kernel_op_s *new_op);
  272. int orangefs_inode_cache_initialize(void);
  273. int orangefs_inode_cache_finalize(void);
  274. /*
  275. * defined in orangefs-mod.c
  276. */
  277. void purge_inprogress_ops(void);
  278. /*
  279. * defined in waitqueue.c
  280. */
  281. void purge_waiting_ops(void);
  282. /*
  283. * defined in super.c
  284. */
  285. extern uint64_t orangefs_features;
  286. struct dentry *orangefs_mount(struct file_system_type *fst,
  287. int flags,
  288. const char *devname,
  289. void *data);
  290. void orangefs_kill_sb(struct super_block *sb);
  291. int orangefs_remount(struct orangefs_sb_info_s *);
  292. int fsid_key_table_initialize(void);
  293. void fsid_key_table_finalize(void);
  294. /*
  295. * defined in inode.c
  296. */
  297. vm_fault_t orangefs_page_mkwrite(struct vm_fault *);
  298. struct inode *orangefs_new_inode(struct super_block *sb,
  299. struct inode *dir,
  300. int mode,
  301. dev_t dev,
  302. struct orangefs_object_kref *ref);
  303. int __orangefs_setattr(struct inode *, struct iattr *);
  304. int orangefs_setattr(struct dentry *, struct iattr *);
  305. int orangefs_getattr(const struct path *path, struct kstat *stat,
  306. u32 request_mask, unsigned int flags);
  307. int orangefs_permission(struct inode *inode, int mask);
  308. int orangefs_update_time(struct inode *, struct timespec64 *, int);
  309. /*
  310. * defined in xattr.c
  311. */
  312. ssize_t orangefs_listxattr(struct dentry *dentry, char *buffer, size_t size);
  313. /*
  314. * defined in namei.c
  315. */
  316. struct inode *orangefs_iget(struct super_block *sb,
  317. struct orangefs_object_kref *ref);
  318. /*
  319. * defined in devorangefs-req.c
  320. */
  321. extern uint32_t orangefs_userspace_version;
  322. int orangefs_dev_init(void);
  323. void orangefs_dev_cleanup(void);
  324. int is_daemon_in_service(void);
  325. bool __is_daemon_in_service(void);
  326. /*
  327. * defined in file.c
  328. */
  329. int orangefs_revalidate_mapping(struct inode *);
  330. ssize_t wait_for_direct_io(enum ORANGEFS_io_type, struct inode *, loff_t *,
  331. struct iov_iter *, size_t, loff_t, struct orangefs_write_range *, int *,
  332. struct file *);
  333. ssize_t do_readv_writev(enum ORANGEFS_io_type, struct file *, loff_t *,
  334. struct iov_iter *);
  335. /*
  336. * defined in orangefs-utils.c
  337. */
  338. __s32 fsid_of_op(struct orangefs_kernel_op_s *op);
  339. ssize_t orangefs_inode_getxattr(struct inode *inode,
  340. const char *name,
  341. void *buffer,
  342. size_t size);
  343. int orangefs_inode_setxattr(struct inode *inode,
  344. const char *name,
  345. const void *value,
  346. size_t size,
  347. int flags);
  348. #define ORANGEFS_GETATTR_NEW 1
  349. #define ORANGEFS_GETATTR_SIZE 2
  350. int orangefs_inode_getattr(struct inode *, int);
  351. int orangefs_inode_check_changed(struct inode *inode);
  352. int orangefs_inode_setattr(struct inode *inode);
  353. bool orangefs_cancel_op_in_progress(struct orangefs_kernel_op_s *op);
  354. int orangefs_normalize_to_errno(__s32 error_code);
  355. extern struct mutex orangefs_request_mutex;
  356. extern int op_timeout_secs;
  357. extern int slot_timeout_secs;
  358. extern int orangefs_cache_timeout_msecs;
  359. extern int orangefs_dcache_timeout_msecs;
  360. extern int orangefs_getattr_timeout_msecs;
  361. extern struct list_head orangefs_superblocks;
  362. extern spinlock_t orangefs_superblocks_lock;
  363. extern struct list_head orangefs_request_list;
  364. extern spinlock_t orangefs_request_list_lock;
  365. extern wait_queue_head_t orangefs_request_list_waitq;
  366. extern struct list_head *orangefs_htable_ops_in_progress;
  367. extern spinlock_t orangefs_htable_ops_in_progress_lock;
  368. extern int hash_table_size;
  369. extern const struct file_operations orangefs_file_operations;
  370. extern const struct inode_operations orangefs_symlink_inode_operations;
  371. extern const struct inode_operations orangefs_dir_inode_operations;
  372. extern const struct file_operations orangefs_dir_operations;
  373. extern const struct dentry_operations orangefs_dentry_operations;
  374. /*
  375. * misc convenience macros
  376. */
  377. #define ORANGEFS_OP_INTERRUPTIBLE 1 /* service_operation() is interruptible */
  378. #define ORANGEFS_OP_PRIORITY 2 /* service_operation() is high priority */
  379. #define ORANGEFS_OP_CANCELLATION 4 /* this is a cancellation */
  380. #define ORANGEFS_OP_NO_MUTEX 8 /* don't acquire request_mutex */
  381. #define ORANGEFS_OP_ASYNC 16 /* Queue it, but don't wait */
  382. #define ORANGEFS_OP_WRITEBACK 32
  383. int service_operation(struct orangefs_kernel_op_s *op,
  384. const char *op_name,
  385. int flags);
  386. #define get_interruptible_flag(inode) \
  387. ((ORANGEFS_SB(inode->i_sb)->flags & ORANGEFS_OPT_INTR) ? \
  388. ORANGEFS_OP_INTERRUPTIBLE : 0)
  389. #define fill_default_sys_attrs(sys_attr, type, mode) \
  390. do { \
  391. sys_attr.owner = from_kuid(&init_user_ns, current_fsuid()); \
  392. sys_attr.group = from_kgid(&init_user_ns, current_fsgid()); \
  393. sys_attr.perms = ORANGEFS_util_translate_mode(mode); \
  394. sys_attr.mtime = 0; \
  395. sys_attr.atime = 0; \
  396. sys_attr.ctime = 0; \
  397. sys_attr.mask = ORANGEFS_ATTR_SYS_ALL_SETABLE; \
  398. } while (0)
  399. static inline void orangefs_set_timeout(struct dentry *dentry)
  400. {
  401. unsigned long time = jiffies + orangefs_dcache_timeout_msecs*HZ/1000;
  402. dentry->d_fsdata = (void *) time;
  403. }
  404. #endif /* __ORANGEFSKERNEL_H */