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 "main/compiler.h"
  26 #include "ir.h"
  27 #include "glsl_types.h"
  28 #include "program/hash_table.h"
  29
  30 /**
  31  * Duplicate an IR variable
  32  *
  33  * \note
  34  * This will probably be made \c virtual and moved to the base class
  35  * eventually.
  36  */
  37 ir_variable *
  38 ir_variable::clone(void *mem_ctx, struct hash_table *ht) const
  39 {
  40    ir_variable *var = new(mem_ctx) ir_variable(this->type, this->name,
  41                                                (ir_variable_mode) this->mode);
  42
  43    var->max_array_access = this->max_array_access;
  44    var->read_only = this->read_only;
  45    var->centroid = this->centroid;
  46    var->invariant = this->invariant;
  47    var->interpolation = this->interpolation;
  48    var->location = this->location;
  49    var->warn_extension = this->warn_extension;
  50    var->origin_upper_left = this->origin_upper_left;
  51    var->pixel_center_integer = this->pixel_center_integer;
  52    var->explicit_location = this->explicit_location;
  53    var->has_initializer = this->has_initializer;
  54    var->depth_layout = this->depth_layout;
  55
  56    var->num_state_slots = this->num_state_slots;
  57    if (this->state_slots) {
  58       /* FINISHME: This really wants to use something like talloc_reference, but
  59        * FINISHME: ralloc doesn't have any similar function.
  60        */
  61       var->state_slots = ralloc_array(var, ir_state_slot,
  62                                       this->num_state_slots);
  63       memcpy(var->state_slots, this->state_slots,
  64              sizeof(this->state_slots[0]) * var->num_state_slots);
  65    }
  66
  67    if (this->explicit_location)
  68       var->location = this->location;
  69
  70    if (this->constant_value)
  71       var->constant_value = this->constant_value->clone(mem_ctx, ht);
  72
  73    if (this->constant_initializer)
  74       var->constant_initializer =
  75          this->constant_initializer->clone(mem_ctx, ht);
  76
  77    if (ht) {
  78       hash_table_insert(ht, var, (void *)const_cast<ir_variable *>(this));
  79    }
  80
  81    return var;
  82 }
  83
  84 ir_swizzle *
  85 ir_swizzle::clone(void *mem_ctx, struct hash_table *ht) const
  86 {
  87    return new(mem_ctx) ir_swizzle(this->val->clone(mem_ctx, ht), this->mask);
  88 }
  89
  90 ir_return *
  91 ir_return::clone(void *mem_ctx, struct hash_table *ht) const
  92 {
  93    ir_rvalue *new_value = NULL;
  94
  95    if (this->value)
  96       new_value = this->value->clone(mem_ctx, ht);
  97
  98    return new(mem_ctx) ir_return(new_value);
  99 }
 100
 101 ir_discard *
 102 ir_discard::clone(void *mem_ctx, struct hash_table *ht) const
 103 {
 104    ir_rvalue *new_condition = NULL;
 105
 106    if (this->condition != NULL)
 107       new_condition = this->condition->clone(mem_ctx, ht);
 108
 109    return new(mem_ctx) ir_discard(new_condition);
 110 }
 111
 112 ir_loop_jump *
 113 ir_loop_jump::clone(void *mem_ctx, struct hash_table *ht) const
 114 {
 115    (void)ht;
 116
 117    return new(mem_ctx) ir_loop_jump(this->mode);
 118 }
 119
 120 ir_if *
 121 ir_if::clone(void *mem_ctx, struct hash_table *ht) const
 122 {
 123    ir_if *new_if = new(mem_ctx) ir_if(this->condition->clone(mem_ctx, ht));
 124
 125    foreach_iter(exec_list_iterator, iter, this->then_instructions) {
 126       ir_instruction *ir = (ir_instruction *)iter.get();
 127       new_if->then_instructions.push_tail(ir->clone(mem_ctx, ht));
 128    }
 129
 130    foreach_iter(exec_list_iterator, iter, this->else_instructions) {
 131       ir_instruction *ir = (ir_instruction *)iter.get();
 132       new_if->else_instructions.push_tail(ir->clone(mem_ctx, ht));
 133    }
 134
 135    return new_if;
 136 }
 137
 138 ir_loop *
 139 ir_loop::clone(void *mem_ctx, struct hash_table *ht) const
 140 {
 141    ir_loop *new_loop = new(mem_ctx) ir_loop();
 142
 143    if (this->from)
 144       new_loop->from = this->from->clone(mem_ctx, ht);
 145    if (this->to)
 146       new_loop->to = this->to->clone(mem_ctx, ht);
 147    if (this->increment)
 148       new_loop->increment = this->increment->clone(mem_ctx, ht);
 149    new_loop->counter = counter;
 150
 151    foreach_iter(exec_list_iterator, iter, this->body_instructions) {
 152       ir_instruction *ir = (ir_instruction *)iter.get();
 153       new_loop->body_instructions.push_tail(ir->clone(mem_ctx, ht));
 154    }
 155
 156    new_loop->cmp = this->cmp;
 157    return new_loop;
 158 }
 159
 160 ir_call *
 161 ir_call::clone(void *mem_ctx, struct hash_table *ht) const
 162 {
 163    if (this->type == glsl_type::error_type)
 164       return ir_call::get_error_instruction(mem_ctx);
 165
 166    exec_list new_parameters;
 167
 168    foreach_iter(exec_list_iterator, iter, this->actual_parameters) {
 169       ir_instruction *ir = (ir_instruction *)iter.get();
 170       new_parameters.push_tail(ir->clone(mem_ctx, ht));
 171    }
 172
 173    return new(mem_ctx) ir_call(this->callee, &new_parameters);
 174 }
 175
 176 ir_expression *
 177 ir_expression::clone(void *mem_ctx, struct hash_table *ht) const
 178 {
 179    ir_rvalue *op[Elements(this->operands)] = { NULL, };
 180    unsigned int i;
 181
 182    for (i = 0; i < get_num_operands(); i++) {
 183       op[i] = this->operands[i]->clone(mem_ctx, ht);
 184    }
 185
 186    return new(mem_ctx) ir_expression(this->operation, this->type,
 187                                      op[0], op[1], op[2], op[3]);
 188 }
 189
 190 ir_dereference_variable *
 191 ir_dereference_variable::clone(void *mem_ctx, struct hash_table *ht) const
 192 {
 193    ir_variable *new_var;
 194
 195    if (ht) {
 196       new_var = (ir_variable *)hash_table_find(ht, this->var);
 197       if (!new_var)
 198          new_var = this->var;
 199    } else {
 200       new_var = this->var;
 201    }
 202
 203    return new(mem_ctx) ir_dereference_variable(new_var);
 204 }
 205
 206 ir_dereference_array *
 207 ir_dereference_array::clone(void *mem_ctx, struct hash_table *ht) const
 208 {
 209    return new(mem_ctx) ir_dereference_array(this->array->clone(mem_ctx, ht),
 210                                             this->array_index->clone(mem_ctx,
 211                                                                      ht));
 212 }
 213
 214 ir_dereference_record *
 215 ir_dereference_record::clone(void *mem_ctx, struct hash_table *ht) const
 216 {
 217    return new(mem_ctx) ir_dereference_record(this->record->clone(mem_ctx, ht),
 218                                              this->field);
 219 }
 220
 221 ir_texture *
 222 ir_texture::clone(void *mem_ctx, struct hash_table *ht) const
 223 {
 224    ir_texture *new_tex = new(mem_ctx) ir_texture(this->op);
 225    new_tex->type = this->type;
 226
 227    new_tex->sampler = this->sampler->clone(mem_ctx, ht);
 228    if (this->coordinate)
 229       new_tex->coordinate = this->coordinate->clone(mem_ctx, ht);
 230    if (this->projector)
 231       new_tex->projector = this->projector->clone(mem_ctx, ht);
 232    if (this->shadow_comparitor) {
 233       new_tex->shadow_comparitor = this->shadow_comparitor->clone(mem_ctx, ht);
 234    }
 235
 236    if (this->offset != NULL)
 237       new_tex->offset = this->offset->clone(mem_ctx, ht);
 238
 239    switch (this->op) {
 240    case ir_tex:
 241       break;
 242    case ir_txb:
 243       new_tex->lod_info.bias = this->lod_info.bias->clone(mem_ctx, ht);
 244       break;
 245    case ir_txl:
 246    case ir_txf:
 247    case ir_txs:
 248       new_tex->lod_info.lod = this->lod_info.lod->clone(mem_ctx, ht);
 249       break;
 250    case ir_txd:
 251       new_tex->lod_info.grad.dPdx = this->lod_info.grad.dPdx->clone(mem_ctx, ht);
 252       new_tex->lod_info.grad.dPdy = this->lod_info.grad.dPdy->clone(mem_ctx, ht);
 253       break;
 254    }
 255
 256    return new_tex;
 257 }
 258
 259 ir_assignment *
 260 ir_assignment::clone(void *mem_ctx, struct hash_table *ht) const
 261 {
 262    ir_rvalue *new_condition = NULL;
 263
 264    if (this->condition)
 265       new_condition = this->condition->clone(mem_ctx, ht);
 266
 267    return new(mem_ctx) ir_assignment(this->lhs->clone(mem_ctx, ht),
 268                                      this->rhs->clone(mem_ctx, ht),
 269                                      new_condition,
 270                                      this->write_mask);
 271 }
 272
 273 ir_function *
 274 ir_function::clone(void *mem_ctx, struct hash_table *ht) const
 275 {
 276    ir_function *copy = new(mem_ctx) ir_function(this->name);
 277
 278    foreach_list_const(node, &this->signatures) {
 279       const ir_function_signature *const sig =
 280          (const ir_function_signature *const) node;
 281
 282       ir_function_signature *sig_copy = sig->clone(mem_ctx, ht);
 283       copy->add_signature(sig_copy);
 284
 285       if (ht != NULL)
 286          hash_table_insert(ht, sig_copy,
 287                            (void *)const_cast<ir_function_signature *>(sig));
 288    }
 289
 290    return copy;
 291 }
 292
 293 ir_function_signature *
 294 ir_function_signature::clone(void *mem_ctx, struct hash_table *ht) const
 295 {
 296    ir_function_signature *copy = this->clone_prototype(mem_ctx, ht);
 297
 298    copy->is_defined = this->is_defined;
 299
 300    /* Clone the instruction list.
 301     */
 302    foreach_list_const(node, &this->body) {
 303       const ir_instruction *const inst = (const ir_instruction *) node;
 304
 305       ir_instruction *const inst_copy = inst->clone(mem_ctx, ht);
 306       copy->body.push_tail(inst_copy);
 307    }
 308
 309    return copy;
 310 }
 311
 312 ir_function_signature *
 313 ir_function_signature::clone_prototype(void *mem_ctx, struct hash_table *ht) const
 314 {
 315    ir_function_signature *copy =
 316       new(mem_ctx) ir_function_signature(this->return_type);
 317
 318    copy->is_defined = false;
 319    copy->is_builtin = this->is_builtin;
 320
 321    /* Clone the parameter list, but NOT the body.
 322     */
 323    foreach_list_const(node, &this->parameters) {
 324       const ir_variable *const param = (const ir_variable *) node;
 325
 326       assert(const_cast<ir_variable *>(param)->as_variable() != NULL);
 327
 328       ir_variable *const param_copy = param->clone(mem_ctx, ht);
 329       copy->parameters.push_tail(param_copy);
 330    }
 331
 332    return copy;
 333 }
 334
 335 ir_constant *
 336 ir_constant::clone(void *mem_ctx, struct hash_table *ht) const
 337 {
 338    (void)ht;
 339
 340    switch (this->type->base_type) {
 341    case GLSL_TYPE_UINT:
 342    case GLSL_TYPE_INT:
 343    case GLSL_TYPE_FLOAT:
 344    case GLSL_TYPE_BOOL:
 345       return new(mem_ctx) ir_constant(this->type, &this->value);
 346
 347    case GLSL_TYPE_STRUCT: {
 348       ir_constant *c = new(mem_ctx) ir_constant;
 349
 350       c->type = this->type;
 351       for (exec_node *node = this->components.head
 352               ; !node->is_tail_sentinel()
 353               ; node = node->next) {
 354          ir_constant *const orig = (ir_constant *) node;
 355
 356          c->components.push_tail(orig->clone(mem_ctx, NULL));
 357       }
 358
 359       return c;
 360    }
 361
 362    case GLSL_TYPE_ARRAY: {
 363       ir_constant *c = new(mem_ctx) ir_constant;
 364
 365       c->type = this->type;
 366       c->array_elements = ralloc_array(c, ir_constant *, this->type->length);
 367       for (unsigned i = 0; i < this->type->length; i++) {
 368          c->array_elements[i] = this->array_elements[i]->clone(mem_ctx, NULL);
 369       }
 370       return c;
 371    }
 372
 373    default:
 374       assert(!"Should not get here.");
 375       return NULL;
 376    }
 377 }
 378
 379
 380 class fixup_ir_call_visitor : public ir_hierarchical_visitor {
 381 public:
 382    fixup_ir_call_visitor(struct hash_table *ht)
 383    {
 384       this->ht = ht;
 385    }
 386
 387    virtual ir_visitor_status visit_enter(ir_call *ir)
 388    {
 389       /* Try to find the function signature referenced by the ir_call in the
 390        * table.  If it is found, replace it with the value from the table.
 391        */
 392       ir_function_signature *sig =
 393          (ir_function_signature *) hash_table_find(this->ht, ir->get_callee());
 394       if (sig != NULL)
 395          ir->set_callee(sig);
 396
 397       /* Since this may be used before function call parameters are flattened,
 398        * the children also need to be processed.
 399        */
 400       return visit_continue;
 401    }
 402
 403 private:
 404    struct hash_table *ht;
 405 };
 406
 407
 408 static void
 409 fixup_function_calls(struct hash_table *ht, exec_list *instructions)
 410 {
 411    fixup_ir_call_visitor v(ht);
 412    v.run(instructions);
 413 }
 414
 415
 416 void
 417 clone_ir_list(void *mem_ctx, exec_list *out, const exec_list *in)
 418 {
 419    struct hash_table *ht =
 420       hash_table_ctor(0, hash_table_pointer_hash, hash_table_pointer_compare);
 421
 422    foreach_list_const(node, in) {
 423       const ir_instruction *const original = (ir_instruction *) node;
 424       ir_instruction *copy = original->clone(mem_ctx, ht);
 425
 426       out->push_tail(copy);
 427    }
 428
 429    /* Make a pass over the cloned tree to fix up ir_call nodes to point to the
 430     * cloned ir_function_signature nodes.  This cannot be done automatically
 431     * during cloning because the ir_call might be a forward reference (i.e.,
 432     * the function signature that it references may not have been cloned yet).
 433     */
 434    fixup_function_calls(ht, out);
 435
 436    hash_table_dtor(ht);
 437 }