jrose@535: /*
minqi@4093:  * Copyright (c) 2008, 2012, Oracle and/or its affiliates. All rights reserved.
jrose@535:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
jrose@535:  *
jrose@535:  * This code is free software; you can redistribute it and/or modify it
jrose@535:  * under the terms of the GNU General Public License version 2 only, as
jrose@535:  * published by the Free Software Foundation.
jrose@535:  *
jrose@535:  * This code is distributed in the hope that it will be useful, but WITHOUT
jrose@535:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
jrose@535:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
jrose@535:  * version 2 for more details (a copy is included in the LICENSE file that
jrose@535:  * accompanied this code).
jrose@535:  *
jrose@535:  * You should have received a copy of the GNU General Public License version
jrose@535:  * 2 along with this work; if not, write to the Free Software Foundation,
jrose@535:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
jrose@535:  *
trims@1907:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
trims@1907:  * or visit www.oracle.com if you need additional information or have any
trims@1907:  * questions.
jrose@535:  *
jrose@535:  */
jrose@535: 
jrose@535: /* decode_instructions -- dump a range of addresses as native instructions
jrose@535:    This implements the protocol required by the HotSpot PrintAssembly option.
jrose@535: 
minqi@4093:    The start_va, end_va is the virtual address the region of memory to
minqi@4093:    disasemble and buffer contains the instructions to decode,
minqi@4093:    Disassembling instructions in the current address space is done by
minqi@4093:    having start_va == buffer.
jrose@535: 
jrose@535:    The option string, if not empty, is interpreted by the disassembler implementation.
jrose@535: 
jrose@535:    The printf callback is 'fprintf' or any other workalike.
jrose@535:    It is called as (*printf_callback)(printf_stream, "some format...", some, format, args).
jrose@535: 
jrose@535:    The event callback receives an event tag (a string) and an argument (a void*).
jrose@535:    It is called as (*event_callback)(event_stream, "tag", arg).
jrose@535: 
jrose@535:    Events:
jrose@535:      <insn pc='%p'>             begin an instruction, at a given location
jrose@535:      </insn pc='%d'>            end an instruction, at a given location
jrose@535:      <addr value='%p'/>         emit the symbolic value of an address
jrose@535: 
jrose@535:    A tag format is one of three basic forms: "tag", "/tag", "tag/",
jrose@535:    where tag is a simple identifier, signifying (as in XML) a element start,
jrose@535:    element end, and standalone element.  (To render as XML, add angle brackets.)
jrose@535: */
minqi@4244: #ifndef SHARED_TOOLS_HSDIS_H
minqi@4244: #define SHARED_TOOLS_HSDIS_H
minqi@4244: 
jrose@535: extern
jrose@535: #ifdef DLL_EXPORT
jrose@535:   DLL_EXPORT
jrose@535: #endif
minqi@4093: void* decode_instructions_virtual(uintptr_t start_va, uintptr_t end_va,
minqi@4093:                                   unsigned char* buffer, uintptr_t length,
minqi@4093:                                   void* (*event_callback)(void*, const char*, void*),
minqi@4093:                                   void* event_stream,
minqi@4093:                                   int (*printf_callback)(void*, const char*, ...),
minqi@4093:                                   void* printf_stream,
minqi@4244:                                   const char* options,
minqi@4244:                                   int newline /* bool value for nice new line */);
minqi@4244: 
minqi@4244: /* This is the compatability interface for older versions of hotspot */
minqi@4244: extern
minqi@4244: #ifdef DLL_ENTRY
minqi@4244:   DLL_ENTRY
minqi@4244: #endif
minqi@4244: void* decode_instructions(void* start_pv, void* end_pv,
minqi@4244:                     void* (*event_callback)(void*, const char*, void*),
minqi@4244:                     void* event_stream,
minqi@4244:                     int   (*printf_callback)(void*, const char*, ...),
minqi@4244:                     void* printf_stream,
minqi@4244:                     const char* options);
jrose@535: 
jrose@535: /* convenience typedefs */
jrose@535: 
jrose@535: typedef void* (*decode_instructions_event_callback_ftype)  (void*, const char*, void*);
jrose@535: typedef int   (*decode_instructions_printf_callback_ftype) (void*, const char*, ...);
minqi@4244: typedef void* (*decode_func_vtype) (uintptr_t start_va, uintptr_t end_va,
minqi@4244:                                     unsigned char* buffer, uintptr_t length,
minqi@4244:                                     decode_instructions_event_callback_ftype event_callback,
minqi@4244:                                     void* event_stream,
minqi@4244:                                     decode_instructions_printf_callback_ftype printf_callback,
minqi@4244:                                     void* printf_stream,
minqi@4244:                                     const char* options,
minqi@4244:                                     int newline);
minqi@4244: typedef void* (*decode_func_stype) (void* start_pv, void* end_pv,
minqi@4244:                                     decode_instructions_event_callback_ftype event_callback,
minqi@4244:                                     void* event_stream,
minqi@4244:                                     decode_instructions_printf_callback_ftype printf_callback,
minqi@4244:                                     void* printf_stream,
minqi@4244:                                     const char* options);
minqi@4244: #endif /* SHARED_TOOLS_HSDIS_H */