# DrCCTProf-Thread_Synchronization_Bottleneck_Detection

**Repository Path**: went_forward/dr-cctprof-thread_-synchronization_-bottleneck_-detection

## Basic Information

- **Project Name**: DrCCTProf-Thread_Synchronization_Bottleneck_Detection
- **Description**: 对多线程中同步存在的问题进行检测的工具，包含mutex、condition variable等
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2023-07-10
- **Last Updated**: 2024-12-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# DrCCTProf

DrCCTProf is a fine-grained call path profiling framework for binaries running on ARM and X86 architectures. 

-   Please see our [blog](https://xl10.github.io/blog/drcctprof.html) for the high-level introduction.
-   Please watch our [introductory talk](https://www.youtube.com/watch?v=oUB9yh_78hE) to learn more.
-   Please refer [documentation](https://drcctprof.readthedocs.io/en/latest/) for detailed tutorial and API references. 

![build master](https://github.com/Xuhpclab/DrCCTProf/workflows/build%20master/badge.svg)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/d9708750f8b24b60bc0102dd5b89e4dd)](https://www.codacy.com/gh/Xuhpclab/DrCCTProf/dashboard?utm_source=github.com&utm_medium=referral&utm_content=Xuhpclab/DrCCTProf&utm_campaign=Badge_Grade)
![license](https://img.shields.io/github/license/Xuhpclab/DrCCTProf)

## Contents

-   [Installation](#installation)
-   [Usage](#usage)
-   [Client tools](#client-tools)
-   [Supported Platforms](#support-platforms)
-   [Obtaining Help](#obtaining-help)
-   [License](#license)

## Installation

### Linux

#### 1 Install dependencies

In order to build you'll need the following packages:

-   gcc (>= 4.8)
-   binutils (>= 2.26)
-   [cmake](https://cmake.org/download/) (>= 3.7)
-   perl

To avoid version conflicts with any packages, we recommend to use [Spack](https://spack.io/) to manage the above packages and create a virtual environment to build and run DrCCTProf. 

#### 2 Build

Use the following commands to get source code and build DrCCTProf:

```console
$ git clone --recurse https://github.com/Xuhpclab/DrCCTProf.git
```

```console
$ ./build.sh
```

## Usage

### Linux

To run DrCCTProf, one needs to use the following command:

#### 1 Set the global environment variable

```console
$ export drrun=/path/to/DrCCTProf/build/bin64/drrun
```

#### 2 Run client tool

-   **x86_64**

```console
$ $drrun -t <client tool> -- <application> [apllication args]
```

e.g. The command below will start the client **drcctlib_instr_statistics_clean_call** to analyze **echo _"Hello World!"_**.

```console
$ $drrun -t drcctlib_instr_statistics_clean_call -- echo "Hello World!"
```

-   **aarch64**

```console
$ $drrun -unsafe_build_ldstex -t <client tool> -- <application> [apllication args]
```

## Client tools

### Internal client tools list

| Name                                 | Features                                                                    | Status  |
| ------------------------------------ | --------------------------------------------------------------------------- | ------- |
| drcctlib_cct_only_clean_call         | A tool that collects call path on each instruction.                         | release |
| drcctlib_instr_statistics_clean_call | A instruction counting tool that counts each instruction.                   | release |
| drcctlib_reuse_distance_client_cache | A reuse distance measurement tool.                                          | release |
| drcctlib_cct_only                    | (Code cache mode)A tool that collects call path on each instruction.        | beta    |
| drcctlib_instr_statistics            | (Code cache mode) A instruction counting tool that counts each instruction. | beta    |
| drcctlib_reuse_distance              | (Code cache mode) A reuse distance measurement tool.                        | beta    |


## Support Platforms

The following platforms pass our tests.

### Linux

| CPU                               | Systems       | Architecture |
| --------------------------------- | ------------- | ------------ |
| Intel(R) Xeon(R) CPU E5-2699 v3   | Ubuntu 18.04  | x86_64       |
| Intel(R) Xeon(R) CPU E5-2650 v4   | Ubuntu 14.04  | x86_64       |
| Intel(R) Xeon(R) CPU E7-4830 v4   | Red Hat 4.8.3 | x86_64       |
| Arm Cortex A53(Raspberry pi 3 b+) | Ubuntu 18.04  | aarch64      |
| Arm Cortex-A57(Jetson Nano)       | Ubuntu 18.04  | aarch64      |
| ThunderX2 99xx                    | Ubuntu 20.04  | aarch64      |
| AWS Graviton1                     | Ubuntu 18.04  | aarch64      |
| AWS Graviton2                     | Ubuntu 18.04  | aarch64      |

## Obtaining Help

### Report an error case of building

Please use the [build error report](https://github.com/Xuhpclab/DrCCTProf/issues/new?labels=build-error&template=build_error.md&title=Build+error).

DrCCTProf is built atop [DynamoRIO](https://github.com/DynamoRIO/dynamorio). If you get errors in building, you can also search the [DynamoRIO's issues](https://github.com/DynamoRIO/dynamorio/issues) to get help.

### Report a bug

Please use the [bug report](https://github.com/Xuhpclab/DrCCTProf/issues/new?labels=bug-report&template=bug_report.md&title=Bug+report).

## License

DrCCTProf is released under the [MIT License](http://www.opensource.org/licenses/MIT).