qilinpta / qilin Goto Github PK

View Code? Open in Web Editor NEW

113.0 10.0 28.0 298.16 MB

Qilin: A New Framework for Supporting Fine-Grained Context-Sensitivity in Java Pointer Analysis

Home Page: https://qilinpta.github.io/Qilin

License: GNU Lesser General Public License v2.1

Dockerfile 0.05% Python 3.73% Java 96.05% HTML 0.17% Shell 0.01%

java-pointer-analysis static-analysis

qilin's Introduction

⚠️ Documentation for Qilin is under development.

News

DebloaterX published in our OOPSLA paper is now available in Qilin
Qilin now supports Soot-4.5.0

Qilin: A fully imperative Java Pointer Analysis Framework.

The repository hosts Qilin, a new Java pointer analysis framework for supporting fine-grained context-sensitivity. For technical details, please refer to our ECOOP'22 paper.

A Quick Start

Prerequisites

Java 16+ (Qilin uses the pattern matching for instanceof provided since Java 16).
Python 3.5+ (the api subprocess.run used in artifact/qilin.py is added in Python 3.5).

Download

This repository contains a submodule that contains a set of real-world ready-to-use benchmarks for Qilin. If you want to run Qilin on these benchmarks, please use the following command to fetch the Qilin source code:

$ git clone --recurse-submodules https://github.com/QilinPTA/Qilin.git

If you have cloned Qilin in a normal way, you still can use the command below to download these benchmarks:

$ git submodule update --init

Building Qilin with Gradle

We use Gradle as the build automation tool. To build Qilin, use

$ ./run.sh

This script contains commands to generate Qilin-VERSION-SNAPSHOT.jar, which will be automatically moved into artifact/.

For users who want to build Qilin in IDE, please refer to this page.

Using Qilin

You can use Qilin either through its command-line interface (e.g., driver.Main) or as a library. For researchers who are working on Java pointer analysis, we have provided a whole set of scripts, benchmarks ( e.g., DaCapo2006) and jdk libraries under artifact/.

To test Qilin, you can directly do:

$ cd artifact
$ python3 run.py antlr ci -print

The above command will analyse antlr with a context-insensitive pointer analysis with some metrics being displayed on the screen.
We plan to optimise the run.py script to make its help info more user-friendly.

Documentation

About Qilin	Setup Guide	User Guide	Developer Guide
Introducing Qilin -- what it does and how we design it	A step by step setup guide to build Qilin	Command-line options of Qilin, and running Qilin with an example	Detailed technical documentation and how to use Qilin as a lib for your tool or write your own analyses in Qilin

Contributing to Qilin

Contributions are always welcome. Qilin is an open-source project that we publish in the hope that it will be useful to the research community as a whole. If you have a new feature or a bug fix that you would like to see in the official code repository, please open a merge request here on Github and leave a short description of what you have done.

License

Qilin is licenced under the GPL v2.1 license, see the LICENSE file.

qilin's People

Stargazers

Watchers

qilin's Issues

-pta ko、kc and so on UNSUPPORT

When I run Qilin as following:
java -cp /home/monadic/java_project/Qilin/artifact/Qilin-1.0-SNAPSHOT.jar driver.Main -pae -pe -clinit=ONFLY -lcs -mh -pta=ko -apppath /home/monadic/java_project/Qilin/docs/example/example01/example.jar -mainclass Main -jre=/home/monadic/java_project/Qilin/artifact/benchmarks/JREs/jre1.8.0_312/ -se -jimple

I have encountered the following error:
[main] ERROR driver.PTAOption - Error parsing command line options
java.lang.RuntimeException: Unsupported PTA: ko !
at driver.PTAPattern.parsePTACommand(PTAPattern.java:51)
at driver.PTAPattern.(PTAPattern.java:35)
at driver.PTAOption.parseCommandLineOptions(PTAOption.java:116)
at driver.PTAOption.parseCommandLine(PTAOption.java:98)
at driver.Main.run(Main.java:41)
at driver.Main.mainRun(Main.java:58)
at driver.Main.main(Main.java:172)

How can I do to make Qilin support ko/kc and so on? Thank you.

Setup error "driver/Main has been compiled by a more recent version of the Java Runtime (class file version 60.0)"

Hi, really good works~

When I tried the docker image by following the instruction in Qilin wiki, I got output below. It says driver/Main has been compiled by a more recent version of the Java Runtime (class file version 60.0). By the way, when I cloned the repo and ran it in my WSL, same things happened.

Is it anything I missed? Thanks~

root@dce6d3699656:/qilin# python3 run.py antlr ci -print
now running insens for antlr ...
-Xmx256g -timeout=43200 -pae -pe -clinit=ONFLY -lcs -mh -pta=insens -apppath benchmarks/dacapo2006/antlr.jar -libpath benchmarks/dacapo2006/antlr-deps.jar -reflectionlog benchmarks/dacapo2006/antlr-refl.log -mainclass dacapo.antlr.Main -jre=jre1.6.0_45
java -Xms1g -Xmx256g -cp /qilin/Qilin-1.0-SNAPSHOT.jar driver.Main -pae -pe -clinit=ONFLY -lcs -mh -pta=insens -apppath benchmarks/dacapo2006/antlr.jar -libpath benchmarks/dacapo2006/antlr-deps.jar -reflectionlog benchmarks/dacapo2006/antlr-refl.log -mainclass dacapo.antlr.Main -jre=/qilin/benchmarks/JREs/jre1.6.0_45
Error: A JNI error has occurred, please check your installation and try again
Exception in thread "main" java.lang.UnsupportedClassVersionError: driver/Main has been compiled by a more recent version of the Java Runtime (class file version 60.0), this version of the Java Runtime only recognizes class file versions up to 52.0
        at java.lang.ClassLoader.defineClass1(Native Method)
        at java.lang.ClassLoader.defineClass(ClassLoader.java:756)
        at java.security.SecureClassLoader.defineClass(SecureClassLoader.java:142)
        at java.net.URLClassLoader.defineClass(URLClassLoader.java:468)
        at java.net.URLClassLoader.access$100(URLClassLoader.java:74)
        at java.net.URLClassLoader$1.run(URLClassLoader.java:369)
        at java.net.URLClassLoader$1.run(URLClassLoader.java:363)
        at java.security.AccessController.doPrivileged(Native Method)
        at java.net.URLClassLoader.findClass(URLClassLoader.java:362)
        at java.lang.ClassLoader.loadClass(ClassLoader.java:418)
        at sun.misc.Launcher$AppClassLoader.loadClass(Launcher.java:352)
        at java.lang.ClassLoader.loadClass(ClassLoader.java:351)
        at sun.launcher.LauncherHelper.checkAndLoadMain(LauncherHelper.java:601)

no problems

Hello! It's nice to see that you did this model, but I don't seem to see any benchmark results in your paper? So have you done it yet? Especially the conclusions of VQA-RAD and PATH-VQA?

How to exclude imported modules in the analysis

When we try to import any kind of java modules, the pointer analysis will then include the packages we import (like java.util.hashmap or java.awt.*), resulting in a huge call graph. Is there a way to limit the pointer analysis depth to a higher level?

Running Code in a Single Thread

Hi there,

Thanks for creating this high performance implementation of the pointer analysis in Java, I find it very easy to install, run, and produce results for my work. I have noticed that your code always runs with multiple threads and I was wondering if it is possible to run it on one thread.

Regards,
Yasmin

Can QiLin use one specified method as the entry for pointer analysis?

I want to specify a method (not main()) as the entry for PTA. What part of the code do I need to modify to do this?