View source

From MCRL2

Jump to: navigation, search
You do not have permission to edit pages, for the following reason:
The action you have requested is limited to users in the group Users.
You can view and copy the source of this page:
== Introduction ==

CMake is a cross-platform open-source build system. It consists of a collection of tools that are designed to build, test and package software. CMake is used to control the software compilation process using simple platform and compiler independent configuration files. It generates native makefiles and workspaces that can be used in the compiler environment of your choice.

Currently, the system is developed and tested under Linux with GCC only.
The current todo list can be found [https://svn.win.tue.nl/trac/oas_repos/browser/mcrl2/cmake/TODO.txt here].

== Prerequisites ==

=== mCRL2 ===
A copy of the source tree can be obtained in two ways:

* Download a compressed archive of the source distribution from development version from the [http://www.mcrl2.org/wiki/index.php/Download download page].

* Use [http://subversion.tigris.org Subversion] to checkout a version of the source tree.

The Subversion revision control system is used for storing the source code of the mCRL2 toolset in a repository. Using a Subversion client it is possible to obtain a local copy of the source tree. The following command achieves this:

 svn checkout https://svn.win.tue.nl/repos/MCRL2/trunk MCRL2

This creates a local directory MCRL2 with the contents of the trunk directory in the MCRL2 repository. For more information on using SVN see the [http://subversion.tigris.org Subversion website].

==== Linux ====

The following packages must be installed:

{|class="wikitable"
|-
! Name !! Version !! Package
|-
! g++ 
| >= 4.0.0
| gcc-c++
|-
! make 
| >= 3.80
| make
|}

===== Optional packages =====

{|class="wikitable"
|-
! Name !! Version !! Package
|-
! default icon locations
|  
| "gnome-themes", "gnome-themes-extras" or "hicolor-icon-theme"
|-
! flex 
| >= 2.5.4a-12
| flex
|-
! bison 
| >= 2.0
| bison
|-
! doxygen 
| >= 1.5.3
| doxygen
|-
! python 
| >= 2.5.1
| python
|}

Any of these default icon location packages ensure that the tools requiring "wxWidgets" do not generate warnings on missing icons.
The packages for "flex", "bison", and "python" are used to generate source code. The package for "doxygen" is used to generate HTML documentation for the website. "flex", "bison", "python" and "doxygen" are only needed for developers.

==== Windows ====

A copy of Microsoft Visual Studio C++ should be installed.
Express editions (may) require additional Windows SDK 6.0a or higher to be installed.
{|class="wikitable"
|-
! Name !! Version !! Package
|-
! Microsoft Visual Studio C++
| >= 2008
| Express / Professional/ Ultimate
|}

Note: It is possible to install the toolset in a Cygwin/MinGW environment. However, we provide no guarantee that it will work out of the box, nor providing (active) support. To build for these environments follow the build instructions for Unix-Like platforms.

==== Mac OS X ====
Mac OS requires a copy of XCode:
* Mac OS X 10.4 with XCode 2.5
* Mac OS X 10.5 with XCode 3.1

=== CMake ===
The CMake build system requires a installed copy of CMake (v2.6.2 or higher) to be installed on your system.
If your copy does not match the requirements or is simply not available it can be downloaded [http://www.cmake.org/cmake/resources/software.html here].

=== Boost ===
The mCRL2 toolset requires an external version of Boost and external version of wxWidgets for development. 
If Boost (v1.36 or higher) is correctly installed, CMake will find the installation and use it.
Installing Boost can be done as described below.

==== Installing Boost for Windows ====

* Download BoostPro 1.44 from [http://www.boostpro.com/download/ http://www.boostpro.com/download/]
* Install file after downloading.
* Accept agreement.
* Select mirror (default is oke).
* MSVC 2010 + All Static runtime libraries (Debug/Release, Multi/Single thread)
* Select additional packages:
 - Filesystem
 - Serialization
 - Signals
 - Regex
Note: Select only version for your compiler (unfold selection). Installing can take some time and disk- space.
* Select a install path. This path is used later on to link to the libraries. (Default: C:\Program Files\boost\boost_1_44)
* Press complete installation.

The following instructions can be used
* Start CMake (cmake-gui)
* Set source code to mcrl2_svn path
* Set "build tree path"
* Make sure BUILD_SHARED_LIBS is unchecked.
* Make sure wxWidgets is found (Place link to "configure for wxWidgets")
* Make sure MCRL2_USE_BOOST_INTERNAL is unchecked.
* Set BOOST_INCLUDEDIR to "C:\Program Files\boost\boost_1_44" 
<pre> Add Entry -> Name = BOOST_INCLUDEDIR, Type = PATH, Value = "C:\Program Files\boost\boost_1_44" -> OK </pre>
* Press Configure
* Make sure that Boost is found:
  % Boost version: 1.44.0
  % Found the following Boost libraries:
  %   signals
  %   filesystem
  %   regex
* Press Configure until Generate is enabled.
* Press Generate
* Goto "build tree path" and open MSVC project.
* Compile toolset

==== Installing Boost for Linux ====
Select the following boost packages from the package manager:
 - Filesystem
 - Signals
 - Regex

==== Installing Boost on MacOS-X ====

Boost can be installed using [http://macports.org MacPorts].
* First goto [http://www.macports.org/ http://www.macports.org/].
* In the left menu bar select "Available Downloads" and download the appropriate version.
* Install the downloaded image.
* After installing open a terminal
* Test and update MacPort by executing: <pre>sudo port selfupdate</pre> Note: <tt>port</tt> is most probably installed in <tt>/opt/local/bin</tt>.
* To install boost, execute: <pre>sudo port install boost</pre> Installing boost may take a while.
* After installing Boost, proceed by executing <pre>cmake</pre> See [[CMake_build_instructions#Configuration]] for more information.
* Set the MCL2_USE_BOOST_INTERNAL to the value "false". Cmake will automatically detect the installed version of boost.

=== wxWidgets ===

The mCRL2 toolset requires an external version of wxWidgets to develop graphical tools.  Make sure that a copy is installed. Tools build in debug mode, require 
a debug version of wxWidgets. Tools that are not build in debug mode, require a release version of wxWidgets. If release tools are linked to debug libraries or vice-versa, it is possible that graphical tools will not work or compilation fails.

==== Installing wxWidgets on Linux ====

Install the following packages with your favorite package manager.
When installed, they will be found by <tt>cmake</tt>.

{|class="wikitable"
|-
! Name !! Version !! Package !! Components 
|-
! wxWidgets
| >= 2.8.4
| "libwxgtk2.8-dev" or "libwxgtk2.8-dbg"
| base core adv xml html aui
|-
! OpenGL 
| 7.0.1, >= 2.8.4
| Mesa (GL and GLU), wxWidgets-gl
|
|}

These packages are required for the following graphical tools:
* diagraphica 
* ltsgraph
* ltsview 
* mcrl2-gui
* lpsxsim

'''Note''': wxWidgets must be compiled with OpenGL for the following tools: 
* diagraphica
* ltsview
* ltsgraph

==== Installing wxWidgets on Windows ====

To install wxWidgets for use with the Microsoft Visual C++ compiler, the following steps have been reported to work:

* Download the latest '''stable''' Windows installer, called <tt>wxMS</tt>, from the [http://www.wxwidgets.org/downloads/ wxWidgets Download page]. After downloading the file, execute the installer. This will install the source files for wxWidgets into the <wxdir> directory. Now the source files need to be prepared (compiled) such that they can be used with MSVC:
* For a build with GUI tools (Recommended): 
*# Edit the file <tt><wxdir>\lib\vc_lib\mswd\wx\setup.h</tt>, and set the following define to <tt>1</tt> instead of <tt>0</tt>: <pre> #define wxUSE_GLCANVAS       1</pre>
* To build libraries for static linking, open <tt>/build/msw/wx.sln</tt>.
* If MSVC asks to convert projects, confirm for all project.
* Compile all libraries for a certain build type (e.g. Release, Debug).
* When done, start with configure with cmake. It should automatically find the compiled libraries. If <tt>cmake</tt> fails to find the libraries, set the following variables '''wxWidgets_LIB_DIR''' and '''wxWidgets_ROOT_DIR''' to "<wxdir>/lib/vc_lib" and "<wxdir>", respectively. This can be done by:
<pre>cmake -DwxWidgets_LIB_DIR="<wxdir>/lib/vc_lib" -DwxWidgets_ROOT_DIR="<wxdir>"</pre>

==== Installing wxWidgets on MacOS-X ====

wxWidgets can be installed using [http://macports.org MacPorts].
* First goto [http://www.macports.org/ http://www.macports.org/].
* In the left menu bar select "Available Downloads" and download the appropriate version.
* Install the downloaded image.
* After installing open a terminal
* Test and update MacPort by executing: <pre>sudo port selfupdate</pre>
* To install wxWidgets, execute: <pre>sudo port install wxWidgets</pre> Installing wxWidgets may take a while.
* After installing wxWidgets, proceed by executing <pre>cmake</pre> See [[CMake_build_instructions#Configuration]] for more information.

== Configuration ==

After the CMake build files are inside the mCRL2 trunk, platform specific makefiles need to be generated for compilation and installation. These Makefiles can be generated inside the source tree or outside the
source tree (resp. in-source and out-of-source builds). The advantage of an out-of-source build, is that it allows different build configurations to be maintained concurrently. The preference is given to an out-of-source build. We recommend not to mix in- and out-of-source builds, because they lead to errors when generating makefiles.

=== Out-of-source builds ===

For an out-of-source build, create a directory in the location of your choice (indicated by BUILD_DIR):
<pre>
mkdir BUILD_DIR
</pre>
Navigate to the directory:
<pre>
cd BUILD_DIR
</pre>
Makefiles are generated in BUILD_DIR by executing the following:
<pre>
cmake /full/path/to/MCRL2
</pre>
'''Note:''' Prior to running this command, the absence of file /path/to/MCRL2/CMakeCache.txt (the location of the SVN checkout) is required, because otherwise no makefiles are generated. 

=== In-source builds ===

For an in-source build, first navigate to the mCRL2 source directory:
<pre>
cd /path/to/MCRL2
</pre>
Makefiles are generated by executing the following command:
<pre>
cmake .
</pre>
'''Note:''' CMake creates a "Makefile" that overrides the current one in the source directory for UNIX systems. Because boost-build requires this Makefile, users MAY NOT UPLOAD this file. To avoid clashes the "MCRL2_BUILD_IN_SOURCE" variable should explicitly be set to "ON".

=== Alternative Makefile Generation ===

It is possible to generate make files differently. Some methods are described below:

==== Command line (WIN, UNIX, MAC) ====

<pre>
ccmake /full/path/to/MCRL2
</pre>

The "ccmake" executable is the CMake curses interface. Project configuration settings may be specified interactively through this GUI in a terminal. Brief instructions are provided at the bottom of the terminal when the program is running.

==== Graphical (WIN, UNIX, MAC) ====

<pre>
cmake-gui
</pre>

The "cmake-gui" executable is the CMake curses interface. Project configuration settings may be specified interactively through this GUI. To use this command on Unix/MAC systems, additional packages may be required.

=== Parameters ===

The behaviour of generated Makefiles can be altered by using the <tt>-D<FLAG=option></tt>.
To set a variable, e.g. <tt>CMAKE_BUILD_TYPE</tt> to <tt>Debug</tt>, execute the following command (for both in-source and out-of-source builds):
<pre>cmake . -DCMAKE_BUILD_TYPE=debug</pre>
If the variable <tt>CMAKE_BUILD_TYPE</tt> is set to <tt>Maintainer</tt> code coverage will be performed
when running tests.
wxWidgets is found automatically, if installed. Sometimes it may be convenient to use a version of 
wxWidgets. If an user want to build with custom version of wxWidgets on Mac and UNIX systems, the user should specify the location (including the file) where <tt> wx-config </tt> is located. If wxWidgets is compiled and installed in e.g. <tt> /USER/Henk/wxWidgetsXYZ/wx-config </tt> one should execute the command:

<pre>cmake . -DwxWidgets_CONFIG_EXECUTABLE=/USER/Henk/wxWidgetsXYZ/wx-config</pre>

'''Note''': Values of the flags are cached and are case insensitive. This implies that when changing a single value, all other flags remain the same. It is also possible to run <tt>ccmake</tt> instead of <tt>cmake</tt> with <tt>-D</tt>.

Here <tt><FLAG=option></tt> needs to be substituted by the variable and value by of your choice. The most important <tt>FLAG</tt> variables are (default values are indicated by a *):

* <tt>CMAKE_BUILD_TYPE</tt>:     <tt>None</tt>, <tt>Release</tt>*, <tt>Debug</tt>, <tt>RelwithDebInfo</tt>, <tt>MinSizeRel</tt>, <tt> Maintainer </tt>
: A variable which controls the type of build when using a single-configuration generator like the Makefile generator. This variable has no effect for Visual Studio projects as they contain multiple-configurations. 
* <tt>CMAKE_INSTALL_PREFIX</tt>:        <tt>/usr/local/</tt>*
: The installation prefix for mCRL2, defaulting to /usr/local. All mCRL2 files will be installed there. 
* <tt>BUILD_SHARED_LIBS</tt>:           <tt>ON</tt>* <tt>OFF</tt>
: A variable which controls if the build is static or shared. By default libraries are shared.
* <tt>MCRL2_USE_BOOST_INTERNAL</tt>:          <tt>ON</tt>*, <tt>OFF</tt>
: A variable that is used if the internal Boost version should be use. By default the internal boost version is used.
* <tt>MCRL2_SQUADT_CONNECTIVITY</tt>:         <tt>ON</tt>* <tt>OFF</tt>
: A variable that is used to enable connectivity with SQuaDT. By default SQuaDT connectivity is enabled.
* <tt>MCRL2_ENABLE_EXPERIMENTAL</tt>:         <tt>ON</tt>, <tt>OFF</tt>*
: A variable that controls the build for experimental tools. By default no experimental tools are build.
* <tt>MCRL2_ENABLE_DEPRECATED</tt>:           <tt>ON</tt>, <tt>OFF</tt>*
: A variable that controls the build for deprecated tools. By default no deprecated tools are build.
* <tt>MCRL2_ENABLE_PROFILING</tt>:            <tt>ON</tt>, <tt>OFF</tt>*     
: A variable that enables profiling when executing tools. By default this option is disabled.                               
* <tt>MCRL2_ENABLE_TEST_TARGETS</tt>:         <tt>ON</tt>, <tt>OFF</tt>*
: A variable that enables the build of test targets. This option needs to be enabled in combination with BUILD_TESTING if one wants to execute library tests. By default this option is disabled.
* <tt>MCRL2_MAN_PAGES</tt>:                   <tt>ON</tt>*, <tt>OFF</tt>
: A variable that controls the generation of man-pages. By default this option is enabled.
* <tt>MCRL2_MONO_LIB</tt>:                    <tt>ON</tt>, <tt>OFF</tt>*    
: A variable that specifies if the separate libraries are build as one single library. This excludes third party libraries. By default this option is disabled.
* <tt>MCRL2_ENABLE_GUI_TOOLS</tt>:            <tt>ON</tt>*, <tt>OFF</tt>
: A variable that controls the build of graphical tools. These tools are Diagraphica, Ltsgraph, Ltsview, Squadt (requires SQUADT_CONNECTIVITY) and Xsim. If this value is equal to OFF, no graphical tools are build. By default this option is enabled.
* <tt>BUILD_TESTING</tt>:               <tt>ON</tt>*, <tt>OFF</tt>
: A variable that enables the execution of tests. If MCRL2_ENABLE_TEST_TARGETS is OFF, only tool tests are executed. If the value for MCRL2_ENABLE_TEST_TARGETS is ON, library tests are also executed. By default this option is enabled.
* <tt>CTAGS</tt>:                       <tt>/PATH/WITH/FILE/ctags</tt>
: This variable specifies the location where Ctags can be found. Ctags is a program that generates an index (or tag) file of names found in source and header files of various programming languages. 
* <tt>DART_TESTING_TIMEOUT</tt>:        <tt>1500</tt>
: This variable controls the timeout for running tests.
* <tt>MCRL2_INSTALL_BOOST_HEADERS</tt>:       <tt>ON</tt>, <tt>OFF</tt>*
: This variable controls the installation of BOOST headers. By default the value is OFF.
* <tt>SVNVERSION</tt>:                  <tt>/PATH/WITH/FILE/svnversion</tt>             
: This variable specifies the location where svnversion can be found. svnversion is a program for summarizing the revision mixture of a working copy. The program is used to insert the revision number of into the tools.
* <tt>wxWidgets_CONFIG_EXECUTABLE</tt>: <tt>/PATH/WITH/FILE/wx-config</tt>
: This variable specifies the full pathname to the wx-config utility in your wxWidgets installation (typically this is located in the bin/ subdirectory of your wxWidgets root install. wx-config is a small command-line utility which can help you while building on unix-like systems (including linux and Mac OS X). wx-config will tell what compile flags to use (wx-config --cppflags), tell what link flags to use (wx-config --libs) and manage multiple wxWidgets installs with different configurations (wx-config --list et al).
* <tt>wxWidgets_USE_STATIC</tt>:        <tt>ON</tt>, <tt>OFF</tt>*  
: This variable specifies if the wxWidgets libraries need to be linked static or shared. By default the libraries are used shared. If the toolset is statically build, this value should be changed to OFF.
* <tt>wxWidgets_USE_UNICODE</tt>:       <tt>ON</tt>*, <tt>OFF</tt>
: This variable specifies if the wxWidgets libraries are use in Unicode. By default the value is equal to ON.
* <tt>wxWidgets_wxrc_EXECUTABLE</tt>:   <tt>/PATH/WITH/FILE/wxrc</tt>
: This variable specifies the full pathname to the wx-rc utility in your wxWidgets installation (typically this is located in the bin/ subdirectory of your wxWidgets root install. The wxrc utility compiles binary xml resource files.

== Compilation ==

=== Unix Makefiles ===

After configuration the toolset can be compiled by executing
<pre>make</pre>
The Makefile provides targets for all tools and libraries. A complete list can be obtained using
<pre>make help</pre>
Compiling individual targets is useful to speed up incremental builds. For instance, in order to compile the target <tt>mcrl22lps</tt>, you can execute
<pre>make mcrl22lps</pre>
Or, if you have only made changes to the tool itself and not to the libraries, you can disable dependency checking by executing
<pre>make mcrl22lps/fast</pre>
It is possible to build the toolset with multiple threads, by using the <tt>j</tt> flag. 
To build the toolset with 8 threads use:
<pre>make -j8</pre>

=== Visual Studio ===
Please use Visual Studio 2010. Graphical tools, that are complied with earlier versions, are known to exit with a segmentation fault as the "vtable" gets corrupt.

== Installation ==

The toolset can be installed by executing the following command in the source tree:
<pre>make install</pre>
This installs the toolset in the <tt>CMAKE_INSTALL_PREFIX</tt> directory.

== Testing ==

Before executing tests, make sure that the makefile
has been generated with the value of <tt>MCRL2_ENABLE_TEST_TARGETS</tt>
set to <tt>YES</tt> and the toolset has been compiled once.

To conduct test specified in the source tree execute:
<pre>make tests</pre>
or
<pre>ctest .</pre>

To upload the tests to the [http://dyn295.win.tue.nl/~fstapper/cdash public dashboard] execute one of the following commands.
For a nightly build (a build of a svn checkout at 00:00:00 CEST)
<pre>ctest -D Nightly </pre>

For an experimental build (used to test new build features) of the current build:
<pre>ctest -D Experimental </pre>

For an continuous build of the current build:
<pre>ctest -D Continuous </pre>

More available options can be found using using:
<pre>ctest -D List </pre>

Note: If multiple Nightly builds are executed, the labels of the buildnames should be disjoint from the other buildname label, in order to avoid the override of earlier builds. To avoid this side-effect, execute cmake and set the BUILDNAME variable with an unique label:
<pre>cmake . -DBUILDNAME=label </pre>

== Packaging ==
To build platform specific packages execute the following command:
<pre>make package</pre>
or 
<pre>cpack .</pre>

To create packages for a specific distribution set the CPACK_SYSTEM_NAME variable to specific distribution by specifying the name, version and architecture.

When package are created for OS-X and Unix, we strongly advise to use the default value for CMAKE_INSTALL_PREFIX, or use a directory value that is available in the target platform.

We advise to use the latest stable version of Cmake and Cpack to generate packages for the various
platforms. 

=== Configure packaging for openSUSE ===
Configure Cmake by:
<pre>cmake . -DCPACK_SYSTEM_NAME="`cat /etc/SuSE-release | head -n1 | sed "s/ /\_/g"`"</pre>

=== Configure packaging for Fedora ===

Create '''script.sh''':
<pre>
#!/bin/bash
arch="_(`uname -i`)"
fed=`cat /etc/fedora-release | sed 's/ /\_/g'`
echo "$fed$arch"
</pre>

Then configure Cmake by:
<pre>cmake . -DCPACK_SYSTEM_NAME="`script.sh`"</pre>

== Setup CDash ==

CDash is an open source, web-based software testing server. CDash aggregates, analyzes and displays the results of software testing processes submitted from clients located around the world.

A generic manual on how to install CDash can be found [http://public.kitware.com/Wiki/CDash:Installation here].

== Tips and Tricks ==

=== Development ===

It is recommended to '''develop in debug mode'''. Improper use of the underlying ATerm Library may cause problems, that are caught by assertions in debug mode.

=== Build selective tools ===
By selecting single tools on the command-line with make, you can save time on building. For example to build mcrl22lps you can use the following command:
 make mcrl22lps

=== Installing syntax highlighting in Vim ===

To install vim syntax highlighting of &mu;CRL, mCRL2 and EBNF specifications, do
the following.
* From the root directory of the distribution, execute this commands: <pre> cp .vim ~/ </pre> 
* Add the following lines to <tt>$HOME/.vimrc</tt> to enable syntax highlighting (if this hasn't been done already):
<pre>
syntax enable
filetype plugin on
</pre>
* Add the following lines to <tt>$HOME/.vim/filetype.vim</tt> to link file names to the syntax files by their extension: 
<pre>
if exists("did_load_filetypes")
  finish
endif

augroup filetypedetect
  au! BufRead,BufNewFile *.bnf          setfiletype ebnf
  au! BufRead,BufNewFile *.ebnf         setfiletype ebnf
  au! BufRead,BufNewFile *.mcrl         setfiletype mcrl
  au! BufRead,BufNewFile *.mcrl2        setfiletype mcrl2
augroup END
</pre>
Return to CMake build instructions.
Retrieved from "http://mcrl2.org/mcrl2/wiki/index.php/CMake_build_instructions"
Personal tools

Views

Toolbox

View source

From MCRL2
