octave-antonio: scripts/general/profile.m annotate

annotate scripts/general/profile.m @ 12869:de9a9719e594

Extend data collection in profiler and add user-interface profile function. * scripts/general/module.mk: Add profile.m. * scripts/general/profile.m: New file. * src/profiler.h (stats): New utility class. (data): Field to replace old times, can now hold more info. * src/profiler.cc (stats): Implementation of routines. (profile_data_accumulator): Changes necessary because call_stack was changed to be a std::vector now and for the new statistics map. (profile_data_accumulator::get_data): Extended to produce much more sophisticated output. (profile_data_accumulator::enter_function): Collect some more data than the timing.

author	Daniel Kraft <d@domob.eu>
date	Thu, 14 Jul 2011 22:16:24 +0200
parents
children	23377c46516b

rev	line source
12869 de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	1 ## Copyright (C) 2011 Daniel Kraft
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	2 ##
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	3 ## This file is part of Octave.
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	4 ##
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	6 ## under the terms of the GNU General Public License as published by
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	7 ## the Free Software Foundation; either version 3 of the License, or (at
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	8 ## your option) any later version.
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	9 ##
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	13 ## General Public License for more details.
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	14 ##
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	15 ## You should have received a copy of the GNU General Public License
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	16 ## along with Octave; see the file COPYING. If not, see
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	17 ## <http://www.gnu.org/licenses/>.
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	18
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	19 ## -- texinfo --
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	20 ## @deftypefn {Function File} {} profile on
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	21 ## @deftypefnx {Function File} {} profile off
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	22 ## @deftypefnx {Function File} {} profile resume
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	23 ## @deftypefnx {Function File} {} profile clear
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	24 ## @deftypefnx {Function File} {@var{S} =} profile ('status')
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	25 ## @deftypefnx {Function File} {@var{T} =} profile ('info')
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	26 ## Control the built-in profiler.
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	27 ##
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	28 ## @table @code
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	29 ## @item profile on
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	30 ## Start the profiler, clearing all previously collected data if there
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	31 ## is any.
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	32 ##
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	33 ## @item profile off
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	34 ## Stop profiling. The collected data can later be retrieved and examined
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	35 ## with calls like @code{S = profile ('info')}.
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	36 ##
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	37 ## @item profile clear
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	38 ## Clear all collected profiler data.
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	39 ##
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	40 ## @item profile resume
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	41 ## Restart profiling without cleaning up the old data and instead
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	42 ## all newly collected statistics are added to the already existing ones.
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	43 ##
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	44 ## @item @var{S} = profile ('status')
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	45 ## Return a structure filled with certain information about the current status
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	46 ## of the profiler. At the moment, the only field is @code{ProfilerStatus}
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	47 ## which is either 'on' or 'off'.
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	48 ##
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	49 ## @item @var{T} = profile ('info')
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	50 ## Return the collected profiling statistics in the structure @var{T}.
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	51 ## Currently, the only field is @code{FunctionTable} which is an array
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	52 ## of structures, each entry corresponding to a function which was called
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	53 ## and for which profiling statistics are present.
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	54 ## @end table
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	55 ## @end deftypefn
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	56
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	57 ## Built-in profiler.
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	58 ## Author: Daniel Kraft <d@domob.eu>
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	59
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	60 function retval = profile (option)
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	61
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	62 switch (option)
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	63 case 'on'
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	64 __profiler_reset ();
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	65 __profiler_enable (true);
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	66
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	67 case 'off'
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	68 __profiler_enable (false);
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	69
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	70 case 'clear'
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	71 __profiler_reset ();
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	72
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	73 case 'resume'
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	74 __profiler_enable (true);
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	75
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	76 case 'status'
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	77 enabled = __profiler_enable ();
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	78 if (enabled)
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	79 enabled = 'on';
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	80 else
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	81 enabled = 'off';
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	82 endif
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	83 retval = struct ('ProfilerStatus', enabled);
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	84
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	85 case 'info'
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	86 data = __profiler_data ();
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	87 retval = struct ('FunctionTable', data);
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	88
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	89 otherwise
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	90 print_usage ();
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	91 endswitch
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	92
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	93 endfunction
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	94
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	95 %!demo
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	96 %! profile ('on');
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	97 %! A = rand (100);
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	98 %! B = expm (A);
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	99 %! profile ('off');
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	100 %! profile ('resume');
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	101 %! C = sqrtm (A);
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	102 %! profile ('off');
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	103 %! T = profile ('info')

Mercurial > octave-antonio

annotate scripts/general/profile.m @ 12869:de9a9719e594