~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/fs/orangefs/orangefs-kernel.h

Version: ~ [ linux-5.9-rc6 ] ~ [ linux-5.8.10 ] ~ [ linux-5.7.19 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.66 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.146 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.198 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.236 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.236 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.19.8 ] ~ [ linux-3.18.140 ] ~ [ linux-3.17.8 ] ~ [ linux-3.16.85 ] ~ [ linux-3.15.10 ] ~ [ linux-3.14.79 ] ~ [ linux-3.13.11 ] ~ [ linux-3.12.74 ] ~ [ linux-3.11.10 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

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

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp