Worker.php 62 KB

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