GNU Linux-libre 4.14.251-gnu1
[releases.git] / arch / x86 / kernel / cpu / intel_rdt_monitor.c
1 /*
2  * Resource Director Technology(RDT)
3  * - Monitoring code
4  *
5  * Copyright (C) 2017 Intel Corporation
6  *
7  * Author:
8  *    Vikas Shivappa <vikas.shivappa@intel.com>
9  *
10  * This replaces the cqm.c based on perf but we reuse a lot of
11  * code and datastructures originally from Peter Zijlstra and Matt Fleming.
12  *
13  * This program is free software; you can redistribute it and/or modify it
14  * under the terms and conditions of the GNU General Public License,
15  * version 2, as published by the Free Software Foundation.
16  *
17  * This program is distributed in the hope it will be useful, but WITHOUT
18  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
19  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
20  * more details.
21  *
22  * More information about RDT be found in the Intel (R) x86 Architecture
23  * Software Developer Manual June 2016, volume 3, section 17.17.
24  */
25
26 #include <linux/module.h>
27 #include <linux/slab.h>
28 #include <asm/cpu_device_id.h>
29 #include "intel_rdt.h"
30
31 #define MSR_IA32_QM_CTR         0x0c8e
32 #define MSR_IA32_QM_EVTSEL              0x0c8d
33
34 struct rmid_entry {
35         u32                             rmid;
36         int                             busy;
37         struct list_head                list;
38 };
39
40 /**
41  * @rmid_free_lru    A least recently used list of free RMIDs
42  *     These RMIDs are guaranteed to have an occupancy less than the
43  *     threshold occupancy
44  */
45 static LIST_HEAD(rmid_free_lru);
46
47 /**
48  * @rmid_limbo_count     count of currently unused but (potentially)
49  *     dirty RMIDs.
50  *     This counts RMIDs that no one is currently using but that
51  *     may have a occupancy value > intel_cqm_threshold. User can change
52  *     the threshold occupancy value.
53  */
54 unsigned int rmid_limbo_count;
55
56 /**
57  * @rmid_entry - The entry in the limbo and free lists.
58  */
59 static struct rmid_entry        *rmid_ptrs;
60
61 /*
62  * Global boolean for rdt_monitor which is true if any
63  * resource monitoring is enabled.
64  */
65 bool rdt_mon_capable;
66
67 /*
68  * Global to indicate which monitoring events are enabled.
69  */
70 unsigned int rdt_mon_features;
71
72 /*
73  * This is the threshold cache occupancy at which we will consider an
74  * RMID available for re-allocation.
75  */
76 unsigned int intel_cqm_threshold;
77
78 static inline struct rmid_entry *__rmid_entry(u32 rmid)
79 {
80         struct rmid_entry *entry;
81
82         entry = &rmid_ptrs[rmid];
83         WARN_ON(entry->rmid != rmid);
84
85         return entry;
86 }
87
88 static u64 __rmid_read(u32 rmid, u32 eventid)
89 {
90         u64 val;
91
92         /*
93          * As per the SDM, when IA32_QM_EVTSEL.EvtID (bits 7:0) is configured
94          * with a valid event code for supported resource type and the bits
95          * IA32_QM_EVTSEL.RMID (bits 41:32) are configured with valid RMID,
96          * IA32_QM_CTR.data (bits 61:0) reports the monitored data.
97          * IA32_QM_CTR.Error (bit 63) and IA32_QM_CTR.Unavailable (bit 62)
98          * are error bits.
99          */
100         wrmsr(MSR_IA32_QM_EVTSEL, eventid, rmid);
101         rdmsrl(MSR_IA32_QM_CTR, val);
102
103         return val;
104 }
105
106 static bool rmid_dirty(struct rmid_entry *entry)
107 {
108         u64 val = __rmid_read(entry->rmid, QOS_L3_OCCUP_EVENT_ID);
109
110         return val >= intel_cqm_threshold;
111 }
112
113 /*
114  * Check the RMIDs that are marked as busy for this domain. If the
115  * reported LLC occupancy is below the threshold clear the busy bit and
116  * decrement the count. If the busy count gets to zero on an RMID, we
117  * free the RMID
118  */
119 void __check_limbo(struct rdt_domain *d, bool force_free)
120 {
121         struct rmid_entry *entry;
122         struct rdt_resource *r;
123         u32 crmid = 1, nrmid;
124
125         r = &rdt_resources_all[RDT_RESOURCE_L3];
126
127         /*
128          * Skip RMID 0 and start from RMID 1 and check all the RMIDs that
129          * are marked as busy for occupancy < threshold. If the occupancy
130          * is less than the threshold decrement the busy counter of the
131          * RMID and move it to the free list when the counter reaches 0.
132          */
133         for (;;) {
134                 nrmid = find_next_bit(d->rmid_busy_llc, r->num_rmid, crmid);
135                 if (nrmid >= r->num_rmid)
136                         break;
137
138                 entry = __rmid_entry(nrmid);
139                 if (force_free || !rmid_dirty(entry)) {
140                         clear_bit(entry->rmid, d->rmid_busy_llc);
141                         if (!--entry->busy) {
142                                 rmid_limbo_count--;
143                                 list_add_tail(&entry->list, &rmid_free_lru);
144                         }
145                 }
146                 crmid = nrmid + 1;
147         }
148 }
149
150 bool has_busy_rmid(struct rdt_resource *r, struct rdt_domain *d)
151 {
152         return find_first_bit(d->rmid_busy_llc, r->num_rmid) != r->num_rmid;
153 }
154
155 /*
156  * As of now the RMIDs allocation is global.
157  * However we keep track of which packages the RMIDs
158  * are used to optimize the limbo list management.
159  */
160 int alloc_rmid(void)
161 {
162         struct rmid_entry *entry;
163
164         lockdep_assert_held(&rdtgroup_mutex);
165
166         if (list_empty(&rmid_free_lru))
167                 return rmid_limbo_count ? -EBUSY : -ENOSPC;
168
169         entry = list_first_entry(&rmid_free_lru,
170                                  struct rmid_entry, list);
171         list_del(&entry->list);
172
173         return entry->rmid;
174 }
175
176 static void add_rmid_to_limbo(struct rmid_entry *entry)
177 {
178         struct rdt_resource *r;
179         struct rdt_domain *d;
180         int cpu;
181         u64 val;
182
183         r = &rdt_resources_all[RDT_RESOURCE_L3];
184
185         entry->busy = 0;
186         cpu = get_cpu();
187         list_for_each_entry(d, &r->domains, list) {
188                 if (cpumask_test_cpu(cpu, &d->cpu_mask)) {
189                         val = __rmid_read(entry->rmid, QOS_L3_OCCUP_EVENT_ID);
190                         if (val <= intel_cqm_threshold)
191                                 continue;
192                 }
193
194                 /*
195                  * For the first limbo RMID in the domain,
196                  * setup up the limbo worker.
197                  */
198                 if (!has_busy_rmid(r, d))
199                         cqm_setup_limbo_handler(d, CQM_LIMBOCHECK_INTERVAL);
200                 set_bit(entry->rmid, d->rmid_busy_llc);
201                 entry->busy++;
202         }
203         put_cpu();
204
205         if (entry->busy)
206                 rmid_limbo_count++;
207         else
208                 list_add_tail(&entry->list, &rmid_free_lru);
209 }
210
211 void free_rmid(u32 rmid)
212 {
213         struct rmid_entry *entry;
214
215         if (!rmid)
216                 return;
217
218         lockdep_assert_held(&rdtgroup_mutex);
219
220         entry = __rmid_entry(rmid);
221
222         if (is_llc_occupancy_enabled())
223                 add_rmid_to_limbo(entry);
224         else
225                 list_add_tail(&entry->list, &rmid_free_lru);
226 }
227
228 static u64 __mon_event_count(u32 rmid, struct rmid_read *rr)
229 {
230         u64 chunks, shift, tval;
231         struct mbm_state *m;
232
233         tval = __rmid_read(rmid, rr->evtid);
234         if (tval & (RMID_VAL_ERROR | RMID_VAL_UNAVAIL)) {
235                 return tval;
236         }
237         switch (rr->evtid) {
238         case QOS_L3_OCCUP_EVENT_ID:
239                 rr->val += tval;
240                 return 0;
241         case QOS_L3_MBM_TOTAL_EVENT_ID:
242                 m = &rr->d->mbm_total[rmid];
243                 break;
244         case QOS_L3_MBM_LOCAL_EVENT_ID:
245                 m = &rr->d->mbm_local[rmid];
246                 break;
247         default:
248                 /*
249                  * Code would never reach here because an invalid
250                  * event id would fail the __rmid_read.
251                  */
252                 return RMID_VAL_ERROR;
253         }
254
255         if (rr->first) {
256                 m->prev_msr = tval;
257                 m->chunks = 0;
258                 return 0;
259         }
260
261         shift = 64 - MBM_CNTR_WIDTH;
262         chunks = (tval << shift) - (m->prev_msr << shift);
263         chunks >>= shift;
264         m->chunks += chunks;
265         m->prev_msr = tval;
266
267         rr->val += m->chunks;
268         return 0;
269 }
270
271 /*
272  * This is called via IPI to read the CQM/MBM counters
273  * on a domain.
274  */
275 void mon_event_count(void *info)
276 {
277         struct rdtgroup *rdtgrp, *entry;
278         struct rmid_read *rr = info;
279         struct list_head *head;
280         u64 ret_val;
281
282         rdtgrp = rr->rgrp;
283
284         ret_val = __mon_event_count(rdtgrp->mon.rmid, rr);
285
286         /*
287          * For Ctrl groups read data from child monitor groups and
288          * add them together. Count events which are read successfully.
289          * Discard the rmid_read's reporting errors.
290          */
291         head = &rdtgrp->mon.crdtgrp_list;
292
293         if (rdtgrp->type == RDTCTRL_GROUP) {
294                 list_for_each_entry(entry, head, mon.crdtgrp_list) {
295                         if (__mon_event_count(entry->mon.rmid, rr) == 0)
296                                 ret_val = 0;
297                 }
298         }
299
300         /* Report error if none of rmid_reads are successful */
301         if (ret_val)
302                 rr->val = ret_val;
303 }
304
305 static void mbm_update(struct rdt_domain *d, int rmid)
306 {
307         struct rmid_read rr;
308
309         rr.first = false;
310         rr.d = d;
311
312         /*
313          * This is protected from concurrent reads from user
314          * as both the user and we hold the global mutex.
315          */
316         if (is_mbm_total_enabled()) {
317                 rr.evtid = QOS_L3_MBM_TOTAL_EVENT_ID;
318                 __mon_event_count(rmid, &rr);
319         }
320         if (is_mbm_local_enabled()) {
321                 rr.evtid = QOS_L3_MBM_LOCAL_EVENT_ID;
322                 __mon_event_count(rmid, &rr);
323         }
324 }
325
326 /*
327  * Handler to scan the limbo list and move the RMIDs
328  * to free list whose occupancy < threshold_occupancy.
329  */
330 void cqm_handle_limbo(struct work_struct *work)
331 {
332         unsigned long delay = msecs_to_jiffies(CQM_LIMBOCHECK_INTERVAL);
333         int cpu = smp_processor_id();
334         struct rdt_resource *r;
335         struct rdt_domain *d;
336
337         mutex_lock(&rdtgroup_mutex);
338
339         r = &rdt_resources_all[RDT_RESOURCE_L3];
340         d = get_domain_from_cpu(cpu, r);
341
342         if (!d) {
343                 pr_warn_once("Failure to get domain for limbo worker\n");
344                 goto out_unlock;
345         }
346
347         __check_limbo(d, false);
348
349         if (has_busy_rmid(r, d))
350                 schedule_delayed_work_on(cpu, &d->cqm_limbo, delay);
351
352 out_unlock:
353         mutex_unlock(&rdtgroup_mutex);
354 }
355
356 void cqm_setup_limbo_handler(struct rdt_domain *dom, unsigned long delay_ms)
357 {
358         unsigned long delay = msecs_to_jiffies(delay_ms);
359         struct rdt_resource *r;
360         int cpu;
361
362         r = &rdt_resources_all[RDT_RESOURCE_L3];
363
364         cpu = cpumask_any(&dom->cpu_mask);
365         dom->cqm_work_cpu = cpu;
366
367         schedule_delayed_work_on(cpu, &dom->cqm_limbo, delay);
368 }
369
370 void mbm_handle_overflow(struct work_struct *work)
371 {
372         unsigned long delay = msecs_to_jiffies(MBM_OVERFLOW_INTERVAL);
373         struct rdtgroup *prgrp, *crgrp;
374         int cpu = smp_processor_id();
375         struct list_head *head;
376         struct rdt_domain *d;
377
378         mutex_lock(&rdtgroup_mutex);
379
380         if (!static_branch_likely(&rdt_enable_key))
381                 goto out_unlock;
382
383         d = get_domain_from_cpu(cpu, &rdt_resources_all[RDT_RESOURCE_L3]);
384         if (!d)
385                 goto out_unlock;
386
387         list_for_each_entry(prgrp, &rdt_all_groups, rdtgroup_list) {
388                 mbm_update(d, prgrp->mon.rmid);
389
390                 head = &prgrp->mon.crdtgrp_list;
391                 list_for_each_entry(crgrp, head, mon.crdtgrp_list)
392                         mbm_update(d, crgrp->mon.rmid);
393         }
394
395         schedule_delayed_work_on(cpu, &d->mbm_over, delay);
396
397 out_unlock:
398         mutex_unlock(&rdtgroup_mutex);
399 }
400
401 void mbm_setup_overflow_handler(struct rdt_domain *dom, unsigned long delay_ms)
402 {
403         unsigned long delay = msecs_to_jiffies(delay_ms);
404         int cpu;
405
406         if (!static_branch_likely(&rdt_enable_key))
407                 return;
408         cpu = cpumask_any(&dom->cpu_mask);
409         dom->mbm_work_cpu = cpu;
410         schedule_delayed_work_on(cpu, &dom->mbm_over, delay);
411 }
412
413 static int dom_data_init(struct rdt_resource *r)
414 {
415         struct rmid_entry *entry = NULL;
416         int i, nr_rmids;
417
418         nr_rmids = r->num_rmid;
419         rmid_ptrs = kcalloc(nr_rmids, sizeof(struct rmid_entry), GFP_KERNEL);
420         if (!rmid_ptrs)
421                 return -ENOMEM;
422
423         for (i = 0; i < nr_rmids; i++) {
424                 entry = &rmid_ptrs[i];
425                 INIT_LIST_HEAD(&entry->list);
426
427                 entry->rmid = i;
428                 list_add_tail(&entry->list, &rmid_free_lru);
429         }
430
431         /*
432          * RMID 0 is special and is always allocated. It's used for all
433          * tasks that are not monitored.
434          */
435         entry = __rmid_entry(0);
436         list_del(&entry->list);
437
438         return 0;
439 }
440
441 static struct mon_evt llc_occupancy_event = {
442         .name           = "llc_occupancy",
443         .evtid          = QOS_L3_OCCUP_EVENT_ID,
444 };
445
446 static struct mon_evt mbm_total_event = {
447         .name           = "mbm_total_bytes",
448         .evtid          = QOS_L3_MBM_TOTAL_EVENT_ID,
449 };
450
451 static struct mon_evt mbm_local_event = {
452         .name           = "mbm_local_bytes",
453         .evtid          = QOS_L3_MBM_LOCAL_EVENT_ID,
454 };
455
456 /*
457  * Initialize the event list for the resource.
458  *
459  * Note that MBM events are also part of RDT_RESOURCE_L3 resource
460  * because as per the SDM the total and local memory bandwidth
461  * are enumerated as part of L3 monitoring.
462  */
463 static void l3_mon_evt_init(struct rdt_resource *r)
464 {
465         INIT_LIST_HEAD(&r->evt_list);
466
467         if (is_llc_occupancy_enabled())
468                 list_add_tail(&llc_occupancy_event.list, &r->evt_list);
469         if (is_mbm_total_enabled())
470                 list_add_tail(&mbm_total_event.list, &r->evt_list);
471         if (is_mbm_local_enabled())
472                 list_add_tail(&mbm_local_event.list, &r->evt_list);
473 }
474
475 int rdt_get_mon_l3_config(struct rdt_resource *r)
476 {
477         int ret;
478
479         r->mon_scale = boot_cpu_data.x86_cache_occ_scale;
480         r->num_rmid = boot_cpu_data.x86_cache_max_rmid + 1;
481
482         /*
483          * A reasonable upper limit on the max threshold is the number
484          * of lines tagged per RMID if all RMIDs have the same number of
485          * lines tagged in the LLC.
486          *
487          * For a 35MB LLC and 56 RMIDs, this is ~1.8% of the LLC.
488          */
489         intel_cqm_threshold = boot_cpu_data.x86_cache_size * 1024 / r->num_rmid;
490
491         /* h/w works in units of "boot_cpu_data.x86_cache_occ_scale" */
492         intel_cqm_threshold /= r->mon_scale;
493
494         ret = dom_data_init(r);
495         if (ret)
496                 return ret;
497
498         l3_mon_evt_init(r);
499
500         r->mon_capable = true;
501         r->mon_enabled = true;
502
503         return 0;
504 }