Windows Compilation

Compiling OSRM on Windows is not straight forward right now. This steps lead us to a correct OSRM compilation and running over Windows 7, but cannot warrantee you anything.

Use always a 64bit version, because 32bit versions will lack of RAM too easily and throw weird errors.

Prerequisites

• x64 Windows machine
• Microsoft Visual Studio 2008 Professional Edition with x64 compiler installed or Microsoft Visual Studio 2008 Express Edition (only from x32 builds)

Compilation Steps

vsprojects[\x64]\Release mean vsprojects\Release or vsprojects\x64\Release depending on choosen platform

1. Download and extract the content DennisOSRM-Project-OSRM-v0.3b-0-gcaf9086.tar.gz to a folder in computer (Ex: C:\Osrm)
2. Create a folder named lib in OSRM folder (Ex: C:\Osrm\lib)

Compling boost library

Download and extract the content of boost_1_49_0.zip to boost dir from lib (Ex: C:\Osrm\lib\boost)

• For x32 run in boost dir from a cmd prompt:
  

  C:\Osrm\lib\boost>bootstratp
  
  C:\Osrm\lib\boost>b2 —build-type=complete
  
  

• For x64 run in boost dir from a cmd prompt:
  

  C:\Osrm\lib\boost>boostrap
  
  C:\Osrm\lib\boost>bjam —toolset=msvc-9.0 address-model=64 —build-type=complete stage
  
  

This compilation will take a long time to finish and will add another 5-7 GB of data to boost folder.

Compiling bzip2 library

1. Download and extract the content of bzip2-1.0.6.tar.gz to bzip2 dir from lib (Ex: C:\Osrm\lib\bzip2)
   • For x32 just open libbz2.dsp and convert to libbz2.sln and build using release version.
   • For x64 open libbz2.dsp and convert to libbz2.sln and choose a new configuration based on release version of x32 but at target processor choose x64
     (“Build” menu → “Configuration Manager”: “Active solutions configuration” → “Release” and “Active solution platform” → “New” → “Type or select the new platform” → “x64” also “Copy settings from” → “Win32”, check “Create new project platforms”).
2. After rebuilding create three folders in bzip2 dir named bin, lib and include
3. Copy libbz2.dll from bzip2 folder in bzip2\bin
4. Copy libbz.lib from bzip2\Release folder in bzip2\lib
5. Copy bzlib.h from bzip2 folder in bzip2\include

Compiling protobuf library

1. Download and extract the content of protobuf-2.4.1.zip to protobuf folder from lib (Ex: C:\Osrm\lib\protobuf)
   • For x32 just open protobuf.sln from vsprojects and build using release version.
     Build and after fail (will fail for sure) download protoc-2.4.1-win32.zip and copy protoc.exe in vsprojects\Release, rebuild the project (now you will have some fails but the library is compiled).
   • For x64 open protobuf.sln from vsprojects and choose a new configuration based on release version of x32 but at target processor choose x64
     (“Build” menu → “Configuration Manager”: “Active solutions configuration” → “Release” and “Active solution platform” → “New” → “Type or select the new platform” → “x64” also “Copy settings from” → “Win32”, check “Create new project platforms”).
     Rebuild and after fail (will fail for sure) download protoc-2.4.1-win32.zip and copy protoc.exe in vsprojects[\x64]\Release and rebuild the project (now you will have some fails but the library is compiled).
2. After second rebuild run extract_includes.bat from vsprojects folder (this will create the include folder in vsprojects).
3. Make three folders in protobuf named bin, lib and include.
4. Copy protoc.exe from protobuf\vsprojects[\x64]\Release to protobuf\bin.
5. Copy the content of include folder from protobuf\vsprojects\include to protobuf\include.
6. Copy *.lib from protobuf\vsprojects[\x64]\Release in protobuf\lib.

Compiling sparsehash library

