package daikon.dcomp;

import daikon.DynComp;
import daikon.chicory.ArrayInfo;
import daikon.chicory.ClassInfo;
import daikon.chicory.ComparabilityProvider;
import daikon.chicory.DaikonClassInfo;
import daikon.chicory.DaikonVariableInfo;
import daikon.chicory.DaikonWriter;
import daikon.chicory.DeclReader;
import daikon.chicory.DeclWriter;
import daikon.chicory.FieldInfo;
import daikon.chicory.MethodInfo;
import daikon.chicory.ParameterInfo;
import daikon.chicory.ReturnInfo;
import daikon.chicory.RootInfo;
import daikon.chicory.StaticObjInfo;
import daikon.chicory.StringInfo;
import daikon.chicory.ThisObjInfo;
import daikon.plumelib.bcelutil.SimpleLog;
import daikon.plumelib.util.WeakIdentityHashMap;
import java.io.PrintWriter;
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.time.LocalDateTime;
import java.time.ZoneId;
import java.util.ArrayDeque;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Deque;
import java.util.HashMap;
import java.util.HashSet;
import java.util.IdentityHashMap;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.checkerframework.checker.lock.qual.GuardSatisfied;
import org.checkerframework.checker.mustcall.qual.MustCall;
import org.checkerframework.checker.nullness.qual.Nullable;
import org.checkerframework.checker.nullness.qual.PolyNull;
import org.checkerframework.dataflow.qual.Pure;

/**
 * Runtime support for DynComp, a comparability front end for Chicory. This class is a collection of
 * methods; it should never be instantiated.
 */
@SuppressWarnings({"nullness", "interning"}) // tricky code, skip for now
public final class DCRuntime implements ComparabilityProvider {

  /** List of all instrumented methods. */
  public static final List<MethodInfo> methods = new ArrayList<>();

  /**
   * Keep track of whether or not we are already processing an enter/exit so we can avoid recursion.
   * Only really necessary during debugging (where we call toString()).
   */
  private static boolean in_enter_exit = false;

  /** Object used to represent nonsensical values. */
  private static final Object nonsensical = new Object();

  /** Object used to represent nonsensical list values. */
  private static final Object nonsensical_list = new Object();

  /** Depth to follow fields in classes. */
  public static int depth = 2;

  /** static count of tags in the JDK. Used as an offset for non-JDK code. */
  static int max_jdk_static = 100000;

  /** If the application exits with an exception, it should be placed here. */
  @SuppressWarnings("StaticAssignmentOfThrowable") // for debugging (I presume)
  public static @Nullable Throwable exit_exception = null;

  /** Storage for each static tag. */
  public static List<@Nullable Object> static_tags = new ArrayList<>();

  /**
   * Object used to mark procedure entries in the tag stack. It is pushed on the stack at entry and
   * checked on exit to make sure it is in on the top of the stack. That allows us to determine
   * which method caused a tag stack problem.
   */
  public static Object method_marker = new Object();

  /** Control debug printing. */
  public static boolean debug = false;

  /** Log comparability tage stack operations. */
  public static boolean debug_tag_frame = false;

  /** Log object compare operations. */
  public static boolean debug_objects = false;

  /** Log variable comparability operations. */
  public static SimpleLog merge_dv = new SimpleLog(false);

  /** Log array comparability operations. */
  public static SimpleLog debug_arr_index = new SimpleLog(false);

  /** Log primitive operations. */
  public static SimpleLog debug_primitive = new SimpleLog(false);

  /** Log comparability merges. */
  public static SimpleLog debug_merge_comp = new SimpleLog(false);

  /** Log excution time. */
  public static SimpleLog debug_timing = new SimpleLog(false);

  /** Log decl output. */
  public static SimpleLog debug_decl_print = new SimpleLog(false);

  /** Log excution time. */
  public static SimpleLog time_decl = new SimpleLog(false);

  /** Log internal data structure sizes. */
  public static SimpleLog map_info = new SimpleLog(false);

  /** If true, merge arrays and their indices. */
  private static boolean merge_arrays_and_indices = true;

  /** Decl writer to share output code with Chicory. */
  // Set in Premain.premain().
  static DeclWriter declWriter;

  /** Used for calling {@link ComparabilityProvider#getComparability}. */
  // Set in Premain.premain().
  static ComparabilityProvider comparabilityProvider;

  /** Whether the header has been printed. */
  private static boolean headerPrinted = false;

  /** Class to hold per-thread comparability data. */
  private static class ThreadData {
    /** Tag stack. */
    Deque<Object> tag_stack;

    /** Number of methods currently on tag_stack. */
    int tag_stack_call_depth;

    /** class initializer. */
    ThreadData() {
      tag_stack = new ArrayDeque<Object>();
      tag_stack_call_depth = 0;
    }
  }

  /** Map from Thread to ThreadData. */
  private static Map<Thread, ThreadData> thread_to_data =
      new ConcurrentHashMap<Thread, ThreadData>();

  /** Map from each object to the tags used for each primitive value in the object. */
  public static WeakIdentityHashMap<Object, Object[]> field_map =
      new WeakIdentityHashMap<Object, Object[]>();

  /** List of all classes encountered. These are the classes that will have comparability output. */
  private static List<ClassInfo> all_classes = new ArrayList<>();

  /** Set of classes whose static initializer has run. */
  private static Set<String> initialized_eclassses = new HashSet<>();

  /**
   * Class used as a tag for primitive constants. Only different from Object for debugging purposes.
   */
  private static class Constant {}

  /**
   * Class used as a tag for uninitialized instance fields. Only different from Object for debugging
   * purposes.
   */
  @SuppressWarnings("UnusedVariable") // used only for debugging
  private static class UninitFieldTag {
    String descr;
    Throwable stack_trace;

    public UninitFieldTag(String descr, Throwable stack_trace) {
      this.descr = descr;
      this.stack_trace = stack_trace;
    }
  }

  /**
   * Class used as a tag for uninitialized array elements. Only different from Object for debugging
   * purposes.
   */
  private static class UninitArrayElem {}

  /** Either java.lang.DCompMarker or daikon.dcomp.DCompMarker */
  private static Class<?> dcomp_marker_class;

  /** java.lang.Object */
  private static Class<Object> java_lang_Object_class;

  /** Perform any initialization required before instrumentation begins. */
  public static void init() {

    debug_decl_print.enabled = DynComp.debug_decl_print;
    if (Premain.debug_dcruntime) {
      debug = true;
      debug_tag_frame = true;
      debug_primitive.enabled = true;
    }
    if (Premain.debug_dcruntime_all) {
      debug = true;
      debug_tag_frame = true;
      debug_objects = true;
      merge_dv.enabled = true;
      debug_arr_index.enabled = true;
      debug_primitive.enabled = true;
      debug_merge_comp.enabled = true;
      debug_decl_print.enabled = true;
    }

    try {
      if (!DCInstrument.jdk_instrumented) {
        dcomp_marker_class = Class.forName("daikon.dcomp.DCompMarker");
      } else {
        dcomp_marker_class = Class.forName("java.lang.DCompMarker");
      }
      @SuppressWarnings("unchecked")
      Class<Object> tmp = (Class<Object>) Class.forName("java.lang.Object");
      java_lang_Object_class = tmp;
    } catch (Exception e) {
      throw new RuntimeException("Unexpected error initializing DCRuntime:", e);
    }

    // Initialize the array of static tags
    ((ArrayList<@Nullable Object>) static_tags).ensureCapacity(max_jdk_static);
    while (static_tags.size() <= max_jdk_static) {
      static_tags.add(null);
    }
  }

  public static void debug_print_call_stack() {
    if (!debug) {
      return;
    }

    StackTraceElement[] stack_trace;
    stack_trace = Thread.currentThread().getStackTrace();
    // [0] is getStackTrace
    // [1] is debug_print_call_stack
    for (int i = 2; i < stack_trace.length; i++) {
      System.out.printf("call stack: %s%n", stack_trace[i]);
    }
    System.out.println();
  }

  /**
   * Handles calls to instrumented equals() methods. Makes the arguments comparable, and returns
   * true if they are equals() to one another.
   *
   * @param o1 the first argument to equals()
   * @param o2 the second argument to equals()
   * @return whether the two values are equal
   */
  public static boolean dcomp_equals(Object o1, Object o2) {
    // Make obj1 and obj2 comparable
    if ((o1 != null) && (o2 != null)) {
      TagEntry.union(o1, o2);
    }

    if (debug) {
      System.out.printf("In dcomp_equals%n");
    }

    Method m;
    try {
      m =
          o1.getClass()
              .getMethod("equals_dcomp_instrumented", new Class<?>[] {java_lang_Object_class});
    } catch (NoSuchMethodException e) {
      m = null;
    } catch (Exception e) {
      throw new RuntimeException("unexpected error locating equal_dcomp_instrumented", e);
    }

    if (m != null) {
      try {
        // In case the class containing "equals_dcomp_instrumented" is not accessible:
        m.setAccessible(true);
        return (Boolean) m.invoke(o1, o2);
      } catch (Exception e) {
        throw new RuntimeException("unexpected error invoking equal_dcomp_instrumented", e);
      }
    }

    // Push tag for return value, and call the uninstrumented version
    ThreadData td = thread_to_data.get(Thread.currentThread());
    td.tag_stack.push(new Constant());
    if (debug_tag_frame) {
      System.out.printf("tag stack size: %d%n", td.tag_stack.size());
    }
    return o1.equals(o2);
  }

  /**
   * This map keeps track of active super.equals() calls.
   *
   * <p>Each time we make a call on a particular Object, we keep track of which superclass's equals
   * method we called last. If that Object makes another call to super.equals before the original
   * call is done, then invoke the equals method of the next-higher class in the class hierarchy
   * (i.e. the next superclass).
   *
   * <p>The map maps an Object to the last Class whose equals method we invoked while invoking that
   * Object's original super.equals call. Once the equals call terminates, whether by returning a
   * value or by throwing an exception, the corresponding key is removed from this map.
   */
  static Map<Object, Class<?>> active_equals_calls = new HashMap<>();

  /**
   * Handles {@code super.equals(Object)} calls. Makes the arguments comparable, and returns true if
   * super.equals() returns true for them
   *
   * @param o1 the first argument to super.equals()
   * @param o2 the second argument to super.equals()
   * @return whether the two values are equal, according to super.equals()
   * @see #active_equals_calls
   */
  public static boolean dcomp_super_equals(Object o1, Object o2) {
    // Make obj1 and obj2 comparable
    if ((o1 != null) && (o2 != null)) {
      TagEntry.union(o1, o2);
    }

    if (debug) {
      System.out.printf("In dcomp_super_equals%n");
    }

    Class<?> o1c = o1.getClass();
    Class<?> o1super;

    // Check to see if we're already in the middle of a super.equals
    // call for this Object
    if (null == active_equals_calls.get(o1)) {
      // No, we are not
      o1super = o1c.getSuperclass();
    } else {
      // Yes, we are -- continue up the class hierarchy
      o1super = active_equals_calls.get(o1).getSuperclass();
    }

    // Update the active_equals_calls map
    active_equals_calls.put(o1, o1super);

    Class<?>[] o1superifaces = o1super.getInterfaces();

    boolean instrumented = false;
    for (Class<?> c : o1superifaces) {
      if (c.getName().equals(DCInstrument.instrumentation_interface)) {
        instrumented = true;
        break;
      }
    }

    boolean return_val;
    try {
      // if the superclass whose method we are calling is instrumented...
      if (instrumented) {
        // call the instrumented version
        Method m =
            o1super.getMethod(
                "equals", new Class<?>[] {java_lang_Object_class, dcomp_marker_class});
        return_val = ((Boolean) m.invoke(o1, o2, null));
      } else {
        // Push tag for return value, and call the uninstrumented version
        @MustCall() ThreadData td = thread_to_data.get(Thread.currentThread());
        td.tag_stack.push(new Constant());
        Method m = o1super.getMethod("equals", new Class<?>[] {java_lang_Object_class});
        return_val = ((Boolean) m.invoke(o1, o2));
        if (debug_tag_frame) {
          System.out.printf("tag stack size: %d%n", td.tag_stack.size());
        }
      }
    } catch (NoSuchMethodException e) {
      System.err.printf("dcomp_super_equals(%s, %s)%n", obj_str(o1), obj_str(o2));
      System.err.printf("o1super %s%n", o1super);
      for (Class<?> c : o1superifaces) {
        System.err.printf("  o1super interface %s%n", c);
      }
      for (Method m : o1super.getDeclaredMethods()) {
        System.err.printf("  o1super method %s%n", m);
      }
      throw new RuntimeException(e);
    } catch (IllegalAccessException e) {
      throw new RuntimeException(e);
    } catch (InvocationTargetException e) {
      e.printStackTrace();
      throw new RuntimeException(e);
    } catch (Exception e) {
      throw new RuntimeException("unexpected error locating equals method", e);
    }

    // We are now done with the call, so remove the entry for this
    // call from the active_equals_calls map
    active_equals_calls.remove(o1);
    return return_val;
  }

