# 安装 SOLA Toolkit

## 概述

SOLA Toolkit 是墨芯为计算卡提供的软件开发工具包，包含驱动、运行时库以及一系列工具，帮助开发和调试墨芯计算卡上的应用程序。本文介绍 SOLA Toolkit 的安装方法，以及在安装和卸载过程中需要注意的事项。

### 系统需求

SOLA 开发环境与主机开发环境紧密集成，包括主机编译器和 C 运行时库。下表列出了对 SOLA Toolkit 进行了充分验证的 Linux 发行版。在其他版本的 Linux 上，SOLA Toolkit 也可能运行，但功能无法保证。

| Linux 发行版                 | **架构** | **内核版本**        | **默认 GCC 版本**      | **GLIBC（GNU C Library）版本** |
| --------------------------- | -------- | ------------------ | ------------------------- | ------------------ |
| Ubuntu 18.04                | x86_64   | 4.15.0             | 7.5.0                     | 2.27               |
| Ubuntu 20.04                | x86_64   | 5.4.0              | 9.4.0                     | 2.31               |
| Ubuntu 22.04                | x86_64   | 6.5.0              | 11.4                      | 2.35               |
| Debian 10                   | x86_64   | 4.19.0             | 8.3.0                     | 2.28               |
| Debian 11                   | x86_64   | 5.10.0             | 10.2.1                    | 2.31               |
| RHEL 8.2/8.3                | x86_64   | 4.18.0             | 8.3.1                     | 2.28               |
| RHEL 8.6                    | x86_64   | 4.18.0             | 8.5.0                     | 2.28               |
| RHEL 9.0                    | x86_64   | 5.14.0             | 11.2.1                    | 2.34               |
| RHEL 9.3                    | x86_64   | 5.14.0             | 10.2.1                    | 2.34               |
| KylinOS V10                 | x86_64   | 4.19               | 7.3.0                     | 2.28               |
| AliOS 7.2                   | x86_64   | 5.10               | 9.2.1                     | 2.17               |
| Rocky Linux 9.3（Blue Onyx） | x86_64   | 5.14.0-362.8.1     | 11.5.0                    | 2.35               |
| openEuler                   | x86_64   | 5.10.0-240.0.0.139 | 10.3.1                    | 2.34               |

## 安装前操作

### 验证系统运行的 Linux 发行版及内核版本

推荐在验证的 Linux 发行版上运行 SOLA Toolkit。查看当前系统 Linux 发行版及其内核版本：

```Bash
hostnamectl
```

确保系统安装了对应版本的内核头文件和开发包：

````{tabs}

```{tab} Ubuntu/Debian
```bash
sudo apt-get install linux-headers-$(uname -r)
```

```{tab} RHEL/AliOS/KylinOS V10/Rocky Linux/openEuler
```bash
sudo dnf install kernel-devel-$(uname -r) kernel-headers-$(uname -r)
```

````

### 验证系统已安装 GCC

查看系统是否安装 GCC（GNU Compiler Collection）编译器，且版本 ≥ GCC 6.x。

```Bash
gcc --version
```

GCC 通常作为 Linux 操作系统的一部分随系统一起安装。如果显示错误信息，则需要从您的 Linux 发行版中安装开发工具，或者从网上获取 GCC 及其相关工具链的版本。

### 验证已安装的依赖软件

确保系统安装了以下依赖的软件：

````{tabs}

```{tab} Ubuntu/Debian
```bash
sudo apt-get install pciutils dkms libelf-dev kmod make tar
```

```{tab} RHEL/AliOS/KylinOS V10/Rocky Linux/openEuler
```bash
sudo dnf install pciutils dkms elfutils-libelf-devel kmod make tar
```

````

### 验证系统能正确识别墨芯计算卡

```Bash
lspci | grep 1f36
```

### 选择安装方式

SOLA Toolkit 提供两种不同的安装方式：

````{tabs}

```{tab} Runfile 安装（推荐）
该方式使用独立于 Linux 发行版的 Runfile 安装包，不依赖 Linux 发行版的本地包管理器，可以在多个 Linux 发行版上使用。
```
```{tab} 包管理器安装
该方式使用 Linux 发行版特定的安装包，依赖于 Linux 发行版的本地包管理器进行安装。安装包根据 Linux 发行版分为以下两种：
- Deb 安装包：适用于 Ubuntu 和 Debian。
- RPM 安装包：适用于 RHEL、AliOS、KylinOS V10、Rocky Linux 9.3 和 openEuler。
```
````

```{admonition} 须知
:class: note

Linux 发行版特定的安装包和独立的 Runfile 安装包底层实现是同源的，所以安装和卸载都会互相影响。如果同时使用了两种不同类型的安装包进行安装，在卸载时可能会影响 Linux 发行版的本地包管理器的使用，所以建议使用同一种类型的安装包。
```

