1 /*
2  *  Copyright (c) 2016, The OpenThread Authors.
3  *  All rights reserved.
4  *
5  *  Redistribution and use in source and binary forms, with or without
6  *  modification, are permitted provided that the following conditions are met:
7  *  1. Redistributions of source code must retain the above copyright
8  *     notice, this list of conditions and the following disclaimer.
9  *  2. Redistributions in binary form must reproduce the above copyright
10  *     notice, this list of conditions and the following disclaimer in the
11  *     documentation and/or other materials provided with the distribution.
12  *  3. Neither the name of the copyright holder nor the
13  *     names of its contributors may be used to endorse or promote products
14  *     derived from this software without specific prior written permission.
15  *
16  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20  *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  *  POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 /**
30  * @file
31  * @brief
32  *   This file includes the platform abstraction for dynamic memory allocation.
33  */
34 
35 #ifndef OPENTHREAD_PLATFORM_MEMORY_H_
36 #define OPENTHREAD_PLATFORM_MEMORY_H_
37 
38 #include <stddef.h>
39 
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43 
44 /**
45  * @addtogroup plat-memory
46  *
47  * @brief
48  *   This module includes the platform abstraction for dynamic memory allocation.
49  *
50  * @{
51  */
52 
53 /*
54  * OpenThread only requires dynamic memory allocation when supporting multiple simultaneous instances, for MbedTls.
55  */
56 
57 /**
58  * Dynamically allocates new memory. On platforms that support it, should just redirect to calloc. For
59  * those that don't support calloc, should support the same functionality:
60  *
61  *   "The calloc() function contiguously allocates enough space for count objects that are size bytes of
62  *   memory each and returns a pointer to the allocated memory. The allocated memory is filled with bytes
63  *   of value zero."
64  *
65  * Is required for OPENTHREAD_CONFIG_HEAP_EXTERNAL_ENABLE.
66  *
67  * @param[in] aNum   The number of blocks to allocate
68  * @param[in] aSize  The size of each block to allocate
69  *
70  * @retval void*  The pointer to the front of the memory allocated
71  * @retval NULL   Failed to allocate the memory requested.
72  */
73 void *otPlatCAlloc(size_t aNum, size_t aSize);
74 
75 /**
76  * Frees memory that was dynamically allocated.
77  *
78  * Is required for OPENTHREAD_CONFIG_HEAP_EXTERNAL_ENABLE.
79  *
80  * @param[in] aPtr  A pointer the memory blocks to free. The pointer may be NULL.
81  */
82 void otPlatFree(void *aPtr);
83 
84 /**
85  * @}
86  */
87 
88 #ifdef __cplusplus
89 } // extern "C"
90 #endif
91 
92 #endif // OPENTHREAD_PLATFORM_MEMORY_H_
93