1 /** 2 * @file 3 * lwIP internal memory implementations (do not use in application code) 4 */ 5 6 /* 7 * Copyright (c) 2018 Swedish Institute of Computer Science. 8 * All rights reserved. 9 * 10 * Redistribution and use in source and binary forms, with or without modification, 11 * are permitted provided that the following conditions are met: 12 * 13 * 1. Redistributions of source code must retain the above copyright notice, 14 * this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright notice, 16 * this list of conditions and the following disclaimer in the documentation 17 * and/or other materials provided with the distribution. 18 * 3. The name of the author may not be used to endorse or promote products 19 * derived from this software without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 22 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 23 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 24 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 25 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 26 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 29 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 30 * OF SUCH DAMAGE. 31 * 32 * This file is part of the lwIP TCP/IP stack. 33 * 34 * Author: Simon Goldschmidt <goldsimon@gmx.de> 35 * 36 */ 37 38 #ifndef LWIP_HDR_MEM_PRIV_H 39 #define LWIP_HDR_MEM_PRIV_H 40 41 #include "lwip/opt.h" 42 43 #ifdef __cplusplus 44 extern "C" { 45 #endif 46 47 #include "lwip/mem.h" 48 49 #if MEM_OVERFLOW_CHECK || MEMP_OVERFLOW_CHECK 50 /* if MEM_OVERFLOW_CHECK or MEMP_OVERFLOW_CHECK is turned on, we reserve some 51 * bytes at the beginning and at the end of each element, initialize them as 52 * 0xcd and check them later. 53 * If MEM(P)_OVERFLOW_CHECK is >= 2, on every call to mem(p)_malloc or mem(p)_free, 54 * every single element in each pool/heap is checked! 55 * This is VERY SLOW but also very helpful. 56 * MEM_SANITY_REGION_BEFORE and MEM_SANITY_REGION_AFTER can be overridden in 57 * lwipopts.h to change the amount reserved for checking. */ 58 #ifndef MEM_SANITY_REGION_BEFORE 59 #define MEM_SANITY_REGION_BEFORE 16 60 #endif /* MEM_SANITY_REGION_BEFORE*/ 61 #if MEM_SANITY_REGION_BEFORE > 0 62 #define MEM_SANITY_REGION_BEFORE_ALIGNED LWIP_MEM_ALIGN_SIZE(MEM_SANITY_REGION_BEFORE) 63 #else 64 #define MEM_SANITY_REGION_BEFORE_ALIGNED 0 65 #endif /* MEM_SANITY_REGION_BEFORE*/ 66 #ifndef MEM_SANITY_REGION_AFTER 67 #define MEM_SANITY_REGION_AFTER 16 68 #endif /* MEM_SANITY_REGION_AFTER*/ 69 #if MEM_SANITY_REGION_AFTER > 0 70 #define MEM_SANITY_REGION_AFTER_ALIGNED LWIP_MEM_ALIGN_SIZE(MEM_SANITY_REGION_AFTER) 71 #else 72 #define MEM_SANITY_REGION_AFTER_ALIGNED 0 73 #endif /* MEM_SANITY_REGION_AFTER*/ 74 75 void mem_overflow_init_raw(void *p, size_t size); 76 void mem_overflow_check_raw(void *p, size_t size, const char *descr1, const char *descr2); 77 78 #endif /* MEM_OVERFLOW_CHECK || MEMP_OVERFLOW_CHECK */ 79 80 #ifdef __cplusplus 81 } 82 #endif 83 84 #endif /* LWIP_HDR_MEMP_PRIV_H */ 85