emo/thin-provisioning-tools
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
884 Commits 2 Branches 0 Tags 3.7 MiB
C++ 52.1%
Scheme 36.6%
HTML 4.4%
C 2.6%
Shell 1.3%
Other 3%
fe64da2c7c
Go to file
Joe Thornber fe64da2c7c Fix these errors: 
thin-provisioning/thin_pool.cc:206: error: reference to 'sector_t' is ambiguous
./thin-provisioning/metadata.h:40: error: candidates are: typedef uint64_t thin_provisioning::sector_t
./block-cache/block_cache.h:20: error:                 typedef uint64_t bcache::sector_t
thin-provisioning/thin_pool.cc:206: error: reference to 'sector_t' is ambiguous
./thin-provisioning/metadata.h:40: error: candidates are: typedef uint64_t thin_provisioning::sector_t
./block-cache/block_cache.h:20: error:                 typedef uint64_t bcache::sector_t
thin-provisioning/thin_pool.cc:206: error: 'sector_t' does not name a type

Signed-off-by: Mikulas Patocka <mpatocka@redhat.com>
2015-01-16 10:14:28 +00:00
autoconf more build stuff 2011-12-09 12:54:51 +00:00
base Old glibc doesn't provide these macros, so we have to define them. 2015-01-16 10:12:30 +00:00
bin [all] Build a single executable 2014-08-27 14:01:31 +01:00
block-cache [block-cache] tweak when validators are swapped 2014-08-21 14:23:14 +01:00
caching Fix these errors: 2015-01-16 10:13:36 +00:00
era Squash a couple of annoying compiler warnings 2014-09-02 10:13:26 +01:00
features [cache_dump feature] switch to using the new /cache dump|restore/ pattern 2014-09-01 15:26:42 +01:00
lib gmock stub 2013-03-22 10:55:55 +00:00
man8 Merge branch 'master' of github.com:jthornber/thin-provisioning-tools 2014-08-06 16:32:04 +01:00
persistent-data [persistent-data/space_map.h] Make destructor for space_map_detail::damage public 2014-11-15 16:48:53 +01:00
thin-provisioning Fix these errors: 2015-01-16 10:14:28 +00:00
unit-tests [unit-tests/bloom_filter_t.cc] Fix ambigious uniform_int_distribution (C++11) 2014-11-15 16:49:08 +01:00
xml_metadata add some example metadata dumps 2011-11-16 12:17:23 +00:00
.gitignore [all] Build a single executable 2014-08-27 14:01:31 +01:00
.ruby-version Don't put a patch version in .rub-version, 1.9.3 is enough 2013-12-02 12:08:01 +00:00
CHANGES update CHANGES 2014-09-01 15:45:29 +01:00
configure.ac [configure.ac] Make sure libaio.h is present, and remove deps for a couple of boost headers we're no longer using. 2014-08-06 16:27:18 +01: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 Update Gemfile 2014-09-04 11:52:12 +01:00
get-gmock.sh Convert buffer_t to gmock. 2013-03-22 12:04:38 +00:00
main.cc [all] Build a single executable 2014-08-27 14:01:31 +01:00
Makefile.in [thin_trim] first code drop. 2014-11-18 16:03:03 +00:00
mk_release make mk_release executable 2012-03-05 11:46:20 +00:00
README.md [README] Add dep for libaio 2014-08-06 16:29:50 +01:00
TODO.org Add a TODO file 2013-04-23 11:18:21 +01:00
VERSION bump version 2014-09-04 11:37:31 +01:00
version.h.in version.h.in 2011-12-15 14:58:25 +01:00

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). The libaio library (note this is not the same as the aio library that you get by linking -lrt) 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'