Refactor Bazel build with custom proto rules and build all test targets

Author: chenBright

.bazelrc

@@ -13,11 +13,21 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-#
+# Bazel doesn't need more than 200MB of memory for local build based on memory profiling:
+# https://docs.bazel.build/versions/master/skylark/performance.html#memory-profiling
+# The default JVM max heapsize is 1/4 of physical memory up to 32GB which could be large
+# enough to consume all memory constrained by cgroup in large host.
+# Limiting JVM heapsize here to let it do GC more when approaching the limit to
+# leave room for compiler/linker.
+# The number 3G is chosen heuristically to both support large VM and small VM with RBE.
+# Startup options cannot be selected via config.
+startup --host_jvm_args=-Xmx3g
+startup --host_jvm_args="-DBAZEL_TRACK_SOURCE_DIRECTORIES=1"
+
 # Default build options. These are applied first and unconditionally.
-#
 common --registry=https://bcr.bazel.build
 common --registry=https://baidu.github.io/babylon/registry
+common --registry=https://raw.githubusercontent.com/apache/brpc/master/registry
 
 build --cxxopt="-std=c++17"
 build --copt="-fno-omit-frame-pointer"
@@ -33,12 +43,39 @@ build --features=per_object_debug_info
 # We already have absl in the build, define absl=1 to tell googletest to use absl for backtrace.
 build --define absl=1
 
-# For brpc.
-test --define=BRPC_BUILD_FOR_UNITTEST=true
+# For UT.
+build:test --define BRPC_BUILD_FOR_UNITTEST=true
+# Hide libunwind's `_Unwind_*` symbols so they don't preempt libgcc_s at
+# runtime. Without this, pthread_exit / C++ exception unwinding crashes
+# when libunwind.so appears earlier in the dynamic link chain.
+# See registry/modules/1.8.3/overlay/BUILD.bazel for details.
+build:test --define with_bthread_tracer=false
+build:test --define libunwind_hide_unwind_symbols=true
+
+test --config=test
 test --test_output=streamed
+test --verbose_failures
 
 # Pass PATH, CC, CXX and LLVM_CONFIG variables from the environment.
 build --action_env=CC
 build --action_env=CXX
 build --action_env=LLVM_CONFIG
 build --action_env=PATH
+
+# Basic ASAN
+build:asan --define=with_asan=true
+build:asan --copt -fsanitize=address
+build:asan --linkopt -fsanitize=address
+# ASAN needs -O1 to get reasonable performance.
+build:asan --copt -O1
+build:asan --copt -fno-optimize-sibling-calls
+
+# macOS ASAN
+build:macos-asan --config=asan
+# Workaround, see https://github.com/bazelbuild/bazel/issues/6932
+build:macos-asan --copt -Wno-macro-redefined
+build:macos-asan --copt -D_FORTIFY_SOURCE=0
+# Dynamic link cause issues like: `dyld: malformed mach-o: load commands size (59272) > 32768`
+build:macos-asan --dynamic_mode=off
+
+test:asan --test_env=ASAN_OPTIONS=detect_leaks=0:detect_stack_use_after_return=1

.github/workflows/ci-linux.yml

@@ -103,11 +103,12 @@ jobs:
         protobuf-install-dir: /protobuf-3.21.12
         config-brpc-options: --cc=gcc --cxx=g++ --werror
 
-  gcc-compile-with-bazel:
+  gcc-compile-and-test-with-bazel:
     runs-on: ubuntu-22.04
     steps:
     - uses: actions/checkout@v2
-    - run: bazel build --verbose_failures -- //... -//example/...
+    - run: bazel build --verbose_failures -- //... -//example/... -//test/...
+    - run: bazel test //test/...
 
   gcc-compile-with-boringssl:
     runs-on: ubuntu-22.04
@@ -129,6 +130,7 @@ jobs:
                     --define with_asan=true \
                     --define with_bthread_tracer=true \
                     --define BRPC_WITH_NO_PTHREAD_MUTEX_HOOK=true \
+                    --define with_babylon_counter=true \
                     -- //... -//example/...
 
   clang-compile-with-make-protobuf:
