# llvm-adlt

**Repository Path**: sukhikhalexander/llvm-adlt

## Basic Information

- **Project Name**: llvm-adlt
- **Description**: Patches for OpenHarmony that add ADLT features for LLVM.
- **Primary Language**: C++
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 17
- **Created**: 2024-07-25
- **Last Updated**: 2024-10-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

Docs and tests of ADLT feature for LLVM.

### General use case
Just add `--adlt` option to `ld.lld` call when build shared library.
```bash
# 1) input libs should be linked with -Wl,--emit-relocs,--no-relax
# 2) '--shared' will be applied automatically
$LLVM/bin/ld.lld --adlt -o libadlt.so liba.so libb.so

# note: the result lib can be checked by existing tools as plain lib
#   examples:
$LLVM/bin/llvm-objdump -xsSdRr out/adlt.so &> adlt.so.asm
$LLVM/bin/llvm-readelf -a out/adlt.so &> readelf_adlt.so.asm
$LLVM/bin/llvm-readelf -r out/adlt.so &> readelf_relocs_adlt.so.asm
# print the content of .adlt section
$LLVM/bin/llvm-readelf --adlt-section --elf-output-style=LLVM out/adlt.so
```


1. #### Setup SDK and Editor first
    `Read this`: [./docs/SETUP_SDK.md](./docs/SETUP_SDK.md).\
    `Alternative way`: Consider using docker container instead of local machine
        for building sdk and llvm-adlt.\
        Docker file and build  script is in `./docker/`,
        description is in [./docs/SETUP_DOCKER.md](./docs/SETUP_DOCKER.md).

1. Download this repo:
    ```bash
    ADLT_DEMO="$HOME/work/llvm-adlt"
    # optional: save this variable
    echo "export ADLT_DEMO=\"$ADLT_DEMO\"" >> ~/.bashrc
    source ~/.bashrc # restart shell

    git clone https://gitee.com/lyupaanastasia/llvm-adlt \
        --depth=1 $ADLT_DEMO && cd $ADLT_DEMO
    ```
1. If `SDK_PARTLY`: Set up variable `. rc.sdk-partly.sh /path/to/clang`, example:
    ```bash
    # do it once:
    echo 'export SDK_PARTLY=$SDK_ROOT/prebuilts/clang/ohos/linux-x86_64/clang-15.0.4' >> ~/.bashrc
    source ~/.bashrc # refresh current session
    # or do this line in every new terminal session
    . rc.sdk-partly.sh $SDK_ROOT/prebuilts/clang/ohos/linux-x86_64/clang-15.0.4
    ```
1. Build demo and run all tests:
    ```bash
    ./main.py -cb all -r all
    # Add the option '-d' to recompile tests in Debug-mode or debug the test.
    # If you want to debug musl, please make sure that you build sdk with the "--adlt-debug-build" flag.
    # Add the option '--withOrigMusl' to run tests with original musl. (needs builded original musl)

    # Other use cases:
    # Build specific tests. E.g. clean and build some base and cfi tests:
    ./main.py -cb base/cross,cfi/call-cast

    # Build group tests:
    ./main.py -cb tls
    # or multiple groups
    ./main.py -cb tls,cfi

    # Rebuild lld, musl (with adlt) and some tests:
    ./main.py -cb lld,musl,cfi/call-cast
    # Note: files for LLD and musl will not be removed.

    # Build orig-musl:
    ./main.py -b orig-musl
    # Note: orig-musl is needed for running with '--withOrigMusl' option.

    # add RELR env variable to build tests with "android+relr" sections
    RELR=1 ./main.py -cb lld,base/cross -r base/cross/adlt


    # Run multiple tests. E.g., compare base/cross tests:
    ./main.py -r base/cross/orig,base/cross/adlt
    # add "--trace" to print more detailed info
    # add "--qemuLogFile" to put runtime results in log files.

    # Run only tests marked as successful:
    ./main.py -r only-ok
    # Run only tests marked as unsuccessful:
    ./main.py -r only-fail
    # (tests states are marked in TEST_LIST in tools/config.py)

    # Run only specific subtest(s) with the specified command line parameters (optional).
    # E.g., for the test ld-musl/so_mem_share/orig run
    # subtests 'so_mem_share_hello', 'so_mem_share_chain_a 0', 'so_mem_share_chain_a 2' and
    # for the test ld-musl/so_mem_share/adlt run all subtests:
    ./main.py -r ld-musl/so_mem_share/orig:so_mem_share_hello:'so_mem_share_chain_a 0':'so_mem_share_chain_a 2',ld-musl/so_mem_share/adlt
    # Note: use single quotes if subtest string contains space(s)
    # or enclose the entire run option value in quotes:
    ./main.py -r 'ld-musl/so_mem_share/orig:so_mem_share_hello:so_mem_share_chain_a 0:so_mem_share_chain_a 2,ld-musl/so_mem_share/adlt'

    # check other features by using '-h' option
    ```
1. The results will be located in `./out/qemu` directory.
1. #### [Learn how to work with projects and publish changes](./docs/CONTRIBUTE.md)
1. #### [Learn debugging notes and examples](./docs/DEBUGGING.md)

### Using prebuilt toolchain
It is now possible to use prebuilt toolchain for building and running tests

To do so
1. Obtain the toolchain build with gtest libraries included (that is, built  with `--build-gtest-libs` option).
See [Setup SDK](./docs/SETUP_SDK.md).
1. Set up variables `. rc.sdk-prebuilt.sh /path/to/llvm-build-id`
1. Build and run tests `./main.py -cb all -r all`


### General rules
1. Code style format: `LLVM`. [Link to configure VSCode](./SETUP_SDK.md#vscode-configuration).
1. Merges are not allowed. Do rebases instead.

### Additional notes
1. If '`-b all`' is used, it will rebuild LLD automatically as well.