syscall-napi 0.1.2 → 0.1.4

package/README.md

@@ -6,9 +6,11 @@ Node.js module to perform promise-based asynchronous syscalls
 
 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.
 
+Previously this module supported asynchronous operation, which turned out not to work as expected. Although it would be possible, currently this is not supported anymore. If you need to execute long running syscalls in parallel, use Workers.
+
 ## Requirements
 
-- `Node.js >= 22` as this is a native TypeScript module
+- `Node.js >= 20`, might work on older
 
 ## Installation
 
@@ -24,7 +26,8 @@ yarn install syscall-napi
 
 ## API
 
-### `syscall({ syscallNumber: bigint, args: (bigint | Uint8Array)[] })` => `{ errno: undefined, ret: BigInt } | { errno: number, ret: undefined }`
+`syscall({ syscallNumber: bigint, args: (bigint | Uint8Array)[] })`
+ => `{ errno: undefined, ret: BigInt } | { errno: number, ret: undefined }`
 
 Supported argument types:
   - `BigInt` arguments are converted to native integers
@@ -33,7 +36,7 @@ Supported argument types:
 In case of an error the promise is rejected with an error object.
 
 For params see `man 2 syscall`.
-  
+
 ### `syscallNumbers.{syscall}`
 This module provides syscall numbers (e.g. `getpid`) that are defined in `uapi/asm-generic/unistd.h` in the linux kernel.
 
@@ -43,7 +46,7 @@ This module provides syscall numbers (e.g. `getpid`) that are defined in `uapi/a
 import { syscall, syscallNumbers } from "syscall-napi";
 
 const { errno, ret: pid } = syscall({
-  syscallNumber: syscallNumbers.__NR_getpid,
+  syscallNumber: syscallNumbers.getpid,
   args: []
 });
 
@@ -52,4 +55,5 @@ if (errno === undefined) {
 } else {
   console.log(`errno = ${errno}`);
 }
+
 ```

package/dist/lib/constants/arm.d.ts

