Add new DumpAllOffHeapEntriesCommand in DDR #21047

LinHu2016 · 2025-01-31T19:12:58Z

new DumpAllOffHeapEntriesCommand provides a way to list all
off-heap entries in the core file, which contain off-heap data
(only when off-heap has been enabled in jvm and gcpolicy has been set
to Balanced GC mode).
for the rest of cases(off-heap has been disabled or "old core file",
which did not contain off-heap option at all), print out error message
"This command only works with the core file,
which contains off-heap."
off-heap entry information includes
the address of the Array Object,
the data address and
the size of array data

LinHu2016 · 2025-02-03T18:40:28Z

output format for DumpAllSparseHeapEntriesCommand

> !dumpalloffheapentries
List off-heap entries(521 entries)
+------------------+------------------+------------------
|  array object    |  data address    |      size        
+------------------+------------------+------------------
 0x00007f0889e2ff60 0x00007f025eef2000 0x0000000000014000
 0x00007f08b7aa1090 0x00007f025edc1000 0x0000000000020000
 0x00007f08b7aa1250 0x00007f025ede1000 0x0000000000020000
 0x00007f08b7aa1410 0x00007f025ee01000 0x0000000000020000
 0x00007f08b7aa15d0 0x00007f025ee21000 0x0000000000020000
 0x00007f08b7aa1790 0x00007f025ee41000 0x0000000000020000
 0x00007f08b7aa1950 0x00007f025ee61000 0x0000000000020000
 0x00007f088e09fc40 0x00007f025ee81000 0x0000000000021000
 0x00007f088cfa0190 0x00007f025eea2000 0x0000000000017000
 0x00007f088d34f5a8 0x00007f025eeb9000 0x0000000000021000
 0x00007f088c3febf0 0x00007f025eeda000 0x0000000000018000
...
 0x00007f08715cb6e8 0x00007f025798b000 0x0000000000010000
 0x00007f0869f8a8f8 0x00007f0257c6b000 0x0000000000010000
+------------------+------------------+------------------

dmitripivkine · 2025-02-03T18:50:43Z

just curious, how this output looks like for Compressed Refs? I guess there are leading zeroes added to the object address.
BTW this PR still have a few whitespace issues (see console output for Line Endings Check job)

LinHu2016 · 2025-02-03T18:59:31Z

just curious, how this output looks like for Compressed Refs? I guess there are leading zeroes added to the object address. BTW this PR still have a few whitespace issues (see console output for Line Endings Check job)

I think it always output 64 bit address for object pointer, and I will update for whitespace issues, thanks

amicic · 2025-02-05T16:36:43Z

@keithc-ca please review

debugtools/DDR_VM/src/com/ibm/j9ddr/AuxFieldInfo29.dat

keithc-ca · 2025-02-05T16:53:47Z

debugtools/DDR_VM/src/com/ibm/j9ddr/vm29/j9/ObjectToSparseDataHashTable.java

+/**
+ * ObjectToSparseDataHashTable is used for accessing hash tables in SparseDataTableEntry
+ * (e.g. readAccessHashTable)
+ */
+
+public class ObjectToSparseDataHashTable extends HashTable_V1<MM_SparseDataTableEntryPointer>


Please improve the javadoc (at least finish the sentence with a period) and remove the blank line separating it from the class.

keithc-ca · 2025-02-05T16:54:41Z

debugtools/DDR_VM/src/com/ibm/j9ddr/vm29/j9/ObjectToSparseDataHashTable.java

+	 * @param structure
+	 * 					the J9HashTablePointer
+	 *
+	 * @throws CorruptDataException
+	 * 					when fails to read from structure


Tabs should only be used for indentation, please use spaces on lines 48, 51.

keithc-ca · 2025-02-05T16:56:17Z

debugtools/DDR_VM/src/com/ibm/j9ddr/vm29/j9/ObjectToSparseDataHashTable.java

+		public UDATA hash(MM_SparseDataTableEntryPointer entry) throws CorruptDataException {
+			return UDATA.cast(entry._dataPtr());
+		}