  /**
   * Clone an object and return the cloned object.
   *
   * <p>DCInstrument guarantees we will not see a clone of an array. If the object has been
   * instrumented, call the instrumented version of clone; if not, call the uninstrumented version
   * and make the objects comparable. Really should make all of their fields comparable instead.
   *
   * @param orig_obj object being cloned
   * @param target_class class to search for clone method
   * @return the result of the clone
   * @throws Throwable if unable to clone object
   */
  public static Object dcomp_clone(Object orig_obj, Class<?> target_class) throws Throwable {
    if (debug) {
      System.out.printf("In dcomp_clone%n");
      System.out.printf("orig: %s, target: %s%n", orig_obj.getClass(), target_class);
    }

    Object clone_obj = null;
    while (true) {
      try {
        clone_obj = dcomp_clone_worker(orig_obj, target_class);
        assert (clone_obj != null);
        break;
      } catch (Exception e) {
        if (e.getCause() == null) {
          // Some exception other than NoSuchMethod.
          throw e;
        }
        if (e.getCause() instanceof java.lang.NoSuchMethodException) {
          if (debug) {
            System.out.println("NoSuchMethod " + target_class.getName());
          }

          // Should never reach top of class heirarchy without finding a clone() method.
          assert !target_class.getName().equals("java.lang.Object");

          // We didn't find a clone method, get next higher super and try again.
          target_class = target_class.getSuperclass();
        } else {
          // Some exception other than NoSuchMethod.
          throw e;
        }
      }
    }

    // Make orig_obj and its clone comparable.
    if ((orig_obj != null) && (clone_obj != null)) {
      TagEntry.union(orig_obj, clone_obj);
    }
    return clone_obj;
  }

  /**
   * Tracks active {@code super.clone()} calls.
   *
   * @see active_equals_calls
   */
  static Map<Object, Class<?>> active_clone_calls = new HashMap<>();

  /**
   * Handles {@code super.clone()} calls.
   *
   * <p>Clone an object using its superclass, and returns the cloned object.
   *
   * <p>DCInstrument guarantees we will not see a clone of an array. If the object has been
   * instrumented, call the instrumented version of clone; if not, call the uninstrumented version
   * and make the objects comparable. TODO: This really should make all of their fields comparable
   * instead.
   *
   * @param orig_obj object being cloned
   * @param target_class class to search for clone method
   * @return the result of the clone
   * @throws Throwable if unable to clone object
   * @see #active_clone_calls
   */
  public static Object dcomp_super_clone(Object orig_obj, Class<?> target_class) throws Throwable {
    if (debug) {
      System.out.printf("In dcomp_super_clone%n");
      System.out.printf("orig: %s, target: %s%n", orig_obj.getClass(), target_class);
    }

    // Check to see if we're already in the middle of a super.clone call for this object.
    if (null != active_clone_calls.get(orig_obj)) {
      // Yes, we are -- continue up the class hierarchy
      target_class = active_clone_calls.get(orig_obj).getSuperclass();
    }
    // Update the active_clone_calls map
    active_clone_calls.put(orig_obj, target_class);

    Object clone_obj = null;
    while (true) {
      try {
        clone_obj = dcomp_clone_worker(orig_obj, target_class);
        assert (clone_obj != null);
        break;
      } catch (Exception e) {

        if (e.getCause() == null) {
          // Some exception other than NoSuchMethod.
          active_clone_calls.remove(orig_obj);
          throw e;
        }
        if (e.getCause() instanceof java.lang.NoSuchMethodException) {
          if (debug) {
            System.out.println("NoSuchMethod " + target_class.getName());
          }

          // Should never reach top of class heirarchy without finding a clone() method.
          assert !target_class.getName().equals("java.lang.Object");

          // We didn't find a clone method, get next higher super and try again.
          target_class = active_clone_calls.get(orig_obj).getSuperclass();
          // Update the active_clone_calls map
          active_clone_calls.put(orig_obj, target_class);
        } else {
          // Some exception other than NoSuchMethod.
          active_clone_calls.remove(orig_obj);
          throw e;
        }
      }
    }

    // Make orig_obj and its clone comparable.
    if ((orig_obj != null) && (clone_obj != null)) {
      TagEntry.union(orig_obj, clone_obj);
    }
    active_clone_calls.remove(orig_obj);
    return clone_obj;
  }

  /**
   * Clone an object and return the cloned object. Throws an exception if unable to clone object.
   *
   * <p>DCInstrument guarantees we will not see a clone of an array. If the object has been
   * instrumented, call the instrumented version of clone; if not, call the uninstrumented version.
   *
   * <p>Note: we use getDeclaredMethod as clone is often protected; also, in the case of
   * dcomp_super_clone we do not want to automatically find clone in a superclass. We will search
   * the hierarchy ourselves.
   *
   * @param orig_obj object being cloned
   * @param target_class class to search for clone method
   * @return the result of the clone
   * @throws Throwable if unable to clone object
   */
  public static Object dcomp_clone_worker(Object orig_obj, Class<?> target_class) throws Throwable {
    if (debug) {
      System.out.printf("In dcomp_clone_worker%n");
      System.out.printf("orig_obj: %s, target_class: %s%n", obj_str(orig_obj), target_class);
    }

    Method m = null;
    try {
      m = target_class.getDeclaredMethod("clone", new Class<?>[] {dcomp_marker_class});
    } catch (NoSuchMethodException e) {
      m = null;
    } catch (Exception e) {
      throw new RuntimeException("unexpected error locating clone(DCompMarker)", e);
    }

    if (m != null) {
      try {
        if (debug) {
          System.out.printf("found: %s%n", m);
        }
        // In case the class containing "clone()" is not accessible
        // or clone() is protected.
        m.setAccessible(true);
        // Since invoke takes a variable number of arguments, we use an array containing null
        // as the DCompMarker to distinguish from just null, which indicates 0 arguments.
        return m.invoke(orig_obj, new Object[] {null});
      } catch (InvocationTargetException e) {
        // This might happen - if an exception is thrown from clone(),
        // propagate it by rethrowing it.
        throw e.getCause();
      } catch (Exception e) {
        throw new RuntimeException(
            "unexpected error invoking clone(DCompMarker) on object of class "
                + orig_obj.getClass(),
            e);
      }
    }

    // No instrumented clone(), try for uninstrumented version.
    try {
      m = target_class.getDeclaredMethod("clone", new Class<?>[] {});
    } catch (NoSuchMethodException e) {
      throw new RuntimeException("unable to locate clone()", e);
    } catch (Exception e) {
      throw new RuntimeException("unexpected error locating clone()", e);
    }
    try {
      if (debug) {
        System.out.printf("found: %s%n", m);
      }
      // In case the class containing "clone()" is not accessible
      // or clone() is protected.
      m.setAccessible(true);
      return m.invoke(orig_obj);
    } catch (InvocationTargetException e) {
      // This might happen - if an exception is thrown from clone(),
      // propagate it by rethrowing it.
      throw e.getCause();
    } catch (Exception e) {
      throw new RuntimeException(
          "unexpected error invoking clone() on object of class " + orig_obj.getClass(), e);
    }
  }

  /**
   * Handle object comparison. Marks the two objects as comparable and returns whether or not they
   * are equal. Used as part of a replacement for IF_ACMPEQ.
   */
  public static boolean object_eq(Object obj1, Object obj2) {

    if (debug_objects) {
      System.out.printf("comparing (eq) '%s' and '%s'%n", obj_str(obj1), obj_str(obj2));
    }

    // Note that obj1 and obj2 are comparable
    if ((obj1 != null) && (obj2 != null)) {
      TagEntry.union(obj1, obj2);
    }

    return (obj1 == obj2);
  }

  /**
   * Handle object comparison. Marks the two objects as comparable and returns whether or not they
   * are equal. Used as part of a replacement for IF_ACMPNE.
   */
  public static boolean object_ne(Object obj1, Object obj2) {

    if (debug_objects) {
      System.out.printf("comparing (ne) '%s' and '%s'%n", obj_str(obj1), obj_str(obj2));
    }
    // Note that obj1 and obj2 are comparable
    if ((obj1 != null) && (obj2 != null)) {
      TagEntry.union(obj1, obj2);
    }

    return (obj1 != obj2);
  }

  static Map<String, Integer> methodCountMap = new HashMap<>(64);

  /**
   * Create the tag frame for this method. Pop the tags for any primitive parameters off of the tag
   * stack and store them in the tag frame.
   *
   * @param params encodes the position of the primitive parameters into a string. The first
   *     character is size of the tag frame. The remaining characters indicate where each parameter
   *     on the tag stack should be stored into the frame. For example "20" allocates a tag frame
   *     with two elements and stores the top of the tag stack into element 0. A string is used for
   *     simplicity in code generation since strings can easily be placed into the constant portion
   *     of the class file. Note that characters are determined by adding the integer value to '0'.
   *     Values greater than 9 will have unintuitive (but printable) values.
   * @return the allocated and initialized tag frame
   */
  public static Object[] create_tag_frame(String params) {
    if (debug) {
      System.out.printf("%nEnter: %s%n", caller_name());
    }

    if (DynComp.verbose) {
      String method_name = caller_name();
      Integer count = methodCountMap.get(method_name);
      if (count == null) {
        count = 1;
      } else {
        count = count.intValue() + 1;
      }
      methodCountMap.put(method_name, count);
    }

    // create_tag_frame is the first DCRuntime method called for an
    // instrumented user method.  Since it might be on a new thread
    // we need to check/set the per-thread data map.
    Thread t = Thread.currentThread();
    ThreadData td = thread_to_data.computeIfAbsent(t, __ -> new ThreadData());

    int frame_size = ((int) params.charAt(0)) - '0';
    // Character.digit (params.charAt(0), Character.MAX_RADIX);
    Object[] tag_frame = new Object[frame_size];
    if (debug_tag_frame) {
      System.out.printf(
          "Creating tag frame of size %d [%s] for %s%n", frame_size, params, caller_name());
    }
    for (int ii = 1; ii < params.length(); ii++) {
      int offset = params.charAt(ii) - '0';
      // Character.digit (params.charAt(ii), Character.MAX_RADIX);
      assert td.tag_stack.peek() != method_marker;
      tag_frame[offset] = td.tag_stack.pop();
      if (debug_tag_frame) {
        System.out.printf("popped %s into tag_frame[%d]%n", tag_frame[offset], offset);
      }
    }

    // Push the method marker on the tag stack (now that we have removed
    // the parameters
    td.tag_stack.push(method_marker);
    // save the tag stack call_depth for debugging
    tag_frame[frame_size - 1] = ++td.tag_stack_call_depth;
    if (debug_tag_frame) {
      System.out.printf("push method marker tag: %s%n", method_marker);
      System.out.printf("tag stack call_depth: %d%n", td.tag_stack_call_depth);
      System.out.printf("tag stack size: %d%n", td.tag_stack.size());
    }

    // debug_print_call_stack();

    return tag_frame;
  }

  /**
   * Make sure the tag stack for this method is empty before exit.
   *
   * @param tag_frame the tag frame
   */
  public static void normal_exit(Object[] tag_frame) {
    if (debug) {
      System.out.printf("Begin normal exit from %s%n", caller_name());
    }

    ThreadData td = thread_to_data.get(Thread.currentThread());
    if (td.tag_stack.peek() != method_marker) {
      // Something has gone wrong.  It's probably an exception that
      // was handled by an exception handler other than one added by
      // DCInstrument. From an <init> method or native code, for example.
      if (debug_tag_frame) {
        System.out.printf("tag stack value mismatch! top not method marker%n");
        Thread.dumpStack();
      }
      // discard tags until we get to a method marker
      while (td.tag_stack.peek() != method_marker) td.tag_stack.pop();
    }

    int orig_tag_stack_call_depth = ((Integer) tag_frame[tag_frame.length - 1]).intValue();
    if (td.tag_stack_call_depth != orig_tag_stack_call_depth) {
      // Something has gone wrong.  It's almost certainly an exception that
      // was handled by an exception handler other than one added by
      // DCInstrument. From an <init> method or native code, for example.
      if (debug_tag_frame) {
        System.out.printf(
            "tag stack call_depth mismatch! at %d expected %d%n",
            td.tag_stack_call_depth, orig_tag_stack_call_depth);
        Thread.dumpStack();
      }
    }
    while (td.tag_stack_call_depth > orig_tag_stack_call_depth) {
      td.tag_stack.pop(); // discard marker
      td.tag_stack_call_depth--;
      // discard tags until we get to a method marker
      while (td.tag_stack.peek() != method_marker) td.tag_stack.pop();
    }

    // now do normal exit process
    td.tag_stack.pop(); // discard marker
    td.tag_stack_call_depth--;
    if (debug_tag_frame) {
      System.out.printf("tag stack call_depth: %d%n", td.tag_stack_call_depth);
      System.out.printf("tag stack size: %d%n", td.tag_stack.size());
    }
    if (debug) {
      System.out.printf("Normal exit from %s%n%n", caller_name());
    }
  }

