New "producer" attribute for gdb.Symtab objects

Message ID yjt2ppevf8il.fsf@ruffy.mtv.corp.google.com
State New, archived
Headers

Commit Message

Doug Evans Sept. 16, 2014, 11:30 p.m. UTC
  Hi.

I have a need to get the producer string from python.
Regression tested on amd64-linux.
Eli, this needs a doc RFA.

2014-09-16  Doug Evans  <dje@google.com>

	* NEWS: Mention new "producer" attribute of gdb.Symtab.
	* python/py-symtab.c (stpy_get_producer): New function.
	(symtab_object_getset): Add "producer" attribute.

	doc/
	* python.texi (Symbol Tables In Python): Document "producer"
	attribute of gdb.Symtab objects.

	testsuite/
	* gdb.python/py-symtab.exp: Add test for symtab.producer.
  

Comments

Pedro Alves Sept. 17, 2014, 12:31 a.m. UTC | #1
On 09/17/2014 12:30 AM, Doug Evans wrote:
> +# We can't do much to test the producer string (compiler name+version).

Sounds like a job for the testsuite's dwarf compiler.

> +# But we do have support for knowing whether gcc was used, so we can at
> +# least use that.
> +if { $gcc_compiled } {
> +    set producer_regexp "GNU.*"
> +} else {
> +    set producer_regexp ""
> +}

Thanks,
Pedro Alves
  
Eli Zaretskii Sept. 17, 2014, 5:09 a.m. UTC | #2
> From: Doug Evans <dje@google.com>
> Date: Tue, 16 Sep 2014 16:30:42 -0700
> 
> I have a need to get the producer string from python.
> Regression tested on amd64-linux.
> Eli, this needs a doc RFA.

That part is fine, thanks.
  

Patch

diff --git a/gdb/NEWS b/gdb/NEWS
index 3bb1c74..e01ed71 100644
--- a/gdb/NEWS
+++ b/gdb/NEWS
@@ -4,7 +4,9 @@ 
 *** Changes since GDB 7.8
 
 * Python Scripting
-  You can now access frame registers from Python scripts.
+
+  ** You can now access frame registers from Python scripts.
+  ** New attribute 'producer' for gdb.Symtab objects.
 
 * New Python-based convenience functions:
 
diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index 9f44948..81ec11b 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -4043,6 +4043,14 @@  The symbol table's backing object file.  @xref{Objfiles In Python}.
 This attribute is not writable.
 @end defvar
 
+@defvar Symtab.producer
+The name and possibly version number of the program that
+compiled the code in the symbol table.
+The contents of this string is up to the compiler.
+If no producer information is available then @code{None} is returned.
+This attribute is not writable.
+@end defvar
+
 A @code{gdb.Symtab} object has the following methods:
 
 @defun Symtab.is_valid ()
diff --git a/gdb/python/py-symtab.c b/gdb/python/py-symtab.c
index 8f4208d..1065ba3 100644
--- a/gdb/python/py-symtab.c
+++ b/gdb/python/py-symtab.c
@@ -126,6 +126,25 @@  stpy_get_objfile (PyObject *self, void *closure)
   return result;
 }
 
+/* Getter function for symtab.producer.  */
+
+static PyObject *
+stpy_get_producer (PyObject *self, void *closure)
+{
+  struct symtab *symtab = NULL;
+
+  STPY_REQUIRE_VALID (self, symtab);
+  if (symtab->producer != NULL)
+    {
+      const char *producer = symtab->producer;
+
+      return PyString_Decode (producer, strlen (producer),
+			      host_charset (), NULL);
+    }
+
+  Py_RETURN_NONE;
+}
+
 static PyObject *
 stpy_fullname (PyObject *self, PyObject *args)
 {
@@ -530,6 +549,8 @@  static PyGetSetDef symtab_object_getset[] = {
     "The symbol table's source filename.", NULL },
   { "objfile", stpy_get_objfile, NULL, "The symtab's objfile.",
     NULL },
+  { "producer", stpy_get_producer, NULL,
+    "The name/version of the program that compiled this symtab.", NULL },
   {NULL}  /* Sentinel */
 };
 
diff --git a/gdb/testsuite/gdb.python/py-symtab.exp b/gdb/testsuite/gdb.python/py-symtab.exp
index e6ac9c3..e2bd3d7 100644
--- a/gdb/testsuite/gdb.python/py-symtab.exp
+++ b/gdb/testsuite/gdb.python/py-symtab.exp
@@ -59,6 +59,15 @@  gdb_test "python print (sal.is_valid())" "True" "Test sal.is_valid"
 # Test symbol table.
 gdb_test "python print (symtab.filename)" ".*gdb.python/py-symbol.c.*" "Test symtab.filename"
 gdb_test "python print (symtab.objfile)" "<gdb.Objfile object at ${hex}>" "Test symtab.objfile"
+# We can't do much to test the producer string (compiler name+version).
+# But we do have support for knowing whether gcc was used, so we can at
+# least use that.
+if { $gcc_compiled } {
+    set producer_regexp "GNU.*"
+} else {
+    set producer_regexp ""
+}
+gdb_test "python print (symtab.producer)" "$producer_regexp" "Test symtab.producer"
 gdb_test "python print (symtab.fullname())" "testsuite/gdb.python/py-symbol.c.*" "Test symtab.fullname"
 gdb_test "python print (symtab.is_valid())" "True" "Test symtab.is_valid()"
 gdb_test "python print (\"qq\" in global_symbols)" "True" "Test qq in global symbols"