Skip to content

Add details when failing to load a shared library with \FFI::load() and \FFI::cdef() #9913

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Add details when failing to load a shared library with \FFI::load() and \FFI::cdef() #9913

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 38 additions & 3 deletions ext/ffi/ffi.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,17 @@
#include <sys/stat.h>
#include <fcntl.h>

#ifdef HAVE_LIBDL
#ifdef PHP_WIN32
#include "win32/param.h"
#include "win32/winutil.h"
#define GET_DL_ERROR() php_win_err()
#else
#include <sys/param.h>
#define GET_DL_ERROR() DL_ERROR()
#endif
#endif

#ifdef HAVE_GLOB
#ifdef PHP_WIN32
#include "win32/glob.h"
Expand Down Expand Up @@ -2934,6 +2945,7 @@ ZEND_METHOD(FFI, cdef) /* {{{ */
zend_string *lib = NULL;
zend_ffi *ffi = NULL;
DL_HANDLE handle = NULL;
char *err;
void *addr;

ZEND_FFI_VALIDATE_API_RESTRICTION();
Expand All @@ -2946,9 +2958,21 @@ ZEND_METHOD(FFI, cdef) /* {{{ */
if (lib) {
handle = DL_LOAD(ZSTR_VAL(lib));
if (!handle) {
zend_throw_error(zend_ffi_exception_ce, "Failed loading '%s'", ZSTR_VAL(lib));
err = GET_DL_ERROR();
#ifdef PHP_WIN32
if (err && err[0]) {
zend_throw_error(zend_ffi_exception_ce, "Failed loading '%s' (%s)", ZSTR_VAL(lib), err);
php_win32_error_msg_free(err);
} else {
zend_throw_error(zend_ffi_exception_ce, "Failed loading '%s' (Unknown reason)", ZSTR_VAL(lib));
}
#else
zend_throw_error(zend_ffi_exception_ce, "Failed loading '%s' (%s)", ZSTR_VAL(lib), err);
GET_DL_ERROR(); /* free the buffer storing the error */
#endif
RETURN_THROWS();
}

#ifdef RTLD_DEFAULT
} else if (1) {
// TODO: this might need to be disabled or protected ???
Expand Down Expand Up @@ -3201,7 +3225,7 @@ static zend_ffi *zend_ffi_load(const char *filename, bool preload) /* {{{ */
{
struct stat buf;
int fd;
char *code, *code_pos, *scope_name, *lib;
char *code, *code_pos, *scope_name, *lib, *err;
size_t code_size, scope_name_len;
zend_ffi *ffi;
DL_HANDLE handle = NULL;
Expand Down Expand Up @@ -3278,7 +3302,18 @@ static zend_ffi *zend_ffi_load(const char *filename, bool preload) /* {{{ */
if (preload) {
zend_error(E_WARNING, "FFI: Failed pre-loading '%s'", lib);
} else {
zend_throw_error(zend_ffi_exception_ce, "Failed loading '%s'", lib);
err = GET_DL_ERROR();
#ifdef PHP_WIN32
if (err && err[0]) {
zend_throw_error(zend_ffi_exception_ce, "Failed loading '%s' (%s)", lib, err);
php_win32_error_msg_free(err);
} else {
zend_throw_error(zend_ffi_exception_ce, "Failed loading '%s' (Unknown reason)", lib);
}
#else
zend_throw_error(zend_ffi_exception_ce, "Failed loading '%s' (%s)", lib, err);
GET_DL_ERROR(); /* free the buffer storing the error */
#endif
}
goto cleanup;
}
Expand Down
1 change: 1 addition & 0 deletions ext/ffi/tests/ffi_load_error.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
#define FFI_LIB "./donotexist.so"
16 changes: 16 additions & 0 deletions ext/ffi/tests/ffi_load_error.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
--TEST--
Test that FFI::load returns a detailed error when failling to load a shared library
--EXTENSIONS--
ffi
--INI--
ffi.enable=1
--FILE--
<?php
try {
FFI::load(__DIR__ . "/ffi_load_error.h");
} catch (FFI\Exception $ex) {
printf($ex->getMessage());
}
?>
--EXPECTF--
Failed loading '%s' (%s)