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