Home | History | Annotate | Line # | Download | only in libnvmm
nvmm.h revision 1.13 
      1 /*	$NetBSD: nvmm.h,v 1.13 2019/10/23 07:01:11 maxv Exp $	*/
      2 
      3 /*
      4  * Copyright (c) 2018-2019 The NetBSD Foundation, Inc.
      5  * All rights reserved.
      6  *
      7  * This code is derived from software contributed to The NetBSD Foundation
      8  * by Maxime Villard.
      9  *
     10  * Redistribution and use in source and binary forms, with or without
     11  * modification, are permitted provided that the following conditions
     12  * are met:
     13  * 1. Redistributions of source code must retain the above copyright
     14  *    notice, this list of conditions and the following disclaimer.
     15  * 2. Redistributions in binary form must reproduce the above copyright
     16  *    notice, this list of conditions and the following disclaimer in the
     17  *    documentation and/or other materials provided with the distribution.
     18  *
     19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     29  * POSSIBILITY OF SUCH DAMAGE.
     30  */
     31 
     32 #ifndef _LIBNVMM_H_
     33 #define _LIBNVMM_H_
     34 
     35 #include <stdint.h>
     36 #include <stdbool.h>
     37 
     38 #include <dev/nvmm/nvmm.h>
     39 #include <dev/nvmm/nvmm_ioctl.h>
     40 
     41 #define NVMM_USER_VERSION	1
     42 
     43 struct nvmm_io {
     44 	uint64_t port;
     45 	bool in;
     46 	size_t size;
     47 	uint8_t *data;
     48 };
     49 
     50 struct nvmm_mem {
     51 	gpaddr_t gpa;
     52 	bool write;
     53 	size_t size;
     54 	uint8_t *data;
     55 };
     56 
     57 struct nvmm_callbacks {
     58 	void (*io)(struct nvmm_io *);
     59 	void (*mem)(struct nvmm_mem *);
     60 };
     61 
     62 struct nvmm_machine {
     63 	nvmm_machid_t machid;
     64 	struct nvmm_comm_page **pages;
     65 	void *areas; /* opaque */
     66 	struct nvmm_callbacks cbs;
     67 };
     68 
     69 struct nvmm_vcpu {
     70 	nvmm_cpuid_t cpuid;
     71 	struct nvmm_vcpu_state *state;
     72 	struct nvmm_vcpu_event *event;
     73 	struct nvmm_vcpu_exit *exit;
     74 };
     75 
     76 #define NVMM_MACH_CONF_CALLBACKS	NVMM_MACH_CONF_LIBNVMM_BEGIN
     77 
     78 #define NVMM_PROT_READ		0x01
     79 #define NVMM_PROT_WRITE		0x02
     80 #define NVMM_PROT_EXEC		0x04
     81 #define NVMM_PROT_USER		0x08
     82 #define NVMM_PROT_ALL		0x0F
     83 typedef uint64_t nvmm_prot_t;
     84 
     85 int nvmm_capability(struct nvmm_capability *);
     86 
     87 int nvmm_machine_create(struct nvmm_machine *);
     88 int nvmm_machine_destroy(struct nvmm_machine *);
     89 int nvmm_machine_configure(struct nvmm_machine *, uint64_t, void *);
     90 
     91 int nvmm_vcpu_create(struct nvmm_machine *, nvmm_cpuid_t, struct nvmm_vcpu *);
     92 int nvmm_vcpu_destroy(struct nvmm_machine *, struct nvmm_vcpu *);
     93 int nvmm_vcpu_configure(struct nvmm_machine *, struct nvmm_vcpu *, uint64_t,
     94     void *);
     95 int nvmm_vcpu_setstate(struct nvmm_machine *, struct nvmm_vcpu *, uint64_t);
     96 int nvmm_vcpu_getstate(struct nvmm_machine *, struct nvmm_vcpu *, uint64_t);
     97 int nvmm_vcpu_inject(struct nvmm_machine *, struct nvmm_vcpu *);
     98 int nvmm_vcpu_run(struct nvmm_machine *, struct nvmm_vcpu *);
     99 
    100 int nvmm_gpa_map(struct nvmm_machine *, uintptr_t, gpaddr_t, size_t, int);
    101 int nvmm_gpa_unmap(struct nvmm_machine *, uintptr_t, gpaddr_t, size_t);
    102 int nvmm_hva_map(struct nvmm_machine *, uintptr_t, size_t);
    103 int nvmm_hva_unmap(struct nvmm_machine *, uintptr_t, size_t);
    104 
    105 int nvmm_gva_to_gpa(struct nvmm_machine *, struct nvmm_vcpu *, gvaddr_t, gpaddr_t *,
    106     nvmm_prot_t *);
    107 int nvmm_gpa_to_hva(struct nvmm_machine *, gpaddr_t, uintptr_t *,
    108     nvmm_prot_t *);
    109 
    110 int nvmm_assist_io(struct nvmm_machine *, struct nvmm_vcpu *);
    111 int nvmm_assist_mem(struct nvmm_machine *, struct nvmm_vcpu *);
    112 
    113 int nvmm_ctl(int, void *, size_t);
    114 
    115 int nvmm_vcpu_dump(struct nvmm_machine *, struct nvmm_vcpu *);
    116 
    117 #endif /* _LIBNVMM_H_ */
    118