-
Notifications
You must be signed in to change notification settings - Fork 3.2k
/
Copy pathswoole_runtime.cc
1626 lines (1455 loc) · 54.6 KB
/
swoole_runtime.cc
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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
+----------------------------------------------------------------------+
| Swoole |
+----------------------------------------------------------------------+
| This source file is subject to version 2.0 of the Apache license, |
| that is bundled with this package in the file LICENSE, and is |
| available through the world-wide-web at the following url: |
| http://www.apache.org/licenses/LICENSE-2.0.html |
| If you did not receive a copy of the Apache2.0 license and are unable|
| to obtain it through the world-wide-web, please send a note to |
| [email protected] so we can mail you a copy immediately. |
+----------------------------------------------------------------------+
| Author: Tianfeng Han <[email protected]> |
+----------------------------------------------------------------------+
*/
#include "php_swoole_cxx.h"
#include "helper/scope_guard.h"
#include "thirdparty/php/standard/proc_open.h"
#include <unordered_map>
#include <initializer_list>
/* openssl */
#ifndef OPENSSL_NO_TLS1_METHOD
#define HAVE_TLS1 1
#endif
#ifndef OPENSSL_NO_TLS1_1_METHOD
#define HAVE_TLS11 1
#endif
#ifndef OPENSSL_NO_TLS1_2_METHOD
#define HAVE_TLS12 1
#endif
#if OPENSSL_VERSION_NUMBER >= 0x10101000 && !defined(OPENSSL_NO_TLS1_3)
#define HAVE_TLS13 1
#endif
#ifndef OPENSSL_NO_ECDH
#define HAVE_ECDH 1
#endif
#ifndef OPENSSL_NO_TLSEXT
#define HAVE_TLS_SNI 1
#if OPENSSL_VERSION_NUMBER >= 0x10002000L
#define HAVE_TLS_ALPN 1
#endif
#endif
#if OPENSSL_VERSION_NUMBER >= 0x10100000L && !defined(LIBRESSL_VERSION_NUMBER)
#define HAVE_SEC_LEVEL 1
#endif
using swoole::Coroutine;
using swoole::PHPCoroutine;
using swoole::coroutine::Socket;
using swoole::coroutine::System;
using swoole::coroutine::PollSocket;
SW_EXTERN_C_BEGIN
static PHP_METHOD(swoole_runtime, enableCoroutine);
static PHP_METHOD(swoole_runtime, getHookFlags);
static PHP_METHOD(swoole_runtime, setHookFlags);
static PHP_FUNCTION(swoole_sleep);
static PHP_FUNCTION(swoole_usleep);
static PHP_FUNCTION(swoole_time_nanosleep);
static PHP_FUNCTION(swoole_time_sleep_until);
static PHP_FUNCTION(swoole_stream_select);
static PHP_FUNCTION(swoole_stream_socket_pair);
static PHP_FUNCTION(swoole_user_func_handler);
SW_EXTERN_C_END
static int socket_set_option(php_stream *stream, int option, int value, void *ptrparam);
#if PHP_VERSION_ID < 70400
static size_t socket_read(php_stream *stream, char *buf, size_t count);
static size_t socket_write(php_stream *stream, const char *buf, size_t count);
#else
static ssize_t socket_read(php_stream *stream, char *buf, size_t count);
static ssize_t socket_write(php_stream *stream, const char *buf, size_t count);
#endif
static int socket_flush(php_stream *stream);
static int socket_close(php_stream *stream, int close_handle);
static int socket_stat(php_stream *stream, php_stream_statbuf *ssb);
static int socket_cast(php_stream *stream, int castas, void **ret);
// clang-format off
ZEND_BEGIN_ARG_INFO_EX(arginfo_swoole_void, 0, 0, 0)
ZEND_END_ARG_INFO()
ZEND_BEGIN_ARG_INFO_EX(arginfo_swoole_runtime_enableCoroutine, 0, 0, 0)
ZEND_ARG_INFO(0, enable)
ZEND_ARG_INFO(0, flags)
ZEND_END_ARG_INFO()
ZEND_BEGIN_ARG_INFO_EX(arginfo_swoole_runtime_setHookFlags, 0, 0, 1)
ZEND_ARG_INFO(0, flags)
ZEND_END_ARG_INFO()
static zend_class_entry *swoole_runtime_ce;
static php_stream_ops socket_ops
{
socket_write,
socket_read,
socket_close,
socket_flush,
"tcp_socket/coroutine",
nullptr, /* seek */
socket_cast,
socket_stat,
socket_set_option,
};
struct php_swoole_netstream_data_t
{
php_netstream_data_t stream;
Socket *socket;
bool blocking;
double read_timeout;
double write_timeout;
};
static bool hook_init = false;
static int hook_flags = 0;
static struct
{
php_stream_transport_factory tcp;
php_stream_transport_factory udp;
php_stream_transport_factory _unix;
php_stream_transport_factory udg;
php_stream_transport_factory ssl;
php_stream_transport_factory tls;
} ori_factory = {
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
};
static const zend_function_entry swoole_runtime_methods[] =
{
PHP_ME(swoole_runtime, enableCoroutine, arginfo_swoole_runtime_enableCoroutine, ZEND_ACC_PUBLIC | ZEND_ACC_STATIC)
PHP_ME(swoole_runtime, getHookFlags, arginfo_swoole_void, ZEND_ACC_PUBLIC | ZEND_ACC_STATIC)
PHP_ME(swoole_runtime, setHookFlags, arginfo_swoole_runtime_setHookFlags, ZEND_ACC_PUBLIC | ZEND_ACC_STATIC)
PHP_FE_END
};
// clang-format on
static php_stream_wrapper ori_php_plain_files_wrapper;
#if PHP_VERSION_ID < 70200
typedef void (*zif_handler)(INTERNAL_FUNCTION_PARAMETERS);
#endif
#define SW_HOOK_FUNC(f) hook_func(ZEND_STRL(#f), PHP_FN(swoole_##f))
#define SW_UNHOOK_FUNC(f) unhook_func(ZEND_STRL(#f))
static void hook_func(const char *name, size_t l_name, zif_handler handler = nullptr);
static void unhook_func(const char *name, size_t l_name);
static zend_array *function_table = nullptr;
SW_EXTERN_C_BEGIN
#include "ext/standard/file.h"
#include "thirdparty/php/streams/plain_wrapper.c"
SW_EXTERN_C_END
void php_swoole_runtime_minit(int module_number) {
SW_INIT_CLASS_ENTRY_BASE(
swoole_runtime, "Swoole\\Runtime", "swoole_runtime", nullptr, swoole_runtime_methods, nullptr);
SW_SET_CLASS_CREATE(swoole_runtime, sw_zend_create_object_deny);
SW_REGISTER_LONG_CONSTANT("SWOOLE_HOOK_TCP", PHPCoroutine::HOOK_TCP);
SW_REGISTER_LONG_CONSTANT("SWOOLE_HOOK_UDP", PHPCoroutine::HOOK_UDP);
SW_REGISTER_LONG_CONSTANT("SWOOLE_HOOK_UNIX", PHPCoroutine::HOOK_UNIX);
SW_REGISTER_LONG_CONSTANT("SWOOLE_HOOK_UDG", PHPCoroutine::HOOK_UDG);
SW_REGISTER_LONG_CONSTANT("SWOOLE_HOOK_SSL", PHPCoroutine::HOOK_SSL);
SW_REGISTER_LONG_CONSTANT("SWOOLE_HOOK_TLS", PHPCoroutine::HOOK_TLS);
SW_REGISTER_LONG_CONSTANT("SWOOLE_HOOK_STREAM_FUNCTION", PHPCoroutine::HOOK_STREAM_FUNCTION);
SW_REGISTER_LONG_CONSTANT("SWOOLE_HOOK_STREAM_SELECT", PHPCoroutine::HOOK_STREAM_FUNCTION); // backward compatibility
SW_REGISTER_LONG_CONSTANT("SWOOLE_HOOK_FILE", PHPCoroutine::HOOK_FILE);
SW_REGISTER_LONG_CONSTANT("SWOOLE_HOOK_SLEEP", PHPCoroutine::HOOK_SLEEP);
SW_REGISTER_LONG_CONSTANT("SWOOLE_HOOK_PROC", PHPCoroutine::HOOK_PROC);
SW_REGISTER_LONG_CONSTANT("SWOOLE_HOOK_CURL", PHPCoroutine::HOOK_CURL);
SW_REGISTER_LONG_CONSTANT("SWOOLE_HOOK_BLOCKING_FUNCTION", PHPCoroutine::HOOK_BLOCKING_FUNCTION);
SW_REGISTER_LONG_CONSTANT("SWOOLE_HOOK_ALL", PHPCoroutine::HOOK_ALL);
swoole_proc_open_init(module_number);
}
struct real_func {
zend_function *function;
zif_handler ori_handler;
zend_fcall_info_cache *fci_cache;
zval name;
};
void php_swoole_runtime_rshutdown() {
if (!hook_init) {
return;
}
hook_init = false;
void *ptr;
ZEND_HASH_FOREACH_PTR(function_table, ptr) {
real_func *rf = reinterpret_cast<real_func *>(ptr);
/**
* php library function
*/
if (rf->fci_cache) {
zval_dtor(&rf->name);
efree(rf->fci_cache);
}
rf->function->internal_function.handler = rf->ori_handler;
efree(rf);
}
ZEND_HASH_FOREACH_END();
zend_hash_destroy(function_table);
efree(function_table);
function_table = nullptr;
}
static inline char *parse_ip_address_ex(const char *str, size_t str_len, int *portno, int get_err, zend_string **err) {
char *colon;
char *host = nullptr;
char *p;
if (*(str) == '[' && str_len > 1) {
/* IPV6 notation to specify raw address with port (i.e. [fe80::1]:80) */
p = (char *) memchr(str + 1, ']', str_len - 2);
if (!p || *(p + 1) != ':') {
if (get_err) {
*err = strpprintf(0, "Failed to parse IPv6 address \"%s\"", str);
}
return nullptr;
}
*portno = atoi(p + 2);
return estrndup(str + 1, p - str - 1);
}
if (str_len) {
colon = (char *) memchr(str, ':', str_len - 1);
} else {
colon = nullptr;
}
if (colon) {
*portno = atoi(colon + 1);
host = estrndup(str, colon - str);
} else {
if (get_err) {
*err = strpprintf(0, "Failed to parse address \"%s\"", str);
}
return nullptr;
}
return host;
}
#if PHP_VERSION_ID < 70400
static size_t socket_write(php_stream *stream, const char *buf, size_t count)
#else
static ssize_t socket_write(php_stream *stream, const char *buf, size_t count)
#endif
{
php_swoole_netstream_data_t *abstract;
Socket *sock;
ssize_t didwrite = -1;
abstract = (php_swoole_netstream_data_t *) stream->abstract;
if (UNEXPECTED(!abstract)) {
goto _exit;
}
sock = (Socket *) abstract->socket;
if (UNEXPECTED(!sock)) {
goto _exit;
}
didwrite = sock->send_all(buf, count);
if (didwrite < 0 || (size_t) didwrite != count) {
/* we do not expect the outer layer to continue to call the send syscall in a loop
* and didwrite is meaningless if it failed */
didwrite = -1;
abstract->stream.timeout_event = (sock->errCode == ETIMEDOUT);
php_error_docref(NULL,
E_NOTICE,
"Send of " ZEND_LONG_FMT " bytes failed with errno=%d %s",
(zend_long) count,
sock->errCode,
sock->errMsg);
} else {
php_stream_notify_progress_increment(PHP_STREAM_CONTEXT(stream), didwrite, 0);
}
_exit:
#if PHP_VERSION_ID < 70400
if (didwrite < 0) {
didwrite = 0;
}
#endif
return didwrite;
}
#if PHP_VERSION_ID < 70400
static size_t socket_read(php_stream *stream, char *buf, size_t count)
#else
static ssize_t socket_read(php_stream *stream, char *buf, size_t count)
#endif
{
php_swoole_netstream_data_t *abstract;
Socket *sock;
ssize_t nr_bytes = -1;
abstract = (php_swoole_netstream_data_t *) stream->abstract;
if (UNEXPECTED(!abstract)) {
goto _exit;
}
sock = (Socket *) abstract->socket;
if (UNEXPECTED(!sock)) {
goto _exit;
}
nr_bytes = sock->recv(buf, count);
/**
* sock->errCode != ETIMEDOUT : Compatible with sync blocking IO
*/
stream->eof = (nr_bytes == 0 || (nr_bytes == -1 && sock->errCode != ETIMEDOUT &&
sock->get_socket()->catch_error(sock->errCode) == SW_CLOSE));
if (nr_bytes > 0) {
php_stream_notify_progress_increment(PHP_STREAM_CONTEXT(stream), nr_bytes, 0);
}
_exit:
#if PHP_VERSION_ID < 70400
if (nr_bytes < 0) {
nr_bytes = 0;
}
#endif
return nr_bytes;
}
static int socket_flush(php_stream *stream) {
return 0;
}
static int socket_close(php_stream *stream, int close_handle) {
php_swoole_netstream_data_t *abstract = (php_swoole_netstream_data_t *) stream->abstract;
if (UNEXPECTED(!abstract)) {
return FAILURE;
}
/** set it null immediately */
stream->abstract = nullptr;
Socket *sock = (Socket *) abstract->socket;
if (UNEXPECTED(!sock)) {
return FAILURE;
}
/**
* it's always successful (even if the destructor rule is violated)
* every calls passes through the hook function in PHP
* so there is unnecessary to worry about the null pointer.
*/
sock->close();
delete sock;
efree(abstract);
return SUCCESS;
}
enum {
STREAM_XPORT_OP_BIND,
STREAM_XPORT_OP_CONNECT,
STREAM_XPORT_OP_LISTEN,
STREAM_XPORT_OP_ACCEPT,
STREAM_XPORT_OP_CONNECT_ASYNC,
STREAM_XPORT_OP_GET_NAME,
STREAM_XPORT_OP_GET_PEER_NAME,
STREAM_XPORT_OP_RECV,
STREAM_XPORT_OP_SEND,
STREAM_XPORT_OP_SHUTDOWN,
};
enum { STREAM_XPORT_CRYPTO_OP_SETUP, STREAM_XPORT_CRYPTO_OP_ENABLE };
static int socket_cast(php_stream *stream, int castas, void **ret) {
php_swoole_netstream_data_t *abstract = (php_swoole_netstream_data_t *) stream->abstract;
if (UNEXPECTED(!abstract)) {
return FAILURE;
}
Socket *sock = (Socket *) abstract->socket;
if (UNEXPECTED(!sock)) {
return FAILURE;
}
switch (castas) {
case PHP_STREAM_AS_STDIO:
if (ret) {
*(FILE **) ret = fdopen(sock->get_fd(), stream->mode);
if (*ret) {
return SUCCESS;
}
return FAILURE;
}
return SUCCESS;
case PHP_STREAM_AS_FD_FOR_SELECT:
case PHP_STREAM_AS_FD:
case PHP_STREAM_AS_SOCKETD:
if (ret) *(php_socket_t *) ret = sock->get_fd();
return SUCCESS;
default:
return FAILURE;
}
}
static int socket_stat(php_stream *stream, php_stream_statbuf *ssb) {
php_swoole_netstream_data_t *abstract = (php_swoole_netstream_data_t *) stream->abstract;
if (UNEXPECTED(!abstract)) {
return FAILURE;
}
Socket *sock = (Socket *) abstract->socket;
if (UNEXPECTED(!sock)) {
return FAILURE;
}
return zend_fstat(sock->get_fd(), &ssb->sb);
}
static inline int socket_connect(php_stream *stream, Socket *sock, php_stream_xport_param *xparam) {
char *host = nullptr, *bindto = nullptr;
int portno = 0, bindport = 0;
int ret = 0;
zval *tmpzval = nullptr;
char *ip_address = nullptr;
if (UNEXPECTED(sock->get_fd() < 0)) {
return FAILURE;
}
if (sock->get_socket()->is_inet()) {
ip_address = parse_ip_address_ex(
xparam->inputs.name, xparam->inputs.namelen, &portno, xparam->want_errortext, &xparam->outputs.error_text);
host = ip_address;
if (sock->get_sock_type() == SOCK_STREAM) {
int sockoptval = 1;
setsockopt(sock->get_fd(), IPPROTO_TCP, TCP_NODELAY, (char *) &sockoptval, sizeof(sockoptval));
}
} else {
host = xparam->inputs.name;
}
if (host == nullptr) {
return FAILURE;
}
ON_SCOPE_EXIT {
if (ip_address) {
efree(ip_address);
}
};
if (PHP_STREAM_CONTEXT(stream) &&
(tmpzval = php_stream_context_get_option(PHP_STREAM_CONTEXT(stream), "socket", "bindto")) != nullptr) {
if (Z_TYPE_P(tmpzval) != IS_STRING) {
if (xparam->want_errortext) {
xparam->outputs.error_text = strpprintf(0, "local_addr context option is not a string.");
}
return FAILURE;
}
bindto = parse_ip_address_ex(
Z_STRVAL_P(tmpzval), Z_STRLEN_P(tmpzval), &bindport, xparam->want_errortext, &xparam->outputs.error_text);
if (bindto == nullptr) {
return FAILURE;
}
ON_SCOPE_EXIT {
if (bindto) {
efree(bindto);
}
};
if (!sock->bind(bindto, bindport)) {
return FAILURE;
}
}
if (xparam->inputs.timeout) {
sock->set_timeout(xparam->inputs.timeout, Socket::TIMEOUT_CONNECT);
}
if (sock->connect(host, portno) == false) {
xparam->outputs.error_code = sock->errCode;
if (sock->errMsg) {
xparam->outputs.error_text = zend_string_init(sock->errMsg, strlen(sock->errMsg), 0);
}
ret = -1;
}
return ret;
}
static inline int socket_bind(php_stream *stream, Socket *sock, php_stream_xport_param *xparam STREAMS_DC) {
char *host = nullptr;
int portno = 0;
char *ip_address = nullptr;
if (sock->get_socket()->is_inet()) {
ip_address = parse_ip_address_ex(
xparam->inputs.name, xparam->inputs.namelen, &portno, xparam->want_errortext, &xparam->outputs.error_text);
host = ip_address;
} else {
host = xparam->inputs.name;
}
int ret = sock->bind(host, portno) ? 0 : -1;
if (ip_address) {
efree(ip_address);
}
return ret;
}
static inline int socket_accept(php_stream *stream, Socket *sock, php_stream_xport_param *xparam STREAMS_DC) {
int tcp_nodelay = 0;
zval *tmpzval = nullptr;
xparam->outputs.client = nullptr;
if ((nullptr != PHP_STREAM_CONTEXT(stream)) &&
(tmpzval = php_stream_context_get_option(PHP_STREAM_CONTEXT(stream), "socket", "tcp_nodelay")) != nullptr &&
zval_is_true(tmpzval)) {
tcp_nodelay = 1;
}
zend_string **textaddr = xparam->want_textaddr ? &xparam->outputs.textaddr : nullptr;
struct sockaddr **addr = xparam->want_addr ? &xparam->outputs.addr : nullptr;
socklen_t *addrlen = xparam->want_addr ? &xparam->outputs.addrlen : nullptr;
struct timeval *timeout = xparam->inputs.timeout;
zend_string **error_string = xparam->want_errortext ? &xparam->outputs.error_text : nullptr;
int *error_code = &xparam->outputs.error_code;
int error = 0;
php_sockaddr_storage sa;
socklen_t sl = sizeof(sa);
if (timeout) {
sock->set_timeout(timeout, Socket::TIMEOUT_READ);
}
Socket *clisock = sock->accept();
#ifdef SW_USE_OPENSSL
if (clisock != nullptr && clisock->open_ssl) {
if (!clisock->ssl_handshake()) {
sock->errCode = clisock->errCode;
delete clisock;
clisock = nullptr;
}
}
#endif
if (clisock == nullptr) {
error = sock->errCode;
if (error_code) {
*error_code = error;
}
if (error_string) {
*error_string = php_socket_error_str(error);
}
return FAILURE;
} else {
php_network_populate_name_from_sockaddr((struct sockaddr *) &sa, sl, textaddr, addr, addrlen);
#ifdef TCP_NODELAY
if (tcp_nodelay) {
setsockopt(clisock->get_fd(), IPPROTO_TCP, TCP_NODELAY, (char *) &tcp_nodelay, sizeof(tcp_nodelay));
}
#endif
php_swoole_netstream_data_t *abstract = (php_swoole_netstream_data_t *) emalloc(sizeof(*abstract));
memset(abstract, 0, sizeof(*abstract));
abstract->socket = clisock;
abstract->blocking = true;
xparam->outputs.client = php_stream_alloc_rel(stream->ops, (void *) abstract, nullptr, "r+");
if (xparam->outputs.client) {
xparam->outputs.client->ctx = stream->ctx;
if (stream->ctx) {
GC_ADDREF(stream->ctx);
}
}
return 0;
}
}
static inline int socket_recvfrom(
Socket *sock, char *buf, size_t buflen, zend_string **textaddr, struct sockaddr **addr, socklen_t *addrlen) {
int ret;
int want_addr = textaddr || addr;
if (want_addr) {
php_sockaddr_storage sa;
socklen_t sl = sizeof(sa);
ret = sock->recvfrom(buf, buflen, (struct sockaddr *) &sa, &sl);
if (sl) {
php_network_populate_name_from_sockaddr((struct sockaddr *) &sa, sl, textaddr, addr, addrlen);
} else {
if (textaddr) {
*textaddr = ZSTR_EMPTY_ALLOC();
}
if (addr) {
*addr = nullptr;
*addrlen = 0;
}
}
} else {
ret = sock->recv(buf, buflen);
}
return ret;
}
static inline int socket_sendto(
Socket *sock, const char *buf, size_t buflen, struct sockaddr *addr, socklen_t addrlen) {
if (addr) {
return sendto(sock->get_fd(), buf, buflen, 0, addr, addrlen);
} else {
return sock->send(buf, buflen);
}
}
#ifdef SW_USE_OPENSSL
#define GET_VER_OPT(name) \
(PHP_STREAM_CONTEXT(stream) && \
(val = php_stream_context_get_option(PHP_STREAM_CONTEXT(stream), "ssl", name)) != nullptr)
#define GET_VER_OPT_STRING(name, str) \
if (GET_VER_OPT(name)) { \
convert_to_string_ex(val); \
str = Z_STRVAL_P(val); \
}
#define GET_VER_OPT_LONG(name, num) \
if (GET_VER_OPT(name)) { \
convert_to_long_ex(val); \
num = Z_LVAL_P(val); \
}
static int socket_setup_crypto(php_stream *stream, Socket *sock, php_stream_xport_crypto_param *cparam STREAMS_DC) {
return 0;
}
static int socket_enable_crypto(php_stream *stream, Socket *sock, php_stream_xport_crypto_param *cparam STREAMS_DC) {
if (cparam->inputs.activate && !sock->is_ssl_enable()) {
return sock->ssl_handshake() ? 0 : -1;
} else if (!cparam->inputs.activate && sock->is_ssl_enable()) {
return sock->ssl_shutdown() ? 0 : -1;
}
return -1;
}
#endif
static inline int socket_xport_api(php_stream *stream, Socket *sock, php_stream_xport_param *xparam STREAMS_DC) {
static const int shutdown_how[] = {SHUT_RD, SHUT_WR, SHUT_RDWR};
switch (xparam->op) {
case STREAM_XPORT_OP_LISTEN: {
xparam->outputs.returncode = sock->listen(xparam->inputs.backlog) ? 0 : -1;
break;
}
case STREAM_XPORT_OP_CONNECT:
case STREAM_XPORT_OP_CONNECT_ASYNC:
xparam->outputs.returncode = socket_connect(stream, sock, xparam);
break;
case STREAM_XPORT_OP_BIND: {
if (sock->get_sock_domain() != AF_UNIX) {
zval *tmpzval = nullptr;
int sockoptval = 1;
php_stream_context *ctx = PHP_STREAM_CONTEXT(stream);
if (!ctx) {
break;
}
#ifdef SO_REUSEADDR
setsockopt(sock->get_fd(), SOL_SOCKET, SO_REUSEADDR, (char *) &sockoptval, sizeof(sockoptval));
#endif
#ifdef SO_REUSEPORT
if ((tmpzval = php_stream_context_get_option(ctx, "socket", "so_reuseport")) != nullptr &&
zval_is_true(tmpzval)) {
setsockopt(sock->get_fd(), SOL_SOCKET, SO_REUSEPORT, (char *) &sockoptval, sizeof(sockoptval));
}
#endif
#ifdef SO_BROADCAST
if ((tmpzval = php_stream_context_get_option(ctx, "socket", "so_broadcast")) != nullptr &&
zval_is_true(tmpzval)) {
setsockopt(sock->get_fd(), SOL_SOCKET, SO_BROADCAST, (char *) &sockoptval, sizeof(sockoptval));
}
#endif
}
xparam->outputs.returncode = socket_bind(stream, sock, xparam STREAMS_CC);
break;
}
case STREAM_XPORT_OP_ACCEPT:
xparam->outputs.returncode = socket_accept(stream, sock, xparam STREAMS_CC);
break;
case STREAM_XPORT_OP_GET_NAME:
xparam->outputs.returncode =
php_network_get_sock_name(sock->get_fd(),
xparam->want_textaddr ? &xparam->outputs.textaddr : nullptr,
xparam->want_addr ? &xparam->outputs.addr : nullptr,
xparam->want_addr ? &xparam->outputs.addrlen : nullptr);
break;
case STREAM_XPORT_OP_GET_PEER_NAME:
xparam->outputs.returncode =
php_network_get_peer_name(sock->get_fd(),
xparam->want_textaddr ? &xparam->outputs.textaddr : nullptr,
xparam->want_addr ? &xparam->outputs.addr : nullptr,
xparam->want_addr ? &xparam->outputs.addrlen : nullptr);
break;
case STREAM_XPORT_OP_SEND:
if ((xparam->inputs.flags & STREAM_OOB) == STREAM_OOB) {
php_swoole_error(E_WARNING, "STREAM_OOB flags is not supports");
xparam->outputs.returncode = -1;
break;
}
xparam->outputs.returncode =
socket_sendto(sock, xparam->inputs.buf, xparam->inputs.buflen, xparam->inputs.addr, xparam->inputs.addrlen);
if (xparam->outputs.returncode == -1) {
char *err = php_socket_strerror(php_socket_errno(), nullptr, 0);
php_error_docref(nullptr, E_WARNING, "%s\n", err);
efree(err);
}
break;
case STREAM_XPORT_OP_RECV:
if ((xparam->inputs.flags & STREAM_OOB) == STREAM_OOB) {
php_swoole_error(E_WARNING, "STREAM_OOB flags is not supports");
xparam->outputs.returncode = -1;
break;
}
if ((xparam->inputs.flags & STREAM_PEEK) == STREAM_PEEK) {
xparam->outputs.returncode = sock->peek(xparam->inputs.buf, xparam->inputs.buflen);
} else {
xparam->outputs.returncode = socket_recvfrom(sock,
xparam->inputs.buf,
xparam->inputs.buflen,
xparam->want_textaddr ? &xparam->outputs.textaddr : nullptr,
xparam->want_addr ? &xparam->outputs.addr : nullptr,
xparam->want_addr ? &xparam->outputs.addrlen : nullptr);
}
break;
case STREAM_XPORT_OP_SHUTDOWN:
xparam->outputs.returncode = sock->shutdown(shutdown_how[xparam->how]);
break;
default:
#ifdef SW_DEBUG
php_swoole_fatal_error(E_WARNING, "socket_xport_api: unsupported option %d", xparam->op);
#endif
break;
}
return PHP_STREAM_OPTION_RETURN_OK;
}
static int socket_set_option(php_stream *stream, int option, int value, void *ptrparam) {
php_swoole_netstream_data_t *abstract = (php_swoole_netstream_data_t *) stream->abstract;
if (UNEXPECTED(!abstract || !abstract->socket)) {
return PHP_STREAM_OPTION_RETURN_ERR;
}
Socket *sock = (Socket *) abstract->socket;
switch (option) {
case PHP_STREAM_OPTION_BLOCKING:
if (abstract->blocking == (bool) value) {
break;
}
abstract->blocking = (bool) value;
if (abstract->blocking) {
sock->set_timeout(abstract->read_timeout, Socket::TIMEOUT_READ);
sock->set_timeout(abstract->write_timeout, Socket::TIMEOUT_WRITE);
} else {
abstract->read_timeout = sock->get_timeout(Socket::TIMEOUT_READ);
abstract->write_timeout = sock->get_timeout(Socket::TIMEOUT_WRITE);
sock->set_timeout(0.001, Socket::TIMEOUT_READ | Socket::TIMEOUT_WRITE);
}
break;
case PHP_STREAM_OPTION_XPORT_API: {
return socket_xport_api(stream, sock, (php_stream_xport_param *) ptrparam STREAMS_CC);
}
case PHP_STREAM_OPTION_META_DATA_API: {
#ifdef SW_USE_OPENSSL
SSL *ssl = sock->get_socket() ? sock->get_socket()->ssl : nullptr;
if (ssl) {
zval tmp;
const char *proto_str;
const SSL_CIPHER *cipher;
array_init(&tmp);
switch (SSL_version(ssl)) {
#ifdef HAVE_TLS13
case TLS1_3_VERSION:
proto_str = "TLSv1.3";
break;
#endif
#ifdef HAVE_TLS12
case TLS1_2_VERSION:
proto_str = "TLSv1.2";
break;
#endif
#ifdef HAVE_TLS11
case TLS1_1_VERSION:
proto_str = "TLSv1.1";
break;
#endif
case TLS1_VERSION:
proto_str = "TLSv1";
break;
#ifdef HAVE_SSL3
case SSL3_VERSION:
proto_str = "SSLv3";
break;
#endif
default:
proto_str = "UNKNOWN";
break;
}
cipher = SSL_get_current_cipher(ssl);
add_assoc_string(&tmp, "protocol", (char *) proto_str);
add_assoc_string(&tmp, "cipher_name", (char *) SSL_CIPHER_get_name(cipher));
add_assoc_long(&tmp, "cipher_bits", SSL_CIPHER_get_bits(cipher, nullptr));
add_assoc_string(&tmp, "cipher_version", (char *) SSL_CIPHER_get_version(cipher));
add_assoc_zval((zval *) ptrparam, "crypto", &tmp);
}
#endif
add_assoc_bool((zval *) ptrparam, "timed_out", sock->errCode == ETIMEDOUT);
add_assoc_bool((zval *) ptrparam, "eof", stream->eof);
add_assoc_bool((zval *) ptrparam, "blocked", 1);
break;
}
case PHP_STREAM_OPTION_READ_TIMEOUT: {
abstract->socket->set_timeout((struct timeval *) ptrparam, Socket::TIMEOUT_READ);
break;
}
#ifdef SW_USE_OPENSSL
case PHP_STREAM_OPTION_CRYPTO_API: {
php_stream_xport_crypto_param *cparam = (php_stream_xport_crypto_param *) ptrparam;
switch (cparam->op) {
case STREAM_XPORT_CRYPTO_OP_SETUP:
cparam->outputs.returncode = socket_setup_crypto(stream, sock, cparam STREAMS_CC);
return PHP_STREAM_OPTION_RETURN_OK;
case STREAM_XPORT_CRYPTO_OP_ENABLE:
cparam->outputs.returncode = socket_enable_crypto(stream, sock, cparam STREAMS_CC);
return PHP_STREAM_OPTION_RETURN_OK;
default:
/* never here */
SW_ASSERT(0);
break;
}
break;
}
#endif
case PHP_STREAM_OPTION_CHECK_LIVENESS: {
return sock->check_liveness() ? PHP_STREAM_OPTION_RETURN_OK : PHP_STREAM_OPTION_RETURN_ERR;
}
case PHP_STREAM_OPTION_READ_BUFFER:
case PHP_STREAM_OPTION_WRITE_BUFFER: {
// TODO: read/write buffer
break;
}
default:
#ifdef SW_DEBUG
php_swoole_fatal_error(E_WARNING, "socket_set_option: unsupported option %d with value %d", option, value);
#endif
break;
}
return PHP_STREAM_OPTION_RETURN_OK;
}
static php_stream *socket_create(const char *proto,
size_t protolen,
const char *resourcename,
size_t resourcenamelen,
const char *persistent_id,
int options,
int flags,
struct timeval *timeout,
php_stream_context *context STREAMS_DC) {
php_stream *stream = nullptr;
php_swoole_netstream_data_t *abstract = nullptr;
Socket *sock;
Coroutine::get_current_safe();
if (SW_STREQ(proto, protolen, "tcp")) {
_tcp:
sock = new Socket(resourcename[0] == '[' ? SW_SOCK_TCP6 : SW_SOCK_TCP);
} else if (SW_STREQ(proto, protolen, "ssl") || SW_STREQ(proto, protolen, "tls")) {
#ifdef SW_USE_OPENSSL
sock = new Socket(resourcename[0] == '[' ? SW_SOCK_TCP6 : SW_SOCK_TCP);
sock->open_ssl = true;
#else
php_swoole_error(E_WARNING,
"you must configure with `--enable-openssl` to support ssl connection when compiling Swoole");
return nullptr;
#endif
} else if (SW_STREQ(proto, protolen, "unix")) {
sock = new Socket(SW_SOCK_UNIX_STREAM);
} else if (SW_STREQ(proto, protolen, "udp")) {
sock = new Socket(SW_SOCK_UDP);
} else if (SW_STREQ(proto, protolen, "udg")) {
sock = new Socket(SW_SOCK_UNIX_DGRAM);
} else {
/* abort? */
goto _tcp;
}
if (UNEXPECTED(sock->get_fd() < 0)) {
_failed:
if (!stream) {
delete sock;
} else {
php_stream_close(stream);
}
return nullptr;
}
sock->set_zero_copy(true);
abstract = (php_swoole_netstream_data_t *) ecalloc(1, sizeof(*abstract));
abstract->socket = sock;
abstract->stream.socket = sock->get_fd();
abstract->blocking = true;
persistent_id = nullptr; // prevent stream api in user level using pconnect to persist the socket
stream = php_stream_alloc_rel(&socket_ops, abstract, persistent_id, "r+");
if (stream == nullptr) {
goto _failed;
}
if (context && ZVAL_IS_ARRAY(&context->options)) {
#ifdef SW_USE_OPENSSL
zval *ztmp;
if (sock->open_ssl && php_swoole_array_get_value(Z_ARRVAL_P(&context->options), "ssl", ztmp) &&
ZVAL_IS_ARRAY(ztmp)) {
[](Socket *sock, HashTable *options) {
zval zalias, *ztmp;
array_init(&zalias);
#define SSL_OPTION_ALIAS(name, alias) \
do { \
if (php_swoole_array_get_value(options, name, ztmp)) { \
add_assoc_zval_ex(&zalias, ZEND_STRL(alias), ztmp); \
} \
} while (0);
SSL_OPTION_ALIAS("peer_name", "ssl_host_name");
SSL_OPTION_ALIAS("verify_peer", "ssl_verify_peer");
SSL_OPTION_ALIAS("allow_self_signed", "ssl_allow_self_signed");
SSL_OPTION_ALIAS("cafile", "ssl_cafile");
SSL_OPTION_ALIAS("capath", "ssl_capath");
SSL_OPTION_ALIAS("local_cert", "ssl_cert_file");
SSL_OPTION_ALIAS("local_pk", "ssl_key_file");
SSL_OPTION_ALIAS("passphrase", "ssl_passphrase");
SSL_OPTION_ALIAS("verify_depth", "ssl_verify_depth");
SSL_OPTION_ALIAS("disable_compression", "ssl_disable_compression");
#undef SSL_OPTION_ALIAS
php_swoole_socket_set_ssl(sock, &zalias);
zend_array_destroy(Z_ARRVAL(zalias));
}(sock, Z_ARRVAL_P(ztmp));
}
#endif
}
return stream;
}
bool PHPCoroutine::enable_hook(uint32_t flags) {
if (!hook_init) {
HashTable *xport_hash = php_stream_xport_get_hash();
// php_stream
ori_factory.tcp = (php_stream_transport_factory) zend_hash_str_find_ptr(xport_hash, ZEND_STRL("tcp"));
ori_factory.udp = (php_stream_transport_factory) zend_hash_str_find_ptr(xport_hash, ZEND_STRL("udp"));
ori_factory._unix = (php_stream_transport_factory) zend_hash_str_find_ptr(xport_hash, ZEND_STRL("unix"));
ori_factory.udg = (php_stream_transport_factory) zend_hash_str_find_ptr(xport_hash, ZEND_STRL("udg"));
ori_factory.ssl = (php_stream_transport_factory) zend_hash_str_find_ptr(xport_hash, ZEND_STRL("ssl"));
ori_factory.tls = (php_stream_transport_factory) zend_hash_str_find_ptr(xport_hash, ZEND_STRL("tls"));
// file
memcpy((void *) &ori_php_plain_files_wrapper, &php_plain_files_wrapper, sizeof(php_plain_files_wrapper));
function_table = (zend_array *) emalloc(sizeof(zend_array));
zend_hash_init(function_table, 8, nullptr, nullptr, 0);
hook_init = true;
}
// php_stream
if (flags & PHPCoroutine::HOOK_TCP) {
if (!(hook_flags & PHPCoroutine::HOOK_TCP)) {
if (php_stream_xport_register("tcp", socket_create) != SUCCESS) {
flags ^= PHPCoroutine::HOOK_TCP;
}
}
} else {
if (hook_flags & PHPCoroutine::HOOK_TCP) {
php_stream_xport_register("tcp", ori_factory.tcp);
}
}
if (flags & PHPCoroutine::HOOK_UDP) {
if (!(hook_flags & PHPCoroutine::HOOK_UDP)) {
if (php_stream_xport_register("udp", socket_create) != SUCCESS) {
flags ^= PHPCoroutine::HOOK_UDP;