util: rename PIPE_ARCH_*_ENDIAN to UTIL_ARCH_*_ENDIAN
[mesa.git] / src / gallium / auxiliary / gallivm / lp_bld_flow.h
1 /**************************************************************************
2 *
3 * Copyright 2009 VMware, Inc.
4 * All Rights Reserved.
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the
8 * "Software"), to deal in the Software without restriction, including
9 * without limitation the rights to use, copy, modify, merge, publish,
10 * distribute, sub license, and/or sell copies of the Software, and to
11 * permit persons to whom the Software is furnished to do so, subject to
12 * the following conditions:
13 *
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
16 * of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
21 * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR
22 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
23 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
24 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
25 *
26 **************************************************************************/
27
28 /**
29 * LLVM control flow build helpers.
30 *
31 * @author Jose Fonseca <jfonseca@vmware.com>
32 */
33
34 #ifndef LP_BLD_FLOW_H
35 #define LP_BLD_FLOW_H
36
37
38 #include "gallivm/lp_bld.h"
39
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43
44 struct lp_type;
45
46
47 /**
48 * Early exit. Useful to skip to the end of a function or block when
49 * the execution mask becomes zero or when there is an error condition.
50 */
51 struct lp_build_skip_context
52 {
53 struct gallivm_state *gallivm;
54
55 /** Block to skip to */
56 LLVMBasicBlockRef block;
57 };
58
59 void
60 lp_build_flow_skip_begin(struct lp_build_skip_context *ctx,
61 struct gallivm_state *gallivm);
62
63 void
64 lp_build_flow_skip_cond_break(struct lp_build_skip_context *ctx,
65 LLVMValueRef cond);
66
67 void
68 lp_build_flow_skip_end(struct lp_build_skip_context *ctx);
69
70
71 struct lp_build_mask_context
72 {
73 struct lp_build_skip_context skip;
74
75 LLVMTypeRef reg_type;
76
77 LLVMValueRef var;
78 };
79
80
81 void
82 lp_build_mask_begin(struct lp_build_mask_context *mask,
83 struct gallivm_state *gallivm,
84 struct lp_type type,
85 LLVMValueRef value);
86
87 LLVMValueRef
88 lp_build_mask_value(struct lp_build_mask_context *mask);
89
90 /**
91 * Bitwise AND the mask with the given value, if a previous mask was set.
92 */
93 void
94 lp_build_mask_update(struct lp_build_mask_context *mask,
95 LLVMValueRef value);
96
97 void
98 lp_build_mask_check(struct lp_build_mask_context *mask);
99
100 LLVMValueRef
101 lp_build_mask_end(struct lp_build_mask_context *mask);
102
103
104 /**
105 * LLVM's IR doesn't represent for-loops directly. Furthermore it
106 * it requires creating code blocks, branches, phi variables, so it
107 * requires a fair amount of code.
108 *
109 * @sa http://www.llvm.org/docs/tutorial/LangImpl5.html#for
110 */
111 struct lp_build_loop_state
112 {
113 LLVMBasicBlockRef block;
114 LLVMValueRef counter_var;
115 LLVMValueRef counter;
116 struct gallivm_state *gallivm;
117 };
118
119
120 void
121 lp_build_loop_begin(struct lp_build_loop_state *state,
122 struct gallivm_state *gallivm,
123 LLVMValueRef start);
124
125 void
126 lp_build_loop_end(struct lp_build_loop_state *state,
127 LLVMValueRef end,
128 LLVMValueRef step);
129
130 void
131 lp_build_loop_force_set_counter(struct lp_build_loop_state *state,
132 LLVMValueRef end);
133
134 void
135 lp_build_loop_force_reload_counter(struct lp_build_loop_state *state);
136 void
137 lp_build_loop_end_cond(struct lp_build_loop_state *state,
138 LLVMValueRef end,
139 LLVMValueRef step,
140 LLVMIntPredicate cond);
141
142
143 /**
144 * Implementation of simple C-style for loops
145 */
146 struct lp_build_for_loop_state
147 {
148 LLVMBasicBlockRef begin;
149 LLVMBasicBlockRef body;
150 LLVMBasicBlockRef exit;
151 LLVMValueRef counter_var;
152 LLVMValueRef counter;
153 LLVMValueRef step;
154 LLVMIntPredicate cond;
155 LLVMValueRef end;
156 struct gallivm_state *gallivm;
157 };
158
159 void
160 lp_build_for_loop_begin(struct lp_build_for_loop_state *state,
161 struct gallivm_state *gallivm,
162 LLVMValueRef start,
163 LLVMIntPredicate llvm_cond,
164 LLVMValueRef end,
165 LLVMValueRef step);
166
167 void
168 lp_build_for_loop_end(struct lp_build_for_loop_state *state);
169
170
171 /**
172 * if/else/endif.
173 */
174 struct lp_build_if_state
175 {
176 struct gallivm_state *gallivm;
177 LLVMValueRef condition;
178 LLVMBasicBlockRef entry_block;
179 LLVMBasicBlockRef true_block;
180 LLVMBasicBlockRef false_block;
181 LLVMBasicBlockRef merge_block;
182 };
183
184
185 void
186 lp_build_if(struct lp_build_if_state *ctx,
187 struct gallivm_state *gallivm,
188 LLVMValueRef condition);
189
190 void
191 lp_build_else(struct lp_build_if_state *ctx);
192
193 void
194 lp_build_endif(struct lp_build_if_state *ctx);
195
196 LLVMBasicBlockRef
197 lp_build_insert_new_block(struct gallivm_state *gallivm, const char *name);
198
199 LLVMValueRef
200 lp_build_alloca(struct gallivm_state *gallivm,
201 LLVMTypeRef type,
202 const char *name);
203
204 LLVMValueRef
205 lp_build_alloca_undef(struct gallivm_state *gallivm,
206 LLVMTypeRef type,
207 const char *name);
208
209 LLVMValueRef
210 lp_build_array_alloca(struct gallivm_state *gallivm,
211 LLVMTypeRef type,
212 LLVMValueRef count,
213 const char *name);
214
215 #ifdef __cplusplus
216 }
217 #endif
218
219 #endif /* !LP_BLD_FLOW_H */