summaryrefslogtreecommitdiff
path: root/arch/x86/machine/pmu_intel.c
blob: 0833a715f25ced4d1f1fc473494dec166125ed13 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
/*
 * Copyright (c) 2014-2018 Remy Noel.
 * Copyright (c) 2014 Richard Braun.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * INTEL PMU driver module.
 */

#include <stdint.h>

#include <include/assert.h>
#include <kern/error.h>
#include <kern/init.h>
#include <kern/log.h>
#include <kern/perfmon.h>
#include <machine/cpu.h>
#include <machine/pmu.h>

/*
 * Intel raw event IDs.
 */
#define PMU_INTEL_RE_CYCLE          0
#define PMU_INTEL_RE_REF_CYCLE      1
#define PMU_INTEL_RE_INSTRUCTION    2
#define PMU_INTEL_RE_CACHE_REF      3
#define PMU_INTEL_RE_CACHE_MISS     4
#define PMU_INTEL_RE_BRANCH         5
#define PMU_INTEL_RE_BRANCH_MISS    6

/*
 * PMU MSR addresses
 */
#define PMU_INTEL_MSR_PMC0      0x0c1
#define PMU_INTEL_MSR_EVTSEL0   0x186

/*
 * V2 MSR addresses
 */
#define PMU_INTEL_MSR_FIXED_CTR0        0x0309
#define PMU_INTEL_MSR_FIXED_CTR1        0x030a
#define PMU_INTEL_MSR_FIXED_CTR2        0x030b
#define PMU_INTEL_MSR_FIXED_CTR_CTRL    0x038d
#define PMU_INTEL_MSR_GLOBAL_STATUS     0x038e
#define PMU_INTEL_MSR_GLOBAL_CTRL       0x038f
#define PMU_INTEL_MSR_GLOBAL_OVF_CTRL   0x0390

/*
 * Event Select Register addresses
 */
#define PMU_INTEL_EVTSEL_USR    0x00010000
#define PMU_INTEL_EVTSEL_OS     0x00020000
#define PMU_INTEL_EVTSEL_EDGE   0x00040000
#define PMU_INTEL_EVTSEL_PC     0x00080000
#define PMU_INTEL_EVTSEL_INT    0x00100000
#define PMU_INTEL_EVTSEL_EN     0x00400000
#define PMU_INTEL_EVTSEL_INV    0x00800000

#define PMU_INTEL_ID_VERSION_MASK       0x000000ff
#define PMU_INTEL_ID_NR_PMCS_MASK       0x0000ff00
#define PMU_INTEL_ID_NR_PMCS_OFFSET     8
#define PMU_INTEL_ID_PMC_WIDTH_MASK     0x00ff0000
#define PMU_INTEL_ID_PMC_WIDTH_OFFSET   16
#define PMU_INTEL_ID_EVLEN_MASK         0xff000000
#define PMU_INTEL_ID_EVLEN_OFFSET       24
#define PMU_INTEL_ID_EVLEN_MAX          7

struct pmu_intel {
    unsigned int version;
    unsigned int nr_pmcs;
    unsigned int pmc_bm;
    unsigned int pmc_width;
    unsigned int events;
};

struct pmu_intel_event_code {
    unsigned int hw_event_id;
    unsigned short event_select;
    unsigned short umask;
};

static struct pmu_intel pmu_intel;

/*
 * Intel hardware events.
 */
#define PMU_INTEL_EVENT_CYCLE          0x01
#define PMU_INTEL_EVENT_INSTRUCTION    0x02
#define PMU_INTEL_EVENT_REF_CYCLE      0x04
#define PMU_INTEL_EVENT_CACHE_REF      0x08
#define PMU_INTEL_EVENT_CACHE_MISS     0x10
#define PMU_INTEL_EVENT_BRANCH         0x20
#define PMU_INTEL_EVENT_BRANCH_MISS    0x40

static const unsigned int pmu_intel_raw_events[] = {
    [PERFMON_EV_CYCLE]          = PMU_INTEL_RE_CYCLE,
    [PERFMON_EV_REF_CYCLE]      = PMU_INTEL_RE_REF_CYCLE,
    [PERFMON_EV_INSTRUCTION]    = PMU_INTEL_RE_INSTRUCTION,
    [PERFMON_EV_CACHE_REF]      = PMU_INTEL_RE_CACHE_REF,
    [PERFMON_EV_CACHE_MISS]     = PMU_INTEL_RE_CACHE_MISS,
    [PERFMON_EV_BRANCH]         = PMU_INTEL_RE_BRANCH,
    [PERFMON_EV_BRANCH_MISS]    = PMU_INTEL_RE_BRANCH_MISS,
};

