Nat Makarevitch does not maintain ikarios anymore
[ikiwiki.git] / docs / developer / ProjectsPage.mdwn
CommitLineData
8c0cdf29 1# DragonFly Projects
b790f880 2
8c0cdf29 3This 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.
b790f880 4
b1b401e0 5Projects 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.
6
8c0cdf29 7[[!toc levels=3 ]]
b790f880 8
8c0cdf29 9## Website projects
b790f880 10
06d07101 11### One-liners
b1b401e0 12* Add traffic report, especially to lists requests that cause 404s (GCI:Research)
13* Add the mail archive to the search index (GCI:Documentation)
14* Download link right on the main page.
8753e704 15* Fix RSS feed to have correct links
b1b401e0 16* Create layout for http://bugs.dragonflybsd.org that matches the main site. (GCI:User Interface)
8753e704 17* Create short list of tasks for a new DragonFly user
b1b401e0 18* How to upgrade the operating system (GCI:Training)
19* How to get to a working desktop (GCI:Training)
20* and where and how to report issues.(GCI:Documentation)
06d07101 21
22### Post papers in the proper locations on the website
8753e704 23* Format conversion may be necessary
24* Aggelos's papers from [http://leaf.dragonflybsd.org/~aggelos/] (http://leaf.dragonflybsd.org/~aggelos/) (netmp-paper.pdf and netmp.pdf) to Presentations
25* ["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
b1b401e0 26(GCI:Documentation)
b790f880 27
8c0cdf29 28## Documentation projects
b790f880 29
06d07101 30### One-liners
8753e704 31* Reorder `/usr/src/UPDATING` to put more relevant information at top; remove data no longer relevant.
32* Help out in [http://bugs.dragonflybsd.org](http://bugs.dragonflybsd.org) (try to reproduce, diagnose, propose fixes ...)
33* Organize, contribute to, and finish the C book project.
06d07101 34
35### Handbook maintenance
8753e704 36* Check if the content applies to DragonFly. If not, change it.
37* Add new content and enhance the previous chapters
b1b401e0 38* Check for syntax error, typos and wiki errors.
39* Add prev/next buttons to all pages. (GCI:User Interface)
40
193c08af 41
87bf445d 42### Write manpages
b1b401e0 43* sysref (GCI:Documentation or Research)
87bf445d 44
8c0cdf29 45## Userland projects
b790f880 46
06d07101 47### One-liners
8753e704 48* Update the [[contributed software|docs/user/ContribSoftware]] which is out-of-date.
49* Remove `NOINET6` build option
b1b401e0 50* `WARN` corrections to utilities (GCI:Code)
8753e704 51* Bring in code from other *BSDs:
b1b401e0 52* smbfs changes from FreeBSD (GCI:Code)
8753e704 53* Add extended slice support to `fdisk`
54* 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.
b1b401e0 55* C99 Standards Conformance. The todo list is on [[/docs/developer/StandardsConformanceProject]] (GCI:Code)
56* Setup a regression testing machine/system to register and find problems and new improvements. (GCI:Quality Assurance)
57* Networking performance / scalability ((GCI:Research)
58* [[RegressionTest|/docs/developer/RegressionTest]] (GCI:Research)
59* also check [[HowToStressTest|/docs/developer/HowToStressTest]] (GCI:Research)
8753e704 60* Add lwp support to ptrace/gdb/core dumps.
8753e704 61* Bringing in version 2.0 of the BSD Installer
62* UTF8 support in the console
06d07101 63
b1b401e0 64### Scalability (algorithmic performance) (GCI:Research)
65* [http://bulk.fefe.de/scalability/](http://bulk.fefe.de/scalability/)
8753e704 66* [http://bulk.fefe.de/lk2006/talk.pdf](http://bulk.fefe.de/lk2006/talk.pdf)
06d07101 67
4e927740 68### Clean our code to make it [style(9)](http://leaf.dragonflybsd.org/cgi/web-man?command=style&section=ANY#style&sectionANY) compatible. (GCI:Code)
8753e704 69* Compile and test your changes.
b1b401e0 70* Verify that the checksum (sha(1)) of the unmodified object matches the checksum of the cleaned object. Check also with strip(1)+sha(1)
06d07101 71
b1b401e0 72### Port BSD-licensed tools (ex: `grep`, `diff` and `sort`) (GCI:Code)
8753e704 73* The OpenBSD guys already did some work related to that.
74* If you manage to bring the tools to DragonFly, check if everything works as expected (e.g. rc.d scripts, make world runs, ...).
75* The new tools need to have at least all the features of the old GNU tools.
06d07101 76
77### Randomize mmap() offsets
8753e704 78* [http://www.openbsd.org/papers/ven05-deraadt/index.html](http://www.openbsd.org/papers/ven05-deraadt/index.html)
06d07101 79
99e24f21 80### GDB
8753e704 81* ptrace/gdb follow-fork-mode support and more (peek at linux)
82* Change the build to create one libbfd for gdb and binutils
83* Separate RPC code from NFS into separate library.
84
85### I/O diagnostic utilities
86* A utility similar to top which displays I/O usage on a per-process basis
87* Network, Disk
8c0cdf29 88
05f26292 89### SMART capabilities
90* Add to natacontrol (see NetBSD's atactl?)
91* Add to camcontrol
92
b1b401e0 93### Disk scheduling rc scripts (GCI:Code)
05f26292 94* Create a rc script to manage the disk/io scheduling system
95* 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
96* Per-device and device class or similar defaults should be definable in rc.conf also
dcf86f60 97* 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.
05f26292 98
b1b401e0 99### libHAMMER
3eda57ef 100* HAMMER has the capability to expose very rich information to userland through ioctl's.
101* Currently the hammer(8) utility makes use of this information in an ad-hoc manner.
102* Port this core functionality into a public libhammer library so that other base and third party utilities may take advantage of it.
103
8c0cdf29 104## Kernel projects
105
06d07101 106### One-liners
8753e704 107* Port the BSDL OSS code to DragonFly
108* 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.
109* 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.
b1b401e0 110* 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)
8753e704 111* 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)
b1b401e0 112* Setup a regression testing machine/system to register and find problems and new improvements. (GCI:Research)
8753e704 113* Port or update drivers from other systems.
114* Port NFSv4. [This mail](http://leaf.dragonflybsd.org/mailarchive/kernel/2008-01/msg00065.html) is a good starting point.
8753e704 115* clean up buildworld/kernel compilation warnings
8753e704 116* Port DTrace
52dfca9b 117* Port Linux emulation to x86-64
06d07101 118
119### Code to port/sync from FreeBSD
8753e704 120* PCI code (to take advantage of power saving features)
b1b401e0 121* Bring in support for UFS2, just the changes to extend the width of some fields from 32 bits to 64 bits. (GCI:Code)
122* hardware drivers.
99e24f21 123
06d07101 124### Code to port/sync from OpenBSD
8753e704 125* 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).
126* After that, make user stacks and data heaps non-executable. (W^X)
127* hardware drivers, specially wireless.
06d07101 128
df817d42 129### CPU scheduler
8753e704 130* A scheduler API supporting multiple scheduler implementations already exists
131* Add a Solaris-like dispatcher framework that can handle more than one installed scheduling policy
06d07101 132
133### I/O scheduler
df817d42 134* A pluggable kernel I/O scheduler already exists
135* Implement additional disk scheduling policies
8753e704 136
b1b401e0 137### Modify firmware framework
1ac22aa1 138* We currently use the firmware(9) FreeBSD also uses
139* 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).
140* See "firmware discussion" thread on kernel@ mailing list, March-May 2010.
ca622843 141* Since it's not desired to just add another way of doing it, this project should include getting rid of loading firmwares as modules
1ac22aa1 142
8753e704 143### Work relating to LWKT (LightWeightKernelThreading)
144* Implement lazy IPI cross-processor lwkt message passing.
145* Add timeout functionality to lwkt_waitmsg().
146* Write man pages for the lwkt message passing API.
147
148### Filesystem extended attributes
149* Generic VFS attributes layer
150* Emulate attributes ala Darwin
151* Allow filesystems to define their own attribute vop ops
152* QUESTIONS: Attributes or subfiles? The consensus is that subfiles are better?
153
b6a0e48f 154### Capabilities
155* Implement something resembling or inspired by POSIX.1e
156* This implementation could possibly exist in userland and interlock with the kernel via a VFS Journal or HAMMER mirroring ioctl's.
157* These should be capable of supporting NFSv4 capabilities.
158* References: [1](http://leaf.dragonflybsd.org/mailarchive/kernel/2006-07/msg00012.html)
159
8753e704 160### Hardware virtualization extensions
161* Increase performance of virtual kernels
162* Make use of hardware virtualization extensions, if supported, to manage vmspaces
0b48e63b 163* Implement a KVM-compatible virtualization device to support qemu
8898930f 164* Hardware IOMMU support is not a priority and if implemented must be strictly optional.
8753e704 165
f1dc70a1 166### Remove zalloc
167* zalloc is a deprecated kernel interface and all current consumers can be ported to objcache, with varying levels of difficulty.
48b27198 168* zlib, pv entries
f1dc70a1 169* Once all consumers are ported, zalloc can be removed.
97f327a5 170
b6a0e48f 171### Document all sysctl's
172* 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.
173* Document all undocumented sysctl's
174* Verify that the description of documented sysctl's is correct.
175
176### Convert kprintf-enabling sysctl's to KTR's
177* Many sysctl's simply enable one or more kernel kprintf's
178* This can be very easy, or can be very unwieldy
179* Convert all of these cases to ktr's, while slightly less easy they are far easier to wield in all cases.
180
b1b401e0 181### Tear out C/H/S disk reporting (GCI:Research)
bd0ac588 182* Cylinders/Heads/Sectors are an outdated concept and the system doesn't rely on them anymore.
183* Verify the assumption that we don't rely on them in any way, shape or form.
184* Tear the reporting out of the kernel/installer/etc.
185
e2952a1f 186### Change vm_map lookup algorithm
187* The vm_map lookups currently use a Red-Black tree, since 2005.
188* It has been decided that using an array'ized bucket'ized hash table is probably a better approach.
189* References: [1](http://kerneltrap.org/mailarchive/freebsd-current/2010/10/1/6260944) [2](http://leaf.dragonflybsd.org/mailarchive/kernel/2005-01/msg00122.html)
97f327a5 190
0422aa9f
M
191### Trampoline Code Page instead of direct syscalls
192* 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.
193
194### Compressed in-memory swap device
195* A device that uses physical memory as swap space, but compresses it.
196* 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.
197
fa076070 198### tmpfs allocations from swap
199* Currently, tmpfs nodes and stuff are allocated from KVA are the size limiter for a tmpfs filesystem
200* Instead allocate them from swappable memory; this will allow larger tmpfses up to swap limits
201
3114c38f 202### mmap MAP_ALIGN
203* Solaris's mmap support a flag, MAP_ALIGN, where the address to mmap acts as an alignment hint
204* Our backing VM calls support an alignment parameter, but our public mmap does not
205* This would allow nmalloc to allocate slabs (64k, 64k-aligned) without wastage
206
fb27736e 207### vnode dumps
208* It would be beneficial to be able to have crash dumps written to an ordinary file in configurations where swap is not configured.
209
af80ec85 210### Kernel allocator feature enhancements
211* 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.
60f380f8 212* Rework the kmalloc allocator to sit on top of objcache (there are various dependencies to making this work).
213* Create or sort out a metric for vnode/other cache object cycling rate that can indicate realistic memory pressure.
214* Clear out free objcache slabs under memory pressure.
215* Add reclaim functionality to objcache, such that it may ask consumers to free objects back into it under memory pressure.
af80ec85 216
fb27736e 217
97f327a5 218For more theoretical projects and project concepts see [[ResearchProjects|/docs/developer/ResearchProjectsPage]]