4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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
23 * Copyright (c) 2009, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2012, 2016, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
32 * lustre/osd-zfs/osd_handler.c
33 * Top-level entry points into osd module
35 * Author: Alex Zhuravlev <bzzz@whamcloud.com>
36 * Author: Mike Pershin <tappro@whamcloud.com>
37 * Author: Johann Lombardi <johann@whamcloud.com>
40 #define DEBUG_SUBSYSTEM S_OSD
42 #include <lustre_ver.h>
43 #include <libcfs/libcfs.h>
44 #include <obd_support.h>
45 #include <lustre_net.h>
47 #include <obd_class.h>
48 #include <lustre_disk.h>
49 #include <lustre_fid.h>
50 #include <uapi/linux/lustre_param.h>
51 #include <md_object.h>
53 #include "osd_internal.h"
55 #include <sys/dnode.h>
60 #include <sys/spa_impl.h>
61 #include <sys/zfs_znode.h>
62 #include <sys/dmu_tx.h>
63 #include <sys/dmu_objset.h>
64 #include <sys/dsl_prop.h>
65 #include <sys/sa_impl.h>
68 struct lu_context_key osd_key;
70 /* Slab for OSD object allocation */
71 struct kmem_cache *osd_object_kmem;
73 /* Slab to allocate osd_zap_it */
74 struct kmem_cache *osd_zapit_cachep;
76 static struct lu_kmem_descr osd_caches[] = {
78 .ckd_cache = &osd_object_kmem,
79 .ckd_name = "zfs_osd_obj",
80 .ckd_size = sizeof(struct osd_object)
83 .ckd_cache = &osd_zapit_cachep,
84 .ckd_name = "osd_zapit_cache",
85 .ckd_size = sizeof(struct osd_zap_it)
92 static void arc_prune_func(int64_t bytes, void *private)
94 struct osd_device *od = private;
95 struct lu_site *site = &od->od_site;
99 LASSERT(site->ls_obj_hash);
101 rc = lu_env_init(&env, LCT_SHRINKER);
103 CERROR("%s: can't initialize shrinker env: rc = %d\n",
108 lu_site_purge(&env, site, (bytes >> 10));
114 * Concurrency: doesn't access mutable data
116 static int osd_root_get(const struct lu_env *env,
117 struct dt_device *dev, struct lu_fid *f)
119 lu_local_obj_fid(f, OSD_FS_ROOT_OID);
124 * OSD object methods.
128 * Concurrency: shouldn't matter.
130 static void osd_trans_commit_cb(void *cb_data, int error)
132 struct osd_thandle *oh = cb_data;
133 struct thandle *th = &oh->ot_super;
134 struct osd_device *osd = osd_dt_dev(th->th_dev);
135 struct lu_device *lud = &th->th_dev->dd_lu_dev;
136 struct dt_txn_commit_cb *dcb, *tmp;
141 if (error == ECANCELED)
142 CWARN("%s: transaction @0x%p was aborted\n",
143 osd_dt_dev(th->th_dev)->od_svname, th);
145 CERROR("%s: transaction @0x%p commit error: rc = %d\n",
146 osd_dt_dev(th->th_dev)->od_svname, th, error);
149 dt_txn_hook_commit(th);
151 /* call per-transaction callbacks if any */
152 list_for_each_entry_safe(dcb, tmp, &oh->ot_dcb_list, dcb_linkage) {
153 LASSERTF(dcb->dcb_magic == TRANS_COMMIT_CB_MAGIC,
154 "commit callback entry: magic=%x name='%s'\n",
155 dcb->dcb_magic, dcb->dcb_name);
156 list_del_init(&dcb->dcb_linkage);
157 dcb->dcb_func(NULL, th, dcb, error);
160 /* Unlike ldiskfs, zfs updates space accounting at commit time.
161 * As a consequence, op_end is called only now to inform the quota slave
162 * component that reserved quota space is now accounted in usage and
163 * should be released. Quota space won't be adjusted at this point since
164 * we can't provide a suitable environment. It will be performed
165 * asynchronously by a lquota thread. */
166 qsd_op_end(NULL, osd->od_quota_slave, &oh->ot_quota_trans);
170 lu_context_exit(&th->th_ctx);
171 lu_context_fini(&th->th_ctx);
177 static int osd_trans_cb_add(struct thandle *th, struct dt_txn_commit_cb *dcb)
179 struct osd_thandle *oh = container_of0(th, struct osd_thandle,
182 LASSERT(dcb->dcb_magic == TRANS_COMMIT_CB_MAGIC);
183 LASSERT(&dcb->dcb_func != NULL);
184 if (dcb->dcb_flags & DCB_TRANS_STOP)
185 list_add(&dcb->dcb_linkage, &oh->ot_stop_dcb_list);
187 list_add(&dcb->dcb_linkage, &oh->ot_dcb_list);
193 * Concurrency: shouldn't matter.
195 static int osd_trans_start(const struct lu_env *env, struct dt_device *d,
198 struct osd_thandle *oh;
202 oh = container_of0(th, struct osd_thandle, ot_super);
206 rc = dt_txn_hook_start(env, d, th);
210 if (oh->ot_write_commit && OBD_FAIL_CHECK(OBD_FAIL_OST_MAPBLK_ENOSPC))
211 /* Unlike ldiskfs, ZFS checks for available space and returns
212 * -ENOSPC when assigning txg */
215 rc = -dmu_tx_assign(oh->ot_tx, TXG_WAIT);
216 if (unlikely(rc != 0)) {
217 struct osd_device *osd = osd_dt_dev(d);
218 /* dmu will call commit callback with error code during abort */
219 if (!lu_device_is_md(&d->dd_lu_dev) && rc == -ENOSPC)
220 CERROR("%s: failed to start transaction due to ENOSPC"
221 "\n", osd->od_svname);
223 CERROR("%s: can't assign tx: rc = %d\n",
226 /* add commit callback */
227 dmu_tx_callback_register(oh->ot_tx, osd_trans_commit_cb, oh);
229 lu_context_init(&th->th_ctx, th->th_tags);
230 lu_context_enter(&th->th_ctx);
231 lu_device_get(&d->dd_lu_dev);
237 static void osd_unlinked_list_emptify(const struct lu_env *env,
238 struct osd_device *osd,
239 struct list_head *list, bool free)
241 struct osd_object *obj;
244 while (!list_empty(list)) {
245 obj = list_entry(list->next,
246 struct osd_object, oo_unlinked_linkage);
247 LASSERT(obj->oo_dn != NULL);
248 oid = obj->oo_dn->dn_object;
250 list_del_init(&obj->oo_unlinked_linkage);
252 (void)osd_unlinked_object_free(env, osd, oid);
256 static void osd_trans_stop_cb(struct osd_thandle *oth, int result)
258 struct dt_txn_commit_cb *dcb;
259 struct dt_txn_commit_cb *tmp;
261 /* call per-transaction stop callbacks if any */
262 list_for_each_entry_safe(dcb, tmp, &oth->ot_stop_dcb_list,
264 LASSERTF(dcb->dcb_magic == TRANS_COMMIT_CB_MAGIC,
265 "commit callback entry: magic=%x name='%s'\n",
266 dcb->dcb_magic, dcb->dcb_name);
267 list_del_init(&dcb->dcb_linkage);
268 dcb->dcb_func(NULL, &oth->ot_super, dcb, result);
273 * Concurrency: shouldn't matter.
275 static int osd_trans_stop(const struct lu_env *env, struct dt_device *dt,
278 struct osd_device *osd = osd_dt_dev(th->th_dev);
279 bool sync = (th->th_sync != 0);
280 struct osd_thandle *oh;
281 struct list_head unlinked;
286 oh = container_of0(th, struct osd_thandle, ot_super);
287 INIT_LIST_HEAD(&unlinked);
288 list_splice_init(&oh->ot_unlinked_list, &unlinked);
289 /* reset OI cache for safety */
290 osd_oti_get(env)->oti_ins_cache_used = 0;
292 if (oh->ot_assigned == 0) {
294 dmu_tx_abort(oh->ot_tx);
295 osd_object_sa_dirty_rele(env, oh);
296 osd_unlinked_list_emptify(env, osd, &unlinked, false);
297 /* there won't be any commit, release reserved quota space now,
299 qsd_op_end(env, osd->od_quota_slave, &oh->ot_quota_trans);
304 rc = dt_txn_hook_stop(env, th);
306 CDEBUG(D_OTHER, "%s: transaction hook failed: rc = %d\n",
309 osd_trans_stop_cb(oh, rc);
312 txg = oh->ot_tx->tx_txg;
314 osd_object_sa_dirty_rele(env, oh);
315 /* XXX: Once dmu_tx_commit() called, oh/th could have been freed
316 * by osd_trans_commit_cb already. */
317 dmu_tx_commit(oh->ot_tx);
319 osd_unlinked_list_emptify(env, osd, &unlinked, true);
322 txg_wait_synced(dmu_objset_pool(osd->od_os), txg);
327 static struct thandle *osd_trans_create(const struct lu_env *env,
328 struct dt_device *dt)
330 struct osd_device *osd = osd_dt_dev(dt);
331 struct osd_thandle *oh;
337 CERROR("%s: someone try to start transaction under "
338 "readonly mode, should be disabled.\n",
339 osd_name(osd_dt_dev(dt)));
341 RETURN(ERR_PTR(-EROFS));
344 tx = dmu_tx_create(osd->od_os);
346 RETURN(ERR_PTR(-ENOMEM));
348 /* alloc callback data */
352 RETURN(ERR_PTR(-ENOMEM));
356 INIT_LIST_HEAD(&oh->ot_dcb_list);
357 INIT_LIST_HEAD(&oh->ot_stop_dcb_list);
358 INIT_LIST_HEAD(&oh->ot_unlinked_list);
359 INIT_LIST_HEAD(&oh->ot_sa_list);
360 memset(&oh->ot_quota_trans, 0, sizeof(oh->ot_quota_trans));
364 th->th_tags = LCT_TX_HANDLE;
368 /* Estimate the total number of objects from a number of blocks */
369 uint64_t osd_objs_count_estimate(uint64_t usedbytes, uint64_t usedobjs,
370 uint64_t nrblocks, uint64_t est_maxblockshift)
372 uint64_t est_totobjs, est_usedblocks, est_usedobjs;
375 * If blocksize is below 64KB (e.g. MDT with recordsize=4096) then
376 * bump the free dnode estimate to assume blocks at least 64KB in
377 * case of a directory-heavy MDT (at 32KB/directory).
379 if (est_maxblockshift < 16) {
380 nrblocks >>= (16 - est_maxblockshift);
381 est_maxblockshift = 16;
385 * Estimate the total number of dnodes from the total blocks count
386 * and the space used per dnode. Since we don't know the overhead
387 * associated with each dnode (xattrs, SAs, VDEV overhead, etc.)
388 * just using DNODE_SHIFT isn't going to give a good estimate.
389 * Instead, compute the current average space usage per dnode, with
390 * an upper and lower cap to avoid unrealistic estimates..
392 * In case there aren't many dnodes or blocks used yet, add a small
393 * correction factor (OSD_DNODE_EST_{COUNT,BLKSHIFT}). This factor
394 * gradually disappears as the number of real dnodes grows. It also
395 * avoids the need to check for divide-by-zero computing dn_per_block.
397 CLASSERT(OSD_DNODE_MIN_BLKSHIFT > 0);
398 CLASSERT(OSD_DNODE_EST_BLKSHIFT > 0);
400 est_usedblocks = ((OSD_DNODE_EST_COUNT << OSD_DNODE_EST_BLKSHIFT) +
401 usedbytes) >> est_maxblockshift;
402 est_usedobjs = OSD_DNODE_EST_COUNT + usedobjs;
404 if (est_usedobjs <= est_usedblocks) {
406 * Average space/dnode more than maximum block size, use max
407 * block size to estimate free dnodes from adjusted free blocks
408 * count. OSTs typically use multiple blocks per dnode so this
411 est_totobjs = nrblocks;
413 } else if (est_usedobjs >= (est_usedblocks << OSD_DNODE_MIN_BLKSHIFT)) {
415 * Average space/dnode smaller than min dnode size (probably
416 * due to metadnode compression), use min dnode size to
417 * estimate object count. MDTs may use only one block per node
418 * so this case applies.
420 est_totobjs = nrblocks << OSD_DNODE_MIN_BLKSHIFT;
424 * Between the extremes, use average space per existing dnode
425 * to compute the number of dnodes that will fit into nrblocks:
427 * est_totobjs = nrblocks * (est_usedobjs / est_usedblocks)
429 * this may overflow 64 bits or become 0 if not handled well.
431 * We know nrblocks is below 2^(64 - blkbits) bits, and
432 * est_usedobjs is under 48 bits due to DN_MAX_OBJECT_SHIFT,
433 * which means that multiplying them may get as large as
434 * 2 ^ 96 for the minimum blocksize of 64KB allowed above.
436 * The ratio of dnodes per block (est_usedobjs / est_usedblocks)
437 * is under 2^(blkbits - DNODE_SHIFT) = blocksize / 512 due to
438 * the limit checks above, so we can safely compute this first.
439 * We care more about accuracy on the MDT (many dnodes/block)
440 * which is good because this is where truncation errors are
441 * smallest. Since both nrblocks and dn_per_block are a
442 * function of blkbits, their product is at most:
444 * 2^(64 - blkbits) * 2^(blkbits - DNODE_SHIFT) = 2^(64 - 9)
446 * so we can safely use 7 bits to compute a fixed-point
447 * fraction and est_totobjs can still fit in 64 bits.
449 unsigned dn_per_block = (est_usedobjs << 7) / est_usedblocks;
451 est_totobjs = (nrblocks * dn_per_block) >> 7;
456 static int osd_objset_statfs(struct osd_device *osd, struct obd_statfs *osfs)
458 struct objset *os = osd->od_os;
459 uint64_t usedbytes, availbytes, usedobjs, availobjs;
460 uint64_t est_availobjs;
464 dmu_objset_space(os, &usedbytes, &availbytes, &usedobjs, &availobjs);
466 memset(osfs, 0, sizeof(*osfs));
468 /* We're a zfs filesystem. */
469 osfs->os_type = UBERBLOCK_MAGIC;
472 * ZFS allows multiple block sizes. For statfs, Linux makes no
473 * proper distinction between bsize and frsize. For calculations
474 * of free and used blocks incorrectly uses bsize instead of frsize,
475 * but bsize is also used as the optimal blocksize. We return the
476 * largest possible block size as IO size for the optimum performance
477 * and scale the free and used blocks count appropriately.
479 osfs->os_bsize = osd->od_max_blksz;
480 bshift = fls64(osfs->os_bsize) - 1;
482 osfs->os_blocks = (usedbytes + availbytes) >> bshift;
483 osfs->os_bfree = availbytes >> bshift;
484 osfs->os_bavail = osfs->os_bfree; /* no extra root reservation */
486 /* Take replication (i.e. number of copies) into account */
487 if (os->os_copies != 0)
488 osfs->os_bavail /= os->os_copies;
491 * Reserve some space so we don't run into ENOSPC due to grants not
492 * accounting for metadata overhead in ZFS, and to avoid fragmentation.
493 * Rather than report this via os_bavail (which makes users unhappy if
494 * they can't fill the filesystem 100%), reduce os_blocks as well.
496 * Reserve 0.78% of total space, at least 16MB for small filesystems,
497 * for internal files to be created/unlinked when space is tight.
499 CLASSERT(OSD_STATFS_RESERVED_SIZE > 0);
500 reserved = OSD_STATFS_RESERVED_SIZE >> bshift;
501 if (likely(osfs->os_blocks >= reserved << OSD_STATFS_RESERVED_SHIFT))
502 reserved = osfs->os_blocks >> OSD_STATFS_RESERVED_SHIFT;
504 osfs->os_blocks -= reserved;
505 osfs->os_bfree -= min(reserved, osfs->os_bfree);
506 osfs->os_bavail -= min(reserved, osfs->os_bavail);
509 * The availobjs value returned from dmu_objset_space() is largely
510 * useless, since it reports the number of objects that might
511 * theoretically still fit into the dataset, independent of minor
512 * issues like how much space is actually available in the pool.
513 * Compute a better estimate in udmu_objs_count_estimate().
515 est_availobjs = osd_objs_count_estimate(usedbytes, usedobjs,
516 osfs->os_bfree, bshift);
518 osfs->os_ffree = min(availobjs, est_availobjs);
519 osfs->os_files = osfs->os_ffree + usedobjs;
521 /* ZFS XXX: fill in backing dataset FSID/UUID
522 memcpy(osfs->os_fsid, .... );*/
524 osfs->os_namelen = MAXNAMELEN;
525 osfs->os_maxbytes = OBD_OBJECT_EOF;
527 if (!spa_writeable(dmu_objset_spa(os)) ||
528 osd->od_dev_set_rdonly || osd->od_prop_rdonly)
529 osfs->os_state |= OS_STATE_READONLY;
535 * Concurrency: shouldn't matter.
537 int osd_statfs(const struct lu_env *env, struct dt_device *d,
538 struct obd_statfs *osfs)
543 rc = osd_objset_statfs(osd_dt_dev(d), osfs);
544 if (unlikely(rc != 0))
547 osfs->os_bavail -= min_t(u64,
548 OSD_GRANT_FOR_LOCAL_OIDS / osfs->os_bsize,
553 static int osd_blk_insert_cost(struct osd_device *osd)
555 int max_blockshift, nr_blkptrshift, bshift;
557 /* max_blockshift is the log2 of the number of blocks needed to reach
558 * the maximum filesize (that's to say 2^64) */
559 bshift = osd_spa_maxblockshift(dmu_objset_spa(osd->od_os));
560 max_blockshift = DN_MAX_OFFSET_SHIFT - bshift;
562 /* nr_blkptrshift is the log2 of the number of block pointers that can
563 * be stored in an indirect block */
564 CLASSERT(DN_MAX_INDBLKSHIFT > SPA_BLKPTRSHIFT);
565 nr_blkptrshift = DN_MAX_INDBLKSHIFT - SPA_BLKPTRSHIFT;
567 /* max_blockshift / nr_blkptrshift is thus the maximum depth of the
568 * tree. We add +1 for rounding purpose.
569 * The tree depth times the indirect block size gives us the maximum
570 * cost of inserting a block in the tree */
571 return (max_blockshift / nr_blkptrshift + 1) * (1<<DN_MAX_INDBLKSHIFT);
575 * Concurrency: doesn't access mutable data.
577 static void osd_conf_get(const struct lu_env *env,
578 const struct dt_device *dev,
579 struct dt_device_param *param)
581 struct osd_device *osd = osd_dt_dev(dev);
584 * XXX should be taken from not-yet-existing fs abstraction layer.
586 param->ddp_max_name_len = MAXNAMELEN;
587 param->ddp_max_nlink = 1 << 31; /* it's 8byte on a disk */
588 param->ddp_symlink_max = PATH_MAX;
589 param->ddp_mount_type = LDD_MT_ZFS;
591 param->ddp_mntopts = MNTOPT_USERXATTR;
592 if (osd->od_posix_acl)
593 param->ddp_mntopts |= MNTOPT_ACL;
594 param->ddp_max_ea_size = DXATTR_MAX_ENTRY_SIZE;
596 /* for maxbytes, report same value as ZPL */
597 param->ddp_maxbytes = MAX_LFS_FILESIZE;
599 /* inodes are dynamically allocated, so we report the per-inode space
600 * consumption to upper layers. This static value is not really accurate
601 * and we should use the same logic as in udmu_objset_statfs() to
602 * estimate the real size consumed by an object */
603 param->ddp_inodespace = OSD_DNODE_EST_COUNT;
604 /* Although ZFS isn't an extent-based filesystem, the metadata overhead
605 * (i.e. 7 levels of indirect blocks, see osd_blk_insert_cost()) should
606 * not be accounted for every single new block insertion.
607 * Instead, the maximum extent size is set to the number of blocks that
608 * can fit into a single contiguous indirect block. There would be some
609 * cases where this crosses indirect blocks, but it also won't have 7
610 * new levels of indirect blocks in that case either, so it will still
611 * have enough reserved space for the extra indirect block */
612 param->ddp_max_extent_blks =
613 (1 << (DN_MAX_INDBLKSHIFT - SPA_BLKPTRSHIFT));
614 param->ddp_extent_tax = osd_blk_insert_cost(osd);
616 /* Preferred RPC size for efficient disk IO. 1MB shows good
617 * all-around performance for ZFS, but use blocksize (recordsize)
618 * by default if larger to avoid read-modify-write. */
619 if (osd->od_max_blksz > ONE_MB_BRW_SIZE)
620 param->ddp_brw_size = osd->od_max_blksz;
622 param->ddp_brw_size = ONE_MB_BRW_SIZE;
626 * Concurrency: shouldn't matter.
628 static int osd_sync(const struct lu_env *env, struct dt_device *d)
631 struct osd_device *osd = osd_dt_dev(d);
633 CDEBUG(D_CACHE, "syncing OSD %s\n", LUSTRE_OSD_ZFS_NAME);
634 txg_wait_synced(dmu_objset_pool(osd->od_os), 0ULL);
635 CDEBUG(D_CACHE, "synced OSD %s\n", LUSTRE_OSD_ZFS_NAME);
641 static int osd_commit_async(const struct lu_env *env, struct dt_device *dev)
643 struct osd_device *osd = osd_dt_dev(dev);
644 tx_state_t *tx = &dmu_objset_pool(osd->od_os)->dp_tx;
647 mutex_enter(&tx->tx_sync_lock);
648 txg = tx->tx_open_txg + 1;
649 if (tx->tx_quiesce_txg_waiting < txg) {
650 tx->tx_quiesce_txg_waiting = txg;
651 cv_broadcast(&tx->tx_quiesce_more_cv);
653 mutex_exit(&tx->tx_sync_lock);
659 * Concurrency: shouldn't matter.
661 static int osd_ro(const struct lu_env *env, struct dt_device *d)
663 struct osd_device *osd = osd_dt_dev(d);
666 CERROR("%s: *** setting device %s read-only ***\n",
667 osd->od_svname, LUSTRE_OSD_ZFS_NAME);
668 osd->od_dev_set_rdonly = 1;
669 spa_freeze(dmu_objset_spa(osd->od_os));
674 static struct dt_device_operations osd_dt_ops = {
675 .dt_root_get = osd_root_get,
676 .dt_statfs = osd_statfs,
677 .dt_trans_create = osd_trans_create,
678 .dt_trans_start = osd_trans_start,
679 .dt_trans_stop = osd_trans_stop,
680 .dt_trans_cb_add = osd_trans_cb_add,
681 .dt_conf_get = osd_conf_get,
683 .dt_commit_async = osd_commit_async,
688 * DMU OSD device type methods
690 static int osd_type_init(struct lu_device_type *t)
692 LU_CONTEXT_KEY_INIT(&osd_key);
693 return lu_context_key_register(&osd_key);
696 static void osd_type_fini(struct lu_device_type *t)
698 lu_context_key_degister(&osd_key);
701 static void *osd_key_init(const struct lu_context *ctx,
702 struct lu_context_key *key)
704 struct osd_thread_info *info;
708 info->oti_env = container_of(ctx, struct lu_env, le_ctx);
710 info = ERR_PTR(-ENOMEM);
714 static void osd_key_fini(const struct lu_context *ctx,
715 struct lu_context_key *key, void *data)
717 struct osd_thread_info *info = data;
718 struct osd_idmap_cache *idc = info->oti_ins_cache;
721 LASSERT(info->oti_ins_cache_size > 0);
722 OBD_FREE(idc, sizeof(*idc) * info->oti_ins_cache_size);
723 info->oti_ins_cache = NULL;
724 info->oti_ins_cache_size = 0;
726 lu_buf_free(&info->oti_xattr_lbuf);
730 static void osd_key_exit(const struct lu_context *ctx,
731 struct lu_context_key *key, void *data)
735 struct lu_context_key osd_key = {
736 .lct_tags = LCT_DT_THREAD | LCT_MD_THREAD | LCT_MG_THREAD | LCT_LOCAL,
737 .lct_init = osd_key_init,
738 .lct_fini = osd_key_fini,
739 .lct_exit = osd_key_exit
742 static void osd_fid_fini(const struct lu_env *env, struct osd_device *osd)
744 if (osd->od_cl_seq == NULL)
747 seq_client_fini(osd->od_cl_seq);
748 OBD_FREE_PTR(osd->od_cl_seq);
749 osd->od_cl_seq = NULL;
752 static int osd_shutdown(const struct lu_env *env, struct osd_device *o)
756 /* shutdown quota slave instance associated with the device */
757 if (o->od_quota_slave != NULL) {
758 /* complete all in-flight callbacks */
759 osd_sync(env, &o->od_dt_dev);
760 txg_wait_callbacks(spa_get_dsl(dmu_objset_spa(o->od_os)));
761 qsd_fini(env, o->od_quota_slave);
762 o->od_quota_slave = NULL;
765 osd_fid_fini(env, o);
770 static void osd_xattr_changed_cb(void *arg, uint64_t newval)
772 struct osd_device *osd = arg;
774 osd->od_xattr_in_sa = (newval == ZFS_XATTR_SA);
777 static void osd_recordsize_changed_cb(void *arg, uint64_t newval)
779 struct osd_device *osd = arg;
781 LASSERT(newval <= osd_spa_maxblocksize(dmu_objset_spa(osd->od_os)));
782 LASSERT(newval >= SPA_MINBLOCKSIZE);
783 LASSERT(ISP2(newval));
785 osd->od_max_blksz = newval;
788 static void osd_readonly_changed_cb(void *arg, uint64_t newval)
790 struct osd_device *osd = arg;
792 osd->od_prop_rdonly = !!newval;
795 static void osd_dnodesize_changed_cb(void *arg, uint64_t newval)
797 struct osd_device *osd = arg;
799 osd->od_dnsize = newval;
803 * This function unregisters all registered callbacks. It's harmless to
804 * unregister callbacks that were never registered so it is used to safely
805 * unwind a partially completed call to osd_objset_register_callbacks().
807 static void osd_objset_unregister_callbacks(struct osd_device *o)
809 struct dsl_dataset *ds = dmu_objset_ds(o->od_os);
811 (void) dsl_prop_unregister(ds, zfs_prop_to_name(ZFS_PROP_XATTR),
812 osd_xattr_changed_cb, o);
813 (void) dsl_prop_unregister(ds, zfs_prop_to_name(ZFS_PROP_RECORDSIZE),
814 osd_recordsize_changed_cb, o);
815 (void) dsl_prop_unregister(ds, zfs_prop_to_name(ZFS_PROP_READONLY),
816 osd_readonly_changed_cb, o);
817 (void) dsl_prop_unregister(ds, zfs_prop_to_name(ZFS_PROP_DNODESIZE),
818 osd_readonly_changed_cb, o);
820 if (o->arc_prune_cb != NULL) {
821 arc_remove_prune_callback(o->arc_prune_cb);
822 o->arc_prune_cb = NULL;
827 * Register the required callbacks to be notified when zfs properties
828 * are modified using the 'zfs(8)' command line utility.
830 static int osd_objset_register_callbacks(struct osd_device *o)
832 struct dsl_dataset *ds = dmu_objset_ds(o->od_os);
833 dsl_pool_t *dp = dmu_objset_pool(o->od_os);
839 dsl_pool_config_enter(dp, FTAG);
840 rc = -dsl_prop_register(ds, zfs_prop_to_name(ZFS_PROP_XATTR),
841 osd_xattr_changed_cb, o);
845 rc = -dsl_prop_register(ds, zfs_prop_to_name(ZFS_PROP_RECORDSIZE),
846 osd_recordsize_changed_cb, o);
850 rc = -dsl_prop_register(ds, zfs_prop_to_name(ZFS_PROP_READONLY),
851 osd_readonly_changed_cb, o);
855 rc = -dsl_prop_register(ds, zfs_prop_to_name(ZFS_PROP_DNODESIZE),
856 osd_dnodesize_changed_cb, o);
860 o->arc_prune_cb = arc_add_prune_callback(arc_prune_func, o);
862 dsl_pool_config_exit(dp, FTAG);
864 osd_objset_unregister_callbacks(o);
869 static int osd_objset_open(struct osd_device *o)
871 uint64_t version = ZPL_VERSION;
872 uint64_t sa_obj, unlink_obj;
876 rc = -osd_dmu_objset_own(o->od_mntdev, DMU_OST_ZFS,
877 o->od_dt_dev.dd_rdonly ? B_TRUE : B_FALSE,
878 B_FALSE, o, &o->od_os);
881 CERROR("%s: can't open %s\n", o->od_svname, o->od_mntdev);
887 /* Check ZFS version */
888 rc = -zap_lookup(o->od_os, MASTER_NODE_OBJ,
889 ZPL_VERSION_STR, 8, 1, &version);
891 CERROR("%s: Error looking up ZPL VERSION\n", o->od_mntdev);
893 * We can't return ENOENT because that would mean the objset
896 GOTO(out, rc = -EIO);
899 rc = -zap_lookup(o->od_os, MASTER_NODE_OBJ,
900 ZFS_SA_ATTRS, 8, 1, &sa_obj);
904 rc = -sa_setup(o->od_os, sa_obj, zfs_attr_table,
905 ZPL_END, &o->z_attr_table);
909 rc = -zap_lookup(o->od_os, MASTER_NODE_OBJ, ZFS_ROOT_OBJ,
910 8, 1, &o->od_rootid);
912 CERROR("%s: lookup for root failed: rc = %d\n",
917 rc = -zap_lookup(o->od_os, MASTER_NODE_OBJ, ZFS_UNLINKED_SET,
920 CERROR("%s: lookup for %s failed: rc = %d\n",
921 o->od_svname, ZFS_UNLINKED_SET, rc);
925 /* Check that user/group usage tracking is supported */
926 if (!dmu_objset_userused_enabled(o->od_os) ||
927 DMU_USERUSED_DNODE(o->od_os)->dn_type != DMU_OT_USERGROUP_USED ||
928 DMU_GROUPUSED_DNODE(o->od_os)->dn_type != DMU_OT_USERGROUP_USED) {
929 CERROR("%s: Space accounting not supported by this target, "
930 "aborting\n", o->od_svname);
931 GOTO(out, rc = -ENOTSUPP);
934 rc = __osd_obj2dnode(o->od_os, unlink_obj, &o->od_unlinked);
936 CERROR("%s: can't get dnode for unlinked: rc = %d\n",
942 if (rc != 0 && o->od_os != NULL) {
943 osd_dmu_objset_disown(o->od_os, B_FALSE, o);
950 int osd_unlinked_object_free(const struct lu_env *env, struct osd_device *osd,
953 char *key = osd_oti_get(env)->oti_str;
957 if (osd->od_dt_dev.dd_rdonly) {
958 CERROR("%s: someone try to free objects under "
959 "readonly mode, should be disabled.\n", osd_name(osd));
965 rc = -dmu_free_long_range(osd->od_os, oid, 0, DMU_OBJECT_END);
967 CWARN("%s: Cannot truncate %llu: rc = %d\n",
968 osd->od_svname, oid, rc);
972 tx = dmu_tx_create(osd->od_os);
973 dmu_tx_hold_free(tx, oid, 0, DMU_OBJECT_END);
974 osd_tx_hold_zap(tx, osd->od_unlinked->dn_object, osd->od_unlinked,
976 rc = -dmu_tx_assign(tx, TXG_WAIT);
978 CWARN("%s: Cannot assign tx for %llu: rc = %d\n",
979 osd->od_svname, oid, rc);
983 snprintf(key, sizeof(osd_oti_get(env)->oti_str), "%llx", oid);
984 rc = osd_zap_remove(osd, osd->od_unlinked->dn_object,
985 osd->od_unlinked, key, tx);
987 CWARN("%s: Cannot remove %llu from unlinked set: rc = %d\n",
988 osd->od_svname, oid, rc);
992 rc = -dmu_object_free(osd->od_os, oid, tx);
994 CWARN("%s: Cannot free %llu: rc = %d\n",
995 osd->od_svname, oid, rc);
1010 osd_unlinked_drain(const struct lu_env *env, struct osd_device *osd)
1013 zap_attribute_t *za = &osd_oti_get(env)->oti_za;
1015 zap_cursor_init(&zc, osd->od_os, osd->od_unlinked->dn_object);
1017 while (zap_cursor_retrieve(&zc, za) == 0) {
1018 /* If cannot free the object, leave it in the unlinked set,
1019 * until the OSD is mounted again when obd_unlinked_drain()
1020 * will be called. */
1021 if (osd_unlinked_object_free(env, osd, za->za_first_integer))
1023 zap_cursor_advance(&zc);
1026 zap_cursor_fini(&zc);
1029 static int osd_mount(const struct lu_env *env,
1030 struct osd_device *o, struct lustre_cfg *cfg)
1032 char *mntdev = lustre_cfg_string(cfg, 1);
1033 char *str = lustre_cfg_string(cfg, 2);
1034 char *svname = lustre_cfg_string(cfg, 4);
1040 if (o->od_os != NULL)
1043 if (mntdev == NULL || svname == NULL)
1046 rc = strlcpy(o->od_mntdev, mntdev, sizeof(o->od_mntdev));
1047 if (rc >= sizeof(o->od_mntdev))
1050 rc = strlcpy(o->od_svname, svname, sizeof(o->od_svname));
1051 if (rc >= sizeof(o->od_svname))
1054 str = strstr(str, ":");
1056 unsigned long flags;
1058 rc = kstrtoul(str + 1, 10, &flags);
1062 if (flags & LMD_FLG_DEV_RDONLY) {
1063 o->od_dt_dev.dd_rdonly = 1;
1064 LCONSOLE_WARN("%s: set dev_rdonly on this device\n",
1069 if (server_name_is_ost(o->od_svname))
1072 rc = osd_objset_open(o);
1076 o->od_xattr_in_sa = B_TRUE;
1077 o->od_max_blksz = osd_spa_maxblocksize(o->od_os->os_spa);
1079 rc = __osd_obj2dnode(o->od_os, o->od_rootid, &rootdn);
1082 o->od_root = rootdn->dn_object;
1083 osd_dnode_rele(rootdn);
1085 rc = __osd_obj2dnode(o->od_os, DMU_USERUSED_OBJECT,
1086 &o->od_userused_dn);
1090 rc = __osd_obj2dnode(o->od_os, DMU_GROUPUSED_OBJECT,
1091 &o->od_groupused_dn);
1095 #ifdef ZFS_PROJINHERIT
1096 if (dmu_objset_projectquota_enabled(o->od_os)) {
1097 rc = __osd_obj2dnode(o->od_os, DMU_PROJECTUSED_OBJECT,
1098 &o->od_projectused_dn);
1099 if (rc && rc != -ENOENT)
1104 /* 1. initialize oi before any file create or file open */
1105 rc = osd_oi_init(env, o);
1109 rc = lu_site_init(&o->od_site, osd2lu_dev(o));
1112 o->od_site.ls_bottom_dev = osd2lu_dev(o);
1114 rc = lu_site_init_finish(&o->od_site);
1118 rc = osd_objset_register_callbacks(o);
1122 rc = osd_procfs_init(o, o->od_svname);
1126 /* initialize quota slave instance */
1127 o->od_quota_slave = qsd_init(env, o->od_svname, &o->od_dt_dev,
1129 if (IS_ERR(o->od_quota_slave)) {
1130 rc = PTR_ERR(o->od_quota_slave);
1131 o->od_quota_slave = NULL;
1135 #ifdef HAVE_DMU_USEROBJ_ACCOUNTING
1136 if (!osd_dmu_userobj_accounting_available(o))
1137 CWARN("%s: dnode accounting not enabled: "
1138 "enable feature@userobj_accounting in pool\n",
1142 /* parse mount option "noacl", and enable ACL by default */
1143 opts = lustre_cfg_string(cfg, 3);
1144 if (opts == NULL || strstr(opts, "noacl") == NULL)
1145 o->od_posix_acl = 1;
1147 osd_unlinked_drain(env, o);
1149 if (rc && o->od_os) {
1150 osd_dmu_objset_disown(o->od_os, B_FALSE, o);
1157 static void osd_umount(const struct lu_env *env, struct osd_device *o)
1161 if (atomic_read(&o->od_zerocopy_alloc))
1162 CERROR("%s: lost %d allocated page(s)\n", o->od_svname,
1163 atomic_read(&o->od_zerocopy_alloc));
1164 if (atomic_read(&o->od_zerocopy_loan))
1165 CERROR("%s: lost %d loaned abuf(s)\n", o->od_svname,
1166 atomic_read(&o->od_zerocopy_loan));
1167 if (atomic_read(&o->od_zerocopy_pin))
1168 CERROR("%s: lost %d pinned dbuf(s)\n", o->od_svname,
1169 atomic_read(&o->od_zerocopy_pin));
1171 if (o->od_unlinked) {
1172 osd_dnode_rele(o->od_unlinked);
1173 o->od_unlinked = NULL;
1175 if (o->od_userused_dn) {
1176 osd_dnode_rele(o->od_userused_dn);
1177 o->od_userused_dn = NULL;
1179 if (o->od_groupused_dn) {
1180 osd_dnode_rele(o->od_groupused_dn);
1181 o->od_groupused_dn = NULL;
1184 #ifdef ZFS_PROJINHERIT
1185 if (o->od_projectused_dn) {
1186 osd_dnode_rele(o->od_projectused_dn);
1187 o->od_projectused_dn = NULL;
1191 if (o->od_os != NULL) {
1192 if (!o->od_dt_dev.dd_rdonly)
1193 /* force a txg sync to get all commit callbacks */
1194 txg_wait_synced(dmu_objset_pool(o->od_os), 0ULL);
1196 /* close the object set */
1197 osd_dmu_objset_disown(o->od_os, B_FALSE, o);
1204 static int osd_device_init0(const struct lu_env *env,
1205 struct osd_device *o,
1206 struct lustre_cfg *cfg)
1208 struct lu_device *l = osd2lu_dev(o);
1211 /* if the module was re-loaded, env can loose its keys */
1212 rc = lu_env_refill((struct lu_env *) env);
1216 l->ld_ops = &osd_lu_ops;
1217 o->od_dt_dev.dd_ops = &osd_dt_ops;
1223 static struct lu_device *osd_device_fini(const struct lu_env *env,
1224 struct lu_device *dev);
1226 static struct lu_device *osd_device_alloc(const struct lu_env *env,
1227 struct lu_device_type *type,
1228 struct lustre_cfg *cfg)
1230 struct osd_device *dev;
1231 struct osd_seq_list *osl;
1236 return ERR_PTR(-ENOMEM);
1238 osl = &dev->od_seq_list;
1239 INIT_LIST_HEAD(&osl->osl_seq_list);
1240 rwlock_init(&osl->osl_seq_list_lock);
1241 sema_init(&osl->osl_seq_init_sem, 1);
1243 rc = dt_device_init(&dev->od_dt_dev, type);
1245 rc = osd_device_init0(env, dev, cfg);
1247 rc = osd_mount(env, dev, cfg);
1249 osd_device_fini(env, osd2lu_dev(dev));
1252 dt_device_fini(&dev->od_dt_dev);
1255 if (unlikely(rc != 0))
1258 return rc == 0 ? osd2lu_dev(dev) : ERR_PTR(rc);
1261 static struct lu_device *osd_device_free(const struct lu_env *env,
1262 struct lu_device *d)
1264 struct osd_device *o = osd_dev(d);
1267 /* XXX: make osd top device in order to release reference */
1268 d->ld_site->ls_top_dev = d;
1269 lu_site_purge(env, d->ld_site, -1);
1270 if (!cfs_hash_is_empty(d->ld_site->ls_obj_hash)) {
1271 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_ERROR, NULL);
1272 lu_site_print(env, d->ld_site, &msgdata, lu_cdebug_printer);
1274 lu_site_fini(&o->od_site);
1275 dt_device_fini(&o->od_dt_dev);
1281 static struct lu_device *osd_device_fini(const struct lu_env *env,
1282 struct lu_device *d)
1284 struct osd_device *o = osd_dev(d);
1290 osd_objset_unregister_callbacks(o);
1291 if (!o->od_dt_dev.dd_rdonly) {
1292 osd_sync(env, lu2dt_dev(d));
1294 spa_get_dsl(dmu_objset_spa(o->od_os)));
1298 /* now with all the callbacks completed we can cleanup the remainings */
1299 osd_shutdown(env, o);
1300 osd_oi_fini(env, o);
1302 rc = osd_procfs_fini(o);
1304 CERROR("proc fini error %d\n", rc);
1305 RETURN(ERR_PTR(rc));
1314 static int osd_device_init(const struct lu_env *env, struct lu_device *d,
1315 const char *name, struct lu_device *next)
1321 * To be removed, setup is performed by osd_device_{init,alloc} and
1322 * cleanup is performed by osd_device_{fini,free).
1324 static int osd_process_config(const struct lu_env *env,
1325 struct lu_device *d, struct lustre_cfg *cfg)
1327 struct osd_device *o = osd_dev(d);
1331 switch(cfg->lcfg_command) {
1333 rc = osd_mount(env, o, cfg);
1336 rc = osd_shutdown(env, o);
1339 LASSERT(&o->od_dt_dev);
1340 rc = class_process_proc_param(PARAM_OSD, lprocfs_osd_obd_vars,
1341 cfg, &o->od_dt_dev);
1342 if (rc > 0 || rc == -ENOSYS) {
1343 rc = class_process_proc_param(PARAM_OST,
1344 lprocfs_osd_obd_vars,
1345 cfg, &o->od_dt_dev);
1358 static int osd_recovery_complete(const struct lu_env *env, struct lu_device *d)
1360 struct osd_device *osd = osd_dev(d);
1364 if (osd->od_quota_slave == NULL)
1367 /* start qsd instance on recovery completion, this notifies the quota
1368 * slave code that we are about to process new requests now */
1369 rc = qsd_start(env, osd->od_quota_slave);
1374 * we use exports to track all osd users
1376 static int osd_obd_connect(const struct lu_env *env, struct obd_export **exp,
1377 struct obd_device *obd, struct obd_uuid *cluuid,
1378 struct obd_connect_data *data, void *localdata)
1380 struct osd_device *osd = osd_dev(obd->obd_lu_dev);
1381 struct lustre_handle conn;
1385 CDEBUG(D_CONFIG, "connect #%d\n", osd->od_connects);
1387 rc = class_connect(&conn, obd, cluuid);
1391 *exp = class_conn2export(&conn);
1393 spin_lock(&obd->obd_dev_lock);
1395 spin_unlock(&obd->obd_dev_lock);
1401 * once last export (we don't count self-export) disappeared
1402 * osd can be released
1404 static int osd_obd_disconnect(struct obd_export *exp)
1406 struct obd_device *obd = exp->exp_obd;
1407 struct osd_device *osd = osd_dev(obd->obd_lu_dev);
1408 int rc, release = 0;
1411 /* Only disconnect the underlying layers on the final disconnect. */
1412 spin_lock(&obd->obd_dev_lock);
1414 if (osd->od_connects == 0)
1416 spin_unlock(&obd->obd_dev_lock);
1418 rc = class_disconnect(exp); /* bz 9811 */
1420 if (rc == 0 && release)
1421 class_manual_cleanup(obd);
1425 static int osd_fid_init(const struct lu_env *env, struct osd_device *osd)
1427 struct seq_server_site *ss = osd_seq_site(osd);
1431 if (osd->od_is_ost || osd->od_cl_seq != NULL)
1434 if (unlikely(ss == NULL))
1437 OBD_ALLOC_PTR(osd->od_cl_seq);
1438 if (osd->od_cl_seq == NULL)
1441 rc = seq_client_init(osd->od_cl_seq, NULL, LUSTRE_SEQ_METADATA,
1442 osd->od_svname, ss->ss_server_seq);
1445 OBD_FREE_PTR(osd->od_cl_seq);
1446 osd->od_cl_seq = NULL;
1452 static int osd_prepare(const struct lu_env *env, struct lu_device *pdev,
1453 struct lu_device *dev)
1455 struct osd_device *osd = osd_dev(dev);
1459 if (osd->od_quota_slave != NULL) {
1460 /* set up quota slave objects */
1461 rc = qsd_prepare(env, osd->od_quota_slave);
1466 rc = osd_fid_init(env, osd);
1471 struct lu_device_operations osd_lu_ops = {
1472 .ldo_object_alloc = osd_object_alloc,
1473 .ldo_process_config = osd_process_config,
1474 .ldo_recovery_complete = osd_recovery_complete,
1475 .ldo_prepare = osd_prepare,
1478 static void osd_type_start(struct lu_device_type *t)
1482 static void osd_type_stop(struct lu_device_type *t)
1486 int osd_fid_alloc(const struct lu_env *env, struct obd_export *exp,
1487 struct lu_fid *fid, struct md_op_data *op_data)
1489 struct osd_device *osd = osd_dev(exp->exp_obd->obd_lu_dev);
1491 return seq_client_alloc_fid(env, osd->od_cl_seq, fid);
1494 static struct lu_device_type_operations osd_device_type_ops = {
1495 .ldto_init = osd_type_init,
1496 .ldto_fini = osd_type_fini,
1498 .ldto_start = osd_type_start,
1499 .ldto_stop = osd_type_stop,
1501 .ldto_device_alloc = osd_device_alloc,
1502 .ldto_device_free = osd_device_free,
1504 .ldto_device_init = osd_device_init,
1505 .ldto_device_fini = osd_device_fini
1508 static struct lu_device_type osd_device_type = {
1509 .ldt_tags = LU_DEVICE_DT,
1510 .ldt_name = LUSTRE_OSD_ZFS_NAME,
1511 .ldt_ops = &osd_device_type_ops,
1512 .ldt_ctx_tags = LCT_LOCAL
1516 static struct obd_ops osd_obd_device_ops = {
1517 .o_owner = THIS_MODULE,
1518 .o_connect = osd_obd_connect,
1519 .o_disconnect = osd_obd_disconnect,
1520 .o_fid_alloc = osd_fid_alloc
1523 static int __init osd_init(void)
1527 rc = osd_options_init();
1531 rc = lu_kmem_init(osd_caches);
1535 rc = class_register_type(&osd_obd_device_ops, NULL, true, NULL,
1536 LUSTRE_OSD_ZFS_NAME, &osd_device_type);
1538 lu_kmem_fini(osd_caches);
1542 static void __exit osd_exit(void)
1544 class_unregister_type(LUSTRE_OSD_ZFS_NAME);
1545 lu_kmem_fini(osd_caches);
1548 extern unsigned int osd_oi_count;
1549 module_param(osd_oi_count, int, 0444);
1550 MODULE_PARM_DESC(osd_oi_count, "Number of Object Index containers to be created, it's only valid for new filesystem.");
1552 MODULE_AUTHOR("OpenSFS, Inc. <http://www.lustre.org/>");
1553 MODULE_DESCRIPTION("Lustre Object Storage Device ("LUSTRE_OSD_ZFS_NAME")");
1554 MODULE_VERSION(LUSTRE_VERSION_STRING);
1555 MODULE_LICENSE("GPL");
1557 module_init(osd_init);
1558 module_exit(osd_exit);