Difference between pages "Code Generation Tutorial" and "Rodin Platform 2.1.1 Release Notes"

From Event-B
(Difference between pages)
Jump to navigationJump to search
imported>Andy
 
imported>Nicolas
 
Line 1: Line 1:
'''This Page is Under Construction!!!!'''
+
{{TOCright}}
  
=== Tutorial Overview ===
+
Rodin 2.1.1 is a maintenance release: as such, it contains only bug fixes. For more information, see [[Rodin_Platform_2.1_Release_Notes]].
  
The aim of the tutorial is to allow users to explore the approach with a relatively simple example. The example uses a shared buffer with reader and writer processes. The tutorial is presented in three stages, making use of the example projects from the download site. There are two translations performed, one is to a common language model (IL1). The second is to an Event-B project which includes a model of the implementation. There is a PrettyPrinter for Ada source code, which uses the common language model. An overview of Tasking Event-B can be found at http://wiki.event-b.org/index.php/Tasking_Event-B_Overview.
+
== What's New in Rodin 2.1.1 ? ==
  
A typical Event-B development may be refined to the point where it is ready for implementation, but 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.
+
* Fixed bugs:
 +
** ArrayIndexOutOfBoundsException during a build
 +
** IndexOutOfBoundsException when building a theory (with [[Theory_Plug-in|Theory Plug-in]] installed)
 +
** Auto-tactic profile preference bugs
 +
** Various UI bugs (prover interface, rule details, tactic profiles) including, in particular, a fix for slow hypothesis search on Windows OS.
  
The example/tutorial projects are,
+
* Changes for plugin-developers
 +
:None
  
{| border="1"
+
== Installing ==
|SharedBuffer20100819Demo
 
|An example project with a completed Tasking Development and IL1 model (post IL1 translation, but before Event-B translation).
 
|-
 
|Sharedbuffer20100819Tasking
 
|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.
 
|-
 
|SharedBuffer20100819Tutorial
 
|A bare project for step 1 of the tutorial.
 
|-
 
|Sharedbuffer20100819Tutorial2
 
|A partially completed tasking development for steps 2 and 3 of the tutorial.
 
|}
 
  
== Preliminaries ==
+
Users who are already running Rodin 2.1 are encouraged to perform an upgrade, as described below. The upgrade is faster, smaller (the archive is about 6 MB) and simpler than downloading a whole new platform: no need to reinstall plug-ins or configure the platform from scratch.  
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.
+
=== Upgrading from Rodin 2.1 ===
  
