The MMTk harness is a debugging tool. It allows you to run MMTk with a simple client - a simple Java-like scripting language - which can explicitly allocate objects, create and delete references, etc. This allows MMTk to be run and debugged stand-alone, without the entire VM, greatly simplifying initial debugging and reducing the edit-debug turnaround time. This is all accessible through the command line or an IDE such as eclipse.
Running the test harness
The harness can be run standalone or via Eclipse (or other IDE).
There is a collection of sample scripts in the MMTk/harness/test-scripts directory. There is a simple wrapper script that runs all the available scripts against all the collectors,
This script prints a PASS/FAIL line as it goes, and puts detailed output in results/mmtk.
Or in versions before 3.1.1
Refresh the project (or import it into eclipse), and then run 'Project > Clean'.
Define a new run configuration with main class org.mmtk.harness.Main.
Click Run (actually the down-arrow next to the the green button), choose 'Run Configurations...'
Select "Java Application" from the left-hand panel, and click the "new" icon (top left).
Fill out the Main tab as below
Fill out the Arguments tab as below
The harness makes extensive use of the java 'assert' keyword, so you should run the harness with '-ea' in the VM options.
Click 'Apply' and then 'Run' to test the configuration. Eclipse will prompt for a value for the 'script' variable - enter the name of one of the available test scripts, such as 'Lists', and click OK. The scripts provided with MMTk are in the directory MMTk/harness/test-scripts.
You can configure eclipse to display vmmagic values (Address/ObjectReference/etc) using their toString method through the Eclipse -> Preferences... -> Java -> Debug -> Detail Formatters menu. The simplest option is to check the box to use toString 'As the label for all variables'.
Test harness options
Options are passed to the test harness as 'keyword=value' pairs. The standard MMTk options that are available through JikesRVM are accepted (leave off the "-X:gc:"), as well as the following harness-specific options:
The MMTk plan class. Defaults to org.mmtk.plan.marksweep.MS
The number of concurrent collector threads (default: 1)
Initial heap size. It is also a good idea to use 'variableSizeHeap=false', since the heap growth manager uses elapsed time to make its decisions, and time is seriously dilated by the MMTk Harness.
Maximum heap size (default: 64 pages)
Debugging messages from the MMTk Harness. Useful trace options include
Set a watchpoint on a given address or comma-separated list of addresses. The harness will display every load and store to that address.
Watch modifications to a given object or comma-separated list of objects, identified by object ID (sequence number).
Force frequent GCs. Options are
Optionally use the deterministic scheduler. Options are
Select from several scheduling policies,
For the FIXED scheduling policy, the yield frequency.
Parameters for the RANDOM scheduler policy. Whenever a thread is created, the scheduler fixes a yield pattern of 'length' integers between 'min' and 'max'. These numbers are used as yield intervals in a circular manner.
Dump statistics for the deterministic scheduler's yield policy.
Select between 32 and 64-bit memory models.
Dump the pseudo-code generated by the harness interpreter
Abort collection if a GC takes longer than this value (seconds). Defaults to 30.
The MMTk/harness/test-scripts directory contains several test scripts.
Test allocator alignment behaviour
Tests alignment by creating a list of objects aligned to a mixture of 4-byte and 8-byte boundaries.
Test cycle detector in Reference Counting collectors
Creates large amounts of cyclic garbage in the form of circular linked lists.
General collection test
Harness version of the FixedLive GC micro-benchmark. Creates a binary tree, then allocates short-lived objects to force garbage collections.
Hash code test.
Creates objects and verifies that their hashcode is unchanged after a GC.
Large object allocator test
Creates objects with sizes ranging from 2 to 32 pages (8k to 128k bytes).
Generational collector stress test
Creates a set of lists of varying lengths, and then allocates to force collections. Ensures that there are Mature->Nursery, Nursery->Mature and Stack->Nursery and Stack->Mature pointers at every GC. Remsets get a serious workout.
Tests out-of-memory handling.
Allocates a linked list that grows until the heap fills up.
General collection test
Implements a list-based quicksort.
Reference type test
Creates Weak references, forces collections and ensures that they are correctly handled.
Creates lots of threads which allocate objects.
Free-list allocator test
Creates large numbers of objects with random size distributions, keeping a fraction of the objects alive.
Concurrent free-list allocator test
A multithreaded version of SpreadAlloc.
The language has three types: integer, object and user-defined. The object type behaves essentially like a double array of pointers and integers (odd, I know, but the scripting language is basically concerned with filling up the heap with objects of a certain size and reachability). User-defined types are like Java objects without methods, 'C' structs, Pascal record types etc.
Objects and user-defined types are allocated with the 'alloc' statement: alloc(p,n,align) allocates an object with 'p' pointers, 'n' integers and the given alignment; alloc(type) allocates an object of the given type. Variables are declared 'c' style, and are optionally initialized at declaration.
User-defined types are declared as follows:
and fields are accessed using java-style "dot" notation, eg
At this stage, fields can only be dereferenced to one level, eg 'l.next.next' is not valid syntax - you need to introduce a temporary variable to achieve this.
Object fields are referenced using syntax like "tmp.int" or "tmp.object[i*3]",
ie like a struct of arrays of the appropriate types.
MMTk Unit Tests
There is a small set of unit tests available for MMTk, using the harness as scaffolding. These tests can be run in the standard test infrastructure using the 'mmtk-unit-tests' test set, or the shell script 'bin/unit-test-mmtk'. Possibly more usefully, they can be run from Eclipse.
To run the unit tests in Eclipse, build the mmtk harness project (see above), and add the directory testing/tests/mmtk/src to your build path (navigate to the directory in the package explorer pane in eclipse, right-click>build-path>Use as Source Folder). Either open one of the test classes, or highlight it in the package explorer and press the 'run' button.