Merge tag 'for-linus' of git://git.kernel.org/pub/scm/virt/kvm/kvm
[cascardo/linux.git] / virt / kvm / arm / vgic / vgic-init.c
1 /*
2  * Copyright (C) 2015, 2016 ARM Ltd.
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License version 2 as
6  * published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
15  */
16
17 #include <linux/uaccess.h>
18 #include <linux/interrupt.h>
19 #include <linux/cpu.h>
20 #include <linux/kvm_host.h>
21 #include <kvm/arm_vgic.h>
22 #include <asm/kvm_mmu.h>
23 #include "vgic.h"
24
25 /*
26  * Initialization rules: there are multiple stages to the vgic
27  * initialization, both for the distributor and the CPU interfaces.
28  *
29  * Distributor:
30  *
31  * - kvm_vgic_early_init(): initialization of static data that doesn't
32  *   depend on any sizing information or emulation type. No allocation
33  *   is allowed there.
34  *
35  * - vgic_init(): allocation and initialization of the generic data
36  *   structures that depend on sizing information (number of CPUs,
37  *   number of interrupts). Also initializes the vcpu specific data
38  *   structures. Can be executed lazily for GICv2.
39  *
40  * CPU Interface:
41  *
42  * - kvm_vgic_cpu_early_init(): initialization of static data that
43  *   doesn't depend on any sizing information or emulation type. No
44  *   allocation is allowed there.
45  */
46
47 /* EARLY INIT */
48
49 /*
50  * Those 2 functions should not be needed anymore but they
51  * still are called from arm.c
52  */
53 void kvm_vgic_early_init(struct kvm *kvm)
54 {
55 }
56
57 void kvm_vgic_vcpu_early_init(struct kvm_vcpu *vcpu)
58 {
59 }
60
61 /* CREATION */
62
63 /**
64  * kvm_vgic_create: triggered by the instantiation of the VGIC device by
65  * user space, either through the legacy KVM_CREATE_IRQCHIP ioctl (v2 only)
66  * or through the generic KVM_CREATE_DEVICE API ioctl.
67  * irqchip_in_kernel() tells you if this function succeeded or not.
68  * @kvm: kvm struct pointer
69  * @type: KVM_DEV_TYPE_ARM_VGIC_V[23]
70  */
71 int kvm_vgic_create(struct kvm *kvm, u32 type)
72 {
73         int i, vcpu_lock_idx = -1, ret;
74         struct kvm_vcpu *vcpu;
75
76         mutex_lock(&kvm->lock);
77
78         if (irqchip_in_kernel(kvm)) {
79                 ret = -EEXIST;
80                 goto out;
81         }
82
83         /*
84          * This function is also called by the KVM_CREATE_IRQCHIP handler,
85          * which had no chance yet to check the availability of the GICv2
86          * emulation. So check this here again. KVM_CREATE_DEVICE does
87          * the proper checks already.
88          */
89         if (type == KVM_DEV_TYPE_ARM_VGIC_V2 &&
90                 !kvm_vgic_global_state.can_emulate_gicv2) {
91                 ret = -ENODEV;
92                 goto out;
93         }
94
95         /*
96          * Any time a vcpu is run, vcpu_load is called which tries to grab the
97          * vcpu->mutex.  By grabbing the vcpu->mutex of all VCPUs we ensure
98          * that no other VCPUs are run while we create the vgic.
99          */
100         ret = -EBUSY;
101         kvm_for_each_vcpu(i, vcpu, kvm) {
102                 if (!mutex_trylock(&vcpu->mutex))
103                         goto out_unlock;
104                 vcpu_lock_idx = i;
105         }
106
107         kvm_for_each_vcpu(i, vcpu, kvm) {
108                 if (vcpu->arch.has_run_once)
109                         goto out_unlock;
110         }
111         ret = 0;
112
113         if (type == KVM_DEV_TYPE_ARM_VGIC_V2)
114                 kvm->arch.max_vcpus = VGIC_V2_MAX_CPUS;
115         else
116                 kvm->arch.max_vcpus = VGIC_V3_MAX_CPUS;
117
118         if (atomic_read(&kvm->online_vcpus) > kvm->arch.max_vcpus) {
119                 ret = -E2BIG;
120                 goto out_unlock;
121         }
122
123         kvm->arch.vgic.in_kernel = true;
124         kvm->arch.vgic.vgic_model = type;
125
126         /*
127          * kvm_vgic_global_state.vctrl_base is set on vgic probe (kvm_arch_init)
128          * it is stored in distributor struct for asm save/restore purpose
129          */
130         kvm->arch.vgic.vctrl_base = kvm_vgic_global_state.vctrl_base;
131
132         kvm->arch.vgic.vgic_dist_base = VGIC_ADDR_UNDEF;
133         kvm->arch.vgic.vgic_cpu_base = VGIC_ADDR_UNDEF;
134         kvm->arch.vgic.vgic_redist_base = VGIC_ADDR_UNDEF;
135
136 out_unlock:
137         for (; vcpu_lock_idx >= 0; vcpu_lock_idx--) {
138                 vcpu = kvm_get_vcpu(kvm, vcpu_lock_idx);
139                 mutex_unlock(&vcpu->mutex);
140         }
141
142 out:
143         mutex_unlock(&kvm->lock);
144         return ret;
145 }
146
147 /* INIT/DESTROY */
148
149 /**
150  * kvm_vgic_dist_init: initialize the dist data structures
151  * @kvm: kvm struct pointer
152  * @nr_spis: number of spis, frozen by caller
153  */
154 static int kvm_vgic_dist_init(struct kvm *kvm, unsigned int nr_spis)
155 {
156         struct vgic_dist *dist = &kvm->arch.vgic;
157         struct kvm_vcpu *vcpu0 = kvm_get_vcpu(kvm, 0);
158         int i;
159
160         INIT_LIST_HEAD(&dist->lpi_list_head);
161         spin_lock_init(&dist->lpi_list_lock);
162
163         dist->spis = kcalloc(nr_spis, sizeof(struct vgic_irq), GFP_KERNEL);
164         if (!dist->spis)
165                 return  -ENOMEM;
166
167         /*
168          * In the following code we do not take the irq struct lock since
169          * no other action on irq structs can happen while the VGIC is
170          * not initialized yet:
171          * If someone wants to inject an interrupt or does a MMIO access, we
172          * require prior initialization in case of a virtual GICv3 or trigger
173          * initialization when using a virtual GICv2.
174          */
175         for (i = 0; i < nr_spis; i++) {
176                 struct vgic_irq *irq = &dist->spis[i];
177
178                 irq->intid = i + VGIC_NR_PRIVATE_IRQS;
179                 INIT_LIST_HEAD(&irq->ap_list);
180                 spin_lock_init(&irq->irq_lock);
181                 irq->vcpu = NULL;
182                 irq->target_vcpu = vcpu0;
183                 kref_init(&irq->refcount);
184                 if (dist->vgic_model == KVM_DEV_TYPE_ARM_VGIC_V2)
185                         irq->targets = 0;
186                 else
187                         irq->mpidr = 0;
188         }
189         return 0;
190 }
191
192 /**
193  * kvm_vgic_vcpu_init: initialize the vcpu data structures and
194  * enable the VCPU interface
195  * @vcpu: the VCPU which's VGIC should be initialized
196  */
197 static void kvm_vgic_vcpu_init(struct kvm_vcpu *vcpu)
198 {
199         struct vgic_cpu *vgic_cpu = &vcpu->arch.vgic_cpu;
200         int i;
201
202         INIT_LIST_HEAD(&vgic_cpu->ap_list_head);
203         spin_lock_init(&vgic_cpu->ap_list_lock);
204
205         /*
206          * Enable and configure all SGIs to be edge-triggered and
207          * configure all PPIs as level-triggered.
208          */
209         for (i = 0; i < VGIC_NR_PRIVATE_IRQS; i++) {
210                 struct vgic_irq *irq = &vgic_cpu->private_irqs[i];
211
212                 INIT_LIST_HEAD(&irq->ap_list);
213                 spin_lock_init(&irq->irq_lock);
214                 irq->intid = i;
215                 irq->vcpu = NULL;
216                 irq->target_vcpu = vcpu;
217                 irq->targets = 1U << vcpu->vcpu_id;
218                 kref_init(&irq->refcount);
219                 if (vgic_irq_is_sgi(i)) {
220                         /* SGIs */
221                         irq->enabled = 1;
222                         irq->config = VGIC_CONFIG_EDGE;
223                 } else {
224                         /* PPIs */
225                         irq->config = VGIC_CONFIG_LEVEL;
226                 }
227         }
228         if (kvm_vgic_global_state.type == VGIC_V2)
229                 vgic_v2_enable(vcpu);
230         else
231                 vgic_v3_enable(vcpu);
232 }
233
234 /*
235  * vgic_init: allocates and initializes dist and vcpu data structures
236  * depending on two dimensioning parameters:
237  * - the number of spis
238  * - the number of vcpus
239  * The function is generally called when nr_spis has been explicitly set
240  * by the guest through the KVM DEVICE API. If not nr_spis is set to 256.
241  * vgic_initialized() returns true when this function has succeeded.
242  * Must be called with kvm->lock held!
243  */
244 int vgic_init(struct kvm *kvm)
245 {
246         struct vgic_dist *dist = &kvm->arch.vgic;
247         struct kvm_vcpu *vcpu;
248         int ret = 0, i;
249
250         if (vgic_initialized(kvm))
251                 return 0;
252
253         /* freeze the number of spis */
254         if (!dist->nr_spis)
255                 dist->nr_spis = VGIC_NR_IRQS_LEGACY - VGIC_NR_PRIVATE_IRQS;
256
257         ret = kvm_vgic_dist_init(kvm, dist->nr_spis);
258         if (ret)
259                 goto out;
260
261         if (vgic_has_its(kvm))
262                 dist->msis_require_devid = true;
263
264         kvm_for_each_vcpu(i, vcpu, kvm)
265                 kvm_vgic_vcpu_init(vcpu);
266
267         dist->initialized = true;
268 out:
269         return ret;
270 }
271
272 static void kvm_vgic_dist_destroy(struct kvm *kvm)
273 {
274         struct vgic_dist *dist = &kvm->arch.vgic;
275
276         mutex_lock(&kvm->lock);
277
278         dist->ready = false;
279         dist->initialized = false;
280
281         kfree(dist->spis);
282         dist->nr_spis = 0;
283
284         mutex_unlock(&kvm->lock);
285 }
286
287 void kvm_vgic_vcpu_destroy(struct kvm_vcpu *vcpu)
288 {
289         struct vgic_cpu *vgic_cpu = &vcpu->arch.vgic_cpu;
290
291         INIT_LIST_HEAD(&vgic_cpu->ap_list_head);
292 }
293
294 void kvm_vgic_destroy(struct kvm *kvm)
295 {
296         struct kvm_vcpu *vcpu;
297         int i;
298
299         kvm_vgic_dist_destroy(kvm);
300
301         kvm_for_each_vcpu(i, vcpu, kvm)
302                 kvm_vgic_vcpu_destroy(vcpu);
303 }
304
305 /**
306  * vgic_lazy_init: Lazy init is only allowed if the GIC exposed to the guest
307  * is a GICv2. A GICv3 must be explicitly initialized by the guest using the
308  * KVM_DEV_ARM_VGIC_GRP_CTRL KVM_DEVICE group.
309  * @kvm: kvm struct pointer
310  */
311 int vgic_lazy_init(struct kvm *kvm)
312 {
313         int ret = 0;
314
315         if (unlikely(!vgic_initialized(kvm))) {
316                 /*
317                  * We only provide the automatic initialization of the VGIC
318                  * for the legacy case of a GICv2. Any other type must
319                  * be explicitly initialized once setup with the respective
320                  * KVM device call.
321                  */
322                 if (kvm->arch.vgic.vgic_model != KVM_DEV_TYPE_ARM_VGIC_V2)
323                         return -EBUSY;
324
325                 mutex_lock(&kvm->lock);
326                 ret = vgic_init(kvm);
327                 mutex_unlock(&kvm->lock);
328         }
329
330         return ret;
331 }
332
333 /* RESOURCE MAPPING */
334
335 /**
336  * Map the MMIO regions depending on the VGIC model exposed to the guest
337  * called on the first VCPU run.
338  * Also map the virtual CPU interface into the VM.
339  * v2/v3 derivatives call vgic_init if not already done.
340  * vgic_ready() returns true if this function has succeeded.
341  * @kvm: kvm struct pointer
342  */
343 int kvm_vgic_map_resources(struct kvm *kvm)
344 {
345         struct vgic_dist *dist = &kvm->arch.vgic;
346         int ret = 0;
347
348         mutex_lock(&kvm->lock);
349         if (!irqchip_in_kernel(kvm))
350                 goto out;
351
352         if (dist->vgic_model == KVM_DEV_TYPE_ARM_VGIC_V2)
353                 ret = vgic_v2_map_resources(kvm);
354         else
355                 ret = vgic_v3_map_resources(kvm);
356 out:
357         mutex_unlock(&kvm->lock);
358         return ret;
359 }
360
361 /* GENERIC PROBE */
362
363 static int vgic_init_cpu_starting(unsigned int cpu)
364 {
365         enable_percpu_irq(kvm_vgic_global_state.maint_irq, 0);
366         return 0;
367 }
368
369
370 static int vgic_init_cpu_dying(unsigned int cpu)
371 {
372         disable_percpu_irq(kvm_vgic_global_state.maint_irq);
373         return 0;
374 }
375
376 static irqreturn_t vgic_maintenance_handler(int irq, void *data)
377 {
378         /*
379          * We cannot rely on the vgic maintenance interrupt to be
380          * delivered synchronously. This means we can only use it to
381          * exit the VM, and we perform the handling of EOIed
382          * interrupts on the exit path (see vgic_process_maintenance).
383          */
384         return IRQ_HANDLED;
385 }
386
387 /**
388  * kvm_vgic_hyp_init: populates the kvm_vgic_global_state variable
389  * according to the host GIC model. Accordingly calls either
390  * vgic_v2/v3_probe which registers the KVM_DEVICE that can be
391  * instantiated by a guest later on .
392  */
393 int kvm_vgic_hyp_init(void)
394 {
395         const struct gic_kvm_info *gic_kvm_info;
396         int ret;
397
398         gic_kvm_info = gic_get_kvm_info();
399         if (!gic_kvm_info)
400                 return -ENODEV;
401
402         if (!gic_kvm_info->maint_irq) {
403                 kvm_err("No vgic maintenance irq\n");
404                 return -ENXIO;
405         }
406
407         switch (gic_kvm_info->type) {
408         case GIC_V2:
409                 ret = vgic_v2_probe(gic_kvm_info);
410                 break;
411         case GIC_V3:
412                 ret = vgic_v3_probe(gic_kvm_info);
413                 break;
414         default:
415                 ret = -ENODEV;
416         };
417
418         if (ret)
419                 return ret;
420
421         kvm_vgic_global_state.maint_irq = gic_kvm_info->maint_irq;
422         ret = request_percpu_irq(kvm_vgic_global_state.maint_irq,
423                                  vgic_maintenance_handler,
424                                  "vgic", kvm_get_running_vcpus());
425         if (ret) {
426                 kvm_err("Cannot register interrupt %d\n",
427                         kvm_vgic_global_state.maint_irq);
428                 return ret;
429         }
430
431         ret = cpuhp_setup_state(CPUHP_AP_KVM_ARM_VGIC_INIT_STARTING,
432                                 "AP_KVM_ARM_VGIC_INIT_STARTING",
433                                 vgic_init_cpu_starting, vgic_init_cpu_dying);
434         if (ret) {
435                 kvm_err("Cannot register vgic CPU notifier\n");
436                 goto out_free_irq;
437         }
438
439         kvm_info("vgic interrupt IRQ%d\n", kvm_vgic_global_state.maint_irq);
440         return 0;
441
442 out_free_irq:
443         free_percpu_irq(kvm_vgic_global_state.maint_irq,
444                         kvm_get_running_vcpus());
445         return ret;
446 }