Skip to content

chore(compiler): Cleanup legacy cmi handling #2305

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 10, 2025
Merged

chore(compiler): Cleanup legacy cmi handling #2305

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
69d520b
chore(cleanup): Cleanup unused char_utils
spotandjake Jul 6, 2025
1a4fc27
chore(cleanup): Cleanup legacy cmi handling
spotandjake Jul 6, 2025
760d964
chore(cleanup): Cleanup `wasm_utils` legacy cmi handling
spotandjake Jul 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 0 additions & 38 deletions compiler/src/typed/cmi_format.re
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@
open Sexplib.Conv;
open Grain_parsing;
open Grain_utils;
open Wasm_utils;

[@deriving (sexp, yojson)]
type pers_flags =
Expand Down Expand Up @@ -114,39 +113,6 @@ let build_crc = (~name: string, sign: Types.signature) => {
Digest.bytes(ns_sign);
};

let deserialize_cmi = (ic, size) => {
let size = ref(size);
let lexbuf =
Lexing.from_function((buf, n) => {
let n = min(n, size^);
let read = input(ic, buf, 0, n);
size := size^ - read;
read;
});
let state = Yojson.init_lexer();
switch (cmi_infos_of_yojson @@ Yojson.Safe.from_lexbuf(state, lexbuf)) {
| Result.Ok(x) => x
| Result.Error(e) => raise(Invalid_argument(e))
};
};

let serialize_cmi =
(
{cmi_name: name, cmi_sign: sign, cmi_crcs: crcs, cmi_flags: flags} as cmi_info,
) =>
Bytes.of_string @@ Yojson.Safe.to_string @@ cmi_infos_to_yojson(cmi_info);

module CmiBinarySection =
BinarySection({
type t = cmi_infos;

let name = "cmi";

let deserialize = deserialize_cmi;
let serialize = serialize_cmi;
let accepts_version = ({major}) => major == 1;
});

let read_cmi = (ic, filename): cmi_infos => {
let read_magic = Bytes.create(4);
really_input(ic, read_magic, 0, 4);
Expand Down Expand Up @@ -179,10 +145,6 @@ let read_cmi = filename => {
cmi;
};

let serialize_cmi = cmi =>
/* beware: the provided signature must have been substituted for saving */
CmiBinarySection.serialize(cmi);

/* Error report */

open Format;
Expand Down
3 changes: 0 additions & 3 deletions compiler/src/typed/cmi_format.rei
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,6 @@ let config_sum: unit => string;

let build_crc: (~name: string, Types.signature) => Digest.t;

/* write the magic + the cmi information */
let serialize_cmi: cmi_infos => bytes;

/* read a cmi from a filename, checking the magic */
let read_cmi: string => cmi_infos;

Expand Down
3 changes: 0 additions & 3 deletions compiler/src/utils/char_utils.re
View file
Open in desktop

This file was deleted.

211 changes: 0 additions & 211 deletions compiler/src/utils/wasm_utils.re
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,20 +31,6 @@ type wasm_bin_section = {
size: int,
};

[@deriving sexp]
type abi_version = {
major: int,
minor: int,
patch: int,
};

let grain_magic = [0x53, 0x77, 0x13, 0x00]; /* punny, I know [16 April 2018] <Philip>
Took me like 5min to figure out the pun here...
if a bad pun is hidden in the code and no one is
there to explain it, is it still a joke? #showerthoughts [21 October 2019] <Philip> */

let latest_abi = {major: 1, minor: 0, patch: 0};

let identity: 'a. 'a => 'a = x => x;
let i32_of_u64 = Int64.to_int32;

Expand Down Expand Up @@ -91,51 +77,6 @@ let read_leb128:
conv(read_int(maxbits));
};

