Skip to content

Commit 791b62b

Browse files
committed
fix: only expire files chisel wrote, and keep going past failures
Expire removed anything old under the digest directories, and the first entry it could not remove stopped the whole run. It now only looks at regular files named like a digest of that kind, or like the temporary files of an unfinished write, and returns the first failure after trying every entry. The concurrent expiry test depended on scheduling. It is replaced by a test that removes an entry between listing and removal on purpose.
1 parent 27e0a3a commit 791b62b

4 files changed

Lines changed: 149 additions & 29 deletions

File tree

‎internal/AGENTS.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ flowchart LR
3030
- `deb/` - Debian package utilities: data tarball access, version comparison, and architecture handling.
3131
- `tarball/` - Extracts selected files from a package data tarball into a target directory.
3232
- `archive/` - Manages remote Ubuntu package archive sources over HTTP/HTTPS.
33-
- `cache/` - Content-addressable on-disk store keyed by SHA256 or SHA384 digest, with digest verification and last-use timestamps.
33+
- `cache/` - Content-addressable on-disk store keyed by SHA256 or SHA384 digest, with digest verification, last-use timestamps, and expiry of entries left unused.
3434
- `fsutil/` - Core filesystem operations for writing files, directories, and symlinks into the target root filesystem.
3535
- `manifestutil/` - Generates the Chisel manifest.
3636
- `scripts/` - Executes Starlark mutation scripts defined in slice definitions.

‎internal/cache/cache.go‎

