aza/APP/nexus-remote/node_modules/koffi/doc/pages/misc.md

Types

Introspection

New in Koffi 2.0: koffi.resolve(), new in Koffi 2.2: koffi.offsetof()

Note

The value returned by introspect() has changed in version 2.0 and in version 2.2.

In Koffi 1.x, it could only be used with struct types and returned the object passed to koffi.struct() with the member names and types.

Starting in Koffi 2.2, each record member is exposed as an object containing the name, the type and the offset within the record.

Consult the migration guide for more information.

Use koffi.introspect(type) to get detailed information about a type: name, primitive, size, alignment, members (record types), reference type (array, pointer) and length (array).

const FoobarType = koffi.struct('FoobarType', {
    a: 'int',
    b: 'char *',
    c: 'double'
});

console.log(koffi.introspect(FoobarType));

// Expected result on 64-bit machines:
// {
//     name: 'FoobarType',
//     primitive: 'Record',
//     size: 24,
//     alignment: 8,
//     members: {
//         a: { name: 'a', type: [External: 4b28a60], offset: 0 },
//         b: { name: 'b', type: [External: 4b292e0], offset: 8 },
//         c: { name: 'c', type: [External: 4b29260], offset: 16 }
//     }
// }

Koffi also exposes a few more utility functions to get a subset of this information:

• koffi.sizeof(type) to get the size of a type
• koffi.alignof(type) to get the alignment of a type
• koffi.offsetof(type, member_name) to get the offset of a record member
• koffi.resolve(type) to get the resolved type object from a type string

Just like before, you can refer to primitive types by their name or through koffi.types:

// These two lines do the same:
console.log(koffi.sizeof('long'));
console.log(koffi.sizeof(koffi.types.long));

Aliases

New in Koffi 2.0

You can alias a type with koffi.alias(name, type). Aliased types are completely equivalent.

Circular references

New in Koffi 2.10.0

In some cases, composite types can point to each other and thus depend on each other. This can also happen when a function takes a pointer to a struct that also contains a function pointer.

To deal with this, you can create an opaque type and redefine it later to a concrete struct or union type, as shown below.

const Type1 = koffi.opaque('Type1');

const Type2 = koffi.struct('Type2', {
    ptr: 'Type1 *',
    i: 'int'
});

// Redefine Type1 to a concrete type
koffi.struct(Type1, {
    ptr: 'Type2 *',
    f: 'float'
});

Note

You must use a proper type object when you redefine the type. If you only have the name, use koffi.resolve() to get a type object from a type string.

const MyType = koffi.opaque('MyType');

// This does not work, you must use the MyType object and not a type string
koffi.struct('MyType', {
     ptr: 'Type2 *',
     f: 'float'
});

Settings

Memory usage

For synchronous/normal calls, Koffi uses two preallocated memory blocks:

• One to construct the C stack and assign registers, subsequently used by the platform-specific assembly code (1 MiB by default)
• One to allocate strings and objects/structs (2 MiB by default)

Unless very big strings or objects (at least more than one page of memory) are used, Koffi does not directly allocate any extra memory during calls or callbacks. However, please note that the JS engine (V8) might.

The size (in bytes) of these preallocated blocks can be changed. Use koffi.config() to get an object with the settings, and koffi.config(obj) to apply new settings.

let config = koffi.config();
console.log(config);

The same is true for asynchronous calls. When an asynchronous call is made, Koffi will allocate new blocks unless there is an unused (resident) set of blocks still available. Once the asynchronous call is finished, these blocks are freed if there are more than resident_async_pools sets of blocks left around. By default, the preallocated stack and heap blocks are much smaller than for synchronous calls (see default settings).

Caution

The memory usage can blow up easily if you increase the size of async memory blocks and many async calls are running or queued at the same time !

For example, with 4096 running/queued async calls, a stack size of 256 kiB and a heap size of 512 kiB, the memory usage will reach approximately 4096 * (256 + 512) kiB ≈ 3 GiB just for Koffi, even though most of it will be freed once the number of queued calls goes down.

Async calls run on worker threads, the number of which depends on the number of cores in your machine. Additional async calls are queued, up to max_async_calls can run and be queued at the same time. If you try to make an async call once the queue if full, an exception will be thrown.

Default settings

Changed in Koffi 2.15

Setting	Default	Maximum	Description
sync_stack_size	1 MiB	16 MiB	Stack size for synchronous calls
sync_heap_size	2 MiB	16 MiB	Heap size for synchronous calls
async_stack_size	128 kiB	16 MiB	Stack size for asynchronous calls
async_heap_size	128 kiB	16 MiB	Heap size for asynchronous calls
resident_async_pools	4	16	Number of resident pools for asynchronous calls
max_async_calls	256	4096	Maximum number of queued asynchronous calls
max_type_size	64 MiB	512 MiB	Maximum size of Koffi types (for arrays and structs)

Usage statistics

New in Koffi 2.3.2

You can use koffi.stats() to get a few statistics related to Koffi.

POSIX error codes

New in Koffi 2.3.14

You can use koffi.errno() to get the current errno value, and koffi.errno(value) to change it.

The standard POSIX error codes are available in koffi.os.errno, as shown below:

const assert = require('assert');

// ES6 syntax: import koffi from 'koffi';
const koffi = require('koffi');

const lib = koffi.load('libc.so.6');

const close = lib.func('int close(int fd)');

close(-1);
assert.equal(koffi.errno(), koffi.os.errno.EBADF);

console.log('close() with invalid FD is POSIX compliant!');

Reset internal state

New in Koffi 2.5.19

You can use koffi.reset() to clear some Koffi internal state such as:

• Parser type names
• Asynchronous function broker (useful to avoid false positive with jest --detectOpenHandles)

This function is mainly intended for test code, when you execute the same code over and over and you need to reuse type names.

Warning

Trying to use a function or a type that was initially defined before the reset is undefined behavior and will likely lead to a crash!