Dockerfile improvements

[momvart]

Here's a list of changes that I think would improve the readability of the Dockerfile.

• We can omit this condition because it simply does nothing if there's no submodule. In addition, it is true for both cases of the proceeding statements. https://github.com/sfu-rsl/symrustc/blob/d7bfc86de417da8d1e7167081ed4cd20c6a97415/generated/Dockerfile#L81
• Hard-coded branch name can be replaced with an argument. https://github.com/sfu-rsl/symrustc/blob/d7bfc86de417da8d1e7167081ed4cd20c6a97415/generated/Dockerfile#L86
• I believe depending on tags would be better than branch names. It may help us not to create a new branch for each version and use the same convention for all repos. For example, the symcc repo uses main/<version> scheme while the llvm repo has a different scheme as well as tags. https://github.com/sfu-rsl/symrustc/blob/d7bfc86de417da8d1e7167081ed4cd20c6a97415/generated/Dockerfile#L93-L94
• A fork for LibAFL will make every component follow a similar pattern. https://github.com/sfu-rsl/symrustc/blob/d7bfc86de417da8d1e7167081ed4cd20c6a97415/generated/Dockerfile#L100
• We can merge builder_depend layer with builder_base or move it above builder_source
• Can't we use ~ in this case? Using $HOME is a little confusing as we have used ~ so far. https://github.com/sfu-rsl/symrustc/blob/d7bfc86de417da8d1e7167081ed4cd20c6a97415/generated/Dockerfile#L195
• Do we build anything in this layer? It seems to be just copying so can be merged with the previous layer. https://github.com/sfu-rsl/symrustc/blob/d7bfc86de417da8d1e7167081ed4cd20c6a97415/generated/Dockerfile#L233-L241
• Maybe we can merge this layer with the next one. https://github.com/sfu-rsl/symrustc/blob/d7bfc86de417da8d1e7167081ed4cd20c6a97415/generated/Dockerfile#L292

[tuong]

We can omit this condition because it simply does nothing if there's no submodule. In addition, it is true for both cases of the proceeding statements. https://github.com/sfu-rsl/symrustc/blob/d7bfc86de417da8d1e7167081ed4cd20c6a97415/generated/Dockerfile#L81

Most of the time, I run build_all.sh ( https://github.com/sfu-rsl/symrustc/blob/d7bfc86de417da8d1e7167081ed4cd20c6a97415/build_all.sh ) to build everything. However there is also build_rustc.sh that can be used as an alternative ( https://github.com/sfu-rsl/symrustc/blob/d7bfc86de417da8d1e7167081ed4cd20c6a97415/build_rustc.sh ). The above condition is to detect in which situation we are running the build, in particular SYMRUSTC_RUST_VERSION is set to some specific value in the latter script, whereas it is not set in build_all.sh.

Can't we use ~ in this case? Using $HOME is a little confusing as we have used ~ so far. https://github.com/sfu-rsl/symrustc/blob/d7bfc86de417da8d1e7167081ed4cd20c6a97415/generated/Dockerfile#L195

I would have wished also, but at the time of writing the current semantics of a Dockerfile is to not expand ~, at least inside a COPY command.

Do we build anything in this layer? It seems to be just copying so can be merged with the previous layer. https://github.com/sfu-rsl/symrustc/blob/d7bfc86de417da8d1e7167081ed4cd20c6a97415/generated/Dockerfile#L233-L241

Here I was separating the build process with content that might be less generic. In the future, belcarra_source/examples may not be provided as part of SymRustC...

[tuong]

At the time of writing, here is the organization of branches:

• We have a list of "stable" branches, they are all listed in git_rebase_versions.sh: https://github.com/sfu-rsl/symrustc/blob/7b71d052d8daefe2e3263ec716e3a72167552016/git_rebase_versions.sh#L50-L81

In addition, branches starting with no_insert/ and appended with an element of $versions1 are also stable.

• The main branch is a bit special, it contains the documentation. It is currently updated by hand.

• Any other branches not mentioned above are temporary, they may disappear at some point.

[tuong]

Some notes regarding the workflow:

• Until now, important modifications of code are principally made in 1.46.0, and the script git_rebase_versions.sh is run afterwards to automatically propagate everything.
• Whenever a new branch is created, we use make_build.sh ( https://github.com/sfu-rsl/symrustc/blob/7b71d052d8daefe2e3263ec716e3a72167552016/make_build.sh ) to initialize the appropriate build scripts for build_all.sh to correctly work (as the associated Dockerfile relies at some point on the branch name to clone the respective version of SymRustC).