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 "gromacs/utility/smalloc.h"
  38
  39 #include "config.h"
  40
  41 #include <errno.h>
  42 #include <stdio.h>
  43 #include <stdlib.h>
  44 #include <string.h>
  45
  46 #ifdef WITH_DMALLOC
  47 #include <dmalloc.h>
  48 #endif
  49
  50 #include "thread_mpi/threads.h"
  51
  52 #include "gromacs/utility/fatalerror.h"
  53 #ifdef PRINT_ALLOC_KB
  54 #include "gromacs/utility/gmxmpi.h"
  55 #endif
  56
  57 static gmx_bool            g_bOverAllocDD     = FALSE;
  58 static tMPI_Thread_mutex_t g_over_alloc_mutex = TMPI_THREAD_MUTEX_INITIALIZER;
  59
  60 #ifdef DEBUG
  61 static void log_action(int bMal, const char *what, const char *file, int line,
  62                        int nelem, int size, void *ptr)
  63 {
  64     static int btot = 0;
  65     char      *NN   = "NULL";
  66     int        bytes;
  67
  68     bytes = size*nelem;
  69     if (!bMal)
  70     {
  71         bytes = -bytes;
  72     }
  73
  74     tMPI_Thread_mutex_lock(&gmx_logfile_mtx);
  75
  76     /* This total memory count is not correct, since with realloc
  77      * it adds the whole size again, not just the increment.
  78      */
  79     /* This static variable is protected by the mutex too... */
  80     btot += bytes;
  81
  82     bytes /= 1024;
  83     if (debug && (bytes != 0))
  84     {
  85         fprintf(debug, "%s:%d kB (%7d kB) [%s, line %d, nelem %d, size %d]\n",
  86                 what ? what : NN, bytes, btot/1024,
  87                 file ? file : NN, line, nelem, size);
  88     }
  89     /* Print to stderr for things larger than 1 MB */
  90     if (bytes >= 1024 || bytes <= -1024)
  91     {
  92         char *fname = NULL;
  93         if (file)
  94         {
  95             fname = strrchr(file, DIR_SEPARATOR);
  96             if (fname)
  97             {
  98                 fname++;
  99             }
 100             else
 101             {
 102                 fname = file;
 103             }
 104         }
 105         printf("%s: %.1f MB [%s, line %d, nelem %d, size %d]\n",
 106                what ? what  : NN, bytes/1024.0,
 107                file ? fname : NN, line, nelem, size);
 108     }
 109     tMPI_Thread_mutex_unlock(&gmx_logfile_mtx);
 110 }
 111 #endif
 112
 113 void *save_malloc(const char *name, const char *file, int line, size_t size)
 114 {
 115     void *p;
 116
 117     p = NULL;
 118     if (size == 0)
 119     {
 120         p = NULL;
 121     }
 122     else
 123     {
 124         if ((p = malloc(size)) == NULL)
 125         {
 126             gmx_fatal(errno, __FILE__, __LINE__,
 127                       "Not enough memory. Failed to malloc %"GMX_PRId64 " bytes for %s\n"
 128                       "(called from file %s, line %d)",
 129                       (gmx_int64_t)size, name, file, line);
 130         }
 131         (void) memset(p, 0, size);
 132     }
 133 #ifdef DEBUG
 134     log_action(1, name, file, line, 1, size, p);
 135 #endif
 136     return p;
 137 }
 138
 139 void *save_calloc(const char *name, const char *file, int line,
 140                   size_t nelem, size_t elsize)
 141 {
 142     void *p;
 143
 144     p = NULL;
 145     if ((nelem == 0) || (elsize == 0))
 146     {
 147         p = NULL;
 148     }
 149     else
 150     {
 151 #ifdef PRINT_ALLOC_KB
 152         int rank = 0;
 153         if (nelem*elsize >= PRINT_ALLOC_KB*1024)
 154         {
 155 #ifdef GMX_MPI
 156             MPI_Comm_rank(MPI_COMM_WORLD, &rank);
 157 #endif
 158             printf("Allocating %.1f MB for %s (called from file %s, line %d on %d)\n",
 159                    nelem*elsize/1048576.0, name, file, line, rank);
 160         }
 161 #endif
 162 #ifdef GMX_BROKEN_CALLOC
 163         /* emulate calloc(3) with malloc/memset on machines with
 164            a broken calloc, e.g. in -lgmalloc on cray xt3. */
 165         if ((p = malloc((size_t)nelem*(size_t)elsize)) == NULL)
 166         {
 167             gmx_fatal(errno, __FILE__, __LINE__,
 168                       "Not enough memory. Failed to calloc %"GMX_PRId64
 169                       " elements of size %"GMX_PRId64
 170                       " for %s\n(called from file %s, line %d)",
 171                       (gmx_int64_t)nelem, (gmx_int64_t)elsize,
 172                       name, file, line);
 173         }
 174         memset(p, 0, (size_t) (nelem * elsize));
 175 #else
 176         if ((p = calloc((size_t)nelem, (size_t)elsize)) == NULL)
 177         {
 178             gmx_fatal(errno, __FILE__, __LINE__,
 179                       "Not enough memory. Failed to calloc %"GMX_PRId64
 180                       " elements of size %"GMX_PRId64
 181                       " for %s\n(called from file %s, line %d)",
 182                       (gmx_int64_t)nelem, (gmx_int64_t)elsize, name, file, line);
 183         }
 184 #endif
 185     }
 186 #ifdef DEBUG
 187     log_action(1, name, file, line, nelem, elsize, p);
 188 #endif
 189     return p;
 190 }
 191
 192 void *save_realloc(const char *name, const char *file, int line, void *ptr,
 193                    size_t nelem, size_t elsize)
 194 {
 195     void  *p;
 196     size_t size = nelem*elsize;
 197
 198     p = NULL;
 199     if (size == 0)
 200     {
 201         save_free(name, file, line, ptr);
 202     }
 203     else
 204     {
 205 #ifdef PRINT_ALLOC_KB
 206         int rank = 0;
 207         if (size >= PRINT_ALLOC_KB*1024)
 208         {
 209 #ifdef GMX_MPI
 210             MPI_Comm_rank(MPI_COMM_WORLD, &rank);
 211 #endif
 212             printf("Reallocating %.1f MB for %s (called from file %s, line %d on %d)\n",
 213                    size/1048576.0, name, file, line, rank);
 214         }
 215 #endif
 216         if (ptr == NULL)
 217         {
 218             p = malloc((size_t)size);
 219         }
 220         else
 221         {
 222             p = realloc(ptr, (size_t)size);
 223         }
 224         if (p == NULL)
 225         {
 226             gmx_fatal(errno, __FILE__, __LINE__,
 227                       "Not enough memory. Failed to realloc %"GMX_PRId64 " bytes for %s, %s=%x\n"
 228                       "(called from file %s, line %d)",
 229                       (gmx_int64_t)size, name, name, ptr, file, line);
 230         }
 231 #ifdef DEBUG
 232         log_action(1, name, file, line, 1, size, p);
 233 #endif
 234     }
 235     return p;
 236 }
 237
 238 void save_free(const char gmx_unused *name, const char gmx_unused *file, int gmx_unused line, void *ptr)
 239 {
 240 #ifdef DEBUG
 241     log_action(0, name, file, line, 0, 0, ptr);
 242 #endif
 243     if (ptr != NULL)
 244     {
 245         free(ptr);
 246     }
 247 }
 248
 249 /* If we don't have useful routines for allocating aligned memory,
 250  * then we have to use the old-style GROMACS approach bitwise-ANDing
 251  * pointers to ensure alignment. We store the pointer to the originally
 252  * allocated region in the space before the returned pointer */
 253
 254 /* we create a positive define for the absence of an system-provided memalign */
 255 #if (!defined HAVE_POSIX_MEMALIGN && !defined HAVE_MEMALIGN && \
 256      !defined HAVE__ALIGNED_MALLOC)
 257 #define GMX_OWN_MEMALIGN
 258 #endif
 259
 260
 261 /* Pointers allocated with this routine should only be freed
 262  * with save_free_aligned, however this will only matter
 263  * on systems that lack posix_memalign() and memalign() when
 264  * freeing memory that needed to be adjusted to achieve
 265  * the necessary alignment. */
 266 void *save_malloc_aligned(const char *name, const char *file, int line,
 267                           size_t nelem, size_t elsize, size_t alignment)
 268 {
 269     void   **aligned  = NULL;
 270     void    *malloced = NULL;
 271     gmx_bool allocate_fail;
 272
 273     if (alignment == 0)
 274     {
 275         gmx_fatal(errno, __FILE__, __LINE__,
 276                   "Cannot allocate aligned memory with alignment of zero!\n(called from file %s, line %d)", file, line);
 277     }
 278
 279
 280     if (nelem == 0 || elsize == 0)
 281     {
 282         aligned  = NULL;
 283     }
 284     else
 285     {
 286 #ifdef PRINT_ALLOC_KB
 287         if (nelem*elsize >= PRINT_ALLOC_KB*1024)
 288         {
 289             printf("Allocating %.1f MB for %s\n",
 290                    nelem*elsize/(PRINT_ALLOC_KB*1024.0), name);
 291         }
 292 #endif
 293
 294 #ifdef HAVE_POSIX_MEMALIGN
 295         allocate_fail = (0 != posix_memalign(&malloced, alignment, nelem*elsize));
 296 #elif defined HAVE_MEMALIGN
 297         allocate_fail = ((malloced = memalign(alignment, nelem*elsize)) == NULL);
 298 #elif defined HAVE__ALIGNED_MALLOC
 299         allocate_fail = ((malloced = _aligned_malloc(nelem*elsize, alignment))
 300                          == NULL);
 301 #else
 302         allocate_fail = ((malloced = malloc(nelem*elsize+alignment+
 303                                             sizeof(void*))) == NULL);
 304 #endif
 305         if (allocate_fail)
 306         {
 307             gmx_fatal(errno, __FILE__, __LINE__,
 308                       "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);
 309         }
 310         /* we start with the original pointer */
 311         aligned = (void**)malloced;
 312
 313 #ifdef GMX_OWN_MEMALIGN
 314         /* Make the aligned pointer, and save the underlying pointer that
 315          * we're allowed to free(). */
 316
 317         /* we first make space to store that underlying pointer: */
 318         aligned = aligned + 1;
 319         /* then we apply a bit mask */
 320         aligned = (void *) (((size_t) aligned + alignment - 1) &
 321                             (~((size_t) (alignment-1))));
 322         /* and we store the original pointer in the area just before the
 323            pointer we're going to return */
 324         aligned[-1] = malloced;
 325 #endif
 326     }
 327     return (void*)aligned;
 328 }
 329
 330 void *save_calloc_aligned(const char *name, const char *file, int line,
 331                           size_t nelem, size_t elsize, size_t alignment)
 332 {
 333     void *aligned = save_malloc_aligned(name, file, line, nelem, elsize, alignment);
 334     if (aligned != NULL)
 335     {
 336         memset(aligned, 0, (size_t)(nelem * elsize));
 337     }
 338     return aligned;
 339 }
 340
 341 /* This routine can NOT be called with any pointer */
 342 void save_free_aligned(const char *name, const char *file, int line, void *ptr)
 343 {
 344     int   i, j;
 345     void *free = ptr;
 346
 347     if (NULL != ptr)
 348     {
 349 #ifdef GMX_OWN_MEMALIGN
 350         /* we get the pointer from just before the memaligned pointer */
 351         free = ((void**)ptr)[-1];
 352 #endif
 353
 354 #ifndef HAVE__ALIGNED_MALLOC
 355         /* (Now) we're allowed to use a normal free() on this pointer. */
 356         save_free(name, file, line, free);
 357 #else
 358         _aligned_free(free);
 359 #endif
 360     }
 361 }
 362
 363 void set_over_alloc_dd(gmx_bool set)
 364 {
 365     tMPI_Thread_mutex_lock(&g_over_alloc_mutex);
 366     /* we just make sure that we don't set this at the same time.
 367        We don't worry too much about reading this rarely-set variable */
 368     g_bOverAllocDD = set;
 369     tMPI_Thread_mutex_unlock(&g_over_alloc_mutex);
 370 }
 371
 372 int over_alloc_dd(int n)
 373 {
 374     if (g_bOverAllocDD)
 375     {
 376         return OVER_ALLOC_FAC*n + 100;
 377     }
 378     else
 379     {
 380         return n;
 381     }
 382 }