  /**
   * Called for exits from methods with a primitive return type. Pop the return type off of the tag
   * stack, make sure the tags stack is empty for this method and then put the return value back on
   * the tag stack.
   *
   * @param tag_frame the tag frame
   */
  public static void normal_exit_primitive(Object[] tag_frame) {
    if (debug) {
      System.out.printf("Begin normal exit primitive from %s%n", caller_name());
    }

    ThreadData td = thread_to_data.get(Thread.currentThread());
    Object ret_tag = td.tag_stack.pop(); // save what we hope is the return value tag
    assert ret_tag != null;

    if (td.tag_stack.peek() != method_marker) {
      // Something has gone wrong.  It's probably an exception that
      // was handled by an exception handler other than one added by
      // DCInstrument. From an <init> method or native code, for example.
      if (debug_tag_frame) {
        System.out.printf("tag stack value mismatch! top not method marker%n");
        Thread.dumpStack();
      }
      // discard tags until we get to a method marker
      while (td.tag_stack.peek() != method_marker) td.tag_stack.pop();
    }

    int orig_tag_stack_call_depth = ((Integer) tag_frame[tag_frame.length - 1]).intValue();
    if (td.tag_stack_call_depth != orig_tag_stack_call_depth) {
      // Something has gone wrong.  It's almost certainly an exception that
      // was handled by an exception handler other than one added by
      // DCInstrument. From an <init> method or native code, for example.
      if (debug_tag_frame) {
        System.out.printf(
            "tag stack call_depth mismatch! at %d expected %d%n",
            td.tag_stack_call_depth, orig_tag_stack_call_depth);
        Thread.dumpStack();
      }
    }
    while (td.tag_stack_call_depth > orig_tag_stack_call_depth) {
      td.tag_stack.pop(); // discard marker
      td.tag_stack_call_depth--;
      // discard tags until we get to a method marker
      while (td.tag_stack.peek() != method_marker) td.tag_stack.pop();
    }

    // now do normal exit process
    td.tag_stack.pop(); // discard marker
    td.tag_stack_call_depth--;
    if (debug_tag_frame) {
      System.out.printf("tag stack call_depth: %d%n", td.tag_stack_call_depth);
    }
    if (debug) {
      System.out.printf("Normal exit primitive from %s%n%n", caller_name());
    }
    td.tag_stack.push(ret_tag);
    if (debug_tag_frame) {
      System.out.printf("push return value tag: %s%n", ret_tag);
      System.out.printf("tag stack size: %d%n", td.tag_stack.size());
    }
  }

  /**
   * Clean up the tag stack on an exception exit from a method. Pops items off of the tag stack
   * until the method marker is found.
   *
   * @param throwable cause of the exception
   */
  public static void exception_exit(Object throwable) {
    if (debug) {
      System.out.printf("Begin exception exit from %s%n", caller_name());
      ((Throwable) throwable).printStackTrace();
    }

    ThreadData td = thread_to_data.get(Thread.currentThread());
    td.tag_stack_call_depth--;
    if (debug_tag_frame) {
      System.out.printf("tag stack call_depth: %d%n", td.tag_stack_call_depth);
    }
    if (debug) {
      System.out.printf("Exception exit from %s%n", caller_name());
    }
    while (!td.tag_stack.isEmpty()) {
      if (td.tag_stack.pop() == method_marker) {
        if (debug_tag_frame) {
          System.out.printf("tag stack size: %d%n", td.tag_stack.size());
        }
        return;
      }
    }

    System.err.printf("Method marker not found in exception exit%n");
  }

  /** Cleans up the tag stack when an exception is thrown. */
  public static void throw_op() {
    if (debug) {
      System.out.printf("In throw_op%n");
    }
    ThreadData td = thread_to_data.get(Thread.currentThread());
    while (td.tag_stack.peek() != method_marker) td.tag_stack.pop();
    if (debug_tag_frame) {
      System.out.printf("tag stack size: %d%n", td.tag_stack.size());
    }
  }

  /** Pushes the tag at tag_frame[index] on the tag stack. */
  public static void push_local_tag(Object[] tag_frame, int index) {

    ThreadData td = thread_to_data.get(Thread.currentThread());
    debug_primitive.log("push_local_tag[%d] %s%n", index, tag_frame[index]);
    assert tag_frame[index] != null : "index " + index;
    td.tag_stack.push(tag_frame[index]);
    if (debug_tag_frame) {
      System.out.printf("tag stack size: %d%n", td.tag_stack.size());
    }
  }

  /** Pops the top of the tag stack into tag_frame[index] */
  public static void pop_local_tag(Object[] tag_frame, int index) {

    ThreadData td = thread_to_data.get(Thread.currentThread());
    assert td.tag_stack.peek() != method_marker;
    tag_frame[index] = td.tag_stack.pop();
    assert tag_frame[index] != null : "index " + index;
    debug_primitive.log("pop_local_tag[%d] %s%n", index, tag_frame[index]);
    if (debug_tag_frame) {
      System.out.printf("tag stack size: %d%n", td.tag_stack.size());
    }
  }

  /** Pushes the tag associated with the static static_num on the tag stack. */
  public static void push_static_tag(int static_num) {

    ThreadData td = thread_to_data.get(Thread.currentThread());
    Object static_tag = static_tags.get(static_num);
    if (static_tag == null) {
      static_tag = new Object();
      static_tags.set(static_num, static_tag);
    }
    td.tag_stack.push(static_tag);
    debug_primitive.log("push_static_tag[%d] %s%n", static_num, static_tag);
    if (debug_tag_frame) {
      System.out.printf("tag stack size: %d%n", td.tag_stack.size());
    }
  }

  /**
   * Pushes an array reference on the tag stack.
   *
   * @param arr_ref array being accessed
   */
  public static void push_array_tag(Object arr_ref) {

    ThreadData td = thread_to_data.get(Thread.currentThread());
    td.tag_stack.push(arr_ref);
    if (debug_arr_index.enabled()) {
      debug_arr_index.log("push_array_tag %s%n", obj_str(arr_ref));
    }
    if (debug_tag_frame) {
      System.out.printf("tag stack size: %d%n", td.tag_stack.size());
    }
  }

  /**
   * Pops the top of the tag stack into the tag storage for static_num.
   *
   * @param static_num identifies the static variable being accessed
   */
  public static void pop_static_tag(int static_num) {

    ThreadData td = thread_to_data.get(Thread.currentThread());
    assert td.tag_stack.peek() != method_marker;
    static_tags.set(static_num, td.tag_stack.pop());
    assert static_tags.get(static_num) != null;
    debug_primitive.log("pop_static_tag[%d] %s%n", static_num, static_tags.get(static_num));
    if (debug_tag_frame) {
      System.out.printf("tag stack size: %d%n", td.tag_stack.size());
    }
  }

  /**
   * Discard the tag on the top of the tag stack. Called when primitives are pushed but not used in
   * expressions (such as when allocating arrays). (No longer used?)
   *
   * @param cnt number of tags to discard
   */
  public static void discard_tag(int cnt) {
    if (debug) {
      System.out.printf("In discard_tag%n");
    }

    ThreadData td = thread_to_data.get(Thread.currentThread());
    // debug_print_call_stack();
    while (--cnt >= 0) {
      assert td.tag_stack.peek() != method_marker;
      if (debug) {
        System.out.printf("   discard a tag%n");
      }
      td.tag_stack.pop();
    }
    if (debug_tag_frame) {
      System.out.printf("tag stack size: %d%n", td.tag_stack.size());
    }
  }

  /**
   * Manipulate the tags for an array store instruction. The tag at the top of stack is stored into
   * the tag storage for the array. Mark the array and the index as comparable.
   *
   * @param arr_ref array being accessed
   * @param length size of the array
   * @param index index of the array element being accessed
   */
  private static void primitive_array_store(Object arr_ref, int length, int index) {
    if (debug) {
      System.out.printf("In primitive_array_store%n");
    }

    // This is a helper routine always called as the first step
    // so we can set the per-thread data here.
    ThreadData td = thread_to_data.get(Thread.currentThread());

    // look for the tag storage for this array
    Object[] obj_tags = field_map.get(arr_ref);

    // If none has been allocated, allocate the space and associate it with
    // the array
    if (obj_tags == null) {
      obj_tags = new Object[length];
      field_map.put(arr_ref, obj_tags);
    }

    // Pop the tag off of the stack and assign it into the tag storage for
    // this index
    assert td.tag_stack.peek() != method_marker;
    obj_tags[index] = td.tag_stack.pop();
    if (debug_primitive.enabled()) {
      debug_primitive.log("array store %s[%d] = %s%n", obj_str(arr_ref), index, obj_tags[index]);
    }

    // Mark the arry and its index as comparable
    assert td.tag_stack.peek() != method_marker;
    Object index_tag = td.tag_stack.pop();
    if (debug_arr_index.enabled()) {
      debug_arr_index.log("Merging array '%s' and index '%s'", obj_str(arr_ref), index_tag);
    }
    if (merge_arrays_and_indices) {
      TagEntry.union(arr_ref, index_tag);
    }
    if (debug_tag_frame) {
      System.out.printf("tag stack size: %d%n", td.tag_stack.size());
    }
  }

  /** Execute an aastore instruction and mark the array and its index as comparable. */
  public static void aastore(Object[] arr, int index, Object val) {

    ThreadData td = thread_to_data.get(Thread.currentThread());
    // Mark the array and its index as comparable
    assert td.tag_stack.peek() != method_marker;
    Object index_tag = td.tag_stack.pop();
    debug_arr_index.log("Merging array '%s' and index '%s'", arr, index_tag);
    if (merge_arrays_and_indices) {
      TagEntry.union(arr, index_tag);
    }

    // Store the value
    arr[index] = val;
    if (debug_tag_frame) {
      System.out.printf("tag stack size: %d%n", td.tag_stack.size());
    }
  }

  /**
   * The JVM uses bastore for both boolean and byte data types. With the addition of StackMap
   * verification in Java 7 we can no longer use the same runtime routine for both data types.
   * Hence, the addition of zastore below for boolean.
   *
   * <p>Execute an bastore instruction and manipulate the tags accordingly. The tag at the top of
   * stack is stored into the tag storage for the array.
   */
  public static void bastore(byte[] arr, int index, byte val) {

    // Store the tag for val in the tag storage for array and mark
    // the array and the index as comparable.
    primitive_array_store(arr, arr.length, index);

    // Execute the array store
    arr[index] = val;
  }

  public static void zastore(boolean[] arr, int index, boolean val) {

    // Store the tag for val in the tag storage for array and mark
    // the array and the index as comparable.
    primitive_array_store(arr, arr.length, index);

    // Execute the array store
    arr[index] = val;
  }

  /**
   * Execute an castore instruction and manipulate the tags accordingly. The tag at the top of stack
   * is stored into the tag storage for the array.
   */
  public static void castore(char[] arr, int index, char val) {

    // Store the tag for val in the tag storage for array and mark
    // the array and the index as comparable.
    primitive_array_store(arr, arr.length, index);

    // Execute the array store
    arr[index] = val;
  }

  /**
   * Execute an dastore instruction and manipulate the tags accordingly. The tag at the top of stack
   * is stored into the tag storage for the array.
   */
  public static void dastore(double[] arr, int index, double val) {

    // Store the tag for val in the tag storage for array and mark
    // the array and the index as comparable.
    primitive_array_store(arr, arr.length, index);

    // Execute the array store
    arr[index] = val;
  }

  /**
   * Execute an fastore instruction and manipulate the tags accordingly. The tag at the top of stack
   * is stored into the tag storage for the array.
   */
  public static void fastore(float[] arr, int index, float val) {

    // Store the tag for val in the tag storage for array and mark
    // the array and the index as comparable.
    primitive_array_store(arr, arr.length, index);

    // Execute the array store
    arr[index] = val;
  }

  /**
   * Execute an iastore instruction and manipulate the tags accordingly. The tag at the top of stack
   * is stored into the tag storage for the array.
   */
  public static void iastore(int[] arr, int index, int val) {

    // Store the tag for val in the tag storage for array and mark
    // the array and the index as comparable.
    primitive_array_store(arr, arr.length, index);

    // Execute the array store
    arr[index] = val;
  }

  /**
   * Execute an lastore instruction and manipulate the tags accordingly. The tag at the top of stack
   * is stored into the tag storage for the array.
   */
  public static void lastore(long[] arr, int index, long val) {

    // Store the tag for val in the tag storage for array and mark
    // the array and the index as comparable.
    primitive_array_store(arr, arr.length, index);

    // Execute the array store
    arr[index] = val;
  }

  /**
   * Execute an sastore instruction and manipulate the tags accordingly. The tag at the top of stack
   * is stored into the tag storage for the array.
   */
  public static void sastore(short[] arr, int index, short val) {

    // Store the tag for val in the tag storage for array and mark
    // the array and the index as comparable.
    primitive_array_store(arr, arr.length, index);

    // Execute the array store
    arr[index] = val;
  }

  /**
   * Make the count arguments to multianewarray comparable to the corresponding array indices.
   * count1 is made comparable to the index of the given array (arr), and count2 is made comparable
   * to the index of each array that is an element of arr.
   *
   * @param count1 number items in 1st dimension (unused, associated tag value is on tag stack)
   * @param count2 number items in 2nd dimension (unused, associated tag value is on tag stack)
   * @param arr the new array
   */
  public static void multianewarray2(int count1, int count2, Object[] arr) {
    if (debug) {
      System.out.printf("In multianewarray2%n");
    }

    ThreadData td = thread_to_data.get(Thread.currentThread());
    assert td.tag_stack.peek() != method_marker;
    Object count2tag = td.tag_stack.pop();
    assert td.tag_stack.peek() != method_marker;
    Object count1tag = td.tag_stack.pop();

    TagEntry.union(count1tag, arr);

    for (Object subarr : arr) {
      TagEntry.union(count2tag, subarr);
    }
    if (debug_tag_frame) {
      System.out.printf("tag stack size: %d%n", td.tag_stack.size());
    }
  }

