Cleanup
[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 ## Userland projects 
40
41 ### One-liners
42 * Update the [[contributed software|docs/user/ContribSoftware]] which is out-of-date.
43 * Remove `NOINET6` build option
44 * `WARN` corrections to utilities
45 * Bring in code from other *BSDs:
46 * smbfs changes from FreeBSD
47 * Add extended slice support to `fdisk`
48 * 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.
49 * C99 Standards Conformance. The todo list is on [[/docs/developer/StandardsConformanceProject]]
50 * Setup a regression testing machine/system to register and find problems and new improvements..
51 * Networking performance / scalability
52 * [[RegressionTest|/docs/developer/RegressionTest]]
53 * also check [[HowToStressTest|/docs/developer/HowToStressTest]]
54 * Add lwp support to ptrace/gdb/core dumps.
55 * Bringing in version 2.0 of the BSD Installer
56 * UTF8 support in the console
57
58 ### Scalability (algorithmic performance)
59 * [http://bulk.fefe.de/scalability/](http://bulk.fefe.de/scalability/)
60 * [http://bulk.fefe.de/lk2006/talk.pdf](http://bulk.fefe.de/lk2006/talk.pdf)
61
62 ### Clean our code to make it [style(9)](http://leaf.dragonflybsd.org/cgi/web-man?command#style&sectionANY) compatible.
63 * Compile and test your changes.
64 * Verify that the checksum (sha(1)) of the unmodified object matches the checksum of the cleaned object.  Check also with strip(1)+sha(1)
65
66 ### Port BSD-licensed tools (ex: `grep`, `diff` and `sort`)
67 * The OpenBSD guys already did some work related to that.
68 * If you manage to bring the tools to DragonFly, check if everything works as expected (e.g. rc.d scripts, make world runs, ...).
69 * The new tools need to have at least all the features of the old GNU tools.
70
71 ### Randomize mmap() offsets
72 * [http://www.openbsd.org/papers/ven05-deraadt/index.html](http://www.openbsd.org/papers/ven05-deraadt/index.html)
73
74 ### GDB
75 * ptrace/gdb follow-fork-mode support and more (peek at linux)
76 * Change the build to create one libbfd for gdb and binutils
77 * Separate RPC code from NFS into separate library.
78
79 ### I/O diagnostic utilities
80 * A utility similar to top which displays I/O usage on a per-process basis
81 * Network, Disk
82
83 ### SMART capabilities
84 * Add to natacontrol (see NetBSD's atactl?)
85 * Add to camcontrol
86
87 ### Disk scheduling rc scripts
88 * Create a rc script to manage the disk/io scheduling system
89 * 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
90 * Per-device and device class or similar defaults should be definable in rc.conf also
91 * 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.
92
93 ### Add usage() to vkernels
94 * 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.
95 * Add a usage() to the vkernel's argument parsing.
96
97 ### libHAMMER
98 * HAMMER has the capability to expose very rich information to userland through ioctl's.
99 * Currently the hammer(8) utility makes use of this information in an ad-hoc manner.
100 * Port this core functionality into a public libhammer library so that other base and third party utilities may take advantage of it.
101
102 ## Kernel projects 
103
104 ### One-liners
105 * Port the BSDL OSS code to DragonFly
106 * 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.
107 * 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.
108 * 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).
109 * 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)
110 * Setup a regression testing machine/system to register and find problems and new improvements..
111 * Port or update drivers from other systems.
112 * Port NFSv4.  [This mail](http://leaf.dragonflybsd.org/mailarchive/kernel/2008-01/msg00065.html) is a good starting point.
113 * clean up buildworld/kernel compilation warnings
114 * Port DTrace
115 * Port Linux emulation to x86-64
116
117 ### Code to port/sync from FreeBSD
118 * PCI code (to take advantage of power saving features)
119 * Bring in support for UFS2, just the changes to extend the width of some fields from 32 bits to 64 bits.
120 * hardware drivers.
121
122 ### Code to port/sync from OpenBSD
123 * 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).
124 * After that, make user stacks and data heaps non-executable. (W^X)
125 * hardware drivers, specially wireless.
126
127 ### CPU scheduler
128 * A scheduler API supporting multiple scheduler implementations already exists
129 * Add a Solaris-like dispatcher framework that can handle more than one installed scheduling policy
130
131 ### I/O scheduler
132 * A pluggable kernel I/O scheduler already exists
133 * Implement additional disk scheduling policies
134
135 ### Modify firmware framework
136 * We currently use the firmware(9) FreeBSD also uses
137 * 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).
138 * See "firmware discussion" thread on kernel@ mailing list, March-May 2010.
139 * Since it's not desired to just add another way of doing it, this project should include getting rid of loading firmwares as modules
140
141 ### Work relating to LWKT (LightWeightKernelThreading)
142 * Implement lazy IPI cross-processor lwkt message passing.
143 * Add timeout functionality to lwkt_waitmsg().
144 * Write man pages for the lwkt message passing API.
145
146 ### Filesystem extended attributes
147 * Generic VFS attributes layer
148 * Emulate attributes ala Darwin
149 * Allow filesystems to define their own attribute vop ops
150 * QUESTIONS: Attributes or subfiles? The consensus is that subfiles are better?
151
152 ### Capabilities
153 * Implement something resembling or inspired by POSIX.1e
154 * This implementation could possibly exist in userland and interlock with the kernel via a VFS Journal or HAMMER mirroring ioctl's.
155 * These should be capable of supporting NFSv4 capabilities.
156 * References: [1](http://leaf.dragonflybsd.org/mailarchive/kernel/2006-07/msg00012.html)
157
158 ### Hardware virtualization extensions
159 * Increase performance of virtual kernels
160 * Make use of hardware virtualization extensions, if supported, to manage vmspaces
161 * Make use of hardware IOMMU support if available
162
163 ### Remove zalloc
164 * zalloc is a deprecated kernel interface and all current consumers can be ported to objcache, with varying levels of difficulty.
165 * Easier: kqueue, nfs nodes, ufs dirhash, aio, crypto, vm_map_entry
166 * Harder: zlib, pv entries
167 * Once all consumers are ported, zalloc can be removed.
168
169 ### Document all sysctl's
170 * 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.
171 * Document all undocumented sysctl's
172 * Verify that the description of documented sysctl's is correct.
173
174 ### Convert kprintf-enabling sysctl's to KTR's
175 * Many sysctl's simply enable one or more kernel kprintf's
176 * This can be very easy, or can be very unwieldy
177 * Convert all of these cases to ktr's, while slightly less easy they are far easier to wield in all cases.
178
179
180 For more theoretical projects and project concepts see [[ResearchProjects|/docs/developer/ResearchProjectsPage]]