![]() |
Cube GUI User Guide
(CubeGUI 4.9, revision 6e5e012c)
Introduction in Cube GUI and its usage
|
This Plugin allows one to create the connection between the performance measurement aka the cube file, and some another application via the simple assignment of the element in the profile, be it metric- or callpath- element and the to-be-executed command.
This connection is always established individually to the performance measurement. If a more general connection is needed, an additional CubeGUI plugin has to be developed.
To achieve this one needs to create the file with the same name as the cube file and with the extension ".launch". For example, profile.cubex -> profile.launch, summary.cubex -> summary.launch etc.
This has to be located in the same directory as the corresponding .cubex file and can be created manually (also postfactum) or automatically.
The content of the file has three main sections: INIT, MAIN, FINALIZE
INIT - defines the command, which has to be executed before other commands of the launch get active. This might be used to initialize a third-party application. This command won't be executed automatically, but is only available in the plugin menu "Plugins".
Syntax:
[INIT] <init menu title> <command> <paramer>
The init menu title defines the menu item, which the user would need to select to execute the command
FINALIZE - this command, if defined, is automatically executed when the cube file is closed
Syntax:
[FINALIZE] <command> <paramer>
This section is "mute", means the command is executed without the additional (except "Close Cube") actions from the user.
MAIN - this section defines commands for individual tree elements.
Syntax:
... <metric uniq name> <menu title in metric tree> <metric tree command> <paramer> - cnode <cnode id> <menu title in call tree for given id> <call tree command> <paramer> ...
In this section one defines metric wise the series of the entries. This means that for the selected metric metric unit name, the command metric tree command is defined, which is executed when menu title in metric tree is selected in the context menu in the metric tree. The prefix "- cnode" is used to define an ID (cnode id) of the call path, for which the command call tree command is specified. This command is excecuted when the the menu item menu title in call tree for given ID is selected in the context menu of the call path.
One can specify multiple - cnode <cnode id>
for the selected metric <metric uniq name>
or one can specify <metric uniq name>
for every cnode individually. The sequence of the entries is irrelevant.
One can choose instead of <metric uniq name>
the placeholder "**", which makes the command available for every call path.
NOTICE Execution of the command is done in the "current directory", which is the directory in which "./cube" has been executed. Every command should be executable. This means that the executable is either found via the PATH variable or must be specified with an absolute path.
To establish the meaningful connection between the performance profile and the To-be-executed command one can specify the paramteres (placeholders) for the command. These will be replaces by the corresponding values. Available placeholders always start with the symbol "%" and are :
%cn - defines the name of the selected call path
Example of the .launch file
[INIT] Init Visualisation initialize.sh %f START time - cnode 4 display_timing_cnode.sh %cn %ci $ce %c visits Display calls in ParaView display_calls_metric.sh %mn %mi $me %m - cnode 3 Display this call in ParaView display_calls_cnode.sh %cn %ci $ce %c - cnode 10 Display this call in ParaView display_calls_cnode.sh %cn %ci $ce %c [FINALIZE] finalize.sh %f DONE
.launch file doesn't support comments.
![]() |
Copyright © 1998 Forschungszentrum Jülich GmbH,
Jülich Supercomputing Centre
Copyright © 2009–2015 German Research School for Simulation Sciences GmbH, Laboratory for Parallel Programming |