dynamic_modules: support for statically linked modules by mathetake · Pull Request #43696 · envoyproxy/envoy

mathetake · 2026-02-28T20:02:08Z

Commit Message: dynamic_modules: support for statically linked modules
Additional Description:

This commit allows statically linked dynamic modules though in that case it is not really a "dynamic". This allows downstream users who build their own Envoy binary to statically link their modules using bazel natively. This will also set the foundation for our discussed direction of the project: allowing new core extensions written as a dynamic module.

The idea is that these statically linked modules must prefix Envoy->DM callbacks (envoy_dynamic_module_on_*) with their own module names, and at the dynamic_modules loading phase, Envoy try to find the init symbol like foo_envoy_dynamic_module_on_init. If found, it is a statically linked module, and otherwise it will try to load the shared library normally.

Since this functionality is very low-level and not available for normal end users (i.e. anyone using official binaries), i intentionally did not add the release note.

Risk Level: low
Testing: done
Docs Changes: n/a
Release Notes: n/a
Platform Specific Features:
[Optional Runtime guard:]
[Optional Fixes #Issue]
[Optional Fixes commit #PR or SHA]
[Optional Deprecated:]
[Optional API Considerations:]

Verified that we can indeed build an Envoy binary with the Rust-SDK based dynamic module statically linked:

diff --git a/source/exe/BUILD b/source/exe/BUILD
index 16a51c89b3..a94ed56d17 100644
--- a/source/exe/BUILD
+++ b/source/exe/BUILD
@@ -31,7 +31,10 @@ envoy_cc_binary(
     }),
     rbe_pool = "6gig",
     stamped = True,
-    deps = [":envoy_main_entry_lib"],
+    deps = [
+        ":envoy_main_entry_lib",
+        "//test/extensions/dynamic_modules/test_data/rust:http_integration_test_static",
+    ],
 )

Produced

$ nm -D bazel-bin/source/exe/envoy-static | grep http_integration_test
000000000c841500 T http_integration_test_envoy_dynamic_module_on_bootstrap_extension_admin_request
000000000c840d80 T http_integration_test_envoy_dynamic_module_on_bootstrap_extension_config_destroy
000000000c840b40 T http_integration_test_envoy_dynamic_module_on_bootstrap_extension_config_new
000000000c8412a0 T http_integration_test_envoy_dynamic_module_on_bootstrap_extension_config_scheduled

repokitteh-read-only · 2026-02-28T20:02:12Z

As a reminder, PRs marked as draft will not be automatically assigned reviewers,
or be handled by maintainer-oncall triage.

Please mark your PR as ready when you want it to be reviewed!

🐱

Caused by: #43696 was opened by mathetake.

see: more, trace.

Signed-off-by: Takeshi Yoneda <tyoneda@netflix.com>

mathetake · 2026-03-01T01:38:48Z

@@ -640,4 +640,1744 @@ __attribute__((weak)) bool envoy_dynamic_module_callback_matcher_get_header_valu
  return false;
 }



change here is just adding missing weak references for testing. Nothing interesting here

mathetake · 2026-03-01T01:40:37Z

+  // In this case, Envoy uses ``dlsym(RTLD_DEFAULT, ...)`` to resolve module symbols, with each
+  // symbol name prefixed by ``<name>_``. For example, ``foo_envoy_dynamic_module_on_program_init``
+  // is resolved instead of ``envoy_dynamic_module_on_program_init``.
+  // When using ``static://``, the ``do_not_close`` and ``load_globally`` fields are ignored.


i was thinking about adding "is_static" or whatever flag but it is weird as it's not available to most of the people as well as it sounds very contradictory to the name "dynamic modules" of this proto. So I decided to have this naming schema stuff. Note that any name containing slash was invalid before, so this is backward compatible

Is it possible for us to automatically infer static if we can find the module to be part of the build? Just not let users specify anything special. WDYT?

fixed! now it's implicit and no API change needed! Thanks for the good advice

repokitteh-read-only · 2026-03-01T01:40:54Z

CC @envoyproxy/api-shepherds: Your approval is needed for changes made to (api/envoy/|docs/root/api-docs/).
envoyproxy/api-shepherds assignee is @mattklein123
CC @envoyproxy/api-watchers: FYI only for changes made to (api/envoy/|docs/root/api-docs/).

