2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
5 * Copyright (c) 2001-2004, The GROMACS development team.
6 * Copyright (c) 2013,2014,2015,2016,2017 by the GROMACS development team.
7 * Copyright (c) 2018,2019,2020,2021, by the GROMACS development team, led by
8 * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
9 * and including many others, as listed in the AUTHORS file in the
10 * top-level source directory and at http://www.gromacs.org.
12 * GROMACS is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU Lesser General Public License
14 * as published by the Free Software Foundation; either version 2.1
15 * of the License, or (at your option) any later version.
17 * GROMACS is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * Lesser General Public License for more details.
22 * You should have received a copy of the GNU Lesser General Public
23 * License along with GROMACS; if not, see
24 * http://www.gnu.org/licenses, or write to the Free Software Foundation,
25 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
27 * If you want to redistribute modifications to GROMACS, please
28 * consider that scientific software is very special. Version
29 * control is crucial - bugs must be traceable. We will be happy to
30 * consider code for inclusion in the official distribution, but
31 * derived work must not be called official GROMACS. Details are found
32 * in the README & COPYING files - if they are missing, get the
33 * official version at http://www.gromacs.org.
35 * To help us fund GROMACS development, we humbly ask that you cite
36 * the research papers on the package. Check out http://www.gromacs.org.
56 #include "gromacs/utility/alignedallocator.h"
57 #include "gromacs/utility/dir_separator.h"
58 #include "gromacs/utility/fatalerror.h"
60 # include "gromacs/utility/basenetwork.h"
61 # include "gromacs/utility/gmxmpi.h"
64 static bool g_bOverAllocDD = false;
65 static std::mutex g_overAllocMutex;
67 void* save_malloc(const char* name, const char* file, int line, size_t size)
78 if ((p = malloc(size)) == nullptr)
83 "Not enough memory. Failed to malloc %" PRId64
85 "(called from file %s, line %d)",
86 static_cast<int64_t>(size),
91 (void)memset(p, 0, size);
96 void* save_calloc(const char* name, const char* file, int line, size_t nelem, size_t elsize)
101 if ((nelem == 0) || (elsize == 0))
107 #ifdef PRINT_ALLOC_KB
108 if (nelem * elsize >= PRINT_ALLOC_KB * 1024)
110 int rank = gmx_node_rank();
111 printf("Allocating %.1f MB for %s (called from file %s, line %d on %d)\n",
112 nelem * elsize / 1048576.0,
119 #if GMX_BROKEN_CALLOC
120 /* emulate calloc(3) with malloc/memset on machines with
121 a broken calloc, e.g. in -lgmalloc on cray xt3. */
122 if ((p = malloc((size_t)nelem * (size_t)elsize)) == NULL)
127 "Not enough memory. Failed to calloc %" PRId64 " elements of size %" PRId64
128 " for %s\n(called from file %s, line %d)",
135 memset(p, 0, (size_t)(nelem * elsize));
137 if ((p = calloc(nelem, elsize)) == nullptr)
142 "Not enough memory. Failed to calloc %" PRId64 " elements of size %" PRId64
143 " for %s\n(called from file %s, line %d)",
144 static_cast<int64_t>(nelem),
145 static_cast<int64_t>(elsize),
155 void* save_realloc(const char* name, const char* file, int line, void* ptr, size_t nelem, size_t elsize)
158 size_t size = nelem * elsize;
163 save_free(name, file, line, ptr);
167 #ifdef PRINT_ALLOC_KB
168 if (size >= PRINT_ALLOC_KB * 1024)
170 int rank = gmx_node_rank();
171 printf("Reallocating %.1f MB for %s (called from file %s, line %d on %d)\n",
185 p = realloc(ptr, size);
192 "Not enough memory. Failed to realloc %zu bytes for %s, %s=%p\n"
193 "(called from file %s, line %d)",
205 void save_free(const char gmx_unused* name, const char gmx_unused* file, int gmx_unused line, void* ptr)
213 /* Pointers allocated with this routine should only be freed
214 * with save_free_aligned, however this will only matter
215 * on systems that lack posix_memalign() and memalign() when
216 * freeing memory that needed to be adjusted to achieve
217 * the necessary alignment. */
218 void* save_malloc_aligned(const char* name, const char* file, int line, size_t nelem, size_t elsize, size_t alignment)
227 "Cannot allocate aligned memory with alignment of zero!\n(called from file %s, "
233 size_t alignmentSize = gmx::AlignedAllocationPolicy::alignment();
234 if (alignment > alignmentSize)
239 "Cannot allocate aligned memory with alignment > %zu bytes\n(called from file "
247 if (nelem == 0 || elsize == 0)
253 #ifdef PRINT_ALLOC_KB
254 if (nelem * elsize >= PRINT_ALLOC_KB * 1024)
256 int rank = gmx_node_rank();
257 printf("Allocating %.1f MB for %s (called from file %s, line %d on %d)\n",
258 nelem * elsize / 1048576.0,
266 p = gmx::AlignedAllocationPolicy::malloc(nelem * elsize);
273 "Not enough memory. Failed to allocate %zu aligned elements of size %zu for "
274 "%s\n(called from file %s, line %d)",
285 void* save_calloc_aligned(const char* name, const char* file, int line, size_t nelem, size_t elsize, size_t alignment)
287 void* aligned = save_malloc_aligned(name, file, line, nelem, elsize, alignment);
288 if (aligned != nullptr)
290 memset(aligned, 0, static_cast<size_t>(nelem * elsize));
295 /* This routine can NOT be called with any pointer */
296 void save_free_aligned(const char gmx_unused* name, const char gmx_unused* file, int gmx_unused line, void* ptr)
298 gmx::AlignedAllocationPolicy::free(ptr);
301 void set_over_alloc_dd(bool set)
303 std::lock_guard<std::mutex> lock(g_overAllocMutex);
304 /* we just make sure that we don't set this at the same time.
305 We don't worry too much about reading this rarely-set variable */
306 g_bOverAllocDD = set;
309 int over_alloc_dd(int n)
313 return static_cast<int>(OVER_ALLOC_FAC * n + 100);