Whamcloud - gitweb
LU-7437 utils: continue on errors in lctl {get,set}_param
[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.sun.com/software/products/lustre/docs/GPLv2.pdf
19  *
20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21  * CA 95054 USA or visit www.sun.com if you need additional information or
22  * have any questions.
23  *
24  * GPL HEADER END
25  */
26 /*
27  * Copyright (c) 2009, 2010, Oracle and/or its affiliates. All rights reserved.
28  * Use is subject to license terms.
29  *
30  * Copyright (c) 2012, 2015, Intel Corporation.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  *
36  * lustre/osd-zfs/osd_internal.h
37  * Shared definitions and declarations for zfs/dmu osd
38  *
39  * Author: Alex Zhuravlev <bzzz@whamcloud.com>
40  * Author: Mike Pershin <tappro@whamcloud.com>
41  * Author: Johann Lombardi <johann@whamcloud.com>
42  */
43
44 #ifndef _OSD_INTERNAL_H
45 #define _OSD_INTERNAL_H
46
47 #include <dt_object.h>
48 #include <md_object.h>
49 #include <lustre_quota.h>
50 #ifdef SHRINK_STOP
51 #undef SHRINK_STOP
52 #endif
53 #include <sys/arc.h>
54 #include <sys/nvpair.h>
55 #include <sys/zfs_znode.h>
56 #include <sys/zap.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 LUSTRE_ROOT_FID_SEQ     0
80 #define DMU_OSD_SVNAME          "svname"
81 #define DMU_OSD_OI_NAME_BASE    "oi"
82
83 #define OSD_GFP_IO              (GFP_NOFS | __GFP_HIGHMEM)
84
85 /* Statfs space reservation for grant, fragmentation, and unlink space. */
86 #define OSD_STATFS_RESERVED_SIZE        (16ULL << 20) /* reserve 16MB minimum */
87 #define OSD_STATFS_RESERVED_SHIFT       (7)     /* reserve 0.78% of all space */
88
89 /* Statfs {minimum, safe estimate, and maximum} dnodes per block */
90 #define OSD_DNODE_MIN_BLKSHIFT  (DNODES_PER_BLOCK_SHIFT)
91 #define OSD_DNODE_EST_BLKSHIFT  (DNODES_PER_BLOCK_SHIFT >> 1)
92 #define OSD_DNODE_EST_COUNT     1024
93
94 #define OSD_GRANT_FOR_LOCAL_OIDS (2ULL << 20) /* 2MB for last_rcvd, ... */
95
96 /**
97  * Iterator's in-memory data structure for quota file.
98  */
99 struct osd_it_quota {
100         struct osd_object       *oiq_obj;
101         /* DMU accounting object id */
102         uint64_t                 oiq_oid;
103         /* ZAP cursor */
104         zap_cursor_t            *oiq_zc;
105         /** identifier for current quota record */
106         __u64                    oiq_id;
107         unsigned                 oiq_reset:1; /* 1 -- no need to advance */
108 };
109
110 /**
111  * Iterator's in-memory data structure for ZAPs
112  *
113  * ZFS does not store . and .. on a disk, instead they are
114  * generated up on request
115  * to follow this format we do the same
116  */
117 struct osd_zap_it {
118         zap_cursor_t            *ozi_zc;
119         struct osd_object       *ozi_obj;
120         unsigned                 ozi_reset:1;   /* 1 -- no need to advance */
121         /* ozi_pos - position of the cursor:
122          * 0 - before any record
123          * 1 - "."
124          * 2 - ".."
125          * 3 - real records */
126         unsigned                 ozi_pos:3;
127         union {
128                 char             ozi_name[MAXNAMELEN]; /* file name for dir */
129                 __u64            ozi_key; /* binary key for index files */
130         };
131 };
132 #define DT_IT2DT(it) (&((struct osd_zap_it *)it)->ozi_obj->oo_dt)
133
134 /*
135  * regular ZFS direntry
136  */
137 struct zpl_direntry {
138         uint64_t        zde_dnode:48,
139                         zde_pad:12,
140                         zde_type:4;
141 } __attribute__((packed));
142
143 /*
144  * lustre direntry adds a fid to regular ZFS direntry
145  */
146 struct luz_direntry {
147         struct zpl_direntry     lzd_reg;
148         struct lu_fid           lzd_fid;
149 } __attribute__((packed));
150
151
152 /* cached SA attributes */
153 struct osa_attr {
154         uint64_t        mode;
155         uint64_t        gid;
156         uint64_t        uid;
157         uint64_t        nlink;
158         uint64_t        rdev;
159         uint64_t        flags;
160         uint64_t        size;
161         uint64_t        atime[2];
162         uint64_t        mtime[2];
163         uint64_t        ctime[2];
164 };
165
166 struct osd_thread_info {
167         const struct lu_env     *oti_env;
168
169         struct lu_fid            oti_fid;
170         /*
171          * XXX temporary: for ->i_op calls.
172          */
173         struct timespec          oti_time;
174
175         struct ost_id            oti_ostid;
176
177         char                     oti_buf[64];
178
179         char                     oti_str[64];
180         union {
181                 char             oti_key[MAXNAMELEN + 1];
182                 __u64            oti_key64[(MAXNAMELEN + 1)/sizeof(__u64)];
183         };
184         struct lustre_mdt_attrs oti_mdt_attrs;
185
186         struct lu_attr           oti_la;
187         struct osa_attr          oti_osa;
188         zap_attribute_t          oti_za;
189         dmu_object_info_t        oti_doi;
190         struct luz_direntry      oti_zde;
191
192         struct lquota_id_info    oti_qi;
193         struct lu_seq_range      oti_seq_range;
194 };
195
196 extern struct lu_context_key osd_key;
197
198 static inline struct osd_thread_info *osd_oti_get(const struct lu_env *env)
199 {
200         return lu_context_key_get(&env->le_ctx, &osd_key);
201 }
202
203 struct osd_thandle {
204         struct thandle           ot_super;
205         struct list_head         ot_dcb_list;
206         struct list_head         ot_stop_dcb_list;
207         struct list_head         ot_unlinked_list;
208         struct list_head         ot_sa_list;
209         struct semaphore         ot_sa_lock;
210         dmu_tx_t                *ot_tx;
211         struct lquota_trans      ot_quota_trans;
212         __u32                    ot_write_commit:1,
213                                  ot_assigned:1;
214 };
215
216 #define OSD_OI_NAME_SIZE        16
217
218 /*
219  * Object Index (OI) instance.
220  */
221 struct osd_oi {
222         char                    oi_name[OSD_OI_NAME_SIZE]; /* unused */
223         uint64_t                oi_zapid;
224 };
225
226 struct osd_seq {
227         uint64_t         *os_compat_dirs;
228         int              os_subdir_count; /* subdir count for each seq */
229         u64              os_seq;          /* seq number */
230         struct list_head os_seq_list;     /* list to seq_list */
231 };
232
233 struct osd_seq_list {
234         rwlock_t         osl_seq_list_lock;     /* lock for seq_list */
235         struct list_head osl_seq_list;          /* list head for seq */
236         struct semaphore osl_seq_init_sem;
237 };
238
239 #define OSD_OST_MAP_SIZE        32
240
241 /*
242  * osd device.
243  */
244 struct osd_device {
245         /* super-class */
246         struct dt_device         od_dt_dev;
247         /* information about underlying file system */
248         struct objset           *od_os;
249         uint64_t                 od_rootid;  /* id of root znode */
250         uint64_t                 od_unlinkedid; /* id of unlinked zapobj */
251         /* SA attr mapping->id,
252          * name is the same as in ZFS to use defines SA_ZPL_...*/
253         sa_attr_type_t           *z_attr_table;
254
255         struct proc_dir_entry   *od_proc_entry;
256         struct lprocfs_stats    *od_stats;
257
258         uint64_t                 od_max_blksz;
259         uint64_t                 od_root;
260         uint64_t                 od_O_id;
261         struct osd_oi           **od_oi_table;
262         unsigned int             od_oi_count;
263         struct osd_seq_list     od_seq_list;
264
265         unsigned int             od_dev_set_rdonly:1, /**< osd_ro() called */
266                                  od_prop_rdonly:1,  /**< ZFS property readonly */
267                                  od_xattr_in_sa:1,
268                                  od_quota_iused_est:1,
269                                  od_is_ost:1,
270                                  od_posix_acl:1;
271
272         char                     od_mntdev[128];
273         char                     od_svname[128];
274
275         int                      od_connects;
276         struct lu_site           od_site;
277
278         /* object IDs of the inode accounting indexes */
279         uint64_t                 od_iusr_oid;
280         uint64_t                 od_igrp_oid;
281
282         /* quota slave instance */
283         struct qsd_instance     *od_quota_slave;
284
285         struct brw_stats        od_brw_stats;
286         atomic_t                od_r_in_flight;
287         atomic_t                od_w_in_flight;
288
289         /* used to debug zerocopy logic: the fields track all
290          * allocated, loaned and referenced buffers in use.
291          * to be removed once the change is tested well. */
292         atomic_t                 od_zerocopy_alloc;
293         atomic_t                 od_zerocopy_loan;
294         atomic_t                 od_zerocopy_pin;
295
296         arc_prune_t             *arc_prune_cb;
297
298         /* osd seq instance */
299         struct lu_client_seq    *od_cl_seq;
300 };
301
302 enum osd_destroy_type {
303         OSD_DESTROY_NONE = 0,
304         OSD_DESTROY_SYNC = 1,
305         OSD_DESTROY_ASYNC = 2,
306 };
307
308 struct osd_object {
309         struct dt_object         oo_dt;
310         /*
311          * Inode for file system object represented by this osd_object. This
312          * inode is pinned for the whole duration of lu_object life.
313          *
314          * Not modified concurrently (either setup early during object
315          * creation, or assigned by osd_object_create() under write lock).
316          */
317         dmu_buf_t               *oo_db;
318         sa_handle_t             *oo_sa_hdl;
319         nvlist_t                *oo_sa_xattr;
320         struct list_head         oo_sa_linkage;
321         struct list_head         oo_unlinked_linkage;
322
323         struct rw_semaphore      oo_sem;
324
325         /* cached attributes */
326         rwlock_t                 oo_attr_lock;
327         struct lu_attr           oo_attr;
328
329         /* protects extended attributes and oo_unlinked_linkage */
330         struct semaphore         oo_guard;
331         uint64_t                 oo_xattr;
332         enum osd_destroy_type    oo_destroy;
333
334         __u32                    oo_destroyed:1;
335
336         /* the i_flags in LMA */
337         __u32                    oo_lma_flags;
338         /* record size for index file */
339         unsigned char            oo_keysize;
340         unsigned char            oo_recsize;
341         unsigned char            oo_recusize;   /* unit size */
342 };
343
344 int osd_statfs(const struct lu_env *, struct dt_device *, struct obd_statfs *);
345 extern const struct dt_index_operations osd_acct_index_ops;
346 uint64_t osd_quota_fid2dmu(const struct lu_fid *fid);
347 extern struct lu_device_operations  osd_lu_ops;
348 extern struct dt_index_operations osd_dir_ops;
349 int osd_declare_quota(const struct lu_env *env, struct osd_device *osd,
350                       qid_t uid, qid_t gid, long long space,
351                       struct osd_thandle *oh, bool is_blk, int *flags,
352                       bool force);
353 uint64_t osd_objs_count_estimate(uint64_t refdbytes, uint64_t usedobjs,
354                                  uint64_t nrblocks, uint64_t est_maxblockshift);
355
356 /*
357  * Helpers.
358  */
359 static inline int lu_device_is_osd(const struct lu_device *d)
360 {
361         return ergo(d != NULL && d->ld_ops != NULL, d->ld_ops == &osd_lu_ops);
362 }
363
364 static inline struct osd_object *osd_obj(const struct lu_object *o)
365 {
366         LASSERT(lu_device_is_osd(o->lo_dev));
367         return container_of0(o, struct osd_object, oo_dt.do_lu);
368 }
369
370 static inline struct osd_device *osd_dt_dev(const struct dt_device *d)
371 {
372         LASSERT(lu_device_is_osd(&d->dd_lu_dev));
373         return container_of0(d, struct osd_device, od_dt_dev);
374 }
375
376 static inline struct osd_device *osd_dev(const struct lu_device *d)
377 {
378         LASSERT(lu_device_is_osd(d));
379         return osd_dt_dev(container_of0(d, struct dt_device, dd_lu_dev));
380 }
381
382 static inline struct osd_object *osd_dt_obj(const struct dt_object *d)
383 {
384         return osd_obj(&d->do_lu);
385 }
386
387 static inline struct osd_device *osd_obj2dev(const struct osd_object *o)
388 {
389         return osd_dev(o->oo_dt.do_lu.lo_dev);
390 }
391
392 static inline struct lu_device *osd2lu_dev(struct osd_device *osd)
393 {
394         return &osd->od_dt_dev.dd_lu_dev;
395 }
396
397 static inline struct objset * osd_dtobj2objset(struct dt_object *o)
398 {
399         return osd_dev(o->do_lu.lo_dev)->od_os;
400 }
401
402 static inline int osd_invariant(const struct osd_object *obj)
403 {
404         return 1;
405 }
406
407 static inline int osd_object_invariant(const struct lu_object *l)
408 {
409         return osd_invariant(osd_obj(l));
410 }
411
412 static inline struct seq_server_site *osd_seq_site(struct osd_device *osd)
413 {
414         return osd->od_dt_dev.dd_lu_dev.ld_site->ld_seq_site;
415 }
416
417 static inline char *osd_name(struct osd_device *osd)
418 {
419         return osd->od_dt_dev.dd_lu_dev.ld_obd->obd_name;
420 }
421
422 #ifdef CONFIG_PROC_FS
423 enum {
424         LPROC_OSD_READ_BYTES = 0,
425         LPROC_OSD_WRITE_BYTES = 1,
426         LPROC_OSD_GET_PAGE = 2,
427         LPROC_OSD_NO_PAGE = 3,
428         LPROC_OSD_CACHE_ACCESS = 4,
429         LPROC_OSD_CACHE_HIT = 5,
430         LPROC_OSD_CACHE_MISS = 6,
431         LPROC_OSD_COPY_IO = 7,
432         LPROC_OSD_ZEROCOPY_IO = 8,
433         LPROC_OSD_TAIL_IO = 9,
434         LPROC_OSD_LAST,
435 };
436
437 extern struct kmem_cache *osd_zapit_cachep;
438 /* osd_lproc.c */
439 extern struct lprocfs_vars lprocfs_osd_obd_vars[];
440
441 int osd_procfs_init(struct osd_device *osd, const char *name);
442 int osd_procfs_fini(struct osd_device *osd);
443
444 /* osd_object.c */
445 extern char *osd_obj_tag;
446 void osd_object_sa_dirty_rele(struct osd_thandle *oh);
447 int __osd_obj2dbuf(const struct lu_env *env, objset_t *os,
448                    uint64_t oid, dmu_buf_t **dbp);
449 struct lu_object *osd_object_alloc(const struct lu_env *env,
450                                    const struct lu_object_header *hdr,
451                                    struct lu_device *d);
452 int osd_object_sa_update(struct osd_object *obj, sa_attr_type_t type,
453                          void *buf, uint32_t buflen, struct osd_thandle *oh);
454 int __osd_zap_create(const struct lu_env *env, struct osd_device *osd,
455                      dmu_buf_t **zap_dbp, dmu_tx_t *tx, struct lu_attr *la,
456                      uint64_t parent, zap_flags_t flags);
457 int __osd_object_create(const struct lu_env *env, struct osd_object *obj,
458                         dmu_buf_t **dbp, dmu_tx_t *tx, struct lu_attr *la,
459                         uint64_t parent);
460
461 /* osd_oi.c */
462 int osd_oi_init(const struct lu_env *env, struct osd_device *o);
463 void osd_oi_fini(const struct lu_env *env, struct osd_device *o);
464 int osd_fid_lookup(const struct lu_env *env,
465                    struct osd_device *, const struct lu_fid *, uint64_t *);
466 uint64_t osd_get_name_n_idx(const struct lu_env *env, struct osd_device *osd,
467                             const struct lu_fid *fid, char *buf);
468 int osd_options_init(void);
469 int osd_ost_seq_exists(const struct lu_env *env, struct osd_device *osd,
470                        __u64 seq);
471 /* osd_index.c */
472 int osd_index_try(const struct lu_env *env, struct dt_object *dt,
473                   const struct dt_index_features *feat);
474 int osd_fld_lookup(const struct lu_env *env, struct osd_device *osd,
475                    u64 seq, struct lu_seq_range *range);
476 void osd_zap_cursor_init_serialized(zap_cursor_t *zc, struct objset *os,
477                                     uint64_t id, uint64_t dirhash);
478 int osd_zap_cursor_init(zap_cursor_t **zc, struct objset *os,
479                         uint64_t id, uint64_t dirhash);
480 void osd_zap_cursor_fini(zap_cursor_t *zc);
481 uint64_t osd_zap_cursor_serialize(zap_cursor_t *zc);
482
483 /* osd_xattr.c */
484 int __osd_xattr_load(struct osd_device *osd, uint64_t dnode,
485                      nvlist_t **sa_xattr);
486 int __osd_xattr_get_large(const struct lu_env *env, struct osd_device *osd,
487                           uint64_t xattr, struct lu_buf *buf,
488                           const char *name, int *sizep);
489 int osd_xattr_get(const struct lu_env *env, struct dt_object *dt,
490                   struct lu_buf *buf, const char *name);
491 int osd_declare_xattr_set(const struct lu_env *env, struct dt_object *dt,
492                           const struct lu_buf *buf, const char *name,
493                           int fl, struct thandle *handle);
494 int osd_xattr_set(const struct lu_env *env, struct dt_object *dt,
495                   const struct lu_buf *buf, const char *name, int fl,
496                   struct thandle *handle);
497 int osd_declare_xattr_del(const struct lu_env *env, struct dt_object *dt,
498                           const char *name, struct thandle *handle);
499 int osd_xattr_del(const struct lu_env *env, struct dt_object *dt,
500                   const char *name, struct thandle *handle);
501 void osd_declare_xattrs_destroy(const struct lu_env *env,
502                                 struct osd_object *obj,
503                                 struct osd_thandle *oh);
504 int osd_xattrs_destroy(const struct lu_env *env,
505                        struct osd_object *obj, struct osd_thandle *oh);
506 int osd_xattr_list(const struct lu_env *env, struct dt_object *dt,
507                    const struct lu_buf *lb);
508 void __osd_xattr_declare_set(const struct lu_env *env, struct osd_object *obj,
509                         int vallen, const char *name, struct osd_thandle *oh);
510 int __osd_sa_xattr_set(const struct lu_env *env, struct osd_object *obj,
511                        const struct lu_buf *buf, const char *name, int fl,
512                        struct osd_thandle *oh);;
513 int __osd_xattr_set(const struct lu_env *env, struct osd_object *obj,
514                     const struct lu_buf *buf, const char *name, int fl,
515                     struct osd_thandle *oh);
516 static inline int
517 osd_xattr_set_internal(const struct lu_env *env, struct osd_object *obj,
518                        const struct lu_buf *buf, const char *name, int fl,
519                        struct osd_thandle *oh)
520 {
521         int rc;
522
523         if (osd_obj2dev(obj)->od_xattr_in_sa) {
524                 rc = __osd_sa_xattr_set(env, obj, buf, name, fl, oh);
525                 if (rc == -EFBIG)
526                         rc = __osd_xattr_set(env, obj, buf, name, fl, oh);
527         } else {
528                 rc = __osd_xattr_set(env, obj, buf, name, fl, oh);
529         }
530
531         return rc;
532 }
533
534 static inline uint64_t attrs_fs2zfs(const uint32_t flags)
535 {
536         return (flags & LUSTRE_APPEND_FL        ? ZFS_APPENDONLY        : 0) |
537                 (flags & LUSTRE_NODUMP_FL       ? ZFS_NODUMP            : 0) |
538                 (flags & LUSTRE_IMMUTABLE_FL    ? ZFS_IMMUTABLE         : 0);
539 }
540
541 static inline uint32_t attrs_zfs2fs(const uint64_t flags)
542 {
543         return (flags & ZFS_APPENDONLY  ? LUSTRE_APPEND_FL      : 0) |
544                 (flags & ZFS_NODUMP     ? LUSTRE_NODUMP_FL      : 0) |
545                 (flags & ZFS_IMMUTABLE  ? LUSTRE_IMMUTABLE_FL   : 0);
546 }
547
548 #endif
549
550 #ifndef HAVE_DSL_POOL_CONFIG
551 static inline void dsl_pool_config_enter(dsl_pool_t *dp, char *name)
552 {
553 }
554
555 static inline void dsl_pool_config_exit(dsl_pool_t *dp, char *name)
556 {
557 }
558 #endif
559
560 #ifdef HAVE_SPA_MAXBLOCKSIZE
561 #define osd_spa_maxblocksize(spa)       spa_maxblocksize(spa)
562 #define osd_spa_maxblockshift(spa)      fls64(spa_maxblocksize(spa) - 1)
563 #else
564 #define osd_spa_maxblocksize(spa)       SPA_MAXBLOCKSIZE
565 #define osd_spa_maxblockshift(spa)      SPA_MAXBLOCKSHIFT
566 #define SPA_OLD_MAXBLOCKSIZE            SPA_MAXBLOCKSIZE
567 #endif
568
569 #ifdef HAVE_SA_SPILL_ALLOC
570 static inline void *
571 osd_zio_buf_alloc(size_t size)
572 {
573         return sa_spill_alloc(KM_SLEEP);
574 }
575
576 static inline void
577 osd_zio_buf_free(void *buf, size_t size)
578 {
579         sa_spill_free(buf);
580 }
581 #else
582 #define osd_zio_buf_alloc(size)         zio_buf_alloc(size)
583 #define osd_zio_buf_free(buf, size)     zio_buf_free(buf, size)
584 #endif
585
586 #endif /* _OSD_INTERNAL_H */