RecentChanges works now; remove tasks for it
[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 [[!toc levels=3 ]]
6
7 ## Website projects 
8
9 ### One-liners
10 * Add traffic report, especially to lists requests that cause 404s
11 * Add the mail archive to the search index
12 * Download link right on the main page.
13 * Fix RSS feed to have correct links
14 * Create layout for http://bugs.dragonflybsd.org that matches the main site.
15 * Create short list of tasks for a new DragonFly user 
16 * how to upgrade the operating system
17 * how to get to a working desktop
18 * and where and how to report issues.
19
20 ### Post papers in the proper locations on the website
21 * Format conversion may be necessary
22 * Aggelos's papers from [http://leaf.dragonflybsd.org/~aggelos/] (http://leaf.dragonflybsd.org/~aggelos/) (netmp-paper.pdf and netmp.pdf) to Presentations
23 * ["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
24
25 ## Documentation projects 
26
27 ### One-liners
28 * Reorder `/usr/src/UPDATING` to put more relevant information at top; remove data no longer relevant.
29 * Help out in [http://bugs.dragonflybsd.org](http://bugs.dragonflybsd.org) (try to reproduce, diagnose, propose fixes ...)
30 * Organize, contribute to, and finish the C book project.
31
32 ### Handbook maintenance
33 * Check if the content applies to DragonFly.  If not, change it.
34 * Add new content and enhance the previous chapters
35 * Check for syntax error, typos and wiki errors.
36 * Add prev/next buttons to all pages.
37
38 ### Write manpages
39 * sysref
40
41 ## Userland projects 
42
43 ### One-liners
44 * Update the [[contributed software|docs/user/ContribSoftware]] which is out-of-date.
45 * Remove `NOINET6` build option
46 * `WARN` corrections to utilities
47 * Bring in code from other *BSDs:
48 * smbfs changes from FreeBSD
49 * Add extended slice support to `fdisk`
50 * 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.
51 * C99 Standards Conformance. The todo list is on [[/docs/developer/StandardsConformanceProject]]
52 * Setup a regression testing machine/system to register and find problems and new improvements..
53 * Networking performance / scalability
54 * [[RegressionTest|/docs/developer/RegressionTest]]
55 * also check [[HowToStressTest|/docs/developer/HowToStressTest]]
56 * Add lwp support to ptrace/gdb/core dumps.
57 * Bringing in version 2.0 of the BSD Installer
58 * UTF8 support in the console
59
60 ### Scalability (algorithmic performance)
61 * [http://bulk.fefe.de/scalability/](http://bulk.fefe.de/scalability/)
62 * [http://bulk.fefe.de/lk2006/talk.pdf](http://bulk.fefe.de/lk2006/talk.pdf)
63
64 ### Clean our code to make it [style(9)](http://leaf.dragonflybsd.org/cgi/web-man?command#style&sectionANY) compatible.
65 * Compile and test your changes.
66 * Verify that the checksum (sha(1)) of the unmodified object matches the checksum of the cleaned object.  Check also with strip(1)+sha(1)
67
68 ### Port BSD-licensed tools (ex: `grep`, `diff` and `sort`)
69 * The OpenBSD guys already did some work related to that.
70 * If you manage to bring the tools to DragonFly, check if everything works as expected (e.g. rc.d scripts, make world runs, ...).
71 * The new tools need to have at least all the features of the old GNU tools.
72
73 ### Randomize mmap() offsets
74 * [http://www.openbsd.org/papers/ven05-deraadt/index.html](http://www.openbsd.org/papers/ven05-deraadt/index.html)
75
76 ### GDB
77 * ptrace/gdb follow-fork-mode support and more (peek at linux)
78 * Change the build to create one libbfd for gdb and binutils
79 * Separate RPC code from NFS into separate library.
80
81 ### I/O diagnostic utilities
82 * A utility similar to top which displays I/O usage on a per-process basis
83 * Network, Disk
84
85 ### SMART capabilities
86 * Add to natacontrol (see NetBSD's atactl?)
87 * Add to camcontrol
88
89 ### Disk scheduling rc scripts
90 * Create a rc script to manage the disk/io scheduling system
91 * 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
92 * Per-device and device class or similar defaults should be definable in rc.conf also
93 * 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.
94
95 ### Add usage() to vkernels
96 * 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.
97 * Add a usage() to the vkernel's argument parsing.
98
99 ### libHAMMER
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
104 ## Kernel projects 
105
106 ### One-liners
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.
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).
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)
112 * Setup a regression testing machine/system to register and find problems and new improvements..
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.
115 * clean up buildworld/kernel compilation warnings
116 * Port DTrace
117 * Port Linux emulation to x86-64
118
119 ### Code to port/sync from FreeBSD
120 * PCI code (to take advantage of power saving features)
121 * Bring in support for UFS2, just the changes to extend the width of some fields from 32 bits to 64 bits.
122 * hardware drivers.
123
124 ### Code to port/sync from OpenBSD
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.
128
129 ### CPU scheduler
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
132
133 ### I/O scheduler
134 * A pluggable kernel I/O scheduler already exists
135 * Implement additional disk scheduling policies
136
137 ### Modify firmware framework
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.
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
142
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
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
160 ### Hardware virtualization extensions
161 * Increase performance of virtual kernels
162 * Make use of hardware virtualization extensions, if supported, to manage vmspaces
163 * Implement a KVM-compatible virtualization device to support qemu
164 * Hardware IOMMU support is not a priority and if implemented must be strictly optional.
165
166 ### Remove zalloc
167 * zalloc is a deprecated kernel interface and all current consumers can be ported to objcache, with varying levels of difficulty.
168 * Easier: kqueue, nfs nodes, ufs dirhash, aio, crypto, vm_map_entry
169 * Harder: zlib, pv entries
170 * Once all consumers are ported, zalloc can be removed.
171
172 ### Document all sysctl's
173 * 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.
174 * Document all undocumented sysctl's
175 * Verify that the description of documented sysctl's is correct.
176
177 ### Convert kprintf-enabling sysctl's to KTR's
178 * Many sysctl's simply enable one or more kernel kprintf's
179 * This can be very easy, or can be very unwieldy
180 * Convert all of these cases to ktr's, while slightly less easy they are far easier to wield in all cases.
181
182 ### Tear out C/H/S disk reporting
183 * Cylinders/Heads/Sectors are an outdated concept and the system doesn't rely on them anymore.
184 * Verify the assumption that we don't rely on them in any way, shape or form.
185 * Tear the reporting out of the kernel/installer/etc.
186
187 ### Change vm_map lookup algorithm
188 * The vm_map lookups currently use a Red-Black tree, since 2005.
189 * It has been decided that using an array'ized bucket'ized hash table is probably a better approach.
190 * References: [1](http://kerneltrap.org/mailarchive/freebsd-current/2010/10/1/6260944) [2](http://leaf.dragonflybsd.org/mailarchive/kernel/2005-01/msg00122.html)
191
192 ### Trampoline Code Page instead of direct syscalls
193 * 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.
194
195 ### Compressed in-memory swap device
196 * A device that uses physical memory as swap space, but compresses it.
197 * 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.
198
199 ### tmpfs allocations from swap
200 * Currently, tmpfs nodes and stuff are allocated from KVA are the size limiter for a tmpfs filesystem
201 * Instead allocate them from swappable memory; this will allow larger tmpfses up to swap limits
202
203 ### mmap MAP_ALIGN
204 * Solaris's mmap support a flag, MAP_ALIGN, where the address to mmap acts as an alignment hint
205 * Our backing VM calls support an alignment parameter, but our public mmap does not
206 * This would allow nmalloc to allocate slabs (64k, 64k-aligned) without wastage
207
208 ### vnode dumps
209 * It would be beneficial to be able to have crash dumps written to an ordinary file in configurations where swap is not configured.
210
211
212 For more theoretical projects and project concepts see [[ResearchProjects|/docs/developer/ResearchProjectsPage]]