- BOINC source code
BOINC source code
Browsing source code on the web
The BOINC source is stored in a Git repository. To access the BOINC Git repository you'll need the Git client software:
- On Windows, get a Git client like 'Git for Windows' (console) and TortoiseGit (GUI) (see this guide for Windows).
- On Linux, Git is usually provided by your distribution. If not, check your package manager and look for "git" or "git-core"
- On Mac OS X, use MacPorts (to keep git up to date, recommended) or a manual installation package.
- Recommended free GUIs: SourceTree (includes an embedded git), SmartGit (free for non-commercial use), GitX (latest)
To get a copy of the BOINC source code you don't need to fully understand Git, just skim the instructions below. However, if you intend to modify BOINC or to look at branches, you'll need to know at least the basics.
- Getting Git: 1 hour video (technical, but highly recommended)
- Pro Git: Great free online book (also commercially available in print!)
- All the rest: Cheat sheets, tutorials and more videos
Getting a copy of the BOINC source
To clone the BOINC Git repository into a local directory called (for example) 'boinc_repo', run:
git clone git://boinc.berkeley.edu/boinc-v2.git boinc_repo
git clone http://boinc.berkeley.edu/git/boinc-v2.git boinc_repo
This will give you a full copy that you can modify and compile locally, but you will not be able to push changes to the BOINC repository. For write access, see further below.
If you change to the newly created directory 'boinc_repo', you will see a local copy of the BOINC source code tree. These are the files corresponding to the 'remote master branch', the bleeding edge of development. Running git status will show that this is actually true:
$ cd boinc_repo $ git status # On branch master nothing to commit, working directory clean
You can replace the files on your 'master branch' by files from older branches or older tags using the appropriate git command - without needing to contact the Git repository server again. This is called 'checking out'. The information to make your local copy of the Git repository a fully navigable development history is tucked away under the '.git' subdirectory.
On Windows, you'll need a Git client such as TortoiseGit (see below). Right-click on the parent directory, select 'Git Clone...', and fill in the dialog with one of the above URLs. Don't forget to remove both 'git clone' and 'boinc' from the commands above.
Tags & Branches
Various versions of the source code are available in the remote repository (and now, in your local copy of it):
- remote tags: These are snapshots of the state of development taken at a specific point in time. You can check out a 'remote tag', but you should not modify the files thus checked out - for that you need a separate branch (which can be created later though). The tag's name indicates what's in there. For example, the release of BOINC client version 7.0.60 has been given then tag 'client_release/7.0/7.0.60'. Run git tag to list the remote tags.
- remote branches:
BOINC developers perform long-running work on source code that needs to be visible to other members of the team by working on a 'remote branch'. There are:
- The remote master branch: This is the most recent version of the source code. It always exists, contains the freshest code and has not necessarily been thoroughly tested.
- Other branches: For example, work on version 6.12 of BOINC that is not done in the 'remote master branch', for example due to the need to apply an urgent fix may be done in a remote branch called 'client_release/6/6.12'. Run git remote show origin to list the remote branches.
As you cloned the Git repository, a 'local master branch' was created. This initially corresponds to the 'remote master branch', but once you start editing files, it will evidently deviate from it.
You can create local branches and tags (both invisible to anyone but yourself). You can check out a specific 'remote tag' to compile, or you can create a local branch based on a specific 'remote tag' to work on the code.
- See Git Basics - Tagging for the concept of 'tagging'.
- See Git Branching - Remote Branches for the concept of 'remote branches' and the concepts of the 'local' and 'remote' master branches.
- See What is the difference between a tag and a branch in git? for a short intro on 'tags' and 'branches'.
- See Checkout GIT tag for an explanation about 'checking out git tags'.
Development on the bleeding edge
If you want to work on the remote 'master' branch, check it out locally:
git checkout master
Actually this has already happened when you cloned the repository, so the above command is mainly useful if you want to go back to the remote master branch after you modified some files in a hasty fashion.
Check out a specific tag for compilation
As said above, the code for each release is 'tagged'. For example, the code for version 7.0.65 is tagged with client_release/7.0/7.0.65.
to list all the visible tags.
git tag --list '*/7.0/*'
to list only the tags matching '/7.0/'.
git checkout client_release/7.0/7.0.65; git status
to check out BOINC client version 7.0.65.
...and proceed with compilation.
For all software other than the client (i.e., server, web, and API) a "stable" version is kept in a branch, server_release. Don't use the server software in a client tag or branch; it probably isn't stable.
git tag --list 'server_release*'
to list the available tags for stable server releases.
- There is no formal testing process for server software. Every so often, when no bugs have been reported for some time, we tag the master branch to server_release.
- Because of limited resources, bug fixes to server software are normally NOT back-ported from master to server_release.
For these reasons: the master branch is typically a better choice than server_release for server software (should this not be the reverse?? .ed)
Write Access to the Git Repository
Note: you don't need direct write access to contribute code to BOINC. Given the distributed nature of Git you can publish your contributions elsewhere (e.g. on GitHub) or send your patches via mail (using git format-patch).
Direct write access to the main repository is currently available via the SSH protocol with public-key authentication. If you want direct write access, contact David Anderson and/or Rom Walton. They'll ask you for your public-key. Here's how you can create a public/private key pair and use it after you've been granted access to the repository:
Please see this page for details.
Linux/Mac OS X
- General note: before you start, please check whether you already have an existing key at ~/.ssh/id_rsa. If so, please choose a different key filename for the commands below! Alternatively, you could also reuse the existing key and continue with the final step.
- Note to Mac OS X users: if you prefer "Finder" over "Terminal" hit CMD+SHIFT+G in "Finder", then enter ~/.ssh to go to that hidden folder.
The following shell/terminal command will create a key pair that gets stored in your ~/.ssh directory:
- Public key: ~/.ssh/id_rsa.pub
- Private key: ~/.ssh/id_rsa
ssh-keygen -t rsa -b 4096 -f ~/.ssh/id_rsa
If you used the standard key filename id_rsa and you want the repository named boinc-v2.git, use the following URL to access the repository:
If you had to use a different key filename because of an existing key that you don't want to overwrite or reuse, you can define a so called ssh host alias that allows you to specify which key to use when accessing the BOINC repo. To do so, add the following to ~/.ssh/config (create the file if necessary), assuming that you created the ssh key as ~/.ssh/boinc-key:
host boinc-git-server Hostname boinc.berkeley.edu Port 22 IdentityFile ~/.ssh/boinc-key User gitolite
Now that you have the host alias defined you may access the repo using the alias in the clone URL (instead of the full user/hostname information):
git clone boinc-git-server:boinc-v2.git
Finally, send the public key to David or Rom. Important: the private key should never leave your system! Keep it safe!
Windows build dependencies
All the additional dependency files are now stored in boinc_depends_win_vs2010;; get them using git clone git://boinc.berkeley.edu/boinc_depends_win_vs2010.git. The dependencies should be stored in the same parent directory as the BOINC source code, for example:
+-+ source | + boinc | | | + api | + client | + clientgui | + etc... | + build_depends_vs2010 | | | + curl | + openssl | + wxwidgets | + zlib
When you have older source code, deleting all previous source code and downloading it fresh will sometimes fix the breaks in building BOINC. Make sure to back up your own code prior to deleting the source code.
Source code road map
The BOINC source tree includes the following directories:
- The BOINC API (for applications).
- Some test applications.
- The BOINC client.
- The BOINC Manager.
- The BOINC screensaver for Windows.
- The BOINC Tray component (checks for user activity on Windows).
- The database schema and C++ interface layer.
- PHP files for the operational web interface.
- PHP files for the participant web interface.
- PHP include files.
- Translation files for project websites.
- Code that is shared by more than one component (core client, scheduling server, etc.).
- Translation files for BOINC Manager.
- Python modules used by tools.
- The scheduling server, feeder, and file upload handler.
- Several example applications together with Windows and Mac project files and a Linux makefile for building the applications. It also includes Windows versions of some libraries (GLUT, jpeglib, etc.) that many applications will need, but which are not part of BOINC.
- Test scripts.
- Operational utility programs.
- Project files for compiling the client under Windows, and the Windows installer.
- Compression functions; not used by BOINC, but may be useful for applications.