1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
/* -*- Mode: C; c-basic-offset:4 ; indent-tabs-mode:nil -*- */
/*
* Copyright (c) 2004-2007 The Trustees of Indiana University and Indiana
* University Research and Technology
* Corporation. All rights reserved.
* Copyright (c) 2004-2008 The University of Tennessee and The University
* of Tennessee Research Foundation. All rights
* reserved.
* Copyright (c) 2004-2005 High Performance Computing Center Stuttgart,
* University of Stuttgart. All rights reserved.
* Copyright (c) 2004-2005 The Regents of the University of California.
* All rights reserved.
* Copyright (c) 2018 Triad National Security, LLC. All rights
* reserved.
* Copyright (c) 2022 Cisco Systems, Inc. All rights reserved
* $COPYRIGHT$
*
* Additional copyrights may follow
*
* $HEADER$
*/
/** @file */
#ifndef OPAL_MALLOC_H
#define OPAL_MALLOC_H
#include <stdio.h>
#include <stdlib.h>
/*
* THIS FILE CANNOT INCLUDE ANY OTHER OPAL HEADER FILES!!!
*
* It is included via <opal_config_bottom.h>. Hence, it should not
* include ANY other files, nor should it include "opal_config.h".
*
*/
/*
* Set OPAL_MALLOC_DEBUG_LEVEL to
* 0 for no checking
* 1 for basic error checking
* 2 for more error checking
*/
#ifndef OPAL_MALLOC_DEBUG_LEVEL
# define OPAL_MALLOC_DEBUG_LEVEL 2
#endif
BEGIN_C_DECLS
/**
* Initialize malloc debug output.
*
* This function is invoked to setup a dedicated output stream for
* malloc debug functions. It does \em not (currently) do anything
* other than that (i.e., no internal accounting for tracking
* malloc/free statements, etc.).
*
* It is invoked as part of opal_init(). Although this function is
* not \em necessary for OPAL_MALLOC() and OPAL_FREE(), it is strong
* recommended because no output messages -- regardless of the
* malloc debug level set by opal_malloc_debug() -- will be displayed
* unless this function is invoked first.
*/
void opal_malloc_init(void);
/**
* \internal
*
* Back-end error-checking malloc function for OPAL (you should use
* the normal malloc() instead of this function).
*
* @param size The number of bytes to allocate
* @param file Typically the __FILE__ macro
* @param line Typically the __LINE__ macro
*
* This function is only used when --enable-mem-debug was specified to
* configure (or by default if you're building in a SVN checkout).
*/
OPAL_DECLSPEC void *opal_malloc(size_t size, const char *file, int line)
__opal_attribute_malloc__ __opal_attribute_warn_unused_result__;
/**
* \internal
*
* Back-end error-checking calloc function for OPAL (you should use
* the normal calloc() instead of this function).
*
* @param nmembers Number of elements to malloc
* @param size Size of each elements
* @param file Typically the __FILE__ macro
* @param line Typically the __LINE__ macro
*
* This function is only used when --enable-mem-debug was specified to
* configure (or by default if you're building in a SVN checkout).
*/
OPAL_DECLSPEC void *opal_calloc(size_t nmembers, size_t size, const char *file, int line)
__opal_attribute_malloc__ __opal_attribute_warn_unused_result__;
/**
* \internal
*
* Back-end error-checking realloc function for OPAL (you should use
* the normal realloc() instead of this function).
*
* @param ptr Pointer to reallocate
* @param size The number of bytes to allocate
* @param file Typically the __FILE__ macro
* @param line Typically the __LINE__ macro
*
* This function is only used when --enable-mem-debug was specified to
* configure (or by default if you're building in a SVN checkout).
*/
OPAL_DECLSPEC void *opal_realloc(void *ptr, size_t size, const char *file, int line)
__opal_attribute_malloc__ __opal_attribute_warn_unused_result__;
/**
* \internal
*
* Back-end error-checking free function for OPAL (you should use
* free() instead of this function).
*
* @param addr Address on the heap to free()
* @param file Typically the __FILE__ macro
* @param line Typically the __LINE__ macro
*
* This function is only used when --enable-mem-debug was specified
* to configure (or by default if you're building in a SVN
* checkout).
*/
OPAL_DECLSPEC void opal_free(void *addr, const char *file, int line);
/**
* Used to set the debug level for malloc debug.
*
* @param level The level of debugging (0 = none, 1 = some, 2 = more)
*
* This value defaults to the OPAL_MALLOC_DEBUG_LEVEL.
*/
OPAL_DECLSPEC void opal_malloc_debug(int level);
END_C_DECLS
#endif /* OPAL_MALLOC_H */
|