/* https://graphics.stanford.edu/~seander/bithacks.html#IntegerLog */
let log2_u64 = x => {
open Int64;
let v = ref(zero);
let b = [|
of_int(0x2),
of_int(0xC),
of_int(0xF0),
of_int(0xFF00),
of_int(0xFFFF0000),
shift_left(of_int(0xFFFFFFFF), 8),
|];
let s = [|1, 2, 4, 8, 16, 32|];
let r = ref(0);
for (i in 5 downto 0) {
if (zero != logand(v^, b[i])) {
v := shift_right(v^, s[i]);
r := r^ lor s[i];
};
};
r^;
};

let log2_i64 = x => {
open Int64;
let v = ref(zero);
let b = [|
of_int(0x2),
of_int(0xC),
of_int(0xF0),
of_int(0xFF00),
of_int(0xFFFF0000),
Int64.shift_left(Int64.of_int(0xFFFFFFFF), 8),
|];
let s = [|1, 2, 4, 8, 16, 32|];
let r = ref(0);
for (i in 5 downto 0) {
if (zero != logand(v^, b[i])) {
v := shift_right(v^, s[i]);
r := r^ lor s[i];
};
};
r^;
};

let read_leb128_i32 = (bytesrc): int32 =>
read_leb128(~signed=true, ~maxbits=32, ~conv=i32_of_u64, bytesrc);
let read_leb128_i32_input = inchan =>
Expand All @@ -153,52 +94,12 @@ let read_leb128_u64 = (bytesrc): int64 =>
let read_leb128_u64_input = inchan =>
read_leb128_u64(() => input_byte(inchan));

let read_int32 = inchan => {
let bytes = Bytes.create(4);
really_input(inchan, bytes, 0, 4);
Bytes.get_int32_le(bytes, 0);
};

let read_abi_version = inchan => {
let num_bytes = 4 * 3;
let bytes = Bytes.create(num_bytes);
really_input(inchan, bytes, 0, num_bytes);
open Int32;
let major = to_int(Bytes.get_int32_le(bytes, 0));
let minor = to_int(Bytes.get_int32_le(bytes, 4));
let patch = to_int(Bytes.get_int32_le(bytes, 8));
{major, minor, patch};
};

let serialize_int32 = i => {
let bytes = Bytes.create(4);
open Int32;
Bytes.set_int32_le(bytes, 0, of_int(i));
bytes;
};

let serialize_abi_version = ({major, minor, patch}) => {
let num_bytes = 4 * 3;
let bytes = Bytes.create(num_bytes);
open Int32;
Bytes.set_int32_le(bytes, 0, of_int(major));
Bytes.set_int32_le(bytes, 4, of_int(minor));
Bytes.set_int32_le(bytes, 8, of_int(patch));
bytes;
};

let utf8_encode = ints => {
let buf = Buffer.create(14);
List.iter(i => {Buffer.add_utf_8_uchar(buf, Uchar.of_int(i))}, ints);
Buffer.contents(buf);
};

let utf8_decode = str => {
List.init(String.length(str), i => {
Uchar.to_int(Uchar.of_char(str.[i]))
});
};

let section_type_of_int = (~pos=?, ~name=?) =>
fun
| 0 => Custom(Option.value(~default="", name))
Expand All @@ -216,22 +117,6 @@ let section_type_of_int = (~pos=?, ~name=?) =>
| 12 => DataCount
| n => raise(MalformedSectionType(n, pos));

let int_of_section_type =
fun
| Custom(_) => 0
| Type => 1
| Import(_) => 2
| Function => 3
| Table => 4
| Memory => 5
| Global => 6
| Export(_) => 7
| Start => 8
| Element => 9
| Code => 10
| Data => 11
| DataCount => 12;

