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