build: making alwayslink optional in Enovy CC libraries

bazel/BUILD

@@ -291,6 +291,11 @@ config_setting(
     values = {"define": "signal_trace=disabled"},
 )
 
+config_setting(
+    name = "disable_library_autolink",
+    values = {"define": "library_autolink=disabled"},
+)
+
 config_setting(
     name = "disable_object_dump_on_signal_trace",
     values = {"define": "object_dump_on_signal_trace=disabled"},

bazel/README.md

@@ -687,6 +687,7 @@ The following optional features can be disabled on the Bazel build command-line:
   tcmalloc with `--define tcmalloc=gperftools` which is the default for builds other than x86_64 and aarch64.
 * deprecated features with `--define deprecated_features=disabled`
 * http3/quic with --//bazel:http3=False
+* autolinking libraries with --define=library_autolink=disabled
 * admin HTML home page with `--define=admin_html=disabled`
 
 ## Enabling optional features

bazel/envoy_library.bzl

@@ -57,6 +57,7 @@ def envoy_cc_extension(
         tags = [],
         extra_visibility = [],
         visibility = EXTENSION_CONFIG_VISIBILITY,
+        alwayslink = 1,
         **kwargs):
     if "//visibility:public" not in visibility:
         visibility = visibility + extra_visibility
@@ -66,6 +67,7 @@ def envoy_cc_extension(
         name = name,
         tags = tags,
         visibility = visibility,
+        alwayslink = alwayslink,
         **kwargs
     )
     native.cc_library(
@@ -83,6 +85,7 @@ def envoy_cc_contrib_extension(
         tags = [],
         extra_visibility = [],
         visibility = CONTRIB_EXTENSION_PACKAGE_VISIBILITY,
+        alwayslink = 1,
         **kwargs):
     envoy_cc_extension(name, tags, extra_visibility, visibility, **kwargs)
 
@@ -101,10 +104,19 @@ def envoy_cc_library(
         strip_include_prefix = None,
         include_prefix = None,
         textual_hdrs = None,
+        alwayslink = None,
         defines = []):
     if tcmalloc_dep:
         deps += tcmalloc_external_deps(repository)
 
+    # If alwayslink is not specified, allow turning it off via --define=library_autolink=disabled
+    # alwayslink is defaulted on for envoy_cc_extensions to ensure the REGISTRY macros work.
+    if alwayslink == None:
+        alwayslink = select({
+            repository + "//bazel:disable_library_autolink": 0,
+            "//conditions:default": 1,
+        })
+
     native.cc_library(
         name = name,
         srcs = srcs,
@@ -122,7 +134,7 @@ def envoy_cc_library(
             envoy_external_dep_path("abseil_strings"),
             envoy_external_dep_path("fmtlib"),
         ],
-        alwayslink = 1,
+        alwayslink = alwayslink,
         linkstatic = envoy_linkstatic(),
         strip_include_prefix = strip_include_prefix,
         include_prefix = include_prefix,

changelogs/current.yaml

@@ -55,6 +55,9 @@ removed_config_or_runtime:
       removed ``envoy.reloadable_features.override_request_timeout_by_gateway_timeout`` and legacy code paths.
 
 new_features:
+- area: build
+  change: |
+    added an option ``--define=library_autolink=disabled`` to disable autolinking libraries.
 - area: generic_proxy
   change: |
     added :ref:`dubbo codec support <envoy_v3_api_msg_extensions.filters.network.generic_proxy.codecs.dubbo.v3.DubboCodecConfig>` to the

ci/do_ci.sh

@@ -286,7 +286,10 @@ elif [[ "$CI_TARGET" == "bazel.gcc" ]]; then
 elif [[ "$CI_TARGET" == "bazel.debug" ]]; then
   setup_clang_toolchain
   echo "Testing ${TEST_TARGETS[*]}"
-  bazel test "${BAZEL_BUILD_OPTIONS[@]}" -c dbg "${TEST_TARGETS[@]}"
+  # Make sure that there are no regressions to building Envoy with autolink disabled.
+  EXTRA_OPTIONS=(
+    "--define" "library_autolink=disabled")
+  bazel test "${BAZEL_BUILD_OPTIONS[@]}"  "${EXTRA_OPTIONS[@]}" -c dbg "${TEST_TARGETS[@]}"
 
   echo "bazel debug build with tests..."
   bazel_envoy_binary_build debug

ci/osx-build-config/extensions_build_config.bzl

@@ -17,3 +17,7 @@ WINDOWS_EXTENSIONS = {}
 EXTENSION_CONFIG_VISIBILITY = ["//:extension_config"]
 EXTENSION_PACKAGE_VISIBILITY = ["//:extension_library"]
 CONTRIB_EXTENSION_PACKAGE_VISIBILITY = ["//:contrib_library"]
+
+# As part of (https://github.com/envoyproxy/envoy-mobile/issues/175) we turned down alwayslink for envoy libraries
+# This tracks libraries that should be registered as extensions.
+LEGACY_ALWAYSLINK = 1

contrib/generic_proxy/filters/network/source/BUILD

@@ -85,4 +85,5 @@ envoy_cc_library(
         "//source/common/matcher:matcher_lib",
         "@envoy_api//contrib/envoy/extensions/filters/network/generic_proxy/matcher/v3:pkg_cc_proto",
     ],
+    alwayslink = 1,
 )

source/common/common/BUILD

@@ -8,6 +8,10 @@ load(
     "envoy_package",
     "envoy_pch_library",
 )
+load(
+    "@envoy_build_config//:extensions_build_config.bzl",
+    "LEGACY_ALWAYSLINK",
+)
 
 licenses(["notice"])  # Apache 2
 
@@ -341,6 +345,7 @@ envoy_cc_library(
         "@envoy_api//envoy/extensions/regex_engines/v3:pkg_cc_proto",
         "@envoy_api//envoy/type/matcher/v3:pkg_cc_proto",
     ],
+    alwayslink = LEGACY_ALWAYSLINK,
 )
 
 envoy_cc_library(

source/common/crypto/BUILD

@@ -28,4 +28,6 @@ envoy_cc_library(
         "//source/common/common:assert_lib",
         "//source/common/singleton:threadsafe_singleton",
     ],
+    # for the singleton
+    alwayslink = 1,
 )

source/common/grpc/BUILD

@@ -5,6 +5,10 @@ load(
     "envoy_package",
     "envoy_select_google_grpc",
 )
+load(
+    "@envoy_build_config//:extensions_build_config.bzl",
+    "LEGACY_ALWAYSLINK",
+)
 
 licenses(["notice"])  # Apache 2
 
@@ -205,6 +209,7 @@ envoy_cc_library(
         "//source/common/config:datasource_lib",
         "@envoy_api//envoy/config/core/v3:pkg_cc_proto",
     ],
+    alwayslink = LEGACY_ALWAYSLINK,
 )
 
 envoy_cc_library(

source/common/http/match_delegate/BUILD

@@ -3,6 +3,10 @@ load(
     "envoy_cc_library",
     "envoy_package",
 )
+load(
+    "@envoy_build_config//:extensions_build_config.bzl",
+    "LEGACY_ALWAYSLINK",
+)
 
 licenses(["notice"])  # Apache 2
 
@@ -21,4 +25,5 @@ envoy_cc_library(
         "@envoy_api//envoy/extensions/common/matching/v3:pkg_cc_proto",
         "@envoy_api//envoy/extensions/filters/common/matcher/action/v3:pkg_cc_proto",
     ],
+    alwayslink = LEGACY_ALWAYSLINK,
 )

