Mercurial > hg > octave-nkf
view src/interp-core/pt-jit.cc @ 15096:909a2797935b
maint: Move interp source code without DEFUNs to interp-core/ dir.
* src/Makefile.am, interpfcn/module.mk, operators/module.mk,
parse-tree/module.mk: Update build system by moving source lists and rules
to the correct directory.
* Cell.cc, Cell.h, c-file-ptr-stream.cc, c-file-ptr-stream.h, comment-list.cc,
comment-list.h, cutils.c, cutils.h, defun-dld.h, defun-int.h, display.cc,
display.h, dynamic-ld.cc, dynamic-ld.h, gl-render.cc, gl-render.h,
gl2ps-renderer.cc, gl2ps-renderer.h, gl2ps.c, gl2ps.h, gripes.cc, gripes.h,
jit-ir.cc, jit-ir.h, jit-typeinfo.cc, jit-typeinfo.h, jit-util.cc, jit-util.h,
ls-ascii-helper.cc, ls-ascii-helper.h, ls-hdf5.cc, ls-hdf5.h, ls-mat-ascii.cc,
ls-mat-ascii.h, ls-mat4.cc, ls-mat4.h, ls-mat5.cc, ls-mat5.h, ls-oct-binary.cc,
ls-oct-binary.h, ls-utils.cc, ls-utils.h, matherr.c, mex.cc, mex.h, mexproto.h,
module.mk, mxarray.in.h, oct-errno.h, oct-errno.in.cc, oct-fstrm.cc,
oct-fstrm.h, oct-hdf5.h, oct-iostrm.cc, oct-iostrm.h, oct-lvalue.cc,
oct-lvalue.h, oct-map.cc, oct-map.h, oct-obj.cc, oct-obj.h, oct-prcstrm.cc,
oct-prcstrm.h, oct-procbuf.cc, oct-procbuf.h, oct-stdstrm.h, oct-stream.cc,
oct-stream.h, oct-strstrm.cc, oct-strstrm.h, oct.h, procstream.cc,
procstream.h, pt-jit.cc, pt-jit.h, siglist.c, siglist.h, sparse-xdiv.cc,
sparse-xdiv.h, sparse-xpow.cc, sparse-xpow.h, txt-eng-ft.cc, txt-eng-ft.h,
txt-eng.h, unwind-prot.cc, unwind-prot.h, xdiv.cc, xdiv.h, xgl2ps.c, xnorm.cc,
xnorm.h, xpow.cc, xpow.h, zfstream.cc, zfstream.h: Move from src/ dir to
src/interp-core dir.
* ops.h: Move to operators/ directory.
* octave.gperf, token.cc, token.h: Move to parse-tree directory.
author | Rik <rik@octave.org> |
---|---|
date | Fri, 03 Aug 2012 13:18:21 -0700 |
parents | src/pt-jit.cc@9df70a18aa27 |
children | d29f2583cf7b |
line wrap: on
line source
/* Copyright (C) 2012 Max Brister <max@2bass.com> This file is part of Octave. Octave is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. Octave is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with Octave; see the file COPYING. If not, see <http://www.gnu.org/licenses/>. */ #define __STDC_LIMIT_MACROS #define __STDC_CONSTANT_MACROS #ifdef HAVE_CONFIG_H #include <config.h> #endif #ifdef HAVE_LLVM #include "pt-jit.h" #include <llvm/Analysis/CallGraph.h> #include <llvm/Analysis/Passes.h> #include <llvm/Analysis/Verifier.h> #include <llvm/LLVMContext.h> #include <llvm/ExecutionEngine/ExecutionEngine.h> #include <llvm/ExecutionEngine/JIT.h> #include <llvm/Module.h> #include <llvm/PassManager.h> #include <llvm/Support/IRBuilder.h> #include <llvm/Support/raw_os_ostream.h> #include <llvm/Support/TargetSelect.h> #include <llvm/Target/TargetData.h> #include <llvm/Transforms/IPO.h> #include <llvm/Transforms/Scalar.h> #ifdef OCTAVE_JIT_DEBUG #include <llvm/Bitcode/ReaderWriter.h> #endif #include "symtab.h" #include "pt-all.h" static llvm::IRBuilder<> builder (llvm::getGlobalContext ()); static llvm::LLVMContext& context = llvm::getGlobalContext (); // -------------------- jit_convert -------------------- jit_convert::jit_convert (llvm::Module *module, tree &tee, jit_type *for_bounds) : iterator_count (0), for_bounds_count (0), short_count (0), breaking (false) { jit_instruction::reset_ids (); entry_block = create<jit_block> ("body"); final_block = create<jit_block> ("final"); append (entry_block); entry_block->mark_alive (); block = entry_block; if (for_bounds) create_variable (next_for_bounds (false), for_bounds); visit (tee); // FIXME: Remove if we no longer only compile loops assert (! breaking); assert (breaks.empty ()); assert (continues.empty ()); block->append (create<jit_branch> (final_block)); append (final_block); for (vmap_t::iterator iter = vmap.begin (); iter != vmap.end (); ++iter) { jit_variable *var = iter->second; const std::string& name = var->name (); if (name.size () && name[0] != '#') final_block->append (create<jit_store_argument> (var)); } construct_ssa (); // initialize the worklist to instructions derived from constants for (std::list<jit_value *>::iterator iter = constants.begin (); iter != constants.end (); ++iter) append_users (*iter); // the entry block terminator may be a regular branch statement if (entry_block->terminator ()) push_worklist (entry_block->terminator ()); // FIXME: Describe algorithm here while (worklist.size ()) { jit_instruction *next = worklist.front (); worklist.pop_front (); next->stash_in_worklist (false); if (next->infer ()) { // terminators need to be handles specially if (jit_terminator *term = dynamic_cast<jit_terminator *> (next)) append_users_term (term); else append_users (next); } } remove_dead (); merge_blocks (); final_block->label (); place_releases (); simplify_phi (); #ifdef OCTAVE_JIT_DEBUG final_block->label (); std::cout << "-------------------- Compiling tree --------------------\n"; std::cout << tee.str_print_code () << std::endl; print_blocks ("octave jit ir"); #endif // for now just init arguments from entry, later we will have to do something // more interesting for (jit_block::iterator iter = entry_block->begin (); iter != entry_block->end (); ++iter) if (jit_extract_argument *extract = dynamic_cast<jit_extract_argument *> (*iter)) arguments.push_back (std::make_pair (extract->name (), true)); convert_llvm to_llvm (*this); function = to_llvm.convert (module, arguments, blocks, constants); #ifdef OCTAVE_JIT_DEBUG std::cout << "-------------------- llvm ir --------------------"; llvm::raw_os_ostream llvm_cout (std::cout); function->print (llvm_cout); std::cout << std::endl; llvm::verifyFunction (*function); #endif } jit_convert::~jit_convert (void) { for (std::list<jit_value *>::iterator iter = all_values.begin (); iter != all_values.end (); ++iter) delete *iter; } void jit_convert::visit_anon_fcn_handle (tree_anon_fcn_handle&) { throw jit_fail_exception (); } void jit_convert::visit_argument_list (tree_argument_list&) { throw jit_fail_exception (); } void jit_convert::visit_binary_expression (tree_binary_expression& be) { if (be.op_type () >= octave_value::num_binary_ops) { tree_boolean_expression *boole; boole = dynamic_cast<tree_boolean_expression *> (&be); assert (boole); bool is_and = boole->op_type () == tree_boolean_expression::bool_and; std::string short_name = next_shortcircut_result (); jit_variable *short_result = create<jit_variable> (short_name); vmap[short_name] = short_result; jit_block *done = create<jit_block> (block->name ()); tree_expression *lhs = be.lhs (); jit_value *lhsv = visit (lhs); lhsv = create_checked (&jit_typeinfo::logically_true, lhsv); jit_block *short_early = create<jit_block> ("short_early"); append (short_early); jit_block *short_cont = create<jit_block> ("short_cont"); if (is_and) block->append (create<jit_cond_branch> (lhsv, short_cont, short_early)); else block->append (create<jit_cond_branch> (lhsv, short_early, short_cont)); block = short_early; jit_value *early_result = create<jit_const_bool> (! is_and); block->append (create<jit_assign> (short_result, early_result)); block->append (create<jit_branch> (done)); append (short_cont); block = short_cont; tree_expression *rhs = be.rhs (); jit_value *rhsv = visit (rhs); rhsv = create_checked (&jit_typeinfo::logically_true, rhsv); block->append (create<jit_assign> (short_result, rhsv)); block->append (create<jit_branch> (done)); append (done); block = done; result = short_result; } else { tree_expression *lhs = be.lhs (); jit_value *lhsv = visit (lhs); tree_expression *rhs = be.rhs (); jit_value *rhsv = visit (rhs); const jit_operation& fn = jit_typeinfo::binary_op (be.op_type ()); result = create_checked (fn, lhsv, rhsv); } } void jit_convert::visit_break_command (tree_break_command&) { breaks.push_back (block); breaking = true; } void jit_convert::visit_colon_expression (tree_colon_expression& expr) { // in the futher we need to add support for classes and deal with rvalues jit_value *base = visit (expr.base ()); jit_value *limit = visit (expr.limit ()); jit_value *increment; tree_expression *tinc = expr.increment (); if (tinc) increment = visit (tinc); else increment = create<jit_const_scalar> (1); result = block->append (create<jit_call> (jit_typeinfo::make_range, base, limit, increment)); } void jit_convert::visit_continue_command (tree_continue_command&) { continues.push_back (block); breaking = true; } void jit_convert::visit_global_command (tree_global_command&) { throw jit_fail_exception (); } void jit_convert::visit_persistent_command (tree_persistent_command&) { throw jit_fail_exception (); } void jit_convert::visit_decl_elt (tree_decl_elt&) { throw jit_fail_exception (); } void jit_convert::visit_decl_init_list (tree_decl_init_list&) { throw jit_fail_exception (); } void jit_convert::visit_simple_for_command (tree_simple_for_command& cmd) { // Note we do an initial check to see if the loop will run atleast once. // This allows us to get better type inference bounds on variables defined // and used only inside the for loop (e.g. the index variable) // If we are a nested for loop we need to store the previous breaks assert (! breaking); unwind_protect prot; prot.protect_var (breaks); prot.protect_var (continues); prot.protect_var (breaking); breaks.clear (); continues.clear (); // we need a variable for our iterator, because it is used in multiple blocks std::string iter_name = next_iterator (); jit_variable *iterator = create<jit_variable> (iter_name); create<jit_variable> (iter_name); vmap[iter_name] = iterator; jit_block *body = create<jit_block> ("for_body"); append (body); jit_block *tail = create<jit_block> ("for_tail"); // do control expression, iter init, and condition check in prev_block (block) // if we are the top level for loop, the bounds is an input argument. jit_value *control = find_variable (next_for_bounds ()); if (! control) control = visit (cmd.control_expr ()); jit_call *init_iter = create<jit_call> (jit_typeinfo::for_init, control); block->append (init_iter); block->append (create<jit_assign> (iterator, init_iter)); jit_value *check = block->append (create<jit_call> (jit_typeinfo::for_check, control, iterator)); block->append (create<jit_cond_branch> (check, body, tail)); block = body; // compute the syntactical iterator jit_call *idx_rhs = create<jit_call> (jit_typeinfo::for_index, control, iterator); block->append (idx_rhs); do_assign (cmd.left_hand_side (), idx_rhs); // do loop tree_statement_list *pt_body = cmd.body (); pt_body->accept (*this); if (breaking && continues.empty ()) { // WTF are you doing user? Every branch was a continue, why did you have // a loop??? Users are silly people... finish_breaks (tail, breaks); append (tail); block = tail; return; } // check our condition, continues jump to this block jit_block *check_block = create<jit_block> ("for_check"); append (check_block); if (! breaking) block->append (create<jit_branch> (check_block)); finish_breaks (check_block, continues); block = check_block; const jit_operation& add_fn = jit_typeinfo::binary_op (octave_value::op_add); jit_value *one = create<jit_const_index> (1); jit_call *iter_inc = create<jit_call> (add_fn, iterator, one); block->append (iter_inc); block->append (create<jit_assign> (iterator, iter_inc)); check = block->append (create<jit_call> (jit_typeinfo::for_check, control, iterator)); block->append (create<jit_cond_branch> (check, body, tail)); // breaks will go to our tail append (tail); finish_breaks (tail, breaks); block = tail; } void jit_convert::visit_complex_for_command (tree_complex_for_command&) { throw jit_fail_exception (); } void jit_convert::visit_octave_user_script (octave_user_script&) { throw jit_fail_exception (); } void jit_convert::visit_octave_user_function (octave_user_function&) { throw jit_fail_exception (); } void jit_convert::visit_octave_user_function_header (octave_user_function&) { throw jit_fail_exception (); } void jit_convert::visit_octave_user_function_trailer (octave_user_function&) { throw jit_fail_exception (); } void jit_convert::visit_function_def (tree_function_def&) { throw jit_fail_exception (); } void jit_convert::visit_identifier (tree_identifier& ti) { if (ti.has_magic_end ()) { if (!end_context.size ()) throw jit_fail_exception ("Illegal end"); result = block->append (create<jit_magic_end> (end_context)); } else result = get_variable (ti.name ()); } void jit_convert::visit_if_clause (tree_if_clause&) { throw jit_fail_exception (); } void jit_convert::visit_if_command (tree_if_command& cmd) { tree_if_command_list *lst = cmd.cmd_list (); assert (lst); // jwe: Can this be null? lst->accept (*this); } void jit_convert::visit_if_command_list (tree_if_command_list& lst) { tree_if_clause *last = lst.back (); size_t last_else = static_cast<size_t> (last->is_else_clause ()); // entry_blocks represents the block you need to enter in order to execute // the condition check for the ith clause. For the else, it is simple the // else body. If there is no else body, then it is padded with the tail std::vector<jit_block *> entry_blocks (lst.size () + 1 - last_else); std::vector<jit_block *> branch_blocks (lst.size (), 0); // final blocks entry_blocks[0] = block; // we need to construct blocks first, because they have jumps to eachother tree_if_command_list::iterator iter = lst.begin (); ++iter; for (size_t i = 1; iter != lst.end (); ++iter, ++i) { tree_if_clause *tic = *iter; if (tic->is_else_clause ()) entry_blocks[i] = create<jit_block> ("else"); else entry_blocks[i] = create<jit_block> ("ifelse_cond"); } jit_block *tail = create<jit_block> ("if_tail"); if (! last_else) entry_blocks[entry_blocks.size () - 1] = tail; size_t num_incomming = 0; // number of incomming blocks to our tail iter = lst.begin (); for (size_t i = 0; iter != lst.end (); ++iter, ++i) { tree_if_clause *tic = *iter; block = entry_blocks[i]; assert (block); if (i) // the first block is prev_block, so it has already been added append (entry_blocks[i]); if (! tic->is_else_clause ()) { tree_expression *expr = tic->condition (); jit_value *cond = visit (expr); jit_call *check = create_checked (&jit_typeinfo::logically_true, cond); jit_block *body = create<jit_block> (i == 0 ? "if_body" : "ifelse_body"); append (body); jit_instruction *br = create<jit_cond_branch> (check, body, entry_blocks[i + 1]); block->append (br); block = body; } tree_statement_list *stmt_lst = tic->commands (); assert (stmt_lst); // jwe: Can this be null? stmt_lst->accept (*this); if (breaking) breaking = false; else { ++num_incomming; block->append (create<jit_branch> (tail)); } } if (num_incomming || ! last_else) { append (tail); block = tail; } else // every branch broke, so we don't have a tail breaking = true; } void jit_convert::visit_index_expression (tree_index_expression& exp) { result = resolve (jit_typeinfo::paren_subsref (), exp); } void jit_convert::visit_matrix (tree_matrix&) { throw jit_fail_exception (); } void jit_convert::visit_cell (tree_cell&) { throw jit_fail_exception (); } void jit_convert::visit_multi_assignment (tree_multi_assignment&) { throw jit_fail_exception (); } void jit_convert::visit_no_op_command (tree_no_op_command&) { throw jit_fail_exception (); } void jit_convert::visit_constant (tree_constant& tc) { octave_value v = tc.rvalue1 (); if (v.is_real_scalar () && v.is_double_type ()) { double dv = v.double_value (); result = create<jit_const_scalar> (dv); } else if (v.is_range ()) { Range rv = v.range_value (); result = create<jit_const_range> (rv); } else if (v.is_complex_scalar ()) { Complex cv = v.complex_value (); result = create<jit_const_complex> (cv); } else throw jit_fail_exception ("Unknown constant"); } void jit_convert::visit_fcn_handle (tree_fcn_handle&) { throw jit_fail_exception (); } void jit_convert::visit_parameter_list (tree_parameter_list&) { throw jit_fail_exception (); } void jit_convert::visit_postfix_expression (tree_postfix_expression&) { throw jit_fail_exception (); } void jit_convert::visit_prefix_expression (tree_prefix_expression&) { throw jit_fail_exception (); } void jit_convert::visit_return_command (tree_return_command&) { throw jit_fail_exception (); } void jit_convert::visit_return_list (tree_return_list&) { throw jit_fail_exception (); } void jit_convert::visit_simple_assignment (tree_simple_assignment& tsa) { if (tsa.op_type () != octave_value::op_asn_eq) throw jit_fail_exception ("Unsupported assign"); // resolve rhs tree_expression *rhs = tsa.right_hand_side (); jit_value *rhsv = visit (rhs); result = do_assign (tsa.left_hand_side (), rhsv); } void jit_convert::visit_statement (tree_statement& stmt) { tree_command *cmd = stmt.command (); tree_expression *expr = stmt.expression (); if (cmd) visit (cmd); else { // stolen from tree_evaluator::visit_statement bool do_bind_ans = false; if (expr->is_identifier ()) { tree_identifier *id = dynamic_cast<tree_identifier *> (expr); do_bind_ans = (! id->is_variable ()); } else do_bind_ans = (! expr->is_assignment_expression ()); jit_value *expr_result = visit (expr); if (do_bind_ans) do_assign ("ans", expr_result, expr->print_result ()); else if (expr->is_identifier () && expr->print_result ()) { // FIXME: ugly hack, we need to come up with a way to pass // nargout to visit_identifier const jit_operation& fn = jit_typeinfo::print_value (); jit_const_string *name = create<jit_const_string> (expr->name ()); block->append (create<jit_call> (fn, name, expr_result)); } } } void jit_convert::visit_statement_list (tree_statement_list& lst) { for (tree_statement_list::iterator iter = lst.begin (); iter != lst.end(); ++iter) { tree_statement *elt = *iter; // jwe: Can this ever be null? assert (elt); elt->accept (*this); if (breaking) break; } } void jit_convert::visit_switch_case (tree_switch_case&) { throw jit_fail_exception (); } void jit_convert::visit_switch_case_list (tree_switch_case_list&) { throw jit_fail_exception (); } void jit_convert::visit_switch_command (tree_switch_command&) { throw jit_fail_exception (); } void jit_convert::visit_try_catch_command (tree_try_catch_command&) { throw jit_fail_exception (); } void jit_convert::visit_unwind_protect_command (tree_unwind_protect_command&) { throw jit_fail_exception (); } void jit_convert::visit_while_command (tree_while_command& wc) { assert (! breaking); unwind_protect prot; prot.protect_var (breaks); prot.protect_var (continues); prot.protect_var (breaking); breaks.clear (); continues.clear (); jit_block *cond_check = create<jit_block> ("while_cond_check"); block->append (create<jit_branch> (cond_check)); append (cond_check); block = cond_check; tree_expression *expr = wc.condition (); assert (expr && "While expression can not be null"); jit_value *check = visit (expr); check = create_checked (&jit_typeinfo::logically_true, check); jit_block *body = create<jit_block> ("while_body"); append (body); jit_block *tail = create<jit_block> ("while_tail"); block->append (create<jit_cond_branch> (check, body, tail)); block = body; tree_statement_list *loop_body = wc.body (); if (loop_body) loop_body->accept (*this); finish_breaks (tail, breaks); finish_breaks (cond_check, continues); if (! breaking) block->append (create<jit_branch> (cond_check)); append (tail); block = tail; } void jit_convert::visit_do_until_command (tree_do_until_command&) { throw jit_fail_exception (); } void jit_convert::append (jit_block *ablock) { blocks.push_back (ablock); ablock->stash_location (--blocks.end ()); } void jit_convert::insert_before (block_iterator iter, jit_block *ablock) { iter = blocks.insert (iter, ablock); ablock->stash_location (iter); } void jit_convert::insert_after (block_iterator iter, jit_block *ablock) { ++iter; insert_before (iter, ablock); } jit_variable * jit_convert::find_variable (const std::string& vname) const { vmap_t::const_iterator iter; iter = vmap.find (vname); return iter != vmap.end () ? iter->second : 0; } jit_variable * jit_convert::get_variable (const std::string& vname) { jit_variable *ret = find_variable (vname); if (ret) return ret; octave_value val = symbol_table::find (vname); jit_type *type = jit_typeinfo::type_of (val); return create_variable (vname, type); } jit_variable * jit_convert::create_variable (const std::string& vname, jit_type *type) { jit_variable *var = create<jit_variable> (vname); jit_extract_argument *extract; extract = create<jit_extract_argument> (type, var); entry_block->prepend (extract); return vmap[vname] = var; } std::string jit_convert::next_name (const char *prefix, size_t& count, bool inc) { std::stringstream ss; ss << prefix << count; if (inc) ++count; return ss.str (); } jit_instruction * jit_convert::resolve (const jit_operation& fres, tree_index_expression& exp, jit_value *extra_arg) { std::string type = exp.type_tags (); if (! (type.size () == 1 && type[0] == '(')) throw jit_fail_exception ("Unsupported index operation"); std::list<tree_argument_list *> args = exp.arg_lists (); if (args.size () != 1) throw jit_fail_exception ("Bad number of arguments in tree_index_expression"); tree_argument_list *arg_list = args.front (); if (! arg_list) throw jit_fail_exception ("null argument list"); if (arg_list->size () < 1) throw jit_fail_exception ("Empty arg_list"); tree_expression *tree_object = exp.expression (); jit_value *object = visit (tree_object); size_t narg = arg_list->size (); tree_argument_list::iterator iter = arg_list->begin (); bool have_extra = extra_arg; std::vector<jit_value *> call_args (narg + 1 + have_extra); call_args[0] = object; for (size_t idx = 0; iter != arg_list->end (); ++idx, ++iter) { unwind_protect prot; prot.add_method (&end_context, &std::vector<jit_magic_end::context>::pop_back); end_context.push_back (jit_magic_end::context (object, idx, narg)); call_args[idx + 1] = visit (*iter); } if (extra_arg) call_args[call_args.size () - 1] = extra_arg; return create_checked (fres, call_args); } jit_value * jit_convert::do_assign (tree_expression *exp, jit_value *rhs, bool artificial) { if (! exp) throw jit_fail_exception ("NULL lhs in assign"); if (isa<tree_identifier> (exp)) return do_assign (exp->name (), rhs, exp->print_result (), artificial); else if (tree_index_expression *idx = dynamic_cast<tree_index_expression *> (exp)) { jit_value *new_object = resolve (jit_typeinfo::paren_subsasgn (), *idx, rhs); do_assign (idx->expression (), new_object, true); // FIXME: Will not work for values that must be release/grabed return rhs; } else throw jit_fail_exception ("Unsupported assignment"); } jit_value * jit_convert::do_assign (const std::string& lhs, jit_value *rhs, bool print, bool artificial) { jit_variable *var = get_variable (lhs); jit_assign *assign = block->append (create<jit_assign> (var, rhs)); if (artificial) assign->mark_artificial (); if (print) { const jit_operation& print_fn = jit_typeinfo::print_value (); jit_const_string *name = create<jit_const_string> (lhs); block->append (create<jit_call> (print_fn, name, var)); } return var; } jit_value * jit_convert::visit (tree& tee) { result = 0; tee.accept (*this); jit_value *ret = result; result = 0; return ret; } void jit_convert::append_users_term (jit_terminator *term) { for (size_t i = 0; i < term->successor_count (); ++i) { if (term->alive (i)) { jit_block *succ = term->successor (i); for (jit_block::iterator iter = succ->begin (); iter != succ->end () && isa<jit_phi> (*iter); ++iter) push_worklist (*iter); jit_terminator *sterm = succ->terminator (); if (sterm) push_worklist (sterm); } } } void jit_convert::merge_blocks (void) { std::vector<jit_block *> dead; for (block_list::iterator iter = blocks.begin (); iter != blocks.end (); ++iter) { jit_block *b = *iter; jit_block *merged = b->maybe_merge (); if (merged) { if (merged == final_block) final_block = b; if (merged == entry_block) entry_block = b; dead.push_back (merged); } } for (size_t i = 0; i < dead.size (); ++i) blocks.erase (dead[i]->location ()); } void jit_convert::construct_ssa (void) { merge_blocks (); final_block->label (); final_block->compute_idom (entry_block); entry_block->compute_df (); entry_block->create_dom_tree (); // insert phi nodes where needed, this is done on a per variable basis for (vmap_t::iterator iter = vmap.begin (); iter != vmap.end (); ++iter) { jit_block::df_set visited, added_phi; std::list<jit_block *> ssa_worklist; iter->second->use_blocks (visited); ssa_worklist.insert (ssa_worklist.begin (), visited.begin (), visited.end ()); while (ssa_worklist.size ()) { jit_block *b = ssa_worklist.front (); ssa_worklist.pop_front (); for (jit_block::df_iterator diter = b->df_begin (); diter != b->df_end (); ++diter) { jit_block *dblock = *diter; if (! added_phi.count (dblock)) { jit_phi *phi = create<jit_phi> (iter->second, dblock->use_count ()); dblock->prepend (phi); added_phi.insert (dblock); } if (! visited.count (dblock)) { ssa_worklist.push_back (dblock); visited.insert (dblock); } } } } do_construct_ssa (*entry_block, entry_block->visit_count ()); } void jit_convert::do_construct_ssa (jit_block& ablock, size_t avisit_count) { if (ablock.visited (avisit_count)) return; // replace variables with their current SSA value for (jit_block::iterator iter = ablock.begin (); iter != ablock.end (); ++iter) { jit_instruction *instr = *iter; instr->construct_ssa (); instr->push_variable (); } // finish phi nodes of successors for (size_t i = 0; i < ablock.successor_count (); ++i) { jit_block *finish = ablock.successor (i); for (jit_block::iterator iter = finish->begin (); iter != finish->end () && isa<jit_phi> (*iter);) { jit_phi *phi = static_cast<jit_phi *> (*iter); jit_variable *var = phi->dest (); if (var->has_top ()) { phi->add_incomming (&ablock, var->top ()); ++iter; } else { // temporaries may have extranious phi nodes which can be removed assert (! phi->use_count ()); assert (var->name ().size () && var->name ()[0] == '#'); iter = finish->remove (iter); } } } for (size_t i = 0; i < ablock.dom_successor_count (); ++i) do_construct_ssa (*ablock.dom_successor (i), avisit_count); ablock.pop_all (); } void jit_convert::remove_dead () { block_list::iterator biter; for (biter = blocks.begin (); biter != blocks.end (); ++biter) { jit_block *b = *biter; if (b->alive ()) { for (jit_block::iterator iter = b->begin (); iter != b->end () && isa<jit_phi> (*iter);) { jit_phi *phi = static_cast<jit_phi *> (*iter); if (phi->prune ()) iter = b->remove (iter); else ++iter; } } } for (biter = blocks.begin (); biter != blocks.end ();) { jit_block *b = *biter; if (b->alive ()) { // FIXME: A special case for jit_error_check, if we generalize to // we will need to change! jit_terminator *term = b->terminator (); if (term && term->successor_count () == 2 && ! term->alive (0)) { jit_block *succ = term->successor (1); term->remove (); jit_branch *abreak = b->append (create<jit_branch> (succ)); abreak->infer (); } ++biter; } else { jit_terminator *term = b->terminator (); if (term) term->remove (); biter = blocks.erase (biter); } } } void jit_convert::place_releases (void) { std::set<jit_value *> temporaries; for (block_list::iterator iter = blocks.begin (); iter != blocks.end (); ++iter) { jit_block& ablock = **iter; if (ablock.id () != jit_block::NO_ID) { release_temp (ablock, temporaries); release_dead_phi (ablock); } } } void jit_convert::release_temp (jit_block& ablock, std::set<jit_value *>& temp) { for (jit_block::iterator iter = ablock.begin (); iter != ablock.end (); ++iter) { jit_instruction *instr = *iter; // check for temporaries that require release and live across // multiple blocks if (instr->needs_release ()) { jit_block *fu_block = instr->first_use_block (); if (fu_block && fu_block != &ablock) temp.insert (instr); } if (isa<jit_call> (instr)) { // place releases for temporary arguments for (size_t i = 0; i < instr->argument_count (); ++i) { jit_value *arg = instr->argument (i); if (arg->needs_release ()) { jit_call *release = create<jit_call> (&jit_typeinfo::release, arg); release->infer (); ablock.insert_after (iter, release); ++iter; temp.erase (arg); } } } } if (! temp.size () || ! isa<jit_error_check> (ablock.terminator ())) return; // FIXME: If we support try/catch or unwind_protect final_block may not be the // destination jit_block *split = ablock.maybe_split (*this, final_block); jit_terminator *term = split->terminator (); for (std::set<jit_value *>::const_iterator iter = temp.begin (); iter != temp.end (); ++iter) { jit_value *value = *iter; jit_call *release = create<jit_call> (&jit_typeinfo::release, value); split->insert_before (term, release); release->infer (); } } void jit_convert::release_dead_phi (jit_block& ablock) { jit_block::iterator iter = ablock.begin (); while (iter != ablock.end () && isa<jit_phi> (*iter)) { jit_phi *phi = static_cast<jit_phi *> (*iter); ++iter; jit_use *use = phi->first_use (); if (phi->use_count () == 1 && isa<jit_assign> (use->user ())) { // instead of releasing on assign, release on all incomming branches, // this can get rid of casts inside loops for (size_t i = 0; i < phi->argument_count (); ++i) { jit_value *arg = phi->argument (i); jit_block *inc = phi->incomming (i); jit_block *split = inc->maybe_split (*this, ablock); jit_terminator *term = split->terminator (); jit_call *release = create<jit_call> (jit_typeinfo::release, arg); release->infer (); split->insert_before (term, release); } phi->replace_with (0); phi->remove (); } } } void jit_convert::simplify_phi (void) { for (block_list::iterator biter = blocks.begin (); biter != blocks.end (); ++biter) { jit_block &ablock = **biter; for (jit_block::iterator iter = ablock.begin (); iter != ablock.end () && isa<jit_phi> (*iter); ++iter) simplify_phi (*static_cast<jit_phi *> (*iter)); } } void jit_convert::simplify_phi (jit_phi& phi) { jit_block& pblock = *phi.parent (); const jit_operation& cast_fn = jit_typeinfo::cast (phi.type ()); jit_variable *dest = phi.dest (); for (size_t i = 0; i < phi.argument_count (); ++i) { jit_value *arg = phi.argument (i); if (arg->type () != phi.type ()) { jit_block *pred = phi.incomming (i); jit_block *split = pred->maybe_split (*this, pblock); jit_terminator *term = split->terminator (); jit_instruction *cast = create<jit_call> (cast_fn, arg); jit_assign *assign = create<jit_assign> (dest, cast); split->insert_before (term, cast); split->insert_before (term, assign); cast->infer (); assign->infer (); phi.stash_argument (i, assign); } } } void jit_convert::finish_breaks (jit_block *dest, const block_list& lst) { for (block_list::const_iterator iter = lst.begin (); iter != lst.end (); ++iter) { jit_block *b = *iter; b->append (create<jit_branch> (dest)); } } // -------------------- jit_convert::convert_llvm -------------------- llvm::Function * jit_convert::convert_llvm::convert (llvm::Module *module, const std::vector<std::pair< std::string, bool> >& args, const std::list<jit_block *>& blocks, const std::list<jit_value *>& constants) { jit_type *any = jit_typeinfo::get_any (); // argument is an array of octave_base_value*, or octave_base_value** llvm::Type *arg_type = any->to_llvm (); // this is octave_base_value* arg_type = arg_type->getPointerTo (); llvm::FunctionType *ft = llvm::FunctionType::get (llvm::Type::getVoidTy (context), arg_type, false); function = llvm::Function::Create (ft, llvm::Function::ExternalLinkage, "foobar", module); try { prelude = llvm::BasicBlock::Create (context, "prelude", function); builder.SetInsertPoint (prelude); llvm::Value *arg = function->arg_begin (); for (size_t i = 0; i < args.size (); ++i) { llvm::Value *loaded_arg = builder.CreateConstInBoundsGEP1_32 (arg, i); arguments[args[i].first] = loaded_arg; } std::list<jit_block *>::const_iterator biter; for (biter = blocks.begin (); biter != blocks.end (); ++biter) { jit_block *jblock = *biter; llvm::BasicBlock *block = llvm::BasicBlock::Create (context, jblock->name (), function); jblock->stash_llvm (block); } jit_block *first = *blocks.begin (); builder.CreateBr (first->to_llvm ()); // constants aren't in the IR, we visit those first for (std::list<jit_value *>::const_iterator iter = constants.begin (); iter != constants.end (); ++iter) if (! isa<jit_instruction> (*iter)) visit (*iter); // convert all instructions for (biter = blocks.begin (); biter != blocks.end (); ++biter) visit (*biter); // now finish phi nodes for (biter = blocks.begin (); biter != blocks.end (); ++biter) { jit_block& block = **biter; for (jit_block::iterator piter = block.begin (); piter != block.end () && isa<jit_phi> (*piter); ++piter) { jit_instruction *phi = *piter; finish_phi (static_cast<jit_phi *> (phi)); } } jit_block *last = blocks.back (); builder.SetInsertPoint (last->to_llvm ()); builder.CreateRetVoid (); } catch (const jit_fail_exception& e) { function->eraseFromParent (); throw; } return function; } void jit_convert::convert_llvm::finish_phi (jit_phi *phi) { llvm::PHINode *llvm_phi = phi->to_llvm (); for (size_t i = 0; i < phi->argument_count (); ++i) { llvm::BasicBlock *pred = phi->incomming_llvm (i); llvm_phi->addIncoming (phi->argument_llvm (i), pred); } } void jit_convert::convert_llvm::visit (jit_const_string& cs) { cs.stash_llvm (builder.CreateGlobalStringPtr (cs.value ())); } void jit_convert::convert_llvm::visit (jit_const_bool& cb) { cb.stash_llvm (llvm::ConstantInt::get (cb.type_llvm (), cb.value ())); } void jit_convert::convert_llvm::visit (jit_const_scalar& cs) { cs.stash_llvm (llvm::ConstantFP::get (cs.type_llvm (), cs.value ())); } void jit_convert::convert_llvm::visit (jit_const_complex& cc) { llvm::Type *scalar_t = jit_typeinfo::get_scalar_llvm (); llvm::Constant *values[2]; Complex value = cc.value (); values[0] = llvm::ConstantFP::get (scalar_t, value.real ()); values[1] = llvm::ConstantFP::get (scalar_t, value.imag ()); cc.stash_llvm (llvm::ConstantVector::get (values)); } void jit_convert::convert_llvm::visit (jit_const_index& ci) { ci.stash_llvm (llvm::ConstantInt::get (ci.type_llvm (), ci.value ())); } void jit_convert::convert_llvm::visit (jit_const_range& cr) { llvm::StructType *stype = llvm::cast<llvm::StructType>(cr.type_llvm ()); llvm::Type *scalar_t = jit_typeinfo::get_scalar_llvm (); llvm::Type *idx = jit_typeinfo::get_index_llvm (); const jit_range& rng = cr.value (); llvm::Constant *constants[4]; constants[0] = llvm::ConstantFP::get (scalar_t, rng.base); constants[1] = llvm::ConstantFP::get (scalar_t, rng.limit); constants[2] = llvm::ConstantFP::get (scalar_t, rng.inc); constants[3] = llvm::ConstantInt::get (idx, rng.nelem); llvm::Value *as_llvm; as_llvm = llvm::ConstantStruct::get (stype, llvm::makeArrayRef (constants, 4)); cr.stash_llvm (as_llvm); } void jit_convert::convert_llvm::visit (jit_block& b) { llvm::BasicBlock *block = b.to_llvm (); builder.SetInsertPoint (block); for (jit_block::iterator iter = b.begin (); iter != b.end (); ++iter) visit (*iter); } void jit_convert::convert_llvm::visit (jit_branch& b) { b.stash_llvm (builder.CreateBr (b.successor_llvm ())); } void jit_convert::convert_llvm::visit (jit_cond_branch& cb) { llvm::Value *cond = cb.cond_llvm (); llvm::Value *br; br = builder.CreateCondBr (cond, cb.successor_llvm (0), cb.successor_llvm (1)); cb.stash_llvm (br); } void jit_convert::convert_llvm::visit (jit_call& call) { const jit_function& ol = call.overload (); std::vector<jit_value *> args (call.arguments ().size ()); for (size_t i = 0; i < args.size (); ++i) args[i] = call.argument (i); llvm::Value *ret = ol.call (builder, args); call.stash_llvm (ret); } void jit_convert::convert_llvm::visit (jit_extract_argument& extract) { llvm::Value *arg = arguments[extract.name ()]; assert (arg); arg = builder.CreateLoad (arg); const jit_function& ol = extract.overload (); extract.stash_llvm (ol.call (builder, arg)); } void jit_convert::convert_llvm::visit (jit_store_argument& store) { const jit_function& ol = store.overload (); llvm::Value *arg_value = ol.call (builder, store.result ()); llvm::Value *arg = arguments[store.name ()]; store.stash_llvm (builder.CreateStore (arg_value, arg)); } void jit_convert::convert_llvm::visit (jit_phi& phi) { // we might not have converted all incoming branches, so we don't // set incomming branches now llvm::PHINode *node = llvm::PHINode::Create (phi.type_llvm (), phi.argument_count ()); builder.Insert (node); phi.stash_llvm (node); } void jit_convert::convert_llvm::visit (jit_variable&) { throw jit_fail_exception ("ERROR: SSA construction should remove all variables"); } void jit_convert::convert_llvm::visit (jit_error_check& check) { llvm::Value *cond = jit_typeinfo::insert_error_check (builder); llvm::Value *br = builder.CreateCondBr (cond, check.successor_llvm (0), check.successor_llvm (1)); check.stash_llvm (br); } void jit_convert::convert_llvm::visit (jit_assign& assign) { jit_value *new_value = assign.src (); assign.stash_llvm (new_value->to_llvm ()); if (assign.artificial ()) return; if (isa<jit_assign_base> (new_value)) { const jit_function& ol = jit_typeinfo::get_grab (new_value->type ()); if (ol.valid ()) assign.stash_llvm (ol.call (builder, new_value)); } jit_value *overwrite = assign.overwrite (); if (isa<jit_assign_base> (overwrite)) { const jit_function& ol = jit_typeinfo::get_release (overwrite->type ()); ol.call (builder, overwrite); } } void jit_convert::convert_llvm::visit (jit_argument&) {} void jit_convert::convert_llvm::visit (jit_magic_end& me) { const jit_function& ol = me.overload (); llvm::Value *ret = ol.call (builder, me.resolve_context ()); me.stash_llvm (ret); } // -------------------- tree_jit -------------------- tree_jit::tree_jit (void) : module (0), engine (0) { } tree_jit::~tree_jit (void) {} bool tree_jit::execute (tree_simple_for_command& cmd, const octave_value& bounds) { const size_t MIN_TRIP_COUNT = 1000; size_t tc = trip_count (bounds); if (! tc || ! initialize ()) return false; jit_info::vmap extra_vars; extra_vars["#for_bounds0"] = &bounds; jit_info *info = cmd.get_info (); if (! info || ! info->match (extra_vars)) { if (tc < MIN_TRIP_COUNT) return false; delete info; info = new jit_info (*this, cmd, bounds); cmd.stash_info (info); } return info->execute (extra_vars); } bool tree_jit::execute (tree_while_command& cmd) { if (! initialize ()) return false; jit_info *info = cmd.get_info (); if (! info || ! info->match ()) { delete info; info = new jit_info (*this, cmd); cmd.stash_info (info); } return info->execute (); } bool tree_jit::initialize (void) { if (engine) return true; if (! module) { llvm::InitializeNativeTarget (); module = new llvm::Module ("octave", context); } // sometimes this fails pre main engine = llvm::ExecutionEngine::createJIT (module); if (! engine) return false; module_pass_manager = new llvm::PassManager (); module_pass_manager->add (llvm::createAlwaysInlinerPass ()); pass_manager = new llvm::FunctionPassManager (module); pass_manager->add (new llvm::TargetData(*engine->getTargetData ())); pass_manager->add (llvm::createBasicAliasAnalysisPass ()); pass_manager->add (llvm::createPromoteMemoryToRegisterPass ()); pass_manager->add (llvm::createInstructionCombiningPass ()); pass_manager->add (llvm::createReassociatePass ()); pass_manager->add (llvm::createGVNPass ()); pass_manager->add (llvm::createCFGSimplificationPass ()); pass_manager->doInitialization (); jit_typeinfo::initialize (module, engine); return true; } size_t tree_jit::trip_count (const octave_value& bounds) const { if (bounds.is_range ()) { Range rng = bounds.range_value (); return rng.nelem (); } // unsupported type return 0; } void tree_jit::optimize (llvm::Function *fn) { module_pass_manager->run (*module); pass_manager->run (*fn); #ifdef OCTAVE_JIT_DEBUG std::string error; llvm::raw_fd_ostream fout ("test.bc", error, llvm::raw_fd_ostream::F_Binary); llvm::WriteBitcodeToFile (module, fout); #endif } // -------------------- jit_info -------------------- jit_info::jit_info (tree_jit& tjit, tree& tee) : engine (tjit.get_engine ()), function (0), llvm_function (0) { try { jit_convert conv (tjit.get_module (), tee); initialize (tjit, conv); } catch (const jit_fail_exception& e) { #ifdef OCTAVE_JIT_DEBUG if (e.known ()) std::cout << "jit fail: " << e.what () << std::endl; #endif } } jit_info::jit_info (tree_jit& tjit, tree& tee, const octave_value& for_bounds) : engine (tjit.get_engine ()), function (0), llvm_function (0) { try { jit_convert conv (tjit.get_module (), tee, jit_typeinfo::type_of (for_bounds)); initialize (tjit, conv); } catch (const jit_fail_exception& e) { #ifdef OCTAVE_JIT_DEBUG if (e.known ()) std::cout << "jit fail: " << e.what () << std::endl; #endif } } jit_info::~jit_info (void) { if (llvm_function) llvm_function->eraseFromParent (); } bool jit_info::execute (const vmap& extra_vars) const { if (! function) return false; std::vector<octave_base_value *> real_arguments (arguments.size ()); for (size_t i = 0; i < arguments.size (); ++i) { if (arguments[i].second) { octave_value current = find (extra_vars, arguments[i].first); octave_base_value *obv = current.internal_rep (); obv->grab (); real_arguments[i] = obv; } } function (&real_arguments[0]); for (size_t i = 0; i < arguments.size (); ++i) { const std::string& name = arguments[i].first; // do not store for loop bounds temporary if (name.size () && name[0] != '#') symbol_table::varref (arguments[i].first) = real_arguments[i]; } return true; } bool jit_info::match (const vmap& extra_vars) const { if (! function) return true; for (size_t i = 0; i < bounds.size (); ++i) { const std::string& arg_name = bounds[i].second; octave_value value = find (extra_vars, arg_name); jit_type *type = jit_typeinfo::type_of (value); // FIXME: Check for a parent relationship if (type != bounds[i].first) return false; } return true; } void jit_info::initialize (tree_jit& tjit, jit_convert& conv) { llvm_function = conv.get_function (); arguments = conv.get_arguments (); bounds = conv.get_bounds (); if (llvm_function) { tjit.optimize (llvm_function); #ifdef OCTAVE_JIT_DEBUG std::cout << "-------------------- optimized llvm ir " << "--------------------\n"; llvm::raw_os_ostream llvm_cout (std::cout); llvm_function->print (llvm_cout); llvm_cout.flush (); std::cout << std::endl; #endif void *void_fn = engine->getPointerToFunction (llvm_function); function = reinterpret_cast<jited_function> (void_fn); } } octave_value jit_info::find (const vmap& extra_vars, const std::string& vname) const { vmap::const_iterator iter = extra_vars.find (vname); return iter == extra_vars.end () ? symbol_table::varval (vname) : *iter->second; } #endif /* Test some simple cases that compile. %!test %! inc = 1e-5; %! result = 0; %! for ii = 0:inc:1 %! result = result + inc * (1/3 * ii * ii); %! endfor %! assert (abs (result - 1/9) < 1e-5); %!test %! inc = 1e-5; %! result = 0; %! for ii = 0:inc:1 %! # the ^ operator's result is complex %! result = result + inc * (1/3 * ii ^ 2); %! endfor %! assert (abs (result - 1/9) < 1e-5); %!test %! nr = 1001; %! mat = zeros (1, nr); %! for i = 1:nr %! mat(i) = i; %! endfor %! assert (mat == 1:nr); %!test %! nr = 1001; %! mat = 1:nr; %! mat(end) = 0; # force mat to a matrix %! total = 0; %! for i = 1:nr %! total = mat(i) + total; %! endfor %! assert (sum (mat) == total); %!test %! nr = 1001; %! mat = [3 1 5]; %! try %! for i = 1:nr %! if i > 500 %! result = mat(100); %! else %! result = i; %! endif %! endfor %! catch %! end %! assert (result == 500); %!function result = gen_test (n) %! result = double (rand (1, n) > .01); %!endfunction %!function z = vectorized (A, K) %! temp = ones (1, K); %! z = conv (A, temp); %! z = z > K-1; %! z = conv (z, temp); %! z = z(K:end-K+1); %! z = z >= 1; %!endfunction %!function z = loopy (A, K) %! z = A; %! n = numel (A); %! counter = 0; %! for ii=1:n %! if z(ii) %! counter = counter + 1; %! else %! if counter > 0 && counter < K %! z(ii-counter:ii-1) = 0; %! endif %! counter = 0; %! endif %! endfor %! %! if counter > 0 && counter < K %! z(end-counter+1:end) = 0; %! endif %!endfunction %!test %! test_set = gen_test (10000); %! assert (all (vectorized (test_set, 3) == loopy (test_set, 3))); %!test %! niter = 1001; %! i = 0; %! while (i < niter) %! i = i + 1; %! endwhile %! assert (i == niter); %!test %! niter = 1001; %! result = 0; %! m = [5 10]; %! for i=1:niter %! result = result + m(end); %! endfor %! assert (result == m(end) * niter); %!test %! ndim = 100; %! result = 0; %! m = zeros (ndim); %! m(:) = 1:ndim^2; %! i = 1; %! while (i <= ndim) %! for j = 1:ndim %! result = result + m(i, j); %! endfor %! i = i + 1; %! endwhile %! assert (result == sum (sum (m))); %!test %! ndim = 100; %! m = zeros (ndim); %! i = 1; %! while (i <= ndim) %! for j = 1:ndim %! m(i, j) = (j - 1) * ndim + i; %! endfor %! i = i + 1; %! endwhile %! m2 = zeros (ndim); %! m2(:) = 1:(ndim^2); %! assert (all (m == m2)); %!test %! ndim = 2; %! m = zeros (ndim, ndim, ndim, ndim); %! result = 0; %! i0 = 1; %! while (i0 <= ndim) %! for i1 = 1:ndim %! for i2 = 1:ndim %! for i3 = 1:ndim %! m(i0, i1, i2, i3) = 1; %! m(i0, i1, i2, i3, 1, 1, 1, 1, 1, 1) = 1; %! result = result + m(i0, i1, i2, i3); %! endfor %! endfor %! endfor %! i0 = i0 + 1; %! endwhile %! expected = ones (ndim, ndim, ndim, ndim); %! assert (all (m == expected)); %! assert (result == sum (expected (:))); %!function test_divide () %! state = warning ("query", "Octave:divide-by-zero").state; %! unwind_protect %! warning ("error", "Octave:divide-by-zero"); %! for i=1:1e5 %! a = 1; %! a / 0; %! endfor %! unwind_protect_cleanup %! warning (state, "Octave:divide-by-zero"); %! end_unwind_protect %!endfunction %!error <division by zero> test_divide () %!test %! while 1 %! a = 0; %! result = a / 1; %! break; %! endwhile %! assert (result, 0); */