Moving LAVA Hypercall struct to include

Author: AndrewQuijano

panda/include/panda/lava_hypercall_struct.h

@@ -0,0 +1,49 @@
+/*!
+ * @file lava_hypercall_struct.h
+ * @brief Support for hypercalls from the PANDA guest to the taint2 plugin. Used by LAVA.
+ *
+ * @author
+ *  Tim Leek               tleek@ll.mit.edu
+ *  Ryan Whelan            rwhelan@ll.mit.edu
+ *  Joshua Hodosh          josh.hodosh@ll.mit.edu
+ *  Michael Zhivich        mzhivich@ll.mit.edu
+ *  Brendan Dolan-Gavitt   brendandg@gatech.edu
+ *
+ * @copyright This work is licensed under the terms of the GNU GPL, version 2.
+ * See the COPYING file in the top-level directory.
+ */
+#pragma once
+
+#ifndef __LAVA_HYPERCALL_STRUCT_H__
+#define __LAVA_HYPERCALL_STRUCT_H__
+
+// lavaint must be 32 bits for architecture compatibility (4 bytes)
+typedef unsigned int lavaint;
+#ifndef __cplusplus
+#define static_assert _Static_assert
+#endif
+static_assert(sizeof(lavaint) == 4, "lavaint size must be 4!");
+
+// Magic number used by the host to identify the hypercall as a legitimate
+// call intended for the taint2 plugin.
+#define LAVA_MAGIC 0xabcd
+
+// CRITICAL: Ensure 1-byte packing so the structure size and field offsets
+// match exactly between the guest and the host (no compiler padding).
+#pragma pack(push,1)
+typedef struct panda_hypercall_struct {
+    lavaint magic;              // Must be LAVA_MAGIC
+    lavaint action;             // label / query / etc
+    lavaint buf;                // ptr to memory we want labeled or queried or ...
+    lavaint len;                // number of bytes to label or query or ...
+    lavaint label_num;          // if labeling, this is the label number.  if querying this should be zero
+    lavaint src_column;         // column on source line
+    lavaint src_filename;       // char * to filename.  
+    lavaint src_linenum;        // line number
+    lavaint src_ast_node_name;  // the name of the l-value queries 
+    lavaint info;               // general info
+    lavaint insertion_point;    // unused now.
+} PandaHypercallStruct;
+#pragma pack(pop)
+
+#endif // __LAVA_HYPERCALL_STRUCT_H__

panda/plugins/pri_taint/pri_taint.cpp

@@ -22,7 +22,7 @@ extern "C" {
 #include "panda/rr/rr_log.h"
 #include "panda/plog.h"
 
-#include "taint2/taint2_hypercalls.h"
+#include "panda/lava_hypercall_struct.h"
 
 #include "pri/pri_types.h"
 #include "pri/pri_ext.h"

panda/plugins/taint2/taint2_hypercalls.cpp

@@ -22,6 +22,7 @@
 #include <string>
 #include <map>
 #include <vector>
+#include "panda/lava_hypercall_struct.h"
 #include "taint2_hypercalls.h"
 #include "taint_api.h"
 #include "callstack_instr/callstack_instr.h"

panda/plugins/taint2/taint2_hypercalls.h

@@ -4,6 +4,7 @@
  *
  * @note This is currently only used by LAVA. Make sure you keep this file
  * in sync between the PANDA and LAVA repositories.
+ * Check the panda/include/panda/lava_hypercall_struct.h file for the struct implementation
  *
  * @author
  *  Tim Leek               tleek@ll.mit.edu
@@ -19,29 +20,6 @@
 
 #include "qemu/osdep.h"
 
-typedef unsigned int lavaint;
-#ifndef __cplusplus
-#define static_assert _Static_assert
-#endif
-static_assert(sizeof(lavaint) == 4, "lavaint size must be 4!");
-
-#define LAVA_MAGIC 0xabcd
-#pragma pack(push,1)
-typedef struct panda_hypercall_struct {
-    lavaint magic;
-    lavaint action;             // label / query / etc
-    lavaint buf;                // ptr to memory we want labeled or queried or ...
-    lavaint len;                // number of bytes to label or query or ...
-    lavaint label_num;          // if labeling, this is the label number.  if querying this should be zero
-    lavaint src_column;         // column on source line
-    lavaint src_filename;       // char * to filename.
-    lavaint src_linenum;        // line number
-    lavaint src_ast_node_name;  // the name of the l-value queries
-    lavaint info;               // general info
-    lavaint insertion_point;    // unused now.
-} PandaHypercallStruct;
-#pragma pack(pop)
-
 #ifdef __cplusplus
 extern "C" {
 #endif