PHP `FFI` (`Foreign Function Interface`) 与 C `Struct` / `Union` / `Callback` 互操作

各位观众老爷，大家好！今天咱们来聊聊PHP的FFI，这玩意儿就像是PHP的“任意门”，能让你直接和C语言的“老伙计们”——struct、union、callback——勾肩搭背，一起愉快地玩耍。

FFI：PHP的“任意门”

PHP虽然强大，但有些底层操作还是得仰仗C语言。以前，想要在PHP里调用C代码，得写扩展，那叫一个费劲。现在有了FFI，一切都变得简单粗暴了。FFI允许你直接在PHP代码里声明C函数、结构体、联合体，然后像调用PHP函数一样调用它们。

这就像你突然有了哆啦A梦的“任意门”，想去C语言的世界看看，直接推门就进，方便快捷。

Struct：C语言的“积木”

在C语言里，struct就像是“积木”，可以把各种不同类型的数据捏合在一起，形成一个新的数据类型。例如：

// C代码：person.h
typedef struct {
    char name[50];
    int age;
    float salary;
} Person;

现在，我们要在PHP里使用这个Person结构体。

<?php
// PHP代码
$ffi = FFI::cdef(
    "typedef struct {
        char name[50];
        int age;
        float salary;
    } Person;",
    __DIR__ . "/person.h" //或者直接写C代码的字符串
);

$person = $ffi->new("Person");
$person->name = "张三";
$person->age = 30;
$person->salary = 10000.50;

echo "姓名: " . $person->name . PHP_EOL;
echo "年龄: " . $person->age . PHP_EOL;
echo "工资: " . $person->salary . PHP_EOL;

//创建一个指向Person的指针
$person_ptr = FFI::addr($person);

//你可以把这个指针传递给C函数，C函数就可以修改这个结构体的值
//这里只是演示，并没有实际的C函数
//例如： void update_person(Person *p);
// $ffi->update_person($person_ptr);
?>

这段代码里，我们用FFI::cdef()声明了C语言的Person结构体。然后，我们用$ffi->new("Person")创建了一个Person结构体的实例。接下来，我们就可以像访问PHP对象的属性一样，访问结构体的成员变量了。

注意：

FFI::cdef()的第一个参数是C语言代码的字符串，也可以是一个包含C语言头文件的路径。
$ffi->new("Person")返回的是一个FFICData类型的对象，这个对象代表了C语言的Person结构体。

Union：C语言的“变形金刚”

在C语言里，union就像是“变形金刚”，同一个内存空间可以存储不同类型的数据。例如：

// C代码：data.h
typedef union {
    int i;
    float f;
    char str[20];
} Data;

在PHP里使用union：

<?php
// PHP代码
$ffi = FFI::cdef(
    "typedef union {
        int i;
        float f;
        char str[20];
    } Data;",
    __DIR__ . "/data.h" //或者直接写C代码的字符串
);

$data = $ffi->new("Data");

$data->i = 10;
echo "Integer: " . $data->i . PHP_EOL;

$data->f = 3.14;
echo "Float: " . $data->f . PHP_EOL;

//设置str的值，会覆盖之前的i和f的值
$data->str = "Hello";
echo "String: " . $data->str . PHP_EOL;
?>

这段代码里，我们用FFI::cdef()声明了C语言的Data联合体。然后，我们用$ffi->new("Data")创建了一个Data联合体的实例。

注意：

当给union的一个成员赋值时，会覆盖之前所有成员的值。

Callback：C语言的“传话筒”

在C语言里，callback（回调函数）就像是“传话筒”，允许你把一个函数的指针传递给另一个函数，让被调用的函数在适当的时候调用你传递的函数。

例如，我们有一个C函数，它可以对一个数组进行排序，但是排序的规则由你来定义。你可以通过传递一个callback函数来告诉它如何排序。

// C代码：sort.h
typedef int (*compare_func)(const void*, const void*);

void sort_array(int* arr, int size, compare_func compare);

这个sort_array函数接受三个参数：

