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.
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)
[x] Include unit tests that cover the new code
[x] Pass all unit tests
[x] Pass all lint checks in CI (goimports, gosec, staticcheck, etc.)
[x] 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
[x] Certify the Developer's Certificate of Origin 1.1
(see next section).
Certify the Developer's Certificate of Origin 1.1
[x] 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.
Description
This PR improves efficiency of functions in
diagnose.go
used byDiagnose()
andDiagnoseFirst()
, especially related to use ofencoding/hex
,encoding/base32
, andencoding/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.
Producing the \uxxxx escape sequences also made a few more allocations than necessary.
PR Was Proposed and Welcomed in Currently Open Issue
Checklist (for code PR only, ignore for docs PR)
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