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