  /**
   * Called when a user method is entered. Any daikon variables whose current values are comparable
   * are marked as comparable.
   *
   * @param tag_frame tag_frame containing the tags for the primitive arguments of this method
   * @param obj value of 'this', or null if the method is static
   * @param mi_index index into the list of all methods (methods)
   * @param args array of the arguments to the method
   */
  public static void enter(Object[] tag_frame, @Nullable Object obj, int mi_index, Object[] args) {

    // Don't be recursive
    if (in_enter_exit) {
      return;
    }
    in_enter_exit = true;

    if (debug) {
      Throwable stack = new Throwable("enter");
      StackTraceElement[] ste_arr = stack.getStackTrace();
      StackTraceElement ste = ste_arr[1];
      System.out.printf("%n%s.%s():::ENTER%n", ste.getClassName(), ste.getMethodName());
      System.out.printf("this = %s%nmi = %s%n", obj_str(obj), methods.get(mi_index));
      System.out.printf("args: ");
      for (Object arg : args) {
        System.out.printf("'%s' ", obj_str(arg));
      }
      System.out.println();
    }

    MethodInfo mi = methods.get(mi_index);
    mi.call_cnt++;
    ClassInfo ci = mi.class_info;
    if (ci.clazz == null) {
      ci.initViaReflection();
      if (debug) {
        System.out.printf("DCRuntime.enter adding %s to all class list%n", ci);
      }
      all_classes.add(ci);
      // Moved to DCInstrument.instrument()
      // daikon.chicory.Runtime.all_classes.add (ci);
      merge_dv.log("initializing traversal for %s%n", ci);
      ci.init_traversal(depth);
    }
    if (mi.traversalEnter == null) {
      mi.init_traversal(depth);
    }

    // Merge comparability information for the Daikon variables
    merge_dv.log("processing method %s:::ENTER%n", mi);
    merge_dv.indent();
    process_all_vars(mi, mi.traversalEnter, tag_frame, obj, args, null);
    merge_dv.exdent();

    in_enter_exit = false;
  }

  /**
   * Called when a user method exits. Any daikon variables whose current values are comparable are
   * marked as comparable.
   *
   * @param tag_frame tag_frame containing the tags for the primitive arguments of this method
   * @param obj value of 'this', or null if the method is static
   * @param mi_index index into the list of all methods (methods)
   * @param args array of the arguments to the method
   * @param ret_val value returned by the method, or null if the method is a constructor or void
   * @param exit_line_number the source line number of this exit point
   */
  public static void exit(
      Object[] tag_frame,
      @Nullable Object obj,
      int mi_index,
      Object[] args,
      Object ret_val,
      int exit_line_number) {

    // Don't be recursive
    if (in_enter_exit) {
      return;
    }
    in_enter_exit = true;

    if (debug) {
      Throwable stack = new Throwable("exit");
      StackTraceElement[] ste_arr = stack.getStackTrace();
      StackTraceElement ste = ste_arr[1];
      System.out.printf("%n%s.%s():::EXIT%n", ste.getClassName(), ste.getMethodName());
      System.out.printf("this = %s%nmi = %s%n", obj_str(obj), methods.get(mi_index));
      System.out.printf("args: ");
      for (Object arg : args) {
        System.out.printf("'%s' ", obj_str(arg));
      }
      System.out.println();
      System.out.printf("ret_val = %s%nexit_line_number= %d%n%n", ret_val, exit_line_number);
    }

    MethodInfo mi = methods.get(mi_index);

    // Merge comparability information for the Daikon variables
    merge_dv.log("processing method %s:::EXIT%n", mi);
    merge_dv.indent();
    process_all_vars(mi, mi.traversalExit, tag_frame, obj, args, ret_val);
    merge_dv.exdent();

    in_enter_exit = false;
  }

  /**
   * Process all of the daikon variables in the tree starting at root. If the values referenced by
   * those variables are comparable mark the variables as comparable.
   */
  public static void process_all_vars(
      MethodInfo mi, RootInfo root, Object[] tag_frame, Object obj, Object[] args, Object ret_val) {

    debug_timing.log("process_all_vars for %s%n", mi);

    merge_dv.log("this: %s%n", obj);
    // For some reason the following line causes DynComp to behave incorrectly.
    // I have not take the time to investigate.
    // merge_dv.log("arguments: %s%n", Arrays.toString(args));

    // Map from an Object to the Daikon variable that currently holds
    // that object.
    IdentityHashMap<Object, DaikonVariableInfo> varmap =
        new IdentityHashMap<Object, DaikonVariableInfo>(2048);

    for (DaikonVariableInfo dv : root.children) {
      if (dv instanceof ThisObjInfo) {
        merge_comparability(varmap, null, obj, dv);
      } else if (dv instanceof ParameterInfo) {
        ParameterInfo pi = (ParameterInfo) dv;
        Object p = args[pi.getArgNum()];
        // Class arg_type = mi.arg_types[pi.getArgNum()];
        // if (arg_type.isPrimitive())
        if (pi.isPrimitive()) {
          p = tag_frame[pi.get_param_offset() + ((obj == null) ? 0 : 1)];
        }
        merge_comparability(varmap, null, p, pi);
      } else if (dv instanceof ReturnInfo) {
        if (mi.return_type().isPrimitive()) {
          ThreadData td = thread_to_data.get(Thread.currentThread());
          ret_val = td.tag_stack.peek();
        }
        merge_comparability(varmap, null, ret_val, dv);
      } else if (dv instanceof FieldInfo) {
        assert ((FieldInfo) dv).isStatic() : "non static field at root " + dv;
        merge_comparability(varmap, null, null, dv);
      } else if (dv instanceof StaticObjInfo) {
        for (DaikonVariableInfo static_dv : dv.children) {
          assert ((FieldInfo) static_dv).isStatic() : "non static field at root " + dv;
          merge_comparability(varmap, null, null, static_dv);
        }
      } else {
        throw new Error("unexpected node " + dv);
      }
    }
    debug_timing.log("exit process_all_vars for %s%n%n", mi);
    map_info.log("varmap size: %d%n", varmap.size());
  }

  /**
   * Returns the tag for the specified field. If that field is an array, a list of tags will be
   * returned.
   *
   * @param fi a field
   * @param parent object that contains the field (if any)
   * @param obj value of the field itself (if available and if it's an object)
   * @return the tag for the specified field
   */
  static Object get_field_tag(FieldInfo fi, Object parent, Object obj) {

    // Initialize the code that gets the tag for various field types
    if (fi.field_tag == null) {
      if (fi.isStatic()) {
        if (fi.isPrimitive()) {
          // a static final primitive is a constant and there is no tag accessor
          if (fi.isFinal()) {
            return null;
          }
          fi.field_tag = new StaticPrimitiveTag(fi);
        } else {
          fi.field_tag = new StaticReferenceTag(fi);
        }
      } else { // not static
        if (fi.isPrimitive() && fi.isArray()) {
          fi.field_tag = new PrimitiveArrayTag(fi);
        } else if (fi.isPrimitive()) {
          fi.field_tag = new PrimitiveTag(fi);
        } else {
          fi.field_tag = new ReferenceTag(fi);
        }
      }
    }

    // get the tag
    return fi.field_tag.get_tag(parent, obj);
  }

  /**
   * Gets the object in field f in object obj. Exceptions are turned into Errors.
   *
   * @param f which field to return
   * @param obj the object that contains the field
   * @return the specified object
   */
  public static Object get_object_field(Field f, Object obj) {
    if (debug) {
      System.out.printf("In get_object_field%n");
    }
    try {
      return f.get(obj);
    } catch (Exception e) {
      throw new Error("can't get field " + f + " in " + obj_str(obj), e);
    }
  }

  /**
   * Merges the comparability of the daikon variable dv and its children whose current values are
   * comparable.
   *
   * @param varmap map from value set leaders to the first daikon variable encountered with that
   *     leader. Whenever a second daikon variable is encountered whose value has the same leader,
   *     that daikon variable is merged with the first daikon variable.
   * @param parent value of dv's parent
   * @param obj value of dv
   * @param dv DaikonVariable to process
   */
  static void merge_comparability(
      IdentityHashMap<Object, DaikonVariableInfo> varmap,
      Object parent,
      Object obj,
      DaikonVariableInfo dv) {

    // merge_dv.enabled = dv.getName().contains ("mtfFreq");

    long start_millis = 0;
    if (debug_timing.enabled()) {
      start_millis = System.currentTimeMillis();
    }
    if (merge_dv.enabled()) {
      merge_dv.log("merge_comparability: checking var %s = '%s' %n", dv, obj_str(obj));
    }

    // Ignore ClassInfo and StringInfo variables.  These are not real
    // variables in the program
    if ((dv instanceof DaikonClassInfo) || (dv instanceof StringInfo)) {
      debug_timing.log("  Variable %s : %d msecs%n", dv, System.currentTimeMillis() - start_millis);
      return;
    }

    // Get the tag for this object.  For non-primitives this is normally the
    // object itself.  For static fields, the object is not passed in, but is
    // obtained via reflection.
    Object tag = obj;
    if (dv instanceof FieldInfo) {
      tag = get_field_tag((FieldInfo) dv, parent, obj);
    }

    if (!dv.declShouldPrint()) {
      // do nothing
    } else if (dv.isArray() && (tag instanceof List<?>)) {
      @SuppressWarnings("unchecked")
      List<Object> elements = (List<Object>) tag;
      if (debug_timing.enabled()) {
        debug_timing.log("  ArrayInfo %d elements", elements.size());
      }
      for (Object atag : elements) {
        // Ignore null and nonsensical tags.  There is no reason to process
        // their children, because they can't have any with reasonable values
        if ((atag == null) || (atag == nonsensical) || (atag == nonsensical_list)) {
          continue;
        }

        // Look up this object.  If it already is associated with a
        // DaikonVariable merge those variables.  Otherwise, add it to
        // the map
        Object leader = TagEntry.find(atag);
        if (merge_dv.enabled()) {
          merge_dv.log("Leader for atag '%s' is '%s'%n", obj_str(atag), obj_str(leader));
        }
        DaikonVariableInfo current = varmap.get(leader);
        merge_dv.log("Daikon variable for leader = %s%n", current);
        if (current != null) {
          merge_dv.log("**Merging %s and %s%n", current, dv);
          TagEntry.union(current, dv);
        } else {
          varmap.put(leader, dv);
        }
      }
    } else if (dv.isArray()) {
      if (tag == null) {
        if (debug_timing.enabled()) {
          debug_timing.log(
              "  no array tags for Variable %s : %d msecs%n",
              dv, System.currentTimeMillis() - start_millis);
        }
        return;
      }
      Object[] elements = (Object[]) tag;
      if (debug_timing.enabled()) {
        debug_timing.log("  Prim ArrayInfo %d elements", elements.length);
      }
      Object prev_tag = null;
      for (Object atag : elements) {
        // Ignore null and nonsensical tags.  There is no reason to process
        // their children, because they can't have any with reasonable values
        if ((atag == null) || (atag == nonsensical) || (atag == nonsensical_list)) {
          continue;
        }

        // No need to handle the same tag twice
        if (prev_tag == atag) {
          continue;
        }
        prev_tag = atag;

        // Look up this object.  If it already is associated with a
        // DaikonVariable merge those variables.  Otherwise, add it to
        // the map
        Object leader = TagEntry.find(atag);
        if (merge_dv.enabled()) {
          merge_dv.log("Leader for atag '%s' is '%s'%n", obj_str(atag), obj_str(leader));
        }
        DaikonVariableInfo current = varmap.get(leader);
        merge_dv.log("Daikon variable for leader = %s%n", current);
        if (current != null) {
          merge_dv.log("**Merging %s and %s%n", current, dv);
          TagEntry.union(current, dv);
        } else {
          varmap.put(leader, dv);
        }
      }
    } else {
      // Ignore null and nonsensical tags.  There is no reason to process
      // their children, because they can't have any with reasonable values
      if ((tag == null) || (tag == nonsensical) || (tag == nonsensical_list)) {
        debug_timing.log(
            "  Variable %s : %d msecs%n", dv, System.currentTimeMillis() - start_millis);
        return;
      }

      // Look up this object.  If it already is associated with a
      // DaikonVariable merge those variables.  Otherwise, add it to
      // the map
      Object leader = TagEntry.find(tag);
      if (merge_dv.enabled()) {
        merge_dv.log("Leader for tag '%s' is '%s'%n", obj_str(tag), obj_str(leader));
      }
      DaikonVariableInfo current = varmap.get(leader);
      assert leader != null : "null leader for " + obj_str(tag);
      merge_dv.log("Daikon variable for leader = %s%n", current);
      if (current != null) {
        merge_dv.log("**Merging variable '%s' and '%s'%n", current, dv);
        TagEntry.union(current, dv);
      } else {
        varmap.put(leader, dv);
      }
    }

    debug_timing.log("  Variable %s : %d msecs%n", dv, System.currentTimeMillis() - start_millis);

    // Process all of the children
    for (DaikonVariableInfo child : dv) {
      Object child_obj;
      if ((child instanceof ArrayInfo) && ((ArrayInfo) child).getType().isPrimitive()) {
        // It's a primitive array.
        // System.out.printf("child array type %s = %s%n", ai, ai.getType());
        Object[] arr_tags = field_map.get(tag);
        // System.out.printf("found arr_tag %s for arr %s%n", arr_tags, tag);
        // System.out.printf("tag values = %s%n", Arrays.toString (arr_tags));
        child_obj = arr_tags;
      } else {
        // It's not a primitive array.
        child_obj = child.getMyValFromParentVal(obj);
      }
      merge_dv.indent();
      merge_comparability(varmap, obj, child_obj, child);
      merge_dv.exdent();
    }
  }

