virperf.c 8.8 KB
Newer Older
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
/*
 * virperf.c: methods for managing perf events
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library.  If not, see
 * <http://www.gnu.org/licenses/>.
 *
 * Authors:
 *  Ren Qiaowei <qiaowei.ren@intel.com>
 */
#include <config.h>

#include <sys/ioctl.h>
#if defined HAVE_SYS_SYSCALL_H
# include <sys/syscall.h>
#endif

#include "virperf.h"
#include "viralloc.h"
#include "virerror.h"
#include "virlog.h"
#include "virfile.h"
#include "virstring.h"
#include "virtypedparam.h"

VIR_LOG_INIT("util.perf");

#define VIR_FROM_THIS VIR_FROM_PERF

VIR_ENUM_IMPL(virPerfEvent, VIR_PERF_EVENT_LAST,
Q
Qiaowei Ren 已提交
41 42 43
              "cmt", "mbmt", "mbml",
              "cpu_cycles", "instructions",
              "cache_references", "cache_misses");
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65

struct virPerfEvent {
    int type;
    int fd;
    bool enabled;
    union {
        /* cmt */
        struct {
            int scale;
        } cmt;
    } efields;
};
typedef struct virPerfEvent *virPerfEventPtr;

struct virPerf {
    struct virPerfEvent events[VIR_PERF_EVENT_LAST];
};

#if defined(__linux__) && defined(HAVE_SYS_SYSCALL_H)

# include <linux/perf_event.h>

66 67 68 69 70 71 72 73 74 75
struct virPerfEventAttr {
    int type;
    unsigned int attrType;
    unsigned long long attrConfig;
};

static struct virPerfEventAttr attrs[] = {
    {.type = VIR_PERF_EVENT_CMT, .attrType = 0, .attrConfig = 1},
    {.type = VIR_PERF_EVENT_MBMT, .attrType = 0, .attrConfig = 2},
    {.type = VIR_PERF_EVENT_MBML, .attrType = 0, .attrConfig = 3},
Q
Qiaowei Ren 已提交
76 77 78 79 80 81 82 83 84 85 86 87
    {.type = VIR_PERF_EVENT_CPU_CYCLES,
     .attrType = PERF_TYPE_HARDWARE,
     .attrConfig = PERF_COUNT_HW_CPU_CYCLES},
    {.type = VIR_PERF_EVENT_INSTRUCTIONS,
     .attrType = PERF_TYPE_HARDWARE,
     .attrConfig = PERF_COUNT_HW_INSTRUCTIONS},
    {.type = VIR_PERF_EVENT_CACHE_REFERENCES,
     .attrType = PERF_TYPE_HARDWARE,
     .attrConfig = PERF_COUNT_HW_CACHE_REFERENCES},
    {.type = VIR_PERF_EVENT_CACHE_MISSES,
     .attrType = PERF_TYPE_HARDWARE,
     .attrConfig = PERF_COUNT_HW_CACHE_MISSES},
88 89 90
};
typedef struct virPerfEventAttr *virPerfEventAttrPtr;

91

92 93 94 95
static virPerfEventAttrPtr
virPerfGetEventAttr(virPerfEventType type)
{
    size_t i;
96 97 98 99 100 101 102
    if (type >= VIR_PERF_EVENT_LAST) {
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("Event '%d' is not supported"),
                       type);
        return NULL;
    }

103 104 105 106 107 108
    for (i = 0; i < VIR_PERF_EVENT_LAST; i++) {
        if (i == type)
            return attrs + i;
    }

    return NULL;
109 110
}

111

112
static int
113
virPerfRdtAttrInit(void)
114 115 116
{
    char *buf = NULL;
    char *tmp = NULL;
117
    unsigned int attr_type = 0;
118

119
    if (virFileReadAll("/sys/devices/intel_cqm/type", 10, &buf) < 0)
120
        goto error;
121 122 123 124

    if ((tmp = strchr(buf, '\n')))
        *tmp = '\0';

125
    if (virStrToLong_ui(buf, NULL, 10, &attr_type) < 0) {
126
        virReportSystemError(errno, "%s",
127
                             _("failed to get rdt event type"));
128
        goto error;
129 130 131
    }
    VIR_FREE(buf);

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
    attrs[VIR_PERF_EVENT_CMT].attrType = attr_type;
    attrs[VIR_PERF_EVENT_MBMT].attrType = attr_type;
    attrs[VIR_PERF_EVENT_MBML].attrType = attr_type;

    return 0;

 error:
    VIR_FREE(buf);
    return -1;
}


static virPerfEventPtr
virPerfGetEvent(virPerfPtr perf,
                virPerfEventType type)
{
    if (!perf)
        return NULL;

    if (type >= VIR_PERF_EVENT_LAST) {
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("Event '%d' is not supported"),
                       type);
        return NULL;
    }

    return perf->events + type;
}

