1 // SPDX-License-Identifier: GPL-2.0-only
3 * Resource Director Technology(RDT)
6 * Copyright (C) 2017 Intel Corporation
9 * Vikas Shivappa <vikas.shivappa@intel.com>
11 * This replaces the cqm.c based on perf but we reuse a lot of
12 * code and datastructures originally from Peter Zijlstra and Matt Fleming.
14 * More information about RDT be found in the Intel (R) x86 Architecture
15 * Software Developer Manual June 2016, volume 3, section 17.17.
18 #include <linux/module.h>
19 #include <linux/slab.h>
20 #include <asm/cpu_device_id.h>
26 struct list_head list;
30 * @rmid_free_lru A least recently used list of free RMIDs
31 * These RMIDs are guaranteed to have an occupancy less than the
34 static LIST_HEAD(rmid_free_lru);
37 * @rmid_limbo_count count of currently unused but (potentially)
39 * This counts RMIDs that no one is currently using but that
40 * may have a occupancy value > intel_cqm_threshold. User can change
41 * the threshold occupancy value.
43 static unsigned int rmid_limbo_count;
46 * @rmid_entry - The entry in the limbo and free lists.
48 static struct rmid_entry *rmid_ptrs;
51 * Global boolean for rdt_monitor which is true if any
52 * resource monitoring is enabled.
57 * Global to indicate which monitoring events are enabled.
59 unsigned int rdt_mon_features;
62 * This is the threshold cache occupancy at which we will consider an
63 * RMID available for re-allocation.
65 unsigned int resctrl_cqm_threshold;
67 #define CF(cf) ((unsigned long)(1048576 * (cf) + 0.5))
70 * The correction factor table is documented in Documentation/x86/resctrl.rst.
71 * If rmid > rmid threshold, MBM total and local values should be multiplied
72 * by the correction factor.
74 * The original table is modified for better code:
76 * 1. The threshold 0 is changed to rmid count - 1 so don't do correction
78 * 2. MBM total and local correction table indexed by core counter which is
79 * equal to (x86_cache_max_rmid + 1) / 8 - 1 and is from 0 up to 27.
80 * 3. The correction factor is normalized to 2^20 (1048576) so it's faster
81 * to calculate corrected value by shifting:
82 * corrected_value = (original_value * correction_factor) >> 20
84 static const struct mbm_correction_factor_table {
87 } mbm_cf_table[] __initconst = {
118 static u32 mbm_cf_rmidthreshold __read_mostly = UINT_MAX;
119 static u64 mbm_cf __read_mostly;
121 static inline u64 get_corrected_mbm_count(u32 rmid, unsigned long val)
123 /* Correct MBM value. */
124 if (rmid > mbm_cf_rmidthreshold)
125 val = (val * mbm_cf) >> 20;
130 static inline struct rmid_entry *__rmid_entry(u32 rmid)
132 struct rmid_entry *entry;
134 entry = &rmid_ptrs[rmid];
135 WARN_ON(entry->rmid != rmid);
140 static u64 __rmid_read(u32 rmid, u32 eventid)
145 * As per the SDM, when IA32_QM_EVTSEL.EvtID (bits 7:0) is configured
146 * with a valid event code for supported resource type and the bits
147 * IA32_QM_EVTSEL.RMID (bits 41:32) are configured with valid RMID,
148 * IA32_QM_CTR.data (bits 61:0) reports the monitored data.
149 * IA32_QM_CTR.Error (bit 63) and IA32_QM_CTR.Unavailable (bit 62)
152 wrmsr(MSR_IA32_QM_EVTSEL, eventid, rmid);
153 rdmsrl(MSR_IA32_QM_CTR, val);
158 static bool rmid_dirty(struct rmid_entry *entry)
160 u64 val = __rmid_read(entry->rmid, QOS_L3_OCCUP_EVENT_ID);
162 return val >= resctrl_cqm_threshold;
166 * Check the RMIDs that are marked as busy for this domain. If the
167 * reported LLC occupancy is below the threshold clear the busy bit and
168 * decrement the count. If the busy count gets to zero on an RMID, we
171 void __check_limbo(struct rdt_domain *d, bool force_free)
173 struct rmid_entry *entry;
174 struct rdt_resource *r;
175 u32 crmid = 1, nrmid;
177 r = &rdt_resources_all[RDT_RESOURCE_L3].r_resctrl;
180 * Skip RMID 0 and start from RMID 1 and check all the RMIDs that
181 * are marked as busy for occupancy < threshold. If the occupancy
182 * is less than the threshold decrement the busy counter of the
183 * RMID and move it to the free list when the counter reaches 0.
186 nrmid = find_next_bit(d->rmid_busy_llc, r->num_rmid, crmid);
187 if (nrmid >= r->num_rmid)
190 entry = __rmid_entry(nrmid);
191 if (force_free || !rmid_dirty(entry)) {
192 clear_bit(entry->rmid, d->rmid_busy_llc);
193 if (!--entry->busy) {
195 list_add_tail(&entry->list, &rmid_free_lru);
202 bool has_busy_rmid(struct rdt_resource *r, struct rdt_domain *d)
204 return find_first_bit(d->rmid_busy_llc, r->num_rmid) != r->num_rmid;
208 * As of now the RMIDs allocation is global.
209 * However we keep track of which packages the RMIDs
210 * are used to optimize the limbo list management.
214 struct rmid_entry *entry;
216 lockdep_assert_held(&rdtgroup_mutex);
218 if (list_empty(&rmid_free_lru))
219 return rmid_limbo_count ? -EBUSY : -ENOSPC;
221 entry = list_first_entry(&rmid_free_lru,
222 struct rmid_entry, list);
223 list_del(&entry->list);
228 static void add_rmid_to_limbo(struct rmid_entry *entry)
230 struct rdt_resource *r;
231 struct rdt_domain *d;
235 r = &rdt_resources_all[RDT_RESOURCE_L3].r_resctrl;
239 list_for_each_entry(d, &r->domains, list) {
240 if (cpumask_test_cpu(cpu, &d->cpu_mask)) {
241 val = __rmid_read(entry->rmid, QOS_L3_OCCUP_EVENT_ID);
242 if (val <= resctrl_cqm_threshold)
247 * For the first limbo RMID in the domain,
248 * setup up the limbo worker.
250 if (!has_busy_rmid(r, d))
251 cqm_setup_limbo_handler(d, CQM_LIMBOCHECK_INTERVAL);
252 set_bit(entry->rmid, d->rmid_busy_llc);
260 list_add_tail(&entry->list, &rmid_free_lru);
263 void free_rmid(u32 rmid)
265 struct rmid_entry *entry;
270 lockdep_assert_held(&rdtgroup_mutex);
272 entry = __rmid_entry(rmid);
274 if (is_llc_occupancy_enabled())
275 add_rmid_to_limbo(entry);
277 list_add_tail(&entry->list, &rmid_free_lru);
280 static u64 mbm_overflow_count(u64 prev_msr, u64 cur_msr, unsigned int width)
282 u64 shift = 64 - width, chunks;
284 chunks = (cur_msr << shift) - (prev_msr << shift);
285 return chunks >>= shift;
288 static int __mon_event_count(u32 rmid, struct rmid_read *rr)
290 struct rdt_hw_resource *hw_res = resctrl_to_arch_res(rr->r);
294 tval = __rmid_read(rmid, rr->evtid);
295 if (tval & (RMID_VAL_ERROR | RMID_VAL_UNAVAIL)) {
300 case QOS_L3_OCCUP_EVENT_ID:
303 case QOS_L3_MBM_TOTAL_EVENT_ID:
304 m = &rr->d->mbm_total[rmid];
306 case QOS_L3_MBM_LOCAL_EVENT_ID:
307 m = &rr->d->mbm_local[rmid];
311 * Code would never reach here because
312 * an invalid event id would fail the __rmid_read.
318 memset(m, 0, sizeof(struct mbm_state));
319 m->prev_bw_msr = m->prev_msr = tval;
323 chunks = mbm_overflow_count(m->prev_msr, tval, hw_res->mbm_width);
327 rr->val += get_corrected_mbm_count(rmid, m->chunks);
333 * Supporting function to calculate the memory bandwidth
334 * and delta bandwidth in MBps.
336 static void mbm_bw_count(u32 rmid, struct rmid_read *rr)
338 struct rdt_hw_resource *hw_res = resctrl_to_arch_res(rr->r);
339 struct mbm_state *m = &rr->d->mbm_local[rmid];
340 u64 tval, cur_bw, chunks;
342 tval = __rmid_read(rmid, rr->evtid);
343 if (tval & (RMID_VAL_ERROR | RMID_VAL_UNAVAIL))
346 chunks = mbm_overflow_count(m->prev_bw_msr, tval, hw_res->mbm_width);
347 cur_bw = (get_corrected_mbm_count(rmid, chunks) * hw_res->mon_scale) >> 20;
350 m->delta_bw = abs(cur_bw - m->prev_bw);
351 m->delta_comp = false;
353 m->prev_bw_msr = tval;
357 * This is called via IPI to read the CQM/MBM counters
360 void mon_event_count(void *info)
362 struct rdtgroup *rdtgrp, *entry;
363 struct rmid_read *rr = info;
364 struct list_head *head;
368 if (__mon_event_count(rdtgrp->mon.rmid, rr))
372 * For Ctrl groups read data from child monitor groups.
374 head = &rdtgrp->mon.crdtgrp_list;
376 if (rdtgrp->type == RDTCTRL_GROUP) {
377 list_for_each_entry(entry, head, mon.crdtgrp_list) {
378 if (__mon_event_count(entry->mon.rmid, rr))
385 * Feedback loop for MBA software controller (mba_sc)
387 * mba_sc is a feedback loop where we periodically read MBM counters and
388 * adjust the bandwidth percentage values via the IA32_MBA_THRTL_MSRs so
391 * current bandwidth(cur_bw) < user specified bandwidth(user_bw)
393 * This uses the MBM counters to measure the bandwidth and MBA throttle
394 * MSRs to control the bandwidth for a particular rdtgrp. It builds on the
395 * fact that resctrl rdtgroups have both monitoring and control.
397 * The frequency of the checks is 1s and we just tag along the MBM overflow
398 * timer. Having 1s interval makes the calculation of bandwidth simpler.
400 * Although MBA's goal is to restrict the bandwidth to a maximum, there may
401 * be a need to increase the bandwidth to avoid unnecessarily restricting
402 * the L2 <-> L3 traffic.
404 * Since MBA controls the L2 external bandwidth where as MBM measures the
405 * L3 external bandwidth the following sequence could lead to such a
408 * Consider an rdtgroup which had high L3 <-> memory traffic in initial
409 * phases -> mba_sc kicks in and reduced bandwidth percentage values -> but
410 * after some time rdtgroup has mostly L2 <-> L3 traffic.
412 * In this case we may restrict the rdtgroup's L2 <-> L3 traffic as its
413 * throttle MSRs already have low percentage values. To avoid
414 * unnecessarily restricting such rdtgroups, we also increase the bandwidth.
416 static void update_mba_bw(struct rdtgroup *rgrp, struct rdt_domain *dom_mbm)
418 u32 closid, rmid, cur_msr, cur_msr_val, new_msr_val;
419 struct mbm_state *pmbm_data, *cmbm_data;
420 struct rdt_hw_resource *hw_r_mba;
421 u32 cur_bw, delta_bw, user_bw;
422 struct rdt_resource *r_mba;
423 struct rdt_domain *dom_mba;
424 struct list_head *head;
425 struct rdtgroup *entry;
427 if (!is_mbm_local_enabled())
430 hw_r_mba = &rdt_resources_all[RDT_RESOURCE_MBA];
431 r_mba = &hw_r_mba->r_resctrl;
432 closid = rgrp->closid;
433 rmid = rgrp->mon.rmid;
434 pmbm_data = &dom_mbm->mbm_local[rmid];
436 dom_mba = get_domain_from_cpu(smp_processor_id(), r_mba);
438 pr_warn_once("Failure to get domain for MBA update\n");
442 cur_bw = pmbm_data->prev_bw;
443 user_bw = dom_mba->mbps_val[closid];
444 delta_bw = pmbm_data->delta_bw;
445 cur_msr_val = dom_mba->ctrl_val[closid];
448 * For Ctrl groups read data from child monitor groups.
450 head = &rgrp->mon.crdtgrp_list;
451 list_for_each_entry(entry, head, mon.crdtgrp_list) {
452 cmbm_data = &dom_mbm->mbm_local[entry->mon.rmid];
453 cur_bw += cmbm_data->prev_bw;
454 delta_bw += cmbm_data->delta_bw;
458 * Scale up/down the bandwidth linearly for the ctrl group. The
459 * bandwidth step is the bandwidth granularity specified by the
462 * The delta_bw is used when increasing the bandwidth so that we
463 * dont alternately increase and decrease the control values
466 * For ex: consider cur_bw = 90MBps, user_bw = 100MBps and if
467 * bandwidth step is 20MBps(> user_bw - cur_bw), we would keep
468 * switching between 90 and 110 continuously if we only check
471 if (cur_msr_val > r_mba->membw.min_bw && user_bw < cur_bw) {
472 new_msr_val = cur_msr_val - r_mba->membw.bw_gran;
473 } else if (cur_msr_val < MAX_MBA_BW &&
474 (user_bw > (cur_bw + delta_bw))) {
475 new_msr_val = cur_msr_val + r_mba->membw.bw_gran;
480 cur_msr = hw_r_mba->msr_base + closid;
481 wrmsrl(cur_msr, delay_bw_map(new_msr_val, r_mba));
482 dom_mba->ctrl_val[closid] = new_msr_val;
485 * Delta values are updated dynamically package wise for each
486 * rdtgrp every time the throttle MSR changes value.
488 * This is because (1)the increase in bandwidth is not perfectly
489 * linear and only "approximately" linear even when the hardware
490 * says it is linear.(2)Also since MBA is a core specific
491 * mechanism, the delta values vary based on number of cores used
494 pmbm_data->delta_comp = true;
495 list_for_each_entry(entry, head, mon.crdtgrp_list) {
496 cmbm_data = &dom_mbm->mbm_local[entry->mon.rmid];
497 cmbm_data->delta_comp = true;
501 static void mbm_update(struct rdt_resource *r, struct rdt_domain *d, int rmid)
510 * This is protected from concurrent reads from user
511 * as both the user and we hold the global mutex.
513 if (is_mbm_total_enabled()) {
514 rr.evtid = QOS_L3_MBM_TOTAL_EVENT_ID;
515 __mon_event_count(rmid, &rr);
517 if (is_mbm_local_enabled()) {
518 rr.evtid = QOS_L3_MBM_LOCAL_EVENT_ID;
519 __mon_event_count(rmid, &rr);
522 * Call the MBA software controller only for the
523 * control groups and when user has enabled
524 * the software controller explicitly.
527 mbm_bw_count(rmid, &rr);
532 * Handler to scan the limbo list and move the RMIDs
533 * to free list whose occupancy < threshold_occupancy.
535 void cqm_handle_limbo(struct work_struct *work)
537 unsigned long delay = msecs_to_jiffies(CQM_LIMBOCHECK_INTERVAL);
538 int cpu = smp_processor_id();
539 struct rdt_resource *r;
540 struct rdt_domain *d;
542 mutex_lock(&rdtgroup_mutex);
544 r = &rdt_resources_all[RDT_RESOURCE_L3].r_resctrl;
545 d = container_of(work, struct rdt_domain, cqm_limbo.work);
547 __check_limbo(d, false);
549 if (has_busy_rmid(r, d))
550 schedule_delayed_work_on(cpu, &d->cqm_limbo, delay);
552 mutex_unlock(&rdtgroup_mutex);
555 void cqm_setup_limbo_handler(struct rdt_domain *dom, unsigned long delay_ms)
557 unsigned long delay = msecs_to_jiffies(delay_ms);
560 cpu = cpumask_any(&dom->cpu_mask);
561 dom->cqm_work_cpu = cpu;
563 schedule_delayed_work_on(cpu, &dom->cqm_limbo, delay);
566 void mbm_handle_overflow(struct work_struct *work)
568 unsigned long delay = msecs_to_jiffies(MBM_OVERFLOW_INTERVAL);
569 struct rdtgroup *prgrp, *crgrp;
570 int cpu = smp_processor_id();
571 struct list_head *head;
572 struct rdt_resource *r;
573 struct rdt_domain *d;
575 mutex_lock(&rdtgroup_mutex);
577 if (!static_branch_likely(&rdt_mon_enable_key))
580 r = &rdt_resources_all[RDT_RESOURCE_L3].r_resctrl;
581 d = container_of(work, struct rdt_domain, mbm_over.work);
583 list_for_each_entry(prgrp, &rdt_all_groups, rdtgroup_list) {
584 mbm_update(r, d, prgrp->mon.rmid);
586 head = &prgrp->mon.crdtgrp_list;
587 list_for_each_entry(crgrp, head, mon.crdtgrp_list)
588 mbm_update(r, d, crgrp->mon.rmid);
591 update_mba_bw(prgrp, d);
594 schedule_delayed_work_on(cpu, &d->mbm_over, delay);
597 mutex_unlock(&rdtgroup_mutex);
600 void mbm_setup_overflow_handler(struct rdt_domain *dom, unsigned long delay_ms)
602 unsigned long delay = msecs_to_jiffies(delay_ms);
605 if (!static_branch_likely(&rdt_mon_enable_key))
607 cpu = cpumask_any(&dom->cpu_mask);
608 dom->mbm_work_cpu = cpu;
609 schedule_delayed_work_on(cpu, &dom->mbm_over, delay);
612 static int dom_data_init(struct rdt_resource *r)
614 struct rmid_entry *entry = NULL;
617 nr_rmids = r->num_rmid;
618 rmid_ptrs = kcalloc(nr_rmids, sizeof(struct rmid_entry), GFP_KERNEL);
622 for (i = 0; i < nr_rmids; i++) {
623 entry = &rmid_ptrs[i];
624 INIT_LIST_HEAD(&entry->list);
627 list_add_tail(&entry->list, &rmid_free_lru);
631 * RMID 0 is special and is always allocated. It's used for all
632 * tasks that are not monitored.
634 entry = __rmid_entry(0);
635 list_del(&entry->list);
640 static struct mon_evt llc_occupancy_event = {
641 .name = "llc_occupancy",
642 .evtid = QOS_L3_OCCUP_EVENT_ID,
645 static struct mon_evt mbm_total_event = {
646 .name = "mbm_total_bytes",
647 .evtid = QOS_L3_MBM_TOTAL_EVENT_ID,
650 static struct mon_evt mbm_local_event = {
651 .name = "mbm_local_bytes",
652 .evtid = QOS_L3_MBM_LOCAL_EVENT_ID,
656 * Initialize the event list for the resource.
658 * Note that MBM events are also part of RDT_RESOURCE_L3 resource
659 * because as per the SDM the total and local memory bandwidth
660 * are enumerated as part of L3 monitoring.
662 static void l3_mon_evt_init(struct rdt_resource *r)
664 INIT_LIST_HEAD(&r->evt_list);
666 if (is_llc_occupancy_enabled())
667 list_add_tail(&llc_occupancy_event.list, &r->evt_list);
668 if (is_mbm_total_enabled())
669 list_add_tail(&mbm_total_event.list, &r->evt_list);
670 if (is_mbm_local_enabled())
671 list_add_tail(&mbm_local_event.list, &r->evt_list);
674 int rdt_get_mon_l3_config(struct rdt_resource *r)
676 unsigned int mbm_offset = boot_cpu_data.x86_cache_mbm_width_offset;
677 struct rdt_hw_resource *hw_res = resctrl_to_arch_res(r);
678 unsigned int cl_size = boot_cpu_data.x86_cache_size;
681 hw_res->mon_scale = boot_cpu_data.x86_cache_occ_scale;
682 r->num_rmid = boot_cpu_data.x86_cache_max_rmid + 1;
683 hw_res->mbm_width = MBM_CNTR_WIDTH_BASE;
685 if (mbm_offset > 0 && mbm_offset <= MBM_CNTR_WIDTH_OFFSET_MAX)
686 hw_res->mbm_width += mbm_offset;
687 else if (mbm_offset > MBM_CNTR_WIDTH_OFFSET_MAX)
688 pr_warn("Ignoring impossible MBM counter offset\n");
691 * A reasonable upper limit on the max threshold is the number
692 * of lines tagged per RMID if all RMIDs have the same number of
693 * lines tagged in the LLC.
695 * For a 35MB LLC and 56 RMIDs, this is ~1.8% of the LLC.
697 resctrl_cqm_threshold = cl_size * 1024 / r->num_rmid;
699 /* h/w works in units of "boot_cpu_data.x86_cache_occ_scale" */
700 resctrl_cqm_threshold /= hw_res->mon_scale;
702 ret = dom_data_init(r);
708 r->mon_capable = true;
709 r->mon_enabled = true;
714 void __init intel_rdt_mbm_apply_quirk(void)
718 cf_index = (boot_cpu_data.x86_cache_max_rmid + 1) / 8 - 1;
719 if (cf_index >= ARRAY_SIZE(mbm_cf_table)) {
720 pr_info("No MBM correction factor available\n");
724 mbm_cf_rmidthreshold = mbm_cf_table[cf_index].rmidthreshold;
725 mbm_cf = mbm_cf_table[cf_index].cf;