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