ollama/llama/compat/llama-ollama-compat.h
jmorganca 0c33775d37 llama/compat: disable mmap when load_op transforms text-side tensors
Root-cause fix for the glm-ocr GGML_ASSERT(buft) crash: handle_glmocr
fuses ffn_gate + ffn_up into a single ffn_up tensor with ne[1] doubled.
The reshape grows ggml_nbytes past what the file's mmap region for the
original tensor can back, and the upstream loader's mmap path tries to
bind the tensor's storage directly to that (too-small) region. With our
maybe_load_text_tensor hook attempting to fill the tensor before that
binding, cur->buffer is still null and ggml_backend_buft_is_host(nullptr)
asserts.

The previous defensive null-buft check (dbba9b170) only papered over the
crash — it would silently return false and let upstream proceed with the
wrong mmap-backed binding, producing garbage output instead.

Real fix: have handlers that transform text-side tensor bytes call
`disable_mmap_for(ml)`. translate_metadata then returns true, and the
patch site sets `use_mmap = false`. The non-mmap path pre-allocates real
backend buffers via ggml_backend_alloc_ctx_tensors_from_buft, after
which our load_op overrides land in writable memory.

Currently only handle_glmocr needs this; the per-block FFN concat is the
sole text-side reshape with a load_op. Other handlers (gemma3, gemma4,
qwen35, etc.) only do KV translation or rename-without-resize and remain
mmap-compatible.

Patch unchanged in line count (78) — the existing translate_metadata
call site is rewritten to consume the new bool return.

Verification blocked: every prior llama-server process on this box is
wedged in macOS uninterruptible-Metal-wait (UE) and survives kill -9,
preventing new processes from initializing past Metal discovery. Fix
will be live-verified after reboot.
2026-04-20 09:30:27 -07:00

83 lines
3.8 KiB
C++
Vendored

#pragma once
// Ollama-format GGUF compatibility shim.
//
// Older Ollama builds ship GGUFs that differ from upstream in a handful of
// ways per-architecture (arch names, KV keys, tensor names, file layout).
// This shim detects those files during load and translates them in-memory
// so the rest of llama.cpp can load them unmodified.
//
// Three upstream hook points call into this namespace — one per insertion:
//
// 1. llama-model-loader.cpp (main model load):
// translate_metadata() — mutate KVs / tensor metadata
// should_skip_tensor() — filter weights_map population
//
// 2. tools/mtmd/clip.cpp (mmproj load):
// translate_clip_metadata() — rewrite KVs + tensor names for clip
// maybe_load_tensor() — override file read (e.g. F16->F32)
//
// Detection is per-arch; for any non-Ollama file every entry point is a
// no-op. Per-arch logic lives in anonymous-namespace handle_<arch>()
// functions in the .cpp; adding a new arch is a new handler plus one
// dispatch line in each translate_* entry point.
#include <cstddef>
#include <string>
#include "ggml-backend.h" // for ggml_backend_buffer_type_t
struct gguf_context;
struct ggml_context;
struct ggml_tensor;
struct llama_model_loader;
namespace llama_ollama_compat {
// Called from llama_model_loader's constructor, right after the arch is read.
// `fname` is the model file path, captured here so later load-time hooks
// (maybe_load_text_tensor) can read raw bytes from it.
//
// Returns true if the caller must disable mmap for this loader. Some
// handlers transform tensor data via load_op (e.g. glm-ocr's gate+up
// FFN concat), which is incompatible with the default mmap path:
// the upstream loader binds tensors directly to the mmap'd file region,
// so there's nowhere to write the transformed bytes. Disabling mmap
// makes the loader pre-allocate real backend buffers, after which our
// load_op overrides land in writable memory.
bool translate_metadata(const llama_model_loader * ml,
gguf_context * meta,
ggml_context * ctx,
std::string & arch_name,
const char * fname);
// Called from llama_model_loader's weights_map population loop. Returns
// true to drop a tensor from the loader — used to hide embedded vision
// tensors from the text model's view without modifying the gguf_context.
bool should_skip_tensor(const llama_model_loader * ml, const char * tensor_name);
// Called from clip_model_loader's constructor. Rewrites the clip-facing
// view of the metadata (arch=clip, clip.vision.* KVs, renamed tensors)
// so the rest of clip.cpp can load an Ollama monolithic GGUF unchanged.
void translate_clip_metadata(gguf_context * meta, ggml_context * ctx);
// Called from clip.cpp's tensor-loading loop, before the normal file read.
// If this tensor was marked for type promotion by translate_clip_metadata
// (e.g. F16->F32), performs the conversion and writes the result into
// `cur` (host memcpy or backend_tensor_set based on `buft`). Returns true
// when the tensor was handled — caller should skip its normal read path.
bool maybe_load_tensor(ggml_tensor * cur,
const char * source_file,
size_t file_offset,
ggml_backend_buffer_type_t buft);
// Text-side counterpart to maybe_load_tensor. Self-contained: looks up
// the model file path from the per-loader registry populated by
// translate_metadata, and derives the buffer type from cur->buffer
// internally — keeps the call site (and the upstream patch) to one line.
bool maybe_load_text_tensor(const llama_model_loader * ml,
ggml_tensor * cur,
size_t file_offset);
} // namespace llama_ollama_compat