arr: 要排序的数组。
size: 数组的大小。
compare: 一个指向compare_func类型的函数的指针。

compare_func是一个函数指针类型，它接受两个void*类型的参数，并返回一个int类型的值。这个函数用于比较两个元素的大小。

现在，我们要在PHP里使用这个sort_array函数，并传递一个PHP函数作为callback。

<?php
// PHP代码
$ffi = FFI::cdef(
    "typedef int (*compare_func)(const void*, const void*);
     void sort_array(int* arr, int size, compare_func compare);",
    __DIR__ . "/sort.h" //或者直接写C代码的字符串
);

//创建一个PHP函数作为callback
$compare_func = function(int $a, int $b) {
    if ($a < $b) {
        return -1;
    } elseif ($a > $b) {
        return 1;
    } else {
        return 0;
    }
};

//创建一个FFI callback
$callback = $ffi->callback("int(int, int)", $compare_func);

//创建一个数组
$arr = [5, 2, 8, 1, 9, 4];

//将PHP数组转换为C数组
$c_arr = $ffi->new("int[" . count($arr) . "]", false);
foreach ($arr as $key => $value) {
    $c_arr[$key] = $value;
}

//调用C函数
$ffi->sort_array($c_arr, count($arr), $callback);

//将C数组转换回PHP数组
$sorted_arr = [];
for ($i = 0; $i < count($arr); $i++) {
    $sorted_arr[] = $c_arr[$i];
}

print_r($sorted_arr); // 输出：Array ( [0] => 1 [1] => 2 [2] => 4 [3] => 5 [4] => 8 [5] => 9 )
?>

这段代码里，我们首先用FFI::cdef()声明了C语言的sort_array函数和compare_func类型。

然后，我们创建了一个PHP函数$compare_func，这个函数用于比较两个元素的大小。

接下来，我们用$ffi->callback("int(int, int)", $compare_func)创建了一个FFI callback。$ffi->callback()的第一个参数是C语言函数签名，第二个参数是PHP函数。

注意：

C语言函数签名必须与PHP函数的参数类型和返回值类型匹配。
PHP函数必须接受与C语言函数相同数量的参数。
PHP函数必须返回与C语言函数相同类型的值。

最后，我们将PHP数组转换为C数组，并调用$ffi->sort_array()函数。

互操作的注意事项

在使用FFI与C代码互操作时，需要注意以下几点：

内存管理： C语言的内存管理需要手动进行，而PHP有自己的垃圾回收机制。在使用FFI时，需要特别注意内存的分配和释放，避免内存泄漏。
类型转换： C语言和PHP的数据类型有所不同，在使用FFI时，需要进行类型转换。FFI会自动处理一些简单的类型转换，但对于复杂类型，需要手动进行转换。
安全性： FFI允许你直接访问C代码，这意味着你可以做任何事情，包括破坏系统。因此，在使用FFI时，需要特别注意安全性，避免恶意代码的注入。

FFI的优势和劣势

优势：

性能： FFI允许你直接调用C代码，可以获得比PHP代码更高的性能。
灵活性： FFI允许你访问C语言的底层功能，可以实现PHP无法实现的功能。
易用性： FFI使用简单，不需要编写扩展。

劣势：

安全性： FFI允许你直接访问C代码，存在安全风险。
复杂性： FFI需要你了解C语言的知识，增加了开发的复杂性。
兼容性： FFI需要PHP 7.4或更高版本。

案例分析：使用FFI调用C语言的数学库

让我们来看一个更实际的例子，使用FFI调用C语言的数学库math.h。

// C代码：math_functions.h
double calculate_hypotenuse(double a, double b);

// C代码：math_functions.c
#include <math.h>
#include "math_functions.h"

double calculate_hypotenuse(double a, double b) {
    return sqrt(a * a + b * b);
}

<?php
// PHP代码
$ffi = FFI::cdef(
    "double calculate_hypotenuse(double a, double b);",
    __DIR__ . "/math_functions.h"
);

