/ConfD

Analyzing Configuration Dependencies of File Systems [FAST'23, HotStorage'22]

Primary LanguageRoff

README

ConfD

This repository contains the research prototype for the ConfD project and the following publications:

ConfD

ConfD analyzes configuration dependencies of file systems. It has two main components.

  • ConfD-core
  • ConfD-plugins

The description of each component is as follows:

ConfD-core

ConfD-core has three components:

  • Taint Analyzer:

    • Source code in ConfD-core/Taint Analyzer/
    • Generates the taint traces for configuratin parameters

  • Dependency Analyzer:

    • Source code in ConfD-core/Dependency Analyzer/
    • Generates the dependency information for the configuration parameters

  • State Generator:

    • Source code in ConfD-core/State Generator/
    • Generates dependency-guided configuration states based on the dependency information of the configuration parameters

ConfD-plugins

Currently ConfD has six plugins:

  • Plugin#1: ConfD-specCk

    • Source code in ConfD-plugins/Plugin#1:ConfD-specCk/
    • Automatically extracts dependency information from linux man-pages and compares with dependencies extracted from ConfD-core to check inconsistency

  • Plugin#2: ConfD-handlingCk

    • Source code in ConfD-plugins/Plugin#2:ConfD-handlingCk/
    • Checks handling of (mis)configuration

  • Plugin#3: ConfD-rfsck

    • Source code in ConfD-plugins/Plugin#2:ConfD-rfsck/
    • Leverages the dependency-guided configuration states for rfsck

  • Plugin#4: ConfD-gt-hydra

    • Source code in ConfD-plugins/Plugin#2:ConfD-gt-hydra/
    • Leverages the dependency-guided configuration states for gt-hydra

  • Plugin#5: ConfD-xfstests

    • Source code in ConfD-plugins/Plugin#2:ConfD-xfstests/
    • Replaces configuration states of the test cases in xfstests to increase configuration coverage and identify failed cases

  • Plugin#6: ConfD-e2fsprogs

    • Source code in ConfD-plugins/Plugin#2:ConfD-e2fsprogs/
    • Replaces configuration states of the test cases in e2fsprogs to increase configuration coverage and identify failed cases

System Requirements

ConfD requires Ubuntu 20.04 and LLVM-14.0.0

ConfD requires Ubuntu 20.04 and LLVM-14.0.0 (make)

ConfD requires Ubuntu 20.04 and LLVM-16.0.0

ConfD requires MacOS(M2)/UNIX and LLVM-16.0.0

Setup

For LLVM-14.0.0 and Ubuntu 20.04

Setting up LLVM

cd ConfD-core/Taint Analyzer/

make sure the input json file is in the directory as "mke2fs_constraints.json"

wget https://github.com/llvm/llvm-project/archive/refs/tags/llvmorg-14.0.0.zip

unzip llvm-project-llvmorg-14.0.0.zip

mkdir llvm-project-llvmorg-14.0.0/llvm/lib/Transforms/interPro/

cp interPro.cpp interPro.h CmakeLists.txt llvm-project-llvmorg-14.0.0/llvm/lib/Transforms/interPro/

cp -r ../dependency Analyzer/trace_analyzer llvm-project-llvmorg-14.0.0/llvm/lib/Transforms/

Add the following lines to ../CMakeLists.txt file

add_subdirectory(interPro)

add_subdirectory(trace_analyzer)

mkdir llvm-project-llvmorg-14.0.0/build/

cmake --build . -j48

cd llvm-project-llvmorg-14.0.0/build/

For LLVM-14.0.0 (make) and Ubuntu 20.04

wget https://github.com//llvm/llvm-project/archive/refs/tags/llvmorg-14.0.0.zip
unzip llvmorg-14.0.0.zip
cd llvm-project-llvmorg-14.0.0
cmake -S llvm -B build -G "Unix Makefiles" -DLLVM_ENABLE_PROJECTS="clang" -DLLVM_ENABLE_RUNTIMES="libcxx;libcxxabi"
cd build 
make clang -j48
cmake --build . -j48

For LLVM-16.0.0 and Ubuntu 20.04

Setting up LLVM

Download llvm 16 source code
Or wget https://github.com/llvm/llvm-project/archive/refs/tags/llvmorg-16.0.0.zip

Then

cd llvm-project-llvmorg-16.0.0
mkdir build
cd build

cmake -S llvm -B build -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr/local/llvm -G "Ninja" -DLLVM_USE_LINKER="gold" -DLLVM_ENABLE_PROJECTS="clang;clang-tools-extra;lld;lldb" -DLLVM_ENABLE_RUNTIMES="libc;compiler-rt;libcxx;libcxxabi;libunwind"

ninja

Set Environment Variable

vi ~/.bashrc

export PATH=YourPath/llvm-project-llvmorg-16.0.0/build/bin:$PATH

source ~/.bashrc

For LLVM-16.0.0 and MacOS(M2)/UNIX

Setting up LLVM

Download llvm 16 source code
Or wget https://github.com/llvm/llvm-project/archive/refs/tags/llvmorg-16.0.0.zip

Then

cd llvm-project-llvmorg-16.0.0
mkdir build
cd build

cmake -G Ninja -DLLVM_ENABLE_PROJECTS="clang;mlir;" -DLLVM_BUILD_EXAMPLES=ON -DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_ASSERTIONS=On -DDEFAULT_SYSROOT=/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk ../llvm

ninja -j32

Set Environment Variable

vi ~/.zshrc

export PATH=YouPath/llvm-project-llvmorg-16.0.0/build/bin:$PATH

source ~/.zshrc

Generating LLVM-IR using clang

Use clang to generate the LLVM-IR of the target program enabling debug information and "-fno-discard-value-names" CFLAG

Generating taint traces

cd ../../

python3 separate_objects.py

Generating dependency information

cd ConfD-core/Dependency Analyzer

python3 phase1.py *path to all the generated taint traces*

For example, python3 phase1.py resize_inode meta_bg

Store all the newly generated files to dependecy/ directory

python3 phase2.py

To see how to run each plugins, please refer to individual directories for the plugins.

Citing ConfD

If you cite ConfD in your research, please you following BibTeX entry:

    @inproceedings {mahmud2023confd,
      author = {Tabassum Mahmud and Om Rameshwar Gatla and Duo Zhang and Carson Love and Ryan Bumann and Mai Zheng},
      title = {{ConfD}: Analyzing Configuration Dependencies of File Systems for Fun and Profit},
      booktitle = {21st USENIX Conference on File and Storage Technologies (FAST 23)},
      year = {2023},
      isbn = {978-1-939133-32-8},
      address = {Santa Clara, CA},
      pages = {199--214},
      url = {https://www.usenix.org/conference/fast23/presentation/mahmud},
      publisher = {USENIX Association},
      month = feb,
    }

Contact

Tabassum Mahmud (tmahmud@iastate.edu)