Worker.php 35 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180
  1. <?php
  2. namespace Workerman;
  3. use \Workerman\Events\Libevent;
  4. use \Workerman\Events\Select;
  5. use \Workerman\Events\EventInterface;
  6. use \Workerman\Connection\ConnectionInterface;
  7. use \Workerman\Connection\TcpConnection;
  8. use \Workerman\Connection\UdpConnection;
  9. use \Workerman\Lib\Timer;
  10. use \Exception;
  11. /**
  12. *
  13. * @author walkor<walkor@workerman.net>
  14. */
  15. class Worker
  16. {
  17. /**
  18. * workerman version
  19. * @var string
  20. */
  21. const VERSION = '3.0.0';
  22. /**
  23. * status starting
  24. * @var int
  25. */
  26. const STATUS_STARTING = 1;
  27. /**
  28. * status running
  29. * @var int
  30. */
  31. const STATUS_RUNNING = 2;
  32. /**
  33. * status shutdown
  34. * @var int
  35. */
  36. const STATUS_SHUTDOWN = 4;
  37. /**
  38. * status reloading
  39. * @var int
  40. */
  41. const STATUS_RELOADING = 8;
  42. /**
  43. * after KILL_WORKER_TIMER_TIME seconds if worker not quit
  44. * then send SIGKILL to the worker
  45. * @var int
  46. */
  47. const KILL_WORKER_TIMER_TIME = 1;
  48. /**
  49. * backlog
  50. * @var int
  51. */
  52. const DEFAUL_BACKLOG = 1024;
  53. /**
  54. * max udp package size
  55. * @var int
  56. */
  57. const MAX_UDP_PACKEG_SIZE = 65535;
  58. /**
  59. * worker name for marking process
  60. * @var string
  61. */
  62. public $name = 'none';
  63. /**
  64. * how many processes will be created for the current worker
  65. * @var unknown_type
  66. */
  67. public $count = 1;
  68. /**
  69. * Set the real user of the current process . Needs appropriate privileges (usually root)
  70. * @var string
  71. */
  72. public $user = '';
  73. /**
  74. * If you do not want restart current worker processes, when received reload signal
  75. * just set reloadable = true
  76. * @var bool
  77. */
  78. public $reloadable = true;
  79. /**
  80. * when worker start, then run onWorkerStart
  81. * @var callback
  82. */
  83. public $onWorkerStart = null;
  84. /**
  85. * when client connect worker, onConnect will be run
  86. * @var callback
  87. */
  88. public $onConnect = null;
  89. /**
  90. * when worker recv data, onMessage will be run
  91. * @var callback
  92. */
  93. public $onMessage = null;
  94. /**
  95. * when connection closed, onClose will be run
  96. * @var callback
  97. */
  98. public $onClose = null;
  99. /**
  100. * when connection has error, onError will be run
  101. * @var unknown_type
  102. */
  103. public $onError = null;
  104. /**
  105. * when worker stop, which function will be run
  106. * @var callback
  107. */
  108. public $onWorkerStop = null;
  109. /**
  110. * tcp/udp
  111. * @var string
  112. */
  113. public $transport = 'tcp';
  114. /**
  115. * protocol
  116. * @var string
  117. */
  118. protected $_protocol = '';
  119. /**
  120. * if run as daemon
  121. * @var bool
  122. */
  123. public static $daemonize = false;
  124. /**
  125. * all output buffer (echo var_dump etc) will write to the file
  126. * @var string
  127. */
  128. public static $stdoutFile = '/dev/null';
  129. /**
  130. * pid file
  131. * @var string
  132. */
  133. public static $pidFile = '';
  134. /**
  135. * log file path
  136. * @var unknown_type
  137. */
  138. public static $logFile = '';
  139. /**
  140. * master process pid
  141. * @var int
  142. */
  143. protected static $_masterPid = 0;
  144. /**
  145. * event loop
  146. * @var Select/Libevent
  147. */
  148. protected static $_globalEvent = null;
  149. /**
  150. * stream socket of the worker
  151. * @var stream
  152. */
  153. protected $_mainSocket = null;
  154. /**
  155. * socket name example http://0.0.0.0:80
  156. * @var string
  157. */
  158. protected $_socketName = '';
  159. /**
  160. * context
  161. * @var context
  162. */
  163. protected $_context = null;
  164. /**
  165. * enable ssl or not
  166. * @var bool
  167. */
  168. protected $_enableSSL = false;
  169. /**
  170. * all instances of worker
  171. * @var array
  172. */
  173. protected static $_workers = array();
  174. /**
  175. * all workers and pids
  176. * @var array
  177. */
  178. protected static $_pidMap = array();
  179. /**
  180. * all processes to be restart [pid=>pid, pid=>pid]
  181. * @var array
  182. */
  183. protected static $_pidsToRestart = array();
  184. /**
  185. * current status
  186. * @var int
  187. */
  188. protected static $_status = self::STATUS_STARTING;
  189. /**
  190. * max length of $_workerName
  191. * @var int
  192. */
  193. protected static $_maxWorkerNameLength = 12;
  194. /**
  195. * max length of $_socketName
  196. * @var int
  197. */
  198. protected static $_maxSocketNameLength = 12;
  199. /**
  200. * max length of $user's name
  201. * @var int
  202. */
  203. protected static $_maxUserNameLength = 12;
  204. /**
  205. * the path of status file, witch will store status of processes
  206. * @var string
  207. */
  208. protected static $_statisticsFile = '';
  209. /**
  210. * start file path
  211. * @var string
  212. */
  213. protected static $_startFile = '';
  214. /**
  215. * global statistics
  216. * @var array
  217. */
  218. protected static $_globalStatistics = array(
  219. 'start_timestamp' => 0,
  220. 'worker_exit_info' => array()
  221. );
  222. /**
  223. * run all workers
  224. * @return void
  225. */
  226. public static function runAll()
  227. {
  228. self::init();
  229. self::parseCommand();
  230. self::daemonize();
  231. self::initWorkers();
  232. self::installSignal();
  233. self::displayUI();
  234. self::resetStd();
  235. self::saveMasterPid();
  236. self::forkWorkers();
  237. self::monitorWorkers();
  238. }
  239. /**
  240. * initialize the environment variables
  241. * @return void
  242. */
  243. public static function init()
  244. {
  245. if(empty(self::$pidFile))
  246. {
  247. $backtrace = debug_backtrace();
  248. self::$_startFile = $backtrace[count($backtrace)-1]['file'];
  249. self::$pidFile = sys_get_temp_dir()."/workerman.".str_replace('/', '_', self::$_startFile).".pid";
  250. }
  251. if(empty(self::$logFile))
  252. {
  253. self::$logFile = __DIR__ . '/../workerman.log';
  254. }
  255. self::$_status = self::STATUS_STARTING;
  256. self::$_globalStatistics['start_timestamp'] = time();
  257. self::$_statisticsFile = sys_get_temp_dir().'/workerman.status';
  258. self::setProcessTitle('WorkerMan: master process start_file=' . self::$_startFile);
  259. Timer::init();
  260. }
  261. /**
  262. * initialize the all the workers
  263. * @return void
  264. */
  265. protected static function initWorkers()
  266. {
  267. foreach(self::$_workers as $worker)
  268. {
  269. // if worker->name not set then use worker->_socketName as worker->name
  270. if(empty($worker->name))
  271. {
  272. $worker->name = 'none';
  273. }
  274. // get the max length of worker->name for formating status info
  275. $worker_name_length = strlen($worker->name);
  276. if(self::$_maxWorkerNameLength < $worker_name_length)
  277. {
  278. self::$_maxWorkerNameLength = $worker_name_length;
  279. }
  280. // get the max length of worker->_socketName
  281. $socket_name_length = strlen($worker->getSocketName());
  282. if(self::$_maxSocketNameLength < $socket_name_length)
  283. {
  284. self::$_maxSocketNameLength = $socket_name_length;
  285. }
  286. // get the max length user name
  287. if(empty($worker->user) || posix_getuid() !== 0)
  288. {
  289. $worker->user = self::getCurrentUser();
  290. }
  291. $user_name_length = strlen($worker->user);
  292. if(self::$_maxUserNameLength < $user_name_length)
  293. {
  294. self::$_maxUserNameLength = $user_name_length;
  295. }
  296. // listen
  297. $worker->listen();
  298. }
  299. }
  300. protected static function getCurrentUser()
  301. {
  302. $user_info = posix_getpwuid(posix_getuid());
  303. return $user_info['name'];
  304. }
  305. protected static function displayUI()
  306. {
  307. echo "\033[1A\n\033[K-----------------------\033[47;30m WORKERMAN \033[0m-----------------------------\n\033[0m";
  308. echo 'Workerman version:' . Worker::VERSION . " PHP version:".PHP_VERSION."\n";
  309. echo "------------------------\033[47;30m WORKERS \033[0m-------------------------------\n";
  310. echo "\033[47;30muser\033[0m",str_pad('', self::$_maxUserNameLength+2-strlen('user')), "\033[47;30mworker\033[0m",str_pad('', self::$_maxWorkerNameLength+2-strlen('worker')), "\033[47;30mlisten\033[0m",str_pad('', self::$_maxSocketNameLength+2-strlen('listen')), "\033[47;30mprocesses\033[0m \033[47;30m","status\033[0m\n";
  311. foreach(self::$_workers as $worker)
  312. {
  313. echo str_pad($worker->user, self::$_maxUserNameLength+2),str_pad($worker->name, self::$_maxWorkerNameLength+2),str_pad($worker->getSocketName(), self::$_maxSocketNameLength+2), str_pad(' '.$worker->count, 9), " \033[32;40m [OK] \033[0m\n";;
  314. }
  315. echo "----------------------------------------------------------------\n";
  316. }
  317. /**
  318. * php yourfile.php start | stop | restart | reload | status
  319. * @return void
  320. */
  321. public static function parseCommand()
  322. {
  323. // check command
  324. global $argv;
  325. $start_file = $argv[0];
  326. if(!isset($argv[1]))
  327. {
  328. exit("Usage: php yourfile.php {start|stop|restart|reload|status}\n");
  329. }
  330. $command = trim($argv[1]);
  331. $command2 = isset($argv[2]) ? $argv[2] : '';
  332. self::log("Workerman[$start_file] $command");
  333. // check if master process is running
  334. $master_pid = @file_get_contents(self::$pidFile);
  335. $master_is_alive = $master_pid && @posix_kill($master_pid, 0);
  336. if($master_is_alive)
  337. {
  338. if($command === 'start')
  339. {
  340. self::log("Workerman[$start_file] is running");
  341. }
  342. }
  343. elseif($command !== 'start' && $command !== 'restart')
  344. {
  345. self::log("Workerman[$start_file] not run");
  346. }
  347. switch($command)
  348. {
  349. // start workerman
  350. case 'start':
  351. if($command2 == '-d')
  352. {
  353. Worker::$daemonize = true;
  354. }
  355. break;
  356. // show status of workerman
  357. case 'status':
  358. // try to delete the statistics file , avoid read dirty data
  359. if(is_file(self::$_statisticsFile))
  360. {
  361. @unlink(self::$_statisticsFile);
  362. }
  363. // send SIGUSR2 to master process ,then master process will send SIGUSR2 to all children processes
  364. // all processes will write statistics data to statistics file
  365. posix_kill($master_pid, SIGUSR2);
  366. // wait all processes wirte statistics data
  367. usleep(100000);
  368. // display statistics file
  369. readfile(self::$_statisticsFile);
  370. exit(0);
  371. // restart workerman
  372. case 'restart':
  373. // stop workeran
  374. case 'stop':
  375. self::log("Workerman[$start_file] is stoping ...");
  376. // send SIGINT to master process, master process will stop all children process and exit
  377. $master_pid && posix_kill($master_pid, SIGINT);
  378. // if $timeout seconds master process not exit then dispaly stop failure
  379. $timeout = 5;
  380. // a recording start time
  381. $start_time = time();
  382. while(1)
  383. {
  384. $master_is_alive = $master_pid && posix_kill($master_pid, 0);
  385. if($master_is_alive)
  386. {
  387. // check whether has timed out
  388. if(time() - $start_time >= $timeout)
  389. {
  390. self::log("Workerman[$start_file] stop fail");
  391. exit;
  392. }
  393. // avoid the cost of CPU time, sleep for a while
  394. usleep(10000);
  395. continue;
  396. }
  397. self::log("Workerman[$start_file] stop success");
  398. if($command === 'stop')
  399. {
  400. exit(0);
  401. }
  402. if($command2 == '-d')
  403. {
  404. Worker::$daemonize = true;
  405. }
  406. break;
  407. }
  408. break;
  409. // reload workerman
  410. case 'reload':
  411. posix_kill($master_pid, SIGUSR1);
  412. self::log("Workerman[$start_file] reload");
  413. exit;
  414. // unknow command
  415. default :
  416. exit("Usage: php yourfile.php {start|stop|restart|reload|status}\n");
  417. }
  418. }
  419. /**
  420. * installs signal handlers for master
  421. * @return void
  422. */
  423. protected static function installSignal()
  424. {
  425. // stop
  426. pcntl_signal(SIGINT, array('\Workerman\Worker', 'signalHandler'), false);
  427. // reload
  428. pcntl_signal(SIGUSR1, array('\Workerman\Worker', 'signalHandler'), false);
  429. // status
  430. pcntl_signal(SIGUSR2, array('\Workerman\Worker', 'signalHandler'), false);
  431. // ignore
  432. pcntl_signal(SIGPIPE, SIG_IGN, false);
  433. }
  434. /**
  435. * reinstall signal handlers for workers
  436. * @return void
  437. */
  438. protected static function reinstallSignal()
  439. {
  440. // uninstall stop signal handler
  441. pcntl_signal(SIGINT, SIG_IGN, false);
  442. // uninstall reload signal handler
  443. pcntl_signal(SIGUSR1, SIG_IGN, false);
  444. // uninstall status signal handler
  445. pcntl_signal(SIGUSR2, SIG_IGN, false);
  446. // reinstall stop signal handler
  447. self::$_globalEvent->add(SIGINT, EventInterface::EV_SIGNAL, array('\Workerman\Worker', 'signalHandler'));
  448. // uninstall reload signal handler
  449. self::$_globalEvent->add(SIGUSR1, EventInterface::EV_SIGNAL,array('\Workerman\Worker', 'signalHandler'));
  450. // uninstall status signal handler
  451. self::$_globalEvent->add(SIGUSR2, EventInterface::EV_SIGNAL, array('\Workerman\Worker', 'signalHandler'));
  452. }
  453. /**
  454. * signal handler
  455. * @param int $signal
  456. */
  457. public static function signalHandler($signal)
  458. {
  459. switch($signal)
  460. {
  461. // stop
  462. case SIGINT:
  463. self::stopAll();
  464. break;
  465. // reload
  466. case SIGUSR1:
  467. self::$_pidsToRestart = self::getAllWorkerPids();;
  468. self::reload();
  469. break;
  470. // show status
  471. case SIGUSR2:
  472. self::writeStatisticsToStatusFile();
  473. break;
  474. }
  475. }
  476. /**
  477. * run workerman as daemon
  478. * @throws Exception
  479. */
  480. protected static function daemonize()
  481. {
  482. if(!self::$daemonize)
  483. {
  484. return;
  485. }
  486. umask(0);
  487. $pid = pcntl_fork();
  488. if(-1 == $pid)
  489. {
  490. throw new Exception('fork fail');
  491. }
  492. elseif($pid > 0)
  493. {
  494. exit(0);
  495. }
  496. if(-1 == posix_setsid())
  497. {
  498. throw new Exception("setsid fail");
  499. }
  500. // fork again avoid SVR4 system regain the control of terminal
  501. $pid = pcntl_fork();
  502. if(-1 == $pid)
  503. {
  504. throw new Exception("fork fail");
  505. }
  506. elseif(0 !== $pid)
  507. {
  508. exit(0);
  509. }
  510. }
  511. /**
  512. * redirecting output
  513. * @throws Exception
  514. */
  515. protected static function resetStd()
  516. {
  517. if(!self::$daemonize)
  518. {
  519. return;
  520. }
  521. global $STDOUT, $STDERR;
  522. $handle = fopen(self::$stdoutFile,"a");
  523. if($handle)
  524. {
  525. unset($handle);
  526. @fclose(STDOUT);
  527. @fclose(STDERR);
  528. $STDOUT = fopen(self::$stdoutFile,"a");
  529. $STDERR = fopen(self::$stdoutFile,"a");
  530. }
  531. else
  532. {
  533. throw new Exception('can not open stdoutFile ' . self::$stdoutFile);
  534. }
  535. }
  536. /**
  537. * save the pid of master for later stop/reload/restart/status command
  538. * @throws Exception
  539. */
  540. protected static function saveMasterPid()
  541. {
  542. self::$_masterPid = posix_getpid();
  543. if(false === @file_put_contents(self::$pidFile, self::$_masterPid))
  544. {
  545. throw new Exception('can not save pid to ' . self::$pidFile);
  546. }
  547. }
  548. /**
  549. * get all pids of workers
  550. * @return array
  551. */
  552. protected static function getAllWorkerPids()
  553. {
  554. $pid_array = array();
  555. foreach(self::$_pidMap as $worker_pid_array)
  556. {
  557. foreach($worker_pid_array as $worker_pid)
  558. {
  559. $pid_array[$worker_pid] = $worker_pid;
  560. }
  561. }
  562. return $pid_array;
  563. }
  564. /**
  565. * fork worker processes
  566. * @return void
  567. */
  568. protected static function forkWorkers()
  569. {
  570. foreach(self::$_workers as $worker)
  571. {
  572. // check worker->name etc
  573. if(self::$_status === self::STATUS_STARTING)
  574. {
  575. // if worker->name not set then use worker->_socketName as worker->name
  576. if(empty($worker->name))
  577. {
  578. $worker->name = $worker->getSocketName();
  579. }
  580. // get the max length of worker->name for formating status info
  581. $worker_name_length = strlen($worker->name);
  582. if(self::$_maxWorkerNameLength < $worker_name_length)
  583. {
  584. self::$_maxWorkerNameLength = $worker_name_length;
  585. }
  586. }
  587. // create processes
  588. while(count(self::$_pidMap[$worker->workerId]) < $worker->count)
  589. {
  590. self::forkOneWorker($worker);
  591. }
  592. }
  593. }
  594. /**
  595. * fork one worker and run it
  596. * @param Worker $worker
  597. * @throws Exception
  598. */
  599. protected static function forkOneWorker($worker)
  600. {
  601. $pid = pcntl_fork();
  602. if($pid > 0)
  603. {
  604. self::$_pidMap[$worker->workerId][$pid] = $pid;
  605. }
  606. elseif(0 === $pid)
  607. {
  608. self::$_pidMap = array();
  609. self::$_workers = array($worker->workerId => $worker);
  610. Timer::delAll();
  611. self::setProcessTitle('WorkerMan: worker process ' . $worker->name . ' ' . $worker->getSocketName());
  612. self::setProcessUser($worker->user);
  613. $worker->run();
  614. exit(250);
  615. }
  616. else
  617. {
  618. throw new Exception("forkOneWorker fail");
  619. }
  620. }
  621. /**
  622. * set current process user
  623. * @return void
  624. */
  625. protected static function setProcessUser($user_name)
  626. {
  627. if(empty($user_name) || posix_getuid() !== 0)
  628. {
  629. return;
  630. }
  631. $user_info = posix_getpwnam($user_name);
  632. if($user_info['uid'] != posix_getuid() || $user_info['gid'] != posix_getgid())
  633. {
  634. if(!posix_setgid($user_info['gid']) || !posix_setuid($user_info['uid']))
  635. {
  636. self::log( 'Notice : Can not run woker as '.$user_name." , You shuld be root\n", true);
  637. }
  638. }
  639. }
  640. /**
  641. * set current process title
  642. * @param string $title
  643. * @return void
  644. */
  645. protected static function setProcessTitle($title)
  646. {
  647. // >=php 5.5
  648. if (function_exists('cli_set_process_title'))
  649. {
  650. @cli_set_process_title($title);
  651. }
  652. // 需要扩展
  653. elseif(extension_loaded('proctitle') && function_exists('setproctitle'))
  654. {
  655. @setproctitle($title);
  656. }
  657. }
  658. /**
  659. * wait for the child process exit
  660. * @return void
  661. */
  662. protected static function monitorWorkers()
  663. {
  664. self::$_status = self::STATUS_RUNNING;
  665. while(1)
  666. {
  667. // calls signal handlers for pending signals
  668. pcntl_signal_dispatch();
  669. // suspends execution of the current process until a child has exited or a signal is delivered
  670. $status = 0;
  671. $pid = pcntl_wait($status, WUNTRACED);
  672. if($pid > 0)
  673. {
  674. foreach(self::$_pidMap as $worker_id => $worker_pid_array)
  675. {
  676. if(isset($worker_pid_array[$pid]))
  677. {
  678. $worker = self::$_workers[$worker_id];
  679. // check status
  680. if($status !== 0)
  681. {
  682. self::log("worker[".$worker->name.":$pid] exit with status $status");
  683. }
  684. // statistics
  685. if(!isset(self::$_globalStatistics['worker_exit_info'][$worker_id][$status]))
  686. {
  687. self::$_globalStatistics['worker_exit_info'][$worker_id][$status] = 0;
  688. }
  689. self::$_globalStatistics['worker_exit_info'][$worker_id][$status]++;
  690. // clear pid info
  691. unset(self::$_pidMap[$worker_id][$pid]);
  692. // if realoding, continue
  693. if(isset(self::$_pidsToRestart[$pid]))
  694. {
  695. unset(self::$_pidsToRestart[$pid]);
  696. self::reload();
  697. }
  698. break;
  699. }
  700. }
  701. // workerman is still running
  702. if(self::$_status !== self::STATUS_SHUTDOWN)
  703. {
  704. self::forkWorkers();
  705. }
  706. else
  707. {
  708. // workerman is shuting down
  709. if(!self::getAllWorkerPids())
  710. {
  711. self::exitAndClearAll();
  712. }
  713. }
  714. }
  715. else
  716. {
  717. if(self::$_status === self::STATUS_SHUTDOWN && !self::getAllWorkerPids())
  718. {
  719. self::exitAndClearAll();
  720. }
  721. }
  722. }
  723. }
  724. /**
  725. * exit
  726. */
  727. protected static function exitAndClearAll()
  728. {
  729. @unlink(self::$pidFile);
  730. self::log("Workerman[".basename(self::$_startFile)."] has been stopped");
  731. exit(0);
  732. }
  733. /**
  734. * reload workerman, gracefully restart child processes one by one
  735. * @return void
  736. */
  737. protected static function reload()
  738. {
  739. // for master process
  740. if(self::$_masterPid === posix_getpid())
  741. {
  742. // set status
  743. if(self::$_status !== self::STATUS_RELOADING && self::$_status !== self::STATUS_SHUTDOWN)
  744. {
  745. self::log("Workerman[".basename(self::$_startFile)."] reloading");
  746. self::$_status = self::STATUS_RELOADING;
  747. }
  748. $reloadable_pid_array = array();
  749. foreach(self::$_pidMap as $worker_id =>$worker_pid_array)
  750. {
  751. $worker = self::$_workers[$worker_id];
  752. if($worker->reloadable)
  753. {
  754. foreach($worker_pid_array as $pid)
  755. {
  756. $reloadable_pid_array[$pid] = $pid;
  757. }
  758. }
  759. }
  760. self::$_pidsToRestart = array_intersect(self::$_pidsToRestart , $reloadable_pid_array);
  761. // reload complete
  762. if(empty(self::$_pidsToRestart))
  763. {
  764. if(self::$_status !== self::STATUS_SHUTDOWN)
  765. {
  766. self::$_status = self::STATUS_RUNNING;
  767. }
  768. return;
  769. }
  770. // continue reload
  771. $one_worker_pid = current(self::$_pidsToRestart );
  772. posix_kill($one_worker_pid, SIGUSR1);
  773. Timer::add(self::KILL_WORKER_TIMER_TIME, 'posix_kill', array($one_worker_pid, SIGKILL), false);
  774. }
  775. // for children process
  776. else
  777. {
  778. $worker = current(self::$_workers);
  779. if($worker->reloadable)
  780. {
  781. self::stopAll();
  782. }
  783. }
  784. }
  785. /**
  786. * stop all workers
  787. * @return void
  788. */
  789. public static function stopAll()
  790. {
  791. self::$_status = self::STATUS_SHUTDOWN;
  792. // for master process
  793. if(self::$_masterPid === posix_getpid())
  794. {
  795. self::log("Workerman[".basename(self::$_startFile)."] Stopping ...");
  796. $worker_pid_array = self::getAllWorkerPids();
  797. foreach($worker_pid_array as $worker_pid)
  798. {
  799. posix_kill($worker_pid, SIGINT);
  800. Timer::add(self::KILL_WORKER_TIMER_TIME, 'posix_kill', array($worker_pid, SIGKILL),false);
  801. }
  802. }
  803. // for worker process
  804. else
  805. {
  806. foreach(self::$_workers as $worker)
  807. {
  808. $worker->stop();
  809. }
  810. exit(0);
  811. }
  812. }
  813. /**
  814. * for workermand status command
  815. * @return void
  816. */
  817. protected static function writeStatisticsToStatusFile()
  818. {
  819. // for master process
  820. if(self::$_masterPid === posix_getpid())
  821. {
  822. $loadavg = sys_getloadavg();
  823. file_put_contents(self::$_statisticsFile, "---------------------------------------GLOBAL STATUS--------------------------------------------\n");
  824. file_put_contents(self::$_statisticsFile, 'Workerman version:' . Worker::VERSION . " PHP version:".PHP_VERSION."\n", FILE_APPEND);
  825. file_put_contents(self::$_statisticsFile, 'start time:'. date('Y-m-d H:i:s', self::$_globalStatistics['start_timestamp']).' run ' . floor((time()-self::$_globalStatistics['start_timestamp'])/(24*60*60)). ' days ' . floor(((time()-self::$_globalStatistics['start_timestamp'])%(24*60*60))/(60*60)) . " hours \n", FILE_APPEND);
  826. file_put_contents(self::$_statisticsFile, 'load average: ' . implode(", ", $loadavg) . "\n", FILE_APPEND);
  827. file_put_contents(self::$_statisticsFile, count(self::$_pidMap) . ' workers ' . count(self::getAllWorkerPids())." processes\n", FILE_APPEND);
  828. file_put_contents(self::$_statisticsFile, str_pad('worker_name', self::$_maxWorkerNameLength) . " exit_status exit_count\n", FILE_APPEND);
  829. foreach(self::$_pidMap as $worker_id =>$worker_pid_array)
  830. {
  831. $worker = self::$_workers[$worker_id];
  832. if(isset(self::$_globalStatistics['worker_exit_info'][$worker_id]))
  833. {
  834. foreach(self::$_globalStatistics['worker_exit_info'][$worker_id] as $worker_exit_status=>$worker_exit_count)
  835. {
  836. file_put_contents(self::$_statisticsFile, str_pad($worker->name, self::$_maxWorkerNameLength) . " " . str_pad($worker_exit_status, 16). " $worker_exit_count\n", FILE_APPEND);
  837. }
  838. }
  839. else
  840. {
  841. file_put_contents(self::$_statisticsFile, str_pad($worker->name, self::$_maxWorkerNameLength) . " " . str_pad(0, 16). " 0\n", FILE_APPEND);
  842. }
  843. }
  844. file_put_contents(self::$_statisticsFile, "---------------------------------------PROCESS STATUS-------------------------------------------\n", FILE_APPEND);
  845. file_put_contents(self::$_statisticsFile, "pid\tmemory ".str_pad('listening', self::$_maxSocketNameLength)." ".str_pad('worker_name', self::$_maxWorkerNameLength)." ".str_pad('total_request', 13)." ".str_pad('send_fail', 9)." ".str_pad('throw_exception', 15)."\n", FILE_APPEND);
  846. chmod(self::$_statisticsFile, 0722);
  847. foreach(self::getAllWorkerPids() as $worker_pid)
  848. {
  849. posix_kill($worker_pid, SIGUSR2);
  850. }
  851. return;
  852. }
  853. // for worker process
  854. $worker = current(self::$_workers);
  855. $wrker_status_str = posix_getpid()."\t".str_pad(round(memory_get_usage()/(1024*1024),2)."M", 7)." " .str_pad($worker->getSocketName(), self::$_maxSocketNameLength) ." ".str_pad(($worker->name == $worker->getSocketName() ? 'none' : $worker->name), self::$_maxWorkerNameLength)." ";
  856. $wrker_status_str .= str_pad(ConnectionInterface::$statistics['total_request'], 14)." ".str_pad(ConnectionInterface::$statistics['send_fail'],9)." ".str_pad(ConnectionInterface::$statistics['throw_exception'],15)."\n";
  857. file_put_contents(self::$_statisticsFile, $wrker_status_str, FILE_APPEND);
  858. }
  859. /**
  860. * log
  861. * @param string $msg
  862. * @return void
  863. */
  864. protected static function log($msg)
  865. {
  866. $msg = $msg."\n";
  867. if(self::$_status === self::STATUS_STARTING || !self::$daemonize)
  868. {
  869. echo $msg;
  870. }
  871. file_put_contents(self::$logFile, date('Y-m-d H:i:s') . " " . $msg, FILE_APPEND);
  872. }
  873. /**
  874. * create a worker
  875. * @param string $socket_name
  876. * @return void
  877. */
  878. public function __construct($socket_name = '', $context_option = array())
  879. {
  880. $this->workerId = spl_object_hash($this);
  881. self::$_workers[$this->workerId] = $this;
  882. self::$_pidMap[$this->workerId] = array();
  883. if($socket_name)
  884. {
  885. $this->_socketName = $socket_name;
  886. if(!isset($context_option['socket']['backlog']))
  887. {
  888. $context_option['socket']['backlog'] = self::DEFAUL_BACKLOG;
  889. }
  890. $this->_context = stream_context_create($context_option);
  891. }
  892. }
  893. /**
  894. * listen and bind socket
  895. * @throws Exception
  896. */
  897. public function listen()
  898. {
  899. if(!$this->_socketName)
  900. {
  901. return;
  902. }
  903. list($scheme, $address) = explode(':', $this->_socketName, 2);
  904. if($scheme != 'tcp' && $scheme != 'udp')
  905. {
  906. $scheme = ucfirst($scheme);
  907. $this->_protocol = '\\Protocols\\'.$scheme;
  908. if(!class_exists($this->_protocol))
  909. {
  910. $this->_protocol = "\\Workerman\\Protocols\\$scheme";
  911. if(!class_exists($this->_protocol))
  912. {
  913. throw new Exception("class \\Protocols\\$scheme not exist");
  914. }
  915. }
  916. }
  917. elseif($scheme === 'udp')
  918. {
  919. $this->transport = 'udp';
  920. }
  921. $flags = $this->transport === 'udp' ? STREAM_SERVER_BIND : STREAM_SERVER_BIND | STREAM_SERVER_LISTEN;
  922. if($this->_enableSSL)
  923. {
  924. if($this->transport == 'udp')
  925. {
  926. throw new Exception('udp do not support ssl');
  927. }
  928. $this->_mainSocket = stream_socket_server("ssl:".$address, $errno, $errmsg, $flags, $this->_context);
  929. @stream_socket_enable_crypto($this->_mainSocket, false);
  930. }
  931. else
  932. {
  933. $this->_mainSocket = stream_socket_server($this->transport.":".$address, $errno, $errmsg, $flags, $this->_context);
  934. }
  935. if(!$this->_mainSocket)
  936. {
  937. throw new Exception($errmsg);
  938. }
  939. stream_set_blocking($this->_mainSocket, 0);
  940. if(self::$_globalEvent)
  941. {
  942. if($this->transport !== 'udp')
  943. {
  944. self::$_globalEvent->add($this->_mainSocket, EventInterface::EV_READ, array($this, 'acceptConnection'));
  945. }
  946. else
  947. {
  948. self::$_globalEvent->add($this->_mainSocket, EventInterface::EV_READ, array($this, 'acceptUdpConnection'));
  949. }
  950. }
  951. }
  952. /**
  953. * get socket name
  954. * @return string
  955. */
  956. public function getSocketName()
  957. {
  958. return $this->_socketName ? $this->_socketName : 'none';
  959. }
  960. /**
  961. * enable SSL
  962. * @param array $option @see http://php.net/manual/zh/context.ssl.php
  963. * example $option = array('local_cert' => '/your/path/file.pem', 'passphrase' => 'password', 'allow_self_signed' => true, 'verify_peer' => false)
  964. * @return void
  965. */
  966. public function enableSSL(array $option)
  967. {
  968. $this->_enableSSL = true;
  969. foreach($option as $key => $value)
  970. {
  971. stream_context_set_option($this->_context, 'ssl', $key, $value);
  972. }
  973. }
  974. /**
  975. * run the current worker
  976. */
  977. public function run()
  978. {
  979. if(!self::$_globalEvent)
  980. {
  981. if(extension_loaded('libevent'))
  982. {
  983. self::$_globalEvent = new Libevent();
  984. }
  985. else
  986. {
  987. self::$_globalEvent = new Select();
  988. }
  989. if($this->_socketName)
  990. {
  991. if($this->transport !== 'udp')
  992. {
  993. self::$_globalEvent->add($this->_mainSocket, EventInterface::EV_READ, array($this, 'acceptConnection'));
  994. }
  995. else
  996. {
  997. self::$_globalEvent->add($this->_mainSocket, EventInterface::EV_READ, array($this, 'acceptUdpConnection'));
  998. }
  999. }
  1000. }
  1001. self::reinstallSignal();
  1002. Timer::init(self::$_globalEvent);
  1003. if($this->onWorkerStart)
  1004. {
  1005. call_user_func($this->onWorkerStart, $this);
  1006. }
  1007. self::$_globalEvent->loop();
  1008. }
  1009. /**
  1010. * stop the current worker
  1011. * @return void
  1012. */
  1013. public function stop()
  1014. {
  1015. if($this->onWorkerStop)
  1016. {
  1017. call_user_func($this->onWorkerStop, $this);
  1018. }
  1019. self::$_globalEvent->del($this->_mainSocket, EventInterface::EV_READ);
  1020. @fclose($this->_mainSocket);
  1021. }
  1022. /**
  1023. * accept a connection of client
  1024. * @param resources $socket
  1025. * @return void
  1026. */
  1027. public function acceptConnection($socket)
  1028. {
  1029. $new_socket = @stream_socket_accept($socket, 0);
  1030. if(false === $new_socket)
  1031. {
  1032. return;
  1033. }
  1034. if($this->_enableSSL)
  1035. {
  1036. // block the connection until SSL is done
  1037. stream_set_blocking ($socket, true);
  1038. stream_socket_enable_crypto($socket, true, STREAM_CRYPTO_METHOD_SSLv3_SERVER);
  1039. //unblock connection
  1040. stream_set_blocking ($socket, false);
  1041. }
  1042. $connection = new TcpConnection($new_socket, self::$_globalEvent);
  1043. $connection->protocol = $this->_protocol;
  1044. $connection->onMessage = $this->onMessage;
  1045. $connection->onClose = $this->onClose;
  1046. $connection->onError = $this->onError;
  1047. if($this->onConnect)
  1048. {
  1049. try
  1050. {
  1051. call_user_func($this->onConnect, $connection);
  1052. }
  1053. catch(Exception $e)
  1054. {
  1055. ConnectionInterface::$statistics['throw_exception']++;
  1056. self::log($e);
  1057. }
  1058. }
  1059. }
  1060. /**
  1061. * deall udp package
  1062. * @param resource $socket
  1063. */
  1064. public function acceptUdpConnection($socket)
  1065. {
  1066. $recv_buffer = stream_socket_recvfrom($socket , self::MAX_UDP_PACKEG_SIZE, 0, $remote_address);
  1067. if(false === $recv_buffer || empty($remote_address))
  1068. {
  1069. return false;
  1070. }
  1071. $connection = new UdpConnection($socket, $remote_address);
  1072. if($this->onMessage)
  1073. {
  1074. $parser = $this->_protocol;
  1075. try
  1076. {
  1077. call_user_func($this->onMessage, $connection, $parser::decode($recv_buffer, $connection));
  1078. }
  1079. catch(Exception $e)
  1080. {
  1081. ConnectionInterface::$statistics['throw_exception']++;
  1082. }
  1083. }
  1084. }
  1085. }