FFI::load

(PHP 7 >= 7.4.0, PHP 8)

FFI::load — Загрузить декларации C из заголовочного файла

Описание

public static FFI::load(string $filename): ?FFI

Загружает декларации C из заголовочного файла. Можно указать общие библиотеки для загрузки с помощью специальной #define директивы FFI_LIB в заголовочном файле.

Список параметров

filename

Имя заголовочного файла C.

Директивы сопроцессора С не поддерживаются. Т.е. #include, #define и макросы CPP работать не будут, за исключением особых случаев, перечисленных ниже.

Заголовочный файл должен содержать оператор #define для переменной FFI_SCOPE, например, #define FFI_SCOPE "MYLIB". За подробностями обратитесь к Введению в FFI.

Заголовочный файл может содержать оператор #define для переменной FFI_LIB, чтобы указать библиотеку, которую он раскрывает. Если это системная библиотека, требуется только имя файла, например: #define FFI_LIB "libc.so.6". Если это пользовательская библиотека, требуется относительный путь, например: #define FFI_LIB "./mylib.so".

Возвращаемые значения

Возвращает новый объект FFI или null в случае возникновения ошибки.

Смотрите также

FFI::scope() - Инстанциирует объект FFI в соответствии с декларацией С, разобранной на этапе предзагрузки

add a note

User Contributed Notes 2 notes

down

jungmann0 at gmail dot com ¶

4 years ago


Since #include's and #define's other than FFI_LIB and FFI_SCOPE are not supported in the header, you may want to use the C preprocessor to pre-process your headers in order to resolve all #include's and macros.

I use -D"__attribute__(ARGS)=" to remove function attributes as well, which are not supported by FFI either.

This is my script:

echo '#define FFI_SCOPE "YOUR_SCOPE"' > header-ffi.h
echo '#define FFI_LIB "/path/to/your_lib.so"' >> header-ffi.h
cpp -P -C -D"__attribute__(ARGS)=" header_original >> header-ffi.h

down

ojrask at gmail dot com ¶

4 years ago


Regarding the `FFI_LIB` constant:

The path given can be either relative, or absolute, or then refer to a library that is in your global libraries path (i.e. where libc.so.6 and friends are).

The absolute path and global lib path work as expected. The relative path does not work from the header file path, but the current working directory instead. So when you create header files for FFI usage, remember that the PHP script can be called anywhere and this means any relative paths in `FFI_LIB` will most probably fail.

Not sure if there is some possibility to make it use paths relative to the script being called, or relative to the header file being loaded. That would make more sense to me at least.

Right now `FFI_LIB` is quite unusable when it comes to making FFI-powered PHP packages that can be installed literally anywhere on a system. `FFI::cdef` works just as well, but `FFI::scope` also seems to rely on `FFI_LIB` meaning it will fail with relative paths as well.

I guess this comes from the C function `dlopen` as is.

add a note