x86: Upgrade backtrace
[akaros.git] / kern / arch / x86 / perfmon.c
index 10c027c..c313c91 100644 (file)
@@ -1,7 +1,34 @@
 /* Copyright (c) 2015 Google Inc
  * Davide Libenzi <dlibenzi@google.com>
+ * Barret Rhoden <brho@cs.berkeley.edu>
  * See LICENSE for details.
- */
+ *
+ * Manages the setting and reading of hardware perf counters across all cores,
+ * including generating samples in response to counter overflow interrupts.
+ *
+ * The hardware interface is pretty straightforward - it's mostly setting and
+ * unsetting fixed and unfixed events, sometimes with interrupts and trigger
+ * counts.
+ *
+ * The 'command' to the cores is a struct perfmon_alloc.  This tells the core
+ * which event to set up (this is the perfmon_event).  The cores respond in
+ * counters[], saying which of their counters it is using for that event.  If
+ * the cores are given different alloc requests, it is possible that they might
+ * choose different counters[] for the same event.
+ *
+ * These perfmon_allocs are collected in a perfmon_session.  The session is just
+ * a bunch of allocs, which are referred to by index (the 'ped').  Currently,
+ * the session is grabbed by whoever opens the perf FD in devarch, and closed
+ * when that FD is closed.  They are 1:1 with devarch's perf_contexts.
+ *
+ * The values for the counters are extracted with perfmon_get_event_status(),
+ * which uses a struct perfmon_status to collect the results.  We pass the
+ * perfmon_alloc as part of the perfmon_status_env, since we need to tell the
+ * core which counter we're talking about.
+ *
+ * You can have multiple sessions, but if you try to install the same counter in
+ * multiple, concurrent sessions, the hardware might complain (it definitely
+ * will if it is a fixed event). */
 
 #include <sys/types.h>
 #include <arch/ros/msr-index.h>
@@ -15,7 +42,6 @@
 #include <smp.h>
 #include <atomic.h>
 #include <core_set.h>
-#include <kref.h>
 #include <percpu.h>
 #include <kmalloc.h>
 #include <err.h>
@@ -64,66 +90,91 @@ static void perfmon_read_cpu_caps(struct perfmon_cpu_caps *pcc)
        pcc->perfmon_version = a & 0xff;
 }
 
-static void perfmon_enable_event(int event)
+static void perfmon_enable_event(int idx, uint64_t event)
 {
-       uint64_t gctrl = read_msr(MSR_CORE_PERF_GLOBAL_CTRL);
+       uint64_t gctrl;
 
-       write_msr(MSR_CORE_PERF_GLOBAL_CTRL, gctrl | (1 << event));
-}
-
-static void perfmon_disable_event(int event)
-{
-       uint64_t gctrl = read_msr(MSR_CORE_PERF_GLOBAL_CTRL);
-
-       write_msr(MSR_CORE_PERF_GLOBAL_CTRL, gctrl & ~(1 << event));
-}
-
-static void perfmon_enable_fix_event(int event)
-{
-       uint64_t gctrl = read_msr(MSR_CORE_PERF_GLOBAL_CTRL);
-
-       write_msr(MSR_CORE_PERF_GLOBAL_CTRL,
-                 gctrl | ((uint64_t) 1 << (32 + event)));
+       /* Events need to be enabled in both MSRs */
+       write_msr(MSR_ARCH_PERFMON_EVENTSEL0 + idx, event);
+       gctrl = read_msr(MSR_CORE_PERF_GLOBAL_CTRL);
+       write_msr(MSR_CORE_PERF_GLOBAL_CTRL, gctrl | (1 << idx));
 }
 
-static void perfmon_disable_fix_event(int event)
+static void perfmon_disable_event(int idx)
 {
-       uint64_t gctrl = read_msr(MSR_CORE_PERF_GLOBAL_CTRL);
+       uint64_t gctrl;
 
-       write_msr(MSR_CORE_PERF_GLOBAL_CTRL,
-                 gctrl & ~((uint64_t) 1 << (32 + event)));
+       /* Events can be disabled in either location.  We could just clear the
+        * global ctrl, but we use the contents of EVENTSEL to say if the counter is
+        * available or not. */
+       write_msr(MSR_ARCH_PERFMON_EVENTSEL0 + idx, 0);
+       gctrl = read_msr(MSR_CORE_PERF_GLOBAL_CTRL);
+       write_msr(MSR_CORE_PERF_GLOBAL_CTRL, gctrl & ~(1 << idx));
 }
 
