-
Notifications
You must be signed in to change notification settings - Fork 9
/
cache.go
219 lines (181 loc) · 6.47 KB
/
cache.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
// Copyright 2022 Namespace Labs Inc; All rights reserved.
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
package compute
import (
"context"
"fmt"
"reflect"
"time"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/trace"
"namespacelabs.dev/foundation/internal/compute/cache"
"namespacelabs.dev/foundation/internal/console"
"namespacelabs.dev/foundation/internal/fnerrors"
"namespacelabs.dev/foundation/internal/versions"
"namespacelabs.dev/foundation/schema"
"namespacelabs.dev/foundation/std/tasks"
)
type Cacheable[V any] interface {
Digester
LoadCached(context.Context, cache.Cache, CacheableInstance, schema.Digest) (Result[V], error)
Cache(context.Context, cache.Cache, V) (schema.Digest, error)
}
type CacheableInstance interface {
NewInstance() interface{}
}
type ComputeDigestFunc func(context.Context, any) (schema.Digest, error)
type cacheable struct {
Type reflect.Type
ComputeDigest ComputeDigestFunc
LoadCached func(context.Context, cache.Cache, CacheableInstance, schema.Digest) (Result[any], error)
Cache func(context.Context, cache.Cache, any) (schema.Digest, error)
}
var cacheables []cacheable
func RegisterCacheable[V any](c Cacheable[V]) {
var t *V // Capture the type.
cacheables = append(cacheables, cacheable{
Type: interfaceType(t),
ComputeDigest: func(ctx context.Context, v any) (schema.Digest, error) {
return c.ComputeDigest(ctx, v)
},
LoadCached: func(ctx context.Context, cache cache.Cache, t CacheableInstance, d schema.Digest) (Result[any], error) {
v, err := c.LoadCached(ctx, cache, t, d)
if err != nil {
return Result[any]{}, err
}
var r Result[any]
r.Digest = v.Digest
r.NonDeterministic = v.NonDeterministic
r.Value = v.Value
return r, nil
},
Cache: func(ctx context.Context, cache cache.Cache, v any) (schema.Digest, error) {
vtyped, ok := v.(V)
if !ok {
return schema.Digest{}, fnerrors.InternalError("failed to cast")
}
return c.Cache(ctx, cache, vtyped)
},
})
}
func interfaceType(t interface{}) reflect.Type {
vt := reflect.TypeOf(t)
if vt.Kind() != reflect.Ptr {
panic("expected pointer to type")
}
elem := vt.Elem()
switch elem.Kind() {
case reflect.Interface, reflect.Slice:
return elem
}
panic("unexpected type, got " + elem.String())
}
type cacheHit struct {
Input schema.Digest
OutputDigest schema.Digest
Hit bool // Always set if we have a stored entry that maps to the inputs.
VerifiedHit bool // If verification is enabled, only set if we've verified the output matches our expectations. Else same value as Hit.
Inputs *computedInputs // Set if VerifyCache is true.
}
func checkLoadCache(ctx context.Context, what string, g *Orch, c computeInstance, cacheable *cacheable, computedDigest schema.Digest, p *Promise[any]) (cacheHit, error) {
var hit cacheHit
err := c.Action().Clone(func(name string) string { return fmt.Sprintf("%s (%s)", what, name) }).
Arg("inputs.digest", computedDigest.String()).
LogLevel(1).
Run(ctx, func(ctx context.Context) error {
output, cached, err := g.cache.LoadEntry(ctx, computedDigest)
if err == nil {
tasks.Attachments(ctx).AddResult("cached", cached)
trace.SpanFromContext(ctx).SetAttributes(attribute.Bool("cached", cached), attribute.String("outputDigest", output.Digest.String()))
if !cached {
return nil
}
v, err := cacheable.LoadCached(ctx, g.cache, c, output.Digest)
if err == nil {
hit.Hit = true
hit.OutputDigest = output.Digest
if VerifyCaching {
hit.Input = computedDigest
verifyComputedDigest(ctx, c.Computable, cacheable, v.Value, output.Digest)
// Don't resolve the promise, so the regular path is triggered.
return nil
}
hit.VerifiedHit = true
return p.resolve(ResultWithTimestamp[any]{Result: v, Cached: true, Completed: output.Timestamp}, nil)
} else {
trace.SpanFromContext(ctx).RecordError(err)
}
} else {
trace.SpanFromContext(ctx).RecordError(err)
}
return nil
})
return hit, err
}
func deferStore(ctx context.Context, g *Orch, c hasAction, cacheable *cacheable, d schema.Digest, ts time.Time, v any, inputs *computedInputs) {
var pointers []schema.Digest
if inputs.Digest.IsSet() {
pointers = append(pointers, inputs.Digest)
}
if inputs.PostComputeDigest.IsSet() {
pointers = append(pointers, inputs.PostComputeDigest)
}
if len(pointers) == 0 {
return
}
g.BestEffort(
c.Action().Clone(func(name string) string { return fmt.Sprintf("cache.store (%s)", name) }).LogLevel(1).Arg("digests", pointers),
func(ctx context.Context) error {
result, err := cacheable.Cache(ctx, g.cache, v)
if err != nil {
return err
}
if VerifyCaching && result != d {
fmt.Fprintf(console.Errors(ctx), "VerifyCache: source of non-determinism writing to the output cache; type=%s cacheableType=%s got=%s expected=%s\n",
typeStr(c), typeStr(cacheable), result, d)
}
entry := cache.CachedOutput{
Digest: result,
Timestamp: ts,
CacheVersion: versions.Builtin().CacheVersion,
}
entry.Debug.PackagePath = inputs.pkgPath
entry.Debug.Typename = inputs.typeName
entry.InputDigests = map[string]string{}
for _, kv := range inputs.digests {
if kv.IsSet {
entry.InputDigests[kv.Name] = kv.Digest
}
}
return g.cache.StoreEntry(ctx, pointers, entry)
})
}
func cacheableFor(outputType interface{}) *cacheable {
vt := reflect.TypeOf(outputType)
if vt == nil {
return nil
}
if vt.Kind() != reflect.Ptr {
return nil
}
elem := vt.Elem()
for _, df := range cacheables {
// We check for both pointers and values as either could implement the
// registered interface. Protos in particular always use pointers.
if elem == df.Type || (df.Type.Kind() == reflect.Interface && (vt.Implements(df.Type) || elem.Implements(df.Type))) {
return &df
}
}
return nil
}
func verifyComputedDigest(ctx context.Context, c UntypedComputable, cacheable *cacheable, v interface{}, outputDigest schema.Digest) {
types := fmt.Sprintf("cacheableType=%s type=%s", typeStr(cacheable), typeStr(c))
computed, err := cacheable.ComputeDigest(ctx, v)
if err != nil {
fmt.Fprintf(console.Errors(ctx), "VerifyCaching: failed to produce digest to verify (%s): %v\n", types, err)
} else if computed != outputDigest {
fmt.Fprintf(console.Errors(ctx), "VerifyCaching: computed digest differs on cache load (%s) got=%s expected=%s\n",
types, computed, outputDigest)
}
}