Worker.php 34 KB

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