usr.sbin/bhyve/mem.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2012 NetApp, Inc.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY NETAPP, INC ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL NETAPP, INC OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  *
  28  * $FreeBSD$
  29  */
  30
  31 /*
  32  * Memory ranges are represented with an RB tree. On insertion, the range
  33  * is checked for overlaps. On lookup, the key has the same base and limit
  34  * so it can be searched within the range.
  35  */
  36
  37 #include <sys/cdefs.h>
  38 __FBSDID("$FreeBSD$");
  39
  40 #include <sys/types.h>
  41 #include <sys/errno.h>
  42 #include <sys/tree.h>
  43 #include <machine/vmm.h>
  44 #include <machine/vmm_instruction_emul.h>
  45
  46 #include <assert.h>
  47 #include <err.h>
  48 #include <pthread.h>
  49 #include <stdio.h>
  50 #include <stdlib.h>
  51
  52 #include "mem.h"
  53
  54 struct mmio_rb_range {
  55         RB_ENTRY(mmio_rb_range) mr_link;        /* RB tree links */
  56         struct mem_range        mr_param;
  57         uint64_t                mr_base;
  58         uint64_t                mr_end;
  59 };
  60
  61 struct mmio_rb_tree;
  62 RB_PROTOTYPE(mmio_rb_tree, mmio_rb_range, mr_link, mmio_rb_range_compare);
  63
  64 RB_HEAD(mmio_rb_tree, mmio_rb_range) mmio_rb_root, mmio_rb_fallback;
  65
  66 /*
  67  * Per-vCPU cache. Since most accesses from a vCPU will be to
  68  * consecutive addresses in a range, it makes sense to cache the
  69  * result of a lookup.
  70  */
  71 static struct mmio_rb_range     *mmio_hint[VM_MAXCPU];
  72
  73 static pthread_rwlock_t mmio_rwlock;
  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(struct mmio_rb_tree *rbt, uint64_t addr,
  87     struct mmio_rb_range **entry)
  88 {
  89         struct mmio_rb_range find, *res;
  90
  91         find.mr_base = find.mr_end = addr;
  92
  93         res = RB_FIND(mmio_rb_tree, rbt, &find);
  94
  95         if (res != NULL) {
  96                 *entry = res;
  97                 return (0);
  98         }
  99
 100         return (ENOENT);
 101 }
 102
 103 static int
 104 mmio_rb_add(struct mmio_rb_tree *rbt, struct mmio_rb_range *new)
 105 {
 106         struct mmio_rb_range *overlap;
 107
 108         overlap = RB_INSERT(mmio_rb_tree, rbt, new);
 109
 110         if (overlap != NULL) {
 111 #ifdef RB_DEBUG
 112                 printf("overlap detected: new %lx:%lx, tree %lx:%lx\n",
 113                        new->mr_base, new->mr_end,
 114                        overlap->mr_base, overlap->mr_end);
 115 #endif
 116
 117                 return (EEXIST);
 118         }
 119
 120         return (0);
 121 }
 122
 123 #if 0
 124 static void
 125 mmio_rb_dump(struct mmio_rb_tree *rbt)
 126 {
 127         int perror;
 128         struct mmio_rb_range *np;
 129
 130         pthread_rwlock_rdlock(&mmio_rwlock);
 131         RB_FOREACH(np, mmio_rb_tree, rbt) {
 132                 printf(" %lx:%lx, %s\n", np->mr_base, np->mr_end,
 133                        np->mr_param.name);
 134         }
 135         perror = pthread_rwlock_unlock(&mmio_rwlock);
 136         assert(perror == 0);
 137 }
 138 #endif
 139
 140 RB_GENERATE(mmio_rb_tree, mmio_rb_range, mr_link, mmio_rb_range_compare);
 141
 142 static int
 143 mem_read(void *ctx, int vcpu, uint64_t gpa, uint64_t *rval, int size, void *arg)
 144 {
 145         int error;
 146         struct mem_range *mr = arg;
 147
 148         error = (*mr->handler)(ctx, vcpu, MEM_F_READ, gpa, size,
 149                                rval, mr->arg1, mr->arg2);
 150         return (error);
 151 }
 152
 153 static int
 154 mem_write(void *ctx, int vcpu, uint64_t gpa, uint64_t wval, int size, void *arg)
 155 {
 156         int error;
 157         struct mem_range *mr = arg;
 158
 159         error = (*mr->handler)(ctx, vcpu, MEM_F_WRITE, gpa, size,
 160                                &wval, mr->arg1, mr->arg2);
 161         return (error);
 162 }
 163
 164 int
 165 emulate_mem(struct vmctx *ctx, int vcpu, uint64_t paddr, struct vie *vie,
 166     struct vm_guest_paging *paging)
 167
 168 {
 169         struct mmio_rb_range *entry;
 170         int err, perror, immutable;
 171
 172         pthread_rwlock_rdlock(&mmio_rwlock);
 173         /*
 174          * First check the per-vCPU cache
 175          */
 176         if (mmio_hint[vcpu] &&
 177             paddr >= mmio_hint[vcpu]->mr_base &&
 178             paddr <= mmio_hint[vcpu]->mr_end) {
 179                 entry = mmio_hint[vcpu];
 180         } else
 181                 entry = NULL;
 182
 183         if (entry == NULL) {
 184                 if (mmio_rb_lookup(&mmio_rb_root, paddr, &entry) == 0) {
 185                         /* Update the per-vCPU cache */
 186                         mmio_hint[vcpu] = entry;
 187                 } else if (mmio_rb_lookup(&mmio_rb_fallback, paddr, &entry)) {
 188                         perror = pthread_rwlock_unlock(&mmio_rwlock);
 189                         assert(perror == 0);
 190                         return (ESRCH);
 191                 }
 192         }
 193
 194         assert(entry != NULL);
 195
 196         /*
 197          * An 'immutable' memory range is guaranteed to be never removed
 198          * so there is no need to hold 'mmio_rwlock' while calling the
 199          * handler.
 200          *
 201          * XXX writes to the PCIR_COMMAND register can cause register_mem()
 202          * to be called. If the guest is using PCI extended config space
 203          * to modify the PCIR_COMMAND register then register_mem() can
 204          * deadlock on 'mmio_rwlock'. However by registering the extended
 205          * config space window as 'immutable' the deadlock can be avoided.
 206          */
 207         immutable = (entry->mr_param.flags & MEM_F_IMMUTABLE);
 208         if (immutable) {
 209                 perror = pthread_rwlock_unlock(&mmio_rwlock);
 210                 assert(perror == 0);
 211         }
 212
 213         err = vmm_emulate_instruction(ctx, vcpu, paddr, vie, paging,
 214                                       mem_read, mem_write, &entry->mr_param);
 215
 216         if (!immutable) {
 217                 perror = pthread_rwlock_unlock(&mmio_rwlock);
 218                 assert(perror == 0);
 219         }
 220
 221
 222         return (err);
 223 }
 224
 225 static int
 226 register_mem_int(struct mmio_rb_tree *rbt, struct mem_range *memp)
 227 {
 228         struct mmio_rb_range *entry, *mrp;
 229         int err, perror;
 230
 231         err = 0;
 232
 233         mrp = malloc(sizeof(struct mmio_rb_range));
 234         if (mrp == NULL) {
 235                 warn("%s: couldn't allocate memory for mrp\n",
 236                      __func__);
 237                 err = ENOMEM;
 238         } else {
 239                 mrp->mr_param = *memp;
 240                 mrp->mr_base = memp->base;
 241                 mrp->mr_end = memp->base + memp->size - 1;
 242                 pthread_rwlock_wrlock(&mmio_rwlock);
 243                 if (mmio_rb_lookup(rbt, memp->base, &entry) != 0)
 244                         err = mmio_rb_add(rbt, mrp);
 245                 perror = pthread_rwlock_unlock(&mmio_rwlock);
 246                 assert(perror == 0);
 247                 if (err)
 248                         free(mrp);
 249         }
 250
 251         return (err);
 252 }
 253
 254 int
 255 register_mem(struct mem_range *memp)
 256 {
 257
 258         return (register_mem_int(&mmio_rb_root, memp));
 259 }
 260
 261 int
 262 register_mem_fallback(struct mem_range *memp)
 263 {
 264
 265         return (register_mem_int(&mmio_rb_fallback, memp));
 266 }
 267
 268 int
 269 unregister_mem(struct mem_range *memp)
 270 {
 271         struct mem_range *mr;
 272         struct mmio_rb_range *entry = NULL;
 273         int err, perror, i;
 274
 275         pthread_rwlock_wrlock(&mmio_rwlock);
 276         err = mmio_rb_lookup(&mmio_rb_root, memp->base, &entry);
 277         if (err == 0) {
 278                 mr = &entry->mr_param;
 279                 assert(mr->name == memp->name);
 280                 assert(mr->base == memp->base && mr->size == memp->size);
 281                 assert((mr->flags & MEM_F_IMMUTABLE) == 0);
 282                 RB_REMOVE(mmio_rb_tree, &mmio_rb_root, entry);
 283
 284                 /* flush Per-vCPU cache */
 285                 for (i=0; i < VM_MAXCPU; i++) {
 286                         if (mmio_hint[i] == entry)
 287                                 mmio_hint[i] = NULL;
 288                 }
 289         }
 290         perror = pthread_rwlock_unlock(&mmio_rwlock);
 291         assert(perror == 0);
 292
 293         if (entry)
 294                 free(entry);
 295
 296         return (err);
 297 }
 298
 299 void
 300 init_mem(void)
 301 {
 302
 303         RB_INIT(&mmio_rb_root);
 304         RB_INIT(&mmio_rb_fallback);
 305         pthread_rwlock_init(&mmio_rwlock, NULL);
 306 }