Whamcloud - gitweb
LU-8560 libcfs: handle PAGE_CACHE_* removal in newer kernels
[fs/lustre-release.git] / lustre / osd-ldiskfs / osd_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) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28  * Use is subject to license terms.
29  *
30  * Copyright (c) 2011, 2015, 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  * lustre/osd/osd_internal.h
37  *
38  * Shared definitions and declarations for osd module
39  *
40  * Author: Nikita Danilov <nikita@clusterfs.com>
41  */
42
43 #ifndef _OSD_INTERNAL_H
44 #define _OSD_INTERNAL_H
45
46
47 /* struct mutex */
48 #include <linux/mutex.h>
49 /* struct rw_semaphore */
50 #include <linux/rwsem.h>
51 /* struct dentry */
52 #include <linux/dcache.h>
53 /* struct dirent64 */
54 #include <linux/dirent.h>
55 #include <linux/statfs.h>
56 #include <ldiskfs/ldiskfs.h>
57 #include <ldiskfs/ldiskfs_jbd2.h>
58
59 /* LUSTRE_OSD_NAME */
60 #include <obd.h>
61 /* class_register_type(), class_unregister_type(), class_get_type() */
62 #include <obd_class.h>
63 #include <lustre_disk.h>
64 #include <dt_object.h>
65 #include <lustre_quota.h>
66
67 #include "osd_oi.h"
68 #include "osd_iam.h"
69 #include "osd_scrub.h"
70 #include "osd_quota_fmt.h"
71
72 struct inode;
73 extern struct kmem_cache *dynlock_cachep;
74
75 #define OSD_COUNTERS (0)
76
77 /* ldiskfs special inode::i_state_flags need to be accessed with
78  * ldiskfs_{set,clear,test}_inode_state() only */
79
80 /* OI scrub should skip this inode. */
81 #define LDISKFS_STATE_LUSTRE_NOSCRUB    31
82 #define LDISKFS_STATE_LUSTRE_DESTROY    30
83
84 /** Enable thandle usage statistics */
85 #define OSD_THANDLE_STATS (0)
86
87 #define MAX_OBJID_GROUP (FID_SEQ_ECHO + 1)
88
89 #define OBJECTS         "OBJECTS"
90 #define ADMIN_USR       "admin_quotafile_v2.usr"
91 #define ADMIN_GRP       "admin_quotafile_v2.grp"
92
93 /* Statfs space reservation for fragmentation and local objects */
94 #define OSD_STATFS_RESERVED             (1ULL << 23) /* 8MB */
95 #define OSD_STATFS_RESERVED_SHIFT       (7) /* reserve 0.78% of all space */
96
97 struct osd_directory {
98         struct iam_container od_container;
99         struct iam_descr     od_descr;
100 };
101
102 /*
103  * Object Index (oi) instance.
104  */
105 struct osd_oi {
106         /*
107          * underlying index object, where fid->id mapping in stored.
108          */
109         struct inode         *oi_inode;
110         struct osd_directory  oi_dir;
111 };
112
113 extern const int osd_dto_credits_noquota[];
114
115 struct osd_object {
116         struct dt_object        oo_dt;
117         /**
118          * Inode for file system object represented by this osd_object. This
119          * inode is pinned for the whole duration of lu_object life.
120          *
121          * Not modified concurrently (either setup early during object
122          * creation, or assigned by osd_object_create() under write lock).
123          */
124         struct inode           *oo_inode;
125         /**
126          * to protect index ops.
127          */
128         struct htree_lock_head *oo_hl_head;
129         struct rw_semaphore     oo_ext_idx_sem;
130         struct rw_semaphore     oo_sem;
131         struct osd_directory    *oo_dir;
132         /** protects inode attributes. */
133         spinlock_t              oo_guard;
134
135         __u32                   oo_destroyed:1;
136
137         /* the i_flags in LMA */
138         __u32                   oo_lma_flags;
139         /**
140          * Following two members are used to indicate the presence of dot and
141          * dotdot in the given directory. This is required for interop mode
142          * (b11826).
143          */
144         int                     oo_compat_dot_created;
145         int                     oo_compat_dotdot_created;
146
147         const struct lu_env    *oo_owner;
148 #ifdef CONFIG_LOCKDEP
149         struct lockdep_map      oo_dep_map;
150 #endif
151
152         struct list_head        oo_xattr_list;
153 };
154
155 struct osd_obj_seq {
156         /* protects on-fly initialization */
157         int              oos_subdir_count; /* subdir count for each seq */
158         struct dentry    *oos_root;        /* O/<seq> */
159         struct dentry    **oos_dirs;       /* O/<seq>/d0-dXX */
160         u64              oos_seq;          /* seq number */
161         struct list_head oos_seq_list;     /* list to seq_list */
162 };
163
164 struct osd_obj_map {
165         struct dentry    *om_root;        /* dentry for /O */
166         rwlock_t         om_seq_list_lock; /* lock for seq_list */
167         struct list_head om_seq_list;      /* list head for seq */
168         int              om_subdir_count;
169         struct mutex     om_dir_init_mutex;
170 };
171
172 struct osd_mdobj {
173         struct dentry   *om_root;      /* AGENT/<index> */
174         u64              om_index;     /* mdt index */
175         struct list_head om_list;      /* list to omm_list */
176 };
177
178 struct osd_mdobj_map {
179         struct dentry   *omm_remote_parent;
180 };
181 int osd_ldiskfs_add_entry(struct osd_thread_info *info,
182                           handle_t *handle, struct dentry *child,
183                           struct inode *inode, struct htree_lock *hlock);
184
185 #define OSD_OTABLE_IT_CACHE_SIZE        64
186 #define OSD_OTABLE_IT_CACHE_MASK        (~(OSD_OTABLE_IT_CACHE_SIZE - 1))
187
188 struct osd_inconsistent_item {
189         /* link into osd_scrub::os_inconsistent_items,
190          * protected by osd_scrub::os_lock. */
191         struct list_head       oii_list;
192
193         /* The right FID <=> ino#/gen mapping. */
194         struct osd_idmap_cache oii_cache;
195
196         unsigned int           oii_insert:1; /* insert or update mapping. */
197 };
198
199 struct osd_otable_cache {
200         struct osd_idmap_cache ooc_cache[OSD_OTABLE_IT_CACHE_SIZE];
201
202         /* Index for next cache slot to be filled. */
203         int                    ooc_producer_idx;
204
205         /* Index for next cache slot to be returned by it::next(). */
206         int                    ooc_consumer_idx;
207
208         /* How many items in ooc_cache. */
209         int                    ooc_cached_items;
210
211         /* Position for up layer LFSCK iteration pre-loading. */
212         __u32                  ooc_pos_preload;
213 };
214
215 struct osd_otable_it {
216         struct osd_device       *ooi_dev;
217         struct osd_otable_cache  ooi_cache;
218
219         /* The following bits can be updated/checked w/o lock protection.
220          * If more bits will be introduced in the future and need lock to
221          * protect, please add comment. */
222         unsigned long            ooi_used_outside:1, /* Some user out of OSD
223                                                       * uses the iteration. */
224                                  ooi_all_cached:1, /* No more entries can be
225                                                     * filled into cache. */
226                                  ooi_user_ready:1, /* The user out of OSD is
227                                                     * ready to iterate. */
228                                  ooi_waiting:1; /* it::next is waiting. */
229 };
230
231 struct osd_obj_orphan {
232         struct list_head oor_list;
233         struct lu_env   *oor_env; /* to identify "own" records */
234         __u32 oor_ino;
235 };
236
237 /*
238  * osd device.
239  */
240 struct osd_device {
241         /* super-class */
242         struct dt_device          od_dt_dev;
243         /* information about underlying file system */
244         struct vfsmount          *od_mnt;
245         /* object index */
246         struct osd_oi           **od_oi_table;
247         /* total number of OI containers */
248         int                       od_oi_count;
249         /*
250          * Fid Capability
251          */
252         unsigned int              od_fl_capa:1,
253                                   od_maybe_new:1,
254                                   od_noscrub:1,
255                                   od_igif_inoi:1,
256                                   od_check_ff:1,
257                                   od_is_ost:1,
258                                   od_index_in_idif:1;
259
260         __u32                     od_dirent_journal;
261         int                       od_index;
262         struct proc_dir_entry    *od_proc_entry;
263         struct lprocfs_stats     *od_stats;
264
265         spinlock_t                od_osfs_lock;
266
267         int                       od_connects;
268         struct lu_site            od_site;
269
270         struct osd_obj_map      *od_ost_map;
271         struct osd_mdobj_map    *od_mdt_map;
272
273         unsigned long long      od_readcache_max_filesize;
274         int                     od_read_cache;
275         int                     od_writethrough_cache;
276
277         struct brw_stats        od_brw_stats;
278         atomic_t                od_r_in_flight;
279         atomic_t                od_w_in_flight;
280
281         struct mutex              od_otable_mutex;
282         struct osd_otable_it     *od_otable_it;
283         struct osd_scrub          od_scrub;
284         struct list_head                  od_ios_list;
285
286         /* service name associated with the osd device */
287         char                      od_svname[MAX_OBD_NAME];
288         char                      od_mntdev[MAX_OBD_NAME];
289
290         /* quota slave instance */
291         struct qsd_instance      *od_quota_slave;
292
293         /* osd seq instance */
294         struct lu_client_seq    *od_cl_seq;
295         /* If the ratio of "the total OI mappings count" vs
296          * "the bad OI mappings count" is lower than the
297          * osd_device::od_full_scrub_ratio, then trigger
298          * OI scrub to scan the whole the device. */
299         __u64                    od_full_scrub_ratio;
300         /* If the speed of found bad OI mappings (per minute)
301          * exceeds the osd_device::od_full_scrub_threshold_rate,
302          * then trigger OI scrub to scan the whole device. */
303         __u64                    od_full_scrub_threshold_rate;
304
305         /* a list of orphaned agent inodes, protected with od_osfs_lock */
306         struct list_head         od_orphan_list;
307 };
308
309 enum osd_full_scrub_ratio {
310         /* Trigger OI scrub to scan the whole device directly. */
311         OFSR_DIRECTLY   = 0,
312
313         /* Because the bad OI mappings count cannot be larger than
314          * the total OI mappints count, then setting OFSR_NEVER means
315          * that the whole device scanning cannot be triggered by auto
316          * detected bad OI mappings during the RPC services. */
317         OFSR_NEVER      = 1,
318         OFSR_DEFAULT    = 10000,
319 };
320
321 #define FULL_SCRUB_THRESHOLD_RATE_DEFAULT       60
322
323 /* There are at most 10 uid/gids are affected in a transaction, and
324  * that's rename case:
325  * - 2 for source parent uid & gid;
326  * - 2 for source child uid & gid ('..' entry update when child is directory);
327  * - 2 for target parent uid & gid;
328  * - 2 for target child uid & gid (if the target child exists);
329  * - 2 for root uid & gid (last_rcvd, llog, etc);
330  *
331  * The 0 to (OSD_MAX_UGID_CNT - 1) bits of ot_id_type is for indicating
332  * the id type of each id in the ot_id_array.
333  */
334 #define OSD_MAX_UGID_CNT        10
335
336 enum {
337         OSD_OT_ATTR_SET         = 0,
338         OSD_OT_PUNCH            = 1,
339         OSD_OT_XATTR_SET        = 2,
340         OSD_OT_CREATE           = 3,
341         OSD_OT_DESTROY          = 4,
342         OSD_OT_REF_ADD          = 5,
343         OSD_OT_REF_DEL          = 6,
344         OSD_OT_WRITE            = 7,
345         OSD_OT_INSERT           = 8,
346         OSD_OT_DELETE           = 9,
347         OSD_OT_QUOTA            = 10,
348         OSD_OT_MAX              = 11
349 };
350
351 struct osd_thandle {
352         struct thandle          ot_super;
353         handle_t               *ot_handle;
354         struct ldiskfs_journal_cb_entry ot_jcb;
355         struct list_head       ot_commit_dcb_list;
356         struct list_head       ot_stop_dcb_list;
357         /* Link to the device, for debugging. */
358         struct lu_ref_link      ot_dev_link;
359         unsigned short          ot_credits;
360         unsigned short          ot_id_cnt;
361         unsigned short          ot_id_type;
362         unsigned int            ot_remove_agents:1;
363         uid_t                   ot_id_array[OSD_MAX_UGID_CNT];
364         struct lquota_trans    *ot_quota_trans;
365 #if OSD_THANDLE_STATS
366         /** time when this handle was allocated */
367         cfs_time_t oth_alloced;
368
369         /** time when this thanle was started */
370         cfs_time_t oth_started;
371 #endif
372 };
373
374 /**
375  * Basic transaction credit op
376  */
377 enum dt_txn_op {
378         DTO_INDEX_INSERT,
379         DTO_INDEX_DELETE,
380         DTO_INDEX_UPDATE,
381         DTO_OBJECT_CREATE,
382         DTO_OBJECT_DELETE,
383         DTO_ATTR_SET_BASE,
384         DTO_XATTR_SET,
385         DTO_WRITE_BASE,
386         DTO_WRITE_BLOCK,
387         DTO_ATTR_SET_CHOWN,
388
389         DTO_NR
390 };
391
392 /*
393  * osd dev stats
394  */
395
396 #ifdef CONFIG_PROC_FS
397 enum {
398         LPROC_OSD_READ_BYTES    = 0,
399         LPROC_OSD_WRITE_BYTES   = 1,
400         LPROC_OSD_GET_PAGE      = 2,
401         LPROC_OSD_NO_PAGE       = 3,
402         LPROC_OSD_CACHE_ACCESS  = 4,
403         LPROC_OSD_CACHE_HIT     = 5,
404         LPROC_OSD_CACHE_MISS    = 6,
405
406 #if OSD_THANDLE_STATS
407         LPROC_OSD_THANDLE_STARTING,
408         LPROC_OSD_THANDLE_OPEN,
409         LPROC_OSD_THANDLE_CLOSING,
410 #endif
411         LPROC_OSD_LAST,
412 };
413 #endif
414
415 /**
416  * Storage representation for fids.
417  *
418  * Variable size, first byte contains the length of the whole record.
419  */
420 struct osd_fid_pack {
421         unsigned char fp_len;
422         char fp_area[sizeof(struct lu_fid)];
423 };
424
425 struct osd_it_ea_dirent {
426         struct lu_fid   oied_fid;
427         __u64           oied_ino;
428         __u64           oied_off;
429         unsigned short  oied_namelen;
430         unsigned int    oied_type;
431         char            oied_name[0];
432 } __attribute__((packed));
433
434 /**
435  * as osd_it_ea_dirent (in memory dirent struct for osd) is greater
436  * than lu_dirent struct. osd readdir reads less number of dirent than
437  * required for mdd dir page. so buffer size need to be increased so that
438  * there  would be one ext3 readdir for every mdd readdir page.
439  */
440
441 #define OSD_IT_EA_BUFSIZE       (PAGE_SIZE + PAGE_SIZE/4)
442
443 /**
444  * This is iterator's in-memory data structure in interoperability
445  * mode (i.e. iterator over ldiskfs style directory)
446  */
447 struct osd_it_ea {
448         struct osd_object       *oie_obj;
449         /** used in ldiskfs iterator, to stored file pointer */
450         struct file             oie_file;
451         /** how many entries have been read-cached from storage */
452         int                     oie_rd_dirent;
453         /** current entry is being iterated by caller */
454         int                     oie_it_dirent;
455         /** current processing entry */
456         struct osd_it_ea_dirent *oie_dirent;
457         /** buffer to hold entries, size == OSD_IT_EA_BUFSIZE */
458         void                    *oie_buf;
459         struct dentry           oie_dentry;
460 };
461
462 /**
463  * Iterator's in-memory data structure for IAM mode.
464  */
465 struct osd_it_iam {
466         struct osd_object     *oi_obj;
467         struct iam_path_descr *oi_ipd;
468         struct iam_iterator    oi_it;
469 };
470
471 struct osd_quota_leaf {
472         struct list_head        oql_link;
473         uint            oql_blk;
474 };
475
476 /**
477  * Iterator's in-memory data structure for quota file.
478  */
479 struct osd_it_quota {
480         struct osd_object       *oiq_obj;
481         /** tree blocks path to where the entry is stored */
482         uint                     oiq_blk[LUSTRE_DQTREEDEPTH + 1];
483         /** on-disk offset for current key where quota record can be found */
484         loff_t                   oiq_offset;
485         /** identifier for current quota record */
486         __u64                    oiq_id;
487         /** the record index in the leaf/index block */
488         uint                     oiq_index[LUSTRE_DQTREEDEPTH + 1];
489         /** list of already processed leaf blocks */
490         struct list_head         oiq_list;
491 };
492
493 #define MAX_BLOCKS_PER_PAGE (PAGE_SIZE / 512)
494
495 struct osd_iobuf {
496         wait_queue_head_t  dr_wait;
497         atomic_t       dr_numreqs;  /* number of reqs being processed */
498         int                dr_max_pages;
499         int                dr_npages;
500         int                dr_error;
501         int                dr_frags;
502         unsigned int       dr_ignore_quota:1;
503         unsigned int       dr_elapsed_valid:1; /* we really did count time */
504         unsigned int       dr_rw:1;
505         struct lu_buf      dr_pg_buf;
506         struct page      **dr_pages;
507         struct lu_buf      dr_bl_buf;
508         sector_t          *dr_blocks;
509         unsigned long      dr_start_time;
510         unsigned long      dr_elapsed;  /* how long io took */
511         struct osd_device *dr_dev;
512         unsigned int       dr_init_at;  /* the line iobuf was initialized */
513 };
514
515 #define OSD_INS_CACHE_SIZE      8
516
517 struct osd_thread_info {
518         const struct lu_env   *oti_env;
519         /**
520          * used for index operations.
521          */
522         struct dentry          oti_obj_dentry;
523         struct dentry          oti_child_dentry;
524
525         /** dentry for Iterator context. */
526         struct dentry           oti_it_dentry;
527
528         union {
529                 /* fake struct file for osd_object_sync */
530                 struct file             oti_file;
531                 /* osd_statfs() */
532                 struct kstatfs          oti_ksfs;
533         };
534
535         struct htree_lock     *oti_hlock;
536
537         struct lu_fid          oti_fid;
538         struct lu_fid          oti_fid2;
539         struct lu_fid          oti_fid3;
540         struct osd_inode_id    oti_id;
541         struct osd_inode_id    oti_id2;
542         struct osd_inode_id    oti_id3;
543         struct ost_id          oti_ostid;
544
545         /*
546          * XXX temporary: for ->i_op calls.
547          */
548         struct timespec        oti_time;
549
550         /** osd_device reference, initialized in osd_trans_start() and
551             used in osd_trans_stop() */
552         struct osd_device     *oti_dev;
553
554         /**
555          * following ipd and it structures are used for osd_index_iam_lookup()
556          * these are defined separately as we might do index operation
557          * in open iterator session.
558          */
559
560         /** pre-allocated buffer used by oti_it_ea, size OSD_IT_EA_BUFSIZE */
561         void                    *oti_it_ea_buf;
562         unsigned int            oti_it_ea_buf_used:1;
563
564         /* IAM iterator for index operation. */
565         struct iam_iterator    oti_idx_it;
566
567         /** union to guarantee that ->oti_ipd[] has proper alignment. */
568         union {
569                 char           oti_name[48];
570                 char           oti_it_ipd[DX_IPD_MAX_SIZE];
571                 long long      oti_alignment_lieutenant;
572         };
573
574         union {
575                 char           oti_idx_ipd[DX_IPD_MAX_SIZE];
576                 long long      oti_alignment_lieutenant_colonel;
577         };
578
579         struct osd_idmap_cache oti_cache;
580
581         /* dedicated OI cache for insert (which needs inum) */
582         struct osd_idmap_cache *oti_ins_cache;
583         int                    oti_ins_cache_size;
584         int                    oti_ins_cache_used;
585
586         int                    oti_r_locks;
587         int                    oti_w_locks;
588         int                    oti_txns;
589         /** used in osd_fid_set() to put xattr */
590         struct lu_buf          oti_buf;
591         struct lu_buf          oti_big_buf;
592         /** used in osd_ea_fid_set() to set fid into common ea */
593         union {
594                 struct lustre_mdt_attrs oti_mdt_attrs;
595                 /* old LMA for compatibility */
596                 char                    oti_mdt_attrs_old[LMA_OLD_SIZE];
597                 struct filter_fid_old   oti_ff;
598                 struct filter_fid       oti_ff_new;
599         };
600         /** 0-copy IO */
601         struct osd_iobuf       oti_iobuf;
602         /* used to access objects in /O */
603         struct inode          *oti_inode;
604 #define OSD_FID_REC_SZ 32
605         char                   oti_ldp[OSD_FID_REC_SZ];
606         char                   oti_ldp2[OSD_FID_REC_SZ];
607
608         /* used by quota code */
609         union {
610 #if defined(HAVE_DQUOT_QC_DQBLK)
611                 struct qc_dqblk         oti_qdq;
612 #elif defined(HAVE_DQUOT_FS_DISK_QUOTA)
613                 struct fs_disk_quota    oti_fdq;
614 #else
615                 struct if_dqblk         oti_dqblk;
616 #endif
617                 struct if_dqinfo        oti_dqinfo;
618         };
619         struct lquota_id_info   oti_qi;
620         struct lquota_trans     oti_quota_trans;
621         union lquota_rec        oti_quota_rec;
622         __u64                   oti_quota_id;
623         struct lu_seq_range     oti_seq_range;
624
625         /* Tracking for transaction credits, to allow debugging and optimizing
626          * cases where a large number of credits are being allocated for
627          * single transaction. */
628         unsigned int            oti_credits_before;
629         unsigned short          oti_declare_ops[OSD_OT_MAX];
630         unsigned short          oti_declare_ops_cred[OSD_OT_MAX];
631         unsigned short          oti_declare_ops_used[OSD_OT_MAX];
632 };
633
634 extern int ldiskfs_pdo;
635
636 static inline int __osd_xattr_get(struct inode *inode, struct dentry *dentry,
637                                   const char *name, void *buf, int len)
638 {
639         if (inode == NULL)
640                 return -EINVAL;
641
642         dentry->d_inode = inode;
643         dentry->d_sb = inode->i_sb;
644         return inode->i_op->getxattr(dentry, name, buf, len);
645 }
646
647 static inline int __osd_xattr_set(struct osd_thread_info *info,
648                                   struct inode *inode, const char *name,
649                                   const void *buf, int buflen, int fl)
650 {
651         struct dentry *dentry = &info->oti_child_dentry;
652
653         ll_vfs_dq_init(inode);
654         dentry->d_inode = inode;
655         dentry->d_sb = inode->i_sb;
656         return inode->i_op->setxattr(dentry, name, buf, buflen, fl);
657 }
658
659 #ifdef CONFIG_PROC_FS
660 /* osd_lproc.c */
661 extern struct lprocfs_vars lprocfs_osd_obd_vars[];
662 extern struct lprocfs_vars lprocfs_osd_module_vars[];
663 int osd_procfs_init(struct osd_device *osd, const char *name);
664 int osd_procfs_fini(struct osd_device *osd);
665 void osd_brw_stats_update(struct osd_device *osd, struct osd_iobuf *iobuf);
666 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(3, 0, 52, 0)
667 int osd_register_proc_index_in_idif(struct osd_device *osd);
668 #endif
669
670 #endif
671 int osd_statfs(const struct lu_env *env, struct dt_device *dev,
672                struct obd_statfs *sfs);
673 struct inode *osd_iget(struct osd_thread_info *info, struct osd_device *dev,
674                        struct osd_inode_id *id);
675 int osd_ea_fid_set(struct osd_thread_info *info, struct inode *inode,
676                    const struct lu_fid *fid, __u32 compat, __u32 incompat);
677 int osd_get_lma(struct osd_thread_info *info, struct inode *inode,
678                 struct dentry *dentry, struct lustre_mdt_attrs *lma);
679 void osd_add_oi_cache(struct osd_thread_info *info, struct osd_device *osd,
680                       struct osd_inode_id *id, const struct lu_fid *fid);
681 int osd_get_idif(struct osd_thread_info *info, struct inode *inode,
682                  struct dentry *dentry, struct lu_fid *fid);
683
684 int osd_obj_map_init(const struct lu_env *env, struct osd_device *osd);
685 void osd_obj_map_fini(struct osd_device *dev);
686 int osd_obj_map_lookup(struct osd_thread_info *info, struct osd_device *osd,
687                         const struct lu_fid *fid, struct osd_inode_id *id);
688 int osd_obj_map_insert(struct osd_thread_info *info, struct osd_device *osd,
689                        const struct lu_fid *fid, const struct osd_inode_id *id,
690                        handle_t *th);
691 int osd_obj_map_delete(struct osd_thread_info *info, struct osd_device *osd,
692                         const struct lu_fid *fid, handle_t *th);
693 int osd_obj_map_update(struct osd_thread_info *info, struct osd_device *osd,
694                        const struct lu_fid *fid, const struct osd_inode_id *id,
695                        handle_t *th);
696 int osd_obj_map_recover(struct osd_thread_info *info, struct osd_device *osd,
697                         struct inode *src_parent, struct dentry *src_child,
698                         const struct lu_fid *fid);
699 int osd_obj_spec_lookup(struct osd_thread_info *info, struct osd_device *osd,
700                         const struct lu_fid *fid, struct osd_inode_id *id);
701 int osd_obj_spec_insert(struct osd_thread_info *info, struct osd_device *osd,
702                         const struct lu_fid *fid, const struct osd_inode_id *id,
703                         handle_t *th);
704 int osd_obj_spec_update(struct osd_thread_info *info, struct osd_device *osd,
705                         const struct lu_fid *fid, const struct osd_inode_id *id,
706                         handle_t *th);
707
708 void osd_scrub_file_reset(struct osd_scrub *scrub, __u8 *uuid, __u64 flags);
709 int osd_scrub_file_store(struct osd_scrub *scrub);
710 char *osd_lf_fid2name(const struct lu_fid *fid);
711 int osd_scrub_start(struct osd_device *dev, __u32 flags);
712 int osd_scrub_setup(const struct lu_env *env, struct osd_device *dev);
713 void osd_scrub_cleanup(const struct lu_env *env, struct osd_device *dev);
714 int osd_oii_insert(struct osd_device *dev, struct osd_idmap_cache *oic,
715                    int insert);
716 int osd_oii_lookup(struct osd_device *dev, const struct lu_fid *fid,
717                    struct osd_inode_id *id);
718 int osd_scrub_dump(struct seq_file *m, struct osd_device *dev);
719
720 int osd_fld_lookup(const struct lu_env *env, struct osd_device *osd,
721                    u64 seq, struct lu_seq_range *range);
722
723 int osd_delete_from_remote_parent(const struct lu_env *env,
724                                   struct osd_device *osd,
725                                   struct osd_object *obj,
726                                   struct osd_thandle *oh);
727 int osd_add_to_remote_parent(const struct lu_env *env, struct osd_device *osd,
728                              struct osd_object *obj, struct osd_thandle *oh);
729 int osd_lookup_in_remote_parent(struct osd_thread_info *oti,
730                                 struct osd_device *osd,
731                                 const struct lu_fid *fid,
732                                 struct osd_inode_id *id);
733
734 int osd_ost_seq_exists(struct osd_thread_info *info, struct osd_device *osd,
735                        __u64 seq);
736 /* osd_quota_fmt.c */
737 int walk_tree_dqentry(const struct lu_env *env, struct osd_object *obj,
738                       int type, uint blk, int depth, uint index,
739                       struct osd_it_quota *it);
740 int walk_block_dqentry(const struct lu_env *env, struct osd_object *obj,
741                        int type, uint blk, uint index,
742                        struct osd_it_quota *it);
743 loff_t find_tree_dqentry(const struct lu_env *env,
744                          struct osd_object *obj, int type,
745                          qid_t dqid, uint blk, int depth,
746                          struct osd_it_quota *it);
747 /* osd_quota.c */
748 int osd_declare_qid(const struct lu_env *env, struct osd_thandle *oh,
749                     struct lquota_id_info *qi, struct osd_object *obj,
750                     bool enforce, int *flags);
751 int osd_declare_inode_qid(const struct lu_env *env, qid_t uid, qid_t gid,
752                           long long space, struct osd_thandle *oh,
753                           struct osd_object *obj, bool is_blk, int *flags,
754                           bool force);
755 const struct dt_rec *osd_quota_pack(struct osd_object *obj,
756                                     const struct dt_rec *rec,
757                                     union lquota_rec *quota_rec);
758 void osd_quota_unpack(struct osd_object *obj, const struct dt_rec *rec);
759 int osd_quota_migration(const struct lu_env *env, struct dt_object *dt);
760
761 #ifndef HAVE_I_UID_READ
762 static inline uid_t i_uid_read(const struct inode *inode)
763 {
764         return inode->i_uid;
765 }
766
767 static inline gid_t i_gid_read(const struct inode *inode)
768 {
769         return inode->i_gid;
770 }
771
772 static inline void i_uid_write(struct inode *inode, uid_t uid)
773 {
774         inode->i_uid = uid;
775 }
776
777 static inline void i_gid_write(struct inode *inode, gid_t gid)
778 {
779         inode->i_gid = gid;
780 }
781 #endif
782
783 #ifdef LDISKFS_HT_MISC
784 # define osd_journal_start_sb(sb, type, nblock) \
785                 ldiskfs_journal_start_sb(sb, type, nblock)
786 # define osd_ldiskfs_append(handle, inode, nblock) \
787                 ldiskfs_append(handle, inode, nblock)
788 # define osd_ldiskfs_find_entry(dir, name, de, inlined, lock) \
789                 (__ldiskfs_find_entry(dir, name, de, inlined, lock) ?: \
790                  ERR_PTR(-ENOENT))
791 # define osd_journal_start(inode, type, nblocks) \
792                 ldiskfs_journal_start(inode, type, nblocks)
793 # define osd_transaction_size(dev) \
794                 (osd_journal(dev)->j_max_transaction_buffers / 2)
795 #else
796 # define LDISKFS_HT_MISC        0
797 # define osd_journal_start_sb(sb, type, nblock) \
798                 ldiskfs_journal_start_sb(sb, nblock)
799
800 static inline struct buffer_head *osd_ldiskfs_append(handle_t *handle,
801                                                      struct inode *inode,
802                                                      ldiskfs_lblk_t *nblock)
803 {
804         struct buffer_head *bh;
805         int err = 0;
806
807         bh = ldiskfs_append(handle, inode, nblock, &err);
808         if (bh == NULL)
809                 bh = ERR_PTR(err);
810
811         return bh;
812 }
813
814 # define osd_ldiskfs_find_entry(dir, name, de, inlined, lock) \
815                 (__ldiskfs_find_entry(dir, name, de, lock) ?: \
816                  ERR_PTR(-ENOENT))
817 # define osd_journal_start(inode, type, nblocks) \
818                 ldiskfs_journal_start(inode, nblocks)
819 # define osd_transaction_size(dev) \
820                 (osd_journal(dev)->j_max_transaction_buffers)
821 #endif
822
823 /*
824  * Invariants, assertions.
825  */
826
827 /*
828  * XXX: do not enable this, until invariant checking code is made thread safe
829  * in the face of pdirops locking.
830  */
831 #define OSD_INVARIANT_CHECKS (0)
832
833 #if OSD_INVARIANT_CHECKS
834 static inline int osd_invariant(const struct osd_object *obj)
835 {
836         return
837                 obj != NULL &&
838                 ergo(obj->oo_inode != NULL,
839                      obj->oo_inode->i_sb == osd_sb(osd_obj2dev(obj)) &&
840                      atomic_read(&obj->oo_inode->i_count) > 0) &&
841                 ergo(obj->oo_dir != NULL &&
842                      obj->oo_dir->od_conationer.ic_object != NULL,
843                      obj->oo_dir->od_conationer.ic_object == obj->oo_inode);
844 }
845 #else
846 #define osd_invariant(obj) (1)
847 #endif
848
849 #define OSD_MAX_CACHE_SIZE OBD_OBJECT_EOF
850
851 extern const struct dt_index_operations osd_otable_ops;
852
853 static inline int osd_oi_fid2idx(struct osd_device *dev,
854                                  const struct lu_fid *fid)
855 {
856         return fid->f_seq & (dev->od_oi_count - 1);
857 }
858
859 static inline struct osd_oi *osd_fid2oi(struct osd_device *osd,
860                                         const struct lu_fid *fid)
861 {
862         LASSERTF(!fid_is_idif(fid), DFID"\n", PFID(fid));
863         LASSERTF(!fid_is_last_id(fid), DFID"\n", PFID(fid));
864         LASSERTF(osd->od_oi_table != NULL && osd->od_oi_count >= 1,
865                  DFID"\n", PFID(fid));
866         /* It can work even od_oi_count equals to 1 although it's unexpected,
867          * the only reason we set it to 1 is for performance measurement */
868         return osd->od_oi_table[osd_oi_fid2idx(osd, fid)];
869 }
870
871 extern const struct lu_device_operations  osd_lu_ops;
872
873 static inline int lu_device_is_osd(const struct lu_device *d)
874 {
875         return ergo(d != NULL && d->ld_ops != NULL, d->ld_ops == &osd_lu_ops);
876 }
877
878 static inline struct osd_device *osd_dt_dev(const struct dt_device *d)
879 {
880         LASSERT(lu_device_is_osd(&d->dd_lu_dev));
881         return container_of0(d, struct osd_device, od_dt_dev);
882 }
883
884 static inline struct osd_device *osd_dev(const struct lu_device *d)
885 {
886         LASSERT(lu_device_is_osd(d));
887         return osd_dt_dev(container_of0(d, struct dt_device, dd_lu_dev));
888 }
889
890 static inline struct osd_device *osd_obj2dev(const struct osd_object *o)
891 {
892         return osd_dev(o->oo_dt.do_lu.lo_dev);
893 }
894
895 static inline struct super_block *osd_sb(const struct osd_device *dev)
896 {
897         return dev->od_mnt->mnt_sb;
898 }
899
900 static inline int osd_object_is_root(const struct osd_object *obj)
901 {
902         return osd_sb(osd_obj2dev(obj))->s_root->d_inode == obj->oo_inode;
903 }
904
905 static inline struct osd_object *osd_obj(const struct lu_object *o)
906 {
907         LASSERT(lu_device_is_osd(o->lo_dev));
908         return container_of0(o, struct osd_object, oo_dt.do_lu);
909 }
910
911 static inline struct osd_object *osd_dt_obj(const struct dt_object *d)
912 {
913         return osd_obj(&d->do_lu);
914 }
915
916 static inline struct lu_device *osd2lu_dev(struct osd_device *osd)
917 {
918         return &osd->od_dt_dev.dd_lu_dev;
919 }
920
921 static inline journal_t *osd_journal(const struct osd_device *dev)
922 {
923         return LDISKFS_SB(osd_sb(dev))->s_journal;
924 }
925
926 static inline struct seq_server_site *osd_seq_site(struct osd_device *osd)
927 {
928         return osd->od_dt_dev.dd_lu_dev.ld_site->ld_seq_site;
929 }
930
931 static inline char *osd_name(struct osd_device *osd)
932 {
933         return osd->od_dt_dev.dd_lu_dev.ld_obd->obd_name;
934 }
935
936 static inline bool osd_is_ea_inode(struct inode *inode)
937 {
938         return !!(LDISKFS_I(inode)->i_flags & LDISKFS_EA_INODE_FL);
939 }
940
941 extern const struct dt_body_operations osd_body_ops;
942 extern struct lu_context_key osd_key;
943
944 static inline struct osd_thread_info *osd_oti_get(const struct lu_env *env)
945 {
946         return lu_context_key_get(&env->le_ctx, &osd_key);
947 }
948
949 extern const struct dt_body_operations osd_body_ops_new;
950
951 /**
952  * IAM Iterator
953  */
954 static inline
955 struct iam_path_descr *osd_it_ipd_get(const struct lu_env *env,
956                                       const struct iam_container *bag)
957 {
958         return bag->ic_descr->id_ops->id_ipd_alloc(bag,
959                                            osd_oti_get(env)->oti_it_ipd);
960 }
961
962 static inline
963 struct iam_path_descr *osd_idx_ipd_get(const struct lu_env *env,
964                                        const struct iam_container *bag)
965 {
966         return bag->ic_descr->id_ops->id_ipd_alloc(bag,
967                                            osd_oti_get(env)->oti_idx_ipd);
968 }
969
970 static inline void osd_ipd_put(const struct lu_env *env,
971                                const struct iam_container *bag,
972                                struct iam_path_descr *ipd)
973 {
974         bag->ic_descr->id_ops->id_ipd_free(ipd);
975 }
976
977 int osd_calc_bkmap_credits(struct super_block *sb, struct inode *inode,
978                            const loff_t size, const loff_t pos,
979                            const int blocks);
980
981 int osd_ldiskfs_read(struct inode *inode, void *buf, int size, loff_t *offs);
982 int osd_ldiskfs_write_record(struct inode *inode, void *buf, int bufsize,
983                              int write_NUL, loff_t *offs, handle_t *handle);
984
985 static inline
986 struct dentry *osd_child_dentry_by_inode(const struct lu_env *env,
987                                          struct inode *inode,
988                                          const char *name, const int namelen)
989 {
990         struct osd_thread_info *info = osd_oti_get(env);
991         struct dentry *child_dentry = &info->oti_child_dentry;
992         struct dentry *obj_dentry = &info->oti_obj_dentry;
993
994         obj_dentry->d_inode = inode;
995         obj_dentry->d_sb = inode->i_sb;
996         obj_dentry->d_name.hash = 0;
997
998         child_dentry->d_name.hash = 0;
999         child_dentry->d_parent = obj_dentry;
1000         child_dentry->d_name.name = name;
1001         child_dentry->d_name.len = namelen;
1002         return child_dentry;
1003 }
1004
1005 extern int osd_trans_declare_op2rb[];
1006 extern int ldiskfs_track_declares_assert;
1007 void osd_trans_dump_creds(const struct lu_env *env, struct thandle *th);
1008
1009 static inline void osd_trans_declare_op(const struct lu_env *env,
1010                                         struct osd_thandle *oh,
1011                                         unsigned int op, int credits)
1012 {
1013         struct osd_thread_info *oti = osd_oti_get(env);
1014
1015         LASSERT(oh->ot_handle == NULL);
1016         if (unlikely(op >= OSD_OT_MAX)) {
1017                 if (unlikely(ldiskfs_track_declares_assert)) {
1018                         LASSERT(op < OSD_OT_MAX);
1019                 } else {
1020                         CWARN("%s: Invalid operation index %d\n",
1021                               osd_name(osd_dt_dev(oh->ot_super.th_dev)), op);
1022                         libcfs_debug_dumpstack(NULL);
1023                 }
1024         } else {
1025                 oti->oti_declare_ops[op]++;
1026                 oti->oti_declare_ops_cred[op] += credits;
1027         }
1028         oh->ot_credits += credits;
1029 }
1030
1031 static inline void osd_trans_exec_op(const struct lu_env *env,
1032                                      struct thandle *th, unsigned int op)
1033 {
1034         struct osd_thread_info *oti = osd_oti_get(env);
1035         struct osd_thandle     *oh  = container_of(th, struct osd_thandle,
1036                                                    ot_super);
1037         unsigned int            rb, left;
1038
1039         LASSERT(oh->ot_handle != NULL);
1040         if (unlikely(op >= OSD_OT_MAX)) {
1041                 if (unlikely(ldiskfs_track_declares_assert))
1042                         LASSERT(op < OSD_OT_MAX);
1043                 else {
1044                         CWARN("%s: Invalid operation index %d\n",
1045                               osd_name(osd_dt_dev(oh->ot_super.th_dev)), op);
1046                         libcfs_debug_dumpstack(NULL);
1047                         return;
1048                 }
1049         }
1050
1051         /* find rollback (or reverse) operation for the given one
1052          * such an operation doesn't require additional credits
1053          * as the same set of blocks are modified */
1054         rb = osd_trans_declare_op2rb[op];
1055
1056         /* check whether credits for this operation were reserved at all */
1057         if (unlikely(oti->oti_declare_ops_cred[op] == 0 &&
1058                      oti->oti_declare_ops_cred[rb] == 0)) {
1059                 /* the API is not perfect yet: CREATE does REF_ADD internally
1060                  * while DESTROY does not. To rollback CREATE the callers
1061                  * needs to call REF_DEL+DESTROY which is hard to detect using
1062                  * a simple table of rollback operations */
1063                 if (op == OSD_OT_REF_DEL &&
1064                     oti->oti_declare_ops_cred[OSD_OT_CREATE] > 0)
1065                         goto proceed;
1066                 if (op == OSD_OT_REF_ADD &&
1067                     oti->oti_declare_ops_cred[OSD_OT_DESTROY] > 0)
1068                         goto proceed;
1069                 osd_trans_dump_creds(env, th);
1070                 CERROR("%s: op = %d, rb = %d\n",
1071                        osd_name(osd_dt_dev(oh->ot_super.th_dev)), op, rb);
1072                 if (unlikely(ldiskfs_track_declares_assert))
1073                         LBUG();
1074         }
1075
1076 proceed:
1077         /* remember how many credits we have unused before the operation */
1078         oti->oti_credits_before = oh->ot_handle->h_buffer_credits;
1079         left = oti->oti_declare_ops_cred[op] - oti->oti_declare_ops_used[op];
1080         if (unlikely(oti->oti_credits_before < left)) {
1081                 osd_trans_dump_creds(env, th);
1082                 CERROR("%s: op = %d, rb = %d\n",
1083                        osd_name(osd_dt_dev(oh->ot_super.th_dev)), op, rb);
1084                 /* on a very small fs (testing?) it's possible that
1085                  * the transaction can't fit 1/4 of journal, so we
1086                  * just request less credits (see osd_trans_start()).
1087                  * ignore the same case here */
1088                 rb = osd_transaction_size(osd_dt_dev(th->th_dev));
1089                 if (unlikely(oh->ot_credits < rb)) {
1090                         if (unlikely(ldiskfs_track_declares_assert))
1091                                 LBUG();
1092                 }
1093         }
1094 }
1095
1096 static inline void osd_trans_exec_check(const struct lu_env *env,
1097                                         struct thandle *th,
1098                                         unsigned int op)
1099 {
1100         struct osd_thread_info *oti = osd_oti_get(env);
1101         struct osd_thandle     *oh  = container_of(th, struct osd_thandle,
1102                                                    ot_super);
1103         int                     used, over, quota;
1104
1105         /* how many credits have been used by the operation */
1106         used = oti->oti_credits_before - oh->ot_handle->h_buffer_credits;
1107
1108         if (unlikely(used < 0)) {
1109                 /* if some block was allocated and released in the same
1110                  * transaction, then it won't be a part of the transaction
1111                  * and delta can be negative */
1112                 return;
1113         }
1114
1115         if (used == 0) {
1116                 /* rollback operations (e.g. when we destroy just created
1117                  * object) should not consume any credits. there is no point
1118                  * to confuse the checks below */
1119                 return;
1120         }
1121
1122         oti->oti_declare_ops_used[op] += used;
1123         if (oti->oti_declare_ops_used[op] <= oti->oti_declare_ops_cred[op])
1124                 return;
1125
1126         /* we account quota for a whole transaction and any operation can
1127          * consume corresponding credits */
1128         over = oti->oti_declare_ops_used[op] -
1129                 oti->oti_declare_ops_cred[op];
1130         quota = oti->oti_declare_ops_cred[OSD_OT_QUOTA] -
1131                 oti->oti_declare_ops_used[OSD_OT_QUOTA];
1132         if (over <= quota) {
1133                 /* probably that credits were consumed by
1134                  * quota indirectly (in the depths of ldiskfs) */
1135                 oti->oti_declare_ops_used[OSD_OT_QUOTA] += over;
1136                 oti->oti_declare_ops_used[op] -= over;
1137         } else {
1138                 CWARN("op %d: used %u, used now %u, reserved %u\n",
1139                       op, oti->oti_declare_ops_used[op], used,
1140                       oti->oti_declare_ops_cred[op]);
1141                 osd_trans_dump_creds(env, th);
1142                 if (unlikely(ldiskfs_track_declares_assert))
1143                         LBUG();
1144         }
1145 }
1146
1147 /**
1148  * Helper function to pack the fid, ldiskfs stores fid in packed format.
1149  */
1150 static inline
1151 void osd_fid_pack(struct osd_fid_pack *pack, const struct dt_rec *fid,
1152                   struct lu_fid *befider)
1153 {
1154         fid_cpu_to_be(befider, (struct lu_fid *)fid);
1155         memcpy(pack->fp_area, befider, sizeof(*befider));
1156         pack->fp_len =  sizeof(*befider) + 1;
1157 }
1158
1159 static inline
1160 int osd_fid_unpack(struct lu_fid *fid, const struct osd_fid_pack *pack)
1161 {
1162         int result;
1163
1164         result = 0;
1165         switch (pack->fp_len) {
1166         case sizeof *fid + 1:
1167                 memcpy(fid, pack->fp_area, sizeof *fid);
1168                 fid_be_to_cpu(fid, fid);
1169                 break;
1170         default:
1171                 CERROR("Unexpected packed fid size: %d\n", pack->fp_len);
1172                 result = -EIO;
1173         }
1174         return result;
1175 }
1176
1177 /**
1178  * Quota/Accounting handling
1179  */
1180 extern const struct dt_index_operations osd_acct_index_ops;
1181 int osd_acct_obj_lookup(struct osd_thread_info *info, struct osd_device *osd,
1182                         const struct lu_fid *fid, struct osd_inode_id *id);
1183
1184 /* copy from fs/ext4/dir.c */
1185 static inline int is_32bit_api(void)
1186 {
1187 #ifdef CONFIG_COMPAT
1188         return is_compat_task();
1189 #else
1190         return (BITS_PER_LONG == 32);
1191 #endif
1192 }
1193
1194 static inline loff_t ldiskfs_get_htree_eof(struct file *filp)
1195 {
1196         if ((filp->f_mode & FMODE_32BITHASH) ||
1197             (!(filp->f_mode & FMODE_64BITHASH) && is_32bit_api()))
1198                 return LDISKFS_HTREE_EOF_32BIT;
1199         else
1200                 return LDISKFS_HTREE_EOF_64BIT;
1201 }
1202
1203 static inline int fid_is_internal(const struct lu_fid *fid)
1204 {
1205         return (!fid_is_namespace_visible(fid) && !fid_is_idif(fid));
1206 }
1207
1208 static inline unsigned long osd_remote_parent_ino(struct osd_device *dev)
1209 {
1210         return dev->od_mdt_map->omm_remote_parent->d_inode->i_ino;
1211 }
1212
1213 /**
1214  * ext4_bread/ldiskfs_bread has either 5 or 4 parameters. The error
1215  * return code has been removed and integrated into the pointer in the
1216  * kernel 3.18.
1217  */
1218 static inline struct buffer_head *__ldiskfs_bread(handle_t *handle,
1219                                                   struct inode *inode,
1220                                                   ldiskfs_lblk_t block,
1221                                                   int create)
1222 {
1223 #ifdef HAVE_EXT4_BREAD_4ARGS
1224         return ldiskfs_bread(handle, inode, block, create);
1225 #else
1226         struct buffer_head *bh;
1227         int error = 0;
1228
1229         bh = ldiskfs_bread(handle, inode, block, create, &error);
1230         if (bh == NULL && error != 0)
1231                 bh = ERR_PTR(error);
1232
1233         return bh;
1234 #endif
1235 }
1236
1237 void ldiskfs_inc_count(handle_t *handle, struct inode *inode);
1238 void ldiskfs_dec_count(handle_t *handle, struct inode *inode);
1239
1240 void osd_fini_iobuf(struct osd_device *d, struct osd_iobuf *iobuf);
1241
1242 #endif /* _OSD_INTERNAL_H */