-
Notifications
You must be signed in to change notification settings - Fork 348
/
garbage_collection_manager.go
215 lines (196 loc) · 6.92 KB
/
garbage_collection_manager.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
package retention
import (
"bytes"
"context"
"encoding/csv"
"errors"
"fmt"
"io"
"os"
"strings"
"time"
"github.com/rs/xid"
"github.com/treeverse/lakefs/pkg/block"
"github.com/treeverse/lakefs/pkg/graveler"
"google.golang.org/protobuf/proto"
)
const (
configFileSuffixTemplate = "%s/retention/gc/rules/config.json"
addressesFilePrefixTemplate = "%s/retention/gc/addresses/"
commitsFileSuffixTemplate = "%s/retention/gc/commits/run_id=%s/commits.csv"
uncommittedPrefixTemplate = "%s/retention/gc/uncommitted/"
uncommittedFilePrefixTemplate = uncommittedPrefixTemplate + "%s/uncommitted/"
// unixYear4000 epoch value for Saturday, January 1, 4000 12:00:00 AM. Changing this value is a breaking change as it is used to have reverse order for time based unique ID (xid).
unixYear4000 = 64060588800
)
type GarbageCollectionManager struct {
blockAdapter block.Adapter
refManager graveler.RefManager
committedBlockStoragePrefix string
}
func (m *GarbageCollectionManager) GetCommitsCSVLocation(runID string, sn graveler.StorageNamespace) (string, error) {
key := fmt.Sprintf(commitsFileSuffixTemplate, m.committedBlockStoragePrefix, runID)
qk, err := m.blockAdapter.ResolveNamespace(sn.String(), key, block.IdentifierTypeRelative)
if err != nil {
return "", err
}
return qk.Format(), nil
}
func (m *GarbageCollectionManager) GetAddressesLocation(sn graveler.StorageNamespace) (string, error) {
key := fmt.Sprintf(addressesFilePrefixTemplate, m.committedBlockStoragePrefix)
qk, err := m.blockAdapter.ResolveNamespace(sn.String(), key, block.IdentifierTypeRelative)
if err != nil {
return "", err
}
return qk.Format(), nil
}
// GetUncommittedLocation return full path to underlying storage path to store uncommitted information
func (m *GarbageCollectionManager) GetUncommittedLocation(runID string, sn graveler.StorageNamespace) (string, error) {
key := fmt.Sprintf(uncommittedFilePrefixTemplate, m.committedBlockStoragePrefix, runID)
qk, err := m.blockAdapter.ResolveNamespace(sn.String(), key, block.IdentifierTypeRelative)
if err != nil {
return "", err
}
return qk.Format(), nil
}
func (m *GarbageCollectionManager) SaveGarbageCollectionUncommitted(ctx context.Context, repository *graveler.RepositoryRecord, filename, runID string) error {
location, err := m.GetUncommittedLocation(runID, repository.StorageNamespace)
if err != nil {
return err
}
fd, err := os.Open(filename)
if err != nil {
return err
}
stat, err := fd.Stat()
if err != nil {
return err
}
if !strings.HasSuffix(location, "/") {
location += "/"
}
location += filename
return m.blockAdapter.Put(ctx, block.ObjectPointer{
Identifier: location,
IdentifierType: block.IdentifierTypeFull,
}, stat.Size(), fd, block.PutOpts{})
}
type RepositoryCommitGetter struct {
refManager graveler.RefManager
repository *graveler.RepositoryRecord
}
func (r *RepositoryCommitGetter) ListCommits(ctx context.Context) (graveler.CommitIterator, error) {
return r.refManager.ListCommits(ctx, r.repository)
}
func NewGarbageCollectionManager(blockAdapter block.Adapter, refManager graveler.RefManager, committedBlockStoragePrefix string) *GarbageCollectionManager {
return &GarbageCollectionManager{
blockAdapter: blockAdapter,
refManager: refManager,
committedBlockStoragePrefix: committedBlockStoragePrefix,
}
}
func (m *GarbageCollectionManager) GetRules(ctx context.Context, storageNamespace graveler.StorageNamespace) (*graveler.GarbageCollectionRules, error) {
objectPointer := block.ObjectPointer{
StorageNamespace: string(storageNamespace),
Identifier: fmt.Sprintf(configFileSuffixTemplate, m.committedBlockStoragePrefix),
IdentifierType: block.IdentifierTypeRelative,
}
reader, err := m.blockAdapter.Get(ctx, objectPointer, -1)
if errors.Is(err, block.ErrDataNotFound) {
return nil, graveler.ErrNotFound
}
if err != nil {
return nil, err
}
defer func() {
_ = reader.Close()
}()
var rules graveler.GarbageCollectionRules
rulesBytes, err := io.ReadAll(reader)
if err != nil {
return nil, err
}
if len(rulesBytes) == 0 {
// empty file - no GC rules
return nil, graveler.ErrNotFound
}
err = proto.Unmarshal(rulesBytes, &rules)
if err != nil {
return nil, err
}
return &rules, nil
}
func (m *GarbageCollectionManager) SaveRules(ctx context.Context, storageNamespace graveler.StorageNamespace, rules *graveler.GarbageCollectionRules) error {
rulesBytes, err := proto.Marshal(rules)
if err != nil {
return err
}
return m.blockAdapter.Put(ctx, block.ObjectPointer{
StorageNamespace: string(storageNamespace),
Identifier: fmt.Sprintf(configFileSuffixTemplate, m.committedBlockStoragePrefix),
IdentifierType: block.IdentifierTypeRelative,
}, int64(len(rulesBytes)), bytes.NewReader(rulesBytes), block.PutOpts{})
}
func (m *GarbageCollectionManager) SaveGarbageCollectionCommits(ctx context.Context, repository *graveler.RepositoryRecord, rules *graveler.GarbageCollectionRules) (string, error) {
commitGetter := &RepositoryCommitGetter{
refManager: m.refManager,
repository: repository,
}
branchIterator, err := m.refManager.GCBranchIterator(ctx, repository)
if err != nil {
return "", err
}
defer branchIterator.Close()
// get all commits that are not the first parent of any commit:
commitIterator, err := m.refManager.GCCommitIterator(ctx, repository)
if err != nil {
return "", fmt.Errorf("create kv orderd commit iterator commits: %w", err)
}
defer commitIterator.Close()
startingPointIterator := NewGCStartingPointIterator(commitIterator, branchIterator)
defer startingPointIterator.Close()
gcCommits, err := GetGarbageCollectionCommits(ctx, startingPointIterator, commitGetter, rules)
if err != nil {
return "", fmt.Errorf("find expired commits: %w", err)
}
b := &strings.Builder{}
csvWriter := csv.NewWriter(b)
// (TODO) - remove expired column from the CSV file and from the GC logic
headers := []string{"commit_id", "expired", "metarange_id"}
if err = csvWriter.Write(headers); err != nil {
return "", err
}
for commitID, metarangeID := range gcCommits {
err := csvWriter.Write([]string{string(commitID), "false", string(metarangeID)})
if err != nil {
return "", err
}
}
csvWriter.Flush()
err = csvWriter.Error()
if err != nil {
return "", err
}
commitsStr := b.String()
runID := m.NewID()
csvLocation, err := m.GetCommitsCSVLocation(runID, repository.StorageNamespace)
if err != nil {
return "", err
}
err = m.blockAdapter.Put(ctx, block.ObjectPointer{
Identifier: csvLocation,
IdentifierType: block.IdentifierTypeFull,
}, int64(len(commitsStr)), strings.NewReader(commitsStr), block.PutOpts{})
if err != nil {
return "", err
}
return runID, nil
}
func (m *GarbageCollectionManager) NewID() string {
return newDescendingID(time.Now()).String()
}
// TODO: Unify implementations of descending IDs
func newDescendingID(tm time.Time) xid.ID {
t := time.Unix(unixYear4000-tm.Unix(), 0).UTC()
return xid.NewWithTime(t)
}