Skip to content
Antoine Lorence edited this page May 6, 2014 · 2 revisions

Run Orcc

$SCRIPTS_DIR/orcc_run_compilation $WORK_DIR ~/projects/orc-apps c RVC \
  org.sc29.wg11.mpeg4.part10.php.Top_mpeg4_part10_PHP_decoder ~/generated_code/c

When Orcc has been built and installed into eclipse.runtime using orcc_build script, this one can be used to generate code using any available Orcc back-end.

Here is a list of valid arguments:

Usage: headless_build/orcc_run_compilation <working_directory> <projects_dir> <backend> <project> <top_network> <output_dir> [<additional_flags>]
    <working_directory>           Path to folder used to perform build & tests
    <projects_dir>                Folder containing CAL projects
    <backend>                     Identifier of the backend tu use (c, llvm, jade, tta, etc.)
    <project>                     The project containing application to build
    <top_network>                 Qualified name of the top network to build
    <output_dir>                  Folder where application will be built
    <additional_flags>            [Optional] Flags added to backend execution command line
  • <working_directory> is the same we use for all scripts, set to $WORK_DIR
  • <projects_dir> is the path to a folder containing CAL eclipse projects, typically the path to your local clone of orc-apps
  • <backend> is the backend you want to use to produce code. This can be set to c, jade, llvm, tta, etc. For a complete and up-to-date list of supported backends, see the plugin.xml in backends plugin. Each backend is declared as extension point org.eclipse.core.runtime.applications and the id of the extension is the value you have to pass to this script top run the corresponding back-end.
  • <project> is the project name containing the network you want to generate (ex: RVC, Research, DigitalFiltering, etc.)
  • <top_network> is the fully qualified name of the network you want to build
  • <output_dir> is the path of a folder on your machine where sources will be generated. This project must have sufficient write permissions
  • <additional_flags> can be used to give other arguments to the back-end. This is not documented for now.

When this script is launched, it cleans bin folders in all directories of given <projects_dir>. A workspace is initialized in the given <projects_dir> (all Orcc projects it contains are registered) and the front-end command-line version is executed to build IR files in required bin folders. Finally, the selected back-end is executed and produces code in the given <output_dir>.

Clone this wiki locally