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