Go to file
2013-09-12 12:33:32 +01:00
autoconf more build stuff 2011-12-09 12:54:51 +00:00
base Put error_state into into it's own file. 2013-08-16 14:07:04 +01:00
caching some work on cache_restore 2013-09-12 12:33:32 +01:00
features WIP on cache tools 2013-09-11 11:40:46 +01:00
lib gmock stub 2013-03-22 10:55:55 +00:00
man8 manual page fixes in header 2013-07-30 19:55:52 +02:00
persistent-data WIP on cache tools 2013-09-11 11:40:46 +01:00
thin-provisioning WIP on cache tools 2013-09-11 11:40:46 +01:00
unit-tests Give up with --std=c++11 2013-08-08 10:49:59 +01:00
xml_metadata add some example metadata dumps 2011-11-16 12:17:23 +00:00
.gitignore Start stubbing out cache_dump 2013-08-19 12:40:03 +01:00
.ruby-version Some trivial cucumber tests 2013-03-20 19:44:09 +00:00
configure.in autconf: support build of thin_metadata_size.c 2013-07-18 14:52:08 +02:00
COPYING Add copyright 2011-12-06 13:43:44 +00:00
Gemfile Update gem requirements 2013-06-19 11:29:49 +01:00
Gemfile.lock WIP on cache tools 2013-09-11 11:40:46 +01:00
get-gmock.sh Convert buffer_t to gmock. 2013-03-22 12:04:38 +00:00
Makefile.in some work on cache_restore 2013-09-12 12:33:32 +01:00
mk_release make mk_release executable 2012-03-05 11:46:20 +00:00
README.md whitespace 2013-06-27 12:44:07 +01:00
TODO.org Add a TODO file 2013-04-23 11:18:21 +01:00
VERSION bump version 2013-08-08 11:43:28 +01:00
version.h.in version.h.in 2011-12-15 14:58:25 +01:00

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'