Intel(R) Threading Building Blocks Doxygen Documentation version 4.2.3
Loading...
Searching...
No Matches
parallel_while.h
Go to the documentation of this file.
1/*
2 Copyright (c) 2005-2020 Intel Corporation
3
4 Licensed under the Apache License, Version 2.0 (the "License");
5 you may not use this file except in compliance with the License.
6 You may obtain a copy of the License at
7
8 http://www.apache.org/licenses/LICENSE-2.0
9
10 Unless required by applicable law or agreed to in writing, software
11 distributed under the License is distributed on an "AS IS" BASIS,
12 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 See the License for the specific language governing permissions and
14 limitations under the License.
15*/
16
17#ifndef __TBB_parallel_while
18#define __TBB_parallel_while
19
20#define __TBB_parallel_while_H_include_area
22
23#include "task.h"
24#include <new>
25
26namespace tbb {
27
28template<typename Body>
29class parallel_while;
30
32namespace internal {
33
34 template<typename Stream, typename Body> class while_task;
35
37
39 template<typename Body>
40 class while_iteration_task: public task {
41 const Body& my_body;
42 typename Body::argument_type my_value;
45 return NULL;
46 }
47 while_iteration_task( const typename Body::argument_type& value, const Body& body ) :
48 my_body(body), my_value(value)
49 {}
50 template<typename Body_> friend class while_group_task;
51 friend class tbb::parallel_while<Body>;
52 };
53
55
57 template<typename Body>
58 class while_group_task: public task {
59 static const size_t max_arg_size = 4;
60 const Body& my_body;
61 size_t size;
62 typename Body::argument_type my_arg[max_arg_size];
63 while_group_task( const Body& body ) : my_body(body), size(0) {}
65 typedef while_iteration_task<Body> iteration_type;
66 __TBB_ASSERT( size>0, NULL );
67 task_list list;
68 task* t;
69 size_t k=0;
70 for(;;) {
71 t = new( allocate_child() ) iteration_type(my_arg[k],my_body);
72 if( ++k==size ) break;
73 list.push_back(*t);
74 }
75 set_ref_count(int(k+1));
76 spawn(list);
78 return NULL;
79 }
80 template<typename Stream, typename Body_> friend class while_task;
81 };
82
84
86 template<typename Stream, typename Body>
87 class while_task: public task {
88 Stream& my_stream;
89 const Body& my_body;
92 typedef while_group_task<Body> block_type;
93 block_type& t = *new( allocate_additional_child_of(my_barrier) ) block_type(my_body);
94 size_t k=0;
95 while( my_stream.pop_if_present(t.my_arg[k]) ) {
96 if( ++k==block_type::max_arg_size ) {
97 // There might be more iterations.
99 break;
100 }
101 }
102 if( k==0 ) {
103 destroy(t);
104 return NULL;
105 } else {
106 t.size = k;
107 return &t;
108 }
109 }
110 while_task( Stream& stream, const Body& body, empty_task& barrier ) :
111 my_stream(stream),
112 my_body(body),
113 my_barrier(barrier)
114 {}
115 friend class tbb::parallel_while<Body>;
116 };
117
118} // namespace internal
120
122
127template<typename Body>
129public:
132
135 if( my_barrier ) {
136 my_barrier->destroy(*my_barrier);
137 my_barrier = NULL;
138 }
139 }
140
142 typedef typename Body::argument_type value_type;
143
145
148 template<typename Stream>
149 void run( Stream& stream, const Body& body );
150
152
153 void add( const value_type& item );
154
155private:
156 const Body* my_body;
158};
159
160template<typename Body>
161template<typename Stream>
162void parallel_while<Body>::run( Stream& stream, const Body& body ) {
163 using namespace internal;
164 empty_task& barrier = *new( task::allocate_root() ) empty_task();
165 my_body = &body;
166 my_barrier = &barrier;
167 my_barrier->set_ref_count(2);
168 while_task<Stream,Body>& w = *new( my_barrier->allocate_child() ) while_task<Stream,Body>( stream, body, barrier );
169 my_barrier->spawn_and_wait_for_all(w);
170 my_barrier->destroy(*my_barrier);
171 my_barrier = NULL;
172 my_body = NULL;
173}
174
175template<typename Body>
177 __TBB_ASSERT(my_barrier,"attempt to add to parallel_while that is not running");
178 typedef internal::while_iteration_task<Body> iteration_type;
179 iteration_type& i = *new( task::allocate_additional_child_of(*my_barrier) ) iteration_type(item,*my_body);
180 task::self().spawn( i );
181}
182
183} // namespace
184
186#undef __TBB_parallel_while_H_include_area
187
188#endif /* __TBB_parallel_while */
#define __TBB_ASSERT(predicate, comment)
No-op version of __TBB_ASSERT.
Definition: tbb_stddef.h:165
#define __TBB_override
Definition: tbb_stddef.h:240
void const char const char int ITT_FORMAT __itt_group_sync x void const char ITT_FORMAT __itt_group_sync s void ITT_FORMAT __itt_group_sync p void ITT_FORMAT p void ITT_FORMAT p no args __itt_suppress_mode_t unsigned int void size_t ITT_FORMAT d void ITT_FORMAT p void ITT_FORMAT p __itt_model_site __itt_model_site_instance ITT_FORMAT p __itt_model_task __itt_model_task_instance ITT_FORMAT p void ITT_FORMAT p void ITT_FORMAT p void size_t ITT_FORMAT d void ITT_FORMAT p const wchar_t ITT_FORMAT s const char ITT_FORMAT s const char ITT_FORMAT s const char ITT_FORMAT s no args void ITT_FORMAT p size_t ITT_FORMAT d no args const wchar_t const wchar_t ITT_FORMAT s __itt_heap_function void size_t int ITT_FORMAT d __itt_heap_function void ITT_FORMAT p __itt_heap_function void void size_t int ITT_FORMAT d no args no args unsigned int ITT_FORMAT u const __itt_domain __itt_id ITT_FORMAT lu const __itt_domain __itt_id __itt_id __itt_string_handle ITT_FORMAT p const __itt_domain __itt_id ITT_FORMAT p const __itt_domain __itt_id __itt_timestamp __itt_timestamp ITT_FORMAT lu const __itt_domain __itt_id __itt_id __itt_string_handle ITT_FORMAT p const __itt_domain ITT_FORMAT p const __itt_domain __itt_string_handle unsigned long long value
The graph class.
Parallel iteration over a stream, with optional addition of more work.
void run(Stream &stream, const Body &body)
Apply body.apply to each item in the stream.
const Body * my_body
parallel_while()
Construct empty non-running parallel while.
Body::argument_type value_type
Type of items.
void add(const value_type &item)
Add a work item while running.
empty_task * my_barrier
~parallel_while()
Destructor cleans up data members before returning.
For internal use only.
task * execute() __TBB_override
Should be overridden by derived classes.
while_iteration_task(const typename Body::argument_type &value, const Body &body)
task * execute() __TBB_override
Should be overridden by derived classes.
For internal use only.
task * execute() __TBB_override
Should be overridden by derived classes.
static const size_t max_arg_size
while_group_task(const Body &body)
Body::argument_type my_arg[max_arg_size]
Base class for user-defined tasks.
Definition: task.h:615
internal::allocate_child_proxy & allocate_child()
Returns proxy for overloaded new that allocates a child task of *this.
Definition: task.h:681
void recycle_to_reexecute()
Schedule this for reexecution after current execute() returns.
Definition: task.h:741
static task &__TBB_EXPORTED_FUNC self()
The innermost task being executed or destroyed by the current thread at the moment.
Definition: task.cpp:201
void spawn_and_wait_for_all(task &child)
Similar to spawn followed by wait_for_all, but more efficient.
Definition: task.h:800
static internal::allocate_root_proxy allocate_root()
Returns proxy for overloaded new that allocates a root task.
Definition: task.h:663
void set_ref_count(int count)
Set reference count.
Definition: task.h:761
task that does nothing. Useful for synchronization.
Definition: task.h:1042
A list of children.
Definition: task.h:1077
void push_back(task &task)
Push task onto back of list.
Definition: task.h:1094
Base class for types that should not be copied or assigned.
Definition: tbb_stddef.h:330

Copyright © 2005-2020 Intel Corporation. All Rights Reserved.

Intel, Pentium, Intel Xeon, Itanium, Intel XScale and VTune are registered trademarks or trademarks of Intel Corporation or its subsidiaries in the United States and other countries.

* Other names and brands may be claimed as the property of others.