Quick Guide to Building On Windows

This step-by-step quick-start guide was written in March of 2008, running Windows XP Service Pack 2 with all the latest updates and building PHP 5.2.5 and PHP 5.3. Experiences using different tools may differ.

1. Download and install:

   • » Microsoft Visual C++ 2008 Express Edition
   • » Windows SDK for Windows Server 2008 and .NET Framework 3.5
2. Copy C:\Program Files\Microsoft SDKs\Windows\v6.1\Include\WinResrc.h to C:\Program Files\Microsoft SDKs\Windows\v6.1\Include\winres.h.
3. Create the directory C:\work.
4. Download » the Windows build tools and unzip the contents into C:\work.
5. Create the directory C:\usr\local\lib. Copy the C:\work\win32build\bin\bison.simple into the new directory.
6. Download » the Windows DNS resolver library and unzip the contents into C:\work.
7. Open C:\work\bindlib_w32\bindlib.dsw. If and when asked whether to update the project, choose Yes. Choose either Debug or Release configuration in the top toolbar, then choose Build => Build Solution.
8. Obtain a copy of the PHP source and extract it into the C:\work directory. At this point, that directory should look something like this:

   +-C:\work
   | +-bindlib_w32
   | | +-Debug
   | | | +-resolv.lib
   | | | +-...
   | | +-...
   | +-win32build
   | | +-bin
   | | +-include
   | | +-lib
   | +-php-5.2.5
   | | +-build
   | | +-win32
   | | +-...

9. Open a shell using the Visual Studio 2008 Command Prompt shortcut in the Start menu.
10. Execute the command:

    C:\Program Files\Microsoft Visual Studio 9.0\VC> set "PATH=C:\work\win32build\bin;%PATH%"
    C:\Program Files\Microsoft Visual Studio 9.0\VC>

11. Enter the C:\work\php-5.2.5 directory.
12. Run cscript /nologo win32\build\buildconf.js.
13. Run cscript /nologo configure.js --disable-all --enable-cli --enable-cgi --enable-object-out-dir=.. --disable-ipv6. To enable debugging, add --enable-debug to the end.
14. Run nmake.
15. If all went well, there will now be a working PHP CLI executable at C:\work\Debug_TS\php.exe, or C:\work\Release_TS\php.exe.

Build Environment

To compile and build PHP you need a Microsoft Development Environment. The following environments are supported:

• Microsoft Visual C++ 6.0 (official)
• Microsoft Visual C++ .NET
• Microsoft Visual C++ 2005, Windows Platform SDK and .NET Framework SDK (current)

While VC6 (Microsoft Visual C++ 6.0) is used to perform official Windows builds, it can no longer be downloaded from Microsoft's website. New users seeking to build PHP for free must use Microsoft Visual C++ 2005 Express Edition and its auxiliary components.

Libraries

To extract the downloaded files you will also need a ZIP extraction utility. Windows XP and newer already include this functionality built-in.

Before you get started, you have to download:

• the win32 buildtools from the PHP site at » http://www.php.net/extra/win32build.zip.
• the source code for the DNS name resolver used by PHP from » http://www.php.net/extra/bindlib_w32.zip. This is a replacement for the resolv.lib library included in win32build.zip.
• If you plan to compile PHP as a Apache module you will also need the » Apache sources.

Finally, you are going to need the source to PHP itself. You can get the latest development version using » anonymous CVS, a » snapshot or the most recent released » source tarball.

Putting it all together

After downloading the required packages you have to extract them in a proper place:

• Create a working directory where all files end up after extracting, e.g: C:\work.
• Create the directory win32build under your working directory (C:\work) and unzip win32build.zip into it.
• Create the directory bindlib_w32 under your working directory (C:\work) and unzip bindlib_w32.zip into it.
• Extract the downloaded PHP source code into your working directory (C:\work).
• Build the libraries you are going to need (or download the binaries if available) and place the headers and libs in the C:\work\win32build\include and C:\work\win32build\lib directories, respectively.
• If you don't have cygwin installed with bison and flex, you also need to make the C:\work\win32build\bin directory available in the PATH, so that thoses tools can be found by the configure script.

