-
Notifications
You must be signed in to change notification settings - Fork 452
/
segment.go
501 lines (423 loc) · 11.2 KB
/
segment.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
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
// Copyright (c) 2017 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
package mem
import (
"errors"
re "regexp"
"sync"
"github.com/m3db/m3/src/m3ninx/doc"
"github.com/m3db/m3/src/m3ninx/index"
"github.com/m3db/m3/src/m3ninx/index/segment"
"github.com/m3db/m3/src/m3ninx/postings"
"github.com/m3db/m3/src/m3ninx/util"
)
var (
errSegmentSealed = errors.New("unable to seal, segment has already been sealed")
errSegmentIsUnsealed = errors.New("un-supported operation on an un-sealed mutable segment")
)
// nolint: maligned
type memSegment struct {
offset int
plPool postings.Pool
newUUIDFn util.NewUUIDFn
state struct {
sync.RWMutex
closed bool
sealed bool
}
// Mapping of postings ID to document.
docs struct {
sync.RWMutex
data []doc.Document
}
// Mapping of term to postings list.
termsDict termsDictionary
writer struct {
sync.Mutex
idSet *idsMap
nextID postings.ID
}
readerID postings.AtomicID
}
// NewSegment returns a new in-memory mutable segment. It will start assigning
// postings IDs at the provided offset.
func NewSegment(opts Options) (segment.MutableSegment, error) {
s := &memSegment{
plPool: opts.PostingsListPool(),
newUUIDFn: opts.NewUUIDFn(),
termsDict: newTermsDict(opts),
readerID: postings.NewAtomicID(0),
}
s.docs.data = make([]doc.Document, opts.InitialCapacity())
s.writer.idSet = newIDsMap(256)
s.writer.nextID = 0
return s, nil
}
func (s *memSegment) SetIndexConcurrency(value int) {
// No-op, does not support concurrent indexing.
}
func (s *memSegment) IndexConcurrency() int {
return 1
}
func (s *memSegment) Reset() {
s.state.Lock()
defer s.state.Unlock()
s.state.sealed = false
s.termsDict.Reset()
s.readerID = postings.NewAtomicID(0)
var empty doc.Document
for i := range s.docs.data {
s.docs.data[i] = empty
}
s.docs.data = s.docs.data[:0]
s.writer.idSet.Reset()
s.writer.nextID = 0
}
func (s *memSegment) Size() int64 {
s.state.RLock()
closed := s.state.closed
size := int64(s.readerID.Load())
s.state.RUnlock()
if closed {
return 0
}
return size
}
func (s *memSegment) Docs() []doc.Document {
s.state.RLock()
defer s.state.RUnlock()
s.docs.RLock()
defer s.docs.RUnlock()
return s.docs.data[:s.readerID.Load()]
}
func (s *memSegment) ContainsID(id []byte) (bool, error) {
s.state.RLock()
if s.state.closed {
s.state.RUnlock()
return false, segment.ErrClosed
}
contains := s.containsIDWithStateLock(id)
s.state.RUnlock()
return contains, nil
}
func (s *memSegment) containsIDWithStateLock(id []byte) bool {
return s.termsDict.ContainsTerm(doc.IDReservedFieldName, id)
}
func (s *memSegment) ContainsField(f []byte) (bool, error) {
s.state.RLock()
if s.state.closed {
s.state.RUnlock()
return false, segment.ErrClosed
}
contains := s.termsDict.ContainsField(f)
s.state.RUnlock()
return contains, nil
}
func (s *memSegment) Insert(d doc.Document) ([]byte, error) {
s.state.RLock()
defer s.state.RUnlock()
if s.state.closed {
return nil, segment.ErrClosed
}
{
s.writer.Lock()
defer s.writer.Unlock()
b := index.NewBatch([]doc.Document{d})
b.AllowPartialUpdates = false
if err := s.prepareDocsWithLocks(b, nil); err != nil {
return nil, err
}
// Update the document in case we generated a UUID for it.
d = b.Docs[0]
if err := s.insertDocWithLocks(d); err != nil {
return nil, err
}
s.readerID.Inc()
}
return d.ID, nil
}
func (s *memSegment) InsertBatch(b index.Batch) error {
s.state.RLock()
defer s.state.RUnlock()
if s.state.closed {
return segment.ErrClosed
}
batchErr := index.NewBatchPartialError()
{
s.writer.Lock()
defer s.writer.Unlock()
if err := s.prepareDocsWithLocks(b, batchErr); err != nil {
return err
}
numInserts := uint32(0)
for i, d := range b.Docs {
// NB(prateek): we override a document to have no ID when
// it doesn't need to be inserted.
if !d.HasID() {
continue
}
if err := s.insertDocWithLocks(d); err != nil {
if !b.AllowPartialUpdates {
return err
}
batchErr.Add(index.BatchError{Err: err, Idx: i})
continue
}
numInserts++
}
s.readerID.Add(numInserts)
}
if !batchErr.IsEmpty() {
return batchErr
}
return nil
}
// prepareDocsWithLocks ensures the given documents can be inserted into the index. It
// must be called with the state and writer locks.
func (s *memSegment) prepareDocsWithLocks(
b index.Batch,
batchErr *index.BatchPartialError,
) error {
s.writer.idSet.Reset()
var emptyDoc doc.Document
for i := 0; i < len(b.Docs); i++ {
d := b.Docs[i]
if err := d.Validate(); err != nil {
if !b.AllowPartialUpdates {
return err
}
batchErr.Add(index.BatchError{Err: err, Idx: i})
b.Docs[i] = emptyDoc
continue
}
if d.HasID() {
if s.containsIDWithStateLock(d.ID) {
// The segment already contains this document so we can remove it from those
// we need to index.
b.Docs[i] = emptyDoc
continue
}
if _, ok := s.writer.idSet.Get(d.ID); ok {
if !b.AllowPartialUpdates {
return index.ErrDuplicateID
}
batchErr.Add(index.BatchError{Err: index.ErrDuplicateID, Idx: i})
b.Docs[i] = emptyDoc
continue
}
} else {
id, err := s.newUUIDFn()
if err != nil {
if !b.AllowPartialUpdates {
return err
}
batchErr.Add(index.BatchError{Err: err, Idx: i})
b.Docs[i] = emptyDoc
continue
}
d.ID = id
// Update the document in the batch since we added an ID to it.
b.Docs[i] = d
}
s.writer.idSet.SetUnsafe(d.ID, struct{}{}, idsMapSetUnsafeOptions{
NoCopyKey: true,
NoFinalizeKey: true,
})
}
return nil
}
// insertDocWithLocks inserts a document into the index. It must be called with the
// state and writer locks.
func (s *memSegment) insertDocWithLocks(d doc.Document) error {
nextID := s.writer.nextID
s.storeDocWithStateLock(nextID, d)
s.writer.nextID++
return s.indexDocWithStateLock(nextID, d)
}
// indexDocWithStateLock indexes the fields of a document in the segment's terms
// dictionary. It must be called with the segment's state lock.
func (s *memSegment) indexDocWithStateLock(id postings.ID, d doc.Document) error {
for _, f := range d.Fields {
if err := s.termsDict.Insert(f, id); err != nil {
return err
}
}
return s.termsDict.Insert(doc.Field{
Name: doc.IDReservedFieldName,
Value: d.ID,
}, id)
}
// storeDocWithStateLock stores a documents into the segment's mapping of postings
// IDs to documents. It must be called with the segment's state lock.
func (s *memSegment) storeDocWithStateLock(id postings.ID, d doc.Document) {
idx := int(id)
// Can return early if we have sufficient capacity.
{
s.docs.RLock()
size := len(s.docs.data)
if size > idx {
// NB(prateek): We only need a Read-lock here despite an insert operation because
// we're guaranteed to never have conflicts with docID (it's monotonically increasing),
// and have checked `i.docs.data` is large enough.
s.docs.data[idx] = d
s.docs.RUnlock()
return
}
s.docs.RUnlock()
}
// Otherwise we need to expand capacity.
{
s.docs.Lock()
size := len(s.docs.data)
// The slice has already been expanded since we released the lock.
if size > idx {
s.docs.data[idx] = d
s.docs.Unlock()
return
}
data := make([]doc.Document, 2*(size+1))
copy(data, s.docs.data)
s.docs.data = data
s.docs.data[idx] = d
s.docs.Unlock()
}
}
func (s *memSegment) Reader() (segment.Reader, error) {
s.state.RLock()
defer s.state.RUnlock()
if s.state.closed {
return nil, segment.ErrClosed
}
limits := readerDocRange{
startInclusive: postings.ID(0),
endExclusive: s.readerID.Load(),
}
return newReader(s, limits, s.plPool), nil
}
func (s *memSegment) AllDocs() (index.IDDocIterator, error) {
r, err := s.Reader()
if err != nil {
return nil, err
}
return r.AllDocs()
}
func (s *memSegment) matchTerm(field, term []byte) (postings.List, error) {
s.state.RLock()
defer s.state.RUnlock()
if s.state.closed {
return nil, segment.ErrClosed
}
return s.termsDict.MatchTerm(field, term), nil
}
func (s *memSegment) matchRegexp(field []byte, compiled *re.Regexp) (postings.List, error) {
s.state.RLock()
defer s.state.RUnlock()
if s.state.closed {
return nil, segment.ErrClosed
}
return s.termsDict.MatchRegexp(field, compiled), nil
}
func (s *memSegment) getDoc(id postings.ID) (doc.Document, error) {
s.state.RLock()
defer s.state.RUnlock()
if s.state.closed {
return doc.Document{}, segment.ErrClosed
}
idx := int(id)
s.docs.RLock()
if idx >= len(s.docs.data) {
s.docs.RUnlock()
return doc.Document{}, index.ErrDocNotFound
}
d := s.docs.data[idx]
s.docs.RUnlock()
return d, nil
}
func (s *memSegment) Close() error {
s.state.Lock()
defer s.state.Unlock()
if s.state.closed {
return segment.ErrClosed
}
s.state.closed = true
return nil
}
func (s *memSegment) IsSealed() bool {
s.state.Lock()
defer s.state.Unlock()
if s.state.closed {
return false
}
return s.state.sealed
}
func (s *memSegment) Seal() error {
s.state.Lock()
defer s.state.Unlock()
if s.state.closed {
return segment.ErrClosed
}
if s.state.sealed {
return errSegmentSealed
}
s.state.sealed = true
return nil
}
func (s *memSegment) Fields() (segment.FieldsIterator, error) {
s.state.RLock()
defer s.state.RUnlock()
if err := s.checkIsSealedWithRLock(); err != nil {
return nil, err
}
return s.termsDict.Fields(), nil
}
func (s *memSegment) FieldsPostingsList() (segment.FieldsPostingsListIterator, error) {
s.state.RLock()
defer s.state.RUnlock()
if err := s.checkIsSealedWithRLock(); err != nil {
return nil, err
}
return s.termsDict.FieldsPostingsList(), nil
}
func (s *memSegment) Terms(name []byte) (segment.TermsIterator, error) {
s.state.RLock()
defer s.state.RUnlock()
if err := s.checkIsSealedWithRLock(); err != nil {
return nil, err
}
return s.termsDict.Terms(name), nil
}
func (s *memSegment) FieldsIterable() segment.FieldsIterable {
return s
}
func (s *memSegment) FieldsPostingsListIterable() segment.FieldsPostingsListIterable {
return s
}
func (s *memSegment) TermsIterable() segment.TermsIterable {
return s
}
func (s *memSegment) checkIsSealedWithRLock() error {
if s.state.closed {
return segment.ErrClosed
}
if !s.state.sealed {
return errSegmentIsUnsealed
}
return nil
}