@@ -0,0 +1,337 @@
+declare const syscallNumbers: {
+    io_setup: bigint;
+    io_destroy: bigint;
+    io_submit: bigint;
+    io_cancel: bigint;
+    io_getevents: bigint;
+    setxattr: bigint;
+    lsetxattr: bigint;
+    fsetxattr: bigint;
+    getxattr: bigint;
+    lgetxattr: bigint;
+    fgetxattr: bigint;
+    listxattr: bigint;
+    llistxattr: bigint;
+    flistxattr: bigint;
+    removexattr: bigint;
+    lremovexattr: bigint;
+    fremovexattr: bigint;
+    getcwd: bigint;
+    lookup_dcookie: bigint;
+    eventfd2: bigint;
+    epoll_create1: bigint;
+    epoll_ctl: bigint;
+    epoll_pwait: bigint;
+    dup: bigint;
+    dup3: bigint;
+    inotify_init1: bigint;
+    inotify_add_watch: bigint;
+    inotify_rm_watch: bigint;
+    ioctl: bigint;
+    ioprio_set: bigint;
+    ioprio_get: bigint;
+    flock: bigint;
+    mknodat: bigint;
+    mkdirat: bigint;
+    unlinkat: bigint;
+    symlinkat: bigint;
+    linkat: bigint;
+    renameat: bigint;
+    umount2: bigint;
+    mount: bigint;
+    pivot_root: bigint;
+    nfsservctl: bigint;
+    fallocate: bigint;
+    faccessat: bigint;
+    chdir: bigint;
+    fchdir: bigint;
+    chroot: bigint;
+    fchmod: bigint;
+    fchmodat: bigint;
+    fchownat: bigint;
+    fchown: bigint;
+    openat: bigint;
+    close: bigint;
+    vhangup: bigint;
+    pipe2: bigint;
+    quotactl: bigint;
+    getdents64: bigint;
+    read: bigint;
+    write: bigint;
+    readv: bigint;
+    writev: bigint;
+    pread64: bigint;
+    pwrite64: bigint;
+    preadv: bigint;
+    pwritev: bigint;
+    pselect6: bigint;
+    ppoll: bigint;
+    signalfd4: bigint;
+    vmsplice: bigint;
+    splice: bigint;
+    tee: bigint;
+    readlinkat: bigint;
+    sync: bigint;
+    fsync: bigint;
+    fdatasync: bigint;
+    sync_file_range2: bigint;
+    timerfd_create: bigint;
+    timerfd_settime: bigint;
+    timerfd_gettime: bigint;
+    utimensat: bigint;
+    acct: bigint;
+    capget: bigint;
+    capset: bigint;
+    personality: bigint;
+    exit: bigint;
+    exit_group: bigint;
+    waitid: bigint;
+    set_tid_address: bigint;
+    unshare: bigint;
+    futex: bigint;
+    set_robust_list: bigint;
+    get_robust_list: bigint;
+    nanosleep: bigint;
+    getitimer: bigint;
+    setitimer: bigint;
+    kexec_load: bigint;
+    init_module: bigint;
+    delete_module: bigint;
+    timer_create: bigint;
+    timer_gettime: bigint;
+    timer_getoverrun: bigint;
+    timer_settime: bigint;
+    timer_delete: bigint;
+    clock_settime: bigint;
+    clock_gettime: bigint;
+    clock_getres: bigint;
+    clock_nanosleep: bigint;
+    syslog: bigint;
+    ptrace: bigint;
+    sched_setparam: bigint;
+    sched_setscheduler: bigint;
+    sched_getscheduler: bigint;
+    sched_getparam: bigint;
+    sched_setaffinity: bigint;
+    sched_getaffinity: bigint;
+    sched_yield: bigint;
+    sched_get_priority_max: bigint;
+    sched_get_priority_min: bigint;
+    sched_rr_get_interval: bigint;
+    restart_syscall: bigint;
+    kill: bigint;
+    tkill: bigint;
+    tgkill: bigint;
+    sigaltstack: bigint;
+    rt_sigsuspend: bigint;
+    rt_sigaction: bigint;
+    rt_sigprocmask: bigint;
+    rt_sigpending: bigint;
+    rt_sigtimedwait: bigint;
+    rt_sigqueueinfo: bigint;
+    rt_sigreturn: bigint;
+    setpriority: bigint;
+    getpriority: bigint;
+    reboot: bigint;
+    setregid: bigint;
+    setgid: bigint;
+    setreuid: bigint;
+    setuid: bigint;
+    setresuid: bigint;
+    getresuid: bigint;
+    setresgid: bigint;
+    getresgid: bigint;
+    setfsuid: bigint;
+    setfsgid: bigint;
+    times: bigint;
+    setpgid: bigint;
+    getpgid: bigint;
+    getsid: bigint;
+    setsid: bigint;
+    getgroups: bigint;
+    setgroups: bigint;
+    uname: bigint;
+    sethostname: bigint;
+    setdomainname: bigint;
+    setrlimit: bigint;
+    getrusage: bigint;
+    umask: bigint;
+    prctl: bigint;
+    getcpu: bigint;
+    gettimeofday: bigint;
+    settimeofday: bigint;
+    adjtimex: bigint;
+    getpid: bigint;
+    getppid: bigint;
+    getuid: bigint;
+    geteuid: bigint;
+    getgid: bigint;
+    getegid: bigint;
+    gettid: bigint;
+    sysinfo: bigint;
+    mq_open: bigint;
+    mq_unlink: bigint;
+    mq_timedsend: bigint;
+    mq_timedreceive: bigint;
+    mq_notify: bigint;
+    mq_getsetattr: bigint;
+    msgget: bigint;
+    msgctl: bigint;
+    msgrcv: bigint;
+    msgsnd: bigint;
+    semget: bigint;
+    semctl: bigint;
+    semtimedop: bigint;
+    semop: bigint;
+    shmget: bigint;
+    shmctl: bigint;
+    shmat: bigint;
+    shmdt: bigint;
+    socket: bigint;
+    socketpair: bigint;
+    bind: bigint;
+    listen: bigint;
+    accept: bigint;
+    connect: bigint;
+    getsockname: bigint;
+    getpeername: bigint;
+    sendto: bigint;
+    recvfrom: bigint;
+    setsockopt: bigint;
+    getsockopt: bigint;
+    shutdown: bigint;
+    sendmsg: bigint;
+    recvmsg: bigint;
+    readahead: bigint;
+    brk: bigint;
+    munmap: bigint;
+    mremap: bigint;
+    add_key: bigint;
+    request_key: bigint;
+    keyctl: bigint;
+    clone: bigint;
+    execve: bigint;
+    swapon: bigint;
+    swapoff: bigint;
+    mprotect: bigint;
+    msync: bigint;
+    mlock: bigint;
+    munlock: bigint;
+    mlockall: bigint;
+    munlockall: bigint;
+    mincore: bigint;
+    madvise: bigint;
+    remap_file_pages: bigint;
+    mbind: bigint;
+    get_mempolicy: bigint;
+    set_mempolicy: bigint;
+    migrate_pages: bigint;
+    move_pages: bigint;
+    rt_tgsigqueueinfo: bigint;
+    perf_event_open: bigint;
+    accept4: bigint;
+    recvmmsg: bigint;
+    wait4: bigint;
+    prlimit64: bigint;
+    fanotify_init: bigint;
+    fanotify_mark: bigint;
+    name_to_handle_at: bigint;
+    open_by_handle_at: bigint;
+    clock_adjtime: bigint;
+    syncfs: bigint;
+    setns: bigint;
+    sendmmsg: bigint;
+    process_vm_readv: bigint;
+    process_vm_writev: bigint;
+    kcmp: bigint;
+    finit_module: bigint;
+    sched_setattr: bigint;
+    sched_getattr: bigint;
+    renameat2: bigint;
+    seccomp: bigint;
+    getrandom: bigint;
+    memfd_create: bigint;
+    bpf: bigint;
+    execveat: bigint;
+    userfaultfd: bigint;
+    membarrier: bigint;
+    mlock2: bigint;
+    copy_file_range: bigint;
+    preadv2: bigint;
+    pwritev2: bigint;
+    pkey_mprotect: bigint;
+    pkey_alloc: bigint;
+    pkey_free: bigint;
+    statx: bigint;
+    io_pgetevents: bigint;
+    rseq: bigint;
+    kexec_file_load: bigint;
+    clock_gettime64: bigint;
+    clock_settime64: bigint;
+    clock_adjtime64: bigint;
+    clock_getres_time64: bigint;
+    clock_nanosleep_time64: bigint;
+    timer_gettime64: bigint;
+    timer_settime64: bigint;
+    timerfd_gettime64: bigint;
+    timerfd_settime64: bigint;
+    utimensat_time64: bigint;
+    pselect6_time64: bigint;
+    ppoll_time64: bigint;
+    io_pgetevents_time64: bigint;
+    recvmmsg_time64: bigint;
+    mq_timedsend_time64: bigint;
+    mq_timedreceive_time64: bigint;
+    semtimedop_time64: bigint;
+    rt_sigtimedwait_time64: bigint;
+    futex_time64: bigint;
+    sched_rr_get_interval_time64: bigint;
+    pidfd_send_signal: bigint;
+    io_uring_setup: bigint;
+    io_uring_enter: bigint;
+    io_uring_register: bigint;
+    open_tree: bigint;
+    move_mount: bigint;
+    fsopen: bigint;
+    fsconfig: bigint;
+    fsmount: bigint;
+    fspick: bigint;
+    pidfd_open: bigint;
+    clone3: bigint;
+    close_range: bigint;
+    openat2: bigint;
+    pidfd_getfd: bigint;
+    faccessat2: bigint;
+    process_madvise: bigint;
+    epoll_pwait2: bigint;
+    mount_setattr: bigint;
+    quotactl_fd: bigint;
+    landlock_create_ruleset: bigint;
+    landlock_add_rule: bigint;
+    landlock_restrict_self: bigint;
+    process_mrelease: bigint;
+    futex_waitv: bigint;
+    set_mempolicy_home_node: bigint;
+    fcntl: bigint;
+    statfs: bigint;
+    fstatfs: bigint;
+    truncate: bigint;
+    ftruncate: bigint;
+    lseek: bigint;
+    sendfile: bigint;
+    fstat: bigint;
+    stat: bigint;
+    lstat: bigint;
+    fcntl64: bigint;
+    statfs64: bigint;
+    fstatfs64: bigint;
+    truncate64: bigint;
+    ftruncate64: bigint;
+    sendfile64: bigint;
+    fstatat64: bigint;
+    fstat64: bigint;
+    mmap2: bigint;
+    stat64: bigint;
+    lstat64: bigint;
+};
+export { syscallNumbers };

