Gem5模拟器学习之旅

安装gem5 模拟器

翻译自官网（https://www.gem5.org/documentation/learning_gem5/part1/building/）

支持的操作系统和环境

gem5的设计考虑到了Linux环境。我们定期在 Ubuntu 18.04、Ubuntu 20.04 和 Ubuntu 22.04 上进行测试，以确保 gem5 在这些环境中运行良好。不过，如果安装了正确的依赖项，任何基于Linux的操作系统都能正常运行。我们确保 gem5 可使用 gcc 和 clang 进行编译（有关编译器版本信息，请参阅下面的 “依赖关系”）。
使用 clang 编译器编译时，Mac OS 在安装了所有其他依赖项后应能正常运行。不过，目前我们并未在 Mac OS 上正式测试我们的构建版本。因此，我们无法保证希望在Mac OS上编译和运行gem5的用户能获得与在基于Linux的系统上相同的稳定性。在gem5的后续版本中，我们希望通过改进测试来更有效地支持Mac OS。
从gem5 21.0开始，我们仅支持在Python 3.6以上版本中编译和运行gem5。 gem5 20.0是我们最后一个支持Python 2的gem5版本。
如果无法在合适的操作系统/环境中运行 gem5，我们提供了预先准备好的 Docker 镜像，可用于编译和运行 gem5。有关详细信息，请参阅下面的 Docker 部分。

依赖

• git : gem5 使用 git 进行版本控制。
• gcc：使用 gcc 对 gem5 进行编译。必须使用 >=7 版本。我们最多支持gcc 第 12 版。注意：可以使用 GCC 第 9 版，但官方不支持该版本，因为它会增加 gem5 对象文件的大小。
• Clang：也可使用 Clang。目前，我们支持 Clang 6 至 Clang 14（含）。
• SCons : gem5 使用 SCons 作为其构建环境。必须使用 SCons 3.0 或更高版本
• Python 3.6+ : gem5 依赖 Python 开发库。gem5 可在使用 Python 3.6+ 的环境中运行。
• protobuf 2.1+ （可选）： protobuf 库用于跟踪生成和回放。
• Boost（可选）： Boost 库是一套通用 C++ 库。如果希望使用 SystemC 实现，则必须依赖该库。

在 Ubuntu 22.04 启动(gem5 >= v21.1)

如果在 Ubuntu 22.04 或相关 Linux 发行版上编译 gem5，可以使用 APT 安装所有这些依赖项：

sudo apt install build-essential git m4 scons zlib1g zlib1g-dev \
    libprotobuf-dev protobuf-compiler libprotoc-dev libgoogle-perftools-dev \
    python3-dev libboost-all-dev pkg-config

Docker

对于正在努力建立环境以构建和运行 gem5 的用户，我们提供了以下 Docker 映像：

包含所有可选依赖项的Ubuntu 22.04：gcr.io/gem5-test/ubuntu-22.04_all-dependencies:v22-1（源Dockerfile）。

Ubuntu 22.04（包含最少依赖项）：gcr.io/gem5-test/ubuntu-22.04_min-dependencies:v22-1（源 Dockerfile）。

Ubuntu 20.04（包含所有可选依赖项）：gcr.io/gem5-test/ubuntu-20.04_all-dependencies:v22-1（源 Dockerfile）。

Ubuntu 18.04（包含所有可选依赖项）：gcr.io/gem5-test/ubuntu-18.04_all-dependencies:v22-1（源 Dockerfile）。

• 获得docker镜像

docker pull

例如，Ubuntu 20.04 包含所有可选的依赖项：

docker pull gcr.io/gem5-test/ubuntu-20.04_all-dependencies:v22-1

那么，要在这种环境中工作，我们建议使用以下方法：

docker run -u $UID:$GID --volume :/gem5 --rm -it

其中， 是文件系统中 gem5 的完整路径， 是拉取的映像（例如，gcr.io/gem5-test/ubuntu-22.04_all-dependencies:v22-1）。

在此环境下，你将能在 /gem5 目录中构建并运行 gem5。

获取代码

git clone https://github.com/gem5/gem5

用 SCons 构建

gem5 的构建系统基于 SCons，这是一个用 Python 实现的开源构建系统。有关 scons 的更多信息，请访问 http://www.scons.org。主 scons 文件名为 SConstruct，位于源代码树的根部。附加的 scons 文件被命名为 SConscript，遍布整个源代码树，通常靠近与之关联的文件。

在 gem5 目录的根目录中，gem5 可以使用 SCons 文件构建：

scons build/{ISA}/gem5.{variant} -j {cpus}

其中 {ISA} 是目标（客户）指令集架构，而 {variant} 则指定编译设置。在大多数情况下，opt 是一个很好的编译目标。-j标志是可选的，允许编译并行化，{cpus}指定线程数。在某些系统上，从头开始的单线程编译可能需要 2 个小时。因此，我们强烈建议尽可能分配更多线程。

