|
111
|
1 /* reducer_impl.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 /**
|
|
|
51 * @file reducer_impl.h
|
|
|
52 *
|
|
|
53 * @brief Functions to implement reducers in the runtime.
|
|
|
54 */
|
|
|
55
|
|
|
56 #ifndef INCLUDED_REDUCER_IMPL_DOT_H
|
|
|
57 #define INCLUDED_REDUCER_IMPL_DOT_H
|
|
|
58
|
|
|
59 #include <cilk/common.h>
|
|
|
60 #include <internal/abi.h>
|
|
|
61 #include "rts-common.h"
|
|
|
62
|
|
|
63 __CILKRTS_BEGIN_EXTERN_C
|
|
|
64
|
|
|
65 /**
|
|
|
66 * Construct an empty reducer map from the memory pool associated with the
|
|
|
67 * given worker. This reducer map must be destroyed before the worker's
|
|
|
68 * associated global context is destroyed.
|
|
|
69 *
|
|
|
70 * @param w __cilkrts_worker the cilkred_map is being created for.
|
|
|
71 *
|
|
|
72 * @return Pointer to the initialized cilkred_map.
|
|
|
73 */
|
|
|
74 COMMON_SYSDEP
|
|
|
75 cilkred_map *__cilkrts_make_reducer_map(__cilkrts_worker *w);
|
|
|
76
|
|
|
77 /**
|
|
|
78 * Destroy a reducer map. The map must have been allocated from the worker's
|
|
|
79 * global context and should have been allocated from the same worker.
|
|
|
80 *
|
|
|
81 * @param w __cilkrts_worker the cilkred_map was created for.
|
|
|
82 * @param h The cilkred_map to be deallocated.
|
|
|
83 */
|
|
|
84 COMMON_SYSDEP
|
|
|
85 void __cilkrts_destroy_reducer_map(__cilkrts_worker *w,
|
|
|
86 cilkred_map *h);
|
|
|
87
|
|
|
88 /**
|
|
|
89 * Set the specified reducer map as the leftmost map if is_leftmost is true,
|
|
|
90 * otherwise, set it to not be the leftmost map.
|
|
|
91 *
|
|
|
92 * @param h The cilkred_map to be modified.
|
|
|
93 * @param is_leftmost true if the reducer map is leftmost.
|
|
|
94 */
|
|
|
95 COMMON_SYSDEP
|
|
|
96 void __cilkrts_set_leftmost_reducer_map(cilkred_map *h,
|
|
|
97 int is_leftmost);
|
|
|
98
|
|
|
99 /**
|
|
|
100 * Merge reducer map RIGHT_MAP into LEFT_MAP and return the result of the
|
|
|
101 * merge. Both maps must be allocated from the global context associated
|
|
|
102 * with the specified worker. The returned reducer map must be destroyed
|
|
|
103 * before the worker's associated global context is destroyed.
|
|
|
104 *
|
|
|
105 * If two cilkred_maps are specified, one will be destroyed and the other
|
|
|
106 * one will be returned as the merged cilkred_map.
|
|
|
107 *
|
|
|
108 * When reducers can contain nested parallelism, execution can return
|
|
|
109 * on a different worker than when it started (but still using the
|
|
|
110 * same stack).
|
|
|
111 *
|
|
|
112 * Upon return, *w_ptr stores the pointer to the worker that execution
|
|
|
113 * returns on.
|
|
|
114 *
|
|
|
115 * @param w_ptr Pointer to the currently executing worker.
|
|
|
116 * @param left_map The left cilkred_map.
|
|
|
117 * @param right_map The right cilkred_map.
|
|
|
118 *
|
|
|
119 * @return pointer to merged cilkred_map.
|
|
|
120 */
|
|
|
121 extern
|
|
|
122 cilkred_map *merge_reducer_maps(__cilkrts_worker **w_ptr,
|
|
|
123 cilkred_map *left_map,
|
|
|
124 cilkred_map *right_map);
|
|
|
125
|
|
|
126 /**
|
|
|
127 * Similar to merge_reducer_maps(), except that after merging
|
|
|
128 * RIGHT_MAP into LEFT_MAP, it repeatedly merges (*w_ptr)->reducer_map
|
|
|
129 * into LEFT_MAP. This procedure ensures that any new reducers
|
|
|
130 * created by the reductions themselves also get merged into LEFT_MAP.
|
|
|
131 */
|
|
|
132 extern
|
|
|
133 cilkred_map *repeated_merge_reducer_maps(__cilkrts_worker **w_ptr,
|
|
|
134 cilkred_map *left_map,
|
|
|
135 cilkred_map *right_map);
|
|
|
136
|
|
|
137 __CILKRTS_END_EXTERN_C
|
|
|
138
|
|
|
139 #endif // ! defined(INCLUDED_REDUCER_IMPL_DOT_H)
|
