Imperas Installation and Getting Started Guide

This document explains how to install and get started with the
OVPsim simulator / models and the Imperas professional products
under Linux and Windows.

Imperas Software Limited

Imperas Buildings, North Weston,
Thame, Oxfordshire, OX9 2HA, UK
docs@imperas.com

Author: Imperas
Version: 2.0.0
Filename: Imperas_Installation_and_Getting_Started.doc
Project: Imperas / Open Virtual Platforms Installation and Getting Started
Last Saved: Wednesday, 23 March 2016
Keywords: Installation, Getting Started, Linux, Windows, Licensing

2016 Imperas Software Limited www.imperas.com/www.OVPWorld.org

 Imperas Installation and Getting Started Guide

Copyright Notice
Copyright 2016 Imperas Software Limited All rights reserved. This software and
documentation contain information that is the property of Imperas Software Limited. The
software and documentation are furnished under a license agreement and may be used or
copied only in accordance with the terms of the license agreement. No part of the
software and documentation may be reproduced, transmitted, or translated, in any form or
by any means, electronic, mechanical, manual, optical, or otherwise, without prior written
permission of Imperas Software Limited, or as expressly provided by the license
agreement.

Right to Copy Documentation

The license agreement with Imperas permits licensee to make copies of the
documentation for its internal use only. Each copy shall include all copyrights,
trademarks, service marks, and proprietary rights notices, if any.

Destination Control Statement

All technical data contained in this publication is subject to the export control laws of the
United States of America. Disclosure to nationals of other countries contrary to United
States law is prohibited. It is the readers responsibility to determine the applicable
regulations and to comply with them.

Disclaimer
IMPERAS SOFTWARE LIMITED AND ITS LICENSORS MAKE NO WARRANTY
OF ANY KIND, EXPRESS OR IMPLIED, WITH REGARD TO THIS MATERIAL,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 2 of 92

.
 Imperas Installation and Getting Started Guide

Table of Contents

1 Preface......................................................................................................................... 7
2 Introduction................................................................................................................. 7
3 Hardware and Software Requirements ....................................................................... 8
3.1 Operating System................................................................................................ 8
3.2 Hardware............................................................................................................. 8
3.3 Host Compiler Versions...................................................................................... 8
4 Installation................................................................................................................... 9
4.1 Installation Packages........................................................................................... 9
4.1.1 OVPsim....................................................................................................... 9
4.1.2 Imperas Developer ...................................................................................... 9
4.1.3 Imperas Advanced Multicore Software Development Kit........................ 10
4.2 Download the Installation files ......................................................................... 10
4.2.1 Login ......................................................................................................... 10
4.2.2 Download the appropriate package........................................................... 10
4.3 Installing Under Linux...................................................................................... 11
4.3.1 Installing ................................................................................................... 11
4.3.2 Setting up the Linux Environment............................................................ 12
4.3.2.1 Setup Script........................................................................................... 12
4.3.2.1.1 32-bit Product on 64-bit Host ......................................................... 13
4.3.2.1.2 32-bit Compatibility libraries on 64-bit Host.................................. 13
4.3.2.2 Environment.......................................................................................... 13
4.3.2.3 Internet Access Via a Proxy Server ...................................................... 15
4.4 Installing Under Windows ................................................................................ 15
4.4.1 Installing ................................................................................................... 16
4.4.2 Setting up the Windows Environment ...................................................... 17
4.5 Setting up Licensing (Both Windows and Linux) ............................................ 19
4.5.1 Obtaining the computer hostname and Host Id......................................... 20
4.5.2 OVPsim FLEXlm License keys................................................................ 20
4.5.3 Imperas Licenses....................................................................................... 21
4.5.4 Using Floating Licenses............................................................................ 21
4.5.5 Using Node Locked License..................................................................... 22
4.5.6 License Queuing ....................................................................................... 22
5 Windows Development Environment....................................................................... 23
5.1 Introduction....................................................................................................... 23
5.2 MSYS / MinGW Environment ......................................................................... 23
5.2.1 Obtaining Latest MSYS............................................................................ 23
5.2.1.1 First, lets download............................................................................... 23
5.2.1.2 Download and Installation of MSYS.................................................... 24
5.2.2 Installation of MinGW 32-bit and 64-bit Toolchains ............................... 27
5.2.2.1 Adding MinGW to the PATH............................................................... 27
5.2.2.2 MinGW 'make' ...................................................................................... 28
5.2.2.3 Completion and test of MSYS/MinGW installation............................. 28
5.2.3 Checking Imperas tools and OVPsim Installation .................................... 32

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 3 of 92

.
 Imperas Installation and Getting Started Guide

5.3 Using a Cygwin Environment........................................................................... 34

5.3.1 Use MINGW GNU Toolset ...................................................................... 34
5.3.2 Verify use of MINGW GNU Toolset ....................................................... 34
5.3.3 Cannot Build OVPsim Examples.............................................................. 35
5.4 Building Virtual platforms with Microsoft MSVC........................................... 36
5.4.1 Running the Example................................................................................ 36
5.4.1.1 Compiling the CpuManager Platform................................................... 36
5.4.1.2 Creating an Application Executable ..................................................... 36
5.4.1.3 Running the Simulation ........................................................................ 37
6 Installing Additional Tools ....................................................................................... 38
6.1 Cross Compiler Toolchains............................................................................... 38
6.2 Peripheral Simulation Engine (PSE) Toolchain ............................................... 38
7 Getting Started .......................................................................................................... 40
7.1 Check Installation ............................................................................................. 40
7.1.1 OVPsim and Imperas Simulator Execution .............................................. 40
7.1.2 iGen Installation........................................................................................ 41
7.2 Cross Compiler and Host Toolchain................................................................. 42
7.2.1 Download OR1K Cross Compiler toolchain ............................................ 42
7.2.2 Install OR1K Cross Compiler toolchains ................................................. 42
7.2.3 Host toolchains.......................................................................................... 43
7.3 Hello World Example ....................................................................................... 43
7.3.1 Compiling an application.......................................................................... 43
7.3.2 Running the simulation using the ISS....................................................... 44
7.3.3 example.sh/.bat script................................................................................ 45
7.3.4 A first platform / module simulated using harness.exe............................. 45
7.3.5 Writing your own test harness .................................................................. 47
7.4 Semihosting Support......................................................................................... 48
7.4.1 In Imperas and OVP simulations .............................................................. 48
7.4.2 Replacing function and/or instruction behavior........................................ 48
7.4.3 Specific to a Cross Compiler and C Library............................................. 48
7.4.4 Used to terminate the simulation .............................................................. 49
7.4.5 Caution using with EPKs and non-baremetal platforms........................... 49
7.5 Simulation Time Statistics ................................................................................ 49
8 Understanding the operation of a code morphing simulator..................................... 52
8.1 Instruction Fetch ............................................................................................... 52
8.2 SystemC Interface Transaction Types .............................................................. 53
APPENDIX A Installation Packages, Products and Licensing Features....................... 54
A.1 Installation Packages......................................................................................... 54
A.1.1 Imperas_SDK package.................................................................................. 54
A.1.2 Imperas_DEV package ................................................................................. 54
A.1.3 OVPsim package........................................................................................... 55
A.2 License Features................................................................................................ 55
A.2.1 Executable Programs .................................................................................... 55
A.2.2 CpuManager Simulator and its Personalities................................................ 55
A.2.3 OVPsim Simulator ........................................................................................ 56
APPENDIX B Obtaining an Imperas License ............................................................. 57

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 4 of 92

.
 Imperas Installation and Getting Started Guide

APPENDIX C Accessing Imperas User Area.............................................................. 58

C.1 Initial Login at Imperas User ............................................................................ 58
C.2 Selecting Imperas Product download................................................................ 58
C.3 Logging into Download area ............................................................................ 59
C.4 Selecting Files................................................................................................... 59
APPENDIX D Setting Environment Variables ............................................................ 60
D.1 Opening System properties on Windows XP.................................................... 60
D.2 Opening System properties on Windows 7....................................................... 60
D.3 Modifying Environment Variables in Windows............................................... 62
APPENDIX E Additional FLEXlm Licensing Information ......................................... 63
E.1 Locating the license server software................................................................. 63
E.2 Types of Licenses ............................................................................................. 63
E.2.1 Uncounted Node-locked Licenses ........................................................... 63
E.2.2 Floating Licenses ..................................................................................... 64
E.3 Starting the License Server ............................................................................... 65
E.4 Configuring the Host Computer........................................................................ 66
E.5 Other License File Configurations.................................................................... 66
E.6 The daemon options file.................................................................................... 66
E.7 License Administration tools ............................................................................ 67
E.8 Configuring the License Server Manager as a Windows Service using
LMTOOLS.................................................................................................................... 68
APPENDIX F Some Common Problems ..................................................................... 71
F.1 Segmentation Fault when Native Debug of an OVP Platform ......................... 71
F.2 Simulator Reports Internal Abort (ASRT)........................................................ 71
F.3 Building on Windows using mingw32-make ................................................... 72
F.3.1 Error in Makefile.pse when building peripherals ........................................... 72
F.4 Licensing........................................................................................................... 73
F.4.1 feature not supported ...................................................................................... 73
F.4.2 cannot access date server ................................................................................ 74
F.5 Ethernet Adapter Naming/HostId is zero.......................................................... 75
F.5.1 How to change the default ens33 network device to old eth0................... 75
F.5.2 How to reorder or rename logical interface names in Linux .......................... 75
F.5.3 Based on the physical properties .................................................................... 76
F.5.3.1 Using the ifrename tool ........................................................................... 76
F.5.3.2 Using the ethtool and ip programs........................................................... 77
F.5.4 Based on the MAC address............................................................................. 77
F.5.4.1 Using udev rules ...................................................................................... 78
F.5.4.2 Using the interface configuration file ...................................................... 78
F.5.4.3 Using the get-mac-address.sh script ........................................................ 79
F.5.4.4 Using the nameif program ........................................................................ 79
F.5.5 Based on the driver .......................................................................................... 80
F.5.5.5 Red Hat ..................................................................................................... 81
F.5.5.1 Debian....................................................................................................... 81
F.5.6 Based on the physical location in the computer .............................................. 81
F.5.7 Ubuntu directly changing logical names ........................................................ 82
F.5.8 More Information............................................................................................. 82

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 5 of 92

.
 Imperas Installation and Getting Started Guide

F.6 Cannot run license server (lmgrd) on Ubuntu................................................... 83

APPENDIX G VLNV Library, Building Components and Makefiles ......................... 84
G.1 Introduction....................................................................................................... 84
G.2 Common Makefiles included in other Makefile ............................................... 84
G.2.1 $(IMPERAS_HOME)/bin/Makefile.include .................................................. 84
G.2.2 $(IMPERAS_HOME)/ImperasLib/buildutils/Makefile.common................... 85
G.3 Component Library Makefiles.......................................................................... 86
G.3.1 Building platforms : Makefile.harness............................................................ 86
G.3.1 Building platforms : Makefile.module............................................................ 86
G.3.2 Building peripheral behavioral code : Makefile.pse ....................................... 86
G.3.3 Building native host code : Makefile.host ...................................................... 86
G.3.1 Building platforms : Makefile.platform (deprecated) ..................................... 87
G.3.4 Building complete VLNV component library : Makefile.library ................... 87
G.3.5 SystemC TLM2 Platforms Makefile.TLM.platform....................................... 87
G.4 Selecting An Alternative Component Library .................................................. 88
G.5 CrossCompiler Makefile includes..................................................................... 88
APPENDIX H Abort Detected in Program ................................................................... 90
H.1 Obtaining Backtrace.......................................................................................... 91
H.2 Connecting a Debugger to a running simulation .............................................. 91

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 6 of 92

.
 Imperas Installation and Getting Started Guide

1 Preface
This document describes how to install the Imperas Professional products, Advanced
Multicore Software Development Kit (M*SDK) and Virtual Platform Development and
Simulation (C*DEV, S*DEV and M*DEV), and the Open Virtual Platforms OVPsim
simulator on both Windows and Linux computers. The installation includes tools,
models, documents and examples.

This document further introduces how to compile applications using the supplied
example GNU cross compiler toolchains/tool kits and how to use this binary with a
virtual platform.

Please see other documents that explain how to create platforms / harnesses, processor
models, and peripheral / behavioral models.

2 Introduction
This installation guide is for the installation of the OVP or Imperas Professional products
on a Linux or Windows host computer. We will need the installation files of either
OVPsim from www.OVPworld.org or the Imperas products from www.Imperas.com, and
at least one example compiler toolchain, also from www.OVPworld.org.

OVP is provided as a single installation package OVPsim.

Imperas products are provided as two installation packages Imperas_SDK for M*SDK
and Imperas_DEV for C*DEV, S*DEV and M*DEV (configured on installation or
post-install with configuration script).

In order to build native host executables and to cross compile applications under
Windows, we suggest the installation of an MSYS/MinGW 1 environment
www.mingw.org. See section 5 for instructions on setting up this environment. This will
make compilation of Applications, Models and Platforms / Simulation harnesses simple.

Part of the installation includes examples files and these will be used to illustrate the
processes and tools used to get your applications running on virtual simulation platforms.
In this document, we will use the openCores openRISC OR1K as the target embedded
processor.

1
It is also possible to use a Cygwin / MinGW environment but care must be taken to ensure that the
MINGW GNU toolset is used.

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 7 of 92

.
 Imperas Installation and Getting Started Guide

3 Hardware and Software Requirements

3.1 Operating System
These are the versions of the operating systems that are currently used by Imperas for
development and product verification; the product has been shown to operate correctly on
other operating systems.

Product Build Operating System

Linux 32-bit Fedora Core 12
Linux 64-bit 2 Fedora Core 18
Windows 32-bit Windows 7 64-bit 3 Professional with SP1
Windows 64-bit Windows 7 64-bit Professional with SP1

3.2 Hardware
The product is developed to work on x86 hardware.

Supported Processors: x86 32-bit and 64-bit

Disk space requirements 4 :

OVP or Imperas Installations: 140MB to 220MB
Toolchain Installations (each) : 60MB to 300MB

3.3 Host Compiler Versions

The following are the GCC compiler versions that are used by imperas for generation of
host code. The products are developed in such a way as to maintain, as far as possible,
backwards compatibility with previous compiler versions, in particular the GLIBC
versions.

Product Build GCC Compiler Version

Linux 32-bit 4.9.1 i686-nptl-linux-gnu (Crosstool-ng)
Linux 64-bit 4.9.1 x86_64-unknown-linux-gnu (Crosstool-ng)
Windows 32-bit 4.4.7 5 i686-unknown-mingw32
Windows 64-bit 4.9.1 x86_64-unknown-mingw32

2
This is only supported by the Imperas installations, Imperas_SDK and Imperas_DEV.
3
The Imperas 32-bit products are also supported in emulation mode on 64-bit hosts.
4
The disk space indicated is per package install or toolchain install. The actual disk space required is
dependent upon the type and number of packages or toolchains installed.
5
The Windows 32-bit ABI changed at release 4.6 which introduced incompatibilities in the Windows ABI.
The OVP products are compiled with the legacy ABI.

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 8 of 92

.
 Imperas Installation and Getting Started Guide

4 Installation
The Imperas professional products and the OVPsim simulator may be installed on a
Linux or Windows platform.

Section 4.1 provides specific information regarding the product packages. The details of
the package installations are the same and are shown for Linux users in section 4.3, and
Windows users in section 4.4.

Different major versions of the software should not be installed on top of each other. The
new installation should either be made into a different directory or the old version
uninstalled before the new version is added. For this reason you should avoid making
changes to files in the installation directories, as those changes will be lost when the
version is un-installed and a subsequent version is installed.
Different minor versions may be installed together; later minor versions typically provide
updates to products.

4.1 Installation Packages

