Copyright (c) 2008, 2022, Oracle and/or its affiliates. All rights reserved.
DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

The Universal Permissive License (UPL), Version 1.0

Subject to the condition set forth below, permission is hereby granted to
any person obtaining a copy of this software, associated documentation
and/or data (collectively the "Software"), free of charge and under any
and all copyright rights in the Software, and any and all patent rights
owned or freely licensable by each licensor hereunder covering either (i)
the unmodified Software as contributed to or provided by such licensor,
or (ii) the Larger Works (as defined below), to deal in both

(a) the Software, and

(b) any piece of software and/or hardware listed in the lrgrwrks.txt file
if one is included with the Software (each a "Larger Work" to which the
Software is contributed by such licensors),

without restriction, including without limitation the rights to copy,
create derivative works of, display, perform, and distribute the Software
and make, use, sell, offer for sale, import, export, have made, and have
sold the Software and the Larger Work(s), and to sublicense the foregoing
rights on either these or other terms.

This license is subject to the following condition:

The above copyright notice and either this complete permission notice or
at a minimum a reference to the UPL must be included in all copies or
substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
USE OR OTHER DEALINGS IN THE SOFTWARE.

Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
or visit www.oracle.com if you need additional information or have any
questions.

hsdis - a HotSpot plugin for disassembling dynamically generated code

The files in this directory are built independently of the HotSpot JVM.

hsdis is an interface exposed by Hotspot. There are several backends that implement this interface, using different disassembly engines. Included in the JDK is support for building hsdis with Capstone, LLVM or GNU binutils. The interface is fairly straightforward and easy to implement using other backends.

Building and installing

To compile hsdis, you need to activate hsdis support, and select the proper backend to use. This is done with the configure switch

To build the hsdis library, run

NOTE: If you do this using the binutils backend, the resulting build may not be distributable. Please get legal advice if you intend to distribute the result of your build.

Using the library

The hsdis library will be automatically loaded by Hotspot when you use the diagnostic option

If using the LLVM backend on Windows, you need to be sure that the LLVM DLL file (or files) can be found by hsdis. In practice, this means that you either need to copy

More information is available at the HotSpot wiki.

Building with Capstone

To build this project using Capstone you need to have Capstone installed. Typical ways of installation can be

This has been tested with Capstone v4.0.2, but earlier (and later) versions are also likely to work.

To build hsdis using Capstone, you must enable it in configure by

On Linux and macOS, the location Capstone can most often be auto-detected. If this fails, or if you are building on Windows, you need to specify where Capstone is located using

Building with LLVM

To build this project using LLVM you need to have LLVM installed. Typical ways of installation can be

This has been tested with LLVM v13.0.0, but earlier (and later) versions are also likely to work.

To build hsdis using LLVM, you must enable it in configure by

If

Building with LLVM on Windows

Getting a usable installation on Windows is trickier than on the other platforms. You can download (and patch) the official distribution, or you can build it yourself.

Links to the latest version of the official build is available at LLVMs download page. Download the file LLVM-nn.n.n-win64.exe, and run it to let it install itself. The default installation location is

For very unclear reasons, the official Windows build is missing almost all LLVM include files. (At least this was the case up to and including LLVM 13.) You will need to complement your installation with the proper include files. One way to do this is to install LLVM in Cygwin. This will give you (apart from the Cygwin-based dll files which are unusable with Visual Studio) a complete set of the headers. These are located in

Alternatively, you can build LLVM yourself from source. This process is documented at the LLVM Visual Studio page.

Either which way, you must tell configure the location of your LLVM installation using

The

Building with binutils

To build this project using binutils you need a copy of GNU binutils to build against. It is known to work with binutils 2.37. Building against versions older than 2.29 is not supported. Download a copy of the software from FSF binutils page or one of its mirrors.

To build this library, you must enable building in configure by

You must also specify where binutils is located. To facilitate building, you can point to a place where the (unpacked) binutils sources are located using

If you have pre-built binutils binaries, you can point to them directly using

If you want to build hsdis with binutils provided by system (e.g. binutils-devel from Fedora, binutils-dev from Ubuntu), you can pass

Building with binutils on Windows

On Windows, the normal Microsoft Visual Studio toolchain cannot build binutils. Instead we need to use the mingw compiler. This is available as a cygwin package. You need to install the