mirrors/quickpassthrough
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update readme for the golang version

Browse source
This commit is contained in:
HikariKnight 2023-04-10 02:10:12 +02:00
parent e19090942a
commit 42a017a58b
1 changed files with 27 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

56
README.md
View file

@ -2,59 +2,57 @@
A project to simplify setting up GPU passthrough on your Linux host for [QuickEMU](https://github.com/quickemu-project/quickemu)(vfio support not developed yet) and libvirt/virt-manager A project to simplify setting up GPU passthrough on your Linux host for [QuickEMU](https://github.com/quickemu-project/quickemu)(vfio support not developed yet) and libvirt/virt-manager
You can use it by simply running You can use it by simply downloading the latest release and run it inside a terminal/shell or by downloading and compiling it yourself with the commands below.
```bash ```bash
git clone https://github.com/HikariKnight/quickpassthrough.git git clone https://github.com/HikariKnight/quickpassthrough.git
cd quickpassthrough cd quickpassthrough
./vfio-setup go mod download
go build -o quickpassthrough cmd/main.go
``` ```
## Features ## Features
* General warning and info about what you will be needing * General warning and info about what you will be needing
* Enable and configure vfio modules * Enable and configure vfio modules
* Configure 2nd GPU for GPU Passthrough * Configure 2nd GPU for GPU Passthrough (1 for host, 1 for VM)
* Dump the selected GPU rom (as some cards require a romfile for passthrough to work), however no rom patching support planned. * Generate script to use for dumping the vbios rom (as some cards require a romfile for passthrough to work), however no rom patching support planned.
* Enable and configure the correct kernel modules and load them early (initramfs-tools, dracut and mkinitcpio) * Enable and configure the correct kernel modules and load them early (initramfs-tools, dracut and mkinitcpio)
* Configure kernel arguments for systemd-boot (using kernelstub) * Configure kernel arguments for systemd-boot (using kernelstub)
* Configure kernel arguments for grub2 * Configure kernel arguments for grub2
* Provides you with the correct kernel arguments to add to your bootloader entry if a supported bootloader is not found * Provides you with the correct kernel arguments to add to your bootloader entry if a supported bootloader is not found
## Contributing ## Contributing
<img src="https://user-images.githubusercontent.com/2557889/156038229-4e70352f-9182-4474-8e32-d14d3ad67566.png" width="250px"> <img src="https://user-images.githubusercontent.com/2557889/156038229-4e70352f-9182-4474-8e32-d14d3ad67566.png" width="250px">
I know my bash skills are not great, so help is always welcome! And help is wanted here. This project originally started out as a bash only project, upon completing the proof of concept it became very clear that bash would become very messy with all the weird quirks and regex and inline editing of files. <br>
If you know bash well, you will be able to help! Just make a pull request to the [dev branch](https://github.com/HikariKnight/quickpassthrough/tree/dev) with your changes! So the project moved over to golang, this lets us utilize TUI toolkits like [Bubble Tea](https://github.com/charmbracelet/bubbletea) to build a proper menu system for the project. <br>
If you know golang, bubbletea, passthrough or qemu, you are welcome to help! Just make a pull request to the [dev branch](https://github.com/HikariKnight/quickpassthrough/tree/dev) with your changes!<br>
Just remember to add comments to document the work and explain it for people who are less familiar with the bash syntax or anything else you use. 😄 Just remember to add comments to document the work and explain it for people who are less familiar with the bash syntax or anything else you use. 😄
Also if you know English, you can help by just proof reading. English is not my native language, plus I have dyslexia so I often make spelling mistakes. Also if you know English, you can help by just proof reading. English is not my native language, plus I have dyslexia so I often make spelling mistakes.
Proof reading is still contribution! Proof reading is still contribution!
## TODO ## Features
* Show general warning to user and inform about making a backup and general expectations
* Detect if user has an amd or intel CPU and provide the correct IOMMU kernel args based on that
* Use [ls-iommu](https://github.com/HikariKnight/ls-iommu) to find PCI devices like graphic cards, usb controllers, etc and see what IOMMU group they are in
* Enable and configure vfio modules
* Generate the correct kernel arguments for grub and systemd-boot~~
* Dump the GPU rom, just in case it will be needed for passthrough~~ (no rom patching planned due to complexity)
* A system you can navigate through, built using [Bubble Tea](https://github.com/charmbracelet/bubbletea) (Help appreciated to make this menu better!)
* ~~Coloured highlight/text for important information?~~ (not implemented yet)
* Make sure [vendor-reset](https://github.com/gnif/vendor-reset) module is loaded before vfio, check the repository for the list of cards that require it!
* ~~Everything~~ ## Features now handled by [ls-iommu](https://github.com/HikariKnight/ls-iommu)
* ~~Show general warning to user and inform about making a backup and general expectations~~ * Automatically handle GPUs where parts of it might be in separate IOMMU groups (ex: RX6600XT)
* ~~Detect if user has an amd or intel CPU and provide the correct IOMMU kernel args based on that~~ * Fetch the ID and PCI Address of devices
* ~~Tell user to enable IOMMU (VT-d/AMD-v) on their motherboard and bootloader~~ * Locate the vbios rom path on the system
* ~~Integrate ls-iommu and locate graphic cards and see what IOMMU group they are in~~ * Tell the user to enable IOMMU (VT-d/AMD-v) on their motherboard and bootloader
* ~~Enable and configure vfio modules~~ * Get a list of devices, their IOMMU groups and various other information
* ~~Fetch the ID for the GPUs and generate the correct kernel arguments for grub and systemd-boot~~
* ~~Dump the GPU rom, just in case it will be needed for passthrough~~ (no rom patching planned due to complexity)
* ~~Get help to actually make the scripts better~~
* Automatically handle GPUs where parts of it might be in separate IOMMU groups (ex: RX5600XT)
* A non-hacky menu system? (I will need help by some bash wizards for this)
* Coloured highlight/text for important information?
* Install vendor\_reset kernel module? (maybe far future, need to detect if user is using a card that needs it, can however mention where to get it)
* Suggest looking-glass if they are going to run Windows
---- ----
### Why bash? ### Why GO?
I wanted the dependencies to be minimal without the need for compilation and to avoid potential breaking changes in the future (like with the transition from python2 to python3). I wanted to learn it, while also using a language that would potentially not create system dependencies. GO fits this criteria when you compile using CGO_ENABLED=0 as this will statically link the libraries and still produce a fairly small (when compressed with upx) binary.
I know enough bash to make things work, but I am in no way a professional in writing bash scripts as I usually write python and golang.
There is also quite a lot of perl usage as I am quite familiar with the perl regex format over something like sed