Outreach Program Projects: Difference between revisions
From Xen
Jump to navigationJump to search
(Add myself to mentor of Rust libxl binding project) |
(Remove finished projects) |
||
| Line 100: | Line 100: | ||
|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. |
||
|GSoC=yes}} |
|GSoC=yes}} |
||
{{project |
|||
|Project=Add PVH mode support to OVMF (UEFI) |
|||
|Date=18/02/2016 |
|||
|Verified=18/02/2016 |
|||
|Difficulty=Medium |
|||
|Contact=Roger Pau Monné <roger.pau@citrix.com>; make sure you CC xen-devel@lists.xenproject.org on all communications |
|||
|Skills=Strong C skills, x86 architecture knowledge. |
|||
|GSoC=Yes |
|||
|Desc=OVMF already has quite a lot of Xen support, including a xenstore, grant-table, xenbus and blkfront implementations. The applicant should be able to leverage all this features in order to create a OVMF binary that’s capable of running as a PVH guest. The student is expected to complete the following tasks: |
|||
* Add support for the PVH entry point to OVMF. |
|||
* Detect which devices OVMF makes use of (local APIC, uart…). |
|||
* Replace the usage of the emulated devices that are not available with their para-virtualized counterparts. |
|||
In order to complete this tasks the student will need to read and understand the [http://lists.xenproject.org/archives/html/xen-devel/2016-02/msg01609.html PVH interface draft ]. It’s also important to notice that [https://svnweb.freebsd.org/base/head/sys/dev/xen/ FreeBSD contains the implementation] of all the needed para-virtualized devices under a BSD license, which is compatible with the license used by OVMF. |
|||
|Outcomes=By the end of the project OVMF should work as a PVH kernel, and should be capable of loading other PVH capable guests/firmwares. |
|||
}} |
|||
{{project |
{{project |
||
| Line 133: | Line 115: | ||
=== Xen Toolstack === |
=== Xen Toolstack === |
||
{{project |
|||
|Project=QEMU xen-blkback performance analysis and improvements |
|||
|Date=15/02/2016 |
|||
|Verified=15/02/2016 |
|||
|Difficulty=Medium |
|||
|Contact=Roger Pau Monné <roger.pau@citrix.com>; make sure you CC xen-devel@lists.xenproject.org on all communications |
|||
|Skills=Strong C skills, ability to read and understand a protocol |
|||
|GSoC=Yes |
|||
|Desc=The current xen-blkback implementation inside of QEMU is lacking several features found in the in-kernel Linux xen-blkback implementation. The student should analyze the bottlenecks currently found in QEMU, and provide solutions in order to reduce them. Some of them might involve: |
|||
* <del>Use grant-copy instead of grant-map.</del> ([http://git.qemu.org/?p=qemu.git;a=commit;h=b6eb9b45f7307638ff166401721ae6d0401e1d67 DONE]) |
|||
* Implement support for indirect descriptors. |
|||
* Implement multi-queue support. |
|||
There's a reference implementation of the last two items in the [http://lxr.free-electrons.com/source/drivers/block/xen-blkback/blkback.c xen-blkback code in Linux], and a technical document that describes the protocol extensions in the [http://xenbits.xen.org/gitweb/?p=xen.git;a=blob;f=xen/include/public/io/blkif.h Xen public headers]. |
|||
|Outcomes=By the end of the project, the student should provide a detailed performance analysis of the block backend inside of QEMU, and implemented at least one performance improvement of a sizeable magnitude or several smaller ones. |
|||
}} |
|||
=== Xen Hypervisor === |
=== Xen Hypervisor === |
||
Revision as of 10:43, 10 February 2017
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 slightly 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 https://www.xenproject.org/help/contribution-guidelines.html#coverity Coverity Scan issues].
- Note that you will not be allowed to access Coverity scan logs. This is, because the Coverity service may discover security issues that have to be handled in compliance with our responsible disclosure practices as described in Xen Security Problem Response Process. Thus, the full database of issues cannot simply be made public.
- You have to 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 Outreachy <round> 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
{{project
...
|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
golang bindings for libxl
|
KDD (Windows Debugger Stub) enhancements
|
Rust bindings for libxl
|
Xen Toolstack
Xen Hypervisor
Fuzzing Xen hypercall interface
|
Rump Kernel
|
To Do:
We discussed a number of options for rump kernel relatedr projects, but need to ensure that these are suitable for applicants and will add them shortly. If you are interested in rump kernel projects, please make a request on xen-devel@lists.xenproject.org. |
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.
XAPI
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
|
Add Centos Virt SIG Xen packages test to the CentOS CI loop
|
Code Standards Checking using clang-format
|
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.
