3 Installing Simics

This section describes the deprecated way to install Simics, for users who are not yet using the Intel Simics Package Manager.

3.1 Linux

Simics is delivered in packages, each one containing different parts of the functionality. There is a base package and several add-on packages. The packages can be combined to create a customized installation. The most common packages are:

• The Simics Base package contains Simics — the Simics execution engine and the user interface, as well as a library of standard models.
• The Simics Express package contains Simics Express — a Simics execution engine and a library of standard models but with limited user interface and just a sub-set of features. Some sections of this guide do not apply to Simics Express.
• An add-on package for each virtual platform, usually containing a CPU core and various devices. The virtual platform is the simulation platform and the model of the physical target hardware that is being simulated.
• The Quick-Start Platform for x86 (QSP-x86) add-on package is meant for training, application development, demos, etc.

The installation process is described in the following chapters. This is a quick overview of the steps involved.

1. Download the base package and the add-on packages you will use.
2. Install the packages, using the corresponding decryption key.
3. Create a project, to store the files you are working on.

Add-on packages are not installed on top of the main Simics installation. Instead each package stays in its own directory, and Simics is simply instructed to look for add-on packages in various places using the addon-manager program

When installing Simics in a shared environment, several options are provided for multi-user installations. Refer to chapter 5 for a complete description.

3.1.1 First Installation

As a Simics customer, you should have received instructions that describes which packages you should download and where to find them. If this is not the case, contact your Simics provider to obtain this information.

1. Start by downloading the packages you want to install. We will use package 1000 (Simics Base package) and package 2096 (QSP-x86 model library) as an example.

   joe@computer$ cd simics-download
   joe@computer$ ls
   simics-pkg-1000-6.0.0-linux64.tar
   simics-pkg-2096-6.0.0-linux64.tar
   

   The packages are .tar files that can be unpacked with the tar command. Unpacking the packages will create a simics-6-install directory with the relevant installation files:

   joe@computer$ tar xf simics-pkg-1000-6.0.0-linux64.tar
   joe@computer$ tar xf simics-pkg-2096-6.0.0-linux64.tar
   joe@computer$ ls simics-6-install
   aescrypt
   install_simics_common.pm
   install-simics.pl*
   package-1000-6.0.0-linux64.packageinfo.aes
   package-1000-6.0.0-linux64.tar.gz.aes
   package-2096-6.0.0-linux64.packageinfo.aes
   package-2096-6.0.0-linux64.tar.gz.aes
   installation-guide.pdf
   old/package-1000-6.0.0-linux64.packageinfo.aes
   old/package-1000-6.0.0-linux64.tar.gz.aes
   old/package-2096-6.0.0-linux64.packageinfo.aes
   old/package-2096-6.0.0-linux64.tar.gz.aes
   

   The file installation-guide.pdf is a copy of this manual. The tar.gz.aes files contains the compressed and encrypted package contents to be installed. The installation script install-simics.pl is used in the next step of the installation.

2. Run the installation script:

   joe@computer$ cd simics-6-install
   joe@computer$ ./install-simics.pl
   

   Note: The script must be run from the installation directory.
3. The script will present a list of packages to install. Simply type the number listed in front of each package you wish to install. In the example we install all packages (Simics Base and QSP-x86):

   install-simics can install the following packages:
      Number  Name          Type    Version   Host         Package
       1      Simics-Base   simics  6.0.0     linux64      package-1000
       2      QSP-x86    	 addon   6.0.0     linux64      package-2096
       3      All packages
   
   Please enter the numbers of the packages you want to install, as in "1 4 3"
   Package numbers, or Enter to [Abort]: 3

4. You will be asked for a destination directory. The default is /opt/simics/simics-6. In the example session below, we will accept the default:

   Enter a destination directory for installation, or Enter
   for [/opt/simics/simics-6/]: <ENTER>
   The directory '/opt/simics/simics-6/' does not exist.
   Do you want to create it? (y, n) [y]: <ENTER>

