add some more notes to the wireguard project

[ikiwiki.git] / docs / developer / Code_Bounties.mdwn

[[!toc levels=2]]

# Explanation 

A code bounty is a certain financial stimulant to encourage someone to put his or her effort into a project. A code bounty in the DragonFlyBSD project needs to adhere to a set of rules defined hereunder, though these are only preliminary and subject to change. One could for example imagine developers accepting sponsorship on a wholly different basis, or non-financial rewards for completing a bounty project, like free hardware (we love that!).

# Rules 

* Bounty Projects are open to anyone that has a reasonable capability of completing the project. Typically it's on first to ask basis, but the sponsor of the bounty may choose differently.

* If the developer can not complete the project by the given time period, the bounty agreement is void and no money will be issued for work done. DragonFly developers may extend the time period if it's reasonable and prudent to do so. Upon voiding the agreement, someone may reissue the project again to another developer.

* Payment for a project shall be issued in no less than 72 hours after the DragonFly developers has had ten business days to determine if the code is stable and usefulness, no major issues are left unresolved and able for being merged into the project. Payment shall be in either [[Paypal]] (preferred), some money sending company or  a bank account transfer.

* Upon receiving payment, the project developer shall issue (within 24 hours) a message in the WIKI and to DragonFly development ML that they have received payment.

* All code submitted shall be of the same license as DragonFly. Any questions on the licensing issues should be directed to the DragonFly Team.


<hr />

# Active bounties 

## In-kernel WireGuard port

### Description

