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