Whamcloud - gitweb
e63e6d6d37bd9044a3ad2f6fd7f48541876ac53c
[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 struct dt_body_operations osd_body_scrub_ops;
107
108 /**
109  * Iterator's in-memory data structure for quota file.
110  */
111 struct osd_it_quota {
112         struct osd_object       *oiq_obj;
113         /* DMU accounting object id */
114         uint64_t                 oiq_oid;
115         /* ZAP cursor */
116         zap_cursor_t            *oiq_zc;
117         /** identifier for current quota record */
118         __u64                    oiq_id;
119         unsigned                 oiq_reset:1; /* 1 -- no need to advance */
120 };
121
122 enum osd_zap_pos {
123         OZI_POS_INIT = 0,
124         OZI_POS_DOT = 1,        /* cursor at . */
125         OZI_POS_DOTDOT = 2,     /* cursor at .. */
126         OZI_POS_REAL = 3,       /* cursor at real entries */
127 };
128
129 /**
130  * Iterator's in-memory data structure for ZAPs
131  *
132  * ZFS does not store . and .. on a disk, instead they are
133  * generated up on request
134  * to follow this format we do the same
135  */
136 struct osd_zap_it {
137         zap_cursor_t            *ozi_zc;
138         struct osd_object       *ozi_obj;
139         unsigned                 ozi_reset:1;   /* 1 -- no need to advance */
140         /* ozi_pos - position of the cursor */
141         enum osd_zap_pos        ozi_pos;
142         union {
143                 char             ozi_name[MAXNAMELEN]; /* file name for dir */
144                 __u64            ozi_key; /* binary key for index files */
145         };
146 };
147 #define DT_IT2DT(it) (&((struct osd_zap_it *)it)->ozi_obj->oo_dt)
148
149 /*
150  * regular ZFS direntry
151  */
152 struct zpl_direntry {
153         uint64_t        zde_dnode:48,
154                         zde_pad:12,
155                         zde_type:4;
156 } __attribute__((packed));
157
158 /*
159  * lustre direntry adds a fid to regular ZFS direntry
160  */
161 struct luz_direntry {
162         struct zpl_direntry     lzd_reg;
163         struct lu_fid           lzd_fid;
164 } __attribute__((packed));
165
166
167 /* cached SA attributes */
168 struct osa_attr {
169         uint64_t        mode;
170         uint64_t        gid;
171         uint64_t        uid;
172 #ifdef ZFS_PROJINHERIT
173         uint64_t        projid;
174 #endif
175         uint64_t        nlink;
176         uint64_t        rdev;
177         uint64_t        flags;
178         uint64_t        size;
179         uint64_t        atime[2];
180         uint64_t        mtime[2];
181         uint64_t        ctime[2];
182 };
183
184
185 #define OSD_INS_CACHE_SIZE      8
186
187 /* OI cache entry */
188 struct osd_idmap_cache {
189         struct osd_device       *oic_dev;
190         struct lu_fid           oic_fid;
191         /** max 2^48 dnodes per dataset, avoid spilling into another word */
192         uint64_t                oic_dnode:DN_MAX_OBJECT_SHIFT,
193                                 oic_remote:1;      /* FID isn't local */
194 };
195
196 struct osd_inconsistent_item {
197         /* link into lustre_scrub::os_inconsistent_items,
198          * protected by lustr_scrub::os_lock. */
199         struct list_head       oii_list;
200
201         /* The right FID <=> oid mapping. */
202         struct osd_idmap_cache oii_cache;
203
204         unsigned int           oii_insert:1; /* insert or update mapping. */
205 };
206
207 struct osd_otable_it {
208         struct osd_device       *ooi_dev;
209         struct lu_fid            ooi_fid;
210         __u64                    ooi_pos;
211         __u64                    ooi_prefetched_dnode;
212         int                      ooi_prefetched;
213
214         /* The following bits can be updated/checked w/o lock protection.
215          * If more bits will be introduced in the future and need lock to
216          * protect, please add comment. */
217         unsigned int             ooi_used_outside:1, /* Some user out of OSD
218                                                       * uses the iteration. */
219                                  ooi_all_cached:1, /* No more entries can be
220                                                     * filled into cache. */
221                                  ooi_user_ready:1, /* The user out of OSD is
222                                                     * ready to iterate. */
223                                  ooi_waiting:1; /* it::next is waiting. */
224 };
225
226 extern const struct dt_index_operations osd_otable_ops;
227
228 /* max.number of regular attributes the callers may ask for */
229 # define OSD_MAX_IN_BULK (sizeof(struct osa_attr)/sizeof(uint64_t))
230
231 struct osd_thread_info {
232         const struct lu_env     *oti_env;
233
234         struct lu_fid            oti_fid;
235         /*
236          * XXX temporary: for ->i_op calls.
237          */
238         struct timespec          oti_time;
239
240         struct ost_id            oti_ostid;
241
242         char                     oti_buf[64];
243
244         char                     oti_str[64];
245         union {
246                 char             oti_key[MAXNAMELEN + 1];
247                 __u64            oti_key64[(MAXNAMELEN + 1)/sizeof(__u64)];
248                 sa_bulk_attr_t   oti_attr_bulk[OSD_MAX_IN_BULK];
249         };
250         struct lustre_mdt_attrs  oti_mdt_attrs;
251         unsigned int             oti_in_trans:1;
252
253         struct lu_attr           oti_la;
254         struct osa_attr          oti_osa;
255         zap_attribute_t          oti_za;
256         zap_attribute_t          oti_za2;
257         dmu_object_info_t        oti_doi;
258         struct luz_direntry      oti_zde;
259
260         struct lquota_id_info    oti_qi;
261         struct lu_seq_range      oti_seq_range;
262
263         /* dedicated OI cache for insert (which needs inum) */
264         struct osd_idmap_cache *oti_ins_cache;
265         int                    oti_ins_cache_size;
266         int                    oti_ins_cache_used;
267         /* inc by osd_trans_create and dec by osd_trans_stop */
268         int                    oti_ins_cache_depth;
269         struct lu_buf          oti_xattr_lbuf;
270         zap_cursor_t           oti_zc;
271         zap_cursor_t           oti_zc2;
272 };
273
274 extern struct lu_context_key osd_key;
275
276 static inline struct osd_thread_info *osd_oti_get(const struct lu_env *env)
277 {
278         return lu_context_key_get(&env->le_ctx, &osd_key);
279 }
280
281 struct osd_thandle {
282         struct thandle           ot_super;
283         struct list_head         ot_dcb_list;
284         struct list_head         ot_stop_dcb_list;
285         struct list_head         ot_unlinked_list;
286         struct list_head         ot_sa_list;
287         dmu_tx_t                *ot_tx;
288         struct lquota_trans      ot_quota_trans;
289         __u32                    ot_assigned:1;
290 };
291
292 #define OSD_OI_NAME_SIZE        24
293
294 /*
295  * Object Index (OI) instance.
296  */
297 struct osd_oi {
298         char                    oi_name[OSD_OI_NAME_SIZE];
299         uint64_t                oi_zapid;
300         dnode_t *oi_dn;
301 };
302
303 struct osd_seq {
304         uint64_t         os_oid;
305         uint64_t         *os_compat_dirs;
306         int              os_subdir_count; /* subdir count for each seq */
307         u64              os_seq;          /* seq number */
308         struct list_head os_seq_list;     /* list to seq_list */
309 };
310
311 struct osd_seq_list {
312         rwlock_t         osl_seq_list_lock;     /* lock for seq_list */
313         struct list_head osl_seq_list;          /* list head for seq */
314         struct semaphore osl_seq_init_sem;
315 };
316
317 #define OSD_OST_MAP_SIZE        32
318
319 /*
320  * osd device.
321  */
322 struct osd_device {
323         /* super-class */
324         struct dt_device         od_dt_dev;
325         /* information about underlying file system */
326         struct objset           *od_os;
327         uint64_t                 od_rootid;  /* id of root znode */
328         dnode_t *od_unlinked; /* dnode of unlinked zapobj */
329         /* SA attr mapping->id,
330          * name is the same as in ZFS to use defines SA_ZPL_...*/
331         sa_attr_type_t           *z_attr_table;
332
333         struct proc_dir_entry   *od_proc_entry;
334         struct lprocfs_stats    *od_stats;
335
336         uint64_t                 od_remote_parent_dir;
337         uint64_t                 od_index_backup_id;
338         uint64_t                 od_max_blksz;
339         uint64_t                 od_root;
340         uint64_t                 od_O_id;
341         struct osd_oi           **od_oi_table;
342         unsigned int             od_oi_count;
343         struct osd_seq_list     od_seq_list;
344
345         unsigned int             od_dev_set_rdonly:1, /**< osd_ro() called */
346                                  od_prop_rdonly:1,  /**< ZFS property readonly */
347                                  od_xattr_in_sa:1,
348                                  od_is_ost:1,
349                                  od_in_init:1,
350                                  od_posix_acl:1,
351                                  od_nonrotational:1;
352         unsigned int             od_dnsize;
353         int                      od_index_backup_stop;
354
355         enum lustre_index_backup_policy od_index_backup_policy;
356         char                     od_mntdev[128];
357         char                     od_svname[128];
358         char                     od_uuid[16];
359
360         int                      od_connects;
361         int                      od_index;
362         __s64                    od_auto_scrub_interval;
363         struct lu_site           od_site;
364
365         dnode_t                 *od_groupused_dn;
366         dnode_t                 *od_userused_dn;
367 #ifdef ZFS_PROJINHERIT
368         dnode_t                 *od_projectused_dn;
369 #endif
370
371         /* quota slave instance for inode */
372         struct qsd_instance     *od_quota_slave_md;
373
374         /* quota slave instance for block */
375         struct qsd_instance     *od_quota_slave_dt;
376
377         struct brw_stats        od_brw_stats;
378         atomic_t                od_r_in_flight;
379         atomic_t                od_w_in_flight;
380
381         /* used to debug zerocopy logic: the fields track all
382          * allocated, loaned and referenced buffers in use.
383          * to be removed once the change is tested well. */
384         atomic_t                 od_zerocopy_alloc;
385         atomic_t                 od_zerocopy_loan;
386         atomic_t                 od_zerocopy_pin;
387
388         arc_prune_t             *arc_prune_cb;
389
390         /* osd seq instance */
391         struct lu_client_seq    *od_cl_seq;
392
393         struct semaphore         od_otable_sem;
394         struct osd_otable_it    *od_otable_it;
395         struct lustre_scrub      od_scrub;
396         struct list_head         od_ios_list;
397         struct list_head         od_index_backup_list;
398         struct list_head         od_index_restore_list;
399         spinlock_t               od_lock;
400         unsigned long long       od_readcache_max_filesize;
401 };
402
403 static inline struct qsd_instance *osd_def_qsd(struct osd_device *osd)
404 {
405         if (osd->od_is_ost)
406                 return osd->od_quota_slave_dt;
407         else
408                 return osd->od_quota_slave_md;
409 }
410
411 enum osd_destroy_type {
412         OSD_DESTROY_NONE = 0,
413         OSD_DESTROY_SYNC = 1,
414         OSD_DESTROY_ASYNC = 2,
415 };
416
417 struct osd_object {
418         struct dt_object         oo_dt;
419         /*
420          * Inode for file system object represented by this osd_object. This
421          * inode is pinned for the whole duration of lu_object life.
422          *
423          * Not modified concurrently (either setup early during object
424          * creation, or assigned by osd_create() under write lock).
425          */
426         dnode_t *oo_dn;
427         sa_handle_t             *oo_sa_hdl;
428         nvlist_t                *oo_sa_xattr;
429         struct list_head         oo_sa_linkage;
430
431         /* used to implement osd_object_*_{lock|unlock} */
432         struct rw_semaphore      oo_sem;
433
434         /* to serialize some updates: destroy vs. others,
435          * xattr_set, object block size change etc */
436         struct rw_semaphore      oo_guard;
437
438         /* protected by oo_guard */
439         struct list_head         oo_unlinked_linkage;
440
441         /* cached attributes */
442         rwlock_t                 oo_attr_lock;
443         struct lu_attr           oo_attr;
444
445         /* external dnode holding large EAs, protected by oo_guard */
446         uint64_t                 oo_xattr;
447         enum osd_destroy_type    oo_destroy;
448
449         __u32                    oo_destroyed:1,
450                                  oo_late_xattr:1,
451 #ifdef ZFS_PROJINHERIT
452                                  oo_with_projid:1,
453 #endif
454                                  oo_late_attr_set:1,
455                                  oo_pfid_in_lma:1;
456
457         /* the i_flags in LMA */
458         __u32                    oo_lma_flags;
459         union {
460                 int             oo_ea_in_bonus; /* EA bytes we expect */
461                 struct {
462                         /* record size for index file */
463                         unsigned char            oo_keysize;
464                         unsigned char            oo_recsize;
465                         unsigned char            oo_recusize;   /* unit size */
466                 };
467                 uint64_t        oo_parent; /* used only at object creation */
468         };
469         struct lu_object_header *oo_header;
470 };
471
472 int osd_statfs(const struct lu_env *, struct dt_device *, struct obd_statfs *);
473 extern const struct dt_index_operations osd_acct_index_ops;
474 extern struct lu_device_operations  osd_lu_ops;
475 extern 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, int *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_of0(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_of0(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_of0(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);
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 void osd_scrub_cleanup(const struct lu_env *env, struct osd_device *dev);
694 int osd_scrub_start(const struct lu_env *env, struct osd_device *dev,
695                     __u32 flags);
696 void osd_scrub_stop(struct osd_device *dev);
697 int osd_oii_insert(const struct lu_env *env, struct osd_device *dev,
698                    const struct lu_fid *fid, uint64_t oid, bool insert);
699 int osd_oii_lookup(struct osd_device *dev, const struct lu_fid *fid,
700                    uint64_t *oid);
701
702 /* osd_xattr.c */
703 int __osd_sa_xattr_schedule_update(const struct lu_env *env,
704                                    struct osd_object *obj,
705                                    struct osd_thandle *oh);
706 int __osd_sa_attr_init(const struct lu_env *env, struct osd_object *obj,
707                        struct osd_thandle *oh);
708 int __osd_sa_xattr_update(const struct lu_env *env, struct osd_object *obj,
709                           struct osd_thandle *oh);
710 int __osd_xattr_load(struct osd_device *osd, sa_handle_t *hdl,
711                      nvlist_t **sa);
712 int __osd_xattr_get_large(const struct lu_env *env, struct osd_device *osd,
713                           uint64_t xattr, struct lu_buf *buf,
714                           const char *name, int *sizep);
715 int osd_xattr_get_internal(const struct lu_env *env, struct osd_object *obj,
716                            struct lu_buf *buf, const char *name, int *sizep);
717 int osd_xattr_get(const struct lu_env *env, struct dt_object *dt,
718                   struct lu_buf *buf, const char *name);
719 int osd_declare_xattr_set(const struct lu_env *env, struct dt_object *dt,
720                           const struct lu_buf *buf, const char *name,
721                           int fl, struct thandle *handle);
722 int osd_xattr_set(const struct lu_env *env, struct dt_object *dt,
723                   const struct lu_buf *buf, const char *name, int fl,
724                   struct thandle *handle);
725 int osd_declare_xattr_del(const struct lu_env *env, struct dt_object *dt,
726                           const char *name, struct thandle *handle);
727 int osd_xattr_del(const struct lu_env *env, struct dt_object *dt,
728                   const char *name, struct thandle *handle);
729 void osd_declare_xattrs_destroy(const struct lu_env *env,
730                                 struct osd_object *obj,
731                                 struct osd_thandle *oh);
732 int osd_xattrs_destroy(const struct lu_env *env,
733                        struct osd_object *obj, struct osd_thandle *oh);
734 int osd_xattr_list(const struct lu_env *env, struct dt_object *dt,
735                    const struct lu_buf *lb);
736 void __osd_xattr_declare_set(const struct lu_env *env, struct osd_object *obj,
737                         int vallen, const char *name, struct osd_thandle *oh);
738 int __osd_sa_xattr_set(const struct lu_env *env, struct osd_object *obj,
739                        const struct lu_buf *buf, const char *name, int fl,
740                        struct osd_thandle *oh);;
741 int __osd_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_sa_xattr_update(const struct lu_env *env, struct osd_object *obj,
745                           struct osd_thandle *oh);
746
747 #define OSD_BASE_EA_IN_BONUS    (ZFS_SA_BASE_ATTR_SIZE + \
748                                  sizeof(__u64) /* VBR VERSION */ + \
749                                  sizeof(struct lustre_mdt_attrs) /* LMA */)
750
751 #ifdef HAVE_DMU_OBJECT_ALLOC_DNSIZE
752 int osd_find_dnsize(struct osd_device *osd, int ea_in_bonus);
753 #else
754 static inline int
755 osd_find_dnsize(struct osd_device *osd, int ea_in_bonus)
756 {
757         return DN_MAX_BONUSLEN;
758 }
759 #endif
760
761 static inline int osd_object_is_zap(dnode_t *dn)
762 {
763         return (dn->dn_type == DMU_OT_DIRECTORY_CONTENTS ||
764                 dn->dn_type == DMU_OT_USERGROUP_USED);
765 }
766
767 /* XXX: f_ver is not counted, but may differ too */
768 static inline void osd_fid2str(char *buf, const struct lu_fid *fid, int len)
769 {
770         snprintf(buf, len, DFID_NOBRACE, PFID(fid));
771 }
772
773 static inline int
774 osd_xattr_set_internal(const struct lu_env *env, struct osd_object *obj,
775                        const struct lu_buf *buf, const char *name, int fl,
776                        struct osd_thandle *oh)
777 {
778         int rc;
779
780         if (unlikely(!dt_object_exists(&obj->oo_dt) || obj->oo_destroyed))
781                 return -ENOENT;
782
783         LASSERT(obj->oo_dn);
784         if (osd_obj2dev(obj)->od_xattr_in_sa) {
785                 rc = __osd_sa_xattr_set(env, obj, buf, name, fl, oh);
786                 if (rc == -EFBIG)
787                         rc = __osd_xattr_set(env, obj, buf, name, fl, oh);
788         } else {
789                 rc = __osd_xattr_set(env, obj, buf, name, fl, oh);
790         }
791
792         return rc;
793 }
794
795 static inline uint64_t attrs_fs2zfs(const uint32_t flags)
796 {
797         return (flags & LUSTRE_APPEND_FL        ? ZFS_APPENDONLY        : 0) |
798                 (flags & LUSTRE_NODUMP_FL       ? ZFS_NODUMP            : 0) |
799 #ifdef ZFS_PROJINHERIT
800                 (flags & LUSTRE_PROJINHERIT_FL  ? ZFS_PROJINHERIT       : 0) |
801 #endif
802                 (flags & LUSTRE_IMMUTABLE_FL    ? ZFS_IMMUTABLE         : 0);
803 }
804
805 static inline uint32_t attrs_zfs2fs(const uint64_t flags)
806 {
807         return (flags & ZFS_APPENDONLY  ? LUSTRE_APPEND_FL      : 0) |
808                 (flags & ZFS_NODUMP     ? LUSTRE_NODUMP_FL      : 0) |
809 #ifdef ZFS_PROJINHERIT
810                 (flags & ZFS_PROJINHERIT ? LUSTRE_PROJINHERIT_FL : 0) |
811 #endif
812                 (flags & ZFS_IMMUTABLE  ? LUSTRE_IMMUTABLE_FL   : 0);
813 }
814
815 #endif
816
817 #ifndef HAVE_DSL_POOL_CONFIG
818 static inline void dsl_pool_config_enter(dsl_pool_t *dp, char *name)
819 {
820 }
821
822 static inline void dsl_pool_config_exit(dsl_pool_t *dp, char *name)
823 {
824 }
825 #endif
826
827 #ifdef HAVE_SPA_MAXBLOCKSIZE
828 #define osd_spa_maxblocksize(spa)       spa_maxblocksize(spa)
829 #define osd_spa_maxblockshift(spa)      fls64(spa_maxblocksize(spa) - 1)
830 #else
831 #define osd_spa_maxblocksize(spa)       SPA_MAXBLOCKSIZE
832 #define osd_spa_maxblockshift(spa)      SPA_MAXBLOCKSHIFT
833 #define SPA_OLD_MAXBLOCKSIZE            SPA_MAXBLOCKSIZE
834 #endif
835
836 #ifdef HAVE_SA_SPILL_ALLOC
837 static inline void *
838 osd_zio_buf_alloc(size_t size)
839 {
840         return sa_spill_alloc(KM_SLEEP);
841 }
842
843 static inline void
844 osd_zio_buf_free(void *buf, size_t size)
845 {
846         sa_spill_free(buf);
847 }
848 #else
849 #define osd_zio_buf_alloc(size)         zio_buf_alloc(size)
850 #define osd_zio_buf_free(buf, size)     zio_buf_free(buf, size)
851 #endif
852
853 #ifdef HAVE_DMU_OBJECT_ALLOC_DNSIZE
854 static inline uint64_t
855 osd_dmu_object_alloc(objset_t *os, dmu_object_type_t objtype, int blocksize,
856                      int dnodesize, dmu_tx_t *tx)
857 {
858         if (dnodesize == 0)
859                 dnodesize = MAX(dmu_objset_dnodesize(os), DNODE_MIN_SIZE);
860
861         return dmu_object_alloc_dnsize(os, objtype, blocksize, DMU_OT_SA,
862                                        DN_BONUS_SIZE(dnodesize), dnodesize, tx);
863 }
864
865 static inline uint64_t
866 osd_zap_create_flags(objset_t *os, int normflags, zap_flags_t flags,
867                      dmu_object_type_t ot, int leaf_blockshift,
868                      int indirect_blockshift, int dnodesize, dmu_tx_t *tx)
869 {
870         if (dnodesize == 0)
871                 dnodesize = MAX(dmu_objset_dnodesize(os), DNODE_MIN_SIZE);
872
873         return zap_create_flags_dnsize(os, normflags, flags, ot,
874                                        leaf_blockshift, indirect_blockshift,
875                                        DMU_OT_SA, DN_BONUS_SIZE(dnodesize),
876                                        dnodesize, tx);
877 }
878
879 static inline int
880 osd_obj_bonuslen(struct osd_object *obj)
881 {
882         int bonuslen = DN_BONUS_SIZE(DNODE_MIN_SIZE);
883
884         if (obj->oo_dn != NULL && obj->oo_dn->dn_num_slots != 0) {
885                 bonuslen = DN_SLOTS_TO_BONUSLEN(obj->oo_dn->dn_num_slots);
886         } else {
887                 objset_t *os = osd_dtobj2objset(&obj->oo_dt);
888                 int dnodesize;
889
890                 if (os != NULL) {
891                         dnodesize = dmu_objset_dnodesize(os);
892                         if (dnodesize != 0)
893                                 bonuslen = DN_BONUS_SIZE(dnodesize);
894                 }
895         }
896
897         return bonuslen;
898 }
899 #else
900 static inline uint64_t
901 osd_dmu_object_alloc(objset_t *os, dmu_object_type_t objtype, int blocksize,
902                      int dnodesize, dmu_tx_t *tx)
903 {
904         return dmu_object_alloc(os, objtype, blocksize, DMU_OT_SA,
905                                 DN_MAX_BONUSLEN, tx);
906 }
907
908 static inline uint64_t
909 osd_zap_create_flags(objset_t *os, int normflags, zap_flags_t flags,
910                      dmu_object_type_t ot, int leaf_blockshift,
911                      int indirect_blockshift, int dnodesize, dmu_tx_t *tx)
912 {
913         return zap_create_flags(os, normflags, flags, ot, leaf_blockshift,
914                                 indirect_blockshift, DMU_OT_SA,
915                                 DN_MAX_BONUSLEN, tx);
916 }
917
918 static inline int
919 osd_obj_bonuslen(struct osd_object *obj)
920 {
921         return DN_MAX_BONUSLEN;
922 }
923 #endif /* HAVE_DMU_OBJECT_ALLOC_DNSIZE */
924
925 #ifdef HAVE_DMU_PREFETCH_6ARG
926 #define osd_dmu_prefetch(os, obj, lvl, off, len, pri)   \
927         dmu_prefetch((os), (obj), (lvl), (off), (len), (pri))
928 #else
929 #define osd_dmu_prefetch(os, obj, lvl, off, len, pri)   \
930         dmu_prefetch((os), (obj), (lvl), (off))
931 #endif
932
933 static inline int osd_sa_handle_get(struct osd_object *obj)
934 {
935         struct osd_device *osd = osd_obj2dev(obj);
936         dnode_t *dn = obj->oo_dn;
937         int rc;
938
939         if (obj->oo_sa_hdl)
940                 return 0;
941
942         dbuf_read(dn->dn_bonus, NULL, DB_RF_MUST_SUCCEED | DB_RF_NOPREFETCH);
943         rc = -sa_handle_get_from_db(osd->od_os, &dn->dn_bonus->db, obj,
944                                     SA_HDL_PRIVATE, &obj->oo_sa_hdl);
945         if (rc)
946                 return rc;
947         zfs_refcount_add(&dn->dn_bonus->db_holds, osd_obj_tag);
948         return 0;
949 }
950
951 static inline void osd_dnode_rele(dnode_t *dn)
952 {
953         dmu_buf_impl_t *db;
954         LASSERT(dn);
955         LASSERT(dn->dn_bonus);
956         db = dn->dn_bonus;
957
958         DB_DNODE_EXIT(db);
959         dmu_buf_rele(&db->db, osd_obj_tag);
960 }
961
962 #ifdef HAVE_DMU_USEROBJ_ACCOUNTING
963
964 #define OSD_DMU_USEROBJ_PREFIX          DMU_OBJACCT_PREFIX
965 #define OSD_DMU_USEROBJ_PREFIX_LEN      DMU_OBJACCT_PREFIX_LEN
966
967 static inline bool osd_dmu_userobj_accounting_available(struct osd_device *osd)
968 {
969         return dmu_objset_userobjspace_present(osd->od_os);
970 }
971 #else
972
973 #define OSD_DMU_USEROBJ_PREFIX          "obj-"
974 #define OSD_DMU_USEROBJ_PREFIX_LEN      4
975
976 static inline bool osd_dmu_userobj_accounting_available(struct osd_device *osd)
977 {
978         return false;
979 }
980 #endif /* #ifdef HAVE_DMU_USEROBJ_ACCOUNTING */
981
982 static inline int osd_zap_add(struct osd_device *osd, uint64_t zap,
983                               dnode_t *dn, const char *key,
984                               int int_size, int int_num,
985                               const void *val, dmu_tx_t *tx)
986 {
987         LASSERT(zap != 0);
988
989 #ifdef HAVE_ZAP_ADD_BY_DNODE
990         if (dn)
991                 return -zap_add_by_dnode(dn, key, int_size, int_num, val, tx);
992 #endif
993         return -zap_add(osd->od_os, zap, key, int_size, int_num, val, tx);
994 }
995
996 static inline int osd_zap_remove(struct osd_device *osd, uint64_t zap,
997                                  dnode_t *dn, const char *key,
998                                  dmu_tx_t *tx)
999 {
1000         LASSERT(zap != 0);
1001
1002 #ifdef HAVE_ZAP_ADD_BY_DNODE
1003         if (dn)
1004                 return -zap_remove_by_dnode(dn, key, tx);
1005 #endif
1006         return -zap_remove(osd->od_os, zap, key, tx);
1007 }
1008
1009
1010 static inline int osd_zap_lookup(struct osd_device *osd, uint64_t zap,
1011                                  dnode_t *dn, const char *key,
1012                                  int int_size, int int_num, void *v)
1013 {
1014         LASSERT(zap != 0);
1015
1016 #ifdef HAVE_ZAP_ADD_BY_DNODE
1017         if (dn)
1018                 return -zap_lookup_by_dnode(dn, key, int_size, int_num, v);
1019 #endif
1020         return -zap_lookup(osd->od_os, zap, key, int_size, int_num, v);
1021 }
1022
1023 static inline void osd_tx_hold_zap(dmu_tx_t *tx, uint64_t zap,
1024                                    dnode_t *dn, int add, const char *name)
1025 {
1026 #ifdef HAVE_DMU_TX_HOLD_ZAP_BY_DNODE
1027         if (dn) {
1028                 dmu_tx_hold_zap_by_dnode(tx, dn, add, name);
1029                 return;
1030         }
1031 #endif
1032         dmu_tx_hold_zap(tx, zap, add, name);
1033 }
1034
1035 static inline void osd_tx_hold_write(dmu_tx_t *tx, uint64_t oid,
1036                                    dnode_t *dn, uint64_t off, int len)
1037 {
1038 #ifdef HAVE_DMU_TX_HOLD_ZAP_BY_DNODE
1039         if (dn) {
1040                 dmu_tx_hold_write_by_dnode(tx, dn, off, len);
1041                 return;
1042         }
1043 #endif
1044         dmu_tx_hold_write(tx, oid, off, len);
1045 }
1046
1047 static inline void osd_dmu_write(struct osd_device *osd, dnode_t *dn,
1048                                  uint64_t offset, uint64_t size,
1049                                  const char *buf, dmu_tx_t *tx)
1050 {
1051         LASSERT(dn);
1052 #ifdef HAVE_DMU_WRITE_BY_DNODE
1053         dmu_write_by_dnode(dn, offset, size, buf, tx);
1054 #else
1055         dmu_write(osd->od_os, dn->dn_object, offset, size, buf, tx);
1056 #endif
1057 }
1058
1059 static inline int osd_dmu_read(struct osd_device *osd, dnode_t *dn,
1060                                uint64_t offset, uint64_t size,
1061                                char *buf, int flags)
1062 {
1063         LASSERT(dn);
1064 #ifdef HAVE_DMU_READ_BY_DNODE
1065         return -dmu_read_by_dnode(dn, offset, size, buf, flags);
1066 #else
1067         return -dmu_read(osd->od_os, dn->dn_object, offset, size, buf, flags);
1068 #endif
1069 }
1070
1071 #ifdef HAVE_DMU_OBJSET_OWN_6ARG
1072 #define osd_dmu_objset_own(name, type, ronly, decrypt, tag, os) \
1073         dmu_objset_own((name), (type), (ronly), (decrypt), (tag), (os))
1074 #else
1075 #define osd_dmu_objset_own(name, type, ronly, decrypt, tag, os) \
1076         dmu_objset_own((name), (type), (ronly), (tag), (os))
1077 #endif
1078
1079 #ifdef HAVE_DMU_OBJSET_DISOWN_3ARG
1080 #define osd_dmu_objset_disown(os, decrypt, tag) \
1081         dmu_objset_disown((os), (decrypt), (tag))
1082 #else
1083 #define osd_dmu_objset_disown(os, decrypt, tag) \
1084         dmu_objset_disown((os), (tag))
1085 #endif
1086
1087 static inline int
1088 osd_index_register(struct osd_device *osd, const struct lu_fid *fid,
1089                    __u32 keysize, __u32 recsize)
1090 {
1091         return lustre_index_register(&osd->od_dt_dev, osd_name(osd),
1092                                      &osd->od_index_backup_list, &osd->od_lock,
1093                                      &osd->od_index_backup_stop,
1094                                      fid, keysize, recsize);
1095 }
1096
1097 static inline void
1098 osd_index_backup(const struct lu_env *env, struct osd_device *osd, bool backup)
1099 {
1100         struct lu_fid *fid = &osd_oti_get(env)->oti_fid;
1101         int rc;
1102
1103         lu_local_obj_fid(fid, INDEX_BACKUP_OID);
1104         rc = osd_idc_find_and_init_with_oid(env, osd, fid,
1105                                             osd->od_index_backup_id);
1106         if (rc)
1107                 backup = false;
1108
1109         lustre_index_backup(env, &osd->od_dt_dev, osd_name(osd),
1110                             &osd->od_index_backup_list, &osd->od_lock,
1111                             &osd->od_index_backup_stop, backup);
1112 }
1113
1114 #ifndef HAVE_DMU_TX_MARK_NETFREE
1115 #define dmu_tx_mark_netfree(tx)
1116 #endif
1117
1118 #ifndef HAVE_ZFS_INODE_TIMESPEC
1119 #define inode_timespec_t timestruc_t
1120 #endif
1121
1122 #endif /* _OSD_INTERNAL_H */