2 This source code file is part of thread_mpi.
3 Written by Sander Pronk, Erik Lindahl, and possibly others.
5 Copyright (c) 2009, Sander Pronk, Erik Lindahl.
8 Redistribution and use in source and binary forms, with or without
9 modification, are permitted provided that the following conditions are met:
10 1) Redistributions of source code must retain the above copyright
11 notice, this list of conditions and the following disclaimer.
12 2) Redistributions in binary form must reproduce the above copyright
13 notice, this list of conditions and the following disclaimer in the
14 documentation and/or other materials provided with the distribution.
15 3) Neither the name of the copyright holders nor the
16 names of its contributors may be used to endorse or promote products
17 derived from this software without specific prior written permission.
19 THIS SOFTWARE IS PROVIDED BY US ''AS IS'' AND ANY
20 EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 DISCLAIMED. IN NO EVENT SHALL WE BE LIABLE FOR ANY
23 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
26 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 If you want to redistribute modifications, please consider that
31 scientific software is very special. Version control is crucial -
32 bugs must be traceable. We will be happy to consider code for
33 inclusion in the official distribution, but derived work should not
34 be called official thread_mpi. Details are found in the README & COPYING
39 #ifndef TMPI_NUMA_MALLOC_H_
40 #define TMPI_NUMA_MALLOC_H_
44 \brief NUMA aware memory allocators.
46 This file provides a NUMA aware version of malloc() and friends to
47 force local allocation, preventing expensive 'remote' memory access.
49 Note that memory allocated with tMPI_Malloc_local(), etc. MUST be
50 freed with tMPI_Free_numa().
52 Currently this is only implemented on Windows. Check for the presence
53 of these functions with
55 #ifdef TMPI_NUMA_MALLOC
62 #include "visibility.h"
69 } /* Avoids screwing up auto-indentation */
73 #if (defined(WIN32) || defined( _WIN32 ) || defined(WIN64) || defined( _WIN64 )) && !defined (__CYGWIN__) && !defined (__CYGWIN32__)
75 #define TMPI_NUMA_MALLOC
80 /*! \brief Allocate local memory by size in bytes.
84 \param[in] size = size in units of sizeof() of the memory to be allocated
86 \return Pointer to allocated memory, or NULL in case of failure
89 void *tMPI_Malloc_local(size_t size);
92 /*! \brief Allocate local memory by array and element size.
96 \param[in] nmemb = number of array members
97 \param[in] size = size in units of sizeof() of a single array element
99 \return Pointer to allocated memory, or NULL in case of failure
102 void *tMPI_Calloc_local(size_t nmemb, size_t size);
105 /*! \brief Re-allocate to local memory.
109 \param[in] ptr = input pointer of originally allocated memory (can
110 be allocated with NUMA or non-NUMA malloc())
111 \param[in] size = new size in units of sizeof().
113 \return Pointer to allocated memory, or NULL in case of failure
116 void *tMPI_Realloc_local(void *ptr, size_t size);
119 /*! \brief Free memory allocate with any of the NUMA-aware allocators
123 \param[in] ptr = pointer to block of memory allocated with a NUMA allocator
125 \return Returns debug info: 0 if the memory was allocated with a NUMA
126 allocator, 1 if it was allocated by another allocator.
129 int tMPI_Free_numa(void *ptr);
136 #endif /* TMPI_NUMA_MALLOC_H_ */