✎ soc:2008:ideas - Etherboot/gPXE Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Google Summer of Code 2008 ======

**The Etherboot Project has been accepted for Google's 2008 [[http://code.google.com/soc/|Summer of Code]] project!**

{{ :bootroms.jpeg?350×190|Some boot ROMs}}

We, the [[http://etherboot.org/|Etherboot Project]], create network booting code (gPXE) that allows computers to load their operating system from a network.  gPXE can be stored in a number of places, including BIOS Flash, EPROMs, floppy, CD, HD, or other bootable media.  The project has been around since about 1993.

We have a number of areas we can use help with.  Since our focus is on creating network boot code, it is important that you be comfortable with low-level programming -- that is, C and possibly some x86 assembler (though this is not essential for many projects, and you can pick it up as you go along).  You should also understand that efficiencies of code size, runtime size, and execution speed are important to us.  Low-level, or "bare-metal" programming requires patience and focus, but the sense of control and deep understanding of what is happening, and why, can be very exhilarating. 

===== Where to find us =====

We generally hang out in the ''#etherboot'' channel on the FreeNode IRC network (irc.freenode.net).  Please feel free to drop in and ask questions, discuss ideas, etc.  We talk to all applicants individually as part of the selection process and, if we accept you as a Summer of Code student, we'll expect to talk to you in the IRC channel at least every couple of days.

Our mentors for Summer of Code are:
  * Marty Connor [''mdc''] (Project Leader, Developer, Etherboot Project)
  * Michael Brown [''mcb30''] (Lead Developer, Etherboot Project)
  * H. Peter Anvin [''hpa''] (Project Leader, Lead Developer, Syslinux Project)

You can reach the mentors directly via e-mail using <soc-mentors@etherboot.org>.  There is also an Etherboot project mailing list ([[https://lists.sourceforge.net/lists/listinfo/etherboot-discuss]]; you must subscribe before posting).

===== Project ideas =====

This list is not exhaustive, and we welcome new suggestions.  Some of these ideas are not in themselves complete projects; feel free to ask us how much work is likely to be involved, and how many ideas you might sensibly attempt as a Summer of Code project.  The approximate difficulty level of each idea has been marked with one or more :-/ symbols; the more :-/, the more difficult the project is expected to be.

{{ :nic.jpeg?237×222|A network card}}

==== Device drivers ====

gPXE is always in need of more device drivers.  In the case of network card drivers, existing drivers and Linux kernel drivers are available as starting points.  Data sheets are also generally available for most NIC variations, though such documentation is sometimes unreliable.  You could:

  * :-/ :-/ Update some of the old Etherboot drivers to work with the new gPXE driver API.  All drivers are written in C, and you will need to have hardware (network cards, server and client computers) to test driver changes.  (We may be able to provide some of the required cards for development and testing.)

  * :-/ Add support for newer network card variants to an existing gPXE driver.

  * :-/ :-/ :-/ Add a device driver for a new, currently-unsupported network card to gPXE.

If you are feeling more adventurous, and have access to appropriate hardware, you could:

  * :-/ :-/ :-/ :-/ Add a driver for a wireless network card.  There is some out-of-date support for one type of 802.11b wireless card; you could expand this into a general framework for wireless networking, and add drivers for one or more modern wireless NICs.

  * :-/ :-/ :-/ Add a non-Ethernet driver, e.g. a driver for an Infiniband card.  (gPXE does have a working Infiniband subsystem.)

  * :-/ :-/ Fix up the support for legacy bus types such as ISAPnP.  These devices are allegedly supported, though most have not been tested for many years, and it is unlikely that the current code is in a working state.

  * :-/ :-/ :-/ :-/ Add support for a new bus type, e.g. PCMCIA or USB.

==== Protocols ====

gPXE already supports several common (and less common) protocols, including TFTP, FTP, HTTP, HTTPS, DNS, iSCSI and AoE.  There are several more (mostly fairly esoteric) protocols that people may find useful.  You could add support for:

  * :-/ :-/ Fibre Channel over Ethernet (FCoE)

  * :-/ :-/ Novell's Remote Program Load (RPL)

  * :-/ :-/ iSCSI extensions for RDMA (iSER)

{{:nullmodem.jpeg?200×200 |A null-modem cable}}

==== GDB remote debugging ====

:-/ :-/ :-/ Debugging gPXE can be a difficult task, since it runs on bare metal with no operating system facilities.  The GNU debugger (GDB) supports a remote debugging protocol that allows source-level debugging of a program running on a remote system.  You could implement the server portion of this protocol (the "GDB stub") within gPXE, which would allow most parts of gPXE to be debugged using GDB or any other debugger supporting the GDB protocol.  You would probably want to support both serial (null-modem) and TCP/IP-based connections to the GDB stub.

==== COMBOOT support ====

:-/ :-/ :-/ At present, gPXE has an interactive command line, but no menuing facility.  [[http://syslinux.zytor.com/|SysLinux]] has a comprehensive menuing system, and a widely-used configuration file format.  By adding support for COMBOOT executables to gPXE, you would be providing the ability for people to use boot menus to control gPXE.  You will also be enabling the use of any other COMBOOT programs with gPXE.

You would need to implement the functions described in the [[http://syslinux.zytor.com/comboot.php|SYSLINUX API]] documentation, along with support for the COMBOOT image format itself.  This will require a reasonable familiarity with the gPXE codebase, and some knowledge of x86 assembler.

==== Automated regression testing ====

:-/ :-/ :-/ :-/ :-/ gPXE has a relatively large feature set given the code size.  Many features are rarely used, and there has been a tendency for parts of the code to suffer from bit-rot.  The measures we have taken so far will ensure that we never end up with unbuildable code; we now avoid the use of #ifdef wherever possible, and have automated tests in place to identify missing or redundant symbols.  However, we do not have any systematic method for functional testing. 

We would ideally like to be able to run a series of tests to verify different functional units (e.g. http download, Linux kernel booting, PXE booting, serial console support, etc.).  Most of these tests can be carried out inside a virtual machine such as bochs or qemu.  Some tests (e.g. specific device driver tests) will need to be carried out on real hardware.  The tests should be fully automated, and should produce a clear pass/fail status indicator.  It should be possible for a developer to simply run “make test” and, some time later, receive an overall pass/fail status, together with a list of any failed tests.

You would design and create an infrastructure for automated testing of gPXE.  Your test harness would have to set up the environment required for the particular test (e.g. building the gPXE image to be tested, configuring the DHCP server), initiate the test (which may involve starting up an emulator such as qemu, or powering-on a test machine), identify and record the test result, then move on to the next test.  Test results should be collated and reported to the developer.

Having such an automated test suite would enable us to offer quality control guarantees; we could then be confident that upgrades would not break existing functionality.

===== What you will need =====

{{ :disk.jpeg?240×186|A disk}}

For almost all gPXE development work, you will need to have:

  * A development machine, running Linux, that you have root access to.  You will edit and compile gPXE on this machine, and you may also need to set up software such as a DHCP server etc.  (We will talk you through getting your machine set up for development; the important thing is that you must have a machine available.)

  * A testing machine, which you can reboot very frequently.  You will test gPXE on this machine.  This machine cannot be the same as your development machine; it must be a separate computer.

  * A working network between the two machines.

  * Access to IRC (Internet Relay Chat), so that you can talk to us.

Depending on the project idea that you choose, you may also need:

  * One or more specific network cards, if you are writing a driver for that card.  We may be able to provide these.

  * Support for specific bus types (e.g. PCI express, PCMCIA) on the testing machine, if your project idea involves working with these buses.

It is useful, though not always essential, to have:

  * Serial ports on both the development and testing machines, and a null-modem cable to connect them.

  * A digital camera (for taking screenshots; we have found situations in which this is the only sensible way to report diagnostic information!)

===== How to apply =====

First, take a look at the above list of project ideas and see if anything takes your fancy.  If you have an idea of your own that isn't listed above, that's great.  Take some time to think about your idea; how might you approach the problem, how long do you think it would take, how interesting do you find it, how useful will it be to other people, etc.?

Second, introduce yourselves to us.  Preferably via the IRC channel, though e-mail is perfectly acceptable.  We will want to spend some time talking to you about your proposal.  We will base our decision mostly on the interactions we have with you, rather than on the project proposal you submit via the GSoC web interface.

Thirdly, once you've talked to us on IRC or via e-mail, submit a project proposal via the official Summer of Code web interface.  Your proposal should clearly state the project idea you'd like to work on, and should give some background information on your experience, and a rough overview of how you would approach the problem.  We will interview all applicants (via IRC), and our decision on who to accept will be based primarily on the interview (and on any other contact we've had with you via IRC).

===== Hints and tips =====

  * Do get in touch with us.  Unlike the larger projects, we **will** take the time to talk to you personally.  If we haven't spoken to you, we're very unlikely to accept you as a student.

  * Do ask for help when you need it.  You're not in class, and you won't be penalised for not knowing the answer immediately.

===== Potentially useful links =====

==== Google Summer of Code ====

  * Main page: [[http://code.google.com/soc/]]
  * Student FAQ: [[http://code.google.com/soc/studentfaq.html]]
  * Student Application: [[http://code.google.com/soc/student_step1.html]] 

==== Etherboot Project Links ====

  * Project Home Page: [[http://www.etherboot.org/]]
  * Source Code: [[http://www.etherboot.org/wiki/download]]

==== Etherboot Mailing List Links ====

  * Etherboot-Discuss Mailing List Archives: [[http://sourceforge.net/mailarchive/forum.php?forum=etherboot-discuss]]
  * Etherboot-Discuss Mailing List Subscription Page: [[https://lists.sourceforge.net/lists/listinfo/etherboot-discuss]]

==== Etherboot IRC Channel ====

  * ''#etherboot'' on the FreeNode network (irc.freenode.net)



We hope you have enjoyed reading about the [[http://www.etherboot.org/|Etherboot Project]], and we look forward to meeting you and discussing your project ideas.
Trace: • timeouts • week1 • sanboot • soc • srp • fredrikhultin • troubleshooting • varnishmirror • howtos • qemu • screenshots • indolent_playground • officialdebian • less1 • concepts • socideas • project_plan • notes • appnoted • isolinux