README - AsmTools - Version 7.0

# Release Notes ## AsmTools ## April 2020

[Skip TOC]

## Table of Contents

Introduction
New in This Release
System Requirements
Release Contents
Installation
Using AsmTools
Known Bugs and Issues
Obtaining Sources
Building from Sources
Contribute

## Introduction

AsmTools is a software package containing a collection of tools that you can use to encode and decode a Java class file, without using a Javac compiler. You can use AsmTools to create class files which can not normally be produced by a compiler. These class files can be used during the development process to test the compliance of a Virtual Machine (VM) to its specification.

These release notes contain information about the ASM Tools version 7.0. See the ( CodeTools project) AsmTools OpenJDK project page for more information about AsmTools.

## New in This Release

### New Features

Bug ID | Description
--- | ---
CODETOOLS-7902525 | Asmtools support: JEP 360 Sealed Types(Preview)
CODETOOLS-7902524 | Asmtools support: JEP 359 Records(Preview)

### Fixed Bugs

Bug ID | Description
--- | ---
CODETOOLS-7902618 | Asmtools does not support jasm output/input for TypeAnnotations.
CODETOOLS-7902643 | Asmtools(jasm) does not support signature attributes in field_info, component_info
CODETOOLS-7902644 | Asmtools (jcoder) fails if an jcod file contains CONSTANT_Utf8_info with non-normative char sequences
CODETOOLS-7902648 | jasm has no clues about how to interpret CONSTANT_MethodHandle_info:reference_kind in an invokedynamic instruction

## System Requirements

Using ASM Tools requires a properly configured, certified Java Platform, Standard Edition (Java SE™ platform) runtime environment version 1.8 or later, or a Java SE platform 8.0 runtime environment.

## Installation

To install the AsmTools, simply unzip the asmtools-7.0.zip distribution file in the directory of your choice. Optionally, you may wish to define an environment variable (ASMTOOLSHOME) to point to this location for your convenience.

## Release Contents

This section lists the components under the base subdirectory structure (`asmtools-7.0/`) that is created when you unzip the AsmTools distribution archive during installation.

### Important Component Descriptions and Locations

Component | Description
--- | ---
`README.html` | The AsmTools release notes (this document).
`lib/asmtools.jar` | The AsmTools library.

## Using AsmTools

AsmTools have the following synopsis:

    java -jar ${ASMTOOLSHOME}/asmtools.jar TOOL FILE
       [TOOL="jasm" | "jdis" | "jcoder" | jdec | jcdec]
       [FILE=xxx.jasm (for jasm command) | xxx.jcod (for jcod command) | xxx.class for jdis, jdec, or jcdec command]

Examples:

% java -jar ${ASMTOOLSHOME}/asmtools.jar jasm MyClass.jasm
(produces MyClass.class)
% java -jar ${ASMTOOLSHOME}/asmtools.jar jdis MyClass.class > MyClass.jasm
(produces MyClass.jasm)
% java -jar ${ASMTOOLSHOME}/asmtools.jar jcoder MyClass.jcod
(produces MyClass.class)
% java -jar ${ASMTOOLSHOME}/asmtools.jar jdec MyClass.class > MyClass.jcod
(produces MyClass.jcod)

Assembler Syntax and tool usage is covered in the AsmTools project wiki.

### Operating Modes

There are no operating modes.

[Top]

## Known Bugs and Issues

Many attributes (in the class file, as specified by the Java VM Specification, Chapter 4) are covered in the JASM syntax, but not all.

[Top]

## Contribute

The AsmTools open source project was created in order to develop a community that will improve it, further the development of Java assembly tools, and use Java assemblers to develop test suites. We encourage you to browse, download, contribute, and get involved.

[Top]

## Obtaining the Sources

The sources for ASM Tools 7.0 and later is available via the community OpenJDK project. The sources are stored and accessed through a Mercurial repository, which the public may access in a read-only fashion. Committing to changes to the sources is accomplished by first contributing through a proxy developer to establish ones self, which can then lead to rights to contribute directly. More information can be found on the OpenJDK Projects landing page.

The general form for obtaining a copy of the current source tree is:

    % hg clone http://hg.openjdk.java.net/code-tools/asmtools asmtools-ro

This places a copy of the entire source tree in the asmtools-ro directory. From that directory, you can then view and build the sources, as described in the next section. Note that this copy is of the development version of the sources, you may need to extract a different revision if you want a copy from a specific period of time.

At the time of writing, the current version of Mercurial (`hg`) is 2.9.1. See the OpenJDK ASM Tools main page for updated and more detailed information.

[Top]

## Building the Sources

Building the sources requires Ant version 1.8 or later (1.10.1 is current at the time of writing), and the built-in build is compatible with using an IDE. The sources are designed for Java 8 and if you invoke `ant` with this runtime, your chance of encountering an abnormal conditions due to your runtime or compiler (or javadoc) version.

General requirements:

- ant, version 1.8 or later
- Java 8 runtime and compiler (minimum and recommended)
- 10MB free disk space (3MB for source tree, 7MB for build output)

The general steps to do a build from source from the command line:

1. Obtain Sources
2. Make your current directory `<topdir>/build/`
3. Invoke ant:
   `% ant`
4. Output appears in a directory above (one above <topdir>), such as: `../../asmtools-7.0-build/`

A common variation of the build command to force `ant` to use a particular installation of Java on your machine:

    # JAVA_HOME=/Library/Java/JavaVirtualMachines/jdk1.8.0_144.jdk/Contents/Home ANTHOME=/usr/share/ant ant

This example for common *nix shells (`zsh, bash, sh`), alter it as needed for your command environment. You can test your invocation of `ant` by running it with the `-diagnostics` flag, where it will indicate which Java it is using.

The build file itself is `build/build.xml`, this is the file you can specify in your IDE for building.

Copyright © 2008, 2020, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms.The majority of the Assember Tools project is released under the GNU General Public License Version 2 (GPLv2)