llvm-project/clang/test/CodeGenCXX/attr-likelihood-if-vs-builtin-expect.cpp

// RUN: %clang_cc1 -O1 -disable-llvm-passes -emit-llvm %s -o - -triple=x86_64-linux-gnu | opt -passes=lower-expect -S | FileCheck %s

// Verifies the output of __builtin_expect versus the output of the likelihood
// attributes. They should generate the same probabilities for the branches.

extern bool a();
extern bool b();
extern bool c();

void ab1(int &i) {
  // CHECK-LABEL: define{{.*}}ab1
  // CHECK: br {{.*}} !prof [[BW_LIKELY:!.+]]
  // CHECK: br {{.*}} !prof [[BW_LIKELY]]
  // CHECK: br {{.*}} !prof [[BW_LIKELY]]
  if (__builtin_expect(a() && b() && a(), 1)) {
    ++i;
  } else {
    --i;
  }
}

void al(int &i) {
  // CHECK-LABEL: define{{.*}}al
  // CHECK: br {{.*}} !prof [[BW_LIKELY]]
  // CHECK: br {{.*}} !prof [[BW_LIKELY]]
  // CHECK: br {{.*}} !prof [[BW_LIKELY]]
  if (a() && b() && c()) [[likely]] {
    ++i;
  } else {
    --i;
  }
}

void ab0(int &i) {
  // CHECK-LABEL: define{{.*}}ab0
  // CHECK: br {{.*}}end{{$}}
  // CHECK: br {{.*}}end{{$}}
  // CHECK: br {{.*}}end{{$}}
  // CHECK: br {{.*}} !prof [[BW_UNLIKELY:!.+]]
  if (__builtin_expect(a() && b() && c(), 0)) {
    ++i;
  } else {
    --i;
  }
}

void au(int &i) {
  // CHECK-LABEL: define{{.*}}au
  // CHECK: br {{.*}}else{{$}}
  // CHECK: br {{.*}}else{{$}}
  // CHECK: br {{.*}} !prof [[BW_UNLIKELY]]
  if (a() && b() && c()) [[unlikely]] {
    ++i;
  } else {
    --i;
  }
}

void ob1(int &i) {
  // CHECK-LABEL: define{{.*}}ob1
  // CHECK: br {{.*}}false{{$}}
  // CHECK: br {{.*}}rhs{{$}}
  // CHECK: br {{.*}}end{{$}}
  // CHECK: br {{.*}} !prof [[BW_LIKELY]]
  if (__builtin_expect(a() || b() || a(), 1)) {
    i = 0;
  } else {
    --i;
  }
}

void ol(int &i) {
  // CHECK-LABEL: define{{.*}}ol
  // CHECK: br {{.*}}false{{$}}
  // CHECK: br {{.*}}false2{{$}}
  // CHECK: br {{.*}} !prof [[BW_LIKELY]]
  if (a() || b() || c()) [[likely]] {
    i = 0;
  } else {
    --i;
  }
}

void ob0(int &i) {
  // CHECK-LABEL: define{{.*}}ob0
  // CHECK: br {{.*}} !prof [[BW_UNLIKELY]]
  // CHECK: br {{.*}} !prof [[BW_UNLIKELY]]
  // CHECK: br {{.*}} !prof [[BW_UNLIKELY]]
  if (__builtin_expect(a() || b() || c(), 0)) {
    i = 0;
  } else {
    --i;
  }
}

void ou(int &i) {
  // CHECK-LABEL: define{{.*}}ou
  // CHECK: br {{.*}} !prof [[BW_UNLIKELY]]
  // CHECK: br {{.*}} !prof [[BW_UNLIKELY]]
  // CHECK: br {{.*}} !prof [[BW_UNLIKELY]]
  if (a() || b() || c()) [[unlikely]] {
    i = 0;
  } else {
    --i;
  }
}

void nb1(int &i) {
  // CHECK-LABEL: define{{.*}}nb1
  // CHECK: br {{.*}} !prof [[BW_LIKELY]]
  if (__builtin_expect(!a(), 1)) {
    ++i;
  } else {
    --i;
  }
}

void nl(int &i) {
  // CHECK-LABEL: define{{.*}}nl
  // CHECK: br {{.*}} !prof [[BW_LIKELY]]
  if (bool d = !a()) [[likely]] {
    ++i;
  } else {
    --i;
  }
}

void nb0(int &i) {
  // CHECK-LABEL: define{{.*}}nb0
  // CHECK: br {{.*}} !prof [[BW_UNLIKELY]]
  if (__builtin_expect(!a(), 0)) {
    ++i;
  } else {
    --i;
  }
}

void nu(int &i) {
  // CHECK-LABEL: define{{.*}}nu
  // CHECK: br {{.*}} !prof [[BW_UNLIKELY]]
  if (bool d = !a()) [[unlikely]] {
    ++i;
  } else {
    --i;
  }
}

void tb1(int &i) {
  // CHECK-LABEL: define{{.*}}tb1
  // CHECK: br {{.*}}false{{$}}
  // CHECK: br {{.*}}end{{$}}
  // CHECK: br {{.*}}end{{$}}
  // CHECK: br {{.*}} !prof [[BW_LIKELY]]
  if (__builtin_expect(a() ? b() : c(), 1)) {
    ++i;
  } else {
    --i;
  }
}

void tl(int &i) {
  // CHECK-LABEL: define{{.*}}tl
  // CHECK: br {{.*}}false{{$}}
  // CHECK: br {{.*}}end{{$}}
  // CHECK: br {{.*}}end{{$}}
  // CHECK: br {{.*}} !prof [[BW_LIKELY]]
  if (bool d = a() ? b() : c()) [[likely]] {
    ++i;
  } else {
    --i;
  }
}

void tl2(int &i) {
  // CHECK-LABEL: define{{.*}}tl
  // CHECK: br {{.*}}false{{$}}
  // CHECK: br {{.*}} !prof [[BW_LIKELY]]
  // CHECK: br {{.*}} !prof [[BW_LIKELY]]
  if (a() ? b() : c()) [[likely]] {
    ++i;
  } else {
    --i;
  }
}

void tb0(int &i) {
  // CHECK-LABEL: define{{.*}}tb0
  // CHECK: br {{.*}}false{{$}}
  // CHECK: br {{.*}}end{{$}}
  // CHECK: br {{.*}}end{{$}}
  // CHECK: br {{.*}} !prof [[BW_UNLIKELY]]
  if (__builtin_expect(a() ? b() : c(), 0)) {
    ++i;
  } else {
    --i;
  }
}

void tu(int &i) {
  // CHECK-LABEL: define{{.*}}tu
  // CHECK: br {{.*}}false{{$}}
  // CHECK: br {{.*}}end{{$}}
  // CHECK: br {{.*}}end{{$}}
  // CHECK: br {{.*}} !prof [[BW_UNLIKELY]]
  if (bool d = a() ? b() : c()) [[unlikely]] {
    ++i;
  } else {
    --i;
  }
}

void tu2(int &i) {
  // CHECK-LABEL: define{{.*}}tu
  // CHECK: br {{.*}}false{{$}}
  // CHECK: br {{.*}} !prof [[BW_UNLIKELY]]
  // CHECK: br {{.*}} !prof [[BW_UNLIKELY]]
  if (a() ? b() : c()) [[unlikely]] {
    ++i;
  } else {
    --i;
  }
}

// CHECK: [[BW_LIKELY]] = !{!"branch_weights", !"expected", i32 2000, i32 1}
// CHECK: [[BW_UNLIKELY]] = !{!"branch_weights", !"expected", i32 1, i32 2000}