How muditbhargava66/opennandlab works
OpenNANDLab is a NAND/SSD research simulator and characterization toolkit. The principal workflow is a researcher invoking the CLI or Python API, configuring and initializing a controller, then running page operations against an FTL and NAND device; characterization and metrics provide an analysis branch. The graph preserves documented defect handling, ECC, optimization, firmware, and visualization capabilities. Some subsystem interactions are documented only at a high level; unverified wiring is omitted rather than inferred from imports.
Main entry points: simulator.py NAND controller · cli.py CLI · gc.py Garbage collection · data_collection.py Characterization collection
Components 25
Interfaces and setup
- CLI
src/opennandlab/cli.py - Configuration
src/opennandlab/config.py - NAND controller
src/opennandlab/simulator.py - Logging
src/opennandlab/utils/logger.py
Translation and NAND
- Page FTL
src/opennandlab/ftl/page_ftl.py - Garbage collection
src/opennandlab/ftl/gc.py - Simulated NAND
src/opennandlab/nand/simulator_device.py - NAND device interface
src/opennandlab/nand/device.py
Reliability features
- Bad block management
src/opennandlab/defect/bad_block.py - Wear leveling
src/opennandlab/defect/wear_leveling.py - ECC handler
src/opennandlab/ecc/handler.py - BCH codec
src/opennandlab/ecc/bch.py - LDPC codec
src/opennandlab/ecc/ldpc.py - Forney algorithm
src/opennandlab/ecc/bch_forney.py
Performance features
- Caching
src/opennandlab/optimization/caching.py - Compression
src/opennandlab/optimization/compression.py - Parallel access
src/opennandlab/optimization/parallel_access.py
Firmware and analysis
- Firmware specifications
src/opennandlab/firmware/specs.py - Firmware validation
src/opennandlab/firmware/validation.py - Characterization collection
src/opennandlab/analytics/data_collection.py - Metrics analysis
src/opennandlab/analytics/metrics.py - Dashboard
src/opennandlab/visualization/dashboard.py - Wear heatmap
src/opennandlab/visualization/wear_heatmap.py - Workloads
src/opennandlab/workloads
Other components
- Researcher
Connections 23
- Researcher → CLI: invokes
README.md - Researcher → NAND controller: uses API
README.md - CLI → NAND controller: runs simulation
README.md - CLI → Configuration: loads config
README.md - CLI → Characterization collection: characterizes
README.md - CLI → Dashboard: launches
README.md - NAND controller → Simulated NAND: initializes interface
src/opennandlab/simulator.py - NAND controller → Page FTL: translates pages
src/opennandlab/simulator.py - NAND controller → Garbage collection: runs collection
src/opennandlab/simulator.py - NAND controller → Caching: caches data
src/opennandlab/simulator.py - NAND controller → Compression: compresses data
README.md - NAND controller → Parallel access: dispatches operations
src/opennandlab/simulator.py - Simulated NAND → NAND device interface: implements
src/opennandlab/nand/simulator_device.py - Garbage collection → Page FTL: allocates pages
src/opennandlab/ftl/gc.py - Garbage collection → Simulated NAND: moves and erases
src/opennandlab/ftl/gc.py - ECC handler → BCH codec: selects codec
src/opennandlab/ecc/handler.py - ECC handler → LDPC codec: selects codec
src/opennandlab/ecc/handler.py - Characterization collection → NAND device interface: samples device
src/opennandlab/analytics/data_collection.py - NAND controller → Bad block management: manages defects
src/opennandlab/simulator.py - NAND controller → Wear leveling: tracks wear
src/opennandlab/simulator.py - Firmware specifications → Firmware validation: validated by
README.md - Characterization collection → Metrics analysis: analyzed by
- Dashboard → Wear heatmap: visualizes wear
README.md