libstorage-ng
BlkFilesystem.h
1 /*
2  * Copyright (c) [2014-2015] Novell, Inc.
3  * Copyright (c) [2016-2022] SUSE LLC
4  *
5  * All Rights Reserved.
6  *
7  * This program is free software; you can redistribute it and/or modify it
8  * under the terms of version 2 of the GNU General Public License as published
9  * by the Free Software Foundation.
10  *
11  * This program is distributed in the hope that it will be useful, but WITHOUT
12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14  * more details.
15  *
16  * You should have received a copy of the GNU General Public License along
17  * with this program; if not, contact Novell, Inc.
18  *
19  * To contact Novell about this file by physical or electronic mail, you may
20  * find current contact information at www.novell.com.
21  */
22 
23 
24 #ifndef STORAGE_BLK_FILESYSTEM_H
25 #define STORAGE_BLK_FILESYSTEM_H
26 
27 
28 #include <vector>
29 
30 #include "storage/Filesystems/Filesystem.h"
31 
32 
33 namespace storage
34 {
35 
36  class BlkDevice;
37  class ContentInfo;
38 
39 
40  // abstract class
41 
42  class BlkFilesystem : public Filesystem
43  {
44  public:
45 
49  static std::vector<BlkFilesystem*> get_all(Devicegraph* devicegraph);
50 
54  static std::vector<const BlkFilesystem*> get_all(const Devicegraph* devicegraph);
55 
59  bool supports_label() const;
60 
64  unsigned int max_labelsize() const;
65 
69  const std::string& get_label() const;
70 
75  void set_label(const std::string& label);
76 
80  bool supports_uuid() const;
81 
85  const std::string& get_uuid() const;
86 
92  void set_uuid(const std::string& uuid);
93 
97  const std::string& get_mkfs_options() const;
98 
104  void set_mkfs_options(const std::string& mkfs_options);
105 
109  bool supports_tune_options() const;
110 
114  const std::string& get_tune_options() const;
115 
123  void set_tune_options(const std::string& tune_options);
124 
128  bool supports_shrink() const;
129 
133  bool supports_grow() const;
134 
139  bool supports_mounted_shrink() const;
140 
145  bool supports_mounted_grow() const;
146 
151  bool supports_unmounted_shrink() const;
152 
157  bool supports_unmounted_grow() const;
158 
162  void set_resize_info(const ResizeInfo& resize_info);
163 
170 
174  void set_content_info(const ContentInfo& content_info);
175 
179  static std::vector<const BlkFilesystem*> find_by_label(const Devicegraph* devicegraph,
180  const std::string& label);
181 
185  static std::vector<const BlkFilesystem*> find_by_uuid(const Devicegraph* devicegraph,
186  const std::string& uuid);
187 
191  std::vector<BlkDevice*> get_blk_devices();
192 
196  std::vector<const BlkDevice*> get_blk_devices() const;
197 
198  public:
199 
200  class Impl;
201 
202  Impl& get_impl();
203  const Impl& get_impl() const;
204 
205  protected:
206 
207  BlkFilesystem(Impl* impl);
208 
209  };
210 
211 
217  bool is_blk_filesystem(const Device* device);
218 
226 
230  const BlkFilesystem* to_blk_filesystem(const Device* device);
231 
232 }
233 
234 #endif
BlkFilesystem * to_blk_filesystem(Device *device)
Converts pointer to Device to pointer to BlkFilesystem.
const std::string & get_mkfs_options() const
Get extra options for the filesystem mkfs command.
void set_resize_info(const ResizeInfo &resize_info)
Set the ResizeInfo.
bool supports_label() const
Return whether the filesystem supports a label.
bool supports_tune_options() const
Checks whether the filesystem supports tune options.
std::vector< BlkDevice * > get_blk_devices()
Get underlying blk devices of the blk filesystem.
ContentInfo detect_content_info() const
Detect the content info of the filesystem.
void set_content_info(const ContentInfo &content_info)
Set the ResizeInfo.
static std::vector< const BlkFilesystem * > find_by_label(const Devicegraph *devicegraph, const std::string &label)
Find filesystems by label.
unsigned int max_labelsize() const
Return the maximal allowed filesystem label length.
const std::string & get_tune_options() const
Get extra options for the filesystem tune command.
static std::vector< const BlkFilesystem * > find_by_uuid(const Devicegraph *devicegraph, const std::string &uuid)
Find filesystems by UUID.
void set_label(const std::string &label)
Set the filesystem label.
The main container of the libstorage-ng.
Definition: Devicegraph.h:169
bool supports_uuid() const
Return whether the filesystem supports a UUID.
const std::string & get_label() const
Get the filesystem label.
bool supports_unmounted_grow() const
Checks whether growing the filesystem while being unmounted is supported.
Definition: BlkFilesystem.h:42
An abstract base class for storage devices.
Definition: Device.h:81
void set_tune_options(const std::string &tune_options)
Set extra options for the filesystem tune command.
const std::string & get_uuid() const
Get the filesystem UUID.
Definition: FreeInfo.h:198
bool supports_mounted_grow() const
Checks whether growing the filesystem while being mounted is supported.
Definition: Filesystem.h:40
bool supports_grow() const
Checks whether growing the filesystem is supported.
static std::vector< BlkFilesystem * > get_all(Devicegraph *devicegraph)
Get all BlkFilesystems.
void set_uuid(const std::string &uuid)
Set the filesystem UUID.
The storage namespace.
Definition: Actiongraph.h:39
bool supports_unmounted_shrink() const
Checks whether shrinking the filesystem while being unmounted is supported.
bool supports_shrink() const
Checks whether shrinking the filesystem is supported.
bool supports_mounted_shrink() const
Checks whether shrinking the filesystem while being mounted is supported.
Definition: FreeInfo.h:301
void set_mkfs_options(const std::string &mkfs_options)
Set extra options for the filesystem mkfs command.
bool is_blk_filesystem(const Device *device)
Checks whether device points to a BlkFilesystem.