Difference between revisions of "Tasking Event-B Tutorial"

From Event-B
Jump to navigationJump to search
imported>Andy
imported>Andy
 
(243 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
THIS PAGE IS UNDER CONSTRUCTION !!!!!!
+
For more information contact Andy Edmunds - University of Southampton - mailto:ae2@ecs.soton.ac.uk
 +
 
 +
<< I AM UPDATING THIS PAGE >>
  
−
For more information contact Andy Edmunds - University of Southampton - mailto:ae2@ecs.soton.ac.uk
 
 
=== Tasking Event-B Tutorial Overview ===
 
=== Tasking Event-B Tutorial Overview ===
  
−
This code generation tutorial supplements the Heating Controller tutorial example, and makes use of example projects from the download site. The code generation stage produces implementable Ada code, and also an Event-B project which models the implementation. The Ada code is produced using a pretty printer tool from an intermediate model, the Common Language model (IL1), generated by a translation tool. An overview of Tasking Event-B can be found on the [[Tasking_Event-B_Overview]] page.
+
This tutorial follows on from the abstract development described [http://wiki.event-b.org/index.php/Development_of_a_Heating_Controller_System here].
  
−
The Heating Controller development has been refined to the point where we wish to add implementation constructs. The Event-B language is not expressive enough to fully describe the implementation. Tasking Event-B facilitates this final step to implementation, by extending Event-B with the necessary constructs. Event-B machines that are to be implemented (and their seen Contexts) are selected and added to a ''Tasking Development''; the Tasking Development files have the file extension ''.tasking''. The machines in the Tasking Development are then extended with implementation details.
+
This code generation tutorial extends the Heating Controller tutorial example, and makes use of example projects from the download site. The code generation stage produces Java code, and also an Event-B model. It is a model of the implementation, and contains flow control variables that model the flow of execution through the task body. The Java code is produced from an intermediate model that is not visible to the user. The Common Language model (CLM), is generated from the Tasking Event-B by a translation tool. Java (and other implementations) may be generated from the CLM. An overview of Tasking Event-B can be found [http://wiki.event-b.org/index.php/Tasking_Event-B_Overview here].
  
−
The example/tutorial projects are,
+
In the example so far, the Heating Controller has been refined to the point where we wish to add implementation constructs. The Event-B language is not expressive enough to fully describe the implementation. Tasking Event-B facilitates this final step to implementation, by extending Event-B with the necessary constructs. Event-B machines modelling tasks, shared objects and the environment are identified, and  extended with the appropriate implementation details.
 +
 
 +
The example/tutorial projects are are available from [https://github.com/andyed2003/codeGenExamples Git] or clone [https://github.com/andyed2003/codeGenExamples.git this].
  
 
{| border="1"
 
{| border="1"
−
|Heating_ControllerTutorial_Completed
+
|Heating_ControllerTutorial2_Completed
−
|An example project with a completed Tasking Development and IL1 model (post IL1 translation, but before Event-B translation).
+
|An example project with an environment simulation. The environment variables are monitored and controlled using subroutine calls. The project contains a complete Tasking Development with generated Event-B and Java code.
 
|-
 
|-
−
|Heating_ControllerTutorial_Completed_Gen
+
|Heating_ControllerTutorial2_Partial1
−
|Same as the example project above, but with Event-B model translations. The difference being that this development includes a model of the implementation. These are refinements that include a program counter to describe flow of execution in each task.
+
|A project with the final decomposition completed, ready to begin Tasking Event-B Development.  
 
|-
 
|-
−
|Heating_ControllerTutorial_Step1
+
|Heating_ControllerTutorial2_Partial2
−
|A bare project for step 1 of the [[Code_Generation_Tutorial#The_Tutorial |tutorial]].
+
|A partially completed tasking specification for the continuation of the tutorial.
 
|-
 
|-
−
|Heating_ControllerTutorial_Step2
+
|TheoriesForCG
−
|A partially completed tasking development for steps 2, 3 and 4 of the [[Code_Generation_Tutorial#The_Tutorial |tutorial]].
+
|Contains the mathematical language translations; encoded as rules in a theory plug-in rule-base.
 
|}
 
|}
−
 
−
== Preliminaries ==
 
−
Before further discussion of the modelling aspects, we take a look at the PrettyPrint viewers. The PrettyPrinters make the viewing of IL1 and tasking models easier; it also provides a route to generate source code. The source code can easily be pasted from the IL1 Pretty Printer window into an the Ada source file .
 
−
==== The PrettyPrint View of a Tasking Development ====
 
−
To open the Tasking PrettyPrint viewer,
 
−
* from the top-menu select ''Window/Show View/Other/Tasking Pretty Printer''.
 
−
 
−
Note that the Tasking PrettyPrinter may have to be closed when editing the Tasking Development, since it can give rise to exceptions. The PrettyPrinter would need further work to make it robust, however it is intended only as a short-term solution.
 
−
 
−
* Open the ''Heating_ControllerTutorial_Completed'' Project and switch to the Resource Perspective.
 
−
* Open the ''.tasking'' model and inspect it. Clicking on the Main, Machine or Event nodes updates the pretty print window.
 
−
 
−
==== Viewing Source Code ====
 
−
aka. The PrettyPrint View of an IL1 Model.
 
−
 
−
To view Ada source code,
 
−
* from the top-menu select ''Window/Show View/Other/IL1 Pretty Printer''.
 
−
* Open the ''Heating_ControllerTutorial_Completed'' Project and switch to the Resource Perspective.
 
−
* Open the ''.il1'' model and inspect it. Clicking on the Protected, Main Entry, or Task nodes updates the pretty print window.
 
−
 
−
==== Cleaning the Tasking Development ====
 
−
If the ''.tasking'' file has errors, then it may need cleaning. To do this right-click on the ''Main'' node, select ''Epsilon Translation/CleanUp''. If a model has errors it can still be viewed by clicking on the ''Selection'' tab at the bottom of the tasking editor window.
 
  
 
== Using the Tasking Extension ==
 
== Using the Tasking Extension ==
 
The steps needed to generate code from an Event-B model, in this tutorial, are as follows,
 
The steps needed to generate code from an Event-B model, in this tutorial, are as follows,
−
* Step 1 - [[Tasking Event-B_Tutorial#Creating The Tasking Development|Create the tasking development]].
+
* Step 1 - [[Tasking Event-B_Tutorial#Adding the Implementation Level Refinement|Adding the Implementation Level Refinement]]
−
* Step 2 - [[Tasking Event-B_Tutorial#Providing the Annotations for Implementations|Add Tasking annotations]].
+
* Step 2 - [[Tasking Event-B_Tutorial#Pre-processing|Pre-processing]]
−
* Step 3 - [[Tasking Event-B_Tutorial#Optional Annotations for Addressed Variables|Add annotations for addressed variables (optional)]].
+
* Step 3 - [[Tasking Event-B_Tutorial#Adding Tasking Event-B|Add Tasking annotations]].
 
* Step 4 - [[Tasking Event-B_Tutorial#Invoking the Translation|Invoke translators]].
 
* Step 4 - [[Tasking Event-B_Tutorial#Invoking the Translation|Invoke translators]].
 +
=== Download and Copy the Theories ===
 +
The translations of the Event-B mathematical language to the target language constructs are specified as rules in the theory plug-in. Example rule files are included for the example, and are available in MathExtension from the [https://github.com/andyed2003/codeGenTheoryRepo Git] repository, or clone [https://github.com/andyed2003/codeGenTheoryRepo.git this]. After checking out the theories, they must be un-deployed, then re-deployed, ensuring that the builder creates all of the appropriate files. Right-Click on the theory file and select deploy to do this. If you already have a MathExtensions folder then it should be renamed else the import will be prevented. Files from this folder can be copied and deployed in the new folder if necessary.
  
−
==== Creating The Tasking Development ====
+
=== Adding the Implementation Level Refinement ===
−
* Change to the Event-B Perspective.
+
The final decomposition generates the machines that are required for code generation. However, it is not possible to edit the machines since they are machine generated, and therefore this is prohibited. In order to be able to modify the models we will refine the generated machines. This is where we begin with the ''Heating_ControllerTutorial2_Partial1'' project (Where the pre-processing steps, described below, have been performed already). To refine the machines we can use the automatic refinement feature, but this presents us with two problems that are dealt with in the pre-processing steps.  
−
* Open the ''Heating_ControllerTutorial_Step1'' Project.
 
−
* Select the following Machines: Display_Update_Task1, Envir1, Heater_Monitor_Task1, Shared_Object1, Temp_Ctrl_Task1 and HC_CONTEXT.
 
−
* Right-click and select ''Make Tasking Development/Generate Tasking Development''.
 
−
 
 
−
The new Tasking Development will not be visible in the Event-B perspective, change to the resource perspective, open and inspect the new ''.tasking'' file. The Tasking Development contains (the EMF representation of) the machines that we wish to provide implementations for. In order to introduce the new concepts we have prepared a partially complete development.
 
−
 
 
−
* Change the tasking development, if necessary, so that the machine that models the environment is at the top of the tree of machines.
 
−
 
 
−
In the simulation implementation, elements of the Environ machine must be declared first.
 
−
 
 
−
Change to the Project ''Heating_ControllerTutorial_Step2'' to begin the next step.
 
−
 
 
−
==== Providing the Annotations for Implementations ====
 
−
* Close any Tasking Pretty Print Viewers that remain open. The incomplete model will give rise to exceptions.
 
−
* Go to the to the Resource Perspective.
 
−
* Open and inspect the ''.tasking'' machine.
 
−
 
 
−
The ''Temp_Ctrl_Task1Impl'', ''Envir1'' and ''Shared_Object1'' machines are incomplete. We will take the necessary steps to provide implementation details.  
 
  
−
===== The Temp_Ctrl_Task1Impl Machine =====
+
=== Pre-processing ===
−
In the partially complete tutorial project we have already identified the ''Temp_Ctrl_Task1Impl'' as an ''Auto Task'' Tasking Machine, by adding the ''Auto Task'' extension. ''Auto Tasks'' are tasks that will be declared and defined in the ''Main'' procedure of the implementation. The effect of this is that the ''Auto Tasks'' are created when the program first loads, and then activated (made ready to run) before the ''Main'' procedure body runs. We have added the ''Periodic Task'' extension to the ''Auto Task'', and set a period of 250 milliseconds. We have provided a PrettyPrint view of the completed [http://wiki.event-b.org/images/Temp_Ctrl_Task1Impl.pdf Temp_Ctrl_Task1Impl] that can be read in conjunction with the tutorial.
 
  
−
We will now complete the sequence that has been partially defined in the task body.
+
The pre-processing step, described here, is done automatically by the tool. The description is provided to assist with understanding the changes that occur to a model, during the code generation phase.
  
−
*'''Add Sensing between TCSense_Temperatures and ENSense_Temperatures'''.
+
* The Code Generator requires a flattened, and annotated, version of each machine; all of the Event-B elements are made available in the implementation level machine.  
−
** Expand the Temp_Ctrl_Task1Impl ''Auto Task Machine'' node.
 
−
** Expand the ''Seq'' sub-tree.
 
−
** Right-click on the ''Seq'' node and select ''New Child/Left Branch EventWrapper''.
 
−
** Provide the event label ''tc1'' using the properties view.
 
−
** Right-click on Event Wrapper and select ''New Child/ Synch Events''.
 
−
** Select ''Synch Events'' and go to the drop-down menu of the ''Local Event'' property.
 
−
** At this point the drop-down box displays a number of event names, select the '''second''' ''TCSense_Temperatures'' event.
 
−
** Go to the drop-down menu of the ''Remote Event'' property.
 
−
** From the list of events select the '''first''' ''ENSense_Temperatures'' event.
 
  
−
By relating the sensing events in this way we describe a simulation of the interaction between the task and environment. The details of the interaction are embodied in the events themselves. This is implemented in the simulation code as a write to environment variables using a subroutine call.
+
===== 'Flattening' the Implementation Machines =====
  
−
Note that the Synch Events construct is used in several ways. We use it to implement [[Tasking Event-B Overview#Control Constructs|Event Synchronisation]]; sensing and actuation; and as a simple event wrapper. An example of its use in a simple event wrapper follows. The simple event wrapper is used to update local state; there is no synchronisation, as such, but we re-use the constructs that already exist rather than create new ones. We now add a wrapped event to the sequence:
+
* Events are changed to be ''not extended''.
 +
* Abstract invariants are copied to the implementation level machine.
  
−
*'''Add the Wrapped Event TCCalculate_Average_Temperature'''.
+
===== Annotations are provided automatically =====
−
** Expand the sub-tree of the second ''Seq'' node.
 
−
** Right-click on the ''Seq'' node and select ''New Child/Left Branch EventWrapper''.
 
−
** Provide the event label ''tc2'' using the properties view.
 
−
** Right-click on Event Wrapper and select ''New Child/ Synch Events''.
 
−
** Select ''Synch Events'' and go to the drop-down menu of the ''Local Event'' property.
 
−
** From the list of events select the ''TCCalculate_Average_Temperature'' event.
 
  
−
The addition of the wrapped event, to the sequence, is simply specification of event ordering. It is implemented in code as a sequential subroutine call statement. We now specify event synchronisation between the task and shared object:
+
* Typing annotations are added to typing invariants and axioms where they type variables and constants.
 +
* Parameter directions (in or out) are inferred from the events.
  
−
*'''Add Synchronisation between TCGet_Target_Temperature2 and SOGet_Target_Temperature2'''.
+
=== Manually correcting the Composed Machine ===
−
** Further expand the ''Seq'' sub-tree until Eventwrapper tc3 appears.
 
−
** Right-click on the sibling ''Seq'' node (lowest in the tree) and select ''New Child/Left Branch EventWrapper''.
 
−
** Provide the event label ''tc4'' using the properties view.
 
−
** Right-click on Event Wrapper and select ''New Child/ Synch Events''.
 
−
** Select ''Synch Events'' and go to the drop-down menu of the ''Local Event'' property.
 
−
** At this point the drop-down box displays a number of event names, select the '''second''' ''TCGet_Target_Temperature2'' event.
 
−
** Go to the drop-down menu of the ''Remote Event'' property.
 
−
** From the list of events select the '''second''' ''SOGet_Target_Temperature2'' event.
 
  
−
We have now completed the task body, and next provide additional details for events. In the first instance we focus on the the ''TCGet_Target_Temperature2 '' event in ''Temp_Ctrl_Task1Impl'' which is to be synchronized with the ''SOGet_Target_Temperature2 '' event in ''Shared_Object1Impl''.  
+
The hierarchy created by successive machine decompositions gives rise to a tree of refined events. Only the leaf event nodes are used during code generation. In the current code generator there is no algorithm to navigate this tree automatically. Therefore the composed machine points to the incorrect machines and events.
  
−
*'''Add The Event Synchronisation Extension'''.
+
We must manually change the composed machine to address this problem.
−
** Right-click on the ''TCGet_Target_Temperature2'' Event node.
 
−
** Select ''New Child/Implementation'' from the menu.
 
−
** Go to the Implementation properties view and set the ''Implementation Type'' property to ''ProcedureSynch''.
 
  
−
We have identified the event as one that partakes in a synchronisation.
+
* Modify the lowest level decomposed machine, HCtrl_M1_cmp, to ''include'' the implementation level machines (task names ending in *Impl). To do this,
 +
* open the composed machine editor. Open the INCLUDES edit feature.
 +
* Select the second drop-down box and find the *Impl version of each machine.
 +
* Save the composed machine.
 +
* Now add missing synchronizations to the composed machine. Add the ''Envir1Impl'' to the includes of HCtrl_M1_cmp.
 +
* Each composed event in the task, that synchronizes with the Environ machine, must have the remote event synchronization added manually. This can only be done by inspection of each composed event. We need to update Sense_Temperatures, Display_Current_Temperature, Actuate_OverHeat_Alram, Actuate_Heat_Source, Sense_Heater_Status, Actuate_NoHeat_Alarm, Sense_PressIncrease_Target_Temperature, Sense_PressDecrease_Target_Temperature, Display_Target_Temperature. One by one, expand the events in the composed events section of the composed machine editor; add a new event in the combines events section, select ''Envir1Impl'' and add the synchronizing event from the list-box to the right.
  
−
*'''Identify a parameter direction'''.
+
=== Removing Non-deterministic Constructs ===
−
** Right-click on the ''tm'' node.
 
−
** Select''New Child/Parameter Type''.
 
−
** Go to the ''Parameter Type'' properties view and set the ''Parameter Type'' property to ''actualIn''.
 
  
−
We have now identified the parameter as an actualIn (this models a call's return value).
+
It is also at this stage that any remaining non-deterministic constructs should be removed by replacing them with deterministic constructs.
  
−
Next we look at the sensing event ''TCSense_Temperatures'' event in ''Temp_Ctrl_Task1Impl''. Sensing (and actuating) can be viewed as a kind of synchronisation. The simulation code has a subroutine corresponding to the ''ENSense_Temperatures'' event in the Environ machine ''Envir1Impl'':
+
TIP: Non-deterministic constructs cause strange characters to appear in the source code. If you see strange characters in the generated code, check for non-deterministic constructs in the implementation level machines.
  
−
*'''Add The Sensed Event Extension'''.
+
Alter_Temperature_Sensor1 in Envir1Impl: action becomes ts1 := ts1 + 1
−
** Right-click on the ''TCSense_Temperatures'' Event node.
+
Alter_Temperature_Sensor2 in Envir1Impl: action becomes ts1 := ts1 + 1
−
** Select ''New Child/Implementation'' from the menu.
+
Alter_Heater_Status in Envir1Impl: action becomes hss := FALSE
−
** Go to the Implementation properties view and set the ''Implementation Type'' property to ''Sensing''.
+
INITIALISATION in Heater_Monitor_TaskImpl: becomes shs := FALSE
  
−
We have identified the event as a sensing event. Now we add the parameter direction:
+
=== Adding Tasking Event-B ===
  
−
*'''Identify parameter directions'''.
+
*Setting Context attributes.
−
** Right-click on the ''t1'' node.
+
**Using the project ''Heating_ControllerTutorial2_Partial1''.  
−
** Select''New Child/Parameter Type''.
+
**Open the context, select the Tasking Context drop-down box, and select Tasking, as the type for the context.  
−
** Go to the ''Parameter Type'' properties view and set the ''Parameter Type'' property to ''actualIn''.
 
−
** Right-click on the ''t2'' node.
 
−
** Select''New Child/Parameter Type''.
 
−
** Go to the ''Parameter Type'' properties view and set the ''Parameter Type'' property to ''actualIn''.
 
  
−
We have now identified the parameters as an actualIn (modelling a simulation's subroutine call return value).
+
Each Machine should be completed as follows.
 +
==== The Temp_Ctrl_TaskImpl Machine ====
 +
During this part of the tutorial we will cut and paste from ''Heating_ControllerTutorial2_Completed'' model when, specifying the task bodies, to save typing. We use the 'Event-B Machine Editor' to edit the Tasking Event-B.
  
−
===== The Shared Machine =====
+
*In the Tasking section of the Event-B editor, click on + to add a new Machine Type construct.
 +
**The machine type defaults to ''Auto Task''.
 +
**Click on the right-arrow symbol by ''Machine Type''.
 +
**Add a new Task Type section by clicking on its green + symbol.
 +
**A Machine Type element is added. The task type defaults to ''Periodic''
 +
**Set a period of 250 milliseconds.
 +
*'''Add a new TaskBody'''.
 +
**Add a new Task Body section by clicking on its green + symbol.
 +
**Copy and paste the task body from ''Heating_ControllerTutorial2_Completed/Temp_Ctrl_TaskImpl''
 +
**Save the model. Ignore the highlighted typing errors, since these annotations will be added by the code generator during pre-processing.
  
−
The next step is to identify the ''Shared_Object1Impl'' machine as a ''Shared Machine''. A PrettyPrint view of the [http://wiki.event-b.org/images/Shared_Object1Impl.pdf Shared_Object1Impl] shared machine can be read in conjunction with the text. The ''Shared_Object1Impl'' Machine will be extended using the Event-B extension mechanism.
+
''Auto Tasks'' are tasks that will be declared and defined in the ''Main'' procedure of the implementation. The effect of this is that the ''Auto Tasks'' are created when the program first loads, and then activated (made ready to run) before the ''Main'' procedure body runs.
−
* Right-click on the ''Shared_Object'' Machine node in the ''.tasking'' file.
 
−
* Select ''New Child/Shared Machine'' from the menu.
 
  
−
We now show how to extend the ''SOGet_Target_Temperature2'' event of the Shared Machine with details about its implementation. The ''SOGet_Target_Temperature2'' event in ''Shared_Object1Impl'' synchronizes with the ''TCGet_Target_Temperature2'' event in the '' Temp_Ctrl_Task1Impl''.
+
==== The Shared Machine ====
  
−
* '''Identify SOGet_Target_Temperature2 as a Synchronized event'''.
+
The next step is to identify the ''Shared_ObjectImpl'' machine as a ''Shared Machine''.
−
** Right-click on the ''SOGet_Target_Temperature2 '' Event node.
+
*Open the Tasking Section.
−
** Select ''New Child/Implementation'' from the menu.
+
*Add a Machine Type by clicking +.
−
** Go to the Implementation properties view and set the ''Implementation Type'' property to ''ProcedureSynch''.
+
* Select ''Shared'' in the Machine Type drop Down box.
  
−
* '''Identify the outgoing (return) parameter'''.
+
==== The Environ Machine ====
−
** Right-click on the ''tm'' node.
+
We identify the ''Envir1Impl'' as an ''Environ Machine'',
−
** Select ''New Child/Parameter Type''.
 
−
** Go to the ''Parameter Type'' properties view and set the ''Parameter Type'' property to ''formalOut''.
 
  
−
===== The Environ Machine =====
+
*Click on +, in the Machine Editor, to add a to add a Tasking Section.
−
In the prepared machine we have identified the ''Envir1Impl'' as an ''Environ Machine'', by adding the ''Environ Machine'' extension. ''Envir1Impl'' models a task that simulates the environment, and can be used to generate simulation code. For deployment in a non-simulated environment the environ machine's generated code can be ignored; we provide details of non-simulated code using addressed variables later. As before, a [http://wiki.event-b.org/images/Envir1Impl_2.pdf PrettyPrint] view is available. We have added the ''Periodic Task'' extension to the ''Auto Task'', and set a period of 100 milliseconds.
+
*A Machine Type element is created.
−
+
*Select ''Environ Machine'' in the drop down box.  
−
We will now complete the sequence that has been partially defined in the task body. The following specification models simulation of a temperature change; the temperature value is represented by a monitored variable in the environment. The generated code simulates the temperature change in the environment by changing the monitored value. 
 
  
−
*'''Model Temperature Change in the environment'''.
+
*In the Tasking section of the Event-B editor, click on + to add a new Machine Type construct.
−
** Expand the Environ1Impl ''Environ Machine'' node.
+
**The machine type defaults to ''Auto Task'', change it to ''Environ''.
−
** Expand the ''Seq'' sub-tree fully.
+
**Click on the right-arrow symbol by ''Machine Type''.
−
** Right-click on the last ''Seq'' node in the tree and and select ''New Child/Left Branch EventWrapper''.
+
**Add a new Task Type section by clicking on its green + symbol.
−
** Provide the event label ''e4'' using the properties view.
+
**A Machine Type element is added. The task type defaults to ''Periodic''
−
** Right-click on Event Wrapper and select ''New Child/ Synch Events''.
+
**Set a period of 100 milliseconds.  
−
** Select ''Synch Events'' and go to the drop-down menu of the ''Local Event'' property.
+
*'''Add a new TaskBody'''.
−
** At this point the drop-down box displays a number of event names, select the '''first''' ''ENAlter_Temperature_Sensor1'' event.
+
**Add a new Task Body section by clicking on its green + symbol.
 +
**Copy and paste the task body from ''Heating_ControllerTutorial2_Completed/Envir1Impl''
 +
**Save the model.
  
−
Output to the screen during the simulation can be specified as follows:
+
In the implementation, ''Environ Tasks'' are declared and defined in the ''Main'' procedure . The ''Envir1Impl'' machine models a task that simulates the environment, and can be used to generate simulation code. For deployment in a non-simulated environment the environ machine's generated code can be ignored. To specify the Environment task's behaviour we add edit the task body.
  
−
*'''Text Output during Simulation.'''.
+
When saving, the task body text is sent to the parser. If parsing is successful then a builder adds the structure to the underlying EMF tree. If parsing fails then an error panel displays the source of the error.
−
** Right-click on the last ''Seq'' node in the tree and and select ''New Child/Right Branch Output''.
 
−
** Select the ''Output'' node, and in the properties menu select the ''Element'' property drop down box.  
 
−
** Select the ''last'' variable ''ctd'' that appears in the list.
 
−
** In the ''Text'' property field, add a textual description to accompany the text output.
 
  
−
The generated code will print the text, and the value of the variable, to the screen. The next step is to identify the ''ENAlter_Temperature_Sensor1'' as a ''ProcedureDef''.
+
== Invoking the Translators ==
  
−
* '''Identify ENAlter_Temperature_Sensor1 as a ProcedureDef event'''.
+
* To generate code,
−
** Right-click on the ''ENAlter_Temperature_Sensor1'' Event node.
+
** Right-Click on the composed machine, or any tasking machine in the development, select ''Code Generation/Translate Event-B to xx'' where ''xx'' is the chosen language.
−
** Select ''New Child/Implementation'' from the menu.
+
** Open the generated ''code'' directory in the project to view the source files.  
−
** Go to the Implementation properties view and set the ''Implementation Type'' property to ''ProcedureDef''.
 
−
 
 
−
The final step is to complete the ''ENSense_Temperatures'' event. The event is a sensing event, sensing is a kind of synchronisation, it synchronises with the ''TCSense_Temperatures'' event. We add formal parameters annotations corresponding to the actual parameters that we have already defined in the task.
 
−
 
 
−
*'''Add The Sensed Event Extension'''.
 
−
** Right-click on the ''ENSense_Temperatures'' Event node.
 
−
** Select ''New Child/Implementation'' from the menu.
 
−
** Go to the Implementation properties view and set the ''Implementation Type'' property to ''Sensing''.
 
−
 
 
−
We have identified the event as a sensing event. Now we add the parameter direction:
 
−
 
 
−
*'''Identify parameter directions'''.
 
−
** Right-click on the ''t1'' node.
 
−
** Select''New Child/Parameter Type''.
 
−
** Go to the ''Parameter Type'' properties view and set the ''Parameter Type'' property to ''formalOut''.
 
−
** Right-click on the ''t2'' node.
 
−
** Select''New Child/Parameter Type''.
 
−
** Go to the ''Parameter Type'' properties view and set the ''Parameter Type'' property to ''formalOut''.
 
−
 
 
−
We have now identified the parameters as an formalOut (modelling a simulation's subroutine call return value). This completes the necessary annotations for the simulation, and we can proceed to the translation step. In the event that memory mapped IO is required (non-simulation) then addresses can be added to the model at this stage, before translation takes place. See section on [http://wiki.event-b.org/index.php/Tasking_Event-B_Tutorial#Optional_Annotations_for_Addressed_Variables Addressed Variables] for details.
 
−
 
 
−
===== A Summary of Steps =====
 
−
If generating environment simulation code:
 
−
# Ensure the Environ Machine is first machine in the development.
 
−
 
 
−
For a Tasking Machine definition:
 
−
# Add the Tasking Machine type (Auto etc).
 
−
# Add the task type (Periodic etc.).
 
−
# Define the task priority.
 
−
# Define the task body.
 
−
# For each event, add the Event Type.
 
−
# For each event parameter, add the Parameter Type.
 
−
# Optionally define addressed variables.
 
−
 
 
−
For a Shared Machine definition:
 
−
# Add the ''SharedMachine'' Machine type.
 
−
# For each event, define the Event Type.
 
−
# For each event parameter, define the Parameter Type.
 
−
 
 
−
For an Environ Machine definition:
 
−
# Make the type an Auto Tasking Machine type.
 
−
# Make the task type Periodic; a shorter period than the shortest task period is best for simulation.
 
−
# Define the task priority.
 
−
# Define the task body, it will contain a simulation of changes in the environment.
 
−
# For each event, add the Event Type.
 
−
# For each event parameter, add the Parameter Type.
 
−
# Optionally define addressed variables.
 
−
 
 
−
==== Invoking the Translation ====
 
−
 
 
−
* To create the IL1 model,
 
−
** Right-Click on the Main node, select ''Epsilon Translation/Translate Task Mch 2 IL1 EMF''.
 
−
** Open the Resource Perspective.
 
−
** Right-click on the ''sharedbuffer20100819Tutorial2'' project folder.
 
−
** Select refresh, the ''.il1'' file should appear in the project.
 
−
** Open and inspect the file, and view the source code by opening the IL1 Pretty Print view if desired.
 
  
 
* To create the Event-B model of the implementation,
 
* To create the Event-B model of the implementation,
−
** Return to the Rodin Modelling Perspective.
+
** Right-Click on the composed machine, or any tasking machine in the development, select ''Code Generation/Translate Tasking Event-B to Event-B''.
−
** Right-Click on the Main node, select ''Epsilon Translation/Translate Task Mch 2 Event-B EMF''.
+
** The Event-B model should be updated with the flow control variables. Users are not able to manually edit the generated elements. The additions can be removed using the menu option ''Code Generation/Remove Generated Event-B''
−
** The ''sharedbuffer20100819bTasking'' project is generated, it can be opened and inspected.
 
−
 
 
−
There are errors in the generated machines (not investigated the cause yet); these can be fixed in the following way.
 
−
* Open a Machine in the Event-B Machine Editor.
 
−
* Select the Edit tab.
 
−
* Open the REFINES section, the error lies here.
 
−
* The correct machine is refined, but choose a different machine to refine (any one, it doesn't matter).
 
−
* Select the original refined machine again.
 
−
* Save and clean the project, and the error should disappear.
 
−
* Repeat for the same errors in the other machines; save and clean again.
 
−
* The machines can viewed as normal using the Rodin editors.
 
−
 
 
−
==== Optional Annotations for Addressed Variables ====
 
−
 
 
−
Link To Addressed Variables!!!!!
 
−
 
 
−
 
 
−
 
 
  
 +
=== Generated Code ===
 +
Generated code will be visible in the code directory, in the Event-B project. However a refresh of the workspace is required. The directory is visible in the resource view; or alternatively, click on the view menu in the Event-B perspective, select customize view, and uncheck the ''all file and folders'' filter.
 
[[Category:User documentation]]
 
[[Category:User documentation]]

Latest revision as of 12:41, 2 September 2013

For more information contact Andy Edmunds - University of Southampton - mailto:ae2@ecs.soton.ac.uk

<< I AM UPDATING THIS PAGE >>

Tasking Event-B Tutorial Overview

This tutorial follows on from the abstract development described here.

This code generation tutorial extends the Heating Controller tutorial example, and makes use of example projects from the download site. The code generation stage produces Java code, and also an Event-B model. It is a model of the implementation, and contains flow control variables that model the flow of execution through the task body. The Java code is produced from an intermediate model that is not visible to the user. The Common Language model (CLM), is generated from the Tasking Event-B by a translation tool. Java (and other implementations) may be generated from the CLM. An overview of Tasking Event-B can be found here.

In the example so far, the Heating Controller has been refined to the point where we wish to add implementation constructs. The Event-B language is not expressive enough to fully describe the implementation. Tasking Event-B facilitates this final step to implementation, by extending Event-B with the necessary constructs. Event-B machines modelling tasks, shared objects and the environment are identified, and extended with the appropriate implementation details.

The example/tutorial projects are are available from Git or clone this.

Heating_ControllerTutorial2_Completed An example project with an environment simulation. The environment variables are monitored and controlled using subroutine calls. The project contains a complete Tasking Development with generated Event-B and Java code.
Heating_ControllerTutorial2_Partial1 A project with the final decomposition completed, ready to begin Tasking Event-B Development.
Heating_ControllerTutorial2_Partial2 A partially completed tasking specification for the continuation of the tutorial.
TheoriesForCG Contains the mathematical language translations; encoded as rules in a theory plug-in rule-base.

Using the Tasking Extension

The steps needed to generate code from an Event-B model, in this tutorial, are as follows,

Download and Copy the Theories

The translations of the Event-B mathematical language to the target language constructs are specified as rules in the theory plug-in. Example rule files are included for the example, and are available in MathExtension from the Git repository, or clone this. After checking out the theories, they must be un-deployed, then re-deployed, ensuring that the builder creates all of the appropriate files. Right-Click on the theory file and select deploy to do this. If you already have a MathExtensions folder then it should be renamed else the import will be prevented. Files from this folder can be copied and deployed in the new folder if necessary.

Adding the Implementation Level Refinement

The final decomposition generates the machines that are required for code generation. However, it is not possible to edit the machines since they are machine generated, and therefore this is prohibited. In order to be able to modify the models we will refine the generated machines. This is where we begin with the Heating_ControllerTutorial2_Partial1 project (Where the pre-processing steps, described below, have been performed already). To refine the machines we can use the automatic refinement feature, but this presents us with two problems that are dealt with in the pre-processing steps.

Pre-processing

The pre-processing step, described here, is done automatically by the tool. The description is provided to assist with understanding the changes that occur to a model, during the code generation phase.

  • The Code Generator requires a flattened, and annotated, version of each machine; all of the Event-B elements are made available in the implementation level machine.
'Flattening' the Implementation Machines
  • Events are changed to be not extended.
  • Abstract invariants are copied to the implementation level machine.
Annotations are provided automatically
  • Typing annotations are added to typing invariants and axioms where they type variables and constants.
  • Parameter directions (in or out) are inferred from the events.

Manually correcting the Composed Machine

The hierarchy created by successive machine decompositions gives rise to a tree of refined events. Only the leaf event nodes are used during code generation. In the current code generator there is no algorithm to navigate this tree automatically. Therefore the composed machine points to the incorrect machines and events.

We must manually change the composed machine to address this problem.

  • Modify the lowest level decomposed machine, HCtrl_M1_cmp, to include the implementation level machines (task names ending in *Impl). To do this,
  • open the composed machine editor. Open the INCLUDES edit feature.
  • Select the second drop-down box and find the *Impl version of each machine.
  • Save the composed machine.
  • Now add missing synchronizations to the composed machine. Add the Envir1Impl to the includes of HCtrl_M1_cmp.
  • Each composed event in the task, that synchronizes with the Environ machine, must have the remote event synchronization added manually. This can only be done by inspection of each composed event. We need to update Sense_Temperatures, Display_Current_Temperature, Actuate_OverHeat_Alram, Actuate_Heat_Source, Sense_Heater_Status, Actuate_NoHeat_Alarm, Sense_PressIncrease_Target_Temperature, Sense_PressDecrease_Target_Temperature, Display_Target_Temperature. One by one, expand the events in the composed events section of the composed machine editor; add a new event in the combines events section, select Envir1Impl and add the synchronizing event from the list-box to the right.

Removing Non-deterministic Constructs

It is also at this stage that any remaining non-deterministic constructs should be removed by replacing them with deterministic constructs.

TIP: Non-deterministic constructs cause strange characters to appear in the source code. If you see strange characters in the generated code, check for non-deterministic constructs in the implementation level machines. 

Alter_Temperature_Sensor1 in Envir1Impl: action becomes ts1 := ts1 + 1
Alter_Temperature_Sensor2 in Envir1Impl: action becomes ts1 := ts1 + 1
Alter_Heater_Status in Envir1Impl: action becomes hss := FALSE
INITIALISATION in Heater_Monitor_TaskImpl: becomes shs := FALSE

Adding Tasking Event-B

  • Setting Context attributes.
    • Using the project Heating_ControllerTutorial2_Partial1.
    • Open the context, select the Tasking Context drop-down box, and select Tasking, as the type for the context.

Each Machine should be completed as follows.

The Temp_Ctrl_TaskImpl Machine

During this part of the tutorial we will cut and paste from Heating_ControllerTutorial2_Completed model when, specifying the task bodies, to save typing. We use the 'Event-B Machine Editor' to edit the Tasking Event-B.

  • In the Tasking section of the Event-B editor, click on + to add a new Machine Type construct.
    • The machine type defaults to Auto Task.
    • Click on the right-arrow symbol by Machine Type.
    • Add a new Task Type section by clicking on its green + symbol.
    • A Machine Type element is added. The task type defaults to Periodic
    • Set a period of 250 milliseconds.
  • Add a new TaskBody.
    • Add a new Task Body section by clicking on its green + symbol.
    • Copy and paste the task body from Heating_ControllerTutorial2_Completed/Temp_Ctrl_TaskImpl
    • Save the model. Ignore the highlighted typing errors, since these annotations will be added by the code generator during pre-processing.

Auto Tasks are tasks that will be declared and defined in the Main procedure of the implementation. The effect of this is that the Auto Tasks are created when the program first loads, and then activated (made ready to run) before the Main procedure body runs.

The Shared Machine

The next step is to identify the Shared_ObjectImpl machine as a Shared Machine.

  • Open the Tasking Section.
  • Add a Machine Type by clicking +.
  • Select Shared in the Machine Type drop Down box.

The Environ Machine

We identify the Envir1Impl as an Environ Machine,

  • Click on +, in the Machine Editor, to add a to add a Tasking Section.
  • A Machine Type element is created.
  • Select Environ Machine in the drop down box.
  • In the Tasking section of the Event-B editor, click on + to add a new Machine Type construct.
    • The machine type defaults to Auto Task, change it to Environ.
    • Click on the right-arrow symbol by Machine Type.
    • Add a new Task Type section by clicking on its green + symbol.
    • A Machine Type element is added. The task type defaults to Periodic
    • Set a period of 100 milliseconds.
  • Add a new TaskBody.
    • Add a new Task Body section by clicking on its green + symbol.
    • Copy and paste the task body from Heating_ControllerTutorial2_Completed/Envir1Impl
    • Save the model.

In the implementation, Environ Tasks are declared and defined in the Main procedure . The Envir1Impl machine models a task that simulates the environment, and can be used to generate simulation code. For deployment in a non-simulated environment the environ machine's generated code can be ignored. To specify the Environment task's behaviour we add edit the task body.

When saving, the task body text is sent to the parser. If parsing is successful then a builder adds the structure to the underlying EMF tree. If parsing fails then an error panel displays the source of the error.

Invoking the Translators

  • To generate code,
    • Right-Click on the composed machine, or any tasking machine in the development, select Code Generation/Translate Event-B to xx where xx is the chosen language.
    • Open the generated code directory in the project to view the source files.
  • To create the Event-B model of the implementation,
    • Right-Click on the composed machine, or any tasking machine in the development, select Code Generation/Translate Tasking Event-B to Event-B.
    • The Event-B model should be updated with the flow control variables. Users are not able to manually edit the generated elements. The additions can be removed using the menu option Code Generation/Remove Generated Event-B

Generated Code

Generated code will be visible in the code directory, in the Event-B project. However a refresh of the workspace is required. The directory is visible in the resource view; or alternatively, click on the view menu in the Event-B perspective, select customize view, and uncheck the all file and folders filter.

Retrieved from ‘https://wiki.event-b.org/index.php?title=Tasking_Event-B_Tutorial&oldid=10103’