libstorage-ng
Partition.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_PARTITION_H
25 #define STORAGE_PARTITION_H
26 
27 
28 #include "storage/Devices/BlkDevice.h"
29 
30 
31 namespace storage
32 {
33 
34  class PartitionTable;
35  class Partitionable;
36  class SystemInfo;
37 
38 
42  enum class PartitionType {
43 
50  PRIMARY,
51 
55  EXTENDED,
56 
60  LOGICAL
61 
62  };
63 
64 
70  std::string get_partition_type_name(PartitionType partition_type);
71 
72 
86  enum IdNum : unsigned int {
87 
89  ID_DOS12 = 0x01,
90 
92  ID_DOS16 = 0x06,
93 
95  ID_NTFS = 0x07,
96 
98  ID_DOS32 = 0x0c,
99 
101  ID_EXTENDED = 0x0f,
102 
104  ID_DIAG = 0x12,
105 
107  ID_PREP = 0x41,
108 
110  ID_SWAP = 0x82,
111 
113  ID_LINUX = 0x83,
114 
116  ID_IRST = 0x84,
117 
119  ID_LVM = 0x8e,
120 
122  ID_RAID = 0xfd,
123 
125  ID_ESP = 0xef,
126 
128  ID_UNKNOWN = 0x100,
129 
133 
136 
139 
142 
145 
148 
151 
154 
157 
160 
163 
166 
169 
172 
175 
178 
181 
184 
187 
190 
193 
196 
199 
202 
205 
208 
211 
212  };
213 
214 
222  std::string get_partition_id_name(IdNum partition_id);
223 
224 
229  {
230  ROOT, USR
231  };
232 
233 
242  IdNum get_linux_partition_id(LinuxPartitionIdCategory linux_partition_id_category, SystemInfo& system_info);
243 
244 
248  class Partition : public BlkDevice
249  {
250  public:
251 
259  static Partition* create(Devicegraph* devicegraph, const std::string& name,
260  const Region& region, PartitionType type);
261 
262  static Partition* load(Devicegraph* devicegraph, const xmlNode* node);
263 
267  unsigned int get_number() const;
268 
274  PartitionType get_type() const;
275 
283  void set_type(PartitionType type);
284 
290  unsigned int get_id() const;
291 
299  void set_id(unsigned int id);
300 
304  bool is_boot() const;
305 
324  void set_boot(bool boot);
325 
329  bool is_legacy_boot() const;
330 
338  void set_legacy_boot(bool legacy_boot);
339 
346  const std::string& get_label() const;
347 
353  void set_label(const std::string& label);
354 
358  const std::string& get_uuid() const;
359 
366 
370  const PartitionTable* get_partition_table() const;
371 
378 
382  const Partitionable* get_partitionable() const;
383 
391 
397  static Partition* find_by_name(Devicegraph* devicegraph, const std::string& name);
398 
402  static const Partition* find_by_name(const Devicegraph* devicegraph, const std::string& name);
403 
409  static bool compare_by_number(const Partition* lhs, const Partition* rhs);
410 
411  public:
412 
413  class Impl;
414 
415  Impl& get_impl();
416  const Impl& get_impl() const;
417 
418  virtual Partition* clone() const override;
419 
420  protected:
421 
422  Partition(Impl* impl);
423 
424  };
425 
426 
432  bool is_partition(const Device* device);
433 
440  Partition* to_partition(Device* device);
441 
445  const Partition* to_partition(const Device* device);
446 
447 }
448 
449 #endif
Only for MS-DOS.
Definition: Partition.h:95
Partition * to_partition(Device *device)
Converts pointer to Device to pointer to Partition.
BIOS boot partition (https://en.wikipedia.org/wiki/BIOS_boot_partition), only for GPT...
Definition: Partition.h:132
Only set during probing.
Definition: Partition.h:128
Linux USR Partition (x86), only for GPT.
Definition: Partition.h:207
Linux Root Partition (x86), only for GPT.
Definition: Partition.h:174
Linux Root Partition (s390x), only for GPT.
Definition: Partition.h:171
For MS-DOS, GPT, DASD and implicit.
Definition: Partition.h:113
void set_type(PartitionType type)
Set the partiton type.
std::string get_partition_id_name(IdNum partition_id)
Convert the IdNum partition_id to a string.
For MS-DOS and GPT.
Definition: Partition.h:104
Linux USR Partition (s390), only for GPT.
Definition: Partition.h:201
unsigned int get_id() const
Get the partition id.
void set_legacy_boot(bool legacy_boot)
Set the legacy boot flag of the partition.
PartitionTable * get_partition_table()
Return the partition table the partition belongs to.
static bool compare_by_number(const Partition *lhs, const Partition *rhs)
Compare (less than) two Partitions by number.
Linux Root Partition (aarch64), only for GPT.
Definition: Partition.h:150
Linux Server Data, only for GPT.
Definition: Partition.h:144
Linux USR Partition (ppc), only for GPT.
Definition: Partition.h:186
Only for MS-DOS.
Definition: Partition.h:92
PartitionType
Enum with partition types.
Definition: Partition.h:42
Only for MS-DOS.
Definition: Partition.h:89
void set_label(const std::string &label)
Set the partition label.
LVM partition, for MS-DOS, GPT and DASD.
Definition: Partition.h:119
Linux Root Partition (ppc64be), only for GPT.
Definition: Partition.h:156
LinuxPartitionIdCategory
Enum with categories for Linux partitions.
Definition: Partition.h:228
Linux USR Partition (riscv32), only for GPT.
Definition: Partition.h:195
Linux USR Partition (x86_64), only for GPT.
Definition: Partition.h:210
IdNum get_linux_partition_id(LinuxPartitionIdCategory linux_partition_id_category, SystemInfo &system_info)
Get the partition id for the Linux partition of the given category (root, usr, ...) depending on the architecture.
Linux Root Partition (arm), only for GPT.
Definition: Partition.h:147
std::string get_partition_type_name(PartitionType partition_type)
Convert the PartitionType partition_type to a string.
A start/length pair with a block size.
Definition: Region.h:84
Linux Root Partition (x86_64), only for GPT.
Definition: Partition.h:177
Region get_unused_surrounding_region() const
Returns the unused region surrounding the partition (including the partition itself).
PPC PReP Boot partition, for MS-DOS and GPT.
Definition: Partition.h:107
Linux USR Partition (s390x), only for GPT.
Definition: Partition.h:204
Windows basic data partition, only for GPT.
Definition: Partition.h:135
Linux USR Partition (ppc64le), only for GPT.
Definition: Partition.h:192
bool is_partition(const Device *device)
Checks whether device points to a Partition.
Intel Rapid Start Technology, for MS-DOS and GPT.
Definition: Partition.h:116
EFI System Partition, for MS-DOS and GPT.
Definition: Partition.h:125
The main container of the libstorage-ng.
Definition: Devicegraph.h:169
Swap partition, for MS-DOS, GPT and DASD.
Definition: Partition.h:110
Only for MS-DOS.
Definition: Partition.h:98
const std::string & get_label() const
Get the partition label.
An abstract Block Device.
Definition: BlkDevice.h:48
unsigned int get_number() const
Get the partition number.
const std::string & get_uuid() const
Get the partition UUID.
void set_boot(bool boot)
Set the boot flag of the partition.
Linux Root Partition (s390), only for GPT.
Definition: Partition.h:168
Linux USR Partition (arm), only for GPT.
Definition: Partition.h:180
An abstract base class for storage devices.
Definition: Device.h:81
PartitionType get_type() const
Get the partition type.
Partitionable * get_partitionable()
Return the partitionable the partition belongs to.
Microsoft reserved partition, only for GPT.
Definition: Partition.h:138
Only for MS-DOS.
Definition: Partition.h:101
Definition: Partitionable.h:39
Linux USR Partition (ppc64be), only for GPT.
Definition: Partition.h:189
bool is_legacy_boot() const
Query the legacy boot flag of the partition.
Linux Root Partition (ppc64le), only for GPT.
Definition: Partition.h:159
A partition of a Partitionable, e.g.
Definition: Partition.h:248
Linux USR Partition (riscv64), only for GPT.
Definition: Partition.h:198
RAID partition, for MS-DOS, GPT and DASD.
Definition: Partition.h:122
Linux Root Partition (riscv64), only for GPT.
Definition: Partition.h:165
Linux Home, only for GPT.
Definition: Partition.h:141
The storage namespace.
Definition: Actiongraph.h:39
Linux Root Partition (riscv32, only for GPT.
Definition: Partition.h:162
static Partition * find_by_name(Devicegraph *devicegraph, const std::string &name)
Find a Partition by its name.
Definition: PartitionTable.h:87
Linux Root Partition (ppc), only for GPT.
Definition: Partition.h:153
Linux USR Partition (aarch64), only for GPT.
Definition: Partition.h:183
bool is_boot() const
Query the boot flag of the partition.
IdNum
Enum with values used as partition ids.
Definition: Partition.h:86
static Partition * create(Devicegraph *devicegraph, const std::string &name, const Region &region, PartitionType type)
Create a device of type Partition.
void set_id(unsigned int id)
Set the partition id.