5. The script will show you a summary of the installation options before proceeding. If you accept, the installation will be performed:

   The following packages will be installed in /opt/simics/simics-6/:
      Simics-Base 6.0.0 (package-1000-6.0.0-linux64.tar.gz.aes)
      QSP-x86 6.0.0 (package-2096-6.0.0-linux64.tar.gz.aes)
   
   Do you wish to perform the installation? (y, n) [y]: <ENTER>
   -> Decrypting package-1000-6.0.0-linux64.tar.gz.aes
   -> Testing package-1000-6.0.0-linux64.tar.gz
   -> Installing package-1000-6.0.0-linux64.tar.gz
   -> Decrypting package-2096-6.0.0-linux64.tar.gz.aes
   -> Testing package-2096-6.0.0-linux64.tar.gz
   -> Installing package-2096-6.0.0-linux64.tar.gz
   

   If everything was successful, you now have two directories in /opt/simics/simics-6/ called simics-6.0.0 and simics-QSP-x86-6.0.0.

   Note: The /opt/simics/simics-6/simics-6.0.0 directory in the example above is the directory referred to by the [simics] abbreviation in examples in the rest of the Simics documentation.
6. The installer will help you finish the configuration of the packages you installed. The default choice, to configure the QSP-x86 add-on with the newly installed Simics Base package, is exactly what we want:

   install-simics has installed the following add-on packages:
      QSP-x86  6.0.0  /opt/simics/simics-6/simics-QSP-x86-6.0.0
   
   Do you wish to make these add-on packages available in
   Simics-Base 6.0.0? (y, n) [y]: <ENTER>
   -> Making add-on packages available in Simics-Base 6.0.0

7. The installer will now summarize the installation and exit.

   Summary of installation process: 
      All selected packages were installed successfully 
   
   You may now want to see the 'Getting Started' guide. 

3.1.2 Obsolete installation flow

You may be redirected onto the "old" installation flow if you did not pass the authentication phase. Note, that this option is temporal and will become obsolete soon.

1. When the installation continues, you will be asked for the keys necessary to decrypt the packages. Keys are cached automatically once they have been found to be correct, so you should need to perform this step only once:

   -> Looking for Simics packages in current directory...
   Enter a decryption key for package-1000-6.0.0-linux64.tar.gz.aes,
   or Enter to [Abort]: 0123456789ABCDEF0123456789ABCDEF
   Enter a decryption key for package-2096-6.0.0-linux64.tar.gz.aes,
   or Enter to [Abort]: 0123456789ABCDEF0123456789ABCDEF

   Note: These are not the actual keys.
2. The script will present a list of packages to install. Simply type the number listed in front of each package you wish to install. In the example we install all packages (Simics Base and QSP-x86):

   install-simics can install the following packages:
      Number  Name          Type    Version   Host         Package
       1      Simics-Base   simics  6.0.0     linux64      package-1000
       2      QSP-x86    	 addon   6.0.0     linux64      package-2096
       3      All packages
   
   Please enter the numbers of the packages you want to install, as in "1 4 3"
   Package numbers, or Enter to [Abort]: 3

3. You will be asked for a destination directory. The default is /opt/simics/simics-6. In the example session below, we will accept the default:

   Enter a destination directory for installation, or Enter
   for [/opt/simics/simics-6/]: <ENTER>
   The directory '/opt/simics/simics-6/' does not exist.
   Do you want to create it? (y, n) [y]: <ENTER>

4. The script will show you a summary of the installation options before proceeding. If you accept, the installation will be performed:

   The following packages will be installed in /opt/simics/simics-6/:
      Simics-Base 6.0.0 (package-1000-6.0.0-linux64.tar.gz.aes)
                   with key 0123456789ABCDEF0123456789ABCDEF
      QSP-x86 6.0.0 (package-2096-6.0.0-linux64.tar.gz.aes)
                   with key 0123456789ABCDEF0123456789ABCDEF
   
   Do you wish to perform the installation? (y, n) [y]: <ENTER>
   -> Decrypting package-1000-6.0.0-linux64.tar.gz.aes
   -> Testing package-1000-6.0.0-linux64.tar.gz
   -> Installing package-1000-6.0.0-linux64.tar.gz
   -> Installed source code for Simics-Base
   -> Decrypting package-2096-6.0.0-linux64.tar.gz.aes
   -> Testing package-2096-6.0.0-linux64.tar.gz
   -> Installing package-2096-6.0.0-linux64.tar.gz
   -> Installed source code for QSP-x86
   

   If everything was successful, you now have two directories in /opt/simics/simics-6/ called simics-6.0.0 and simics-QSP-x86-6.0.0.

   Note: The /opt/simics/simics-6/simics-6.0.0 directory in the example above is the directory referred to by the [simics] abbreviation in examples in the rest of the Simics documentation.
