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

go/vt/sqlparser: improve performance in TrackedBuffer formatting #16364

Merged
merged 2 commits into from
Sep 16, 2024
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
43 changes: 40 additions & 3 deletions go/vt/sqlparser/tracked_buffer.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ package sqlparser

import (
"fmt"
"strconv"
"strings"
)

Expand Down Expand Up @@ -211,7 +212,32 @@ func (buf *TrackedBuffer) astPrintf(currentNode SQLNode, format string, values .
}
}
case 'd':
buf.WriteString(fmt.Sprintf("%d", values[fieldnum]))
switch v := values[fieldnum].(type) {
case int:
buf.WriteInt(int64(v))
case int8:
buf.WriteInt(int64(v))
case int16:
buf.WriteInt(int64(v))
case int32:
buf.WriteInt(int64(v))
case int64:
buf.WriteInt(v)
case uint:
buf.WriteUint(uint64(v))
case uint8:
buf.WriteUint(uint64(v))
case uint16:
buf.WriteUint(uint64(v))
case uint32:
buf.WriteUint(uint64(v))
case uint64:
buf.WriteUint(v)
case uintptr:
buf.WriteUint(uint64(v))
default:
panic(fmt.Sprintf("unexepcted TrackedBuffer type %T", v))
}
case 'a':
buf.WriteArg("", values[fieldnum].(string))
default:
Expand Down Expand Up @@ -288,14 +314,26 @@ func areBothISExpr(op Expr, val Expr) bool {
// WriteArg writes a value argument into the buffer along with
// tracking information for future substitutions.
func (buf *TrackedBuffer) WriteArg(prefix, arg string) {
length := len(prefix) + len(arg)
buf.bindLocations = append(buf.bindLocations, BindLocation{
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As a potential follow up:

I got here because WriteArg stood out a bit in a pprof I was looking at for heap allocations, and the other thing that can be done in here with some more work is the bindLocations slice that keeps getting appended to 1 at a time.

So we might want to do a thing where we count up the args first so can we grow the slice, then append to the slice. So adding a method like, GrowArgs(size)

Offset: buf.Len(),
Length: len(prefix) + len(arg),
Length: length,
})
buf.Grow(length)
buf.WriteString(prefix)
buf.WriteString(arg)
}

// WriteInt writes a signed integer into the buffer.
func (buf *TrackedBuffer) WriteInt(v int64) {
buf.WriteString(strconv.FormatInt(v, 10))
}

// WriteUint writes an unsigned integer into the buffer.
func (buf *TrackedBuffer) WriteUint(v uint64) {
buf.WriteString(strconv.FormatUint(v, 10))
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that this is still allocating memory when the small-number optimization doesn't trigger, so that isn't great. I think it may be time to leave behind the *strings.Builder used here and instead implementing building ourselves, which would allow us to simplify many things, including using strconv.AppendInt instead of the Format versions. Maybe for another PR!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I assume you're thinking something more specialized like what zap does? https://github.com/uber-go/zap/blob/master/buffer/buffer.go

}

// ParsedQuery returns a ParsedQuery that contains bind
// locations for easy substitution.
func (buf *TrackedBuffer) ParsedQuery() *ParsedQuery {
Expand Down Expand Up @@ -335,7 +373,6 @@ func UnescapedString(node SQLNode) string {
buf.SetEscapeNoIdentifier()
node.Format(buf)
return buf.String()

}

// CanonicalString returns a canonical string representation of an SQLNode where all identifiers
Expand Down
32 changes: 32 additions & 0 deletions go/vt/sqlparser/tracked_buffer_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -295,3 +295,35 @@ func TestCanonicalOutput(t *testing.T) {
})
}
}

func TestTrackedBufferMyprintf(t *testing.T) {
testcases := []struct {
input string
output string
args []any
}{
{
input: "nothing",
output: "nothing",
args: []any{},
},
{
input: "my name is %s",
output: "my name is Homer",
args: []any{"Homer"},
},
{
input: "%d %d %d %d %d %d %d %d %d %d %d",
output: "1 2 3 4 5 6 7 8 9 10 11",
args: []any{int(1), int8(2), int16(3), int32(4), int64(5), uint(6), uint8(7), uint16(8), uint32(9), uint64(10), uintptr(11)},
},
}
for _, tc := range testcases {
t.Run(tc.input, func(t *testing.T) {
buf := NewTrackedBuffer(nil)
buf.Myprintf(tc.input, tc.args...)
got := buf.String()
assert.Equal(t, tc.output, got)
})
}
}
Loading