EiffelStudio: an EiffelSoftware project - User contributions [en]

Automatic Build Scripts

2007-06-11T09:32:32Z

Sieberst: /* Based on geant */

[[Category:Compiler]]
[[Category:EiffelStudio]]
This page references different build scripts that automate the process of building EiffelStudio.

= Platform independent =
== Based on geant ==
* To build a working delivery out of the trunk source code
svn checkout https://eiffelsoftware.origo.ethz.ch/svn/es/trunk trunk
set EIFFEL_SRC to point to this path

And then use the geant script located under trunk/Src/scripts/build.eant
geant -b $EIFFEL_SRC/scripts/build.eant build_es

This will create in the current directory a delivery in the EiffelXX.
You just need to point ISE_EIFFEL to this location to have a working EiffelStudio delivery

* Warnings:
The scripts are not fully tested, and may not be very well written for now
(it contains unfinished code .. especially regarding setup building)
On Windows:
- It may have issue with dotnet (windows)
- It requires: sed, tar, and bash (for runtime). You can use cygwin for that.
- Extracting the Gobo library may crash "tar" ... need to check
On linux:
- You need to answer a few questions, mostly for runtime configuration

However, the scripts are working and can be helpful to build EiffelStudio without too much trouble.

* Note: If there are built executables in the build folder (subfolder bin/), these executables are used for the delivery instead of recompiling from source. To make sure that the Delivery is built from scratch, the 'bin/' - folder should be removed from the build directory.
* If ever you have feedback, or comment, or anything, you can contact Jocelyn : mailto:jfiat@eiffel.com

= Windows =

