syscall-napi 0.0.8 → 0.1.1

package/README.md

@@ -4,11 +4,11 @@ Node.js module to perform promise-based asynchronous syscalls
 
 ## About
 
-This module allows to execute syscalls on linux based systems. NAPI is being used to stay ABI compatible with future Node.js versions. The focus of this module is not (yet) performance, but providing a clear promise based interface to the linux kernel.
+This module allows to execute syscalls on linux based systems. NAPI is being used to stay ABI compatible with future Node.js versions. The focus of this module is not (yet) performance, but providing a clear interface to the linux kernel.
 
 ## Requirements
 
-- `Node.js >= 12` as ES6 modules are used.
+- `Node.js >= 22` as this is a native TypeScript module
 
 ## Installation
 
@@ -24,36 +24,32 @@ yarn install syscall-napi
 
 ## API
 
-### `sys.syscall(...params)` => `Promise(BigInt)`
-Execute syscall asynchronously.
+### `syscall({ syscallNumber: bigint, args: (bigint | Uint8Array)[] })` => `{ errno: undefined, ret: BigInt } | { errno: number, ret: undefined }`
 
 Supported argument types:
   - `BigInt` arguments are converted to native integers
-  - `Buffer` arguments are converted to the address of the buffer in memory. The native code holds a reference to this buffer so it will not by freed by the garbage collector while the syscall is running. During a syscall the referenced buffer instance should not be modified. Be aware that passing buffers of wrong sizes (i.e. smaller than the kernel expects) leads to undefined behaviour as it may overwrite vital data or crash the application.
+  - `Buffer` arguments are converted to the address of the buffer in memory. Be aware that passing buffers of wrong sizes (i.e. smaller than the kernel expects) leads to undefined behaviour as it may overwrite vital data or crash the application.
 
 In case of an error the promise is rejected with an error object.
 
 For params see `man 2 syscall`.
-
-### `sys.syscall.sync(...params)` => `BigInt`
-
-Same as above, but synchronous.
   
-### `sys.__NR_xxx`
-This module provides syscall numbers (e.g. `__NR_getpid`) that are defined in `uapi/asm-generic/unistd.h` in the linux kernel.
+### `syscallNumbers.{syscall}`
+This module provides syscall numbers (e.g. `getpid`) that are defined in `uapi/asm-generic/unistd.h` in the linux kernel.
 
 ## Minimal example
 
 ```javascript
-import sys from "syscall-napi";
-
-process.nextTick(async () => {
-  try {
-    const pid = await sys.syscall(sys.__NR_getpid);
-    console.log(`pid = ${pid}`);
-  } catch (ex) {
-    console.error(ex);
-    process.exitCode = -1;
-  }
+import { syscall, syscallNumbers } from "syscall-napi";
+
+const { errno, ret: pid } = syscall({
+  syscallNumber: syscallNumbers.__NR_getpid,
+  args: []
 });
+
+if (errno === undefined) {
+  console.log(`pid = ${pid}`);
+} else {
+  console.log(`errno = ${errno}`);
+}
 ```

package/lib/constants/arm.ts

