sync: address review comments + rebase onto latest apache/master (fixes ASAN CI) for #3428

.bazelignore

@@ -1,4 +1,6 @@
 ./example/build_with_bazel
+./example/build_with_bazel_module
+./example/build_with_old_bazel
 
 # `registry/` is brpc's self-maintained Bzlmod registry. Its overlay
 # BUILD.bazel files reference sources from the libunwind tarball that is

.bazelrc

@@ -87,3 +87,5 @@ build:macos-asan --copt -D_FORTIFY_SOURCE=0
 build:macos-asan --dynamic_mode=off
 
 test:asan --test_env=ASAN_OPTIONS=detect_leaks=0:detect_stack_use_after_return=1
+
+build:ubring --define BRPC_WITH_UBRING=true

.github/workflows/ci-linux.yml

@@ -65,7 +65,7 @@ jobs:
       run: |
         export CC=gcc && export CXX=g++
         mkdir gcc_build_all && cd gcc_build_all
-        cmake -DWITH_MESALINK=OFF -DWITH_GLOG=ON -DWITH_THRIFT=ON -DWITH_RDMA=ON \
+        cmake -DWITH_MESALINK=OFF -DWITH_GLOG=ON -DWITH_THRIFT=ON -DWITH_RDMA=ON -DWITH_UBRING=ON \
               -DWITH_DEBUG_BTHREAD_SCHE_SAFETY=ON -DWITH_DEBUG_LOCK=ON -DWITH_BTHREAD_TRACER=ON \
               -DWITH_ASAN=ON -DCMAKE_POLICY_VERSION_MINIMUM=3.5 ..
         make -j ${{env.proc_num}} && make clean
@@ -123,24 +123,44 @@ jobs:
     # real server (e.g. brpc_redis_unittest) actually run under bazel instead
     # of skipping. Same shared action the make-based unittest jobs use.
     - uses: ./.github/actions/install-essential-dependencies
-    - run: bazel test //test/...
+    - run: bazel test --config=rdma --config=ubring //test/...
 
   gcc-compile-with-bazel-all-options:
     runs-on: ubuntu-22.04
     steps:
     - uses: actions/checkout@v2
-    - run: |
+    - run: sudo apt-get update && sudo apt-get install -y  libibverbs-dev
+    - name: root
+      run: |
+        bazel build --define with_mesalink=false \
+                    --define with_glog=true \
+                    --define with_thrift=true \
+                    --define BRPC_WITH_RDMA=true \
+                    --define BRPC_WITH_UBRING=true \
+                    --define BRPC_WITH_BORINGSSL=true \
+                    --define with_debug_bthread_sche_safety=true \
+                    --define with_debug_lock=true \
+                    --define with_asan=true \
+                    --define with_bthread_tracer=true \
+                    --define BRPC_WITH_NO_PTHREAD_MUTEX_HOOK=true \
+                    --define with_babylon_counter=true \
+                    -- //:brpc //example/...
+    - name: external
+      run: |
+        cd example/build_with_bazel_module
         bazel build --define with_mesalink=false \
                     --define with_glog=true \
                     --define with_thrift=true \
+                    --define BRPC_WITH_RDMA=true \
+                    --define BRPC_WITH_UBRING=true \
                     --define BRPC_WITH_BORINGSSL=true \
                     --define with_debug_bthread_sche_safety=true \
                     --define with_debug_lock=true \
                     --define with_asan=true \
                     --define with_bthread_tracer=true \
                     --define BRPC_WITH_NO_PTHREAD_MUTEX_HOOK=true \
                     --define with_babylon_counter=true \
-                    -- //:brpc
+                    -- //...
 
   clang-compile-with-make-protobuf:
     runs-on: ubuntu-22.04
@@ -182,25 +202,48 @@ jobs:
     - run: |
         bazel test --test_output=streamed \
                    --action_env=CC=clang \
+                   --config=rdma \
+                   --config=ubring \
                    //test/...
 
   clang-compile-with-bazel-all-options:
     runs-on: ubuntu-22.04
     steps:
     - uses: actions/checkout@v2
-    - run: |
+    - run: sudo apt-get update && sudo apt-get install -y  libibverbs-dev
+    - name: root
+      run: |
+        bazel build --action_env=CC=clang \
+                    --define with_mesalink=false \
+                    --define with_glog=true \
+                    --define with_thrift=true \
+                    --define BRPC_WITH_RDMA=true \
+                    --define BRPC_WITH_UBRING=true \
+                    --define BRPC_WITH_BORINGSSL=true \
+                    --define with_debug_bthread_sche_safety=true \
+                    --define with_debug_lock=true \
+                    --define with_asan=true \
+                    --define with_bthread_tracer=true \
+                    --define BRPC_WITH_NO_PTHREAD_MUTEX_HOOK=true \
+                    --define with_babylon_counter=true \
+                    -- //:brpc //example/...
+    - name: external
+      run: |
+        cd example/build_with_bazel_module
         bazel build --action_env=CC=clang \
                     --define with_mesalink=false \
                     --define with_glog=true \
                     --define with_thrift=true \
