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, 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 "gromacs/utility/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
  52 #include "thread_mpi/threads.h"
  53
  54 #include "gromacs/utility/fatalerror.h"
  55 #ifdef PRINT_ALLOC_KB
  56 #include "gromacs/utility/gmxmpi.h"
  57 #endif
  58
  59 static gmx_bool            g_bOverAllocDD     = FALSE;
  60 static tMPI_Thread_mutex_t g_over_alloc_mutex = TMPI_THREAD_MUTEX_INITIALIZER;
  61
  62 #ifdef DEBUG
  63 static void log_action(int bMal, const char *what, const char *file, int line,
  64                        int nelem, int size, void *ptr)
  65 {
  66     static int btot = 0;
  67     char      *NN   = "NULL";
  68     int        bytes;
  69
  70     bytes = size*nelem;
  71     if (!bMal)
  72     {
  73         bytes = -bytes;
  74     }
  75
  76     tMPI_Thread_mutex_lock(&gmx_logfile_mtx);
  77
  78     /* This total memory count is not correct, since with realloc
  79      * it adds the whole size again, not just the increment.
  80      */
  81     /* This static variable is protected by the mutex too... */
  82     btot += bytes;
  83
  84     bytes /= 1024;
  85     if (debug && (bytes != 0))
  86     {
  87         fprintf(debug, "%s:%d kB (%7d kB) [%s, line %d, nelem %d, size %d]\n",
  88                 what ? what : NN, bytes, btot/1024,
  89                 file ? file : NN, line, nelem, size);
  90     }
  91     /* Print to stderr for things larger than 1 MB */
  92     if (bytes >= 1024 || bytes <= -1024)
  93     {
  94         char *fname = NULL;
  95         if (file)
  96         {
  97             fname = strrchr(file, DIR_SEPARATOR);
  98             if (fname)
  99             {
 100                 fname++;
 101             }
 102             else
 103             {
 104                 fname = file;
 105             }
 106         }
 107         printf("%s: %.1f MB [%s, line %d, nelem %d, size %d]\n",
 108                what ? what  : NN, bytes/1024.0,
 109                file ? fname : NN, line, nelem, size);
 110     }
 111     tMPI_Thread_mutex_unlock(&gmx_logfile_mtx);
 112 }
 113 #endif
 114
 115 void *save_malloc(const char *name, const char *file, int line, size_t size)
 116 {
 117     void *p;
 118
 119     p = NULL;
 120     if (size == 0)
 121     {
 122         p = NULL;
 123     }
 124     else
 125     {
 126         if ((p = malloc(size)) == NULL)
 127         {
 128             gmx_fatal(errno, __FILE__, __LINE__,
 129                       "Not enough memory. Failed to malloc %"GMX_PRId64 " bytes for %s\n"
 130                       "(called from file %s, line %d)",
 131                       (gmx_int64_t)size, name, file, line);
 132         }
 133         (void) memset(p, 0, size);
 134     }
 135 #ifdef DEBUG
 136     log_action(1, name, file, line, 1, size, p);
 137 #endif
 138     return p;
 139 }
 140
 141 void *save_calloc(const char *name, const char *file, int line,
 142                   size_t nelem, size_t elsize)
 143 {
 144     void *p;
 145
 146     p = NULL;
 147     if ((nelem == 0) || (elsize == 0))
 148     {
 149         p = NULL;
 150     }
 151     else
 152     {
 153 #ifdef PRINT_ALLOC_KB
 154         int rank = 0;
 155         if (nelem*elsize >= PRINT_ALLOC_KB*1024)
 156         {
 157 #ifdef GMX_MPI
 158             MPI_Comm_rank(MPI_COMM_WORLD, &rank);
 159 #endif
 160             printf("Allocating %.1f MB for %s (called from file %s, line %d on %d)\n",
 161                    nelem*elsize/1048576.0, name, file, line, rank);
 162         }
 163 #endif
 164 #ifdef GMX_BROKEN_CALLOC
 165         /* emulate calloc(3) with malloc/memset on machines with
 166            a broken calloc, e.g. in -lgmalloc on cray xt3. */
 167         if ((p = malloc((size_t)nelem*(size_t)elsize)) == NULL)
 168         {
 169             gmx_fatal(errno, __FILE__, __LINE__,
 170                       "Not enough memory. Failed to calloc %"GMX_PRId64
 171                       " elements of size %"GMX_PRId64
 172                       " for %s\n(called from file %s, line %d)",
 173                       (gmx_int64_t)nelem, (gmx_int64_t)elsize,
 174                       name, file, line);
 175         }
 176         memset(p, 0, (size_t) (nelem * elsize));
 177 #else
 178         if ((p = calloc((size_t)nelem, (size_t)elsize)) == NULL)
 179         {
 180             gmx_fatal(errno, __FILE__, __LINE__,
 181                       "Not enough memory. Failed to calloc %"GMX_PRId64
 182                       " elements of size %"GMX_PRId64
 183                       " for %s\n(called from file %s, line %d)",
 184                       (gmx_int64_t)nelem, (gmx_int64_t)elsize, name, file, line);
 185         }
 186 #endif
 187     }
 188 #ifdef DEBUG
 189     log_action(1, name, file, line, nelem, elsize, p);
 190 #endif
 191     return p;
 192 }
 193
 194 void *save_realloc(const char *name, const char *file, int line, void *ptr,
 195                    size_t nelem, size_t elsize)
 196 {
 197     void  *p;
 198     size_t size = nelem*elsize;
 199
 200     p = NULL;
 201     if (size == 0)
 202     {
 203         save_free(name, file, line, ptr);
 204     }
 205     else
 206     {
 207 #ifdef PRINT_ALLOC_KB
 208         int rank = 0;
 209         if (size >= PRINT_ALLOC_KB*1024)
 210         {
 211 #ifdef GMX_MPI
 212             MPI_Comm_rank(MPI_COMM_WORLD, &rank);
 213 #endif
 214             printf("Reallocating %.1f MB for %s (called from file %s, line %d on %d)\n",
 215                    size/1048576.0, name, file, line, rank);
 216         }
 217 #endif
 218         if (ptr == NULL)
 219         {
 220             p = malloc((size_t)size);
 221         }
 222         else
 223         {
 224             p = realloc(ptr, (size_t)size);
 225         }
 226         if (p == NULL)
 227         {
 228             gmx_fatal(errno, __FILE__, __LINE__,
 229                       "Not enough memory. Failed to realloc %"GMX_PRId64 " bytes for %s, %s=%x\n"
 230                       "(called from file %s, line %d)",
 231                       (gmx_int64_t)size, name, name, ptr, file, line);
 232         }
 233 #ifdef DEBUG
 234         log_action(1, name, file, line, 1, size, p);
 235 #endif
 236     }
 237     return p;
 238 }
 239
 240 void save_free(const char gmx_unused *name, const char gmx_unused *file, int gmx_unused line, void *ptr)
 241 {
 242 #ifdef DEBUG
 243     log_action(0, name, file, line, 0, 0, ptr);
 244 #endif
 245     if (ptr != NULL)
 246     {
 247         free(ptr);
 248     }
 249 }
 250
 251 /* If we don't have useful routines for allocating aligned memory,
 252  * then we have to use the old-style GROMACS approach bitwise-ANDing
 253  * pointers to ensure alignment. We store the pointer to the originally
 254  * allocated region in the space before the returned pointer */
 255
 256 /* we create a positive define for the absence of an system-provided memalign */
 257 #if (!defined HAVE_POSIX_MEMALIGN && !defined HAVE_MEMALIGN && \
 258      !defined HAVE__ALIGNED_MALLOC)
 259 #define GMX_OWN_MEMALIGN
 260 #endif
 261
 262
 263 /* Pointers allocated with this routine should only be freed
 264  * with save_free_aligned, however this will only matter
 265  * on systems that lack posix_memalign() and memalign() when
 266  * freeing memory that needed to be adjusted to achieve
 267  * the necessary alignment. */
 268 void *save_malloc_aligned(const char *name, const char *file, int line,
 269                           size_t nelem, size_t elsize, size_t alignment)
 270 {
 271     void   **aligned  = NULL;
 272     void    *malloced = NULL;
 273     gmx_bool allocate_fail;
 274
 275     if (alignment == 0)
 276     {
 277         gmx_fatal(errno, __FILE__, __LINE__,
 278                   "Cannot allocate aligned memory with alignment of zero!\n(called from file %s, line %d)", file, line);
 279     }
 280
 281
 282     if (nelem == 0 || elsize == 0)
 283     {
 284         aligned  = NULL;
 285     }
 286     else
 287     {
 288 #ifdef PRINT_ALLOC_KB
 289         if (nelem*elsize >= PRINT_ALLOC_KB*1024)
 290         {
 291             printf("Allocating %.1f MB for %s\n",
 292                    nelem*elsize/(PRINT_ALLOC_KB*1024.0), name);
 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 *name, const char *file, int 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 }