Skip to content

Home

Jump to bottom
trentmeester edited this page Apr 18, 2012 · 54 revisions

tnvme is a user space test application targeting the compliance verification of NVM Express (NVMe) compliant hardware. The NVMe home page is located here.

tnvme it not the complete compliance suite, rather it is the framework which empowers the building, and execution of compliance test cases. Further logic is necessary, in kernel space, to provide the low level support tnvme requires. The logic resident within the kernel is platform specific and the generic logic, non-platform specific, lives within tnvme. Currently the compliance suite targets Linux distributions only, however the design allows source code ports to other platforms by creating a corresponding kernel mode driver to implement the necessary IOCTL’s. The corresponding Linux kernel mode driver is dnvme which is resident within https://github.com/organizations/nvmecompliance as its own git repo.

tnvme is not a benchmark, throughput or performance measurement system, rather its goal is to verify hardware compliance against a written set of specifications. Functionality, not speed, was the main target of this application. It was seen that satisfying both speed and functionality could not be addressed simultaneously in all aspects of this design. Thus when a decision had to be made as to which one to choose, functionality always won.

Presentations and Documents

  1. Introduction to the compliance suite presentation
  2. Designing test dependencies within the framework presentation
  3. Software release notes
  4. Compliance suite test plan

Your Workflow

  1. Learn git; find a tutorial
  2. Create an account on github
  3. Fork repos(s) of interest
        a) After forking, clone the repo(s) on a local machine.
  4. Modify code, commit, and push to the local repo(s); normal git usage.
  5. Contribute your logic to the mainline github repo(s)

Introduction

Compiling
Executing
Example Code
Command Line Options Design Strategy
Test Strategy
Coding Standards

General Architectural Details

Groups
Tests
Resource Lifetime
Interrupts
Number of Queues

Resources

In the most general sense, resources are those objects tnvme uses to setup and test a Device Under Test (DUT). Resources are commands from any command set, any type of queue, and memory (both contiguous and discontiguous with various alignment requirements). An alternative mechanism to view resources and the C++ classes which represent them is to generate the doxygen output against the source code.

1) cd tnvme
2) make doc
3) ./classHierarchy.sh

Queues
Commands
Memory

Singletons

gRsrcMngr
gCtrlrConfig
gRegisters
gInformative

Clone this wiki locally