(no commit message)
[ikiwiki.git] / docs / developer / ProjectsPage.mdwn
8c0cdf29 1# DragonFly Projects
b790f880 2
8c0cdf29 3This 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.
b790f880 4
b1b401e0 5Projects 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.
8c0cdf29 7[[!toc levels=3 ]]
b790f880 8
8c0cdf29 9## Documentation projects
b790f880 10
87bf445d 11### Write manpages
b1b401e0 12* sysref (GCI:Documentation or Research)
87bf445d 13
8c0cdf29 14## Userland projects
b790f880 15
06d07101 16### One-liners
8116f646 17* Bring in smbfs changes from FreeBSD (GCI:Code)
1571f8e5 18* rpc.lockd and rpc.statd sync with FreeBSD (GCI:Code)
8753e704 19* Add extended slice support to `fdisk`
b1b401e0 20* C99 Standards Conformance. The todo list is on [[/docs/developer/StandardsConformanceProject]] (GCI:Code)
8753e704 21* Add lwp support to ptrace/gdb/core dumps.
8753e704 22* UTF8 support in the console
06d07101 23
8116f646 24### dma
25* Make dma(8) our default MTA
26* Remove sendmail (optional)
b1b401e0 28### Scalability (algorithmic performance) (GCI:Research)
29* [http://bulk.fefe.de/scalability/](http://bulk.fefe.de/scalability/)
8753e704 30* [http://bulk.fefe.de/lk2006/talk.pdf](http://bulk.fefe.de/lk2006/talk.pdf)
06d07101 31
4e927740 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)
8753e704 33* Compile and test your changes.
b1b401e0 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)
06d07101 35
b1b401e0 36### Port BSD-licensed tools (ex: `grep`, `diff` and `sort`) (GCI:Code)
8753e704 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, ...).
06d07101 39
99e24f21 40### GDB
8753e704 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.
45### I/O diagnostic utilities
46* A utility similar to top which displays I/O usage on a per-process basis
47* Network, Disk
8c0cdf29 48
05f26292 49### SMART capabilities
05f26292 50* Add to camcontrol
8e7be9e6 51* Add to natacontrol (see NetBSD's atactl?)
05f26292 52
b1b401e0 53### Disk scheduling rc scripts (GCI:Code)
05f26292 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
dcf86f60 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.
05f26292 58
b1b401e0 59### libHAMMER
3eda57ef 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.
8e7be9e6 63* See commit: cb7575e6a89409a2041a37fcfc22ce9e41297ab8 -- libHAMMER already exists, port functionality into it!
3eda57ef 64
5dd9f19a 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.
d299f726 69### Live images enhancement
71The live images could be made easier to use by not assuming a QWERTY keyboard layout.
73Not beeing able to choose a localized keyboard layout before having to type 'installer' or 'root' may be a deal breaker for some users.
74A simple menu replacing login(1) and displaying the following three choices could be a good solution:
761. Set keyboard layout
772. Launch the installer
783. Login as root
2330756a 80### pkill/pgrep enhancement
82killall recently gained a -T flag to kill all descendents of a tty, bring this feature to pkill/pgrep and evaluate any other features flags of these utilities and bring them to parity.
8c0cdf29 84## Kernel projects
06d07101 86### One-liners
8753e704 87* Port the BSDL OSS code to DragonFly
88* 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.
b1b401e0 89* 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)
8753e704 90* Port or update drivers from other systems.
52dfca9b 91* Port Linux emulation to x86-64
06d07101 92
93### Code to port/sync from FreeBSD
8753e704 94* PCI code (to take advantage of power saving features)
b1b401e0 95* Bring in support for UFS2, just the changes to extend the width of some fields from 32 bits to 64 bits. (GCI:Code)
96* hardware drivers.
8116f646 97* ext2fs
98* DTrace
99e24f21 99
06d07101 100### Code to port/sync from OpenBSD
8753e704 101* 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).
102* After that, make user stacks and data heaps non-executable. (W^X)
103* hardware drivers, specially wireless.
06d07101 104
df817d42 105### CPU scheduler
8753e704 106* A scheduler API supporting multiple scheduler implementations already exists
107* Add a Solaris-like dispatcher framework that can handle more than one installed scheduling policy
06d07101 108
109### I/O scheduler
df817d42 110* A pluggable kernel I/O scheduler already exists
111* Implement additional disk scheduling policies
8753e704 112
43da2530 113### Implement boot cache
114* Effectively a smart readahead.
7957e767 115* Store the pattern of incoming read requests of the boot disk.
43da2530 116
c1941460 117### Improve kernel boot speed
118* Research source of delays in boot process, keyboard init, scsi?
119* Better thread some hardware init, for example USB?
120* Perhaps look to see how Linux can boot in one second, better pci scan code?
ab4ba9d2 121* "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/
c1941460 122
b1b401e0 123### Modify firmware framework
1ac22aa1 124* We currently use the firmware(9) FreeBSD also uses
125* 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).
126* See "firmware discussion" thread on kernel@ mailing list, March-May 2010.
ca622843 127* Since it's not desired to just add another way of doing it, this project should include getting rid of loading firmwares as modules
1ac22aa1 128
8753e704 129### Work relating to LWKT (LightWeightKernelThreading)
130* Implement lazy IPI cross-processor lwkt message passing.
131* Add timeout functionality to lwkt_waitmsg().
8753e704 132
133### Filesystem extended attributes
134* Generic VFS attributes layer
135* Emulate attributes ala Darwin
136* Allow filesystems to define their own attribute vop ops
137* QUESTIONS: Attributes or subfiles? The consensus is that subfiles are better?
b6a0e48f 139### Capabilities
140* Implement something resembling or inspired by POSIX.1e
141* This implementation could possibly exist in userland and interlock with the kernel via a VFS Journal or HAMMER mirroring ioctl's.
142* These should be capable of supporting NFSv4 capabilities.
143* References: [1](http://leaf.dragonflybsd.org/mailarchive/kernel/2006-07/msg00012.html)
8753e704 145### Hardware virtualization extensions
146* Increase performance of virtual kernels
147* Make use of hardware virtualization extensions, if supported, to manage vmspaces
0b48e63b 148* Implement a KVM-compatible virtualization device to support qemu
8898930f 149* Hardware IOMMU support is not a priority and if implemented must be strictly optional.
8753e704 150
f1dc70a1 151### Remove zalloc
152* zalloc is a deprecated kernel interface and all current consumers can be ported to objcache, with varying levels of difficulty.
48b27198 153* zlib, pv entries
f1dc70a1 154* Once all consumers are ported, zalloc can be removed.
97f327a5 155
b6a0e48f 156### Convert kprintf-enabling sysctl's to KTR's
157* Many sysctl's simply enable one or more kernel kprintf's
158* This can be very easy, or can be very unwieldy
159* Convert all of these cases to ktr's, while slightly less easy they are far easier to wield in all cases.
8116f646 161### Tear out C/H/S disk reporting
bd0ac588 162* Cylinders/Heads/Sectors are an outdated concept and the system doesn't rely on them anymore.
163* Verify the assumption that we don't rely on them in any way, shape or form.
164* Tear the reporting out of the kernel/installer/etc.
e2952a1f 166### Change vm_map lookup algorithm
167* The vm_map lookups currently use a Red-Black tree, since 2005.
168* It has been decided that using an array'ized bucket'ized hash table is probably a better approach.
169* References: [1](http://kerneltrap.org/mailarchive/freebsd-current/2010/10/1/6260944) [2](http://leaf.dragonflybsd.org/mailarchive/kernel/2005-01/msg00122.html)
97f327a5 170
171### Trampoline Code Page instead of direct syscalls
172* 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.
174### Compressed in-memory swap device
175* A device that uses physical memory as swap space, but compresses it.
176* 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.
3114c38f 178### mmap MAP_ALIGN
179* Solaris's mmap support a flag, MAP_ALIGN, where the address to mmap acts as an alignment hint
180* Our backing VM calls support an alignment parameter, but our public mmap does not
181* This would allow nmalloc to allocate slabs (64k, 64k-aligned) without wastage
fb27736e 183### vnode dumps
8116f646 184* It may be beneficial to be able to have crash dumps written to an ordinary file in configurations where swap is not configured.
186### vnode swap
187* Add a vnode-backed swap pager that respects a file size limit, to allow paging to a "swap file" on a filesystem.
fb27736e 188
af80ec85 189### Kernel allocator feature enhancements
190* 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.
60f380f8 191* Rework the kmalloc allocator to sit on top of objcache (there are various dependencies to making this work).
192* Create or sort out a metric for vnode/other cache object cycling rate that can indicate realistic memory pressure.
193* Clear out free objcache slabs under memory pressure.
194* Add reclaim functionality to objcache, such that it may ask consumers to free objects back into it under memory pressure.
af80ec85 195
8e7be9e6 196### Tear out serializers
8116f646 197* Serializers could be _carefully_ replaced with MTX locks?
8e7be9e6 198
199### Tear out condvars
200* Conditional vars -- condvar(9), could be replaced with other locking primitives and our tsleep/wakeup interlock.
c52e2798 202### Make karc4random in libkern per-cpu (or at least wrap its own token around it)
8ac2913d 203* Verify that it is possible and safe to do this, what care would need to be taken, especially with respect to the random seeding?
204* Pull out locks around calls to karc4rand*
d882bf8a 206### Improve kernel spinlock debug-ability
207* Add a const char *descr field to the spinlock structure.
208* Adjust spin_init() and all use cases, SPINLOCK_INITIALIZER() could juse use macro string extensions (# head) to install the name there.
209* Adjust error messages to print the spinlock desc field.
210* This change will require a full world & kernel recompile.
d866bea9 212### Partially rewrite buffer cache
213* 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.
214* 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.
215* Rewrite the buffer cache to have separate spaces or separate buffer pools for different sizes (16, 32, 64, 128, 256... up to max).
216* 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.
29685166 218### Sync wireless infrastructure / drivers from FreeBSD
219* 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.
ff694554 221### Add informational hardware-related sysctl's
222* 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.
223* Research which of these sysctl's is the most useful and add them, using the same node names as OSX.
2241. hw.vectorunit = 1
2251. hw.busfrequency = 100000000
2261. hw.cpufrequency = 3062000000
2271. hw.cachelinesize = 64
2281. hw.l1icachesize = 32768
2291. hw.l1dcachesize = 32768
2301. hw.l2settings = 1
2311. hw.l2cachesize = 262144
2321. hw.l3settings = 1
2331. hw.l3cachesize = 6291456
2341. hw.tbfrequency = 1000000000
2351. hw.activecpu: 2
2361. hw.physicalcpu: 2
2371. hw.physicalcpu_max: 2
2381. hw.logicalcpu: 2
2391. hw.logicalcpu_max: 2
2401. hw.cputype: 7
2411. hw.cpusubtype: 4
2421. hw.cpu64bit_capable: 1
2431. hw.cpufamily: 1418770316
2441. hw.cacheconfig: 2 1 1 1 0 0 0 0 0 0
2451. hw.cachesize: 2147483648 32768 262144 6291456 0 0 0 0 0 0
2461. hw.busfrequency: 100000000
2471. hw.busfrequency_min: 100000000
2481. hw.busfrequency_max: 100000000
2491. hw.cpufrequency: 3062000000
2501. hw.cpufrequency_min: 3062000000
2511. hw.cpufrequency_max: 3062000000
2521. hw.cachelinesize: 64
2531. hw.l1icachesize: 32768
2541. hw.l1dcachesize: 32768
2551. hw.l2cachesize: 262144
2561. hw.l3cachesize: 6291456
2571. hw.tbfrequency: 1000000000
2581. hw.packages: 2
2591. hw.optional.floatingpoint: 1
2601. hw.optional.mmx: 1
2611. hw.optional.sse: 1
2621. hw.optional.sse2: 1
2631. hw.optional.sse3: 1
2641. hw.optional.supplementalsse3: 1
2651. hw.optional.sse4_1: 1
2661. hw.optional.sse4_2: 1
2671. hw.optional.x86_64: 1
2681. hw.optional.aes: 1
2691. hw.optional.avx1_0: 1
2701. hw.optional.rdrand: 0
2711. hw.optional.f16c: 0
2721. hw.optional.enfstrg: 0
2731. machdep.cpu.max_basic: 13
2741. machdep.cpu.max_ext: 2147483656
2751. machdep.cpu.vendor: GenuineIntel
2761. machdep.cpu.brand_string: Intel(R) Core(TM) i5-3470 CPU @ 3.20GHz
2771. machdep.cpu.family: 6
2781. machdep.cpu.model: 42
2791. machdep.cpu.extmodel: 2
2801. machdep.cpu.extfamily: 0
2811. machdep.cpu.stepping: 7
2821. machdep.cpu.feature_bits: 262929407 2660770315
2831. machdep.cpu.extfeature_bits: 672139520 1
2841. machdep.cpu.signature: 132775
2851. machdep.cpu.brand: 0
2871. machdep.cpu.extfeatures: SYSCALL XD EM64T LAHF RDTSCP TSCI
2881. machdep.cpu.cores_per_package: 1
2891. machdep.cpu.microcode_version: 16
2901. machdep.cpu.processor_flag: 0
2911. machdep.cpu.mwait.linesize_min: 4096
2921. machdep.cpu.mwait.linesize_max: 4096
2931. machdep.cpu.mwait.extensions: 3
2941. machdep.cpu.mwait.sub_Cstates: 4384
2951. machdep.cpu.xsave.extended_state: 7 832 832 0
2961. machdep.cpu.arch_perf.version: 1
2971. machdep.cpu.arch_perf.number: 8
2981. machdep.cpu.arch_perf.width: 48
2991. machdep.cpu.arch_perf.events_number: 7
3001. machdep.cpu.arch_perf.events: 127
3011. machdep.cpu.arch_perf.fixed_number: 0
3021. machdep.cpu.arch_perf.fixed_width: 0
3031. machdep.cpu.cache.linesize: 64
3041. machdep.cpu.cache.L2_associativity: 8
3051. machdep.cpu.cache.size: 256
3061. machdep.cpu.tlb.inst.small: 128
3071. machdep.cpu.tlb.data.small: 64
3081. machdep.cpu.tlb.data.large: 32
3091. machdep.cpu.tlb.shared: 512
3101. machdep.cpu.address_bits.physical: 40
3111. machdep.cpu.address_bits.virtual: 48
3121. machdep.cpu.core_count: 1
3131. machdep.cpu.thread_count: 1
094b2c92 315
97f327a5 316For more theoretical projects and project concepts see [[ResearchProjects|/docs/developer/ResearchProjectsPage]]