Worker.php 56 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825
  1. <?php
  2. /**
  3. * This file is part of workerman.
  4. *
  5. * Licensed under The MIT License
  6. * For full copyright and license information, please see the MIT-LICENSE.txt
  7. * Redistributions of files must retain the above copyright notice.
  8. *
  9. * @author walkor<walkor@workerman.net>
  10. * @copyright walkor<walkor@workerman.net>
  11. * @link http://www.workerman.net/
  12. * @license http://www.opensource.org/licenses/mit-license.php MIT License
  13. */
  14. namespace Workerman;
  15. require_once __DIR__ . '/Lib/Constants.php';
  16. use Workerman\Events\EventInterface;
  17. use Workerman\Connection\ConnectionInterface;
  18. use Workerman\Connection\TcpConnection;
  19. use Workerman\Connection\UdpConnection;
  20. use Workerman\Lib\Timer;
  21. use Exception;
  22. /**
  23. * Worker class
  24. * A container for listening ports
  25. */
  26. class Worker
  27. {
  28. /**
  29. * Version.
  30. *
  31. * @var string
  32. */
  33. const VERSION = '3.4.8';
  34. /**
  35. * Status starting.
  36. *
  37. * @var int
  38. */
  39. const STATUS_STARTING = 1;
  40. /**
  41. * Status running.
  42. *
  43. * @var int
  44. */
  45. const STATUS_RUNNING = 2;
  46. /**
  47. * Status shutdown.
  48. *
  49. * @var int
  50. */
  51. const STATUS_SHUTDOWN = 4;
  52. /**
  53. * Status reloading.
  54. *
  55. * @var int
  56. */
  57. const STATUS_RELOADING = 8;
  58. /**
  59. * After sending the restart command to the child process KILL_WORKER_TIMER_TIME seconds,
  60. * if the process is still living then forced to kill.
  61. *
  62. * @var int
  63. */
  64. const KILL_WORKER_TIMER_TIME = 2;
  65. /**
  66. * Default backlog. Backlog is the maximum length of the queue of pending connections.
  67. *
  68. * @var int
  69. */
  70. const DEFAULT_BACKLOG = 102400;
  71. /**
  72. * Max udp package size.
  73. *
  74. * @var int
  75. */
  76. const MAX_UDP_PACKAGE_SIZE = 65535;
  77. /**
  78. * Worker id.
  79. *
  80. * @var int
  81. */
  82. public $id = 0;
  83. /**
  84. * Name of the worker processes.
  85. *
  86. * @var string
  87. */
  88. public $name = 'none';
  89. /**
  90. * Number of worker processes.
  91. *
  92. * @var int
  93. */
  94. public $count = 1;
  95. /**
  96. * Unix user of processes, needs appropriate privileges (usually root).
  97. *
  98. * @var string
  99. */
  100. public $user = '';
  101. /**
  102. * Unix group of processes, needs appropriate privileges (usually root).
  103. *
  104. * @var string
  105. */
  106. public $group = '';
  107. /**
  108. * reloadable.
  109. *
  110. * @var bool
  111. */
  112. public $reloadable = true;
  113. /**
  114. * reuse port.
  115. *
  116. * @var bool
  117. */
  118. public $reusePort = false;
  119. /**
  120. * Emitted when worker processes start.
  121. *
  122. * @var callback
  123. */
  124. public $onWorkerStart = null;
  125. /**
  126. * Emitted when a socket connection is successfully established.
  127. *
  128. * @var callback
  129. */
  130. public $onConnect = null;
  131. /**
  132. * Emitted when data is received.
  133. *
  134. * @var callback
  135. */
  136. public $onMessage = null;
  137. /**
  138. * Emitted when the other end of the socket sends a FIN packet.
  139. *
  140. * @var callback
  141. */
  142. public $onClose = null;
  143. /**
  144. * Emitted when an error occurs with connection.
  145. *
  146. * @var callback
  147. */
  148. public $onError = null;
  149. /**
  150. * Emitted when the send buffer becomes full.
  151. *
  152. * @var callback
  153. */
  154. public $onBufferFull = null;
  155. /**
  156. * Emitted when the send buffer becomes empty.
  157. *
  158. * @var callback
  159. */
  160. public $onBufferDrain = null;
  161. /**
  162. * Emitted when worker processes stoped.
  163. *
  164. * @var callback
  165. */
  166. public $onWorkerStop = null;
  167. /**
  168. * Emitted when worker processes get reload signal.
  169. *
  170. * @var callback
  171. */
  172. public $onWorkerReload = null;
  173. /**
  174. * Transport layer protocol.
  175. *
  176. * @var string
  177. */
  178. public $transport = 'tcp';
  179. /**
  180. * Store all connections of clients.
  181. *
  182. * @var array
  183. */
  184. public $connections = array();
  185. /**
  186. * Application layer protocol.
  187. *
  188. * @var Protocols\ProtocolInterface
  189. */
  190. public $protocol = null;
  191. /**
  192. * Root path for autoload.
  193. *
  194. * @var string
  195. */
  196. protected $_autoloadRootPath = '';
  197. /**
  198. * Daemonize.
  199. *
  200. * @var bool
  201. */
  202. public static $daemonize = false;
  203. /**
  204. * Stdout file.
  205. *
  206. * @var string
  207. */
  208. public static $stdoutFile = '/dev/null';
  209. /**
  210. * The file to store master process PID.
  211. *
  212. * @var string
  213. */
  214. public static $pidFile = '';
  215. /**
  216. * Log file.
  217. *
  218. * @var mixed
  219. */
  220. public static $logFile = '';
  221. /**
  222. * Global event loop.
  223. *
  224. * @var Events\EventInterface
  225. */
  226. public static $globalEvent = null;
  227. /**
  228. * Emitted when the master process get reload signal.
  229. *
  230. * @var callback
  231. */
  232. public static $onMasterReload = null;
  233. /**
  234. * Emitted when the master process terminated.
  235. *
  236. * @var callback
  237. */
  238. public static $onMasterStop = null;
  239. /**
  240. * EventLoopClass
  241. *
  242. * @var string
  243. */
  244. public static $eventLoopClass = '';
  245. /**
  246. * The PID of master process.
  247. *
  248. * @var int
  249. */
  250. protected static $_masterPid = 0;
  251. /**
  252. * Listening socket.
  253. *
  254. * @var resource
  255. */
  256. protected $_mainSocket = null;
  257. /**
  258. * Socket name. The format is like this http://0.0.0.0:80 .
  259. *
  260. * @var string
  261. */
  262. protected $_socketName = '';
  263. /**
  264. * Context of socket.
  265. *
  266. * @var resource
  267. */
  268. protected $_context = null;
  269. /**
  270. * All worker instances.
  271. *
  272. * @var array
  273. */
  274. protected static $_workers = array();
  275. /**
  276. * All worker porcesses pid.
  277. * The format is like this [worker_id=>[pid=>pid, pid=>pid, ..], ..]
  278. *
  279. * @var array
  280. */
  281. protected static $_pidMap = array();
  282. /**
  283. * All worker processes waiting for restart.
  284. * The format is like this [pid=>pid, pid=>pid].
  285. *
  286. * @var array
  287. */
  288. protected static $_pidsToRestart = array();
  289. /**
  290. * Mapping from PID to worker process ID.
  291. * The format is like this [worker_id=>[0=>$pid, 1=>$pid, ..], ..].
  292. *
  293. * @var array
  294. */
  295. protected static $_idMap = array();
  296. /**
  297. * Current status.
  298. *
  299. * @var int
  300. */
  301. protected static $_status = self::STATUS_STARTING;
  302. /**
  303. * Maximum length of the worker names.
  304. *
  305. * @var int
  306. */
  307. protected static $_maxWorkerNameLength = 12;
  308. /**
  309. * Maximum length of the socket names.
  310. *
  311. * @var int
  312. */
  313. protected static $_maxSocketNameLength = 12;
  314. /**
  315. * Maximum length of the process user names.
  316. *
  317. * @var int
  318. */
  319. protected static $_maxUserNameLength = 12;
  320. /**
  321. * The file to store status info of current worker process.
  322. *
  323. * @var string
  324. */
  325. protected static $_statisticsFile = '';
  326. /**
  327. * Start file.
  328. *
  329. * @var string
  330. */
  331. protected static $_startFile = '';
  332. /**
  333. * Status info of current worker process.
  334. *
  335. * @var array
  336. */
  337. protected static $_globalStatistics = array(
  338. 'start_timestamp' => 0,
  339. 'worker_exit_info' => array()
  340. );
  341. /**
  342. * Available event loops.
  343. *
  344. * @var array
  345. */
  346. protected static $_availableEventLoops = array(
  347. 'libevent' => '\Workerman\Events\Libevent',
  348. 'event' => '\Workerman\Events\Event'
  349. );
  350. /**
  351. * PHP built-in protocols.
  352. *
  353. * @var array
  354. */
  355. protected static $_builtinTransports = array(
  356. 'tcp' => 'tcp',
  357. 'udp' => 'udp',
  358. 'unix' => 'unix',
  359. 'ssl' => 'tcp'
  360. );
  361. /**
  362. * Run all worker instances.
  363. *
  364. * @return void
  365. */
  366. public static function runAll()
  367. {
  368. self::checkSapiEnv();
  369. self::init();
  370. self::parseCommand();
  371. self::daemonize();
  372. self::initWorkers();
  373. self::installSignal();
  374. self::saveMasterPid();
  375. self::forkWorkers();
  376. self::displayUI();
  377. self::resetStd();
  378. self::monitorWorkers();
  379. }
  380. /**
  381. * Check sapi.
  382. *
  383. * @return void
  384. */
  385. protected static function checkSapiEnv()
  386. {
  387. // Only for cli.
  388. if (php_sapi_name() != "cli") {
  389. exit("only run in command line mode \n");
  390. }
  391. }
  392. /**
  393. * Init.
  394. *
  395. * @return void
  396. */
  397. protected static function init()
  398. {
  399. // Start file.
  400. $backtrace = debug_backtrace();
  401. self::$_startFile = $backtrace[count($backtrace) - 1]['file'];
  402. // Pid file.
  403. if (empty(self::$pidFile)) {
  404. self::$pidFile = __DIR__ . "/../" . str_replace('/', '_', self::$_startFile) . ".pid";
  405. }
  406. // Log file.
  407. if (empty(self::$logFile)) {
  408. self::$logFile = __DIR__ . '/../workerman.log';
  409. }
  410. $log_file = (string)self::$logFile;
  411. if (!is_file($log_file)) {
  412. touch($log_file);
  413. chmod($log_file, 0622);
  414. }
  415. // State.
  416. self::$_status = self::STATUS_STARTING;
  417. // For statistics.
  418. self::$_globalStatistics['start_timestamp'] = time();
  419. self::$_statisticsFile = sys_get_temp_dir() . '/workerman.status';
  420. // Process title.
  421. self::setProcessTitle('WorkerMan: master process start_file=' . self::$_startFile);
  422. // Init data for worker id.
  423. self::initId();
  424. // Timer init.
  425. Timer::init();
  426. }
  427. /**
  428. * Init All worker instances.
  429. *
  430. * @return void
  431. */
  432. protected static function initWorkers()
  433. {
  434. foreach (self::$_workers as $worker) {
  435. // Worker name.
  436. if (empty($worker->name)) {
  437. $worker->name = 'none';
  438. }
  439. // Get maximum length of worker name.
  440. $worker_name_length = strlen($worker->name);
  441. if (self::$_maxWorkerNameLength < $worker_name_length) {
  442. self::$_maxWorkerNameLength = $worker_name_length;
  443. }
  444. // Get maximum length of socket name.
  445. $socket_name_length = strlen($worker->getSocketName());
  446. if (self::$_maxSocketNameLength < $socket_name_length) {
  447. self::$_maxSocketNameLength = $socket_name_length;
  448. }
  449. // Get unix user of the worker process.
  450. if (empty($worker->user)) {
  451. $worker->user = self::getCurrentUser();
  452. } else {
  453. if (posix_getuid() !== 0 && $worker->user != self::getCurrentUser()) {
  454. self::log('Warning: You must have the root privileges to change uid and gid.');
  455. }
  456. }
  457. // Get maximum length of unix user name.
  458. $user_name_length = strlen($worker->user);
  459. if (self::$_maxUserNameLength < $user_name_length) {
  460. self::$_maxUserNameLength = $user_name_length;
  461. }
  462. // Listen.
  463. if (!$worker->reusePort) {
  464. $worker->listen();
  465. }
  466. }
  467. }
  468. /**
  469. * Get all worker instances.
  470. *
  471. * @return array
  472. */
  473. public static function getAllWorkers()
  474. {
  475. return self::$_workers;
  476. }
  477. /**
  478. * Get global event-loop instance.
  479. *
  480. * @return EventInterface
  481. */
  482. public static function getEventLoop()
  483. {
  484. return self::$globalEvent;
  485. }
  486. /**
  487. * Init idMap.
  488. * return void
  489. */
  490. protected static function initId()
  491. {
  492. foreach (self::$_workers as $worker_id => $worker) {
  493. $new_id_map = array();
  494. for($key = 0; $key < $worker->count; $key++) {
  495. $new_id_map[$key] = isset(self::$_idMap[$worker_id][$key]) ? self::$_idMap[$worker_id][$key] : 0;
  496. }
  497. self::$_idMap[$worker_id] = $new_id_map;
  498. }
  499. }
  500. /**
  501. * Get unix user of current porcess.
  502. *
  503. * @return string
  504. */
  505. protected static function getCurrentUser()
  506. {
  507. $user_info = posix_getpwuid(posix_getuid());
  508. return $user_info['name'];
  509. }
  510. /**
  511. * Display staring UI.
  512. *
  513. * @return void
  514. */
  515. protected static function displayUI()
  516. {
  517. self::safeEcho("\033[1A\n\033[K-----------------------\033[47;30m WORKERMAN \033[0m-----------------------------\n\033[0m");
  518. self::safeEcho('Workerman version:'. Worker::VERSION. " PHP version:". PHP_VERSION. "\n");
  519. self::safeEcho("------------------------\033[47;30m WORKERS \033[0m-------------------------------\n");
  520. self::safeEcho("\033[47;30muser\033[0m". str_pad('',
  521. self::$_maxUserNameLength + 2 - strlen('user')). "\033[47;30mworker\033[0m". str_pad('',
  522. self::$_maxWorkerNameLength + 2 - strlen('worker')). "\033[47;30mlisten\033[0m". str_pad('',
  523. self::$_maxSocketNameLength + 2 - strlen('listen')). "\033[47;30mprocesses\033[0m \033[47;30m". "status\033[0m\n");
  524. foreach (self::$_workers as $worker) {
  525. self::safeEcho(str_pad($worker->user, self::$_maxUserNameLength + 2). str_pad($worker->name,
  526. self::$_maxWorkerNameLength + 2). str_pad($worker->getSocketName(),
  527. self::$_maxSocketNameLength + 2). str_pad(' ' . $worker->count, 9). " \033[32;40m [OK] \033[0m\n");
  528. }
  529. self::safeEcho("----------------------------------------------------------------\n");
  530. if (self::$daemonize) {
  531. global $argv;
  532. $start_file = $argv[0];
  533. self::safeEcho("Input \"php $start_file stop\" to quit. Start success.\n\n");
  534. } else {
  535. self::safeEcho("Press Ctrl-C to quit. Start success.\n");
  536. }
  537. }
  538. /**
  539. * Parse command.
  540. * php yourfile.php start | stop | restart | reload | status
  541. *
  542. * @return void
  543. */
  544. protected static function parseCommand()
  545. {
  546. global $argv;
  547. // Check argv;
  548. $start_file = $argv[0];
  549. $available_commands = array(
  550. 'start',
  551. 'stop',
  552. 'restart',
  553. 'reload',
  554. 'status',
  555. 'connections',
  556. );
  557. if (!isset($argv[1]) || !in_array($argv[1], $available_commands)) {
  558. exit("Usage: php yourfile.php {" . implode('|', $available_commands) . "}\n");
  559. }
  560. // Get command.
  561. $command = trim($argv[1]);
  562. $command2 = isset($argv[2]) ? $argv[2] : '';
  563. // Start command.
  564. $mode = '';
  565. if ($command === 'start') {
  566. if ($command2 === '-d' || Worker::$daemonize) {
  567. $mode = 'in DAEMON mode';
  568. } else {
  569. $mode = 'in DEBUG mode';
  570. }
  571. }
  572. self::log("Workerman[$start_file] $command $mode");
  573. // Get master process PID.
  574. $master_pid = is_file(self::$pidFile) ? file_get_contents(self::$pidFile) : 0;
  575. $master_is_alive = $master_pid && @posix_kill($master_pid, 0) && posix_getpid() != $master_pid;
  576. // Master is still alive?
  577. if ($master_is_alive) {
  578. if ($command === 'start') {
  579. self::log("Workerman[$start_file] already running");
  580. exit;
  581. }
  582. } elseif ($command !== 'start' && $command !== 'restart') {
  583. self::log("Workerman[$start_file] not run");
  584. exit;
  585. }
  586. // execute command.
  587. switch ($command) {
  588. case 'start':
  589. if ($command2 === '-d') {
  590. Worker::$daemonize = true;
  591. }
  592. break;
  593. case 'status':
  594. case 'connections':
  595. if (is_file(self::$_statisticsFile)) {
  596. @unlink(self::$_statisticsFile);
  597. }
  598. // Master process will send status signal to all child processes.
  599. $signal = $command === 'status' ? SIGUSR2 : SIGIO;
  600. posix_kill($master_pid, $signal);
  601. // Waiting amoment.
  602. usleep(500000);
  603. // Display statisitcs data from a disk file.
  604. if ($command !== 'status') {
  605. @readfile(self::$_statisticsFile);
  606. exit(0);
  607. }
  608. echo self::formatStatusData();
  609. exit(0);
  610. case 'restart':
  611. case 'stop':
  612. self::log("Workerman[$start_file] is stoping ...");
  613. // Send stop signal to master process.
  614. $master_pid && posix_kill($master_pid, SIGINT);
  615. // Timeout.
  616. $timeout = 5;
  617. $start_time = time();
  618. // Check master process is still alive?
  619. while (1) {
  620. $master_is_alive = $master_pid && posix_kill($master_pid, 0);
  621. if ($master_is_alive) {
  622. // Timeout?
  623. if (time() - $start_time >= $timeout) {
  624. self::log("Workerman[$start_file] stop fail");
  625. exit;
  626. }
  627. // Waiting amoment.
  628. usleep(10000);
  629. continue;
  630. }
  631. // Stop success.
  632. self::log("Workerman[$start_file] stop success");
  633. if ($command === 'stop') {
  634. exit(0);
  635. }
  636. if ($command2 === '-d') {
  637. Worker::$daemonize = true;
  638. }
  639. break;
  640. }
  641. break;
  642. case 'reload':
  643. posix_kill($master_pid, SIGUSR1);
  644. self::log("Workerman[$start_file] reload");
  645. exit;
  646. default :
  647. exit("Usage: php yourfile.php {" . implode('|', $available_commands) . "}\n");
  648. }
  649. }
  650. /**
  651. * Format status data.
  652. *
  653. * @return string
  654. */
  655. protected static function formatStatusData()
  656. {
  657. $info = @file(self::$_statisticsFile, FILE_IGNORE_NEW_LINES);
  658. if (!$info) {
  659. return '';
  660. }
  661. $status_str = '';
  662. $worker_info = json_decode($info[0], true);
  663. ksort($worker_info, SORT_NUMERIC);
  664. unset($info[0]);
  665. $data_waiting_sort = array();
  666. foreach($info as $key => $value) {
  667. if ($key < 10) {
  668. $status_str .= $value . "\n";
  669. continue;
  670. }
  671. if(preg_match('/^[0-9]+/', $value, $pid)) {
  672. $data_waiting_sort[$pid[0]] = $value;
  673. }
  674. }
  675. foreach($worker_info as $pid => $info) {
  676. if (!isset($data_waiting_sort[$pid])) {
  677. $status_str .= "$pid\t" . str_pad('N/A', 7) . " "
  678. . str_pad($info['listen'], self::$_maxSocketNameLength) . " "
  679. . str_pad($info['name'], self::$_maxWorkerNameLength) . " "
  680. . str_pad('N/A', 11) . " " . str_pad('N/A', 13) . " "
  681. . str_pad('N/A', 9) . " " . str_pad('N/A', 8) . " [busy] \n";
  682. continue;
  683. }
  684. $status_str .= $data_waiting_sort[$pid]. " [idle] \n";
  685. }
  686. return $status_str;
  687. }
  688. /**
  689. * Install signal handler.
  690. *
  691. * @return void
  692. */
  693. protected static function installSignal()
  694. {
  695. // stop
  696. pcntl_signal(SIGINT, array('\Workerman\Worker', 'signalHandler'), false);
  697. // reload
  698. pcntl_signal(SIGUSR1, array('\Workerman\Worker', 'signalHandler'), false);
  699. // status
  700. pcntl_signal(SIGUSR2, array('\Workerman\Worker', 'signalHandler'), false);
  701. // connection status
  702. pcntl_signal(SIGIO, array('\Workerman\Worker', 'signalHandler'), false);
  703. // ignore
  704. pcntl_signal(SIGPIPE, SIG_IGN, false);
  705. }
  706. /**
  707. * Reinstall signal handler.
  708. *
  709. * @return void
  710. */
  711. protected static function reinstallSignal()
  712. {
  713. // uninstall stop signal handler
  714. pcntl_signal(SIGINT, SIG_IGN, false);
  715. // uninstall reload signal handler
  716. pcntl_signal(SIGUSR1, SIG_IGN, false);
  717. // uninstall status signal handler
  718. pcntl_signal(SIGUSR2, SIG_IGN, false);
  719. // reinstall stop signal handler
  720. self::$globalEvent->add(SIGINT, EventInterface::EV_SIGNAL, array('\Workerman\Worker', 'signalHandler'));
  721. // reinstall reload signal handler
  722. self::$globalEvent->add(SIGUSR1, EventInterface::EV_SIGNAL, array('\Workerman\Worker', 'signalHandler'));
  723. // reinstall status signal handler
  724. self::$globalEvent->add(SIGUSR2, EventInterface::EV_SIGNAL, array('\Workerman\Worker', 'signalHandler'));
  725. // reinstall connection status signal handler
  726. self::$globalEvent->add(SIGIO, EventInterface::EV_SIGNAL, array('\Workerman\Worker', 'signalHandler'));
  727. }
  728. /**
  729. * Signal handler.
  730. *
  731. * @param int $signal
  732. */
  733. public static function signalHandler($signal)
  734. {
  735. switch ($signal) {
  736. // Stop.
  737. case SIGINT:
  738. self::stopAll();
  739. break;
  740. // Reload.
  741. case SIGUSR1:
  742. self::$_pidsToRestart = self::getAllWorkerPids();
  743. self::reload();
  744. break;
  745. // Show status.
  746. case SIGUSR2:
  747. self::writeStatisticsToStatusFile();
  748. break;
  749. // Show connection status.
  750. case SIGIO:
  751. self::writeConnectionsStatisticsToStatusFile();
  752. break;
  753. }
  754. }
  755. /**
  756. * Run as deamon mode.
  757. *
  758. * @throws Exception
  759. */
  760. protected static function daemonize()
  761. {
  762. if (!self::$daemonize) {
  763. return;
  764. }
  765. umask(0);
  766. $pid = pcntl_fork();
  767. if (-1 === $pid) {
  768. throw new Exception('fork fail');
  769. } elseif ($pid > 0) {
  770. exit(0);
  771. }
  772. if (-1 === posix_setsid()) {
  773. throw new Exception("setsid fail");
  774. }
  775. // Fork again avoid SVR4 system regain the control of terminal.
  776. $pid = pcntl_fork();
  777. if (-1 === $pid) {
  778. throw new Exception("fork fail");
  779. } elseif (0 !== $pid) {
  780. exit(0);
  781. }
  782. }
  783. /**
  784. * Redirect standard input and output.
  785. *
  786. * @throws Exception
  787. */
  788. public static function resetStd()
  789. {
  790. if (!self::$daemonize) {
  791. return;
  792. }
  793. global $STDOUT, $STDERR;
  794. $handle = fopen(self::$stdoutFile, "a");
  795. if ($handle) {
  796. unset($handle);
  797. @fclose(STDOUT);
  798. @fclose(STDERR);
  799. $STDOUT = fopen(self::$stdoutFile, "a");
  800. $STDERR = fopen(self::$stdoutFile, "a");
  801. } else {
  802. throw new Exception('can not open stdoutFile ' . self::$stdoutFile);
  803. }
  804. }
  805. /**
  806. * Save pid.
  807. *
  808. * @throws Exception
  809. */
  810. protected static function saveMasterPid()
  811. {
  812. self::$_masterPid = posix_getpid();
  813. if (false === @file_put_contents(self::$pidFile, self::$_masterPid)) {
  814. throw new Exception('can not save pid to ' . self::$pidFile);
  815. }
  816. }
  817. /**
  818. * Get event loop name.
  819. *
  820. * @return string
  821. */
  822. protected static function getEventLoopName()
  823. {
  824. if (self::$eventLoopClass) {
  825. return self::$eventLoopClass;
  826. }
  827. $loop_name = '';
  828. foreach (self::$_availableEventLoops as $name=>$class) {
  829. if (extension_loaded($name)) {
  830. $loop_name = $name;
  831. break;
  832. }
  833. }
  834. if ($loop_name) {
  835. if (interface_exists('\React\EventLoop\LoopInterface')) {
  836. switch ($loop_name) {
  837. case 'libevent':
  838. self::$eventLoopClass = '\Workerman\Events\React\LibEventLoop';
  839. break;
  840. case 'event':
  841. self::$eventLoopClass = '\Workerman\Events\React\ExtEventLoop';
  842. break;
  843. default :
  844. self::$eventLoopClass = '\Workerman\Events\React\StreamSelectLoop';
  845. break;
  846. }
  847. } else {
  848. self::$eventLoopClass = self::$_availableEventLoops[$loop_name];
  849. }
  850. } else {
  851. self::$eventLoopClass = interface_exists('\React\EventLoop\LoopInterface')? '\Workerman\Events\React\StreamSelectLoop':'\Workerman\Events\Select';
  852. }
  853. return self::$eventLoopClass;
  854. }
  855. /**
  856. * Get all pids of worker processes.
  857. *
  858. * @return array
  859. */
  860. protected static function getAllWorkerPids()
  861. {
  862. $pid_array = array();
  863. foreach (self::$_pidMap as $worker_pid_array) {
  864. foreach ($worker_pid_array as $worker_pid) {
  865. $pid_array[$worker_pid] = $worker_pid;
  866. }
  867. }
  868. return $pid_array;
  869. }
  870. /**
  871. * Fork some worker processes.
  872. *
  873. * @return void
  874. */
  875. protected static function forkWorkers()
  876. {
  877. foreach (self::$_workers as $worker) {
  878. if (self::$_status === self::STATUS_STARTING) {
  879. if (empty($worker->name)) {
  880. $worker->name = $worker->getSocketName();
  881. }
  882. $worker_name_length = strlen($worker->name);
  883. if (self::$_maxWorkerNameLength < $worker_name_length) {
  884. self::$_maxWorkerNameLength = $worker_name_length;
  885. }
  886. }
  887. $worker->count = $worker->count <= 0 ? 1 : $worker->count;
  888. while (count(self::$_pidMap[$worker->workerId]) < $worker->count) {
  889. static::forkOneWorker($worker);
  890. }
  891. }
  892. }
  893. /**
  894. * Fork one worker process.
  895. *
  896. * @param Worker $worker
  897. * @throws Exception
  898. */
  899. protected static function forkOneWorker($worker)
  900. {
  901. // Get available worker id.
  902. $id = self::getId($worker->workerId, 0);
  903. if ($id === false) {
  904. return;
  905. }
  906. $pid = pcntl_fork();
  907. // For master process.
  908. if ($pid > 0) {
  909. self::$_pidMap[$worker->workerId][$pid] = $pid;
  910. self::$_idMap[$worker->workerId][$id] = $pid;
  911. } // For child processes.
  912. elseif (0 === $pid) {
  913. if ($worker->reusePort) {
  914. $worker->listen();
  915. }
  916. if (self::$_status === self::STATUS_STARTING) {
  917. self::resetStd();
  918. }
  919. self::$_pidMap = array();
  920. self::$_workers = array($worker->workerId => $worker);
  921. Timer::delAll();
  922. self::setProcessTitle('WorkerMan: worker process ' . $worker->name . ' ' . $worker->getSocketName());
  923. $worker->setUserAndGroup();
  924. $worker->id = $id;
  925. $worker->run();
  926. $err = new Exception('event-loop exited');
  927. self::log($err);
  928. exit(250);
  929. } else {
  930. throw new Exception("forkOneWorker fail");
  931. }
  932. }
  933. /**
  934. * Get worker id.
  935. *
  936. * @param int $worker_id
  937. * @param int $pid
  938. *
  939. * @return integer
  940. */
  941. protected static function getId($worker_id, $pid)
  942. {
  943. return array_search($pid, self::$_idMap[$worker_id]);
  944. }
  945. /**
  946. * Set unix user and group for current process.
  947. *
  948. * @return void
  949. */
  950. public function setUserAndGroup()
  951. {
  952. // Get uid.
  953. $user_info = posix_getpwnam($this->user);
  954. if (!$user_info) {
  955. self::log("Warning: User {$this->user} not exsits");
  956. return;
  957. }
  958. $uid = $user_info['uid'];
  959. // Get gid.
  960. if ($this->group) {
  961. $group_info = posix_getgrnam($this->group);
  962. if (!$group_info) {
  963. self::log("Warning: Group {$this->group} not exsits");
  964. return;
  965. }
  966. $gid = $group_info['gid'];
  967. } else {
  968. $gid = $user_info['gid'];
  969. }
  970. // Set uid and gid.
  971. if ($uid != posix_getuid() || $gid != posix_getgid()) {
  972. if (!posix_setgid($gid) || !posix_initgroups($user_info['name'], $gid) || !posix_setuid($uid)) {
  973. self::log("Warning: change gid or uid fail.");
  974. }
  975. }
  976. }
  977. /**
  978. * Set process name.
  979. *
  980. * @param string $title
  981. * @return void
  982. */
  983. protected static function setProcessTitle($title)
  984. {
  985. // >=php 5.5
  986. if (function_exists('cli_set_process_title')) {
  987. @cli_set_process_title($title);
  988. } // Need proctitle when php<=5.5 .
  989. elseif (extension_loaded('proctitle') && function_exists('setproctitle')) {
  990. @setproctitle($title);
  991. }
  992. }
  993. /**
  994. * Monitor all child processes.
  995. *
  996. * @return void
  997. */
  998. protected static function monitorWorkers()
  999. {
  1000. self::$_status = self::STATUS_RUNNING;
  1001. while (1) {
  1002. // Calls signal handlers for pending signals.
  1003. pcntl_signal_dispatch();
  1004. // Suspends execution of the current process until a child has exited, or until a signal is delivered
  1005. $status = 0;
  1006. $pid = pcntl_wait($status, WUNTRACED);
  1007. // Calls signal handlers for pending signals again.
  1008. pcntl_signal_dispatch();
  1009. // If a child has already exited.
  1010. if ($pid > 0) {
  1011. // Find out witch worker process exited.
  1012. foreach (self::$_pidMap as $worker_id => $worker_pid_array) {
  1013. if (isset($worker_pid_array[$pid])) {
  1014. $worker = self::$_workers[$worker_id];
  1015. // Exit status.
  1016. if ($status !== 0) {
  1017. self::log("worker[" . $worker->name . ":$pid] exit with status $status");
  1018. }
  1019. // For Statistics.
  1020. if (!isset(self::$_globalStatistics['worker_exit_info'][$worker_id][$status])) {
  1021. self::$_globalStatistics['worker_exit_info'][$worker_id][$status] = 0;
  1022. }
  1023. self::$_globalStatistics['worker_exit_info'][$worker_id][$status]++;
  1024. // Clear process data.
  1025. unset(self::$_pidMap[$worker_id][$pid]);
  1026. // Mark id is available.
  1027. $id = self::getId($worker_id, $pid);
  1028. self::$_idMap[$worker_id][$id] = 0;
  1029. break;
  1030. }
  1031. }
  1032. // Is still running state then fork a new worker process.
  1033. if (self::$_status !== self::STATUS_SHUTDOWN) {
  1034. self::forkWorkers();
  1035. // If reloading continue.
  1036. if (isset(self::$_pidsToRestart[$pid])) {
  1037. unset(self::$_pidsToRestart[$pid]);
  1038. self::reload();
  1039. }
  1040. } else {
  1041. // If shutdown state and all child processes exited then master process exit.
  1042. if (!self::getAllWorkerPids()) {
  1043. self::exitAndClearAll();
  1044. }
  1045. }
  1046. } else {
  1047. // If shutdown state and all child processes exited then master process exit.
  1048. if (self::$_status === self::STATUS_SHUTDOWN && !self::getAllWorkerPids()) {
  1049. self::exitAndClearAll();
  1050. }
  1051. }
  1052. }
  1053. }
  1054. /**
  1055. * Exit current process.
  1056. *
  1057. * @return void
  1058. */
  1059. protected static function exitAndClearAll()
  1060. {
  1061. foreach (self::$_workers as $worker) {
  1062. $socket_name = $worker->getSocketName();
  1063. if ($worker->transport === 'unix' && $socket_name) {
  1064. list(, $address) = explode(':', $socket_name, 2);
  1065. @unlink($address);
  1066. }
  1067. }
  1068. @unlink(self::$pidFile);
  1069. self::log("Workerman[" . basename(self::$_startFile) . "] has been stopped");
  1070. if (self::$onMasterStop) {
  1071. call_user_func(self::$onMasterStop);
  1072. }
  1073. exit(0);
  1074. }
  1075. /**
  1076. * Execute reload.
  1077. *
  1078. * @return void
  1079. */
  1080. protected static function reload()
  1081. {
  1082. // For master process.
  1083. if (self::$_masterPid === posix_getpid()) {
  1084. // Set reloading state.
  1085. if (self::$_status !== self::STATUS_RELOADING && self::$_status !== self::STATUS_SHUTDOWN) {
  1086. self::log("Workerman[" . basename(self::$_startFile) . "] reloading");
  1087. self::$_status = self::STATUS_RELOADING;
  1088. // Try to emit onMasterReload callback.
  1089. if (self::$onMasterReload) {
  1090. try {
  1091. call_user_func(self::$onMasterReload);
  1092. } catch (\Exception $e) {
  1093. self::log($e);
  1094. exit(250);
  1095. } catch (\Error $e) {
  1096. self::log($e);
  1097. exit(250);
  1098. }
  1099. self::initId();
  1100. }
  1101. }
  1102. // Send reload signal to all child processes.
  1103. $reloadable_pid_array = array();
  1104. foreach (self::$_pidMap as $worker_id => $worker_pid_array) {
  1105. $worker = self::$_workers[$worker_id];
  1106. if ($worker->reloadable) {
  1107. foreach ($worker_pid_array as $pid) {
  1108. $reloadable_pid_array[$pid] = $pid;
  1109. }
  1110. } else {
  1111. foreach ($worker_pid_array as $pid) {
  1112. // Send reload signal to a worker process which reloadable is false.
  1113. posix_kill($pid, SIGUSR1);
  1114. }
  1115. }
  1116. }
  1117. // Get all pids that are waiting reload.
  1118. self::$_pidsToRestart = array_intersect(self::$_pidsToRestart, $reloadable_pid_array);
  1119. // Reload complete.
  1120. if (empty(self::$_pidsToRestart)) {
  1121. if (self::$_status !== self::STATUS_SHUTDOWN) {
  1122. self::$_status = self::STATUS_RUNNING;
  1123. }
  1124. return;
  1125. }
  1126. // Continue reload.
  1127. $one_worker_pid = current(self::$_pidsToRestart);
  1128. // Send reload signal to a worker process.
  1129. posix_kill($one_worker_pid, SIGUSR1);
  1130. // If the process does not exit after self::KILL_WORKER_TIMER_TIME seconds try to kill it.
  1131. Timer::add(self::KILL_WORKER_TIMER_TIME, 'posix_kill', array($one_worker_pid, SIGKILL), false);
  1132. } // For child processes.
  1133. else {
  1134. reset(self::$_workers);
  1135. $worker = current(self::$_workers);
  1136. // Try to emit onWorkerReload callback.
  1137. if ($worker->onWorkerReload) {
  1138. try {
  1139. call_user_func($worker->onWorkerReload, $worker);
  1140. } catch (\Exception $e) {
  1141. self::log($e);
  1142. exit(250);
  1143. } catch (\Error $e) {
  1144. self::log($e);
  1145. exit(250);
  1146. }
  1147. }
  1148. if ($worker->reloadable) {
  1149. self::stopAll();
  1150. }
  1151. }
  1152. }
  1153. /**
  1154. * Stop.
  1155. *
  1156. * @return void
  1157. */
  1158. public static function stopAll()
  1159. {
  1160. self::$_status = self::STATUS_SHUTDOWN;
  1161. // For master process.
  1162. if (self::$_masterPid === posix_getpid()) {
  1163. self::log("Workerman[" . basename(self::$_startFile) . "] Stopping ...");
  1164. $worker_pid_array = self::getAllWorkerPids();
  1165. // Send stop signal to all child processes.
  1166. foreach ($worker_pid_array as $worker_pid) {
  1167. posix_kill($worker_pid, SIGINT);
  1168. Timer::add(self::KILL_WORKER_TIMER_TIME, 'posix_kill', array($worker_pid, SIGKILL), false);
  1169. }
  1170. // Remove statistics file.
  1171. if (is_file(self::$_statisticsFile)) {
  1172. @unlink(self::$_statisticsFile);
  1173. }
  1174. } // For child processes.
  1175. else {
  1176. // Execute exit.
  1177. foreach (self::$_workers as $worker) {
  1178. $worker->stop();
  1179. }
  1180. self::$globalEvent->destroy();
  1181. exit(0);
  1182. }
  1183. }
  1184. /**
  1185. * Write statistics data to disk.
  1186. *
  1187. * @return void
  1188. */
  1189. protected static function writeStatisticsToStatusFile()
  1190. {
  1191. // For master process.
  1192. if (self::$_masterPid === posix_getpid()) {
  1193. $all_worker_info = array();
  1194. foreach(self::$_pidMap as $worker_id => $pid_array) {
  1195. /** @var Worker $worker */
  1196. $worker = self::$_workers[$worker_id];
  1197. foreach($pid_array as $pid) {
  1198. $all_worker_info[$pid] = array('name' => $worker->name, 'listen' => $worker->getSocketName());
  1199. }
  1200. }
  1201. file_put_contents(self::$_statisticsFile, json_encode($all_worker_info)."\n", FILE_APPEND);
  1202. $loadavg = function_exists('sys_getloadavg') ? array_map('round', sys_getloadavg(), array(2)) : array('-', '-', '-');
  1203. file_put_contents(self::$_statisticsFile,
  1204. "---------------------------------------GLOBAL STATUS--------------------------------------------\n", FILE_APPEND);
  1205. file_put_contents(self::$_statisticsFile,
  1206. 'Workerman version:' . Worker::VERSION . " PHP version:" . PHP_VERSION . "\n", FILE_APPEND);
  1207. file_put_contents(self::$_statisticsFile, 'start time:' . date('Y-m-d H:i:s',
  1208. 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",
  1209. FILE_APPEND);
  1210. $load_str = 'load average: ' . implode(", ", $loadavg);
  1211. file_put_contents(self::$_statisticsFile,
  1212. str_pad($load_str, 33) . 'event-loop:' . self::getEventLoopName() . "\n", FILE_APPEND);
  1213. file_put_contents(self::$_statisticsFile,
  1214. count(self::$_pidMap) . ' workers ' . count(self::getAllWorkerPids()) . " processes\n",
  1215. FILE_APPEND);
  1216. file_put_contents(self::$_statisticsFile,
  1217. str_pad('worker_name', self::$_maxWorkerNameLength) . " exit_status exit_count\n", FILE_APPEND);
  1218. foreach (self::$_pidMap as $worker_id => $worker_pid_array) {
  1219. $worker = self::$_workers[$worker_id];
  1220. if (isset(self::$_globalStatistics['worker_exit_info'][$worker_id])) {
  1221. foreach (self::$_globalStatistics['worker_exit_info'][$worker_id] as $worker_exit_status => $worker_exit_count) {
  1222. file_put_contents(self::$_statisticsFile,
  1223. str_pad($worker->name, self::$_maxWorkerNameLength) . " " . str_pad($worker_exit_status,
  1224. 16) . " $worker_exit_count\n", FILE_APPEND);
  1225. }
  1226. } else {
  1227. file_put_contents(self::$_statisticsFile,
  1228. str_pad($worker->name, self::$_maxWorkerNameLength) . " " . str_pad(0, 16) . " 0\n",
  1229. FILE_APPEND);
  1230. }
  1231. }
  1232. file_put_contents(self::$_statisticsFile,
  1233. "---------------------------------------PROCESS STATUS-------------------------------------------\n",
  1234. FILE_APPEND);
  1235. file_put_contents(self::$_statisticsFile,
  1236. "pid\tmemory " . str_pad('listening', self::$_maxSocketNameLength) . " " . str_pad('worker_name',
  1237. self::$_maxWorkerNameLength) . " connections " . str_pad('total_request',
  1238. 13) . " " . str_pad('send_fail', 9) . " " . str_pad('timers', 8) . " status\n", FILE_APPEND);
  1239. chmod(self::$_statisticsFile, 0722);
  1240. foreach (self::getAllWorkerPids() as $worker_pid) {
  1241. posix_kill($worker_pid, SIGUSR2);
  1242. }
  1243. return;
  1244. }
  1245. // For child processes.
  1246. /** @var Worker $worker */
  1247. $worker = current(self::$_workers);
  1248. $worker_status_str = posix_getpid() . "\t" . str_pad(round(memory_get_usage(true) / (1024 * 1024), 2) . "M",
  1249. 7) . " " . str_pad($worker->getSocketName(),
  1250. self::$_maxSocketNameLength) . " " . str_pad(($worker->name === $worker->getSocketName() ? 'none' : $worker->name),
  1251. self::$_maxWorkerNameLength) . " ";
  1252. $worker_status_str .= str_pad(ConnectionInterface::$statistics['connection_count'],
  1253. 11) . " " . str_pad(ConnectionInterface::$statistics['total_request'],
  1254. 13) . " " . str_pad(ConnectionInterface::$statistics['send_fail'],
  1255. 9) . " " . str_pad(self::$globalEvent->getTimerCount(), 8) . "\n";
  1256. file_put_contents(self::$_statisticsFile, $worker_status_str, FILE_APPEND);
  1257. }
  1258. /**
  1259. * Write statistics data to disk.
  1260. *
  1261. * @return void
  1262. */
  1263. protected static function writeConnectionsStatisticsToStatusFile()
  1264. {
  1265. // For master process.
  1266. if (self::$_masterPid === posix_getpid()) {
  1267. file_put_contents(self::$_statisticsFile, "--------------------------------------------------------------------- WORKERMAN CONNECTION STATUS --------------------------------------------------------------------------------\n", FILE_APPEND);
  1268. file_put_contents(self::$_statisticsFile, "PID Worker CID Trans Protocol ipv4 ipv6 Recv-Q Send-Q Bytes-R Bytes-W Status Local Address Foreign Address\n", FILE_APPEND);
  1269. chmod(self::$_statisticsFile, 0722);
  1270. foreach (self::getAllWorkerPids() as $worker_pid) {
  1271. posix_kill($worker_pid, SIGIO);
  1272. }
  1273. return;
  1274. }
  1275. // For child processes.
  1276. $bytes_format = function($bytes)
  1277. {
  1278. if($bytes > 1024*1024*1024*1024) {
  1279. return round($bytes/(1024*1024*1024*1024), 1)."TB";
  1280. }
  1281. if($bytes > 1024*1024*1024) {
  1282. return round($bytes/(1024*1024*1024), 1)."GB";
  1283. }
  1284. if($bytes > 1024*1024) {
  1285. return round($bytes/(1024*1024), 1)."MB";
  1286. }
  1287. if($bytes > 1024) {
  1288. return round($bytes/(1024), 1)."KB";
  1289. }
  1290. return $bytes."B";
  1291. };
  1292. $pid = posix_getpid();
  1293. $str = '';
  1294. reset(self::$_workers);
  1295. $current_worker = current(self::$_workers);
  1296. $default_worker_name = $current_worker->name;
  1297. /** @var Worker $worker */
  1298. foreach(TcpConnection::$connections as $connection) {
  1299. /** @var Connection\TcpConnection $connection */
  1300. $transport = $connection->transport;
  1301. $ipv4 = $connection->isIpV4() ? ' 1' : ' 0';
  1302. $ipv6 = $connection->isIpV6() ? ' 1' : ' 0';
  1303. $recv_q = $bytes_format($connection->getRecvBufferQueueSize());
  1304. $send_q = $bytes_format($connection->getSendBufferQueueSize());
  1305. $local_address = trim($connection->getLocalAddress());
  1306. $remote_address = trim($connection->getRemoteAddress());
  1307. $state = $connection->getStatus(false);
  1308. $bytes_read = $bytes_format($connection->bytesRead);
  1309. $bytes_written = $bytes_format($connection->bytesWritten);
  1310. $id = $connection->id;
  1311. $protocol = $connection->protocol ? $connection->protocol : $connection->transport;
  1312. $pos = strrpos($protocol, '\\');
  1313. if ($pos) {
  1314. $protocol = substr($protocol, $pos+1);
  1315. }
  1316. if (strlen($protocol) > 15) {
  1317. $protocol = substr($protocol, 0, 13) . '..';
  1318. }
  1319. $worker_name = isset($connection->worker) ? $connection->worker->name : $default_worker_name;
  1320. if (strlen($worker_name) > 14) {
  1321. $worker_name = substr($worker_name, 0, 12) . '..';
  1322. }
  1323. $str .= str_pad($pid, 9) . str_pad($worker_name, 16) . str_pad($id, 10) . str_pad($transport, 8)
  1324. . str_pad($protocol, 16) . str_pad($ipv4, 7) . str_pad($ipv6, 7) . str_pad($recv_q, 13)
  1325. . str_pad($send_q, 13) . str_pad($bytes_read, 13) . str_pad($bytes_written, 13) . ' '
  1326. . str_pad($state, 14) . ' ' . str_pad($local_address, 22) . ' ' . str_pad($remote_address, 22) ."\n";
  1327. }
  1328. if ($str) {
  1329. file_put_contents(self::$_statisticsFile, $str, FILE_APPEND);
  1330. }
  1331. }
  1332. /**
  1333. * Check errors when current process exited.
  1334. *
  1335. * @return void
  1336. */
  1337. public static function checkErrors()
  1338. {
  1339. if (self::STATUS_SHUTDOWN != self::$_status) {
  1340. $error_msg = 'Worker['. posix_getpid() .'] process terminated';
  1341. $errors = error_get_last();
  1342. if ($errors && ($errors['type'] === E_ERROR ||
  1343. $errors['type'] === E_PARSE ||
  1344. $errors['type'] === E_CORE_ERROR ||
  1345. $errors['type'] === E_COMPILE_ERROR ||
  1346. $errors['type'] === E_RECOVERABLE_ERROR)
  1347. ) {
  1348. $error_msg .= ' with ERROR: ' . self::getErrorType($errors['type']) . " \"{$errors['message']} in {$errors['file']} on line {$errors['line']}\"";
  1349. }
  1350. self::log($error_msg);
  1351. }
  1352. }
  1353. /**
  1354. * Get error message by error code.
  1355. *
  1356. * @param integer $type
  1357. * @return string
  1358. */
  1359. protected static function getErrorType($type)
  1360. {
  1361. switch ($type) {
  1362. case E_ERROR: // 1 //
  1363. return 'E_ERROR';
  1364. case E_WARNING: // 2 //
  1365. return 'E_WARNING';
  1366. case E_PARSE: // 4 //
  1367. return 'E_PARSE';
  1368. case E_NOTICE: // 8 //
  1369. return 'E_NOTICE';
  1370. case E_CORE_ERROR: // 16 //
  1371. return 'E_CORE_ERROR';
  1372. case E_CORE_WARNING: // 32 //
  1373. return 'E_CORE_WARNING';
  1374. case E_COMPILE_ERROR: // 64 //
  1375. return 'E_COMPILE_ERROR';
  1376. case E_COMPILE_WARNING: // 128 //
  1377. return 'E_COMPILE_WARNING';
  1378. case E_USER_ERROR: // 256 //
  1379. return 'E_USER_ERROR';
  1380. case E_USER_WARNING: // 512 //
  1381. return 'E_USER_WARNING';
  1382. case E_USER_NOTICE: // 1024 //
  1383. return 'E_USER_NOTICE';
  1384. case E_STRICT: // 2048 //
  1385. return 'E_STRICT';
  1386. case E_RECOVERABLE_ERROR: // 4096 //
  1387. return 'E_RECOVERABLE_ERROR';
  1388. case E_DEPRECATED: // 8192 //
  1389. return 'E_DEPRECATED';
  1390. case E_USER_DEPRECATED: // 16384 //
  1391. return 'E_USER_DEPRECATED';
  1392. }
  1393. return "";
  1394. }
  1395. /**
  1396. * Log.
  1397. *
  1398. * @param string $msg
  1399. * @return void
  1400. */
  1401. public static function log($msg)
  1402. {
  1403. $msg = $msg . "\n";
  1404. if (!self::$daemonize) {
  1405. self::safeEcho($msg);
  1406. }
  1407. file_put_contents((string)self::$logFile, date('Y-m-d H:i:s') . ' ' . 'pid:'. posix_getpid() . ' ' . $msg, FILE_APPEND | LOCK_EX);
  1408. }
  1409. /**
  1410. * Safe Echo.
  1411. *
  1412. * @param $msg
  1413. */
  1414. public static function safeEcho($msg)
  1415. {
  1416. if (!function_exists('posix_isatty') || posix_isatty(STDOUT)) {
  1417. echo $msg;
  1418. }
  1419. }
  1420. /**
  1421. * Construct.
  1422. *
  1423. * @param string $socket_name
  1424. * @param array $context_option
  1425. */
  1426. public function __construct($socket_name = '', $context_option = array())
  1427. {
  1428. // Save all worker instances.
  1429. $this->workerId = spl_object_hash($this);
  1430. self::$_workers[$this->workerId] = $this;
  1431. self::$_pidMap[$this->workerId] = array();
  1432. // Get autoload root path.
  1433. $backtrace = debug_backtrace();
  1434. $this->_autoloadRootPath = dirname($backtrace[0]['file']);
  1435. // Context for socket.
  1436. if ($socket_name) {
  1437. $this->_socketName = $socket_name;
  1438. if (!isset($context_option['socket']['backlog'])) {
  1439. $context_option['socket']['backlog'] = self::DEFAULT_BACKLOG;
  1440. }
  1441. $this->_context = stream_context_create($context_option);
  1442. }
  1443. // Set an empty onMessage callback.
  1444. $this->onMessage = function () {
  1445. };
  1446. }
  1447. /**
  1448. * Listen port.
  1449. *
  1450. * @throws Exception
  1451. */
  1452. public function listen()
  1453. {
  1454. if (!$this->_socketName || $this->_mainSocket) {
  1455. return;
  1456. }
  1457. // Autoload.
  1458. Autoloader::setRootPath($this->_autoloadRootPath);
  1459. // Get the application layer communication protocol and listening address.
  1460. list($scheme, $address) = explode(':', $this->_socketName, 2);
  1461. // Check application layer protocol class.
  1462. if (!isset(self::$_builtinTransports[$scheme])) {
  1463. $scheme = ucfirst($scheme);
  1464. $this->protocol = '\\Protocols\\' . $scheme;
  1465. if (!class_exists($this->protocol)) {
  1466. $this->protocol = "\\Workerman\\Protocols\\$scheme";
  1467. if (!class_exists($this->protocol)) {
  1468. throw new Exception("class \\Protocols\\$scheme not exist");
  1469. }
  1470. }
  1471. if (!isset(self::$_builtinTransports[$this->transport])) {
  1472. throw new \Exception('Bad worker->transport ' . var_export($this->transport, true));
  1473. }
  1474. } else {
  1475. $this->transport = $scheme;
  1476. }
  1477. $local_socket = self::$_builtinTransports[$this->transport] . ":" . $address;
  1478. // Flag.
  1479. $flags = $this->transport === 'udp' ? STREAM_SERVER_BIND : STREAM_SERVER_BIND | STREAM_SERVER_LISTEN;
  1480. $errno = 0;
  1481. $errmsg = '';
  1482. // SO_REUSEPORT.
  1483. if ($this->reusePort) {
  1484. stream_context_set_option($this->_context, 'socket', 'so_reuseport', 1);
  1485. }
  1486. // Create an Internet or Unix domain server socket.
  1487. $this->_mainSocket = stream_socket_server($local_socket, $errno, $errmsg, $flags, $this->_context);
  1488. if (!$this->_mainSocket) {
  1489. throw new Exception($errmsg);
  1490. }
  1491. if ($this->transport === 'ssl') {
  1492. stream_socket_enable_crypto($this->_mainSocket, false);
  1493. }
  1494. // Try to open keepalive for tcp and disable Nagle algorithm.
  1495. if (function_exists('socket_import_stream') && self::$_builtinTransports[$this->transport] === 'tcp') {
  1496. $socket = socket_import_stream($this->_mainSocket);
  1497. @socket_set_option($socket, SOL_SOCKET, SO_KEEPALIVE, 1);
  1498. @socket_set_option($socket, SOL_TCP, TCP_NODELAY, 1);
  1499. }
  1500. // Non blocking.
  1501. stream_set_blocking($this->_mainSocket, 0);
  1502. // Register a listener to be notified when server socket is ready to read.
  1503. if (self::$globalEvent) {
  1504. if ($this->transport !== 'udp') {
  1505. self::$globalEvent->add($this->_mainSocket, EventInterface::EV_READ, array($this, 'acceptConnection'));
  1506. } else {
  1507. self::$globalEvent->add($this->_mainSocket, EventInterface::EV_READ,
  1508. array($this, 'acceptUdpConnection'));
  1509. }
  1510. }
  1511. }
  1512. /**
  1513. * Get socket name.
  1514. *
  1515. * @return string
  1516. */
  1517. public function getSocketName()
  1518. {
  1519. return $this->_socketName ? lcfirst($this->_socketName) : 'none';
  1520. }
  1521. /**
  1522. * Run worker instance.
  1523. *
  1524. * @return void
  1525. */
  1526. public function run()
  1527. {
  1528. //Update process state.
  1529. self::$_status = self::STATUS_RUNNING;
  1530. // Register shutdown function for checking errors.
  1531. register_shutdown_function(array("\\Workerman\\Worker", 'checkErrors'));
  1532. // Set autoload root path.
  1533. Autoloader::setRootPath($this->_autoloadRootPath);
  1534. // Create a global event loop.
  1535. if (!self::$globalEvent) {
  1536. $event_loop_class = self::getEventLoopName();
  1537. self::$globalEvent = new $event_loop_class;
  1538. // Register a listener to be notified when server socket is ready to read.
  1539. if ($this->_socketName) {
  1540. if ($this->transport !== 'udp') {
  1541. self::$globalEvent->add($this->_mainSocket, EventInterface::EV_READ,
  1542. array($this, 'acceptConnection'));
  1543. } else {
  1544. self::$globalEvent->add($this->_mainSocket, EventInterface::EV_READ,
  1545. array($this, 'acceptUdpConnection'));
  1546. }
  1547. }
  1548. }
  1549. // Reinstall signal.
  1550. self::reinstallSignal();
  1551. // Init Timer.
  1552. Timer::init(self::$globalEvent);
  1553. // Try to emit onWorkerStart callback.
  1554. if ($this->onWorkerStart) {
  1555. try {
  1556. call_user_func($this->onWorkerStart, $this);
  1557. } catch (\Exception $e) {
  1558. self::log($e);
  1559. // Avoid rapid infinite loop exit.
  1560. sleep(1);
  1561. exit(250);
  1562. } catch (\Error $e) {
  1563. self::log($e);
  1564. // Avoid rapid infinite loop exit.
  1565. sleep(1);
  1566. exit(250);
  1567. }
  1568. }
  1569. // Main loop.
  1570. self::$globalEvent->loop();
  1571. }
  1572. /**
  1573. * Stop current worker instance.
  1574. *
  1575. * @return void
  1576. */
  1577. public function stop()
  1578. {
  1579. // Try to emit onWorkerStop callback.
  1580. if ($this->onWorkerStop) {
  1581. try {
  1582. call_user_func($this->onWorkerStop, $this);
  1583. } catch (\Exception $e) {
  1584. self::log($e);
  1585. exit(250);
  1586. } catch (\Error $e) {
  1587. self::log($e);
  1588. exit(250);
  1589. }
  1590. }
  1591. // Remove listener for server socket.
  1592. if ($this->_mainSocket) {
  1593. self::$globalEvent->del($this->_mainSocket, EventInterface::EV_READ);
  1594. @fclose($this->_mainSocket);
  1595. }
  1596. }
  1597. /**
  1598. * Accept a connection.
  1599. *
  1600. * @param resource $socket
  1601. * @return void
  1602. */
  1603. public function acceptConnection($socket)
  1604. {
  1605. // Accept a connection on server socket.
  1606. $new_socket = @stream_socket_accept($socket, 0, $remote_address);
  1607. // Thundering herd.
  1608. if (!$new_socket) {
  1609. return;
  1610. }
  1611. // TcpConnection.
  1612. $connection = new TcpConnection($new_socket, $remote_address);
  1613. $this->connections[$connection->id] = $connection;
  1614. $connection->worker = $this;
  1615. $connection->protocol = $this->protocol;
  1616. $connection->transport = $this->transport;
  1617. $connection->onMessage = $this->onMessage;
  1618. $connection->onClose = $this->onClose;
  1619. $connection->onError = $this->onError;
  1620. $connection->onBufferDrain = $this->onBufferDrain;
  1621. $connection->onBufferFull = $this->onBufferFull;
  1622. // Try to emit onConnect callback.
  1623. if ($this->onConnect) {
  1624. try {
  1625. call_user_func($this->onConnect, $connection);
  1626. } catch (\Exception $e) {
  1627. self::log($e);
  1628. exit(250);
  1629. } catch (\Error $e) {
  1630. self::log($e);
  1631. exit(250);
  1632. }
  1633. }
  1634. }
  1635. /**
  1636. * For udp package.
  1637. *
  1638. * @param resource $socket
  1639. * @return bool
  1640. */
  1641. public function acceptUdpConnection($socket)
  1642. {
  1643. $recv_buffer = stream_socket_recvfrom($socket, self::MAX_UDP_PACKAGE_SIZE, 0, $remote_address);
  1644. if (false === $recv_buffer || empty($remote_address)) {
  1645. return false;
  1646. }
  1647. // UdpConnection.
  1648. $connection = new UdpConnection($socket, $remote_address);
  1649. $connection->protocol = $this->protocol;
  1650. if ($this->onMessage) {
  1651. if ($this->protocol !== null) {
  1652. $parser = $this->protocol;
  1653. $recv_buffer = $parser::decode($recv_buffer, $connection);
  1654. // Discard bad packets.
  1655. if ($recv_buffer === false)
  1656. return true;
  1657. }
  1658. ConnectionInterface::$statistics['total_request']++;
  1659. try {
  1660. call_user_func($this->onMessage, $connection, $recv_buffer);
  1661. } catch (\Exception $e) {
  1662. self::log($e);
  1663. exit(250);
  1664. } catch (\Error $e) {
  1665. self::log($e);
  1666. exit(250);
  1667. }
  1668. }
  1669. return true;
  1670. }
  1671. }