source/common/http/matching/BUILD

@@ -3,6 +3,10 @@ load(
     "envoy_cc_library",
     "envoy_package",
 )
+load(
+    "@envoy_build_config//:extensions_build_config.bzl",
+    "LEGACY_ALWAYSLINK",
+)
 
 licenses(["notice"])  # Apache 2
 
@@ -27,4 +31,5 @@ envoy_cc_library(
         "//source/common/http:header_utility_lib",
         "@envoy_api//envoy/type/matcher/v3:pkg_cc_proto",
     ],
+    alwayslink = LEGACY_ALWAYSLINK,
 )

source/common/network/BUILD

@@ -3,6 +3,10 @@ load(
     "envoy_cc_library",
     "envoy_package",
 )
+load(
+    "@envoy_build_config//:extensions_build_config.bzl",
+    "LEGACY_ALWAYSLINK",
+)
 
 licenses(["notice"])  # Apache 2
 
@@ -157,6 +161,7 @@ envoy_cc_library(
         "//envoy/network:transport_socket_interface",
         "//envoy/registry",
     ],
+    alwayslink = LEGACY_ALWAYSLINK,
 )
 
 envoy_cc_library(
@@ -228,6 +233,7 @@ envoy_cc_library(
         "//envoy/registry",
         "//envoy/server:bootstrap_extension_config_interface",
     ],
+    alwayslink = LEGACY_ALWAYSLINK,
 )
 
 envoy_cc_library(
@@ -254,6 +260,7 @@ envoy_cc_library(
         "//source/common/event:dispatcher_includes",
         "@envoy_api//envoy/extensions/network/socket_interface/v3:pkg_cc_proto",
     ],
+    alwayslink = LEGACY_ALWAYSLINK,
 )
 
 envoy_cc_library(

source/common/network/matching/BUILD

@@ -3,6 +3,10 @@ load(
     "envoy_cc_library",
     "envoy_package",
 )
+load(
+    "@envoy_build_config//:extensions_build_config.bzl",
+    "LEGACY_ALWAYSLINK",
+)
 
 licenses(["notice"])  # Apache 2
 
@@ -28,4 +32,5 @@ envoy_cc_library(
         "//source/common/network:utility_lib",
         "@envoy_api//envoy/extensions/matching/common_inputs/network/v3:pkg_cc_proto",
     ],
+    alwayslink = LEGACY_ALWAYSLINK,
 )

