RAGFlow is an agent-native database: a Retrieval-Augmented Generation (RAG) engine that grew into context infrastructure.
Go agent-harnessagent-native-databaseagentic-aiagentic-retrievalagentic-searchaiai-agentscontext-enginecontext-engineeringcontext-managementharness-engineeringknowledge-compilationragretrieval-augmented-generationretrieval-harnesssearch-harness
Perf: link onnxruntime without --whole-archive to cut binary size (#19277)
xugangqiangaaed9fd40e09
diff --git a/build.sh b/build.shindex 2a1c8f5ae9..f346c3c815 100755--- a/build.sh+++ b/build.sh@@ -39,10 +39,11 @@ PDF_OXIDE_VERSION="0.3.73"# onnxruntime native library settings — static linking for the in-process# (Go) DeepDoc backend. libonnxruntime*.a is linked into the server binary-# (--whole-archive + --export-dynamic); OrtGetApiBase is then resolved via-# dlopen(self), so no libonnxruntime.so is needed at runtime. Downloaded by-# ragflow_deps/download_go_deps.py (and ragflow_deps/download_deps.py) into-# onnxruntime/static_lib.+# (--undefined=OrtGetApiBase + --dynamic-list, no --whole-archive); OrtGetApiBase+# is then resolved via dlopen(NULL) (the process-global symbol table, not the+# executable's own path), so no libonnxruntime.so is needed at runtime.+# Downloaded by ragflow_deps/download_go_deps.py (and+# ragflow_deps/download_deps.py) into onnxruntime/static_lib.ONNXRUNTIME_STATIC_PREFIX="${HOME}/ragflow-native-libs/onnxruntime/static_lib"# Copy a dependency from the system pre-seed directory to the user cache.@@ -372,19 +373,20 @@ build_go() {setup_cgo_env# The in-process (Go) DeepDoc backend is statically linked against ONNX- # Runtime (--whole-archive + -Wl,--export-dynamic, see setup_cgo_env). The- # forked onnxruntime_go binding resolves OrtGetApiBase only at RUNTIME via- # dlopen(NULL), so a missing ORT archive still lets `go build` SUCCEED and- # yields a server binary that FAILS AT STARTUP with a fatal- # "no in-process DeepDoc backend serving". That is exactly the breakage- # colleagues hit when ORT was not present at build time and setup_cgo_env- # silently skipped it. Fail the build HERE instead of deferring the breakage- # to runtime: a server binary without ORT is unusable, not a degraded one.+ # Runtime (--undefined=OrtGetApiBase + -Wl,--dynamic-list, see+ # setup_cgo_env). The forked onnxruntime_go binding resolves OrtGetApiBase+ # only at RUNTIME via dlopen(NULL), so a missing ORT archive still lets+ # `go build` SUCCEED and yields a server binary that FAILS AT STARTUP with a+ # fatal "no in-process DeepDoc backend serving". That is exactly the+ # breakage colleagues hit when ORT was not present at build time and+ # setup_cgo_env silently skipped it. Fail the build HERE instead of+ # deferring the breakage to runtime: a server binary without ORT is unusable,+ # not a degraded one.if ! printf '%s' "$CGO_LDFLAGS" | grep -q 'libonnxruntime'; thenecho -e "${RED}Error: ONNX Runtime static libraries are not linked.${NC}" >&2echo " The in-process DeepDoc backend requires libonnxruntime.a to be" >&2- echo " statically linked into ragflow_server (--whole-archive +" >&2- echo " -Wl,--export-dynamic). Without it the binary compiles but dies" >&2+ echo " statically linked into ragflow_server (--undefined=OrtGetApiBase +" >&2+ echo " -Wl,--dynamic-list). Without it the binary compiles but dies" >&2echo " at startup with a fatal 'no in-process DeepDoc backend serving'." >&2echo " Fetch the static libs with:" >&2echo " uv run python3 ragflow_deps/download_go_deps.py" >&2@@ -502,25 +504,35 @@ setup_cgo_env() {# ── onnxruntime (static, resolved via dlopen(NULL)) ────────────────# macOS native builds of the in-process DeepDoc backend are not supported:- # ONNX Runtime is statically linked with GNU ld flags (--whole-archive /- # --export-dynamic) and resolved at runtime via dlopen(NULL); Apple's ld64- # does not understand these flags. Build on Linux or cross-compile there.+ # ONNX Runtime is statically linked with GNU ld flags+ # (-Wl,--undefined=OrtGetApiBase + -Wl,--dynamic-list) and resolved at+ # runtime via dlopen(NULL); Apple's ld64 does not understand these flags.+ # Build on Linux or cross-compile there.case "$(uname -s)" inDarwin)echo "Error: macOS native build of the in-process DeepDoc backend is not supported." >&2- echo " ONNX Runtime is linked with GNU ld flags (--whole-archive / --export-dynamic)" >&2+ echo " ONNX Runtime is linked with GNU ld flags (-Wl,--undefined=OrtGetApiBase + -Wl,--dynamic-list)" >&2echo " and resolved via dlopen(NULL); Apple's ld64 does not support them. Build on Linux." >&2return 1;;esac# Statically link libonnxruntime*.a into the binary. The org Go binding- # (onnxruntime_go, github.com/infiniflow/onnxruntime_go) resolves- # OrtGetApiBase with dlopen(NULL), so the symbols must (a) be pulled in- # wholesale with --whole-archive (ORT registers its execution providers- # lazily at runtime, beyond what a normal link would keep) and (b) be- # exported with --export-dynamic so the process-global symbol table- # dlopen finds them. No libonnxruntime.so is required or supported at- # runtime; there is no dynamic .so fallback.+ # (onnxruntime_go, github.com/infiniflow/onnxruntime_go) resolves OrtGetApiBase+ # with dlopen(NULL) + dlsym(handle, "OrtGetApiBase"), so the ONLY symbol that+ # must be visible in the process-global table is OrtGetApiBase.+ #+ # We therefore do NOT use --whole-archive: that flag force-pulls every .o in+ # the archive (including unregistered "dead" kernels we never call), which+ # is why every ORT size-trimming build flag had near-zero effect before.+ # Instead we link the archives normally and let GNU ld's archive-level GC+ # drop any kernel/EP object that nothing references. The onnxruntime_go+ # binding reaches ORT purely through the OrtApi function-pointer table+ # returned by OrtGetApiBase, and a minimal/reduced-ops build registers only+ # the operators the deepdoc models actually use, so the reachable closure is+ # small. --dynamic-list exports just OrtGetApiBase (the only symbol dlopen+ # needs) and leaves Go's runtime symbols untouched, unlike a "local: *"+ # version script which breaks PIE absolute relocations. No libonnxruntime.so+ # is required or supported at runtime; there is no dynamic .so fallback.## Seed the static ORT archives from the system pre-bake (/opt, laid down# by the CI runner image) into the user cache before the link check@@ -559,14 +571,28 @@ setup_cgo_env() {done < <(find "$ONNXRUNTIME_STATIC_PREFIX" -type f -name '*.a' 2>/dev/null)if [ -n "$ort_a" ]; then- export CGO_LDFLAGS="$CGO_LDFLAGS -Wl,--export-dynamic -Wl,--whole-archive$ort_a -Wl,--no-whole-archive -lstdc++"+ # Export exactly one symbol (OrtGetApiBase) for the binding's+ # dlopen(NULL)+dlsym lookup via --dynamic-list (NOT --version-script+ # with "local: *", which hides Go's runtime type symbols and breaks+ # the PIE absolute relocations). No --whole-archive, so GNU ld's+ # archive-level GC drops any ORT kernel/EP object nothing references.+ local ort_dynamic_list+ ort_dynamic_list="$(mktemp "${TMPDIR:-/tmp}/ort_dynamic.XXXXXX.txt")"+ printf '{\n OrtGetApiBase;\n};\n' > "$ort_dynamic_list"+ # --undefined=OrtGetApiBase force-pulls the archive member that+ # defines OrtGetApiBase (the Go binding reaches ORT only via+ # dlsym("OrtGetApiBase"), so nothing references it at link time and+ # it would otherwise be GC'd). From there the minimal build's CPU-EP+ # registration call chain pulls in the operators the models use.+ export CGO_LDFLAGS="$CGO_LDFLAGS -Wl,--undefined=OrtGetApiBase -Wl,--dynamic-list=$ort_dynamic_list$ort_a -lstdc++"echo " onnxruntime (static) → $ONNXRUNTIME_STATIC_PREFIX"# The re2 regex-library collision between onnxruntime.a and# librag_tokenizer_c_api.a is fixed at the .a level in build_cpp():# the tokenizer's bundled re2 symbols are renamed into a private# namespace (ragtokre2_) so the two re2 copies never share a symbol- # name. --export-dynamic is required because OrtGetApiBase is- # resolved via dlopen(NULL) at runtime (see the block comment above).+ # name. --dynamic-list (above) exports OrtGetApiBase into the process+ # dynamic symbol table, which is what the binding's dlopen(NULL)+dlsym+ # lookup needs at runtime (no --export-dynamic required).elseecho " onnxruntime static_lib dir has no .a files; the in-process DeepDoc backend cannot link ORT" >&2fidiff --git a/go.mod b/go.modindex f53f75c095..53917c5c4f 100644--- a/go.mod+++ b/go.mod@@ -262,7 +262,8 @@ replace github.com/AkmalOt/gomsg => github.com/xugangqiang/gomsg v0.0.0-20260407// onnxruntime_go is mirrored to github.com/infiniflow/onnxruntime_go (org-owned// fork of yalue/onnxruntime_go at v1.23.0) so the in-process DeepDoc backend no// longer depends on a personal fork or the upstream repo directly. ONNX Runtime is-// linked statically (--whole-archive + --export-dynamic); OrtGetApiBase is then-// resolved at runtime via dlopen(NULL) from the running binary, so no+// linked statically (no --whole-archive, so kernels nothing references are+// dropped; only OrtGetApiBase is exported, via --dynamic-list), and OrtGetApiBase+// is then resolved at runtime via dlopen(NULL) from the running binary, so no// libonnxruntime.so is required. The module path matches the import path, so no// replace directive is needed.diff --git a/internal/deepdoc/native/session.go b/internal/deepdoc/native/session.goindex 99914e8863..7c65a25d07 100644--- a/internal/deepdoc/native/session.go+++ b/internal/deepdoc/native/session.go@@ -36,9 +36,11 @@ var (// call multiple times; only the first takes effect. Call it once at process// start (the CLI does this from main).//-// The in-process DeepDoc backend links ONNX Runtime statically (libonnxruntime.a-// is linked into the binary with --whole-archive and exported via-// -Wl,--export-dynamic; see build.sh: ONNX_RUNTIME_STATIC_DIR). The org+// The in-process DeepDoc backend links ONNX Runtime statically:+// libonnxruntime.a is linked in with no --whole-archive, so GNU ld drops the+// kernels and execution providers that nothing references, and only+// OrtGetApiBase is exported, via --dynamic-list (see build.sh:+// ONNXRUNTIME_STATIC_PREFIX). The org// onnxruntime_go binding (github.com/infiniflow/onnxruntime_go) resolves// OrtGetApiBase from the running binary itself via dlopen(NULL) (the// process-global symbol table), so no external libonnxruntime.so is needed anddiff --git a/internal/development.md b/internal/development.mdindex 210d6f751b..5d7eb734f0 100644--- a/internal/development.md+++ b/internal/development.md@@ -62,11 +62,17 @@ uv run python3 ragflow_deps/download_deps.py>> # Resolve the version-stamped ORT archive path FIRST, in its own unquoted> # assignment: the shell does not expand `*` inside the double-quoted-> # CGO_LDFLAGS below, and `--whole-archive` must stay a separate argument from-> # the archive path. If this lists more than one match, delete the stale+> # CGO_LDFLAGS below. If this lists more than one match, delete the stale> # version dir — build.sh refuses to link two ORT versions.> ORT_A="$(ls ${RAGFLOW_DEPS}/onnxruntime/static_lib/*/lib/libonnxruntime.a)">+> # The binding reaches ORT with dlopen(NULL)+dlsym("OrtGetApiBase"), so+> # OrtGetApiBase is the only symbol that must be visible process-wide. Export+> # just it — not via a "local: *" version script, which hides Go's runtime type+> # symbols and breaks PIE absolute relocations. There is deliberately no+> # --whole-archive, so unreferenced kernels are dropped.+> printf '{\n OrtGetApiBase;\n};\n' > /tmp/ort_dynamic.txt+>> export CGO_CFLAGS="-I${RAGFLOW_DEPS}/office_oxide/include/office_oxide_c"> export CGO_LDFLAGS="\> ${RAGFLOW_DEPS}/office_oxide/lib/liboffice_oxide.a \@@ -74,7 +80,7 @@ uv run python3 ragflow_deps/download_deps.py> ${RAGFLOW_DEPS}/pdfium-static/lib/libc++.a \> ${RAGFLOW_DEPS}/pdfium-static/lib/libc++abi.a \> ${RAGFLOW_DEPS}/pdf_oxide/lib/${PLATFORM}/libpdf_oxide.a \-> -Wl,--export-dynamic -Wl,--whole-archive ${ORT_A} -Wl,--no-whole-archive -lstdc++ \+> -Wl,--undefined=OrtGetApiBase -Wl,--dynamic-list=/tmp/ort_dynamic.txt ${ORT_A} -lstdc++ \> -fuse-ld=lld \> -lm -lpthread -ldl -lrt -lgcc_s -lutil -lc"> ```@@ -82,9 +88,11 @@ uv run python3 ragflow_deps/download_deps.py> All four native libraries are statically linked — no `LD_LIBRARY_PATH` or `-Wl,-rpath` needed.>> **ONNX Runtime is mandatory for the production binary.** The in-process (Go)-> DeepDoc backend is statically linked against `libonnxruntime.a` via-> `--whole-archive -Wl,--export-dynamic`, and `OrtGetApiBase` is resolved at-> runtime through `dlopen(NULL)`. The org `onnxruntime_go` binding+> DeepDoc backend is statically linked against `libonnxruntime.a` (no+> `--whole-archive`; `OrtGetApiBase` is force-pulled with+> `-Wl,--undefined=OrtGetApiBase` and exported via `--dynamic-list`), and+> `OrtGetApiBase` is resolved at runtime through `dlopen(NULL)`. The org+> `onnxruntime_go` binding> (github.com/infiniflow/onnxruntime_go, the mirror of yalue/onnxruntime_go) only> needs `-ldl` to *compile*, so a binary built **without** ORT links> successfully but dies at startup with:diff --git a/ragflow_deps/download_deps.py b/ragflow_deps/download_deps.pyindex d599a1f14e..ec53f9dfa6 100644--- a/ragflow_deps/download_deps.py+++ b/ragflow_deps/download_deps.py@@ -86,9 +86,12 @@ def get_urls(use_china_mirrors=False) -> list[str | list[str]]:["https://github.com/yfedoseev/office_oxide/releases/download/v0.1.9/native-linux-x86_64.tar.gz", "office_oxide-linux-x86_64.tar.gz"],# ONNX Runtime static archives for the Go in-process (DeepDoc)# backend. Statically linked into the server binary (see build.sh:- # ONNX_RUNTIME_STATIC_DIR, --whole-archive + --export-dynamic), so- # no libonnxruntime.so is needed at runtime — OrtGetApiBase is- # resolved via dlopen(self). csukuangfj's static_lib build is+ # ONNXRUNTIME_STATIC_PREFIX — no --whole-archive, so kernels nothing+ # references are dropped; only OrtGetApiBase is exported, via+ # --dynamic-list), so no libonnxruntime.so is needed at runtime —+ # OrtGetApiBase is resolved via dlopen(NULL) (the process-global+ # symbol table, not the executable's own path). csukuangfj's+ # static_lib build is# CPU-only and glibc2_28-based, matching ORT_VERSION's C-API line# (ABI-compatible with onnxruntime_go) and the onnxruntime the# Python goldens were generated with.@@ -132,9 +135,12 @@ def get_urls(use_china_mirrors=False) -> list[str | list[str]]:["https://github.com/yfedoseev/office_oxide/releases/download/v0.1.9/native-linux-x86_64.tar.gz", "office_oxide-linux-x86_64.tar.gz"],# ONNX Runtime static archives for the Go in-process (DeepDoc)# backend. Statically linked into the server binary (see build.sh:- # ONNX_RUNTIME_STATIC_DIR, --whole-archive + --export-dynamic), so- # no libonnxruntime.so is needed at runtime — OrtGetApiBase is- # resolved via dlopen(self). csukuangfj's static_lib build is+ # ONNXRUNTIME_STATIC_PREFIX — no --whole-archive, so kernels nothing+ # references are dropped; only OrtGetApiBase is exported, via+ # --dynamic-list), so no libonnxruntime.so is needed at runtime —+ # OrtGetApiBase is resolved via dlopen(NULL) (the process-global+ # symbol table, not the executable's own path). csukuangfj's+ # static_lib build is# CPU-only and glibc2_28-based, matching ORT_VERSION's C-API line# (ABI-compatible with onnxruntime_go) and the onnxruntime the# Python goldens were generated with.