Expose APIs for getting at variables and their initializers, and start adding a test suite for the plugin API

- Add gcc.Variable class, and gcc.get_variables()
- Add 'initial' property to gcc.VarDecl
- Add 'elements' property to gcc.Constructor
- Start adding a test suite for the plugin API: compile c source whilst running
Python code, and checking the output is expected.
- Add a test case to exercise the Python API for looking up initialization of
arrays of structures.

Author: davidmalcolm

Makefile

@@ -10,8 +10,10 @@ PLUGIN_SOURCE_FILES= \
   gcc-python-pass.c \
   gcc-python-pretty-printer.c \
   gcc-python-tree.c \
+  gcc-python-variable.c \
   autogenerated-tree.c \
-  autogenerated-gimple.c
+  autogenerated-gimple.c \
+  autogenerated-variable.c
 
 PLUGIN_OBJECT_FILES= $(patsubst %.c,%.o,$(PLUGIN_SOURCE_FILES))
 GCCPLUGINS_DIR:= $(shell $(GCC) --print-file-name=plugin)
@@ -45,6 +47,9 @@ autogenerated-tree.c: cpybuilder.py generate-tree-c.py autogenerated-tree-types.
 autogenerated-gimple.c: cpybuilder.py generate-gimple-c.py autogenerated-gimple-types.txt maketreetypes.py
 	python generate-gimple-c.py > $@
 
+autogenerated-variable.c: cpybuilder.py generate-variable-c.py autogenerated-gimple-types.txt maketreetypes.py
+	python generate-variable-c.py > $@
+
 # Hint for debugging: add -v to the gcc options 
 # to get a command line for invoking individual subprocesses
 # Doing so seems to require that paths be absolute, rather than relative
@@ -74,3 +79,7 @@ debug: plugin
 # A simple demo, to make it easy to demonstrate the cpychecker:
 demo: plugin
 	PYTHONPATH=$(shell pwd) gcc -fplugin=$(shell pwd)/python.so -fplugin-arg-python-script=cpychecker.py $(shell python-config --cflags) $(shell pwd)/demo.c
+
+test-suite: plugin
+	python run-test-suite.py
+

cpybuilder.py

@@ -333,6 +333,10 @@ def __init__(self, sm, builddir='.'):
 
 class CommandError(RuntimeError):
     def __init__(self, out, err, p):
+        assert isinstance(out, str)
+        assert isinstance(err, str)
+        assert isinstance(p, Popen)
+
         self.out = out
         self.err = err
         self.p = p
@@ -343,12 +347,16 @@ def __str__(self):
         result += '  %s\n' % self._describe_activity()
         result += 'Stdout:\n'
         result += self._indent(self.out)
-        result += 'Stderr:\n'
+        result += '\nStderr:\n'
         result += self._indent(self.err, 4)
+        result += self._extra_info()
         return result
 
     def _indent(self, txt, size=2):
         return '\n'.join([' '*size + line for line in txt.splitlines()])
+
+    def _extra_info(self):
+        return ''
 
 class PyRuntimeError(CommandError):
     def __init__(self, runtime, cmd, out, err, p):

gcc-python-pretty-printer.c

@@ -58,9 +58,12 @@ gcc_python_pretty_printer_as_string(PyObject *obj)
     /* Convert to a python string, leaving off the trailing newline: */
     len = strlen(ppobj->buf);
     assert(len > 0);
-    assert('\n' == ppobj->buf[len - 1]);
-    return PyString_FromStringAndSize(ppobj->buf,
-				      len - 1);
+    if ('\n' == ppobj->buf[len - 1]) {
+	return PyString_FromStringAndSize(ppobj->buf,
+					  len - 1);
+    } else {
+	return PyString_FromString(ppobj->buf);
+    }
 }
 
 void

gcc-python-tree.c

@@ -118,6 +118,57 @@ gcc_Declaration_repr(struct PyGccTree * self)
     return NULL;
 }
 
