Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Clang][RISCV] Add preprocessor macros for Zicfilp CFI scheme #109600

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

[Clang][RISCV] Add preprocessor macros for Zicfilp CFI scheme #109600

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3bb0b65
[clang][RISCV] Add Zicfilp CFI scheme preprocessor macros
mylai-mtk May 10, 2024
8d278be
fixup: Remove redundant macro contents
mylai-mtk Feb 17, 2025
87067be
fixup: Move tests of macros from CodeGen dir to Preprocessor dir
mylai-mtk Feb 17, 2025
f3d2973
fixup: Add tests for default branch label scheme
mylai-mtk Feb 17, 2025
d88836d
fixup: Add tests for `-fcf-protection=full`
mylai-mtk Feb 17, 2025
02d43b3
fixup: Remove useless line in test and rename test file itself
mylai-mtk Feb 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions clang/lib/Basic/Targets/RISCV.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,25 @@ void RISCVTargetInfo::getTargetDefines(const LangOptions &Opts,
else
Builder.defineMacro("__riscv_32e");
}

if (Opts.CFProtectionBranch) {
auto Scheme = Opts.getCFBranchLabelScheme();
if (Scheme == CFBranchLabelSchemeKind::Default)
Scheme = getDefaultCFBranchLabelScheme();

Builder.defineMacro("__riscv_landing_pad");
switch (Scheme) {
case CFBranchLabelSchemeKind::Unlabeled:
Builder.defineMacro("__riscv_landing_pad_unlabeled");
break;
case CFBranchLabelSchemeKind::FuncSig:
Builder.defineMacro("__riscv_landing_pad_func_sig");
break;
Comment on lines +252 to +254
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Drop this since this not really functional work on upstream LLVM yet, this may misleading user that already implemented.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To drop this case I have 2 options, but I think neither is appropriate.

  • Option 1:
    case CFBranchLabelSchemeKind::FuncSig:
      // TODO: Define macros after the func-sig scheme is implemented
      break;

Considering we already accepted -mcf-branch-label-scheme=func-sig, if the user uses the flag now, he would get a success program run, but incomplete compilation result, which is also misleading, so it's better to add an error to prevent the case, which leads to Option 2.

  • Option 2:
    case CFBranchLabelSchemeKind::FuncSig:
      // TODO: Define macros after the func-sig scheme is implemented
      llvm::report_fatal_error("the func-sig scheme is not implemented yet!");
      break;

This prevents the misleading results, but it breaks tests in the main trunk, so existing tests for the func-sig scheme have to be removed, but I don't think it's worth it to undo the work just to merge this PR.

Perhaps we should still pause this PR? This is not really an urgent thing given the concern of misleading users.

case CFBranchLabelSchemeKind::Default:
llvm_unreachable("default cf-branch-label scheme should already be "
"transformed to other scheme");
}
}
}

static constexpr int NumRVVBuiltins =
Expand Down
148 changes: 148 additions & 0 deletions clang/test/Preprocessor/riscv-cf-protection-branch.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,148 @@
// RUN: %clang --target=riscv32 -menable-experimental-extensions \
// RUN: -march=rv32i_zicfilp1p0 -fcf-protection=branch -E -dM %s -o - | \
// RUN: FileCheck --check-prefixes=LPAD-MACRO,FUNC-SIG-MACRO %s

// RUN: %clang --target=riscv32 -menable-experimental-extensions \
// RUN: -march=rv32i_zicfilp1p0 -fcf-protection=branch \
// RUN: -mcf-branch-label-scheme=unlabeled -E -dM %s -o - | FileCheck \
// RUN: --check-prefixes=LPAD-MACRO,UNLABELED-MACRO %s

// RUN: %clang --target=riscv32 -menable-experimental-extensions \
// RUN: -march=rv32i_zicfilp1p0 -fcf-protection=branch \
// RUN: -mcf-branch-label-scheme=func-sig -E -dM %s -o - | FileCheck \
// RUN: --check-prefixes=LPAD-MACRO,FUNC-SIG-MACRO %s

// RUN: %clang --target=riscv32 -menable-experimental-extensions \
// RUN: -march=rv32i_zicfilp1p0 -fcf-protection=full -E -dM %s -o - | \
// RUN: FileCheck --check-prefixes=LPAD-MACRO,FUNC-SIG-MACRO %s