1. Download and extract the content of sparsehash-2.0.2.zip to sparsehash folder from lib (Ex: C:\Osrm\lib\sparsehash).
   • For x32 just open sparsehash.sln and rebuild using release version.
   • For x64 open sparsehash.sln and choose a new configuration based on release version of x32 but at target processor choose x64
     (“Build” menu → “Configuration Manager”: “Active solutions configuration” → “Release” and “Active solution platform” → “New” → “Type or select the new platform” → “x64” also “Copy settings from” → “Win32”, check “Create new project platforms”)
2. Rebuild solution.

Compiling stxxl library

1. Download and extract the content of stxxl-1.3.1.zip to stxxl folder from lib (Ex: C:\Osrm\lib\stxxl)
2. Create a file named make.settings.local in stxxl folder with folowing content:
   

   BOOST_ROOT = “$(TOPDIR)\..\boost”#

3. Add
   

   /LIBPATH:$(BOOST_ROOT)\stage\lib\

   in make.settings.msvc between /LIBPATH:$(BOOST_ROOT)\lib\ and /STACK:16777216 /NOLOGO (line 68) so this line become

   /LIBPATH:$(BOOST_ROOT)\lib\ /LIBPATH:$(BOOST_ROOT)\stage\lib\ /STACK:16777216 /NOLOGO

4. If you compile for debug you need to add

   DEBUG_COMPILER=/MDd /Zi 

   and

   DEBUG_LINKER=/DEBUG

   to make.settings.local
5. Compile
   • For x32 just open stxxl.sln and rebuild using “Library”
   • For x64 open stxxl.sln and choose a new configuration based on x32 Library but at target processor choose x64
     (“Build” menu → “Configuration Manager”: “Active solutions configuration” → “Library” and “Active solution platform” → “New” → “Type or select the new platform” → “x64” also “Copy settings from” → “Win32”, check “Create new project platforms”)
6. Rebuild solution.

Compiling zlib library

Download and extract the content of zlib-1.2.7.tar.gz to zlib folder from lib (Ex: C:\Osrm\lib\zlib).

For x32

1. Download and install masm32
2. Open a cmd promt and go to zlib\contrib\masmx86 folder.
3. Add C:\masm32\bin to path:

   C:\Osrm\lib\zlib\contrib\masmx86\>SET path=C:\masm32\bin;%path%

4. Run bld_ml32.bat from zlib\contrib\masmx86 folder.
5. Go to root zlib folder and run:

   C:\Osrm\lib\zlib\>"C:\Program Files\Microsoft Visual Studio 9.0\VC\vcpackages\vcbuild.exe" /rebuild contrib\vstudio\vc9\zlibvc.sln “Release|Win32”

6. Create thre folders in zlib named bin, lib and include.
7. Copy zlib\contrib\vstudio\vc9\x86\ZlibDllRelease\zlibwapi.dll to zlib\bin\zlib.dll.
8. Copy zlib\zconf.h to zlib\include\zconf.h
9. Copy zlib\zlib.h to zlib\inc\zlib.h
10. Copy zlib\contrib\vstudio\vc9\x86\ZlibDllRelease\zlibwapi.lib to zlib\lib\zlib.lib

For x64

1. Open a cmd promt and go to zlib\contrib\masmx64 folder.
2. Add C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\bin\x86_amd64 to path

   C:\Osrm\lib\zlib\contrib\masmx64\>SET path=C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\bin\x86_amd64;%path%

3. Run bld_ml64.bat from zlib\contrib\masmx64 folder.
4. Open zlibvc.sln from zlib\contrib\vstudio\vc9 folder and choose a Release version with 64 bits from build → configuration manager.
5. Rebuid the solution.
6. Create thre folders in zlib named bin, lib and include.
7. Copy zlib\contrib\vstudio\vc9\x64\ZlibDllRelease\zlibwapi.dll to zlib\bin\zlibwapi.dll.
8. Copy zlib\zconf.h to zlib\include\zconf.h.
9. copy zlib\zlib.h to zlib\inc\zlib.h.
10. Copy zlib\contrib\vstudio\vc9\x64\ZlibDllRelease\zlibwapi.lib to zlib\lib\zlib.lib.