4.1.1 OVPsim
The OVPsim simulation package, OVPsim, contains
1. the OVPsim reference simulator
2. the OVP model library
3. the Imperas iGen model template wizard (productivity tool)
4. examples and demonstrations

4.1.2 Imperas Developer

The Imperas Developer package, Imperas_DEV, contains
1. a professional version of the simulator that can be licensed for different
capabilities
a. Controller (C*DEV) : single processor / multi-core processor
b. Standard (S*DEV) : multiple processors / multi-core processors
(homogeneous processor vendor)
c. Multi (M*DEV) : multiple processors / multi-core processors
(heterogeneous processor vendors)
2. The Imperas Generation tool 'iGen' that increases productivity by simplifying and
automating the generation of C, C++, SystemC TLM2.0 platforms files,
peripheral and processor model templates

The Imperas Developer package once installed requires that the

IMPERAS_PERSONALITY is set to reflect the level of the product that has been
purchased. This is done during installation or after installation using the selectSimulator
script.

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 9 of 92

.
 Imperas Installation and Getting Started Guide

4.1.3 Imperas Advanced Multicore Software Development Kit

The Imperas SDK package, 'Imperas_SDK', contains
1. a professional version of the simulator that is licensed for capability
a. Multi : multiple processors or multi-core processors (heterogeneous
processor vendors)
2. The Imperas Generation tool 'iGen' that increases productivity by simplifying and
automating the generation of C, C++, SystemC TLM2.0 platforms files,
peripheral and processor model templates
3. The Imperas Verification, Analysis and Profiling (VAP) tools
4. The Imperas Interactive control and Multi-Processor Debugger (MPD)
5. The cpuGen processor model generator productivity tool

4.2 Download the Installation files

First you must download the installation files from either OVPworld.org or Imperas.com.

4.2.1 Login
The OVPworld download page can only be accessed when you are registered and logged
into the sites forums. Please register (can take up to 24 hours to receive authorization
email) and be logged in from the forums page before continuing.

Imperas customers should go to Imperas.com and select user login. This accepts the same
username and password as the OVPworld.org site. This will take you to the Imperas User
Home Page. Click on Imperas Product Downloads Imperas link (or Beta if you require an
updated pre-release version to download) and you will be requested to enter your Imperas
user name and password, which should have been provided to you by Imperas. The
imperas user area also provides 64-bit versions of the OVP packages via the OVP link.
See APPENDIX C Accessing Imperas User Area for additional information
accessing the Imperas User site and downloading packages.

4.2.2 Download the appropriate package

To download OVPsim after logging in to the OVPworld website go to the downloads
page http://www.ovpworld.org/download.php, look on the right hand side list and select
the appropriate link for the version you wish to download (Windows or Linux). This will
download the Windows or Linux installer executable for OVPsim.

To download the Imperas professional tools or the Imperas development tools after
logging into the Imperas Product Downloads area select the product you wish to
download (Windows or Linux).

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 10 of 92

.
 Imperas Installation and Getting Started Guide

4.3 Installing Under Linux

This section tells you how to install the Linux version of the products. Windows users
should refer to section 4.4.

The Linux versions are provided as pre-built binaries in a self extracting executable file,
either the
Imperas SDK as Imperas_SDK.<version>.<dot release>.Linux32 6 .exe
Imperas Developer as Imperas_DEV.<version >.<dot release>. Linux 32.exe
OVPsim as OVPsim.<version >.<dot release>. Linux 32.exe or
OVPsim. Linux32.exe (for current version from www.OVPworld.org)

4.3.1 Installing
Execute the self extracting executable file to install. You may need to change the installer
to be executable first:

> chmod +x Imperas_SDK.<major version>.<minor version>.Linux32.exe

The self extracting executable will install the files in the current directory or in a selected
directory:

Then execute the self extracting installer to extract the files:

> ./Imperas_SDK.<major version>.<minor version>.Linux32.exe

Or

> ./OVPsim.<major version>.<minor version>.Linux32.exe

You will be asked to accept a license agreement. It should be read and, if acceptable,
agreed to by typing yes at the prompt. For example:
Software License Agreement for Imperas Proprietary Software
Imperas Limited.
---------------------

<.. lines removed ..>

You are not allowed to use this software without a specific signed license
agreement.

Imperas_Software_License_Note (v.1.0)

Please indicate whether you accept the license agreement

yes/no >

6
This shows the release for a Linux 32-bit host, Linux 64-bit hosts are supported and available from
Imperas.

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 11 of 92

.
 Imperas Installation and Getting Started Guide

Once the license agreement has been accepted the Imperas tools or OVPsim you will be
prompted for the directory to install into:
Install into directory <current directory>/Imperas.<release major version>
yes/no >

If you reply yes, the installation will carry on into the current directory. If you reply no,
you will be prompted for a directory to install into:

Please provide an installation directory:

This will create <installDir>/Imperas.<release major version> (for example

/home/myaccount/Imperas.20130630), where <installDir> is the directory that is entered
at the prompt. Since the tools are installed in a directory tree whose root contains the
version, multiple versions may coexist side by side, or the old versions directory tree
may be deleted.

The Linux binary executables and shared objects are provided in the directory:
<installDir>/Imperas.<major version>/bin/Linux32

The model libraries are provided, as shared objects, in the directory:

<installDir>/Imperas.<major version>.<minor version>/lib/Linux32/ImperasLib
this will be referenced by the environment variable IMPERAS_VLNV.

4.3.2 Setting up the Linux Environment

4.3.2.1 Setup Script

A script is provided to install a function to setup the environment in which to run the
Imperas tools. The script is provided in the bin directory below the Imperas installation
directory. This script should be sourced in a bourne shell to provide the function
setupImperas, which is then executed passing the full path to the Imperas directory as the
argument.

> source <installDir>/Imperas.<major version>/bin/setup.sh

> setupImperas <installDir>/Imperas.<major version>

One of the environment variables set is IMPERAS_RUNTIME which is used to select the
simulator to be loaded, the normal settings are either CpuManager for the Imperas
Professional simulator or OVPsim for the OVP simulator.
This environment variable may be set prior to running this function. If not set the
setupImperas function will set the environment variable in accordance with the installed
files i.e. if the Imperas simulator, CpuManager, is available it will set the
IMPERAS_RUNTIME to CpuManager; if not found it will default to the OVPsim
simulator, OVPsim.

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 12 of 92

.
 Imperas Installation and Getting Started Guide

4.3.2.1.1 32-bit Product on 64-bit Host

The setup script also allows for the setup of a 32-bit product on a 64-bit host. This does
require that the 64-bit host includes 32-bit compatibility libraries.

Add the -m32 argument to the setupImperas function

> source <installDir>/Imperas.<major version>/bin/setup.sh

> setupImperas <installDir>/Imperas.<major version> -m32

4.3.2.1.2 32-bit Compatibility libraries on 64-bit Host

When running a 32-bit product on a 64-bit host or when using some of the OVP
toolchains, that are only provided as 32-bit executables in the 64-bit package files, you
will need to have 32-bit compatibility libraries on the 64-bit host machine.

To find out information about your specific host operating system and installing
compatibility libraries search the internet for "install 32 bit compatibility libraries linux".

If you are using Ubuntu try the following command line:

> sudo apt-get install lib32z1 lib32ncurses5 lib32bz2-1.0

If you are using Fedora try the following command line:

> sudo yum install zlib.i686

4.3.2.2 Environment

The following environment variables are used by the OVP simulator or Imperas
professional tools:

Required Environment Variables

IMPERAS_HOME Points to the root of the tools installation
IMPERAS_UNAME Is set to the Host OS type, Linux
IMPERAS_ARCH Is set to the Host architecture, Linux32
IMPERAS_SHRSUF Is set to the suffix for shared libraries, so
IMPERAS_VLNV Points to the root of the compiled library in the Imperas
installation
IMPERAS_RUNTIME Specifies which simulator, Imperas (CpuManager) or OVPsim, to
load at runtime
The PATH should include $IMPERAS_HOME/bin/$IMPERAS_ARCH

The LD_LIBRARY_PATH should include $IMPERAS_HOME/bin/$IMPERAS_ARCH and

$IMPERAS_HOME/lib/$IMPERAS_ARCH/External/lib

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 13 of 92

.
 Imperas Installation and Getting Started Guide

Additional Environment Variables

IMPERAS_PERSONALITY If this is set it can modify the features available from the Imperas
simulator runtime. This also modifies the license features that will
be required.
IMPERAS_ISS If this is set it will select the Imperas Instruction Set Simulation
executable version.

The following must be set manually, if required:

IMPERAS_PROXY_SERVER Only required for Demo and Web licenses, if the internet is
accessed through a proxy server, this should be set to the value
<hostname>:<port>, e.g. myproxyserver.com:3128

The following shows example commands to set these variables.

Create an environment variable IMPERAS_HOME pointing to the root of the Imperas tree, for
example:

> export IMPERAS_HOME=<installDir>/Imperas.20130630

Create an environment variable IMPERAS_ARCH for the current architecture, for example:

> export IMPERAS_ARCH=Linux32

Create an environment variable IMPERAS_SHRSUF for the current architecture, for example:

> export IMPERAS_SHRSUF=so

Create an environment variable IMPERAS_VLNV pointing to the root of the Imperas library,
for example:

> export IMPERAS_VLNV=$IMPERAS_HOME/lib/$IMPERAS_ARCH/ImperasLib

Create an environment variable IMPERAS_RUNTIME specifying which library to load at

runtime. If you have a license for the Imperas tools this should be:

> export IMPERAS_RUNTIME=CpuManager

If you have a license for OVPsim then this may be left unset (as this is the default value)
or set to:

> export IMPERAS_RUNTIME=OVPsim

Add the Imperas executables directory to the search path, for example:
> export PATH=${PATH}:$IMPERAS_HOME/bin/$IMPERAS_ARCH

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 14 of 92

.
 Imperas Installation and Getting Started Guide

Add Imperas shared library directories to the variable LD_LIBRARY_PATH, for example 7 :
> export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:$IMPERAS_HOME/bin/$IMPERAS_ARCH:\
$IMPERAS_HOME/lib/$IMPERAS_ARCH/External/lib

These commands should be added to a shell start up script, e.g. ~/.bashrc, or must be
executed some other way before the tools are used.

If you are installing one of the Developer products (C*DEV, S*DEV or M*DEV) from
Imperas you will need to setup the environment variable IMPERAS_PERSONALITY for the
correct type. This can be achieved by directly using the script
IMPERAS_HOME/bin/selectSimulator.sh.

Next, you must also set up licensing for the program. This is described for both Linux
and Windows installations in section 4.5.

4.3.2.3 Internet Access Via a Proxy Server

If you are using a Demo license downloaded from the OVP website, this will require web
access in order to run the simulator.
If this is the case and you use an Internet Proxy Server to access the web, you must set
the environment variable, IMPERAS_PROXY_SERVER, in order to enable access to the
internet.

For example if the Proxy Server is running on myproxyserver.com at port 3128

> export IMPERAS_PROXY_SERVER=http://myproxyserver.com:3128

A simple check to ensure this has worked correctly is as follows

> export IMPERAS_PROXY_SERVER=http://myproxyserver.com:3128

