usr.sbin/bhyve/mem.h

   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 #ifndef _MEM_H_
  30 #define _MEM_H_
  31
  32 #include <sys/linker_set.h>
  33
  34 struct vmctx;
  35
  36 typedef int (*mem_func_t)(struct vmctx *ctx, int vcpu, int dir, uint64_t addr,
  37                           int size, uint64_t *val, void *arg1, long arg2);
  38
  39 struct mem_range {
  40         const char      *name;
  41         int             flags;
  42         mem_func_t      handler;
  43         void            *arg1;
  44         long            arg2;
  45         uint64_t        base;
  46         uint64_t        size;
  47 };
  48 #define MEM_F_READ              0x1
  49 #define MEM_F_WRITE             0x2
  50 #define MEM_F_RW                0x3
  51 #define MEM_F_IMMUTABLE         0x4     /* mem_range cannot be unregistered */
  52
  53 void    init_mem(void);
  54 int     emulate_mem(struct vmctx *, int vcpu, uint64_t paddr, struct vie *vie,
  55                     struct vm_guest_paging *paging);
  56
  57 int     register_mem(struct mem_range *memp);
  58 int     register_mem_fallback(struct mem_range *memp);
  59 int     unregister_mem(struct mem_range *memp);
  60
  61 #endif  /* _MEM_H_ */