-
Notifications
You must be signed in to change notification settings - Fork 9
/
cas_directory.go
252 lines (223 loc) · 10.3 KB
/
cas_directory.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
package virtual
import (
"bytes"
"context"
"encoding/binary"
"io"
"sort"
remoteexecution "github.com/bazelbuild/remote-apis/build/bazel/remote/execution/v2"
"github.com/buildbarn/bb-remote-execution/pkg/filesystem/virtual"
"github.com/buildbarn/bb-storage/pkg/digest"
"github.com/buildbarn/bb-storage/pkg/filesystem"
"github.com/buildbarn/bb-storage/pkg/filesystem/path"
"github.com/buildbarn/bb-storage/pkg/util"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
)
// CASDirectoryContext contains all of the methods that the directory
// created by NewCASDirectory uses to obtain its contents and
// instantiate inodes for its children.
type CASDirectoryContext interface {
CASDirectoryFactory
virtual.CASFileFactory
GetDirectoryContents() (*remoteexecution.Directory, virtual.Status)
LogError(err error)
}
type casDirectory struct {
virtual.ReadOnlyDirectory
directoryContext CASDirectoryContext
digestFunction digest.Function
handleAllocator virtual.ResolvableHandleAllocator
sizeBytes uint64
}
// NewCASDirectory creates an immutable directory that is backed by a
// Directory message stored in the Content Addressable Storage (CAS). In
// order to load the Directory message and to instantiate inodes for any
// of its children, calls are made into a CASDirectoryContext object.
//
// TODO: Reimplement this on top of cas.DirectoryWalker.
func NewCASDirectory(directoryContext CASDirectoryContext, digestFunction digest.Function, handleAllocation virtual.ResolvableHandleAllocation, sizeBytes uint64) (virtual.Directory, virtual.HandleResolver) {
d := &casDirectory{
directoryContext: directoryContext,
digestFunction: digestFunction,
sizeBytes: sizeBytes,
}
d.handleAllocator = handleAllocation.AsResolvableAllocator(d.resolveHandle)
return d.createSelf(), d.resolveHandle
}
func (d *casDirectory) createSelf() virtual.Directory {
return d.handleAllocator.New(bytes.NewBuffer([]byte{0})).AsStatelessDirectory(d)
}
func (d *casDirectory) createSymlink(index uint64, target string) virtual.NativeLeaf {
var encodedIndex [binary.MaxVarintLen64]byte
return d.handleAllocator.
New(bytes.NewBuffer(encodedIndex[:binary.PutUvarint(encodedIndex[:], index+1)])).
AsNativeLeaf(virtual.BaseSymlinkFactory.LookupSymlink([]byte(target)))
}
func (d *casDirectory) resolveHandle(r io.ByteReader) (virtual.DirectoryChild, virtual.Status) {
index, err := binary.ReadUvarint(r)
if err != nil {
return virtual.DirectoryChild{}, virtual.StatusErrBadHandle
}
if index == 0 {
return virtual.DirectoryChild{}.FromDirectory(d.createSelf()), virtual.StatusOK
}
// If a suffix is provided, it corresponds to a symbolic link
// inside this directory. Files and directories will be
// resolvable through other means.
directory, s := d.directoryContext.GetDirectoryContents()
if s != virtual.StatusOK {
return virtual.DirectoryChild{}, s
}
index--
if index >= uint64(len(directory.Symlinks)) {
return virtual.DirectoryChild{}, virtual.StatusErrBadHandle
}
return virtual.DirectoryChild{}.FromLeaf(d.createSymlink(index, directory.Symlinks[index].Target)), virtual.StatusOK
}
func (d *casDirectory) VirtualGetAttributes(ctx context.Context, requested virtual.AttributesMask, attributes *virtual.Attributes) {
attributes.SetChangeID(0)
// This should be 2 + nDirectories, but that requires us to load
// the directory. This is highly inefficient and error prone.
attributes.SetLinkCount(virtual.ImplicitDirectoryLinkCount)
attributes.SetFileType(filesystem.FileTypeDirectory)
attributes.SetPermissions(virtual.PermissionsRead | virtual.PermissionsExecute)
attributes.SetSizeBytes(d.sizeBytes)
}
func (d *casDirectory) VirtualLookup(ctx context.Context, name path.Component, requested virtual.AttributesMask, out *virtual.Attributes) (virtual.DirectoryChild, virtual.Status) {
directory, s := d.directoryContext.GetDirectoryContents()
if s != virtual.StatusOK {
return virtual.DirectoryChild{}, s
}
// The Remote Execution protocol requires that entries stored in
// a Directory message are sorted alphabetically. Make use of
// this fact by performing binary searching when looking up
// entries. There is no need to explicitly index the entries.
n := name.String()
directories := directory.Directories
if i := sort.Search(len(directories), func(i int) bool { return directories[i].Name >= n }); i < len(directories) && directories[i].Name == n {
entryDigest, err := d.digestFunction.NewDigestFromProto(directories[i].Digest)
if err != nil {
d.directoryContext.LogError(util.StatusWrapf(err, "Failed to parse digest for directory %#v", n))
return virtual.DirectoryChild{}, virtual.StatusErrIO
}
child := d.directoryContext.LookupDirectory(entryDigest)
child.VirtualGetAttributes(ctx, requested, out)
return virtual.DirectoryChild{}.FromDirectory(child), virtual.StatusOK
}
files := directory.Files
if i := sort.Search(len(files), func(i int) bool { return files[i].Name >= n }); i < len(files) && files[i].Name == n {
entry := files[i]
entryDigest, err := d.digestFunction.NewDigestFromProto(entry.Digest)
if err != nil {
d.directoryContext.LogError(util.StatusWrapf(err, "Failed to parse digest for file %#v", n))
return virtual.DirectoryChild{}, virtual.StatusErrIO
}
child := d.directoryContext.LookupFile(entryDigest, entry.IsExecutable, nil)
child.VirtualGetAttributes(ctx, requested, out)
return virtual.DirectoryChild{}.FromLeaf(child), virtual.StatusOK
}
symlinks := directory.Symlinks
if i := sort.Search(len(symlinks), func(i int) bool { return symlinks[i].Name >= n }); i < len(symlinks) && symlinks[i].Name == n {
f := d.createSymlink(uint64(i), symlinks[i].Target)
f.VirtualGetAttributes(ctx, requested, out)
return virtual.DirectoryChild{}.FromLeaf(f), virtual.StatusOK
}
return virtual.DirectoryChild{}, virtual.StatusErrNoEnt
}
func (d *casDirectory) VirtualOpenChild(ctx context.Context, name path.Component, shareAccess virtual.ShareMask, createAttributes *virtual.Attributes, existingOptions *virtual.OpenExistingOptions, requested virtual.AttributesMask, openedFileAttributes *virtual.Attributes) (virtual.Leaf, virtual.AttributesMask, virtual.ChangeInfo, virtual.Status) {
directory, s := d.directoryContext.GetDirectoryContents()
if s != virtual.StatusOK {
return nil, 0, virtual.ChangeInfo{}, s
}
n := name.String()
directories := directory.Directories
if i := sort.Search(len(directories), func(i int) bool { return directories[i].Name >= n }); i < len(directories) && directories[i].Name == n {
return virtual.ReadOnlyDirectoryOpenChildWrongFileType(existingOptions, virtual.StatusErrIsDir)
}
files := directory.Files
if i := sort.Search(len(files), func(i int) bool { return files[i].Name >= n }); i < len(files) && files[i].Name == n {
if existingOptions == nil {
return nil, 0, virtual.ChangeInfo{}, virtual.StatusErrExist
}
entry := files[i]
entryDigest, err := d.digestFunction.NewDigestFromProto(entry.Digest)
if err != nil {
d.directoryContext.LogError(util.StatusWrapf(err, "Failed to parse digest for file %#v", n))
return nil, 0, virtual.ChangeInfo{}, virtual.StatusErrIO
}
leaf := d.directoryContext.LookupFile(entryDigest, entry.IsExecutable, nil)
s := leaf.VirtualOpenSelf(ctx, shareAccess, existingOptions, requested, openedFileAttributes)
return leaf, existingOptions.ToAttributesMask(), virtual.ChangeInfo{}, s
}
symlinks := directory.Symlinks
if i := sort.Search(len(symlinks), func(i int) bool { return symlinks[i].Name >= n }); i < len(symlinks) && symlinks[i].Name == n {
return virtual.ReadOnlyDirectoryOpenChildWrongFileType(existingOptions, virtual.StatusErrSymlink)
}
return virtual.ReadOnlyDirectoryOpenChildDoesntExist(createAttributes)
}
func (d *casDirectory) VirtualReadDir(ctx context.Context, firstCookie uint64, requested virtual.AttributesMask, reporter virtual.DirectoryEntryReporter) virtual.Status {
directory, s := d.directoryContext.GetDirectoryContents()
if s != virtual.StatusOK {
return s
}
i := firstCookie
nextCookieOffset := uint64(1)
for ; i < uint64(len(directory.Directories)); i++ {
entry := directory.Directories[i]
name, ok := path.NewComponent(entry.Name)
if !ok {
d.directoryContext.LogError(status.Errorf(codes.InvalidArgument, "Directory %#v has an invalid name", entry.Name))
return virtual.StatusErrIO
}
entryDigest, err := d.digestFunction.NewDigestFromProto(entry.Digest)
if err != nil {
d.directoryContext.LogError(util.StatusWrapf(err, "Failed to parse digest for directory %#v", entry.Name))
return virtual.StatusErrIO
}
child := d.directoryContext.LookupDirectory(entryDigest)
var attributes virtual.Attributes
child.VirtualGetAttributes(ctx, requested, &attributes)
if !reporter.ReportEntry(nextCookieOffset+i, name, virtual.DirectoryChild{}.FromDirectory(child), &attributes) {
return virtual.StatusOK
}
}
i -= uint64(len(directory.Directories))
nextCookieOffset += uint64(len(directory.Directories))
for ; i < uint64(len(directory.Files)); i++ {
entry := directory.Files[i]
name, ok := path.NewComponent(entry.Name)
if !ok {
d.directoryContext.LogError(status.Errorf(codes.InvalidArgument, "File %#v has an invalid name", entry.Name))
return virtual.StatusErrIO
}
entryDigest, err := d.digestFunction.NewDigestFromProto(entry.Digest)
if err != nil {
d.directoryContext.LogError(util.StatusWrapf(err, "Failed to parse digest for file %#v", entry.Name))
return virtual.StatusErrIO
}
child := d.directoryContext.LookupFile(entryDigest, entry.IsExecutable, nil)
var attributes virtual.Attributes
child.VirtualGetAttributes(ctx, requested, &attributes)
if !reporter.ReportEntry(nextCookieOffset+i, name, virtual.DirectoryChild{}.FromLeaf(child), &attributes) {
return virtual.StatusOK
}
}
i -= uint64(len(directory.Files))
nextCookieOffset += uint64(len(directory.Files))
for ; i < uint64(len(directory.Symlinks)); i++ {
entry := directory.Symlinks[i]
name, ok := path.NewComponent(entry.Name)
if !ok {
d.directoryContext.LogError(status.Errorf(codes.InvalidArgument, "Symbolic link %#v has an invalid name", entry.Name))
return virtual.StatusErrIO
}
child := d.createSymlink(i, entry.Target)
var attributes virtual.Attributes
child.VirtualGetAttributes(ctx, requested, &attributes)
if !reporter.ReportEntry(nextCookieOffset+i, name, virtual.DirectoryChild{}.FromLeaf(child), &attributes) {
return virtual.StatusOK
}
}
return virtual.StatusOK
}