libcilkrts/runtime/cilk-ittnotify.h

   1 /* cilk-ittnotify.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_CILK_ITTNOTIFY_DOT_H
  51 #define INCLUDED_CILK_ITTNOTIFY_DOT_H
  52
  53 #ifdef __INTEL_COMPILER
  54 #endif
  55 #include <stdio.h>
  56
  57 // ITTNOTIFY does not support ARM at this time
  58 #ifdef __arm__
  59 #undef USE_ITTNOTIFY
  60 #endif
  61
  62 #ifdef USE_ITTNOTIFY
  63 #include <ittnotify.h>
  64
  65 #ifdef _WIN32
  66 # define ITT_SYNC_CREATE(_address, _description)        \
  67     __itt_sync_createA(_address,                        \
  68                        "Intel Cilk Plus " _description, \
  69                        "",                              \
  70                        __itt_attr_barrier)
  71 #else
  72 # define ITT_SYNC_CREATE(_address, _description)        \
  73     __itt_sync_create(_address,                         \
  74                       "Intel Cilk Plus " _description,  \
  75                       "",                               \
  76                       __itt_attr_barrier)
  77 #endif
  78
  79 #define ITT_SYNC_PREPARE(_address) __itt_sync_prepare(_address)
  80 #define ITT_SYNC_ACQUIRED(_address) __itt_sync_acquired(_address)
  81 #define ITT_SYNC_RELEASING(_address) __itt_sync_releasing(_address)
  82 #define ITT_SYNC_DESTROY(_address) __itt_sync_destroy(_address)
  83 // Note that we subtract 5 from the return address to find the CALL instruction
  84 // to __cilkrts_sync
  85 #if 1   // Disable renaming for now.  Piersol isn't ready yet
  86 #define ITT_SYNC_SET_NAME_AND_PREPARE(_address, _sync_ret_address) __itt_sync_prepare(_address)
  87 #else
  88 #define ITT_SYNC_SET_NAME_AND_PREPARE(_address, _sync_ret_address) \
  89     if (NULL != __itt_sync_prepare_ptr) {   \
  90         if (0 == _sync_ret_address) \
  91             __itt_sync_renameA(_address, "");  \
  92         else    \
  93         {   \
  94             char buf[128];  \
  95             sprintf_s(buf, 128, "IP:0x%p", (DWORD_PTR)_sync_ret_address - 5); \
  96             __itt_sync_renameA(_address, buf); \
  97             _sync_ret_address = 0;  \
  98          }  \
  99         __itt_sync_prepare(_address);  \
 100     }
 101 #endif
 102 #else   // USE_ITTNOTIFY not defined, compile out all calls
 103 #define ITT_SYNC_CREATE(_address, _description)
 104 #define ITT_SYNC_PREPARE(_address)
 105 #define ITT_SYNC_ACQUIRED(_address)
 106 #define ITT_SYNC_RELEASING(_addresss)
 107 #define ITT_SYNC_DESTROY(_address)
 108 #define ITT_SYNC_SET_NAME_AND_PREPARE(_sync_address, _wait_address)
 109 #endif
 110
 111 #endif // ! defined(INCLUDED_CILK_ITTNOTIFY_DOT_H)