Files
ollama_ollama/llama/compat/README.md
T
Daniel Hiltgen 9db4bdbad6 runner: Remove CGO engines, use llama-server exclusively for GGML models (#16031)
* broad lint fixes to sidestep CI scope glitch

* runner: Remove CGO engines, use llama-server exclusively for GGML models

Remove the vendored GGML and llama.cpp backend, CGO runner, Go model
implementations, and sample.  llama-server (built from upstream llama.cpp via
FetchContent) is now the sole inference engine for GGUF-based models.
(Safetensor based models continue to run on the new MLX engine.)  This allows
us to more rapidly pick up new capabilities and fixes from llama.cpp as they
come out.

On windows this now requires recent AMD driver versions to support ROCm v7 as
llama.cpp currently does not support building against v6.

* llama/compat: load Ollama-format GGUFs in llama-server

Squashed from upstream/jmorganca/llama-compat on 2026-04-29.
Source tip: 0c33775d37.

Original source commits:
- 25223160d llama/compat: add in-memory shim so llama-server can load Ollama-format GGUFs
- 7449b539a llm,server: route Ollama-format gemma3 blobs through llama/compat
- 436f2e2b1 llama/compat: make patch-apply idempotent
- 8c2c9d4c8 llama/compat: extend gemma3 handler to cover 1B and 270M blobs
- 021389f7b llama/compat: shrink clip.cpp injection from 18 lines to 1
- 61b367ec2 llama/compat: shrink patch to pure call-site hooks (34 -> 20 lines)
- 36049361c llama/compat: simplify shim (gemma3-tested)
- 8fa664865 llama/compat: add qwen35moe text handler
- db0c74530 llama/compat: add qwen35moe vision (clip) support
- 2a388da77 llama/compat: split shared infra into a util TU
- 9a69a17dc llama/compat: document non-public API dependencies
- d0f38a915 llama/compat: add gpt-oss and lfm2 handlers
- 086071822 llama/compat: add mistral3 text handler (vision TODO)
- 63bde9ff7 llama/compat: add mistral3 vision (clip) support
- 3a57b89d5 llama/compat: apply LLaMA RoPE permute to mistral3 vision Q/K
- 99cb87439 llama/compat: add qwen35, gemma4, deepseek-ocr handlers
- 2c7850dba llama/compat: add nemotron_h_moe handler (latent FFN + MTP skip)
- 9e3b54225 llama/compat: add llama4 text + clip handlers
- 034fee349 llama/compat: add gemma4 clip handler (gemma4v projector)
- 9945c5a93 server: remove dhiltgen/* compat redirect table
- 5d4539101 llama/compat: rewrite gemma4 tokenizer model to BPE
- 7e0765327 llama/compat: add glm-ocr text handler + text-loader load-op hook
- f1bd1a25a llama/compat: add glm-ocr clip handler (glm4v projector)
- 4b5cf3420 llama/compat: collapse text-loader hook back to one new patch line
- eb4ecf4fc llama/compat: extend gemma4 clip handler to gemma4a (audio)
- a23a5e76f llama/compat: fix gemma4a per-block norm tensor mapping
- cd2dcaff4 llama/compat: add embeddinggemma handler
- 1ce8a6b26 llama/compat: add qwen3-vl + qwen2.5-vl handlers
- fd98ffa1e llama/compat: add gemma3n + glm4moelite handlers
- cc7bdf0bc llama/compat: handle null buft in maybe_load_tensor
- 0c33775d3 llama/compat: disable mmap when load_op transforms text-side tensors

* refine implementation

* ci: fix windows MLX build

* ci: fix windows llama-server build

* ci: fix windows rocm build

* ci: windows mlx tuning

Shorten long-tail on build, and get OllamaSetup.exe back under 2g limit

* ci: fix windows dependencies

* win: fix dependency gathering

* disable openmp

* win: arm64 cross-compile build

also DRY out CI steps

* scheduler improvements

* ci: improvements from #15982

* win: favor ninja for faster developer builds

* win: fix build

* win: fix arm64 cross-compile

* win: avoid spaces in compiler path

* misc discovery fixes, and bos handling

* lint fixes

* win: fix arm cross-compile build/CI bugs

* llama.cpp update

* win: handle multiple CRT dirs

* vulkan: add windows iGPU detection

* fix creation bugs for patched models, other refactoring work

* tune batch size for better performance

* ci and lint fixes

* fix repeat_last_n bug

* build: revamp build for better developer UX

* amd, sampler, qwen3next fixes

* version bump

* fix mlx build

* revamp GPU discovery

Scanning the output of llama-server is turning out to be too error prone across
llama.cpp updates, so this switches to a thin dynamic library load against the
bundled GGML libraries so more details can be gathered from the API.

* version bump

* missing file

* ci: fix cache miss on rocm build

* refine vulkan dep handling

* fix ps reporting bug on full GPU load

* improve cmake wiring for customized local builds

* version bump

* docker build arg cleanup

* improve windows exit error logs

* fix community gemma4 support and ci flakes

* fix mlx unit test

* tighten up ps logic to avoid double counting fit log lines

* version bump

* fix ps view for full gpu layer offload

* add MTP wiring for llama-server and create with GGUFs

* pick best template by capabilities

* version bump

* ci: harden apt repos

* remove unused cpu core discovery

* adjust batch default logic to reduce OOMs

* support larger tool calls

* fix audio support, template show

* qwen35 mtp patch support

* flesh out dtypes

* rocm deps

* version bump

* lint fix

* block broken gfx1150 on windows

* fix qwen3.5 moe mtp tensors in patch

* mmproj oom fallback and vulkan on by default

* qwen MTP compat fix

* version bump

* ci: fix WoA cross-compile

* ci: workaround ui tool in cross-compile

* version bump

* win: enable OpenMP for CPU builds

* build: improve developer UX

* ci: windows path workaround for CPU build

* win: fix WoA dependencies

* win: fix large offset reads for mmproj patched loads

* version bump

* fix vulkan dup detection

* add OLLAMA_IGPU_ENABLE and largely disable iGPUs by default

* opt-in MTP, win large offset, integraton fixes

* fix unit test scheduler interaction hang

* fix multi-gpu filtering

* version bump

* review comments

* fix thinking level

* fix linux rocm ordering and granite 3.3 template

* version bump

* ci fix - non-shallow MLX checkout

* bypass linux sysfs unit test on windows

---------

Co-authored-by: jmorganca <jmorganca@gmail.com>
2026-05-29 13:35:47 -07:00

8.1 KiB

llama.cpp compatibility layer

This directory holds a temporary in-process compatibility layer for existing published Ollama GGUFs whose metadata or tensor layout does not yet match what llama.cpp expects directly. The layer translates those files in memory at load time so users do not need to re-pull or re-create models during the transition to llama-server.

This patch model is intended to be short lived. The target end state is that published models and newly created models use llama.cpp-compatible metadata and tensor layouts on disk, and this directory can be removed.

The layer is applied automatically at build time via CMake FetchContent's PATCH_COMMAND for normal fetched builds. If CMake is pointed at a source override through FETCHCONTENT_SOURCE_DIR_LLAMA_CPP, the same patch is applied during configure. If OLLAMA_LLAMA_CPP_SOURCE is set, the patch is intentionally skipped so a developer can iterate on a local llama.cpp tree.

Files

  • llama-ollama-compat.h, llama-ollama-compat.cpp - the compatibility entry points and per-architecture handlers.
  • llama-ollama-compat-util.h, llama-ollama-compat-util.cpp - helpers for KV edits, tensor renames, skip-prefix tracking, tensor load operations, and small tensor repacking primitives.
  • llama-cpp-hooks.patch - small additive call-site edits in llama.cpp files. It currently touches src/llama-model-loader.cpp and tools/mtmd/clip.cpp.
  • compat.cmake, apply-patch.cmake - CMake glue and an idempotent patch applier used by llama/server/CMakeLists.txt.

The compatibility source files stay in this directory and are linked into the fetched llama.cpp targets. The patch file only adds call sites.

Load-Time Hooks

The layer runs at a small set of loader hook points:

  1. Main model constructor: translate_metadata inspects the parsed metadata and mutates the in-memory gguf_context and ggml_context when a handler recognizes an existing published model format. It can also request mmap disablement when a handler needs writable backend buffers for transformed tensor data.
  2. Main model tensor indexing: should_skip_tensor hides embedded projector, vision, audio, MTP, or other tensors that the text loader should not claim.
  3. Main model tensor reads: maybe_load_text_tensor applies registered text-side load operations, such as FFN concat or dtype promotion, before the normal llama.cpp file read. This is wired into both full model loading and single-tensor reads used by tools such as llama-quantize.
  4. mtmd/clip constructor: translate_clip_metadata rewrites a clip-facing view of monolithic GGUFs into the mmproj form expected by llama.cpp.
  5. mtmd/clip tensor load loop: maybe_load_tensor applies clip-side load operations, such as F16 to F32 promotion, QKV merge, tensor repack, tensor split, or zero-fill.

Files that do not match a supported published-model marker are left unchanged. Setting OLLAMA_LLAMA_CPP_COMPAT=0 disables the hook bodies for internal create-time validation and for models that are already known to be llama.cpp-compatible on disk.

Supported Transformations

This table tracks the dispatch surface. Keep it brief; the handler comments in llama-ollama-compat.cpp are the source of truth for exact KV and tensor maps.

Internal arch / marker Text handling Clip/mmproj handling
gemma3 Normalizes Gemma 3 metadata, tokenizer fields, and embedded vision/projector tensors. Gemma 3 projector translation.
gemma3 + embedding markers (embeddinggemma) Maps to gemma-embedding metadata and fixes embedding dense/norm tensors. n/a
bert + Snowflake markers (snowflake-arctic-embed2) Fixes Snowflake Arctic Embed 2 tokenizer metadata. n/a
gemma3n Normalizes tokenizer/EOS metadata, truncates vocab-shaped tensors, and hides unused embedded vision/audio/projector tensors. n/a
gemma4 Normalizes tokenizer metadata and hides embedded audio/vision/projector tensors from the text loader. Gemma 4 projector translation; audio remains disabled.
gptoss Maps to gpt-oss, copies KVs, injects missing expert FFN metadata, and renames tensors. n/a
lfm2 Renames norm tensors and fixes feed-forward metadata. n/a
olmo3 Maps to the OLMo2-compatible loader path. n/a
mistral3 Fixes RoPE/YaRN metadata and hides embedded vision/projector tensors. Pixtral-style projector translation.
qwen35, qwen35moe Fixes Qwen3.5/Qwen3-VL-style text metadata, translates embedded MTP tensors, and hides embedded vision/projector tensors. Qwen3-VL merger-style projector translation.
qwen3next Normalizes hybrid attention KV-head metadata and renames SSM dt tensors to the names expected by llama.cpp. n/a
qwen25vl Maps to qwen2vl metadata conventions. Qwen2.5-VL projector translation.
qwen3vl, qwen3vlmoe Adds missing Qwen3-VL metadata and hides embedded vision/projector tensors. Qwen3-VL projector translation, including QKV merge and patch-embedding split/repack.
deepseekocr Maps to deepseek2-ocr, injects missing OCR/MoE metadata, and hides embedded SAM/vision/projector tensors. DeepSeek OCR projector translation.
glmocr Maps GLM OCR metadata/tensors to the llama.cpp-compatible view. GLM OCR projector translation.
glm4moelite Maps GLM-4.7 Flash MLA metadata to the deepseek2 path and fixes special-token metadata. n/a
nemotron_h_moe Fixes latent-FFN variants and hides MTP tensors. n/a
nemotron_h_omni Selects the Nemotron text loader and hides audio/vision/projector tensors from the text loader. Nemotron V2 VL projector translation; audio remains disabled.
llama with Llama 3 markers Fixes Llama 3 tokenizer metadata. n/a
llama4 Hides embedded vision/projector tensors from the text loader. Llama 4 projector translation.
clip projector without clip.projector_type n/a Defaults LLaVA/BakLLaVA projectors to clip.projector_type=mlp.

Usage:

llama-server --model /path/to/ollama-blob --mmproj /path/to/ollama-blob

Passing the same monolithic GGUF as both --model and --mmproj works because each loader applies its own translation.

Additional architectures are added by implementing a handle_<arch>() and, for vision models, handle_<arch>_clip() in llama-ollama-compat.cpp, then dispatching them from translate_metadata / translate_clip_metadata. For monolithic vision models, also update the compatClipArches allowlist in llm/llama_server.go so Ollama passes the main GGUF as --mmproj.

Regenerating the Patch File

After a llama.cpp bump moves the insertion points, re-apply the edits to a fresh checkout and run:

cd /path/to/llama.cpp
git diff -- \
    src/llama-model-loader.cpp \
    tools/mtmd/clip.cpp \
    > /path/to/ollama/llama/compat/llama-cpp-hooks.patch

Implementation Notes

The compatibility code is mostly written against public APIs (gguf.h, ggml.h, ggml-backend.h). A few operations rely on implementation details because the public API does not expose equivalent mutators:

Dependency Use Replacement if needed
Direct writes to ggml_tensor::type / ne[] / nb[] Post-creation tensor reshape/retype for in-memory translation. Add public tensor shape/type mutators.
const_cast<char *>(gguf_get_tensor_name(...)) in rename_tensor Renames gguf tensors in place. Add a public gguf_rename_tensor helper.
llama_model_loader forward declaration from src/llama-model-loader.h Opaque key for per-loader registries. The pointer is never dereferenced. Replace registry keys with const void *.

Two helpers need extra context:

  • reclaim_slot_as repurposes an orphaned tensor slot as a synthesized tensor when a clip handler splits one source tensor into multiple destination tensors. This is needed because clip metadata loading allocates exactly enough tensor slots for the source file.
  • Load-op registry overrides ignore the caller-provided file_offset when a registered operation exists. The operations capture their own source offsets at translation time, before renames change tensor names.