pqos(8)
NAME
pqos - Intel(R) Resource Director Technology monitoring and control tool
SYNOPSIS
pqos [OPTIONS]...
DESCRIPTION
Intel(R) Resource Director Technology is designed to monitor and manage cpu resources and improve performance of applications and virtual machines. Intel(R) Resource Director Technology includes monitoring and control technologies. Monitoring technologies include CMT (Cache Monitoring Technology), which monitors occupancy of last level cache, and MBM (Memory Bandwidth Monitoring). Control technologies include CAT (Cache Allocation Technology) and CDP (Code Data Prioritization). pqos supports CMT and MBM on a per core or hardware thread basis. MBM supports two types of events reporting local and remote memory bandwidth. For hardware information please refer to the README located on: https://github.com/01org/intel-cmt-cat/blob/master/README
OPTIONS
pqos options are as follow:
-h, --help
show help
-v, --verbose
verbose mode
-V, --super-verbose
super-verbose mode
-l FILE, --log-file=FILE
log messages into selected log FILE
-s, --show
show the current allocation and monitoring configuration
-f FILE, --config-file=FILE
load commands from selected configuration FILE
-e CLASSDEF, --alloc-class=CLASSDEF
define the allocation classes on all CPU sockets. CLASSDEF
format is "TYPE:ID=DEFINITION;...".
define classes for selected CPU sockets. CLASSDEF format is
"TYPE[@SOCK_LIST]:ID=DEFINITION;...".
For CAT, TYPE is "llc", ID is a CLOS number and DEFINITION is a
bitmask.
Note: When CDP is on, ID can be postfixed with 'D' for data or
'C' for code.
For example: "-e
llc:0=0xffff;llc:1=0x00ff;llc@0-1:2=0xff00;l2:2=0x3f;l2@2:1=0xf",
or for CDP: "-e llc:0d=0xfff;llc:0c=0xfff00."
-a CLASS2CORE, --alloc-assoc=CLASS2CORE
associate allocation classes with cores. CLASS2CORE format is
"TYPE:ID=CORE_LIST;...".
For CAT, TYPE is "llc" and ID is a class number. CORE_LIST is
comma or dash separated list of cores.
For example "-a llc:0=0,2,4,6-10;llc:1=1;" associates cores 0,
2, 4, 6, 7, 8, 9, 10 with CAT class 0 and core 1 with class 1.
-R [CONFIG], --alloc-reset[=CONFIG]
reset allocation setting (L3 CAT, L2 CAT) and reconfigure L3
CDP. CONFIG is one of the following options:
l3cdp-on sets L3 CDP on
l3cdp-off sets L3 CDP off
l3cdp-any keep current L3 CDP setting (default)
-m EVTCORES, --mon-core=EVTCORES
select the cores and events for monitoring, EVTCORES format is
"EVENT:CORE_LIST". Valid EVENT settings are:
- "llc" for CMT (LLC occupancy)
- "mbr" for MBR (remote memory bandwidth)
- "mbl" for MBL (local memory bandwidth)
- "all" or "" for all detected event types
CORE_LIST is comma or dash separated list of cores.
Example "-m all:0,2,4-10;llc:1,3;mbr:11-12".
Core statistics can be grouped by enclosing the core list in
square brackets.
Example "-m llc:[0-3];all:[4,5,6];mbr:[0-3],7,8".
-p EVTPIDS, --mon-pid=EVTPIDS
select the process ids and events to monitor, EVTPIDS format is
"EVENT:PID_LIST". See -m option for valid EVENT settings.
PID_LIST is comma separated list of process ids.
Examples "-p llc:22,25673" or "-p all:892,4588-4592".
Note: it is not possible to track both processes and cores at
the same time.
Note: Process tracking depends on the library to be built with
PID API.
-T, --mon-top
enable top like monitoring output sorted by highest LLC
occupancy
-o FILE, --mon-file FILE
select output FILE to store monitored data in, the default is
'stdout'
-u TYPE, --mon-file-type=TYPE
select the output format TYPE for monitored data. Supported TYPE
settings are: "text" (default), "xml" and "csv".
-i INTERVAL, --mon-interval=INTERVAL
define monitoring sampling INTERVAL in 100ms units, 1=100ms,
default 10=10x100ms=1s
-t SECONDS, --mon-time=SECONDS
define monitoring time in seconds, use 'inf' or 'infinite' for
infinite monitoring. Use CTRL+C to stop monitoring at any time.
-r, --mon-reset
reset monitoring and use all RMID's and cores in the system
-H, --profile-list
list supported allocation profiles
-c PROFILE, --profile-set=PROFILE
select a PROFILE from predefined allocation classes, use -H to
list available profiles
NOTES
CMT, MBM and CAT are configured using Model Specific Registers (MSRs). The pqos software executes in user space, and access to the MSRs is obtained through a standard Linux* interface. The msr file interface is protected and requires root privileges. The msr driver might not be auto-loaded and on some modular kernels the driver may need to be loaded manually: For Linux: sudo modprobe msr For FreeBSD: sudo kldload cpuctl
SEE ALSO
msr(4)
AUTHOR
pqos was written by Tomasz Kantecki <tomasz.kantecki@intel.com>, Marcel
Cornu <marcel.d.cornu@intel.com>
This is free software; see the source for copying conditions. There is
NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE.
September 20, 2016 PQOS(8)
Opportunity
Personal Opportunity - Free software gives you access to billions of dollars of software at no cost. Use this software for your business, personal use or to develop a profitable skill. Access to source code provides access to a level of capabilities/information that companies protect though copyrights. Open source is a core component of the Internet and it is available to you. Leverage the billions of dollars in resources and capabilities to build a career, establish a business or change the world. The potential is endless for those who understand the opportunity.
Business Opportunity - Goldman Sachs, IBM and countless large corporations are leveraging open source to reduce costs, develop products and increase their bottom lines. Learn what these companies know about open source and how open source can give you the advantage.
Free Software
Free Software provides computer programs and capabilities at no cost but more importantly, it provides the freedom to run, edit, contribute to, and share the software. The importance of free software is a matter of access, not price. Software at no cost is a benefit but ownership rights to the software and source code is far more significant.
Free Office Software - The Libre Office suite provides top desktop productivity tools for free. This includes, a word processor, spreadsheet, presentation engine, drawing and flowcharting, database and math applications. Libre Office is available for Linux or Windows.
Free Books
The Free Books Library is a collection of thousands of the most popular public domain books in an online readable format. The collection includes great classical literature and more recent works where the U.S. copyright has expired. These books are yours to read and use without restrictions.
Source Code - Want to change a program or know how it works? Open Source provides the source code for its programs so that anyone can use, modify or learn how to write those programs themselves. Visit the GNU source code repositories to download the source.
Education
Study at Harvard, Stanford or MIT - Open edX provides free online courses from Harvard, MIT, Columbia, UC Berkeley and other top Universities. Hundreds of courses for almost all major subjects and course levels. Open edx also offers some paid courses and selected certifications.
Linux Manual Pages - A man or manual page is a form of software documentation found on Linux/Unix operating systems. Topics covered include computer programs (including library and system calls), formal standards and conventions, and even abstract concepts.