[WireGuard](https://www.wireguard.com/) is an extremely simple yet fast and modern VPN that utilizes state-of-the-art cryptography.
It aims to be faster, simpler, leaner, and more useful than IPsec, while avoiding the massive headache.
It intends to be considerably more performant than OpenVPN.
WireGuard is designed as a general purpose VPN for running on embedded interfaces and super computers alike, fit for many different circumstances.
Initially released for the Linux kernel, it is now cross-platform (Windows, macOS, BSD, iOS, Android) and widely deployable.
(copied from [WireGuard official website](https://www.wireguard.com/))

We already have the userland implementation in Golang in DPorts (i.e., [`wireguard-go`](https://github.com/DragonFlyBSD/DPorts/tree/master/net/wireguard-go)).
It would be better to also gain the in-kernel implementation, like OpenBSD and FreeBSD already did.

### Technical details 

* Port WireGuard directly from the upstream or from OpenBSD/FreeBSD.
* The crypto framework might need an update (from OpenBSD/FreeBSD).

**NOTE**:
The initial port by FreeBSD/Netgate was buggy, so need to investigate before using that code.
See: [Buffer overruns, license violations, and bad code: FreeBSD 13's close call](https://arstechnica.com/gadgets/2021/03/buffer-overruns-license-violations-and-bad-code-freebsd-13s-close-call/)

The re-port of WireGuard to FreeBSD: [[ANNOUNCE] WireGuard for FreeBSD in development for 13.y – and a note of how we got here](https://lists.zx2c4.com/pipermail/wireguard/2021-March/006499.html).

The Author (Jason A. Donenfeld) also said "the crypto needed to be re-accelerated", as detailed in [if_wg simd chapoly needs some love](https://lists.freebsd.org/pipermail/freebsd-hackers/2021-March/057076.html).

**NOTE**:
NetBSD has a separate from-sratch implementation [wg(4)](https://man.netbsd.org/wg.4).
The [code](https://github.com/NetBSD/src/blob/trunk/sys/net/if_wg.c) looks quite clean and nice.
So it maybe a good idea to port the NetBSD version.

See also the dispute between WireGuard's author and NetBSD developers:
["wireguard" implementation improperly merged and needs revert](https://mail-index.netbsd.org/tech-net/2020/08/22/msg007842.html)

### Main goals

* WireGuard port in DragonFly kernel, as well as the userland tools.
* WireGuard works.
* The port should be ideally reviewed/audited by the WireGuard project.
  I (aly@) believe the author (Jason A. Donenfeld) would like to help.

### Actuality

Created at: 2021-08-12

### Estimated time

Unknown.

### Donators

<table>
<tr>
<th>Donor</th>
<th>Amount</th>
</tr>

<tr>
<td>aly (Aaron LI)</td>
<td>100 USD</td>
</tr>
<tr>
<td>bycn82 (Bill Yuan)</td>
<td>100 USD</td>
</tr>

<tr>
<td>TOTAL AMOUNT</td>
<td>200 USD</td>
</tr>
</table>


## Bring in support for USB webcams

### Description

Bring in `uvideo` from NetBSD or OpenBSD, and the dependent `video` driver. If you think that webcam support in FreeBSD is superior, feels free to bring in `cuse` etc.

Final result should be that USB webcams are usable from chrome or firefox for the purpose of video conferencing (e.g. via jitsi.org). Personally I only need support for low-quality webcams, no need for 4k :).

### Actuality

Bounty created at: 2021-08-08

### Estimated time

Unknown.

### Donators

<table>
<tr>
<th>Donor</th>
<th>Amount</th>
</tr>

<tr>
<td>mneumann</td>
<td>150 USD</td>
</tr>

<tr>
<td>pikrzyszt</td>
<td>100 GBP</td>
</tr>

<tr>
<td>aly</td>
<td>50 USD</td>
</tr>

<tr>
<td>TOTAL AMOUNT</td>
<td>200 USD + 100 GBP</td>
</tr>

</table>


## Port uhidd HID daemon from FreeBSD

### Description

uhidd is a userland driver/daemon for USB HID devices like mouse, keyboard etc.
It is based on libusb20 and currently only works for FreeBSD 8.x and above.

The uhidd driver would allow USB gaming controllers and joysticks to be used on DragonFly BSD.
uhidd also provide support for multimedia keys found on USB keyboards.

(Derived from the [FreeBSD Wiki: uhidd](https://wiki.freebsd.org/uhidd))

### Technical details 

* This mainly involves porting uhidd and related items from FreeBSD.

### Main goals

* Being able to use USB game controllers and joysticks on DragonFly.

### Actuality

Bounty created at: 2020-02-17

### Estimated time

Unknown.

### Donators

<table>
<tr>
<th>Donor</th>
<th>Amount</th>
</tr>

<tr>
<td>kerma</td>
<td>100 USD</td>
</tr>

<tr>
<td>TOTAL AMOUNT</td>
<td>100 USD</td>
</tr>

</table>


## Extend vkernel(7) to run on any POSIX OS

### Description

* vkernel(7) allows for running DragonFly kernels in userland. Still, it requires a DragonFly operating system.

* Similar to NetBSD's rumpkernel, allow the vkernel application to be independent of the operating system. Using a cross-compiler,
  this would allow us to run a DragonFly kernel for instance on Linux or NetBSD (I know that running it within a virtual machine would be faster...).

### Technical details 

* This mainly involves rewriting parts of the page-table handling code and interrupt-related code.

### Main goals

* Being able to run a vkernel binary on any POSIX OS.

### Actuality

Bounty created at: 2020-02-12

### Estimated time

Unknown.

### Donators

<table>
<tr>
<th>Donor</th>
<th>Amount</th>
</tr>

<tr>
<td>mneumann</td>
<td>100 USD</td>
</tr>

<tr>
<td>TOTAL AMOUNT</td>
<td>100 USD</td>
</tr>

</table>


## Bluetooth-Support

### Description

* Make Bluetooth work on DragonFly.

### Technical details

We already have bluetooth support in the kernel which is based on netgraph6 (AFAIK). 
It is disabled by default and is probably out of date.

We also have a partial and old netbt port from NetBSD...

### Main goals

* Research the current state of Bluetooth in DragonFly.
* Bluetooth is enabled by default when building the kernel/world.
* Bring in updates or re-port from FreeBSD/NetBSD.
* Bluetooth keyboard / mice is working.
* Bluetooth headphone is working.

### Actuality

Bounty created at: 2020-02-12

### Estimated time

Unknown.

### Donators

<table>
<tr>
<th>Donor</th>
<th>Amount</th>
</tr>

<tr>
<td>mneumann</td>
<td>200 USD</td>
</tr>

<tr>
<td>tuxillo</td>
<td>50 USD</td>
</tr>

<tr>
<td>aly</td>
<td>50 USD</td>
</tr>

<tr>
<td>TOTAL AMOUNT</td>
<td>300 USD</td>
</tr>

</table>


## Full Rust libc FFI binding support

### Description

* Port Rust FFI libc bindings, in full to DragonFly.

### Technical details

There has intermittently been some support on this and builds and tests have gone through periods of passing and failing, but a comprehensive buildout of full support of all features would make more advanced Rust development, especially as a viable web server backend more possible.

The Github URL is https://github.com/rust-lang/libc

### Main goals

* Ensure that all features available in our libc have been ported to working in the Rust FFI lib
* Ensure that the code builds
* Ensure that all tests pass
* Ensure at least a semi automated way for the upstream team to be able to continue validation by some sort of CI/CD system so that we don't have a large support divergence

### Estimated time

Unknown.

### Donators

<table>
<tr>
<th>Donor</th>
<th>Amount</th>
</tr>

<tr>
<td>zach</td>
<td>400 USD</td>
</tr>

<tr>
<td>joris</td>
<td>150 USD</td>
</tr>

<tr>
<td>profmakx</td>
<td>200 USD</td>
</tr>

<tr>
<td>TOTAL AMOUNT</td>
<td>750 USD</td>
</tr>

</table>
<br>


## More Modern Thunderbolt Support

### Description

* Integrate Thunderbolt Devices

### Technical Details

To be defined

### Main Goals

Not Yet Written

### Estimated Time

Unknown

### Donators

<table>
<tr>
<th>Donor</th>
<th>Amount</th>
</tr>

<tr>
<td>Mike Carroll</td>
<td>150 USD</td>
</tr>

<tr>
<td>TOTAL AMOUNT</td>
<td> 150 USD</td>
</tr>

</table> 


## OpenPower9 Support

### Description

* Port DragonFly to OpenPower 9 CPUs

### Technical Details

To be defined

### Main Goals

Not Yet Written

### Estimated Time

Unknown

### Donators

<table>
<tr>
<th>Donor</th>
<th>Amount</th>
</tr>

<tr>
<td>Mike Carroll</td>
<td>150 USD</td>
</tr>

<tr>
<td>TOTAL AMOUNT</td>
<td> 150 USD</td>
</tr>

</table> 


## AArch64 support

### Description

* Port DragonFly to Aarch64

### Technical details

To be defined

### Main goals

Not yet written.

### Estimated time

Unknown.

### Donators

<table>
<tr>
<th>Donor</th>
<th>Amount</th>
</tr>

<tr>
<td>tuxillo</td>
<td>100 EUR</td>
</tr>

<tr>
<td>Mike Carroll</td>
<td>150 USD</td>
</tr>

<tr>
<td>TOTAL AMOUNT</td>
<td>100 EUR + 150 USD</td>
</tr>

</table>


## UTF-8 support in Console 

### Description 

Adding full UTF-8 support in console.

### Technical details

Not yet written.

### Main goals

Not yet written.

### Estimated time

Still unknown.

### Donators

<table>
<tr>
<th>Donor</th>
<th>Amount</th>
</tr>

<tr>
<td>timofonic</td>
<td>35 EUR</td>
</tr>

<tr>
<td>dillon</td>
<td>50 USD</td>
</tr>

<tr>
<td>kerma</td>
<td>100 USD</td>
</tr>

<tr>
<td>TOTAL AMOUNT</td>
<td>35 EUR + 150 USD</td>
</tr>

</table>

## HAMMER compression

### Description

(shamelessly copied from gsoc2010 projects page)

* Compress blocks as they get written to disk.
* Only file data (rec_type == DATA) should be compressed, not meta-data.
* the CRC should be that of the uncompressed data.
* ideally you'd need to associate the uncompressed data with the buffer cache buffer somehow, so that decompression is only performed once.
* compression could be turned on a per-file or per-pfs basis.
* gzip compression would be just fine at first; lzo or lzjb might be preferable.

**NOTE**:
HAMMER2 has replaced HAMMER to be the default filesystem on DragonFly and is under active development and maintenance.  HAMMER2 also has compression support.

### Technical details

(shamelessly copied from gsoc2010 projects page)

Doing compression would require flagging the data record as being compressed and also require double-buffering since the buffer cache buffer associated with the uncompressed data might have holes in it and otherwise referenced by user programs and cannot serve as a buffer for in-place compression or decompression.

The direct read / direct write mechanic would almost certainly have to be disabled for compressed buffers and the small-data zone would probably have to be used (the large-data zone is designed only for use with 16K or 64K buffers).

### Main goals

Not yet written.

### Estimated time

Unknown.

### Donators

<table>
<tr>
<th>Donor</th>
<th>Amount</th>
</tr>

<tr>
<td>rumko</td>
<td>50 EUR</td>
</tr>

<tr>
<td>dillon</td>
<td>100 USD</td>
</tr>

<tr>
<td>vsrinivas</td>
<td>50 USD</td>
</tr>

<tr>
<td>TOTAL AMOUNT</td>
<td>50 EUR + 150 USD</td>
</tr>

</table>


## Native NTFS support

### Description

(shamelessly copied from gsoc2010 projects page)

* Port Apple's native NTFS driver

### Technical details

(shamelessly copied from gsoc2010 projects page)

Apple's NTFS native driver could be ported to DragonFly BSD.

Latest code as of now is:
http://opensource.apple.com/source/ntfs/ntfs-84.40.1/kext/

### Main goals

Not yet written.

### Estimated time

Unknown.

### Donators

<table>
<tr>
<th>Donor</th>
<th>Amount</th>
</tr>

<tr>
<td>tuxillo</td>
<td>75 EUR</td>
</tr>

<tr>
<td>TOTAL AMOUNT</td>
<td>75 EUR</td>
</tr>

</table>


## Card reader driver

### Description

As swildner wrote on 18th Septmber 2017: we need a new driver for a card reader.

RTS5209 PCI Express Card Reader

### Estimated time

Unknown.

### Donators

<table>
<tr>
<th>Donor</th>
<th>Amount</th>
</tr>

<tr>
<td>ferz</td>
<td>20 EUR</td>
</tr>

<tr>
<td>TOTAL AMOUNT</td>
<td>20 EUR</td>
</tr>

</table>

<hr />

# Completed Bounties

## Port valgrind to DragonFlyBSD [TAKEN 2021-03-30]

### Description

(shamelessly copied from gsoc2010 projects page)

Valgrind is a very useful tool on a system like DragonFly that's under heavy development. Ideally, we would want the port to be usable with vkernel processes, thus enabling complex checking of the core kernel code.

### Technical details

Not yet written.

### Main goals

(shamelessly copied from gsoc2010 projects page)

The goal of this project is to port valgrind (3.5.0+) to the DragonFlyBSD platform so that at least the memcheck tool runs sufficiently well to be useful. Also an update for the pkgsrc package (devel/valgrind) should be made.

### Estimated time

Unknown.

### Bounty status

Taken by dan_.

Repository: [[Github|https://github.com/1338-1/valgrind-dragonfly]]

### Donators

<table>
<tr>
<th>Donor</th>
<th>Amount</th>
</tr>

<tr>
<td>rumko</td>
<td>100 EUR</td>
</tr>

<tr>
<td>tuxillo</td>
<td>50 EUR</td>
</tr>

<tr>
<td>dillon</td>
<td>100 USD</td>
</tr>

<tr>
<td>sjg</td>
<td>50 USD</td>
</tr>

<tr>
<td>TOTAL AMOUNT</td>
<td>150 EUR + 150 USD (paid)</td>
</tr>

</table>

## Hypervisor for DragonFly/x86_64

### Description

* Port nvmm (NetBSD) or bhyve (FreeBSD) to DragonFly.

### Technical details 

Employ Intel VT-x and AMD SVM to provide fast virtualization support for running various guest OSes.

### Main goals

* Hardware-accelerated virtualization to run guest operating systems like Linux or Windows 10 on DragonFly.
* Support both Intel and AMD CPUs.

### Actuality

Created at: 2020-02-12<br>
Completed at: 2021-08-08

### Estimated time

Unknown.

### Bounty status

Completed by: Aaron LI (aly@)<br>

Previous Party: Kamil Rytarowski (kamil at netbsd dot org)<br>
Previous Repository: https://github.com/Moritz-Systems/DragonFlyBSD

### Results

* Ported NVMM from NetBSD-current (as of 2021-06-25), plus various improvements/fixes from maxv's repo.
* Support both Intel VMX and AMD SVM on x86_64 CPUs.
* Components:
  - nvmm(4): kernel module, including both the MI frontend and MD backends
  - libnvmm(3): hypervisor API interacting with nvmm(4), e.g., used by QEMU
  - nvmmctl(8): utility to inspect NVMM status (still premilinary)
  - testcases/libnvmm: libnvmm test cases
  - test/nvmm: examples
* Merged into master (6.1) on 2021-07-20.
* QEMU (6.0.0) has been updated to employ NVMM on DragonFly and available in [DPorts: emulators/qemu60](https://github.com/DragonFlyBSD/DPorts/tree/master/emulators/qemu60).
* HowTo document: [Virtualization: NVMM Hypervisor](/docs/docs/howtos/nvmm)

### Donators

<table>
<tr>
<th>Donor</th>
<th>Amount</th>
</tr>

<tr>
<td>mneumann</td>
<td>500 USD (paid)</td>
</tr>

<tr>
<td>tuxillo</td>
<td>175 USD (paid)</td>
</tr>

<tr>
<td>kerma</td>
<td>500 USD (paid)</td>
</tr>

<tr>
<td>aly</td>
<td>500 CNY (myself ;))</td>
</tr>

<tr>
<td>TOTAL AMOUNT</td>
<td>1175 USD + 500 CNY</td>
</tr>

</table>


## Port autofs from FreeBSD

### Description

Autofs allows dynamic filesystem mapping to render filesystems accessible, without keeping them mounted. It is designed as a modern, simpler, cleanroom reimplementation of amd.

### Main goals

Not yet written.

### Estimated time

Unknown.

### Donators

<table>
<tr>
<th>Donor</th>
<th>Amount</th>
</tr>

<tr>
<td>kerma</td>
<td>50 USD (paid)</td>
</tr>

<tr>
<td>TOTAL AMOUNT</td>
<td>50 USD</td>
</tr>

</table>


## Bring in usb4bsd

### Description

* Completely rip out our USB stack and replace it with FreeBSD's new usb4bsd (or whatever the FreeBSD-current USB stack is called nowadays).
* Note that some work was done here already by polachok (http://gitweb.dragonflybsd.org/~polachok/dragonfly.git/shortlog/refs/heads/usb2) but the state is unknown.

### Technical details 

Not yet written.

### Main goals

Not yet written.

### Estimated time

Unknown.

### Donators

<table>
<tr>
<th>Donor</th>
<th>Amount</th>
</tr>

<tr>
<td>alexh</td>
<td>300 USD (paid)</td>
</tr>

<tr>
<td>sjg</td>
<td>100 USD (paid)</td>
</tr>

<tr>
<td>ferz</td>
<td>50 EUR (paid)</td>
</tr>

<tr>
<td>tuxillo</td>
<td>50 EUR (paid)</td>
</tr>

<tr>
<td>TOTAL AMOUNT</td>
<td>100 EUR + 400 USD</td>
</tr>

</table>