5c2aadcf4ec6ab3182c8099c2dc51923511a3a15
[blender.git] / intern / cycles / kernel / split / kernel_split_data_types.h
1 /*
2  * Copyright 2011-2016 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 #ifndef __KERNEL_SPLIT_DATA_TYPES_H__
18 #define __KERNEL_SPLIT_DATA_TYPES_H__
19
20 CCL_NAMESPACE_BEGIN
21
22 /* parameters used by the split kernels, we use a single struct to avoid passing these to each kernel */
23
24 typedef struct SplitParams {
25         WorkTile tile;
26         uint total_work_size;
27
28         ccl_global unsigned int *work_pools;
29
30         ccl_global int *queue_index;
31         int queue_size;
32         ccl_global char *use_queues_flag;
33
34         /* Place for storing sd->flag. AMD GPU OpenCL compiler workaround */
35         int dummy_sd_flag;
36 } SplitParams;
37
38 /* Global memory variables [porting]; These memory is used for
39  * co-operation between different kernels; Data written by one
40  * kernel will be available to another kernel via this global
41  * memory.
42  */
43
44 /* SPLIT_DATA_ENTRY(type, name, num) */
45
46 #ifdef __BRANCHED_PATH__
47
48 typedef ccl_global struct SplitBranchedState {
49         /* various state that must be kept and restored after an indirect loop */
50         PathState path_state;
51         float3 throughput;
52         Ray ray;
53
54         struct ShaderData sd;
55         Intersection isect;
56
57         char ray_state;
58
59         /* indirect loop state */
60         int next_closure;
61         int next_sample;
62
63 #ifdef __SUBSURFACE__
64         int ss_next_closure;
65         int ss_next_sample;
66         int next_hit;
67         int num_hits;
68
69         uint lcg_state;
70         LocalIntersection ss_isect;
71
72 #  ifdef __VOLUME__
73         VolumeStack volume_stack[VOLUME_STACK_SIZE];
74 #  endif  /* __VOLUME__ */
75 #endif  /*__SUBSURFACE__ */
76
77         int shared_sample_count; /* number of branched samples shared with other threads */
78         int original_ray; /* index of original ray when sharing branched samples */
79         bool waiting_on_shared_samples;
80 } SplitBranchedState;
81
82 #define SPLIT_DATA_BRANCHED_ENTRIES \
83         SPLIT_DATA_ENTRY( SplitBranchedState, branched_state, 1)
84 #else
85 #define SPLIT_DATA_BRANCHED_ENTRIES
86 #endif  /* __BRANCHED_PATH__ */
87
88 #ifdef __SUBSURFACE__
89 #  define SPLIT_DATA_SUBSURFACE_ENTRIES \
90         SPLIT_DATA_ENTRY(ccl_global SubsurfaceIndirectRays, ss_rays, 1)
91 #else
92 #  define SPLIT_DATA_SUBSURFACE_ENTRIES
93 #endif /* __SUBSURFACE__ */
94
95 #ifdef __VOLUME__
96 #  define SPLIT_DATA_VOLUME_ENTRIES \
97         SPLIT_DATA_ENTRY(ccl_global PathState, state_shadow, 1)
98 #else
99 #  define SPLIT_DATA_VOLUME_ENTRIES
100 #endif /* __VOLUME__ */
101
102 #define SPLIT_DATA_ENTRIES \
103         SPLIT_DATA_ENTRY(ccl_global float3, throughput, 1) \
104         SPLIT_DATA_ENTRY(PathRadiance, path_radiance, 1) \
105         SPLIT_DATA_ENTRY(ccl_global Ray, ray, 1) \
106         SPLIT_DATA_ENTRY(ccl_global PathState, path_state, 1) \
107         SPLIT_DATA_ENTRY(ccl_global Intersection, isect, 1) \
108         SPLIT_DATA_ENTRY(ccl_global BsdfEval, bsdf_eval, 1) \
109         SPLIT_DATA_ENTRY(ccl_global int, is_lamp, 1) \
110         SPLIT_DATA_ENTRY(ccl_global Ray, light_ray, 1) \
111         SPLIT_DATA_ENTRY(ccl_global int, queue_data, (NUM_QUEUES*2)) /* TODO(mai): this is too large? */ \
112         SPLIT_DATA_ENTRY(ccl_global uint, buffer_offset, 1) \
113         SPLIT_DATA_ENTRY(ShaderData, sd, 1) \
114         SPLIT_DATA_ENTRY(ShaderDataTinyStorage, sd_DL_shadow, 1) \
115         SPLIT_DATA_SUBSURFACE_ENTRIES \
116         SPLIT_DATA_VOLUME_ENTRIES \
117         SPLIT_DATA_BRANCHED_ENTRIES \
118
119 /* entries to be copied to inactive rays when sharing branched samples (TODO: which are actually needed?) */
120 #define SPLIT_DATA_ENTRIES_BRANCHED_SHARED \
121         SPLIT_DATA_ENTRY(ccl_global float3, throughput, 1) \
122         SPLIT_DATA_ENTRY(PathRadiance, path_radiance, 1) \
123         SPLIT_DATA_ENTRY(ccl_global Ray, ray, 1) \
124         SPLIT_DATA_ENTRY(ccl_global PathState, path_state, 1) \
125         SPLIT_DATA_ENTRY(ccl_global Intersection, isect, 1) \
126         SPLIT_DATA_ENTRY(ccl_global BsdfEval, bsdf_eval, 1) \
127         SPLIT_DATA_ENTRY(ccl_global int, is_lamp, 1) \
128         SPLIT_DATA_ENTRY(ccl_global Ray, light_ray, 1) \
129         SPLIT_DATA_ENTRY(ShaderData, sd, 1) \
130         SPLIT_DATA_ENTRY(ShaderDataTinyStorage, sd_DL_shadow, 1) \
131         SPLIT_DATA_SUBSURFACE_ENTRIES \
132         SPLIT_DATA_VOLUME_ENTRIES \
133         SPLIT_DATA_BRANCHED_ENTRIES \
134
135 /* struct that holds pointers to data in the shared state buffer */
136 typedef struct SplitData {
137 #define SPLIT_DATA_ENTRY(type, name, num) type *name;
138         SPLIT_DATA_ENTRIES
139 #undef SPLIT_DATA_ENTRY
140
141         /* this is actually in a separate buffer from the rest of the split state data (so it can be read back from
142          * the host easily) but is still used the same as the other data so we have it here in this struct as well
143          */
144         ccl_global char *ray_state;
145 } SplitData;
146
147 #ifndef __KERNEL_CUDA__
148 #  define kernel_split_state (kg->split_data)
149 #  define kernel_split_params (kg->split_param_data)
150 #else
151 __device__ SplitData __split_data;
152 #  define kernel_split_state (__split_data)
153 __device__ SplitParams __split_param_data;
154 #  define kernel_split_params (__split_param_data)
155 #endif  /* __KERNEL_CUDA__ */
156
157 /* Local storage for queue_enqueue kernel. */
158 typedef struct QueueEnqueueLocals {
159         uint queue_atomics[2];
160 } QueueEnqueueLocals;
161
162 /* Local storage for holdout_emission_blurring_pathtermination_ao kernel. */
163 typedef struct BackgroundAOLocals {
164         uint queue_atomics_bg;
165         uint queue_atomics_ao;
166 } BackgroundAOLocals;
167
168 typedef struct ShaderSortLocals {
169         uint local_value[SHADER_SORT_BLOCK_SIZE];
170         ushort local_index[SHADER_SORT_BLOCK_SIZE];
171 } ShaderSortLocals;
172
173 CCL_NAMESPACE_END
174
175 #endif  /* __KERNEL_SPLIT_DATA_TYPES_H__ */