-
Notifications
You must be signed in to change notification settings - Fork 453
/
types.go
346 lines (295 loc) · 10.5 KB
/
types.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
// Copyright (c) 2016 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 persist
import (
"errors"
"fmt"
"time"
"github.com/m3db/m3/src/dbnode/namespace"
"github.com/m3db/m3/src/dbnode/ts"
"github.com/m3db/m3/src/m3ninx/doc"
"github.com/m3db/m3/src/m3ninx/index/segment"
idxpersist "github.com/m3db/m3/src/m3ninx/persist"
"github.com/m3db/m3/src/x/ident"
"github.com/pborman/uuid"
)
var (
errReuseableTagIteratorRequired = errors.New("reuseable tags iterator is required")
)
// Metadata is metadata for a time series, it can
// have several underlying sources.
type Metadata struct {
metadata doc.Document
id ident.ID
tags ident.Tags
tagsIter ident.TagIterator
opts MetadataOptions
}
// MetadataOptions is options to use when creating metadata.
type MetadataOptions struct {
FinalizeID bool
FinalizeTags bool
FinalizeTagIterator bool
}
// NewMetadata returns a new metadata struct from series metadata.
// Note: because doc.Document has no pools for finalization we do not
// take MetadataOptions here, in future if we have pools or
// some other shared options that Metadata needs we will add it to this
// constructor as well.
func NewMetadata(metadata doc.Document) Metadata {
return Metadata{metadata: metadata}
}
// NewMetadataFromIDAndTags returns a new metadata struct from
// explicit ID and tags.
func NewMetadataFromIDAndTags(
id ident.ID,
tags ident.Tags,
opts MetadataOptions,
) Metadata {
return Metadata{
id: id,
tags: tags,
opts: opts,
}
}
// NewMetadataFromIDAndTagIterator returns a new metadata struct from
// explicit ID and tag iterator.
func NewMetadataFromIDAndTagIterator(
id ident.ID,
tagsIter ident.TagIterator,
opts MetadataOptions,
) Metadata {
return Metadata{
id: id,
tagsIter: tagsIter,
opts: opts,
}
}
// BytesID returns the bytes ID of the series.
func (m Metadata) BytesID() []byte {
if m.id != nil {
return m.id.Bytes()
}
return m.metadata.ID
}
// ResetOrReturnProvidedTagIterator returns a tag iterator
// for the series, returning a direct ref to a provided tag
// iterator or using the reuseable tag iterator provided by the
// callsite if it needs to iterate over tags or fields.
func (m Metadata) ResetOrReturnProvidedTagIterator(
reuseableTagsIterator ident.TagsIterator,
) (ident.TagIterator, error) {
if reuseableTagsIterator == nil {
// Always check to make sure callsites won't
// get a bad allocation pattern of having
// to create one here inline if the metadata
// they are passing in suddenly changes from
// tagsIter to tags or fields with metadata.
return nil, errReuseableTagIteratorRequired
}
if m.tagsIter != nil {
return m.tagsIter, nil
}
if len(m.tags.Values()) > 0 {
reuseableTagsIterator.Reset(m.tags)
return reuseableTagsIterator, reuseableTagsIterator.Err()
}
reuseableTagsIterator.ResetFields(m.metadata.Fields)
return reuseableTagsIterator, reuseableTagsIterator.Err()
}
// Finalize will finalize any resources that requested
// to be finalized.
func (m Metadata) Finalize() {
if m.opts.FinalizeID && m.id != nil {
m.id.Finalize()
}
if m.opts.FinalizeTags && m.tags.Values() != nil {
m.tags.Finalize()
}
if m.opts.FinalizeTagIterator && m.tagsIter != nil {
m.tagsIter.Close()
}
}
// DataFn is a function that persists a m3db segment for a given ID.
type DataFn func(metadata Metadata, segment ts.Segment, checksum uint32) error
// DataCloser is a function that performs cleanup after persisting the data
// blocks for a (shard, blockStart) combination.
type DataCloser func() error
// DeferCloser returns a DataCloser that persists the data checkpoint file when called.
type DeferCloser func() (DataCloser, error)
// PreparedDataPersist is an object that wraps holds a persist function and a closer.
type PreparedDataPersist struct {
Persist DataFn
Close DataCloser
DeferClose DeferCloser
}
// CommitLogFiles represents a slice of commitlog files.
type CommitLogFiles []CommitLogFile
// Contains returns a boolean indicating whether the CommitLogFiles slice
// contains the provided CommitlogFile based on its path.
func (c CommitLogFiles) Contains(path string) bool {
for _, f := range c {
if f.FilePath == path {
return true
}
}
return false
}
// CommitLogFile represents a commit log file and its associated metadata.
type CommitLogFile struct {
FilePath string
Index int64
}
// IndexFn is a function that persists a m3ninx MutableSegment.
type IndexFn func(segment.Builder) error
// IndexCloser is a function that performs cleanup after persisting the index data
// block for a (namespace, blockStart) combination and returns the corresponding
// immutable Segment.
type IndexCloser func() ([]segment.Segment, error)
// PreparedIndexPersist is an object that wraps holds a persist function and a closer.
type PreparedIndexPersist struct {
Persist IndexFn
Close IndexCloser
}
// Manager manages the internals of persisting data onto storage layer.
type Manager interface {
// StartFlushPersist begins a data flush for a set of shards.
StartFlushPersist() (FlushPreparer, error)
// StartSnapshotPersist begins a snapshot for a set of shards.
StartSnapshotPersist(snapshotID uuid.UUID) (SnapshotPreparer, error)
// StartIndexPersist begins a flush for index data.
StartIndexPersist() (IndexFlush, error)
Close()
}
// Preparer can generate a PreparedDataPersist object for writing data for
// a given (shard, blockstart) combination.
type Preparer interface {
// Prepare prepares writing data for a given (shard, blockStart) combination,
// returning a PreparedDataPersist object and any error encountered during
// preparation if any.
PrepareData(opts DataPrepareOptions) (PreparedDataPersist, error)
}
// FlushPreparer is a persist flush cycle, each shard and block start permutation needs
// to explicitly be prepared.
type FlushPreparer interface {
Preparer
// DoneFlush marks the data flush as complete.
DoneFlush() error
}
// SnapshotPreparer is a persist snapshot cycle, each shard and block start permutation needs
// to explicitly be prepared.
type SnapshotPreparer interface {
Preparer
// DoneSnapshot marks the snapshot as complete.
DoneSnapshot(snapshotUUID uuid.UUID, commitLogIdentifier CommitLogFile) error
}
// IndexFlush is a persist flush cycle, each namespace, block combination needs
// to explicitly be prepared.
type IndexFlush interface {
// Prepare prepares writing data for a given ns/blockStart, returning a
// PreparedIndexPersist object and any error encountered during
// preparation if any.
PrepareIndex(opts IndexPrepareOptions) (PreparedIndexPersist, error)
// DoneIndex marks the index flush as complete.
DoneIndex() error
}
// DataPrepareOptions is the options struct for the DataFlush's Prepare method.
// nolint: maligned
type DataPrepareOptions struct {
NamespaceMetadata namespace.Metadata
BlockStart time.Time
Shard uint32
// This volume index is only used when preparing for a flush fileset type.
// When opening a snapshot, the new volume index is determined by looking
// at what files exist on disk.
VolumeIndex int
FileSetType FileSetType
DeleteIfExists bool
// Snapshot options are applicable to snapshots (index yes, data yes)
Snapshot DataPrepareSnapshotOptions
}
// IndexPrepareOptions is the options struct for the IndexFlush's Prepare method.
// nolint: maligned
type IndexPrepareOptions struct {
NamespaceMetadata namespace.Metadata
BlockStart time.Time
FileSetType FileSetType
Shards map[uint32]struct{}
IndexVolumeType idxpersist.IndexVolumeType
}
// DataPrepareSnapshotOptions is the options struct for the Prepare method that contains
// information specific to read/writing snapshot files.
type DataPrepareSnapshotOptions struct {
SnapshotTime time.Time
SnapshotID uuid.UUID
}
// FileSetType is an enum that indicates what type of files a fileset contains
type FileSetType int
func (f FileSetType) String() string {
switch f {
case FileSetFlushType:
return "flush"
case FileSetSnapshotType:
return "snapshot"
}
return fmt.Sprintf("unknown: %d", f)
}
const (
// FileSetFlushType indicates that the fileset files contain a complete flush
FileSetFlushType FileSetType = iota
// FileSetSnapshotType indicates that the fileset files contain a snapshot
FileSetSnapshotType
)
// FileSetContentType is an enum that indicates what the contents of files a fileset contains
type FileSetContentType int
func (f FileSetContentType) String() string {
switch f {
case FileSetDataContentType:
return "data"
case FileSetIndexContentType:
return "index"
}
return fmt.Sprintf("unknown: %d", f)
}
const (
// FileSetDataContentType indicates that the fileset files contents is time series data
FileSetDataContentType FileSetContentType = iota
// FileSetIndexContentType indicates that the fileset files contain time series index metadata
FileSetIndexContentType
)
// OnFlushNewSeriesEvent is the fields related to a flush of a new series.
type OnFlushNewSeriesEvent struct {
Shard uint32
BlockStart time.Time
FirstWrite time.Time
SeriesMetadata doc.Document
}
// OnFlushSeries performs work on a per series level.
type OnFlushSeries interface {
OnFlushNewSeries(OnFlushNewSeriesEvent) error
}
// NoOpColdFlushNamespace is a no-op impl of OnFlushSeries.
type NoOpColdFlushNamespace struct{}
// OnFlushNewSeries is a no-op.
func (n *NoOpColdFlushNamespace) OnFlushNewSeries(event OnFlushNewSeriesEvent) error {
return nil
}
// Done is a no-op.
func (n *NoOpColdFlushNamespace) Done() error { return nil }