+--C:\work
|  |
|  +--bindlib_w32
|  |  |
|  |  +--arpa
|  |  |
|  |  +--conf
|  |  |
|  |  +--...
|  |
|  +--php-5.x.x
|  |  |
|  |  +--build
|  |  |
|  |  +--...
|  |  |
|  |  +--win32
|  |  |
|  |  +--...
|  |
|  +--win32build
|  |  |
|  |  +--bin
|  |  |
|  |  +--include
|  |  |
|  |  +--lib

   

If you aren't using » Cygwin, you must also create the directories C:\usr\local\lib and then copy bison.simple from C:\work\win32build\bin to C:\usr\local\lib.

Note: If you want to use PEAR and the comfortable command line installer, the CLI-SAPI is mandatory. For more information about PEAR and the installer read the documentation at the » PEAR website.

Build resolv.lib

You must build the resolv.lib library. Decide whether you want to have debug symbols available (bindlib - Win32 Debug) or not (bindlib - Win32 Release), but please remember the choice you made, because the debug build will only link with PHP when it is also built in debug mode. Build the appropriate configuration:

• For GUI users, launch VC++, by double-clicking in C:\work\bindlib_w32\bindlib.dsw. Then select Build=>Rebuild All.
• For command line users, make sure that you either have the C++ environment variables registered, or have run vcvars.bat, and then execute one of the following commands:
  • msdev bindlib.dsp /MAKE "bindlib - Win32 Debug"
  • msdev bindlib.dsp /MAKE "bindlib - Win32 Release"

Building PHP using the new build system [PHP >=5 only]

This chapter explains how to compile PHP >=5 using the new build system, which is CLI-based and very similar with the main PHP's Unix build system.

Note: This build system isn't available in PHP 4. Please refer to Building from source instead.

Before starting, be sure you have read Building from source and you have built all needed libraries, like » Libxml or » ICU (needed for PHP >= 6).

First you should open a Visual Studio Command Prompt, which should be available under the Start menu. A regular Command Prompt window shouldn't work, as probably it doesn't have the necessary environment variables set. Then type something like cd C:\work\php-5.x.x to enter in the PHP source dir. Now you are ready to start configuring PHP.

The second step is running the buildconf batch file to make the configure script, by scanning the folder for config.w32 files. By default this command will also search in the following directories: pecl; ..\pecl; pecl\rpc; ..\pecl\rpc. Since PHP 5.1.0, you can change this behaviour by using the --add-modules-dir argument (e.g. cscript /nologo win32/build/buildconf.js --add-modules-dir=../php-gtk2 --add-modules-dir=../pecl).

The third step is configuring. To view the list of the available configuration options type cscript /nologo configure.js --help. After choosing the options that you will enable/disable, type something like: cscript /nologo configure.js --disable-foo --enable-fun-ext. Using --enable-foo=shared will attempt to build the 'foo' extension as a shared, dynamically loadable module.

The last step is compiling. To achieve this just issue the command nmake. The generated files (e.g. .exe and .dll) will be placed in either Release_TS or Debug_TS directories (if built with Thread safety), or in the Release or Debug directories otherwise.

Optionally you may also run PHP's test suite, by typing nmake test. If you want to run just a specific test, you may use the 'TESTS' variable (e.g. nmake /D TESTS=ext/sqlite/tests test - will only run sqlite's tests). To delete the files that were created during the compilation, you can use the nmake clean command.

A very useful configure option to build snapshots is --enable-snapshot-build, which add a new compiling mode (nmake build-snap). This tries to build every extension available (as shared, by default), but it will ignore build errors in individual extensions or SAPI.

Building PHP using DSW files [PHP 4]

Compiling PHP using the DSW files isn't supported as of PHP 5, as a much more flexible system was made available. Anyway, you can still use them, but keep in mind that they are not maintained very often, so you can have compiling problems. To compile PHP 4 for windows, this is the only available way though.