# QCG
**Repository Path**: mirrors_secure-software-engineering/QCG
## Basic Information
- **Project Name**: QCG
- **Description**: Qilin: A New Framework for Supporting Fine-Grained Context-Sensitivity in Java Pointer Analysis
- **Primary Language**: Unknown
- **License**: LGPL-2.1
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-03-03
- **Last Updated**: 2026-05-10
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
[](https://github.com/QilinPTA/Qilin/actions/workflows/gradle.yml)
[](https://github.com/QilinPTA/Qilin/actions/workflows/docker-image.yml)
[](https://gitpod.io/#https://github.com/QilinPTA/Qilin)
> :warning: [Documentation for Qilin](https://qilinpta.github.io/) is under development.
# News
* [DebloaterX](https://github.com/DongjieHe/DebloaterX) published in our [OOPSLA paper](https://dongjiehe.github.io/mypaper/OOPSLA2023_DebloaterX_Preprint.pdf) is now available in Qilin
* Qilin now supports Soot-4.4.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.
Qilin is introduced in our ECOOP'22 paper. You can cite our paper as follows:
```
@InProceedings{he2022qilin,
author = {He, Dongjie and Lu, Jingbo and Xue, Jingling},
title = {Qilin: A New Framework for Supporting Fine-Grained Context-Sensitivity in Java Pointer Analysis},
booktitle = {36th European Conference on Object-Oriented Programming (ECOOP 2022)},
year = {2022},
publisher = {Schloss Dagstuhl -- Leibniz-Zentrum f{\"u}r Informatik},
address = {Dagstuhl, Germany},
}
```
## 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](https://github.com/QilinPTA/Qilin/wiki/Set-up-the-Debugging-Environment-for-Qilin-in-IntelliJ-IDEA).
### 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](https://qilinpta.github.io/Qilin/#what-is-qilin) and [how we design it](https://github.com/QilinPTA/Qilin/wiki/Qilin-Design#qilin-design) | A step by step [setup guide](https://github.com/QilinPTA/Qilin/wiki/Setup-Guide#getting-started) to build Qilin | [Command-line options](https://github.com/QilinPTA/Qilin/wiki/Full-list-of-Qilin-options) of Qilin, and running Qilin with [an example](https://github.com/QilinPTA/Qilin/wiki/Analyse-a-Simple-Java-Program#an-example) | Detailed [technical documentation](https://qilinpta.github.io/Qilin/QilinCodeStructure.html) and how to [use Qilin as a lib](https://github.com/QilinPTA/Qilin/wiki/Qilin-as-a-lib) for your tool or [write your own analyses](https://github.com/QilinPTA/Qilin/wiki/Write-your-own-analysis-in-Qilin) 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.