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

Simplify code when pooled buffers aren't returned #532

Merged
merged 1 commit into from
Jun 27, 2023

Conversation

pkwarren
Copy link
Contributor

In some error handling cases, we're retrieving a value from the sync.Pool and explicitly not returning it. Instead, we might simplify things and just allocate a buffer (since we already know the size) and use it and not put extra work on the pool to garbage collect objects that are retrieved but never returned.

In some error handling cases, we're retrieving a value from the
sync.Pool and explicitly not returning it. Instead, we might simplify
things and just allocate a buffer (since we already know the size) and
use it and not put extra work on the pool to garbage collect objects
that are retrieved but never returned.
@@ -171,15 +171,12 @@ func (r *envelopeReader) Unmarshal(message any) *Error {
// stream. Save the message for protocol-specific code to process and
// return a sentinel error. Since we've deferred functions to return env's
// underlying buffer to a pool, we need to keep a copy.
copiedData := make([]byte, data.Len())
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Just a small optimization after re-reading our buffer pool logic.

@pkwarren pkwarren changed the title Simplify code when buffers aren't freed Simplify code when buffers aren't returned Jun 26, 2023
@pkwarren pkwarren changed the title Simplify code when buffers aren't returned Simplify code when pooled buffers aren't returned Jun 26, 2023
Copy link
Contributor

@jchadwick-buf jchadwick-buf left a comment

Choose a reason for hiding this comment

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

Thinking about it, this seems logical enough to me. If the buffer is never returned, then it's effectively just deferring the allocation to later in most cases. Right? So this is not really making the GC/allocation load any worse, it's just changing when the alloc inevitably happens. (Maybe in some cases that is still desired?)

In addition, I think this particular make+copy pattern is optimized by gc and makes it marginally faster than other options for copying data. Though, it could be getting pessimized by the function call to data.Bytes() happening during the copy. Given that this is in a hot path, it might just be worth looking into.

Copy link
Member

@akshayjshah akshayjshah left a comment

Choose a reason for hiding this comment

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

Makes sense to me too!

@pkwarren pkwarren merged commit daa0efc into main Jun 27, 2023
@pkwarren pkwarren deleted the pkw/simplify-copy-allocation branch June 27, 2023 13:01
renovate bot referenced this pull request in open-feature/flagd Jun 27, 2023
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
|
[github.com/bufbuild/connect-go](https://togithub.com/bufbuild/connect-go)
| require | minor | `v1.8.0` -> `v1.9.0` |

---

### Release Notes

<details>
<summary>bufbuild/connect-go (github.com/bufbuild/connect-go)</summary>

###
[`v1.9.0`](https://togithub.com/bufbuild/connect-go/releases/tag/v1.9.0)

[Compare
Source](https://togithub.com/bufbuild/connect-go/compare/v1.8.0...v1.9.0)

#### What's Changed

Along with a few new features and bugfixes, this release includes a
variety of internal performance improvements.

[v1.8.0] BenchmarkConnect/unary-12 8415 1305116 ns/op 14449031 B/op 254
allocs/op
[v1.9.0] BenchmarkConnect/unary-12 10443 1151366 ns/op 6024079 B/op 236
allocs/op

##### Enhancements

- Allow clients to set Host in headers by
[@&#8203;emcfarlane](https://togithub.com/emcfarlane) in
[https://github.com/bufbuild/connect-go/pull/522](https://togithub.com/bufbuild/connect-go/pull/522)
- Allow Connect clients to configure max HTTP GET size by
[@&#8203;jhump](https://togithub.com/jhump) in
[https://github.com/bufbuild/connect-go/pull/529](https://togithub.com/bufbuild/connect-go/pull/529)
- Reduce allocations in HTTP routing by
[@&#8203;mattrobenolt](https://togithub.com/mattrobenolt) in
[https://github.com/bufbuild/connect-go/pull/519](https://togithub.com/bufbuild/connect-go/pull/519)
- Cache mapping of methods to protocol handlers by
[@&#8203;emcfarlane](https://togithub.com/emcfarlane) in
[https://github.com/bufbuild/connect-go/pull/525](https://togithub.com/bufbuild/connect-go/pull/525)
- Improve performance of percent encoding by
[@&#8203;emcfarlane](https://togithub.com/emcfarlane) in
[https://github.com/bufbuild/connect-go/pull/531](https://togithub.com/bufbuild/connect-go/pull/531)
- Reduce marshaling allocations with MarshalAppend by
[@&#8203;emcfarlane](https://togithub.com/emcfarlane) in
[https://github.com/bufbuild/connect-go/pull/503](https://togithub.com/bufbuild/connect-go/pull/503)

##### Bugfixes

- Discard unknown JSON fields by default by
[@&#8203;akshayjshah](https://togithub.com/akshayjshah) in
[https://github.com/bufbuild/connect-go/pull/518](https://togithub.com/bufbuild/connect-go/pull/518)
- Canonicalize Connect streaming trailer names by
[@&#8203;jchadwick-buf](https://togithub.com/jchadwick-buf) in
[https://github.com/bufbuild/connect-go/pull/528](https://togithub.com/bufbuild/connect-go/pull/528)

##### Other changes

- Tighten internal lint checks by
[@&#8203;zchee](https://togithub.com/zchee) in
[https://github.com/bufbuild/connect-go/pull/520](https://togithub.com/bufbuild/connect-go/pull/520)
- Simplify code when pooled buffers aren't returned by
[@&#8203;pkwarren](https://togithub.com/pkwarren) in
[https://github.com/bufbuild/connect-go/pull/532](https://togithub.com/bufbuild/connect-go/pull/532)

#### New Contributors

- [@&#8203;zchee](https://togithub.com/zchee) made their first
contribution in
[https://github.com/bufbuild/connect-go/pull/520](https://togithub.com/bufbuild/connect-go/pull/520)
- [@&#8203;emcfarlane](https://togithub.com/emcfarlane) made their first
contribution in
[https://github.com/bufbuild/connect-go/pull/522](https://togithub.com/bufbuild/connect-go/pull/522)

**Full Changelog**:
bufbuild/connect-go@v1.8.0...v1.9.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/open-feature/flagd).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNS4xNDEuMyIsInVwZGF0ZWRJblZlciI6IjM1LjE0MS4zIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants