libcilkrts/runtime/pedigrees.c

   1 /* pedigrees.c                  -*-C-*-
   2  *
   3  *************************************************************************
   4  *
   5  *  Copyright (C) 2007-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 #include "pedigrees.h"
  52 #include "local_state.h"
  53
  54 /*************************************************************
  55   Pedigree API code.
  56 *************************************************************/
  57
  58 /*
  59  * C99 requires that every inline function with external linkage have one
  60  * extern declaration in the program (with the inline definition in scope).
  61  */
  62 COMMON_PORTABLE
  63 extern void update_pedigree_on_leave_frame(__cilkrts_worker *w,
  64                                            __cilkrts_stack_frame *sf);
  65
  66 void __cilkrts_set_pedigree_leaf(__cilkrts_pedigree *leaf)
  67 {
  68     __cilkrts_set_tls_pedigree_leaf(leaf);
  69 }
  70
  71 void load_pedigree_leaf_into_user_worker(__cilkrts_worker *w)
  72 {
  73     __cilkrts_pedigree *pedigree_leaf;
  74     CILK_ASSERT(w->l->type == WORKER_USER);
  75     pedigree_leaf = __cilkrts_get_tls_pedigree_leaf(1);
  76     w->pedigree = *pedigree_leaf;
  77
  78     // Save a pointer to the old leaf.
  79     // We'll need to restore it later.
  80     CILK_ASSERT(w->l->original_pedigree_leaf == NULL);
  81     w->l->original_pedigree_leaf = pedigree_leaf;
  82
  83     __cilkrts_set_tls_pedigree_leaf(&w->pedigree);
  84
  85     // Check that this new pedigree root has at least two values.
  86     CILK_ASSERT(w->pedigree.parent);
  87     CILK_ASSERT(w->pedigree.parent->parent == NULL);
  88 }
  89
  90 void save_pedigree_leaf_from_user_worker(__cilkrts_worker *w)
  91 {
  92     CILK_ASSERT(w->l->type == WORKER_USER);
  93
  94     // Existing leaf in tls should be for the current worker.
  95     // This assert is expensive to check though.
  96     // CILK_ASSERT(&w->pedigree == __cilkrts_get_tls_pedigree_leaf(0));
  97     CILK_ASSERT(w->l->original_pedigree_leaf);
  98
  99     // w should finish with a pedigree node that points to
 100     // the same root that we just looked up.
 101
 102     // TODO: This assert should be valid.
 103     // But we are removing it now to make exceptions (without pedigrees) work.
 104     // Currently, reading the pedigree after an exception is caught
 105     // fails because the pedigree chain not restored correctly.
 106     // CILK_ASSERT(w->l->original_pedigree_leaf->next == w->pedigree.parent);
 107     w->l->original_pedigree_leaf->rank = w->pedigree.rank;
 108
 109     // Save that leaf pointer back into tls.
 110     __cilkrts_set_tls_pedigree_leaf(w->l->original_pedigree_leaf);
 111     // Null out worker's leaf for paranoia.
 112     w->l->original_pedigree_leaf = NULL;
 113 }
 114
 115
 116
 117 /*
 118   Local Variables: **
 119   c-file-style:"bsd" **
 120   c-basic-offset:4 **
 121   indent-tabs-mode:nil **
 122   End: **
 123 */