include/sys/dbuf.h

   1 /*
   2  * CDDL HEADER START
   3  *
   4  * The contents of this file are subject to the terms of the
   5  * Common Development and Distribution License (the "License").
   6  * You may not use this file except in compliance with the License.
   7  *
   8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9  * or https://opensource.org/licenses/CDDL-1.0.
  10  * See the License for the specific language governing permissions
  11  * and limitations under the License.
  12  *
  13  * When distributing Covered Code, include this CDDL HEADER in each
  14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15  * If applicable, add the following below this CDDL HEADER, with the
  16  * fields enclosed by brackets "[]" replaced with your own identifying
  17  * information: Portions Copyright [yyyy] [name of copyright owner]
  18  *
  19  * CDDL HEADER END
  20  */
  21 /*
  22  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
  23  * Copyright (c) 2012, 2020 by Delphix. All rights reserved.
  24  * Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
  25  * Copyright (c) 2014 Spectra Logic Corporation, All rights reserved.
  26  */
  27
  28 #ifndef _SYS_DBUF_H
  29 #define _SYS_DBUF_H
  30
  31 #include <sys/dmu.h>
  32 #include <sys/spa.h>
  33 #include <sys/txg.h>
  34 #include <sys/zio.h>
  35 #include <sys/arc.h>
  36 #include <sys/zfs_context.h>
  37 #include <sys/zfs_refcount.h>
  38 #include <sys/zrlock.h>
  39 #include <sys/multilist.h>
  40
  41 #ifdef  __cplusplus
  42 extern "C" {
  43 #endif
  44
  45 #define IN_DMU_SYNC 2
  46
  47 /*
  48  * define flags for dbuf_read
  49  */
  50
  51 #define DB_RF_MUST_SUCCEED      (1 << 0)
  52 #define DB_RF_CANFAIL           (1 << 1)
  53 #define DB_RF_HAVESTRUCT        (1 << 2)
  54 #define DB_RF_NOPREFETCH        (1 << 3)
  55 #define DB_RF_NEVERWAIT         (1 << 4)
  56 #define DB_RF_CACHED            (1 << 5)
  57 #define DB_RF_NO_DECRYPT        (1 << 6)
  58 #define DB_RF_PARTIAL_FIRST     (1 << 7)
  59 #define DB_RF_PARTIAL_MORE      (1 << 8)
  60
  61 /*
  62  * The simplified state transition diagram for dbufs looks like:
  63  *
  64  *                  +--> READ --+
  65  *                  |           |
  66  *                  |           V
  67  *  (alloc)-->UNCACHED       CACHED-->EVICTING-->(free)
  68  *             ^    |           ^        ^
  69  *             |    |           |        |
  70  *             |    +--> FILL --+        |
  71  *             |    |                    |
  72  *             |    |                    |
  73  *             |    +------> NOFILL -----+
  74  *             |               |
  75  *             +---------------+
  76  *
  77  * DB_SEARCH is an invalid state for a dbuf. It is used by dbuf_free_range
  78  * to find all dbufs in a range of a dnode and must be less than any other
  79  * dbuf_states_t (see comment on dn_dbufs in dnode.h).
  80  */
  81 typedef enum dbuf_states {
  82         DB_SEARCH = -1,
  83         DB_UNCACHED,
  84         DB_FILL,
  85         DB_NOFILL,
  86         DB_READ,
  87         DB_CACHED,
  88         DB_EVICTING
  89 } dbuf_states_t;
  90
  91 typedef enum dbuf_cached_state {
  92         DB_NO_CACHE = -1,
  93         DB_DBUF_CACHE,
  94         DB_DBUF_METADATA_CACHE,
  95         DB_CACHE_MAX
  96 } dbuf_cached_state_t;
  97
  98 struct dnode;
  99 struct dmu_tx;
 100
 101 /*
 102  * level = 0 means the user data
 103  * level = 1 means the single indirect block
 104  * etc.
 105  */
 106
 107 struct dmu_buf_impl;
 108
 109 typedef enum override_states {
 110         DR_NOT_OVERRIDDEN,
 111         DR_IN_DMU_SYNC,
 112         DR_OVERRIDDEN
 113 } override_states_t;
 114
 115 typedef enum db_lock_type {
 116         DLT_NONE,
 117         DLT_PARENT,
 118         DLT_OBJSET
 119 } db_lock_type_t;
 120
 121 typedef struct dbuf_dirty_record {
 122         /* link on our parents dirty list */
 123         list_node_t dr_dirty_node;
 124
 125         /* transaction group this data will sync in */
 126         uint64_t dr_txg;
 127
 128         /* zio of outstanding write IO */
 129         zio_t *dr_zio;
 130
 131         /* pointer back to our dbuf */
 132         struct dmu_buf_impl *dr_dbuf;
 133
 134         /* list link for dbuf dirty records */
 135         list_node_t dr_dbuf_node;
 136
 137         /*
 138          * The dnode we are part of.  Note that the dnode can not be moved or
 139          * evicted due to the hold that's added by dnode_setdirty() or
 140          * dmu_objset_sync_dnodes(), and released by dnode_rele_task() or
 141          * userquota_updates_task().  This hold is necessary for
 142          * dirty_lightweight_leaf-type dirty records, which don't have a hold
 143          * on a dbuf.
 144          */
 145         dnode_t *dr_dnode;
 146
 147         /* pointer to parent dirty record */
 148         struct dbuf_dirty_record *dr_parent;
 149
 150         /* How much space was changed to dsl_pool_dirty_space() for this? */
 151         unsigned int dr_accounted;
 152
 153         /* A copy of the bp that points to us */
 154         blkptr_t dr_bp_copy;
 155
 156         union dirty_types {
 157                 struct dirty_indirect {
 158
 159                         /* protect access to list */
 160                         kmutex_t dr_mtx;
 161
 162                         /* Our list of dirty children */
 163                         list_t dr_children;
 164                 } di;
 165                 struct dirty_leaf {
 166
 167                         /*
 168                          * dr_data is set when we dirty the buffer
 169                          * so that we can retain the pointer even if it
 170                          * gets COW'd in a subsequent transaction group.
 171                          */
 172                         arc_buf_t *dr_data;
 173                         blkptr_t dr_overridden_by;
 174                         override_states_t dr_override_state;
 175                         uint8_t dr_copies;
 176                         boolean_t dr_nopwrite;
 177                         boolean_t dr_brtwrite;
 178                         boolean_t dr_has_raw_params;
 179
 180                         /*
 181                          * If dr_has_raw_params is set, the following crypt
 182                          * params will be set on the BP that's written.
 183                          */
 184                         boolean_t dr_byteorder;
 185                         uint8_t dr_salt[ZIO_DATA_SALT_LEN];
 186                         uint8_t dr_iv[ZIO_DATA_IV_LEN];
 187                         uint8_t dr_mac[ZIO_DATA_MAC_LEN];
 188                 } dl;
 189                 struct dirty_lightweight_leaf {
 190                         /*
 191                          * This dirty record refers to a leaf (level=0)
 192                          * block, whose dbuf has not been instantiated for
 193                          * performance reasons.
 194                          */
 195                         uint64_t dr_blkid;
 196                         abd_t *dr_abd;
 197                         zio_prop_t dr_props;
 198                         zio_flag_t dr_flags;
 199                 } dll;
 200         } dt;
 201 } dbuf_dirty_record_t;
 202
 203 typedef struct dmu_buf_impl {
 204         /*
 205          * The following members are immutable, with the exception of
 206          * db.db_data, which is protected by db_mtx.
 207          */
 208
 209         /* the publicly visible structure */
 210         dmu_buf_t db;
 211
 212         /* the objset we belong to */
 213         struct objset *db_objset;
 214
 215         /*
 216          * handle to safely access the dnode we belong to (NULL when evicted)
 217          */
 218         struct dnode_handle *db_dnode_handle;
 219
 220         /*
 221          * our parent buffer; if the dnode points to us directly,
 222          * db_parent == db_dnode_handle->dnh_dnode->dn_dbuf
 223          * only accessed by sync thread ???
 224          * (NULL when evicted)
 225          * May change from NULL to non-NULL under the protection of db_mtx
 226          * (see dbuf_check_blkptr())
 227          */
 228         struct dmu_buf_impl *db_parent;
 229
 230         /*
 231          * link for hash table of all dmu_buf_impl_t's
 232          */
 233         struct dmu_buf_impl *db_hash_next;
 234
 235         /*
 236          * Our link on the owner dnodes's dn_dbufs list.
 237          * Protected by its dn_dbufs_mtx.  Should be on the same cache line
 238          * as db_level and db_blkid for the best avl_add() performance.
 239          */
 240         avl_node_t db_link;
 241
 242         /* our block number */
 243         uint64_t db_blkid;
 244
 245         /*
 246          * Pointer to the blkptr_t which points to us. May be NULL if we
 247          * don't have one yet. (NULL when evicted)
 248          */
 249         blkptr_t *db_blkptr;
 250
 251         /*
 252          * Our indirection level.  Data buffers have db_level==0.
 253          * Indirect buffers which point to data buffers have
 254          * db_level==1. etc.  Buffers which contain dnodes have
 255          * db_level==0, since the dnodes are stored in a file.
 256          */
 257         uint8_t db_level;
 258
 259         /*
 260          * Protects db_buf's contents if they contain an indirect block or data
 261          * block of the meta-dnode. We use this lock to protect the structure of
 262          * the block tree. This means that when modifying this dbuf's data, we
 263          * grab its rwlock. When modifying its parent's data (including the
 264          * blkptr to this dbuf), we grab the parent's rwlock. The lock ordering
 265          * for this lock is:
 266          * 1) dn_struct_rwlock
 267          * 2) db_rwlock
 268          * We don't currently grab multiple dbufs' db_rwlocks at once.
 269          */
 270         krwlock_t db_rwlock;
 271
 272         /* buffer holding our data */
 273         arc_buf_t *db_buf;
 274
 275         /* db_mtx protects the members below */
 276         kmutex_t db_mtx;
 277
 278         /*
 279          * Current state of the buffer
 280          */
 281         dbuf_states_t db_state;
 282
 283         /*
 284          * Refcount accessed by dmu_buf_{hold,rele}.
 285          * If nonzero, the buffer can't be destroyed.
 286          * Protected by db_mtx.
 287          */
 288         zfs_refcount_t db_holds;
 289
 290         kcondvar_t db_changed;
 291         dbuf_dirty_record_t *db_data_pending;
 292
 293         /* List of dirty records for the buffer sorted newest to oldest. */
 294         list_t db_dirty_records;
 295
 296         /* Link in dbuf_cache or dbuf_metadata_cache */
 297         multilist_node_t db_cache_link;
 298
 299         /* Tells us which dbuf cache this dbuf is in, if any */
 300         dbuf_cached_state_t db_caching_status;
 301
 302         uint64_t db_hash;
 303
 304         /* Data which is unique to data (leaf) blocks: */
 305
 306         /* User callback information. */
 307         dmu_buf_user_t *db_user;
 308
 309         /*
 310          * Evict user data as soon as the dirty and reference
 311          * counts are equal.
 312          */
 313         uint8_t db_user_immediate_evict;
 314
 315         /*
 316          * This block was freed while a read or write was
 317          * active.
 318          */
 319         uint8_t db_freed_in_flight;
 320
 321         /*
 322          * dnode_evict_dbufs() or dnode_evict_bonus() tried to
 323          * evict this dbuf, but couldn't due to outstanding
 324          * references.  Evict once the refcount drops to 0.
 325          */
 326         uint8_t db_pending_evict;
 327
 328         uint8_t db_dirtycnt;
 329
 330         /* The buffer was partially read.  More reads may follow. */
 331         uint8_t db_partial_read;
 332 } dmu_buf_impl_t;
 333
 334 #define DBUF_HASH_MUTEX(h, idx) \
 335         (&(h)->hash_mutexes[(idx) & ((h)->hash_mutex_mask)])
 336
 337 typedef struct dbuf_hash_table {
 338         uint64_t hash_table_mask;
 339         uint64_t hash_mutex_mask;
 340         dmu_buf_impl_t **hash_table;
 341         kmutex_t *hash_mutexes;
 342 } dbuf_hash_table_t;
 343
 344 typedef void (*dbuf_prefetch_fn)(void *, uint64_t, uint64_t, boolean_t);
 345
 346 uint64_t dbuf_whichblock(const struct dnode *di, const int64_t level,
 347     const uint64_t offset);
 348
 349 void dbuf_create_bonus(struct dnode *dn);
 350 int dbuf_spill_set_blksz(dmu_buf_t *db, uint64_t blksz, dmu_tx_t *tx);
 351
 352 void dbuf_rm_spill(struct dnode *dn, dmu_tx_t *tx);
 353
 354 dmu_buf_impl_t *dbuf_hold(struct dnode *dn, uint64_t blkid, const void *tag);
 355 dmu_buf_impl_t *dbuf_hold_level(struct dnode *dn, int level, uint64_t blkid,
 356     const void *tag);
 357 int dbuf_hold_impl(struct dnode *dn, uint8_t level, uint64_t blkid,
 358     boolean_t fail_sparse, boolean_t fail_uncached,
 359     const void *tag, dmu_buf_impl_t **dbp);
 360
 361 int dbuf_prefetch_impl(struct dnode *dn, int64_t level, uint64_t blkid,
 362     zio_priority_t prio, arc_flags_t aflags, dbuf_prefetch_fn cb,
 363     void *arg);
 364 int dbuf_prefetch(struct dnode *dn, int64_t level, uint64_t blkid,
 365     zio_priority_t prio, arc_flags_t aflags);
 366
 367 void dbuf_add_ref(dmu_buf_impl_t *db, const void *tag);
 368 boolean_t dbuf_try_add_ref(dmu_buf_t *db, objset_t *os, uint64_t obj,
 369     uint64_t blkid, const void *tag);
 370 uint64_t dbuf_refcount(dmu_buf_impl_t *db);
 371
 372 void dbuf_rele(dmu_buf_impl_t *db, const void *tag);
 373 void dbuf_rele_and_unlock(dmu_buf_impl_t *db, const void *tag,
 374     boolean_t evicting);
 375
 376 dmu_buf_impl_t *dbuf_find(struct objset *os, uint64_t object, uint8_t level,
 377     uint64_t blkid, uint64_t *hash_out);
 378
 379 int dbuf_read(dmu_buf_impl_t *db, zio_t *zio, uint32_t flags);
 380 void dmu_buf_will_clone(dmu_buf_t *db, dmu_tx_t *tx);
 381 void dmu_buf_will_not_fill(dmu_buf_t *db, dmu_tx_t *tx);
 382 void dmu_buf_will_fill(dmu_buf_t *db, dmu_tx_t *tx);
 383 void dmu_buf_fill_done(dmu_buf_t *db, dmu_tx_t *tx);
 384 void dbuf_assign_arcbuf(dmu_buf_impl_t *db, arc_buf_t *buf, dmu_tx_t *tx);
 385 dbuf_dirty_record_t *dbuf_dirty(dmu_buf_impl_t *db, dmu_tx_t *tx);
 386 dbuf_dirty_record_t *dbuf_dirty_lightweight(dnode_t *dn, uint64_t blkid,
 387     dmu_tx_t *tx);
 388 boolean_t dbuf_undirty(dmu_buf_impl_t *db, dmu_tx_t *tx);
 389 arc_buf_t *dbuf_loan_arcbuf(dmu_buf_impl_t *db);
 390 void dmu_buf_write_embedded(dmu_buf_t *dbuf, void *data,
 391     bp_embedded_type_t etype, enum zio_compress comp,
 392     int uncompressed_size, int compressed_size, int byteorder, dmu_tx_t *tx);
 393
 394 int dmu_lightweight_write_by_dnode(dnode_t *dn, uint64_t offset, abd_t *abd,
 395     const struct zio_prop *zp, zio_flag_t flags, dmu_tx_t *tx);
 396
 397 void dmu_buf_redact(dmu_buf_t *dbuf, dmu_tx_t *tx);
 398 void dbuf_destroy(dmu_buf_impl_t *db);
 399
 400 void dbuf_unoverride(dbuf_dirty_record_t *dr);
 401 void dbuf_sync_list(list_t *list, int level, dmu_tx_t *tx);
 402 void dbuf_release_bp(dmu_buf_impl_t *db);
 403 db_lock_type_t dmu_buf_lock_parent(dmu_buf_impl_t *db, krw_t rw,
 404     const void *tag);
 405 void dmu_buf_unlock_parent(dmu_buf_impl_t *db, db_lock_type_t type,
 406     const void *tag);
 407
 408 void dbuf_free_range(struct dnode *dn, uint64_t start, uint64_t end,
 409     struct dmu_tx *);
 410
 411 void dbuf_new_size(dmu_buf_impl_t *db, int size, dmu_tx_t *tx);
 412
 413 void dbuf_stats_init(dbuf_hash_table_t *hash);
 414 void dbuf_stats_destroy(void);
 415
 416 int dbuf_dnode_findbp(dnode_t *dn, uint64_t level, uint64_t blkid,
 417     blkptr_t *bp, uint16_t *datablkszsec, uint8_t *indblkshift);
 418
 419 #define DB_DNODE(_db)           ((_db)->db_dnode_handle->dnh_dnode)
 420 #define DB_DNODE_LOCK(_db)      ((_db)->db_dnode_handle->dnh_zrlock)
 421 #define DB_DNODE_ENTER(_db)     (zrl_add(&DB_DNODE_LOCK(_db)))
 422 #define DB_DNODE_EXIT(_db)      (zrl_remove(&DB_DNODE_LOCK(_db)))
 423 #define DB_DNODE_HELD(_db)      (!zrl_is_zero(&DB_DNODE_LOCK(_db)))
 424
 425 void dbuf_init(void);
 426 void dbuf_fini(void);
 427
 428 boolean_t dbuf_is_metadata(dmu_buf_impl_t *db);
 429
 430 static inline dbuf_dirty_record_t *
 431 dbuf_find_dirty_lte(dmu_buf_impl_t *db, uint64_t txg)
 432 {
 433         dbuf_dirty_record_t *dr;
 434
 435         for (dr = list_head(&db->db_dirty_records);
 436             dr != NULL && dr->dr_txg > txg;
 437             dr = list_next(&db->db_dirty_records, dr))
 438                 continue;
 439         return (dr);
 440 }
 441
 442 static inline dbuf_dirty_record_t *
 443 dbuf_find_dirty_eq(dmu_buf_impl_t *db, uint64_t txg)
 444 {
 445         dbuf_dirty_record_t *dr;
 446
 447         dr = dbuf_find_dirty_lte(db, txg);
 448         if (dr && dr->dr_txg == txg)
 449                 return (dr);
 450         return (NULL);
 451 }
 452
 453 #define DBUF_GET_BUFC_TYPE(_db) \
 454         (dbuf_is_metadata(_db) ? ARC_BUFC_METADATA : ARC_BUFC_DATA)
 455
 456 #define DBUF_IS_CACHEABLE(_db)                                          \
 457         ((_db)->db_objset->os_primary_cache == ZFS_CACHE_ALL ||         \
 458         (dbuf_is_metadata(_db) &&                                       \
 459         ((_db)->db_objset->os_primary_cache == ZFS_CACHE_METADATA)))
 460
 461 boolean_t dbuf_is_l2cacheable(dmu_buf_impl_t *db);
 462
 463 #ifdef ZFS_DEBUG
 464
 465 /*
 466  * There should be a ## between the string literal and fmt, to make it
 467  * clear that we're joining two strings together, but gcc does not
 468  * support that preprocessor token.
 469  */
 470 #define dprintf_dbuf(dbuf, fmt, ...) do { \
 471         if (zfs_flags & ZFS_DEBUG_DPRINTF) { \
 472         char __db_buf[32]; \
 473         uint64_t __db_obj = (dbuf)->db.db_object; \
 474         if (__db_obj == DMU_META_DNODE_OBJECT) \
 475                 (void) strlcpy(__db_buf, "mdn", sizeof (__db_buf));     \
 476         else \
 477                 (void) snprintf(__db_buf, sizeof (__db_buf), "%lld", \
 478                     (u_longlong_t)__db_obj); \
 479         dprintf_ds((dbuf)->db_objset->os_dsl_dataset, \
 480             "obj=%s lvl=%u blkid=%lld " fmt, \
 481             __db_buf, (dbuf)->db_level, \
 482             (u_longlong_t)(dbuf)->db_blkid, __VA_ARGS__); \
 483         } \
 484 } while (0)
 485
 486 #define dprintf_dbuf_bp(db, bp, fmt, ...) do {                  \
 487         if (zfs_flags & ZFS_DEBUG_DPRINTF) {                    \
 488         char *__blkbuf = kmem_alloc(BP_SPRINTF_LEN, KM_SLEEP);  \
 489         snprintf_blkptr(__blkbuf, BP_SPRINTF_LEN, bp);          \
 490         dprintf_dbuf(db, fmt " %s\n", __VA_ARGS__, __blkbuf);   \
 491         kmem_free(__blkbuf, BP_SPRINTF_LEN);                    \
 492         }                                                       \
 493 } while (0)
 494
 495 #define DBUF_VERIFY(db) dbuf_verify(db)
 496
 497 #else
 498
 499 #define dprintf_dbuf(db, fmt, ...)
 500 #define dprintf_dbuf_bp(db, bp, fmt, ...)
 501 #define DBUF_VERIFY(db)
 502
 503 #endif
 504
 505
 506 #ifdef  __cplusplus
 507 }
 508 #endif
 509
 510 #endif /* _SYS_DBUF_H */