2 Palacios main control interface
6 #include <linux/kernel.h>
7 #include <linux/module.h>
8 #include <linux/moduleparam.h>
9 #include <linux/errno.h>
10 #include <linux/percpu.h>
12 #include <linux/uaccess.h>
13 #include <linux/device.h>
14 #include <linux/cdev.h>
18 #include <linux/file.h>
19 #include <linux/spinlock.h>
20 #include <linux/kthread.h>
22 #include <linux/proc_fs.h>
23 #include <linux/seq_file.h>
25 #include <palacios/vmm.h>
31 #include "allow_devmem.h"
33 #include "lockcheck.h"
35 #include "linux-exts.h"
37 #include "util-hashtable.h"
40 MODULE_LICENSE("GPL");
43 int cpu_list[NR_CPUS] = {};
45 module_param_array(cpu_list, int, &cpu_list_len, 0644);
46 MODULE_PARM_DESC(cpu_list, "Comma-delimited list of CPUs that Palacios will run on");
48 static int allow_devmem = 0;
49 module_param(allow_devmem, int, 0);
50 MODULE_PARM_DESC(allow_devmem, "Allow general user-space /dev/mem access even if kernel is strict");
52 // Palacios options parameter
54 module_param(options, charp, 0);
55 MODULE_PARM_DESC(options, "Generic options to internal Palacios modules");
61 static int v3_major_num = 0;
63 static struct v3_guest * guest_map[MAX_VMS] = {[0 ... MAX_VMS - 1] = 0};
64 static struct proc_dir_entry * palacios_proc_dir = NULL;
66 struct class * v3_class = NULL;
67 static struct cdev ctrl_dev;
70 // mapping from thread ids to their resource control blocks
71 struct hashtable *v3_thread_resource_map=0;
73 static int register_vm(struct v3_guest * guest) {
76 for (i = 0; i < MAX_VMS; i++) {
77 if (guest_map[i] == NULL) {
88 static long v3_dev_ioctl(struct file * filp,
89 unsigned int ioctl, unsigned long arg) {
90 void __user * argp = (void __user *)arg;
91 DEBUG("V3 IOCTL %d\n", ioctl);
95 case V3_CREATE_GUEST:{
97 struct v3_guest_img user_image;
98 struct v3_guest * guest = palacios_alloc(sizeof(struct v3_guest));
101 ERROR("Palacios: Error allocating Kernel guest_image\n");
105 memset(guest, 0, sizeof(struct v3_guest));
107 INFO("Palacios: Creating V3 Guest...\n");
109 vm_minor = register_vm(guest);
111 if (vm_minor == -1) {
112 ERROR("Palacios Error: Too many VMs are currently running\n");
116 guest->vm_dev = MKDEV(v3_major_num, vm_minor);
118 if (copy_from_user(&user_image, argp, sizeof(struct v3_guest_img))) {
119 ERROR("Palacios Error: copy from user error getting guest image...\n");
123 guest->img_size = user_image.size;
125 DEBUG("Palacios: Allocating kernel memory for guest image (%llu bytes)\n", user_image.size);
126 // overflow possible here, but only if guest image is probably to large for kernel anyway...
127 guest->img = palacios_valloc(guest->img_size);
130 ERROR("Palacios Error: Could not allocate space for guest image\n");
134 if (copy_from_user(guest->img, user_image.guest_data, guest->img_size)) {
135 ERROR("Palacios: Error loading guest data\n");
139 strncpy(guest->name, user_image.name, 128);
140 guest->name[127] = 0;
142 INIT_LIST_HEAD(&(guest->exts));
144 if (create_palacios_vm(guest) == -1) {
145 ERROR("Palacios: Error creating guest\n");
153 palacios_vfree(guest->img);
155 guest_map[vm_minor] = NULL;
157 palacios_free(guest);
163 case V3_FREE_GUEST: {
164 unsigned long vm_idx = arg;
165 struct v3_guest * guest;
167 if (vm_idx >= MAX_VMS) {
168 ERROR("Invalid VM index: %ld\n", vm_idx);
172 guest = guest_map[vm_idx];
175 ERROR("No VM at index %ld\n",vm_idx);
179 INFO("Freeing VM (%s) (%p)\n", guest->name, guest);
181 if (free_palacios_vm(guest)<0) {
182 ERROR("Cannot free guest at index %ld\n",vm_idx);
186 guest_map[vm_idx] = NULL;
189 case V3_ADD_MEMORY: {
190 struct v3_mem_region mem;
192 memset(&mem, 0, sizeof(struct v3_mem_region));
194 if (copy_from_user(&mem, argp, sizeof(struct v3_mem_region))) {
195 ERROR("copy from user error getting mem_region...\n");
199 DEBUG("Adding %llu pages to Palacios memory\n", mem.num_pages);
201 if (add_palacios_memory(&mem) == -1) {
202 ERROR("Error adding memory to Palacios\n");
209 case V3_REMOVE_MEMORY: {
210 struct v3_mem_region mem;
212 memset(&mem, 0, sizeof(struct v3_mem_region));
214 if (copy_from_user(&mem, argp, sizeof(struct v3_mem_region))) {
215 ERROR("copy from user error getting mem_region...\n");
219 DEBUG("Removing memory at address %p\n", (void*)(mem.base_addr));
221 if (remove_palacios_memory(&mem) == -1) {
222 ERROR("Error removing memory from Palacios\n");
231 case V3_RESET_MEMORY: {
232 DEBUG("Resetting memory\n");
233 if (palacios_deinit_mm() == -1) {
234 ERROR("Error deiniting the Palacios memory manager\n");
237 if (palacios_init_mm()) {
238 ERROR("Error initing the Palacios memory manager\n");
245 struct global_ctrl * ctrl = get_global_ctrl(ioctl);
248 return ctrl->handler(ioctl, arg);
251 WARNING("\tUnhandled global ctrl cmd: %d\n", ioctl);
262 static struct file_operations v3_ctrl_fops = {
263 .owner = THIS_MODULE,
264 .unlocked_ioctl = v3_dev_ioctl,
265 .compat_ioctl = v3_dev_ioctl,
270 struct proc_dir_entry *palacios_get_procdir(void)
272 // INFO("Returning procdir=%p\n",palacios_proc_dir);
273 return palacios_proc_dir;
277 #define MAX_CORES 1024
278 #define MAX_REGIONS 1024
279 #define MIN(x,y) ((x)<(y) ? (x) : (y))
281 static int read_guests_details(struct seq_file *s, void *v)
285 uint64_t num_vcores, num_regions;
286 uint64_t alloc_num_vcores, alloc_num_regions;
287 struct v3_vm_base_state *base=0;
288 struct v3_vm_core_state *core=0;
289 struct v3_vm_mem_state *mem=0;
292 base = palacios_valloc(sizeof(struct v3_vm_base_state));
296 ERROR("No space for base state structure\n");
301 for(i = 0; i < MAX_VMS; i++) {
303 if (guest_map[i] != NULL) {
305 v3_get_state_sizes_vm(guest_map[i]->v3_ctx,&num_vcores,&num_regions);
307 alloc_num_vcores = MIN(num_vcores,MAX_CORES);
308 alloc_num_regions = MIN(num_regions,MAX_REGIONS);
310 core = palacios_valloc(sizeof(struct v3_vm_core_state) + alloc_num_vcores*sizeof(struct v3_vm_vcore_state));
313 ERROR("No space for core state structure\n");
317 mem = palacios_valloc(sizeof(struct v3_vm_mem_state) + alloc_num_regions*sizeof(struct v3_vm_mem_region));
320 ERROR("No space for memory state structure\n");
325 "---------------------------------------------------------------------------------------\n");
329 "Device: /dev/v3-vm%d\n",
330 i,guest_map[i]->name, i);
333 core->num_vcores=alloc_num_vcores;
334 mem->num_regions=alloc_num_regions;
336 if (v3_get_state_vm(guest_map[i]->v3_ctx, base, core, mem)) {
337 ERROR("Cannot get VM info\n");
338 seq_printf(s, "<unable to get data for this VM>\n");
343 "Cores: %llu (%llu shown)\n"
344 "Regions: %llu (%llu shown)\n"
345 "Memsize: %llu (%llu ROS)\n\n",
346 base->vm_type==V3_VM_GENERAL ? "general" :
347 base->vm_type==V3_VM_HVM ? "HVM" : "UNKNOWN",
348 base->state==V3_VM_INVALID ? "INVALID" :
349 base->state==V3_VM_RUNNING ? "running" :
350 base->state==V3_VM_STOPPED ? "stopped" :
351 base->state==V3_VM_PAUSED ? "paused" :
352 base->state==V3_VM_ERROR ? "ERROR" :
353 base->state==V3_VM_SIMULATING ? "simulating" :
354 base->state==V3_VM_RESETTING ? "resetting" : "UNKNOWN",
362 seq_printf(s, "Core States\n");
364 for (j=0;j<core->num_vcores;j++) {
366 " vcore %u %s on pcore %lu %llu exits rip=0x%p %s %s %s %s\n",
368 core->vcore[j].state==V3_VCORE_INVALID ? "INVALID" :
369 core->vcore[j].state==V3_VCORE_RUNNING ? "running" :
370 core->vcore[j].state==V3_VCORE_STOPPED ? "stopped" :
371 core->vcore[j].state==V3_VCORE_RESETTING ? "resetting" : "UNKNOWN",
372 core->vcore[j].pcore,
373 core->vcore[j].num_exits,
374 core->vcore[j].last_rip,
375 core->vcore[j].cpu_mode==V3_VCORE_CPU_REAL ? "real" :
376 core->vcore[j].cpu_mode==V3_VCORE_CPU_PROTECTED ? "protected" :
377 core->vcore[j].cpu_mode==V3_VCORE_CPU_PROTECTED_PAE ? "protectedpae" :
378 core->vcore[j].cpu_mode==V3_VCORE_CPU_LONG ? "long" :
379 core->vcore[j].cpu_mode==V3_VCORE_CPU_LONG_32_COMPAT ? "long32" :
380 core->vcore[j].cpu_mode==V3_VCORE_CPU_LONG_16_COMPAT ? "long16" : "UNKNOWN",
381 core->vcore[j].mem_mode==V3_VCORE_MEM_MODE_PHYSICAL ? "physical" :
382 core->vcore[j].mem_mode==V3_VCORE_MEM_MODE_VIRTUAL ? "virtual" : "UNKNOWN",
383 core->vcore[j].mem_state==V3_VCORE_MEM_STATE_SHADOW ? "shadow" :
384 core->vcore[j].mem_state==V3_VCORE_MEM_STATE_NESTED ? "nested" : "UNKNOWN",
385 core->vcore[j].vcore_type==V3_VCORE_GENERAL ? "" :
386 core->vcore[j].vcore_type==V3_VCORE_ROS ? "ros" :
387 core->vcore[j].vcore_type==V3_VCORE_HRT ? "hrt" : "UNKNOWN");
391 seq_printf(s, "\nMemory Regions\n");
392 for (j=0;j<mem->num_regions;j++) {
393 seq_printf(s," region %u has HPAs 0x%016llx-0x%016llx (node %d) GPA 0x%016llx %s %s\n",
394 j, (uint64_t)mem->region[j].host_paddr, (uint64_t)mem->region[j].host_paddr+mem->region[j].size,
395 numa_addr_to_node((uintptr_t)(mem->region[j].host_paddr)),
396 (uint64_t)mem->region[j].guest_paddr,
397 mem->region[j].swapped ? "swapped" : "",
398 mem->region[j].pinned ? "pinned" : "");
403 "---------------------------------------------------------------------------------------\n");
405 palacios_vfree(mem); mem=0;
406 palacios_vfree(core); core=0;
414 if (mem) { palacios_vfree(mem); } // dead code but kept for clarity
415 if (core) { palacios_vfree(core); }
416 if (base) { palacios_vfree(base); }
421 static int read_guests(struct seq_file *s, void *v)
424 struct v3_vm_base_state *base=0;
425 struct v3_vm_core_state *core=0;
426 struct v3_vm_mem_state *mem=0;
427 uint64_t num_vcores, num_regions;
430 INFO("READ GUEST\n");
432 base = palacios_valloc(sizeof(struct v3_vm_base_state));
435 ERROR("No space for base state structure\n");
439 core = palacios_valloc(sizeof(struct v3_vm_core_state));
442 ERROR("No space for core state structure\n");
446 mem = palacios_valloc(sizeof(struct v3_vm_mem_state));
449 ERROR("No space for memory state structure\n");
454 for(i = 0; i < MAX_VMS; i++) {
455 if (guest_map[i] != NULL) {
457 v3_get_state_sizes_vm(guest_map[i]->v3_ctx,&num_vcores,&num_regions);
459 seq_printf(s,"%s\t/dev/v3-vm%d", guest_map[i]->name, i);
461 // Skip getting per core and per-region
465 if (v3_get_state_vm(guest_map[i]->v3_ctx, base, core, mem)) {
466 ERROR("Cannot get VM info\n");
467 seq_printf(s, "\t<unable to get data for this VM>\n");
469 seq_printf(s,"\t%s\t%llu vcores\t%llu regions\t%llu mem\t%s\n",
470 base->state==V3_VM_INVALID ? "INVALID" :
471 base->state==V3_VM_RUNNING ? "running" :
472 base->state==V3_VM_STOPPED ? "stopped" :
473 base->state==V3_VM_PAUSED ? "paused" :
474 base->state==V3_VM_ERROR ? "ERROR" :
475 base->state==V3_VM_SIMULATING ? "simulating" : "UNKNOWN",
479 base->vm_type == V3_VM_GENERAL ? "general" :
480 base->vm_type == V3_VM_HVM ? "hvm" : "UNKNOWN");
487 if (mem) { palacios_vfree(mem); }
488 if (core) { palacios_vfree(core); }
489 if (base) { palacios_vfree(base); }
495 static int guests_short_proc_open(struct inode * inode, struct file * filp)
497 return single_open(filp, read_guests, PAL_PROC_GETDATA(inode));
500 static int guests_full_proc_open(struct inode * inode, struct file * filp)
502 return single_open(filp, read_guests_details, PAL_PROC_GETDATA(inode));
508 static struct file_operations guest_full_proc_ops = {
509 .owner = THIS_MODULE,
510 .open = guests_full_proc_open,
513 .release = single_release,
516 static struct file_operations guest_short_proc_ops = {
517 .owner = THIS_MODULE,
518 .open = guests_short_proc_open,
521 .release = single_release,
524 // Supply basic information that the user-space tools need
525 // to manipulate Palacios. The current use case here is to
526 // convey memory information
527 static int read_info(struct seq_file *s, void *v)
529 uint64_t mem_block_size;
532 seq_printf(s,"kernel MAX_ORDER:\t%d\n",MAX_ORDER);
533 seq_printf(s,"number of nodes:\t%d\n", numa_num_nodes());
534 seq_printf(s,"number of cpus: \t%d\n", num_online_cpus());
535 seq_printf(s,"\npalacios compiled mem_block_size:\t%d\n", V3_CONFIG_MEM_BLOCK_SIZE);
536 if (!v3_lookup_option("mem_block_size")) {
537 mem_block_size = V3_CONFIG_MEM_BLOCK_SIZE;
539 if (strict_strtoull(v3_lookup_option("mem_block_size"), 0, &mem_block_size)) {
544 seq_printf(s,"palacios run-time mem_block_size:\t%llu\n", mem_block_size);
546 seq_printf(s,"\nCPU to node mappings\n");
547 for (i=0;i<num_online_cpus();i++) {
548 seq_printf(s,"cpu %d -> node %d\n", i, numa_cpu_to_node(i));
549 if (numa_cpu_to_node(i)>max_node) {
550 max_node=numa_cpu_to_node(i);
553 seq_printf(s,"\nNode to node distances\n");
554 for (j=0;j<=max_node;j++) {
555 seq_printf(s," \t%2d", j);
558 for (i=0;i<=max_node;i++) {
559 seq_printf(s,"%2d ",i);
560 for (j=0;j<=max_node;j++) {
561 seq_printf(s,"\t%2d", numa_get_distance(i,j));
565 seq_printf(s,"\nCPU to CPU distances\n");
566 for (j=0;j<num_online_cpus();j++) {
567 seq_printf(s," \t%2d", j);
570 for (i=0;i<num_online_cpus();i++) {
571 seq_printf(s,"%2d ",i);
572 for (j=0;j<num_online_cpus();j++) {
573 seq_printf(s,"\t%2d", numa_get_distance(numa_cpu_to_node(i),numa_cpu_to_node(j)));
580 static int info_proc_open(struct inode * inode, struct file * filp)
582 return single_open(filp, read_info, PAL_PROC_GETDATA(inode));
587 static struct file_operations info_proc_ops = {
588 .owner = THIS_MODULE,
589 .open = info_proc_open,
592 .release = single_release,
596 static inline uint_t thr_hash_func(addr_t key)
598 return palacios_hash_long((long)key,64);
601 static inline int thr_hash_comp(addr_t k1, addr_t k2)
606 static int __init v3_init(void) {
608 dev_t dev = MKDEV(0, 0); // We dynamicallly assign the major number
615 if (!(v3_thread_resource_map = palacios_create_htable(MAX_THREADS,thr_hash_func,thr_hash_comp))) {
616 ERROR("Could not create thread/resource map\n");
621 palacios_proc_dir = proc_mkdir("v3vee", NULL);
622 if (!palacios_proc_dir) {
623 ERROR("Could not create proc entry\n");
628 // this will populate the v3vee tree...
629 if (palacios_init_mm()) {
634 palacios_allow_devmem();
637 // numa is now a required interface and we need it
638 // up before primary initiatilization
639 palacios_init_numa();
641 // Initialize Palacios
642 palacios_vmm_init(options);
644 // initialize extensions
645 init_lnx_extensions();
648 v3_class = class_create(THIS_MODULE, "vms");
649 if (!v3_class || IS_ERR(v3_class)) {
650 ERROR("Failed to register V3 VM device class\n");
651 ret = PTR_ERR(v3_class);
655 INFO("intializing V3 Control device\n");
657 ret = alloc_chrdev_region(&dev, 0, MAX_VMS + 1, "v3vee");
660 ERROR("Error registering device region for V3 devices\n");
664 v3_major_num = MAJOR(dev);
666 dev = MKDEV(v3_major_num, MAX_VMS + 1);
669 DEBUG("Creating V3 Control device: Major %d, Minor %d\n", v3_major_num, MINOR(dev));
670 cdev_init(&ctrl_dev, &v3_ctrl_fops);
671 ctrl_dev.owner = THIS_MODULE;
672 ctrl_dev.ops = &v3_ctrl_fops;
673 cdev_add(&ctrl_dev, dev, 1);
675 device_create(v3_class, NULL, dev, NULL, "v3vee");
678 ERROR("Error adding v3 control device\n");
683 struct proc_dir_entry *entry;
685 #define PALPROC(ent, success, error, out_target, fname, perm, parent, fops) \
686 PAL_PROC_CREATE(ent, fname, perm, parent, fops); \
694 PALPROC(entry, "/proc/v3vee/v3-guests succesfully created\n",
695 "Could not create proc entry\n", failure6,
696 "v3-guests", 0444, palacios_proc_dir, &guest_short_proc_ops);
698 PALPROC(entry, "/proc/v3vee/v3-guests-details successfully created\n",
699 "Could not create proc entry\n", failure7,
700 "v3-guests-details", 0444, palacios_proc_dir, &guest_full_proc_ops);
702 PALPROC(entry, "/proc/v3vee/v3-info successfully created\n",
703 "Could not create proc entry\n", failure8,
704 "v3-info", 0444, palacios_proc_dir, &info_proc_ops);
712 remove_proc_entry("v3-guests-details", palacios_proc_dir);
714 remove_proc_entry("v3-guests", palacios_proc_dir);
716 device_destroy(v3_class, dev);
718 unregister_chrdev_region(MKDEV(v3_major_num, 0), MAX_VMS + 1);
720 class_destroy(v3_class);
723 palacios_restore_devmem();
725 palacios_deinit_mm();
727 remove_proc_entry("v3vee", NULL);
729 palacios_free_htable(v3_thread_resource_map,0,0);
738 static void __exit v3_exit(void) {
739 extern u32 pg_allocs;
746 struct v3_guest * guest;
750 /* Stop and free any running VMs */
751 for (i = 0; i < MAX_VMS; i++) {
752 if (guest_map[i] != NULL) {
753 guest = (struct v3_guest *)(guest_map[i]);
755 if (!guest->v3_ctx) {
756 ERROR("Orphan VM detected and skipped: index=%d name=%s\n", i, guest->name);
760 if (v3_stop_vm(guest->v3_ctx) < 0)
761 ERROR("Couldn't stop VM %d\n", i);
763 free_palacios_vm(guest);
768 dev = MKDEV(v3_major_num, MAX_VMS + 1);
770 INFO("Removing V3 Control device\n");
775 palacios_deinit_numa();
777 DEBUG("Palacios Mallocs = %d, Frees = %d\n", mallocs, frees);
778 DEBUG("Palacios Vmallocs = %d, Vfrees = %d\n", vmallocs, vfrees);
779 DEBUG("Palacios Page Allocs = %d, Page Frees = %d\n", pg_allocs, pg_frees);
781 unregister_chrdev_region(MKDEV(v3_major_num, 0), MAX_VMS + 1);
785 device_destroy(v3_class, dev);
786 class_destroy(v3_class);
789 deinit_lnx_extensions();
792 palacios_restore_devmem();
795 palacios_deinit_mm();
797 remove_proc_entry("v3-info", palacios_proc_dir);
798 remove_proc_entry("v3-guests-details", palacios_proc_dir);
799 remove_proc_entry("v3-guests", palacios_proc_dir);
800 remove_proc_entry("v3vee", NULL);
802 DEBUG("Palacios Module Mallocs = %d, Frees = %d\n", mod_allocs, mod_frees);
804 palacios_free_htable(v3_thread_resource_map,0,0);
812 module_init(v3_init);
813 module_exit(v3_exit);
817 void * trace_malloc(size_t size, gfp_t flags) {
821 addr = palacios_alloc_extended(size, flags, -1);
827 void trace_free(const void * objp) {
829 palacios_free((void*)objp);