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

Improve speed & memory use for Diagnose() and DiagnoseFirst() #533

Merged
merged 4 commits into from
May 13, 2024

Conversation

benluddy
Copy link
Contributor

@benluddy benluddy commented May 8, 2024

Description

This PR improves efficiency of functions in diagnose.go used by Diagnose() and DiagnoseFirst(), especially related to use of encoding/hex, encoding/base32, and encoding/base64.

The "Encoder" types for the various byte string diagnostic encodings (encoding/hex, encoding/base32,
and encoding/base64) include sizable internal buffers (1KiB at time of writing), and a new encoder
is created to produce the diagnostic encoding of every byte string in the input. This results in a
lot of extra allocations, especially for inputs containing many small byte strings.

                                        │  before.txt  │              after.txt              │
                                        │    sec/op    │   sec/op     vs base                │
Diagnose/byte_string_base16_encoding      315.90n ± 0%   95.03n ± 1%  -69.92% (p=0.000 n=10)
Diagnose/byte_string_base32_encoding      325.55n ± 0%   99.27n ± 1%  -69.51% (p=0.000 n=10)
Diagnose/byte_string_base32hex_encoding    325.4n ± 0%   100.2n ± 1%  -69.21% (p=0.000 n=10)
Diagnose/byte_string_base64url_encoding    336.5n ± 0%   100.7n ± 2%  -70.07% (p=0.000 n=10)
geomean                                    325.8n        98.78n       -69.68%

                                        │  before.txt  │             after.txt              │
                                        │     B/op     │    B/op     vs base                │
Diagnose/byte_string_base16_encoding      1344.00 ± 0%   80.00 ± 0%  -94.05% (p=0.000 n=10)
Diagnose/byte_string_base32_encoding      1344.00 ± 0%   80.00 ± 0%  -94.05% (p=0.000 n=10)
Diagnose/byte_string_base32hex_encoding   1344.00 ± 0%   80.00 ± 0%  -94.05% (p=0.000 n=10)
Diagnose/byte_string_base64url_encoding   1344.00 ± 0%   80.00 ± 0%  -94.05% (p=0.000 n=10)
geomean                                   1.313Ki        80.00       -94.05%

                                        │ before.txt │             after.txt              │
                                        │ allocs/op  │ allocs/op   vs base                │
Diagnose/byte_string_base16_encoding      5.000 ± 0%   2.000 ± 0%  -60.00% (p=0.000 n=10)
Diagnose/byte_string_base32_encoding      5.000 ± 0%   2.000 ± 0%  -60.00% (p=0.000 n=10)
Diagnose/byte_string_base32hex_encoding   5.000 ± 0%   2.000 ± 0%  -60.00% (p=0.000 n=10)
Diagnose/byte_string_base64url_encoding   5.000 ± 0%   2.000 ± 0%  -60.00% (p=0.000 n=10)
geomean                                   5.000        2.000       -60.00%

Producing the \uxxxx escape sequences also made a few more allocations than necessary.

                                          │ before.txt  │              after.txt              │
                                          │   sec/op    │   sec/op     vs base                │
Diagnose/escaped_character_in_text_string   180.3n ± 0%   109.2n ± 2%  -39.41% (p=0.000 n=10)

                                          │ before.txt  │             after.txt              │
                                          │    B/op     │    B/op     vs base                │
Diagnose/escaped_character_in_text_string   192.00 ± 0%   72.00 ± 0%  -62.50% (p=0.000 n=10)

                                          │ before.txt │             after.txt              │
                                          │ allocs/op  │ allocs/op   vs base                │
Diagnose/escaped_character_in_text_string   5.000 ± 0%   2.000 ± 0%  -60.00% (p=0.000 n=10)

PR Was Proposed and Welcomed in Currently Open Issue

  • This PR was proposed and welcomed by maintainer(s) in issue #___
  • Closes or Updates Issue #___

Checklist (for code PR only, ignore for docs PR)

  • Include unit tests that cover the new code
  • Pass all unit tests
  • Pass all lint checks in CI (goimports, gosec, staticcheck, etc.)
  • Sign each commit with your real name and email.
    Last line of each commit message should be in this format:
    Signed-off-by: Firstname Lastname firstname.lastname@example.com
  • Certify the Developer's Certificate of Origin 1.1
    (see next section).

