|
Size: 2635
Comment:
|
Size: 9149
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| = Outreach Program for Women (OPW) = | ## page was renamed from OPWIntro = 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. |
| Line 3: | Line 5: |
| The Linux Foundation is sponsoring internships for women to work on the Linux kernel. The kernel is the most basic layer of the Linux operating system. The kernel encompasses many things: hardware drivers, filesystems, security, task scheduling, and much more. | '''Round 12''' is coming up soon. 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 intersted in applying. |
| Line 5: | Line 7: |
| == Participating kernel projects == | We are looking for round 12 [:OutreachySponsor:funding sponsors] and Linux kernel [:OutreachyMentor:mentors]. Please see the linked FAQ pages if you want to help out. |
| Line 7: | Line 9: |
| Currently, we have two participating projects. | 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. |
| Line 9: | Line 11: |
| === USB === | = How to apply = The application period for Outreachy Round 12 is February 9 to March 22. Please fill your [https://live.gnome.org/OutreachProgramForWomen#Application_Process application] by '''March 22''', and complete your kernel patch by '''March 22''' 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 11: | Line 14: |
| The Linux kernel includes a USB stack that communicates with the hardware behind your USB ports (USB host controller drivers), and includes USB device drivers that talk to your USB devices (USB device drivers). Working on USB is fun because you get to make all sorts of interesting USB devices work. | If you are interested in being a Linux kernel intern, please: |
| Line 13: | Line 16: |
| Sarah Sharp is sponsoring an intern to work on the USB 3.0 host controller driver. The Linux kernel USB 3.0 driver was introduced in 2009, and works 10 times faster than USB 2.0 devices. The USB 3.0 driver still needs a lot of work, so there are plenty of small bug fixes that interns can tackle. If time permits, interns could also work on small to medium features. | * 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 March 22. * Use our [:Outreachyfirstpatch:tutorial] to send in your first kernel patch by March 22. |
| Line 15: | Line 22: |
| FIXME: add links to kernel.bugzilla.org entries for these tasks. | = 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.'' |
| Line 17: | Line 25: |
| Necessary skills: Experience in C or C++ Optional but learnable skills: Knowledge of operating systems, USB |
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! |
| Line 20: | Line 27: |
| Suggested reading for accepted interns: * [http://lwn.net/Kernel/LDD3/ Linux Device Drivers] * [http://www.beyondlogic.org/usbnutshell/usb1.shtml USB in a Nutshell] |
= Round 12 projects = Previous projects, from round 11 projects are available [:OutreachyRound11:here]. For each project, if you click on the proposer's name, you may find more information. The following is a partial list of projects. More will come soon. |
| Line 24: | Line 30: |
| == Ethernet == | == Update legacy workqueue creation interface users == ''Mentor:'': [:Tejun Heo:Tejun Heo] |
| Line 26: | Line 33: |
| Carolyn Wyborny and Anjali Jain are sponsoring a project to work on 1 gig ethernet. (More info coming soon.) | Workqueue is an asynchronous execution mechanism which is widely used across the kernel. A work item queued on a workqueue is asynchronously executed by a worker task (kworker/* in ps output). It's used for various purposes from simple context bouncing to hosting a persistent in-kernel service thread. |
| Line 28: | Line 35: |
| Due to its development history, there currently are two sets of interfaces to create workqueues. | |
| Line 29: | Line 37: |
| = Getting Started = | * create[_singlethread|_freezable]_workqueue() * alloc[_ordered]_workqueue() |
| Line 31: | Line 40: |
| TODO: * Intro, what the goals are, why they should be excited about developing for the kernel. :) * What skills are good to have (e.g. having taken an OS class is good), or how they can get those skills later on, like by reading Linux Device Drivers * Outline of what this tutorial covers * If you run into any issues, ask on the opw irc channel, or email sarah.a.sharp at linux.intel.com * Step 0: install Linux on a home computer (alternative instructions for installing in a VM would be good, but I have no background in that). * Build a custom kernel * Find out which drivers you have installed (maybe plug in any USB devices on hand) * Make small change in one of the drivers (e.g. run checkpatch over them, or fix some grammer in the printks) * Or maybe pick a driver in staging and run checkpatch on it * Test your patch (may need to enable debugging) * Make a patch (link to art of patch description creation) * Send patch to kernel newbies mailing list as RFC (perhaps we need a separate mailing list?) |
The latter is the new interface which is superset of the former. While each create*_workqueue() can be directly mapped to an alloc*_workqueue() invocation, create*_workqueue() encodes much less information than alloc*_workqueue() making determining which exact flavor and attributes to use non-trivial. Each case should be examined to find out why a specific kind is used and then converted to an alloc*_workqueue() invocation which matches the requirements. There currently are around 280 users of the legacy interface. While the number seems daunting, there are common patterns that many of them follow. This project would involve understanding workqueue's various users to certain degree in addition to workqueue itself and can be a good opportunity to roam through and learn various parts of the kernel. See the small tasks for this project on the [:Tejun Heo: mentor's page]. == Coccinelle == ''Mentor:'': [:JuliaLawall:Julia Lawall] Coccinelle is a program matching and transformation tool that has been extensively used for finding bugs in the Linux kernel. Around 50 Coccinelle rules are currently part of the kernel source code, and are regularly run on all kernel code changes via the 0-day build testing service. Still, there is the potential for many more such rules. The goal of this project is to prepare existing semantic patches, such as those found at [https://github.com/coccinelle/coccinellery coccinellery] for inclusion in the kernel and to write some new ones. 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:'': [: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 we will enhance the driver with 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 == memory management latency tracing == ''Mentor:'' [:RikvanRiel:Rik van Riel] Every few months, some issue seems to pop up where users suffer from excessive latency at page fault and/or memory allocation time, usually (but not always) due to latency in the page reclaim code. Developers end up with some ad-hoc tracing to figure out the problem, because the kernel does not have a tool to discover the cause of these latencies on production systems. The goal of this project is to add the necessary tracepoints to the page fault, memory allocation, compaction, and reclaiming code, as well as some kind of script or tool in userspace that allows Linux users to obtain information on where time was spent when a memory allocation takes longer than a specified threshold. This project requires learning about the memory management code, as well as tracepoints, and tracing tools in userspace. == 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 #opw 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 March 22. * Use our [:Outreachyfirstpatch:tutorial] to send in your first kernel patch by March 22. * After you have sent several cleanup patches and at least one patchset, choose a [:OutreachyTasks:small task] 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.
Round 12 is coming up soon. 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 intersted in applying.
We are looking for round 12 [: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 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.
How to apply
The application period for Outreachy Round 12 is February 9 to March 22. Please fill your [https://live.gnome.org/OutreachProgramForWomen#Application_Process application] by March 22, and complete your kernel patch by March 22 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 March 22.
Use our [:Outreachyfirstpatch:tutorial] to send in your first kernel patch by March 22.
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 12 projects
Previous projects, from round 11 projects are available [:OutreachyRound11:here]. For each project, if you click on the proposer's name, you may find more information. The following is a partial list of projects. More will come soon.
Update legacy workqueue creation interface users
Mentor:: [:Tejun Heo:Tejun Heo]
Workqueue is an asynchronous execution mechanism which is widely used across the kernel. A work item queued on a workqueue is asynchronously executed by a worker task (kworker/* in ps output). It's used for various purposes from simple context bouncing to hosting a persistent in-kernel service thread.
Due to its development history, there currently are two sets of interfaces to create workqueues.
- create[_singlethread|_freezable]_workqueue()
- alloc[_ordered]_workqueue()
The latter is the new interface which is superset of the former. While each create*_workqueue() can be directly mapped to an alloc*_workqueue() invocation, create*_workqueue() encodes much less information than alloc*_workqueue() making determining which exact flavor and attributes to use non-trivial. Each case should be examined to find out why a specific kind is used and then converted to an alloc*_workqueue() invocation which matches the requirements.
There currently are around 280 users of the legacy interface. While the number seems daunting, there are common patterns that many of them follow.
This project would involve understanding workqueue's various users to certain degree in addition to workqueue itself and can be a good opportunity to roam through and learn various parts of the kernel.
See the small tasks for this project on the [:Tejun Heo: mentor's page].
Coccinelle
Mentor:: [:JuliaLawall:Julia Lawall]
Coccinelle is a program matching and transformation tool that has been extensively used for finding bugs in the Linux kernel. Around 50 Coccinelle rules are currently part of the kernel source code, and are regularly run on all kernel code changes via the 0-day build testing service. Still, there is the potential for many more such rules. The goal of this project is to prepare existing semantic patches, such as those found at [https://github.com/coccinelle/coccinellery coccinellery] for inclusion in the kernel and to write some new ones. 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:: [: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 we will enhance the driver with 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
memory management latency tracing
Mentor: [:RikvanRiel:Rik van Riel]
Every few months, some issue seems to pop up where users suffer from excessive latency at page fault and/or memory allocation time, usually (but not always) due to latency in the page reclaim code. Developers end up with some ad-hoc tracing to figure out the problem, because the kernel does not have a tool to discover the cause of these latencies on production systems. The goal of this project is to add the necessary tracepoints to the page fault, memory allocation, compaction, and reclaiming code, as well as some kind of script or tool in userspace that allows Linux users to obtain information on where time was spent when a memory allocation takes longer than a specified threshold.
This project requires learning about the memory management code, as well as tracepoints, and tracing tools in userspace.
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 #opw 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 March 22.
Use our [:Outreachyfirstpatch:tutorial] to send in your first kernel patch by March 22.
After you have sent several cleanup patches and at least one patchset, choose a [:OutreachyTasks:small task] to complete.