2020-12-19 13:25:06 +00:00
|
|
|
/*
|
2022-04-25 16:54:06 +00:00
|
|
|
* Copyright (c) 2020-2022, Liav A. <liavalb@hotmail.co.il>
|
2020-12-19 13:25:06 +00:00
|
|
|
*
|
2021-04-22 08:24:48 +00:00
|
|
|
* SPDX-License-Identifier: BSD-2-Clause
|
2020-12-19 13:25:06 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
|
2021-08-27 05:08:43 +00:00
|
|
|
#include <AK/IntrusiveList.h>
|
2020-12-19 13:25:06 +00:00
|
|
|
#include <AK/Types.h>
|
2020-12-26 14:53:30 +00:00
|
|
|
#include <Kernel/FileSystem/FileSystem.h>
|
2022-08-19 18:53:40 +00:00
|
|
|
#include <Kernel/Library/NonnullLockRefPtr.h>
|
|
|
|
|
#include <Kernel/Library/NonnullLockRefPtrVector.h>
|
2022-03-02 01:24:01 +00:00
|
|
|
#include <Kernel/Storage/DiskPartition.h>
|
2020-12-19 13:25:06 +00:00
|
|
|
#include <Kernel/Storage/StorageController.h>
|
|
|
|
|
#include <Kernel/Storage/StorageDevice.h>
|
2022-03-01 23:09:46 +00:00
|
|
|
#include <LibPartition/PartitionTable.h>
|
2020-12-19 13:25:06 +00:00
|
|
|
|
|
|
|
|
namespace Kernel {
|
|
|
|
|
|
Kernel/Storage: Introduce new boot device addressing modes
Before of this patch, we supported two methods to address a boot device:
1. Specifying root=/dev/hdXY, where X is a-z letter which corresponds to
a boot device, and Y as number from 1 to 16, to indicate the partition
number, which can be omitted to instruct the kernel to use a raw device
rather than a partition on a raw device.
2. Specifying root=PARTUUID: with a GUID string of a GUID partition. In
case of existing storage device with GPT partitions, this is most likely
the safest option to ensure booting from persistent storage.
While option 2 is more advanced and reliable, the first option has 2
caveats:
1. The string prefix "/dev/hd" doesn't mean anything beside a convention
on Linux installations, that was taken into use in Serenity. In Serenity
we don't mount DevTmpFS before we mount the boot device on /, so the
kernel doesn't really access /dev anyway, so this convention is only a
big misleading relic that can easily make the user to assume we access
/dev early on boot.
2. This convention although resemble the simple linux convention, is
quite limited in specifying a correct boot device across hardware setup
changes, so option 2 was recommended to ensure the system is always
bootable.
With these caveats in mind, this commit tries to fix the problem with
adding more addressing options as well as to remove the first option
being mentioned above of addressing.
To sum it up, there are 4 addressing options:
1. Hardware relative address - Each instance of StorageController is
assigned with a index number relative to the type of hardware it handles
which makes it possible to address storage devices with a prefix of the
commandset ("ata" for ATA, "nvme" for NVMe, "ramdisk" for Plain memory),
and then the number for the parent controller relative hardware index,
another number LUN target_id, and a third number for LUN disk_id.
2. LUN address - Similar to the previous option, but instead we rely on
the parent controller absolute index for the first number.
3. Block device major and minor numbers - by specifying the major and
minor numbers, the kernel can simply try to get the corresponding block
device and use it as the boot device.
4. GUID string, in the same fashion like before, so the user use the
"PARTUUID:" string prefix and add the GUID of the GPT partition.
For the new address modes 1 and 2, the user can choose to also specify a
partition out of the selected boot device. To do that, the user needs to
append the semicolon character and then add the string "partX" where X
is to be changed for the partition number. We start counting from 0, and
therefore the first partition number is 0 and not 1 in the kernel boot
argument.
2022-08-05 17:32:26 +00:00
|
|
|
class ATAController;
|
|
|
|
|
class NVMeController;
|
2020-12-19 13:25:06 +00:00
|
|
|
class StorageManagement {
|
|
|
|
|
|
|
|
|
|
public:
|
2021-08-27 05:08:43 +00:00
|
|
|
StorageManagement();
|
2020-12-19 13:25:06 +00:00
|
|
|
static bool initialized();
|
2022-01-27 11:14:58 +00:00
|
|
|
void initialize(StringView boot_argument, bool force_pio, bool nvme_poll);
|
2020-12-19 13:25:06 +00:00
|
|
|
static StorageManagement& the();
|
|
|
|
|
|
2022-08-19 18:53:40 +00:00
|
|
|
NonnullLockRefPtr<FileSystem> root_filesystem() const;
|
2020-12-26 14:53:30 +00:00
|
|
|
|
2021-12-23 18:08:18 +00:00
|
|
|
static MajorNumber storage_type_major_number();
|
|
|
|
|
static MinorNumber generate_storage_minor_number();
|
2021-02-25 17:36:49 +00:00
|
|
|
|
2022-07-23 08:15:35 +00:00
|
|
|
static MinorNumber generate_partition_minor_number();
|
|
|
|
|
|
Kernel/Storage: Add LUN address to each StorageDevice
LUN address is essentially how people used to address SCSI devices back
in the day we had these devices more in use. However, SCSI was taken as
an abstraction layer for many Unix and Unix-like systems, so it still
common to see LUN addresses in use. In Serenity, we don't really provide
such abstraction layer, and therefore until now, we didn't use LUNs too.
However (again), this changes, as we want to let users to address their
devices under SysFS easily. LUNs make sense in that regard, because they
can be easily adapted to different interfaces besides SCSI.
For example, for legacy ATA hard drive being connected to the first IDE
controller which was enumerated on the PCI bus, and then to the primary
channel as slave device, the LUN address would be 0:0:1.
To make this happen, we add unique ID number to each StorageController,
which increments by 1 for each new instance of StorageController. Then,
we adapt the ATA and NVMe devices to use these numbers and generate LUN
in the construction time.
2022-04-22 15:52:20 +00:00
|
|
|
static u32 generate_controller_id();
|
|
|
|
|
|
Kernel/Storage: Introduce new boot device addressing modes
Before of this patch, we supported two methods to address a boot device:
1. Specifying root=/dev/hdXY, where X is a-z letter which corresponds to
a boot device, and Y as number from 1 to 16, to indicate the partition
number, which can be omitted to instruct the kernel to use a raw device
rather than a partition on a raw device.
2. Specifying root=PARTUUID: with a GUID string of a GUID partition. In
case of existing storage device with GPT partitions, this is most likely
the safest option to ensure booting from persistent storage.
While option 2 is more advanced and reliable, the first option has 2
caveats:
1. The string prefix "/dev/hd" doesn't mean anything beside a convention
on Linux installations, that was taken into use in Serenity. In Serenity
we don't mount DevTmpFS before we mount the boot device on /, so the
kernel doesn't really access /dev anyway, so this convention is only a
big misleading relic that can easily make the user to assume we access
/dev early on boot.
2. This convention although resemble the simple linux convention, is
quite limited in specifying a correct boot device across hardware setup
changes, so option 2 was recommended to ensure the system is always
bootable.
With these caveats in mind, this commit tries to fix the problem with
adding more addressing options as well as to remove the first option
being mentioned above of addressing.
To sum it up, there are 4 addressing options:
1. Hardware relative address - Each instance of StorageController is
assigned with a index number relative to the type of hardware it handles
which makes it possible to address storage devices with a prefix of the
commandset ("ata" for ATA, "nvme" for NVMe, "ramdisk" for Plain memory),
and then the number for the parent controller relative hardware index,
another number LUN target_id, and a third number for LUN disk_id.
2. LUN address - Similar to the previous option, but instead we rely on
the parent controller absolute index for the first number.
3. Block device major and minor numbers - by specifying the major and
minor numbers, the kernel can simply try to get the corresponding block
device and use it as the boot device.
4. GUID string, in the same fashion like before, so the user use the
"PARTUUID:" string prefix and add the GUID of the GPT partition.
For the new address modes 1 and 2, the user can choose to also specify a
partition out of the selected boot device. To do that, the user needs to
append the semicolon character and then add the string "partX" where X
is to be changed for the partition number. We start counting from 0, and
therefore the first partition number is 0 and not 1 in the kernel boot
argument.
2022-08-05 17:32:26 +00:00
|
|
|
static u32 generate_relative_nvme_controller_id(Badge<NVMeController>);
|
|
|
|
|
static u32 generate_relative_ata_controller_id(Badge<ATAController>);
|
|
|
|
|
|
2021-08-27 05:08:43 +00:00
|
|
|
void remove_device(StorageDevice&);
|
|
|
|
|
|
2020-12-19 13:25:06 +00:00
|
|
|
private:
|
2020-12-31 11:17:03 +00:00
|
|
|
bool boot_argument_contains_partition_uuid();
|
2020-12-26 14:53:30 +00:00
|
|
|
|
2022-01-21 14:18:31 +00:00
|
|
|
void enumerate_pci_controllers(bool force_pio, bool nvme_poll);
|
2021-08-27 05:08:43 +00:00
|
|
|
void enumerate_storage_devices();
|
2022-01-03 10:58:38 +00:00
|
|
|
void enumerate_disk_partitions();
|
2020-12-26 14:53:30 +00:00
|
|
|
|
2020-12-31 11:17:03 +00:00
|
|
|
void determine_boot_device();
|
|
|
|
|
void determine_boot_device_with_partition_uuid();
|
2020-12-26 14:53:30 +00:00
|
|
|
|
Kernel/Storage: Introduce new boot device addressing modes
Before of this patch, we supported two methods to address a boot device:
1. Specifying root=/dev/hdXY, where X is a-z letter which corresponds to
a boot device, and Y as number from 1 to 16, to indicate the partition
number, which can be omitted to instruct the kernel to use a raw device
rather than a partition on a raw device.
2. Specifying root=PARTUUID: with a GUID string of a GUID partition. In
case of existing storage device with GPT partitions, this is most likely
the safest option to ensure booting from persistent storage.
While option 2 is more advanced and reliable, the first option has 2
caveats:
1. The string prefix "/dev/hd" doesn't mean anything beside a convention
on Linux installations, that was taken into use in Serenity. In Serenity
we don't mount DevTmpFS before we mount the boot device on /, so the
kernel doesn't really access /dev anyway, so this convention is only a
big misleading relic that can easily make the user to assume we access
/dev early on boot.
2. This convention although resemble the simple linux convention, is
quite limited in specifying a correct boot device across hardware setup
changes, so option 2 was recommended to ensure the system is always
bootable.
With these caveats in mind, this commit tries to fix the problem with
adding more addressing options as well as to remove the first option
being mentioned above of addressing.
To sum it up, there are 4 addressing options:
1. Hardware relative address - Each instance of StorageController is
assigned with a index number relative to the type of hardware it handles
which makes it possible to address storage devices with a prefix of the
commandset ("ata" for ATA, "nvme" for NVMe, "ramdisk" for Plain memory),
and then the number for the parent controller relative hardware index,
another number LUN target_id, and a third number for LUN disk_id.
2. LUN address - Similar to the previous option, but instead we rely on
the parent controller absolute index for the first number.
3. Block device major and minor numbers - by specifying the major and
minor numbers, the kernel can simply try to get the corresponding block
device and use it as the boot device.
4. GUID string, in the same fashion like before, so the user use the
"PARTUUID:" string prefix and add the GUID of the GPT partition.
For the new address modes 1 and 2, the user can choose to also specify a
partition out of the selected boot device. To do that, the user needs to
append the semicolon character and then add the string "partX" where X
is to be changed for the partition number. We start counting from 0, and
therefore the first partition number is 0 and not 1 in the kernel boot
argument.
2022-08-05 17:32:26 +00:00
|
|
|
void resolve_partition_from_boot_device_parameter(StorageDevice const& chosen_storage_device, StringView boot_device_prefix);
|
|
|
|
|
void determine_boot_device_with_logical_unit_number();
|
|
|
|
|
void determine_block_boot_device();
|
|
|
|
|
void determine_nvme_boot_device();
|
|
|
|
|
void determine_ata_boot_device();
|
|
|
|
|
void determine_hardware_relative_boot_device(StringView relative_hardware_prefix, Function<bool(StorageDevice const&)> filter_device_callback);
|
|
|
|
|
Array<unsigned, 3> extract_boot_device_address_parameters(StringView device_prefix);
|
|
|
|
|
Optional<unsigned> extract_boot_device_partition_number_parameter(StringView device_prefix);
|
|
|
|
|
|
2022-01-26 19:47:30 +00:00
|
|
|
void dump_storage_devices_and_partitions() const;
|
|
|
|
|
|
2022-03-01 23:09:46 +00:00
|
|
|
ErrorOr<NonnullOwnPtr<Partition::PartitionTable>> try_to_initialize_partition_table(StorageDevice const&) const;
|
2020-12-19 13:25:06 +00:00
|
|
|
|
2022-08-19 18:53:40 +00:00
|
|
|
LockRefPtr<BlockDevice> boot_block_device() const;
|
2020-12-31 11:17:03 +00:00
|
|
|
|
2021-10-02 22:11:01 +00:00
|
|
|
StringView m_boot_argument;
|
2022-08-19 18:53:40 +00:00
|
|
|
LockWeakPtr<BlockDevice> m_boot_block_device;
|
|
|
|
|
NonnullLockRefPtrVector<StorageController> m_controllers;
|
2021-09-09 12:00:59 +00:00
|
|
|
IntrusiveList<&StorageDevice::m_list_node> m_storage_devices;
|
2020-12-19 13:25:06 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
}
|