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