libcilkrts/runtime/pedigrees.h

   1 /* pedigrees.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 #ifndef INCLUDED_PEDIGREES_DOT_H
  51 #define INCLUDED_PEDIGREES_DOT_H
  52
  53
  54 #include <cilk/common.h>
  55 #include <internal/abi.h>
  56
  57 #include "rts-common.h"
  58 #include "global_state.h"
  59 #include "os.h"
  60
  61 __CILKRTS_BEGIN_EXTERN_C
  62
  63 /**
  64  * @file pedigrees.h
  65  *
  66  * @brief pedigrees.h declares common routines related to pedigrees
  67  * and the pedigree API.
  68  */
  69
  70
  71 /**
  72  * @brief Sets the leaf pedigree node for the current user thread.
  73  *
  74  * A typical implementation stores this pedigree node in thread-local
  75  * storage.
  76  *
  77  * Preconditions:
  78  *  - Current thread should be a user thread.
  79  *
  80  * @param leaf The pedigree node to store as a leaf.
  81  */
  82 COMMON_PORTABLE
  83 void __cilkrts_set_pedigree_leaf(__cilkrts_pedigree* leaf);
  84
  85
  86 /**
  87  * Load the pedigree leaf node from thread-local storage into the
  88  * current user worker.  This method should execute as a part of
  89  * binding the user thread to a worker.
  90  *
  91  * Preconditions:
  92  *
  93  *  - w should be the worker for the current thread
  94  *  - w should be a user thread.
  95  */
  96 COMMON_PORTABLE
  97 void load_pedigree_leaf_into_user_worker(__cilkrts_worker *w);
  98
  99 /**
 100  * Save the pedigree leaf node from the worker into thread-local
 101  * storage.  This method should execute as part of unbinding a user
 102  * thread from a worker.
 103  *
 104  * Preconditions:
 105  *
 106  *  - w should be the worker for the current thread
 107  *  - w should be a user thread.
 108  */
 109 COMMON_PORTABLE
 110 void save_pedigree_leaf_from_user_worker(__cilkrts_worker *w);
 111
 112
 113
 114 /**
 115  * Update pedigree for a worker when leaving a frame.
 116  *
 117  * If this is the frame of a spawn helper (indicated by the
 118  *  CILK_FRAME_DETACHED flag) we must update the pedigree.  The
 119  *  pedigree points to nodes allocated on the stack.  Failing to
 120  *  update it will result in a accvio/segfault if the pedigree is
 121  *  walked.  This must happen for all spawn helper frames, even if
 122  *  we're processing an exception.
 123  */
 124 COMMON_PORTABLE
 125 inline void update_pedigree_on_leave_frame(__cilkrts_worker *w,
 126                                            __cilkrts_stack_frame *sf)
 127 {
 128     // Update the worker's pedigree information if this is an ABI 1 or later
 129     // frame
 130     if (CILK_FRAME_VERSION_VALUE(sf->flags) >= 1)
 131     {
 132         w->pedigree.rank = sf->spawn_helper_pedigree.rank + 1;
 133         w->pedigree.parent = sf->spawn_helper_pedigree.parent;
 134     }
 135 }
 136
 137
 138
 139 __CILKRTS_END_EXTERN_C
 140
 141 #endif // ! defined(INCLUDED_PEDIGREES_DOT_H)