diff --git a/src/memory-model.md b/src/memory-model.md index 404240db8..cc3cf02ec 100644 --- a/src/memory-model.md +++ b/src/memory-model.md @@ -1,5 +1,26 @@ +r[memory] # Memory model -Rust does not yet have a defined memory model. Various academics and industry professionals -are working on various proposals, but for now, this is an under-defined place -in the language. +> [!WARNING] +> The memory model of Rust is incomplete and not fully decided. + +r[memory.bytes] +## Bytes + +r[memory.bytes.intro] +The most basic unit of memory in Rust is a byte. + +> [!NOTE] +> While bytes are typically lowered to hardware bytes, Rust uses an "abstract" notion of bytes that can make distinctions which are absent in hardware, such as being uninitialized, or storing part of a pointer. Those distinctions can affect whether your program has undefined behavior, so they still have tangible impact on how compiled Rust programs behave. + +r[memory.bytes.contents] +Each byte may have one of the following values: + +r[memory.bytes.init] +* An initialized byte containing a `u8` value and optional [provenance][std::ptr#provenance], + +r[memory.bytes.uninit] +* An uninitialized byte. + +> [!NOTE] +> The above list is not yet guaranteed to be exhaustive.