Files
wasmtime/cranelift/entity
Alex Crichton c89dc55108 Add a two-week delay to Wasmtime's release process (#3955)
* Bump to 0.36.0

* Add a two-week delay to Wasmtime's release process

This commit is a proposal to update Wasmtime's release process with a
two-week delay from branching a release until it's actually officially
released. We've had two issues lately that came up which led to this proposal:

* In #3915 it was realized that changes just before the 0.35.0 release
  weren't enough for an embedding use case, but the PR didn't meet the
  expectations for a full patch release.

* At Fastly we were about to start rolling out a new version of Wasmtime
  when over the weekend the fuzz bug #3951 was found. This led to the
  desire internally to have a "must have been fuzzed for this long"
  period of time for Wasmtime changes which we felt were better
  reflected in the release process itself rather than something about
  Fastly's own integration with Wasmtime.

This commit updates the automation for releases to unconditionally
create a `release-X.Y.Z` branch on the 5th of every month. The actual
release from this branch is then performed on the 20th of every month,
roughly two weeks later. This should provide a period of time to ensure
that all changes in a release are fuzzed for at least two weeks and
avoid any further surprises. This should also help with any last-minute
changes made just before a release if they need tweaking since
backporting to a not-yet-released branch is much easier.

Overall there are some new properties about Wasmtime with this proposal
as well:

* The `main` branch will always have a section in `RELEASES.md` which is
  listed as "Unreleased" for us to fill out.
* The `main` branch will always be a version ahead of the latest
  release. For example it will be bump pre-emptively as part of the
  release process on the 5th where if `release-2.0.0` was created then
  the `main` branch will have 3.0.0 Wasmtime.
* Dates for major versions are automatically updated in the
  `RELEASES.md` notes.

The associated documentation for our release process is updated and the
various scripts should all be updated now as well with this commit.

* Add notes on a security patch

* Clarify security fixes shouldn't be previewed early on CI
2022-04-01 13:11:10 -05:00
..

This crate contains array-based data structures used by the core Cranelift code generator which use densely numbered entity references as mapping keys.

One major difference between this crate and crates like slotmap, slab, and generational-arena is that this crate currently provides no way to delete entities. This limits its use to situations where deleting isn't important, however this also makes it more efficient, because it doesn't need extra bookkeeping state to reuse the storage for deleted objects, or to ensure that new objects always have unique keys (eg. slotmap's and generational-arena's versioning).

Another major difference is that this crate protects against using a key from one map to access an element in another. Where SlotMap, Slab, and Arena have a value type parameter, PrimaryMap has a key type parameter and a value type parameter. The crate also provides the entity_impl macro which makes it easy to declare new unique types for use as keys. Any attempt to use a key in a map it's not intended for is diagnosed with a type error.

Another is that this crate has two core map types, PrimaryMap and SecondaryMap, which serve complementary purposes. A PrimaryMap creates its own keys when elements are inserted, while an SecondaryMap reuses the keys values of a PrimaryMap, conceptually storing additional data in the same index space. SecondaryMap's values must implement Default and all elements in an SecondaryMap initially have the value of default().

A common way to implement Default is to wrap a type in Option, however this crate also provides the PackedOption utility which can use less memory in some cases.

Additional utilities provided by this crate include:

  • EntityList, for allocating many small arrays (such as instruction operand lists in a compiler code generator).
  • SparseMap: an alternative to SecondaryMap which can use less memory in some situations.
  • EntitySet: a specialized form of SecondaryMap using a bitvector to record which entities are members of the set.