usr.sbin/bhyve/mem.c

   1 /*-
   2  * Copyright (c) 2012 NetApp, Inc.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY NETAPP, INC ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL NETAPP, INC OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  * $FreeBSD$
  27  */
  28
  29 /*
  30  * Memory ranges are represented with an RB tree. On insertion, the range
  31  * is checked for overlaps. On lookup, the key has the same base and limit
  32  * so it can be searched within the range.
  33  *
  34  * It is assumed that all setup of ranges takes place in single-threaded
  35  * mode before vCPUs have been started. As such, no locks are used on the
  36  * RB tree. If this is no longer the case, then a r/w lock could be used,
  37  * with readers on the lookup and a writer if the tree needs to be changed
  38  * (and per vCPU caches flushed)
  39  */
  40
  41 #include <sys/cdefs.h>
  42 __FBSDID("$FreeBSD$");
  43
  44 #include <sys/types.h>
  45 #include <sys/tree.h>
  46 #include <sys/errno.h>
  47 #include <machine/vmm.h>
  48
  49 #include <stdio.h>
  50 #include <stdlib.h>
  51 #include <assert.h>
  52
  53 #include "mem.h"
  54 #include "instruction_emul.h"
  55
  56 struct mmio_rb_range {
  57         RB_ENTRY(mmio_rb_range) mr_link;        /* RB tree links */
  58         struct mem_range        mr_param;
  59         uint64_t                mr_base;
  60         uint64_t                mr_end;
  61 };
  62
  63 struct mmio_rb_tree;
  64 RB_PROTOTYPE(mmio_rb_tree, mmio_rb_range, mr_link, mmio_rb_range_compare);
  65
  66 RB_HEAD(mmio_rb_tree, mmio_rb_range) mmio_rbroot;
  67
  68 /*
  69  * Per-vCPU cache. Since most accesses from a vCPU will be to
  70  * consecutive addresses in a range, it makes sense to cache the
  71  * result of a lookup.
  72  */
  73 static struct mmio_rb_range     *mmio_hint[VM_MAXCPU];
  74
  75 static int
  76 mmio_rb_range_compare(struct mmio_rb_range *a, struct mmio_rb_range *b)
  77 {
  78         if (a->mr_end < b->mr_base)
  79                 return (-1);
  80         else if (a->mr_base > b->mr_end)
  81                 return (1);
  82         return (0);
  83 }
  84
  85 static int
  86 mmio_rb_lookup(uint64_t addr, struct mmio_rb_range **entry)
  87 {
  88         struct mmio_rb_range find, *res;
  89
  90         find.mr_base = find.mr_end = addr;
  91
  92         res = RB_FIND(mmio_rb_tree, &mmio_rbroot, &find);
  93
  94         if (res != NULL) {
  95                 *entry = res;
  96                 return (0);
  97         }
  98
  99         return (ENOENT);
 100 }
 101
 102 static int
 103 mmio_rb_add(struct mmio_rb_range *new)
 104 {
 105         struct mmio_rb_range *overlap;
 106
 107         overlap = RB_INSERT(mmio_rb_tree, &mmio_rbroot, new);
 108
 109         if (overlap != NULL) {
 110 #ifdef RB_DEBUG
 111                 printf("overlap detected: new %lx:%lx, tree %lx:%lx\n",
 112                        new->mr_base, new->mr_end,
 113                        overlap->mr_base, overlap->mr_end);
 114 #endif
 115
 116                 return (EEXIST);
 117         }
 118
 119         return (0);
 120 }
 121
 122 #if 0
 123 static void
 124 mmio_rb_dump(void)
 125 {
 126         struct mmio_rb_range *np;
 127
 128         RB_FOREACH(np, mmio_rb_tree, &mmio_rbroot) {
 129                 printf(" %lx:%lx, %s\n", np->mr_base, np->mr_end,
 130                        np->mr_param.name);
 131         }
 132 }
 133 #endif
 134
 135 RB_GENERATE(mmio_rb_tree, mmio_rb_range, mr_link, mmio_rb_range_compare);
 136
 137 int
 138 emulate_mem(struct vmctx *ctx, int vcpu, uint64_t paddr, uint64_t rip,
 139             uint64_t cr3, int mode)
 140 {
 141         struct mmio_rb_range *entry;
 142         int err;
 143
 144         err = 0;
 145
 146         /*
 147          * First check the per-vCPU cache
 148          */
 149         if (mmio_hint[vcpu] &&
 150             paddr >= mmio_hint[vcpu]->mr_base &&
 151             paddr <= mmio_hint[vcpu]->mr_end) {
 152                 err = emulate_instruction(ctx, vcpu, rip, cr3, paddr, mode,
 153                                           &mmio_hint[vcpu]->mr_param);
 154         } else {
 155                 if (mmio_rb_lookup(paddr, &entry)) {
 156                         err = ENOENT;
 157                 } else {
 158                         mmio_hint[vcpu] = entry;
 159                         err = emulate_instruction(ctx, vcpu, rip, cr3, paddr,
 160                                                   mode, &entry->mr_param);
 161                 }
 162         }
 163
 164         return (err);
 165 }
 166
 167 int
 168 register_mem(struct mem_range *memp)
 169 {
 170         struct mmio_rb_range *mrp;
 171         int             err;
 172
 173         err = 0;
 174
 175         mrp = malloc(sizeof(struct mmio_rb_range));
 176
 177         if (mrp != NULL) {
 178                 mrp->mr_param = *memp;
 179                 mrp->mr_base = memp->base;
 180                 mrp->mr_end = memp->base + memp->size - 1;
 181
 182                 err = mmio_rb_add(mrp);
 183                 if (err)
 184                         free(mrp);
 185         } else
 186                 err = ENOMEM;
 187
 188         return (err);
 189 }
 190
 191 void
 192 init_mem(void)
 193 {
 194
 195         RB_INIT(&mmio_rbroot);
 196 }