## 安装 SOLA Toolkit

### Runfile 安装

使用独立的 Runfile 安装包安装 SOLA Toolkit，步骤如下：

1. 获取安装包。

   ```Bash
   wget https://moffett-oss-bucket.tos-cn-shanghai.volces.com/sola-toolkits/sola_3.13.0_x86_64.run
   ```

2. 安装 SOLA Toolkit。

   ```Bash
   sudo sh sola_3.13.0_x86_64.run --driver --accept
   ```

   其中：
   - `--driver`：表示同时安装 SOLA 驱动，建议添加该参数。
   - `--accept`：表示执行安装命令时同意最终用户许可协议，建议添加该参数。

   ```{admonition} 须知
   :class: note

   如果未添加 `--accept` 参数，您也可以在执行安装命令时阅读协议内容，并根据提示输入 `accept` 并按回车键确认后继续安装。
   ```

3. （可选）如果执行安装 SOLA Toolkit 的命令时未添加 `--driver` 参数，按照以下步骤手动安装 SOLA 驱动，以确保板卡功能正常运行。

   a. 进入 SOLA 驱动程序的目录。

   ```Bash
   cd /usr/local/sola/driver
   ```

   b. 安装 SOLA 驱动。

   ```Bash
   sudo sh setup.sh
   ```

### 包管理器安装

使用 RPM 或 Deb 包进行安装时，会与 Linux 发行版的包管理器集成。

```{admonition} 须知
:class: note

使用 Deb 或 RPM 包安装时，默认您已同意最终用户许可协议（End User License Agreement，EULA）。EULA 详细内容请参见 [SOLA Toolkit 最终用户许可协议](../eula/SOLA_Toolkit_EULA.md)。
```

1. 获取安装包。

   ````{tabs}

   ```{tab} Ubuntu/Debian
   ```Bash
   wget https://moffett-oss-bucket.tos-cn-shanghai.volces.com/sola-toolkits/sola_3.13.0_amd64.deb
   ```

   ```{tab} RHEL/AliOS/KylinOS V10/Rocky Linux/openEuler
   ```Bash
   wget https://moffett-oss-bucket.tos-cn-shanghai.volces.com/sola-toolkits/sola-3.13.0-1.x86_64.rpm
   ```
   ````

2. 安装 SOLA Toolkit。

   ````{tabs}

   ```{tab} Ubuntu/Debian
   ```Bash
   sudo dpkg -i sola_3.13.0_amd64.deb
   ```

   ```{tab} RHEL/AliOS/KylinOS V10/Rocky Linux/openEuler
   ```Bash
   sudo rpm -U sola-3.13.0-1.x86_64.rpm
   ```
   ````

## 安装后验证操作（必须）

SOLA Toolkit 安装完成后，必须进行以下验证操作确保设备正常运行。

### 验证固件版本

```Bash
mx-smi select -f firmware_version
```

```{admonition} 注意
:class: caution

确保固件版本为 1.0.17。如版本不符，请参见 [mx-mft 用户手册](../tool/mx-mft-userguide.md)升级板载设备固件至最新版，否则可能影响功能使用。
```

### 验证 SOLA Toolkit 版本和板卡相关信息

```Bash
mx-smi
```

如果显示的 SOLA Toolkit 版本与安装的版本一致，则表示 SOLA toolkit 已成功安装。SOLA Toolkit 默认安装在 `/usr/local/sola-<version>` 路径下，并会自动创建一个指向该路径的软链接 `/usr/local/sola`。同时，以下可执行工具程序安装在 `/usr/bin` 目录下，供调试板卡使用。

| **可执行工具程序**     | **说明**               |
| --------------------- | ---------------------- |
| mx-smi                | 管理和监控设备的工具   |
| mx-qual               | 系统和设备质量检测工具 |
| mx-mft                | 设备固件管理工具       |
| mx-daemon             | 自动加载固件的守护进程 |
| sola-uninstall        | 卸载程序               |
| moffett-bug-report.sh | 日志收集工具           |

关于如何使用 `mx-smi`、`mx-qual`、`mx-mft`，请参见[设备管理工具用户手册](../tool/index.rst)。

## 卸载 SOLA Toolkit

卸载 SOLA Toolkit 会卸载与它相关的所有组件，包括驱动程序、工具和库。根据不同的安装方式选择卸载方式：

- Runfile

  ```bash
  sudo sola-uninstall --all
  ```

- 包管理器

  ````{tabs}

  ```{tab} Ubuntu/Debian
  ```bash
  sudo dpkg -r sola
  ```

  ```{tab} RHEL/AliOS/KylinOS V10/Rocky Linux/openEuler
  ```bash
  sudo rpm -e sola
  ```

  ````