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