Merge branch 'master' of /usr/local/www/ikiwiki-srcdir
[ikiwiki.git] / docs / developer / ProjectsPage.mdwn
1 # DragonFly Projects 
2
3 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.
4
5 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.
6
7 [[!toc levels=3 ]]
8
9 ## Website projects 
10
11 ### One-liners
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.  
15 * Fix RSS feed to have correct links
16 * Create layout for http://bugs.dragonflybsd.org that matches the main site.  (GCI:User Interface)
17 * Create short list of tasks for a new DragonFly user 
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)
21
22 ### Post papers in the proper locations on the website
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
26 (GCI:Documentation)
27
28 ## Documentation projects 
29
30 ### One-liners
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.
34
35 ### Handbook maintenance
36 * Check if the content applies to DragonFly.  If not, change it.
37 * Add new content and enhance the previous chapters
38 * Check for syntax error, typos and wiki errors. 
39 * Add prev/next buttons to all pages. (GCI:User Interface)
40
41
42 ### Write manpages
43 * sysref (GCI:Documentation or Research)
44
45 ## Userland projects 
46
47 ### One-liners
48 * Update the [[contributed software|docs/user/ContribSoftware]] which is out-of-date.
49 * Remove `NOINET6` build option
50 * `WARN` corrections to utilities (GCI:Code)
51 * Bring in code from other *BSDs:
52 * smbfs changes from FreeBSD (GCI:Code)
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.
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)
60 * Add lwp support to ptrace/gdb/core dumps.
61 * Bringing in version 2.0 of the BSD Installer
62 * UTF8 support in the console
63
64 ### Scalability (algorithmic performance) (GCI:Research)
65 * [http://bulk.fefe.de/scalability/](http://bulk.fefe.de/scalability/) 
66 * [http://bulk.fefe.de/lk2006/talk.pdf](http://bulk.fefe.de/lk2006/talk.pdf)
67
68 ### Clean our code to make it [style(9)](http://leaf.dragonflybsd.org/cgi/web-man?command#style&sectionANY) compatible.  (GCI:Code)
69 * Compile and test your changes.
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)  
71
72 ### Port BSD-licensed tools (ex: `grep`, `diff` and `sort`) (GCI:Code)
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.
76
77 ### Randomize mmap() offsets
78 * [http://www.openbsd.org/papers/ven05-deraadt/index.html](http://www.openbsd.org/papers/ven05-deraadt/index.html)
79
80 ### GDB
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
88
89 ### SMART capabilities
90 * Add to natacontrol (see NetBSD's atactl?)
91 * Add to camcontrol
92
93 ### Disk scheduling rc scripts (GCI:Code)
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
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.
98
99 ### Add usage() to vkernels (GCI:Code)
100 * Most userspace applications have a (traditionally) usage() routine which prints helpful information when passed -h or -? or any unknown command line argument or incorrect syntax.
101 * Add a usage() to the vkernel's argument parsing.
102
103 ### libHAMMER 
104 * HAMMER has the capability to expose very rich information to userland through ioctl's.
105 * Currently the hammer(8) utility makes use of this information in an ad-hoc manner.
106 * Port this core functionality into a public libhammer library so that other base and third party utilities may take advantage of it.
107
108 ## Kernel projects 
109
110 ### One-liners
111 * Port the BSDL OSS code to DragonFly
112 * 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.
113 * 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.
114 * 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)
115 * 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)
116 * Setup a regression testing machine/system to register and find problems and new improvements. (GCI:Research)
117 * Port or update drivers from other systems.
118 * Port NFSv4.  [This mail](http://leaf.dragonflybsd.org/mailarchive/kernel/2008-01/msg00065.html) is a good starting point.
119 * clean up buildworld/kernel compilation warnings
120 * Port DTrace
121 * Port Linux emulation to x86-64
122
123 ### Code to port/sync from FreeBSD
124 * PCI code (to take advantage of power saving features)
125 * Bring in support for UFS2, just the changes to extend the width of some fields from 32 bits to 64 bits.  (GCI:Code)
126 * hardware drivers. 
127
128 ### Code to port/sync from OpenBSD
129 * 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).
130 * After that, make user stacks and data heaps non-executable. (W^X)
131 * hardware drivers, specially wireless.
132
133 ### CPU scheduler
134 * A scheduler API supporting multiple scheduler implementations already exists
135 * Add a Solaris-like dispatcher framework that can handle more than one installed scheduling policy
136
137 ### I/O scheduler
138 * A pluggable kernel I/O scheduler already exists
139 * Implement additional disk scheduling policies
140
141 ### Modify firmware framework 
142 * We currently use the firmware(9) FreeBSD also uses
143 * 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).
144 * See "firmware discussion" thread on kernel@ mailing list, March-May 2010.
145 * Since it's not desired to just add another way of doing it, this project should include getting rid of loading firmwares as modules
146
147 ### Work relating to LWKT (LightWeightKernelThreading)
148 * Implement lazy IPI cross-processor lwkt message passing.
149 * Add timeout functionality to lwkt_waitmsg().
150 * Write man pages for the lwkt message passing API.
151
152 ### Filesystem extended attributes
153 * Generic VFS attributes layer
154 * Emulate attributes ala Darwin
155 * Allow filesystems to define their own attribute vop ops
156 * QUESTIONS: Attributes or subfiles? The consensus is that subfiles are better?
157
158 ### Capabilities
159 * Implement something resembling or inspired by POSIX.1e
160 * This implementation could possibly exist in userland and interlock with the kernel via a VFS Journal or HAMMER mirroring ioctl's.
161 * These should be capable of supporting NFSv4 capabilities.
162 * References: [1](http://leaf.dragonflybsd.org/mailarchive/kernel/2006-07/msg00012.html)
163
164 ### Hardware virtualization extensions
165 * Increase performance of virtual kernels
166 * Make use of hardware virtualization extensions, if supported, to manage vmspaces
167 * Implement a KVM-compatible virtualization device to support qemu
168 * Hardware IOMMU support is not a priority and if implemented must be strictly optional.
169
170 ### Remove zalloc
171 * zalloc is a deprecated kernel interface and all current consumers can be ported to objcache, with varying levels of difficulty.
172 * Easier: kqueue, nfs nodes, ufs dirhash, aio, crypto, vm_map_entry
173 * Harder: zlib, pv entries
174 * Once all consumers are ported, zalloc can be removed.
175
176 ### Document all sysctl's
177 * 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.
178 * Document all undocumented sysctl's
179 * Verify that the description of documented sysctl's is correct.
180
181 ### Convert kprintf-enabling sysctl's to KTR's
182 * Many sysctl's simply enable one or more kernel kprintf's
183 * This can be very easy, or can be very unwieldy
184 * Convert all of these cases to ktr's, while slightly less easy they are far easier to wield in all cases.
185
186 ### Tear out C/H/S disk reporting (GCI:Research)
187 * Cylinders/Heads/Sectors are an outdated concept and the system doesn't rely on them anymore.
188 * Verify the assumption that we don't rely on them in any way, shape or form.
189 * Tear the reporting out of the kernel/installer/etc.
190
191 ### Change vm_map lookup algorithm
192 * The vm_map lookups currently use a Red-Black tree, since 2005.
193 * It has been decided that using an array'ized bucket'ized hash table is probably a better approach.
194 * References: [1](http://kerneltrap.org/mailarchive/freebsd-current/2010/10/1/6260944) [2](http://leaf.dragonflybsd.org/mailarchive/kernel/2005-01/msg00122.html)
195
196 ### Trampoline Code Page instead of direct syscalls
197 * 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.
198
199 ### Compressed in-memory swap device
200 * A device that uses physical memory as swap space, but compresses it.
201 * 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.
202
203 ### tmpfs allocations from swap
204 * Currently, tmpfs nodes and stuff are allocated from KVA are the size limiter for a tmpfs filesystem
205 * Instead allocate them from swappable memory; this will allow larger tmpfses up to swap limits
206
207 ### mmap MAP_ALIGN
208 * Solaris's mmap support a flag, MAP_ALIGN, where the address to mmap acts as an alignment hint
209 * Our backing VM calls support an alignment parameter, but our public mmap does not
210 * This would allow nmalloc to allocate slabs (64k, 64k-aligned) without wastage
211
212 ### vnode dumps
213 * It would be beneficial to be able to have crash dumps written to an ordinary file in configurations where swap is not configured.
214
215
216 For more theoretical projects and project concepts see [[ResearchProjects|/docs/developer/ResearchProjectsPage]]