static const struct pmu_intel_event_code pmu_intel_event_codes[] = {
    [PMU_INTEL_RE_CYCLE]        = { PMU_INTEL_EVENT_CYCLE,        0x3c, 0x00 },
    [PMU_INTEL_RE_REF_CYCLE]    = { PMU_INTEL_EVENT_REF_CYCLE,    0x3c, 0x01 },
    [PMU_INTEL_RE_INSTRUCTION]  = { PMU_INTEL_EVENT_INSTRUCTION,  0xc0, 0x00 },
    [PMU_INTEL_RE_CACHE_REF]    = { PMU_INTEL_EVENT_CACHE_REF,    0x2e, 0x4f },
    [PMU_INTEL_RE_CACHE_MISS]   = { PMU_INTEL_EVENT_CACHE_MISS,   0x2e, 0x41 },
    [PMU_INTEL_RE_BRANCH]       = { PMU_INTEL_EVENT_BRANCH,       0xc4, 0x00 },
    [PMU_INTEL_RE_BRANCH_MISS]  = { PMU_INTEL_EVENT_BRANCH_MISS,  0xc5, 0x00 },
};

static struct pmu_intel *
pmu_intel_get(void)
{
    return &pmu_intel;
}

static uint64_t
pmu_intel_get_status(void)
{
    return cpu_get_msr64(PMU_INTEL_MSR_GLOBAL_STATUS);
}

static void
pmu_intel_ack_status(uint64_t status)
{
    return cpu_set_msr64(PMU_INTEL_MSR_GLOBAL_OVF_CTRL, status);
}

static unsigned int
pmu_popcount(unsigned int bits)
{
    unsigned int count = 0;

    /* XXX: Dummy version of popcount. We should implement a faster one if it
     * gets needed somewhere else.
     */
    while (bits) {
        if (bits & 1) {
            count++;
        }
        bits >>= 1;
    }
    return count;
}

static void
pmu_intel_info(void)
{
    const struct pmu_intel *pmu;
    unsigned int nr_events;

    pmu = pmu_intel_get();
    nr_events = pmu_popcount(pmu->events);
    log_info("pmu: driver: intel, architectural v1\n"
            "pmu: nr_pmcs: %u, pmc_width: %u, events: %#x, nr_events: %u\n",
            pmu->nr_pmcs, pmu->pmc_width, pmu->events, nr_events);
}

static int
pmu_intel_translate(unsigned int *raw_event_idp, unsigned event_id)
{
    if (event_id >= ARRAY_SIZE(pmu_intel_raw_events)) {
        return EINVAL;
    }

    *raw_event_idp = pmu_intel_raw_events[event_id];

    return 0;
}

static int
pmu_intel_alloc(unsigned int *pmc_idp, unsigned int raw_event_id)
{
    struct pmu_intel *pmu;
    unsigned int pmc_id;
    unsigned int hw_event_id;

    assert(raw_event_id < ARRAY_SIZE(pmu_intel_event_codes));

    pmu = pmu_intel_get();
    hw_event_id = pmu_intel_event_codes[raw_event_id].hw_event_id;

    if (!(pmu->events & hw_event_id)) {
        return EINVAL;
    }

    if (pmu->pmc_bm == 0) {
        return EAGAIN;
    }

    pmc_id = __builtin_ffs(pmu->pmc_bm) - 1;
    pmu->pmc_bm &= ~(1U << pmc_id);
    *pmc_idp = pmc_id;
    return 0;
}

static void
pmu_intel_free(unsigned int pmc_id)
{
    struct pmu_intel *pmu;
    unsigned int mask;

    pmu = pmu_intel_get();
    mask = (1U << pmc_id);

    assert(!(pmu->pmc_bm & mask));

    pmu->pmc_bm |= mask;
}

static void
pmu_intel_start(unsigned int pmc_id, unsigned int raw_event_id)
{
    const struct pmu_intel_event_code *code;
    uint32_t evtsel;

    assert(raw_event_id < ARRAY_SIZE(pmu_intel_event_codes));

    code = &pmu_intel_event_codes[raw_event_id];

    /* TODO Handle PERFMON_EF_KERN/PERFMON_EF_USER */
    evtsel = PMU_INTEL_EVTSEL_EN
             | PMU_INTEL_EVTSEL_OS
             | PMU_INTEL_EVTSEL_USR
             | PMU_INTEL_EVTSEL_INT
             | (code->umask << 8)
             | code->event_select;
    cpu_set_msr(PMU_INTEL_MSR_EVTSEL0 + pmc_id, 0, evtsel);
}

static void
pmu_intel_stop(unsigned int pmc_id)
{
    cpu_set_msr(PMU_INTEL_MSR_EVTSEL0 + pmc_id, 0, 0);
}

static uint64_t
pmu_intel_read(unsigned int pmc_id)
{
    return cpu_get_msr64(PMU_INTEL_MSR_PMC0 + pmc_id);
}

#ifdef CONFIG_PERFMON_TEST

