system/serenity
system/serenity
1
0
Fork 0
mirror of https://github.com/SerenityOS/serenity synced 2024-11-02 22:04:47 +00:00
Code Issues Projects Releases Packages Wiki Activity
serenity/Kernel/CommandLine.h

98 lines
2.6 KiB
C
Raw Normal View History

Meta: Add license header to source files As suggested by Joshua, this commit adds the 2-clause BSD license as a comment block to the top of every source file. For the first pass, I've just added myself for simplicity. I encourage everyone to add themselves as copyright holders of any file they've added or modified in some significant way. If I've added myself in error somewhere, feel free to replace it with the appropriate copyright holder instead. Going forward, all new source files should include a license header.
2020-01-18 08:38:21 +00:00
/*
* Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
*
Everything: Move to SPDX license identifiers in all files. SPDX License Identifiers are a more compact / standardized way of representing file license information. See: https://spdx.dev/resources/use/#identifiers This was done with the `ambr` search and replace tool. ambr --no-parent-ignore --key-from-file --rep-from-file key.txt rep.txt *
2021-04-22 08:24:48 +00:00
* SPDX-License-Identifier: BSD-2-Clause
Meta: Add license header to source files As suggested by Joshua, this commit adds the 2-clause BSD license as a comment block to the top of every source file. For the first pass, I've just added myself for simplicity. I encourage everyone to add themselves as copyright holders of any file they've added or modified in some significant way. If I've added myself in error somewhere, feel free to replace it with the appropriate copyright holder instead. Going forward, all new source files should include a license header.
2020-01-18 08:38:21 +00:00
*/
Kernel: Add KParams class for accessing kernel cmdline parameters (#188)
2019-06-04 10:54:27 +00:00
#pragma once
#include <AK/HashMap.h>
Kernel: Use KString all the way in sys$execve() This patch converts all the usage of AK::String around sys$execve() to using KString instead, allowing us to catch and propagate OOM errors. It also required changing the kernel CommandLine helper class to return a vector of KString for the userspace init program arguments.
2021-09-09 09:36:40 +00:00
#include <AK/NonnullOwnPtrVector.h>
Kernel: Simplify VMWareBackdoor somewhat - If there is no VMWare backdoor, don't allocate memory for it. - Remove the "unsupported" state, instead just don't instantiate. - Move the command-line parsing from init to the driver. - Move mouse packet reception from PS2MouseDevice to VMWareBackdoor.
2020-04-08 14:35:00 +00:00
#include <AK/Optional.h>
Kernel: Run clang-format on files Let's rip off the band-aid
2020-03-22 00:12:45 +00:00
#include <AK/String.h>
Kernel: Move Kernel CommandLine parsing to strongly typed API. Previously all of the CommandLine parsing was spread out around the Kernel. Instead move it all into the Kernel CommandLine class, and expose a strongly typed API for querying the state of options.
2021-03-03 08:51:55 +00:00
#include <AK/Vector.h>
Kernel: Use KString all the way in sys$execve() This patch converts all the usage of AK::String around sys$execve() to using KString instead, allowing us to catch and propagate OOM errors. It also required changing the kernel CommandLine helper class to return a vector of KString for the userspace init program arguments.
2021-09-09 09:36:40 +00:00
#include <Kernel/KString.h>
Kernel: Add KParams class for accessing kernel cmdline parameters (#188)
2019-06-04 10:54:27 +00:00
Kernel: Rename KParams => Kernel::CommandLine Let's make this read more like English.
2020-04-08 11:54:44 +00:00
namespace Kernel {
Kernel: Add KParams class for accessing kernel cmdline parameters (#188)
2019-06-04 10:54:27 +00:00
Kernel: Separate panic behavior from bootmode Bootmode used to control panic behavior and SystemServer. This patch factors panic behavior control into a separate flag.
2021-10-23 15:31:00 +00:00
enum class PanicMode {
Halt,
Shutdown,
};
Kernel: Move Kernel CommandLine parsing to strongly typed API. Previously all of the CommandLine parsing was spread out around the Kernel. Instead move it all into the Kernel CommandLine class, and expose a strongly typed API for querying the state of options.
2021-03-03 08:51:55 +00:00
enum class HPETMode {
Periodic,
NonPeriodic
};
enum class AcpiFeatureLevel {
Enabled,
Limited,
Disabled,
};
Kernel/PCI: Introduce a new ECAM access mechanism Now the kernel supports 2 ECAM access methods. MMIOAccess was renamed to WindowedMMIOAccess and is what we had until now - each device that is detected on boot is assigned to a memory-mapped window, so IO operations on multiple devices can occur simultaneously due to creating multiple virtual mappings, hence the name is a memory-mapped window. This commit adds a new class called MMIOAccess (not to be confused with the old MMIOAccess class). This class creates one memory-mapped window. On each IO operation on a configuration space of a device, it maps the requested PCI bus region to that window. Therefore it holds a SpinLock during the operation to ensure that no other PCI bus region was mapped during the call. A user can choose to either use PCI ECAM with memory-mapped window for each device, or for an entire bus. By default, the kernel prefers to map the entire PCI bus region.
2021-04-03 13:46:04 +00:00
enum class PCIAccessLevel {
IOAddressing,
Kernel/PCI: Simplify the entire subsystem A couple of things were changed: 1. Semantic changes - PCI segments are now called PCI domains, to better match what they are really. It's also the name that Linux gave, and it seems that Wikipedia also uses this name. We also remove PCI::ChangeableAddress, because it was used in the past but now it's no longer being used. 2. There are no WindowedMMIOAccess or MMIOAccess classes anymore, as they made a bunch of unnecessary complexity. Instead, Windowed access is removed entirely (this was tested, but never was benchmarked), so we are left with IO access and memory access options. The memory access option is essentially mapping the PCI bus (from the chosen PCI domain), to virtual memory as-is. This means that unless needed, at any time, there is only one PCI bus being mapped, and this is changed if access to another PCI bus in the same PCI domain is needed. For now, we don't support mapping of different PCI buses from different PCI domains at the same time, because basically it's still a non-issue for most machines out there. 2. OOM-safety is increased, especially when constructing the Access object. It means that we pre-allocating any needed resources, and we try to find PCI domains (if requested to initialize memory access) after we attempt to construct the Access object, so it's possible to fail at this point "gracefully". 3. All PCI API functions are now separated into a different header file, which means only "clients" of the PCI subsystem API will need to include that header file. 4. Functional changes - we only allow now to enumerate the bus after a hardware scan. This means that the old method "enumerate_hardware" is removed, so, when initializing an Access object, the initializing function must call rescan on it to force it to find devices. This makes it possible to fail rescan, and also to defer it after construction from both OOM-safety terms and hotplug capabilities.
2021-09-07 09:08:38 +00:00
MemoryAddressing,
Kernel/PCI: Introduce a new ECAM access mechanism Now the kernel supports 2 ECAM access methods. MMIOAccess was renamed to WindowedMMIOAccess and is what we had until now - each device that is detected on boot is assigned to a memory-mapped window, so IO operations on multiple devices can occur simultaneously due to creating multiple virtual mappings, hence the name is a memory-mapped window. This commit adds a new class called MMIOAccess (not to be confused with the old MMIOAccess class). This class creates one memory-mapped window. On each IO operation on a configuration space of a device, it maps the requested PCI bus region to that window. Therefore it holds a SpinLock during the operation to ensure that no other PCI bus region was mapped during the call. A user can choose to either use PCI ECAM with memory-mapped window for each device, or for an entire bus. By default, the kernel prefers to map the entire PCI bus region.
2021-04-03 13:46:04 +00:00
};
Kernel: Don't reset AHCI ports during boot unless requested Instead of blindly resetting every AHCI port, let's just reset only the controller by default. The user can still request to reset everything with a new kernel boot argument called ahci_reset_mode which is set by default to "controller", so the code will only invoke an HBA reset. This kernel boot argument can be set to 3 different values: 1. "controller" - reset the HBA and skip resetting AHCI ports 2. "none" - don't reset anything, so we rely on the firmware to initialize the AHCI HBA and ports for us. 3. "complete" - reset the AHCI HBA and ports.
2021-03-12 16:35:16 +00:00
enum class AHCIResetMode {
ControllerOnly,
Kernel/Storage: Remove the None option from AHCI reset policy This was proved to be a problematic option. I tested this option on bare metal AHCI controller, and if we didn't reset the controller, the firmware (SeaBIOS) could leave the controller state not clean, so an plugged device signature was in place although the specific port had no plugged device after rebooting. Therefore, we need to ensure we use the controller in a clean state always. In addition to that, the Complete option was renamed to Aggressive, as it represents better the consequences of choosing this option.
2021-05-28 22:18:45 +00:00
Aggressive,
Kernel: Don't reset AHCI ports during boot unless requested Instead of blindly resetting every AHCI port, let's just reset only the controller by default. The user can still request to reset everything with a new kernel boot argument called ahci_reset_mode which is set by default to "controller", so the code will only invoke an HBA reset. This kernel boot argument can be set to 3 different values: 1. "controller" - reset the HBA and skip resetting AHCI ports 2. "none" - don't reset anything, so we rely on the firmware to initialize the AHCI HBA and ports for us. 3. "complete" - reset the AHCI HBA and ports.
2021-03-12 16:35:16 +00:00
};
Kernel: Rename KParams => Kernel::CommandLine Let's make this read more like English.
2020-04-08 11:54:44 +00:00
class CommandLine {
AK_MAKE_ETERNAL;
Kernel: Simplify VMWareBackdoor somewhat - If there is no VMWare backdoor, don't allocate memory for it. - Remove the "unsupported" state, instead just don't instantiate. - Move the command-line parsing from init to the driver. - Move mouse packet reception from PS2MouseDevice to VMWareBackdoor.
2020-04-08 14:35:00 +00:00
Kernel: Rename KParams => Kernel::CommandLine Let's make this read more like English.
2020-04-08 11:54:44 +00:00
public:
Kernel: Copy command line to a safe place This avoids kmalloc overwriting it because it may be within the kmalloc or eternal pool.
2020-08-25 01:35:27 +00:00
static void early_initialize(const char* cmd_line);
static void initialize();
Kernel: Add KParams class for accessing kernel cmdline parameters (#188)
2019-06-04 10:54:27 +00:00
Kernel: Fix panic loop when encountering an unknown boot_mode The kernel panic handler now parses the kernels boot_mode to decide how to handle the panic. So the previous logic could end up in an panic loop until we blew out the kernel stack. Instead only validate the kernel's boot mode once per boot, after initializing the kernel command line.
2021-08-08 19:40:45 +00:00
enum class Validate {
Yes,
No,
};
Kernel: Move Kernel CommandLine parsing to strongly typed API. Previously all of the CommandLine parsing was spread out around the Kernel. Instead move it all into the Kernel CommandLine class, and expose a strongly typed API for querying the state of options.
2021-03-03 08:51:55 +00:00
[[nodiscard]] const String& string() const { return m_string; }
Everywhere: Pass AK::StringView by value
2021-11-10 23:55:02 +00:00
Optional<StringView> lookup(StringView key) const;
[[nodiscard]] bool contains(StringView key) const;
Kernel: Move Kernel CommandLine parsing to strongly typed API. Previously all of the CommandLine parsing was spread out around the Kernel. Instead move it all into the Kernel CommandLine class, and expose a strongly typed API for querying the state of options.
2021-03-03 08:51:55 +00:00
Kernel: Add 'boot_prof' option to enable full system profiling on boot The full system profiling functionality is useful for profiling the boot performance of the system. Add a new kernel boot option to start the system with profiling enabled. This lets you disable and view a profile once the system is booted. You can use it by running: ``` $ run.sh qcmd boot_prof ```
2021-03-03 09:00:41 +00:00
[[nodiscard]] bool is_boot_profiling_enabled() const;
Kernel: Move Kernel CommandLine parsing to strongly typed API. Previously all of the CommandLine parsing was spread out around the Kernel. Instead move it all into the Kernel CommandLine class, and expose a strongly typed API for querying the state of options.
2021-03-03 08:51:55 +00:00
[[nodiscard]] bool is_ide_enabled() const;
Kernel: Allow switching to IOAPIC mode even without enabling SMP This small change allows to use the IOAPIC by default without to enable SMP mode, which emulates Uni-Processor setup with IOAPIC instead of using the PIC. This opens the opportunity to utilize other types of interrupts like MSI and MSI-X interrupts.
2021-11-28 15:38:10 +00:00
[[nodiscard]] bool is_ioapic_enabled() const;
Kernel: Move Kernel CommandLine parsing to strongly typed API. Previously all of the CommandLine parsing was spread out around the Kernel. Instead move it all into the Kernel CommandLine class, and expose a strongly typed API for querying the state of options.
2021-03-03 08:51:55 +00:00
[[nodiscard]] bool is_smp_enabled() const;
Kernel/CommandLine: Add option to disable physical networking hardware This is useful for debugging sessions mostly.
2021-06-04 05:02:14 +00:00
[[nodiscard]] bool is_physical_networking_disabled() const;
Kernel: Move Kernel CommandLine parsing to strongly typed API. Previously all of the CommandLine parsing was spread out around the Kernel. Instead move it all into the Kernel CommandLine class, and expose a strongly typed API for querying the state of options.
2021-03-03 08:51:55 +00:00
[[nodiscard]] bool is_vmmouse_enabled() const;
Kernel/PCI: Introduce a new ECAM access mechanism Now the kernel supports 2 ECAM access methods. MMIOAccess was renamed to WindowedMMIOAccess and is what we had until now - each device that is detected on boot is assigned to a memory-mapped window, so IO operations on multiple devices can occur simultaneously due to creating multiple virtual mappings, hence the name is a memory-mapped window. This commit adds a new class called MMIOAccess (not to be confused with the old MMIOAccess class). This class creates one memory-mapped window. On each IO operation on a configuration space of a device, it maps the requested PCI bus region to that window. Therefore it holds a SpinLock during the operation to ensure that no other PCI bus region was mapped during the call. A user can choose to either use PCI ECAM with memory-mapped window for each device, or for an entire bus. By default, the kernel prefers to map the entire PCI bus region.
2021-04-03 13:46:04 +00:00
[[nodiscard]] PCIAccessLevel pci_access_level() const;
Kernel: Move Kernel CommandLine parsing to strongly typed API. Previously all of the CommandLine parsing was spread out around the Kernel. Instead move it all into the Kernel CommandLine class, and expose a strongly typed API for querying the state of options.
2021-03-03 08:51:55 +00:00
[[nodiscard]] bool is_legacy_time_enabled() const;
Kernel: Separate framebuffers from bootmode Bootmode used to control framebuffers, panic behavior, and SystemServer. This patch factors framebuffer control into a separate flag. Note that the combination 'bootmode=self-test fbdev=on' leads to unexpected behavior, which can only be fixed in a later commit.
2021-10-23 15:18:57 +00:00
[[nodiscard]] bool are_framebuffer_devices_enabled() const;
Kernel: Move Kernel CommandLine parsing to strongly typed API. Previously all of the CommandLine parsing was spread out around the Kernel. Instead move it all into the Kernel CommandLine class, and expose a strongly typed API for querying the state of options.
2021-03-03 08:51:55 +00:00
[[nodiscard]] bool is_force_pio() const;
[[nodiscard]] AcpiFeatureLevel acpi_feature_level() const;
Kernel+SystemServer: Change bootmode to system_mode 'bootmode' now only controls which set of services are started by SystemServer, so it is more appropriate to rename it to system_mode, and no longer validate it in the Kernel.
2021-10-23 16:26:50 +00:00
[[nodiscard]] StringView system_mode() const;
Kernel: Separate panic behavior from bootmode Bootmode used to control panic behavior and SystemServer. This patch factors panic behavior control into a separate flag.
2021-10-23 15:31:00 +00:00
[[nodiscard]] PanicMode panic_mode(Validate should_validate = Validate::No) const;
Kernel: Move Kernel CommandLine parsing to strongly typed API. Previously all of the CommandLine parsing was spread out around the Kernel. Instead move it all into the Kernel CommandLine class, and expose a strongly typed API for querying the state of options.
2021-03-03 08:51:55 +00:00
[[nodiscard]] HPETMode hpet_mode() const;
Kernel: Introduce two new boot arguments to assist with bare metal debug The first one is for disabling the PS2 controller, the other one is for disabling physical storage enumeration. We can't be sure any machine will work with our implementation, therefore this will help us to test more machines.
2021-04-08 18:18:48 +00:00
[[nodiscard]] bool disable_physical_storage() const;
[[nodiscard]] bool disable_ps2_controller() const;
Kernel: Add boot argument to disable the UHCI Controller Helps with bare metal debugging, as we can't be sure our implementation will work with a given machine. As reported by someone on Discord, their machine hangs when we attempt the dummy transfer.
2021-04-17 19:36:53 +00:00
[[nodiscard]] bool disable_uhci_controller() const;
Kernel/USB: Create controller base class and introduce USBManagement This removes Pipes dependency on the UHCIController by introducing a controller base class. This will be used to implement other controllers such as OHCI. Additionally, there can be multiple instances of a UHCI controller. For example, multiple UHCI instances can be required for systems with EHCI controllers. EHCI relies on using multiple of either UHCI or OHCI controllers to drive USB 1.x devices. This means UHCIController can no longer be a singleton. Multiple instances of it can now be created and passed to the device and then to the pipe. To handle finding and creating these instances, USBManagement has been introduced. It has the same pattern as the other management classes such as NetworkManagement.
2021-08-08 18:50:20 +00:00
[[nodiscard]] bool disable_usb() const;
Kernel: Add kernel command line flag to disable VirtIO support This command line flag can be used to disable VirtIO support on certain configurations (native windows) where interfacing with virtio devices can cause qemu to freeze.
2021-04-18 13:06:35 +00:00
[[nodiscard]] bool disable_virtio() const;
Kernel: Don't reset AHCI ports during boot unless requested Instead of blindly resetting every AHCI port, let's just reset only the controller by default. The user can still request to reset everything with a new kernel boot argument called ahci_reset_mode which is set by default to "controller", so the code will only invoke an HBA reset. This kernel boot argument can be set to 3 different values: 1. "controller" - reset the HBA and skip resetting AHCI ports 2. "none" - don't reset anything, so we rely on the firmware to initialize the AHCI HBA and ports for us. 3. "complete" - reset the AHCI HBA and ports.
2021-03-12 16:35:16 +00:00
[[nodiscard]] AHCIResetMode ahci_reset_mode() const;
AK+Kernel: StringView hash map Traits should not set peek type to String This typo / bug in the Traits<T> implementation for StringView caused AK::HashMap methods to return a `String` when looking up values out of a hash map of type HashTable<StringView,StringView>. This change fixes the typo, and fixes the only consumer, the kernel Commandline class.
2021-08-15 06:49:17 +00:00
[[nodiscard]] StringView userspace_init() const;
Kernel: Use KString all the way in sys$execve() This patch converts all the usage of AK::String around sys$execve() to using KString instead, allowing us to catch and propagate OOM errors. It also required changing the kernel CommandLine helper class to return a vector of KString for the userspace init program arguments.
2021-09-09 09:36:40 +00:00
[[nodiscard]] NonnullOwnPtrVector<KString> userspace_init_args() const;
AK+Kernel: StringView hash map Traits should not set peek type to String This typo / bug in the Traits<T> implementation for StringView caused AK::HashMap methods to return a `String` when looking up values out of a hash map of type HashTable<StringView,StringView>. This change fixes the typo, and fixes the only consumer, the kernel Commandline class.
2021-08-15 06:49:17 +00:00
[[nodiscard]] StringView root_device() const;
Kernel: Allow the user to specify the virtual console when booting
2021-05-13 21:22:02 +00:00
[[nodiscard]] size_t switch_to_tty() const;
Kernel: Run clang-format on everything.
2019-06-07 09:43:58 +00:00
Kernel: Add KParams class for accessing kernel cmdline parameters (#188)
2019-06-04 10:54:27 +00:00
private:
Kernel: Rename KParams => Kernel::CommandLine Let's make this read more like English.
2020-04-08 11:54:44 +00:00
CommandLine(const String&);
Kernel: Move CommandLine API to use AK::StringView instead of AK::String The current CommandLine API unfortunately allocates Strings just to query the presence of arguments on the command line. Switch the API to use StringView instead to reduce the number of String allocations.
2021-05-31 08:59:02 +00:00
void add_arguments(const Vector<StringView>& args);
Kernel/Commandline: Allow the user to specify an embedded string This is by default left empty, so people won't run the kernel in a mode which they didn't want to. The embedded string will override the supplied commandline from the bootloader, which is good for debugging sessions. This change seemed important for me, because I debug the kernel on bare metal with iPXE, and every change to the commandline meant that I needed rewrite a new iPXE USB image with a modified iPXE script.
2021-05-21 17:42:33 +00:00
void build_commandline(const String& cmdline_from_bootloader);
Kernel: Rename KParams => Kernel::CommandLine Let's make this read more like English.
2020-04-08 11:54:44 +00:00
String m_string;
Kernel: Move CommandLine API to use AK::StringView instead of AK::String The current CommandLine API unfortunately allocates Strings just to query the presence of arguments on the command line. Switch the API to use StringView instead to reduce the number of String allocations.
2021-05-31 08:59:02 +00:00
HashMap<StringView, StringView> m_params;
Kernel: Add KParams class for accessing kernel cmdline parameters (#188)
2019-06-04 10:54:27 +00:00
};
Kernel: Rename KParams => Kernel::CommandLine Let's make this read more like English.
2020-04-08 11:54:44 +00:00
const CommandLine& kernel_command_line();
}
Reference in a new issue Copy permalink