-static bool perfmon_event_available(uint32_t event)
+static bool perfmon_event_available(uint32_t idx)
 {
-       return read_msr(MSR_ARCH_PERFMON_EVENTSEL0 + event) == 0;
+       return read_msr(MSR_ARCH_PERFMON_EVENTSEL0 + idx) == 0;
 }
 
-static uint64_t perfmon_get_fixevent_mask(const struct perfmon_event *pev,
-                                          int eventno, uint64_t base)
+/* Helper.  Given an event, a fixed counter index, and the contents of the fixed
+ * counter ctl MSR, output the value for the fixed counter ctl that will enable
+ * the event at idx. */
+static uint64_t perfmon_apply_fixevent_mask(uint64_t event, int idx,
+                                            uint64_t base)
 {
        uint64_t m = 0;
 
-       if (PMEV_GET_INTEN(pev->event))
-               m |= 1 << 3;
-       if (PMEV_GET_OS(pev->event))
+       if (PMEV_GET_OS(event))
                m |= (1 << 0);
-       if (PMEV_GET_USR(pev->event))
+       if (PMEV_GET_USR(event))
                m |= (1 << 1);
-       if (PMEV_GET_ANYTH(pev->event) && (cpu_caps.perfmon_version >= 3))
+       if (PMEV_GET_ANYTH(event) && (cpu_caps.perfmon_version >= 3))
                m |= (1 << 2);
+       if (PMEV_GET_INTEN(event))
+               m |= (1 << 3);
        /* Enable enforcement: we need at least one bit set so that this fixed
         * counter appears to be in use. */
-       if (PMEV_GET_EN(pev->event) && !PMEV_GET_OS(pev->event) &&
-           !PMEV_GET_USR(pev->event))
+       if (PMEV_GET_EN(event) && !PMEV_GET_OS(event) && !PMEV_GET_USR(event))
                m |= (1 << 0) | (1 << 1);
 
-       m <<= eventno * FIXCNTR_NBITS;
-       m |= base & ~(FIXCNTR_MASK << (eventno * FIXCNTR_NBITS));
+       m <<= idx * FIXCNTR_NBITS;
+       m |= base & ~(FIXCNTR_MASK << (idx * FIXCNTR_NBITS));
 
        return m;
 }
 
+/* These helpers take the fxctrl_value to save on a rdmsr. */
+static void perfmon_enable_fix_event(int idx, uint64_t event,
+                                     uint64_t fxctrl_value)
+{
+       uint64_t gctrl, fx;
+
+       /* Enable in both locations: the bits in FIXED and the bit in GLOBAL. */
+       fx = perfmon_apply_fixevent_mask(event, idx, fxctrl_value);
+       write_msr(MSR_CORE_PERF_FIXED_CTR_CTRL, fx);
+       gctrl = read_msr(MSR_CORE_PERF_GLOBAL_CTRL);
+       write_msr(MSR_CORE_PERF_GLOBAL_CTRL, gctrl | ((uint64_t) 1 << (32 + idx)));
+}
+
+static void perfmon_disable_fix_event(int idx, uint64_t fxctrl_value)
+{
+       uint64_t gctrl;
+
+       /* Events can be disabled in either location.  We could just clear the
+        * global ctrl, but we use the bits of fxctlr to say if the counter is
+        * available or not. */
+       write_msr(MSR_CORE_PERF_FIXED_CTR_CTRL,
+                 fxctrl_value & ~(FIXCNTR_MASK << (idx * FIXCNTR_NBITS)));
+       gctrl = read_msr(MSR_CORE_PERF_GLOBAL_CTRL);
+       write_msr(MSR_CORE_PERF_GLOBAL_CTRL, gctrl & ~((uint64_t) 1 << (32 + idx)));
+}
+
+static bool perfmon_fix_event_available(uint32_t idx, uint64_t fxctrl_value)
+{
+       return (fxctrl_value & (FIXCNTR_MASK << (idx * FIXCNTR_NBITS))) == 0;
+}
+
 /* Helper to set a fixed perfcounter to trigger/overflow after count events.
  * Anytime you set a perfcounter to something non-zero, you need to use this
  * helper. */
