.\" Hey, EMACS: -*- nroff -*- .\" First parameter, NAME, should be all caps .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection .\" other parameters are allowed: see man(7), man(1) .TH PQOS 8 "September 20, 2016" .\" Please adjust this date whenever revising the manpage. .\" .\" Some roff macros, for reference: .\" .nh disable hyphenation .\" .hy enable hyphenation .\" .ad l left justify .\" .ad b justify to both left and right margins .\" .nf disable filling .\" .fi enable filling .\" .br insert line break .\" .sp insert n+1 empty lines .\" for manpage-specific macros, see man(7) .SH NAME pqos \- Intel(R) Resource Director Technology monitoring and control tool .br .SH SYNOPSIS .B pqos .RI [ OPTIONS ]... .SH DESCRIPTION Intel(R) Resource Director Technology is designed to monitor and manage cpu resources and improve performance of applications and virtual machines. .PP 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). .PP 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. .PP For hardware information please refer to the README located on: https://github.com/01org/intel-cmt-cat/blob/master/README .SH OPTIONS pqos options are as follow: .TP .B \-h, \-\-help show help .TP .B \-v, \-\-verbose verbose mode .TP .B \-V, \-\-super\-verbose super-verbose mode .TP .B \-l FILE, \-\-log\-file=FILE log messages into selected log FILE .TP .B \-s, \-\-show show the current allocation and monitoring configuration .TP .B \-f FILE, \-\-config\-file=FILE load commands from selected configuration FILE .TP .B \-e CLASSDEF, \-\-alloc\-class=CLASSDEF define the allocation classes on all CPU sockets. CLASSDEF format is "TYPE:ID=DEFINITION;...". .br define classes for selected CPU sockets. CLASSDEF format is "TYPE[@SOCK_LIST]:ID=DEFINITION;...". .br For CAT, TYPE is "llc", ID is a CLOS number and DEFINITION is a bitmask. .br .B Note: When CDP is on, ID can be postfixed with 'D' for data or 'C' for code. .br 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." .TP .B \-a CLASS2CORE, \-\-alloc\-assoc=CLASS2CORE associate allocation classes with cores. CLASS2CORE format is "TYPE:ID=CORE_LIST;...". .br For CAT, TYPE is "llc" and ID is a class number. CORE_LIST is comma or dash separated list of cores. .br 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. .TP .B \-R [CONFIG], \-\-alloc\-reset[=CONFIG] reset allocation setting (L3 CAT, L2 CAT) and reconfigure L3 CDP. CONFIG is one of the following options: .br l3cdp-on sets L3 CDP on .br l3cdp-off sets L3 CDP off .br l3cdp-any keep current L3 CDP setting (default) .TP .B \-m EVTCORES, \-\-mon\-core=EVTCORES select the cores and events for monitoring, EVTCORES format is "EVENT:CORE_LIST". Valid EVENT settings are: .br \- "llc" for CMT (LLC occupancy) .br \- "mbr" for MBR (remote memory bandwidth) .br \- "mbl" for MBL (local memory bandwidth) .br \- "all" or "" for all detected event types .br CORE_LIST is comma or dash separated list of cores. .br Example "-m all:0,2,4-10;llc:1,3;mbr:11-12". .br Core statistics can be grouped by enclosing the core list in square brackets. .br Example "-m llc:[0-3];all:[4,5,6];mbr:[0-3],7,8". .TP .B \-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. .br Examples "-p llc:22,25673" or "-p all:892,4588-4592". .br .B Note: it is not possible to track both processes and cores at the same time. .br .B Note: Process tracking depends on the library to be built with PID API. .TP .B \-T, \-\-mon-top enable top like monitoring output sorted by highest LLC occupancy .TP .B \-o FILE, \-\-mon-file FILE select output FILE to store monitored data in, the default is 'stdout' .TP .B \-u TYPE, \-\-mon-file-type=TYPE select the output format TYPE for monitored data. Supported TYPE settings are: "text" (default), "xml" and "csv". .TP .B \-i INTERVAL, \-\-mon-interval=INTERVAL define monitoring sampling INTERVAL in 100ms units, 1=100ms, default 10=10x100ms=1s .TP .B \-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. .TP .B \-r, \-\-mon\-reset reset monitoring and use all RMID's and cores in the system .TP .B \-H, \-\-profile\-list list supported allocation profiles .TP .B \-c PROFILE, \-\-profile\-set=PROFILE select a PROFILE from predefined allocation classes, use \-H to list available profiles .SH NOTES .PP 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: .PP For Linux: .br sudo modprobe msr .PP For FreeBSD: .br sudo kldload cpuctl .SH SEE ALSO .BR msr (4) .SH AUTHOR pqos was written by Tomasz Kantecki , Marcel Cornu .P This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.