Persistent Memory Documentation
HomePMDKNDCTLBlog
  • Persistent Memory Documentation
  • Getting Started Guide
    • Introduction
    • PMDK Introduction
    • NDCTL Introduction
    • System Requirements
    • Creating Development Environments
      • Linux Environments
        • Using the memmap Kernel Option
        • Advanced Topics
          • Partitioning Namespaces
          • I/O Alignment Considerations
      • Windows Environments
      • Virtualization
        • Windows Server Hyper-V
        • Using QEMU Virtualization
        • VMware VSphere/ESXi
      • Cloud Environments
        • Microsoft Azure Cloud
        • Google Cloud Platform (GCP)
    • Installing NDCTL
    • Installing PMDK
      • PMDK Directory Structure
      • Installing PMDK using Linux Packages
      • Installing PMDK from Source on Linux
      • Installing PMDK on Windows
  • IPMCTL User Guide
  • NDCTL User Guide
Powered by GitBook
On this page
  • PROJECT NOT UNDER ACTIVE MANAGEMENT
  • Persistent Memory Documentation
  • Introductory Materials
  • Standards
  • Related Specifications

Persistent Memory Documentation

NextGetting Started Guide

Last updated 7 months ago

PROJECT NOT UNDER ACTIVE MANAGEMENT

This project will no longer be maintained by Intel. Intel has ceased development and contributions including, but not limited to, maintenance, bug fixes, new releases, or updates, to this project. Intel no longer accepts patches to this project. If you have an ongoing need to use this project, are interested in independently developing it, or would like to maintain patches for the open source software community, please create your own fork of this project.

Persistent Memory Documentation

Introductory Materials

This , published in the Summer of 2017, provides an overview of the persistent memory programming model and the related software work that has been taking place. It includes a very high-level description of programming with , although it refers to it by the old name, . This article is actually a follow-on to an , published in the Summer 2013 issue of USENIX ;login:.

The , held January 24th, 2018, provided a day full of informative talks and panels on persistent memory (slides and videos of the sesssions are available at above link).

The projects on this site, like , are product-neutral, meant to work on any product that provides the persistent memory programming model. One such product is Intel’s . Intel has assembled a collection of persistent memory programming documentation, webinars, videos, and related materials on the .

Dozens of companies have collaborated on a common persistent memory programming model in the SNIA NVM Programming Technical Workgroup (TWG). SNIA provides a on their web site with links to recent presentations, persistent memory standards and white papers, etc. The SNIA activity continues to be very active, working on areas like remote persistent memory and security. The original programming model specification put forward the basic idea that applications access persistent memory as memory-mapped files, a concept which has appeared as the DAX feature (Direct Access) on both and .

Standards

The standard describes the basic programming model used for persistent memory programming.

The , starting with version 6.0, defines the NVDIMM Firmware Interface Table (NFIT) which is how the existence of persistent memory is communicated to operating systems. The specification also describes how NVDIMMs are partitioned into namespaces, methods for communicating with NVDIMMs, etc.

The , covers other NVDIMM-related topics such as the Block Translation Table (BTT) which allows an NVDIMM to provide block device semantics.

Before the above two standards were developed, the described the namespace and BTT mechanisms. The link to the outdated document is maintained here for reference.

Related Specifications

The is targeted to driver writers for NVDIMMs that adhere to the NFIT tables in the Advanced Configuration and Power Interface (ACPI) V6.0 specification, the Device Specific Method (DSM) specification, and the NVDIMM Namespace Specification. This document specifically discusses the block window HW interface and persistent memory interface that Intel is proposing for NVDIMMs. A version of the document with [pdf] from the previous version is also available.

The , Version 3.0, describes the NVDIMM Device Specific Methods (_DSM) that pertain to Optane PMem modules. This document is provided as a reference for BIOS and OS driver writers supporting NVDIMMs and similar devices that appear in the ACPI NFIT table.

The describes the (hopefully rare) error case where flushes to persistent memory did not go as expected on power failure or system crash. The guide describes how this failure is detected, and how it is communicated to applications via the dirty shutdown count**.**

USENIX ;login: article
PMDK
NVM Libraries
earlier article
Persistent Memory Summit 2018
PMDK
3D XPoint
Intel Developer Zone
persistent memory page
Linux
Windows
SNIA NVM Programming Model
ACPI Specification
UEFI Specification
NVDIMM Namespace Specification
NVDIMM Driver Writers Guide
change bars
Intel Optane PMem DSM Interface
Dirty Shutdown Handling guide