Whamcloud - gitweb
LU-13467 llite: truncate deadlock with DoM files
[fs/lustre-release.git] / lustre / llite / llite_internal.h
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 only,
8  * as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * General Public License version 2 for more details (a copy is included
14  * in the LICENSE file that accompanied this code).
15  *
16  * You should have received a copy of the GNU General Public License
17  * version 2 along with this program; If not, see
18  * http://www.gnu.org/licenses/gpl-2.0.html
19  *
20  * GPL HEADER END
21  */
22 /*
23  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Use is subject to license terms.
25  *
26  * Copyright (c) 2011, 2017, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  * Lustre is a trademark of Sun Microsystems, Inc.
31  */
32
33 #ifndef LLITE_INTERNAL_H
34 #define LLITE_INTERNAL_H
35 #include <lustre_debug.h>
36 #include <lustre_disk.h>  /* for s2sbi */
37 #include <lustre_eacl.h>
38 #include <lustre_linkea.h>
39
40 /* for struct cl_lock_descr and struct cl_io */
41 #include <cl_object.h>
42 #include <lustre_lmv.h>
43 #include <lustre_mdc.h>
44 #include <lustre_intent.h>
45 #include <linux/compat.h>
46 #include <linux/aio.h>
47 #include <lustre_compat.h>
48 #include <lustre_crypto.h>
49
50 #include "vvp_internal.h"
51 #include "range_lock.h"
52 #include "pcc.h"
53
54 #ifndef FMODE_EXEC
55 #define FMODE_EXEC 0
56 #endif
57
58 #ifndef VM_FAULT_RETRY
59 #define VM_FAULT_RETRY 0
60 #endif
61
62 /* Kernel 3.1 kills LOOKUP_CONTINUE, LOOKUP_PARENT is equivalent to it.
63  * seem kernel commit 49084c3bb2055c401f3493c13edae14d49128ca0 */
64 #ifndef LOOKUP_CONTINUE
65 #define LOOKUP_CONTINUE LOOKUP_PARENT
66 #endif
67
68 /** Only used on client-side for indicating the tail of dir hash/offset. */
69 #define LL_DIR_END_OFF          0x7fffffffffffffffULL
70 #define LL_DIR_END_OFF_32BIT    0x7fffffffUL
71
72 /* 4UL * 1024 * 1024 */
73 #define LL_MAX_BLKSIZE_BITS 22
74
75 #define LL_IT2STR(it) ((it) ? ldlm_it2str((it)->it_op) : "0")
76
77 #define TIMES_SET_FLAGS (ATTR_MTIME_SET | ATTR_ATIME_SET | ATTR_TIMES_SET)
78
79 struct ll_dentry_data {
80         unsigned int                    lld_sa_generation;
81         unsigned int                    lld_invalid:1;
82         unsigned int                    lld_nfs_dentry:1;
83         struct rcu_head                 lld_rcu_head;
84 };
85
86 #define ll_d2d(de) ((struct ll_dentry_data*)((de)->d_fsdata))
87
88 #define LLI_INODE_MAGIC                 0x111d0de5
89 #define LLI_INODE_DEAD                  0xdeadd00d
90
91 struct ll_getname_data {
92 #ifdef HAVE_DIR_CONTEXT
93         struct dir_context      ctx;
94 #endif
95         char            *lgd_name;      /* points to a buffer with NAME_MAX+1 size */
96         struct lu_fid   lgd_fid;        /* target fid we are looking for */
97         int             lgd_found;      /* inode matched? */
98 };
99
100 struct ll_grouplock {
101         struct lu_env   *lg_env;
102         struct cl_io    *lg_io;
103         struct cl_lock  *lg_lock;
104         unsigned long    lg_gid;
105 };
106
107 /* See comment on trunc_sem_down_read_nowait */
108 struct ll_trunc_sem {
109         /* when positive, this is a count of readers, when -1, it indicates
110          * the semaphore is held for write, and 0 is unlocked
111          */
112         atomic_t        ll_trunc_readers;
113         /* this tracks a count of waiting writers */
114         atomic_t        ll_trunc_waiters;
115 };
116
117 struct ll_inode_info {
118         __u32                           lli_inode_magic;
119         spinlock_t                      lli_lock;
120
121         volatile unsigned long          lli_flags;
122         struct posix_acl                *lli_posix_acl;
123
124         /* identifying fields for both metadata and data stacks. */
125         struct lu_fid                   lli_fid;
126         /* master inode fid for stripe directory */
127         struct lu_fid                   lli_pfid;
128
129         /* We need all three because every inode may be opened in different
130          * modes */
131         struct obd_client_handle       *lli_mds_read_och;
132         struct obd_client_handle       *lli_mds_write_och;
133         struct obd_client_handle       *lli_mds_exec_och;
134         __u64                           lli_open_fd_read_count;
135         __u64                           lli_open_fd_write_count;
136         __u64                           lli_open_fd_exec_count;
137         /* Protects access to och pointers and their usage counters */
138         struct mutex                    lli_och_mutex;
139
140         struct inode                    lli_vfs_inode;
141
142         /* the most recent timestamps obtained from mds */
143         s64                             lli_atime;
144         s64                             lli_mtime;
145         s64                             lli_ctime;
146         s64                             lli_btime;
147         spinlock_t                      lli_agl_lock;
148
149         /* Try to make the d::member and f::member are aligned. Before using
150          * these members, make clear whether it is directory or not. */
151         union {
152                 /* for directory */
153                 struct {
154                         /* metadata statahead */
155                         /* since parent-child threads can share the same @file
156                          * struct, "opendir_key" is the token when dir close for
157                          * case of parent exit before child -- it is me should
158                          * cleanup the dir readahead. */
159                         void                           *lli_opendir_key;
160                         struct ll_statahead_info       *lli_sai;
161                         /* protect statahead stuff. */
162                         spinlock_t                      lli_sa_lock;
163                         /* "opendir_pid" is the token when lookup/revalid
164                          * -- I am the owner of dir statahead. */
165                         pid_t                           lli_opendir_pid;
166                         /* stat will try to access statahead entries or start
167                          * statahead if this flag is set, and this flag will be
168                          * set upon dir open, and cleared when dir is closed,
169                          * statahead hit ratio is too low, or start statahead
170                          * thread failed. */
171                         unsigned int                    lli_sa_enabled:1;
172                         /* generation for statahead */
173                         unsigned int                    lli_sa_generation;
174                         /* rw lock protects lli_lsm_md */
175                         struct rw_semaphore             lli_lsm_sem;
176                         /* directory stripe information */
177                         struct lmv_stripe_md            *lli_lsm_md;
178                         /* directory default LMV */
179                         struct lmv_stripe_md            *lli_default_lsm_md;
180                 };
181
182                 /* for non-directory */
183                 struct {
184                         struct mutex            lli_size_mutex;
185                         char                   *lli_symlink_name;
186                         struct ll_trunc_sem     lli_trunc_sem;
187                         struct range_lock_tree  lli_write_tree;
188                         struct mutex            lli_setattr_mutex;
189
190                         struct rw_semaphore     lli_glimpse_sem;
191                         ktime_t                 lli_glimpse_time;
192                         struct list_head        lli_agl_list;
193                         __u64                   lli_agl_index;
194
195                         /* for writepage() only to communicate to fsync */
196                         int                     lli_async_rc;
197
198                         /* protect the file heat fields */
199                         spinlock_t                      lli_heat_lock;
200                         __u32                           lli_heat_flags;
201                         struct obd_heat_instance        lli_heat_instances[OBD_HEAT_COUNT];
202
203                         /*
204                          * Whenever a process try to read/write the file, the
205                          * jobid of the process will be saved here, and it'll
206                          * be packed into the write PRC when flush later.
207                          *
208                          * So the read/write statistics for jobid will not be
209                          * accurate if the file is shared by different jobs.
210                          */
211                         char                    lli_jobid[LUSTRE_JOBID_SIZE];
212
213                         struct mutex             lli_pcc_lock;
214                         enum lu_pcc_state_flags  lli_pcc_state;
215                         /*
216                          * @lli_pcc_generation saves the gobal PCC generation
217                          * when the file was successfully attached into PCC.
218                          * The flags of the PCC dataset are saved in
219                          * @lli_pcc_dsflags.
220                          * The gobal PCC generation will be increased when add
221                          * or delete a PCC backend, or change the configuration
222                          * parameters for PCC.
223                          * If @lli_pcc_generation is same as the gobal PCC
224                          * generation, we can use the saved flags of the PCC
225                          * dataset to determine whether need to try auto attach
226                          * safely.
227                          */
228                         __u64                    lli_pcc_generation;
229                         enum pcc_dataset_flags   lli_pcc_dsflags;
230                         struct pcc_inode        *lli_pcc_inode;
231
232                         struct mutex             lli_group_mutex;
233                         __u64                    lli_group_users;
234                         unsigned long            lli_group_gid;
235
236                         __u64                    lli_attr_valid;
237                         __u64                    lli_lazysize;
238                         __u64                    lli_lazyblocks;
239                 };
240         };
241
242         /* XXX: For following frequent used members, although they maybe special
243          *      used for non-directory object, it is some time-wasting to check
244          *      whether the object is directory or not before using them. On the
245          *      other hand, currently, sizeof(f) > sizeof(d), it cannot reduce
246          *      the "ll_inode_info" size even if moving those members into u.f.
247          *      So keep them out side.
248          *
249          *      In the future, if more members are added only for directory,
250          *      some of the following members can be moved into u.f.
251          */
252         struct cl_object                *lli_clob;
253
254         /* mutex to request for layout lock exclusively. */
255         struct mutex                    lli_layout_mutex;
256         /* Layout version, protected by lli_layout_lock */
257         __u32                           lli_layout_gen;
258         spinlock_t                      lli_layout_lock;
259
260         __u32                           lli_projid;   /* project id */
261
262         struct rw_semaphore             lli_xattrs_list_rwsem;
263         struct mutex                    lli_xattrs_enq_lock;
264         struct list_head                lli_xattrs; /* ll_xattr_entry->xe_list */
265 };
266
267 static inline void ll_trunc_sem_init(struct ll_trunc_sem *sem)
268 {
269         atomic_set(&sem->ll_trunc_readers, 0);
270         atomic_set(&sem->ll_trunc_waiters, 0);
271 }
272
273 /* This version of down read ignores waiting writers, meaning if the semaphore
274  * is already held for read, this down_read will 'join' that reader and also
275  * take the semaphore.
276  *
277  * This lets us avoid an unusual deadlock.
278  *
279  * We must take lli_trunc_sem in read mode on entry in to various i/o paths
280  * in Lustre, in order to exclude truncates.  Some of these paths then need to
281  * take the mmap_sem, while still holding the trunc_sem.  The problem is that
282  * page faults hold the mmap_sem when calling in to Lustre, and then must also
283  * take the trunc_sem to exclude truncate.
284  *
285  * This means the locking order for trunc_sem and mmap_sem is sometimes AB,
286  * sometimes BA.  This is almost OK because in both cases, we take the trunc
287  * sem for read, so it doesn't block.
288  *
289  * However, if a write mode user (truncate, a setattr op) arrives in the
290  * middle of this, the second reader on the truncate_sem will wait behind that
291  * writer.
292  *
293  * So we have, on our truncate sem, in order (where 'reader' and 'writer' refer
294  * to the mode in which they take the semaphore):
295  * reader (holding mmap_sem, needs truncate_sem)
296  * writer
297  * reader (holding truncate sem, waiting for mmap_sem)
298  *
299  * And so the readers deadlock.
300  *
301  * The solution is this modified semaphore, where this down_read ignores
302  * waiting write operations, and all waiters are woken up at once, so readers
303  * using down_read_nowait cannot get stuck behind waiting writers, regardless
304  * of the order they arrived in.
305  *
306  * down_read_nowait is only used in the page fault case, where we already hold
307  * the mmap_sem.  This is because otherwise repeated read and write operations
308  * (which take the truncate sem) could prevent a truncate from ever starting.
309  * This could still happen with page faults, but without an even more complex
310  * mechanism, this is unavoidable.
311  *
312  * LU-12460
313  */
314 static inline void trunc_sem_down_read_nowait(struct ll_trunc_sem *sem)
315 {
316         wait_var_event(&sem->ll_trunc_readers,
317                        atomic_inc_unless_negative(&sem->ll_trunc_readers));
318 }
319
320 static inline void trunc_sem_down_read(struct ll_trunc_sem *sem)
321 {
322         wait_var_event(&sem->ll_trunc_readers,
323                        atomic_read(&sem->ll_trunc_waiters) == 0 &&
324                        atomic_inc_unless_negative(&sem->ll_trunc_readers));
325 }
326
327 static inline void trunc_sem_up_read(struct ll_trunc_sem *sem)
328 {
329         if (atomic_dec_return(&sem->ll_trunc_readers) == 0 &&
330             atomic_read(&sem->ll_trunc_waiters))
331                 wake_up_var(&sem->ll_trunc_readers);
332 }
333
334 static inline void trunc_sem_down_write(struct ll_trunc_sem *sem)
335 {
336         atomic_inc(&sem->ll_trunc_waiters);
337         wait_var_event(&sem->ll_trunc_readers,
338                        atomic_cmpxchg(&sem->ll_trunc_readers, 0, -1) == 0);
339         atomic_dec(&sem->ll_trunc_waiters);
340 }
341
342 static inline void trunc_sem_up_write(struct ll_trunc_sem *sem)
343 {
344         atomic_set(&sem->ll_trunc_readers, 0);
345         wake_up_var(&sem->ll_trunc_readers);
346 }
347
348 static inline __u32 ll_layout_version_get(struct ll_inode_info *lli)
349 {
350         __u32 gen;
351
352         spin_lock(&lli->lli_layout_lock);
353         gen = lli->lli_layout_gen;
354         spin_unlock(&lli->lli_layout_lock);
355
356         return gen;
357 }
358
359 static inline void ll_layout_version_set(struct ll_inode_info *lli, __u32 gen)
360 {
361         spin_lock(&lli->lli_layout_lock);
362         lli->lli_layout_gen = gen;
363         spin_unlock(&lli->lli_layout_lock);
364 }
365
366 enum ll_file_flags {
367         /* File data is modified. */
368         LLIF_DATA_MODIFIED      = 0,
369         /* File is being restored */
370         LLIF_FILE_RESTORING     = 1,
371         /* Xattr cache is attached to the file */
372         LLIF_XATTR_CACHE        = 2,
373         /* Project inherit */
374         LLIF_PROJECT_INHERIT    = 3,
375         /* update atime from MDS even if it's older than local inode atime. */
376         LLIF_UPDATE_ATIME       = 4,
377
378 };
379
380 static inline void ll_file_set_flag(struct ll_inode_info *lli,
381                                     enum ll_file_flags flag)
382 {
383         set_bit(flag, &lli->lli_flags);
384 }
385
386 static inline void ll_file_clear_flag(struct ll_inode_info *lli,
387                                       enum ll_file_flags flag)
388 {
389         clear_bit(flag, &lli->lli_flags);
390 }
391
392 static inline bool ll_file_test_flag(struct ll_inode_info *lli,
393                                      enum ll_file_flags flag)
394 {
395         return test_bit(flag, &lli->lli_flags);
396 }
397
398 static inline bool ll_file_test_and_clear_flag(struct ll_inode_info *lli,
399                                                enum ll_file_flags flag)
400 {
401         return test_and_clear_bit(flag, &lli->lli_flags);
402 }
403
404 int ll_xattr_cache_destroy(struct inode *inode);
405
406 int ll_xattr_cache_get(struct inode *inode,
407                         const char *name,
408                         char *buffer,
409                         size_t size,
410                         __u64 valid);
411
412 static inline bool obd_connect_has_secctx(struct obd_connect_data *data)
413 {
414 #ifdef CONFIG_SECURITY
415         return data->ocd_connect_flags & OBD_CONNECT_FLAGS2 &&
416                data->ocd_connect_flags2 & OBD_CONNECT2_FILE_SECCTX;
417 #else
418         return false;
419 #endif
420 }
421
422 static inline void obd_connect_set_secctx(struct obd_connect_data *data)
423 {
424 #ifdef CONFIG_SECURITY
425         data->ocd_connect_flags2 |= OBD_CONNECT2_FILE_SECCTX;
426 #endif
427 }
428
429 int ll_dentry_init_security(struct dentry *dentry, int mode, struct qstr *name,
430                             const char **secctx_name, void **secctx,
431                             __u32 *secctx_size);
432 int ll_inode_init_security(struct dentry *dentry, struct inode *inode,
433                            struct inode *dir);
434
435 int ll_listsecurity(struct inode *inode, char *secctx_name,
436                     size_t secctx_name_size);
437
438 static inline bool obd_connect_has_enc(struct obd_connect_data *data)
439 {
440 #ifdef HAVE_LUSTRE_CRYPTO
441         return data->ocd_connect_flags & OBD_CONNECT_FLAGS2 &&
442                 data->ocd_connect_flags2 & OBD_CONNECT2_ENCRYPT;
443 #else
444         return false;
445 #endif
446 }
447
448 static inline void obd_connect_set_enc(struct obd_connect_data *data)
449 {
450 #ifdef HAVE_LUSTRE_CRYPTO
451         data->ocd_connect_flags2 |= OBD_CONNECT2_ENCRYPT;
452 #endif
453 }
454
455 /*
456  * Locking to guarantee consistency of non-atomic updates to long long i_size,
457  * consistency between file size and KMS.
458  *
459  * Implemented by ->lli_size_mutex and ->lsm_lock, nested in that order.
460  */
461
462 void ll_inode_size_lock(struct inode *inode);
463 void ll_inode_size_unlock(struct inode *inode);
464
465 static inline struct ll_inode_info *ll_i2info(struct inode *inode)
466 {
467         return container_of(inode, struct ll_inode_info, lli_vfs_inode);
468 }
469
470 static inline struct pcc_inode *ll_i2pcci(struct inode *inode)
471 {
472         return ll_i2info(inode)->lli_pcc_inode;
473 }
474
475 /* default to use at least 16M for fast read if possible */
476 #define RA_REMAIN_WINDOW_MIN                    MiB_TO_PAGES(16UL)
477
478 /* default readahead on a given system. */
479 #define SBI_DEFAULT_READ_AHEAD_MAX              MiB_TO_PAGES(64UL)
480
481 /* default read-ahead full files smaller than limit on the second read */
482 #define SBI_DEFAULT_READ_AHEAD_WHOLE_MAX        MiB_TO_PAGES(2UL)
483
484 enum ra_stat {
485         RA_STAT_HIT = 0,
486         RA_STAT_MISS,
487         RA_STAT_DISTANT_READPAGE,
488         RA_STAT_MISS_IN_WINDOW,
489         RA_STAT_FAILED_GRAB_PAGE,
490         RA_STAT_FAILED_MATCH,
491         RA_STAT_DISCARDED,
492         RA_STAT_ZERO_LEN,
493         RA_STAT_ZERO_WINDOW,
494         RA_STAT_EOF,
495         RA_STAT_MAX_IN_FLIGHT,
496         RA_STAT_WRONG_GRAB_PAGE,
497         RA_STAT_FAILED_REACH_END,
498         RA_STAT_ASYNC,
499         RA_STAT_FAILED_FAST_READ,
500         _NR_RA_STAT,
501 };
502
503 struct ll_ra_info {
504         atomic_t        ra_cur_pages;
505         unsigned long   ra_max_pages;
506         unsigned long   ra_max_pages_per_file;
507         unsigned long   ra_max_read_ahead_whole_pages;
508         struct workqueue_struct  *ll_readahead_wq;
509         /*
510          * Max number of active works could be triggered
511          * for async readahead.
512          */
513         unsigned int ra_async_max_active;
514         /* how many async readahead triggered in flight */
515         atomic_t ra_async_inflight;
516         /* Threshold to control when to trigger async readahead */
517         unsigned long ra_async_pages_per_file_threshold;
518 };
519
520 /* ra_io_arg will be filled in the beginning of ll_readahead with
521  * ras_lock, then the following ll_read_ahead_pages will read RA
522  * pages according to this arg, all the items in this structure are
523  * counted by page index.
524  */
525 struct ra_io_arg {
526         pgoff_t         ria_start_idx;  /* start offset of read-ahead*/
527         pgoff_t         ria_end_idx;    /* end offset of read-ahead*/
528         unsigned long   ria_reserved;   /* reserved pages for read-ahead */
529         pgoff_t         ria_end_idx_min;/* minimum end to cover current read */
530         bool            ria_eof;        /* reach end of file */
531         /* If stride read pattern is detected, ria_stoff is the byte offset
532          * where stride read is started. Note: for normal read-ahead, the
533          * value here is meaningless, and also it will not be accessed*/
534         loff_t          ria_stoff;
535         /* ria_length and ria_bytes are the length and pages length in the
536          * stride I/O mode. And they will also be used to check whether
537          * it is stride I/O read-ahead in the read-ahead pages*/
538         loff_t          ria_length;
539         loff_t          ria_bytes;
540 };
541
542 /* LL_HIST_MAX=32 causes an overflow */
543 #define LL_HIST_MAX 28
544 #define LL_HIST_START 12 /* buckets start at 2^12 = 4k */
545 #define LL_PROCESS_HIST_MAX 10
546 struct per_process_info {
547         pid_t pid;
548         struct obd_histogram pp_r_hist;
549         struct obd_histogram pp_w_hist;
550 };
551
552 /* pp_extents[LL_PROCESS_HIST_MAX] will hold the combined process info */
553 struct ll_rw_extents_info {
554         struct per_process_info pp_extents[LL_PROCESS_HIST_MAX + 1];
555 };
556
557 #define LL_OFFSET_HIST_MAX 100
558 struct ll_rw_process_info {
559         pid_t                     rw_pid;
560         int                       rw_op;
561         loff_t                    rw_range_start;
562         loff_t                    rw_range_end;
563         loff_t                    rw_last_file_pos;
564         loff_t                    rw_offset;
565         size_t                    rw_smallest_extent;
566         size_t                    rw_largest_extent;
567         struct ll_file_data      *rw_last_file;
568 };
569
570 enum stats_track_type {
571         STATS_TRACK_ALL = 0,  /* track all processes */
572         STATS_TRACK_PID,      /* track process with this pid */
573         STATS_TRACK_PPID,     /* track processes with this ppid */
574         STATS_TRACK_GID,      /* track processes with this gid */
575         STATS_TRACK_LAST,
576 };
577
578 /* flags for sbi->ll_flags */
579 #define LL_SBI_NOLCK             0x01 /* DLM locking disabled (directio-only) */
580 #define LL_SBI_CHECKSUM          0x02 /* checksum each page as it's written */
581 #define LL_SBI_FLOCK             0x04
582 #define LL_SBI_USER_XATTR        0x08 /* support user xattr */
583 #define LL_SBI_ACL               0x10 /* support ACL */
584 /*      LL_SBI_RMT_CLIENT        0x40    remote client */
585 #define LL_SBI_MDS_CAPA          0x80 /* support mds capa, obsolete */
586 #define LL_SBI_OSS_CAPA         0x100 /* support oss capa, obsolete */
587 #define LL_SBI_LOCALFLOCK       0x200 /* Local flocks support by kernel */
588 #define LL_SBI_LRU_RESIZE       0x400 /* lru resize support */
589 #define LL_SBI_LAZYSTATFS       0x800 /* lazystatfs mount option */
590 /*      LL_SBI_SOM_PREVIEW     0x1000    SOM preview mount option, obsolete */
591 #define LL_SBI_32BIT_API       0x2000 /* generate 32 bit inodes. */
592 #define LL_SBI_64BIT_HASH      0x4000 /* support 64-bits dir hash/offset */
593 #define LL_SBI_AGL_ENABLED     0x8000 /* enable agl */
594 #define LL_SBI_VERBOSE        0x10000 /* verbose mount/umount */
595 #define LL_SBI_LAYOUT_LOCK    0x20000 /* layout lock support */
596 #define LL_SBI_USER_FID2PATH  0x40000 /* allow fid2path by unprivileged users */
597 #define LL_SBI_XATTR_CACHE    0x80000 /* support for xattr cache */
598 #define LL_SBI_NOROOTSQUASH  0x100000 /* do not apply root squash */
599 #define LL_SBI_ALWAYS_PING   0x200000 /* always ping even if server
600                                        * suppress_pings */
601 #define LL_SBI_FAST_READ     0x400000 /* fast read support */
602 #define LL_SBI_FILE_SECCTX   0x800000 /* set file security context at create */
603 /*      LL_SBI_PIO          0x1000000    parallel IO support, introduced in
604                                          2.10, abandoned */
605 #define LL_SBI_TINY_WRITE   0x2000000 /* tiny write support */
606 #define LL_SBI_FILE_HEAT    0x4000000 /* file heat support */
607 #define LL_SBI_TEST_DUMMY_ENCRYPTION    0x8000000 /* test dummy encryption */
608 #define LL_SBI_ENCRYPT     0x10000000 /* client side encryption */
609 #define LL_SBI_FLAGS {  \
610         "nolck",        \
611         "checksum",     \
612         "flock",        \
613         "user_xattr",   \
614         "acl",          \
615         "???",          \
616         "???",          \
617         "mds_capa",     \
618         "oss_capa",     \
619         "flock",        \
620         "lru_resize",   \
621         "lazy_statfs",  \
622         "som",          \
623         "32bit_api",    \
624         "64bit_hash",   \
625         "agl",          \
626         "verbose",      \
627         "layout",       \
628         "user_fid2path",\
629         "xattr_cache",  \
630         "norootsquash", \
631         "always_ping",  \
632         "fast_read",    \
633         "file_secctx",  \
634         "pio",          \
635         "tiny_write",   \
636         "file_heat",    \
637         "test_dummy_encryption", \
638         "noencrypt",    \
639 }
640
641 /* This is embedded into llite super-blocks to keep track of connect
642  * flags (capabilities) supported by all imports given mount is
643  * connected to. */
644 struct lustre_client_ocd {
645         /* This is conjunction of connect_flags across all imports
646          * (LOVs) this mount is connected to. This field is updated by
647          * cl_ocd_update() under ->lco_lock. */
648         __u64                    lco_flags;
649         struct mutex             lco_lock;
650         struct obd_export       *lco_md_exp;
651         struct obd_export       *lco_dt_exp;
652 };
653
654 struct ll_sb_info {
655         /* this protects pglist and ra_info.  It isn't safe to
656          * grab from interrupt contexts */
657         spinlock_t               ll_lock;
658         spinlock_t               ll_pp_extent_lock; /* pp_extent entry*/
659         spinlock_t               ll_process_lock; /* ll_rw_process_info */
660         struct obd_uuid          ll_sb_uuid;
661         struct obd_export       *ll_md_exp;
662         struct obd_export       *ll_dt_exp;
663         struct obd_device       *ll_md_obd;
664         struct obd_device       *ll_dt_obd;
665         struct dentry           *ll_debugfs_entry;
666         struct lu_fid            ll_root_fid; /* root object fid */
667
668         int                       ll_flags;
669         unsigned int              ll_xattr_cache_enabled:1,
670                                   ll_xattr_cache_set:1, /* already set to 0/1 */
671                                   ll_client_common_fill_super_succeeded:1,
672                                   ll_checksum_set:1;
673
674         struct lustre_client_ocd  ll_lco;
675
676         struct lprocfs_stats     *ll_stats; /* lprocfs stats counter */
677
678         /* Used to track "unstable" pages on a client, and maintain a
679          * LRU list of clean pages. An "unstable" page is defined as
680          * any page which is sent to a server as part of a bulk request,
681          * but is uncommitted to stable storage. */
682         struct cl_client_cache   *ll_cache;
683
684         struct lprocfs_stats     *ll_ra_stats;
685
686         struct ll_ra_info         ll_ra_info;
687         unsigned int              ll_namelen;
688         struct file_operations   *ll_fop;
689
690         struct lu_site           *ll_site;
691         struct cl_device         *ll_cl;
692         /* Statistics */
693         struct ll_rw_extents_info ll_rw_extents_info;
694         int                       ll_extent_process_count;
695         struct ll_rw_process_info ll_rw_process_info[LL_PROCESS_HIST_MAX];
696         unsigned int              ll_offset_process_count;
697         struct ll_rw_process_info ll_rw_offset_info[LL_OFFSET_HIST_MAX];
698         unsigned int              ll_rw_offset_entry_count;
699         int                       ll_stats_track_id;
700         enum stats_track_type     ll_stats_track_type;
701         int                       ll_rw_stats_on;
702
703         /* metadata stat-ahead */
704         unsigned int              ll_sa_running_max;/* max concurrent
705                                                      * statahead instances */
706         unsigned int              ll_sa_max;     /* max statahead RPCs */
707         atomic_t                  ll_sa_total;   /* statahead thread started
708                                                   * count */
709         atomic_t                  ll_sa_wrong;   /* statahead thread stopped for
710                                                   * low hit ratio */
711         atomic_t                  ll_sa_running; /* running statahead thread
712                                                   * count */
713         atomic_t                  ll_agl_total;  /* AGL thread started count */
714
715         dev_t                     ll_sdev_orig; /* save s_dev before assign for
716                                                  * clustred nfs */
717         /* root squash */
718         struct root_squash_info   ll_squash;
719         struct path               ll_mnt;
720
721         /* st_blksize returned by stat(2), when non-zero */
722         unsigned int              ll_stat_blksize;
723
724         /* maximum relative age of cached statfs results */
725         unsigned int              ll_statfs_max_age;
726
727         struct kset               ll_kset;      /* sysfs object */
728         struct completion         ll_kobj_unregister;
729
730         /* File heat */
731         unsigned int              ll_heat_decay_weight;
732         unsigned int              ll_heat_period_second;
733
734         /* filesystem fsname */
735         char                      ll_fsname[LUSTRE_MAXFSNAME + 1];
736
737         /* Persistent Client Cache */
738         struct pcc_super          ll_pcc_super;
739 };
740
741 #define SBI_DEFAULT_HEAT_DECAY_WEIGHT   ((80 * 256 + 50) / 100)
742 #define SBI_DEFAULT_HEAT_PERIOD_SECOND  (60)
743 /*
744  * per file-descriptor read-ahead data.
745  */
746 struct ll_readahead_state {
747         spinlock_t      ras_lock;
748         /* End byte that read(2) try to read.  */
749         loff_t          ras_last_read_end_bytes;
750         /*
751          * number of bytes read after last read-ahead window reset. As window
752          * is reset on each seek, this is effectively a number of consecutive
753          * accesses. Maybe ->ras_accessed_in_window is better name.
754          *
755          * XXX nikita: window is also reset (by ras_update()) when Lustre
756          * believes that memory pressure evicts read-ahead pages. In that
757          * case, it probably doesn't make sense to expand window to
758          * PTLRPC_MAX_BRW_PAGES on the third access.
759          */
760         loff_t          ras_consecutive_bytes;
761         /*
762          * number of read requests after the last read-ahead window reset
763          * As window is reset on each seek, this is effectively the number
764          * on consecutive read request and is used to trigger read-ahead.
765          */
766         unsigned long   ras_consecutive_requests;
767         /*
768          * Parameters of current read-ahead window. Handled by
769          * ras_update(). On the initial access to the file or after a seek,
770          * window is reset to 0. After 3 consecutive accesses, window is
771          * expanded to PTLRPC_MAX_BRW_PAGES. Afterwards, window is enlarged by
772          * PTLRPC_MAX_BRW_PAGES chunks up to ->ra_max_pages.
773          */
774         pgoff_t         ras_window_start_idx;
775         pgoff_t         ras_window_pages;
776         /*
777          * Optimal RPC size in pages.
778          * It decides how many pages will be sent for each read-ahead.
779          */
780         unsigned long   ras_rpc_pages;
781         /*
782          * Where next read-ahead should start at. This lies within read-ahead
783          * window. Read-ahead window is read in pieces rather than at once
784          * because: 1. lustre limits total number of pages under read-ahead by
785          * ->ra_max_pages (see ll_ra_count_get()), 2. client cannot read pages
786          * not covered by DLM lock.
787          */
788         pgoff_t         ras_next_readahead_idx;
789         /*
790          * Total number of ll_file_read requests issued, reads originating
791          * due to mmap are not counted in this total.  This value is used to
792          * trigger full file read-ahead after multiple reads to a small file.
793          */
794         unsigned long   ras_requests;
795         /*
796          * The following 3 items are used for detecting the stride I/O
797          * mode.
798          * In stride I/O mode,
799          * ...............|-----data-----|****gap*****|--------|******|....
800          *    offset      |-stride_bytes-|-stride_gap-|
801          * ras_stride_offset = offset;
802          * ras_stride_length = stride_bytes + stride_gap;
803          * ras_stride_bytes = stride_bytes;
804          * Note: all these three items are counted by bytes.
805          */
806         loff_t          ras_stride_offset;
807         loff_t          ras_stride_length;
808         loff_t          ras_stride_bytes;
809         /*
810          * number of consecutive stride request count, and it is similar as
811          * ras_consecutive_requests, but used for stride I/O mode.
812          * Note: only more than 2 consecutive stride request are detected,
813          * stride read-ahead will be enable
814          */
815         unsigned long   ras_consecutive_stride_requests;
816         /* index of the last page that async readahead starts */
817         pgoff_t         ras_async_last_readpage_idx;
818         /* whether we should increase readahead window */
819         bool            ras_need_increase_window;
820         /* whether ra miss check should be skipped */
821         bool            ras_no_miss_check;
822 };
823
824 struct ll_readahead_work {
825         /** File to readahead */
826         struct file                     *lrw_file;
827         pgoff_t                          lrw_start_idx;
828         pgoff_t                          lrw_end_idx;
829
830         /* async worker to handler read */
831         struct work_struct               lrw_readahead_work;
832         char                             lrw_jobid[LUSTRE_JOBID_SIZE];
833 };
834
835 extern struct kmem_cache *ll_file_data_slab;
836 struct lustre_handle;
837 struct ll_file_data {
838         struct ll_readahead_state fd_ras;
839         struct ll_grouplock fd_grouplock;
840         __u64 lfd_pos;
841         __u32 fd_flags;
842         fmode_t fd_omode;
843         /* openhandle if lease exists for this file.
844          * Borrow lli->lli_och_mutex to protect assignment */
845         struct obd_client_handle *fd_lease_och;
846         struct obd_client_handle *fd_och;
847         struct file *fd_file;
848         /* Indicate whether need to report failure when close.
849          * true: failure is known, not report again.
850          * false: unknown failure, should report. */
851         bool fd_write_failed;
852         bool ll_lock_no_expand;
853         rwlock_t fd_lock; /* protect lcc list */
854         struct list_head fd_lccs; /* list of ll_cl_context */
855         /* Used by mirrored file to lead IOs to a specific mirror, usually
856          * for mirror resync. 0 means default. */
857         __u32 fd_designated_mirror;
858         /* The layout version when resync starts. Resync I/O should carry this
859          * layout version for verification to OST objects */
860         __u32 fd_layout_version;
861         struct pcc_file fd_pcc_file;
862 };
863
864 void llite_tunables_unregister(void);
865 int llite_tunables_register(void);
866
867 static inline struct inode *ll_info2i(struct ll_inode_info *lli)
868 {
869         return &lli->lli_vfs_inode;
870 }
871
872 __u32 ll_i2suppgid(struct inode *i);
873 void ll_i2gids(__u32 *suppgids, struct inode *i1,struct inode *i2);
874
875 static inline int ll_need_32bit_api(struct ll_sb_info *sbi)
876 {
877 #if BITS_PER_LONG == 32
878         return 1;
879 #elif defined(CONFIG_COMPAT)
880         if (unlikely(sbi->ll_flags & LL_SBI_32BIT_API))
881                 return true;
882
883 # ifdef CONFIG_X86_X32
884         /* in_compat_syscall() returns true when called from a kthread
885          * and CONFIG_X86_X32 is enabled, which is wrong. So check
886          * whether the caller comes from a syscall (ie. not a kthread)
887          * before calling in_compat_syscall(). */
888         if (current->flags & PF_KTHREAD)
889                 return false;
890 # endif
891
892         return unlikely(in_compat_syscall());
893 #else
894         return unlikely(sbi->ll_flags & LL_SBI_32BIT_API);
895 #endif
896 }
897
898 static inline bool ll_sbi_has_fast_read(struct ll_sb_info *sbi)
899 {
900         return !!(sbi->ll_flags & LL_SBI_FAST_READ);
901 }
902
903 static inline bool ll_sbi_has_tiny_write(struct ll_sb_info *sbi)
904 {
905         return !!(sbi->ll_flags & LL_SBI_TINY_WRITE);
906 }
907
908 static inline bool ll_sbi_has_file_heat(struct ll_sb_info *sbi)
909 {
910         return !!(sbi->ll_flags & LL_SBI_FILE_HEAT);
911 }
912
913 void ll_ras_enter(struct file *f, loff_t pos, size_t count);
914
915 /* llite/lcommon_misc.c */
916 int cl_ocd_update(struct obd_device *host, struct obd_device *watched,
917                   enum obd_notify_event ev, void *owner);
918 int cl_get_grouplock(struct cl_object *obj, unsigned long gid, int nonblock,
919                      struct ll_grouplock *lg);
920 void cl_put_grouplock(struct ll_grouplock *lg);
921
922 /* llite/lproc_llite.c */
923 int ll_debugfs_register_super(struct super_block *sb, const char *name);
924 void ll_debugfs_unregister_super(struct super_block *sb);
925 void ll_stats_ops_tally(struct ll_sb_info *sbi, int op, long count);
926
927 enum {
928         LPROC_LL_READ_BYTES,
929         LPROC_LL_WRITE_BYTES,
930         LPROC_LL_READ,
931         LPROC_LL_WRITE,
932         LPROC_LL_IOCTL,
933         LPROC_LL_OPEN,
934         LPROC_LL_RELEASE,
935         LPROC_LL_MMAP,
936         LPROC_LL_FAULT,
937         LPROC_LL_MKWRITE,
938         LPROC_LL_LLSEEK,
939         LPROC_LL_FSYNC,
940         LPROC_LL_READDIR,
941         LPROC_LL_SETATTR,
942         LPROC_LL_TRUNC,
943         LPROC_LL_FLOCK,
944         LPROC_LL_GETATTR,
945         LPROC_LL_CREATE,
946         LPROC_LL_LINK,
947         LPROC_LL_UNLINK,
948         LPROC_LL_SYMLINK,
949         LPROC_LL_MKDIR,
950         LPROC_LL_RMDIR,
951         LPROC_LL_MKNOD,
952         LPROC_LL_RENAME,
953         LPROC_LL_STATFS,
954         LPROC_LL_SETXATTR,
955         LPROC_LL_GETXATTR,
956         LPROC_LL_GETXATTR_HITS,
957         LPROC_LL_LISTXATTR,
958         LPROC_LL_REMOVEXATTR,
959         LPROC_LL_INODE_PERM,
960         LPROC_LL_FALLOCATE,
961         LPROC_LL_FILE_OPCODES
962 };
963
964 /* llite/dir.c */
965 enum get_default_layout_type {
966         GET_DEFAULT_LAYOUT_ROOT = 1,
967 };
968
969 struct ll_dir_chain {
970 };
971
972 static inline void ll_dir_chain_init(struct ll_dir_chain *chain)
973 {
974 }
975
976 static inline void ll_dir_chain_fini(struct ll_dir_chain *chain)
977 {
978 }
979
980 extern const struct file_operations ll_dir_operations;
981 extern const struct inode_operations ll_dir_inode_operations;
982 #ifdef HAVE_DIR_CONTEXT
983 int ll_dir_read(struct inode *inode, __u64 *pos, struct md_op_data *op_data,
984                 struct dir_context *ctx);
985 #else
986 int ll_dir_read(struct inode *inode, __u64 *pos, struct md_op_data *op_data,
987                 void *cookie, filldir_t filldir);
988 #endif
989 int ll_get_mdt_idx(struct inode *inode);
990 int ll_get_mdt_idx_by_fid(struct ll_sb_info *sbi, const struct lu_fid *fid);
991 struct page *ll_get_dir_page(struct inode *dir, struct md_op_data *op_data,
992                              __u64 offset, struct ll_dir_chain *chain);
993 void ll_release_page(struct inode *inode, struct page *page, bool remove);
994
995 /* llite/namei.c */
996 extern const struct inode_operations ll_special_inode_operations;
997
998 struct inode *ll_iget(struct super_block *sb, ino_t hash,
999                       struct lustre_md *lic);
1000 int ll_test_inode_by_fid(struct inode *inode, void *opaque);
1001 int ll_md_blocking_ast(struct ldlm_lock *, struct ldlm_lock_desc *,
1002                        void *data, int flag);
1003 struct dentry *ll_splice_alias(struct inode *inode, struct dentry *de);
1004 int ll_rmdir_entry(struct inode *dir, char *name, int namelen);
1005 void ll_update_times(struct ptlrpc_request *request, struct inode *inode);
1006
1007 /* llite/rw.c */
1008 int ll_writepage(struct page *page, struct writeback_control *wbc);
1009 int ll_writepages(struct address_space *, struct writeback_control *wbc);
1010 int ll_readpage(struct file *file, struct page *page);
1011 int ll_io_read_page(const struct lu_env *env, struct cl_io *io,
1012                            struct cl_page *page, struct file *file);
1013 void ll_readahead_init(struct inode *inode, struct ll_readahead_state *ras);
1014 int vvp_io_write_commit(const struct lu_env *env, struct cl_io *io);
1015
1016 enum lcc_type;
1017 void ll_cl_add(struct file *file, const struct lu_env *env, struct cl_io *io,
1018                enum lcc_type type);
1019 void ll_cl_remove(struct file *file, const struct lu_env *env);
1020 struct ll_cl_context *ll_cl_find(struct file *file);
1021
1022 extern const struct address_space_operations ll_aops;
1023
1024 /* llite/file.c */
1025 extern struct file_operations ll_file_operations;
1026 extern struct file_operations ll_file_operations_flock;
1027 extern struct file_operations ll_file_operations_noflock;
1028 extern struct inode_operations ll_file_inode_operations;
1029 extern int ll_have_md_lock(struct inode *inode, __u64 *bits,
1030                            enum ldlm_mode l_req_mode);
1031 extern enum ldlm_mode ll_take_md_lock(struct inode *inode, __u64 bits,
1032                                       struct lustre_handle *lockh, __u64 flags,
1033                                       enum ldlm_mode mode);
1034
1035 int ll_file_open(struct inode *inode, struct file *file);
1036 int ll_file_release(struct inode *inode, struct file *file);
1037 int ll_release_openhandle(struct dentry *, struct lookup_intent *);
1038 int ll_md_real_close(struct inode *inode, fmode_t fmode);
1039 extern void ll_rw_stats_tally(struct ll_sb_info *sbi, pid_t pid,
1040                               struct ll_file_data *file, loff_t pos,
1041                               size_t count, int rw);
1042 #ifdef HAVE_INODEOPS_ENHANCED_GETATTR
1043 int ll_getattr(const struct path *path, struct kstat *stat,
1044                u32 request_mask, unsigned int flags);
1045 #else
1046 int ll_getattr(struct vfsmount *mnt, struct dentry *de, struct kstat *stat);
1047 #endif
1048 int ll_getattr_dentry(struct dentry *de, struct kstat *stat, u32 request_mask,
1049                       unsigned int flags);
1050 struct posix_acl *ll_get_acl(struct inode *inode, int type);
1051 #ifdef HAVE_IOP_SET_ACL
1052 #ifdef CONFIG_LUSTRE_FS_POSIX_ACL
1053 int ll_set_acl(struct inode *inode, struct posix_acl *acl, int type);
1054 #else  /* !CONFIG_LUSTRE_FS_POSIX_ACL */
1055 #define ll_set_acl NULL
1056 #endif /* CONFIG_LUSTRE_FS_POSIX_ACL */
1057
1058 #endif
1059
1060 static inline int ll_xflags_to_inode_flags(int xflags)
1061 {
1062         return ((xflags & FS_XFLAG_SYNC)      ? S_SYNC      : 0) |
1063                ((xflags & FS_XFLAG_NOATIME)   ? S_NOATIME   : 0) |
1064                ((xflags & FS_XFLAG_APPEND)    ? S_APPEND    : 0) |
1065                ((xflags & FS_XFLAG_IMMUTABLE) ? S_IMMUTABLE : 0);
1066 }
1067
1068 static inline int ll_inode_flags_to_xflags(int flags)
1069 {
1070         return ((flags & S_SYNC)      ? FS_XFLAG_SYNC      : 0) |
1071                ((flags & S_NOATIME)   ? FS_XFLAG_NOATIME   : 0) |
1072                ((flags & S_APPEND)    ? FS_XFLAG_APPEND    : 0) |
1073                ((flags & S_IMMUTABLE) ? FS_XFLAG_IMMUTABLE : 0);
1074 }
1075
1076 int ll_migrate(struct inode *parent, struct file *file,
1077                struct lmv_user_md *lum, const char *name);
1078 int ll_get_fid_by_name(struct inode *parent, const char *name,
1079                        int namelen, struct lu_fid *fid, struct inode **inode);
1080 int ll_inode_permission(struct inode *inode, int mask);
1081 int ll_ioctl_check_project(struct inode *inode, struct fsxattr *fa);
1082 int ll_ioctl_fsgetxattr(struct inode *inode, unsigned int cmd,
1083                         unsigned long arg);
1084 int ll_ioctl_fssetxattr(struct inode *inode, unsigned int cmd,
1085                         unsigned long arg);
1086
1087 int ll_lov_setstripe_ea_info(struct inode *inode, struct dentry *dentry,
1088                              __u64 flags, struct lov_user_md *lum,
1089                              int lum_size);
1090 int ll_lov_getstripe_ea_info(struct inode *inode, const char *filename,
1091                              struct lov_mds_md **lmm, int *lmm_size,
1092                              struct ptlrpc_request **request);
1093 int ll_dir_setstripe(struct inode *inode, struct lov_user_md *lump,
1094                      int set_default);
1095 int ll_dir_getstripe_default(struct inode *inode, void **lmmp,
1096                              int *lmm_size, struct ptlrpc_request **request,
1097                              struct ptlrpc_request **root_request, u64 valid);
1098 int ll_dir_getstripe(struct inode *inode, void **plmm, int *plmm_size,
1099                      struct ptlrpc_request **request, u64 valid);
1100 int ll_fsync(struct file *file, loff_t start, loff_t end, int data);
1101 int ll_merge_attr(const struct lu_env *env, struct inode *inode);
1102 int ll_fid2path(struct inode *inode, void __user *arg);
1103 int ll_data_version(struct inode *inode, __u64 *data_version, int flags);
1104 int ll_hsm_release(struct inode *inode);
1105 int ll_hsm_state_set(struct inode *inode, struct hsm_state_set *hss);
1106 void ll_io_set_mirror(struct cl_io *io, const struct file *file);
1107
1108 /* llite/dcache.c */
1109
1110 int ll_d_init(struct dentry *de);
1111 extern const struct dentry_operations ll_d_ops;
1112 void ll_intent_drop_lock(struct lookup_intent *);
1113 void ll_intent_release(struct lookup_intent *);
1114 void ll_invalidate_aliases(struct inode *);
1115 void ll_lookup_finish_locks(struct lookup_intent *it, struct dentry *dentry);
1116 int ll_revalidate_it_finish(struct ptlrpc_request *request,
1117                             struct lookup_intent *it, struct dentry *de);
1118
1119 /* llite/llite_lib.c */
1120 extern struct super_operations lustre_super_operations;
1121
1122 void ll_lli_init(struct ll_inode_info *lli);
1123 int ll_fill_super(struct super_block *sb);
1124 void ll_put_super(struct super_block *sb);
1125 void ll_kill_super(struct super_block *sb);
1126 struct inode *ll_inode_from_resource_lock(struct ldlm_lock *lock);
1127 void ll_dir_clear_lsm_md(struct inode *inode);
1128 void ll_clear_inode(struct inode *inode);
1129 int ll_setattr_raw(struct dentry *dentry, struct iattr *attr,
1130                    enum op_xvalid xvalid, bool hsm_import);
1131 int ll_setattr(struct dentry *de, struct iattr *attr);
1132 int ll_statfs(struct dentry *de, struct kstatfs *sfs);
1133 int ll_statfs_internal(struct ll_sb_info *sbi, struct obd_statfs *osfs,
1134                        u32 flags);
1135 int ll_update_inode(struct inode *inode, struct lustre_md *md);
1136 void ll_update_inode_flags(struct inode *inode, int ext_flags);
1137 int ll_read_inode2(struct inode *inode, void *opaque);
1138 void ll_delete_inode(struct inode *inode);
1139 int ll_iocontrol(struct inode *inode, struct file *file,
1140                  unsigned int cmd, unsigned long arg);
1141 int ll_flush_ctx(struct inode *inode);
1142 void ll_umount_begin(struct super_block *sb);
1143 int ll_remount_fs(struct super_block *sb, int *flags, char *data);
1144 int ll_show_options(struct seq_file *seq, struct dentry *dentry);
1145 void ll_dirty_page_discard_warn(struct page *page, int ioret);
1146 int ll_prep_inode(struct inode **inode, struct ptlrpc_request *req,
1147                   struct super_block *, struct lookup_intent *);
1148 int ll_obd_statfs(struct inode *inode, void __user *arg);
1149 int ll_get_max_mdsize(struct ll_sb_info *sbi, int *max_mdsize);
1150 int ll_get_default_mdsize(struct ll_sb_info *sbi, int *default_mdsize);
1151 int ll_set_default_mdsize(struct ll_sb_info *sbi, int default_mdsize);
1152
1153 void ll_unlock_md_op_lsm(struct md_op_data *op_data);
1154 struct md_op_data *ll_prep_md_op_data(struct md_op_data *op_data,
1155                                       struct inode *i1, struct inode *i2,
1156                                       const char *name, size_t namelen,
1157                                       __u32 mode, enum md_op_code opc,
1158                                       void *data);
1159 void ll_finish_md_op_data(struct md_op_data *op_data);
1160 int ll_get_obd_name(struct inode *inode, unsigned int cmd, unsigned long arg);
1161 void ll_compute_rootsquash_state(struct ll_sb_info *sbi);
1162 ssize_t ll_copy_user_md(const struct lov_user_md __user *md,
1163                         struct lov_user_md **kbuf);
1164 void ll_open_cleanup(struct super_block *sb, struct ptlrpc_request *open_req);
1165
1166 void ll_dom_finish_open(struct inode *inode, struct ptlrpc_request *req,
1167                         struct lookup_intent *it);
1168
1169 /* Compute expected user md size when passing in a md from user space */
1170 static inline ssize_t ll_lov_user_md_size(const struct lov_user_md *lum)
1171 {
1172         switch (lum->lmm_magic) {
1173         case LOV_USER_MAGIC_V1:
1174                 return sizeof(struct lov_user_md_v1);
1175         case LOV_USER_MAGIC_V3:
1176                 return sizeof(struct lov_user_md_v3);
1177         case LOV_USER_MAGIC_SPECIFIC:
1178                 if (lum->lmm_stripe_count > LOV_MAX_STRIPE_COUNT)
1179                         return -EINVAL;
1180
1181                 return lov_user_md_size(lum->lmm_stripe_count,
1182                                         LOV_USER_MAGIC_SPECIFIC);
1183         case LOV_USER_MAGIC_COMP_V1:
1184                 return ((struct lov_comp_md_v1 *)lum)->lcm_size;
1185         case LOV_USER_MAGIC_FOREIGN:
1186                 return foreign_size(lum);
1187         }
1188
1189         return -EINVAL;
1190 }
1191
1192 /* llite/llite_nfs.c */
1193 extern struct export_operations lustre_export_operations;
1194 __u32 get_uuid2int(const char *name, int len);
1195 struct inode *search_inode_for_lustre(struct super_block *sb,
1196                                       const struct lu_fid *fid);
1197 int ll_dir_get_parent_fid(struct inode *dir, struct lu_fid *parent_fid);
1198
1199 /* llite/symlink.c */
1200 extern struct inode_operations ll_fast_symlink_inode_operations;
1201
1202 /**
1203  * IO arguments for various VFS I/O interfaces.
1204  */
1205 struct vvp_io_args {
1206         /** normal/sendfile/splice */
1207         enum vvp_io_subtype via_io_subtype;
1208
1209         union {
1210                 struct {
1211                         struct kiocb      *via_iocb;
1212                         struct iov_iter   *via_iter;
1213                 } normal;
1214                 struct {
1215                         struct pipe_inode_info  *via_pipe;
1216                         unsigned int       via_flags;
1217                 } splice;
1218         } u;
1219 };
1220
1221 enum lcc_type {
1222         LCC_RW = 1,
1223         LCC_MMAP
1224 };
1225
1226 struct ll_cl_context {
1227         struct list_head         lcc_list;
1228         void                    *lcc_cookie;
1229         const struct lu_env     *lcc_env;
1230         struct cl_io            *lcc_io;
1231         struct cl_page          *lcc_page;
1232         enum lcc_type            lcc_type;
1233 };
1234
1235 struct ll_thread_info {
1236         struct vvp_io_args      lti_args;
1237         struct ra_io_arg        lti_ria;
1238         struct ll_cl_context    lti_io_ctx;
1239 };
1240
1241 extern struct lu_context_key ll_thread_key;
1242
1243 static inline struct ll_thread_info *ll_env_info(const struct lu_env *env)
1244 {
1245         struct ll_thread_info *lti;
1246
1247         lti = lu_context_key_get(&env->le_ctx, &ll_thread_key);
1248         LASSERT(lti != NULL);
1249
1250         return lti;
1251 }
1252
1253 static inline struct vvp_io_args *ll_env_args(const struct lu_env *env,
1254                                               enum vvp_io_subtype type)
1255 {
1256         struct vvp_io_args *via = &ll_env_info(env)->lti_args;
1257
1258         via->via_io_subtype = type;
1259
1260         return via;
1261 }
1262
1263 void ll_io_init(struct cl_io *io, struct file *file, enum cl_io_type iot,
1264                 struct vvp_io_args *args);
1265
1266 /* llite/llite_mmap.c */
1267
1268 int ll_teardown_mmaps(struct address_space *mapping, __u64 first, __u64 last);
1269 int ll_file_mmap(struct file * file, struct vm_area_struct * vma);
1270 void policy_from_vma(union ldlm_policy_data *policy, struct vm_area_struct *vma,
1271                      unsigned long addr, size_t count);
1272 struct vm_area_struct *our_vma(struct mm_struct *mm, unsigned long addr,
1273                                size_t count);
1274
1275 #define    ll_s2sbi(sb)        (s2lsi(sb)->lsi_llsbi)
1276
1277 /* don't need an addref as the sb_info should be holding one */
1278 static inline struct obd_export *ll_s2dtexp(struct super_block *sb)
1279 {
1280         return ll_s2sbi(sb)->ll_dt_exp;
1281 }
1282
1283 /* don't need an addref as the sb_info should be holding one */
1284 static inline struct obd_export *ll_s2mdexp(struct super_block *sb)
1285 {
1286         return ll_s2sbi(sb)->ll_md_exp;
1287 }
1288
1289 static inline struct client_obd *sbi2mdc(struct ll_sb_info *sbi)
1290 {
1291         struct obd_device *obd = sbi->ll_md_exp->exp_obd;
1292         if (obd == NULL)
1293                 LBUG();
1294         return &obd->u.cli;
1295 }
1296
1297 // FIXME: replace the name of this with LL_SB to conform to kernel stuff
1298 static inline struct ll_sb_info *ll_i2sbi(struct inode *inode)
1299 {
1300         return ll_s2sbi(inode->i_sb);
1301 }
1302
1303 static inline struct obd_export *ll_i2dtexp(struct inode *inode)
1304 {
1305         return ll_s2dtexp(inode->i_sb);
1306 }
1307
1308 static inline struct obd_export *ll_i2mdexp(struct inode *inode)
1309 {
1310         return ll_s2mdexp(inode->i_sb);
1311 }
1312
1313 static inline struct lu_fid *ll_inode2fid(struct inode *inode)
1314 {
1315         struct lu_fid *fid;
1316
1317         LASSERT(inode != NULL);
1318         fid = &ll_i2info(inode)->lli_fid;
1319
1320         return fid;
1321 }
1322
1323 static inline bool ll_dir_striped(struct inode *inode)
1324 {
1325         LASSERT(inode);
1326         return S_ISDIR(inode->i_mode) &&
1327                lmv_dir_striped(ll_i2info(inode)->lli_lsm_md);
1328 }
1329
1330 static inline loff_t ll_file_maxbytes(struct inode *inode)
1331 {
1332         struct cl_object *obj = ll_i2info(inode)->lli_clob;
1333
1334         if (obj == NULL)
1335                 return MAX_LFS_FILESIZE;
1336
1337         return min_t(loff_t, cl_object_maxbytes(obj), MAX_LFS_FILESIZE);
1338 }
1339
1340 /* llite/xattr.c */
1341 extern const struct xattr_handler *ll_xattr_handlers[];
1342
1343 #define XATTR_USER_T            1
1344 #define XATTR_TRUSTED_T         2
1345 #define XATTR_SECURITY_T        3
1346 #define XATTR_ACL_ACCESS_T      4
1347 #define XATTR_ACL_DEFAULT_T     5
1348 #define XATTR_LUSTRE_T          6
1349 #define XATTR_OTHER_T           7
1350
1351 ssize_t ll_listxattr(struct dentry *dentry, char *buffer, size_t size);
1352 int ll_xattr_list(struct inode *inode, const char *name, int type,
1353                   void *buffer, size_t size, u64 valid);
1354 const struct xattr_handler *get_xattr_type(const char *name);
1355
1356 /**
1357  * Common IO arguments for various VFS I/O interfaces.
1358  */
1359 int cl_sb_init(struct super_block *sb);
1360 int cl_sb_fini(struct super_block *sb);
1361
1362 enum ras_update_flags {
1363         LL_RAS_HIT  = 0x1,
1364         LL_RAS_MMAP = 0x2
1365 };
1366 void ll_ra_count_put(struct ll_sb_info *sbi, unsigned long len);
1367 void ll_ra_stats_inc(struct inode *inode, enum ra_stat which);
1368
1369 /* statahead.c */
1370
1371 #define LL_SA_RPC_MIN           2
1372 #define LL_SA_RPC_DEF           32
1373 #define LL_SA_RPC_MAX           512
1374
1375 /* XXX: If want to support more concurrent statahead instances,
1376  *      please consider to decentralize the RPC lists attached
1377  *      on related import, such as imp_{sending,delayed}_list.
1378  *      LU-11079 */
1379 #define LL_SA_RUNNING_MAX       256
1380 #define LL_SA_RUNNING_DEF       16
1381
1382 #define LL_SA_CACHE_BIT         5
1383 #define LL_SA_CACHE_SIZE        (1 << LL_SA_CACHE_BIT)
1384 #define LL_SA_CACHE_MASK        (LL_SA_CACHE_SIZE - 1)
1385
1386 /* per inode struct, for dir only */
1387 struct ll_statahead_info {
1388         struct dentry          *sai_dentry;
1389         atomic_t                sai_refcount;   /* when access this struct, hold
1390                                                  * refcount */
1391         unsigned int            sai_max;        /* max ahead of lookup */
1392         __u64                   sai_sent;       /* stat requests sent count */
1393         __u64                   sai_replied;    /* stat requests which received
1394                                                  * reply */
1395         __u64                   sai_index;      /* index of statahead entry */
1396         __u64                   sai_index_wait; /* index of entry which is the
1397                                                  * caller is waiting for */
1398         __u64                   sai_hit;        /* hit count */
1399         __u64                   sai_miss;       /* miss count:
1400                                                  * for "ls -al" case, includes
1401                                                  * hidden dentry miss;
1402                                                  * for "ls -l" case, it does not
1403                                                  * include hidden dentry miss.
1404                                                  * "sai_miss_hidden" is used for
1405                                                  * the later case.
1406                                                  */
1407         unsigned int            sai_consecutive_miss; /* consecutive miss */
1408         unsigned int            sai_miss_hidden;/* "ls -al", but first dentry
1409                                                  * is not a hidden one */
1410         unsigned int            sai_skip_hidden;/* skipped hidden dentry count
1411                                                  */
1412         unsigned int            sai_ls_all:1,   /* "ls -al", do stat-ahead for
1413                                                  * hidden entries */
1414                                 sai_agl_valid:1,/* AGL is valid for the dir */
1415                                 sai_in_readpage:1;/* statahead is in readdir()*/
1416         wait_queue_head_t       sai_waitq;      /* stat-ahead wait queue */
1417         struct task_struct      *sai_task;      /* stat-ahead thread */
1418         struct task_struct      *sai_agl_task;  /* AGL thread */
1419         struct list_head        sai_interim_entries; /* entries which got async
1420                                                       * stat reply, but not
1421                                                       * instantiated */
1422         struct list_head        sai_entries;    /* completed entries */
1423         struct list_head        sai_agls;       /* AGLs to be sent */
1424         struct list_head        sai_cache[LL_SA_CACHE_SIZE];
1425         spinlock_t              sai_cache_lock[LL_SA_CACHE_SIZE];
1426         atomic_t                sai_cache_count; /* entry count in cache */
1427 };
1428
1429 int ll_revalidate_statahead(struct inode *dir, struct dentry **dentry,
1430                             bool unplug);
1431 int ll_start_statahead(struct inode *dir, struct dentry *dentry, bool agl);
1432 void ll_authorize_statahead(struct inode *dir, void *key);
1433 void ll_deauthorize_statahead(struct inode *dir, void *key);
1434
1435 /* glimpse.c */
1436 blkcnt_t dirty_cnt(struct inode *inode);
1437
1438 int cl_glimpse_size0(struct inode *inode, int agl);
1439 int cl_glimpse_lock(const struct lu_env *env, struct cl_io *io,
1440                     struct inode *inode, struct cl_object *clob, int agl);
1441
1442 static inline int cl_glimpse_size(struct inode *inode)
1443 {
1444         return cl_glimpse_size0(inode, 0);
1445 }
1446
1447 /* AGL is 'asychronous glimpse lock', which is a speculative lock taken as
1448  * part of statahead */
1449 static inline int cl_agl(struct inode *inode)
1450 {
1451         return cl_glimpse_size0(inode, 1);
1452 }
1453
1454 int ll_file_lock_ahead(struct file *file, struct llapi_lu_ladvise *ladvise);
1455
1456 int cl_io_get(struct inode *inode, struct lu_env **envout,
1457               struct cl_io **ioout, __u16 *refcheck);
1458
1459 static inline int ll_glimpse_size(struct inode *inode)
1460 {
1461         struct ll_inode_info *lli = ll_i2info(inode);
1462         int rc;
1463
1464         down_read(&lli->lli_glimpse_sem);
1465         rc = cl_glimpse_size(inode);
1466         lli->lli_glimpse_time = ktime_get();
1467         up_read(&lli->lli_glimpse_sem);
1468         return rc;
1469 }
1470
1471 /* dentry may statahead when statahead is enabled and current process has opened
1472  * parent directory, and this dentry hasn't accessed statahead cache before */
1473 static inline bool
1474 dentry_may_statahead(struct inode *dir, struct dentry *dentry)
1475 {
1476         struct ll_inode_info  *lli;
1477         struct ll_dentry_data *ldd;
1478
1479         if (ll_i2sbi(dir)->ll_sa_max == 0)
1480                 return false;
1481
1482         lli = ll_i2info(dir);
1483
1484         /* statahead is not allowed for this dir, there may be three causes:
1485          * 1. dir is not opened.
1486          * 2. statahead hit ratio is too low.
1487          * 3. previous stat started statahead thread failed. */
1488         if (!lli->lli_sa_enabled)
1489                 return false;
1490
1491         /* not the same process, don't statahead */
1492         if (lli->lli_opendir_pid != current->pid)
1493                 return false;
1494
1495         /*
1496          * When stating a dentry, kernel may trigger 'revalidate' or 'lookup'
1497          * multiple times, eg. for 'getattr', 'getxattr' and etc.
1498          * For patchless client, lookup intent is not accurate, which may
1499          * misguide statahead. For example:
1500          * The 'revalidate' call for 'getattr' and 'getxattr' of a dentry will
1501          * have the same intent -- IT_GETATTR, while one dentry should access
1502          * statahead cache once, otherwise statahead windows is messed up.
1503          * The solution is as following:
1504          * Assign 'lld_sa_generation' with 'lli_sa_generation' when a dentry
1505          * IT_GETATTR for the first time, and subsequent IT_GETATTR will
1506          * bypass interacting with statahead cache by checking
1507          * 'lld_sa_generation == lli->lli_sa_generation'.
1508          */
1509         ldd = ll_d2d(dentry);
1510         if (ldd != NULL && lli->lli_sa_generation &&
1511             ldd->lld_sa_generation == lli->lli_sa_generation)
1512                 return false;
1513
1514         return true;
1515 }
1516
1517 int cl_sync_file_range(struct inode *inode, loff_t start, loff_t end,
1518                        enum cl_fsync_mode mode, int ignore_layout);
1519
1520 static inline int ll_file_nolock(const struct file *file)
1521 {
1522         struct ll_file_data *fd = file->private_data;
1523         struct inode *inode = file_inode((struct file *)file);
1524
1525         LASSERT(fd != NULL);
1526         return ((fd->fd_flags & LL_FILE_IGNORE_LOCK) ||
1527                 (ll_i2sbi(inode)->ll_flags & LL_SBI_NOLCK));
1528 }
1529
1530 static inline void ll_set_lock_data(struct obd_export *exp, struct inode *inode,
1531                                     struct lookup_intent *it, __u64 *bits)
1532 {
1533         if (!it->it_lock_set) {
1534                 struct lustre_handle handle;
1535
1536                 /* If this inode is a remote object, it will get two
1537                  * separate locks in different namespaces, Master MDT,
1538                  * where the name entry is, will grant LOOKUP lock,
1539                  * remote MDT, where the object is, will grant
1540                  * UPDATE|PERM lock. The inode will be attched to both
1541                  * LOOKUP and PERM locks, so revoking either locks will
1542                  * case the dcache being cleared */
1543                 if (it->it_remote_lock_mode) {
1544                         handle.cookie = it->it_remote_lock_handle;
1545                         CDEBUG(D_DLMTRACE, "setting l_data to inode "DFID
1546                                "(%p) for remote lock %#llx\n",
1547                                PFID(ll_inode2fid(inode)), inode,
1548                                handle.cookie);
1549                         md_set_lock_data(exp, &handle, inode, NULL);
1550                 }
1551
1552                 handle.cookie = it->it_lock_handle;
1553
1554                 CDEBUG(D_DLMTRACE, "setting l_data to inode "DFID"(%p)"
1555                        " for lock %#llx\n",
1556                        PFID(ll_inode2fid(inode)), inode, handle.cookie);
1557
1558                 md_set_lock_data(exp, &handle, inode, &it->it_lock_bits);
1559                 it->it_lock_set = 1;
1560         }
1561
1562         if (bits != NULL)
1563                 *bits = it->it_lock_bits;
1564 }
1565
1566 static inline int d_lustre_invalid(const struct dentry *dentry)
1567 {
1568         struct ll_dentry_data *lld = ll_d2d(dentry);
1569
1570         return (lld == NULL) || lld->lld_invalid;
1571 }
1572
1573 static inline void __d_lustre_invalidate(struct dentry *dentry)
1574 {
1575         struct ll_dentry_data *lld = ll_d2d(dentry);
1576
1577         if (lld != NULL)
1578                 lld->lld_invalid = 1;
1579 }
1580
1581 /*
1582  * Mark dentry INVALID, if dentry refcount is zero (this is normally case for
1583  * ll_md_blocking_ast), unhash this dentry, and let dcache to reclaim it later;
1584  * else dput() of the last refcount will unhash this dentry and kill it.
1585  */
1586 static inline void d_lustre_invalidate(struct dentry *dentry, int nested)
1587 {
1588         CDEBUG(D_DENTRY, "invalidate dentry %pd (%p) parent %p inode %p refc %d\n",
1589                dentry, dentry,
1590                dentry->d_parent, dentry->d_inode, ll_d_count(dentry));
1591
1592         spin_lock_nested(&dentry->d_lock,
1593                          nested ? DENTRY_D_LOCK_NESTED : DENTRY_D_LOCK_NORMAL);
1594         __d_lustre_invalidate(dentry);
1595         /*
1596          * We should be careful about dentries created by d_obtain_alias().
1597          * These dentries are not put in the dentry tree, instead they are
1598          * linked to sb->s_anon through dentry->d_hash.
1599          * shrink_dcache_for_umount() shrinks the tree and sb->s_anon list.
1600          * If we unhashed such a dentry, unmount would not be able to find
1601          * it and busy inodes would be reported.
1602          */
1603         if (ll_d_count(dentry) == 0 && !(dentry->d_flags & DCACHE_DISCONNECTED))
1604                 __d_drop(dentry);
1605         spin_unlock(&dentry->d_lock);
1606 }
1607
1608 static inline void d_lustre_revalidate(struct dentry *dentry)
1609 {
1610         spin_lock(&dentry->d_lock);
1611         LASSERT(ll_d2d(dentry) != NULL);
1612         ll_d2d(dentry)->lld_invalid = 0;
1613         spin_unlock(&dentry->d_lock);
1614 }
1615
1616 static inline dev_t ll_compat_encode_dev(dev_t dev)
1617 {
1618         /* The compat_sys_*stat*() syscalls will fail unless the
1619          * device majors and minors are both less than 256. Note that
1620          * the value returned here will be passed through
1621          * old_encode_dev() in cp_compat_stat(). And so we are not
1622          * trying to return a valid compat (u16) device number, just
1623          * one that will pass the old_valid_dev() check. */
1624
1625         return MKDEV(MAJOR(dev) & 0xff, MINOR(dev) & 0xff);
1626 }
1627
1628 int ll_layout_conf(struct inode *inode, const struct cl_object_conf *conf);
1629 int ll_layout_refresh(struct inode *inode, __u32 *gen);
1630 int ll_layout_restore(struct inode *inode, loff_t start, __u64 length);
1631 int ll_layout_write_intent(struct inode *inode, enum layout_intent_opc opc,
1632                            struct lu_extent *ext);
1633
1634 int ll_xattr_init(void);
1635 void ll_xattr_fini(void);
1636
1637 int ll_page_sync_io(const struct lu_env *env, struct cl_io *io,
1638                     struct cl_page *page, enum cl_req_type crt);
1639
1640 int ll_getparent(struct file *file, struct getparent __user *arg);
1641
1642 /* lcommon_cl.c */
1643 int cl_setattr_ost(struct cl_object *obj, const struct iattr *attr,
1644                    enum op_xvalid xvalid, unsigned int attr_flags);
1645
1646 extern struct lu_env *cl_inode_fini_env;
1647 extern __u16 cl_inode_fini_refcheck;
1648
1649 int cl_file_inode_init(struct inode *inode, struct lustre_md *md);
1650 void cl_inode_fini(struct inode *inode);
1651
1652 u64 cl_fid_build_ino(const struct lu_fid *fid, int api32);
1653 u32 cl_fid_build_gen(const struct lu_fid *fid);
1654
1655 static inline struct pcc_super *ll_i2pccs(struct inode *inode)
1656 {
1657         return &ll_i2sbi(inode)->ll_pcc_super;
1658 }
1659
1660 static inline struct pcc_super *ll_info2pccs(struct ll_inode_info *lli)
1661 {
1662         return ll_i2pccs(ll_info2i(lli));
1663 }
1664
1665 #ifdef HAVE_LUSTRE_CRYPTO
1666 /* crypto.c */
1667 extern const struct llcrypt_operations lustre_cryptops;
1668 #endif
1669
1670 #endif /* LLITE_INTERNAL_H */