summaryrefslogtreecommitdiffhomepage
path: root/dev/kernel/NetworkKit
diff options
context:
space:
mode:
Diffstat (limited to 'dev/kernel/NetworkKit')
-rw-r--r--dev/kernel/NetworkKit/IP.h83
-rw-r--r--dev/kernel/NetworkKit/IPC.h91
-rw-r--r--dev/kernel/NetworkKit/LTE.h16
-rw-r--r--dev/kernel/NetworkKit/MAC.h36
-rw-r--r--dev/kernel/NetworkKit/NetworkDevice.h83
-rw-r--r--dev/kernel/NetworkKit/NetworkDevice.inl32
6 files changed, 341 insertions, 0 deletions
diff --git a/dev/kernel/NetworkKit/IP.h b/dev/kernel/NetworkKit/IP.h
new file mode 100644
index 00000000..4a552d87
--- /dev/null
+++ b/dev/kernel/NetworkKit/IP.h
@@ -0,0 +1,83 @@
+/* -------------------------------------------
+
+ Copyright (C) 2024-2025, Amlal EL Mahrouss, all rights reserved.
+
+------------------------------------------- */
+
+#pragma once
+
+#include <KernelKit/DebugOutput.h>
+#include <NewKit/Defines.h>
+#include <NewKit/Ref.h>
+#include <NewKit/KString.h>
+
+namespace NeOS
+{
+ class RawIPAddress6;
+ class RawIPAddress;
+ class IPFactory;
+
+ class RawIPAddress final
+ {
+ private:
+ explicit RawIPAddress(char bytes[4]);
+ ~RawIPAddress() = default;
+
+ RawIPAddress& operator=(const RawIPAddress&) = delete;
+ RawIPAddress(const RawIPAddress&) = default;
+
+ public:
+ Char* Address();
+
+ Char& operator[](const Size& index);
+
+ BOOL operator==(const RawIPAddress& ipv6);
+ BOOL operator!=(const RawIPAddress& ipv6);
+
+ private:
+ Char fAddr[4];
+
+ friend IPFactory; // it is the one creating these addresses, thus this
+ // is why the constructors are private.
+ };
+
+ /**
+ * @brief IPv6 address.
+ */
+ class RawIPAddress6 final
+ {
+ private:
+ explicit RawIPAddress6(char Bytes[8]);
+ ~RawIPAddress6() = default;
+
+ RawIPAddress6& operator=(const RawIPAddress6&) = delete;
+ RawIPAddress6(const RawIPAddress6&) = default;
+
+ public:
+ char* Address()
+ {
+ return fAddr;
+ }
+
+ char& operator[](const Size& index);
+
+ bool operator==(const RawIPAddress6& ipv6);
+ bool operator!=(const RawIPAddress6& ipv6);
+
+ private:
+ char fAddr[8];
+
+ friend IPFactory;
+ };
+
+ /**
+ * @brief IP Creation helpers
+ */
+ class IPFactory final
+ {
+ public:
+ static ErrorOr<KString> ToKString(Ref<RawIPAddress6>& ipv6);
+ static ErrorOr<KString> ToKString(Ref<RawIPAddress>& ipv4);
+ static bool IpCheckVersion4(const Char* ip);
+ };
+} // namespace NeOS
diff --git a/dev/kernel/NetworkKit/IPC.h b/dev/kernel/NetworkKit/IPC.h
new file mode 100644
index 00000000..e8f0898f
--- /dev/null
+++ b/dev/kernel/NetworkKit/IPC.h
@@ -0,0 +1,91 @@
+/* -------------------------------------------
+
+ Copyright (C) 2024-2025, Amlal EL Mahrouss, all rights reserved..
+
+ File: IPC.h.
+ Purpose: IPC protocol.
+
+------------------------------------------- */
+
+#ifndef INC_IPC_H
+#define INC_IPC_H
+
+#include <NewKit/Defines.h>
+#include <NewKit/KString.h>
+#include <HintsKit/CompilerHint.h>
+
+/// @file IPC.h
+/// @brief IPC comm. protocol.
+
+/// IA separator.
+#define kIPCRemoteSeparator ":"
+
+/// Interchange address, consists of PID:TEAM.
+#define kIPCRemoteInvalid "00:00"
+
+#define kIPCHeaderMagic (0x4950434)
+
+namespace NeOS
+{
+ struct IPC_ADDR;
+ struct IPC_MSG;
+
+ /// @brief 128-bit IPC address.
+ struct PACKED IPC_ADDR final
+ {
+ UInt64 UserProcessID;
+ UInt64 UserProcessTeam;
+
+ ////////////////////////////////////
+ // some operators.
+ ////////////////////////////////////
+
+ bool operator==(const IPC_ADDR& addr) noexcept;
+
+ bool operator==(IPC_ADDR& addr) noexcept;
+
+ bool operator!=(const IPC_ADDR& addr) noexcept;
+
+ bool operator!=(IPC_ADDR& addr) noexcept;
+ };
+
+ typedef struct IPC_ADDR IPC_ADDR;
+
+ enum
+ {
+ kIPCLittleEndian = 0,
+ kIPCBigEndian = 1,
+ kIPCMixedEndian = 2,
+ };
+
+ constexpr inline auto kIPCMsgSize = 6094U;
+
+ /// @brief IPC connection header, message cannot be greater than 6K.
+ typedef struct IPC_MSG final
+ {
+ UInt32 IpcHeaderMagic; // cRemoteHeaderMagic
+ UInt8 IpcEndianess; // 0 : LE, 1 : BE
+ SizeT IpcPacketSize;
+ IPC_ADDR IpcFrom;
+ IPC_ADDR IpcTo;
+ UInt32 IpcCRC32;
+ UInt32 IpcMsg;
+ UInt32 IpcMsgSz;
+ UInt8 IpcData[kIPCMsgSize];
+
+ /// @brief Passes the message to target, could be anything, HTTP packet, JSON or whatever.
+ static Bool Pass(IPC_MSG* self, IPC_MSG* target) noexcept;
+ } PACKED IPC_MSG;
+
+ /// @brief Sanitize packet function
+ /// @retval true packet is correct.
+ /// @retval false packet is incorrect and process has crashed.
+ Bool ipc_sanitize_packet(_Input IPC_MSG* pckt_in);
+
+ /// @brief Construct packet function
+ /// @retval true packet is correct.
+ /// @retval false packet is incorrect and process has crashed.
+ Bool ipc_construct_packet(_Output _Input IPC_MSG** pckt_in);
+} // namespace NeOS
+
+#endif // INC_IPC_H
diff --git a/dev/kernel/NetworkKit/LTE.h b/dev/kernel/NetworkKit/LTE.h
new file mode 100644
index 00000000..e0a0ff64
--- /dev/null
+++ b/dev/kernel/NetworkKit/LTE.h
@@ -0,0 +1,16 @@
+/* -------------------------------------------
+
+ Copyright (C) 2024-2025, Amlal EL Mahrouss, all rights reserved..
+
+ File: LTE.h.
+ Purpose: LTE protocol classes.
+
+------------------------------------------- */
+
+#ifndef _INC_NETWORK_LTE_H_
+#define _INC_NETWORK_LTE_H_
+
+#include <NewKit/Defines.h>
+#include <NewKit/KString.h>
+
+#endif // ifndef _INC_NETWORK_LTE_H_
diff --git a/dev/kernel/NetworkKit/MAC.h b/dev/kernel/NetworkKit/MAC.h
new file mode 100644
index 00000000..f7283708
--- /dev/null
+++ b/dev/kernel/NetworkKit/MAC.h
@@ -0,0 +1,36 @@
+/* -------------------------------------------
+
+ Copyright (C) 2024-2025, Amlal EL Mahrouss, all rights reserved.
+
+------------------------------------------- */
+
+#pragma once
+
+#include <NewKit/Array.h>
+#include <NewKit/Defines.h>
+#include <NewKit/KString.h>
+
+#define kMACAddrLen (12)
+
+namespace NeOS
+{
+ class MacAddressGetter;
+
+ /// \brief This retrieves the MAC address of the device.
+ /// \note Listens for the current NIC.
+ class MacAddressGetter final
+ {
+ public:
+ MacAddressGetter() = default;
+ ~MacAddressGetter() = default;
+
+ NE_COPY_DEFAULT(MacAddressGetter);
+
+ public:
+ Array<WideChar, kMACAddrLen>& AsBytes();
+
+ private:
+ Array<WideChar, kMACAddrLen> fMacAddress;
+ };
+
+} // namespace NeOS
diff --git a/dev/kernel/NetworkKit/NetworkDevice.h b/dev/kernel/NetworkKit/NetworkDevice.h
new file mode 100644
index 00000000..c95573f3
--- /dev/null
+++ b/dev/kernel/NetworkKit/NetworkDevice.h
@@ -0,0 +1,83 @@
+/* -------------------------------------------
+
+ Copyright (C) 2024-2025, Amlal EL Mahrouss, all rights reserved.
+
+------------------------------------------- */
+
+#ifndef __INC_NETWORK_DEVICE_H__
+#define __INC_NETWORK_DEVICE_H__
+
+#include <KernelKit/DeviceMgr.h>
+#include <NetworkKit/IP.h>
+
+/// @note Can either work with: Ethernet, GPRS, WiFi
+
+namespace NeOS
+{
+ struct NetworkDeviceCommand;
+ class NetworkDevice;
+
+ /**
+ * \brief Network device interface, establishes a connection to the NIC.
+ */
+ class NetworkDevice final : public IDeviceObject<NetworkDeviceCommand>
+ {
+ public:
+ NetworkDevice(void (*out)(IDeviceObject<NetworkDeviceCommand>*, NetworkDeviceCommand),
+ void (*in)(IDeviceObject<NetworkDeviceCommand>*, NetworkDeviceCommand),
+ void (*onCleanup)(void) = nullptr);
+
+ ~NetworkDevice() override;
+
+ public:
+ NetworkDevice& operator=(const NetworkDevice&) = default;
+ NetworkDevice(const NetworkDevice&) = default;
+
+ public:
+ const Char* Name() const override;
+ Boolean Name(const Char* newStr);
+
+ private:
+ static constexpr auto cNetworkNameLen = 512;
+
+ Void (*fCleanup)(void);
+ Char fNetworkName[cNetworkNameLen];
+ };
+
+ struct NetworkDeviceCommand final
+ {
+ UInt32 CommandName;
+ UInt32 CommandType;
+ UInt32 CommandFlags;
+ VoidPtr CommandBuffer;
+ SizeT CommandSizeBuffer;
+ };
+
+ /// @brief TCP device.
+ using TCPNetworkDevice = NetworkDevice;
+
+ /// @brief UDP device.
+ using UDPNetworkDevice = NetworkDevice;
+
+ /// @brief PPP device.
+ using PPPNetworkDevice = NetworkDevice;
+
+ /// @brief IPC device.
+ using IPCNetworkDevice = NetworkDevice;
+
+ /// @brief GRPS device.
+ using GPRSNetworkDevice = NetworkDevice;
+
+ /// @brief GSM device.
+ using GSMNetworkDevice = NetworkDevice;
+
+ /// @brief Bluetooth device.
+ using BTNetworkDevice = NetworkDevice;
+
+ /// @brief LTE device.
+ using LTENetworkDevice = NetworkDevice;
+} // namespace NeOS
+
+#include <NetworkKit/NetworkDevice.inl>
+
+#endif // !__INC_NETWORK_DEVICE_H__
diff --git a/dev/kernel/NetworkKit/NetworkDevice.inl b/dev/kernel/NetworkKit/NetworkDevice.inl
new file mode 100644
index 00000000..dceae66e
--- /dev/null
+++ b/dev/kernel/NetworkKit/NetworkDevice.inl
@@ -0,0 +1,32 @@
+/* -------------------------------------------
+
+ Copyright (C) 2024-2025, Amlal EL Mahrouss, all rights reserved.
+
+------------------------------------------- */
+
+/***
+ Dtor and ctors.
+*/
+
+namespace NeOS
+{
+ NetworkDevice::NetworkDevice(void (*out)(IDeviceObject<NetworkDeviceCommand>*, NetworkDeviceCommand),
+ void (*in)(IDeviceObject<NetworkDeviceCommand>*, NetworkDeviceCommand),
+ void (*on_cleanup)(void))
+ : IDeviceObject<NetworkDeviceCommand>(out, in), fCleanup(on_cleanup)
+ {
+ kout << "NetworkDevice initialized.\r";
+
+ MUST_PASS(out && in && on_cleanup);
+ }
+
+ NetworkDevice::~NetworkDevice()
+ {
+ MUST_PASS(fCleanup);
+
+ kout << "NetworkDevice cleanup.\r";
+
+ if (fCleanup)
+ fCleanup();
+ }
+} // namespace NeOS