boinc/doc/boinc_dev.php

<?php
require_once("docutil.php");
page_head("BOINC software development [deprecated - Wiki]");

if (!$book) {
    echo "
        <ul>
        <li> Get and build BOINC software</li>
            <ul> 
            <li> <a href=source_code.php>Get BOINC source code</a>
            <li> <a href=server.php>Building server software</a>
            <li> <a href=compile_app.php>Building applications</a>
            <li> <a href=compile_client.php>Building BOINC client software</a>
            </ul>
        <li> <a href=#dev>BOINC development</a></li>
        <li> <a href=#projects>Development projects</a></li>
        <li> <a href=#addon>Writing add-on software</a></li>
        </ul>
    ";
}

echo "
<a name=dev></a>
<h2>BOINC development</h2>
<p>
<ul>
<li> <a href=contact.php>Personnel and contributors</a>
<li> <a href=dev_flow.php>Development information flow</a>
<li> <a href=http://boinc.berkeley.edu/trac/>BOINC/Trac</a> (bug database, source code browsing)
<li> <a href=email_lists.php>boinc_dev</a>, an email list for BOINC developers.
<li> <a href=impl_notes.php>Implementation notes</a>
<li> <a href=coding.php>BOINC coding style</a>
<li> <a href=test.php>The BOINC testing framework</a>
</ul>
<p>
BOINC is free software, distributed under the Lesser General Public License (LGPL).
We need volunteers to help with software testing and development.
If you have one or more of the relevant technical skills
(C++ system programming, PHP/MySQL web development,
WxWidgets programming, autoconf/automake expertise, etc.)
you may be able to help us maintain and enhance BOINC.

<p>
The University of California holds the copyright on all BOINC source code.
By submitting contributions to the BOINC code, you irrevocably assign
all right, title, and interest, including copyright and all copyright
rights, in such contributions to The Regents of the University of
California, who may then use the code for any purpose that it desires.

<p>
In any case, you are welcome to browse the source code and give us feedback.
You should understand how BOINC works
(for both <a href=participate.php>participants</a>
and <a href=create_project.php>projects</a>)
before getting into the source code.

<p>
To get started, find a small bug fix or enhancement to do
(look at the BOINC bug database, the email lists, or message boards for ideas).
Look at the source code and think about how you would implement it.
Then communicate with the <a href=contact.php>area owner</a>,
sketching what you want to do and how.
Work the the area owner to carry out and check in the work.

<a name=projects></a>
<h2>Development projects</h2>
<p>
The following medium-to-large development projects are available:
<ul>
<li> Applications
<ul>
<li> Write an example compound application
(and suggest API revisions to make this easier).
<li> Create Makefiles and project files to build
the sample applications using MinGW and DevC++.
<li> Extend wrapper application handle multiple tasks,
and test/debug it.
<li> Investigate the  crlibm library for generating
identical results across processors
(or at least reducing the number of cases for HR).
<li> Graphics in separate program.
<li> Java support: core client checks for the existence of JVM,
    reports version to scheduler.
    Write Java wrapper (runs JVM, gives it jar files).
    Note: Szataki has already done some part of this.
<li> Same, .NET
<li> Distributed Python:
    Borrow or invent a notation for master/slave execution in Python.
    Develop a system that implements this on BOINC,
    i.e., creates WUs and applications, and harvests the results.
<li> Write example FORTRAN application and Makefiles/ project files
</ul>
<li> Core client:
<ul>
<li> Add a preferences for total download and upload in a month
    (many Australian ISPs have monthly limits)
<li> Have the core client sense CPU temperature
    and throttle CPU if it goes too high.
    Open-source software for this (on Linux) is at
    http://www.lm-sensors.org/.
<li> Windows: get proxy config info directly from the OS
<li> After an applications exits or is killed (for whatever reason)
make sure (after a few second delay) that its subprocesses are gone too.
Don't restart the job until this happens.
Unix: use process groups and killpg().
<li> More generally: make a better state machine for shutting down apps:
tell them to checkpoint, wait a little, tell them to quit,
clean up straggler processes.
<li> Integrate BitTorrent with the core client.
<li> Do potentially slow RPCs and other tasks
(such as computing disk usage) in a separate thread.
<li> Don't enforce RAM limits unless free RAM is low
<li> Extend general preferences to allow users to
specify different time-of-day restrictions for different days of the week.
<li> 
Write a simulator for the CPU scheduler and work fetch policies
(Derrick Kondo is working on this).

<li> Log result start/ends (for use by 3rd-party software like BoincView).

