Browse Source

Initial commit

pull/1/head
Janne Pulkkinen 5 years ago
commit
3830f80078
  1. 103
      .gitignore
  2. BIN
      .nvidia_rom_vfio_edit.py.swp
  3. 116
      LICENSE
  4. 30
      README.md
  5. 183
      nvidia_vbios_vfio_patcher.py

103
.gitignore vendored

@ -0,0 +1,103 @@
# Created by https://www.gitignore.io/api/python
### Python ###
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class
# C extensions
*.so
# Distribution / packaging
.Python
env/
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
*.egg-info/
.installed.cfg
*.egg
# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec
# Installer logs
pip-log.txt
pip-delete-this-directory.txt
# Unit test / coverage reports
htmlcov/
.tox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*,cover
.hypothesis/
# Translations
*.mo
*.pot
# Django stuff:
*.log
local_settings.py
# Flask stuff:
instance/
.webassets-cache
# Scrapy stuff:
.scrapy
# Sphinx documentation
docs/_build/
# PyBuilder
target/
# Jupyter Notebook
.ipynb_checkpoints
# pyenv
.python-version
# celery beat schedule file
celerybeat-schedule
# SageMath parsed files
*.sage.py
# dotenv
.env
# virtualenv
.venv
venv/
ENV/
# Spyder project settings
.spyderproject
.spyproject
# Rope project settings
.ropeproject
# mkdocs documentation
/site
# End of https://www.gitignore.io/api/python

BIN
.nvidia_rom_vfio_edit.py.swp

Binary file not shown.

116
LICENSE

