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->uniform_block = this->uniform_block;
  54    var->warn_extension = this->warn_extension;
  55    var->origin_upper_left = this->origin_upper_left;
  56    var->pixel_center_integer = this->pixel_center_integer;
  57    var->explicit_location = this->explicit_location;
  58    var->explicit_index = this->explicit_index;
  59    var->has_initializer = this->has_initializer;
  60    var->depth_layout = this->depth_layout;
  61
  62    var->num_state_slots = this->num_state_slots;
  63    if (this->state_slots) {
  64       /* FINISHME: This really wants to use something like talloc_reference, but
  65        * FINISHME: ralloc doesn't have any similar function.
  66        */
  67       var->state_slots = ralloc_array(var, ir_state_slot,
  68                                       this->num_state_slots);
  69       memcpy(var->state_slots, this->state_slots,
  70              sizeof(this->state_slots[0]) * var->num_state_slots);
  71    }
  72
  73    if (this->constant_value)
  74       var->constant_value = this->constant_value->clone(mem_ctx, ht);
  75
  76    if (this->constant_initializer)
  77       var->constant_initializer =
  78          this->constant_initializer->clone(mem_ctx, ht);
  79
  80    if (ht) {
  81       hash_table_insert(ht, var, (void *)const_cast<ir_variable *>(this));
  82    }
  83
  84    return var;
  85 }
  86
  87 ir_swizzle *
  88 ir_swizzle::clone(void *mem_ctx, struct hash_table *ht) const
  89 {
  90    return new(mem_ctx) ir_swizzle(this->val->clone(mem_ctx, ht), this->mask);
  91 }
  92
  93 ir_return *
  94 ir_return::clone(void *mem_ctx, struct hash_table *ht) const
  95 {
  96    ir_rvalue *new_value = NULL;
  97
  98    if (this->value)
  99       new_value = this->value->clone(mem_ctx, ht);
 100
 101    return new(mem_ctx) ir_return(new_value);
 102 }
 103
 104 ir_discard *
 105 ir_discard::clone(void *mem_ctx, struct hash_table *ht) const
 106 {
 107    ir_rvalue *new_condition = NULL;
 108
 109    if (this->condition != NULL)
 110       new_condition = this->condition->clone(mem_ctx, ht);
 111
 112    return new(mem_ctx) ir_discard(new_condition);
 113 }
 114
 115 ir_loop_jump *
 116 ir_loop_jump::clone(void *mem_ctx, struct hash_table *ht) const
 117 {
 118    (void)ht;
 119
 120    return new(mem_ctx) ir_loop_jump(this->mode);
 121 }
 122
 123 ir_if *
 124 ir_if::clone(void *mem_ctx, struct hash_table *ht) const
 125 {
 126    ir_if *new_if = new(mem_ctx) ir_if(this->condition->clone(mem_ctx, ht));
 127
 128    foreach_iter(exec_list_iterator, iter, this->then_instructions) {
 129       ir_instruction *ir = (ir_instruction *)iter.get();
 130       new_if->then_instructions.push_tail(ir->clone(mem_ctx, ht));
 131    }
 132
 133    foreach_iter(exec_list_iterator, iter, this->else_instructions) {
 134       ir_instruction *ir = (ir_instruction *)iter.get();
 135       new_if->else_instructions.push_tail(ir->clone(mem_ctx, ht));
 136    }
 137
 138    return new_if;
 139 }
 140
 141 ir_loop *
 142 ir_loop::clone(void *mem_ctx, struct hash_table *ht) const
 143 {
 144    ir_loop *new_loop = new(mem_ctx) ir_loop();
 145
 146    if (this->from)
 147       new_loop->from = this->from->clone(mem_ctx, ht);
 148    if (this->to)
 149       new_loop->to = this->to->clone(mem_ctx, ht);
 150    if (this->increment)
 151       new_loop->increment = this->increment->clone(mem_ctx, ht);
 152    new_loop->counter = counter;
 153
 154    foreach_iter(exec_list_iterator, iter, this->body_instructions) {
 155       ir_instruction *ir = (ir_instruction *)iter.get();
 156       new_loop->body_instructions.push_tail(ir->clone(mem_ctx, ht));
 157    }
 158
 159    new_loop->cmp = this->cmp;
 160    return new_loop;
 161 }
 162
 163 ir_call *
 164 ir_call::clone(void *mem_ctx, struct hash_table *ht) const
 165 {
 166    ir_dereference_variable *new_return_ref = NULL;
 167    if (this->return_deref != NULL)
 168       new_return_ref = this->return_deref->clone(mem_ctx, ht);
 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_return_ref, &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    copy->origin = this;
 325
 326    /* Clone the parameter list, but NOT the body.
 327     */
 328    foreach_list_const(node, &this->parameters) {
 329       const ir_variable *const param = (const ir_variable *) node;
 330
 331       assert(const_cast<ir_variable *>(param)->as_variable() != NULL);
 332
 333       ir_variable *const param_copy = param->clone(mem_ctx, ht);
 334       copy->parameters.push_tail(param_copy);
 335    }
 336
 337    return copy;
 338 }
 339
 340 ir_constant *
 341 ir_constant::clone(void *mem_ctx, struct hash_table *ht) const
 342 {
 343    (void)ht;
 344
 345    switch (this->type->base_type) {
 346    case GLSL_TYPE_UINT:
 347    case GLSL_TYPE_INT:
 348    case GLSL_TYPE_FLOAT:
 349    case GLSL_TYPE_BOOL:
 350       return new(mem_ctx) ir_constant(this->type, &this->value);
 351
 352    case GLSL_TYPE_STRUCT: {
 353       ir_constant *c = new(mem_ctx) ir_constant;
 354
 355       c->type = this->type;
 356       for (exec_node *node = this->components.head
 357               ; !node->is_tail_sentinel()
 358               ; node = node->next) {
 359          ir_constant *const orig = (ir_constant *) node;
 360
 361          c->components.push_tail(orig->clone(mem_ctx, NULL));
 362       }
 363
 364       return c;
 365    }
 366
 367    case GLSL_TYPE_ARRAY: {
 368       ir_constant *c = new(mem_ctx) ir_constant;
 369
 370       c->type = this->type;
 371       c->array_elements = ralloc_array(c, ir_constant *, this->type->length);
 372       for (unsigned i = 0; i < this->type->length; i++) {
 373          c->array_elements[i] = this->array_elements[i]->clone(mem_ctx, NULL);
 374       }
 375       return c;
 376    }
 377
 378    default:
 379       assert(!"Should not get here.");
 380       return NULL;
 381    }
 382 }
 383
 384
 385 class fixup_ir_call_visitor : public ir_hierarchical_visitor {
 386 public:
 387    fixup_ir_call_visitor(struct hash_table *ht)
 388    {
 389       this->ht = ht;
 390    }
 391
 392    virtual ir_visitor_status visit_enter(ir_call *ir)
 393    {
 394       /* Try to find the function signature referenced by the ir_call in the
 395        * table.  If it is found, replace it with the value from the table.
 396        */
 397       ir_function_signature *sig =
 398          (ir_function_signature *) hash_table_find(this->ht, ir->callee);
 399       if (sig != NULL)
 400          ir->callee = sig;
 401
 402       /* Since this may be used before function call parameters are flattened,
 403        * the children also need to be processed.
 404        */
 405       return visit_continue;
 406    }
 407
 408 private:
 409    struct hash_table *ht;
 410 };
 411
 412
 413 static void
 414 fixup_function_calls(struct hash_table *ht, exec_list *instructions)
 415 {
 416    fixup_ir_call_visitor v(ht);
 417    v.run(instructions);
 418 }
 419
 420
 421 void
 422 clone_ir_list(void *mem_ctx, exec_list *out, const exec_list *in)
 423 {
 424    struct hash_table *ht =
 425       hash_table_ctor(0, hash_table_pointer_hash, hash_table_pointer_compare);
 426
 427    foreach_list_const(node, in) {
 428       const ir_instruction *const original = (ir_instruction *) node;
 429       ir_instruction *copy = original->clone(mem_ctx, ht);
 430
 431       out->push_tail(copy);
 432    }
 433
 434    /* Make a pass over the cloned tree to fix up ir_call nodes to point to the
 435     * cloned ir_function_signature nodes.  This cannot be done automatically
 436     * during cloning because the ir_call might be a forward reference (i.e.,
 437     * the function signature that it references may not have been cloned yet).
 438     */
 439    fixup_function_calls(ht, out);
 440
 441    hash_table_dtor(ht);
 442 }