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.


added new copyright and license
[palacios.git] / palacios / include / palacios / vmm.h
index aebc8ad..b8728b4 100644 (file)
@@ -1,3 +1,22 @@
+/*
+ * This file is part of the Palacios Virtual Machine Monitor developed
+ * by the V3VEE Project with funding from the United States National 
+ * Science Foundation and the Department of Energy.  
+ *
+ * The V3VEE Project is a joint project between Northwestern University
+ * and the University of New Mexico.  You can find out more at 
+ * http://www.v3vee.org
+ *
+ * Copyright (c) 2008, Jack Lange <jarusl@cs.northwestern.edu> 
+ * Copyright (c) 2008, The V3VEE Project <http://www.v3vee.org> 
+ * All rights reserved.
+ *
+ * Author: Jack Lange <jarusl@cs.northwestern.edu>
+ *
+ * This is free software.  You are permitted to use,
+ * redistribute, and modify it as specified in the file "V3VEE_LICENSE".
+ */
+
 #ifndef __VMM_H
 #define __VMM_H
 
 
 
 
-#define PrintError(fmt, args...)                       \
-  do {                                                 \
-    extern struct vmm_os_hooks * os_hooks;             \
-    if ((os_hooks) && (os_hooks)->print_debug) {       \
-      (os_hooks)->print_debug((fmt), ##args);          \
-    }                                                  \
+#define PrintError(fmt, args...)                                       \
+  do {                                                                 \
+    extern struct vmm_os_hooks * os_hooks;                             \
+    if ((os_hooks) && (os_hooks)->print_debug) {                       \
+      (os_hooks)->print_debug("%s(%d): " fmt, __FILE__, __LINE__, ##args); \
+    }                                                                  \
   } while (0)                                          
 
 
 
 
 #if VMM_TRACE
-#define PrintTrace(fmt, args...)                       \
-  do {                                                 \
-    extern struct vmm_os_hooks * os_hooks;             \
-    if ((os_hooks) && (os_hooks)->print_trace) {       \
-      (os_hooks)->print_trace((fmt), ##args);          \
-    }                                                  \
+#define PrintTrace(fmt, args...)                                       \
+  do {                                                                 \
+    extern struct vmm_os_hooks * os_hooks;                             \
+    if ((os_hooks) && (os_hooks)->print_trace) {                       \
+      (os_hooks)->print_trace(fmt, ##args);                            \
+    }                                                                  \
   } while (0)                                          
 #else
 #define PrintTrace(fmt, args...)
 #endif
 
 
-#define V3_AllocPages(ptr, num_pages)                  \
-  do {                                                 \
+#define V3_AllocPages(num_pages)                       \
+  ({                                                   \
     extern struct vmm_os_hooks * os_hooks;             \
-    ptr = 0;                                           \
+    void * ptr = 0;                                    \
     if ((os_hooks) && (os_hooks)->allocate_pages) {    \
       ptr = (os_hooks)->allocate_pages(num_pages);     \
     }                                                  \
-  } while (0)                                          \
+    ptr;                                               \
+  })                                                   \
+
+
+#define V3_FreePage(page)                      \
+  do {                                         \
+    extern struct vmm_os_hooks * os_hooks;     \
+    if ((os_hooks) && (os_hooks)->free_page) { \
+      (os_hooks)->free_page(page);             \
+    }                                          \
+  } while(0)                                   \
+
 
 
-/*
-#define V3_Malloc(type, var, size)                     \
-  do {                                                 \
-    extern struct vmm_os_hooks * os_hooks;             \
-    var = 0;                                           \
-    if ((os_hooks) && (os_hooks)->malloc) {            \
-      var = (type)(os_hooks)->malloc(size);            \
-    }                                                  \
-  } while (0)                                          \
-*/
 
 #define V3_Malloc(size) ({                     \
       extern struct vmm_os_hooks * os_hooks;   \
     }                                                  \
   } while (0)                                          \
 
+
+// uint_t V3_CPU_KHZ();
 #define V3_CPU_KHZ()                                   \
   ({                                                   \
     unsigned int khz = 0;                              \
   })                                                   \
     
 
+
+#define V3_Hook_Interrupt(irq, opaque)                         \
+  ({                                                           \
+    int ret = 0;                                               \
+    extern struct vmm_os_hooks * os_hooks;                     \
+    if ((os_hooks) && (os_hooks)->hook_interrupt) {            \
+      ret = (os_hooks)->hook_interrupt(irq, opaque);           \
+    }                                                          \
+    ret;                                                       \
+  })                                                           \
+
+
 /* ** */
 
 #define V3_ASSERT(x)                                                   \
   } while(0)                                                           \
     
 
+
+
 #define VMM_INVALID_CPU 0
 #define VMM_VMX_CPU 1
 #define VMM_SVM_CPU 2
 
+
+// Maybe make this a define....
+typedef enum v3_cpu_arch {V3_INVALID_CPU, V3_SVM_CPU, V3_SVM_REV3_CPU, V3_VMX_CPU} v3_cpu_arch_t;
+
+
 #endif //!__V3VEE__
 
 
+
 //
 //
 // This is the interrupt state that the VMM's interrupt handlers need to see
 //
 struct vmm_intr_state {
-  uint_t irq;
-  uint_t error;
+  unsigned int irq;
+  unsigned int error;
 
-  uint_t should_ack;  // Should the vmm ack this interrupt, or will
+  unsigned int should_ack;  // Should the vmm ack this interrupt, or will
                       // the host OS do it?
 
   // This is the value given when the interrupt is hooked.
   // This will never be NULL
-  void *opaque;
+  void * opaque;
 };
 
-void deliver_interrupt_to_vmm(struct vmm_intr_state *state);
+void deliver_interrupt_to_vmm(struct vmm_intr_state * state);
 
 
 /* This will contain function pointers that provide OS services */
@@ -169,40 +211,41 @@ struct vmm_os_hooks {
   void *(*paddr_to_vaddr)(void *addr);
   void *(*vaddr_to_paddr)(void *addr);
 
-  //  int (*hook_interrupt)(int irq, vmm_intr_handler handler, uint_t opaque);
+  //  int (*hook_interrupt)(struct guest_info *s, int irq);
 
-  int (*hook_interrupt)(struct guest_info *s, int irq);
-
-  int (*hook_interrupt_new)(uint_t irq, void *opaque);
+  int (*hook_interrupt)(unsigned int irq, void *opaque);
 
   int (*ack_irq)(int irq);
 
 
   unsigned int (*get_cpu_khz)();
 
-  // Do we need this here?
-  //  void (*snprintf)(char * dst, char * format, int len, ...);
+
+  void (*start_kernel_thread)(); // include pointer to function
 
 
 
-  void (*start_kernel_thread)(); // include pointer to function
 };
 
 
-
 /* This will contain Function pointers that control the VMs */
 struct vmm_ctrl_ops {
-  int (*init_guest)(struct guest_info* info);
+  struct guest_info *(*allocate_guest)();
+
+  int (*config_guest)(struct guest_info * info, void * config_ptr);
+  int (*init_guest)(struct guest_info * info);
   int (*start_guest)(struct guest_info * info);
   //  int (*stop_vm)(uint_t vm_id);
 
   int (*has_nested_paging)();
+
+  //  v3_cpu_arch_t (*get_cpu_arch)();
 };
 
 
 
 
-void Init_VMM(struct vmm_os_hooks * hooks, struct vmm_ctrl_ops * vmm_ops);
+void Init_V3(struct vmm_os_hooks * hooks, struct vmm_ctrl_ops * vmm_ops);