[IMP] Add ipc_construct_packet function to IPC protocol implementation.

[IMP] Update Endian enum to match the one from the IPC protocol.
[IMP] MUST_PASS works in debug only now.

Signed-off-by: Amlal El Mahrouss <amlal.elmahrouss@icloud.com>

5 files changed, 72 insertions, 12 deletions

diff --git a/dev/ZKA/Modules/CoreCG/WindowRenderer.hxx b/dev/ZKA/Modules/CoreCG/WindowRenderer.hxx
index 1a7d1660..580e2197 100644
--- a/dev/ZKA/Modules/CoreCG/WindowRenderer.hxx
+++ b/dev/ZKA/Modules/CoreCG/WindowRenderer.hxx
@@ -34,6 +34,8 @@ namespace CG
 
 	struct UI_WINDOW_STRUCT final
 	{
+		static constexpr auto cChildElementCount = 255;
+
 		Char					 w_window_name[255]{0};
 		Char					 w_class_name[255]{0};
 		Int32					 w_type{0};
@@ -43,7 +45,7 @@ namespace CG
 		Int32					 w_w{0};
 		Int32					 w_h{0};
 		Size					 w_child_count{0};
-		struct UI_WINDOW_STRUCT* w_child_elements[255]{0};
+		struct UI_WINDOW_STRUCT* w_child_elements[cChildElementCount]{0};
 		struct UI_WINDOW_STRUCT* w_parent{nullptr};
 		UInt32*					 display_ptr{nullptr};
 		Bool					 w_needs_repaint{false};
diff --git a/dev/ZKA/NetworkKit/IPC.hxx b/dev/ZKA/NetworkKit/IPC.hxx
index eb62f433..069a2c66 100644
--- a/dev/ZKA/NetworkKit/IPC.hxx
+++ b/dev/ZKA/NetworkKit/IPC.hxx
@@ -12,22 +12,25 @@
 
 #include <NewKit/Defines.hxx>
 #include <NewKit/String.hxx>
-
+#include <HintKit/CompilerHint.hxx>
 #include <CompressKit/RLE.hxx>
 
 /// @file IPC.hxx
-/// @brief IPC protocol.
+/// @brief IPC EP protocol.
 
 /// IA separator.
-#define cRemoteSeparator "."
+#define cIPCEPRemoteSeparator ":"
 
 /// Interchange address, consists of PID:TEAM.
-#define cRemoteInvalid "00:00"
+#define cIPCEPRemoteInvalid "00:00"
 
-#define cRemoteHeaderMagic (0x4950434)
+#define cIPCEPHeaderMagic (0x4950434)
 
 namespace Kernel
 {
+	struct IPC_ADDRESS_STRUCT;
+	struct IPC_MESSAGE_STRUCT;
+
 	/// @brief 128-bit IPC address.
 	struct PACKED IPC_ADDRESS_STRUCT final
 	{
@@ -54,7 +57,8 @@ namespace Kernel
 	enum
 	{
 		eIPCEPLittleEndian = 0,
-		eIPCEPBigEndian	   = 1
+		eIPCEPBigEndian	   = 1,
+		eIPCEPMixedEndian = 2,
 	};
 
 	constexpr auto cIPCEPMsgSize = 6094U;
@@ -76,7 +80,12 @@ namespace Kernel
 	/// @brief Sanitize packet function
 	/// @retval true packet is correct.
 	/// @retval false packet is incorrect and process has crashed.
-	Bool ipc_sanitize_packet(IPC_MESSAGE_STRUCT* pckt);
+	Bool ipc_sanitize_packet(_Input IPC_MESSAGE_STRUCT* 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 IPC_MESSAGE_STRUCT** pckt_in);
 } // namespace Kernel
 
 #endif // _INC_IPC_ENDPOINT_HXX_
diff --git a/dev/ZKA/NewKit/Defines.hxx b/dev/ZKA/NewKit/Defines.hxx
index 47381368..c83ec782 100644
--- a/dev/ZKA/NewKit/Defines.hxx
+++ b/dev/ZKA/NewKit/Defines.hxx
@@ -74,10 +74,11 @@ namespace Kernel
 
 	using Lba = UInt64;
 
-	enum class Endian : UChar
+	enum class Endian : UInt8
 	{
-		kEndianLittle,
+		kEndianInvalid,
 		kEndianBig,
+		kEndianLittle,
 		kEndianMixed,
 		kCount
 	};
diff --git a/dev/ZKA/NewKit/KernelCheck.hxx b/dev/ZKA/NewKit/KernelCheck.hxx
index 30f66ee5..58a76acb 100644
--- a/dev/ZKA/NewKit/KernelCheck.hxx
+++ b/dev/ZKA/NewKit/KernelCheck.hxx
@@ -15,10 +15,17 @@ namespace Kernel
 }
 
 #define MUST_PASS_COMPILER(EXPR, MSG) static_assert(EXPR, MSG)
+
 #define __MUST_PASS(EXPR, FILE, LINE) \
 	Kernel::ke_runtime_check(EXPR, FILE, STRINGIFY(LINE))
+
+#ifdef __DEBUG__
 #define MUST_PASS(EXPR) __MUST_PASS(EXPR, __FILE__, __LINE__)
 #define assert(EXPR)	MUST_PASS(EXPR, RUNTIME_CHECK_EXPRESSION)
+#else
+#define MUST_PASS(EXPR) (Kernel::Void)(EXPR)
+#define assert(EXPR)	(Kernel::Void)(EXPR)
+#endif
 
 enum RUNTIME_CHECK
 {
diff --git a/dev/ZKA/Sources/Network/IPC.cxx b/dev/ZKA/Sources/Network/IPC.cxx
index 926224d9..2ec50892 100644
--- a/dev/ZKA/Sources/Network/IPC.cxx
+++ b/dev/ZKA/Sources/Network/IPC.cxx
@@ -30,8 +30,12 @@ Bool ipc_int_sanitize_packet(IPC_MESSAGE_STRUCT* pckt)
 
 		break;
 	}
-	case Endian::kEndianMixed:
+	case Endian::kEndianMixed: {
+		if (pckt->IpcEndianess == eIPCEPMixedEndian)
+			goto ipc_check_failed;
+
 		break;
+	}
 	default:
 		goto ipc_check_failed;
 	}
@@ -42,7 +46,7 @@ Bool ipc_int_sanitize_packet(IPC_MESSAGE_STRUCT* pckt)
 		goto ipc_check_failed;
 	}
 
-	return pckt->IpcPacketSize > 1 && pckt->IpcHeaderMagic == cRemoteHeaderMagic;
+	return pckt->IpcPacketSize > 1 && pckt->IpcHeaderMagic == cIPCEPHeaderMagic;
 
 ipc_check_failed:
 	ErrLocal() = kErrorIPC;
@@ -65,4 +69,41 @@ namespace Kernel
 
 		return true;
 	}
+
+	/// @brief Construct packet function
+	/// @retval true packet is correct.
+	/// @retval false packet is incorrect and process has crashed.
+	Bool ipc_construct_packet(_Output IPC_MESSAGE_STRUCT** pckt_in)
+	{
+		// don't do anything if it's valid already.
+		if (*pckt_in)
+			return true;
+
+		// crash process if the packet pointer of pointer is NULL.
+		if (!pckt_in)
+		{
+			ProcessScheduler::The().Leak().TheCurrent().Leak().Crash();
+			return false;
+		}
+
+		*pckt_in = new IPC_MESSAGE_STRUCT();
+
+		MUST_PASS((*pckt_in));
+
+		if (*pckt_in)
+		{
+			(*pckt_in)->IpcHeaderMagic = cIPCEPHeaderMagic;
+
+			auto endian = DEDUCE_ENDIAN((*pckt_in), ((Char*)(*pckt_in))[0]);
+
+			(*pckt_in)->IpcEndianess		= static_cast<UInt8>(endian);
+			(*pckt_in)->IpcPacketSize		= sizeof(IPC_MESSAGE_STRUCT);
+			(*pckt_in)->IpcFrom.ProcessID	= Kernel::ProcessScheduler::The().Leak().TheCurrent().Leak().ProcessId;
+			(*pckt_in)->IpcFrom.ProcessTeam = Kernel::ProcessScheduler::The().Leak().CurrentTeam().mTeamId;
+			return true;
+		}
+
+		ProcessScheduler::The().Leak().TheCurrent().Leak().Crash();
+		return false;
+	}
 } // namespace Kernel