mirror of
https://github.com/milvus-io/milvus.git
synced 2026-07-21 10:15:43 +00:00
89f107fa00
issue: #50742 ## What this PR does Optimizes protobuf decoding on Milvus RPC read/write hot paths with a hand-written decoder in `pkg/util/fastpb`. The final change contains no gRPC connection-pool or connection-count changes. ## Fast decoder coverage The gRPC `releaseCodec.Unmarshal` path dispatches these top-level messages to fastpb: - `internalpb.RetrieveResults` - `milvuspb.InsertRequest` - `milvuspb.UpsertRequest` `schemapb.SearchResultData` is not a top-level codec-dispatched message. It is decoded directly from `SlicedBlob` at the search/reduce hot paths in: - `internal/proxy/search_reduce_util.go` - `internal/querynodev2/segments/result.go` - `internal/querynodev2/local_worker.go` - `internal/querynodev2/tasks/search_task_go_reduce.go` Nested hot messages such as `FieldData`, scalar/vector arrays, and IDs are decoded by the same package. Main optimizations: - varchar string arrays use one backing byte arena, reducing per-string allocations - packed float vectors use a single memcpy into self-owned memory - cold, complex, unknown, and mismatched fields delegate or merge through the official protobuf codec - no new external dependency or source-buffer aliasing ## Compatibility boundary The compatibility contract depends on the data path: - **Untrusted client ingress (`InsertRequest` and `UpsertRequest`)** validates proto3 strings as UTF-8 and is tested differentially against `proto.Unmarshal`, including malformed input behavior. - **Trusted internal result paths (`SearchResultData`, `RetrieveResults`, and direct `FieldData` decoding)** assume canonical Milvus/segcore protobuf output and intentionally skip UTF-8 validation for performance. Therefore these paths do not claim equivalence for arbitrary adversarial wire containing invalid UTF-8. Within that boundary, the decoder preserves the protobuf behaviors exercised by the differential tests: - proto2 groups fall back to the official codec - known fields with mismatched wire types fall back to the official codec - unknown and future fields are preserved through an official merge pass - repeated singular messages merge from the raw wire, including explicitly encoded proto3 default values - repeated message-valued oneof members merge correctly, while different variants remain last-wins - mixed packed and unpacked scalar encodings preserve wire order - descriptor field-set tripwires force decoder review when the protobuf schema changes The unsafe packed-float copy assumes the currently supported little-endian Milvus targets such as x86-64 and arm64. ## Benchmarks fastpb vs official `proto.Unmarshal`, using 1000-row payloads: | path | payload | speedup | allocations/op | |---|---|---:|---:| | search / query | varchar | about 2x | about 1000-2035 to about 10-17 | | search / query | float vector, dim 768 | about 6x | unchanged | | insert | varchar with UTF-8 validation | about 1.8x | 1019 to about 10 | ## Verification - unit and differential tests cover field descriptors, UTF-8 contracts, wire-type mismatches, proto2 groups, unknown fields, packed/unpacked ordering, oneof behavior, and repeated-message merge semantics - randomized canonical-message equivalence tests cover search, retrieve, insert, and upsert payloads - `go test ./util/fastpb ./util/resource` passes - `go vet ./util/fastpb ./util/resource` passes - current full CI and end-to-end status is tracked by the PR checks 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Signed-off-by: xiaofanluan <xiaofan.luan@zilliz.com> Signed-off-by: xiaofanluan <xf@hjjaq.com> Co-authored-by: Claude Fable 5 <noreply@anthropic.com> Co-authored-by: xiaofanluan <xf@hjjaq.com>
90 lines
3.7 KiB
Go
90 lines
3.7 KiB
Go
package fastpb
|
|
|
|
import (
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
"google.golang.org/protobuf/encoding/protowire"
|
|
"google.golang.org/protobuf/proto"
|
|
|
|
milvuspb "github.com/milvus-io/milvus-proto/go-api/v3/milvuspb"
|
|
schemapb "github.com/milvus-io/milvus-proto/go-api/v3/schemapb"
|
|
"github.com/milvus-io/milvus/pkg/v3/proto/internalpb"
|
|
)
|
|
|
|
// appendGroup appends a proto2 group-encoded field (start-group ... end-group,
|
|
// wire types 3/4) carrying one nested varint. proto3 never produces this; the
|
|
// official codec preserves it as an unknown field.
|
|
func appendGroup(b []byte, fieldNum int32) []byte {
|
|
b = protowire.AppendTag(b, protowire.Number(fieldNum), protowire.StartGroupType)
|
|
b = protowire.AppendTag(b, 1, protowire.VarintType)
|
|
b = protowire.AppendVarint(b, 42)
|
|
b = protowire.AppendTag(b, protowire.Number(fieldNum), protowire.EndGroupType)
|
|
return b
|
|
}
|
|
|
|
// TestProto2GroupFallback: a wire buffer containing a proto2 group (which fastpb
|
|
// does not decode) must fall back to the official codec and yield a byte-for-byte
|
|
// identical message, never an error (issue: fastpb proto2 group handling).
|
|
func TestProto2GroupFallback(t *testing.T) {
|
|
t.Run("InsertRequest/top-level group", func(t *testing.T) {
|
|
canonical, err := proto.Marshal(&milvuspb.InsertRequest{
|
|
CollectionName: "c", DbName: "db", NumRows: 3,
|
|
FieldsData: []*schemapb.FieldData{{FieldId: 1, Type: schemapb.DataType_Int64, FieldName: "id"}},
|
|
})
|
|
require.NoError(t, err)
|
|
wire := appendGroup(append([]byte{}, canonical...), 1000)
|
|
|
|
want := &milvuspb.InsertRequest{}
|
|
require.NoError(t, proto.Unmarshal(wire, want), "official codec must accept the group")
|
|
got := &milvuspb.InsertRequest{}
|
|
require.NoError(t, UnmarshalInsertRequest(wire, got), "fastpb must fall back, not error")
|
|
assert.True(t, proto.Equal(got, want), "fallback result must equal official decode")
|
|
})
|
|
|
|
t.Run("InsertRequest/group nested in fields_data", func(t *testing.T) {
|
|
// Build a FieldData submessage whose bytes carry a nested group, exercising
|
|
// errProto2 propagation up from the nested fieldData decoder to the entry.
|
|
fdBytes, err := proto.Marshal(&schemapb.FieldData{FieldId: 1, Type: schemapb.DataType_Int64, FieldName: "id"})
|
|
require.NoError(t, err)
|
|
fdBytes = appendGroup(fdBytes, 999)
|
|
|
|
var wire []byte
|
|
wire = protowire.AppendTag(wire, 3, protowire.BytesType) // collection_name
|
|
wire = protowire.AppendString(wire, "c")
|
|
wire = protowire.AppendTag(wire, 5, protowire.BytesType) // fields_data (5)
|
|
wire = protowire.AppendBytes(wire, fdBytes)
|
|
|
|
want := &milvuspb.InsertRequest{}
|
|
require.NoError(t, proto.Unmarshal(wire, want))
|
|
got := &milvuspb.InsertRequest{}
|
|
require.NoError(t, UnmarshalInsertRequest(wire, got))
|
|
assert.True(t, proto.Equal(got, want))
|
|
})
|
|
|
|
t.Run("SearchResultData/top-level group", func(t *testing.T) {
|
|
canonical, err := proto.Marshal(&schemapb.SearchResultData{NumQueries: 2, TopK: 5})
|
|
require.NoError(t, err)
|
|
wire := appendGroup(append([]byte{}, canonical...), 1000)
|
|
|
|
want := &schemapb.SearchResultData{}
|
|
require.NoError(t, proto.Unmarshal(wire, want))
|
|
got := &schemapb.SearchResultData{}
|
|
require.NoError(t, UnmarshalSearchResultData(wire, got))
|
|
assert.True(t, proto.Equal(got, want))
|
|
})
|
|
|
|
t.Run("RetrieveResults/top-level group", func(t *testing.T) {
|
|
canonical, err := proto.Marshal(&internalpb.RetrieveResults{ReqID: 7, AllRetrieveCount: 9})
|
|
require.NoError(t, err)
|
|
wire := appendGroup(append([]byte{}, canonical...), 1000)
|
|
|
|
want := &internalpb.RetrieveResults{}
|
|
require.NoError(t, proto.Unmarshal(wire, want))
|
|
got := &internalpb.RetrieveResults{}
|
|
require.NoError(t, UnmarshalRetrieveResults(wire, got))
|
|
assert.True(t, proto.Equal(got, want))
|
|
})
|
|
}
|