glsl2: Fix spelling of "sentinel."
[profile/ivi/mesa.git] / src / glsl / ir_clone.cpp
1 /*
2  * Copyright © 2010 Intel Corporation
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice (including the next
12  * paragraph) shall be included in all copies or substantial portions of the
13  * Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21  * DEALINGS IN THE SOFTWARE.
22  */
23
24 #include <string.h>
25 #include "ir.h"
26 #include "glsl_types.h"
27 extern "C" {
28 #include "hash_table.h"
29 }
30
31 /**
32  * Duplicate an IR variable
33  *
34  * \note
35  * This will probably be made \c virtual and moved to the base class
36  * eventually.
37  */
38 ir_variable *
39 ir_variable::clone(struct hash_table *ht) const
40 {
41    void *ctx = talloc_parent(this);
42    ir_variable *var = new(ctx) ir_variable(this->type, this->name,
43                                            (ir_variable_mode) this->mode);
44
45    var->max_array_access = this->max_array_access;
46    var->read_only = this->read_only;
47    var->centroid = this->centroid;
48    var->invariant = this->invariant;
49    var->shader_in = this->shader_in;
50    var->shader_out = this->shader_out;
51    var->interpolation = this->interpolation;
52    var->array_lvalue = this->array_lvalue;
53    var->location = this->location;
54    var->warn_extension = this->warn_extension;
55    var->origin_upper_left = this->origin_upper_left;
56    var->pixel_center_integer = this->pixel_center_integer;
57
58    if (this->constant_value)
59       var->constant_value = this->constant_value->clone(ht);
60
61    if (ht) {
62       hash_table_insert(ht, var, (void *)const_cast<ir_variable *>(this));
63    }
64
65    return var;
66 }
67
68 ir_swizzle *
69 ir_swizzle::clone(struct hash_table *ht) const
70 {
71    void *ctx = talloc_parent(this);
72    return new(ctx) ir_swizzle(this->val->clone(ht), this->mask);
73 }
74
75 ir_return *
76 ir_return::clone(struct hash_table *ht) const
77 {
78    void *ctx = talloc_parent(this);
79    ir_rvalue *new_value = NULL;
80
81    if (this->value)
82       new_value = this->value->clone(ht);
83
84    return new(ctx) ir_return(new_value);
85 }
86
87 ir_discard *
88 ir_discard::clone(struct hash_table *ht) const
89 {
90    void *ctx = talloc_parent(this);
91    ir_rvalue *new_condition = NULL;
92
93    if (this->condition != NULL)
94       new_condition = this->condition->clone(ht);
95
96    return new(ctx) ir_discard(new_condition);
97 }
98
99 ir_loop_jump *
100 ir_loop_jump::clone(struct hash_table *ht) const
101 {
102    void *ctx = talloc_parent(this);
103    (void)ht;
104
105    return new(ctx) ir_loop_jump(this->mode);
106 }
107
108 ir_if *
109 ir_if::clone(struct hash_table *ht) const
110 {
111    void *ctx = talloc_parent(this);
112    ir_if *new_if = new(ctx) ir_if(this->condition->clone(ht));
113
114    foreach_iter(exec_list_iterator, iter, this->then_instructions) {
115       ir_instruction *ir = (ir_instruction *)iter.get();
116       new_if->then_instructions.push_tail(ir->clone(ht));
117    }
118
119    foreach_iter(exec_list_iterator, iter, this->else_instructions) {
120       ir_instruction *ir = (ir_instruction *)iter.get();
121       new_if->else_instructions.push_tail(ir->clone(ht));
122    }
123
124    return new_if;
125 }
126
127 ir_loop *
128 ir_loop::clone(struct hash_table *ht) const
129 {
130    void *ctx = talloc_parent(this);
131    ir_loop *new_loop = new(ctx) ir_loop();
132
133    if (this->from)
134       new_loop->from = this->from->clone(ht);
135    if (this->to)
136       new_loop->to = this->to->clone(ht);
137    if (this->increment)
138       new_loop->increment = this->increment->clone(ht);
139    new_loop->counter = counter;
140
141    foreach_iter(exec_list_iterator, iter, this->body_instructions) {
142       ir_instruction *ir = (ir_instruction *)iter.get();
143       new_loop->body_instructions.push_tail(ir->clone(ht));
144    }
145
146    return new_loop;
147 }
148
149 ir_call *
150 ir_call::clone(struct hash_table *ht) const
151 {
152    void *ctx = talloc_parent(this);
153    exec_list new_parameters;
154
155    foreach_iter(exec_list_iterator, iter, this->actual_parameters) {
156       ir_instruction *ir = (ir_instruction *)iter.get();
157       new_parameters.push_tail(ir->clone(ht));
158    }
159
160    return new(ctx) ir_call(this->callee, &new_parameters);
161 }
162
163 ir_expression *
164 ir_expression::clone(struct hash_table *ht) const
165 {
166    void *ctx = talloc_parent(this);
167    ir_rvalue *op[2] = {NULL, NULL};
168    unsigned int i;
169
170    for (i = 0; i < get_num_operands(); i++) {
171       op[i] = this->operands[i]->clone(ht);
172    }
173
174    return new(ctx) ir_expression(this->operation, this->type, op[0], op[1]);
175 }
176
177 ir_dereference_variable *
178 ir_dereference_variable::clone(struct hash_table *ht) const
179 {
180    void *ctx = talloc_parent(this);
181    ir_variable *new_var;
182
183    if (ht) {
184       new_var = (ir_variable *)hash_table_find(ht, this->var);
185       if (!new_var)
186          new_var = this->var;
187    } else {
188       new_var = this->var;
189    }
190
191    return new(ctx) ir_dereference_variable(new_var);
192 }
193
194 ir_dereference_array *
195 ir_dereference_array::clone(struct hash_table *ht) const
196 {
197    void *ctx = talloc_parent(this);
198    return new(ctx) ir_dereference_array(this->array->clone(ht),
199                                         this->array_index->clone(ht));
200 }
201
202 ir_dereference_record *
203 ir_dereference_record::clone(struct hash_table *ht) const
204 {
205    void *ctx = talloc_parent(this);
206    return new(ctx) ir_dereference_record(this->record->clone(ht),
207                                          this->field);
208 }
209
210 ir_texture *
211 ir_texture::clone(struct hash_table *ht) const
212 {
213    void *ctx = talloc_parent(this);
214    ir_texture *new_tex = new(ctx) ir_texture(this->op);
215    new_tex->type = this->type;
216
217    new_tex->sampler = this->sampler->clone(ht);
218    new_tex->coordinate = this->coordinate->clone(ht);
219    if (this->projector)
220       new_tex->projector = this->projector->clone(ht);
221    if (this->shadow_comparitor) {
222       new_tex->shadow_comparitor = this->shadow_comparitor->clone(ht);
223    }
224
225    for (int i = 0; i < 3; i++)
226       new_tex->offsets[i] = this->offsets[i];
227
228    switch (this->op) {
229    case ir_tex:
230       break;
231    case ir_txb:
232       new_tex->lod_info.bias = this->lod_info.bias->clone(ht);
233       break;
234    case ir_txl:
235    case ir_txf:
236       new_tex->lod_info.lod = this->lod_info.lod->clone(ht);
237       break;
238    case ir_txd:
239       new_tex->lod_info.grad.dPdx = this->lod_info.grad.dPdx->clone(ht);
240       new_tex->lod_info.grad.dPdy = this->lod_info.grad.dPdy->clone(ht);
241       break;
242    }
243
244    return new_tex;
245 }
246
247 ir_assignment *
248 ir_assignment::clone(struct hash_table *ht) const
249 {
250    ir_rvalue *new_condition = NULL;
251
252    if (this->condition)
253       new_condition = this->condition->clone(ht);
254
255    void *ctx = talloc_parent(this);
256    return new(ctx) ir_assignment(this->lhs->clone(ht),
257                                  this->rhs->clone(ht),
258                                  new_condition);
259 }
260
261 ir_function *
262 ir_function::clone(struct hash_table *ht) const
263 {
264    void *mem_ctx = talloc_parent(this);
265    ir_function *copy = new(mem_ctx) ir_function(this->name);
266
267    foreach_list_const(node, &this->signatures) {
268       const ir_function_signature *const sig =
269          (const ir_function_signature *const) node;
270
271       ir_function_signature *sig_copy = sig->clone(ht);
272       copy->add_signature(sig_copy);
273
274       if (ht != NULL)
275          hash_table_insert(ht, sig_copy,
276                            (void *)const_cast<ir_function_signature *>(sig));
277    }
278
279    return copy;
280 }
281
282 ir_function_signature *
283 ir_function_signature::clone(struct hash_table *ht) const
284 {
285    void *mem_ctx = talloc_parent(this);
286    ir_function_signature *copy =
287       new(mem_ctx) ir_function_signature(this->return_type);
288
289    copy->is_defined = this->is_defined;
290    copy->is_built_in = this->is_built_in;
291
292    /* Clone the parameter list.
293     */
294    foreach_list_const(node, &this->parameters) {
295       const ir_variable *const param = (const ir_variable *) node;
296
297       assert(const_cast<ir_variable *>(param)->as_variable() != NULL);
298
299       ir_variable *const param_copy = param->clone(ht);
300       copy->parameters.push_tail(param_copy);
301    }
302
303    /* Clone the instruction list.
304     */
305    foreach_list_const(node, &this->body) {
306       const ir_instruction *const inst = (const ir_instruction *) node;
307
308       ir_instruction *const inst_copy = inst->clone(ht);
309       copy->body.push_tail(inst_copy);
310    }
311
312    return copy;
313 }
314
315 ir_constant *
316 ir_constant::clone(struct hash_table *ht) const
317 {
318    void *ctx = talloc_parent(this);
319    (void)ht;
320
321    switch (this->type->base_type) {
322    case GLSL_TYPE_UINT:
323    case GLSL_TYPE_INT:
324    case GLSL_TYPE_FLOAT:
325    case GLSL_TYPE_BOOL:
326       return new(ctx) ir_constant(this->type, &this->value);
327
328    case GLSL_TYPE_STRUCT: {
329       ir_constant *c = new(ctx) ir_constant;
330
331       c->type = this->type;
332       for (exec_node *node = this->components.head
333               ; !node->is_tail_sentinel()
334               ; node = node->next) {
335          ir_constant *const orig = (ir_constant *) node;
336
337          c->components.push_tail(orig->clone(NULL));
338       }
339
340       return c;
341    }
342
343    case GLSL_TYPE_ARRAY: {
344       ir_constant *c = new(ctx) ir_constant;
345
346       c->type = this->type;
347       c->array_elements = talloc_array(c, ir_constant *, this->type->length);
348       for (unsigned i = 0; i < this->type->length; i++) {
349          c->array_elements[i] = this->array_elements[i]->clone(NULL);
350       }
351       return c;
352    }
353
354    default:
355       assert(!"Should not get here."); break;
356       return NULL;
357    }
358 }
359
360
361 class fixup_ir_call_visitor : public ir_hierarchical_visitor {
362 public:
363    fixup_ir_call_visitor(struct hash_table *ht)
364    {
365       this->ht = ht;
366    }
367
368    virtual ir_visitor_status visit_enter(ir_call *ir)
369    {
370       /* Try to find the function signature referenced by the ir_call in the
371        * table.  If it is found, replace it with the value from the table.
372        */
373       ir_function_signature *sig =
374          (ir_function_signature *) hash_table_find(this->ht, ir->get_callee());
375       if (sig != NULL)
376          ir->set_callee(sig);
377
378       /* Since this may be used before function call parameters are flattened,
379        * the children also need to be processed.
380        */
381       return visit_continue;
382    }
383
384 private:
385    struct hash_table *ht;
386 };
387
388
389 static void
390 fixup_function_calls(struct hash_table *ht, exec_list *instructions)
391 {
392    fixup_ir_call_visitor v(ht);
393    v.run(instructions);
394 }
395
396
397 void
398 clone_ir_list(exec_list *out, const exec_list *in)
399 {
400    struct hash_table *ht =
401       hash_table_ctor(0, hash_table_pointer_hash, hash_table_pointer_compare);
402
403    foreach_list_const(node, in) {
404       const ir_instruction *const original = (ir_instruction *) node;
405       ir_instruction *copy = original->clone(ht);
406
407       out->push_tail(copy);
408    }
409
410    /* Make a pass over the cloned tree to fix up ir_call nodes to point to the
411     * cloned ir_function_signature nodes.  This cannot be done automatically
412     * during cloning because the ir_call might be a forward reference (i.e.,
413     * the function signature that it references may not have been cloned yet).
414     */
415    fixup_function_calls(ht, out);
416
417    hash_table_dtor(ht);
418 }