milvus/internal/storage/payload_writer.go
Buqian Zheng 3c80083f51
feat: [Sparse Float Vector] add sparse vector support to milvus components (#30630)
add sparse float vector support to different milvus components,
including proxy, data node to receive and write sparse float vectors to
binlog, query node to handle search requests, index node to build index
for sparse float column, etc.

https://github.com/milvus-io/milvus/issues/29419

---------

Signed-off-by: Buqian Zheng <zhengbuqian@gmail.com>
2024-03-13 14:32:54 -07:00

607 lines
15 KiB
Go

// Licensed to the LF AI & Data foundation under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package storage
import (
"bytes"
"fmt"
"math"
"sync"
"github.com/apache/arrow/go/v12/arrow"
"github.com/apache/arrow/go/v12/arrow/array"
"github.com/apache/arrow/go/v12/arrow/memory"
"github.com/apache/arrow/go/v12/parquet"
"github.com/apache/arrow/go/v12/parquet/compress"
"github.com/apache/arrow/go/v12/parquet/pqarrow"
"github.com/cockroachdb/errors"
"github.com/golang/protobuf/proto"
"github.com/milvus-io/milvus-proto/go-api/v2/schemapb"
"github.com/milvus-io/milvus/pkg/common"
"github.com/milvus-io/milvus/pkg/util/typeutil"
)
var _ PayloadWriterInterface = (*NativePayloadWriter)(nil)
type NativePayloadWriter struct {
dataType schemapb.DataType
arrowType arrow.DataType
builder array.Builder
finished bool
flushedRows int
output *bytes.Buffer
releaseOnce sync.Once
}
func NewPayloadWriter(colType schemapb.DataType, dim ...int) (PayloadWriterInterface, error) {
var arrowType arrow.DataType
// writer for sparse float vector doesn't require dim
if typeutil.IsVectorType(colType) && !typeutil.IsSparseVectorType(colType) {
if len(dim) != 1 {
return nil, fmt.Errorf("incorrect input numbers")
}
arrowType = milvusDataTypeToArrowType(colType, dim[0])
} else {
arrowType = milvusDataTypeToArrowType(colType, 1)
}
builder := array.NewBuilder(memory.DefaultAllocator, arrowType)
return &NativePayloadWriter{
dataType: colType,
arrowType: arrowType,
builder: builder,
finished: false,
flushedRows: 0,
output: new(bytes.Buffer),
}, nil
}
func (w *NativePayloadWriter) AddDataToPayload(data interface{}, dim ...int) error {
switch len(dim) {
case 0:
switch w.dataType {
case schemapb.DataType_Bool:
val, ok := data.([]bool)
if !ok {
return errors.New("incorrect data type")
}
return w.AddBoolToPayload(val)
case schemapb.DataType_Int8:
val, ok := data.([]int8)
if !ok {
return errors.New("incorrect data type")
}
return w.AddInt8ToPayload(val)
case schemapb.DataType_Int16:
val, ok := data.([]int16)
if !ok {
return errors.New("incorrect data type")
}
return w.AddInt16ToPayload(val)
case schemapb.DataType_Int32:
val, ok := data.([]int32)
if !ok {
return errors.New("incorrect data type")
}
return w.AddInt32ToPayload(val)
case schemapb.DataType_Int64:
val, ok := data.([]int64)
if !ok {
return errors.New("incorrect data type")
}
return w.AddInt64ToPayload(val)
case schemapb.DataType_Float:
val, ok := data.([]float32)
if !ok {
return errors.New("incorrect data type")
}
return w.AddFloatToPayload(val)
case schemapb.DataType_Double:
val, ok := data.([]float64)
if !ok {
return errors.New("incorrect data type")
}
return w.AddDoubleToPayload(val)
case schemapb.DataType_String, schemapb.DataType_VarChar:
val, ok := data.(string)
if !ok {
return errors.New("incorrect data type")
}
return w.AddOneStringToPayload(val)
case schemapb.DataType_Array:
val, ok := data.(*schemapb.ScalarField)
if !ok {
return errors.New("incorrect data type")
}
return w.AddOneArrayToPayload(val)
case schemapb.DataType_JSON:
val, ok := data.([]byte)
if !ok {
return errors.New("incorrect data type")
}
return w.AddOneJSONToPayload(val)
default:
return errors.New("incorrect datatype")
}
case 1:
switch w.dataType {
case schemapb.DataType_BinaryVector:
val, ok := data.([]byte)
if !ok {
return errors.New("incorrect data type")
}
return w.AddBinaryVectorToPayload(val, dim[0])
case schemapb.DataType_FloatVector:
val, ok := data.([]float32)
if !ok {
return errors.New("incorrect data type")
}
return w.AddFloatVectorToPayload(val, dim[0])
case schemapb.DataType_Float16Vector:
val, ok := data.([]byte)
if !ok {
return errors.New("incorrect data type")
}
return w.AddFloat16VectorToPayload(val, dim[0])
case schemapb.DataType_BFloat16Vector:
val, ok := data.([]byte)
if !ok {
return errors.New("incorrect data type")
}
return w.AddBFloat16VectorToPayload(val, dim[0])
case schemapb.DataType_SparseFloatVector:
val, ok := data.(*SparseFloatVectorFieldData)
if !ok {
return errors.New("incorrect data type")
}
return w.AddSparseFloatVectorToPayload(val)
default:
return errors.New("incorrect datatype")
}
default:
return errors.New("incorrect input numbers")
}
}
func (w *NativePayloadWriter) AddBoolToPayload(data []bool) error {
if w.finished {
return errors.New("can't append data to finished writer")
}
if len(data) == 0 {
return errors.New("can't add empty msgs into payload")
}
builder, ok := w.builder.(*array.BooleanBuilder)
if !ok {
return errors.New("failed to cast ArrayBuilder")
}
builder.AppendValues(data, nil)
return nil
}
func (w *NativePayloadWriter) AddByteToPayload(data []byte) error {
if w.finished {
return errors.New("can't append data to finished writer")
}
if len(data) == 0 {
return errors.New("can't add empty msgs into payload")
}
builder, ok := w.builder.(*array.Int8Builder)
if !ok {
return errors.New("failed to cast ArrayBuilder")
}
builder.Reserve(len(data))
for i := range data {
builder.Append(int8(data[i]))
}
return nil
}
func (w *NativePayloadWriter) AddInt8ToPayload(data []int8) error {
if w.finished {
return errors.New("can't append data to finished writer")
}
if len(data) == 0 {
return errors.New("can't add empty msgs into payload")
}
builder, ok := w.builder.(*array.Int8Builder)
if !ok {
return errors.New("failed to cast ArrayBuilder")
}
builder.AppendValues(data, nil)
return nil
}
func (w *NativePayloadWriter) AddInt16ToPayload(data []int16) error {
if w.finished {
return errors.New("can't append data to finished writer")
}
if len(data) == 0 {
return errors.New("can't add empty msgs into payload")
}
builder, ok := w.builder.(*array.Int16Builder)
if !ok {
return errors.New("failed to cast ArrayBuilder")
}
builder.AppendValues(data, nil)
return nil
}
func (w *NativePayloadWriter) AddInt32ToPayload(data []int32) error {
if w.finished {
return errors.New("can't append data to finished writer")
}
if len(data) == 0 {
return errors.New("can't add empty msgs into payload")
}
builder, ok := w.builder.(*array.Int32Builder)
if !ok {
return errors.New("failed to cast ArrayBuilder")
}
builder.AppendValues(data, nil)
return nil
}
func (w *NativePayloadWriter) AddInt64ToPayload(data []int64) error {
if w.finished {
return errors.New("can't append data to finished writer")
}
if len(data) == 0 {
return errors.New("can't add empty msgs into payload")
}
builder, ok := w.builder.(*array.Int64Builder)
if !ok {
return errors.New("failed to cast ArrayBuilder")
}
builder.AppendValues(data, nil)
return nil
}
func (w *NativePayloadWriter) AddFloatToPayload(data []float32) error {
if w.finished {
return errors.New("can't append data to finished writer")
}
if len(data) == 0 {
return errors.New("can't add empty msgs into payload")
}
builder, ok := w.builder.(*array.Float32Builder)
if !ok {
return errors.New("failed to cast ArrayBuilder")
}
builder.AppendValues(data, nil)
return nil
}
func (w *NativePayloadWriter) AddDoubleToPayload(data []float64) error {
if w.finished {
return errors.New("can't append data to finished writer")
}
if len(data) == 0 {
return errors.New("can't add empty msgs into payload")
}
builder, ok := w.builder.(*array.Float64Builder)
if !ok {
return errors.New("failed to cast ArrayBuilder")
}
builder.AppendValues(data, nil)
return nil
}
func (w *NativePayloadWriter) AddOneStringToPayload(data string) error {
if w.finished {
return errors.New("can't append data to finished writer")
}
builder, ok := w.builder.(*array.StringBuilder)
if !ok {
return errors.New("failed to cast ArrayBuilder")
}
builder.Append(data)
return nil
}
func (w *NativePayloadWriter) AddOneArrayToPayload(data *schemapb.ScalarField) error {
if w.finished {
return errors.New("can't append data to finished writer")
}
bytes, err := proto.Marshal(data)
if err != nil {
return errors.New("Marshal ListValue failed")
}
builder, ok := w.builder.(*array.BinaryBuilder)
if !ok {
return errors.New("failed to cast ArrayBuilder")
}
builder.Append(bytes)
return nil
}
func (w *NativePayloadWriter) AddOneJSONToPayload(data []byte) error {
if w.finished {
return errors.New("can't append data to finished writer")
}
builder, ok := w.builder.(*array.BinaryBuilder)
if !ok {
return errors.New("failed to cast ArrayBuilder")
}
builder.Append(data)
return nil
}
func (w *NativePayloadWriter) AddBinaryVectorToPayload(data []byte, dim int) error {
if w.finished {
return errors.New("can't append data to finished writer")
}
if len(data) == 0 {
return errors.New("can't add empty msgs into payload")
}
builder, ok := w.builder.(*array.FixedSizeBinaryBuilder)
if !ok {
return errors.New("failed to cast ArrayBuilder")
}
byteLength := dim / 8
length := len(data) / byteLength
builder.Reserve(length)
for i := 0; i < length; i++ {
builder.Append(data[i*byteLength : (i+1)*byteLength])
}
return nil
}
func (w *NativePayloadWriter) AddFloatVectorToPayload(data []float32, dim int) error {
if w.finished {
return errors.New("can't append data to finished writer")
}
if len(data) == 0 {
return errors.New("can't add empty msgs into payload")
}
builder, ok := w.builder.(*array.FixedSizeBinaryBuilder)
if !ok {
return errors.New("failed to cast ArrayBuilder")
}
byteLength := dim * 4
length := len(data) / dim
builder.Reserve(length)
bytesData := make([]byte, byteLength)
for i := 0; i < length; i++ {
vec := data[i*dim : (i+1)*dim]
for j := range vec {
bytes := math.Float32bits(vec[j])
common.Endian.PutUint32(bytesData[j*4:], bytes)
}
builder.Append(bytesData)
}
return nil
}
func (w *NativePayloadWriter) AddFloat16VectorToPayload(data []byte, dim int) error {
if w.finished {
return errors.New("can't append data to finished writer")
}
if len(data) == 0 {
return errors.New("can't add empty msgs into payload")
}
builder, ok := w.builder.(*array.FixedSizeBinaryBuilder)
if !ok {
return errors.New("failed to cast ArrayBuilder")
}
byteLength := dim * 2
length := len(data) / byteLength
builder.Reserve(length)
for i := 0; i < length; i++ {
builder.Append(data[i*byteLength : (i+1)*byteLength])
}
return nil
}
func (w *NativePayloadWriter) AddBFloat16VectorToPayload(data []byte, dim int) error {
if w.finished {
return errors.New("can't append data to finished writer")
}
if len(data) == 0 {
return errors.New("can't add empty msgs into payload")
}
builder, ok := w.builder.(*array.FixedSizeBinaryBuilder)
if !ok {
return errors.New("failed to cast ArrayBuilder")
}
byteLength := dim * 2
length := len(data) / byteLength
builder.Reserve(length)
for i := 0; i < length; i++ {
builder.Append(data[i*byteLength : (i+1)*byteLength])
}
return nil
}
func (w *NativePayloadWriter) AddSparseFloatVectorToPayload(data *SparseFloatVectorFieldData) error {
if w.finished {
return errors.New("can't append data to finished writer")
}
builder, ok := w.builder.(*array.BinaryBuilder)
if !ok {
return errors.New("failed to cast BinaryBuilder")
}
length := len(data.SparseFloatArray.Contents)
builder.Reserve(length)
for i := 0; i < length; i++ {
builder.Append(data.SparseFloatArray.Contents[i])
}
return nil
}
func (w *NativePayloadWriter) FinishPayloadWriter() error {
if w.finished {
return errors.New("can't reuse a finished writer")
}
w.finished = true
field := arrow.Field{
Name: "val",
Type: w.arrowType,
}
schema := arrow.NewSchema([]arrow.Field{
field,
}, nil)
w.flushedRows += w.builder.Len()
data := w.builder.NewArray()
defer data.Release()
column := arrow.NewColumnFromArr(field, data)
defer column.Release()
table := array.NewTable(schema, []arrow.Column{column}, int64(column.Len()))
defer table.Release()
props := parquet.NewWriterProperties(
parquet.WithCompression(compress.Codecs.Zstd),
parquet.WithCompressionLevel(3),
)
return pqarrow.WriteTable(table,
w.output,
1024*1024*1024,
props,
pqarrow.DefaultWriterProps(),
)
}
func (w *NativePayloadWriter) GetPayloadBufferFromWriter() ([]byte, error) {
data := w.output.Bytes()
// The cpp version of payload writer handles the empty buffer as error
if len(data) == 0 {
return nil, errors.New("empty buffer")
}
return data, nil
}
func (w *NativePayloadWriter) GetPayloadLengthFromWriter() (int, error) {
return w.flushedRows + w.builder.Len(), nil
}
func (w *NativePayloadWriter) ReleasePayloadWriter() {
w.releaseOnce.Do(func() {
w.builder.Release()
})
}
func (w *NativePayloadWriter) Close() {
w.ReleasePayloadWriter()
}
func milvusDataTypeToArrowType(dataType schemapb.DataType, dim int) arrow.DataType {
switch dataType {
case schemapb.DataType_Bool:
return &arrow.BooleanType{}
case schemapb.DataType_Int8:
return &arrow.Int8Type{}
case schemapb.DataType_Int16:
return &arrow.Int16Type{}
case schemapb.DataType_Int32:
return &arrow.Int32Type{}
case schemapb.DataType_Int64:
return &arrow.Int64Type{}
case schemapb.DataType_Float:
return &arrow.Float32Type{}
case schemapb.DataType_Double:
return &arrow.Float64Type{}
case schemapb.DataType_VarChar, schemapb.DataType_String:
return &arrow.StringType{}
case schemapb.DataType_Array:
return &arrow.BinaryType{}
case schemapb.DataType_JSON:
return &arrow.BinaryType{}
case schemapb.DataType_FloatVector:
return &arrow.FixedSizeBinaryType{
ByteWidth: dim * 4,
}
case schemapb.DataType_BinaryVector:
return &arrow.FixedSizeBinaryType{
ByteWidth: dim / 8,
}
case schemapb.DataType_Float16Vector:
return &arrow.FixedSizeBinaryType{
ByteWidth: dim * 2,
}
case schemapb.DataType_BFloat16Vector:
return &arrow.FixedSizeBinaryType{
ByteWidth: dim * 2,
}
case schemapb.DataType_SparseFloatVector:
return &arrow.BinaryType{}
default:
panic("unsupported data type")
}
}