int
virPerfEventEnable(virPerfPtr perf,
                   virPerfEventType type,
                   pid_t pid)
{
    char *buf = NULL;
    struct perf_event_attr attr;
    virPerfEventPtr event = virPerfGetEvent(perf, type);
    virPerfEventAttrPtr event_attr = virPerfGetEventAttr(type);

    if (!event || !event_attr)
        return -1;
173

174 175 176 177 178 179 180 181 182 183
    if (event_attr->attrType == 0 && (type == VIR_PERF_EVENT_CMT ||
                                       type == VIR_PERF_EVENT_MBMT ||
                                       type == VIR_PERF_EVENT_MBML)) {
        virReportSystemError(errno,
                             _("Unable to open perf event for %s"),
                             virPerfEventTypeToString(event->type));
        return -1;
    }

    if (type == VIR_PERF_EVENT_CMT) {
184 185 186 187
        if (virFileReadAll("/sys/devices/intel_cqm/events/llc_occupancy.scale",
                           10, &buf) < 0)
            goto error;

188
        if (virStrToLong_i(buf, NULL, 10, &event->efields.cmt.scale) < 0) {
189 190 191 192
            virReportSystemError(errno, "%s",
                                 _("failed to get cmt scaling factor"));
            goto error;
        }
193 194

        VIR_FREE(buf);
195 196
    }

197 198 199 200 201 202 203 204 205
    memset(&attr, 0, sizeof(attr));
    attr.size = sizeof(attr);
    attr.inherit = 1;
    attr.disabled = 1;
    attr.enable_on_exec = 0;
    attr.type = event_attr->attrType;
    attr.config = event_attr->attrConfig;

    event->fd = syscall(__NR_perf_event_open, &attr, pid, -1, -1, 0);
206 207
    if (event->fd < 0) {
        virReportSystemError(errno,
208 209
                             _("Unable to open perf event for %s"),
                             virPerfEventTypeToString(event->type));
210
        goto error;
211 212 213
    }

    if (ioctl(event->fd, PERF_EVENT_IOC_ENABLE) < 0) {
214 215 216
        virReportSystemError(errno,
                             _("Unable to enable perf event for %s"),
                             virPerfEventTypeToString(event->type));
217
        goto error;
218 219 220 221 222
    }

    event->enabled = true;
    return 0;

223
 error:
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
    VIR_FORCE_CLOSE(event->fd);
    VIR_FREE(buf);
    return -1;
}

int
virPerfEventDisable(virPerfPtr perf,
                    virPerfEventType type)
{
    virPerfEventPtr event = virPerfGetEvent(perf, type);
    if (event == NULL)
        return -1;

    if (ioctl(event->fd, PERF_EVENT_IOC_DISABLE) < 0) {
        virReportSystemError(errno,
                             _("Unable to disable perf event type=%d"),
                             event->type);
        return -1;
    }

    event->enabled = false;
    VIR_FORCE_CLOSE(event->fd);
    return 0;
}

bool virPerfEventIsEnabled(virPerfPtr perf,
                           virPerfEventType type)
{
    virPerfEventPtr event = virPerfGetEvent(perf, type);
    if (event == NULL)
        return false;

    return event->enabled;
}

int
virPerfReadEvent(virPerfPtr perf,
                 virPerfEventType type,
                 uint64_t *value)
{
    virPerfEventPtr event = virPerfGetEvent(perf, type);
    if (event == NULL || !event->enabled)
        return -1;

268
    if (saferead(event->fd, value, sizeof(uint64_t)) < 0) {
269 270 271 272 273 274 275 276 277 278 279 280
        virReportSystemError(errno, "%s",
                             _("Unable to read cache data"));
        return -1;
    }

    if (type == VIR_PERF_EVENT_CMT)
        *value *= event->efields.cmt.scale;

    return 0;
}

#else
281 282 283 284 285 286 287
static int
virPerfRdtAttrInit(void)
{
    return 0;
}


288 289
int
virPerfEventEnable(virPerfPtr perf ATTRIBUTE_UNUSED,
R
Roman Bogorodskiy 已提交
290
                   virPerfEventType type ATTRIBUTE_UNUSED,
291 292 293 294 295 296 297 298 299
                   pid_t pid ATTRIBUTE_UNUSED)
{
    virReportSystemError(ENXIO, "%s",
                         _("Perf not supported on this platform"));
    return -1;
}

int
virPerfEventDisable(virPerfPtr perf ATTRIBUTE_UNUSED,
R
Roman Bogorodskiy 已提交
300
                    virPerfEventType type ATTRIBUTE_UNUSED)
301 302 303 304 305 306 307
{
    virReportSystemError(ENXIO, "%s",
                         _("Perf not supported on this platform"));
    return -1;
}

bool
R
Roman Bogorodskiy 已提交
308 309
virPerfEventIsEnabled(virPerfPtr perf ATTRIBUTE_UNUSED,
                      virPerfEventType type ATTRIBUTE_UNUSED)
310 311 312 313 314
{
    return false;
}

int
R
Roman Bogorodskiy 已提交
315 316 317
virPerfReadEvent(virPerfPtr perf ATTRIBUTE_UNUSED,
                 virPerfEventType type ATTRIBUTE_UNUSED,
                 uint64_t *value ATTRIBUTE_UNUSED)
318 319 320 321 322 323 324
{
    virReportSystemError(ENXIO, "%s",
                         _("Perf not supported on this platform"));
    return -1;
}

#endif
325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340

virPerfPtr
virPerfNew(void)
{
    size_t i;
    virPerfPtr perf;

    if (VIR_ALLOC(perf) < 0)
        return NULL;

    for (i = 0; i < VIR_PERF_EVENT_LAST; i++) {
        perf->events[i].type = i;
        perf->events[i].fd = -1;
        perf->events[i].enabled = false;
    }

341 342 343
    if (virPerfRdtAttrInit() < 0)
        virResetLastError();

344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361
    return perf;
}

void
virPerfFree(virPerfPtr perf)
{
    size_t i;

    if (perf == NULL)
        return;

    for (i = 0; i < VIR_PERF_EVENT_LAST; i++) {
        if (perf->events[i].enabled)
            virPerfEventDisable(perf, i);
    }

    VIR_FREE(perf);
}