lustre/osd-zfs/osd_handler.c

   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, 2014, 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_handler.c
  37  * Top-level entry points into osd module
  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 #define DEBUG_SUBSYSTEM S_OSD
  45
  46 #include <lustre_ver.h>
  47 #include <libcfs/libcfs.h>
  48 #include <obd_support.h>
  49 #include <lustre_net.h>
  50 #include <obd.h>
  51 #include <obd_class.h>
  52 #include <lustre_disk.h>
  53 #include <lustre_fid.h>
  54 #include <lustre_param.h>
  55 #include <md_object.h>
  56
  57 #include "osd_internal.h"
  58
  59 #include <sys/dnode.h>
  60 #include <sys/dbuf.h>
  61 #include <sys/spa.h>
  62 #include <sys/stat.h>
  63 #include <sys/zap.h>
  64 #include <sys/spa_impl.h>
  65 #include <sys/zfs_znode.h>
  66 #include <sys/dmu_tx.h>
  67 #include <sys/dmu_objset.h>
  68 #include <sys/dsl_prop.h>
  69 #include <sys/sa_impl.h>
  70 #include <sys/txg.h>
  71
  72 struct lu_context_key   osd_key;
  73
  74 /* Slab for OSD object allocation */
  75 struct kmem_cache *osd_object_kmem;
  76
  77 /* Slab to allocate osd_zap_it */
  78 struct kmem_cache *osd_zapit_cachep;
  79
  80 static struct lu_kmem_descr osd_caches[] = {
  81         {
  82                 .ckd_cache = &osd_object_kmem,
  83                 .ckd_name  = "zfs_osd_obj",
  84                 .ckd_size  = sizeof(struct osd_object)
  85         },
  86         {
  87                 .ckd_cache = &osd_zapit_cachep,
  88                 .ckd_name  = "osd_zapit_cache",
  89                 .ckd_size  = sizeof(struct osd_zap_it)
  90         },
  91         {
  92                 .ckd_cache = NULL
  93         }
  94 };
  95
  96 static void arc_prune_func(int64_t bytes, void *private)
  97 {
  98         struct osd_device *od = private;
  99         struct lu_site    *site = &od->od_site;
 100         struct lu_env      env;
 101         int rc;
 102
 103         rc = lu_env_init(&env, LCT_SHRINKER);
 104         if (rc) {
 105                 CERROR("%s: can't initialize shrinker env: rc = %d\n",
 106                        od->od_svname, rc);
 107                 return;
 108         }
 109
 110         lu_site_purge(&env, site, (bytes >> 10));
 111
 112         lu_env_fini(&env);
 113 }
 114
 115 /*
 116  * Concurrency: doesn't access mutable data
 117  */
 118 static int osd_root_get(const struct lu_env *env,
 119                         struct dt_device *dev, struct lu_fid *f)
 120 {
 121         lu_local_obj_fid(f, OSD_FS_ROOT_OID);
 122         return 0;
 123 }
 124
 125 /*
 126  * OSD object methods.
 127  */
 128
 129 /*
 130  * Concurrency: shouldn't matter.
 131  */
 132 static void osd_trans_commit_cb(void *cb_data, int error)
 133 {
 134         struct osd_thandle      *oh = cb_data;
 135         struct thandle          *th = &oh->ot_super;
 136         struct osd_device       *osd = osd_dt_dev(th->th_dev);
 137         struct lu_device        *lud = &th->th_dev->dd_lu_dev;
 138         struct dt_txn_commit_cb *dcb, *tmp;
 139
 140         ENTRY;
 141
 142         if (error) {
 143                 if (error == ECANCELED)
 144                         CWARN("%s: transaction @0x%p was aborted\n",
 145                               osd_dt_dev(th->th_dev)->od_svname, th);
 146                 else
 147                         CERROR("%s: transaction @0x%p commit error: rc = %d\n",
 148                                 osd_dt_dev(th->th_dev)->od_svname, th, error);
 149         }
 150
 151         dt_txn_hook_commit(th);
 152
 153         /* call per-transaction callbacks if any */
 154         list_for_each_entry_safe(dcb, tmp, &oh->ot_dcb_list, dcb_linkage)
 155                 dcb->dcb_func(NULL, th, dcb, error);
 156
 157         /* Unlike ldiskfs, zfs updates space accounting at commit time.
 158          * As a consequence, op_end is called only now to inform the quota slave
 159          * component that reserved quota space is now accounted in usage and
 160          * should be released. Quota space won't be adjusted at this point since
 161          * we can't provide a suitable environment. It will be performed
 162          * asynchronously by a lquota thread. */
 163         qsd_op_end(NULL, osd->od_quota_slave, &oh->ot_quota_trans);
 164
 165         lu_device_put(lud);
 166         th->th_dev = NULL;
 167         lu_context_exit(&th->th_ctx);
 168         lu_context_fini(&th->th_ctx);
 169         thandle_put(&oh->ot_super);
 170
 171         EXIT;
 172 }
 173
 174 static int osd_trans_cb_add(struct thandle *th, struct dt_txn_commit_cb *dcb)
 175 {
 176         struct osd_thandle *oh;
 177
 178         oh = container_of0(th, struct osd_thandle, ot_super);
 179         list_add(&dcb->dcb_linkage, &oh->ot_dcb_list);
 180
 181         return 0;
 182 }
 183
 184 /*
 185  * Concurrency: shouldn't matter.
 186  */
 187 static int osd_trans_start(const struct lu_env *env, struct dt_device *d,
 188                            struct thandle *th)
 189 {
 190         struct osd_thandle      *oh;
 191         int                     rc;
 192         ENTRY;
 193
 194         oh = container_of0(th, struct osd_thandle, ot_super);
 195         LASSERT(oh);
 196         LASSERT(oh->ot_tx);
 197
 198         rc = dt_txn_hook_start(env, d, th);
 199         if (rc != 0)
 200                 RETURN(rc);
 201
 202         if (oh->ot_write_commit && OBD_FAIL_CHECK(OBD_FAIL_OST_MAPBLK_ENOSPC))
 203                 /* Unlike ldiskfs, ZFS checks for available space and returns
 204                  * -ENOSPC when assigning txg */
 205                 RETURN(-ENOSPC);
 206
 207         rc = -dmu_tx_assign(oh->ot_tx, TXG_WAIT);
 208         if (unlikely(rc != 0)) {
 209                 struct osd_device *osd = osd_dt_dev(d);
 210                 /* dmu will call commit callback with error code during abort */
 211                 if (!lu_device_is_md(&d->dd_lu_dev) && rc == -ENOSPC)
 212                         CERROR("%s: failed to start transaction due to ENOSPC. "
 213                                "Metadata overhead is underestimated or "
 214                                "grant_ratio is too low.\n", osd->od_svname);
 215                 else
 216                         CERROR("%s: can't assign tx: rc = %d\n",
 217                                osd->od_svname, rc);
 218         } else {
 219                 /* add commit callback */
 220                 dmu_tx_callback_register(oh->ot_tx, osd_trans_commit_cb, oh);
 221                 oh->ot_assigned = 1;
 222                 lu_context_init(&th->th_ctx, th->th_tags);
 223                 lu_context_enter(&th->th_ctx);
 224                 lu_device_get(&d->dd_lu_dev);
 225         }
 226
 227         RETURN(rc);
 228 }
 229
 230 /*
 231  * Concurrency: shouldn't matter.
 232  */
 233 static int osd_trans_stop(const struct lu_env *env, struct dt_device *dt,
 234                           struct thandle *th)
 235 {
 236         struct osd_device       *osd = osd_dt_dev(th->th_dev);
 237         struct osd_thandle      *oh;
 238         uint64_t                 txg;
 239         int                      rc;
 240         ENTRY;
 241
 242         oh = container_of0(th, struct osd_thandle, ot_super);
 243
 244         if (oh->ot_assigned == 0) {
 245                 LASSERT(oh->ot_tx);
 246                 dmu_tx_abort(oh->ot_tx);
 247                 osd_object_sa_dirty_rele(oh);
 248                 /* there won't be any commit, release reserved quota space now,
 249                  * if any */
 250                 qsd_op_end(env, osd->od_quota_slave, &oh->ot_quota_trans);
 251                 thandle_put(&oh->ot_super);
 252                 RETURN(0);
 253         }
 254
 255         /* When doing our own inode accounting, the ZAPs storing per-uid/gid
 256          * usage are updated at operation execution time, so we should call
 257          * qsd_op_end() straight away. Otherwise (for blk accounting maintained
 258          * by ZFS and when #inode is estimated from #blks) accounting is updated
 259          * at commit time and the call to qsd_op_end() must be delayed */
 260         if (oh->ot_quota_trans.lqt_id_cnt > 0 &&
 261                         !oh->ot_quota_trans.lqt_ids[0].lqi_is_blk &&
 262                         !osd->od_quota_iused_est)
 263                 qsd_op_end(env, osd->od_quota_slave, &oh->ot_quota_trans);
 264
 265         rc = dt_txn_hook_stop(env, th);
 266         if (rc != 0)
 267                 CDEBUG(D_OTHER, "%s: transaction hook failed: rc = %d\n",
 268                        osd->od_svname, rc);
 269
 270         LASSERT(oh->ot_tx);
 271         txg = oh->ot_tx->tx_txg;
 272
 273         osd_object_sa_dirty_rele(oh);
 274         dmu_tx_commit(oh->ot_tx);
 275
 276         if (th->th_sync)
 277                 txg_wait_synced(dmu_objset_pool(osd->od_os), txg);
 278
 279         RETURN(rc);
 280 }
 281
 282 static struct thandle *osd_trans_create(const struct lu_env *env,
 283                                         struct dt_device *dt)
 284 {
 285         struct osd_device       *osd = osd_dt_dev(dt);
 286         struct osd_thandle      *oh;
 287         struct thandle          *th;
 288         dmu_tx_t                *tx;
 289         ENTRY;
 290
 291         tx = dmu_tx_create(osd->od_os);
 292         if (tx == NULL)
 293                 RETURN(ERR_PTR(-ENOMEM));
 294
 295         /* alloc callback data */
 296         OBD_ALLOC_PTR(oh);
 297         if (oh == NULL) {
 298                 dmu_tx_abort(tx);
 299                 RETURN(ERR_PTR(-ENOMEM));
 300         }
 301
 302         oh->ot_tx = tx;
 303         INIT_LIST_HEAD(&oh->ot_dcb_list);
 304         INIT_LIST_HEAD(&oh->ot_sa_list);
 305         sema_init(&oh->ot_sa_lock, 1);
 306         memset(&oh->ot_quota_trans, 0, sizeof(oh->ot_quota_trans));
 307         th = &oh->ot_super;
 308         th->th_dev = dt;
 309         th->th_result = 0;
 310         th->th_tags = LCT_TX_HANDLE;
 311         atomic_set(&th->th_refc, 1);
 312         th->th_alloc_size = sizeof(*oh);
 313         RETURN(th);
 314 }
 315
 316 /* Estimate the number of objects from a number of blocks */
 317 uint64_t osd_objs_count_estimate(uint64_t refdbytes, uint64_t usedobjs,
 318                                  uint64_t nrblocks)
 319 {
 320         uint64_t est_objs, est_refdblocks, est_usedobjs;
 321
 322         /* Compute an nrblocks estimate based on the actual number of
 323          * dnodes that could fit in the space.  Since we don't know the
 324          * overhead associated with each dnode (xattrs, SAs, VDEV overhead,
 325          * etc) just using DNODE_SHIFT isn't going to give a good estimate.
 326          * Instead, compute an estimate based on the average space usage per
 327          * dnode, with an upper and lower cap.
 328          *
 329          * In case there aren't many dnodes or blocks used yet, add a small
 330          * correction factor using OSD_DNODE_EST_SHIFT.  This correction
 331          * factor gradually disappears as the number of real dnodes grows.
 332          * This also avoids the need to check for divide-by-zero later.
 333          */
 334         CLASSERT(OSD_DNODE_MIN_BLKSHIFT > 0);
 335         CLASSERT(OSD_DNODE_EST_BLKSHIFT > 0);
 336
 337         est_refdblocks = (refdbytes >> SPA_MAXBLOCKSHIFT) +
 338                          (OSD_DNODE_EST_COUNT >> OSD_DNODE_EST_BLKSHIFT);
 339         est_usedobjs   = usedobjs + OSD_DNODE_EST_COUNT;
 340
 341         /* Average space/dnode more than maximum dnode size, use max dnode
 342          * size to estimate free dnodes from adjusted free blocks count.
 343          * OSTs typically use more than one block dnode so this case applies. */
 344         if (est_usedobjs <= est_refdblocks * 2) {
 345                 est_objs = nrblocks;
 346
 347         /* Average space/dnode smaller than min dnode size (probably due to
 348          * metadnode compression), use min dnode size to estimate the number of
 349          * objects.
 350          * An MDT typically uses below 512 bytes/dnode so this case applies. */
 351         } else if (est_usedobjs >= (est_refdblocks << OSD_DNODE_MIN_BLKSHIFT)) {
 352                 est_objs = nrblocks << OSD_DNODE_MIN_BLKSHIFT;
 353
 354                 /* Between the extremes, we try to use the average size of
 355                  * existing dnodes to compute the number of dnodes that fit
 356                  * into nrblocks:
 357                  *
 358                  * est_objs = nrblocks * (est_usedobjs / est_refblocks);
 359                  *
 360                  * but this may overflow 64 bits or become 0 if not handled well
 361                  *
 362                  * We know nrblocks is below (64 - 17 = 47) bits from
 363                  * SPA_MAXBLKSHIFT, and est_usedobjs is under 48 bits due to
 364                  * DN_MAX_OBJECT_SHIFT, which means that multiplying them may
 365                  * get as large as 2 ^ 95.
 366                  *
 367                  * We also know (est_usedobjs / est_refdblocks) is between 2 and
 368                  * 256, due to above checks, we can safely compute this first.
 369                  * We care more about accuracy on the MDT (many dnodes/block)
 370                  * which is good because this is where truncation errors are
 371                  * smallest.  This adds 8 bits to nrblocks so we can use 7 bits
 372                  * to compute a fixed-point fraction and nrblocks can still fit
 373                  * in 64 bits. */
 374         } else {
 375                 unsigned dnodes_per_block = (est_usedobjs << 7)/est_refdblocks;
 376
 377                 est_objs = (nrblocks * dnodes_per_block) >> 7;
 378         }
 379         return est_objs;
 380 }
 381
 382 static int osd_objset_statfs(struct objset *os, struct obd_statfs *osfs)
 383 {
 384         uint64_t refdbytes, availbytes, usedobjs, availobjs;
 385         uint64_t est_availobjs;
 386         uint64_t reserved;
 387
 388         dmu_objset_space(os, &refdbytes, &availbytes, &usedobjs,
 389                          &availobjs);
 390
 391         /*
 392          * ZFS allows multiple block sizes.  For statfs, Linux makes no
 393          * proper distinction between bsize and frsize.  For calculations
 394          * of free and used blocks incorrectly uses bsize instead of frsize,
 395          * but bsize is also used as the optimal blocksize.  We return the
 396          * largest possible block size as IO size for the optimum performance
 397          * and scale the free and used blocks count appropriately.
 398          */
 399         osfs->os_bsize = 1ULL << SPA_MAXBLOCKSHIFT;
 400
 401         osfs->os_blocks = (refdbytes + availbytes) >> SPA_MAXBLOCKSHIFT;
 402         osfs->os_bfree = availbytes >> SPA_MAXBLOCKSHIFT;
 403         osfs->os_bavail = osfs->os_bfree; /* no extra root reservation */
 404
 405         /* Take replication (i.e. number of copies) into account */
 406         osfs->os_bavail /= os->os_copies;
 407
 408         /*
 409          * Reserve some space so we don't run into ENOSPC due to grants not
 410          * accounting for metadata overhead in ZFS, and to avoid fragmentation.
 411          * Rather than report this via os_bavail (which makes users unhappy if
 412          * they can't fill the filesystem 100%), reduce os_blocks as well.
 413          *
 414          * Reserve 0.78% of total space, at least 4MB for small filesystems,
 415          * for internal files to be created/unlinked when space is tight.
 416          */
 417         CLASSERT(OSD_STATFS_RESERVED_BLKS > 0);
 418         if (likely(osfs->os_blocks >=
 419                         OSD_STATFS_RESERVED_BLKS << OSD_STATFS_RESERVED_SHIFT))
 420                 reserved = osfs->os_blocks >> OSD_STATFS_RESERVED_SHIFT;
 421         else
 422                 reserved = OSD_STATFS_RESERVED_BLKS;
 423
 424         osfs->os_blocks -= reserved;
 425         osfs->os_bfree  -= MIN(reserved, osfs->os_bfree);
 426         osfs->os_bavail -= MIN(reserved, osfs->os_bavail);
 427
 428         /*
 429          * The availobjs value returned from dmu_objset_space() is largely
 430          * useless, since it reports the number of objects that might
 431          * theoretically still fit into the dataset, independent of minor
 432          * issues like how much space is actually available in the pool.
 433          * Compute a better estimate in udmu_objs_count_estimate().
 434          */
 435         est_availobjs = osd_objs_count_estimate(refdbytes, usedobjs,
 436                                                 osfs->os_bfree);
 437
 438         osfs->os_ffree = min(availobjs, est_availobjs);
 439         osfs->os_files = osfs->os_ffree + usedobjs;
 440
 441         /* ZFS XXX: fill in backing dataset FSID/UUID
 442            memcpy(osfs->os_fsid, .... );*/
 443
 444         /* We're a zfs filesystem. */
 445         osfs->os_type = UBERBLOCK_MAGIC;
 446
 447         /* ZFS XXX: fill in appropriate OS_STATE_{DEGRADED,READONLY} flags
 448            osfs->os_state = vf_to_stf(vfsp->vfs_flag);
 449            if (sb->s_flags & MS_RDONLY)
 450            osfs->os_state = OS_STATE_READONLY;
 451          */
 452
 453         osfs->os_namelen = MAXNAMELEN;
 454         osfs->os_maxbytes = OBD_OBJECT_EOF;
 455
 456         return 0;
 457 }
 458
 459 /*
 460  * Concurrency: shouldn't matter.
 461  */
 462 int osd_statfs(const struct lu_env *env, struct dt_device *d,
 463                struct obd_statfs *osfs)
 464 {
 465         struct osd_device *osd = osd_dt_dev(d);
 466         int                rc;
 467         ENTRY;
 468
 469         rc = osd_objset_statfs(osd->od_os, osfs);
 470         if (unlikely(rc != 0))
 471                 RETURN(rc);
 472
 473         osfs->os_bavail -= min_t(u64,
 474                                  OSD_GRANT_FOR_LOCAL_OIDS / osfs->os_bsize,
 475                                  osfs->os_bavail);
 476         RETURN(0);
 477 }
 478
 479 static int osd_blk_insert_cost(void)
 480 {
 481         int max_blockshift, nr_blkptrshift;
 482
 483         /* max_blockshift is the log2 of the number of blocks needed to reach
 484          * the maximum filesize (that's to say 2^64) */
 485         max_blockshift = DN_MAX_OFFSET_SHIFT - SPA_MAXBLOCKSHIFT;
 486
 487         /* nr_blkptrshift is the log2 of the number of block pointers that can
 488          * be stored in an indirect block */
 489         CLASSERT(DN_MAX_INDBLKSHIFT > SPA_BLKPTRSHIFT);
 490         nr_blkptrshift = DN_MAX_INDBLKSHIFT - SPA_BLKPTRSHIFT;
 491
 492         /* max_blockshift / nr_blkptrshift is thus the maximum depth of the
 493          * tree. We add +1 for rounding purpose.
 494          * The tree depth times the indirect block size gives us the maximum
 495          * cost of inserting a block in the tree */
 496         return (max_blockshift / nr_blkptrshift + 1) * (1<<DN_MAX_INDBLKSHIFT);
 497 }
 498
 499 /*
 500  * Concurrency: doesn't access mutable data.
 501  */
 502 static void osd_conf_get(const struct lu_env *env,
 503                          const struct dt_device *dev,
 504                          struct dt_device_param *param)
 505 {
 506         struct osd_device *osd = osd_dt_dev(dev);
 507
 508         /*
 509          * XXX should be taken from not-yet-existing fs abstraction layer.
 510          */
 511         param->ddp_max_name_len = MAXNAMELEN;
 512         param->ddp_max_nlink    = 1 << 31; /* it's 8byte on a disk */
 513         param->ddp_block_shift  = 12; /* XXX */
 514         param->ddp_mount_type   = LDD_MT_ZFS;
 515
 516         param->ddp_mntopts      = MNTOPT_USERXATTR;
 517         if (osd->od_posix_acl)
 518                 param->ddp_mntopts |= MNTOPT_ACL;
 519         param->ddp_max_ea_size  = DXATTR_MAX_ENTRY_SIZE;
 520
 521         /* for maxbytes, report same value as ZPL */
 522         param->ddp_maxbytes     = MAX_LFS_FILESIZE;
 523
 524         /* Default reserved fraction of the available space that should be kept
 525          * for error margin. Unfortunately, there are many factors that can
 526          * impact the overhead with zfs, so let's be very cautious for now and
 527          * reserve 20% of the available space which is not given out as grant.
 528          * This tunable can be changed on a live system via procfs if needed. */
 529         param->ddp_grant_reserved = 20;
 530
 531         /* inodes are dynamically allocated, so we report the per-inode space
 532          * consumption to upper layers. This static value is not really accurate
 533          * and we should use the same logic as in udmu_objset_statfs() to
 534          * estimate the real size consumed by an object */
 535         param->ddp_inodespace = OSD_DNODE_EST_COUNT;
 536         /* per-fragment overhead to be used by the client code */
 537         param->ddp_grant_frag = osd_blk_insert_cost();
 538 }
 539
 540 /*
 541  * Concurrency: shouldn't matter.
 542  */
 543 static int osd_sync(const struct lu_env *env, struct dt_device *d)
 544 {
 545         struct osd_device  *osd = osd_dt_dev(d);
 546         CDEBUG(D_CACHE, "syncing OSD %s\n", LUSTRE_OSD_ZFS_NAME);
 547         txg_wait_synced(dmu_objset_pool(osd->od_os), 0ULL);
 548         CDEBUG(D_CACHE, "synced OSD %s\n", LUSTRE_OSD_ZFS_NAME);
 549         return 0;
 550 }
 551
 552 static int osd_commit_async(const struct lu_env *env, struct dt_device *dev)
 553 {
 554         struct osd_device *osd = osd_dt_dev(dev);
 555         tx_state_t        *tx = &dmu_objset_pool(osd->od_os)->dp_tx;
 556         uint64_t           txg;
 557
 558         mutex_enter(&tx->tx_sync_lock);
 559         txg = tx->tx_open_txg + 1;
 560         if (tx->tx_quiesce_txg_waiting < txg) {
 561                 tx->tx_quiesce_txg_waiting = txg;
 562                 cv_broadcast(&tx->tx_quiesce_more_cv);
 563         }
 564         mutex_exit(&tx->tx_sync_lock);
 565
 566         return 0;
 567 }
 568
 569 /*
 570  * Concurrency: shouldn't matter.
 571  */
 572 static int osd_ro(const struct lu_env *env, struct dt_device *d)
 573 {
 574         struct osd_device  *osd = osd_dt_dev(d);
 575         ENTRY;
 576
 577         CERROR("%s: *** setting device %s read-only ***\n",
 578                osd->od_svname, LUSTRE_OSD_ZFS_NAME);
 579         osd->od_rdonly = 1;
 580         spa_freeze(dmu_objset_spa(osd->od_os));
 581
 582         RETURN(0);
 583 }
 584
 585 /*
 586  * Concurrency: serialization provided by callers.
 587  */
 588 static int osd_init_capa_ctxt(const struct lu_env *env, struct dt_device *d,
 589                               int mode, unsigned long timeout, __u32 alg,
 590                               struct lustre_capa_key *keys)
 591 {
 592         struct osd_device *dev = osd_dt_dev(d);
 593         ENTRY;
 594
 595         dev->od_fl_capa = mode;
 596         dev->od_capa_timeout = timeout;
 597         dev->od_capa_alg = alg;
 598         dev->od_capa_keys = keys;
 599
 600         RETURN(0);
 601 }
 602
 603 static struct dt_device_operations osd_dt_ops = {
 604         .dt_root_get            = osd_root_get,
 605         .dt_statfs              = osd_statfs,
 606         .dt_trans_create        = osd_trans_create,
 607         .dt_trans_start         = osd_trans_start,
 608         .dt_trans_stop          = osd_trans_stop,
 609         .dt_trans_cb_add        = osd_trans_cb_add,
 610         .dt_conf_get            = osd_conf_get,
 611         .dt_sync                = osd_sync,
 612         .dt_commit_async        = osd_commit_async,
 613         .dt_ro                  = osd_ro,
 614         .dt_init_capa_ctxt      = osd_init_capa_ctxt,
 615 };
 616
 617 /*
 618  * DMU OSD device type methods
 619  */
 620 static int osd_type_init(struct lu_device_type *t)
 621 {
 622         LU_CONTEXT_KEY_INIT(&osd_key);
 623         return lu_context_key_register(&osd_key);
 624 }
 625
 626 static void osd_type_fini(struct lu_device_type *t)
 627 {
 628         lu_context_key_degister(&osd_key);
 629 }
 630
 631 static void *osd_key_init(const struct lu_context *ctx,
 632                           struct lu_context_key *key)
 633 {
 634         struct osd_thread_info *info;
 635
 636         OBD_ALLOC_PTR(info);
 637         if (info != NULL)
 638                 info->oti_env = container_of(ctx, struct lu_env, le_ctx);
 639         else
 640                 info = ERR_PTR(-ENOMEM);
 641         return info;
 642 }
 643
 644 static void osd_key_fini(const struct lu_context *ctx,
 645                          struct lu_context_key *key, void *data)
 646 {
 647         struct osd_thread_info *info = data;
 648
 649         OBD_FREE_PTR(info);
 650 }
 651
 652 static void osd_key_exit(const struct lu_context *ctx,
 653                          struct lu_context_key *key, void *data)
 654 {
 655         struct osd_thread_info *info = data;
 656
 657         memset(info, 0, sizeof(*info));
 658 }
 659
 660 struct lu_context_key osd_key = {
 661         .lct_tags = LCT_DT_THREAD | LCT_MD_THREAD | LCT_MG_THREAD | LCT_LOCAL,
 662         .lct_init = osd_key_init,
 663         .lct_fini = osd_key_fini,
 664         .lct_exit = osd_key_exit
 665 };
 666
 667 static int osd_shutdown(const struct lu_env *env, struct osd_device *o)
 668 {
 669         ENTRY;
 670
 671         /* shutdown quota slave instance associated with the device */
 672         if (o->od_quota_slave != NULL) {
 673                 qsd_fini(env, o->od_quota_slave);
 674                 o->od_quota_slave = NULL;
 675         }
 676
 677         RETURN(0);
 678 }
 679
 680 static void osd_xattr_changed_cb(void *arg, uint64_t newval)
 681 {
 682         struct osd_device *osd = arg;
 683
 684         osd->od_xattr_in_sa = (newval == ZFS_XATTR_SA);
 685 }
 686
 687 static int osd_objset_open(struct osd_device *o)
 688 {
 689         uint64_t        version = ZPL_VERSION;
 690         uint64_t        sa_obj;
 691         int             rc;
 692         ENTRY;
 693
 694         rc = -dmu_objset_own(o->od_mntdev, DMU_OST_ZFS, B_FALSE, o, &o->od_os);
 695         if (rc) {
 696                 o->od_os = NULL;
 697                 goto out;
 698         }
 699
 700         /* Check ZFS version */
 701         rc = -zap_lookup(o->od_os, MASTER_NODE_OBJ,
 702                          ZPL_VERSION_STR, 8, 1, &version);
 703         if (rc) {
 704                 CERROR("%s: Error looking up ZPL VERSION\n", o->od_mntdev);
 705                 /*
 706                  * We can't return ENOENT because that would mean the objset
 707                  * didn't exist.
 708                  */
 709                 GOTO(out, rc = -EIO);
 710         }
 711
 712         rc = -zap_lookup(o->od_os, MASTER_NODE_OBJ,
 713                          ZFS_SA_ATTRS, 8, 1, &sa_obj);
 714         if (rc)
 715                 GOTO(out, rc);
 716
 717         rc = -sa_setup(o->od_os, sa_obj, zfs_attr_table,
 718                        ZPL_END, &o->z_attr_table);
 719         if (rc)
 720                 GOTO(out, rc);
 721
 722         rc = -zap_lookup(o->od_os, MASTER_NODE_OBJ, ZFS_ROOT_OBJ,
 723                          8, 1, &o->od_rootid);
 724         if (rc) {
 725                 CERROR("%s: lookup for root failed: rc = %d\n",
 726                         o->od_svname, rc);
 727                 GOTO(out, rc);
 728         }
 729
 730         /* Check that user/group usage tracking is supported */
 731         if (!dmu_objset_userused_enabled(o->od_os) ||
 732             DMU_USERUSED_DNODE(o->od_os)->dn_type != DMU_OT_USERGROUP_USED ||
 733             DMU_GROUPUSED_DNODE(o->od_os)->dn_type != DMU_OT_USERGROUP_USED) {
 734                 CERROR("%s: Space accounting not supported by this target, "
 735                         "aborting\n", o->od_svname);
 736                 GOTO(out, -ENOTSUPP);
 737         }
 738
 739 out:
 740         if (rc != 0 && o->od_os != NULL)
 741                 dmu_objset_disown(o->od_os, o);
 742
 743         RETURN(rc);
 744 }
 745
 746 static int osd_mount(const struct lu_env *env,
 747                      struct osd_device *o, struct lustre_cfg *cfg)
 748 {
 749         struct dsl_dataset      *ds;
 750         char                    *mntdev = lustre_cfg_string(cfg, 1);
 751         char                    *svname = lustre_cfg_string(cfg, 4);
 752         dmu_buf_t               *rootdb;
 753         dsl_pool_t              *dp;
 754         const char              *opts;
 755         int                      rc;
 756         ENTRY;
 757
 758         if (o->od_os != NULL)
 759                 RETURN(0);
 760
 761         if (mntdev == NULL || svname == NULL)
 762                 RETURN(-EINVAL);
 763
 764         rc = strlcpy(o->od_mntdev, mntdev, sizeof(o->od_mntdev));
 765         if (rc >= sizeof(o->od_mntdev))
 766                 RETURN(-E2BIG);
 767
 768         rc = strlcpy(o->od_svname, svname, sizeof(o->od_svname));
 769         if (rc >= sizeof(o->od_svname))
 770                 RETURN(-E2BIG);
 771
 772         if (server_name_is_ost(o->od_svname))
 773                 o->od_is_ost = 1;
 774
 775         rc = osd_objset_open(o);
 776         if (rc) {
 777                 CERROR("%s: can't open objset %s: rc = %d\n", o->od_svname,
 778                         o->od_mntdev, rc);
 779                 RETURN(rc);
 780         }
 781
 782         ds = dmu_objset_ds(o->od_os);
 783         dp = dmu_objset_pool(o->od_os);
 784         LASSERT(ds);
 785         LASSERT(dp);
 786         dsl_pool_config_enter(dp, FTAG);
 787         rc = dsl_prop_register(ds, "xattr", osd_xattr_changed_cb, o);
 788         dsl_pool_config_exit(dp, FTAG);
 789         if (rc)
 790                 CWARN("%s: can't register xattr callback, ignore: rc=%d\n",
 791                       o->od_svname, rc);
 792
 793         rc = __osd_obj2dbuf(env, o->od_os, o->od_rootid, &rootdb);
 794         if (rc) {
 795                 CERROR("%s: obj2dbuf() failed: rc = %d\n", o->od_svname, rc);
 796                 dmu_objset_disown(o->od_os, o);
 797                 o->od_os = NULL;
 798                 RETURN(rc);
 799         }
 800
 801         o->od_root = rootdb->db_object;
 802         sa_buf_rele(rootdb, osd_obj_tag);
 803
 804         /* 1. initialize oi before any file create or file open */
 805         rc = osd_oi_init(env, o);
 806         if (rc)
 807                 GOTO(err, rc);
 808
 809         rc = lu_site_init(&o->od_site, osd2lu_dev(o));
 810         if (rc)
 811                 GOTO(err, rc);
 812         o->od_site.ls_bottom_dev = osd2lu_dev(o);
 813
 814         rc = lu_site_init_finish(&o->od_site);
 815         if (rc)
 816                 GOTO(err, rc);
 817
 818         rc = osd_convert_root_to_new_seq(env, o);
 819         if (rc)
 820                 GOTO(err, rc);
 821
 822         /* Use our own ZAP for inode accounting by default, this can be changed
 823          * via procfs to estimate the inode usage from the block usage */
 824         o->od_quota_iused_est = 0;
 825
 826         rc = osd_procfs_init(o, o->od_svname);
 827         if (rc)
 828                 GOTO(err, rc);
 829
 830         o->arc_prune_cb = arc_add_prune_callback(arc_prune_func, o);
 831
 832         /* initialize quota slave instance */
 833         o->od_quota_slave = qsd_init(env, o->od_svname, &o->od_dt_dev,
 834                                      o->od_proc_entry);
 835         if (IS_ERR(o->od_quota_slave)) {
 836                 rc = PTR_ERR(o->od_quota_slave);
 837                 o->od_quota_slave = NULL;
 838                 GOTO(err, rc);
 839         }
 840
 841         /* parse mount option "noacl", and enable ACL by default */
 842         opts = lustre_cfg_string(cfg, 3);
 843         if (opts == NULL || strstr(opts, "noacl") == NULL)
 844                 o->od_posix_acl = 1;
 845
 846 err:
 847         RETURN(rc);
 848 }
 849
 850 static void osd_umount(const struct lu_env *env, struct osd_device *o)
 851 {
 852         ENTRY;
 853
 854         if (atomic_read(&o->od_zerocopy_alloc))
 855                 CERROR("%s: lost %d allocated page(s)\n", o->od_svname,
 856                        atomic_read(&o->od_zerocopy_alloc));
 857         if (atomic_read(&o->od_zerocopy_loan))
 858                 CERROR("%s: lost %d loaned abuf(s)\n", o->od_svname,
 859                        atomic_read(&o->od_zerocopy_loan));
 860         if (atomic_read(&o->od_zerocopy_pin))
 861                 CERROR("%s: lost %d pinned dbuf(s)\n", o->od_svname,
 862                        atomic_read(&o->od_zerocopy_pin));
 863
 864         if (o->od_os != NULL) {
 865                 /* force a txg sync to get all commit callbacks */
 866                 txg_wait_synced(dmu_objset_pool(o->od_os), 0ULL);
 867
 868                 /* close the object set */
 869                 dmu_objset_disown(o->od_os, o);
 870
 871                 o->od_os = NULL;
 872         }
 873
 874         EXIT;
 875 }
 876
 877 static int osd_device_init0(const struct lu_env *env,
 878                             struct osd_device *o,
 879                             struct lustre_cfg *cfg)
 880 {
 881         struct lu_device        *l = osd2lu_dev(o);
 882         int                      rc;
 883
 884         /* if the module was re-loaded, env can loose its keys */
 885         rc = lu_env_refill((struct lu_env *) env);
 886         if (rc)
 887                 GOTO(out, rc);
 888
 889         l->ld_ops = &osd_lu_ops;
 890         o->od_dt_dev.dd_ops = &osd_dt_ops;
 891
 892         o->od_capa_hash = init_capa_hash();
 893         if (o->od_capa_hash == NULL)
 894                 GOTO(out, rc = -ENOMEM);
 895
 896 out:
 897         RETURN(rc);
 898 }
 899
 900 static struct lu_device *osd_device_fini(const struct lu_env *env,
 901                                          struct lu_device *dev);
 902
 903 static struct lu_device *osd_device_alloc(const struct lu_env *env,
 904                                           struct lu_device_type *type,
 905                                           struct lustre_cfg *cfg)
 906 {
 907         struct osd_device *dev;
 908         int                rc;
 909
 910         OBD_ALLOC_PTR(dev);
 911         if (dev == NULL)
 912                 return ERR_PTR(-ENOMEM);
 913
 914         rc = dt_device_init(&dev->od_dt_dev, type);
 915         if (rc == 0) {
 916                 rc = osd_device_init0(env, dev, cfg);
 917                 if (rc == 0) {
 918                         rc = osd_mount(env, dev, cfg);
 919                         if (rc)
 920                                 osd_device_fini(env, osd2lu_dev(dev));
 921                 }
 922                 if (rc)
 923                         dt_device_fini(&dev->od_dt_dev);
 924         }
 925
 926         if (unlikely(rc != 0))
 927                 OBD_FREE_PTR(dev);
 928
 929         return rc == 0 ? osd2lu_dev(dev) : ERR_PTR(rc);
 930 }
 931
 932 static struct lu_device *osd_device_free(const struct lu_env *env,
 933                                          struct lu_device *d)
 934 {
 935         struct osd_device *o = osd_dev(d);
 936         ENTRY;
 937
 938         cleanup_capa_hash(o->od_capa_hash);
 939         /* XXX: make osd top device in order to release reference */
 940         d->ld_site->ls_top_dev = d;
 941         lu_site_purge(env, d->ld_site, -1);
 942         if (!cfs_hash_is_empty(d->ld_site->ls_obj_hash)) {
 943                 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_ERROR, NULL);
 944                 lu_site_print(env, d->ld_site, &msgdata, lu_cdebug_printer);
 945         }
 946         lu_site_fini(&o->od_site);
 947         dt_device_fini(&o->od_dt_dev);
 948         OBD_FREE_PTR(o);
 949
 950         RETURN (NULL);
 951 }
 952
 953 static struct lu_device *osd_device_fini(const struct lu_env *env,
 954                                          struct lu_device *d)
 955 {
 956         struct osd_device *o = osd_dev(d);
 957         struct dsl_dataset *ds;
 958         int                rc;
 959         ENTRY;
 960
 961
 962         osd_shutdown(env, o);
 963         osd_oi_fini(env, o);
 964
 965         if (o->od_os) {
 966                 ds = dmu_objset_ds(o->od_os);
 967                 rc = dsl_prop_unregister(ds, "xattr", osd_xattr_changed_cb, o);
 968                 if (rc)
 969                         CERROR("%s: dsl_prop_unregister xattr error %d\n",
 970                                 o->od_svname, rc);
 971                 if (o->arc_prune_cb != NULL) {
 972                         arc_remove_prune_callback(o->arc_prune_cb);
 973                         o->arc_prune_cb = NULL;
 974                 }
 975                 osd_sync(env, lu2dt_dev(d));
 976                 txg_wait_callbacks(spa_get_dsl(dmu_objset_spa(o->od_os)));
 977         }
 978
 979         rc = osd_procfs_fini(o);
 980         if (rc) {
 981                 CERROR("proc fini error %d\n", rc);
 982                 RETURN(ERR_PTR(rc));
 983         }
 984
 985         if (o->od_os)
 986                 osd_umount(env, o);
 987
 988         RETURN(NULL);
 989 }
 990
 991 static int osd_device_init(const struct lu_env *env, struct lu_device *d,
 992                            const char *name, struct lu_device *next)
 993 {
 994         return 0;
 995 }
 996
 997 /*
 998  * To be removed, setup is performed by osd_device_{init,alloc} and
 999  * cleanup is performed by osd_device_{fini,free).
1000  */
1001 static int osd_process_config(const struct lu_env *env,
1002                               struct lu_device *d, struct lustre_cfg *cfg)
1003 {
1004         struct osd_device       *o = osd_dev(d);
1005         int                     rc;
1006         ENTRY;
1007
1008         switch(cfg->lcfg_command) {
1009         case LCFG_SETUP:
1010                 rc = osd_mount(env, o, cfg);
1011                 break;
1012         case LCFG_CLEANUP:
1013                 rc = osd_shutdown(env, o);
1014                 break;
1015         case LCFG_PARAM: {
1016                 LASSERT(&o->od_dt_dev);
1017                 rc = class_process_proc_param(PARAM_OSD, lprocfs_osd_obd_vars,
1018                                               cfg, &o->od_dt_dev);
1019                 if (rc > 0 || rc == -ENOSYS)
1020                         rc = class_process_proc_param(PARAM_OST,
1021                                                       lprocfs_osd_obd_vars,
1022                                                       cfg, &o->od_dt_dev);
1023                 break;
1024         }
1025         default:
1026                 rc = -ENOTTY;
1027         }
1028
1029         RETURN(rc);
1030 }
1031
1032 static int osd_recovery_complete(const struct lu_env *env, struct lu_device *d)
1033 {
1034         struct osd_device       *osd = osd_dev(d);
1035         int                      rc = 0;
1036         ENTRY;
1037
1038         if (osd->od_quota_slave == NULL)
1039                 RETURN(0);
1040
1041         /* start qsd instance on recovery completion, this notifies the quota
1042          * slave code that we are about to process new requests now */
1043         rc = qsd_start(env, osd->od_quota_slave);
1044         RETURN(rc);
1045 }
1046
1047 /*
1048  * we use exports to track all osd users
1049  */
1050 static int osd_obd_connect(const struct lu_env *env, struct obd_export **exp,
1051                            struct obd_device *obd, struct obd_uuid *cluuid,
1052                            struct obd_connect_data *data, void *localdata)
1053 {
1054         struct osd_device    *osd = osd_dev(obd->obd_lu_dev);
1055         struct lustre_handle  conn;
1056         int                   rc;
1057         ENTRY;
1058
1059         CDEBUG(D_CONFIG, "connect #%d\n", osd->od_connects);
1060
1061         rc = class_connect(&conn, obd, cluuid);
1062         if (rc)
1063                 RETURN(rc);
1064
1065         *exp = class_conn2export(&conn);
1066
1067         spin_lock(&obd->obd_dev_lock);
1068         osd->od_connects++;
1069         spin_unlock(&obd->obd_dev_lock);
1070
1071         RETURN(0);
1072 }
1073
1074 /*
1075  * once last export (we don't count self-export) disappeared
1076  * osd can be released
1077  */
1078 static int osd_obd_disconnect(struct obd_export *exp)
1079 {
1080         struct obd_device *obd = exp->exp_obd;
1081         struct osd_device *osd = osd_dev(obd->obd_lu_dev);
1082         int                rc, release = 0;
1083         ENTRY;
1084
1085         /* Only disconnect the underlying layers on the final disconnect. */
1086         spin_lock(&obd->obd_dev_lock);
1087         osd->od_connects--;
1088         if (osd->od_connects == 0)
1089                 release = 1;
1090         spin_unlock(&obd->obd_dev_lock);
1091
1092         rc = class_disconnect(exp); /* bz 9811 */
1093
1094         if (rc == 0 && release)
1095                 class_manual_cleanup(obd);
1096         RETURN(rc);
1097 }
1098
1099 static int osd_prepare(const struct lu_env *env, struct lu_device *pdev,
1100                        struct lu_device *dev)
1101 {
1102         struct osd_device       *osd = osd_dev(dev);
1103         int                      rc = 0;
1104         ENTRY;
1105
1106         if (osd->od_quota_slave != NULL)
1107                 /* set up quota slave objects */
1108                 rc = qsd_prepare(env, osd->od_quota_slave);
1109
1110         RETURN(rc);
1111 }
1112
1113 struct lu_device_operations osd_lu_ops = {
1114         .ldo_object_alloc       = osd_object_alloc,
1115         .ldo_process_config     = osd_process_config,
1116         .ldo_recovery_complete  = osd_recovery_complete,
1117         .ldo_prepare            = osd_prepare,
1118 };
1119
1120 static void osd_type_start(struct lu_device_type *t)
1121 {
1122 }
1123
1124 static void osd_type_stop(struct lu_device_type *t)
1125 {
1126 }
1127
1128 int osd_fid_alloc(const struct lu_env *env, struct obd_export *exp,
1129                   struct lu_fid *fid, struct md_op_data *op_data)
1130 {
1131         struct osd_device *osd = osd_dev(exp->exp_obd->obd_lu_dev);
1132
1133         return seq_client_alloc_fid(env, osd->od_cl_seq, fid);
1134 }
1135
1136 static struct lu_device_type_operations osd_device_type_ops = {
1137         .ldto_init              = osd_type_init,
1138         .ldto_fini              = osd_type_fini,
1139
1140         .ldto_start             = osd_type_start,
1141         .ldto_stop              = osd_type_stop,
1142
1143         .ldto_device_alloc      = osd_device_alloc,
1144         .ldto_device_free       = osd_device_free,
1145
1146         .ldto_device_init       = osd_device_init,
1147         .ldto_device_fini       = osd_device_fini
1148 };
1149
1150 static struct lu_device_type osd_device_type = {
1151         .ldt_tags     = LU_DEVICE_DT,
1152         .ldt_name     = LUSTRE_OSD_ZFS_NAME,
1153         .ldt_ops      = &osd_device_type_ops,
1154         .ldt_ctx_tags = LCT_LOCAL
1155 };
1156
1157
1158 static struct obd_ops osd_obd_device_ops = {
1159         .o_owner       = THIS_MODULE,
1160         .o_connect      = osd_obd_connect,
1161         .o_disconnect   = osd_obd_disconnect,
1162         .o_fid_alloc    = osd_fid_alloc
1163 };
1164
1165 int __init osd_init(void)
1166 {
1167         int rc;
1168
1169         rc = osd_options_init();
1170         if (rc)
1171                 return rc;
1172
1173         rc = lu_kmem_init(osd_caches);
1174         if (rc)
1175                 return rc;
1176
1177         rc = class_register_type(&osd_obd_device_ops, NULL, true, NULL,
1178                                  LUSTRE_OSD_ZFS_NAME, &osd_device_type);
1179         if (rc)
1180                 lu_kmem_fini(osd_caches);
1181         return rc;
1182 }
1183
1184 void __exit osd_exit(void)
1185 {
1186         class_unregister_type(LUSTRE_OSD_ZFS_NAME);
1187         lu_kmem_fini(osd_caches);
1188 }
1189
1190 extern unsigned int osd_oi_count;
1191 CFS_MODULE_PARM(osd_oi_count, "i", int, 0444,
1192                 "Number of Object Index containers to be created, "
1193                 "it's only valid for new filesystem.");
1194
1195 MODULE_AUTHOR("Sun Microsystems, Inc. <http://www.lustre.org/>");
1196 MODULE_DESCRIPTION("Lustre Object Storage Device ("LUSTRE_OSD_ZFS_NAME")");
1197 MODULE_LICENSE("GPL");
1198
1199 cfs_module(osd, LUSTRE_VERSION_STRING, osd_init, osd_exit);