Worker.php 35 KB

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