Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

Derive the .cmi / .cmt / .ast magic numbers instead of bumping them in every PR

Aberta
  • Algo errado?
#8,947 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
5/5
Tempo estimado
Mais de uma semana
Facilidade para iniciantes
35/100
Tipo de issue
Funcionalidade
Clareza
Claramente especificada
Status de atividade
Ativa
Stack de tecnologia
ocaml
Domínio
compilers

Direção de pesquisa

Start with compiler/ext/config.ml and inspect how the .cmi, .cmt, and .ast magic numbers are defined, then trace the serialized interfaces and release tooling described in the proposal. The work spans digest generation, release recording and counter updates, and possibly dev build suffixes and prefix changes. Done means release counters change only when serialized layouts change, outside tools can distinguish compatible releases, and the changelog notes the prefix change.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

Problem

compiler/ext/config.ml holds hand-numbered magic numbers for .cmi (Caml1999I036), .cmt (Caml1999T043) and marshaled .ast files (ResImpl01315 / ResIntf01315). Every PR that changes a serialized type bumps them, so parallel PRs constantly conflict on the same lines. That's the same problem we had with CHANGELOG.md before fragments. There have been about 20 bumps since August.

The per-PR precision buys nothing:

  • Rebuilds after a compiler change are driven by bsc_hash, which both build systems store, not by the magic numbers.
  • Outside tools only ever see released versions, so intermediate bumps between two releases are invisible to them.
  • A bump forgotten in a PR fails silently: mixing files across a layout change crashes in Marshal instead of giving a clean error.

The Caml1999 prefix is a separate problem. OCaml 5.5 uses Caml1999I037 / Caml1999T037, so our I036 is most likely a real OCaml release's .cmi number, and the next bump would collide with OCaml 5.5. An OCaml tool would then accept a ReScript .cmi and misread it, instead of rejecting it.

What outside tools need

Tools that read .cmi/.cmt files may rely on the magic number. They need:

  • A stable number for each release.
  • A change between releases only when the format may have changed, so they can tell that two releases share a format.
  • Ordering, for "built by a newer compiler" checks (cmi_format.ml already uses it for its older/newer error).

Proposal

Bump the counters at release time, not in PRs:

  1. A dune rule computes a digest of the interfaces whose values are serialized. For .cmi that is types, path, ident, parsetree, …; for .cmt add typedtree; for .ast it is parsetree. Prefer whole directories or dune's cmi digests over a hand-picked file list, which would go stale like manual bumps do.
  2. A checked-in file records the counter and digest from the last release. PRs never touch it.
  3. The release script, or a CI check on release PRs, compares the current digest with the recorded one. If they differ, it bumps the counter and records the new digest. Comment-only edits cause harmless extra bumps.
  4. Optional: dev builds append the digest (e.g. …037+3fa9c1d2), so mixing two dev builds that share a counter but differ in layout gives a clean error instead of a crash. Releases ship the bare counter.
  5. Switch to our own prefixes (e.g. ResCmi… / ResCmt…, like the .ast numbers already did), so OCaml tools reject our files. Note this in the changelog because outside tools will see it.

Not in scope: .cmj has no magic number yet, only a digest of its own content (js_cmj_format.ml has a TODO). It could get a counter under the same scheme. The frozen Parsetree0 PPX numbers (Caml1999M022 / N022) must never change and stay as they are.

Alternatives considered

  • The compiler version as the magic number. Stable per release and never touched by PRs. However, it changes on every release even when the format didn't, it has no meaningful ordering across prereleases, and dev builds sharing a version can't detect a layout mismatch.
  • A pure content digest. Exact and never conflicts, but outside tools can't see that two releases share a format, and there's no ordering.
Linguagem predominante
OCaml
Estrelas
7.5k
Forks
483
Merge médio
21h 8min
PRs com merge (30d)
183

Preparar o ambiente

Abrir no Codespaces

Inicia o contêiner de desenvolvimento do projeto no navegador, com a sua própria conta do GitHub.

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de rescript-lang/rescript

Todas as issues de rescript-lang/rescript

Issues semelhantes

Mais issues de Compilers

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.