Whamcloud - gitweb
LU-14734 osd-ldiskfs: enable large_dir automatically
[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.gnu.org/licenses/gpl-2.0.html
19  *
20  * GPL HEADER END
21  */
22 /*
23  * Copyright (c) 2007, 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  * lustre/osd/osd_internal.h
32  *
33  * Shared definitions and declarations for osd module
34  *
35  * Author: Nikita Danilov <nikita@clusterfs.com>
36  */
37
38 #ifndef _OSD_INTERNAL_H
39 #define _OSD_INTERNAL_H
40
41
42 /* struct mutex */
43 #include <linux/mutex.h>
44 /* struct rw_semaphore */
45 #include <linux/rwsem.h>
46 /* struct dentry */
47 #include <linux/dcache.h>
48 /* struct dirent64 */
49 #include <linux/dirent.h>
50 #include <linux/statfs.h>
51 #include <linux/bio.h>
52 #include <ldiskfs/ldiskfs.h>
53 #include <ldiskfs/ldiskfs_jbd2.h>
54
55 /* LUSTRE_OSD_NAME */
56 #include <obd.h>
57 /* class_register_type(), class_unregister_type() */
58 #include <obd_class.h>
59 #include <lustre_disk.h>
60 #include <dt_object.h>
61 #include <lustre_quota.h>
62
63 #include "osd_oi.h"
64 #include "osd_iam.h"
65 #include "osd_scrub.h"
66 #include "osd_quota_fmt.h"
67
68 struct inode;
69 extern struct kmem_cache *dynlock_cachep;
70
71 #define OSD_COUNTERS (0)
72
73 /* ldiskfs special inode::i_state_flags need to be accessed with
74  * ldiskfs_{set,clear,test}_inode_state() only */
75
76 /* OI scrub should skip this inode. */
77 #define LDISKFS_STATE_LUSTRE_NOSCRUB    31
78 #define LDISKFS_STATE_LUSTRE_DESTROY    30
79
80 /** Enable thandle usage statistics */
81 #define OSD_THANDLE_STATS (0)
82
83 #define MAX_OBJID_GROUP (FID_SEQ_ECHO + 1)
84
85 #define OBJECTS         "OBJECTS"
86 #define ADMIN_USR       "admin_quotafile_v2.usr"
87 #define ADMIN_GRP       "admin_quotafile_v2.grp"
88
89 /* Statfs space reservation for fragmentation and local objects */
90 #define OSD_STATFS_RESERVED             (1ULL << 23) /* 8MB */
91 #define OSD_STATFS_RESERVED_SHIFT       (7) /* reserve 0.78% of all space */
92
93 /* Default extent bytes when declaring write commit */
94 #define OSD_DEFAULT_EXTENT_BYTES        (1U << 20)
95
96 /* check if ldiskfs support project quota */
97 #ifndef LDISKFS_IOC_FSSETXATTR
98 #undef HAVE_PROJECT_QUOTA
99 #endif
100
101 #define OBD_BRW_MAPPED  OBD_BRW_LOCAL1
102
103 struct osd_directory {
104         struct iam_container od_container;
105         struct iam_descr     od_descr;
106 };
107
108 /*
109  * Object Index (oi) instance.
110  */
111 struct osd_oi {
112         /*
113          * underlying index object, where fid->id mapping in stored.
114          */
115         struct inode         *oi_inode;
116         struct osd_directory  oi_dir;
117 };
118
119 extern const int osd_dto_credits_noquota[];
120
121 struct osd_object {
122         struct dt_object        oo_dt;
123         /**
124          * Inode for file system object represented by this osd_object. This
125          * inode is pinned for the whole duration of lu_object life.
126          *
127          * Not modified concurrently (either setup early during object
128          * creation, or assigned by osd_create() under write lock).
129          */
130         struct inode           *oo_inode;
131         /**
132          * to protect index ops.
133          */
134         struct htree_lock_head *oo_hl_head;
135         struct rw_semaphore     oo_ext_idx_sem;
136         struct rw_semaphore     oo_sem;
137         struct osd_directory    *oo_dir;
138         /** protects inode attributes. */
139         spinlock_t              oo_guard;
140
141         /**
142          * Following two members *compat_dot* are used to indicate
143          * the presence of dot and dotdot in the given directory.
144          * This is required for interop mode (b11826).
145          */
146         __u32                   oo_destroyed:1,
147                                 oo_pfid_in_lma:1,
148                                 oo_compat_dot_created:1,
149                                 oo_compat_dotdot_created:1;
150
151         /* the i_flags in LMA */
152         __u32                   oo_lma_flags;
153
154         const struct lu_env    *oo_owner;
155
156         struct list_head        oo_xattr_list;
157         struct lu_object_header *oo_header;
158         __u64                   oo_dirent_count;
159 };
160
161 struct osd_obj_seq {
162         /* protects on-fly initialization */
163         int              oos_subdir_count; /* subdir count for each seq */
164         struct dentry    *oos_root;        /* O/<seq> */
165         struct dentry    **oos_dirs;       /* O/<seq>/d0-dXX */
166         u64              oos_seq;          /* seq number */
167         struct list_head oos_seq_list;     /* list to seq_list */
168 };
169
170 struct osd_obj_map {
171         struct dentry    *om_root;        /* dentry for /O */
172         rwlock_t         om_seq_list_lock; /* lock for seq_list */
173         struct list_head om_seq_list;      /* list head for seq */
174         int              om_subdir_count;
175         struct mutex     om_dir_init_mutex;
176 };
177
178 struct osd_mdobj {
179         struct dentry   *om_root;      /* AGENT/<index> */
180         u64              om_index;     /* mdt index */
181         struct list_head om_list;      /* list to omm_list */
182 };
183
184 struct osd_mdobj_map {
185         struct dentry   *omm_remote_parent;
186 };
187 int osd_ldiskfs_add_entry(struct osd_thread_info *info, struct osd_device *osd,
188                           handle_t *handle, struct dentry *child,
189                           struct inode *inode, struct htree_lock *hlock);
190
191 #define OSD_OTABLE_IT_CACHE_SIZE        64
192 #define OSD_OTABLE_IT_CACHE_MASK        (~(OSD_OTABLE_IT_CACHE_SIZE - 1))
193
194 struct osd_inconsistent_item {
195         /* link into lustre_scrub::os_inconsistent_items,
196          * protected by lustre_scrub::os_lock. */
197         struct list_head       oii_list;
198
199         /* The right FID <=> ino#/gen mapping. */
200         struct osd_idmap_cache oii_cache;
201
202         unsigned int           oii_insert:1; /* insert or update mapping. */
203 };
204
205 struct osd_otable_cache {
206         struct osd_idmap_cache ooc_cache[OSD_OTABLE_IT_CACHE_SIZE];
207
208         /* Index for next cache slot to be filled. */
209         int                    ooc_producer_idx;
210
211         /* Index for next cache slot to be returned by it::next(). */
212         int                    ooc_consumer_idx;
213
214         /* How many items in ooc_cache. */
215         __u64                  ooc_cached_items;
216
217         /* Position for up layer LFSCK iteration pre-loading. */
218         __u64                  ooc_pos_preload;
219 };
220
221 struct osd_otable_it {
222         struct osd_device       *ooi_dev;
223         struct osd_otable_cache  ooi_cache;
224         struct osd_iit_param     ooi_iit_param;
225
226         /* The following bits can be updated/checked w/o lock protection.
227          * If more bits will be introduced in the future and need lock to
228          * protect, please add comment. */
229         unsigned long            ooi_used_outside:1, /* Some user out of OSD
230                                                       * uses the iteration. */
231                                  ooi_all_cached:1, /* No more entries can be
232                                                     * filled into cache. */
233                                  ooi_user_ready:1, /* The user out of OSD is
234                                                     * ready to iterate. */
235                                  ooi_waiting:1; /* it::next is waiting. */
236 };
237
238 struct osd_obj_orphan {
239         struct list_head oor_list;
240         struct lu_env   *oor_env; /* to identify "own" records */
241         __u32 oor_ino;
242 };
243
244 enum osd_t10_type {
245         OSD_T10_TYPE_UNKNOWN = 0,
246         OSD_T10_TYPE1_CRC,
247         OSD_T10_TYPE3_CRC,
248         OSD_T10_TYPE1_IP,
249         OSD_T10_TYPE3_IP
250 };
251
252 /*
253  * osd device.
254  */
255 struct osd_device {
256         /* super-class */
257         struct dt_device          od_dt_dev;
258         /* information about underlying file system */
259         struct vfsmount          *od_mnt;
260         /* object index */
261         struct osd_oi           **od_oi_table;
262         /* total number of OI containers */
263         int                       od_oi_count;
264         /*
265          * Fid Capability
266          */
267         unsigned int              od_fl_capa:1,
268                                   od_maybe_new:1,
269                                   od_igif_inoi:1,
270                                   od_check_ff:1,
271                                   od_is_ost:1,
272                                   od_in_init:1,
273                                   od_index_in_idif:1,
274         /* Other flags */
275                                   od_read_cache:1,
276                                   od_writethrough_cache:1,
277                                   od_nonrotational:1;
278
279
280         __s64                     od_auto_scrub_interval;
281         __u32                     od_dirent_journal;
282         int                       od_index;
283         struct proc_dir_entry    *od_proc_entry;
284         struct lprocfs_stats     *od_stats;
285
286         spinlock_t                od_osfs_lock;
287
288         int                       od_fallocate_zero_blocks;
289         int                       od_connects;
290         struct lu_site            od_site;
291
292         struct osd_obj_map      *od_ost_map;
293         struct osd_mdobj_map    *od_mdt_map;
294
295         /* objects with size > od_readcache_max_filesize will be
296          * served bypassing pagecache unless already cached */
297         unsigned long long      od_readcache_max_filesize;
298
299         /* reads > od_readcache_max_iosize will be
300          * served bypassing pagecache unless already cached */
301         unsigned long           od_readcache_max_iosize;
302
303         /* writes > od_writethough_max_iosize will be
304          * served bypassing pagecache unless already cached */
305         unsigned long           od_writethrough_max_iosize;
306
307         struct brw_stats        od_brw_stats;
308         atomic_t                od_r_in_flight;
309         atomic_t                od_w_in_flight;
310
311         struct mutex              od_otable_mutex;
312         struct osd_otable_it     *od_otable_it;
313         struct osd_scrub          od_scrub;
314         struct list_head                  od_ios_list;
315
316         /* service name associated with the osd device */
317         char                      od_svname[MAX_OBD_NAME];
318         char                      od_mntdev[MAX_OBD_NAME];
319         uuid_t                  od_uuid;
320
321         /* quota slave instance for inode */
322         struct qsd_instance      *od_quota_slave_md;
323
324         /* quota slave instance for block */
325         struct qsd_instance      *od_quota_slave_dt;
326
327         /* osd seq instance */
328         struct lu_client_seq    *od_cl_seq;
329         /* If the ratio of "the total OI mappings count" vs
330          * "the bad OI mappings count" is lower than the
331          * osd_device::od_full_scrub_ratio, then trigger
332          * OI scrub to scan the whole the device. */
333         __u64                    od_full_scrub_ratio;
334         /* If the speed of found bad OI mappings (per minute)
335          * exceeds the osd_device::od_full_scrub_threshold_rate,
336          * then trigger OI scrub to scan the whole device. */
337         __u64                    od_full_scrub_threshold_rate;
338
339         /* a list of orphaned agent inodes, protected with od_osfs_lock */
340         struct list_head         od_orphan_list;
341         struct list_head         od_index_backup_list;
342         struct list_head         od_index_restore_list;
343         spinlock_t               od_lock;
344         struct inode            *od_index_backup_inode;
345         enum lustre_index_backup_policy od_index_backup_policy;
346         int                      od_index_backup_stop;
347         /* T10PI type, zero if not supported  */
348         enum osd_t10_type        od_t10_type;
349         atomic_t                 od_commit_cb_in_flight;
350         wait_queue_head_t        od_commit_cb_done;
351         unsigned int __percpu   *od_extent_bytes_percpu;
352 };
353
354 static inline struct qsd_instance *osd_def_qsd(struct osd_device *osd)
355 {
356         if (osd->od_is_ost)
357                 return osd->od_quota_slave_dt;
358         else
359                 return osd->od_quota_slave_md;
360 }
361
362 enum osd_full_scrub_ratio {
363         /* Trigger OI scrub to scan the whole device directly. */
364         OFSR_DIRECTLY   = 0,
365
366         /* Because the bad OI mappings count cannot be larger than
367          * the total OI mappints count, then setting OFSR_NEVER means
368          * that the whole device scanning cannot be triggered by auto
369          * detected bad OI mappings during the RPC services. */
370         OFSR_NEVER      = 1,
371         OFSR_DEFAULT    = 10000,
372 };
373
374 #define FULL_SCRUB_THRESHOLD_RATE_DEFAULT       60
375
376 /* There are at most 15 uid/gid/projids are affected in a transaction, and
377  * that's rename case:
378  * - 3 for source parent uid & gid & projid;
379  * - 3 for source child uid & gid & projid ('..' entry update when
380  * child is directory);
381  * - 3 for target parent uid & gid & projid;
382  * - 3 for target child uid & gid & projid(if the target child exists);
383  * - 3 for root uid & gid(last_rcvd, llog, etc);
384  *
385  */
386 #define OSD_MAX_UGID_CNT        15
387
388 enum osd_op_type {
389         OSD_OT_ATTR_SET         = 0,
390         OSD_OT_PUNCH,
391         OSD_OT_XATTR_SET,
392         OSD_OT_CREATE,
393         OSD_OT_DESTROY,
394         OSD_OT_REF_ADD,
395         OSD_OT_REF_DEL,
396         OSD_OT_WRITE,
397         OSD_OT_INSERT,
398         OSD_OT_DELETE,
399         OSD_OT_QUOTA,
400         OSD_OT_PREALLOC,
401         OSD_OT_MAX
402 };
403
404 struct osd_access_lock {
405         struct list_head         tl_list;
406         struct osd_object       *tl_obj;
407         loff_t                   tl_start;
408         loff_t                   tl_end;
409         int                      tl_mode;
410         bool                     tl_shared;
411         bool                     tl_truncate;
412         bool                     tl_punch;
413 };
414
415 struct osd_thandle {
416         struct thandle          ot_super;
417         handle_t               *ot_handle;
418         struct ldiskfs_journal_cb_entry ot_jcb;
419         struct list_head       ot_commit_dcb_list;
420         struct list_head       ot_stop_dcb_list;
421         /* Link to the device, for debugging. */
422         struct lu_ref_link      ot_dev_link;
423         unsigned int            ot_credits;
424         unsigned int            oh_declared_ext;
425
426         /* quota IDs related to the transaction */
427         unsigned short          ot_id_cnt;
428         __u8                    ot_id_res[OSD_MAX_UGID_CNT];
429         __u8                    ot_id_types[OSD_MAX_UGID_CNT];
430         uid_t                   ot_id_array[OSD_MAX_UGID_CNT];
431         struct lquota_trans    *ot_quota_trans;
432
433         unsigned int            ot_remove_agents:1;
434 #if OSD_THANDLE_STATS
435         /** time when this handle was allocated */
436         ktime_t oth_alloced;
437
438         /** time when this thanle was started */
439         ktime_t oth_started;
440 #endif
441         struct list_head        ot_trunc_locks;
442 };
443
444 /**
445  * Basic transaction credit op
446  */
447 enum dt_txn_op {
448         DTO_INDEX_INSERT,
449         DTO_INDEX_DELETE,
450         DTO_INDEX_UPDATE,
451         DTO_OBJECT_CREATE,
452         DTO_OBJECT_DELETE,
453         DTO_ATTR_SET_BASE,
454         DTO_XATTR_SET,
455         DTO_WRITE_BASE,
456         DTO_WRITE_BLOCK,
457         DTO_ATTR_SET_CHOWN,
458
459         DTO_NR
460 };
461
462 /*
463  * osd dev stats
464  */
465
466 #ifdef CONFIG_PROC_FS
467 enum {
468         LPROC_OSD_READ_BYTES    = 0,
469         LPROC_OSD_WRITE_BYTES   = 1,
470         LPROC_OSD_GET_PAGE      = 2,
471         LPROC_OSD_NO_PAGE       = 3,
472         LPROC_OSD_CACHE_ACCESS  = 4,
473         LPROC_OSD_CACHE_HIT     = 5,
474         LPROC_OSD_CACHE_MISS    = 6,
475
476 #if OSD_THANDLE_STATS
477         LPROC_OSD_THANDLE_STARTING,
478         LPROC_OSD_THANDLE_OPEN,
479         LPROC_OSD_THANDLE_CLOSING,
480 #endif
481         LPROC_OSD_LAST,
482 };
483 #endif
484
485 /**
486  * Storage representation for fids.
487  *
488  * Variable size, first byte contains the length of the whole record.
489  */
490 struct osd_fid_pack {
491         unsigned char fp_len;
492         char fp_area[sizeof(struct lu_fid)];
493 };
494
495 struct osd_it_ea_dirent {
496         struct lu_fid   oied_fid;
497         __u64           oied_ino;
498         __u64           oied_off;
499         unsigned short  oied_namelen;
500         unsigned int    oied_type;
501         char            oied_name[0];
502 } __attribute__((packed));
503
504 /**
505  * as osd_it_ea_dirent (in memory dirent struct for osd) is greater
506  * than lu_dirent struct. osd readdir reads less number of dirent than
507  * required for mdd dir page. so buffer size need to be increased so that
508  * there  would be one ext3 readdir for every mdd readdir page.
509  */
510
511 #define OSD_IT_EA_BUFSIZE       (PAGE_SIZE + PAGE_SIZE/4)
512
513 /**
514  * This is iterator's in-memory data structure in interoperability
515  * mode (i.e. iterator over ldiskfs style directory)
516  */
517 struct osd_it_ea {
518         struct osd_object       *oie_obj;
519         /** used in ldiskfs iterator, to stored file pointer */
520         struct file             oie_file;
521         /** how many entries have been read-cached from storage */
522         int                     oie_rd_dirent;
523         /** current entry is being iterated by caller */
524         int                     oie_it_dirent;
525         /** current processing entry */
526         struct osd_it_ea_dirent *oie_dirent;
527         /** buffer to hold entries, size == OSD_IT_EA_BUFSIZE */
528         void                    *oie_buf;
529         struct dentry           oie_dentry;
530 };
531
532 /**
533  * Iterator's in-memory data structure for IAM mode.
534  */
535 struct osd_it_iam {
536         struct osd_object     *oi_obj;
537         struct iam_path_descr *oi_ipd;
538         struct iam_iterator    oi_it;
539 };
540
541 struct osd_quota_leaf {
542         struct list_head        oql_link;
543         uint            oql_blk;
544 };
545
546 /**
547  * Iterator's in-memory data structure for quota file.
548  */
549 struct osd_it_quota {
550         struct osd_object       *oiq_obj;
551         /** tree blocks path to where the entry is stored */
552         uint                     oiq_blk[LUSTRE_DQTREEDEPTH + 1];
553         /** on-disk offset for current key where quota record can be found */
554         loff_t                   oiq_offset;
555         /** identifier for current quota record */
556         __u64                    oiq_id;
557         /** the record index in the leaf/index block */
558         uint                     oiq_index[LUSTRE_DQTREEDEPTH + 1];
559         /** list of already processed leaf blocks */
560         struct list_head         oiq_list;
561 };
562
563 #define MAX_BLOCKS_PER_PAGE (PAGE_SIZE / 512)
564
565 struct osd_iobuf {
566         wait_queue_head_t  dr_wait;
567         atomic_t       dr_numreqs;  /* number of reqs being processed */
568         int                dr_max_pages;
569         int                dr_npages;
570         int                dr_error;
571         int                dr_frags;
572         unsigned int       dr_elapsed_valid:1; /* we really did count time */
573         unsigned int       dr_rw:1;
574         struct lu_buf      dr_pg_buf;
575         struct page      **dr_pages;
576         struct niobuf_local     **dr_lnbs;
577         struct lu_buf      dr_bl_buf;
578         struct lu_buf      dr_lnb_buf;
579         sector_t          *dr_blocks;
580         ktime_t            dr_start_time;
581         ktime_t            dr_elapsed;  /* how long io took */
582         struct osd_device *dr_dev;
583         unsigned int       dr_init_at;  /* the line iobuf was initialized */
584 };
585
586 int osd_security_file_alloc(struct file *file);
587
588 #define osd_dirty_inode(inode, flag)  (inode)->i_sb->s_op->dirty_inode((inode), flag)
589
590 #ifdef HAVE_INODE_TIMESPEC64
591 # define osd_timespec                   timespec64
592 #else
593 # define osd_timespec                   timespec
594 #endif
595
596 static inline struct osd_timespec osd_inode_time(struct inode *inode,
597                                                  s64 seconds)
598 {
599         struct osd_timespec ts = { .tv_sec = seconds };
600
601         return ts;
602 }
603
604 #define OSD_INS_CACHE_SIZE      8
605
606 struct osd_thread_info {
607         const struct lu_env   *oti_env;
608         /**
609          * used for index operations.
610          */
611         struct dentry          oti_obj_dentry;
612         struct dentry          oti_child_dentry;
613
614         /** dentry for Iterator context. */
615         struct dentry           oti_it_dentry;
616
617         union {
618                 /* fake struct file for osd_object_sync */
619                 struct file             oti_file;
620                 /* osd_statfs() */
621                 struct kstatfs          oti_ksfs;
622         };
623
624         struct htree_lock     *oti_hlock;
625
626         struct lu_fid          oti_fid;
627         struct lu_fid          oti_fid2;
628         struct lu_fid          oti_fid3;
629         struct osd_inode_id    oti_id;
630         struct osd_inode_id    oti_id2;
631         struct osd_inode_id    oti_id3;
632         struct ost_id          oti_ostid;
633
634         /**
635          * following ipd and it structures are used for osd_index_iam_lookup()
636          * these are defined separately as we might do index operation
637          * in open iterator session.
638          */
639
640         /** pre-allocated buffer used by oti_it_ea, size OSD_IT_EA_BUFSIZE */
641         void                    *oti_it_ea_buf;
642         unsigned int            oti_it_ea_buf_used:1;
643
644         /* IAM iterator for index operation. */
645         struct iam_iterator    oti_idx_it;
646
647         /** union to guarantee that ->oti_ipd[] has proper alignment. */
648         union {
649                 char           oti_name[48];
650                 char           oti_it_ipd[DX_IPD_MAX_SIZE];
651                 long long      oti_alignment_lieutenant;
652         };
653
654         union {
655                 char           oti_idx_ipd[DX_IPD_MAX_SIZE];
656                 long long      oti_alignment_lieutenant_colonel;
657         };
658
659         struct osd_idmap_cache oti_cache;
660
661         /* dedicated OI cache for insert (which needs inum) */
662         struct osd_idmap_cache          *oti_ins_cache;
663         int                             oti_ins_cache_size;
664         int                             oti_ins_cache_used;
665         /* inc by osd_trans_create and dec by osd_trans_stop */
666         int                             oti_ins_cache_depth;
667
668         int                             oti_r_locks;
669         int                             oti_w_locks;
670         int                             oti_txns;
671         /** used in osd_fid_set() to put xattr */
672         struct lu_buf                   oti_buf;
673         struct lu_buf                   oti_big_buf;
674         /** used in osd_ea_fid_set() to set fid into common ea */
675         union {
676                 struct lustre_ost_attrs oti_ost_attrs;
677                 struct filter_fid_18_23 oti_ff_old;
678                 struct filter_fid       oti_ff;
679         };
680         /** 0-copy IO */
681         struct osd_iobuf                oti_iobuf;
682         /* used to access objects in /O */
683         struct inode                    *oti_inode;
684 #define OSD_FID_REC_SZ 32
685         char                            oti_ldp[OSD_FID_REC_SZ];
686         char                            oti_ldp2[OSD_FID_REC_SZ];
687
688         /* used by quota code */
689         union {
690 #if defined(HAVE_DQUOT_QC_DQBLK)
691                 struct qc_dqblk         oti_qdq;
692 #else
693                 struct fs_disk_quota    oti_fdq;
694 #endif
695                 struct if_dqinfo        oti_dqinfo;
696         };
697         struct lquota_id_info   oti_qi;
698         struct lquota_trans     oti_quota_trans;
699         union lquota_rec        oti_quota_rec;
700         __u64                   oti_quota_id;
701         struct lu_seq_range     oti_seq_range;
702
703         /* Tracking for transaction credits, to allow debugging and optimizing
704          * cases where a large number of credits are being allocated for
705          * single transaction. */
706         unsigned int            oti_credits_before;
707         unsigned int            oti_declare_ops[OSD_OT_MAX];
708         unsigned int            oti_declare_ops_cred[OSD_OT_MAX];
709         unsigned int            oti_declare_ops_used[OSD_OT_MAX];
710         struct osd_directory    oti_iam;
711
712         struct page             **oti_dio_pages;
713         int                     oti_dio_pages_used;
714
715         struct osd_it_ea_dirent *oti_seq_dirent;
716         struct osd_it_ea_dirent *oti_dir_dirent;
717 };
718
719 extern int ldiskfs_pdo;
720
721 /* autoconf test is in lustre-build-ldiskfs.m4 */
722 #ifdef HAVE_BVEC_ITER_ALL
723 #define DECLARE_BVEC_ITER_ALL(iter) struct bvec_iter_all iter
724 #else
725 #define DECLARE_BVEC_ITER_ALL(iter) int iter
726 #endif
727
728 static inline int __osd_xattr_get(struct inode *inode, struct dentry *dentry,
729                                   const char *name, void *buf, int len)
730 {
731         if (inode == NULL)
732                 return -EINVAL;
733
734         dentry->d_inode = inode;
735         dentry->d_sb = inode->i_sb;
736         return ll_vfs_getxattr(dentry, inode, name, buf, len);
737 }
738
739 static inline int __osd_xattr_set(struct osd_thread_info *info,
740                                   struct inode *inode, const char *name,
741                                   const void *buf, int buflen, int fl)
742 {
743         struct dentry *dentry = &info->oti_child_dentry;
744
745         dquot_initialize(inode);
746         dentry->d_inode = inode;
747         dentry->d_sb = inode->i_sb;
748         return ll_vfs_setxattr(dentry, inode, name, buf, buflen, fl);
749 }
750
751 static inline char *osd_oid_name(char *name, size_t name_size,
752                                  const struct lu_fid *fid, u64 id)
753 {
754         snprintf(name, name_size,
755                  (fid_seq_is_rsvd(fid_seq(fid)) ||
756                   fid_seq_is_mdt0(fid_seq(fid)) ||
757                   fid_seq_is_idif(fid_seq(fid))) ? "%llu" : "%llx", id);
758
759         return name;
760 }
761
762 #ifdef CONFIG_PROC_FS
763 /* osd_lproc.c */
764 extern struct lprocfs_vars lprocfs_osd_obd_vars[];
765 int osd_procfs_init(struct osd_device *osd, const char *name);
766 int osd_procfs_fini(struct osd_device *osd);
767 void osd_brw_stats_update(struct osd_device *osd, struct osd_iobuf *iobuf);
768 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(3, 0, 52, 0)
769 int osd_register_proc_index_in_idif(struct osd_device *osd);
770 #endif
771
772 #endif
773 int osd_statfs(const struct lu_env *env, struct dt_device *dev,
774                struct obd_statfs *sfs, struct obd_statfs_info *info);
775 struct inode *osd_iget(struct osd_thread_info *info, struct osd_device *dev,
776                        struct osd_inode_id *id);
777 struct inode *
778 osd_iget_fid(struct osd_thread_info *info, struct osd_device *dev,
779              struct osd_inode_id *id, struct lu_fid *fid);
780 int osd_ea_fid_set(struct osd_thread_info *info, struct inode *inode,
781                    const struct lu_fid *fid, __u32 compat, __u32 incompat);
782 struct osd_obj_seq *osd_seq_load(struct osd_thread_info *info,
783                                  struct osd_device *osd, u64 seq);
784 int osd_get_lma(struct osd_thread_info *info, struct inode *inode,
785                 struct dentry *dentry, struct lustre_ost_attrs *loa);
786 void osd_add_oi_cache(struct osd_thread_info *info, struct osd_device *osd,
787                       struct osd_inode_id *id, const struct lu_fid *fid);
788 int osd_get_idif(struct osd_thread_info *info, struct inode *inode,
789                  struct dentry *dentry, struct lu_fid *fid);
790 struct osd_it_ea *osd_it_dir_init(const struct lu_env *env, struct inode *inode,
791                                   __u32 attr);
792 void osd_it_dir_fini(const struct lu_env *env, struct osd_it_ea *oie,
793                      struct inode *inode);
794 int osd_ldiskfs_it_fill(const struct lu_env *env, const struct dt_it *di);
795
796 int osd_obj_map_init(const struct lu_env *env, struct osd_device *osd);
797 void osd_obj_map_fini(struct osd_device *dev);
798 int osd_obj_map_lookup(struct osd_thread_info *info, struct osd_device *osd,
799                         const struct lu_fid *fid, struct osd_inode_id *id);
800 int osd_obj_map_insert(struct osd_thread_info *info, struct osd_device *osd,
801                        const struct lu_fid *fid, const struct osd_inode_id *id,
802                        handle_t *th);
803 int osd_obj_map_delete(struct osd_thread_info *info, struct osd_device *osd,
804                         const struct lu_fid *fid, handle_t *th);
805 int osd_obj_map_update(struct osd_thread_info *info, struct osd_device *osd,
806                        const struct lu_fid *fid, const struct osd_inode_id *id,
807                        handle_t *th);
808 int osd_obj_map_recover(struct osd_thread_info *info, struct osd_device *osd,
809                         struct inode *src_parent, struct dentry *src_child,
810                         const struct lu_fid *fid);
811 int osd_obj_spec_lookup(struct osd_thread_info *info, struct osd_device *osd,
812                         const struct lu_fid *fid, struct osd_inode_id *id,
813                         enum oi_check_flags flags);
814 int osd_obj_spec_insert(struct osd_thread_info *info, struct osd_device *osd,
815                         const struct lu_fid *fid, const struct osd_inode_id *id,
816                         handle_t *th);
817 int osd_obj_spec_update(struct osd_thread_info *info, struct osd_device *osd,
818                         const struct lu_fid *fid, const struct osd_inode_id *id,
819                         handle_t *th);
820 int osd_obj_del_entry(struct osd_thread_info *info, struct osd_device *osd,
821                       struct dentry *dird, char *name, int namelen,
822                       handle_t *th);
823
824 char *osd_lf_fid2name(const struct lu_fid *fid);
825 int osd_scrub_start(const struct lu_env *env, struct osd_device *dev,
826                     __u32 flags);
827 void osd_scrub_stop(struct osd_device *dev);
828 int osd_scrub_setup(const struct lu_env *env, struct osd_device *dev,
829                     bool restored);
830 void osd_scrub_cleanup(const struct lu_env *env, struct osd_device *dev);
831 int osd_oii_insert(struct osd_device *dev, const struct lu_fid *fid,
832                    struct osd_inode_id *id, int insert);
833 int osd_oii_lookup(struct osd_device *dev, const struct lu_fid *fid,
834                    struct osd_inode_id *id);
835 void osd_scrub_dump(struct seq_file *m, struct osd_device *dev);
836
837 struct dentry *osd_lookup_one_len_unlocked(struct osd_device *dev,
838                                            const char *name,
839                                            struct dentry *base, int len);
840 struct dentry *osd_lookup_one_len(struct osd_device *dev, const char *name,
841                                   struct dentry *base, int len);
842
843 int osd_fld_lookup(const struct lu_env *env, struct osd_device *osd,
844                    u64 seq, struct lu_seq_range *range);
845
846 int osd_delete_from_remote_parent(const struct lu_env *env,
847                                   struct osd_device *osd,
848                                   struct osd_object *obj,
849                                   struct osd_thandle *oh, bool destroy);
850 int osd_add_to_remote_parent(const struct lu_env *env, struct osd_device *osd,
851                              struct osd_object *obj, struct osd_thandle *oh);
852 int osd_lookup_in_remote_parent(struct osd_thread_info *oti,
853                                 struct osd_device *osd,
854                                 const struct lu_fid *fid,
855                                 struct osd_inode_id *id);
856
857 int osd_ost_seq_exists(struct osd_thread_info *info, struct osd_device *osd,
858                        __u64 seq);
859 int osd_scrub_refresh_mapping(struct osd_thread_info *info,
860                               struct osd_device *dev,
861                               const struct lu_fid *fid,
862                               const struct osd_inode_id *id,
863                               int ops, bool force,
864                               enum oi_check_flags flags, bool *exist);
865
866 /* osd_quota_fmt.c */
867 int walk_tree_dqentry(const struct lu_env *env, struct osd_object *obj,
868                       int type, uint blk, int depth, uint index,
869                       struct osd_it_quota *it);
870 int walk_block_dqentry(const struct lu_env *env, struct osd_object *obj,
871                        int type, uint blk, uint index,
872                        struct osd_it_quota *it);
873 loff_t find_tree_dqentry(const struct lu_env *env,
874                          struct osd_object *obj, int type,
875                          qid_t dqid, uint blk, int depth,
876                          struct osd_it_quota *it);
877 /* osd_quota.c */
878 int osd_declare_qid(const struct lu_env *env, struct osd_thandle *oh,
879                     struct lquota_id_info *qi, struct osd_object *obj,
880                     bool enforce, enum osd_quota_local_flags *local_flags);
881 int osd_declare_inode_qid(const struct lu_env *env, qid_t uid, qid_t gid,
882                           __u32 projid, long long space, struct osd_thandle *oh,
883                           struct osd_object *obj,
884                           enum osd_quota_local_flags *local_flags,
885                           enum osd_qid_declare_flags);
886 const struct dt_rec *osd_quota_pack(struct osd_object *obj,
887                                     const struct dt_rec *rec,
888                                     union lquota_rec *quota_rec);
889 void osd_quota_unpack(struct osd_object *obj, const struct dt_rec *rec);
890
891 #ifdef HAVE_PROJECT_QUOTA
892 static inline __u32 i_projid_read(struct inode *inode)
893 {
894         return (__u32)from_kprojid(&init_user_ns, LDISKFS_I(inode)->i_projid);
895 }
896
897 static inline void i_projid_write(struct inode *inode, __u32 projid)
898 {
899         kprojid_t kprojid;
900         kprojid = make_kprojid(&init_user_ns, (projid_t)projid);
901         LDISKFS_I(inode)->i_projid = kprojid;
902 }
903 #else
904 static inline uid_t i_projid_read(struct inode *inode)
905 {
906         return 0;
907 }
908 static inline void i_projid_write(struct inode *inode, __u32 projid)
909 {
910         return;
911 }
912 #endif
913
914 #ifdef HAVE_LDISKFS_IGET_WITH_FLAGS
915 # define osd_ldiskfs_iget(sb, ino) \
916                 ldiskfs_iget((sb), (ino), \
917                              LDISKFS_IGET_HANDLE | LDISKFS_IGET_SPECIAL)
918 #else
919 # define osd_ldiskfs_iget(sb, ino) ldiskfs_iget((sb), (ino))
920 #endif
921
922 #ifdef HAVE_LDISKFS_INFO_JINODE
923 # define osd_attach_jinode(inode) ldiskfs_inode_attach_jinode(inode)
924 #else  /* HAVE_LDISKFS_INFO_JINODE */
925 # define osd_attach_jinode(inode) 0
926 #endif /* HAVE_LDISKFS_INFO_JINODE */
927
928 #ifdef LDISKFS_HT_MISC
929 # define osd_journal_start_sb(sb, type, nblock) \
930                 ldiskfs_journal_start_sb(sb, type, nblock)
931 static inline struct buffer_head *osd_ldiskfs_append(handle_t *handle,
932                                                      struct inode *inode,
933                                                      ldiskfs_lblk_t *nblock)
934 {
935         int rc;
936
937         rc = osd_attach_jinode(inode);
938         if (rc)
939                 return ERR_PTR(rc);
940         return ldiskfs_append(handle, inode, nblock);
941 }
942
943 # ifdef HAVE___LDISKFS_FIND_ENTRY
944 #  define osd_ldiskfs_find_entry(dir, name, de, inlined, lock) \
945                 (__ldiskfs_find_entry(dir, name, de, inlined, lock) ?: \
946                  ERR_PTR(-ENOENT))
947 # else
948 #  define osd_ldiskfs_find_entry(dir, name, de, inlined, lock) \
949                 (ldiskfs_find_entry_locked(dir, name, de, inlined, lock) ?: \
950                  ERR_PTR(-ENOENT))
951 # endif
952
953 # define osd_journal_start(inode, type, nblocks) \
954                 ldiskfs_journal_start(inode, type, nblocks)
955 # define osd_transaction_size(dev) \
956                 (osd_journal(dev)->j_max_transaction_buffers / 2)
957 #else /* ! defined LDISKFS_HT_MISC */
958 # define LDISKFS_HT_MISC        0
959 # define osd_journal_start_sb(sb, type, nblock) \
960                 ldiskfs_journal_start_sb(sb, nblock)
961
962 static inline struct buffer_head *osd_ldiskfs_append(handle_t *handle,
963                                                      struct inode *inode,
964                                                      ldiskfs_lblk_t *nblock)
965 {
966         struct buffer_head *bh;
967         int err = 0;
968
969         bh = ldiskfs_append(handle, inode, nblock, &err);
970         if (bh == NULL)
971                 bh = ERR_PTR(err);
972
973         return bh;
974 }
975
976 # ifdef HAVE___LDISKFS_FIND_ENTRY
977 #  define osd_ldiskfs_find_entry(dir, name, de, inlined, lock) \
978                 (__ldiskfs_find_entry(dir, name, de, lock) ?: \
979                  ERR_PTR(-ENOENT))
980 # else
981 #  define osd_ldiskfs_find_entry(dir, name, de, inlined, lock) \
982                 (ldiskfs_find_entry_locked(dir, name, de, lock) ?: \
983                  ERR_PTR(-ENOENT))
984 # endif
985 # define osd_journal_start(inode, type, nblocks) \
986                 ldiskfs_journal_start(inode, nblocks)
987 # define osd_transaction_size(dev) \
988                 (osd_journal(dev)->j_max_transaction_buffers)
989 #endif /* LDISKFS_HT_MISC */
990
991 #ifndef HAVE___LDISKFS_FIND_ENTRY
992 # define __ldiskfs_add_entry(handle, child, inode, hlock) \
993                 ldiskfs_add_entry_locked(handle, child, inode, hlock)
994 #endif
995
996 /*
997  * Invariants, assertions.
998  */
999
1000 /*
1001  * XXX: do not enable this, until invariant checking code is made thread safe
1002  * in the face of pdirops locking.
1003  */
1004 #define OSD_INVARIANT_CHECKS (0)
1005
1006 #if OSD_INVARIANT_CHECKS
1007 static inline int osd_invariant(const struct osd_object *obj)
1008 {
1009         return
1010                 obj != NULL &&
1011                 ergo(obj->oo_inode != NULL,
1012                      obj->oo_inode->i_sb == osd_sb(osd_obj2dev(obj)) &&
1013                      atomic_read(&obj->oo_inode->i_count) > 0) &&
1014                 ergo(obj->oo_dir != NULL &&
1015                      obj->oo_dir->od_conationer.ic_object != NULL,
1016                      obj->oo_dir->od_conationer.ic_object == obj->oo_inode);
1017 }
1018 #else
1019 #define osd_invariant(obj) (1)
1020 #endif
1021
1022 #define OSD_MAX_CACHE_SIZE OBD_OBJECT_EOF
1023 #define OSD_READCACHE_MAX_IO_MB         8
1024 #define OSD_WRITECACHE_MAX_IO_MB        8
1025
1026 extern const struct dt_index_operations osd_otable_ops;
1027
1028 static inline int osd_oi_fid2idx(struct osd_device *dev,
1029                                  const struct lu_fid *fid)
1030 {
1031         return fid->f_seq & (dev->od_oi_count - 1);
1032 }
1033
1034 static inline struct osd_oi *osd_fid2oi(struct osd_device *osd,
1035                                         const struct lu_fid *fid)
1036 {
1037         LASSERTF(!fid_is_idif(fid), DFID"\n", PFID(fid));
1038         LASSERTF(!fid_is_last_id(fid), DFID"\n", PFID(fid));
1039         LASSERTF(osd->od_oi_table != NULL && osd->od_oi_count >= 1,
1040                  DFID"\n", PFID(fid));
1041         /* It can work even od_oi_count equals to 1 although it's unexpected,
1042          * the only reason we set it to 1 is for performance measurement */
1043         return osd->od_oi_table[osd_oi_fid2idx(osd, fid)];
1044 }
1045
1046 extern const struct lu_device_operations  osd_lu_ops;
1047
1048 static inline int lu_device_is_osd(const struct lu_device *d)
1049 {
1050         return ergo(d != NULL && d->ld_ops != NULL, d->ld_ops == &osd_lu_ops);
1051 }
1052
1053 static inline struct osd_device *osd_dt_dev(const struct dt_device *d)
1054 {
1055         LASSERT(lu_device_is_osd(&d->dd_lu_dev));
1056         return container_of(d, struct osd_device, od_dt_dev);
1057 }
1058
1059 static inline struct osd_device *osd_dev(const struct lu_device *d)
1060 {
1061         LASSERT(lu_device_is_osd(d));
1062         return osd_dt_dev(container_of(d, struct dt_device, dd_lu_dev));
1063 }
1064
1065 static inline struct osd_device *osd_obj2dev(const struct osd_object *o)
1066 {
1067         return osd_dev(o->oo_dt.do_lu.lo_dev);
1068 }
1069
1070 static inline struct super_block *osd_sb(const struct osd_device *dev)
1071 {
1072         return dev->od_mnt->mnt_sb;
1073 }
1074
1075 static inline const char *osd_sb2name(const struct super_block *sb)
1076 {
1077         /* this is LDISKFS_SB(sb), but preserves "const" */
1078         const struct ldiskfs_sb_info *sbi = sb->s_fs_info;
1079
1080         return sbi->s_es->s_volume_name;
1081 }
1082
1083 static inline const char *osd_dev2name(const struct osd_device *dev)
1084 {
1085         return osd_sb2name(osd_sb(dev));
1086 }
1087
1088 static inline const char *osd_ino2name(const struct inode *inode)
1089 {
1090         return osd_sb2name(inode->i_sb);
1091 }
1092
1093 /**
1094  * Put the osd object once done with it.
1095  *
1096  * \param obj osd object that needs to be put
1097  */
1098 static inline void osd_object_put(const struct lu_env *env,
1099                                   struct osd_object *obj)
1100 {
1101         dt_object_put(env, &obj->oo_dt);
1102 }
1103
1104 static inline int osd_object_is_root(const struct osd_object *obj)
1105 {
1106         return obj->oo_inode && is_root_inode(obj->oo_inode);
1107 }
1108
1109 static inline struct osd_object *osd_obj(const struct lu_object *o)
1110 {
1111         LASSERT(lu_device_is_osd(o->lo_dev));
1112         return container_of(o, struct osd_object, oo_dt.do_lu);
1113 }
1114
1115 static inline struct osd_object *osd_dt_obj(const struct dt_object *d)
1116 {
1117         return osd_obj(&d->do_lu);
1118 }
1119
1120 static inline struct lu_device *osd2lu_dev(struct osd_device *osd)
1121 {
1122         return &osd->od_dt_dev.dd_lu_dev;
1123 }
1124
1125 static inline journal_t *osd_journal(const struct osd_device *dev)
1126 {
1127         return LDISKFS_SB(osd_sb(dev))->s_journal;
1128 }
1129
1130 static inline struct seq_server_site *osd_seq_site(struct osd_device *osd)
1131 {
1132         return osd->od_dt_dev.dd_lu_dev.ld_site->ld_seq_site;
1133 }
1134
1135 static inline char *osd_name(struct osd_device *osd)
1136 {
1137         return osd->od_svname;
1138 }
1139
1140 static inline bool osd_is_ea_inode(struct inode *inode)
1141 {
1142         return !!(LDISKFS_I(inode)->i_flags & LDISKFS_EA_INODE_FL);
1143 }
1144
1145 extern const struct dt_body_operations osd_body_ops;
1146 extern struct lu_context_key osd_key;
1147
1148 static inline struct osd_thread_info *osd_oti_get(const struct lu_env *env)
1149 {
1150         return lu_context_key_get(&env->le_ctx, &osd_key);
1151 }
1152
1153 extern const struct dt_body_operations osd_body_ops_new;
1154
1155 /**
1156  * IAM Iterator
1157  */
1158 static inline
1159 struct iam_path_descr *osd_it_ipd_get(const struct lu_env *env,
1160                                       const struct iam_container *bag)
1161 {
1162         return bag->ic_descr->id_ops->id_ipd_alloc(bag,
1163                                            osd_oti_get(env)->oti_it_ipd);
1164 }
1165
1166 static inline
1167 struct iam_path_descr *osd_idx_ipd_get(const struct lu_env *env,
1168                                        const struct iam_container *bag)
1169 {
1170         return bag->ic_descr->id_ops->id_ipd_alloc(bag,
1171                                            osd_oti_get(env)->oti_idx_ipd);
1172 }
1173
1174 static inline void osd_ipd_put(const struct lu_env *env,
1175                                const struct iam_container *bag,
1176                                struct iam_path_descr *ipd)
1177 {
1178         bag->ic_descr->id_ops->id_ipd_free(ipd);
1179 }
1180
1181 int osd_calc_bkmap_credits(struct super_block *sb, struct inode *inode,
1182                            const loff_t size, const loff_t pos,
1183                            const int blocks);
1184
1185 int osd_ldiskfs_read(struct inode *inode, void *buf, int size, loff_t *offs);
1186
1187 static inline
1188 struct dentry *osd_child_dentry_by_inode(const struct lu_env *env,
1189                                          struct inode *inode,
1190                                          const char *name, const int namelen)
1191 {
1192         struct osd_thread_info *info = osd_oti_get(env);
1193         struct dentry *child_dentry = &info->oti_child_dentry;
1194         struct dentry *obj_dentry = &info->oti_obj_dentry;
1195
1196         obj_dentry->d_inode = inode;
1197         obj_dentry->d_sb = inode->i_sb;
1198         obj_dentry->d_name.hash = 0;
1199
1200         child_dentry->d_name.hash = 0;
1201         child_dentry->d_parent = obj_dentry;
1202         child_dentry->d_name.name = name;
1203         child_dentry->d_name.len = namelen;
1204         return child_dentry;
1205 }
1206
1207 /* build quasi file structure when it is needed to call an inode i_fop */
1208 static inline struct file *osd_quasi_file_init(const struct lu_env *env,
1209                                                struct dentry *dentry,
1210                                                struct inode *inode)
1211 {
1212         struct osd_thread_info *info = osd_oti_get(env);
1213
1214         info->oti_file.f_path.dentry = dentry;
1215         info->oti_file.f_mapping = inode->i_mapping;
1216         info->oti_file.f_op = inode->i_fop;
1217         info->oti_file.f_inode = inode;
1218         info->oti_file.f_pos = 0;
1219         info->oti_file.private_data = NULL;
1220         info->oti_file.f_cred = current_cred();
1221         info->oti_file.f_flags = O_NOATIME;
1222         info->oti_file.f_mode = FMODE_64BITHASH | FMODE_NONOTIFY;
1223
1224         return &info->oti_file;
1225 }
1226
1227 static inline struct file *osd_quasi_file(const struct lu_env *env,
1228                                           struct inode *inode)
1229 {
1230         struct osd_thread_info *info = osd_oti_get(env);
1231
1232         info->oti_obj_dentry.d_inode = inode;
1233         info->oti_obj_dentry.d_sb = inode->i_sb;
1234
1235         return osd_quasi_file_init(env, &info->oti_obj_dentry, inode);
1236 }
1237
1238 static inline struct file *osd_quasi_file_by_dentry(const struct lu_env *env,
1239                                                     struct dentry *dentry)
1240 {
1241         return osd_quasi_file_init(env, dentry, dentry->d_inode);
1242 }
1243
1244 extern int osd_trans_declare_op2rb[];
1245 extern int ldiskfs_track_declares_assert;
1246 void osd_trans_dump_creds(const struct lu_env *env, struct thandle *th);
1247
1248 static inline void osd_trans_declare_op(const struct lu_env *env,
1249                                         struct osd_thandle *oh,
1250                                         enum osd_op_type op, int credits)
1251 {
1252         struct osd_thread_info *oti = osd_oti_get(env);
1253
1254         LASSERT(oh->ot_handle == NULL);
1255         if (unlikely(op >= OSD_OT_MAX)) {
1256                 if (unlikely(ldiskfs_track_declares_assert)) {
1257                         LASSERT(op < OSD_OT_MAX);
1258                 } else {
1259                         CWARN("%s: Invalid operation index %d\n",
1260                               osd_name(osd_dt_dev(oh->ot_super.th_dev)), op);
1261                         libcfs_debug_dumpstack(NULL);
1262                 }
1263         } else {
1264                 oti->oti_declare_ops[op]++;
1265                 oti->oti_declare_ops_cred[op] += credits;
1266         }
1267         oh->ot_credits += credits;
1268 }
1269
1270 /* linux: v5.4-rc3-21-g933f1c1e0b75 renamed h_buffer_credits */
1271 #ifdef HAVE_JOURNAL_TOTAL_CREDITS
1272 #define h_buffer_credits h_total_credits
1273 #endif
1274
1275 static inline void osd_trans_exec_op(const struct lu_env *env,
1276                                      struct thandle *th,
1277                                      enum osd_op_type op)
1278 {
1279         struct osd_thread_info *oti = osd_oti_get(env);
1280         struct osd_thandle     *oh  = container_of(th, struct osd_thandle,
1281                                                    ot_super);
1282         unsigned int            rb, left;
1283
1284         LASSERT(oh->ot_handle != NULL);
1285         if (unlikely(op >= OSD_OT_MAX)) {
1286                 if (unlikely(ldiskfs_track_declares_assert))
1287                         LASSERT(op < OSD_OT_MAX);
1288                 else {
1289                         CWARN("%s: opcode %u: invalid value >= %u\n",
1290                               osd_name(osd_dt_dev(oh->ot_super.th_dev)),
1291                               op, OSD_OT_MAX);
1292                         libcfs_debug_dumpstack(NULL);
1293                         return;
1294                 }
1295         }
1296
1297         /* find rollback (or reverse) operation for the given one
1298          * such an operation doesn't require additional credits
1299          * as the same set of blocks are modified */
1300         rb = osd_trans_declare_op2rb[op];
1301
1302         /* check whether credits for this operation were reserved at all */
1303         if (unlikely(oti->oti_declare_ops_cred[op] == 0 &&
1304                      oti->oti_declare_ops_cred[rb] == 0)) {
1305                 /* the API is not perfect yet: CREATE does REF_ADD internally
1306                  * while DESTROY does not. To rollback CREATE the callers
1307                  * needs to call REF_DEL+DESTROY which is hard to detect using
1308                  * a simple table of rollback operations */
1309                 if (op == OSD_OT_REF_DEL &&
1310                     oti->oti_declare_ops_cred[OSD_OT_CREATE] > 0)
1311                         goto proceed;
1312                 if (op == OSD_OT_REF_ADD &&
1313                     oti->oti_declare_ops_cred[OSD_OT_DESTROY] > 0)
1314                         goto proceed;
1315                 CWARN("%s: opcode %u: credits = 0, rollback = %u\n",
1316                       osd_name(osd_dt_dev(oh->ot_super.th_dev)), op, rb);
1317                 osd_trans_dump_creds(env, th);
1318                 LASSERT(!ldiskfs_track_declares_assert);
1319         }
1320
1321 proceed:
1322         /* remember how many credits we have unused before the operation */
1323         oti->oti_credits_before = oh->ot_handle->h_buffer_credits;
1324         left = oti->oti_declare_ops_cred[op] - oti->oti_declare_ops_used[op];
1325         if (unlikely(oti->oti_credits_before < left)) {
1326                 CWARN("%s: opcode %u: before %u < left %u, rollback = %u\n",
1327                       osd_name(osd_dt_dev(oh->ot_super.th_dev)), op,
1328                       oti->oti_credits_before, left, rb);
1329                 osd_trans_dump_creds(env, th);
1330                 /* on a very small fs (testing?) it's possible that
1331                  * the transaction can't fit 1/4 of journal, so we
1332                  * just request less credits (see osd_trans_start()).
1333                  * ignore the same case here */
1334                 rb = osd_transaction_size(osd_dt_dev(th->th_dev));
1335                 if (unlikely(oh->ot_credits < rb))
1336                         LASSERT(!ldiskfs_track_declares_assert);
1337         }
1338 }
1339
1340 static inline void osd_trans_exec_check(const struct lu_env *env,
1341                                         struct thandle *th,
1342                                         enum osd_op_type op)
1343 {
1344         struct osd_thread_info *oti = osd_oti_get(env);
1345         struct osd_thandle     *oh  = container_of(th, struct osd_thandle,
1346                                                    ot_super);
1347         int                     used, over, quota;
1348
1349         /* how many credits have been used by the operation */
1350         used = oti->oti_credits_before - oh->ot_handle->h_buffer_credits;
1351
1352         if (unlikely(used < 0)) {
1353                 /* if some block was allocated and released in the same
1354                  * transaction, then it won't be a part of the transaction
1355                  * and delta can be negative */
1356                 return;
1357         }
1358
1359         if (used == 0) {
1360                 /* rollback operations (e.g. when we destroy just created
1361                  * object) should not consume any credits. there is no point
1362                  * to confuse the checks below */
1363                 return;
1364         }
1365
1366         oti->oti_declare_ops_used[op] += used;
1367         if (oti->oti_declare_ops_used[op] <= oti->oti_declare_ops_cred[op])
1368                 return;
1369
1370         /* we account quota for a whole transaction and any operation can
1371          * consume corresponding credits */
1372         over = oti->oti_declare_ops_used[op] -
1373                 oti->oti_declare_ops_cred[op];
1374         quota = oti->oti_declare_ops_cred[OSD_OT_QUOTA] -
1375                 oti->oti_declare_ops_used[OSD_OT_QUOTA];
1376         if (over <= quota) {
1377                 /* probably that credits were consumed by
1378                  * quota indirectly (in the depths of ldiskfs) */
1379                 oti->oti_declare_ops_used[OSD_OT_QUOTA] += over;
1380                 oti->oti_declare_ops_used[op] -= over;
1381         } else {
1382                 CWARN("%s: opcode %d: used %u, used now %u, reserved %u\n",
1383                       osd_name(osd_dt_dev(oh->ot_super.th_dev)), op,
1384                       oti->oti_declare_ops_used[op], used,
1385                       oti->oti_declare_ops_cred[op]);
1386                 osd_trans_dump_creds(env, th);
1387                 if (unlikely(ldiskfs_track_declares_assert))
1388                         LBUG();
1389         }
1390 }
1391
1392 /**
1393  * Helper function to pack the fid, ldiskfs stores fid in packed format.
1394  */
1395 static inline
1396 void osd_fid_pack(struct osd_fid_pack *pack, const struct dt_rec *fid,
1397                   struct lu_fid *befider)
1398 {
1399         fid_cpu_to_be(befider, (struct lu_fid *)fid);
1400         memcpy(pack->fp_area, befider, sizeof(*befider));
1401         pack->fp_len =  sizeof(*befider) + 1;
1402 }
1403
1404 static inline
1405 int osd_fid_unpack(struct lu_fid *fid, const struct osd_fid_pack *pack)
1406 {
1407         int result;
1408
1409         result = 0;
1410         switch (pack->fp_len) {
1411         case sizeof *fid + 1:
1412                 memcpy(fid, pack->fp_area, sizeof *fid);
1413                 fid_be_to_cpu(fid, fid);
1414                 break;
1415         default:
1416                 CERROR("Unexpected packed fid size: %d\n", pack->fp_len);
1417                 result = -EIO;
1418         }
1419         return result;
1420 }
1421
1422 /**
1423  * Quota/Accounting handling
1424  */
1425 extern const struct dt_index_operations osd_acct_index_ops;
1426 int osd_acct_obj_lookup(struct osd_thread_info *info, struct osd_device *osd,
1427                         const struct lu_fid *fid, struct osd_inode_id *id);
1428
1429 /* copy from fs/ext4/dir.c */
1430 static inline int is_32bit_api(void)
1431 {
1432 #ifdef CONFIG_COMPAT
1433         return in_compat_syscall();
1434 #else
1435         return (BITS_PER_LONG == 32);
1436 #endif
1437 }
1438
1439 static inline loff_t ldiskfs_get_htree_eof(struct file *filp)
1440 {
1441         if ((filp->f_mode & FMODE_32BITHASH) ||
1442             (!(filp->f_mode & FMODE_64BITHASH) && is_32bit_api()))
1443                 return LDISKFS_HTREE_EOF_32BIT;
1444         else
1445                 return LDISKFS_HTREE_EOF_64BIT;
1446 }
1447
1448 static inline int fid_is_internal(const struct lu_fid *fid)
1449 {
1450         return (!fid_is_namespace_visible(fid) && !fid_is_idif(fid));
1451 }
1452
1453 static inline bool is_remote_parent_ino(struct osd_device *o, unsigned long ino)
1454 {
1455         if (o->od_is_ost)
1456                 return false;
1457
1458         LASSERT(o->od_mdt_map != NULL);
1459
1460         return ino == o->od_mdt_map->omm_remote_parent->d_inode->i_ino;
1461 }
1462
1463 /**
1464  * ext4_bread/ldiskfs_bread has either 5 or 4 parameters. The error
1465  * return code has been removed and integrated into the pointer in the
1466  * kernel 3.18.
1467  */
1468 static inline struct buffer_head *__ldiskfs_bread(handle_t *handle,
1469                                                   struct inode *inode,
1470                                                   ldiskfs_lblk_t block,
1471                                                   int create)
1472 {
1473         int rc = 0;
1474         struct buffer_head *bh;
1475
1476         if (create) {
1477                 rc = osd_attach_jinode(inode);
1478                 if (rc)
1479                         return ERR_PTR(rc);
1480         }
1481 #ifdef HAVE_EXT4_BREAD_4ARGS
1482         bh = ldiskfs_bread(handle, inode, block, create);
1483 #else
1484
1485         bh = ldiskfs_bread(handle, inode, block, create, &rc);
1486         if (bh == NULL && rc != 0)
1487                 bh = ERR_PTR(rc);
1488 #endif
1489         return bh;
1490 }
1491
1492 #ifndef HAVE_BIO_INTEGRITY_ENABLED
1493 bool bio_integrity_enabled(struct bio *bio);
1494 #endif
1495
1496 #ifdef HAVE_BI_BDEV
1497 # define bio_get_dev(bio)       ((bio)->bi_bdev)
1498 # define bio_get_disk(bio)      (bio_get_dev(bio)->bd_disk)
1499 # define bio_get_queue(bio)     bdev_get_queue(bio_get_dev(bio))
1500 # define bio_set_dev(bio, bdev) (bio_get_dev(bio) = (bdev))
1501 #else
1502 # define bio_get_disk(bio)      ((bio)->bi_disk)
1503 # define bio_get_queue(bio)     (bio_get_disk(bio)->queue)
1504 #endif
1505
1506 void ldiskfs_inc_count(handle_t *handle, struct inode *inode);
1507 void ldiskfs_dec_count(handle_t *handle, struct inode *inode);
1508
1509 void osd_fini_iobuf(struct osd_device *d, struct osd_iobuf *iobuf);
1510
1511 static inline int
1512 osd_index_register(struct osd_device *osd, const struct lu_fid *fid,
1513                    __u32 keysize, __u32 recsize)
1514 {
1515         return lustre_index_register(&osd->od_dt_dev, osd_name(osd),
1516                                      &osd->od_index_backup_list, &osd->od_lock,
1517                                      &osd->od_index_backup_stop,
1518                                      fid, keysize, recsize);
1519 }
1520
1521 static inline void
1522 osd_index_backup(const struct lu_env *env, struct osd_device *osd, bool backup)
1523 {
1524         struct osd_thread_info *info = osd_oti_get(env);
1525         struct lu_fid *fid = &info->oti_fid3;
1526         struct osd_inode_id *id = &info->oti_id3;
1527
1528         lu_local_obj_fid(fid, INDEX_BACKUP_OID);
1529         osd_id_gen(id, osd->od_index_backup_inode->i_ino,
1530                    osd->od_index_backup_inode->i_generation);
1531         osd_add_oi_cache(info, osd, id, fid);
1532
1533         lustre_index_backup(env, &osd->od_dt_dev, osd_name(osd),
1534                             &osd->od_index_backup_list, &osd->od_lock,
1535                             &osd->od_index_backup_stop, backup);
1536 }
1537
1538 #ifdef LDISKFS_HAS_INCOMPAT_FEATURE
1539
1540 # ifdef LDISKFS_FEATURE_INCOMPAT_EXTENTS
1541 # define ldiskfs_has_feature_extents(sb) \
1542         LDISKFS_HAS_INCOMPAT_FEATURE(sb, LDISKFS_FEATURE_INCOMPAT_EXTENTS)
1543 # endif
1544 # ifdef LDISKFS_FEATURE_INCOMPAT_EA_INODE
1545 # define ldiskfs_has_feature_ea_inode(sb) \
1546         LDISKFS_HAS_INCOMPAT_FEATURE(sb, LDISKFS_FEATURE_INCOMPAT_EA_INODE)
1547 # endif
1548 # ifdef LDISKFS_FEATURE_INCOMPAT_DIRDATA
1549 # define ldiskfs_has_feature_dirdata(sb) \
1550         LDISKFS_HAS_INCOMPAT_FEATURE(sb, LDISKFS_FEATURE_INCOMPAT_DIRDATA)
1551 # endif
1552 # ifdef LDISKFS_FEATURE_INCOMPAT_LARGEDIR
1553 # define ldiskfs_has_feature_largedir(sb) \
1554         LDISKFS_HAS_INCOMPAT_FEATURE(sb, LDISKFS_FEATURE_INCOMPAT_LARGEDIR)
1555 # define ldiskfs_set_feature_largedir(sb) \
1556         LDISKFS_SET_INCOMPAT_FEATURE(sb, LDISKFS_FEATURE_INCOMPAT_LARGEDIR)
1557 # endif
1558 # ifdef LDISKFS_FEATURE_COMPAT_HAS_JOURNAL
1559 # define ldiskfs_has_feature_journal(sb) \
1560         LDISKFS_HAS_COMPAT_FEATURE(sb, LDISKFS_FEATURE_COMPAT_HAS_JOURNAL)
1561 # endif
1562 # ifdef LDISKFS_FEATURE_RO_COMPAT_QUOTA
1563 # define ldiskfs_has_feature_quota(sb) \
1564         LDISKFS_HAS_RO_COMPAT_FEATURE(sb, LDISKFS_FEATURE_RO_COMPAT_QUOTA)
1565 # endif
1566 # ifdef LDISKFS_FEATURE_RO_COMPAT_PROJECT
1567 # define ldiskfs_has_feature_project(sb) \
1568         LDISKFS_HAS_RO_COMPAT_FEATURE(sb, LDISKFS_FEATURE_RO_COMPAT_PROJECT)
1569 # endif
1570
1571 #endif
1572
1573 int osd_trunc_lock(struct osd_object *obj, struct osd_thandle *oh,
1574                    bool shared);
1575 void osd_trunc_unlock_all(const struct lu_env *env, struct list_head *list);
1576 void osd_process_truncates(const struct lu_env *env, struct list_head *list);
1577 void osd_execute_truncate(struct osd_object *obj);
1578
1579 #ifdef HAVE_BIO_ENDIO_USES_ONE_ARG
1580 #define osd_dio_complete_routine(bio, error) dio_complete_routine(bio)
1581 #else
1582 #define osd_dio_complete_routine(bio, error) dio_complete_routine(bio, error)
1583 #endif
1584
1585 #ifndef HAVE___BI_CNT
1586 #define __bi_cnt bi_cnt
1587 #endif
1588
1589 #ifndef HAVE_BI_OPF
1590 #define bi_opf bi_rw
1591 #endif
1592
1593 #ifndef HAVE_CLEAN_BDEV_ALIASES
1594 #define clean_bdev_aliases(bdev, block, len)    \
1595         unmap_underlying_metadata((bdev), (block))
1596 #endif
1597
1598 #ifndef HAVE_BI_STATUS
1599 #define bi_status bi_error
1600 #endif
1601
1602 /*
1603  * Maximum size of xattr attributes for FEATURE_INCOMPAT_EA_INODE 1Mb
1604  * This limit is arbitrary, but is reasonable for the xattr API.
1605  */
1606 #define LDISKFS_XATTR_MAX_LARGE_EA_SIZE    (1024 * 1024)
1607
1608 struct osd_bio_private {
1609         struct osd_iobuf        *obp_iobuf;
1610         /* Start page index in the obp_iobuf for the bio */
1611         int                      obp_start_page_idx;
1612 };
1613
1614 #ifdef HAVE_BIO_INTEGRITY_PREP_FN
1615 int osd_get_integrity_profile(struct osd_device *osd,
1616                               integrity_gen_fn **generate_fn,
1617                               integrity_vrfy_fn **verify_fn);
1618 #else
1619 #define integrity_gen_fn void
1620 #define integrity_vrfy_fn int
1621 static inline int osd_get_integrity_profile(struct osd_device *osd,
1622                                             integrity_gen_fn **generate_fn,
1623                                             integrity_vrfy_fn **verify_fn)
1624 {
1625         return 0;
1626 }
1627
1628 static inline bool bio_integrity_prep_fn(struct bio *bio,
1629                                          integrity_gen_fn *generate_fn,
1630                                          integrity_vrfy_fn *verify_fn)
1631 {
1632         return bio_integrity_prep(bio);
1633 }
1634 #endif
1635
1636 #ifdef HAVE_BIO_BI_PHYS_SEGMENTS
1637 #define osd_bio_nr_segs(bio)            ((bio)->bi_phys_segments)
1638 #else
1639 #define osd_bio_nr_segs(bio)            bio_segments((bio))
1640 #endif /* HAVE_BIO_BI_PHYS_SEGMENTS */
1641
1642 #endif /* _OSD_INTERNAL_H */