-
Notifications
You must be signed in to change notification settings - Fork 451
/
convert.go
507 lines (444 loc) · 13.8 KB
/
convert.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
502
503
504
505
506
507
// Copyright (c) 2018 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 convert contains various conversions.
package convert
import (
"bytes"
"errors"
"fmt"
"unicode/utf8"
"github.com/m3db/m3/src/dbnode/ts"
"github.com/m3db/m3/src/m3ninx/doc"
"github.com/m3db/m3/src/query/graphite/graphite"
"github.com/m3db/m3/src/x/ident"
"github.com/m3db/m3/src/x/pool"
"github.com/m3db/m3/src/x/serialize"
)
const (
// NB: this assumes that series ID has a format:
// {tag1="value1",tag2="value2",...}
//
// Thus firstTagBytesPosition points to the 't' immediately after curly brace '{'
firstTagBytesPosition int = 1
// distanceBetweenTagNameAndValue corresponds to '="' in series ID that separates tag name from
// it's value
distanceBetweenTagNameAndValue int = 2
// distanceBetweenTagValueAndNextName corresponds to '",' in series ID that separates
// tag's value from the following tag name
distanceBetweenTagValueAndNextName int = 2
)
var (
// ReservedFieldNameID is the field name used to index the ID in the
// m3ninx subsytem.
ReservedFieldNameID = doc.IDReservedFieldName
// ErrUsingReservedFieldName is the error returned when a metric
// cannot be parsed due to using a resereved field name
ErrUsingReservedFieldName = errors.New(
"unable to parse metric using reserved field name: " +
string(ReservedFieldNameID))
errInvalidResultMissingID = errors.New(
"corrupt data, unable to extract id")
)
// Validate returns a bool indicating whether the document is valid.
func Validate(d doc.Metadata) error {
if !utf8.Valid(d.ID) {
return fmt.Errorf("document has invalid non-UTF8 ID: id=%v, id_hex=%x",
d.ID, d.ID)
}
for _, f := range d.Fields {
if !utf8.Valid(f.Name) {
return fmt.Errorf("document has invalid non-UTF8 field name: name=%v, name_hex=%x",
f.Name, f.Name)
}
if bytes.Equal(f.Name, ReservedFieldNameID) {
return ErrUsingReservedFieldName
}
if !utf8.Valid(f.Value) {
return fmt.Errorf("document has invalid non-UTF8 field value: value=%v, value_hex=%x",
f.Value, f.Value)
}
}
return nil
}
// ValidateSeries will validate a series for use with m3ninx.
func ValidateSeries(id ident.ID, tags ident.Tags) error {
if idBytes := id.Bytes(); !utf8.Valid(idBytes) {
return fmt.Errorf("series has invalid non-UTF8 ID: id=%s, id_hex=%x",
idBytes, idBytes)
}
for _, tag := range tags.Values() {
if err := ValidateSeriesTag(tag); err != nil {
return err
}
}
return nil
}
// ValidateSeriesTag validates a series tag for use with m3ninx.
func ValidateSeriesTag(tag ident.Tag) error {
tagName := tag.Name.Bytes()
tagValue := tag.Value.Bytes()
if bytes.Equal(ReservedFieldNameID, tagName) {
return ErrUsingReservedFieldName
}
if !utf8.Valid(tagName) {
return fmt.Errorf("series contains invalid non-UTF8 field name: "+
"field=%s, field_hex=%v", tagName, tagName)
}
if !utf8.Valid(tagValue) {
return fmt.Errorf("series contains invalid non-UTF8 field value: "+
"field=%s, field_value=%s, field_value_hex=%x",
tagName, tagValue, tagValue)
}
return nil
}
// FromSeriesIDAndTags converts the provided series id+tags into a document.
func FromSeriesIDAndTags(id ident.ID, tags ident.Tags) (doc.Metadata, error) {
var (
clonedID = clone(id.Bytes())
fields = make([]doc.Field, 0, len(tags.Values()))
expectedStart = firstTagBytesPosition
)
for _, tag := range tags.Values() {
nameBytes, valueBytes := tag.Name.Bytes(), tag.Value.Bytes()
var clonedName, clonedValue []byte
clonedName, expectedStart = findSliceOrClone(clonedID, nameBytes, expectedStart,
distanceBetweenTagNameAndValue)
clonedValue, expectedStart = findSliceOrClone(clonedID, valueBytes, expectedStart,
distanceBetweenTagValueAndNextName)
fields = append(fields, doc.Field{
Name: clonedName,
Value: clonedValue,
})
}
d := doc.Metadata{
ID: clonedID,
Fields: fields,
}
if err := Validate(d); err != nil {
return doc.Metadata{}, err
}
return d, nil
}
// FromSeriesIDAndTagIter converts the provided series id+tags into a document.
func FromSeriesIDAndTagIter(id ident.ID, tags ident.TagIterator) (doc.Metadata, error) {
var (
clonedID = clone(id.Bytes())
fields = make([]doc.Field, 0, tags.Remaining())
expectedStart = firstTagBytesPosition
)
for tags.Next() {
tag := tags.Current()
nameBytes, valueBytes := tag.Name.Bytes(), tag.Value.Bytes()
var clonedName, clonedValue []byte
clonedName, expectedStart = findSliceOrClone(clonedID, nameBytes, expectedStart,
distanceBetweenTagNameAndValue)
clonedValue, expectedStart = findSliceOrClone(clonedID, valueBytes, expectedStart,
distanceBetweenTagValueAndNextName)
fields = append(fields, doc.Field{
Name: clonedName,
Value: clonedValue,
})
}
if err := tags.Err(); err != nil {
return doc.Metadata{}, err
}
d := doc.Metadata{
ID: clonedID,
Fields: fields,
}
if err := Validate(d); err != nil {
return doc.Metadata{}, err
}
return d, nil
}
// FromSeriesIDAndEncodedTags converts the provided series id and encoded tags into a doc.Metadata.
func FromSeriesIDAndEncodedTags(id ident.BytesID, encodedTags ts.EncodedTags) (doc.Metadata, error) {
var (
byteOrder = serialize.ByteOrder
total = len(encodedTags)
)
if total == 0 {
// No tags set for this series
return doc.Metadata{
ID: clone(id.Bytes()),
Fields: nil,
}, nil
}
if total < 4 {
return doc.Metadata{}, fmt.Errorf("encoded tags too short: size=%d, need=%d", total, 4)
}
header := byteOrder.Uint16(encodedTags[:2])
encodedTags = encodedTags[2:]
if header != serialize.HeaderMagicNumber {
return doc.Metadata{}, serialize.ErrIncorrectHeader
}
length := int(byteOrder.Uint16(encodedTags[:2]))
encodedTags = encodedTags[2:]
var (
clonedID = clone(id.Bytes())
fields = make([]doc.Field, 0, length)
expectedStart = firstTagBytesPosition
)
for i := 0; i < length; i++ {
if len(encodedTags) < 2 {
return doc.Metadata{}, fmt.Errorf("missing size for tag name: index=%d", i)
}
numBytesName := int(byteOrder.Uint16(encodedTags[:2]))
if numBytesName == 0 {
return doc.Metadata{}, serialize.ErrEmptyTagNameLiteral
}
encodedTags = encodedTags[2:]
bytesName := encodedTags[:numBytesName]
encodedTags = encodedTags[numBytesName:]
if len(encodedTags) < 2 {
return doc.Metadata{}, fmt.Errorf("missing size for tag value: index=%d", i)
}
numBytesValue := int(byteOrder.Uint16(encodedTags[:2]))
encodedTags = encodedTags[2:]
bytesValue := encodedTags[:numBytesValue]
encodedTags = encodedTags[numBytesValue:]
var clonedName, clonedValue []byte
clonedName, expectedStart = findSliceOrClone(clonedID, bytesName, expectedStart,
distanceBetweenTagNameAndValue)
clonedValue, expectedStart = findSliceOrClone(clonedID, bytesValue, expectedStart,
distanceBetweenTagValueAndNextName)
fields = append(fields, doc.Field{
Name: clonedName,
Value: clonedValue,
})
}
d := doc.Metadata{
ID: clonedID,
Fields: fields,
}
if err := Validate(d); err != nil {
return doc.Metadata{}, err
}
return d, nil
}
func findSliceOrClone(id, tag []byte, expectedStart, nextPositionDistance int) ([]byte, int) { //nolint:unparam
n := len(tag)
expectedEnd := expectedStart + n
if expectedStart != -1 && expectedEnd <= len(id) &&
bytes.Equal(id[expectedStart:expectedEnd], tag) {
return id[expectedStart:expectedEnd], expectedEnd + nextPositionDistance
} else if idx := bytes.Index(id, tag); idx != -1 {
return id[idx : idx+n], expectedEnd + nextPositionDistance
} else {
return clone(tag), -1
}
}
// TagsFromTagsIter returns an ident.Tags from a TagIterator. It also tries
// to re-use bytes from the seriesID if they're also present in the tags
// instead of re-allocating them. This requires that the ident.Tags that is
// returned will have the same (or shorter) life time as the seriesID,
// otherwise the operation is unsafe.
func TagsFromTagsIter(
seriesID ident.ID,
iter ident.TagIterator,
idPool ident.Pool,
) (ident.Tags, error) {
var tags ident.Tags
if idPool != nil {
tags = idPool.Tags()
} else {
tagSlice := make([]ident.Tag, 0, iter.Len())
tags = ident.NewTags(tagSlice...)
}
seriesIDBytes := ident.BytesID(seriesID.Bytes())
for iter.Next() {
curr := iter.Current()
var (
nameBytes, valueBytes = curr.Name.Bytes(), curr.Value.Bytes()
tag ident.Tag
idRef bool
)
if idx := bytes.Index(seriesIDBytes, nameBytes); idx != -1 {
tag.Name = seriesIDBytes[idx : idx+len(nameBytes)]
idRef = true
} else {
if idPool != nil {
// NB(r): Fast path for if a graphite tag name to save
// a lot of space is to reuse a preallocated tag name.
if idx, ok := graphite.TagIndex(nameBytes); ok {
tag.Name = graphite.TagNameID(idx)
} else {
tag.Name = idPool.Clone(curr.Name)
}
} else {
copiedBytes := append([]byte(nil), curr.Name.Bytes()...)
tag.Name = ident.BytesID(copiedBytes)
}
}
if idx := bytes.Index(seriesIDBytes, valueBytes); idx != -1 {
tag.Value = seriesIDBytes[idx : idx+len(valueBytes)]
idRef = true
} else {
if idPool != nil {
tag.Value = idPool.Clone(curr.Value)
} else {
copiedBytes := append([]byte(nil), curr.Value.Bytes()...)
tag.Value = ident.BytesID(copiedBytes)
}
}
if idRef {
tag.NoFinalize() // Taken ref, cannot finalize this.
}
tags.Append(tag)
}
if err := iter.Err(); err != nil {
return ident.Tags{}, err
}
return tags, nil
}
// NB(prateek): we take an independent copy of the bytes underlying
// any ids provided, as we need to maintain the lifecycle of the indexed
// bytes separately from the rest of the storage subsystem.
func clone(original []byte) []byte {
clone := make([]byte, len(original))
copy(clone, original)
return clone
}
// Opts are the pools required for conversions.
type Opts struct {
IdentPool ident.Pool
CheckedBytesPool pool.CheckedBytesPool
NoClone bool
}
// wrapBytes wraps the provided bytes into an ident.ID backed by pooled types,
// such that calling Finalize() on the returned type returns the resources to
// the pools.
func (o Opts) wrapBytes(b []byte) ident.ID {
if o.NoClone {
return ident.BytesID(b)
}
cb := o.CheckedBytesPool.Get(len(b))
cb.IncRef()
cb.AppendAll(b)
id := o.IdentPool.BinaryID(cb)
// release held reference so now the only reference to the bytes is owned by `id`
cb.DecRef()
return id
}
// ToSeries converts the provided doc to metric id+tags.
func ToSeries(d doc.Metadata, opts Opts) (ident.ID, ident.TagIterator, error) {
if len(d.ID) == 0 {
return nil, nil, errInvalidResultMissingID
}
return opts.wrapBytes(d.ID), ToSeriesTags(d, opts), nil
}
// ToSeriesTags converts the provided doc to metric tags.
func ToSeriesTags(d doc.Metadata, opts Opts) ident.TagIterator {
return newTagIter(d, opts)
}
// tagIter exposes an ident.TagIterator interface over a doc.Metadata.
type tagIter struct {
docFields doc.Fields
err error
done bool
currentIdx int
currentTag ident.Tag
opts Opts
}
// NB: force tagIter to implement the ident.TagIterator interface.
var _ ident.TagIterator = &tagIter{}
func newTagIter(d doc.Metadata, opts Opts) ident.TagIterator {
return &tagIter{
docFields: d.Fields,
currentIdx: -1,
opts: opts,
}
}
func (t *tagIter) Next() bool {
if t.err != nil || t.done {
return false
}
hasNext := t.parseNext()
if !hasNext {
t.done = true
}
return hasNext
}
func (t *tagIter) parseNext() (hasNext bool) {
t.releaseCurrent()
t.currentIdx++
// early terminate if we know there's no more fields
if t.currentIdx >= len(t.docFields) {
return false
}
// if there are fields, we have to ensure the next field
// is not using the reserved ID fieldname
next := t.docFields[t.currentIdx]
if bytes.Equal(ReservedFieldNameID, next.Name) {
t.err = ErrUsingReservedFieldName
return false
}
// otherwise, we're good.
t.currentTag = ident.Tag{
Name: t.opts.wrapBytes(next.Name),
Value: t.opts.wrapBytes(next.Value),
}
return true
}
func (t *tagIter) releaseCurrent() {
if t.currentTag.Name != nil {
t.currentTag.Name.Finalize()
t.currentTag.Name = nil
}
if t.currentTag.Value != nil {
t.currentTag.Value.Finalize()
t.currentTag.Value = nil
}
}
func (t *tagIter) Current() ident.Tag {
return t.currentTag
}
func (t *tagIter) CurrentIndex() int {
if t.currentIdx >= 0 {
return t.currentIdx
}
return 0
}
func (t *tagIter) Err() error {
return t.err
}
func (t *tagIter) Close() {
t.releaseCurrent()
t.done = true
}
func (t *tagIter) Len() int {
return len(t.docFields)
}
func (t *tagIter) Remaining() int {
l := len(t.docFields) - (t.currentIdx + 1)
return l
}
func (t *tagIter) Duplicate() ident.TagIterator {
var dupe = *t
if t.currentTag.Name != nil {
dupe.currentTag = t.opts.IdentPool.CloneTag(t.currentTag)
}
return &dupe
}
func (t *tagIter) Rewind() {
t.releaseCurrent()
t.currentIdx = -1
t.done = false
}