Certify the Developer's Certificate of Origin 1.1

  • By marking this item as completed, I certify
    the Developer Certificate of Origin 1.1.
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
660 York Street, Suite 102,
San Francisco, CA 94110 USA

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@benluddy benluddy changed the title Eliminate some unnecessary alllocations for string diagnostic encodings. Eliminate some unnecessary allocations for string diagnostic encodings. May 8, 2024
Signed-off-by: Ben Luddy <bluddy@redhat.com>
The write methods of *bytes.Buffer are guaranteed to return a nil error, so it is impossible to have
test coverage for the if statements handling non-nil errors.

Signed-off-by: Ben Luddy <bluddy@redhat.com>
                                          │ before.txt  │              after.txt              │
                                          │   sec/op    │   sec/op     vs base                │
Diagnose/escaped_character_in_text_string   180.3n ± 0%   109.2n ± 2%  -39.41% (p=0.000 n=10)

                                          │ before.txt  │             after.txt              │
                                          │    B/op     │    B/op     vs base                │
Diagnose/escaped_character_in_text_string   192.00 ± 0%   72.00 ± 0%  -62.50% (p=0.000 n=10)

                                          │ before.txt │             after.txt              │
                                          │ allocs/op  │ allocs/op   vs base                │
Diagnose/escaped_character_in_text_string   5.000 ± 0%   2.000 ± 0%  -60.00% (p=0.000 n=10)

Signed-off-by: Ben Luddy <bluddy@redhat.com>
The "Encoder" types for the various byte string diagnostic encodings (encoding/hex, encoding/base32,
and encoding/base64) include sizable internal buffers (1KiB at time of writing), and a new encoder
is created to produce the diagnostic encoding of every byte string in the input. This results in a
lot of extra allocations, especially for inputs containing many small byte strings.

                                        │  before.txt  │              after.txt              │
                                        │    sec/op    │   sec/op     vs base                │
Diagnose/byte_string_base16_encoding      315.90n ± 0%   92.34n ± 1%  -70.77% (p=0.000 n=10)
Diagnose/byte_string_base32_encoding      325.55n ± 0%   96.98n ± 0%  -70.21% (p=0.000 n=10)
Diagnose/byte_string_base32hex_encoding   325.45n ± 0%   96.97n ± 0%  -70.21% (p=0.000 n=10)
Diagnose/byte_string_base64url_encoding   336.50n ± 0%   96.50n ± 0%  -71.32% (p=0.000 n=10)
geomean                                    325.8n        95.68n       -70.63%

                                        │  before.txt  │             after.txt              │
                                        │     B/op     │    B/op     vs base                │
Diagnose/byte_string_base16_encoding      1344.00 ± 0%   80.00 ± 0%  -94.05% (p=0.000 n=10)
Diagnose/byte_string_base32_encoding      1344.00 ± 0%   80.00 ± 0%  -94.05% (p=0.000 n=10)
Diagnose/byte_string_base32hex_encoding   1344.00 ± 0%   80.00 ± 0%  -94.05% (p=0.000 n=10)
Diagnose/byte_string_base64url_encoding   1344.00 ± 0%   80.00 ± 0%  -94.05% (p=0.000 n=10)
geomean                                   1.313Ki        80.00       -94.05%

                                        │ before.txt │             after.txt              │
                                        │ allocs/op  │ allocs/op   vs base                │
Diagnose/byte_string_base16_encoding      5.000 ± 0%   2.000 ± 0%  -60.00% (p=0.000 n=10)
Diagnose/byte_string_base32_encoding      5.000 ± 0%   2.000 ± 0%  -60.00% (p=0.000 n=10)
Diagnose/byte_string_base32hex_encoding   5.000 ± 0%   2.000 ± 0%  -60.00% (p=0.000 n=10)
Diagnose/byte_string_base64url_encoding   5.000 ± 0%   2.000 ± 0%  -60.00% (p=0.000 n=10)
geomean                                   5.000        2.000       -60.00%

Signed-off-by: Ben Luddy <bluddy@redhat.com>
@benluddy benluddy marked this pull request as ready for review May 8, 2024 17:10
@fxamacker fxamacker changed the title Eliminate some unnecessary allocations for string diagnostic encodings. Reduce memory and allocs in Diagnose() and DiagnoseFirst() May 11, 2024
@fxamacker fxamacker changed the title Reduce memory and allocs in Diagnose() and DiagnoseFirst() Improve speed & memory use for Diagnose() and DiagnoseFirst() May 13, 2024
Copy link
Owner

@fxamacker fxamacker left a comment

Choose a reason for hiding this comment

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

@benluddy LGTM! Thanks for the optimization and benchmark results is very impressive!

@fxamacker fxamacker merged commit eb04c4e into fxamacker:master May 13, 2024
17 checks passed
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.

2 participants