tests/pm_rps: ducttape for igt fork helper cleanup issues
[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(freqs[MIN] <= freqs[MAX]);
114         igt_assert(freqs[CUR] <= freqs[MAX]);
115         igt_assert(freqs[MIN] <= freqs[CUR]);
116         igt_assert(freqs[RPn] <= freqs[MIN]);
117         igt_assert(freqs[MAX] <= freqs[RP0]);
118         igt_assert(freqs[RP1] <= freqs[RP0]);
119         igt_assert(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(freqs1[CUR] == freqs2[CUR]);
127         igt_assert(freqs1[MIN] == freqs2[MIN]);
128         igt_assert(freqs1[MAX] == freqs2[MAX]);
129         igt_assert(freqs1[RP0] == freqs2[RP0]);
130         igt_assert(freqs1[RP1] == freqs2[RP1]);
131         igt_assert(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         bool ready;
157         enum load load;
158         bool exit;
159         struct igt_helper_process igt_proc;
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 static void load_helper_set_load(enum load load)
200 {
201         assert(lh.igt_proc.running);
202
203         if (lh.load == load)
204                 return;
205
206         lh.load = load;
207         kill(lh.igt_proc.pid, SIGUSR2);
208 }
209
210 static void load_helper_run(enum load load)
211 {
212         /*
213          * FIXME fork helpers won't get cleaned up when started from within a
214          * subtest, so handle the case where it sticks around a bit too long.
215          */
216         if (lh.igt_proc.running) {
217                 load_helper_set_load(load);
218                 return;
219         }
220
221         igt_require(lh.ready == true);
222
223         lh.load = load;
224
225         igt_fork_helper(&lh.igt_proc) {
226                 uint32_t val = 0;
227
228                 signal(SIGUSR1, load_helper_signal_handler);
229                 signal(SIGUSR2, load_helper_signal_handler);
230
231                 while (!lh.exit) {
232                         emit_store_dword_imm(val);
233                         intel_batchbuffer_flush_on_ring(lh.batch, 0);
234                         val++;
235
236                         /* Lower the load by pausing after every submitted
237                          * write. */
238                         if (lh.load == LOW)
239                                 usleep(LOAD_HELPER_PAUSE_USEC);
240                 }
241
242                 /* Map buffer to stall for write completion */
243                 drm_intel_bo_map(lh.target_buffer, 0);
244                 drm_intel_bo_unmap(lh.target_buffer);
245
246                 igt_debug("load helper sent %u dword writes\n", val);
247         }
248 }
249
250 static void load_helper_stop(void)
251 {
252         kill(lh.igt_proc.pid, SIGUSR1);
253         igt_wait_helper(&lh.igt_proc);
254 }
255
256 /* The load helper resource is used by only some subtests. We attempt to
257  * initialize in igt_fixture but do our igt_require check only if a
258  * subtest attempts to run it */
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. */
266         if (intel_gen(lh.devid) < 6) {
267                 igt_debug("load helper init failed: pre-gen6 not supported\n");
268                 return;
269         }
270
271         lh.bufmgr = drm_intel_bufmgr_gem_init(drm_fd, 4096);
272         if (!lh.bufmgr) {
273                 igt_debug("load helper init failed: buffer manager init\n");
274                 return;
275         }
276         drm_intel_bufmgr_gem_enable_reuse(lh.bufmgr);
277
278         lh.batch = intel_batchbuffer_alloc(lh.bufmgr, lh.devid);
279         if (!lh.batch) {
280                 igt_debug("load helper init failed: batch buffer alloc\n");
281                 return;
282         }
283
284         lh.target_buffer = drm_intel_bo_alloc(lh.bufmgr, "target bo",
285                                               4096, 4096);
286         if (!lh.target_buffer) {
287                 igt_debug("load helper init failed: target buffer alloc\n");
288                 return;
289         }
290
291         lh.ready = true;
292 }
293
294 static void load_helper_deinit(void)
295 {
296         if (lh.igt_proc.running)
297                 load_helper_stop();
298
299         if (lh.target_buffer)
300                 drm_intel_bo_unreference(lh.target_buffer);
301
302         if (lh.batch)
303                 intel_batchbuffer_free(lh.batch);
304
305         if (lh.bufmgr)
306                 drm_intel_bufmgr_destroy(lh.bufmgr);
307 }
308
309 static void stop_rings(void)
310 {
311         int fd;
312         static const char data[] = "0xf";
313
314         fd = igt_debugfs_open(&dfs, "i915_ring_stop", O_WRONLY);
315         igt_assert(fd >= 0);
316
317         igt_debug("injecting ring stop\n");
318         igt_assert(write(fd, data, sizeof(data)) == sizeof(data));
319
320         close(fd);
321 }
322
323 static bool rings_stopped(void)
324 {
325         int fd;
326         static char buf[128];
327         unsigned long long val;
328
329         fd = igt_debugfs_open(&dfs, "i915_ring_stop", O_RDONLY);
330         igt_assert(fd >= 0);
331
332         igt_assert(read(fd, buf, sizeof(buf)) > 0);
333         close(fd);
334
335         sscanf(buf, "%llx", &val);
336
337         return (bool)val;
338 }
339
340 static void min_max_config(void (*check)(void))
341 {
342         int fmid = (origfreqs[RPn] + origfreqs[RP0]) / 2;
343
344         /* hw (and so kernel) currently rounds to 50 MHz ... */
345         fmid = fmid / 50 * 50;
346
347         igt_debug("\nCheck original min and max...\n");
348         check();
349
350         igt_debug("\nSet min=RPn and max=RP0...\n");
351         writeval(stuff[MIN].filp, origfreqs[RPn]);
352         writeval(stuff[MAX].filp, origfreqs[RP0]);
353         check();
354
355         igt_debug("\nIncrease min to midpoint...\n");
356         writeval(stuff[MIN].filp, fmid);
357         check();
358
359         igt_debug("\nIncrease min to RP0...\n");
360         writeval(stuff[MIN].filp, origfreqs[RP0]);
361         check();
362
363         igt_debug("\nIncrease min above RP0 (invalid)...\n");
364         writeval_inval(stuff[MIN].filp, origfreqs[RP0] + 1000);
365         check();
366
367         igt_debug("\nDecrease max to RPn (invalid)...\n");
368         writeval_inval(stuff[MAX].filp, origfreqs[RPn]);
369         check();
370
371         igt_debug("\nDecrease min to midpoint...\n");
372         writeval(stuff[MIN].filp, fmid);
373         check();
374
375         igt_debug("\nDecrease min to RPn...\n");
376         writeval(stuff[MIN].filp, origfreqs[RPn]);
377         check();
378
379         igt_debug("\nDecrease min below RPn (invalid)...\n");
380         writeval_inval(stuff[MIN].filp, 0);
381         check();
382
383         igt_debug("\nDecrease max to midpoint...\n");
384         writeval(stuff[MAX].filp, fmid);
385         check();
386
387         igt_debug("\nDecrease max to RPn...\n");
388         writeval(stuff[MAX].filp, origfreqs[RPn]);
389         check();
390
391         igt_debug("\nDecrease max below RPn (invalid)...\n");
392         writeval_inval(stuff[MAX].filp, 0);
393         check();
394
395         igt_debug("\nIncrease min to RP0 (invalid)...\n");
396         writeval_inval(stuff[MIN].filp, origfreqs[RP0]);
397         check();
398
399         igt_debug("\nIncrease max to midpoint...\n");
400         writeval(stuff[MAX].filp, fmid);
401         check();
402
403         igt_debug("\nIncrease max to RP0...\n");
404         writeval(stuff[MAX].filp, origfreqs[RP0]);
405         check();
406
407         igt_debug("\nIncrease max above RP0 (invalid)...\n");
408         writeval_inval(stuff[MAX].filp, origfreqs[RP0] + 1000);
409         check();
410
411         writeval(stuff[MIN].filp, origfreqs[MIN]);
412         writeval(stuff[MAX].filp, origfreqs[MAX]);
413 }
414
415 static void basic_check(void)
416 {
417         int freqs[NUMFREQ];
418
419         read_freqs(freqs);
420         dump(freqs);
421         checkit(freqs);
422 }
423
424 #define IDLE_WAIT_TIMESTEP_MSEC 100
425 #define IDLE_WAIT_TIMEOUT_MSEC 3000
426 static void idle_check(void)
427 {
428         int freqs[NUMFREQ];
429         int wait = 0;
430
431         /* Monitor frequencies until cur settles down to min, which should
432          * happen within the allotted time */
433         do {
434                 read_freqs(freqs);
435                 dump(freqs);
436                 checkit(freqs);
437                 if (freqs[CUR] == freqs[MIN])
438                         break;
439                 usleep(1000 * IDLE_WAIT_TIMESTEP_MSEC);
440                 wait += IDLE_WAIT_TIMESTEP_MSEC;
441         } while (wait < IDLE_WAIT_TIMEOUT_MSEC);
442
443         igt_assert(freqs[CUR] == freqs[MIN]);
444         igt_debug("Required %d msec to reach cur=min\n", wait);
445 }
446
447 #define LOADED_WAIT_TIMESTEP_MSEC 100
448 #define LOADED_WAIT_TIMEOUT_MSEC 3000
449 static void loaded_check(void)
450 {
451         int freqs[NUMFREQ];
452         int wait = 0;
453
454         /* Monitor frequencies until cur increases to max, which should
455          * happen within the allotted time */
456         do {
457                 read_freqs(freqs);
458                 dump(freqs);
459                 checkit(freqs);
460                 if (freqs[CUR] == freqs[MAX])
461                         break;
462                 usleep(1000 * LOADED_WAIT_TIMESTEP_MSEC);
463                 wait += LOADED_WAIT_TIMESTEP_MSEC;
464         } while (wait < LOADED_WAIT_TIMEOUT_MSEC);
465
466         igt_assert(freqs[CUR] == freqs[MAX]);
467         igt_debug("Required %d msec to reach cur=max\n", wait);
468 }
469
470 #define STABILIZE_WAIT_TIMESTEP_MSEC 100
471 #define STABILIZE_WAIT_TIMEOUT_MSEC 2000
472 static void stabilize_check(int *freqs)
473 {
474         int wait = 0;
475
476         do {
477                 read_freqs(freqs);
478                 dump(freqs);
479                 usleep(1000 * STABILIZE_WAIT_TIMESTEP_MSEC);
480                 wait += STABILIZE_WAIT_TIMESTEP_MSEC;
481         } while (wait < STABILIZE_WAIT_TIMEOUT_MSEC);
482
483         igt_debug("Waited %d msec to stabilize cur\n", wait);
484 }
485
486 static void reset(void)
487 {
488         int pre_freqs[NUMFREQ];
489         int post_freqs[NUMFREQ];
490
491         igt_debug("Apply low load...\n");
492         load_helper_run(LOW);
493         stabilize_check(pre_freqs);
494
495         igt_debug("Stop rings...\n");
496         stop_rings();
497         while (rings_stopped())
498                 usleep(1000 * 100);
499         igt_debug("Ring stop cleared\n");
500
501         igt_debug("Apply high load...\n");
502         load_helper_set_load(HIGH);
503         loaded_check();
504
505         igt_debug("Apply low load...\n");
506         load_helper_set_load(LOW);
507         stabilize_check(post_freqs);
508         matchit(pre_freqs, post_freqs);
509
510         igt_debug("Apply high load...\n");
511         load_helper_set_load(HIGH);
512         loaded_check();
513
514         igt_debug("Removing load...\n");
515         load_helper_stop();
516         idle_check();
517 }
518
519 static void pm_rps_exit_handler(int sig)
520 {
521         if (origfreqs[MIN] > readval(stuff[MAX].filp)) {
522                 writeval(stuff[MAX].filp, origfreqs[MAX]);
523                 writeval(stuff[MIN].filp, origfreqs[MIN]);
524         } else {
525                 writeval(stuff[MIN].filp, origfreqs[MIN]);
526                 writeval(stuff[MAX].filp, origfreqs[MAX]);
527         }
528
529         load_helper_deinit();
530         close(drm_fd);
531 }
532
533 igt_main
534 {
535         igt_skip_on_simulation();
536
537         igt_fixture {
538                 const int device = drm_get_card();
539                 struct junk *junk = stuff;
540                 int ret;
541
542                 /* Use drm_open_any to verify device existence */
543                 drm_fd = drm_open_any();
544
545                 do {
546                         int val = -1;
547                         char *path;
548                         ret = asprintf(&path, sysfs_base_path, device, junk->name);
549                         igt_assert(ret != -1);
550                         junk->filp = fopen(path, junk->mode);
551                         igt_require(junk->filp);
552                         setbuf(junk->filp, NULL);
553
554                         val = readval(junk->filp);
555                         igt_assert(val >= 0);
556                         junk++;
557                 } while(junk->name != NULL);
558
559                 read_freqs(origfreqs);
560
561                 igt_install_exit_handler(pm_rps_exit_handler);
562
563                 load_helper_init();
564
565                 igt_debugfs_init(&dfs);
566         }
567
568         igt_subtest("basic-api")
569                 min_max_config(basic_check);
570
571         igt_subtest("min-max-config-idle")
572                 min_max_config(idle_check);
573
574         igt_subtest("min-max-config-loaded") {
575                 load_helper_run(HIGH);
576                 min_max_config(loaded_check);
577                 load_helper_stop();
578         }
579
580         igt_subtest("reset")
581                 reset();
582 }