  /**
   * Dumps out comparability information for all classes that were processed.
   *
   * @param pw PrintWriter to write on
   */
  public static void printAllComparable(PrintWriter pw) {

    for (ClassInfo ci : all_classes) {
      merge_class_comparability(ci);
      for (MethodInfo mi : ci.method_infos) {
        if (mi.is_class_initializer()) {
          continue;
        }
        // skip our added method
        if (mi.method_name.equals("equals_dcomp_instrumented")) {
          continue;
        }
        pw.println();
        printComparable(pw, mi);
      }
    }
  }

  /**
   * Dumps out comparability trace information for all classes that were processed.
   *
   * @param pw PrintWriter to write on
   */
  public static void traceAllComparable(PrintWriter pw) {

    for (ClassInfo ci : all_classes) {
      merge_class_comparability(ci);
      for (MethodInfo mi : ci.method_infos) {
        if (mi.is_class_initializer()) {
          continue;
        }
        if (mi.method_name.equals("equals_dcomp_instrumented")) {
          continue;
        }
        pw.println();
        printComparableTraced(pw, mi);
      }
    }
  }

  /**
   * Prints header information to the decls file. Should be called once before emitting any other
   * declarations.
   *
   * @param pw where to write output
   * @param className name of the top-level class (used only for printing comments)
   */
  public static void printHeaderInfo(PrintWriter pw, String className) {

    // Write the file header
    pw.println("// Declarations for " + className);
    pw.println(
        "// Declarations written "
            + LocalDateTime.now(ZoneId.systemDefault())
            + " by daikon.DynComp");
    pw.println();
    pw.println("decl-version 2.0");
    pw.println("var-comparability implicit");
    pw.println();
  }

  /**
   * Dumps out .decl file information for all classes that were processed.
   *
   * @param pw where to write output
   */
  public static void printDeclFile(PrintWriter pw) {

    // Write the information for each class
    for (ClassInfo ci : all_classes) {
      if (!headerPrinted) {
        printHeaderInfo(pw, ci.class_name);
        headerPrinted = true;
      }
      printClassDecl(pw, ci);
    }
    debug_decl_print.log("finished %d classes%n", all_classes.size());
  }

  static int class_cnt = 0;
  static int method_cnt = 0;
  static int instance_var_cnt = 0;
  static int static_final_cnt = 0;
  static int hashcode_var_cnt = 0;
  static int hashcode_arr_cnt = 0;
  static int primitive_var_cnt = 0;
  static int tostring_cnt = 0;
  static int class_var_cnt = 0;
  static int this_instance_cnt = 0;
  static int other_instance_cnt = 0;
  static int other_cnt = 0;
  static int parameter_cnt = 0;
  static int static_cnt = 0;
  static int synthetic_cnt = 0;
  static int enum_cnt = 0;

  /** Prints statistics about the number of decls to stdout. */
  public static void decl_stats() {

    for (ClassInfo ci : all_classes) {
      class_cnt++;
      System.out.printf("processing class %s%n", ci);
      add_dv_stats(ci.traversalClass);
      add_dv_stats(ci.traversalObject);
      for (MethodInfo mi : ci.method_infos) {
        if (mi.is_class_initializer()) {
          continue;
        }
        method_cnt++;
        System.out.printf("  Processing method %s [%d calls]%n", mi, mi.call_cnt);
        if (mi.traversalEnter == null) {
          System.out.printf("  Skipping method %s%n", mi);
          continue;
        }
        System.out.printf("    Enter%n");
        add_dv_stats(mi.traversalEnter);
        for (Integer ii : mi.exit_locations) {
          System.out.printf("    Exit%d%n", ii);
          add_dv_stats(mi.traversalExit);
        }
      }
    }

    // The section above output method count data for non-omitted user code.
    // The section below outputs method count data for all methods - including java runtime.
    System.out.printf("%ndisplaying all method counts%n");
    for (String key : methodCountMap.keySet()) {
      System.out.printf("  method %s [%d calls]%n", key, methodCountMap.get(key));
    }
    System.out.println();

    System.out.printf("Classes             = %,d%n", class_cnt);
    System.out.printf("Methods             = %,d%n", method_cnt);
    System.out.printf("------------------------------%n");
    System.out.printf("Hashcodes           = %,d%n", hashcode_var_cnt);
    System.out.printf("Hashcode arrays     = %,d%n", hashcode_arr_cnt);
    System.out.printf("primitives          = %,d%n", primitive_var_cnt);
    System.out.printf("------------------------------%n");
    System.out.printf("tostring vars       = %,d%n", tostring_cnt);
    System.out.printf("class vars          = %,d%n", class_var_cnt);
    System.out.printf("Enums               = %,d%n", enum_cnt);
    System.out.printf("Synthetic           = %,d%n", synthetic_cnt);
    System.out.printf("static final vars   = %,d%n", static_final_cnt);
    System.out.printf("static vars         = %,d%n", static_cnt);
    System.out.printf("this instance vars  = %,d%n", this_instance_cnt);
    System.out.printf("other instance vars = %,d%n", other_instance_cnt);
    System.out.printf("Parameters          = %,d%n", parameter_cnt);
    System.out.printf("Others              = %,d%n", other_cnt);
  }

  private static void add_dv_stats(RootInfo root) {

    if (root == null) {
      return;
    }
    List<DaikonVariableInfo> dv_list = root.tree_as_list();
    for (DaikonVariableInfo dv : dv_list) {
      if (dv instanceof RootInfo) {
        continue;
      }
      if (!dv.declShouldPrint()) {
        continue;
      }
      // System.out.printf("      processing dv %s [%s]%n", dv,
      //                    dv.getTypeName());
      if (dv.isHashcode()) {
        hashcode_var_cnt++;
      } else if (dv.isHashcodeArray()) {
        hashcode_arr_cnt++;
      } else {
        primitive_var_cnt++;
      }
      if (dv.getName().contains(".toString")) {
        tostring_cnt++;
      } else if (dv.getName().contains(DaikonVariableInfo.class_suffix)) {
        class_var_cnt++;
      } else if (dv instanceof FieldInfo) {
        Field field = ((FieldInfo) dv).getField();
        int modifiers = field.getModifiers();
        if (field.isEnumConstant()) {
          enum_cnt++;
        } else if (field.isSynthetic()) synthetic_cnt++;
        else if (Modifier.isStatic(modifiers) && Modifier.isFinal(modifiers)) static_final_cnt++;
        else if (Modifier.isStatic(modifiers)) static_cnt++;
        else if (dv.getName().startsWith("this")) this_instance_cnt++;
        else {
          other_instance_cnt++;
        }
      } else if (dv instanceof ParameterInfo) {
        parameter_cnt++;
      } else {
        other_cnt++;
      }
    }
  }

  /**
   * Calculates and prints the declarations for the specified class.
   *
   * @param pw where to produce output
   * @param ci the class to write
   */
  public static void printClassDecl(PrintWriter pw, ClassInfo ci) {

    time_decl.log("Printing decl file for class %s%n", ci.class_name);
    time_decl.indent();
    debug_decl_print.log("class %s%n", ci.class_name);

    // Make sure that two variables have the same comparability at all
    // program points
    merge_class_comparability(ci);

    // Write the class ppt
    String classPptName = ci.class_name + ":::CLASS";
    pw.println("ppt " + classPptName);
    pw.println("ppt-type class");
    printDeclVars(get_comparable(ci.traversalClass), ci.traversalClass, classPptName);
    pw.println();
    time_decl.log("printed class ppt");

    // Write the object ppt
    String objectPptName = ci.class_name + ":::OBJECT";
    pw.println("ppt " + objectPptName);
    pw.println("ppt-type object");
    printDeclVars(get_comparable(ci.traversalObject), ci.traversalObject, objectPptName);
    pw.println();
    time_decl.log("printed object ppt");

    // Print the information for each enter/exit point
    for (MethodInfo mi : ci.method_infos) {
      if (mi.is_class_initializer()) {
        continue;
      }
      debug_decl_print.log("  method %s%n", mi.method_name);
      printMethod(pw, mi);
    }

    time_decl.log("finished class %s%n", ci.class_name);
    time_decl.exdent();
  }

  static long comp_list_ms = 0;
  static long ppt_name_ms = 0;
  static long decl_vars_ms = 0;
  static long total_ms = 0;

  // static Stopwatch watch = new Stopwatch();

  /**
   * Prints a decl ENTER/EXIT records with comparability. Returns the list of comparabile DVSets for
   * the exit.
   *
   * @param pw where to produce output
   * @param mi the class to output
   * @return the list of comparabile DVSets for the exit
   */
  public static List<DVSet> printMethod(PrintWriter pw, MethodInfo mi) {

    // long start = System.currentTimeMillis();
    // watch.reset();

    time_decl.log("Print decls for method '%s'", mi.method_name);
    time_decl.indent();
    List<DVSet> l = get_comparable(mi.traversalEnter);
    // comp_list_ms += watch.snapshot(); watch.reset();
    if (l == null) {
      return null;
    }
    time_decl.log("got %d comparable sets", l.size());

    // Print the enter point
    String enterPptName = clean_decl_name(DaikonWriter.methodEntryName(mi.member));
    pw.println("ppt " + enterPptName);
    pw.println("ppt-type enter");
    // ppt_name_ms += watch.snapshot();  watch.reset();
    printDeclVars(l, mi.traversalEnter, enterPptName);
    // decl_vars_ms += watch.snapshot();  watch.reset();
    pw.println();
    time_decl.log("after enter");

    // Print the exit points
    l = get_comparable(mi.traversalExit);
    // comp_list_ms += watch.snapshot();  watch.reset();

    time_decl.log("got exit comparable sets");
    for (Integer ii : mi.exit_locations) {
      String exitPptName = clean_decl_name(DaikonWriter.methodExitName(mi.member, ii));
      pw.println("ppt " + exitPptName);
      pw.println("ppt-type subexit");
      // ppt_name_ms += watch.snapshot();  watch.reset();

      time_decl.log("after exit clean_decl_name");
      printDeclVars(l, mi.traversalExit, exitPptName);
      pw.println();
      // decl_vars_ms += watch.snapshot();  watch.reset();

    }

    // total_ms += System.currentTimeMillis() - start;
    time_decl.log("Finished processing method '%s'", mi.method_name);
    time_decl.exdent();
    return l;
  }

  /** Map from array name to comparability for its indices (if any). */
  private static Map<String, Integer> arr_index_map;

  /** Map from variable to its comparability. */
  private static IdentityHashMap<DaikonVariableInfo, Integer> dv_comp_map;

  /** Comparability value for a variable. */
  private static int base_comp;

  /**
   * Print the variables in sets to pw in DECL file format. Each variable in the same set is given
   * the same comparability. Constructed classname variables are made comparable to other classname
   * variables only.
   *
   * @param sets the comparability sets
   * @param dv_tree the tree of variables
   * @param pptName used only for debugging output
   */
  private static void printDeclVars(List<DVSet> sets, RootInfo dv_tree, String pptName) {

    time_decl.indent();
    time_decl.log("printDeclVars start");

    debug_decl_print.log("printDeclVars(%s)%n", pptName);

    // Map from array name to comparability for its indices (if any)
    arr_index_map = new LinkedHashMap<>();

    // Map from daikon variable to its comparability
    dv_comp_map = new IdentityHashMap<DaikonVariableInfo, Integer>(256);

    // Initial comparability values
    int class_comp = 1;
    base_comp = 2;

    // Loop through each set of comparable variables
    for (DVSet set : sets) {

      if ((set.size() == 1) && (set.get(0) instanceof StaticObjInfo)) {
        continue;
      }

      // Determine if the set has both hashcode variables and integer
      // variables.  If it does, it is indicating index comparability
      boolean hashcode_vars = false;
      boolean non_hashcode_vars = false;
      // System.out.printf("Checking dv set %s%n", set);
      for (DaikonVariableInfo dv : set) {
        if (dv.isHashcode() || dv.isHashcodeArray()) {
          hashcode_vars = true;
        } else {
          non_hashcode_vars = true;
        }
        // System.out.printf("dv = %s, hashcode_var = %b%n",
        //                   dv, dv.isHashcode() || dv.isHashcodeArray());
      }
      debug_decl_print.log(
          "        %d vars in set, hashcode/non = %b/%b%n",
          set.size(), hashcode_vars, non_hashcode_vars);

      // Loop through each variable and assign its comparability
      // Since hashcodes and their indices are in the same set, assign
      // hashcodes one higher comparability number.  Note that there is
      // not necessarily an array child for a hashcode that is comparable
      // to an integer.  This can happen when an array and a non-array object
      // become comparable to one another.  An integer that is comparable
      // to the array will also be comparable to the non-array object, but
      // that comparability isn't interesting (and it can't be expressed)
      for (DaikonVariableInfo dv : set) {
        debug_decl_print.log("          dv %s [%s]%n", dv, System.identityHashCode(dv));
        if (dv instanceof DaikonClassInfo) {
          dv_comp_map.put(dv, class_comp);
          assert set.size() == 1 : "odd set " + set;
          base_comp--; // negate increment of base_comp below
        } else if (dv.isHashcode() && non_hashcode_vars) {
          assert !dv_comp_map.containsKey(dv) : dv + " " + base_comp;
          dv_comp_map.put(dv, base_comp + 1);
          DaikonVariableInfo array_child = dv.array_child();
          if (array_child != null) {
            // System.out.printf("array_index_map put: %s, %d%n", array_child.getName(),
            // base_comp);
            arr_index_map.put(array_child.getName(), base_comp);
          }
        } else {
          assert !dv_comp_map.containsKey(dv) : dv + " " + base_comp;
          dv_comp_map.put(dv, base_comp);
        }
      }

      // Increment the comparability number to the next valid number
      base_comp++;
      if (hashcode_vars && non_hashcode_vars) {
        base_comp++;
      }
    }

    time_decl.log("finished filling maps%n");

    // Loop through each variable and print out its comparability
    // Use the dv_tree rather than sets so that we print out in the
    // same order each time.  Note that arrays get two comparablities, one
    // for the elements of the array and one for indices.  Normally, these
    // comparabilities will be different, but if an index is placed in the
    // array the comparabilities can be the same.
    List<DaikonVariableInfo> dv_list = dv_tree.tree_as_list();
    time_decl.log("built tree as list with %d elements", dv_list.size());
    for (DaikonVariableInfo dv : dv_list) {
      if ((dv instanceof RootInfo) || (dv instanceof StaticObjInfo) || !dv.declShouldPrint()) {
        continue;
      }

      declWriter.printDecl(null, dv, null, comparabilityProvider);
    }

    time_decl.log("printDeclVars end%n");
    map_info.log("dv_comp_map size: %d%n", dv_comp_map.size());
    time_decl.exdent();
  }

