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