@@ -161,11 +163,12 @@ jobs:
         protobuf-install-dir: /protobuf-3.21.12
         config-brpc-options: --cc=clang --cxx=clang++ --werror
 
-  clang-compile-with-bazel:
+  clang-compile-and-test-with-bazel:
     runs-on: ubuntu-22.04
     steps:
     - uses: actions/checkout@v2
-    - run: bazel build --verbose_failures --action_env=CC=clang -- //... -//example/...
+    - run: bazel build --verbose_failures --action_env=CC=clang -- //... -//example/...  -//test/...
+    - run: bazel test --action_env=CC=clang //test/...
 
   clang-compile-with-boringssl:
     runs-on: ubuntu-22.04
@@ -188,6 +191,7 @@ jobs:
                     --define with_asan=true \
                     --define with_bthread_tracer=true \
                     --define BRPC_WITH_NO_PTHREAD_MUTEX_HOOK=true \
+                    --define with_babylon_counter=true \
                     -- //... -//example/...
 
   clang-unittest:
@@ -226,11 +230,29 @@ jobs:
         cd test
         sh ./run_tests.sh
 
-  bazel-bvar-unittest:
+
+  clang-bazel-unittest-bvar-babylon:
     runs-on: ubuntu-22.04
     steps:
     - uses: actions/checkout@v2
-    - run: bazel test --verbose_failures //test:bvar_test
     - run: bazel test --verbose_failures --define with_babylon_counter=true //test:bvar_test
-    - run: bazel test --verbose_failures --action_env=CC=clang //test:bvar_test
     - run: bazel test --verbose_failures --action_env=CC=clang --define with_babylon_counter=true //test:bvar_test
+
+  clang-bazel-unittest-new-pb:
+    runs-on: ubuntu-22.04
+    env:
+      TEST_PROTOBUF_VERSION: "35.0"
+      # protobuf >= 34.x uses new ProtoInfo fields (option_deps,
+      # extension_declarations) introduced in Bazel 8.x. The repo's
+      # .bazelversion (7.2.1) is too old. bazelisk honors USE_BAZEL_VERSION.
+      USE_BAZEL_VERSION: "8.3.1"
+    steps:
+    - uses: actions/checkout@v2
+    - name: Override protobuf version for testing
+      run: |
+        sed -i -E "s/(bazel_dep\(name = ['\"]protobuf['\"], version = ['\"])[^'\"]+/\1${TEST_PROTOBUF_VERSION}/" MODULE.bazel
+        echo "After override:"
+        grep -E "bazel_dep\(name = ['\"]protobuf['\"]" MODULE.bazel
+        grep -qE "bazel_dep\(name = ['\"]protobuf['\"], version = ['\"]${TEST_PROTOBUF_VERSION}['\"]" MODULE.bazel \
+          || { echo "ERROR: failed to override protobuf version in MODULE.bazel to ${TEST_PROTOBUF_VERSION}"; exit 1; }
+    - run: bazel test --action_env=CC=clang //test:brpc_unittests

BUILD.bazel

