Difference between revisions of "Decomposition Plug-in User Guide"
imported>Renato |
imported>Renato |
||
Line 108: | Line 108: | ||
=== ''Shared event'' (B-style) decomposition === | === ''Shared event'' (B-style) decomposition === | ||
− | + | *'''I am getting an error when trying to decompose saying that I have complex actions/guards''' <br/> This usually means that a predicate/assignment is too complex to be decomposed automatically. If a predicate/assignment refers to variables that belong to different sub-components, that predicate/assignment cannot be decomposed automatically: the user must explicitly make the separation of the variables in the predicate/assignment. A solution can be add an additional parameter representing the value of the used variable. Consider v1 a variable that is sub-set of carrier set S (v1 <: S) and v2 that is an element of S (<math>v2 \in S</math>). The predicate <math>v1 \eq S \ {v2} </math> cannot be decomposed automatically if v1 and v2 belong to different sub-components. A possible solution is to add a parameter p: p = v2 /\ v1 = S \{p}. | |
[[Category:User documentation]] | [[Category:User documentation]] | ||
[[Category:Work in progress]] | [[Category:Work in progress]] | ||
[[Category:Composition]] | [[Category:Composition]] |
Revision as of 12:15, 3 March 2010
Introduction
The Decomposition plug-in allows to decompose a model into sub-models.
See the Event-B Model Decomposition page for technical details on shared variables (A-style) decomposition.
Installing and Updating
Setup
The following steps will guide you through the setup process:
- Download Rodin for your platform from Sourceforge.
- Extract the downloaded zip file.
- Start Rodin from the folder where you extracted the zip file in the previous step.
- Install the Decomposition plug-in:
- In the menu choose Help -> Install New Software...
- In the Work with dropdown list, choose the location URL: Rodin - http://rodin-b-sharp.sourceforge.net/updates
- Select the Model Decomposition feature under the Model Decomposition category, then click the check box
- Click Next, after some time, the Install Details page appears
- Click Next and accept the license
- Click Finish
- A Security Warning window may appear: click OK
- Restart Rodin as suggested.
Now you are ready to use the Decomposition plug-in.
Update
The following steps will guide you through the update process:
- In Rodin open the preferences (Window -> Preferences or for Mac: Rodin -> Preferences)
- Find Install/Update -> Automatic Updates
- Select Automatically find new updates and notify me
As soon as Rodin finds a new update it will ask you if you would like to install it.
Release Notes
See the Decomposition Release History.
Decomposing
Running the Decompose Action
The Decompose action launches the decomposition wizard, which will perform the decomposition according to the preferences. It is available:
1. Either from the toolbar of the Event-B explorer. | 2. Or from the contextual menu, when right-clicking on a machine. |
Setting the Preferences
The different decomposition options are described below:
- Decomposition style. The shared variables (A-style) or shared events (B-style) decomposition will be performed, according to the specified decomposition style.
- Create new projects for sub-components. If checked, the decomposed sub-models are created in new projects.
- Context decomposition. The contexts seen by the input machine are decomposed if and only if this option is checked; otherwise, they are copied from the initial model to the decomposed sub-models.
Selecting the Input Machine and Partitioning the Elements
The following information has to be provided in the wizard dialog:
- Which machine will be decomposed.
- Which sub-machines will be generated.
- How the elements, and more precisely the events for shared variables (A-style) decomposition and the variables for shared events (B-style) decomposition, are partioned among these sub-machines.
Reporting a Bug or Requesting a Feature
Please, use the SourceForge trackers to report a bug on existing features, or to request new features:
Error Messages
When running the decomposition
The decomposition is forbidden, and an error message is displayed, if one of the following conditions applies:
- The built INITIALISATION events of the sub-machines would define an action modifying at the same time a private variable and a shared variable.
Action {0} of the INITIALISATION event modifies a private variable and a shared variable
See Ensuring that a shared variable is not refined by an initialization event for further explanations. - The sub-models shall be created in new Event-B projects, but one of the entered project names already exists.
The project {0} should not exist - The same project name has been entered for two distinct sub-models.
Duplicate sub-model names: {0} - For the shared event decomposition, the predicates (invariants,guards) and assignments (actions) must not refer to elements that before to different sub-components. If we create sub-component C1 with element el1 and sub-component C2 with element el2 from the non-decomposed component C, then a predicate P(el1, el2) (like el1=el2) in C would generate this error while decomposing. The predicate/assignment is too complex since refers to elements that belong to different sub-components. So solve this issue, the user must explicitly separate the elements (by a further refinement or introducing an auxiliary parameter p representing the value of a variable: el1=el2 <=> p=el2 /\ el1 = p).
Action/Guard {0} in event {1}.{2} is too complex to be decomposed (includes variables that do not belong to this sub-component):\n\nAvailable variables/parameters: {3}\n\nAvailable carrier sets/constants: {4}\n\nAction: {5}\n\nPlease simplify/separate variables before decomposing.}
When running the static checker
The following rules are enforced by the static checker, and errors are returned (in the Rodin Problems view) accordingly:
- A shared variable shall be present in subsequent refinements.
Shared variable {0} has disappeared - A shared variable shall still have the shared attribute in subsequent refinements.
Inconsistent nature of shared variable {0}, shared expected - An external event shall be present in subsequent refinements.
External event {0} has disappeared - An external event shall still have the external attribute in subsequent refinements.
Inconsistent status of external event {0}, external expected - An external event shall have the extended attribute in subsequent refinements.
Inconsistent status of external event {0}, extended expected - An external event shall not declare any additional parameter in subsequent refinements.
Parameters cannot be added in external events - An external event shall not declare any additional guard in subsequent refinements.
Guards cannot be added in external events - An external event shall not declare any additional action in subsequent refinements.
Actions cannot be added in external events - An INITIALISATION event shall not contain an action modifying at the same time a private variable and a shared variable.
Action {0} of the INITIALISATION event modifies a private variable and a shared variable - The actions of an INITIALISATION event modifying a shared variable shall be present and be syntactically equal in subsequent refinements.
Action {0} of the INITIALISATION event has disappeared
For additional information, see:
- Ensuring that a shared variable is not refined.
- Ensuring that an external event is not refined.
- Ensuring that a shared variable is not refined by an initialization event.
Tips and Tricks
- An invariant is missing in a sub-machine, but I would like to have it copied.
For example, an invariant between a concrete variable and some abstract variable may be useful.
A solution is to add a theorem based on the missing predicate in the non-decomposed machine. See the last paragraph about the invariants in the Event-B Model Decomposition page.
- An axiom is missing in a sub-context, but I would like to have it copied.
Such a situation may be encountered if the "Decompose contexts" option is checked.
The workaround proposed for the invariants applies to the axioms as well.
For example, if the non-decomposed context defines the axiom, and this axiom is not copied in a sub-context which contains the
carrier set but does not contain the
constant, then the information
is lost. In order to keep it, it is possible to add the theorem
in the non-decomposed context.
- A variable is tagged as private in a sub-machine, but I would like to have it tagged shared.
Such a behavior is suitable if you want to prevent this variable from being further refined.
A solution for such a variableof a sub-machine
is to add a fake action
in a event of the non-decomposed machine which is associated to the sub-machine
(
and
are distinct sub-machines) when performing the decomposition.
In the first example below, thevariable will become private when performing the decomposition:
In the second example below, thevariable will become shared when performing the decomposition:
- I am getting an error when trying to decompose saying that I have complex actions/guards
This usually means that a predicate/assignment is too complex to be decomposed automatically. If a predicate/assignment refers to variables that belong to different sub-components, that predicate/assignment cannot be decomposed automatically: the user must explicitly make the separation of the variables in the predicate/assignment. A solution can be add an additional parameter representing the value of the used variable. Consider v1 a variable that is sub-set of carrier set S (v1 <: S) and v2 that is an element of S (). The predicate Failed to parse (unknown function "\eq"): v1 \eq S \ {v2} cannot be decomposed automatically if v1 and v2 belong to different sub-components. A possible solution is to add a parameter p: p = v2 /\ v1 = S \{p}.