Whamcloud - gitweb
1fa1f760a7cf639f8b3753196265ae400da39469
[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         unsigned int             od_dnsize;
352         int                      od_index_backup_stop;
353
354         enum lustre_index_backup_policy od_index_backup_policy;
355         char                     od_mntdev[128];
356         char                     od_svname[128];
357         char                     od_uuid[16];
358
359         int                      od_connects;
360         int                      od_index;
361         __s64                    od_auto_scrub_interval;
362         struct lu_site           od_site;
363
364         dnode_t                 *od_groupused_dn;
365         dnode_t                 *od_userused_dn;
366 #ifdef ZFS_PROJINHERIT
367         dnode_t                 *od_projectused_dn;
368 #endif
369
370         /* quota slave instance for inode */
371         struct qsd_instance     *od_quota_slave_md;
372
373         /* quota slave instance for block */
374         struct qsd_instance     *od_quota_slave_dt;
375
376         struct brw_stats        od_brw_stats;
377         atomic_t                od_r_in_flight;
378         atomic_t                od_w_in_flight;
379
380         /* used to debug zerocopy logic: the fields track all
381          * allocated, loaned and referenced buffers in use.
382          * to be removed once the change is tested well. */
383         atomic_t                 od_zerocopy_alloc;
384         atomic_t                 od_zerocopy_loan;
385         atomic_t                 od_zerocopy_pin;
386
387         arc_prune_t             *arc_prune_cb;
388
389         /* osd seq instance */
390         struct lu_client_seq    *od_cl_seq;
391
392         struct semaphore         od_otable_sem;
393         struct osd_otable_it    *od_otable_it;
394         struct lustre_scrub      od_scrub;
395         struct list_head         od_ios_list;
396         struct list_head         od_index_backup_list;
397         struct list_head         od_index_restore_list;
398         spinlock_t               od_lock;
399         unsigned long long       od_readcache_max_filesize;
400 };
401
402 static inline struct qsd_instance *osd_def_qsd(struct osd_device *osd)
403 {
404         if (osd->od_is_ost)
405                 return osd->od_quota_slave_dt;
406         else
407                 return osd->od_quota_slave_md;
408 }
409
410 enum osd_destroy_type {
411         OSD_DESTROY_NONE = 0,
412         OSD_DESTROY_SYNC = 1,
413         OSD_DESTROY_ASYNC = 2,
414 };
415
416 struct osd_object {
417         struct dt_object         oo_dt;
418         /*
419          * Inode for file system object represented by this osd_object. This
420          * inode is pinned for the whole duration of lu_object life.
421          *
422          * Not modified concurrently (either setup early during object
423          * creation, or assigned by osd_create() under write lock).
424          */
425         dnode_t *oo_dn;
426         sa_handle_t             *oo_sa_hdl;
427         nvlist_t                *oo_sa_xattr;
428         struct list_head         oo_sa_linkage;
429
430         /* used to implement osd_object_*_{lock|unlock} */
431         struct rw_semaphore      oo_sem;
432
433         /* to serialize some updates: destroy vs. others,
434          * xattr_set, object block size change etc */
435         struct rw_semaphore      oo_guard;
436
437         /* protected by oo_guard */
438         struct list_head         oo_unlinked_linkage;
439
440         /* cached attributes */
441         rwlock_t                 oo_attr_lock;
442         struct lu_attr           oo_attr;
443
444         /* external dnode holding large EAs, protected by oo_guard */
445         uint64_t                 oo_xattr;
446         enum osd_destroy_type    oo_destroy;
447
448         __u32                    oo_destroyed:1,
449                                  oo_late_xattr:1,
450 #ifdef ZFS_PROJINHERIT
451                                  oo_with_projid:1,
452 #endif
453                                  oo_late_attr_set:1,
454                                  oo_pfid_in_lma:1;
455
456         /* the i_flags in LMA */
457         __u32                    oo_lma_flags;
458         union {
459                 int             oo_ea_in_bonus; /* EA bytes we expect */
460                 struct {
461                         /* record size for index file */
462                         unsigned char            oo_keysize;
463                         unsigned char            oo_recsize;
464                         unsigned char            oo_recusize;   /* unit size */
465                 };
466                 uint64_t        oo_parent; /* used only at object creation */
467         };
468         struct lu_object_header *oo_header;
469 };
470
471 int osd_statfs(const struct lu_env *, struct dt_device *, struct obd_statfs *);
472 extern const struct dt_index_operations osd_acct_index_ops;
473 extern struct lu_device_operations  osd_lu_ops;
474 extern struct dt_index_operations osd_dir_ops;
475 int osd_declare_quota(const struct lu_env *env, struct osd_device *osd,
476                       qid_t uid, qid_t gid, qid_t projid, long long space,
477                       struct osd_thandle *oh, int *flags,
478                       enum osd_qid_declare_flags osd_qid_declare_flags);
479 uint64_t osd_objs_count_estimate(uint64_t refdbytes, uint64_t usedobjs,
480                                  uint64_t nrblocks, uint64_t est_maxblockshift);
481 int osd_unlinked_object_free(const struct lu_env *env, struct osd_device *osd,
482                          uint64_t oid);
483
484 /*
485  * Helpers.
486  */
487 static inline int lu_device_is_osd(const struct lu_device *d)
488 {
489         return ergo(d != NULL && d->ld_ops != NULL, d->ld_ops == &osd_lu_ops);
490 }
491
492 static inline struct osd_object *osd_obj(const struct lu_object *o)
493 {
494         LASSERT(lu_device_is_osd(o->lo_dev));
495         return container_of0(o, struct osd_object, oo_dt.do_lu);
496 }
497
498 static inline struct osd_device *osd_dt_dev(const struct dt_device *d)
499 {
500         LASSERT(lu_device_is_osd(&d->dd_lu_dev));
501         return container_of0(d, struct osd_device, od_dt_dev);
502 }
503
504 static inline struct osd_device *osd_dev(const struct lu_device *d)
505 {
506         LASSERT(lu_device_is_osd(d));
507         return osd_dt_dev(container_of0(d, struct dt_device, dd_lu_dev));
508 }
509
510 static inline struct osd_object *osd_dt_obj(const struct dt_object *d)
511 {
512         return osd_obj(&d->do_lu);
513 }
514
515 static inline struct osd_device *osd_obj2dev(const struct osd_object *o)
516 {
517         return osd_dev(o->oo_dt.do_lu.lo_dev);
518 }
519
520 static inline struct lu_device *osd2lu_dev(struct osd_device *osd)
521 {
522         return &osd->od_dt_dev.dd_lu_dev;
523 }
524
525 static inline struct objset * osd_dtobj2objset(struct dt_object *o)
526 {
527         return osd_dev(o->do_lu.lo_dev)->od_os;
528 }
529
530 static inline int osd_invariant(const struct osd_object *obj)
531 {
532         return 1;
533 }
534
535 /**
536  * Put the osd object once done with it.
537  *
538  * \param obj osd object that needs to be put
539  */
540 static inline void osd_object_put(const struct lu_env *env,
541                                   struct osd_object *obj)
542 {
543         dt_object_put(env, &obj->oo_dt);
544 }
545
546 static inline int osd_object_invariant(const struct lu_object *l)
547 {
548         return osd_invariant(osd_obj(l));
549 }
550
551 static inline struct seq_server_site *osd_seq_site(struct osd_device *osd)
552 {
553         return osd->od_dt_dev.dd_lu_dev.ld_site->ld_seq_site;
554 }
555
556 static inline char *osd_name(struct osd_device *osd)
557 {
558         return osd->od_svname;
559 }
560
561 static inline void zfs_set_bit(int nr, __u8 *addr)
562 {
563         set_bit(nr, (unsigned long *)addr);
564 }
565
566 static inline int zfs_test_bit(int nr, __u8 *addr)
567 {
568         return test_bit(nr, (const unsigned long *)addr);
569 }
570
571 static inline int osd_oi_fid2idx(struct osd_device *dev,
572                                  const struct lu_fid *fid)
573 {
574         return fid->f_seq & (dev->od_oi_count - 1);
575 }
576
577 static inline struct osd_oi *osd_fid2oi(struct osd_device *osd,
578                                         const struct lu_fid *fid)
579 {
580         LASSERTF(osd->od_oi_table && osd->od_oi_count >= 1,
581                  "%s: "DFID", oi_count %d\n",
582                  osd_name(osd), PFID(fid), osd->od_oi_count);
583
584         return osd->od_oi_table[osd_oi_fid2idx(osd, fid)];
585 }
586
587 #ifdef CONFIG_PROC_FS
588 enum {
589         LPROC_OSD_READ_BYTES = 0,
590         LPROC_OSD_WRITE_BYTES = 1,
591         LPROC_OSD_GET_PAGE = 2,
592         LPROC_OSD_NO_PAGE = 3,
593         LPROC_OSD_CACHE_ACCESS = 4,
594         LPROC_OSD_CACHE_HIT = 5,
595         LPROC_OSD_CACHE_MISS = 6,
596         LPROC_OSD_COPY_IO = 7,
597         LPROC_OSD_ZEROCOPY_IO = 8,
598         LPROC_OSD_TAIL_IO = 9,
599         LPROC_OSD_LAST,
600 };
601
602 extern struct kmem_cache *osd_zapit_cachep;
603 /* osd_lproc.c */
604 extern struct lprocfs_vars lprocfs_osd_obd_vars[];
605
606 int osd_procfs_init(struct osd_device *osd, const char *name);
607 int osd_procfs_fini(struct osd_device *osd);
608
609 /* osd_object.c */
610 extern char *osd_obj_tag;
611 int __osd_obj2dnode(objset_t *os, uint64_t oid, dnode_t **dnp);
612 void osd_object_sa_dirty_rele(const struct lu_env *env, struct osd_thandle *oh);
613 void osd_object_sa_dirty_add(struct osd_object *obj, struct osd_thandle *oh);
614 int __osd_obj2dbuf(const struct lu_env *env, objset_t *os,
615                    uint64_t oid, dmu_buf_t **dbp);
616 struct lu_object *osd_object_alloc(const struct lu_env *env,
617                                    const struct lu_object_header *hdr,
618                                    struct lu_device *d);
619 int osd_object_sa_update(struct osd_object *obj, sa_attr_type_t type,
620                          void *buf, uint32_t buflen, struct osd_thandle *oh);
621 int __osd_zap_create(const struct lu_env *env, struct osd_device *osd,
622                      dnode_t **zap_dnp, dmu_tx_t *tx, struct lu_attr *la,
623                      unsigned dnsize, zap_flags_t flags);
624 int __osd_object_create(const struct lu_env *env, struct osd_device *osd,
625                         struct osd_object *obj, const struct lu_fid *fid,
626                         dnode_t **dnp, dmu_tx_t *tx, struct lu_attr *la);
627 int __osd_attr_init(const struct lu_env *env, struct osd_device *osd,
628                     struct osd_object *obj, sa_handle_t *sa_hdl, dmu_tx_t *tx,
629                     struct lu_attr *la, uint64_t parent, nvlist_t *);
630 int osd_find_new_dnode(const struct lu_env *env, dmu_tx_t *tx,
631                        uint64_t oid, dnode_t **dnp);
632
633 /* osd_oi.c */
634 int osd_oi_init(const struct lu_env *env, struct osd_device *o);
635 void osd_oi_fini(const struct lu_env *env, struct osd_device *o);
636 int osd_fid_lookup(const struct lu_env *env,
637                    struct osd_device *, const struct lu_fid *, uint64_t *);
638 uint64_t osd_get_name_n_idx(const struct lu_env *env, struct osd_device *osd,
639                             const struct lu_fid *fid, char *buf, int bufsize,
640                             dnode_t **zdn);
641 int osd_options_init(void);
642 int osd_ost_seq_exists(const struct lu_env *env, struct osd_device *osd,
643                        __u64 seq);
644 int osd_idc_find_and_init(const struct lu_env *env, struct osd_device *osd,
645                           struct osd_object *obj);
646 struct osd_idmap_cache *osd_idc_find_or_init(const struct lu_env *env,
647                                              struct osd_device *osd,
648                                              const struct lu_fid *fid);
649 struct osd_idmap_cache *osd_idc_find(const struct lu_env *env,
650                                      struct osd_device *osd,
651                                      const struct lu_fid *fid);
652 int osd_idc_find_and_init_with_oid(const struct lu_env *env,
653                                    struct osd_device *osd,
654                                    const struct lu_fid *fid,
655                                    uint64_t oid);
656 int fid_is_on_ost(const struct lu_env *env, struct osd_device *osd,
657                   const struct lu_fid *fid);
658 int osd_obj_find_or_create(const struct lu_env *env, struct osd_device *o,
659                            uint64_t parent, const char *name, uint64_t *child,
660                            const struct lu_fid *fid, bool isdir);
661
662 extern unsigned int osd_oi_count;
663
664 /* osd_index.c */
665 int osd_get_fid_by_oid(const struct lu_env *env, struct osd_device *osd,
666                        uint64_t oid, struct lu_fid *fid);
667 int osd_index_try(const struct lu_env *env, struct dt_object *dt,
668                   const struct dt_index_features *feat);
669 int osd_fld_lookup(const struct lu_env *env, struct osd_device *osd,
670                    u64 seq, struct lu_seq_range *range);
671 void osd_zap_cursor_init_serialized(zap_cursor_t *zc, struct objset *os,
672                                     uint64_t id, uint64_t dirhash);
673 int osd_zap_cursor_init(zap_cursor_t **zc, struct objset *os,
674                         uint64_t id, uint64_t dirhash);
675 void osd_zap_cursor_fini(zap_cursor_t *zc);
676 uint64_t osd_zap_cursor_serialize(zap_cursor_t *zc);
677 int osd_remote_fid(const struct lu_env *env, struct osd_device *osd,
678                    const struct lu_fid *fid);
679 int osd_add_to_remote_parent(const struct lu_env *env,
680                              struct osd_device *osd,
681                              struct osd_object *obj,
682                              struct osd_thandle *oh);
683 int osd_delete_from_remote_parent(const struct lu_env *env,
684                                   struct osd_device *osd,
685                                   struct osd_object *obj,
686                                   struct osd_thandle *oh, bool destroy);
687 int __osd_xattr_load_by_oid(struct osd_device *osd, uint64_t oid,
688                             nvlist_t **sa);
689
690 /* osd_scrub.c */
691 int osd_scrub_setup(const struct lu_env *env, struct osd_device *dev);
692 void osd_scrub_cleanup(const struct lu_env *env, struct osd_device *dev);
693 int osd_scrub_start(const struct lu_env *env, struct osd_device *dev,
694                     __u32 flags);
695 void osd_scrub_stop(struct osd_device *dev);
696 int osd_oii_insert(const struct lu_env *env, struct osd_device *dev,
697                    const struct lu_fid *fid, uint64_t oid, bool insert);
698 int osd_oii_lookup(struct osd_device *dev, const struct lu_fid *fid,
699                    uint64_t *oid);
700
701 /* osd_xattr.c */
702 int __osd_sa_xattr_schedule_update(const struct lu_env *env,
703                                    struct osd_object *obj,
704                                    struct osd_thandle *oh);
705 int __osd_sa_attr_init(const struct lu_env *env, struct osd_object *obj,
706                        struct osd_thandle *oh);
707 int __osd_sa_xattr_update(const struct lu_env *env, struct osd_object *obj,
708                           struct osd_thandle *oh);
709 int __osd_xattr_load(struct osd_device *osd, sa_handle_t *hdl,
710                      nvlist_t **sa);
711 int __osd_xattr_get_large(const struct lu_env *env, struct osd_device *osd,
712                           uint64_t xattr, struct lu_buf *buf,
713                           const char *name, int *sizep);
714 int osd_xattr_get_internal(const struct lu_env *env, struct osd_object *obj,
715                            struct lu_buf *buf, const char *name, int *sizep);
716 int osd_xattr_get(const struct lu_env *env, struct dt_object *dt,
717                   struct lu_buf *buf, const char *name);
718 int osd_declare_xattr_set(const struct lu_env *env, struct dt_object *dt,
719                           const struct lu_buf *buf, const char *name,
720                           int fl, struct thandle *handle);
721 int osd_xattr_set(const struct lu_env *env, struct dt_object *dt,
722                   const struct lu_buf *buf, const char *name, int fl,
723                   struct thandle *handle);
724 int osd_declare_xattr_del(const struct lu_env *env, struct dt_object *dt,
725                           const char *name, struct thandle *handle);
726 int osd_xattr_del(const struct lu_env *env, struct dt_object *dt,
727                   const char *name, struct thandle *handle);
728 void osd_declare_xattrs_destroy(const struct lu_env *env,
729                                 struct osd_object *obj,
730                                 struct osd_thandle *oh);
731 int osd_xattrs_destroy(const struct lu_env *env,
732                        struct osd_object *obj, struct osd_thandle *oh);
733 int osd_xattr_list(const struct lu_env *env, struct dt_object *dt,
734                    const struct lu_buf *lb);
735 void __osd_xattr_declare_set(const struct lu_env *env, struct osd_object *obj,
736                         int vallen, const char *name, struct osd_thandle *oh);
737 int __osd_sa_xattr_set(const struct lu_env *env, struct osd_object *obj,
738                        const struct lu_buf *buf, const char *name, int fl,
739                        struct osd_thandle *oh);;
740 int __osd_xattr_set(const struct lu_env *env, struct osd_object *obj,
741                     const struct lu_buf *buf, const char *name, int fl,
742                     struct osd_thandle *oh);
743 int __osd_sa_xattr_update(const struct lu_env *env, struct osd_object *obj,
744                           struct osd_thandle *oh);
745
746 #define OSD_BASE_EA_IN_BONUS    (ZFS_SA_BASE_ATTR_SIZE + \
747                                  sizeof(__u64) /* VBR VERSION */ + \
748                                  sizeof(struct lustre_mdt_attrs) /* LMA */)
749
750 #ifdef HAVE_DMU_OBJECT_ALLOC_DNSIZE
751 int osd_find_dnsize(struct osd_device *osd, int ea_in_bonus);
752 #else
753 static inline int
754 osd_find_dnsize(struct osd_device *osd, int ea_in_bonus)
755 {
756         return DN_MAX_BONUSLEN;
757 }
758 #endif
759
760 static inline int osd_object_is_zap(dnode_t *dn)
761 {
762         return (dn->dn_type == DMU_OT_DIRECTORY_CONTENTS ||
763                 dn->dn_type == DMU_OT_USERGROUP_USED);
764 }
765
766 /* XXX: f_ver is not counted, but may differ too */
767 static inline void osd_fid2str(char *buf, const struct lu_fid *fid, int len)
768 {
769         snprintf(buf, len, DFID_NOBRACE, PFID(fid));
770 }
771
772 static inline int
773 osd_xattr_set_internal(const struct lu_env *env, struct osd_object *obj,
774                        const struct lu_buf *buf, const char *name, int fl,
775                        struct osd_thandle *oh)
776 {
777         int rc;
778
779         if (unlikely(!dt_object_exists(&obj->oo_dt) || obj->oo_destroyed))
780                 return -ENOENT;
781
782         LASSERT(obj->oo_dn);
783         if (osd_obj2dev(obj)->od_xattr_in_sa) {
784                 rc = __osd_sa_xattr_set(env, obj, buf, name, fl, oh);
785                 if (rc == -EFBIG)
786                         rc = __osd_xattr_set(env, obj, buf, name, fl, oh);
787         } else {
788                 rc = __osd_xattr_set(env, obj, buf, name, fl, oh);
789         }
790
791         return rc;
792 }
793
794 static inline uint64_t attrs_fs2zfs(const uint32_t flags)
795 {
796         return (flags & LUSTRE_APPEND_FL        ? ZFS_APPENDONLY        : 0) |
797                 (flags & LUSTRE_NODUMP_FL       ? ZFS_NODUMP            : 0) |
798 #ifdef ZFS_PROJINHERIT
799                 (flags & LUSTRE_PROJINHERIT_FL  ? ZFS_PROJINHERIT       : 0) |
800 #endif
801                 (flags & LUSTRE_IMMUTABLE_FL    ? ZFS_IMMUTABLE         : 0);
802 }
803
804 static inline uint32_t attrs_zfs2fs(const uint64_t flags)
805 {
806         return (flags & ZFS_APPENDONLY  ? LUSTRE_APPEND_FL      : 0) |
807                 (flags & ZFS_NODUMP     ? LUSTRE_NODUMP_FL      : 0) |
808 #ifdef ZFS_PROJINHERIT
809                 (flags & ZFS_PROJINHERIT ? LUSTRE_PROJINHERIT_FL : 0) |
810 #endif
811                 (flags & ZFS_IMMUTABLE  ? LUSTRE_IMMUTABLE_FL   : 0);
812 }
813
814 #endif
815
816 #ifndef HAVE_DSL_POOL_CONFIG
817 static inline void dsl_pool_config_enter(dsl_pool_t *dp, char *name)
818 {
819 }
820
821 static inline void dsl_pool_config_exit(dsl_pool_t *dp, char *name)
822 {
823 }
824 #endif
825
826 #ifdef HAVE_SPA_MAXBLOCKSIZE
827 #define osd_spa_maxblocksize(spa)       spa_maxblocksize(spa)
828 #define osd_spa_maxblockshift(spa)      fls64(spa_maxblocksize(spa) - 1)
829 #else
830 #define osd_spa_maxblocksize(spa)       SPA_MAXBLOCKSIZE
831 #define osd_spa_maxblockshift(spa)      SPA_MAXBLOCKSHIFT
832 #define SPA_OLD_MAXBLOCKSIZE            SPA_MAXBLOCKSIZE
833 #endif
834
835 #ifdef HAVE_SA_SPILL_ALLOC
836 static inline void *
837 osd_zio_buf_alloc(size_t size)
838 {
839         return sa_spill_alloc(KM_SLEEP);
840 }
841
842 static inline void
843 osd_zio_buf_free(void *buf, size_t size)
844 {
845         sa_spill_free(buf);
846 }
847 #else
848 #define osd_zio_buf_alloc(size)         zio_buf_alloc(size)
849 #define osd_zio_buf_free(buf, size)     zio_buf_free(buf, size)
850 #endif
851
852 #ifdef HAVE_DMU_OBJECT_ALLOC_DNSIZE
853 static inline uint64_t
854 osd_dmu_object_alloc(objset_t *os, dmu_object_type_t objtype, int blocksize,
855                      int dnodesize, dmu_tx_t *tx)
856 {
857         if (dnodesize == 0)
858                 dnodesize = MAX(dmu_objset_dnodesize(os), DNODE_MIN_SIZE);
859
860         return dmu_object_alloc_dnsize(os, objtype, blocksize, DMU_OT_SA,
861                                        DN_BONUS_SIZE(dnodesize), dnodesize, tx);
862 }
863
864 static inline uint64_t
865 osd_zap_create_flags(objset_t *os, int normflags, zap_flags_t flags,
866                      dmu_object_type_t ot, int leaf_blockshift,
867                      int indirect_blockshift, int dnodesize, dmu_tx_t *tx)
868 {
869         if (dnodesize == 0)
870                 dnodesize = MAX(dmu_objset_dnodesize(os), DNODE_MIN_SIZE);
871
872         return zap_create_flags_dnsize(os, normflags, flags, ot,
873                                        leaf_blockshift, indirect_blockshift,
874                                        DMU_OT_SA, DN_BONUS_SIZE(dnodesize),
875                                        dnodesize, tx);
876 }
877
878 static inline int
879 osd_obj_bonuslen(struct osd_object *obj)
880 {
881         int bonuslen = DN_BONUS_SIZE(DNODE_MIN_SIZE);
882
883         if (obj->oo_dn != NULL && obj->oo_dn->dn_num_slots != 0) {
884                 bonuslen = DN_SLOTS_TO_BONUSLEN(obj->oo_dn->dn_num_slots);
885         } else {
886                 objset_t *os = osd_dtobj2objset(&obj->oo_dt);
887                 int dnodesize;
888
889                 if (os != NULL) {
890                         dnodesize = dmu_objset_dnodesize(os);
891                         if (dnodesize != 0)
892                                 bonuslen = DN_BONUS_SIZE(dnodesize);
893                 }
894         }
895
896         return bonuslen;
897 }
898 #else
899 static inline uint64_t
900 osd_dmu_object_alloc(objset_t *os, dmu_object_type_t objtype, int blocksize,
901                      int dnodesize, dmu_tx_t *tx)
902 {
903         return dmu_object_alloc(os, objtype, blocksize, DMU_OT_SA,
904                                 DN_MAX_BONUSLEN, tx);
905 }
906
907 static inline uint64_t
908 osd_zap_create_flags(objset_t *os, int normflags, zap_flags_t flags,
909                      dmu_object_type_t ot, int leaf_blockshift,
910                      int indirect_blockshift, int dnodesize, dmu_tx_t *tx)
911 {
912         return zap_create_flags(os, normflags, flags, ot, leaf_blockshift,
913                                 indirect_blockshift, DMU_OT_SA,
914                                 DN_MAX_BONUSLEN, tx);
915 }
916
917 static inline int
918 osd_obj_bonuslen(struct osd_object *obj)
919 {
920         return DN_MAX_BONUSLEN;
921 }
922 #endif /* HAVE_DMU_OBJECT_ALLOC_DNSIZE */
923
924 #ifdef HAVE_DMU_PREFETCH_6ARG
925 #define osd_dmu_prefetch(os, obj, lvl, off, len, pri)   \
926         dmu_prefetch((os), (obj), (lvl), (off), (len), (pri))
927 #else
928 #define osd_dmu_prefetch(os, obj, lvl, off, len, pri)   \
929         dmu_prefetch((os), (obj), (lvl), (off))
930 #endif
931
932 static inline int osd_sa_handle_get(struct osd_object *obj)
933 {
934         struct osd_device *osd = osd_obj2dev(obj);
935         dnode_t *dn = obj->oo_dn;
936         int rc;
937
938         if (obj->oo_sa_hdl)
939                 return 0;
940
941         dbuf_read(dn->dn_bonus, NULL, DB_RF_MUST_SUCCEED | DB_RF_NOPREFETCH);
942         rc = -sa_handle_get_from_db(osd->od_os, &dn->dn_bonus->db, obj,
943                                     SA_HDL_PRIVATE, &obj->oo_sa_hdl);
944         if (rc)
945                 return rc;
946         zfs_refcount_add(&dn->dn_bonus->db_holds, osd_obj_tag);
947         return 0;
948 }
949
950 static inline void osd_dnode_rele(dnode_t *dn)
951 {
952         dmu_buf_impl_t *db;
953         LASSERT(dn);
954         LASSERT(dn->dn_bonus);
955         db = dn->dn_bonus;
956
957         DB_DNODE_EXIT(db);
958         dmu_buf_rele(&db->db, osd_obj_tag);
959 }
960
961 #ifdef HAVE_DMU_USEROBJ_ACCOUNTING
962
963 #define OSD_DMU_USEROBJ_PREFIX          DMU_OBJACCT_PREFIX
964 #define OSD_DMU_USEROBJ_PREFIX_LEN      DMU_OBJACCT_PREFIX_LEN
965
966 static inline bool osd_dmu_userobj_accounting_available(struct osd_device *osd)
967 {
968         return dmu_objset_userobjspace_present(osd->od_os);
969 }
970 #else
971
972 #define OSD_DMU_USEROBJ_PREFIX          "obj-"
973 #define OSD_DMU_USEROBJ_PREFIX_LEN      4
974
975 static inline bool osd_dmu_userobj_accounting_available(struct osd_device *osd)
976 {
977         return false;
978 }
979 #endif /* #ifdef HAVE_DMU_USEROBJ_ACCOUNTING */
980
981 static inline int osd_zap_add(struct osd_device *osd, uint64_t zap,
982                               dnode_t *dn, const char *key,
983                               int int_size, int int_num,
984                               const void *val, dmu_tx_t *tx)
985 {
986         LASSERT(zap != 0);
987
988 #ifdef HAVE_ZAP_ADD_BY_DNODE
989         if (dn)
990                 return -zap_add_by_dnode(dn, key, int_size, int_num, val, tx);
991 #endif
992         return -zap_add(osd->od_os, zap, key, int_size, int_num, val, tx);
993 }
994
995 static inline int osd_zap_remove(struct osd_device *osd, uint64_t zap,
996                                  dnode_t *dn, const char *key,
997                                  dmu_tx_t *tx)
998 {
999         LASSERT(zap != 0);
1000
1001 #ifdef HAVE_ZAP_ADD_BY_DNODE
1002         if (dn)
1003                 return -zap_remove_by_dnode(dn, key, tx);
1004 #endif
1005         return -zap_remove(osd->od_os, zap, key, tx);
1006 }
1007
1008
1009 static inline int osd_zap_lookup(struct osd_device *osd, uint64_t zap,
1010                                  dnode_t *dn, const char *key,
1011                                  int int_size, int int_num, void *v)
1012 {
1013         LASSERT(zap != 0);
1014
1015 #ifdef HAVE_ZAP_ADD_BY_DNODE
1016         if (dn)
1017                 return -zap_lookup_by_dnode(dn, key, int_size, int_num, v);
1018 #endif
1019         return -zap_lookup(osd->od_os, zap, key, int_size, int_num, v);
1020 }
1021
1022 static inline void osd_tx_hold_zap(dmu_tx_t *tx, uint64_t zap,
1023                                    dnode_t *dn, int add, const char *name)
1024 {
1025 #ifdef HAVE_DMU_TX_HOLD_ZAP_BY_DNODE
1026         if (dn) {
1027                 dmu_tx_hold_zap_by_dnode(tx, dn, add, name);
1028                 return;
1029         }
1030 #endif
1031         dmu_tx_hold_zap(tx, zap, add, name);
1032 }
1033
1034 static inline void osd_tx_hold_write(dmu_tx_t *tx, uint64_t oid,
1035                                    dnode_t *dn, uint64_t off, int len)
1036 {
1037 #ifdef HAVE_DMU_TX_HOLD_ZAP_BY_DNODE
1038         if (dn) {
1039                 dmu_tx_hold_write_by_dnode(tx, dn, off, len);
1040                 return;
1041         }
1042 #endif
1043         dmu_tx_hold_write(tx, oid, off, len);
1044 }
1045
1046 static inline void osd_dmu_write(struct osd_device *osd, dnode_t *dn,
1047                                  uint64_t offset, uint64_t size,
1048                                  const char *buf, dmu_tx_t *tx)
1049 {
1050         LASSERT(dn);
1051 #ifdef HAVE_DMU_WRITE_BY_DNODE
1052         dmu_write_by_dnode(dn, offset, size, buf, tx);
1053 #else
1054         dmu_write(osd->od_os, dn->dn_object, offset, size, buf, tx);
1055 #endif
1056 }
1057
1058 static inline int osd_dmu_read(struct osd_device *osd, dnode_t *dn,
1059                                uint64_t offset, uint64_t size,
1060                                char *buf, int flags)
1061 {
1062         LASSERT(dn);
1063 #ifdef HAVE_DMU_READ_BY_DNODE
1064         return -dmu_read_by_dnode(dn, offset, size, buf, flags);
1065 #else
1066         return -dmu_read(osd->od_os, dn->dn_object, offset, size, buf, flags);
1067 #endif
1068 }
1069
1070 #ifdef HAVE_DMU_OBJSET_OWN_6ARG
1071 #define osd_dmu_objset_own(name, type, ronly, decrypt, tag, os) \
1072         dmu_objset_own((name), (type), (ronly), (decrypt), (tag), (os))
1073 #else
1074 #define osd_dmu_objset_own(name, type, ronly, decrypt, tag, os) \
1075         dmu_objset_own((name), (type), (ronly), (tag), (os))
1076 #endif
1077
1078 #ifdef HAVE_DMU_OBJSET_DISOWN_3ARG
1079 #define osd_dmu_objset_disown(os, decrypt, tag) \
1080         dmu_objset_disown((os), (decrypt), (tag))
1081 #else
1082 #define osd_dmu_objset_disown(os, decrypt, tag) \
1083         dmu_objset_disown((os), (tag))
1084 #endif
1085
1086 static inline int
1087 osd_index_register(struct osd_device *osd, const struct lu_fid *fid,
1088                    __u32 keysize, __u32 recsize)
1089 {
1090         return lustre_index_register(&osd->od_dt_dev, osd_name(osd),
1091                                      &osd->od_index_backup_list, &osd->od_lock,
1092                                      &osd->od_index_backup_stop,
1093                                      fid, keysize, recsize);
1094 }
1095
1096 static inline void
1097 osd_index_backup(const struct lu_env *env, struct osd_device *osd, bool backup)
1098 {
1099         struct lu_fid *fid = &osd_oti_get(env)->oti_fid;
1100         int rc;
1101
1102         lu_local_obj_fid(fid, INDEX_BACKUP_OID);
1103         rc = osd_idc_find_and_init_with_oid(env, osd, fid,
1104                                             osd->od_index_backup_id);
1105         if (rc)
1106                 backup = false;
1107
1108         lustre_index_backup(env, &osd->od_dt_dev, osd_name(osd),
1109                             &osd->od_index_backup_list, &osd->od_lock,
1110                             &osd->od_index_backup_stop, backup);
1111 }
1112
1113 #ifndef HAVE_DMU_TX_MARK_NETFREE
1114 #define dmu_tx_mark_netfree(tx)
1115 #endif
1116
1117 #ifndef HAVE_ZFS_INODE_TIMESPEC
1118 #define inode_timespec_t timestruc_t
1119 #endif
1120
1121 #endif /* _OSD_INTERNAL_H */