summaryrefslogtreecommitdiffhomepage
path: root/dev/Kernel/NetworkKit/IPC.h
diff options
context:
space:
mode:
authorAmlal <amlalelmahrouss@icloud.com>2024-12-21 21:59:13 +0100
committerAmlal <amlalelmahrouss@icloud.com>2024-12-21 21:59:45 +0100
commit610f91d87152cbe48d3054fcf437d8239da6ef35 (patch)
treea386f7047ab73d088169ab2371ddc6ffe8020f1c /dev/Kernel/NetworkKit/IPC.h
parent509fcca5986651c8ba712fb395f8498f2dea4109 (diff)
IMP: :boom: Breaking changes some checks are needed to be done.
Signed-off-by: Amlal <amlalelmahrouss@icloud.com>
Diffstat (limited to 'dev/Kernel/NetworkKit/IPC.h')
-rw-r--r--dev/Kernel/NetworkKit/IPC.h107
1 files changed, 107 insertions, 0 deletions
diff --git a/dev/Kernel/NetworkKit/IPC.h b/dev/Kernel/NetworkKit/IPC.h
new file mode 100644
index 00000000..8496282c
--- /dev/null
+++ b/dev/Kernel/NetworkKit/IPC.h
@@ -0,0 +1,107 @@
+/* -------------------------------------------
+
+ Copyright (C) 2024, TQ B.V, 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 <HintKit/CompilerHint.h>
+#include <CompressKit/API.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 Kernel
+{
+ struct IPCAddress;
+ struct IPCMessage;
+
+ /// @brief 128-bit IPC address.
+ struct PACKED IPCAddress final
+ {
+ UInt64 UserProcessID;
+ UInt64 UserProcessTeam;
+
+ ////////////////////////////////////
+ // some operators.
+ ////////////////////////////////////
+
+ bool operator==(const IPCAddress& addr) noexcept
+ {
+ return addr.UserProcessID == this->UserProcessID && addr.UserProcessTeam == this->UserProcessTeam;
+ }
+
+ bool operator==(IPCAddress& addr) noexcept
+ {
+ return addr.UserProcessID == this->UserProcessID && addr.UserProcessTeam == this->UserProcessTeam;
+ }
+ };
+
+ typedef struct IPCAddress IPCEPAddressKind;
+
+ enum
+ {
+ kIPCLittleEndian = 0,
+ kIPCBigEndian = 1,
+ kIPCMixedEndian = 2,
+ };
+
+ constexpr inline auto kIPCMsgSize = 6094U;
+
+ /// @brief IPC connection header, message cannot be greater than 6K.
+ typedef struct IPCMessage final
+ {
+ UInt32 IpcHeaderMagic; // cRemoteHeaderMagic
+ UInt8 IpcEndianess; // 0 : LE, 1 : BE
+ SizeT IpcPacketSize;
+ IPCEPAddressKind IpcFrom;
+ IPCEPAddressKind IpcTo;
+ UInt32 IpcCRC32;
+ UInt32 IpcMsg;
+ UInt32 IpcMsgSz;
+ UInt8 IpcData[kIPCMsgSize];
+
+ /// @brief Passes the message to target, could be anything, HTTP packet, JSON or whatever.
+ Bool Pass(IPCMessage* target) noexcept
+ {
+ if (target && target->IpcFrom == this->IpcTo)
+ {
+ if (this->IpcMsgSz > target->IpcMsgSz)
+ return No;
+
+ rt_copy_memory(this->IpcData, target->IpcData, this->IpcMsgSz);
+
+ return Yes;
+ }
+
+ return No;
+ }
+ } PACKED IPCMessage;
+
+ /// @brief Sanitize packet function
+ /// @retval true packet is correct.
+ /// @retval false packet is incorrect and process has crashed.
+ Bool ipc_sanitize_packet(_Input IPCMessage* 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 IPCMessage** pckt_in);
+} // namespace Kernel
+
+#endif // INC_IPC_H