+                    --define BRPC_WITH_RDMA=true \
+                    --define BRPC_WITH_UBRING=true \
                     --define BRPC_WITH_BORINGSSL=true \
                     --define with_debug_bthread_sche_safety=true \
                     --define with_debug_lock=true \
                     --define with_asan=true \
                     --define with_bthread_tracer=true \
                     --define BRPC_WITH_NO_PTHREAD_MUTEX_HOOK=true \
                     --define with_babylon_counter=true \
-                    -- //:brpc
+                    -- //...
 
   clang-unittest:
     runs-on: ubuntu-22.04
@@ -209,7 +252,7 @@ jobs:
     - uses: ./.github/actions/install-essential-dependencies
     - uses: ./.github/actions/init-ut-make-config
       with:
-        options: --with-bthread-tracer
+        options: --with-bthread-tracer --with-rdma
     - name: compile tests
       run: |
         cat config.mk
@@ -245,10 +288,10 @@ jobs:
   clang-unittest-bazel-with-babylon-and-new-pb:
     runs-on: ubuntu-22.04
     env:
-      TEST_PROTOBUF_VERSION: "34.1"
-      # 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.
+      TEST_PROTOBUF_VERSION: "35.1"
+      # 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
@@ -263,7 +306,7 @@ jobs:
         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 --config=rdma \
+        bazel test --action_env=CC=clang --config=rdma --config=ubring \
                    --define with_bthread_tracer=true \
                    --define with_babylon_counter=true \
                    //test/...

.licenserc.yaml

@@ -34,6 +34,7 @@ header:
     - 'example/*/*.json'
     - 'example/*/*.pem'
     - 'example/*/*.port'
+    - 'example/build_with_bazel_module/.bazelversion'
     - 'src/bthread/offset_inl.list'
     - 'test/*.crt'
     - 'test/*.key'

BUILD.bazel

