module/zfs/dsl_bookmark.c

   1 /*
   2  * CDDL HEADER START
   3  *
   4  * This file and its contents are supplied under the terms of the
   5  * Common Development and Distribution License ("CDDL"), version 1.0.
   6  * You may only use this file in accordance with the terms of version
   7  * 1.0 of the CDDL.
   8  *
   9  * A full copy of the text of the CDDL should have accompanied this
  10  * source.  A copy of the CDDL is also available via the Internet at
  11  * http://www.illumos.org/license/CDDL.
  12  *
  13  * CDDL HEADER END
  14  */
  15 /*
  16  * Copyright (c) 2013 by Delphix. All rights reserved.
  17  */
  18
  19 #include <sys/zfs_context.h>
  20 #include <sys/dsl_dataset.h>
  21 #include <sys/dsl_dir.h>
  22 #include <sys/dsl_prop.h>
  23 #include <sys/dsl_synctask.h>
  24 #include <sys/dmu_impl.h>
  25 #include <sys/dmu_tx.h>
  26 #include <sys/arc.h>
  27 #include <sys/zap.h>
  28 #include <sys/zfeature.h>
  29 #include <sys/spa.h>
  30 #include <sys/dsl_bookmark.h>
  31 #include <zfs_namecheck.h>
  32
  33 static int
  34 dsl_bookmark_hold_ds(dsl_pool_t *dp, const char *fullname,
  35     dsl_dataset_t **dsp, void *tag, char **shortnamep)
  36 {
  37         char buf[MAXNAMELEN];
  38         char *hashp;
  39
  40         if (strlen(fullname) >= MAXNAMELEN)
  41                 return (SET_ERROR(ENAMETOOLONG));
  42         hashp = strchr(fullname, '#');
  43         if (hashp == NULL)
  44                 return (SET_ERROR(EINVAL));
  45
  46         *shortnamep = hashp + 1;
  47         if (zfs_component_namecheck(*shortnamep, NULL, NULL))
  48                 return (SET_ERROR(EINVAL));
  49         (void) strlcpy(buf, fullname, hashp - fullname + 1);
  50         return (dsl_dataset_hold(dp, buf, tag, dsp));
  51 }
  52
  53 /*
  54  * Returns ESRCH if bookmark is not found.
  55  */
  56 static int
  57 dsl_dataset_bmark_lookup(dsl_dataset_t *ds, const char *shortname,
  58     zfs_bookmark_phys_t *bmark_phys)
  59 {
  60         objset_t *mos = ds->ds_dir->dd_pool->dp_meta_objset;
  61         uint64_t bmark_zapobj = ds->ds_bookmarks;
  62         matchtype_t mt;
  63         int err;
  64
  65         if (bmark_zapobj == 0)
  66                 return (SET_ERROR(ESRCH));
  67
  68         if (dsl_dataset_phys(ds)->ds_flags & DS_FLAG_CI_DATASET)
  69                 mt = MT_FIRST;
  70         else
  71                 mt = MT_EXACT;
  72
  73         err = zap_lookup_norm(mos, bmark_zapobj, shortname, sizeof (uint64_t),
  74             sizeof (*bmark_phys) / sizeof (uint64_t), bmark_phys, mt,
  75             NULL, 0, NULL);
  76
  77         return (err == ENOENT ? ESRCH : err);
  78 }
  79
  80 /*
  81  * If later_ds is non-NULL, this will return EXDEV if the the specified bookmark
  82  * does not represents an earlier point in later_ds's timeline.
  83  *
  84  * Returns ENOENT if the dataset containing the bookmark does not exist.
  85  * Returns ESRCH if the dataset exists but the bookmark was not found in it.
  86  */
  87 int
  88 dsl_bookmark_lookup(dsl_pool_t *dp, const char *fullname,
  89     dsl_dataset_t *later_ds, zfs_bookmark_phys_t *bmp)
  90 {
  91         char *shortname;
  92         dsl_dataset_t *ds;
  93         int error;
  94
  95         error = dsl_bookmark_hold_ds(dp, fullname, &ds, FTAG, &shortname);
  96         if (error != 0)
  97                 return (error);
  98
  99         error = dsl_dataset_bmark_lookup(ds, shortname, bmp);
 100         if (error == 0 && later_ds != NULL) {
 101                 if (!dsl_dataset_is_before(later_ds, ds, bmp->zbm_creation_txg))
 102                         error = SET_ERROR(EXDEV);
 103         }
 104         dsl_dataset_rele(ds, FTAG);
 105         return (error);
 106 }
 107
 108 typedef struct dsl_bookmark_create_arg {
 109         nvlist_t *dbca_bmarks;
 110         nvlist_t *dbca_errors;
 111 } dsl_bookmark_create_arg_t;
 112
 113 static int
 114 dsl_bookmark_create_check_impl(dsl_dataset_t *snapds, const char *bookmark_name,
 115     dmu_tx_t *tx)
 116 {
 117         dsl_pool_t *dp = dmu_tx_pool(tx);
 118         dsl_dataset_t *bmark_fs;
 119         char *shortname;
 120         int error;
 121         zfs_bookmark_phys_t bmark_phys;
 122
 123         if (!snapds->ds_is_snapshot)
 124                 return (SET_ERROR(EINVAL));
 125
 126         error = dsl_bookmark_hold_ds(dp, bookmark_name,
 127             &bmark_fs, FTAG, &shortname);
 128         if (error != 0)
 129                 return (error);
 130
 131         if (!dsl_dataset_is_before(bmark_fs, snapds, 0)) {
 132                 dsl_dataset_rele(bmark_fs, FTAG);
 133                 return (SET_ERROR(EINVAL));
 134         }
 135
 136         error = dsl_dataset_bmark_lookup(bmark_fs, shortname,
 137             &bmark_phys);
 138         dsl_dataset_rele(bmark_fs, FTAG);
 139         if (error == 0)
 140                 return (SET_ERROR(EEXIST));
 141         if (error == ESRCH)
 142                 return (0);
 143         return (error);
 144 }
 145
 146 static int
 147 dsl_bookmark_create_check(void *arg, dmu_tx_t *tx)
 148 {
 149         dsl_bookmark_create_arg_t *dbca = arg;
 150         dsl_pool_t *dp = dmu_tx_pool(tx);
 151         int rv = 0;
 152         nvpair_t *pair;
 153
 154         if (!spa_feature_is_enabled(dp->dp_spa, SPA_FEATURE_BOOKMARKS))
 155                 return (SET_ERROR(ENOTSUP));
 156
 157         for (pair = nvlist_next_nvpair(dbca->dbca_bmarks, NULL);
 158             pair != NULL; pair = nvlist_next_nvpair(dbca->dbca_bmarks, pair)) {
 159                 dsl_dataset_t *snapds;
 160                 int error;
 161
 162                 /* note: validity of nvlist checked by ioctl layer */
 163                 error = dsl_dataset_hold(dp, fnvpair_value_string(pair),
 164                     FTAG, &snapds);
 165                 if (error == 0) {
 166                         error = dsl_bookmark_create_check_impl(snapds,
 167                             nvpair_name(pair), tx);
 168                         dsl_dataset_rele(snapds, FTAG);
 169                 }
 170                 if (error != 0) {
 171                         fnvlist_add_int32(dbca->dbca_errors,
 172                             nvpair_name(pair), error);
 173                         rv = error;
 174                 }
 175         }
 176
 177         return (rv);
 178 }
 179
 180 static void
 181 dsl_bookmark_create_sync(void *arg, dmu_tx_t *tx)
 182 {
 183         dsl_bookmark_create_arg_t *dbca = arg;
 184         dsl_pool_t *dp = dmu_tx_pool(tx);
 185         objset_t *mos = dp->dp_meta_objset;
 186         nvpair_t *pair;
 187
 188         ASSERT(spa_feature_is_enabled(dp->dp_spa, SPA_FEATURE_BOOKMARKS));
 189
 190         for (pair = nvlist_next_nvpair(dbca->dbca_bmarks, NULL);
 191             pair != NULL; pair = nvlist_next_nvpair(dbca->dbca_bmarks, pair)) {
 192                 dsl_dataset_t *snapds, *bmark_fs;
 193                 zfs_bookmark_phys_t bmark_phys;
 194                 char *shortname;
 195
 196                 VERIFY0(dsl_dataset_hold(dp, fnvpair_value_string(pair),
 197                     FTAG, &snapds));
 198                 VERIFY0(dsl_bookmark_hold_ds(dp, nvpair_name(pair),
 199                     &bmark_fs, FTAG, &shortname));
 200                 if (bmark_fs->ds_bookmarks == 0) {
 201                         bmark_fs->ds_bookmarks =
 202                             zap_create_norm(mos, U8_TEXTPREP_TOUPPER,
 203                             DMU_OTN_ZAP_METADATA, DMU_OT_NONE, 0, tx);
 204                         spa_feature_incr(dp->dp_spa, SPA_FEATURE_BOOKMARKS, tx);
 205
 206                         dsl_dataset_zapify(bmark_fs, tx);
 207                         VERIFY0(zap_add(mos, bmark_fs->ds_object,
 208                             DS_FIELD_BOOKMARK_NAMES,
 209                             sizeof (bmark_fs->ds_bookmarks), 1,
 210                             &bmark_fs->ds_bookmarks, tx));
 211                 }
 212
 213                 bmark_phys.zbm_guid = dsl_dataset_phys(snapds)->ds_guid;
 214                 bmark_phys.zbm_creation_txg =
 215                     dsl_dataset_phys(snapds)->ds_creation_txg;
 216                 bmark_phys.zbm_creation_time =
 217                     dsl_dataset_phys(snapds)->ds_creation_time;
 218
 219                 VERIFY0(zap_add(mos, bmark_fs->ds_bookmarks,
 220                     shortname, sizeof (uint64_t),
 221                     sizeof (zfs_bookmark_phys_t) / sizeof (uint64_t),
 222                     &bmark_phys, tx));
 223
 224                 spa_history_log_internal_ds(bmark_fs, "bookmark", tx,
 225                     "name=%s creation_txg=%llu target_snap=%llu",
 226                     shortname,
 227                     (longlong_t)bmark_phys.zbm_creation_txg,
 228                     (longlong_t)snapds->ds_object);
 229
 230                 dsl_dataset_rele(bmark_fs, FTAG);
 231                 dsl_dataset_rele(snapds, FTAG);
 232         }
 233 }
 234
 235 /*
 236  * The bookmarks must all be in the same pool.
 237  */
 238 int
 239 dsl_bookmark_create(nvlist_t *bmarks, nvlist_t *errors)
 240 {
 241         nvpair_t *pair;
 242         dsl_bookmark_create_arg_t dbca;
 243
 244         pair = nvlist_next_nvpair(bmarks, NULL);
 245         if (pair == NULL)
 246                 return (0);
 247
 248         dbca.dbca_bmarks = bmarks;
 249         dbca.dbca_errors = errors;
 250
 251         return (dsl_sync_task(nvpair_name(pair), dsl_bookmark_create_check,
 252             dsl_bookmark_create_sync, &dbca, fnvlist_num_pairs(bmarks)));
 253 }
 254
 255 int
 256 dsl_get_bookmarks_impl(dsl_dataset_t *ds, nvlist_t *props, nvlist_t *outnvl)
 257 {
 258         int err = 0;
 259         zap_cursor_t zc;
 260         zap_attribute_t attr;
 261         dsl_pool_t *dp = ds->ds_dir->dd_pool;
 262
 263         uint64_t bmark_zapobj = ds->ds_bookmarks;
 264         if (bmark_zapobj == 0)
 265                 return (0);
 266
 267         for (zap_cursor_init(&zc, dp->dp_meta_objset, bmark_zapobj);
 268             zap_cursor_retrieve(&zc, &attr) == 0;
 269             zap_cursor_advance(&zc)) {
 270                 nvlist_t *out_props;
 271                 char *bmark_name = attr.za_name;
 272                 zfs_bookmark_phys_t bmark_phys;
 273
 274                 err = dsl_dataset_bmark_lookup(ds, bmark_name, &bmark_phys);
 275                 ASSERT3U(err, !=, ENOENT);
 276                 if (err != 0)
 277                         break;
 278
 279                 out_props = fnvlist_alloc();
 280                 if (nvlist_exists(props,
 281                     zfs_prop_to_name(ZFS_PROP_GUID))) {
 282                         dsl_prop_nvlist_add_uint64(out_props,
 283                             ZFS_PROP_GUID, bmark_phys.zbm_guid);
 284                 }
 285                 if (nvlist_exists(props,
 286                     zfs_prop_to_name(ZFS_PROP_CREATETXG))) {
 287                         dsl_prop_nvlist_add_uint64(out_props,
 288                             ZFS_PROP_CREATETXG, bmark_phys.zbm_creation_txg);
 289                 }
 290                 if (nvlist_exists(props,
 291                     zfs_prop_to_name(ZFS_PROP_CREATION))) {
 292                         dsl_prop_nvlist_add_uint64(out_props,
 293                             ZFS_PROP_CREATION, bmark_phys.zbm_creation_time);
 294                 }
 295
 296                 fnvlist_add_nvlist(outnvl, bmark_name, out_props);
 297                 fnvlist_free(out_props);
 298         }
 299         zap_cursor_fini(&zc);
 300         return (err);
 301 }
 302
 303 /*
 304  * Retrieve the bookmarks that exist in the specified dataset, and the
 305  * requested properties of each bookmark.
 306  *
 307  * The "props" nvlist specifies which properties are requested.
 308  * See lzc_get_bookmarks() for the list of valid properties.
 309  */
 310 int
 311 dsl_get_bookmarks(const char *dsname, nvlist_t *props, nvlist_t *outnvl)
 312 {
 313         dsl_pool_t *dp;
 314         dsl_dataset_t *ds;
 315         int err;
 316
 317         err = dsl_pool_hold(dsname, FTAG, &dp);
 318         if (err != 0)
 319                 return (err);
 320         err = dsl_dataset_hold(dp, dsname, FTAG, &ds);
 321         if (err != 0) {
 322                 dsl_pool_rele(dp, FTAG);
 323                 return (err);
 324         }
 325
 326         err = dsl_get_bookmarks_impl(ds, props, outnvl);
 327
 328         dsl_dataset_rele(ds, FTAG);
 329         dsl_pool_rele(dp, FTAG);
 330         return (err);
 331 }
 332
 333 typedef struct dsl_bookmark_destroy_arg {
 334         nvlist_t *dbda_bmarks;
 335         nvlist_t *dbda_success;
 336         nvlist_t *dbda_errors;
 337 } dsl_bookmark_destroy_arg_t;
 338
 339 static int
 340 dsl_dataset_bookmark_remove(dsl_dataset_t *ds, const char *name, dmu_tx_t *tx)
 341 {
 342         objset_t *mos = ds->ds_dir->dd_pool->dp_meta_objset;
 343         uint64_t bmark_zapobj = ds->ds_bookmarks;
 344         matchtype_t mt;
 345
 346         if (dsl_dataset_phys(ds)->ds_flags & DS_FLAG_CI_DATASET)
 347                 mt = MT_FIRST;
 348         else
 349                 mt = MT_EXACT;
 350
 351         return (zap_remove_norm(mos, bmark_zapobj, name, mt, tx));
 352 }
 353
 354 static int
 355 dsl_bookmark_destroy_check(void *arg, dmu_tx_t *tx)
 356 {
 357         dsl_bookmark_destroy_arg_t *dbda = arg;
 358         dsl_pool_t *dp = dmu_tx_pool(tx);
 359         int rv = 0;
 360         nvpair_t *pair;
 361
 362         if (!spa_feature_is_enabled(dp->dp_spa, SPA_FEATURE_BOOKMARKS))
 363                 return (0);
 364
 365         for (pair = nvlist_next_nvpair(dbda->dbda_bmarks, NULL);
 366             pair != NULL; pair = nvlist_next_nvpair(dbda->dbda_bmarks, pair)) {
 367                 const char *fullname = nvpair_name(pair);
 368                 dsl_dataset_t *ds;
 369                 zfs_bookmark_phys_t bm;
 370                 int error;
 371                 char *shortname;
 372
 373                 error = dsl_bookmark_hold_ds(dp, fullname, &ds,
 374                     FTAG, &shortname);
 375                 if (error == ENOENT) {
 376                         /* ignore it; the bookmark is "already destroyed" */
 377                         continue;
 378                 }
 379                 if (error == 0) {
 380                         error = dsl_dataset_bmark_lookup(ds, shortname, &bm);
 381                         dsl_dataset_rele(ds, FTAG);
 382                         if (error == ESRCH) {
 383                                 /*
 384                                  * ignore it; the bookmark is
 385                                  * "already destroyed"
 386                                  */
 387                                 continue;
 388                         }
 389                 }
 390                 if (error == 0) {
 391                         fnvlist_add_boolean(dbda->dbda_success, fullname);
 392                 } else {
 393                         fnvlist_add_int32(dbda->dbda_errors, fullname, error);
 394                         rv = error;
 395                 }
 396         }
 397         return (rv);
 398 }
 399
 400 static void
 401 dsl_bookmark_destroy_sync(void *arg, dmu_tx_t *tx)
 402 {
 403         dsl_bookmark_destroy_arg_t *dbda = arg;
 404         dsl_pool_t *dp = dmu_tx_pool(tx);
 405         objset_t *mos = dp->dp_meta_objset;
 406         nvpair_t *pair;
 407
 408         for (pair = nvlist_next_nvpair(dbda->dbda_success, NULL);
 409             pair != NULL; pair = nvlist_next_nvpair(dbda->dbda_success, pair)) {
 410                 dsl_dataset_t *ds;
 411                 char *shortname;
 412                 uint64_t zap_cnt;
 413
 414                 VERIFY0(dsl_bookmark_hold_ds(dp, nvpair_name(pair),
 415                     &ds, FTAG, &shortname));
 416                 VERIFY0(dsl_dataset_bookmark_remove(ds, shortname, tx));
 417
 418                 /*
 419                  * If all of this dataset's bookmarks have been destroyed,
 420                  * free the zap object and decrement the feature's use count.
 421                  */
 422                 VERIFY0(zap_count(mos, ds->ds_bookmarks,
 423                     &zap_cnt));
 424                 if (zap_cnt == 0) {
 425                         dmu_buf_will_dirty(ds->ds_dbuf, tx);
 426                         VERIFY0(zap_destroy(mos, ds->ds_bookmarks, tx));
 427                         ds->ds_bookmarks = 0;
 428                         spa_feature_decr(dp->dp_spa, SPA_FEATURE_BOOKMARKS, tx);
 429                         VERIFY0(zap_remove(mos, ds->ds_object,
 430                             DS_FIELD_BOOKMARK_NAMES, tx));
 431                 }
 432
 433                 spa_history_log_internal_ds(ds, "remove bookmark", tx,
 434                     "name=%s", shortname);
 435
 436                 dsl_dataset_rele(ds, FTAG);
 437         }
 438 }
 439
 440 /*
 441  * The bookmarks must all be in the same pool.
 442  */
 443 int
 444 dsl_bookmark_destroy(nvlist_t *bmarks, nvlist_t *errors)
 445 {
 446         int rv;
 447         dsl_bookmark_destroy_arg_t dbda;
 448         nvpair_t *pair = nvlist_next_nvpair(bmarks, NULL);
 449         if (pair == NULL)
 450                 return (0);
 451
 452         dbda.dbda_bmarks = bmarks;
 453         dbda.dbda_errors = errors;
 454         dbda.dbda_success = fnvlist_alloc();
 455
 456         rv = dsl_sync_task(nvpair_name(pair), dsl_bookmark_destroy_check,
 457             dsl_bookmark_destroy_sync, &dbda, fnvlist_num_pairs(bmarks));
 458         fnvlist_free(dbda.dbda_success);
 459         return (rv);
 460 }