1 /* 2 * Copyright (c) 2021, 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 * This file includes definitions for `Heap`. 32 */ 33 34 #ifndef HEAP_HPP_ 35 #define HEAP_HPP_ 36 37 #include "openthread-core-config.h" 38 39 #include <stddef.h> 40 #include <string.h> 41 42 namespace ot { 43 namespace Heap { 44 45 /** 46 * Allocates memory from heap for an array of given number of object of certain size. 47 * 48 * @param[in] aCount Number of objects. 49 * @param[in] aSize Size of each object. 50 * 51 * @returns A pointer to the allocated buffer or `nullptr` if fails to allocate. 52 * 53 */ 54 void *CAlloc(size_t aCount, size_t aSize); 55 56 /** 57 * Frees a previously heap allocated buffer. 58 * 59 * A heap allocated buffer MUST be freed only once. 60 * 61 * @param[in] aPointer A pointer to the previously heap allocated buffer. Can be `nullptr` which does nothing. 62 * 63 */ 64 void Free(void *aPointer); 65 66 } // namespace Heap 67 } // namespace ot 68 69 #endif // HEAP_HPP_ 70