PapiRunner.kt 8.33 KB
Newer Older
Noric Couderc's avatar
Noric Couderc committed
1
2
3
4
package se.lth.cs

import papi.EventSet
import papi.Papi
5
import papi.PapiException
6
import java.io.FileWriter
Noric Couderc's avatar
Noric Couderc committed
7

8
9
10
11
12
open class PapiRunner(numRuns : Int, counters: CounterSpecification, normalizeFeatures : Boolean) {
    constructor(numRuns: Int, specification: CounterSpecification) : this(numRuns, specification, false) {

    }

13
14
15
    init {
        Papi.init()
    }
16
17

    val counterSpec = counters
18
    val numRuns = numRuns
19
    val normalizeFeatures = normalizeFeatures
20

Noric Couderc's avatar
Noric Couderc committed
21
22
23
24
25
26
27
    /**
     * Empty benchmark:
     * Test to see if the results are stable.
     */
    fun emptyBenchmark(): MutableMap<String, List<Long>> {
        // For each counter,
        // we store the values for each run (10 runs)
Noric Couderc's avatar
Noric Couderc committed
28
        var data: MutableMap<String, List<Long>> = mutableMapOf()
Noric Couderc's avatar
Noric Couderc committed
29

30
        for (kvp in counterSpec.currentSpec) {
Noric Couderc's avatar
Noric Couderc committed
31
32
            val evset = EventSet.create(kvp.value)

Noric Couderc's avatar
Noric Couderc committed
33
            val current: MutableList<Long> = mutableListOf()
Noric Couderc's avatar
Noric Couderc committed
34

Noric Couderc's avatar
Noric Couderc committed
35
            for (warmup in 0..100) {
Noric Couderc's avatar
Noric Couderc committed
36
37
38
39
40
41
42
43
                val a = (0..warmup).toList().toTypedArray()
                val b = IntArray(warmup)

                evset.start()
                // Synthetic piece of code to see if counters run as expected
                var acc = 0
                for (i in 0 until warmup) {
                    acc += a[i]
Noric Couderc's avatar
Noric Couderc committed
44
                    if (acc % 2 == 1) {
Noric Couderc's avatar
Noric Couderc committed
45
46
47
48
49
50
51
52
53
54
55
56
57
                        b[i] = acc
                    }
                }
                evset.stop()
                // Get data
                val currentData = evset.counters
                current.addAll(currentData.toList())
            }
            data.set(kvp.key, current)
        }
        return data
    }

58
59
60
61
    /**
     * Runs a function several times
     * @return A map from PAPI counter names to list of values
     */
62
    inline fun runFunction(counter: String, function: () -> Unit): MutableList<Long> {
63
        val counterId = counterSpec.getCounter(counter)!!
Noric Couderc's avatar
Noric Couderc committed
64
65
66
67
        // We record only one counter
        var evset = EventSet.create()
        try {
            evset = EventSet.create(counterId)
Noric Couderc's avatar
Noric Couderc committed
68
        } catch (e: PapiException) {
Noric Couderc's avatar
Noric Couderc committed
69
70
            error("Failed to sample counter: ${counter}")
        }
71

Noric Couderc's avatar
Noric Couderc committed
72
73
74
75
76
77
78
79
80
81
82
        // We run the function n times
        var values = mutableListOf<Long>()
        for (run in 0..numRuns) {
            // We do the measurements
            evset.start()
            val result = function()
            evset.stop()

            // We record the data
            val data = evset.counters
            values.addAll(data.toList())
83
        }
Noric Couderc's avatar
Noric Couderc committed
84
        return values
85
86
    }

87
88
89
90
91
92
93
94
    data class RunSpec(val numRuns: Int,
                       val counter : String,
                       val eventSet: EventSet,
                       val syntheticBenchmark: SyntheticBenchmark<*>)

    /**
     * Creates a list of specifications of what counter to get from what benchmarks
     */
95
    fun createRunSpecs(syntheticBenchmarks: List<SyntheticBenchmark<*>>): List<RunSpec> {
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
        val counters = counterSpec.currentSpec

        // Let's say we want to minimize the counter change
        // We put it in the outer loop
        val specification = mutableListOf<RunSpec>()
        for (c in counters) {
            val eventSet = EventSet.create(c.value)
            for (b in syntheticBenchmarks) {
                for (i in 0 until numRuns) {
                    specification.add(RunSpec(i, c.key, eventSet, b))
                }
            }
        }
        return specification.toList()
    }