5. The installer will help you finish the configuration of the packages you installed. The default choice, to configure the QSP-x86 add-on with the newly installed Simics Base package, is exactly what we want:

   install-simics has installed the following add-on packages:
      QSP-x86  6.0.0  /opt/simics/simics-6/simics-QSP-x86-6.0.0
   
   Do you wish to make these add-on packages available in
   Simics-Base 6.0.0? (y, n) [y]: <ENTER>
   -> Making add-on packages available in Simics-Base 6.0.0

6. The installer will now summarize the installation and exit.

   Summary of installation process: 
      All selected packages were installed successfully 
   
   You may now want to see the 'Getting Started' guide. 

3.1.3 Start Simics

To get started, run the Simics GUI and set up a project.

If you are new to Simics, you will find more information if you open the Getting Started document and follow the tutorial. You will find it in the doc/ directory of your Simics installation or in the Simics on-line help.

3.1.3.1 Simics Interface

• Run the Classic Simics GUI, with the following command:

  joe@computer$ /opt/simics/simics-6/simics-6.0.0/bin/simics-gui
  

3.1.3.2 Projects

The first time you run Simics you will be prompted for a project. For more details regarding projects, see the document Getting Started.

• You will be asked to select an empty directory where Simics can create a project. The project is used to create and edit scripts and keep the files you are working on, without touching any files of the installed packages.
  Choose a project name and click OK. See figure 1
  

  Figure 1. Select Project

• Click Yes when asked to create a new project directory.
• The installation is now finished and Simics will start.
Note: Once a project is created, start Simics from the project directory.

3.1.4 Reinstall Simics Base

If this is not the first time you install Simics Base you are provided with the option to copy the configuration of an earlier Simics installation.

install-simics can re-use the existing configuration
of the following Simics installation:
   Number  Name         Version  Path
    1      Simics-Base  6.0.0    /opt/simics/simics-6/simics-6.0.0
    2      None

Please choose an option [default to 1]: ENTER

3.1.5 Installing More Packages

You can install more packages at any time using the same steps as in chapter 3.1.1. It is easiest to install all packages in the same directory e.g. /opt/simics/simics-6.

The installer will propose a default configuration that should always work with the latest installed version of Simics. For customized configurations, please read the Add-on Manager, chapter 5.

3.1.6 Uninstalling Simics

Uninstalling Simics is very simple, just remove the directories that were created for each package during the installation. Note the following:

• If you delete an add-on package that is still referenced in the add-on packages list of a Simics installation, the add-on package will simply be considered invalid and ignored. The project-setup program will however suggest that you update projects that were using that add-on package.
• If you delete a Simics installation, you will need to reconfigure the projects that depended on it by running the project-setup program from another Simics installation.

3.1.7 Installing VMP

VMP uses direct execution to simulate x86 systems at near native speed. Kernel modules are needed to communicate directly with the host hardware, and installing those kernel modules requires a separate step.

Installing and managing VMP kernel modules requires sudo privileges. Installing will compile the kernel module and therefore also requires an environment to build kernel modules. Which packages you need for building kernel modules depend on the distribution of Linux that you are using, but at least for certain Red Hat based distributions you would need gcc-c++, kernel-headers, and kernel-devel. Change directory to the Simics Base package and run:

joe@computer$ bin/vmp-kernel-install

The script will compile and persistently install the kernel modules that are used by VMP. It will echo what needs to be done, which involves running scripts in the vmxmon/scripts/ directory.

Disable VMP temporarily by running the bin/vmp-kernel-unload script, and enable VMP with the bin/vmp-kernel-load script. Permanently uninstall VMP from your host by running the bin/vmp-kernel-uninstall script.

If your installation is read-only, or you for some other reason want to have the built VMP artifacts outside of the installation, you can give a directory to the relevant VMP scripts, example:

joe@computer$ bin/vmp-kernel-install /somewhere/directory
joe@computer$ bin/vmp-kernel-load /somewhere/directory

See the VMP section in the Simulation Performance chapter of the Simics User's Guide for information about enabling and using VMP.

3.2 Windows

Simics is delivered in packages, each one containing different parts of the functionality. There is a base package and several add-on packages. The packages can be combined to create a customized installation. The most common packages are:

• The Simics Base package contains Simics — the Simics execution engine and the user interface, as well as a library of standard models.
• The Simics Express package contains Simics Express — a Simics execution engine and a library of standard models but with limited user interface and just a sub-set of features. Some sections of this guide do not apply to Simics Express.
• An add-on package for each virtual platform, usually containing a CPU core and various devices. The virtual platform is the simulation platform and the model of the physical target hardware that is being simulated.
• The Quick-Start Platform for x86 (QSP-x86) add-on package is meant for training, application development, demos, etc.

