Skip to content

Commit a8ed59a

Browse files
aeglIngo Molnar
authored andcommitted
Documentation/x86: Document that resctrl bandwidth control units are MiB
The memory bandwidth software controller uses 2^20 units rather than 10^6. See mbm_bw_count() which computes bandwidth using the "SZ_1M" Linux define for 0x00100000. Update the documentation to use MiB when describing this feature. It's too late to fix the mount option "mba_MBps" as that is now an established user interface. Signed-off-by: Tony Luck <[email protected]> Signed-off-by: Ingo Molnar <[email protected]> Link: https://lore.kernel.org/r/[email protected]
1 parent f2208aa commit a8ed59a

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

Documentation/arch/x86/resctrl.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ mount options are:
4545
Enable code/data prioritization in L2 cache allocations.
4646
"mba_MBps":
4747
Enable the MBA Software Controller(mba_sc) to specify MBA
48-
bandwidth in MBps
48+
bandwidth in MiBps
4949
"debug":
5050
Make debug files accessible. Available debug files are annotated with
5151
"Available only with debug option".
@@ -526,7 +526,7 @@ threads start using more cores in an rdtgroup, the actual bandwidth may
526526
increase or vary although user specified bandwidth percentage is same.
527527

528528
In order to mitigate this and make the interface more user friendly,
529-
resctrl added support for specifying the bandwidth in MBps as well. The
529+
resctrl added support for specifying the bandwidth in MiBps as well. The
530530
kernel underneath would use a software feedback mechanism or a "Software
531531
Controller(mba_sc)" which reads the actual bandwidth using MBM counters
532532
and adjust the memory bandwidth percentages to ensure::
@@ -573,13 +573,13 @@ Memory b/w domain is L3 cache.
573573

574574
MB:<cache_id0>=bandwidth0;<cache_id1>=bandwidth1;...
575575

576-
Memory bandwidth Allocation specified in MBps
576+
Memory bandwidth Allocation specified in MiBps
577577
---------------------------------------------
578578

579579
Memory bandwidth domain is L3 cache.
580580
::
581581

582-
MB:<cache_id0>=bw_MBps0;<cache_id1>=bw_MBps1;...
582+
MB:<cache_id0>=bw_MiBps0;<cache_id1>=bw_MiBps1;...
583583

584584
Slow Memory Bandwidth Allocation (SMBA)
585585
---------------------------------------

0 commit comments

Comments
 (0)