Diagnostics for DynComp

.circleci/config.yml

@@ -329,7 +329,7 @@ jobs:
           paths:
             - ".git"
       - run:
-          command: ./scripts/test-misc.sh
+          command: export COMSPEC="" && export ComSpec="" && ./scripts/test-misc.sh
           no_output_timeout: 20m
   misc-ubuntu-jdk11:
     docker:
@@ -351,7 +351,7 @@ jobs:
           paths:
             - ".git"
       - run:
-          command: ./scripts/test-misc.sh
+          command: export COMSPEC="" && export ComSpec="" && ./scripts/test-misc.sh
           no_output_timeout: 20m
   misc-ubuntu-jdk17:
     docker:
@@ -373,7 +373,7 @@ jobs:
           paths:
             - ".git"
       - run:
-          command: ./scripts/test-misc.sh
+          command: export COMSPEC="" && export ComSpec="" && ./scripts/test-misc.sh
           no_output_timeout: 20m
   misc-ubuntu-jdk21:
     docker:
@@ -395,7 +395,7 @@ jobs:
           paths:
             - ".git"
       - run:
-          command: ./scripts/test-misc.sh
+          command: export COMSPEC="" && export ComSpec="" && ./scripts/test-misc.sh
           no_output_timeout: 20m
   misc-ubuntu-jdk25:
     docker:
@@ -417,7 +417,7 @@ jobs:
           paths:
             - ".git"
       - run:
-          command: ./scripts/test-misc.sh
+          command: export COMSPEC="" && export ComSpec="" && ./scripts/test-misc.sh
           no_output_timeout: 20m
 
   kvasir-ubuntu-jdk8:
@@ -939,7 +939,7 @@ jobs:
           paths:
             - ".git"
       - run:
-          command: ./scripts/test-misc.sh
+          command: export COMSPEC="" && export ComSpec="" && ./scripts/test-misc.sh
           no_output_timeout: 20m
   misc-rockylinux-jdk25:
     docker:
@@ -961,7 +961,7 @@ jobs:
           paths:
             - ".git"
       - run:
-          command: ./scripts/test-misc.sh
+          command: export COMSPEC="" && export ComSpec="" && ./scripts/test-misc.sh
           no_output_timeout: 20m
 
   kvasir-rockylinux-jdk8:

.circleci/defs.m4

