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
|
package cacheimport
import (
"context"
"strings"
"sync"
"time"
"github.com/containerd/containerd/content"
"github.com/moby/buildkit/session"
"github.com/moby/buildkit/solver"
digest "github.com/opencontainers/go-digest"
ocispecs "github.com/opencontainers/image-spec/specs-go/v1"
"github.com/pkg/errors"
)
func NewCacheChains() *CacheChains {
return &CacheChains{visited: map[interface{}]struct{}{}}
}
type CacheChains struct {
items []*item
visited map[interface{}]struct{}
}
var _ solver.CacheExporterTarget = &CacheChains{}
func (c *CacheChains) Add(dgst digest.Digest) solver.CacheExporterRecord {
if strings.HasPrefix(dgst.String(), "random:") {
// random digests will be different *every* run - so we shouldn't cache
// it, since there's a zero chance this random digest collides again
return &nopRecord{}
}
it := &item{dgst: dgst, backlinks: map[*item]struct{}{}}
c.items = append(c.items, it)
return it
}
func (c *CacheChains) Visit(target any) {
c.visited[target] = struct{}{}
}
func (c *CacheChains) Visited(target any) bool {
_, ok := c.visited[target]
return ok
}
func (c *CacheChains) normalize(ctx context.Context) error {
st := &normalizeState{
added: map[*item]*item{},
links: map[*item]map[nlink]map[digest.Digest]struct{}{},
byKey: map[digest.Digest]*item{},
}
validated := make([]*item, 0, len(c.items))
for _, it := range c.items {
it.backlinksMu.Lock()
it.validate()
it.backlinksMu.Unlock()
}
for _, it := range c.items {
if !it.invalid {
validated = append(validated, it)
}
}
c.items = validated
for _, it := range c.items {
_, err := normalizeItem(it, st)
if err != nil {
return err
}
}
st.removeLoops(ctx)
items := make([]*item, 0, len(st.byKey))
for _, it := range st.byKey {
items = append(items, it)
}
c.items = items
return nil
}
// Marshal converts the cache chains structure into a cache config and a
// collection of providers for reading the results from.
//
// Marshal aims to validate, normalize and sort the output to ensure a
// consistent digest (since cache configs are typically uploaded and stored in
// content-addressable OCI registries).
func (c *CacheChains) Marshal(ctx context.Context) (*CacheConfig, DescriptorProvider, error) {
if err := c.normalize(ctx); err != nil {
return nil, nil, err
}
st := &marshalState{
chainsByID: map[string]int{},
descriptors: DescriptorProvider{},
recordsByItem: map[*item]int{},
}
for _, it := range c.items {
if err := marshalItem(ctx, it, st); err != nil {
return nil, nil, err
}
}
cc := CacheConfig{
Layers: st.layers,
Records: st.records,
}
sortConfig(&cc)
return &cc, st.descriptors, nil
}
type DescriptorProvider map[digest.Digest]DescriptorProviderPair
type DescriptorProviderPair struct {
Descriptor ocispecs.Descriptor
Provider content.Provider
InfoProvider content.InfoProvider
}
func (p DescriptorProviderPair) ReaderAt(ctx context.Context, desc ocispecs.Descriptor) (content.ReaderAt, error) {
return p.Provider.ReaderAt(ctx, desc)
}
func (p DescriptorProviderPair) Info(ctx context.Context, dgst digest.Digest) (content.Info, error) {
if p.InfoProvider != nil {
return p.InfoProvider.Info(ctx, dgst)
}
if dgst != p.Descriptor.Digest {
return content.Info{}, errors.Errorf("content not found %s", dgst)
}
return content.Info{
Digest: p.Descriptor.Digest,
Size: p.Descriptor.Size,
}, nil
}
func (p DescriptorProviderPair) UnlazySession(desc ocispecs.Descriptor) session.Group {
type unlazySession interface {
UnlazySession(ocispecs.Descriptor) session.Group
}
if cd, ok := p.Provider.(unlazySession); ok {
return cd.UnlazySession(desc)
}
return nil
}
func (p DescriptorProviderPair) SnapshotLabels(descs []ocispecs.Descriptor, index int) map[string]string {
type snapshotLabels interface {
SnapshotLabels([]ocispecs.Descriptor, int) map[string]string
}
if cd, ok := p.Provider.(snapshotLabels); ok {
return cd.SnapshotLabels(descs, index)
}
return nil
}
// item is an implementation of a record in the cache chain. After validation,
// normalization and marshalling into the cache config, the item results form
// into the "layers", while the digests and the links form into the "records".
type item struct {
// dgst is the unique identifier for each record.
// This *roughly* corresponds to an edge (vertex cachekey + index) in the
// solver - however, a single vertex can produce multiple unique cache keys
// (e.g. fast/slow), so it's a one-to-many relation.
dgst digest.Digest
// links are what connect records to each other (with an optional selector),
// organized by input index (which correspond to vertex inputs).
// We can have multiple links for each index, since *any* of these could be
// used to get to this item (e.g. we could retrieve by fast/slow key).
links []map[link]struct{}
// backlinks are the inverse of a link - these don't actually get directly
// exported, but they're internally used to help efficiently navigate the
// graph.
backlinks map[*item]struct{}
backlinksMu sync.Mutex
// result is the result of computing the edge - this is the target of the
// data we actually want to store in the cache chain.
result *solver.Remote
resultTime time.Time
invalid bool
}
// link is a pointer to an item, with an optional selector.
type link struct {
src *item
selector string
}
func (c *item) removeLink(src *item) bool {
found := false
for idx := range c.links {
for l := range c.links[idx] {
if l.src == src {
delete(c.links[idx], l)
found = true
}
}
}
for idx := range c.links {
if len(c.links[idx]) == 0 {
c.links = nil
break
}
}
return found
}
func (c *item) AddResult(_ digest.Digest, _ int, createdAt time.Time, result *solver.Remote) {
c.resultTime = createdAt
c.result = result
}
func (c *item) LinkFrom(rec solver.CacheExporterRecord, index int, selector string) {
src, ok := rec.(*item)
if !ok {
return
}
for {
if index < len(c.links) {
break
}
c.links = append(c.links, map[link]struct{}{})
}
c.links[index][link{src: src, selector: selector}] = struct{}{}
src.backlinksMu.Lock()
src.backlinks[c] = struct{}{}
src.backlinksMu.Unlock()
}
// validate checks if an item is valid (i.e. each index has at least one link)
// and marks it as such.
//
// Essentially, if an index has no links, it means that this cache record is
// unreachable by the cache importer, so we should remove it. Once we've marked
// an item as invalid, we remove it from it's backlinks and check it's
// validity again - since now this linked item may be unreachable too.
func (c *item) validate() {
if c.invalid {
// early exit, if the item is already invalid, we've already gone
// through the backlinks
return
}
for _, m := range c.links {
// if an index has no links, there's no way to access this record, so
// mark it as invalid
if len(m) == 0 {
c.invalid = true
break
}
}
if c.invalid {
for bl := range c.backlinks {
// remove ourselves from the backlinked item
changed := false
for _, m := range bl.links {
for l := range m {
if l.src == c {
delete(m, l)
changed = true
}
}
}
// if we've removed ourselves, we need to check it again
if changed {
bl.validate()
}
}
}
}
func (c *item) walkAllResults(fn func(i *item) error, visited map[*item]struct{}) error {
if _, ok := visited[c]; ok {
return nil
}
visited[c] = struct{}{}
if err := fn(c); err != nil {
return err
}
for _, links := range c.links {
for l := range links {
if err := l.src.walkAllResults(fn, visited); err != nil {
return err
}
}
}
return nil
}
// nopRecord is used to discard cache results that we're not interested in storing.
type nopRecord struct {
}
func (c *nopRecord) AddResult(_ digest.Digest, _ int, createdAt time.Time, result *solver.Remote) {
}
func (c *nopRecord) LinkFrom(rec solver.CacheExporterRecord, index int, selector string) {
}
|