source/common/quic/BUILD

@@ -3,6 +3,10 @@ load(
     "envoy_cc_library",
     "envoy_package",
 )
+load(
+    "@envoy_build_config//:extensions_build_config.bzl",
+    "LEGACY_ALWAYSLINK",
+)
 
 licenses(["notice"])  # Apache 2
 
@@ -431,6 +435,7 @@ envoy_cc_library(
         "@com_github_google_quiche//:quic_core_crypto_crypto_handshake_lib",
         "@envoy_api//envoy/extensions/transport_sockets/quic/v3:pkg_cc_proto",
     ],
+    alwayslink = LEGACY_ALWAYSLINK,
 )
 
 # Create a single target that contains all the libraries that register factories.

source/common/router/BUILD

@@ -3,6 +3,10 @@ load(
     "envoy_cc_library",
     "envoy_package",
 )
+load(
+    "@envoy_build_config//:extensions_build_config.bzl",
+    "LEGACY_ALWAYSLINK",
+)
 
 licenses(["notice"])  # Apache 2
 
@@ -78,6 +82,7 @@ envoy_cc_library(
         "@envoy_api//envoy/type/matcher/v3:pkg_cc_proto",
         "@envoy_api//envoy/type/v3:pkg_cc_proto",
     ],
+    alwayslink = LEGACY_ALWAYSLINK,
 )
 
 envoy_cc_library(
@@ -362,6 +367,7 @@ envoy_cc_library(
         "//source/extensions/filters/http/common:factory_base_lib",
         "@envoy_api//envoy/extensions/filters/http/upstream_codec/v3:pkg_cc_proto",
     ],
+    alwayslink = LEGACY_ALWAYSLINK,
 )
 
 envoy_cc_library(

source/common/ssl/matching/BUILD

@@ -3,6 +3,10 @@ load(
     "envoy_cc_library",
     "envoy_package",
 )
+load(
+    "@envoy_build_config//:extensions_build_config.bzl",
+    "LEGACY_ALWAYSLINK",
+)
 
 licenses(["notice"])  # Apache 2
 
@@ -18,4 +22,5 @@ envoy_cc_library(
         "//envoy/network:filter_interface",
         "@envoy_api//envoy/extensions/matching/common_inputs/ssl/v3:pkg_cc_proto",
     ],
+    alwayslink = LEGACY_ALWAYSLINK,
 )

