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