Difference between revisions of "Outreach Program Projects"
(→Xen Hypervisor) |
Lars.kurth (talk | contribs) |
||
(4 intermediate revisions by 3 users not shown) | |||
Line 3: | Line 3: | ||
The Xen Project is a Linux Foundation collaborative project that develops the |
The Xen Project is a Linux Foundation collaborative project that develops the |
||
− | * Xen Hypervisor (for x86 and ARM) - the bulk of this page |
+ | * Xen Hypervisor (for x86 and ARM) - the bulk of this page. IRC channel #xendevel |
− | * |
+ | * Unikraft (see [[#Unikraft]]). IRC channel #unikraft |
− | * Mirage OS (see [[# |
+ | * Mirage OS (see [[#Mirage_OS]]). IRC channel #mirage |
* 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]] |
* 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. |
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 === |
=== Finding a project that fits you === |
||
− | This page lists Xen Project development projects for Outreachy (formerly the Outreach Program for Women) |
+ | This page lists Xen Project development projects for Google Summer of Code and Outreachy (formerly the Outreach Program for Women). But projects 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:''' |
'''To work on a project:''' |
||
* Send an email to the relevant [http://www.xenproject.org/help/mailing-list.html mailing list] (see '''Developer Mailing Lists''') and let us know if you are interested in starting to work or applying on a specific project. |
* Send an email to the relevant [http://www.xenproject.org/help/mailing-list.html 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 [http://www.xenproject.org/help/mailing-list.html mailing list] sooner than later so you can get comments and feedback. |
* Post your ideas, questions, RFCs to the relevant [http://www.xenproject.org/help/mailing-list.html mailing list] sooner than later so you can get comments and feedback. |
||
− | * |
+ | * 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]. |
+ | * '''Small Contribution Requirement''': Outreachy requires that youfulfil the [https://wiki.gnome.org/Outreachy#Make_a_Small_Contribution Make a Small Code Contribution Requirement]. This is not strictly necessary for GSoC, but a small contribution to the project during the application period gives you an advantage |
||
− | ** 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 [http://www.xenproject.org/security-policy.html Xen Security Problem Response Process]. Thus, the full database of issues cannot simply be made public. |
||
− | ** You have to ask on [http://www.xenproject.org/help/mailing-list.html xen-devel@] for a set of suitable issues and later you may ask for [http://www.xenproject.org/help/contribution-guidelines.html access to coverity scan] or for a bug on [http://bugs.xenproject.org/xen/ /bugs.xenproject.org]. |
||
'''You have your own project idea: no problem!''' |
'''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 [http://www.xenproject.org/help/mailing-list.html 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. |
+ | * 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 [http://www.xenproject.org/help/mailing-list.html mailing list]. Failing that post on xen-devel and we can redirect you to the right list. Make sure you add '''Outreachy <round>''' or '''GSoC <year>''' to the subject line. |
'''It is a good idea to ...'''<br> |
'''It is a good idea to ...'''<br> |
||
− | The Xen Project has |
+ | The Xen Project has participated in Outreachy 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 |
* Contact your mentor early and get to know him or her |
||
− | * Start hanging out on our IRC |
+ | * Start hanging out on our IRC channels (#xendevel, #unikraft, #mirage) |
* 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 [http://www.xenproject.org/help/mailing-list.html 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. |
* 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 [http://www.xenproject.org/help/mailing-list.html 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. |
* 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). |
+ | * 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). 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 ==== |
==== More resources ==== |
||
Line 64: | Line 63: | ||
--> |
--> |
||
− | == Projects completed in 2017 == |
||
− | |||
− | {{ProjectComplete |
||
− | |Project=Fuzzing Xen hypercall interface |
||
− | |Acknowledgement=This project was completed by '''Felix Schmoll''' |
||
− | |Refs=For more information see |
||
− | * [https://blog.xenproject.org/2017/08/25/my-gsoc-experience-fuzzing-the-hypervisor/ My GSoC experience: Fuzzing the hypervisor] |
||
− | * [https://lists.xen.org/archives/html/xen-devel/2017-08/msg01960.html Technical Summary of project] |
||
− | * [https://summerofcode.withgoogle.com/archive/2017/projects/6343132106981376/ GSoC 2017] |
||
− | |Date=8/02/2017 |
||
− | |Verified=8/2/2017 |
||
− | |Difficulty=Very high |
||
− | |Contact=Wei Liu <wei.liu2@citrix.com>; make sure you CC xen-devel@lists.xenproject.org on all communications; tag mails with [GSoC] or [Outreachy] as appropriate |
||
− | |Skills=Strong C and ASM skills, good knowledge of GCC toolchain, good knowledge of GNU Make, good knowledge of fuzzing in general, good kernel programming and user space programming skills |
||
− | |GSoC=Yes (accepted in 2017 - see https://summerofcode.withgoogle.com/dashboard/project/5585891117498368/overview/) |
||
− | |Desc=The Xen Project has been using American Fuzzy Lop (AFL) for fuzzing and achieve useful results. Up until now we've only been able to adapt some Xen components to be fuzzed in a userspace program. There is untapped potential in using AFL (or other fuzzers) to fuzz hypercall interface. AFL (and other coverage guided fuzzers) requires feedback from the fuzzing target to mutate test cases. Xen does not yet have the ability to return precise execution path. |
||
− | |||
− | * Create a small domain or program to accept command from fuzzer, execute test case etc. |
||
− | * Use GCC coverage support to give back precise execution path. |
||
− | * Massage and feed the input back to fuzzer. |
||
− | |||
− | |||
− | '''Related open source technologies and repositories''': |
||
− | * [http://lcamtuf.coredump.cx/afl/ AFL home page] (and [http://lcamtuf.coredump.cx/afl/README.txt README]) |
||
− | * [http://events.linuxfoundation.org/sites/events/files/slides/AFL%20filesystem%20fuzzing%2C%20Vault%202016_0.pdf Shows how conceptually similar problems have been solved elsewhere] |
||
− | |||
− | |||
− | |Outcomes=A system for fuzzing Xen hypercall interface. |
||
− | }} |
||
− | |||
− | {{ProjectComplete |
||
− | |Project=Share a page in memory from the VM config file |
||
− | |Acknowledgement=This project was completed by '''Zhongze Liu''' |
||
− | |Refs=For more information see |
||
− | * [https://blog.xenproject.org/2017/08/29/my-gsoc-experience-allow-setting-up-shared-memory-regions-between-vms-from-xl-config-file/ My GSoC Experience: Allow Setting up Shared Memory Regions between VMs from xl Config File] |
||
− | * [https://summerofcode.withgoogle.com/archive/2017/projects/5356246735519744/ GSoC 2017] |
||
− | |Date=28/02/2017 |
||
− | |Verified=28/2/2017 |
||
− | |Difficulty=Average |
||
− | |Contact=Stefano Stabellini <sstabellini@kernel.org>; Julien Grall <julien.grall@arm.com>; make sure you CC xen-devel@lists.xenproject.org on all communications; tag mails with [GSoC] or [Outreachy] as appropriate |
||
− | |Skills=Good C and kernel programming skills |
||
− | |GSoC=Yes (2017) |
||
− | |Desc= |
||
− | |||
− | Virtual machines use grant table hypercalls to setup a share page for inter-VMs communications. These hypercalls are used by all PV protocols today. However, very simple guests, such as baremetal applications, might not have the infrastructure to handle the grant table. This project is about setting up a shared page for inter-VMs communications directly from the VM config file. So that the guest kernel doesn't have to have grant table support to be able to communicate with other guests. |
||
− | |||
− | * introduce a new VM config option in xl |
||
− | * allocate a page in memory and add it to the VM stage2 pagetable at a given address |
||
− | * the page should be shareable with other virtual machines |
||
− | |||
− | |Outcomes=A new VM config file option is introduced to share a page in memory across multiple guests |
||
− | }} |
||
== List of peer reviewed Projects == |
== List of peer reviewed Projects == |
||
Line 223: | Line 170: | ||
{{project |
{{project |
||
− | |Project=Performance Counters Virtualization |
+ | |Project=Xen on ARM: Performance Counters Virtualization |
|Date=2019/02/01 |
|Date=2019/02/01 |
||
|Verified=2019/02/01 |
|Verified=2019/02/01 |
||
Line 238: | Line 185: | ||
<br> |
<br> |
||
− | |||
− | === Mini-OS === |
||
− | |||
− | Mini-OS is a very small kernel being designed to run as a domU under Xen (either PV or PVH mode). It is primarily being used as the base for '''stubdoms''' e.g. to run grub, xenstore or qemu in paravirtualized mode in a dedicated domain. Mini-OS is multi-threaded and contains a basic memory management, some Xen backend drivers and a libc-like interface to applications which are linked directly with the kernel. |
||
− | |||
− | '''Related open source technologies and repositories''': |
||
− | * [[Mini-OS]] |
||
− | * [[Mini-OS-DevNotes|A tour of Mini-OS]] |
||
− | * [http://xenbits.xen.org/gitweb/?p=mini-os.git;a=summary Mini-OS git tree] |
||
− | |||
− | Mini-OS is an excellent starting point for low-level kernel development: It is rather small and debugging it isn't very complicated as it is running as a Xen guest (you can look into it from the host and a complete test/debug/correction cycle may be well under one minute). |
||
− | |||
− | {{project |
||
− | |Project=Adding Floating Point support to Mini-OS |
||
− | |Date=28/02/2017 |
||
− | |Verified=28/2/2017 |
||
− | |Difficulty=Medium |
||
− | |Contact=Juergen Gross <jgross@suse.com>; make sure you CC xen-devel@lists.xenproject.org AND minios-devel@lists.xenproject.org on all communications; tag mails with [GSoC] or [Outreachy] as appropriate |
||
− | |Skills=good C and ASM skills, knowledge of GCC toolchain, good kernel programming skills, good skills in understanding hardware documentation |
||
− | |GSoC=Yes |
||
− | |Desc=Currently Mini-OS has no support for using any Floating Point registers. This means no application needing more than one thread and using FP operations can be used with Mini-OS. Adding FP support to Mini-OS will remove that limitation. |
||
− | |||
− | * Create a small multi-thread test application for Mini-OS using FP registers to verify the lack of support. |
||
− | * Add FP register saving/restoring when switching threads. |
||
− | * Verify that the test application is working now. |
||
− | |||
− | |Outcomes=Full FP-support in Mini-OS. |
||
− | }} |
||
− | |||
− | {{project |
||
− | |Project=Add logging to a dom0 file support to Mini-OS |
||
− | |Date=28/02/2017 |
||
− | |Verified=28/2/2017 |
||
− | |Difficulty=Medium |
||
− | |Contact=Juergen Gross <jgross@suse.com>; make sure you CC xen-devel@lists.xenproject.org AND minios-devel@lists.xenproject.org on all communications; tag mails with [GSoC] or [Outreachy] as appropriate |
||
− | |Skills=good C, knowledge of GCC toolchain, good user and kernel programming skills |
||
− | |GSoC=Yes |
||
− | |Desc=The Xenstore domain is using Mini-OS as its kernel. The main lack of functionality compared to the Xenstore daemon in dom0 is the missing logging capability in order to find problems in e.g. strange behaving guests. |
||
− | |||
− | The easiest way to support such a logging capability would be the usage of a paravirtualized channel. Its frontend would connect to the file interface in Mini-OS, while the backend in dom0 should write the data sent via the channel to a file. |
||
− | |||
− | * Add the needed configuration items to libxl. |
||
− | * Add the missing items to Mini-OS. |
||
− | * Modify Xenstore domain configuration to make use of the feature. |
||
− | |||
− | '''Related open source technologies and repositories''': |
||
− | * [[XenStore]] and [[XenStore_Reference]] |
||
− | |||
− | |Outcomes=Logging support in Mini-OS, especially for Xenstore domain. |
||
− | }} |
||
=== Unikraft === |
=== Unikraft === |
||
Line 423: | Line 320: | ||
|Desc=The CentOS project has a continuous integration (CI) system running Jenkins, which can automatically run a set of tests when specific conditions are met, such as new versions of packages being available on the CentOS community build system (CBS). The CentOS Virtualization SIG ('Special Interest Group') produces Xen packages for CentOS 6 and 7, along with other related packages (such as libvirt). The goal of this project would be to add tests to this system to test the basic functionality of the Xen packages produced by the CentOS Virt SIG, helping to avoid regressions in released software. |
|Desc=The CentOS project has a continuous integration (CI) system running Jenkins, which can automatically run a set of tests when specific conditions are met, such as new versions of packages being available on the CentOS community build system (CBS). The CentOS Virtualization SIG ('Special Interest Group') produces Xen packages for CentOS 6 and 7, along with other related packages (such as libvirt). The goal of this project would be to add tests to this system to test the basic functionality of the Xen packages produced by the CentOS Virt SIG, helping to avoid regressions in released software. |
||
|Outcomes=An appropriate array of tests for xen (and ideally libvirt) packages running in the CentOS CI loop. |
|Outcomes=An appropriate array of tests for xen (and ideally libvirt) packages running in the CentOS CI loop. |
||
− | }} |
||
− | |||
− | {{project |
||
− | |Project=Code Standards Checking using clang-format |
||
− | |Date=18/02/2016 |
||
− | |Verified=18/02/2016 |
||
− | |Difficulty=Easy |
||
− | |Contact=Doug Goldstein <cardoe@cardoe.com>; make sure you CC xen-devel@lists.xenproject.org on all communications; tag mails with [GSoC] or [Outreachy] as appropriate |
||
− | |Skills=clang-format, shell scripting (to skip files), potentially C++ to extend clang-format |
||
− | |GSoC=Yes |
||
− | |Desc=The Xen Project has a coding standard in place but like many projects the standard is only enforced through peer review. As such mistakes slip through and code is imported from other projects |
||
− | which may not follow the same standard. The goal would be to come up with a script that can audit the code base as part of a CI loop for code style inconsistencies and potentially provide corrections. This project would start on one part of the tree and then move on through each component. |
||
− | |Outcomes=A script that can be used to check some (or all of the tree) for code style standards violations. |
||
− | |||
− | '''Related open source technologies and repositories''': |
||
− | * [http://xenbits.xen.org/gitweb/?p=xen.git;a=blob;f=CODING_STYLE Primary Coding Standard in Xen] |
||
− | * [http://xenbits.xen.org/gitweb/?p=xen.git;a=blob;f=tools/libxl/CODING_STYLE LIBXL Coding Standard in Xen] |
||
− | * [http://clang.llvm.org/ Information on clang] (also see [http://clang.llvm.org/docs/Tooling.html] & [http://clang.llvm.org/docs/ClangTools.html]) |
||
− | * [https://opensource.com/article/17/1/coding-style Using Clang-format to ensure clean, consistent code] |
||
}} |
}} |
||
Line 501: | Line 379: | ||
=== Choosing Projects === |
=== 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. |
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. |
||
+ | |||
+ | == Projects completed in 2017 == |
||
+ | |||
+ | {{ProjectComplete |
||
+ | |Project=Fuzzing Xen hypercall interface |
||
+ | |Acknowledgement=This project was completed by '''Felix Schmoll''' |
||
+ | |Refs=For more information see |
||
+ | * [https://blog.xenproject.org/2017/08/25/my-gsoc-experience-fuzzing-the-hypervisor/ My GSoC experience: Fuzzing the hypervisor] |
||
+ | * [https://lists.xen.org/archives/html/xen-devel/2017-08/msg01960.html Technical Summary of project] |
||
+ | * [https://summerofcode.withgoogle.com/archive/2017/projects/6343132106981376/ GSoC 2017] |
||
+ | |Date=8/02/2017 |
||
+ | |Verified=8/2/2017 |
||
+ | |Difficulty=Very high |
||
+ | |Contact=Wei Liu <wei.liu2@citrix.com>; make sure you CC xen-devel@lists.xenproject.org on all communications; tag mails with [GSoC] or [Outreachy] as appropriate |
||
+ | |Skills=Strong C and ASM skills, good knowledge of GCC toolchain, good knowledge of GNU Make, good knowledge of fuzzing in general, good kernel programming and user space programming skills |
||
+ | |GSoC=Yes (accepted in 2017 - see https://summerofcode.withgoogle.com/dashboard/project/5585891117498368/overview/) |
||
+ | |Desc=The Xen Project has been using American Fuzzy Lop (AFL) for fuzzing and achieve useful results. Up until now we've only been able to adapt some Xen components to be fuzzed in a userspace program. There is untapped potential in using AFL (or other fuzzers) to fuzz hypercall interface. AFL (and other coverage guided fuzzers) requires feedback from the fuzzing target to mutate test cases. Xen does not yet have the ability to return precise execution path. |
||
+ | |||
+ | * Create a small domain or program to accept command from fuzzer, execute test case etc. |
||
+ | * Use GCC coverage support to give back precise execution path. |
||
+ | * Massage and feed the input back to fuzzer. |
||
+ | |||
+ | |||
+ | '''Related open source technologies and repositories''': |
||
+ | * [http://lcamtuf.coredump.cx/afl/ AFL home page] (and [http://lcamtuf.coredump.cx/afl/README.txt README]) |
||
+ | * [http://events.linuxfoundation.org/sites/events/files/slides/AFL%20filesystem%20fuzzing%2C%20Vault%202016_0.pdf Shows how conceptually similar problems have been solved elsewhere] |
||
+ | |||
+ | |||
+ | |Outcomes=A system for fuzzing Xen hypercall interface. |
||
+ | }} |
||
+ | |||
+ | {{ProjectComplete |
||
+ | |Project=Share a page in memory from the VM config file |
||
+ | |Acknowledgement=This project was completed by '''Zhongze Liu''' |
||
+ | |Refs=For more information see |
||
+ | * [https://blog.xenproject.org/2017/08/29/my-gsoc-experience-allow-setting-up-shared-memory-regions-between-vms-from-xl-config-file/ My GSoC Experience: Allow Setting up Shared Memory Regions between VMs from xl Config File] |
||
+ | * [https://summerofcode.withgoogle.com/archive/2017/projects/5356246735519744/ GSoC 2017] |
||
+ | |Date=28/02/2017 |
||
+ | |Verified=28/2/2017 |
||
+ | |Difficulty=Average |
||
+ | |Contact=Stefano Stabellini <sstabellini@kernel.org>; Julien Grall <julien.grall@arm.com>; make sure you CC xen-devel@lists.xenproject.org on all communications; tag mails with [GSoC] or [Outreachy] as appropriate |
||
+ | |Skills=Good C and kernel programming skills |
||
+ | |GSoC=Yes (2017) |
||
+ | |Desc= |
||
+ | |||
+ | Virtual machines use grant table hypercalls to setup a share page for inter-VMs communications. These hypercalls are used by all PV protocols today. However, very simple guests, such as baremetal applications, might not have the infrastructure to handle the grant table. This project is about setting up a shared page for inter-VMs communications directly from the VM config file. So that the guest kernel doesn't have to have grant table support to be able to communicate with other guests. |
||
+ | |||
+ | * introduce a new VM config option in xl |
||
+ | * allocate a page in memory and add it to the VM stage2 pagetable at a given address |
||
+ | * the page should be shareable with other virtual machines |
||
+ | |||
+ | |Outcomes=A new VM config file option is introduced to share a page in memory across multiple guests |
||
+ | }} |
||
[[Category:Developers]] |
[[Category:Developers]] |
Revision as of 12:25, 6 February 2019
Contents
- 1 Finding a project that fits you
- 2 Aspiring Participants
- 3 Outreach Program Project Ideas
- 4 List of peer reviewed Projects
- 5 New Project Ideas
- 6 Conventions for Projects and Project Mentors
- 7 Projects completed in 2017
The Xen Project is a Linux Foundation collaborative project that develops the
- Xen Hypervisor (for x86 and ARM) - the bulk of this page. IRC channel #xendevel
- Unikraft (see #Unikraft). IRC channel #unikraft
- Mirage OS (see #Mirage_OS). IRC channel #mirage
- 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 Google Summer of Code and Outreachy (formerly the Outreach Program for Women). But projects 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:
- 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.
- 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.
- Small Contribution Requirement: Outreachy requires that youfulfil the Make a Small Code Contribution Requirement. This is not strictly necessary for GSoC, but a small contribution to the project during the application period gives you an advantage
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> or GSoC <year> to the subject line.
It is a good idea to ...
The Xen Project has participated in Outreachy 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 channels (#xendevel, #unikraft, #mirage)
- 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). 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
|
Xen Toolstack
Xen Hypervisor
Xen on ARM: Trap & sanitize ID registers (ID_PFR0, ID_DFR0, etc)
|
Xen on ARM, dom0less: configurable memory layout for guests
|
ARMv8.1 atomics
|
Xen on ARM: dynamic virtual memory layout
|
Xen on ARM: Performance Counters Virtualization
|
Unikraft
Unikraft is a Unikernel build system that enables developers to build light-weight services starting from a highly customizable library base. This library base includes core libraries which provide decomposed OS functionality (e.g., schedulers, memory allocators, etc.) and enhanced libraries that provide functionality to Unikernels that is often required by applications (e.g., libC, network stacks). For instance, on x86_64 Unikraft is able to automatically generate a (Micro)-python unikernel weighing in at only ~700KBs.
For more information please checkout: [1]
New Platform Support
|
FreeBSD's Network Stack Port
|
Go Language Support
|
Enhanced Profiling and Tracing Support
|
Mirage OS
Several different projects (follow link)
For Mirage OS, please check out the list of Mirage OS projects where help is needed. 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.
Add Centos Virt SIG Xen packages test to the CentOS CI loop
|
Add more FreeBSD testing to osstest
|
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.
Projects completed in 2017
Fuzzing Xen hypercall interfaceThis project was completed by Felix Schmoll For more information see
|
This project was completed by Zhongze Liu For more information see
|