|
Packit |
bcb633 |
|
|
Packit |
bcb633 |
|
|
Packit |
bcb633 |
========================================================================
|
|
Packit |
bcb633 |
INSTALLATION Instructions for Intel(R) RDT Software Package
|
|
Packit |
bcb633 |
|
|
Packit |
bcb633 |
April 2016
|
|
Packit |
bcb633 |
|
|
Packit |
bcb633 |
========================================================================
|
|
Packit |
bcb633 |
|
|
Packit |
bcb633 |
|
|
Packit |
bcb633 |
Contents
|
|
Packit |
bcb633 |
========
|
|
Packit |
bcb633 |
|
|
Packit |
bcb633 |
- Overview
|
|
Packit |
bcb633 |
- Installation Steps
|
|
Packit |
bcb633 |
- Linux Requirements
|
|
Packit |
bcb633 |
- FreeBSD Requirements (experimental)
|
|
Packit |
bcb633 |
- Legal Disclaimer
|
|
Packit |
bcb633 |
|
|
Packit |
bcb633 |
|
|
Packit |
bcb633 |
Installation Steps
|
|
Packit |
bcb633 |
==================
|
|
Packit |
bcb633 |
|
|
Packit |
bcb633 |
For installation of the software package untar the gzip image and follow
|
|
Packit |
bcb633 |
below instructions. As the results the following components will be built and
|
|
Packit |
bcb633 |
installed:
|
|
Packit |
bcb633 |
- PQoS DSO and its header file (libpqos.so and pqos.h)
|
|
Packit |
bcb633 |
- PQoS utility executable (pqos)
|
|
Packit |
bcb633 |
- PQoS utility MSR wrapper script
|
|
Packit |
bcb633 |
- PQoS utility OS/Kernel wrapper script
|
|
Packit |
bcb633 |
- PQoS man page (pqos.8)
|
|
Packit |
bcb633 |
- rdtset tool executable (rdtset)
|
|
Packit |
bcb633 |
- rdtset man page (rdtset.8)
|
|
Packit |
bcb633 |
|
|
Packit |
bcb633 |
NOTE to FreeBSD users, remember to replace "make" with "gmake" in
|
|
Packit |
bcb633 |
the steps described below.
|
|
Packit |
bcb633 |
|
|
Packit |
bcb633 |
The following steps are required to compile and install the package:
|
|
Packit |
bcb633 |
$ make
|
|
Packit |
bcb633 |
$ sudo make install
|
|
Packit |
bcb633 |
|
|
Packit |
bcb633 |
"make" compiles all software components of the package.
|
|
Packit |
bcb633 |
"sudo make install" installs compiled files into system directories.
|
|
Packit |
bcb633 |
|
|
Packit |
bcb633 |
By default, files are installed below /usr/local but it can be changed
|
|
Packit |
bcb633 |
with use of PREFIX to install files below /some/where:
|
|
Packit |
bcb633 |
$ sudo make install PREFIX=/some/where
|
|
Packit |
bcb633 |
|
|
Packit |
bcb633 |
Software package files can be removed but the same PREFIX has to be
|
|
Packit |
bcb633 |
used for uninstall and install targets.
|
|
Packit |
bcb633 |
To remove files from below default PREFIX:
|
|
Packit |
bcb633 |
$ sudo make uninstall
|
|
Packit |
bcb633 |
To remove from below /some/where:
|
|
Packit |
bcb633 |
$ sudo make uninstall PREFIX=/some/where
|
|
Packit |
bcb633 |
|
|
Packit |
bcb633 |
Software package files can be cleaned with "make clean" command.
|
|
Packit |
bcb633 |
|
|
Packit |
bcb633 |
NOTE
|
|
Packit |
bcb633 |
If you require system wide interface enforcement you can do so by setting the
|
|
Packit |
bcb633 |
"RDT_IFACE" environment variable.
|
|
Packit |
bcb633 |
|
|
Packit |
bcb633 |
Linux
|
|
Packit |
bcb633 |
=====
|
|
Packit |
bcb633 |
|
|
Packit |
bcb633 |
CMT, MBM and CAT are configured using Model Specific Registers (MSRs)
|
|
Packit |
bcb633 |
to measure occupancy, set up the class of service masks and manage
|
|
Packit |
bcb633 |
the association of the cores/logical threads to a class of service.
|
|
Packit |
bcb633 |
The pqos software executes in user space, and access to the MSRs is
|
|
Packit |
bcb633 |
obtained through a standard Linux* interface. The virtual file system
|
|
Packit |
bcb633 |
structure /dev/cpu/CPUNUM/msr provides an interface to read and write
|
|
Packit |
bcb633 |
the MSRs. The msr file interface is protected and requires root
|
|
Packit |
bcb633 |
privileges. The msr driver might not be auto-loaded and on some
|
|
Packit |
bcb633 |
modular kernels the driver may need to be loaded manually:
|
|
Packit |
bcb633 |
|
|
Packit |
bcb633 |
$ modprobe msr
|
|
Packit |
bcb633 |
|
|
Packit |
bcb633 |
For instructions on package installation please see "Installation Steps"
|
|
Packit |
bcb633 |
section.
|
|
Packit |
bcb633 |
|
|
Packit |
bcb633 |
|
|
Packit |
bcb633 |
FreeBSD (experimental)
|
|
Packit |
bcb633 |
======================
|
|
Packit |
bcb633 |
|
|
Packit |
bcb633 |
CMT, MBM and CAT are configured using Model Specific Registers (MSRs)
|
|
Packit |
bcb633 |
to measure occupancy, set up the class of service masks and manage
|
|
Packit |
bcb633 |
the association of the cores/logical threads to a class of service.
|
|
Packit |
bcb633 |
The pqos software executes in user space, and access to the MSRs is
|
|
Packit |
bcb633 |
obtained through a standard FreeBSD* cpuctl driver interface. The virtual
|
|
Packit |
bcb633 |
file system structure /dev/cpuctlCPUNUM provides an interface to read
|
|
Packit |
bcb633 |
and write the MSR registers. The MSR file interface is protected and
|
|
Packit |
bcb633 |
requires root privileges.
|
|
Packit |
bcb633 |
The cpuctl driver might not be auto-loaded on some systems. Please follow
|
|
Packit |
bcb633 |
cpuctl (4) man page to load cpuctl driver on your system.
|
|
Packit |
bcb633 |
|
|
Packit |
bcb633 |
$ man 4 cpuctl
|
|
Packit |
bcb633 |
|
|
Packit |
bcb633 |
Please note that all project build scripts have been written for GNU Make so
|
|
Packit |
bcb633 |
it is required to install GNU Make on FreeBSD in order to compile the project.
|
|
Packit |
bcb633 |
|
|
Packit |
bcb633 |
$ pkg install gmake
|
|
Packit |
bcb633 |
|
|
Packit |
bcb633 |
For instructions on package installation please see "Installation Steps"
|
|
Packit |
bcb633 |
section. Remember to replace "make" with "gmake" on FreeBSD.
|
|
Packit |
bcb633 |
|
|
Packit |
bcb633 |
Currently verified configuration is:
|
|
Packit |
bcb633 |
- Intel(R) Xeon(R) processor D
|
|
Packit |
bcb633 |
- FreeBSD 9.1
|
|
Packit |
bcb633 |
- GNU Compiler Collection 5 (gcc 5.3.1)
|
|
Packit |
bcb633 |
- GNU Make 4.1
|
|
Packit |
bcb633 |
|
|
Packit |
bcb633 |
|
|
Packit |
bcb633 |
Legal Disclaimer
|
|
Packit |
bcb633 |
================
|
|
Packit |
bcb633 |
|
|
Packit |
bcb633 |
THIS SOFTWARE IS PROVIDED BY INTEL"AS IS". NO LICENSE, EXPRESS OR
|
|
Packit |
bcb633 |
IMPLIED, BY ESTOPPEL OR OTHERWISE, TO ANY INTELLECTUAL PROPERTY RIGHTS
|
|
Packit |
bcb633 |
ARE GRANTED THROUGH USE. EXCEPT AS PROVIDED IN INTEL'S TERMS AND
|
|
Packit |
bcb633 |
CONDITIONS OF SALE, INTEL ASSUMES NO LIABILITY WHATSOEVER AND INTEL
|
|
Packit |
bcb633 |
DISCLAIMS ANY EXPRESS OR IMPLIED WARRANTY, RELATING TO SALE AND/OR
|
|
Packit |
bcb633 |
USE OF INTEL PRODUCTS INCLUDING LIABILITY OR WARRANTIES RELATING TO
|
|
Packit |
bcb633 |
FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR INFRINGEMENT
|
|
Packit |
bcb633 |
OF ANY PATENT, COPYRIGHT OR OTHER INTELLECTUAL PROPERTY RIGHT.
|