xref: /kvmtool/include/kvm/kvm.h (revision 7eff9f4904b32c4a2a4f09a0cdc0090c7d441bd5)
1ae1fae34SPekka Enberg #ifndef KVM__KVM_H
2ae1fae34SPekka Enberg #define KVM__KVM_H
3ae1fae34SPekka Enberg 
4af7b0868SMatt Evans #include "kvm/kvm-arch.h"
5da8883c1SPekka Enberg 
6ae1fae34SPekka Enberg #include <stdbool.h>
73fdf659dSSasha Levin #include <linux/types.h>
8ce79f1caSPekka Enberg #include <time.h>
982d2f21eSSasha Levin #include <signal.h>
10ae1fae34SPekka Enberg 
11b1c2516bSSasha Levin #define SIGKVMEXIT		(SIGRTMIN + 0)
124298ddadSSasha Levin #define SIGKVMPAUSE		(SIGRTMIN + 1)
1349e5227dSSasha Levin 
1482d65b5eSSasha Levin #define KVM_PID_FILE_PATH	"/.kvm-tools/"
1582d65b5eSSasha Levin #define HOME_DIR		getenv("HOME")
16ee8b1456SWanlong Gao #define KVM_BINARY_NAME		"lkvm"
1782d65b5eSSasha Levin 
18af7b0868SMatt Evans #define PAGE_SIZE (sysconf(_SC_PAGE_SIZE))
19ae1fae34SPekka Enberg 
20af7b0868SMatt Evans #define DEFINE_KVM_EXT(ext)		\
21af7b0868SMatt Evans 	.name = #ext,			\
22af7b0868SMatt Evans 	.code = ext
230c7c14a7SCyrill Gorcunov 
24af7b0868SMatt Evans struct kvm_ext {
255358b0e6SSasha Levin 	const char *name;
26af7b0868SMatt Evans 	int code;
27ae1fae34SPekka Enberg };
28ae1fae34SPekka Enberg 
299667701cSPekka Enberg void kvm__set_dir(const char *fmt, ...);
309667701cSPekka Enberg const char *kvm__get_dir(void);
319667701cSPekka Enberg 
3261061257SMatt Evans struct kvm *kvm__init(const char *kvm_dev, const char *hugetlbfs_path, u64 ram_size, const char *name);
338259b8ccSSasha Levin int kvm__recommended_cpus(struct kvm *kvm);
3443835ac9SSasha Levin int kvm__max_cpus(struct kvm *kvm);
3543835ac9SSasha Levin void kvm__init_ram(struct kvm *kvm);
3643835ac9SSasha Levin void kvm__delete(struct kvm *kvm);
372065a6f7SCyrill Gorcunov bool kvm__load_kernel(struct kvm *kvm, const char *kernel_filename,
3853861c74SJohn Floren 			const char *initrd_filename, const char *kernel_cmdline, u16 vidmode);
3943835ac9SSasha Levin void kvm__start_timer(struct kvm *kvm);
4043835ac9SSasha Levin void kvm__stop_timer(struct kvm *kvm);
4143835ac9SSasha Levin void kvm__irq_line(struct kvm *kvm, int irq, int level);
42bfaed61cSSasha Levin void kvm__irq_trigger(struct kvm *kvm, int irq);
4343835ac9SSasha Levin bool kvm__emulate_io(struct kvm *kvm, u16 port, void *data, int direction, int size, u32 count);
4443835ac9SSasha Levin bool kvm__emulate_mmio(struct kvm *kvm, u64 phys_addr, u8 *data, u32 len, u8 is_write);
4596feb589SPekka Enberg void kvm__register_mem(struct kvm *kvm, u64 guest_phys, u64 size, void *userspace_addr);
469aa9d62aSSasha Levin bool kvm__register_mmio(struct kvm *kvm, u64 phys_addr, u64 phys_addr_len, bool coalesce,
479aa9d62aSSasha Levin 			void (*mmio_fn)(u64 addr, u8 *data, u32 len, u8 is_write, void *ptr),
489aa9d62aSSasha Levin 			void *ptr);
4973f7e5b3SSasha Levin bool kvm__deregister_mmio(struct kvm *kvm, u64 phys_addr);
504298ddadSSasha Levin void kvm__pause(void);
514298ddadSSasha Levin void kvm__continue(void);
524298ddadSSasha Levin void kvm__notify_paused(void);
534b1addaeSSasha Levin int kvm__get_sock_by_instance(const char *name);
54886af5f2SLiming Wang int kvm__enumerate_instances(int (*callback)(const char *name, int pid));
554b1addaeSSasha Levin void kvm__remove_socket(const char *name);
56ae1fae34SPekka Enberg 
578e704a7aSMatt Evans void kvm__arch_set_cmdline(char *cmdline, bool video);
58*7eff9f49SWanlong Gao void kvm__arch_init(struct kvm *kvm, const char *hugetlbfs_path, u64 ram_size);
59f7f9d02bSCyrill Gorcunov int kvm__arch_setup_firmware(struct kvm *kvm);
60af7b0868SMatt Evans bool kvm__arch_cpu_supports_vm(void);
610b69bdefSMatt Evans void kvm__arch_periodic_poll(struct kvm *kvm);
62af7b0868SMatt Evans 
63604dbd63SMatt Evans int load_flat_binary(struct kvm *kvm, int fd_kernel, int fd_initrd, const char *kernel_cmdline);
64af7b0868SMatt Evans bool load_bzimage(struct kvm *kvm, int fd_kernel, int fd_initrd, const char *kernel_cmdline, u16 vidmode);
65af7b0868SMatt Evans 
66ae1fae34SPekka Enberg /*
67ae1fae34SPekka Enberg  * Debugging
68ae1fae34SPekka Enberg  */
6943835ac9SSasha Levin void kvm__dump_mem(struct kvm *kvm, unsigned long addr, unsigned long size);
70ae1fae34SPekka Enberg 
71ae1fae34SPekka Enberg extern const char *kvm_exit_reasons[];
72ae1fae34SPekka Enberg 
7343835ac9SSasha Levin static inline bool host_ptr_in_ram(struct kvm *kvm, void *p)
749292f776SCyrill Gorcunov {
7543835ac9SSasha Levin 	return kvm->ram_start <= p && p < (kvm->ram_start + kvm->ram_size);
769292f776SCyrill Gorcunov }
779292f776SCyrill Gorcunov 
7843835ac9SSasha Levin static inline void *guest_flat_to_host(struct kvm *kvm, unsigned long offset)
799292f776SCyrill Gorcunov {
8043835ac9SSasha Levin 	return kvm->ram_start + offset;
819292f776SCyrill Gorcunov }
829292f776SCyrill Gorcunov 
831d6fb3f2SSasha Levin bool kvm__supports_extension(struct kvm *kvm, unsigned int extension);
846930e42fSSasha Levin 
85ae1fae34SPekka Enberg #endif /* KVM__KVM_H */
86