tests/pm_rps: Round requested freq correctly
[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 bool verbose = false;
44
45 static int drm_fd;
46
47 static const char sysfs_base_path[] = "/sys/class/drm/card%d/gt_%s_freq_mhz";
48 enum {
49         CUR,
50         MIN,
51         MAX,
52         RP0,
53         RP1,
54         RPn,
55         NUMFREQ
56 };
57
58 static int origfreqs[NUMFREQ];
59
60 struct junk {
61         const char *name;
62         const char *mode;
63         FILE *filp;
64 } stuff[] = {
65         { "cur", "r", NULL }, { "min", "rb+", NULL }, { "max", "rb+", NULL }, { "RP0", "r", NULL }, { "RP1", "r", NULL }, { "RPn", "r", NULL }, { NULL, NULL, NULL }
66 };
67
68 static igt_debugfs_t dfs;
69
70 static int readval(FILE *filp)
71 {
72         int val;
73         int scanned;
74
75         rewind(filp);
76         scanned = fscanf(filp, "%d", &val);
77         igt_assert(scanned == 1);
78
79         return val;
80 }
81
82 static void read_freqs(int *freqs)
83 {
84         int i;
85
86         for (i = 0; i < NUMFREQ; i++)
87                 freqs[i] = readval(stuff[i].filp);
88 }
89
90 static int do_writeval(FILE *filp, int val, int lerrno)
91 {
92         int ret, orig;
93
94         orig = readval(filp);
95         rewind(filp);
96         ret = fprintf(filp, "%d", val);
97
98         if (lerrno) {
99                 /* Expecting specific error */
100                 igt_assert(ret == EOF && errno == lerrno);
101                 igt_assert(readval(filp) == orig);
102         } else {
103                 /* Expecting no error */
104                 igt_assert(ret != EOF);
105                 igt_assert(readval(filp) == val);
106         }
107
108         return ret;
109 }
110 #define writeval(filp, val) do_writeval(filp, val, 0)
111 #define writeval_inval(filp, val) do_writeval(filp, val, EINVAL)
112
113 static void setfreq(int val)
114 {
115         if (val > readval(stuff[MAX].filp)) {
116                 writeval(stuff[MAX].filp, val);
117                 writeval(stuff[MIN].filp, val);
118         } else {
119                 writeval(stuff[MIN].filp, val);
120                 writeval(stuff[MAX].filp, val);
121         }
122 }
123
124 static void checkit(const int *freqs)
125 {
126         igt_assert(freqs[MIN] <= freqs[MAX]);
127         igt_assert(freqs[CUR] <= freqs[MAX]);
128         igt_assert(freqs[MIN] <= freqs[CUR]);
129         igt_assert(freqs[RPn] <= freqs[MIN]);
130         igt_assert(freqs[MAX] <= freqs[RP0]);
131         igt_assert(freqs[RP1] <= freqs[RP0]);
132         igt_assert(freqs[RPn] <= freqs[RP1]);
133         igt_assert(freqs[RP0] != 0);
134         igt_assert(freqs[RP1] != 0);
135 }
136
137 static void matchit(const int *freqs1, const int *freqs2)
138 {
139         igt_assert(freqs1[CUR] == freqs2[CUR]);
140         igt_assert(freqs1[MIN] == freqs2[MIN]);
141         igt_assert(freqs1[MAX] == freqs2[MAX]);
142         igt_assert(freqs1[RP0] == freqs2[RP0]);
143         igt_assert(freqs1[RP1] == freqs2[RP1]);
144         igt_assert(freqs1[RPn] == freqs2[RPn]);
145 }
146
147 static void dumpit(const int *freqs)
148 {
149         int i;
150
151         printf("gt freq (MHz):");
152         for (i = 0; i < NUMFREQ; i++)
153                 printf("  %s=%d", stuff[i].name, freqs[i]);
154
155         printf("\n");
156 }
157 #define dump(x) if (verbose) dumpit(x)
158 #define log(...) if (verbose) printf(__VA_ARGS__)
159
160 enum load {
161         LOW,
162         HIGH
163 };
164
165 static struct load_helper {
166         int devid;
167         int has_ppgtt;
168         drm_intel_bufmgr *bufmgr;
169         struct intel_batchbuffer *batch;
170         drm_intel_bo *target_buffer;
171         bool ready;
172         enum load load;
173         bool exit;
174         struct igt_helper_process igt_proc;
175 } lh;
176
177 static void load_helper_signal_handler(int sig)
178 {
179         if (sig == SIGUSR2)
180                 lh.load = lh.load == LOW ? HIGH : LOW;
181         else
182                 lh.exit = true;
183 }
184
185 static void emit_store_dword_imm(uint32_t val)
186 {
187         int cmd;
188         struct intel_batchbuffer *batch = lh.batch;
189
190         cmd = MI_STORE_DWORD_IMM;
191         if (!lh.has_ppgtt)
192                 cmd |= MI_MEM_VIRTUAL;
193
194         if (intel_gen(lh.devid) >= 8) {
195                 BEGIN_BATCH(4);
196                 OUT_BATCH(cmd);
197                 OUT_RELOC(lh.target_buffer, I915_GEM_DOMAIN_INSTRUCTION,
198                           I915_GEM_DOMAIN_INSTRUCTION, 0);
199                 OUT_BATCH(0);
200                 OUT_BATCH(val);
201                 ADVANCE_BATCH();
202         } else {
203                 BEGIN_BATCH(4);
204                 OUT_BATCH(cmd);
205                 OUT_BATCH(0); /* reserved */
206                 OUT_RELOC(lh.target_buffer, I915_GEM_DOMAIN_INSTRUCTION,
207                           I915_GEM_DOMAIN_INSTRUCTION, 0);
208                 OUT_BATCH(val);
209                 ADVANCE_BATCH();
210         }
211 }
212
213 #define LOAD_HELPER_PAUSE_USEC 500
214 static void load_helper_run(enum load load)
215 {
216         assert(!lh.igt_proc.running);
217
218         igt_require(lh.ready == true);
219
220         lh.load = load;
221
222         igt_fork_helper(&lh.igt_proc) {
223                 uint32_t val = 0;
224
225                 signal(SIGUSR1, load_helper_signal_handler);
226                 signal(SIGUSR2, load_helper_signal_handler);
227
228                 while (!lh.exit) {
229                         emit_store_dword_imm(val);
230                         intel_batchbuffer_flush_on_ring(lh.batch, 0);
231                         val++;
232
233                         /* Lower the load by pausing after every submitted
234                          * write. */
235                         if (lh.load == LOW)
236                                 usleep(LOAD_HELPER_PAUSE_USEC);
237                 }
238
239                 /* Map buffer to stall for write completion */
240                 drm_intel_bo_map(lh.target_buffer, 0);
241                 drm_intel_bo_unmap(lh.target_buffer);
242
243                 log("load helper sent %u dword writes\n", val);
244         }
245 }
246
247 static void load_helper_set_load(enum load load)
248 {
249         assert(lh.igt_proc.running);
250
251         if (lh.load == load)
252                 return;
253
254         lh.load = load;
255         kill(lh.igt_proc.pid, SIGUSR2);
256 }
257
258 static void load_helper_stop(void)
259 {
260         assert(lh.igt_proc.running);
261         kill(lh.igt_proc.pid, SIGUSR1);
262         igt_wait_helper(&lh.igt_proc);
263 }
264
265 /* The load helper resource is used by only some subtests. We attempt to
266  * initialize in igt_fixture but do our igt_require check only if a
267  * subtest attempts to run it */
268 static void load_helper_init(void)
269 {
270         lh.devid = intel_get_drm_devid(drm_fd);
271         lh.has_ppgtt = gem_uses_aliasing_ppgtt(drm_fd);
272
273         /* MI_STORE_DATA can only use GTT address on gen4+/g33 and needs
274          * snoopable mem on pre-gen6. */
275         if (intel_gen(lh.devid) < 6) {
276                 log("load helper init failed: pre-gen6 not supported\n");
277                 return;
278         }
279
280         lh.bufmgr = drm_intel_bufmgr_gem_init(drm_fd, 4096);
281         if (!lh.bufmgr) {
282                 log("load helper init failed: buffer manager init\n");
283                 return;
284         }
285         drm_intel_bufmgr_gem_enable_reuse(lh.bufmgr);
286
287         lh.batch = intel_batchbuffer_alloc(lh.bufmgr, lh.devid);
288         if (!lh.batch) {
289                 log("load helper init failed: batch buffer alloc\n");
290                 return;
291         }
292
293         lh.target_buffer = drm_intel_bo_alloc(lh.bufmgr, "target bo",
294                                               4096, 4096);
295         if (!lh.target_buffer) {
296                 log("load helper init failed: target buffer alloc\n");
297                 return;
298         }
299
300         lh.ready = true;
301 }
302
303 static void load_helper_deinit(void)
304 {
305         if (lh.igt_proc.running)
306                 load_helper_stop();
307
308         if (lh.target_buffer)
309                 drm_intel_bo_unreference(lh.target_buffer);
310
311         if (lh.batch)
312                 intel_batchbuffer_free(lh.batch);
313
314         if (lh.bufmgr)
315                 drm_intel_bufmgr_destroy(lh.bufmgr);
316 }
317
318 static void stop_rings(void)
319 {
320         int fd;
321         static const char data[] = "0xf";
322
323         fd = igt_debugfs_open(&dfs, "i915_ring_stop", O_WRONLY);
324         igt_assert(fd >= 0);
325
326         log("injecting ring stop\n");
327         igt_assert(write(fd, data, sizeof(data)) == sizeof(data));
328
329         close(fd);
330 }
331
332 static bool rings_stopped(void)
333 {
334         int fd;
335         static char buf[128];
336         unsigned long long val;
337
338         fd = igt_debugfs_open(&dfs, "i915_ring_stop", O_RDONLY);
339         igt_assert(fd >= 0);
340
341         igt_assert(read(fd, buf, sizeof(buf)) > 0);
342         close(fd);
343
344         sscanf(buf, "%llx", &val);
345
346         return (bool)val;
347 }
348
349 static void min_max_config(void (*check)(void))
350 {
351         int fmid = (origfreqs[RPn] + origfreqs[RP0]) / 2;
352
353         /* hw (and so kernel) currently rounds to 50 MHz ... */
354         fmid = fmid / 50 * 50;
355
356         log("\nCheck original min and max...\n");
357         check();
358
359         log("\nSet min=RPn and max=RP0...\n");
360         writeval(stuff[MIN].filp, origfreqs[RPn]);
361         writeval(stuff[MAX].filp, origfreqs[RP0]);
362         check();
363
364         log("\nIncrease min to midpoint...\n");
365         writeval(stuff[MIN].filp, fmid);
366         check();
367
368         log("\nIncrease min to RP0...\n");
369         writeval(stuff[MIN].filp, origfreqs[RP0]);
370         check();
371
372         log("\nIncrease min above RP0 (invalid)...\n");
373         writeval_inval(stuff[MIN].filp, origfreqs[RP0] + 1000);
374         check();
375
376         log("\nDecrease max to RPn (invalid)...\n");
377         writeval_inval(stuff[MAX].filp, origfreqs[RPn]);
378         check();
379
380         log("\nDecrease min to midpoint...\n");
381         writeval(stuff[MIN].filp, fmid);
382         check();
383
384         log("\nDecrease min to RPn...\n");
385         writeval(stuff[MIN].filp, origfreqs[RPn]);
386         check();
387
388         log("\nDecrease min below RPn (invalid)...\n");
389         writeval_inval(stuff[MIN].filp, 0);
390         check();
391
392         log("\nDecrease max to midpoint...\n");
393         writeval(stuff[MAX].filp, fmid);
394         check();
395
396         log("\nDecrease max to RPn...\n");
397         writeval(stuff[MAX].filp, origfreqs[RPn]);
398         check();
399
400         log("\nDecrease max below RPn (invalid)...\n");
401         writeval_inval(stuff[MAX].filp, 0);
402         check();
403
404         log("\nIncrease min to RP0 (invalid)...\n");
405         writeval_inval(stuff[MIN].filp, origfreqs[RP0]);
406         check();
407
408         log("\nIncrease max to midpoint...\n");
409         writeval(stuff[MAX].filp, fmid);
410         check();
411
412         log("\nIncrease max to RP0...\n");
413         writeval(stuff[MAX].filp, origfreqs[RP0]);
414         check();
415
416         log("\nIncrease max above RP0 (invalid)...\n");
417         writeval_inval(stuff[MAX].filp, origfreqs[RP0] + 1000);
418         check();
419
420         writeval(stuff[MIN].filp, origfreqs[MIN]);
421         writeval(stuff[MAX].filp, origfreqs[MAX]);
422 }
423
424 static void basic_check(void)
425 {
426         int freqs[NUMFREQ];
427
428         read_freqs(freqs);
429         dump(freqs);
430         checkit(freqs);
431 }
432
433 #define IDLE_WAIT_TIMESTEP_MSEC 100
434 #define IDLE_WAIT_TIMEOUT_MSEC 3000
435 static void idle_check(void)
436 {
437         int freqs[NUMFREQ];
438         int wait = 0;
439
440         /* Monitor frequencies until cur settles down to min, which should
441          * happen within the allotted time */
442         do {
443                 read_freqs(freqs);
444                 dump(freqs);
445                 checkit(freqs);
446                 if (freqs[CUR] == freqs[MIN])
447                         break;
448                 usleep(1000 * IDLE_WAIT_TIMESTEP_MSEC);
449                 wait += IDLE_WAIT_TIMESTEP_MSEC;
450         } while (wait < IDLE_WAIT_TIMEOUT_MSEC);
451
452         igt_assert(freqs[CUR] == freqs[MIN]);
453         log("Required %d msec to reach cur=min\n", wait);
454 }
455
456 #define LOADED_WAIT_TIMESTEP_MSEC 100
457 #define LOADED_WAIT_TIMEOUT_MSEC 3000
458 static void loaded_check(void)
459 {
460         int freqs[NUMFREQ];
461         int wait = 0;
462
463         /* Monitor frequencies until cur increases to max, which should
464          * happen within the allotted time */
465         do {
466                 read_freqs(freqs);
467                 dump(freqs);
468                 checkit(freqs);
469                 if (freqs[CUR] == freqs[MAX])
470                         break;
471                 usleep(1000 * LOADED_WAIT_TIMESTEP_MSEC);
472                 wait += LOADED_WAIT_TIMESTEP_MSEC;
473         } while (wait < LOADED_WAIT_TIMEOUT_MSEC);
474
475         igt_assert(freqs[CUR] == freqs[MAX]);
476         log("Required %d msec to reach cur=max\n", wait);
477 }
478
479 #define STABILIZE_WAIT_TIMESTEP_MSEC 100
480 #define STABILIZE_WAIT_TIMEOUT_MSEC 2000
481 static void stabilize_check(int *freqs)
482 {
483         int wait = 0;
484
485         do {
486                 read_freqs(freqs);
487                 dump(freqs);
488                 usleep(1000 * STABILIZE_WAIT_TIMESTEP_MSEC);
489                 wait += STABILIZE_WAIT_TIMESTEP_MSEC;
490         } while (wait < STABILIZE_WAIT_TIMEOUT_MSEC);
491
492         log("Waited %d msec to stabilize cur\n", wait);
493 }
494
495 static void reset(void)
496 {
497         int pre_freqs[NUMFREQ];
498         int post_freqs[NUMFREQ];
499
500         log("Apply low load...\n");
501         load_helper_run(LOW);
502         stabilize_check(pre_freqs);
503
504         log("Stop rings...\n");
505         stop_rings();
506         while (rings_stopped())
507                 usleep(1000 * 100);
508         log("Ring stop cleared\n");
509
510         log("Apply high load...\n");
511         load_helper_set_load(HIGH);
512         loaded_check();
513
514         log("Apply low load...\n");
515         load_helper_set_load(LOW);
516         stabilize_check(post_freqs);
517         matchit(pre_freqs, post_freqs);
518
519         log("Apply high load...\n");
520         load_helper_set_load(HIGH);
521         loaded_check();
522
523         log("Removing load...\n");
524         load_helper_stop();
525         idle_check();
526 }
527
528 static void pm_rps_exit_handler(int sig)
529 {
530         if (origfreqs[MIN] > readval(stuff[MAX].filp)) {
531                 writeval(stuff[MAX].filp, origfreqs[MAX]);
532                 writeval(stuff[MIN].filp, origfreqs[MIN]);
533         } else {
534                 writeval(stuff[MIN].filp, origfreqs[MIN]);
535                 writeval(stuff[MAX].filp, origfreqs[MAX]);
536         }
537
538         load_helper_deinit();
539         close(drm_fd);
540 }
541
542 static int opt_handler(int opt, int opt_index)
543 {
544         switch (opt) {
545         case 'v':
546                 verbose = true;
547                 break;
548         default:
549                 assert(0);
550         }
551
552         return 0;
553 }
554
555 /* Mod of igt_subtest_init that adds our extra options */
556 static void subtest_init(int argc, char **argv)
557 {
558         struct option long_opts[] = {
559                 {"verbose", 0, 0, 'v'}
560         };
561         const char *help_str = "  -v, --verbose";
562         int ret;
563
564         ret = igt_subtest_init_parse_opts(argc, argv, "v", long_opts,
565                                           help_str, opt_handler);
566
567         if (ret < 0)
568                 /* exit with no error for -h/--help */
569                 exit(ret == -1 ? 0 : ret);
570 }
571
572 int main(int argc, char **argv)
573 {
574         subtest_init(argc, argv);
575
576         igt_skip_on_simulation();
577
578         igt_fixture {
579                 const int device = drm_get_card();
580                 struct junk *junk = stuff;
581                 int ret;
582
583                 /* Use drm_open_any to verify device existence */
584                 drm_fd = drm_open_any();
585
586                 do {
587                         int val = -1;
588                         char *path;
589                         ret = asprintf(&path, sysfs_base_path, device, junk->name);
590                         igt_assert(ret != -1);
591                         junk->filp = fopen(path, junk->mode);
592                         igt_require(junk->filp);
593                         setbuf(junk->filp, NULL);
594
595                         val = readval(junk->filp);
596                         igt_assert(val >= 0);
597                         junk++;
598                 } while(junk->name != NULL);
599
600                 read_freqs(origfreqs);
601
602                 igt_install_exit_handler(pm_rps_exit_handler);
603
604                 load_helper_init();
605
606                 igt_debugfs_init(&dfs);
607         }
608
609         igt_subtest("basic-api")
610                 min_max_config(basic_check);
611
612         igt_subtest("min-max-config-idle")
613                 min_max_config(idle_check);
614
615         igt_subtest("min-max-config-loaded") {
616                 load_helper_run(HIGH);
617                 min_max_config(loaded_check);
618                 load_helper_stop();
619         }
620
621         igt_subtest("reset")
622                 reset();
623
624         igt_exit();
625 }