nbl.h

Go to the documentation of this file.

/*
 * Copyright (c) 2025, 2026, Loongson Technology. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 */

#ifndef NBL_H
#define NBL_H

#include <dlfcn.h>
#include <elf.h>
#include <fcntl.h>
#include <signal.h>
#include <stdbool.h>
#include <stdint.h>
#include <unistd.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
  NBL_VAARGS_NONE = 0,
  NBL_VAARGS_NULL_TERMINATED = 1,
} NblVaargsPolicy;

#define NBL_MAXPATHLEN 2048

typedef struct {
  void* (*dlopen)(const char* filename, int mode);

  int (*dlclose)(void* handle);

  int (*dlinfo)(void* handle, int request, void* arg);

  char* (*dlerror)(void);

  void* (*dlsym)(void* handle, const char* name);

  void* (*dlsym_with_signature)(void* handle, const char* name, const char* nbl_signature);

  bool (*register_hostfunc)(const void* entry, const char* name, const char* nbl_signature);

  bool (*register_hostdata)(const void* address, const char* name);

  bool (*register_hostfunc_with_callback)(const void* entry, const char* name, const char* nbl_signature, const void* c_entry, const char* c_signature);

  bool (*register_hostfunc_with_callback_arg)(
      const void* entry,
      const char* name,
      const char* nbl_signature,
      const void* c_entry,
      const char* c_signature,
      int callback_arg_index);

  bool (*register_hostfunc_with_vaargs_policy)(
      const void* entry,
      const char* name,
      const char* nbl_signature,
      NblVaargsPolicy policy,
      char vaargs_type,
      bool include_terminator);

  bool (*unregister_hostfunc)(const void* entry, const char* name);

  void* (*method_stub)(const char* nbl_signature, const void* entry);

  bool (*is_tr_handle)(void* handle);

  bool (*is_tr_symbol)(const void* addr);

  bool (*is_tr_signal)(const void* addr);

  bool (*tr_signalhandler)(int sig, siginfo_t* info, ucontext_t* uc);

  const void* (*get_extension)(uint32_t extension_id);
} Nbl;

Nbl* nbl_load(int tr_mode, const char* nbl_lib_base, bool host_dispatch_signal);

void nbl_unload(Nbl* nbl);

static inline bool is_x86_64_arch(const char *filename) {
  int fd = open(filename, O_RDONLY);
  if (fd == -1) return false;

  bool ret = false;
  Elf64_Ehdr header;
  if (read(fd, &header, sizeof(header)) == sizeof(header)) {
    if (header.e_machine == EM_X86_64) ret = true;
  }

  close(fd);
  return ret;
}

void set_host_sighandle(int (*host_sig_handler)(int signo, void* siginfo, void* ucontext, int abort_if_unrecognized));
#ifdef __cplusplus
}
#endif

#endif