tools

pstore Tools

Table of Contents

• Installed tools
  • Exchange
  • Exploring
  • Garbage Collection
  • Read and Write
• Build-and-test tools
  • Build-time
  • Testing

Installed tools

Exchange

Tools for textual export and import of the contents of a pstore file.

Name	Description
pstore‑export	Exports the contents of a pstore repository in a format that can be consumed by pstore‑import.
pstore‑import	Creates a pstore repository from an export file created by pstore‑export.

Exploring

The utility programs in this group enable you to inspect and explore the contents of a pstore database.

Name	Description
pstore‑diff	Dumps diff between two pstore revisions.
pstore‑dump	Dumps pstore contents as YAML.
pstore‑index‑stats	Dumps statistics about the index trees in a pstore file as CSV.
pstore‑index‑structure	Dumps pstore index structures as GraphViz DOT graphs.

Garbage Collection

Name	Description
pstore‑brokerd	The pstore message broker. The broker is a service which is used to manage the garbage collection processes.
pstore‑ui	The pstore broker dashboard application.
pstore‑vacuumd	Data store garbage collector.

Read and Write

These utilities are included purely to provide a simple means of experimenting with the pstore library. pstore-write enables you to store specific key/value pairs or whole files in a database (where the key is the file path and the value is the file’s contents). pstore-read, on the other hand, allows the data that is recorded by pstore-write to be extracted by printing it to stdout.

Name	Description
pstore‑read	A utility for reading the write or strings index.
pstore‑write	A utility for writing to the write or strings index.

Build-and-test tools

Build-time

Executables that are used as part of the pstore build itself.

Name	Description
pstore‑genromfs	Dumps a directory structure to stdout in a form that can be used by the romfs library.

Testing

Executables that are used to test the pstore library.

Name	Description
pstore‑broker‑poker	A utility for exercising the broker agent: used by the system tests.
pstore‑hamt‑test	A utility to exercise and verify the behavior of the pstore index implementation.
pstore‑httpd	A minimal HTTP server to exercise the httpd library.
pstore‑inserter	A utility to exercise the digest index.
pstore‑json	A small wrapper for the JSON parser library.
pstore-lock-test	A test for the cross-process transaction lock.
pstore‑mangle	A simple file fuzzing utility.
pstore‑sieve	A utility to generate data for the system tests.