Whamcloud - gitweb
dc220216418c39b7ac68959eec2079d3e558bc26
[fs/lustre-release.git] / lustre / osd-zfs / 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) 2009, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Use is subject to license terms.
25  *
26  * Copyright (c) 2012, 2017, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  *
31  * lustre/osd-zfs/osd_internal.h
32  * Shared definitions and declarations for zfs/dmu osd
33  *
34  * Author: Alex Zhuravlev <bzzz@whamcloud.com>
35  * Author: Mike Pershin <tappro@whamcloud.com>
36  * Author: Johann Lombardi <johann@whamcloud.com>
37  */
38
39 #ifndef _OSD_INTERNAL_H
40 #define _OSD_INTERNAL_H
41
42 #include <dt_object.h>
43 #include <md_object.h>
44 #include <lustre_quota.h>
45 #include <lustre_scrub.h>
46 #include <obd.h>
47 #ifdef SHRINK_STOP
48 #undef SHRINK_STOP
49 #endif
50 #include <sys/arc.h>
51 #include <sys/nvpair.h>
52 #include <sys/zfs_znode.h>
53 #include <sys/zap.h>
54 #include <sys/dbuf.h>
55 #include <sys/dmu_objset.h>
56 #include <lustre_scrub.h>
57
58 /**
59  * By design including kmem.h overrides the Linux slab interfaces to provide
60  * the Illumos kmem cache interfaces.  To override this and gain access to
61  * the Linux interfaces these preprocessor macros must be undefined.
62  */
63 #ifdef kmem_cache_destroy
64 #undef kmem_cache_destroy
65 #endif
66
67 #ifdef kmem_cache_create
68 #undef kmem_cache_create
69 #endif
70
71 #ifdef kmem_cache_alloc
72 #undef kmem_cache_alloc
73 #endif
74
75 #ifdef kmem_cache_free
76 #undef kmem_cache_free
77 #endif
78
79 #define ZFS_VERSION_CODE        \
80         OBD_OCD_VERSION(ZFS_MAJOR, ZFS_MINOR, ZFS_PATCH, ZFS_FIX)
81
82 #define LUSTRE_ROOT_FID_SEQ     0
83 #define DMU_OSD_SVNAME          "svname"
84 #define DMU_OSD_OI_NAME_BASE    "oi"
85
86 #define OSD_GFP_IO              (GFP_NOFS | __GFP_HIGHMEM)
87
88 /* Statfs space reservation for grant, fragmentation, and unlink space. */
89 #define OSD_STATFS_RESERVED_SIZE        (16ULL << 20) /* reserve 16MB minimum */
90 #define OSD_STATFS_RESERVED_SHIFT       (7)     /* reserve 0.78% of all space */
91
92 /* Statfs {minimum, safe estimate, and maximum} dnodes per block */
93 #define OSD_DNODE_MIN_BLKSHIFT  (DNODES_PER_BLOCK_SHIFT)
94 #define OSD_DNODE_EST_BLKSHIFT  (12)     /* est 4KB/dnode */
95 #define OSD_DNODE_EST_COUNT     4096
96
97 #define OSD_GRANT_FOR_LOCAL_OIDS (2ULL << 20) /* 2MB for last_rcvd, ... */
98
99 #define OSD_MAX_CACHE_SIZE OBD_OBJECT_EOF
100
101 #ifndef HAVE_ZFS_REFCOUNT_ADD
102 #define zfs_refcount_add        refcount_add
103 #endif
104
105 extern const struct dt_body_operations osd_body_scrub_ops;
106 extern const struct dt_body_operations osd_body_ops;
107 extern struct kmem_cache *osd_object_kmem;
108
109 /**
110  * Iterator's in-memory data structure for quota file.
111  */
112 struct osd_it_quota {
113         struct osd_object       *oiq_obj;
114         /* DMU accounting object id */
115         uint64_t                 oiq_oid;
116         /* ZAP cursor */
117         zap_cursor_t            *oiq_zc;
118         /** identifier for current quota record */
119         __u64                    oiq_id;
120         unsigned                 oiq_reset:1; /* 1 -- no need to advance */
121 };
122
123 enum osd_zap_pos {
124         OZI_POS_INIT = 0,
125         OZI_POS_DOT = 1,        /* cursor at . */
126         OZI_POS_DOTDOT = 2,     /* cursor at .. */
127         OZI_POS_REAL = 3,       /* cursor at real entries */
128 };
129
130 /**
131  * Iterator's in-memory data structure for ZAPs
132  *
133  * ZFS does not store . and .. on a disk, instead they are
134  * generated up on request
135  * to follow this format we do the same
136  */
137 struct osd_zap_it {
138         zap_cursor_t            *ozi_zc;
139         struct osd_object       *ozi_obj;
140         unsigned                 ozi_reset:1;   /* 1 -- no need to advance */
141         /* ozi_pos - position of the cursor */
142         enum osd_zap_pos        ozi_pos;
143         union {
144                 char             ozi_name[MAXNAMELEN]; /* file name for dir */
145                 __u64            ozi_key; /* binary key for index files */
146         };
147 };
148 #define DT_IT2DT(it) (&((struct osd_zap_it *)it)->ozi_obj->oo_dt)
149
150 /*
151  * regular ZFS direntry
152  */
153 struct zpl_direntry {
154         uint64_t        zde_dnode:48,
155                         zde_pad:12,
156                         zde_type:4;
157 } __attribute__((packed));
158
159 /*
160  * lustre direntry adds a fid to regular ZFS direntry
161  */
162 struct luz_direntry {
163         struct zpl_direntry     lzd_reg;
164         struct lu_fid           lzd_fid;
165 } __attribute__((packed));
166
167
168 /* cached SA attributes */
169 struct osa_attr {
170         uint64_t        mode;
171         uint64_t        gid;
172         uint64_t        uid;
173 #ifdef ZFS_PROJINHERIT
174         uint64_t        projid;
175 #endif
176         uint64_t        nlink;
177         uint64_t        rdev;
178         uint64_t        flags;
179         uint64_t        size;
180         uint64_t        atime[2];
181         uint64_t        mtime[2];
182         uint64_t        ctime[2];
183         uint64_t        btime[2];
184 };
185
186
187 #define OSD_INS_CACHE_SIZE      8
188
189 /* OI cache entry */
190 struct osd_idmap_cache {
191         struct osd_device       *oic_dev;
192         struct lu_fid           oic_fid;
193         /** max 2^48 dnodes per dataset, avoid spilling into another word */
194         uint64_t                oic_dnode:DN_MAX_OBJECT_SHIFT,
195                                 oic_remote:1;      /* FID isn't local */
196 };
197
198 struct osd_inconsistent_item {
199         /* link into lustre_scrub::os_inconsistent_items,
200          * protected by lustr_scrub::os_lock. */
201         struct list_head       oii_list;
202
203         /* The right FID <=> oid mapping. */
204         struct osd_idmap_cache oii_cache;
205
206         unsigned int           oii_insert:1; /* insert or update mapping. */
207 };
208
209 struct osd_otable_it {
210         struct osd_device       *ooi_dev;
211         struct lu_fid            ooi_fid;
212         __u64                    ooi_pos;
213         __u64                    ooi_prefetched_dnode;
214         int                      ooi_prefetched;
215
216         /* The following bits can be updated/checked w/o lock protection.
217          * If more bits will be introduced in the future and need lock to
218          * protect, please add comment. */
219         unsigned int             ooi_used_outside:1, /* Some user out of OSD
220                                                       * uses the iteration. */
221                                  ooi_all_cached:1, /* No more entries can be
222                                                     * filled into cache. */
223                                  ooi_user_ready:1, /* The user out of OSD is
224                                                     * ready to iterate. */
225                                  ooi_waiting:1; /* it::next is waiting. */
226 };
227
228 extern const struct dt_index_operations osd_otable_ops;
229
230 /* max.number of regular attributes the callers may ask for */
231 # define OSD_MAX_IN_BULK (sizeof(struct osa_attr)/sizeof(uint64_t))
232
233 struct osd_thread_info {
234         const struct lu_env     *oti_env;
235
236         struct lu_fid            oti_fid;
237
238         struct ost_id            oti_ostid;
239
240         char                     oti_buf[64];
241
242         char                     oti_str[64];
243         union {
244                 char             oti_key[MAXNAMELEN + 1];
245                 __u64            oti_key64[(MAXNAMELEN + 1)/sizeof(__u64)];
246                 sa_bulk_attr_t   oti_attr_bulk[OSD_MAX_IN_BULK];
247         };
248         struct lustre_mdt_attrs  oti_mdt_attrs;
249         unsigned int             oti_in_trans:1;
250
251         struct lu_attr           oti_la;
252         struct osa_attr          oti_osa;
253         zap_attribute_t          oti_za;
254         zap_attribute_t          oti_za2;
255         dmu_object_info_t        oti_doi;
256         struct luz_direntry      oti_zde;
257
258         struct lquota_id_info    oti_qi;
259         struct lu_seq_range      oti_seq_range;
260
261         /* dedicated OI cache for insert (which needs inum) */
262         struct osd_idmap_cache *oti_ins_cache;
263         int                    oti_ins_cache_size;
264         int                    oti_ins_cache_used;
265         /* inc by osd_trans_create and dec by osd_trans_stop */
266         int                    oti_ins_cache_depth;
267         struct lu_buf          oti_xattr_lbuf;
268         zap_cursor_t           oti_zc;
269         zap_cursor_t           oti_zc2;
270 };
271
272 extern struct lu_context_key osd_key;
273
274 static inline struct osd_thread_info *osd_oti_get(const struct lu_env *env)
275 {
276         return lu_context_key_get(&env->le_ctx, &osd_key);
277 }
278
279 struct osd_thandle {
280         struct thandle           ot_super;
281         struct list_head         ot_dcb_list;
282         struct list_head         ot_stop_dcb_list;
283         struct list_head         ot_unlinked_list;
284         struct list_head         ot_sa_list;
285         dmu_tx_t                *ot_tx;
286         struct lquota_trans      ot_quota_trans;
287         __u32                    ot_assigned:1;
288 };
289
290 #define OSD_OI_NAME_SIZE        24
291
292 /*
293  * Object Index (OI) instance.
294  */
295 struct osd_oi {
296         char                    oi_name[OSD_OI_NAME_SIZE];
297         uint64_t                oi_zapid;
298         dnode_t *oi_dn;
299 };
300
301 struct osd_seq {
302         uint64_t         os_oid;
303         uint64_t         *os_compat_dirs;
304         int              os_subdir_count; /* subdir count for each seq */
305         u64              os_seq;          /* seq number */
306         struct list_head os_seq_list;     /* list to seq_list */
307 };
308
309 struct osd_seq_list {
310         rwlock_t         osl_seq_list_lock;     /* lock for seq_list */
311         struct list_head osl_seq_list;          /* list head for seq */
312         struct semaphore osl_seq_init_sem;
313 };
314
315 #define OSD_OST_MAP_SIZE        32
316
317 /*
318  * osd device.
319  */
320 struct osd_device {
321         /* super-class */
322         struct dt_device         od_dt_dev;
323         /* information about underlying file system */
324         struct objset           *od_os;
325         uint64_t                 od_rootid;  /* id of root znode */
326         dnode_t *od_unlinked; /* dnode of unlinked zapobj */
327         /* SA attr mapping->id,
328          * name is the same as in ZFS to use defines SA_ZPL_...*/
329         sa_attr_type_t           *z_attr_table;
330
331         struct proc_dir_entry   *od_proc_entry;
332         struct lprocfs_stats    *od_stats;
333
334         uint64_t                 od_remote_parent_dir;
335         uint64_t                 od_index_backup_id;
336         uint64_t                 od_max_blksz;
337         uint64_t                 od_root;
338         uint64_t                 od_O_id;
339         struct osd_oi           **od_oi_table;
340         unsigned int             od_oi_count;
341         struct osd_seq_list     od_seq_list;
342
343         unsigned int             od_dev_set_rdonly:1, /**< osd_ro() called */
344                                  od_prop_rdonly:1,  /**< ZFS property readonly */
345                                  od_xattr_in_sa:1,
346                                  od_is_ost:1,
347                                  od_in_init:1,
348                                  od_posix_acl:1,
349                                  od_nonrotational:1;
350         unsigned int             od_dnsize;
351         int                      od_index_backup_stop;
352
353         enum lustre_index_backup_policy od_index_backup_policy;
354         char                     od_mntdev[128];
355         char                     od_svname[128];
356         uuid_t                   od_uuid;
357
358         int                      od_connects;
359         int                      od_index;
360         __s64                    od_auto_scrub_interval;
361         struct lu_site           od_site;
362
363         dnode_t                 *od_groupused_dn;
364         dnode_t                 *od_userused_dn;
365 #ifdef ZFS_PROJINHERIT
366         dnode_t                 *od_projectused_dn;
367 #endif
368
369         /* quota slave instance for inode */
370         struct qsd_instance     *od_quota_slave_md;
371
372         /* quota slave instance for block */
373         struct qsd_instance     *od_quota_slave_dt;
374
375         struct brw_stats        od_brw_stats;
376         atomic_t                od_r_in_flight;
377         atomic_t                od_w_in_flight;
378
379         /* used to debug zerocopy logic: the fields track all
380          * allocated, loaned and referenced buffers in use.
381          * to be removed once the change is tested well. */
382         atomic_t                 od_zerocopy_alloc;
383         atomic_t                 od_zerocopy_loan;
384         atomic_t                 od_zerocopy_pin;
385
386         arc_prune_t             *arc_prune_cb;
387
388         /* osd seq instance */
389         struct lu_client_seq    *od_cl_seq;
390
391         struct semaphore         od_otable_sem;
392         struct osd_otable_it    *od_otable_it;
393         struct lustre_scrub      od_scrub;
394         struct list_head         od_ios_list;
395         struct list_head         od_index_backup_list;
396         struct list_head         od_index_restore_list;
397         spinlock_t               od_lock;
398         unsigned long long       od_readcache_max_filesize;
399 };
400
401 static inline struct qsd_instance *osd_def_qsd(struct osd_device *osd)
402 {
403         if (osd->od_is_ost)
404                 return osd->od_quota_slave_dt;
405         else
406                 return osd->od_quota_slave_md;
407 }
408
409 enum osd_destroy_type {
410         OSD_DESTROY_NONE = 0,
411         OSD_DESTROY_SYNC = 1,
412         OSD_DESTROY_ASYNC = 2,
413 };
414
415 struct osd_object {
416         struct dt_object         oo_dt;
417         /*
418          * Inode for file system object represented by this osd_object. This
419          * inode is pinned for the whole duration of lu_object life.
420          *
421          * Not modified concurrently (either setup early during object
422          * creation, or assigned by osd_create() under write lock).
423          */
424         dnode_t *oo_dn;
425         sa_handle_t             *oo_sa_hdl;
426         nvlist_t                *oo_sa_xattr;
427         struct list_head         oo_sa_linkage;
428
429         /* used to implement osd_object_*_{lock|unlock} */
430         struct rw_semaphore      oo_sem;
431
432         /* to serialize some updates: destroy vs. others,
433          * xattr_set, object block size change etc */
434         struct rw_semaphore      oo_guard;
435
436         /* protected by oo_guard */
437         struct list_head         oo_unlinked_linkage;
438
439         /* cached attributes */
440         rwlock_t                 oo_attr_lock;
441         struct lu_attr           oo_attr;
442
443         /* external dnode holding large EAs, protected by oo_guard */
444         uint64_t                 oo_xattr;
445         enum osd_destroy_type    oo_destroy;
446
447         __u32                    oo_destroyed:1,
448                                  oo_late_xattr:1,
449 #ifdef ZFS_PROJINHERIT
450                                  oo_with_projid:1,
451 #endif
452                                  oo_late_attr_set:1,
453                                  oo_pfid_in_lma:1;
454
455         /* the i_flags in LMA */
456         __u32                    oo_lma_flags;
457         union {
458                 int             oo_ea_in_bonus; /* EA bytes we expect */
459                 struct {
460                         /* record size for index file */
461                         unsigned char            oo_keysize;
462                         unsigned char            oo_recsize;
463                         unsigned char            oo_recusize;   /* unit size */
464                 };
465                 uint64_t        oo_parent; /* used only at object creation */
466         };
467         struct lu_object_header *oo_header;
468 };
469
470 int osd_statfs(const struct lu_env *, struct dt_device *, struct obd_statfs *,
471                struct obd_statfs_info *);
472 extern const struct dt_index_operations osd_acct_index_ops;
473 extern const struct lu_device_operations  osd_lu_ops;
474 extern const struct dt_index_operations osd_dir_ops;
475 int osd_declare_quota(const struct lu_env *env, struct osd_device *osd,
476                       qid_t uid, qid_t gid, qid_t projid, long long space,
477                       struct osd_thandle *oh,
478                       enum osd_quota_local_flags *local_flags,
479                       enum osd_qid_declare_flags osd_qid_declare_flags);
480 uint64_t osd_objs_count_estimate(uint64_t refdbytes, uint64_t usedobjs,
481                                  uint64_t nrblocks, uint64_t est_maxblockshift);
482 int osd_unlinked_object_free(const struct lu_env *env, struct osd_device *osd,
483                          uint64_t oid);
484
485 /*
486  * Helpers.
487  */
488 static inline int lu_device_is_osd(const struct lu_device *d)
489 {
490         return ergo(d != NULL && d->ld_ops != NULL, d->ld_ops == &osd_lu_ops);
491 }
492
493 static inline struct osd_object *osd_obj(const struct lu_object *o)
494 {
495         LASSERT(lu_device_is_osd(o->lo_dev));
496         return container_of(o, struct osd_object, oo_dt.do_lu);
497 }
498
499 static inline struct osd_device *osd_dt_dev(const struct dt_device *d)
500 {
501         LASSERT(lu_device_is_osd(&d->dd_lu_dev));
502         return container_of(d, struct osd_device, od_dt_dev);
503 }
504
505 static inline struct osd_device *osd_dev(const struct lu_device *d)
506 {
507         LASSERT(lu_device_is_osd(d));
508         return osd_dt_dev(container_of(d, struct dt_device, dd_lu_dev));
509 }
510
511 static inline struct osd_object *osd_dt_obj(const struct dt_object *d)
512 {
513         return osd_obj(&d->do_lu);
514 }
515
516 static inline struct osd_device *osd_obj2dev(const struct osd_object *o)
517 {
518         return osd_dev(o->oo_dt.do_lu.lo_dev);
519 }
520
521 static inline struct lu_device *osd2lu_dev(struct osd_device *osd)
522 {
523         return &osd->od_dt_dev.dd_lu_dev;
524 }
525
526 static inline struct objset * osd_dtobj2objset(struct dt_object *o)
527 {
528         return osd_dev(o->do_lu.lo_dev)->od_os;
529 }
530
531 static inline int osd_invariant(const struct osd_object *obj)
532 {
533         return 1;
534 }
535
536 /**
537  * Put the osd object once done with it.
538  *
539  * \param obj osd object that needs to be put
540  */
541 static inline void osd_object_put(const struct lu_env *env,
542                                   struct osd_object *obj)
543 {
544         dt_object_put(env, &obj->oo_dt);
545 }
546
547 static inline int osd_object_invariant(const struct lu_object *l)
548 {
549         return osd_invariant(osd_obj(l));
550 }
551
552 static inline struct seq_server_site *osd_seq_site(struct osd_device *osd)
553 {
554         return osd->od_dt_dev.dd_lu_dev.ld_site->ld_seq_site;
555 }
556
557 static inline char *osd_name(struct osd_device *osd)
558 {
559         return osd->od_svname;
560 }
561
562 static inline void zfs_set_bit(int nr, __u8 *addr)
563 {
564         set_bit(nr, (unsigned long *)addr);
565 }
566
567 static inline int zfs_test_bit(int nr, __u8 *addr)
568 {
569         return test_bit(nr, (const unsigned long *)addr);
570 }
571
572 static inline int osd_oi_fid2idx(struct osd_device *dev,
573                                  const struct lu_fid *fid)
574 {
575         return fid->f_seq & (dev->od_oi_count - 1);
576 }
577
578 static inline struct osd_oi *osd_fid2oi(struct osd_device *osd,
579                                         const struct lu_fid *fid)
580 {
581         LASSERTF(osd->od_oi_table && osd->od_oi_count >= 1,
582                  "%s: "DFID", oi_count %d\n",
583                  osd_name(osd), PFID(fid), osd->od_oi_count);
584
585         return osd->od_oi_table[osd_oi_fid2idx(osd, fid)];
586 }
587
588 #ifdef CONFIG_PROC_FS
589 enum {
590         LPROC_OSD_READ_BYTES = 0,
591         LPROC_OSD_WRITE_BYTES = 1,
592         LPROC_OSD_GET_PAGE = 2,
593         LPROC_OSD_NO_PAGE = 3,
594         LPROC_OSD_CACHE_ACCESS = 4,
595         LPROC_OSD_CACHE_HIT = 5,
596         LPROC_OSD_CACHE_MISS = 6,
597         LPROC_OSD_COPY_IO = 7,
598         LPROC_OSD_ZEROCOPY_IO = 8,
599         LPROC_OSD_TAIL_IO = 9,
600         LPROC_OSD_LAST,
601 };
602
603 extern struct kmem_cache *osd_zapit_cachep;
604 /* osd_lproc.c */
605 extern struct lprocfs_vars lprocfs_osd_obd_vars[];
606
607 int osd_procfs_init(struct osd_device *osd, const char *name);
608 int osd_procfs_fini(struct osd_device *osd);
609
610 /* osd_object.c */
611 extern char *osd_obj_tag;
612 int __osd_obj2dnode(objset_t *os, uint64_t oid, dnode_t **dnp);
613 void osd_object_sa_dirty_rele(const struct lu_env *env, struct osd_thandle *oh);
614 void osd_object_sa_dirty_add(struct osd_object *obj, struct osd_thandle *oh);
615 int __osd_obj2dbuf(const struct lu_env *env, objset_t *os,
616                    uint64_t oid, dmu_buf_t **dbp);
617 struct lu_object *osd_object_alloc(const struct lu_env *env,
618                                    const struct lu_object_header *hdr,
619                                    struct lu_device *d);
620 int osd_object_sa_update(struct osd_object *obj, sa_attr_type_t type,
621                          void *buf, uint32_t buflen, struct osd_thandle *oh);
622 int __osd_zap_create(const struct lu_env *env, struct osd_device *osd,
623                      dnode_t **zap_dnp, dmu_tx_t *tx, struct lu_attr *la,
624                      unsigned dnsize, zap_flags_t flags);
625 int __osd_object_create(const struct lu_env *env, struct osd_device *osd,
626                         struct osd_object *obj, const struct lu_fid *fid,
627                         dnode_t **dnp, dmu_tx_t *tx, struct lu_attr *la);
628 int __osd_attr_init(const struct lu_env *env, struct osd_device *osd,
629                     struct osd_object *obj, sa_handle_t *sa_hdl, dmu_tx_t *tx,
630                     struct lu_attr *la, uint64_t parent, nvlist_t *);
631 int osd_find_new_dnode(const struct lu_env *env, dmu_tx_t *tx,
632                        uint64_t oid, dnode_t **dnp);
633
634 /* osd_oi.c */
635 int osd_oi_init(const struct lu_env *env, struct osd_device *o, bool reset);
636 void osd_oi_fini(const struct lu_env *env, struct osd_device *o);
637 int osd_fid_lookup(const struct lu_env *env,
638                    struct osd_device *, const struct lu_fid *, uint64_t *);
639 uint64_t osd_get_name_n_idx(const struct lu_env *env, struct osd_device *osd,
640                             const struct lu_fid *fid, char *buf, int bufsize,
641                             dnode_t **zdn);
642 int osd_options_init(void);
643 int osd_ost_seq_exists(const struct lu_env *env, struct osd_device *osd,
644                        __u64 seq);
645 int osd_idc_find_and_init(const struct lu_env *env, struct osd_device *osd,
646                           struct osd_object *obj);
647 struct osd_idmap_cache *osd_idc_find_or_init(const struct lu_env *env,
648                                              struct osd_device *osd,
649                                              const struct lu_fid *fid);
650 struct osd_idmap_cache *osd_idc_find(const struct lu_env *env,
651                                      struct osd_device *osd,
652                                      const struct lu_fid *fid);
653 int osd_idc_find_and_init_with_oid(const struct lu_env *env,
654                                    struct osd_device *osd,
655                                    const struct lu_fid *fid,
656                                    uint64_t oid);
657 int fid_is_on_ost(const struct lu_env *env, struct osd_device *osd,
658                   const struct lu_fid *fid);
659 int osd_obj_find_or_create(const struct lu_env *env, struct osd_device *o,
660                            uint64_t parent, const char *name, uint64_t *child,
661                            const struct lu_fid *fid, bool isdir);
662
663 extern unsigned int osd_oi_count;
664
665 /* osd_index.c */
666 int osd_get_fid_by_oid(const struct lu_env *env, struct osd_device *osd,
667                        uint64_t oid, struct lu_fid *fid);
668 int osd_index_try(const struct lu_env *env, struct dt_object *dt,
669                   const struct dt_index_features *feat);
670 int osd_fld_lookup(const struct lu_env *env, struct osd_device *osd,
671                    u64 seq, struct lu_seq_range *range);
672 void osd_zap_cursor_init_serialized(zap_cursor_t *zc, struct objset *os,
673                                     uint64_t id, uint64_t dirhash);
674 int osd_zap_cursor_init(zap_cursor_t **zc, struct objset *os,
675                         uint64_t id, uint64_t dirhash);
676 void osd_zap_cursor_fini(zap_cursor_t *zc);
677 uint64_t osd_zap_cursor_serialize(zap_cursor_t *zc);
678 int osd_remote_fid(const struct lu_env *env, struct osd_device *osd,
679                    const struct lu_fid *fid);
680 int osd_add_to_remote_parent(const struct lu_env *env,
681                              struct osd_device *osd,
682                              struct osd_object *obj,
683                              struct osd_thandle *oh);
684 int osd_delete_from_remote_parent(const struct lu_env *env,
685                                   struct osd_device *osd,
686                                   struct osd_object *obj,
687                                   struct osd_thandle *oh, bool destroy);
688 int __osd_xattr_load_by_oid(struct osd_device *osd, uint64_t oid,
689                             nvlist_t **sa);
690
691 /* osd_scrub.c */
692 int osd_scrub_setup(const struct lu_env *env, struct osd_device *dev,
693                     bool resetoi);
694 void osd_scrub_cleanup(const struct lu_env *env, struct osd_device *dev);
695 int osd_scrub_start(const struct lu_env *env, struct osd_device *dev,
696                     __u32 flags);
697 void osd_scrub_stop(struct osd_device *dev);
698 int osd_oii_insert(const struct lu_env *env, struct osd_device *dev,
699                    const struct lu_fid *fid, uint64_t oid, bool insert);
700 int osd_oii_lookup(struct osd_device *dev, const struct lu_fid *fid,
701                    uint64_t *oid);
702
703 /**
704  * Basic transaction credit op
705  */
706 enum dt_txn_op {
707         DTO_INDEX_INSERT,
708         DTO_INDEX_DELETE,
709         DTO_INDEX_UPDATE,
710         DTO_NR
711 };
712
713 int osd_scrub_refresh_mapping(const struct lu_env *env,
714                               struct osd_device *dev,
715                               const struct lu_fid *fid,
716                               uint64_t oid, enum dt_txn_op ops,
717                               bool force, const char *name);
718
719
720 /* osd_xattr.c */
721 int __osd_sa_xattr_schedule_update(const struct lu_env *env,
722                                    struct osd_object *obj,
723                                    struct osd_thandle *oh);
724 int __osd_sa_attr_init(const struct lu_env *env, struct osd_object *obj,
725                        struct osd_thandle *oh);
726 int __osd_sa_xattr_update(const struct lu_env *env, struct osd_object *obj,
727                           struct osd_thandle *oh);
728 int __osd_xattr_load(struct osd_device *osd, sa_handle_t *hdl,
729                      nvlist_t **sa);
730 int __osd_xattr_get_large(const struct lu_env *env, struct osd_device *osd,
731                           uint64_t xattr, struct lu_buf *buf,
732                           const char *name, int *sizep);
733 int osd_xattr_get_internal(const struct lu_env *env, struct osd_object *obj,
734                            struct lu_buf *buf, const char *name, int *sizep);
735 int osd_xattr_get_lma(const struct lu_env *env, struct osd_object *obj,
736                       struct lu_buf *buf);
737 int osd_xattr_get(const struct lu_env *env, struct dt_object *dt,
738                   struct lu_buf *buf, const char *name);
739 int osd_declare_xattr_set(const struct lu_env *env, struct dt_object *dt,
740                           const struct lu_buf *buf, const char *name,
741                           int fl, struct thandle *handle);
742 int osd_xattr_set(const struct lu_env *env, struct dt_object *dt,
743                   const struct lu_buf *buf, const char *name, int fl,
744                   struct thandle *handle);
745 int osd_declare_xattr_del(const struct lu_env *env, struct dt_object *dt,
746                           const char *name, struct thandle *handle);
747 int osd_xattr_del(const struct lu_env *env, struct dt_object *dt,
748                   const char *name, struct thandle *handle);
749 void osd_declare_xattrs_destroy(const struct lu_env *env,
750                                 struct osd_object *obj,
751                                 struct osd_thandle *oh);
752 int osd_xattrs_destroy(const struct lu_env *env,
753                        struct osd_object *obj, struct osd_thandle *oh);
754 int osd_xattr_list(const struct lu_env *env, struct dt_object *dt,
755                    const struct lu_buf *lb);
756 void __osd_xattr_declare_set(const struct lu_env *env, struct osd_object *obj,
757                         int vallen, const char *name, struct osd_thandle *oh);
758 int __osd_sa_xattr_set(const struct lu_env *env, struct osd_object *obj,
759                        const struct lu_buf *buf, const char *name, int fl,
760                        struct osd_thandle *oh);;
761 int __osd_xattr_set(const struct lu_env *env, struct osd_object *obj,
762                     const struct lu_buf *buf, const char *name, int fl,
763                     struct osd_thandle *oh);
764 int __osd_sa_xattr_update(const struct lu_env *env, struct osd_object *obj,
765                           struct osd_thandle *oh);
766
767 #define OSD_BASE_EA_IN_BONUS    (ZFS_SA_BASE_ATTR_SIZE + \
768                                  sizeof(__u64) /* VBR VERSION */ + \
769                                  sizeof(struct lustre_mdt_attrs) /* LMA */)
770
771 #ifdef HAVE_DMU_OBJECT_ALLOC_DNSIZE
772 int osd_find_dnsize(struct osd_device *osd, int ea_in_bonus);
773 #else
774 static inline int
775 osd_find_dnsize(struct osd_device *osd, int ea_in_bonus)
776 {
777         return DN_MAX_BONUSLEN;
778 }
779 #endif
780
781 static inline int osd_object_is_zap(dnode_t *dn)
782 {
783         return (dn->dn_type == DMU_OT_DIRECTORY_CONTENTS ||
784                 dn->dn_type == DMU_OT_USERGROUP_USED);
785 }
786
787 /* XXX: f_ver is not counted, but may differ too */
788 static inline void osd_fid2str(char *buf, const struct lu_fid *fid, int len)
789 {
790         snprintf(buf, len, DFID_NOBRACE, PFID(fid));
791 }
792
793 static inline int
794 osd_xattr_set_internal(const struct lu_env *env, struct osd_object *obj,
795                        const struct lu_buf *buf, const char *name, int fl,
796                        struct osd_thandle *oh)
797 {
798         int rc;
799
800         if (unlikely(!dt_object_exists(&obj->oo_dt) || obj->oo_destroyed))
801                 return -ENOENT;
802
803         LASSERT(obj->oo_dn);
804         if (osd_obj2dev(obj)->od_xattr_in_sa) {
805                 rc = __osd_sa_xattr_set(env, obj, buf, name, fl, oh);
806                 if (rc == -EFBIG)
807                         rc = __osd_xattr_set(env, obj, buf, name, fl, oh);
808         } else {
809                 rc = __osd_xattr_set(env, obj, buf, name, fl, oh);
810         }
811
812         return rc;
813 }
814
815 static inline uint64_t attrs_fs2zfs(const uint32_t flags)
816 {
817         return (flags & LUSTRE_APPEND_FL        ? ZFS_APPENDONLY        : 0) |
818                 (flags & LUSTRE_NODUMP_FL       ? ZFS_NODUMP            : 0) |
819 #ifdef ZFS_PROJINHERIT
820                 (flags & LUSTRE_PROJINHERIT_FL  ? ZFS_PROJINHERIT       : 0) |
821 #endif
822                 (flags & LUSTRE_IMMUTABLE_FL    ? ZFS_IMMUTABLE         : 0);
823 }
824
825 static inline uint32_t attrs_zfs2fs(const uint64_t flags)
826 {
827         return (flags & ZFS_APPENDONLY  ? LUSTRE_APPEND_FL      : 0) |
828                 (flags & ZFS_NODUMP     ? LUSTRE_NODUMP_FL      : 0) |
829 #ifdef ZFS_PROJINHERIT
830                 (flags & ZFS_PROJINHERIT ? LUSTRE_PROJINHERIT_FL : 0) |
831 #endif
832                 (flags & ZFS_IMMUTABLE  ? LUSTRE_IMMUTABLE_FL   : 0);
833 }
834
835 #endif
836
837 #ifndef HAVE_DSL_POOL_CONFIG
838 static inline void dsl_pool_config_enter(dsl_pool_t *dp, void *name)
839 {
840 }
841
842 static inline void dsl_pool_config_exit(dsl_pool_t *dp, void *name)
843 {
844 }
845 #endif
846
847 #ifdef HAVE_SPA_MAXBLOCKSIZE
848 #define osd_spa_maxblocksize(spa)       spa_maxblocksize(spa)
849 #define osd_spa_maxblockshift(spa)      fls64(spa_maxblocksize(spa) - 1)
850 #else
851 #define osd_spa_maxblocksize(spa)       SPA_MAXBLOCKSIZE
852 #define osd_spa_maxblockshift(spa)      SPA_MAXBLOCKSHIFT
853 #define SPA_OLD_MAXBLOCKSIZE            SPA_MAXBLOCKSIZE
854 #endif
855
856 #ifdef HAVE_SA_SPILL_ALLOC
857 static inline void *
858 osd_zio_buf_alloc(size_t size)
859 {
860         return sa_spill_alloc(KM_SLEEP);
861 }
862
863 static inline void
864 osd_zio_buf_free(void *buf, size_t size)
865 {
866         sa_spill_free(buf);
867 }
868 #else
869 #define osd_zio_buf_alloc(size)         zio_buf_alloc(size)
870 #define osd_zio_buf_free(buf, size)     zio_buf_free(buf, size)
871 #endif
872
873 #ifdef HAVE_DMU_OBJECT_ALLOC_DNSIZE
874 static inline uint64_t
875 osd_dmu_object_alloc(objset_t *os, dmu_object_type_t objtype, int blocksize,
876                      int dnodesize, dmu_tx_t *tx)
877 {
878         if (dnodesize == 0)
879                 dnodesize = max_t(int, dmu_objset_dnodesize(os),
880                                   DNODE_MIN_SIZE);
881
882         return dmu_object_alloc_dnsize(os, objtype, blocksize, DMU_OT_SA,
883                                        DN_BONUS_SIZE(dnodesize), dnodesize, tx);
884 }
885
886 static inline uint64_t
887 osd_zap_create_flags(objset_t *os, int normflags, zap_flags_t flags,
888                      dmu_object_type_t ot, int leaf_blockshift,
889                      int indirect_blockshift, int dnodesize, dmu_tx_t *tx)
890 {
891         if (dnodesize == 0)
892                 dnodesize = max_t(int, dmu_objset_dnodesize(os),
893                                   DNODE_MIN_SIZE);
894
895         return zap_create_flags_dnsize(os, normflags, flags, ot,
896                                        leaf_blockshift, indirect_blockshift,
897                                        DMU_OT_SA, DN_BONUS_SIZE(dnodesize),
898                                        dnodesize, tx);
899 }
900
901 static inline int
902 osd_obj_bonuslen(struct osd_object *obj)
903 {
904         int bonuslen = DN_BONUS_SIZE(DNODE_MIN_SIZE);
905
906         if (obj->oo_dn != NULL && obj->oo_dn->dn_num_slots != 0) {
907                 bonuslen = DN_SLOTS_TO_BONUSLEN(obj->oo_dn->dn_num_slots);
908         } else {
909                 objset_t *os = osd_dtobj2objset(&obj->oo_dt);
910                 int dnodesize;
911
912                 if (os != NULL) {
913                         dnodesize = dmu_objset_dnodesize(os);
914                         if (dnodesize != 0)
915                                 bonuslen = DN_BONUS_SIZE(dnodesize);
916                 }
917         }
918
919         return bonuslen;
920 }
921 #else
922 static inline uint64_t
923 osd_dmu_object_alloc(objset_t *os, dmu_object_type_t objtype, int blocksize,
924                      int dnodesize, dmu_tx_t *tx)
925 {
926         return dmu_object_alloc(os, objtype, blocksize, DMU_OT_SA,
927                                 DN_MAX_BONUSLEN, tx);
928 }
929
930 static inline uint64_t
931 osd_zap_create_flags(objset_t *os, int normflags, zap_flags_t flags,
932                      dmu_object_type_t ot, int leaf_blockshift,
933                      int indirect_blockshift, int dnodesize, dmu_tx_t *tx)
934 {
935         return zap_create_flags(os, normflags, flags, ot, leaf_blockshift,
936                                 indirect_blockshift, DMU_OT_SA,
937                                 DN_MAX_BONUSLEN, tx);
938 }
939
940 static inline int
941 osd_obj_bonuslen(struct osd_object *obj)
942 {
943         return DN_MAX_BONUSLEN;
944 }
945 #endif /* HAVE_DMU_OBJECT_ALLOC_DNSIZE */
946
947 #ifdef HAVE_DMU_PREFETCH_6ARG
948 #define osd_dmu_prefetch(os, obj, lvl, off, len, pri)   \
949         dmu_prefetch((os), (obj), (lvl), (off), (len), (pri))
950 #else
951 #define osd_dmu_prefetch(os, obj, lvl, off, len, pri)   \
952         dmu_prefetch((os), (obj), (lvl), (off))
953 #endif
954
955 static inline int osd_sa_handle_get(struct osd_object *obj)
956 {
957         struct osd_device *osd = osd_obj2dev(obj);
958         dnode_t *dn = obj->oo_dn;
959         int rc;
960
961         if (obj->oo_sa_hdl)
962                 return 0;
963
964         dbuf_read(dn->dn_bonus, NULL, DB_RF_MUST_SUCCEED | DB_RF_NOPREFETCH);
965         rc = -sa_handle_get_from_db(osd->od_os, &dn->dn_bonus->db, obj,
966                                     SA_HDL_PRIVATE, &obj->oo_sa_hdl);
967         if (rc)
968                 return rc;
969         zfs_refcount_add(&dn->dn_bonus->db_holds, osd_obj_tag);
970         return 0;
971 }
972
973 static inline void osd_dnode_rele(dnode_t *dn)
974 {
975         dmu_buf_impl_t *db;
976         LASSERT(dn);
977         LASSERT(dn->dn_bonus);
978         db = dn->dn_bonus;
979
980         dmu_buf_rele(&db->db, osd_obj_tag);
981 }
982
983 static inline uint64_t osd_db_dirty_txg(dmu_buf_impl_t *db)
984 {
985         dbuf_dirty_record_t *dr;
986         uint64_t txg = 0;
987
988         mutex_enter(&db->db_mtx);
989 #ifdef HAVE_DB_DIRTY_RECORDS_LIST
990         dr = list_head(&db->db_dirty_records);
991 #else
992         dr = db->db_last_dirty;
993 #endif
994         if (dr != NULL)
995                 txg = dr->dr_txg;
996         mutex_exit(&db->db_mtx);
997
998         return txg;
999 }
1000
1001 #ifdef HAVE_DMU_USEROBJ_ACCOUNTING
1002
1003 #define OSD_DMU_USEROBJ_PREFIX          DMU_OBJACCT_PREFIX
1004 #define OSD_DMU_USEROBJ_PREFIX_LEN      DMU_OBJACCT_PREFIX_LEN
1005
1006 static inline bool osd_dmu_userobj_accounting_available(struct osd_device *osd)
1007 {
1008         return dmu_objset_userobjspace_present(osd->od_os);
1009 }
1010 #else
1011
1012 #define OSD_DMU_USEROBJ_PREFIX          "obj-"
1013 #define OSD_DMU_USEROBJ_PREFIX_LEN      4
1014
1015 static inline bool osd_dmu_userobj_accounting_available(struct osd_device *osd)
1016 {
1017         return false;
1018 }
1019 #endif /* #ifdef HAVE_DMU_USEROBJ_ACCOUNTING */
1020
1021 static inline int osd_zap_add(struct osd_device *osd, uint64_t zap,
1022                               dnode_t *dn, const char *key,
1023                               int int_size, int int_num,
1024                               const void *val, dmu_tx_t *tx)
1025 {
1026         LASSERT(zap != 0);
1027
1028 #ifdef HAVE_ZAP_ADD_BY_DNODE
1029         if (dn)
1030                 return -zap_add_by_dnode(dn, key, int_size, int_num, val, tx);
1031 #endif
1032         return -zap_add(osd->od_os, zap, key, int_size, int_num, val, tx);
1033 }
1034
1035 static inline int osd_zap_remove(struct osd_device *osd, uint64_t zap,
1036                                  dnode_t *dn, const char *key,
1037                                  dmu_tx_t *tx)
1038 {
1039         LASSERT(zap != 0);
1040
1041 #ifdef HAVE_ZAP_ADD_BY_DNODE
1042         if (dn)
1043                 return -zap_remove_by_dnode(dn, key, tx);
1044 #endif
1045         return -zap_remove(osd->od_os, zap, key, tx);
1046 }
1047
1048
1049 static inline int osd_zap_lookup(struct osd_device *osd, uint64_t zap,
1050                                  dnode_t *dn, const char *key,
1051                                  int int_size, int int_num, void *v)
1052 {
1053         LASSERT(zap != 0);
1054
1055 #ifdef HAVE_ZAP_ADD_BY_DNODE
1056         if (dn)
1057                 return -zap_lookup_by_dnode(dn, key, int_size, int_num, v);
1058 #endif
1059         return -zap_lookup(osd->od_os, zap, key, int_size, int_num, v);
1060 }
1061
1062 static inline void osd_tx_hold_zap(dmu_tx_t *tx, uint64_t zap,
1063                                    dnode_t *dn, int add, const char *name)
1064 {
1065 #ifdef HAVE_DMU_TX_HOLD_ZAP_BY_DNODE
1066         if (dn) {
1067                 dmu_tx_hold_zap_by_dnode(tx, dn, add, name);
1068                 return;
1069         }
1070 #endif
1071         dmu_tx_hold_zap(tx, zap, add, name);
1072 }
1073
1074 static inline void osd_tx_hold_write(dmu_tx_t *tx, uint64_t oid,
1075                                    dnode_t *dn, uint64_t off, int len)
1076 {
1077 #ifdef HAVE_DMU_TX_HOLD_ZAP_BY_DNODE
1078         if (dn) {
1079                 dmu_tx_hold_write_by_dnode(tx, dn, off, len);
1080                 return;
1081         }
1082 #endif
1083         dmu_tx_hold_write(tx, oid, off, len);
1084 }
1085
1086 static inline void osd_dmu_write(struct osd_device *osd, dnode_t *dn,
1087                                  uint64_t offset, uint64_t size,
1088                                  const char *buf, dmu_tx_t *tx)
1089 {
1090         LASSERT(dn);
1091 #ifdef HAVE_DMU_WRITE_BY_DNODE
1092         dmu_write_by_dnode(dn, offset, size, buf, tx);
1093 #else
1094         dmu_write(osd->od_os, dn->dn_object, offset, size, buf, tx);
1095 #endif
1096 }
1097
1098 static inline int osd_dmu_read(struct osd_device *osd, dnode_t *dn,
1099                                uint64_t offset, uint64_t size,
1100                                char *buf, int flags)
1101 {
1102         LASSERT(dn);
1103 #ifdef HAVE_DMU_READ_BY_DNODE
1104         return -dmu_read_by_dnode(dn, offset, size, buf, flags);
1105 #else
1106         return -dmu_read(osd->od_os, dn->dn_object, offset, size, buf, flags);
1107 #endif
1108 }
1109
1110 #ifdef HAVE_DMU_OBJSET_OWN_6ARG
1111 #define osd_dmu_objset_own(name, type, ronly, decrypt, tag, os) \
1112         dmu_objset_own((name), (type), (ronly), (decrypt), (tag), (os))
1113 #else
1114 #define osd_dmu_objset_own(name, type, ronly, decrypt, tag, os) \
1115         dmu_objset_own((name), (type), (ronly), (tag), (os))
1116 #endif
1117
1118 #ifdef HAVE_DMU_OBJSET_DISOWN_3ARG
1119 #define osd_dmu_objset_disown(os, decrypt, tag) \
1120         dmu_objset_disown((os), (decrypt), (tag))
1121 #else
1122 #define osd_dmu_objset_disown(os, decrypt, tag) \
1123         dmu_objset_disown((os), (tag))
1124 #endif
1125
1126 static inline int
1127 osd_index_register(struct osd_device *osd, const struct lu_fid *fid,
1128                    __u32 keysize, __u32 recsize)
1129 {
1130         return lustre_index_register(&osd->od_dt_dev, osd_name(osd),
1131                                      &osd->od_index_backup_list, &osd->od_lock,
1132                                      &osd->od_index_backup_stop,
1133                                      fid, keysize, recsize);
1134 }
1135
1136 static inline void
1137 osd_index_backup(const struct lu_env *env, struct osd_device *osd, bool backup)
1138 {
1139         struct lu_fid *fid = &osd_oti_get(env)->oti_fid;
1140         int rc;
1141
1142         lu_local_obj_fid(fid, INDEX_BACKUP_OID);
1143         rc = osd_idc_find_and_init_with_oid(env, osd, fid,
1144                                             osd->od_index_backup_id);
1145         if (rc)
1146                 backup = false;
1147
1148         lustre_index_backup(env, &osd->od_dt_dev, osd_name(osd),
1149                             &osd->od_index_backup_list, &osd->od_lock,
1150                             &osd->od_index_backup_stop, backup);
1151 }
1152
1153 #ifndef HAVE_DMU_TX_MARK_NETFREE
1154 #define dmu_tx_mark_netfree(tx)
1155 #endif
1156
1157 #ifndef HAVE_ZFS_INODE_TIMESPEC
1158 #define inode_timespec_t timestruc_t
1159 #endif
1160
1161 #ifdef HAVE_DMU_OFFSET_NEXT
1162 #define osd_dmu_offset_next(os, obj, hole, res) \
1163         dmu_offset_next((os), (obj), (hole), (res))
1164 #else
1165 #define osd_dmu_offset_next(os, obj, hole, res) (EBUSY)
1166 #endif
1167
1168 #endif /* _OSD_INTERNAL_H */