Mercurial > octave-nkf
view libinterp/corefcn/profiler.h @ 20569:b70cc4bd8109
begin removal of global error_state variable
* gripes.h, gripes.cc (gripe_library_execution_error): Delete.
* error.cc (warning_state): Delete unused variable.
(reset_error_handler): Don't set warning_state or error_state.
(debug_or_throw_exception): New static function.
(verror): Don't check error_state.
(vmessage): Call debug_or_throw_exception instead of setting
error_state.
(error_1, error_2): Combine into single function, error_1 that prints
error message and ultimately calls debug_or_throw_exception.
(verror, verror_with_cfn, verror_with_id_cfn): Call error_1. Don't
check or set warning_state.
(error): Don't check error_state.
(Flasterror, Flasterr): Adapt to not using error_state.
(interpreter_try): Don't unwind_protect error_state.
* NEWS: Update.
* doc/interpreter/external.txi: Explain octave_execution_exception
instead of error_state for matrix addition example.
* jit-typeinfo.cc (octave_jit_gripe_nan_to_logical_conversion,
octave_jit_ginvalid_index, octave_jit_gindex_range,
octave_jit_paren_scalar, octave_jit_paren_scalar_subsasgn):
Don't catch octave_execution_exception.
* cellfun.cc (Fcellfun): Use exceptions instead of error_state.
* ls-mat-ascii.cc (save_mat_ascii_data): Likewise.
* mex.cc (mexCallMATLAB, mexEvalString): Likewise.
* variables.cc (safe_symbol_lookup): Likewise.
* svd.cc (Fsvd): Eliminate use of error_state.
* __magick_read__.cc (read_file, write_file): Likewise.
* variables.cc (generate_struct_completions): Eliminate use of
obsolete warning_state variable.
* ov-builtin.cc (octave_builtin::do_multi_index_op): Don't catch
octave_execution_exception and call gripe_library_execution_error.
* ov-class.cc (octave_class::reconstruct_exemplar): Eliminate use of
error_state. Catch possible octave_execution_exception in
do_multi_index_op.
* ov-mex-fcn.cc (octave_mex_function::do_multi_index_op): Eliminate
use of error_state. Catch possible octave_execution_exception in
call_mex.
* ov-fcn-handle.cc (octave_fcn_binder::maybe_binder): Eliminate use of
error_state.
* ov-oncleanup.cc (octave_oncleanup::~octave_oncleanup): Eliminate use
of error_state. Propagate possible octave_execution_exception from
do_multi_index_op.
* ov.cc (octave_value::assign, do_binary_op, do_unary_op,
octave_value::do_non_const_unary_op): Don't catch
octave_execution_exception here.
* oct-parse.in.yy (octave_base_parser::finish_colon_expression,
octave_base_parser::finish_array_list): Eliminate use of warning_state
and error_state.
(Feval, Fevalin): Use exceptions instead of error_state.
* pt-eval.cc, pt-eval.h (tree_evaluator::unwind_protect_exception):
New static variable.
* (tree_evaluator::visit_statement): Don't catch
octave_execution_exception here.
(tree_evaluator::visit_try_catch_command,
tree_evaluator::do_unwind_protect_cleanup): Eliminate use of error_state.
(tree_evaluator::visit_unwind_protect_command): Use
unwind_protect_exception to track whether an exception has occurred in
the try block.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Thu, 01 Oct 2015 16:18:19 -0400 |
parents | 4197fc428c7d |
children |
line wrap: on
line source
/* Copyright (C) 2014-2015 Julien Bect Copyright (C) 2012-2015 Daniel Kraft 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/>. */ #if !defined (octave_profiler_h) #define octave_profiler_h 1 #include <cstddef> #include <map> #include <set> #include <string> #include <vector> class octave_value; class OCTINTERP_API profile_data_accumulator { public: // This is a utility class that can be used to call the enter/exit // functions in a manner protected from stack unwinding. template<class T> class enter { private: profile_data_accumulator& acc; std::string fcn; bool is_active; public: enter (profile_data_accumulator& a, const T& t) : acc (a) { // A profiling block cannot be active if the profiler is not is_active = acc.is_active (); if (is_active) { fcn = t.profiler_name (); // NOTE: The test f != "" must be kept to prevent a blank line showing // up in profiler statistics. See bug #39524. The root cause is that // the function name is not set for the recurring readline hook function. if (fcn == "") is_active = false; // Inactive profiling block else acc.enter_function (fcn); } } ~enter () { if (is_active) acc.exit_function (fcn); } private: // No copying! enter (const enter&); enter& operator = (const enter&); }; profile_data_accumulator (void); virtual ~profile_data_accumulator (); bool is_active (void) const { return enabled; } void set_active (bool); void reset (void); octave_value get_flat (void) const; octave_value get_hierarchical (void) const; private: // One entry in the flat profile (i.e., a collection of data for a single // function). This is filled in when building the flat profile from the // hierarchical call tree. struct stats { stats (); double time; unsigned calls; bool recursive; typedef std::set<octave_idx_type> function_set; function_set parents; function_set children; // Convert a function_set list to an Octave array of indices. static octave_value function_set_value (const function_set&); }; typedef std::vector<stats> flat_profile; // Store data for one node in the call-tree of the hierarchical profiler // data we collect. class tree_node { public: tree_node (tree_node*, octave_idx_type); virtual ~tree_node (); void add_time (double dt) { time += dt; } // Enter a child function. It is created in the list of children if it // wasn't already there. The now-active child node is returned. tree_node* enter (octave_idx_type); // Exit function. As a sanity-check, it is verified that the currently // active function actually is the one handed in here. Returned is the // then-active node, which is our parent. tree_node* exit (octave_idx_type); void build_flat (flat_profile&) const; // Get the hierarchical profile for this node and its children. If total // is set, accumulate total time of the subtree in that variable as // additional return value. octave_value get_hierarchical (double* total = 0) const; private: tree_node* parent; octave_idx_type fcn_id; typedef std::map<octave_idx_type, tree_node*> child_map; child_map children; // This is only time spent *directly* on this level, excluding children! double time; unsigned calls; // No copying! tree_node (const tree_node&); tree_node& operator = (const tree_node&); }; // Each function we see in the profiler is given a unique index (which // simply counts starting from 1). We thus have to map profiler-names to // those indices. For all other stuff, we identify functions by their index. typedef std::vector<std::string> function_set; typedef std::map<std::string, octave_idx_type> fcn_index_map; function_set known_functions; fcn_index_map fcn_index; bool enabled; tree_node* call_tree; tree_node* active_fcn; // Store last timestamp we had, when the currently active function was called. double last_time; // These are private as only the unwind-protecting inner class enter // should be allowed to call them. void enter_function (const std::string&); void exit_function (const std::string&); // Query a timestamp, used for timing calls (obviously). // This is not static because in the future, maybe we want a flag // in the profiler or something to choose between cputime, wall-time, // user-time, system-time, ... double query_time () const; // Add the time elapsed since last_time to the function we're currently in. // This is called from two different positions, thus it is useful to have // it as a seperate function. void add_current_time (void); // No copying! profile_data_accumulator (const profile_data_accumulator&); profile_data_accumulator& operator = (const profile_data_accumulator&); }; // The instance used. extern OCTINTERP_API profile_data_accumulator profiler; // Helper macro to profile a block of code. #define BEGIN_PROFILER_BLOCK(classname) \ { \ profile_data_accumulator::enter<classname> pe (profiler, *this); #define END_PROFILER_BLOCK \ } // end of block => call pe's destructor #endif