libcilkrts/runtime/cilk-abi-vla-internal.h

   1 /* cilk-abi-vla-internal.h        -*-C++-*-
   2  *
   3  *************************************************************************
   4  *
   5  *  Copyright (C) 2013-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-abi-vla-internal.h
  52  *
  53  * @brief Allocation/deallocation function for use with Variable Length
  54  * Arrays in spawning functions.
  55  *
  56  * These should be the only functions in the Cilk runtime allocating memory
  57  * from the standard C runtime heap.  This memory will be provided to user
  58  * code for use in VLAs, when the memory cannot be allocated from the stack.
  59  *
  60  * While these functions are simply passthroughs to malloc and free at the
  61  * moment, once we've got the basics of VLA allocations working we'll make
  62  * them do fancier tricks.
  63  */
  64
  65 /**
  66  * @brief Allocate memory from the heap for use by a Variable Length Array in
  67  * a spawning function.
  68  *
  69  * @param sf The __cilkrts_stack_frame for the spawning function containing
  70  * the VLA.
  71  * @param full_size The number of bytes to be allocated, including any tags
  72  * needed to identify this as allocated from the heap.
  73  * @param align Any alignment necessary for the allocation.
  74  */
  75
  76 void *vla_internal_heap_alloc(__cilkrts_stack_frame *sf,
  77                               size_t full_size,
  78                               uint32_t align);
  79
  80 /**
  81  * @brief Deallocate memory from the heap used by a Variable Length Array in
  82  * a spawning function.
  83  *
  84  * @param t The address of the memory block to be freed.
  85  * @param size The size of the memory block to be freed.
  86  */
  87
  88 void vla_internal_heap_free(void *t,
  89                             size_t size);
  90
  91 /**
  92  * @brief Deallocate memory from the original stack.  We'll do this by adding
  93  * full_size to ff->sync_sp.  So after the sync, the Variable Length Array
  94  * will no longer be allocated on the stack.
  95  *
  96  * @param sf The __cilkrts_stack_frame for the spawning function that is
  97  * deallocating a VLA.
  98  * @param full_size The size of the VLA, including any alignment and tags.
  99  */
 100 void vla_free_from_original_stack(__cilkrts_stack_frame *sf,
 101                                   size_t full_size);