Changes for page Project Management

Last modified by Richard Kreissig on 2023/09/14 10:56

From version < 3.1 >

edited by aas2
on 2017/08/02 21:12

To version < 6.1 >

edited by aas2
on 2017/10/16 13:33

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)
Objects (1 modified, 0 added, 0 removed)
- Confluence.Code.ConfluencePageClass[0]

Details

Page properties

Content

@@ -83,12 +83,372 @@
  The new project builder is configured using a domain specific language, namely KiBuild. Corresponding to the actions that are performed during the build, its configuration consists of //model compilers//, //simulation compilers// and //template processors//. A template processor is either a //simple template processor//, //wrapper code template processor// or //simulation template processor//.
++When writing the configuration, use code completion to see available attributes for the entities. The following table describes the available attributes.
++
++(% class="relative-table wrapped" style="width: 99.937%;" %)
++|=(((
++**Attribute**
++)))|=(((
++Domain
++)))|=(% colspan="1" %)(% colspan="1" %)
++(((
++Default Value
++)))|=(((
++Description
++)))
++|(% class="highlight-blue" colspan="1" data-highlight-colour="blue" %)(% class="highlight-blue" colspan="1" data-highlight-colour="blue" %)
++(((
++**KiCo Model Compiler**
++)))|(% class="highlight-blue" colspan="1" data-highlight-colour="blue" %)(% class="highlight-blue" colspan="1" data-highlight-colour="blue" %)
++(((
++\\
++)))|(% class="highlight-blue" colspan="1" data-highlight-colour="blue" %)(% class="highlight-blue" colspan="1" data-highlight-colour="blue" %)
++(((
++\\
++)))|(% class="highlight-blue" colspan="1" data-highlight-colour="blue" %)(% class="highlight-blue" colspan="1" data-highlight-colour="blue" %)
++(((
++\\
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++outputFolder
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++String
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++kieler-gen
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++{{{The folder in which compilation output is saved}}}
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++whitelist
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++String, Regular expression
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++-
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Only model files that have a location matching this regular expression are compiled. Thus to compile only a specific model, one can use the expression "ModelName.sctx"
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++blacklist
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++String, Regular expression
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++-
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Model files that have a location matching this regular expression are exluded from the build. Thus to exclued all models and skip compilation, one can use ".*", which matches everything.
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++outputFileExtension
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++String
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++c
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Compiled models are saved with using this file extension. Thus this attribute should match the code format that is generated by KiCo at the end of the compilation.
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++outputTemplate
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++String, Project relative file path
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++-
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++An optional template to add surrounding code to KiCo generated output for every compiled file. In the template the placeholder **${kico_code}** can be used an will be replaced with the compiled code.
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++compileChain
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++(% class="content-wrapper" %)
++(((
++String, Id of a pre-defined compilation system or processor id or a project relative file path to a kico file
++
++Can also be a list of the above to compile models in several steps
++
++Can also be a map to define the compilation of different model types
++
++{{code}}
++compileChain {
++  sctx: de.cau.cs.kieler.sccharts.netlist.simple
++  strl: de.cau.cs.kieler.esterel.netlist.simple
++}
++{{/code}}
++
++\\
++
++\\
++)))
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++de.cau.cs.kieler.sccharts.netlist.simple
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++The compilation system that is used by KiCo to determine the compile chain.
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++communicateRegisterVariables
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Boolean
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++true
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Determines if the variables that save the internal state of a model should be communicated to the simulation generation. If set to false, stepping back and forth in the simulation history will not change the internal state of the model.
++)))
++|(% class="highlight-blue" colspan="1" data-highlight-colour="blue" %)(% class="highlight-blue" colspan="1" data-highlight-colour="blue" %)
++(((
++**Simulation Compiler**
++)))|(% class="highlight-blue" colspan="1" data-highlight-colour="blue" %)(% class="highlight-blue" colspan="1" data-highlight-colour="blue" %)
++(((
++\\
++)))|(% class="highlight-blue" colspan="1" data-highlight-colour="blue" %)(% class="highlight-blue" colspan="1" data-highlight-colour="blue" %)
++(((
++\\
++)))|(% class="highlight-blue" colspan="1" data-highlight-colour="blue" %)(% class="highlight-blue" colspan="1" data-highlight-colour="blue" %)
++(((
++\\
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++command
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++String
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++For C:
++
++"gcc -std=c99 -Werror=int-conversion -o \"./${outputFolder}/${executable_name}\""
++
++For Java:
++
++"jar cvfe \"../${outputFolder}/${executable_name}\""
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++The command that is called to compile simulation code to an executable.
++
++In case of the C simulation, the compiled file is added implicitly as additional parameter, to create an executable.
++
++In case of Java, all class files and the class file of the compiled model are added implicitly to create an executable JAR file.
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++outputFolder
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++String, Project relative folder path
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++kieler-gen/sim/bin
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++The folder in which compiled output will be saved.
++
++Note that it is possible to use a command that creates the compiled files in a different location. However the folder specified in this attribute is created before the command is executed and refreshed afterwards. This ensures that the folder exists and changes will be noticed in the Eclipse workspace.
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++libFolder
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++String, Project relative folder path
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++kieler-gen/sim/lib
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++The folder where additional files are saved before the command is run. These files can be linked into the simulation code, e.g., for JSON handling.
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++timeout
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++int
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++10
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Time in seconds that is waited for the executed command to finish. If the command runs longer, it is assumed to be failed and aborted.
++)))
++|(% class="highlight-blue" colspan="1" data-highlight-colour="blue" %)(% class="highlight-blue" colspan="1" data-highlight-colour="blue" %)
++(((
++**Template Processor**
++)))|(% class="highlight-blue" colspan="1" data-highlight-colour="blue" %)(% class="highlight-blue" colspan="1" data-highlight-colour="blue" %)
++(((
++\\
++)))|(% class="highlight-blue" colspan="1" data-highlight-colour="blue" %)(% class="highlight-blue" colspan="1" data-highlight-colour="blue" %)
++(((
++\\
++)))|(% class="highlight-blue" colspan="1" data-highlight-colour="blue" %)(% class="highlight-blue" colspan="1" data-highlight-colour="blue" %)
++(((
++\\
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++file
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++String, Project relative file path
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++-
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++The template file that should be processed
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++target
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++String, Project relative file path
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++-
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++The file in which the output should be saved
++)))
++|(% class="highlight-blue" colspan="1" data-highlight-colour="blue" %)(% class="highlight-blue" colspan="1" data-highlight-colour="blue" %)
++(((
++**Wrapper Code Template Processor**
++)))|(% class="highlight-blue" colspan="1" data-highlight-colour="blue" %)(% class="highlight-blue" colspan="1" data-highlight-colour="blue" %)
++(((
++\\
++)))|(% class="highlight-blue" colspan="1" data-highlight-colour="blue" %)(% class="highlight-blue" colspan="1" data-highlight-colour="blue" %)
++(((
++\\
++)))|(% class="highlight-blue" colspan="1" data-highlight-colour="blue" %)(% class="highlight-blue" colspan="1" data-highlight-colour="blue" %)
++(((
++\\
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++modelFile
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++String, Project relative file path
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++-
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++The model file that is searched for annotations to determine the code snippets to be injected.
++)))
++|(% class="highlight-blue" colspan="1" data-highlight-colour="blue" %)(% class="highlight-blue" colspan="1" data-highlight-colour="blue" %)
++(((
++**Simulation Code Template Processor**
++)))|(% class="highlight-blue" colspan="1" data-highlight-colour="blue" %)(% class="highlight-blue" colspan="1" data-highlight-colour="blue" %)
++(((
++\\
++)))|(% class="highlight-blue" colspan="1" data-highlight-colour="blue" %)(% class="highlight-blue" colspan="1" data-highlight-colour="blue" %)
++(((
++\\
++)))|(% class="highlight-blue" colspan="1" data-highlight-colour="blue" %)(% class="highlight-blue" colspan="1" data-highlight-colour="blue" %)
++(((
++\\
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++modelFile
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++String, Project relative file path
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++-
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++The model file that is searched for annotations to determine the code snippets to be injected
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++compiledModelFile
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++String, Absolute file system path
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++-
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++The absolute path of the compiled model file for which the simulation is created. This is used to replace the placeholder ${compiled_model_loc} in the simulation code template
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++variables
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++(% class="content-wrapper" %)
++(((
++Map, e.g.,
++
++{{code}}
++variables {
++  input: myVar1
++  output: {
++    bool: myVar2
++    int: myVar3[2][3]
++  }
++}
++{{/code}}
++)))
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++-
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Optional additional variables that should be communicated to the outside
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++interfaceTypes
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++String, List of Strings
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++-
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++The interface types that should be communicated in the simulation, e.g., input, output, internal
++)))
++
++\\
++
++Example for KiBuild files:
++
  {{code title="Simple KiBuild Example" linenumbers="true"}}
  // Compile models to C code
  model compiler kico {
    outputFolder: kieler-gen   // The folder, in which the compilation output is saved
    outputFileExtension: c     // The file extension for compiled files
--  compilationSystem: de.cau.cs.kieler.sccharts.netlist.simple  // The system that determines the compile chain within the KIELER compiler
++  compileChain: de.cau.cs.kieler.sccharts.netlist.simple  // The system that determines the compile chain within the KIELER compiler
    // Generate C simulation for compiled models
    process simulation template {
@@ -96,15 +96,14 @@
    }
  }
--// Compile C simulation via gcc
++// Compile simulation code
  simulation compiler c {
    libFolder: kieler-gen/sim/lib      // Create additional libraries required for compilation in this folder
    outputFolder: kieler-gen/sim/bin   // Create the executables in this folder
--  command: "gcc -std=c99 -o ./${outputFolder}/${executable_name}"  // Use gcc to compile the code
++  command: "gcc -std=c99 -o ./${outputFolder}/${executable_name} ${file_path} "  // Use gcc to compile the code
  }
--
  {{/code}}
  {{code title="Complex KiBuild Example"}}
@@ -113,7 +113,7 @@
    outputFolder: kieler-gen
    outputFileExtension: java
    outputTemplate: assets/OutputTemplate.ftl
--  compilationSystem: de.cau.cs.kieler.sccharts.netlist.simple
++  compileChain: de.cau.cs.kieler.sccharts.netlist.simple
    whitelist: "ModelA|ModelB"    // Only compile models that match this regex
    // Generate C simulation for compiled models
@@ -122,11 +122,12 @@
    }
  }
--// Compile C simulation via gcc
++// Compile simulation code
  simulation compiler java {
    libFolder: kieler-gen/org/json
    outputFolder: kieler-gen/sim/bin
--  command: "jar cvfe ../${outputFolder}/${executable_name}"
++  command: "javac -cp kieler-gen -d bin \"${file_path}\" "
++  jarCommand: "jar cvfe \"./${outputFolder}/${executable_name}\" sim.code.${file_basename} -C bin . "
  }
  // Process a simple template
@@ -141,6 +141,17 @@
    target: kieler-gen/Main.c
    modelFile: MyModel.sctx
  }
++
++// Process a template to generate a simulation for a model that has been compiled with some other framework
++process simulation template {
++  file: assets/JavaSimulationForOtherModel.ftl
++  target: kieler-gen/Sim_OtherModel.java
++  variables: {    // These variables should be communicated to the outside
++    input: a,b,c
++    output: x,y,z
++  }
++  interfaceTypes: input, output  // Only communicate these interface types. In this case, internal variables are not communicated.
++}
  {{/code}}
  \\
@@ -147,11 +147,11 @@
  ----
--== Prom Environments ==
++== Project Drafts ==
--Environments are used to provide default settings for project creation. They are configured in the **preferences** (//Window //>// Preferences > KIELER SCCharts > Execution Environments//).
++Project drafts are used to provide default settings for project creation. They are configured in the **preferences** (//Window //>// Preferences > KIELER SCCharts > Project Drafts//).
--An environment consists of
++An project draft consists of
 . a unique **name**, which may not contain a comma
 . an **associated** project wizard
@@ -226,3 +226,15 @@
  === [[image:attach:wrapper_code_generation_example.png]] ===
  ----
++
++== Problem Solving ==
++
++=== CDT Projects ===
++
++When working with the CDT, the folder that contains the simulation code has to be excluded from the CDT build, because this code is compiled using the compiler specified in the kibuild file, and every simulation file has an additional main function, which is not the use-case that a CDT project is made for. These files are self contained and do not interact with other files in the CDT project, thus they should not be built.
++
++[[image:attach:cdt_exlude_from_build.png]]
++
++\\
++
++----

Confluence.Code.ConfluencePageClass[0]

Id

@@ -1,1 +1,1 @@
--31162488
++33259959

URL

@@ -1,1 +1,1 @@
--https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/31162488/V2 Project Management
++https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/33259959/V2 Project Management

Changes for page Project Management

Summary

Details

Navigation

Quick Links