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