tests/pm_rps: use igt_assert_cmpint
[platform/upstream/intel-gpu-tools.git] / tests / pm_rps.c
1 /*
2  * Copyright © 2012 Intel Corporation
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice (including the next
12  * paragraph) shall be included in all copies or substantial portions of the
13  * Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21  * IN THE SOFTWARE.
22  *
23  * Authors:
24  *    Ben Widawsky <ben@bwidawsk.net>
25  *    Jeff McGee <jeff.mcgee@intel.com>
26  *
27  */
28
29 #define _GNU_SOURCE
30 #include <stdio.h>
31 #include <stdlib.h>
32 #include <string.h>
33 #include <unistd.h>
34 #include <getopt.h>
35 #include <fcntl.h>
36 #include <signal.h>
37 #include "drmtest.h"
38 #include "intel_gpu_tools.h"
39 #include "intel_bufmgr.h"
40 #include "intel_batchbuffer.h"
41 #include "igt_debugfs.h"
42
43 static int drm_fd;
44
45 static const char sysfs_base_path[] = "/sys/class/drm/card%d/gt_%s_freq_mhz";
46 enum {
47         CUR,
48         MIN,
49         MAX,
50         RP0,
51         RP1,
52         RPn,
53         NUMFREQ
54 };
55
56 static int origfreqs[NUMFREQ];
57
58 struct junk {
59         const char *name;
60         const char *mode;
61         FILE *filp;
62 } stuff[] = {
63         { "cur", "r", NULL }, { "min", "rb+", NULL }, { "max", "rb+", NULL }, { "RP0", "r", NULL }, { "RP1", "r", NULL }, { "RPn", "r", NULL }, { NULL, NULL, NULL }
64 };
65
66 static igt_debugfs_t dfs;
67
68 static int readval(FILE *filp)
69 {
70         int val;
71         int scanned;
72
73         rewind(filp);
74         scanned = fscanf(filp, "%d", &val);
75         igt_assert(scanned == 1);
76
77         return val;
78 }
79
80 static void read_freqs(int *freqs)
81 {
82         int i;
83
84         for (i = 0; i < NUMFREQ; i++)
85                 freqs[i] = readval(stuff[i].filp);
86 }
87
88 static int do_writeval(FILE *filp, int val, int lerrno)
89 {
90         int ret, orig;
91
92         orig = readval(filp);
93         rewind(filp);
94         ret = fprintf(filp, "%d", val);
95
96         if (lerrno) {
97                 /* Expecting specific error */
98                 igt_assert(ret == EOF && errno == lerrno);
99                 igt_assert(readval(filp) == orig);
100         } else {
101                 /* Expecting no error */
102                 igt_assert(ret != EOF);
103                 igt_assert(readval(filp) == val);
104         }
105
106         return ret;
107 }
108 #define writeval(filp, val) do_writeval(filp, val, 0)
109 #define writeval_inval(filp, val) do_writeval(filp, val, EINVAL)
110
111 static void checkit(const int *freqs)
112 {
113         igt_assert_cmpint(freqs[MIN], <=, freqs[MAX]);
114         igt_assert_cmpint(freqs[CUR], <=, freqs[MAX]);
115         igt_assert_cmpint(freqs[MIN], <=, freqs[CUR]);
116         igt_assert_cmpint(freqs[RPn], <=, freqs[MIN]);
117         igt_assert_cmpint(freqs[MAX], <=, freqs[RP0]);
118         igt_assert_cmpint(freqs[RP1], <=, freqs[RP0]);
119         igt_assert_cmpint(freqs[RPn], <=, freqs[RP1]);
120         igt_assert(freqs[RP0] != 0);
121         igt_assert(freqs[RP1] != 0);
122 }
123
124 static void matchit(const int *freqs1, const int *freqs2)
125 {
126         igt_assert_cmpint(freqs1[CUR], ==, freqs2[CUR]);
127         igt_assert_cmpint(freqs1[MIN], ==, freqs2[MIN]);
128         igt_assert_cmpint(freqs1[MAX], ==, freqs2[MAX]);
129         igt_assert_cmpint(freqs1[RP0], ==, freqs2[RP0]);
130         igt_assert_cmpint(freqs1[RP1], ==, freqs2[RP1]);
131         igt_assert_cmpint(freqs1[RPn], ==, freqs2[RPn]);
132 }
133
134 static void dump(const int *freqs)
135 {
136         int i;
137
138         igt_debug("gt freq (MHz):");
139         for (i = 0; i < NUMFREQ; i++)
140                 igt_debug("  %s=%d", stuff[i].name, freqs[i]);
141
142         igt_debug("\n");
143 }
144
145 enum load {
146         LOW,
147         HIGH
148 };
149
150 static struct load_helper {
151         int devid;
152         int has_ppgtt;
153         drm_intel_bufmgr *bufmgr;
154         struct intel_batchbuffer *batch;
155         drm_intel_bo *target_buffer;
156         enum load load;
157         bool exit;
158         struct igt_helper_process igt_proc;
159         drm_intel_bo *src, *dst;
160 } lh;
161
162 static void load_helper_signal_handler(int sig)
163 {
164         if (sig == SIGUSR2)
165                 lh.load = lh.load == LOW ? HIGH : LOW;
166         else
167                 lh.exit = true;
168 }
169
170 static void emit_store_dword_imm(uint32_t val)
171 {
172         int cmd;
173         struct intel_batchbuffer *batch = lh.batch;
174
175         cmd = MI_STORE_DWORD_IMM;
176         if (!lh.has_ppgtt)
177                 cmd |= MI_MEM_VIRTUAL;
178
179         if (intel_gen(lh.devid) >= 8) {
180                 BEGIN_BATCH(4);
181                 OUT_BATCH(cmd);
182                 OUT_RELOC(lh.target_buffer, I915_GEM_DOMAIN_INSTRUCTION,
183                           I915_GEM_DOMAIN_INSTRUCTION, 0);
184                 OUT_BATCH(0);
185                 OUT_BATCH(val);
186                 ADVANCE_BATCH();
187         } else {
188                 BEGIN_BATCH(4);
189                 OUT_BATCH(cmd);
190                 OUT_BATCH(0); /* reserved */
191                 OUT_RELOC(lh.target_buffer, I915_GEM_DOMAIN_INSTRUCTION,
192                           I915_GEM_DOMAIN_INSTRUCTION, 0);
193                 OUT_BATCH(val);
194                 ADVANCE_BATCH();
195         }
196 }
197
198 #define LOAD_HELPER_PAUSE_USEC 500
199 #define LOAD_HELPER_BO_SIZE (16*1024*1024)
200 static void load_helper_set_load(enum load load)
201 {
202         assert(lh.igt_proc.running);
203
204         if (lh.load == load)
205                 return;
206
207         lh.load = load;
208         kill(lh.igt_proc.pid, SIGUSR2);
209 }
210
211 static void load_helper_run(enum load load)
212 {
213         /*
214          * FIXME fork helpers won't get cleaned up when started from within a
215          * subtest, so handle the case where it sticks around a bit too long.
216          */
217         if (lh.igt_proc.running) {
218                 load_helper_set_load(load);
219                 return;
220         }
221
222         lh.load = load;
223
224         igt_fork_helper(&lh.igt_proc) {
225                 uint32_t val = 0;
226
227                 signal(SIGUSR1, load_helper_signal_handler);
228                 signal(SIGUSR2, load_helper_signal_handler);
229
230                 while (!lh.exit) {
231                         if (lh.load == HIGH)
232                                 intel_copy_bo(lh.batch, lh.dst, lh.dst,
233                                               LOAD_HELPER_BO_SIZE);
234
235                         emit_store_dword_imm(val);
236                         intel_batchbuffer_flush_on_ring(lh.batch, 0);
237                         val++;
238
239                         /* Lower the load by pausing after every submitted
240                          * write. */
241                         if (lh.load == LOW)
242                                 usleep(LOAD_HELPER_PAUSE_USEC);
243                 }
244
245                 /* Map buffer to stall for write completion */
246                 drm_intel_bo_map(lh.target_buffer, 0);
247                 drm_intel_bo_unmap(lh.target_buffer);
248
249                 igt_debug("load helper sent %u dword writes\n", val);
250         }
251 }
252
253 static void load_helper_stop(void)
254 {
255         kill(lh.igt_proc.pid, SIGUSR1);
256         igt_wait_helper(&lh.igt_proc);
257 }
258
259 static void load_helper_init(void)
260 {
261         lh.devid = intel_get_drm_devid(drm_fd);
262         lh.has_ppgtt = gem_uses_aliasing_ppgtt(drm_fd);
263
264         /* MI_STORE_DATA can only use GTT address on gen4+/g33 and needs
265          * snoopable mem on pre-gen6. Hence load-helper only works on gen6+, but
266          * that's also all we care about for the rps testcase*/
267         igt_assert(intel_gen(lh.devid) >= 6);
268         lh.bufmgr = drm_intel_bufmgr_gem_init(drm_fd, 4096);
269         igt_assert(lh.bufmgr);
270
271         drm_intel_bufmgr_gem_enable_reuse(lh.bufmgr);
272
273         lh.batch = intel_batchbuffer_alloc(lh.bufmgr, lh.devid);
274         igt_assert(lh.batch);
275
276         lh.target_buffer = drm_intel_bo_alloc(lh.bufmgr, "target bo",
277                                               4096, 4096);
278         igt_assert(lh.target_buffer);
279
280         lh.dst = drm_intel_bo_alloc(lh.bufmgr, "dst bo",
281                                     LOAD_HELPER_BO_SIZE, 4096);
282         igt_assert(lh.dst);
283         lh.src = drm_intel_bo_alloc(lh.bufmgr, "src bo",
284                                     LOAD_HELPER_BO_SIZE, 4096);
285         igt_assert(lh.src);
286 }
287
288 static void load_helper_deinit(void)
289 {
290         if (lh.igt_proc.running)
291                 load_helper_stop();
292
293         if (lh.target_buffer)
294                 drm_intel_bo_unreference(lh.target_buffer);
295
296         if (lh.batch)
297                 intel_batchbuffer_free(lh.batch);
298
299         if (lh.bufmgr)
300                 drm_intel_bufmgr_destroy(lh.bufmgr);
301 }
302
303 static void stop_rings(void)
304 {
305         int fd;
306         static const char data[] = "0xf";
307
308         fd = igt_debugfs_open(&dfs, "i915_ring_stop", O_WRONLY);
309         igt_assert(fd >= 0);
310
311         igt_debug("injecting ring stop\n");
312         igt_assert(write(fd, data, sizeof(data)) == sizeof(data));
313
314         close(fd);
315 }
316
317 static bool rings_stopped(void)
318 {
319         int fd;
320         static char buf[128];
321         unsigned long long val;
322
323         fd = igt_debugfs_open(&dfs, "i915_ring_stop", O_RDONLY);
324         igt_assert(fd >= 0);
325
326         igt_assert(read(fd, buf, sizeof(buf)) > 0);
327         close(fd);
328
329         sscanf(buf, "%llx", &val);
330
331         return (bool)val;
332 }
333
334 static void min_max_config(void (*check)(void))
335 {
336         int fmid = (origfreqs[RPn] + origfreqs[RP0]) / 2;
337
338         /* hw (and so kernel) currently rounds to 50 MHz ... */
339         fmid = fmid / 50 * 50;
340
341         igt_debug("\nCheck original min and max...\n");
342         check();
343
344         igt_debug("\nSet min=RPn and max=RP0...\n");
345         writeval(stuff[MIN].filp, origfreqs[RPn]);
346         writeval(stuff[MAX].filp, origfreqs[RP0]);
347         check();
348
349         igt_debug("\nIncrease min to midpoint...\n");
350         writeval(stuff[MIN].filp, fmid);
351         check();
352
353         igt_debug("\nIncrease min to RP0...\n");
354         writeval(stuff[MIN].filp, origfreqs[RP0]);
355         check();
356
357         igt_debug("\nIncrease min above RP0 (invalid)...\n");
358         writeval_inval(stuff[MIN].filp, origfreqs[RP0] + 1000);
359         check();
360
361         igt_debug("\nDecrease max to RPn (invalid)...\n");
362         writeval_inval(stuff[MAX].filp, origfreqs[RPn]);
363         check();
364
365         igt_debug("\nDecrease min to midpoint...\n");
366         writeval(stuff[MIN].filp, fmid);
367         check();
368
369         igt_debug("\nDecrease min to RPn...\n");
370         writeval(stuff[MIN].filp, origfreqs[RPn]);
371         check();
372
373         igt_debug("\nDecrease min below RPn (invalid)...\n");
374         writeval_inval(stuff[MIN].filp, 0);
375         check();
376
377         igt_debug("\nDecrease max to midpoint...\n");
378         writeval(stuff[MAX].filp, fmid);
379         check();
380
381         igt_debug("\nDecrease max to RPn...\n");
382         writeval(stuff[MAX].filp, origfreqs[RPn]);
383         check();
384
385         igt_debug("\nDecrease max below RPn (invalid)...\n");
386         writeval_inval(stuff[MAX].filp, 0);
387         check();
388
389         igt_debug("\nIncrease min to RP0 (invalid)...\n");
390         writeval_inval(stuff[MIN].filp, origfreqs[RP0]);
391         check();
392
393         igt_debug("\nIncrease max to midpoint...\n");
394         writeval(stuff[MAX].filp, fmid);
395         check();
396
397         igt_debug("\nIncrease max to RP0...\n");
398         writeval(stuff[MAX].filp, origfreqs[RP0]);
399         check();
400
401         igt_debug("\nIncrease max above RP0 (invalid)...\n");
402         writeval_inval(stuff[MAX].filp, origfreqs[RP0] + 1000);
403         check();
404
405         writeval(stuff[MIN].filp, origfreqs[MIN]);
406         writeval(stuff[MAX].filp, origfreqs[MAX]);
407 }
408
409 static void basic_check(void)
410 {
411         int freqs[NUMFREQ];
412
413         read_freqs(freqs);
414         dump(freqs);
415         checkit(freqs);
416 }
417
418 #define IDLE_WAIT_TIMESTEP_MSEC 100
419 #define IDLE_WAIT_TIMEOUT_MSEC 3000
420 static void idle_check(void)
421 {
422         int freqs[NUMFREQ];
423         int wait = 0;
424
425         /* Monitor frequencies until cur settles down to min, which should
426          * happen within the allotted time */
427         do {
428                 read_freqs(freqs);
429                 dump(freqs);
430                 checkit(freqs);
431                 if (freqs[CUR] == freqs[MIN])
432                         break;
433                 usleep(1000 * IDLE_WAIT_TIMESTEP_MSEC);
434                 wait += IDLE_WAIT_TIMESTEP_MSEC;
435         } while (wait < IDLE_WAIT_TIMEOUT_MSEC);
436
437         igt_assert_cmpint(freqs[CUR], ==, freqs[MIN]);
438         igt_debug("Required %d msec to reach cur=min\n", wait);
439 }
440
441 #define LOADED_WAIT_TIMESTEP_MSEC 100
442 #define LOADED_WAIT_TIMEOUT_MSEC 3000
443 static void loaded_check(void)
444 {
445         int freqs[NUMFREQ];
446         int wait = 0;
447
448         /* Monitor frequencies until cur increases to max, which should
449          * happen within the allotted time */
450         do {
451                 read_freqs(freqs);
452                 dump(freqs);
453                 checkit(freqs);
454                 if (freqs[CUR] == freqs[MAX])
455                         break;
456                 usleep(1000 * LOADED_WAIT_TIMESTEP_MSEC);
457                 wait += LOADED_WAIT_TIMESTEP_MSEC;
458         } while (wait < LOADED_WAIT_TIMEOUT_MSEC);
459
460         igt_assert_cmpint(freqs[CUR], ==, freqs[MAX]);
461         igt_debug("Required %d msec to reach cur=max\n", wait);
462 }
463
464 #define STABILIZE_WAIT_TIMESTEP_MSEC 100
465 #define STABILIZE_WAIT_TIMEOUT_MSEC 2000
466 static void stabilize_check(int *freqs)
467 {
468         int wait = 0;
469
470         do {
471                 read_freqs(freqs);
472                 dump(freqs);
473                 usleep(1000 * STABILIZE_WAIT_TIMESTEP_MSEC);
474                 wait += STABILIZE_WAIT_TIMESTEP_MSEC;
475         } while (wait < STABILIZE_WAIT_TIMEOUT_MSEC);
476
477         igt_debug("Waited %d msec to stabilize cur\n", wait);
478 }
479
480 static void reset(void)
481 {
482         int pre_freqs[NUMFREQ];
483         int post_freqs[NUMFREQ];
484
485         igt_debug("Apply low load...\n");
486         load_helper_run(LOW);
487         stabilize_check(pre_freqs);
488
489         igt_debug("Stop rings...\n");
490         stop_rings();
491         while (rings_stopped())
492                 usleep(1000 * 100);
493         igt_debug("Ring stop cleared\n");
494
495         igt_debug("Apply high load...\n");
496         load_helper_set_load(HIGH);
497         loaded_check();
498
499         igt_debug("Apply low load...\n");
500         load_helper_set_load(LOW);
501         stabilize_check(post_freqs);
502         matchit(pre_freqs, post_freqs);
503
504         igt_debug("Apply high load...\n");
505         load_helper_set_load(HIGH);
506         loaded_check();
507
508         igt_debug("Removing load...\n");
509         load_helper_stop();
510         idle_check();
511 }
512
513 static void pm_rps_exit_handler(int sig)
514 {
515         if (origfreqs[MIN] > readval(stuff[MAX].filp)) {
516                 writeval(stuff[MAX].filp, origfreqs[MAX]);
517                 writeval(stuff[MIN].filp, origfreqs[MIN]);
518         } else {
519                 writeval(stuff[MIN].filp, origfreqs[MIN]);
520                 writeval(stuff[MAX].filp, origfreqs[MAX]);
521         }
522
523         load_helper_deinit();
524         close(drm_fd);
525 }
526
527 igt_main
528 {
529         igt_skip_on_simulation();
530
531         igt_fixture {
532                 const int device = drm_get_card();
533                 struct junk *junk = stuff;
534                 int ret;
535
536                 /* Use drm_open_any to verify device existence */
537                 drm_fd = drm_open_any();
538
539                 do {
540                         int val = -1;
541                         char *path;
542                         ret = asprintf(&path, sysfs_base_path, device, junk->name);
543                         igt_assert(ret != -1);
544                         junk->filp = fopen(path, junk->mode);
545                         igt_require(junk->filp);
546                         setbuf(junk->filp, NULL);
547
548                         val = readval(junk->filp);
549                         igt_assert(val >= 0);
550                         junk++;
551                 } while(junk->name != NULL);
552
553                 read_freqs(origfreqs);
554
555                 igt_install_exit_handler(pm_rps_exit_handler);
556
557                 load_helper_init();
558
559                 igt_debugfs_init(&dfs);
560         }
561
562         igt_subtest("basic-api")
563                 min_max_config(basic_check);
564
565         igt_subtest("min-max-config-idle")
566                 min_max_config(idle_check);
567
568         igt_subtest("min-max-config-loaded") {
569                 load_helper_run(HIGH);
570                 min_max_config(loaded_check);
571                 load_helper_stop();
572         }
573
574         igt_subtest("reset")
575                 reset();
576 }