> http_proxy=${IMPERAS_PROXY_SERVER wget http://www.ovpworld.org

This should cause the index.html to download if all is successful

4.4 Installing Under Windows

This section tells you how to install the Windows version of the tools. Linux users should
refer to section 4.3.

The Windows versions are provided as executable installers, either the

Imperas SDK as Imperas_SDK.<version>.<dot release>.Windows32 8 .exe
Imperas Developer as Imperas_DEV.<version>.<dot release>.Windows32.exe
OVPsim as OVPsim.<version>.<dot release>. Windows32.exe or
OVPsim.Windows.exe (for current version from www.OVPworld.org)

7
This is all one command; note the use of the Linux line continuation character \ at the end of the first 2
lines
8
This shows the release for a Windows 32-bit host, other Windows hosts are supported by Imperas.

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 15 of 92

.
 Imperas Installation and Getting Started Guide

The installer, when executed, will extract the tools and setup the environment. Remember
to uninstall any existing versions before installing. An uninstall program, uninstall.exe
is provided in the root install directory (i.e. <installDir>\uninstall.exe, e.g.
C:\Imperas\uninstall.exe)

4.4.1 Installing
1. Execute the provided installer 2. Read and click through the license agreement

3. Choose the location for installation 4. Start the installation

5. When completed click Finish 6. Finally, read the notes for this release.

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 16 of 92

.
 Imperas Installation and Getting Started Guide

4.4.2 Setting up the Windows Environment

The following environment variables are automatically set by the installer:

Required Environment Variables

IMPERAS_HOME Points to the root of the installation
IMPERAS_VLNV Points to the compiled library
IMPERAS_UNAME Set to the Host OS Type, Windows
IMPERAS_ARCH Set to the Host architecture, Windows32
IMPERAS_SHRSUF Is set to the suffix for shared libraries, dll
IMPERAS_RUNTIME Specifies which simulator, Imperas (CpuManager) or OVPsim, to
load at runtime
PATH modified to include IMPERAS_HOME/bin/IMPERAS_ARCH

LD_LIBRARY_PATH modified to include IMPERAS_HOME/bin/IMPERAS_ARCH and

IMPERAS_HOME/lib/IMPERAS_ARCH/External/lib

Additional Environment Variables

IMPERAS_PERSONALITY If this is set it can modify the features available from the Imperas
simulator runtime. This also modifies the license features that will
be required.
IMPERAS_ISS If this is set it will select the Imperas Instruction Set Simulation
executable version.

The following must be set manually, if required:

IMPERAS_PROXY_SERVER Only required for Demo and Web licenses, this should be set to
the value <hostname>:<port>, e.g. myproxyserver.com:3128

The environment variable IMPERAS_RUNTIME may be set. If the Imperas tools are installed
then it will be set to CpuManager to select the Imperas simulator library to be loaded at

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 17 of 92

.
 Imperas Installation and Getting Started Guide

runtime. For OVPsim this variable will be set to OVPsim. It may be left unset and the
default value OVPsim will be used.

If you are installing one of the Developer products (C*DEV, S*DEV or M*DEV) from
Imperas you will be asked during installation which product that you have had licenses
provided for. This will set the environment variable IMPERAS_PERSONALITY for the correct
product personality. This can be also be achieved after installation by directly using the
script IMPERAS_HOME/bin/selectSimulator.bat or using the select product link provided on
the Program Start menu.

You must also set up licensing for the program. This is described for both Linux and
Windows installations in section 4.5. You may wish to install the preferred Windows
development environment, MSYS. This is described in section 5 Windows Development
Environment.

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 18 of 92

.
 Imperas Installation and Getting Started Guide

Environment variables on Windows XP can be modified by going to:

Start->Control Panel->System->Advanced->Environment Variables

Environment variables on Windows 7 can be modified by going to:

Start->Control Panel->System and Security->System->Advanced System Settings-

>Environment Variables

4.5 Setting up Licensing (Both Windows and Linux)

The OVP and Imperas products are licensed using FLEXlm. In order to execute the tools
you will need a license file. A license file is bound to an individual computer through that

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 19 of 92

.
 Imperas Installation and Getting Started Guide

computers host ID. To obtain a license file you must provide the host ID and host name
of one of your computers that will host the license.

NOTE
Running the Imperas license server within a virtual machine is not permitted.

4.5.1 Obtaining the computer hostname and Host Id

To determine the host ID of a computer use the lmhostid command of the lmutil utility
program (lmutil on Linux or lmutil.exe on Windows). If you have already gone through
the installation process then the lmutil utility will be in the directory
IMPERAS_HOME/bin/IMPERAS_ARCH which will already be on your executable path.

From a Linux shell or a Windows Command Prompt/MSYS window do the following:

> lmutil lmhostid

lmhostid - Copyright (c) 1989-2006 Macrovision Europe Ltd. and/or Macrovision
Corporation. All Rights Reserved.
The FLEXlm host ID of this machine is "002486571114"
>

NOTE
If the returned host ID is "000000000000" then this may be because you are using an OS
which uses Consistent Network Device Naming. Please see appendix F.5 for ways in
which this problem can be resolved. A license cannot be generated for a NULL host ID.

The host name of the computer can be obtained with the hostname command. From a
Linux shell or a Windows Command Prompt/MSYS window do the following:
> hostname
Workstation123
>

Floating licenses require that a license server is executed on a machine that will be used
to serve licenses to clients. The license server, lmgrd (lmgrd.exe on Windows) is
provided in the binary directory of an installation. See section

4.5.2 OVPsim FLEXlm License keys

OVPsim FLEXlm license keys may be requested directly from
http://www.ovpworld.org/licensekey.php by registered OVP users. Licenses for
commercial use may be obtained from Imperas.
OVPsim licenses are uncounted node-locked licenses and as such do not require a license
server or a license daemon.

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 20 of 92

.
 Imperas Installation and Getting Started Guide

iGen uses the same license as OVPsim.

OVPsim and iGen look, by default, for their license file in:

$IMPERAS_HOME/OVPsim.lic

If the license file is installed there then there is no need to do anything else. If it is
installed elsewhere then the IMPERASD_LICENSE_FILE environment variable 9 should be set
to point to it.

OVPsim license key files are to a specific version (release) of OVPsim/iGen, with a
license feature entry similar to that shown below.

FEATURE IMP_OVPSIM_20150205 imperasd 1.0 1-jul-2015 uncounted

HOSTID=... SIGN="...

You will need to obtain a new license file when you install a new version of the
simulator. Since it is tied to the release, it is OK to place it in the release directory.
License key files that are not tied to a specific release should not be placed in the install
directory, as that directory will be replaced when a new release is installed.

NOTE
When using an OVPsim license the simulator product will also require access to the
internet to allow checking for product updates. Without internet access an error will be
reported.

4.5.3 Imperas Licenses

The license to run the Imperas products (or OVPsim in some circumstances) is provided
as a floating license where one computer on the network is the license server and the
same or other computers on the network check out licenses from it.

The IMPERASD_LICENSE_FILE environment variable should be set to point to the license

server.

4.5.4 Using Floating Licenses

Licenses for the Imperas tools generally will require a license daemon to be running on a
license server.

9
For information on setting the environment variable on Windows please see appendix

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 21 of 92

.
 Imperas Installation and Getting Started Guide

The Imperas license daemon (imperasd) must be run on the license server using the
FLEXlm tools. The FLEXlm lmutil tool and the Imperas daemon are provided in the
$IMPERAS_HOME/bin/$IMPERAS_ARCH directory. The daemon can be started using the
following command on the license server:

On a Windows machine in an MSYS shell

> $IMPERAS_HOME/bin/$IMPERAS_ARCH/lmgrd.exe c license.lic l license.log

On a Linux machine in a shell

> $IMPERAS_HOME/bin/$IMPERAS_ARCH/lmgrd c license.lic l license.log

The license server can also be run on Windows using the LMTOOLS utility. Additional
information for getting a license daemon running on a license server can be found in
APPENDIX E, Additional FLEXlm Licensing Information.

Once you have your license server running, the computer from which the tools are run
needs the IMPERASD_LICENSE_FILE environment variable to be set to an @ followed by
the host name of the license server, for example:

IMPERASD_LICENSE_FILE=@serverhost

where serverhost is the host name of the license server. (See the respective installation
instructions for Windows and Linux for examples of how to set an environment variable.)
In this example we assume that the default port (27000-27009) is being used by the
license server. If the license server was set up to use a different port for some reason it
must be specified before the @, for example:

IMPERASD_LICENSE_FILE=27000@serverhost

Here, 27000 is the port number that the license server is using. Consult your license
administrator or see APPENDIX E, Additional FLEXlm Licensing Information, for more
information.

4.5.5 Using Node Locked License

A license may be for a single node locked machine and as such held in a local file. In this
case the same environment variable can be used but locates the file directly, for example
IMPERASD_LICENSE_FILE=/home/user/Imperas/Imperas.lic

4.5.6 License Queuing

The licensing software supports license queuing for server based license daemons, this
allows waiting for licenses becoming available which is useful for batch oriented
execution. In order to enable queuing, define the environment variable as shown
IMPERAS_QUEUE_LICENSE=1

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 22 of 92

.
 Imperas Installation and Getting Started Guide

5 Windows Development Environment

5.1 Introduction
The development of platforms, processor and peripheral models on the Windows
operating system has been validated in an environment using MSYS and MINGW. A
default build environment is provided with both the Imperas tools and OVPsim
installations that will allow models and platforms to be built in this environment.

Linux users should skip ahead to Section 6.

5.2 MSYS / MinGW Environment

The MSYS / MinGW environment is a shell and GNU toolchain to use under Windows.

This should be installed on a Windows 32-bit or a Windows 64-bit host machine.

It is recommended that the latest version of MSYS be obtained from the mingw website
and the MinGW cross compilers taken from the version saved to the OVP World website
resources page.

5.2.1 Obtaining Latest MSYS

5.2.1.1 First, lets download

MSYS is provided as part of the MinGW installation provided by http://www.mingw.org/
and available to download from http://sourceforge.net/projects/mingw/files/MinGW/

Click on the link, Download mingw-get-setup.exe (86.5 kB), after the text looking for the
latest version? to start the download of the installer.

This will download a small executable which we will then use to download and install the
MSYS installation.

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 23 of 92

.
 Imperas Installation and Getting Started Guide

5.2.1.2 Download and Installation of MSYS

Execute the program that you downloaded.

Select Run to execute the download and installation program

View the License and if acceptable, click Install

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 24 of 92

.
 Imperas Installation and Getting Started Guide

Select the options and installation root directory, click Continue.

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 25 of 92

.
 Imperas Installation and Getting Started Guide

The installer can install all of the MSYS and MinGW components, we want to install
only the MSYS Base System. Select the "Basic Setup" option and select 'msys-base' for
installation.

Under the Installation menu select 'Apply Changes'.

This will start the download and installation of the MSYS base system

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 26 of 92

.
 Imperas Installation and Getting Started Guide

When the installation has completed you will have a MinGW directory containing the
basic MSYS installation:

5.2.2 Installation of MinGW 32-bit and 64-bit Toolchains

In the previous section we installed the latest MSYS environment, next we need to install
the specific MinGW toolchains 10 . The version that has been verified with the
Imperas/OVP build system may be obtained from the OVP World website (problems
have been reported using later versions).

The files may be found on the OVPworld.org website under the Resources tab. There are
two zip files containing the 32-bit and 64-bit toolchains respectively.

mingw-w32-bin_i686-mingw_20111031_sezero.zip

mingw-w64-bin_i686-mingw_20111031_sezero.zip

Download the appropriate one for your host (32-bit or 64-bit) and we recommend
extracting into a directory, for example C:\MinGW_Toolchains, separate to the root of
the MSYS/MinGW installation in the previous section, C:\MinGW. This will create
mingw32 and mingw64 directories respectively.

5.2.2.1 Adding MinGW to the PATH

Select the Windows control panel and get to the advanced system setting and the
environment setting within it.

To the PATH variable add

1. The MSYS installation binary directory
C:\MinGW\msys\1.0\bin
2. The MinGW installation binary directory or directories.
C:\MinGW_Toolchains\mingw32\bin
C:\MinGW_Toolchains\mingw64\bin

10
These versions of the toolchains are used within Imperas and so are know to work with the provided
build environment.

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 27 of 92

.
 Imperas Installation and Getting Started Guide

5.2.2.2 MinGW 'make'

It is important that the correct version of make is used when using Makefiles in the
Windows build environment.

The Windows bat files supplied by Imperas all invoke 'mingw32-make'

In the MSYS shell it is possible to invoke make, using one of the shell scripts supplied by
Imperas in the Demo or Example directories or directly but this may not use the correct
version. By default the Cross Compiler toolchains provide 'gmake.exe' and ' mingw32-
make', they do not provide 'make.exe' so this is often either not found or the incorrect
version found.

We recommend copying 'gmake.exe' to 'make.exe' in the Cross Compiler binary

directories, for example in the directories C:\MinGW_Toolchains\mingw32\bin and
C:\MinGW_Toolchains \mingw64\bin

5.2.2.3 Completion and test of MSYS/MinGW installation

The installation process may have created a desktop shortcut

If not, create your own desktop shortcut by locating the msys.bat file in the installation at
C:\MinGW\msys\1.0\msys.bat and create a shortcut and move to your desktop.

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 28 of 92

.
 Imperas Installation and Getting Started Guide

Start the MinGW shell and then type ls and pwd in it to check all is ok and working.

If you already have an OVPsim or Imperas installed try env | grep IMP which should
show that the Imperas environment has been configured.

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 29 of 92

.
 Imperas Installation and Getting Started Guide

With any of the OVPsim, Imperas_SDK or Imperas_DEV packages installed and the
or1k.toolchain package installed you can try running the Example
Imperas/Examples/HelloWorld/usingICM that will ensure everything is available and
correctly installed.

In the following screen shot we show the execution of the example using the script
example.sh. Below we further describe each section separately

Build the application, setting CROSS to the Cross Compiler toolchain we are using. In
this case we set CROSS=OR1K to utilize the installed cross compiler toolchain for the
OR1K processor, OR1K.toolchain.

The command line to do this is make CROSS=OR1K clean all

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 30 of 92

.
 Imperas Installation and Getting Started Guide

In this next screenshot we attempt to build the platform using the supplied Makefile,
Makefile.platform (provided, with other standard Makefiles in
IMPERAS_HOME/ImperasLib/buildutils).

We specify that we will build locally and not use the VLNV library structure by setting
NOVLNV=1.

The command line used is

make -f ${IMPERAS_HOME}/ImperasLib/buildutils/Makefile.platform \
NOVLNV=1 clean all

As you can see the platform cannot be built because the host GCC (x86_64-mingw32-gcc
as we are running on a 64-Bit Windows 7 host machine) cannot be found. This is because
we have not setup the PATH environment variable.

We can setup the PATH environment variable in the shell. Below we show the addition
of the bin directory for the 64-bit Host GCC to the PATH.

export PATH=$PATH:/c/MinGW_Toolchains/mingw64/bin

We are now able to re-invoke the same make command and build the platform

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 31 of 92

.
 Imperas Installation and Getting Started Guide

We can now run the OVP virtual platform. the simulator loads the OVP Fast processor
model (and any other model or semihost libraries required), loads an application into
memory and uses the processor model to execute the binary code.

The command line to run the simulation is

platform.${IMPERAS_ARCH}.exe application.OR1K.elf or1k

11

5.2.3 Checking Imperas tools and OVPsim Installation

When the Imperas tools or OVPsim were installed, new environment variables would
have been created, and the PATH environment variable would have been updated to
include the bin directory of the installation.

We can check this by starting an Msys shell.

In the MSYS shell, type the following

$ env | grep IMPERAS

This should provide us with 4 environment variables shown here with their default values

IMPERAS_HOME=C:\Imperas
IMPERAS_UNAME=Windows
IMPERAS_ARCH=Windows32 12
IMPERAS_SHRSUF=dll
IMPERAS_RUNTIME=OVPsim

11
The execution time was extended from the application provided so that statistics would be reported fully.
12
This will be Windows64 if you are installing one of the Windows 64-bit products

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 32 of 92

.
 Imperas Installation and Getting Started Guide

IMPERAS_VLNV=C:\Imperas\lib\Windows32\ImperasLib

The IMPERAS_RUNTIME will be set to either OVPsim or CpuManager dependent

upon the installation of OVPsim or the Imperas tools respectively. The Imperas tool
installation includes an OVPsim installation; by changing this variable you can choose to
run using either of the simulators.

In addition, if we print the value of the PATH environment variable:-

$ echo $PATH

It should contain the following

/c/Imperas/bin/Windows32 13

If you installed, OVPsim or the Imperas tools, in a different directory to the default, then
these variables will be changed accordingly.

These environment variables are used by the Makefiles whilst compiling applications,
models and platforms / simulation harnesses for the OVP and Imperas tools.

IMPORTANT
We have observed that when other packages are installed in the MSYS environment the
msys.bat file used to start up the shell may be modified such that the PATH variable is
restricted to the MINGW and MSYS paths. If you find that the PATH environment
variable does not contain your full PATH, find the bat file executed from the msys link
and if MSYSTEM is set to MINGW32 please remove.

13
This will be Windows64 if you are installing one of the Windows 64-bit products

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 33 of 92

.
 Imperas Installation and Getting Started Guide

5.3 Using a Cygwin Environment

5.3.1 Use MINGW GNU Toolset

Although, the MSYS environment is recommended it is also possible to make use of the
Cygwin environment.

If an installation of cygwin is used as the environment it must be ensured that the

MINGW GNU tools are used during the build of any application or DLL.

Using the MINGW GNU toolset provides a native Windows executable.

Using the Cygwin GNU toolset generates executables and DLLs that will reference and
be reliant on the Cygwin DLLs. This will create executables and DLLs that are not
portable and therefore not compatible in other environments. There are compatibility
issues even between different versions of Cygwin.

5.3.2 Verify use of MINGW GNU Toolset

To verify that the correct environment is being used check the version of gcc that is found
on the path in a cygwin shell. The following illustrates that the incorrect version of gcc
would be used is from the Cygwin install.

We should modify the path so that the MINGW GNU tools appear before the Cygwin
tools.

We can see now that the GNU tools are being found from the MINGW installation before
the Cygwin.
Note that this installation of MINGW has been made under an MSYS installation.

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 34 of 92

.
 Imperas Installation and Getting Started Guide

Note that when creating Makefiles or scripts to build executables and DLLs it is often
useful to use MINGW specific names of the GNU tool executables. These appear in the
mingw/bin directory as, for example, mingw-gcc.exe. By doing this you will guarantee
that you do not inadvertently pick up the Cygwin tools. There are mingw-* named copies
of all the GNU tools.

5.3.3 Cannot Build OVPsim Examples

The Mingw gnu tools are native Windows tools and as such are not expecting Cygwin
path names.

There is a utility cygpath that will convert a Cygwin path into a native windows path.
This may be used to give the correct path for the MINGW GNU tools.

cygpath w $(pwd)

Unfortunately this cannot be used in conjunction with the Makefile system provided with
the OVPsim examples because the Windows native path contains a : which is a special
character when used in Makefiles!
The OVPsim examples are all verified for use in the MSYS environment.

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 35 of 92

.
 Imperas Installation and Getting Started Guide

5.4 Building Virtual platforms with Microsoft MSVC

The Microsoft Visual C++ environment may be used to build the virtual platform
executable for a Windows host.

An example is provided in the Platform Examples section to show the compilation of a

virtual platform using MSVC.

5.4.1 Running the Example

Take a copy of the example:

> cp r $IMPERAS_HOME/Examples/PlatformsICM/simple_MSVC_compile .

5.4.1.1 Compiling the CpuManager Platform

The test platform can be compiled to produce an executable,
platform.${IMPERAS_ARCH}.exe, using the MSVC environment.

To compile using MSVC the setup program must be invoked that is provided with MSVC
to start a shell with an appropriate environment. This is typically called a Visual Studio
2008 Command Prompt
A script in the platform directory, compile.msvc.bat, contains the following command
line that is used to build using nmake and the Makefile provided.

> nmake nologo s f nmakefile

Note that for completeness this example can also be built in a Linux shell or in a MinGW
shell on Windows by using the following command in the platform directory:

> make C platform

5.4.1.2 Creating an Application Executable

A test case must be created using the processor tool chain. Because the OR1K processor
is supported by Imperas tools and shipped as an example, there is already an encapsulated
tool chain that you can use to compile test cases for it.

Within the platform directory is a simple assembler test, application/asmtest.S,

which simply performs a few instructions and exits. The application can be compiled
using the following command in the platform directory:

> make C application

The result is an ELF format file for the OR1K called asmtest.OR1K.elf.

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 36 of 92

.
 Imperas Installation and Getting Started Guide

5.4.1.3 Running the Simulation

Having compiled the test platform and application, you are now ready to run a
simulation. Do this by running the following in the example directory:

platform/platform.${IMPERAS_ARCH}.exe application/asmtest.OR1K.elf

You should see the following output:

Processor cpu1 terminated at exit, address 0x10000bc

This message is printed by the imperasExit semihosting library as the processor executes
the first instruction at exit in the application.

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 37 of 92

.
 Imperas Installation and Getting Started Guide

6 Installing Additional Tools

Additional tools are provided in Linux or Windows installers. These are available from
the OVP website, www.OVPworld.org and the user area of the Imperas website 14 ,
http://www.imperas.com/

IMPORTANT
The Cross Compiler and Peripheral Simulation Engine toolchains are provided only as
32-bit native executables. This requires that a 64-bit host must provide a 32-bit
compatibility mode in order that they can execute. The packages they are provided in are
labeled as 64-bit packages, for example Linux64 only to indicate that they support a
64-bit Imperas or OVPsim installation.

6.1 Cross Compiler Toolchains

Imperas provides example pre-built toolchains for processors provided by OVP (the
toolchains are available at www.OVPworld.org and the user area of the Imperas website,
www.imperas.com).

NOTE
The Cross Compiler toolchains are provided to allow a user to quickly start generating
application binary code that can be executed on OVP processor models.
It is expected that after the initial experiments a cross compiler toolchain will be selected
from a cross compiler supplier.
Some processors and processor variants are not supported by the cross compiler
toolchains available on the OVPWorld website and alternatives are indicated to download
and install.

Also as part of these cross compiler toolchains is a Makefile to provide a default build
environment for an application onto a processor. The Makefiles are found in the directory
IMPERAS_HOME/lib/IMPERAS_ARCH/CrossCompiler in the format
<Processor Type/Variant>.makefile.include, for example MIPS32.Makefile.include.

Each cross compiler toolchain should be installed into the current installation of Imperas
Professional or OVPsim.

6.2 Peripheral Simulation Engine (PSE) Toolchain

A toolchain is provided to allow behavioral code to be compiled for a Peripheral
Simulation Engine (PSE). This is the simulation engine that is used to provide peripheral
models in a virtual platform simulation.

When installed this provides the toolchain pse-elf and a PSE.makefile.include.

14
The Imperas website provides the same installers but also for 64-bit host computers.

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 38 of 92

.
 Imperas Installation and Getting Started Guide

This toolchain should be installed into the current installation of Imperas tools or
OVPsim.

In the peripheral model source directory a Makefile should include a pre-defined

Makefile for building PSE behavioral code, Makefile.pse, as shown below

IMPERAS_HOME := $(shell getpath.exe "$(IMPERAS_HOME)")

include $(IMPERAS_HOME)/ImperasLib/buildutils/Makefile.pse

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 39 of 92

.
 Imperas Installation and Getting Started Guide

7 Getting Started
The following should be carried out in a Linux shell or on Windows an MSYS shell,
some scripts may be executed on Windows by double clicking in the explorer browser.

7.1 Check Installation

This section provides some checks that the tools have been correctly installed.

7.1.1 OVPsim and Imperas Simulator Execution

To verify the installation after an OVPsim or an Imperas install one of the Demos that are
downloaded in both installations can be executed. These Demos will work with both the
OVPsim and the Imperas Simulators.

For example, execute the Fibonacci benchmark on a single core OR1K platform.

Change to the directory (the following assumes a Linux or MSYS shell is used).

> cd $IMPERAS_HOME/Demo/Processors/OPENCORES/or1k/generic/single_core
> Run_Fibonacci.sh

If Windows explorer is used, change to the directory and double-click the corresponding
.bat file.

This should provide an output similar to that shown below, for an OVPsim installation:

IMPERAS Instruction Set Simulator (ISS)

OVPsim (32-Bit) v20150901.0 Open Virtual Platform simulator from www.OVPworld.org.

Copyright (c) 2005-2015 Imperas Software Ltd. Contains Imperas Proprietary Information.
Licensed Software, All Rights Reserved.
Visit www.IMPERAS.com for multicore debug, verification and analysis solutions.

OVPsim started: Thu Sep 17 09:35:46 2015

Info (ICM_AL) Found attribute symbol 'modelAttrs' in file

'C:/Imperas/lib/Windows64/ImperasLib/ovpworld.org/processor/or1k/1.0/model.dll'
Info (ICM_AL) Found attribute symbol 'modelAttrs' in file
'C:/Imperas/lib/Windows64/ImperasLib/ovpworld.org/semihosting/or1kNewlib/1.0/model.dll'
Info (OR_OF) Target 'iss/cpu0' has object file read from
'../../../Applications/fibonacci/fibonacci.OR1K-O3-g.elf'
Info (OR_PH) Program Headers:
Info (OR_PH) Type Offset VirtAddr PhysAddr FileSiz MemSiz Flags Align
Info (OR_PD) LOAD 0x00002000 0x00000000 0x00000000 0x0000e37c 0x0000e494 RWE 2000
starting fib(36)...
fib(0) = 0
fib(1) = 1
fib(2) = 1
fib(3) = 2
fib(4) = 3
...
fib(33) = 3524578
fib(34) = 5702887
fib(35) = 9227465
finishing...
Info

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 40 of 92

.
 Imperas Installation and Getting Started Guide

Info ---------------------------------------------------
Info CPU 'iss/cpu0' STATISTICS
Info Type : or1k (generic)
Info Nominal MIPS : 100
Info Final program counter : 0x1948
Info Simulated instructions: 1,563,699,833
Info Simulated MIPS : 1373.1
Info ---------------------------------------------------
Info
Info ---------------------------------------------------
Info SIMULATION TIME STATISTICS
Info Simulated time : 15.64 seconds
Info User time : 1.14 seconds
Info System time : 0.00 seconds
Info Elapsed time : 1.15 seconds
Info Real time ratio : 13.55x faster
Info ---------------------------------------------------

OVPsim finished: Thu Sep 17 09:35:48 2015

OVPsim (32-Bit) v20150901.0 Open Virtual Platform simulator from www.OVPworld.org.

Visit www.IMPERAS.com for multicore debug, verification and analysis solutions.

NOTE
The Imperas ISS used in this example is provided in two different executable programs,
as iss.exe and issdemo.exe. The demo scripts use the environment variable
IMPERAS_ISS that selects which to run. The environment variable is setup as part of the
installation setup scripts. iss.exe is compiled with licensing that uses the default OVPsim
or Imperas simulator license features. issdemo.exe does not require a license but can only
be executed with access to the internet.

If you see the following it indicates that issdemo.exe is being executed.

Info (PER_DDR) 77 Demo License days remain

7.1.2 iGen Installation

There are a number of executables supplied with the Imperas professional product
installation, for example igen.exe and mpd.exe. If you execute:

> igen.exe --version

This should provide the version information, for example 20150901.0

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 41 of 92

.
 Imperas Installation and Getting Started Guide

> igen.exe --help

This should start iGen with the help output similar to that shown below:
flag short argument description

diagnostics
--apropos command Show igen commands similar to the given argument
--help -h Print list of flags
--showcommands Show all igen commands

input
--batch -b filename Execute this tcl file
--batchargv argument Argument to --batch file
--checkmodels Load and check models when writing a platform
--modellibrary string Processor VLNV library
--modelname string Processor VLNV name
--modelvendor string Processor VLNV vendor
...

7.2 Cross Compiler and Host Toolchain

For this example the OR1K toolchain will be used to compile an application to execute
on the OR1K processor model contained in a simple platform.

To see more about videos, examples etc. for the OR1K look at the OR1K model variant
page: http://www.ovpworld.org/processor-model-variant-opencores-or1k-generic.

7.2.1 Download OR1K Cross Compiler toolchain

Go to the OVPworld.org downloads page http://www.ovpworld.org/dlp and then scroll
down to the OpenCores OR1K section. Look on the right hand side list to find the
appropriate (Windows or Linux) installer for the OR1K Toolchains. This will download
either an installer for Windows (or1k.toolchain.<major version>.<dot
release>.Windows32.exe) or an installer for Linux (or1k.toolchain.<major version>.<dot
release>.Linux32.exe).

7.2.2 Install OR1K Cross Compiler toolchains

The toolchains are provided in the same way as the Imperas tools and OVPsim
installations; that is as a Windows or Linux installation executable.

The version of the toolchain available is the same as the version of the Imperas tools or
OVPsim available. When extracted they should be installed into the same directory. For
example, into the directory <installDir>/Imperas.<major version> on Linux.

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 42 of 92

.
 Imperas Installation and Getting Started Guide

7.2.3 Host toolchains

The host toolchain is used to compile code that executes directly on the Linux or
Windows machine.

On Linux, the standard toolchain provided with the Linux installation is used.

On Windows, a MinGW toolchain is recommended as described in section 5.2.2

"Installation of MinGW 32-bit and 64-bit Toolchains"

7.3 Hello World Example

There are many examples and demonstrations that are provided in an installation. They
are in the directories $IMPERAS_HOME/Examples and $IMPERAS_HOME/Demo.

For our first compilation/run we will use one of the provided 'hello world' examples.

There are a number of different ways of building a platform and controlling a simulation.

In the example above we used the ISS to run the OR1K Fibonacci example. The ISS uses
the model library and allows a binary cross compiled elf file to be run on a processor
model variant without you defining a platform at all. It is the simplest way to run and
debug software.

If you need to model a platform, then there are several ways to create that platform.

If you look in the Examples/HelloWorld directory there are some simple examples:

> ls $IMPERAS_HOME/Examples/HelloWorld
usingHarnessExe usingHarnessInC usingISS usingSystemC

For the simplest run, lets look at the usingISS example:

> cp r $IMPERAS_HOME/Examples/HelloWorld/usingISS .
> cd usingISS

In this directory you should see an application directory with a file application.c, which
can run on this platform, and a Makefile for building the application.

7.3.1 Compiling an application

Lets compile the Application using the OR1K Cross Compiler toolchain.

> cd application
> make

If you see the following the toolchain has not been installed or it has not been installed
into the current release that is being executed. (Install the toolchain now.)

Makefile:12: *** "Please install the toolchain to support OR1K ". Stop.

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 43 of 92

.
 Imperas Installation and Getting Started Guide

A correct compilation will give you output something like

> make
Compiling application.c
Linking application.OR1K.elf
rm application.o

To see exactly what is going on add VERBOSE=1 to the command line

$ make CROSS=OR1K VERBOSE=1

echo "Compiling application.c"
Compiling application.c
C:/Imperas/lib/WINDOW~1/CROSSC~1/or32-elf/bin/or32-elf-gcc
-IC:/Imperas/ImpPublic/include/common
-IC:/Imperas/ImpPublic/include/target/common
-IC:/Imperas/ImpPublic/include/target/application
-IC:/Imperas/lib/Windows64/TargetLibraries/include/or32 -c -o application.o
application.c
echo "Linking application.OR1K.elf"
Linking application.OR1K.elf
C:/Imperas/lib/WINDOW~1/CROSSC~1/or32-elf/bin/or32-elf-gcc
-IC:/Imperas/ImpPublic/include/common
-IC:/Imperas/ImpPublic/include/target/common
-IC:/Imperas/ImpPublic/include/target/application
-IC:/Imperas/lib/Windows64/TargetLibraries/include/or32 -nostartfiles
-TC:/Imperas/lib/Windows64/TargetLibraries/or32-elf/or32-
elf-lib.ld -LC:/Imperas/lib/Windows64/TargetLibraries/or32-elf
C:/Imperas/lib/Windows64/TargetLibraries/or32-elf/crt0.o -o application.OR1K.elf
application.o -limperas -lm
rm application.o

This cross compilation of the application for the OR1K processor, will produce a file
called application.OR1k.elf.

Move back up a directory

> cd ..

7.3.2 Running the simulation using the ISS

We can now run the compiled application using the ISS:

> iss.exe --program application/application.OR1K.elf \

--processorvendor ovpworld.org \
--processorname or1k \
--variant generic \
--verbose

This should provide an output similar to that shown below:

OVPsim (32-Bit) v20150901.0 Open Virtual Platform simulator from

www.OVPworld.org.
Copyright (c) 2005-2015 Imperas Software Ltd. Contains Imperas Proprietary
Information.
Licensed Software, All Rights Reserved.
Visit www.IMPERAS.com for multicore debug, verification and analysis solutions.

OVPsim started: Fri Sep 18 11:45:52 2015

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 44 of 92

.
 Imperas Installation and Getting Started Guide

Info (OP_AL) Found attribute symbol 'modelAttrs' in file

'C:/Imperas/lib/Windows32/ImperasLib/ovpworld.org/processor/or1k/1.0/model.dll'
Info (OP_AL) Found attribute symbol 'modelAttrs' in file
'C:/Imperas/lib/Windows32/ImperasLib/ovpworld.org/semihosting/or1kNewlib/1.0/model.dll'
Info (OR_OF) Target 'platform/cpu1' has object file read from 'application.OR1K.elf'
Info (OR_PH) Program Headers:
Info (OR_PH) Type Offset VirtAddr PhysAddr FileSiz MemSiz Flags Align
Info (OR_PD) LOAD 0x00002000 0x00000000 0x00000000 0x0000dc48 0x0000dd64 RWE 2000
Hello World
Info
Info ---------------------------------------------------
Info CPU 'platform/cpu1' STATISTICS
Info Type : or1k
Info Nominal MIPS : 100
Info Final program counter : 0x1720
Info Simulated instructions: 2,226
Info Simulated MIPS : run too short for meaningful result
Info ---------------------------------------------------
Info
Info ---------------------------------------------------
Info SIMULATION TIME STATISTICS
Info Simulated time : 0.00 seconds
Info User time : 0.02 seconds
Info System time : 0.00 seconds
Info Elapsed time : 0.02 seconds
Info ---------------------------------------------------

OVPsim finished: Fri Sep 18 11:45:52 2015

OVPsim (32-Bit) v20150901.0 Open Virtual Platform simulator from www.OVPworld.org.

Visit www.IMPERAS.com for multicore debug, verification and analysis solutions.

NOTE
The Simulated MIPS figure provides an indication of how many millions of instructions
the simulator was able to run on your host machine per second. You will get the message
run too short for meaningful result if the simulated time is less than a second.

7.3.3 example.sh/.bat script

For convenience we provide an example.bat/sh file that compiles up the application and
runs the simulation:

> ./example.sh
...

7.3.4 A first platform / module simulated using harness.exe

The above previous example showed compiling an application and then using the ISS to
run it. In this next example, we will create a simple platform, and use the provided test
harness program to control the simulation.

> cp r $IMPERAS_HOME/Examples/HelloWorld/usingHarnessExe .
> cd usingHarnessExe

In this directory - there is the application - as in the previous example. So compile it up:

> cd application
> make

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 45 of 92

.
 Imperas Installation and Getting Started Guide

> cd ..

and then lets have a look at the platform / module.

> cd module
> ls

and we will see there is a module.op.tcl file and a Makefile. The module.op.tcl is the
definition of the platform using iGen input script commands.

The provided Makefile will run iGen on the input file:

> make
# iGen Create OP MODULE module
# Host Depending obj/Windows64/module.d
# Host Compiling Module obj/Windows64/module.o
# Host Linking Module object model.dll

and if you now list the directory, you will see several .c/.h files created by iGen. These
are normal C files that make use of the standard OVP OP API that creates platforms. For
examples of platforms/modules written directly in OP, please refer to:
Writing_Platforms_and_Modules_in_C_User_Guide.pdf

There are many examples of using this approach in the Examples/PlatformConstruction

directory and there are 2 comprehensive documents in doc/ovp that describe the use of
iGen for platforms.modules:
iGen_Model_Generator_Introduction.pdf
iGen_Platform_and_Module_Creation_User_Guide.pdf

Also, please look at the iGen section in doc/ovp/index.html. iGen is a platform and
model building wizard/productivity tool to make it very easy to create platforms/models.

The running of the Makefile has created the module/model.dll that is a binary
representation of the input .c/.h that was created by iGen from the input .tcl file. This
module/model.dll can be used in other platforms/modules (as part of a system/subsystem
hierarchy), or it can be simulated directly using the provided harness.exe program:

> cd ..
> harness.exe --modulefile module/model.dll
--program application/application.OR1K.elf
...
OVPsim started: Wed Mar 23 12:00:23 2016

Hello World using harness.exe

OVPsim finished: Wed Mar 23 12:00:23 2016

...

You can see what control options are available in the harness.exe by using the help
option:

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 46 of 92

.
 Imperas Installation and Getting Started Guide

> harness.exe --help

Try out some like --trace, --showbuses, --showmodule, --showoverrides, --gdbconsole.

Again there is a script to compile the application, module and run the harness.exe:

> ./example.sh

7.3.5 Writing your own test harness

The above previous example showed creating a platform/module and using the provided
simulation test harness to run and control the simulation. You can of course write your
own test harness.

The OVP OP API provides many powerful functions to control a simulation. There are
many examples of this in the Examples/SimulationControl directory and there are two
documents which provide many common use cases
Simulation_Control_of_Platforms_and_Modules_User_Guide.pdf
Advanced_Simulation_Control_of_Platforms_and_Modules_User_Guide.pdf

> cp r $IMPERAS_HOME/Examples/HelloWorld/usingHarnessInC .
> cd usingHarnessInC

This has an application directory and module directory as in the previous examples. What
is new is the harness directory:

> cd harness
> ls
harness.c Makefile

The harness.c is a regular C program that uses calls to the OVP OP API to control the
simulation of a module. Please refer to the documents mentioned above for information
on the OP API calls etc.

As in previous examples, for convenience a script it provided to compile and run the
complete example:

> ./example.sh
...
# Compiling application.c
...
# iGen Create OP MODULE module
...
# Host Linking Harness harness.Windows64.exe
...
OVPsim started: Wed Mar 23 12:21:06 2016

Hello World using C Harness

OVPsim finished: Wed Mar 23 12:21:06 2016

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 47 of 92

.
 Imperas Installation and Getting Started Guide

7.4 Semihosting Support

7.4.1 In Imperas and OVP simulations
The term "semihosting" is over used and can mean several things. In the case of OVP
simulations the term semihosting refers to specific behavior that is provided by the Host
system rather than the simulation platform or an operating system running on the
simulation platform.
For example, in an embedded system to get output on a terminal the platform would
typically include a hardware device, such as a UART, and the application software would
provide a driver to initialize the device and provide low level functions that can be used
by library functions, for example printf, to output characters to the terminal. This adds
complexity to the software and the platform that is not required if we simply wanted to
cross compile and run a bare metal C application on a specific processor variant.
In this example semihosting would be used to provide behavior for the low level
functions without having to add anything to the platform or application code. A semihost
library replaces behavior of the low level function in the cross compiled application with
a native host function provided within a semihosting intercept library.
The semihost library is native code that is loaded as a shared object by the simulator. It is
defined in the instantiation of a processor instance in a platform.

7.4.2 Replacing function and/or instruction behavior

Different mechanisms may be used to support semihosting. This may be replacing a
functions behavior or using one or more 15 specific instructions to control semihost
operations.

A semihost library may replace a function in its entirety to provide that function itself, for
example the function _write, which sends a character from a buffer to a hardware device
output register, may be intercepted and replaced by a semihost function that takes the
character from the buffer and displays it on the host stdout.

A semihost library may replace a specific instruction, typically a software interrupt

instruction, which is a way of the application program requesting an action from a Host
operating system, but that in this case is intercepted and the function performed

7.4.3 Specific to a Cross Compiler and C Library

The way a semihost library is intended to work is specific to a processor type and also to
the cross compiler toolchain and C library used during the application compilation and
linkage. It is, therefore, important that the correct semihost library is included with the
processor instantiation in a platform for the cross compiler and C library used to build the
application that will execute on the processor.

Example mips32 CodeSourcery cross compiler toolchain uses mips32Newlib semihost

library.
The C library used in the application compilation in this case is specified by a linker
script, mipssim-hosted.ld. This controls the C library included. The semihosting is
15
The actual number of instruction types that can be used is limited in a semihost library

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 48 of 92

.
 Imperas Installation and Getting Started Guide

performed at the low level function level, as defined in the .intercept table of the semihost
file mips32Newlib.c in the VLNV library.

Example ARM Linaro cross compiler toolchain used armAngel semihost library.
The C library used in the application compilation in this case is specified by a specs file,
aprofile-ve.specs. This controls the C library included. The semihosting is performed at
the instruction level, as defined in the armOSOperation function of the semihost file
armAngel.c in the VLNV library.

7.4.4 Used to terminate the simulation

The semihost library may also detect other events in the execution of application
software, for example a call to exit or a jump-to-self.
An embedded processor would never stop executing instructions, unless put into a
specific mode. In order to stop an application 'running off the end' designers typically put
spin loops in areas of code that are used to capture unwanted events from which the
program cannot recover including the 'exit' function code.
The execution of a spin loop could cause the application to run forever and make the
simulation appear to lock-up so the semihost library is used to detect spin loops or calls to
exit and terminate the simulation.

7.4.5 Caution using with EPKs and non-baremetal platforms

The semihost library replaces functions and/or instructions behavior so it is not the case
that a semihost library should always be used. In an EPK or other non-baremetal platform
care should be taken to avoid the situation that code is not executed when expected
because a symbol has happened to match one defined in the semihost library and has
caused the functions normal behavior to be replaced by that of the semihost library.

7.5 Simulation Time Statistics

At the end of simulation, if the verbose flag has been used, some statistics will be
reported by the simulator. This provides information to indicate how many instructions
were executed on the OVP Processor model and the equivalent simulated Millions of
Instructions Per Second (MIPS) that were executed. This can be used as an indication of
how well the simulator performed on the host machine running the particular application.

The typical simulation statistics is shown below. Most entries are self explanatory but are
described in the following sections

Info ---------------------------------------------------
Info CPU 'platform/cpu0' STATISTICS
Info Type : arm (Cortex-A9UP)
Info Nominal MIPS : 100
Info Final program counter : 0x4b8
Info Simulated instructions: 22,400,008,761
Info Simulated MIPS : 5720.7
Info ---------------------------------------------------
Info
Info ---------------------------------------------------
Info SIMULATION TIME STATISTICS

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 49 of 92

.
 Imperas Installation and Getting Started Guide

Info Simulated time : 224.00 seconds

Info User time : 3.92 seconds
Info System time : 0.00 seconds
Info Elapsed time : 3.93 seconds
Info Real time ratio : 56.98x faster
Info ---------------------------------------------------

OVP Fast processor model configuration information

Info Type : arm (Cortex-A9UP)

Info Nominal MIPS : 100

The model type and, if selected, the configuration variant are displayed. The nominal
MIPS for the processor model, by default, is 100 MIPS. This has an effect when running
with 'wallclock' enabled or when in a multi-processor system. With 'wallclock' enabled it
is used to control the maximum execution performance i.e. only 100 million instructions
will be executed in a real time 1 second. In a multi-processor system (without wallclock
enabled) it provides an execution ration between processors e.g. a 200 MIPS processor
will execute twice the instructions as a 100 MIPS processor in a simulation unit of time.

Program execution information

Info Final program counter : 0x4b8

Info Simulated instructions: 22,400,008,761

The 'Simulated instructions' will vary depending upon the application being executed, this
count indicates the number of simulated processor instructions for the processors in the
platform. The final program counter can be useful as an easy way of showing the
application program executes in a deterministic way over a number of simulation runs.

Simulated MIPS

Info Simulated MIPS : 5720.7

The 'Simulated MIPS' will be a measure of the number of 'Simulated instructions' over
the host elapsed time and is an indication of the performance of the simulator.

There is an overhead at the start of simulation with Just-In-Time code morphing

simulators and so the Simulated MIPS are not calculated if the simulated run time is
below a threshold. If you see the following output you are typically running too few
instructions i.e. your application is too short.

Info Simulated MIPS : run too short for meaningful result

Simulation time statistics

The simulated time is the time it would have taken to run the application based upon the
MIPS configuration of the processor and the number of instructions the application took
to complete.

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 50 of 92

.
 Imperas Installation and Getting Started Guide

Info Simulated time : 224.00 seconds

The time fields are real time information from the native Host machine relating to the
simulator execution.

Info User time : 3.92 seconds

Info System time : 0.00 seconds
Info Elapsed time : 3.93 seconds

The "real time ratio" is an indication of how much quicker the simulator was able to
execute the processor instructions than the real silicon based upon the OVP Fast
processor model MIPS rate configuration and the time the simulator took to execute the
instructions on the native host machine.

Info Real time ratio : 56.98x faster

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 51 of 92

.
 Imperas Installation and Getting Started Guide

8 Understanding the operation of a code morphing

simulator
8.1 Instruction Fetch
A code morphing simulator operates in two phases to provide the behavior of a target
processor executing a sequence of instructions.

1. Morphing cross compiled target instructions (for example ARM Cortex-A9, MIPS
1074Kc, V850) to a sequence of native host instructions
2. Executing the sequence of native host instructions to provide the behavior
expected of the target

In 1 we are executing in 'morph time' using the translations specified by the OVP
processor model. During the translation process, each instruction is read from the virtual
platform memory using a debug (artifact) transaction. This access must have no effect on
the system and must be implemented as a 'back door' access that bypasses any behavior
of the system; including timing or delays that may be in a SystemC TLM2 virtual
platform implementation.
The code morpher will continue reading instructions and morphing code until it has
constructed an entire 'code block'. This may be a few or many instructions.
Once a code block is created, the block is executed. We are now in 2, in 'run time', for
each target instruction behavior, a) the instruction is reread from memory - but this time
as a 'real' transaction that will have an effect on the system that the fetch would normally
have and b) the native code is executed to create the behavior.

