Skip to content
This repository
Octocat-spinner-32 autoconf more build stuff December 09, 2011
Octocat-spinner-32 base Factor out base/indented_stream.h January 31, 2014
Octocat-spinner-32 caching Merge branch 'master' of github.com:jthornber/thin-provisioning-tools… January 31, 2014
Octocat-spinner-32 era [era] qualify btiset April 01, 2014
Octocat-spinner-32 features [thin_check] --clear-needs-check-flag March 27, 2014
Octocat-spinner-32 lib gmock stub March 22, 2013
Octocat-spinner-32 man8 Add missing cache tools manual pages and update Makefile.in respectively October 19, 2013
Octocat-spinner-32 persistent-data remove a typename that rhel 6.6 objects to April 11, 2014
Octocat-spinner-32 thin-provisioning [thin_check] Fix bug in clear needs check logic. April 02, 2014
Octocat-spinner-32 unit-tests Knock out the era_superblock_t for now. March 27, 2014
Octocat-spinner-32 xml_metadata add some example metadata dumps November 16, 2011
Octocat-spinner-32 .gitignore Merge branch 'master' of github.com:jthornber/thin-provisioning-tools… January 31, 2014
Octocat-spinner-32 .ruby-version Don't put a patch version in .rub-version, 1.9.3 is enough December 02, 2013
Octocat-spinner-32 COPYING Add copyright December 06, 2011
Octocat-spinner-32 Gemfile Update gem requirements June 19, 2013
Octocat-spinner-32 Gemfile.lock Update Gemfile.lock October 14, 2013
Octocat-spinner-32 Makefile.in install era tools March 06, 2014
Octocat-spinner-32 README.md wrong repo December 11, 2013
Octocat-spinner-32 TODO.org Add a TODO file April 23, 2013
Octocat-spinner-32 VERSION bump version April 01, 2014
Octocat-spinner-32 configure.in autconf: support build of thin_metadata_size.c July 18, 2013
Octocat-spinner-32 get-gmock.sh Convert buffer_t to gmock. March 22, 2013
Octocat-spinner-32 mk_release make mk_release executable March 05, 2012
Octocat-spinner-32 version.h.in version.h.in December 15, 2011
README.md

Introduction

A suite of tools for manipulating the metadata of the dm-thin device-mapper target.

Requirements

A C++ compiler that supports the c++11 standard (eg, g++). The Boost C++ library. The expat xml parser library (version 1). make, autoconf etc.

There are more requirements for testing, detailed below.

Building

./configure
make
sudo make install

Quick examples

These tools introduce an xml format for the metadata. This is useful for making backups, or allowing scripting languages to generate or manipulate metadata. A Ruby library for this available; thinp_xml.

To convert the binary metadata format that the kernel uses to this xml format use thin_dump.

thin_dump --format xml /dev/mapper/my_thinp_metadata

To convert xml back to the binary form use thin_restore.

thin_restore -i my_xml -o /dev/mapper/my_thinp_metadata

You should periodically check the health of your metadata, much as you fsck a filesystem. Your volume manager (eg, LVM2) should be doing this for you behind the scenes.

thin_check /dev/mapper/my_thinp_metadata

Checking all the mappings can take some time, you can omit this part of the check if you wish.

thin_check --skip-mappings /dev/mapper/my_thinp_metadata

If your metadata has become corrupt for some reason (device failure, user error, kernel bug), thin_check will tell you what the effects of the corruption are (eg, which thin devices are effected, which mappings).

There are two ways to repair metadata. The simplest is via the thin_repair tool.

thin_repair -i /dev/mapper/broken_metadata_dev -o /dev/mapper/new_metadata_dev

This is a non-destructive operation that writes corrected metadata to a new metadata device.

Alternatively you can go via the xml format (perhaps you want to inspect the repaired metadata before restoring).

thin_dump --repair /dev/mapper/my_metadata > repaired.xml
thinp_restore -i repaired.xml -o /dev/mapper/my_metadata

Development

Autoconf

If you've got the source from github you'll need to create the configure script with autoconf. I do this by running:

autoreconf

Enable tests

You will need to enable tests when you configure.

./configure --enable-testing

Unit tests

Unit tests are implemented using the google mock framework. This is a source library that you will have to download. A script is provided to do this for you.

./get-gmock.sh

All tests can be run via:

make unit-test

Alternatively you may want to run a subset of the tests:

make unit-tests/unit_tests
unit-tests/unit_tests --gtest_filter=BtreeTests.*

Functional tests

These top level tests are implemented using the cucumber tool. They check the user interface of the tools (eg, command line switches are accepted and effective).

I've provided a Gemfile, so installing this should be easy:

  • Install Ruby 1.9.x. I recommend doing this via RVM.
  • Make sure bundler is installed:

    gem install bundler

  • Install dependencies (including cucumber and thinp_xml)

    bundle

Once you've done this you can run the tests with a simple:

cucumber

Or specific tests with:

cucumber features/thin_restore -n 'print help'
Something went wrong with that request. Please try again.