Wiki source code of SCCharts Development

Version 5.1 by ssm on 2016/04/20 10:47
Hide last authors
ssm 5.1 1 This is a light-weight tutorial for developing additions for SCCharts in KIELER. It will use Eclipse, EMF, and Xtend and therefore, finishing the corresponding tutorials could prove useful. However, they are not a strict requirement for this tutorial.
ssm 1.1 2
3 = Preliminaries =
4
5 There's a few things to do before we dive into the tutorial itself. For example, to do Eclipse programming, you will have to get your hands on an Eclipse installation first. Read through the following sections to get ready for the tutorial tasks.
6
7 == Required Software ==
8
9 As you're going to develop for KIELER SCCharts we recommend to use the semantic Oomph setup as described in [[doc:KIELER.Getting Eclipse]] (Oomph Setup). However, you could also install all componentes by yourself. Please consult the other tutorials if you want to do that. You would need to install the Modeling Tools and the Xtext SDK.
10
11 Additionally, install the** EcoreViz** from the **Ecore Model Visualization** category from the **OpenKieler** update site: [[http:~~/~~/rtsys.informatik.uni-kiel.de/~~~~kieler/updatesite/nightly-openkieler/>>url:http://rtsys.informatik.uni-kiel.de/~~kieler/updatesite/nightly-openkieler/||rel="nofollow" shape="rect"]]
12
13 == Recommended Tutorials ==
14
15 We recommend that you have completed the following tutorials before diving into this one (or at least sweep over them). However, this is not a strict requirement.
16
17 1. [[doc:Eclipse Plug-ins and Extension Points]]
18 1. [[doc:Eclipse Modeling Framework (EMF)]]
19 11. This tutorial needs the turingmachine.ecore and the controller you've implemented in the EMF tutorial. If you did not complete the EMF tutorial, you may download a working turing machine here... (in the future).
20 1. (((
21 (% class="with-breadcrumbs" %)
22 [[Xtend 2 - Model Transformations>>url:http://rtsys.informatik.uni-kiel.de/confluence/display/TUT/Xtend+2+-+Model+Transformations||shape="rect"]]
23 )))
24
25 == Helpful Tutorials ==
26
27 When developing within the KIELER semantics team, you will most likely be confronted with Xtext and [[doc:KIELER.Lightweight Diagrams (KLighD)]]. The following tutorials may be helpful but not required for this tutorial.
28
29 1. [[doc:Xtext 2 - Creating a Grammar from Scratch]]
30 1. [[doc:Lightweight Diagrams (KLighD)]]
31
32 == Finding Documentation ==
33
ssm 5.1 34 You can find additional documentation to the aforementioned topics in the corresponding tutorials. If you get stuck with a particular topic, please consult that tutorial. For SCCharts, you should read the SCCharts confluence page in our wiki: [[doc:KIELER.SCCharts]]
ssm 1.1 35
36 As usual, documentation often gets obsolete or wrong if not maintained regularly, so please, if you find missing, misleading, or outdated information, please let us know.
37
38 Additionally, the following list will give a short overview over the most important publications:
39
40 * (% style="color: rgb(0,0,0);" %)**Main paper:**
41 Reinhard von Hanxleden and Björn Duderstadt and Christian Motika and Steven Smyth and Michael Mendler and Joaquín Aguado and Stephen Mercer and Owen O’Brien. SCCharts: Sequentially Constructive Statecharts for Safety-Critical Applications. In (% class="cmti-10" %)Proc. ACM SIGPLAN Conference on Programming Language Design(%%) (% class="cmti-10" %)and Implementation (PLDI’14)(%%), Edinburgh, UK, June 2014. ACM. (%%)[[pdf>>url:http://rtsys.informatik.uni-kiel.de/~~biblio/downloads/papers/pldi14.pdf||shape="rect"]](% style="color: rgb(0,0,0);" %), (%%)[[talk>>url:http://rtsys.informatik.uni-kiel.de/~~biblio/downloads/talks/pldi14-talk.pdf||shape="rect"]](% style="color: rgb(0,0,0);" %), (%%)[[bib>>url:http://rtsys.informatik.uni-kiel.de/~~biblio/cgi-bin/bibcgi.cgi?key=vonHanxledenDM+14||shape="rect"]]
42 * **SLIC Compilation:**
43 (% style="color: rgb(0,0,0);" %)Christian Motika and Steven Smyth and Reinhard von Hanxleden. Compiling SCCharts—A Case-Study on Interactive Model-Based Compilation. In (% class="cmti-10" %)Proceedings of(%%) (% class="cmti-10" %)the 6th International Symposium on Leveraging Applications of Formal(%%) (% class="cmti-10" %)Methods, Verification and Validation (ISoLA 2014)(%%), volume 8802 of (% class="cmti-10" %)LNCS(%%), page 443–462, Corfu, Greece, October 2014. The (%%)[[original publication>>url:http://dx.doi.org/10.1007/978-3-662-45234-9||shape="rect"]](% style="color: rgb(0,0,0);" %) is available at (%%)[[http:~~/~~/link.springer.com>>url:http://link.springer.com/||shape="rect"]](% style="color: rgb(0,0,0);" %). (%%)[[pdf>>url:http://rtsys.informatik.uni-kiel.de/~~biblio/downloads/papers/isola14.pdf||shape="rect"]](% style="color: rgb(0,0,0);" %), (%%)[[bib>>url:http://rtsys.informatik.uni-kiel.de/~~biblio/cgi-bin/bibcgi.cgi?key=MotikaSvH14||shape="rect"]]
44 * **Theoretical Foundations:**
45 (% style="color: rgb(0,0,0);" %)Reinhard von Hanxleden and Michael Mendler and Joaquín Aguado and Björn Duderstadt and Insa Fuhrmann and Christian Motika and Stephen Mercer and Owen O’Brien and Partha Roop. Sequentially Constructive Concurrency—A Conservative Extension of the Synchronous Model of Computation. (% class="cmti-10" %)ACM Transactions on Embedded Computing(%%) (% class="cmti-10" %)Systems, Special Issue on Applications of Concurrency to System Design(%%), 13(4s):144:1–144:26, July 2014. (%%)[[pdf>>url:http://rtsys.informatik.uni-kiel.de/~~biblio/downloads/papers/tecs14.pdf||shape="rect"]](% style="color: rgb(0,0,0);" %), (%%)[[bib>>url:http://rtsys.informatik.uni-kiel.de/~~biblio/cgi-bin/bibcgi.cgi?key=vonHanxledenMA+14||shape="rect"]]
46 * **Overview and High-Level Transformations in Detail:**
47 (% style="color: rgb(0,0,0);" %)Reinhard von Hanxleden and Björn Duderstadt and Christian Motika and Steven Smyth and Michael Mendler and Joaquín Aguado and Stephen Mercer and Owen O’Brien. SCCharts: Sequentially Constructive Statecharts for Safety-Critical Applications. Technical Report 1311, Christian-Albrechts-Universität zu Kiel, Department of Computer Science, December 2013. ISSN 2192-6247. (%%)[[pdf>>url:http://rtsys.informatik.uni-kiel.de/~~biblio/downloads/papers/report-1311.pdf||shape="rect"]](% style="color: rgb(0,0,0);" %), (%%)[[bib>>url:http://rtsys.informatik.uni-kiel.de/~~biblio/cgi-bin/bibcgi.cgi?key=vonHanxledenDM+13b||shape="rect"]]
48
49 = The SCCharts Metamodel =
50
ssm 4.1 51 Navigate to the models folder of the plugin {{code language="none"}}de.cau.cs.kieler.sccharts{{/code}}. Here, open the {{code language="none"}}sccharts.ecore{{/code}} and right-click on the {{code language="none"}}sccharts.ecore{{/code}} file and select //Visualize Ecore Model//. Since you also installed **EcoreViz** from the OpenKieler Suite, you should now see a graphical representation of the SCCharts metamodel. Every SCChart will be a model of this metamodel.
ssm 1.1 52
53 IMAGE
54
55 Try to understand most parts of the metamodel. You don't have to understand every detail but you should get the idea.
56
57 ==== Model Task ====
58
ssm 5.1 59 1. (% style="line-height: 20.0px;" %)Answer the following questions
60 11. (% style="line-height: 20.0px;" %)Name the class of the root element of an SCChart
61 11. (% style="line-height: 20.0px;" %)How do you describe a superstate in the model?
62 11. (% style="line-height: 20.0px;" %)What is a valued object?
63 11. (% style="line-height: 20.0px;" %)How do you get the type of an interface variable?
64 11. Outline the relationship between states, regions, transitions, and valued objects
65 11. (% style="line-height: 20.0px;" %)What other metamodels are needed for the SCCharts metamodel and write down which one is needed for what?
66 1. (% style="line-height: 20.0px;" %)Write down (on paper, text editor, etc) how the following SCChart models look like
67 11. (% style="line-height: 1.42857;" %)Open the wiki page that explains the [[doc:KIELER.Textual SCCharts Language SCT]].
68 11. (% style="line-height: 1.4286; line-height: 1.4286" %)Search the (%%)//SCChart, Initial State, State, Transition and Immediate Transition //example and ...
69 111. write down (on paper or text editor, etc) how the model of that SCChart looks like.
70 111. The user now marks C as final. What has to be changed in the model? What semantic problem do you see?
71 11. (% style="line-height: 1.42857;" %)Now, navigate to the //Super State: Strong Abort Transition //example. Write down (on paper) how the model of that SCCharts looks like.
72 11. And finally a more sophisticated model: Write down the model of ABO (from [[doc:KIELER.Examples]]).
ssm 4.1 73
74 = Creating SCCharts Models Programmatically =
75
76 == Creating a Test Project ==
77
78 We need a project for testing. Do the following:
79
80 1. Create a new empty //Plug-In Project//.
81 1. Add the project that contains the sccharts metamodel as a dependency of your new project through the //Plugin Manifest Editor//.
82 1. Create a simple Java class that implements a main method. Hint: In a new Java class, simply type main and hit Ctrl+Space. Eclipse content assist will create the method for you.
83
84 == Creating a Model ==
85
86 To create a model programmatically you cannot directly use the Java classes generated for the model. Instead, the main package contains interfaces for all of your model object classes. The {{code language="none"}}impl{{/code}} package contains the actual implementation and the {{code language="none"}}util{{/code}} package contains some helper classes. Do not instantiate objects directly by manually calling {{code language="none"}}new{{/code}}. EMF generates a Factory to create new objects. The factory itself uses the singleton pattern to get access to it:
87
88 {{code language="java"}}
89 SCChartsFactory sccFactory = SCChartsFactory.eINSTANCE;
90 State state = sccFactory .createState();
91 Transition transition = sccFactory .createTransition();
92 {{/code}}
93
94 Important: The SCCharts grammar is build on top of several other grammars. Therefore, not all language objects can be found in the SCCharts factory. For example, all expression elements are part of the KExpressions grammar and hence, have their own factory. If you need other factories, don't forget to add the corresponding plugin to your plugin dependency list.
95
96 {{code language="java"}}
97 KExpressionsFactory kFactory = KExpressionsFactory.eINSTANCE;
98 BooleanValue boolValue = kFactory.createBooleanValue();
99 {{/code}}
100
101 For all simple attributes, there are getter and setter methods:
102
103 {{code language="java"}}
104 state.setId("Root");
105 boolValue.setValue(true);
106 {{/code}}
107
108 Simple references (multiplicity of 1) also have getters and setters:
109
110 {{code language="java"}}
111 transition.setTrigger(boolValue);
112 {{/code}}
113
114 List references (multiplicity of > 1) have only a list getter, which is used to manipulate the list:
115
116 {{code language="java"}}
117 state.outgoingTransitions.add(transition);
118 {{/code}}
119
120 == Saving a Model ==
121
122 EMF uses the [[Eclipse Resource concept>>url:http://help.eclipse.org/juno/topic/org.eclipse.platform.doc.isv/guide/resInt.htm?cp=2_0_10||rel="nofollow" shape="rect" class="external-link"]] to save models to files and load models from files. It can use different //Resource Factories// that determine how exactly models are serialized. We will use the [[XMIResourceFactoryImpl>>url:http://download.eclipse.org/modeling/emf/emf/javadoc/2.8.0/org/eclipse/emf/ecore/xmi/impl/XMIResourceFactoryImpl.html||rel="nofollow" shape="rect" class="external-link"]] to save our models to XML files:
123
124 1. Add a dependency to the {{code language="none"}}org.eclipse.emf.ecore.xmi{{/code}} plug-in.
125 1. (((
126 Use something like the following code to save the model from above:
127
128 {{code language="java"}}
129 // Create a resource set.
130 ResourceSet resourceSet = new ResourceSetImpl();
131
132 // Register the default resource factory -- only needed for stand-alone!
133 // this tells EMF to use XML to save the model
134 resourceSet.getResourceFactoryRegistry().getExtensionToFactoryMap().put(
135 Resource.Factory.Registry.DEFAULT_EXTENSION, new SCTResourceFactoryImpl());
136 // Get the URI of the model file.
137 URI fileURI = URI.createFileURI(new File("myABO.sct").getAbsolutePath());
138
139 // Create a resource for this file.
140 Resource resource = resourceSet.createResource(fileURI);
141
142 // Add the model objects to the contents.
143 resource.getContents().add(myModel);
144
145 // Save the contents of the resource to the file system.
146 try
147 {
148 resource.save(Collections.EMPTY_MAP); // the map can pass special saving options to the operation
149 } catch (IOException e) {
150 /* error handling */
151 }
152 {{/code}}
153 )))
154
155 ==== Model Creation Task ====
156
157 With these information out of the way, on we go to some model creation:
158
159 1. Programmatically create a valid model of ABO in the {{code language="none"}}main(){{/code}} method.
160 1. Run the {{code language="none"}}main(){{/code}} method by right-clicking its class and selecting //Run as// -> //Java Application//. Note that this runs your {{code language="none"}}main(){{/code}} method as a simple Java program, not a complete Eclipse application. EMF models can be used in any simple Java context, not just in Eclipse applications.
161 1. Execute the main method.
162 1. Inspect your SCT file.
163 1. Start your SCChart Editor Eclipse instance and load your SCT file. KLighD should now be able to visualize your ABO correctly.
164
165 = Transforming SCCharts =
166
167 Transformations from one model to another may be performed within the same metamodel or from metamodel to a different metamodel. Both methods are used in KIELER and in principle they do not really differ in implementation. Nevertheless, if working within the same metamodel you should keep in mind that you're potentially changing the actual model instead of changing another instance (after copying). Both is possible. Just make sure that you know what you're doing.
168
169 Now, you're going to transform the normalized form of HandleA from ABO to an SCG. The Sequentially Constructive Graph is a control-flow graph which can be seen as another representation of the same program. The SCG of the normalized version of ABO's HandleA is depicted on the right.
170
171 |(((
172 {{code}}
173 scchart ABO_norm_HandleA {
174 input output bool A;
175 input output bool B;
176 output bool O1;
177 output bool O2;
178 region HandleA:
179 initial state WaitA
180 --> _S immediate with A
181 --> _Pause immediate;
182 final state DoneA;
183 state _S
184 --> _S2 immediate with / B = true;
185 state _S2
186 --> DoneA immediate with / O1 = true;
187 state _Pause
188 --> _Depth;
189 state _Depth
190 --> _S immediate with A
191 --> _Pause immediate;
192 }
193 {{/code}}
194 )))|(((
195 [[image:attach:abo_norm_HandleA.png]]
196 )))|(% colspan="1" %)(% colspan="1" %)
197 (((
198 [[image:attach:abo_scg_HandleA.png]]
199 )))
200
201 The next figure depicts the direct mapping from normalized SCCharts to their corresponding SCG.
202
203 [[image:attach:sccharts-scg.png]]
204
205 Inspect the metamodel of the SCGs in plugin de.cau.cs.kieler.scg. SCGs are used for analyses and optimization and include a lot of additional elements. However, for this tutorial it should be sufficient to look at the SCGraph class, its nodes attribute, the important node classes and the controlflow class. Important nodes for this SCG are entry, exit, assignment, conditional,
206
207 ==== Transformation Task ====
208
209 Write a transformation that transforms your normalized version of ABO's HandleA into its corresponding SCG.
210
211 1. (((
212 **Writing a Model Transformation**
213
214 This time we want you to integrate your transformation into your SCCharts Editor instance. Therefore,...
215 (% style="color: rgb(51,51,51);line-height: 1.66667;" %)\\
216
217 1. Add a new package 
218
219 {{code language="none"}}
220 <project>.transformations
221 {{/code}} to your project.
222 1. Add an //Xtend Class// to the new package.
223 1. If you notice that your new class is marked with an error marker because of a missing dependency of the new plug-in project to 
224
225 {{code language="none"}}
226 org.eclipse.xtext.xbase.lib, 
227 {{/code}}you can hover over the error with your mouse and have Eclipse add all libraries required by Xtend to your project.
228 1.
229
230 Define an entry method for the transformation that takes an SCChart program instance as an argument and returns an SCG {{code language="none"}}Program{{/code}}. You can use the following (incomplete) method as a starting point:
231
232 (((
233 (% class="syntaxhighlighter sh-confluence nogutter java" %)
234 (((
235
236
237 |(((
238 (% class="container" title="Hint: double-click to select code" %)
239 (((
240 (% class="line number1 index0 alt2" %)
241 (((
242 {{code language="none"}}
243 /**
244 {{/code}}
245 )))
246
247 (% class="line number2 index1 alt1" %)
248 (((
249 {{code language="none"}}
250  
251 {{/code}}
252
253 {{code language="none"}}
254 * Transforms a given SCCharts program into an SCG.
255 {{/code}}
256 )))
257
258 (% class="line number3 index2 alt2" %)
259 (((
260 {{code language="none"}}
261  
262 {{/code}}
263
264 {{code language="none"}}
265 *
266 {{/code}}
267 )))
268
269 (% class="line number4 index3 alt1" %)
270 (((
271 {{code language="none"}}
272 */
273 {{/code}}
274 )))
275
276 (% class="line number8 index7 alt1" %)
277 (((
278 {{code language="none"}}
279 def SCGraph transform(State rootState) {
280 {{/code}}
281 )))
282
283 (% class="line number9 index8 alt2" %)
284 (((
285 {{code language="none"}}
286     
287 {{/code}}
288
289 {{code language="none"}}
290 // Create the SCG
291 {{/code}}
292 )))
293
294 (% class="line number10 index9 alt1" %)
295 (((
296 {{code language="none"}}
297     
298 {{/code}}
299
300 {{code language="none"}}
301 val scg = SCGraphFactory::eINSTANCE.createSCGraph()
302 {{/code}}
303 )))
304
305 (% class="line number11 index10 alt2" %)
306 (((
307 {{code language="none"}}
308   
309 {{/code}}
310 )))
311
312 (% class="line number12 index11 alt1" %)
313 (((
314 {{code language="none"}}
315     
316 {{/code}}
317
318 {{code language="none"}}
319 // TODO: Your transformation code
320 {{/code}}
321 )))
322
323 (% class="line number13 index12 alt2" %)
324 (((
325 {{code language="none"}}
326   
327 {{/code}}
328 )))
329
330 (% class="line number14 index13 alt1" %)
331 (((
332 {{code language="none"}}
333     
334 {{/code}}
335
336 {{code language="none"}}
337 // Return the transformed program
338 {{/code}}
339 )))
340
341 (% class="line number15 index14 alt2" %)
342 (((
343 {{code language="none"}}
344     scg
345 {{/code}}
346 )))
347
348 (% class="line number16 index15 alt1" %)
349 (((
350 {{code language="none"}}
351 }
352 {{/code}}
353 )))
354 )))
355 )))
356
357
358 )))
359 )))
360
361 (((
362 (% class="syntaxhighlighter nogutter java" %)
363 (((
364 There's a few points to note here:
365 )))
366 )))
367
ssm 1.1 368 \\
ssm 4.1 369
370 1.
371 1*. Lines in Xtend code don't have to and with a semicolon.
372 1*. We have been explicit about the method's return type, but we could have easily omitted it, letting Xtend infer the return type.
373 1*. The keyword 
374
375 {{code language="none"}}
376 val
377 {{/code}} declares a constant, while 
378
379 {{code language="none"}}
380 var
381 {{/code}} declares a variable. Try to make do with constants where possible.
382 1*. The methods you call should be declared as 
383
384 {{code language="none"}}
385 def private
386 {{/code}} since they are implementation details and shouldn't be called by other classes.
387 1*. You may be tempted to add a few global variables that hold things like a global input variable or a pointer to the current state. While you could to that, 
388
389 {{code language="none"}}
390 def create 
391 {{/code}}methods might offer a better alternative...
392 \\
393 1. Replace the TODO with an transformation code that takes an extended BF program and transforms it into an semantically equivalent BF program that only uses standard BF instructions. 
394 HINT: Some of the extended BF commands can only be expressed by standard operations if you can write to other cells. Therefore you are allowed to perform side effects on the tape.
395 1. Open the //Plug-In Manifest Editor// and switch to the Runtime tab. Add the package containing your transformation to the list of exported packages. (You may have to check the //Show non-Java packages// option in the //Exported Packages// dialog to see the package.)
396 \\
397 )))
398 1. **Verify your generated SCG**. If you added your transformation correctly, the SCG should be displayed automatically as soon as selected. If your SCG looks like the SCG depicted earlier, then everything is fine.
399 1. Check your SCG semantically. Is there anything you could improve/optimize? 
400 11. Write a second transformation (just as before) and add it to the transformation chain right after the transformation you already added.
401 11. Optimize the given SCG and compare the result with the previous one.
402 11. Make sure that the two SCGs are still semantically identical.
403
404 Congratulations! You finished the SCCharts Development Tutorial. Ask your supervisor for further instructions!
405
406

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage