mirror of
https://fuchsia.googlesource.com/third_party/pigweed.googlesource.com/pigweed/pigweed
synced 2024-09-20 13:51:05 +00:00
f9fb90f299
- Update labels so they use consistent naming. Instead of the copy-and-pasted `chapter` prefix, name labels with a prefix consistent with what they point to: - "module-" for module - "target-" for targets - "docs-" for general documentation - Remove the unnecessary highlight and default-domain directives. Neither is necessary since the Pigweed docs always specify the language in code snippets and other directives. Change-Id: I55c34e9ec919f6f4670e5d3d008e0edf5fecf05b Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/19328 Commit-Queue: Wyatt Hepler <hepler@google.com> Reviewed-by: Keir Mierle <keir@google.com>
30 lines
978 B
ReStructuredText
30 lines
978 B
ReStructuredText
.. _module-pw_malloc:
|
|
|
|
---------
|
|
pw_malloc
|
|
---------
|
|
|
|
This module defines an interface for replacing the standard libc dynamic memory
|
|
operations.
|
|
|
|
This facade doesn't implement any heap structure or dynamic memory methods. It
|
|
only requires that backends implements a ``void pw_MallocInit();`` method.
|
|
This function is called before static intialization, and is responsible for
|
|
initializing global data structures required by the malloc implementation.
|
|
|
|
The intent of this module is to provide an interface for user-provided dynamic
|
|
memory operations that is compatible with different implementations.
|
|
|
|
Setup
|
|
=====
|
|
This module requires the following setup:
|
|
|
|
1. Chose a ``pw_malloc`` backend, or write one yourself.
|
|
2. If using GN build, Specify the ``pw_sys_io_BACKEND`` GN build arg to point
|
|
the library that provides a ``pw_malloc`` backend.
|
|
|
|
Module usage
|
|
============
|
|
See backend docs for how to interact with the underlying dynamic memory
|
|
operations implementation.
|