Bilder

# Preparing a Windows machine for Bilder (64-bit only)

For building on Windows 10 in Ubuntu, follow the Linux Bilder setup instructions. 

Windows 7/2008: For 64-bit systems, 64-bit applications are stored in C:\Program Files and 32-bit applications are stored in C:\Program Files (x86). UserAccountControlSettings can be fine-tuned (see Control-Panel, System and Security, Action Center). Set Control Setting to the lowest setting (never notify) to avoid unwanted dialog boxes. This requires a reboot to take effect! At least for ATLAS, the UAC Settings must be adjusted to "never notify" (this action is generally recommended while taking all the steps below). 

# Basic Windows Configuration

_Warning:_ In following the directions below, pre-defined env variables like CL, PETSC_DIR, PETSC_ARCH, and others will cause problems.  For example, one user had CL=/nologo which prevented the version and other info from being printed and caused bilder to fail.

# Editing your system path on Windows

From the Start menu, right click on My Computer and choose Properties. Choose the Advanced Tab, and click the Environment Variables button towards the bottom of the dialog. In System Variables, highlight Path and click Edit. This is where you make changes to your system path.

# Ensure that Windows knows its domainname

* From a command prompt, type the command: 

~~~~~~

ipconfig /all

~~~~~~

Look for value of the "Primary Dns Suffix" field, which should be your domain name (i.e. txcorp.com).

* If cygwin is already installed,

~~~~~~

ipconfig /all | grep -i "Primary Dns Suffix" | sed -e 's/^.*: //'

~~~~~~

should return the domainname. This only applies if it is part of a Windows Domain.

* For Windows 7/Windows 2008 machines that are not a member of the Windows Domain, Active Directory, do the following:

    1. Right click on My Computer, select properties

    2. Click on Advanced system settings

    3. Select the computer name tab

    4. Click the change button

    5. Click the more button

    6. Enter the Primary DNS suffix. i.e. txcorp.com 

# Create initial directories

* Create the folder C:\\bin (if not already present).

* Add or move C:\\bin to the front of your system path.

# Tools needed by Bilder

__If all you need is python and sphinx__ (e.g., for builds of documentation), then you need only

* Cygwin (for bash shell)

* CMake from an installer

* Python from an installer

* Latex (MikTek below)

* Visual Studio Express (for nmake)

and then you can add the arguments,  -W python,cmake, and your installed Python and CMake will be used if your path is correct.

## Blat

Blat is a sendmail client for Windows.

