src/gromacs/utility/smalloc.c

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   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, by the GROMACS development team, led by
   7  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   8  * and including many others, as listed in the AUTHORS file in the
   9  * top-level source directory and at http://www.gromacs.org.
  10  *
  11  * GROMACS is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public License
  13  * as published by the Free Software Foundation; either version 2.1
  14  * of the License, or (at your option) any later version.
  15  *
  16  * GROMACS is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with GROMACS; if not, see
  23  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  24  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  25  *
  26  * If you want to redistribute modifications to GROMACS, please
  27  * consider that scientific software is very special. Version
  28  * control is crucial - bugs must be traceable. We will be happy to
  29  * consider code for inclusion in the official distribution, but
  30  * derived work must not be called official GROMACS. Details are found
  31  * in the README & COPYING files - if they are missing, get the
  32  * official version at http://www.gromacs.org.
  33  *
  34  * To help us fund GROMACS development, we humbly ask that you cite
  35  * the research papers on the package. Check out http://www.gromacs.org.
  36  */
  37 #include "gmxpre.h"
  38
  39 #include "smalloc.h"
  40
  41 #include "config.h"
  42
  43 #include <errno.h>
  44 #include <stdio.h>
  45 #include <stdlib.h>
  46 #include <string.h>
  47
  48 #ifdef WITH_DMALLOC
  49 #include <dmalloc.h>
  50 #endif
  51 #ifdef HAVE__ALIGNED_MALLOC
  52 #include <malloc.h>
  53 #endif
  54
  55 #include "thread_mpi/threads.h"
  56
  57 #include "gromacs/utility/dir_separator.h"
  58 #include "gromacs/utility/fatalerror.h"
  59 #ifdef PRINT_ALLOC_KB
  60 #include "gromacs/utility/basenetwork.h"
  61 #include "gromacs/utility/gmxmpi.h"
  62 #endif
  63
  64 static gmx_bool            g_bOverAllocDD     = FALSE;
  65 static tMPI_Thread_mutex_t g_over_alloc_mutex = TMPI_THREAD_MUTEX_INITIALIZER;
  66
  67 #ifdef DEBUG
  68 static void log_action(int bMal, const char *what, const char *file, int line,
  69                        int nelem, int size, void *ptr)
  70 {
  71     static int btot = 0;
  72     char      *NN   = "NULL";
  73     int        bytes;
  74
  75     bytes = size*nelem;
  76     if (!bMal)
  77     {
  78         bytes = -bytes;
  79     }
  80
  81     tMPI_Thread_mutex_lock(&gmx_logfile_mtx);
  82
  83     /* This total memory count is not correct, since with realloc
  84      * it adds the whole size again, not just the increment.
  85      */
  86     /* This static variable is protected by the mutex too... */
  87     btot += bytes;
  88
  89     bytes /= 1024;
  90     if (debug && (bytes != 0))
  91     {
  92         fprintf(debug, "%s:%d kB (%7d kB) [%s, line %d, nelem %d, size %d]\n",
  93                 what ? what : NN, bytes, btot/1024,
  94                 file ? file : NN, line, nelem, size);
  95     }
  96     /* Print to stderr for things larger than 1 MB */
  97     if (bytes >= 1024 || bytes <= -1024)
  98     {
  99         char *fname = NULL;
 100         if (file)
 101         {
 102             fname = strrchr(file, DIR_SEPARATOR);
 103             if (fname)
 104             {
 105                 fname++;
 106             }
 107             else
 108             {
 109                 fname = file;
 110             }
 111         }
 112         printf("%s: %.1f MB [%s, line %d, nelem %d, size %d]\n",
 113                what ? what  : NN, bytes/1024.0,
 114                file ? fname : NN, line, nelem, size);
 115     }
 116     tMPI_Thread_mutex_unlock(&gmx_logfile_mtx);
 117 }
 118 #endif
 119
 120 void *save_malloc(const char *name, const char *file, int line, size_t size)
 121 {
 122     void *p;
 123
 124     p = NULL;
 125     if (size == 0)
 126     {
 127         p = NULL;
 128     }
 129     else
 130     {
 131         if ((p = malloc(size)) == NULL)
 132         {
 133             gmx_fatal(errno, __FILE__, __LINE__,
 134                       "Not enough memory. Failed to malloc %"GMX_PRId64 " bytes for %s\n"
 135                       "(called from file %s, line %d)",
 136                       (gmx_int64_t)size, name, file, line);
 137         }
 138         (void) memset(p, 0, size);
 139     }
 140 #ifdef DEBUG
 141     log_action(1, name, file, line, 1, size, p);
 142 #endif
 143     return p;
 144 }
 145
 146 void *save_calloc(const char *name, const char *file, int line,
 147                   size_t nelem, size_t elsize)
 148 {
 149     void *p;
 150
 151     p = NULL;
 152     if ((nelem == 0) || (elsize == 0))
 153     {
 154         p = NULL;
 155     }
 156     else
 157     {
 158 #ifdef PRINT_ALLOC_KB
 159         if (nelem*elsize >= PRINT_ALLOC_KB*1024)
 160         {
 161             int rank = gmx_node_rank();
 162             printf("Allocating %.1f MB for %s (called from file %s, line %d on %d)\n",
 163                    nelem*elsize/1048576.0, name, file, line, rank);
 164         }
 165 #endif
 166 #ifdef GMX_BROKEN_CALLOC
 167         /* emulate calloc(3) with malloc/memset on machines with
 168            a broken calloc, e.g. in -lgmalloc on cray xt3. */
 169         if ((p = malloc((size_t)nelem*(size_t)elsize)) == NULL)
 170         {
 171             gmx_fatal(errno, __FILE__, __LINE__,
 172                       "Not enough memory. Failed to calloc %"GMX_PRId64
 173                       " elements of size %"GMX_PRId64
 174                       " for %s\n(called from file %s, line %d)",
 175                       (gmx_int64_t)nelem, (gmx_int64_t)elsize,
 176                       name, file, line);
 177         }
 178         memset(p, 0, (size_t) (nelem * elsize));
 179 #else
 180         if ((p = calloc((size_t)nelem, (size_t)elsize)) == NULL)
 181         {
 182             gmx_fatal(errno, __FILE__, __LINE__,
 183                       "Not enough memory. Failed to calloc %"GMX_PRId64
 184                       " elements of size %"GMX_PRId64
 185                       " for %s\n(called from file %s, line %d)",
 186                       (gmx_int64_t)nelem, (gmx_int64_t)elsize, name, file, line);
 187         }
 188 #endif
 189     }
 190 #ifdef DEBUG
 191     log_action(1, name, file, line, nelem, elsize, p);
 192 #endif
 193     return p;
 194 }
 195
 196 void *save_realloc(const char *name, const char *file, int line, void *ptr,
 197                    size_t nelem, size_t elsize)
 198 {
 199     void  *p;
 200     size_t size = nelem*elsize;
 201
 202     p = NULL;
 203     if (size == 0)
 204     {
 205         save_free(name, file, line, ptr);
 206     }
 207     else
 208     {
 209 #ifdef PRINT_ALLOC_KB
 210         if (size >= PRINT_ALLOC_KB*1024)
 211         {
 212             int rank = gmx_node_rank();
 213             printf("Reallocating %.1f MB for %s (called from file %s, line %d on %d)\n",
 214                    size/1048576.0, name, file, line, rank);
 215         }
 216 #endif
 217         if (ptr == NULL)
 218         {
 219             p = malloc((size_t)size);
 220         }
 221         else
 222         {
 223             p = realloc(ptr, (size_t)size);
 224         }
 225         if (p == NULL)
 226         {
 227             gmx_fatal(errno, __FILE__, __LINE__,
 228                       "Not enough memory. Failed to realloc %"GMX_PRId64 " bytes for %s, %s=%x\n"
 229                       "(called from file %s, line %d)",
 230                       (gmx_int64_t)size, name, name, ptr, file, line);
 231         }
 232 #ifdef DEBUG
 233         log_action(1, name, file, line, 1, size, p);
 234 #endif
 235     }
 236     return p;
 237 }
 238
 239 void save_free(const char gmx_unused *name, const char gmx_unused *file, int gmx_unused line, void *ptr)
 240 {
 241 #ifdef DEBUG
 242     log_action(0, name, file, line, 0, 0, ptr);
 243 #endif
 244     if (ptr != NULL)
 245     {
 246         free(ptr);
 247     }
 248 }
 249
 250 /* If we don't have useful routines for allocating aligned memory,
 251  * then we have to use the old-style GROMACS approach bitwise-ANDing
 252  * pointers to ensure alignment. We store the pointer to the originally
 253  * allocated region in the space before the returned pointer */
 254
 255 /* we create a positive define for the absence of an system-provided memalign */
 256 #if (!defined HAVE_POSIX_MEMALIGN && !defined HAVE_MEMALIGN && \
 257      !defined HAVE__ALIGNED_MALLOC)
 258 #define GMX_OWN_MEMALIGN
 259 #endif
 260
 261
 262 /* Pointers allocated with this routine should only be freed
 263  * with save_free_aligned, however this will only matter
 264  * on systems that lack posix_memalign() and memalign() when
 265  * freeing memory that needed to be adjusted to achieve
 266  * the necessary alignment. */
 267 void *save_malloc_aligned(const char *name, const char *file, int line,
 268                           size_t nelem, size_t elsize, size_t alignment)
 269 {
 270     void   **aligned  = NULL;
 271     void    *malloced = NULL;
 272     gmx_bool allocate_fail;
 273
 274     if (alignment == 0)
 275     {
 276         gmx_fatal(errno, __FILE__, __LINE__,
 277                   "Cannot allocate aligned memory with alignment of zero!\n(called from file %s, line %d)", file, line);
 278     }
 279
 280
 281     if (nelem == 0 || elsize == 0)
 282     {
 283         aligned  = NULL;
 284     }
 285     else
 286     {
 287 #ifdef PRINT_ALLOC_KB
 288         if (nelem*elsize >= PRINT_ALLOC_KB*1024)
 289         {
 290             int rank = gmx_node_rank();
 291             printf("Allocating %.1f MB for %s (called from file %s, line %d on %d)\n",
 292                    nelem*elsize/1048576.0, name, file, line, rank);
 293         }
 294 #endif
 295
 296 #ifdef HAVE_POSIX_MEMALIGN
 297         allocate_fail = (0 != posix_memalign(&malloced, alignment, nelem*elsize));
 298 #elif defined HAVE_MEMALIGN
 299         allocate_fail = ((malloced = memalign(alignment, nelem*elsize)) == NULL);
 300 #elif defined HAVE__ALIGNED_MALLOC
 301         allocate_fail = ((malloced = _aligned_malloc(nelem*elsize, alignment))
 302                          == NULL);
 303 #else
 304         allocate_fail = ((malloced = malloc(nelem*elsize+alignment+
 305                                             sizeof(void*))) == NULL);
 306 #endif
 307         if (allocate_fail)
 308         {
 309             gmx_fatal(errno, __FILE__, __LINE__,
 310                       "Not enough memory. Failed to allocate %u aligned elements of size %u for %s\n(called from file %s, line %d)", nelem, elsize, name, file, line);
 311         }
 312         /* we start with the original pointer */
 313         aligned = (void**)malloced;
 314
 315 #ifdef GMX_OWN_MEMALIGN
 316         /* Make the aligned pointer, and save the underlying pointer that
 317          * we're allowed to free(). */
 318
 319         /* we first make space to store that underlying pointer: */
 320         aligned = aligned + 1;
 321         /* then we apply a bit mask */
 322         aligned = (void *) (((size_t) aligned + alignment - 1) &
 323                             (~((size_t) (alignment-1))));
 324         /* and we store the original pointer in the area just before the
 325            pointer we're going to return */
 326         aligned[-1] = malloced;
 327 #endif
 328     }
 329     return (void*)aligned;
 330 }
 331
 332 void *save_calloc_aligned(const char *name, const char *file, int line,
 333                           size_t nelem, size_t elsize, size_t alignment)
 334 {
 335     void *aligned = save_malloc_aligned(name, file, line, nelem, elsize, alignment);
 336     if (aligned != NULL)
 337     {
 338         memset(aligned, 0, (size_t)(nelem * elsize));
 339     }
 340     return aligned;
 341 }
 342
 343 /* This routine can NOT be called with any pointer */
 344 void save_free_aligned(const char gmx_unused *name, const char gmx_unused *file, int gmx_unused line, void *ptr)
 345 {
 346     int   i, j;
 347     void *free = ptr;
 348
 349     if (NULL != ptr)
 350     {
 351 #ifdef GMX_OWN_MEMALIGN
 352         /* we get the pointer from just before the memaligned pointer */
 353         free = ((void**)ptr)[-1];
 354 #endif
 355
 356 #ifndef HAVE__ALIGNED_MALLOC
 357         /* (Now) we're allowed to use a normal free() on this pointer. */
 358         save_free(name, file, line, free);
 359 #else
 360         _aligned_free(free);
 361 #endif
 362     }
 363 }
 364
 365 void set_over_alloc_dd(gmx_bool set)
 366 {
 367     tMPI_Thread_mutex_lock(&g_over_alloc_mutex);
 368     /* we just make sure that we don't set this at the same time.
 369        We don't worry too much about reading this rarely-set variable */
 370     g_bOverAllocDD = set;
 371     tMPI_Thread_mutex_unlock(&g_over_alloc_mutex);
 372 }
 373
 374 int over_alloc_dd(int n)
 375 {
 376     if (g_bOverAllocDD)
 377     {
 378         return OVER_ALLOC_FAC*n + 100;
 379     }
 380     else
 381     {
 382         return n;
 383     }
 384 }