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