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