Blame lib/README

Packit bcb633
Packit bcb633
Packit bcb633
========================================================================
Packit bcb633
README for PQoS/Intel(R) RDT library
Packit bcb633
Packit bcb633
April 2016
Packit bcb633
========================================================================
Packit bcb633
Packit bcb633
Packit bcb633
Contents
Packit bcb633
========
Packit bcb633
Packit bcb633
- Overview
Packit bcb633
- Installation
Packit bcb633
- Legal Disclaimer
Packit bcb633
Packit bcb633
Packit bcb633
Overview
Packit bcb633
========
Packit bcb633
Packit bcb633
PQoS library provides API to detect and configure Intel(R) RDT including:
Packit bcb633
Cache Monitoring Technology (CMT), Memory Bandwidth Monitoring (MBM),
Packit bcb633
Cache Allocation Technology (CAT), Code and Data Prioritization (CDP) Technology.
Packit bcb633
For more information about Intel(R) RDT please see top level README.
Packit bcb633
Packit bcb633
Packit bcb633
Installation
Packit bcb633
============
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 library:
Packit bcb633
$ make
Packit bcb633
$ sudo make install
Packit bcb633
Packit bcb633
By default make builds shared library.
Packit bcb633
Packit bcb633
"make" accepts extra options e.g.:
Packit bcb633
"SHARED=n" - for static library
Packit bcb633
"DEBUG=y" - for library for debugging
Packit bcb633
Packit bcb633
"sudo make install" installs compiled library into system directories.
Packit bcb633
Packit bcb633
By default, library files are installed in "lib" directory below "/usr/local"
Packit bcb633
but it can be changed with use of PREFIX to install files below "/some/where":
Packit bcb633
$ sudo make install PREFIX=/some/where
Packit bcb633
Packit bcb633
Library files can be removed but the same PREFIX has to be
Packit bcb633
used for uninstall and install targets.
Packit bcb633
Packit bcb633
To remove files from below default PREFIX:
Packit bcb633
$ sudo make uninstall
Packit bcb633
Packit bcb633
To remove from below /some/where:
Packit bcb633
$ sudo make uninstall PREFIX=/some/where
Packit bcb633
Packit bcb633
For more info about make targets, please run "make help" command.
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.