// _ _ // __ _____ __ ___ ___ __ _| |_ ___ // \ \ /\ / / _ \/ _` \ \ / / |/ _` | __/ _ \ // \ V V / __/ (_| |\ V /| | (_| | || __/ // \_/\_/ \___|\__,_| \_/ |_|\__,_|\__\___| // // Copyright © 2016 - 2025 Weaviate B.V. All rights reserved. // // CONTACT: hello@weaviate.io // // Package byteops provides helper functions to (un-) marshal objects from or into a buffer package byteops import ( "encoding/binary" "errors" "io" "math" ) const ( Uint64Len = 8 Uint32Len = 4 Uint16Len = 2 Uint8Len = 1 ) type ReadWriter struct { Position uint64 Buffer []byte } func WithPosition(pos uint64) func(*ReadWriter) { return func(rw *ReadWriter) { rw.Position = pos } } func NewReadWriter(buf []byte) ReadWriter { rw := ReadWriter{Buffer: buf} return rw } // NewReadWriterWithOps escapes to heap even if no ops are given func NewReadWriterWithOps(buf []byte, opts ...func(writer *ReadWriter)) ReadWriter { rw := ReadWriter{Buffer: buf} for _, opt := range opts { opt(&rw) } return rw } func (bo *ReadWriter) ResetBuffer(buf []byte) { bo.Buffer = buf bo.Position = 0 } func (bo *ReadWriter) ReadUint64() uint64 { bo.Position += Uint64Len return binary.LittleEndian.Uint64(bo.Buffer[bo.Position-Uint64Len : bo.Position]) } func (bo *ReadWriter) ReadUint16() uint16 { bo.Position += Uint16Len return binary.LittleEndian.Uint16(bo.Buffer[bo.Position-Uint16Len : bo.Position]) } func (bo *ReadWriter) ReadUint32() uint32 { bo.Position += Uint32Len return binary.LittleEndian.Uint32(bo.Buffer[bo.Position-Uint32Len : bo.Position]) } func (bo *ReadWriter) ReadUint8() uint8 { bo.Position += Uint8Len return bo.Buffer[bo.Position-Uint8Len] } func (bo *ReadWriter) CopyBytesFromBuffer(length uint64, out []byte) ([]byte, error) { if out == nil { out = make([]byte, length) } bo.Position += length numCopiedBytes := copy(out, bo.Buffer[bo.Position-length:bo.Position]) if numCopiedBytes != int(length) { return nil, errors.New("could not copy data from buffer") } return out, nil } func (bo *ReadWriter) ReadBytesFromBuffer(length uint64) []byte { subslice := bo.Buffer[bo.Position : bo.Position+length] bo.Position += length return subslice } func (bo *ReadWriter) ReadBytesFromBufferWithUint64LengthIndicator() []byte { bo.Position += Uint64Len bufLen := binary.LittleEndian.Uint64(bo.Buffer[bo.Position-Uint64Len : bo.Position]) bo.Position += bufLen subslice := bo.Buffer[bo.Position-bufLen : bo.Position] return subslice } func (bo *ReadWriter) DiscardBytesFromBufferWithUint64LengthIndicator() uint64 { bo.Position += Uint64Len bufLen := binary.LittleEndian.Uint64(bo.Buffer[bo.Position-Uint64Len : bo.Position]) bo.Position += bufLen return bufLen } func (bo *ReadWriter) ReadBytesFromBufferWithUint32LengthIndicator() []byte { bo.Position += Uint32Len bufLen := uint64(binary.LittleEndian.Uint32(bo.Buffer[bo.Position-Uint32Len : bo.Position])) bo.Position += bufLen subslice := bo.Buffer[bo.Position-bufLen : bo.Position] return subslice } func (bo *ReadWriter) DiscardBytesFromBufferWithUint32LengthIndicator() uint32 { bo.Position += Uint32Len bufLen := binary.LittleEndian.Uint32(bo.Buffer[bo.Position-Uint32Len : bo.Position]) bo.Position += uint64(bufLen) return bufLen } func (bo *ReadWriter) WriteUint64(value uint64) { bo.Position += Uint64Len binary.LittleEndian.PutUint64(bo.Buffer[bo.Position-Uint64Len:bo.Position], value) } func (bo *ReadWriter) WriteUint32(value uint32) { bo.Position += Uint32Len binary.LittleEndian.PutUint32(bo.Buffer[bo.Position-Uint32Len:bo.Position], value) } func (bo *ReadWriter) WriteUint16(value uint16) { bo.Position += Uint16Len binary.LittleEndian.PutUint16(bo.Buffer[bo.Position-Uint16Len:bo.Position], value) } func (bo *ReadWriter) CopyBytesToBuffer(copyBytes []byte) error { lenCopyBytes := uint64(len(copyBytes)) bo.Position += lenCopyBytes numCopiedBytes := copy(bo.Buffer[bo.Position-lenCopyBytes:bo.Position], copyBytes) if numCopiedBytes != int(lenCopyBytes) { return errors.New("could not copy data into buffer") } return nil } // for io.Writer interface func (bo *ReadWriter) Write(p []byte) (int, error) { lenCopyBytes := uint64(len(p)) bo.Position += lenCopyBytes if bo.Position > uint64(len(bo.Buffer)) { return 0, io.EOF } numCopiedBytes := copy(bo.Buffer[bo.Position-lenCopyBytes:bo.Position], p) return numCopiedBytes, nil } // Writes a uint64 length indicator about the buffer that's about to follow, // then writes the buffer itself func (bo *ReadWriter) CopyBytesToBufferWithUint64LengthIndicator(copyBytes []byte) error { lenCopyBytes := uint64(len(copyBytes)) bo.Position += Uint64Len binary.LittleEndian.PutUint64(bo.Buffer[bo.Position-Uint64Len:bo.Position], lenCopyBytes) bo.Position += lenCopyBytes numCopiedBytes := copy(bo.Buffer[bo.Position-lenCopyBytes:bo.Position], copyBytes) if numCopiedBytes != int(lenCopyBytes) { return errors.New("could not copy data into buffer") } return nil } // Writes a uint32 length indicator about the buffer that's about to follow, // then writes the buffer itself func (bo *ReadWriter) CopyBytesToBufferWithUint32LengthIndicator(copyBytes []byte) error { lenCopyBytes := uint32(len(copyBytes)) bo.Position += Uint32Len binary.LittleEndian.PutUint32(bo.Buffer[bo.Position-Uint32Len:bo.Position], lenCopyBytes) bo.Position += uint64(lenCopyBytes) numCopiedBytes := copy(bo.Buffer[bo.Position-uint64(lenCopyBytes):bo.Position], copyBytes) if numCopiedBytes != int(lenCopyBytes) { return errors.New("could not copy data into buffer") } return nil } func (bo *ReadWriter) MoveBufferPositionForward(length uint64) { bo.Position += length } func (bo *ReadWriter) MoveBufferToAbsolutePosition(pos uint64) { bo.Position = pos } func (bo *ReadWriter) WriteByte(b byte) { bo.Buffer[bo.Position] = b bo.Position += 1 } func Fp32SliceToBytes(slice []float32) []byte { if len(slice) == 0 { return []byte{} } vector := make([]byte, len(slice)*Uint32Len) for i := 0; i < len(slice); i++ { binary.LittleEndian.PutUint32(vector[i*Uint32Len:(i+1)*Uint32Len], math.Float32bits(slice[i])) } return vector } // Fp32SliceOfSlicesToBytes converts a slice of slices of float64 to a byte slice // // Within the byte slice, it encodes the first two bytes as the number of dimensions with uint16 type // The rest of the bytes are the float32 values. // // If the outer slice is empty, it returns an empty byte slice. // If the first slice is empty, it returns an empty byte slice. func Fp32SliceOfSlicesToBytes(slices [][]float32) []byte { if len(slices) == 0 { return []byte{} } if len(slices[0]) == 0 { return []byte{} } dimensions := len(slices[0]) // make a byte slice with size 2 and capacity 2 + (number of slices * number of floats * 4) bytes := make([]byte, Uint16Len, Uint16Len+len(slices)*dimensions*Uint32Len) // write the number of dimensions to the first 2 bytes binary.LittleEndian.PutUint16(bytes[:Uint16Len], uint16(dimensions)) // append the rest of the bytes by looping over the slices and converting them to bytes for _, slice := range slices { bytes = append(bytes, Fp32SliceToBytes(slice)...) } return bytes } func Fp64SliceToBytes(floats []float64) []byte { vector := make([]byte, len(floats)*Uint64Len) for i := 0; i < len(floats); i++ { binary.LittleEndian.PutUint64(vector[i*Uint64Len:(i+1)*Uint64Len], math.Float64bits(floats[i])) } return vector } func Fp32SliceFromBytes(vector []byte) []float32 { floats := make([]float32, len(vector)/Uint32Len) for i := 0; i < len(floats); i++ { asUint := binary.LittleEndian.Uint32(vector[i*Uint32Len : (i+1)*Uint32Len]) floats[i] = math.Float32frombits(asUint) } return floats } // Fp32SliceOfSlicesToBytes converts a slice of slices of float64 to a byte slice // // Within the byte slice, it determines the dimensions of the inner slices using the first two bytes inferred as uint16 type // The rest of the bytes are the float32 values. // // If the byte slice is empty, it returns an empty slice of slices. // If the dimension is found to be 0 then an error is returned as this is invalid. func Fp32SliceOfSlicesFromBytes(bytes []byte) ([][]float32, error) { if len(bytes) == 0 { return [][]float32{}, nil } // read the first 2 bytes to get the dimension of the internal slices dimension := int(binary.LittleEndian.Uint16(bytes[:Uint16Len])) if dimension == 0 { return nil, errors.New("dimension cannot be 0") } // discard the first 2 bytes bytes = bytes[Uint16Len:] // calculate how many slices there are howMany := len(bytes) / (dimension * Uint32Len) vectors := make([][]float32, howMany) // loop through the bytes pulling out the slices based on the dimension for i := 0; i < howMany; i++ { vectors[i] = Fp32SliceFromBytes(bytes[i*dimension*Uint32Len : (i+1)*dimension*Uint32Len]) } return vectors, nil } func Fp64SliceFromBytes(vector []byte) []float64 { floats := make([]float64, len(vector)/Uint64Len) for i := 0; i < len(floats); i++ { asUint := binary.LittleEndian.Uint64(vector[i*Uint64Len : (i+1)*Uint64Len]) floats[i] = math.Float64frombits(asUint) } return floats } func IntsToByteVector(ints []float64) []byte { vector := make([]byte, len(ints)*Uint64Len) for i, val := range ints { intVal := int64(val) binary.LittleEndian.PutUint64(vector[i*Uint64Len:(i+1)*Uint64Len], uint64(intVal)) } return vector } func IntsFromByteVector(vector []byte) []int64 { ints := make([]int64, len(vector)/Uint64Len) for i := 0; i < len(ints); i++ { asUint := binary.LittleEndian.Uint64(vector[i*Uint64Len : (i+1)*Uint64Len]) ints[i] = int64(asUint) } return ints }