// RUN: %clang --target=riscv32 -menable-experimental-extensions \
// RUN: -march=rv32i_zicfilp1p0 -fcf-protection=full \
// RUN: -mcf-branch-label-scheme=unlabeled -E -dM %s -o - | FileCheck \
// RUN: --check-prefixes=LPAD-MACRO,UNLABELED-MACRO %s

// RUN: %clang --target=riscv32 -menable-experimental-extensions \
// RUN: -march=rv32i_zicfilp1p0 -fcf-protection=full \
// RUN: -mcf-branch-label-scheme=func-sig -E -dM %s -o - | FileCheck \
// RUN: --check-prefixes=LPAD-MACRO,FUNC-SIG-MACRO %s

// RUN: %clang --target=riscv32 -menable-experimental-extensions \
// RUN: -march=rv32i_zicfilp1p0 -E -dM %s -o - 2>&1 | \
// RUN: FileCheck --check-prefixes=NO-MACRO %s

// RUN: %clang --target=riscv32 -menable-experimental-extensions \
// RUN: -march=rv32i_zicfilp1p0 -mcf-branch-label-scheme=unlabeled -E -dM %s \
// RUN: -o - 2>&1 | FileCheck --check-prefixes=NO-MACRO %s

// RUN: %clang --target=riscv32 -menable-experimental-extensions \
// RUN: -march=rv32i_zicfilp1p0 -mcf-branch-label-scheme=func-sig -E -dM %s \
// RUN: -o - 2>&1 | FileCheck --check-prefixes=NO-MACRO %s

// RUN: %clang --target=riscv32 -fcf-protection=branch -E -dM -emit-llvm %s \
// RUN: -o - | FileCheck --check-prefixes=LPAD-MACRO,FUNC-SIG-MACRO %s

// RUN: %clang --target=riscv32 -fcf-protection=branch \
// RUN: -mcf-branch-label-scheme=unlabeled -E -dM -emit-llvm %s -o - | \
// RUN: FileCheck --check-prefixes=LPAD-MACRO,UNLABELED-MACRO %s

// RUN: %clang --target=riscv32 -fcf-protection=branch \
// RUN: -mcf-branch-label-scheme=func-sig -E -dM %s -o - | FileCheck \
// RUN: --check-prefixes=LPAD-MACRO,FUNC-SIG-MACRO %s

// RUN: %clang --target=riscv32 -fcf-protection=full -E -dM -emit-llvm %s \
// RUN: -o - | FileCheck --check-prefixes=LPAD-MACRO,FUNC-SIG-MACRO %s

// RUN: %clang --target=riscv32 -fcf-protection=full \
// RUN: -mcf-branch-label-scheme=unlabeled -E -dM -emit-llvm %s -o - | \
// RUN: FileCheck --check-prefixes=LPAD-MACRO,UNLABELED-MACRO %s

// RUN: %clang --target=riscv32 -fcf-protection=full \
// RUN: -mcf-branch-label-scheme=func-sig -E -dM %s -o - | FileCheck \
// RUN: --check-prefixes=LPAD-MACRO,FUNC-SIG-MACRO %s

// RUN: %clang --target=riscv32 -E -dM %s -o - 2>&1 | \
// RUN: FileCheck --check-prefixes=NO-MACRO %s

// RUN: %clang --target=riscv32 -mcf-branch-label-scheme=unlabeled -E -dM %s \
// RUN: -o - 2>&1 | FileCheck --check-prefixes=NO-MACRO %s

// RUN: %clang --target=riscv32 -mcf-branch-label-scheme=func-sig -E -dM %s \
// RUN: -o - 2>&1 | FileCheck --check-prefixes=NO-MACRO %s

// RUN: %clang --target=riscv64 -menable-experimental-extensions \
// RUN: -march=rv64i_zicfilp1p0 -fcf-protection=branch -E -dM %s -o - | \
// RUN: FileCheck --check-prefixes=LPAD-MACRO,FUNC-SIG-MACRO %s

// RUN: %clang --target=riscv64 -menable-experimental-extensions \
// RUN: -march=rv64i_zicfilp1p0 -fcf-protection=branch \
// RUN: -mcf-branch-label-scheme=unlabeled -E -dM %s -o - | FileCheck \
// RUN: --check-prefixes=LPAD-MACRO,UNLABELED-MACRO %s

// RUN: %clang --target=riscv64 -menable-experimental-extensions \
// RUN: -march=rv64i_zicfilp1p0 -fcf-protection=branch \
// RUN: -mcf-branch-label-scheme=func-sig -E -dM %s -o - | FileCheck \
// RUN: --check-prefixes=LPAD-MACRO,FUNC-SIG-MACRO %s

