Distcc With MSVC

From CDOT Wiki
Revision as of 12:50, 29 May 2007 by David.humphrey (talk | contribs) (Added link for compiler porters)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Project Name

distcc, distributed compilations for C/C++ compilers.

Project Description

The goal of this project is to speed up Windows Mozilla Builds by spreading object compilations over several machines. This can be done by using an open source product called distcc created by Martin Pool. Unfortunately this is only available on *nix machines using gcc. Our project involves porting this software to Windows and use Microsoft's Visual C++ compiler using cygwin and msys.

Project Leader(s)

Project Contributor(s)

We have stuff for you to do!

  • Dave Liebreich - Thanks for checkin whether cygwin's ln will create working links to cl.exe (e.g. a link name clfoo.exe to cl.exe).
  • Ben Hearsum - for the windows box and support! Thank you!
  • Jason Spiro - For helping figure out why cl wouldn't execute in the unit testing framework and assisting in finding the right path to solve this issue.
  • Phil - helped with changing the page on helping people do research into cl options for us.
  • Moe
  • Mark P. (aka RealMarkP)
  • David Humphrey
  • Jeff
  • Melz

Product Documentation

The project has been focused on getting distcc to work with Mozilla, mainly because Mozilla uses GNU Makefiles which can run concurrent jobs. We have started a tutorial in order to help testers/developers. We have also written documentation for others who might wish to add support to distcc for other compilers (e.g., Java, C#, etc.).

Current Status

  • Some of the Test Cases may be incorrect. Neither Tom nor Cesar have extensive experience in CL options. So it may not distribute when it should, or it may distribute when it shouldn't.

What's still to do

Task Priority Status
Fix documentation, including website, manpage, and tutorials Medium Neglected. I think Tom has worked on the man page, Cesar has worked on the tutorial
  • find a suitable replacement for fork()
    • using windows threads. Need to use #ifdef directives to switch between unix fork and threads. But perhaps where is a better way to do this.
    • Perhaps talk to Martian Pool to see if he has any ideas? He hasn't been in the mailing list for a while.
High Have not started
  • Send .pdb files to allow debug builds. Currently blocking mozilla from ever using distcc.
    • looking at the protocol. Hopefully we don't have to changed a lot.
High Have not started
  • Port distcc to use mingw
    • Properly link in winsock library (fixed using libtool)
    • use windows threads (another high priority item)
    • locate and replace unix functionality that existed in cygwin, but doesn't exist in mingw.
High Have only got libtool to compile a simple sockets program. We have now port it to distcc
  • probably use #ifdef MINGW ... #else ... #endif in source files that use socket.h
  • another possibility is to have one header file handle this, and the source files include that header file
Find more applications that use the Makefile system and can use CL Medium Difficult to find. Not many open source applications use Makefile and MSVC, many choosing to opt for NMake
Compile NSPR using distcc Medium Dave suggested only building NSPR because its smaller and won't take as long to compile. Cesar is responsible for this
boy there sure are lot of memory leaks... would be nice to fix that Low We can use tools like valgrind and mtrace to help. Or we can use Boehm-GC to free the memory automatically. But this is a lot of work for such low priority.
Make sure that there are no orphan distcc processes left after make maintainer-check Low This is a problem when tests are killed, and can leave to false-negatives when you try to rerun the tests again. But that can be fixed with god ol' kill-y mc. kill, agent 009

How to get distcc to compile use cl

Tom and Cesar created this patch keeping backwards compatibility in mind. You should be able to still use distcc to compile your c programs if you wish. But if you applied the patch, you probably want to do more than that.

Firstly, the environment variables for distributing with cl is different. DISTCC_HOSTS is still valid for gcc, but cl will be looking for DISCC_CL_HOSTS instead. In fact, that is the only thing it looks for. Unlike gcc, cl will not look for ~/.distcc directory. This might be implemented later on.

Secondly, masquerade mode works only for gcc. If you want want to use cl, you must explicitly say so (distcc cl hello.c). If you are using gnu make, you must also explictly tell it to use cl as well (eg using CC, CXX, etc).


NOTE :: If you run the checks, please check your processes (ps aux, or the task manager) for leaked distcc/distccd programs. We will fix this ASAP

You may ignore this section if you installed Microsoft's CL in the default C:\ directory and your tests work fine.

In order to properly run the tests, you may need to make a few changes. The PATH variable is reinitalized when the test cases are run. Normally, the tests will fail when they try the cl tests. This is because PATH does not look for the cl executable and the libraries. Tom and Cesar have made certain assemptions when extending the include path, and included these following paths :

/cygdrive/c/Program Files/Microsoft Visual Studio 8/VC/bin
/cygdrive/c/Program Files/Microsoft Visual Studio 8/Common7/IDE

If it is different for your machine, you need to find these in the Makefile.in or Makefile and change them to your settings.

Extending the program

This will be postponed until we get distcc working properly (not fully) with cl.

Project Details

Mozilla (and others :) ) is interested in speeding up their builds by using a distributed compiler (distcc). The problem is that distcc only works with gcc but not with the msvc compiler (cl).

