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