Please format consistently; the opening brace { should be on a separate line.

keithc-ca · 2025-02-05T16:58:36Z

debugtools/DDR_VM/src/com/ibm/j9ddr/vm29/j9/ObjectToSparseDataHashTable.java

+	protected ObjectToSparseDataHashTable(J9HashTablePointer hashTablePointer, boolean isInline, Class<MM_SparseDataTableEntryPointer> structType,
+			HashEqualFunction<MM_SparseDataTableEntryPointer> equalFn,
+			HashFunction<MM_SparseDataTableEntryPointer> hashFn) throws CorruptDataException


Please fold this, one parameter per line.

keithc-ca · 2025-02-05T17:03:07Z

...VM/src/com/ibm/j9ddr/vm29/tools/ddrinteractive/commands/DumpAllSparseHeapEntriesCommand.java

+public class DumpAllSparseHeapEntriesCommand extends Command
+{
+	public DumpAllSparseHeapEntriesCommand()
+	{
+		addCommand("dumpalloffheapentries", "cmd|help", "dump all off heap entries");


Suggest the class name should more closely match the command name.

keithc-ca · 2025-02-05T17:03:29Z

...VM/src/com/ibm/j9ddr/vm29/tools/ddrinteractive/commands/DumpAllSparseHeapEntriesCommand.java

+		addCommand("dumpalloffheapentries", "cmd|help", "dump all off heap entries");
+	}
+
+	public void run(String command, String[] args, Context context, PrintStream out) throws DDRInteractiveCommandException


Please add the missing @Override annotation.

keithc-ca · 2025-02-05T17:03:41Z

...VM/src/com/ibm/j9ddr/vm29/tools/ddrinteractive/commands/DumpAllSparseHeapEntriesCommand.java

+		if (0 != args.length) {
+			String argument = args[0];
+
+			if(argument.equalsIgnoreCase("help")) {


Formatting: space before (.

keithc-ca · 2025-02-05T17:04:32Z

...VM/src/com/ibm/j9ddr/vm29/tools/ddrinteractive/commands/DumpAllSparseHeapEntriesCommand.java

+							HashTable<MM_SparseDataTableEntryPointer> readObjectToSparseDataTable = ObjectToSparseDataHashTable.fromJ9HashTable(objectToSparseDataTable);
+							SlotIterator<MM_SparseDataTableEntryPointer> readSlotIterator = readObjectToSparseDataTable.iterator();
+							long count = readObjectToSparseDataTable.getCount();
+							out.printf("List off heap entries(%,d entries)\n", count);


Please %n, not \n in format strings in calls to printf() or format().

keithc-ca · 2025-02-05T17:05:51Z

...VM/src/com/ibm/j9ddr/vm29/tools/ddrinteractive/commands/DumpAllSparseHeapEntriesCommand.java

+							out.printf("List off heap entries(%,d entries)\n", count);
+							if (0 < count) {
+								if (!J9BuildFlags.J9VM_ENV_DATA64) {
+									throw new CorruptDataException("off heap would not be supported in 32 bit platform.");


Please hyphenate "32-bit", and improve wording:

throw new CorruptDataException("off heap is not supported on 32-bit platforms");

On second thought, this command should only be added in GetCommandsTask for 64-bit core files.

keithc-ca · 2025-02-11T20:21:13Z

debugtools/DDR_VM/src/com/ibm/j9ddr/vm29/j9/ObjectToSparseDataHashTable.java

+
+/**
+ * ObjectToSparseDataHashTable is used for accessing hash tables {@link HashTable}
+ * in SparseDataTableEntry {@link MM_SparseDataTableEntryPointer} (e.g. iterator)。


Please use a normal period to finish sentences (unicode 0x2e).

Not all of those are fixed; see line 47.

debugtools/DDR_VM/src/com/ibm/j9ddr/vm29/j9/ObjectToSparseDataHashTable.java

keithc-ca · 2025-02-11T20:29:49Z

debugtools/DDR_VM/src/com/ibm/j9ddr/vm29/j9/ObjectToSparseDataHashTable.java

+		return new ObjectToSparseDataHashTable(structure, false, MM_SparseDataTableEntryPointer.class, new SparseDataHashEqualFn(), new SparseDataHashFn());
+	}
+
+	private static class SparseDataHashFn implements HashFunction<MM_SparseDataTableEntryPointer>


It's still not final.

debugtools/DDR_VM/src/com/ibm/j9ddr/vm29/j9/ObjectToSparseDataHashTable.java

keithc-ca · 2025-02-11T20:34:18Z

debugtools/DDR_VM/src/com/ibm/j9ddr/vm29/tools/ddrinteractive/GetCommandsTask.java

@@ -45,6 +46,7 @@
 import com.ibm.j9ddr.vm29.tools.ddrinteractive.commands.DumpAllRegionsCommand;
 import com.ibm.j9ddr.vm29.tools.ddrinteractive.commands.DumpAllRomClassLinearCommand;
 import com.ibm.j9ddr.vm29.tools.ddrinteractive.commands.DumpAllSegmentsCommand;
+import com.ibm.j9ddr.vm29.tools.ddrinteractive.commands.DumpAllOffHeapEntriesCommand;


Please keep imports sorted.

keithc-ca · 2025-02-11T20:35:12Z

...DR_VM/src/com/ibm/j9ddr/vm29/tools/ddrinteractive/commands/DumpAllOffHeapEntriesCommand.java

+
+
+public class DumpAllOffHeapEntriesCommand extends Command


One blank line at a time is sufficient. Please add the missing javadoc.

The javadoc is still missing.

...DR_VM/src/com/ibm/j9ddr/vm29/tools/ddrinteractive/commands/DumpAllOffHeapEntriesCommand.java

keithc-ca · 2025-02-11T20:36:17Z

...DR_VM/src/com/ibm/j9ddr/vm29/tools/ddrinteractive/commands/DumpAllOffHeapEntriesCommand.java

+								if (!J9BuildFlags.J9VM_ENV_DATA64) {
+									throw new CorruptDataException("32-bit JVM should not contain any off heap.%n");
+								}


Please remove this dead code (and the related import).

The import is still present; please remove it.

...DR_VM/src/com/ibm/j9ddr/vm29/tools/ddrinteractive/commands/DumpAllOffHeapEntriesCommand.java

keithc-ca · 2025-02-13T21:27:27Z

debugtools/DDR_VM/src/com/ibm/j9ddr/vm29/j9/ObjectToSparseDataHashTable.java

+	}
+
+	/**
+	 * Opens J9HashTable from J9HashTablePointer。


Please use an ASCII period (., not 。).

keithc-ca · 2025-02-13T21:33:11Z

...DR_VM/src/com/ibm/j9ddr/vm29/tools/ddrinteractive/commands/DumpAllOffHeapEntriesCommand.java

+import com.ibm.j9ddr.tools.ddrinteractive.Context;
+import com.ibm.j9ddr.tools.ddrinteractive.DDRInteractiveCommandException;
+import com.ibm.j9ddr.tools.ddrinteractive.Command;
+import com.ibm.j9ddr.vm29.j9.HashTable;
+import com.ibm.j9ddr.vm29.j9.ObjectToSparseDataHashTable;
+import com.ibm.j9ddr.vm29.j9.SlotIterator;
+import com.ibm.j9ddr.vm29.j9.gc.GCBase;
+import com.ibm.j9ddr.vm29.pointer.generated.J9HashTablePointer;
+import com.ibm.j9ddr.vm29.pointer.generated.MM_GCExtensionsPointer;
+import com.ibm.j9ddr.vm29.pointer.generated.MM_SparseAddressOrderedFixedSizeDataPoolPointer;
+import com.ibm.j9ddr.vm29.pointer.generated.MM_SparseDataTableEntryPointer;
+import com.ibm.j9ddr.vm29.pointer.generated.MM_SparseVirtualMemoryPointer;
+import com.ibm.j9ddr.vm29.pointer.VoidPointer;


Please sort imports.

keithc-ca · 2025-02-13T21:34:01Z

...DR_VM/src/com/ibm/j9ddr/vm29/tools/ddrinteractive/commands/DumpAllOffHeapEntriesCommand.java

+{
+	public DumpAllOffHeapEntriesCommand()
+	{
+		addCommand("dumpalloffheapentries", "cmd|help", "dump all off-heap entries");


Suggest cmd|help should instead be [help].

- new DumpAllOffHeapEntriesCommand provides a way to list all off-heap entries in the core file, which contain off heap data (only when off-heap has been enabled in jvm and gcpolicy has been set to Balanced GC mode). - for the rest of cases(off-heap has been disabled or "old core file", which did not contain off-heap option at all), print out error message "This command only works with the core file, which contains off-heap." - off-heap entry information includes the address of the Array Object, the data address and the size of array data Signed-off-by: lhu <[email protected]>

keithc-ca · 2025-02-14T15:40:46Z

...DR_VM/src/com/ibm/j9ddr/vm29/tools/ddrinteractive/commands/DumpAllOffHeapEntriesCommand.java

+import com.ibm.j9ddr.vm29.j9.gc.GCBase;
+import com.ibm.j9ddr.vm29.j9.HashTable;
+import com.ibm.j9ddr.vm29.j9.ObjectToSparseDataHashTable;
+import com.ibm.j9ddr.vm29.j9.SlotIterator;
+import com.ibm.j9ddr.vm29.pointer.generated.J9HashTablePointer;
+import com.ibm.j9ddr.vm29.pointer.generated.MM_GCExtensionsPointer;
+import com.ibm.j9ddr.vm29.pointer.generated.MM_SparseAddressOrderedFixedSizeDataPoolPointer;
+import com.ibm.j9ddr.vm29.pointer.generated.MM_SparseDataTableEntryPointer;
+import com.ibm.j9ddr.vm29.pointer.generated.MM_SparseVirtualMemoryPointer;
+import com.ibm.j9ddr.vm29.pointer.VoidPointer;


Imports should be sorted with subpackages following their parent package; GCBase and VoidPointer should be placed like this:

import com.ibm.j9ddr.vm29.j9.SlotIterator; import com.ibm.j9ddr.vm29.j9.gc.GCBase; import com.ibm.j9ddr.vm29.pointer.VoidPointer; import com.ibm.j9ddr.vm29.pointer.generated.J9HashTablePointer;

LinHu2016 force-pushed the DDR_update4offheap branch 2 times, most recently from 73c3599 to 37ff513 Compare February 3, 2025 16:20

LinHu2016 force-pushed the DDR_update4offheap branch 2 times, most recently from 4658ac3 to c21c507 Compare February 3, 2025 18:56

amicic added the comp:gc label Feb 5, 2025

keithc-ca requested changes Feb 5, 2025

View reviewed changes

LinHu2016 force-pushed the DDR_update4offheap branch 4 times, most recently from 9aa77cb to 9e709bf Compare February 7, 2025 17:34

keithc-ca changed the title ~~Add new DumpAllSparseHeapEntriesCommand in DDR~~ Add new DumpAllOffHeapEntriesCommand in DDR Feb 11, 2025

keithc-ca requested changes Feb 11, 2025

View reviewed changes

LinHu2016 force-pushed the DDR_update4offheap branch 3 times, most recently from 9caf04b to 27bd42b Compare February 13, 2025 17:16

keithc-ca requested changes Feb 13, 2025

View reviewed changes

LinHu2016 force-pushed the DDR_update4offheap branch from 27bd42b to f8e78c1 Compare February 14, 2025 14:52

keithc-ca reviewed Feb 14, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add new DumpAllOffHeapEntriesCommand in DDR #21047

Add new DumpAllOffHeapEntriesCommand in DDR #21047

LinHu2016 commented Jan 31, 2025 •

edited

Loading

LinHu2016 commented Feb 3, 2025 •

edited

Loading

dmitripivkine commented Feb 3, 2025

LinHu2016 commented Feb 3, 2025

amicic commented Feb 5, 2025

keithc-ca Feb 5, 2025

keithc-ca Feb 5, 2025

keithc-ca Feb 5, 2025

keithc-ca Feb 5, 2025

keithc-ca Feb 5, 2025

keithc-ca Feb 5, 2025

keithc-ca Feb 5, 2025

keithc-ca Feb 5, 2025

keithc-ca Feb 5, 2025

keithc-ca Feb 5, 2025

keithc-ca Feb 11, 2025

keithc-ca Feb 12, 2025

keithc-ca Feb 11, 2025

keithc-ca Feb 11, 2025

keithc-ca Feb 11, 2025

keithc-ca Feb 12, 2025

keithc-ca Feb 11, 2025

keithc-ca Feb 12, 2025

keithc-ca Feb 13, 2025

keithc-ca Feb 13, 2025

keithc-ca Feb 13, 2025

keithc-ca Feb 14, 2025

Add new DumpAllOffHeapEntriesCommand in DDR #21047

Are you sure you want to change the base?

Add new DumpAllOffHeapEntriesCommand in DDR #21047

Conversation

LinHu2016 commented Jan 31, 2025 • edited Loading

LinHu2016 commented Feb 3, 2025 • edited Loading

dmitripivkine commented Feb 3, 2025

LinHu2016 commented Feb 3, 2025

amicic commented Feb 5, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

LinHu2016 commented Jan 31, 2025 •

edited

Loading

LinHu2016 commented Feb 3, 2025 •

edited

Loading