| xf.li | bdd93d5 | 2023-05-12 07:10:14 -0700 | [diff] [blame] | 1 | /* Copyright (C) 1996-2016 Free Software Foundation, Inc. |
| 2 | This file is part of the GNU C Library. |
| 3 | |
| 4 | The GNU C Library is free software; you can redistribute it and/or |
| 5 | modify it under the terms of the GNU Lesser General Public |
| 6 | License as published by the Free Software Foundation; either |
| 7 | version 2.1 of the License, or (at your option) any later version. |
| 8 | |
| 9 | The GNU C Library is distributed in the hope that it will be useful, |
| 10 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 12 | Lesser General Public License for more details. |
| 13 | |
| 14 | You should have received a copy of the GNU Lesser General Public |
| 15 | License along with the GNU C Library; if not, see |
| 16 | <http://www.gnu.org/licenses/>. */ |
| 17 | |
| 18 | #ifndef _MCHECK_H |
| 19 | #define _MCHECK_H 1 |
| 20 | |
| 21 | #include <features.h> |
| 22 | |
| 23 | __BEGIN_DECLS |
| 24 | |
| 25 | /* Return values for `mprobe': these are the kinds of inconsistencies that |
| 26 | `mcheck' enables detection of. */ |
| 27 | enum mcheck_status |
| 28 | { |
| 29 | MCHECK_DISABLED = -1, /* Consistency checking is not turned on. */ |
| 30 | MCHECK_OK, /* Block is fine. */ |
| 31 | MCHECK_FREE, /* Block freed twice. */ |
| 32 | MCHECK_HEAD, /* Memory before the block was clobbered. */ |
| 33 | MCHECK_TAIL /* Memory after the block was clobbered. */ |
| 34 | }; |
| 35 | |
| 36 | |
| 37 | /* Activate a standard collection of debugging hooks. This must be called |
| 38 | before `malloc' is ever called. ABORTFUNC is called with an error code |
| 39 | (see enum above) when an inconsistency is detected. If ABORTFUNC is |
| 40 | null, the standard function prints on stderr and then calls `abort'. */ |
| 41 | extern int mcheck (void (*__abortfunc)(enum mcheck_status)) __THROW; |
| 42 | |
| 43 | /* Similar to `mcheck' but performs checks for all block whenever one of |
| 44 | the memory handling functions is called. This can be very slow. */ |
| 45 | extern int mcheck_pedantic (void (*__abortfunc)(enum mcheck_status)) __THROW; |
| 46 | |
| 47 | /* Force check of all blocks now. */ |
| 48 | extern void mcheck_check_all (void); |
| 49 | |
| 50 | /* Check for aberrations in a particular malloc'd block. You must have |
| 51 | called `mcheck' already. These are the same checks that `mcheck' does |
| 52 | when you free or reallocate a block. */ |
| 53 | extern enum mcheck_status mprobe (void *__ptr) __THROW; |
| 54 | |
| 55 | /* Activate a standard collection of tracing hooks. */ |
| 56 | extern void mtrace (void) __THROW; |
| 57 | extern void muntrace (void) __THROW; |
| 58 | |
| 59 | __END_DECLS |
| 60 | #endif /* mcheck.h */ |