source/common/upstream/BUILD

@@ -4,6 +4,10 @@ load(
     "envoy_package",
     "envoy_select_enable_http3",
 )
+load(
+    "@envoy_build_config//:extensions_build_config.bzl",
+    "LEGACY_ALWAYSLINK",
+)
 
 licenses(["notice"])  # Apache 2
 
@@ -357,6 +361,7 @@ envoy_cc_library(
         "@envoy_api//envoy/config/core/v3:pkg_cc_proto",
         "@envoy_api//envoy/config/endpoint/v3:pkg_cc_proto",
     ],
+    alwayslink = LEGACY_ALWAYSLINK,
 )
 
 envoy_cc_library(
@@ -377,6 +382,7 @@ envoy_cc_library(
         "@envoy_api//envoy/config/core/v3:pkg_cc_proto",
         "@envoy_api//envoy/config/endpoint/v3:pkg_cc_proto",
     ],
+    alwayslink = LEGACY_ALWAYSLINK,
 )
 
 envoy_cc_library(
@@ -480,6 +486,7 @@ envoy_cc_library(
         "@envoy_api//envoy/config/endpoint/v3:pkg_cc_proto",
         "@envoy_api//envoy/service/discovery/v3:pkg_cc_proto",
     ],
+    alwayslink = LEGACY_ALWAYSLINK,
 )
 
 envoy_cc_library(
@@ -594,6 +601,7 @@ envoy_cc_library(
         "@envoy_api//envoy/config/cluster/v3:pkg_cc_proto",
         "@envoy_api//envoy/config/endpoint/v3:pkg_cc_proto",
     ],
+    alwayslink = LEGACY_ALWAYSLINK,
 )
 
 envoy_cc_library(
@@ -606,6 +614,7 @@ envoy_cc_library(
         "@envoy_api//envoy/config/cluster/v3:pkg_cc_proto",
         "@envoy_api//envoy/config/endpoint/v3:pkg_cc_proto",
     ],
+    alwayslink = LEGACY_ALWAYSLINK,
 )
 
 envoy_cc_library(

source/common/watchdog/BUILD

@@ -3,6 +3,10 @@ load(
     "envoy_cc_library",
     "envoy_package",
 )
+load(
+    "@envoy_build_config//:extensions_build_config.bzl",
+    "LEGACY_ALWAYSLINK",
+)
 
 licenses(["notice"])  # Apache 2
 
@@ -35,4 +39,5 @@ envoy_cc_library(
         "//source/common/protobuf:message_validator_lib",
         "@envoy_api//envoy/watchdog/v3:pkg_cc_proto",
     ],
+    alwayslink = LEGACY_ALWAYSLINK,
 )

source/extensions/access_loggers/wasm/BUILD

@@ -19,6 +19,7 @@ envoy_cc_library(
         "//source/common/http:header_map_lib",
         "//source/extensions/common/wasm:wasm_lib",
     ],
+    alwayslink = 1,
 )
 
 envoy_cc_extension(

source/extensions/bootstrap/internal_listener/BUILD

@@ -19,7 +19,7 @@ envoy_cc_extension(
     ],
 )
 
-envoy_cc_library(
+envoy_cc_extension(
     name = "internal_listener_registry",
     srcs = [
         "internal_listener_registry.cc",
@@ -33,9 +33,10 @@ envoy_cc_library(
         "//source/server:listener_manager_lib",
         "@envoy_api//envoy/extensions/bootstrap/internal_listener/v3:pkg_cc_proto",
     ],
+    alwayslink = 1,
 )
 
-envoy_cc_library(
+envoy_cc_extension(
     name = "client_connection_factory",
     srcs = [
         "client_connection_factory.cc",