[fud] Add save_temps option to Xilinx synthesis #851
Merged
Conversation
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
* 2 minutes turns out to be what it takes to crash in synthesis. 5 minutes is about what it takes to successfully produce an `xclbin`. * The fud invocation should use `-o` instead of `--to` because the output file is binary. (fud will crash when trying to decode it to a printable string.)
sampsyo
force-pushed
the
xilinx-save-temps
branch
from
47a1cb4 to
b5b0090
Compare
|
Rebased and ready to look at! |
cgyurgyik
reviewed
Jan 5, 2022
fud/fud/stages/remote_context.py
Outdated
| @@ -120,18 +120,20 @@ def run_remote(client: SourceType.UnTyped, tmpdir: SourceType.String): | |||
|
|
|||
| run_remote(client, tmpdir) | |||
|
|
|||
| def _close(self, client, remote_tmpdir): | |||
| def _close(self, client, remote_tmpdir, keep=False): | |||
There was a problem hiding this comment.
Nit: prefer a more verbose name, e.g. keep_tmpdir or keep_remote_tmpdir.
There was a problem hiding this comment.
Sounds good; changed!
| client, | ||
| tmpdir, | ||
| "xclbin/kernel.xclbin", | ||
| keep=self.save_temps, | ||
| ) | ||
| else: |
There was a problem hiding this comment.
Super nit: else not really needed here, but understand some people like the symmetry.
| @@ -40,6 +40,8 @@ def __init__(self, config): | |||
| self.remote_exec = RemoteExecution(self) | |||
| self.temp_location = self.config["stages", self.name, "temp_location"] | |||
|
|
|||
| self.save_temps = bool(self.config["stages", self.name, "save_temps"]) | |||
There was a problem hiding this comment.
Maybe a comment explaining why this is added would prove useful for future readers. It wasn't obvious to me until I read your PR description.
There was a problem hiding this comment.
Good call; added a short comment.
|
LGTM! Chris's nits are a superset of mine so address and merge! |
|
Thanks, y'all! Merging now. |
sampsyo
added a commit
that referenced
this pull request
Jan 5, 2022
sampsyo
added a commit
that referenced
this pull request
Jan 6, 2022
* Start refactoring generic sandbox utility LocalSandbox is a new alternative to RemoteExecution for running commands locally. It's not a drop-in replacement (maybe that should come in the future), but it offers morally equivalent functionality. * Fix some configuration stuff * Improve an error message I don't know why "provide an input file" was suggested, so I took that out. Also, properly interpolate the variable into the example flag. * Document what we know so far * Black formatting * Simplify emulation command execution And also make them work locally, with a utility. * Avoid some hard-coding * Document wdb stage configuration * Fix for name change from #851
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change builds on #850 (and depends on it, which is why this is a draft for now and is not worth reviewing until that's merged).
It's a pretty small additional feature: it adds support for the
save_tempsconfig option in the Xilinx bitstream compilation stage, which is calledxclbin. This option works in both SSH and local mode, and it just keeps around the temporary directory that would otherwise be deleted at the end of the fud execution. This should make it super easy to check things out manually when something goes wrong.I added a simple utility class,
FreshDir, that creates a new empty directory in cwd. I hope this will be useful for other vendor-toolchain-related fud stages that need sandbox directories.There is new documentation in the
synthesis.mdchapter for how to use the new flag.