-
Notifications
You must be signed in to change notification settings - Fork 451
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[dbnode] Add claims for index segments volume index (#2846)
- Loading branch information
1 parent
5b5c050
commit 251dc3d
Showing
29 changed files
with
523 additions
and
49 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| // Copyright (c) 2020 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 fs | ||
|
|
||
| import ( | ||
| "errors" | ||
| "sync" | ||
| "time" | ||
|
|
||
| "github.com/m3db/m3/src/dbnode/namespace" | ||
| "github.com/m3db/m3/src/dbnode/retention" | ||
| "github.com/m3db/m3/src/x/clock" | ||
| "github.com/m3db/m3/src/x/ident" | ||
| xtime "github.com/m3db/m3/src/x/time" | ||
| ) | ||
|
|
||
| var errOutOfRetentionClaim = errors.New("out of retention index volume claim") | ||
|
|
||
| type indexClaimsManager struct { | ||
| sync.Mutex | ||
|
|
||
| filePathPrefix string | ||
| nowFn clock.NowFn | ||
| nextIndexFileSetVolumeIndexFn nextIndexFileSetVolumeIndexFn | ||
|
|
||
| // Map of ns ID string -> blockStart -> volumeIndexClaim. | ||
| volumeIndexClaims map[string]map[xtime.UnixNano]volumeIndexClaim | ||
| } | ||
|
|
||
| type volumeIndexClaim struct { | ||
| volumeIndex int | ||
| } | ||
|
|
||
| // NewIndexClaimsManager returns an instance of the index claim manager. This manages | ||
| // concurrent claims for volume indices per ns and block start. | ||
| // NB(bodu): There should be only a single shared index claim manager among all threads | ||
| // writing index data filesets. | ||
| func NewIndexClaimsManager(opts Options) IndexClaimsManager { | ||
| return &indexClaimsManager{ | ||
| filePathPrefix: opts.FilePathPrefix(), | ||
| nowFn: opts.ClockOptions().NowFn(), | ||
| volumeIndexClaims: make(map[string]map[xtime.UnixNano]volumeIndexClaim), | ||
| nextIndexFileSetVolumeIndexFn: NextIndexFileSetVolumeIndex, | ||
| } | ||
| } | ||
|
|
||
| func (i *indexClaimsManager) ClaimNextIndexFileSetVolumeIndex( | ||
| md namespace.Metadata, | ||
| blockStart time.Time, | ||
| ) (int, error) { | ||
| i.Lock() | ||
| earliestBlockStart := retention.FlushTimeStartForRetentionPeriod( | ||
| md.Options().RetentionOptions().RetentionPeriod(), | ||
| md.Options().IndexOptions().BlockSize(), | ||
| i.nowFn(), | ||
| ) | ||
| defer func() { | ||
| i.deleteOutOfRetentionEntriesWithLock(md.ID(), earliestBlockStart) | ||
| i.Unlock() | ||
| }() | ||
|
|
||
| // Reject out of retention claims. | ||
| if blockStart.Before(earliestBlockStart) { | ||
| return 0, errOutOfRetentionClaim | ||
| } | ||
|
|
||
| volumeIndexClaimsByBlockStart, ok := i.volumeIndexClaims[md.ID().String()] | ||
| if !ok { | ||
| volumeIndexClaimsByBlockStart = make(map[xtime.UnixNano]volumeIndexClaim) | ||
| i.volumeIndexClaims[md.ID().String()] = volumeIndexClaimsByBlockStart | ||
| } | ||
|
|
||
| blockStartUnixNanos := xtime.ToUnixNano(blockStart) | ||
| if curr, ok := volumeIndexClaimsByBlockStart[blockStartUnixNanos]; ok { | ||
| // Already had a previous claim, return the next claim. | ||
| next := curr | ||
| next.volumeIndex++ | ||
| volumeIndexClaimsByBlockStart[blockStartUnixNanos] = next | ||
| return next.volumeIndex, nil | ||
| } | ||
|
|
||
| volumeIndex, err := i.nextIndexFileSetVolumeIndexFn(i.filePathPrefix, md.ID(), | ||
| blockStart) | ||
| if err != nil { | ||
| return 0, err | ||
| } | ||
| volumeIndexClaimsByBlockStart[blockStartUnixNanos] = volumeIndexClaim{ | ||
| volumeIndex: volumeIndex, | ||
| } | ||
| return volumeIndex, nil | ||
| } | ||
|
|
||
| func (i *indexClaimsManager) deleteOutOfRetentionEntriesWithLock( | ||
| nsID ident.ID, | ||
| earliestBlockStart time.Time, | ||
| ) { | ||
| earliestBlockStartUnixNanos := xtime.ToUnixNano(earliestBlockStart) | ||
| // ns ID already exists at this point since the delete call is deferred. | ||
| for blockStart := range i.volumeIndexClaims[nsID.String()] { | ||
| if blockStart.Before(earliestBlockStartUnixNanos) { | ||
| delete(i.volumeIndexClaims[nsID.String()], blockStart) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| type nextIndexFileSetVolumeIndexFn func( | ||
| filePathPrefix string, | ||
| namespace ident.ID, | ||
| blockStart time.Time, | ||
| ) (int, error) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| // Copyright (c) 2020 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 fs | ||
|
|
||
| import ( | ||
| "sync" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
|
|
||
| "github.com/m3db/m3/src/dbnode/namespace" | ||
| "github.com/m3db/m3/src/x/ident" | ||
| xtime "github.com/m3db/m3/src/x/time" | ||
| ) | ||
|
|
||
| func TestIndexClaimsManagerConcurrentClaims(t *testing.T) { | ||
| mgr, ok := NewIndexClaimsManager(NewOptions()).(*indexClaimsManager) | ||
| require.True(t, ok) | ||
|
|
||
| // Always return 0 for starting volume index for testing purposes. | ||
| mgr.nextIndexFileSetVolumeIndexFn = func( | ||
| filePathPrefix string, | ||
| namespace ident.ID, | ||
| blockStart time.Time, | ||
| ) (int, error) { | ||
| return 0, nil | ||
| } | ||
|
|
||
| md, err := namespace.NewMetadata(ident.StringID("foo"), namespace.NewOptions()) | ||
| require.NoError(t, err) | ||
|
|
||
| var ( | ||
| m sync.Map | ||
| wg sync.WaitGroup | ||
| blockSize = md.Options().IndexOptions().BlockSize() | ||
| blockStart = time.Now().Truncate(blockSize) | ||
| ) | ||
| for i := 0; i < 10; i++ { | ||
| wg.Add(1) | ||
| go func() { | ||
| defer wg.Done() | ||
| for j := 0; j < 100; j++ { | ||
| volumeIndex, err := mgr.ClaimNextIndexFileSetVolumeIndex( | ||
| md, | ||
| blockStart, | ||
| ) | ||
| require.NoError(t, err) | ||
| _, loaded := m.LoadOrStore(volumeIndex, true) | ||
| // volume index should not have been previously stored or | ||
| // there are conflicting volume indices. | ||
| require.False(t, loaded) | ||
| } | ||
| }() | ||
| } | ||
| wg.Wait() | ||
| } | ||
|
|
||
| // TestIndexClaimsManagerOutOfRetention ensure that we both reject and delete out of | ||
| // retention index claims. | ||
| func TestIndexClaimsManagerOutOfRetention(t *testing.T) { | ||
| mgr, ok := NewIndexClaimsManager(NewOptions()).(*indexClaimsManager) | ||
| require.True(t, ok) | ||
|
|
||
| // Always return 0 for starting volume index for testing purposes. | ||
| mgr.nextIndexFileSetVolumeIndexFn = func( | ||
| filePathPrefix string, | ||
| namespace ident.ID, | ||
| blockStart time.Time, | ||
| ) (int, error) { | ||
| return 0, nil | ||
| } | ||
|
|
||
| md, err := namespace.NewMetadata(ident.StringID("foo"), namespace.NewOptions()) | ||
| blockSize := md.Options().IndexOptions().BlockSize() | ||
| blockStart := time.Now().Truncate(blockSize) | ||
| require.NoError(t, err) | ||
|
|
||
| _, err = mgr.ClaimNextIndexFileSetVolumeIndex( | ||
| md, | ||
| blockStart, | ||
| ) | ||
| require.NoError(t, err) | ||
|
|
||
| now := mgr.nowFn().Add(md.Options().RetentionOptions().RetentionPeriod()). | ||
| Add(blockSize) | ||
| mgr.nowFn = func() time.Time { return now } | ||
| _, err = mgr.ClaimNextIndexFileSetVolumeIndex( | ||
| md, | ||
| blockStart, | ||
| ) | ||
| require.Equal(t, errOutOfRetentionClaim, err) | ||
|
|
||
| // Verify that the out of retention entry has been deleted as well. | ||
| _, ok = mgr.volumeIndexClaims[md.ID().String()][xtime.ToUnixNano(blockStart)] | ||
| require.False(t, ok) | ||
| } |
Oops, something went wrong.