Code refactor: add WorkTile struct for passing work to kernel.
[blender-staging.git] / intern / cycles / kernel / split / kernel_data_init.h
1 /*
2  * Copyright 2011-2015 Blender Foundation
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 CCL_NAMESPACE_BEGIN
18
19 /* This kernel Initializes structures needed in path-iteration kernels.
20  *
21  * Note on Queues:
22  * All slots in queues are initialized to queue empty slot;
23  * The number of elements in the queues is initialized to 0;
24  */
25
26 /* Distributes an amount of work across all threads
27  * note: work done inside the loop may not show up to all threads till after
28  * the current kernel has completed
29  */
30 #define parallel_for(kg, iter_name, work_size) \
31         for(size_t _size = (work_size), \
32             _global_size = ccl_global_size(0) * ccl_global_size(1), \
33             _n = _size / _global_size, \
34                 _thread = ccl_global_id(0) + ccl_global_id(1) * ccl_global_size(0), \
35             iter_name = (_n > 0) ? (_thread * _n) : (_thread) \
36                 ; \
37                 (iter_name < (_thread+1) * _n) || (iter_name == _n * _global_size + _thread && _thread < _size % _global_size) \
38                 ; \
39                 iter_name = (iter_name != (_thread+1) * _n - 1) ? (iter_name + 1) : (_n * _global_size + _thread) \
40         )
41
42 #ifndef __KERNEL_CPU__
43 ccl_device void kernel_data_init(
44 #else
45 void KERNEL_FUNCTION_FULL_NAME(data_init)(
46 #endif
47         KernelGlobals *kg,
48         ccl_constant KernelData *data,
49         ccl_global void *split_data_buffer,
50         int num_elements,
51         ccl_global char *ray_state,
52         ccl_global uint *rng_state,
53
54 #ifdef __KERNEL_OPENCL__
55                 KERNEL_BUFFER_PARAMS,
56 #endif
57
58         int start_sample,
59         int end_sample,
60         int sx, int sy, int sw, int sh, int offset, int stride,
61         ccl_global int *Queue_index,                 /* Tracks the number of elements in queues */
62         int queuesize,                               /* size (capacity) of the queue */
63         ccl_global char *use_queues_flag,            /* flag to decide if scene-intersect kernel should use queues to fetch ray index */
64         ccl_global unsigned int *work_pools,      /* Work pool for each work group */
65         unsigned int num_samples,
66         ccl_global float *buffer)
67 {
68 #ifdef KERNEL_STUB
69         STUB_ASSERT(KERNEL_ARCH, data_init);
70 #else
71
72 #ifdef __KERNEL_OPENCL__
73         kg->data = data;
74 #endif
75
76         kernel_split_params.tile.x = sx;
77         kernel_split_params.tile.y = sy;
78         kernel_split_params.tile.w = sw;
79         kernel_split_params.tile.h = sh;
80
81         kernel_split_params.tile.start_sample = start_sample;
82         kernel_split_params.tile.num_samples = num_samples;
83
84         kernel_split_params.tile.offset = offset;
85         kernel_split_params.tile.stride = stride;
86
87         kernel_split_params.tile.rng_state = rng_state;
88         kernel_split_params.tile.buffer = buffer;
89
90         kernel_split_params.total_work_size = sw * sh * num_samples;
91
92         kernel_split_params.work_pools = work_pools;
93
94         kernel_split_params.queue_index = Queue_index;
95         kernel_split_params.queue_size = queuesize;
96         kernel_split_params.use_queues_flag = use_queues_flag;
97
98         split_data_init(kg, &kernel_split_state, num_elements, split_data_buffer, ray_state);
99
100 #ifdef __KERNEL_OPENCL__
101         kernel_set_buffer_pointers(kg, KERNEL_BUFFER_ARGS);
102         kernel_set_buffer_info(kg);
103 #endif
104
105         int thread_index = ccl_global_id(1) * ccl_global_size(0) + ccl_global_id(0);
106
107         /* Initialize queue data and queue index. */
108         if(thread_index < queuesize) {
109                 for(int i = 0; i < NUM_QUEUES; i++) {
110                         kernel_split_state.queue_data[i * queuesize + thread_index] = QUEUE_EMPTY_SLOT;
111                 }
112         }
113
114         if(thread_index == 0) {
115                 for(int i = 0; i < NUM_QUEUES; i++) {
116                         Queue_index[i] = 0;
117                 }
118
119                 /* The scene-intersect kernel should not use the queues very first time.
120                  * since the queue would be empty.
121                  */
122                 *use_queues_flag = 0;
123         }
124
125         /* zero the tiles pixels and initialize rng_state if this is the first sample */
126         if(start_sample == 0) {
127                 int pass_stride = kernel_data.film.pass_stride;
128
129 #ifdef __KERNEL_CPU__
130                 for(int y = sy; y < sy + sh; y++) {
131                         int index = offset + y * stride;
132                         memset(buffer + (sx + index) * pass_stride, 0, sizeof(float) * pass_stride * sw);
133                         for(int x = sx; x < sx + sw; x++) {
134                                 rng_state[index + x] = hash_int_2d(x, y);
135                         }
136                 }
137 #else
138                 parallel_for(kg, i, sw * sh * pass_stride) {
139                         int pixel = i / pass_stride;
140                         int pass = i % pass_stride;
141
142                         int x = sx + pixel % sw;
143                         int y = sy + pixel / sw;
144
145                         int index = (offset + x + y*stride) * pass_stride + pass;
146
147                         *(buffer + index) = 0.0f;
148                 }
149
150                 parallel_for(kg, i, sw * sh) {
151                         int x = sx + i % sw;
152                         int y = sy + i / sw;
153
154                         int index = (offset + x + y*stride);
155                         *(rng_state + index) = hash_int_2d(x, y);
156                 }
157 #endif
158         }
159
160 #endif  /* KERENL_STUB */
161 }
162
163 CCL_NAMESPACE_END