[[User:Barnski|Bernardo Buss]] created a set of scripts for the automated compilation of EiffelStudio under Windows.
* Script: http://homepage.hispeed.ch/barnski/EiffelStudio_batch_files.zip
* Announcement: http://origo.ethz.ch/pipermail/es-devel/2006-April/000052.html
'''Note:''' 
* You may need to keep "2_checkout_dev.bat" up to date by yourself according to [[Compiling_EiffelStudio#Checking_out_from_SVN|Checking out from SVN]].
* It is possible that the '''batchfiles only work partial''' with EiffelStudio '''newer than version 5.7.0826''' (especially parts of the compilation process may differ too much).
'''Update:''' 
* [[User:Philipp|Philipp Bönhof]] improved the scripts with customizable parameters which should work with the newest pre-release of EiffelStudio. Download here: http://n.ethz.ch/student/pboenhof/autotest/eiffel_win_compilation_scripts.zip (updated: 2006-09-06)

= Linux =

Bernd Schoeller has developed a build script vor use with .acex configuration files. it is available for download at http://se.inf.ethz.ch/people/schoeller/download/build-ec-acex

For use with the new .ecf configuration files, please use this updated version: 
http://n.ethz.ch/~bherlig/download/build-ec-ecf.sh

This script requires a single checkout from the SVN repository (with the EIFFEL_SVN environment variable pointing to it). It will compile the bench or the batch compiler (you need to modify the script for the second).

== Gentoo ==
Ebuilds and installation instructions can be found [http://n.ethz.ch/~philipkr/eiffel-ebuilds.html here]

= Mac OSX =
Now that Mac builds are available, I guess you can use the Linux script on Mac OS, too.
I prefer this more simple script though:
<pre>
#!/bin/bash

cd $EIFFEL_SRC/C
make clobber
./quick_configure

cd $EIFFEL_SRC/library/event/Clib
finish_freezing -library
cd $EIFFEL_SRC/library/net/Clib
finish_freezing -library
cd $EIFFEL_SRC/library/vision2/Clib
finish_freezing -library
cd $EIFFEL_SRC/library/vision2/implementation/gtk/Clib
finish_freezing -library

cd $EIFFEL_SRC/Eiffel/Ace
ec -config ec.ecf -target bench -finalize -c_compile
</pre>
This basically automates the steps described [[Compiling_EiffelStudio|here]].

Automatic Build Scripts

2007-06-11T09:31:24Z

Sieberst:

[[Category:Compiler]]
[[Category:EiffelStudio]]
This page references different build scripts that automate the process of building EiffelStudio.

= Platform independent =
== Based on geant ==
* To build a working delivery out of the trunk source code
svn checkout https://eiffelsoftware.origo.ethz.ch/svn/es/trunk trunk
set EIFFEL_SRC to point to this path

And then use the geant script located under trunk/Src/scripts/build.eant
geant -b $EIFFEL_SRC/scripts/build.eant build_es

This will create in the current directory a delivery in the EiffelXX.
You just need to point ISE_EIFFEL to this location to have a working EiffelStudio delivery

* Warnings:
The scripts are not fully tested, and may not be very well written for now
(it contains unfinished code .. especially regarding setup building)
On Windows:
- It may have issue with dotnet (windows)
- It requires: sed, tar, and bash (for runtime). You can use cygwin for that.
- Extracting the Gobo library may crash "tar" ... need to check
On linux:
- You need to answer a few questions, mostly for runtime configuration

However, the scripts are working and can be helpful to build EiffelStudio without too much trouble.

* Note: If there are built executables in the build folder (in bin/), these executables are used for the delivery instead of recompiling from source. To make sure that the Delivery is built from scratch, the 'bin/' - folder of the build directory should be removed.
* If ever you have feedback, or comment, or anything, you can contact Jocelyn : mailto:jfiat@eiffel.com

= Windows =

[[User:Barnski|Bernardo Buss]] created a set of scripts for the automated compilation of EiffelStudio under Windows.
* Script: http://homepage.hispeed.ch/barnski/EiffelStudio_batch_files.zip
* Announcement: http://origo.ethz.ch/pipermail/es-devel/2006-April/000052.html
'''Note:''' 
* You may need to keep "2_checkout_dev.bat" up to date by yourself according to [[Compiling_EiffelStudio#Checking_out_from_SVN|Checking out from SVN]].
* It is possible that the '''batchfiles only work partial''' with EiffelStudio '''newer than version 5.7.0826''' (especially parts of the compilation process may differ too much).
'''Update:''' 
* [[User:Philipp|Philipp Bönhof]] improved the scripts with customizable parameters which should work with the newest pre-release of EiffelStudio. Download here: http://n.ethz.ch/student/pboenhof/autotest/eiffel_win_compilation_scripts.zip (updated: 2006-09-06)

= Linux =

Bernd Schoeller has developed a build script vor use with .acex configuration files. it is available for download at http://se.inf.ethz.ch/people/schoeller/download/build-ec-acex

For use with the new .ecf configuration files, please use this updated version: 
http://n.ethz.ch/~bherlig/download/build-ec-ecf.sh

This script requires a single checkout from the SVN repository (with the EIFFEL_SVN environment variable pointing to it). It will compile the bench or the batch compiler (you need to modify the script for the second).

== Gentoo ==
Ebuilds and installation instructions can be found [http://n.ethz.ch/~philipkr/eiffel-ebuilds.html here]

= Mac OSX =
Now that Mac builds are available, I guess you can use the Linux script on Mac OS, too.
I prefer this more simple script though:
<pre>
#!/bin/bash

cd $EIFFEL_SRC/C
make clobber
./quick_configure

cd $EIFFEL_SRC/library/event/Clib
finish_freezing -library
cd $EIFFEL_SRC/library/net/Clib
finish_freezing -library
cd $EIFFEL_SRC/library/vision2/Clib
finish_freezing -library
cd $EIFFEL_SRC/library/vision2/implementation/gtk/Clib
finish_freezing -library

cd $EIFFEL_SRC/Eiffel/Ace
ec -config ec.ecf -target bench -finalize -c_compile
</pre>
This basically automates the steps described [[Compiling_EiffelStudio|here]].

Capture and replay

2007-04-19T07:35:25Z

Sieberst: /* Open Questions */

This is the project page for capture & replay debugging

==Overview==
Capture/Replay should be implemented according to [1]:
*After defining the set of observed classes, an instrumented executable should be generated, that records all interactions between observed and unobserved objects.
*For the replay phase, unobserved classes are replaced with stubs that replay their with the observed classes based on the recorded interactions. Thus it should be possible to replay a run for the set of observed classes.

*Capture/Replay should at least be available for the Workbench (Frozen) C Code. The implementation for melted code is optional. It can't be avoided that parts of the work will depend on the compiler backend that is used. These dependencies should be isolated into separate classes and kept as small as possible.

*The overhead of capture/replay should be measured to see if it could be used in practice.

==Plan==
The project will be divided into several iterations to be able to work with both capture and replay as fast as possible.

===iteration 0===
*Basic Capture
*Basic Replay

===iteration 1===
*Fields
*Expanded Types
*Contracts

===iteration 2===
*Polymorphism
*Genericity
*Onces

===iteration 3===
*Agents
*Tuples
*Externals

[[Image:Schedule 2007-03-27.png|800px]]

==References==
[1] Shrinivas Joshi and Alessandro Orso: Capture and Replay of User Executions to Improve Software Quality

==Common build errors==
Here's a draft of some lessons learned while building eiffel studio:

* gcc: $ISE_EIFFEL/precomp/spec/linux-x86/EIFGENs/base/W_code/preobj.o: No such file or directory --> building of precompiles not successfully finished. Precompile $ISE_EIFFEL.

==Other common errors==
* console applications in debug mode can't read from console, if the hosting eiffel studio was started in the background ('estudio &' instead 'estudio'). This is no bug, as '&' detaches the application from the standard input.

==Open Questions==
* Why does Eiffel not support 'real' weak references? IDENTIFIED makes it necessary to modify a class before weak references to its objects are possible. Wouldn't it be possible to keep a table of Eiffel objects, which is ignored when calculating the reachable set of objects, but whose references are updated, when the GC moves objects? Instead of keeping the offset of the table entry (object_id of IDENTIFIED):
** an entry per weak reference could be made
** or an entry per object, but then it would be necessary to lookup in the table before creating the reference

Capture and replay

2007-04-19T07:35:06Z

Sieberst: /* Open Questions */

Capture and replay

2007-04-19T07:34:19Z

Sieberst:

This is the project page for capture & replay debugging

==Overview==
Capture/Replay should be implemented according to [1]:
*After defining the set of observed classes, an instrumented executable should be generated, that records all interactions between observed and unobserved objects.
*For the replay phase, unobserved classes are replaced with stubs that replay their with the observed classes based on the recorded interactions. Thus it should be possible to replay a run for the set of observed classes.

*Capture/Replay should at least be available for the Workbench (Frozen) C Code. The implementation for melted code is optional. It can't be avoided that parts of the work will depend on the compiler backend that is used. These dependencies should be isolated into separate classes and kept as small as possible.

*The overhead of capture/replay should be measured to see if it could be used in practice.

==Plan==
The project will be divided into several iterations to be able to work with both capture and replay as fast as possible.

===iteration 0===
*Basic Capture
*Basic Replay

===iteration 1===
*Fields
*Expanded Types
*Contracts

===iteration 2===
*Polymorphism
*Genericity
*Onces

===iteration 3===
*Agents
*Tuples
*Externals

[[Image:Schedule 2007-03-27.png|800px]]

==References==
[1] Shrinivas Joshi and Alessandro Orso: Capture and Replay of User Executions to Improve Software Quality

==Common build errors==
Here's a draft of some lessons learned while building eiffel studio:

* gcc: $ISE_EIFFEL/precomp/spec/linux-x86/EIFGENs/base/W_code/preobj.o: No such file or directory --> building of precompiles not successfully finished. Precompile $ISE_EIFFEL.

==Other common errors==
* console applications in debug mode can't read from console, if the hosting eiffel studio was started in the background ('estudio &' instead 'estudio'). This is no bug, as '&' detaches the application from the standard input.

==Open Questions==
* Why does Eiffel not support 'real' weak references? IDENTIFIED makes it necessary to modify a class before weak references to its objects are possible. Wouldn't it be possible to keep a table of Eiffel objects, which is ignored when calculating the reachable set of objects, but whose references are updated, when the GC moves objects? Instead of keeping the offset of the table entry (object_id of IDENTIFIED), either a entry per weak reference could be made, or an entry per object, but then it would be necessary to lookup in the table before crating the reference

Capture and replay

2007-04-18T11:49:47Z

Sieberst: /* Other common errors */

Capture and replay

2007-04-18T11:46:51Z

Sieberst:

Capture and replay

2007-04-17T11:37:03Z

Sieberst:

Capture and replay

2007-03-27T09:17:10Z

Sieberst:

Capture and replay

2007-03-27T09:11:14Z

Sieberst:

File:Schedule 2007-03-27.png

2007-03-27T09:09:21Z

Sieberst: Capture & Replay: tentative Schedule (March 27, 2007)

Capture & Replay: tentative Schedule (March 27, 2007)

Capture and replay

2007-03-27T08:55:28Z

Sieberst:

Running EiffelStudio in Workbench mode

2007-03-22T09:21:33Z

Sieberst:

[[Category:EiffelStudio]]
[[Category:Compiler]]
Starting from revision 6.0 of EiffelStudio, we made it easier to run side by side an official version of EiffelStudio and its workbench version. To make sure this functionality is enabled you need to create a separate delivery of EiffelStudio located at the same place as the official version with the '''_wkbench''' suffix.

We assume that you have installed the official release of EiffelStudio in the following directory '''/apps/EiffelXX'''. Therefore in the '''/apps''' directory follow the [[Building_a_delivery|instruction on how to build a delivery]], but use the name EiffelXX_wkbench instead of EiffelXX.

Now that you have done that, simply copy your workbench binaries into EiffelXX_wkbench/studio/spec/$ISE_PLATFORM/bin. It is also possible to directly link 'ec' from the workbench binaries (located in $EIFFEL_SRC/Eiffel/Ace/EIFGENs/bench/W_code/).

Create the precompiles for EiffelXX_wkbench using ec from EiffelXX_wkbench.

Make sure that $EIFFEL_SRC is set.