(no commit message)
[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 ## Documentation projects 
10
11 ### Write manpages
12 * sysref (GCI:Documentation or Research)
13
14 ## Userland projects 
15
16 ### One-liners
17 * Bring in smbfs changes from FreeBSD (GCI:Code)
18 * rpc.lockd and rpc.statd sync with FreeBSD (GCI:Code)
19 * Add extended slice support to `fdisk`
20 * C99 Standards Conformance. The todo list is on [[/docs/developer/StandardsConformanceProject]] (GCI:Code)
21 * Add lwp support to ptrace/gdb/core dumps.
22 * UTF8 support in the console
23
24 ### dma
25 * Make dma(8) our default MTA
26 * Remove sendmail (optional)
27
28 ### Scalability (algorithmic performance) (GCI:Research)
29 * [http://bulk.fefe.de/scalability/](http://bulk.fefe.de/scalability/) 
30 * [http://bulk.fefe.de/lk2006/talk.pdf](http://bulk.fefe.de/lk2006/talk.pdf)
31
32 ### Clean our code to make it [style(9)](http://leaf.dragonflybsd.org/cgi/web-man?command=style&section=ANY#style&sectionANY) compatible.  (GCI:Code)
33 * Compile and test your changes.
34 * Verify that the checksum (sha(1)) of the unmodified object matches the checksum of the cleaned object.  Check also with strip(1)+sha(1)  
35
36 ### Port BSD-licensed tools (ex: `grep`, `diff` and `sort`) (GCI:Code)
37 * The OpenBSD guys already did some work related to that.
38 * If you manage to bring the tools to DragonFly, check if everything works as expected (e.g. rc.d scripts, make world runs, ...).
39
40 ### GDB
41 * ptrace/gdb follow-fork-mode support and more (peek at linux)
42 * Change the build to create one libbfd for gdb and binutils
43 * Separate RPC code from NFS into separate library.
44
45 ### I/O diagnostic utilities
46 * A utility similar to top which displays I/O usage on a per-process basis
47 * Network, Disk
48
49 ### SMART capabilities
50 * Add to camcontrol
51 * Add to natacontrol (see NetBSD's atactl?)
52
53 ### Disk scheduling rc scripts (GCI:Code)
54 * Create a rc script to manage the disk/io scheduling system
55 * 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
56 * Per-device and device class or similar defaults should be definable in rc.conf also
57 * 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.
58
59 ### libHAMMER 
60 * HAMMER has the capability to expose very rich information to userland through ioctl's.
61 * Currently the hammer(8) utility makes use of this information in an ad-hoc manner.
62 * Port this core functionality into a public libhammer library so that other base and third party utilities may take advantage of it.
63 * See commit: cb7575e6a89409a2041a37fcfc22ce9e41297ab8 -- libHAMMER already exists, port functionality into it!
64
65 ### Clean up crypt(3) consumers
66 * crypt(3) can legitimately return NULL on error, but many consumers do not check for this, instead passing the return directly to str[n]cmp. Fix these cases.
67 * Fix these cases in pkgsrc as well.
68
69 ### Live images enhancement
70
71 The live images could be made easier to use by not assuming a QWERTY keyboard layout.
72
73 Not beeing able to choose a localized keyboard layout before having to type 'installer' or 'root' may be a deal breaker for some users.
74 A simple menu replacing login(1) and displaying the following three choices could be a good solution:
75
76 1. Set keyboard layout
77 2. Launch the installer
78 3. Login as root
79
80 ## Kernel projects 
81
82 ### One-liners
83 * Port the BSDL OSS code to DragonFly
84 * 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.
85 * 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)
86 * Port or update drivers from other systems.
87 * Port Linux emulation to x86-64
88
89 ### Code to port/sync from FreeBSD
90 * PCI code (to take advantage of power saving features)
91 * Bring in support for UFS2, just the changes to extend the width of some fields from 32 bits to 64 bits.  (GCI:Code)
92 * hardware drivers. 
93 * ext2fs
94 * DTrace
95
96 ### Code to port/sync from OpenBSD
97 * 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).
98 * After that, make user stacks and data heaps non-executable. (W^X)
99 * hardware drivers, specially wireless.
100
101 ### CPU scheduler
102 * A scheduler API supporting multiple scheduler implementations already exists
103 * Add a Solaris-like dispatcher framework that can handle more than one installed scheduling policy
104
105 ### I/O scheduler
106 * A pluggable kernel I/O scheduler already exists
107 * Implement additional disk scheduling policies
108
109 ### Implement boot cache
110 * Effectively a smart readahead.
111 * Store the pattern of incoming read requests of the boot disk.
112
113 ### Improve kernel boot speed
114 * Research source of delays in boot process, keyboard init, scsi?
115 * Better thread some hardware init, for example USB?
116 * Perhaps look to see how Linux can boot in one second, better pci scan code?
117 * "Some kernel work made it possible to do asynchronous initialization of some subsystems. For example, the modified kernel starts the Advanced Host Controller Interface (AHCI) initialization, to handle storage, at the same time as the Universal Host Controller Interface (UHCI), in order to handle USB" - http://lwn.net/Articles/299483/
118
119 ### Modify firmware framework 
120 * We currently use the firmware(9) FreeBSD also uses
121 * 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).
122 * See "firmware discussion" thread on kernel@ mailing list, March-May 2010.
123 * Since it's not desired to just add another way of doing it, this project should include getting rid of loading firmwares as modules
124
125 ### Work relating to LWKT (LightWeightKernelThreading)
126 * Implement lazy IPI cross-processor lwkt message passing.
127 * Add timeout functionality to lwkt_waitmsg().
128
129 ### Filesystem extended attributes
130 * Generic VFS attributes layer
131 * Emulate attributes ala Darwin
132 * Allow filesystems to define their own attribute vop ops
133 * QUESTIONS: Attributes or subfiles? The consensus is that subfiles are better?
134
135 ### Capabilities
136 * Implement something resembling or inspired by POSIX.1e
137 * This implementation could possibly exist in userland and interlock with the kernel via a VFS Journal or HAMMER mirroring ioctl's.
138 * These should be capable of supporting NFSv4 capabilities.
139 * References: [1](http://leaf.dragonflybsd.org/mailarchive/kernel/2006-07/msg00012.html)
140
141 ### Hardware virtualization extensions
142 * Increase performance of virtual kernels
143 * Make use of hardware virtualization extensions, if supported, to manage vmspaces
144 * Implement a KVM-compatible virtualization device to support qemu
145 * Hardware IOMMU support is not a priority and if implemented must be strictly optional.
146
147 ### Remove zalloc
148 * zalloc is a deprecated kernel interface and all current consumers can be ported to objcache, with varying levels of difficulty.
149 * zlib, pv entries
150 * Once all consumers are ported, zalloc can be removed.
151
152 ### Convert kprintf-enabling sysctl's to KTR's
153 * Many sysctl's simply enable one or more kernel kprintf's
154 * This can be very easy, or can be very unwieldy
155 * Convert all of these cases to ktr's, while slightly less easy they are far easier to wield in all cases.
156
157 ### Tear out C/H/S disk reporting
158 * Cylinders/Heads/Sectors are an outdated concept and the system doesn't rely on them anymore.
159 * Verify the assumption that we don't rely on them in any way, shape or form.
160 * Tear the reporting out of the kernel/installer/etc.
161
162 ### Change vm_map lookup algorithm
163 * The vm_map lookups currently use a Red-Black tree, since 2005.
164 * It has been decided that using an array'ized bucket'ized hash table is probably a better approach.
165 * References: [1](http://kerneltrap.org/mailarchive/freebsd-current/2010/10/1/6260944) [2](http://leaf.dragonflybsd.org/mailarchive/kernel/2005-01/msg00122.html)
166
167 ### Trampoline Code Page instead of direct syscalls
168 * 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.
169
170 ### Compressed in-memory swap device
171 * A device that uses physical memory as swap space, but compresses it.
172 * 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.
173
174 ### mmap MAP_ALIGN
175 * Solaris's mmap support a flag, MAP_ALIGN, where the address to mmap acts as an alignment hint
176 * Our backing VM calls support an alignment parameter, but our public mmap does not
177 * This would allow nmalloc to allocate slabs (64k, 64k-aligned) without wastage
178
179 ### vnode dumps
180 * It may be beneficial to be able to have crash dumps written to an ordinary file in configurations where swap is not configured.
181
182 ### vnode swap
183 * Add a vnode-backed swap pager that respects a file size limit, to allow paging to a "swap file" on a filesystem.
184
185 ### Kernel allocator feature enhancements
186 * 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.
187 * Rework the kmalloc allocator to sit on top of objcache (there are various dependencies to making this work).
188 * Create or sort out a metric for vnode/other cache object cycling rate that can indicate realistic memory pressure.
189 * Clear out free objcache slabs under memory pressure.
190 * Add reclaim functionality to objcache, such that it may ask consumers to free objects back into it under memory pressure.
191
192 ### Tear out serializers
193 * Serializers could be _carefully_ replaced with MTX locks?
194
195 ### Tear out condvars
196 * Conditional vars -- condvar(9), could be replaced with other locking primitives and our tsleep/wakeup interlock.
197
198 ### Make karc4random in libkern per-cpu (or at least wrap its own token around it)
199 * Verify that it is possible and safe to do this, what care would need to be taken, especially with respect to the random seeding?
200 * Pull out locks around calls to karc4rand*
201
202 ### Improve kernel spinlock debug-ability
203 * Add a const char *descr  field to the spinlock structure.
204 * Adjust spin_init() and all use cases, SPINLOCK_INITIALIZER() could juse use macro string extensions (# head) to install the name there.
205 * Adjust error messages to print the spinlock desc field.
206 * This change will require a full world & kernel recompile.
207
208 ### Partially rewrite buffer cache
209 * Buffer cache buffers map VM pages from the filesystems VM-backed vnodes, the "buffer space" is the maximum amount of virtual space to allocate to these buffers.
210 * When the buffer_map KVA space gets fragmented it caused very expensive defrag operations, the buffer_map KVA was recently increased to double the actual buffer space to allow full space utilization in the face of fragmentation and reduce the frequency of defrag operations.
211 * Rewrite the buffer cache to have separate spaces or separate buffer pools for different sizes (16, 32, 64, 128, 256... up to max).
212 * The vm_map API is used to allocate kvm out of the buffer_map.  If the buffer's KVAs are preallocated then things can basically just be setup linearly at boot time.
213
214 ### Sync wireless infrastructure / drivers from FreeBSD
215 * Rui Paulo ported the wireless infrastructure and ath drivers to DragonFly from FreeBSD in recent history. A lot has changed in the intervening time, the infrastructure should be synchronized/updated to match the state-of-the-art in FreeBSD. At a minimum the drivers that currently work in DragonFly should be tested to ensure functionality and updates as well or improved.
216
217 ### Add informational hardware-related sysctl's
218 * MacOS X exports a bunch of cpu-specific sysctl's detailing sizes, layout, features, etc. Most/all of this could be detected by a userspace program, but exporting these makes the barrier of entry to cpu-conditional code lower.
219 * Research which of these sysctl's is the most useful and add them, using the same node names as OSX.
220 1. hw.vectorunit = 1
221 1. hw.busfrequency = 100000000
222 1. hw.cpufrequency = 3062000000
223 1. hw.cachelinesize = 64
224 1. hw.l1icachesize = 32768
225 1. hw.l1dcachesize = 32768
226 1. hw.l2settings = 1
227 1. hw.l2cachesize = 262144
228 1. hw.l3settings = 1
229 1. hw.l3cachesize = 6291456
230 1. hw.tbfrequency = 1000000000
231 1. hw.activecpu: 2
232 1. hw.physicalcpu: 2
233 1. hw.physicalcpu_max: 2
234 1. hw.logicalcpu: 2
235 1. hw.logicalcpu_max: 2
236 1. hw.cputype: 7
237 1. hw.cpusubtype: 4
238 1. hw.cpu64bit_capable: 1
239 1. hw.cpufamily: 1418770316
240 1. hw.cacheconfig: 2 1 1 1 0 0 0 0 0 0
241 1. hw.cachesize: 2147483648 32768 262144 6291456 0 0 0 0 0 0
242 1. hw.busfrequency: 100000000
243 1. hw.busfrequency_min: 100000000
244 1. hw.busfrequency_max: 100000000
245 1. hw.cpufrequency: 3062000000
246 1. hw.cpufrequency_min: 3062000000
247 1. hw.cpufrequency_max: 3062000000
248 1. hw.cachelinesize: 64
249 1. hw.l1icachesize: 32768
250 1. hw.l1dcachesize: 32768
251 1. hw.l2cachesize: 262144
252 1. hw.l3cachesize: 6291456
253 1. hw.tbfrequency: 1000000000
254 1. hw.packages: 2
255 1. hw.optional.floatingpoint: 1
256 1. hw.optional.mmx: 1
257 1. hw.optional.sse: 1
258 1. hw.optional.sse2: 1
259 1. hw.optional.sse3: 1
260 1. hw.optional.supplementalsse3: 1
261 1. hw.optional.sse4_1: 1
262 1. hw.optional.sse4_2: 1
263 1. hw.optional.x86_64: 1
264 1. hw.optional.aes: 1
265 1. hw.optional.avx1_0: 1
266 1. hw.optional.rdrand: 0
267 1. hw.optional.f16c: 0
268 1. hw.optional.enfstrg: 0
269 1. machdep.cpu.max_basic: 13
270 1. machdep.cpu.max_ext: 2147483656
271 1. machdep.cpu.vendor: GenuineIntel
272 1. machdep.cpu.brand_string: Intel(R) Core(TM) i5-3470 CPU @ 3.20GHz
273 1. machdep.cpu.family: 6
274 1. machdep.cpu.model: 42
275 1. machdep.cpu.extmodel: 2
276 1. machdep.cpu.extfamily: 0
277 1. machdep.cpu.stepping: 7
278 1. machdep.cpu.feature_bits: 262929407 2660770315
279 1. machdep.cpu.extfeature_bits: 672139520 1
280 1. machdep.cpu.signature: 132775
281 1. machdep.cpu.brand: 0
282 1. machdep.cpu.features: FPU VME DE PSE TSC MSR PAE MCE CX8 APIC SEP MTRR PGE MCA CMOV PAT PSE36 CLFSH DS MMX FXSR SSE SSE2 SS SSE3 PCLMULQDQ MON SSSE3 CX16 SSE4.1 SSE4.2 POPCNT AES VMM XSAVE OSXSAVE AVX1.0
283 1. machdep.cpu.extfeatures: SYSCALL XD EM64T LAHF RDTSCP TSCI
284 1. machdep.cpu.cores_per_package: 1
285 1. machdep.cpu.microcode_version: 16
286 1. machdep.cpu.processor_flag: 0
287 1. machdep.cpu.mwait.linesize_min: 4096
288 1. machdep.cpu.mwait.linesize_max: 4096
289 1. machdep.cpu.mwait.extensions: 3
290 1. machdep.cpu.mwait.sub_Cstates: 4384
291 1. machdep.cpu.xsave.extended_state: 7 832 832 0
292 1. machdep.cpu.arch_perf.version: 1
293 1. machdep.cpu.arch_perf.number: 8
294 1. machdep.cpu.arch_perf.width: 48
295 1. machdep.cpu.arch_perf.events_number: 7
296 1. machdep.cpu.arch_perf.events: 127
297 1. machdep.cpu.arch_perf.fixed_number: 0
298 1. machdep.cpu.arch_perf.fixed_width: 0
299 1. machdep.cpu.cache.linesize: 64
300 1. machdep.cpu.cache.L2_associativity: 8
301 1. machdep.cpu.cache.size: 256
302 1. machdep.cpu.tlb.inst.small: 128
303 1. machdep.cpu.tlb.data.small: 64
304 1. machdep.cpu.tlb.data.large: 32
305 1. machdep.cpu.tlb.shared: 512
306 1. machdep.cpu.address_bits.physical: 40
307 1. machdep.cpu.address_bits.virtual: 48
308 1. machdep.cpu.core_count: 1
309 1. machdep.cpu.thread_count: 1
310
311
312 For more theoretical projects and project concepts see [[ResearchProjects|/docs/developer/ResearchProjectsPage]]