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

   1 /* cilk-abi-vla-internal.h        -*-C++-*-
   2  *
   3  *************************************************************************
   4  *
   5  *  @copyright
   6  *  Copyright (C) 2013, Intel Corporation
   7  *  All rights reserved.
   8  *
   9  *  @copyright
  10  *  Redistribution and use in source and binary forms, with or without
  11  *  modification, are permitted provided that the following conditions
  12  *  are met:
  13  *
  14  *    * Redistributions of source code must retain the above copyright
  15  *      notice, this list of conditions and the following disclaimer.
  16  *    * Redistributions in binary form must reproduce the above copyright
  17  *      notice, this list of conditions and the following disclaimer in
  18  *      the documentation and/or other materials provided with the
  19  *      distribution.
  20  *    * Neither the name of Intel Corporation nor the names of its
  21  *      contributors may be used to endorse or promote products derived
  22  *      from this software without specific prior written permission.
  23  *
  24  *  @copyright
  25  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  26  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  27  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  28  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  29  *  HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  30  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  31  *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
  32  *  OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  33  *  AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  34  *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
  35  *  WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  36  *  POSSIBILITY OF SUCH DAMAGE.
  37  **************************************************************************/
  38
  39 /**
  40  * @file cilk-abi-vla-internal.h
  41  *
  42  * @brief Allocation/deallocation function for use with Variable Length
  43  * Arrays in spawning functions.
  44  *
  45  * These should be the only functions in the Cilk runtime allocating memory
  46  * from the standard C runtime heap.  This memory will be provided to user
  47  * code for use in VLAs, when the memory cannot be allocated from the stack.
  48  *
  49  * While these functions are simply passthroughs to malloc and free at the
  50  * moment, once we've got the basics of VLA allocations working we'll make
  51  * them do fancier tricks.
  52  */
  53
  54 /**
  55  * @brief Allocate memory from the heap for use by a Variable Length Array in
  56  * a spawning function.
  57  *
  58  * @param sf The __cilkrts_stack_frame for the spawning function containing
  59  * the VLA.
  60  * @param full_size The number of bytes to be allocated, including any tags
  61  * needed to identify this as allocated from the heap.
  62  * @param align Any alignment necessary for the allocation.
  63  */
  64
  65 void *vla_internal_heap_alloc(__cilkrts_stack_frame *sf,
  66                               size_t full_size,
  67                               uint32_t align);
  68
  69 /**
  70  * @brief Deallocate memory from the heap used by a Variable Length Array in
  71  * a spawning function.
  72  *
  73  * @param t The address of the memory block to be freed.
  74  * @param size The size of the memory block to be freed.
  75  */
  76
  77 void vla_internal_heap_free(void *t,
  78                             size_t size);
  79
  80 /**
  81  * @brief Deallocate memory from the original stack.  We'll do this by adding
  82  * full_size to ff->sync_sp.  So after the sync, the Variable Length Array
  83  * will no longer be allocated on the stack.
  84  *
  85  * @param sf The __cilkrts_stack_frame for the spawning function that is
  86  * deallocating a VLA.
  87  * @param full_size The size of the VLA, including any alignment and tags.
  88  */
  89 void vla_free_from_original_stack(__cilkrts_stack_frame *sf,
  90                                   size_t full_size);