1 // SPDX-License-Identifier: CDDL-1.0 2 /* 3 * CDDL HEADER START 4 * 5 * The contents of this file are subject to the terms of the 6 * Common Development and Distribution License (the "License"). 7 * You may not use this file except in compliance with the License. 8 * 9 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 10 * or https://opensource.org/licenses/CDDL-1.0. 11 * See the License for the specific language governing permissions 12 * and limitations under the License. 13 * 14 * When distributing Covered Code, include this CDDL HEADER in each 15 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 16 * If applicable, add the following below this CDDL HEADER, with the 17 * fields enclosed by brackets "[]" replaced with your own identifying 18 * information: Portions Copyright [yyyy] [name of copyright owner] 19 * 20 * CDDL HEADER END 21 */ 22 23 /* 24 * Copyright 2009 Sun Microsystems, Inc. All rights reserved. 25 * Use is subject to license terms. 26 */ 27 28 /* 29 * Copyright (c) 2013, 2017 by Delphix. All rights reserved. 30 */ 31 32 #ifndef _SYS_TXG_IMPL_H 33 #define _SYS_TXG_IMPL_H 34 35 #include <sys/spa.h> 36 #include <sys/txg.h> 37 38 #ifdef __cplusplus 39 extern "C" { 40 #endif 41 42 /* 43 * The tx_cpu structure is a per-cpu structure that is used to track 44 * the number of active transaction holds (tc_count). As transactions 45 * are assigned into a transaction group the appropriate tc_count is 46 * incremented to indicate that there are pending changes that have yet 47 * to quiesce. Consumers eventually call txg_rele_to_sync() to decrement 48 * the tc_count. A transaction group is not considered quiesced until all 49 * tx_cpu structures have reached a tc_count of zero. 50 * 51 * This structure is a per-cpu structure by design. Updates to this structure 52 * are frequent and concurrent. Having a single structure would result in 53 * heavy lock contention so a per-cpu design was implemented. With the fanned 54 * out mutex design, consumers only need to lock the mutex associated with 55 * thread's cpu. 56 * 57 * The tx_cpu contains two locks, the tc_lock and tc_open_lock. 58 * The tc_lock is used to protect all members of the tx_cpu structure with 59 * the exception of the tc_open_lock. This lock should only be held for a 60 * short period of time, typically when updating the value of tc_count. 61 * 62 * The tc_open_lock protects the tx_open_txg member of the tx_state structure. 63 * This lock is used to ensure that transactions are only assigned into 64 * the current open transaction group. In order to move the current open 65 * transaction group to the quiesce phase, the txg_quiesce thread must 66 * grab all tc_open_locks, increment the tx_open_txg, and drop the locks. 67 * The tc_open_lock is held until the transaction is assigned into the 68 * transaction group. Typically, this is a short operation but if throttling 69 * is occurring it may be held for longer periods of time. 70 */ 71 struct tx_cpu { 72 kmutex_t tc_open_lock; /* protects tx_open_txg */ 73 kmutex_t tc_lock; /* protects the rest of this struct */ 74 kcondvar_t tc_cv[TXG_SIZE]; 75 uint64_t tc_count[TXG_SIZE]; /* tx hold count on each txg */ 76 list_t tc_callbacks[TXG_SIZE]; /* commit cb list */ 77 } ____cacheline_aligned; 78 79 /* 80 * The tx_state structure maintains the state information about the different 81 * stages of the pool's transaction groups. A per pool tx_state structure 82 * is used to track this information. The tx_state structure also points to 83 * an array of tx_cpu structures (described above). Although the tx_sync_lock 84 * is used to protect the members of this structure, it is not used to 85 * protect the tx_open_txg. Instead a special lock in the tx_cpu structure 86 * is used. Readers of tx_open_txg must grab the per-cpu tc_open_lock. 87 * Any thread wishing to update tx_open_txg must grab the tc_open_lock on 88 * every cpu (see txg_quiesce()). 89 */ 90 typedef struct tx_state { 91 tx_cpu_t *tx_cpu; /* protects access to tx_open_txg */ 92 kmutex_t tx_sync_lock; /* protects the rest of this struct */ 93 94 uint64_t tx_open_txg; /* currently open txg id */ 95 uint64_t tx_quiescing_txg; /* currently quiescing txg id */ 96 uint64_t tx_quiesced_txg; /* quiesced txg waiting for sync */ 97 uint64_t tx_syncing_txg; /* currently syncing txg id */ 98 uint64_t tx_synced_txg; /* last synced txg id */ 99 100 hrtime_t tx_open_time; /* start time of tx_open_txg */ 101 102 uint64_t tx_sync_txg_waiting; /* txg we're waiting to sync */ 103 uint64_t tx_quiesce_txg_waiting; /* txg we're waiting to open */ 104 105 kcondvar_t tx_sync_more_cv; 106 kcondvar_t tx_sync_done_cv; 107 kcondvar_t tx_quiesce_more_cv; 108 kcondvar_t tx_quiesce_done_cv; 109 kcondvar_t tx_timeout_cv; 110 kcondvar_t tx_exit_cv; /* wait for all threads to exit */ 111 112 uint8_t tx_threads; /* number of threads */ 113 uint8_t tx_exiting; /* set when we're exiting */ 114 115 kthread_t *tx_sync_thread; 116 kthread_t *tx_quiesce_thread; 117 118 taskq_t *tx_commit_cb_taskq; /* commit callback taskq */ 119 } tx_state_t; 120 121 #ifdef __cplusplus 122 } 123 #endif 124 125 #endif /* _SYS_TXG_IMPL_H */ 126