+PyObject *
+gcc_Constructor_get_elements(PyObject *self, void *closure)
+{
+    struct PyGccTree * self_as_tree;
+    PyObject *result = NULL;
+    tree node;
+    unsigned HOST_WIDE_INT cnt;
+    tree index, value;
+
+    self_as_tree = (struct PyGccTree *)self; /* FIXME */
+    node = self_as_tree->t;
+    
+    result = PyList_New(VEC_length(constructor_elt, CONSTRUCTOR_ELTS (node)));
+    if (!result) {
+	goto error;
+    }
+
+    FOR_EACH_CONSTRUCTOR_ELT (CONSTRUCTOR_ELTS (node),
+			      cnt, index, value) {
+	PyObject *obj_index = NULL;
+	PyObject *obj_value = NULL;
+	PyObject *obj_pair = NULL;
+	obj_index = gcc_python_make_wrapper_tree(index);
+	if (!obj_index) {
+	    goto error;
+	}
+	obj_value = gcc_python_make_wrapper_tree(value);
+	if (!obj_value) {
+	    Py_DECREF(obj_index);
+	    goto error;
+	}
+	obj_pair = PyTuple_Pack(2, obj_index, obj_value);
+	if (!obj_pair) {
+	    Py_DECREF(obj_value);
+	    Py_DECREF(obj_index);
+	    goto error;
+	}
+
+	if (-1 == PyList_SetItem(result, cnt, obj_pair)) {
+	    Py_DECREF(obj_pair);
+	    goto error;
+	}
+    }
+
+    return result;
+
+ error:
+    Py_XDECREF(result);
+    return NULL;
+}
+
 /* 
    GCC's debug_tree is implemented in:
      gcc/print-tree.c

gcc-python-variable.c

@@ -0,0 +1,34 @@
+#include <Python.h>
+#include "gcc-python.h"
+#include "gcc-python-wrappers.h"
+
+PyObject *
+gcc_python_make_wrapper_variable(struct varpool_node *node)
+{
+    struct PyGccVariable *var_obj = NULL;
+
+    if (NULL == node) {
+	Py_RETURN_NONE;
+    }
+  
+    var_obj = PyObject_New(struct PyGccVariable, &gcc_VariableType);
+    if (!var_obj) {
+        goto error;
+    }
+
+    var_obj->var = node;
+    /* FIXME: do we need to do something for the GCC GC? */
+
+    return (PyObject*)var_obj;
+      
+error:
+    return NULL;
+}
+
+
+/*
+  PEP-7  
+Local variables:
+c-basic-offset: 4
+End:
+*/

gcc-python-wrappers.h

@@ -45,6 +45,9 @@ gcc_Declaration_get_name(struct PyGccTree *self, void *closure);
 PyObject *
 gcc_Declaration_repr(struct PyGccTree * self);
 
+PyObject *
+gcc_Constructor_get_elements(PyObject *self, void *closure);
+
 PyObject *
 gcc_Gimple_repr(struct PyGccGimple * self);
 

gcc-python.c

@@ -11,6 +11,7 @@ int plugin_is_GPL_compatible;
 #include "tree.h"
 #include "function.h"
 #include "diagnostic.h"
+#include "cgraph.h"
 
 #define GCC_PYTHON_TRACE_ALL_EVENTS 0
 #if GCC_PYTHON_TRACE_ALL_EVENTS
@@ -261,13 +262,45 @@ gcc_python_permerror(PyObject *self, PyObject *args)
     return result_obj;
 }
 
+static PyObject *
+gcc_python_get_variables(PyObject *self, PyObject *args)
+{
+    PyObject *result;
+    struct varpool_node *n;
+
+    result = PyList_New(0);
+    if (!result) {
+	goto error;
+    }
+
+    for (n = varpool_nodes; n; n = n->next) {
+	PyObject *obj_var = gcc_python_make_wrapper_variable(n);
+	if (!obj_var) {
+	    goto error;
+	}
+	if (-1 == PyList_Append(result, obj_var)) {
+	    Py_DECREF(obj_var);
+	    goto error;
+	}
+    }
+
+    return result;
+
+ error:
+    Py_XDECREF(result);
+    return NULL;
+}
+
 static PyMethodDef GccMethods[] = {
     {"register_callback", gcc_python_register_callback, METH_VARARGS,
      "Register a callback, to be called when various GCC events occur."},
 
     {"permerror", gcc_python_permerror, METH_VARARGS,
      NULL},
 
+    {"get_variables", gcc_python_get_variables, METH_VARARGS,
+     "Get all variables in this compilation unit as a list of gcc.Variable"},
+
     /* Sentinel: */
     {NULL, NULL, 0, NULL}
 };
