diff src/share/tools/hsdis/hsdis.h @ 100:c7c777385a15

6667042: PrintAssembly option does not work without special plugin Summary: remove old private plugin interface, simplify, rework old plugin to use unchanged Gnu sources Reviewed-by: kvn, rasbold
author jrose
date Wed, 02 Apr 2008 12:09:59 -0700
parents
children c18cbe5936b8
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/share/tools/hsdis/hsdis.h	Wed Apr 02 12:09:59 2008 -0700
@@ -0,0 +1,67 @@
+/*
+ * Copyright 2008 Sun Microsystems, Inc.  All Rights Reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
+ * CA 95054 USA or visit www.sun.com if you need additional information or
+ * have any questions.
+ *
+ */
+
+/* decode_instructions -- dump a range of addresses as native instructions
+   This implements the protocol required by the HotSpot PrintAssembly option.
+
+   The starting and ending addresses are within the current process's address space.
+
+   The option string, if not empty, is interpreted by the disassembler implementation.
+
+   The printf callback is 'fprintf' or any other workalike.
+   It is called as (*printf_callback)(printf_stream, "some format...", some, format, args).
+
+   The event callback receives an event tag (a string) and an argument (a void*).
+   It is called as (*event_callback)(event_stream, "tag", arg).
+
+   Events:
+     <insn pc='%p'>             begin an instruction, at a given location
+     </insn pc='%d'>            end an instruction, at a given location
+     <addr value='%p'/>         emit the symbolic value of an address
+
+   A tag format is one of three basic forms: "tag", "/tag", "tag/",
+   where tag is a simple identifier, signifying (as in XML) a element start,
+   element end, and standalone element.  (To render as XML, add angle brackets.)
+*/
+extern
+#ifdef DLL_EXPORT
+  DLL_EXPORT
+#endif
+void* decode_instructions(void* start, void* end,
+                          void* (*event_callback)(void*, const char*, void*),
+                          void* event_stream,
+                          int (*printf_callback)(void*, const char*, ...),
+                          void* printf_stream,
+                          const char* options);
+
+/* convenience typedefs */
+
+typedef void* (*decode_instructions_event_callback_ftype)  (void*, const char*, void*);
+typedef int   (*decode_instructions_printf_callback_ftype) (void*, const char*, ...);
+typedef void* (*decode_instructions_ftype) (void* start, void* end,
+                                            decode_instructions_event_callback_ftype event_callback,
+                                            void* event_stream,
+                                            decode_instructions_printf_callback_ftype printf_callback,
+                                            void* printf_stream,
+                                            const char* options);