summaryrefslogtreecommitdiff
path: root/lib/sbuild/chroot/facet/lvm-snapshot.h
blob: d3cdabfc041772fe9f4ef9a856512d77733dff42 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
/* Copyright © 2005-2013  Roger Leigh <rleigh@debian.org>
 *
 * schroot is free software: you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * schroot is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see
 * <http://www.gnu.org/licenses/>.
 *
 *********************************************************************/

#ifndef SBUILD_CHROOT_FACET_LVM_SNAPSHOT_H
#define SBUILD_CHROOT_FACET_LVM_SNAPSHOT_H

#include <sbuild/chroot/facet/block-device-base.h>
#include <sbuild/chroot/facet/session-setup.h>
#include <sbuild/chroot/facet/source-setup.h>

namespace sbuild
{
  namespace chroot
  {
    namespace facet
    {

      /**
       * A chroot stored on an LVM logical volume (LV).
       *
       * A snapshot LV will be created and mounted on demand.
       */
      class lvm_snapshot : public block_device_base,
                           public session_setup,
                           public source_setup
      {
      public:
        /// A shared_ptr to a chroot facet object.
        typedef std::shared_ptr<lvm_snapshot> ptr;

        /// A shared_ptr to a const chroot facet object.
        typedef std::shared_ptr<const lvm_snapshot> const_ptr;

      protected:
        /// The constructor.
        lvm_snapshot ();

        /// The copy constructor.
        lvm_snapshot (const lvm_snapshot& rhs);

        void
        set_chroot (chroot& chroot,
                    bool    copy);

        friend class chroot;

      public:
        /// The destructor.
        virtual ~lvm_snapshot ();

        virtual std::string const&
        get_name () const;

        /**
         * Create a chroot facet.
         *
         * @returns a shared_ptr to the new chroot facet.
         */
        static ptr
        create ();

        facet::ptr
        clone () const;

        /**
         * Get the logical volume snapshot device name.  This is used by
         * lvcreate.
         *
         * @returns the device name.
         */
        std::string const&
        get_snapshot_device () const;

        /**
         * Set the logical volume snapshot device name.  This is used by
         * lvcreate.
         *
         * @param snapshot_device the device name.
         */
        void
        set_snapshot_device (const std::string& snapshot_device);

        /**
         * Get the logical volume snapshot options.  These are used by
         * lvcreate.
         *
         * @returns the options.
         */
        std::string const&
        get_snapshot_options () const;

        /**
         * Set the logical volume snapshot options.  These are used by
         * lvcreate.
         *
         * @param snapshot_options the options.
         */
        void
        set_snapshot_options (const std::string& snapshot_options);

        virtual void
        setup_env (environment& env) const;

        virtual session_flags
        get_session_flags () const;

      protected:
        virtual void
        setup_lock (chroot::setup_type type,
                    bool               lock,
                    int                status);

        virtual void
        get_details (format_detail& detail) const;

        virtual void
        get_used_keys (string_list& used_keys) const;

        virtual void
        get_keyfile (keyfile& keyfile) const;

        virtual void
        set_keyfile (const keyfile& keyfile);

        virtual void
        chroot_session_setup (const chroot&      parent,
                              const std::string& session_id,
                              const std::string& alias,
                              const std::string& user,
                              bool               root);

        virtual void
        chroot_source_setup (const chroot& parent);

      private:
        /// LVM snapshot device name for lvcreate.
        std::string snapshot_device;
        /// LVM snapshot options for lvcreate.
        std::string snapshot_options;
      };

    }
  }
}

#endif /* SBUILD_CHROOT_FACET_LVM_SNAPSHOT_H */

/*
 * Local Variables:
 * mode:C++
 * End:
 */