    fun runSpec(spec : RunSpec): List<Long> {
        val writer = FileWriter("/dev/null")

        val samples = mutableListOf<Long>()
116
        for (i in 0 until numRuns) {
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
            val app = spec.syntheticBenchmark
            val evset = spec.eventSet
            // We do the measurements
            app.reset(app.baseDataStructureSize)
            var accumulator = 0
            evset.start()
            while (app.hasNext()) {
                val result: Int? = app.invokeCurrentMethod() as? Int
                accumulator += result ?: 1
                app.tick()
            }
            val resultDataStructure = app.getDataStructure()
            evset.stop()

            // We reset the benchmark
            app.reset(0)

            // Write the result somewhere to prevent dead code elimination
            writer.write(accumulator)
            writer.write(resultDataStructure.toString())
            // We record the data
            samples.addAll(evset.counters.toList())
        }
Noric Couderc's avatar
Noric Couderc committed
140
        writer.close()
141
142
        return samples
    }
143

Noric Couderc's avatar
Noric Couderc committed
144
145
146
    /**
     * A function for running one benchmark, gathering all the hardware counters
     * Present in the counter specification we have.
147
     */
148
    fun runApplication(app: SyntheticBenchmark<*>) : Map<String, List<Long>> {
Noric Couderc's avatar
Noric Couderc committed
149
150
151
152
153
154
155
        // We will write the aggregators to nowhere
        val writer = FileWriter("/dev/null")
        // We get integers for all the counters.
        val counters = counterSpec.currentSpec

        var result = mutableMapOf<String, List<Long>>()
        for (counter in counters.keys) {
156
157
            val counterId = counterSpec.getCounter(counter)
            val evset = EventSet.create(counterId!!)
Noric Couderc's avatar
Noric Couderc committed
158
159
160
161
162
163
164
165
166
167
            val samples = mutableListOf<Long>()
            for (run in 0 until numRuns) {
                // We do the measurements
                app.reset(app.baseDataStructureSize)
                var accumulator = 0
                evset.start()
                while (app.hasNext()) {
                    val result: Int? = app.invokeCurrentMethod() as? Int
                    accumulator += result ?: 1
                    app.tick()
168
                }
Noric Couderc's avatar
Noric Couderc committed
169
170
                val resultDataStructure = app.getDataStructure()
                evset.stop()
171

Noric Couderc's avatar
Noric Couderc committed
172
173
                // We reset the benchmark
                app.reset(0)
174

Noric Couderc's avatar
Noric Couderc committed
175
176
177
178
179
                // Write the result somewhere to prevent dead code elimination
                writer.write(accumulator)
                writer.write(resultDataStructure.toString())
                // We record the data
                samples.addAll(evset.counters.toList())
180
            }
Noric Couderc's avatar
Noric Couderc committed
181
182
            result[counter] = ArrayList(samples)
            samples.clear()
Noric Couderc's avatar
Noric Couderc committed
183
        }
184
		app.clearDataStructure()
185
186
187

        writer.close()

Noric Couderc's avatar
Noric Couderc committed
188
        return result.toMap()
Noric Couderc's avatar
Noric Couderc committed
189
190
    }

Noric Couderc's avatar
Noric Couderc committed
191
192
193
194
195
196
197
    /**
     * Runs a function several times, gather the performance counters
     * and returns their median
     * @param numRuns Number of times the function should be ran
     * @param function The function to benchmark
     * @return A map from PAPI counter names to the median of their values over numRuns
     */
198
199
    fun runFunctionMedian(counter: String, function: () -> Unit): Double {
        val data = runFunction(counter, function)
Noric Couderc's avatar
Noric Couderc committed
200
        return medianLong(data)
Noric Couderc's avatar
Noric Couderc committed
201
202
    }

203
    fun runApplications(syntheticBenchmarks: List<SyntheticBenchmark<*>>): List<Map<String, Double>> {
204
        // return syntheticBenchmarks.map { b -> runApplication(iterations, b) }
205
        val specs = createRunSpecs(syntheticBenchmarks)
206
207
208
209
210
211
        val map = specs.map {
            val samples = runSpec(it)
            Pair(it, samples)
        }
        // TODO: Return a Map<Pair<CounterString, Benchmark>, List<Long>> instead of this mess.
        val map1 = map.groupBy { s -> s.first.syntheticBenchmark }
212
        val mapsOfSamples = map1.mapValues {
213
214
215
216
217
218
            it.value.map {
                Pair(it.first.counter, it.second)
            }.toMap()
        }.map {
            it.value
        }
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
        // If we are in normalized mode, the scores are normalized by the total number of
        // instructions
        return when (normalizeFeatures) {
            true -> mapsOfSamples.map {
                normalizeFeatures(medianFeatures(it))
            }
           false -> mapsOfSamples.map { medianFeatures(it) }
        }
    }

    /**
     * Compute the median of samples for each counter
     * @param counters: A map from PAPI counter names to lists of samples
     */
    fun medianFeatures(counters : Map<String, List<Long>>) : Map<String, Double> {
        return counters.mapValues {
            medianLong(it.value)
        }
    }

    /**
     * Normalize a map of counters by the PAPI_TOT_INS (Total number of instructions)
     * @param counters: A map from PAPI counter names to their median value
     */
    fun normalizeFeatures(counters : Map<String, Double>) : Map<String, Double> {
        val total = counters["PAPI_TOT_INS"] ?: error("'PAPI_TOT_INS' not present in counters")

        return counters.mapValues {
            it.value / total
        }
249
    }
Noric Couderc's avatar
Noric Couderc committed
250
}