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  * \note
  41  * This will probably be made \c virtual and moved to the base class
  42  * eventually.
  43  */
  44 ir_variable *
  45 ir_variable::clone(void *mem_ctx, struct hash_table *ht) const
  46 {
  47    ir_variable *var = new(mem_ctx) ir_variable(this->type, this->name,
  48                                                (ir_variable_mode) this->mode);
  49
  50    var->max_array_access = this->max_array_access;
  51    var->read_only = this->read_only;
  52    var->centroid = this->centroid;
  53    var->invariant = this->invariant;
  54    var->interpolation = this->interpolation;
  55    var->location = this->location;
  56    var->warn_extension = this->warn_extension;
  57    var->origin_upper_left = this->origin_upper_left;
  58    var->pixel_center_integer = this->pixel_center_integer;
  59    var->explicit_location = this->explicit_location;
  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->explicit_location)
  75       var->location = this->location;
  76
  77    if (this->constant_value)
  78       var->constant_value = this->constant_value->clone(mem_ctx, ht);
  79
  80    if (this->constant_initializer)
  81       var->constant_initializer =
  82          this->constant_initializer->clone(mem_ctx, ht);
  83
  84    if (ht) {
  85       hash_table_insert(ht, var, (void *)const_cast<ir_variable *>(this));
  86    }
  87
  88    return var;
  89 }
  90
  91 ir_swizzle *
  92 ir_swizzle::clone(void *mem_ctx, struct hash_table *ht) const
  93 {
  94    return new(mem_ctx) ir_swizzle(this->val->clone(mem_ctx, ht), this->mask);
  95 }
  96
  97 ir_return *
  98 ir_return::clone(void *mem_ctx, struct hash_table *ht) const
  99 {
 100    ir_rvalue *new_value = NULL;
 101
 102    if (this->value)
 103       new_value = this->value->clone(mem_ctx, ht);
 104
 105    return new(mem_ctx) ir_return(new_value);
 106 }
 107
 108 ir_discard *
 109 ir_discard::clone(void *mem_ctx, struct hash_table *ht) const
 110 {
 111    ir_rvalue *new_condition = NULL;
 112
 113    if (this->condition != NULL)
 114       new_condition = this->condition->clone(mem_ctx, ht);
 115
 116    return new(mem_ctx) ir_discard(new_condition);
 117 }
 118
 119 ir_loop_jump *
 120 ir_loop_jump::clone(void *mem_ctx, struct hash_table *ht) const
 121 {
 122    (void)ht;
 123
 124    return new(mem_ctx) ir_loop_jump(this->mode);
 125 }
 126
 127 ir_if *
 128 ir_if::clone(void *mem_ctx, struct hash_table *ht) const
 129 {
 130    ir_if *new_if = new(mem_ctx) ir_if(this->condition->clone(mem_ctx, ht));
 131
 132    foreach_iter(exec_list_iterator, iter, this->then_instructions) {
 133       ir_instruction *ir = (ir_instruction *)iter.get();
 134       new_if->then_instructions.push_tail(ir->clone(mem_ctx, ht));
 135    }
 136
 137    foreach_iter(exec_list_iterator, iter, this->else_instructions) {
 138       ir_instruction *ir = (ir_instruction *)iter.get();
 139       new_if->else_instructions.push_tail(ir->clone(mem_ctx, ht));
 140    }
 141
 142    return new_if;
 143 }
 144
 145 ir_loop *
 146 ir_loop::clone(void *mem_ctx, struct hash_table *ht) const
 147 {
 148    ir_loop *new_loop = new(mem_ctx) ir_loop();
 149
 150    if (this->from)
 151       new_loop->from = this->from->clone(mem_ctx, ht);
 152    if (this->to)
 153       new_loop->to = this->to->clone(mem_ctx, ht);
 154    if (this->increment)
 155       new_loop->increment = this->increment->clone(mem_ctx, ht);
 156    new_loop->counter = counter;
 157
 158    foreach_iter(exec_list_iterator, iter, this->body_instructions) {
 159       ir_instruction *ir = (ir_instruction *)iter.get();
 160       new_loop->body_instructions.push_tail(ir->clone(mem_ctx, ht));
 161    }
 162
 163    new_loop->cmp = this->cmp;
 164    return new_loop;
 165 }
 166
 167 ir_call *
 168 ir_call::clone(void *mem_ctx, struct hash_table *ht) const
 169 {
 170    exec_list new_parameters;
 171
 172    foreach_iter(exec_list_iterator, iter, this->actual_parameters) {
 173       ir_instruction *ir = (ir_instruction *)iter.get();
 174       new_parameters.push_tail(ir->clone(mem_ctx, ht));
 175    }
 176
 177    return new(mem_ctx) ir_call(this->callee, &new_parameters);
 178 }
 179
 180 ir_expression *
 181 ir_expression::clone(void *mem_ctx, struct hash_table *ht) const
 182 {
 183    ir_rvalue *op[Elements(this->operands)] = { NULL, };
 184    unsigned int i;
 185
 186    for (i = 0; i < get_num_operands(); i++) {
 187       op[i] = this->operands[i]->clone(mem_ctx, ht);
 188    }
 189
 190    return new(mem_ctx) ir_expression(this->operation, this->type,
 191                                      op[0], op[1], op[2], op[3]);
 192 }
 193
 194 ir_dereference_variable *
 195 ir_dereference_variable::clone(void *mem_ctx, struct hash_table *ht) const
 196 {
 197    ir_variable *new_var;
 198
 199    if (ht) {
 200       new_var = (ir_variable *)hash_table_find(ht, this->var);
 201       if (!new_var)
 202          new_var = this->var;
 203    } else {
 204       new_var = this->var;
 205    }
 206
 207    return new(mem_ctx) ir_dereference_variable(new_var);
 208 }
 209
 210 ir_dereference_array *
 211 ir_dereference_array::clone(void *mem_ctx, struct hash_table *ht) const
 212 {
 213    return new(mem_ctx) ir_dereference_array(this->array->clone(mem_ctx, ht),
 214                                             this->array_index->clone(mem_ctx,
 215                                                                      ht));
 216 }
 217
 218 ir_dereference_record *
 219 ir_dereference_record::clone(void *mem_ctx, struct hash_table *ht) const
 220 {
 221    return new(mem_ctx) ir_dereference_record(this->record->clone(mem_ctx, ht),
 222                                              this->field);
 223 }
 224
 225 ir_texture *
 226 ir_texture::clone(void *mem_ctx, struct hash_table *ht) const
 227 {
 228    ir_texture *new_tex = new(mem_ctx) ir_texture(this->op);
 229    new_tex->type = this->type;
 230
 231    new_tex->sampler = this->sampler->clone(mem_ctx, ht);
 232    if (this->coordinate)
 233       new_tex->coordinate = this->coordinate->clone(mem_ctx, ht);
 234    if (this->projector)
 235       new_tex->projector = this->projector->clone(mem_ctx, ht);
 236    if (this->shadow_comparitor) {
 237       new_tex->shadow_comparitor = this->shadow_comparitor->clone(mem_ctx, ht);
 238    }
 239
 240    if (this->offset != NULL)
 241       new_tex->offset = this->offset->clone(mem_ctx, ht);
 242
 243    switch (this->op) {
 244    case ir_tex:
 245       break;
 246    case ir_txb:
 247       new_tex->lod_info.bias = this->lod_info.bias->clone(mem_ctx, ht);
 248       break;
 249    case ir_txl:
 250    case ir_txf:
 251    case ir_txs:
 252       new_tex->lod_info.lod = this->lod_info.lod->clone(mem_ctx, ht);
 253       break;
 254    case ir_txd:
 255       new_tex->lod_info.grad.dPdx = this->lod_info.grad.dPdx->clone(mem_ctx, ht);
 256       new_tex->lod_info.grad.dPdy = this->lod_info.grad.dPdy->clone(mem_ctx, ht);
 257       break;
 258    }
 259
 260    return new_tex;
 261 }
 262
 263 ir_assignment *
 264 ir_assignment::clone(void *mem_ctx, struct hash_table *ht) const
 265 {
 266    ir_rvalue *new_condition = NULL;
 267
 268    if (this->condition)
 269       new_condition = this->condition->clone(mem_ctx, ht);
 270
 271    return new(mem_ctx) ir_assignment(this->lhs->clone(mem_ctx, ht),
 272                                      this->rhs->clone(mem_ctx, ht),
 273                                      new_condition,
 274                                      this->write_mask);
 275 }
 276
 277 ir_function *
 278 ir_function::clone(void *mem_ctx, struct hash_table *ht) const
 279 {
 280    ir_function *copy = new(mem_ctx) ir_function(this->name);
 281
 282    foreach_list_const(node, &this->signatures) {
 283       const ir_function_signature *const sig =
 284          (const ir_function_signature *const) node;
 285
 286       ir_function_signature *sig_copy = sig->clone(mem_ctx, ht);
 287       copy->add_signature(sig_copy);
 288
 289       if (ht != NULL)
 290          hash_table_insert(ht, sig_copy,
 291                            (void *)const_cast<ir_function_signature *>(sig));
 292    }
 293
 294    return copy;
 295 }
 296
 297 ir_function_signature *
 298 ir_function_signature::clone(void *mem_ctx, struct hash_table *ht) const
 299 {
 300    ir_function_signature *copy = this->clone_prototype(mem_ctx, ht);
 301
 302    copy->is_defined = this->is_defined;
 303
 304    /* Clone the instruction list.
 305     */
 306    foreach_list_const(node, &this->body) {
 307       const ir_instruction *const inst = (const ir_instruction *) node;
 308
 309       ir_instruction *const inst_copy = inst->clone(mem_ctx, ht);
 310       copy->body.push_tail(inst_copy);
 311    }
 312
 313    return copy;
 314 }
 315
 316 ir_function_signature *
 317 ir_function_signature::clone_prototype(void *mem_ctx, struct hash_table *ht) const
 318 {
 319    ir_function_signature *copy =
 320       new(mem_ctx) ir_function_signature(this->return_type);
 321
 322    copy->is_defined = false;
 323    copy->is_builtin = this->is_builtin;
 324
 325    /* Clone the parameter list, but NOT the body.
 326     */
 327    foreach_list_const(node, &this->parameters) {
 328       const ir_variable *const param = (const ir_variable *) node;
 329
 330       assert(const_cast<ir_variable *>(param)->as_variable() != NULL);
 331
 332       ir_variable *const param_copy = param->clone(mem_ctx, ht);
 333       copy->parameters.push_tail(param_copy);
 334    }
 335
 336    return copy;
 337 }
 338
 339 ir_constant *
 340 ir_constant::clone(void *mem_ctx, struct hash_table *ht) const
 341 {
 342    (void)ht;
 343
 344    switch (this->type->base_type) {
 345    case GLSL_TYPE_UINT:
 346    case GLSL_TYPE_INT:
 347    case GLSL_TYPE_FLOAT:
 348    case GLSL_TYPE_BOOL:
 349       return new(mem_ctx) ir_constant(this->type, &this->value);
 350
 351    case GLSL_TYPE_STRUCT: {
 352       ir_constant *c = new(mem_ctx) ir_constant;
 353
 354       c->type = this->type;
 355       for (exec_node *node = this->components.head
 356               ; !node->is_tail_sentinel()
 357               ; node = node->next) {
 358          ir_constant *const orig = (ir_constant *) node;
 359
 360          c->components.push_tail(orig->clone(mem_ctx, NULL));
 361       }
 362
 363       return c;
 364    }
 365
 366    case GLSL_TYPE_ARRAY: {
 367       ir_constant *c = new(mem_ctx) ir_constant;
 368
 369       c->type = this->type;
 370       c->array_elements = ralloc_array(c, ir_constant *, this->type->length);
 371       for (unsigned i = 0; i < this->type->length; i++) {
 372          c->array_elements[i] = this->array_elements[i]->clone(mem_ctx, NULL);
 373       }
 374       return c;
 375    }
 376
 377    default:
 378       assert(!"Should not get here.");
 379       return NULL;
 380    }
 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->get_callee());
 398       if (sig != NULL)
 399          ir->set_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_list_const(node, in) {
 427       const ir_instruction *const original = (ir_instruction *) node;
 428       ir_instruction *copy = original->clone(mem_ctx, ht);
 429
 430       out->push_tail(copy);
 431    }
 432
 433    /* Make a pass over the cloned tree to fix up ir_call nodes to point to the
 434     * cloned ir_function_signature nodes.  This cannot be done automatically
 435     * during cloning because the ir_call might be a forward reference (i.e.,
 436     * the function signature that it references may not have been cloned yet).
 437     */
 438    fixup_function_calls(ht, out);
 439
 440    hash_table_dtor(ht);
 441 }