@ -0,0 +1,116 @@
CC0 1.0 Universal
Statement of Purpose
The laws of most jurisdictions throughout the world automatically confer
exclusive Copyright and Related Rights (defined below) upon the creator and
subsequent owner(s) (each and all, an "owner") of an original work of
authorship and/or a database (each, a "Work").
Certain owners wish to permanently relinquish those rights to a Work for the
purpose of contributing to a commons of creative, cultural and scientific
works ("Commons") that the public can reliably and without fear of later
claims of infringement build upon, modify, incorporate in other works, reuse
and redistribute as freely as possible in any form whatsoever and for any
purposes, including without limitation commercial purposes. These owners may
contribute to the Commons to promote the ideal of a free culture and the
further production of creative, cultural and scientific works, or to gain
reputation or greater distribution for their Work in part through the use and
efforts of others.
For these and/or other purposes and motivations, and without any expectation
of additional consideration or compensation, the person associating CC0 with a
Work (the "Affirmer"), to the extent that he or she is an owner of Copyright
and Related Rights in the Work, voluntarily elects to apply CC0 to the Work
and publicly distribute the Work under its terms, with knowledge of his or her
Copyright and Related Rights in the Work and the meaning and intended legal
effect of CC0 on those rights.
1. Copyright and Related Rights. A Work made available under CC0 may be
protected by copyright and related or neighboring rights ("Copyright and
Related Rights"). Copyright and Related Rights include, but are not limited
to, the following:
i. the right to reproduce, adapt, distribute, perform, display, communicate,
and translate a Work;
ii. moral rights retained by the original author(s) and/or performer(s);
iii. publicity and privacy rights pertaining to a person's image or likeness
depicted in a Work;
iv. rights protecting against unfair competition in regards to a Work,
subject to the limitations in paragraph 4(a), below;
v. rights protecting the extraction, dissemination, use and reuse of data in
a Work;
vi. database rights (such as those arising under Directive 96/9/EC of the
European Parliament and of the Council of 11 March 1996 on the legal
protection of databases, and under any national implementation thereof,
including any amended or successor version of such directive); and
vii. other similar, equivalent or corresponding rights throughout the world
based on applicable law or treaty, and any national implementations thereof.
2. Waiver. To the greatest extent permitted by, but not in contravention of,
applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and
unconditionally waives, abandons, and surrenders all of Affirmer's Copyright
and Related Rights and associated claims and causes of action, whether now
known or unknown (including existing as well as future claims and causes of
action), in the Work (i) in all territories worldwide, (ii) for the maximum
duration provided by applicable law or treaty (including future time
extensions), (iii) in any current or future medium and for any number of
copies, and (iv) for any purpose whatsoever, including without limitation
commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes
the Waiver for the benefit of each member of the public at large and to the
detriment of Affirmer's heirs and successors, fully intending that such Waiver
shall not be subject to revocation, rescission, cancellation, termination, or
any other legal or equitable action to disrupt the quiet enjoyment of the Work
by the public as contemplated by Affirmer's express Statement of Purpose.
3. Public License Fallback. Should any part of the Waiver for any reason be
judged legally invalid or ineffective under applicable law, then the Waiver
shall be preserved to the maximum extent permitted taking into account
Affirmer's express Statement of Purpose. In addition, to the extent the Waiver
is so judged Affirmer hereby grants to each affected person a royalty-free,
non transferable, non sublicensable, non exclusive, irrevocable and
unconditional license to exercise Affirmer's Copyright and Related Rights in
the Work (i) in all territories worldwide, (ii) for the maximum duration
provided by applicable law or treaty (including future time extensions), (iii)
in any current or future medium and for any number of copies, and (iv) for any
purpose whatsoever, including without limitation commercial, advertising or
promotional purposes (the "License"). The License shall be deemed effective as
of the date CC0 was applied by Affirmer to the Work. Should any part of the
License for any reason be judged legally invalid or ineffective under
applicable law, such partial invalidity or ineffectiveness shall not
invalidate the remainder of the License, and in such case Affirmer hereby
affirms that he or she will not (i) exercise any of his or her remaining
Copyright and Related Rights in the Work or (ii) assert any associated claims
and causes of action with respect to the Work, in either case contrary to
Affirmer's express Statement of Purpose.
4. Limitations and Disclaimers.
a. No trademark or patent rights held by Affirmer are waived, abandoned,
surrendered, licensed or otherwise affected by this document.
b. Affirmer offers the Work as-is and makes no representations or warranties
of any kind concerning the Work, express, implied, statutory or otherwise,
including without limitation warranties of title, merchantability, fitness
for a particular purpose, non infringement, or the absence of latent or
other defects, accuracy, or the present or absence of errors, whether or not
discoverable, all to the greatest extent permissible under applicable law.
c. Affirmer disclaims responsibility for clearing rights of other persons
that may apply to the Work or any use thereof, including without limitation
any person's Copyright and Related Rights in the Work. Further, Affirmer
disclaims responsibility for obtaining any necessary consents, permissions
or other rights required for any use of the Work.
d. Affirmer understands and acknowledges that Creative Commons is not a
party to this document and has no duty or obligation with respect to this
CC0 or use of the Work.
For more information, please see
<http://creativecommons.org/publicdomain/zero/1.0/>

30
README.md

@ -0,0 +1,30 @@
# NVIDIA vBIOS VFIO Patcher
nvidia_vbios_vfio_patcher.py is a script that creates a patched/spliced copy of a NVIDIA vBIOS that allows VFIO passthrough when using libvirt. This copy of the vBIOS can then be passed to libvirt, allowing the NVIDIA GPU to be used in the guest VM. This can be done by adding the following line to the VM domain XML file.
```
<hostdev>
...
<rom file='/path/to/your/patched/gpu/bios.bin'/>
...
</hostdev>
```
This script may be useful if you are using one of the Pascal (1xxx series) series of NVIDIA GPUs and you are having passing the GPU to the guest VM. In this case, the vBIOS of the system's primary GPU is tainted when booting the host OS, making GPU passthrough impossible unless a clean copy of the vBIOS is used.
# DISCLAIMER
**Use this script at your own discretion. This script has NOT been tested extensively, and has only been tested with a few GPUs belonging to he Pascal series of NVIDIA GPUs.**
**The script makes only a few rudimentary sanity checks, but no guarantees are made of the validity of the patched ROM!**
# Usage
The script should work with both Python 2 and 3.
To create a patched version of the BIOS, run the script with the following parameters.
```
python nvidia_vbios_vfio_patcher.py -i <ORIGINAL_ROM> -o <PATCHED_ROM>
```
A patched version of <ORIGINAL_ROM> will be written to <PATCHED_ROM>.

183
nvidia_vbios_vfio_patcher.py

@ -0,0 +1,183 @@
from __future__ import print_function
import sys
import binascii
import argparse
import re
# raw_input doesn't exist in Python 3
try:
raw_input
except NameError:
raw_input = input
PROMPT_TEXT = (
"I agree to be careful"
)
WARNING_TEXT = """
USE THIS SOFTWARE AT YOUR OWN DISCRETION. THIS SOFTWARE HAS *NOT* BEEN
EXTENSIVELY TESTED AND MAY NOT WORK WITH YOUR GRAPHICS CARD.
If you want to save the created vBIOS file, type the following phrase
EXACTLY as it is written below:
%s
""" % PROMPT_TEXT
class VBIOSROM(object):
def __init__(self, f):
"""
Load a VBIOS and convert it into a hex-ascii format
for easier editing
"""
content = f.read()
self.offsets = {
"header": None,
"footer": None
}
self.content = binascii.hexlify(content)
def detect_offsets(self):
"""
Search the ROM for known sections of data and raise an AssertionError
if any of the checks fails
"""
content = self.content
# Search for the header that starts the file
# Examples of this header:
#
# U.y.K7400.L.w.VIDEO
# U.x.K7400.L.w.VIDEO
#
HEADER_REGEX = (
b'55aa(([a-z]|[0-9]){2})(eb)(([a-z]|[0-9]){20})(564944454f)'
)
result = re.compile(HEADER_REGEX).search(self.content)
assert len(result.groups()) == 6, "Couldn't find the ROM header!"
self.offsets["header"] = result.start(0)
# Search for the footer, which are shortly followed by
# 'NPDS' and 'NPDE' strings. 'NPDS' and 'NPDE' markers are separated by
# 28 ASCII characters
FOOTER_REGEX = (
b'564e(([a-z]|[0-9]){348})(4e504453)(([a-z]|[0-9]){56})(4e504445)'
)
result = re.compile(FOOTER_REGEX).search(self.content)
assert len(result.groups()) == 6, "Couldn't find the ROM footer!"
self.offsets["footer"] = result.start(0)
def run_sanity_tests(self, ignore_check=False):
"""
Run a few sanity tests on the ROM to be a little more sure we are
working with a valid ROM
"""
try:
# There should be one 'NPDS' marker and three 'NPDE' markers
# before the footer we've already found
#
# The 'NPDS' marker should be followed by two 'NPDE' markers
npds_count = self.content.count(
b"4e504453", self.offsets["header"], self.offsets["footer"])
assert npds_count == 1, \
str("Expected only one 'NPDS' marker between header and "
"footer, found %d" % npds_count)
npde_count = self.content.count(
b"4e504445", self.offsets["header"], self.offsets["footer"])
assert npde_count == 3, \
str("Expected only three 'NPDE' markers between header and "
"footer, found %d" % npde_count)
npde_after_npds_count = self.content.count(
b"4e504445", self.content.find(b"4e504453"),
self.offsets["footer"])
assert npde_after_npds_count == 2, \
"Expected two 'NPDE' markers after the 'NPDS' marker"
except AssertionError as e:
if ignore_check:
print("Encountered error during sanity check: %s" % str(e))
print("Ignoring...")
else:
raise
print("No problems found.")
def get_spliced_rom(self):
"""
Convert the internal hex-ascii representation of the ROM
into binary data for saving
"""
start = self.offsets["header"]
end = self.offsets["footer"]
spliced = self.content[start:end]
return binascii.unhexlify(spliced)
def main():
parser = argparse.ArgumentParser(
description=(
"Convert a full NVIDIA Pascal vBIOS ROM into a form compatible "
"for PCI passthrough."
)
)
parser.add_argument(
"-i", type=str, required=True,
help="The full ROM to read")
parser.add_argument(
"-o", type=str, required=True,
help="Path for saving the newly generated ROM")
parser.add_argument(
"--ignore-sanity-check", default=False, action="store_true",
help="Don't halt the script if any of the sanity checks fails"
)
parser.add_argument(
"--skip-the-very-important-warning",
default=False, action="store_true",
help=(
"Skip the very important warning and save the ROM without asking "
"for any input."
)
)
args = parser.parse_args()
print("Opening the ROM file...")
with open(args.i, "rb") as f:
rom = VBIOSROM(f)
print("Scanning for ROM offsets...")
rom.detect_offsets()
print("Offsets found!")
print("Running sanity checks...")
rom.run_sanity_tests(args.ignore_sanity_check)
spliced_rom = rom.get_spliced_rom()
if not args.skip_the_very_important_warning:
print(WARNING_TEXT)
print("Type here: ", end="")
answer = raw_input()
if answer != PROMPT_TEXT:
print("Wrong answer, halting...")
sys.exit(1)
print("Writing the edited ROM...")
with open(args.o, "wb") as f:
f.write(spliced_rom)
print("Done!")
if __name__ == "__main__":
main()
Loading…
Cancel
Save