Difference between revisions of "Outreach Program Projects"

From Xen
(PCI Pass-through improvements: Deleted)
(List of peer reviewed Projects)
Line 87: Line 87:
|Outcomes=Code is submitted to xen-devel@xen.org for inclusion in the xen-unstable project.
|Outcomes=Code is submitted to xen-devel@xen.org for inclusion in the xen-unstable project.
=== Xen Toolstack ===
{{TODO|Have a shortlist of new projects that will be added shortly}}
=== Xen Hypervisor ===
=== Xen Hypervisor ===
{{TODO|Have a shortlist of new projects that will be added shortly}}
=== Rump Kernel ===
{{TODO|Have a shortlist of new projects that will be added shortly}}
=== Mirage OS ===
=== Mirage OS ===

Revision as of 15:48, 11 February 2016

The Xen Project is a Linux Foundation collaborative project that develops the

  • Xen Hypervisor (for x86 and ARM) - the bulk of this page
  • The XAPI toolstack (see #Mirage_OS)
  • Mirage OS (see #XAPI)
  • We also have some infrastructure, tooling and community related projects that run across all the sub-projects. These are sllightly different from other projects, in terms of skills: see #Infra_and_Community

The project also has excellent relationships with its upstreams (Linux Kernel, the BSDs, QEMU and other projects) and upstreams such as Linux distributions. This is reflected in the project list, which contains many interesting cross-project development projects for applicants.

Finding a project that fits you

This page lists Xen Project development projects for Outreachy (formerly the Outreach Program for Women) that can be picked up by anyone! If you're interesting in hacking Xen Project code and want to become a part of our friendly developer community this is the place to start! Ready for the challenge?

To work on a project:

  • Find a peer-reviewed project from below that looks interesting. If you do not find an interesting issue, you can also go to Xen UserVoice, pick a few projects from there and ask on xen-devel@ whether the chosen project(s) would be suitable for Outreachy. Note that some of them may be too large or complex for Outreachy.
  • Send an email to the relevant mailing list (see Developer Mailing Lists) and let us know if you are interested in starting to work or applying on a specific project.
  • Post your ideas, questions, RFCs to the relevant mailing list sooner than later so you can get comments and feedback.
  • Easy test projects to fulfil the Make a Small Code Contribution Requirement: An easy way to get started (and show that you can set up the Xen Development Environment, fix an issue, build and test Xen, submit a patch, etc.) is to address a suitable number of Coverity Scan issues. Ask on xen-devel@ for a set of suitable issues and later you may ask for access to coverity scan or for a bug on /bugs.xenproject.org.

You have your own project idea: no problem!

  • If you have your own project idea, outline what you are trying to do on the mailing list. If you know the right list, post your project idea on mailing list. Failing that post on xen-devel and we can redirect you to the right list. Make sure you add OPW 2014 to the subject line.

It is a good idea to ...
The Xen Project has also participated in the Gnome Outreach Program for Women (OPW) and Google Summer of Code (GSoC) in the past. One of the things we learned by participating in these programs is that you will be more successful, happier and get more out of participating in internship programs, if you do a bit of prep-work before writing an application. Here is some stuff you can do:

  • Contact your mentor early and get to know him or her
  • Start hanging out on our IRC channel. You can use the #xen-opw IRC channel on freenode.net for now
  • You may want to ask the mentor for a couple of small bitesize work-items (such as reviewing someones patch, a bitesize bug, ...) and start communicating on the relevant mailing list. That helps you become familiar with our development process, the mentor and other community members and will help you chose the right project and help you decide whether the Xen project is for you.
  • Note that quite a few Xen maintainers used to be GSoC participants once. Feel free to ask community dot manager at xenproject dot org to put you in touch with them if you have questions about their experience.
  • Any work you submit before applying for a project should be based on xen-unstable development tree, if the project is Xen Hypervisor and/or tools related. Linux kernel related patches should be based on upstream kernel.org Linux git tree (latest version). XAPI and Mirage OS patches should be based on the right codeline too. Check out the navigation by audience section on the left to find resources.

More resources

Quick links to changelogs of the various Xen related repositories/trees: Please see XenRepositories wiki page!

Before to submit patches, please look at Submitting Xen Patches wiki page and the relevant Xen Project team page. This will contain more information.

If you have new ideas, suggestions or development plans let us know and we'll update this list!

Aspiring Participants

  • Please contact the mentor and CC the most appropriate mailing list
  • Get a bite-size task from the mentor before the application starts
  • If you feel comfortable with an idea, please put your name to an idea using the following format
|Review=(delete as addressed)
* {{Comment|~~~~:}} I am interested in this idea ... 
                    (note that you may also want to link to the e-mail thread with the mentor)
  • You will need to request write access to the wiki by filling out this form

Outreach Program Project Ideas

List of peer reviewed Projects

Xen Hypervisor Userspace Tools

KDD (Windows Debugger Stub) enhancements

Date of insert: 01/30/2014; Verified: 09/17/2015; GSoC: yes
Technical contact: Paul Durrant <paul.durrant@citrix.com>
Mailing list/forum for project: xen-devel@
IRC channel for project: #xen-devel
Difficulty: Medium
Skills Needed: C, Kernel Debuggers, Xen, Windows
Description: kdd is a Windows Debugger Stub for Xen hypervisor. It is OSS found under http://xenbits.xen.org/gitweb/?p=xen.git;a=tree;f=tools/debugger/kdd;h=fd82789a678fb8060cc74ebbe0a04dc58309d6d7;hb=refs/heads/master

kdd allows you to debug a running Windows virtual machine on Xen using standard Windows kernel debugging tools like WinDbg. kdd is an external debugger stub for the windows kernel. Windows can be debugged without enabling the debugger stub inside windows kernel by using kdd. This is important for debugging hard to reproduce problems on Windows virtual machines that may not have debugging enabled.

Expected Results:

  1. Add support for Windows 8.1 and 10 (x86, x64) to kdd
  2. Add support for Windows Server 2012 to kdd
  3. Enhance kdd to allow WinDbg to write out usable Windows memory dumps (via .dump debugger extension) for all supported versions
  4. Produce a user guide for kdd on Xen wiki page
Nice to have: Allow kdd to operate on a Windows domain checkpoint file (output of xl save for e.g.)
Outcomes: Code is submitted to xen-devel@xen.org for inclusion in the xen-unstable project.

Xen Toolstack

Icon todo.png To Do:

Have a shortlist of new projects that will be added shortly

Xen Hypervisor

Icon todo.png To Do:

Have a shortlist of new projects that will be added shortly

Rump Kernel

Icon todo.png To Do:

Have a shortlist of new projects that will be added shortly

Mirage OS

Several different projects (follow link)

For Mirage OS, please check out the Mirage OS Pioneer-Projects page. If you are interested in one of these projects, please e-mail mirageos-devel@lists.xenproject.org and CC the mentor from the page (the project will contain a link to the mentor's GitHub account, which normally contains an email address and IRC information). You can also ask questions on the #mirage IRC channel and usually find mentors on there.


No projects at this stage.

Infra and Community

We also have some infrastructure, tooling and community related projects that run across all the sub-projects. These are slightly different from other projects, in terms of skills and working with the community. Please check extra information below the project.

Xen Code Review Dashboard

Xen Code Review Dashboard (MetricsGrimoire, GrimoireNG)

Date of insert: 09/28/2015; Verified: 09/28/2015; GSoC: Yes
Technical contact: Jesus M. Gonzalez-Barahona <jgb@bitergia.com>, Lars Kurth <lars.kurth@xenproject.org>
Mailing list/forum for project: xen-devel@
IRC channel for project: #xen-devel
Difficulty: Medium
Skills Needed: Javascript programming, HTML5, basic software design knowledge (working with the mentors)
Description: The code review process in Xen is being analyzed, using MetricsGrimoire tools. As a result of that process, several parameters are identified for the review of each patch or patch set, such as number of iterations until accepted, time to review, time to attention, developer submitting the patch, employer, date of submission and acceptance, etc. Some summary parameters are produced as well, such as the total number of code reviews, or the number of people involved. Some of the early output of that work can be found at https://github.com/dicortazar/ipython-notebooks/tree/master/projects/xen-analysis and will be used as a baseline for further work (note that the project will be completed before Outreachy round 11 starts) and will be made available os open source.

The purpose of this project is build an HTML5 application which consumes JSON documents with the data described above, and shows users a dashboard which allows them to watch the data, and interact with it to filter, group and drill-down. Current ideas include using

other options may be possible.
Outcomes: The final result is expected to have some resemblance with the [GrimoireNG proof-of-concept dashboard for Xen https://projects.bitergia.com/previews/ng/dashboard.html?db=xen], which uses information from git commits. Code is expected to be upstreamed to either GitHub or a code repository hosted on xenbits.xen.org/gitweb.

Further Information:

  • Small code contribution requirement: In the "GrimoireNG proof-of-concept dashboard for Xen" (the code is on github.com/Bitergia/newgen-dashboard/tree/refac) add a new chart with the number of authors (distinct authors) per month, similar to the one with the number of commits per month which is already in the dashboard.
  • IRC: #metrics-grimoire at freenet (mentors are jgbarah and lars_kurth)
  • Mailing List: : metrics-grimoire@lists.libresoft.es and CC xen-devel@lists.xenproject.org
  • Final Code Location: Decide final code location of output

New Project Ideas

Please add new project ideas here, following

Conventions for Projects and Project Mentors

Rules and Advice for Adding Ideas

  • Be creative
  • Add projects into New Project Ideas or improve projects in Project Ideas that Need Review or more work through review comments.
  • Use the {{GSoC Project}} template to encode ideas on this page. Please read the Template Documentation before you do so.
  • Be specific: what do you want to be implemented; if at all possible provide an indication of size and complexity as described above to make it easier for an applicant to choose ideas
  • If you are willing to mentors those ideas, add your name and email to the idea.
  • Aspiring mentors should introduce themselves on the most appropriate Xen Project mailing list

Peer Review Goals

We strongly recommend and invite project proposers and project mentors to review each others proposals. When you review, please look out for

  • Can an intern get going and started with the information in the project description
  • Are any unstated assumptions in the proposal, is there undefined terminology, etc. in the proposal
  • Can the project completed in 3 months (assume that one month is needed for preparation)
  • Does the project meet Google Summer of Code goals, which are
    • Create and release open source code for the benefit of all
    • Inspire young developers to begin participating in open source development
    • Help open source projects identify and bring in new developers and committers
    • Provide interns the opportunity to do work related to their academic pursuits (think "flip bits, not burgers")
    • Give interns more exposure to real-world software development scenarios (e.g., distributed development, software licensing questions, mailing-list etiquette)

Peer Review Conventions

The {{GSoC Project}} template used to encode project listings, contains some review functionality. Please read the Template Documentation before you add a template, also please use the conventions below to make comments.

|Review=(delete as addressed)
* {{Comment|~~~~:}} Comment 1
* {{Comment|~~~~:}} Comment 2

Choosing Projects

We have a bi-weekly mentor meeting overlooked by our program management team, which are a core team of 2-3 mentors and a program administrator. This group will work with mentors to ensure that project proposals are of good quality and whether mentors are engaging with the program management team and particpants in the weeks before the application period ends.