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