Figure 1: Real and Artifact accesses over time

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 52 of 92

.
 Imperas Installation and Getting Started Guide

8.2 SystemC Interface Transaction Types

In SystemC TLM2 interface code is generated for each OVP fast processor model.

There is also generic OVP processor interface code that is provided in the installed
component source library.
The component VLNV source library is found at IMPERAS_HOME/ImperasLib/source,
with the V/L/N/V of the TLM2.0 support models
ovpworld.org/modelSupport/tlmProcessor/1.0 containing the interface file
tlm2.0/tlmProcessor.cpp

In this file you will find the function icmCpuMasterPort::readUpCall that will perform a
TLM2.0 read (fetch) transaction by calling either socket->b_transport() for a 'real' access
or socket->transport_dbg() for a 'debug' (simulation artifact) access.

IMPORTANT NOTE

The SystemC virtual platform must provide both debug and real interface connections.

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 53 of 92

.
 Imperas Installation and Getting Started Guide

APPENDIX A Installation Packages, Products and

Licensing Features

A.1 Installation Packages

There are three main product installation packages available to download via the Imperas
or OVP World websites.
1. Imperas_SDK
2. Imperas_DEV
3. OVPsim

In addition to the product installation packages above are a number of installers providing
specific demonstrations and example toolchains to be used in compilation of peripheral
models and cross compilation of processor application code.

