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