static void
pmu_intel_write(unsigned int pmc_id, uint64_t value)
{
    cpu_set_msr64(PMU_INTEL_MSR_PMC0 + pmc_id, value);
}

#endif /* CONFIG_PERFMON_TEST */

static void
pmu_intel_handle_of_intr_v1(struct trap_frame *frame)
{
    struct pmu_intel *pmu;
    unsigned int mask;
    uint64_t value;
    uint64_t prev;

    (void)frame;

    pmu = pmu_intel_get();

    for (unsigned int pmc_id = 0; pmc_id != pmu->nr_pmcs; pmc_id++) {
        mask = (1U << pmc_id);
        if (pmu->pmc_bm & mask) {
            /* counter not enabled: can't overflow. */
            continue;
        }

        value = pmu_intel_read(pmc_id);
        prev = perfmon_cpu_pmc_get_prev(pmc_id);
        if (prev > value) {
            /* Overflow */
            perfmon_cpu_pmc_inc_of(pmc_id);
            /* Prevents us from overflowing twice */
            perfmon_cpu_pmc_set_prev(pmc_id, value);
        }
    }
}

static int
pmu_intel_consume_bits(uint64_t *bits)
{
    int bit;

    bit = __builtin_ffsll(*bits) - 1;
    if (bit < 0) {
        return bit;
    }
    *bits &= ~(1U << bit);

    return bit;
}

static void
pmu_intel_handle_of_intr_v2(struct trap_frame *frame)
{
    struct pmu_intel *pmu;
    uint64_t status;
    int pmc_id;

    (void)frame;

    status = pmu_intel_get_status();
    if (status == 0) {
        return;
    }
    pmu_intel_ack_status(status);
    pmu = pmu_intel_get();

    /* XXX: Mask on all PMCs (we do not check FIXED counters status */
    status &= ((1U << pmu->pmc_width) - 1);
    for(;;) {
        pmc_id = pmu_intel_consume_bits(&status);
        if (pmc_id < 0) {
            break;
        }
        perfmon_cpu_pmc_inc_of(pmc_id);
    }
}

static uint8_t
pmu_intel_get_pmc_width(void)
{
    struct pmu_intel *pmu;

    pmu = pmu_intel_get();

    return pmu->pmc_width;
}

static int __init
pmu_intel_setup(void)
{
    const struct cpu *cpu;
    struct pmu_intel *pmu;
    struct perfmon_pmu_ops pmu_driver;
    unsigned int eax, ebx, ecx, edx, ev_len;

    cpu = cpu_current();
    eax = 0xa;

    if (cpu->vendor_id != CPU_VENDOR_INTEL) {
        return 0;
    }

    if (cpu->cpuid_max_basic < eax) {
        return ENODEV;
    }

    pmu = pmu_intel_get();
    cpu_cpuid(&eax, &ebx, &ecx, &edx);
    pmu->version = eax & PMU_INTEL_ID_VERSION_MASK;

    if ((pmu->version == 0) || (pmu->version > 3)) {
        return ENODEV;
    }

    pmu->nr_pmcs = (eax & PMU_INTEL_ID_NR_PMCS_MASK)
                   >> PMU_INTEL_ID_NR_PMCS_OFFSET;
    pmu->pmc_bm = (1U << pmu->nr_pmcs ) - 1;
    pmu->pmc_width = (eax & PMU_INTEL_ID_PMC_WIDTH_MASK)
                     >> PMU_INTEL_ID_PMC_WIDTH_OFFSET;
    ev_len = (eax & PMU_INTEL_ID_EVLEN_MASK) >> PMU_INTEL_ID_EVLEN_OFFSET;

    assert(ev_len <= PMU_INTEL_ID_EVLEN_MAX);

    pmu->events = ~ebx & ((1U << ev_len) - 1);

    pmu_driver.info = pmu_intel_info;
    pmu_driver.translate = pmu_intel_translate;
    pmu_driver.alloc = pmu_intel_alloc;
    pmu_driver.free = pmu_intel_free;
    pmu_driver.start = pmu_intel_start;
    pmu_driver.stop = pmu_intel_stop;
    pmu_driver.read = pmu_intel_read;
    pmu_driver.get_pmc_width = pmu_intel_get_pmc_width;
    if (pmu->version > 2) {
        pmu_driver.handle_of_intr = pmu_intel_handle_of_intr_v1;
    } else {
        pmu_driver.handle_of_intr = pmu_intel_handle_of_intr_v2;
    }
#ifdef CONFIG_PERFMON_TEST
    pmu_driver.write = pmu_intel_write;
#endif

    return perfmon_pmu_register(&pmu_driver);
}

INIT_OP_DEFINE(pmu_intel_setup,
               INIT_OP_DEP(perfmon_bootstrap, true),
               INIT_OP_DEP(cpu_setup, true),
               INIT_OP_DEP(log_setup, true));