Home | History | Annotate | Line # | Download | only in libnvmm
nvmm.h revision 1.14 
      1 /*	$NetBSD: nvmm.h,v 1.14 2019/10/23 12:02:55 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 struct nvmm_mem;
     45 
     46 struct nvmm_assist_callbacks {
     47 	void (*io)(struct nvmm_io *);
     48 	void (*mem)(struct nvmm_mem *);
     49 };
     50 
     51 struct nvmm_machine {
     52 	nvmm_machid_t machid;
     53 	struct nvmm_comm_page **pages;
     54 	void *areas; /* opaque */
     55 };
     56 
     57 struct nvmm_vcpu {
     58 	nvmm_cpuid_t cpuid;
     59 	struct nvmm_assist_callbacks cbs;
     60 	struct nvmm_vcpu_state *state;
     61 	struct nvmm_vcpu_event *event;
     62 	struct nvmm_vcpu_exit *exit;
     63 };
     64 
     65 struct nvmm_io {
     66 	struct nvmm_machine *mach;
     67 	struct nvmm_vcpu *vcpu;
     68 	uint64_t port;
     69 	bool in;
     70 	size_t size;
     71 	uint8_t *data;
     72 };
     73 
     74 struct nvmm_mem {
     75 	struct nvmm_machine *mach;
     76 	struct nvmm_vcpu *vcpu;
     77 	gpaddr_t gpa;
     78 	bool write;
     79 	size_t size;
     80 	uint8_t *data;
     81 };
     82 
     83 #define NVMM_VCPU_CONF_CALLBACKS	NVMM_VCPU_CONF_LIBNVMM_BEGIN
     84 
     85 #define NVMM_PROT_READ		0x01
     86 #define NVMM_PROT_WRITE		0x02
     87 #define NVMM_PROT_EXEC		0x04
     88 #define NVMM_PROT_USER		0x08
     89 #define NVMM_PROT_ALL		0x0F
     90 typedef uint64_t nvmm_prot_t;
     91 
     92 int nvmm_capability(struct nvmm_capability *);
     93 
     94 int nvmm_machine_create(struct nvmm_machine *);
     95 int nvmm_machine_destroy(struct nvmm_machine *);
     96 int nvmm_machine_configure(struct nvmm_machine *, uint64_t, void *);
     97 
     98 int nvmm_vcpu_create(struct nvmm_machine *, nvmm_cpuid_t, struct nvmm_vcpu *);
     99 int nvmm_vcpu_destroy(struct nvmm_machine *, struct nvmm_vcpu *);
    100 int nvmm_vcpu_configure(struct nvmm_machine *, struct nvmm_vcpu *, uint64_t,
    101     void *);
    102 int nvmm_vcpu_setstate(struct nvmm_machine *, struct nvmm_vcpu *, uint64_t);
    103 int nvmm_vcpu_getstate(struct nvmm_machine *, struct nvmm_vcpu *, uint64_t);
    104 int nvmm_vcpu_inject(struct nvmm_machine *, struct nvmm_vcpu *);
    105 int nvmm_vcpu_run(struct nvmm_machine *, struct nvmm_vcpu *);
    106 
    107 int nvmm_gpa_map(struct nvmm_machine *, uintptr_t, gpaddr_t, size_t, int);
    108 int nvmm_gpa_unmap(struct nvmm_machine *, uintptr_t, gpaddr_t, size_t);
    109 int nvmm_hva_map(struct nvmm_machine *, uintptr_t, size_t);
    110 int nvmm_hva_unmap(struct nvmm_machine *, uintptr_t, size_t);
    111 
    112 int nvmm_gva_to_gpa(struct nvmm_machine *, struct nvmm_vcpu *, gvaddr_t, gpaddr_t *,
    113     nvmm_prot_t *);
    114 int nvmm_gpa_to_hva(struct nvmm_machine *, gpaddr_t, uintptr_t *,
    115     nvmm_prot_t *);
    116 
    117 int nvmm_assist_io(struct nvmm_machine *, struct nvmm_vcpu *);
    118 int nvmm_assist_mem(struct nvmm_machine *, struct nvmm_vcpu *);
    119 
    120 int nvmm_ctl(int, void *, size_t);
    121 
    122 int nvmm_vcpu_dump(struct nvmm_machine *, struct nvmm_vcpu *);
    123 
    124 #endif /* _LIBNVMM_H_ */
    125