libstorage-ng
Loading...
Searching...
No Matches
LvmLv.h
1/*
2 * Copyright (c) [2016-2021] SUSE LLC
3 *
4 * All Rights Reserved.
5 *
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of version 2 of the GNU General Public License as published
8 * by the Free Software Foundation.
9 *
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, contact Novell, Inc.
17 *
18 * To contact Novell about this file by physical or electronic mail, you may
19 * find current contact information at www.novell.com.
20 */
21
22
23#ifndef STORAGE_LVM_LV_H
24#define STORAGE_LVM_LV_H
25
26
27#include "storage/Devices/BlkDevice.h"
28#include "storage/Devicegraph.h"
29
30
31namespace storage
32{
33
34 class LvmVg;
35
36
40 enum class LvType
41 {
47 UNKNOWN,
48
52 NORMAL,
53
60
64 THIN,
65
71 RAID,
72
79
85 CACHE,
86
93
100
107 MIRROR
108 };
109
110
116 std::string get_lv_type_name(LvType lv_type);
117
118
120 {
121 public:
122
123 LvmLvNotFoundByLvName(const std::string& lv_name);
124 };
125
126
128 {
129 public:
130
131 InvalidStripeSize(const std::string& msg);
132 };
133
134
136 {
137 public:
138
139 InvalidChunkSize(const std::string& msg);
140 };
141
142
146 class LvmLv : public BlkDevice
147 {
148
149 public:
150
157 static LvmLv* create(Devicegraph* devicegraph, const std::string& vg_name,
158 const std::string& lv_name, LvType lv_type);
159
160 static LvmLv* load(Devicegraph* devicegraph, const xmlNode* node);
161
165 static std::vector<LvmLv*> get_all(Devicegraph* devicegraph);
166
170 static std::vector<const LvmLv*> get_all(const Devicegraph* devicegraph);
171
180 const std::string& get_lv_name() const;
181
188 void set_lv_name(const std::string& lv_name);
189
193 static bool is_valid_lv_name(const std::string& lv_name);
194
201
205 unsigned int get_stripes() const;
206
214 void set_stripes(unsigned int stripes);
215
219 unsigned long long get_stripe_size() const;
220
228 void set_stripe_size(unsigned long long stripe_size);
229
233 unsigned long long get_chunk_size() const;
234
240 void set_chunk_size(unsigned long long chunk_size);
241
247 const LvmVg* get_lvm_vg() const;
248
254 const LvmLv* get_thin_pool() const;
255
260 bool has_snapshots() const;
261
267 std::vector<LvmLv*> get_snapshots();
268
272 std::vector<const LvmLv*> get_snapshots() const;
273
281 bool has_origin() const;
282
291
295 const LvmLv* get_origin() const;
296
305 unsigned long long max_size_for_lvm_lv(LvType lv_type) const;
306
315 LvmLv* create_lvm_lv(const std::string& lv_name, LvType lv_type, unsigned long long size);
316
320 LvmLv* get_lvm_lv(const std::string& lv_name);
321
322 std::vector<LvmLv*> get_lvm_lvs();
323 std::vector<const LvmLv*> get_lvm_lvs() const;
324
332 static bool compare_by_lv_name(const LvmLv* lhs, const LvmLv* rhs);
333
334 public:
335
336 class Impl;
337
338 Impl& get_impl();
339 const Impl& get_impl() const;
340
341 virtual LvmLv* clone() const override;
342
343 protected:
344
345 LvmLv(Impl* impl);
346
347 };
348
349
355 bool is_lvm_lv(const Device* device);
356
364
368 const LvmLv* to_lvm_lv(const Device* device);
369
370}
371
372#endif
An abstract Block Device.
Definition: BlkDevice.h:49
Definition: Devicegraph.h:50
An abstract base class for storage devices.
Definition: Device.h:82
The main container of the libstorage-ng.
Definition: Devicegraph.h:170
Base class for storage exceptions.
Definition: Exception.h:114
const std::string & msg() const
Return the message string provided to the constructor.
Definition: Exception.h:150
Definition: LvmLv.h:136
Definition: LvmLv.h:128
Definition: LvmLv.h:120
A Logical Volume of the Logical Volume Manager (LVM).
Definition: LvmLv.h:147
const LvmLv * get_origin() const
Get the origin of the logical volume if it has one.
void set_stripes(unsigned int stripes)
Set the number of stripes.
const LvmVg * get_lvm_vg() const
Return volume group this logical volume belongs to.
unsigned long long get_stripe_size() const
Get the stripe size.
LvmLv * get_lvm_lv(const std::string &lv_name)
LvType get_lv_type() const
Return the logical volume type.
void set_stripe_size(unsigned long long stripe_size)
Set the stripe size.
LvmLv * get_origin()
Get the origin of the logical volume if it has one.
void set_lv_name(const std::string &lv_name)
Set the logical volume name.
static bool compare_by_lv_name(const LvmLv *lhs, const LvmLv *rhs)
Compare (less than) two LvmLvs by lv-name.
bool has_snapshots() const
Check whether the logical volume has snapshots.
static bool is_valid_lv_name(const std::string &lv_name)
Check whether a (new and public) logical volume name is valid.
unsigned int get_stripes() const
Get the number of stripes.
static LvmLv * create(Devicegraph *devicegraph, const std::string &vg_name, const std::string &lv_name, LvType lv_type)
Create a device of type LvmLv.
static std::vector< const LvmLv * > get_all(const Devicegraph *devicegraph)
Get all LvmLvs.
std::vector< const LvmLv * > get_snapshots() const
Get snapshots of the logical volume.
static std::vector< LvmLv * > get_all(Devicegraph *devicegraph)
Get all LvmLvs.
bool has_origin() const
Check whether the logical volume has an origin.
std::vector< LvmLv * > get_snapshots()
Get snapshots of the logical volume.
void set_chunk_size(unsigned long long chunk_size)
Set the chunk size.
unsigned long long max_size_for_lvm_lv(LvType lv_type) const
Return the max size in bytes for a new logical volume of type lv_type.
const LvmLv * get_thin_pool() const
Return the thin pool for a thin logical volume.
LvmLv * create_lvm_lv(const std::string &lv_name, LvType lv_type, unsigned long long size)
Create a logical volume with name lv_name and type lv_type in the thin pool.
const std::string & get_lv_name() const
Get the logical volume name.
unsigned long long get_chunk_size() const
Get the chunk size.
A Volume Group of the Logical Volume Manager (LVM).
Definition: LvmVg.h:61
The storage namespace.
Definition: Actiongraph.h:40
bool is_lvm_lv(const Device *device)
Checks whether device points to a LvmLv.
LvmLv * to_lvm_lv(Device *device)
Converts pointer to Device to pointer to LvmLv.
std::string get_lv_type_name(LvType lv_type)
Convert LvType to string.
LvType
LVM logical volume types, see lvs(8).
Definition: LvmLv.h:41
@ CACHE
A cache logical volume.
@ NORMAL
A linear or striped logical volume.
@ WRITECACHE
A writecache logical volume.
@ CACHE_POOL
A cache-pool logical volume.
@ SNAPSHOT
A thick snapshot.
@ MIRROR
A mirror volume.
@ RAID
A raid logical volume.
@ THIN
A thin logical volume.
@ THIN_POOL
A thin-pool logical volume.