@@ -380,9 +413,12 @@ plugin_init (struct plugin_name_args *plugin_info,
 
     gcc_python_autogenerated_tree_init_types(); /* FIXME: error checking! */
     autogenerated_gimple_init_types();  /* FIXME: error checking! */
+    autogenerated_variable_init_types(); /* FIXME: error checking! */
 
     gcc_python_autogenerated_tree_add_types(gcc_python_globals.module);
     autogenerated_gimple_add_types(gcc_python_globals.module);
+    autogenerated_variable_add_types(gcc_python_globals.module);
+
 
     //    inittree();
 

gcc-python.h

@@ -59,11 +59,20 @@ DECLARE_SIMPLE_WRAPPER(PyGccTree,
 		       gcc_TreeType,
 		       tree, tree, t)
 
+DECLARE_SIMPLE_WRAPPER(PyGccVariable,
+		       gcc_VariableType,
+		       variable,
+		       struct varpool_node *, var)
+
 /* autogenerated-gimple.c */
 int autogenerated_gimple_init_types(void);
 void autogenerated_gimple_add_types(PyObject *m);
 PyTypeObject* gcc_python_autogenerated_gimple_type_for_stmt(gimple g);
 
+/* autogenerated-variable.c */
+int autogenerated_variable_init_types(void);
+void autogenerated_variable_add_types(PyObject *m);
+
 
 int
 gcc_python_autogenerated_tree_init_types(void);

generate-tree-c.py

@@ -535,14 +535,23 @@ def generate_tree_code_classes():
 
         getsettable =  PyGetSetDefTable('gcc_%s_getset_table' % cc, [])
 
+        def get_getter_identifier(name):
+            return 'gcc_%s_get_%s' % (cc, name)
+
         def add_simple_getter(name, c_expression, doc):
             getsettable.add_gsdef(name,
-                                  cu.add_simple_getter('gcc_%s_get_%s' % (cc, name),
+                                  cu.add_simple_getter(get_getter_identifier(name),
                                                        'PyGccTree',
                                                        c_expression),
                                   None,
                                   doc)
 
+        def add_complex_getter(name, doc):
+            getsettable.add_gsdef(name,
+                                  get_getter_identifier(name),
+                                  None,
+                                  doc)
+
         if cc == 'AddrExpr':
             add_simple_getter('operand',
                               'gcc_python_make_wrapper_tree(TREE_OPERAND (self->t, 0))',
@@ -591,7 +600,17 @@ def add_simple_getter(name, c_expression, doc):
         if tree_type.SYM == 'IDENTIFIER_NODE':
             add_simple_getter('name',
                               'gcc_python_string_or_none(IDENTIFIER_POINTER(self->t))',
-                              "The name of this gcc.IdentifierNode, as a string'")
+                              "The name of this gcc.IdentifierNode, as a string")
+
+        if tree_type.SYM == 'VAR_DECL':
+            add_simple_getter('initial',
+                              'gcc_python_make_wrapper_tree(DECL_INITIAL(self->t))',
+                              "The initial value for this variable as a gcc.Constructor, or None")
+
+        if tree_type.SYM == 'CONSTRUCTOR':
+            add_complex_getter('elements',
+                              "The elements of this constructor, as a list of (index, gcc.Tree) pairs")
+        
 
         cu.add_defn(getsettable.c_defn())
 
@@ -641,7 +660,9 @@ def add_simple_getter(name, c_expression, doc):
 """)
 
 
-    cu.add_defn("""
+generate_tree_code_classes()
+
+cu.add_defn("""
 int gcc_python_autogenerated_tree_init_types(void)
 {
 """ + modinit_preinit + """
@@ -652,13 +673,13 @@ def add_simple_getter(name, c_expression, doc):
 }
 """)
 
-    cu.add_defn("""
+cu.add_defn("""
 void gcc_python_autogenerated_tree_add_types(PyObject *m)
 {
 """ + modinit_postinit + """
 }
 """)
 
-generate_tree_code_classes()
+
 
 print(cu.as_str())