package/dist/lib/constants/arm64.d.ts

@@ -0,0 +1,311 @@
+declare const syscallNumbers: {
+    io_setup: bigint;
+    io_destroy: bigint;
+    io_submit: bigint;
+    io_cancel: bigint;
+    io_getevents: bigint;
+    setxattr: bigint;
+    lsetxattr: bigint;
+    fsetxattr: bigint;
+    getxattr: bigint;
+    lgetxattr: bigint;
+    fgetxattr: bigint;
+    listxattr: bigint;
+    llistxattr: bigint;
+    flistxattr: bigint;
+    removexattr: bigint;
+    lremovexattr: bigint;
+    fremovexattr: bigint;
+    getcwd: bigint;
+    lookup_dcookie: bigint;
+    eventfd2: bigint;
+    epoll_create1: bigint;
+    epoll_ctl: bigint;
+    epoll_pwait: bigint;
+    dup: bigint;
+    dup3: bigint;
+    inotify_init1: bigint;
+    inotify_add_watch: bigint;
+    inotify_rm_watch: bigint;
+    ioctl: bigint;
+    ioprio_set: bigint;
+    ioprio_get: bigint;
+    flock: bigint;
+    mknodat: bigint;
+    mkdirat: bigint;
+    unlinkat: bigint;
+    symlinkat: bigint;
+    linkat: bigint;
+    renameat: bigint;
+    umount2: bigint;
+    mount: bigint;
+    pivot_root: bigint;
+    nfsservctl: bigint;
+    fallocate: bigint;
+    faccessat: bigint;
+    chdir: bigint;
+    fchdir: bigint;
+    chroot: bigint;
+    fchmod: bigint;
+    fchmodat: bigint;
+    fchownat: bigint;
+    fchown: bigint;
+    openat: bigint;
+    close: bigint;
+    vhangup: bigint;
+    pipe2: bigint;
+    quotactl: bigint;
+    getdents64: bigint;
+    read: bigint;
+    write: bigint;
+    readv: bigint;
+    writev: bigint;
+    pread64: bigint;
+    pwrite64: bigint;
+    preadv: bigint;
+    pwritev: bigint;
+    pselect6: bigint;
+    ppoll: bigint;
+    signalfd4: bigint;
+    vmsplice: bigint;
+    splice: bigint;
+    tee: bigint;
+    readlinkat: bigint;
+    sync: bigint;
+    fsync: bigint;
+    fdatasync: bigint;
+    sync_file_range: bigint;
+    timerfd_create: bigint;
+    timerfd_settime: bigint;
+    timerfd_gettime: bigint;
+    utimensat: bigint;
+    acct: bigint;
+    capget: bigint;
+    capset: bigint;
+    personality: bigint;
+    exit: bigint;
+    exit_group: bigint;
+    waitid: bigint;
+    set_tid_address: bigint;
+    unshare: bigint;
+    futex: bigint;
+    set_robust_list: bigint;
+    get_robust_list: bigint;
+    nanosleep: bigint;
+    getitimer: bigint;
+    setitimer: bigint;
+    kexec_load: bigint;
+    init_module: bigint;
+    delete_module: bigint;
+    timer_create: bigint;
+    timer_gettime: bigint;
+    timer_getoverrun: bigint;
+    timer_settime: bigint;
+    timer_delete: bigint;
+    clock_settime: bigint;
+    clock_gettime: bigint;
+    clock_getres: bigint;
+    clock_nanosleep: bigint;
+    syslog: bigint;
+    ptrace: bigint;
+    sched_setparam: bigint;
+    sched_setscheduler: bigint;
+    sched_getscheduler: bigint;
+    sched_getparam: bigint;
+    sched_setaffinity: bigint;
+    sched_getaffinity: bigint;
+    sched_yield: bigint;
+    sched_get_priority_max: bigint;
+    sched_get_priority_min: bigint;
+    sched_rr_get_interval: bigint;
+    restart_syscall: bigint;
+    kill: bigint;
+    tkill: bigint;
+    tgkill: bigint;
+    sigaltstack: bigint;
+    rt_sigsuspend: bigint;
+    rt_sigaction: bigint;
+    rt_sigprocmask: bigint;
+    rt_sigpending: bigint;
+    rt_sigtimedwait: bigint;
+    rt_sigqueueinfo: bigint;
+    rt_sigreturn: bigint;
+    setpriority: bigint;
+    getpriority: bigint;
+    reboot: bigint;
+    setregid: bigint;
+    setgid: bigint;
+    setreuid: bigint;
+    setuid: bigint;
+    setresuid: bigint;
+    getresuid: bigint;
+    setresgid: bigint;
+    getresgid: bigint;
+    setfsuid: bigint;
+    setfsgid: bigint;
+    times: bigint;
+    setpgid: bigint;
+    getpgid: bigint;
+    getsid: bigint;
+    setsid: bigint;
+    getgroups: bigint;
+    setgroups: bigint;
+    uname: bigint;
+    sethostname: bigint;
+    setdomainname: bigint;
+    getrlimit: bigint;
+    setrlimit: bigint;
+    getrusage: bigint;
+    umask: bigint;
+    prctl: bigint;
+    getcpu: bigint;
+    gettimeofday: bigint;
+    settimeofday: bigint;
+    adjtimex: bigint;
+    getpid: bigint;
+    getppid: bigint;
+    getuid: bigint;
+    geteuid: bigint;
+    getgid: bigint;
+    getegid: bigint;
+    gettid: bigint;
+    sysinfo: bigint;
+    mq_open: bigint;
+    mq_unlink: bigint;
+    mq_timedsend: bigint;
+    mq_timedreceive: bigint;
+    mq_notify: bigint;
+    mq_getsetattr: bigint;
+    msgget: bigint;
+    msgctl: bigint;
+    msgrcv: bigint;
+    msgsnd: bigint;
+    semget: bigint;
+    semctl: bigint;
+    semtimedop: bigint;
+    semop: bigint;
+    shmget: bigint;
+    shmctl: bigint;
+    shmat: bigint;
+    shmdt: bigint;
+    socket: bigint;
+    socketpair: bigint;
+    bind: bigint;
+    listen: bigint;
+    accept: bigint;
+    connect: bigint;
+    getsockname: bigint;
+    getpeername: bigint;
+    sendto: bigint;
+    recvfrom: bigint;
+    setsockopt: bigint;
+    getsockopt: bigint;
+    shutdown: bigint;
+    sendmsg: bigint;
+    recvmsg: bigint;
+    readahead: bigint;
+    brk: bigint;
+    munmap: bigint;
+    mremap: bigint;
+    add_key: bigint;
+    request_key: bigint;
+    keyctl: bigint;
+    clone: bigint;
+    execve: bigint;
+    swapon: bigint;
+    swapoff: bigint;
+    mprotect: bigint;
+    msync: bigint;
+    mlock: bigint;
+    munlock: bigint;
+    mlockall: bigint;
+    munlockall: bigint;
+    mincore: bigint;
+    madvise: bigint;
+    remap_file_pages: bigint;
+    mbind: bigint;
+    get_mempolicy: bigint;
+    set_mempolicy: bigint;
+    migrate_pages: bigint;
+    move_pages: bigint;
+    rt_tgsigqueueinfo: bigint;
+    perf_event_open: bigint;
+    accept4: bigint;
+    recvmmsg: bigint;
+    arch_specific_syscall: bigint;
+    wait4: bigint;
+    prlimit64: bigint;
+    fanotify_init: bigint;
+    fanotify_mark: bigint;
+    name_to_handle_at: bigint;
+    open_by_handle_at: bigint;
+    clock_adjtime: bigint;
+    syncfs: bigint;
+    setns: bigint;
+    sendmmsg: bigint;
+    process_vm_readv: bigint;
+    process_vm_writev: bigint;
+    kcmp: bigint;
+    finit_module: bigint;
+    sched_setattr: bigint;
+    sched_getattr: bigint;
+    renameat2: bigint;
+    seccomp: bigint;
+    getrandom: bigint;
+    memfd_create: bigint;
+    bpf: bigint;
+    execveat: bigint;
+    userfaultfd: bigint;
+    membarrier: bigint;
+    mlock2: bigint;
+    copy_file_range: bigint;
+    preadv2: bigint;
+    pwritev2: bigint;
+    pkey_mprotect: bigint;
+    pkey_alloc: bigint;
+    pkey_free: bigint;
+    statx: bigint;
+    io_pgetevents: bigint;
+    rseq: bigint;
+    kexec_file_load: bigint;
+    pidfd_send_signal: bigint;
+    io_uring_setup: bigint;
+    io_uring_enter: bigint;
+    io_uring_register: bigint;
+    open_tree: bigint;
+    move_mount: bigint;
+    fsopen: bigint;
+    fsconfig: bigint;
+    fsmount: bigint;
+    fspick: bigint;
+    pidfd_open: bigint;
+    clone3: bigint;
+    close_range: bigint;
+    openat2: bigint;
+    pidfd_getfd: bigint;
+    faccessat2: bigint;
+    process_madvise: bigint;
+    epoll_pwait2: bigint;
+    mount_setattr: bigint;
+    quotactl_fd: bigint;
+    landlock_create_ruleset: bigint;
+    landlock_add_rule: bigint;
+    landlock_restrict_self: bigint;
+    memfd_secret: bigint;
+    process_mrelease: bigint;
+    futex_waitv: bigint;
+    set_mempolicy_home_node: bigint;
+    syscalls: bigint;
+    fcntl: bigint;
+    statfs: bigint;
+    fstatfs: bigint;
+    truncate: bigint;
+    ftruncate: bigint;
+    lseek: bigint;
+    sendfile: bigint;
+    newfstatat: bigint;
+    fstat: bigint;
+    mmap: bigint;
+    fadvise64: bigint;
+};
+export { syscallNumbers };

package/dist/lib/constants/index.d.ts

@@ -0,0 +1,4 @@
+declare const syscallNumbers: Partial<{
+    [x: string]: any;
+}>;
+export { syscallNumbers };