HIXL Data Structures

struct MemDesc {
  uintptr_t addr;
  size_t len;
  uint8_t reserved[128] = {};
}

using MemHandle = void *;

enum MemType {
  MEM_DEVICE,
  MEM_HOST
}

enum class AsyncConnectStatus {
  NOT_CONNECT,        // not connected
  CONNECT_PENDING,    // link establishment to be executed
  CONNECTING,         // link establishment in progress
  CONNECTED,          // link established successfully
  CONNECT_FAILED,     // link establishment failed
  DISCONNECT_PENDING, // disconnection to be executed
  DISCONNECTING       // disconnection in progress
};

enum TransferOp {
  READ,
  WRITE
}

struct TransferOpDesc {
  uintptr_t local_addr;
  uintptr_t remote_addr;
  size_t len;
}

struct TransferArgs {
  const void *user_data = nullptr;  // user-defined information, which must be used together with the API for obtaining the status of all asynchronous transmission requests.
  uint8_t reserved[120] = {};  // reserved parameter
};

using TransferReq = void *;

enum class TransferStatus {
  WAITING,
  COMPLETED,
  TIMEOUT, // Not supported currently
  FAILED
};

struct GetTransferStatusArgs {
  uint32_t max_query_count = UINT32_MAX;  // Maximum number of transmission request statuses that can be queried.
  bool skip_waiting = false;  // Query whether to skip the transmission requests in the TransferStatus::WAITING state.
  uint8_t reserved[123] = {};  // Reserved parameter
};

struct TransferResult {
  TransferReq req = nullptr;  // Handle of the transmission request
  const void *user_data = nullptr;  // User-defined information
  TransferStatus status = TransferStatus::WAITING;  // Transmission request status
  uint8_t reserved[108] = {};  // Reserved parameter
};

struct NotifyDesc {
  AscendString name;
  AscendString notify_msg;
}

enum FeatureType : int32_t {
  AUTO_CONNECT = 0,
  CLIENT_SERVER_COMM = 1,
}

constexpr int32_t FEATURE_SUPPORTED = 1;
constexpr int32_t FEATURE_NOT_SUPPORTED = 0;