imported>Andy |
|
| Line 1: |
Line 1: |
| − | For more information contact Andy Edmunds - University of Southampton - mailto:ae2@ecs.soton.ac.uk
| |
| − | === Tasking Event-B Tutorial Overview ===
| |
| | | | |
| − | <span style="color: RED">'''Caution''': This Page is under Construction - some parts are incomplete</span>
| |
| − |
| |
| − | This tutorial follows on from the abstract development described [http://wiki.event-b.org/index.php/Development_of_a_Heating_Controller_System 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 implementable Ada 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 Ada 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. Ada (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].
| |
| − |
| |
| − | 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 in the [http://deploy-eprints.ecs.soton.ac.uk/304/ e-prints archive], or on [https://codegenerationd.svn.sourceforge.net/svnroot/codegenerationd/Examples/Heating_ControllerTutorial_v0.2.0/ SVN].
| |
| − |
| |
| − | {| border="1"
| |
| − | |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 Ada 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,
| |
| − | * Step 1 - [[Tasking Event-B_Tutorial#Adding the Implementation Level Refinement|Adding the Implementation Level Refinement]]
| |
| − | * Step 2 - [[Tasking Event-B_Tutorial#Pre-processing|Pre-processing]]
| |
| − | * Step 3 - [[Tasking Event-B_Tutorial#Providing the Annotations for Implementations|Add Tasking annotations]].
| |
| − | * 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. Two rule files are included for the example, and are available in the [https://codegenerationd.svn.sourceforge.net/svnroot/codegenerationd/Examples/Heating_ControllerTutorial_v0.2.0/ SVN]. The files can be downloaded and copied into an Event-B project called ''MathExtensions''. The theory must then be deployed. Right-Click on the theory file and select deploy to do this. The non-Event-B project, the original download may now be deleted.
| |
| − |
| |
| − | === 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. 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 step. 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
| |
| − |
| |
| − | We also need to add a typing flag to an invariant. We need to add it in only one place, and this is where an invariant is used type a variable, in the Heating Controller machine. The flag is used to guide the translator to the typing invariant. This is because there is more than one invariant involving that particular variable. They may also be added to guards where parameters are typed in guards, and the parameters are referred to in more than one guard.
| |
| − |
| |
| − | * Go to the ''Heater_Monitor_TaskImpl typing_shs'' invariant.
| |
| − | * Add the typing flag, by right-clicking on the invariant and selecting typing from the menu.
| |
| − |
| |
| − | === Pre-processing ===
| |
| − |
| |
| − | The pre-processing step should be a temporary, the solutions can be incorporated into the tool to automatically perform the changes that are required.
| |
| − |
| |
| − | * The Code Generator requires a flattened version of each machine; all of the Event-B elements should be available in the implementation level machine.
| |
| − | * Composed machines are not currently able to be refined, so anything that requires synchronization of events requires some manual updates.
| |
| − |
| |
| − | ===== 'Flattening' the Implementation Machines =====
| |
| − |
| |
| − | The temporary solution for flattening:
| |
| − | * Make events ''not extended''.
| |
| − | * Copy missing invariants.
| |
| − |
| |
| − | I found the Event-B Machine Editor's synthesis view useful for this. Invariants can be copy-pasted into the implementation machine from the abstraction. (A dummy invariant can be added and selected for pasting)
| |
| − |
| |
| − | ===== Providing the correct Composed Machine =====
| |
| − |
| |
| − | The composed machine problem is sub-divided into two sub-problems. Firstly composed machines cannot be refined, and secondly when a machine is further decomposed there is no link between the first composed machine and the newly generated composed machine. So one or both of these problems may occur, depending on the number of decompositions.
| |
| − |
| |
| − | We must manually add the information to the composed machines to address these two problems.
| |
| − |
| |
| − | The temporary solution for composed machines:
| |
| − | * 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.
| |
| − |
| |
| − | === Adding Tasking Event-B ===
| |
| − | Each Machine should be completed as follows.
| |
| − | ==== The Temp_Ctrl_TaskImpl Machine ====
| |
| − | Continuing with the tutorial project ''Heating_ControllerTutorial2_Partial2'', we need to make changes to the following machines. During the tutorial we will cut and paste from ''Heating_ControllerTutorial2_Completed'' model when, specifying the task bodies, to save typing.
| |
| − |
| |
| − | *Add the ''Auto Task'' extension.
| |
| − | **Right-Click on the Machine node in the Rose tree-editor,
| |
| − | **and click on ''New Child Element/Auto Task Machine'' menu option.
| |
| − |
| |
| − | ''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.
| |
| − |
| |
| − | *'''Edit the TaskBody'''.
| |
| − | **Open the properties editor for the task body.
| |
| − | **Copy and paste the task body from ''Heating_ControllerTutorial2_Completed/Temp_Ctrl_Task1Impl''
| |
| − | **Set the task type to ''Periodic'',
| |
| − | **Set a period of 250 milliseconds.
| |
| − | **Click on the Set Task Body button.
| |
| − |
| |
| − | The task body is parsed, and if successful will add the structure to the EMF tree. If parsing is not successful an error panel will display the source of the error.
| |
| − |
| |
| − | We now look at the sensing event ''Sense_Temperatures'' event in ''Temp_Ctrl_TaskImpl''. In order to assist with the translation we add the following annotation:
| |
| − |
| |
| − | *'''Add a Sensed Event Annotation'''.
| |
| − | ** Right-click on the ''Sense_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 now look at the actuating event ''Display_Current_Temperatures'' event in ''Temp_Ctrl_TaskImpl''. In order to assist with the translation we add the following annotation:
| |
| − |
| |
| − | *'''Add an Actuating Event Annotation'''.
| |
| − | ** Right-click on the ''Display_Current_Temperatures'' Event node.
| |
| − | ** Select ''New Child/Implementation'' from the menu.
| |
| − | ** Go to the Implementation properties view and set the ''Implementation Type'' property to ''Actuating''.
| |
| − |
| |
| − | ==== The Shared Machine ====
| |
| − |
| |
| − | The next step is to identify the ''Shared_ObjectImpl'' machine as a ''Shared Machine''.
| |
| − | * Right-click on the ''Shared_Object'' Machine node in the Rose tree-editor.
| |
| − | * Select ''New Child/Shared Machine'' from the menu.
| |
| − |
| |
| − | ==== The Environ Machine ====
| |
| − | In the prepared machine we identify the ''Envir1Impl'' as an ''Environ Machine'',
| |
| − |
| |
| − | *Add the ''Environ Machine'' extension.
| |
| − | **Right-click on the Machine node in the Rose tree-editor.
| |
| − | **Select
| |
| − |
| |
| − |
| |
| − |
| |
| − | ''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 screenshot is available [http://wiki.event-b.org/images/Envir1Impl_2.pdf here]. In the prepared Environment Machine we have already set task type to ''Periodic'' extension, and set a period of 100 milliseconds.
| |
| − |
| |
| − | 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'''.
| |
| − | ??????
| |
| − |
| |
| − | * Output to the screen during the simulation can be specified as follows:
| |
| − | ??????
| |
| − |
| |
| − | The generated code will print the text, and the value of the variable, to the screen.
| |
| − |
| |
| − | 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 in the ''Temp_Ctrl_Task1'' tasking machine. We add formal parameters annotations corresponding to the actual parameters that we have already defined in the task.
| |
| − |
| |
| − | *'''Add a Sensed Event Annotation'''.
| |
| − | ** Right-click on the ''Sense_Temperatures'' Event node.
| |
| − | ** Select ''New Child/Implementation'' from the menu.
| |
| − | ** Go to the Implementation properties view and set the ''Implementation Type'' property to ''Sensing''.
| |
| − |
| |
| − | *'''Add an Actuating Event Annotation'''.
| |
| − | ** Right-click on the ''Display_Current_Temperatures'' Event node.
| |
| − | ** Select ''New Child/Implementation'' from the menu.
| |
| − | ** Go to the Implementation properties view and set the ''Implementation Type'' property to ''Actuating''.
| |
| − |
| |
| − | === A Summary of Steps ===
| |
| − | For a Tasking Machine definition:
| |
| − | # Add the Tasking Machine type (Auto etc).
| |
| − | # Set the task type (Periodic etc.).
| |
| − | # Set the task priority.
| |
| − | # Specify the task body.
| |
| − | # For sensing/actuating events, add the Event Type.
| |
| − |
| |
| − | For a Shared Machine definition:
| |
| − | # Add the ''SharedMachine'' Machine type.
| |
| − |
| |
| − | For an Environ Machine definition:
| |
| − | # Make the type an Environ Machine type.
| |
| − | # Set the task type Periodic; a shorter period than the shortest task period is best for simulation.
| |
| − | # Set the task priority.
| |
| − | # Specify the task body, it will contain a simulation of changes in the environment.
| |
| − | # For each sensing/actuating event, add the Event Type.
| |
| − |
| |
| − | == Invoking the Translators ==
| |
| − |
| |
| − | * To generate Ada code,
| |
| − | ** Right-Click on the composed machine, or any tasking machine in the development, select ''Code Generation/Translate Event-B to Ada''.
| |
| − | ** Open the generated ''code'' directory in the project to view the source files. A refresh will be necessary to make the code visible. The .gpr file has been provided for AdaCore GPS users.
| |
| − |
| |
| − | * 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 ==
| |
| − | The Ada Code generated by the translator is available at the following links:
| |
| − |
| |
| − | for simulation of environment without addressed variables, [http://wiki.event-b.org/images/Code_Heating_ControllerTutorial_Completed.pdf Heating_ControllerTutorial_Completed]
| |
| − |
| |
| − | for simulation of environment with addressed variables, [http://wiki.event-b.org/images/Code_Heating_Controller5AddressedSim_Completed.pdf Heating_Controller5AddressedSim_Completed]
| |
| − |
| |
| − | Removal of the environment task from the ''Heating_Controller5AddressedSim_Completed'' should be deployable.
| |
| − |
| |
| − | [[Category:User documentation]]
| |
