Stdlib module kernel/memory.vitl
This page is a wiki-style reference for one concrete stdlib file. It explains what the file owns, where it fits in the family, and how to decide whether this is the right surface to depend on.
kernel/memory.vitl.Family: kernel
Kind: public stdlib surface
Page style: this reference follows the same “encyclopedic card + portrait + usage contract” logic as the keyword pages, but for stdlib modules.
Summary
- Overview
- Purpose
- Taxonomy
- Implementation profile
- Top-level API inventory
- Position in family
- Declaration map
- Representative signatures
- How to use this module
- User example
- Keyword coverage
- Source shape
- Source landmarks
- Source organization
- Complete API catalog
- Integration boundaries
- Composition guidance
- Relationship table
- Neighbor modules
Overview
| Field | Value |
|---|---|
| Path | kernel/memory.vitl |
| Family | kernel |
| Kind | public stdlib surface |
| Line count | 153 |
| Declared procedures | 18 |
| Declared forms/picks | 1 |
`kernel/memory.vitl` is a public stdlib surface inside the `kernel` family. It should be read as one focused slice of the broader family responsibility: System-facing runtime helpers such as process, scheduler, threads, sync, users, signals, network, device, and memory.
Purpose
This file should be chosen because of responsibility, not because its name “sounds close enough”. Inside the kernel family, it carries one focused part of the contract and keeps that responsibility separate from neighboring concerns.
- A service manager may use scheduler, process, and signals while keeping policy in separate code.
- A network-facing runtime should explain why it depends on kernel surfaces instead of lighter families.
Taxonomy
Think of this page as a generated encyclopedia entry rather than a hand-written tutorial. The goal is to show what kind of module this is, how dense it is, and what reading strategy makes sense before depending on it.
- Medium procedure surface: this file groups several related operations behind one namespace.
- Owns domain vocabulary: the module declares data shapes in addition to executable helpers, so its types are part of the contract.
- Has tuning constants: part of the module behavior is controlled by named constants that document default precision, limits, or policy.
- Minimal top-level dependencies: the module reads as mostly self-contained from its opening declarations.
- Explicit export surface: the file ends with visible export declarations instead of relying only on implicit namespace discovery.
Implementation profile
This profile is inferred directly from the source text. It does not replace reading the file, but it tells you quickly whether the module is mostly declarative, loop-heavy, branch-heavy, or organized around many small exits.
| Signal | Count | What it suggests |
|---|---|---|
if | 0 | Branching density and local decision-making. |
while | 0 | Loop-heavy or iterative implementation style. |
for | 0 | Collection-style traversal at source level. |
match | 0 | Variant-driven branching or grammar-style decoding. |
let | 0 | Local state and intermediate value density. |
give | 18 | Number of explicit exit points and result shaping. |
Top-level API inventory
| Surface | Items |
|---|---|
| Procedures | mmap, munmap, mprotect, madvise, msync, mlock, munlock, mlockall, munlockall, brk, sbrk, get_meminfo |
| Forms | MemInfo |
| Picks | none declared at top level |
| Constants | PROT_NONE, PROT_READ, PROT_WRITE, PROT_EXEC, MAP_SHARED, MAP_PRIVATE, MAP_FIXED, MAP_ANONYMOUS, MADV_NORMAL, MADV_RANDOM, MADV_SEQUENTIAL, MADV_WILLNEED |
| Exports | * |
Imported surfaces
This file does not advertise a top-level `use` surface in its opening declarations. That often means it is either self-contained or an aggregation layer.
Position in family
This file is module 5 of 12 in the kernel family when ordered by path. By procedure count it ranks 5, and by line count it ranks 5. Those ranks are useful as rough signals of breadth, not as quality judgments.
Declaration map
The declaration map turns raw source into a scan-friendly catalog. It is useful when the file is large enough that a reader wants to orient by kinds of surfaces first.
| Line | Name | Kind | Role |
|---|---|---|---|
| 1 | vitte/kernel_name/memory | space | Declares the namespace that anchors this file in the stdlib tree. |
| 9 | PROT_NONE | const | Defines a named constant reused across the module. |
| 10 | PROT_READ | const | Defines a named constant reused across the module. |
| 11 | PROT_WRITE | const | Defines a named constant reused across the module. |
| 12 | PROT_EXEC | const | Defines a named constant reused across the module. |
| 15 | MAP_SHARED | const | Defines a named constant reused across the module. |
| 16 | MAP_PRIVATE | const | Defines a named constant reused across the module. |
| 17 | MAP_FIXED | const | Defines a named constant reused across the module. |
| 18 | MAP_ANONYMOUS | const | Defines a named constant reused across the module. |
| 21 | MADV_NORMAL | const | Defines a named constant reused across the module. |
| 22 | MADV_RANDOM | const | Defines a named constant reused across the module. |
| 23 | MADV_SEQUENTIAL | const | Defines a named constant reused across the module. |
| 24 | MADV_WILLNEED | const | Defines a named constant reused across the module. |
| 25 | MADV_DONTNEED | const | Defines a named constant reused across the module. |
| 28 | MCL_CURRENT | const | Defines a named constant reused across the module. |
| 29 | MCL_FUTURE | const | Defines a named constant reused across the module. |
| 32 | PAGE_SIZE | const | Defines a named constant reused across the module. |
| 38 | mmap | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 43 | munmap | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 48 | mprotect | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 53 | madvise | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 58 | msync | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 67 | mlock | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 72 | munlock | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 77 | mlockall | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 82 | munlockall | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 87 | brk | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 92 | sbrk | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 101 | MemInfo | form | Introduces a structured data shape that other procedures can exchange. |
| 110 | get_meminfo | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 121 | get_page_size | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 125 | get_phys_pages | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 130 | get_avphys_pages | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 139 | mreconcile | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 144 | mincore | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 149 | get_memory_map | proc | Owns a concrete data shape or the operations that maintain it. |
The table is exhaustive for top-level declarations of the selected kinds. This file declares 36 matching surfaces.
Representative signatures
These signatures are shown in source order so the page keeps the feel of a reference manual, not just a keyword cloud.
const PROT_NONE: i32 = 0(line 9)const PROT_READ: i32 = 1(line 10)const PROT_WRITE: i32 = 2(line 11)const PROT_EXEC: i32 = 4(line 12)const MAP_SHARED: i32 = 1(line 15)const MAP_PRIVATE: i32 = 2(line 16)const MAP_FIXED: i32 = 10(line 17)const MAP_ANONYMOUS: i32 = 32(line 18)const MADV_NORMAL: i32 = 0(line 21)const MADV_RANDOM: i32 = 1(line 22)const MADV_SEQUENTIAL: i32 = 2(line 23)const MADV_WILLNEED: i32 = 3(line 24)const MADV_DONTNEED: i32 = 4(line 25)const MCL_CURRENT: i32 = 1(line 28)const MCL_FUTURE: i32 = 2(line 29)const PAGE_SIZE: i64 = 4096(line 32)proc mmap(addr: i64, length: i64, prot: i32, flag_bits: i32, fd: i32, offset: i64) -> i64 {(line 38)proc munmap(addr: i64, length: i64) -> int {(line 43)
The list is intentionally capped here; the source file declares 35 matching signatures in total.
How to use this module
Start by reading the file as an ownership boundary. Ask three questions: what enters this module, what stable types or procedures it exports, and what adjacent module should stay outside of it.
- Read
spaceand top-level imports first so the ownership boundary ofkernel/memory.vitlis explicit. - Scan constants before procedures; they often encode precision, limits, or policy assumptions that explain later behavior.
- Read declared forms and picks before algorithms so the data vocabulary is stable in your head.
- Traverse procedures in source order; the early helpers usually explain the naming and numeric conventions used later.
- Use the source landmarks section below as a table of contents when the file is large.
User example
This example is generated from the actual stdlib module surface. Its job is not to be the smallest snippet possible; its job is to show a realistic consumer-shaped file that exercises the module and mirrors the language keywords the module itself relies on.
space demo/kernel_memory
const SAMPLE_LABEL: string = "demo"
form UserReport {
label: string,
ready: bool
}
proc run_example() -> UserReport {
give UserReport { label: "ok", ready: ready }
}
export run_example
Keyword coverage
This table makes the “all keywords of the module” requirement auditable. It compares the detected Vitte keywords in the source file with the generated consumer example above.
| Keyword | Present in module source | Used in generated user example |
|---|---|---|
space | yes | yes |
const | yes | yes |
form | yes | yes |
proc | yes | yes |
give | yes | yes |
export | yes | yes |
The generated snippet exercises every detected Vitte keyword used by this module.
Source shape
space vitte/kernel_name/memory
// Memory protection flag_bits
const PROT_NONE: i32 = 0
const PROT_READ: i32 = 1
const PROT_WRITE: i32 = 2
const PROT_EXEC: i32 = 4
// Memory mapping flag_bits
const MAP_SHARED: i32 = 1
const MAP_PRIVATE: i32 = 2
const MAP_FIXED: i32 = 10
The excerpt is not meant to replace the file. It exists to make the module recognizable at first glance, the same way a Wikipedia infobox helps the reader orient before reading the whole article.
Source landmarks
Large files are easier to retain when they have visible landmarks. When the source contains explicit section banners, they are surfaced here; otherwise the first major declarations are used as anchors.
- Kernel Memory Management — Virtual Memory, Paging / Memory mapping, page management, memory protection
- Memory Mapping
- Virtual Memory Operations
- Memory Statistics
- Address Space Layout
Source organization
When a file carries its own internal chaptering, those chapters usually reveal the intended reading order better than a flat symbol list. This section reconstructs that organization from the source itself.
Opening declarations
Top-level items: 1. Procedures: 0. Data surfaces: 0. Constants: 0.
First visible names: vitte/kernel_name/memory
Kernel Memory Management — Virtual Memory, Paging / Memory mapping, page management, memory protection
Top-level items: 16. Procedures: 0. Data surfaces: 0. Constants: 16.
First visible names: PROT_NONE, PROT_READ, PROT_WRITE, PROT_EXEC, MAP_SHARED, MAP_PRIVATE, MAP_FIXED, MAP_ANONYMOUS, MADV_NORMAL, MADV_RANDOM
Memory Mapping
Top-level items: 5. Procedures: 5. Data surfaces: 0. Constants: 0.
First visible names: mmap, munmap, mprotect, madvise, msync
Virtual Memory Operations
Top-level items: 6. Procedures: 6. Data surfaces: 0. Constants: 0.
First visible names: mlock, munlock, mlockall, munlockall, brk, sbrk
Memory Statistics
Top-level items: 5. Procedures: 4. Data surfaces: 1. Constants: 0.
First visible names: MemInfo, get_meminfo, get_page_size, get_phys_pages, get_avphys_pages
Address Space Layout
Top-level items: 4. Procedures: 3. Data surfaces: 0. Constants: 0.
First visible names: mreconcile, mincore, get_memory_map, *
Complete API catalog
This catalog is the exhaustive file-level index for the module. It is intentionally closer to a generated encyclopedia appendix than to a tutorial summary.
Constants
| Line | Name | Signature | Role |
|---|---|---|---|
| 9 | PROT_NONE | const PROT_NONE: i32 = 0 | Defines a named constant reused across the module. |
| 10 | PROT_READ | const PROT_READ: i32 = 1 | Defines a named constant reused across the module. |
| 11 | PROT_WRITE | const PROT_WRITE: i32 = 2 | Defines a named constant reused across the module. |
| 12 | PROT_EXEC | const PROT_EXEC: i32 = 4 | Defines a named constant reused across the module. |
| 15 | MAP_SHARED | const MAP_SHARED: i32 = 1 | Defines a named constant reused across the module. |
| 16 | MAP_PRIVATE | const MAP_PRIVATE: i32 = 2 | Defines a named constant reused across the module. |
| 17 | MAP_FIXED | const MAP_FIXED: i32 = 10 | Defines a named constant reused across the module. |
| 18 | MAP_ANONYMOUS | const MAP_ANONYMOUS: i32 = 32 | Defines a named constant reused across the module. |
| 21 | MADV_NORMAL | const MADV_NORMAL: i32 = 0 | Defines a named constant reused across the module. |
| 22 | MADV_RANDOM | const MADV_RANDOM: i32 = 1 | Defines a named constant reused across the module. |
| 23 | MADV_SEQUENTIAL | const MADV_SEQUENTIAL: i32 = 2 | Defines a named constant reused across the module. |
| 24 | MADV_WILLNEED | const MADV_WILLNEED: i32 = 3 | Defines a named constant reused across the module. |
| 25 | MADV_DONTNEED | const MADV_DONTNEED: i32 = 4 | Defines a named constant reused across the module. |
| 28 | MCL_CURRENT | const MCL_CURRENT: i32 = 1 | Defines a named constant reused across the module. |
| 29 | MCL_FUTURE | const MCL_FUTURE: i32 = 2 | Defines a named constant reused across the module. |
| 32 | PAGE_SIZE | const PAGE_SIZE: i64 = 4096 | Defines a named constant reused across the module. |
Data surfaces
| Line | Name | Signature | Role |
|---|---|---|---|
| 101 | MemInfo | form MemInfo { | Introduces a structured data shape that other procedures can exchange. |
Procedures
| Line | Name | Signature | Role |
|---|---|---|---|
| 38 | mmap | proc mmap(addr: i64, length: i64, prot: i32, flag_bits: i32, fd: i32, offset: i64) -> i64 { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 43 | munmap | proc munmap(addr: i64, length: i64) -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 48 | mprotect | proc mprotect(addr: i64, length: i64, prot: i32) -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 53 | madvise | proc madvise(addr: i64, length: i64, advice: i32) -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 58 | msync | proc msync(addr: i64, length: i64, flag_bits: i32) -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 67 | mlock | proc mlock(addr: i64, length: i64) -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 72 | munlock | proc munlock(addr: i64, length: i64) -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 77 | mlockall | proc mlockall(flag_bits: i32) -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 82 | munlockall | proc munlockall() -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 87 | brk | proc brk(addr: i64) -> i64 { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 92 | sbrk | proc sbrk(increment: i64) -> i64 { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 110 | get_meminfo | proc get_meminfo() -> MemInfo { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 121 | get_page_size | proc get_page_size() -> i64 { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 125 | get_phys_pages | proc get_phys_pages() -> i64 { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 130 | get_avphys_pages | proc get_avphys_pages() -> i64 { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 139 | mreconcile | proc mreconcile(pages_to_free: i64) -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 144 | mincore | proc mincore(addr: i64, length: i64, vec: [int]) -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 149 | get_memory_map | proc get_memory_map() -> string { | Owns a concrete data shape or the operations that maintain it. |
Exports
| Line | Name | Signature | Role |
|---|---|---|---|
| 153 | * | export * | Re-exports surfaces that the module wants to expose as part of its public boundary. |
Integration boundaries
Within kernel, this file should remain focused. If a future helper changes the host boundary, scheduling boundary, or data-shape boundary, it probably belongs in a neighbor module instead of being added here by convenience.
- Family responsibility: System-facing runtime helpers such as process, scheduler, threads, sync, users, signals, network, device, and memory.
- Family architecture role: Use `kernel` when the program explicitly models system services, scheduling, process behavior, or device-facing coordination.
Composition guidance
Choose this module when
- Choose
kernel/memory.vitlwhen the main question is owned by this module rather than by transport, storage, orchestration, or user-interface code. - A service manager may use scheduler, process, and signals while keeping policy in separate code.
- A network-facing runtime should explain why it depends on kernel surfaces instead of lighter families.
Pause before extending it when
- Avoid extending this file when the new helper mostly changes the boundary to host I/O, runtime coordination, or foreign integration instead of staying inside
kernel. - Check nearby modules such as
kernel/device.vitl,kernel/fileio.vitl,kernel/interrupt.vitlbefore adding convenience wrappers here.
Relationship table
This table keeps the page closer to a real encyclopedia entry: a module is easier to understand when compared with its nearest alternatives in the same family.
| Neighbor | Procedures | Data surfaces | Why compare it |
|---|---|---|---|
kernel/device.vitl | 0 | 0 | Shares the same family boundary but carries a distinct slice of responsibility. |
kernel/fileio.vitl | 44 | 2 | Shares the same family boundary but carries a distinct slice of responsibility. |
kernel/interrupt.vitl | 9 | 0 | Shares the same family boundary but carries a distinct slice of responsibility. |
kernel/network.vitl | 42 | 4 | Shares the same family boundary but carries a distinct slice of responsibility. |
kernel/process.vitl | 14 | 2 | Shares the same family boundary but carries a distinct slice of responsibility. |
kernel/scheduler.vitl | 1 | 0 | Shares the same family boundary but carries a distinct slice of responsibility. |
kernel/signals.vitl | 18 | 1 | Shares the same family boundary but carries a distinct slice of responsibility. |
kernel/sync.vitl | 34 | 6 | Shares the same family boundary but carries a distinct slice of responsibility. |