Merge remote-tracking branch 'remotes/amit-virtio-rng/for-2.2' into staging
[sdk/emulator/qemu.git] / xen-hvm.c
1 /*
2  * Copyright (C) 2010       Citrix Ltd.
3  *
4  * This work is licensed under the terms of the GNU GPL, version 2.  See
5  * the COPYING file in the top-level directory.
6  *
7  * Contributions after 2012-01-13 are licensed under the terms of the
8  * GNU GPL, version 2 or (at your option) any later version.
9  */
10
11 #include <sys/mman.h>
12
13 #include "hw/pci/pci.h"
14 #include "hw/i386/pc.h"
15 #include "hw/xen/xen_common.h"
16 #include "hw/xen/xen_backend.h"
17 #include "qmp-commands.h"
18
19 #include "sysemu/char.h"
20 #include "qemu/range.h"
21 #include "sysemu/xen-mapcache.h"
22 #include "trace.h"
23 #include "exec/address-spaces.h"
24
25 #include <xen/hvm/ioreq.h>
26 #include <xen/hvm/params.h>
27 #include <xen/hvm/e820.h>
28
29 //#define DEBUG_XEN_HVM
30
31 #ifdef DEBUG_XEN_HVM
32 #define DPRINTF(fmt, ...) \
33     do { fprintf(stderr, "xen: " fmt, ## __VA_ARGS__); } while (0)
34 #else
35 #define DPRINTF(fmt, ...) \
36     do { } while (0)
37 #endif
38
39 static MemoryRegion ram_memory, ram_640k, ram_lo, ram_hi;
40 static MemoryRegion *framebuffer;
41 static bool xen_in_migration;
42
43 /* Compatibility with older version */
44 #if __XEN_LATEST_INTERFACE_VERSION__ < 0x0003020a
45 static inline uint32_t xen_vcpu_eport(shared_iopage_t *shared_page, int i)
46 {
47     return shared_page->vcpu_iodata[i].vp_eport;
48 }
49 static inline ioreq_t *xen_vcpu_ioreq(shared_iopage_t *shared_page, int vcpu)
50 {
51     return &shared_page->vcpu_iodata[vcpu].vp_ioreq;
52 }
53 #  define FMT_ioreq_size PRIx64
54 #else
55 static inline uint32_t xen_vcpu_eport(shared_iopage_t *shared_page, int i)
56 {
57     return shared_page->vcpu_ioreq[i].vp_eport;
58 }
59 static inline ioreq_t *xen_vcpu_ioreq(shared_iopage_t *shared_page, int vcpu)
60 {
61     return &shared_page->vcpu_ioreq[vcpu];
62 }
63 #  define FMT_ioreq_size "u"
64 #endif
65 #ifndef HVM_PARAM_BUFIOREQ_EVTCHN
66 #define HVM_PARAM_BUFIOREQ_EVTCHN 26
67 #endif
68
69 #define BUFFER_IO_MAX_DELAY  100
70
71 typedef struct XenPhysmap {
72     hwaddr start_addr;
73     ram_addr_t size;
74     char *name;
75     hwaddr phys_offset;
76
77     QLIST_ENTRY(XenPhysmap) list;
78 } XenPhysmap;
79
80 typedef struct XenIOState {
81     shared_iopage_t *shared_page;
82     buffered_iopage_t *buffered_io_page;
83     QEMUTimer *buffered_io_timer;
84     /* the evtchn port for polling the notification, */
85     evtchn_port_t *ioreq_local_port;
86     /* evtchn local port for buffered io */
87     evtchn_port_t bufioreq_local_port;
88     /* the evtchn fd for polling */
89     XenEvtchn xce_handle;
90     /* which vcpu we are serving */
91     int send_vcpu;
92
93     struct xs_handle *xenstore;
94     MemoryListener memory_listener;
95     QLIST_HEAD(, XenPhysmap) physmap;
96     hwaddr free_phys_offset;
97     const XenPhysmap *log_for_dirtybit;
98
99     Notifier exit;
100     Notifier suspend;
101     Notifier wakeup;
102 } XenIOState;
103
104 /* Xen specific function for piix pci */
105
106 int xen_pci_slot_get_pirq(PCIDevice *pci_dev, int irq_num)
107 {
108     return irq_num + ((pci_dev->devfn >> 3) << 2);
109 }
110
111 void xen_piix3_set_irq(void *opaque, int irq_num, int level)
112 {
113     xc_hvm_set_pci_intx_level(xen_xc, xen_domid, 0, 0, irq_num >> 2,
114                               irq_num & 3, level);
115 }
116
117 void xen_piix_pci_write_config_client(uint32_t address, uint32_t val, int len)
118 {
119     int i;
120
121     /* Scan for updates to PCI link routes (0x60-0x63). */
122     for (i = 0; i < len; i++) {
123         uint8_t v = (val >> (8 * i)) & 0xff;
124         if (v & 0x80) {
125             v = 0;
126         }
127         v &= 0xf;
128         if (((address + i) >= 0x60) && ((address + i) <= 0x63)) {
129             xc_hvm_set_pci_link_route(xen_xc, xen_domid, address + i - 0x60, v);
130         }
131     }
132 }
133
134 void xen_hvm_inject_msi(uint64_t addr, uint32_t data)
135 {
136     xen_xc_hvm_inject_msi(xen_xc, xen_domid, addr, data);
137 }
138
139 static void xen_suspend_notifier(Notifier *notifier, void *data)
140 {
141     xc_set_hvm_param(xen_xc, xen_domid, HVM_PARAM_ACPI_S_STATE, 3);
142 }
143
144 /* Xen Interrupt Controller */
145
146 static void xen_set_irq(void *opaque, int irq, int level)
147 {
148     xc_hvm_set_isa_irq_level(xen_xc, xen_domid, irq, level);
149 }
150
151 qemu_irq *xen_interrupt_controller_init(void)
152 {
153     return qemu_allocate_irqs(xen_set_irq, NULL, 16);
154 }
155
156 /* Memory Ops */
157
158 static void xen_ram_init(ram_addr_t *below_4g_mem_size,
159                          ram_addr_t *above_4g_mem_size,
160                          ram_addr_t ram_size, MemoryRegion **ram_memory_p)
161 {
162     MemoryRegion *sysmem = get_system_memory();
163     ram_addr_t block_len;
164     uint64_t user_lowmem = object_property_get_int(qdev_get_machine(),
165                                                    PC_MACHINE_MAX_RAM_BELOW_4G,
166                                                    &error_abort);
167
168     /* Handle the machine opt max-ram-below-4g.  It is basically doing
169      * min(xen limit, user limit).
170      */
171     if (HVM_BELOW_4G_RAM_END <= user_lowmem) {
172         user_lowmem = HVM_BELOW_4G_RAM_END;
173     }
174
175     if (ram_size >= user_lowmem) {
176         *above_4g_mem_size = ram_size - user_lowmem;
177         *below_4g_mem_size = user_lowmem;
178     } else {
179         *above_4g_mem_size = 0;
180         *below_4g_mem_size = ram_size;
181     }
182     if (!*above_4g_mem_size) {
183         block_len = ram_size;
184     } else {
185         /*
186          * Xen does not allocate the memory continuously, it keeps a
187          * hole of the size computed above or passed in.
188          */
189         block_len = (1ULL << 32) + *above_4g_mem_size;
190     }
191     memory_region_init_ram(&ram_memory, NULL, "xen.ram", block_len);
192     *ram_memory_p = &ram_memory;
193     vmstate_register_ram_global(&ram_memory);
194
195     memory_region_init_alias(&ram_640k, NULL, "xen.ram.640k",
196                              &ram_memory, 0, 0xa0000);
197     memory_region_add_subregion(sysmem, 0, &ram_640k);
198     /* Skip of the VGA IO memory space, it will be registered later by the VGA
199      * emulated device.
200      *
201      * The area between 0xc0000 and 0x100000 will be used by SeaBIOS to load
202      * the Options ROM, so it is registered here as RAM.
203      */
204     memory_region_init_alias(&ram_lo, NULL, "xen.ram.lo",
205                              &ram_memory, 0xc0000,
206                              *below_4g_mem_size - 0xc0000);
207     memory_region_add_subregion(sysmem, 0xc0000, &ram_lo);
208     if (*above_4g_mem_size > 0) {
209         memory_region_init_alias(&ram_hi, NULL, "xen.ram.hi",
210                                  &ram_memory, 0x100000000ULL,
211                                  *above_4g_mem_size);
212         memory_region_add_subregion(sysmem, 0x100000000ULL, &ram_hi);
213     }
214 }
215
216 void xen_ram_alloc(ram_addr_t ram_addr, ram_addr_t size, MemoryRegion *mr)
217 {
218     unsigned long nr_pfn;
219     xen_pfn_t *pfn_list;
220     int i;
221
222     if (runstate_check(RUN_STATE_INMIGRATE)) {
223         /* RAM already populated in Xen */
224         fprintf(stderr, "%s: do not alloc "RAM_ADDR_FMT
225                 " bytes of ram at "RAM_ADDR_FMT" when runstate is INMIGRATE\n",
226                 __func__, size, ram_addr); 
227         return;
228     }
229
230     if (mr == &ram_memory) {
231         return;
232     }
233
234     trace_xen_ram_alloc(ram_addr, size);
235
236     nr_pfn = size >> TARGET_PAGE_BITS;
237     pfn_list = g_malloc(sizeof (*pfn_list) * nr_pfn);
238
239     for (i = 0; i < nr_pfn; i++) {
240         pfn_list[i] = (ram_addr >> TARGET_PAGE_BITS) + i;
241     }
242
243     if (xc_domain_populate_physmap_exact(xen_xc, xen_domid, nr_pfn, 0, 0, pfn_list)) {
244         hw_error("xen: failed to populate ram at " RAM_ADDR_FMT, ram_addr);
245     }
246
247     g_free(pfn_list);
248 }
249
250 static XenPhysmap *get_physmapping(XenIOState *state,
251                                    hwaddr start_addr, ram_addr_t size)
252 {
253     XenPhysmap *physmap = NULL;
254
255     start_addr &= TARGET_PAGE_MASK;
256
257     QLIST_FOREACH(physmap, &state->physmap, list) {
258         if (range_covers_byte(physmap->start_addr, physmap->size, start_addr)) {
259             return physmap;
260         }
261     }
262     return NULL;
263 }
264
265 static hwaddr xen_phys_offset_to_gaddr(hwaddr start_addr,
266                                                    ram_addr_t size, void *opaque)
267 {
268     hwaddr addr = start_addr & TARGET_PAGE_MASK;
269     XenIOState *xen_io_state = opaque;
270     XenPhysmap *physmap = NULL;
271
272     QLIST_FOREACH(physmap, &xen_io_state->physmap, list) {
273         if (range_covers_byte(physmap->phys_offset, physmap->size, addr)) {
274             return physmap->start_addr;
275         }
276     }
277
278     return start_addr;
279 }
280
281 #if CONFIG_XEN_CTRL_INTERFACE_VERSION >= 340
282 static int xen_add_to_physmap(XenIOState *state,
283                               hwaddr start_addr,
284                               ram_addr_t size,
285                               MemoryRegion *mr,
286                               hwaddr offset_within_region)
287 {
288     unsigned long i = 0;
289     int rc = 0;
290     XenPhysmap *physmap = NULL;
291     hwaddr pfn, start_gpfn;
292     hwaddr phys_offset = memory_region_get_ram_addr(mr);
293     char path[80], value[17];
294
295     if (get_physmapping(state, start_addr, size)) {
296         return 0;
297     }
298     if (size <= 0) {
299         return -1;
300     }
301
302     /* Xen can only handle a single dirty log region for now and we want
303      * the linear framebuffer to be that region.
304      * Avoid tracking any regions that is not videoram and avoid tracking
305      * the legacy vga region. */
306     if (mr == framebuffer && start_addr > 0xbffff) {
307         goto go_physmap;
308     }
309     return -1;
310
311 go_physmap:
312     DPRINTF("mapping vram to %"HWADDR_PRIx" - %"HWADDR_PRIx"\n",
313             start_addr, start_addr + size);
314
315     pfn = phys_offset >> TARGET_PAGE_BITS;
316     start_gpfn = start_addr >> TARGET_PAGE_BITS;
317     for (i = 0; i < size >> TARGET_PAGE_BITS; i++) {
318         unsigned long idx = pfn + i;
319         xen_pfn_t gpfn = start_gpfn + i;
320
321         rc = xc_domain_add_to_physmap(xen_xc, xen_domid, XENMAPSPACE_gmfn, idx, gpfn);
322         if (rc) {
323             DPRINTF("add_to_physmap MFN %"PRI_xen_pfn" to PFN %"
324                     PRI_xen_pfn" failed: %d\n", idx, gpfn, rc);
325             return -rc;
326         }
327     }
328
329     physmap = g_malloc(sizeof (XenPhysmap));
330
331     physmap->start_addr = start_addr;
332     physmap->size = size;
333     physmap->name = (char *)mr->name;
334     physmap->phys_offset = phys_offset;
335
336     QLIST_INSERT_HEAD(&state->physmap, physmap, list);
337
338     xc_domain_pin_memory_cacheattr(xen_xc, xen_domid,
339                                    start_addr >> TARGET_PAGE_BITS,
340                                    (start_addr + size - 1) >> TARGET_PAGE_BITS,
341                                    XEN_DOMCTL_MEM_CACHEATTR_WB);
342
343     snprintf(path, sizeof(path),
344             "/local/domain/0/device-model/%d/physmap/%"PRIx64"/start_addr",
345             xen_domid, (uint64_t)phys_offset);
346     snprintf(value, sizeof(value), "%"PRIx64, (uint64_t)start_addr);
347     if (!xs_write(state->xenstore, 0, path, value, strlen(value))) {
348         return -1;
349     }
350     snprintf(path, sizeof(path),
351             "/local/domain/0/device-model/%d/physmap/%"PRIx64"/size",
352             xen_domid, (uint64_t)phys_offset);
353     snprintf(value, sizeof(value), "%"PRIx64, (uint64_t)size);
354     if (!xs_write(state->xenstore, 0, path, value, strlen(value))) {
355         return -1;
356     }
357     if (mr->name) {
358         snprintf(path, sizeof(path),
359                 "/local/domain/0/device-model/%d/physmap/%"PRIx64"/name",
360                 xen_domid, (uint64_t)phys_offset);
361         if (!xs_write(state->xenstore, 0, path, mr->name, strlen(mr->name))) {
362             return -1;
363         }
364     }
365
366     return 0;
367 }
368
369 static int xen_remove_from_physmap(XenIOState *state,
370                                    hwaddr start_addr,
371                                    ram_addr_t size)
372 {
373     unsigned long i = 0;
374     int rc = 0;
375     XenPhysmap *physmap = NULL;
376     hwaddr phys_offset = 0;
377
378     physmap = get_physmapping(state, start_addr, size);
379     if (physmap == NULL) {
380         return -1;
381     }
382
383     phys_offset = physmap->phys_offset;
384     size = physmap->size;
385
386     DPRINTF("unmapping vram to %"HWADDR_PRIx" - %"HWADDR_PRIx", at "
387             "%"HWADDR_PRIx"\n", start_addr, start_addr + size, phys_offset);
388
389     size >>= TARGET_PAGE_BITS;
390     start_addr >>= TARGET_PAGE_BITS;
391     phys_offset >>= TARGET_PAGE_BITS;
392     for (i = 0; i < size; i++) {
393         xen_pfn_t idx = start_addr + i;
394         xen_pfn_t gpfn = phys_offset + i;
395
396         rc = xc_domain_add_to_physmap(xen_xc, xen_domid, XENMAPSPACE_gmfn, idx, gpfn);
397         if (rc) {
398             fprintf(stderr, "add_to_physmap MFN %"PRI_xen_pfn" to PFN %"
399                     PRI_xen_pfn" failed: %d\n", idx, gpfn, rc);
400             return -rc;
401         }
402     }
403
404     QLIST_REMOVE(physmap, list);
405     if (state->log_for_dirtybit == physmap) {
406         state->log_for_dirtybit = NULL;
407     }
408     g_free(physmap);
409
410     return 0;
411 }
412
413 #else
414 static int xen_add_to_physmap(XenIOState *state,
415                               hwaddr start_addr,
416                               ram_addr_t size,
417                               MemoryRegion *mr,
418                               hwaddr offset_within_region)
419 {
420     return -ENOSYS;
421 }
422
423 static int xen_remove_from_physmap(XenIOState *state,
424                                    hwaddr start_addr,
425                                    ram_addr_t size)
426 {
427     return -ENOSYS;
428 }
429 #endif
430
431 static void xen_set_memory(struct MemoryListener *listener,
432                            MemoryRegionSection *section,
433                            bool add)
434 {
435     XenIOState *state = container_of(listener, XenIOState, memory_listener);
436     hwaddr start_addr = section->offset_within_address_space;
437     ram_addr_t size = int128_get64(section->size);
438     bool log_dirty = memory_region_is_logging(section->mr);
439     hvmmem_type_t mem_type;
440
441     if (!memory_region_is_ram(section->mr)) {
442         return;
443     }
444
445     if (!(section->mr != &ram_memory
446           && ( (log_dirty && add) || (!log_dirty && !add)))) {
447         return;
448     }
449
450     trace_xen_client_set_memory(start_addr, size, log_dirty);
451
452     start_addr &= TARGET_PAGE_MASK;
453     size = TARGET_PAGE_ALIGN(size);
454
455     if (add) {
456         if (!memory_region_is_rom(section->mr)) {
457             xen_add_to_physmap(state, start_addr, size,
458                                section->mr, section->offset_within_region);
459         } else {
460             mem_type = HVMMEM_ram_ro;
461             if (xc_hvm_set_mem_type(xen_xc, xen_domid, mem_type,
462                                     start_addr >> TARGET_PAGE_BITS,
463                                     size >> TARGET_PAGE_BITS)) {
464                 DPRINTF("xc_hvm_set_mem_type error, addr: "TARGET_FMT_plx"\n",
465                         start_addr);
466             }
467         }
468     } else {
469         if (xen_remove_from_physmap(state, start_addr, size) < 0) {
470             DPRINTF("physmapping does not exist at "TARGET_FMT_plx"\n", start_addr);
471         }
472     }
473 }
474
475 static void xen_region_add(MemoryListener *listener,
476                            MemoryRegionSection *section)
477 {
478     memory_region_ref(section->mr);
479     xen_set_memory(listener, section, true);
480 }
481
482 static void xen_region_del(MemoryListener *listener,
483                            MemoryRegionSection *section)
484 {
485     xen_set_memory(listener, section, false);
486     memory_region_unref(section->mr);
487 }
488
489 static void xen_sync_dirty_bitmap(XenIOState *state,
490                                   hwaddr start_addr,
491                                   ram_addr_t size)
492 {
493     hwaddr npages = size >> TARGET_PAGE_BITS;
494     const int width = sizeof(unsigned long) * 8;
495     unsigned long bitmap[(npages + width - 1) / width];
496     int rc, i, j;
497     const XenPhysmap *physmap = NULL;
498
499     physmap = get_physmapping(state, start_addr, size);
500     if (physmap == NULL) {
501         /* not handled */
502         return;
503     }
504
505     if (state->log_for_dirtybit == NULL) {
506         state->log_for_dirtybit = physmap;
507     } else if (state->log_for_dirtybit != physmap) {
508         /* Only one range for dirty bitmap can be tracked. */
509         return;
510     }
511
512     rc = xc_hvm_track_dirty_vram(xen_xc, xen_domid,
513                                  start_addr >> TARGET_PAGE_BITS, npages,
514                                  bitmap);
515     if (rc < 0) {
516 #ifndef ENODATA
517 #define ENODATA  ENOENT
518 #endif
519         if (errno == ENODATA) {
520             memory_region_set_dirty(framebuffer, 0, size);
521             DPRINTF("xen: track_dirty_vram failed (0x" TARGET_FMT_plx
522                     ", 0x" TARGET_FMT_plx "): %s\n",
523                     start_addr, start_addr + size, strerror(errno));
524         }
525         return;
526     }
527
528     for (i = 0; i < ARRAY_SIZE(bitmap); i++) {
529         unsigned long map = bitmap[i];
530         while (map != 0) {
531             j = ctzl(map);
532             map &= ~(1ul << j);
533             memory_region_set_dirty(framebuffer,
534                                     (i * width + j) * TARGET_PAGE_SIZE,
535                                     TARGET_PAGE_SIZE);
536         };
537     }
538 }
539
540 static void xen_log_start(MemoryListener *listener,
541                           MemoryRegionSection *section)
542 {
543     XenIOState *state = container_of(listener, XenIOState, memory_listener);
544
545     xen_sync_dirty_bitmap(state, section->offset_within_address_space,
546                           int128_get64(section->size));
547 }
548
549 static void xen_log_stop(MemoryListener *listener, MemoryRegionSection *section)
550 {
551     XenIOState *state = container_of(listener, XenIOState, memory_listener);
552
553     state->log_for_dirtybit = NULL;
554     /* Disable dirty bit tracking */
555     xc_hvm_track_dirty_vram(xen_xc, xen_domid, 0, 0, NULL);
556 }
557
558 static void xen_log_sync(MemoryListener *listener, MemoryRegionSection *section)
559 {
560     XenIOState *state = container_of(listener, XenIOState, memory_listener);
561
562     xen_sync_dirty_bitmap(state, section->offset_within_address_space,
563                           int128_get64(section->size));
564 }
565
566 static void xen_log_global_start(MemoryListener *listener)
567 {
568     if (xen_enabled()) {
569         xen_in_migration = true;
570     }
571 }
572
573 static void xen_log_global_stop(MemoryListener *listener)
574 {
575     xen_in_migration = false;
576 }
577
578 static MemoryListener xen_memory_listener = {
579     .region_add = xen_region_add,
580     .region_del = xen_region_del,
581     .log_start = xen_log_start,
582     .log_stop = xen_log_stop,
583     .log_sync = xen_log_sync,
584     .log_global_start = xen_log_global_start,
585     .log_global_stop = xen_log_global_stop,
586     .priority = 10,
587 };
588
589 /* get the ioreq packets from share mem */
590 static ioreq_t *cpu_get_ioreq_from_shared_memory(XenIOState *state, int vcpu)
591 {
592     ioreq_t *req = xen_vcpu_ioreq(state->shared_page, vcpu);
593
594     if (req->state != STATE_IOREQ_READY) {
595         DPRINTF("I/O request not ready: "
596                 "%x, ptr: %x, port: %"PRIx64", "
597                 "data: %"PRIx64", count: %" FMT_ioreq_size ", size: %" FMT_ioreq_size "\n",
598                 req->state, req->data_is_ptr, req->addr,
599                 req->data, req->count, req->size);
600         return NULL;
601     }
602
603     xen_rmb(); /* see IOREQ_READY /then/ read contents of ioreq */
604
605     req->state = STATE_IOREQ_INPROCESS;
606     return req;
607 }
608
609 /* use poll to get the port notification */
610 /* ioreq_vec--out,the */
611 /* retval--the number of ioreq packet */
612 static ioreq_t *cpu_get_ioreq(XenIOState *state)
613 {
614     int i;
615     evtchn_port_t port;
616
617     port = xc_evtchn_pending(state->xce_handle);
618     if (port == state->bufioreq_local_port) {
619         timer_mod(state->buffered_io_timer,
620                 BUFFER_IO_MAX_DELAY + qemu_clock_get_ms(QEMU_CLOCK_REALTIME));
621         return NULL;
622     }
623
624     if (port != -1) {
625         for (i = 0; i < max_cpus; i++) {
626             if (state->ioreq_local_port[i] == port) {
627                 break;
628             }
629         }
630
631         if (i == max_cpus) {
632             hw_error("Fatal error while trying to get io event!\n");
633         }
634
635         /* unmask the wanted port again */
636         xc_evtchn_unmask(state->xce_handle, port);
637
638         /* get the io packet from shared memory */
639         state->send_vcpu = i;
640         return cpu_get_ioreq_from_shared_memory(state, i);
641     }
642
643     /* read error or read nothing */
644     return NULL;
645 }
646
647 static uint32_t do_inp(pio_addr_t addr, unsigned long size)
648 {
649     switch (size) {
650         case 1:
651             return cpu_inb(addr);
652         case 2:
653             return cpu_inw(addr);
654         case 4:
655             return cpu_inl(addr);
656         default:
657             hw_error("inp: bad size: %04"FMT_pioaddr" %lx", addr, size);
658     }
659 }
660
661 static void do_outp(pio_addr_t addr,
662         unsigned long size, uint32_t val)
663 {
664     switch (size) {
665         case 1:
666             return cpu_outb(addr, val);
667         case 2:
668             return cpu_outw(addr, val);
669         case 4:
670             return cpu_outl(addr, val);
671         default:
672             hw_error("outp: bad size: %04"FMT_pioaddr" %lx", addr, size);
673     }
674 }
675
676 /*
677  * Helper functions which read/write an object from/to physical guest
678  * memory, as part of the implementation of an ioreq.
679  *
680  * Equivalent to
681  *   cpu_physical_memory_rw(addr + (req->df ? -1 : +1) * req->size * i,
682  *                          val, req->size, 0/1)
683  * except without the integer overflow problems.
684  */
685 static void rw_phys_req_item(hwaddr addr,
686                              ioreq_t *req, uint32_t i, void *val, int rw)
687 {
688     /* Do everything unsigned so overflow just results in a truncated result
689      * and accesses to undesired parts of guest memory, which is up
690      * to the guest */
691     hwaddr offset = (hwaddr)req->size * i;
692     if (req->df) {
693         addr -= offset;
694     } else {
695         addr += offset;
696     }
697     cpu_physical_memory_rw(addr, val, req->size, rw);
698 }
699
700 static inline void read_phys_req_item(hwaddr addr,
701                                       ioreq_t *req, uint32_t i, void *val)
702 {
703     rw_phys_req_item(addr, req, i, val, 0);
704 }
705 static inline void write_phys_req_item(hwaddr addr,
706                                        ioreq_t *req, uint32_t i, void *val)
707 {
708     rw_phys_req_item(addr, req, i, val, 1);
709 }
710
711
712 static void cpu_ioreq_pio(ioreq_t *req)
713 {
714     uint32_t i;
715
716     if (req->dir == IOREQ_READ) {
717         if (!req->data_is_ptr) {
718             req->data = do_inp(req->addr, req->size);
719         } else {
720             uint32_t tmp;
721
722             for (i = 0; i < req->count; i++) {
723                 tmp = do_inp(req->addr, req->size);
724                 write_phys_req_item(req->data, req, i, &tmp);
725             }
726         }
727     } else if (req->dir == IOREQ_WRITE) {
728         if (!req->data_is_ptr) {
729             do_outp(req->addr, req->size, req->data);
730         } else {
731             for (i = 0; i < req->count; i++) {
732                 uint32_t tmp = 0;
733
734                 read_phys_req_item(req->data, req, i, &tmp);
735                 do_outp(req->addr, req->size, tmp);
736             }
737         }
738     }
739 }
740
741 static void cpu_ioreq_move(ioreq_t *req)
742 {
743     uint32_t i;
744
745     if (!req->data_is_ptr) {
746         if (req->dir == IOREQ_READ) {
747             for (i = 0; i < req->count; i++) {
748                 read_phys_req_item(req->addr, req, i, &req->data);
749             }
750         } else if (req->dir == IOREQ_WRITE) {
751             for (i = 0; i < req->count; i++) {
752                 write_phys_req_item(req->addr, req, i, &req->data);
753             }
754         }
755     } else {
756         uint64_t tmp;
757
758         if (req->dir == IOREQ_READ) {
759             for (i = 0; i < req->count; i++) {
760                 read_phys_req_item(req->addr, req, i, &tmp);
761                 write_phys_req_item(req->data, req, i, &tmp);
762             }
763         } else if (req->dir == IOREQ_WRITE) {
764             for (i = 0; i < req->count; i++) {
765                 read_phys_req_item(req->data, req, i, &tmp);
766                 write_phys_req_item(req->addr, req, i, &tmp);
767             }
768         }
769     }
770 }
771
772 static void handle_ioreq(ioreq_t *req)
773 {
774     if (!req->data_is_ptr && (req->dir == IOREQ_WRITE) &&
775             (req->size < sizeof (target_ulong))) {
776         req->data &= ((target_ulong) 1 << (8 * req->size)) - 1;
777     }
778
779     switch (req->type) {
780         case IOREQ_TYPE_PIO:
781             cpu_ioreq_pio(req);
782             break;
783         case IOREQ_TYPE_COPY:
784             cpu_ioreq_move(req);
785             break;
786         case IOREQ_TYPE_TIMEOFFSET:
787             break;
788         case IOREQ_TYPE_INVALIDATE:
789             xen_invalidate_map_cache();
790             break;
791         default:
792             hw_error("Invalid ioreq type 0x%x\n", req->type);
793     }
794 }
795
796 static int handle_buffered_iopage(XenIOState *state)
797 {
798     buf_ioreq_t *buf_req = NULL;
799     ioreq_t req;
800     int qw;
801
802     if (!state->buffered_io_page) {
803         return 0;
804     }
805
806     memset(&req, 0x00, sizeof(req));
807
808     while (state->buffered_io_page->read_pointer != state->buffered_io_page->write_pointer) {
809         buf_req = &state->buffered_io_page->buf_ioreq[
810             state->buffered_io_page->read_pointer % IOREQ_BUFFER_SLOT_NUM];
811         req.size = 1UL << buf_req->size;
812         req.count = 1;
813         req.addr = buf_req->addr;
814         req.data = buf_req->data;
815         req.state = STATE_IOREQ_READY;
816         req.dir = buf_req->dir;
817         req.df = 1;
818         req.type = buf_req->type;
819         req.data_is_ptr = 0;
820         qw = (req.size == 8);
821         if (qw) {
822             buf_req = &state->buffered_io_page->buf_ioreq[
823                 (state->buffered_io_page->read_pointer + 1) % IOREQ_BUFFER_SLOT_NUM];
824             req.data |= ((uint64_t)buf_req->data) << 32;
825         }
826
827         handle_ioreq(&req);
828
829         xen_mb();
830         state->buffered_io_page->read_pointer += qw ? 2 : 1;
831     }
832
833     return req.count;
834 }
835
836 static void handle_buffered_io(void *opaque)
837 {
838     XenIOState *state = opaque;
839
840     if (handle_buffered_iopage(state)) {
841         timer_mod(state->buffered_io_timer,
842                 BUFFER_IO_MAX_DELAY + qemu_clock_get_ms(QEMU_CLOCK_REALTIME));
843     } else {
844         timer_del(state->buffered_io_timer);
845         xc_evtchn_unmask(state->xce_handle, state->bufioreq_local_port);
846     }
847 }
848
849 static void cpu_handle_ioreq(void *opaque)
850 {
851     XenIOState *state = opaque;
852     ioreq_t *req = cpu_get_ioreq(state);
853
854     handle_buffered_iopage(state);
855     if (req) {
856         handle_ioreq(req);
857
858         if (req->state != STATE_IOREQ_INPROCESS) {
859             fprintf(stderr, "Badness in I/O request ... not in service?!: "
860                     "%x, ptr: %x, port: %"PRIx64", "
861                     "data: %"PRIx64", count: %" FMT_ioreq_size ", size: %" FMT_ioreq_size "\n",
862                     req->state, req->data_is_ptr, req->addr,
863                     req->data, req->count, req->size);
864             destroy_hvm_domain(false);
865             return;
866         }
867
868         xen_wmb(); /* Update ioreq contents /then/ update state. */
869
870         /*
871          * We do this before we send the response so that the tools
872          * have the opportunity to pick up on the reset before the
873          * guest resumes and does a hlt with interrupts disabled which
874          * causes Xen to powerdown the domain.
875          */
876         if (runstate_is_running()) {
877             if (qemu_shutdown_requested_get()) {
878                 destroy_hvm_domain(false);
879             }
880             if (qemu_reset_requested_get()) {
881                 qemu_system_reset(VMRESET_REPORT);
882                 destroy_hvm_domain(true);
883             }
884         }
885
886         req->state = STATE_IORESP_READY;
887         xc_evtchn_notify(state->xce_handle, state->ioreq_local_port[state->send_vcpu]);
888     }
889 }
890
891 static void xen_main_loop_prepare(XenIOState *state)
892 {
893     int evtchn_fd = -1;
894
895     if (state->xce_handle != XC_HANDLER_INITIAL_VALUE) {
896         evtchn_fd = xc_evtchn_fd(state->xce_handle);
897     }
898
899     state->buffered_io_timer = timer_new_ms(QEMU_CLOCK_REALTIME, handle_buffered_io,
900                                                  state);
901
902     if (evtchn_fd != -1) {
903         qemu_set_fd_handler(evtchn_fd, cpu_handle_ioreq, NULL, state);
904     }
905 }
906
907
908 static void xen_hvm_change_state_handler(void *opaque, int running,
909                                          RunState rstate)
910 {
911     XenIOState *xstate = opaque;
912     if (running) {
913         xen_main_loop_prepare(xstate);
914     }
915 }
916
917 static void xen_exit_notifier(Notifier *n, void *data)
918 {
919     XenIOState *state = container_of(n, XenIOState, exit);
920
921     xc_evtchn_close(state->xce_handle);
922     xs_daemon_close(state->xenstore);
923 }
924
925 static void xen_read_physmap(XenIOState *state)
926 {
927     XenPhysmap *physmap = NULL;
928     unsigned int len, num, i;
929     char path[80], *value = NULL;
930     char **entries = NULL;
931
932     snprintf(path, sizeof(path),
933             "/local/domain/0/device-model/%d/physmap", xen_domid);
934     entries = xs_directory(state->xenstore, 0, path, &num);
935     if (entries == NULL)
936         return;
937
938     for (i = 0; i < num; i++) {
939         physmap = g_malloc(sizeof (XenPhysmap));
940         physmap->phys_offset = strtoull(entries[i], NULL, 16);
941         snprintf(path, sizeof(path),
942                 "/local/domain/0/device-model/%d/physmap/%s/start_addr",
943                 xen_domid, entries[i]);
944         value = xs_read(state->xenstore, 0, path, &len);
945         if (value == NULL) {
946             g_free(physmap);
947             continue;
948         }
949         physmap->start_addr = strtoull(value, NULL, 16);
950         free(value);
951
952         snprintf(path, sizeof(path),
953                 "/local/domain/0/device-model/%d/physmap/%s/size",
954                 xen_domid, entries[i]);
955         value = xs_read(state->xenstore, 0, path, &len);
956         if (value == NULL) {
957             g_free(physmap);
958             continue;
959         }
960         physmap->size = strtoull(value, NULL, 16);
961         free(value);
962
963         snprintf(path, sizeof(path),
964                 "/local/domain/0/device-model/%d/physmap/%s/name",
965                 xen_domid, entries[i]);
966         physmap->name = xs_read(state->xenstore, 0, path, &len);
967
968         QLIST_INSERT_HEAD(&state->physmap, physmap, list);
969     }
970     free(entries);
971 }
972
973 static void xen_wakeup_notifier(Notifier *notifier, void *data)
974 {
975     xc_set_hvm_param(xen_xc, xen_domid, HVM_PARAM_ACPI_S_STATE, 0);
976 }
977
978 int xen_hvm_init(ram_addr_t *below_4g_mem_size, ram_addr_t *above_4g_mem_size,
979                  MemoryRegion **ram_memory)
980 {
981     int i, rc;
982     unsigned long ioreq_pfn;
983     unsigned long bufioreq_evtchn;
984     XenIOState *state;
985
986     state = g_malloc0(sizeof (XenIOState));
987
988     state->xce_handle = xen_xc_evtchn_open(NULL, 0);
989     if (state->xce_handle == XC_HANDLER_INITIAL_VALUE) {
990         perror("xen: event channel open");
991         g_free(state);
992         return -errno;
993     }
994
995     state->xenstore = xs_daemon_open();
996     if (state->xenstore == NULL) {
997         perror("xen: xenstore open");
998         g_free(state);
999         return -errno;
1000     }
1001
1002     state->exit.notify = xen_exit_notifier;
1003     qemu_add_exit_notifier(&state->exit);
1004
1005     state->suspend.notify = xen_suspend_notifier;
1006     qemu_register_suspend_notifier(&state->suspend);
1007
1008     state->wakeup.notify = xen_wakeup_notifier;
1009     qemu_register_wakeup_notifier(&state->wakeup);
1010
1011     xc_get_hvm_param(xen_xc, xen_domid, HVM_PARAM_IOREQ_PFN, &ioreq_pfn);
1012     DPRINTF("shared page at pfn %lx\n", ioreq_pfn);
1013     state->shared_page = xc_map_foreign_range(xen_xc, xen_domid, XC_PAGE_SIZE,
1014                                               PROT_READ|PROT_WRITE, ioreq_pfn);
1015     if (state->shared_page == NULL) {
1016         hw_error("map shared IO page returned error %d handle=" XC_INTERFACE_FMT,
1017                  errno, xen_xc);
1018     }
1019
1020     xc_get_hvm_param(xen_xc, xen_domid, HVM_PARAM_BUFIOREQ_PFN, &ioreq_pfn);
1021     DPRINTF("buffered io page at pfn %lx\n", ioreq_pfn);
1022     state->buffered_io_page = xc_map_foreign_range(xen_xc, xen_domid, XC_PAGE_SIZE,
1023                                                    PROT_READ|PROT_WRITE, ioreq_pfn);
1024     if (state->buffered_io_page == NULL) {
1025         hw_error("map buffered IO page returned error %d", errno);
1026     }
1027
1028     state->ioreq_local_port = g_malloc0(max_cpus * sizeof (evtchn_port_t));
1029
1030     /* FIXME: how about if we overflow the page here? */
1031     for (i = 0; i < max_cpus; i++) {
1032         rc = xc_evtchn_bind_interdomain(state->xce_handle, xen_domid,
1033                                         xen_vcpu_eport(state->shared_page, i));
1034         if (rc == -1) {
1035             fprintf(stderr, "bind interdomain ioctl error %d\n", errno);
1036             return -1;
1037         }
1038         state->ioreq_local_port[i] = rc;
1039     }
1040
1041     rc = xc_get_hvm_param(xen_xc, xen_domid, HVM_PARAM_BUFIOREQ_EVTCHN,
1042             &bufioreq_evtchn);
1043     if (rc < 0) {
1044         fprintf(stderr, "failed to get HVM_PARAM_BUFIOREQ_EVTCHN\n");
1045         return -1;
1046     }
1047     rc = xc_evtchn_bind_interdomain(state->xce_handle, xen_domid,
1048             (uint32_t)bufioreq_evtchn);
1049     if (rc == -1) {
1050         fprintf(stderr, "bind interdomain ioctl error %d\n", errno);
1051         return -1;
1052     }
1053     state->bufioreq_local_port = rc;
1054
1055     /* Init RAM management */
1056     xen_map_cache_init(xen_phys_offset_to_gaddr, state);
1057     xen_ram_init(below_4g_mem_size, above_4g_mem_size, ram_size, ram_memory);
1058
1059     qemu_add_vm_change_state_handler(xen_hvm_change_state_handler, state);
1060
1061     state->memory_listener = xen_memory_listener;
1062     QLIST_INIT(&state->physmap);
1063     memory_listener_register(&state->memory_listener, &address_space_memory);
1064     state->log_for_dirtybit = NULL;
1065
1066     /* Initialize backend core & drivers */
1067     if (xen_be_init() != 0) {
1068         fprintf(stderr, "%s: xen backend core setup failed\n", __FUNCTION__);
1069         exit(1);
1070     }
1071     xen_be_register("console", &xen_console_ops);
1072     xen_be_register("vkbd", &xen_kbdmouse_ops);
1073     xen_be_register("qdisk", &xen_blkdev_ops);
1074     xen_read_physmap(state);
1075
1076     return 0;
1077 }
1078
1079 void destroy_hvm_domain(bool reboot)
1080 {
1081     XenXC xc_handle;
1082     int sts;
1083
1084     xc_handle = xen_xc_interface_open(0, 0, 0);
1085     if (xc_handle == XC_HANDLER_INITIAL_VALUE) {
1086         fprintf(stderr, "Cannot acquire xenctrl handle\n");
1087     } else {
1088         sts = xc_domain_shutdown(xc_handle, xen_domid,
1089                                  reboot ? SHUTDOWN_reboot : SHUTDOWN_poweroff);
1090         if (sts != 0) {
1091             fprintf(stderr, "xc_domain_shutdown failed to issue %s, "
1092                     "sts %d, %s\n", reboot ? "reboot" : "poweroff",
1093                     sts, strerror(errno));
1094         } else {
1095             fprintf(stderr, "Issued domain %d %s\n", xen_domid,
1096                     reboot ? "reboot" : "poweroff");
1097         }
1098         xc_interface_close(xc_handle);
1099     }
1100 }
1101
1102 void xen_register_framebuffer(MemoryRegion *mr)
1103 {
1104     framebuffer = mr;
1105 }
1106
1107 void xen_shutdown_fatal_error(const char *fmt, ...)
1108 {
1109     va_list ap;
1110
1111     va_start(ap, fmt);
1112     vfprintf(stderr, fmt, ap);
1113     va_end(ap);
1114     fprintf(stderr, "Will destroy the domain.\n");
1115     /* destroy the domain */
1116     qemu_system_shutdown_request();
1117 }
1118
1119 void xen_modified_memory(ram_addr_t start, ram_addr_t length)
1120 {
1121     if (unlikely(xen_in_migration)) {
1122         int rc;
1123         ram_addr_t start_pfn, nb_pages;
1124
1125         if (length == 0) {
1126             length = TARGET_PAGE_SIZE;
1127         }
1128         start_pfn = start >> TARGET_PAGE_BITS;
1129         nb_pages = ((start + length + TARGET_PAGE_SIZE - 1) >> TARGET_PAGE_BITS)
1130             - start_pfn;
1131         rc = xc_hvm_modified_memory(xen_xc, xen_domid, start_pfn, nb_pages);
1132         if (rc) {
1133             fprintf(stderr,
1134                     "%s failed for "RAM_ADDR_FMT" ("RAM_ADDR_FMT"): %i, %s\n",
1135                     __func__, start, nb_pages, rc, strerror(-rc));
1136         }
1137     }
1138 }
1139
1140 void qmp_xen_set_global_dirty_log(bool enable, Error **errp)
1141 {
1142     if (enable) {
1143         memory_global_dirty_log_start();
1144     } else {
1145         memory_global_dirty_log_stop();
1146     }
1147 }