StormByte-System 3.0.0
C++26 process and environment module of the StormByte suite
Loading...
Searching...
No Matches
host.hxx
Go to the documentation of this file.
1/*
2 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
3 *
4 * This file is part of StormByte-System.
5 *
6 * StormByte-System original source is dual-licensed:
7 *
8 * 1. GNU Lesser General Public License v3.0 (or later)
9 * You may redistribute and/or modify this file under the terms of the
10 * GNU Lesser General Public License as published by the Free Software
11 * Foundation, either version 3 of the License, or (at your option)
12 * any later version.
13 *
14 * 2. Commercial license
15 * Alternatively, this file may be used under the terms of a commercial
16 * license agreement with the copyright holder
17 * (David C. Manuelda <StormByte@gmail.com>).
18 *
19 * Both licenses apply only to original StormByte-System source in this
20 * repository. They do not cover other StormByte modules or any third-party
21 * material shipped with this repository (including everything under
22 * thirdparty/, and in particular the bundled StormByte Base tree), which
23 * remains under its own license.
24 *
25 * Neither license grants any patent rights. Any patent licenses required
26 * to use this software or third-party components must be obtained separately
27 * from the patent holders.
28 *
29 * StormByte-System is distributed in the hope that it will be useful,
30 * but WITHOUT ANY WARRANTY; without even the implied warranty of
31 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
32 * GNU Lesser General Public License for more details.
33 *
34 * You should have received a copy of the GNU Lesser General Public License
35 * version 3 along with StormByte-System. If not, see
36 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
37 *
38 * SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-StormByte-Commercial
39 */
40
41#pragma once
42
43#include <StormByte/byte_size.hxx>
44#include <StormByte/error.hxx>
45#include <StormByte/safe/string.hxx>
47
48#include <string>
49#include <system_error>
50
54namespace StormByte::System {
64 namespace Host {
78
84
91
101 public:
105 CPU() = default;
106
111 CPU(const CPU& other) = default;
112
117 CPU(CPU&& other) noexcept = default;
118
122 ~CPU() = default;
123
129 CPU& operator=(const CPU& other) = default;
130
136 CPU& operator=(CPU&& other) noexcept = default;
137
143
149
155
160 unsigned PhysicalCores() const;
161
166 unsigned LogicalProcessors() const noexcept;
167
172 unsigned Bitness() const noexcept;
173 };
174
183 public:
187 Motherboard() = default;
188
193 Motherboard(const Motherboard& other) = default;
194
199 Motherboard(Motherboard&& other) noexcept = default;
200
204 ~Motherboard() = default;
205
211 Motherboard& operator=(const Motherboard& other) = default;
212
218 Motherboard& operator=(Motherboard&& other) noexcept = default;
219
225
231
237 };
238
244
250
256
262
268 }
269}
270
274template<>
276 static constexpr const char* Name = "StormByte.System.Host";
277
284 switch (e) {
286 return "Success";
288 return "Host operation failed";
290 return "Host property is not supported";
292 return "Host property is unavailable";
294 return "Host property access denied";
295 }
296 return "Unknown Host error";
297 }
298};
299
300namespace StormByte::System {
306
314 return std::error_code(static_cast<int>(e), host_category());
315 }
316}
317
318namespace std {
322 template<>
323 struct is_error_code_enum<StormByte::System::Host::Error>: true_type {};
324}
StormByte::Safe::String Model() const
Processor brand text.
unsigned LogicalProcessors() const noexcept
Logical processor count visible to the OS.
~CPU()=default
Destroy a query object.
unsigned PhysicalCores() const
Physical core count across processor packages.
StormByte::Safe::String Manufacturer() const
Processor vendor identifier, when exposed by the OS.
CPU()=default
Construct a stateless query object without probing.
CPU & operator=(const CPU &other)=default
Copy-assign a query object.
CPU & operator=(CPU &&other) noexcept=default
Move-assign a query object.
CPU(const CPU &other)=default
Copy a query object.
StormByte::Safe::String Architecture() const
Native instruction-set name.
CPU(CPU &&other) noexcept=default
Move a query object.
unsigned Bitness() const noexcept
Pointer width of this process, not CPU capability.
Motherboard & operator=(Motherboard &&other) noexcept=default
Move-assign a query object.
StormByte::Safe::String Manufacturer() const
Board manufacturer supplied by firmware.
StormByte::Safe::String Revision() const
Board revision supplied by firmware.
Motherboard & operator=(const Motherboard &other)=default
Copy-assign a query object.
Motherboard(const Motherboard &other)=default
Copy a query object.
Motherboard(Motherboard &&other) noexcept=default
Move a query object.
~Motherboard()=default
Destroy a query object.
Motherboard()=default
Construct a stateless query object without probing.
StormByte::Safe::String Model() const
Board product identifier.
Identity and capacity of this machine.
Definition host.hxx:64
bool Name(StormByte::Safe::String &name)
Host name of this machine.
StormByte::ByteSize AvailableMemory()
Currently available physical memory.
StormByte::ByteSize PageSize()
System page size.
Error
Host enumerators.
Definition host.hxx:71
@ Unavailable
The platform did not supply this property.
Definition host.hxx:75
@ Success
No error.
Definition host.hxx:72
@ NotSupported
No native source for this property.
Definition host.hxx:74
@ Failed
The platform call failed.
Definition host.hxx:73
@ Permission
Access to this property was denied.
Definition host.hxx:76
StormByte::Safe::String OS()
Operating system brand and version.
StormByte::Error::Fault LastError() noexcept
Last Host error on this thread.
StormByte::Safe::String Kernel()
Kernel identification.
StormByte::ByteSize PhysicalMemory()
Installed physical memory.
System module of the StormByte suite.
Definition device.hxx:59
STORMBYTE_FORCE_INLINE std::error_code make_error_code(Device::Error e) noexcept
Builds an std::error_code from Device::Error.
Definition device.hxx:341
const StormByte::Error::Category< Host::Error > & host_category() noexcept
Category singleton for Host::Error.
STL namespace.
#define STORMBYTE_FORCE_INLINE
static constexpr const char * Name
Stable category tag.
Definition host.hxx:276
static STORMBYTE_FORCE_INLINE std::string Message(StormByte::System::Host::Error e)
Text for one Host enumerator.
Definition host.hxx:283
#define STORMBYTE_SYSTEM_PUBLIC
Definition visibility.h:53