Provide more details for the livecd enhancement project

[ikiwiki.git] / docs / developer / ProjectsPage.mdwn

# DragonFly Projects 

This page shall serve as a common place to look if you're in search of a DragonFly related project. It's also the place to check if someone else is already working on it (to prevent project collision) or should be contacted.

Projects that can be clearly used for Google Code-In are marked with their category, where applicable.  Some unmarked items may be eligible; it depends on how the student wants to tackle the project.

[[!toc levels=3 ]]

## Website projects 

### One-liners
* Add traffic report, especially to lists requests that cause 404s (GCI:Research)
* Add the mail archive to the search index (GCI:Documentation)
* Download link right on the main page.  
* Fix RSS feed to have correct links
* Create layout for http://bugs.dragonflybsd.org that matches the main site.  (GCI:User Interface)
* Create short list of tasks for a new DragonFly user 
* How to upgrade the operating system (GCI:Training)
* How to get to a working desktop (GCI:Training)
* and where and how to report issues.(GCI:Documentation)

### Post papers in the proper locations on the website
* Format conversion may be necessary
* Aggelos's papers from [http://leaf.dragonflybsd.org/~aggelos/] (http://leaf.dragonflybsd.org/~aggelos/) (netmp-paper.pdf and netmp.pdf) to Presentations
* ["A Peek at the vKernel" article](http://cvsweb.dragonflybsd.org/cvsweb/site/data/docs/articles/vkernel/vkernel.shtml?rev=1.3&content-type=text/x-cvsweb-markup) from old site
(GCI:Documentation)

## Documentation projects 

### One-liners
* Reorder `/usr/src/UPDATING` to put more relevant information at top; remove data no longer relevant.
* Help out in [http://bugs.dragonflybsd.org](http://bugs.dragonflybsd.org) (try to reproduce, diagnose, propose fixes ...)
* Organize, contribute to, and finish the C book project.

### Handbook maintenance
* Check if the content applies to DragonFly.  If not, change it.
* Add new content and enhance the previous chapters
* Check for syntax error, typos and wiki errors. 
* Add prev/next buttons to all pages. (GCI:User Interface)


### Write manpages
* sysref (GCI:Documentation or Research)

## Userland projects 

### One-liners
* Update the [[contributed software|docs/user/ContribSoftware]] which is out-of-date.
* Remove `NOINET6` build option
* `WARN` corrections to utilities (GCI:Code)
* Bring in code from other *BSDs:
* smbfs changes from FreeBSD (GCI:Code)
* Add extended slice support to `fdisk`
* Install Coverity and fix the FreeBSD bugs that were uncovered by Coverity, but do not just blindly pull over the FreeBSD patches. Make sure that you first understand what the patch does.
* C99 Standards Conformance. The todo list is on [[/docs/developer/StandardsConformanceProject]] (GCI:Code)
* Setup a regression testing machine/system to register and find problems and new improvements. (GCI:Quality Assurance) 
* Networking performance / scalability ((GCI:Research)
* [[RegressionTest|/docs/developer/RegressionTest]] (GCI:Research)
* also check [[HowToStressTest|/docs/developer/HowToStressTest]] (GCI:Research)
* Add lwp support to ptrace/gdb/core dumps.
* Bringing in version 2.0 of the BSD Installer
* UTF8 support in the console

### Scalability (algorithmic performance) (GCI:Research)
* [http://bulk.fefe.de/scalability/](http://bulk.fefe.de/scalability/) 
* [http://bulk.fefe.de/lk2006/talk.pdf](http://bulk.fefe.de/lk2006/talk.pdf)

### Clean our code to make it [style(9)](http://leaf.dragonflybsd.org/cgi/web-man?command=style&section=ANY#style&sectionANY) compatible.  (GCI:Code)
* Compile and test your changes.
* Verify that the checksum (sha(1)) of the unmodified object matches the checksum of the cleaned object.  Check also with strip(1)+sha(1)  

### Port BSD-licensed tools (ex: `grep`, `diff` and `sort`) (GCI:Code)
* The OpenBSD guys already did some work related to that.
* If you manage to bring the tools to DragonFly, check if everything works as expected (e.g. rc.d scripts, make world runs, ...).
* The new tools need to have at least all the features of the old GNU tools.

### Randomize mmap() offsets
* [http://www.openbsd.org/papers/ven05-deraadt/index.html](http://www.openbsd.org/papers/ven05-deraadt/index.html)

### GDB
* ptrace/gdb follow-fork-mode support and more (peek at linux)
* Change the build to create one libbfd for gdb and binutils
* Separate RPC code from NFS into separate library.

### I/O diagnostic utilities
* A utility similar to top which displays I/O usage on a per-process basis
* Network, Disk

### SMART capabilities
* Add to camcontrol
* Add to natacontrol (see NetBSD's atactl?)

### Disk scheduling rc scripts (GCI:Code)
* Create a rc script to manage the disk/io scheduling system
* Perhaps 1 entry to "enable" it, and all disks will have mode set to "auto", in auto mode smart inquiries and other heuristics could attempt to determine the best i/o scheduler
* Per-device and device class or similar defaults should be definable in rc.conf also
* The bulk of this functionality could be implemented in a resurrected "dschedctl" utility and exposed through the rc interface using just a thin wrapper, allowing hotplug scripts and etc. an easier option to use the same facilities.

### libHAMMER 
* HAMMER has the capability to expose very rich information to userland through ioctl's.
* Currently the hammer(8) utility makes use of this information in an ad-hoc manner.
* Port this core functionality into a public libhammer library so that other base and third party utilities may take advantage of it.
* See commit: cb7575e6a89409a2041a37fcfc22ce9e41297ab8 -- libHAMMER already exists, port functionality into it!

### Clean up crypt(3) consumers
* crypt(3) can legitimately return NULL on error, but many consumers do not check for this, instead passing the return directly to str[n]cmp. Fix these cases.
* Fix these cases in pkgsrc as well.

## Kernel projects 

### One-liners
* Port the BSDL OSS code to DragonFly
* Complete Path MTU Discovery by adding a host route to remember the Path MTU and setting a timer to expire old host routes. See netinet/if_ether.c for an example of this mechanism as used by ARP. Periodically increase MTU of hosts that have had its MTU decreased.
* Look for places in the kernel that can benefit from Solaris-style caching of preconstructed slab allocator objects. If we can find enough of these uses, we can add this functionality to the kernel memory allocator.
* Implement [`sem_open()`](http://www.opengroup.org/onlinepubs/000095399/functions/sem_open.html), [`sem_close()`](http://www.opengroup.org/onlinepubs/000095399/functions/sem_close.html), and [`sem_unlink()`](http://www.opengroup.org/onlinepubs/000095399/functions/sem_unlink.html). (GCI:Code)
* Clean our code to make it [style(9)](http://leaf.dragonflybsd.org/cgi/web-man?command#style&sectionANY) compatible.  Compile and test your changes.  Verify that the checksum (sha(1)) of the unmodified object matches the checksum of the cleaned object.  Check also with strip(1)+sha(1)
* Setup a regression testing machine/system to register and find problems and new improvements. (GCI:Research)
* Port or update drivers from other systems.
* Port NFSv4.  [This mail](http://leaf.dragonflybsd.org/mailarchive/kernel/2008-01/msg00065.html) is a good starting point.
* clean up buildworld/kernel compilation warnings
* Port DTrace
* Port Linux emulation to x86-64

### Code to port/sync from FreeBSD
* PCI code (to take advantage of power saving features)
* Bring in support for UFS2, just the changes to extend the width of some fields from 32 bits to 64 bits.  (GCI:Code)
* hardware drivers. 

### Code to port/sync from OpenBSD
* Add support for the NoExecute bit as described in [http://www.openbsd.org/papers/auug04/index.html](http://www.openbsd.org/papers/auug04/index.html).
* After that, make user stacks and data heaps non-executable. (W^X)
* hardware drivers, specially wireless.

### CPU scheduler
* A scheduler API supporting multiple scheduler implementations already exists
* Add a Solaris-like dispatcher framework that can handle more than one installed scheduling policy

### I/O scheduler
* A pluggable kernel I/O scheduler already exists
* Implement additional disk scheduling policies

### Implement boot cache
* Effectively a smart readahead.
* Store the pattern of incoming read requests of the boot disk. (Likely into an array structure for better linear readback, We mmap() the whole thing into RAM on boot.)
* Sort pattern into a playback list. (Burstsort or a simple quick sort to get things going?)
* Provide feedback of boot cache playback list hit rate for better adaptiveness.

### Improve kernel boot speed
* Research source of delays in boot process, keyboard init, scsi?
* Better thread some hardware init, for example USB?
* Perhaps look to see how Linux can boot in one second, better pci scan code?
* "Some kernel work made it possible to do asynchronous initialization of some subsystems. For example, the modified kernel starts the Advanced Host Controller Interface (AHCI) initialization, to handle storage, at the same time as the Universal Host Controller Interface (UHCI), in order to handle USB" - http://lwn.net/Articles/299483/

### Modify firmware framework 
* We currently use the firmware(9) FreeBSD also uses
* It would be more appropriate to avoid future problems with redistribution problems, etc, to adapt the wifi firmware stuff to use the firmware(9) we used to have before, which was able to load firmware files from userland (/etc/firmware).
* See "firmware discussion" thread on kernel@ mailing list, March-May 2010.
* Since it's not desired to just add another way of doing it, this project should include getting rid of loading firmwares as modules

### Work relating to LWKT (LightWeightKernelThreading)
* Implement lazy IPI cross-processor lwkt message passing.
* Add timeout functionality to lwkt_waitmsg().
* Write man pages for the lwkt message passing API.

### Filesystem extended attributes
* Generic VFS attributes layer
* Emulate attributes ala Darwin
* Allow filesystems to define their own attribute vop ops
* QUESTIONS: Attributes or subfiles? The consensus is that subfiles are better?

### Capabilities
* Implement something resembling or inspired by POSIX.1e
* This implementation could possibly exist in userland and interlock with the kernel via a VFS Journal or HAMMER mirroring ioctl's.
* These should be capable of supporting NFSv4 capabilities.
* References: [1](http://leaf.dragonflybsd.org/mailarchive/kernel/2006-07/msg00012.html)

### Hardware virtualization extensions
* Increase performance of virtual kernels
* Make use of hardware virtualization extensions, if supported, to manage vmspaces
* Implement a KVM-compatible virtualization device to support qemu
* Hardware IOMMU support is not a priority and if implemented must be strictly optional.

### Remove zalloc
* zalloc is a deprecated kernel interface and all current consumers can be ported to objcache, with varying levels of difficulty.
* zlib, pv entries
* Once all consumers are ported, zalloc can be removed.

### Document all sysctl's
* The description of sysctl's can be provided when the sysctl is declared and displayed in userland by passing the -d flag to the sysctl utility.
* Document all undocumented sysctl's
* Verify that the description of documented sysctl's is correct.

### Convert kprintf-enabling sysctl's to KTR's
* Many sysctl's simply enable one or more kernel kprintf's
* This can be very easy, or can be very unwieldy
* Convert all of these cases to ktr's, while slightly less easy they are far easier to wield in all cases.

### Tear out C/H/S disk reporting (GCI:Research)
* Cylinders/Heads/Sectors are an outdated concept and the system doesn't rely on them anymore.
* Verify the assumption that we don't rely on them in any way, shape or form.
* Tear the reporting out of the kernel/installer/etc.

### Change vm_map lookup algorithm
* The vm_map lookups currently use a Red-Black tree, since 2005.
* It has been decided that using an array'ized bucket'ized hash table is probably a better approach.
* References: [1](http://kerneltrap.org/mailarchive/freebsd-current/2010/10/1/6260944) [2](http://leaf.dragonflybsd.org/mailarchive/kernel/2005-01/msg00122.html)

### Trampoline Code Page instead of direct syscalls
* Map a read/execute trampoline page into every process, which has a syscall table, i.e. is used instead of "int" to enter the kernel. This way we can easily change the kernel enter method from "int" to e.g. "sysenter" without having to recompile userland applications, or even implement some syscalls in userspace.

### Compressed in-memory swap device
* A device that uses physical memory as swap space, but compresses it.
* Do we support stacking of swap space? For example, one would have this compressed in-memory swap device with highest priority. Replaced objects will be put into the next priority swap device (e.g. a SSD), and so on.

### tmpfs allocations from swap
* Currently, tmpfs nodes and stuff are allocated from KVA are the size limiter for a tmpfs filesystem
* Instead allocate them from swappable memory; this will allow larger tmpfses up to swap limits

### mmap MAP_ALIGN
* Solaris's mmap support a flag, MAP_ALIGN, where the address to mmap acts as an alignment hint
* Our backing VM calls support an alignment parameter, but our public mmap does not
* This would allow nmalloc to allocate slabs (64k, 64k-aligned) without wastage

### vnode dumps
* It would be beneficial to be able to have crash dumps written to an ordinary file in configurations where swap is not configured.

### Kernel allocator feature enhancements
* Enhance objcache in a manner that will allow the initialization to specify allocation functions which will allocate and free entire slabs of memory, not just single objects.
* Rework the kmalloc allocator to sit on top of objcache (there are various dependencies to making this work).
* Create or sort out a metric for vnode/other cache object cycling rate that can indicate realistic memory pressure.
* Clear out free objcache slabs under memory pressure.
* Add reclaim functionality to objcache, such that it may ask consumers to free objects back into it under memory pressure.

### Tear out serializers
* Serializers could be _carefully_ replaced with MTX locks

### Tear out condvars
* Conditional vars -- condvar(9), could be replaced with other locking primitives and our tsleep/wakeup interlock.

### Make karc4random in libkern per-cpu
* Verify that it is possible and safe to do this, what care would need to be taken, especially with respect to the random seeding?
* Pull out locks around calls to karc4rand*

## Live images enhancement

The live images could be made easier to use. The following enhancements should be added:

1. Let the user choose the keyboard layout at startup, do not assume QWERTY.
Ideally, an user should be able to login after having selected a non-QWERTY layout without needing to use any of the alphabetic keys.
2. Configure network interfaces automatically, using DHCP

Not beeing able to choose keyboard layout before having to type 'installer' or 'root' may be a deal breaker for some users.
A simple menu replacing login(1) and displaying the following three choices could be a good solution:
* Choice 1: Set keyboard layout
* Choice 2: Launch the installer
* Choice 3: Login as root

For more theoretical projects and project concepts see [[ResearchProjects|/docs/developer/ResearchProjectsPage]]