event_download.py

#!/usr/bin/env python
# Copyright (c) 2014, Intel Corporation
# Author: Andi Kleen
#
# This program is free software; you can redistribute it and/or modify it
# under the terms and conditions of the GNU General Public License,
# version 2, as published by the Free Software Foundation.
#
# This program is distributed in the hope 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.
#
# Automatic event list downloader
#
# event_download.py         download for current cpu
# event_download.py -a      download all
# event_download.py cpustr...  Download for specific CPU
import sys
import re
from urllib2 import urlopen, URLError
import os
import string
from fnmatch import fnmatch

urlpath = 'https://download.01.org/perfmon'
mapfile = 'mapfile.csv'
modelpath = urlpath + "/" + mapfile

def get_cpustr():
    f = open('/proc/cpuinfo', 'r')
    cpu = [None, None, None]
    for j in f:
        n = j.split()
        if n[0] == 'vendor_id':
            cpu[0] = n[2]
        elif n[0] == 'model' and n[1] == ':':
            cpu[2] = int(n[2])
        elif n[0] == 'cpu' and n[1] == 'family':
            cpu[1] = int(n[3])
        if all(cpu):
            break
    return "%s-%d-%X" % (cpu[0], cpu[1], cpu[2])

def sanitize(s, a):
    o = ""
    for j in s:
        if j in a:
            o += j
    return o

def getdir():
    try:
        d = os.getenv("XDG_CACHE_HOME")
	xd = d
        if not d:
            home = os.getenv("HOME")
            d = "%s/.cache" % (home)
        d += "/pmu-events"
        if not os.path.isdir(d):
            # try to handle the sudo case
	    if not xd:
                user = os.getenv("SUDO_USER")
                if user:
                    nd = os.path.expanduser("~" + user) + "/.cache/pmu-events"
		    if os.path.isdir(nd):
		        return nd
            os.makedirs(d)
        return d
    except OSError:
        raise Exception('Cannot access ' + d)

def getfile(url, dir, fn):
    print "Downloading", url, "to", fn
    f = urlopen(url)
    o = open(os.path.join(dir, fn), "w")
    o.write(f.read())
    o.close()
    f.close()

allowed_chars = string.ascii_letters + '_-.' + string.digits
def download(match, key=["core"], link=True):
    found = 0
    dir = getdir()
    try:
        getfile(modelpath, dir, "mapfile.csv")
        models = open(os.path.join(dir, "mapfile.csv"))
        for j in models:
            n = j.rstrip().split(",")
            if len(n) < 4:
                if len(n) > 0:
                    print "Cannot parse", n
                continue
            cpu, version, name, type = n
            if not fnmatch(cpu, match) or (key is not None and type not in key) or type.startswith("EventType"):
                continue
            cpu = sanitize(cpu, allowed_chars)
            url = urlpath + name
            fn = "%s-%s.json" % (cpu, type)
            try:
                os.remove(os.path.join(dir, fn))
            except OSError:
                pass
            getfile(url, dir, fn)
            if link:
                lname = re.sub(r'.*/', '', name)
                lname = sanitize(lname, allowed_chars)
                try:
                    os.remove(os.path.join(dir, lname))
                except OSError:
                    pass
                try:
                    os.symlink(fn, os.path.join(dir, lname))
                except OSError as e:
                    print >>sys.stderr, "Cannot link %s to %s:" % (name, lname), e
            found += 1
        models.close()
        getfile(urlpath + "/readme.txt", dir, "readme.txt")
    except URLError as e:
        print >>sys.stderr, "Cannot access event server:", e
        print >>sys.stderr, "If you need a proxy to access the internet please set it with:"
        print >>sys.stderr, "\texport https_proxy=http://proxyname..."
        print >>sys.stderr, "If you are not connected to the internet please run this on a connected system:"
        print >>sys.stderr, "\tevent_download.py '%s'" % (match)
        print >>sys.stderr, "and then copy ~/.cache/pmu-events to the system under test"
        print >>sys.stderr, "To get events for all possible CPUs use:"
        print >>sys.stderr, "\tevent_download.py -a"
    except OSError as e:
        print >>sys.stderr, "Cannot write events file:", e
    return found

def download_current(link=False):
    """Download JSON event list for current cpu.
       Returns >0 when a event list is found"""
    return download(get_cpustr(), link=link)

def eventlist_name(name=None, key="core"):
    if not name:
        name = get_cpustr()
    cache = getdir()
    return "%s/%s-%s.json" % (cache, name, key)

if __name__ == '__main__':
    # only import argparse when actually called from command line
    # this makes ocperf work on older python versions without it.
    import argparse
    p = argparse.ArgumentParser(usage='download Intel event files')
    p.add_argument('--all', '-a', help='Download all available event files', action='store_true')
    p.add_argument('--verbose', '-v', help='Be verbose', action='store_true')
    p.add_argument('--mine', help='Print name of current CPU', action='store_true')
    p.add_argument('--link', help='Create links with the original event file name', action='store_true')
    p.add_argument('cpus', help='CPU identifiers to download', nargs='*')
    args = p.parse_args()

    cpustr = get_cpustr()
    if args.verbose or args.mine:
        print "My CPU", cpustr
    if args.mine:
        sys.exit(0)
    d = getdir()
    if args.all:
        found = download('*', key=None, link=args.link)
    elif len(args.cpus) == 0:
        found = download_current(link=args.link)
    else:
        found = 0
        for j in args.cpus:
            found += download(j, link=args.link)

    if found == 0:
        print >>sys.stderr, "Nothing found"

    el = eventlist_name()
    if os.path.exists(el):
        print "my event list", el