A.1.1 Imperas_SDK package

The Imperas_SDK package is available from the Imperas website and provides the
M*SDK product features.

These include
1. Verification, Analysis and Profiling (VAP) tools
2. Multicore debugger for debugging of applications running on processor
models and peripheral models in a unified environment
3. M*SIM professional simulator
4. Imperas Generator Wizard (iGen) for generating virtual platforms and model
(processor and peripheral) templates
5. Model Library
6. Examples and Demonstrations

A.1.2 Imperas_DEV package

The Imperas_DEV package is available from the Imperas website and provides the
Developer installations; C*DEV, S*DEV 16 and M*DEV which provide different
simulator features. The package provides the DEV product features.

These include
1. M*SIM professional simulator
2. Imperas Generator Wizard (iGen) for generating virtual platforms and model
templates
3. Model Library
4. Examples and Demonstrations

16
The Standard Developer simulator configuration provides similar capabilities to the OVPsim simulator.

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 54 of 92

.
 Imperas Installation and Getting Started Guide

The setting of the IMPERAS_PERSONALITY environment variable is used to select the

simulator features, between those provided by Controller (C*DEV), Standard (S*DEV)
and Multi (M*DEV)

A.1.3 OVPsim package

The OVPsim package is available from the OVP World website. The package provides
the product features.

These include
1. OVPsim reference simulator
2. Imperas Generator Wizard (iGen) for generating virtual platforms and model
templates
3. Model Library
4. Examples and Demonstrations

A.2 License Features

A.2.1 Executable Programs
The following table shows the executable programs that are provided in the product
packages.

Product Name Package License Feature Simulator / Personality

mpd.exe Imperas_SDK IMP_MPD Not required
igen.exe all (simulator) Any / Any
ipost.exe Imperas_SDK IMP_IPOST Not required
cpuGen Imperas_SDK IMP_IGEN + Any / Any
IMP_CPUGEN

A.2.2 CpuManager Simulator and its Personalities

The CpuManager simulator runtime can be configured to provide different levels of
simulation support. The configuration of the simulator is controlled with the
IMPERAS_PERSONALITY environment variable. The simulator has a default
personality equivalent to setting IMPERAS_PERSONALITY to CPUMAN_MULTI. The
license features that the simulator will checkout are controlled by the personality.

Simulator Personality Product License Feature

CPUMAN_CONTROLLER C*DEV IMP_CPUMAN_CONTROLLER
CPUMAN_STANDARD S*DEV IMP_CPUMAN_STANDARD
CPUMAN_MULTI (default) M*SDK and M*DEV IMP_CPUMAN_MULTI

OVPSIM OVPsim IMP_OVPSIM

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 55 of 92

.
 Imperas Installation and Getting Started Guide

A.2.3 OVPsim Simulator

The OVPsim simulator does not use the IMPERAS_PERSONALITY environment
variable and provides fixed simulation support, equivalent of the Developer S*DEV
product.

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 56 of 92

.
 Imperas Installation and Getting Started Guide

APPENDIX B Obtaining an Imperas License

To obtain an
Imperas license send an email request to license_support@imperas.com,
OVPsim license visit the OVPworld.org license page, or send an email to
license@ovpworld.org

The email sent must contain the following information:

Name
e-mail address of the person responsible for the Imperas/OVP Tools
Phone number
Company Address
Host id 17
Host Name of the machine running the license server
Type (Linux, Windows)

17
This is the FlexLM information obtained using the lmutil(.exe) that is installed with all packages. See
section 4.5 Setting up Licensing (Both Windows and Linux)

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 57 of 92

.
 Imperas Installation and Getting Started Guide

APPENDIX C Accessing Imperas User Area

C.1 Initial Login at Imperas User
Login at www.imperas.com and select the "User Login" link. At this point you will use
the same username and password that is used on the OVP World website.

C.2 Selecting Imperas Product download

The Imperas products are found at the Downloads link for the Imperas Current Release
Product.

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 58 of 92

.
 Imperas Installation and Getting Started Guide

C.3 Logging into Download area

