folk-ext 0.2.1

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

//! ZTS worker threads — each thread runs an independent PHP context.
//!
//! A worker thread:
//! 1. Registers with TSRM via `ZtsThreadGuard`
//! 2. Starts a PHP request (`request_startup`)
//! 3. Executes the PHP worker script (which registers handlers)
//! 4. Enters the recv/send loop via `bridge::do_recv()`/`bridge::do_send()`
//! 5. Cleans up on exit

use std::sync::mpsc;
use std::thread;

use tracing::{error, info};

use crate::bridge;
use crate::zts;

/// Spawn a ZTS worker thread that executes the given PHP script.
///
/// The worker thread receives tasks via `task_rx` and signals
/// readiness via `ready_tx`. The script is expected to call
/// `folk_worker_ready()` and then loop on `folk_worker_recv()`/`folk_worker_send()`.
pub fn spawn_zts_worker(
    worker_id: u32,
    script: String,
    task_rx: mpsc::Receiver<bridge::TaskRequest>,
    ready_tx: mpsc::SyncSender<()>,
) -> thread::JoinHandle<()> {
    thread::Builder::new()
        .name(format!("folk-worker-{worker_id}"))
        .spawn(move || {
            if let Err(e) = std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| {
                run_zts_worker(worker_id, &script, task_rx, ready_tx);
            })) {
                error!(worker_id, "ZTS worker thread panicked: {e:?}");
            }
        })
        .expect("failed to spawn worker thread")
}

fn run_zts_worker(
    worker_id: u32,
    script: &str,
    task_rx: mpsc::Receiver<bridge::TaskRequest>,
    ready_tx: mpsc::SyncSender<()>,
) {
    // 1. Register with TSRM.
    let _guard = zts::ZtsThreadGuard::new();

    // 2. Start PHP request.
    if let Err(e) = zts::request_startup() {
        error!(worker_id, error = ?e, "php_request_startup failed");
        return;
    }

    // 3. Install worker bridge channels (thread-local).
    bridge::init_worker_state(worker_id, task_rx, ready_tx);

    // 4. Execute the PHP worker script.
    //    The script calls folk_worker_ready() and enters the recv/send loop.
    //    This call blocks until the script exits (channel closed).
    if let Err(e) = zts::execute_script(script) {
        error!(worker_id, error = ?e, "worker script failed");
    }

    // 5. Clean up.
    bridge::cleanup_worker_state();
    zts::request_shutdown();
    // ZtsThreadGuard drop handles ts_free_thread().

    info!(worker_id, "ZTS worker thread exiting");
}