@@ -13,52 +13,55 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-load("@rules_proto//proto:defs.bzl", "proto_library")
-load("@rules_cc//cc:defs.bzl", "cc_binary", "cc_library", "cc_proto_library", "objc_library")
+load("@rules_cc//cc:defs.bzl", "cc_binary", "cc_library", "objc_library")
+load("//bazel/tools:brpc_proto_library.bzl", "brpc_proto_library")
 
 licenses(["notice"])  # Apache v2
 
 exports_files(["LICENSE"])
 
 COPTS = [
     "-fno-omit-frame-pointer",
-    "-DBTHREAD_USE_FAST_PTHREAD_MUTEX",
-    "-D__const__=__unused__",
-    "-D_GNU_SOURCE",
-    "-DUSE_SYMBOLIZE",
-    "-DNO_TCMALLOC",
-    "-D__STDC_FORMAT_MACROS",
-    "-D__STDC_LIMIT_MACROS",
-    "-D__STDC_CONSTANT_MACROS",
 ] + select({
-    "//bazel/config:brpc_with_glog": ["-DBRPC_WITH_GLOG=1"],
-    "//conditions:default": ["-DBRPC_WITH_GLOG=0"],
-}) + select({
-    "//bazel/config:brpc_with_mesalink": ["-DUSE_MESALINK"],
-    "//conditions:default": [""],
-}) + select({
-    "//bazel/config:brpc_with_thrift": ["-DENABLE_THRIFT_FRAMED_PROTOCOL=1"],
-    "//conditions:default": [""],
-}) + select({
-    "//bazel/config:brpc_with_thrift_legacy_version": [],
-    "//conditions:default": ["-DTHRIFT_STDCXX=std"],
-}) + select({
-    "//bazel/config:brpc_with_rdma": ["-DBRPC_WITH_RDMA=1"],
-    "//conditions:default": [""],
-}) + select({
-    "//bazel/config:brpc_with_debug_bthread_sche_safety": ["-DBRPC_DEBUG_BTHREAD_SCHE_SAFETY=1"],
-    "//conditions:default": ["-DBRPC_DEBUG_BTHREAD_SCHE_SAFETY=0"],
-}) + select({
-    "//bazel/config:brpc_with_debug_lock": ["-DBRPC_DEBUG_LOCK=1"],
-    "//conditions:default": ["-DBRPC_DEBUG_LOCK=0"],
-}) + select({
     "//bazel/config:brpc_with_asan": ["-fsanitize=address"],
-    "//conditions:default": [""],
-}) + select({
-    "//bazel/config:brpc_with_no_pthread_mutex_hook": ["-DNO_PTHREAD_MUTEX_HOOK"],
-    "//conditions:default": [""],
+    "//conditions:default": [],
 })
 
