-
Notifications
You must be signed in to change notification settings - Fork 127
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add README for ofrak_gpu, compiled futhark code, rename CLI file
- Loading branch information
Showing
6 changed files
with
12,333 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
[run] | ||
omit = | ||
ofrak_gpu/entropy.py | ||
ofrak_gpu/run.py | ||
ofrak_gpu/bench.py | ||
ofrak_gpu/run_entropy.py | ||
ofrak_gpu/bench_entropy.py |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,25 @@ | ||
# ofrak_gpu | ||
# OFRAK | ||
OFRAK (Open Firmware Reverse Analysis Konsole) is a binary analysis and modification platform that combines the ability to unpack, analyze, modify, and repack binaries. | ||
|
||
|
||
# Package: ofrak_gpu | ||
|
||
``` | ||
OFRAK | ||
└───... | ||
└───ofrak_gpu <-- //YOU ARE HERE// | ||
│ └───entropy.fut // Futhark source code for GPU-bound entropy calculations | ||
│ └───entropy.py // Pyopencl equivalent of entropy.fut, generated by the futhark compiler (see "Futhark Compilation") | ||
│ └───run_entropy.py // CLI to run compute the entropy of a file | ||
└───... | ||
``` | ||
|
||
This package contains the GPU-bound implementations of expensive computations performed by OFRAK. | ||
|
||
## Futhark Compilation | ||
The [Futhark language](https://futhark-lang.org/) is not required to install and run this module, nor will the Futhark compiler be installed into your Docker container. Instead, `entropy.py`, the compiled pyopencl output of `entropy.fut`, has been provided. If you would like to make any changes to `entropy.fut`, you will have to re-compile `entropy.py` with `futhark pyopencl --library entropy.fut -o entropy.py` - see the `make futhark` target. The `--library` flag must be used. | ||
## Dependencies | ||
This package requires numpy, pyopencl, and an OpenCL platform to run. If you don't have an OpenCL platform and want to test your code, consider [oclgrind, pocl, or another pip-installable CPU runtime for OpenCL](https://documen.tician.de/pyopencl/misc.html#enabling-access-to-cpus-and-gpus-via-py-opencl). oclgrind is installed by default by requirements-test to run tests. The Futhark compiler is not required, see "Futhark Compilation." | ||
|
||
## Testing | ||
This package maintains 100% test coverage of functions. See `ofrak_gpu_test`. |
Binary file not shown.
Oops, something went wrong.