Update documentation for release

Robert Lougher · Robert Lougher · commit c415ba42285d · 2014-07-31T01:27:48.000+01:00
Signed-off-by: Robert Lougher &lt;rob@jamvm.org.uk&gt;
diff --git a/INSTALL b/INSTALL
@@ -1,4 +1,4 @@
-JamVM 1.5.4 Installation
+JamVM 2.0.0 Installation
 ========================
 
 This section describes how to configure, build and install JamVM on
@@ -12,11 +12,23 @@ Getting the Files
 You must already have the compressed tar file containing the source
 code for JamVM (you're reading this!).  For JamVM to run, it must also
 have a class library containing the system classes and the associated
-native methods (e.g. java.lang.Object).  JamVM 1.5.4 has been written to
-use GNU Classpath.  It is compatible with the latest released version
-which is currently 0.98.  It is not compatible with earlier versions. 
-It should also be compatible with the CVS version, and later snapshots,
-as long as the VM interface has remained the same.
+native methods (e.g. java.lang.Object).  JamVM 2.0.0 has been written to
+work either OpenJDK/IcedTea or GNU Classpath.
+
+OpenJDK/IcedTea
+---------------
+
+As discussed in the README, the easiest way to get an OpenJDK/IcedTea
+install that works with JamVM is to get an existing package for your
+system and then overwrite the libjvm.so file with the new version.  If you
+wish to build OpenJDK/IcedTea from source, please refer to the build
+instructions contained within the source distribution.
+
+GNU Classpath
+-------------
+
+JamVM is compatible with GNU Classpath versions 0.98 and above (earlier
+versions will not work).  It should also be compatible with the CVS version.
 
 Classpath can be obtained from the following URL:
 
@@ -32,11 +44,16 @@ Linux distributions.
 Building and Installing JamVM
 -----------------------------
 
-I'll deal with building GNU classpath later.  To build JamVM, you
-must first run `configure' to generate the Makefiles specific to your
-machine.  From the directory containing this file do :-
+To build JamVM, you must first run `configure' to generate the Makefiles
+specific to your machine.  The --with-java-runtime-library option specifies
+which class-library to support (by default if the option isn't specified
+JamVM is configured for GNU Classpath).  Supported values are gnuclasspath,
+openjdk6, openjdk7 or openjdk8.
 
-./configure
+For example, to configure JamVM to use OpenJDK 8, from the directory
+containing this file do :-
+
+./configure --with-java-runtime-library=openjdk8
 
 This should print out some information and then say it's creating
 the Makefiles.  If it fails, make sure your machine's architecture
@@ -50,9 +67,9 @@ To install in the default location (/usr/local), type :-
 
 make install
 
-This installs an executable of JamVM with debug information (-g).
-Alternatively, to install a version with no symbols (which is much
-smaller, around 220K on PowerPC and 200K on Intel) type :-
+This installs an executable of JamVM and a libjvm.so shared library with
+debug information (-g).  Alternatively, to install a version with no symbols
+(which is much smaller) type :-
 
 make install-strip
 
@@ -71,7 +88,7 @@ JamVM supports a number of JamVM specific options to `configure'.
 For full details do ./configure --help.  Most of these are concerned
 with enabling tracing (e.g. --enable-tracelock), or selecting which
 interpreter variant to build.  Unless you want to debug JamVM, or
-experiment with the intepreter these should not be needed.
+experiment with the interpreter these should not be needed.
 
 Two options, however, are useful and may need to be specified.  The
 first is '--with-classpath-install-dir=PATH'.  This can be used to
@@ -88,6 +105,38 @@ via Classpath and is unaffected, and will still support jar/zip files).
 This will reduce the JamVM executable by approx 10K (but see note below, in
 Classpath installation).
 
+Installing JamVM into OpenJDK/IcedTea
+-------------------------------------
+
+When using JamVM with OpenJDK/IcedTea, JamVM's libjvm.so file must be
+copied from its initial install location into the OpenJDK/IcedTea
+installation.
+
+The default install location puts libjvm.so into /usr/local/jamvm/lib.
+
+IcedTea supports JamVM as an alternative VM which is invoked using the
+-jamvm option to java.  To install a new version of libjvm.so, locate the
+jamvm directory within IcedTea.  For example, for OpenJDK 7 on an x64_64
+Debian system this is /usr/lib/jvm/java-7-openjdk-amd64/jre/lib/amd64/jamvm.
+
+If installing into OpenJDK, the default HotSpot libjvm.so can be overwritten
+by JamVM's libjvm.so.  When java is executed it will now run JamVM (if
+HotSpot is still required you can create a copy of OpenJDK, and overwrite
+the libjvm.so in the copy).  HotSpot will be in either the client or server
+directory, e.g. <openjdk-install>/jre/lib/amd64/server.
+
+Do the copy (as root), e.g.:
+
+cp /usr/local/jamvm/lib/libjvm.so /usr/lib/jvm/java-7-openjdk-amd64/jre/lib/amd64/jamvm
+
+To test the install has been successful, run java -version, e.g.:
+
+/usr/lib/jvm/java-7-openjdk-amd64/jre/bin/java -jamvm -version
+java version "1.7.0_65"
+OpenJDK Runtime Environment (IcedTea 2.5.1) (7u65-2.5.1-2~deb7u1)
+JamVM (build 2.0.0, inline-threaded interpreter)
+
+
 Building and Installing GNU classpath
 -------------------------------------
 
diff --git a/NEWS b/NEWS
@@ -1,3 +1,131 @@
+JamVM 2.0.0 released on 30th July 2014
+======================================
+
+JamVM 2.0.0 is the first release of JamVM with support for OpenJDK.  Although
+IcedTea already includes JamVM with OpenJDK support, this has been based on
+periodic snapshots of the development tree.
+
+This release supports OpenJDK 6, 7 and 8 (the latest).  With OpenJDK 7 and 8
+this includes full support for JSR 292 (invokedynamic).  JamVM 2.0.0
+with OpenJDK 8 also includes full support for Lambda expressions (JSR 335),
+type annotations (JSR 308) and method parameter reflection.
+
+In addition to OpenJDK support, JamVM 2.0.0 also includes many bug-fixes,
+performance improvements and improved compatibility (from running the OpenJDK
+jtreg tests).  The following is an edited list of the top ~100 commits (out
+of 300+) in date order (most recent first).  The list has been categorised
+into those affecting OpenJDK only, GNU Classpath only, and both OpenJDK and
+GNU Classpath (All).
+
+- OpenJDK: JSR 292: show full anonymous/lamdba class name in stack trace
+- OpenJDK: JSR 292: resolvePolyMethod race-conditions
+- OpenJDK: JSR 292: Free callsite linked-list on class GC
+- OpenJDK: JSR 292: Fix for invokedynamic resolution (must be per callsite)
+- OpenJDK: JSR 292: constant method handle can be signature polymorphic
+- All: More command-line compatibility options
+- OpenJDK: Use correct thread group function when thread dies
+- GNU Classpath: update JamVM's version of VMAccessController
+- All: Check ClassBlock padding at VM initialisation
+- GNU Classpath: Update GNU Classpath ClassBlock padding
+- OpenJDK: Make ClassBlock padding dependent on OpenJDK version
+- OpenJDK: JSR 292: Fix RepetitiveLambdaSerialization jtreg test
+- OpenJDK: Fix compatibility issues on different Unixes
+- All: Explicitly initialise java.lang.Class
+- All: Optimise ClassBlock structure
+- OpenJDK: JSR 292: anonymous class resolution to itself
+- OpenJDK: JSR 292: anonymous classes should use host_class permissions
+- OpenJDK: JSR 292: findInvokeDynamicInvoker fix exception handling
+- OpenJDK: JSR 292: Fix CallStaticInitOrder jtreg test
+- OpenJDK: JVM_NewMultiArray: element class may be an array
+- OpenJDK: jtreg test java/lang/reflect/Array/ExceedMaxDim
+- OpenJDK: Fix Local/Anonymous class checks
+- All: Fix race-condition in constant-pool resolution code
+- OpenJDK: JSR 292: MethodHandle constant-pool refs may be resolved
+- OpenJDK: JSR 292: bootstrap method args error handling
+- GNU Classpath: race-condition in thread detach
+- GNU Classpath: fix threading issue in lookupLoadedDlls0
+- All: Race condition in setting up imethod table
+- All: GC: Several minor performance improvements
+- OpenJDK: Add support for CallerSensitive
+- OpenJDK: JSR 335: handle interfaces when resolving a method
+- OpenJDK: sun.misc.Unsafe: additional methods get/putAddress
+- OpenJDK: JSR 292: enable for OpenJDK 7/IcedTea 2
+- OpenJDK: JSR 335: invokeinterface check in method resolution
+- OpenJDK: JSR 335: implement "bridge" methods for Mirandas
+- OpenJDK: JSR 335: interface methods - handle multiple defaults and conflicts
+- All: Fix invokesuper check in invokespecial opcode
+- OpenJDK: JSR 901: VM support for method parameter reflection
+- OpenJDK: JSR 335: VM support for lambda expressions
+- OpenJDK: Implement JSR 308: Type Annotations
+- All: Re-work internal storage of annotation data
+- OpenJDK: JSR 292: update intrinsic cache after GC compaction
+- OpenJDK: JSR 292: initMemberName: handle constructor
+- OpenJDK: JSR 292: implement MethodHandleNatives::expand
+- OpenJDK: JSR 292: resolveMemberName: throw LinkageError
+- OpenJDK: JSR 292: intercept LinkageError when linking callsite
+- OpenJDK: JSR 292: handle fields in findMethodHandleConstant
+- OpenJDK: JSR 292: enable only when configuring for OpenJDK8
+- OpenJDK: Implement fence methods in sun.misc.Unsafe
+- OpenJDK: JSR 292: implement intrinsic cache
+- OpenJDK: JSR 292: use internal opcodes for intrinsics
+- OpenJDK: Very simple field injection framework
+- OpenJDK: JSR 292 Lambda access control jtreg tests
+- OpenJDK: Garbage collector changes for JSR 292
+- OpenJDK: Yet more JSR 292 jtreg tests
+- OpenJDK: Set anonymous class protection domain
+- OpenJDK: JSR 292: all jtreg tests now pass
+- OpenJDK: First commit of OpenJDK8 JSR292 support (invokedynamic)
+- OpenJDK: Do not put version number in libjvm.so SONAME
+- All: Changes for Raspbian (Raspberry Pi)
+- All: Add extra compatibility options
+- All: When suspending, ignore detached threads that have died
+- All: Update stubs generator to handle ref returns
+- All: Ref return values from JNI methods need to handled specially
+- OpenJDK: Implement classlibCheckIfOnLoad() on OpenJDK
+- OpenJDK: OpenJDK 7: make thread states JVMTI compatible
+- All: Add OpenBSD/sparc to list of recognised hosts
+- All: Make command line compatibility options table-driven
+- OpenJDK: Skip Java-reflection-related DelegatingClassLoaders
+- All: Generic JNI stubs for common JNI method signatures
+- All: Add support for armhf
+- OpenJDK: Fix OpenJDK enclosingMethodInfo()
+- All: "Fix" handling of CLI bootclasspath options
+- All: Correct thrown exception by bootstrap loader
+- All: Fix threading of references list during compaction
+- All: Fix class GC with classes containing Miranda methods
+- All: Propogate initialisation errors to top-level
+- OpenJDK: Extra sun.misc.Unsafe functions
+- GNU Classpath: Fix VMThread.join
+- OpenJDK: Initial implementation of JVM_FindClassFromBootLoader
+- All: Fix callJNIMethod on i386 with -fomit-frame-pointer
+- All: Fix backwards cache conflict resolution code
+- All: Unify command line options parsing
+- OpenJDK: Implement remaining OpenJDK Array reflection interface
+- All: Base default min and max heap size on physical memory
+- OpenJDK: Fix reflective array access
+- All: Rewrite integer divide overflow check
+- OpenJDK: First set of changes to support JamVM/OpenJDK on MacOS X
+- All: Handle integer overflow on i386/amd64
+- All: On ARM, force interpreter to be built in ARM mode
+- All: MIPS: 64-bit and interpreter inlining by default
+- OpenJDK: Fix bug in JVM_NewMultiArray
+- All: JNI compatibility options and error printing
+- OpenJDK: Nasty compaction bug with OpenJDK classloader tables
+- All: Native return types smaller than an int must be handled specially
+- All: Add MIPS support for inlining
+- All: Update arm.h for ARMv7-A
+- All: Linux implementation of nativeJVMPath()
+- OpenJDK: Changes to VM to support different class-libraries
+- All: Fix for LNEG with stack-caching enabled on 32 bit machines (seen on ARM)
+- All: Fix for I2L on MIPS
+- All: Fix getMethodParameterAnnotations when there are no annotations
+- All: Fix constructorParameterAnnotations
+- All: Initial version of JNI stubs generator
+- All: Support for JNI stubs (signature specific fast invoke)
+- OpenJDK: Implement JNI RegisterNatives (first change for OpenJDK)
+- All: Add JNI 1.6 to supported versions returned by JNI onload
+
+
 JamVM 1.5.4 released on 1st January 2010
 ========================================
 
diff --git a/README b/README