* Download Blat from [The Blat SourceForge](http://sourceforge.net/projects/blat) Site and extract all files. As of 07/18/2013, this is version 311.

* Extract the blat311 folder into C:\\bin.

* Copy the C:\bin\blat311\full\blat.{exe,dll} to C:\bin\blat.{exe,dll}

* Execute the following command in a cygwin terminal

~~~~~~

    blat -install mail.txcorp.com <username>@txcorp.com

~~~~~~

## CMake

CMake is a cross-platform build system.

* Install [CMake (a 32-bit application)](http://www.cmake.org/files/).

  * Version 2.8.6 is required.  Later versions work also.

  * Add the CMake path to the front of the system path! (Needed to build newer 64 bit versions through Bilder)

  * When this step is complete, make sure the newest CMake is the only one in your system path.

## CYGWIN

### Gotchas (in advance)

* Do not install Cygwin's MinGW. Those are installed in a separate area to reduce conflicts.

* Do not install Cygwin's rc, or you may get a weird error (/focmTryCompileExec.exe.embed.manifest.res: No such file or directory) about cl being invalid.  This can be seen by the output of 'which rc'.

* Do not install Cygwin's mt.  If 'which mt' returns /bin/mt or /usr/bin/mt, then move this aside too.

* If 'which link' returns /usr/bin/link, then move this aside (mv /usr/bin/link.exe /usr/bin/linkoff.exe) so that it is not picked up to replace the Visual Studio link.  (This is where we could define BILDER_LINK.)

* Make sure that 'which find' returns the cygwin version (/usr/bin/find), not the Windows version.

* Make sure 'which cmd' returns the Windows version. If not, check that your bash_profile has not made an error in setting your path.

* If you get an error like "ValueError: Symbol table not found" when building numpy, you are somehow using a 32-bit version of objdump.  Disable the 32-bit version.

### Updating Cygwin

* Be sure to select the version of subversion that is compatible with any other sister machines being run through jenkins.  They must all use the same version of svn, which must be the same version chosen in Jenkins.

* If you have moved aside any of the interfering commands (e.g. link, mt, rc) in the past and have recently updated cygwin or Windows, then do the 'which' checks again.

* Recreate the /etc/passwd and /etc/group file again using the mkpasswd and mkgroup commands described in the Configuring Cygwin section.

* Install Cygwin from [here](http://cygwin.com/install.html). There are now separate installers for 64 bit (setup-x86_64.exe ) and 32 bit (setup-x86.exe).

* Upon running setup-*.exe, select the packages:

  * Base -> util-linux

  * Devel -> bison

  * Devel -> flex

  * Devel -> gcc-g++ and gcc-fortran (4.9.3 does not compile sqlite, so choose 4.9.2)

  * Devel -> git

  * Devel -> make

  * Devel -> mercurial

  * Devel -> patch

  * Devel -> subversion (If this machine will be a Jenkins slave, the version of subversion that is consistent with the Jenkins master's svnkit should be chosen. The latest version supported by svnkit is 1.8.14 at the time, Dec. 31, 2016, of this writing.)

  * Editors -> vim and emacs (and alternate editors of choice)

  * Math -> bc

  * Net -> openssh

  * Net -> curl

  * Python -> python (see note below)

  * Shells -> mintty

  * Utils -> diffutils

  * Utils -> dos2unix

  * Web -> wget

* Do NOT install any of the mingw packages.  If used, they must be installed separately to overcome path issues.  (NumPy will not accept the different, distinguishing name for mingw's gcc).

* Note: PATH should be set such that the Windows python is found before the cygwin python. We need the cygwin python to build PETSc. Once PETSc is cmaked, this requirement will go away.

* Note: mkshortcut.exe in cygutils 1.4.10-2 is broken, but as of (July 18, 2013 with cygutils version 1.4.12 this is fixed).  If the version of mkshortcut.exe that is installed when you run setup.exe doesn't work (i.e. mkshortcut -h segfaults), then go bach to cygwin setup and update your cygutils.

### Setting Cygwin Disk Mounts

* Create the directory winsame at the top level of both the Cygwin and Windows file systems. You must always work in this directory.  This is critical for getting the ATLAS linear algebra libraries to build. Do this via:

~~~~~~

mkdir /cygdrive/c/winsame

mkdir /winsame

mount C:/winsame /winsame

~~~~~~

To make this permanent, put

~~~~~~

C:/winsame /winsame ntfs binary 0 0

~~~~~~

as one line in /etc/fstab.

On Windows-64, additionally put

~~~~~~

C:/Program\040Files\040(x86) /ProgramFilesX86 ntfs binary 0 0

~~~~~~

as one line in /etc/fstab.  This allows one to construct a valid path with no parentheses as needed for ATLAS.

### Configuring Cygwin

* Use a "Cygwin64 Terminal" from basic cygwin installation above to perform all subsequent bash tasks

* If bilderizing a domain machine, create an /etc/passwd file with the following command

~~~~~~

mkpasswd -l -d -p /winsame > /etc/passwd

~~~~~~

* If bilderizing a non-domain machine, create an /etc/passwd file with the following command

~~~~~~

mkpasswd -l -p /winsame > /etc/passwd

~~~~~~

* If bilderizing a domain machine, create an /etc/group file with the following command

~~~~~~

mkgroup -l -d > /etc/group

~~~~~~

* If bilderizing a non-domain machine, create an /etc/group file with the following command

~~~~~~

mkgroup -l > /etc/group

~~~~~~

* Close the terminal and open a new one. You should see that the 'pwd' command shows that you are in a new home area directory: /winsame/<username>. Copy bash profile files from /home to /winsame and delete the previous home area for each user with the commands:

~~~~~~

cp /home/<username>/.* /winsame/<username>/

rm -rf /home/<username>

## Dependency Walker

Dependency Walker shows the DLL's that an executable depends on.  This is used to find and copy-in DLLs to a final distribution.

__Make sure you download and install the correct version of dependencywalker for your machine (x86 for x86 machines, x64 for 64bit machines, etc).__

Install [Dependency Walker](http://www.dependencywalker.com/) into C:\\bin.

## JOM

JOM is an nmake substitute that allows the -j flag for faster compilation.

* Create the folder C:\bin (if not already present).

* Add C:\bin to your system path (if not already there).

* Download jom.zip from [the Qt Project](https://wiki.qt.io/Jom).

* Extract the contents of jom.zip

* Move/copy jom.exe to C:\bin (you then can delete the remainder of the contents or keep for historical reasons).

## LaTeX

If you will be building documentation, then you will need to

* Install [Doxygen](http://www.stack.nl/~dimitri/doxygen/download.html).

* Install Basic MikTeX from [MikTeX](http://miktex.org/). Use the MikTeX Package Manager to install breakurl capt-of cmap comment courier ec eepic environ epstopdf eqparbox fancybox fancyvrb framed footnote framed fricychap gensymb helvetic lineno mdwtools mmap mptopdf multirow newfloat overpic palatino parskip pdftex pifont revtex4 siunitx subfiles symbol tabulary threeparttable titlesec trimspaces txfonts units upquote url wrapfig xcite xcolor xypic zapfding

* In MikTex Settings application (start from StartMenu), under the General tab, choose "Yes" for "Install missing packages on-the-fly". This ensures that builds won't hang waiting for user to dismiss install package dialogs.

* Install [ghostscript](http://sourceforge.net/projects/ghostscript/files/GPL%20Ghostscript/9.04/).

~~~~~~

## MPI

Download the HPC Pack 2008 R2 (Service Pack 4 as of March 2016) from:

https://www.microsoft.com/en-us/download/details.aspx?id=29992

The 64bit installer is named HPC2008R2-SP4-Update-x64.zip (the monitor pack & integration pack are separate and optional).

The installers will put mpiexec in your path, but you will need to restart any cygwin shells and the Jenkins slave to make this active.

## NSIS

NSIS is a scriptable installer maker.

* Install NSIS from [NSIS Download Site](http://nsis.sourceforge.net/Download).

    * For building CMake 64bit and if you are building the composers, you will need a generator for installer executables, which is NSIS (Nullsoft Scriptable Install System) a professional open source system to create Windows installers.

    * Version 2.46 is available as of Aug 21, 2011. 

* Install NSIS Access Control Plugin from [Access Control Plugin Site](http://nsis.sourceforge.net/AccessControl_plug-in).

Copies directories and files into the NSIS installation as follows:

~~~~~~

AccessControl.zip\Contrib\AccessControl --> NSIS\Contrib\AccessControl

AccessControl.zip\Docs\AccessControl --> NSIS\Docs\AccessControl

AccessControl.zip\Plugins\AccessControl.dll --> NSIS\Plugins\x86-ansi\AccessControl.dll

AccessControl.zip\Unicode\Plugins\AccessControl.dll --> NSIS\Plugins\x86-unicode\AccessControl.dll

~~~~~~

## Perl

Perl is needed for Qt

* Download and install [ActiveState Perl](http://www.activestate.com/activeperl/downloads).

## Python

* As of VS12, bilder builds Python from a checkout of a git repo and no longer needs to be installed by hand. No PATH changes are needed either.

## Subversion

* Install the CollabNet Subversion Command-Line Client from [The CollabNet Download Site](http://www.open.collab.net/downloads/subversion/).

Tech-X users may use the Tech-X login available at the [Tech-X internal accounts page](https://internal.txcorp.com/it/wiki/techxAccounts).

* With this, you will have two versions of svn on your machine. One is in `/usr/bin` under cygwin, and it is used for direct invocation at the bash command-line. The other is in `\Program Files`, and it is needed for getting repo versions when Bilder is invoked through Jenkins. You can verify this with:

~~~~~~

$ where svn

  C:\cygwin64\bin\svn.exe

  C:\Program Files\CollabNet\Subversion Client\svn.exe

$ /bin/svn --version | head -n 1

  svn, version 1.7.14 (r1542130)

$ /cygdrive/c/Program\ Files/CollabNet/Subversion\ Client/svn --version | head -n 1

  svn, version 1.7.18 (r1615261)

~~~~~~

## Visual Studio

* Bilder works with VS12 (Visual Studio 2013). Since code is moving to C++11 standards, VS12 is required. We recommend you remove older versions of VS such as VS10 and VS9.

    * VS12: Visual Studio 2013 Community Edition from Microsoft [VS12 Download Site](https://www.visualstudio.com/en-US/products/visual-studio-community-vs)

* Install the latest update for Visual Studio. Open Visual Studio application. Going to Help -> About Microsoft Visual Studio, should show you the update version installed. As of July 2015 it is as Update 5. To update go to [Visual Studio Update Download](http://www.microsoft.com/en-us/download/details.aspx?id=48129).

* Ensure that Visual Studio is not in the system path. (Bilder adds this as needed.)

### Compatibility with Python

* Python is built by Bilder.

# Useful Tools

## Notepad++

* (Optional) Notepad++ is a free source code editor that is a great tool for Windows.

* Download from http://notepad-plus-plus.org/

* Install and pin to your taskbar.

# Libraries

## OpenSSL

OpenSSL is needed by libssh.

* Download from http://slproweb.com/products/Win32OpenSSL.html

* Choose the Win64 OpenSSL v1.0.2j  (not Light) on 64bit or the Win32 OpenSSL v1.0.2j on 32bit windows.

* You may have to install Visual C++ Redistributables if the installer complains.

* During the installation, select "Copy OpenSSL DLLs to: The OpenSSL binaries (/bin) directory"

* After the installation on 64bit windows, goto C:\Windows\System32 and prepend libssl32.dll, libeay32.dll, and ssleay32.dll with an "OFF." This and the next step are required so that dependency walker finds the SSL libs from the OpenSSL distro instead of the ones in C:\Windows\System32.

* Add C:\OpenSSL-Win64 (in some cases, we have seen that C:\OpenSSL-Win64\bin should be added instead) or the directory where you installed OpenSSL to the beginning of the system path. In particular, it needs to be in front of the CollabNet path and the Intel client path, because both contain libeay32.dll. A which for the libeay32.dll should give this installed version. For example:

~~~~~~

which libeay32.dll

/cygdrive/c/OpenSSL-Win64/bin/libeay32.dll

~~~~~~

* If built software has unexplained crashes, recheck the above command results.

##  [Building and Installing Qt4](#qt4)

* Make sure no other Qt is in your system path.

* Get the Qt Libraries from http://download.qt.io/official_releases/qt/4.8/4.8.7/. Download qt-opensource-windows-x86-vs2010-4.8.7.exe. (The vs2010 in the name is irrelevant as we will build Qt using the source code in this download.)

** Version 5.6.1: from http://download.qt.io/official_releases/qt/5.6/5.6.1/qt-opensource-windows-x86-msvc2013_64-5.6.1.exe

* Run this program, selecting C:\winsame\builds-vsXX\winqt\<version> as your installation directory, where XX is the version of your Visual Studio.

* If 4.8.7, patch Qt by opening a Cygwin window:

~~~~~~

cd /winsame/builds-vs12/winqt/4.8.7

patch -p1 --binary < /path/to/bilder/patches/qt-4.8.7.patch

~~~~~~

### Compiling Qt4

* The copy/paste-able commands below assume VS12.

In a Visual Studio x64 DOS window:

~~~~~~

set VER=12

set SFX=vs%VER%

set QTVER=4.8.7

cd C:\winsame\builds-%SFX%\winqt\%QTVER%

configure.exe -prefix C:\winsame\contrib-%SFX%\qt-%QTVER%-sersh -debug-and-release -opensource \

-confirm-license -fast -no-sql-db2 -no-sql-ibase -no-sql-mysql -no-sql-oci -no-sql-odbc -no-sql-psql \

-no-sql-sqlite -no-sql-sqlite2 -no-sql-tds -no-libtiff -webkit -declarative

~~~~~~

(NOTE: If you are building with Visual Studio 2008, then you'll need to add the following arguments to the above command: -platform win32-msvc2008)

In a bash window launched from the previous DOS window (try `C:\cygwin64\bin\mintty -`, note that the dash is important!), execute the following (changing vsver to your version)

~~~~~~

export VER=12

export SFX=vs${VER}

cd /winsame/builds-${SFX}/winqt/4.8.7

mkdir -p /winsame/contrib-${SFX}/qt-4.8.7-sersh

cp -R mkspecs /winsame/contrib-${SFX}/qt-4.8.7-sersh

cd /winsame/contrib-${SFX}

ln -s qt-4.8.7-sersh qt-sersh

mkshortcut.exe -n qt-sersh.lnk qt-4.8.7-sersh

~~~~~~

In the Visual Studio x64 DOS window

~~~~~~

set VER=12

set SFX=vs%VER%

cd C:\winsame\builds-%SFX%\winqt\4.8.7 

set PATH=%PATH%;C:\winsame\builds-%SFX%\winqt\4.8.7\bin

nmake         # Took 3.5 hours on a 2.3 GHz Core2 Duo with Solid State Drive

nmake install # Took 10 minutes on a 2.3 GHZ Core2 Duo with Solid State Drive

~~~~~~

* If you want to use this qt outside of Bilder, add C:\winsame\contrib-%SFX%\qt-4.8.7-sersh\bin to the system path variable.  This may not work if you have more than one Bilder run.

In the bash window, then execute

~~~~~~

/path/to//bilder/setinstald.sh -i /winsame/contrib-$SFX qt,sersh

~~~~~~

## [Building and Installing Qt5](#qt5)

* Ruby, http://rubyinstaller.org/, must be installed first.

* Make sure no other Qt is in your system path.

* Get the Qt Libraries from http://download.qt.io/official_releases/qt/5.6/5.6.1/qt-opensource-windows-x86-msvc2013_64-5.6.1.exe

* Run this program, selecting C:\winsame\builds-vsXX\winqt\<version> as your installation directory, where XX is the version of your Visual Studio.

### Compiling Qt5

* The copy/paste-able commands below assume VS12.

In a Visual Studio x64 DOS window:

~~~~~~

set VER=12

set SFX=vs%VER%

set QTVER=5.6.1

set CONTRIB_DIR=C:\winsame\contrib-%SFX%

~~~~~~

The last command can be modified to your installation dir.  Continue with

~~~~~~

cd C:\winsame\builds-%SFX%\winqt\%QTVER%\5.6\Src

configure.bat -prefix %CONTRIB_DIR%\qt-%QTVER%-sersh -opensource -confirm-license -no-separate-debug-info -developer-build -make-tool jom -make libs -make tools -no-sql-db2 -no-sql-ibase -no-sql-mysql -no-sql-oci -no-sql-odbc -no-sql-psql -no-sql-sqlite -no-sql-sqlite2 -no-sql-tds -no-libjpeg -no-qml-debug -nomake examples -nomake tests -skip qtandroidextras -skip qtdoc -skip qtlocation -skip qtscript -skip qtserialbus -skip qtserialport -skip qtsensors

jom         # Took 45 minutes on a 4-core i7

jom install # Took 8 minutes on a 4-core i7

~~~~~~

VisIt team also uses (doesn't skip) qtwebengine, qtquickcontrols, qtquickcontrols2, as QtWebEngineWidgets requires them.

### Completing installation

In a bash window:

~~~~~~

export VER=12

export SFX=vs${VER}

/path/to//bilder/setinstald.sh -i /winsame/contrib-$SFX qt,sersh

cd /winsame/contrib-$SFX

ln -s qt-5.6.1-sersh qt-sersh

mkshortcut -n qt-sersh qt-5.6.1-sersh

~~~~~~

# Experimental Tools and Libraries

These tools have not been fully vetted or built, so you need not do these.

## MinGW

See [[Installing MinGW]].

## ATLAS

See [[Installing ATLAS on Windows]].

# Cygwin and Paths

(This section assumes the user is familiar with the relations between Cygwin and Windows paths.)

The path is critical for when there are conflicting executables.  This is the case for Subversion and OpenSSL.

The cygwin and Windows versions of svn are incompatible due to line endings, so care must be taken as to which is used at what time.

The path to cygwin's version of svn will be ahead of the Windows Subversion so as to allow users to checkout a project using /usr/bin/svn and never worry about the Windows version of svn.

The path to the installed OpenSSL needs to be in front of the path to Subversion because during the copying in of OpenSSL libraries depends needs to find the ones in the OpenSSL installation not the Subversion installation.

## Usage under Jenkins

Jenkins uses `svnkit`, which is compatible with the Windows version of Subversion of the same version number.  So for jenkins usage, one must have the same version of `svn` installed across all slaves, and when `Bilder` runs under Jenkins, it must be sure to use the Windows version of `svn`.  There are two methods for doing this.  First, `bilder/jenkins/jenkinsbild` defines the environment variables, `BILDER_SVN`, `BILDER_SVNDIR`, and `BLDR_SVNVERSION`, which hold the correct executables to be used by `Bilder`.  However, in the configuration of some packages, notably VisIT in `visit.sh`, the path is used to find `svn`, and this gives the wrong executable.  For these cases, the path is modified just before configuration.

## Summary

* Bilder moves `/usr/bin` to just after the Python path and therefore to before

  `/cygdrive/c/Windows/system32`.

* Put the Windows Subversion path behind the Python path (and so behind `/usr/bin`).

    - `/usr/bin` must be removed from the path when configuring some packages in order to get the correct subversion when building under Jenkins.

# Bilder machine files for cygwin

The Bilder machine file for cygwin and Visual Studio 2013 (VS12) is bilder/machines/cygwin.vs12. It is sourced by bilder using the -m option. It augments PATH and sets the values of the INCLUDE, LIB, and LIBPATH variables.

In case of problems, one should check that the values of these were set correctly. This is done by starting up the **Visual Studio Command Prompt**, then starting rxvt as noted above. The values for or additions to these variables should agree with how they are being set or modified by the cygwin machine files.

# Setup for making Installers

## Visual Studios Redistributables

Download vcredist_x64.exe (Visual C++ Redistributable Packages for Visual Studio 2013)

http://www.microsoft.com/en-gb/download/details.aspx?id=40784

Choose only vcredist_x64.exe executable from list. Put executable in C:\bin.

## Sign Tools

* The Microsoft Signtool comes with Visual Studio, however, one must install a code-signing certificate. This process is site-specific so please see your system administrator.

* Contrary to what signtool says, the capicom dll must be copied from C:\Program Files\Microsoft SDKs\Windows\v6.0A\bin to C:\Windows\System32 and must be registered by typing the following at a Command Prompt run as Administrator: 

~~~~~~

cd C:\Windows\System32

REGSVR32 capicom.dll

~~~~~~

# Notes For Development

[[Notes on debugging Windows executables]]

[[Notes on deleting directories and files owned by other users]]