Build Status

• Master Branch:
• Develop Branch:

REQUIREMENTS

The build relies on a valid gcc, cmake and 32 bit headers installation:

Unix:

see setup-ubuntu.sh for a complete setup for a recent ubuntu machine.

Mac:

Download and install the homebrew package manager with some additional packages

# install homebrew with the following oneliner:
ruby -e "$(curl -fsSL https://raw.github.com/mxcl/homebrew/go)"
# if you haven't installed git yet
brew install git
# wget is needed in certain cases to download files
brew install wget
# OSX' default tar doesn't feature 7z compression needed for for some 3rd party libs
brew install gnu-tar --default-names

Install the latest version of XCode and XCode command line tools. Download MacOSX10.6.sdk.zip and put in Xcode SDK folder:

# make sure you're root: sudo su
cd /Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs
wget http://files.pharo.org/vm/src/lib/MacOSX10.6.sdk.zip
unzip MacOSX10.6.sdk.zip
rm MacOSX10.6.sdk.zip

Windows:

For building the VM under windows you will have to install a minggw environment.

Install the following additional MinGW packages by running the following command in the MingGW Shell:

mingw-get install msys-unzip msys-wget msys-zip

The thing is that on newer installs, you will not have the mingw-get.exe in the system. MSys/MinGW install is getting ever more twisted than before. You can extract it from the zip version of the installer. There is also a copy in the pharo-vm/win32support folder. Just copy it into C:\MinGW\bin

Install git: http://code.google.com/p/msysgit/ and add it to PATH variable after the msys paths.

Install CMake: during installation, in install options , make sure that you choose to add CMake to PATH.

To check if everything is installed, open MSYS program (which should look like a UNIX terminal) and try to execute the different commands: git, make and cmake.

Also there are some discrepancy with recent GCC (4.6.1), you need to add:

#ifndef _MINGW_FLOAT_H_
#include_next <float.h>
#endif

into C:\MinGW\lib\gcc\mingw32\4.6.1\include\float.h at the end of that file. The version number, in this case 4.6.1, might be different in your case.

At the time of writing the mingw32 version is 4.8.1.

There are additional steps to take to have the build process to work on a 64 bit Windows machine (e.g. Windows 8.1 Pro):

1. As the build process uses libcrtdll.dll, one needs to make a libcrtdll.a to link against. libcrtdll.dll is obsolete but that's what we do use. So, one must have a libcrtdll.def file from which to create the libcrtdll.a file. A copy of those files is provided in the wind32support directory. Copy the libcrtdll.a file in C:\MinGW\lib

2. The _mingw.h header has to be amended to deal with changes in some typedefs. One needs to add:

#define off64_t _off64_t
#define off_t _off_t

at the end.

For some weird reason, make sure you copy the _mingw.h header to the:

C:\MinGW\include C:\MinGW\mingw32\include

folders.

Should you need a copy of crtdll32.dll, it lives in C:\Windows\SysWOW64 on 4-bit system. The build process fails to find it on such machines.

3. time_t in its 32-bit version is required by the VM at this point in time. To work properly and avoid the "time_t structure is not 32 bit" error message, the CMakeLists.txt file in the build folder has to be changed (add -D_USE_32BIT_TIME_T). The VMMaker CMake related package should take care of this. Not done yet.

add_definitions(-march=pentium4 -mwindows -D_MT -msse2 -mthreads -mwin32 -mno-rtd -mms-bitfields -mno-accumulate-outgoing-args -D_WIN32_WINNT=0x0501 -DWINVER=0x0501 -DWIN32 -DWIN32_FILE_SUPPORT -DNO_ISNAN -DNO_SERVICE -DNO_STD_FILE_SUPPORT -DLSB_FIRST -DVM_NAME="Pharo" -D_USE_32BIT_TIME_T -DX86 -DSTACK_ALIGN_BYTES=16 -DALLOCA_LIES_SO_USE_GETSP=0 -DENABLE_FAST_BLT  -g0 -O2 -march=pentium4 -momit-leaf-frame-pointer -maccumulate-outgoing-args -funroll-loops -DNDEBUG -DDEBUGVM=0)

Building the VM

1. Download the sources from github

git clone --depth=1 https://github.com/pharo-project/pharo-vm.git
cd pharo-vm

Windows specifics

If you do this on Windows/Msys, you'll get a message about the GeniePlugin giving trouble:

error: unable to create file mc/VMMaker-oscog.package/GeniePlugin.class/instance/primSameClassAbsoluteStrokeDistanceMyPoints.otherPoints.myVectors.otherVectors.mySquaredLengths.otherSquaredLengths.myAngles.otherAngles.maxSizeAndReferenceFlag.rowBase.rowInsertRemove.rowInsertRemoveCount..st (Filename too long)

As the Windows VM doesn't use the plugin, that's no big deal.

Next, you'll face another issue which is that that clone isn't respecting the line endings of the files and all files will appear as being different from the ones in the repository. It makes it impossible to stage, commit, and push.

So go to the pharo-vm/.git/ folder and edit the config file in there.

Add:

text=auto

at the end of the [core] section.

It should be working when you set that in the /etc/gitconfig but apparently it doesn't work.

Then, back to the pharo-vm folder and remove it all (the .git/ folder will stay as it is a hidden folder).

cd pharo-vm/
rm -rf *

Then check everything out again.

git checkout -f HEAD

It should be fast as you have the whole clone in the .git/ folder

Now, line endings are correct and one will be able to commit.

Now, gcc will not work as the default $PATH is incorrect in the Msys install.

Get in your home dir ( cd ~) and edit the .profile file. Add this to the top.

export PATH=/c/MinGW/bin:$PATH

Should you need to know where files are and what the Msys pathes are in Windows, you can also add this function to the .profile:

winpath() {
    if [ -z "$1" ]; then
        echo "$@"
    else
        if [ -f "$1" ]; then
            local dir=$(dirname "$1")
            local fn=$(basename "$1")
            echo "$(cd "$dir"; echo "$(pwd -W)/$fn")" | sed 's|/|\\|g';
        else
            if [ -d "$1" ]; then
                echo "$(cd "$1"; pwd -W)" | sed 's|/|\\|g';
            else
                echo "$1" | sed 's|^/\(.\)/|\1:\\|g; s|/|\\|g';
            fi
        fi
    fi
}

2. Get a fresh pharo image from the build server by running the script in the image folder.

cd image && ./newImage.sh

3. generator.image now contains VMMaker with the Slang sources, plus a workspace with some example VM configurations. (That's not true as there will be no workspace open or your with that, so open a workspace and copy paste the line you need, and then evaluate it (Do It)). Pick or edit the configuration you want, then evaluate it.

"Unix"
PharoVMBuilder buildUnix32.
"OSX"
PharoVMBuilder buildMacOSX32.
"Windows"
PharoVMBuilder buildWin32.

See startup.st for more examples for the common platforms.

As an alternative, try (Windows flavor shown):

./pharo generator.image eval 'PharoVMBuilder buildWin32'

Should you want to build a StackVM version, use the PharoSVMBuilder.

4. Once the sources are exported, you can launch cmake and build the VM:

cd build
./build.sh

Before doing that, you would be well advised to make a tar or zipfile of the whole folder in case you encounter a compilation/resources download problem as doing the whole process above is quite long.

5. Finally, run the freshly compiled VM from results.

See a complete guide on how to build Cog VM using cmake on: http://code.google.com/p/cog/wiki/Guide (even if this VM is the PharoVM and notthe CogVM per se).