let get_wasm_sections = (~reset=false, inchan) => {
let orig_pos = pos_in(inchan);
let read_boilerplate = () => {
Expand Down Expand Up @@ -378,102 +263,6 @@ let get_wasm_sections = (~reset=false, inchan) => {
ret;
};

let get_grain_custom_info = inchan =>
try({
let rec check_magic = remaining =>
switch (remaining) {
| [] => true
| [hd, ...tl] => input_byte(inchan) == hd && check_magic(tl)
};
if (!check_magic(grain_magic)) {
None;
} else {
let version = read_abi_version(inchan);
let section_name_length = Int32.to_int(read_int32(inchan));
let section_name_bytes = Bytes.create(section_name_length);
really_input(inchan, section_name_bytes, 0, section_name_length);
let section_name = Bytes.to_string(section_name_bytes);
Some((version, section_name));
};
}) {
| End_of_file => None
};

let serialize_grain_custom_info = (sec_name, abi_version) => {
let sec_bytes = Bytes.of_string(sec_name);
let buf = Buffer.create(Bytes.length(sec_bytes) + 4 + 4 * 3 + 4);
List.iter(b => Buffer.add_char(buf, char_of_int(b)), grain_magic);
Buffer.add_bytes(buf, serialize_abi_version(abi_version));
Buffer.add_bytes(buf, serialize_int32(Bytes.length(sec_bytes)));
Buffer.add_bytes(buf, sec_bytes);
Buffer.to_bytes(buf);
};

module type BinarySectionSpec = {
type t;

let name: string;
let deserialize: (in_channel, int) => t;
let accepts_version: abi_version => bool;
let serialize: t => bytes;
};

module type BinarySectionSig = {
type t;

/** Loads the first instance of this section from the WASM module
loaded at the given [in_channel]. */
/** Serializes this section at the current position in the given [out_channel]. */

let load: (~preserve: bool=?, in_channel) => option(t);

/** Serializes this section at the current position in the given [out_channel]. */

let serialize: t => bytes;
};

module BinarySection =
(Spec: BinarySectionSpec)
: (BinarySectionSig with type t = Spec.t) => {
type t = Spec.t;

let load = (~preserve=false, inchan) => {
let orig_pos = pos_in(inchan);
let sections =
List.filter(
({sec_type}) => sec_type == Custom(Spec.name),
get_wasm_sections(inchan),
);
let rec process = sections =>
switch (sections) {
| [] => None
| [{offset, size}, ...tl] =>
seek_in(inchan, offset);
switch (get_grain_custom_info(inchan)) {
| Some((abi_version, name))
when name == Spec.name && Spec.accepts_version(abi_version) =>
/* Now we're at the start of the section. Time to read */
let realsize = size - (pos_in(inchan) - offset);
Some(Spec.deserialize(inchan, realsize));
| _ => process(tl)
};
};

let ret = process(sections);
if (preserve) {
seek_in(inchan, orig_pos);
};
ret;
};

let serialize = value => {
let val_bytes = Spec.serialize(value);
let header_bytes = serialize_grain_custom_info(Spec.name, latest_abi);
let sep = Bytes.empty;
Bytes.concat(sep, [header_bytes, val_bytes]);
};
};

let () =
Printexc.register_printer(exc =>
switch (exc) {
Expand Down
35 changes: 0 additions & 35 deletions compiler/src/utils/wasm_utils.rei
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,6 @@ type wasm_bin_section = {
size: int,
};

[@deriving sexp]
type abi_version = {
major: int,
minor: int,
patch: int,
};

let latest_abi: abi_version;

let read_leb128_i32: (unit => int) => int32;
let read_leb128_i32_input: in_channel => int32;

Expand All @@ -52,29 +43,3 @@ let read_leb128_u64: (unit => int) => int64;
let read_leb128_u64_input: in_channel => int64;

let get_wasm_sections: (~reset: bool=?, in_channel) => list(wasm_bin_section);

module type BinarySectionSpec = {
type t;

let name: string;
let deserialize: (in_channel, int) => t;
let accepts_version: abi_version => bool;
let serialize: t => bytes;
};

module type BinarySectionSig = {
type t;

/** Loads the first instance of this section from the WASM module
loaded at the given [in_channel]. */
/** Serializes this section at the current position in the given [out_channel]. */

let load: (~preserve: bool=?, in_channel) => option(t);

/** Serializes this section at the current position in the given [out_channel]. */

let serialize: t => bytes;
};

module BinarySection:
(Spec: BinarySectionSpec) => BinarySectionSig with type t = Spec.t;
Loading