有效的 ISA 有

• ARM
• NULL
• MIPS
• POWER
• RISC-V
• SPARC
• X86

有效的构建变量有

• debug 关闭优化。这将确保变量不会被优化掉，函数不会被意外内联，控制流不会以令人惊讶的方式运行。这使得该版本更容易在 gdb等工具中使用，但如果不进行优化，该版本会比其他版本慢很多。在使用 gdb 和 valgrind等工具且不希望任何细节被掩盖的情况下，应选择该版本，但在其他情况下，建议使用更优化的版本。
• opt 开启了优化，但保留了断言和DPRINTF 等调试功能。这样既能保证仿真速度，又能在出错时洞察发生了什么。在大多数情况下，该版本是最佳选择。
• fast 打开了优化，并编译了调试功能。该版本在性能上全面提升，但却牺牲了运行时的错误检查和调试输出功能。如果你确信一切运行正常，并希望从模拟器中获得最高性能，建议使用该版本。
  下表概述了这些版本。
  
  例如，使用 opt 在 4 个线程上构建 gem5，目标机型为 x86：

scons build/X86/gem5.opt -j 4

此外，用户还可使用 "gprof "和 "pperf "构建选项来启用剖析功能：

• gprof 允许 gem5 与 gprof 分析工具一起使用。可通过使用 --gprof 标志编译来启用它。例如，scons build/ARM/gem5.debug --gprof.
• pprof 允许 gem5 与 pprof 分析工具一起使用。可以通过使用 --pprof 标志编译来启用它。例如，scons build/X86/gem5.debug --pprof.

用法

编译完成后，可以使用

./build/{ISA}/gem5.{variant} [gem5 options] {simulation script} [script options]

使用 --help 标志运行将显示所有可用选项：

使用方法
=====
  gem5.opt [gem5 选项] script.py [脚本选项］

gem5 是受版权保护的软件；请使用 --copyright 选项了解详情。

选项
=======
--version 显示程序的版本号并退出
--help、-h 显示帮助信息并退出
--build-info, -B 显示构建信息
-copyright, -C 显示完整的版权信息
--readme, -R 显示自述文件
--outdir=DIR, -d DIR 将输出目录设置为 DIR [默认：m5out]
--redirect-stdout, -r 重定向 stdout（和 stderr，不含 -e）到文件
--redirect-stderr, -e 将 stderr 重定向到文件
--stdout-file=FILE-r重定向的文件名 [默认值：simout］
--stderr-file=FILE-e 重定向的文件名 [默认值：simerr］
--监听器模式={开,关,自动｝
                        端口（如 gdb）监听模式（auto： 如果
                        默认值：auto
--只接收回传连接
                        端口监听器只接受通过
                        环回设备上的连接
--交互式, -i 运行脚本后调用交互式解释器
                        脚本后调用交互式解释器
--pdb 在运行脚本前调用 python 调试器
--path=PATH[:PATH], -p PATH[:PATH]
                        调用
                        脚本
--quiet，-q 降低冗余度
--verbose, -v 增加冗长度

统计选项
------------------
--stats-file=FILE 设置统计输出文件 [默认：
                        stats.txt］
--stats-help 显示可用统计访问者的文档

配置选项
---------------------
--dump-config=FILE转储配置输出文件 [默认值：config.ini]
--json-config=FILE 创建配置的 JSON 输出 [默认值：
                        config.json] --dot-config=FILE
--dot-config=FILE创建配置的 DOT 和 pdf 输出文件
                        [默认值：config.dot］
--dot-dvfs-config=FILE 创建 DVFS 配置的 DOT 和 pdf 输出
                        [默认值：无］

调试选项
-----------------
--debug-break=TICK[,TICK]（调试断点
                        在 TICK(s)处创建断点（如果未连接调试器，则杀死进程
                        如果没有连接调试器，则会杀死进程）
--debug-help 打印调试标志帮助
--debug-flags=FLAG[,FLAG]（调试标记
                        设置调试输出的标志（-FLAG 关闭一个
                        标志）。
--debug-start=TICK在 TICK 开始调试输出
--debug-end=TICK在TICK处结束调试输出
--debug-file=FILE设置调试输出文件[默认：cout］
--debug-ignore=EXPR忽略 EXPR 模拟对象
--远程 gdb-port=REMOTE_GDB_PORT
                        远程 gdb 基本端口（设为 0 则禁止监听）

帮助选项
------------
--列出所有内置模拟对象及其参数和默认值。
                        值

EXTRAS scons 变量可用于在 gem5 中构建额外的源文件目录，方法是将其设置为以冒号分隔的额外目录路径列表。EXTRAS 是在 gem5 代码基础之上构建的一种便捷方法，不会将你的新源代码与上游源代码混淆。这样，你就可以独立于主代码库管理你的新代码。