@@ -56,7 +56,7 @@ define([misc_job], [dnl
       - image: mdernst/daikon-$1-jdk$2-plus
 circleci_boilerplate(full)
       - run:
-          command: ./scripts/test-misc.sh
+          command: export COMSPEC="" && export ComSpec="" && ./scripts/test-misc.sh
           no_output_timeout: 20m])dnl
 dnl
 define([kvasir_job], [dnl

Makefile

@@ -322,7 +322,7 @@ nightly-test-except-doc-pdf:
 	${MAKE} junit test
 
 # Code style; defines `style-check` and `style-fix`.
-CODE_STYLE_EXCLUSIONS_USER := --exclude-dir kvasir-tests --exclude-dir six170 --exclude-dir .utils --exclude clustering.html
+CODE_STYLE_EXCLUSIONS_USER := --exclude-dir kvasir-tests --exclude-dir six170 --exclude-dir .utils --exclude-dir .plume-scripts --exclude clustering.html
 ifeq (,$(wildcard .plume-scripts))
 dummy := $(shell git clone -q https://github.com/plume-lib/plume-scripts.git .plume-scripts)
 endif

doc/Makefile

@@ -4,6 +4,8 @@ all-except-pdf: config-options.texinfo invariants-doc.texinfo html-chap html
 TEXI2HTML ?= makeinfo --html
 
 HTMLTOOLS ?= ../.utils/html-tools
+# `cronic` suppresses output unless the wrapped command fails.
+CRONIC ?= ../.utils/plume-scripts/cronic
 
 daikon.info: daikon.texinfo config-options.texinfo invariants-doc.texinfo
 # Large split size fixes an apparent bug in makeinfo 4.11:
@@ -32,7 +34,7 @@ invariants-doc.texinfo:
 	${MAKE} -C ../java ../doc/invariants-doc.texinfo
 
 # Always remake config-options.texinfo
-# (We delegate to ../java/Makefile, which is more discerning)
+# (We delegate to ../java/Makefile, which is more discerning.)
 .PHONY : config-options.texinfo
 .PHONY : invariants-doc.texinfo
 endif
@@ -66,6 +68,7 @@ daikon-fast: daikon.texinfo
 ../.utils/html-tools:
 	${MAKE} -C .. update-html-tools
 
+${CRONIC}: ../.utils/plume-scripts
 ../.utils/plume-scripts:
 	${MAKE} -C .. update-plume-scripts-in-utils
 
@@ -87,9 +90,9 @@ html-chap: daikon/index.html developer/index.html
 
 # The "subdir" flag does not copy over images, so the
 # pathnames become incorrect.  We need to copy them over ourselves.
-daikon/index.html: daikon.texinfo config-options.texinfo invariants-doc.texinfo images/dfepl-flow.jpg ../.utils/html-tools
+daikon/index.html: daikon.texinfo config-options.texinfo invariants-doc.texinfo images/dfepl-flow.jpg ../.utils/html-tools ../.utils/plume-scripts
 	rm -rf daikon/*
-	${TEXI2HTML} --split=chapter -o daikon $<
+	${CRONIC} ${TEXI2HTML} --split=chapter -o daikon $<
 	# Fixup 'bad' href(s) inserted by makeinfo.
 	perl -pi -e 's|../dir/index.html|../index.html|;' daikon/index.html
 	perl -pi -e 's|href="CHANGELOG.md"|href="../CHANGELOG.md"|;' daikon/*.html
@@ -98,9 +101,9 @@ daikon/index.html: daikon.texinfo config-options.texinfo invariants-doc.texinfo
 	cp images/*.jpg daikon/images
 	cd daikon && ../${HTMLTOOLS}/html-add-favicon . ../daikon-favicon.png
 
-developer/index.html: developer.texinfo ../.utils/html-tools
+developer/index.html: developer.texinfo ../.utils/html-tools ${CRONIC}
 	rm -rf developer/*
-	${TEXI2HTML} --split=chapter -o developer $<
+	${CRONIC} ${TEXI2HTML} --split=chapter -o developer $<
 	# Fixup 'bad' href inserted by makeinfo.
 	perl -pi -e 's|../dir/index.html|../index.html|;' developer/index.html
 	mkdir developer/images
@@ -110,11 +113,11 @@ developer/index.html: developer.texinfo ../.utils/html-tools
 
 pdf: daikon.pdf images/dfepl-flow.eps developer.pdf
 
-daikon.pdf: daikon.texinfo config-options.texinfo invariants-doc.texinfo
-	makeinfo --pdf $<
+daikon.pdf: daikon.texinfo config-options.texinfo invariants-doc.texinfo ${CRONIC}
+	${CRONIC} makeinfo --pdf $<
 
-developer.pdf: developer.texinfo
-	makeinfo --pdf $<
+developer.pdf: developer.texinfo ${CRONIC}
+	${CRONIC} makeinfo --pdf $<
 
 # Note that the clean target does not remove invariants-doc.texinfo or
 # config-options.texinfo.

java/daikon/chicory/DaikonVariableInfo.java

@@ -195,7 +195,11 @@ protected void addChild(DaikonVariableInfo info) {
     children.add(info);
   }
 
-  /** Returns a string representation of this node. */
+  /**
+   * Returns a string representation of this node.
+   *
+   * <p>This implementation returns its run-time class and its name.
+   */
   @SideEffectFree
   @Override
   public String toString(@GuardSatisfied DaikonVariableInfo this) {
@@ -1391,6 +1395,9 @@ public boolean isStatic() {
    */
   private boolean check_for_dup_names() {
 
+    // TODO: It seems wrong to choose the first occurrence of the variable, which could be a nested
+    // occurrence rather than the canonical top-level occurrence.
+
     if (ppt_statics.contains(name)) {
       debug_vars.log("ignoring already included variable %s [%s]", name, getClass());
       // if (!isStatic()) {

java/daikon/dcomp/DCRuntime.java

@@ -18,17 +18,23 @@
 import daikon.chicory.StringInfo;
 import daikon.chicory.ThisObjInfo;
 import daikon.plumelib.bcelutil.SimpleLog;
+import daikon.plumelib.util.StringsPlume;
 import daikon.plumelib.util.WeakIdentityHashMap;
+import java.io.ByteArrayOutputStream;
+import java.io.PrintStream;
 import java.io.PrintWriter;
+import java.io.UnsupportedEncodingException;
 import java.lang.reflect.Array;
 import java.lang.reflect.Field;
 import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;
 import java.lang.reflect.Modifier;
+import java.nio.charset.StandardCharsets;
 import java.time.LocalDateTime;
 import java.time.ZoneId;
 import java.util.ArrayDeque;
 import java.util.ArrayList;
+import java.util.Collection;
 import java.util.Collections;
 import java.util.Deque;
 import java.util.HashMap;
@@ -2236,6 +2242,20 @@ private static String skinnyOutput(DaikonVariableInfo dv, boolean on) {
   private static class DVSet extends ArrayList<DaikonVariableInfo> implements Comparable<DVSet> {
     static final long serialVersionUID = 20050923L;
 
+    /** Creates an empty DVSet. */
+    private DVSet() {
+      super();
+    }
+
+    /**
+     * Creates a DVSet with that contains the given variables.
+     *
+     * @param variables the variables
+     */
+    private DVSet(Collection<DaikonVariableInfo> variables) {
+      super(variables);
+    }
+
     @Pure
     @Override
     public int compareTo(@GuardSatisfied DVSet this, DVSet s1) {
@@ -2257,7 +2277,6 @@ void sort() {
      *
      * @return a multi-line representation of the list of variables
      */
-    @SuppressWarnings("UnusedMethod") // TEMPORARY
     String toStringWithIdentityHashCode() {
       StringJoiner result = new StringJoiner(System.lineSeparator());
       result.add("DVSet(");
@@ -2270,8 +2289,8 @@ String toStringWithIdentityHashCode() {
   }
 
   /**
-   * Gets a list of comparability sets of Daikon variables. If the method has never been executed
-   * returns null (it would probably be better to return each variable in a separate set, but I
+   * Gets a list of comparability sets of Daikon variables. Returns null if the method has never
+   * been executed (it would probably be better to return each variable in a separate set, but I
    * wanted to differentiate this case for now).
    *
    * <p>The sets are calculated by processing each daikon variable and adding it to a list
@@ -2305,6 +2324,32 @@ String toStringWithIdentityHashCode() {
     return set_list;
   }
 
+  /**
+   * Produce debugging output for a {@code List<DVSet>}.
+   *
+   * @param dvsets a list of DVSet objects
+   * @param indent how many spaces to indent each line
+   * @return a string representation of {@code dvsets}
+   */
+  static String dvSetsToString(List<DVSet> dvsets, int indent) {
+    // On Java 11, do
+    //   ByteArrayOutputStream baos = new ByteArrayOutputStream();
+    //   try (PrintStream ps = new PrintStream(baos, true, StandardCharsets.UTF_8)) {
+    //   ...
+    //   return baos.toString(StandardCharsets.UTF_8);
+    // and drop the catch clause.
+    ByteArrayOutputStream baos = new ByteArrayOutputStream();
+    String utf8 = StandardCharsets.UTF_8.name();
+    try (PrintStream ps = new PrintStream(baos, true, utf8)) {
+      for (DVSet dvset : dvsets) {
+        ps.println(StringsPlume.indentLines(indent, dvset.toStringWithIdentityHashCode()));
+      }
+      return baos.toString(utf8);
+    } catch (UnsupportedEncodingException e) {
+      throw new Error(e);
+    }
+  }
+
   /**
    * Returns a map representing the tree of tracers. Represents the tree as entries in a map with
    * each parent node as the key to a set contains all its children. The parameter RootInfo node is
@@ -2421,14 +2466,37 @@ static void merge_class_comparability(ClassInfo ci) {
    */
   static void merge_dv_comparability(RootInfo src, RootInfo dest, String debuginfo) {
 
+    // TODO: Why does this take a RootInfo?  A RootInfo contains many more variables than we are
+    // interested in.
+    // What is a better way to obtain just the relevant DaikonVariableInfo objects for a given
+    // program point?
+
+    // TODO: We should never merge across different program points.
+
     debug_merge_comp.log("merge_dv_comparability: %s%n", debuginfo);
 
     debug_merge_comp.indent();
 
     // Create a map relating destination names to their variables
     Map<String, DaikonVariableInfo> dest_map = new LinkedHashMap<>();
     for (DaikonVariableInfo dest_var : varlist(dest)) {
-      dest_map.put(dest_var.getName(), dest_var);
+      String dest_var_name = dest_var.getName();
+      if (false) { // temporarily commented out because it is failing
+        if (dest_map.containsKey(dest_var_name)) {
+          DaikonVariableInfo old_dest_var = dest_map.get(dest_var_name);
+          String msg =
+              String.format(
+                  "duplicate var name %s%n from old_dest_var = %s%n and dest_var = %s%n" + " in %s",
+                  dest_var_name,
+                  old_dest_var.toStringWithIdentityHashCode(),
+                  dest_var.toStringWithIdentityHashCode(),
+                  new DVSet(varlist(dest)).toStringWithIdentityHashCode());
+          System.out.println(msg);
+          System.err.println(msg);
+          throw new Error(msg);
+        }
+      }
+      dest_map.put(dest_var_name, dest_var);
     }
 
     // Get the variable sets for the source

tests/Makefile.common

@@ -499,7 +499,7 @@ endif
 
 chicory: $(SCRATCH_FOR_DAIKON)/$(PROJECT_FILE).dtrace.gz
 $(SCRATCH_FOR_DAIKON)/$(PROJECT_FILE).dtrace.gz : $(SCRATCH_FOR_DAIKON)/.copy-timestamp \
-									$(INST_LIST_FILE) $(CHICORY_EXEC)
+						$(INST_LIST_FILE) $(CHICORY_EXEC)
 	@echo
 	@echo "### Run Chicory (${PROJECT_FILE})"
 	@echo