The plan has two stages:

  1. change distcc to support multiple compilers
  2. add cl support

Initially, we planned to use two vtables (one for distcc and another for distccd) to keep track of which compiler specific operation to use when. However that bombed out so we're currently using a single vtable.

We have kept the two vtable branch because we actually got a lot of the cl specific stuff done (before we realized we missed some functions).

Help Us Out

Here's what you can do to help us out...:

The First Patch (Oops)

This was released to the distcc mailing list. This has a few functions missing. It was meant to provide the two vtable support without cl. It should be ignored and we'll be re-releasing a working version of this soon.

Project News

See what's up with this project! Older news can be found here

May 1, 2007

I've been doing a lot of #ifdef conditions, just to get it to compile (although we will be doing windows threads instead of fork, this is just a step). But now I'm stuck on the function fcntl(). It's a POSIX function, and it has POSIX flags, but some of the flags don't seem to exist in Windows. I don't have enough information to know how important the function is, and if we can just skip it.

And I forgot my power cable in a certain building, and laptop is running out of battery!

April 30, 2007

There are some header files in distcc that have the same name as some of the standard header files in /usr/include. One file is rpc.h, which is being #included by "sockets.h". Since we don't need sockets.h, this shouldn't be a problem in this case. But that is still something we have to watch out for.

Bah! windows.h #includes rpc.h, dammit.

Resource : Microsofts Unix migration guide

April 28, 2007

PDB files :

vc80.pdb - source file debug symbols
project.pdb - project debug symbols
vc80.pdb can be overwritten by/Fddebug

Link between source.c[pp] and debug is hard coded in the object file. You can find it by running the strings command on the object file (Thanks shaver!).

Leaving debug symbols aside. We should probably start porting distcc to mingw and replacing incompatible functions. Since that would be more time consuming and more difficult to get right.

April 23, 2007

Semester is over. Because I honestly have no life, and there is work to do here, I started mapping out the distcc protocol, so we can start making any changes, if necessary. It was a wasted afternoon because the protocol is already documented in the trunk, under docs directory (who would have guessed?)

Preliminary examination indicates that this won't be so much work. The functions seem to already be there.

March 19, 2007

There was a subtle bug in Mozilla's code base that bug 274563 deals with that made it impossible for distcc to build Moz. If you apply the patch attached to the bug then you'll be able to do distcc builds of Mozilla. We will soon be releasing our first beta to reflect our confidence in the code.

Feb 27, 2007

We are able to do distributed builds of Mozilla but it dies when trying to link stuff together (issues surrounding ATL?). So in order to take advantage of Ben Smedberg's wonderful Mozilla Build and be able to get help figuring out weird linkage bugs and dependancies without having to deal with cygwin issues (which are galore), we've started a branch with a mingw port: svn://cdot.senecac.on.ca/distcc/branches/mingwcompatible/

Jan 4, 2007

The post made to the build newgroup seems to have gathered dust. If mozilla is limited to only 4 jobs, than distcc is somewhat limited. But that's not our problem.

Tom has found one problem with using cygwin. Using absolute pathnames. For example :

$ cl hello.c
Microsoft (R) 32-bit C/C++ Optimizing Compiler Version 14.00.50727.42 for 80x86
Copyright (C) Microsoft Corporation.  All rights reserved.

Microsoft (R) Incremental Linker Version 8.00.50727.42
Copyright (C) Microsoft Corporation.  All rights reserved.


Works. But this doesn't :

$ cl /cygdrive/c/home/temp/hello.c
Microsoft (R) 32-bit C/C++ Optimizing Compiler Version 14.00.50727.42 for 80x86
Copyright (C) Microsoft Corporation.  All rights reserved.

cl : Command line warning D9002 : ignoring unknown option '/cygdrive/c/home/temp
cl : Command line error D8003 : missing source filename

There are a few things we can do about this :

  • replace /cygdrive/c/ with C:\
  • user must replace the enviroment variable TMPDIR which defaults to /tmp

Cesar found another problem. Both C/C++ preprocessed file ends in .i. cl has no way of knowning if it's a C/C++ preprocessed file. So it refuses to compile it (it treats it as an object file). So when we preprocess, we have to redirect to the same extension as the source file.

$ cl hello.i
Microsoft (R) 32-bit C/C++ Optimizing Compiler Version 14.00.50727.42 for 80x86
Copyright (C) Microsoft Corporation.  All rights reserved.

cl : Command line warning D9024 : unrecognized source file type 'hello.i', objec
t file assumed
Microsoft (R) Incremental Linker Version 8.00.50727.42
Copyright (C) Microsoft Corporation.  All rights reserved.

hello.i : fatal error LNK1107: invalid or corrupt file: cannot read at 0xEE7F