-
Notifications
You must be signed in to change notification settings - Fork 0
/
lockbased_tx_simulator.go
222 lines (196 loc) · 7.86 KB
/
lockbased_tx_simulator.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
/*
Copyright IBM Corp. All Rights Reserved.
SPDX-License-Identifier: Apache-2.0
*/
package lockbasedtxmgr
import (
"fmt"
commonledger "github.com/hyperledger/fabric/common/ledger"
"github.com/hyperledger/fabric/core/ledger"
"github.com/hyperledger/fabric/core/ledger/kvledger/txmgmt/rwsetutil"
"github.com/hyperledger/fabric/core/ledger/kvledger/txmgmt/txmgr"
"github.com/pkg/errors"
)
// LockBasedTxSimulator is a transaction simulator used in `LockBasedTxMgr`
type lockBasedTxSimulator struct {
lockBasedQueryExecutor
rwsetBuilder *rwsetutil.RWSetBuilder
writePerformed bool
pvtdataQueriesPerformed bool
simulationResultsComputed bool
paginatedQueriesPerformed bool
}
func newLockBasedTxSimulator(txmgr *LockBasedTxMgr, txid string) (*lockBasedTxSimulator, error) {
rwsetBuilder := rwsetutil.NewRWSetBuilder()
helper := newQueryHelper(txmgr, rwsetBuilder)
logger.Debugf("constructing new tx simulator txid = [%s]", txid)
return &lockBasedTxSimulator{lockBasedQueryExecutor{helper, txid}, rwsetBuilder, false, false, false, false}, nil
}
// SetState implements method in interface `ledger.TxSimulator`
func (s *lockBasedTxSimulator) SetState(ns string, key string, value []byte) error {
if err := s.checkWritePrecondition(key, value); err != nil {
return err
}
s.rwsetBuilder.AddToWriteSet(ns, key, value)
return nil
}
// DeleteState implements method in interface `ledger.TxSimulator`
func (s *lockBasedTxSimulator) DeleteState(ns string, key string) error {
return s.SetState(ns, key, nil)
}
// SetStateMultipleKeys implements method in interface `ledger.TxSimulator`
func (s *lockBasedTxSimulator) SetStateMultipleKeys(namespace string, kvs map[string][]byte) error {
for k, v := range kvs {
if err := s.SetState(namespace, k, v); err != nil {
return err
}
}
return nil
}
// SetStateMetadata implements method in interface `ledger.TxSimulator`
func (s *lockBasedTxSimulator) SetStateMetadata(namespace, key string, metadata map[string][]byte) error {
if err := s.checkWritePrecondition(key, nil); err != nil {
return err
}
s.rwsetBuilder.AddToMetadataWriteSet(namespace, key, metadata)
return nil
}
// DeleteStateMetadata implements method in interface `ledger.TxSimulator`
func (s *lockBasedTxSimulator) DeleteStateMetadata(namespace, key string) error {
return s.SetStateMetadata(namespace, key, nil)
}
// SetPrivateData implements method in interface `ledger.TxSimulator`
func (s *lockBasedTxSimulator) SetPrivateData(ns, coll, key string, value []byte) error {
if err := s.helper.validateCollName(ns, coll); err != nil {
return err
}
if err := s.checkWritePrecondition(key, value); err != nil {
return err
}
s.writePerformed = true
s.rwsetBuilder.AddToPvtAndHashedWriteSet(ns, coll, key, value)
return nil
}
// DeletePrivateData implements method in interface `ledger.TxSimulator`
func (s *lockBasedTxSimulator) DeletePrivateData(ns, coll, key string) error {
return s.SetPrivateData(ns, coll, key, nil)
}
// SetPrivateDataMultipleKeys implements method in interface `ledger.TxSimulator`
func (s *lockBasedTxSimulator) SetPrivateDataMultipleKeys(ns, coll string, kvs map[string][]byte) error {
for k, v := range kvs {
if err := s.SetPrivateData(ns, coll, k, v); err != nil {
return err
}
}
return nil
}
// GetPrivateDataRangeScanIterator implements method in interface `ledger.TxSimulator`
func (s *lockBasedTxSimulator) GetPrivateDataRangeScanIterator(namespace, collection, startKey, endKey string) (commonledger.ResultsIterator, error) {
if err := s.checkBeforePvtdataQueries(); err != nil {
return nil, err
}
return s.lockBasedQueryExecutor.GetPrivateDataRangeScanIterator(namespace, collection, startKey, endKey)
}
// SetPrivateDataMetadata implements method in interface `ledger.TxSimulator`
func (s *lockBasedTxSimulator) SetPrivateDataMetadata(namespace, collection, key string, metadata map[string][]byte) error {
if err := s.helper.validateCollName(namespace, collection); err != nil {
return err
}
if err := s.checkWritePrecondition(key, nil); err != nil {
return err
}
s.rwsetBuilder.AddToHashedMetadataWriteSet(namespace, collection, key, metadata)
return nil
}
// DeletePrivateMetadata implements method in interface `ledger.TxSimulator`
func (s *lockBasedTxSimulator) DeletePrivateDataMetadata(namespace, collection, key string) error {
return s.SetPrivateDataMetadata(namespace, collection, key, nil)
}
// ExecuteQueryOnPrivateData implements method in interface `ledger.TxSimulator`
func (s *lockBasedTxSimulator) ExecuteQueryOnPrivateData(namespace, collection, query string) (commonledger.ResultsIterator, error) {
if err := s.checkBeforePvtdataQueries(); err != nil {
return nil, err
}
return s.lockBasedQueryExecutor.ExecuteQueryOnPrivateData(namespace, collection, query)
}
// GetStateRangeScanIteratorWithMetadata implements method in interface `ledger.QueryExecutor`
func (s *lockBasedTxSimulator) GetStateRangeScanIteratorWithMetadata(namespace string, startKey string, endKey string, metadata map[string]interface{}) (ledger.QueryResultsIterator, error) {
if err := s.checkBeforePaginatedQueries(); err != nil {
return nil, err
}
return s.lockBasedQueryExecutor.GetStateRangeScanIteratorWithMetadata(namespace, startKey, endKey, metadata)
}
// ExecuteQueryWithMetadata implements method in interface `ledger.QueryExecutor`
func (s *lockBasedTxSimulator) ExecuteQueryWithMetadata(namespace, query string, metadata map[string]interface{}) (ledger.QueryResultsIterator, error) {
if err := s.checkBeforePaginatedQueries(); err != nil {
return nil, err
}
return s.lockBasedQueryExecutor.ExecuteQueryWithMetadata(namespace, query, metadata)
}
// GetTxSimulationResults implements method in interface `ledger.TxSimulator`
func (s *lockBasedTxSimulator) GetTxSimulationResults() (*ledger.TxSimulationResults, error) {
if s.simulationResultsComputed {
return nil, errors.New("this function should only be called once on a transaction simulator instance")
}
defer func() { s.simulationResultsComputed = true }()
logger.Debugf("Simulation completed, getting simulation results")
if s.helper.err != nil {
return nil, s.helper.err
}
s.helper.addRangeQueryInfo()
return s.rwsetBuilder.GetTxSimulationResults()
}
// ExecuteUpdate implements method in interface `ledger.TxSimulator`
func (s *lockBasedTxSimulator) ExecuteUpdate(query string) error {
return errors.New("not supported")
}
func (s *lockBasedTxSimulator) checkWritePrecondition(key string, value []byte) error {
if err := s.helper.checkDone(); err != nil {
return err
}
if err := s.checkPvtdataQueryPerformed(); err != nil {
return err
}
if err := s.checkPaginatedQueryPerformed(); err != nil {
return err
}
s.writePerformed = true
if err := s.helper.txmgr.db.ValidateKeyValue(key, value); err != nil {
return err
}
return nil
}
func (s *lockBasedTxSimulator) checkBeforePvtdataQueries() error {
if s.writePerformed {
return &txmgr.ErrUnsupportedTransaction{
Msg: fmt.Sprintf("txid [%s]: Queries on pvt data is supported only in a read-only transaction", s.txid),
}
}
s.pvtdataQueriesPerformed = true
return nil
}
func (s *lockBasedTxSimulator) checkPvtdataQueryPerformed() error {
if s.pvtdataQueriesPerformed {
return &txmgr.ErrUnsupportedTransaction{
Msg: fmt.Sprintf("txid [%s]: Transaction has already performed queries on pvt data. Writes are not allowed", s.txid),
}
}
return nil
}
func (s *lockBasedTxSimulator) checkBeforePaginatedQueries() error {
if s.writePerformed {
return &txmgr.ErrUnsupportedTransaction{
Msg: fmt.Sprintf("txid [%s]: Paginated queries are supported only in a read-only transaction", s.txid),
}
}
s.paginatedQueriesPerformed = true
return nil
}
func (s *lockBasedTxSimulator) checkPaginatedQueryPerformed() error {
if s.paginatedQueriesPerformed {
return &txmgr.ErrUnsupportedTransaction{
Msg: fmt.Sprintf("txid [%s]: Transaction has already performed a paginated query. Writes are not allowed", s.txid),
}
}
return nil
}