Whamcloud - gitweb
LU-4906 llite: read page from LMV/MDC for readdir
[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.sun.com/software/products/lustre/docs/GPLv2.pdf
19  *
20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21  * CA 95054 USA or visit www.sun.com if you need additional information or
22  * have any questions.
23  *
24  * GPL HEADER END
25  */
26 /*
27  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
28  * Use is subject to license terms.
29  *
30  * Copyright (c) 2011, 2013, Intel Corporation.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  */
36
37 #ifndef LLITE_INTERNAL_H
38 #define LLITE_INTERNAL_H
39 #include <lustre_debug.h>
40 #include <lustre_ver.h>
41 #include <lustre_disk.h>  /* for s2sbi */
42 #include <lustre_eacl.h>
43
44 /* for struct cl_lock_descr and struct cl_io */
45 #include <cl_object.h>
46 #include <lclient.h>
47 #include <lustre_lmv.h>
48 #include <lustre_mdc.h>
49 #include <linux/lustre_intent.h>
50 #include <linux/compat.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 #define LL_IT2STR(it) ((it) ? ldlm_it2str((it)->it_op) : "0")
71 #define LUSTRE_FPRIVATE(file) ((file)->private_data)
72
73 struct ll_dentry_data {
74         struct lookup_intent            *lld_it;
75         unsigned int                    lld_sa_generation;
76         unsigned int                    lld_invalid:1;
77         struct rcu_head                 lld_rcu_head;
78 };
79
80 #define ll_d2d(de) ((struct ll_dentry_data*)((de)->d_fsdata))
81
82 #define LLI_INODE_MAGIC                 0x111d0de5
83 #define LLI_INODE_DEAD                  0xdeadd00d
84
85 /* remote client permission cache */
86 #define REMOTE_PERM_HASHSIZE 16
87
88 struct ll_getname_data {
89 #ifdef HAVE_DIR_CONTEXT
90         struct dir_context      ctx;
91 #endif
92         char            *lgd_name;      /* points to a buffer with NAME_MAX+1 size */
93         struct lu_fid   lgd_fid;        /* target fid we are looking for */
94         int             lgd_found;      /* inode matched? */
95 };
96
97 /* llite setxid/access permission for user on remote client */
98 struct ll_remote_perm {
99         struct hlist_node       lrp_list;
100         uid_t                   lrp_uid;
101         gid_t                   lrp_gid;
102         uid_t                   lrp_fsuid;
103         gid_t                   lrp_fsgid;
104         int                     lrp_access_perm; /* MAY_READ/WRITE/EXEC, this
105                                                     is access permission with
106                                                     lrp_fsuid/lrp_fsgid. */
107 };
108
109 enum lli_flags {
110         /* MDS has an authority for the Size-on-MDS attributes. */
111         LLIF_MDS_SIZE_LOCK      = (1 << 0),
112         /* Epoch close is postponed. */
113         LLIF_EPOCH_PENDING      = (1 << 1),
114         /* DONE WRITING is allowed. */
115         LLIF_DONE_WRITING       = (1 << 2),
116         /* Sizeon-on-MDS attributes are changed. An attribute update needs to
117          * be sent to MDS. */
118         LLIF_SOM_DIRTY          = (1 << 3),
119         /* File data is modified. */
120         LLIF_DATA_MODIFIED      = (1 << 4),
121         /* File is being restored */
122         LLIF_FILE_RESTORING     = (1 << 5),
123         /* Xattr cache is attached to the file */
124         LLIF_XATTR_CACHE        = (1 << 6),
125 };
126
127 struct ll_inode_info {
128         __u32                           lli_inode_magic;
129         __u32                           lli_flags;
130         __u64                           lli_ioepoch;
131
132         spinlock_t                      lli_lock;
133         struct posix_acl                *lli_posix_acl;
134
135         struct hlist_head               *lli_remote_perms;
136         struct mutex                    lli_rmtperm_mutex;
137
138         /* identifying fields for both metadata and data stacks. */
139         struct lu_fid                   lli_fid;
140         /* Parent fid for accessing default stripe data on parent directory
141          * for allocating OST objects after a mknod() and later open-by-FID. */
142         struct lu_fid                   lli_pfid;
143
144         struct list_head                lli_close_list;
145         struct list_head                lli_oss_capas;
146         /* open count currently used by capability only, indicate whether
147          * capability needs renewal */
148         atomic_t                    lli_open_count;
149         struct obd_capa                *lli_mds_capa;
150         cfs_time_t                      lli_rmtperm_time;
151
152         /* handle is to be sent to MDS later on done_writing and setattr.
153          * Open handle data are needed for the recovery to reconstruct
154          * the inode state on the MDS. XXX: recovery is not ready yet. */
155         struct obd_client_handle       *lli_pending_och;
156
157         /* We need all three because every inode may be opened in different
158          * modes */
159         struct obd_client_handle       *lli_mds_read_och;
160         struct obd_client_handle       *lli_mds_write_och;
161         struct obd_client_handle       *lli_mds_exec_och;
162         __u64                           lli_open_fd_read_count;
163         __u64                           lli_open_fd_write_count;
164         __u64                           lli_open_fd_exec_count;
165         /* Protects access to och pointers and their usage counters */
166         struct mutex                    lli_och_mutex;
167
168         struct inode                    lli_vfs_inode;
169
170         /* the most recent timestamps obtained from mds */
171         struct ost_lvb                  lli_lvb;
172         spinlock_t                      lli_agl_lock;
173
174         /* Try to make the d::member and f::member are aligned. Before using
175          * these members, make clear whether it is directory or not. */
176         union {
177                 /* for directory */
178                 struct {
179                         /* serialize normal readdir and statahead-readdir. */
180                         struct mutex                    d_readdir_mutex;
181
182                         /* metadata statahead */
183                         /* since parent-child threads can share the same @file
184                          * struct, "opendir_key" is the token when dir close for
185                          * case of parent exit before child -- it is me should
186                          * cleanup the dir readahead. */
187                         void                           *d_opendir_key;
188                         struct ll_statahead_info       *d_sai;
189                         /* protect statahead stuff. */
190                         spinlock_t                      d_sa_lock;
191                         /* "opendir_pid" is the token when lookup/revalid
192                          * -- I am the owner of dir statahead. */
193                         pid_t                           d_opendir_pid;
194                         /* directory stripe information */
195                         struct lmv_stripe_md            *d_lsm_md;
196                         /* striped directory size */
197                         loff_t                          d_stripe_size;
198                         /* striped directory nlink */
199                         __u64                           d_stripe_nlink;
200                 } d;
201
202 #define lli_readdir_mutex       u.d.d_readdir_mutex
203 #define lli_opendir_key         u.d.d_opendir_key
204 #define lli_sai                 u.d.d_sai
205 #define lli_sa_lock             u.d.d_sa_lock
206 #define lli_opendir_pid         u.d.d_opendir_pid
207 #define lli_lsm_md              u.d.d_lsm_md
208 #define lli_stripe_dir_size     u.d.d_stripe_size
209 #define lli_stripe_dir_nlink    u.d.d_stripe_nlink
210
211                 /* for non-directory */
212                 struct {
213                         struct mutex                    f_size_mutex;
214                         char                            *f_symlink_name;
215                         __u64                           f_maxbytes;
216                         /*
217                          * struct rw_semaphore {
218                          *    signed long       count;     // align d.d_def_acl
219                          *    spinlock_t        wait_lock; // align d.d_sa_lock
220                          *    struct list_head wait_list;
221                          * }
222                          */
223                         struct rw_semaphore             f_trunc_sem;
224                         struct mutex                    f_write_mutex;
225
226                         struct rw_semaphore             f_glimpse_sem;
227                         cfs_time_t                      f_glimpse_time;
228                         struct list_head                        f_agl_list;
229                         __u64                           f_agl_index;
230
231                         /* for writepage() only to communicate to fsync */
232                         int                             f_async_rc;
233
234                         /*
235                          * whenever a process try to read/write the file, the
236                          * jobid of the process will be saved here, and it'll
237                          * be packed into the write PRC when flush later.
238                          *
239                          * so the read/write statistics for jobid will not be
240                          * accurate if the file is shared by different jobs.
241                          */
242                         char                     f_jobid[JOBSTATS_JOBID_SIZE];
243                 } f;
244
245 #define lli_size_mutex          u.f.f_size_mutex
246 #define lli_symlink_name        u.f.f_symlink_name
247 #define lli_maxbytes            u.f.f_maxbytes
248 #define lli_trunc_sem           u.f.f_trunc_sem
249 #define lli_write_mutex         u.f.f_write_mutex
250 #define lli_glimpse_sem         u.f.f_glimpse_sem
251 #define lli_glimpse_time        u.f.f_glimpse_time
252 #define lli_agl_list            u.f.f_agl_list
253 #define lli_agl_index           u.f.f_agl_index
254 #define lli_async_rc            u.f.f_async_rc
255 #define lli_jobid               u.f.f_jobid
256
257         } u;
258
259         /* XXX: For following frequent used members, although they maybe special
260          *      used for non-directory object, it is some time-wasting to check
261          *      whether the object is directory or not before using them. On the
262          *      other hand, currently, sizeof(f) > sizeof(d), it cannot reduce
263          *      the "ll_inode_info" size even if moving those members into u.f.
264          *      So keep them out side.
265          *
266          *      In the future, if more members are added only for directory,
267          *      some of the following members can be moved into u.f.
268          */
269         bool                            lli_has_smd;
270         struct cl_object               *lli_clob;
271
272         /* mutex to request for layout lock exclusively. */
273         struct mutex                    lli_layout_mutex;
274         /* Layout version, protected by lli_layout_lock */
275         __u32                           lli_layout_gen;
276         spinlock_t                      lli_layout_lock;
277
278         struct rw_semaphore             lli_xattrs_list_rwsem;
279         struct mutex                    lli_xattrs_enq_lock;
280         struct list_head                lli_xattrs; /* ll_xattr_entry->xe_list */
281 };
282
283 static inline __u32 ll_layout_version_get(struct ll_inode_info *lli)
284 {
285         __u32 gen;
286
287         spin_lock(&lli->lli_layout_lock);
288         gen = lli->lli_layout_gen;
289         spin_unlock(&lli->lli_layout_lock);
290
291         return gen;
292 }
293
294 static inline void ll_layout_version_set(struct ll_inode_info *lli, __u32 gen)
295 {
296         spin_lock(&lli->lli_layout_lock);
297         lli->lli_layout_gen = gen;
298         spin_unlock(&lli->lli_layout_lock);
299 }
300
301 int ll_xattr_cache_destroy(struct inode *inode);
302
303 int ll_xattr_cache_get(struct inode *inode,
304                         const char *name,
305                         char *buffer,
306                         size_t size,
307                         __u64 valid);
308
309 /*
310  * Locking to guarantee consistency of non-atomic updates to long long i_size,
311  * consistency between file size and KMS.
312  *
313  * Implemented by ->lli_size_mutex and ->lsm_lock, nested in that order.
314  */
315
316 void ll_inode_size_lock(struct inode *inode);
317 void ll_inode_size_unlock(struct inode *inode);
318
319 // FIXME: replace the name of this with LL_I to conform to kernel stuff
320 // static inline struct ll_inode_info *LL_I(struct inode *inode)
321 static inline struct ll_inode_info *ll_i2info(struct inode *inode)
322 {
323         return container_of(inode, struct ll_inode_info, lli_vfs_inode);
324 }
325
326 /* default to about 40meg of readahead on a given system.  That much tied
327  * up in 512k readahead requests serviced at 40ms each is about 1GB/s. */
328 #define SBI_DEFAULT_READAHEAD_MAX (40UL << (20 - PAGE_CACHE_SHIFT))
329
330 /* default to read-ahead full files smaller than 2MB on the second read */
331 #define SBI_DEFAULT_READAHEAD_WHOLE_MAX (2UL << (20 - PAGE_CACHE_SHIFT))
332
333 enum ra_stat {
334         RA_STAT_HIT = 0,
335         RA_STAT_MISS,
336         RA_STAT_DISTANT_READPAGE,
337         RA_STAT_MISS_IN_WINDOW,
338         RA_STAT_FAILED_GRAB_PAGE,
339         RA_STAT_FAILED_MATCH,
340         RA_STAT_DISCARDED,
341         RA_STAT_ZERO_LEN,
342         RA_STAT_ZERO_WINDOW,
343         RA_STAT_EOF,
344         RA_STAT_MAX_IN_FLIGHT,
345         RA_STAT_WRONG_GRAB_PAGE,
346         RA_STAT_FAILED_REACH_END,
347         _NR_RA_STAT,
348 };
349
350 struct ll_ra_info {
351         atomic_t        ra_cur_pages;
352         unsigned long   ra_max_pages;
353         unsigned long   ra_max_pages_per_file;
354         unsigned long   ra_max_read_ahead_whole_pages;
355 };
356
357 /* ra_io_arg will be filled in the beginning of ll_readahead with
358  * ras_lock, then the following ll_read_ahead_pages will read RA
359  * pages according to this arg, all the items in this structure are
360  * counted by page index.
361  */
362 struct ra_io_arg {
363         unsigned long ria_start;  /* start offset of read-ahead*/
364         unsigned long ria_end;    /* end offset of read-ahead*/
365         /* If stride read pattern is detected, ria_stoff means where
366          * stride read is started. Note: for normal read-ahead, the
367          * value here is meaningless, and also it will not be accessed*/
368         pgoff_t ria_stoff;
369         /* ria_length and ria_pages are the length and pages length in the
370          * stride I/O mode. And they will also be used to check whether
371          * it is stride I/O read-ahead in the read-ahead pages*/
372         unsigned long ria_length;
373         unsigned long ria_pages;
374 };
375
376 /* LL_HIST_MAX=32 causes an overflow */
377 #define LL_HIST_MAX 28
378 #define LL_HIST_START 12 /* buckets start at 2^12 = 4k */
379 #define LL_PROCESS_HIST_MAX 10
380 struct per_process_info {
381         pid_t pid;
382         struct obd_histogram pp_r_hist;
383         struct obd_histogram pp_w_hist;
384 };
385
386 /* pp_extents[LL_PROCESS_HIST_MAX] will hold the combined process info */
387 struct ll_rw_extents_info {
388         struct per_process_info pp_extents[LL_PROCESS_HIST_MAX + 1];
389 };
390
391 #define LL_OFFSET_HIST_MAX 100
392 struct ll_rw_process_info {
393         pid_t                     rw_pid;
394         int                       rw_op;
395         loff_t                    rw_range_start;
396         loff_t                    rw_range_end;
397         loff_t                    rw_last_file_pos;
398         loff_t                    rw_offset;
399         size_t                    rw_smallest_extent;
400         size_t                    rw_largest_extent;
401         struct ll_file_data      *rw_last_file;
402 };
403
404 enum stats_track_type {
405         STATS_TRACK_ALL = 0,  /* track all processes */
406         STATS_TRACK_PID,      /* track process with this pid */
407         STATS_TRACK_PPID,     /* track processes with this ppid */
408         STATS_TRACK_GID,      /* track processes with this gid */
409         STATS_TRACK_LAST,
410 };
411
412 /* flags for sbi->ll_flags */
413 #define LL_SBI_NOLCK             0x01 /* DLM locking disabled (directio-only) */
414 #define LL_SBI_CHECKSUM          0x02 /* checksum each page as it's written */
415 #define LL_SBI_FLOCK             0x04
416 #define LL_SBI_USER_XATTR        0x08 /* support user xattr */
417 #define LL_SBI_ACL               0x10 /* support ACL */
418 #define LL_SBI_RMT_CLIENT        0x40 /* remote client */
419 #define LL_SBI_MDS_CAPA          0x80 /* support mds capa */
420 #define LL_SBI_OSS_CAPA         0x100 /* support oss capa */
421 #define LL_SBI_LOCALFLOCK       0x200 /* Local flocks support by kernel */
422 #define LL_SBI_LRU_RESIZE       0x400 /* lru resize support */
423 #define LL_SBI_LAZYSTATFS       0x800 /* lazystatfs mount option */
424 #define LL_SBI_SOM_PREVIEW     0x1000 /* SOM preview mount option */
425 #define LL_SBI_32BIT_API       0x2000 /* generate 32 bit inodes. */
426 #define LL_SBI_64BIT_HASH      0x4000 /* support 64-bits dir hash/offset */
427 #define LL_SBI_AGL_ENABLED     0x8000 /* enable agl */
428 #define LL_SBI_VERBOSE        0x10000 /* verbose mount/umount */
429 #define LL_SBI_LAYOUT_LOCK    0x20000 /* layout lock support */
430 #define LL_SBI_USER_FID2PATH  0x40000 /* allow fid2path by unprivileged users */
431 #define LL_SBI_XATTR_CACHE    0x80000 /* support for xattr cache */
432 #define LL_SBI_NOROOTSQUASH  0x100000 /* do not apply root squash */
433
434 #define LL_SBI_FLAGS {  \
435         "nolck",        \
436         "checksum",     \
437         "flock",        \
438         "xattr",        \
439         "acl",          \
440         "???",          \
441         "rmt_client",   \
442         "mds_capa",     \
443         "oss_capa",     \
444         "flock",        \
445         "lru_resize",   \
446         "lazy_statfs",  \
447         "som",          \
448         "32bit_api",    \
449         "64bit_hash",   \
450         "agl",          \
451         "verbose",      \
452         "layout",       \
453         "user_fid2path",\
454         "xattr",        \
455         "norootsquash", \
456 }
457
458 #define RCE_HASHES      32
459
460 struct rmtacl_ctl_entry {
461         struct list_head       rce_list;
462         pid_t            rce_key; /* hash key */
463         int              rce_ops; /* acl operation type */
464 };
465
466 struct rmtacl_ctl_table {
467         spinlock_t      rct_lock;
468         struct list_head        rct_entries[RCE_HASHES];
469 };
470
471 #define EE_HASHES       32
472
473 struct eacl_entry {
474         struct list_head            ee_list;
475         pid_t                 ee_key; /* hash key */
476         struct lu_fid         ee_fid;
477         int                   ee_type; /* ACL type for ACCESS or DEFAULT */
478         ext_acl_xattr_header *ee_acl;
479 };
480
481 struct eacl_table {
482         spinlock_t      et_lock;
483         struct list_head        et_entries[EE_HASHES];
484 };
485
486 struct ll_sb_info {
487         struct list_head                  ll_list;
488         /* this protects pglist and ra_info.  It isn't safe to
489          * grab from interrupt contexts */
490         spinlock_t                ll_lock;
491         spinlock_t                ll_pp_extent_lock; /* pp_extent entry*/
492         spinlock_t                ll_process_lock; /* ll_rw_process_info */
493         struct obd_uuid           ll_sb_uuid;
494         struct obd_export        *ll_md_exp;
495         struct obd_export        *ll_dt_exp;
496         struct proc_dir_entry*    ll_proc_root;
497         struct lu_fid             ll_root_fid; /* root object fid */
498
499         int                       ll_flags;
500         unsigned int              ll_umounting:1,
501                                   ll_xattr_cache_enabled:1;
502         /* per-conn chain of SBs */
503         struct list_head                ll_conn_chain;
504         struct lustre_client_ocd  ll_lco;
505
506         /*please don't ask -p*/
507         struct list_head        ll_orphan_dentry_list;
508         struct ll_close_queue    *ll_lcq;
509
510         struct lprocfs_stats     *ll_stats; /* lprocfs stats counter */
511
512         /* Used to track "unstable" pages on a client, and maintain a
513          * LRU list of clean pages. An "unstable" page is defined as
514          * any page which is sent to a server as part of a bulk request,
515          * but is uncommitted to stable storage. */
516         struct cl_client_cache    ll_cache;
517
518         struct lprocfs_stats     *ll_ra_stats;
519
520         struct ll_ra_info         ll_ra_info;
521         unsigned int              ll_namelen;
522         struct file_operations   *ll_fop;
523
524         /* =0 - hold lock over whole read/write
525          * >0 - max. chunk to be read/written w/o lock re-acquiring */
526         unsigned long             ll_max_rw_chunk;
527         unsigned int              ll_md_brw_pages; /* readdir pages per RPC */
528
529         struct lu_site           *ll_site;
530         struct cl_device         *ll_cl;
531         /* Statistics */
532         struct ll_rw_extents_info ll_rw_extents_info;
533         int                       ll_extent_process_count;
534         struct ll_rw_process_info ll_rw_process_info[LL_PROCESS_HIST_MAX];
535         unsigned int              ll_offset_process_count;
536         struct ll_rw_process_info ll_rw_offset_info[LL_OFFSET_HIST_MAX];
537         unsigned int              ll_rw_offset_entry_count;
538         int                       ll_stats_track_id;
539         enum stats_track_type     ll_stats_track_type;
540         int                       ll_rw_stats_on;
541
542         /* metadata stat-ahead */
543         unsigned int              ll_sa_max;     /* max statahead RPCs */
544         atomic_t                  ll_sa_total;   /* statahead thread started
545                                                   * count */
546         atomic_t                  ll_sa_wrong;   /* statahead thread stopped for
547                                                   * low hit ratio */
548         atomic_t                  ll_agl_total;  /* AGL thread started count */
549
550         dev_t                     ll_sdev_orig; /* save s_dev before assign for
551                                                  * clustred nfs */
552         struct rmtacl_ctl_table   ll_rct;
553         struct eacl_table         ll_et;
554
555         /* root squash */
556         struct root_squash_info   ll_squash;
557 };
558
559 #define LL_DEFAULT_MAX_RW_CHUNK      (32 * 1024 * 1024)
560
561 struct ll_ra_read {
562         pgoff_t             lrr_start;
563         pgoff_t             lrr_count;
564         struct task_struct *lrr_reader;
565         struct list_head          lrr_linkage;
566 };
567
568 /*
569  * per file-descriptor read-ahead data.
570  */
571 struct ll_readahead_state {
572         spinlock_t  ras_lock;
573         /*
574          * index of the last page that read(2) needed and that wasn't in the
575          * cache. Used by ras_update() to detect seeks.
576          *
577          * XXX nikita: if access seeks into cached region, Lustre doesn't see
578          * this.
579          */
580         unsigned long   ras_last_readpage;
581         /*
582          * number of pages read after last read-ahead window reset. As window
583          * is reset on each seek, this is effectively a number of consecutive
584          * accesses. Maybe ->ras_accessed_in_window is better name.
585          *
586          * XXX nikita: window is also reset (by ras_update()) when Lustre
587          * believes that memory pressure evicts read-ahead pages. In that
588          * case, it probably doesn't make sense to expand window to
589          * PTLRPC_MAX_BRW_PAGES on the third access.
590          */
591         unsigned long   ras_consecutive_pages;
592         /*
593          * number of read requests after the last read-ahead window reset
594          * As window is reset on each seek, this is effectively the number
595          * on consecutive read request and is used to trigger read-ahead.
596          */
597         unsigned long   ras_consecutive_requests;
598         /*
599          * Parameters of current read-ahead window. Handled by
600          * ras_update(). On the initial access to the file or after a seek,
601          * window is reset to 0. After 3 consecutive accesses, window is
602          * expanded to PTLRPC_MAX_BRW_PAGES. Afterwards, window is enlarged by
603          * PTLRPC_MAX_BRW_PAGES chunks up to ->ra_max_pages.
604          */
605         unsigned long   ras_window_start, ras_window_len;
606         /*
607          * Where next read-ahead should start at. This lies within read-ahead
608          * window. Read-ahead window is read in pieces rather than at once
609          * because: 1. lustre limits total number of pages under read-ahead by
610          * ->ra_max_pages (see ll_ra_count_get()), 2. client cannot read pages
611          * not covered by DLM lock.
612          */
613         unsigned long   ras_next_readahead;
614         /*
615          * Total number of ll_file_read requests issued, reads originating
616          * due to mmap are not counted in this total.  This value is used to
617          * trigger full file read-ahead after multiple reads to a small file.
618          */
619         unsigned long   ras_requests;
620         /*
621          * Page index with respect to the current request, these value
622          * will not be accurate when dealing with reads issued via mmap.
623          */
624         unsigned long   ras_request_index;
625         /*
626          * list of struct ll_ra_read's one per read(2) call current in
627          * progress against this file descriptor. Used by read-ahead code,
628          * protected by ->ras_lock.
629          */
630         struct list_head      ras_read_beads;
631         /*
632          * The following 3 items are used for detecting the stride I/O
633          * mode.
634          * In stride I/O mode,
635          * ...............|-----data-----|****gap*****|--------|******|....
636          *    offset      |-stride_pages-|-stride_gap-|
637          * ras_stride_offset = offset;
638          * ras_stride_length = stride_pages + stride_gap;
639          * ras_stride_pages = stride_pages;
640          * Note: all these three items are counted by pages.
641          */
642         unsigned long   ras_stride_length;
643         unsigned long   ras_stride_pages;
644         pgoff_t         ras_stride_offset;
645         /*
646          * number of consecutive stride request count, and it is similar as
647          * ras_consecutive_requests, but used for stride I/O mode.
648          * Note: only more than 2 consecutive stride request are detected,
649          * stride read-ahead will be enable
650          */
651         unsigned long   ras_consecutive_stride_requests;
652 };
653
654 extern struct kmem_cache *ll_file_data_slab;
655 struct lustre_handle;
656 struct ll_file_data {
657         struct ll_readahead_state fd_ras;
658         struct ccc_grouplock fd_grouplock;
659         __u64 lfd_pos;
660         __u32 fd_flags;
661         fmode_t fd_omode;
662         /* openhandle if lease exists for this file.
663          * Borrow lli->lli_och_mutex to protect assignment */
664         struct obd_client_handle *fd_lease_och;
665         struct obd_client_handle *fd_och;
666         struct file *fd_file;
667         /* Indicate whether need to report failure when close.
668          * true: failure is known, not report again.
669          * false: unknown failure, should report. */
670         bool fd_write_failed;
671         rwlock_t fd_lock; /* protect lcc list */
672         struct list_head fd_lccs; /* list of ll_cl_context */
673 };
674
675 struct lov_stripe_md;
676
677 extern spinlock_t inode_lock;
678
679 extern struct proc_dir_entry *proc_lustre_fs_root;
680
681 static inline struct inode *ll_info2i(struct ll_inode_info *lli)
682 {
683         return &lli->lli_vfs_inode;
684 }
685
686 __u32 ll_i2suppgid(struct inode *i);
687 void ll_i2gids(__u32 *suppgids, struct inode *i1,struct inode *i2);
688
689 static inline int ll_need_32bit_api(struct ll_sb_info *sbi)
690 {
691 #if BITS_PER_LONG == 32
692         return 1;
693 #elif defined(CONFIG_COMPAT)
694         return unlikely(is_compat_task() || (sbi->ll_flags & LL_SBI_32BIT_API));
695 #else
696         return unlikely(sbi->ll_flags & LL_SBI_32BIT_API);
697 #endif
698 }
699
700 void ll_ra_read_in(struct file *f, struct ll_ra_read *rar);
701 void ll_ra_read_ex(struct file *f, struct ll_ra_read *rar);
702 struct ll_ra_read *ll_ra_read_get(struct file *f);
703
704 /* llite/lproc_llite.c */
705 #ifdef LPROCFS
706 int lprocfs_register_mountpoint(struct proc_dir_entry *parent,
707                                 struct super_block *sb, char *osc, char *mdc);
708 void lprocfs_unregister_mountpoint(struct ll_sb_info *sbi);
709 void ll_stats_ops_tally(struct ll_sb_info *sbi, int op, int count);
710 extern struct lprocfs_seq_vars lprocfs_llite_obd_vars[];
711 #else
712 static inline int lprocfs_register_mountpoint(struct proc_dir_entry *parent,
713                         struct super_block *sb, char *osc, char *mdc){return 0;}
714 static inline void lprocfs_unregister_mountpoint(struct ll_sb_info *sbi) {}
715 static void ll_stats_ops_tally(struct ll_sb_info *sbi, int op, int count) {}
716 #endif
717
718
719 /* llite/dir.c */
720 extern const struct file_operations ll_dir_operations;
721 extern const struct inode_operations ll_dir_inode_operations;
722 #ifdef HAVE_DIR_CONTEXT
723 int ll_dir_read(struct inode *inode, __u64 *pos, struct md_op_data *op_data,
724                 struct dir_context *ctx);
725 #else
726 int ll_dir_read(struct inode *inode, __u64 *pos, struct md_op_data *op_data,
727                 void *cookie, filldir_t filldir);
728 #endif
729 int ll_get_mdt_idx(struct inode *inode);
730 int ll_get_mdt_idx_by_fid(struct ll_sb_info *sbi, const struct lu_fid *fid);
731 struct page *ll_get_dir_page(struct inode *dir, struct md_op_data *op_data,
732                              __u64 offset, struct ll_dir_chain *chain);
733 void ll_release_page(struct inode *inode, struct page *page, bool remove);
734
735 /* llite/namei.c */
736 extern const struct inode_operations ll_special_inode_operations;
737
738 int ll_objects_destroy(struct ptlrpc_request *request,
739                        struct inode *dir);
740 struct inode *ll_iget(struct super_block *sb, ino_t hash,
741                       struct lustre_md *lic);
742 int ll_test_inode_by_fid(struct inode *inode, void *opaque);
743 int ll_md_blocking_ast(struct ldlm_lock *, struct ldlm_lock_desc *,
744                        void *data, int flag);
745 struct dentry *ll_splice_alias(struct inode *inode, struct dentry *de);
746 int ll_rmdir_entry(struct inode *dir, char *name, int namelen);
747 void ll_update_times(struct ptlrpc_request *request, struct inode *inode);
748
749 /* llite/rw.c */
750 int ll_writepage(struct page *page, struct writeback_control *wbc);
751 int ll_writepages(struct address_space *, struct writeback_control *wbc);
752 int ll_readpage(struct file *file, struct page *page);
753 void ll_readahead_init(struct inode *inode, struct ll_readahead_state *ras);
754 int ll_readahead(const struct lu_env *env, struct cl_io *io,
755                  struct cl_page_list *queue, struct ll_readahead_state *ras,
756                  bool hit);
757 int vvp_io_write_commit(const struct lu_env *env, struct cl_io *io);
758 struct ll_cl_context *ll_cl_find(struct file *file);
759 void ll_cl_add(struct file *file, const struct lu_env *env, struct cl_io *io);
760 void ll_cl_remove(struct file *file, const struct lu_env *env);
761
762 #ifndef MS_HAS_NEW_AOPS
763 extern const struct address_space_operations ll_aops;
764 #else
765 extern const struct address_space_operations_ext ll_aops;
766 #endif
767
768 /* llite/file.c */
769 extern struct file_operations ll_file_operations;
770 extern struct file_operations ll_file_operations_flock;
771 extern struct file_operations ll_file_operations_noflock;
772 extern struct inode_operations ll_file_inode_operations;
773 extern int ll_have_md_lock(struct inode *inode, __u64 *bits,
774                            ldlm_mode_t l_req_mode);
775 extern ldlm_mode_t ll_take_md_lock(struct inode *inode, __u64 bits,
776                                    struct lustre_handle *lockh, __u64 flags,
777                                    ldlm_mode_t mode);
778
779 int ll_file_open(struct inode *inode, struct file *file);
780 int ll_file_release(struct inode *inode, struct file *file);
781 int ll_glimpse_ioctl(struct ll_sb_info *sbi,
782                      struct lov_stripe_md *lsm, lstat_t *st);
783 void ll_ioepoch_open(struct ll_inode_info *lli, __u64 ioepoch);
784 int ll_release_openhandle(struct dentry *, struct lookup_intent *);
785 int ll_md_real_close(struct inode *inode, fmode_t fmode);
786 void ll_ioepoch_close(struct inode *inode, struct md_op_data *op_data,
787                       struct obd_client_handle **och, unsigned long flags);
788 void ll_done_writing_attr(struct inode *inode, struct md_op_data *op_data);
789 int ll_som_update(struct inode *inode, struct md_op_data *op_data);
790 int ll_inode_getattr(struct inode *inode, struct obdo *obdo,
791                      __u64 ioepoch, int sync);
792 void ll_pack_inode2opdata(struct inode *inode, struct md_op_data *op_data,
793                           struct lustre_handle *fh);
794 extern void ll_rw_stats_tally(struct ll_sb_info *sbi, pid_t pid,
795                               struct ll_file_data *file, loff_t pos,
796                               size_t count, int rw);
797 int ll_getattr(struct vfsmount *mnt, struct dentry *de, struct kstat *stat);
798 struct posix_acl *ll_get_acl(struct inode *inode, int type);
799 int ll_migrate(struct inode *parent, struct file *file, int mdtidx,
800                const char *name, int namelen);
801 int ll_get_fid_by_name(struct inode *parent, const char *name,
802                        int namelen, struct lu_fid *fid);
803 #ifdef HAVE_GENERIC_PERMISSION_4ARGS
804 int ll_inode_permission(struct inode *inode, int mask, unsigned int flags);
805 #else
806 # ifndef HAVE_INODE_PERMISION_2ARGS
807 int ll_inode_permission(struct inode *inode, int mask, struct nameidata *nd);
808 # else
809 int ll_inode_permission(struct inode *inode, int mask);
810 # endif
811 #endif
812
813 int ll_lov_setstripe_ea_info(struct inode *inode, struct file *file,
814                              __u64  flags, struct lov_user_md *lum,
815                              int lum_size);
816 int ll_lov_getstripe_ea_info(struct inode *inode, const char *filename,
817                              struct lov_mds_md **lmm, int *lmm_size,
818                              struct ptlrpc_request **request);
819 int ll_dir_setstripe(struct inode *inode, struct lov_user_md *lump,
820                      int set_default);
821 int ll_dir_getstripe(struct inode *inode, void **lmmp,
822                      int *lmm_size, struct ptlrpc_request **request,
823                      obd_valid valid);
824 #ifdef HAVE_FILE_FSYNC_4ARGS
825 int ll_fsync(struct file *file, loff_t start, loff_t end, int data);
826 #elif defined(HAVE_FILE_FSYNC_2ARGS)
827 int ll_fsync(struct file *file, int data);
828 #else
829 int ll_fsync(struct file *file, struct dentry *dentry, int data);
830 #endif
831 int ll_merge_lvb(const struct lu_env *env, struct inode *inode);
832 int ll_fid2path(struct inode *inode, void *arg);
833 int ll_data_version(struct inode *inode, __u64 *data_version, int flags);
834 int ll_hsm_release(struct inode *inode);
835
836 /* llite/dcache.c */
837
838 int ll_d_init(struct dentry *de);
839 extern const struct dentry_operations ll_d_ops;
840 void ll_intent_drop_lock(struct lookup_intent *);
841 void ll_intent_release(struct lookup_intent *);
842 void ll_invalidate_aliases(struct inode *);
843 void ll_lookup_finish_locks(struct lookup_intent *it, struct dentry *dentry);
844 int ll_revalidate_it_finish(struct ptlrpc_request *request,
845                             struct lookup_intent *it, struct dentry *de);
846
847 /* llite/llite_lib.c */
848 extern struct super_operations lustre_super_operations;
849
850 void ll_lli_init(struct ll_inode_info *lli);
851 int ll_fill_super(struct super_block *sb, struct vfsmount *mnt);
852 void ll_put_super(struct super_block *sb);
853 void ll_kill_super(struct super_block *sb);
854 struct inode *ll_inode_from_resource_lock(struct ldlm_lock *lock);
855 void ll_clear_inode(struct inode *inode);
856 int ll_setattr_raw(struct dentry *dentry, struct iattr *attr, bool hsm_import);
857 int ll_setattr(struct dentry *de, struct iattr *attr);
858 int ll_statfs(struct dentry *de, struct kstatfs *sfs);
859 int ll_statfs_internal(struct super_block *sb, struct obd_statfs *osfs,
860                        __u64 max_age, __u32 flags);
861 int ll_update_inode(struct inode *inode, struct lustre_md *md);
862 int ll_read_inode2(struct inode *inode, void *opaque);
863 void ll_delete_inode(struct inode *inode);
864 int ll_iocontrol(struct inode *inode, struct file *file,
865                  unsigned int cmd, unsigned long arg);
866 int ll_flush_ctx(struct inode *inode);
867 void ll_umount_begin(struct super_block *sb);
868 int ll_remount_fs(struct super_block *sb, int *flags, char *data);
869 #ifdef HAVE_SUPEROPS_USE_DENTRY
870 int ll_show_options(struct seq_file *seq, struct dentry *dentry);
871 #else
872 int ll_show_options(struct seq_file *seq, struct vfsmount *vfs);
873 #endif
874 void ll_dirty_page_discard_warn(struct page *page, int ioret);
875 int ll_prep_inode(struct inode **inode, struct ptlrpc_request *req,
876                   struct super_block *, struct lookup_intent *);
877 void lustre_dump_dentry(struct dentry *, int recur);
878 int ll_obd_statfs(struct inode *inode, void *arg);
879 int ll_get_max_mdsize(struct ll_sb_info *sbi, int *max_mdsize);
880 int ll_get_default_mdsize(struct ll_sb_info *sbi, int *default_mdsize);
881 int ll_get_max_cookiesize(struct ll_sb_info *sbi, int *max_cookiesize);
882 int ll_get_default_cookiesize(struct ll_sb_info *sbi, int *default_cookiesize);
883 int ll_process_config(struct lustre_cfg *lcfg);
884 struct md_op_data *ll_prep_md_op_data(struct md_op_data *op_data,
885                                       struct inode *i1, struct inode *i2,
886                                       const char *name, int namelen,
887                                       int mode, __u32 opc, void *data);
888 void ll_finish_md_op_data(struct md_op_data *op_data);
889 int ll_get_obd_name(struct inode *inode, unsigned int cmd, unsigned long arg);
890 char *ll_get_fsname(struct super_block *sb, char *buf, int buflen);
891 void ll_compute_rootsquash_state(struct ll_sb_info *sbi);
892
893 /* llite/llite_nfs.c */
894 extern struct export_operations lustre_export_operations;
895 __u32 get_uuid2int(const char *name, int len);
896 struct inode *search_inode_for_lustre(struct super_block *sb,
897                                       const struct lu_fid *fid);
898 int ll_dir_get_parent_fid(struct inode *dir, struct lu_fid *parent_fid);
899
900 /* llite/symlink.c */
901 extern struct inode_operations ll_fast_symlink_inode_operations;
902
903 /* llite/llite_close.c */
904 struct ll_close_queue {
905         spinlock_t              lcq_lock;
906         struct list_head                lcq_head;
907         wait_queue_head_t       lcq_waitq;
908         struct completion       lcq_comp;
909         atomic_t                lcq_stop;
910 };
911
912 struct ccc_object *cl_inode2ccc(struct inode *inode);
913
914
915 void vvp_write_pending (struct ccc_object *club, struct ccc_page *page);
916 void vvp_write_complete(struct ccc_object *club, struct ccc_page *page);
917
918 /* specific achitecture can implement only part of this list */
919 enum vvp_io_subtype {
920         /** normal IO */
921         IO_NORMAL,
922         /** io started from splice_{read|write} */
923         IO_SPLICE
924 };
925
926 /* IO subtypes */
927 struct vvp_io {
928         /** io subtype */
929         enum vvp_io_subtype    cui_io_subtype;
930
931         union {
932                 struct {
933                         struct pipe_inode_info *cui_pipe;
934                         unsigned int            cui_flags;
935                 } splice;
936                 struct vvp_fault_io {
937                         /**
938                          * Inode modification time that is checked across DLM
939                          * lock request.
940                          */
941                         time_t                 ft_mtime;
942                         struct vm_area_struct *ft_vma;
943                         /**
944                          *  locked page returned from vvp_io
945                          */
946                         struct page            *ft_vmpage;
947                         struct vm_fault_api {
948                                 /**
949                                  * kernel fault info
950                                  */
951                                 struct vm_fault *ft_vmf;
952                                 /**
953                                  * fault API used bitflags for return code.
954                                  */
955                                 unsigned int    ft_flags;
956                         } fault;
957                 } fault;
958         } u;
959         /**
960          * Read-ahead state used by read and page-fault IO contexts.
961          */
962         struct ll_ra_read    cui_bead;
963         /**
964          * Set when cui_bead has been initialized.
965          */
966         int                  cui_ra_window_set;
967 };
968
969 /**
970  * IO arguments for various VFS I/O interfaces.
971  */
972 struct vvp_io_args {
973         /** normal/sendfile/splice */
974         enum vvp_io_subtype via_io_subtype;
975
976         union {
977                 struct {
978                         struct kiocb      *via_iocb;
979                         struct iovec      *via_iov;
980                         unsigned long      via_nrsegs;
981                 } normal;
982                 struct {
983                         struct pipe_inode_info  *via_pipe;
984                         unsigned int       via_flags;
985                 } splice;
986         } u;
987 };
988
989 struct ll_cl_context {
990         struct list_head         lcc_list;
991         void                    *lcc_cookie;
992         const struct lu_env     *lcc_env;
993         struct cl_io            *lcc_io;
994         struct cl_page          *lcc_page;
995 };
996
997 struct vvp_thread_info {
998         struct iovec         vti_local_iov;
999         struct vvp_io_args   vti_args;
1000         struct ra_io_arg     vti_ria;
1001         struct kiocb         vti_kiocb;
1002         struct ll_cl_context vti_io_ctx;
1003 };
1004
1005 static inline struct vvp_thread_info *vvp_env_info(const struct lu_env *env)
1006 {
1007         extern struct lu_context_key vvp_key;
1008         struct vvp_thread_info      *info;
1009
1010         info = lu_context_key_get(&env->le_ctx, &vvp_key);
1011         LASSERT(info != NULL);
1012         return info;
1013 }
1014
1015 static inline struct vvp_io_args *vvp_env_args(const struct lu_env *env,
1016                                                enum vvp_io_subtype type)
1017 {
1018         struct vvp_io_args *ret = &vvp_env_info(env)->vti_args;
1019
1020         ret->via_io_subtype = type;
1021
1022         return ret;
1023 }
1024
1025 struct vvp_session {
1026         struct vvp_io         vs_ios;
1027 };
1028
1029 static inline struct vvp_session *vvp_env_session(const struct lu_env *env)
1030 {
1031         extern struct lu_context_key vvp_session_key;
1032         struct vvp_session *ses;
1033
1034         ses = lu_context_key_get(env->le_ses, &vvp_session_key);
1035         LASSERT(ses != NULL);
1036         return ses;
1037 }
1038
1039 static inline struct vvp_io *vvp_env_io(const struct lu_env *env)
1040 {
1041         return &vvp_env_session(env)->vs_ios;
1042 }
1043
1044 int vvp_global_init(void);
1045 void vvp_global_fini(void);
1046
1047 void ll_queue_done_writing(struct inode *inode, unsigned long flags);
1048 void ll_close_thread_shutdown(struct ll_close_queue *lcq);
1049 int ll_close_thread_start(struct ll_close_queue **lcq_ret);
1050
1051 /* llite/llite_mmap.c */
1052
1053 int ll_teardown_mmaps(struct address_space *mapping, __u64 first, __u64 last);
1054 int ll_file_mmap(struct file * file, struct vm_area_struct * vma);
1055 void policy_from_vma(ldlm_policy_data_t *policy,
1056                 struct vm_area_struct *vma, unsigned long addr, size_t count);
1057 struct vm_area_struct *our_vma(struct mm_struct *mm, unsigned long addr,
1058                                size_t count);
1059
1060 static inline void ll_invalidate_page(struct page *vmpage)
1061 {
1062         struct address_space *mapping = vmpage->mapping;
1063         loff_t offset = vmpage->index << PAGE_CACHE_SHIFT;
1064
1065         LASSERT(PageLocked(vmpage));
1066         if (mapping == NULL)
1067                 return;
1068
1069         /*
1070          * truncate_complete_page() calls
1071          * a_ops->invalidatepage()->cl_page_delete()->vvp_page_delete().
1072          */
1073         ll_teardown_mmaps(mapping, offset, offset + PAGE_CACHE_SIZE);
1074         truncate_complete_page(mapping, vmpage);
1075 }
1076
1077 #define    ll_s2sbi(sb)        (s2lsi(sb)->lsi_llsbi)
1078
1079 /* don't need an addref as the sb_info should be holding one */
1080 static inline struct obd_export *ll_s2dtexp(struct super_block *sb)
1081 {
1082         return ll_s2sbi(sb)->ll_dt_exp;
1083 }
1084
1085 /* don't need an addref as the sb_info should be holding one */
1086 static inline struct obd_export *ll_s2mdexp(struct super_block *sb)
1087 {
1088         return ll_s2sbi(sb)->ll_md_exp;
1089 }
1090
1091 static inline struct client_obd *sbi2mdc(struct ll_sb_info *sbi)
1092 {
1093         struct obd_device *obd = sbi->ll_md_exp->exp_obd;
1094         if (obd == NULL)
1095                 LBUG();
1096         return &obd->u.cli;
1097 }
1098
1099 // FIXME: replace the name of this with LL_SB to conform to kernel stuff
1100 static inline struct ll_sb_info *ll_i2sbi(struct inode *inode)
1101 {
1102         return ll_s2sbi(inode->i_sb);
1103 }
1104
1105 static inline struct obd_export *ll_i2dtexp(struct inode *inode)
1106 {
1107         return ll_s2dtexp(inode->i_sb);
1108 }
1109
1110 static inline struct obd_export *ll_i2mdexp(struct inode *inode)
1111 {
1112         return ll_s2mdexp(inode->i_sb);
1113 }
1114
1115 static inline struct lu_fid *ll_inode2fid(struct inode *inode)
1116 {
1117         struct lu_fid *fid;
1118
1119         LASSERT(inode != NULL);
1120         fid = &ll_i2info(inode)->lli_fid;
1121
1122         return fid;
1123 }
1124
1125 static inline __u64 ll_file_maxbytes(struct inode *inode)
1126 {
1127         return ll_i2info(inode)->lli_maxbytes;
1128 }
1129
1130 /* llite/xattr.c */
1131 int ll_setxattr(struct dentry *dentry, const char *name,
1132                 const void *value, size_t size, int flags);
1133 ssize_t ll_getxattr(struct dentry *dentry, const char *name,
1134                     void *buffer, size_t size);
1135 ssize_t ll_listxattr(struct dentry *dentry, char *buffer, size_t size);
1136 int ll_removexattr(struct dentry *dentry, const char *name);
1137
1138 /* llite/remote_perm.c */
1139 extern struct kmem_cache *ll_remote_perm_cachep;
1140 extern struct kmem_cache *ll_rmtperm_hash_cachep;
1141
1142 void free_rmtperm_hash(struct hlist_head *hash);
1143 int ll_update_remote_perm(struct inode *inode, struct mdt_remote_perm *perm);
1144 int lustre_check_remote_perm(struct inode *inode, int mask);
1145
1146 /* llite/llite_capa.c */
1147 extern struct timer_list ll_capa_timer;
1148
1149 int ll_capa_thread_start(void);
1150 void ll_capa_thread_stop(void);
1151 void ll_capa_timer_callback(unsigned long unused);
1152
1153 struct obd_capa *ll_add_capa(struct inode *inode, struct obd_capa *ocapa);
1154
1155 void ll_capa_open(struct inode *inode);
1156 void ll_capa_close(struct inode *inode);
1157
1158 struct obd_capa *ll_mdscapa_get(struct inode *inode);
1159 struct obd_capa *ll_osscapa_get(struct inode *inode, __u64 opc);
1160
1161 void ll_truncate_free_capa(struct obd_capa *ocapa);
1162 void ll_clear_inode_capas(struct inode *inode);
1163 void ll_print_capa_stat(struct ll_sb_info *sbi);
1164
1165 /* llite/llite_cl.c */
1166 extern struct lu_device_type vvp_device_type;
1167
1168 /**
1169  * Common IO arguments for various VFS I/O interfaces.
1170  */
1171 int cl_sb_init(struct super_block *sb);
1172 int cl_sb_fini(struct super_block *sb);
1173
1174 void ras_update(struct ll_sb_info *sbi, struct inode *inode,
1175                 struct ll_readahead_state *ras, unsigned long index,
1176                 unsigned hit);
1177 void ll_ra_count_put(struct ll_sb_info *sbi, unsigned long len);
1178 void ll_ra_stats_inc(struct inode *inode, enum ra_stat which);
1179
1180 /* llite/llite_rmtacl.c */
1181 #ifdef CONFIG_FS_POSIX_ACL
1182 obd_valid rce_ops2valid(int ops);
1183 struct rmtacl_ctl_entry *rct_search(struct rmtacl_ctl_table *rct, pid_t key);
1184 int rct_add(struct rmtacl_ctl_table *rct, pid_t key, int ops);
1185 int rct_del(struct rmtacl_ctl_table *rct, pid_t key);
1186 void rct_init(struct rmtacl_ctl_table *rct);
1187 void rct_fini(struct rmtacl_ctl_table *rct);
1188
1189 void ee_free(struct eacl_entry *ee);
1190 int ee_add(struct eacl_table *et, pid_t key, struct lu_fid *fid, int type,
1191            ext_acl_xattr_header *header);
1192 struct eacl_entry *et_search_del(struct eacl_table *et, pid_t key,
1193                                  struct lu_fid *fid, int type);
1194 void et_search_free(struct eacl_table *et, pid_t key);
1195 void et_init(struct eacl_table *et);
1196 void et_fini(struct eacl_table *et);
1197 #endif
1198
1199 /* statahead.c */
1200
1201 #define LL_SA_RPC_MIN           2
1202 #define LL_SA_RPC_DEF           32
1203 #define LL_SA_RPC_MAX           8192
1204
1205 #define LL_SA_CACHE_BIT         5
1206 #define LL_SA_CACHE_SIZE        (1 << LL_SA_CACHE_BIT)
1207 #define LL_SA_CACHE_MASK        (LL_SA_CACHE_SIZE - 1)
1208
1209 /* per inode struct, for dir only */
1210 struct ll_statahead_info {
1211         struct inode            *sai_inode;
1212         atomic_t                sai_refcount;   /* when access this struct, hold
1213                                                  * refcount */
1214         unsigned int            sai_generation; /* generation for statahead */
1215         unsigned int            sai_max;        /* max ahead of lookup */
1216         __u64                   sai_sent;       /* stat requests sent count */
1217         __u64                   sai_replied;    /* stat requests which received
1218                                                  * reply */
1219         __u64                   sai_index;      /* index of statahead entry */
1220         __u64                   sai_index_wait; /* index of entry which is the
1221                                                  * caller is waiting for */
1222         __u64                   sai_hit;        /* hit count */
1223         __u64                   sai_miss;       /* miss count:
1224                                                  * for "ls -al" case, it
1225                                                  * includes hidden dentry miss;
1226                                                  * for "ls -l" case, it does not
1227                                                  * include hidden dentry miss.
1228                                                  * "sai_miss_hidden" is used for
1229                                                  * the later case.
1230                                                  */
1231         unsigned int            sai_consecutive_miss; /* consecutive miss */
1232         unsigned int            sai_miss_hidden;/* "ls -al", but first dentry
1233                                                  * is not a hidden one */
1234         unsigned int            sai_skip_hidden;/* skipped hidden dentry count */
1235         unsigned int            sai_ls_all:1,   /* "ls -al", do stat-ahead for
1236                                                  * hidden entries */
1237                                 sai_agl_valid:1,/* AGL is valid for the dir */
1238                                 sai_in_readpage:1;/* statahead is in readdir()*/
1239         wait_queue_head_t       sai_waitq;      /* stat-ahead wait queue */
1240         struct ptlrpc_thread    sai_thread;     /* stat-ahead thread */
1241         struct ptlrpc_thread    sai_agl_thread; /* AGL thread */
1242         struct list_head        sai_entries;    /* entry list */
1243         struct list_head        sai_entries_received;   /* entries returned */
1244         struct list_head        sai_entries_stated;     /* entries stated */
1245         struct list_head        sai_entries_agl;  /* AGL entries to be sent */
1246         struct list_head        sai_cache[LL_SA_CACHE_SIZE];
1247         spinlock_t              sai_cache_lock[LL_SA_CACHE_SIZE];
1248         atomic_t                sai_cache_count; /* entry count in cache */
1249 };
1250
1251 int do_statahead_enter(struct inode *dir, struct dentry **dentry,
1252                        int only_unplug);
1253 void ll_stop_statahead(struct inode *dir, void *key);
1254
1255 static inline int ll_glimpse_size(struct inode *inode)
1256 {
1257         struct ll_inode_info *lli = ll_i2info(inode);
1258         int rc;
1259
1260         down_read(&lli->lli_glimpse_sem);
1261         rc = cl_glimpse_size(inode);
1262         lli->lli_glimpse_time = cfs_time_current();
1263         up_read(&lli->lli_glimpse_sem);
1264         return rc;
1265 }
1266
1267 static inline void
1268 ll_statahead_mark(struct inode *dir, struct dentry *dentry)
1269 {
1270         struct ll_inode_info     *lli = ll_i2info(dir);
1271         struct ll_statahead_info *sai = lli->lli_sai;
1272         struct ll_dentry_data    *ldd = ll_d2d(dentry);
1273
1274         /* not the same process, don't mark */
1275         if (lli->lli_opendir_pid != current_pid())
1276                 return;
1277
1278         LASSERT(ldd != NULL);
1279         if (sai != NULL)
1280                 ldd->lld_sa_generation = sai->sai_generation;
1281 }
1282
1283 static inline int
1284 d_need_statahead(struct inode *dir, struct dentry *dentryp)
1285 {
1286         struct ll_inode_info  *lli;
1287         struct ll_dentry_data *ldd;
1288
1289         if (ll_i2sbi(dir)->ll_sa_max == 0)
1290                 return -EAGAIN;
1291
1292         lli = ll_i2info(dir);
1293         /* not the same process, don't statahead */
1294         if (lli->lli_opendir_pid != current_pid())
1295                 return -EAGAIN;
1296
1297         /* statahead has been stopped */
1298         if (lli->lli_opendir_key == NULL)
1299                 return -EAGAIN;
1300
1301         ldd = ll_d2d(dentryp);
1302         /*
1303          * When stats a dentry, the system trigger more than once "revalidate"
1304          * or "lookup", for "getattr", for "getxattr", and maybe for others.
1305          * Under patchless client mode, the operation intent is not accurate,
1306          * which maybe misguide the statahead thread. For example:
1307          * The "revalidate" call for "getattr" and "getxattr" of a dentry maybe
1308          * have the same operation intent -- "IT_GETATTR".
1309          * In fact, one dentry should has only one chance to interact with the
1310          * statahead thread, otherwise the statahead windows will be confused.
1311          * The solution is as following:
1312          * Assign "lld_sa_generation" with "sai_generation" when a dentry
1313          * "IT_GETATTR" for the first time, and the subsequent "IT_GETATTR"
1314          * will bypass interacting with statahead thread for checking:
1315          * "lld_sa_generation == lli_sai->sai_generation"
1316          */
1317         if (ldd && lli->lli_sai &&
1318             ldd->lld_sa_generation == lli->lli_sai->sai_generation)
1319                 return -EAGAIN;
1320
1321         return 1;
1322 }
1323
1324 static inline int
1325 ll_statahead_enter(struct inode *dir, struct dentry **dentryp, int only_unplug)
1326 {
1327         int ret;
1328
1329         ret = d_need_statahead(dir, *dentryp);
1330         if (ret <= 0)
1331                 return ret;
1332
1333         return do_statahead_enter(dir, dentryp, only_unplug);
1334 }
1335
1336 /* llite ioctl register support rountine */
1337 #ifdef __KERNEL__
1338 enum llioc_iter {
1339         LLIOC_CONT = 0,
1340         LLIOC_STOP
1341 };
1342
1343 #define LLIOC_MAX_CMD           256
1344
1345 /*
1346  * Rules to write a callback function:
1347  *
1348  * Parameters:
1349  *  @magic: Dynamic ioctl call routine will feed this vaule with the pointer
1350  *      returned to ll_iocontrol_register.  Callback functions should use this
1351  *      data to check the potential collasion of ioctl cmd. If collasion is
1352  *      found, callback function should return LLIOC_CONT.
1353  *  @rcp: The result of ioctl command.
1354  *
1355  *  Return values:
1356  *      If @magic matches the pointer returned by ll_iocontrol_data, the
1357  *      callback should return LLIOC_STOP; return LLIOC_STOP otherwise.
1358  */
1359 typedef enum llioc_iter (*llioc_callback_t)(struct inode *inode,
1360                 struct file *file, unsigned int cmd, unsigned long arg,
1361                 void *magic, int *rcp);
1362
1363 /* export functions */
1364 /* Register ioctl block dynamatically for a regular file.
1365  *
1366  * @cmd: the array of ioctl command set
1367  * @count: number of commands in the @cmd
1368  * @cb: callback function, it will be called if an ioctl command is found to
1369  *      belong to the command list @cmd.
1370  *
1371  * Return vaule:
1372  *      A magic pointer will be returned if success;
1373  *      otherwise, NULL will be returned.
1374  * */
1375 void *ll_iocontrol_register(llioc_callback_t cb, int count, unsigned int *cmd);
1376 void ll_iocontrol_unregister(void *magic);
1377
1378 #endif
1379
1380 /* lclient compat stuff */
1381 #define cl_inode_info ll_inode_info
1382 #define cl_i2info(info) ll_i2info(info)
1383 #define cl_inode_mode(inode) ((inode)->i_mode)
1384 #define cl_i2sbi ll_i2sbi
1385
1386 static inline struct ll_file_data *cl_iattr2fd(struct inode *inode,
1387                                                const struct iattr *attr)
1388 {
1389         LASSERT(attr->ia_valid & ATTR_FILE);
1390         return LUSTRE_FPRIVATE(attr->ia_file);
1391 }
1392
1393 static inline void cl_isize_lock(struct inode *inode)
1394 {
1395         ll_inode_size_lock(inode);
1396 }
1397
1398 static inline void cl_isize_unlock(struct inode *inode)
1399 {
1400         ll_inode_size_unlock(inode);
1401 }
1402
1403 static inline void cl_isize_write_nolock(struct inode *inode, loff_t kms)
1404 {
1405         LASSERT(mutex_is_locked(&ll_i2info(inode)->lli_size_mutex));
1406         i_size_write(inode, kms);
1407 }
1408
1409 static inline void cl_isize_write(struct inode *inode, loff_t kms)
1410 {
1411         ll_inode_size_lock(inode);
1412         i_size_write(inode, kms);
1413         ll_inode_size_unlock(inode);
1414 }
1415
1416 #define cl_isize_read(inode)             i_size_read(inode)
1417
1418 static inline int cl_merge_lvb(const struct lu_env *env, struct inode *inode)
1419 {
1420         return ll_merge_lvb(env, inode);
1421 }
1422
1423 #define cl_inode_atime(inode) LTIME_S((inode)->i_atime)
1424 #define cl_inode_ctime(inode) LTIME_S((inode)->i_ctime)
1425 #define cl_inode_mtime(inode) LTIME_S((inode)->i_mtime)
1426
1427 struct obd_capa *cl_capa_lookup(struct inode *inode, enum cl_req_type crt);
1428
1429 int cl_sync_file_range(struct inode *inode, loff_t start, loff_t end,
1430                        enum cl_fsync_mode mode, int ignore_layout);
1431
1432 /** direct write pages */
1433 struct ll_dio_pages {
1434         /** page array to be written. we don't support
1435          * partial pages except the last one. */
1436         struct page **ldp_pages;
1437         /* offset of each page */
1438         loff_t       *ldp_offsets;
1439         /** if ldp_offsets is NULL, it means a sequential
1440          * pages to be written, then this is the file offset
1441          * of the * first page. */
1442         loff_t        ldp_start_offset;
1443         /** how many bytes are to be written. */
1444         size_t        ldp_size;
1445         /** # of pages in the array. */
1446         int           ldp_nr;
1447 };
1448
1449 static inline void cl_stats_tally(struct cl_device *dev, enum cl_req_type crt,
1450                                   int rc)
1451 {
1452         int opc = (crt == CRT_READ) ? LPROC_LL_OSC_READ :
1453                                       LPROC_LL_OSC_WRITE;
1454
1455         ll_stats_ops_tally(ll_s2sbi(cl2ccc_dev(dev)->cdv_sb), opc, rc);
1456 }
1457
1458 extern ssize_t ll_direct_rw_pages(const struct lu_env *env, struct cl_io *io,
1459                                   int rw, struct inode *inode,
1460                                   struct ll_dio_pages *pv);
1461
1462 static inline int ll_file_nolock(const struct file *file)
1463 {
1464         struct ll_file_data *fd = LUSTRE_FPRIVATE(file);
1465         struct inode *inode = file->f_dentry->d_inode;
1466
1467         LASSERT(fd != NULL);
1468         return ((fd->fd_flags & LL_FILE_IGNORE_LOCK) ||
1469                 (ll_i2sbi(inode)->ll_flags & LL_SBI_NOLCK));
1470 }
1471
1472 static inline void ll_set_lock_data(struct obd_export *exp, struct inode *inode,
1473                                     struct lookup_intent *it, __u64 *bits)
1474 {
1475         if (!it->d.lustre.it_lock_set) {
1476                 struct lustre_handle handle;
1477
1478                 /* If this inode is a remote object, it will get two
1479                  * separate locks in different namespaces, Master MDT,
1480                  * where the name entry is, will grant LOOKUP lock,
1481                  * remote MDT, where the object is, will grant
1482                  * UPDATE|PERM lock. The inode will be attched to both
1483                  * LOOKUP and PERM locks, so revoking either locks will
1484                  * case the dcache being cleared */
1485                 if (it->d.lustre.it_remote_lock_mode) {
1486                         handle.cookie = it->d.lustre.it_remote_lock_handle;
1487                         CDEBUG(D_DLMTRACE, "setting l_data to inode "DFID
1488                                "(%p) for remote lock "LPX64"\n",
1489                                PFID(ll_inode2fid(inode)), inode,
1490                                handle.cookie);
1491                         md_set_lock_data(exp, &handle.cookie, inode, NULL);
1492                 }
1493
1494                 handle.cookie = it->d.lustre.it_lock_handle;
1495
1496                 CDEBUG(D_DLMTRACE, "setting l_data to inode "DFID"(%p)"
1497                        " for lock "LPX64"\n",
1498                        PFID(ll_inode2fid(inode)), inode, handle.cookie);
1499
1500                 md_set_lock_data(exp, &handle.cookie, inode,
1501                                  &it->d.lustre.it_lock_bits);
1502                 it->d.lustre.it_lock_set = 1;
1503         }
1504
1505         if (bits != NULL)
1506                 *bits = it->d.lustre.it_lock_bits;
1507 }
1508
1509 static inline void ll_lock_dcache(struct inode *inode)
1510 {
1511 #ifdef HAVE_DCACHE_LOCK
1512         spin_lock(&dcache_lock);
1513 #else
1514         spin_lock(&inode->i_lock);
1515 #endif
1516 }
1517
1518 static inline void ll_unlock_dcache(struct inode *inode)
1519 {
1520 #ifdef HAVE_DCACHE_LOCK
1521         spin_unlock(&dcache_lock);
1522 #else
1523         spin_unlock(&inode->i_lock);
1524 #endif
1525 }
1526
1527 static inline int d_lustre_invalid(const struct dentry *dentry)
1528 {
1529         struct ll_dentry_data *lld = ll_d2d(dentry);
1530
1531         return (lld == NULL) || lld->lld_invalid;
1532 }
1533
1534 static inline void __d_lustre_invalidate(struct dentry *dentry)
1535 {
1536         struct ll_dentry_data *lld = ll_d2d(dentry);
1537
1538         if (lld != NULL)
1539                 lld->lld_invalid = 1;
1540 }
1541
1542 /*
1543  * Mark dentry INVALID, if dentry refcount is zero (this is normally case for
1544  * ll_md_blocking_ast), unhash this dentry, and let dcache to reclaim it later;
1545  * else dput() of the last refcount will unhash this dentry and kill it.
1546  */
1547 static inline void d_lustre_invalidate(struct dentry *dentry, int nested)
1548 {
1549         CDEBUG(D_DENTRY, "invalidate dentry %.*s (%p) parent %p inode %p "
1550                "refc %d\n", dentry->d_name.len, dentry->d_name.name, dentry,
1551                dentry->d_parent, dentry->d_inode, d_count(dentry));
1552
1553         spin_lock_nested(&dentry->d_lock,
1554                          nested ? DENTRY_D_LOCK_NESTED : DENTRY_D_LOCK_NORMAL);
1555         __d_lustre_invalidate(dentry);
1556         if (d_count(dentry) == 0)
1557                 __d_drop(dentry);
1558         spin_unlock(&dentry->d_lock);
1559 }
1560
1561 static inline void d_lustre_revalidate(struct dentry *dentry)
1562 {
1563         spin_lock(&dentry->d_lock);
1564         LASSERT(ll_d2d(dentry) != NULL);
1565         ll_d2d(dentry)->lld_invalid = 0;
1566         spin_unlock(&dentry->d_lock);
1567 }
1568
1569 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 7, 50, 0)
1570 /* Compatibility for old (1.8) compiled userspace quota code */
1571 struct if_quotactl_18 {
1572         __u32                   qc_cmd;
1573         __u32                   qc_type;
1574         __u32                   qc_id;
1575         __u32                   qc_stat;
1576         struct obd_dqinfo       qc_dqinfo;
1577         struct obd_dqblk        qc_dqblk;
1578         char                    obd_type[16];
1579         struct obd_uuid         obd_uuid;
1580 };
1581 #define LL_IOC_QUOTACTL_18              _IOWR('f', 162, struct if_quotactl_18 *)
1582 /* End compatibility for old (1.8) compiled userspace quota code */
1583 #else
1584 #warning "remove old LL_IOC_QUOTACTL_18 compatibility code"
1585 #endif /* LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 7, 50, 0) */
1586
1587 enum {
1588         LL_LAYOUT_GEN_NONE  = ((__u32)-2),      /* layout lock was cancelled */
1589         LL_LAYOUT_GEN_EMPTY = ((__u32)-1)       /* for empty layout */
1590 };
1591
1592 int ll_layout_conf(struct inode *inode, const struct cl_object_conf *conf);
1593 int ll_layout_refresh(struct inode *inode, __u32 *gen);
1594 int ll_layout_restore(struct inode *inode, loff_t start, __u64 length);
1595
1596 int ll_xattr_init(void);
1597 void ll_xattr_fini(void);
1598
1599 int ll_page_sync_io(const struct lu_env *env, struct cl_io *io,
1600                     struct cl_page *page, enum cl_req_type crt);
1601
1602 #endif /* LLITE_INTERNAL_H */