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