[ { "path": ".clang-format", "content": "---\nLanguage: Cpp\n# BasedOnStyle: LLVM\nAccessModifierOffset: -2\nAlignAfterOpenBracket: Align\nAlignConsecutiveMacros: false\nAlignConsecutiveAssignments: false\nAlignConsecutiveBitFields: false\nAlignConsecutiveDeclarations: false\nAlignEscapedNewlines: Right\nAlignOperands: Align\nAlignTrailingComments: true\nAllowAllArgumentsOnNextLine: true\nAllowAllConstructorInitializersOnNextLine: true\nAllowAllParametersOfDeclarationOnNextLine: true\nAllowShortEnumsOnASingleLine: true\nAllowShortBlocksOnASingleLine: Empty\nAllowShortCaseLabelsOnASingleLine: false\nAllowShortFunctionsOnASingleLine: All\nAllowShortLambdasOnASingleLine: All\nAllowShortIfStatementsOnASingleLine: Never\nAllowShortLoopsOnASingleLine: false\nAlwaysBreakAfterDefinitionReturnType: None\nAlwaysBreakAfterReturnType: None\nAlwaysBreakBeforeMultilineStrings: false\nAlwaysBreakTemplateDeclarations: Yes\nBinPackArguments: true\nBinPackParameters: true\nBraceWrapping:\n AfterCaseLabel: false\n AfterClass: false\n AfterControlStatement: Never\n AfterEnum: false\n AfterFunction: false\n AfterNamespace: false\n AfterObjCDeclaration: false\n AfterStruct: false\n AfterUnion: false\n AfterExternBlock: false\n BeforeCatch: false\n BeforeElse: false\n BeforeLambdaBody: false\n BeforeWhile: false\n IndentBraces: false\n SplitEmptyFunction: true\n SplitEmptyRecord: true\n SplitEmptyNamespace: true\nBreakBeforeBinaryOperators: None\nBreakBeforeBraces: Attach\nBreakBeforeInheritanceComma: false\nBreakInheritanceList: BeforeColon\nBreakBeforeTernaryOperators: true\nBreakConstructorInitializersBeforeComma: false\nBreakConstructorInitializers: BeforeColon\nBreakAfterJavaFieldAnnotations: false\nBreakStringLiterals: true\nColumnLimit: 80\nCompactNamespaces: false\nConstructorInitializerAllOnOneLineOrOnePerLine: false\nConstructorInitializerIndentWidth: 8\nContinuationIndentWidth: 8\nCpp11BracedListStyle: true\nDeriveLineEnding: false\nDerivePointerAlignment: false\nDisableFormat: false\nFixNamespaceComments: true\nForEachMacros:\n - foreach\n - Q_FOREACH\n - BOOST_FOREACH\nIncludeBlocks: Preserve\nIndentCaseLabels: false\nIndentCaseBlocks: false\nIndentGotoLabels: false\nIndentPPDirectives: None\nIndentExternBlock: AfterExternBlock\nIndentWidth: 4\nIndentWrappedFunctionNames: false\nInsertTrailingCommas: None\nJavaScriptQuotes: Leave\nJavaScriptWrapImports: true\nKeepEmptyLinesAtTheStartOfBlocks: false\nMacroBlockBegin: ''\nMacroBlockEnd: ''\nMaxEmptyLinesToKeep: 1\nNamespaceIndentation: None\nObjCBinPackProtocolList: Auto\nObjCBlockIndentWidth: 2\nObjCBreakBeforeNestedBlockParam: true\nObjCSpaceAfterProperty: false\nObjCSpaceBeforeProtocolList: true\nPenaltyBreakAssignment: 2\nPenaltyBreakBeforeFirstCallParameter: 19\nPenaltyBreakComment: 300\nPenaltyBreakFirstLessLess: 120\nPenaltyBreakString: 1000\nPenaltyBreakTemplateDeclaration: 10\nPenaltyExcessCharacter: 1000000\nPenaltyReturnTypeOnItsOwnLine: 60\nPointerAlignment: Right\nReflowComments: true\nSortIncludes: true\nSortUsingDeclarations: true\nSpaceAfterCStyleCast: true\nSpaceAfterLogicalNot: false\nSpaceAfterTemplateKeyword: true\nSpaceBeforeAssignmentOperators: true\nSpaceBeforeCpp11BracedList: false\nSpaceBeforeCtorInitializerColon: true\nSpaceBeforeInheritanceColon: true\nSpaceBeforeParens: ControlStatements\nSpaceBeforeRangeBasedForLoopColon: true\nSpaceInEmptyBlock: false\nSpaceInEmptyParentheses: false\nSpacesBeforeTrailingComments: 1\nSpacesInAngles: false\nSpacesInConditionalStatement: false\nSpacesInContainerLiterals: true\nSpacesInCStyleCastParentheses: false\nSpacesInParentheses: false\nSpacesInSquareBrackets: false\nSpaceBeforeSquareBrackets: false\nStandard: Latest\nTabWidth: 8\nUseCRLF: false\nUseTab: Never\n...\n" }, { "path": ".clang-tidy", "content": "---\n# vim: syntax=yaml\n# we might want to enable llvm-namespace-comment in the future\nChecks: 'clang-diagnostic-*,clang-analyzer-*,modernize-*,-modernize-use-auto,-modernize-use-trailing-return-type,bugprone-*,llvm-*,-llvm-header-guard,-llvm-namespace-comment,misc-misplaced-const,misc-non-copyable-objects,misc-redundant-expression,misc-static-assert,misc-throw-by-value-catch-by-reference,misc-unconventional-assign-operator,misc-uniqueptr-reset-release,performace-*,readability-*,-readability-isolate-declaration,-readability-braces-around-statements,-readability-implicit-bool-conversion,-readability-static-accessed-through-instance,-readability-identifier-length'\nWarningsAsErrors: ''\nHeaderFilterRegex: 'include/|lib/|tools/'\nAnalyzeTemporaryDtors: false\nFormatStyle: file\nCheckOptions:\n - key: bugprone-argument-comment.CommentBoolLiterals\n value: '0'\n - key: bugprone-argument-comment.CommentCharacterLiterals\n value: '0'\n - key: bugprone-argument-comment.CommentFloatLiterals\n value: '0'\n - key: bugprone-argument-comment.CommentIntegerLiterals\n value: '0'\n - key: bugprone-argument-comment.CommentNullPtrs\n value: '0'\n - key: bugprone-argument-comment.CommentStringLiterals\n value: '0'\n - key: bugprone-argument-comment.CommentUserDefinedLiterals\n value: '0'\n - key: bugprone-argument-comment.IgnoreSingleArgument\n value: '0'\n - key: bugprone-argument-comment.StrictMode\n value: '0'\n - key: bugprone-assert-side-effect.AssertMacros\n value: assert\n - key: bugprone-assert-side-effect.CheckFunctionCalls\n value: 'false'\n - key: bugprone-dangling-handle.HandleClasses\n value: 'std::basic_string_view;std::experimental::basic_string_view'\n - key: bugprone-dynamic-static-initializers.HeaderFileExtensions\n value: ';h;hh;hpp;hxx'\n - key: bugprone-exception-escape.FunctionsThatShouldNotThrow\n value: ''\n - key: bugprone-exception-escape.IgnoredExceptions\n value: ''\n - key: bugprone-misplaced-widening-cast.CheckImplicitCasts\n value: 'false'\n - key: bugprone-narrowing-conversions.PedanticMode\n value: 'false'\n - key: bugprone-narrowing-conversions.WarnOnFloatingPointNarrowingConversion\n value: 'true'\n - key: bugprone-not-null-terminated-result.WantToUseSafeFunctions\n value: 'true'\n - key: bugprone-reserved-identifier.AggressiveDependentMemberLookup\n value: 'false'\n - key: bugprone-reserved-identifier.AllowedIdentifiers\n value: ''\n - key: bugprone-reserved-identifier.Invert\n value: 'false'\n - key: bugprone-signed-char-misuse.CharTypdefsToIgnore\n value: ''\n - key: bugprone-signed-char-misuse.DiagnoseSignedUnsignedCharComparisons\n value: 'true'\n - key: bugprone-sizeof-expression.WarnOnSizeOfCompareToConstant\n value: 'true'\n - key: bugprone-sizeof-expression.WarnOnSizeOfConstant\n value: 'true'\n - key: bugprone-sizeof-expression.WarnOnSizeOfIntegerExpression\n value: 'false'\n - key: bugprone-sizeof-expression.WarnOnSizeOfThis\n value: 'true'\n - key: bugprone-string-constructor.LargeLengthThreshold\n value: '8388608'\n - key: bugprone-string-constructor.WarnOnLargeLength\n value: 'true'\n - key: bugprone-suspicious-enum-usage.StrictMode\n value: 'false'\n - key: bugprone-suspicious-include.HeaderFileExtensions\n value: ';h;hh;hpp;hxx'\n - key: bugprone-suspicious-include.ImplementationFileExtensions\n value: 'c;cc;cpp;cxx'\n - key: bugprone-suspicious-missing-comma.MaxConcatenatedTokens\n value: '5'\n - key: bugprone-suspicious-missing-comma.RatioThreshold\n value: '0.200000'\n - key: bugprone-suspicious-missing-comma.SizeThreshold\n value: '5'\n - key: bugprone-suspicious-string-compare.StringCompareLikeFunctions\n value: ''\n - key: bugprone-suspicious-string-compare.WarnOnImplicitComparison\n value: 'true'\n - key: bugprone-suspicious-string-compare.WarnOnLogicalNotComparison\n value: 'false'\n - key: bugprone-too-small-loop-variable.MagnitudeBitsUpperLimit\n value: '16'\n - key: bugprone-unhandled-self-assignment.WarnOnlyIfThisHasSuspiciousField\n value: 'true'\n - key: bugprone-unused-return-value.CheckedFunctions\n value: '::std::async;::std::launder;::std::remove;::std::remove_if;::std::unique;::std::unique_ptr::release;::std::basic_string::empty;::std::vector::empty;::std::back_inserter;::std::distance;::std::find;::std::find_if;::std::inserter;::std::lower_bound;::std::make_pair;::std::map::count;::std::map::find;::std::map::lower_bound;::std::multimap::equal_range;::std::multimap::upper_bound;::std::set::count;::std::set::find;::std::setfill;::std::setprecision;::std::setw;::std::upper_bound;::std::vector::at;::bsearch;::ferror;::feof;::isalnum;::isalpha;::isblank;::iscntrl;::isdigit;::isgraph;::islower;::isprint;::ispunct;::isspace;::isupper;::iswalnum;::iswprint;::iswspace;::isxdigit;::memchr;::memcmp;::strcmp;::strcoll;::strncmp;::strpbrk;::strrchr;::strspn;::strstr;::wcscmp;::access;::bind;::connect;::difftime;::dlsym;::fnmatch;::getaddrinfo;::getopt;::htonl;::htons;::iconv_open;::inet_addr;::isascii;::isatty;::mmap;::newlocale;::openat;::pathconf;::pthread_equal;::pthread_getspecific;::pthread_mutex_trylock;::readdir;::readlink;::recvmsg;::regexec;::scandir;::semget;::setjmp;::shm_open;::shmget;::sigismember;::strcasecmp;::strsignal;::ttyname'\n - key: cert-dcl16-c.NewSuffixes\n value: 'L;LL;LU;LLU'\n - key: cert-oop54-cpp.WarnOnlyIfThisHasSuspiciousField\n value: '0'\n - key: cert-str34-c.DiagnoseSignedUnsignedCharComparisons\n value: '0'\n - key: cppcoreguidelines-explicit-virtual-functions.IgnoreDestructors\n value: '1'\n - key: cppcoreguidelines-non-private-member-variables-in-classes.IgnoreClassesWithAllMemberVariablesBeingPublic\n value: '1'\n - key: google-readability-braces-around-statements.ShortStatementLines\n value: '1'\n - key: google-readability-function-size.StatementThreshold\n value: '800'\n - key: google-readability-namespace-comments.ShortNamespaceLines\n value: '10'\n - key: google-readability-namespace-comments.SpacesBeforeComments\n value: '2'\n - key: llvm-else-after-return.WarnOnConditionVariables\n value: 'false'\n - key: llvm-else-after-return.WarnOnUnfixable\n value: 'false'\n - key: llvm-header-guard.HeaderFileExtensions\n value: ';h;hh;hpp;hxx'\n - key: llvm-namespace-comment.ShortNamespaceLines\n value: '1'\n - key: llvm-namespace-comment.SpacesBeforeComments\n value: '1'\n - key: llvm-qualified-auto.AddConstToQualified\n value: 'false'\n - key: misc-non-private-member-variables-in-classes.IgnoreClassesWithAllMemberVariablesBeingPublic\n value: 'false'\n - key: misc-non-private-member-variables-in-classes.IgnorePublicMemberVariables\n value: 'false'\n - key: misc-throw-by-value-catch-by-reference.CheckThrowTemporaries\n value: 'true'\n - key: misc-throw-by-value-catch-by-reference.WarnOnLargeObjects\n value: 'false'\n - key: modernize-avoid-bind.PermissiveParameterList\n value: 'false'\n - key: modernize-loop-convert.MaxCopySize\n value: '16'\n - key: modernize-loop-convert.MinConfidence\n value: reasonable\n - key: modernize-loop-convert.NamingStyle\n value: CamelCase\n - key: modernize-make-shared.IgnoreMacros\n value: 'true'\n - key: modernize-make-shared.IncludeStyle\n value: llvm\n - key: modernize-make-shared.MakeSmartPtrFunction\n value: 'std::make_shared'\n - key: modernize-make-shared.MakeSmartPtrFunctionHeader\n value: memory\n - key: modernize-make-unique.IgnoreMacros\n value: 'true'\n - key: modernize-make-unique.IncludeStyle\n value: llvm\n - key: modernize-make-unique.MakeSmartPtrFunction\n value: 'std::make_unique'\n - key: modernize-make-unique.MakeSmartPtrFunctionHeader\n value: memory\n - key: modernize-pass-by-value.IncludeStyle\n value: llvm\n - key: modernize-pass-by-value.ValuesOnly\n value: 'false'\n - key: modernize-raw-string-literal.DelimiterStem\n value: lit\n - key: modernize-raw-string-literal.ReplaceShorterLiterals\n value: 'false'\n - key: modernize-replace-auto-ptr.IncludeStyle\n value: llvm\n - key: modernize-replace-disallow-copy-and-assign-macro.MacroName\n value: DISALLOW_COPY_AND_ASSIGN\n - key: modernize-replace-random-shuffle.IncludeStyle\n value: llvm\n - key: modernize-use-bool-literals.IgnoreMacros\n value: 'true'\n - key: modernize-use-default-member-init.IgnoreMacros\n value: 'true'\n - key: modernize-use-default-member-init.UseAssignment\n value: 'false'\n - key: modernize-use-emplace.ContainersWithPushBack\n value: '::std::vector;::std::list;::std::deque'\n - key: modernize-use-emplace.IgnoreImplicitConstructors\n value: 'false'\n - key: modernize-use-emplace.SmartPointers\n value: '::std::shared_ptr;::std::unique_ptr;::std::auto_ptr;::std::weak_ptr'\n - key: modernize-use-emplace.TupleMakeFunctions\n value: '::std::make_pair;::std::make_tuple'\n - key: modernize-use-emplace.TupleTypes\n value: '::std::pair;::std::tuple'\n - key: modernize-use-equals-default.IgnoreMacros\n value: 'true'\n - key: modernize-use-equals-delete.IgnoreMacros\n value: 'true'\n - key: modernize-use-nodiscard.ReplacementString\n value: '[[nodiscard]]'\n - key: modernize-use-noexcept.ReplacementString\n value: ''\n - key: modernize-use-noexcept.UseNoexceptFalse\n value: 'true'\n - key: modernize-use-nullptr.NullMacros\n value: 'NULL'\n - key: modernize-use-override.AllowOverrideAndFinal\n value: 'false'\n - key: modernize-use-override.FinalSpelling\n value: final\n - key: modernize-use-override.IgnoreDestructors\n value: 'false'\n - key: modernize-use-override.OverrideSpelling\n value: override\n - key: modernize-use-transparent-functors.SafeMode\n value: 'false'\n - key: modernize-use-using.IgnoreMacros\n value: 'true'\n - key: readability-braces-around-statements.ShortStatementLines\n value: '0'\n - key: readability-else-after-return.WarnOnConditionVariables\n value: 'true'\n - key: readability-else-after-return.WarnOnUnfixable\n value: 'true'\n - key: readability-function-size.BranchThreshold\n value: '4294967295'\n - key: readability-function-size.LineThreshold\n value: '4294967295'\n - key: readability-function-size.NestingThreshold\n value: '4294967295'\n - key: readability-function-size.ParameterThreshold\n value: '4294967295'\n - key: readability-function-size.StatementThreshold\n value: '800'\n - key: readability-function-size.VariableThreshold\n value: '4294967295'\n - key: readability-identifier-naming.AggressiveDependentMemberLookup\n value: 'false'\n - key: readability-identifier-naming.IgnoreFailedSplit\n value: 'false'\n - key: readability-identifier-naming.IgnoreMainLikeFunctions\n value: 'false'\n - key: readability-implicit-bool-conversion.AllowIntegerConditions\n value: 'true'\n - key: readability-implicit-bool-conversion.AllowPointerConditions\n value: 'true'\n - key: readability-inconsistent-declaration-parameter-name.IgnoreMacros\n value: 'true'\n - key: readability-inconsistent-declaration-parameter-name.Strict\n value: 'false'\n - key: readability-magic-numbers.IgnoreAllFloatingPointValues\n value: 'false'\n - key: readability-magic-numbers.IgnoreBitFieldsWidths\n value: 'true'\n - key: readability-magic-numbers.IgnorePowersOf2IntegerValues\n value: 'false'\n - key: readability-magic-numbers.IgnoredFloatingPointValues\n value: '1.0;100.0;'\n - key: readability-magic-numbers.IgnoredIntegerValues\n value: '1;2;3;4;'\n - key: readability-qualified-auto.AddConstToQualified\n value: 'true'\n - key: readability-redundant-declaration.IgnoreMacros\n value: 'true'\n - key: readability-redundant-member-init.IgnoreBaseInCopyConstructors\n value: 'false'\n - key: readability-redundant-smartptr-get.IgnoreMacros\n value: 'true'\n - key: readability-redundant-string-init.StringNames\n value: '::std::basic_string'\n - key: readability-simplify-boolean-expr.ChainedConditionalAssignment\n value: 'false'\n - key: readability-simplify-boolean-expr.ChainedConditionalReturn\n value: 'false'\n - key: readability-simplify-subscript-expr.Types\n value: '::std::basic_string;::std::basic_string_view;::std::vector;::std::array'\n - key: readability-static-accessed-through-instance.NameSpecifierNestingThreshold\n value: '3'\n - key: readability-uppercase-literal-suffix.IgnoreMacros\n value: 'true'\n - key: readability-uppercase-literal-suffix.NewSuffixes\n value: ''\n...\n" }, { "path": ".git-blame-ignore-revs", "content": "# Reformat the whole project\n2e60545c73a872b95d3c32a097e351ed9bfd8bf6\na69378f4f29a63d28cb79e0d6728d069353b19c8\n" }, { "path": ".github/workflows/clang-format.yml", "content": "---\nname: Find unformatted files\n\non: [push, pull_request]\n\njobs:\n Format:\n name: Find unformatted files\n runs-on: ubuntu-22.04\n steps:\n - name: Checkout DG\n uses: actions/checkout@v3\n\n - name: Install clang-format 14\n run: |\n sudo apt install clang-format-14\n\n - name: Find unformatted files\n # Based on https://rigtorp.se/notes/clang-format/.\n run: |\n set -o pipefail\n find . -regextype posix-extended \\\n -iregex '\\./(include|lib|tests|tools)/.*\\.(h|c|cpp|hpp)' \\\n -o -iregex '\\./tests/catch2' -prune -type f | \\\n xargs clang-format-14 --style=file --dry-run -Werror --color=true\n" }, { "path": ".github/workflows/docker.yml", "content": "---\nname: Docker Image\n\non:\n [push, pull_request]\n\njobs:\n Docker:\n runs-on: ubuntu-latest\n steps:\n - name: Checkout DG\n uses: actions/checkout@v3\n\n - name: Build the Docker image\n run: |\n docker build . --file Dockerfile \\\n --build-arg GIT_REF=$GITHUB_REF \\\n --build-arg GIT_REPO=$GITHUB_REPOSITORY \\\n --tag dg:$(date +%s)\n" }, { "path": ".github/workflows/hash_map.yml", "content": "---\nname: DG + External Hash Maps\non: [push, pull_request]\n\njobs:\n Ubuntu:\n strategy:\n fail-fast: false\n matrix:\n os: [ubuntu-20.04]\n compiler: [gcc, clang]\n hashmap: [tsl-hopscotch]\n\n runs-on: ${{matrix.os}}\n env:\n # for colours in ninja\n CLICOLOR_FORCE: 1\n\n steps:\n - name: Checkout DG\n uses: actions/checkout@v3\n\n - name: Checkout TSL Hopscotch\n uses: actions/checkout@v3\n with:\n repository: Tessil/hopscotch-map\n path: tsl-hopscotch\n\n - name: Install dependencies\n run: |\n sudo apt update\n sudo apt install ccache cmake ninja-build clang-10 llvm-10-dev\n\n - name: Set environment\n id: env\n run: |\n # set expected name of selected hashmap\n case \"${{matrix.hashmap}}\" in\n \"tsl-hopscotch\") echo \"HASHMAP=TSL_HOPSCOTCH_DIR\" >> $GITHUB_ENV;;\n *) echo \"Unknown hashmap selected.\" && exit 1;;\n esac\n\n if [[ \"${{matrix.compiler}}\" = \"clang\" ]]; then\n echo \"CC=clang-10\" >> $GITHUB_ENV\n echo \"CXX=clang++-10\" >> $GITHUB_ENV\n\n # force coloured output\n echo \"CFLAGS=$CFLAGS -fcolor-diagnostics\" >> $GITHUB_ENV\n echo \"CXXFLAGS=$CXXFLAGS -fcolor-diagnostics\" >> $GITHUB_ENV\n else\n echo \"CC=gcc\" >> $GITHUB_ENV\n echo \"CXX=g++\" >> $GITHUB_ENV\n\n # force coloured output\n echo \"CFLAGS=$CFLAGS -fdiagnostics-color=always\" >> $GITHUB_ENV\n echo \"CXXFLAGS=$CXXFLAGS -fdiagnostics-color=always\" >> $GITHUB_ENV\n fi\n\n # set up ccache\n sudo /usr/sbin/update-ccache-symlinks\n echo \"/usr/lib/ccache\" >> $GITHUB_PATH\n\n echo \"CCACHE_BASEDIR=$GITHUB_WORKSPACE\" >> $GITHUB_ENV\n echo \"CCACHE_DIR=$GITHUB_WORKSPACE/.ccache\" >> $GITHUB_ENV\n echo \"CCACHE_COMPRESS=true\" >> $GITHUB_ENV\n echo \"CCACHE_COMPRESSLEVEL=6\" >> $GITHUB_ENV\n echo \"CCACHE_MAXSIZE=400M\" >> $GITHUB_ENV\n\n echo \"::set-output name=timestamp::$(date -u -Iseconds)\"\n\n - name: Set up ccache\n uses: actions/cache@v3\n with:\n path: .ccache\n key: ${{matrix.os}}-${{matrix.hashmap}}-${{matrix.compiler}}-${{steps.env.outputs.timestamp}}\n restore-keys: ${{matrix.os}}-${{matrix.hashmap}}-${{matrix.compiler}}\n\n - name: Configure CMake project\n run: |\n cmake -S. \\\n -B_build \\\n -GNinja \\\n -DUSE_SANITIZERS:BOOL=ON \\\n -DLLVM_DIR:PATH=\"$(llvm-config-10 --cmakedir)\" \\\n -D${HASHMAP}:PATH=\"$GITHUB_WORKSPACE/${{matrix.hashmap}}\"\n\n - name: Build\n run: cmake --build _build\n\n - name: Run tests\n # TODO: turn off the detection of leaks, we're working on it\n run: ASAN_OPTIONS=detect_leaks=0 cmake --build _build --target check\n\n - name: ccache statistics\n run: ccache -s\n" }, { "path": ".github/workflows/linux.yml", "content": "---\nname: Linux CI\non: [push, pull_request]\n\njobs:\n build64:\n name: Ubuntu 64-bit\n strategy:\n fail-fast: false\n matrix:\n include:\n # Linux with GCC\n - {os: ubuntu-18.04, llvm: '3.9', compiler: gcc}\n - {os: ubuntu-18.04, llvm: '4.0', compiler: gcc}\n - {os: ubuntu-18.04, llvm: '5.0', compiler: gcc}\n - {os: ubuntu-18.04, llvm: '6.0', compiler: gcc}\n - {os: ubuntu-18.04, llvm: 7, compiler: gcc}\n - {os: ubuntu-18.04, llvm: 8, compiler: gcc}\n - {os: ubuntu-18.04, llvm: 9, compiler: gcc}\n - {os: ubuntu-20.04, llvm: 10, compiler: gcc}\n - {os: ubuntu-20.04, llvm: 11, compiler: gcc}\n - {os: ubuntu-20.04, llvm: 12, compiler: gcc}\n - {os: ubuntu-22.04, llvm: 13, compiler: gcc}\n - {os: ubuntu-22.04, llvm: 14, compiler: gcc}\n - {os: ubuntu-22.04, llvm: 14, compiler: gcc, type: Debug}\n\n # Linux with Clang\n - {os: ubuntu-18.04, llvm: '3.9', compiler: clang}\n - {os: ubuntu-18.04, llvm: '4.0', compiler: clang}\n - {os: ubuntu-18.04, llvm: '5.0', compiler: clang}\n - {os: ubuntu-18.04, llvm: '6.0', compiler: clang}\n - {os: ubuntu-18.04, llvm: 7, compiler: clang}\n - {os: ubuntu-18.04, llvm: 8, compiler: clang}\n - {os: ubuntu-18.04, llvm: 9, compiler: clang}\n - {os: ubuntu-20.04, llvm: 10, compiler: clang}\n - {os: ubuntu-20.04, llvm: 11, compiler: clang}\n - {os: ubuntu-20.04, llvm: 12, compiler: clang}\n - {os: ubuntu-22.04, llvm: 13, compiler: clang}\n - {os: ubuntu-22.04, llvm: 14, compiler: clang}\n - {os: ubuntu-22.04, llvm: 14, compiler: clang, type: Debug}\n\n runs-on: ${{matrix.os}}\n env:\n # for colours in ninja\n CLICOLOR_FORCE: 1\n\n steps:\n - name: Checkout DG\n uses: actions/checkout@v3\n\n - name: '[LLVM ${{matrix.llvm}}] Add repositories'\n if: matrix.llvm >= 15\n run: |\n wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key | sudo apt-key add -\n sudo apt-add-repository \"deb https://apt.llvm.org/jammy/ llvm-toolchain-jammy-${{matrix.llvm}} main\"\n\n - name: Install dependencies\n run: |\n sudo apt update\n sudo apt install ccache cmake ninja-build clang-${{matrix.llvm}} \\\n llvm-${{matrix.llvm}}-dev\n\n - name: Set environment\n id: env\n run: |\n if [[ \"${{matrix.compiler}}\" = \"clang\" ]]; then\n echo \"CC=clang-${{matrix.llvm}}\" >> $GITHUB_ENV\n echo \"CXX=clang++-${{matrix.llvm}}\" >> $GITHUB_ENV\n\n # force coloured output\n echo \"CFLAGS=$CFLAGS -fcolor-diagnostics\" >> $GITHUB_ENV\n echo \"CXXFLAGS=$CXXFLAGS -fcolor-diagnostics\" >> $GITHUB_ENV\n else\n echo \"CC=gcc\" >> $GITHUB_ENV\n echo \"CXX=g++\" >> $GITHUB_ENV\n\n # force coloured output\n echo \"CFLAGS=$CFLAGS -fdiagnostics-color=always\" >> $GITHUB_ENV\n echo \"CXXFLAGS=$CXXFLAGS -fdiagnostics-color=always\" >> $GITHUB_ENV\n fi\n\n # set up ccache\n sudo /usr/sbin/update-ccache-symlinks\n echo \"/usr/lib/ccache\" >> $GITHUB_PATH\n\n # Bionic does not create symlinks to versioned clang\n sudo ln -sfr /usr/bin/ccache /usr/lib/ccache/clang-${{matrix.llvm}}\n sudo ln -sfr /usr/bin/ccache /usr/lib/ccache/clang++-${{matrix.llvm}}\n\n echo \"CCACHE_BASEDIR=$GITHUB_WORKSPACE\" >> $GITHUB_ENV\n echo \"CCACHE_DIR=$GITHUB_WORKSPACE/.ccache\" >> $GITHUB_ENV\n echo \"CCACHE_COMPRESS=true\" >> $GITHUB_ENV\n echo \"CCACHE_COMPRESSLEVEL=6\" >> $GITHUB_ENV\n echo \"CCACHE_MAXSIZE=400M\" >> $GITHUB_ENV\n\n echo \"::set-output name=timestamp::$(date -u -Iseconds)\"\n\n - name: Set up ccache\n uses: actions/cache@v3\n with:\n path: .ccache\n key: ${{matrix.os}}-${{matrix.llvm}}-${{matrix.compiler}}-${{matrix.type}}-${{steps.env.outputs.timestamp}}\n restore-keys: ${{matrix.os}}-${{matrix.llvm}}-${{matrix.compiler}}-${{matrix.type}}\n\n - name: '[Dynamic LLVM] Configure CMake project'\n run: |\n cmake -S. \\\n -B_build \\\n -GNinja \\\n -DCMAKE_BUILD_TYPE:STRING=\"${{matrix.type}}\" \\\n -DUSE_SANITIZERS:BOOL=ON \\\n -DLLVM_DIR:PATH=\"/usr/lib/llvm-${{matrix.llvm}}/lib/cmake/llvm\"\n # llvm-config-3.9 does not take --cmakedir yet!\n\n - name: '[Dynamic LLVM] Build'\n run: cmake --build _build\n\n - name: '[Dynamic LLVM] Run tests'\n # TODO: turn off the detection of leaks, we're working on it\n run: ASAN_OPTIONS=detect_leaks=0 cmake --build _build --target check\n\n - name: '[Static LLVM] Re-configure CMake project'\n run: |\n cmake -S. \\\n -B_build \\\n -DLLVM_LINK_DYLIB:BOOL=OFF\n cmake --build _build --target clean\n\n - name: '[Static LLVM] Build'\n run: cmake --build _build\n\n - name: '[Static LLVM] Run tests'\n # TODO: turn off the detection of leaks, we're working on it\n run: ASAN_OPTIONS=detect_leaks=0 cmake --build _build --target check\n\n - name: ccache statistics\n run: ccache -s\n\n# Warning: untested and incomplete\n#\n# build32:\n# name: Ubuntu 32-bit\n# runs-on: ubuntu-20.04\n# container: ubuntu:latest\n#\n# strategy:\n# fail-fast: false\n# matrix:\n# compiler: [gcc, clang]\n# build_type: [Debug, Release]\n#\n# steps:\n# - uses: actions/checkout@v2\n# - name: Install dependencies\n# run: |\n# dpkg --add-architecture i386\n# apt update\n# apt install -y cmake ninja-build clang:i386 llvm-dev:i386 libc-dev:i386\n#\n# - name: Set environment\n# run: |\n# CFLAGS=\"$CFLAGS -m32\"\n# CXXFLAGS=\"$CXXFLAGS -m32\"\n#\n# if [[ \"${{matrix.compiler}}\" = \"clang\" ]]; then\n# echo \"CC=clang\" >> $GITHUB_ENV\n# echo \"CXX=clang++\" >> $GITHUB_ENV\n#\n# # force coloured output\n# echo \"CFLAGS=$CFLAGS -fcolor-diagnostics\" >> $GITHUB_ENV\n# echo \"CXXFLAGS=$CXXFLAGS -fcolor-diagnostics\" >> $GITHUB_ENV\n# else\n# echo \"CC=gcc\" >> $GITHUB_ENV\n# echo \"CXX=g++\" >> $GITHUB_ENV\n#\n# # force coloured output\n# echo \"CFLAGS=$CFLAGS -fdiagnostics-color\" >> $GITHUB_ENV\n# echo \"CXXFLAGS=$CXXFLAGS -fdiagnostics-color\" >> $GITHUB_ENV\n# fi\n#\n# - name: Configure CMake project\n# run: |\n# cmake -Bbuild -S. \\\n# -GNinja \\\n# -DUSE_SANITIZERS=ON \\\n# -DCMAKE_BUILD_TYPE='${{matrix.build_type}}'\n#\n# - name: Build\n# run: ninja -C build\n#\n# - name: Run tests\n# # TODO: turn off the detection of leaks, we're working on it\n# run: ASAN_OPTIONS=detect_leaks=0 ninja check -C build\n" }, { "path": ".github/workflows/mac.yml", "content": "---\nname: macOS CI\non: [push, pull_request]\n\njobs:\n build:\n name: macOS\n strategy:\n fail-fast: false\n matrix:\n os: [macos-12]\n build: [Debug, RelWithDebInfo]\n\n runs-on: ${{matrix.os}}\n env:\n # for colours in ninja\n CLICOLOR_FORCE: 1\n\n steps:\n - name: Checkout DG\n uses: actions/checkout@v3\n\n - name: Install dependencies\n run: brew install ninja ccache llvm@14\n\n - name: Set environment\n id: env\n run: |\n echo \"CCACHE_BASEDIR=$GITHUB_WORKSPACE\" >> $GITHUB_ENV\n echo \"CCACHE_DIR=$GITHUB_WORKSPACE/.ccache\" >> $GITHUB_ENV\n echo \"CCACHE_COMPRESS=true\" >> $GITHUB_ENV\n echo \"CCACHE_COMPRESSLEVEL=6\" >> $GITHUB_ENV\n echo \"CCACHE_MAXSIZE=400M\" >> $GITHUB_ENV\n\n echo \"/usr/local/opt/ccache/libexec\" >> $GITHUB_PATH\n\n echo \"::set-output name=timestamp::$(date -u +%Y-%m-%dT%H:%M:%S%z)\"\n\n - name: Set-up ccache\n uses: actions/cache@v3\n with:\n path: .ccache\n key: ${{matrix.os}}-${{matrix.build}}-${{steps.env.outputs.timestamp}}\n restore-keys: ${{matrix.os}}-${{matrix.build}}\n\n - name: Configure CMake project\n run: |\n cmake -S. \\\n -B_build \\\n -GNinja \\\n -DCMAKE_BUILD_TYPE:STRING=${{matrix.build}} \\\n -DUSE_SANITIZERS:BOOL=ON \\\n -DLLVM_DIR:PATH=\"$($(brew --prefix llvm@14)/bin/llvm-config --cmakedir)\"\n env:\n # for coloured output\n CFLAGS: -fcolor-diagnostics\n CXXFLAGS: -fcolor-diagnostics\n\n - name: Build\n run: cmake --build _build\n\n - name: Run tests\n # TODO: turn off the detection of leaks, we're working on it\n run: ASAN_OPTIONS=detect_leaks=0 cmake --build _build --target check\n\n - name: ccache statistics\n run: ccache -s\n" }, { "path": ".github/workflows/svf.yml", "content": "---\nname: DG + SVF\non: [push, pull_request]\n\njobs:\n Ubuntu:\n strategy:\n fail-fast: false\n matrix:\n os: [ubuntu-22.04]\n compiler: [gcc, clang]\n\n runs-on: ${{matrix.os}}\n env:\n # for colours in ninja\n CLICOLOR_FORCE: 1\n\n steps:\n - name: Checkout DG\n uses: actions/checkout@v3\n\n - name: Checkout SVF\n uses: actions/checkout@v3\n with:\n ref: SVF-2.4\n repository: SVF-tools/SVF\n path: svf\n\n - name: Checkout SVF test-suite\n uses: actions/checkout@v3\n with:\n # ref corresponding to the SVF ref above\n ref: 2338ede904c1f46293b64ccf32feb09b3904401f\n repository: SVF-tools/Test-Suite\n path: svf/Test-Suite\n\n - name: Install dependencies\n run: |\n sudo apt update\n sudo apt install ccache cmake ninja-build clang-13 llvm-13-dev \\\n libz3-dev\n\n - name: Set environment\n id: env\n run: |\n if [[ \"${{matrix.compiler}}\" = \"clang\" ]]; then\n echo \"CC=clang-13\" >> $GITHUB_ENV\n echo \"CXX=clang++-13\" >> $GITHUB_ENV\n\n # force coloured output\n echo \"CFLAGS=$CFLAGS -fcolor-diagnostics\" >> $GITHUB_ENV\n echo \"CXXFLAGS=$CXXFLAGS -fcolor-diagnostics\" >> $GITHUB_ENV\n else\n echo \"CC=gcc\" >> $GITHUB_ENV\n echo \"CXX=g++\" >> $GITHUB_ENV\n\n # force coloured output\n echo \"CFLAGS=$CFLAGS -fdiagnostics-color=always\" >> $GITHUB_ENV\n echo \"CXXFLAGS=$CXXFLAGS -fdiagnostics-color=always\" >> $GITHUB_ENV\n fi\n\n # set up ccache\n sudo /usr/sbin/update-ccache-symlinks\n echo \"/usr/lib/ccache\" >> $GITHUB_PATH\n\n echo \"CCACHE_BASEDIR=$GITHUB_WORKSPACE\" >> $GITHUB_ENV\n echo \"CCACHE_DIR=$GITHUB_WORKSPACE/.ccache\" >> $GITHUB_ENV\n echo \"CCACHE_COMPRESS=true\" >> $GITHUB_ENV\n echo \"CCACHE_COMPRESSLEVEL=6\" >> $GITHUB_ENV\n echo \"CCACHE_MAXSIZE=400M\" >> $GITHUB_ENV\n\n echo \"::set-output name=timestamp::$(date -u -Iseconds)\"\n\n - name: Set up ccache\n uses: actions/cache@v3\n with:\n path: .ccache\n key: ${{matrix.os}}-svf-${{matrix.compiler}}-${{steps.env.outputs.timestamp}}\n restore-keys: ${{matrix.os}}-svf-${{matrix.compiler}}\n\n - name: Build SVF\n run: |\n # Build directory name format is hard-coded in SVF tests...\n\n # do not build with -Werror (needed for GCC 11.2.0)\n sed -i 's/-Werror//' svf/CMakeLists.txt\n\n # WARNING: DO NOT SET CMAKE_BUILD_TYPE! (except Debug)\n # SVF expects that NDEBUG will never be defined!\n cmake -Ssvf \\\n -Bsvf/Release-build \\\n -GNinja \\\n -DLLVM_DIR:PATH=\"$(llvm-config-13 --cmakedir)\"\n\n cmake --build svf/Release-build\n (cd svf/Release-build && \\\n PATH=\"$(llvm-config-13 --bindir):$PATH\" \\\n ctest --progress --output-on-failure)\n\n - name: '[Dynamic LLVM] Configure CMake project'\n run: |\n cmake -S. \\\n -B_build \\\n -GNinja \\\n -DUSE_SANITIZERS:BOOL=ON \\\n -DLLVM_DIR:PATH=\"$(llvm-config-13 --cmakedir)\" \\\n -DSVF_DIR:PATH=\"$GITHUB_WORKSPACE/svf/Release-build\"\n\n - name: '[Dynamic LLVM] Build'\n run: cmake --build _build\n\n - name: '[Dynamic LLVM] Run tests'\n # TODO: turn off the detection of leaks, we're working on it\n run: ASAN_OPTIONS=detect_leaks=0 cmake --build _build --target check\n\n - name: '[Static LLVM] Re-configure CMake project'\n run: |\n cmake -S. \\\n -B_build \\\n -DLLVM_LINK_DYLIB:BOOL=OFF\n cmake --build _build --target clean\n\n - name: '[Static LLVM] Build'\n run: cmake --build _build\n\n - name: '[Static LLVM] Run tests'\n # TODO: turn off the detection of leaks, we're working on it\n run: ASAN_OPTIONS=detect_leaks=0 cmake --build _build --target check\n\n - name: ccache statistics\n run: ccache -s\n" }, { "path": ".gitignore", "content": "# Compiled Object files\n*.slo\n*.lo\n*.o\n*.obj\n\n# Precompiled Headers\n*.gch\n*.pch\n\n# Compiled Dynamic libraries\n*.so\n*.dylib\n*.dll\n\n# Fortran module files\n*.mod\n\n# Compiled Static libraries\n*.lai\n*.la\n*.a\n*.lib\n\n# Executables\n*.exe\n*.out\n*.app\n\n# cmake\n*.cmake\n*Makefile*\n\n# swp files\n*.swp\n*.swo\n*.swm\n\n# vim config files\n*.vimrc\n\ntags\n*/tags\n*/cscope.out\n\n*.swn\n*.dot\n*.ps\n\n# LLVM files\n*.bc\n*.sliced\n*.linked\n*.opt\n*.ll\n\n*.i\n\ntests/*-test\ntests/fuzzing/regressions/\n\n# clangd\n.cache\n.clangd\n\n# pycache\n__pycache__\n\n# C files in tools are test codes\ntools/*.c\ntools/*.bc\n\ntools/llvm-dg-dump\ntools/llvm-to-source\ntools/llvm-slicer\n\ngit-version.h\n\n# build directory\nbuild\n\n# sourcetrail files\ndg.srctrl*\n\ncompile_commands.json\n\nCMakeLists.txt.user*\n" }, { "path": ".travis.yml", "content": "language: cpp\nsudo: true\n\ndist: trusty\n\ngit:\n depth: 1\n\naddons:\n apt:\n sources:\n # newer gcc and clang\n - ubuntu-toolchain-r-test\n - sourceline: 'deb http://apt.llvm.org/trusty/ llvm-toolchain-trusty-4.0 main'\n key_url: 'https://apt.llvm.org/llvm-snapshot.gpg.key'\n - sourceline: 'deb http://apt.llvm.org/trusty/ llvm-toolchain-trusty-5.0 main'\n packages:\n - libz-dev\n\nenv:\n - LLVM=3.8 BUILD_TYPE=Release\n - LLVM=3.8 BUILD_TYPE=Debug\n - LLVM=4.0 BUILD_TYPE=Release\n - LLVM=4.0 BUILD_TYPE=Debug\n - LLVM=5.0 BUILD_TYPE=Release\n - LLVM=5.0 BUILD_TYPE=Debug\n\ncompiler:\n - 'clang++'\n - 'g++'\n - 'g++-5'\n\ninstall:\n - git clone --depth 1 https://github.com/tomsik68/travis-llvm.git\n - cd travis-llvm\n - chmod +x travis-llvm.sh\n - ./travis-llvm.sh ${LLVM}\n - cd ..\n\nscript:\n - cmake -DCMAKE_BUILD_TYPE=\"$BUILD_TYPE\" -DUSE_SANITIZERS=ON .\n - make -j2\n # for now turn off the detection of leaks, we're working on it\n - ASAN_OPTIONS=detect_leaks=0 make check -j2\n\nnotifications:\n email: false\n" }, { "path": "CMakeLists.txt", "content": "cmake_minimum_required(VERSION 3.1)\n\n# FIXME: Unfortunately, C is (at least temporarily) required due to a bug\n# in LLVM 14. See https://github.com/llvm/llvm-project/issues/53950.\nproject(dg LANGUAGES C CXX)\n\ninclude(CTest)\n\n# we need at least C++11 standard\nset(CMAKE_CXX_STANDARD 11)\nset(CMAKE_CXX_STANDARD_REQUIRED ON)\nset(CMAKE_CXX_EXTENSIONS OFF)\n\nOPTION(LLVM_DG \"Support for LLVM Dependency graph\" ON)\nOPTION(ENABLE_CFG \"Add support for CFG edges to the graph\" ON)\nOPTION(NO_EXCEPTIONS \"Compile with -fno-exceptions (ON by default)\" ON)\n\nif(NOT CMAKE_BUILD_TYPE)\n message(STATUS \"Build type not set. Setting default.\")\n set(CMAKE_BUILD_TYPE \"RelWithDebInfo\" CACHE STRING \"\" FORCE)\nendif()\nmessage(STATUS \"Build type: ${CMAKE_BUILD_TYPE}\")\nset_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS \"Debug\" \"RelWithDebInfo\"\n \"MinSizeRel\" \"Release\")\n\nif (LLVM_DG)\n\t# for llvm dg we need cfg and postdom edges\n\tif (NOT ENABLE_CFG)\n\t\tmessage(STATUS \"Enabling CFG edges due to llvm dg\")\n\tendif()\n\n\tset(ENABLE_CFG ON)\n\n\tfind_package(LLVM REQUIRED CONFIG)\n\n\tmessage(STATUS \"Found LLVM ${LLVM_PACKAGE_VERSION}\")\n\tmessage(STATUS \"Using LLVMConfig.cmake in: ${LLVM_DIR}\")\n\tmessage(STATUS \"LLVM binaries: ${LLVM_TOOLS_BINARY_DIR}\")\n\n\tset(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} \"${LLVM_DIR}\")\n\tinclude(LLVMConfig)\n\tinclude(AddLLVM)\n\n\tmessage(STATUS \"LLVM include dir: ${LLVM_INCLUDE_DIRS}\")\n\tmessage(STATUS \"LLVM libraries dir: ${LLVM_LIBRARY_DIRS}\")\n\tmessage(STATUS \"LLVM definitions: ${LLVM_DEFINITIONS}\")\n\n\t# if we were provided a path to custom sources\n\t# use that path\n\tif (LLVM_SRC_PATH)\n\t\tinclude_directories(SYSTEM ${LLVM_SRC_PATH}/include)\n\t\tmessage(STATUS \"Looking for headers in given: ${LLVM_SRC_PATH}/include\")\n\telse()\n\t\tinclude_directories(SYSTEM ${LLVM_INCLUDE_DIRS})\n\t\tmessage(STATUS \"Looking for headers in: ${LLVM_INCLUDE_DIRS}\")\n\tendif()\n\n\t# if we were provided a path to custom build directory\n\t# use that\n\tif (LLVM_BUILD_PATH)\n\t\tlink_directories(${LLVM_BUILD_PATH}/lib)\n\n\t\t# llvm-config.h\n\t\tinclude_directories(SYSTEM \"${LLVM_BUILD_PATH}/include\")\n\t\tmessage(STATUS \"Looking for libraries in given: ${LLVM_BUILD_PATH}/lib\")\n\telse()\n\t\tlink_directories(${LLVM_LIBRARY_DIRS})\n\t\tmessage(STATUS \"Looking for libraries in: ${LLVM_LIBRARY_DIRS}\")\n\tendif(LLVM_BUILD_PATH)\n\n\tadd_definitions(${LLVM_DEFINITIONS})\n\n\toption(LLVM_LINK_DYLIB \"Link with LLVM dynamically\" ON)\n\n\tif (LLVM_LINK_DYLIB)\n\t\tmessage(STATUS \"LLVM linking: dynamic\")\n\t\tif (${LLVM_PACKAGE_VERSION} VERSION_LESS \"3.8\")\n\t\t\tset(llvm LLVM-${LLVM_PACKAGE_VERSION})\n\t\telse()\n\t\t\t# only LLVM 3.8+ provide unversioned library\n\t\t\tset(llvm LLVM)\n\t\tendif()\n\telse()\n\t\tmessage(STATUS \"LLVM linking: static\")\n\t\tif (${LLVM_PACKAGE_VERSION} VERSION_GREATER \"3.4\")\n\t\t\tllvm_map_components_to_libnames(llvm_analysis analysis)\n\t\t\tllvm_map_components_to_libnames(llvm_irreader irreader)\n\t\t\tllvm_map_components_to_libnames(llvm_bitwriter bitwriter)\n\t\telse()\n\t\t\tllvm_map_components_to_libraries(llvm_irreader irreader)\n\t\t\tllvm_map_components_to_libraries(llvm_bitwriter bitwriter)\n\t\t\tllvm_map_components_to_libraries(llvm_analysis analysis)\n\t\tendif()\n\tendif()\n\n\t# LLVM 10 and newer require at least c++14 standard\n\tif (${LLVM_PACKAGE_VERSION} VERSION_GREATER \"9.0\")\n\t\tset(CMAKE_CXX_STANDARD 14)\n\t\toption(USE_CXX14 \"Use C++14 standard\" ON)\n\tendif()\nendif(LLVM_DG)\n\nif (SVF_DIR)\n\tset(HAVE_SVF ON)\n\tadd_definitions(-DHAVE_SVF)\n\tset(SVF_LIBDIR ${SVF_DIR}/lib)\n\n\tif (NOT SVF_INCLUDE)\n\t\tif (EXISTS \"${SVF_DIR}/include/WPA/Andersen.h\")\n\t\t\tset(SVF_INCLUDE ${SVF_DIR}/include)\n\t\telseif (EXISTS \"${SVF_DIR}/../include/WPA/Andersen.h\")\n\t\t\tset(SVF_INCLUDE ${SVF_DIR}/../include)\n\t\telse()\n\t\t\tmessage(FATAL_ERROR \"Did not find the directory with SVF headers\")\n\t\tendif()\n\tendif()\n\n\tset(SVF_LIBS Svf Cudd)\n\n\tinclude_directories(SYSTEM ${SVF_INCLUDE})\n\tlink_directories(${SVF_LIBDIR} ${SVF_LIBDIR}/CUDD)\n\n\tif (NOT LLVM_LINK_DYLIB)\n\t\tif (${LLVM_PACKAGE_VERSION} VERSION_GREATER \"3.4\")\n\t\t\tllvm_map_components_to_libnames(llvm_transformutils transformutils)\n\t\telse()\n\t\t\tllvm_map_components_to_libraries(llvm_transformutils transformutils)\n\t\tendif()\n\tendif()\n\n\tmessage(STATUS \"SVF dir: ${SVF_DIR}\")\n\tmessage(STATUS \"SVF libraries dir: ${SVF_LIBDIR}\")\n\tmessage(STATUS \"SVF include dir: ${SVF_INCLUDE}\")\n\tmessage(STATUS \"SVF libs: ${SVF_LIBS}\")\nendif(SVF_DIR)\n\nif (TSL_HOPSCOTCH_DIR)\n set(HOPSCOTCH_DIR ${TSL_HOPSCOTCH_DIR}/include/)\n if (NOT EXISTS \"${HOPSCOTCH_DIR}/tsl/hopscotch_map.h\")\n message(FATAL_ERROR \"Tessil hopscotch map NOT FOUND in ${TSL_HOPSCOTCH_DIR}\" )\n endif()\n\n include_directories(SYSTEM ${HOPSCOTCH_DIR})\n message(STATUS \"Found Tessil Hopscotch map in ${HOPSCOTCH_DIR}\" )\n message(STATUS \"Adding include dir ${HOPSCOTCH_DIR}\")\n add_definitions(-DHAVE_TSL_HOPSCOTCH)\nendif()\n\n\n\nif (ENABLE_CFG)\n\tadd_definitions(-DENABLE_CFG)\nendif()\n\nmessage(STATUS \"Using compiler: ${CMAKE_CXX_COMPILER}\")\n\n# --------------------------------------------------\n# Fuzzing\n# --------------------------------------------------\ninclude(CheckCXXCompilerFlag)\nset(CMAKE_REQUIRED_FLAGS \"-fsanitize=fuzzer\")\ncheck_cxx_source_compiles(\n \"#include \n extern \\\"C\\\" int LLVMFuzzerTestOneInput(const void *, size_t) { return 0; }\"\n HAS_FUZZER)\nset(CMAKE_REQUIRED_FLAGS \"\")\n\noption(ENABLE_FUZZING \"Enable fuzzing tests\" ${HAS_FUZZER})\nif(NOT ENABLE_FUZZING)\n message(STATUS \"Will NOT build fuzzing tests (requires Clang 6 or newer)\")\nendif()\n\n# --------------------------------------------------\n# clang-tidy\n# --------------------------------------------------\noption(USE_CLANG_TIDY \"Enable clang-tidy checks\" OFF)\nif(USE_CLANG_TIDY)\n message(STATUS \"Clang-tidy build enabled\")\n # read config from .clang-tidy\n set(CMAKE_CXX_CLANG_TIDY \"clang-tidy;--config=\")\nendif()\n\n# --------------------------------------------------\n# Compiler flags\n# --------------------------------------------------\n# explicitly add -std=c++11 (-std=c++14) and -fno-rtti\n# we have CMAKE_CXX_STANDARD, but for some reason it does not\n# put the -std=c++11 (-std=c++14) or -std=gnu++11 (-std=gnu++14)\n# to the flags on some systems.\n# For the -fno-rtti: LLVM still got problems with turning RTTI off...\nif (USE_CXX14)\n\tset(CMAKE_CXX_FLAGS \"${CMAKE_CXX_FLAGS} -std=c++14\")\nelse()\n\tset(CMAKE_CXX_FLAGS \"${CMAKE_CXX_FLAGS} -std=c++11\")\nendif()\nset(CMAKE_CXX_FLAGS \"${CMAKE_CXX_FLAGS} -fno-rtti -Wall -Wextra\")\nif (NO_EXCEPTIONS)\n set(CMAKE_CXX_FLAGS \"${CMAKE_CXX_FLAGS} -fno-exceptions\")\nendif()\n\nif (USE_SANITIZERS)\n\tset(CMAKE_REQUIRED_FLAGS \"-fsanitize=undefined,address\") # for linker\n\tcheck_cxx_compiler_flag(\"-fsanitize=undefined,address\" sanitizers_work)\n\tset(CMAKE_REQUIRED_FLAGS \"\")\n\n\tif (sanitizers_work)\n\t\tset(CMAKE_CXX_FLAGS \"${CMAKE_CXX_FLAGS} -fsanitize=undefined,address\")\n\t\tset(CMAKE_CXX_FLAGS \"${CMAKE_CXX_FLAGS} -g -fno-omit-frame-pointer\")\n\t\tset(CMAKE_CXX_FLAGS \"${CMAKE_CXX_FLAGS} -fno-sanitize-recover=all\")\n\t\tadd_definitions(-DUSING_SANITIZERS)\n\telse()\n\t\tmessage(WARNING \"Used compiler does not support sanitizers or its support is incomplete.\")\n\tendif()\nendif()\n\n# Debug Release RelWithDebInfo MinSizeRel.\nif (CMAKE_BUILD_TYPE STREQUAL \"Debug\")\n\tadd_definitions(-DDEBUG_ENABLED)\n\tmessage(STATUS \"Using compilation flags: ${CMAKE_CXX_FLAGS_DEBUG}\")\nelseif (CMAKE_BUILD_TYPE STREQUAL \"Release\")\n\tmessage(STATUS \"Using compilation flags: ${CMAKE_CXX_FLAGS_RELEASE}\")\nelseif (CMAKE_BUILD_TYPE STREQUAL \"RelWithDebInfo\")\n\tmessage(STATUS\n\t\t\"Using compilation flags: ${CMAKE_CXX_FLAGS_RELWITHDEBINFO}\")\nelseif (CMAKE_BUILD_TYPE STREQUAL \"MinSizeRel\")\n\tmessage(STATUS \"Using compilation flags: ${CMAKE_CXX_FLAGS_MINSIZEREL}\")\nendif ()\n\nmessage(STATUS \"Additional compilation flags: ${CMAKE_CXX_FLAGS}\")\n\ninclude(GNUInstallDirs)\nmessage(STATUS \"CMAKE_INSTALL_LIBDIR: \\\"${CMAKE_INSTALL_LIBDIR}\\\"\")\nmessage(STATUS \"CMAKE_INSTALL_INCLUDEDIR: \\\"${CMAKE_INSTALL_INCLUDEDIR}\\\"\")\n\ninclude_directories(include)\ninclude_directories(lib)\n\nadd_subdirectory(lib)\nadd_subdirectory(tools)\nadd_subdirectory(tests EXCLUDE_FROM_ALL)\n\nif(NOT LLVM_DG)\n set(INSTALL_EXCLUDE_PATTERNS PATTERN \"llvm\" EXCLUDE)\nendif()\ninstall(DIRECTORY include/\n DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}\n ${INSTALL_EXCLUDE_PATTERNS})\n" }, { "path": "Changelog", "content": "-- 3. 10. 2018\n\n* The project was re-structured from src/ structure to lib/ and include/\n structure. As a consequence, all public headers were moved to dg/\n subdirectory, e.g. \"llvm/LLVMDependenceGraph.h\" is now\n \"dg/llvm/LLVMDependenceGraph.h\"\n\n* Renamed files:\n- llvm/Slicer.h -> dg/llvm/LLVMSlicer.h\n- llvm/analysis/PointsTo/PointsTo.h -> dg/llvm/analysis/PointsTo/PointerAnalysis.h\n- analysis/PointsTo/PointsToFlowSensitive.h -> dg/analysis/PointsTo/PointerAnalysisFS.h\n- analysis/PointsTo/PointsToFlowInsensitive.h -> dg/analysis/PointsTo/PointerAnalysisFI.h\n- analysis/PointsTo/PointsToWithInvalidate.h -> dg/analysis/PointsTo/PointerAnalysisFSInv.h\n\n* A new library libDGAnalysis.so was added. You must link to this library\n when linking with any dg library.\n" }, { "path": "Dockerfile", "content": "# --------------------------------------------------\n# Base container\n# --------------------------------------------------\nFROM docker.io/ubuntu:jammy AS base\n\nRUN set -e\n\n# Install packages\nENV DEBIAN_FRONTEND=noninteractive\nRUN apt-get update\nRUN apt-get install -yq --no-install-recommends clang llvm\n\n# --------------------------------------------------\n# Build container\n# --------------------------------------------------\nFROM base as build\n\n# Can be used to specify which git ref to checkout\nARG GIT_REF=master\nARG GIT_REPO=mchalupa/dg\n\n# Install build dependencies\nRUN apt-get install -yq --no-install-recommends ca-certificates cmake git \\\n ninja-build llvm-dev python3\n\n# Clone\nRUN git clone https://github.com/$GIT_REPO\nWORKDIR /dg\nRUN git fetch origin $GIT_REF:build\nRUN git checkout build\n\n# libfuzzer does not like the container environment\nRUN cmake -S. -GNinja -Bbuild -DCMAKE_INSTALL_PREFIX=/opt/dg \\\n -DCMAKE_CXX_COMPILER=clang++ -DENABLE_FUZZING=OFF\nRUN cmake --build build\nRUN cmake --build build --target check\n\n# Install\nRUN cmake --build build --target install/strip\n\n# -------------------------------------------------\n# Release container\n# -------------------------------------------------\nFROM base AS release\n\nCOPY --from=build /opt/dg /opt/dg\nENV PATH=\"/opt/dg/bin:$PATH\"\nENV LD_LIBRARY_PATH=\"/opt/dg/lib\"\n\n# Verify it works\nRUN llvm-slicer --version\n" }, { "path": "LICENSE", "content": "Copyright (c) 2015-2020 Marek Chalupa\n\nPermission is hereby granted, free of charge, to any person obtaining\na copy of this software and associated documentation files (the\n\"Software\"), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\nThe above copyright notice and this permission notice (including the\nnext paragraph) shall be included in all copies or substantial\nportions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\nNONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS\nBE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN\nACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\nCONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n" }, { "path": "README.md", "content": "# DG\n\n[![Linux CI](https://github.com/mchalupa/dg/actions/workflows/linux.yml/badge.svg)](https://github.com/mchalupa/dg/actions/workflows/linux.yml)\n[![macOS CI](https://github.com/mchalupa/dg/actions/workflows/mac.yml/badge.svg)](https://github.com/mchalupa/dg/actions/workflows/mac.yml)\n\nDG is a library containing various bits for program analysis. However, the main motivation of this library is program slicing. The library contains implementation of a pointer analysis, data dependence analysis, control dependence analysis, and an analysis of relations between values in LLVM bitcode. All of the analyses target LLVM bitcode, but most of them are written in a generic way, so they are not dependent on LLVM in particular.\n\nFurther, DG contains an implementation of dependence graphs and a [static program slicer](doc/llvm-slicer.md) for LLVM bitcode. Some documentation can be found in the [doc/](doc/) directory.\n\n\n* [Downloading DG](doc/downloading.md)\n* [Compiling DG](doc/compiling.md)\n* [Using llvm-slicer](doc/llvm-slicer.md)\n* [Other tools](doc/tools.md)\n\n------------------------------------------------\n\nYou can find a high-level description of DG in [DG: a program analysis library](https://doi.org/10.1016/j.simpa.2020.100038) or [DG: Analysis and slicing of LLVM bitcode](https://www.fi.muni.cz/~xchalup4/dg_atva20_preprint.pdf) papers. More detailed information about dg is in the doc/ folder or in my [master thesis](http://is.muni.cz/th/396236/fi_m/thesis.pdf).\n\nYou can write e-mails with issues to (or file issue in github).\n" }, { "path": "dg.spec.rpkg", "content": "# vim: syntax=spec\n\n# Do out-of-source build by default on Fedora\n%undefine __cmake_in_source_build\n\nName: {{{ git_dir_name }}}\nVersion: {{{ git_dir_version }}}\nRelease: 1%{?dist}\nSummary: Analyses, construction of dependence graphs and slicing of LLVM bitcode\n\nLicense: MIT\nURL: https://github.com/mchalupa/dg\nVCS: {{{ git_dir_vcs }}}\n\nSource: {{{ git_dir_archive }}}\n\nBuildRequires: clang\nBuildRequires: cmake\nBuildRequires: gcc\nBuildRequires: gcc-c++\nBuildRequires: llvm-devel\nBuildRequires: make\nBuildRequires: ncurses-devel\nBuildRequires: python3\nBuildRequires: zlib-devel\n\nRequires: clang\nRequires: llvm\n\n%description\nDG is a library containing various bits for program analysis. However, the\nmain motivation of this library is program slicing. The library contains\nimplementation of a pointer analysis, data dependence analysis, control\ndependence analysis, and an analysis of relations between values in LLVM\nbitcode. All of the analyses target LLVM bitcode, but most of them are written\nin a generic way, so they are not dependent on LLVM in particular.\n\n%prep\n{{{ git_dir_setup_macro }}}\n\n%build\nGIT_VERSION={{{ git rev-parse --short --sq HEAD }}}\n%cmake -DGIT_VERSION=\"$GIT_VERSION\"\n%cmake_build\n\n%install\n%cmake_install\n\n%check\n%if 0%{?suse_version}\n %cmake_build -C %{__builddir} check\n%else\n %if 0%{?epel}\n %cmake_build check\n %else\n %cmake_build --target check\n %endif\n%endif\n\n%files\n%license LICENSE\n%doc doc/*\n%{_bindir}/*\n%{_includedir}/%{name}\n%{_libdir}/*\n" }, { "path": "doc/CDA.md", "content": "# Control Dependence Analysis\n\nIn DG, we implemented several algorithms for the computation of different control dependencies.\nThese control dependencies are:\n\n - Standard (SCD) control dependence (Ferrante et al. [1])\n - Non-termination sensitive control dependence (NTSCD) (Ranangath et al.[2])\n - Decisive order dependence (DOD) (Ranangath et al.[2])\n - [experimental/WIP] Strong control closures (Strong CC) (Danicic et al.[3])\n\n\n## Public API\n\nThe class through which you can run and access the results of control dependence analysis\nis called `LLVMControlDependenceAnalysis` and is defined in\n[dg/llvm/ControlDependence/ControlDependence.h](../include/dg/llvm/ControlDependence/ControlDependence.h)\n\nThe class takes an instance of `LLVMControlDependenceAnalysisOptions` in constructor. This object\ndescribes which analysis to run and whether to compute also interprocedural dependencies (see below).\n\nThe public API of `LLVMControlDependenceAnalysis` contains several methods:\n\n* `run()` to run the analysis\n* `getDependencies()` to get dependencies of an instruction or a basic block (there are two polymorphic methods).\n As we compute intraprocedural dependencies on basic block level, these two method return different things.\n `getDependencies` for a basic block returns a set of values on which depend all the instructions in the basic\n block. `getDependencies` for instruction then returns additional dependencies, e.g., interprocedural.\n Therefore, if you want _all_ dependencies for an instruction, you should always query both, `getDependencies`\n for the instruction and also `getDependencies` for the basic block of the instruction.\n Note that the return value may be either an instruction or a basic block.\n If a basic block is returned as a dependence, it means that the queried value depends on the terminator\n instruction of the returned basic block.\n\n* `getDependent()` methods return values (instructions and blocks) that depend on the given instruction (block).\n They work similarly as `getDependencies` methods, just return dependent values instead of dependencies.\n If a block is returned, then all instructions of the block depend on the given value.\n\n* `getNoReturns()` return possibly no-returning points of the given function (those are usually calls to functions\n that may not return). If interprocedural analysis is disabled, returns always an empty vector.\n\nThen there are methods for closure-based algorithms, but these are mostly unimplemented (in fact, the Strong CC algorithm\nworks, just these getter methods are not implemented yet).\n\n## Interprocedural dependencies\n\nDG supports the computation of control dependencies that arise due to e.g., calling `abort()` from inside of a procedure.\nConsider this example:\n\n```C\nvoid foo(int x) { if (x < 0) abort(); }\n\nint main() {\n int a = input();\n foo();\n assert(a > 0);\n}\n```\n\nIn the example above, the assertion cannot be violated, because for values of `a` that would violate the\nassert the program is killed by the call to `abort`. That is, the assertion in fact depends on the if statement\nin the `foo` function. Such control dependencies between procedures are omitted by the classical algorithms.\nIn DG, compute these dependencies by a standalone analysis that runs after computing intraprocedural control dependencies.\nResults of the interprocedural analysis are returned by `getDependencies` and `getDependent` along with\nresults of the intraprocedural analysis (of course, only if interprocedural analysis is enabled by the options\nobject).\n\nAlso, NTSCD and DOD algorithms can be executed on interprocedural (inlined) CFG (ICFG).\nThat is, a one big CFG that contains nodes for all basic blocks/instructions of the\nprogram and there are regular intraprocedural edges and also interprocedural\nedges going between calls and entry blocks/instructions and from returns to return-sites.\nFor this functionality, use -cda-icfg.\n\n## Tools\n\nThere is the `llvm-cda-dump` tool that dumps the results of control dependence analysis.\nBy default, it shows the results directly on LLVM bitcode. You can you the `-ir`switch to see the internal\nrepresentation from the analyses. To select the analysis to run, use the `-cda` switch with one of these options:\n\n|opt | description |\n|----------------|---------------------------------------|\n|`scd` | standard CD (the default) |\n|`standard` | an alias for stanard |\n|`classic` | an alias for standard |\n|`ntscd` | non-termination sensitive CD |\n|`ntscd2` | NTSCD (a different implementation) |\n|`ntscd-ranganath` | Ranganath et al's algorithm for NTSCD (warning: it is incorrect) |\n|`dod` | Standalone DOD computation |\n|`dod-ranganath` | Ranganath et al's algorithm (the original algorithm was incorrect, this is a fixed version) |\n|`dod+ntscd` | NTSCD + DOD |\n|`scc` | Strong control closures |\n\n\nNote that `llvm-slicer` takes the very same options.\n\nThere are also tools `llvm-ntscd-dump` specialized for showing internals and results of the NTSCD analysis,\n`llvm-cda-bench` that benchmarks a given list of analyses (the list is given without the `-cda` switch,\ne.g., `-ntscd -ntscd2 -dod`, see the help message) on a given program, and `llvm-cda-stress`\nthat works like `llvm-cda-bench` with the difference that it generates and uses a random control flow graph\nand it works with only a subset of analyses (all except SCD).\n\n## Other notes\n\nThe algorithm for computing standard control dependencies does not have a generic implementation in DG\nas we heavily rely on LLVM in computation of post dominators.\n\n\n\n[1] Jeanne Ferrante, Karl J. Ottenstein, Joe D. Warren: The Program Dependence Graph and Its Use in Optimization.\n ACM Trans. Program. Lang. Syst. 9(3): 319-349 (1987)\n\n\n[2] Venkatesh Prasad Ranganath, Torben Amtoft, Anindya Banerjee, Matthew B. Dwyer, John Hatcliff:\n A New Foundation for Control-Dependence and Slicing for Modern Program Structures. ESOP 2005: 77-93\n\n[3] Sebastian Danicic, Richard W.Barraclough, Mark Harman, John D.Howroyd, Ákos Kiss, Michael R.Laurence: A unifying theory of control dependence and its application to arbitrary program structures. Theoretical Computer Science, Volume 412, Issue 49, 2011, Pages 6809-6842\n" }, { "path": "doc/DDA.md", "content": "# Data Dependence Analysis\n\nDG contains the analysis of data dependencies (also called value-flow)\nbased on constructing memory SSA form of the program.\n\n## Public API\n\nThe data dependence analysis class for LLVM is `LLVMDataDependenceAnalysis`.\nIts constructor takes the LLVM module, results of pointer analysis and optionally an instance of\n`LLVMDataDependenceAnalysisOptions`.\n\nRelevant methods from the public API are two polymorphic methods `getLLVMDefinitions`.\n\nOne takes LLVM value which is required to read memory (can be checked by `isUse` method)\nand returns a vector of LLVM values that may have possibly written the values read\nby the given value.\n\nThe other takes parameters `where`, `mem`, `off`, and `len` and returns all LLVM values that\nmay write to the memory allocated by instruction or global variable `mem` at bytes from `off`\nto `off + len - 1` and the written value may be read at `where` (i.e., it has not been surely\noverwritten at `where` yet).\n\n## Modeling external (undefined) functions\n\nThe class `LLVMDataDependenceAnalysisOptions` has the possibility of registering\nmodels for functions. If the analysis then hits a call of the given function,\nit uses this model instead of calling the function (if the function is defined\nin the module) or instead of assuming that the function may do anything.\n\nThe methods that take care of registering models of functions are\n`functionModelAddDef` and `functionModelAddUse`.\nThese methods take the name of the modelled function and a tripple `(argidx, offset, len)`\nwhich means that the function defines/uses the memory pointed by the `argidx`-th argument\n(beginning at 0) and define `len` bytes from the memory beginning at `argidx + offset`.\nIf `len` (`offset`, resp.) are of type `Offset`, these are interpreted as constant numbers.\nHowever, if those are of type `unsigned`, those are interpreted as indexes of arguments\n(the same as `argidx`) meaning that the real number of bytes and offset is given\nby the argument of the called function. If the argument is not a constant,\nit is taken as UNKNOWN. For example,\n\n```C\nfunctionModelAddUse(\"memset\", {0, Offset(0), 2})`\n```\n\ntell the analysis that `memset` function defines the memory pointed by the first argument\n(with index 0) and this memory is defined from the byte where the first argument points.\nAlso, only the number of bytes specified by the third argument (with index 2) are used.\nFor the code\n\n```C\nint array[10];\nmemset(array + 2, 0, 20);\n```\n\nThe analysis will create a model that tells that this call to `memset` defines bytes 8 - 27 of `array`\n(given that the size of int is 4 bytes).Another examples of using these functions can be found in\n[LLVMDataDependenceAnalysisOptions.h](../include/dg/llvm/DataDependence/LLVMDataDependenceAnalysisOptions.h).\n\n\n## Tools\n\nThere is `llvm-dda-dump` that dumps the results of data dependence analysis. If dumped to .dot file\n(`-dot` option) the computed memory SSA along with def-use chains is shown.\n" }, { "path": "doc/PTA.md", "content": "# Pointer Analysis in DG\n\nPointer analysis (PTA) implementation in DG consists of a general part and LLVM\npart. The general part include a program representation (graph) and the\npointer analysis algorithm that runs on the graph. The LLVM part takes care of\nbuilding the pointer graph from the LLVM module and translating results from\nthe analysis to consumers of LLVM bitcode (i.e., if we ask for points-to set of\na LLVM value, we get a set of LLVM values and not the analysi's internal\nnodes).\n\nThe program representation (`PointerGraph`) is a graph whose nodes (`PSNode`)\ncontain information about pointer handlings, e.g., casts, storing and loading\nto/from memory, shifting, etc. Further, the graph is subdivided into subgraphs\n(`PointerSubgraph`) that correspond to procedures.\n\nOnce we build the pointer graph, we can run an analysis on it. In DG, the\npointer analysis class has virtual `getMemoryObjects` method whose definition\nchanges the behavior of the analysis (along with auxiliary `processefore` and\n`processAfter`). Once the `run` method of pointer analysis is invoked, the\nanalysis computes points-to sets of nodes (that correspond to top-level values\nin LLVM) until fixpoint is reached.\n\nWe have implemented flow-sensitive (data-flow) and flow-insensitive\n(Andersen's-like) pointer analysis (this one is used by default).\n\n## LLVM pointer analysis\n\nFiles from [dg/llvm/PointerAnalysis/](../include/dg/llvm/PointerAnalysis/)\n\nThe pointer analysis for LLVM is provided by the `LLVMPointerAnalysis` class.\nThis class can have different implementations, all of them complying with a\nbasic public API:\n\n##### `hasPointsTo`\n\nreturns true if\n 1) PTA has any points-to set for the given value\n 2) the points-to set is non-empty```\n\n##### `getLLVMPointsTo`\n\nreturns points-to set (object of the class `LLVMPointsToSet`, see below) for the given value.\nIf `hasPointsTo` would be false for the given value, points-to set containging the only\nelement `unknown` is returned.\n\n##### `getLLVMPointsToChecked`\n\nreturns points-to set (object of the class `LLVMPointsToSet`) for the given value\nand a bool which corresponds with the result of `hasPointsTo`. \nThe boolean returned is good for checking whether the `unknown` pointer in the points-to set\n(if any) is a result of the analysis (e.g., a pointer returned from an undefined function) or\nis there because the analysis has no information about the queried value.\n\n##### `getAccessedMemory`\n\nis a wrapper around getLLVMPointsTo that returns `LLVMMemoryRegionSet`.\nThis object represents a set of tripples (memory, offset, length) describing the regions\nof memory accessed by the given instruction (e.g., store or load).\n\n\n`LLVMPointsToSet` is an object that yields `LLVMPointer` objects upon\niteration. Each `LLVMPointer` object is a pair of LLVM `Value` and `Offset`\ncontaining the allocation that allocated the pointed memory and the offset into\nthe memory. `LLVMPointsToSet` has also methods `hasUnknown`, `hasNull`, and\n`hasInvalidated` that return true if the points-to set contains `unknown`,\n`null`, or `invalidated` (i.e., pointing to freed or destroyed memory) element.\nNote that these elements are not physically present in the points-to set as\nthere are no LLVM Values that would represent them (and thus could be returned\nin LLVMPointer).\n\n## Tools\n\nResults of pointer analysis can be dumped by the `llvm-pta-dump` tool which can be found in `tools/` directory.\nPossible options are:\n\nOption | Values | Description\n----------------------|-------------|-------------\n`-pta` | fi, fs, inv, svf | Type of analysis - flow-insensitive, flow-sensitive, flow-sensitive with tracking invalidated memory, and SVF (if available)\n`-pta-field-sensitive` | BYTES | Set field sensitivity: how many bytes to track on each object\n`-callgraph` | | Dump also call graph\n`-callgraph-only` | | Dump only call graph\n`-iteration` | NUM | How many iterations to perform (for debugging)\n`-graph-only` | | Do not run PTA, just build and dump the pointer graph\n`-stats` | | Dump statistics\n`-entry` | FUN | Set entry function to FUN\n`-dbg` | | Show debugging messages\n`-ir` | | Dump internal representation of the analysis\n`-c-lines` | | Dump output on the level of C lines (needs debug info)\n`-dot` | | Dump IR and results of the analysis to .dot file\n`-v` `-vv` | | Verbose output\n\nFurther, there is the tool `llvm-pta-ben` for evaulation of files annotated according to the [PTABen](https://github.com/SVF-tools/PTABen) project, and `llvm-pta-compare` that compares results different pointer analyses.\n" }, { "path": "doc/README.md", "content": "# DG library\n\nDG is a C++ library containing bits for building various static program\nanalyses. The main part of the library aims at building dependence graph and\nprogram slicing. In particular, DG contains an implementation of static program\nslicer for LLVM bitcode.\n\n#### Supported operating systems\n\nWe develop and target DG on GNU/Linux. The project should be compilable on OSX,\nthough there were some issues in the past (issue [#230](https://github.com/mchalupa/dg/issues/230)).\nThere were also some unresolved attempts to compile DG on Windows.\nAlthough the code does not use any compiler-specific\nor non-portable features, so it should be compilable on Windows,\nthe compilation was failing due to problems with linking to LLVM libraries\n(issues [#196](https://github.com/mchalupa/dg/issues/196) and\n[#315](https://github.com/mchalupa/dg/issues/315)).\n\n## Analyses\n - [Pointer analysis](PTA.md)\n - [Data dependence analysis](DDA.md)\n - [Control dependence analysis](CDA.md)\n - [Value-relations analysis](VRA.md)\n\n## Tools\n - [llvm-slicer](llvm-slicer.md)\n - [Other tools](tools.md)\n\n## External Libraries\n - [SVF](SVF.md)\n" }, { "path": "doc/SVF.md", "content": "# Integration of SVF into DG\n\nDG can use pointer anlysis from the SVF project. This analysis should scale\nmuch more better than ours, however, our analysis can be more precise in some\ncases.\n\n\n## Building DG with SVF\n\nTo use SVF with DG, you first needs a build of\n[SVF](https://github.com/SVF-tools/SVF). Build the project according its\ninstructions. To configure DG with SVF, setup `SVF_DIR` variable to point\nto the build of SVF:\n\n```\ncmake . -DSVF_DIR=/path/to/svf/build\n```\n\nDuring configuration, cmake should inform you about the found SVF build:\n\n```cmake\n-- SVF dir: /home/user/SVF/Debug-build\n-- SVF libraries dir: /home/user/SVF/Debug-build/lib\n-- SVF include dir: /home/user/SVF/Debug-build/../include\n-- SVF libs: LLVMSvf;LLVMCudd\n```\n\nIn cases of out-of-source build of SVF you may want to manually specify\nthe varable for include directory:\n\n```\ncmake . -DSVF_DIR=/path/to/svf/build -DSVF_INCLUDE=/path/to/svf/include\n```\n\n`SVF_DIR` must point to a directory that contains the `lib` subdirectory with\nlibraries. `SVF_INCLUDE` must point to directly to a directory that contains\nthe header files.\n\n## Using DG with SVF\n\nDG now integrates only pointer analysis from SVF. To use SVF from C++ API,\njust specify in the `LLVMPointerAnalysisOptions` object\nthat the analysis is of type `LLVMPointerAnalysisOptions::AnalysisType::svf`.\n\nFor tools, the switch that turns on SVF pointer analysis is `-pta svf`,\nfor example:\n\n```\ntools/llvm-slicer -c foo -pta svf test.ll\n```\n" }, { "path": "doc/compiling.md", "content": "# Compiling DG from sources\n\n## Requirements\n\nDG needs LLVM 3.4 or higher. Further requirements are `cmake`, `make`, `g++` or `clang++`\nin a version that supports at least C++11 standard.\nAnd, of course, `git` for downloading the project. On some systems,\nalso `zlib` is required. For compilation of files into LLVM, we need also `clang`\ncompiler. To run slicing tests and some of the tools, you need also an installation\nof `python`.\n\nOn Ubuntu, you install the dependencies with:\n\n```\napt install git cmake make llvm zlib1g-dev clang g++ python3\n```\n\nOn ArchLinux, the command for installing the dependencies is the following:\n\n```\npacman -S git cmake make llvm clang gcc python\n```\n\nOn CentOS/RHEL/Fedora, the command for installing the dependencies is the following:\n\n```\ndnf install git cmake make zlib-devel llvm-devel gcc-c++ ncurses-devel\n```\n\nYou can use also LLVM compiled from sources (see below).\n\n## Building docker image\n\nThe DG repository contains a prepared Dockerfile that\nbuilds DG under Ubuntu 20.04. To build the docker image,\ngo into the top-level project's directory (the one containing\nDockerfile) and run:\n\n```\ndocker build . --tag dg:latest\ndocker run -ti dg:latest\n```\n\nThe Dockerfile installs only the prerequisities for dg.\nIf you need anything else to try out dg (e.g., vim or emacs), you must install\nit manually inside the image.\n\n## Compiling DG\n\nThe first step is to clone the repository to your machine:\n\n```\ngit clone https://github.com/mchalupa/dg\ncd dg\n```\n\nOnce you have the project cloned, you need to configure it.\nWhen LLVM is installed on your system in standard paths,\nthe configuration should be as easy as calling `cmake`:\n\n```\ncmake .\n```\nor\n```\nmkdir build\ncd build\ncmake ..\n```\n\nHowever, if you have LLVM installed in non-standard paths, or you have several\nversions of LLVM and want to use a particular one, you must manually specify\npath to the installation:\n\n```\ncmake -DLLVM_SRC_PATH=/path/to/src -DLLVM_BUILD_PATH=/path/to/build -DLLVM_DIR=path/to/llvm/share/llvm/cmake .\n```\n\nLLVM\\_DIR is an environment variable used by LLVM to find cmake config files\n(it points to the build or install directory), LLVM\\_SRC\\_DIR is a variable\nthat tells cmake where to look for llvm's sources and it is used to override\ninclude paths. The same holds for LLVM\\_BUILD\\_PATH that is used to override\nlibrary paths. Usually, you don't need to specify all these variables:\nLLVM\\_DIR variable is useful if there is any collision (i.e. there are more\nversions of LLVM installed) and you want to use a particular build of LLVM. In\nthat case, define the LLVM\\_DIR variable to point to the directory where are\nthe config files of the desired version (`$PREFIX/share/llvm/cmake` or\n`$PREFIX/lib/cmake/llvm/` for newer versions of LLVM -- for system\ninstallations, `PREFIX` is usually set to `/usr`). If you have LLVM compiled\nfrom sources but not installed anywhere, you may need to use LLVM\\_SRC\\_PATH\nand LLVM\\_BUILD\\_PATH variables to specify the directory with sources and\nbuild. As an example, suppose you have LLVM built in /home/user/llvm-build\nfrom sources in /home/user/llvm-src. Then the following configuration should\nwork:\n\n```\ncmake -DLLVM_SRC_PATH=/home/user/llvm-src -DLLVM_BUILD_PATH=/home/user/llvm-build -DLLVM_DIR=/home/user/llvm-build/share/llvm/cmake .\n```\n\nThe LLVM is linked dynamically by default. This behaviour can be toggled by\nturning the `LLVM_LINK_DYLIB` option `OFF`. Note that some additional packages\nmight be required than those listed above when linking statically.\n\nIf you want to build the project with debugging information and assertions, you\nmay specify the build type by adding `-DCMAKE_BUILD_TYPE=Debug` during\nconfiguration. Also, you may enable building with sanitizers by adding\n`-DUSE_SANITIZERS=ON`.\n\nAfter configuring the project, usual `make` takes place:\n\n```\nmake -j4\n```\n\nIn this documentation, you can find also some reports of how we compiled DG on\ndifferent Linux systems with the system LLVM packages. These documents describe\njust the one-time experience and are not maintained. Therefore,\nthe reports may be out-of-date:\n\n- [Compiling on Ubuntu Trusty](compiling_ubuntu_trusty.md)\n- [Compiling on Ubuntu Xenial](compiling_ubuntu_xenial.md)\n\n\n## Building with SVF support\n\nIf you want to build DG with the support of the\n[SVF](https://github.com/SVF-tools/SVF) library, you must specify `SVF_DIR`\nvariable to point to the build of SVF. For more information, see [documentation\nfor SVF](SVF.md).\n\n## Testing\n\nYou can run tests with `make check`. The command runs unit tests and also tests\nof slicing LLVM bitcode in several different configurations, so it may take a\nwhile. If your compiler supports `libFuzzer`, fuzzing tests are compiled and\nrun as well.\n" }, { "path": "doc/compiling_ubuntu_trusty.md", "content": "# The experience with compiling DG on Ubuntu Trusty\n\nThis is my experience with compiling DG on (a clean installation of) Ubuntu Trusty for different versions of LLVM.\nTo summarize, compiling DG with a custom build of LLVM goes fine on Ubuntu Trusty.\nUsing system LLVM packages does not work at all. The only way how to compile DG without compiling also LLVM\nis to use our packages that we use in CI.\n\nIf LLVM is compiled from sources, it should be enough to set `LLVM_DIR` (and possibly\n`LLVM_SRC_DIR` and `LLVM_BUILD_DIR` to the right directories.\n\nThe LLVM 3.4-3.8 packages from the system repositories unfortunately contain broken cmake files.\nNot only the config file is named `LLVM-Config.cmake` instead of `LLVMConfig.cmake`\nfor some LLVM version,but there is also broken the mapping to LLVM libraries.\n\nThe configuration with system LLVM 3.9 goes smoothly, but the compilation fails with this error:\n\n```\n/usr/lib/llvm-3.9/lib/libLLVMCore.a(AsmWriter.cpp.o): unrecognized relocation (0x2a) in section `.text._ZN4llvm24AssemblyAnnotationWriterD2Ev'\n\n```\n\nGreater versions of LLVM are not available from the repositories.\n\n## Building with LLVM package from our CI\n\nIf you do not want to compile LLVM from sources, \nfor LLVM 3.8, 4, and 5 you can use the packages that we use in our CI:\n\n\n```\ngit clone --depth 1 https://github.com/tomsik68/travis-llvm.git\ncd travis-llvm\nchmod +x travis-llvm.sh\n./travis-llvm.sh 3.8 # change 3.8 to 4 or 5 if wanted\n```\n\nNow we can proceed normally with configuration and compilation:\n\n```\ncd dg\ncmake . -DLLVM_DIR=/usr/share/llvm-3.8/cmake\nmake -j4\n```\n" }, { "path": "doc/compiling_ubuntu_xenial.md", "content": "# The experience with compiling DG on Ubuntu Trusty\n\nThis is my experience with compiling DG on (a clean installation of) Ubuntu Xenial for different versions of LLVM.\nCompiling DG with LLVM built from sources should work fine, so here I focus only on the compilation\nwith LLVM from the repositories packages.\n\n\nFirst of all, install the dependencies.\n\n```\napt update\napt install git cmake make zlib1g-dev clang g++ python3\n```\n\n## LLVM 3.8\n\nThe default LLVM is 3.8 which you can install with:\n\n```\napt install llvm\n```\n\nUnfortunately, it still suffers from the broken cmake files as in Ubuntu Trusty\n(the files are in `/usr/share/llvm-3.8/cmake/`, but cmake is instructed to look\nfor the configuration files in `/usr/share/llvm/cmake/`. So for LLVm 3.8, the\nonly option is to build LLVM from sources or use our CI package\n(see [Compiling on Ubuntu Trusty](compiling_ubuntu_trusty.md) page).\n\n## LLVM >= 3.9\n\nCompiling DG with system LLVM 3.9 and higher (Xenial has packages\nfor LLVM 3.9, 4.0, 5.0, 6.0, and 8.0) should work out of the box.\nAfter the installation of prerequisities, just install LLVM, configure DG\nand compile (replace `-3.9` with the desired version of LLVM):\n\n```\napt install llvm-3.9\ncmake . # you may need to use -DLLVM_DIR=/usr/lib/llvm-3.9/cmake\nmake -j2\n```\n\nDon't forget to compile source code to LLVM with the right version of clang:\n\n```\napt install clang-3.9\n```\n\nThe binaries `clang`, `llvm-link`, `opt`, and `lli` (for running slicing tests) may have the suffix `-3.9`,\nso you may need to create symbolic links with names without the suffix to successfully run tests.\n\n" }, { "path": "doc/downloading.md", "content": "# Getting pre-compiled DG\n\nYou can obtain pre-compiled DG project in several forms.\n\n## Docker image\n\nYou can download the image from [Docker Hub](https://hub.docker.com/r/mchalupa/dg). The image\ncontains, apart from DG, also vim and emacs editors and clang, so that you can try dg out.\n(Note that this image is not being updated regularly).\nAlternatively, the root folder of dg contains a Dockerfile which allows you to build\na docker image with dg installed. Just run these commands from the dg's root directory:\n\n```\ndocker build . --tag dg:latest\ndocker run -ti dg:latest\n```\n\nNote that the locally built image does not contain either vim or emacs, so you must\ninstall one of them if you need.\n\n## Binary Packages\n\nWe have packed DG for several systems. The packages contain only the library and `llvm-slicer`. Other tools are not included.\n\n### Ubuntu package\n\nA binary package for Ubuntu 18.04 can be found in [Releases](https://github.com/mchalupa/dg/releases/tag/v0.9-pre).\n\n\n### Archlinux AUR package\n\nThere is also the [dg-git](https://aur.archlinux.org/packages/dg-git/) AUR package for Archlinux users.\n" }, { "path": "doc/llvm-slicer.md", "content": "# llvm-slicer\n\nDG project contains a static slicer for LLVM bitcode. The slicer supports backward and forward (experimental) slicing.\nIt is designed and tested on slicing code generated from sequential C programs. However, there is an experimental\nsupport for parallel programs and it should handle bitcode generated from other languages in many cases.\nThere is a section on using the slicer with bitcode generated from C++ at the end of this file.\n\n### Using the llvm-slicer\n\nThe compiled `llvm-slicer` can be found in the `tools/` subdirectory. First, you need to compile your\nprogram into LLVM IR (make sure you are using the correct version of LLVM binaries if you have more than one):\n\n```\nclang -c -emit-llvm source.c -o bitcode.bc\n```\n\nIf the program is split into more source files (exactly one of them must contain main),\nyou must compile each of them separately (as above) and then link the bitcodes together using `llvm-link`:\n\n```\nllvm-link bitcode1.bc bitcode2.bc ... -o bitcode.bc\n```\n\nNow, you're ready to slice the program:\n\n```\n./llvm-slicer -c slicing_criterion bitcode.bc\n```\n\nThe `slicing_criterion` is either a call-site of a function or `ret` to slice\nwith respect to the return value of the main function. Alternatively, if the program was compiled with the `-g` option,\nyou can also use `line:variable` as slicing criterion. Slicer will then try to find a use of the variable\non the provided line and mark this use, if found, as a slicing criterion.\nIf no line is provided (e.g. `:x`), then the variable is considered to be global variable.\nYou can provide a comma-separated list of slicing criterions, e.g.: `-c crit1,crit2,crit3`.\nMore about specifying slicing criteria can be found [later](#slicing-criteria) in this document.\n\nYou can view the dependence graph that was used to slice the bitcode by exporting it into .dot file.\nTo achieve this, use `-dump-dg` switch with `llvm-slicer` or a stand-alone tool like\n`llvm-dg-dump` (this one is deprecated, but should still work):\n\n```\n./llvm-dg-dump bitcode.bc > file.dot\n```\n\nYou can highlight nodes from the dependence graph that will be in the slice using the `-mark` switch:\n\n```\n./llvm-dg-dump -mark slicing_criterion bitcode.bc > file.dot\n```\n\nWhen using `-dump-dg` with `llvm-slicer`, the nodes should be already highlighted.\nAlso a .dot file with the sliced dependence graph is generated (similar behaviour\ncan be achieved with `llvm-dg-dump` using the `-slice` switch).\n\nIf the dependence graph is too big to be displayed using .dot files, you can debug/see the slice right from\nthe LLVM language. Just pass `-annotate` option to the `llvm-slicer` and it will store readable annotated LLVM in `file-debug.ll`\n(where `file.bc` is the name of file being sliced). There are more options (try `llvm-slicer -help` for show all of them),\nbut the most interesting is probably the `-annotate slice`:\n\n```\n./llvm-slicer -c crit -annotate slice code.bc\n```\n\nThe content of `code-debug.ll` will look like this:\n\n```LLVM\n;