-
Notifications
You must be signed in to change notification settings - Fork 1
/
Worker.php
837 lines (740 loc) · 25 KB
/
Worker.php
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
<?php
namespace Socks5;
use Socks5\Protocols\ProtocolInterface;
use Swoole\Process;
class Worker
{
use EventServer;
/**
* 启动状态
* @int
*/
const STATE_STARTING = 1;
/**
* 运行中状态
* @int
*/
const STATE_RUNNING = 2;
/**
* 平滑重启
* @var int
*/
const STATE_RELOADING = 3;
/**
* 停止成功
* @int
*/
const STATE_STOPPED = 4;
/**
* @var int
*/
const SIG_KILL_TIMEOUT = 3;
/**
* @var int
*/
const DEFAULT_BACKLOG = 102400;
/**
* @var string $logFile
*/
public static string $logFile = '';
/**
* 通知停止超时
* @var int $stopTimeout
*/
public static int $stopTimeout = 4;
/**
* @var bool $daemonize
*/
public static bool $daemonize = false;
/**
* @var bool $smoothStop
*/
protected static bool $smoothStop = false;
/**
* 判断是否reload 完毕
* @var array $reloadable
*/
protected static array $reloadable = [];
/**
* ['pid'=>'pid', 'pid'=>'pid',....]
*
* @var array $pidMap
*/
protected static array $pidMap = [];
/**
* @var array $idMap
*/
protected static array $idMap = [];
/**
* 多路服用驱动
* @var ?LoopInterface $eventLoop
*/
public static ?LoopInterface $eventLoop = null;
/**
* Master 进程PID位置
* @var string $pidFile
*/
protected static string $pidFile;
/**
* Master 进程PID
* @var int $masterPid
*/
protected static int $masterPid;
/**
* 当前Worker进程TCP 连接
* @var array $connections
*/
public array $connections = [];
/**
* 运行状态
* @var int $stateCurrent
*/
protected static int $stateCurrent = self::STATE_STARTING;
/**
* @var int $count
*/
public int $count = 0;
/**
* @var string $name
*/
public string $name = 'none';
/**
* 进程所属用户
* @var string $user
*/
public string $user = '';
/**
* 进程组所属组
* @var string $group
*/
public string $group = '';
/**
* @var bool $stopped
*/
protected bool $stopped = false;
/**
* @var resource $mainSocket
*/
protected $mainSocket;
/**
* @var int $workerId
*/
public int $workerId;
/**
* Application layer protocol
* @var string $layerProtocol
*/
public string $layerProtocol = '';
/**
* @var string $socketName
*/
protected string $socketName = '';
/**
* @var $contextOption
*/
protected $contextOption;
/**
* @var bool $reusePort
*/
protected bool $reusePort = true;
/**
* @var bool $pauseAccept
*/
protected bool $pauseAccept = true;
/**
* @param string $socket_name
* @param array $context_option
* @throws \Exception
*/
public function __construct(string $socket_name = '', array $context_option = [])
{
if (PHP_OS !== 'Linux') {
throw new \Exception(sprintf("Cannot run on [%s] operating system.", PHP_OS));
}
// Context for socket.
if ($socket_name) {
$this->socketName = $socket_name;
if (!isset($context_option['socket']['backlog'])) {
$context_option['socket']['backlog'] = static::DEFAULT_BACKLOG;
}
$this->contextOption = \stream_context_create($context_option);
}
}
/**
* @var string $processTitle
*/
public static string $processTitle = 'Socks5-Proxy';
protected function unlisten()
{
$this->pauseAccept();
if ($this->mainSocket) {
@\fclose($this->mainSocket);
$this->mainSocket = null;
}
}
/**
* @throws \Exception
*/
protected function listen()
{
if (!$this->socketName) {
return;
}
if ($this->layerProtocol && !is_a($this->layerProtocol, ProtocolInterface::class, true)) {
throw new \Exception("[ {$this->layerProtocol} ] Application layer protocol not found.");
}
if (!$this->mainSocket) {
if ($this->reusePort) {
\stream_context_set_option($this->contextOption, 'socket', 'so_reuseport', 1);
}
$this->mainSocket = \stream_socket_server($this->socketName, $error_code, $error_msg, STREAM_SERVER_BIND | STREAM_SERVER_LISTEN, $this->contextOption);
if (!$this->mainSocket) {
throw new \Exception(sprintf("Failed to listen on port: %s, error msg: %s, error code: %d.",
$this->getLocalPort(),
$error_msg,
$error_code
)
);
}
// Try to open keepalive for tcp and disable Nagle algorithm.
if (\function_exists('socket_import_stream')) {
$socket = @\socket_import_stream($this->mainSocket);
@\socket_set_option($socket, \SOL_SOCKET, \SO_KEEPALIVE, 1);
@\socket_set_option($socket, \SOL_TCP, \TCP_NODELAY, 1);
}
\stream_set_blocking($this->mainSocket, false);
}
}
/**
* @throws \Exception
*/
public function start()
{
$this->initialization();
$this->parseCommand();
$this->daemonize();
$this->saveMasterPid();
$this->installSignal();
$this->forkWorkers();
$this->monitorWorkers();
}
/**
* Master 进程信号安装
*/
protected function installSignal()
{
$signalDispatcher = array($this, 'signalDispatcher');
foreach ($signals = [\SIGUSR1,\SIGHUP,\SIGINT,\SIGTERM] as $signal) {
\pcntl_signal($signal, $signalDispatcher, false);
}
// RST 包导致进程退出
\pcntl_signal(SIGPIPE, SIG_IGN);
}
/**
* worker 进程信号安装
*/
protected function reinstallSignal()
{
$signal_dispatcher = array($this, 'signalDispatcher');
foreach ($signals = [\SIGUSR1,\SIGHUP,\SIGINT,\SIGTERM] as $signal) {
// 忽略主进程信号
\pcntl_signal($signal, \SIG_IGN, false);
// 注册信号到多路复用
static::$eventLoop->add($signal, LoopInterface::EV_SIGNAL, $signal_dispatcher);
}
}
public function signalDispatcher($signal)
{
switch ($signal) {
case \SIGTERM: // stop
case \SIGINT:
static::$smoothStop = false;
$this->stopAll();
break;
case \SIGHUP: // stop -g
static::$smoothStop = true;
$this->stopAll();
break;
case \SIGUSR1: // reload
static::$smoothStop = !($signal === \SIGUSR1);
static::$reloadable = static::$pidMap; // 拷贝PID数据进行平滑重启
$this->reload();
break;
}
}
/**
* 平滑重启worker服务
*/
public function reload() {
// Master
if (static::$masterPid === \posix_getpid()) {
if (static::$stateCurrent === static::STATE_STOPPED) {
return;
}
// 正在执行reload
static::$stateCurrent = static::STATE_RELOADING;
// reload 完成
if (empty(static::$reloadable) &&
static::$stateCurrent === static::STATE_RELOADING) {
static::$stateCurrent = static::STATE_RUNNING;
Worker::debug("Proxy service reload completed.");
return;
}
$signal = \SIGUSR1;
if (static::$smoothStop) {
$signal = \SIGUSR2; // 平滑重启, -g
}
$worker_pid = \current(static::$reloadable);
// 通知worker 平滑重启
\posix_kill($worker_pid, $signal);
\pcntl_alarm(static::$stopTimeout);
if (!static::$smoothStop) {
\pcntl_signal(SIGALRM, function() {posix_kill(getmypid(), 9);});
// Timer::add(static::$stopTimeout, 'posix_kill', [$worker_pid, \SIGKILL], false);
}
return;
}
Worker::debug("Proxy service is performing a reload.");
// 代理服务worker 接收到平滑重启信号
if (!static::$smoothStop) {
$this->stopAll();
}
}
/**
* 停止Worker 代理服务
* @param int $code
*/
public function stopAll($code = 0)
{
static::$stateCurrent = static::STATE_STOPPED;
// for master
if (static::$masterPid === \posix_getpid()) {
if (!$this->stopped) {
// 不使用Timer::add 因为退出事件循环,导致主进程退出较慢
\pcntl_alarm(static::SIG_KILL_TIMEOUT);
$handler = function () {
foreach (static::$pidMap as $worker_pid) {
$sigo = static::$smoothStop ? \SIGHUP : \SIGINT;
\posix_kill($worker_pid, $sigo);
if (!static::$smoothStop) {
\posix_kill($worker_pid, \SIGKILL);
}
}
};
\pcntl_signal(\SIGALRM, $handler, false);
$this->stopped = true;
}
} else {
//for worker
if (!$this->stopped) {
if ($this->onWorkerStop) {
try {
call_user_func($this->onWorkerStop, $this);
} catch (\Throwable $e) {
Worker::stopWorker($e);
}
}
$this->unlisten();
if (!static::$smoothStop) {
foreach ($this->connections as $connection) {
$connection->close();
}
$this->onWorkerStart = $this->onWorkerStop = $this->onMessage = $this->onBufferDrain = $this->onBufferFull = null;
}
$this->stopped = true;
}
if (!static::$smoothStop || \count($this->connections) <= 0) {
if (static::$eventLoop) {
static::$eventLoop->destroy();
}
try {
exit($code);
} catch (\Swoole\ExitException $e) {
}
}
}
}
protected function forkWorkers()
{
for ($worker_id = 0; $worker_id < static::workerCount($this->count); $worker_id++) {
$this->forkOneWorker($worker_id);
}
}
/**
* @param int $count
* @return int
*/
protected static function workerCount(int $count = 5): int
{
if ($count < 1) {
return \function_exists('swoole_cpu_num') ? \swoole_cpu_num() : 1;
}
return $count;
}
protected function forkOneWorker(int $workerId)
{
$process = new Process(function () use ($workerId) { // for worker
\srand();
\mt_srand();
// Clear data
static::$pidMap = [];
static::$reloadable = [];
static::$onMasterStart = static::$onMasterStart = null;
Timer::delAll();
if ($this->reusePort) {
$this->listen();
}
$processTitle = (!empty($this->name) && $this->name !== 'none') ?
ucfirst(strtolower($this->name)) : static::$processTitle;
\swoole_set_process_name("{$processTitle}: worker process");
$this->workerId = $workerId;
$this->setUserAndGroup();
$this->run();
}, static::$daemonize, 0, false);
if (!$pid = $process->start()) { // start trigger error.
exit("Fork fail: " . swoole_strerror(swoole_errno()));
}
// for master
static::$pidMap[$pid] = $pid;
static::$idMap[$workerId] = $pid;
}
protected function parseCommand()
{
global $argv;
$available_commands = ['stop' => ['-d', '-g'], 'start' => ['-d'], 'reload' =>[]];
$usage = <<<HELP
Usage: php Yourfile <command> [mode]
AbstractCommand:
start Start worker in DEBUG mode.
Use mode -d to start in DAEMON mode.
stop Stop worker.
Use mode -g to stop gracefully.\n
reload Hot update business code.\n
HELP;
$start_file = $argv[0];
if (!isset($argv[1])) {
exit($usage);
}
$command = $argv[1];
$mode = '';
if (!in_array($command, array_keys($available_commands), true)) {
exit($usage);
}
if (isset($argv[2])) {
if (!in_array($argv[2], $available_commands[$command], true)) {
exit($usage);
}
$mode = $argv[2];
}
$master_pid = \is_file(static::$pidFile) ? (int)\file_get_contents(static::$pidFile) : 0;
$is_alive_master = $master_pid && posix_kill($master_pid, 0);
if ($command === 'start' && $is_alive_master) {
exit(static::$processTitle . " [ {$start_file} ] 服务已运行中!\n");
} elseif ($command === 'stop' && !$is_alive_master) {
exit(static::$processTitle . " [ {$start_file} ] 服务未运行!\n");
} elseif($command === 'reload' && !$is_alive_master) {
exit(static::$processTitle . " [ {$start_file} ] 服务未运行!\n");
}
switch ($command) {
case 'start':
$mode_str = '调试模式';
if ($mode === '-d') {
static::$daemonize = true;
$mode_str = '守护进程模式';
}
echo "[ " . static::$processTitle . " ] | {$mode_str}" . PHP_EOL;
break;
case 'stop':
if (static::$smoothStop = ($mode === '-g')) {
$sig = \SIGHUP;
echo "[ " . static::$processTitle . " ] 正在平滑停止...\n";
} else {
$sig = \SIGINT;
echo "[ " . static::$processTitle . " ] 正在停止...\n";
}
$stop_at = \time() + 5;
while (1) {
$is_alive_master = @\posix_kill($master_pid, 0);
if (!$is_alive_master) {
exit(static::$processTitle . " [ {$start_file} ] 停止服务成功.\n");
}
$master_pid && \posix_kill($master_pid, $sig);
if (static::$smoothStop === false && $stop_at < \time()) {
exit(static::$processTitle . " [ {$start_file} ] 停止服务失败.\n");
}
\usleep(100000);
}
case 'reload':
// 给代理服务器Master 发送平滑重启信号
\posix_kill($master_pid, \SIGUSR1);
exit(0);
default:
exit($usage);
}
}
/**
* 记录日志消息
* @param string $msg
*/
public static function debug(string $msg)
{
$info = \sprintf("{ \033[0;32m%s\033[0m } | %s | {pid-%d}: %s", static::$processTitle, date('Y-m-d H:i:s'), \getmypid(), $msg);
if (!static::$daemonize) {
echo $info . PHP_EOL;
return;
}
$log_msg = \sprintf("{ %s } | %s | {pid-%d}: %s", static::$processTitle, date('Y-m-d H:i:s'), \getmypid(), $msg);
\file_put_contents(static::$logFile, $log_msg . PHP_EOL, FILE_APPEND | LOCK_EX);
}
/**
* 监控工作池
*/
protected function monitorWorkers(): void
{
static::$stateCurrent = static::STATE_RUNNING;
while (1) {
$status = 0;
\pcntl_signal_dispatch();
$pid = \pcntl_wait($status, \WUNTRACED);
\pcntl_signal_dispatch();
if ($pid > 0) {
// 可能是: 平滑重启、意外停止
if (static::$stateCurrent !== static::STATE_STOPPED) {
if (isset(static::$pidMap[$pid])) {
// 异常退出进程
if ($status !== 0) {
echo "Worker process {$pid} exited abnormally: {$status}\n";
}
$workerId = array_search($pid, static::$idMap);
if ($workerId === false) {
continue;
}
// 创建一个worker
$this->forkOneWorker($workerId);
if (static::$reloadable) {
if (isset(static::$reloadable[$pid])) {
unset(static::$reloadable[$pid]);
}
\pcntl_alarm(0);
static::reload();
}
}
}
// 释放内存
unset(static::$pidMap[$pid]);
}
// for master clear data
if (static::$stateCurrent === static::STATE_STOPPED && empty(static::$pidMap)) {
\clearstatcache(static::$pidFile);
if (\file_exists(static::$pidFile)) {
@\unlink(static::$pidFile);
}
echo "[ " . static::$processTitle . " ] 停止成功\n";
if (static::$onMasterStop) {
try {
\call_user_func(static::$onMasterStop);
} catch (\Exception $e) {
Worker::stopWorker($e);
} catch (\Error $err) {
Worker::stopWorker($err);
}
}
exit(0);
}
}
}
/**
* @param \Throwable|null $e
* @param int|null $signal
*/
public static function stopWorker(\Throwable $e = null, ?int $signal = null)
{
if ($e) {
echo sprintf("Terminate process [%d] - %s\n", getmypid(), $e);
}
if (!$signal) {
$signal = \SIGINT;
}
@\posix_kill(getmypid(), $signal);
}
/**
* @param int $signal
* @param int $masterPid
* @return bool
*/
protected static function stopServer($signal = SIGTERM, $masterPid = 0): bool
{
$masterPid = static::$masterPid ? static::$masterPid : $masterPid;
return @\posix_kill($masterPid, $signal);
}
protected function run()
{
// Update the running status of the child process
static::$stateCurrent = static::STATE_RUNNING;
\register_shutdown_function(array($this, 'checkErrors'));
static::$eventLoop = new Swoole();
$this->resumeAccept();
$this->reinstallSignal();
Timer::init(static::$eventLoop);
// Set an empty onMessage callback.
if (empty($this->onMessage)) {
$this->onMessage = function () {
};
}
try {
if ($this->onWorkerStart) {
call_user_func($this->onWorkerStart, $this);
}
} catch (\Exception $e) {
Worker::stopWorker($e);
} catch (\Error $err) {
Worker::stopWorker($err);
}
static::$eventLoop->loop();
}
public static function checkErrors()
{
if (static::$stateCurrent !== static::STATE_STOPPED) {
echo 'Please do not use exit() or die();' . PHP_EOL;
}
}
/**
* Save pid
*
* @throws \Exception
*/
protected function saveMasterPid()
{
static::$masterPid = \posix_getpid();
if (false === \file_put_contents(static::$pidFile, static::$masterPid)) {
throw new \RuntimeException('Failed to save the main process file:' . static::$pidFile);
}
}
protected function daemonize()
{
if (static::$daemonize) {
Process::daemon(true, false);
}
}
/**
* Get unix user of current porcess.
*
* @return string
*/
public static function getCurrentUser()
{
$user_info = \posix_getpwuid(\posix_getuid());
return $user_info['name'];
}
protected function initialization()
{
if (empty($this->user)) {
$this->user = static::getCurrentUser();
} else {
if (\posix_getuid() !== 0 && $this->user !== static::getCurrentUser()) {
echo 'Warning: You must have the root privileges to change uid and gid.' . PHP_EOL;
}
}
if (empty(static::$pidFile)) {
static::$pidFile = __DIR__ . '/' . static::$processTitle . '.pid';
}
if (empty(static::$logFile)) {
static::$logFile = __DIR__ . '/' . static::$processTitle . '.log';
}
if (!\file_exists(static::$logFile)) {
\touch(static::$logFile);
\chmod(static::$logFile, 0622);
}
\swoole_set_process_name(static::$processTitle . ': master process');
$this->initIdMap();
Timer::init(new Swoole());
static::$stateCurrent = static::STATE_STARTING;
// 忽略用户异常
if (!empty(static::$onMasterStart)) {
try {
call_user_func(static::$onMasterStart);
} catch (\Throwable $e) {
}
}
}
protected function initIdMap()
{
for ($i = 0; $i < $this->count; $i++) {
static::$idMap[$i] = 0;
}
}
public function resumeAccept()
{
if (static::$eventLoop && $this->mainSocket && $this->pauseAccept) {
static::$eventLoop->add($this->mainSocket, LoopInterface::EV_READ, array($this, 'acceptTcpConnection'));
$this->pauseAccept = false;
}
}
public function pauseAccept()
{
if (static::$eventLoop && $this->mainSocket && !$this->pauseAccept) {
static::$eventLoop->del($this->mainSocket, LoopInterface::EV_READ);
$this->pauseAccept = true;
}
}
public function acceptTcpConnection($socket)
{
$new_socket = @\stream_socket_accept($socket, 0, $remote_address);
if (!$new_socket) {
return;
}
$connection = new TcpConnection($new_socket, $remote_address);
$this->connections[$connection->id] = $connection;
$connection->onMessage = $this->onMessage;
$connection->worker = $this;
$connection->onClose = $this->onClose;
$connection->onError = $this->onError;
$connection->onBufferDrain = $this->onBufferDrain;
$connection->onBufferFull = $this->onBufferFull;
$connection->setLayerProtocol($this->layerProtocol);
if ($this->onConnect) {
try {
\call_user_func($this->onConnect, $connection);
} catch (\Exception $e) {
Worker::stopWorker($e);
} catch (\Error $err) {
Worker::stopWorker($err);
}
}
}
public function getLocalAddress()
{
return parse_url($this->socketName, PHP_URL_HOST);
}
public function getLocalPort()
{
return parse_url($this->socketName, PHP_URL_PORT);
}
public function setUserAndGroup()
{
// Get uid.
$user_info = \posix_getpwnam($this->user);
if (!$user_info) {
echo "Warning: User {$this->user} not exsits" . PHP_EOL;
return;
}
$uid = $user_info['uid'];
// Get gid.
if ($this->group) {
$group_info = \posix_getgrnam($this->group);
if (!$group_info) {
echo "Warning: Group {$this->group} not exsits" . PHP_EOL;
return;
}
$gid = $group_info['gid'];
} else {
$gid = $user_info['gid'];
}
// Set uid and gid.
if ($uid !== \posix_getuid() || $gid !== \posix_getgid()) {
if (!\posix_setgid($gid) || !\posix_initgroups($user_info['name'], $gid) || !\posix_setuid($uid)) {
echo "Warning: change gid or uid fail." . PHP_EOL;
}
}
}
}