src/glsl/opt_function_inlining.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 /**
  25  * \file opt_function_inlining.cpp
  26  *
  27  * Replaces calls to functions with the body of the function.
  28  */
  29
  30 #include <inttypes.h>
  31 #include "ir.h"
  32 #include "ir_visitor.h"
  33 #include "ir_function_inlining.h"
  34 #include "ir_expression_flattening.h"
  35 #include "glsl_types.h"
  36 #include "program/hash_table.h"
  37
  38 static void
  39 do_sampler_replacement(exec_list *instructions,
  40                        ir_variable *sampler,
  41                        ir_dereference *deref);
  42
  43 class ir_function_inlining_visitor : public ir_hierarchical_visitor {
  44 public:
  45    ir_function_inlining_visitor()
  46    {
  47       progress = false;
  48    }
  49
  50    virtual ~ir_function_inlining_visitor()
  51    {
  52       /* empty */
  53    }
  54
  55    virtual ir_visitor_status visit_enter(ir_expression *);
  56    virtual ir_visitor_status visit_enter(ir_call *);
  57    virtual ir_visitor_status visit_enter(ir_assignment *);
  58    virtual ir_visitor_status visit_enter(ir_return *);
  59    virtual ir_visitor_status visit_enter(ir_texture *);
  60    virtual ir_visitor_status visit_enter(ir_swizzle *);
  61
  62    bool progress;
  63 };
  64
  65
  66 bool
  67 automatic_inlining_predicate(ir_instruction *ir)
  68 {
  69    ir_call *call = ir->as_call();
  70
  71    if (call && can_inline(call))
  72       return true;
  73
  74    return false;
  75 }
  76
  77 bool
  78 do_function_inlining(exec_list *instructions)
  79 {
  80    ir_function_inlining_visitor v;
  81
  82    do_expression_flattening(instructions, automatic_inlining_predicate);
  83
  84    v.run(instructions);
  85
  86    return v.progress;
  87 }
  88
  89 static void
  90 replace_return_with_assignment(ir_instruction *ir, void *data)
  91 {
  92    void *ctx = ralloc_parent(ir);
  93    ir_variable *retval = (ir_variable *)data;
  94    ir_return *ret = ir->as_return();
  95
  96    if (ret) {
  97       if (ret->value) {
  98          ir_rvalue *lhs = new(ctx) ir_dereference_variable(retval);
  99          ret->replace_with(new(ctx) ir_assignment(lhs, ret->value, NULL));
 100       } else {
 101          /* un-valued return has to be the last return, or we shouldn't
 102           * have reached here. (see can_inline()).
 103           */
 104          assert(ret->next->is_tail_sentinel());
 105          ret->remove();
 106       }
 107    }
 108 }
 109
 110 ir_rvalue *
 111 ir_call::generate_inline(ir_instruction *next_ir)
 112 {
 113    void *ctx = ralloc_parent(this);
 114    ir_variable **parameters;
 115    int num_parameters;
 116    int i;
 117    ir_variable *retval = NULL;
 118    struct hash_table *ht;
 119
 120    ht = hash_table_ctor(0, hash_table_pointer_hash, hash_table_pointer_compare);
 121
 122    num_parameters = 0;
 123    foreach_iter(exec_list_iterator, iter_sig, this->callee->parameters)
 124       num_parameters++;
 125
 126    parameters = new ir_variable *[num_parameters];
 127
 128    /* Generate storage for the return value. */
 129    if (!this->callee->return_type->is_void()) {
 130       retval = new(ctx) ir_variable(this->callee->return_type, "_ret_val",
 131                                     ir_var_auto);
 132       next_ir->insert_before(retval);
 133    }
 134
 135    /* Generate the declarations for the parameters to our inlined code,
 136     * and set up the mapping of real function body variables to ours.
 137     */
 138    i = 0;
 139    exec_list_iterator sig_param_iter = this->callee->parameters.iterator();
 140    exec_list_iterator param_iter = this->actual_parameters.iterator();
 141    for (i = 0; i < num_parameters; i++) {
 142       ir_variable *sig_param = (ir_variable *) sig_param_iter.get();
 143       ir_rvalue *param = (ir_rvalue *) param_iter.get();
 144
 145       /* Generate a new variable for the parameter. */
 146       if (sig_param->type->base_type == GLSL_TYPE_SAMPLER) {
 147          /* For samplers, we want the inlined sampler references
 148           * referencing the passed in sampler variable, since that
 149           * will have the location information, which an assignment of
 150           * a sampler wouldn't.  Fix it up below.
 151           */
 152          parameters[i] = NULL;
 153       } else {
 154          parameters[i] = sig_param->clone(ctx, ht);
 155          parameters[i]->mode = ir_var_auto;
 156
 157          /* Remove the read-only decoration becuase we're going to write
 158           * directly to this variable.  If the cloned variable is left
 159           * read-only and the inlined function is inside a loop, the loop
 160           * analysis code will get confused.
 161           */
 162          parameters[i]->read_only = false;
 163          next_ir->insert_before(parameters[i]);
 164       }
 165
 166       /* Move the actual param into our param variable if it's an 'in' type. */
 167       if (parameters[i] && (sig_param->mode == ir_var_in ||
 168                             sig_param->mode == ir_var_const_in ||
 169                             sig_param->mode == ir_var_inout)) {
 170          ir_assignment *assign;
 171
 172          assign = new(ctx) ir_assignment(new(ctx) ir_dereference_variable(parameters[i]),
 173                                          param, NULL);
 174          next_ir->insert_before(assign);
 175       }
 176
 177       sig_param_iter.next();
 178       param_iter.next();
 179    }
 180
 181    exec_list new_instructions;
 182
 183    /* Generate the inlined body of the function to a new list */
 184    foreach_iter(exec_list_iterator, iter, callee->body) {
 185       ir_instruction *ir = (ir_instruction *)iter.get();
 186       ir_instruction *new_ir = ir->clone(ctx, ht);
 187
 188       new_instructions.push_tail(new_ir);
 189       visit_tree(new_ir, replace_return_with_assignment, retval);
 190    }
 191
 192    /* If any samplers were passed in, replace any deref of the sampler
 193     * with a deref of the sampler argument.
 194     */
 195    param_iter = this->actual_parameters.iterator();
 196    sig_param_iter = this->callee->parameters.iterator();
 197    for (i = 0; i < num_parameters; i++) {
 198       ir_instruction *const param = (ir_instruction *) param_iter.get();
 199       ir_variable *sig_param = (ir_variable *) sig_param_iter.get();
 200
 201       if (sig_param->type->base_type == GLSL_TYPE_SAMPLER) {
 202          ir_dereference *deref = param->as_dereference();
 203
 204          assert(deref);
 205          do_sampler_replacement(&new_instructions, sig_param, deref);
 206       }
 207       param_iter.next();
 208       sig_param_iter.next();
 209    }
 210
 211    /* Now push those new instructions in. */
 212    next_ir->insert_before(&new_instructions);
 213
 214    /* Copy back the value of any 'out' parameters from the function body
 215     * variables to our own.
 216     */
 217    i = 0;
 218    param_iter = this->actual_parameters.iterator();
 219    sig_param_iter = this->callee->parameters.iterator();
 220    for (i = 0; i < num_parameters; i++) {
 221       ir_instruction *const param = (ir_instruction *) param_iter.get();
 222       const ir_variable *const sig_param = (ir_variable *) sig_param_iter.get();
 223
 224       /* Move our param variable into the actual param if it's an 'out' type. */
 225       if (parameters[i] && (sig_param->mode == ir_var_out ||
 226                             sig_param->mode == ir_var_inout)) {
 227          ir_assignment *assign;
 228
 229          assign = new(ctx) ir_assignment(param->clone(ctx, NULL)->as_rvalue(),
 230                                          new(ctx) ir_dereference_variable(parameters[i]),
 231                                          NULL);
 232          next_ir->insert_before(assign);
 233       }
 234
 235       param_iter.next();
 236       sig_param_iter.next();
 237    }
 238
 239    delete [] parameters;
 240
 241    hash_table_dtor(ht);
 242
 243    if (retval)
 244       return new(ctx) ir_dereference_variable(retval);
 245    else
 246       return NULL;
 247 }
 248
 249
 250 ir_visitor_status
 251 ir_function_inlining_visitor::visit_enter(ir_expression *ir)
 252 {
 253    (void) ir;
 254    return visit_continue_with_parent;
 255 }
 256
 257
 258 ir_visitor_status
 259 ir_function_inlining_visitor::visit_enter(ir_return *ir)
 260 {
 261    (void) ir;
 262    return visit_continue_with_parent;
 263 }
 264
 265
 266 ir_visitor_status
 267 ir_function_inlining_visitor::visit_enter(ir_texture *ir)
 268 {
 269    (void) ir;
 270    return visit_continue_with_parent;
 271 }
 272
 273
 274 ir_visitor_status
 275 ir_function_inlining_visitor::visit_enter(ir_swizzle *ir)
 276 {
 277    (void) ir;
 278    return visit_continue_with_parent;
 279 }
 280
 281
 282 ir_visitor_status
 283 ir_function_inlining_visitor::visit_enter(ir_call *ir)
 284 {
 285    if (can_inline(ir)) {
 286       /* If the call was part of some tree, then it should have been
 287        * flattened out or we shouldn't have seen it because of a
 288        * visit_continue_with_parent in this visitor.
 289        */
 290       assert(ir == base_ir);
 291
 292       (void) ir->generate_inline(ir);
 293       ir->remove();
 294       this->progress = true;
 295    }
 296
 297    return visit_continue;
 298 }
 299
 300
 301 ir_visitor_status
 302 ir_function_inlining_visitor::visit_enter(ir_assignment *ir)
 303 {
 304    ir_call *call = ir->rhs->as_call();
 305    if (!call || !can_inline(call))
 306       return visit_continue;
 307
 308    /* generates the parameter setup, function body, and returns the return
 309     * value of the function
 310     */
 311    ir_rvalue *rhs = call->generate_inline(ir);
 312    assert(rhs);
 313
 314    ir->rhs = rhs;
 315    this->progress = true;
 316
 317    return visit_continue;
 318 }
 319
 320 /**
 321  * Replaces references to the "sampler" variable with a clone of "deref."
 322  *
 323  * From the spec, samplers can appear in the tree as function
 324  * (non-out) parameters and as the result of array indexing and
 325  * structure field selection.  In our builtin implementation, they
 326  * also appear in the sampler field of an ir_tex instruction.
 327  */
 328
 329 class ir_sampler_replacement_visitor : public ir_hierarchical_visitor {
 330 public:
 331    ir_sampler_replacement_visitor(ir_variable *sampler, ir_dereference *deref)
 332    {
 333       this->sampler = sampler;
 334       this->deref = deref;
 335    }
 336
 337    virtual ~ir_sampler_replacement_visitor()
 338    {
 339    }
 340
 341    virtual ir_visitor_status visit_leave(ir_call *);
 342    virtual ir_visitor_status visit_leave(ir_dereference_array *);
 343    virtual ir_visitor_status visit_leave(ir_dereference_record *);
 344    virtual ir_visitor_status visit_leave(ir_texture *);
 345
 346    void replace_deref(ir_dereference **deref);
 347    void replace_rvalue(ir_rvalue **rvalue);
 348
 349    ir_variable *sampler;
 350    ir_dereference *deref;
 351 };
 352
 353 void
 354 ir_sampler_replacement_visitor::replace_deref(ir_dereference **deref)
 355 {
 356    ir_dereference_variable *deref_var = (*deref)->as_dereference_variable();
 357    if (deref_var && deref_var->var == this->sampler) {
 358       *deref = this->deref->clone(ralloc_parent(*deref), NULL);
 359    }
 360 }
 361
 362 void
 363 ir_sampler_replacement_visitor::replace_rvalue(ir_rvalue **rvalue)
 364 {
 365    if (!*rvalue)
 366       return;
 367
 368    ir_dereference *deref = (*rvalue)->as_dereference();
 369
 370    if (!deref)
 371       return;
 372
 373    replace_deref(&deref);
 374    *rvalue = deref;
 375 }
 376
 377 ir_visitor_status
 378 ir_sampler_replacement_visitor::visit_leave(ir_texture *ir)
 379 {
 380    replace_deref(&ir->sampler);
 381
 382    return visit_continue;
 383 }
 384
 385 ir_visitor_status
 386 ir_sampler_replacement_visitor::visit_leave(ir_dereference_array *ir)
 387 {
 388    replace_rvalue(&ir->array);
 389    return visit_continue;
 390 }
 391
 392 ir_visitor_status
 393 ir_sampler_replacement_visitor::visit_leave(ir_dereference_record *ir)
 394 {
 395    replace_rvalue(&ir->record);
 396    return visit_continue;
 397 }
 398
 399 ir_visitor_status
 400 ir_sampler_replacement_visitor::visit_leave(ir_call *ir)
 401 {
 402    foreach_iter(exec_list_iterator, iter, *ir) {
 403       ir_rvalue *param = (ir_rvalue *)iter.get();
 404       ir_rvalue *new_param = param;
 405       replace_rvalue(&new_param);
 406
 407       if (new_param != param) {
 408          param->replace_with(new_param);
 409       }
 410    }
 411    return visit_continue;
 412 }
 413
 414 static void
 415 do_sampler_replacement(exec_list *instructions,
 416                        ir_variable *sampler,
 417                        ir_dereference *deref)
 418 {
 419    ir_sampler_replacement_visitor v(sampler, deref);
 420
 421    visit_list_elements(&v, instructions);
 422 }