@@ -146,6 +197,29 @@ static void perfmon_set_unfixed_trigger(unsigned int idx, uint64_t count)
        write_msr(MSR_IA32_PERFCTR0 + idx, write_val);
 }
 
+/* Helper: sets errno/errstr based on the error code returned from the core.  We
+ * don't have a great way to get errors back from smp_do_in_cores() commands.
+ * We use negative counter values (e.g. i = -EBUSY) to signal an error of a
+ * certain type.  This converts that to something useful for userspace. */
+static void perfmon_convert_error(int err_code, int core_id)
+{
+       switch (err_code) {
+       case EBUSY:
+               set_error(err_code, "Fixed perf counter is busy on core %d", core_id);
+               break;
+       case ENOSPC:
+               set_error(err_code, "Perf counter idx out of range on core %d",
+                         core_id);
+               break;
+       case ENOENT:
+               set_error(err_code, "Perf counter not set on core %d", core_id);
+               break;
+       default:
+               set_error(err_code, "Unknown perf counter error on core %d", core_id);
+               break;
+       };
+}
+
 static void perfmon_do_cores_alloc(void *opaque)
 {
        struct perfmon_alloc *pa = (struct perfmon_alloc *) opaque;
@@ -156,12 +230,11 @@ static void perfmon_do_cores_alloc(void *opaque)
        spin_lock_irqsave(&cctx->lock);
        if (perfmon_is_fixed_event(&pa->ev)) {
                uint64_t fxctrl_value = read_msr(MSR_CORE_PERF_FIXED_CTR_CTRL);
-               uint64_t tmp;
 
                i = PMEV_GET_EVENT(pa->ev.event);
                if (i >= (int) cpu_caps.fix_counters_x_proc) {
-                       i = -EINVAL;
-               } else if (fxctrl_value & (FIXCNTR_MASK << (i * FIXCNTR_NBITS))) {
+                       i = -ENOSPC;
+               } else if (!perfmon_fix_event_available(i, fxctrl_value)) {
                        i = -EBUSY;
                } else {
                        /* Keep a copy of pa->ev for later.  pa is read-only and shared. */
@@ -172,18 +245,14 @@ static void perfmon_do_cores_alloc(void *opaque)
                        else
                                write_msr(MSR_CORE_PERF_FIXED_CTR0 + i, 0);
                        write_msr(MSR_CORE_PERF_GLOBAL_OVF_CTRL, 1ULL << (32 + i));
-                       /* Event needs to be enabled in both MSRs */
-                       perfmon_enable_fix_event(i);
-                       tmp = perfmon_get_fixevent_mask(pev, i, fxctrl_value);
-                       write_msr(MSR_CORE_PERF_FIXED_CTR_CTRL, tmp);
+                       perfmon_enable_fix_event(i, pev->event, fxctrl_value);
                }
        } else {
                for (i = 0; i < (int) cpu_caps.counters_x_proc; i++) {
                        if (cctx->counters[i].event == 0) {
-                               if (!perfmon_event_available(i))
-                                       warn_once("Counter %d is free but not available", i);
-                               else
-                                       break;
+                               /* kernel bug if the MSRs don't agree with our bookkeeping */
+                               assert(perfmon_event_available(i));
+                               break;
                        }
                }
                if (i < (int) cpu_caps.counters_x_proc) {
@@ -194,8 +263,7 @@ static void perfmon_do_cores_alloc(void *opaque)
                        else
                                write_msr(MSR_IA32_PERFCTR0 + i, 0);
                        write_msr(MSR_CORE_PERF_GLOBAL_OVF_CTRL, 1ULL << i);
-                       perfmon_enable_event(i);
-                       write_msr(MSR_ARCH_PERFMON_EVENTSEL0 + i, pev->event);
+                       perfmon_enable_event(i, pev->event);
                } else {
                        i = -ENOSPC;
                }
@@ -214,28 +282,20 @@ static void perfmon_do_cores_free(void *opaque)
 
        spin_lock_irqsave(&cctx->lock);
        if (perfmon_is_fixed_event(&pa->ev)) {
-               unsigned int ccbitsh = ccno * FIXCNTR_NBITS;
                uint64_t fxctrl_value = read_msr(MSR_CORE_PERF_FIXED_CTR_CTRL);
 
                if ((ccno >= cpu_caps.fix_counters_x_proc) ||
-                       !(fxctrl_value & (FIXCNTR_MASK << ccbitsh))) {
+                   perfmon_fix_event_available(ccno, fxctrl_value)) {
                        err = -ENOENT;
                } else {
                        perfmon_init_event(&cctx->fixed_counters[ccno]);
-
-                       perfmon_disable_fix_event((int) ccno);
-
-                       write_msr(MSR_CORE_PERF_FIXED_CTR_CTRL,
-                                 fxctrl_value & ~(FIXCNTR_MASK << ccbitsh));
+                       perfmon_disable_fix_event((int) ccno, fxctrl_value);
                        write_msr(MSR_CORE_PERF_FIXED_CTR0 + ccno, 0);
                }
        } else {
                if (ccno < (int) cpu_caps.counters_x_proc) {
                        perfmon_init_event(&cctx->counters[ccno]);
-
                        perfmon_disable_event((int) ccno);
-
-                       write_msr(MSR_ARCH_PERFMON_EVENTSEL0 + ccno, 0);
                        write_msr(MSR_IA32_PERFCTR0 + ccno, 0);
                } else {
                        err = -ENOENT;
@@ -246,6 +306,30 @@ static void perfmon_do_cores_free(void *opaque)
        pa->cores_counters[coreno] = (counter_t) err;
 }
 
+/* Helper: Reads a fixed counter's value.  Returns the max amount possible if
+ * the counter overflowed. */
+static uint64_t perfmon_read_fixed_counter(int ccno)
+{
+       uint64_t overflow_status = read_msr(MSR_CORE_PERF_GLOBAL_STATUS);
+
+       if (overflow_status & (1ULL << (32 + ccno)))
+               return (1ULL << cpu_caps.bits_x_fix_counter) - 1;
+       else
+               return read_msr(MSR_CORE_PERF_FIXED_CTR0 + ccno);
+}
+
+/* Helper: Reads an unfixed counter's value.  Returns the max amount possible if
+ * the counter overflowed. */
+static uint64_t perfmon_read_unfixed_counter(int ccno)
+{
+       uint64_t overflow_status = read_msr(MSR_CORE_PERF_GLOBAL_STATUS);
+
+       if (overflow_status & (1ULL << ccno))
+               return (1ULL << cpu_caps.bits_x_counter) - 1;
+       else
+               return read_msr(MSR_IA32_PERFCTR0 + ccno);
+}
+
 static void perfmon_do_cores_status(void *opaque)
 {
        struct perfmon_status_env *env = (struct perfmon_status_env *) opaque;
@@ -255,11 +339,9 @@ static void perfmon_do_cores_status(void *opaque)
 
        spin_lock_irqsave(&cctx->lock);
        if (perfmon_is_fixed_event(&env->pa->ev))
-               env->pef->cores_values[coreno] =
-                   read_msr(MSR_CORE_PERF_FIXED_CTR0 + ccno);
+               env->pef->cores_values[coreno] = perfmon_read_fixed_counter(ccno);
        else
-               env->pef->cores_values[coreno] =
-                   read_msr(MSR_IA32_PERFCTR0 + ccno);
+               env->pef->cores_values[coreno] = perfmon_read_unfixed_counter(ccno);
        spin_unlock_irqsave(&cctx->lock);
 }
 
@@ -290,17 +372,8 @@ static void perfmon_free_alloc(struct perfmon_alloc *pa)
 
 static void perfmon_destroy_alloc(struct perfmon_alloc *pa)
 {
-       if (pa) {
-               perfmon_cleanup_cores_alloc(pa);
-               perfmon_free_alloc(pa);
-       }
-}
-
-static void perfmon_release_alloc(struct kref *kref)
-{
-       struct perfmon_alloc *pa = container_of(kref, struct perfmon_alloc, ref);
-
-       perfmon_destroy_alloc(pa);
+       perfmon_cleanup_cores_alloc(pa);
+       perfmon_free_alloc(pa);
 }
 
 static struct perfmon_alloc *perfmon_create_alloc(const struct perfmon_event *pev)
@@ -310,7 +383,6 @@ static struct perfmon_alloc *perfmon_create_alloc(const struct perfmon_event *pe
                                                num_cores * sizeof(counter_t),
                                            MEM_WAIT);
 
-       kref_init(&pa->ref, perfmon_release_alloc, 1);
        pa->ev = *pev;
        for (i = 0; i < num_cores; i++)
                pa->cores_counters[i] = INVALID_COUNTER;
@@ -318,7 +390,7 @@ static struct perfmon_alloc *perfmon_create_alloc(const struct perfmon_event *pe
        return pa;
 }
 
-static struct perfmon_status *perfmon_alloc_status(void)
+static struct perfmon_status *perfmon_status_alloc(void)
 {
        struct perfmon_status *pef = kzmalloc(sizeof(struct perfmon_status) +
                                                  num_cores * sizeof(uint64_t),
@@ -367,13 +439,7 @@ void perfmon_pcpu_init(void)
 
 static uint64_t perfmon_make_sample_event(const struct perfmon_event *pev)
 {
-       uint64_t ei = ((uint64_t) PMEV_GET_MASK(pev->event) << 8) |
-               PMEV_GET_EVENT(pev->event);
-
-       if (perfmon_is_fixed_event(pev))
-               ei |= 1 << 16;
-
-       return PROF_MKINFO(PROF_DOM_PMU, ei);
+       return pev->user_data;
 }
 
 void perfmon_interrupt(struct hw_trapframe *hw_tf, void *data)
@@ -428,20 +494,16 @@ void perfmon_get_cpu_caps(struct perfmon_cpu_caps *pcc)
 static int perfmon_install_session_alloc(struct perfmon_session *ps,
                                          struct perfmon_alloc *pa)
 {
-       int i;
-
-       spin_lock(&ps->lock);
-       for (i = 0; (i < ARRAY_SIZE(ps->allocs)) && (ps->allocs[i] != NULL); i++)
-               ;
-       if (likely(i < ARRAY_SIZE(ps->allocs)))
-               ps->allocs[i] = pa;
-       else
-               i = -ENFILE;
-       spin_unlock(&ps->lock);
-       if (unlikely(i < 0))
-               error(-i, ERROR_FIXME);
-
-       return i;
+       qlock(&ps->qlock);
+       for (int i = 0; i < ARRAY_SIZE(ps->allocs); i++) {
+               if (!ps->allocs[i]) {
+                       ps->allocs[i] = pa;
+                       qunlock(&ps->qlock);
+                       return i;
+               }
+       }
+       qunlock(&ps->qlock);
+       error(ENFILE, "Too many perf allocs in the session");
 }
 
 int perfmon_open_event(const struct core_set *cset, struct perfmon_session *ps,
@@ -467,7 +529,8 @@ int perfmon_open_event(const struct core_set *cset, struct perfmon_session *ps,
 
                        if (unlikely(ccno < 0)) {
                                perfmon_destroy_alloc(pa);
-                               return (int) ccno;
+                               perfmon_convert_error(-(int)ccno, i);
+                               return -1;
                        }
                }
        }
@@ -483,48 +546,61 @@ int perfmon_open_event(const struct core_set *cset, struct perfmon_session *ps,
        return i;
 }
 
-static void perfmon_alloc_get(struct perfmon_session *ps, int ped, bool reset,
-                              struct perfmon_alloc **ppa)
+/* Helper, looks up a pa, given ped.  Hold the qlock. */
+static struct perfmon_alloc *__lookup_pa(struct perfmon_session *ps, int ped)
 {
        struct perfmon_alloc *pa;
 
        if (unlikely((ped < 0) || (ped >= ARRAY_SIZE(ps->allocs))))
-               error(EBADFD, ERROR_FIXME);
-       spin_lock(&ps->lock);
+               error(EBADFD, "Perf event %d out of range", ped);
        pa = ps->allocs[ped];
-       if (likely(pa)) {
-               if (reset)
-                       ps->allocs[ped] = NULL;
-               else
-                       kref_get(&pa->ref, 1);
-       }
-       spin_unlock(&ps->lock);
-       if (unlikely(!pa))
-               error(ENOENT, ERROR_FIXME);
-       *ppa = pa;
+       if (!pa)
+               error(ENOENT, "No perf alloc for event %d", ped);
+       return pa;
 }
 
 void perfmon_close_event(struct perfmon_session *ps, int ped)
 {
+       ERRSTACK(1);
        struct perfmon_alloc *pa;
 
-       perfmon_alloc_get(ps, ped, TRUE, &pa);
-       kref_put(&pa->ref);
+       qlock(&ps->qlock);
+       if (waserror()) {
+               qunlock(&ps->qlock);
+               nexterror();
+       };
+       /* lookup does the error checking */
+       pa = __lookup_pa(ps, ped);
+       ps->allocs[ped] = NULL;
+       poperror();
+       qunlock(&ps->qlock);
+       perfmon_destroy_alloc(pa);
 }
 
+/* Fetches the status (i.e. PMU counters) of event ped from all applicable
+ * cores.  Returns a perfmon_status, which the caller should free. */
 struct perfmon_status *perfmon_get_event_status(struct perfmon_session *ps,
                                                 int ped)
 {
+       ERRSTACK(1);
        struct core_set cset;
        struct perfmon_status_env env;
 
-       perfmon_alloc_get(ps, ped, FALSE, &env.pa);
-       env.pef = perfmon_alloc_status();
-       perfmon_setup_alloc_core_set(env.pa, &cset);
+       /* qlock keeps the PA alive.  We don't want to spin, since the spinners
+        * might prevent the smp_do_in_cores(), resulting in a deadlock. */
+       qlock(&ps->qlock);
+       if (waserror()) {
+               qunlock(&ps->qlock);
+               nexterror();
+       };
+       env.pa = __lookup_pa(ps, ped);
+       env.pef = perfmon_status_alloc();
 
+       perfmon_setup_alloc_core_set(env.pa, &cset);
        smp_do_in_cores(&cset, perfmon_do_cores_status, &env);
 
-       kref_put(&env.pa->ref);
+       poperror();
+       qunlock(&ps->qlock);
 
        return env.pef;
 }
@@ -534,38 +610,23 @@ void perfmon_free_event_status(struct perfmon_status *pef)
        kfree(pef);
 }
 
-static void perfmon_release_session(struct kref *kref)
-{
-       struct perfmon_session *ps =
-           container_of(kref, struct perfmon_session, ref);
-
-       for (int i = 0; i < ARRAY_SIZE(ps->allocs); i++) {
-               struct perfmon_alloc *pa = ps->allocs[i];
-
-               if (pa)
-                       kref_put(&pa->ref);
-       }
-       kfree(ps);
-}
-
 struct perfmon_session *perfmon_create_session(void)
 {
        struct perfmon_session *ps = kzmalloc(sizeof(struct perfmon_session),
                                              MEM_WAIT);
 
-       kref_init(&ps->ref, perfmon_release_session, 1);
-       spinlock_init(&ps->lock);
-
+       qlock_init(&ps->qlock);
        return ps;
 }
 
-void perfmon_get_session(struct perfmon_session *ps)
-{
-       kref_get(&ps->ref, 1);
-}
-
 void perfmon_close_session(struct perfmon_session *ps)
 {
-       if (likely(ps))
-               kref_put(&ps->ref);
+       struct perfmon_alloc *pa;
+
+       for (int i = 0; i < ARRAY_SIZE(ps->allocs); i++) {
+               pa = ps->allocs[i];
+               if (pa)
+                       perfmon_destroy_alloc(pa);
+       }
+       kfree(ps);
 }