Packages

•  package root

  Definition Classes

  root

•  package org

  Definition Classes

  root

•  package opalj

  OPAL is a Scala-based framework for the static analysis, manipulation and creation of Java bytecode.

  OPAL is a Scala-based framework for the static analysis, manipulation and creation of Java bytecode. OPAL is designed with performance, scalability and adaptability in mind.

  Its main components are:

  • a library (Common) which provides generally useful data-structures and algorithms for static analyses.
  • a framework for implementing lattice based static analyses (Static Analysis Infrastructure)
  • a framework for parsing Java bytecode (Bytecode Infrastructure - org.opalj.bi) that can be used to create arbitrary representations.
  • a library to create a one-to-one in-memory representation of Java bytecode (Bytecode Disassembler - org.opalj.da).
  • a library to convert this representation to Java class files (Bytecode Creator - org.opalj.bc).
  • a library to create a representation of Java bytecode that facilitates writing simple static analyses (Bytecode Representation - org.opalj.br).
  • a library to create a stackless, three-address code representation of Java bytecode that facilitates writing complex static analyses (Three Address Code - org.opalj.tac).
  • a scalable, easily customizable framework for the abstract interpretation of Java bytecode (Abstract Interpretation Framework - org.opalj.ai).
  • a library to extract dependencies between code elements (Dependencies Extraction - org.opalj.de) and to facilitate checking architecture definitions (Architecture Validation - org.opalj.av).
  • a library for the lightweight manipulation and creation of Java bytecode (Bytecode Assembler - org.opalj.ba).
  • a library for parsing Android packages (APK - org.opalj.apk).
  • libraries for writing static analyses using the interprocedural finite distributive subset (IFDS - org.opalj.ifds) and interprocedural distributive environment (IDE - org.opal.ide) algorithms.

  General Design Decisions

  Thread Safety

  Unless explicitly noted, OPAL is thread safe. I.e., the classes defined by OPAL can be considered to be thread safe unless otherwise stated. (For example, it is possible to read and process class files concurrently without explicit synchronization on the client side.)

  No null Values

  Unless explicitly noted, OPAL does not null values I.e., fields that are accessible will never contain null values and methods will never return null. If a method accepts null as a value for a parameter or returns a null value it is always explicitly documented. In general, the behavior of methods that are passed null values is undefined unless explicitly documented.

  No Typecasts for Collections

  For efficiency reasons, OPAL sometimes uses mutable data-structures internally. After construction time, these data-structures are generally represented using their generic interfaces (e.g., scala.collection.{Set,Map}). However, a downcast (e.g., to add/remove elements) is always forbidden as it would effectively prevent thread-safety.

  Assertions

  OPAL makes heavy use of Scala's Assertion Facility to facilitate writing correct code. Hence, for production builds (after thorough testing(!)) it is highly recommend to build OPAL again using -Xdisable-assertions.

  Definition Classes

  org

•  package tac

  Common definitions related to the definition and processing of three address code.

  Common definitions related to the definition and processing of three address code.

  Definition Classes

  opalj

•  object TAC extends ProjectsAnalysisApplication

  Creates the three-address representation for some method(s) and prints it to std out or writes it to a file.

  Creates the three-address representation for some method(s) and prints it to std out or writes it to a file.

  Definition Classes

  tac

  Example:

  1. To convert all files of a project to the AI based three-address code, you can use:

     import org.opalj.io.write
     import org.opalj.util.PerformanceEvaluation.time
     import org.opalj.tac._
     val f = new java.io.File("OPAL/bi/target/scala-2.12/resource_managed/test/ai.jar")
     val p = org.opalj.br.analyses.Project(f)
     var i = 0
     val errors = time {
       p.parForeachMethodWithBody(parallelizationLevel=32){ mi =>
         val TACode(code,cfg,ehs,_) = org.opalj.tac.TACAI(p,mi.method)()
         val tac = ToTxt(code, Some(cfg))
         val fileNamePrefix = mi.classFile.thisType.toJava+"."+mi.method.name
         val file = write(tac, fileNamePrefix, ".tac.txt")
         i+= 1
         println(i+":"+file)
       }
     }(t => println("transformation time: "+t.toSeconds))
     if(errors.nonEmpty) println(errors.mkString("\n"))

• TACConfig

org.opalj.tac.TAC

TACConfig