doc/bmproto.html


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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
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
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503

<html>

<head>

<style type="text/css">
table {background-color:#f5f5f5; text-align:left}
th {vertical-align:top; padding:5px}
td {vertical-align:top; padding:5px}
.requestName {color:#a0291b; font-size:18}
.requestDescr {color:#117711; min-width:200px}
</style>

</head>

<body>

<h2>BM Protocol</h2>

<h3>Overview</h3>

The BM protocol is a simple protocol that assumes a reliable byte channel
(like TCP) between a client and a <a href="bmserver.html">BM
server</a>. Requests are sent from the client to the server. Each request is
followed by a reply sent from the server to the client.

<h3>General Message Structure</h3>

Each request or reply message consists of a header followed by a data
part. The header consists of a single four-byte quint32 value (in big endian,
i.e. most significant byte first) that holds the size of the data part (in bytes).
The data part is encoded in XML as specified in the table below.

<b>Note:</b> Any reply message may optionally contain an <i>error</i>
attribute in its &lt;reply&gt; tag. If non-empty, the value of this attribute
is an error message that describes the reason why the request could not be
successfully processed.

<br />
<br />

<table border=1>
<tr>
    <th>Name</th>
    <th>Description</th>
    <th>Request message</th>
    <th>Reply message</th>
</tr>

<!-- ---------------------------------------------------------------------------------- -->
<tr>
<td class="requestName">PutResults</td>
<td class="requestDescr">
Adds new results to the database.
</td>

<td>
<pre>
&lt;request type="PutResults"&gt;
    &lt;context platform="..." host="..."
        gitRepo="..." gitBranch="..."
        timestamp="..." sha1="..."
        testCase="..." /&gt;
    &lt;testFunction name="..."&gt;
        &lt;dataTag name="..." metric="..."
            value"..." /&gt;
        ...
    &lt;/testFunction&gt;
    ...
&lt;/request&gt;
</pre>
</td>

<td>
&lt;reply type="PutResults" /&gt;
</td>

</tr>

<!-- ---------------------------------------------------------------------------------- -->
<tr>
<td class="requestName">GetMetrics</td>
<td class="requestDescr">
Lists available metrics. Additional context components (platform, host,
or git repo/branch) may be specified as non-empty values to restrict the
output to metrics for which at least one result exists in combination with
those values. If all additional entity values are empty, the output will
include all available metrics, even those that haven't been associated with
any result yet.
</td>

<td>
<pre>
&lt;request type="GetMetrics"&gt;
    &lt;context platform="..."
        host="..." gitRepo="..."
        gitBranch="..." /&gt;
&lt;/request&gt;
</pre>
</td>

<td>
<pre>
&lt;reply type="GetMetrics"&gt;
    &lt;metric name="..." /&gt;
    &lt;metric name="..." /&gt;
    ...
&lt;/reply&gt;
</pre>
</td>

</tr>

<!-- ---------------------------------------------------------------------------------- -->
<tr>
<td class="requestName">GetPlatforms</td>
<td class="requestDescr">
Behaves similarly to GetMetrics (see this).
</td>

<td>
<pre>
&lt;request type="GetPlatforms"&gt;
    &lt;context metric="..."
        host="..." gitRepo="..."
        gitBranch="..." /&gt;
&lt;/request&gt;
</pre>
</td>

<td>
<pre>
&lt;reply type="GetPlatforms"&gt;
    &lt;platform name="..." /&gt;
    &lt;platform name="..." /&gt;
    ...
&lt;/reply&gt;
</pre>
</td>

</tr>

<!-- ---------------------------------------------------------------------------------- -->
<tr>
<td class="requestName">GetHosts</td>
<td class="requestDescr">
Behaves similarly to GetMetrics (see this).
</td>

<td>
<pre>
&lt;request type="GetHosts"&gt;
    &lt;context metric="..."
        platform="..." gitRepo="..."
        gitBranch="..." /&gt;
&lt;/request&gt;
</pre>
</td>

<td>
<pre>
&lt;reply type="GetHosts"&gt;
    &lt;host name="..." /&gt;
    &lt;host name="..." /&gt;
    ...
&lt;/reply&gt;
</pre>
</td>

</tr>

<!-- ---------------------------------------------------------------------------------- -->
<tr>
<td class="requestName">GetBranches</td>
<td class="requestDescr">
Behaves similarly to GetMetrics (see this).
</td>

<td>
<pre>
&lt;request type="GetBranches"&gt;
    &lt;context metric="..."
        platform="..." host="..." /&gt;
&lt;/request&gt;
</pre>
</td>

<td>
<pre>
&lt;reply type="GetBranches"&gt;
    &lt;branch gitRepo="..." gitBranch="..." /&gt;
    &lt;branch gitRepo="..." gitBranch="..." /&gt;
    ...
&lt;/reply&gt;
</td>

</tr>

<!-- ---------------------------------------------------------------------------------- -->
<tr>
<td class="requestName">GetHistory</td>
<td class="requestDescr">
Lists statistics and history for a specific benchmark.

<br /><br />
<b>Note:</b> The value <i>first</i> for timestamp1 specifies the first available
snapshot, while the value <i>last</i> for timestamp2 specifies the last available
snapshot. Otherwise, timestamp1 refers to the earliest snapshot that is not
earlier than the specified value, while timestamp2 refers to the
latest snapshot that is not later than the specified value.

<br /><br />
<b>Notes:</b>
<ul>
<li>The &lt;lastDiff&gt; tag is omitted altogether if no last difference
    exists (within the specified range).</li>
<li>A non-negative value for the <i>index</i> attribute in the
    &lt;lastDiff&gt; tag refers to the index (0 = first) of the last difference
    in the list of &lt;result&gt; tags. (</b>A negative value means
    that the list of &lt;result&gt; tags doesn't include the last difference.)
<li>The &lt;lastValue&gt; tag is omitted altogether if no last value
    exists (i.e. the specified range is empty).</li>
<li>The &lt;regression&gt; tag is omitted altogether if the regression
    cannot be computed.</li>
<li>The <i>id</i> attribute in the &lt;result&gt; tag is the primary key that
    identifies the result in the database.</li>
</ul>

</td>

<td>
<pre>
&lt;request type="GetHistory"&gt;
    &lt;context testCase="..." testFunction="..."
        dataTag="..." metric="..."
        platform="..." host="..."
        gitRepo="..." gitBranch="..."
        timestamp1="..." timestamp2="..."
        diffTolerance="..." stabTolerance="..."
        maxSize="..." /&gt;
&lt;/request&gt;
</pre>
</td>

<td>
<pre>
&lt;reply type="GetHistory"&gt;
    &lt;lastDiff index="..." stable="..."
        timestamp="..." sha1="..."
        value="..." /&gt;
    &lt;lastValue stable="..." /&gt;
    &lt;regression a="..." b="..." /&gt;
    &lt;result timestamp="..." sha1="..."
        value="..." id="..." /&gt;
    &lt;result timestamp="..." sha1="..."
        value="..." id="..." /&gt;
    ...
&lt;/reply&gt;
</pre>
</td>

</tr>

<!-- ---------------------------------------------------------------------------------- -->
<tr>
<td class="requestName">GetHistory2</td>
<td class="requestDescr">
Lists statistics and history for a specific benchmark in two branches.

<br />
<span style="color:red">2 B COMPLETED</span>

</td>

<td>
<pre>
&lt;request type="GetHistory2"&gt;
    &lt;context testCase="..." testFunction="..."
        dataTag="..." metric="..."
        platform="..." host="..."
        gitRepo1="..." gitBranch1="..."
        gitRepo2="..." gitBranch2="..."
        timestamp1="..." timestamp2="..."
        diffTolerance="..." stabTolerance="..."
        maxSize="..." /&gt;
&lt;/request&gt;
</pre>
</td>

<td>
<pre>
&lt;reply type="GetHistory2"&gt;
    &lt;lastDiff1 index="..." stable="..."
        timestamp="..." sha1="..."
        value="..." /&gt;
    &lt;lastValue1 stable="..." /&gt;
    &lt;regression1 a="..." b="..." /&gt;
    &lt;result1 timestamp="..." sha1="..."
        value="..." /&gt;
    &lt;result1 timestamp="..." sha1="..."
        value="..." /&gt;
    ...
    &lt;lastDiff2 index="..." stable="..."
        timestamp="..." sha1="..."
        value="..." /&gt;
    &lt;lastValue2 stable="..." /&gt;
    &lt;regression2 a="..." b="..." /&gt;
    &lt;result2 timestamp="..." sha1="..."
        value="..." /&gt;
    &lt;result2 timestamp="..." sha1="..."
        value="..." /&gt;
    ...
&lt;/reply&gt;
</pre>
</td>

</tr>

<!-- ---------------------------------------------------------------------------------- -->
<tr>
<td class="requestName">GetRankedBenchmarks</td>
<td class="requestDescr">
Lists the benchmarks with the most important <i>last difference</i> values.

<br /><br />
The snapshot range (timestamp1/2) is defined as for the <span
class="requestName">GetHistory</span> request (see this).

<br /><br />
For each benchmark in the reply message, each of the &lt;lastValue&gt;,
&lt;lastDiff&gt;, and &lt;regression&gt; is included only if the value
exists (or can be computed in the case of the regression).

</td>

<td>
<pre>
&lt;request type="GetRankedBenchmarks"&gt;
    &lt;context metric="..."
        platform="..." host="..."
        gitRepo="..." gitBranch="..."
        timestamp1="..." timestamp2="..."
        diffTolerance="..." stabTolerance="..."
        ranking="..." scope="..."
        maxSize="..."
        testCaseFilter="..."
        testFunctionFilter="..."
        dataTagFilter="..." /&gt;
&lt;/request&gt;
</pre>
</td>

<td>
<pre>
&lt;reply type="GetRankedBenchmarks"&gt;
    &lt;benchmark testCase="..."
        testFunction="..." dataTag="..."&gt;
        &lt;lastValue timestamp="..."
            sha1="..." value="..."
            stable="..." /&gt;
        &lt;lastDiff timestamp="..."
            sha1="..." value="..."
            stable="..." /&gt;
        &lt;regression a="..." b="..." /&gt;
    &lt;/benchmark&gt;
    ...
&lt;/reply&gt;
</pre>
</td>

</tr>


<!-- ---------------------------------------------------------------------------------- -->
<tr>
<td class="requestName">GetRankedBenchmarks2</td>
<td class="requestDescr">
Lists the benchmarks with the most important <i>last value differences</i> for
two branches.

</td>

<td>
<pre>
&lt;request type="GetRankedBenchmarks2"&gt;
    &lt;context metric="..."
        platform="..." host="..."
        gitRepo1="..." gitBranch1="..."
        gitRepo2="..." gitBranch2="..."
        diffTolerance="..." stabTolerance="..."
        ranking="..." scope="..."
        maxSize="..." 
        testCaseFilter="..."
        testFunctionFilter="..."
        dataTagFilter="..." /&gt;
&lt;/request&gt;
</pre>
</td>

<td>
<pre>
&lt;reply type="GetRankedBenchmarks2"&gt;
    &lt;benchmark testCase="..."
        testFunction="..." dataTag="..."&gt;
        &lt;lastValue1 timestamp="..."
            sha1="..." value="..."
            stable="..." /&gt;
        &lt;lastValue2 timestamp="..."
            sha1="..." value="..."
            stable="..." /&gt;
    &lt;/benchmark&gt;
    ...
&lt;/reply&gt;
</pre>
</td>

</tr>


<!-- ---------------------------------------------------------------------------------- -->
<tr>
<td class="requestName">GetStats</td>
<td class="requestDescr">
Computes basic statistics for the benchmarks within a certain context.

</td>

<td>
<pre>
&lt;request type="GetStats"&gt;
    &lt;context metric="..."
        platform="..." host="..."
        gitRepo="..." gitBranch="..."
        timestamp1="..." timestamp2="..."
        diffTolerance="..." stabTolerance="..." /&gt;
&lt;/request&gt;
</pre>
</td>

<td>
<pre>
&lt;reply type="GetStats"&gt;
    &lt;stats nBenchmarks="..."
        nLastDiffs="..."
        nStableLastDiffs="..."
        minStableLastDiff="..."
        avgStableLastDiff="..."
        maxStableLastDiff="..." /&gt;
&lt;/reply&gt;
</pre>
</td>

</tr>


<!-- ---------------------------------------------------------------------------------- -->
<tr>
<td class="requestName">GetContexts</td>
<td class="requestDescr">
Lists available contexts, i.e. combinations of metric, platform, host, and
branch.
<b>Note:</b> the attribute values in a <i>context</i> element are
zero-based indexes of entries in the respective component lists.
</td>

<td>
<pre>
&lt;request type="GetContexts" /&gt;
</pre>
</td>

<td>
<pre>
&lt;reply type="GetContexts"&gt;
    &lt;metric name="..." /&gt;
    &lt;metric name="..." /&gt;
    ...
    &lt;platform name="..." /&gt;
    &lt;platform name="..." /&gt;
    ...
    &lt;host name="..." /&gt;
    &lt;host name="..." /&gt;
    ...
    &lt;branch gitRepo="..." gitBranch="..." /&gt;
    &lt;branch gitRepo="..." gitBranch="..." /&gt;
    ...
    &lt;context
        metric="..." platform="..."
        host="..." branch="..." /&gt;
    &lt;context
        metric="..." platform="..."
        host="..." branch="..." /&gt;
    ...
&lt;/reply&gt;
</pre>
</td>

</tr>


</table>

</body>
</html>