// Load the shared library
$lib = FFI::load(__DIR__ . "/math_functions.so"); // Linux specific, use .dll for Windows and .dylib for macOS

$a = 3.0;
$b = 4.0;

$hypotenuse = $lib->calculate_hypotenuse($a, $b);

echo "斜边长: " . $hypotenuse . PHP_EOL; // 输出：斜边长: 5
?>

解释：

C 代码 (math_functions.h & math_functions.c): 定义了一个计算直角三角形斜边的 C 函数。
PHP 代码:
- FFI::cdef(): 声明了 C 函数的签名。
- FFI::load(): 加载了包含 C 函数的共享库 (.so 文件)。注意，你需要先使用 C 编译器将 math_functions.c 编译成共享库。例如，在 Linux 下：gcc -shared -o math_functions.so math_functions.c -lm (-lm 链接数学库)。
- $lib->calculate_hypotenuse(): 调用了 C 函数，就像调用 PHP 函数一样。

关键步骤：

编译 C 代码: 使用 C 编译器将 C 代码编译成共享库 (shared library)。
加载共享库: 使用 FFI::load() 加载共享库。

总结

FFI是PHP的一个强大工具，它允许你直接与C代码互操作，从而获得更高的性能和灵活性。但是，FFI也存在安全风险和复杂性，需要谨慎使用。

总的来说，FFI就像一把双刃剑，用好了可以披荆斩棘，无往不利；用不好可能会伤到自己。希望今天的讲解能帮助你更好地理解和使用FFI。

接下来，我们用一个表格总结一下今天讲的内容：

特性	描述	示例
`struct`	将不同类型的数据组合成一个结构体。	`php $ffi = FFI::cdef("typedef struct { int x; int y; } Point;"); $point = $ffi->new("Point"); $point->x = 10; $point->y = 20; echo $point->x; // 输出：10`
`union`	允许在相同的内存位置存储不同的数据类型。	`php $ffi = FFI::cdef("typedef union { int i; float f; } Number;"); $number = $ffi->new("Number"); $number->i = 10; echo $number->i; // 输出：10 $number->f = 3.14; echo $number->f; // 输出：3.14 注意：设置 $number->f 后，$number->i 的值也会被覆盖。`
`callback`	允许将PHP函数作为回调函数传递给C函数。	`php $ffi = FFI::cdef("typedef int (compare_func)(int, int); void sort(int arr, int size, compare_func compare);"); $compare = function(int $a, int $b) { return $a - $b; }; $callback = $ffi->callback("int(int, int)", $compare); $arr = $ffi->new("int[5]", false); for ($i = 0; $i < 5; $i++) { $arr[$i] = rand(1, 10); } $ffi->sort($arr, 5, $callback); for ($i = 0; $i < 5; $i++) { echo $arr[$i] . " "; } // 输出排序后的数组`
内存管理	C语言需要手动管理内存，PHP有垃圾回收机制。在使用FFI时，需要注意内存的分配和释放，避免内存泄漏。	在调用C函数返回指针时，需要特别注意，确保在PHP中正确释放内存。
类型转换	C语言和PHP的数据类型有所不同，需要进行类型转换。FFI会自动处理一些简单的类型转换，但对于复杂类型，需要手动进行转换。	例如，C语言的字符串是`char*`类型，在PHP中需要转换为`string`类型。
安全性	FFI允许你直接访问C代码，存在安全风险。需要谨慎使用，避免恶意代码的注入。	避免使用用户输入作为`FFI::cdef()`的参数，防止代码注入攻击。

好了，今天的讲座就到这里，感谢各位的观看！希望大家都能掌握FFI这把“任意门”，在PHP的世界里自由穿梭！

FFI：PHP的“任意门”

Struct：C语言的“积木”

Union：C语言的“变形金刚”

Callback：C语言的“传话筒”

互操作的注意事项

FFI的优势和劣势

案例分析：使用FFI调用C语言的数学库

总结

发表回复 取消回复

发表回复取消回复