Difference between pages "SMT Solvers Plug-in" and "Tasking Event-B Tutorial"

From Event-B
(Difference between pages)
Jump to navigationJump to search
imported>YGU
m
 
imported>Andy
 
Line 1: Line 1:
''For developer support, see [[SMT Solvers Plug-in Developer Support]]''
+
For more information contact Andy Edmunds - University of Southampton - mailto:ae2@ecs.soton.ac.uk
{| align="right"
+
=== Tasking Event-B Tutorial Overview ===
| __TOC__
+
This tutorial follows on from the abstract development described [http://wiki.event-b.org/index.php/Development_of_a_Heating_Controller_System here].
|}
 
  
==Introduction==
+
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].
The SMT plug-in allows users to use SMT solvers within Rodin. It is still in development (See sources [https://rodin-b-sharp.svn.sourceforge.net/svnroot/rodin-b-sharp/trunk/_exploratory/fages/]).
 
  
==Installation==
+
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.
You will need to:
 
* Install the Rodin Platform.
 
* Install the SMT Solvers Plug-in into Rodin.
 
** Install veriT if you want to use it (instead of ppTrans) to translate Event-B to SMT-LIB.
 
* Install the SMT solvers you want to use.
 
  
=== Installing the Rodin Platform ===
+
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/HeatingController_Tutorial_v0.1.4/ SVN].
Download the Rodin Platform 2.3 (Core) (around 61MB) corresponding to your operating system and install it [http://www.event-b.org/install.html].
 
  
=== Installing the SMT Solvers Plug-in ===
+
{| border="1"
Launch Rodin and go to ''Help > Install New Software...''.
+
|Heating_ControllerTutorial_Completed
 
+
|An example project generating an environment simulation. Generates code, where environment variables are monitored and controlled using subroutine calls. Contains a completed Tasking Development with generated Event-B and Ada code.
[[Image:Install_new_software.png|450px]]
+
|-
 
+
|Heating_ControllerTutorial_Step1
 
+
|A bare project for step 1 of the [[Code_Generation_Tutorial#The_Tutorial |tutorial]].
Select the Rodin Platform Update Site: http://rodin-b-sharp.sourceforge.net/updates.
+
|-
 
+
|Heating_ControllerTutorial_Step2
[[Image:Select_update_site.png|450px]]
+
|A partially completed tasking development for steps 2, and 4 of the [[Code_Generation_Tutorial#The_Tutorial |tutorial]] (step 3 not required here).
 
+
<!--|- >
 
+
<!--|Heating_Controller5AddressedSim_Completed>
Unfold the ''Prover Extensions'' category, and select the ''SMT Solvers Integration'' feature. Click ''Next''.
+
<!--|A completed example that uses Addressed Variables in the tasks, and also in the environment simulation. Generates Memory Mapped IO for sensing and actuation. >
 
+
<!--|->
[[Image:Select_smt_feature.png|450px]]
+
<!--|Heating_Controller5AddressedNotSim_Completed>
 
+
<!--|A completed example that uses Addressed Variables in the tasks only. Generates Deployable Memory Mapped IO for sensing and actuation. Similar to above but we discard the environment task from generated code.
 
+
|}
Review the item to be installed and click ''Next''.
 
  
[[Image:Review_install_details.png|450px]]
+
== 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.
  
Read and accept the terms of the license agreement to install the plug-in. Then click ''Finish''.
+
* 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.
  
[[Image:Review_licenses.png|450px]]
+
==== 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.
  
A security warning appears because the feature content is unsigned. Click ''Ok''.
+
==== 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.
  
[[Image:Security_warning.png|450px]]
+
== 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#Creating The Tasking Development|Create the tasking development]].
 +
* Step 2 - [[Tasking Event-B_Tutorial#Providing the Annotations for Implementations|Add Tasking annotations]].
 +
* Step 3 - [[Tasking Event-B_Tutorial#Optional Annotations for Addressed Variables|Add annotations for addressed variables (optional)]].
 +
* Step 4 - [[Tasking Event-B_Tutorial#Invoking the Translation|Invoke translators]].
  
 +
==== Creating The Tasking Development ====
 +
* Change to the Event-B Perspective.
 +
* 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''.
  
Click ''Restart Now''.
+
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.  
  
The SMT Solvers Plug-in is now installed.
+
* Change the tasking development, if necessary, so that the machine that models the environment is at the top of the list of machines.
  
=== Installing the SMT solvers ===
+
This is due to a temporary technical limitation in the translator.
Currently, the SMT plug-in has been tested with the following solvers:
 
* Alt-Ergo (INRIA Saclay)
 
* CVC3 (New York and Iowa Universities)
 
* veriT (Loria Nancy and UFRN)
 
* Z3 (Microsoft Research)
 
  
==== Installing veriT ====
+
Change to the Project ''Heating_ControllerTutorial_Step2'' to begin the next step.
veriT solver can be downloaded at http://www.verit-solver.org/veriT-download.php. Compilation and installation instructions are in the ''INSTALL'' file. You must set off proof production in ''Makefile.config'', because the SMT plug-in needs solvers to check satisfiability only:
 
PROOF_PRODUCTION = NO
 
# PROOF_PRODUCTION = YES
 
  
The following tools are used in the installation process (Debian/Ubuntu platforms):
+
==== Providing the Annotations for Implementations ====
* gcc, g++: compilers
+
* Close any Tasking Pretty Print Viewers that remain open. The incomplete model will give rise to exceptions.
* make, ar, ranlib: build process
+
* Go to the to the Resource Perspective.
* wget, tar, patch: to fetch GMP and Minisat
+
* Open and inspect the ''.tasking'' machine.
* bison, flex, m4: build compilers and preprocessing
 
  
Do not forget to install the E-prover as well[http://eprover.org/] (''eprover'' package on Ubuntu platforms).
+
The ''Temp_Ctrl_Task1Impl'', ''Envir1'' and ''Shared_Object1'' machines are incomplete. We will take the necessary steps to provide implementation details.  
  
==== Installing Alt-Ergo ====
+
===== The Temp_Ctrl_Task1Impl Machine =====
alt-ergo solver can be downloaded at http://alt-ergo.lri.fr/, or installed using the Ubuntu repository: ''alt-ergo'' package.
+
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 ''Temp_Ctrl_Task1Impl'' [http://wiki.event-b.org/images/Temp_Ctrl_Task1Impl.pdf here], it can be read in conjunction with the tutorial.
  
==== Installing CVC3 ====
+
The next step is to construct the task body using control constructs such as sequence, branch, loop and output. These constructs are discussed in the [http://wiki.event-b.org/index.php/Tasking_Event-B_Overview overview] of Tasking Event-B. We will now complete the sequence that has been partially defined in the task body.
CVC3 solver can be downloaded at http://cs.nyu.edu/acsys/cvc3/download.html, or installed using the Ubuntu repository: ''cvc3'' package.
 
  
==== Installing Z3 ====
+
*'''Synchronize Sensing between TCSense_Temperatures and ENSense_Temperatures'''.
Z3 solver can be downloaded at http://research.microsoft.com/en-us/um/redmond/projects/z3/download.html.
+
** Expand the Temp_Ctrl_Task1Impl ''Auto Task Machine'' node.
 +
** Expand the ''Seq'' sub-tree.
 +
** Right-click on the first ''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 in the properties view.
 +
** 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 '''second''' ''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; and this is implemented in the simulation code by reading the values of the environment variables.
  
== SMT solvers configurations ==
+
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:
In order to use the plug-in, you must set up some SMT Solvers configuration. We call ''SMT Solver configuration'' a settled configuration of a solver, with ad-hoc properties such as its path, its parameters and the SMT-LIB version of the benchmarks it will execute. For example, such configurations can execute the same solver with different options, or different versions of the same solver, or different solvers.
 
  
As to reach the SMT solver configurations page, open the ''Preferences'' window: ''Window > Preferences''.
+
*'''Add the Wrapped Event TCCalculate_Average_Temperature'''.
 +
** Expand the sub-tree of the second ''Seq'' node.
 +
** Right-click on this (same as above) ''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 '''second''' ''TCCalculate_Average_Temperature'' event.
  
[[Image:Preferences_menu.png|450px]]
+
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:  
  
 +
*'''Add Synchronisation between TCGet_Target_Temperature2 and SOGet_Target_Temperature2'''.
 +
** 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.
  
Go to the ''SMT-Solvers'' page.
+
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''.  
  
[[Image:Smt_solvers_preferences_page.png|450px]]
+
*'''Add The Event Synchronisation Extension'''.
 +
** Navigate to the list of events in the machine.
 +
** 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. The corresponding event in the Shared machine is dealt with [http://wiki.event-b.org/index.php/Tasking_Event-B_Tutorial#The_Shared_Machine here]
  
Add a new SMT solver configuration into Rodin by clicking the ''Add'' button.
+
*'''Identify a parameter direction'''.
 +
** 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''.
  
[[Image:Solver_configuration.png|450px]]
+
We have now identified the parameter as an actualIn (this models a call's return value).
  
* Fill the ''Solver ID'' with the name you want to give to this configuration.
+
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. Synchronisation between tasks and shared objects are represented as subroutine calls. The sensing/actuating synchronisations only occur between tasks and the environment.  
* Select the solver you want to use in this configuration (if it does not appear in the list, select ''unknown'').
 
* Click ''Browse'' to fill the solver executable path.
 
* Fill the ''Solver arguments'' if needed. For now, veriT, Alt-Ergo and Z3 do not need any argument. CVC3 must be used with ''-lang smt'' argument.
 
* Select which version of SMT-LIB must be used by the plug-in. Currently, version 1.2 is the only one covered by the plug-in).
 
* Click ''OK''.
 
  
The selected solver configuration is the blue one. This shows which solver configuration will be used when the SMT tactic will be called. If you want to use another solver configuration, click on the corresponding line in the ''SMT-Solvers configurations'' list, and click ''Select''.
+
*'''Add The Sensed Event Extension'''.
 +
** Right-click on the ''TCSense_Temperatures'' Event node.
 +
** Select ''New Child/Implementation'' from the menu.
 +
** Go to the Implementation properties view and set the ''Implementation Type'' property to ''Sensing''.
  
[[Image:Selected solver.png|451px]]
+
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 ''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''.
  
=== SMT-LIB translation settings ===
+
We have now identified the parameters as an actualIn (modelling a received value from the environment).
If you want to use veriT instead of ppTrans to translate Event-B sequents to SMT-LIB benchmarks, you need to fill the veriT path, by clicking the corresponding ''Browse'' button, and selecting the veriT binary.
 
  
The plug-in may use some temporary files to discharge a sequent. You can choose the directory to use for this purpose, by clicking the corresponding ''Browse'' button, and selecting the target directory.
+
===== The Shared Machine =====
  
== Usage ==
+
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.
 +
* Optionally collapse open branches of the EMF editor to remove clutter.  
 +
* Right-click on the ''Shared_Object'' Machine node in the ''.tasking'' file.
 +
* Select ''New Child/Shared Machine'' from the menu.
  
=== Discharging a sequent ===
+
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''.
We give an example of Event-B model of which proof obligation can be discharge using an SMT solver:
 
  
[[Image:PrettyPrinted context.png|225px]]
+
* '''Identify SOGet_Target_Temperature2 as a Synchronized event'''.
[[Image:Hypothesis and goal.png|225px]]
+
** Right-click on the ''SOGet_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''.
  
''thm1'' is a theorem which must be proved given axioms ''axm2..axm5''.
+
* '''Identify the outgoing (return) parameter'''.
 +
** 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 ''formalOut''.
  
 +
===== The Environ Machine =====
 +
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 PrettyPrint view is available [http://wiki.event-b.org/images/Envir1Impl_2.pdf here]. In the prepared Environment Machine we have already added a ''Periodic Task'' 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. 
  
Since we installed SMT Plug-in into the Rodin Platform, the SMT tactic button is now accessible in the ''Proof Control'' bar.
+
*'''Model Temperature Change in the environment'''.
 +
** Optionally collapse open branches of the EMF editor to remove clutter. 
 +
** Expand the Environ1Impl ''Environ Machine'' node.
 +
** Expand the ''Seq'' sub-tree fully.
 +
** Right-click on the last ''Seq'' node in the tree and and select ''New Child/Left Branch EventWrapper''.
 +
** Provide the event label ''e4'' 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''' ''ENAlter_Temperature_Sensor1'' event.
  
[[Image:SMT button.png|450px]]
+
Output to the screen during the simulation can be specified as follows:
  
 +
*'''Text Output during Simulation.'''.
 +
** 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.
  
Clicking on this button will call the previously selected SMT solver, which will discharge the proof obligation if possible:
+
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''. This event enables the environment to manipulate the monitored variable.
  
[[Image:Tactic applied successfully.png|450px]]
+
* '''Identify ENAlter_Temperature_Sensor1 as a ProcedureDef event'''.
 +
** Right-click on the ''ENAlter_Temperature_Sensor1'' Event node.
 +
** Select ''New Child/Implementation'' from the menu.
 +
** 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 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.
  
When the tactic is applied successfully, this means that the reasonner created the new proof rule:
+
*'''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''.
  
[[Image:Proof Tree and Rule Details.png|450px]]
+
We have identified the event as a sensing event. Now we add the parameter direction:
  
For now, the proof tree doesn't contain any detail because SMT-LIB 1.2 doesn't implement a proof witnesses system.
+
*'''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''.
  
=== Setting-up an SMT auto tactic ===
+
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.
One might want to set-up a configuration of SMT solver to be used automatically to discharge Event-b sequents in the Rodin platform. Since version 2.3 of Rodin, it is possible to create new ''tactic combinations'' to be applied automatically (See ''Advanced Profile Customisation'' in [[Rodin_Platform_2.3_Release_Notes]]). A reasonable combination using the SMT tactic is an SMT tactic queued to the default auto tactic combination. We show here how to create such a ''profile''.
 
  
First, open the ''Preferences'' window of the Rodin platform: ''Window > Preferences''.
+
==== A Quick Check ====
  
[[Image:Preferences_menu.png|450px]]
+
It should now be possible to open the tasking PrettyPrinter view (Window menu) without errors. If the PrettyPrint fails, then this is a sign that the model has been incorrectly constructed. The point of failure (the extent of the printout before failure) may indicate the location of the error in the model.
  
 +
===== A Summary of Steps =====
 +
If generating environment simulation code:
 +
# Ensure the Environ Machine is first machine in the development.
  
Open the ''Auto/Post Tactic'' preferences page: ''Event-B > Sequent Prover > Auto/Post Tactic''. Go to the ''Profiles'' tab.
+
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.
  
[[Image:Duplicating_auto_tactic_profile.png|450px]]
+
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.
  
Select the default auto tactic profile, and click ''Duplicate'' to duplicate it.
+
For an Environ Machine definition:
 +
# Make the type an Environ 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.
  
Then, select the duplicated profile, and click ''Edit'' to edit it.
+
== Invoking the Translators ==
  
[[Image:Auto_tactic_profile_duplicated.png|450px]]
+
* 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 ''Heating_ControllerTutorial_Step2'' 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.
  
 +
In the event that the translator fails check that the correct events have been selected in the ''synchEvents'' construct. This can be done by looking at each task's ''taskBody'' construct, in the Tasking Pretty Printer view. In the PrettyPrinter view, each synchronization has a ''target'' and ''event'' seprated by dot-notation. The target is either the name of a shared machine or an environ machine. In this example check that the ''target'' refers to the correct machine, i.e. ''Envir1Impl'' rather than ''Envir1''; ''Temp_Ctrl_Task1Impl'' rather than ''Temp_Ctrl_Task1''; and ''SharedObject1Impl'', rather than ''SharedObject1''. After correcting any errors, invoke the translator again.
  
In the tactic profile window, rename the profile, and drag and drop the chosen SMT tactic from the tactics list (in the first column) to the end of the combined tactics (in the second column).
+
* To create the Event-B model of the implementation,
 +
** Return to the Rodin Modelling Perspective.
 +
** Right-Click on the Main node, select ''Epsilon Translation/Translate Task Mch 2 Event-B EMF''.
 +
** The ''Heating_Controller5AGen'' project is generated, it can be opened and inspected.
  
[[Image:Adding_smt_tactic_in_profile.png|450px]]
+
There may be errors in the generated machines (the issue will disappear in a future release); 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.
  
Then click ''Finish''.
+
== Optional Annotations for Addressed Variables ==
 +
To use memory mapped IO (Addressed Variables) in our generated code we can specify which addresses to use in our [http://wiki.event-b.org/index.php/Tasking_Event-B_Overview#Implementing_Events sensing and actuating events]. The addresses are added to the event parameters of  a Tasking Machine's sensing and actuating events. The addresses may also be added to the Environ machine's machine variables, for use in simulation. It should be noted that the use of addressed variables, in simulation, has to be done cautiously to prevent memory errors. In the current release the translator generates code for all of these situations, and the environment task should be discarded if simulation is not required.
  
Now a new profile combining the SMT tactic with other tactics is created. To set it on, go to the ''Auto/Post Tactic'' tab.
+
We now add addressed variable to the ''TCSense_Temperatures'' event in ''Temp_Ctrl_Task1Impl'', a PrettyPrint view is available [http://wiki.event-b.org/images/AddressedVarsTask.pdf here].
  
[[Image:Smt auto tactic profile selected.png|450px]]
+
* '''Add Address Information to Event Parameters'''.
 +
** Right-click on the parameter node.
 +
** Select ''New Child/Addressed Variable''.
 +
** Go to the ''Addressed Variable'' properties view and set the ''Address'' and ''Base'' properties to appropriate values.
  
Set the tactic profile to be used for auto-tactics up to the one combining the SMT tactic, by using the drop-down menu.
+
Reads of the monitored variables of the sensing event can therefore be made directly from the address specified. Their is also a ''base'' property which can be set to indicate the base of the property value. The default value is 16. The environment simulation may also make use of addressed variables, but in this case the extension is made to the Environ Machine machine variables and used as shown [http://wiki.event-b.org/images/AddressedVarsEnvir.pdf here].
  
Then click ''Ok''.
+
Invocation of the translators proceeds as detailed above.
  
Now, the combined tactics of your new profile, including the SMT tactic, will be automatically launched when a new proof objective will be opened.
+
== Generated Code ==
 +
The Ada Code generated by the translator is available at the following links:
  
== Bugs and features request ==
+
for simulation of environment without addressed variables, [http://wiki.event-b.org/images/Code_Heating_ControllerTutorial_Completed.pdf Heating_ControllerTutorial_Completed]
* SMT-LIB 2.0 support in developpment
 
* Full set theory support in progress
 
  
== Releases Notes ==
+
for simulation of environment with addressed variables, [http://wiki.event-b.org/images/Code_Heating_Controller5AddressedSim_Completed.pdf Heating_Controller5AddressedSim_Completed]
  
'''Version 0.1.0'''
+
Removal of the environment task from the ''Heating_Controller5AddressedSim_Completed'' should be deployable.
* Initial beta-release.
 
* Two approaches for translating Event-B to SMT-LIB 1.2:
 
** with ppTrans (included in Rodin official releases)
 
** with veriT (must be installed)
 
* Integration of solvers successfully tested with: ''(notice that no solver will be included in the plug-in at all)''
 
** Alt-Ergo 0.93
 
** Cvc3 2011-07-14
 
** veriT 201107
 
** z3 2.19
 
* Good results in the field of linear integer arithmetic with uninterpreted sort and function symbols
 
* Good support of basic set theory
 
* Full set theory support needs to be improved
 
* No SMT-LIB 2.0 support in this release
 
  
[[Category:Plugin]]
 
 
[[Category:User documentation]]
 
[[Category:User documentation]]

Revision as of 09:14, 29 November 2011

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

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 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 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 e-prints archive, or on SVN.

Heating_ControllerTutorial_Completed An example project generating an environment simulation. Generates code, where environment variables are monitored and controlled using subroutine calls. Contains a completed Tasking Development with generated Event-B and Ada code.
Heating_ControllerTutorial_Step1 A bare project for step 1 of the tutorial.
Heating_ControllerTutorial_Step2 A partially completed tasking development for steps 2, and 4 of the tutorial (step 3 not required here).