ik-llama-cpp-sys 0.1.1

Low level bindings to ik_llama.cpp (ikawrakow's SOTA-quant fork)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

#pragma once

// C ABI glue for ik_llama.cpp's MTP (Multi-Token-Prediction / NextN) speculative
// decoding, compiled only under the `common` feature. Wraps ik's C++
// `common_speculative_*` + `common_sampler` (in libcommon.a) so Rust binds a
// small, stable `extern "C"` surface (bindgen allowlist `ik_llama_rs_.*`).
//
// This header is pure C (parsed by bindgen); the heavy C++ common headers are
// included only by wrapper_common.cpp. `llama_*` types come from llama.h, which
// wrapper.h includes before this header.

#include "wrapper_utils.h"

#ifdef __cplusplus
extern "C" {
#endif

// Convert a JSON Schema (as a JSON string) into a GBNF grammar string. Wraps
// libcommon's C++ `json_schema_to_grammar`. On LLAMA_RS_STATUS_OK, writes a
// heap-allocated NUL-terminated grammar string to `*out_grammar` (the caller
// frees it with ik_llama_rs_string_free). On any error `*out_grammar` is left
// NULL. Returns LLAMA_RS_STATUS_INVALID_ARGUMENT for null args,
// LLAMA_RS_STATUS_EXCEPTION on parse/conversion failure, or
// LLAMA_RS_STATUS_ALLOCATION_FAILED if the result string could not be duplicated.
llama_rs_status ik_llama_rs_json_schema_to_grammar(
        const char  * schema_json,
        bool          force_gbnf,
        char       ** out_grammar);

// Free a string returned via `out_grammar` by the function above.
void ik_llama_rs_string_free(char * ptr);

// Opaque MTP speculative driver handle.
typedef struct ik_llama_rs_mtp ik_llama_rs_mtp;

// Initialize the MTP speculative driver over an existing target context.
//
// Preconditions (the caller MUST satisfy these — see the Rust MtpSpeculative):
//   * `model`   was loaded with model_params.mtp = true (NextN tensors present), and
//   * `ctx_tgt` was created with context_params.mtp = true.
// `cparams_tgt` must be the same `llama_context_params` used to build `ctx_tgt`;
// the companion MTP context is derived from it (+ MTP warmup/embeddings overrides).
// `temp <= 0` selects a greedy target sampler.
//
// Returns NULL on error, including: null args, a model with 0 NextN layers, or an
// openPangu/recurrent target (v1 supports embedded NextN-MTP only).
ik_llama_rs_mtp * ik_llama_rs_mtp_init(
        struct llama_model                * model,
        struct llama_context              * ctx_tgt,
        const struct llama_context_params * cparams_tgt,
        int32_t                             n_max,
        int32_t                             n_min,
        float                               p_min,
        int32_t                             mtp_heads,
        float                               temp);

// Prompt warmup + begin + capture final hidden state. The driver OWNS the prompt
// decode (it must feed an all-logits batch). Call once before stepping.
// Returns n_past (>= 0) on success, or a negative `llama_rs_status` on error.
long ik_llama_rs_mtp_begin(
        ik_llama_rs_mtp   * spec,
        const llama_token * prompt,
        size_t              n_prompt);

// Run one draft -> verify -> accept -> commit cycle. Writes the tokens emitted
// this step into `out_tokens[0..*n_out)` (append these to the visible output;
// each token is emitted exactly once across steps). `*n_accepted` = number of
// draft tokens accepted this step. The caller decides when to stop (EOG / budget).
// Returns LLAMA_RS_STATUS_OK on success.
llama_rs_status ik_llama_rs_mtp_step(
        ik_llama_rs_mtp * spec,
        llama_token     * out_tokens,
        size_t            cap,
        size_t          * n_out,
        int32_t         * n_accepted);

void ik_llama_rs_mtp_free(ik_llama_rs_mtp * spec);

#ifdef __cplusplus
}
#endif