Skip to content

(*zstdByteStreamWriter).Write and (*readStreamWriter).Write implementations are unsound #342

Description

@tamird

Per the io.Writer documentation:

type Writer interface {
	Write(p []byte) (n int, err error)
}

[...]
Implementations must not retain p.

While the implementations:

func (w *readStreamWriter) Write(p []byte) (int, error) {
if err := w.out.Send(&bytestream.ReadResponse{Data: p}); err != nil {
return 0, err
}
return len(p), nil
}

func (w *zstdByteStreamWriter) Write(p []byte) (int, error) {
if err := w.client.Send(&bytestream.WriteRequest{
ResourceName: w.resourceName,
WriteOffset: w.writeOffset,
Data: p,
}); err != nil {
return 0, err
}
w.writeOffset += int64(len(p))
w.resourceName = ""
return len(p), nil
}

call ByteStream_ReadServer.Send and ByteStream_WriteClient.Send which in turn call ServerStream.SendMsg and ClientStream.SendMsg both of which document:

// It is not safe to modify the message after calling SendMsg. Tracing
// libraries and stats handlers may use the message lazily.

Thus these implementations are unsound.

It is not possible to soundly implement io.Writer on top of ClientStream.SendMsg or ServerStream.SendMsg without internally copying (and allocating, because grpc never lets us know when buffers passed into it can be safely reused).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions