folk-ext 0.2.2

Folk PHP extension — runs the Folk server as a PHP extension (like Swoole)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

/*
 * folk_zts.c — thin C wrappers for PHP ZTS thread lifecycle.
 *
 * These functions call PHP macros/inline functions that cannot
 * be called directly from Rust FFI.
 */

#include "php.h"
#include "SAPI.h"

#ifdef ZTS
#include "TSRM.h"
#endif

#include "php_main.h"
#include "zend_stream.h"
#include "zend_execute.h"

/* Register the calling thread with PHP TSRM.
 * Must be called before any PHP API usage from a new thread.
 * No-op on non-ZTS builds. */
void folk_zts_thread_init(void) {
#ifdef ZTS
    (void)ts_resource(0);
#ifdef PHP_WIN32
    ZEND_TSRMLS_CACHE_UPDATE();
#endif
#endif
}

/* Unregister the calling thread from PHP TSRM.
 * Must be called before the thread exits.
 * No-op on non-ZTS builds. */
void folk_zts_thread_shutdown(void) {
#ifdef ZTS
    ts_free_thread();
#endif
}

/* Start a PHP request on the current thread.
 * Returns 0 (SUCCESS) or -1 (FAILURE). */
int folk_zts_request_startup(void) {
    return php_request_startup();
}

/* Shut down the PHP request on the current thread. */
void folk_zts_request_shutdown(void) {
    php_request_shutdown(NULL);
}

/* Execute a PHP script file on the current thread.
 * Skips the shebang line (#!/...) if present — CLI SAPI does this
 * automatically but ZTS worker threads use the embed context where
 * shebang stripping is not performed.
 * Returns 0 (SUCCESS) or -1 (FAILURE). */
int folk_zts_execute_script(const char *filename) {
    FILE *fp = fopen(filename, "rb");
    if (!fp) return 0;

    /* Skip shebang line if present. */
    int c1 = fgetc(fp);
    int c2 = fgetc(fp);
    if (c1 == '#' && c2 == '!') {
        int c;
        while ((c = fgetc(fp)) != EOF && c != '\n') {}
    } else {
        rewind(fp);
    }

    zend_file_handle file_handle;
    zend_stream_init_fp(&file_handle, fp, filename);
    int ret = php_execute_script(&file_handle);
    zend_destroy_file_handle(&file_handle);
    /* fp is closed by zend_destroy_file_handle */
    return ret;
}

/* Call a PHP function by name with two arguments (method string + params array).
 * Returns 0 (SUCCESS) or non-zero (FAILURE).
 * retval must point to a valid zval (will be overwritten). */
int folk_zts_call_dispatch(const char *func_name, zval *method_zval, zval *params_zval, zval *retval) {
    zval fname;
    ZVAL_STRING(&fname, func_name);

    zval args[2];
    ZVAL_COPY(&args[0], method_zval);
    ZVAL_COPY(&args[1], params_zval);

    int result = call_user_function(
        CG(function_table),
        NULL,
        &fname,
        retval,
        2,
        args
    );

    /* Clean up our copies (decrements refcount). */
    zval_ptr_dtor(&args[0]);
    zval_ptr_dtor(&args[1]);
    zval_ptr_dtor(&fname);
    return result;
}

/* Check if the current PHP build has ZTS enabled. */
int folk_zts_is_enabled(void) {
#ifdef ZTS
    return 1;
#else
    return 0;
#endif
}