Drop our aliases for QCHECK().

Now that Abseil has released logging, we are removing many of our macros in favor of the Abseil macros they alias. See also the github issue. Work towards google#1318. PiperOrigin-RevId: 610789664
seiry · Feb 27, 2024 · e4d3071 · e4d3071
1 parent 9984073
commit e4d3071
Show file tree

Hide file tree

Showing 48 changed files with 188 additions and 183 deletions.
diff --git a/third_party/xls_berkeley_softfloat/BUILD b/third_party/xls_berkeley_softfloat/BUILD
@@ -60,6 +60,7 @@ cc_test(
     tags = ["optonly"],
     deps = [
         ":fpdiv_2x32_jit_wrapper",
+        "@com_google_absl//absl/flags:flag",
         "@com_google_absl//absl/random",
         "@com_google_absl//absl/status",
         "@com_google_absl//absl/strings:str_format",

diff --git a/third_party/xls_berkeley_softfloat/fpdiv_2x32_test.cc b/third_party/xls_berkeley_softfloat/fpdiv_2x32_test.cc
@@ -27,6 +27,7 @@
 #include <cmath>
 #include <tuple>
 
+#include "absl/flags/flag.h"
 #include "absl/random/random.h"
 #include "absl/status/status.h"
 #include "absl/strings/str_format.h"
@@ -118,8 +119,8 @@ absl::Status RealMain(bool use_opt_ir, uint64_t num_samples, int num_threads) {
 
 int main(int argc, char** argv) {
   xls::InitXls(argv[0], argc, argv);
-  XLS_QCHECK_OK(xls::RealMain(absl::GetFlag(FLAGS_use_opt_ir),
-                              absl::GetFlag(FLAGS_num_samples),
-                              absl::GetFlag(FLAGS_num_threads)));
+  QCHECK_OK(xls::RealMain(absl::GetFlag(FLAGS_use_opt_ir),
+                          absl::GetFlag(FLAGS_num_samples),
+                          absl::GetFlag(FLAGS_num_threads)));
   return 0;
 }
diff --git a/third_party/xls_go_math/BUILD b/third_party/xls_go_math/BUILD
@@ -78,6 +78,7 @@ cc_test(
     tags = ["optonly"],
     deps = [
         ":fpexp_32_jit_wrapper",
+        "@com_google_absl//absl/flags:flag",
         "@com_google_absl//absl/random",
         "@com_google_absl//absl/status",
         "//xls/common:init_xls",
@@ -150,6 +151,7 @@ cc_test(
     tags = ["optonly"],
     deps = [
         ":fp_sincos_32_jit_wrapper",
+        "@com_google_absl//absl/flags:flag",
         "@com_google_absl//absl/random",
         "@com_google_absl//absl/status",
         "//xls/common:init_xls",
@@ -214,6 +216,7 @@ cc_test(
     tags = ["optonly"],
     deps = [
         ":fp_trig_reduce_jit_wrapper",
+        "@com_google_absl//absl/flags:flag",
         "@com_google_absl//absl/numeric:int128",
         "@com_google_absl//absl/random",
         "@com_google_absl//absl/status",
@@ -275,6 +278,7 @@ cc_test(
     tags = ["optonly"],
     deps = [
         ":fpsqrt_32_jit_wrapper",
+        "@com_google_absl//absl/flags:flag",
         "@com_google_absl//absl/random",
         "@com_google_absl//absl/status",
         "//xls/common:init_xls",

diff --git a/third_party/xls_go_math/fp_sincos_32_test.cc b/third_party/xls_go_math/fp_sincos_32_test.cc
@@ -7,6 +7,7 @@
 #include <cmath>
 #include <tuple>
 
+#include "absl/flags/flag.h"
 #include "absl/random/random.h"
 #include "absl/status/status.h"
 #include "xls/common/file/get_runfile_path.h"
@@ -120,7 +121,7 @@ absl::Status RealMain(uint32_t num_samples, int num_threads) {
 
 int main(int argc, char** argv) {
   xls::InitXls(argv[0], argc, argv);
-  XLS_QCHECK_OK(xls::RealMain(absl::GetFlag(FLAGS_num_samples),
-                              absl::GetFlag(FLAGS_num_threads)));
+  QCHECK_OK(xls::RealMain(absl::GetFlag(FLAGS_num_samples),
+                          absl::GetFlag(FLAGS_num_threads)));
   return 0;
 }
diff --git a/third_party/xls_go_math/fp_trig_reduce_64_test.cc b/third_party/xls_go_math/fp_trig_reduce_64_test.cc
@@ -8,6 +8,7 @@
 #include <cmath>
 #include <tuple>
 
+#include "absl/flags/flag.h"
 #include "absl/numeric/int128.h"
 #include "absl/random/random.h"
 #include "absl/status/status.h"
@@ -205,8 +206,8 @@ absl::Status RealMain(bool use_opt_ir, uint64_t num_samples, int num_threads) {
 
 int main(int argc, char** argv) {
   xls::InitXls(argv[0], argc, argv);
-  XLS_QCHECK_OK(xls::RealMain(absl::GetFlag(FLAGS_use_opt_ir),
-                              absl::GetFlag(FLAGS_num_samples),
-                              absl::GetFlag(FLAGS_num_threads)));
+  QCHECK_OK(xls::RealMain(absl::GetFlag(FLAGS_use_opt_ir),
+                          absl::GetFlag(FLAGS_num_samples),
+                          absl::GetFlag(FLAGS_num_threads)));
   return 0;
 }
diff --git a/third_party/xls_go_math/fpexp_32_test.cc b/third_party/xls_go_math/fpexp_32_test.cc
@@ -6,6 +6,7 @@
 #include <cmath>
 #include <limits>
 
+#include "absl/flags/flag.h"
 #include "absl/random/random.h"
 #include "absl/status/status.h"
 #include "xls/common/file/get_runfile_path.h"
@@ -96,7 +97,7 @@ absl::Status RealMain(uint64_t num_samples, int num_threads) {
 
 int main(int argc, char** argv) {
   xls::InitXls(argv[0], argc, argv);
-  XLS_QCHECK_OK(xls::RealMain(absl::GetFlag(FLAGS_num_samples),
-                              absl::GetFlag(FLAGS_num_threads)));
+  QCHECK_OK(xls::RealMain(absl::GetFlag(FLAGS_num_samples),
+                          absl::GetFlag(FLAGS_num_threads)));
   return 0;
 }
diff --git a/third_party/xls_go_math/fpsqrt_32_test.cc b/third_party/xls_go_math/fpsqrt_32_test.cc
@@ -7,6 +7,7 @@
 #include <cmath>
 #include <limits>
 
+#include "absl/flags/flag.h"
 #include "absl/random/random.h"
 #include "absl/status/status.h"
 #include "xls/common/file/get_runfile_path.h"
@@ -73,7 +74,7 @@ absl::Status RealMain(uint64_t num_samples, int num_threads) {
 
 int main(int argc, char** argv) {
   xls::InitXls(argv[0], argc, argv);
-  XLS_QCHECK_OK(xls::RealMain(absl::GetFlag(FLAGS_num_samples),
-                              absl::GetFlag(FLAGS_num_threads)));
+  QCHECK_OK(xls::RealMain(absl::GetFlag(FLAGS_num_samples),
+                          absl::GetFlag(FLAGS_num_threads)));
   return 0;
 }
diff --git a/third_party/xls_machsuite/fft/fft_reference.cc b/third_party/xls_machsuite/fft/fft_reference.cc
@@ -166,6 +166,6 @@ absl::Status RealMain() {
 
 int main(int argc, char** argv) {
   xls::InitXls(argv[0], argc, argv);
-  XLS_QCHECK_OK(xls::RealMain());
+  QCHECK_OK(xls::RealMain());
   return 0;
 }
diff --git a/xls/common/logging/logging.h b/xls/common/logging/logging.h
@@ -38,7 +38,7 @@
 // Even seemingly unconditional statements like `XLS_LOG(INFO)` might be
 // disabled at compile-time to minimize binary size or for security reasons.
 //
-// * Except for the condition in a `XLS_CHECK` or `XLS_QCHECK` statement,
+// * Except for the condition in a `XLS_CHECK` or `QCHECK` statement,
 //   programs must not rely on evaluation of expressions anywhere in logging
 //   statements for correctness.  For example, this is ok:
 //
@@ -221,16 +221,7 @@
 #define XLS_CHECK_GE(val1, val2) CHECK_GE(val1, val2)
 #define XLS_CHECK_GT(val1, val2) CHECK_GT(val1, val2)
 
-#define XLS_QCHECK(condition) QCHECK(condition)
-#define XLS_QCHECK_EQ(val1, val2) QCHECK_EQ(val1, val2)
-#define XLS_QCHECK_NE(val1, val2) QCHECK_NE(val1, val2)
-#define XLS_QCHECK_LE(val1, val2) QCHECK_LE(val1, val2)
-#define XLS_QCHECK_LT(val1, val2) QCHECK_LT(val1, val2)
-#define XLS_QCHECK_GE(val1, val2) QCHECK_GE(val1, val2)
-#define XLS_QCHECK_GT(val1, val2) QCHECK_GT(val1, val2)
-
 #define XLS_CHECK_OK(val) CHECK_OK(val)
-#define XLS_QCHECK_OK(val) QCHECK_OK(val)
 
 
 #endif  // XLS_COMMON_LOGGING_LOGGING_H_
diff --git a/xls/common/logging/logging_test.cc b/xls/common/logging/logging_test.cc
@@ -117,7 +117,7 @@ TEST_F(LoggingTest, CheckPrintsStackTraceWhenConditionFails) {
 }
 
 TEST_F(LoggingTest, QcheckDoesNothingWhenConditionHolds) {
-  XLS_QCHECK(true);
+  QCHECK(true);
 
   EXPECT_EQ(entries_.size(), 0);
 }
@@ -126,7 +126,7 @@ TEST_F(LoggingTest, QcheckCrashesWhenConditionFails) {
   EXPECT_DEATH(
       {
         bool condition_variable = false;
-        XLS_QCHECK(condition_variable);
+        QCHECK(condition_variable);
       },
       HasSubstr("condition_variable"));
 }
@@ -201,63 +201,63 @@ TEST_F(LoggingTest, CheckGtCrashesWhenConditionFails) {
 }
 
 TEST_F(LoggingTest, QcheckEqDoesNothingWhenConditionHolds) {
-  XLS_QCHECK_EQ(1, 1);
+  QCHECK_EQ(1, 1);
 
   EXPECT_EQ(entries_.size(), 0);
 }
 
 TEST_F(LoggingTest, QcheckEqCrashesWhenConditionFails) {
-  EXPECT_DEATH({ XLS_QCHECK_EQ(1, 2); }, HasSubstr("1 == 2"));
+  EXPECT_DEATH({ QCHECK_EQ(1, 2); }, HasSubstr("1 == 2"));
 }
 
 TEST_F(LoggingTest, QcheckNeDoesNothingWhenConditionHolds) {
-  XLS_QCHECK_NE(1, 2);
+  QCHECK_NE(1, 2);
 
   EXPECT_EQ(entries_.size(), 0);
 }
 
 TEST_F(LoggingTest, QcheckNeCrashesWhenConditionFails) {
-  EXPECT_DEATH({ XLS_QCHECK_NE(1, 1); }, HasSubstr("1 != 1"));
+  EXPECT_DEATH({ QCHECK_NE(1, 1); }, HasSubstr("1 != 1"));
 }
 
 TEST_F(LoggingTest, QcheckLeDoesNothingWhenConditionHolds) {
-  XLS_QCHECK_LE(1, 1);
+  QCHECK_LE(1, 1);
 
   EXPECT_EQ(entries_.size(), 0);
 }
 
 TEST_F(LoggingTest, QcheckLeCrashesWhenConditionFails) {
-  EXPECT_DEATH({ XLS_QCHECK_LE(2, 1); }, HasSubstr("2 <= 1"));
+  EXPECT_DEATH({ QCHECK_LE(2, 1); }, HasSubstr("2 <= 1"));
 }
 
 TEST_F(LoggingTest, QcheckLtDoesNothingWhenConditionHolds) {
-  XLS_QCHECK_LT(1, 2);
+  QCHECK_LT(1, 2);
 
   EXPECT_EQ(entries_.size(), 0);
 }
 
 TEST_F(LoggingTest, QcheckLtCrashesWhenConditionFails) {
-  EXPECT_DEATH({ XLS_QCHECK_LT(1, 1); }, HasSubstr("1 < 1"));
+  EXPECT_DEATH({ QCHECK_LT(1, 1); }, HasSubstr("1 < 1"));
 }
 
 TEST_F(LoggingTest, QcheckGeDoesNothingWhenConditionHolds) {
-  XLS_QCHECK_GE(1, 1);
+  QCHECK_GE(1, 1);
 
   EXPECT_EQ(entries_.size(), 0);
 }
 
 TEST_F(LoggingTest, QcheckGeCrashesWhenConditionFails) {
-  EXPECT_DEATH({ XLS_QCHECK_GE(1, 2); }, HasSubstr("1 >= 2"));
+  EXPECT_DEATH({ QCHECK_GE(1, 2); }, HasSubstr("1 >= 2"));
 }
 
 TEST_F(LoggingTest, QcheckGtDoesNothingWhenConditionHolds) {
-  XLS_QCHECK_GT(2, 1);
+  QCHECK_GT(2, 1);
 
   EXPECT_EQ(entries_.size(), 0);
 }
 
 TEST_F(LoggingTest, QcheckGtCrashesWhenConditionFails) {
-  EXPECT_DEATH({ XLS_QCHECK_GT(1, 1); }, HasSubstr("1 > 1"));
+  EXPECT_DEATH({ QCHECK_GT(1, 1); }, HasSubstr("1 > 1"));
 }
 
 TEST_F(LoggingTest, CheckOkDoesNothingWithOkStatus) {
@@ -277,19 +277,20 @@ TEST_F(LoggingTest, CheckOkCrashesWithStackTrace) {
 }
 
 TEST_F(LoggingTest, QcheckOkDoesNothingWithOkStatus) {
-  XLS_QCHECK_OK(absl::OkStatus());
+  QCHECK_OK(absl::OkStatus());
 
   EXPECT_EQ(entries_.size(), 0);
 }
 
 TEST_F(LoggingTest, QcheckOkCrashesWithNonOkStatus) {
-  EXPECT_DEATH({ XLS_QCHECK_OK(absl::UnknownError("error_msg")); },
-               HasSubstr("error_msg"));
+  EXPECT_DEATH(
+      { QCHECK_OK(absl::UnknownError("error_msg")); }, HasSubstr("error_msg"));
 }
 
 TEST_F(LoggingTest, QcheckOkCrashesWithoutStackTrace) {
-  EXPECT_DEATH({ XLS_QCHECK_OK(absl::UnknownError("error_msg")); },
-               Not(HasSubstr("CheckOkCrashesWithStackTrace")));
+  EXPECT_DEATH(
+      { QCHECK_OK(absl::UnknownError("error_msg")); },
+      Not(HasSubstr("CheckOkCrashesWithStackTrace")));
 }
 
 }  // namespace

diff --git a/xls/contrib/xlscc/xlscc_logging.h b/xls/contrib/xlscc/xlscc_logging.h
@@ -17,8 +17,7 @@
 
 #define XLSCC_CHECK(condition, loc) \
   XLS_CHECK(condition) << ErrorMessage(loc, "")
-#define XLSCC_QCHECK(condition, loc) \
-  XLS_QCHECK(condition) << ErrorMessage(loc, "")
+#define XLSCC_QCHECK(condition, loc) QCHECK(condition) << ErrorMessage(loc, "")
 #define XLSCC_DCHECK(condition, loc) DCHECK(condition) << ErrorMessage(loc, "")
 
 #define XLSCC_CHECK_EQ(val1, val2, loc) \
@@ -34,17 +33,17 @@
 #define XLSCC_CHECK_GT(val1, val2, loc) \
   XLS_CHECK_GT(val1, val2) << ErrorMessage(loc, "")
 #define XLSCC_QCHECK_EQ(val1, val2, loc) \
-  XLS_QCHECK_EQ(val1, val2) << ErrorMessage(loc, "")
+  QCHECK_EQ(val1, val2) << ErrorMessage(loc, "")
 #define XLSCC_QCHECK_NE(val1, val2, loc) \
-  XLS_QCHECK_NE(val1, val2) << ErrorMessage(loc, "")
+  QCHECK_NE(val1, val2) << ErrorMessage(loc, "")
 #define XLSCC_QCHECK_LE(val1, val2, loc) \
-  XLS_QCHECK_LE(val1, val2) << ErrorMessage(loc, "")
+  QCHECK_LE(val1, val2) << ErrorMessage(loc, "")
 #define XLSCC_QCHECK_LT(val1, val2, loc) \
-  XLS_QCHECK_LT(val1, val2) << ErrorMessage(loc, "")
+  QCHECK_LT(val1, val2) << ErrorMessage(loc, "")
 #define XLSCC_QCHECK_GE(val1, val2, loc) \
-  XLS_QCHECK_GE(val1, val2) << ErrorMessage(loc, "")
+  QCHECK_GE(val1, val2) << ErrorMessage(loc, "")
 #define XLSCC_QCHECK_GT(val1, val2, loc) \
-  XLS_QCHECK_GT(val1, val2) << ErrorMessage(loc, "")
+  QCHECK_GT(val1, val2) << ErrorMessage(loc, "")
 
 #define XLSCC_DCHECK_EQ(val1, val2, loc) \
   XLSCC_CHECK_EQ(val1, val2) << ErrorMessage(loc, "")
@@ -60,7 +59,7 @@
   XLSCC_CHECK_GT(val1, val2) << ErrorMessage(loc, "")
 
 #define XLSCC_CHECK_OK(val, loc) XLS_CHECK_EQ(val) << ErrorMessage(loc, "")
-#define XLSCC_QCHECK_OK(val, loc) XLS_QCHECK_EQ(val) << ErrorMessage(loc, "")
+#define XLSCC_QCHECK_OK(val, loc) QCHECK_EQ(val) << ErrorMessage(loc, "")
 #define XLSCC_DCHECK_OK(val, loc) DCHECK_EQ(val) << ErrorMessage(loc), ""
 
 #endif  // XLSCC_COMMON_LOGGING_LOGGING_H_
diff --git a/xls/dslx/bytecode/bytecode_interpreter.cc b/xls/dslx/bytecode/bytecode_interpreter.cc
@@ -1660,8 +1660,7 @@ absl::StatusOr<ProcRunResult> ProcInstance::Run() {
     if (next_args_.size() == proc_->members().size() + 2) {
       next_args_[proc_->members().size() + 1] = result_value;
     } else {
-      XLS_QCHECK(result_value.IsTuple() &&
-                 result_value.GetLength().value() == 0);
+      QCHECK(result_value.IsTuple() && result_value.GetLength().value() == 0);
     }
 
     XLS_RETURN_IF_ERROR(interpreter_->InitFrame(next_fn_.get(), next_args_,

diff --git a/xls/dslx/cpp_transpiler/cpp_transpiler_main.cc b/xls/dslx/cpp_transpiler/cpp_transpiler_main.cc
@@ -88,10 +88,10 @@ int main(int argc, char* argv[]) {
   }
 
   std::string output_header_path = absl::GetFlag(FLAGS_output_header_path);
-  XLS_QCHECK(!output_header_path.empty())
+  QCHECK(!output_header_path.empty())
       << "--output_header_path must be specified.";
   std::string output_source_path = absl::GetFlag(FLAGS_output_source_path);
-  XLS_QCHECK(!output_source_path.empty())
+  QCHECK(!output_source_path.empty())
       << "--output_source_path must be specified.";
   return xls::ExitStatus(xls::dslx::RealMain(
       args[0], absl::GetFlag(FLAGS_dslx_stdlib_path), output_header_path,

diff --git a/xls/dslx/interpreter_main.cc b/xls/dslx/interpreter_main.cc
@@ -237,8 +237,8 @@ int main(int argc, char* argv[]) {
     absl::StatusOr<xls::FormatPreference> flag_preference =
         xls::FormatPreferenceFromString(absl::GetFlag(FLAGS_format_preference));
     // `default` is not a legal overriding format preference.
-    XLS_QCHECK(flag_preference.ok() &&
-               absl::GetFlag(FLAGS_format_preference) != "default")
+    QCHECK(flag_preference.ok() &&
+           absl::GetFlag(FLAGS_format_preference) != "default")
         << "-format_preference accepts binary|hex|decimal";
     preference = flag_preference.value();
   }

diff --git a/xls/dslx/ir_convert/ir_converter_main.cc b/xls/dslx/ir_convert/ir_converter_main.cc
@@ -102,12 +102,12 @@ absl::Status RealMain(absl::Span<const std::string_view> paths,
   // The following checks are performed inside ConvertFilesToPackage(), but we
   // reproduce them here to give nicer error messages.
   if (!package_name.has_value()) {
-    XLS_QCHECK_EQ(paths.size(), 1)
+    QCHECK_EQ(paths.size(), 1)
         << "-package_name *must* be given when multiple input paths are "
            "supplied";
   }
   if (paths.size() > 1) {
-    XLS_QCHECK(!top.has_value())
+    QCHECK(!top.has_value())
         << "-entry cannot be supplied with multiple input paths (need a single "
            "input path to know where to resolve the entry function)";
   }

diff --git a/xls/dslx/type_system/BUILD b/xls/dslx/type_system/BUILD
@@ -616,13 +616,16 @@ cc_binary(
     deps = [
         ":type_info_to_proto",
         "@com_google_absl//absl/flags:flag",
+        "@com_google_absl//absl/log:check",
         "@com_google_absl//absl/status",
         "@com_google_absl//absl/status:statusor",
         "@com_google_absl//absl/strings",
         "@com_google_absl//absl/types:span",
         "//xls/common:exit_status",
         "//xls/common:init_xls",
         "//xls/common/file:filesystem",
+        "//xls/common/logging",
+        "//xls/common/status:status_macros",
         "//xls/dslx:command_line_utils",
         "//xls/dslx:create_import_data",
         "//xls/dslx:default_dslx_stdlib_path",