1 // SPDX-License-Identifier: GPL-2.0
3 * KVM dirty page logging test
5 * Copyright (C) 2018, Red Hat, Inc.
8 #define _GNU_SOURCE /* for program_invocation_name */
15 #include <semaphore.h>
16 #include <sys/types.h>
19 #include <linux/bitmap.h>
20 #include <linux/bitops.h>
21 #include <asm/barrier.h>
23 #include "test_util.h"
25 #include "processor.h"
29 /* The memory slot index to track dirty pages */
30 #define TEST_MEM_SLOT_INDEX 1
32 /* Default guest test virtual memory offset */
33 #define DEFAULT_GUEST_TEST_MEM 0xc0000000
35 /* How many pages to dirty for each guest loop */
36 #define TEST_PAGES_PER_LOOP 1024
38 /* How many host loops to run (one KVM_GET_DIRTY_LOG for each loop) */
39 #define TEST_HOST_LOOP_N 32UL
41 /* Interval for each host loop (ms) */
42 #define TEST_HOST_LOOP_INTERVAL 10UL
44 /* Dirty bitmaps are always little endian, so we need to swap on big endian */
45 #if defined(__s390x__)
46 # define BITOP_LE_SWIZZLE ((BITS_PER_LONG-1) & ~0x7)
47 # define test_bit_le(nr, addr) \
48 test_bit((nr) ^ BITOP_LE_SWIZZLE, addr)
49 # define set_bit_le(nr, addr) \
50 set_bit((nr) ^ BITOP_LE_SWIZZLE, addr)
51 # define clear_bit_le(nr, addr) \
52 clear_bit((nr) ^ BITOP_LE_SWIZZLE, addr)
53 # define test_and_set_bit_le(nr, addr) \
54 test_and_set_bit((nr) ^ BITOP_LE_SWIZZLE, addr)
55 # define test_and_clear_bit_le(nr, addr) \
56 test_and_clear_bit((nr) ^ BITOP_LE_SWIZZLE, addr)
58 # define test_bit_le test_bit
59 # define set_bit_le set_bit
60 # define clear_bit_le clear_bit
61 # define test_and_set_bit_le test_and_set_bit
62 # define test_and_clear_bit_le test_and_clear_bit
65 #define TEST_DIRTY_RING_COUNT 65536
67 #define SIG_IPI SIGUSR1
70 * Guest/Host shared variables. Ensure addr_gva2hva() and/or
71 * sync_global_to/from_guest() are used when accessing from
72 * the host. READ/WRITE_ONCE() should also be used with anything
75 static uint64_t host_page_size;
76 static uint64_t guest_page_size;
77 static uint64_t guest_num_pages;
78 static uint64_t random_array[TEST_PAGES_PER_LOOP];
79 static uint64_t iteration;
82 * Guest physical memory offset of the testing memory slot.
83 * This will be set to the topmost valid physical address minus
84 * the test memory size.
86 static uint64_t guest_test_phys_mem;
89 * Guest virtual memory offset of the testing memory slot.
90 * Must not conflict with identity mapped test code.
92 static uint64_t guest_test_virt_mem = DEFAULT_GUEST_TEST_MEM;
95 * Continuously write to the first 8 bytes of a random pages within
96 * the testing memory region.
98 static void guest_code(void)
104 * On s390x, all pages of a 1M segment are initially marked as dirty
105 * when a page of the segment is written to for the very first time.
106 * To compensate this specialty in this test, we need to touch all
107 * pages during the first iteration.
109 for (i = 0; i < guest_num_pages; i++) {
110 addr = guest_test_virt_mem + i * guest_page_size;
111 *(uint64_t *)addr = READ_ONCE(iteration);
115 for (i = 0; i < TEST_PAGES_PER_LOOP; i++) {
116 addr = guest_test_virt_mem;
117 addr += (READ_ONCE(random_array[i]) % guest_num_pages)
119 addr &= ~(host_page_size - 1);
120 *(uint64_t *)addr = READ_ONCE(iteration);
123 /* Tell the host that we need more random numbers */
129 static bool host_quit;
131 /* Points to the test VM memory region on which we track dirty logs */
132 static void *host_test_mem;
133 static uint64_t host_num_pages;
135 /* For statistics only */
136 static uint64_t host_dirty_count;
137 static uint64_t host_clear_count;
138 static uint64_t host_track_next_count;
140 /* Whether dirty ring reset is requested, or finished */
141 static sem_t dirty_ring_vcpu_stop;
142 static sem_t dirty_ring_vcpu_cont;
144 * This is updated by the vcpu thread to tell the host whether it's a
145 * ring-full event. It should only be read until a sem_wait() of
146 * dirty_ring_vcpu_stop and before vcpu continues to run.
148 static bool dirty_ring_vcpu_ring_full;
150 * This is only used for verifying the dirty pages. Dirty ring has a very
151 * tricky case when the ring just got full, kvm will do userspace exit due to
152 * ring full. When that happens, the very last PFN is set but actually the
153 * data is not changed (the guest WRITE is not really applied yet), because
154 * we found that the dirty ring is full, refused to continue the vcpu, and
155 * recorded the dirty gfn with the old contents.
157 * For this specific case, it's safe to skip checking this pfn for this
158 * bit, because it's a redundant bit, and when the write happens later the bit
159 * will be set again. We use this variable to always keep track of the latest
160 * dirty gfn we've collected, so that if a mismatch of data found later in the
161 * verifying process, we let it pass.
163 static uint64_t dirty_ring_last_page;
166 /* Only use KVM_GET_DIRTY_LOG for logging */
167 LOG_MODE_DIRTY_LOG = 0,
169 /* Use both KVM_[GET|CLEAR]_DIRTY_LOG for logging */
170 LOG_MODE_CLEAR_LOG = 1,
172 /* Use dirty ring for logging */
173 LOG_MODE_DIRTY_RING = 2,
177 /* Run all supported modes */
178 LOG_MODE_ALL = LOG_MODE_NUM,
181 /* Mode of logging to test. Default is to run all supported modes */
182 static enum log_mode_t host_log_mode_option = LOG_MODE_ALL;
183 /* Logging mode for current run */
184 static enum log_mode_t host_log_mode;
185 static pthread_t vcpu_thread;
186 static uint32_t test_dirty_ring_count = TEST_DIRTY_RING_COUNT;
188 static void vcpu_kick(void)
190 pthread_kill(vcpu_thread, SIG_IPI);
194 * In our test we do signal tricks, let's use a better version of
195 * sem_wait to avoid signal interrupts
197 static void sem_wait_until(sem_t *sem)
203 while (ret == -1 && errno == EINTR);
206 static bool clear_log_supported(void)
208 return kvm_check_cap(KVM_CAP_MANUAL_DIRTY_LOG_PROTECT2);
211 static void clear_log_create_vm_done(struct kvm_vm *vm)
213 struct kvm_enable_cap cap = {};
216 manual_caps = kvm_check_cap(KVM_CAP_MANUAL_DIRTY_LOG_PROTECT2);
217 TEST_ASSERT(manual_caps, "MANUAL_CAPS is zero!");
218 manual_caps &= (KVM_DIRTY_LOG_MANUAL_PROTECT_ENABLE |
219 KVM_DIRTY_LOG_INITIALLY_SET);
220 cap.cap = KVM_CAP_MANUAL_DIRTY_LOG_PROTECT2;
221 cap.args[0] = manual_caps;
222 vm_enable_cap(vm, &cap);
225 static void dirty_log_collect_dirty_pages(struct kvm_vm *vm, int slot,
226 void *bitmap, uint32_t num_pages)
228 kvm_vm_get_dirty_log(vm, slot, bitmap);
231 static void clear_log_collect_dirty_pages(struct kvm_vm *vm, int slot,
232 void *bitmap, uint32_t num_pages)
234 kvm_vm_get_dirty_log(vm, slot, bitmap);
235 kvm_vm_clear_dirty_log(vm, slot, bitmap, 0, num_pages);
238 static void default_after_vcpu_run(struct kvm_vm *vm, int ret, int err)
240 struct kvm_run *run = vcpu_state(vm, VCPU_ID);
242 TEST_ASSERT(ret == 0 || (ret == -1 && err == EINTR),
243 "vcpu run failed: errno=%d", err);
245 TEST_ASSERT(get_ucall(vm, VCPU_ID, NULL) == UCALL_SYNC,
246 "Invalid guest sync status: exit_reason=%s\n",
247 exit_reason_str(run->exit_reason));
250 static bool dirty_ring_supported(void)
252 return kvm_check_cap(KVM_CAP_DIRTY_LOG_RING);
255 static void dirty_ring_create_vm_done(struct kvm_vm *vm)
258 * Switch to dirty ring mode after VM creation but before any
259 * of the vcpu creation.
261 vm_enable_dirty_ring(vm, test_dirty_ring_count *
262 sizeof(struct kvm_dirty_gfn));
265 static inline bool dirty_gfn_is_dirtied(struct kvm_dirty_gfn *gfn)
267 return gfn->flags == KVM_DIRTY_GFN_F_DIRTY;
270 static inline void dirty_gfn_set_collected(struct kvm_dirty_gfn *gfn)
272 gfn->flags = KVM_DIRTY_GFN_F_RESET;
275 static uint32_t dirty_ring_collect_one(struct kvm_dirty_gfn *dirty_gfns,
276 int slot, void *bitmap,
277 uint32_t num_pages, uint32_t *fetch_index)
279 struct kvm_dirty_gfn *cur;
283 cur = &dirty_gfns[*fetch_index % test_dirty_ring_count];
284 if (!dirty_gfn_is_dirtied(cur))
286 TEST_ASSERT(cur->slot == slot, "Slot number didn't match: "
287 "%u != %u", cur->slot, slot);
288 TEST_ASSERT(cur->offset < num_pages, "Offset overflow: "
289 "0x%llx >= 0x%x", cur->offset, num_pages);
290 //pr_info("fetch 0x%x page %llu\n", *fetch_index, cur->offset);
291 set_bit_le(cur->offset, bitmap);
292 dirty_ring_last_page = cur->offset;
293 dirty_gfn_set_collected(cur);
301 static void dirty_ring_wait_vcpu(void)
303 /* This makes sure that hardware PML cache flushed */
305 sem_wait_until(&dirty_ring_vcpu_stop);
308 static void dirty_ring_continue_vcpu(void)
310 pr_info("Notifying vcpu to continue\n");
311 sem_post(&dirty_ring_vcpu_cont);
314 static void dirty_ring_collect_dirty_pages(struct kvm_vm *vm, int slot,
315 void *bitmap, uint32_t num_pages)
317 /* We only have one vcpu */
318 static uint32_t fetch_index = 0;
319 uint32_t count = 0, cleared;
320 bool continued_vcpu = false;
322 dirty_ring_wait_vcpu();
324 if (!dirty_ring_vcpu_ring_full) {
326 * This is not a ring-full event, it's safe to allow
329 dirty_ring_continue_vcpu();
330 continued_vcpu = true;
333 /* Only have one vcpu */
334 count = dirty_ring_collect_one(vcpu_map_dirty_ring(vm, VCPU_ID),
335 slot, bitmap, num_pages, &fetch_index);
337 cleared = kvm_vm_reset_dirty_ring(vm);
339 /* Cleared pages should be the same as collected */
340 TEST_ASSERT(cleared == count, "Reset dirty pages (%u) mismatch "
341 "with collected (%u)", cleared, count);
343 if (!continued_vcpu) {
344 TEST_ASSERT(dirty_ring_vcpu_ring_full,
345 "Didn't continue vcpu even without ring full");
346 dirty_ring_continue_vcpu();
349 pr_info("Iteration %ld collected %u pages\n", iteration, count);
352 static void dirty_ring_after_vcpu_run(struct kvm_vm *vm, int ret, int err)
354 struct kvm_run *run = vcpu_state(vm, VCPU_ID);
356 /* A ucall-sync or ring-full event is allowed */
357 if (get_ucall(vm, VCPU_ID, NULL) == UCALL_SYNC) {
358 /* We should allow this to continue */
360 } else if (run->exit_reason == KVM_EXIT_DIRTY_RING_FULL ||
361 (ret == -1 && err == EINTR)) {
362 /* Update the flag first before pause */
363 WRITE_ONCE(dirty_ring_vcpu_ring_full,
364 run->exit_reason == KVM_EXIT_DIRTY_RING_FULL);
365 sem_post(&dirty_ring_vcpu_stop);
366 pr_info("vcpu stops because %s...\n",
367 dirty_ring_vcpu_ring_full ?
368 "dirty ring is full" : "vcpu is kicked out");
369 sem_wait_until(&dirty_ring_vcpu_cont);
370 pr_info("vcpu continues now.\n");
372 TEST_ASSERT(false, "Invalid guest sync status: "
374 exit_reason_str(run->exit_reason));
378 static void dirty_ring_before_vcpu_join(void)
380 /* Kick another round of vcpu just to make sure it will quit */
381 sem_post(&dirty_ring_vcpu_cont);
386 /* Return true if this mode is supported, otherwise false */
387 bool (*supported)(void);
388 /* Hook when the vm creation is done (before vcpu creation) */
389 void (*create_vm_done)(struct kvm_vm *vm);
390 /* Hook to collect the dirty pages into the bitmap provided */
391 void (*collect_dirty_pages) (struct kvm_vm *vm, int slot,
392 void *bitmap, uint32_t num_pages);
393 /* Hook to call when after each vcpu run */
394 void (*after_vcpu_run)(struct kvm_vm *vm, int ret, int err);
395 void (*before_vcpu_join) (void);
396 } log_modes[LOG_MODE_NUM] = {
399 .collect_dirty_pages = dirty_log_collect_dirty_pages,
400 .after_vcpu_run = default_after_vcpu_run,
404 .supported = clear_log_supported,
405 .create_vm_done = clear_log_create_vm_done,
406 .collect_dirty_pages = clear_log_collect_dirty_pages,
407 .after_vcpu_run = default_after_vcpu_run,
410 .name = "dirty-ring",
411 .supported = dirty_ring_supported,
412 .create_vm_done = dirty_ring_create_vm_done,
413 .collect_dirty_pages = dirty_ring_collect_dirty_pages,
414 .before_vcpu_join = dirty_ring_before_vcpu_join,
415 .after_vcpu_run = dirty_ring_after_vcpu_run,
420 * We use this bitmap to track some pages that should have its dirty
421 * bit set in the _next_ iteration. For example, if we detected the
422 * page value changed to current iteration but at the same time the
423 * page bit is cleared in the latest bitmap, then the system must
424 * report that write in the next get dirty log call.
426 static unsigned long *host_bmap_track;
428 static void log_modes_dump(void)
433 for (i = 0; i < LOG_MODE_NUM; i++)
434 printf(", %s", log_modes[i].name);
438 static bool log_mode_supported(void)
440 struct log_mode *mode = &log_modes[host_log_mode];
443 return mode->supported();
448 static void log_mode_create_vm_done(struct kvm_vm *vm)
450 struct log_mode *mode = &log_modes[host_log_mode];
452 if (mode->create_vm_done)
453 mode->create_vm_done(vm);
456 static void log_mode_collect_dirty_pages(struct kvm_vm *vm, int slot,
457 void *bitmap, uint32_t num_pages)
459 struct log_mode *mode = &log_modes[host_log_mode];
461 TEST_ASSERT(mode->collect_dirty_pages != NULL,
462 "collect_dirty_pages() is required for any log mode!");
463 mode->collect_dirty_pages(vm, slot, bitmap, num_pages);
466 static void log_mode_after_vcpu_run(struct kvm_vm *vm, int ret, int err)
468 struct log_mode *mode = &log_modes[host_log_mode];
470 if (mode->after_vcpu_run)
471 mode->after_vcpu_run(vm, ret, err);
474 static void log_mode_before_vcpu_join(void)
476 struct log_mode *mode = &log_modes[host_log_mode];
478 if (mode->before_vcpu_join)
479 mode->before_vcpu_join();
482 static void generate_random_array(uint64_t *guest_array, uint64_t size)
486 for (i = 0; i < size; i++)
487 guest_array[i] = random();
490 static void *vcpu_worker(void *data)
493 struct kvm_vm *vm = data;
494 uint64_t *guest_array;
495 uint64_t pages_count = 0;
496 struct kvm_signal_mask *sigmask = alloca(offsetof(struct kvm_signal_mask, sigset)
498 sigset_t *sigset = (sigset_t *) &sigmask->sigset;
500 vcpu_fd = vcpu_get_fd(vm, VCPU_ID);
503 * SIG_IPI is unblocked atomically while in KVM_RUN. It causes the
504 * ioctl to return with -EINTR, but it is still pending and we need
505 * to accept it with the sigwait.
508 pthread_sigmask(0, NULL, sigset);
509 vcpu_ioctl(vm, VCPU_ID, KVM_SET_SIGNAL_MASK, sigmask);
510 sigaddset(sigset, SIG_IPI);
511 pthread_sigmask(SIG_BLOCK, sigset, NULL);
514 sigaddset(sigset, SIG_IPI);
516 guest_array = addr_gva2hva(vm, (vm_vaddr_t)random_array);
518 while (!READ_ONCE(host_quit)) {
519 /* Clear any existing kick signals */
520 generate_random_array(guest_array, TEST_PAGES_PER_LOOP);
521 pages_count += TEST_PAGES_PER_LOOP;
522 /* Let the guest dirty the random pages */
523 ret = ioctl(vcpu_fd, KVM_RUN, NULL);
524 if (ret == -1 && errno == EINTR) {
526 sigwait(sigset, &sig);
527 assert(sig == SIG_IPI);
529 log_mode_after_vcpu_run(vm, ret, errno);
532 pr_info("Dirtied %"PRIu64" pages\n", pages_count);
537 static void vm_dirty_log_verify(enum vm_guest_mode mode, unsigned long *bmap)
539 uint64_t step = vm_num_host_pages(mode, 1);
542 uint64_t min_iter = 0;
544 for (page = 0; page < host_num_pages; page += step) {
545 value_ptr = host_test_mem + page * host_page_size;
547 /* If this is a special page that we were tracking... */
548 if (test_and_clear_bit_le(page, host_bmap_track)) {
549 host_track_next_count++;
550 TEST_ASSERT(test_bit_le(page, bmap),
551 "Page %"PRIu64" should have its dirty bit "
552 "set in this iteration but it is missing",
556 if (test_and_clear_bit_le(page, bmap)) {
562 * If the bit is set, the value written onto
563 * the corresponding page should be either the
564 * previous iteration number or the current one.
566 matched = (*value_ptr == iteration ||
567 *value_ptr == iteration - 1);
569 if (host_log_mode == LOG_MODE_DIRTY_RING && !matched) {
570 if (*value_ptr == iteration - 2 && min_iter <= iteration - 2) {
572 * Short answer: this case is special
573 * only for dirty ring test where the
574 * page is the last page before a kvm
575 * dirty ring full in iteration N-2.
577 * Long answer: Assuming ring size R,
578 * one possible condition is:
583 * write 1 to page 0~(R-1)
587 * write 1 to (R-1)~(2R-2)
590 * collect (R-1)~(2R-2)
593 * (NOTE!!! "1" cached in cpu reg)
594 * write 2 to (2R-1)~(3R-3)
597 * collect (2R-2)~(3R-3)
598 * (here if we read value on page
599 * "2R-2" is 1, while iter=3!!!)
601 * This however can only happen once per iteration.
603 min_iter = iteration - 1;
605 } else if (page == dirty_ring_last_page) {
607 * Please refer to comments in
608 * dirty_ring_last_page.
615 "Set page %"PRIu64" value %"PRIu64
616 " incorrect (iteration=%"PRIu64")",
617 page, *value_ptr, iteration);
621 * If cleared, the value written can be any
622 * value smaller or equals to the iteration
623 * number. Note that the value can be exactly
624 * (iteration-1) if that write can happen
627 * (1) increase loop count to "iteration-1"
628 * (2) write to page P happens (with value
630 * (3) get dirty log for "iteration-1"; we'll
631 * see that page P bit is set (dirtied),
632 * and not set the bit in host_bmap_track
633 * (4) increase loop count to "iteration"
634 * (which is current iteration)
635 * (5) get dirty log for current iteration,
636 * we'll see that page P is cleared, with
637 * value "iteration-1".
639 TEST_ASSERT(*value_ptr <= iteration,
640 "Clear page %"PRIu64" value %"PRIu64
641 " incorrect (iteration=%"PRIu64")",
642 page, *value_ptr, iteration);
643 if (*value_ptr == iteration) {
645 * This page is _just_ modified; it
646 * should report its dirtyness in the
649 set_bit_le(page, host_bmap_track);
655 static struct kvm_vm *create_vm(enum vm_guest_mode mode, uint32_t vcpuid,
656 uint64_t extra_mem_pages, void *guest_code)
659 uint64_t extra_pg_pages = extra_mem_pages / 512 * 2;
661 pr_info("Testing guest mode: %s\n", vm_guest_mode_string(mode));
663 vm = vm_create(mode, DEFAULT_GUEST_PHY_PAGES + extra_pg_pages, O_RDWR);
664 kvm_vm_elf_load(vm, program_invocation_name, 0, 0);
666 vm_create_irqchip(vm);
668 log_mode_create_vm_done(vm);
669 vm_vcpu_add_default(vm, vcpuid, guest_code);
673 #define DIRTY_MEM_BITS 30 /* 1G */
674 #define PAGE_SHIFT_4K 12
676 static void run_test(enum vm_guest_mode mode, unsigned long iterations,
677 unsigned long interval, uint64_t phys_offset)
682 if (!log_mode_supported()) {
683 print_skip("Log mode '%s' not supported",
684 log_modes[host_log_mode].name);
689 * We reserve page table for 2 times of extra dirty mem which
690 * will definitely cover the original (1G+) test range. Here
691 * we do the calculation with 4K page size which is the
692 * smallest so the page number will be enough for all archs
693 * (e.g., 64K page size guest will need even less memory for
696 vm = create_vm(mode, VCPU_ID,
697 2ul << (DIRTY_MEM_BITS - PAGE_SHIFT_4K),
700 guest_page_size = vm_get_page_size(vm);
702 * A little more than 1G of guest page sized pages. Cover the
703 * case where the size is not aligned to 64 pages.
705 guest_num_pages = (1ul << (DIRTY_MEM_BITS -
706 vm_get_page_shift(vm))) + 3;
707 guest_num_pages = vm_adjust_num_guest_pages(mode, guest_num_pages);
709 host_page_size = getpagesize();
710 host_num_pages = vm_num_host_pages(mode, guest_num_pages);
713 guest_test_phys_mem = (vm_get_max_gfn(vm) -
714 guest_num_pages) * guest_page_size;
715 guest_test_phys_mem &= ~(host_page_size - 1);
717 guest_test_phys_mem = phys_offset;
721 /* Align to 1M (segment size) */
722 guest_test_phys_mem &= ~((1 << 20) - 1);
725 pr_info("guest physical test memory offset: 0x%lx\n", guest_test_phys_mem);
727 bmap = bitmap_alloc(host_num_pages);
728 host_bmap_track = bitmap_alloc(host_num_pages);
730 /* Add an extra memory slot for testing dirty logging */
731 vm_userspace_mem_region_add(vm, VM_MEM_SRC_ANONYMOUS,
735 KVM_MEM_LOG_DIRTY_PAGES);
737 /* Do mapping for the dirty track memory slot */
738 virt_map(vm, guest_test_virt_mem, guest_test_phys_mem, guest_num_pages, 0);
740 /* Cache the HVA pointer of the region */
741 host_test_mem = addr_gpa2hva(vm, (vm_paddr_t)guest_test_phys_mem);
744 vcpu_set_cpuid(vm, VCPU_ID, kvm_get_supported_cpuid());
746 ucall_init(vm, NULL);
748 /* Export the shared variables to the guest */
749 sync_global_to_guest(vm, host_page_size);
750 sync_global_to_guest(vm, guest_page_size);
751 sync_global_to_guest(vm, guest_test_virt_mem);
752 sync_global_to_guest(vm, guest_num_pages);
754 /* Start the iterations */
756 sync_global_to_guest(vm, iteration);
758 host_dirty_count = 0;
759 host_clear_count = 0;
760 host_track_next_count = 0;
762 pthread_create(&vcpu_thread, NULL, vcpu_worker, vm);
764 while (iteration < iterations) {
765 /* Give the vcpu thread some time to dirty some pages */
766 usleep(interval * 1000);
767 log_mode_collect_dirty_pages(vm, TEST_MEM_SLOT_INDEX,
768 bmap, host_num_pages);
769 vm_dirty_log_verify(mode, bmap);
771 sync_global_to_guest(vm, iteration);
774 /* Tell the vcpu thread to quit */
776 log_mode_before_vcpu_join();
777 pthread_join(vcpu_thread, NULL);
779 pr_info("Total bits checked: dirty (%"PRIu64"), clear (%"PRIu64"), "
780 "track_next (%"PRIu64")\n", host_dirty_count, host_clear_count,
781 host_track_next_count);
784 free(host_bmap_track);
793 static struct guest_mode guest_modes[NUM_VM_MODES];
795 #define guest_mode_init(mode, supported, enabled) ({ \
796 guest_modes[mode] = (struct guest_mode){ supported, enabled }; \
799 static void help(char *name)
804 printf("usage: %s [-h] [-i iterations] [-I interval] "
805 "[-p offset] [-m mode]\n", name);
807 printf(" -c: specify dirty ring size, in number of entries\n");
808 printf(" (only useful for dirty-ring test; default: %"PRIu32")\n",
809 TEST_DIRTY_RING_COUNT);
810 printf(" -i: specify iteration counts (default: %"PRIu64")\n",
812 printf(" -I: specify interval in ms (default: %"PRIu64" ms)\n",
813 TEST_HOST_LOOP_INTERVAL);
814 printf(" -p: specify guest physical test memory offset\n"
815 " Warning: a low offset can conflict with the loaded test code.\n");
816 printf(" -M: specify the host logging mode "
817 "(default: run all log modes). Supported modes: \n\t");
819 printf(" -m: specify the guest mode ID to test "
820 "(default: test all supported modes)\n"
821 " This option may be used multiple times.\n"
822 " Guest mode IDs:\n");
823 for (i = 0; i < NUM_VM_MODES; ++i) {
824 printf(" %d: %s%s\n", i, vm_guest_mode_string(i),
825 guest_modes[i].supported ? " (supported)" : "");
831 int main(int argc, char *argv[])
833 unsigned long iterations = TEST_HOST_LOOP_N;
834 unsigned long interval = TEST_HOST_LOOP_INTERVAL;
835 bool mode_selected = false;
836 uint64_t phys_offset = 0;
840 sem_init(&dirty_ring_vcpu_stop, 0, 0);
841 sem_init(&dirty_ring_vcpu_cont, 0, 0);
844 guest_mode_init(VM_MODE_PXXV48_4K, true, true);
847 guest_mode_init(VM_MODE_P40V48_4K, true, true);
848 guest_mode_init(VM_MODE_P40V48_64K, true, true);
851 unsigned int limit = kvm_check_cap(KVM_CAP_ARM_VM_IPA_SIZE);
854 guest_mode_init(VM_MODE_P52V48_64K, true, true);
856 guest_mode_init(VM_MODE_P48V48_4K, true, true);
857 guest_mode_init(VM_MODE_P48V48_64K, true, true);
862 guest_mode_init(VM_MODE_P40V48_4K, true, true);
865 while ((opt = getopt(argc, argv, "c:hi:I:p:m:M:")) != -1) {
868 test_dirty_ring_count = strtol(optarg, NULL, 10);
871 iterations = strtol(optarg, NULL, 10);
874 interval = strtol(optarg, NULL, 10);
877 phys_offset = strtoull(optarg, NULL, 0);
880 if (!mode_selected) {
881 for (i = 0; i < NUM_VM_MODES; ++i)
882 guest_modes[i].enabled = false;
883 mode_selected = true;
885 mode = strtoul(optarg, NULL, 10);
886 TEST_ASSERT(mode < NUM_VM_MODES,
887 "Guest mode ID %d too big", mode);
888 guest_modes[mode].enabled = true;
891 if (!strcmp(optarg, "all")) {
892 host_log_mode_option = LOG_MODE_ALL;
895 for (i = 0; i < LOG_MODE_NUM; i++) {
896 if (!strcmp(optarg, log_modes[i].name)) {
897 pr_info("Setting log mode to: '%s'\n",
899 host_log_mode_option = i;
903 if (i == LOG_MODE_NUM) {
904 printf("Log mode '%s' invalid. Please choose "
917 TEST_ASSERT(iterations > 2, "Iterations must be greater than two");
918 TEST_ASSERT(interval > 0, "Interval must be greater than zero");
920 pr_info("Test iterations: %"PRIu64", interval: %"PRIu64" (ms)\n",
921 iterations, interval);
925 for (i = 0; i < NUM_VM_MODES; ++i) {
926 if (!guest_modes[i].enabled)
928 TEST_ASSERT(guest_modes[i].supported,
929 "Guest mode ID %d (%s) not supported.",
930 i, vm_guest_mode_string(i));
931 if (host_log_mode_option == LOG_MODE_ALL) {
932 /* Run each log mode */
933 for (j = 0; j < LOG_MODE_NUM; j++) {
934 pr_info("Testing Log Mode '%s'\n",
937 run_test(i, iterations, interval, phys_offset);
940 host_log_mode = host_log_mode_option;
941 run_test(i, iterations, interval, phys_offset);