How to compile with Ubuntu in Docker

1. Overview

Docker is useful for the easy setup of the compile environment for S2E.
Both Windows and Mac users can use the same environment and get the same result by using the docker container.
We selected Ubuntu as an OS in the docker image and GCC/G++ as a compiler for S2E.
Note: We currently use a 32bit compiler for S2E since flight S/Ws are usually executed on a 32bit microcomputers.
We recommend using Visual Studio Code as an editor for the environment.
This document explains a setup sequence of the docker environment for S2E.
Note: For a detailed explanation of Docker and VSCode's Extensions, please see the latest and official information.

Install the coreutils to use the realpath command in setup_docker.sh
- Use the brew install coreutils command when you have Homebrew

Create a work directory as a working directory.
Clone s2e-core in the work directory.
Add the work directory in the file sharing directory of Docker.
- Note: This setting does not exist in the latest Docker and WSL2 environments in Windows, so it is not necessary.

Launch git bash (for windows users) or terminal (for Mac users)
Move /s2e-core/scripts/Docker_Ubuntu directory
Edit Dockerfile or setup_docker.sh when you want to change the directory name, the user name of the container, and other settings.
Execute ./setup_docker.sh build to make images
Check created images (issl (and ubuntu))
- command: docker images
Execute ./setup_docker.sh run_core to make the container
Check created container (issl:latest)
- command: docker ps -a
Check the dashboard of Docker as follows.

Launch VS Code and open a new window.
Click the Remote Explorer icon on the left side.
- Note: the icon looks like a monitor
Click the gear icon of SSH TARGETS and select the config file you want to edit
- Default: C:\Users\UserName\ssh\config or User/UserName/ssh/config

Edit the config file as follows

Host issl-1
  HostName localhost
  User s2e
  Port 2222

Save the config file and check a new SSH target issl-1 is made in the explorer
Click Connect to Host in New Window icon on right side of issl-1
Enter the password s2e when required
See left bottom icon SSH:issl-1 to confirm the connection
Open the work directory in the container by using Open folder

Note : This sequence was integrated within the docker build process, so this is currently unnecessary.

S2E has several script files to get external libraries.
For this ubuntu/docker platform, users should use script files in scripts/Common directory and scripts/Docker_Ubuntu directory.
Users can execute most of the script files with git bash or terminal in the outside of the container, but users should execute scripts/Common/download_nrlmsise00_src_and_table.sh inside the container to use the same compiler.
Click Terminal > New terminal in the menu bar of VS Code.
Select bash terminal at the bottom window.
Execute ./s2e-core/scripts/Common/download_nrlmsise00_src_and_table.sh.
See ExtLibraries to confirm the NRLMSISE library is generated.

Edit setting of CMake Tools in issl-1

Cmake Build Directory: ${workspaceFolder}/s2e-core/build/Debug

After CMake and CMake Tools are installed, VS Code requires you to configure the building environment with CMakeList.txt. Please select yes. However, there is no CMakeList.txt file in the work directory, and VS Code requires you to locate CMakeList.txt, so please select the CMakeList.txt file in s2e-core directory.
- This setting is written in .vscode/settings.json
- You can directly edit the settings.json as follows
```
{
  "cmake.sourceDirectory": "${workspaceFolder}/s2e-core",
  "cmake.buildDirectory": "${workspaceFolder}/s2e-core/build/Debug"
}
```
Select GCC 11.2.0 as a kit (compiler)
- Note: Users can also choose other GCC versions.
Select CMake [Debug] and check the configuration is successfully done.
Build S2E
- If you want to clean up, please use CMake: Clean command.
Move to build/Debug directory with Terminal in VS Code.
Execute ./S2E or click the run icon at the bottom.
Check the data/log directory to confirm log file output.

Select Run > Start Debugging in the menu bar.
Select C++(GDB/LLDB) debugger
- If C++(GDB/LLDB) is not shown, please open a CPP file and select Run > Start Debugging again.
- .vscode/launch.json will be created.

Edit as follows.

"program": "${workspaceFolder}/s2e-core/build/Debug/S2E",
"cwd": "${workspaceFolder}/s2e-core/build/Debug",