ducktinycc

DuckDB-C-Erweiterung für im Prozess JIT-kompilierte C-UDFs über TinyCC — eigenständig, keine externe Laufzeitumgebung erforderlich

Maintainer: sounkou-bioinfo

Installation und Laden

INSTALL ducktinycc FROM community;
LOAD ducktinycc;

Beispiel

-- Load the extension
LOAD ducktinycc;

-- Compile and register a simple C function as a SQL UDF
SELECT ok, mode, code
FROM tcc_module(
  mode := 'quick_compile',
  source := 'const char *hello_from_c(void){ return "hello from C"; }',
  symbol := 'hello_from_c',
  sql_name := 'hello_from_c',
  return_type := 'varchar',
  arg_types := []
);

-- Call the registered C UDF
SELECT hello_from_c() AS msg;

Über ducktinycc

DuckTinyCC kompiliert und registriert C-Skalar-UDFs aus SQL mit TinyCC (libtcc), im Prozess.

Wichtige SQL-Einstiegspunkte:

Compile-/Codegen- und C-Typ-Hilfsmodi (über tcc_module):

Namensschema der generierten Hilfsfunktionen:

Unterstützung für Typsignaturen (return_type / arg_types):

Entsprechungen der SQL-↔-C-Brücke:

Ergebnisschemas der Funktionen:

Codegen-/Laufzeitmodell:

• Wrapper werden aus return_type/arg_types erzeugt und über ducktinycc_register_signature(…) registriert
• wrapper_mode unterstützt zeilen- und batchweise Ausführungspfade
• Code wird im Speicher kompiliert + relokiert (kein separates Shared-Library-Artefakt)
• Die zweimalige Registrierung desselben sql_name in einer Sitzung liefert false/E_INIT_FAILED (plattformübergreifend konsistent); vor erneuter Registrierung mit tcc_new_state zurücksetzen

Stabilität von Skalar-UDFs:

• compile, quick_compile und codegen_preview akzeptieren stability := ‘consistent’ | ‘volatile’
• tinycc_bind kann die Stabilität für eine spätere Kompilierung vorbereiten; ein expliziter stability-Wert bei compile/quick_compile/codegen_preview überschreibt den vorgestagten Wert
• Verwenden Sie volatile für RNGs, Zähler, Uhren, Allokation, I/O, Callbacks oder Lesezugriffe auf veränderlichen externen Speicher, damit DuckDB die Funktion erneut ausführt und Seiteneffekte nicht constant-foldet
• Generierte Hilfsmodi setzen intern eine explizite Hilfsstabilität: reine Metadaten-/Enum-Helfer sind consistent, während Allokations-/Free-/Setter-/Getter-Helfer für veränderlichen Speicher volatile sind

Eingebettete Laufzeitumgebung (eigenständig):

• libtcc1.a und alle TinyCC-Include-Header (stdarg.h, stddef.h, tccdefs.h usw.) werden zur Build-Zeit in die Erweiterungsbinary eingebettet
• Beim ersten compile- oder quick_compile-Aufruf extrahiert tcc_ensure_embedded_runtime() sie in ein inhaltshash-adressiertes temporäres Verzeichnis (z. B. /tmp/ducktinycc_/)
• Folgeaufrufe im selben Prozess nutzen dieses Verzeichnis erneut, ohne erneut zu extrahieren
• Nach der Bereitstellung ist keine separate TinyCC-Installation oder Laufzeitpfadkonfiguration nötig
• tcc_system_paths() zeigt den aktiven Laufzeitpfad und, ob er aus der eingebetteten Extraktion aufgelöst wurde

Projektdetails und Beispiele: https://github.com/sounkou-bioinfo/DuckTinyCC

Community package excludes WASM targets.

Additional Notes: Generated and helper functions are SQL scalar UDFs; only tcc_module(…), tcc_system_paths(…), and tcc_library_probe(…) are table functions. For library linking, we can pass short names (m, z, c), explicit filenames (libfoo.so, foo.dll, .a, .lib), or path-like values. Because DuckTinyCC uses -nostdlib by default, use library := ‘c’ when generated code needs libc symbols that are not otherwise injected. Pointer helpers are low-level interop tools; for most workflows, handle-based access is safer than raw tcc_dataptr

Hinzugefügte Funktionen

Überladene Funktionen

Diese Erweiterung fügt keine Funktionsüberladungen hinzu.

Hinzugefügte Typen

Diese Erweiterung fügt keine Typen hinzu.

Hinzugefügte Einstellungen

Diese Erweiterung fügt keine Einstellungen hinzu.