xref: /aosp_15_r20/external/pigweed/pw_allocator/code_size.rst (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1.. _module-pw_allocator-size-reports:
2
3==================
4Code size analysis
5==================
6.. pigweed-module-subpage::
7   :name: pw_allocator
8
9This module provides the :ref:`module-pw_allocator-api-allocator` interface, as
10well as several implementations of it. The tables below shows the
11relative code size for the interface and each of these implementations. The
12measurement includes a call to each method.
13
14-------------------
15Allocator interface
16-------------------
17The following shows the code size incurred by the
18:ref:`module-pw_allocator-api-allocator` interface itself. A call to each method
19of the interface is measured using an empty implementation,
20:ref:`module-pw_allocator-api-null_allocator`.
21
22.. include:: allocator_api_size_report
23
24----------------------------------
25Concrete allocator implementations
26----------------------------------
27The following are code sizes for each of the provided allocator implementations
28that directly manage the memory they use to fulfill requests. These are measured
29relative to the empty implementation measured above.
30
31.. include:: concrete_allocators_size_report
32
33-------------------------------------
34Forwarding allocators implementations
35-------------------------------------
36The following are code sizes for each of the provided "forwarding" allocators as
37described by :ref:`module-pw_allocator-design-forwarding`. These are measured
38by having the forwarding allocator wrap a
39:ref:`module-pw_allocator-api-first_fit_allocator`, and are measured relative to
40that implementation.
41
42.. include:: forwarding_allocators_size_report
43