-
Notifications
You must be signed in to change notification settings - Fork 154
/
grpc_bytestream.go
589 lines (493 loc) · 15.7 KB
/
grpc_bytestream.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
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
package server
import (
"context"
"errors"
"fmt"
"io"
"strconv"
"strings"
"google.golang.org/genproto/googleapis/bytestream"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
"github.com/buchgr/bazel-remote/cache"
"github.com/buchgr/bazel-remote/cache/disk/casblob"
"github.com/klauspost/compress/zstd"
"github.com/buchgr/bazel-remote/utils/zstdpool"
syncpool "github.com/mostynb/zstdpool-syncpool"
)
const (
// The maximum chunk size to write back to the client in Send calls.
// Inspired by Goma's FileBlob.FILE_CHUNK maxium size.
maxChunkSize = 2 * 1024 * 1024 // 2M
)
var decoderPool = zstdpool.GetDecoderPool()
// ByteStreamServer interface:
var emptyZstdBlob = []byte{40, 181, 47, 253, 32, 0, 1, 0, 0}
func (s *grpcServer) Read(req *bytestream.ReadRequest,
resp bytestream.ByteStream_ReadServer) error {
errorPrefix := "GRPC BYTESTREAM READ"
var cmp casblob.CompressionType
hash, size, cmp, err := s.parseReadResource(req.ResourceName, errorPrefix)
if err != nil {
return err
}
if size == 0 {
if cmp == casblob.Identity {
s.accessLogger.Printf("GRPC BYTESTREAM READ COMPLETED %s", req.ResourceName)
return nil
}
// The client asked for a zstd-compressed empty blob. Weird.
err := resp.Send(&bytestream.ReadResponse{Data: emptyZstdBlob})
if err != nil {
msg := fmt.Sprintf("GRPC BYTESTREAM READ FAILED TO SEND RESPONSE: %s %v", hash, err)
s.accessLogger.Printf(msg)
return status.Error(codes.Unknown, msg)
}
s.accessLogger.Printf("GRPC BYTESTREAM READ COMPLETED %s", req.ResourceName)
return nil
}
if req.ReadOffset < 0 {
s.accessLogger.Printf("GRPC BYTESTREAM READ OFFSET INVALID: %s %d",
req.ReadOffset)
return status.Error(codes.InvalidArgument,
"Negative ReadOffset is invalid")
}
if cmp != casblob.Identity && req.ReadLimit != 0 {
s.accessLogger.Printf("GRPC BYTESTREAM READ LIMIT INVALID: %s %d",
req.ReadLimit)
return status.Error(codes.InvalidArgument,
"ReadLimit must be 0 for compressed-blobs")
}
if req.ReadLimit < 0 {
s.accessLogger.Printf("GRPC BYTESTREAM READ LIMIT OUT OF RANGE: %s %d",
req.ReadLimit)
return status.Error(codes.OutOfRange,
"Negative ReadLimit is out of range")
}
limitedSend := (req.ReadLimit != 0) && cmp == casblob.Identity
sendLimitRemaining := req.ReadLimit
if req.ReadOffset > size {
msg := fmt.Sprintf("ReadOffset %d larger than expected data size %d resource: %s",
req.ReadOffset, size, req.ResourceName)
s.accessLogger.Printf("GRPC BYTESTREAM READ FAILED %s: %s", hash, msg)
return status.Error(codes.OutOfRange, msg)
}
var rc io.ReadCloser
var foundSize int64
if cmp == casblob.Zstandard {
rc, foundSize, err = s.cache.GetZstd(resp.Context(), hash, size, req.ReadOffset)
} else {
rc, foundSize, err = s.cache.Get(resp.Context(), cache.CAS, hash, size, req.ReadOffset)
}
if rc != nil {
defer rc.Close()
}
if err != nil {
msg := fmt.Sprintf("GRPC BYTESTREAM READ FAILED: %s %v", hash, err)
s.accessLogger.Printf(msg)
code := gRPCErrCode(err, codes.Internal)
return status.Error(code, msg)
}
if rc == nil {
msg := fmt.Sprintf("GRPC BYTESTREAM READ BLOB NOT FOUND: %s", hash)
s.accessLogger.Printf(msg)
return status.Error(codes.NotFound, msg)
}
if foundSize != size {
// This should have been caught above.
msg := fmt.Sprintf("GRPC BYTESTREAM READ BLOB SIZE MISMATCH: %s (EXPECTED %d, FOUND %d)",
hash, size, foundSize)
s.accessLogger.Printf(msg)
return status.Error(codes.Internal, msg)
}
bufSize := size
if bufSize > maxChunkSize {
bufSize = maxChunkSize
}
buf := make([]byte, bufSize)
var chunkResp bytestream.ReadResponse
for {
n, err := rc.Read(buf)
if n > 0 {
if limitedSend {
if (sendLimitRemaining - int64(n)) < 0 {
msg := fmt.Sprintf("GRPC BYTESTREAM READ FAILED: %s READ LIMIT EXCEEDED", hash)
s.accessLogger.Printf(msg)
return status.Error(codes.OutOfRange, msg)
}
sendLimitRemaining -= int64(n)
}
chunkResp.Data = buf[:n]
sendErr := resp.Send(&chunkResp)
if sendErr != nil {
msg := fmt.Sprintf("GRPC BYTESTREAM READ FAILED TO SEND RESPONSE: %s %v", hash, sendErr)
s.accessLogger.Printf(msg)
return status.Error(codes.Unknown, msg)
}
}
if err == io.EOF {
s.accessLogger.Printf("GRPC BYTESTREAM READ COMPLETED %s",
req.ResourceName)
return nil
}
if err != nil {
msg := fmt.Sprintf("GRPC BYTESTREAM READ FAILED: %s %v", hash, err)
s.accessLogger.Printf(msg)
return status.Error(codes.Unknown, msg)
}
}
}
// Parse a ReadRequest.ResourceName, return the validated hash, size, compression type and an error.
func (s *grpcServer) parseReadResource(name string, errorPrefix string) (string, int64, casblob.CompressionType, error) {
// The resource name should be of the format:
// [{instance_name}]/blobs/{hash}/{size}
// Or:
// [{instance_name}]/compressed-blobs/{compressor}/{uncompressed_hash}/{uncompressed_size}
// Instance_name is ignored in this bytestream implementation, so don't
// bother returning it. It is not allowed to contain "blobs" as a distinct
// path segment.
fields := strings.Split(name, "/")
var rem []string
foundBlobs := false
foundCompressedBlobs := false
for i := range fields {
if fields[i] == "blobs" {
rem = fields[i+1:]
foundBlobs = true
break
}
if fields[i] == "compressed-blobs" {
rem = fields[i+1:]
foundCompressedBlobs = true
break
}
}
if foundBlobs {
if len(rem) != 2 {
msg := fmt.Sprintf("Unable to parse resource name: %s", name)
s.accessLogger.Printf("%s: %s", errorPrefix, msg)
return "", 0, casblob.Identity,
status.Error(codes.InvalidArgument, msg)
}
hash := rem[0]
size, err := strconv.ParseInt(rem[1], 10, 64)
if err != nil {
msg := fmt.Sprintf("Invalid size: %s from %q", rem[1], name)
s.accessLogger.Printf("%s: %s", errorPrefix, msg)
return "", 0, casblob.Identity,
status.Error(codes.InvalidArgument, msg)
}
if size < 0 {
msg := fmt.Sprintf("Invalid size (must be non-negative): %d from %q", size, name)
s.accessLogger.Printf("%s: %s", errorPrefix, msg)
return "", 0, casblob.Identity,
status.Error(codes.InvalidArgument, msg)
}
err = s.validateHash(hash, size, errorPrefix)
if err != nil {
return "", 0, casblob.Identity, err
}
return hash, size, casblob.Identity, nil
}
if !foundCompressedBlobs || len(rem) != 3 {
msg := fmt.Sprintf("Unable to parse resource name: %s", name)
s.accessLogger.Printf("%s: %s", errorPrefix, msg)
return "", 0, casblob.Identity,
status.Error(codes.InvalidArgument, msg)
}
if rem[0] != "zstd" {
msg := fmt.Sprintf("Unable to parse compressor in resource name: %s", name)
s.accessLogger.Printf("%s: %s", errorPrefix, msg)
return "", 0, casblob.Identity,
status.Error(codes.InvalidArgument, msg)
}
hash := rem[1]
sizeStr := rem[2]
size, err := strconv.ParseInt(sizeStr, 10, 64)
if err != nil {
msg := fmt.Sprintf("Invalid size: %s from %q", sizeStr, name)
s.accessLogger.Printf("%s: %s", errorPrefix, msg)
return "", 0, casblob.Zstandard,
status.Error(codes.InvalidArgument, msg)
}
if size < 0 {
msg := fmt.Sprintf("Invalid size (must be non-negative): %d from %q", size, name)
s.accessLogger.Printf("%s: %s", errorPrefix, msg)
return "", 0, casblob.Zstandard,
status.Error(codes.InvalidArgument, msg)
}
err = s.validateHash(hash, size, errorPrefix)
if err != nil {
return "", 0, casblob.Zstandard, err
}
return hash, size, casblob.Zstandard, nil
}
// Parse a WriteRequest.ResourceName, return the validated hash, size,
// compression type and an optional error.
func (s *grpcServer) parseWriteResource(r string) (string, int64, casblob.CompressionType, error) {
// req.ResourceName is of the form:
// [{instance_name}/]uploads/{uuid}/blobs/{hash}/{size}[/{optionalmetadata}]
// Or, for compressed blobs:
// [{instance_name}/]uploads/{uuid}/compressed-blobs/{compressor}/{uncompressed_hash}/{uncompressed_size}[{/optional_metadata}]
fields := strings.Split(r, "/")
var rem []string
for i := range fields {
if fields[i] == "uploads" {
rem = fields[i+1:]
break
}
}
if len(rem) < 4 {
return "", 0, casblob.Identity,
status.Errorf(codes.InvalidArgument, "Unable to parse resource name: %s", r)
}
// rem[0] should hold the uuid, which we don't use- ignore it.
if rem[1] == "blobs" {
hash := rem[2]
size, err := strconv.ParseInt(rem[3], 10, 64)
if err != nil {
return "", 0, casblob.Identity,
status.Errorf(codes.InvalidArgument, "Unable to parse size: %s from %q", rem[3], r)
}
if size < 0 {
return "", 0, casblob.Identity,
status.Errorf(codes.InvalidArgument, "Invalid size (must be non-negative): %d from %q", size, r)
}
err = s.validateHash(hash, size, "GRPC BYTESTREAM READ FAILED")
if err != nil {
return "", 0, casblob.Identity, err
}
return hash, size, casblob.Identity, nil
}
if rem[1] != "compressed-blobs" || len(rem) < 5 || rem[2] != "zstd" {
return "", 0, casblob.Zstandard,
status.Errorf(codes.InvalidArgument, "Unable to parse resource name: %s", r)
}
sizeStr := rem[4]
size, err := strconv.ParseInt(sizeStr, 10, 64)
if err != nil {
return "", 0, casblob.Zstandard,
status.Errorf(codes.InvalidArgument, "Unable to parse size: %s from %q", sizeStr, r)
}
if size < 0 {
return "", 0, casblob.Zstandard,
status.Errorf(codes.InvalidArgument, "Invalid size (must be non-negative): %d from %q", size, r)
}
hash := rem[3]
err = s.validateHash(hash, size, "GRPC BYTESTREAM READ FAILED")
if err != nil {
return "", 0, casblob.Zstandard, err
}
return hash, size, casblob.Zstandard, nil
}
var errWriteOffset error = errors.New("bytestream writes from non-zero offsets are unsupported")
var errDecoderPoolFail error = errors.New("failed to get DecoderWrapper from pool")
func (s *grpcServer) Write(srv bytestream.ByteStream_WriteServer) error {
if s.checkClientCertForWrites {
err := checkGRPCClientCert(srv.Context())
if err != nil {
return err
}
}
var resp bytestream.WriteResponse
pr, pw := io.Pipe()
putResult := make(chan error, 1)
recvResult := make(chan error, 1)
resourceNameChan := make(chan string, 1)
cmp := casblob.Identity
var dec *zstd.Decoder
defer func() {
if dec != nil {
dec.Close()
}
}()
go func() {
firstIteration := true
var resourceName string
var size int64
for {
req, err := srv.Recv()
if err == io.EOF {
if cmp == casblob.Identity && resp.CommittedSize != size {
msg := fmt.Sprintf("Unexpected amount of data read: %d expected: %d",
resp.CommittedSize, size)
recvResult <- status.Error(codes.Unknown, msg)
return
}
recvResult <- io.EOF
return
}
if err != nil {
recvResult <- status.Error(codes.Internal, err.Error())
return
}
if firstIteration {
resourceName = req.ResourceName
if resourceName == "" {
msg := "Empty resource name"
s.accessLogger.Printf("GRPC BYTESTREAM WRITE FAILED: %s", msg)
recvResult <- status.Error(codes.InvalidArgument, msg)
return
}
resourceNameChan <- resourceName
close(resourceNameChan)
var hash string
hash, size, cmp, err = s.parseWriteResource(resourceName)
if err != nil {
s.accessLogger.Printf("GRPC BYTESTREAM WRITE FAILED: %s", err)
recvResult <- err
return
}
exists, _ := s.cache.Contains(srv.Context(), cache.CAS, hash, size)
if exists {
// Blob already exists, return without writing anything.
resp.CommittedSize = size
putResult <- io.EOF
return
}
resp.CommittedSize = req.WriteOffset
if req.WriteOffset != 0 {
err = errWriteOffset
s.accessLogger.Printf("GRPC BYTESTREAM WRITE FAILED: %s", err)
recvResult <- err
return
}
var rc io.ReadCloser = pr
if cmp == casblob.Zstandard {
dec, ok := decoderPool.Get().(*syncpool.DecoderWrapper)
if !ok {
s.accessLogger.Printf("GRPC BYTESTREAM WRITE FAILED: %s", errDecoderPoolFail)
recvResult <- errDecoderPoolFail
return
}
err = dec.Reset(pr)
if err != nil {
s.accessLogger.Printf("GRPC BYTESTREAM WRITE FAILED: %s", err)
recvResult <- err
return
}
rc = dec.IOReadCloser()
}
go func() {
err := s.cache.Put(cache.CAS, hash, size, rc)
putResult <- err
}()
firstIteration = false
} else {
if req.ResourceName != "" && resourceName != req.ResourceName {
msg := fmt.Sprintf("Resource name changed in a single Write %v -> %v",
resourceName, req.ResourceName)
recvResult <- status.Error(codes.InvalidArgument, msg)
return
}
}
n, err := pw.Write(req.Data)
if err != nil {
recvResult <- status.Error(codes.Internal, err.Error())
return
}
resp.CommittedSize += int64(n)
if cmp == casblob.Identity && resp.CommittedSize > size {
msg := fmt.Sprintf("Client sent more than %d data! %d", size, resp.CommittedSize)
recvResult <- status.Error(codes.OutOfRange, msg)
return
}
// Possibly redundant check, since we explicitly check for
// EOF at the start of each loop.
if req.FinishWrite {
if cmp == casblob.Identity && resp.CommittedSize != size {
msg := fmt.Sprintf("Unexpected amount of data read: %d expected: %d",
resp.CommittedSize, size)
recvResult <- status.Error(codes.Unknown, msg)
return
}
recvResult <- io.EOF
return
}
}
}()
resourceName := "unknown-resource"
select {
case err, ok := <-recvResult:
if !ok {
select {
case resourceName = <-resourceNameChan:
default:
}
msg := fmt.Sprintf("GRPC BYTESTREAM WRITE FAILED: %s Receive loop closed unexpectedly.", resourceName)
s.accessLogger.Printf(msg)
return status.Error(codes.Internal, msg)
}
if err == io.EOF {
pw.Close()
break
}
if err != nil {
select {
case resourceName = <-resourceNameChan:
default:
}
_ = pw.CloseWithError(err)
s.accessLogger.Printf("GRPC BYTESTREAM WRITE FAILED: %s %s",
resourceName, err.Error())
return err
}
case err := <-putResult:
select {
case resourceName = <-resourceNameChan:
default:
}
if err == io.EOF {
s.accessLogger.Printf("GRPC BYTESTREAM SKIPPED WRITE: %s", resourceName)
err = srv.SendAndClose(&resp)
if err != nil {
msg := fmt.Sprintf("GRPC BYTESTREAM SKIPPED WRITE FAILED: %s %v", resourceName, err)
s.accessLogger.Printf(msg)
return status.Error(codes.Internal, msg)
}
return nil
}
if err == nil {
// Unexpected early return. Should not happen.
msg := fmt.Sprintf("GRPC BYTESTREAM WRITE INTERNAL ERROR %s", resourceName)
s.accessLogger.Printf(msg)
return status.Error(codes.Internal, msg)
}
msg := fmt.Sprintf("GRPC BYTESTREAM WRITE CACHE ERROR: %s %v", resourceName, err)
s.accessLogger.Printf(msg)
return status.Error(codes.Internal, msg)
}
select {
case resourceName = <-resourceNameChan:
default:
}
err := <-putResult
if err == io.EOF {
s.accessLogger.Printf("GRPC BYTESTREAM SKIPPED WRITE: %s", resourceName)
err = srv.SendAndClose(&resp)
if err != nil {
msg := fmt.Sprintf("GRPC BYTESTREAM SKIPPED WRITE FAILED: %s %v", resourceName, err)
s.accessLogger.Printf(msg)
return status.Error(codes.Internal, msg)
}
return nil
}
if err != nil {
msg := fmt.Sprintf("GRPC BYTESTREAM WRITE FAILED: %s Cache Put failed: %v", resourceName, err)
s.accessLogger.Printf(msg)
code := gRPCErrCode(err, codes.Internal)
return status.Error(code, msg)
}
err = srv.SendAndClose(&resp)
if err != nil {
msg := fmt.Sprintf("GRPC BYTESTREAM WRITE FAILED: %s %v", resourceName, err)
s.accessLogger.Printf(msg)
return status.Error(codes.Unknown, msg)
}
s.accessLogger.Printf("GRPC BYTESTREAM WRITE COMPLETED: %s", resourceName)
return nil
}
func (s *grpcServer) QueryWriteStatus(context.Context, *bytestream.QueryWriteStatusRequest) (*bytestream.QueryWriteStatusResponse, error) {
return nil, status.Error(codes.Unimplemented,
"QueryWriteStatus is not implemented")
}