1168404Spjd/* 2168404Spjd * CDDL HEADER START 3168404Spjd * 4168404Spjd * The contents of this file are subject to the terms of the 5168404Spjd * Common Development and Distribution License (the "License"). 6168404Spjd * You may not use this file except in compliance with the License. 7168404Spjd * 8168404Spjd * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9168404Spjd * or http://www.opensolaris.org/os/licensing. 10168404Spjd * See the License for the specific language governing permissions 11168404Spjd * and limitations under the License. 12168404Spjd * 13168404Spjd * When distributing Covered Code, include this CDDL HEADER in each 14168404Spjd * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15168404Spjd * If applicable, add the following below this CDDL HEADER, with the 16168404Spjd * fields enclosed by brackets "[]" replaced with your own identifying 17168404Spjd * information: Portions Copyright [yyyy] [name of copyright owner] 18168404Spjd * 19168404Spjd * CDDL HEADER END 20168404Spjd */ 21168404Spjd/* 22219089Spjd * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. 23286575Smav * Copyright (c) 2014 Spectra Logic Corporation, All rights reserved. 24296519Smav * Copyright (c) 2014 Integros [integros.com] 25168404Spjd */ 26168404Spjd 27168404Spjd#ifndef _SYS_ZAP_IMPL_H 28168404Spjd#define _SYS_ZAP_IMPL_H 29168404Spjd 30168404Spjd#include <sys/zap.h> 31168404Spjd#include <sys/zfs_context.h> 32168404Spjd#include <sys/avl.h> 33168404Spjd 34168404Spjd#ifdef __cplusplus 35168404Spjdextern "C" { 36168404Spjd#endif 37168404Spjd 38168404Spjdextern int fzap_default_block_shift; 39168404Spjd 40168404Spjd#define ZAP_MAGIC 0x2F52AB2ABULL 41168404Spjd 42168404Spjd#define FZAP_BLOCK_SHIFT(zap) ((zap)->zap_f.zap_block_shift) 43168404Spjd 44168404Spjd#define MZAP_ENT_LEN 64 45168404Spjd#define MZAP_NAME_LEN (MZAP_ENT_LEN - 8 - 4 - 2) 46274337Sdelphij#define MZAP_MAX_BLKSZ SPA_OLD_MAXBLOCKSIZE 47168404Spjd 48219089Spjd#define ZAP_NEED_CD (-1U) 49219089Spjd 50168404Spjdtypedef struct mzap_ent_phys { 51168404Spjd uint64_t mze_value; 52168404Spjd uint32_t mze_cd; 53168404Spjd uint16_t mze_pad; /* in case we want to chain them someday */ 54168404Spjd char mze_name[MZAP_NAME_LEN]; 55168404Spjd} mzap_ent_phys_t; 56168404Spjd 57168404Spjdtypedef struct mzap_phys { 58168404Spjd uint64_t mz_block_type; /* ZBT_MICRO */ 59168404Spjd uint64_t mz_salt; 60185029Spjd uint64_t mz_normflags; 61185029Spjd uint64_t mz_pad[5]; 62168404Spjd mzap_ent_phys_t mz_chunk[1]; 63168404Spjd /* actually variable size depending on block size */ 64168404Spjd} mzap_phys_t; 65168404Spjd 66168404Spjdtypedef struct mzap_ent { 67168404Spjd avl_node_t mze_node; 68168404Spjd int mze_chunkid; 69168404Spjd uint64_t mze_hash; 70219089Spjd uint32_t mze_cd; /* copy from mze_phys->mze_cd */ 71168404Spjd} mzap_ent_t; 72168404Spjd 73219089Spjd#define MZE_PHYS(zap, mze) \ 74275782Sdelphij (&zap_m_phys(zap)->mz_chunk[(mze)->mze_chunkid]) 75168404Spjd 76168404Spjd/* 77168404Spjd * The (fat) zap is stored in one object. It is an array of 78168404Spjd * 1<<FZAP_BLOCK_SHIFT byte blocks. The layout looks like one of: 79168404Spjd * 80168404Spjd * ptrtbl fits in first block: 81168404Spjd * [zap_phys_t zap_ptrtbl_shift < 6] [zap_leaf_t] ... 82168404Spjd * 83168404Spjd * ptrtbl too big for first block: 84168404Spjd * [zap_phys_t zap_ptrtbl_shift >= 6] [zap_leaf_t] [ptrtbl] ... 85168404Spjd * 86168404Spjd */ 87168404Spjd 88168404Spjdstruct dmu_buf; 89168404Spjdstruct zap_leaf; 90168404Spjd 91168404Spjd#define ZBT_LEAF ((1ULL << 63) + 0) 92168404Spjd#define ZBT_HEADER ((1ULL << 63) + 1) 93168404Spjd#define ZBT_MICRO ((1ULL << 63) + 3) 94168404Spjd/* any other values are ptrtbl blocks */ 95168404Spjd 96168404Spjd/* 97168404Spjd * the embedded pointer table takes up half a block: 98168404Spjd * block size / entry size (2^3) / 2 99168404Spjd */ 100168404Spjd#define ZAP_EMBEDDED_PTRTBL_SHIFT(zap) (FZAP_BLOCK_SHIFT(zap) - 3 - 1) 101168404Spjd 102168404Spjd/* 103168404Spjd * The embedded pointer table starts half-way through the block. Since 104168404Spjd * the pointer table itself is half the block, it starts at (64-bit) 105168404Spjd * word number (1<<ZAP_EMBEDDED_PTRTBL_SHIFT(zap)). 106168404Spjd */ 107168404Spjd#define ZAP_EMBEDDED_PTRTBL_ENT(zap, idx) \ 108275782Sdelphij ((uint64_t *)zap_f_phys(zap)) \ 109168404Spjd [(idx) + (1<<ZAP_EMBEDDED_PTRTBL_SHIFT(zap))] 110168404Spjd 111168404Spjd/* 112168404Spjd * TAKE NOTE: 113168404Spjd * If zap_phys_t is modified, zap_byteswap() must be modified. 114168404Spjd */ 115168404Spjdtypedef struct zap_phys { 116168404Spjd uint64_t zap_block_type; /* ZBT_HEADER */ 117168404Spjd uint64_t zap_magic; /* ZAP_MAGIC */ 118168404Spjd 119168404Spjd struct zap_table_phys { 120168404Spjd uint64_t zt_blk; /* starting block number */ 121168404Spjd uint64_t zt_numblks; /* number of blocks */ 122168404Spjd uint64_t zt_shift; /* bits to index it */ 123168404Spjd uint64_t zt_nextblk; /* next (larger) copy start block */ 124168404Spjd uint64_t zt_blks_copied; /* number source blocks copied */ 125168404Spjd } zap_ptrtbl; 126168404Spjd 127168404Spjd uint64_t zap_freeblk; /* the next free block */ 128168404Spjd uint64_t zap_num_leafs; /* number of leafs */ 129168404Spjd uint64_t zap_num_entries; /* number of entries */ 130168404Spjd uint64_t zap_salt; /* salt to stir into hash function */ 131185029Spjd uint64_t zap_normflags; /* flags for u8_textprep_str() */ 132219089Spjd uint64_t zap_flags; /* zap_flags_t */ 133168404Spjd /* 134168404Spjd * This structure is followed by padding, and then the embedded 135168404Spjd * pointer table. The embedded pointer table takes up second 136168404Spjd * half of the block. It is accessed using the 137168404Spjd * ZAP_EMBEDDED_PTRTBL_ENT() macro. 138168404Spjd */ 139168404Spjd} zap_phys_t; 140168404Spjd 141168404Spjdtypedef struct zap_table_phys zap_table_phys_t; 142168404Spjd 143168404Spjdtypedef struct zap { 144286575Smav dmu_buf_user_t zap_dbu; 145168404Spjd objset_t *zap_objset; 146168404Spjd uint64_t zap_object; 147168404Spjd struct dmu_buf *zap_dbuf; 148168404Spjd krwlock_t zap_rwlock; 149185029Spjd boolean_t zap_ismicro; 150185029Spjd int zap_normflags; 151168404Spjd uint64_t zap_salt; 152168404Spjd union { 153168404Spjd struct { 154168404Spjd /* 155168404Spjd * zap_num_entries_mtx protects 156168404Spjd * zap_num_entries 157168404Spjd */ 158168404Spjd kmutex_t zap_num_entries_mtx; 159168404Spjd int zap_block_shift; 160168404Spjd } zap_fat; 161168404Spjd struct { 162168404Spjd int16_t zap_num_entries; 163168404Spjd int16_t zap_num_chunks; 164168404Spjd int16_t zap_alloc_next; 165168404Spjd avl_tree_t zap_avl; 166168404Spjd } zap_micro; 167168404Spjd } zap_u; 168168404Spjd} zap_t; 169168404Spjd 170275782Sdelphijinline zap_phys_t * 171275782Sdelphijzap_f_phys(zap_t *zap) 172275782Sdelphij{ 173275782Sdelphij return (zap->zap_dbuf->db_data); 174275782Sdelphij} 175275782Sdelphij 176275782Sdelphijinline mzap_phys_t * 177275782Sdelphijzap_m_phys(zap_t *zap) 178275782Sdelphij{ 179275782Sdelphij return (zap->zap_dbuf->db_data); 180275782Sdelphij} 181275782Sdelphij 182185029Spjdtypedef struct zap_name { 183185029Spjd zap_t *zn_zap; 184219089Spjd int zn_key_intlen; 185219089Spjd const void *zn_key_orig; 186219089Spjd int zn_key_orig_numints; 187219089Spjd const void *zn_key_norm; 188219089Spjd int zn_key_norm_numints; 189185029Spjd uint64_t zn_hash; 190185029Spjd matchtype_t zn_matchtype; 191185029Spjd char zn_normbuf[ZAP_MAXNAMELEN]; 192185029Spjd} zap_name_t; 193185029Spjd 194168404Spjd#define zap_f zap_u.zap_fat 195168404Spjd#define zap_m zap_u.zap_micro 196168404Spjd 197185029Spjdboolean_t zap_match(zap_name_t *zn, const char *matchname); 198168404Spjdint zap_lockdir(objset_t *os, uint64_t obj, dmu_tx_t *tx, 199185029Spjd krw_t lti, boolean_t fatreader, boolean_t adding, zap_t **zapp); 200168404Spjdvoid zap_unlockdir(zap_t *zap); 201286575Smavvoid zap_evict(void *dbu); 202219089Spjdzap_name_t *zap_name_alloc(zap_t *zap, const char *key, matchtype_t mt); 203185029Spjdvoid zap_name_free(zap_name_t *zn); 204219089Spjdint zap_hashbits(zap_t *zap); 205219089Spjduint32_t zap_maxcd(zap_t *zap); 206219089Spjduint64_t zap_getflags(zap_t *zap); 207168404Spjd 208168404Spjd#define ZAP_HASH_IDX(hash, n) (((n) == 0) ? 0 : ((hash) >> (64 - (n)))) 209168404Spjd 210168404Spjdvoid fzap_byteswap(void *buf, size_t size); 211168404Spjdint fzap_count(zap_t *zap, uint64_t *count); 212185029Spjdint fzap_lookup(zap_name_t *zn, 213185029Spjd uint64_t integer_size, uint64_t num_integers, void *buf, 214185029Spjd char *realname, int rn_len, boolean_t *normalization_conflictp); 215219089Spjdvoid fzap_prefetch(zap_name_t *zn); 216209962Smmint fzap_count_write(zap_name_t *zn, int add, uint64_t *towrite, 217209962Smm uint64_t *tooverwrite); 218185029Spjdint fzap_add(zap_name_t *zn, uint64_t integer_size, uint64_t num_integers, 219168404Spjd const void *val, dmu_tx_t *tx); 220185029Spjdint fzap_update(zap_name_t *zn, 221168404Spjd int integer_size, uint64_t num_integers, const void *val, dmu_tx_t *tx); 222185029Spjdint fzap_length(zap_name_t *zn, 223168404Spjd uint64_t *integer_size, uint64_t *num_integers); 224185029Spjdint fzap_remove(zap_name_t *zn, dmu_tx_t *tx); 225168404Spjdint fzap_cursor_retrieve(zap_t *zap, zap_cursor_t *zc, zap_attribute_t *za); 226168404Spjdvoid fzap_get_stats(zap_t *zap, zap_stats_t *zs); 227168404Spjdvoid zap_put_leaf(struct zap_leaf *l); 228168404Spjd 229185029Spjdint fzap_add_cd(zap_name_t *zn, 230168404Spjd uint64_t integer_size, uint64_t num_integers, 231168404Spjd const void *val, uint32_t cd, dmu_tx_t *tx); 232219089Spjdvoid fzap_upgrade(zap_t *zap, dmu_tx_t *tx, zap_flags_t flags); 233219089Spjdint fzap_cursor_move_to_key(zap_cursor_t *zc, zap_name_t *zn); 234168404Spjd 235168404Spjd#ifdef __cplusplus 236168404Spjd} 237168404Spjd#endif 238168404Spjd 239168404Spjd#endif /* _SYS_ZAP_IMPL_H */ 240