Profiler auto-configuration of cost centers

Author(s): Teresa Trigo.

This module performs an automatic cost center configuration for a given goal. As a result it gives the trace of the highest resource (e.g., time, counts, ticks, etc.) consuming path starting from the goal.

Usage and interface

Library usage:
:- use_module(library(profilercc/profiler_auto_conf)).
Exports:
- Predicates:
  cc_auto_conf/4, cc_auto_conf/5, cc_auto_conf/6, cc_auto_conf/7, cc_auto_conf/8, get_goal_filename/2, reset/1, record_time/1, tree_to_tex/2, recorded_time/1, write_cc_assertions/2, compose_name/3.
- Multifiles:
  portray/1.

Documentation on exports

PREDICATEcc_auto_conf/4

Usage 1:

Same as cc_auto_conf/5 applied to time.

Call and exit should be compatible with:
(cgoal/1)Arg1 is a term which represents a goal, i.e., an atom or a structure.
(nnegint/1)Arg2 is a non-negative integer.
(list/1)Arg3 is a list.
(term/1)Arg4 is any term.

Usage 2:

Same as cc_auto_conf/3 able to deal with modular programs.

Call and exit should be compatible with:
(info_item_name/1)info_item_name(Arg1)
(list/1)Arg2 is a list.
(cgoal/1)Arg3 is a term which represents a goal, i.e., an atom or a structure.
(term/1)Arg4 is any term.

Meta-predicate with arguments: cc_auto_conf(goal,?,?,?).

PREDICATEcc_auto_conf/5

Usage:cc_auto_conf(Field,Goal,Cond,Goals,Tree)

Auto configuration of cost centers in order to find the sub-graph Goals of the call graph that is responsible of the performance leak. Goal is the call to be profiled and Field is the resource name w.r.t. the optimization is made (e.g., time, counts, ticks, etc.).

Call and exit should be compatible with:
(info_item_name/1)info_item_name(Field)
(cgoal/1)Goal is a term which represents a goal, i.e., an atom or a structure.
(nnegint/1)Cond is a non-negative integer.
(list/1)Goals is a list.
(term/1)Tree is any term.

Meta-predicate with arguments: cc_auto_conf(?,goal,?,?,?).

PREDICATEcc_auto_conf/6

No further documentation available for this predicate. Meta-predicate with arguments: cc_auto_conf(?,?,goal,?,?,?).

PREDICATEcc_auto_conf/7

No further documentation available for this predicate. Meta-predicate with arguments: cc_auto_conf(?,goal,?,?,?,?,?).

PREDICATEcc_auto_conf/8

No further documentation available for this predicate. Meta-predicate with arguments: cc_auto_conf(?,?,goal,?,?,?,?,?).

PREDICATEget_goal_filename/2

No further documentation available for this predicate. Meta-predicate with arguments: get_goal_filename(goal,?).

PREDICATEreset/1

Usage:

Given a name of a file erases its content

Call and exit should be compatible with:
(atm/1)Arg1 is an atom.

PREDICATErecord_time/1

No further documentation available for this predicate. Meta-predicate with arguments: record_time(goal).

PREDICATEtree_to_tex/2

No further documentation available for this predicate.

PREDICATErecorded_time/1

No further documentation available for this predicate. The predicate is of type data.

PREDICATEwrite_cc_assertions/2

Usage:

Given a set of predicates writes a cost_center assertion for all of them.

PREDICATEcompose_name/3

No further documentation available for this predicate.

Documentation on multifiles

PREDICATEportray/1

No further documentation available for this predicate. The predicate is multifile.

Documentation on imports

This module has the following direct dependencies:

Application modules:
profiler_utils, profiler_base, profiler_extra, profiler_type, graph_to_tex.
System library modules:
native_props, foreign_interface_properties, datafacts_rt, aggregates, format, hiordlib, compiler, system, lists, llists, stream_utils, write, terms, c_itf, global_module_options, pretty_print, ciaoc_aux.
Internal (engine) modules:
term_basic, arithmetic, atomic_basic, basiccontrol, exceptions, term_compare, term_typing, debugger_support, basic_props, hiord_rt, io_basic.
Packages:
prelude, initial, condcomp, assertions, assertions/assertions_basic, nativeprops, foreign_interface, basicmodes, regtypes, engine(foreign_types), datafacts.