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