OpenNANDLab Documentation

Welcome to the documentation for OpenNANDLab: an open-source SSD Controller & 3D NAND Research Platform!

Quick Navigation

Getting Started

• API Guide

• Usage Guide

• Contributing Guide

Documentation

• Design Architecture

Contents

API Reference & Usage

• API Reference
• User Manual
• OpenNANDLab Examples
• Scripts and Specs Navigation
• Contributing to OpenNANDLab

Design Docs

• System Architecture
  • OpenNANDLab v2.0
  • 1. Design Philosophy
  • 2. High-Level Architecture
  • 3. Module Reference
  • 4. Critical Bug Fix: write_page (v1.1.0 → v2.0)
  • 5. Key Design Decisions
  • 6. Thread Safety Note
  • 7. Performance Budget (CPython 3.12)
• Data Flow
  • 1. Configuration Initialization
  • 2. Write Operations
  • 3. Read Operations
  • 4. Garbage Collection
  • 5. Optimization and Analysis
• Benchmarks
  • Methodology
  • Workload Definitions
  • Results — v2.0 (TLC-standard config, greedy GC, CPython 3.12, Apple M2)
  • How to Add a Benchmark Result
  • Benchmark Anti-Patterns
• Flash Translation Layer (FTL)
  • Page-Level Mapping
  • Data Structures & State Management
  • Garbage Collection (GC)
  • Metrics & Telemetry
  • Extending the FTL
• NAND Defect Handling
  • Error Correction (opennandlab.ecc)
  • Bad Block Management (opennandlab.defect)
  • Wear Leveling
  • Integration with NAND Controller
  • Component Interaction
  • Configurable Parameters
• NAND Characterization
  • Data Collection
  • Data Analysis
  • Data Visualization
  • Integration with NAND Controller
  • Usage Example
• Firmware Integration
  • Firmware Specification Generation
  • Firmware Specification Validation
  • Test Bench Execution
  • Validation Scripts
  • Integration With NAND Controller
  • Validation Benefits
• Performance Optimization
  • Data Compression
  • Advanced Caching System
  • Parallel Access
  • Integration with NAND Controller
  • Performance Impact
  • Usage Examples
• References & Further Reading
  • Core References
  • Related Open-Source Projects
  • Textbooks
  • Useful Datasets & Traces

Indices and Tables

• Index

• Module Index

• Search Page