PapiRunner.kt 8.48 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
7
8
import java.time.Duration
import java.time.Instant
Noric Couderc's avatar
Noric Couderc committed
9

10
open class PapiRunner(numRuns : Int, counters: CounterSpecification) {
11

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

    val counterSpec = counters
17
    val numRuns = numRuns
18

Noric Couderc's avatar
Noric Couderc committed
19
20
21
22
23
24
25
    /**
     * 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
26
        var data: MutableMap<String, List<Long>> = mutableMapOf()
Noric Couderc's avatar
Noric Couderc committed
27

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

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

Noric Couderc's avatar
Noric Couderc committed
33
            for (warmup in 0..100) {
Noric Couderc's avatar
Noric Couderc committed
34
35
36
37
38
39
40
41
                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
42
                    if (acc % 2 == 1) {
Noric Couderc's avatar
Noric Couderc committed
43
44
45
46
47
48
49
50
51
52
53
54
55
                        b[i] = acc
                    }
                }
                evset.stop()
                // Get data
                val currentData = evset.counters
                current.addAll(currentData.toList())
            }
            data.set(kvp.key, current)
        }
        return data
    }

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

Noric Couderc's avatar
Noric Couderc committed
70
71
72
73
74
75
76
77
78
79
80
        // 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())
81
        }
Noric Couderc's avatar
Noric Couderc committed
82
        return values
83
84
    }

85
86
87
88
89
90
91
92
    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
     */
93
    fun createRunSpecs(syntheticBenchmarks: List<SyntheticBenchmark<*>>): List<RunSpec> {
94
95
96
97
98
99
100
101
        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) {
102
                specification.add(RunSpec(numRuns, c.key, eventSet, b))
103
104
105
106
107
108
109
110
111
            }
        }
        return specification.toList()
    }

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

        val samples = mutableListOf<Long>()
112
        for (i in 0 until spec.numRuns) {
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
            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
136
        writer.close()
137
138
        return samples
    }
139

Noric Couderc's avatar
Noric Couderc committed
140
141
142
    /**
     * A function for running one benchmark, gathering all the hardware counters
     * Present in the counter specification we have.
143
     */
144
    fun runApplication(app: SyntheticBenchmark<*>) : Map<String, List<Long>> {
Noric Couderc's avatar
Noric Couderc committed
145
146
147
148
149
150
151
        // 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) {
152
153
            val counterId = counterSpec.getCounter(counter)
            val evset = EventSet.create(counterId!!)
Noric Couderc's avatar
Noric Couderc committed
154
155
156
157
158
159
160
161
162
163
            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()
164
                }
Noric Couderc's avatar
Noric Couderc committed
165
166
                val resultDataStructure = app.getDataStructure()
                evset.stop()
167

Noric Couderc's avatar
Noric Couderc committed
168
169
                // We reset the benchmark
                app.reset(0)
170

Noric Couderc's avatar
Noric Couderc committed
171
172
173
174
175
                // 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())
176
            }
Noric Couderc's avatar
Noric Couderc committed
177
178
            result[counter] = ArrayList(samples)
            samples.clear()
Noric Couderc's avatar
Noric Couderc committed
179
        }
180
		app.clearDataStructure()
181
182
183

        writer.close()

Noric Couderc's avatar
Noric Couderc committed
184
        return result.toMap()
Noric Couderc's avatar
Noric Couderc committed
185
186
    }

Noric Couderc's avatar
Noric Couderc committed
187
188
189
190
191
192
193
    /**
     * 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
     */
194
195
    fun runFunctionMedian(counter: String, function: () -> Unit): Double {
        val data = runFunction(counter, function)
Noric Couderc's avatar
Noric Couderc committed
196
        return medianLong(data)
Noric Couderc's avatar
Noric Couderc committed
197
198
    }

199
200
201


    fun runApplications(syntheticBenchmarks: List<SyntheticBenchmark<*>>): List<Triple<SyntheticBenchmark<*>, String, List<Long>>> {
202
        // return syntheticBenchmarks.map { b -> runApplication(iterations, b) }
203
        val specs = createRunSpecs(syntheticBenchmarks)
204
        val spectToCounters = specs.map {
205
206
207
            val samples = runSpec(it)
            Pair(it, samples)
        }
208
209
210
211
        return spectToCounters.map {
            Triple(it.first.syntheticBenchmark,
                    it.first.counter,
                    it.second)
212
        }
213

214
215
    }

216
217
218
219
    fun runApplicationsMedian(syntheticBenchmarks: List<SyntheticBenchmark<*>>) : List<Triple<SyntheticBenchmark<*>, String, Double>> {
        val samples = runApplications(syntheticBenchmarks)
        return samples.map {
            Triple(it.first, it.second, medianLong(it.third))
220
221
222
        }
    }

223
224
225
226
227
228
229
    fun runApplicationsNormalized(syntheticBenchmarks: List<SyntheticBenchmark<*>>) : List<Triple<SyntheticBenchmark<*>, String, Double>> {
        val countersMedians = runApplicationsMedian(syntheticBenchmarks)
        val instructionsForBenchmark = countersMedians.filter { it.second == "PAPI_TOT_INS" }
                .map { Pair(it.first, it.third) }
                .toMap()
        return countersMedians.map {
            Triple(it.first, it.second, it.third / instructionsForBenchmark[it.first]!!)
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
        }
    }

    /**
     * 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
        }
253
    }
Noric Couderc's avatar
Noric Couderc committed
254
}