libcilkrts/runtime/cilk_malloc.h

   1 /* cilk_malloc.h                  -*-C++-*-
   2  *
   3  *************************************************************************
   4  *
   5  *  Copyright (C) 2009-2016, Intel Corporation
   6  *  All rights reserved.
   7  *
   8  *  Redistribution and use in source and binary forms, with or without
   9  *  modification, are permitted provided that the following conditions
  10  *  are met:
  11  *
  12  *    * Redistributions of source code must retain the above copyright
  13  *      notice, this list of conditions and the following disclaimer.
  14  *    * Redistributions in binary form must reproduce the above copyright
  15  *      notice, this list of conditions and the following disclaimer in
  16  *      the documentation and/or other materials provided with the
  17  *      distribution.
  18  *    * Neither the name of Intel Corporation nor the names of its
  19  *      contributors may be used to endorse or promote products derived
  20  *      from this software without specific prior written permission.
  21  *
  22  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  23  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  24  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  25  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  26  *  HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  27  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  28  *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
  29  *  OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  30  *  AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31  *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
  32  *  WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  33  *  POSSIBILITY OF SUCH DAMAGE.
  34  *
  35  *  *********************************************************************
  36  *
  37  *  PLEASE NOTE: This file is a downstream copy of a file mainitained in
  38  *  a repository at cilkplus.org. Changes made to this file that are not
  39  *  submitted through the contribution process detailed at
  40  *  http://www.cilkplus.org/submit-cilk-contribution will be lost the next
  41  *  time that a new version is released. Changes only submitted to the
  42  *  GNU compiler collection or posted to the git repository at
  43  *  https://bitbucket.org/intelcilkruntime/intel-cilk-runtime.git are
  44  *  not tracked.
  45  *
  46  *  We welcome your contributions to this open source project. Thank you
  47  *  for your assistance in helping us improve Cilk Plus.
  48  **************************************************************************/
  49
  50 /**
  51  * @file cilk_malloc.h
  52  *
  53  * @brief Provides replacement memory allocation functions to allocate
  54  * (and free) memory on cache line boundaries, if supported by the OS.
  55  *
  56  * If aligned memory functions are not provided by the OS, the calls just
  57  * pass through to the standard memory allocation functions.
  58  */
  59
  60 #ifndef INCLUDED_CILK_MALLOC_DOT_H
  61 #define INCLUDED_CILK_MALLOC_DOT_H
  62
  63 #include <cilk/common.h>
  64 #include <stddef.h>
  65
  66 #include "rts-common.h"
  67
  68 __CILKRTS_BEGIN_EXTERN_C
  69
  70 /**
  71  * malloc replacement function to allocate memory aligned on a cache line
  72  * boundary if aligned memory allocations are supported by the OS.
  73  *
  74  * @param size Number of bytes to allocate.
  75  *
  76  * @return pointer to memory block allocated, or NULL if unsuccessful.
  77  */
  78 COMMON_PORTABLE void *__cilkrts_malloc(size_t size);
  79
  80 /**
  81  * realloc replacement function to allocate memory aligned on a cache line
  82  * boundary if aligned memory allocations are supported by the OS.
  83  *
  84  * @param ptr Block to be reallocated.
  85  * @param size Number of bytes to allocate.
  86  *
  87  * @return pointer to memory block allocated, or NULL if unsuccessful.
  88  */
  89 COMMON_PORTABLE void *__cilkrts_realloc(void *ptr, size_t size);
  90
  91 /**
  92  * free replacement function to deallocate memory aligned on a cache line
  93  * boundary if aligned memory allocations are supported by the OS.
  94  *
  95  * @param ptr Block to be freed.
  96  */
  97 COMMON_PORTABLE void __cilkrts_free(void *ptr);
  98
  99 __CILKRTS_END_EXTERN_C
 100
 101 #endif // ! defined(INCLUDED_CILK_MALLOC_DOT_H)