Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Utilise byteSlice as a part of struct to avoid allocations #686

Merged
merged 1 commit into from
Mar 25, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions client/conn.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package client

import (
"bytes"
"context"
"crypto/tls"
"fmt"
Expand Down Expand Up @@ -223,30 +224,30 @@ func (c *Conn) ExecuteMultiple(query string, perResultCallback ExecPerResultCall
return nil, errors.Trace(err)
}

var buf []byte
var err error
var result *Result
defer utils.ByteSlicePut(buf)

bs := utils.ByteSliceGet(16)
defer utils.ByteSlicePut(bs)

for {
buf, err = c.ReadPacketReuseMem(utils.ByteSliceGet(16)[:0])
bs.B, err = c.ReadPacketReuseMem(bs.B[:0])
if err != nil {
return nil, errors.Trace(err)
}

switch buf[0] {
switch bs.B[0] {
case OK_HEADER:
result, err = c.handleOKPacket(buf)
result, err = c.handleOKPacket(bs.B)
case ERR_HEADER:
err = c.handleErrorPacket(append([]byte{}, buf...))
err = c.handleErrorPacket(bytes.Repeat(bs.B, 1))
result = nil
case LocalInFile_HEADER:
err = ErrMalformPacket
result = nil
default:
result, err = c.readResultset(buf, false)
result, err = c.readResultset(bs.B, false)
}

// call user-defined callback
perResultCallback(result, err)

Expand Down
6 changes: 3 additions & 3 deletions client/req.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ func (c *Conn) writeCommandBuf(command byte, arg []byte) error {

length := len(arg) + 1
data := utils.ByteSliceGet(length + 4)
data[4] = command
data.B[4] = command

copy(data[5:], arg)
copy(data.B[5:], arg)

err := c.WritePacket(data)
err := c.WritePacket(data.B)

utils.ByteSlicePut(data)

Expand Down
44 changes: 24 additions & 20 deletions client/resp.go
Original file line number Diff line number Diff line change
Expand Up @@ -216,38 +216,42 @@ func (c *Conn) readOK() (*Result, error) {
}

func (c *Conn) readResult(binary bool) (*Result, error) {
firstPkgBuf, err := c.ReadPacketReuseMem(utils.ByteSliceGet(16)[:0])
defer utils.ByteSlicePut(firstPkgBuf)

bs := utils.ByteSliceGet(16)
defer utils.ByteSlicePut(bs)
var err error
bs.B, err = c.ReadPacketReuseMem(bs.B[:0])
if err != nil {
return nil, errors.Trace(err)
}

if firstPkgBuf[0] == OK_HEADER {
return c.handleOKPacket(firstPkgBuf)
} else if firstPkgBuf[0] == ERR_HEADER {
return nil, c.handleErrorPacket(append([]byte{}, firstPkgBuf...))
} else if firstPkgBuf[0] == LocalInFile_HEADER {
switch bs.B[0] {
case OK_HEADER:
return c.handleOKPacket(bs.B)
case ERR_HEADER:
return nil, c.handleErrorPacket(bytes.Repeat(bs.B, 1))
case LocalInFile_HEADER:
return nil, ErrMalformPacket
default:
return c.readResultset(bs.B, binary)
}

return c.readResultset(firstPkgBuf, binary)
}

func (c *Conn) readResultStreaming(binary bool, result *Result, perRowCb SelectPerRowCallback, perResCb SelectPerResultCallback) error {
firstPkgBuf, err := c.ReadPacketReuseMem(utils.ByteSliceGet(16)[:0])
defer utils.ByteSlicePut(firstPkgBuf)

bs := utils.ByteSliceGet(16)
defer utils.ByteSlicePut(bs)
var err error
bs.B, err = c.ReadPacketReuseMem(bs.B[:0])
if err != nil {
return errors.Trace(err)
}

if firstPkgBuf[0] == OK_HEADER {
switch bs.B[0] {
case OK_HEADER:
// https://dev.mysql.com/doc/internals/en/com-query-response.html
// 14.6.4.1 COM_QUERY Response
// If the number of columns in the resultset is 0, this is a OK_Packet.

okResult, err := c.handleOKPacket(firstPkgBuf)
okResult, err := c.handleOKPacket(bs.B)
if err != nil {
return errors.Trace(err)
}
Expand All @@ -262,13 +266,13 @@ func (c *Conn) readResultStreaming(binary bool, result *Result, perRowCb SelectP
result.Reset(0)
}
return nil
} else if firstPkgBuf[0] == ERR_HEADER {
return c.handleErrorPacket(append([]byte{}, firstPkgBuf...))
} else if firstPkgBuf[0] == LocalInFile_HEADER {
case ERR_HEADER:
return c.handleErrorPacket(bytes.Repeat(bs.B, 1))
case LocalInFile_HEADER:
return ErrMalformPacket
default:
return c.readResultsetStreaming(bs.B, binary, result, perRowCb, perResCb)
}

return c.readResultsetStreaming(firstPkgBuf, binary, result, perRowCb, perResCb)
}

func (c *Conn) readResultset(data []byte, binary bool) (*Result, error) {
Expand Down
32 changes: 13 additions & 19 deletions utils/byte_slice_pool.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,35 +2,29 @@ package utils

import "sync"

type ByteSlice struct {
B []byte
}

var (
byteSlicePool = sync.Pool{
New: func() interface{} {
return []byte{}
return new(ByteSlice)
},
}
byteSliceChan = make(chan []byte, 10)
)

func ByteSliceGet(length int) (data []byte) {
select {
case data = <-byteSliceChan:
default:
data = byteSlicePool.Get().([]byte)[:0]
}

if cap(data) < length {
data = make([]byte, length)
func ByteSliceGet(length int) *ByteSlice {
data := byteSlicePool.Get().(*ByteSlice)
if cap(data.B) < length {
data.B = make([]byte, length)
} else {
data = data[:length]
data.B = data.B[:length]
}

return data
}

func ByteSlicePut(data []byte) {
select {
case byteSliceChan <- data:
default:
byteSlicePool.Put(data) //nolint:staticcheck
}
func ByteSlicePut(data *ByteSlice) {
data.B = data.B[:0]
byteSlicePool.Put(data)
}
12 changes: 12 additions & 0 deletions utils/byte_slice_pool_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
package utils

import "testing"

func BenchmarkByteSlicePool(b *testing.B) {
b.ReportAllocs()
for i := 0; i < b.N; i++ {
b := ByteSliceGet(16)
b.B = append(b.B[:0], 0, 1)
ByteSlicePut(b)
}
}
12 changes: 12 additions & 0 deletions utils/bytes_buffer_pool_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
package utils

import "testing"

func BenchmarkBytesBufferPool(b *testing.B) {
b.ReportAllocs()
for i := 0; i < b.N; i++ {
b := BytesBufferGet()
b.WriteString("01")
BytesBufferPut(b)
}
}