Palacios Public Git Repository

To checkout Palacios execute

  git clone http://v3vee.org/palacios/palacios.web/palacios.git
This will give you the master branch. You probably want the devel branch or one of the release branches. To switch to the devel branch, simply execute
  cd palacios
  git checkout --track -b devel origin/devel
The other branches are similar.


Live Migration Functionality
[palacios.git] / palacios / src / palacios / vmm.c
1 /* 
2  * This file is part of the Palacios Virtual Machine Monitor developed
3  * by the V3VEE Project with funding from the United States National 
4  * Science Foundation and the Department of Energy.  
5  *
6  * The V3VEE Project is a joint project between Northwestern University
7  * and the University of New Mexico.  You can find out more at 
8  * http://www.v3vee.org
9  *
10  * Copyright (c) 2008, Jack Lange <jarusl@cs.northwestern.edu> 
11  * Copyright (c) 2008, The V3VEE Project <http://www.v3vee.org> 
12  * All rights reserved.
13  *
14  * Author: Jack Lange <jarusl@cs.northwestern.edu>
15  *
16  * This is free software.  You are permitted to use,
17  * redistribute, and modify it as specified in the file "V3VEE_LICENSE".
18  */
19
20 #include <palacios/vmm.h>
21 #include <palacios/vmm_intr.h>
22 #include <palacios/vmm_config.h>
23 #include <palacios/vm_guest.h>
24 #include <palacios/vmm_ctrl_regs.h>
25 #include <palacios/vmm_lowlevel.h>
26 #include <palacios/vmm_sprintf.h>
27 #include <palacios/vmm_extensions.h>
28 #include <palacios/vmm_timeout.h>
29
30
31 #ifdef V3_CONFIG_SVM
32 #include <palacios/svm.h>
33 #endif
34 #ifdef V3_CONFIG_VMX
35 #include <palacios/vmx.h>
36 #endif
37
38 #ifdef V3_CONFIG_CHECKPOINT
39 #include <palacios/vmm_checkpoint.h>
40 #endif
41
42
43 v3_cpu_arch_t v3_cpu_types[V3_CONFIG_MAX_CPUS];
44 v3_cpu_arch_t v3_mach_type = V3_INVALID_CPU;
45
46 struct v3_os_hooks * os_hooks = NULL;
47 int v3_dbg_enable = 0;
48
49
50
51
52 static void init_cpu(void * arg) {
53     uint32_t cpu_id = (uint32_t)(addr_t)arg;
54
55 #ifdef V3_CONFIG_SVM
56     if (v3_is_svm_capable()) {
57         PrintDebug("Machine is SVM Capable\n");
58         v3_init_svm_cpu(cpu_id);
59         
60     } else 
61 #endif
62 #ifdef V3_CONFIG_VMX
63     if (v3_is_vmx_capable()) {
64         PrintDebug("Machine is VMX Capable\n");
65         v3_init_vmx_cpu(cpu_id);
66
67     } else 
68 #endif
69     {
70        PrintError("CPU has no virtualization Extensions\n");
71     }
72 }
73
74
75 static void deinit_cpu(void * arg) {
76     uint32_t cpu_id = (uint32_t)(addr_t)arg;
77
78
79     switch (v3_cpu_types[cpu_id]) {
80 #ifdef V3_CONFIG_SVM
81         case V3_SVM_CPU:
82         case V3_SVM_REV3_CPU:
83             PrintDebug("Deinitializing SVM CPU %d\n", cpu_id);
84             v3_deinit_svm_cpu(cpu_id);
85             break;
86 #endif
87 #ifdef V3_CONFIG_VMX
88         case V3_VMX_CPU:
89         case V3_VMX_EPT_CPU:
90         case V3_VMX_EPT_UG_CPU:
91             PrintDebug("Deinitializing VMX CPU %d\n", cpu_id);
92             v3_deinit_vmx_cpu(cpu_id);
93             break;
94 #endif
95         case V3_INVALID_CPU:
96         default:
97             PrintError("CPU has no virtualization Extensions\n");
98             break;
99     }
100 }
101
102
103 void Init_V3(struct v3_os_hooks * hooks, char * cpu_mask, int num_cpus) {
104     int i = 0;
105     int minor = 0;
106     int major = 0;
107
108     V3_Print("V3 Print statement to fix a Kitten page fault bug\n");
109
110     // Set global variables. 
111     os_hooks = hooks;
112
113     // Determine the global machine type
114     v3_mach_type = V3_INVALID_CPU;
115
116     for (i = 0; i < V3_CONFIG_MAX_CPUS; i++) {
117         v3_cpu_types[i] = V3_INVALID_CPU;
118     }
119
120     // Register all the possible device types
121     V3_init_devices();
122
123     // Register all shadow paging handlers
124     V3_init_shdw_paging();
125
126     // Register all extensions
127     V3_init_extensions();
128
129
130 #ifdef V3_CONFIG_SYMMOD
131     V3_init_symmod();
132 #endif
133
134 #ifdef V3_CONFIG_CHECKPOINT
135     V3_init_checkpoint();
136 #endif
137
138     if ((hooks) && (hooks->call_on_cpu)) {
139
140         for (i = 0; i < num_cpus; i++) {
141             major = i / 8;
142             minor = i % 8;
143
144             if ((cpu_mask == NULL) || (*(cpu_mask + major) & (0x1 << minor))) {
145                 V3_Print("Initializing VMM extensions on cpu %d\n", i);
146                 hooks->call_on_cpu(i, &init_cpu, (void *)(addr_t)i);
147
148                 if (v3_mach_type == V3_INVALID_CPU) {
149                     v3_mach_type = v3_cpu_types[i];
150                 }   
151             }
152         }
153     }
154 }
155
156
157
158 void Shutdown_V3() {
159     int i;
160
161     V3_deinit_devices();
162     V3_deinit_shdw_paging();
163
164     V3_deinit_extensions();
165
166 #ifdef V3_CONFIG_SYMMOD
167     V3_deinit_symmod();
168 #endif
169
170 #ifdef V3_CONFIG_CHECKPOINT
171     V3_deinit_checkpoint();
172 #endif
173
174
175     if ((os_hooks) && (os_hooks->call_on_cpu)) {
176         for (i = 0; i < V3_CONFIG_MAX_CPUS; i++) {
177             if (v3_cpu_types[i] != V3_INVALID_CPU) {
178                 V3_Call_On_CPU(i, deinit_cpu, (void *)(addr_t)i);
179                 //deinit_cpu((void *)(addr_t)i);
180             }
181         }
182     }
183
184 }
185
186
187 v3_cpu_arch_t v3_get_cpu_type(int cpu_id) {
188     return v3_cpu_types[cpu_id];
189 }
190
191
192 struct v3_vm_info * v3_create_vm(void * cfg, void * priv_data, char * name) {
193     struct v3_vm_info * vm = v3_config_guest(cfg, priv_data);
194
195     if (vm == NULL) {
196         PrintError("Could not configure guest\n");
197         return NULL;
198     }
199
200     V3_Print("CORE 0 RIP=%p\n", (void *)(addr_t)(vm->cores[0].rip));
201
202     if (name == NULL) {
203         name = "[V3_VM]";
204     } else if (strlen(name) >= 128) {
205         PrintError("VM name is too long. Will be truncated to 128 chars.\n");
206     }
207
208     memset(vm->name, 0, 128);
209     strncpy(vm->name, name, 127);
210
211     return vm;
212 }
213
214
215
216
217 static int start_core(void * p)
218 {
219     struct guest_info * core = (struct guest_info *)p;
220
221
222     PrintDebug("virtual core %u (on logical core %u): in start_core (RIP=%p)\n", 
223                core->vcpu_id, core->pcpu_id, (void *)(addr_t)core->rip);
224
225     switch (v3_mach_type) {
226 #ifdef V3_CONFIG_SVM
227         case V3_SVM_CPU:
228         case V3_SVM_REV3_CPU:
229             return v3_start_svm_guest(core);
230             break;
231 #endif
232 #if V3_CONFIG_VMX
233         case V3_VMX_CPU:
234         case V3_VMX_EPT_CPU:
235         case V3_VMX_EPT_UG_CPU:
236             return v3_start_vmx_guest(core);
237             break;
238 #endif
239         default:
240             PrintError("Attempting to enter a guest on an invalid CPU\n");
241             return -1;
242     }
243     // should not happen
244     return 0;
245 }
246
247
248 // For the moment very ugly. Eventually we will shift the cpu_mask to an arbitrary sized type...
249 #define MAX_CORES 32
250
251
252 int v3_start_vm(struct v3_vm_info * vm, unsigned int cpu_mask) {
253     uint32_t i;
254     uint8_t * core_mask = (uint8_t *)&cpu_mask; // This is to make future expansion easier
255     uint32_t avail_cores = 0;
256     int vcore_id = 0;
257
258
259     if (vm->run_state != VM_STOPPED) {
260         PrintError("VM has already been launched (state=%d)\n", (int)vm->run_state);
261         return -1;
262     }
263
264     /// CHECK IF WE ARE MULTICORE ENABLED....
265
266     V3_Print("V3 --  Starting VM (%u cores)\n", vm->num_cores);
267     V3_Print("CORE 0 RIP=%p\n", (void *)(addr_t)(vm->cores[0].rip));
268
269
270     // Check that enough cores are present in the mask to handle vcores
271     for (i = 0; i < MAX_CORES; i++) {
272         int major = i / 8;
273         int minor = i % 8;
274         
275         if (core_mask[major] & (0x1 << minor)) {
276             if (v3_cpu_types[i] == V3_INVALID_CPU) {
277                 core_mask[major] &= ~(0x1 << minor);
278             } else {
279                 avail_cores++;
280             }
281         }
282     }
283
284
285     if (vm->num_cores > avail_cores) {
286         PrintError("Attempted to start a VM with too many cores (vm->num_cores = %d, avail_cores = %d, MAX=%d)\n", 
287                    vm->num_cores, avail_cores, MAX_CORES);
288         return -1;
289     }
290
291     vm->run_state = VM_RUNNING;
292
293     // Spawn off threads for each core. 
294     // We work backwards, so that core 0 is always started last.
295     for (i = 0, vcore_id = vm->num_cores - 1; (i < MAX_CORES) && (vcore_id >= 0); i++) {
296         int major = 0;
297         int minor = 0;
298         struct guest_info * core = &(vm->cores[vcore_id]);
299         char * specified_cpu = v3_cfg_val(core->core_cfg_data, "target_cpu");
300         uint32_t core_idx = 0;
301
302         if (specified_cpu != NULL) {
303             core_idx = atoi(specified_cpu);
304             
305             if ((core_idx < 0) || (core_idx >= MAX_CORES)) {
306                 PrintError("Target CPU out of bounds (%d) (MAX_CORES=%d)\n", core_idx, MAX_CORES);
307             }
308
309             i--; // We reset the logical core idx. Not strictly necessary I guess... 
310         } else {
311             core_idx = i;
312         }
313
314         major = core_idx / 8;
315         minor = core_idx % 8;
316
317         if ((core_mask[major] & (0x1 << minor)) == 0) {
318             PrintError("Logical CPU %d not available for virtual core %d; not started\n",
319                        core_idx, vcore_id);
320
321             if (specified_cpu != NULL) {
322                 PrintError("CPU was specified explicitly (%d). HARD ERROR\n", core_idx);
323                 v3_stop_vm(vm);
324                 return -1;
325             }
326
327             continue;
328         }
329
330         PrintDebug("Starting virtual core %u on logical core %u\n", 
331                    vcore_id, core_idx);
332         
333         sprintf(core->exec_name, "%s-%u", vm->name, vcore_id);
334
335         PrintDebug("run: core=%u, func=0x%p, arg=0x%p, name=%s\n",
336                    core_idx, start_core, core, core->exec_name);
337
338         core->core_run_state = CORE_STOPPED;  // core zero will turn itself on
339         core->pcpu_id = core_idx;
340         core->core_thread = V3_CREATE_THREAD_ON_CPU(core_idx, start_core, core, core->exec_name);
341
342         if (core->core_thread == NULL) {
343             PrintError("Thread launch failed\n");
344             v3_stop_vm(vm);
345             return -1;
346         }
347
348         vcore_id--;
349     }
350
351     if (vcore_id >= 0) {
352         PrintError("Error starting VM: Not enough available CPU cores\n");
353         v3_stop_vm(vm);
354         return -1;
355     }
356
357
358     return 0;
359
360 }
361
362
363 int v3_reset_vm_core(struct guest_info * core, addr_t rip) {
364     
365     switch (v3_cpu_types[core->pcpu_id]) {
366 #ifdef V3_CONFIG_SVM
367         case V3_SVM_CPU:
368         case V3_SVM_REV3_CPU:
369             PrintDebug("Resetting SVM Guest CPU %d\n", core->vcpu_id);
370             return v3_reset_svm_vm_core(core, rip);
371 #endif
372 #ifdef V3_CONFIG_VMX
373         case V3_VMX_CPU:
374         case V3_VMX_EPT_CPU:
375         case V3_VMX_EPT_UG_CPU:
376             PrintDebug("Resetting VMX Guest CPU %d\n", core->vcpu_id);
377             return v3_reset_vmx_vm_core(core, rip);
378 #endif
379         case V3_INVALID_CPU:
380         default:
381             PrintError("CPU has no virtualization Extensions\n");
382             break;
383     }
384
385     return -1;
386 }
387
388
389
390 /* move a virtual core to different physical core */
391 int v3_move_vm_core(struct v3_vm_info * vm, int vcore_id, int target_cpu) {
392     struct guest_info * core = NULL;
393
394     if ((vcore_id < 0) || (vcore_id >= vm->num_cores)) {
395         PrintError("Attempted to migrate invalid virtual core (%d)\n", vcore_id);
396         return -1;
397     }
398
399     core = &(vm->cores[vcore_id]);
400
401     if (target_cpu == core->pcpu_id) {
402         PrintError("Attempted to migrate to local core (%d)\n", target_cpu);
403         // well that was pointless
404         return 0;
405     }
406
407     if (core->core_thread == NULL) {
408         PrintError("Attempted to migrate a core without a valid thread context\n");
409         return -1;
410     }
411
412     while (v3_raise_barrier(vm, NULL) == -1);
413
414     V3_Print("Performing Migration from %d to %d\n", core->pcpu_id, target_cpu);
415
416     // Double check that we weren't preemptively migrated
417     if (target_cpu != core->pcpu_id) {    
418
419         V3_Print("Moving Core\n");
420
421
422 #ifdef V3_CONFIG_VMX
423         switch (v3_cpu_types[core->pcpu_id]) {
424             case V3_VMX_CPU:
425             case V3_VMX_EPT_CPU:
426             case V3_VMX_EPT_UG_CPU:
427                 PrintDebug("Flushing VMX Guest CPU %d\n", core->vcpu_id);
428                 V3_Call_On_CPU(core->pcpu_id, (void (*)(void *))v3_flush_vmx_vm_core, (void *)core);
429                 break;
430             default:
431                 break;
432         }
433 #endif
434
435         if (V3_MOVE_THREAD_TO_CPU(target_cpu, core->core_thread) != 0) {
436             PrintError("Failed to move Vcore %d to CPU %d\n", 
437                        core->vcpu_id, target_cpu);
438             v3_lower_barrier(vm);
439             return -1;
440         } 
441         
442         /* There will be a benign race window here:
443            core->pcpu_id will be set to the target core before its fully "migrated"
444            However the core will NEVER run on the old core again, its just in flight to the new core
445         */
446         core->pcpu_id = target_cpu;
447
448         V3_Print("core now at %d\n", core->pcpu_id);    
449     }
450
451     v3_lower_barrier(vm);
452
453     return 0;
454 }
455
456
457
458 int v3_stop_vm(struct v3_vm_info * vm) {
459
460     vm->run_state = VM_STOPPED;
461
462     // Sanity check to catch any weird execution states
463     if (v3_wait_for_barrier(vm, NULL) == 0) {
464         v3_lower_barrier(vm);
465     }
466     
467     // XXX force exit all cores via a cross call/IPI XXX
468
469     while (1) {
470         int i = 0;
471         int still_running = 0;
472
473         for (i = 0; i < vm->num_cores; i++) {
474             if (vm->cores[i].core_run_state != CORE_STOPPED) {
475                 still_running = 1;
476             }
477         }
478
479         if (still_running == 0) {
480             break;
481         }
482
483         v3_yield(NULL,-1);
484     }
485     
486     V3_Print("VM stopped. Returning\n");
487
488     return 0;
489 }
490
491
492 int v3_pause_vm(struct v3_vm_info * vm) {
493
494     if (vm->run_state != VM_RUNNING) {
495         PrintError("Tried to pause a VM that was not running\n");
496         return -1;
497     }
498
499     while (v3_raise_barrier(vm, NULL) == -1);
500
501     vm->run_state = VM_PAUSED;
502
503     return 0;
504 }
505
506
507 int v3_continue_vm(struct v3_vm_info * vm) {
508
509     if (vm->run_state != VM_PAUSED) {
510         PrintError("Tried to continue a VM that was not paused\n");
511         return -1;
512     }
513
514     vm->run_state = VM_RUNNING;
515
516     v3_lower_barrier(vm);
517
518     return 0;
519 }
520
521
522
523 static int sim_callback(struct guest_info * core, void * private_data) {
524     struct v3_bitmap * timeout_map = private_data;
525
526     v3_bitmap_set(timeout_map, core->vcpu_id);
527     
528     V3_Print("Simulation callback activated (guest_rip=%p)\n", (void *)core->rip);
529
530     while (v3_bitmap_check(timeout_map, core->vcpu_id) == 1) {
531         v3_yield(NULL,-1);
532     }
533
534     return 0;
535 }
536
537
538
539
540 int v3_simulate_vm(struct v3_vm_info * vm, unsigned int msecs) {
541     struct v3_bitmap timeout_map;
542     int i = 0;
543     int all_blocked = 0;
544     uint64_t cycles = 0;
545     uint64_t cpu_khz = V3_CPU_KHZ();
546
547     if (vm->run_state != VM_PAUSED) {
548         PrintError("VM must be paused before simulation begins\n");
549         return -1;
550     }
551
552     /* AT this point VM is paused */
553     
554     // initialize bitmap
555     v3_bitmap_init(&timeout_map, vm->num_cores);
556
557
558
559
560     // calculate cycles from msecs...
561     // IMPORTANT: Floating point not allowed.
562     cycles = (msecs * cpu_khz);
563     
564
565
566     V3_Print("Simulating %u msecs (%llu cycles) [CPU_KHZ=%llu]\n", msecs, cycles, cpu_khz);
567
568     // set timeout
569     
570     for (i = 0; i < vm->num_cores; i++) {
571         if (v3_add_core_timeout(&(vm->cores[i]), cycles, sim_callback, &timeout_map) == -1) {
572             PrintError("Could not register simulation timeout for core %d\n", i);
573             return -1;
574         }
575     }
576
577     V3_Print("timeouts set on all cores\n ");
578
579     
580     // Run the simulation
581 //    vm->run_state = VM_SIMULATING;
582     vm->run_state = VM_RUNNING;
583     v3_lower_barrier(vm);
584
585
586     V3_Print("Barrier lowered: We are now Simulating!!\n");
587
588     // block until simulation is complete    
589     while (all_blocked == 0) {
590         all_blocked = 1;
591
592         for (i = 0; i < vm->num_cores; i++) {
593             if (v3_bitmap_check(&timeout_map, i)  == 0) {
594                 all_blocked = 0;
595             }
596         }
597
598         if (all_blocked == 1) {
599             break;
600         }
601
602         v3_yield(NULL,-1);
603     }
604
605
606     V3_Print("Simulation is complete\n");
607
608     // Simulation is complete
609     // Reset back to PAUSED state
610
611     v3_raise_barrier_nowait(vm, NULL);
612     vm->run_state = VM_PAUSED;
613     
614     v3_bitmap_reset(&timeout_map);
615
616     v3_wait_for_barrier(vm, NULL);
617
618     return 0;
619
620 }
621
622 #ifdef V3_CONFIG_CHECKPOINT
623 #include <palacios/vmm_checkpoint.h>
624
625 int v3_save_vm(struct v3_vm_info * vm, char * store, char * url) {
626     return v3_chkpt_save_vm(vm, store, url);
627 }
628
629
630 int v3_load_vm(struct v3_vm_info * vm, char * store, char * url) {
631     return v3_chkpt_load_vm(vm, store, url);
632 }
633
634 #ifdef V3_CONFIG_LIVE_MIGRATION
635 int v3_send_vm(struct v3_vm_info * vm, char * store, char * url) {
636     return v3_chkpt_send_vm(vm, store, url);
637 }
638
639
640 int v3_receive_vm(struct v3_vm_info * vm, char * store, char * url) {
641     return v3_chkpt_receive_vm(vm, store, url);
642 }
643 #endif
644
645 #endif
646
647
648 int v3_free_vm(struct v3_vm_info * vm) {
649     int i = 0;
650     // deinitialize guest (free memory, etc...)
651
652     v3_free_vm_devices(vm);
653
654     // free cores
655     for (i = 0; i < vm->num_cores; i++) {
656         v3_free_core(&(vm->cores[i]));
657     }
658
659     // free vm
660     v3_free_vm_internal(vm);
661
662     v3_free_config(vm);
663
664     V3_Free(vm);
665
666     return 0;
667 }
668
669
670 #ifdef __V3_32BIT__
671
672 v3_cpu_mode_t v3_get_host_cpu_mode() {
673     uint32_t cr4_val;
674     struct cr4_32 * cr4;
675
676     __asm__ (
677              "movl %%cr4, %0; "
678              : "=r"(cr4_val) 
679              );
680
681     
682     cr4 = (struct cr4_32 *)&(cr4_val);
683
684     if (cr4->pae == 1) {
685         return PROTECTED_PAE;
686     } else {
687         return PROTECTED;
688     }
689 }
690
691 #elif __V3_64BIT__
692
693 v3_cpu_mode_t v3_get_host_cpu_mode() {
694     return LONG;
695 }
696
697 #endif 
698
699
700
701
702
703 void v3_yield_cond(struct guest_info * info, int usec) {
704     uint64_t cur_cycle;
705     cur_cycle = v3_get_host_time(&info->time_state);
706
707     if (cur_cycle > (info->yield_start_cycle + info->vm_info->yield_cycle_period)) {
708         //PrintDebug("Conditional Yield (cur_cyle=%p, start_cycle=%p, period=%p)\n", 
709         //           (void *)cur_cycle, (void *)info->yield_start_cycle, 
710         //         (void *)info->yield_cycle_period);
711         
712         if (usec < 0) { 
713             V3_Yield();
714         } else {
715             V3_Yield_Timed(usec);
716         }
717
718         info->yield_start_cycle +=  info->vm_info->yield_cycle_period;
719     }
720 }
721
722
723 /* 
724  * unconditional cpu yield 
725  * if the yielding thread is a guest context, the guest quantum is reset on resumption 
726  * Non guest context threads should call this function with a NULL argument
727  *
728  * usec <0  => the non-timed yield is used
729  * usec >=0 => the timed yield is used, which also usually implies interruptible
730  */ 
731 void v3_yield(struct guest_info * info, int usec) {
732     if (usec < 0) { 
733         V3_Yield();
734     } else {
735         V3_Yield_Timed(usec);
736     }
737
738     if (info) {
739         info->yield_start_cycle +=  info->vm_info->yield_cycle_period;
740     }
741 }
742
743
744
745
746 void v3_print_cond(const char * fmt, ...) {
747     if (v3_dbg_enable == 1) {
748         char buf[2048];
749         va_list ap;
750
751         va_start(ap, fmt);
752         vsnprintf(buf, 2048, fmt, ap);
753         va_end(ap);
754
755         V3_Print("%s", buf);
756     }    
757 }
758
759
760
761 void v3_interrupt_cpu(struct v3_vm_info * vm, int logical_cpu, int vector) {
762     extern struct v3_os_hooks * os_hooks;
763
764     if ((os_hooks) && (os_hooks)->interrupt_cpu) {
765         (os_hooks)->interrupt_cpu(vm, logical_cpu, vector);
766     }
767 }
768
769
770
771 int v3_vm_enter(struct guest_info * info) {
772     switch (v3_mach_type) {
773 #ifdef V3_CONFIG_SVM
774         case V3_SVM_CPU:
775         case V3_SVM_REV3_CPU:
776             return v3_svm_enter(info);
777             break;
778 #endif
779 #if V3_CONFIG_VMX
780         case V3_VMX_CPU:
781         case V3_VMX_EPT_CPU:
782         case V3_VMX_EPT_UG_CPU:
783             return v3_vmx_enter(info);
784             break;
785 #endif
786         default:
787             PrintError("Attemping to enter a guest on an invalid CPU\n");
788             return -1;
789     }
790 }