libstorage-ng
Partition.h
1 /*
2  * Copyright (c) [2014-2015] Novell, Inc.
3  * Copyright (c) [2016-2021] 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 
37 
41  enum class PartitionType {
42 
49  PRIMARY,
50 
54  EXTENDED,
55 
59  LOGICAL
60 
61  };
62 
63 
69  std::string get_partition_type_name(PartitionType partition_type);
70 
71 
85  enum IdNum : unsigned int {
86 
88  ID_DOS12 = 0x01,
89 
91  ID_DOS16 = 0x06,
92 
94  ID_NTFS = 0x07,
95 
97  ID_DOS32 = 0x0c,
98 
100  ID_EXTENDED = 0x0f,
101 
103  ID_DIAG = 0x12,
104 
106  ID_PREP = 0x41,
107 
109  ID_SWAP = 0x82,
110 
112  ID_LINUX = 0x83,
113 
115  ID_IRST = 0x84,
116 
118  ID_LVM = 0x8e,
119 
121  ID_RAID = 0xfd,
122 
124  ID_ESP = 0xef,
125 
127  ID_UNKNOWN = 0x100,
128 
131  ID_BIOS_BOOT = 0x101,
132 
135 
138 
140  ID_LINUX_HOME = 0x104,
141 
142  };
143 
144 
152  std::string get_partition_id_name(IdNum partition_id);
153 
154 
158  class Partition : public BlkDevice
159  {
160  public:
161 
169  static Partition* create(Devicegraph* devicegraph, const std::string& name,
170  const Region& region, PartitionType type);
171 
172  static Partition* load(Devicegraph* devicegraph, const xmlNode* node);
173 
177  unsigned int get_number() const;
178 
184  PartitionType get_type() const;
185 
193  void set_type(PartitionType type);
194 
195  unsigned int get_id() const;
196 
200  void set_id(unsigned int id);
201 
205  bool is_boot() const;
206 
223  void set_boot(bool boot);
224 
228  bool is_legacy_boot() const;
229 
235  void set_legacy_boot(bool legacy_boot);
236 
243  const std::string& get_label() const;
244 
250  void set_label(const std::string& label);
251 
255  const std::string& get_uuid() const;
256 
263 
267  const PartitionTable* get_partition_table() const;
268 
275 
279  const Partitionable* get_partitionable() const;
280 
288 
294  static Partition* find_by_name(Devicegraph* devicegraph, const std::string& name);
295 
299  static const Partition* find_by_name(const Devicegraph* devicegraph, const std::string& name);
300 
306  static bool compare_by_number(const Partition* lhs, const Partition* rhs);
307 
308  public:
309 
310  class Impl;
311 
312  Impl& get_impl();
313  const Impl& get_impl() const;
314 
315  virtual Partition* clone() const override;
316 
317  protected:
318 
319  Partition(Impl* impl);
320 
321  };
322 
323 
329  bool is_partition(const Device* device);
330 
337  Partition* to_partition(Device* device);
338 
342  const Partition* to_partition(const Device* device);
343 
344 }
345 
346 #endif
Only for MS-DOS.
Definition: Partition.h:94
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:131
Only set during probing.
Definition: Partition.h:127
For MS-DOS, GPT, DASD and implicit.
Definition: Partition.h:112
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:103
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.
Only for MS-DOS.
Definition: Partition.h:91
PartitionType
Enum with partition types.
Definition: Partition.h:41
Only for MS-DOS.
Definition: Partition.h:88
void set_label(const std::string &label)
Set the partition label.
LVM partition, for MS-DOS, GPT and DASD.
Definition: Partition.h:118
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:73
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:106
Windows basic data partition, only for GPT.
Definition: Partition.h:134
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:115
EFI System Partition, for MS-DOS and GPT.
Definition: Partition.h:124
The main container of the libstorage-ng.
Definition: Devicegraph.h:169
Swap partition, for MS-DOS, GPT and DASD.
Definition: Partition.h:109
Only for MS-DOS.
Definition: Partition.h:97
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.
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:137
Only for MS-DOS.
Definition: Partition.h:100
Definition: Partitionable.h:39
bool is_legacy_boot() const
Query the legacy boot flag of the partition.
A partition of a Partitionable, e.g.
Definition: Partition.h:158
RAID partition, for MS-DOS, GPT and DASD.
Definition: Partition.h:121
Linux home, only for GPT.
Definition: Partition.h:140
The storage namespace.
Definition: Actiongraph.h:38
static Partition * find_by_name(Devicegraph *devicegraph, const std::string &name)
Find a Partition by its name.
Definition: PartitionTable.h:87
bool is_boot() const
Query the boot flag of the partition.
IdNum
Enum with values used as partition ids.
Definition: Partition.h:85
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)