Virtio driver project implemented, remove from list
[ikiwiki.git] / docs / developer / gsocprojectspage / index.mdwn
CommitLineData
90c0b013 1[[!meta title="Google Summer of Code Project List"]]
4114eeff 2
3[[!toc levels=0]]
4
f57c228c 5Have a look at our SoC pages from [[2008|/docs/developer/GoogleSoC2008/]], [[2009|/docs/developer/gsoc2009/]], [[2010|/docs/developer/gsoc2010/]] and [[2011|/docs/developer/gsoc2011/]] to get an overview about prior year's projects.
4114eeff 6
7For more details on Google's Summer of Code: [Google's SoC page](http://socghop.appspot.com/)
8
f57c228c 9Alternate project links: [[Projects page|/docs/developer/ProjectsPage/]], [[Research Projects|/docs/developer/researchprojectspage/]]
10
4114eeff 11Note to prospective students: These project proposals are meant to be a first approximation; we're looking forward to your own suggestions (even for completely new directions) and will try to integrate your ideas to make the GSoC project more interesting to all parties. Even when a proposal is very specific about the goals that must be achieved and the path that should be taken, these are always negotiable. Keep in mind that we have tried to limit the proposals on this page to those that (based on our past experience) are appropriate for the GSoC program. This is by no means a comprehensive list, original ideas or proposals based on project ideas found on other pages are very welcome.
12
13Note to everyone else: These proposals are by no means Summer of Code specific, anyone is welcome and encouraged to adopt any of these projects at any time (just please let us know, or make a note on this page).
14
15Legend:
16
17* Prerequisites: knowledge that the student should have before starting the project. It may be possible to acquire the knowledge in the course of the project, but the estimated difficulty would increase substantially. On the bright side, you can expect to have a much deeper understanding of these fields (and gain some real-world experience) after you successfully complete the respective project.
18* Difficulty: Estimated difficulty of the project, taking into account the complexity of the task and the time constraints of the GSoC program.
19* Contact point: The person you should contact for any further information or clarifications. If the primary contact for a project does not respond in a reasonable amount of time (2-3 days), you should contact the appropriate DragonFly BSD mailing list, usually kernel@.
20
21#### Project ideas
22
11f3d975 23---
24
a6283272 25##### Implement amd64 Linux compatibility for x86_64 64-bit kernel
26* Add a syscall table which translates 64-bit Linux system calls to DragonFly ones
27* Add support for ELF binary detection.
28
29DragonFly/i386 supports the execution of 32 bit Linux binaries; it
30is only natural to implement the same kind of binary compatibility
31for 64-bit systems.
32
33Some of the other *BSD systems may already have implemented such a mechanism.
34
35Meta information:
36
37* Prerequisites: C, amd64 architecture knowledge
38* Difficulty: Moderate to difficult
39* Contact point: kernel@crater.dragonflybsd.org
40
41---
4114eeff 42##### Implement i386 32-bit ABI for x86_64 64-bit kernel
43* Add a 32-bit syscall table which translates 32-bit
44 system calls to 64-bit.
45* Add support for 32 bit compatibility mode operation
46 and ELF binary detection.
47
48The idea here is to support the execution of 32 bit DragonFly binaries in 64 bit DragonFly environments, something numerous other operating systems have done. Several things must be done to support this. First, the appropriate control bits must be set to execute in 32-bit compatibility mode while in usermode instead of 64-bit mode. Second, when a system call is made from 32-bit mode a translation layer is needed to translate the system call into the 64-bit requivalent within the kernel. Third, the signal handler and trampoline code needs to operate on the 32-bit signal frame. Fourth, the 32 and 64 bit ELF loaders both have to be in the kernel at the same time, which may require some messing around with procedure names and include files since originally the source was designed to be one or the other.
49
50There are several hundred system calls which translates to a great deal of 'grunt work' when it comes time to actually do all the translations.
51
52Meta information:
53
54* Prerequisites: C
55* Difficulty: Difficult (lots of moving parts, particularly the trapframes)
56* Contact point: dillon
57
58---
59
60##### Implement ARC algorithm extension for the vnode free list
61* Vnode recycling is LRU and can't efficiently handle data sets which
62 exceed the maxvnode limit. When the maxvnode limit is reached the kernel
63 starts throwing away cached vnodes along with their VM objects (and thus
64 all related cached file data).
65
66* What we would like to do is implement an ARC algorithm for the free
67 vnodes to determine which ones to throw away and potentially combine
68 this with further caching of the related VM object even after the vnode
69 is thrown away by associating it with a mount point and inode number,
70 until memory pressure forces all of its pages out.
71
72* For this project the student can choose to just implement the VM object
73 retention portion and not try to implement an ARC algorithm (which can
74 be considerably more complex).
75
76Meta information:
77
78* Prerequisites: C, OS internals
79* Difficulty: Modest without ARC (Very difficult with ARC)
80* Contact point: dillon
81
82---
83
4114eeff 84##### Make DragonFly NUMA-aware
85
86* Parse related ACPI tables
87* NUMA-aware memory allocation
88* References:
89[ACPI SLIT parser](http://mail-index.netbsd.org/tech-kern/2009/11/23/msg006518.html)
90[ACPI SRAT parser](http://mail-index.netbsd.org/tech-kern/2009/11/23/msg006517.html)
91[NetBSD NUMA diff](http://www.netbsd.org/~cegger/numa2.diff)
92[NetBSD NUMA x86 diff](http://www.netbsd.org/~cegger/numa_x86.diff) (These patches now in NetBSD tree)
93
94Meta information:
95
96* Prerequisites: C, introductory computer architecture
97* Difficulty: Easy
98* Contact point: kernel@crater.dragonflybsd.org
99
100---
101
102
103##### Port valgrind to DragonFlyBSD
104
105Valgrind is a very useful tool on a system like DragonFly that's under heavy development. Since valgrind is very target specific, a student doing the port will have to get acquainted with many low level details of the system libraries and the user<->kernel interface (system calls, signal delivery, threading...). This is a project that should appeal to aspiring systems programmers. Ideally, we would want the port to be usable with vkernel processes, thus enabling complex checking of the core kernel code.
106
107The goal of this project is to port valgrind to the DragonFlyBSD platform so that at least the memcheck tool runs sufficiently well to be useful. This is in itself a challenging task. If time remains, the student should try to get at least a trivial valgrind tool to work on a vkernel process.
108
109Meta information:
110
111* Prerequisites: C, x86 assembly, low-level OS internals
112* Difficulty: Hard
113* Contact point: Aggelos Economopoulos <aoiko@cc.ece.ntua.gr>
114
115---
116
117##### Adapt pkgsrc to create a package system with dependency independence.
118* Create a set of tools that modifies how the pkgsrc packages are installed, allowing for the ability to upgrade individual packages, without stopping applications that depend on said packages from working. One method of achieving this is detailed at http://www.dragonflybsd.org/goals/#packages but other methods may be possible. PC-BSD have written a tool called PBI Builder which modifies FreeBSD ports for their dependency independence PBI system, this could be used as a starting point for the DragonFly BSD tools.
119
120Meta information:
121
122* Prerequisites: C
123* Difficulty: ?
124* Contact point: kernel@crater.dragonflybsd.org
125
126---
127
1e5fd6e2 128##### Make vkernels checkpointable (2011 Project)
4114eeff 129
130* See checkpt(1).
131* Implement save and restore of segment registers so that threaded applications may be checkpointed. The segment registers support TLS. There are potential security concerns here.
132* Teach the checkpt system call how to checkpoint multiple vmspaces.
133* Add code to the vkernel which gets triggered upon reception of a SIGCKPT signal to dump/load e.g. the current state of network drivers.
134* This would allow us to save and restore or even migrate a complete DragonFly operating system running on the vkernel platform.
135This could be especially handy on laptops (if we'd get X11 operating in vkernels).
136* See also: http://www.dragonflybsd.org/docs/developer/CheckpointFeatures/
137
138Meta information:
139
140* Prerequisites: C, OS internals
141* Difficulty: Medium
142* Contact point: Michael Neumann <mneumann@ntecs.de>
143* References: [1](http://leaf.dragonflybsd.org/mailarchive/kernel/2007-02/msg00073.html) [2](http://leaf.dragonflybsd.org/mailarchive/users/2007-02/msg00034.html)
144
145---
146
147##### HAMMER compression
148
149* Compress blocks as they get written to disk.
150* Only file data (rec_type == DATA) should be compressed, not meta-data.
151* the CRC should be that of the uncompressed data.
152* ideally you'd need to associate the uncompressed data with the buffer cache buffer somehow, so that decompression is only performed once.
153* compression could be turned on a per-file or per-pfs basis.
154* gzip compression would be just fine at first.
155
156Doing compression would require flagging the data record as being compressed and also require double-buffering since
157the buffer cache buffer associated with the uncompressed data might have holes in it and otherwise referenced by user
158programs and cannot serve as a buffer for in-place compression or decompression.
159
160The direct read / direct write mechanic would almost certainly have to be disabled for compressed buffers and the
161small-data zone would probably have to be used (the large-data zone is designed only for use with 16K or 64K buffers).
162
163Meta information:
164
165* Prerequisites: C, filesystem internals
166* Difficulty: Difficult
167* Contact point: Michael Neumann <mneumann@ntecs.de>
168
169---
170
4114eeff 171##### Userland System V Shared Memory / Semaphore / Message Queue implementation
172* Implement some or all of these subsystems in their entirety, or as completely as possible in userland using a daemon, mmap and the DragonFly umtx_sleep(2)/umtx_wakeup(2) or other userland facilities.
173* Any security or other major hurdles to this approach that would likely have to be implemented in-kernel should be noted in the students application.
174* Test and benchmark the new facilities with heavy SysV consumers such as PostgreSQL
175* Identify performance tradeoffs made in the userland implementation versus the existing kernel implementation. If time permits identify and apply solutions to these tradeoffs so that the userland implementation performs on par with or better than the kernel implementation.
176
177Meta information:
178
179* Prerequisites: C, x86 assembly
180* Difficulty: Moderate
181* Contact point: Samuel J. Greear <sjg@thesjg.com>
182
183---
184
8e2bdf60 185##### DragonFly history access for Gnome/KDE
5654e978 186* Write a Dolphin (KDE) plugin or Gnome file manager plugin that creates a 'time slider' when working with HAMMER filesystems.
187* If time remains investigate additional features and/or methods of display and possibly a HAMMER configuration utility for managing history retention, etc.
8e2bdf60 188
189Meta information:
190
5654e978 191* Prerequisites: C, Gnome or KDE familiarity
8e2bdf60 192* Difficulty: Hard
193* Contact point: kernel@crater.dragonflybsd.org
194* References: [A similar idea for ZFS](http://blogs.sun.com/erwann/entry/zfs_on_the_desktop_zfs)
195
196---
197
198##### Create a Samba VFS plugin to expose Hammer history
199* Give access to Hammer snapshots/fine-grained history to anyone able to access the Hammer volume over Samba
5654e978 200* This would involve writing a Samba3 VFS module to expose historical versions of files as "shadow copies". VFS module implementations supporting more traditional snapshot hierarchies do already exist.
8e2bdf60 201
202Meta information:
203
5654e978 204* Prerequisites: C
205* Difficulty: Moderate
8e2bdf60 206* Contact point: kernel@crater.dragonflybsd.org
207
208---
209
56ca55df
T
210##### Port Hyper-V Linux Integration components to DragonFly
211* Microsoft released a dual BSD/GPL version of their para-virtualized drivers (SCSI and Networking) for Linux.
212* This work would require porting the Linux VMBus (Microsoft's equivlalent to XenBus) and the corresponding SCSI (StorVSC) and networking (NetVSC) drivers to DragonFly.
213* References: [Sources](http://www.microsoft.com/downloads/en/details.aspx?FamilyID=eee39325-898b-4522-9b4c-f4b5b9b64551) [Architecture Overview](http://port25.technet.com/archive/2009/07/22/introduction-to-the-linux-integration-components.aspx)
8e2bdf60 214
56ca55df
T
215Meta information:
216
217* Prerequisites: C, OS internals
218* Difficulty: Hard
219* Contact point: kernel@crater.dragonflybsd.org
8e2bdf60 220
8cb8502a 221---
222
223##### Implement more dm targets
224* Since we now have dm (device mapper) in DragonFly, it would be nice to make better use of it. Currently we have a relatively small number of useful targets (crypt, linear and striped).
225* Other targets should be implemented, in particular the mirror target would be of interest. Other ideas are welcome, too. Before applying for this please discuss the target of interest on the mailing list or with me directly.
c2cfaa23 226* There is a start of a journalled mirror target, if you want to attack soft mirroring; the problem is a lot more difficult than it seems at first, so talking on the mailing list or on IRC would be definitely worthwhile!
8cb8502a 227
228Meta information:
229
230* Prerequisites: C, OS internals
231* Difficulty: Medium
c2cfaa23 232* Contact point: kernel@crater.dragonflybsd.org , Alex Hornung <alexh@dragonflybsd.org>, Venkatesh Srinivas <vsrinivas@dragonflybsd.org>
8cb8502a 233
3a9e5de8 234---
235
236##### Implement a new unionfs
237* unionfs is a particularly useful pseudo-fs which allows to have an upper and a lower filesystem on a single mountpoint. The upper mountpoint is mostly transparent, so that the lower mountpoint is accessible.
3a9e5de8 238* A typical use case is mounting a tmpfs filesystem as the upper and a read-only FS as the lower mp. This way files can be edited transparently even on a RO filesystem without actually modifying it.
65d9da85 239* The current unionfs is completely broken as it relies on the whiteout VFS technique which is not supported by HAMMER. A new unionfs implementation should not rely on archaic methods such as whiteout.
3a9e5de8 240
241Meta information:
242
243* Prerequisites: C, OS internals, ideally some knowledge of the FreeBSD/DragonFly VFS
244* Difficulty: Medium
245* Contact point: kernel@crater.dragonflybsd.org
8e2bdf60 246
0c47d1e1 247---
248
249##### Improve compatibility of libdevattr with Linux' libudev
250* Our libdevattr has an API which is mostly compatible with Linux' libudev, but it is doubtful that any Linux application making use of libudev would run out of the box on DragonFly with libdevattr.
b515bc2d 251* The aim of this project is to identify the shortcomings of libdevattr and fix them so that some common libudev applications work with our libdevattr.
252* This might involve some kernel hacking to improve our kern_udev and definitely includes some grunt work of "tagging" subsystems with the kern_udev API.
253* Most of the work will be in userland, though, working on udevd and libdevattr.
0c47d1e1 254
255Meta information:
256
257* Prerequisites: C, familiarity with Linux' libudev would be a plus
258* Difficulty: Medium
259* Contact point: kernel@crater.dragonflybsd.org , Alex Hornung <alexh@dragonflybsd.org>
260
261
262
9792e675 263---
264
fc1a3138 265##### Implement further dsched disk scheduling policies (2011 Project: BFQ)
9792e675 266* dsched is a highly flexible disk scheduling framework which greatly minimizes the effort of writing disk scheduling policies.
267* Currently only dsched_fq, a fairly simple fair-queuing policy, and noop policies are implemented.
268* The aim of this project would be to implement at least another useful disk scheduling policy, preferably one that improves interactivity.
269* Other ideas are welcome.
1e4090b0 270* This is a great opportunity for CS students interested in scheduling problems to apply their theoretical knowledge.
9792e675 271
272Meta information:
273
274* Prerequisites: C, OS internals, familiarity with disk scheduling
275* Difficulty: Medium
276* Contact point: kernel@crater.dragonflybsd.org , Alex Hornung <alexh@dragonflybsd.org>
277
82d3efd3 278---
279
692141e4 280##### Implement hardware nested page table support for vkernels
82d3efd3 281* Various modern hardware supports virtualization extensions, including nested pagetables.
282* The DragonFly BSD vmspaces API, used to support vkernels, is effectively a software implementation of nested pagetables.
283* The goal of this project would be to add support for detection of the hardware features on AMD and Intel cpu's and alter the vmspace implementation to use hardware support when available.
284
285Meta information:
9792e675 286
82d3efd3 287* Prerequisites: C, x86 assembly, OS internals
288* Difficulty: Hard
289* Contact point: kernel@crater.dragonflybsd.org
290
291---
8ff76619 292
ec874e8b 293##### Access to ktr(4) buffers via shared memory
294Our event tracing system, ktr(4), records interesting events in per-cpu buffers that are printed out with ktrdump(8). Currently, ktrdump uses libkvm to access these buffers, which is suboptimal. One can allow a sufficiently-privileged userspace process to map those buffers read-only and access them directly. For bonus points, design an extensible, discoverable (think reflection) mechanism that provides fast access via shared memory to data structures that the kernel chooses to expose to userland.
295
296Meta information:
297
298* Prerequisites: C, OS internals
299* Difficulty: Medium
300* Contact point: kernel@crater.dragonflybsd.org, Aggelos Economopoulos <aoiko@cc.ece.ntua.gr>
301
302---
303
8b8bd18e 304#####Ability to execute Mach-O (OS X) binaries
305This is a project for a student with something to prove, executing a binary touches a huge number of moving parts of a modern kernel. This project would entail adding or porting support for Mach-O binaries to the DragonFly BSD kernel. It would also involve adding an additional system call vector, like the Linux vector used for linux binary emulation. This is quite a large and complicated task and any proposal will be expected to be well-researched to reflect that. The ability to execute non-GUI binaries that make use of shared libraries should be the minimum to which such a project should aspire. OpenDarwin is available as a reference or to port relevant code from.
306
307Meta information:
308
309* Prerequisites: C, OS internals, binary file formats
310* Difficulty: Hard
311* Contact point: Samuel J. Greear <sjg@thesjg.com>
312
313---
9376443d 314##### nmalloc (libc malloc) measurements and performance work
315
316nmalloc is our libc memory allocator it is a slab-like allocator; it recently had some work done to add per-thread caches, but there is much more work that could be done. A project on this might characterize fragmentation, try out a number of techniques to improve per-thread caching and reduce the number of total syscalls, and see if any are worth applying.
317
318Possible things to work on:
319(thread caches)
320* The per-thread caches are fixed-size; at larger object sizes (say 4K), this can result in a lot of memory tied up. Perhaps they should scale their max size inversely to the object size.
321
322* The per-thread caches are filled one-at-a-time from free(). Perhaps the per-thread caches should be burst-filled.
323
324* Perhaps the per-thread caches should age items out
325
326(slab zone allocation)
327* zone_alloc() currently burst-allocates slab zones with the zone magazine held across a spinlock.
328
329* zone_free() holds the zone magazine lock around bzero()ing a slab zone header
330
331* zone_free() madvise()s one slab at a time; it'd be nice to madvise() runs of contiguous slabs
332
333* zone_free() madvise()s very readily (for every slab freed). Perhaps it should only madvise slabs that are idle for some time
334
335* zone_free() burst-frees slabs. Its not clear whether this is a good idea.
336
337(VMEM):
338* currently allocations > either 4k or 8k are forced directly to mmap(); this means that idle memory from free slabs cannot be used to service those allocations and that we do no caching for allocations > than that size. this is almost certainly a mistake.
339
340* we could use a small (embeddable) data structure that allows:
3411. efficient coalescing of adjacent mmap space for madvise
3422. efficient queries for vmem_alloc() (w/ alignment!)
3433. compact and doesn't use any space in the zone header (dirty/cold!)
3444. allows traversal in address order to fight fragmentation
3455. keep two such data structures (one for dirty pages, one for cold pages)
346
347(Note)
348* These are just ideas; there are many more things possible and many of these things need a lot of measurement to evaluate them. It'd be interesting to see if any of these are appropriate for it.
349
350References:
351* http://www.usenix.org/event/usenix01/bonwick.html
352
353A description of the Sun Solaris work on which the DragonFly allocator is based; use this as an overview, but do not take it as gospel for how the DFly allocator works.
354
355* http://leaf.dragonflybsd.org/~vsrinivas/jemalloc-tech-talk.ogv (Jason Evans tech talk about jemalloc, 1/2011)
356
357jemalloc is FreeBSD's and Firefox's (and NetBSD and GNASH and ...)'s malloc; in this tech talk, Jason Evans reviews how jemalloc works, how it has changed recently, and how it avoid fragmentation.
358
359* http://endeavour.zapto.org/src/malloc-thesis.pdf (Ayelet Wasik's thesis 'Features of a Multi-Threaded Memory Allocator')
360
361This thesis is an excellent overview of many techniques to reduce contention and the effects these techniques have on fragmentation.
362
363* Prerequisites: C, a taste of data structures
364* Difficulty: moderate
365* Contact point: Venkatesh Srinivas <me@endeavour.zapto.org>
366
367---
01b524ba 368
369##### Create a filesystem indexing service
370Currently to locate an arbitrary file on a dragonfly system you would use the locate(1), which(1) or whereis(1) tools. These are a bit clunky, paint in broad strokes and the accuracy of the database is often suspect. The first part of this project would involve implementing the Linux inotify interface in the DragonFly kernel. The second part would be to write a daemon that can (optionally) operate as an indexing service, if the weekly 310.locate periodic job see's that the locate database is being maintained by the daemon, it can skip running locate.updatedb(8). A third part of this project might involve extending the current database to a binary format with information about file types, what bits are set, etc. This could enable the user to have the locate tool paint in narrower strokes by specifying only files of type "ASCII text" or only files that are suid root or have the execute bit set.
371
372Meta information:
373
374* Prerequisites: C, OS internals, binary file formats
375* Difficulty: Easy/Moderate
376* Contact point: Samuel J. Greear <sjg@thesjg.com>
377
378---
4c7e21d4 379
380##### Make DragonFly multiboot capable
381Adjust the DragonFly kernel to be multiboot (the specification) capable. In addition, add necessary code to grub2 to understand our disklabel64 and anything else we need to be able to use grub2 to multiboot DragonFly without any chainloading involved.
382
383Meta information:
384
385* Prerequisites: C, OS internals
386* Difficulty: Easy/Moderate
387* Contact point: Alex Hornung <alexh@dragonflybsd.org>
388
7700f24f 389
390---
391
2fed452e 392##### Complete installer rewrite
996043c0 393Completely rewrite the installer to be much simpler to maintain. It will still have to be an ncurses-based installer written in C, or in Python (but with C bindings for every single library that will be created - see below). A text interface UI library (e.g. newt [see examples on http://gnewt.sourceforge.net/tutorial-4.html] - which seems very easy and handy) should be used to make the handling of the graphical part as easy as possible.
2fed452e 394
395As part of rewriting the installer, several functions scattered around in other base utils should be factored out into libraries that both the installer and the util it comes from can use, e.g.:
7c6affa1 396
397* partitioning (both GPT and MBR) should be factored out into two libraries, that the fdisk and the gpt tools use, but the installer can make use of, too.
398* disklabel32/64 functionality
399* adduser (and other user/group management)
2fed452e 400
401The new installer should then make use of all these new libraries and other ones that are already available (libcryptsetup, libluks, liblvm, libtcplay) to offer more advanced features.
402
c5845662 403NOTE: The new installer should maintain most if not all of the functionality of the old installer in addition to adding features taking advantage of the aforementioned libraries.
404
2fed452e 405
406
407Meta information:
408
409* Prerequisites: C
410* Difficulty: Moderate
411* Contact point: kernel@lists.dragonflybsd.org, Alex Hornung <alexh@dragonflybsd.org>
412
413
4c7e21d4 414---
103f9a35 415##### Extend dsched framework to support jails
416Extend/modify the dsched framework to take into account jails and etc. instead of always allocating a 'tdio'. This would allow different process groupings (such as all processes in a jail) to be scheduled together. A new jail-specific policy would have to be written to support this, or an existing policy modified.
417
418Meta information:
419
420* Prerequisites: C, OS internals
421* Difficulty: Moderate
422* Contact point: kernel@lists.dragonflybsd.org, Samuel J. Greear <sjg@thesjg.com>, Alex Hornung <alexh@dragonflybsd.org>
423
424---
1a9c0407 425##### Implement NFS version 4
426* NFSv4 is more than a simple version increase; it is an adaptation of NFS to Internet and WAN networks, with an expectation of high latency and firewalled data transfers and a non-naive security framework layer.
427* NFSv4 servers export a single Pseudo File System (which has nothing to do with HAMMER(5) PFSes besides the name) merging all local filesystems in a unique namespace.
428* We already have some kernel code which could be used as a starting point (WebNFS)
d8f691bb 429* FreeBSD possesses a NFSv4 implementation which could be ported or serve as a reference basis
430* Given NFSv4 protocol complexity, it may be best to implement this project in userspace
1a9c0407 431
432Meta information:
433
434* Prerequisites: C, OS internals, ideally some knowledge of the VFS and namecache layers
435* Difficulty: Medium
436* Contact point: kernel@crater.dragonflybsd.org
437
438---
4114eeff 439 (please add)