zephyr/samples/basic/sys_heap
Krzysztof Sychla a51d3c0f74 kernel: heap: Add allocation metadata to allocated_bytes
The allocated_bytes were missing the allocation metadata. Because of that
the sum of free_bytes and allocated_bytes doesn't remain constant after
each allocation. This convention doesn't match glibc's behavior. This
commit changes the chunksz_to_bytes function to include the metadata in the
calculation. The analysis of the mallinfo2 function from glibc has been
done in #92392 Pull Request.

Signed-off-by: Krzysztof Sychla <ksychla@antmicro.com>
2025-07-07 10:08:58 -05:00
..
src
CMakeLists.txt
prj.conf
README.rst
sample.yaml kernel: heap: Add allocation metadata to allocated_bytes 2025-07-07 10:08:58 -05:00

.. zephyr:code-sample:: sys-heap
   :name: System heap

   Print system heap usage to the console.

Overview
********

A simple sample that can be used with any :ref:`supported board <boards>` and
prints system heap usage to the console.

Building
********

This application can be built on :ref:`native_sim <native_sim>` as follows:

.. zephyr-app-commands::
   :zephyr-app: samples/basic/sys_heap
   :host-os: unix
   :board: native_sim
   :goals: build
   :compact:

To build for another board, change "native_sim" above to that board's name.

Running
*******

Run build/zephyr/zephyr.exe

Sample Output
*************

.. code-block:: console

   System heap sample

   allocated 0, free 196, max allocated 0, heap size 256
   allocated 156, free 36, max allocated 156, heap size 256
   allocated 100, free 92, max allocated 156, heap size 256
   allocated 0, free 196, max allocated 156, heap size 256
   1 static heap(s) allocated:
         0 - address 0x80552a8 allocated 12, free 180, max allocated 12, heap size 256
   2 heap(s) allocated (including static):
         0 - address 0x80552a8 allocated 12, free 180, max allocated 12, heap size 256
         1 - address 0x805530c allocated 0, free 196, max allocated 156, heap size 256