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