  /**
   * Calculates a comparability value.
   *
   * @param dv variable to calculate comparability for
   * @param compare_ppt (not used)
   * @return string containing comparability value
   */
  @Override
  public String getComparability(DaikonVariableInfo dv, DeclReader.DeclPpt compare_ppt) {
    int comp = dv_comp_map.get(dv);
    String comp_str = Integer.toString(comp);
    if (dv.isArray()) {
      String name = dv.getName();
      // If we an array of CLASSNAME or TO_STRING get the index
      // comparability from the base array.
      if (name.endsWith(DaikonVariableInfo.class_suffix)) {
        name = name.substring(0, name.length() - DaikonVariableInfo.class_suffix.length());
      } else if (name.endsWith(".toString")) {
        name = name.substring(0, name.length() - ".toString".length());
      }
      Integer index_comp = arr_index_map.get(name);
      // System.out.printf("compare: %d [ %s ] ", comp, index_comp);
      if (index_comp != null) {
        // System.out.println(comp + "[" + index_comp + "]");
        comp_str = comp_str + "[" + index_comp + "]";
      } else {
        // There is no index comparability, so just set it to a unique value.
        // System.out.println(comp + "[" + base_comp + "]");
        comp_str = comp_str + "[" + base_comp++ + "]";
      }
    }
    return comp_str;
  }

  /**
   * Prints comparability information for the enter and exit points of the specified method. By
   * default, outputs to {@code foo.txt-cset}.
   *
   * @param pw where to produce output
   * @param mi the method whose comparability to output
   */
  /* TO DO: Find a way to make this work correctly without using normal
   * get_comparable.
   */
  public static void printComparable(PrintWriter pw, MethodInfo mi) {

    List<DVSet> l = get_comparable(mi.traversalEnter);
    pw.printf("Variable sets for %s enter%n", clean_decl_name(mi.toString()));
    if (l == null) {
      pw.printf("  not called%n");
    } else {
      for (DVSet set : l) {
        if ((set.size() == 1) && (set.get(0) instanceof StaticObjInfo)) {
          continue;
        }
        ArrayList<String> stuff = skinyOutput(set, daikon.DynComp.abridged_vars);
        // To see "daikon.chicory.FooInfo:variable", change true to false
        pw.printf("  [%d] %s%n", stuff.size(), stuff);
      }
    }

    l = get_comparable(mi.traversalExit);
    pw.printf("Variable sets for %s exit%n", clean_decl_name(mi.toString()));
    if (l == null) {
      pw.printf("  not called%n");
    } else {
      for (DVSet set : l) {
        if ((set.size() == 1) && (set.get(0) instanceof StaticObjInfo)) {
          continue;
        }
        ArrayList<String> stuff = skinyOutput(set, daikon.DynComp.abridged_vars);
        // To see "daikon.chicory.FooInfo:variable", change true to false
        pw.printf("  [%d] %s%n", stuff.size(), stuff);
      }
    }
  }

  /**
   * Dumps out comparability trace information for a single method.
   *
   * @param pw where to write output
   * @param mi the method to process
   */
  public static void printComparableTraced(PrintWriter pw, MethodInfo mi) {
    List<DVSet> l = get_comparable(mi.traversalEnter);
    Map<DaikonVariableInfo, DVSet> t = get_comparable_traced(mi.traversalEnter);
    pw.printf("DynComp Traced Tree for %s enter%n", clean_decl_name(mi.toString()));
    if (t == null) {
      pw.printf("  not called%n");
    } else {
      for (DVSet set : l) {
        if ((set.size() == 1) && (set.get(0) instanceof StaticObjInfo)) {
          continue;
        }
        printTree(pw, t, (DaikonVariableInfo) TagEntry.troot_find(set.get(0)), 0);
        pw.println();
      }
    }
    pw.println();

    l = get_comparable(mi.traversalExit);
    t = get_comparable_traced(mi.traversalExit);
    pw.printf("DynComp Traced Tree for %s exit%n", clean_decl_name(mi.toString()));
    if (t == null) {
      pw.printf("  not called%n");
    } else {
      for (DVSet set : l) {
        if ((set.size() == 1) && (set.get(0) instanceof StaticObjInfo)) {
          continue;
        }
        printTree(pw, t, (DaikonVariableInfo) TagEntry.troot_find(set.get(0)), 0);
        pw.println();
      }
    }
    pw.println();
  }

  /**
   * Prints to [stream] the segment of the tree that starts at [node], interpreting [node] as
   * [depth] steps from the root. Requires a Map [tree] that represents a tree though key-value sets
   * of the form {@code <}parent, set of children{@code >}.
   *
   * @param pw where to write output
   * @param tree map parents to children
   * @param node starting point of tree to print
   * @param depth distance from node to root of tree
   */
  static void printTree(
      PrintWriter pw, Map<DaikonVariableInfo, DVSet> tree, DaikonVariableInfo node, int depth) {

    /* This method, for some reason, triggers a segfault due to the way
     * DVSets are handled conceptually. A trace-tree of one element creates
     * a key-value pair DVI foo &rarr; DVSet {foo}, whereas a trace-tree of
     * two elements creates a key-value pair DVI foo &rarr; DVSet {bar}.
     */

    if (depth == 0) {
      pw.printf("%s%n", skinyOutput(node, daikon.DynComp.abridged_vars));
      if (tree.get(node) == null) {
        return;
      }
      for (DaikonVariableInfo child : tree.get(node)) {
        if (child != node) {
          printTree(pw, tree, child, depth + 1);
        }
      }
    } else {
      for (int i = 0; i < depth; i++) {
        pw.printf("--");
      }
      pw.printf(
          "%s (%s)%n",
          skinyOutput(node, daikon.DynComp.abridged_vars), TagEntry.get_line_trace(node));
      if (tree.get(node) == null) {
        return;
      }
      for (DaikonVariableInfo child : tree.get(node)) {
        if (child != node) {
          printTree(pw, tree, child, depth + 1);
        }
      }
    }
  }

  /**
   * If on, returns an ArrayList of Strings that converts the usual DVInfo.toString() output to a
   * more readable form
   *
   * <p>e.g. "daikon.chicory.ParameterInfo:foo" becomes "Parameter foo"
   *
   * <p>"daikon.chicory.FieldInfo:this.foo" becomes "Field foo"
   */
  private static ArrayList<String> skinyOutput(DVSet l, boolean on) {
    ArrayList<String> o = new ArrayList<>();
    for (DaikonVariableInfo dvi : l) {
      o.add(skinyOutput(dvi, on));
    }
    return o;
  }

  private static String skinyOutput(DaikonVariableInfo dv, boolean on) {
    if (!on) {
      return dv.toString();
    }
    String dvtxt = dv.toString();
    String type = dvtxt.split(":")[0];
    type = type.substring(type.lastIndexOf(".") + 1);
    String name = dvtxt.split(":")[1];
    if (type.equals("ThisObjInfo")) {
      dvtxt = "this";
    } else if (type.equals("ReturnInfo")) {
      dvtxt = "return";
    } else if (type.endsWith("Info")) {
      type = type.substring(0, type.length() - 4);
      if (name.endsWith(DaikonVariableInfo.class_suffix)) {
        name = name.substring(0, name.length() - DaikonVariableInfo.class_suffix.length());
        type = "Class of";
      }
      if (name.startsWith("this.")) {
        name = name.substring(5);
        if (!type.endsWith("Field")) {
          type = (type + " Field").trim();
        }
      }
      dvtxt = type + " " + name;
    }
    return dvtxt;
  }

  /** Set of Daikon variables. Implements comparable on first DaikonVariable in each set. */
  private static class DVSet extends ArrayList<DaikonVariableInfo> implements Comparable<DVSet> {
    static final long serialVersionUID = 20050923L;

    @Pure
    @Override
    public int compareTo(@GuardSatisfied DVSet this, DVSet s1) {
      if (s1.size() == 0) {
        return 1;
      } else if (size() == 0) {
        return -1;
      } else {
        return this.get(0).compareTo(s1.get(0));
      }
    }

    public void sort() {
      Collections.sort(this);
    }
  }

  /**
   * 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
   * wanted to differentiate this case for now).
   *
   * <p>The sets are calculated by processing each daikon variable and adding it to a list
   * associated with the leader of that set.
   */
  static @Nullable List<DVSet> get_comparable(RootInfo root) {

    if (root == null) {
      return null;
    }

    // List of all of the sets of comparable daikon variables
    IdentityHashMap<DaikonVariableInfo, DVSet> sets =
        new IdentityHashMap<DaikonVariableInfo, DVSet>();

    for (DaikonVariableInfo dv : root) {
      add_variable(sets, dv);
    }
    map_info.log("sets size: %d%n", sets.size());

    // Get each set, sort it, and add it to the list of all sets.  Then sort
    // the list of all sets.  The sorting is not critical except to create
    // a reproducible order.
    List<DVSet> set_list = new ArrayList<>(sets.size());
    for (DVSet dvs : sets.values()) {
      dvs.sort();
      set_list.add(dvs);
    }
    Collections.sort(set_list);

    return set_list;
  }

  /**
   * 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
   * included as a key to all its children.
   */
  static @PolyNull Map<DaikonVariableInfo, DVSet> get_comparable_traced(@PolyNull RootInfo root) {
    if (root == null) {
      return null;
    }

    // List of all of the parent-child relationships, where parent-child
    //   represents the equivalence relation of being comparable.
    // The keyset of this Map is exactly the RootInfo node and the set of all
    //   nodes that have children.
    // The valueset of this Map is exactly the set of all nodes.
    IdentityHashMap<DaikonVariableInfo, DVSet> sets =
        new IdentityHashMap<DaikonVariableInfo, DVSet>(256);

    for (DaikonVariableInfo child : root) {
      if (child.declShouldPrint()) {
        add_variable_traced(sets, child);
      }
    }
    for (DVSet dvs : sets.values()) {
      dvs.sort();
    }

    return sets;
  }

  static void add_variable_traced(Map<DaikonVariableInfo, DVSet> sets, DaikonVariableInfo dv) {
    try {
      DaikonVariableInfo parent = (DaikonVariableInfo) TagEntry.tracer_find(dv);
      DVSet set = sets.computeIfAbsent(parent, __ -> new DVSet());
      set.add(dv);
    } catch (NullPointerException e) {
      throw new Error(e);
    }

    for (DaikonVariableInfo child : dv) {
      add_variable_traced(sets, child);
    }
  }

  /**
   * Merges comparability so that the same variable has the same comparability at all points in the
   * program point hierarchy. The comparability at the class/object points is calculated by merging
   * the comparability at each exit point (i.e., if two variables are in the same set at any exit
   * point, they are in the same set at the class point). That comparability is then applied back to
   * the exit points so that if two class variables are comparable at any exit point they are
   * comparable at each exit point. Finally exit point comparability is merged to the enter point so
   * that their comparabilities are the same.
   *
   * <p>This is not the only valid definition of comparability but it is the one that Daikon expects
   * because of how equality sets are handled.
   */
  static void merge_class_comparability(ClassInfo ci) {

    // Get the variables at the object and class point
    assert ci.traversalObject != null : ci;
    assert ci.traversalClass != null : ci;
    // ci.init_traversal (depth);

    // If any methods have not been executed, create their information
    // now (which will note all of their variables as not comparable)
    for (MethodInfo mi : ci.method_infos) {
      if (mi.is_class_initializer()) {
        continue;
      }
      if (mi.traversalEnter == null) {
        // mi.initViaReflection();
        mi.init_traversal(depth);
        // System.out.printf("Warning: Method %s never executed%n", mi);
      }
    }

    // Merge the comparability from each exit point into the object point
    for (MethodInfo mi : ci.method_infos) {
      if (mi.is_class_initializer()) {
        continue;
      }
      merge_dv_comparability(mi.traversalExit, mi.traversalEnter, "Merging exit to enter: " + mi);
      merge_dv_comparability(mi.traversalExit, ci.traversalObject, "Merging exit to object: " + mi);
      merge_dv_comparability(mi.traversalEnter, ci.traversalObject, "Merging enter to object" + mi);
    }

    // Merge the comparability from the object point back to each exit point
    for (MethodInfo mi : ci.method_infos) {
      if (mi.is_class_initializer()) {
        continue;
      }
      merge_dv_comparability(ci.traversalObject, mi.traversalExit, "Merging object to exit: " + mi);
    }

    // Merge the comparability for each exit point back to the enter
    for (MethodInfo mi : ci.method_infos) {
      if (mi.is_class_initializer()) {
        continue;
      }
      merge_dv_comparability(mi.traversalExit, mi.traversalEnter, "Merging exit to enter: " + mi);
    }

    // Merge the object comparability to the class
    merge_dv_comparability(ci.traversalObject, ci.traversalClass, "Merging object to class: " + ci);
  }