@@ -0,0 +1,340 @@
+const syscallNumbers = {
+  io_setup: 243n,
+  io_destroy: 244n,
+  io_submit: 246n,
+  io_cancel: 247n,
+  io_getevents: 245n,
+  setxattr: 226n,
+  lsetxattr: 227n,
+  fsetxattr: 228n,
+  getxattr: 229n,
+  lgetxattr: 230n,
+  fgetxattr: 231n,
+  listxattr: 232n,
+  llistxattr: 233n,
+  flistxattr: 234n,
+  removexattr: 235n,
+  lremovexattr: 236n,
+  fremovexattr: 237n,
+  getcwd: 183n,
+  lookup_dcookie: 249n,
+  eventfd2: 356n,
+  epoll_create1: 357n,
+  epoll_ctl: 251n,
+  epoll_pwait: 346n,
+  dup: 41n,
+  dup3: 358n,
+  inotify_init1: 360n,
+  inotify_add_watch: 317n,
+  inotify_rm_watch: 318n,
+  ioctl: 54n,
+  ioprio_set: 314n,
+  ioprio_get: 315n,
+  flock: 143n,
+  mknodat: 324n,
+  mkdirat: 323n,
+  unlinkat: 328n,
+  symlinkat: 331n,
+  linkat: 330n,
+  renameat: 329n,
+  umount2: 52n,
+  mount: 21n,
+  pivot_root: 218n,
+  nfsservctl: 169n,
+  fallocate: 352n,
+  faccessat: 334n,
+  chdir: 12n,
+  fchdir: 133n,
+  chroot: 61n,
+  fchmod: 94n,
+  fchmodat: 333n,
+  fchownat: 325n,
+  fchown: 95n,
+  openat: 322n,
+  close: 6n,
+  vhangup: 111n,
+  pipe2: 359n,
+  quotactl: 131n,
+  getdents64: 217n,
+  read: 3n,
+  write: 4n,
+  readv: 145n,
+  writev: 146n,
+  pread64: 180n,
+  pwrite64: 181n,
+  preadv: 361n,
+  pwritev: 362n,
+  pselect6: 335n,
+  ppoll: 336n,
+  signalfd4: 355n,
+  vmsplice: 343n,
+  splice: 340n,
+  tee: 342n,
+  readlinkat: 332n,
+  sync: 36n,
+  fsync: 118n,
+  fdatasync: 148n,
+  sync_file_range2: 341n,
+  timerfd_create: 350n,
+  timerfd_settime: 353n,
+  timerfd_gettime: 354n,
+  utimensat: 348n,
+  acct: 51n,
+  capget: 184n,
+  capset: 185n,
+  personality: 136n,
+  exit: 1n,
+  exit_group: 248n,
+  waitid: 280n,
+  set_tid_address: 256n,
+  unshare: 337n,
+  futex: 240n,
+  set_robust_list: 338n,
+  get_robust_list: 339n,
+  nanosleep: 162n,
+  getitimer: 105n,
+  setitimer: 104n,
+  kexec_load: 347n,
+  init_module: 128n,
+  delete_module: 129n,
+  timer_create: 257n,
+  timer_gettime: 259n,
+  timer_getoverrun: 260n,
+  timer_settime: 258n,
+  timer_delete: 261n,
+  clock_settime: 262n,
+  clock_gettime: 263n,
+  clock_getres: 264n,
+  clock_nanosleep: 265n,
+  syslog: 103n,
+  ptrace: 26n,
+  sched_setparam: 154n,
+  sched_setscheduler: 156n,
+  sched_getscheduler: 157n,
+  sched_getparam: 155n,
+  sched_setaffinity: 241n,
+  sched_getaffinity: 242n,
+  sched_yield: 158n,
+  sched_get_priority_max: 159n,
+  sched_get_priority_min: 160n,
+  sched_rr_get_interval: 161n,
+  restart_syscall: 0n,
+  kill: 37n,
+  tkill: 238n,
+  tgkill: 268n,
+  sigaltstack: 186n,
+  rt_sigsuspend: 179n,
+  rt_sigaction: 174n,
+  rt_sigprocmask: 175n,
+  rt_sigpending: 176n,
+  rt_sigtimedwait: 177n,
+  rt_sigqueueinfo: 178n,
+  rt_sigreturn: 173n,
+  setpriority: 97n,
+  getpriority: 96n,
+  reboot: 88n,
+  setregid: 71n,
+  setgid: 46n,
+  setreuid: 70n,
+  setuid: 23n,
+  setresuid: 164n,
+  getresuid: 165n,
+  setresgid: 170n,
+  getresgid: 171n,
+  setfsuid: 138n,
+  setfsgid: 139n,
+  times: 43n,
+  setpgid: 57n,
+  getpgid: 132n,
+  getsid: 147n,
+  setsid: 66n,
+  getgroups: 80n,
+  setgroups: 81n,
+  uname: 122n,
+  sethostname: 74n,
+  setdomainname: 121n,
+  setrlimit: 75n,
+  getrusage: 77n,
+  umask: 60n,
+  prctl: 172n,
+  getcpu: 345n,
+  gettimeofday: 78n,
+  settimeofday: 79n,
+  adjtimex: 124n,
+  getpid: 20n,
+  getppid: 64n,
+  getuid: 24n,
+  geteuid: 49n,
+  getgid: 47n,
+  getegid: 50n,
+  gettid: 224n,
+  sysinfo: 116n,
+  mq_open: 274n,
+  mq_unlink: 275n,
+  mq_timedsend: 276n,
+  mq_timedreceive: 277n,
+  mq_notify: 278n,
+  mq_getsetattr: 279n,
+  msgget: 303n,
+  msgctl: 304n,
+  msgrcv: 302n,
+  msgsnd: 301n,
+  semget: 299n,
+  semctl: 300n,
+  semtimedop: 312n,
+  semop: 298n,
+  shmget: 307n,
+  shmctl: 308n,
+  shmat: 305n,
+  shmdt: 306n,
+  socket: 281n,
+  socketpair: 288n,
+  bind: 282n,
+  listen: 284n,
+  accept: 285n,
+  connect: 283n,
+  getsockname: 286n,
+  getpeername: 287n,
+  sendto: 290n,
+  recvfrom: 292n,
+  setsockopt: 294n,
+  getsockopt: 295n,
+  shutdown: 293n,
+  sendmsg: 296n,
+  recvmsg: 297n,
+  readahead: 225n,
+  brk: 45n,
+  munmap: 91n,
+  mremap: 163n,
+  add_key: 309n,
+  request_key: 310n,
+  keyctl: 311n,
+  clone: 120n,
+  execve: 11n,
+  swapon: 87n,
+  swapoff: 115n,
+  mprotect: 125n,
+  msync: 144n,
+  mlock: 150n,
+  munlock: 151n,
+  mlockall: 152n,
+  munlockall: 153n,
+  mincore: 219n,
+  madvise: 220n,
+  remap_file_pages: 253n,
+  mbind: 319n,
+  get_mempolicy: 320n,
+  set_mempolicy: 321n,
+  migrate_pages: 400n,
+  move_pages: 344n,
+  rt_tgsigqueueinfo: 363n,
+  perf_event_open: 364n,
+  accept4: 366n,
+  recvmmsg: 365n,
+  wait4: 114n,
+  prlimit64: 369n,
+  fanotify_init: 367n,
+  fanotify_mark: 368n,
+  name_to_handle_at: 370n,
+  open_by_handle_at: 371n,
+  clock_adjtime: 372n,
+  syncfs: 373n,
+  setns: 375n,
+  sendmmsg: 374n,
+  process_vm_readv: 376n,
+  process_vm_writev: 377n,
+  kcmp: 378n,
+  finit_module: 379n,
+  sched_setattr: 380n,
+  sched_getattr: 381n,
+  renameat2: 382n,
+  seccomp: 383n,
+  getrandom: 384n,
+  memfd_create: 385n,
+  bpf: 386n,
+  execveat: 387n,
+  userfaultfd: 388n,
+  membarrier: 389n,
+  mlock2: 390n,
+  copy_file_range: 391n,
+  preadv2: 392n,
+  pwritev2: 393n,
+  pkey_mprotect: 394n,
+  pkey_alloc: 395n,
+  pkey_free: 396n,
+  statx: 397n,
+  io_pgetevents: 399n,
+  rseq: 398n,
+  kexec_file_load: 401n,
+  clock_gettime64: 403n,
+  clock_settime64: 404n,
+  clock_adjtime64: 405n,
+  clock_getres_time64: 406n,
+  clock_nanosleep_time64: 407n,
+  timer_gettime64: 408n,
+  timer_settime64: 409n,
+  timerfd_gettime64: 410n,
+  timerfd_settime64: 411n,
+  utimensat_time64: 412n,
+  pselect6_time64: 413n,
+  ppoll_time64: 414n,
+  io_pgetevents_time64: 416n,
+  recvmmsg_time64: 417n,
+  mq_timedsend_time64: 418n,
+  mq_timedreceive_time64: 419n,
+  semtimedop_time64: 420n,
+  rt_sigtimedwait_time64: 421n,
+  futex_time64: 422n,
+  sched_rr_get_interval_time64: 423n,
+  pidfd_send_signal: 424n,
+  io_uring_setup: 425n,
+  io_uring_enter: 426n,
+  io_uring_register: 427n,
+  open_tree: 428n,
+  move_mount: 429n,
+  fsopen: 430n,
+  fsconfig: 431n,
+  fsmount: 432n,
+  fspick: 433n,
+  pidfd_open: 434n,
+  clone3: 435n,
+  close_range: 436n,
+  openat2: 437n,
+  pidfd_getfd: 438n,
+  faccessat2: 439n,
+  process_madvise: 440n,
+  epoll_pwait2: 441n,
+  mount_setattr: 442n,
+  quotactl_fd: 443n,
+  landlock_create_ruleset: 444n,
+  landlock_add_rule: 445n,
+  landlock_restrict_self: 446n,
+  process_mrelease: 448n,
+  futex_waitv: 449n,
+  set_mempolicy_home_node: 450n,
+  fcntl: 55n,
+  statfs: 99n,
+  fstatfs: 100n,
+  truncate: 92n,
+  ftruncate: 93n,
+  lseek: 19n,
+  sendfile: 187n,
+  fstat: 108n,
+  stat: 106n,
+  lstat: 107n,
+  fcntl64: 221n,
+  statfs64: 266n,
+  fstatfs64: 267n,
+  truncate64: 193n,
+  ftruncate64: 194n,
+  sendfile64: 239n,
+  fstatat64: 327n,
+  fstat64: 197n,
+  mmap2: 192n,
+  stat64: 195n,
+  lstat64: 196n,
+};
+
+export {
+  syscallNumbers
+};