+DEFINES = [
+    "BTHREAD_USE_FAST_PTHREAD_MUTEX",
+    "__const__=__unused__",
+    "_GNU_SOURCE",
+    "USE_SYMBOLIZE",
+    "NO_TCMALLOC",
+    "__STDC_FORMAT_MACROS",
+    "__STDC_LIMIT_MACROS",
+    "__STDC_CONSTANT_MACROS",
+] + select({
+     "//bazel/config:brpc_with_glog": ["BRPC_WITH_GLOG=1"],
+     "//conditions:default": ["BRPC_WITH_GLOG=0"],
+ }) + select({
+     "//bazel/config:brpc_with_mesalink": ["USE_MESALINK"],
+     "//conditions:default": [],
+ }) + select({
+     "//bazel/config:brpc_with_thrift": ["ENABLE_THRIFT_FRAMED_PROTOCOL=1"],
+     "//conditions:default": [],
+ }) + select({
+     "//bazel/config:brpc_with_thrift_legacy_version": [],
+     "//conditions:default": ["THRIFT_STDCXX=std"],
+ }) + select({
+     "//bazel/config:brpc_with_rdma": ["BRPC_WITH_RDMA=1"],
+     "//conditions:default": [],
+ }) + select({
+     "//bazel/config:brpc_with_debug_bthread_sche_safety": ["BRPC_DEBUG_BTHREAD_SCHE_SAFETY=1"],
+     "//conditions:default": ["BRPC_DEBUG_BTHREAD_SCHE_SAFETY=0"],
+ }) + select({
+     "//bazel/config:brpc_with_debug_lock": ["BRPC_DEBUG_LOCK=1"],
+     "//conditions:default": ["BRPC_DEBUG_LOCK=0"],
+ }) + select({
+     "//bazel/config:brpc_with_no_pthread_mutex_hook": ["NO_PTHREAD_MUTEX_HOOK"],
+     "//conditions:default": [],
+ })
+
 LINKOPTS = [
     "-pthread",
     "-ldl",
@@ -93,7 +96,7 @@ LINKOPTS = [
     "//conditions:default": [],
 }) + select({
         "//bazel/config:brpc_with_asan": ["-fsanitize=address"],
-        "//conditions:default": [""],
+        "//conditions:default": [],
   })
 
 genrule(
@@ -331,13 +334,13 @@ cc_library(
         "src/butil/third_party/dmg_fp/dtoa.cc",
         ":config_h",
     ],
-    copts = COPTS + select({
+    defines = DEFINES + select({
         "//bazel/config:brpc_build_for_unittest": [
-            "-DBVAR_NOT_LINK_DEFAULT_VARIABLES",
-            "-DUNIT_TEST",
+            "UNIT_TEST",
         ],
         "//conditions:default": [],
     }),
+    copts = COPTS,
     includes = [
         "src/",
     ],
@@ -354,8 +357,14 @@ cc_library(
         "@bazel_tools//src/conditions:darwin": [":macos_lib"],
         "//conditions:default": [],
     }) + select({
-        "//bazel/config:brpc_with_boringssl": ["@boringssl//:ssl", "@boringssl//:crypto"],
-        "//conditions:default": ["@openssl//:ssl", "@openssl//:crypto"],
+        "//bazel/config:brpc_with_boringssl": [
+            "@boringssl//:ssl",
+            "@boringssl//:crypto"
+        ],
+        "//conditions:default": [
+            "@openssl//:ssl",
+            "@openssl//:crypto"
+        ],
     }),
 )
 
@@ -381,14 +390,13 @@ cc_library(
     defines = [] + select({
         "//bazel/config:with_babylon_counter": ["WITH_BABYLON_COUNTER=1"],
         "//conditions:default": [],
-    }),
-    copts = COPTS + select({
+    }) + select({
         "//bazel/config:brpc_build_for_unittest": [
-            "-DBVAR_NOT_LINK_DEFAULT_VARIABLES",
-            "-DUNIT_TEST",
+            "BVAR_NOT_LINK_DEFAULT_VARIABLES",
         ],
         "//conditions:default": [],
     }),
+    copts = COPTS,
     includes = [
         "src/",
     ],
@@ -475,7 +483,6 @@ cc_library(
     deps = [
         ":brpc_idl_options_cc_proto",
         ":butil",
-        "@com_google_protobuf//:protoc_lib",
     ],
 )
 
@@ -487,20 +494,11 @@ filegroup(
     visibility = ["//visibility:public"],
 )
 
-proto_library(
-    name = "brpc_idl_options_proto",
-    srcs = [":brpc_idl_options_proto_srcs"],
-    strip_import_prefix = "src",
-    visibility = ["//visibility:public"],
-    deps = [
-        "@com_google_protobuf//:descriptor_proto",
-    ],
-)
-
-cc_proto_library(
+brpc_proto_library(
     name = "brpc_idl_options_cc_proto",
+    srcs = [":brpc_idl_options_proto_srcs"],
+    include = "src",
     visibility = ["//visibility:public"],
-    deps = [":brpc_idl_options_proto"],
 )
 
 filegroup(
@@ -512,21 +510,12 @@ filegroup(
     visibility = ["//visibility:public"],
 )
 
-proto_library(
-    name = "brpc_internal_proto",
-    srcs = [":brpc_internal_proto_srcs"],
-    strip_import_prefix = "src",
-    visibility = ["//visibility:public"],
-    deps = [
-        ":brpc_idl_options_proto",
-        "@com_google_protobuf//:descriptor_proto",
-    ],
-)
-
-cc_proto_library(
+brpc_proto_library(
     name = "brpc_internal_cc_proto",
+    srcs = [":brpc_internal_proto_srcs"],
+    include = "src",
+    deps = [":brpc_idl_options_cc_proto"],
     visibility = ["//visibility:public"],
-    deps = [":brpc_internal_proto"],
 )
 
 cc_library(
@@ -587,5 +576,6 @@ cc_binary(
     deps = [
         ":brpc",
         ":brpc_idl_options_cc_proto",
+        "@com_google_protobuf//:protoc_lib",
     ],
 )

CMakeLists.txt

@@ -206,11 +206,13 @@ if(Protobuf_VERSION GREATER 4.21)
         absl::hash
         absl::layout
         absl::log_initialize
+        absl::log_globals
         absl::log_severity
         absl::memory
         absl::node_hash_map
         absl::node_hash_set
-        absl::optional
+        absl::random_distributions
+        absl::random_random
         absl::span
         absl::status
         absl::statusor