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