forked from php/php-src
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathpcntl.c
1869 lines (1606 loc) · 48.3 KB
/
pcntl.c
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
/*
+----------------------------------------------------------------------+
| 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: Jason Greene <jason@inetgurus.net> |
+----------------------------------------------------------------------+
*/
#define PCNTL_DEBUG 0
#if PCNTL_DEBUG
#define DEBUG_OUT printf("DEBUG: ");printf
#define IF_DEBUG(z) z
#else
#define IF_DEBUG(z)
#endif
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include "php.h"
#include "ext/standard/info.h"
#include "php_signal.h"
#include "php_ticks.h"
#include "zend_fibers.h"
#if defined(HAVE_GETPRIORITY) || defined(HAVE_SETPRIORITY) || defined(HAVE_WAIT3)
#include <sys/wait.h>
#include <sys/time.h>
#include <sys/resource.h>
#endif
#ifdef HAVE_WAITID
#if defined (HAVE_DECL_P_ALL) && HAVE_DECL_P_ALL == 1
#define HAVE_POSIX_IDTYPES 1
#endif
#if defined (HAVE_DECL_P_PIDFD) && HAVE_DECL_P_PIDFD == 1
#define HAVE_LINUX_IDTYPES 1
#endif
#if defined (HAVE_DECL_P_UID) && HAVE_DECL_P_UID == 1
#define HAVE_NETBSD_IDTYPES 1
#endif
#if defined (HAVE_DECL_P_JAILID) && HAVE_DECL_P_JAILID == 1
#define HAVE_FREEBSD_IDTYPES 1
#endif
#endif
#include "php_pcntl.h"
#include <errno.h>
#if defined(HAVE_UNSHARE) || defined(HAVE_SCHED_SETAFFINITY) || defined(HAVE_SCHED_GETCPU)
#include <sched.h>
#if defined(__FreeBSD__)
#include <sys/types.h>
#include <sys/cpuset.h>
typedef cpuset_t cpu_set_t;
#endif
#define PCNTL_CPUSET(mask) &mask
#define PCNTL_CPUSET_SIZE(mask) sizeof(mask)
#define PCNTL_CPU_ISSET(i, mask) CPU_ISSET(i, &mask)
#define PCNTL_CPU_SET(i, mask) CPU_SET(i, &mask)
#define PCNTL_CPU_ZERO(mask) CPU_ZERO(&mask)
#define PCNTL_CPU_DESTROY(mask) ((void)0)
#elif defined(__NetBSD__)
#include <sys/syscall.h>
#include <sched.h>
typedef cpuset_t *cpu_set_t;
#define sched_getaffinity(p, c, m) syscall(SYS__sched_getaffinity, p, 0, c, m)
#define sched_setaffinity(p, c, m) syscall(SYS__sched_setaffinity, p, 0, c, m)
#define PCNTL_CPUSET(mask) mask
#define PCNTL_CPUSET_SIZE(mask) cpuset_size(mask)
#define PCNTL_CPU_ISSET(i, mask) cpuset_isset((cpuid_t)i, mask)
#define PCNTL_CPU_SET(i, mask) cpuset_set((cpuid_t)i, mask)
#define PCNTL_CPU_ZERO(mask) \
do { \
mask = cpuset_create(); \
if (UNEXPECTED(!mask)) { \
php_error_docref(NULL, E_WARNING, "cpuset_create: Insufficient memory"); \
RETURN_FALSE; \
} \
cpuset_zero(mask); \
} while(0)
#define PCNTL_CPU_DESTROY(mask) cpuset_destroy(mask)
#define HAVE_SCHED_SETAFFINITY 1
#elif defined(HAVE_PSET_BIND)
#include <sys/pset.h>
typedef psetid_t cpu_set_t;
#define sched_getaffinity(p, c, m) pset_bind(PS_QUERY, P_PID, (p <= 0 ? getpid() : p), &m)
#define sched_setaffinity(p, c, m) pset_bind(m, P_PID, (p <= 0 ? getpid() : p), NULL)
#define PCNTL_CPUSET(mask) mask
#define PCNTL_CPU_ISSET(i, mask) (pset_assign(PS_QUERY, (processorid_t)i, &query) == 0 && query == mask)
#define PCNTL_CPU_SET(i, mask) pset_assign(mask, (processorid_t)i, NULL)
#define PCNTL_CPU_ZERO(mask) \
psetid_t query; \
do { \
if (UNEXPECTED(pset_create(&mask) != 0)) { \
php_error_docref(NULL, E_WARNING, "pset_create: %s", strerror(errno)); \
RETURN_FALSE; \
} \
} while (0)
#define PCNTL_CPU_DESTROY(mask) \
do { \
if (UNEXPECTED(mask != PS_NONE && pset_destroy(mask) != 0)) { \
php_error_docref(NULL, E_WARNING, "pset_destroy: %s", strerror(errno)); \
} \
} while (0)
#define HAVE_SCHED_SETAFFINITY 1
#endif
#if defined(HAVE_GETCPUID)
#include <sys/processor.h>
#define sched_getcpu getcpuid
#define HAVE_SCHED_GETCPU 1
#endif
#if defined(HAVE_PTHREAD_SET_QOS_CLASS_SELF_NP)
#include <pthread/qos.h>
#endif
#ifdef HAVE_PIDFD_OPEN
#include <sys/syscall.h>
#endif
#ifdef HAVE_FORKX
#include <sys/fork.h>
#endif
#ifndef NSIG
# define NSIG 32
#endif
#define LONG_CONST(c) (zend_long) c
#include "Zend/zend_enum.h"
#include "Zend/zend_max_execution_timer.h"
#include "pcntl_arginfo.h"
static zend_class_entry *QosClass_ce;
ZEND_DECLARE_MODULE_GLOBALS(pcntl)
static PHP_GINIT_FUNCTION(pcntl);
zend_module_entry pcntl_module_entry = {
STANDARD_MODULE_HEADER,
"pcntl",
ext_functions,
PHP_MINIT(pcntl),
NULL,
PHP_RINIT(pcntl),
PHP_RSHUTDOWN(pcntl),
PHP_MINFO(pcntl),
PHP_PCNTL_VERSION,
PHP_MODULE_GLOBALS(pcntl),
PHP_GINIT(pcntl),
NULL,
NULL,
STANDARD_MODULE_PROPERTIES_EX
};
#ifdef COMPILE_DL_PCNTL
#ifdef ZTS
ZEND_TSRMLS_CACHE_DEFINE()
#endif
ZEND_GET_MODULE(pcntl)
#endif
static void (*orig_interrupt_function)(zend_execute_data *execute_data);
#ifdef HAVE_STRUCT_SIGINFO_T
static void pcntl_signal_handler(int, siginfo_t*, void*);
static void pcntl_siginfo_to_zval(int, siginfo_t*, zval*);
#else
static void pcntl_signal_handler(int);
#endif
static void pcntl_signal_dispatch(void);
static void pcntl_signal_dispatch_tick_function(int dummy_int, void *dummy_pointer);
static void pcntl_interrupt_function(zend_execute_data *execute_data);
static PHP_GINIT_FUNCTION(pcntl)
{
#if defined(COMPILE_DL_PCNTL) && defined(ZTS)
ZEND_TSRMLS_CACHE_UPDATE();
#endif
memset(pcntl_globals, 0, sizeof(*pcntl_globals));
}
PHP_RINIT_FUNCTION(pcntl)
{
php_add_tick_function(pcntl_signal_dispatch_tick_function, NULL);
zend_hash_init(&PCNTL_G(php_signal_table), 16, NULL, ZVAL_PTR_DTOR, 0);
PCNTL_G(head) = PCNTL_G(tail) = PCNTL_G(spares) = NULL;
PCNTL_G(async_signals) = 0;
PCNTL_G(last_error) = 0;
PCNTL_G(num_signals) = NSIG;
#ifdef SIGRTMAX
/* At least FreeBSD reports an incorrecrt NSIG that does not include realtime signals.
* As SIGRTMAX may be a dynamic value, adjust the value in INIT. */
if (NSIG < SIGRTMAX + 1) {
PCNTL_G(num_signals) = SIGRTMAX + 1;
}
#endif
return SUCCESS;
}
PHP_MINIT_FUNCTION(pcntl)
{
QosClass_ce = register_class_Pcntl_QosClass();
register_pcntl_symbols(module_number);
orig_interrupt_function = zend_interrupt_function;
zend_interrupt_function = pcntl_interrupt_function;
return SUCCESS;
}
PHP_RSHUTDOWN_FUNCTION(pcntl)
{
struct php_pcntl_pending_signal *sig;
zend_long signo;
zval *handle;
/* Reset all signals to their default disposition */
ZEND_HASH_FOREACH_NUM_KEY_VAL(&PCNTL_G(php_signal_table), signo, handle) {
if (Z_TYPE_P(handle) != IS_LONG || Z_LVAL_P(handle) != (zend_long)SIG_DFL) {
php_signal(signo, (Sigfunc *)(zend_long)SIG_DFL, 0);
}
} ZEND_HASH_FOREACH_END();
zend_hash_destroy(&PCNTL_G(php_signal_table));
while (PCNTL_G(head)) {
sig = PCNTL_G(head);
PCNTL_G(head) = sig->next;
efree(sig);
}
while (PCNTL_G(spares)) {
sig = PCNTL_G(spares);
PCNTL_G(spares) = sig->next;
efree(sig);
}
return SUCCESS;
}
PHP_MINFO_FUNCTION(pcntl)
{
php_info_print_table_start();
php_info_print_table_row(2, "pcntl support", "enabled");
php_info_print_table_end();
}
/* {{{ Forks the currently running process following the same behavior as the UNIX fork() system call*/
PHP_FUNCTION(pcntl_fork)
{
pid_t id;
ZEND_PARSE_PARAMETERS_NONE();
id = fork();
if (id == -1) {
PCNTL_G(last_error) = errno;
switch (errno) {
case EAGAIN:
php_error_docref(NULL, E_WARNING, "Error %d: Reached the maximum limit of number of processes", errno);
break;
case ENOMEM:
php_error_docref(NULL, E_WARNING, "Error %d: Insufficient memory", errno);
break;
// unlikely, especially nowadays.
case ENOSYS:
php_error_docref(NULL, E_WARNING, "Error %d: Unimplemented", errno);
break;
// QNX is the only platform returning it so far and is a different case from EAGAIN.
// Retries can be handled with sleep eventually.
case EBADF:
php_error_docref(NULL, E_WARNING, "Error %d: File descriptor concurrency issue", errno);
break;
default:
php_error_docref(NULL, E_WARNING, "Error %d", errno);
}
} else if (id == 0) {
zend_max_execution_timer_init();
}
RETURN_LONG((zend_long) id);
}
/* }}} */
/* {{{ Set an alarm clock for delivery of a signal*/
PHP_FUNCTION(pcntl_alarm)
{
zend_long seconds;
ZEND_PARSE_PARAMETERS_START(1, 1)
Z_PARAM_LONG(seconds);
ZEND_PARSE_PARAMETERS_END();
RETURN_LONG((zend_long) alarm(seconds));
}
/* }}} */
#define PHP_RUSAGE_PARA(from, to, field) \
add_assoc_long(to, #field, from.field)
#ifndef _OSD_POSIX
#define PHP_RUSAGE_SPECIAL(from, to) \
PHP_RUSAGE_PARA(from, to, ru_oublock); \
PHP_RUSAGE_PARA(from, to, ru_inblock); \
PHP_RUSAGE_PARA(from, to, ru_msgsnd); \
PHP_RUSAGE_PARA(from, to, ru_msgrcv); \
PHP_RUSAGE_PARA(from, to, ru_maxrss); \
PHP_RUSAGE_PARA(from, to, ru_ixrss); \
PHP_RUSAGE_PARA(from, to, ru_idrss); \
PHP_RUSAGE_PARA(from, to, ru_minflt); \
PHP_RUSAGE_PARA(from, to, ru_majflt); \
PHP_RUSAGE_PARA(from, to, ru_nsignals); \
PHP_RUSAGE_PARA(from, to, ru_nvcsw); \
PHP_RUSAGE_PARA(from, to, ru_nivcsw); \
PHP_RUSAGE_PARA(from, to, ru_nswap);
#else /*_OSD_POSIX*/
#define PHP_RUSAGE_SPECIAL(from, to)
#endif
#define PHP_RUSAGE_COMMON(from ,to) \
PHP_RUSAGE_PARA(from, to, ru_utime.tv_usec); \
PHP_RUSAGE_PARA(from, to, ru_utime.tv_sec); \
PHP_RUSAGE_PARA(from, to, ru_stime.tv_usec); \
PHP_RUSAGE_PARA(from, to, ru_stime.tv_sec);
#define PHP_RUSAGE_TO_ARRAY(from, to) \
if (to) { \
PHP_RUSAGE_SPECIAL(from, to) \
PHP_RUSAGE_COMMON(from, to); \
}
/* {{{ Waits on or returns the status of a forked child as defined by the waitpid() system call */
PHP_FUNCTION(pcntl_waitpid)
{
zend_long pid, options = 0;
zval *z_status = NULL, *z_rusage = NULL;
int status;
pid_t child_id;
#ifdef HAVE_WAIT4
struct rusage rusage;
#endif
ZEND_PARSE_PARAMETERS_START(2, 4)
Z_PARAM_LONG(pid)
Z_PARAM_ZVAL(z_status)
Z_PARAM_OPTIONAL
Z_PARAM_LONG(options)
Z_PARAM_ZVAL(z_rusage)
ZEND_PARSE_PARAMETERS_END();
status = zval_get_long(z_status);
#ifdef HAVE_WAIT4
if (z_rusage) {
z_rusage = zend_try_array_init(z_rusage);
if (!z_rusage) {
RETURN_THROWS();
}
memset(&rusage, 0, sizeof(struct rusage));
child_id = wait4((pid_t) pid, &status, options, &rusage);
} else {
child_id = waitpid((pid_t) pid, &status, options);
}
#else
child_id = waitpid((pid_t) pid, &status, options);
#endif
if (child_id < 0) {
PCNTL_G(last_error) = errno;
}
#ifdef HAVE_WAIT4
if (child_id > 0) {
PHP_RUSAGE_TO_ARRAY(rusage, z_rusage);
}
#endif
ZEND_TRY_ASSIGN_REF_LONG(z_status, status);
RETURN_LONG((zend_long) child_id);
}
/* }}} */
#if defined (HAVE_WAITID) && defined (HAVE_POSIX_IDTYPES) && defined (HAVE_DECL_WEXITED) && HAVE_DECL_WEXITED == 1
PHP_FUNCTION(pcntl_waitid)
{
zend_long idtype = P_ALL;
zend_long id = 0;
bool id_is_null = 1;
zval *user_siginfo = NULL;
zend_long options = WEXITED;
ZEND_PARSE_PARAMETERS_START(0, 4)
Z_PARAM_OPTIONAL
Z_PARAM_LONG(idtype)
Z_PARAM_LONG_OR_NULL(id, id_is_null)
Z_PARAM_ZVAL(user_siginfo)
Z_PARAM_LONG(options)
ZEND_PARSE_PARAMETERS_END();
errno = 0;
siginfo_t siginfo;
int status = waitid((idtype_t) idtype, (id_t) id, &siginfo, (int) options);
if (status == -1) {
PCNTL_G(last_error) = errno;
RETURN_FALSE;
}
pcntl_siginfo_to_zval(SIGCHLD, &siginfo, user_siginfo);
RETURN_TRUE;
}
#endif
/* {{{ Waits on or returns the status of a forked child as defined by the waitpid() system call */
PHP_FUNCTION(pcntl_wait)
{
zend_long options = 0;
zval *z_status = NULL, *z_rusage = NULL;
int status;
pid_t child_id;
#ifdef HAVE_WAIT3
struct rusage rusage;
#endif
ZEND_PARSE_PARAMETERS_START(1, 3)
Z_PARAM_ZVAL(z_status)
Z_PARAM_OPTIONAL
Z_PARAM_LONG(options)
Z_PARAM_ZVAL(z_rusage)
ZEND_PARSE_PARAMETERS_END();
status = zval_get_long(z_status);
#ifdef HAVE_WAIT3
if (z_rusage) {
z_rusage = zend_try_array_init(z_rusage);
if (!z_rusage) {
RETURN_THROWS();
}
memset(&rusage, 0, sizeof(struct rusage));
child_id = wait3(&status, options, &rusage);
} else if (options) {
child_id = wait3(&status, options, NULL);
} else {
child_id = wait(&status);
}
#else
child_id = wait(&status);
#endif
if (child_id < 0) {
PCNTL_G(last_error) = errno;
}
#ifdef HAVE_WAIT3
if (child_id > 0) {
PHP_RUSAGE_TO_ARRAY(rusage, z_rusage);
}
#endif
ZEND_TRY_ASSIGN_REF_LONG(z_status, status);
RETURN_LONG((zend_long) child_id);
}
/* }}} */
#undef PHP_RUSAGE_PARA
#undef PHP_RUSAGE_SPECIAL
#undef PHP_RUSAGE_COMMON
#undef PHP_RUSAGE_TO_ARRAY
/* {{{ Returns true if the child status code represents a successful exit */
PHP_FUNCTION(pcntl_wifexited)
{
zend_long status_word;
ZEND_PARSE_PARAMETERS_START(1, 1)
Z_PARAM_LONG(status_word)
ZEND_PARSE_PARAMETERS_END();
#ifdef WIFEXITED
int int_status_word = (int) status_word;
if (WIFEXITED(int_status_word)) {
RETURN_TRUE;
}
#endif
RETURN_FALSE;
}
/* }}} */
/* {{{ Returns true if the child status code represents a stopped process (WUNTRACED must have been used with waitpid) */
PHP_FUNCTION(pcntl_wifstopped)
{
zend_long status_word;
ZEND_PARSE_PARAMETERS_START(1, 1)
Z_PARAM_LONG(status_word)
ZEND_PARSE_PARAMETERS_END();
#ifdef WIFSTOPPED
int int_status_word = (int) status_word;
if (WIFSTOPPED(int_status_word)) {
RETURN_TRUE;
}
#endif
RETURN_FALSE;
}
/* }}} */
/* {{{ Returns true if the child status code represents a process that was terminated due to a signal */
PHP_FUNCTION(pcntl_wifsignaled)
{
zend_long status_word;
ZEND_PARSE_PARAMETERS_START(1, 1)
Z_PARAM_LONG(status_word)
ZEND_PARSE_PARAMETERS_END();
#ifdef WIFSIGNALED
int int_status_word = (int) status_word;
if (WIFSIGNALED(int_status_word)) {
RETURN_TRUE;
}
#endif
RETURN_FALSE;
}
/* }}} */
/* {{{ Returns true if the child status code represents a process that was resumed due to a SIGCONT signal */
PHP_FUNCTION(pcntl_wifcontinued)
{
zend_long status_word;
ZEND_PARSE_PARAMETERS_START(1, 1)
Z_PARAM_LONG(status_word)
ZEND_PARSE_PARAMETERS_END();
#ifdef HAVE_WCONTINUED
int int_status_word = (int) status_word;
if (WIFCONTINUED(int_status_word)) {
RETURN_TRUE;
}
#endif
RETURN_FALSE;
}
/* }}} */
/* {{{ Returns the status code of a child's exit */
PHP_FUNCTION(pcntl_wexitstatus)
{
zend_long status_word;
ZEND_PARSE_PARAMETERS_START(1, 1)
Z_PARAM_LONG(status_word)
ZEND_PARSE_PARAMETERS_END();
#ifdef WEXITSTATUS
int int_status_word = (int) status_word;
RETURN_LONG(WEXITSTATUS(int_status_word));
#else
RETURN_FALSE;
#endif
}
/* }}} */
/* {{{ Returns the number of the signal that terminated the process who's status code is passed */
PHP_FUNCTION(pcntl_wtermsig)
{
zend_long status_word;
ZEND_PARSE_PARAMETERS_START(1, 1)
Z_PARAM_LONG(status_word)
ZEND_PARSE_PARAMETERS_END();
#ifdef WTERMSIG
int int_status_word = (int) status_word;
RETURN_LONG(WTERMSIG(int_status_word));
#else
RETURN_FALSE;
#endif
}
/* }}} */
/* {{{ Returns the number of the signal that caused the process to stop who's status code is passed */
PHP_FUNCTION(pcntl_wstopsig)
{
zend_long status_word;
ZEND_PARSE_PARAMETERS_START(1, 1)
Z_PARAM_LONG(status_word)
ZEND_PARSE_PARAMETERS_END();
#ifdef WSTOPSIG
int int_status_word = (int) status_word;
RETURN_LONG(WSTOPSIG(int_status_word));
#else
RETURN_FALSE;
#endif
}
/* }}} */
/* {{{ Executes specified program in current process space as defined by exec(2) */
PHP_FUNCTION(pcntl_exec)
{
zval *args = NULL;
HashTable *env_vars_ht = NULL;
zval *element;
char **argv = NULL, **envp = NULL;
char *path;
size_t path_len;
ZEND_PARSE_PARAMETERS_START(1, 3)
Z_PARAM_PATH(path, path_len)
Z_PARAM_OPTIONAL
Z_PARAM_ARRAY(args)
Z_PARAM_ARRAY_HT(env_vars_ht)
ZEND_PARSE_PARAMETERS_END();
if (args != NULL) {
// TODO Check array is a list?
/* Build argument list */
SEPARATE_ARRAY(args);
const HashTable *args_ht = Z_ARRVAL_P(args);
uint32_t argc = zend_hash_num_elements(args_ht);
/* We want a NULL terminated array of char* with the first entry being the path,
* followed by the arguments */
argv = safe_emalloc((argc + 2), sizeof(char *), 0);
argv[0] = path;
char **current_arg = argv+1;
ZEND_HASH_FOREACH_VAL(args_ht, element) {
if (!try_convert_to_string(element)) {
efree(argv);
RETURN_THROWS();
}
if (zend_str_has_nul_byte(Z_STR_P(element))) {
zend_argument_value_error(2, "individual argument must not contain null bytes");
efree(argv);
RETURN_THROWS();
}
*current_arg = Z_STRVAL_P(element);
current_arg++;
} ZEND_HASH_FOREACH_END();
*current_arg = NULL;
} else {
argv = emalloc(2 * sizeof(char *));
argv[0] = path;
argv[1] = NULL;
}
if (env_vars_ht != NULL) {
/* Build environment pair list */
char **pair;
zend_ulong key_num;
zend_string *key;
/* We want a NULL terminated array of char* */
size_t envp_len = zend_hash_num_elements(env_vars_ht) + 1;
pair = envp = safe_emalloc(envp_len, sizeof(char *), 0);
memset(envp, 0, sizeof(char *) * envp_len);
ZEND_HASH_FOREACH_KEY_VAL(env_vars_ht, key_num, key, element) {
zend_string *element_str = zval_try_get_string(element);
if (element_str == NULL) {
goto cleanup_env_vars;
}
if (zend_str_has_nul_byte(element_str)) {
zend_argument_value_error(3, "value for environment variable must not contain null bytes");
zend_string_release_ex(element_str, false);
goto cleanup_env_vars;
}
/* putenv() allows integer environment variables */
if (!key) {
key = zend_long_to_str((zend_long) key_num);
} else {
if (zend_str_has_nul_byte(key)) {
zend_argument_value_error(3, "name for environment variable must not contain null bytes");
zend_string_release_ex(element_str, false);
goto cleanup_env_vars;
}
zend_string_addref(key);
}
/* Length of element + equal sign + length of key + null */
*pair = safe_emalloc(ZSTR_LEN(element_str) + 1, sizeof(char), ZSTR_LEN(key) + 1);
/* Copy key=element + final null byte into buffer */
memcpy(*pair, ZSTR_VAL(key), ZSTR_LEN(key));
(*pair)[ZSTR_LEN(key)] = '=';
/* Copy null byte */
memcpy(*pair + ZSTR_LEN(key) + 1, ZSTR_VAL(element_str), ZSTR_LEN(element_str) + 1);
/* Cleanup */
zend_string_release_ex(key, false);
zend_string_release_ex(element_str, false);
pair++;
} ZEND_HASH_FOREACH_END();
*(pair) = NULL;
if (execve(path, argv, envp) == -1) {
PCNTL_G(last_error) = errno;
php_error_docref(NULL, E_WARNING, "Error has occurred: (errno %d) %s", errno, strerror(errno));
}
cleanup_env_vars:
/* Cleanup */
for (pair = envp; *pair != NULL; pair++) efree(*pair);
efree(envp);
} else {
if (execv(path, argv) == -1) {
PCNTL_G(last_error) = errno;
php_error_docref(NULL, E_WARNING, "Error has occurred: (errno %d) %s", errno, strerror(errno));
}
}
efree(argv);
RETURN_FALSE;
}
/* }}} */
/* {{{ Assigns a system signal handler to a PHP function */
PHP_FUNCTION(pcntl_signal)
{
zval *handle;
zend_long signo;
bool restart_syscalls = 1;
bool restart_syscalls_is_null = 1;
ZEND_PARSE_PARAMETERS_START(2, 3)
Z_PARAM_LONG(signo)
Z_PARAM_ZVAL(handle)
Z_PARAM_OPTIONAL
Z_PARAM_BOOL_OR_NULL(restart_syscalls, restart_syscalls_is_null)
ZEND_PARSE_PARAMETERS_END();
if (signo < 1) {
zend_argument_value_error(1, "must be greater than or equal to 1");
RETURN_THROWS();
}
if (signo >= PCNTL_G(num_signals)) {
zend_argument_value_error(1, "must be less than %d", PCNTL_G(num_signals));
RETURN_THROWS();
}
if (!PCNTL_G(spares)) {
/* since calling malloc() from within a signal handler is not portable,
* pre-allocate a few records for recording signals */
for (unsigned int i = 0; i < PCNTL_G(num_signals); i++) {
struct php_pcntl_pending_signal *psig;
psig = emalloc(sizeof(*psig));
psig->next = PCNTL_G(spares);
PCNTL_G(spares) = psig;
}
}
/* If restart_syscalls was not explicitly specified and the signal is SIGALRM, then default
* restart_syscalls to false. PHP used to enforce that restart_syscalls is false for SIGALRM,
* so we keep this differing default to reduce the degree of BC breakage. */
if (restart_syscalls_is_null && signo == SIGALRM) {
restart_syscalls = 0;
}
/* Special long value case for SIG_DFL and SIG_IGN */
if (Z_TYPE_P(handle) == IS_LONG) {
if (Z_LVAL_P(handle) != (zend_long) SIG_DFL && Z_LVAL_P(handle) != (zend_long) SIG_IGN) {
zend_argument_value_error(2, "must be either SIG_DFL or SIG_IGN when an integer value is given");
RETURN_THROWS();
}
if (php_signal(signo, (Sigfunc *) Z_LVAL_P(handle), (int) restart_syscalls) == (void *)SIG_ERR) {
PCNTL_G(last_error) = errno;
php_error_docref(NULL, E_WARNING, "Error assigning signal");
RETURN_FALSE;
}
zend_hash_index_update(&PCNTL_G(php_signal_table), signo, handle);
RETURN_TRUE;
}
if (!zend_is_callable_ex(handle, NULL, 0, NULL, NULL, NULL)) {
PCNTL_G(last_error) = EINVAL;
zend_argument_type_error(2, "must be of type callable|int, %s given", zend_zval_value_name(handle));
RETURN_THROWS();
}
/* Add the function name to our signal table */
handle = zend_hash_index_update(&PCNTL_G(php_signal_table), signo, handle);
Z_TRY_ADDREF_P(handle);
if (php_signal4(signo, pcntl_signal_handler, (int) restart_syscalls, 1) == (void *)SIG_ERR) {
PCNTL_G(last_error) = errno;
php_error_docref(NULL, E_WARNING, "Error assigning signal");
RETURN_FALSE;
}
RETURN_TRUE;
}
/* }}} */
/* {{{ Gets signal handler */
PHP_FUNCTION(pcntl_signal_get_handler)
{
zval *prev_handle;
zend_long signo;
ZEND_PARSE_PARAMETERS_START(1, 1)
Z_PARAM_LONG(signo)
ZEND_PARSE_PARAMETERS_END();
// note: max signal on mac is SIGUSR2 (31), no real time signals.
int sigmax = NSIG - 1;
#if defined(SIGRTMAX)
// oddily enough, NSIG on freebsd reports only 32 whereas SIGRTMIN starts at 65.
if (sigmax < SIGRTMAX) {
sigmax = SIGRTMAX;
}
#endif
if (signo < 1 || signo > sigmax) {
zend_argument_value_error(1, "must be between 1 and %d", sigmax);
RETURN_THROWS();
}
if ((prev_handle = zend_hash_index_find(&PCNTL_G(php_signal_table), signo)) != NULL) {
RETURN_COPY(prev_handle);
} else {
RETURN_LONG((zend_long)SIG_DFL);
}
}
/* {{{ Dispatch signals to signal handlers */
PHP_FUNCTION(pcntl_signal_dispatch)
{
ZEND_PARSE_PARAMETERS_NONE();
pcntl_signal_dispatch();
RETURN_TRUE;
}
/* }}} */
/* Common helper function for these 3 wrapper functions */
#if defined(HAVE_SIGWAITINFO) || defined(HAVE_SIGTIMEDWAIT) || defined(HAVE_SIGPROCMASK)
static bool php_pcntl_set_user_signal_infos(
/* const */ HashTable *const user_signals,
sigset_t *const set,
size_t arg_num,
bool allow_empty_signal_array
) {
if (!allow_empty_signal_array && zend_hash_num_elements(user_signals) == 0) {
zend_argument_must_not_be_empty_error(arg_num);
return false;
}
errno = 0;
if (sigemptyset(set) != 0) {
PCNTL_G(last_error) = errno;
php_error_docref(NULL, E_WARNING, "%s", strerror(errno));
return false;
}
zval *user_signal_no;
ZEND_HASH_FOREACH_VAL(user_signals, user_signal_no) {
bool failed = true;
ZVAL_DEREF(user_signal_no);
zend_long tmp = zval_try_get_long(user_signal_no, &failed);
if (failed) {
zend_argument_type_error(arg_num, "signals must be of type int, %s given", zend_zval_value_name(user_signal_no));
return false;
}
/* Signals are positive integers */
if (tmp < 1 || tmp >= PCNTL_G(num_signals)) {
/* PCNTL_G(num_signals) stores +1 from the last valid signal */
zend_argument_value_error(arg_num, "signals must be between 1 and %d", PCNTL_G(num_signals)-1);
return false;
}
int signal_no = (int) tmp;
errno = 0;
if (sigaddset(set, signal_no) != 0) {
PCNTL_G(last_error) = errno;
php_error_docref(NULL, E_WARNING, "%s", strerror(errno));
return false;
}
} ZEND_HASH_FOREACH_END();
return true;
}
#endif
#ifdef HAVE_SIGPROCMASK
/* {{{ Examine and change blocked signals */
PHP_FUNCTION(pcntl_sigprocmask)
{
zend_long how;
HashTable *user_set;
/* Optional by-ref out-param array of old signals */
zval *user_old_set = NULL;
ZEND_PARSE_PARAMETERS_START(2, 3)
Z_PARAM_LONG(how)
Z_PARAM_ARRAY_HT(user_set)
Z_PARAM_OPTIONAL
Z_PARAM_ZVAL(user_old_set)
ZEND_PARSE_PARAMETERS_END();
if (how != SIG_BLOCK && how != SIG_UNBLOCK && how != SIG_SETMASK) {
zend_argument_value_error(1, "must be one of SIG_BLOCK, SIG_UNBLOCK, or SIG_SETMASK");
RETURN_THROWS();
}
errno = 0;
sigset_t old_set;
if (sigemptyset(&old_set) != 0) {
PCNTL_G(last_error) = errno;
php_error_docref(NULL, E_WARNING, "%s", strerror(errno));
RETURN_FALSE;
}
sigset_t set;
bool status = php_pcntl_set_user_signal_infos(user_set, &set, 2, /* allow_empty_signal_array */ how == SIG_SETMASK);
/* Some error occurred */
if (!status) {
RETURN_FALSE;
}
if (sigprocmask(how, &set, &old_set) != 0) {
PCNTL_G(last_error) = errno;
php_error_docref(NULL, E_WARNING, "%s", strerror(errno));
RETURN_FALSE;
}
if (user_old_set != NULL) {
user_old_set = zend_try_array_init(user_old_set);
if (!user_old_set) {
RETURN_THROWS();
}
for (unsigned int signal_no = 1; signal_no < PCNTL_G(num_signals); ++signal_no) {
if (sigismember(&old_set, signal_no) != 1) {
continue;
}
add_next_index_long(user_old_set, signal_no);
}
}
RETURN_TRUE;
}
/* }}} */
#endif
#ifdef HAVE_STRUCT_SIGINFO_T
# ifdef HAVE_SIGWAITINFO
/* {{{ Synchronously wait for queued signals */
PHP_FUNCTION(pcntl_sigwaitinfo)
{
HashTable *user_set;
/* Optional by-ref array of ints */
zval *user_siginfo = NULL;
ZEND_PARSE_PARAMETERS_START(1, 2)
Z_PARAM_ARRAY_HT(user_set)
Z_PARAM_OPTIONAL
Z_PARAM_ZVAL(user_siginfo)
ZEND_PARSE_PARAMETERS_END();
sigset_t set;
bool status = php_pcntl_set_user_signal_infos(user_set, &set, 1, /* allow_empty_signal_array */ false);
/* Some error occurred */
if (!status) {
RETURN_FALSE;
}
errno = 0;
siginfo_t siginfo;
int signal_no = sigwaitinfo(&set, &siginfo);
/* sigwaitinfo() never sets errno to EAGAIN according to POSIX */
if (signal_no == -1) {
PCNTL_G(last_error) = errno;