1c20dd9e0SHaibo Xu // SPDX-License-Identifier: GPL-2.0-only
2c20dd9e0SHaibo Xu /*
3c20dd9e0SHaibo Xu * arch_timer.c - Tests the arch timer IRQ functionality
4c20dd9e0SHaibo Xu *
5c20dd9e0SHaibo Xu * The guest's main thread configures the timer interrupt and waits
6c20dd9e0SHaibo Xu * for it to fire, with a timeout equal to the timer period.
7c20dd9e0SHaibo Xu * It asserts that the timeout doesn't exceed the timer period plus
8c20dd9e0SHaibo Xu * a user configurable error margin(default to 100us)
9c20dd9e0SHaibo Xu *
10c20dd9e0SHaibo Xu * On the other hand, upon receipt of an interrupt, the guest's interrupt
11c20dd9e0SHaibo Xu * handler validates the interrupt by checking if the architectural state
12c20dd9e0SHaibo Xu * is in compliance with the specifications.
13c20dd9e0SHaibo Xu *
14c20dd9e0SHaibo Xu * The test provides command-line options to configure the timer's
15c20dd9e0SHaibo Xu * period (-p), number of vCPUs (-n), iterations per stage (-i) and timer
16c20dd9e0SHaibo Xu * interrupt arrival error margin (-e). To stress-test the timer stack
17c20dd9e0SHaibo Xu * even more, an option to migrate the vCPUs across pCPUs (-m), at a
18c20dd9e0SHaibo Xu * particular rate, is also provided.
19c20dd9e0SHaibo Xu *
20c20dd9e0SHaibo Xu * Copyright (c) 2021, Google LLC.
21c20dd9e0SHaibo Xu */
22c20dd9e0SHaibo Xu #include <stdlib.h>
23c20dd9e0SHaibo Xu #include <pthread.h>
24c20dd9e0SHaibo Xu #include <linux/sizes.h>
25c20dd9e0SHaibo Xu #include <linux/bitmap.h>
26c20dd9e0SHaibo Xu #include <sys/sysinfo.h>
27c20dd9e0SHaibo Xu
28c20dd9e0SHaibo Xu #include "timer_test.h"
29*2b7deea3SSean Christopherson #include "ucall_common.h"
30c20dd9e0SHaibo Xu
31c20dd9e0SHaibo Xu struct test_args test_args = {
32c20dd9e0SHaibo Xu .nr_vcpus = NR_VCPUS_DEF,
33c20dd9e0SHaibo Xu .nr_iter = NR_TEST_ITERS_DEF,
34c20dd9e0SHaibo Xu .timer_period_ms = TIMER_TEST_PERIOD_MS_DEF,
35c20dd9e0SHaibo Xu .migration_freq_ms = TIMER_TEST_MIGRATION_FREQ_MS,
36c20dd9e0SHaibo Xu .timer_err_margin_us = TIMER_TEST_ERR_MARGIN_US,
37d0b94bcbSHaibo Xu .reserved = 1,
38c20dd9e0SHaibo Xu };
39c20dd9e0SHaibo Xu
40c20dd9e0SHaibo Xu struct kvm_vcpu *vcpus[KVM_MAX_VCPUS];
41c20dd9e0SHaibo Xu struct test_vcpu_shared_data vcpu_shared_data[KVM_MAX_VCPUS];
42c20dd9e0SHaibo Xu
43c20dd9e0SHaibo Xu static pthread_t pt_vcpu_run[KVM_MAX_VCPUS];
44c20dd9e0SHaibo Xu static unsigned long *vcpu_done_map;
45c20dd9e0SHaibo Xu static pthread_mutex_t vcpu_done_map_lock;
46c20dd9e0SHaibo Xu
test_vcpu_run(void * arg)47c20dd9e0SHaibo Xu static void *test_vcpu_run(void *arg)
48c20dd9e0SHaibo Xu {
49c20dd9e0SHaibo Xu unsigned int vcpu_idx = (unsigned long)arg;
50c20dd9e0SHaibo Xu struct ucall uc;
51c20dd9e0SHaibo Xu struct kvm_vcpu *vcpu = vcpus[vcpu_idx];
52c20dd9e0SHaibo Xu struct kvm_vm *vm = vcpu->vm;
53c20dd9e0SHaibo Xu struct test_vcpu_shared_data *shared_data = &vcpu_shared_data[vcpu_idx];
54c20dd9e0SHaibo Xu
55c20dd9e0SHaibo Xu vcpu_run(vcpu);
56c20dd9e0SHaibo Xu
57c20dd9e0SHaibo Xu /* Currently, any exit from guest is an indication of completion */
58c20dd9e0SHaibo Xu pthread_mutex_lock(&vcpu_done_map_lock);
59c20dd9e0SHaibo Xu __set_bit(vcpu_idx, vcpu_done_map);
60c20dd9e0SHaibo Xu pthread_mutex_unlock(&vcpu_done_map_lock);
61c20dd9e0SHaibo Xu
62c20dd9e0SHaibo Xu switch (get_ucall(vcpu, &uc)) {
63c20dd9e0SHaibo Xu case UCALL_SYNC:
64c20dd9e0SHaibo Xu case UCALL_DONE:
65c20dd9e0SHaibo Xu break;
66c20dd9e0SHaibo Xu case UCALL_ABORT:
67c20dd9e0SHaibo Xu sync_global_from_guest(vm, *shared_data);
68c20dd9e0SHaibo Xu fprintf(stderr, "Guest assert failed, vcpu %u; stage; %u; iter: %u\n",
69c20dd9e0SHaibo Xu vcpu_idx, shared_data->guest_stage, shared_data->nr_iter);
70c20dd9e0SHaibo Xu REPORT_GUEST_ASSERT(uc);
71c20dd9e0SHaibo Xu break;
72c20dd9e0SHaibo Xu default:
73c20dd9e0SHaibo Xu TEST_FAIL("Unexpected guest exit");
74c20dd9e0SHaibo Xu }
75c20dd9e0SHaibo Xu
76d0b94bcbSHaibo Xu pr_info("PASS(vCPU-%d).\n", vcpu_idx);
77d0b94bcbSHaibo Xu
78c20dd9e0SHaibo Xu return NULL;
79c20dd9e0SHaibo Xu }
80c20dd9e0SHaibo Xu
test_get_pcpu(void)81c20dd9e0SHaibo Xu static uint32_t test_get_pcpu(void)
82c20dd9e0SHaibo Xu {
83c20dd9e0SHaibo Xu uint32_t pcpu;
84c20dd9e0SHaibo Xu unsigned int nproc_conf;
85c20dd9e0SHaibo Xu cpu_set_t online_cpuset;
86c20dd9e0SHaibo Xu
87c20dd9e0SHaibo Xu nproc_conf = get_nprocs_conf();
88c20dd9e0SHaibo Xu sched_getaffinity(0, sizeof(cpu_set_t), &online_cpuset);
89c20dd9e0SHaibo Xu
90c20dd9e0SHaibo Xu /* Randomly find an available pCPU to place a vCPU on */
91c20dd9e0SHaibo Xu do {
92c20dd9e0SHaibo Xu pcpu = rand() % nproc_conf;
93c20dd9e0SHaibo Xu } while (!CPU_ISSET(pcpu, &online_cpuset));
94c20dd9e0SHaibo Xu
95c20dd9e0SHaibo Xu return pcpu;
96c20dd9e0SHaibo Xu }
97c20dd9e0SHaibo Xu
test_migrate_vcpu(unsigned int vcpu_idx)98c20dd9e0SHaibo Xu static int test_migrate_vcpu(unsigned int vcpu_idx)
99c20dd9e0SHaibo Xu {
100c20dd9e0SHaibo Xu int ret;
101c20dd9e0SHaibo Xu cpu_set_t cpuset;
102c20dd9e0SHaibo Xu uint32_t new_pcpu = test_get_pcpu();
103c20dd9e0SHaibo Xu
104c20dd9e0SHaibo Xu CPU_ZERO(&cpuset);
105c20dd9e0SHaibo Xu CPU_SET(new_pcpu, &cpuset);
106c20dd9e0SHaibo Xu
107c20dd9e0SHaibo Xu pr_debug("Migrating vCPU: %u to pCPU: %u\n", vcpu_idx, new_pcpu);
108c20dd9e0SHaibo Xu
109c20dd9e0SHaibo Xu ret = pthread_setaffinity_np(pt_vcpu_run[vcpu_idx],
110c20dd9e0SHaibo Xu sizeof(cpuset), &cpuset);
111c20dd9e0SHaibo Xu
112c20dd9e0SHaibo Xu /* Allow the error where the vCPU thread is already finished */
113c20dd9e0SHaibo Xu TEST_ASSERT(ret == 0 || ret == ESRCH,
114c20dd9e0SHaibo Xu "Failed to migrate the vCPU:%u to pCPU: %u; ret: %d",
115c20dd9e0SHaibo Xu vcpu_idx, new_pcpu, ret);
116c20dd9e0SHaibo Xu
117c20dd9e0SHaibo Xu return ret;
118c20dd9e0SHaibo Xu }
119c20dd9e0SHaibo Xu
test_vcpu_migration(void * arg)120c20dd9e0SHaibo Xu static void *test_vcpu_migration(void *arg)
121c20dd9e0SHaibo Xu {
122c20dd9e0SHaibo Xu unsigned int i, n_done;
123c20dd9e0SHaibo Xu bool vcpu_done;
124c20dd9e0SHaibo Xu
125c20dd9e0SHaibo Xu do {
126c20dd9e0SHaibo Xu usleep(msecs_to_usecs(test_args.migration_freq_ms));
127c20dd9e0SHaibo Xu
128c20dd9e0SHaibo Xu for (n_done = 0, i = 0; i < test_args.nr_vcpus; i++) {
129c20dd9e0SHaibo Xu pthread_mutex_lock(&vcpu_done_map_lock);
130c20dd9e0SHaibo Xu vcpu_done = test_bit(i, vcpu_done_map);
131c20dd9e0SHaibo Xu pthread_mutex_unlock(&vcpu_done_map_lock);
132c20dd9e0SHaibo Xu
133c20dd9e0SHaibo Xu if (vcpu_done) {
134c20dd9e0SHaibo Xu n_done++;
135c20dd9e0SHaibo Xu continue;
136c20dd9e0SHaibo Xu }
137c20dd9e0SHaibo Xu
138c20dd9e0SHaibo Xu test_migrate_vcpu(i);
139c20dd9e0SHaibo Xu }
140c20dd9e0SHaibo Xu } while (test_args.nr_vcpus != n_done);
141c20dd9e0SHaibo Xu
142c20dd9e0SHaibo Xu return NULL;
143c20dd9e0SHaibo Xu }
144c20dd9e0SHaibo Xu
test_run(struct kvm_vm * vm)145c20dd9e0SHaibo Xu static void test_run(struct kvm_vm *vm)
146c20dd9e0SHaibo Xu {
147c20dd9e0SHaibo Xu pthread_t pt_vcpu_migration;
148c20dd9e0SHaibo Xu unsigned int i;
149c20dd9e0SHaibo Xu int ret;
150c20dd9e0SHaibo Xu
151c20dd9e0SHaibo Xu pthread_mutex_init(&vcpu_done_map_lock, NULL);
152c20dd9e0SHaibo Xu vcpu_done_map = bitmap_zalloc(test_args.nr_vcpus);
153c20dd9e0SHaibo Xu TEST_ASSERT(vcpu_done_map, "Failed to allocate vcpu done bitmap");
154c20dd9e0SHaibo Xu
155c20dd9e0SHaibo Xu for (i = 0; i < (unsigned long)test_args.nr_vcpus; i++) {
156c20dd9e0SHaibo Xu ret = pthread_create(&pt_vcpu_run[i], NULL, test_vcpu_run,
157c20dd9e0SHaibo Xu (void *)(unsigned long)i);
158c20dd9e0SHaibo Xu TEST_ASSERT(!ret, "Failed to create vCPU-%d pthread", i);
159c20dd9e0SHaibo Xu }
160c20dd9e0SHaibo Xu
161c20dd9e0SHaibo Xu /* Spawn a thread to control the vCPU migrations */
162c20dd9e0SHaibo Xu if (test_args.migration_freq_ms) {
163c20dd9e0SHaibo Xu srand(time(NULL));
164c20dd9e0SHaibo Xu
165c20dd9e0SHaibo Xu ret = pthread_create(&pt_vcpu_migration, NULL,
166c20dd9e0SHaibo Xu test_vcpu_migration, NULL);
167c20dd9e0SHaibo Xu TEST_ASSERT(!ret, "Failed to create the migration pthread");
168c20dd9e0SHaibo Xu }
169c20dd9e0SHaibo Xu
170c20dd9e0SHaibo Xu
171c20dd9e0SHaibo Xu for (i = 0; i < test_args.nr_vcpus; i++)
172c20dd9e0SHaibo Xu pthread_join(pt_vcpu_run[i], NULL);
173c20dd9e0SHaibo Xu
174c20dd9e0SHaibo Xu if (test_args.migration_freq_ms)
175c20dd9e0SHaibo Xu pthread_join(pt_vcpu_migration, NULL);
176c20dd9e0SHaibo Xu
177c20dd9e0SHaibo Xu bitmap_free(vcpu_done_map);
178c20dd9e0SHaibo Xu }
179c20dd9e0SHaibo Xu
test_print_help(char * name)180c20dd9e0SHaibo Xu static void test_print_help(char *name)
181c20dd9e0SHaibo Xu {
182c20dd9e0SHaibo Xu pr_info("Usage: %s [-h] [-n nr_vcpus] [-i iterations] [-p timer_period_ms]\n"
183c20dd9e0SHaibo Xu "\t\t [-m migration_freq_ms] [-o counter_offset]\n"
184c20dd9e0SHaibo Xu "\t\t [-e timer_err_margin_us]\n", name);
185c20dd9e0SHaibo Xu pr_info("\t-n: Number of vCPUs to configure (default: %u; max: %u)\n",
186c20dd9e0SHaibo Xu NR_VCPUS_DEF, KVM_MAX_VCPUS);
187c20dd9e0SHaibo Xu pr_info("\t-i: Number of iterations per stage (default: %u)\n",
188c20dd9e0SHaibo Xu NR_TEST_ITERS_DEF);
189c20dd9e0SHaibo Xu pr_info("\t-p: Periodicity (in ms) of the guest timer (default: %u)\n",
190c20dd9e0SHaibo Xu TIMER_TEST_PERIOD_MS_DEF);
191c20dd9e0SHaibo Xu pr_info("\t-m: Frequency (in ms) of vCPUs to migrate to different pCPU. 0 to turn off (default: %u)\n",
192c20dd9e0SHaibo Xu TIMER_TEST_MIGRATION_FREQ_MS);
193d0b94bcbSHaibo Xu pr_info("\t-o: Counter offset (in counter cycles, default: 0) [aarch64-only]\n");
194c20dd9e0SHaibo Xu pr_info("\t-e: Interrupt arrival error margin (in us) of the guest timer (default: %u)\n",
195c20dd9e0SHaibo Xu TIMER_TEST_ERR_MARGIN_US);
196c20dd9e0SHaibo Xu pr_info("\t-h: print this help screen\n");
197c20dd9e0SHaibo Xu }
198c20dd9e0SHaibo Xu
parse_args(int argc,char * argv[])199c20dd9e0SHaibo Xu static bool parse_args(int argc, char *argv[])
200c20dd9e0SHaibo Xu {
201c20dd9e0SHaibo Xu int opt;
202c20dd9e0SHaibo Xu
203c20dd9e0SHaibo Xu while ((opt = getopt(argc, argv, "hn:i:p:m:o:e:")) != -1) {
204c20dd9e0SHaibo Xu switch (opt) {
205c20dd9e0SHaibo Xu case 'n':
206c20dd9e0SHaibo Xu test_args.nr_vcpus = atoi_positive("Number of vCPUs", optarg);
207c20dd9e0SHaibo Xu if (test_args.nr_vcpus > KVM_MAX_VCPUS) {
208c20dd9e0SHaibo Xu pr_info("Max allowed vCPUs: %u\n",
209c20dd9e0SHaibo Xu KVM_MAX_VCPUS);
210c20dd9e0SHaibo Xu goto err;
211c20dd9e0SHaibo Xu }
212c20dd9e0SHaibo Xu break;
213c20dd9e0SHaibo Xu case 'i':
214c20dd9e0SHaibo Xu test_args.nr_iter = atoi_positive("Number of iterations", optarg);
215c20dd9e0SHaibo Xu break;
216c20dd9e0SHaibo Xu case 'p':
217c20dd9e0SHaibo Xu test_args.timer_period_ms = atoi_positive("Periodicity", optarg);
218c20dd9e0SHaibo Xu break;
219c20dd9e0SHaibo Xu case 'm':
220c20dd9e0SHaibo Xu test_args.migration_freq_ms = atoi_non_negative("Frequency", optarg);
221c20dd9e0SHaibo Xu break;
222c20dd9e0SHaibo Xu case 'e':
223c20dd9e0SHaibo Xu test_args.timer_err_margin_us = atoi_non_negative("Error Margin", optarg);
224c20dd9e0SHaibo Xu break;
225c20dd9e0SHaibo Xu case 'o':
226d0b94bcbSHaibo Xu test_args.counter_offset = strtol(optarg, NULL, 0);
227d0b94bcbSHaibo Xu test_args.reserved = 0;
228c20dd9e0SHaibo Xu break;
229c20dd9e0SHaibo Xu case 'h':
230c20dd9e0SHaibo Xu default:
231c20dd9e0SHaibo Xu goto err;
232c20dd9e0SHaibo Xu }
233c20dd9e0SHaibo Xu }
234c20dd9e0SHaibo Xu
235c20dd9e0SHaibo Xu return true;
236c20dd9e0SHaibo Xu
237c20dd9e0SHaibo Xu err:
238c20dd9e0SHaibo Xu test_print_help(argv[0]);
239c20dd9e0SHaibo Xu return false;
240c20dd9e0SHaibo Xu }
241c20dd9e0SHaibo Xu
main(int argc,char * argv[])242c20dd9e0SHaibo Xu int main(int argc, char *argv[])
243c20dd9e0SHaibo Xu {
244c20dd9e0SHaibo Xu struct kvm_vm *vm;
245c20dd9e0SHaibo Xu
246c20dd9e0SHaibo Xu if (!parse_args(argc, argv))
247c20dd9e0SHaibo Xu exit(KSFT_SKIP);
248c20dd9e0SHaibo Xu
249c20dd9e0SHaibo Xu __TEST_REQUIRE(!test_args.migration_freq_ms || get_nprocs() >= 2,
250c20dd9e0SHaibo Xu "At least two physical CPUs needed for vCPU migration");
251c20dd9e0SHaibo Xu
252c20dd9e0SHaibo Xu vm = test_vm_create();
253c20dd9e0SHaibo Xu test_run(vm);
254c20dd9e0SHaibo Xu test_vm_cleanup(vm);
255c20dd9e0SHaibo Xu
256c20dd9e0SHaibo Xu return 0;
257c20dd9e0SHaibo Xu }
258