docs/developer/Code_Bounties.mdwn

   1 [[!toc levels=2]]
   2
   3 # Explanation
   4
   5 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!).
   6
   7 # Rules
   8
   9 * 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.
  10
  11 * 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.
  12
  13 * 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.
  14
  15 * 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.
  16
  17 * All code submitted shall be of the same license as DragonFly. Any questions on the licensing issues should be directed to the DragonFly Team.
  18
  19
  20 <hr />
  21
  22 # Active bounties
  23
  24 ## In-kernel WireGuard port
  25
  26 ### Description
  27
  28 [WireGuard](https://www.wireguard.com/) is an extremely simple yet fast and modern VPN that utilizes state-of-the-art cryptography.
  29 It aims to be faster, simpler, leaner, and more useful than IPsec, while avoiding the massive headache.
  30 It intends to be considerably more performant than OpenVPN.
  31 WireGuard is designed as a general purpose VPN for running on embedded interfaces and super computers alike, fit for many different circumstances.
  32 Initially released for the Linux kernel, it is now cross-platform (Windows, macOS, BSD, iOS, Android) and widely deployable.
  33 (copied from [WireGuard official website](https://www.wireguard.com/))
  34
  35 We already have the userland implementation in Golang in DPorts (i.e., [`wireguard-go`](https://github.com/DragonFlyBSD/DPorts/tree/master/net/wireguard-go)).
  36 It would be better to also gain the in-kernel implementation, like OpenBSD and FreeBSD already did.
  37
  38 ### Technical details
  39
  40 * Port WireGuard directly from the upstream or from OpenBSD/FreeBSD.
  41 * The crypto framework might need an update (from OpenBSD/FreeBSD).
  42
  43 **NOTE**:
  44 The initial port by FreeBSD/Netgate was buggy, so need to investigate before using that code.
  45 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/)
  46
  47 ### Main goals
  48
  49 * WireGuard port in DragonFly kernel, as well as the userland tools.
  50 * WireGuard works.
  51 * The port should be ideally reviewed/audited by the WireGuard project.
  52   I (aly@) believe the author (Jason A. Donenfeld) would like to help.
  53
  54 ### Actuality
  55
  56 Created at: 2021-08-12
  57
  58 ### Estimated time
  59
  60 Unknown.
  61
  62 ### Donators
  63
  64 <table>
  65 <tr>
  66 <th>Donor</th>
  67 <th>Amount</th>
  68 </tr>
  69
  70 <tr>
  71 <td>aly</td>
  72 <td>100 USD</td>
  73 </tr>
  74
  75 <tr>
  76 <td>TOTAL AMOUNT</td>
  77 <td>100 USD</td>
  78 </tr>
  79 </table>
  80
  81
  82 ## Bring in support for USB webcams
  83
  84 ### Description
  85
  86 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.
  87
  88 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 :).
  89
  90 ### Actuality
  91
  92 Bounty created at: 2021-08-08
  93
  94 ### Estimated time
  95
  96 Unknown.
  97
  98 ### Donators
  99
 100 <table>
 101 <tr>
 102 <th>Donor</th>
 103 <th>Amount</th>
 104 </tr>
 105
 106 <tr>
 107 <td>mneumann</td>
 108 <td>150 USD</td>
 109 </tr>
 110
 111 <tr>
 112 <td>pikrzyszt</td>
 113 <td>100 GBP</td>
 114 </tr>
 115
 116 <tr>
 117 <td>aly</td>
 118 <td>50 USD</td>
 119 </tr>
 120
 121 <tr>
 122 <td>TOTAL AMOUNT</td>
 123 <td>200 USD + 100 GBP</td>
 124 </tr>
 125
 126 </table>
 127
 128
 129 ## Port uhidd HID daemon from FreeBSD
 130
 131 ### Description
 132
 133 uhidd is a userland driver/daemon for USB HID devices like mouse, keyboard etc.
 134 It is based on libusb20 and currently only works for FreeBSD 8.x and above.
 135
 136 The uhidd driver would allow USB gaming controllers and joysticks to be used on DragonFly BSD.
 137 uhidd also provide support for multimedia keys found on USB keyboards.
 138
 139 (Derived from the [FreeBSD Wiki: uhidd](https://wiki.freebsd.org/uhidd))
 140
 141 ### Technical details
 142
 143 * This mainly involves porting uhidd and related items from FreeBSD.
 144
 145 ### Main goals
 146
 147 * Being able to use USB game controllers and joysticks on DragonFly.
 148
 149 ### Actuality
 150
 151 Bounty created at: 2020-02-17
 152
 153 ### Estimated time
 154
 155 Unknown.
 156
 157 ### Donators
 158
 159 <table>
 160 <tr>
 161 <th>Donor</th>
 162 <th>Amount</th>
 163 </tr>
 164
 165 <tr>
 166 <td>kerma</td>
 167 <td>100 USD</td>
 168 </tr>
 169
 170 <tr>
 171 <td>TOTAL AMOUNT</td>
 172 <td>100 USD</td>
 173 </tr>
 174
 175 </table>
 176
 177
 178 ## Extend vkernel(7) to run on any POSIX OS
 179
 180 ### Description
 181
 182 * vkernel(7) allows for running DragonFly kernels in userland. Still, it requires a DragonFly operating system.
 183
 184 * Similar to NetBSD's rumpkernel, allow the vkernel application to be independent of the operating system. Using a cross-compiler,
 185   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...).
 186
 187 ### Technical details
 188
 189 * This mainly involves rewriting parts of the page-table handling code and interrupt-related code.
 190
 191 ### Main goals
 192
 193 * Being able to run a vkernel binary on any POSIX OS.
 194
 195 ### Actuality
 196
 197 Bounty created at: 2020-02-12
 198
 199 ### Estimated time
 200
 201 Unknown.
 202
 203 ### Donators
 204
 205 <table>
 206 <tr>
 207 <th>Donor</th>
 208 <th>Amount</th>
 209 </tr>
 210
 211 <tr>
 212 <td>mneumann</td>
 213 <td>100 USD</td>
 214 </tr>
 215
 216 <tr>
 217 <td>TOTAL AMOUNT</td>
 218 <td>100 USD</td>
 219 </tr>
 220
 221 </table>
 222
 223
 224 ## Bluetooth-Support
 225
 226 ### Description
 227
 228 * Make Bluetooth work on DragonFly.
 229
 230 ### Technical details
 231
 232 We already have bluetooth support in the kernel which is based on netgraph6 (AFAIK).
 233 It is disabled by default and is probably out of date.
 234
 235 We also have a partial and old netbt port from NetBSD...
 236
 237 ### Main goals
 238
 239 * Research the current state of Bluetooth in DragonFly.
 240 * Bluetooth is enabled by default when building the kernel/world.
 241 * Bring in updates or re-port from FreeBSD/NetBSD.
 242 * Bluetooth keyboard / mice is working.
 243 * Bluetooth headphone is working.
 244
 245 ### Actuality
 246
 247 Bounty created at: 2020-02-12
 248
 249 ### Estimated time
 250
 251 Unknown.
 252
 253 ### Donators
 254
 255 <table>
 256 <tr>
 257 <th>Donor</th>
 258 <th>Amount</th>
 259 </tr>
 260
 261 <tr>
 262 <td>mneumann</td>
 263 <td>200 USD</td>
 264 </tr>
 265
 266 <tr>
 267 <td>tuxillo</td>
 268 <td>50 USD</td>
 269 </tr>
 270
 271 <tr>
 272 <td>aly</td>
 273 <td>50 USD</td>
 274 </tr>
 275
 276 <tr>
 277 <td>TOTAL AMOUNT</td>
 278 <td>300 USD</td>
 279 </tr>
 280
 281 </table>
 282
 283
 284 ## Full Rust libc FFI binding support
 285
 286 ### Description
 287
 288 * Port Rust FFI libc bindings, in full to DragonFly.
 289
 290 ### Technical details
 291
 292 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.
 293
 294 The Github URL is https://github.com/rust-lang/libc
 295
 296 ### Main goals
 297
 298 * Ensure that all features available in our libc have been ported to working in the Rust FFI lib
 299 * Ensure that the code builds
 300 * Ensure that all tests pass
 301 * 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
 302
 303 ### Estimated time
 304
 305 Unknown.
 306
 307 ### Donators
 308
 309 <table>
 310 <tr>
 311 <th>Donor</th>
 312 <th>Amount</th>
 313 </tr>
 314
 315 <tr>
 316 <td>zach</td>
 317 <td>400 USD</td>
 318 </tr>
 319
 320 <tr>
 321 <td>joris</td>
 322 <td>150 USD</td>
 323 </tr>
 324
 325 <tr>
 326 <td>profmakx</td>
 327 <td>200 USD</td>
 328 </tr>
 329
 330 <tr>
 331 <td>TOTAL AMOUNT</td>
 332 <td>750 USD</td>
 333 </tr>
 334
 335 </table>
 336 <br>
 337
 338
 339 ## More Modern Thunderbolt Support
 340
 341 ### Description
 342
 343 * Integrate Thunderbolt Devices
 344
 345 ### Technical Details
 346
 347 To be defined
 348
 349 ### Main Goals
 350
 351 Not Yet Written
 352
 353 ### Estimated Time
 354
 355 Unknown
 356
 357 ### Donators
 358
 359 <table>
 360 <tr>
 361 <th>Donor</th>
 362 <th>Amount</th>
 363 </tr>
 364
 365 <tr>
 366 <td>Mike Carroll</td>
 367 <td>150 USD</td>
 368 </tr>
 369
 370 <tr>
 371 <td>TOTAL AMOUNT</td>
 372 <td> 150 USD</td>
 373 </tr>
 374
 375 </table>
 376
 377
 378 ## OpenPower9 Support
 379
 380 ### Description
 381
 382 * Port DragonFly to OpenPower 9 CPUs
 383
 384 ### Technical Details
 385
 386 To be defined
 387
 388 ### Main Goals
 389
 390 Not Yet Written
 391
 392 ### Estimated Time
 393
 394 Unknown
 395
 396 ### Donators
 397
 398 <table>
 399 <tr>
 400 <th>Donor</th>
 401 <th>Amount</th>
 402 </tr>
 403
 404 <tr>
 405 <td>Mike Carroll</td>
 406 <td>150 USD</td>
 407 </tr>
 408
 409 <tr>
 410 <td>TOTAL AMOUNT</td>
 411 <td> 150 USD</td>
 412 </tr>
 413
 414 </table>
 415
 416
 417 ## AArch64 support
 418
 419 ### Description
 420
 421 * Port DragonFly to Aarch64
 422
 423 ### Technical details
 424
 425 To be defined
 426
 427 ### Main goals
 428
 429 Not yet written.
 430
 431 ### Estimated time
 432
 433 Unknown.
 434
 435 ### Donators
 436
 437 <table>
 438 <tr>
 439 <th>Donor</th>
 440 <th>Amount</th>
 441 </tr>
 442
 443 <tr>
 444 <td>tuxillo</td>
 445 <td>100 EUR</td>
 446 </tr>
 447
 448 <tr>
 449 <td>Mike Carroll</td>
 450 <td>150 USD</td>
 451 </tr>
 452
 453 <tr>
 454 <td>TOTAL AMOUNT</td>
 455 <td>100 EUR + 150 USD</td>
 456 </tr>
 457
 458 </table>
 459
 460
 461 ## UTF-8 support in Console
 462
 463 ### Description
 464
 465 Adding full UTF-8 support in console.
 466
 467 ### Technical details
 468
 469 Not yet written.
 470
 471 ### Main goals
 472
 473 Not yet written.
 474
 475 ### Estimated time
 476
 477 Still unknown.
 478
 479 ### Donators
 480
 481 <table>
 482 <tr>
 483 <th>Donor</th>
 484 <th>Amount</th>
 485 </tr>
 486
 487 <tr>
 488 <td>timofonic</td>
 489 <td>35 EUR</td>
 490 </tr>
 491
 492 <tr>
 493 <td>dillon</td>
 494 <td>50 USD</td>
 495 </tr>
 496
 497 <tr>
 498 <td>kerma</td>
 499 <td>100 USD</td>
 500 </tr>
 501
 502 <tr>
 503 <td>TOTAL AMOUNT</td>
 504 <td>35 EUR + 150 USD</td>
 505 </tr>
 506
 507 </table>
 508
 509 ## HAMMER compression
 510
 511 ### Description
 512
 513 (shamelessly copied from gsoc2010 projects page)
 514
 515 * Compress blocks as they get written to disk.
 516 * Only file data (rec_type == DATA) should be compressed, not meta-data.
 517 * the CRC should be that of the uncompressed data.
 518 * ideally you'd need to associate the uncompressed data with the buffer cache buffer somehow, so that decompression is only performed once.
 519 * compression could be turned on a per-file or per-pfs basis.
 520 * gzip compression would be just fine at first; lzo or lzjb might be preferable.
 521
 522 **NOTE**:
 523 HAMMER2 has replaced HAMMER to be the default filesystem on DragonFly and is under active development and maintenance.  HAMMER2 also has compression support.
 524
 525 ### Technical details
 526
 527 (shamelessly copied from gsoc2010 projects page)
 528
 529 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.
 530
 531 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).
 532
 533 ### Main goals
 534
 535 Not yet written.
 536
 537 ### Estimated time
 538
 539 Unknown.
 540
 541 ### Donators
 542
 543 <table>
 544 <tr>
 545 <th>Donor</th>
 546 <th>Amount</th>
 547 </tr>
 548
 549 <tr>
 550 <td>rumko</td>
 551 <td>50 EUR</td>
 552 </tr>
 553
 554 <tr>
 555 <td>dillon</td>
 556 <td>100 USD</td>
 557 </tr>
 558
 559 <tr>
 560 <td>vsrinivas</td>
 561 <td>50 USD</td>
 562 </tr>
 563
 564 <tr>
 565 <td>TOTAL AMOUNT</td>
 566 <td>50 EUR + 150 USD</td>
 567 </tr>
 568
 569 </table>
 570
 571
 572 ## Native NTFS support
 573
 574 ### Description
 575
 576 (shamelessly copied from gsoc2010 projects page)
 577
 578 * Port Apple's native NTFS driver
 579
 580 ### Technical details
 581
 582 (shamelessly copied from gsoc2010 projects page)
 583
 584 Apple's NTFS native driver could be ported to DragonFly BSD.
 585
 586 Latest code as of now is:
 587 http://opensource.apple.com/source/ntfs/ntfs-84.40.1/kext/
 588
 589 ### Main goals
 590
 591 Not yet written.
 592
 593 ### Estimated time
 594
 595 Unknown.
 596
 597 ### Donators
 598
 599 <table>
 600 <tr>
 601 <th>Donor</th>
 602 <th>Amount</th>
 603 </tr>
 604
 605 <tr>
 606 <td>tuxillo</td>
 607 <td>75 EUR</td>
 608 </tr>
 609
 610 <tr>
 611 <td>TOTAL AMOUNT</td>
 612 <td>75 EUR</td>
 613 </tr>
 614
 615 </table>
 616
 617
 618 ## Card reader driver
 619
 620 ### Description
 621
 622 As swildner wrote on 18th Septmber 2017: we need a new driver for a card reader.
 623
 624 RTS5209 PCI Express Card Reader
 625
 626 ### Estimated time
 627
 628 Unknown.
 629
 630 ### Donators
 631
 632 <table>
 633 <tr>
 634 <th>Donor</th>
 635 <th>Amount</th>
 636 </tr>
 637
 638 <tr>
 639 <td>ferz</td>
 640 <td>20 EUR</td>
 641 </tr>
 642
 643 <tr>
 644 <td>TOTAL AMOUNT</td>
 645 <td>20 EUR</td>
 646 </tr>
 647
 648 </table>
 649
 650 <hr />
 651
 652 # Completed Bounties
 653
 654 ## Port valgrind to DragonFlyBSD [TAKEN 2021-03-30]
 655
 656 ### Description
 657
 658 (shamelessly copied from gsoc2010 projects page)
 659
 660 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.
 661
 662 ### Technical details
 663
 664 Not yet written.
 665
 666 ### Main goals
 667
 668 (shamelessly copied from gsoc2010 projects page)
 669
 670 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.
 671
 672 ### Estimated time
 673
 674 Unknown.
 675
 676 ### Bounty status
 677
 678 Taken by dan_.
 679
 680 Repository: [[Github|https://github.com/1338-1/valgrind-dragonfly]]
 681
 682 ### Donators
 683
 684 <table>
 685 <tr>
 686 <th>Donor</th>
 687 <th>Amount</th>
 688 </tr>
 689
 690 <tr>
 691 <td>rumko</td>
 692 <td>100 EUR</td>
 693 </tr>
 694
 695 <tr>
 696 <td>tuxillo</td>
 697 <td>50 EUR</td>
 698 </tr>
 699
 700 <tr>
 701 <td>dillon</td>
 702 <td>100 USD</td>
 703 </tr>
 704
 705 <tr>
 706 <td>sjg</td>
 707 <td>50 USD</td>
 708 </tr>
 709
 710 <tr>
 711 <td>TOTAL AMOUNT</td>
 712 <td>150 EUR + 150 USD (paid)</td>
 713 </tr>
 714
 715 </table>
 716
 717 ## Hypervisor for DragonFly/x86_64
 718
 719 ### Description
 720
 721 * Port nvmm (NetBSD) or bhyve (FreeBSD) to DragonFly.
 722
 723 ### Technical details
 724
 725 Employ Intel VT-x and AMD SVM to provide fast virtualization support for running various guest OSes.
 726
 727 ### Main goals
 728
 729 * Hardware-accelerated virtualization to run guest operating systems like Linux or Windows 10 on DragonFly.
 730 * Support both Intel and AMD CPUs.
 731
 732 ### Actuality
 733
 734 Created at: 2020-02-12<br>
 735 Completed at: 2021-08-08
 736
 737 ### Estimated time
 738
 739 Unknown.
 740
 741 ### Bounty status
 742
 743 Completed by: Aaron LI (aly@)<br>
 744
 745 Previous Party: Kamil Rytarowski (kamil at netbsd dot org)<br>
 746 Previous Repository: https://github.com/Moritz-Systems/DragonFlyBSD
 747
 748 ### Results
 749
 750 * Ported NVMM from NetBSD-current (as of 2021-06-25), plus various improvements/fixes from maxv's repo.
 751 * Support both Intel VMX and AMD SVM on x86_64 CPUs.
 752 * Components:
 753   - nvmm(4): kernel module, including both the MI frontend and MD backends
 754   - libnvmm(3): hypervisor API interacting with nvmm(4), e.g., used by QEMU
 755   - nvmmctl(8): utility to inspect NVMM status (still premilinary)
 756   - testcases/libnvmm: libnvmm test cases
 757   - test/nvmm: examples
 758 * Merged into master (6.1) on 2021-07-20.
 759 * 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).
 760 * HowTo document: [Virtualization: NVMM Hypervisor](/docs/docs/howtos/nvmm)
 761
 762 ### Donators
 763
 764 <table>
 765 <tr>
 766 <th>Donor</th>
 767 <th>Amount</th>
 768 </tr>
 769
 770 <tr>
 771 <td>mneumann</td>
 772 <td>500 USD (paid)</td>
 773 </tr>
 774
 775 <tr>
 776 <td>tuxillo</td>
 777 <td>175 USD (paid)</td>
 778 </tr>
 779
 780 <tr>
 781 <td>kerma</td>
 782 <td>500 USD (paid)</td>
 783 </tr>
 784
 785 <tr>
 786 <td>aly</td>
 787 <td>500 CNY (myself ;))</td>
 788 </tr>
 789
 790 <tr>
 791 <td>TOTAL AMOUNT</td>
 792 <td>1175 USD + 500 CNY</td>
 793 </tr>
 794
 795 </table>
 796
 797
 798 ## Port autofs from FreeBSD
 799
 800 ### Description
 801
 802 Autofs allows dynamic filesystem mapping to render filesystems accessible, without keeping them mounted. It is designed as a modern, simpler, cleanroom reimplementation of amd.
 803
 804 ### Main goals
 805
 806 Not yet written.
 807
 808 ### Estimated time
 809
 810 Unknown.
 811
 812 ### Donators
 813
 814 <table>
 815 <tr>
 816 <th>Donor</th>
 817 <th>Amount</th>
 818 </tr>
 819
 820 <tr>
 821 <td>kerma</td>
 822 <td>50 USD (paid)</td>
 823 </tr>
 824
 825 <tr>
 826 <td>TOTAL AMOUNT</td>
 827 <td>50 USD</td>
 828 </tr>
 829
 830 </table>
 831
 832
 833 ## Bring in usb4bsd
 834
 835 ### Description
 836
 837 * Completely rip out our USB stack and replace it with FreeBSD's new usb4bsd (or whatever the FreeBSD-current USB stack is called nowadays).
 838 * 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.
 839
 840 ### Technical details
 841
 842 Not yet written.
 843
 844 ### Main goals
 845
 846 Not yet written.
 847
 848 ### Estimated time
 849
 850 Unknown.
 851
 852 ### Donators
 853
 854 <table>
 855 <tr>
 856 <th>Donor</th>
 857 <th>Amount</th>
 858 </tr>
 859
 860 <tr>
 861 <td>alexh</td>
 862 <td>300 USD (paid)</td>
 863 </tr>
 864
 865 <tr>
 866 <td>sjg</td>
 867 <td>100 USD (paid)</td>
 868 </tr>
 869
 870 <tr>
 871 <td>ferz</td>
 872 <td>50 EUR (paid)</td>
 873 </tr>
 874
 875 <tr>
 876 <td>tuxillo</td>
 877 <td>50 EUR (paid)</td>
 878 </tr>
 879
 880 <tr>
 881 <td>TOTAL AMOUNT</td>
 882 <td>100 EUR + 400 USD</td>
 883 </tr>
 884
 885 </table>