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[] __initdata = {
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];
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];
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)
293 tval = __rmid_read(rmid, rr->evtid);
294 if (tval & (RMID_VAL_ERROR | RMID_VAL_UNAVAIL)) {
299 case QOS_L3_OCCUP_EVENT_ID:
302 case QOS_L3_MBM_TOTAL_EVENT_ID:
303 m = &rr->d->mbm_total[rmid];
305 case QOS_L3_MBM_LOCAL_EVENT_ID:
306 m = &rr->d->mbm_local[rmid];
310 * Code would never reach here because
311 * an invalid event id would fail the __rmid_read.
317 memset(m, 0, sizeof(struct mbm_state));
318 m->prev_bw_msr = m->prev_msr = tval;
322 chunks = mbm_overflow_count(m->prev_msr, tval, rr->r->mbm_width);
326 rr->val += get_corrected_mbm_count(rmid, m->chunks);
332 * Supporting function to calculate the memory bandwidth
333 * and delta bandwidth in MBps.
335 static void mbm_bw_count(u32 rmid, struct rmid_read *rr)
337 struct rdt_resource *r = &rdt_resources_all[RDT_RESOURCE_L3];
338 struct mbm_state *m = &rr->d->mbm_local[rmid];
339 u64 tval, cur_bw, chunks;
341 tval = __rmid_read(rmid, rr->evtid);
342 if (tval & (RMID_VAL_ERROR | RMID_VAL_UNAVAIL))
345 chunks = mbm_overflow_count(m->prev_bw_msr, tval, rr->r->mbm_width);
346 cur_bw = (get_corrected_mbm_count(rmid, chunks) * r->mon_scale) >> 20;
349 m->delta_bw = abs(cur_bw - m->prev_bw);
350 m->delta_comp = false;
352 m->prev_bw_msr = tval;
356 * This is called via IPI to read the CQM/MBM counters
359 void mon_event_count(void *info)
361 struct rdtgroup *rdtgrp, *entry;
362 struct rmid_read *rr = info;
363 struct list_head *head;
367 if (__mon_event_count(rdtgrp->mon.rmid, rr))
371 * For Ctrl groups read data from child monitor groups.
373 head = &rdtgrp->mon.crdtgrp_list;
375 if (rdtgrp->type == RDTCTRL_GROUP) {
376 list_for_each_entry(entry, head, mon.crdtgrp_list) {
377 if (__mon_event_count(entry->mon.rmid, rr))
384 * Feedback loop for MBA software controller (mba_sc)
386 * mba_sc is a feedback loop where we periodically read MBM counters and
387 * adjust the bandwidth percentage values via the IA32_MBA_THRTL_MSRs so
390 * current bandwidth(cur_bw) < user specified bandwidth(user_bw)
392 * This uses the MBM counters to measure the bandwidth and MBA throttle
393 * MSRs to control the bandwidth for a particular rdtgrp. It builds on the
394 * fact that resctrl rdtgroups have both monitoring and control.
396 * The frequency of the checks is 1s and we just tag along the MBM overflow
397 * timer. Having 1s interval makes the calculation of bandwidth simpler.
399 * Although MBA's goal is to restrict the bandwidth to a maximum, there may
400 * be a need to increase the bandwidth to avoid uncecessarily restricting
401 * the L2 <-> L3 traffic.
403 * Since MBA controls the L2 external bandwidth where as MBM measures the
404 * L3 external bandwidth the following sequence could lead to such a
407 * Consider an rdtgroup which had high L3 <-> memory traffic in initial
408 * phases -> mba_sc kicks in and reduced bandwidth percentage values -> but
409 * after some time rdtgroup has mostly L2 <-> L3 traffic.
411 * In this case we may restrict the rdtgroup's L2 <-> L3 traffic as its
412 * throttle MSRs already have low percentage values. To avoid
413 * unnecessarily restricting such rdtgroups, we also increase the bandwidth.
415 static void update_mba_bw(struct rdtgroup *rgrp, struct rdt_domain *dom_mbm)
417 u32 closid, rmid, cur_msr, cur_msr_val, new_msr_val;
418 struct mbm_state *pmbm_data, *cmbm_data;
419 u32 cur_bw, delta_bw, user_bw;
420 struct rdt_resource *r_mba;
421 struct rdt_domain *dom_mba;
422 struct list_head *head;
423 struct rdtgroup *entry;
425 if (!is_mbm_local_enabled())
428 r_mba = &rdt_resources_all[RDT_RESOURCE_MBA];
429 closid = rgrp->closid;
430 rmid = rgrp->mon.rmid;
431 pmbm_data = &dom_mbm->mbm_local[rmid];
433 dom_mba = get_domain_from_cpu(smp_processor_id(), r_mba);
435 pr_warn_once("Failure to get domain for MBA update\n");
439 cur_bw = pmbm_data->prev_bw;
440 user_bw = dom_mba->mbps_val[closid];
441 delta_bw = pmbm_data->delta_bw;
442 cur_msr_val = dom_mba->ctrl_val[closid];
445 * For Ctrl groups read data from child monitor groups.
447 head = &rgrp->mon.crdtgrp_list;
448 list_for_each_entry(entry, head, mon.crdtgrp_list) {
449 cmbm_data = &dom_mbm->mbm_local[entry->mon.rmid];
450 cur_bw += cmbm_data->prev_bw;
451 delta_bw += cmbm_data->delta_bw;
455 * Scale up/down the bandwidth linearly for the ctrl group. The
456 * bandwidth step is the bandwidth granularity specified by the
459 * The delta_bw is used when increasing the bandwidth so that we
460 * dont alternately increase and decrease the control values
463 * For ex: consider cur_bw = 90MBps, user_bw = 100MBps and if
464 * bandwidth step is 20MBps(> user_bw - cur_bw), we would keep
465 * switching between 90 and 110 continuously if we only check
468 if (cur_msr_val > r_mba->membw.min_bw && user_bw < cur_bw) {
469 new_msr_val = cur_msr_val - r_mba->membw.bw_gran;
470 } else if (cur_msr_val < MAX_MBA_BW &&
471 (user_bw > (cur_bw + delta_bw))) {
472 new_msr_val = cur_msr_val + r_mba->membw.bw_gran;
477 cur_msr = r_mba->msr_base + closid;
478 wrmsrl(cur_msr, delay_bw_map(new_msr_val, r_mba));
479 dom_mba->ctrl_val[closid] = new_msr_val;
482 * Delta values are updated dynamically package wise for each
483 * rdtgrp everytime the throttle MSR changes value.
485 * This is because (1)the increase in bandwidth is not perfectly
486 * linear and only "approximately" linear even when the hardware
487 * says it is linear.(2)Also since MBA is a core specific
488 * mechanism, the delta values vary based on number of cores used
491 pmbm_data->delta_comp = true;
492 list_for_each_entry(entry, head, mon.crdtgrp_list) {
493 cmbm_data = &dom_mbm->mbm_local[entry->mon.rmid];
494 cmbm_data->delta_comp = true;
498 static void mbm_update(struct rdt_resource *r, struct rdt_domain *d, int rmid)
507 * This is protected from concurrent reads from user
508 * as both the user and we hold the global mutex.
510 if (is_mbm_total_enabled()) {
511 rr.evtid = QOS_L3_MBM_TOTAL_EVENT_ID;
512 __mon_event_count(rmid, &rr);
514 if (is_mbm_local_enabled()) {
515 rr.evtid = QOS_L3_MBM_LOCAL_EVENT_ID;
516 __mon_event_count(rmid, &rr);
519 * Call the MBA software controller only for the
520 * control groups and when user has enabled
521 * the software controller explicitly.
524 mbm_bw_count(rmid, &rr);
529 * Handler to scan the limbo list and move the RMIDs
530 * to free list whose occupancy < threshold_occupancy.
532 void cqm_handle_limbo(struct work_struct *work)
534 unsigned long delay = msecs_to_jiffies(CQM_LIMBOCHECK_INTERVAL);
535 int cpu = smp_processor_id();
536 struct rdt_resource *r;
537 struct rdt_domain *d;
539 mutex_lock(&rdtgroup_mutex);
541 r = &rdt_resources_all[RDT_RESOURCE_L3];
542 d = container_of(work, struct rdt_domain, cqm_limbo.work);
544 __check_limbo(d, false);
546 if (has_busy_rmid(r, d))
547 schedule_delayed_work_on(cpu, &d->cqm_limbo, delay);
549 mutex_unlock(&rdtgroup_mutex);
552 void cqm_setup_limbo_handler(struct rdt_domain *dom, unsigned long delay_ms)
554 unsigned long delay = msecs_to_jiffies(delay_ms);
557 cpu = cpumask_any(&dom->cpu_mask);
558 dom->cqm_work_cpu = cpu;
560 schedule_delayed_work_on(cpu, &dom->cqm_limbo, delay);
563 void mbm_handle_overflow(struct work_struct *work)
565 unsigned long delay = msecs_to_jiffies(MBM_OVERFLOW_INTERVAL);
566 struct rdtgroup *prgrp, *crgrp;
567 int cpu = smp_processor_id();
568 struct list_head *head;
569 struct rdt_resource *r;
570 struct rdt_domain *d;
572 mutex_lock(&rdtgroup_mutex);
574 if (!static_branch_likely(&rdt_mon_enable_key))
577 r = &rdt_resources_all[RDT_RESOURCE_L3];
578 d = container_of(work, struct rdt_domain, mbm_over.work);
580 list_for_each_entry(prgrp, &rdt_all_groups, rdtgroup_list) {
581 mbm_update(r, d, prgrp->mon.rmid);
583 head = &prgrp->mon.crdtgrp_list;
584 list_for_each_entry(crgrp, head, mon.crdtgrp_list)
585 mbm_update(r, d, crgrp->mon.rmid);
588 update_mba_bw(prgrp, d);
591 schedule_delayed_work_on(cpu, &d->mbm_over, delay);
594 mutex_unlock(&rdtgroup_mutex);
597 void mbm_setup_overflow_handler(struct rdt_domain *dom, unsigned long delay_ms)
599 unsigned long delay = msecs_to_jiffies(delay_ms);
602 if (!static_branch_likely(&rdt_mon_enable_key))
604 cpu = cpumask_any(&dom->cpu_mask);
605 dom->mbm_work_cpu = cpu;
606 schedule_delayed_work_on(cpu, &dom->mbm_over, delay);
609 static int dom_data_init(struct rdt_resource *r)
611 struct rmid_entry *entry = NULL;
614 nr_rmids = r->num_rmid;
615 rmid_ptrs = kcalloc(nr_rmids, sizeof(struct rmid_entry), GFP_KERNEL);
619 for (i = 0; i < nr_rmids; i++) {
620 entry = &rmid_ptrs[i];
621 INIT_LIST_HEAD(&entry->list);
624 list_add_tail(&entry->list, &rmid_free_lru);
628 * RMID 0 is special and is always allocated. It's used for all
629 * tasks that are not monitored.
631 entry = __rmid_entry(0);
632 list_del(&entry->list);
637 static struct mon_evt llc_occupancy_event = {
638 .name = "llc_occupancy",
639 .evtid = QOS_L3_OCCUP_EVENT_ID,
642 static struct mon_evt mbm_total_event = {
643 .name = "mbm_total_bytes",
644 .evtid = QOS_L3_MBM_TOTAL_EVENT_ID,
647 static struct mon_evt mbm_local_event = {
648 .name = "mbm_local_bytes",
649 .evtid = QOS_L3_MBM_LOCAL_EVENT_ID,
653 * Initialize the event list for the resource.
655 * Note that MBM events are also part of RDT_RESOURCE_L3 resource
656 * because as per the SDM the total and local memory bandwidth
657 * are enumerated as part of L3 monitoring.
659 static void l3_mon_evt_init(struct rdt_resource *r)
661 INIT_LIST_HEAD(&r->evt_list);
663 if (is_llc_occupancy_enabled())
664 list_add_tail(&llc_occupancy_event.list, &r->evt_list);
665 if (is_mbm_total_enabled())
666 list_add_tail(&mbm_total_event.list, &r->evt_list);
667 if (is_mbm_local_enabled())
668 list_add_tail(&mbm_local_event.list, &r->evt_list);
671 int rdt_get_mon_l3_config(struct rdt_resource *r)
673 unsigned int mbm_offset = boot_cpu_data.x86_cache_mbm_width_offset;
674 unsigned int cl_size = boot_cpu_data.x86_cache_size;
677 r->mon_scale = boot_cpu_data.x86_cache_occ_scale;
678 r->num_rmid = boot_cpu_data.x86_cache_max_rmid + 1;
679 r->mbm_width = MBM_CNTR_WIDTH_BASE;
681 if (mbm_offset > 0 && mbm_offset <= MBM_CNTR_WIDTH_OFFSET_MAX)
682 r->mbm_width += mbm_offset;
683 else if (mbm_offset > MBM_CNTR_WIDTH_OFFSET_MAX)
684 pr_warn("Ignoring impossible MBM counter offset\n");
687 * A reasonable upper limit on the max threshold is the number
688 * of lines tagged per RMID if all RMIDs have the same number of
689 * lines tagged in the LLC.
691 * For a 35MB LLC and 56 RMIDs, this is ~1.8% of the LLC.
693 resctrl_cqm_threshold = cl_size * 1024 / r->num_rmid;
695 /* h/w works in units of "boot_cpu_data.x86_cache_occ_scale" */
696 resctrl_cqm_threshold /= r->mon_scale;
698 ret = dom_data_init(r);
704 r->mon_capable = true;
705 r->mon_enabled = true;
710 void __init intel_rdt_mbm_apply_quirk(void)
714 cf_index = (boot_cpu_data.x86_cache_max_rmid + 1) / 8 - 1;
715 if (cf_index >= ARRAY_SIZE(mbm_cf_table)) {
716 pr_info("No MBM correction factor available\n");
720 mbm_cf_rmidthreshold = mbm_cf_table[cf_index].rmidthreshold;
721 mbm_cf = mbm_cf_table[cf_index].cf;