Add sysctl cpu info task
[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 ## Website projects 
10
11 ### One-liners
12 * Add traffic report, especially to lists requests that cause 404s (GCI:Research)
13 * Add the mail archive to the search index (GCI:Documentation)
14 * Download link right on the main page.  
15 * Fix RSS feed to have correct links
16 * Create layout for http://bugs.dragonflybsd.org that matches the main site.  (GCI:User Interface)
17 * Create short list of tasks for a new DragonFly user 
18 * How to upgrade the operating system (GCI:Training)
19 * How to get to a working desktop (GCI:Training)
20 * and where and how to report issues.(GCI:Documentation)
21
22 ### Post papers in the proper locations on the website
23 * Format conversion may be necessary
24 * Aggelos's papers from [http://leaf.dragonflybsd.org/~aggelos/] (http://leaf.dragonflybsd.org/~aggelos/) (netmp-paper.pdf and netmp.pdf) to Presentations
25 * ["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
26 (GCI:Documentation)
27
28 ## Documentation projects 
29
30 ### One-liners
31 * Reorder `/usr/src/UPDATING` to put more relevant information at top; remove data no longer relevant.
32 * Help out in [http://bugs.dragonflybsd.org](http://bugs.dragonflybsd.org) (try to reproduce, diagnose, propose fixes ...)
33 * Organize, contribute to, and finish the C book project.
34
35 ### Handbook maintenance
36 * Check if the content applies to DragonFly.  If not, change it.
37 * Add new content and enhance the previous chapters
38 * Check for syntax error, typos and wiki errors. 
39 * Add prev/next buttons to all pages. (GCI:User Interface)
40
41
42 ### Write manpages
43 * sysref (GCI:Documentation or Research)
44
45 ## Userland projects 
46
47 ### One-liners
48 * Update the [[contributed software|docs/user/ContribSoftware]] which is out-of-date.
49 * Remove `NOINET6` build option
50 * `WARN` corrections to utilities (GCI:Code)
51 * Bring in code from other *BSDs:
52 * smbfs changes from FreeBSD (GCI:Code)
53 * Add extended slice support to `fdisk`
54 * 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.
55 * C99 Standards Conformance. The todo list is on [[/docs/developer/StandardsConformanceProject]] (GCI:Code)
56 * Setup a regression testing machine/system to register and find problems and new improvements. (GCI:Quality Assurance) 
57 * Networking performance / scalability ((GCI:Research)
58 * [[RegressionTest|/docs/developer/RegressionTest]] (GCI:Research)
59 * also check [[HowToStressTest|/docs/developer/HowToStressTest]] (GCI:Research)
60 * Add lwp support to ptrace/gdb/core dumps.
61 * Bringing in version 2.0 of the BSD Installer
62 * UTF8 support in the console
63
64 ### Scalability (algorithmic performance) (GCI:Research)
65 * [http://bulk.fefe.de/scalability/](http://bulk.fefe.de/scalability/) 
66 * [http://bulk.fefe.de/lk2006/talk.pdf](http://bulk.fefe.de/lk2006/talk.pdf)
67
68 ### Clean our code to make it [style(9)](http://leaf.dragonflybsd.org/cgi/web-man?command=style&section=ANY#style&sectionANY) compatible.  (GCI:Code)
69 * Compile and test your changes.
70 * Verify that the checksum (sha(1)) of the unmodified object matches the checksum of the cleaned object.  Check also with strip(1)+sha(1)  
71
72 ### Port BSD-licensed tools (ex: `grep`, `diff` and `sort`) (GCI:Code)
73 * The OpenBSD guys already did some work related to that.
74 * If you manage to bring the tools to DragonFly, check if everything works as expected (e.g. rc.d scripts, make world runs, ...).
75 * The new tools need to have at least all the features of the old GNU tools.
76
77 ### Randomize mmap() offsets
78 * [http://www.openbsd.org/papers/ven05-deraadt/index.html](http://www.openbsd.org/papers/ven05-deraadt/index.html)
79
80 ### GDB
81 * ptrace/gdb follow-fork-mode support and more (peek at linux)
82 * Change the build to create one libbfd for gdb and binutils
83 * Separate RPC code from NFS into separate library.
84
85 ### I/O diagnostic utilities
86 * A utility similar to top which displays I/O usage on a per-process basis
87 * Network, Disk
88
89 ### SMART capabilities
90 * Add to camcontrol
91 * Add to natacontrol (see NetBSD's atactl?)
92
93 ### Disk scheduling rc scripts (GCI:Code)
94 * Create a rc script to manage the disk/io scheduling system
95 * 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
96 * Per-device and device class or similar defaults should be definable in rc.conf also
97 * 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.
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 * See commit: cb7575e6a89409a2041a37fcfc22ce9e41297ab8 -- libHAMMER already exists, port functionality into it!
104
105 ### Clean up crypt(3) consumers
106 * 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.
107 * Fix these cases in pkgsrc as well.
108
109 ## Kernel projects 
110
111 ### One-liners
112 * Port the BSDL OSS code to DragonFly
113 * 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.
114 * 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.
115 * 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)
116 * 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)
117 * Setup a regression testing machine/system to register and find problems and new improvements. (GCI:Research)
118 * Port or update drivers from other systems.
119 * Port NFSv4.  [This mail](http://leaf.dragonflybsd.org/mailarchive/kernel/2008-01/msg00065.html) is a good starting point.
120 * clean up buildworld/kernel compilation warnings
121 * Port DTrace
122 * Port Linux emulation to x86-64
123
124 ### Code to port/sync from FreeBSD
125 * PCI code (to take advantage of power saving features)
126 * Bring in support for UFS2, just the changes to extend the width of some fields from 32 bits to 64 bits.  (GCI:Code)
127 * hardware drivers. 
128
129 ### Code to port/sync from OpenBSD
130 * 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).
131 * After that, make user stacks and data heaps non-executable. (W^X)
132 * hardware drivers, specially wireless.
133
134 ### CPU scheduler
135 * A scheduler API supporting multiple scheduler implementations already exists
136 * Add a Solaris-like dispatcher framework that can handle more than one installed scheduling policy
137
138 ### I/O scheduler
139 * A pluggable kernel I/O scheduler already exists
140 * Implement additional disk scheduling policies
141
142 ### Implement boot cache
143 * Effectively a smart readahead.
144 * Store the pattern of incoming read requests of the boot disk. (Likely into an array structure for better linear readback, We mmap() the whole thing into RAM on boot.)
145 * Sort pattern into a playback list. (Burstsort or a simple quick sort to get things going?)
146 * Provide feedback of boot cache playback list hit rate for better adaptiveness.
147
148 ### Improve kernel boot speed
149 * Research source of delays in boot process, keyboard init, scsi?
150 * Better thread some hardware init, for example USB?
151 * Perhaps look to see how Linux can boot in one second, better pci scan code?
152 * "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/
153
154 ### Modify firmware framework 
155 * We currently use the firmware(9) FreeBSD also uses
156 * 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).
157 * See "firmware discussion" thread on kernel@ mailing list, March-May 2010.
158 * Since it's not desired to just add another way of doing it, this project should include getting rid of loading firmwares as modules
159
160 ### Work relating to LWKT (LightWeightKernelThreading)
161 * Implement lazy IPI cross-processor lwkt message passing.
162 * Add timeout functionality to lwkt_waitmsg().
163
164 ### Filesystem extended attributes
165 * Generic VFS attributes layer
166 * Emulate attributes ala Darwin
167 * Allow filesystems to define their own attribute vop ops
168 * QUESTIONS: Attributes or subfiles? The consensus is that subfiles are better?
169
170 ### Capabilities
171 * Implement something resembling or inspired by POSIX.1e
172 * This implementation could possibly exist in userland and interlock with the kernel via a VFS Journal or HAMMER mirroring ioctl's.
173 * These should be capable of supporting NFSv4 capabilities.
174 * References: [1](http://leaf.dragonflybsd.org/mailarchive/kernel/2006-07/msg00012.html)
175
176 ### Hardware virtualization extensions
177 * Increase performance of virtual kernels
178 * Make use of hardware virtualization extensions, if supported, to manage vmspaces
179 * Implement a KVM-compatible virtualization device to support qemu
180 * Hardware IOMMU support is not a priority and if implemented must be strictly optional.
181
182 ### Remove zalloc
183 * zalloc is a deprecated kernel interface and all current consumers can be ported to objcache, with varying levels of difficulty.
184 * zlib, pv entries
185 * Once all consumers are ported, zalloc can be removed.
186
187 ### Document all sysctl's
188 * 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.
189 * Document all undocumented sysctl's
190 * Verify that the description of documented sysctl's is correct.
191
192 ### Convert kprintf-enabling sysctl's to KTR's
193 * Many sysctl's simply enable one or more kernel kprintf's
194 * This can be very easy, or can be very unwieldy
195 * Convert all of these cases to ktr's, while slightly less easy they are far easier to wield in all cases.
196
197 ### Tear out C/H/S disk reporting (GCI:Research)
198 * Cylinders/Heads/Sectors are an outdated concept and the system doesn't rely on them anymore.
199 * Verify the assumption that we don't rely on them in any way, shape or form.
200 * Tear the reporting out of the kernel/installer/etc.
201
202 ### Change vm_map lookup algorithm
203 * The vm_map lookups currently use a Red-Black tree, since 2005.
204 * It has been decided that using an array'ized bucket'ized hash table is probably a better approach.
205 * References: [1](http://kerneltrap.org/mailarchive/freebsd-current/2010/10/1/6260944) [2](http://leaf.dragonflybsd.org/mailarchive/kernel/2005-01/msg00122.html)
206
207 ### Trampoline Code Page instead of direct syscalls
208 * 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.
209
210 ### Compressed in-memory swap device
211 * A device that uses physical memory as swap space, but compresses it.
212 * 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.
213
214 ### tmpfs allocations from swap
215 * Currently, tmpfs nodes and stuff are allocated from KVA are the size limiter for a tmpfs filesystem
216 * Instead allocate them from swappable memory; this will allow larger tmpfses up to swap limits
217
218 ### mmap MAP_ALIGN
219 * Solaris's mmap support a flag, MAP_ALIGN, where the address to mmap acts as an alignment hint
220 * Our backing VM calls support an alignment parameter, but our public mmap does not
221 * This would allow nmalloc to allocate slabs (64k, 64k-aligned) without wastage
222
223 ### vnode dumps
224 * It would be beneficial to be able to have crash dumps written to an ordinary file in configurations where swap is not configured.
225
226 ### Kernel allocator feature enhancements
227 * 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.
228 * Rework the kmalloc allocator to sit on top of objcache (there are various dependencies to making this work).
229 * Create or sort out a metric for vnode/other cache object cycling rate that can indicate realistic memory pressure.
230 * Clear out free objcache slabs under memory pressure.
231 * Add reclaim functionality to objcache, such that it may ask consumers to free objects back into it under memory pressure.
232
233 ### Tear out serializers
234 * Serializers could be _carefully_ replaced with MTX locks
235
236 ### Tear out condvars
237 * Conditional vars -- condvar(9), could be replaced with other locking primitives and our tsleep/wakeup interlock.
238
239 ### Make karc4random in libkern per-cpu
240 * Verify that it is possible and safe to do this, what care would need to be taken, especially with respect to the random seeding?
241 * Pull out locks around calls to karc4rand*
242
243 ### Improve kernel spinlock debug-ability
244 * Add a const char *descr  field to the spinlock structure.
245 * Adjust spin_init() and all use cases, SPINLOCK_INITIALIZER() could juse use macro string extensions (# head) to install the name there.
246 * Adjust error messages to print the spinlock desc field.
247 * This change will require a full world & kernel recompile.
248
249 ### Add informational hardware-related sysctl's
250 * 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.
251 * Research which of these sysctl's is the most useful and add them, using the same node names as OSX.
252 1. hw.vectorunit = 1
253 1. hw.busfrequency = 100000000
254 1. hw.cpufrequency = 3062000000
255 1. hw.cachelinesize = 64
256 1. hw.l1icachesize = 32768
257 1. hw.l1dcachesize = 32768
258 1. hw.l2settings = 1
259 1. hw.l2cachesize = 262144
260 1. hw.l3settings = 1
261 1. hw.l3cachesize = 6291456
262 1. hw.tbfrequency = 1000000000
263 1. hw.activecpu: 2
264 1. hw.physicalcpu: 2
265 1. hw.physicalcpu_max: 2
266 1. hw.logicalcpu: 2
267 1. hw.logicalcpu_max: 2
268 1. hw.cputype: 7
269 1. hw.cpusubtype: 4
270 1. hw.cpu64bit_capable: 1
271 1. hw.cpufamily: 1418770316
272 1. hw.cacheconfig: 2 1 1 1 0 0 0 0 0 0
273 1. hw.cachesize: 2147483648 32768 262144 6291456 0 0 0 0 0 0
274 1. hw.busfrequency: 100000000
275 1. hw.busfrequency_min: 100000000
276 1. hw.busfrequency_max: 100000000
277 1. hw.cpufrequency: 3062000000
278 1. hw.cpufrequency_min: 3062000000
279 1. hw.cpufrequency_max: 3062000000
280 1. hw.cachelinesize: 64
281 1. hw.l1icachesize: 32768
282 1. hw.l1dcachesize: 32768
283 1. hw.l2cachesize: 262144
284 1. hw.l3cachesize: 6291456
285 1. hw.tbfrequency: 1000000000
286 1. hw.packages: 2
287 1. hw.optional.floatingpoint: 1
288 1. hw.optional.mmx: 1
289 1. hw.optional.sse: 1
290 1. hw.optional.sse2: 1
291 1. hw.optional.sse3: 1
292 1. hw.optional.supplementalsse3: 1
293 1. hw.optional.sse4_1: 1
294 1. hw.optional.sse4_2: 1
295 1. hw.optional.x86_64: 1
296 1. hw.optional.aes: 1
297 1. hw.optional.avx1_0: 1
298 1. hw.optional.rdrand: 0
299 1. hw.optional.f16c: 0
300 1. hw.optional.enfstrg: 0
301 1. machdep.cpu.max_basic: 13
302 1. machdep.cpu.max_ext: 2147483656
303 1. machdep.cpu.vendor: GenuineIntel
304 1. machdep.cpu.brand_string: Intel(R) Core(TM) i5-3470 CPU @ 3.20GHz
305 1. machdep.cpu.family: 6
306 1. machdep.cpu.model: 42
307 1. machdep.cpu.extmodel: 2
308 1. machdep.cpu.extfamily: 0
309 1. machdep.cpu.stepping: 7
310 1. machdep.cpu.feature_bits: 262929407 2660770315
311 1. machdep.cpu.extfeature_bits: 672139520 1
312 1. machdep.cpu.signature: 132775
313 1. machdep.cpu.brand: 0
314 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
315 1. machdep.cpu.extfeatures: SYSCALL XD EM64T LAHF RDTSCP TSCI
316 1. machdep.cpu.cores_per_package: 1
317 1. machdep.cpu.microcode_version: 16
318 1. machdep.cpu.processor_flag: 0
319 1. machdep.cpu.mwait.linesize_min: 4096
320 1. machdep.cpu.mwait.linesize_max: 4096
321 1. machdep.cpu.mwait.extensions: 3
322 1. machdep.cpu.mwait.sub_Cstates: 4384
323 1. machdep.cpu.xsave.extended_state: 7 832 832 0
324 1. machdep.cpu.arch_perf.version: 1
325 1. machdep.cpu.arch_perf.number: 8
326 1. machdep.cpu.arch_perf.width: 48
327 1. machdep.cpu.arch_perf.events_number: 7
328 1. machdep.cpu.arch_perf.events: 127
329 1. machdep.cpu.arch_perf.fixed_number: 0
330 1. machdep.cpu.arch_perf.fixed_width: 0
331 1. machdep.cpu.cache.linesize: 64
332 1. machdep.cpu.cache.L2_associativity: 8
333 1. machdep.cpu.cache.size: 256
334 1. machdep.cpu.tlb.inst.small: 128
335 1. machdep.cpu.tlb.data.small: 64
336 1. machdep.cpu.tlb.data.large: 32
337 1. machdep.cpu.tlb.shared: 512
338 1. machdep.cpu.address_bits.physical: 40
339 1. machdep.cpu.address_bits.virtual: 48
340 1. machdep.cpu.core_count: 1
341 1. machdep.cpu.thread_count: 1
342
343 ## Live images enhancement
344
345 The live images could be made easier to use by not assuming a QWERTY keyboard layout.
346
347 Not beeing able to choose a localized keyboard layout before having to type 'installer' or 'root' may be a deal breaker for some users.
348 A simple menu replacing login(1) and displaying the following three choices could be a good solution:
349
350 1. Set keyboard layout
351 2. Launch the installer
352 3. Login as root
353
354 For more theoretical projects and project concepts see [[ResearchProjects|/docs/developer/ResearchProjectsPage]]