Lines changed: 44 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,10 @@ import (
77
"fmt"
88
"hash"
99
"io"
10+
"io/fs"
1011
"os"
1112
"path/filepath"
13+
"regexp"
1214
"time"
1315

1416
"golang.org/x/crypto/sha3"
@@ -102,6 +104,15 @@ const (
102104

103105
var digestKinds = []DigestKind{SHA256, SHA384, SHA512}
104106

107+
// entryNames matches the names Chisel writes in the directory of each digest
108+
// kind: an entry named after its digest, or a temporary file left behind by a
109+
// write that did not finish.
110+
var entryNames = map[DigestKind]*regexp.Regexp{
111+
SHA256: regexp.MustCompile(`^([0-9a-f]{64}(\.tmp)?|tmp\.[0-9]+)$`),
112+
SHA384: regexp.MustCompile(`^([0-9a-f]{96}(\.tmp)?|tmp\.[0-9]+)$`),
113+
SHA512: regexp.MustCompile(`^([0-9a-f]{128}(\.tmp)?|tmp\.[0-9]+)$`),
114+
}
115+
105116
var ErrMiss = fmt.Errorf("not cached")
106117

107118
func (c *Cache) filePath(digestKind DigestKind, digest string) string {
@@ -187,35 +198,54 @@ func (c *Cache) Read(digestKind DigestKind, digest string) ([]byte, error) {
187198
return data, nil
188199
}
189200

201+
// Expire removes the entries that were last used longer than timeout ago.
202+
// Only files Chisel wrote are considered. A failure on one entry does not
203+
// stop the others from being expired, and the first failure is returned.
190204
func (c *Cache) Expire(timeout time.Duration) error {
191205
expired := time.Now().Add(-timeout)
206+
var firstErr error
192207
for _, digestKind := range digestKinds {
193208
digestKindDir := filepath.Join(c.Dir, string(digestKind))
194209
entries, err := os.ReadDir(digestKindDir)
195210
if os.IsNotExist(err) {
196211
continue
197212
}
198213
if err != nil {
199-
return fmt.Errorf("cannot list cache directory: %v", err)
214+
if firstErr == nil {
215+
firstErr = fmt.Errorf("cannot list cache directory: %v", err)
216+
}
217+
continue
200218
}
201219
for _, entry := range entries {
202-
// Entries may vanish while listing, e.g. renamed from .tmp by
203-
// a writer or removed by a concurrent expiry.
204-
finfo, err := entry.Info()
205-
if os.IsNotExist(err) {
206-
continue
207-
}
208-
if err != nil {
209-
return err
210-
}
211-
if finfo.ModTime().After(expired) {
220+
if !entry.Type().IsRegular() || !entryNames[digestKind].MatchString(entry.Name()) {
212221
continue
213222
}
214-
err = os.Remove(filepath.Join(digestKindDir, finfo.Name()))
215-
if err != nil && !os.IsNotExist(err) {
216-
return fmt.Errorf("cannot expire cache entry: %v", err)
223+
err := expireEntry(filepath.Join(digestKindDir, entry.Name()), entry, expired)
224+
if err != nil && firstErr == nil {
225+
firstErr = err
217226
}
218227
}
219228
}
229+
return firstErr
230+
}
231+
232+
// expireEntry removes the entry at path if it was last used before expired.
233+
// Entries may vanish meanwhile, renamed from .tmp by a writer or removed by a
234+
// concurrent expiry, and that is not an error.
235+
func expireEntry(path string, entry fs.DirEntry, expired time.Time) error {
236+
finfo, err := entry.Info()
237+
if os.IsNotExist(err) {
238+
return nil
239+
}
240+
if err != nil {
241+
return fmt.Errorf("cannot expire cache entry: %v", err)
242+
}
243+
if finfo.ModTime().After(expired) {
244+
return nil
245+
}
246+
err = os.Remove(path)
247+
if err != nil && !os.IsNotExist(err) {
248+
return fmt.Errorf("cannot expire cache entry: %v", err)
249+
}
220250
return nil
221251
}

‎internal/cache/cache_test.go‎

Lines changed: 101 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
package cache_test
22

33
import (
4-
"fmt"
54
"io"
5+
"io/fs"
66
"os"
77
"path/filepath"
88
"strings"
@@ -305,32 +305,119 @@ func (s *S) TestCacheExpireNoDigestKindDirs(c *C) {
305305
c.Assert(err, IsNil)
306306
}
307307

308-
func (s *S) TestCacheExpireConcurrent(c *C) {
308+
func (s *S) TestCacheExpireOnlyOwnEntries(c *C) {
309309
cc := cache.Cache{Dir: c.MkDir()}
310310
dir := filepath.Join(cc.Dir, "sha256")
311311
err := os.MkdirAll(dir, 0755)
312312
c.Assert(err, IsNil)
313313

314+
// Names Chisel writes: entries and leftovers of unfinished writes.
315+
own := []string{
316+
data1Digest,
317+
data2Digest + ".tmp",
318+
"tmp.123456",
319+
}
320+
// Anything else, including digests of another kind or length, upper
321+
// case digests, and a directory named after a digest.
322+
other := []string{
323+
"README",
324+
data3Digest + ".partial",
325+
strings.ToUpper(data2Digest),
326+
data3Digest[:63],
327+
data3Digest + data3Digest,
328+
"tmp.abc",
329+
}
314330
expiredTime := time.Now().Add(-2 * time.Hour)
315-
for i := 0; i < 2000; i++ {
316-
name := filepath.Join(dir, fmt.Sprintf("%064x", i))
317-
err := os.WriteFile(name, nil, 0644)
331+
for _, name := range append(own, other...) {
332+
path := filepath.Join(dir, name)
333+
err := os.WriteFile(path, nil, 0644)
318334
c.Assert(err, IsNil)
319-
err = os.Chtimes(name, expiredTime, expiredTime)
335+
err = os.Chtimes(path, expiredTime, expiredTime)
320336
c.Assert(err, IsNil)
321337
}
338+
digestDir := filepath.Join(dir, data3Digest)
339+
err = os.Mkdir(digestDir, 0755)
340+
c.Assert(err, IsNil)
341+
err = os.WriteFile(filepath.Join(digestDir, "file"), nil, 0644)
342+
c.Assert(err, IsNil)
343+
err = os.Chtimes(digestDir, expiredTime, expiredTime)
344+
c.Assert(err, IsNil)
345+
346+
err = cc.Expire(time.Hour)
347+
c.Assert(err, IsNil)
348+
349+
for _, name := range own {
350+
_, err := os.Stat(filepath.Join(dir, name))
351+
c.Assert(os.IsNotExist(err), Equals, true, Commentf("%s", name))
352+
}
353+
for _, name := range append(other, data3Digest) {
354+
_, err := os.Stat(filepath.Join(dir, name))
355+
c.Assert(err, IsNil, Commentf("%s", name))
356+
}
357+
}
322358

323-
// Expiries running at the same time remove entries the others have
324-
// listed too, and must not fail because of it.
325-
errs := make(chan error, 4)
326-
for i := 0; i < 4; i++ {
327-
go func() { errs <- cc.Expire(time.Hour) }()
359+
func (s *S) TestCacheExpireKeepsGoing(c *C) {
360+
if os.Getuid() == 0 {
361+
c.Skip("root can remove files from a read-only directory")
328362
}
329-
for i := 0; i < 4; i++ {
330-
c.Assert(<-errs, IsNil)
363+
cc := cache.Cache{Dir: c.MkDir()}
364+
err := cc.Write(cache.SHA256, data1Digest, []byte("data1"))
365+
c.Assert(err, IsNil)
366+
w := cc.Create(cache.SHA512, "")
367+
_, err = w.Write([]byte("sha512data1"))
368+
c.Assert(err, IsNil)
369+
err = w.Close()
370+
c.Assert(err, IsNil)
371+
372+
sha256Entry := filepath.Join(cc.Dir, "sha256", data1Digest)
373+
sha512Entry := filepath.Join(cc.Dir, "sha512", w.Digest())
374+
expiredTime := time.Now().Add(-2 * time.Hour)
375+
for _, path := range []string{sha256Entry, sha512Entry} {
376+
err := os.Chtimes(path, expiredTime, expiredTime)
377+
c.Assert(err, IsNil)
331378
}
332379

380+
// The sha256 entry cannot be removed, which must not keep the sha512
381+
// entry from being expired.
382+
sha256Dir := filepath.Join(cc.Dir, "sha256")
383+
err = os.Chmod(sha256Dir, 0555)
384+
c.Assert(err, IsNil)
385+
defer func() {
386+
err := os.Chmod(sha256Dir, 0755)
387+
c.Assert(err, IsNil)
388+
}()
389+
390+
err = cc.Expire(time.Hour)
391+
c.Assert(err, ErrorMatches, "cannot expire cache entry: remove .*/sha256/"+data1Digest+": permission denied")
392+
393+
_, err = os.Stat(sha256Entry)
394+
c.Assert(err, IsNil)
395+
_, err = os.Stat(sha512Entry)
396+
c.Assert(os.IsNotExist(err), Equals, true)
397+
}
398+
399+
func (s *S) TestCacheExpireVanishedEntry(c *C) {
400+
cc := cache.Cache{Dir: c.MkDir()}
401+
err := cc.Write(cache.SHA256, data1Digest, []byte("data1"))
402+
c.Assert(err, IsNil)
403+
dir := filepath.Join(cc.Dir, "sha256")
404+
path := filepath.Join(dir, data1Digest)
405+
expiredTime := time.Now().Add(-2 * time.Hour)
406+
err = os.Chtimes(path, expiredTime, expiredTime)
407+
c.Assert(err, IsNil)
408+
409+
// Listed and then removed by someone else before it was looked at.
333410
entries, err := os.ReadDir(dir)
334411
c.Assert(err, IsNil)
335-
c.Assert(entries, HasLen, 0)
412+
c.Assert(entries, HasLen, 1)
413+
finfo, err := os.Stat(path)
414+
c.Assert(err, IsNil)
415+
err = os.Remove(path)
416+
c.Assert(err, IsNil)
417+
err = cache.ExpireEntry(path, entries[0], time.Now().Add(-time.Hour))
418+
c.Assert(err, IsNil)
419+
420+
// Looked at and then removed by someone else before it was removed.
421+
err = cache.ExpireEntry(path, fs.FileInfoToDirEntry(finfo), time.Now().Add(-time.Hour))
422+
c.Assert(err, IsNil)
336423
}

‎internal/cache/export_test.go‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
package cache
2+
3+
var ExpireEntry = expireEntry

0 commit comments

Comments
 (0)