libxml2

Create libxml2 folder (Ex: C:\Osrm\lib\libxml2)

For x64

Look for a precompiled version of libxml2 (libxml2_x64.zip from project files) for x64 (usually from a x64 apache install), download the dll and extract the exported symbols to a def file (look at http://www.coderetard.com/2009/01/21/generate-a-lib-from-a-dll-with-visual-studio/ for more info).
For lib program use /machine:x64 option.

For x32

For x32 you will find precompiled library (file libxml2-2.7.8.win32.zip).

1. Download the libxml2-2.7.8.win32.zip file.
2. Make a folder named libxml2 and make in this three new subfolders named bin, lib and include.
3. Copy in libxml2\bin the downloaded dll (libxml2.dll)
4. Copy in libxml2\lib the created import library (libxml2.lib)
5. Copy in libxml2\include the libxml folder from libxml2-2.7.8.win32.zip\include

libiconv

Download and extract the libiconv-1.14.tar.gz to libiconv folder from lib (Ex: C:\Osrm\lib\libiconv).
Use http://www.codeproject.com/Articles/302012/How-to-Build-libiconv-with-Microsoft-Visual-Studio as a guide for building a project for iconv (libiconv_vcproject.zip from project files).

For x64

1. Open libiconv.sln from libiconv\libiconv folder and choose a new configuration based on release version of x32 but at target processor choose x64
   (“Build” menu → “Configuration Manager”: “Active solutions configuration” → “Release” and “Active solution platform” → “New” → “Type or select the new platform” → “x64” also “Copy settings from” → “Win32”, check “Create new project platforms”).
2. After rebuild create a folder named iconv in lib (Ex: C:\Osrm\lib\iconv).
3. Create three new folders in iconv named bin, lib and include.
4. Copy libiconv.dll from libiconv\libiconv\x64\Release to iconv\bin.
5. Copy libiconv.lib from libiconv\libiconv\x64\Release to iconv\lib.
6. Copy content of libiconv\libiconv\include in iconv\include.

For x32

You can find precompiled version of the lib (libiconv-1.9.2-1-bin.zip and libiconv-1.9.2-1-lib.zip).

Compile OSRM

Edit osrm.vsprops from c:\Osrm\vcprojects adjusting paths to indicate the folders from lib dir

For x64

1. Open osrm.sln from Osrm\vcprojects and choose a new configuration based on release version of x32 but at target processor choose x64
   (“Build” menu → “Configuration Manager”: “Active solutions configuration” → “Release” and “Active solution platform” → “New” → “Type or select the new platform” → “x64” also “Copy settings from” → “Win32”, check “Create new project platforms”)
   Rebuild solution.

For x32 and x64

Build of createHierachy.exe

1. Modify Osrm\DataStructures\NNGrid.h and add
   

   #undef min
   
   #undef max

   before line 51 static const unsigned MAX_CACHE_ELEMENTS = 1000;
2. Modify Osrm\typedefs.h and comment line 51:
   

   #define DELETE do { if(NULL != x) { delete x; x = NULL; } }while(0);

3. Modify Osrm\routed.cpp line 134 and replace DELETE(s); with
   

   do { if(NULL != s) { delete s; s = NULL; } }while(0);

   and DELETE(objects); from line 135 with
   

   do { if(NULL != objects) { delete objects; objects = NULL; } }while(0);

4. Modify Osrm\createHierarchy.cpp and Replace DELETE(edgeBasedGraphFactory); on line 143 with
   

   do { if(NULL != edgeBasedGraphFactory) { delete edgeBasedGraphFactory; edgeBasedGraphFactory = NULL; } }while(0);

   and DELETE( writeableGrid ); from line 148 with

   do { if(NULL != writeableGrid) { delete writeableGrid; writeableGrid = NULL; } }while(0);

   and DELETE( cleanup ); from line 178 with

   do { if(NULL != cleanup) { delete cleanup; cleanup = NULL; } }while(0);

5. Comment or delete typename from Osrm\Contractor\EdgeBasedGraphFactory.cpp line 42

   for ( /typename/ std::vector< NodeBasedEdge >::const_iterator i = …

6. In Osrm\Contractor\EdgeBasedGraphFactory.cpp change line 105 from

   while(restrictionIterator→fromNode < u && inputRestrictions.end() != restrictionIterator) {

   to

   while(inputRestrictions.end() != restrictionIterator && restrictionIterator→fromNode < u) {

   line 117 from

   if(u == restrictionIterator→fromNode) {

   to

   if(inputRestrictions.end() != restrictionIterator && u == restrictionIterator→fromNode) {

   line 120 from

   if(v == secondRestrictionIterator→viaNode && w == secondRestrictionIterator→toNode) {

   to

   if(inputRestrictions.end() != secondRestrictionIterator && v == secondRestrictionIterator→viaNode && w == secondRestrictionIterator→toNode) {

   and line 124 from

   } while(u == secondRestrictionIterator→fromNode);

   to

   } while(inputRestrictions.end() != secondRestrictionIterator && u == secondRestrictionIterator→fromNode);

7. Remove inline definition of gettimeofday from Osrm\DataStructures\Util.h line 36 adding this function in a new file named Util.cpp in the same folder

   void gettimeofday(struct timeval* t,void* timezone);

   in header and

   #include “Util.h”
   
   void gettimeofday(struct timeval* t,void* timezone)
   
   {       
   
   	struct _timeb timebuffer;
   
   	ftime( &timebuffer );
   
   	t→tv_sec=timebuffer.time;
   
   	t→tvusec=1000*timebuffer.millitm;
   
   } 

   
   in cpp.
8. Add Osrm\DataStructures\Util.cpp and Osrm\Contractor\EdgeBasedGraphFactory.cpp to project (add existing file)
9. Add $(BoostPath)\stage\lib in project properties → linker → General → Additional library directories.
10. Rebuild project.

Build of extractor.exe

1. Add DataStructures\Util.cpp to project.
2. Add $(BoostPath)\stage\lib in Project properties → Linker → General → Additional library directories
3. Rebuild project.

Build of routed.exe

1. Replace

   DELETE;

   from Osrm\Server\RequestHandler.h line 47 with

   do { if(NULL != tempPointer) { delete tempPointer; tempPointer = NULL; } }while(0);

2. Replace

   DELETE;

   from Osrm\Plugins\ViaRoutePlugin.h line 68 with

   do { if(NULL != searchEngine) { delete searchEngine; searchEngine = NULL; } }while(0);

   and

   DELETE;

   from line 268 with

   do { if(NULL != desc) { delete desc; desc = NULL; } }while(0);

3. Add Osrm\Descriptors\DescriptionFactory.cpp to project.
4. Add $(BoostPath)\stage\lib in Project properties → Linker → General → Additional library directories.
5. Rebuild project.

Final steps

1. Copy libxml2.dll from Osrm\lib\libxml2\bin to exe folder (Osrm\vcprojects\x64\Release).
2. Copy zlibwapi.dll from Osrm\lib\zlib\bin to exe folder (Osrm\vcprojects\x64\Release).
3. Change server.ini from Osrm\vcprojects\x64\Release folder to indicate at correct files.
4. Modify Osrm\Docs\WebFrontend\Route.js line 32 to use local server for test.

On server you will need to install Microsoft Visual C++ 2008 Redistributable SP1 (vcredist_x64.exe from project files)

Acknowledgements.

Kudos to pixecs, who did a great job.
Kudos to Emergya for supporting this build.