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