forked from couchbase/cbgt
/
manager_api.go
395 lines (342 loc) · 11.6 KB
/
manager_api.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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
// Copyright (c) 2014 Couchbase, Inc.
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the
// License. You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an "AS
// IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
// express or implied. See the License for the specific language
// governing permissions and limitations under the License.
package cbgt
import (
"fmt"
"regexp"
"sync/atomic"
log "github.com/couchbase/clog"
)
// INDEX_NAME_REGEXP is used to validate index definition names.
const INDEX_NAME_REGEXP = `^[A-Za-z][0-9A-Za-z_\-]*$`
// Creates a logical index definition. A non-"" prevIndexUUID means
// an update to an existing index.
func (mgr *Manager) CreateIndex(sourceType,
sourceName, sourceUUID, sourceParams,
indexType, indexName, indexParams string, planParams PlanParams,
prevIndexUUID string) error {
atomic.AddUint64(&mgr.stats.TotCreateIndex, 1)
matched, err := regexp.Match(INDEX_NAME_REGEXP, []byte(indexName))
if err != nil {
return fmt.Errorf("manager_api: CreateIndex,"+
" indexName parsing problem,"+
" indexName: %s, err: %v", indexName, err)
}
if !matched {
return fmt.Errorf("manager_api: CreateIndex,"+
" indexName is invalid, indexName: %q", indexName)
}
pindexImplType, exists := PIndexImplTypes[indexType]
if !exists {
return fmt.Errorf("manager_api: CreateIndex,"+
" unknown indexType: %s", indexType)
}
if pindexImplType.Validate != nil {
err = pindexImplType.Validate(indexType, indexName, indexParams)
if err != nil {
return fmt.Errorf("manager_api: CreateIndex, invalid,"+
" err: %v", err)
}
}
// First, check that the source exists.
sourceParams, err = DataSourcePrepParams(sourceType,
sourceName, sourceUUID, sourceParams, mgr.server, mgr.Options())
if err != nil {
return fmt.Errorf("manager_api: failed to connect to"+
" or retrieve information from source,"+
" sourceType: %s, sourceName: %s, sourceUUID: %s, err: %v",
sourceType, sourceName, sourceUUID, err)
}
var indexDef *IndexDef
tries := 0
for {
tries += 1
if tries > 100 {
return fmt.Errorf("manager_api: CreateIndex,"+
" too many tries: %d", tries)
}
indexDefs, cas, err := CfgGetIndexDefs(mgr.cfg)
if err != nil {
return fmt.Errorf("manager_api: CfgGetIndexDefs err: %v", err)
}
if indexDefs == nil {
indexDefs = NewIndexDefs(mgr.version)
}
if VersionGTE(mgr.version, indexDefs.ImplVersion) == false {
return fmt.Errorf("manager_api: could not create index,"+
" indexDefs.ImplVersion: %s > mgr.version: %s",
indexDefs.ImplVersion, mgr.version)
}
prevIndex, exists := indexDefs.IndexDefs[indexName]
if prevIndexUUID == "" { // New index creation.
if exists || prevIndex != nil {
return fmt.Errorf("manager_api: cannot create index because"+
" an index with the same name already exists: %s",
indexName)
}
} else if prevIndexUUID == "*" {
if exists && prevIndex != nil {
prevIndexUUID = prevIndex.UUID
}
} else { // Update index definition.
if !exists || prevIndex == nil {
return fmt.Errorf("manager_api: index missing for update,"+
" indexName: %s", indexName)
}
if prevIndex.UUID != prevIndexUUID {
return fmt.Errorf("manager_api:"+
" perhaps there was concurrent index definition update,"+
" current index UUID: %s, did not match input UUID: %s",
prevIndex.UUID, prevIndexUUID)
}
}
indexUUID := NewUUID()
indexDef = &IndexDef{
Type: indexType,
Name: indexName,
UUID: indexUUID,
Params: indexParams,
SourceType: sourceType,
SourceName: sourceName,
SourceUUID: sourceUUID,
SourceParams: sourceParams,
PlanParams: planParams,
}
indexDefs.UUID = indexUUID
indexDefs.IndexDefs[indexName] = indexDef
indexDefs.ImplVersion = mgr.version
// NOTE: If our ImplVersion is still too old due to a race, we
// expect a more modern planner to catch it later.
_, err = CfgSetIndexDefs(mgr.cfg, indexDefs, cas)
if err != nil {
if _, ok := err.(*CfgCASError); ok {
continue // Retry on CAS mismatch.
}
return fmt.Errorf("manager_api: could not save indexDefs,"+
" err: %v", err)
}
break // Success.
}
if prevIndexUUID == "" {
log.Printf("manager_api: index definition created,"+
" indexType: %s, indexName: %s, indexUUID: %s",
indexDef.Type, indexDef.Name, indexDef.UUID)
} else {
log.Printf("manager_api: index definition updated,"+
" indexType: %s, indexName: %s, indexUUID: %s, prevIndexUUID: %s",
indexDef.Type, indexDef.Name, indexDef.UUID, prevIndexUUID)
}
mgr.GetIndexDefs(true)
mgr.PlannerKick("api/CreateIndex, indexName: " + indexName)
atomic.AddUint64(&mgr.stats.TotCreateIndexOk, 1)
return nil
}
// DeleteIndex deletes a logical index definition.
func (mgr *Manager) DeleteIndex(indexName string) error {
err := mgr.DeleteIndexEx(indexName, "")
log.Errorf("manager_api: DeleteIndex, indexname: %s, err: %v",
indexName, err)
return err
}
// DeleteIndexEx deletes a logical index definition, with an optional
// indexUUID ("" means don't care).
func (mgr *Manager) DeleteIndexEx(indexName, indexUUID string) error {
atomic.AddUint64(&mgr.stats.TotDeleteIndex, 1)
indexDefs, cas, err := CfgGetIndexDefs(mgr.cfg)
if err != nil {
return err
}
if indexDefs == nil {
return fmt.Errorf("manager_api: no indexes on deletion"+
" of indexName: %s", indexName)
}
if VersionGTE(mgr.version, indexDefs.ImplVersion) == false {
return fmt.Errorf("manager_api: could not delete index,"+
" indexDefs.ImplVersion: %s > mgr.version: %s",
indexDefs.ImplVersion, mgr.version)
}
indexDef, exists := indexDefs.IndexDefs[indexName]
if !exists {
return fmt.Errorf("manager_api: index to delete missing,"+
" indexName: %s", indexName)
}
if indexUUID != "" && indexDef.UUID != indexUUID {
return fmt.Errorf("manager_api: index to delete wrong UUID,"+
" indexName: %s", indexName)
}
indexDefs.UUID = NewUUID()
delete(indexDefs.IndexDefs, indexName)
indexDefs.ImplVersion = mgr.version
// NOTE: if our ImplVersion is still too old due to a race, we
// expect a more modern planner to catch it later.
_, err = CfgSetIndexDefs(mgr.cfg, indexDefs, cas)
if err != nil {
return fmt.Errorf("manager_api: could not save indexDefs,"+
" err: %v", err)
}
log.Printf("manager_api: index definition deleted,"+
" indexType: %s, indexName: %s, indexUUID: %s",
indexDef.Type, indexDef.Name, indexDef.UUID)
mgr.GetIndexDefs(true)
mgr.PlannerKick("api/DeleteIndex, indexName: " + indexName)
atomic.AddUint64(&mgr.stats.TotDeleteIndexOk, 1)
return nil
}
// IndexControl is used to change runtime properties of an index
// definition.
func (mgr *Manager) IndexControl(indexName, indexUUID, readOp, writeOp,
planFreezeOp string) error {
atomic.AddUint64(&mgr.stats.TotIndexControl, 1)
indexDefs, cas, err := CfgGetIndexDefs(mgr.cfg)
if err != nil {
return err
}
if indexDefs == nil {
return fmt.Errorf("manager_api: no indexes,"+
" index read/write control, indexName: %s", indexName)
}
if VersionGTE(mgr.version, indexDefs.ImplVersion) == false {
return fmt.Errorf("manager_api: index read/write control,"+
" indexName: %s,"+
" indexDefs.ImplVersion: %s > mgr.version: %s",
indexName, indexDefs.ImplVersion, mgr.version)
}
indexDef, exists := indexDefs.IndexDefs[indexName]
if !exists || indexDef == nil {
return fmt.Errorf("manager_api: no index to read/write control,"+
" indexName: %s", indexName)
}
if indexUUID != "" && indexDef.UUID != indexUUID {
return fmt.Errorf("manager_api: index.UUID mismatched")
}
if indexDef.PlanParams.NodePlanParams == nil {
indexDef.PlanParams.NodePlanParams =
map[string]map[string]*NodePlanParam{}
}
if indexDef.PlanParams.NodePlanParams[""] == nil {
indexDef.PlanParams.NodePlanParams[""] =
map[string]*NodePlanParam{}
}
if indexDef.PlanParams.NodePlanParams[""][""] == nil {
indexDef.PlanParams.NodePlanParams[""][""] = &NodePlanParam{
CanRead: true,
CanWrite: true,
}
}
// TODO: Allow for node UUID and planPIndex.Name inputs.
npp := indexDef.PlanParams.NodePlanParams[""][""]
if readOp != "" {
if readOp == "allow" || readOp == "resume" {
npp.CanRead = true
} else {
npp.CanRead = false
}
}
if writeOp != "" {
if writeOp == "allow" || writeOp == "resume" {
npp.CanWrite = true
} else {
npp.CanWrite = false
}
}
if npp.CanRead == true && npp.CanWrite == true {
delete(indexDef.PlanParams.NodePlanParams[""], "")
}
if planFreezeOp != "" {
indexDef.PlanParams.PlanFrozen = planFreezeOp == "freeze"
}
_, err = CfgSetIndexDefs(mgr.cfg, indexDefs, cas)
if err != nil {
return fmt.Errorf("manager_api: could not save indexDefs,"+
" err: %v", err)
}
atomic.AddUint64(&mgr.stats.TotIndexControlOk, 1)
return nil
}
// BumpIndexDefs bumps the uuid of the index defs, to force planners
// and other downstream tasks to re-run.
func (mgr *Manager) BumpIndexDefs(indexDefsUUID string) error {
indexDefs, cas, err := CfgGetIndexDefs(mgr.cfg)
if err != nil {
return err
}
if indexDefs == nil {
return fmt.Errorf("manager_api: no indexDefs to bump")
}
if VersionGTE(mgr.version, indexDefs.ImplVersion) == false {
return fmt.Errorf("manager_api: could not bump indexDefs,"+
" indexDefs.ImplVersion: %s > mgr.version: %s",
indexDefs.ImplVersion, mgr.version)
}
if indexDefsUUID != "" && indexDefs.UUID != indexDefsUUID {
return fmt.Errorf("manager_api: bump indexDefs wrong UUID")
}
indexDefs.UUID = NewUUID()
indexDefs.ImplVersion = mgr.version
// NOTE: if our ImplVersion is still too old due to a race, we
// expect a more modern cbgt to do the work instead.
_, err = CfgSetIndexDefs(mgr.cfg, indexDefs, cas)
if err != nil {
return fmt.Errorf("manager_api: could not bump indexDefs,"+
" err: %v", err)
}
log.Printf("manager_api: bumped indexDefs, indexDefsUUID: %s",
indexDefs.UUID)
mgr.PlannerKick("BumpIndexDefs")
return nil
}
// DeleteAllIndexFromSource deletes all indexes with a given
// sourceType and sourceName.
func (mgr *Manager) DeleteAllIndexFromSource(
sourceType, sourceName, sourceUUID string) error {
indexDefs, _, err := CfgGetIndexDefs(mgr.cfg)
if err != nil {
return err
}
if indexDefs == nil {
return fmt.Errorf("manager_api: DeleteAllIndexFromSource, no indexDefs")
}
if VersionGTE(mgr.version, indexDefs.ImplVersion) == false {
return fmt.Errorf("manager_api: DeleteAllIndexFromSource,"+
" indexDefs.ImplVersion: %s > mgr.version: %s",
indexDefs.ImplVersion, mgr.version)
}
var outerErr error
for indexName, indexDef := range indexDefs.IndexDefs {
if indexDef.SourceType == sourceType &&
indexDef.SourceName == sourceName {
if sourceUUID != "" && sourceUUID != indexDef.SourceUUID {
continue
}
atomic.AddUint64(&mgr.stats.TotDeleteIndexBySource, 1)
log.Printf("manager_api: DeleteAllIndexFromSource,"+
" indexName: %s, sourceType: %s, sourceName: %s, sourceUUID: %s",
indexName, sourceType, sourceName, sourceUUID)
err = mgr.DeleteIndexEx(indexName, indexDef.UUID)
if err != nil {
if outerErr == nil {
outerErr = err
}
atomic.AddUint64(&mgr.stats.TotDeleteIndexBySourceErr, 1)
} else {
atomic.AddUint64(&mgr.stats.TotDeleteIndexBySourceOk, 1)
}
}
}
// With MB-19117, we've seen cfg that strangely had empty
// indexDefs, but non-empty planPIndexes. Force bump the
// indexDefs so the planner and other downstream tasks re-run.
err = mgr.BumpIndexDefs("")
if err != nil {
return err
}
return outerErr
}