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