<li> Prevent disk space usage from exceeding user preferences,
and enforce resource shares,
with file deletion according to project policy.
<li> Make messages of class MSG_USER_ERROR translatable.
<li> GUI RPC to tell apps to checkpoint and quit.
<li> Vista: if get 'about to shut down' msg from OS,
stop apps immediately (don't tell them to checkpoint).
Investigate.
</ul>

<li> BOINC Manager:
<ul>
<li> Make simple GUI accessible to visually impaired.
<li> Properties pages for projects, jobs
<li> Project list (Rom's working on this)
<li> Turn off alerts (Rom's working on this)
<li> Have the Manager do RPCs in a separate thread.
<br>
(The following are currently in progress by Frank Weiler)
<li> Advanced prefs dialog

<li> Show progress bars for file transfers and in-progress results
(this requires changing the container class from Spreadsheet to Grid).

<li> Sortable columns in the Work tab.
</ul>

<li> Server/Back End:
    <ul>
    <li> Add a 'validity' field to host.
        Exponential average of fraction of valid results.
        Demand more replicas if some are from suspect hosts.
    <li> Allow the scheduler to take a list of platforms (not just one).
        E.g. a Win64 machine could send Win64 and Win32.
    <li> When using HR, if the scheduler has sent one result of a WU
        using a particular app version,
        it should use the same app version for other results from that WU.
        Need to change protocol to specify version num;
        need to change client to use this.
    <li> Implement a mechanism so that server
        software detects incompatible database format
    <li> 
        Scheduler: implement mechanisms so that server:
        <ul>
        <li> Sends only results likely to finish by their deadline
        <li> Sends commands to abort results that can't get credit
        <li> Sends commands to recommend abort of results
            that may get credit, but are not useful
            (i.e. canonical result already found)
        <li> Attempts to send results from the same WU to
            hosts with similar speed,
            so that a fast host doesn't have to wait weeks to get credit.
        </ul>
    <li> Implement a 'benchmark result' mechanism:
        every host runs a benchmark result per app version,
        and the CPU time determines credit/CPU for future results
    </ul>

<li> Web features:
    <ul>
        <li> Propagate profiles between projects.
            When create or edit profile,
            if attached to other projects,
            show 'propagate changes' page,
            with checkboxes for other projects
            (must have same password on other projects).
            Add web RPCs for updating profile
            (args: user ID, profile, password hash)
            Implement this so that page doesn't block
            waiting for replies from RPCs.
        <li> Same for forum preferences
        <li> Combine user page and profile
        <li> Add new profile features:
            <ul>
            <li> 'Buddy lists'
            <li> personal messages
            <li> list of recent posts and threads this person created,
                on this and other projects
            <li> other features from networking sites?
            </ul>
        <li> Change the ops/ web pages to require login
            by a user with admin privileges.
        <li> Add 'referral' mechanism:
            new user creates account, enters email of 'referrer'
            (or goes to URL that has it embedded).
            Give referrer a fraction of credit
            (or a 1-time bonus).
            List referrals on user page (show only those still active).
            Add new referral table to DB.
    </ul>

</ul>
Please check with <a href=contact.php>David Anderson</a>
before undertaking any of these.

<a name=addon></a>
<h2>Writing add-on software</h2>
<p>
BOINC's architecture is 'open';
documented interfaces making it possible to
develop various types of applications and web sites that
interact with BOINC components.
Examples include:
";
list_start();
list_item("<a href=gui_rpc.php>Client GUIs</a>",
    "Application that control a local or remote core client."
);
list_item("<a href=stats.php>Credit statistics web sites</a>",
    "Web sites showing credit information
    (project totals, user/team/country leaderboards)
    based on daily XML feeds of statistics data from BOINC projects."
);
list_item("<a href=acct_mgt.php>Account managers</a>",
    "Web sites that let BOINC users create and manage accounts
    on multiple projects."
);
list_item("<a href=server_status.php>Server status web sites</a>",
    "Web sites showing the server status of BOINC projects."
);
list_item("<a href=web_rpc.php>Web RPCs</a>",
    "These interfaces let a program or web site
    obtain information about users and hosts from projects."
);
list_item("<a href=prefs_override.php>Local editing of preferences</a>",
    "This mechanism lets you write programs for local editing of preferences."
);
list_end();
echo "
<p>
Check the
<a href=addons.php>index of add-on software</a>
before writing anything (it may already exist).
The index has instructions for submitting new add-ons.

";

page_tail();
?>