-
Notifications
You must be signed in to change notification settings - Fork 11
/
GCD+RBExtras.h
165 lines (144 loc) · 6.13 KB
/
GCD+RBExtras.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
//
// GCD+RBExtras.h
//
// Copyright (c) 2011 Robert Brown
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
//
#ifndef GCD_RBExtras_h
#define GCD_RBExtras_h
#include <dispatch/dispatch.h>
/// Deadlock warnings may be turned on/off by defining or not defining
/// DEADLOCK_WARNINGS. It's best to turn these warnings on in debug mode.
#if defined(DEADLOCK_WARNINGS)
/// Issues a warning when a synchronous method is called from the main queue.
/// Put this macro in your sychronous methods that are not safe for the main
/// queue. Intended for Objective-C.
#define DEADLOCK_SYNC_WARNING() \
if (dispatch_get_current_queue() == dispatch_get_main_queue()) \
NSLog(\
@"WARNING: Deadlock possible. "\
"Calling sychronous method from main queue in method: "\
"%@ file: %s line: %d.", \
NSStringFromSelector(_cmd), \
__FILE__, \
__LINE__);
/// Issues a warning when a synchronous method is called from the main queue.
/// Put this macro in your sychronous methods that are not safe for the main
/// queue. Intended for C or Objective-C.
#define DEADLOCK_SYNC_WARNING_C() \
if (dispatch_get_current_queue() == dispatch_get_main_queue()) \
NSLog(\
@"WARNING: Deadlock possible. "\
"Calling sychronous function from main queue in "\
"%@ file: %s line: %d.", \
__FILE__, \
__LINE__);
#else
#define DEADLOCK_SYNC_WARNING()
#define DEADLOCK_SYNC_WARNING_C()
#endif
/// Race condition warnings may be turned on/off by defining or not defining
/// RACE_CONDITION_WARNINGS. It's best to turn these warnings on in debug mode.
#if defined(RACE_CONDITION_WARNINGS)
/// Issues a warning when the current queue is not the given queue. Useful for
/// when you want to make sure a certain method is only run with the given
/// queue. Intended to be used with Objective-C.
/// q must be of type dispatch_queue_t.
#define RACE_CONDITION_WARNING(q) \
if (dispatch_get_current_queue() != q) \
NSLog(\
@"WARNING: Race condition possible. " \
"Running method from wrong queue in method: "\
"%@ file: %s line: %d. Expected queue: %s but running in: %s",\
NSStringFromSelector(_cmd), \
__FILE__, \
__LINE__, \
dispatch_queue_get_label(q), \
dispatch_queue_get_label(dispatch_get_current_queue()));
/// Issues a warning when the current queue is not the given queue. Useful for
/// when you want to make sure a certain method is only run with the given
/// queue. Intended to be used with Objective-C.
/// q must be of type dispatch_queue_t.
#define RACE_CONDITION_WARNING_C(q) \
if (dispatch_get_current_queue() != q) \
NSLog(\
@"WARNING: Race condition possible. " \
"Running method from wrong queue in method: "\
"%@ file: %s line: %d. Expected queue: %s but running in: %s",\
NSStringFromSelector(_cmd), \
__FILE__, \
__LINE__, \
dispatch_queue_get_label(q), \
dispatch_queue_get_label(dispatch_get_current_queue()));
/// Issues a warning when the current queue is not the main queue. Useful for
/// when you want to make sure a certain method is only run with the main queue.
/// Intended to be used with Objective-C.
#define RACE_CONDITION_WARNING_MAIN() RACE_CONDITION_WARNING(dispatch_get_main_queue())
/// Issues a warning when the current queue is not the main queue. Useful for
/// when you want to make sure a certain method is only run with the main queue.
/// Intended to be used with C or Objective-C.
#define RACE_CONDITION_WARNING_MAIN_C() RACE_CONDITION_WARNING_C(dispatch_get_main_queue())
#else
#define RACE_CONDITION_WARNING(q)
#define RACE_CONDITION_WARNING_C(q)
#define RACE_CONDITION_WARNING_MAIN()
#define RACE_CONDITION_WARNING_MAIN_C()
#endif
/// A convenient block type to use with dispatch_stride.
typedef void(^StrideBlock)(size_t idx);
/**
* Convenience method for asynchronously dispatching to the main queue.
*
* @param block The block to asynchrously dispatch. Must not be NULL.
*/
void dispatch_async_main(dispatch_block_t block);
/**
* Convenience method for asynchronously dispatching to the low priority queue.
*
* @param block The block to asynchrously dispatch. Must not be NULL.
*/
void dispatch_async_low(dispatch_block_t block);
/**
* Convenience method for asynchronously dispatching to the default priority
* queue.
*
* @param block The block to asynchrously dispatch. Must not be NULL.
*/
void dispatch_async_default(dispatch_block_t block);
/**
* Convenience method for asynchronously dispatching to the high priority queue.
*
* @param block The block to asynchrously dispatch. Must not be NULL.
*/
void dispatch_async_high(dispatch_block_t block);
/**
* Convenience method for using the striding pattern. Runs the given block on
* the given queue in parallel. The block will be run 'iterations' number of
* times and 'stride' number of iterations will run per thread.
*
* @param stride The number of times to run 'block' per thread.
* @param iterations The total number of times to run 'block'.
* @param queue The queue to run the block on. This must be a concurrent queue
* to take advantage of parallelization.
* @param block The block of code to run in parallel. Must be thread safe and
* independent of other iterations. Must not be NULL.
*/
void dispatch_stride(size_t stride, size_t iterations, dispatch_queue_t queue, StrideBlock block);
#endif // GCD_RBExtras_h