com.ibm.wala.ipa.modref.ModRefFieldAccess Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2002 - 2014 IBM Corporation.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 */

package com.ibm.wala.ipa.modref;

import com.ibm.wala.classLoader.IClass;
import com.ibm.wala.classLoader.IField;
import com.ibm.wala.ipa.callgraph.CGNode;
import com.ibm.wala.ipa.callgraph.CallGraph;
import com.ibm.wala.ssa.IR;
import com.ibm.wala.ssa.SSAGetInstruction;
import com.ibm.wala.ssa.SSAInstruction;
import com.ibm.wala.ssa.SSAPutInstruction;
import com.ibm.wala.types.FieldReference;
import com.ibm.wala.util.collections.Iterator2Iterable;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;

/**
 * Computes interprocedural field accesses for a given method.
 *
 * @author Martin Seidel
 * @author Juergen Graf <[email protected]>
 */
public final class ModRefFieldAccess {

  private static class TwoMaps {
    private Map> mods;
    private Map> refs;

    public TwoMaps(Map> mods, Map> refs) {
      this.mods = mods;
      this.refs = refs;
      if (mods == null) {
        this.mods = new HashMap<>();
      }
      if (refs == null) {
        this.refs = new HashMap<>();
      }
    }

    public Map> getMods() {
      return mods;
    }

    public Map> getRefs() {
      return refs;
    }
  }

  private final CallGraph cg;

  private final Map>> mods;
  private final Map>> refs;
  private final Map>> tmods;
  private final Map>> trefs;

  private final List done;

  private ModRefFieldAccess(CallGraph cg) {
    this.cg = cg;
    this.refs = new HashMap<>();
    this.mods = new HashMap<>();
    this.trefs = new HashMap<>();
    this.tmods = new HashMap<>();
    this.done = new ArrayList<>();
  }

  public static ModRefFieldAccess compute(CallGraph cg) {
    ModRefFieldAccess fa = new ModRefFieldAccess(cg);
    fa.run();

    return fa;
  }

  public Map> getMod(CGNode node) {
    return mods.get(node);
  }

  public Map> getRef(CGNode node) {
    return refs.get(node);
  }

  public Map> getTransitiveMod(CGNode node) {
    return tmods.get(node);
  }

  public Map> getTransitiveRef(CGNode node) {
    return trefs.get(node);
  }

  private void run() {

    for (CGNode cgNode : cg) {
      if (!refs.containsKey(cgNode)) {
        refs.put(cgNode, new HashMap<>());
      }
      if (!mods.containsKey(cgNode)) {
        mods.put(cgNode, new HashMap<>());
      }

      final IR ir = cgNode.getIR();

      if (ir == null) {
        continue;
      }

      for (SSAInstruction instr : Iterator2Iterable.make(ir.iterateNormalInstructions())) {
        if (instr instanceof SSAGetInstruction) {
          SSAGetInstruction get = (SSAGetInstruction) instr;
          FieldReference fref = get.getDeclaredField();
          IField field = cg.getClassHierarchy().resolveField(fref);
          if (field != null) {
            IClass cls = field.getDeclaringClass();
            if (cls != null) {
              if (!refs.get(cgNode).containsKey(cls)) {
                refs.get(cgNode).put(cls, new HashSet<>());
              }
              refs.get(cgNode).get(cls).add(field);
            }
          }
        } else if (instr instanceof SSAPutInstruction) {
          SSAPutInstruction put = (SSAPutInstruction) instr;
          FieldReference fput = put.getDeclaredField();
          IField field = cg.getClassHierarchy().resolveField(fput);
          if (field != null) {
            IClass cls = field.getDeclaringClass();
            if (cls != null) {
              if (!mods.get(cgNode).containsKey(cls)) {
                mods.get(cgNode).put(cls, new HashSet<>());
              }
              mods.get(cgNode).get(cls).add(field);
            }
          }
        }
      }
    }

    recAdd(cg.getFakeRootNode());
  }

  private TwoMaps recAdd(CGNode node) {
    if (!trefs.containsKey(node)) {
      trefs.put(node, new HashMap<>());
    }
    if (!tmods.containsKey(node)) {
      tmods.put(node, new HashMap<>());
    }

    final IR ir = node.getIR();
    if (ir != null) {
      for (SSAInstruction instr : Iterator2Iterable.make(ir.iterateNormalInstructions())) {
        if (instr instanceof SSAGetInstruction) {
          SSAGetInstruction get = (SSAGetInstruction) instr;
          FieldReference fref = get.getDeclaredField();
          IField field = cg.getClassHierarchy().resolveField(fref);
          if (field != null) {
            IClass cls = field.getDeclaringClass();
            if (cls != null) {
              if (!trefs.get(node).containsKey(cls)) {
                trefs.get(node).put(cls, new HashSet<>());
              }
              trefs.get(node).get(cls).add(field);
            }
          }
        } else if (instr instanceof SSAPutInstruction) {
          SSAPutInstruction put = (SSAPutInstruction) instr;
          FieldReference fput = put.getDeclaredField();
          IField field = cg.getClassHierarchy().resolveField(fput);
          if (field != null) {
            IClass cls = field.getDeclaringClass();
            if (cls != null) {
              if (!tmods.get(node).containsKey(cls)) {
                tmods.get(node).put(cls, new HashSet<>());
              }
              tmods.get(node).get(cls).add(field);
            }
          }
        }
      }
    }

    for (CGNode n : Iterator2Iterable.make(cg.getSuccNodes(node))) {
      if (!done.contains(n)) {
        done.add(n);
        TwoMaps t = recAdd(n);
        for (IClass c : t.getRefs().keySet()) {
          if (trefs.get(node).containsKey(c)) {
            trefs.get(node).get(c).addAll(t.getRefs().get(c));
          } else {
            trefs.get(node).put(c, t.getRefs().get(c));
          }
        }
        for (IClass c : t.getMods().keySet()) {
          if (tmods.get(node).containsKey(c)) {
            tmods.get(node).get(c).addAll(t.getMods().get(c));
          } else {
            tmods.get(node).put(c, t.getMods().get(c));
          }
        }
      }
    }

    return new TwoMaps(tmods.get(node), trefs.get(node));
  }
}