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 extern "C" {
  29 #include "program/hash_table.h"
  30 }
  31
  32 /**
  33  * Duplicate an IR variable
  34  *
  35  * \note
  36  * This will probably be made \c virtual and moved to the base class
  37  * eventually.
  38  */
  39 ir_variable *
  40 ir_variable::clone(void *mem_ctx, struct hash_table *ht) const
  41 {
  42    ir_variable *var = new(mem_ctx) ir_variable(this->type, this->name,
  43                                                (ir_variable_mode) this->mode);
  44
  45    var->max_array_access = this->max_array_access;
  46    var->read_only = this->read_only;
  47    var->centroid = this->centroid;
  48    var->invariant = this->invariant;
  49    var->interpolation = this->interpolation;
  50    var->location = this->location;
  51    var->warn_extension = this->warn_extension;
  52    var->origin_upper_left = this->origin_upper_left;
  53    var->pixel_center_integer = this->pixel_center_integer;
  54    var->explicit_location = this->explicit_location;
  55
  56    var->num_state_slots = this->num_state_slots;
  57    if (this->state_slots) {
  58       /* FINISHME: This really wants to use something like talloc_reference, but
  59        * FINISHME: ralloc doesn't have any similar function.
  60        */
  61       var->state_slots = ralloc_array(var, ir_state_slot,
  62                                       this->num_state_slots);
  63       memcpy(var->state_slots, this->state_slots,
  64              sizeof(this->state_slots[0]) * var->num_state_slots);
  65    }
  66
  67    if (this->explicit_location)
  68       var->location = this->location;
  69
  70    if (this->constant_value)
  71       var->constant_value = this->constant_value->clone(mem_ctx, ht);
  72
  73    if (ht) {
  74       hash_table_insert(ht, var, (void *)const_cast<ir_variable *>(this));
  75    }
  76
  77    return var;
  78 }
  79
  80 ir_swizzle *
  81 ir_swizzle::clone(void *mem_ctx, struct hash_table *ht) const
  82 {
  83    return new(mem_ctx) ir_swizzle(this->val->clone(mem_ctx, ht), this->mask);
  84 }
  85
  86 ir_return *
  87 ir_return::clone(void *mem_ctx, struct hash_table *ht) const
  88 {
  89    ir_rvalue *new_value = NULL;
  90
  91    if (this->value)
  92       new_value = this->value->clone(mem_ctx, ht);
  93
  94    return new(mem_ctx) ir_return(new_value);
  95 }
  96
  97 ir_discard *
  98 ir_discard::clone(void *mem_ctx, struct hash_table *ht) const
  99 {
 100    ir_rvalue *new_condition = NULL;
 101
 102    if (this->condition != NULL)
 103       new_condition = this->condition->clone(mem_ctx, ht);
 104
 105    return new(mem_ctx) ir_discard(new_condition);
 106 }
 107
 108 ir_loop_jump *
 109 ir_loop_jump::clone(void *mem_ctx, struct hash_table *ht) const
 110 {
 111    (void)ht;
 112
 113    return new(mem_ctx) ir_loop_jump(this->mode);
 114 }
 115
 116 ir_if *
 117 ir_if::clone(void *mem_ctx, struct hash_table *ht) const
 118 {
 119    ir_if *new_if = new(mem_ctx) ir_if(this->condition->clone(mem_ctx, ht));
 120
 121    foreach_iter(exec_list_iterator, iter, this->then_instructions) {
 122       ir_instruction *ir = (ir_instruction *)iter.get();
 123       new_if->then_instructions.push_tail(ir->clone(mem_ctx, ht));
 124    }
 125
 126    foreach_iter(exec_list_iterator, iter, this->else_instructions) {
 127       ir_instruction *ir = (ir_instruction *)iter.get();
 128       new_if->else_instructions.push_tail(ir->clone(mem_ctx, ht));
 129    }
 130
 131    return new_if;
 132 }
 133
 134 ir_loop *
 135 ir_loop::clone(void *mem_ctx, struct hash_table *ht) const
 136 {
 137    ir_loop *new_loop = new(mem_ctx) ir_loop();
 138
 139    if (this->from)
 140       new_loop->from = this->from->clone(mem_ctx, ht);
 141    if (this->to)
 142       new_loop->to = this->to->clone(mem_ctx, ht);
 143    if (this->increment)
 144       new_loop->increment = this->increment->clone(mem_ctx, ht);
 145    new_loop->counter = counter;
 146
 147    foreach_iter(exec_list_iterator, iter, this->body_instructions) {
 148       ir_instruction *ir = (ir_instruction *)iter.get();
 149       new_loop->body_instructions.push_tail(ir->clone(mem_ctx, ht));
 150    }
 151
 152    new_loop->cmp = this->cmp;
 153    return new_loop;
 154 }
 155
 156 ir_call *
 157 ir_call::clone(void *mem_ctx, struct hash_table *ht) const
 158 {
 159    if (this->type == glsl_type::error_type)
 160       return ir_call::get_error_instruction(mem_ctx);
 161
 162    exec_list new_parameters;
 163
 164    foreach_iter(exec_list_iterator, iter, this->actual_parameters) {
 165       ir_instruction *ir = (ir_instruction *)iter.get();
 166       new_parameters.push_tail(ir->clone(mem_ctx, ht));
 167    }
 168
 169    return new(mem_ctx) ir_call(this->callee, &new_parameters);
 170 }
 171
 172 ir_expression *
 173 ir_expression::clone(void *mem_ctx, struct hash_table *ht) const
 174 {
 175    ir_rvalue *op[Elements(this->operands)] = { NULL, };
 176    unsigned int i;
 177
 178    for (i = 0; i < get_num_operands(); i++) {
 179       op[i] = this->operands[i]->clone(mem_ctx, ht);
 180    }
 181
 182    return new(mem_ctx) ir_expression(this->operation, this->type,
 183                                      op[0], op[1], op[2], op[3]);
 184 }
 185
 186 ir_dereference_variable *
 187 ir_dereference_variable::clone(void *mem_ctx, struct hash_table *ht) const
 188 {
 189    ir_variable *new_var;
 190
 191    if (ht) {
 192       new_var = (ir_variable *)hash_table_find(ht, this->var);
 193       if (!new_var)
 194          new_var = this->var;
 195    } else {
 196       new_var = this->var;
 197    }
 198
 199    return new(mem_ctx) ir_dereference_variable(new_var);
 200 }
 201
 202 ir_dereference_array *
 203 ir_dereference_array::clone(void *mem_ctx, struct hash_table *ht) const
 204 {
 205    return new(mem_ctx) ir_dereference_array(this->array->clone(mem_ctx, ht),
 206                                             this->array_index->clone(mem_ctx,
 207                                                                      ht));
 208 }
 209
 210 ir_dereference_record *
 211 ir_dereference_record::clone(void *mem_ctx, struct hash_table *ht) const
 212 {
 213    return new(mem_ctx) ir_dereference_record(this->record->clone(mem_ctx, ht),
 214                                              this->field);
 215 }
 216
 217 ir_texture *
 218 ir_texture::clone(void *mem_ctx, struct hash_table *ht) const
 219 {
 220    ir_texture *new_tex = new(mem_ctx) ir_texture(this->op);
 221    new_tex->type = this->type;
 222
 223    new_tex->sampler = this->sampler->clone(mem_ctx, ht);
 224    if (this->coordinate)
 225       new_tex->coordinate = this->coordinate->clone(mem_ctx, ht);
 226    if (this->projector)
 227       new_tex->projector = this->projector->clone(mem_ctx, ht);
 228    if (this->shadow_comparitor) {
 229       new_tex->shadow_comparitor = this->shadow_comparitor->clone(mem_ctx, ht);
 230    }
 231
 232    if (this->offset != NULL)
 233       new_tex->offset = this->offset->clone(mem_ctx, ht);
 234
 235    switch (this->op) {
 236    case ir_tex:
 237       break;
 238    case ir_txb:
 239       new_tex->lod_info.bias = this->lod_info.bias->clone(mem_ctx, ht);
 240       break;
 241    case ir_txl:
 242    case ir_txf:
 243    case ir_txs:
 244       new_tex->lod_info.lod = this->lod_info.lod->clone(mem_ctx, ht);
 245       break;
 246    case ir_txd:
 247       new_tex->lod_info.grad.dPdx = this->lod_info.grad.dPdx->clone(mem_ctx, ht);
 248       new_tex->lod_info.grad.dPdy = this->lod_info.grad.dPdy->clone(mem_ctx, ht);
 249       break;
 250    }
 251
 252    return new_tex;
 253 }
 254
 255 ir_assignment *
 256 ir_assignment::clone(void *mem_ctx, struct hash_table *ht) const
 257 {
 258    ir_rvalue *new_condition = NULL;
 259
 260    if (this->condition)
 261       new_condition = this->condition->clone(mem_ctx, ht);
 262
 263    return new(mem_ctx) ir_assignment(this->lhs->clone(mem_ctx, ht),
 264                                      this->rhs->clone(mem_ctx, ht),
 265                                      new_condition,
 266                                      this->write_mask);
 267 }
 268
 269 ir_function *
 270 ir_function::clone(void *mem_ctx, struct hash_table *ht) const
 271 {
 272    ir_function *copy = new(mem_ctx) ir_function(this->name);
 273
 274    foreach_list_const(node, &this->signatures) {
 275       const ir_function_signature *const sig =
 276          (const ir_function_signature *const) node;
 277
 278       ir_function_signature *sig_copy = sig->clone(mem_ctx, ht);
 279       copy->add_signature(sig_copy);
 280
 281       if (ht != NULL)
 282          hash_table_insert(ht, sig_copy,
 283                            (void *)const_cast<ir_function_signature *>(sig));
 284    }
 285
 286    return copy;
 287 }
 288
 289 ir_function_signature *
 290 ir_function_signature::clone(void *mem_ctx, struct hash_table *ht) const
 291 {
 292    ir_function_signature *copy = this->clone_prototype(mem_ctx, ht);
 293
 294    copy->is_defined = this->is_defined;
 295
 296    /* Clone the instruction list.
 297     */
 298    foreach_list_const(node, &this->body) {
 299       const ir_instruction *const inst = (const ir_instruction *) node;
 300
 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->is_builtin = this->is_builtin;
 316
 317    /* Clone the parameter list, but NOT the body.
 318     */
 319    foreach_list_const(node, &this->parameters) {
 320       const ir_variable *const param = (const ir_variable *) node;
 321
 322       assert(const_cast<ir_variable *>(param)->as_variable() != NULL);
 323
 324       ir_variable *const param_copy = param->clone(mem_ctx, ht);
 325       copy->parameters.push_tail(param_copy);
 326    }
 327
 328    return copy;
 329 }
 330
 331 ir_constant *
 332 ir_constant::clone(void *mem_ctx, struct hash_table *ht) const
 333 {
 334    (void)ht;
 335
 336    switch (this->type->base_type) {
 337    case GLSL_TYPE_UINT:
 338    case GLSL_TYPE_INT:
 339    case GLSL_TYPE_FLOAT:
 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    default:
 370       assert(!"Should not get here.");
 371       return NULL;
 372    }
 373 }
 374
 375
 376 class fixup_ir_call_visitor : public ir_hierarchical_visitor {
 377 public:
 378    fixup_ir_call_visitor(struct hash_table *ht)
 379    {
 380       this->ht = ht;
 381    }
 382
 383    virtual ir_visitor_status visit_enter(ir_call *ir)
 384    {
 385       /* Try to find the function signature referenced by the ir_call in the
 386        * table.  If it is found, replace it with the value from the table.
 387        */
 388       ir_function_signature *sig =
 389          (ir_function_signature *) hash_table_find(this->ht, ir->get_callee());
 390       if (sig != NULL)
 391          ir->set_callee(sig);
 392
 393       /* Since this may be used before function call parameters are flattened,
 394        * the children also need to be processed.
 395        */
 396       return visit_continue;
 397    }
 398
 399 private:
 400    struct hash_table *ht;
 401 };
 402
 403
 404 static void
 405 fixup_function_calls(struct hash_table *ht, exec_list *instructions)
 406 {
 407    fixup_ir_call_visitor v(ht);
 408    v.run(instructions);
 409 }
 410
 411
 412 void
 413 clone_ir_list(void *mem_ctx, exec_list *out, const exec_list *in)
 414 {
 415    struct hash_table *ht =
 416       hash_table_ctor(0, hash_table_pointer_hash, hash_table_pointer_compare);
 417
 418    foreach_list_const(node, in) {
 419       const ir_instruction *const original = (ir_instruction *) node;
 420       ir_instruction *copy = original->clone(mem_ctx, ht);
 421
 422       out->push_tail(copy);
 423    }
 424
 425    /* Make a pass over the cloned tree to fix up ir_call nodes to point to the
 426     * cloned ir_function_signature nodes.  This cannot be done automatically
 427     * during cloning because the ir_call might be a forward reference (i.e.,
 428     * the function signature that it references may not have been cloned yet).
 429     */
 430    fixup_function_calls(ht, out);
 431
 432    hash_table_dtor(ht);
 433 }