package/lib/constants/arm64.ts

@@ -0,0 +1,314 @@
+const syscallNumbers = {
+  io_setup: 0n,
+  io_destroy: 1n,
+  io_submit: 2n,
+  io_cancel: 3n,
+  io_getevents: 4n,
+  setxattr: 5n,
+  lsetxattr: 6n,
+  fsetxattr: 7n,
+  getxattr: 8n,
+  lgetxattr: 9n,
+  fgetxattr: 10n,
+  listxattr: 11n,
+  llistxattr: 12n,
+  flistxattr: 13n,
+  removexattr: 14n,
+  lremovexattr: 15n,
+  fremovexattr: 16n,
+  getcwd: 17n,
+  lookup_dcookie: 18n,
+  eventfd2: 19n,
+  epoll_create1: 20n,
+  epoll_ctl: 21n,
+  epoll_pwait: 22n,
+  dup: 23n,
+  dup3: 24n,
+  inotify_init1: 26n,
+  inotify_add_watch: 27n,
+  inotify_rm_watch: 28n,
+  ioctl: 29n,
+  ioprio_set: 30n,
+  ioprio_get: 31n,
+  flock: 32n,
+  mknodat: 33n,
+  mkdirat: 34n,
+  unlinkat: 35n,
+  symlinkat: 36n,
+  linkat: 37n,
+  renameat: 38n,
+  umount2: 39n,
+  mount: 40n,
+  pivot_root: 41n,
+  nfsservctl: 42n,
+  fallocate: 47n,
+  faccessat: 48n,
+  chdir: 49n,
+  fchdir: 50n,
+  chroot: 51n,
+  fchmod: 52n,
+  fchmodat: 53n,
+  fchownat: 54n,
+  fchown: 55n,
+  openat: 56n,
+  close: 57n,
+  vhangup: 58n,
+  pipe2: 59n,
+  quotactl: 60n,
+  getdents64: 61n,
+  read: 63n,
+  write: 64n,
+  readv: 65n,
+  writev: 66n,
+  pread64: 67n,
+  pwrite64: 68n,
+  preadv: 69n,
+  pwritev: 70n,
+  pselect6: 72n,
+  ppoll: 73n,
+  signalfd4: 74n,
+  vmsplice: 75n,
+  splice: 76n,
+  tee: 77n,
+  readlinkat: 78n,
+  sync: 81n,
+  fsync: 82n,
+  fdatasync: 83n,
+  sync_file_range: 84n,
+  timerfd_create: 85n,
+  timerfd_settime: 86n,
+  timerfd_gettime: 87n,
+  utimensat: 88n,
+  acct: 89n,
+  capget: 90n,
+  capset: 91n,
+  personality: 92n,
+  exit: 93n,
+  exit_group: 94n,
+  waitid: 95n,
+  set_tid_address: 96n,
+  unshare: 97n,
+  futex: 98n,
+  set_robust_list: 99n,
+  get_robust_list: 100n,
+  nanosleep: 101n,
+  getitimer: 102n,
+  setitimer: 103n,
+  kexec_load: 104n,
+  init_module: 105n,
+  delete_module: 106n,
+  timer_create: 107n,
+  timer_gettime: 108n,
+  timer_getoverrun: 109n,
+  timer_settime: 110n,
+  timer_delete: 111n,
+  clock_settime: 112n,
+  clock_gettime: 113n,
+  clock_getres: 114n,
+  clock_nanosleep: 115n,
+  syslog: 116n,
+  ptrace: 117n,
+  sched_setparam: 118n,
+  sched_setscheduler: 119n,
+  sched_getscheduler: 120n,
+  sched_getparam: 121n,
+  sched_setaffinity: 122n,
+  sched_getaffinity: 123n,
+  sched_yield: 124n,
+  sched_get_priority_max: 125n,
+  sched_get_priority_min: 126n,
+  sched_rr_get_interval: 127n,
+  restart_syscall: 128n,
+  kill: 129n,
+  tkill: 130n,
+  tgkill: 131n,
+  sigaltstack: 132n,
+  rt_sigsuspend: 133n,
+  rt_sigaction: 134n,
+  rt_sigprocmask: 135n,
+  rt_sigpending: 136n,
+  rt_sigtimedwait: 137n,
+  rt_sigqueueinfo: 138n,
+  rt_sigreturn: 139n,
+  setpriority: 140n,
+  getpriority: 141n,
+  reboot: 142n,
+  setregid: 143n,
+  setgid: 144n,
+  setreuid: 145n,
+  setuid: 146n,
+  setresuid: 147n,
+  getresuid: 148n,
+  setresgid: 149n,
+  getresgid: 150n,
+  setfsuid: 151n,
+  setfsgid: 152n,
+  times: 153n,
+  setpgid: 154n,
+  getpgid: 155n,
+  getsid: 156n,
+  setsid: 157n,
+  getgroups: 158n,
+  setgroups: 159n,
+  uname: 160n,
+  sethostname: 161n,
+  setdomainname: 162n,
+  getrlimit: 163n,
+  setrlimit: 164n,
+  getrusage: 165n,
+  umask: 166n,
+  prctl: 167n,
+  getcpu: 168n,
+  gettimeofday: 169n,
+  settimeofday: 170n,
+  adjtimex: 171n,
+  getpid: 172n,
+  getppid: 173n,
+  getuid: 174n,
+  geteuid: 175n,
+  getgid: 176n,
+  getegid: 177n,
+  gettid: 178n,
+  sysinfo: 179n,
+  mq_open: 180n,
+  mq_unlink: 181n,
+  mq_timedsend: 182n,
+  mq_timedreceive: 183n,
+  mq_notify: 184n,
+  mq_getsetattr: 185n,
+  msgget: 186n,
+  msgctl: 187n,
+  msgrcv: 188n,
+  msgsnd: 189n,
+  semget: 190n,
+  semctl: 191n,
+  semtimedop: 192n,
+  semop: 193n,
+  shmget: 194n,
+  shmctl: 195n,
+  shmat: 196n,
+  shmdt: 197n,
+  socket: 198n,
+  socketpair: 199n,
+  bind: 200n,
+  listen: 201n,
+  accept: 202n,
+  connect: 203n,
+  getsockname: 204n,
+  getpeername: 205n,
+  sendto: 206n,
+  recvfrom: 207n,
+  setsockopt: 208n,
+  getsockopt: 209n,
+  shutdown: 210n,
+  sendmsg: 211n,
+  recvmsg: 212n,
+  readahead: 213n,
+  brk: 214n,
+  munmap: 215n,
+  mremap: 216n,
+  add_key: 217n,
+  request_key: 218n,
+  keyctl: 219n,
+  clone: 220n,
+  execve: 221n,
+  swapon: 224n,
+  swapoff: 225n,
+  mprotect: 226n,
+  msync: 227n,
+  mlock: 228n,
+  munlock: 229n,
+  mlockall: 230n,
+  munlockall: 231n,
+  mincore: 232n,
+  madvise: 233n,
+  remap_file_pages: 234n,
+  mbind: 235n,
+  get_mempolicy: 236n,
+  set_mempolicy: 237n,
+  migrate_pages: 238n,
+  move_pages: 239n,
+  rt_tgsigqueueinfo: 240n,
+  perf_event_open: 241n,
+  accept4: 242n,
+  recvmmsg: 243n,
+  arch_specific_syscall: 244n,
+  wait4: 260n,
+  prlimit64: 261n,
+  fanotify_init: 262n,
+  fanotify_mark: 263n,
+  name_to_handle_at: 264n,
+  open_by_handle_at: 265n,
+  clock_adjtime: 266n,
+  syncfs: 267n,
+  setns: 268n,
+  sendmmsg: 269n,
+  process_vm_readv: 270n,
+  process_vm_writev: 271n,
+  kcmp: 272n,
+  finit_module: 273n,
+  sched_setattr: 274n,
+  sched_getattr: 275n,
+  renameat2: 276n,
+  seccomp: 277n,
+  getrandom: 278n,
+  memfd_create: 279n,
+  bpf: 280n,
+  execveat: 281n,
+  userfaultfd: 282n,
+  membarrier: 283n,
+  mlock2: 284n,
+  copy_file_range: 285n,
+  preadv2: 286n,
+  pwritev2: 287n,
+  pkey_mprotect: 288n,
+  pkey_alloc: 289n,
+  pkey_free: 290n,
+  statx: 291n,
+  io_pgetevents: 292n,
+  rseq: 293n,
+  kexec_file_load: 294n,
+  pidfd_send_signal: 424n,
+  io_uring_setup: 425n,
+  io_uring_enter: 426n,
+  io_uring_register: 427n,
+  open_tree: 428n,
+  move_mount: 429n,
+  fsopen: 430n,
+  fsconfig: 431n,
+  fsmount: 432n,
+  fspick: 433n,
+  pidfd_open: 434n,
+  clone3: 435n,
+  close_range: 436n,
+  openat2: 437n,
+  pidfd_getfd: 438n,
+  faccessat2: 439n,
+  process_madvise: 440n,
+  epoll_pwait2: 441n,
+  mount_setattr: 442n,
+  quotactl_fd: 443n,
+  landlock_create_ruleset: 444n,
+  landlock_add_rule: 445n,
+  landlock_restrict_self: 446n,
+  memfd_secret: 447n,
+  process_mrelease: 448n,
+  futex_waitv: 449n,
+  set_mempolicy_home_node: 450n,
+  syscalls: 451n,
+  fcntl: 25n,
+  statfs: 43n,
+  fstatfs: 44n,
+  truncate: 45n,
+  ftruncate: 46n,
+  lseek: 62n,
+  sendfile: 71n,
+  newfstatat: 79n,
+  fstat: 80n,
+  mmap: 222n,
+  fadvise64: 223n,
+};
+
+export {
+  syscallNumbers
+};