Add routing references (from http://www.shiningsilence.com/dbsdlog/2010/09/14/6403...
[ikiwiki.git] / docs / developer / gsocprojectspage / index.mdwn
1 [[!meta title="Google Summer of Code Project List"]]
2
3 [[!toc levels=0]]
4
5 Have a look at our SoC pages from [[2008|docs/developer/GoogleSoC2008/]], [[2009|docs/developer/gsoc2009]] and [[2010|docs/developer/gsoc2010]] to get an overview about prior year's projects.
6
7 For more details on Google's Summer of Code: [Google's SoC page](http://socghop.appspot.com/)
8
9 Note 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.
10
11 Note 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).
12
13 Legend:
14
15 * 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.
16 * Difficulty: Estimated difficulty of the project, taking into account the complexity of the task and the time constraints of the GSoC program.
17 * 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@.
18
19 #### Project ideas
20
21 ##### VFS Quota System
22 * Create a new kernel subsystem to manage quota's in a filesystem agnostic manner by interfacing with the kernel VFS layer.
23 * Create filesystem-agnostic quota support tools for userland that obtain information in the same manner as eg: du(1) instead of parsing the filesystem internals directly as the existing quota tools do (see quotacheck(8), repquota(8), edquota(8), ...).
24 * The quota file storage can be modeled after the existing UFS code that does the same, but should use the more general bytes, files and/or directories metrics instead of the somewhat UFS-specific blocks and inodes.
25
26 Meta information:
27
28 * Prerequisites: C, introductory filesystems internals
29 * Difficulty: Moderate
30 * Contact point: Samuel J. Greear <sjg@thesjg.com>
31
32 ---
33
34 ##### HAMMER Data dedup
35
36 The HAMMER filesystem is very efficient in sharing data between its fine-grained
37 snapshots, but when you copy (or otherwise duplicate) a file or directory tree, the data
38 is no longer shared. This is suboptimal because then we make poor use of disk space
39 and the same data gets cached multiple times wasting precious RAM space.
40
41 The goal of this project is to add a data de-duplication mechanism to the HAMMER
42 filesystem. A reasonable approach would be to detect potential data matches using
43 CRCs during pruning runs. Then you could verify there is actual duplication of data
44 (i.e. the match is not a false positive), collapse the B-Tree data reference and account for the additional reference in the allocation blockmap.
45
46 BSD kernels cache data on a per-vnode basis, possibly investigate methods by which de-duplication could be extended into the vnode layer.
47
48 Meta information:
49
50 * Prerequisites: C, modern filesystem internals
51 * Difficulty: Moderate
52 * Contact point: dillon
53
54 Status:
55
56 * In progress
57
58 ---
59
60 ##### Implement i386 32-bit ABI for x86_64 64-bit kernel
61 * Add a 32-bit syscall table which translates 32-bit
62   system calls to 64-bit.
63 * Add support for 32 bit compatibility mode operation
64   and ELF binary detection.
65
66 The 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.
67
68 There are several hundred system calls which translates to a great deal of 'grunt work' when it comes time to actually do all the translations.
69
70 Meta information:
71
72 * Prerequisites: C
73 * Difficulty: Difficult (lots of moving parts, particularly the trapframes)
74 * Contact point: dillon
75
76 ---
77
78 ##### Implement ARC algorithm extension for the vnode free list
79 * Vnode recycling is LRU and can't efficiently handle data sets which
80   exceed the maxvnode limit.  When the maxvnode limit is reached the kernel
81   starts throwing away cached vnodes along with their VM objects (and thus
82   all related cached file data).
83
84 * What we would like to do is implement an ARC algorithm for the free
85   vnodes to determine which ones to throw away and potentially combine
86   this with further caching of the related VM object even after the vnode
87   is thrown away by associating it with a mount point and inode number,
88   until memory pressure forces all of its pages out.
89
90 * For this project the student can choose to just implement the VM object
91   retention portion and not try to implement an ARC algorithm (which can
92   be considerably more complex).
93
94 Meta information:
95
96 * Prerequisites: C, OS internals
97 * Difficulty: Modest without ARC (Very difficult with ARC)
98 * Contact point: dillon
99
100 ---
101
102 ##### Make DragonFly NUMA-aware 
103
104 * Parse related ACPI tables 
105 * NUMA-aware memory allocation
106 * References:
107 [ACPI SLIT parser](http://mail-index.netbsd.org/tech-kern/2009/11/23/msg006518.html)
108 [ACPI SRAT parser](http://mail-index.netbsd.org/tech-kern/2009/11/23/msg006517.html)
109 [NetBSD NUMA diff](http://www.netbsd.org/~cegger/numa2.diff)
110 [NetBSD NUMA x86 diff](http://www.netbsd.org/~cegger/numa_x86.diff) (These patches now in NetBSD tree)
111
112 Meta information:
113
114 * Prerequisites: C, introductory computer architecture
115 * Difficulty: Easy
116 * Contact point: kernel@crater.dragonflybsd.org
117
118 ---
119
120
121 ##### Port valgrind to DragonFlyBSD
122
123 Valgrind 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.
124
125 The 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.
126
127 Meta information:
128
129 * Prerequisites: C, x86 assembly, low-level OS internals
130 * Difficulty: Hard
131 * Contact point: Aggelos Economopoulos <aoiko@cc.ece.ntua.gr>
132
133 ---
134
135 ##### Adapt pkgsrc to create a package system with dependency independence.
136 * 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.
137
138 Meta information:
139
140 * Prerequisites: C
141 * Difficulty: ?
142 * Contact point: kernel@crater.dragonflybsd.org
143
144 ---
145
146 ##### Implement virtio drivers on DragonFly to speed up DragonFly as a KVM guest
147
148 As virtualization is coming more and more and KVM will be a strong player in that field,
149 we want DragonFly to have top-notch support for this virtualization platform. For this
150 purpose, we'd like to have a virtio-based implementation of a paravirtualized disk and
151 network driver. [virtio](http://www.ibm.com/developerworks/linux/library/l-virtio/index.html)
152 is an abstraction to a ring buffer that is shared between the host and the guest. On top of this
153 abstraction, one can build a variety of paravirtualized devices, as specified in
154 [virtio-spec](http://ozlabs.org/~rusty/virtio-spec/virtio-spec-0.8.6.pdf).
155
156 The goal of this project is to create a virtio-ring implementation and then to implement drivers
157 for the network and block devices described in the specification linked to above. This is a great
158 project for a student who wants to get experience writing (real-world, high-performance) device
159 drivers without having to deal with the quirks of real hardware.
160
161 Meta information:
162
163 * Prerequisites: C, elementary OS internals
164 * Difficulty: Easy
165 * Contact point: Aggelos Economopoulos <aoiko@cc.ece.ntua.gr>, kernel@crater.dragonflybsd.org
166
167 ---
168
169 ##### Port PUFFS from FreeBSD/NetBSD
170
171 * http://www.netbsd.org/docs/puffs/
172 * This would make many userspace filesystems available to DragonFly, e.g. sshfs to mention only one.
173
174 Meta information:
175
176 * Prerequisites: C, elementary OS internals
177 * Difficulty: Medium
178 * Contact point: Michael Neumann <mneumann@ntecs.de>
179
180 ---
181
182 ##### Make vkernels checkpointable
183
184 * See checkpt(1).
185 * 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.
186 * Teach the checkpt system call how to checkpoint multiple vmspaces.
187 * 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.
188 * This would allow us to save and restore or even migrate a complete DragonFly operating system running on the vkernel platform.
189 This could be especially handy on laptops (if we'd get X11 operating in vkernels).
190 * See also: http://www.dragonflybsd.org/docs/developer/CheckpointFeatures/
191
192 Meta information:
193
194 * Prerequisites: C, OS internals
195 * Difficulty: Medium
196 * Contact point: Michael Neumann <mneumann@ntecs.de>
197 * References: [1](http://leaf.dragonflybsd.org/mailarchive/kernel/2007-02/msg00073.html) [2](http://leaf.dragonflybsd.org/mailarchive/users/2007-02/msg00034.html)
198
199 ---
200
201 ##### HAMMER compression
202
203 * Compress blocks as they get written to disk.
204 * Only file data (rec_type == DATA) should be compressed, not meta-data.
205 * the CRC should be that of the uncompressed data.
206 * ideally you'd need to associate the uncompressed data with the buffer cache buffer somehow, so that decompression is only performed once.
207 * compression could be turned on a per-file or per-pfs basis.
208 * gzip compression would be just fine at first.
209
210 Doing compression would require flagging the data record as being compressed and also require double-buffering since
211 the buffer cache buffer associated with the uncompressed data might have holes in it and otherwise referenced by user
212 programs and cannot serve as a buffer for in-place compression or decompression.
213
214 The direct read / direct write mechanic would almost certainly have to be disabled for compressed buffers and the
215 small-data zone would probably have to be used (the large-data zone is designed only for use with 16K or 64K buffers).
216
217 Meta information:
218
219 * Prerequisites: C, filesystem internals
220 * Difficulty: Difficult
221 * Contact point: Michael Neumann <mneumann@ntecs.de>
222
223 ---
224
225
226 ##### Port usb4bsd
227 * Port the whole usb4bsd stuff to DragonFly, as our own usb stack is too outdated.
228
229 * The usb4bsd branch of hselasky (?) has several userland wrappers and quite good abstraction to simplify the porting.
230
231 Meta information:
232
233 * Prerequisites: C, OS internals
234 * Difficulty: Moderate
235 * Contact point: kernel@crater.dragonflybsd.org
236
237 ---
238
239 ##### Userland System V Shared Memory / Semaphore / Message Queue implementation
240 * 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.
241 * 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.
242 * Test and benchmark the new facilities with heavy SysV consumers such as PostgreSQL
243 * 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.
244
245 Meta information:
246
247 * Prerequisites: C, x86 assembly
248 * Difficulty: Moderate
249 * Contact point: Samuel J. Greear <sjg@thesjg.com>
250
251 ---
252
253
254 ##### Update our interrupt routing and PCI code
255 * Update our interrupt routing to ACPI interrupt routing instead of relying on the mptable exclusively
256 * Update the PCI code to take advantage of MSI (Message Signalled Interrupts)
257
258 Meta information:
259
260 * Prerequisites: C, OS internals 
261 * Difficulty: Hard
262 * Contact point: kernel@crater.dragonflybsd.org
263 * References: [1](http://people.freebsd.org/~jhb/papers/bsdcan/2007/article/article.html) [2](http://www.bsdcan.org/2007/schedule/events/2.en.html) [3](http://www.acpi.info/DOWNLOADS/ACPIspec40a.pdf) [4](http://tldp.org/LDP/tlk/dd/interrupts.html) [5](http://wiki.osdev.org/Category:Interrupts)
264
265 ---
266
267 ##### Proportional RSS
268
269 The Resident Stack Size displayed by top keeps track of the number of resident pages in
270 a certain process's adress space. It is very useful to locate memory hogs, but doesn't take
271 into account page sharing. For example, if N processes map library L and L's resident pages
272 are 1G, this 1G is added to the RSS of all N processes. A more useful number would be the
273 Proportional (or Effective) RSS, for which we divide the number of mapped shared pages by
274 the number of processes sharing each page. So in the previous example we would add 1GB/N
275 to each process that has L mapped.
276
277 The goal of this project is to hack the kernel to allow for effective calculation of the
278 Proportional RSS and modify top to use it in addition to the RSS (i.e. it should display it by
279 default and be able to sort based on it).
280
281 Meta information:
282
283 * Prerequisites: C, Elementary OS internals
284 * Difficulty: Easy
285 * Contact point: Aggelos Economopoulos <aoiko@cc.ece.ntua.gr>
286
287 Status:
288
289 * Possibly in-progress
290
291 ---
292
293  (please add)