🐱

Caused by: #43696 was ready_for_review by mathetake.

see: more, trace.

mathetake · 2026-03-01T01:41:34Z

 	lua*;
 	envoyGo*;
 	envoy_dynamic_module_callback_*;
+	*_envoy_dynamic_module_on_*;


this is necessary to allow the statically linked symbols to be available via dlsym

mathetake · 2026-03-01T01:50:32Z

+
+load("@rules_cc//cc:defs.bzl", "cc_import")
+
+def envoy_dynamic_module_prefix_symbols(name, module_name, archive, tags = [], **kwargs):


i am planning to use this one internally not only the tests here in upstream

mathetake · 2026-03-01T02:46:07Z

Will fix the coverage in a bit

Signed-off-by: Takeshi Yoneda <tyoneda@netflix.com>

agrawroh · 2026-03-02T17:27:09Z

/retest

) Commit Message: dynamic_modules: support for statically linked modules Additional Description: This commit allows statically linked dynamic modules though in that case it is not really a "dynamic". This allows downstream users who build their own Envoy binary to statically link their modules using bazel natively. This will also set the foundation for our discussed direction of the project: allowing new core extensions written as a dynamic module. The idea is that these statically linked modules must prefix Envoy->DM callbacks (envoy_dynamic_module_on_*) with their own module names, and at the dynamic_modules loading phase, Envoy try to find the init symbol like foo_envoy_dynamic_module_on_init. If found, it is a statically linked module, and otherwise it will try to load the shared library normally. Since this functionality is very low-level and not available for normal end users (i.e. anyone using official binaries), i intentionally did not add the release note. Risk Level: low Testing: done Docs Changes: n/a Release Notes: n/a Platform Specific Features: --------- Signed-off-by: Takeshi Yoneda <tyoneda@netflix.com> Signed-off-by: bjmask <11672696+bjmask@users.noreply.github.com>

) Commit Message: dynamic_modules: support for statically linked modules Additional Description: This commit allows statically linked dynamic modules though in that case it is not really a "dynamic". This allows downstream users who build their own Envoy binary to statically link their modules using bazel natively. This will also set the foundation for our discussed direction of the project: allowing new core extensions written as a dynamic module. The idea is that these statically linked modules must prefix Envoy->DM callbacks (envoy_dynamic_module_on_*) with their own module names, and at the dynamic_modules loading phase, Envoy try to find the init symbol like foo_envoy_dynamic_module_on_init. If found, it is a statically linked module, and otherwise it will try to load the shared library normally. Since this functionality is very low-level and not available for normal end users (i.e. anyone using official binaries), i intentionally did not add the release note. Risk Level: low Testing: done Docs Changes: n/a Release Notes: n/a Platform Specific Features: --------- Signed-off-by: Takeshi Yoneda <tyoneda@netflix.com>

mathetake added 6 commits February 28, 2026 21:29

dynamic_modules: support for statically linked modules

843e107

Signed-off-by: Takeshi Yoneda <tyoneda@netflix.com>

ok

6455ed7

Signed-off-by: Takeshi Yoneda <tyoneda@netflix.com>

more

cccbd1d

Signed-off-by: Takeshi Yoneda <tyoneda@netflix.com>

more

ce48f48

Signed-off-by: Takeshi Yoneda <tyoneda@netflix.com>

more

ddd9f19

Signed-off-by: Takeshi Yoneda <tyoneda@netflix.com>

fix test

3adce38

Signed-off-by: Takeshi Yoneda <tyoneda@netflix.com>

mathetake force-pushed the staticalliylinkabledm branch from 02dce7c to 3adce38 Compare February 28, 2026 22:54

mathetake added 2 commits March 1, 2026 00:12

linkable

117a51d

Signed-off-by: Takeshi Yoneda <tyoneda@netflix.com>

integration test

1bacac2

Signed-off-by: Takeshi Yoneda <tyoneda@netflix.com>

mathetake commented Mar 1, 2026

View reviewed changes

repokitteh-read-only Bot added the api label Mar 1, 2026

mathetake commented Mar 1, 2026

View reviewed changes

mathetake marked this pull request as ready for review March 1, 2026 01:40

