7971
Comment:
|
9773
|
Deletions are marked like this. | Additions are marked like this. |
Line 5: | Line 5: |
We are looking for round 11 [:OutreachySponsor:funding sponsors] and Linux kernel [:OutreachyMentor:mentors]. Please see the linked FAQ pages if you want to help out. | The application period for '''Round 13''' will start on September 12, 2016. It's too early to send patches to the outreachy kernel mailing list, but please consider working through the other parts of the tutorial if you are interested in applying. |
Line 7: | Line 7: |
Welcome Outreachy applicants! Our [:OutreachySponsor:round 11 sponsors] have generiously donated funds for internships for women, genderqueer, genderfluid, or genderfree people, and residents and nationals of the United States of any gender who are Black/African American, Hispanic/Latino, American Indian, Alaska Native, Native Hawaiian, or Pacific Islander to work on the Linux kernel. The kernel is the most basic layer of the Linux operating system. It encompasses many things: hardware drivers, filesystems, security, task scheduling, and much more. | We are looking for round 13 [:OutreachySponsor:funding sponsors] and Linux kernel [:OutreachyMentor:mentors]. Please see the linked FAQ pages if you want to help out. Welcome Outreachy applicants! Our [:OutreachySponsor:round 13 sponsors] have generiously donated funds for internships for women, genderqueer, genderfluid, or genderfree people, and residents and nationals of the United States of any gender who are Black/African American, Hispanic/Latino, American Indian, Alaska Native, Native Hawaiian, or Pacific Islander to work on the Linux kernel. The kernel is the most basic layer of the Linux operating system. It encompasses many things: hardware drivers, filesystems, security, task scheduling, and much more. '''News''' This year, we ask that you send all patches to the appropriate staging driver maintainers, as well as to the outreachy mailing list. See [:FirstKernelPatch#submit_a_patch:Submit a patch] for more information. |
Line 10: | Line 14: |
The application period for Outreachy Round 11 is September 29 to November 2. Please fill your [https://live.gnome.org/OutreachProgramForWomen#Application_Process application] by '''November 2''', and complete your kernel patch by '''November 2''' also (7pm UTC on both dates). Applicants that do not complete the first patch will not be considered for an internship. Please take a look at our [:OutreachyApply:application FAQ] for more info on how to fill out your application. | The application period for Outreachy Round 13 is September 12 to October 17. Please fill your [https://live.gnome.org/OutreachProgramForWomen#Application_Process application] by '''October 17''', and complete your kernel patch by '''October 17''' also (7pm UTC in both cases). Applicants that do not complete the first patch will not be considered for an internship. Please take a look at our [:OutreachyApply:application FAQ] for more info on how to fill out your application. |
Line 15: | Line 19: |
* Join the #opw IRC channel on irc.gnome.org | * Join the #outreachy IRC channel on irc.gnome.org |
Line 17: | Line 21: |
* Read our [:OutreachyApply:instructions for applying], and apply by November 2. * Use our [:Outreachyfirstpatch:tutorial] to send in your first kernel patch by November 2. |
* Read our [:OutreachyApply:instructions for applying], and apply by October 17. * Use our [:Outreachyfirstpatch:tutorial] to send in your first kernel patch by October 17. |
Line 25: | Line 29: |
= Round 11 projects = Round 10 projects are available [:OutreachyRound10:here]. For each project, if you click on the proposer's name, you may find more information. |
= Round 13 projects = Previous projects, from round 12 projects are available [:OutreachyRound13:here]. For each project, if you click on the proposer's name, you may find more information. |
Line 28: | Line 32: |
== ADXL377 Triple Axis Accelerometer IIO driver == ''Mentor:'': [:OctavianPurdila:Octavian Purdila], [:DanielBaluta:Daniel Baluta] |
== Coccinelle == ''Mentor:'': [:JuliaLawall:Julia Lawall] Coccinelle is a program matching and transformation tool that has been extensively used for improving Linux kernel code. This project will involve using Coccinelle to address a security issue in the Linux kernel. The Linux kernel contains many data structures whose contents never change once they are initialized, many of which contain function pointers. Such structures that are modifiable at run time constitute a security risk, because an attacker may be able to overwrite the field value with a pointer to malicious code, that will then be executed with full kernel privileges. The first goal of this project is to use Coccinelle to insert const annotations on such structures to prevent runtime modfications. Some structures, however, cannot be made const, because they are initialized in several steps. In these cases, it may be possible to annotate the structure as {{{__ro_after_init}}}, if all of the initializations can take place during the init phase. The second goal is to add {{{__ro_after_init}}} where they are needed. This may requiring adding {{{__init}}} annotations on some code that is actually only needed during the init phase. More information about Coccinelle is available [http://coccinelle.lip6.fr/ here], including a [http://coccinelle.lip6.fr/papers/tutorial.pdf tutorial]. For some Coccinelle small tasks, click on the mentor name. == IIO driver == ''Mentor:'': [:AlisonSchofield:Alison Schofield] and [:DanielBaluta:Daniel Baluta] |
Line 33: | Line 46: |
The goal of this project is to write a driver for Analog Devices ADXL377 triple axis accelerometer using the Industrial I/O interface. In the first part of the project you will get familiar with the hardware and the IIO then implement raw readings from the device. After upstreaming the code we will enhance the driver with support for buffered readings, power management and interrupts. | The goal of this project is to write a driver for a sensor using the Industrial I/O interface. In the first part of the project you will get familiar with the hardware and the IIO subsystem then implement raw readings from the device. After upstreaming the code you will enhance the driver with advanced features such as support for buffered readings, power management and interrupts. The exact device will be decided when the internship starts. |
Line 35: | Line 48: |
We will provide you the hardware setup necessary to test the driver. == Staging driver cleanup == ''Mentor:'': [:GregKH:Greg Kroah-Hartman] This project will dive into a few specific drivers in the staging tree, doing more than just basic code formatting cleanup. The goal will be to help change the code to make it acceptable for merging into the "real" portion of the kernel. If possible, hardware will be provided for the code being worked on. |
We will provide you the hardware setup necessary to test the driver. If you are interested in this project please consider solving the [:IIO_tasks:IIO tasks]. |
Line 47: | Line 55: |
If you are interested in this project please consider solving any of the following tasks: * Request an account for the wiki.nftables.org page and help us improve the content. * Provide an iptables to nft translation via the iptables-translate utility. You can give a try to the following extensions: icmp, icmp6, rt. * Try to fix any of the existing nft bugs in bugzilla.netfilter.org. |
|
Line 49: | Line 63: |
== Ceph-related kernel code cleanup == | |
Line 51: | Line 64: |
''Mentor:'': [:AlexElder:Alex Elder] | == radix tree test suite == ''Mentors:'': [:RikvanRiel:Rik van Riel] and [:MatthewWilcox:Matthew Wilcox] |
Line 53: | Line 67: |
The Ceph project implements a scalable and fault-tolerant network based storage system. Portions of Ceph reside in the Linux kernel, presenting either a block device or a file system interface backed by Ceph storage accessed over the network. | The radix tree test suite (found in tools/testing/radix-tree) is currently rather ad-hoc. It would benefit from someone sorting through it, looking for missing coverage (maybe use gcov), and adding tests to exercise the missing functionality. This project involves working primarily in user-space as the kernel code is pulled into userspace and compiled there. |
Line 55: | Line 69: |
This project involves doing cleanup of the Ceph-related kernel code. The work will range from very easy fixes (like typo's and coding style) to more more substantive (refactoring functions and source files). Typically this kind of work identifies bugs as well, and if so those will be fixed (or at least documented). | We could also use performance tests (Konstantin Khlebnikov recently posted patches that adds one performance test) |
Line 57: | Line 71: |
== y2038 cleanup in drivers == | The radix tree test suite was adapted from outside the kernel tree recently, and does not yet share much of the common test infrastructure, eg tools/include/ |
Line 59: | Line 73: |
''Mentor:'' [:ArndBergmann:Arnd Bergmann] | |
Line 61: | Line 74: |
The concept of 'time' in Linux is encoded in many different ways, but the most common one is based on the 'time_t' type that counts the number of seconds that have passed since Jan 1, 1970. This type is currently defined as 'long', which on 32-bit systems is a signed 32-bit number that will overflow on Jan 19 2038 and likely cause existing systems to stop working, see http://en.wikipedia.org/wiki/Year_2038_problem. | == radix tree __alloc_fd == ''Mentors:'': [:RikvanRiel:Rik van Riel] and [:MatthewWilcox:Matthew Wilcox] |
Line 63: | Line 77: |
On 64-bit systems, the problem is solved for the most part because 'long' is a 64-bit number that will not overflow for billions of years, but there are some important missing pieces such as file systems that store time in 32-bit quantities on disk as well support for 32-bit user space binaries running on 64-bit kernels. | Currently sys_open() uses a linear search through a bitmap to find the first free file descriptor. This custom code could be replaced with the IDR interface. This replaces some custom code in the kernel with generic code (hopefully shrinking the size of the kernel), could result in some memory savings for processes with relatively few open files, and hopefully improve performance of workloads with very large numbers of open files. |
Line 65: | Line 79: |
Solving this problem in general is a huge effort involving lots of changes in the kernel as well as in user space. This project focuses on the kernel side, can be nicely split up into many small subtasks and is a prerequisite for doing the user space changes. There are currently 2003 instances of 'time_t', 'struct timespec' and 'struct timeval' in the kernel, and we are going to replace all of them with other types. | If you think you may be interested in this project, here are some small tasks to start with: * read how sys_open() currently finds the first open file descriptor, and allocates/resizes the file descriptor table * understand the IDR API * email Matthew and Rik a description of your findings, and a proposed project time line |
Line 67: | Line 84: |
Any isolated in-kernel uses of these types can be replaced with 'ktime_t' or 'struct timespec64'. For any interface to user space (typically an ioctl command or a system call) that passes a data structure based on these types, we have to keep the existing interface working and introduce an alternative interface that can be used by newly built user space programs. | If you have any questions, please email Matthew and Rik. |
Line 69: | Line 86: |
[:y2038:] has a deeper introduction to the topic and will be updated with more detailed subtasks over time. | == radix tree PID allocation == ''Mentors:'': [:RikvanRiel:Rik van Riel] and [:MatthewWilcox:Matthew Wilcox] The PID allocator is a good match for the IDR API, but it currently uses its own custom allocator. Similar to the {{{__alloc_fd}}} project above, after understanding the IDR API, read how alloc_pid() works (paying particular attention to PID namespaces!) and come up with a project plan. |
Line 80: | Line 101: |
* Join the #opw IRC channel on irc.gnome.org | * Join the #outreachy IRC channel on irc.gnome.org |
Line 82: | Line 103: |
* Read our [:OutreachyApply:instructions for applying], and apply by November 2. * Use our [:Outreachyfirstpatch:tutorial] to send in your first kernel patch by November 2. * After you have sent several cleanup patches and at least one patchset, choose a [:OutreachyTasks:small task] to complete. |
* Read our [:OutreachyApply:instructions for applying], and apply by October 17. * Use our [:Outreachyfirstpatch:tutorial] to send in your first kernel patch by October 17. * After you have 10 cleanup patches and at least two patchsets, choose some [:OutreachyTasks:small tasks] to complete. |
Outreachy (formerly FOSS Outreach Program for Women (OPW) and Project Ascend Alumni)
Please see the [https://www.gnome.org/outreachy/ Outreachy homepage] for an introduction to the program.
The application period for Round 13 will start on September 12, 2016. It's too early to send patches to the outreachy kernel mailing list, but please consider working through the other parts of the tutorial if you are interested in applying.
We are looking for round 13 [:OutreachySponsor:funding sponsors] and Linux kernel [:OutreachyMentor:mentors]. Please see the linked FAQ pages if you want to help out.
Welcome Outreachy applicants! Our [:OutreachySponsor:round 13 sponsors] have generiously donated funds for internships for women, genderqueer, genderfluid, or genderfree people, and residents and nationals of the United States of any gender who are Black/African American, Hispanic/Latino, American Indian, Alaska Native, Native Hawaiian, or Pacific Islander to work on the Linux kernel. The kernel is the most basic layer of the Linux operating system. It encompasses many things: hardware drivers, filesystems, security, task scheduling, and much more.
News This year, we ask that you send all patches to the appropriate staging driver maintainers, as well as to the outreachy mailing list. See [:FirstKernelPatch#submit_a_patch:Submit a patch] for more information.
How to apply
The application period for Outreachy Round 13 is September 12 to October 17. Please fill your [https://live.gnome.org/OutreachProgramForWomen#Application_Process application] by October 17, and complete your kernel patch by October 17 also (7pm UTC in both cases). Applicants that do not complete the first patch will not be considered for an internship. Please take a look at our [:OutreachyApply:application FAQ] for more info on how to fill out your application.
If you are interested in being a Linux kernel intern, please:
Join the [https://groups.google.com/forum/#!forum/outreachy-kernel outreachy-kernel mailing list]
- Join the #outreachy IRC channel on irc.gnome.org
- Join the #kernel-outreachy IRC channel on irc.oftc.net
Read our [:OutreachyApply:instructions for applying], and apply by October 17.
Use our [:Outreachyfirstpatch:tutorial] to send in your first kernel patch by October 17.
Participating Linux kernel projects
Applicants for all projects should have basic experience with C or C++ and boolean algebra. Optionally, we would love it if you have basic operating system knowledge, know your way around a Linux/UNIX command line, and/or know the revision system called git. Please note that these three skills can be learned during the internship.
Some projects may have small tasks you can complete as part of the application process. Do not start on these tasks until after you complete the [:Outreachyfirstpatch:first patch tutorial] and Greg Kroah-Hartman has accepted at least ten of your cleanup patches and two of your patchsets. In order to ensure applicants aren't working on the same task, we need your help in coordinating who is working on what task. Please see the [:OutreachyTasks:Outreachy tasks page] for details before starting on a task!
Round 13 projects
Previous projects, from round 12 projects are available [:OutreachyRound13:here]. For each project, if you click on the proposer's name, you may find more information.
Coccinelle
Mentor:: [:JuliaLawall:Julia Lawall]
Coccinelle is a program matching and transformation tool that has been extensively used for improving Linux kernel code. This project will involve using Coccinelle to address a security issue in the Linux kernel.
The Linux kernel contains many data structures whose contents never change once they are initialized, many of which contain function pointers. Such structures that are modifiable at run time constitute a security risk, because an attacker may be able to overwrite the field value with a pointer to malicious code, that will then be executed with full kernel privileges. The first goal of this project is to use Coccinelle to insert const annotations on such structures to prevent runtime modfications. Some structures, however, cannot be made const, because they are initialized in several steps. In these cases, it may be possible to annotate the structure as __ro_after_init, if all of the initializations can take place during the init phase. The second goal is to add __ro_after_init where they are needed. This may requiring adding __init annotations on some code that is actually only needed during the init phase.
More information about Coccinelle is available [http://coccinelle.lip6.fr/ here], including a [http://coccinelle.lip6.fr/papers/tutorial.pdf tutorial]. For some Coccinelle small tasks, click on the mentor name.
IIO driver
Mentor:: [:AlisonSchofield:Alison Schofield] and [:DanielBaluta:Daniel Baluta]
A driver allows applications to communicate and control hardware devices. Each development cycle, driver changes account for more than a half of the total Linux kernel code changes.
The goal of this project is to write a driver for a sensor using the Industrial I/O interface. In the first part of the project you will get familiar with the hardware and the IIO subsystem then implement raw readings from the device. After upstreaming the code you will enhance the driver with advanced features such as support for buffered readings, power management and interrupts. The exact device will be decided when the internship starts.
We will provide you the hardware setup necessary to test the driver. If you are interested in this project please consider solving the [:IIO_tasks:IIO tasks].
nftables
Mentor:: [:pablo:Pablo Neira Ayuso]
nftables provides a replacement for the very popular {ip,ip6,arp,eb}tables tools. nftables reuses most of the Netfilter components such as the existing hooks, connection tracking system, NAT, userspace queueing, logging among many other features. So we have only replaced the packet classification framework. nftables comes with a new userspace utility nft and the low-level userspace library libnftnl. The goal will be to help finish the translation layer software that converts from the iptables syntax to nftables, complete some simple missing features and fixing bugs whenever possible.
If you are interested in this project please consider solving any of the following tasks:
- Request an account for the wiki.nftables.org page and help us improve the content.
- Provide an iptables to nft translation via the iptables-translate utility. You can give a try to the following extensions: icmp, icmp6, rt.
- Try to fix any of the existing nft bugs in bugzilla.netfilter.org.
For more information on nftables, please check: http://wiki.nftables.org
radix tree test suite
Mentors:: [:RikvanRiel:Rik van Riel] and [:MatthewWilcox:Matthew Wilcox]
The radix tree test suite (found in tools/testing/radix-tree) is currently rather ad-hoc. It would benefit from someone sorting through it, looking for missing coverage (maybe use gcov), and adding tests to exercise the missing functionality. This project involves working primarily in user-space as the kernel code is pulled into userspace and compiled there.
We could also use performance tests (Konstantin Khlebnikov recently posted patches that adds one performance test)
The radix tree test suite was adapted from outside the kernel tree recently, and does not yet share much of the common test infrastructure, eg tools/include/
radix tree __alloc_fd
Mentors:: [:RikvanRiel:Rik van Riel] and [:MatthewWilcox:Matthew Wilcox]
Currently sys_open() uses a linear search through a bitmap to find the first free file descriptor. This custom code could be replaced with the IDR interface. This replaces some custom code in the kernel with generic code (hopefully shrinking the size of the kernel), could result in some memory savings for processes with relatively few open files, and hopefully improve performance of workloads with very large numbers of open files.
If you think you may be interested in this project, here are some small tasks to start with:
- read how sys_open() currently finds the first open file descriptor, and allocates/resizes the file descriptor table
- understand the IDR API
- email Matthew and Rik a description of your findings, and a proposed project time line
If you have any questions, please email Matthew and Rik.
radix tree PID allocation
Mentors:: [:RikvanRiel:Rik van Riel] and [:MatthewWilcox:Matthew Wilcox]
The PID allocator is a good match for the IDR API, but it currently uses its own custom allocator. Similar to the __alloc_fd project above, after understanding the IDR API, read how alloc_pid() works (paying particular attention to PID namespaces!) and come up with a project plan.
Project
Mentor:: [:WikiName:Mentor names]
Brief project description.
Yeah, that sounds cool!
If you are interested in being a Linux kernel intern, please:
Join the [https://groups.google.com/forum/#!forum/outreachy-kernel outreachy-kernel mailing list]
- Join the #outreachy IRC channel on irc.gnome.org
- Join the #kernel-outreachy IRC channel on irc.oftc.net
Read our [:OutreachyApply:instructions for applying], and apply by October 17.
Use our [:Outreachyfirstpatch:tutorial] to send in your first kernel patch by October 17.
After you have 10 cleanup patches and at least two patchsets, choose some [:OutreachyTasks:small tasks] to complete.