fxamacker / cbor

CBOR codec (RFC 8949) with CBOR tags, Go struct tags (toarray, keyasint, omitempty), float64/32/16, big.Int, and fuzz tested billions of execs.
MIT License
748 stars 61 forks source link

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

Closed benluddy closed 6 months ago

benluddy commented 7 months ago

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

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

Certify the Developer's 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.