  /**
   * Merges any variables in the dest tree that are in the same set in the source tree. The source
   * tree's comparability is unchanged. Variables are identified by name.
   *
   * @param src the comparability to read
   * @param dest the comparability to modify
   * @param debuginfo information about this method call, for debugging
   */
  static void merge_dv_comparability(RootInfo src, RootInfo dest, String debuginfo) {

    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);
    }

    // Get the variable sets for the source
    List<DVSet> src_sets = get_comparable(src);

    // Merge any destination variables that are in the same source set
    for (DVSet src_set : src_sets) {
      if (src_set.size() == 1) {
        continue;
      }
      DaikonVariableInfo dest_canonical = null;
      for (DaikonVariableInfo src_var : src_set) {
        if (dest_canonical == null) {
          dest_canonical = dest_map.get(src_var.getName());
          continue;
        }
        DaikonVariableInfo dest_var = dest_map.get(src_var.getName());
        if (dest_var != null) {
          TagEntry.union(dest_canonical, dest_var);
          debug_merge_comp.log(
              "merged '%s' [%s] and '%s' [%s]%n",
              dest_canonical,
              System.identityHashCode(dest_canonical),
              dest_var,
              System.identityHashCode(dest_var));
        }
      }
    }
    debug_merge_comp.exdent();
  }

  /**
   * Adds this daikon variable and all of its children into their appropriate sets (those of their
   * leader) in sets.
   */
  static void add_variable(Map<DaikonVariableInfo, DVSet> sets, DaikonVariableInfo dv) {

    // Add this variable into the set of its leader
    if (dv.declShouldPrint()) {
      DaikonVariableInfo leader = (DaikonVariableInfo) TagEntry.find(dv);
      DVSet set = sets.computeIfAbsent(leader, __ -> new DVSet());
      set.add(dv);
    }

    // Process the children
    for (DaikonVariableInfo child : dv) {
      add_variable(sets, child);
    }
  }

  /**
   * Pushes the tag associated with field_num in obj on the tag stack. A tag value must have been
   * previously stored for this field.
   *
   * @param obj where to store tag
   * @param field_num which field within obj to store into
   */
  public static void push_field_tag(Object obj, int field_num) {
    if (debug) {
      System.out.printf("In push_field_tag%n");
    }
    // Since instance variables by default initialize to zero, any field
    // can possibly be read before it is set.
    push_field_tag_null_ok(obj, field_num);
  }

  /**
   * Pushes the tag associated with field_num in obj on the tag stack. If tag storage for this
   * object has not been previously allocated it is allocated now and a tag is allocated for this
   * field. This should only be called for objects whose fields can be read without having been
   * previously written (in Java).
   *
   * @param obj where to store tag
   * @param field_num which field within obj to store into
   */
  public static void push_field_tag_null_ok(Object obj, int field_num) {
    if (debug) {
      System.out.printf("In push_field_tag_null_ok%n");
    }

    ThreadData td = thread_to_data.get(Thread.currentThread());
    Object[] obj_tags = field_map.get(obj);
    if (obj_tags != null) {
      Object tag = obj_tags[field_num];
      if (tag == null) {
        Throwable stack_trace = new Throwable();
        obj_tags[field_num] =
            tag =
                new UninitFieldTag(
                    obj.getClass().getName() + ":uninit-field:" + field_num, stack_trace);
      }
      td.tag_stack.push(tag);
      if (debug_primitive.enabled()) {
        debug_primitive.log(
            "push_field_tag %s %d = %s%n", obj_str(obj), field_num, obj_tags[field_num]);
      }
    } else {
      int fcnt = num_prim_fields(obj.getClass());
      assert field_num < fcnt : obj.getClass() + " " + field_num + " " + fcnt;
      obj_tags = new Object[fcnt];
      field_map.put(obj, obj_tags);
      debug_primitive.log("push_field_tag: Created tag storage%n");
      Throwable stack_trace = new Throwable();
      Object tag =
          new UninitFieldTag(obj.getClass().getName() + ":uninit-field" + field_num, stack_trace);
      obj_tags[field_num] = tag;
      td.tag_stack.push(tag);
      if (debug_primitive.enabled()) {
        debug_primitive.log("push_field_tag %s %d = %s%n", obj_str(obj), field_num, tag);
      }
    }
    if (debug_tag_frame) {
      System.out.printf("tag stack size: %d%n", td.tag_stack.size());
    }
  }

  /**
   * Pops the tag from the top of the tag stack and stores it in the tag storage for the specified
   * field of the specified object. If tag storage was not previously allocated, it is allocated
   * now.
   *
   * @param obj where to store tag
   * @param field_num which field within obj to store into
   */
  public static void pop_field_tag(Object obj, int field_num) {
    if (debug) {
      System.out.printf("In pop_field_tag%n");
    }

    ThreadData td = thread_to_data.get(Thread.currentThread());
    // Look for the tag storage for this object
    Object[] obj_tags = field_map.get(obj);

    // If none has been allocated, determine how many locations are
    // required (the number of primitive fields), allocate the space,
    // and associate it with the object.
    if (obj_tags == null) {
      int fcnt = num_prim_fields(obj.getClass());
      assert field_num < fcnt : obj.getClass() + " " + field_num + " " + fcnt;
      obj_tags = new Object[fcnt];
      field_map.put(obj, obj_tags);
      debug_primitive.log("pop_field_tag: Created tag storage%n");
    }

    // Pop the tag off of the stack and assign into the tag storage for
    // this field.
    assert td.tag_stack.peek() != method_marker;
    Object tag = td.tag_stack.pop();
    assert tag != null : "Object " + obj.getClass() + " '" + obj + "' field_num " + field_num;
    obj_tags[field_num] = tag;
    if (debug_primitive.enabled()) {
      debug_primitive.log(
          "pop_field_tag (%s %d = %s%n", obj_str(obj), field_num, obj_tags[field_num]);
    }
    if (debug_tag_frame) {
      System.out.printf("tag stack size: %d%n", td.tag_stack.size());
    }
  }

  /** Return the number of primitive fields in clazz and all of its superclasses. */
  public static int num_prim_fields(Class<?> clazz) {
    if (clazz == Object.class) {
      return 0;
    } else {
      int field_cnt = num_prim_fields(clazz.getSuperclass());
      for (Field f : clazz.getDeclaredFields()) {
        if (f.getType().isPrimitive()) {
          field_cnt++;
        }
      }
      return field_cnt;
    }
  }

  /**
   * Handle a binary operation on the two items at the top of the tag stack. Binary operations pop
   * the two items off of the top of the stack perform an operation and push the result back on the
   * stack. The tags of the two items on the top of the stack must thus be merged and a
   * representative tag pushed back on the stack.
   */
  public static void binary_tag_op() {
    ThreadData td = thread_to_data.get(Thread.currentThread());
    debug_primitive.log("binary tag op%n");
    assert td.tag_stack.peek() != method_marker;
    Object tag1 = td.tag_stack.pop();
    assert td.tag_stack.peek() != method_marker;
    TagEntry.union(tag1, td.tag_stack.peek());
    if (debug_tag_frame) {
      System.out.printf("tag stack size: %d%n", td.tag_stack.size());
    }
  }

  /**
   * Handles an i_cmpXX operation. This opcode compares the two integers on the top of the stack and
   * jumps accordingly. Thus the two tags on the top of the stack are popped from the tag stack and
   * merged. Very similar to binary_tag_op except that nothing is pushed back on the tag stack.
   */
  public static void cmp_op() {
    ThreadData td = thread_to_data.get(Thread.currentThread());
    debug_primitive.log("cmp_op%n");
    assert td.tag_stack.peek() != method_marker;
    Object tag1 = td.tag_stack.pop();
    assert td.tag_stack.peek() != method_marker;
    TagEntry.union(tag1, td.tag_stack.pop());
    if (debug_tag_frame) {
      System.out.printf("tag stack size: %d%n", td.tag_stack.size());
    }
    // debug_print_call_stack();
  }

  /** Handles a dup opcode on a primitive. */
  public static void dup() {
    ThreadData td = thread_to_data.get(Thread.currentThread());
    debug_primitive.log("dup%n");
    assert td.tag_stack.peek() != method_marker;
    td.tag_stack.push(td.tag_stack.peek());
    if (debug_tag_frame) {
      System.out.printf("tag stack size: %d%n", td.tag_stack.size());
    }
  }

  /** Handles a dup_x1 opcode on a primitive. */
  public static void dup_x1() {
    ThreadData td = thread_to_data.get(Thread.currentThread());
    debug_primitive.log("dup_x1%n");
    assert td.tag_stack.peek() != method_marker;
    Object top = td.tag_stack.pop();
    assert td.tag_stack.peek() != method_marker;
    Object nxt = td.tag_stack.pop();
    td.tag_stack.push(top);
    td.tag_stack.push(nxt);
    td.tag_stack.push(top);
    if (debug_tag_frame) {
      System.out.printf("tag stack size: %d%n", td.tag_stack.size());
    }
  }

  /**
   * Handles a dup_x2 opcode on a primitive. Currently only support category 1 computational types.
   */
  public static void dup_x2() {
    ThreadData td = thread_to_data.get(Thread.currentThread());
    debug_primitive.log("dup_x2%n");
    assert td.tag_stack.peek() != method_marker;
    Object top = td.tag_stack.pop();
    assert td.tag_stack.peek() != method_marker;
    Object tag1 = td.tag_stack.pop();
    assert td.tag_stack.peek() != method_marker;
    Object tag2 = td.tag_stack.pop();
    td.tag_stack.push(top);
    td.tag_stack.push(tag2);
    td.tag_stack.push(tag1);
    td.tag_stack.push(top);
    if (debug_tag_frame) {
      System.out.printf("tag stack size: %d%n", td.tag_stack.size());
    }
  }

  /** Handles a dup2 opcode on a primitive. */
  public static void dup2() {
    ThreadData td = thread_to_data.get(Thread.currentThread());
    debug_primitive.log("dup2%n");
    assert td.tag_stack.peek() != method_marker;
    Object top = td.tag_stack.pop();
    assert td.tag_stack.peek() != method_marker;
    Object tag1 = td.tag_stack.pop();
    td.tag_stack.push(tag1);
    td.tag_stack.push(top);
    td.tag_stack.push(tag1);
    td.tag_stack.push(top);
    if (debug_tag_frame) {
      System.out.printf("tag stack size: %d%n", td.tag_stack.size());
    }
  }

  /** Handles a dup2_x1 opcode on a primitive. */
  public static void dup2_x1() {
    ThreadData td = thread_to_data.get(Thread.currentThread());
    debug_primitive.log("dup2_x1%n");
    assert td.tag_stack.peek() != method_marker;
    Object top = td.tag_stack.pop();
    assert td.tag_stack.peek() != method_marker;
    Object tag1 = td.tag_stack.pop();
    assert td.tag_stack.peek() != method_marker;
    Object tag2 = td.tag_stack.pop();
    td.tag_stack.push(tag1);
    td.tag_stack.push(top);
    td.tag_stack.push(tag2);
    td.tag_stack.push(tag1);
    td.tag_stack.push(top);
    if (debug_tag_frame) {
      System.out.printf("tag stack size: %d%n", td.tag_stack.size());
    }
  }

  /** Handles a dup2_x2 opcode on a primitive. */
  public static void dup2_x2() {
    ThreadData td = thread_to_data.get(Thread.currentThread());
    debug_primitive.log("dup2_x2%n");
    assert td.tag_stack.peek() != method_marker;
    Object top = td.tag_stack.pop();
    assert td.tag_stack.peek() != method_marker;
    Object tag1 = td.tag_stack.pop();
    assert td.tag_stack.peek() != method_marker;
    Object tag2 = td.tag_stack.pop();
    assert td.tag_stack.peek() != method_marker;
    Object tag3 = td.tag_stack.pop();
    td.tag_stack.push(tag1);
    td.tag_stack.push(top);
    td.tag_stack.push(tag3);
    td.tag_stack.push(tag2);
    td.tag_stack.push(tag1);
    td.tag_stack.push(top);
    if (debug_tag_frame) {
      System.out.printf("tag stack size: %d%n", td.tag_stack.size());
    }
  }

  /** Swaps the two elements on the top of the tag stack. */
  public static void swap() {
    ThreadData td = thread_to_data.get(Thread.currentThread());
    debug_primitive.log("swap%n");
    assert td.tag_stack.peek() != method_marker;
    Object top = td.tag_stack.pop();
    assert td.tag_stack.peek() != method_marker;
    Object tag1 = td.tag_stack.pop();
    td.tag_stack.push(top);
    td.tag_stack.push(tag1);
    if (debug_tag_frame) {
      System.out.printf("tag stack size: %d%n", td.tag_stack.size());
    }
  }

  /**
   * Handles the various primitive (int, double, etc) array load instructions. The array and its
   * index are made comparable. The tag for the index is removed from the tag stack and the tag for
   * the array element is pushed on the stack.
   *
   * @param arr_ref array reference
   * @param index index into array
   */
  public static void primitive_array_load(Object arr_ref, int index) {
    debug_primitive.log("primitive_array_load%n");
    // Since instance variables by default initialize to zero, any field
    // can possibly be read before it is set.
    primitive_array_load_null_ok(arr_ref, index);
  }

  /**
   * Handles the various primitive (int, double, etc) array load instructions. The array and its
   * index are made comparable. The tag for the index is removed from the tag stack and the tag for
   * the array element is pushed on the stack. Unlike primitive_array_load(), this method handles
   * array elements whose tags have not previously been set. This can happen when the JVM sets an
   * array element directly and there is no corresponding java code that can set the tag.
   *
   * @param arr_ref array reference
   * @param index index into array
   */
  public static void primitive_array_load_null_ok(Object arr_ref, int index) {
    ThreadData td = thread_to_data.get(Thread.currentThread());
    debug_primitive.log("primitive_array_load_null_ok%n");
    // Get the tag for the index and mark it as comparable with the array
    assert td.tag_stack.peek() != method_marker;
    Object index_tag = td.tag_stack.pop();
    if (arr_ref == null) {
      if (debug_tag_frame) {
        System.out.printf("tag stack size: %d%n", td.tag_stack.size());
      }
      return;
    }
    if (debug_arr_index.enabled()) {
      debug_arr_index.log("Merging array '%s' and index '%s'", obj_str(arr_ref), index_tag);
    }
    if (merge_arrays_and_indices) {
      TagEntry.union(arr_ref, index_tag);
    }

    // Push the tag for the element on the tag stack.
    Object[] obj_tags = field_map.get(arr_ref);
    if (obj_tags != null) {
      Object tag = obj_tags[index];
      if (tag == null) {
        obj_tags[index] = tag = new UninitArrayElem();
      }
      td.tag_stack.push(tag);
      if (debug_primitive.enabled()) {
        debug_primitive.log(
            "arrayload null-ok %s[%d] = %s%n", obj_str(arr_ref), index, obj_str(obj_tags[index]));
      }
    } else {
      int length = Array.getLength(arr_ref);
      obj_tags = new Object[length];
      field_map.put(arr_ref, obj_tags);
      Object tag = new UninitArrayElem();
      obj_tags[index] = tag;
      td.tag_stack.push(tag);
      if (debug_primitive.enabled()) {
        debug_primitive.log("arrayload null-ok %s[%d] = null%n", obj_str(arr_ref), index);
      }
    }
    if (debug_tag_frame) {
      System.out.printf("tag stack size: %d%n", td.tag_stack.size());
    }
  }

  /**
   * Handles the aaload instruction. The arry and its index are made comparable. The tag for the
   * index is removed from the tag stack.
   *
   * @param arr_ref array reference
   * @param index index into array
   */
  public static void ref_array_load(Object arr_ref, int index) {
    ThreadData td = thread_to_data.get(Thread.currentThread());
    debug_primitive.log("ref_array_load%n");
    // Get the tag for the index and mark it as comparable with the array
    assert td.tag_stack.peek() != method_marker;
    Object index_tag = td.tag_stack.pop();
    if (debug_tag_frame) {
      System.out.printf("tag stack size: %d%n", td.tag_stack.size());
    }
    if (arr_ref == null) {
      return;
    }
    if (debug_arr_index.enabled()) {
      debug_arr_index.log("Merging array '%s' and index '%s'", obj_str(arr_ref), index_tag);
    }
    if (merge_arrays_and_indices) {
      TagEntry.union(arr_ref, index_tag);
    }
  }

  /**
   * Allocate a new tag for the constant and push it on the tag stack. Note that this allocates a
   * new tag each time the constant is pushed. If the same code is executed multiple time (eg, in a
   * loop), and different values interact with the constant each time, those values will not end up
   * comparable to each other.
   */
  public static void push_const() {
    ThreadData td = thread_to_data.get(Thread.currentThread());
    Object tag = new Constant();
    debug_primitive.log("push literal constant tag: %s%n", tag);
    td.tag_stack.push(tag);
    if (debug_tag_frame) {
      System.out.printf("tag stack size: %d%n", td.tag_stack.size());
    }

    // debug_print_call_stack();
  }

  /**
   * Marks the specified class as initialized. We don't look at static variables in classes until
   * they are initialized.
   *
   * @param classname class to mark initialized
   */
  public static void set_class_initialized(String classname) {
    debug_primitive.log("set_class_initialized: %s%n", classname);
    initialized_eclassses.add(classname);
  }

  /**
   * Returns whether or not the specified class is initialized.
   *
   * @param clazz class to check
   * @return true if clazz has been initialized
   */
  @Pure
  public static boolean is_class_initialized(Class<?> clazz) {
    debug_primitive.log("is_class_initialized%n");
    return initialized_eclassses.contains(clazz.getName());
  }

  /** Returns the name of the method that called the caller of caller_name(). */
  private static String caller_name() {

    Throwable stack = new Throwable("caller");
    StackTraceElement[] ste_arr = stack.getStackTrace();
    StackTraceElement ste = ste_arr[2];
    // If JDK 11 runtime transfer method, need to skip another level.
    if (ste.getClassName().equals("java.lang.DCRuntime")) {
      ste = ste_arr[3];
    }
    return ste.getClassName() + "." + ste.getMethodName();
  }

  /**
   * Returns a string description of the object that includes its class, identity hash code, and the
   * result of its toString() function - if it differs from the default implementation. Note that
   * the call to toString() may have unintended side effects. Hence, all calls to obj_str are
   * protected by debug flag checks or debug logging enabled() checks.
   *
   * @param obj object to be described
   * @return object description
   */
  private static String obj_str(Object obj) {

    if (obj == null) {
      return "<null>";
    } else {
      String tostring;
      try {
        tostring = obj.toString();
      } catch (Exception e) {
        // We use System.identityHashCode(obj) as obj.hashCode() can fail.
        tostring =
            "toString of "
                + obj.getClass().getName()
                + "@"
                + Integer.toHexString(System.identityHashCode(obj))
                + " failed";
      }
      String default_tostring =
          String.format("%s@%s", obj.getClass().getName(), System.identityHashCode(obj));
      if (tostring.equals(default_tostring)) {
        return tostring;
      } else {
        // Limit display of object contents to 60 characters.
        return String.format(
            "%s [%s]",
            default_tostring, org.apache.commons.lang3.StringUtils.abbreviate(tostring, 60));
      }
    }
  }

  /**
   * Returns all of the daikonvariables in the tree rooted at dvi.
   *
   * @param dvi the tree of variables
   * @return all the daikonvarables in the tree
   */
  private static List<DaikonVariableInfo> varlist(DaikonVariableInfo dvi) {

    List<DaikonVariableInfo> list = new ArrayList<>();
    list.add(dvi);
    for (DaikonVariableInfo child : dvi) {
      list.addAll(varlist(child));
    }
    return list;
  }

  /**
   * Returns the name of the tag field that corresponds to the specified field.
   *
   * @param field_name field name
   * @return tag field name
   */
  public static String tag_field_name(String field_name) {
    debug_primitive.log("tag_field_name: %s%n", field_name);
    return (field_name + "__$tag");
  }

  private static Matcher jdk_decl_matcher =
      Pattern.compile("(, )?java.lang.DCompMarker( marker)?").matcher("");
  private static Matcher non_jdk_decl_matcher =
      Pattern.compile("(, )?daikon.dcomp.DCompMarker( marker)?").matcher("");

  /** Removes DCompMarker from the signature. */
  public static String clean_decl_name(String decl_name) {

    if (DCInstrument.jdk_instrumented) {
      jdk_decl_matcher.reset(decl_name);
      return jdk_decl_matcher.replaceFirst("");
    } else {
      non_jdk_decl_matcher.reset(decl_name);
      return non_jdk_decl_matcher.replaceFirst("");
    }
  }

  /**
   * Abstract base class for code that gets the tag associated with a particular field. There are
   * specific implementors for the various types of fields. FieldTag instances are stored in
   * FieldInfo so that tags can be efficiently obtained.
   */
  public abstract static class FieldTag {

    /**
     * Gets the tag for the field.
     *
     * @param parent object that contains the field (if any)
     * @param obj value of the field itself (if available and if it's an object)
     * @return the tag for the field
     */
    abstract Object get_tag(Object parent, Object obj);
  }

  /**
   * Class that gets the tag for static primitive fields. We retrieve the static tag by using the
   * same method as we use during run time to push the tag on the tag stack.
   */
  public static class StaticPrimitiveTag extends FieldTag {

    Method get_tag;

    /** Initialize with information from the field. */
    StaticPrimitiveTag(FieldInfo fi) {
      assert fi.isStatic();
      assert fi.isPrimitive();
      Field field = fi.getField();
      Class<?> clazz = field.getDeclaringClass();
      String name =
          DCInstrument.tag_method_name(DCInstrument.GET_TAG, clazz.getName(), field.getName());
      try {
        get_tag = clazz.getMethod(name);
      } catch (Exception e) {
        throw new Error("can't find tag method " + name, e);
      }
    }

    /** Return the tag associated with this field. */
    @Override
    Object get_tag(Object parent, Object obj) {
      Object tag;
      // jhp - not sure why these are not null...
      // assert parent == null && obj == null
      //  : " parent/obj = " + obj_str(parent) + "/" + obj_str(obj);
      try {
        ThreadData td = thread_to_data.get(Thread.currentThread());
        Object ret_val = get_tag.invoke(parent);
        assert ret_val == null;
        assert td.tag_stack.peek() != method_marker;
        tag = td.tag_stack.pop();
        assert tag != null;
        if (debug_tag_frame) {
          System.out.printf("tag stack size: %d%n", td.tag_stack.size());
        }
      } catch (Exception e) {
        throw new Error("can't execute tag method " + get_tag, e);
      }
      return tag;
    }
  }

  /**
   * Class that gets the tag for a static reference variable. The tag for a reference variable is
   * the object itself, so that is obtained via reflection.
   */
  public static class StaticReferenceTag extends FieldTag {

    /** Corresponding java field. */
    Field field;

    /** Set to true when the class containing the field is initialized. */
    boolean is_class_initialized = false;

    /** Class that contains the field. */
    Class<?> declaring_class;

    /** Initialize for this field. */
    public StaticReferenceTag(FieldInfo fi) {

      assert fi.isStatic();
      assert !fi.isPrimitive();
      field = fi.getField();
      declaring_class = field.getDeclaringClass();
    }

    /** Gets the tag for this static reference. */
    @Override
    @SuppressWarnings("deprecation") // in Java 9+, use canAccess instead of isAccessible
    public Object get_tag(Object parent, Object obj) {

      // assert parent == null && obj == null;
      if (!is_class_initialized) {
        if (is_class_initialized(declaring_class)) {
          if (!field.isAccessible()) {
            field.setAccessible(true);
          }
          is_class_initialized = true;
        } else {
          return nonsensical;
        }
      }

      try {
        return field.get(null);
      } catch (Exception e) {
        throw new RuntimeException("Can't get val for static field " + field, e);
      }
    }
  }

  /**
   * Class that gets the list of tags for primitive arrays. Note that primitive arrays can both be
   * actual arrays of primitives and also arrays of classes containing primitives. In the second
   * case, there is a separate object that contains each of the 'array' values.
   */
  public static class PrimitiveArrayTag extends FieldTag {

    /** The field number for this field inside its object. */
    int field_num;

    public PrimitiveArrayTag(FieldInfo fi) {
      assert !fi.isStatic() && fi.isPrimitive() && fi.isArray();
      field_num = fi.get_field_num();
    }

    /** Returns a list of object tags. */
    @Override
    public Object get_tag(Object parent, Object obj) {

      // Object is an array of objects containing each item
      // assert obj == null: "primitive array object = " + obj_str (obj);
      @SuppressWarnings("unchecked")
      List<Object> parent_list = (List<Object>) parent;
      List<Object> tag_list = new ArrayList<>(parent_list.size());
      for (Object parent_element : parent_list) {
        Object[] tags = field_map.get(parent_element);
        if (tags == null) {
          tag_list.add(nonsensical);
        } else {
          tag_list.add(tags[field_num]);
        }
      }
      return tag_list;
    }
  }

  /**
   * Class that gets the tag for a primitive instance field. Each object with primitive fields has a
   * corresponding tag array in field map. The tag for a particular field is stored at that fields
   * offset in the tag array.
   */
  public static class PrimitiveTag extends FieldTag {

    int field_num;

    public PrimitiveTag(FieldInfo fi) {
      assert !fi.isStatic() && fi.isPrimitive() && !fi.isArray();
      field_num = fi.get_field_num();
    }

    @Override
    public Object get_tag(Object parent, Object obj) {

      // obj is the wrapper for the primitive
      // assert obj == null: "primitive object = " + obj_str (obj);
      Object[] tags = field_map.get(parent);
      if (tags == null) {
        return nonsensical; // happens if field has never been assigned to
      } else {
        return tags[field_num];
      }
    }
  }

  /**
   * Class that returns the tag for a reference instance field. In this case, the tag is just the
   * object itself.
   */
  public static class ReferenceTag extends FieldTag {

    public ReferenceTag(FieldInfo fi) {
      assert !fi.isStatic() && !fi.isPrimitive();
    }

    @Override
    public Object get_tag(Object parent, Object obj) {
      return obj;
    }
  }
}