@@ -35,7 +35,7 @@ about the feature from resctrl's info directory.
3535
3636To use the feature mount the file system::
3737
38- # mount -t resctrl resctrl [-o cdp[,cdpl2][,mba_MBps]] /sys/fs/resctrl
38+ # mount -t resctrl resctrl [-o cdp[,cdpl2][,mba_MBps][,debug] ] /sys/fs/resctrl
3939
4040mount options are:
4141
@@ -46,6 +46,9 @@ mount options are:
4646"mba_MBps":
4747 Enable the MBA Software Controller(mba_sc) to specify MBA
4848 bandwidth in MBps
49+ "debug":
50+ Make debug files accessible. Available debug files are annotated with
51+ "Available only with debug option".
4952
5053L2 and L3 CDP are controlled separately.
5154
@@ -124,6 +127,13 @@ related to allocation:
124127 "P":
125128 Corresponding region is pseudo-locked. No
126129 sharing allowed.
130+ "sparse_masks":
131+ Indicates if non-contiguous 1s value in CBM is supported.
132+
133+ "0":
134+ Only contiguous 1s value in CBM is supported.
135+ "1":
136+ Non-contiguous 1s value in CBM is supported.
127137
128138Memory bandwidth(MB) subdirectory contains the following files
129139with respect to allocation:
@@ -299,7 +309,14 @@ All groups contain the following files:
299309"tasks":
300310 Reading this file shows the list of all tasks that belong to
301311 this group. Writing a task id to the file will add a task to the
302- group. If the group is a CTRL_MON group the task is removed from
312+ group. Multiple tasks can be added by separating the task ids
313+ with commas. Tasks will be assigned sequentially. Multiple
314+ failures are not supported. A single failure encountered while
315+ attempting to assign a task will cause the operation to abort and
316+ already added tasks before the failure will remain in the group.
317+ Failures will be logged to /sys/fs/resctrl/info/last_cmd_status.
318+
319+ If the group is a CTRL_MON group the task is removed from
303320 whichever previous CTRL_MON group owned the task and also from
304321 any MON group that owned the task. If the group is a MON group,
305322 then the task must already belong to the CTRL_MON parent of this
@@ -342,6 +359,10 @@ When control is enabled all CTRL_MON groups will also contain:
342359 file. On successful pseudo-locked region creation the mode will
343360 automatically change to "pseudo-locked".
344361
362+ "ctrl_hw_id":
363+ Available only with debug option. The identifier used by hardware
364+ for the control group. On x86 this is the CLOSID.
365+
345366When monitoring is enabled all MON groups will also contain:
346367
347368"mon_data":
@@ -355,6 +376,10 @@ When monitoring is enabled all MON groups will also contain:
355376 the sum for all tasks in the CTRL_MON group and all tasks in
356377 MON groups. Please see example section for more details on usage.
357378
379+ "mon_hw_id":
380+ Available only with debug option. The identifier used by hardware
381+ for the monitor group. On x86 this is the RMID.
382+
358383Resource allocation rules
359384-------------------------
360385
@@ -445,12 +470,13 @@ For cache resources we describe the portion of the cache that is available
445470for allocation using a bitmask. The maximum value of the mask is defined
446471by each cpu model (and may be different for different cache levels). It
447472is found using CPUID, but is also provided in the "info" directory of
448- the resctrl file system in "info/{resource}/cbm_mask". Intel hardware
473+ the resctrl file system in "info/{resource}/cbm_mask". Some Intel hardware
449474requires that these masks have all the '1' bits in a contiguous block. So
4504750x3, 0x6 and 0xC are legal 4-bit masks with two bits set, but 0x5, 0x9
451- and 0xA are not. On a system with a 20-bit mask each bit represents 5%
452- of the capacity of the cache. You could partition the cache into four
453- equal parts with masks: 0x1f, 0x3e0, 0x7c00, 0xf8000.
476+ and 0xA are not. Check /sys/fs/resctrl/info/{resource}/sparse_masks
477+ if non-contiguous 1s value is supported. On a system with a 20-bit mask
478+ each bit represents 5% of the capacity of the cache. You could partition
479+ the cache into four equal parts with masks: 0x1f, 0x3e0, 0x7c00, 0xf8000.
454480
455481Memory bandwidth Allocation and monitoring
456482==========================================
0 commit comments