mathetake requested review from agrawroh, mattklein123 and wbpcode as code owners March 1, 2026 01:40

repokitteh-read-only Bot assigned mattklein123 Mar 1, 2026

mathetake commented Mar 1, 2026

View reviewed changes

mathetake added 5 commits March 1, 2026 02:53

stub tests

ecb54d3

Signed-off-by: Takeshi Yoneda <tyoneda@netflix.com>

fmt

0205355

Signed-off-by: Takeshi Yoneda <tyoneda@netflix.com>

stubs

db9f819

Signed-off-by: Takeshi Yoneda <tyoneda@netflix.com>

stubs

f0b0143

Signed-off-by: Takeshi Yoneda <tyoneda@netflix.com>

Merge remote-tracking branch 'origin/main' into staticalliylinkabledm

f8def51

mathetake assigned wbpcode and agrawroh and unassigned mattklein123 Mar 1, 2026

mathetake added 7 commits March 1, 2026 22:04

review: implicitly support for static

6f1dd11

Signed-off-by: Takeshi Yoneda <tyoneda@netflix.com>

more

0600d6e

Signed-off-by: Takeshi Yoneda <tyoneda@netflix.com>

more

3b31056

Signed-off-by: Takeshi Yoneda <tyoneda@netflix.com>

more

057b687

Signed-off-by: Takeshi Yoneda <tyoneda@netflix.com>

fix test

e532493

Signed-off-by: Takeshi Yoneda <tyoneda@netflix.com>

fix test

3291849

Signed-off-by: Takeshi Yoneda <tyoneda@netflix.com>

stable comment

5016877

Signed-off-by: Takeshi Yoneda <tyoneda@netflix.com>

agrawroh approved these changes Mar 2, 2026

View reviewed changes

mathetake merged commit ffc0de4 into envoyproxy:main Mar 2, 2026
29 checks passed

mathetake deleted the staticalliylinkabledm branch March 2, 2026 17:53

mathetake mentioned this pull request Mar 4, 2026

dynamic modules: add asyncDataSource for the module binary using local.filename #43333

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

dynamic_modules: support for statically linked modules#43696

dynamic_modules: support for statically linked modules#43696
mathetake merged 20 commits into
envoyproxy:mainfrom
mathetake:staticalliylinkabledm

mathetake commented Feb 28, 2026 •

edited

Loading

Uh oh!

repokitteh-read-only Bot commented Feb 28, 2026

Uh oh!

mathetake Mar 1, 2026

Uh oh!

mathetake Mar 1, 2026 •

edited

Loading

Uh oh!

agrawroh Mar 1, 2026

Uh oh!

mathetake Mar 1, 2026

Uh oh!

mathetake Mar 2, 2026

Uh oh!

repokitteh-read-only Bot commented Mar 1, 2026

Uh oh!

mathetake Mar 1, 2026

Uh oh!

mathetake Mar 1, 2026 •

edited

Loading

Uh oh!

mathetake commented Mar 1, 2026

Uh oh!

agrawroh commented Mar 2, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

		@@ -640,4 +640,1744 @@ __attribute__((weak)) bool envoy_dynamic_module_callback_matcher_get_header_valu
		return false;
		}


		load("@rules_cc//cc:defs.bzl", "cc_import")

		def envoy_dynamic_module_prefix_symbols(name, module_name, archive, tags = [], **kwargs):

Conversation

mathetake commented Feb 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

repokitteh-read-only Bot commented Feb 28, 2026

Uh oh!

mathetake Mar 1, 2026

Choose a reason for hiding this comment

Uh oh!

mathetake Mar 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

agrawroh Mar 1, 2026

Choose a reason for hiding this comment

Uh oh!

mathetake Mar 1, 2026

Choose a reason for hiding this comment

Uh oh!

mathetake Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

repokitteh-read-only Bot commented Mar 1, 2026

Uh oh!

mathetake Mar 1, 2026

Choose a reason for hiding this comment

Uh oh!

mathetake Mar 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mathetake commented Mar 1, 2026

Uh oh!

agrawroh commented Mar 2, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

mathetake commented Feb 28, 2026 •

edited

Loading

mathetake Mar 1, 2026 •

edited

Loading

mathetake Mar 1, 2026 •

edited

Loading