-
Notifications
You must be signed in to change notification settings - Fork 1.4k
/
lib_repo.go
573 lines (453 loc) · 14.5 KB
/
lib_repo.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
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
/*
Copyright the Velero contributors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package kopialib
import (
"context"
"os"
"runtime"
"strings"
"sync/atomic"
"time"
"github.com/kopia/kopia/repo"
"github.com/kopia/kopia/repo/compression"
"github.com/kopia/kopia/repo/content/index"
"github.com/kopia/kopia/repo/maintenance"
"github.com/kopia/kopia/repo/manifest"
"github.com/kopia/kopia/repo/object"
"github.com/kopia/kopia/snapshot/snapshotmaintenance"
"github.com/pkg/errors"
"github.com/sirupsen/logrus"
"github.com/vmware-tanzu/velero/pkg/repository/udmrepo"
"github.com/vmware-tanzu/velero/pkg/util/logging"
)
type kopiaRepoService struct {
logger logrus.FieldLogger
}
type kopiaRepository struct {
rawRepo repo.Repository
rawWriter repo.RepositoryWriter
description string
uploaded int64
openTime time.Time
throttle logThrottle
logger logrus.FieldLogger
}
type kopiaMaintenance struct {
mode maintenance.Mode
startTime time.Time
uploaded int64
throttle logThrottle
logger logrus.FieldLogger
}
type logThrottle struct {
lastTime int64
interval time.Duration
}
type kopiaObjectReader struct {
rawReader object.Reader
}
type kopiaObjectWriter struct {
rawWriter object.Writer
}
const (
defaultLogInterval = time.Second * 10
defaultMaintainCheckPeriod = time.Hour
overwriteFullMaintainInterval = time.Duration(0)
overwriteQuickMaintainInterval = time.Duration(0)
)
var kopiaRepoOpen = repo.Open
// NewKopiaRepoService creates an instance of BackupRepoService implemented by Kopia
func NewKopiaRepoService(logger logrus.FieldLogger) udmrepo.BackupRepoService {
ks := &kopiaRepoService{
logger: logger,
}
return ks
}
func (ks *kopiaRepoService) Init(ctx context.Context, repoOption udmrepo.RepoOptions, createNew bool) error {
repoCtx := logging.SetupKopiaLog(ctx, ks.logger)
if createNew {
if err := CreateBackupRepo(repoCtx, repoOption); err != nil {
return err
}
return writeInitParameters(repoCtx, repoOption, ks.logger)
} else {
return ConnectBackupRepo(repoCtx, repoOption)
}
}
func (ks *kopiaRepoService) Open(ctx context.Context, repoOption udmrepo.RepoOptions) (udmrepo.BackupRepo, error) {
repoConfig := repoOption.ConfigFilePath
if repoConfig == "" {
return nil, errors.New("invalid config file path")
}
if _, err := os.Stat(repoConfig); os.IsNotExist(err) {
return nil, errors.Wrapf(err, "repo config %s doesn't exist", repoConfig)
}
repoCtx := logging.SetupKopiaLog(ctx, ks.logger)
r, err := openKopiaRepo(repoCtx, repoConfig, repoOption.RepoPassword)
if err != nil {
return nil, err
}
kr := kopiaRepository{
rawRepo: r,
openTime: time.Now(),
description: repoOption.Description,
throttle: logThrottle{
interval: defaultLogInterval,
},
logger: ks.logger,
}
_, kr.rawWriter, err = r.NewWriter(repoCtx, repo.WriteSessionOptions{
Purpose: repoOption.Description,
OnUpload: kr.updateProgress,
})
if err != nil {
if e := r.Close(repoCtx); e != nil {
ks.logger.WithError(e).Error("Failed to close raw repository on error")
}
return nil, errors.Wrap(err, "error to create repo writer")
}
return &kr, nil
}
func (ks *kopiaRepoService) Maintain(ctx context.Context, repoOption udmrepo.RepoOptions) error {
repoConfig := repoOption.ConfigFilePath
if repoConfig == "" {
return errors.New("invalid config file path")
}
if _, err := os.Stat(repoConfig); os.IsNotExist(err) {
return errors.Wrapf(err, "repo config %s doesn't exist", repoConfig)
}
repoCtx := logging.SetupKopiaLog(ctx, ks.logger)
r, err := openKopiaRepo(repoCtx, repoConfig, repoOption.RepoPassword)
if err != nil {
return err
}
defer func() {
c := r.Close(repoCtx)
if c != nil {
ks.logger.WithError(c).Error("Failed to close repo")
}
}()
km := kopiaMaintenance{
mode: maintenance.ModeAuto,
startTime: time.Now(),
throttle: logThrottle{
interval: defaultLogInterval,
},
logger: ks.logger,
}
if mode, exist := repoOption.GeneralOptions[udmrepo.GenOptionMaintainMode]; exist {
if strings.EqualFold(mode, udmrepo.GenOptionMaintainFull) {
km.mode = maintenance.ModeFull
} else if strings.EqualFold(mode, udmrepo.GenOptionMaintainQuick) {
km.mode = maintenance.ModeQuick
}
}
err = repo.DirectWriteSession(repoCtx, r.(repo.DirectRepository), repo.WriteSessionOptions{
Purpose: "UdmRepoMaintenance",
OnUpload: km.maintainProgress,
}, func(ctx context.Context, dw repo.DirectRepositoryWriter) error {
return km.runMaintenance(ctx, dw)
})
if err != nil {
return errors.Wrap(err, "error to maintain repo")
}
return nil
}
func (ks *kopiaRepoService) DefaultMaintenanceFrequency() time.Duration {
return defaultMaintainCheckPeriod
}
func (km *kopiaMaintenance) runMaintenance(ctx context.Context, rep repo.DirectRepositoryWriter) error {
err := snapshotmaintenance.Run(logging.SetupKopiaLog(ctx, km.logger), rep, km.mode, false, maintenance.SafetyFull)
if err != nil {
return errors.Wrapf(err, "error to run maintenance under mode %s", km.mode)
}
return nil
}
// maintainProgress is called when the repository writes a piece of blob data to the storage during the maintenance
func (km *kopiaMaintenance) maintainProgress(uploaded int64) {
total := atomic.AddInt64(&km.uploaded, uploaded)
if km.throttle.shouldLog() {
km.logger.WithFields(
logrus.Fields{
"Start Time": km.startTime.Format(time.RFC3339Nano),
"Current": time.Now().Format(time.RFC3339Nano),
},
).Debugf("Repo maintenance uploaded %d bytes.", total)
}
}
func (kr *kopiaRepository) OpenObject(ctx context.Context, id udmrepo.ID) (udmrepo.ObjectReader, error) {
if kr.rawRepo == nil {
return nil, errors.New("repo is closed or not open")
}
reader, err := kr.rawRepo.OpenObject(logging.SetupKopiaLog(ctx, kr.logger), object.ID(id))
if err != nil {
return nil, errors.Wrap(err, "error to open object")
}
return &kopiaObjectReader{
rawReader: reader,
}, nil
}
func (kr *kopiaRepository) GetManifest(ctx context.Context, id udmrepo.ID, mani *udmrepo.RepoManifest) error {
if kr.rawRepo == nil {
return errors.New("repo is closed or not open")
}
metadata, err := kr.rawRepo.GetManifest(logging.SetupKopiaLog(ctx, kr.logger), manifest.ID(id), mani.Payload)
if err != nil {
return errors.Wrap(err, "error to get manifest")
}
mani.Metadata = getManifestEntryFromKopia(metadata)
return nil
}
func (kr *kopiaRepository) FindManifests(ctx context.Context, filter udmrepo.ManifestFilter) ([]*udmrepo.ManifestEntryMetadata, error) {
if kr.rawRepo == nil {
return nil, errors.New("repo is closed or not open")
}
metadata, err := kr.rawRepo.FindManifests(logging.SetupKopiaLog(ctx, kr.logger), filter.Labels)
if err != nil {
return nil, errors.Wrap(err, "error to find manifests")
}
return getManifestEntriesFromKopia(metadata), nil
}
func (kr *kopiaRepository) Time() time.Time {
if kr.rawRepo == nil {
return time.Time{}
}
return kr.rawRepo.Time()
}
func (kr *kopiaRepository) Close(ctx context.Context) error {
if kr.rawWriter != nil {
err := kr.rawWriter.Close(logging.SetupKopiaLog(ctx, kr.logger))
if err != nil {
return errors.Wrap(err, "error to close repo writer")
}
kr.rawWriter = nil
}
if kr.rawRepo != nil {
err := kr.rawRepo.Close(logging.SetupKopiaLog(ctx, kr.logger))
if err != nil {
return errors.Wrap(err, "error to close repo")
}
kr.rawRepo = nil
}
return nil
}
func (kr *kopiaRepository) NewObjectWriter(ctx context.Context, opt udmrepo.ObjectWriteOptions) udmrepo.ObjectWriter {
if kr.rawWriter == nil {
return nil
}
writer := kr.rawWriter.NewObjectWriter(logging.SetupKopiaLog(ctx, kr.logger), object.WriterOptions{
Description: opt.Description,
Prefix: index.ID(opt.Prefix),
AsyncWrites: getAsyncWrites(),
Compressor: getCompressorForObject(opt),
})
if writer == nil {
return nil
}
return &kopiaObjectWriter{
rawWriter: writer,
}
}
func (kr *kopiaRepository) PutManifest(ctx context.Context, manifest udmrepo.RepoManifest) (udmrepo.ID, error) {
if kr.rawWriter == nil {
return "", errors.New("repo writer is closed or not open")
}
id, err := kr.rawWriter.PutManifest(logging.SetupKopiaLog(ctx, kr.logger), manifest.Metadata.Labels, manifest.Payload)
if err != nil {
return "", errors.Wrap(err, "error to put manifest")
}
return udmrepo.ID(id), nil
}
func (kr *kopiaRepository) DeleteManifest(ctx context.Context, id udmrepo.ID) error {
if kr.rawWriter == nil {
return errors.New("repo writer is closed or not open")
}
err := kr.rawWriter.DeleteManifest(logging.SetupKopiaLog(ctx, kr.logger), manifest.ID(id))
if err != nil {
return errors.Wrap(err, "error to delete manifest")
}
return nil
}
func (kr *kopiaRepository) Flush(ctx context.Context) error {
if kr.rawWriter == nil {
return errors.New("repo writer is closed or not open")
}
err := kr.rawWriter.Flush(logging.SetupKopiaLog(ctx, kr.logger))
if err != nil {
return errors.Wrap(err, "error to flush repo")
}
return nil
}
// updateProgress is called when the repository writes a piece of blob data to the storage during data write
func (kr *kopiaRepository) updateProgress(uploaded int64) {
total := atomic.AddInt64(&kr.uploaded, uploaded)
if kr.throttle.shouldLog() {
kr.logger.WithFields(
logrus.Fields{
"Description": kr.description,
"Open Time": kr.openTime.Format(time.RFC3339Nano),
"Current": time.Now().Format(time.RFC3339Nano),
},
).Debugf("Repo uploaded %d bytes.", total)
}
}
func (kor *kopiaObjectReader) Read(p []byte) (int, error) {
if kor.rawReader == nil {
return 0, errors.New("object reader is closed or not open")
}
return kor.rawReader.Read(p)
}
func (kor *kopiaObjectReader) Seek(offset int64, whence int) (int64, error) {
if kor.rawReader == nil {
return -1, errors.New("object reader is closed or not open")
}
return kor.rawReader.Seek(offset, whence)
}
func (kor *kopiaObjectReader) Close() error {
if kor.rawReader == nil {
return nil
}
err := kor.rawReader.Close()
if err != nil {
return err
}
kor.rawReader = nil
return nil
}
func (kor *kopiaObjectReader) Length() int64 {
if kor.rawReader == nil {
return -1
}
return kor.rawReader.Length()
}
func (kow *kopiaObjectWriter) Write(p []byte) (int, error) {
if kow.rawWriter == nil {
return 0, errors.New("object writer is closed or not open")
}
return kow.rawWriter.Write(p)
}
func (kow *kopiaObjectWriter) Seek(offset int64, whence int) (int64, error) {
return -1, errors.New("not supported")
}
func (kow *kopiaObjectWriter) Checkpoint() (udmrepo.ID, error) {
if kow.rawWriter == nil {
return udmrepo.ID(""), errors.New("object writer is closed or not open")
}
id, err := kow.rawWriter.Checkpoint()
if err != nil {
return udmrepo.ID(""), errors.Wrap(err, "error to checkpoint object")
}
return udmrepo.ID(id), nil
}
func (kow *kopiaObjectWriter) Result() (udmrepo.ID, error) {
if kow.rawWriter == nil {
return udmrepo.ID(""), errors.New("object writer is closed or not open")
}
id, err := kow.rawWriter.Result()
if err != nil {
return udmrepo.ID(""), errors.Wrap(err, "error to wait object")
}
return udmrepo.ID(id), nil
}
func (kow *kopiaObjectWriter) Close() error {
if kow.rawWriter == nil {
return nil
}
err := kow.rawWriter.Close()
if err != nil {
return err
}
kow.rawWriter = nil
return nil
}
// getAsyncWrites returns the number of concurrent async writes
func getAsyncWrites() int {
return runtime.NumCPU()
}
// getCompressorForObject returns the compressor for an object, at present, we don't support compression
func getCompressorForObject(opt udmrepo.ObjectWriteOptions) compression.Name {
return ""
}
func getManifestEntryFromKopia(kMani *manifest.EntryMetadata) *udmrepo.ManifestEntryMetadata {
return &udmrepo.ManifestEntryMetadata{
ID: udmrepo.ID(kMani.ID),
Labels: kMani.Labels,
Length: int32(kMani.Length),
ModTime: kMani.ModTime,
}
}
func getManifestEntriesFromKopia(kMani []*manifest.EntryMetadata) []*udmrepo.ManifestEntryMetadata {
var ret []*udmrepo.ManifestEntryMetadata
for _, entry := range kMani {
ret = append(ret, &udmrepo.ManifestEntryMetadata{
ID: udmrepo.ID(entry.ID),
Labels: entry.Labels,
Length: int32(entry.Length),
ModTime: entry.ModTime,
})
}
return ret
}
func (lt *logThrottle) shouldLog() bool {
nextOutputTime := atomic.LoadInt64(<.lastTime)
if nowNano := time.Now().UnixNano(); nowNano > nextOutputTime {
if atomic.CompareAndSwapInt64(<.lastTime, nextOutputTime, nowNano+lt.interval.Nanoseconds()) {
return true
}
}
return false
}
func openKopiaRepo(ctx context.Context, configFile string, password string) (repo.Repository, error) {
r, err := kopiaRepoOpen(ctx, configFile, password, &repo.Options{})
if os.IsNotExist(err) {
return nil, errors.Wrap(err, "error to open repo, repo doesn't exist")
}
if err != nil {
return nil, errors.Wrap(err, "error to open repo")
}
return r, nil
}
func writeInitParameters(ctx context.Context, repoOption udmrepo.RepoOptions, logger logrus.FieldLogger) error {
r, err := openKopiaRepo(ctx, repoOption.ConfigFilePath, repoOption.RepoPassword)
if err != nil {
return err
}
defer func() {
c := r.Close(ctx)
if c != nil {
logger.WithError(c).Error("Failed to close repo")
}
}()
err = repo.WriteSession(ctx, r, repo.WriteSessionOptions{
Purpose: "set init parameters",
}, func(ctx context.Context, w repo.RepositoryWriter) error {
p := maintenance.DefaultParams()
if overwriteFullMaintainInterval != time.Duration(0) {
logger.Infof("Full maintenance interval change from %v to %v", p.FullCycle.Interval, overwriteFullMaintainInterval)
p.FullCycle.Interval = overwriteFullMaintainInterval
}
if overwriteQuickMaintainInterval != time.Duration(0) {
logger.Infof("Quick maintenance interval change from %v to %v", p.QuickCycle.Interval, overwriteQuickMaintainInterval)
p.QuickCycle.Interval = overwriteQuickMaintainInterval
}
p.Owner = r.ClientOptions().UsernameAtHost()
if err := maintenance.SetParams(ctx, w, &p); err != nil {
return errors.Wrap(err, "error to set maintenance params")
}
return nil
})
if err != nil {
return errors.Wrap(err, "error to init write repo parameters")
}
return nil
}