IPC.h

Go to the documentation of this file.

/* ========================================
 
  Copyright (C) 2024-2025, Amlal El Mahrouss, licensed under the Apache 2.0 license..
 
  File: IPC.h.
  Purpose: IPC protocol.
 
======================================== */
 
#ifndef INC_IPC_H
#define INC_IPC_H
 
#include <NeKit/Config.h>
#include <NeKit/KString.h>
#include <hint/CompilerHint.h>


#define kIPCRemoteSeparator ":"

#define kIPCRemoteInvalid "00:00"
 
#define kIPCHeaderMagic (0x4950434)
 
namespace Kernel {
struct IPC_ADDR;
struct IPC_MSG;

struct PACKED IPC_ADDR final {
  UInt64 UserProcessID;
  UInt64 UserProcessTeam;

  // some operators.
 
  BOOL operator==(const IPC_ADDR& addr);
  BOOL operator==(IPC_ADDR& addr);
  BOOL operator!=(const IPC_ADDR& addr);
  BOOL operator!=(IPC_ADDR& addr);
};
 
typedef struct IPC_ADDR IPC_ADDR;
 
enum {
  kIPCLittleEndian = 0,
  kIPCBigEndian    = 1,
  kIPCMixedEndian  = 2,
};
 
constexpr inline auto kIPCMsgSize = 6094U;
 
enum {
  kIPCLockInvalid = 0,
  kIPCLockFree    = 1,
  kIPCLockUsed    = 2,
};

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];
  UInt32   IpcLock;
  static Bool Pass(IPC_MSG* self, IPC_MSG* target);
} PACKED ALIGN(8) IPC_MSG;

BOOL ipc_sanitize_packet(_Input IPC_MSG* pckt_in);

BOOL ipc_construct_packet(_Output _Input IPC_MSG** pckt_in);
}  // namespace Kernel
 
#endif  // INC_IPC_H