• If you plan to create new models in Simics, you will need the MinGW tools to compile your models. See section 5.3.

The installation process is described in the following chapters. This is a quick overview of the steps involved.

1. Download the base package and the add-on packages you will use.
2. Install the packages, using the corresponding decryption key.
3. Create a project, to store the files you are working on.

Add-on packages are not installed on top of the main Simics installation. Instead each package stays in its own directory, and Simics is simply instructed to look for add-on packages in various places using the addon-manager program

When installing Simics in a shared environment, several options are provided for multi-user installations. Refer to chapter 5 for a complete description.

3.2.1 First Installation

As a Simics customer, you should have received instructions that describes which packages you should download and where to find them. If this is not the case, contact your Simics provider to obtain this information.

1. Start by downloading the packages you want to install. We will use package 1000 (Simics Base package) and package 2096 (QSP-x86 model library) as an example. These packages are .exe installers.
2. Run the installer for package 1000. You will first need to provide a decryption key for the package.
3. When the installer is decrypted successfully, click Next to start the installation.
4. Choose an installation directory. The default directory is C:\Program Files\Simics\Simics 6\.
5. Install Simics Base. Click Install.
6. End the installation. Click Finish.
7. Package 1000 is now installed. Continue by installing the add-on package 2096, QSP-x86. The installation is similar to the Simics Base package:
   • Run the installer and enter the decryption key.
   • Choose an installation directory, or accept the suggested installation path.
   • Select an installation of Simics Base with which this add-on package will be registered. Press Next to continue.
     Note: If you choose "skip this step", you can later associate this add-on package with Simics by using the Add-on Manager, see chapter 5.
   • Click Install to begin the installation.
   • Click Finish to exit the installation.

3.2.2 Start Simics

To get started, run the Simics Classic UI and set up a project.

If you are new to Simics, you will find more information if you open the Getting Started document and follow the tutorial. You will find it under the Start Menu in your Simics installation or in the Simics on-line help.

• Start Simics Classic UI from the Start Menu.
• You will be asked to select an empty directory where Simics can create a project. The project is used to create and edit scripts and keep the files you are working on, without touching any files of the installed packages.
  Choose a project name and click OK.
• Click Yes when asked to create a new project directory.
• The installation is now finished and Simics will start.

3.2.3 Reinstall Simics Base

If this is not the first time you install Simics Base you are provided with the option to copy the configuration of an earlier Simics installation.

3.2.4 Installing More Packages

You can install more packages at any time using the same steps as in chapter 3.1.1. It is easiest to install all packages in the same directory e.g. /opt/simics/simics-6.

The installer will propose a default configuration that should always work with the latest installed version of Simics. For customized configurations, please read the Add-on Manager, chapter 5.

3.2.5 Uninstalling Simics

To uninstall Simics or its add-on packages, navigate to Start Menu → Control Panel → Programs and Features, select and right-click an entry and select Uninstall. Another option is to run the downloaded installation .exe file and eventually select Remove.

Note the following:

• If you delete an add-on package that is still referenced in the add-on packages list of a Simics installation, the add-on package will simply be considered invalid and ignored. The project-setup program will however suggest that you update projects that were using that add-on package.
• If you delete a Simics installation, you will need to reconfigure the projects that depended on it by running the project-setup program from another Simics installation.

3.2.6 Installing VMP

VMP uses direct execution to simulate x86 systems at near native speed. Kernel modules are needed to communicate directly with the host hardware, and installing those kernel modules requires a separate step.

The kernel module can be loaded and unloaded by running the bin\vmp-kernel-load.bat respective bin\vmp-kernel-unload.bat scripts as administrator. To do that, open a command shell as administrator and run:

bin\vmp-kernel-load.bat

Another way to perform the same action would be to right-click on vmp-kernel-load.bat and select run as administrator.

The /AUTO and /DEMAND options select the start option for the VMP service. With /AUTO (default), the service will be available after restart whereas with /DEMAND (which used to be the behavior before these flags were added) will mean that the service is only available until shutdown or reboot and then has to be manually loaded again if needed.

If the script fails, see the Windows event log for more information. The most common reason is that Intel® VT-x technology or the NX feature is not enabled in the BIOS. The kernel module will also fail to load if Windows is running with the Hyper-V feature enabled.

See the VMP section in the Simulation Performance chapter of the Simics User's Guide for information about enabling and using VMP.