changelog shortlog graph tags branches changeset files file revisions raw help

Mercurial > org > docs / annotate core/ffi.org

changeset 12: 31db7a83d2c6
child: 2601788ab805
author: ellis <ellis@rwest.io>
date: Tue, 12 Dec 2023 21:50:16 -0500
permissions: -rw-r--r--
description: ffi
12
ellis <ellis@rwest.io>
parents:
diff changeset
1
 {{{header(core/ffi,Richard Westhaver,ellis@rwest.io)}}}
ellis <ellis@rwest.io>
parents:
diff changeset
2
 
ellis <ellis@rwest.io>
parents:
diff changeset
3
 This doc is about the [[https://en.wikipedia.org/wiki/Foreign_function_interface][Foreign Function Interface]] (FFI) features of the
ellis <ellis@rwest.io>
parents:
diff changeset
4
 =core=. 
ellis <ellis@rwest.io>
parents:
diff changeset
5
 
ellis <ellis@rwest.io>
parents:
diff changeset
6
 Besides accessing system, OS, and external libraries via binding code
ellis <ellis@rwest.io>
parents:
diff changeset
7
 (dynamically in Lisp, statically in Rust), we also expose parts of the
ellis <ellis@rwest.io>
parents:
diff changeset
8
 core in a C-compatible fashion. In Lisp, we use the SB-ALIEN interface
ellis <ellis@rwest.io>
parents:
diff changeset
9
 to load (with dlopen) and call foreign symbols. In Rust we mostly use
ellis <ellis@rwest.io>
parents:
diff changeset
10
 rust-bindgen and the built-in rustc features.
ellis <ellis@rwest.io>
parents:
diff changeset
11
 
ellis <ellis@rwest.io>
parents:
diff changeset
12
 * Libraries
ellis <ellis@rwest.io>
parents:
diff changeset
13
 The following binding libraries are provided with supporting
ellis <ellis@rwest.io>
parents:
diff changeset
14
 code. There is some cross-over between the Lisp and Rust bindings
ellis <ellis@rwest.io>
parents:
diff changeset
15
 depending on what library features we need and where. Some of the
ellis <ellis@rwest.io>
parents:
diff changeset
16
 bindings are very minimal or for experimental-use only only.
ellis <ellis@rwest.io>
parents:
diff changeset
17
 ** xkb
ellis <ellis@rwest.io>
parents:
diff changeset
18
 These bindings are actually directed at libxkbcommon instead of
ellis <ellis@rwest.io>
parents:
diff changeset
19
 x11/xkb directly.
ellis <ellis@rwest.io>
parents:
diff changeset
20
 *** xkbcommon
ellis <ellis@rwest.io>
parents:
diff changeset
21
 https://xkbcommon.org/doc/current/md_doc_2quick-guide.html
ellis <ellis@rwest.io>
parents:
diff changeset
22
 ** rocksdb
ellis <ellis@rwest.io>
parents:
diff changeset
23
 [[https://github.com/facebook/rocksdb/wiki][RocksDB Wiki]]
ellis <ellis@rwest.io>
parents:
diff changeset
24
 ** btrfs
ellis <ellis@rwest.io>
parents:
diff changeset
25
 The kernel headers btrfs and btrfs_tree will be wrapped at some point
ellis <ellis@rwest.io>
parents:
diff changeset
26
 in addition to the userspace library (btrfsutil) documented below.
ellis <ellis@rwest.io>
parents:
diff changeset
27
 *** btrfsutil
ellis <ellis@rwest.io>
parents:
diff changeset
28
 https://github.com/kdave/btrfs-progs
ellis <ellis@rwest.io>
parents:
diff changeset
29
 ** uring
ellis <ellis@rwest.io>
parents:
diff changeset
30
 https://man.archlinux.org/man/io_uring.7.en
ellis <ellis@rwest.io>
parents:
diff changeset
31
 ** alpm
ellis <ellis@rwest.io>
parents:
diff changeset
32
 https://man.archlinux.org/man/core/pacman/libalpm.3.en
ellis <ellis@rwest.io>
parents:
diff changeset
33
 https://github.com/archlinux/alpm.rs/tree/382af70cdbff8e1f65c0bf8df79693786f44429c/alpm/examples
ellis <ellis@rwest.io>
parents:
diff changeset
34
 ** zstd
ellis <ellis@rwest.io>
parents:
diff changeset
35
 zstd compression bindings: https://github.com/facebook/zstd
ellis <ellis@rwest.io>
parents:
diff changeset
36
 ** tree-sitter
ellis <ellis@rwest.io>
parents:
diff changeset
37
 bindings to tree-sitter parser generator and language libraries: https://github.com/tree-sitter/tree-sitter
ellis <ellis@rwest.io>
parents:
diff changeset
38
 ** blake3
ellis <ellis@rwest.io>
parents:
diff changeset
39
 temporary package for CL implementation of Blake3 SHA. Wraps C
ellis <ellis@rwest.io>
parents:
diff changeset
40
 implementation (libblake3).
ellis <ellis@rwest.io>
parents:
diff changeset
41
 ** bqn
ellis <ellis@rwest.io>
parents:
diff changeset
42
 These bindings are for libcbqn which can be build from CBQN:
ellis <ellis@rwest.io>
parents:
diff changeset
43
 https://github.com/dzaima/CBQN
ellis <ellis@rwest.io>
parents:
diff changeset
44
 ** k
ellis <ellis@rwest.io>
parents:
diff changeset
45
 https://codeberg.org/ngn/k
ellis <ellis@rwest.io>
parents:
diff changeset
46
 bindings for ngn/k (libk).