// RUN: %clang --target=riscv64 -menable-experimental-extensions \
// RUN: -march=rv64i_zicfilp1p0 -fcf-protection=full -E -dM %s -o - | \
// RUN: FileCheck --check-prefixes=LPAD-MACRO,FUNC-SIG-MACRO %s

// RUN: %clang --target=riscv64 -menable-experimental-extensions \
// RUN: -march=rv64i_zicfilp1p0 -fcf-protection=full \
// RUN: -mcf-branch-label-scheme=unlabeled -E -dM %s -o - | FileCheck \
// RUN: --check-prefixes=LPAD-MACRO,UNLABELED-MACRO %s

// RUN: %clang --target=riscv64 -menable-experimental-extensions \
// RUN: -march=rv64i_zicfilp1p0 -fcf-protection=full \
// RUN: -mcf-branch-label-scheme=func-sig -E -dM %s -o - | FileCheck \
// RUN: --check-prefixes=LPAD-MACRO,FUNC-SIG-MACRO %s

// RUN: %clang --target=riscv64 -menable-experimental-extensions \
// RUN: -march=rv64i_zicfilp1p0 -E -dM %s -o - 2>&1 | \
// RUN: FileCheck --check-prefixes=NO-MACRO %s

// RUN: %clang --target=riscv64 -menable-experimental-extensions \
// RUN: -march=rv64i_zicfilp1p0 -mcf-branch-label-scheme=unlabeled -E -dM %s \
// RUN: -o - 2>&1 | FileCheck --check-prefixes=NO-MACRO %s

// RUN: %clang --target=riscv64 -menable-experimental-extensions \
// RUN: -march=rv64i_zicfilp1p0 -mcf-branch-label-scheme=func-sig -E -dM %s \
// RUN: -o - 2>&1 | FileCheck --check-prefixes=NO-MACRO %s

// RUN: %clang --target=riscv64 -fcf-protection=branch -E -dM %s -o - | \
// RUN: FileCheck --check-prefixes=LPAD-MACRO,FUNC-SIG-MACRO %s

// RUN: %clang --target=riscv64 -fcf-protection=branch \
// RUN: -mcf-branch-label-scheme=unlabeled -E -dM %s -o - | FileCheck \
// RUN: --check-prefixes=LPAD-MACRO,UNLABELED-MACRO %s

// RUN: %clang --target=riscv64 -fcf-protection=branch \
// RUN: -mcf-branch-label-scheme=func-sig -E -dM %s -o - | FileCheck \
// RUN: --check-prefixes=LPAD-MACRO,FUNC-SIG-MACRO %s

// RUN: %clang --target=riscv64 -fcf-protection=full -E -dM %s -o - | \
// RUN: FileCheck --check-prefixes=LPAD-MACRO,FUNC-SIG-MACRO %s

// RUN: %clang --target=riscv64 -fcf-protection=full \
// RUN: -mcf-branch-label-scheme=unlabeled -E -dM %s -o - | FileCheck \
// RUN: --check-prefixes=LPAD-MACRO,UNLABELED-MACRO %s

// RUN: %clang --target=riscv64 -fcf-protection=full \
// RUN: -mcf-branch-label-scheme=func-sig -E -dM %s -o - | FileCheck \
// RUN: --check-prefixes=LPAD-MACRO,FUNC-SIG-MACRO %s

// RUN: %clang --target=riscv64 -E -dM %s -o - 2>&1 | \
// RUN: FileCheck --check-prefixes=NO-MACRO %s

// RUN: %clang --target=riscv64 -mcf-branch-label-scheme=unlabeled -E -dM %s \
// RUN: -o - 2>&1 | FileCheck --check-prefixes=NO-MACRO %s

// RUN: %clang --target=riscv64 -mcf-branch-label-scheme=func-sig -E -dM %s \
// RUN: -o - 2>&1 | FileCheck --check-prefixes=NO-MACRO %s

// LPAD-MACRO: __riscv_landing_pad 1{{$}}
// UNLABELED-MACRO: __riscv_landing_pad_unlabeled 1{{$}}
// FUNC-SIG-MACRO: __riscv_landing_pad_func_sig 1{{$}}
// NO-MACRO-NOT: __riscv_landing_pad
// NO-MACRO-NOT: __riscv_landing_pad_unlabeled
// NO-MACRO-NOT: __riscv_landing_pad_func_sig