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