The TLA Toolbox

What is the Toolbox?

• Create and edit your specs, with the locations of parsing errors marked in the modules.
• Run the PlusCal translator, with the locations of translation errors marked in the PlusCal code.
  
• View the pretty-printed versions of your modules.


• Run the TLC model checker.  You do this by creating one or more models, which specify the information TLC needs to check the spec: what the spec is, what properties to check, the values to substitute for constant parameters, etc. Among the features the Toolbox provides is an error trace viewer and explorer that allows you to:
  • Explore a structured view of the states.
  • See exactly what parts of the state are changed in each step.
  • Evaluate arbitrary state and action formulas at each step in the trace.

• Run TLAPS, the TLA+ proof system.

Installing and Running the Toolbox

The instructions that appear on the welcome screen tell you what to do next: namely, read the indicated help page.  For now, the help pages are the only user manual that exists for the Toolbox.  Read it.  Even after using the Toolbox for a while, you're unlikely to have discovered all its features.  Read all the help pages.  You never know what you might find in them.

The help pages tell you how to use the Toolbox, and they tell you most of what you need to know about the tools--especially the TLC model checker and the pretty-printer.  However, they don't describe the TLA⁺ and PlusCal languages.  To learn about them, see the Learning page.

If You Find a Problem

• Bug 98: If you run TLC with some invariants unchecked and TLC finds an error in a checked invariant, the Toolbox sometimes reports the wrong invariant as having failed.
• Bug 40: When TLC is run in simulation mode, liveness checking doesn't work.

Implementing the Toolbox has involved a lot of work--mainly by Simon Zambrovski, Dan Ricketts, and Markus Kuppe.  They were able to build a sophisticated tool in a short time by using Eclipse.  However, this required compromises, and there are some annoying (but not serious) inconveniences in the Toolbox because they either didn't have the time or the Eclipse expertise to fix them.  They have has also not had time to do extensive testing, which is hard and time-consuming for this type of graphical interface program.  So, please try to be helpful instead of angry if something doesn't work right.  Report the problem if it's not already in the bug list, and help us fix it if you can.  Thanks.

Downloading the Toolbox

By installing, copying, or otherwise using this software, you agree to be bound by the terms of its license.   Read the license.

       -- DOWNLOAD THE TOOLBOX --

System Specific Instructions

Linux

On some versions of Ubuntu, the Toolbox's menus may not be displayed.  To fix this, you can launch the Toolbox with a shell script that sets the environment variable UBUNTU_MENUPROXY to 0--for example the shell script:

   #!/bin/bash
   export UBUNTU_MENUPROXY=0 
   toolbox/toolbox

Release History

Version 1.4.6 of 18 April 2013
- Fixes bug in PlusCal translation of fairness for algorithms with procedures.
- Adds handling of strings to TLC's implementation of Tail and SubSeq.
- Fixes a minor TLATeX bug.

Version 1.4.5 of 22 February 2013
- The Decompose Proof Command has been added to the Toolbox editor.
   It makes it easy to perform the standard hierarchical decompositions of a proof
   based on the structure of the formula to be proved.
- A few minor bugs have been fixed.

Version 1.4.4 of 30 November 2012
- There have been numberous changes to distributed TLC and how to run it.
- Syntax coloring of PlusCal algorithms was added.
- TLATeX now formats PlusCal algorithms.
- Support for library folders required by Version 1.1.1 of TLAPS has been added.

Version 1.4.3.c of 24 May 2012
Version 1.4.3.b of 24 April 2012
Version 1.4.3.a of 17 April 2012
    These are intermediate versions that contain the current version of TLAPS.tla and
       fix mostly minor bugs.
    Version 1.4.3.c fixes a bug that can cause an updated version of the Toolbox
       to use an earlier version of TLC.
    The latest version is available only by updating.  (Select  Check for Updates 
       on the Toolbox's  Help  menu.)

Version 1.4.3 of 10 April 2012
- Adds a "Cardinality of largest enumerable set" TLC parameter.
- Fixed the order of definitions and declarations in the MC.tla file.
- Includes TLC version 2.05 of 7 April 2012, which adds the TLCEval operator to the TLC module.
- Includes PlusCal Verion 1.8 of 30 March 2012.

Version 1.4.2 of 17 February 2012
- Selecting a location in an error report and control-clicking jumps to its source in PlusCal code.
- Supports library folders (directories) for modules used in multiple specs.
- Provides a built-in pdf viewer that can be used for viewing pretty-printed modules.

Version 1.4.1 of 19 January 2012
- Contains a new editor command for jumping from a region in the TLA+ translation
  of a PlusCal algorithm to the region of PlusCal code that generated it.
- Introduces some additional editor commands, including one for parenthesis matching.
- Fixes a number of bugs, including ones that occurred when TLC checked large models.

Version 1.4.0 of 16 September 2011
- Includes a method for obtaining new releases from inside the Toolbox.
- Includes PlusCal Version 1.6, which:
    * Slightly changes the syntax for specifying fairness.
    * Permits using previously declared macros in a macro definition.
- Added the Forget Specification command.
- Includes a first release of the distributed version of TLC.
- Includes a fix to SANY to support binary, octal, and hex numbers.
- Added default overriding of definitions like Foo == CHOOSE v : v \notin S.
- Definition overriding section of advanced model page now opens if there are overrides.
- Fixed a TLC bug in overriding instantiated definitions.
- Displays timeout as a reason for prover failure.

Version 1.3.1 of 5 April 2011
- Includes PlusCal Version 1.5, which adds:
    * Fairness specifation in a PlusCal algorithm.
    * Translation simplifications, including omission of the pc variable when not needed.
- Contains a number of minor bug fixes.

Version 1.2.1 of 2 October 2010
- Added a sophisticated interface for running the TLAPS proof checker.
- Added a command for displaying all globally defined symbols.
- Added commands for displaying all uses of a symbol.
- The Goto Declaration command now works for locally defined symbols.
- Added commands for formatting boxed comments.
- Made some additional minor changes.

Version 1.1.2 of 6 May 2010
- Added trace Explorer, which evaluates expressions on an error trace.
- Added folding of proofs to permit reading them hierarchically.
- Added TLA Proof Manager menu item that currently does nothing.

Version 1.1.1 of 22 Mar 2010
- Fixes TLC bug that made restarting from a checkpoint not work.
- Various minor bug fixes.

Version 1.1.0 of 4 February 2010
- The initial public release.