When any of the links are selected you will get a popup in which the company username
and password should be entered. This is common to all users of a company, university
etc. and is provided by Imperas.

C.4 Selecting Files

You are now in a page listing all the available Imperas product packages. Select the link
for the package that you wish to download.

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 59 of 92

.
 Imperas Installation and Getting Started Guide

APPENDIX D Setting Environment Variables

D.1 Opening System properties on Windows XP
In order to set an environment variable using Windows XP follow these steps

Select Control Panel

Select System to bring up the System properties dialogue box.

D.2 Opening System properties on Windows 7

Select Control Panel and then select System and Security

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 60 of 92

.
 Imperas Installation and Getting Started Guide

Now select System

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 61 of 92

.
 Imperas Installation and Getting Started Guide

Finally select Advanced system settings

D.3 Modifying Environment Variables in Windows

Select Advanced tab and then Environment Variable

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 62 of 92

.
 Imperas Installation and Getting Started Guide

APPENDIX E Additional FLEXlm Licensing Information

E.1 Locating the license server software
The license server and daemon are provided as part of the OVPsim or Imperas releases or
may be downloaded from the Imperas and OVPWorld websites.

After installing the OVPsim or Imperas packages the license server, lmgrd, and the
Imperas license daemon, imperasd, can be found in the binary installation directory.

On a Windows machine the server will be found

$IMPERAS_HOME/bin/$IMPERAS_ARCH/lmgrd.exe

On a Linux machine the server will be found

$IMPERAS_HOME/bin/$IMPERAS_ARCH/lmgrd

The deamon, imperasd, is found in the same directory.

E.2 Types of Licenses

There are several different types of license files. A license can be node-locked, which
means the tools can only run on a single computer, or it can be floating in which case one
computer acts as a license server, which runs a license daemon, and the tools may run on
any computer that can contact the server over the local area network to check out a
license.

In the case of a node-locked license, you will send Imperas/OVPworld the host name and
host ID of the computer that you will run the tools on. In the case of a floating license
you will need to choose one computer to be the license server and send the host name and
host ID of that computer to Imperas/OVPworld to obtain your license. Note the license
server may be the same computer you run the tools on.

In addition a license may be uncounted, which means that any number of copies of the
program may run simultaneously, or it may be counted which means that only a specified
number of instances of the program may be active at one time.

E.2.1 Uncounted Node-locked Licenses

