Build Chromium in Windows using Visual Studio 2010

2012-03-03T08:36:00.017-08:00

This is the second post in a series of "Browser development" articles. In this one, I will outline the basic steps necessary to get a working build of the open source Chromium browser (known as Google Chrome) on Windows. For details about building and debugging Firefox, head over to Debugging Firefox in Windows with VS2010.

First, you will need the prerequisites. Chromium will require a hefty amount of "juice" from your hardware. The minimum required RAM is 8GB, but more is better. Here are a few "build environment" recommendations:

1. Get a "true" multicore PC, such as one having an Intel "Core" series processor (i7 would be great :))

2. Have at least 8GB RAM. I've seen people talking about still needing more, as much as 16GB!

3. Better if you build on a separate HDD than your Windows installation. YES, THAT MEANS ON A DIFFERENT PHYSICAL DISK, NOT A DIFFERENT PARTITION.

4. Disable your Anti-virus, or at least, pause it.

Now on to the actual build process. We start by downloading a few stuff that are mandatory:

1. Like Mozilla's MozillaBuild, Chrome developers have also made a custom set of tools that basically does the pre-build processing of the source tree. So you need to download the depot_tools.

2. Download and install VS2010SP1.

3. Download and install Windows7.1SDK.

4. Download and install the DirectX SDK.

Assuming that the above steps went smoothly, lets move on to the real deal. We will be building Chromium from a tarball download, rather than an SVN checkout.

1. Download the latest Chromium tarball from here: Chromium Source tarball.

2. Extract the source using a zip utility, such as 7-zip to a folder of your choice (e.g., C:\chromium). CAUTION: you need ample free space, the extraction takes about 4.5 GB.

3. Assuming you have extracted the depot_tools downloaded earlier to: C:\depot_tools, set the PATH environment variable of Windows (Start Menu>Computer>Properties>Advanced System Settings>Advanced>Environment Variables>System Variables>PATH>Edit). Append this line to the end of your path: "C:\depot_tools\". You may need to restart your computer for updating the PATH.

4. Open command prompt. Type echo %USERPROFILE%. Head over to the folder and create a .gyp folder there (note the beginning dot). Windows will not let you build a folder with a beginning dot. So, from command prompt, cd to the %USERPROFILE% folder and type: mkdir .gyp. In the .gyp folder, create a blank text file and name it include.gypi.

5. Paste these following lines to include.gypi:

{
'variables': {
'msbuild_toolset': 'Windows7.1SDK',

'chromium_win_pch': 1,

'component': 'shared_library',

},
}

6. In command prompt, type: echo %LOCALAPPDATA%. Head over to the folder. You will see two files: Microsoft.Cpp.Win32.user.props and Microsoft.Cpp.x64.user.props. Open notepad (or any text editor) in "administrator mode". Then edit these two files by appending these lines in the <Project> node :

<PropertyGroup> $(DXSDK_DIR)\include;$(IncludePath) $(DXSDK_DIR)\lib\x86;$(LibraryPath)

</PropertyGroup>

7. From the command prompt, go to the Chromium source directory where you extracted the source files. cd to the src directory (e.g., ~\chromium\src). Run the following commands:

a) set GYP_MSVS_VERSION=2010

b) gclient sync --force

c) gclient runhooks --force

You should now have a chrome.sln (visual studio solution file) in the chrome\ folder of the source tree.

1. Open the sln file in VS2010.

2. IMPORTANT: set the maximum number of parallel builds (tools>options>projects and solutions>build and run>maximum number of parallel builds) to this value NUMBER_OF_CORES_OF_YOUR_PROCESSOR-1 (this is not a hard rule, btw). This is supposed to speed up the build process.

3. Build Chromium from VS2010. Build times will vary, but will mostly be anything from 30 mins (really fast PC) to 2.5hrs.

4. Test/debug your build from VS2010.

Debugging Firefox in Windows with VS2010

2012-01-09T10:34:00.000-08:00

Download and Make a Debug Build

1. Download Mozilla source from http://hg.mozilla.org/mozilla-central/ (choose files, then click on zip). Alternatively, you can follow the instructions at https://developer.mozilla.org/en/Download_Mozilla_Source_Code which leads to Mozilla's FTP server ftp://ftp.mozilla.org/pub/mozilla.org/firefox/releases/9.0/source/ . (first link is nightly build, second is release build).

2. Extract the source code. 7-zip works best. (e.g. to C:\FFBuild\mozilla-release).

3. Download and install DirectX SDK 10. https://developer.mozilla.org/En/Developer_Guide/Build_Instructions/Windows_Prerequisites#Microsoft_DirectX.C2.A0SDK

4. Download and install MozillaBuild.

https://developer.mozilla.org/En/Developer_Guide/Build_Instructions/Windows_Prerequisites#MozillaBuild_.2F_Pymake

5. If you have VS2010 it comes bundled with Windows SDK. No worries here.

6. Create a .mozconfig file in the root directory of the source code (mozilla-central or mozilla-release). This file will contain the build configuration for the source. For our purposes, we have to do the "debug" build. I followed the .mozconfig from https://developer.mozilla.org/en/Configuring_Build_Options#Firefox.2C_Debugging_Build . (Note: windows won't allow creating .mozconfig file, so create a text file new.txt, go to cmd, and from cmd rename the file to .mozconfig like this: a) cd to root dir of source code, b) rename new.txt .mozconfig).

7. For windows, use of pymake instead of make is advocated here https://developer.mozilla.org/en/pymake . Follow those instructions to start the build (might take upto 2 hours). (Note: to make builds faster, edit this line in the .mozconfig file : mk_add_options MOZ_MAKE_FLAGS="-jN", edit N to be twice the number of your processor cores. For example, for a 4 core processor, replace N with 8).

Debugging in Visual Studio

8. If the build is successful, there should be a firefox.exe at [mozilla-source]\ff-dbg\dist\bin . Test it to see if it works.

9. Start VS2010. Go to File>Open>Project/Solution>[mozilla-source]\ff-dbg\dist\bin\firefox.exe .

10. Right click on firefox.exe in the Solution Explorer and go to Properties. Edit Environment Variable to add MOZ_NO_REMOTE=1. (https://cs.senecac.on.ca/~david.humphrey/writing/debugging-firefox.html ).

11. Open any file from the source code directory (CAUTION: NOT FROM THE ff-dbg DIRECTORY). Set a debug point. For example: line 143 of [mozilla-source]\caps\src\nScriptSecurityManager.cpp.

12. Right click on firefox.exe and Debug>Start New Instance.

Anton's Tech Blog

Build Chromium in Windows using Visual Studio 2010

Debugging Firefox in Windows with VS2010