* Open the ''SharedBuffer20100819Demo'' Project and switch to the Resource Perspective.
+
* download archive [http://sourceforge.net/projects/rodin-b-sharp/files/Core_%20Rodin%20Platform/2.1.1/rodin-2.1.1-repo.zip/download rodin-2.1.1-repo.zip]
* Open the ''.tasking'' model and inspect it. Clicking on the Main, Machine or Event nodes updates the pretty print window.
+
* launch Rodin 2.1
 +
* Help > Install New Software... > Add... > enter a name (for instance "Rodin 2.1.1") then
 +
: Archive... > select the rodin-2.1.1-repo.zip archive
 +
: Mac users may have to use Local... then point to archive root directory, in case the archive was automatically unzipped
 +
* set options in the bottom of the page:
 +
:* check
 +
:** "Show only the latest versions of available software"
 +
:** "Hide items that are already installed"
 +
:* uncheck
 +
:** "Group items by category"
 +
:** "Contact all update sites..."
 +
: the central area should now list 5 entries
 +
* select "Rodin Platform", click "Next"
 +
: a message informs "Your original request has been modified.  See the details."
 +
: "Rodin Platform" is already installed, so an update will be performed instead.
 +
* click Next, accept license, finish and restart
  
==== Viewing Source Code ====
+
=== Downloading ===
aka. The PrettyPrint View of an IL1 Model.
 
  
To view Ada source code,
+
[http://sourceforge.net/projects/rodin-b-sharp/files/Core_%20Rodin%20Platform/2.1.1/ http://sourceforge.net/projects/rodin-b-sharp/files/Core_ Rodin Platform/2.1.1/]
* from the top-menu select ''Window/Show View/Other/IL1 Pretty Printer''.
 
* Open the ''SharedBuffer20100819Demo'' 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 ====
+
== Disclaimer ==
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.
+
Since Rodin is continuously maintained, several unsoundness bugs which have been encountered were investigated and fixed. However, despite the total commitment of our teams to insure the soundness of the platform, some unexpected and unknown soundness issues could remain. We would be grateful if you would report these issues to the [mailto:rodin-b-sharp-devel@lists.sourceforge.net development mailing list].
  
== The Tutorial ==
+
== About ==
The steps needed to generate code from an Event-B model, in this tutorial, are as follows,
+
Rodin Platform from release branch: branches/RodinCore/2.1.1 r10985
* Step 1 - Create the tasking development.
 
* Step 2 - Add annotations.
 
* Step 3 - Invoke translators.
 
  
==== Creating The Tasking Development ====
+
Made of Rodin 2.1 plus following trunk revisions (change log available in SourceForge downloads):
* Change to the Event-B Perspective.
+
10768; 10800; 10801; 10806; 10807; 10860; 10861; 10863; 10870; 10872; 10876; 10877; 10880; 10879; 10915; 10916; 10940
* Open the ''SharedBuffer20100819Tutorial'' Project.  
 
* Select the following Machines: Reader, Writer and Shared.
 
* 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 to the Project ''SharedBuffer20100819Tutorial2'' to begin the next step.
+
Developer Release date : 11/03/2011.
 +
User Release date : 15/03/2011.
  
==== Providing the Annotations for Implementations ====
+
[[Category:Rodin Platform Release Notes]]
* 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 ''WriterTsk'' and ''SharedObj'' machines are incomplete. We will take the steps to necessary to provide implementation details.
 
 
 
===== The WriterTsk Machine =====
 
In the partially complete tutorial project we already identified the ''WriterTsk'' 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 will now complete the sequence that has been partially defined in the task body.
 
 
 
* Expand the ''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 ''w1'' 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 ''TWrite'' event.
 
* Go to the drop-down menu of the ''Remote Event'' property.
 
* From the list of events select the ''SWrite'' event.
 
 
 
The Synch Events construct is used to implement [http://wiki.event-b.org/index.php/Tasking_Event-B_Overview#Control_Constructs Event Synchronisation]. The next step wraps an event in an Event Wrapper in order to update the local state; there is no synchronisation as such but we will re-use the constructs that already exist.
 
 
 
* 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 ''w2'' 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 ''TcalcWVal'' event.
 
 
 
We have now completed the task body, and it just remains to complete provide details for the ''TWrite'' event.
 
 
 
===== The Shared Machine =====
 
 
 
The next step is to identify the ''SharedObj'' machine as a ''Shared Machine''. The ''SharedObj'' Machine will be extended using the Event-B EMF extension mechanism.
 
* Right-click on the ''SharedObj'' Machine node in the ''.tasking'' file.
 
* Select ''New Child/Extension''.
 
* Right-click on the ''Extension'' node and select ''New Child/Shared Machine'' from the menu.
 
 
 
We now show how to extend the ''SWrite'' event of the Shared Machine with details about its implementation. The ''SWrite'' event in ''SharedObj'' is to be synchronized with the ''TWrite'' event in the ''WriterTsk''.
 
* Right-click on the ''SWrite'' Event node.
 
* Select ''New Child/Extension''.
 
* Right-click on the ''Extension'' node and select ''New Child/Implementation'' from the menu.
 
* Go to the Implementation properties view and set the ''Implementation type'' property to ''ProcedureSynch''.
 
 
 
We now identify incoming and outgoing parameters of the event.
 
* Right-click on the ''inFP'' node and add an ''Extension''.
 
* Right-click on the ''Extension'' and select''New Child/Parameter Type''.
 
* Go to the ''Parameter Type'' properties view and set the ''Parameter type'' property to ''formalIn''.
 
* Right-click on the ''outFP'' node and add an ''Extension''.
 
* Right-click on the ''Extension'' and select''New Child/Parameter Type''.
 
* Go to the ''Parameter Type'' properties view and set the ''Parameter type'' property to ''formalOut''.
 
 
 
To summarise, 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.
 

Revision as of 14:59, 17 March 2011

Rodin 2.1.1 is a maintenance release: as such, it contains only bug fixes. For more information, see Rodin_Platform_2.1_Release_Notes.

What's New in Rodin 2.1.1 ?

  • Fixed bugs:
    • ArrayIndexOutOfBoundsException during a build
    • IndexOutOfBoundsException when building a theory (with Theory Plug-in installed)
    • Auto-tactic profile preference bugs
    • Various UI bugs (prover interface, rule details, tactic profiles) including, in particular, a fix for slow hypothesis search on Windows OS.
  • Changes for plugin-developers
None

Installing

Users who are already running Rodin 2.1 are encouraged to perform an upgrade, as described below. The upgrade is faster, smaller (the archive is about 6 MB) and simpler than downloading a whole new platform: no need to reinstall plug-ins or configure the platform from scratch.

Upgrading from Rodin 2.1

  • download archive rodin-2.1.1-repo.zip
  • launch Rodin 2.1
  • Help > Install New Software... > Add... > enter a name (for instance "Rodin 2.1.1") then
Archive... > select the rodin-2.1.1-repo.zip archive
Mac users may have to use Local... then point to archive root directory, in case the archive was automatically unzipped
  • set options in the bottom of the page:
  • check
    • "Show only the latest versions of available software"
    • "Hide items that are already installed"
  • uncheck
    • "Group items by category"
    • "Contact all update sites..."
the central area should now list 5 entries
  • select "Rodin Platform", click "Next"
a message informs "Your original request has been modified. See the details."
"Rodin Platform" is already installed, so an update will be performed instead.
  • click Next, accept license, finish and restart

Downloading

http://sourceforge.net/projects/rodin-b-sharp/files/Core_ Rodin Platform/2.1.1/

Disclaimer

Since Rodin is continuously maintained, several unsoundness bugs which have been encountered were investigated and fixed. However, despite the total commitment of our teams to insure the soundness of the platform, some unexpected and unknown soundness issues could remain. We would be grateful if you would report these issues to the development mailing list.

About

Rodin Platform from release branch: branches/RodinCore/2.1.1 r10985

Made of Rodin 2.1 plus following trunk revisions (change log available in SourceForge downloads):

10768; 10800; 10801; 10806; 10807; 10860; 10861; 10863; 10870; 10872; 10876; 10877; 10880; 10879; 10915; 10916; 10940


Developer Release date : 11/03/2011. User Release date : 15/03/2011.