php-async/php_async.h at main · true-async/php-async · GitHub

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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
/*
+----------------------------------------------------------------------+
  | Copyright (c) The PHP Group                                          |
  +----------------------------------------------------------------------+
  | This source file is subject to version 3.01 of the PHP license,      |
  | that is bundled with this package in the file LICENSE, and is        |
  | available through the world-wide-web at the following url:           |
  | https://www.php.net/license/3_01.txt                                 |
  | If you did not receive a copy of the PHP license and are unable to   |
  | obtain it through the world-wide-web, please send a note to          |
  | license@php.net so we can mail you a copy immediately.               |
  +----------------------------------------------------------------------+
  | Author: Edmond                                                       |
  +----------------------------------------------------------------------+
*/
#ifndef PHP_ASYNC_H
#define PHP_ASYNC_H

#include <php.h>

#ifdef PHP_WIN32
#include "libuv/uv.h"
#else
#include <uv.h>
#endif

#include "coroutine.h"
#include "internal/circular_buffer.h"

#ifdef PHP_WIN32

#else

#endif

extern zend_module_entry async_module_entry;
#define phpext_async_ptr &async_module_entry

#include "php_async_api.h"

PHP_ASYNC_API extern zend_class_entry *async_ce_awaitable;
PHP_ASYNC_API extern zend_class_entry *async_ce_completable;
PHP_ASYNC_API extern zend_class_entry *async_ce_timeout;
PHP_ASYNC_API extern zend_class_entry *async_ce_signal;
PHP_ASYNC_API extern zend_class_entry *async_ce_circuit_breaker_state;
PHP_ASYNC_API extern zend_class_entry *async_ce_circuit_breaker;
PHP_ASYNC_API extern zend_class_entry *async_ce_filesystem_event;
PHP_ASYNC_API extern zend_class_entry *async_ce_fs_watcher;
PHP_ASYNC_API extern zend_class_entry *async_ce_circuit_breaker_strategy;

#define PHP_ASYNC_NAME "true_async"
#define PHP_ASYNC_VERSION "0.5.0"
#define PHP_ASYNC_NAME_VERSION "true async v0.5.0"

#define REACTOR_CHECK_INTERVAL (100 * 1000000) // ms in nanoseconds

typedef struct
{
	// The first field must be a reference to a Zend object.
	zend_object *std;
	zend_async_event_dispose_t prev_dispose;
} async_timeout_ext_t;

/**
 * Structure of an Awaitable interface object that holds a reference to an event object.
 */
typedef struct
{
	ZEND_ASYNC_EVENT_REF_PROLOG
	// Pointer to the event object, which is a timer event.
	zend_async_timer_event_t *event;
	zend_object std;
} async_timeout_object_t;

#define ASYNC_TIMEOUT_FROM_EVENT(ev) ((async_timeout_ext_t *) ((char *) (ev) + (ev)->extra_offset))
#define ASYNC_TIMEOUT_FROM_OBJ(obj) ((async_timeout_object_t *) ((char *) (obj) - (obj)->handlers->offset))

ZEND_BEGIN_MODULE_GLOBALS(async)
// Microtask queue
circular_buffer_t microtasks;
/* Queue of coroutine_queue */
circular_buffer_t coroutine_queue;
/* Queue of resumed coroutines for event cleanup */
circular_buffer_t resumed_coroutines;
/* List of coroutines  */
HashTable coroutines;
/* The transfer structure is used to return to the main execution context. */
zend_fiber_transfer *main_transfer;
/* The main flow stack */
zend_vm_stack main_vm_stack;
/* System root context */
zend_async_context_t *root_context;
/* The default concurrency */
int default_concurrency;

/* Fiber context pool for performance optimization */
circular_buffer_t fiber_context_pool;

/* The reactor */
uv_loop_t uvloop;
bool reactor_started;
HashTable active_io_handles; /* tracks all IO handles issued by the reactor */

/* Global signal management for all platforms */
HashTable *signal_handlers; /* signum -> uv_signal_t* */
HashTable *signal_events;   /* signum -> HashTable* (signal events) */
HashTable *process_events;  /* dedicated for SIGCHLD process events */

#ifdef PHP_WIN32
uv_thread_t *watcherThread;
HANDLE ioCompletionPort;
unsigned int countWaitingDescriptors;
bool isRunning;
uv_async_t *uvloop_wakeup;
/* Circular buffer of libuv_process_t ptr */
circular_buffer_t *pid_queue;
#endif

/* Reactor execution optimization */
uint64_t last_reactor_tick;

/* Debug: print coroutine wait info on deadlock detection */
bool debug_deadlock;

#ifdef PHP_WIN32
#endif
ZEND_END_MODULE_GLOBALS(async)

ZEND_EXTERN_MODULE_GLOBALS(async)

#define ASYNC_G(v) ZEND_MODULE_GLOBALS_ACCESSOR(async, v)
#define ASYNC_GLOBALS ZEND_MODULE_GLOBALS_BULK(async)

#if defined(ZTS) && defined(COMPILE_DL_ASYNC)
ZEND_TSRMLS_CACHE_EXTERN()
#endif

#endif // ASYNC_H