An uncounted node-locked license is the simplest sort of license. It does not require a
license server or a license daemon to be running. You can tell your license is node-locked
if it has only uncounted FEATURE lines and comment lines (which start with a #) in it.
For example:

#### OVPsim non-commercial license keys

#### Generated on 2011-04-30

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 63 of 92

.
 Imperas Installation and Getting Started Guide

#### Hostname1 PC1

FEATURE IMP_OVPSIM_20130630 imperasd 1.0 25-aug-2013 uncounted \
HOSTID=002119426114 SIGN="0874 1401 CA64 337B FC3B 9CE6 9D29 \
CFD3 F89E F4C1 D090 9084 CE9A E2A8 D8BA 0F6F BEF9 CC19 ACF4 \
A7F9 6834 145A 0B11 0BED AD50 6672 47B2 1758 7B24 65D2"

You can tell if a license feature is uncounted by looking for the word uncounted
following the expiration date of the feature.

If a license contains only node-locked, uncounted features then you only need to set the
environment variable IMPERASD_LICENSE_FILE to point at it, e.g.:
IMPERASD_LICENSE_FILE=~/Imperas/license.lic

See the respective installation instructions for Windows and Linux for examples of how
to set an environment variable.

E.2.2 Floating Licenses

If your license is a floating license then you will need a license daemon program running
on a license server. With a floating license any computer that can find the license server
on the local area network can run the tools.

An example of a floating license looks like:

SERVER server1 00F346829930

VENDOR imperasd /path-to-deamon/imperasd
USE_SERVER
################## Feature List ####################
FEATURE IMP_SIMULATOR imperasd 1.0 25-aug-2013 5 TS_OK SIGN="5763\
07C3 196A 858A 5455 A9EF 541E D2D4 6A75 1ED5 B3BF AE94 F141 \
1A7A BE50 CD76 3466 A503 3035 4464 9788 4911 AEC5 F73B 18E7 \
92AC 27CF B8A4 9FF3 0DE4 "
FEATURE IMP_CPUMANAGER imperasd 1.0 25-aug-2013 5 TS_OK SIGN="10D9 \
9297 4903 02EE 90C9 95BC 3371 9B72 11D4 F9E2 056F BBF2 AA5F \
4DBE 681B 0193 A355 B1B2 1638 6BBF 01CD A006 5E73 56C1 FD5D \
EAB6 B2E0 70C3 893F 9755"

Here we see SERVER, VENDOR and USE_SERVER lines in addition to the FEATURE
lines we saw in an uncounted node-locked license. Also, after the expiration date on the
FEATURE lines we see 5 instead of uncounted indicating this is a counted license.
When either of these is true a license server will be required.

The format of the SERVER line is as follows:

SERVER <host name> <host ID> {<port>}

<host name> should be the host name of the license server. This can be edited if it is not
correct.
<host ID> is the host id of the license server. This cannot be changed without
invalidating the license file. The license server must be the computer with this host ID.
{<port>} is an optional integer value which specifies the port the server communicates
through. It should usually be left blank, in which case a port in the default range of 27000
2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 64 of 92
.
 Imperas Installation and Getting Started Guide

to 27009 will be used. If it is specified in the license file then the same value must be
specified on the IMPERASD_LICENSE_FILE environment variable on the computer running
the target program.

The format of the VENDOR line is as follows:

VENDOR <vendor_daemon_name> <path to vendor daemon file>

<vendor_daemon_name> should be imperasd. <path to vendor daemon file> should be

edited to be the path of the imperasd (imperasd.exe on Windows) file located in the
directory $IMPERAS_HOME/bin/$IMPERAS_ARCH for example:

VENDOR imperasd /usr/Imperas/bin/Linux32/imperasd

or
VENDOR imperasd C:\Imperas\bin\Windows32\imperasd.exe

E.3 Starting the License Server

The Imperas license daemon (imperasd) must be run on the license server using the
FLEXlm tools. The FLEXlm lmutil tool and the Imperas daemon are provided in the
$IMPERAS_HOME/bin/$IMPERAS_ARCH directory. The daemon can be started using the
following command on the license server:

On a Windows machine in an MSYS shell

> $IMPERAS_HOME/bin/$IMPERAS_ARCH/lmgrd.exe c license.lic l license.log

On a Linux machine in a shell

> $IMPERAS_HOME/bin/$IMPERAS_ARCH/lmgrd c license.lic l license.log

Where license.lic is the name of the license file which must be able to be read from the
license server and license.log is the name of a file where the license manager will write
informational and debug messages.

The license server may also be started in a foreground mode by adding the -z switch

> $IMPERAS_HOME/bin/$IMPERAS_ARCH/lmgrd z c license.lic

If the license server is a different computer than you installed the tools on, you may want
to copy the license manager tools and the daemon file from
$IMPERAS_HOME/bin/$IMPERAS_ARCH to the license server. The license tools all start with
lm and the daemon file is named either imperasd or imperasd.exe.

The lmgrd command will need to be re-run every time the license server is rebooted.

On Linux it can be placed in a boot script file (e.g. /etc/rc.local).

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 65 of 92

.
 Imperas Installation and Getting Started Guide

On Windows it can be started as a service each time the computer is rebooted. The
command lmtools will start a GUI program where you can configure the windows lmgrd
service from the Config Services tab.

E.4 Configuring the Host Computer

On the computer that will be running the tools you simply have to set the
IMPERASD_LICENSE_FILE environment variable to point to the license server,
IMPERASD_LICENSE_FILE=@serverhost

where serverhost is the hostname of the license server. The command hostname may be
used on both Windows and Linux to find out the host name of a particular computer. This
example assumes that the default port (27000-27009) is being used by the license server.
If the license server was set up to use a different port it must be specified before the @,
for example:
IMPERASD_LICENSE_FILE=9999@serverhost

Here, 9999 is the port number that the license server is using.

See the respective installation instructions for Windows and Linux for examples of how
to set an environment variable.

E.5 Other License File Configurations

FLEXlm has many different ways to configure it. You may already have other FLEXlm
licenses running on your computers. By default we have configured things to be as
independent of other installations as possible, but your particular situation may require
alternative configurations.

Also, FLEXlm supports many different options to control how licenses are managed than
are discussed her. If you need to use any of those additional capabilities please consult
the FLEXlm End Users Manual.

Searching the internet for FlexLM End Users Manual should locate a copy of this
manual.

E.6 The daemon options file

Use of the licenses can be customized by using a daemon options file.

To make FLEXlm use an options file, either specify the full path to the file in the license
file or name the file 'imperasd.opt' and place it in the same directory as the license file.

Each line of the options file controls one option. The most commonly used options are:

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 66 of 92

.
 Imperas Installation and Getting Started Guide

EXCLUDE feature[:keyword=value] type {name | group_name}

Exclude a user or host from using a license feature.

where featurename is the name of the feature as specified in the license file, type
is normally USER, HOST or GROUP, and name is the name of the user or group
to exclude.
INCLUDE feature[:keyword=value] type {name | group_name}

This option is the same as EXCLUDE but allows a user to use a license feature,
but note, if any INCLUDE lines are used then one must be provided for each user
who will use the license.

GROUP group_name user_list

Defines a name (group_name) for a group of users, so it can be used in other

options like include & exclude. username list is just a list of names separated by a
space.
RESERVE num_lic feature[:keyword=value] type {name | group_name}

Reserve licenses for a specific user, group or host.

where num_lic is the number of licenses to be reserved, and the other variables are
the same as for EXCLUDE.

For a list of other options please consult the FLEXlm End Users Manual.

Searching the internet for FlexLM End Users Manual should locate a copy of this
manual.

E.7 License Administration tools

There are several utilities that aid administration of the licenses and this section briefly
describes the most frequently used.

lmutil lmstat - allows users to see:-

which daemons are running
which users are using which features
Options:
-a - Display all information.
-A - List all active licenses.
-c - Use the given license file.
-f - List all users of featurename.

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 67 of 92

.
 Imperas Installation and Getting Started Guide

-S - List all users of a vendor's features (for example, arcd)

-s - Display status of clients running on given host.

lmutil lmdown - gracefully shutdown all daemons.

Use -c to shutdown a specific license. Providing no arguments shuts down the

license(s) specified by the environment variable LM_LICENSE_FILE. Use of lmdown
should be protected to prevent unintentional loss of licenses.

lmutil lmremove - most commonly used to remove licenses that are still checked out after
a node crashes.

lmremove will remove all instances of the specified feature by the given user on
host.

lmutil lmreread - make the license daemon reread the given license file.

This will start any new daemons that have been added and cause currently running
daemons to read their license files again.

Use either lmutil lmreread imperasd or lmutil lmreread c <licensefile>.

E.8 Configuring the License Server Manager as a

Windows Service using LMTOOLS
To configure a license server manager (lmgrd) as a service, you must have Administrator
privileges. The service will run under the LocalSystem account. This account is required
to run this utility as a service.

To configure a license server as a service:

1. Run the lmtools utility, this is found in Imperas/bin/Windows32

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 68 of 92

.
 Imperas Installation and Getting Started Guide

2. Click the Configuration using Services button, and then click the Config Services
tab.

3. In the Service Name, type the name of the service that you want to define, for
example, Imperas License Manager. If you leave this field blank, the service will be
given a default name.
4. In the Path to the lmgrd.exe file field, enter or browse to lmgrd.exe for this license
server.
5. In the Path to the license file field, enter or browse to the license file for this license
server.
6. In the Path to the debug log file, enter or browse to the debug log file that this license
server writes.

4
5
6

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 69 of 92

.
 Imperas Installation and Getting Started Guide

7. Start the license server

8. Check the license server status

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 70 of 92

.
 Imperas Installation and Getting Started Guide

APPENDIX F Some Common Problems

F.1 Segmentation Fault when Native Debug of an OVP
Platform
When an ICM C platform is being debugged the simulation may stop with the message

Program received signal SIGSEGV, Segmentation fault.

This will have occurred in the call to icmInitplatform() when the licensing is initialized.
The latest version of the FlexLM licensing code utilized by the OVP and Imperas
products contains a feature that causes a segmentation fault when attempting to run under
a debugger.

This has no effect on the execution of the OVP virtual platform and it is possible to
continue the simulation and debugging the platform beyond this point. Simply continue
the simulation.

The following is the contents of an example .gdbinint script that may be used to ignore
this issue

handle SIGSEGV nostop

handle SIGSEGV noprint

The OVP and Imperas simulators also may use of the floating point exceptions during
simulation, these may be ignored when debugging by adding the following

handle SIGFPE nostop

handle SIGFPE noprint

Finally, additional options that we have found useful are

set break pending on

set backtrace limit 100

F.2 Simulator Reports Internal Abort (ASRT)

The simulator will only report an assertion when it has detected that the internal state is
no longer valid. This can be caused by a bug in the simulator, which should be reported to

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 71 of 92

.
 Imperas Installation and Getting Started Guide

Imperas including a test case 18 that can be used to reproduce the problem at the Imperas
site.

However, often these problems are caused when the simulator is being used incorrectly.

Asynchronous Calls to a running simulator

One such way is by making asynchronous calls to a running simulator. There must be no
asynchronous calls made to the running simulator. If the simulation is to be interrupted
the procedure that is described in the OVPsim and CpuManager User Guide must be
followed.

If this procedure is not followed the asynchronous calls can cause the simulator to be
interrupted during a system state update and hence the state can become corrupted.

When this occurs it is typical to see the following assertions reported by the simulator and
for the simulation to terminate.

> Internal Abort (ASRT)

>
/home/release/build/20130630.6/Imperas/SimCommon/source/morph/codeBlock.c:1407
> : Assertion failure : bad native address bounds

> Internal Abort (ASRT)

> /home/release/build/20130630.6/Imperas/SimCommon/source/morph/xRef.c:690
> : Assertion failure : resolved cross-reference found

F.3 Building on Windows using mingw32-make

F.3.1 Error in Makefile.pse when building peripherals

There is a known bug in the version of GNU make 3.80. This version is sometimes
installed as part of the MinGW installation as mingw32-make and will result in the error
shown below when attempting to build a peripheral model

/c/Imperas/Examples/Models/Peripherals/creatingDMAC/1.registers
$ mingw32-make NOVLNV=1
C:/Imperas/ImperasLib/buildutils/Makefile.pse:39: *** missing `endif'. Stop.

/c/Imperas/Examples/Models/Peripherals/creatingDMAC/1.registers
$

You can check the version of mingw32-make that you have installed with the command
mingw32-make --version

18
A test case should include the virtual platform source code, the application code being executed and clear
instructions of how to reproduce the problem. All these files should be sent as a zip or tar file. It is useful to
extract the files and check in a clean directory that the instructions sent can re-produce the problem.

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 72 of 92

.
 Imperas Installation and Getting Started Guide

$ mingw32-make --version
GNU Make 3.80
Copyright (C) 2002 Free Software Foundation, Inc.
This is free software; see the source for copying conditions.
There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE.

F.4 Licensing

F.4.1 feature not supported

If you get an error something like the following:

Error (LIC_NE) License not available. FLEXLM reports:

License server system does not support this feature.

Feature: IMP_OVPSIM
License path: C:\Imperas\bin\Windows\OVPsim.lic;
FLEXnet Licensing error:-18,147
For further information, refer to the FLEXnet Licensing End User Guide,
available at "www.macrovision.com".

License server system does not support this feature.

Feature: IMP_OVPSIM_20130630
License path: C:\Imperas\bin\Windows\OVPsim.lic;
FLEXnet Licensing error:-18,147
For further information, refer to the FLEXnet Licensing End User Guide,
available at "www.macrovision.com".

Fatal (LIC_FE) If you have a license from OVPworld, put it in

$IMPERAS_HOME/OVPsim.lic
Alternatively, set IMPERASD_LICENSE_FILE environment variable to your
license file or server location.
If you don't have a key, click on download at www.OVPworld.org
Info Exiting

You have not got the correct license FEATURE available in your license file.

In the above output you can see that the simulator first attempts to obtain the license
feature IMP_OVPSIM and then attempts to obtain the license feature
IMP_OVPSIM_20130630.
The feature IMP_OVPSIM may be obtained by contacting Imperas, this is a license that
can be used with any version of the OVPsim simulator.
The feature IMP_OVPSIM_20130630 is contained in licenses generated from the OVP
World license page automatically. It is generated for the current product version and can
only be used with that product version.

This license error could be caused by one of the following:

1. The license file has not been obtained
a. Check the license file does include this FEATURE

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 73 of 92

.
 Imperas Installation and Getting Started Guide

2. The incorrect license file is being used or the license file has been corrupted
a. Check the IMPERASD_LICENSE_FILE variable is pointing to the
correct license file or license server for floating licenses
b. Check the license file has not been corrupted. Use a hex editor to ensure
only valid ASCII characters and <CR>, <LF> are present
3. The incorrect simulator is being used
a. The incorrect IMPERAS_RUNTIME has been set.
If your license(s) are supplied by Imperas for the Imperas tools, the
IMPERAS_RUNTIME should be set to CpuManager so that the correct
Imperas licenses are used.
4. The simulator personality is not set correctly
a. The correct runtime and IMPERAS_PERSONALITY has been set.
The CpuManager simulator can be set to support different feature sets
using the IMPERAS_PERSONALITY environment variable. This also
means that different license features are required. See section

F.4.2 cannot access date server

If you get an error something like this:

Error (LIC_SRVNS) License not available. FLEXLM reports:

Bad Status connecting to internet date server.
Feature: IMP_OVPSIM_20120313
FLEXnet Licensing error:+97,210
Fatal (LIC_SRVNS) Exiting:
Info Exiting

For version locked licenses the simulator will access a date server. This error will occur if
the simulator is not able to connect to the internet.

You may get this if you are using an internet proxy server. In this case you need to inform
the Imperas products of the proxy server using the IMPERAS_PROXY_SERVER
environment variable. This is set to an <address>:<port> pair for the proxy server access.

For example

export IMPERAS_PROXY_SERVER=192.168.2.1:1234

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 74 of 92

.
 Imperas Installation and Getting Started Guide

F.5 Ethernet Adapter Naming/HostId is zero

If you get an error something like this:

Invalid host.
The hostid of this system does not match the hostid
specified in the license file.
Feature: IMP_OVPSIM_20100528.0
Hostid: 112233445566
License path: /home/Imperas.20130630/OVPsim.lic
FLEXnet Licensing error:-9,57. System Error: 19 "(null)"
For further information, refer to the FLEXnet Licensing End User Guide,
available at "www.macrovision.com".

The problem is caused by the FlexLM licensing used obtaining the MAC address, against
which the product is licensed, from the eth0 network interface.

If the network interface is enabled on a different device, e.g. eth1 the FlexLM software
does not read a valid MAC address and a NULL host Id is reported. This may be caused
because on modern operating systems Consistent Network Device Naming may be used,
see the following link for further information
http://fedoraproject.org/wiki/Features/ConsistentNetworkDeviceNaming

The solution is to enable the network interface on eth0 or to rename the network interface
to be eth0.

There are a number of ways this can be achieved, the following was taken from
http://www.science.uva.nl/research/air/wiki/LogicalInterfaceNames

F.5.1 How to change the default ens33 network device to old

eth0
The following URL explains the full procedure

http://unix.stackexchange.com/questions/81834/how-can-i-change-the-default-ens33-
network-device-to-old-eth0-on-fedora-19
The minimum set of stages that were required when performed are:
1. Edit /etc/default/grub. Note you need root privileges to edit this file.
2. At the end of GRUB_CMDLINE_LINUX line append "net.ifnames=0 biosdevname=0"
3. Save the file
4. type the command "grub2-mkconfig -o /boot/grub2/grub.cfg"
5. type the command reboot

F.5.2 How to reorder or rename logical interface names in Linux

One of the problems of Linux is that the order of the network interfaces is unpredictable.

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 75 of 92

.
 Imperas Installation and Getting Started Guide

Between reboots it usually stays the same, but often after an upgrade to a new kernel or
the addition or replacement of a network card (NIC) the order of all network interfaces
changes. For example, what used to be eth0 now becomes eth1 or eth2 or visa versa.

Obviously there is some logic to which network interface gets which name, but Linux
documentation states that this may change and no user or program should ever assume
anything about this. This is annoying, in particular if your management interface is at
eth1 at one node in a cluster and at eth2 in another node of the same cluster (which we
have experienced). I personally like to have my (primary) management interface always
to be eth0.

Thankfully, there are ways to achieve this. They can be divided in four methods:
1. Order the network interfaces based on physical properties of the NIC. (e.g. the physical
location in the machine)
2. Order the network interfaces based on the MAC address of the NIC.
3. Order the network interfaces based on the driver of the NIC.
4. Order the network interfaces based on the physical location of the NIC in the computer

So you have to pick a method that suits you. I recommend either to use ifrename (based
on physical properties, especially useful if you often change network cards in your hosts)
or writing a udev rule (based on the MAC address). However, I listed the other methods
as well. Be aware that the last two methods mentioned in this article are only for the
masochistic (you will scream and shoot to get those to work).

Note: Linux kernels up to 2.4 did only probe for the first Ethernet card, ignoring other
NICs. We assume you use a 2.6 or higher kernel or already fixed this, for example by
specifying ether=0,0,eth1 as kernel parameter.

F.5.3 Based on the physical properties

Perhaps the most elegant way to name the Ethernet NIC is to do so based on their
physical properties, like link speed and port type.

F.5.3.1 Using the ifrename tool

Ifrename is a tool specifically designed to (re)name network interfaces based on

characteristics like MAC address (wildcards supported), bus information, and hardware
settings. It uses a control file (/etc/iftab) to specify rules about how the interfaces will be
named. (thanks to Matt Baron for this tip.)

# Example /etc/iftab file

eth2 mac 08:00:09:DE:82:0E

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 76 of 92

.
 Imperas Installation and Getting Started Guide

eth3 driver wavelan interrupt 15 baseaddress 0x390

eth4 driver pcnet32 businfo 0000:02:05.0
# wildcard name: pick the lowest available name of air0,
air1, air2, etc.
air* mac 00:07:0E:* arp 1

F.5.3.2 Using the ethtool and ip programs

It is possible to check the NIC properties using the ethtool program, and to change the
name using the ip program (thanks to Jollynn Schmidt for this tip):

if ethtool eth0 | grep -q "Port: FIBRE"; then

ip link set dev eth0 name not_eth0
ip link set dev eth1 name eth0
ip link set dev not_eth0 name eth1
fi

The disadvantage of ethtool is that it can only be run by root, even when you're only
using it to query for information. Though this is a minor annoyance of ethtool, it does not
matter in this case, since you want to set a device name and thus need to be root anyway.

F.5.4 Based on the MAC address

Secondly, it is also possible to name the network interface based on the MAC address of
each NIC. The advantage is that it is possible to use this method if you have two NICs
which use the same driver (unlike the next method: based on driver).

First, you must determine the MAC address of your interfaces. You can do this locally on
a machine running

ifconfig -a

The MAC address is listed as "hwaddr" (hardware address). Alternatively, you can even
determine MAC addresses remotely using ping and /sbin/arp.

There are three ways to map the MAC address to the logical interface name. Either by
using the udev rules, with the get-mac-address.sh script, or by using the nameif program.

The udev method should work on all recent Linux distributions, and is recommended.
The get-mac-address.sh script and the nameif program are know to work with Debian,
while on Red Hat, you can change the interface configuration file.

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 77 of 92

.
 Imperas Installation and Getting Started Guide

F.5.4.1 Using udev rules

udev replaced devfs in Linux 2.6. First make sure that your Linux system has udev
installed, rather then devfs. If you have a /etc/udev directory, but not /etc/devfs directory,
you are probably fine. If not, be aware that changing your kernel from devfs to udev is
possible, but is not just a matter of adding a new module. Perhaps for now, another
method is easier for you.

Now that you have udev, it is rather simple. You only need to create a udev rule mapping
the MAC address to the interface name. Store this in a file inside
the/etc/udev/rules.d/ directory:

KERNEL=="eth?", SYSFS{address}=="00:37:e9:17:64:af",
NAME="eth0" # MAC of first NIC in lowercase
KERNEL=="eth?", SYSFS{address}=="00:21:e9:17:64:b5",
NAME="eth1" # MAC of second NIC in lowercase

Most distributions already come with an example config file for you.
E.g. /etc/udev/rules.d/network-devices.rules or /etc/udev/rules.d/010_netinterfaces.rules.
More information can be found
at http://www.reactivated.net/writing_udev_rules.html or http://www.debianhelp.co.uk/
udev.htm. (Thanks to Casey Scott and Ron Hermsen for the pointers.)

Another rule I've seen is:

SUBSYSTEM=="net", DRIVERS=="?*",
ATTRS{address}=="00:16:3e:00:02:00", NAME="eth0"
SUBSYSTEM=="net", DRIVERS=="?*",
ATTRS{address}=="00:16:3e:00:02:01", NAME="eth1"

I'm not sure about the difference between these rules. Information is welcome (please
leave a comment below)

F.5.4.2 Using the interface configuration file

If you run a Red-Hat-based distribution, you can simply add the MAC address in the
interface configuration file /etc/sysconfig/network-scripts/ifcfg-eth0:

DEVICE=eth0
HWADDR=00:37:e9:17:64:af

You can give it any DEVICE name you want, like DEVICE=ethmgmt, as long as you
remember to rename the config file:
/etc/sysconfig/network-scripts/ifcfg-ethmgmt
2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 78 of 92
.
 Imperas Installation and Getting Started Guide

Source: http://forums.serverwatch.com/showthread.php?t=18476

F.5.4.3 Using the get-mac-address.sh script

Another solution is to use the get-mac-address.sh script to map interface names by MAC
address. On Debian, this script is distributed as part of the ifupdown
package(in /usr/share/doc/ifupdown/examples/get-mac-address.sh). Copy this script to a
saner place (e.g. /usr/local/bin), and you can setup /etc/network/interfaces in this manner:

auto lo eth0 eth1

iface lo inet loopback

mapping eth0 eth1

script /usr/local/bin/get-mac-address.sh
map 00:37:E9:17:64:AF netA
map 00:21:E9:17:64:B5 netB

iface netA inet static

address etc...

iface netB inet static

address etc...

Source: https://www.gelato.unsw.edu.au/archives/gelato-technical/2004-
February/000334.html

The disadvantage of this method is that defines a mapping, rather then changing the
actual logical interface name.

F.5.4.4 Using the nameif program

Alternative to the get-mac-address.sh script, you can also use the slightly more
convenient nameif program, which is distributed as part of the net-tools package on
Debian.

The advantage of nameif is that you can specify the interface names in
the /etc/mactab file:

ethmgnt 00:37:E9:17:64:AF
ethwireless 00:21:E9:17:64:B5

It is not possible to rename an interface to a name of an existing interface. So you can't

rename eth1 to eth0 as long as eth0 still exists. It is possible to still swap the names eth0

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 79 of 92

.
 Imperas Installation and Getting Started Guide

and eth1 by using a temporary name (e.g. first rename eth1 to ethfoo, then eth0 to eth1
and finally ethfoo to eth0). Note that this method may lead to problems if you use
common names such as eth0 and eth1. If you upgrade a kernel, the names may be
different than you expected, and you may rename a NIC to eth0 while eth0 still exists,
leading to name collisions. Therefore, it is recommended to use other names like
"ethmgmnt", "ethwired", "ethwireless" and "eth10ge", as shown in the example above.

F.5.5 Based on the driver

Warning: This only works if the driver is available as a loadable module. Not if it is built
into the kernel.

This is a relative easy method, since it does not rely on external scripts. The idea is to just
load the kernel module for your eth0 interface before the modules for other network
cards.

First of all, you must determine which driver is used for each network card. Thankfully
Linux does have a system to load the appropriate driver automatically, based on the PCI
ID of the network card. Unfortunately, there is no single command to simply get the
driver (and other information like the link speed) based on just the interface name in
Linux. Your best bet is to look for kernel messages:

dmesg | grep eth

This should give you a good estimate of the driver name. You can verify if the name
indeed does exist and is loaded:

lsmod

Note:
lsmod gave:
e1000 84868 0
tg3 70816 0

However, the 0 indicates that these drivers are not controlling any device! That is strange,
since modprobe -r tg3 and modprobe -r e1000 do disable the network cards. Apparently,
this is a flaw in lsmod.

Note that running modprobe tg3 en then modprobe e1000 does bring them up in the
correct order, with the correct interface names. This is a good check if this approach
(using the driver to decide the interface name) can work.

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 80 of 92

.
 Imperas Installation and Getting Started Guide

F.5.5.5 Red Hat

In Red Hat, if the driver is called "tg3" (the Tigon driver), you simply specify the network
name by adding this entry in /etc/modules.conf:

~alias eth0 tg3

F.5.5.1 Debian
On a Debian system, /etc/modules.conf is generated automatically and should not be
edited directly. Instead, create a file in the subdirectory /etc/modules/ (do not
use /etc/modprobe.d/, that seems out-of-date). For example, create the
file /etc/modutils/interfaces and add the appropriate modules. For example:

alias eth0 tg3

alias eth1 e1000

Next, update /etc/modules.conf by running:

update-modules

Alternative method: I have encountered scenarios where the kernel did already load the
modules for the drivers, even before /etc/modules.conf was read. The result was that in
effect, the specification in /etc/modules.conf was ignored, and this method did not work.
As an alternative, it is possible to also list the drivers, in the appropriate order,
in /etc/modules (thus not /etc/modules.conf):

tg3
e1000

The result will be that the tg3 driver is loaded before the e1000 kernel.
Since /etc/modules only exists for Debian, this trick will most likely not work for other
distributions.

F.5.6 Based on the physical location in the computer

Warning: This only works if the driver is built into the kernel, not as a loadable module.

Note: It is relatively hard to get this to work, and we encountered problems with it. The
other methods are recommended.

It is possible to name the network interfaces based on the interrupt (IRQ) and memory
address. This should work if you have network cards in PCI busses, and it involves
appending the proper parameters to the "ether=" or "netdev=" kernel parameters.

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 81 of 92

.
 Imperas Installation and Getting Started Guide

First of all, you can detect the PCI slot of the devices using

lspci -v

This is reported to fail sometimes for certain cards. Now, write down the IRQ and IO
(memory) address of each network card, and use this information to specify the interface
name in your LILO or GRUB configuration file.

For LILO, you need to add an add line to the appropriate boot configuration. For
example:

append="netdev=irq=21,io=0x2040,name=eth0

netdev=irq=20,io=0x3000,name=eth1
netdev=irq18,io=0x2000,name=eth2"

Under grub, it can just be listed as parameter. e.g.:

kernel /boot/vmlinuz netdev=irq=24,name=eth0

F.5.7 Ubuntu directly changing logical names

The following information is taken from the page found at
https://help.ubuntu.com/10.04/serverguide/network-configuration.html

The Ethernet interface logical names are configured in the file

/etc/udev/rules.d/70-persistent-net.rules

If you would like control which interface receives a particular logical name, find the line
matching the interfaces physical MAC address and modify the value of NAME=ethX to
the desired logical name. Reboot the system to commit your changes.

F.5.8 More Information

http://www.tldp.org/HOWTO/Ethernet-HOWTO-8.html
http://www.tldp.org/HOWTO/BootPrompt-HOWTO-11.html

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 82 of 92

.
 Imperas Installation and Getting Started Guide

Written by Freek Dijkstra. Licensed under public domain. (That is, feel free to modify,
redistribute, cripple, or even sell it as your own work, and there is no need to mention the
source, even though you are of course welcome to do so.)

F.6 Cannot run license server (lmgrd) on Ubuntu

When you try and run the FlexLM license on Ubuntu you get an error

./lmgrd: No such file or directory

The FlexLM license manager daemon is not officially supported on Ubuntu, it is

supported on the RedHat Enterprise Linux distribution. It can, however, be used on the
Ubuntu Linux operating system.
For Ubuntu the LSB support package is required, if it is not already present.
This may be obtained using the command
sudo apt-get install lsb

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 83 of 92

.
 Imperas Installation and Getting Started Guide

APPENDIX G VLNV Library, Building Components and

Makefiles
G.1 Introduction
Windows and Unix present a number of challenges to engineers in the different ways file
structure paths are referenced, in particular the \ (backslash) versus / (slash)
differences, and the differences regarding the use of a (space) in a name, in Unix a
space is generally treated as a separator, whereas on Windows it can form part of a
filename without the need to be escaped.
In order to help overcome these issues a number of utilities, and included Makefiles have
been created, which will help in the building of Platforms, Processors, Peripherals and
Applications.

Take a look at the file Makefile, in the example Imperas/Examples/HelloWorld/usingICM

The first line of the Makefile is thus :-

IMPERAS_HOME := $(shell getpath.exe "$(IMPERAS_HOME)")

This line will modify a Windows long filename format, to the short filename format, so
that in the Makefile, the default value of IMPERAS_HOME is modified from
IMPERAS_HOME = C:\Program Files\Imperas
to
IMPERAS_HOME = C:/PROGRA~1/Imperas

Thus removing the space separator, which would cause a problem for the make
program.

NOTE
It is recommended to install in a location that does not contain a space, for example the
default installation for Windows is C:\Imperas

G.2 Common Makefiles included in other Makefile

G.2.1 $(IMPERAS_HOME)/bin/Makefile.include
This is included in all the standard Makefiles that are provided to pre-define a set of
standard variables:

include $(IMPERAS_HOME)/bin/Makefile.include

This included makefile, will provide the following variables to make :-

IMPERAS_LIB
This variable will point to the Imperas installation lib directory

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 84 of 92

.
 Imperas Installation and Getting Started Guide

IMPERAS_BIN
This variable will point to the Imperas installation bin directory

IMPERAS_VMISTUBS
This variable will point to a link library, required whilst producing a shared library
for a processor/semihosting library model.

IMPERAS_VMIINC
This variable will point to the ICM header files.

SIM_CFLAGS
This variable will contain a set of useful flags for compiling host specific code,
including setting paths for the VMI include files

SIM_LDFLAGS
This variable will contain a set of useful flags for linking host specific code,
including setting paths to runtime libraries (e.g., libOVPsim)

G.2.2
$(IMPERAS_HOME)/ImperasLib/buildutils/Makefile.common
This is included in standard Makefiles that are provided to pre-define variables to obtain
the source and dependency files and the VLNV library information for the source input
and target library output when building components:

include $(IMPERAS_HOME)/ImperasLib/buildutils/Makefile.common

This included Makefile, will check that the user has specified one of the following to
define the location for the output binary generation
NOVLNV=1 this will write files to the current directory
SYSTEMVLNV=1 this will overwrite, back to the system library
VLNVROOT=<path> this will write to a new VLNV, rooted at <path>

This included makefile, will provide the following variables to be used by other
Makefiles

OBJ
This variable will contain a list of all the object files found from all the *.c, *.cpp
and *.S files found in the source directory

DEP
This variable will contain a list of all the dependency files to be generated for the
*.c, *.cpp and *.S files found in the source directory

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 85 of 92

.
 Imperas Installation and Getting Started Guide

G.3 Component Library Makefiles

There are a number of Makefiles provided in the directory ImperasLib/buildutils to aid in
the building of components in the VLNV library.

For individual components, these are:

Makefile.harness : for building an executable from an OP harness.c file
Makefile.module : for building hierarchical components as native host shared objects.
These could be combinations of processor and peripheral models and
include other modules.
Makefile.pse : for building a pse.pse peripheral model shared object
Makefile.host : for building native host model shared objects , such as processor
models or intercept libraries.
Makefile.platform : (deprecated) for building an executable from an ICM platform.c file

For building the complete library of components, these are:

Makefile.library : this may be used to build the entire VLNV component library
Makefile.igen : uses the Imperas productivity tool igen to generate peripheral
model source code. Used by Makefile.library.

G.3.1 Building platforms : Makefile.harness

Include this in the Makefile found in a harness source directory

IMPERAS_HOME := $(shell getpath.exe "$(IMPERAS_HOME)")

include $(IMPERAS_HOME)/ImperasLib/buildutils/Makefile.harness

G.3.1 Building platforms : Makefile.module

Include this in the Makefile found in a module source directory

IMPERAS_HOME := $(shell getpath.exe "$(IMPERAS_HOME)")

include $(IMPERAS_HOME)/ImperasLib/buildutils/Makefile.module

G.3.2 Building peripheral behavioral code : Makefile.pse

Include this in the Makefile found in a peripheral model pse directory

IMPERAS_HOME := $(shell getpath.exe "$(IMPERAS_HOME)")

include $(IMPERAS_HOME)/ImperasLib/buildutils/Makefile.pse

G.3.3 Building native host code : Makefile.host

Include this in the Makefile found in a model directory and used for compiling models,
intercept (including semihosting) libraries and MMCs to native host code shared objects.

IMPERAS_HOME := $(shell getpath.exe "$(IMPERAS_HOME)")

include $(IMPERAS_HOME)/ImperasLib/buildutils/Makefile.host

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 86 of 92

.
 Imperas Installation and Getting Started Guide

G.3.1 Building platforms : Makefile.platform (deprecated)

This has been deprecated. You should now use harness and model directories and
Makefiles.

Include this in the Makefile found in a platform source directory

IMPERAS_HOME := $(shell getpath.exe "$(IMPERAS_HOME)")

include $(IMPERAS_HOME)/ImperasLib/buildutils/Makefile.platform

G.3.2 Building complete VLNV component library :

Makefile.library
Used with VLNVSRC and VLNVROOT to specify the root of the source directory and
the root of the output binary VLNV library directory respectively.

> make -f ImperasLib/buildutils/Makefile.library \

VLNVSRC=$IMPERAS_HOME/ImperasLib/source \
VLNVROOT=$IMPERAS_VLNV

It is recommended to run this from the VLNVSRC directory, this can be achieved using
the following

> make -C $IMPERAS_HOME/ImperasLib/source \

-f ImperasLib/buildutils/Makefile.library \
VLNVSRC=$IMPERAS_HOME/ImperasLib/source \
VLNVROOT=$IMPERAS_VLNV

NOTE
The build system requires that the output library, VLNVROOT, directory exists.
If you are building into your own library directory it may be required to create this
directory before invoking the Makefile.

This is also used to build your own library components in the following way

> mkdir -p $HOME/lib/$IMPERAS_ARCH/MyLib

> make -C $HOME/MyLib/source \
-f ImperasLib/buildutils/Makefile.library \
VLNVSRC=$HOME/MyLib/source \
VLNVROOT=$HOME/lib/$IMPERAS_ARCH/MyLib

G.3.3 SystemC TLM2 Platforms Makefile.TLM.platform

Used within a SystemC TLM platform source directory to invoke the building of a local
platform cpp file.

> make -f $IMPERAS_HOME/ImperasLib/buildutils/Makefile.TLM.platform \

PLATFORM=ArmIntegratorCP_tlm2.0

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 87 of 92

.
 Imperas Installation and Getting Started Guide

G.4 Selecting An Alternative Component Library

By default the Imperas VLNV library is selected using the IMPERAS_VLNV
environment variable, such as shown below

> export IMPERAS_VLNV=$IMPERAS_HOME/lib/$IMPERAS_ARCH/ImperasLib

This allows all components within this library to be found and used in platforms.

However, when you are creating custom components, they may be created using separate
source and binary libraries which are built using the Makefile described in the previous
section.

The IMPERAS_VLNV environment variable is a list of libraries to be searched. The list

uses a colon (:) as the separator on Linux and a semi-colon (;) as the separator on
Windows.

Thus if a new library, $THISHOME/myLib, is created with custom components we can

add this to the IMPERAS_VLNV search path,

For Linux, in a shell or shell script

> export IMPERAS_VLNV=$IMPERAS_VLNV:$THISHOME/myLib

And, for Windows, in a batch file

> set IMPERAS_VLNV=%IMPERAS_VLNV%;%THISHOME%/myLib

And, for Windows, in an MSYS/MINGW shell

Note that a semi-colon is used as the separator but it is also required to quote the
complete string so that it is not pre-processed by Windows but passed complete into the
OVPsim or Imperas product.

> export IMPERAS_VLNV=$IMPERAS_VLNV;$THISHOME/myLib

G.5 CrossCompiler Makefile includes

Each of the CrossCompilers which are shipped as packages, will install a file which can
be included into a Makefile intended to help cross compile applications to the targeted
processor.

Take a look at the Makefile, in the previous example Examples/HelloWorld/usingICM.

The lines in the Makefile are thus :-

CROSS?=OR1K
-include $(IMPERAS_LIB)/CrossCompiler/$(CROSS).makefile.include

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 88 of 92

.
 Imperas Installation and Getting Started Guide

This inclusion provides a number of variables including IMPERAS_CC,

IMPERAS_LINK, which can be seen in usage in the file Makefile.

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 89 of 92

.
 Imperas Installation and Getting Started Guide

APPENDIX H Abort Detected in Program

The Imperas and OVP products contain a function to trap aborts. This may trap aborts
caused anywhere in the execution flow i.e. it may not be specifically within the Imperas
product but in an application using or a user shared object loaded by the Imperas product.

As the Imperas/OVP simulators load shared objects for processor models, peripheral
models and intercept (including semihost) libraries it is possible that a segmentation fault
or abort can be caused in the loaded code.

This may appear to be a fault of the simulator but this is unlikely. It is more likely to be a
fault in one of the models or platforms that are loaded by the simulator. The following
can be used to help you find the problem in the software that you have created.

An abort will be reported in the following manner. For an example, an abort has been
caused in the virtual platform when run using the command line

OVPsim_single_arm_Cortex-A_tlm2.0.Linux32.exe dhrystone.ARM_CORTEX_A15.elf

The abort is reported during the run as follows

SystemC 2.3.0-ASI --- Jun 6 2013 16:33:50

Copyright (c) 1996-2012 by all Contributors,
ALL RIGHTS RESERVED

CpuManager (32-Bit) v99999999 Open Virtual Platform simulator from

www.IMPERAS.com.
Copyright (c) 2005-2013 Imperas Software Ltd. Contains Imperas Proprietary
Information.
Licensed Software, All Rights Reserved.
Visit www.IMPERAS.com for multicore debug, verification and analysis solutions.

CpuManager started: Mon Jun 24 16:28:41 2013

<snip>

Internal Abort (ABRT) Imperas/Common/source/targetOS/tosSignal.c:656 : Abort

reached.
Uncaught Exception (SIGSEGV) at 0x5b5d30

This could be due to an error in your native code (for example the platform,
semihost library etc.) or an error in the simulator.
Use the following approaches to try to find the source of the error:
1. Rerun the simulation under a debugger.
2. Set environment variable IMPERAS_BACKTRACE=1 to generate a backtrace (Linux
only).
3. Set environment variable IMPERAS_LOOP_ON_EXCEPTION=1 to cause the simulator
to enter a wait loop on exception, so that a debugger can be attached.
If you believe the error originates within the simulator, please contact Imperas
support (support@imperas.com)
Info Exiting

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 90 of 92

.
 Imperas Installation and Getting Started Guide

To aid in tracking down the cause of the abort there are two features, explained in the
abort output

H.1 Obtaining Backtrace

A backtrace can be generated, on Linux only, which may help you determine if the error
originates in the code that you have added. The following shows the same platform run
with the IMPERAS_BACKTRACE=1 set on the command line, i.e.

IMPERAS_BACKTRACE=1 OVPsim_single_arm_Cortex-A_tlm2.0.Linux32.exe
dhrystone.ARM_CORTEX_A15.elf

And this results in the following extra information

*** backtrace 19 stack frames:

-------------------------------
/home/graham/Imperas/bin/Linux32/libCpuManager.so(+0x8923b) [0x2e523b]
/home/graham/Imperas/bin/Linux32/libCpuManager.so(+0x892e5) [0x2e52e5]
/home/graham/Imperas/bin/Linux32/libCpuManager.so(+0x8932a) [0x2e532a]
/home/graham/Imperas/bin/Linux32/libCpuManager.so(+0x8930c) [0x2e530c]
/home/graham/Imperas/bin/Linux32/libCpuManager.so(+0x1db4eb) [0x4374eb]
/home/graham/Imperas/bin/Linux32/libCpuManager.so(+0x1db64b) [0x43764b]
[0xf1e40c]
/user/systemc-2.3.0/lib-linux/libsystemc-2.3.0.so(bindingEv+0x49) [0x18ff19]
/user/systemc-2.3.0/lib-linux/libsystemc-2.3.0.so(elab_doneEv+0x1f) [0x19012f]
/user/systemc-2.3.0/lib-linux/libsystemc-2.3.0.so(elabEv+0x14c) [0x174bfc]
/user/systemc-2.3.0/lib-linux/libsystemc-2.3.0.so(initEb+0x30) [0x176b60]
/user/systemc-2.3.0/lib-linux/libsystemc-2.3.0.so(_7scimeE+0x2d) [0x176c2d]
/user/systemc-2.3.0/lib-linux/libsystemc-2.3.0.so(20sc_stvpolE+0xdc) [0x1778ec]
/user/systemc-2.3.0/lib-linux/libsystemc-2.3.0.so(_startEv+0x73) [0x177b83]
OVPsim_single_arm_Cortex-A_tlm2.0.Linux32.exe(sc_main+0x1d5) [0x805109f]
/user/systemc-2.3.0/lib-linux/libsystemc-2.3.0.so(sc_elab+0xa4) [0x163b94]
/user/systemc-2.3.0/lib-linux/libsystemc-2.3.0.so(main+0x32) [0x163a02]
/lib/libc.so.6(__libc_start_main+0xe6) [0xad1bb6]
OVPsim_single_arm_Cortex-A_tlm2.0.Linux32.exe(__gxx_person_v0+0x159) [0x8050841]

Internal Abort (ABRT) Imperas/Common/source/targetOS/tosSignal.c:630 : Abort

reached.
Uncaught Exception (SIGSEGV) at 0x18fd30

Info Exiting

H.2 Connecting a Debugger to a running simulation

The simulator can be forced to wait at exit for a debugger to be connected.

The following shows the same platform run with the environment variable
IMPERAS_LOOP_ON_EXCEPTION=1 set on the command line, i.e.

IMPERAS_LOOP_ON_EXCEPTION=1 OVPsim_single_arm_Cortex-A_tlm2.0.Linux32.exe
dhrystone.ARM_CORTEX_A15.elf

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 91 of 92

.
 Imperas Installation and Getting Started Guide

This simulation will not finish. In a separate shell you can now start a suitable host
debugger and examine the running processes on the host for the one running your
platform executable, for example OVPsim_single_arm_Cortex-A_tlm2.0.Linux32.exe in
this case.

##

2016 Imperas Software Limited www.imperas.com/www.OVPworld.org Page 92 of 92

.