@@ -51,6 +51,9 @@ DEFINES = [
  }) + select({
      "//bazel/config:brpc_with_rdma": ["BRPC_WITH_RDMA=1"],
      "//conditions:default": [],
+ }) + select({
+     "//bazel/config:brpc_with_ubring": ["BRPC_WITH_UBRING=1"],
+     "//conditions:default": [],
  }) + select({
      "//bazel/config:brpc_with_urma": ["BRPC_WITH_URMA=1"],
      "//conditions:default": [],

CMakeLists.txt

@@ -31,6 +31,9 @@ option(WITH_URMA "With URMA (openEuler Unified Remote Memory Access)" OFF)
 option(DOWNLOAD_URMA_HEADERS
        "Download UMDK headers when WITH_URMA is enabled and headers are absent"
        ON)
+option(WITH_URMA_MOCK
+       "Explicitly allow linking brpc's URMA link-time mock when liburma is not found (WITH_URMA only). The mock cannot talk to real URMA hardware, so this must be opted into rather than silently substituted."
+       OFF)
 option(WITH_UBRING "With UB" OFF)
 option(WITH_DEBUG_BTHREAD_SCHE_SAFETY "With debugging bthread sche safety" OFF)
 option(WITH_DEBUG_LOCK "With debugging lock" OFF)
@@ -371,10 +374,17 @@ if(WITH_URMA)
     if(URMA_LIB)
         message(STATUS "Found URMA library: ${URMA_LIB}")
         set(URMA_USE_MOCK 0)
-    else()
+    elseif(WITH_URMA_MOCK)
         message(STATUS
-            "liburma not found; building with the URMA link-time mock")
+            "liburma not found; WITH_URMA_MOCK=ON, building with the URMA "
+            "link-time mock")
         set(URMA_USE_MOCK 1)
+    else()
+        message(FATAL_ERROR
+            "Fail to find liburma. Install liburma, set URMA_ROOT, or "
+            "explicitly opt into brpc's link-time mock with "
+            "-DWITH_URMA_MOCK=ON (the mock cannot talk to real URMA "
+            "hardware; only enable it for CI/tests without URMA hardware).")
     endif()
 endif()
 

MODULE.bazel

@@ -1,3 +1,20 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 module(
   name = 'brpc',
   version = '1.17.0',
@@ -10,11 +27,10 @@ bazel_dep(name = 'bazel_skylib', version = '1.0.3')
 bazel_dep(name = 'boringssl', version = '0.0.0-20211025-d4f1ab9')
 bazel_dep(name = 'protobuf', version = '27.3', repo_name = 'com_google_protobuf')
 bazel_dep(name = 'gflags', version = '2.2.2', repo_name = 'com_github_gflags_gflags')
-bazel_dep(name = 'glog', version = '0.5.0', repo_name = 'com_github_google_glog')
+bazel_dep(name = 'glog', version = '0.7.1', repo_name = 'com_github_google_glog')
 bazel_dep(name = 'platforms', version = '0.0.4')
 bazel_dep(name = "apple_support", version = "1.22.1")
 bazel_dep(name = 'rules_cc', version = '0.0.1')
-bazel_dep(name = 'rules_proto', version = '4.0.0')
 bazel_dep(name = 'zlib', version = '1.3.1.bcr.5', repo_name = 'com_github_madler_zlib')
 bazel_dep(name = 'babylon', version = '1.4.4')
 # --registry=https://raw.githubusercontent.com/apache/brpc/master/registry
@@ -62,4 +78,12 @@ git_repository(
     build_file = '//bazel/third_party/umdk:umdk.BUILD',
     remote = 'https://atomgit.com/openeuler/umdk.git',
     commit = '564ee727a55523d4351a8fb3c94292b388ebb924',  # v26.06.0_CAM
+    # umdk ships its own src/urma/BUILD.bazel, which turns src/urma into a
+    # separate Bazel package and silently empties the glob() in umdk.BUILD
+    # (glob cannot cross package boundaries). Drop it so the headers under
+    # src/urma/lib/urma/**/include stay part of this repository's root
+    # package.
+    patch_cmds = [
+        'rm -f src/urma/BUILD.bazel',
+    ],
 )

WORKSPACE

@@ -284,6 +284,14 @@ git_repository(
     build_file = "//bazel/third_party/umdk:umdk.BUILD",
     remote = "https://atomgit.com/openeuler/umdk.git",
     commit = "564ee727a55523d4351a8fb3c94292b388ebb924",  # v26.06.0_CAM
+    # umdk ships its own src/urma/BUILD.bazel, which turns src/urma into a
+    # separate Bazel package and silently empties the glob() in umdk.BUILD
+    # (glob cannot cross package boundaries). Drop it so the headers under
+    # src/urma/lib/urma/**/include stay part of this repository's root
+    # package.
+    patch_cmds = [
+        "rm -f src/urma/BUILD.bazel",
+    ],
 )
 
 # Header-only JSON library used by iobuf_unittest's IOBuf<->std::iostream

bazel/config/BUILD.bazel

@@ -162,3 +162,9 @@ config_setting(
     define_values = {"with_babylon_counter": "true"},
     visibility = ["//visibility:public"],
 )
+
+config_setting(
+    name = "brpc_with_ubring",
+    define_values = {"BRPC_WITH_UBRING": "true"},
+    visibility = ["//visibility:public"],
+)

bazel/third_party/umdk/BUILD.bazel

@@ -0,0 +1,17 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# Thie empty BUILD.bazel file is required to make Bazel treat
+# this directory as a package.

bazel/tools/brpc_proto_library.bzl

@@ -70,17 +70,13 @@ def brpc_proto_library(
       include: protoc `-I` root AND the resulting cc_library `includes`
                root, relative to the current package.
                When omitted, "" or None, the include root is the
-               current package itself (suitable for .proto files
-               sitting directly under the package root, as in `test/`
-               and `example/...`). The root `BUILD.bazel` of brpc must
-               pass `"src"` so that code can reference the protos as
-               `import "brpc/foo.proto"`.
+               current package itself.
       proto_deps: list of native `proto_library` dependencies
                   (well-known protos or external .proto libraries).
                   Defaults to
                   `["@com_google_protobuf//:descriptor_proto"]`.
-                  Pass `[]` explicitly to disable the default; pass
-                  None (the default) to use it.
+                  Pass `[]` explicitly to disable the default.
+                  Pass None (the default) to use it.
       visibility: same semantics as cc_library.
       testonly: same semantics as cc_library.
     """
@@ -127,11 +123,11 @@ def brpc_proto_library(
         # cc_library `includes` is required, otherwise the .pb.cc
         # files inside this cc_library cannot find the .pb.h headers
         # they just generated (the headers live under
-        # bazel-bin/<package>/<include>/...). When include="" we pass
-        # "." to mean "the current package itself"; Bazel then exposes
-        # both `-I <package>` and `-I bazel-bin/<package>`
-        # automatically to dependents.
-        includes = [real_include if real_include else "."],
+        # bazel-bin/<package>/<include>/...). For a non-root package
+        # with include="", "." exposes the current package's source
+        # and bazel-bin directories. The root package needs no extra
+        # include because those roots are already on the search path.
+        includes = [real_include] if real_include else (["."] if native.package_name() else []),
         deps = deps + ["@com_google_protobuf//:protobuf"],
         visibility = visibility,
         testonly = testonly,