sce_schedule allows to query and manipulate meta-information about the intended scheduling of behaviors inside PEs in a given design.
sce_schedule reads the SIR file for a given design, performs each action specified via the command line and writes out the resulting modified SIR (if any). An output SIR file is only written if modifications to the design have been made through the actions. If no action is specified, no operations are performed, no output is produced and the specified design is left unchanged.
On successful completion, the exit value 0 is returned. In case of errors, a diagnostic message is written to standard error and the program execution is aborted with a non-zero exit value. In this case, no output is produced.
specifies the design to work with; if no -i or -o options are specificed, the suffix '.sir' will be appended to this name in order to obtain the default SIR file to read and write, respectively.
specifies the action to perform on the design; actions include operations to query or manipulate the design, and to set up options for following operations; command line actions are processed strictly in order, i.e. multiple operations are performed in the order specified on the command line and earlier options have effect until they are overwritten by later ones.
-h
prints a short usage and version information and then quits;
-i input file
specifies the name of the input file explicitly; the name '-' can be used to specify reading from standard input;
-n
suppresses the creation of new log information when generating the output SIR file; by default, log information in the main design file is updated automatically (see also section ANNOTATIONS below);
-o output file
specifies the name of the output design file explicitly; the name '-' can be used to specify writing to standard output;
-v
set the verbosity level so that progress reports about actions performed are logged to standard error (default: be silent);
-d
remove any scheduling meta-information, i.e. delete any flattening, serialization or subbehavior order and restore original schedule for the currently selected behavior (see -t); if -r has been specified previously, recursively delete schedule for behavior and all its subbehaviors;
-f
[child]flatten subbehavior instance child (default: all children) of currently selected behavior (see -t); if -r has been specified previously, recursively flatten child and all its subbehaviors;
-k name
show the selected OS model for the PE with the given name;
-k name
=[fIos]set the OS for the PE with the given name to the model os;
-p child
show priority of child task (subbehavior instance) inside the currently selected behavior (see -t);
-p child
=[priority]set priority of child task (subbehavior instance) inside the currently selected behavior (see -t) to the given priority value (default: remove task priority);
-r
apply all following static scheduling operations (-f or -s) for the currently selected behavior (see -t) recursively;
-s
serialize subbehaviors of currently selected behavior (see -t); if -r has been specified previously, recursively serialize behavior and all its subbehaviors;
-t behavior
(re-)set the behavior to operate on for all actions following on the command line (default: use top-level behavior specified in the design);
-u
show schedule of subbehaviors for currently selected behavior (see -t); prints list of subbehaviors in order of their execution, separated by spaces;
-u child
,...set schedule of subbehaviors for currently selected behavior (see -t); set the list of child behaviors in their order of execution;
HOME
determines the location of the user's home directory and consequently the default path to the file with user-specific application preferences ($HOME/.sce/scerc);
determines the list of directories where files "scerc" with user-specific application preferences are stored; multiple directories can be provided, separated by colons (":"); directories are searched for and preference files are read in the given order, i.e. preference files in later directories override settings in earlier ones; if SCERC_PATH is not set, the location (directory) of the user-specific "scerc" file defaults to $HOME/.sce;
determines the license file (path and file name) to be used by the SIR tool set; if undefined, the environment variable SPECC is used as the path to the license file called "license.sir"; if neither SPECC_LICENSE_FILE nor SPECC exist, the file "license.sir" is searched in the current directory;
File with system-wide default settings for application preferences; system-wide settings are read on startup before user-specific settings;
File(s) with user-specific settings for application preferences; user-specific settings are read on startup after system-wide settings, i.e. user-specific settings override system-wide settings;
The following SpecC annotations are recognized by sce_schedule:
contains the log information of the SIR file; this global annotation is created and maintained automatically by the SpecC compiler and the SCE tool set and can be used to determine the origin and the operations performed on the design model; _SCE_LOG is a composite annotation consisting of a list of log entries, ordered by time of creation; each log entry consists of a time stamp, command line, source file, version info, and an optional comment;