• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/tools/hsdis/hsdis.h@710a3c8b516e (annotated)

src/share/tools/hsdis/hsdis.h

Tue, 08 Aug 2017 15:57:29 +0800

author

aoqi

date

Tue, 08 Aug 2017 15:57:29 +0800

changeset 6876

710a3c8b516e

parent 4244

3d701c802d01

parent 0

f90c822e73f8

child 9572

624a0741915c

permissions

-rw-r--r--

merge

aoqi@0	1	/*
aoqi@0	2	* Copyright (c) 2008, 2012, Oracle and/or its affiliates. All rights reserved.
aoqi@0	3	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0	4	*
aoqi@0	5	* This code is free software; you can redistribute it and/or modify it
aoqi@0	6	* under the terms of the GNU General Public License version 2 only, as
aoqi@0	7	* published by the Free Software Foundation.
aoqi@0	8	*
aoqi@0	9	* This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0	10	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0	11	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0	12	* version 2 for more details (a copy is included in the LICENSE file that
aoqi@0	13	* accompanied this code).
aoqi@0	14	*
aoqi@0	15	* You should have received a copy of the GNU General Public License version
aoqi@0	16	* 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0	17	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0	18	*
aoqi@0	19	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0	20	* or visit www.oracle.com if you need additional information or have any
aoqi@0	21	* questions.
aoqi@0	22	*
aoqi@0	23	*/
aoqi@0	24
aoqi@0	25	/* decode_instructions -- dump a range of addresses as native instructions
aoqi@0	26	This implements the protocol required by the HotSpot PrintAssembly option.
aoqi@0	27
aoqi@0	28	The start_va, end_va is the virtual address the region of memory to
aoqi@0	29	disasemble and buffer contains the instructions to decode,
aoqi@0	30	Disassembling instructions in the current address space is done by
aoqi@0	31	having start_va == buffer.
aoqi@0	32
aoqi@0	33	The option string, if not empty, is interpreted by the disassembler implementation.
aoqi@0	34
aoqi@0	35	The printf callback is 'fprintf' or any other workalike.
aoqi@0	36	It is called as (*printf_callback)(printf_stream, "some format...", some, format, args).
aoqi@0	37
aoqi@0	38	The event callback receives an event tag (a string) and an argument (a void*).
aoqi@0	39	It is called as (*event_callback)(event_stream, "tag", arg).
aoqi@0	40
aoqi@0	41	Events:
aoqi@0	42	<insn pc='%p'> begin an instruction, at a given location
aoqi@0	43	</insn pc='%d'> end an instruction, at a given location
aoqi@0	44	<addr value='%p'/> emit the symbolic value of an address
aoqi@0	45
aoqi@0	46	A tag format is one of three basic forms: "tag", "/tag", "tag/",
aoqi@0	47	where tag is a simple identifier, signifying (as in XML) a element start,
aoqi@0	48	element end, and standalone element. (To render as XML, add angle brackets.)
aoqi@0	49	*/
aoqi@0	50	#ifndef SHARED_TOOLS_HSDIS_H
aoqi@0	51	#define SHARED_TOOLS_HSDIS_H
aoqi@0	52
aoqi@0	53	extern
aoqi@0	54	#ifdef DLL_EXPORT
aoqi@0	55	DLL_EXPORT
aoqi@0	56	#endif
aoqi@0	57	void* decode_instructions_virtual(uintptr_t start_va, uintptr_t end_va,
aoqi@0	58	unsigned char* buffer, uintptr_t length,
aoqi@0	59	void* (*event_callback)(void*, const char*, void*),
aoqi@0	60	void* event_stream,
aoqi@0	61	int (*printf_callback)(void*, const char*, ...),
aoqi@0	62	void* printf_stream,
aoqi@0	63	const char* options,
aoqi@0	64	int newline /* bool value for nice new line */);
aoqi@0	65
aoqi@0	66	/* This is the compatability interface for older versions of hotspot */
aoqi@0	67	extern
aoqi@0	68	#ifdef DLL_ENTRY
aoqi@0	69	DLL_ENTRY
aoqi@0	70	#endif
aoqi@0	71	void* decode_instructions(void* start_pv, void* end_pv,
aoqi@0	72	void* (*event_callback)(void*, const char*, void*),
aoqi@0	73	void* event_stream,
aoqi@0	74	int (*printf_callback)(void*, const char*, ...),
aoqi@0	75	void* printf_stream,
aoqi@0	76	const char* options);
aoqi@0	77
aoqi@0	78	/* convenience typedefs */
aoqi@0	79
aoqi@0	80	typedef void* (*decode_instructions_event_callback_ftype) (void*, const char*, void*);
aoqi@0	81	typedef int (*decode_instructions_printf_callback_ftype) (void*, const char*, ...);
aoqi@0	82	typedef void* (*decode_func_vtype) (uintptr_t start_va, uintptr_t end_va,
aoqi@0	83	unsigned char* buffer, uintptr_t length,
aoqi@0	84	decode_instructions_event_callback_ftype event_callback,
aoqi@0	85	void* event_stream,
aoqi@0	86	decode_instructions_printf_callback_ftype printf_callback,
aoqi@0	87	void* printf_stream,
aoqi@0	88	const char* options,
aoqi@0	89	int newline);
aoqi@0	90	typedef void* (*decode_func_stype) (void* start_pv, void* end_pv,
aoqi@0	91	decode_instructions_event_callback_ftype event_callback,
aoqi@0	92	void* event_stream,
aoqi@0	93	decode_instructions_printf_callback_ftype printf_callback,
aoqi@0	94	void* printf_stream,
aoqi@0	95	const char* options);
aoqi@0	96	#endif /* SHARED_TOOLS_HSDIS_H */