Worker.php 79 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549
  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 Workerman\Events\Select;
  22. use \Exception;
  23. /**
  24. * Worker class
  25. * A container for listening ports
  26. */
  27. class Worker
  28. {
  29. /**
  30. * Version.
  31. *
  32. * @var string
  33. */
  34. const VERSION = '4.0.8';
  35. /**
  36. * Status starting.
  37. *
  38. * @var int
  39. */
  40. const STATUS_STARTING = 1;
  41. /**
  42. * Status running.
  43. *
  44. * @var int
  45. */
  46. const STATUS_RUNNING = 2;
  47. /**
  48. * Status shutdown.
  49. *
  50. * @var int
  51. */
  52. const STATUS_SHUTDOWN = 4;
  53. /**
  54. * Status reloading.
  55. *
  56. * @var int
  57. */
  58. const STATUS_RELOADING = 8;
  59. /**
  60. * After sending the restart command to the child process KILL_WORKER_TIMER_TIME seconds,
  61. * if the process is still living then forced to kill.
  62. *
  63. * @var int
  64. */
  65. const KILL_WORKER_TIMER_TIME = 2;
  66. /**
  67. * Default backlog. Backlog is the maximum length of the queue of pending connections.
  68. *
  69. * @var int
  70. */
  71. const DEFAULT_BACKLOG = 102400;
  72. /**
  73. * Max udp package size.
  74. *
  75. * @var int
  76. */
  77. const MAX_UDP_PACKAGE_SIZE = 65535;
  78. /**
  79. * The safe distance for columns adjacent
  80. *
  81. * @var int
  82. */
  83. const UI_SAFE_LENGTH = 4;
  84. /**
  85. * Worker id.
  86. *
  87. * @var int
  88. */
  89. public $id = 0;
  90. /**
  91. * Name of the worker processes.
  92. *
  93. * @var string
  94. */
  95. public $name = 'none';
  96. /**
  97. * Number of worker processes.
  98. *
  99. * @var int
  100. */
  101. public $count = 1;
  102. /**
  103. * Unix user of processes, needs appropriate privileges (usually root).
  104. *
  105. * @var string
  106. */
  107. public $user = '';
  108. /**
  109. * Unix group of processes, needs appropriate privileges (usually root).
  110. *
  111. * @var string
  112. */
  113. public $group = '';
  114. /**
  115. * reloadable.
  116. *
  117. * @var bool
  118. */
  119. public $reloadable = true;
  120. /**
  121. * reuse port.
  122. *
  123. * @var bool
  124. */
  125. public $reusePort = false;
  126. /**
  127. * Emitted when worker processes start.
  128. *
  129. * @var callable
  130. */
  131. public $onWorkerStart = null;
  132. /**
  133. * Emitted when a socket connection is successfully established.
  134. *
  135. * @var callable
  136. */
  137. public $onConnect = null;
  138. /**
  139. * Emitted when data is received.
  140. *
  141. * @var callable
  142. */
  143. public $onMessage = null;
  144. /**
  145. * Emitted when the other end of the socket sends a FIN packet.
  146. *
  147. * @var callable
  148. */
  149. public $onClose = null;
  150. /**
  151. * Emitted when an error occurs with connection.
  152. *
  153. * @var callable
  154. */
  155. public $onError = null;
  156. /**
  157. * Emitted when the send buffer becomes full.
  158. *
  159. * @var callable
  160. */
  161. public $onBufferFull = null;
  162. /**
  163. * Emitted when the send buffer becomes empty.
  164. *
  165. * @var callable
  166. */
  167. public $onBufferDrain = null;
  168. /**
  169. * Emitted when worker processes stoped.
  170. *
  171. * @var callable
  172. */
  173. public $onWorkerStop = null;
  174. /**
  175. * Emitted when worker processes get reload signal.
  176. *
  177. * @var callable
  178. */
  179. public $onWorkerReload = null;
  180. /**
  181. * Transport layer protocol.
  182. *
  183. * @var string
  184. */
  185. public $transport = 'tcp';
  186. /**
  187. * Store all connections of clients.
  188. *
  189. * @var array
  190. */
  191. public $connections = array();
  192. /**
  193. * Application layer protocol.
  194. *
  195. * @var string
  196. */
  197. public $protocol = null;
  198. /**
  199. * Root path for autoload.
  200. *
  201. * @var string
  202. */
  203. protected $_autoloadRootPath = '';
  204. /**
  205. * Pause accept new connections or not.
  206. *
  207. * @var bool
  208. */
  209. protected $_pauseAccept = true;
  210. /**
  211. * Is worker stopping ?
  212. * @var bool
  213. */
  214. public $stopping = false;
  215. /**
  216. * Daemonize.
  217. *
  218. * @var bool
  219. */
  220. public static $daemonize = false;
  221. /**
  222. * Stdout file.
  223. *
  224. * @var string
  225. */
  226. public static $stdoutFile = '/dev/null';
  227. /**
  228. * The file to store master process PID.
  229. *
  230. * @var string
  231. */
  232. public static $pidFile = '';
  233. /**
  234. * Log file.
  235. *
  236. * @var mixed
  237. */
  238. public static $logFile = '';
  239. /**
  240. * Global event loop.
  241. *
  242. * @var EventInterface
  243. */
  244. public static $globalEvent = null;
  245. /**
  246. * Emitted when the master process get reload signal.
  247. *
  248. * @var callable
  249. */
  250. public static $onMasterReload = null;
  251. /**
  252. * Emitted when the master process terminated.
  253. *
  254. * @var callable
  255. */
  256. public static $onMasterStop = null;
  257. /**
  258. * EventLoopClass
  259. *
  260. * @var string
  261. */
  262. public static $eventLoopClass = '';
  263. /**
  264. * Process title
  265. *
  266. * @var string
  267. */
  268. public static $processTitle = 'WorkerMan';
  269. /**
  270. * The PID of master process.
  271. *
  272. * @var int
  273. */
  274. protected static $_masterPid = 0;
  275. /**
  276. * Listening socket.
  277. *
  278. * @var resource
  279. */
  280. protected $_mainSocket = null;
  281. /**
  282. * Socket name. The format is like this http://0.0.0.0:80 .
  283. *
  284. * @var string
  285. */
  286. protected $_socketName = '';
  287. /** parse from _socketName avoid parse again in master or worker
  288. * LocalSocket The format is like tcp://0.0.0.0:8080
  289. * @var string
  290. */
  291. protected $_localSocket=null;
  292. /**
  293. * Context of socket.
  294. *
  295. * @var resource
  296. */
  297. protected $_context = null;
  298. /**
  299. * All worker instances.
  300. *
  301. * @var Worker[]
  302. */
  303. protected static $_workers = array();
  304. /**
  305. * All worker processes pid.
  306. * The format is like this [worker_id=>[pid=>pid, pid=>pid, ..], ..]
  307. *
  308. * @var array
  309. */
  310. protected static $_pidMap = array();
  311. /**
  312. * All worker processes waiting for restart.
  313. * The format is like this [pid=>pid, pid=>pid].
  314. *
  315. * @var array
  316. */
  317. protected static $_pidsToRestart = array();
  318. /**
  319. * Mapping from PID to worker process ID.
  320. * The format is like this [worker_id=>[0=>$pid, 1=>$pid, ..], ..].
  321. *
  322. * @var array
  323. */
  324. protected static $_idMap = array();
  325. /**
  326. * Current status.
  327. *
  328. * @var int
  329. */
  330. protected static $_status = self::STATUS_STARTING;
  331. /**
  332. * Maximum length of the worker names.
  333. *
  334. * @var int
  335. */
  336. protected static $_maxWorkerNameLength = 12;
  337. /**
  338. * Maximum length of the socket names.
  339. *
  340. * @var int
  341. */
  342. protected static $_maxSocketNameLength = 12;
  343. /**
  344. * Maximum length of the process user names.
  345. *
  346. * @var int
  347. */
  348. protected static $_maxUserNameLength = 12;
  349. /**
  350. * Maximum length of the Proto names.
  351. *
  352. * @var int
  353. */
  354. protected static $_maxProtoNameLength = 4;
  355. /**
  356. * Maximum length of the Processes names.
  357. *
  358. * @var int
  359. */
  360. protected static $_maxProcessesNameLength = 9;
  361. /**
  362. * Maximum length of the Status names.
  363. *
  364. * @var int
  365. */
  366. protected static $_maxStatusNameLength = 1;
  367. /**
  368. * The file to store status info of current worker process.
  369. *
  370. * @var string
  371. */
  372. protected static $_statisticsFile = '';
  373. /**
  374. * Start file.
  375. *
  376. * @var string
  377. */
  378. protected static $_startFile = '';
  379. /**
  380. * OS.
  381. *
  382. * @var string
  383. */
  384. protected static $_OS = \OS_TYPE_LINUX;
  385. /**
  386. * Processes for windows.
  387. *
  388. * @var array
  389. */
  390. protected static $_processForWindows = array();
  391. /**
  392. * Status info of current worker process.
  393. *
  394. * @var array
  395. */
  396. protected static $_globalStatistics = array(
  397. 'start_timestamp' => 0,
  398. 'worker_exit_info' => array()
  399. );
  400. /**
  401. * Available event loops.
  402. *
  403. * @var array
  404. */
  405. protected static $_availableEventLoops = array(
  406. 'libevent' => '\Workerman\Events\Libevent',
  407. 'event' => '\Workerman\Events\Event'
  408. // Temporarily removed swoole because it is not stable enough
  409. //'swoole' => '\Workerman\Events\Swoole'
  410. );
  411. /**
  412. * PHP built-in protocols.
  413. *
  414. * @var array
  415. */
  416. protected static $_builtinTransports = array(
  417. 'tcp' => 'tcp',
  418. 'udp' => 'udp',
  419. 'unix' => 'unix',
  420. 'ssl' => 'tcp'
  421. );
  422. /**
  423. * PHP built-in error types.
  424. *
  425. * @var array
  426. */
  427. protected static $_errorType = array(
  428. \E_ERROR => 'E_ERROR', // 1
  429. \E_WARNING => 'E_WARNING', // 2
  430. \E_PARSE => 'E_PARSE', // 4
  431. \E_NOTICE => 'E_NOTICE', // 8
  432. \E_CORE_ERROR => 'E_CORE_ERROR', // 16
  433. \E_CORE_WARNING => 'E_CORE_WARNING', // 32
  434. \E_COMPILE_ERROR => 'E_COMPILE_ERROR', // 64
  435. \E_COMPILE_WARNING => 'E_COMPILE_WARNING', // 128
  436. \E_USER_ERROR => 'E_USER_ERROR', // 256
  437. \E_USER_WARNING => 'E_USER_WARNING', // 512
  438. \E_USER_NOTICE => 'E_USER_NOTICE', // 1024
  439. \E_STRICT => 'E_STRICT', // 2048
  440. \E_RECOVERABLE_ERROR => 'E_RECOVERABLE_ERROR', // 4096
  441. \E_DEPRECATED => 'E_DEPRECATED', // 8192
  442. \E_USER_DEPRECATED => 'E_USER_DEPRECATED' // 16384
  443. );
  444. /**
  445. * Graceful stop or not.
  446. *
  447. * @var bool
  448. */
  449. protected static $_gracefulStop = false;
  450. /**
  451. * Standard output stream
  452. * @var resource
  453. */
  454. protected static $_outputStream = null;
  455. /**
  456. * If $outputStream support decorated
  457. * @var bool
  458. */
  459. protected static $_outputDecorated = null;
  460. /**
  461. * Run all worker instances.
  462. *
  463. * @return void
  464. */
  465. public static function runAll()
  466. {
  467. static::checkSapiEnv();
  468. static::init();
  469. static::lock();
  470. static::parseCommand();
  471. static::daemonize();
  472. static::initWorkers();
  473. static::installSignal();
  474. static::saveMasterPid();
  475. static::unlock();
  476. static::displayUI();
  477. static::forkWorkers();
  478. static::resetStd();
  479. static::monitorWorkers();
  480. }
  481. /**
  482. * Check sapi.
  483. *
  484. * @return void
  485. */
  486. protected static function checkSapiEnv()
  487. {
  488. // Only for cli.
  489. if (\PHP_SAPI !== 'cli') {
  490. exit("Only run in command line mode \n");
  491. }
  492. if (\DIRECTORY_SEPARATOR === '\\') {
  493. self::$_OS = \OS_TYPE_WINDOWS;
  494. }
  495. }
  496. /**
  497. * Init.
  498. *
  499. * @return void
  500. */
  501. protected static function init()
  502. {
  503. \set_error_handler(function($code, $msg, $file, $line){
  504. Worker::safeEcho("$msg in file $file on line $line\n");
  505. });
  506. // Start file.
  507. $backtrace = \debug_backtrace();
  508. static::$_startFile = $backtrace[\count($backtrace) - 1]['file'];
  509. $unique_prefix = \str_replace('/', '_', static::$_startFile);
  510. // Pid file.
  511. if (empty(static::$pidFile)) {
  512. static::$pidFile = __DIR__ . "/../$unique_prefix.pid";
  513. }
  514. // Log file.
  515. if (empty(static::$logFile)) {
  516. static::$logFile = __DIR__ . '/../workerman.log';
  517. }
  518. $log_file = (string)static::$logFile;
  519. if (!\is_file($log_file)) {
  520. \touch($log_file);
  521. \chmod($log_file, 0622);
  522. }
  523. // State.
  524. static::$_status = static::STATUS_STARTING;
  525. // For statistics.
  526. static::$_globalStatistics['start_timestamp'] = \time();
  527. static::$_statisticsFile = \sys_get_temp_dir() . "/$unique_prefix.status";
  528. // Process title.
  529. static::setProcessTitle(static::$processTitle . ': master process start_file=' . static::$_startFile);
  530. // Init data for worker id.
  531. static::initId();
  532. // Timer init.
  533. Timer::init();
  534. }
  535. /**
  536. * Lock.
  537. *
  538. * @return void
  539. */
  540. protected static function lock()
  541. {
  542. $fd = \fopen(static::$_startFile, 'r');
  543. if ($fd && !flock($fd, LOCK_EX)) {
  544. static::log('Workerman['.static::$_startFile.'] already running.');
  545. exit;
  546. }
  547. }
  548. /**
  549. * Unlock.
  550. *
  551. * @return void
  552. */
  553. protected static function unlock()
  554. {
  555. $fd = \fopen(static::$_startFile, 'r');
  556. $fd && flock($fd, \LOCK_UN);
  557. }
  558. /**
  559. * Init All worker instances.
  560. *
  561. * @return void
  562. */
  563. protected static function initWorkers()
  564. {
  565. if (static::$_OS !== \OS_TYPE_LINUX) {
  566. return;
  567. }
  568. foreach (static::$_workers as $worker) {
  569. // Worker name.
  570. if (empty($worker->name)) {
  571. $worker->name = 'none';
  572. }
  573. // Get unix user of the worker process.
  574. if (empty($worker->user)) {
  575. $worker->user = static::getCurrentUser();
  576. } else {
  577. if (\posix_getuid() !== 0 && $worker->user !== static::getCurrentUser()) {
  578. static::log('Warning: You must have the root privileges to change uid and gid.');
  579. }
  580. }
  581. // Socket name.
  582. $worker->socket = $worker->getSocketName();
  583. // Status name.
  584. $worker->status = '<g> [OK] </g>';
  585. // Get column mapping for UI
  586. foreach(static::getUiColumns() as $column_name => $prop){
  587. !isset($worker->{$prop}) && $worker->{$prop} = 'NNNN';
  588. $prop_length = \strlen($worker->{$prop});
  589. $key = '_max' . \ucfirst(\strtolower($column_name)) . 'NameLength';
  590. static::$$key = \max(static::$$key, $prop_length);
  591. }
  592. // Listen.
  593. if (!$worker->reusePort) {
  594. $worker->listen();
  595. }
  596. }
  597. }
  598. /**
  599. * Reload all worker instances.
  600. *
  601. * @return void
  602. */
  603. public static function reloadAllWorkers()
  604. {
  605. static::init();
  606. static::initWorkers();
  607. static::displayUI();
  608. static::$_status = static::STATUS_RELOADING;
  609. }
  610. /**
  611. * Get all worker instances.
  612. *
  613. * @return array
  614. */
  615. public static function getAllWorkers()
  616. {
  617. return static::$_workers;
  618. }
  619. /**
  620. * Get global event-loop instance.
  621. *
  622. * @return EventInterface
  623. */
  624. public static function getEventLoop()
  625. {
  626. return static::$globalEvent;
  627. }
  628. /**
  629. * Get main socket resource
  630. * @return resource
  631. */
  632. public function getMainSocket(){
  633. return $this->_mainSocket;
  634. }
  635. /**
  636. * Init idMap.
  637. * return void
  638. */
  639. protected static function initId()
  640. {
  641. foreach (static::$_workers as $worker_id => $worker) {
  642. $new_id_map = array();
  643. $worker->count = $worker->count < 1 ? 1 : $worker->count;
  644. for($key = 0; $key < $worker->count; $key++) {
  645. $new_id_map[$key] = isset(static::$_idMap[$worker_id][$key]) ? static::$_idMap[$worker_id][$key] : 0;
  646. }
  647. static::$_idMap[$worker_id] = $new_id_map;
  648. }
  649. }
  650. /**
  651. * Get unix user of current porcess.
  652. *
  653. * @return string
  654. */
  655. protected static function getCurrentUser()
  656. {
  657. $user_info = \posix_getpwuid(\posix_getuid());
  658. return $user_info['name'];
  659. }
  660. /**
  661. * Display staring UI.
  662. *
  663. * @return void
  664. */
  665. protected static function displayUI()
  666. {
  667. global $argv;
  668. if (\in_array('-q', $argv)) {
  669. return;
  670. }
  671. if (static::$_OS !== \OS_TYPE_LINUX) {
  672. static::safeEcho("----------------------- WORKERMAN -----------------------------\r\n");
  673. static::safeEcho('Workerman version:'. static::VERSION. ' PHP version:'. \PHP_VERSION. "\r\n");
  674. static::safeEcho("------------------------ WORKERS -------------------------------\r\n");
  675. static::safeEcho("worker listen processes status\r\n");
  676. return;
  677. }
  678. //show version
  679. $line_version = 'Workerman version:' . static::VERSION . \str_pad('PHP version:', 22, ' ', \STR_PAD_LEFT) . \PHP_VERSION . \PHP_EOL;
  680. !\defined('LINE_VERSIOIN_LENGTH') && \define('LINE_VERSIOIN_LENGTH', \strlen($line_version));
  681. $total_length = static::getSingleLineTotalLength();
  682. $line_one = '<n>' . \str_pad('<w> WORKERMAN </w>', $total_length + \strlen('<w></w>'), '-', \STR_PAD_BOTH) . '</n>'. \PHP_EOL;
  683. $line_two = \str_pad('<w> WORKERS </w>' , $total_length + \strlen('<w></w>'), '-', \STR_PAD_BOTH) . \PHP_EOL;
  684. static::safeEcho($line_one . $line_version . $line_two);
  685. //Show title
  686. $title = '';
  687. foreach(static::getUiColumns() as $column_name => $prop){
  688. $key = '_max' . \ucfirst(\strtolower($column_name)) . 'NameLength';
  689. //just keep compatible with listen name
  690. $column_name === 'socket' && $column_name = 'listen';
  691. $title.= "<w>{$column_name}</w>" . \str_pad('', static::$$key + static::UI_SAFE_LENGTH - \strlen($column_name));
  692. }
  693. $title && static::safeEcho($title . \PHP_EOL);
  694. //Show content
  695. foreach (static::$_workers as $worker) {
  696. $content = '';
  697. foreach(static::getUiColumns() as $column_name => $prop){
  698. $key = '_max' . \ucfirst(\strtolower($column_name)) . 'NameLength';
  699. \preg_match_all("/(<n>|<\/n>|<w>|<\/w>|<g>|<\/g>)/is", $worker->{$prop}, $matches);
  700. $place_holder_length = !empty($matches) ? \strlen(\implode('', $matches[0])) : 0;
  701. $content .= \str_pad($worker->{$prop}, static::$$key + static::UI_SAFE_LENGTH + $place_holder_length);
  702. }
  703. $content && static::safeEcho($content . \PHP_EOL);
  704. }
  705. //Show last line
  706. $line_last = \str_pad('', static::getSingleLineTotalLength(), '-') . \PHP_EOL;
  707. !empty($content) && static::safeEcho($line_last);
  708. if (static::$daemonize) {
  709. static::safeEcho("Input \"php $argv[0] stop\" to stop. Start success.\n\n");
  710. } else {
  711. static::safeEcho("Press Ctrl+C to stop. Start success.\n");
  712. }
  713. }
  714. /**
  715. * Get UI columns to be shown in terminal
  716. *
  717. * 1. $column_map: array('ui_column_name' => 'clas_property_name')
  718. * 2. Consider move into configuration in future
  719. *
  720. * @return array
  721. */
  722. public static function getUiColumns()
  723. {
  724. return array(
  725. 'proto' => 'transport',
  726. 'user' => 'user',
  727. 'worker' => 'name',
  728. 'socket' => 'socket',
  729. 'processes' => 'count',
  730. 'status' => 'status',
  731. );
  732. }
  733. /**
  734. * Get single line total length for ui
  735. *
  736. * @return int
  737. */
  738. public static function getSingleLineTotalLength()
  739. {
  740. $total_length = 0;
  741. foreach(static::getUiColumns() as $column_name => $prop){
  742. $key = '_max' . \ucfirst(\strtolower($column_name)) . 'NameLength';
  743. $total_length += static::$$key + static::UI_SAFE_LENGTH;
  744. }
  745. //keep beauty when show less colums
  746. !\defined('LINE_VERSIOIN_LENGTH') && \define('LINE_VERSIOIN_LENGTH', 0);
  747. $total_length <= LINE_VERSIOIN_LENGTH && $total_length = LINE_VERSIOIN_LENGTH;
  748. return $total_length;
  749. }
  750. /**
  751. * Parse command.
  752. *
  753. * @return void
  754. */
  755. protected static function parseCommand()
  756. {
  757. if (static::$_OS !== \OS_TYPE_LINUX) {
  758. return;
  759. }
  760. global $argv;
  761. // Check argv;
  762. $start_file = $argv[0];
  763. $available_commands = array(
  764. 'start',
  765. 'stop',
  766. 'restart',
  767. 'reload',
  768. 'status',
  769. 'connections',
  770. );
  771. $usage = "Usage: php yourfile <command> [mode]\nCommands: \nstart\t\tStart worker in DEBUG mode.\n\t\tUse mode -d to start in DAEMON mode.\nstop\t\tStop worker.\n\t\tUse mode -g to stop gracefully.\nrestart\t\tRestart workers.\n\t\tUse mode -d to start in DAEMON mode.\n\t\tUse mode -g to stop gracefully.\nreload\t\tReload codes.\n\t\tUse mode -g to reload gracefully.\nstatus\t\tGet worker status.\n\t\tUse mode -d to show live status.\nconnections\tGet worker connections.\n";
  772. if (!isset($argv[1]) || !\in_array($argv[1], $available_commands)) {
  773. if (isset($argv[1])) {
  774. static::safeEcho('Unknown command: ' . $argv[1] . "\n");
  775. }
  776. exit($usage);
  777. }
  778. // Get command.
  779. $command = \trim($argv[1]);
  780. $command2 = isset($argv[2]) ? $argv[2] : '';
  781. // Start command.
  782. $mode = '';
  783. if ($command === 'start') {
  784. if ($command2 === '-d' || static::$daemonize) {
  785. $mode = 'in DAEMON mode';
  786. } else {
  787. $mode = 'in DEBUG mode';
  788. }
  789. }
  790. static::log("Workerman[$start_file] $command $mode");
  791. // Get master process PID.
  792. $master_pid = \is_file(static::$pidFile) ? \file_get_contents(static::$pidFile) : 0;
  793. $master_is_alive = $master_pid && \posix_kill($master_pid, 0) && \posix_getpid() !== $master_pid;
  794. // Master is still alive?
  795. if ($master_is_alive) {
  796. if ($command === 'start') {
  797. static::log("Workerman[$start_file] already running");
  798. exit;
  799. }
  800. } elseif ($command !== 'start' && $command !== 'restart') {
  801. static::log("Workerman[$start_file] not run");
  802. exit;
  803. }
  804. // execute command.
  805. switch ($command) {
  806. case 'start':
  807. if ($command2 === '-d') {
  808. static::$daemonize = true;
  809. }
  810. break;
  811. case 'status':
  812. while (1) {
  813. if (\is_file(static::$_statisticsFile)) {
  814. @\unlink(static::$_statisticsFile);
  815. }
  816. // Master process will send SIGUSR2 signal to all child processes.
  817. \posix_kill($master_pid, SIGUSR2);
  818. // Sleep 1 second.
  819. \sleep(1);
  820. // Clear terminal.
  821. if ($command2 === '-d') {
  822. static::safeEcho("\33[H\33[2J\33(B\33[m", true);
  823. }
  824. // Echo status data.
  825. static::safeEcho(static::formatStatusData());
  826. if ($command2 !== '-d') {
  827. exit(0);
  828. }
  829. static::safeEcho("\nPress Ctrl+C to quit.\n\n");
  830. }
  831. exit(0);
  832. case 'connections':
  833. if (\is_file(static::$_statisticsFile) && \is_writable(static::$_statisticsFile)) {
  834. \unlink(static::$_statisticsFile);
  835. }
  836. // Master process will send SIGIO signal to all child processes.
  837. \posix_kill($master_pid, SIGIO);
  838. // Waiting amoment.
  839. \usleep(500000);
  840. // Display statisitcs data from a disk file.
  841. if(\is_readable(static::$_statisticsFile)) {
  842. \readfile(static::$_statisticsFile);
  843. }
  844. exit(0);
  845. case 'restart':
  846. case 'stop':
  847. if ($command2 === '-g') {
  848. static::$_gracefulStop = true;
  849. $sig = \SIGTERM;
  850. static::log("Workerman[$start_file] is gracefully stopping ...");
  851. } else {
  852. static::$_gracefulStop = false;
  853. $sig = \SIGINT;
  854. static::log("Workerman[$start_file] is stopping ...");
  855. }
  856. // Send stop signal to master process.
  857. $master_pid && \posix_kill($master_pid, $sig);
  858. // Timeout.
  859. $timeout = 5;
  860. $start_time = \time();
  861. // Check master process is still alive?
  862. while (1) {
  863. $master_is_alive = $master_pid && \posix_kill($master_pid, 0);
  864. if ($master_is_alive) {
  865. // Timeout?
  866. if (!static::$_gracefulStop && \time() - $start_time >= $timeout) {
  867. static::log("Workerman[$start_file] stop fail");
  868. exit;
  869. }
  870. // Waiting amoment.
  871. \usleep(10000);
  872. continue;
  873. }
  874. // Stop success.
  875. static::log("Workerman[$start_file] stop success");
  876. if ($command === 'stop') {
  877. exit(0);
  878. }
  879. if ($command2 === '-d') {
  880. static::$daemonize = true;
  881. }
  882. break;
  883. }
  884. break;
  885. case 'reload':
  886. if($command2 === '-g'){
  887. $sig = \SIGQUIT;
  888. }else{
  889. $sig = \SIGUSR1;
  890. }
  891. \posix_kill($master_pid, $sig);
  892. exit;
  893. default :
  894. if (isset($command)) {
  895. static::safeEcho('Unknown command: ' . $command . "\n");
  896. }
  897. exit($usage);
  898. }
  899. }
  900. /**
  901. * Format status data.
  902. *
  903. * @return string
  904. */
  905. protected static function formatStatusData()
  906. {
  907. static $total_request_cache = array();
  908. if (!\is_readable(static::$_statisticsFile)) {
  909. return '';
  910. }
  911. $info = \file(static::$_statisticsFile, \FILE_IGNORE_NEW_LINES);
  912. if (!$info) {
  913. return '';
  914. }
  915. $status_str = '';
  916. $current_total_request = array();
  917. $worker_info = \unserialize($info[0]);
  918. \ksort($worker_info, SORT_NUMERIC);
  919. unset($info[0]);
  920. $data_waiting_sort = array();
  921. $read_process_status = false;
  922. $total_requests = 0;
  923. $total_qps = 0;
  924. $total_connections = 0;
  925. $total_fails = 0;
  926. $total_memory = 0;
  927. $total_timers = 0;
  928. $maxLen1 = static::$_maxSocketNameLength;
  929. $maxLen2 = static::$_maxWorkerNameLength;
  930. foreach($info as $key => $value) {
  931. if (!$read_process_status) {
  932. $status_str .= $value . "\n";
  933. if (\preg_match('/^pid.*?memory.*?listening/', $value)) {
  934. $read_process_status = true;
  935. }
  936. continue;
  937. }
  938. if(\preg_match('/^[0-9]+/', $value, $pid_math)) {
  939. $pid = $pid_math[0];
  940. $data_waiting_sort[$pid] = $value;
  941. if(\preg_match('/^\S+?\s+?(\S+?)\s+?(\S+?)\s+?(\S+?)\s+?(\S+?)\s+?(\S+?)\s+?(\S+?)\s+?(\S+?)\s+?/', $value, $match)) {
  942. $total_memory += \intval(\str_ireplace('M','',$match[1]));
  943. $maxLen1 = \max($maxLen1,\strlen($match[2]));
  944. $maxLen2 = \max($maxLen2,\strlen($match[3]));
  945. $total_connections += \intval($match[4]);
  946. $total_fails += \intval($match[5]);
  947. $total_timers += \intval($match[6]);
  948. $current_total_request[$pid] = $match[7];
  949. $total_requests += \intval($match[7]);
  950. }
  951. }
  952. }
  953. foreach($worker_info as $pid => $info) {
  954. if (!isset($data_waiting_sort[$pid])) {
  955. $status_str .= "$pid\t" . \str_pad('N/A', 7) . " "
  956. . \str_pad($info['listen'], static::$_maxSocketNameLength) . " "
  957. . \str_pad($info['name'], static::$_maxWorkerNameLength) . " "
  958. . \str_pad('N/A', 11) . " " . \str_pad('N/A', 9) . " "
  959. . \str_pad('N/A', 7) . " " . \str_pad('N/A', 13) . " N/A [busy] \n";
  960. continue;
  961. }
  962. //$qps = isset($total_request_cache[$pid]) ? $current_total_request[$pid]
  963. if (!isset($total_request_cache[$pid]) || !isset($current_total_request[$pid])) {
  964. $qps = 0;
  965. } else {
  966. $qps = $current_total_request[$pid] - $total_request_cache[$pid];
  967. $total_qps += $qps;
  968. }
  969. $status_str .= $data_waiting_sort[$pid]. " " . \str_pad($qps, 6) ." [idle]\n";
  970. }
  971. $total_request_cache = $current_total_request;
  972. $status_str .= "----------------------------------------------PROCESS STATUS---------------------------------------------------\n";
  973. $status_str .= "Summary\t" . \str_pad($total_memory.'M', 7) . " "
  974. . \str_pad('-', $maxLen1) . " "
  975. . \str_pad('-', $maxLen2) . " "
  976. . \str_pad($total_connections, 11) . " " . \str_pad($total_fails, 9) . " "
  977. . \str_pad($total_timers, 7) . " " . \str_pad($total_requests, 13) . " "
  978. . \str_pad($total_qps,6)." [Summary] \n";
  979. return $status_str;
  980. }
  981. /**
  982. * Install signal handler.
  983. *
  984. * @return void
  985. */
  986. protected static function installSignal()
  987. {
  988. if (static::$_OS !== \OS_TYPE_LINUX) {
  989. return;
  990. }
  991. $signalHandler = '\Workerman\Worker::signalHandler';
  992. // stop
  993. \pcntl_signal(\SIGINT, $signalHandler, false);
  994. // graceful stop
  995. \pcntl_signal(\SIGTERM, $signalHandler, false);
  996. // reload
  997. \pcntl_signal(\SIGUSR1, $signalHandler, false);
  998. // graceful reload
  999. \pcntl_signal(\SIGQUIT, $signalHandler, false);
  1000. // status
  1001. \pcntl_signal(\SIGUSR2, $signalHandler, false);
  1002. // connection status
  1003. \pcntl_signal(\SIGIO, $signalHandler, false);
  1004. // ignore
  1005. \pcntl_signal(\SIGPIPE, \SIG_IGN, false);
  1006. }
  1007. /**
  1008. * Reinstall signal handler.
  1009. *
  1010. * @return void
  1011. */
  1012. protected static function reinstallSignal()
  1013. {
  1014. if (static::$_OS !== \OS_TYPE_LINUX) {
  1015. return;
  1016. }
  1017. $signalHandler = '\Workerman\Worker::signalHandler';
  1018. // uninstall stop signal handler
  1019. \pcntl_signal(\SIGINT, \SIG_IGN, false);
  1020. // uninstall graceful stop signal handler
  1021. \pcntl_signal(\SIGTERM, \SIG_IGN, false);
  1022. // uninstall reload signal handler
  1023. \pcntl_signal(\SIGUSR1, \SIG_IGN, false);
  1024. // uninstall graceful reload signal handler
  1025. \pcntl_signal(\SIGQUIT, \SIG_IGN, false);
  1026. // uninstall status signal handler
  1027. \pcntl_signal(\SIGUSR2, \SIG_IGN, false);
  1028. // uninstall connections status signal handler
  1029. \pcntl_signal(\SIGIO, \SIG_IGN, false);
  1030. // reinstall stop signal handler
  1031. static::$globalEvent->add(\SIGINT, EventInterface::EV_SIGNAL, $signalHandler);
  1032. // reinstall graceful stop signal handler
  1033. static::$globalEvent->add(\SIGTERM, EventInterface::EV_SIGNAL, $signalHandler);
  1034. // reinstall reload signal handler
  1035. static::$globalEvent->add(\SIGUSR1, EventInterface::EV_SIGNAL, $signalHandler);
  1036. // reinstall graceful reload signal handler
  1037. static::$globalEvent->add(\SIGQUIT, EventInterface::EV_SIGNAL, $signalHandler);
  1038. // reinstall status signal handler
  1039. static::$globalEvent->add(\SIGUSR2, EventInterface::EV_SIGNAL, $signalHandler);
  1040. // reinstall connection status signal handler
  1041. static::$globalEvent->add(\SIGIO, EventInterface::EV_SIGNAL, $signalHandler);
  1042. }
  1043. /**
  1044. * Signal handler.
  1045. *
  1046. * @param int $signal
  1047. */
  1048. public static function signalHandler($signal)
  1049. {
  1050. switch ($signal) {
  1051. // Stop.
  1052. case \SIGINT:
  1053. static::$_gracefulStop = false;
  1054. static::stopAll();
  1055. break;
  1056. // Graceful stop.
  1057. case \SIGTERM:
  1058. static::$_gracefulStop = true;
  1059. static::stopAll();
  1060. break;
  1061. // Reload.
  1062. case \SIGQUIT:
  1063. case \SIGUSR1:
  1064. if($signal === \SIGQUIT){
  1065. static::$_gracefulStop = true;
  1066. }else{
  1067. static::$_gracefulStop = false;
  1068. }
  1069. static::$_pidsToRestart = static::getAllWorkerPids();
  1070. static::reload();
  1071. break;
  1072. // Show status.
  1073. case \SIGUSR2:
  1074. static::writeStatisticsToStatusFile();
  1075. break;
  1076. // Show connection status.
  1077. case \SIGIO:
  1078. static::writeConnectionsStatisticsToStatusFile();
  1079. break;
  1080. }
  1081. }
  1082. /**
  1083. * Run as deamon mode.
  1084. *
  1085. * @throws Exception
  1086. */
  1087. protected static function daemonize()
  1088. {
  1089. if (!static::$daemonize || static::$_OS !== \OS_TYPE_LINUX) {
  1090. return;
  1091. }
  1092. \umask(0);
  1093. $pid = \pcntl_fork();
  1094. if (-1 === $pid) {
  1095. throw new Exception('Fork fail');
  1096. } elseif ($pid > 0) {
  1097. exit(0);
  1098. }
  1099. if (-1 === \posix_setsid()) {
  1100. throw new Exception("Setsid fail");
  1101. }
  1102. // Fork again avoid SVR4 system regain the control of terminal.
  1103. $pid = \pcntl_fork();
  1104. if (-1 === $pid) {
  1105. throw new Exception("Fork fail");
  1106. } elseif (0 !== $pid) {
  1107. exit(0);
  1108. }
  1109. }
  1110. /**
  1111. * Redirect standard input and output.
  1112. *
  1113. * @throws Exception
  1114. */
  1115. public static function resetStd()
  1116. {
  1117. if (!static::$daemonize || static::$_OS !== \OS_TYPE_LINUX) {
  1118. return;
  1119. }
  1120. global $STDOUT, $STDERR;
  1121. $handle = \fopen(static::$stdoutFile, "a");
  1122. if ($handle) {
  1123. unset($handle);
  1124. \set_error_handler(function(){});
  1125. \fclose($STDOUT);
  1126. \fclose($STDERR);
  1127. \fclose(\STDOUT);
  1128. \fclose(\STDERR);
  1129. $STDOUT = \fopen(static::$stdoutFile, "a");
  1130. $STDERR = \fopen(static::$stdoutFile, "a");
  1131. // change output stream
  1132. static::$_outputStream = null;
  1133. static::outputStream($STDOUT);
  1134. \restore_error_handler();
  1135. return;
  1136. }
  1137. throw new Exception('Can not open stdoutFile ' . static::$stdoutFile);
  1138. }
  1139. /**
  1140. * Save pid.
  1141. *
  1142. * @throws Exception
  1143. */
  1144. protected static function saveMasterPid()
  1145. {
  1146. if (static::$_OS !== \OS_TYPE_LINUX) {
  1147. return;
  1148. }
  1149. static::$_masterPid = \posix_getpid();
  1150. if (false === \file_put_contents(static::$pidFile, static::$_masterPid)) {
  1151. throw new Exception('can not save pid to ' . static::$pidFile);
  1152. }
  1153. }
  1154. /**
  1155. * Get event loop name.
  1156. *
  1157. * @return string
  1158. */
  1159. protected static function getEventLoopName()
  1160. {
  1161. if (static::$eventLoopClass) {
  1162. return static::$eventLoopClass;
  1163. }
  1164. if (!\class_exists('\Swoole\Event', false)) {
  1165. unset(static::$_availableEventLoops['swoole']);
  1166. }
  1167. $loop_name = '';
  1168. foreach (static::$_availableEventLoops as $name=>$class) {
  1169. if (\extension_loaded($name)) {
  1170. $loop_name = $name;
  1171. break;
  1172. }
  1173. }
  1174. if ($loop_name) {
  1175. if (\interface_exists('\React\EventLoop\LoopInterface')) {
  1176. switch ($loop_name) {
  1177. case 'libevent':
  1178. static::$eventLoopClass = '\Workerman\Events\React\ExtLibEventLoop';
  1179. break;
  1180. case 'event':
  1181. static::$eventLoopClass = '\Workerman\Events\React\ExtEventLoop';
  1182. break;
  1183. default :
  1184. static::$eventLoopClass = '\Workerman\Events\React\StreamSelectLoop';
  1185. break;
  1186. }
  1187. } else {
  1188. static::$eventLoopClass = static::$_availableEventLoops[$loop_name];
  1189. }
  1190. } else {
  1191. static::$eventLoopClass = \interface_exists('\React\EventLoop\LoopInterface') ? '\Workerman\Events\React\StreamSelectLoop' : '\Workerman\Events\Select';
  1192. }
  1193. return static::$eventLoopClass;
  1194. }
  1195. /**
  1196. * Get all pids of worker processes.
  1197. *
  1198. * @return array
  1199. */
  1200. protected static function getAllWorkerPids()
  1201. {
  1202. $pid_array = array();
  1203. foreach (static::$_pidMap as $worker_pid_array) {
  1204. foreach ($worker_pid_array as $worker_pid) {
  1205. $pid_array[$worker_pid] = $worker_pid;
  1206. }
  1207. }
  1208. return $pid_array;
  1209. }
  1210. /**
  1211. * Fork some worker processes.
  1212. *
  1213. * @return void
  1214. */
  1215. protected static function forkWorkers()
  1216. {
  1217. if (static::$_OS === \OS_TYPE_LINUX) {
  1218. static::forkWorkersForLinux();
  1219. } else {
  1220. static::forkWorkersForWindows();
  1221. }
  1222. }
  1223. /**
  1224. * Fork some worker processes.
  1225. *
  1226. * @return void
  1227. */
  1228. protected static function forkWorkersForLinux()
  1229. {
  1230. foreach (static::$_workers as $worker) {
  1231. if (static::$_status === static::STATUS_STARTING) {
  1232. if (empty($worker->name)) {
  1233. $worker->name = $worker->getSocketName();
  1234. }
  1235. $worker_name_length = \strlen($worker->name);
  1236. if (static::$_maxWorkerNameLength < $worker_name_length) {
  1237. static::$_maxWorkerNameLength = $worker_name_length;
  1238. }
  1239. }
  1240. while (\count(static::$_pidMap[$worker->workerId]) < $worker->count) {
  1241. static::forkOneWorkerForLinux($worker);
  1242. }
  1243. }
  1244. }
  1245. /**
  1246. * Fork some worker processes.
  1247. *
  1248. * @return void
  1249. */
  1250. protected static function forkWorkersForWindows()
  1251. {
  1252. $files = static::getStartFilesForWindows();
  1253. global $argv;
  1254. if(\in_array('-q', $argv) || \count($files) === 1)
  1255. {
  1256. if(\count(static::$_workers) > 1)
  1257. {
  1258. static::safeEcho("@@@ Error: multi workers init in one php file are not support @@@\r\n");
  1259. static::safeEcho("@@@ See http://doc.workerman.net/faq/multi-woker-for-windows.html @@@\r\n");
  1260. }
  1261. elseif(\count(static::$_workers) <= 0)
  1262. {
  1263. exit("@@@no worker inited@@@\r\n\r\n");
  1264. }
  1265. \reset(static::$_workers);
  1266. /** @var Worker $worker */
  1267. $worker = current(static::$_workers);
  1268. // Display UI.
  1269. static::safeEcho(\str_pad($worker->name, 21) . \str_pad($worker->getSocketName(), 36) . \str_pad($worker->count, 10) . "[ok]\n");
  1270. $worker->listen();
  1271. $worker->run();
  1272. exit("@@@child exit@@@\r\n");
  1273. }
  1274. else
  1275. {
  1276. static::$globalEvent = new \Workerman\Events\Select();
  1277. Timer::init(static::$globalEvent);
  1278. foreach($files as $start_file)
  1279. {
  1280. static::forkOneWorkerForWindows($start_file);
  1281. }
  1282. }
  1283. }
  1284. /**
  1285. * Get start files for windows.
  1286. *
  1287. * @return array
  1288. */
  1289. public static function getStartFilesForWindows() {
  1290. global $argv;
  1291. $files = array();
  1292. foreach($argv as $file)
  1293. {
  1294. if(\is_file($file))
  1295. {
  1296. $files[$file] = $file;
  1297. }
  1298. }
  1299. return $files;
  1300. }
  1301. /**
  1302. * Fork one worker process.
  1303. *
  1304. * @param string $start_file
  1305. */
  1306. public static function forkOneWorkerForWindows($start_file)
  1307. {
  1308. $start_file = \realpath($start_file);
  1309. $std_file = \sys_get_temp_dir() . '/'.\str_replace(array('/', "\\", ':'), '_', $start_file).'.out.txt';
  1310. $descriptorspec = array(
  1311. 0 => array('pipe', 'a'), // stdin
  1312. 1 => array('file', $std_file, 'w'), // stdout
  1313. 2 => array('file', $std_file, 'w') // stderr
  1314. );
  1315. $pipes = array();
  1316. $process = \proc_open("php \"$start_file\" -q", $descriptorspec, $pipes);
  1317. $std_handler = \fopen($std_file, 'a+');
  1318. \stream_set_blocking($std_handler, false);
  1319. if (empty(static::$globalEvent)) {
  1320. static::$globalEvent = new Select();
  1321. Timer::init(static::$globalEvent);
  1322. }
  1323. $timer_id = Timer::add(0.1, function()use($std_handler)
  1324. {
  1325. Worker::safeEcho(\fread($std_handler, 65535));
  1326. });
  1327. // 保存子进程句柄
  1328. static::$_processForWindows[$start_file] = array($process, $start_file, $timer_id);
  1329. }
  1330. /**
  1331. * check worker status for windows.
  1332. * @return void
  1333. */
  1334. public static function checkWorkerStatusForWindows()
  1335. {
  1336. foreach(static::$_processForWindows as $process_data)
  1337. {
  1338. $process = $process_data[0];
  1339. $start_file = $process_data[1];
  1340. $timer_id = $process_data[2];
  1341. $status = \proc_get_status($process);
  1342. if(isset($status['running']))
  1343. {
  1344. if(!$status['running'])
  1345. {
  1346. static::safeEcho("process $start_file terminated and try to restart\n");
  1347. Timer::del($timer_id);
  1348. \proc_close($process);
  1349. static::forkOneWorkerForWindows($start_file);
  1350. }
  1351. }
  1352. else
  1353. {
  1354. static::safeEcho("proc_get_status fail\n");
  1355. }
  1356. }
  1357. }
  1358. /**
  1359. * Fork one worker process.
  1360. *
  1361. * @param self $worker
  1362. * @throws Exception
  1363. */
  1364. protected static function forkOneWorkerForLinux(self $worker)
  1365. {
  1366. // Get available worker id.
  1367. $id = static::getId($worker->workerId, 0);
  1368. if ($id === false) {
  1369. return;
  1370. }
  1371. $pid = \pcntl_fork();
  1372. // For master process.
  1373. if ($pid > 0) {
  1374. static::$_pidMap[$worker->workerId][$pid] = $pid;
  1375. static::$_idMap[$worker->workerId][$id] = $pid;
  1376. } // For child processes.
  1377. elseif (0 === $pid) {
  1378. \srand();
  1379. \mt_srand();
  1380. if ($worker->reusePort) {
  1381. $worker->listen();
  1382. }
  1383. if (static::$_status === static::STATUS_STARTING) {
  1384. static::resetStd();
  1385. }
  1386. static::$_pidMap = array();
  1387. // Remove other listener.
  1388. foreach(static::$_workers as $key => $one_worker) {
  1389. if ($one_worker->workerId !== $worker->workerId) {
  1390. $one_worker->unlisten();
  1391. unset(static::$_workers[$key]);
  1392. }
  1393. }
  1394. Timer::delAll();
  1395. static::setProcessTitle(self::$processTitle . ': worker process ' . $worker->name . ' ' . $worker->getSocketName());
  1396. $worker->setUserAndGroup();
  1397. $worker->id = $id;
  1398. $worker->run();
  1399. if (strpos(static::$eventLoopClass, 'Workerman\Events\Swoole') !== false) {
  1400. exit(0);
  1401. }
  1402. $err = new Exception('event-loop exited');
  1403. static::log($err);
  1404. exit(250);
  1405. } else {
  1406. throw new Exception("forkOneWorker fail");
  1407. }
  1408. }
  1409. /**
  1410. * Get worker id.
  1411. *
  1412. * @param int $worker_id
  1413. * @param int $pid
  1414. *
  1415. * @return integer
  1416. */
  1417. protected static function getId($worker_id, $pid)
  1418. {
  1419. return \array_search($pid, static::$_idMap[$worker_id]);
  1420. }
  1421. /**
  1422. * Set unix user and group for current process.
  1423. *
  1424. * @return void
  1425. */
  1426. public function setUserAndGroup()
  1427. {
  1428. // Get uid.
  1429. $user_info = \posix_getpwnam($this->user);
  1430. if (!$user_info) {
  1431. static::log("Warning: User {$this->user} not exsits");
  1432. return;
  1433. }
  1434. $uid = $user_info['uid'];
  1435. // Get gid.
  1436. if ($this->group) {
  1437. $group_info = \posix_getgrnam($this->group);
  1438. if (!$group_info) {
  1439. static::log("Warning: Group {$this->group} not exsits");
  1440. return;
  1441. }
  1442. $gid = $group_info['gid'];
  1443. } else {
  1444. $gid = $user_info['gid'];
  1445. }
  1446. // Set uid and gid.
  1447. if ($uid !== \posix_getuid() || $gid !== \posix_getgid()) {
  1448. if (!\posix_setgid($gid) || !\posix_initgroups($user_info['name'], $gid) || !\posix_setuid($uid)) {
  1449. static::log("Warning: change gid or uid fail.");
  1450. }
  1451. }
  1452. }
  1453. /**
  1454. * Set process name.
  1455. *
  1456. * @param string $title
  1457. * @return void
  1458. */
  1459. protected static function setProcessTitle($title)
  1460. {
  1461. \set_error_handler(function(){});
  1462. // >=php 5.5
  1463. if (\function_exists('cli_set_process_title')) {
  1464. \cli_set_process_title($title);
  1465. } // Need proctitle when php<=5.5 .
  1466. elseif (\extension_loaded('proctitle') && \function_exists('setproctitle')) {
  1467. \setproctitle($title);
  1468. }
  1469. \restore_error_handler();
  1470. }
  1471. /**
  1472. * Monitor all child processes.
  1473. *
  1474. * @return void
  1475. */
  1476. protected static function monitorWorkers()
  1477. {
  1478. if (static::$_OS === \OS_TYPE_LINUX) {
  1479. static::monitorWorkersForLinux();
  1480. } else {
  1481. static::monitorWorkersForWindows();
  1482. }
  1483. }
  1484. /**
  1485. * Monitor all child processes.
  1486. *
  1487. * @return void
  1488. */
  1489. protected static function monitorWorkersForLinux()
  1490. {
  1491. static::$_status = static::STATUS_RUNNING;
  1492. while (1) {
  1493. // Calls signal handlers for pending signals.
  1494. \pcntl_signal_dispatch();
  1495. // Suspends execution of the current process until a child has exited, or until a signal is delivered
  1496. $status = 0;
  1497. $pid = \pcntl_wait($status, \WUNTRACED);
  1498. // Calls signal handlers for pending signals again.
  1499. \pcntl_signal_dispatch();
  1500. // If a child has already exited.
  1501. if ($pid > 0) {
  1502. // Find out which worker process exited.
  1503. foreach (static::$_pidMap as $worker_id => $worker_pid_array) {
  1504. if (isset($worker_pid_array[$pid])) {
  1505. $worker = static::$_workers[$worker_id];
  1506. // Exit status.
  1507. if ($status !== 0) {
  1508. static::log("worker[" . $worker->name . ":$pid] exit with status $status");
  1509. }
  1510. // For Statistics.
  1511. if (!isset(static::$_globalStatistics['worker_exit_info'][$worker_id][$status])) {
  1512. static::$_globalStatistics['worker_exit_info'][$worker_id][$status] = 0;
  1513. }
  1514. ++static::$_globalStatistics['worker_exit_info'][$worker_id][$status];
  1515. // Clear process data.
  1516. unset(static::$_pidMap[$worker_id][$pid]);
  1517. // Mark id is available.
  1518. $id = static::getId($worker_id, $pid);
  1519. static::$_idMap[$worker_id][$id] = 0;
  1520. break;
  1521. }
  1522. }
  1523. // Is still running state then fork a new worker process.
  1524. if (static::$_status !== static::STATUS_SHUTDOWN) {
  1525. static::forkWorkers();
  1526. // If reloading continue.
  1527. if (isset(static::$_pidsToRestart[$pid])) {
  1528. unset(static::$_pidsToRestart[$pid]);
  1529. static::reload();
  1530. }
  1531. }
  1532. }
  1533. // If shutdown state and all child processes exited then master process exit.
  1534. if (static::$_status === static::STATUS_SHUTDOWN && !static::getAllWorkerPids()) {
  1535. static::exitAndClearAll();
  1536. }
  1537. }
  1538. }
  1539. /**
  1540. * Monitor all child processes.
  1541. *
  1542. * @return void
  1543. */
  1544. protected static function monitorWorkersForWindows()
  1545. {
  1546. Timer::add(1, "\\Workerman\\Worker::checkWorkerStatusForWindows");
  1547. static::$globalEvent->loop();
  1548. }
  1549. /**
  1550. * Exit current process.
  1551. *
  1552. * @return void
  1553. */
  1554. protected static function exitAndClearAll()
  1555. {
  1556. foreach (static::$_workers as $worker) {
  1557. $socket_name = $worker->getSocketName();
  1558. if ($worker->transport === 'unix' && $socket_name) {
  1559. list(, $address) = \explode(':', $socket_name, 2);
  1560. @\unlink($address);
  1561. }
  1562. }
  1563. @\unlink(static::$pidFile);
  1564. static::log("Workerman[" . \basename(static::$_startFile) . "] has been stopped");
  1565. if (static::$onMasterStop) {
  1566. \call_user_func(static::$onMasterStop);
  1567. }
  1568. exit(0);
  1569. }
  1570. /**
  1571. * Execute reload.
  1572. *
  1573. * @return void
  1574. */
  1575. protected static function reload()
  1576. {
  1577. // For master process.
  1578. if (static::$_masterPid === \posix_getpid()) {
  1579. // Set reloading state.
  1580. if (static::$_status !== static::STATUS_RELOADING && static::$_status !== static::STATUS_SHUTDOWN) {
  1581. static::log("Workerman[" . \basename(static::$_startFile) . "] reloading");
  1582. static::$_status = static::STATUS_RELOADING;
  1583. // Try to emit onMasterReload callback.
  1584. if (static::$onMasterReload) {
  1585. try {
  1586. \call_user_func(static::$onMasterReload);
  1587. } catch (\Exception $e) {
  1588. static::log($e);
  1589. exit(250);
  1590. } catch (\Error $e) {
  1591. static::log($e);
  1592. exit(250);
  1593. }
  1594. static::initId();
  1595. }
  1596. }
  1597. if (static::$_gracefulStop) {
  1598. $sig = \SIGQUIT;
  1599. } else {
  1600. $sig = \SIGUSR1;
  1601. }
  1602. // Send reload signal to all child processes.
  1603. $reloadable_pid_array = array();
  1604. foreach (static::$_pidMap as $worker_id => $worker_pid_array) {
  1605. $worker = static::$_workers[$worker_id];
  1606. if ($worker->reloadable) {
  1607. foreach ($worker_pid_array as $pid) {
  1608. $reloadable_pid_array[$pid] = $pid;
  1609. }
  1610. } else {
  1611. foreach ($worker_pid_array as $pid) {
  1612. // Send reload signal to a worker process which reloadable is false.
  1613. \posix_kill($pid, $sig);
  1614. }
  1615. }
  1616. }
  1617. // Get all pids that are waiting reload.
  1618. static::$_pidsToRestart = \array_intersect(static::$_pidsToRestart, $reloadable_pid_array);
  1619. // Reload complete.
  1620. if (empty(static::$_pidsToRestart)) {
  1621. if (static::$_status !== static::STATUS_SHUTDOWN) {
  1622. static::$_status = static::STATUS_RUNNING;
  1623. }
  1624. return;
  1625. }
  1626. // Continue reload.
  1627. $one_worker_pid = \current(static::$_pidsToRestart);
  1628. // Send reload signal to a worker process.
  1629. \posix_kill($one_worker_pid, $sig);
  1630. // If the process does not exit after static::KILL_WORKER_TIMER_TIME seconds try to kill it.
  1631. if(!static::$_gracefulStop){
  1632. Timer::add(static::KILL_WORKER_TIMER_TIME, '\posix_kill', array($one_worker_pid, \SIGKILL), false);
  1633. }
  1634. } // For child processes.
  1635. else {
  1636. \reset(static::$_workers);
  1637. $worker = \current(static::$_workers);
  1638. // Try to emit onWorkerReload callback.
  1639. if ($worker->onWorkerReload) {
  1640. try {
  1641. \call_user_func($worker->onWorkerReload, $worker);
  1642. } catch (\Exception $e) {
  1643. static::log($e);
  1644. exit(250);
  1645. } catch (\Error $e) {
  1646. static::log($e);
  1647. exit(250);
  1648. }
  1649. }
  1650. if ($worker->reloadable) {
  1651. static::stopAll();
  1652. }
  1653. }
  1654. }
  1655. /**
  1656. * Stop.
  1657. *
  1658. * @return void
  1659. */
  1660. public static function stopAll()
  1661. {
  1662. static::$_status = static::STATUS_SHUTDOWN;
  1663. // For master process.
  1664. if (static::$_masterPid === \posix_getpid()) {
  1665. static::log("Workerman[" . \basename(static::$_startFile) . "] stopping ...");
  1666. $worker_pid_array = static::getAllWorkerPids();
  1667. // Send stop signal to all child processes.
  1668. if (static::$_gracefulStop) {
  1669. $sig = \SIGTERM;
  1670. } else {
  1671. $sig = \SIGINT;
  1672. }
  1673. foreach ($worker_pid_array as $worker_pid) {
  1674. \posix_kill($worker_pid, $sig);
  1675. if(!static::$_gracefulStop){
  1676. Timer::add(static::KILL_WORKER_TIMER_TIME, '\posix_kill', array($worker_pid, \SIGKILL), false);
  1677. }
  1678. }
  1679. Timer::add(1, "\\Workerman\\Worker::checkIfChildRunning");
  1680. // Remove statistics file.
  1681. if (\is_file(static::$_statisticsFile)) {
  1682. @\unlink(static::$_statisticsFile);
  1683. }
  1684. } // For child processes.
  1685. else {
  1686. // Execute exit.
  1687. foreach (static::$_workers as $worker) {
  1688. if(!$worker->stopping){
  1689. $worker->stop();
  1690. $worker->stopping = true;
  1691. }
  1692. }
  1693. if (!static::$_gracefulStop || ConnectionInterface::$statistics['connection_count'] <= 0) {
  1694. static::$_workers = array();
  1695. if (static::$globalEvent) {
  1696. static::$globalEvent->destroy();
  1697. }
  1698. try {
  1699. exit(0);
  1700. } catch (Exception $e) {
  1701. }
  1702. }
  1703. }
  1704. }
  1705. /**
  1706. * check if child processes is really running
  1707. */
  1708. public static function checkIfChildRunning()
  1709. {
  1710. foreach (static::$_pidMap as $worker_id => $worker_pid_array) {
  1711. foreach ($worker_pid_array as $pid => $worker_pid) {
  1712. if (!\posix_kill($pid, 0)) {
  1713. unset(static::$_pidMap[$worker_id][$pid]);
  1714. }
  1715. }
  1716. }
  1717. }
  1718. /**
  1719. * Get process status.
  1720. *
  1721. * @return number
  1722. */
  1723. public static function getStatus()
  1724. {
  1725. return static::$_status;
  1726. }
  1727. /**
  1728. * If stop gracefully.
  1729. *
  1730. * @return bool
  1731. */
  1732. public static function getGracefulStop()
  1733. {
  1734. return static::$_gracefulStop;
  1735. }
  1736. /**
  1737. * Write statistics data to disk.
  1738. *
  1739. * @return void
  1740. */
  1741. protected static function writeStatisticsToStatusFile()
  1742. {
  1743. // For master process.
  1744. if (static::$_masterPid === \posix_getpid()) {
  1745. $all_worker_info = array();
  1746. foreach(static::$_pidMap as $worker_id => $pid_array) {
  1747. /** @var /Workerman/Worker $worker */
  1748. $worker = static::$_workers[$worker_id];
  1749. foreach($pid_array as $pid) {
  1750. $all_worker_info[$pid] = array('name' => $worker->name, 'listen' => $worker->getSocketName());
  1751. }
  1752. }
  1753. \file_put_contents(static::$_statisticsFile, \serialize($all_worker_info)."\n", \FILE_APPEND);
  1754. $loadavg = \function_exists('sys_getloadavg') ? \array_map('round', \sys_getloadavg(), array(2)) : array('-', '-', '-');
  1755. \file_put_contents(static::$_statisticsFile,
  1756. "----------------------------------------------GLOBAL STATUS----------------------------------------------------\n", \FILE_APPEND);
  1757. \file_put_contents(static::$_statisticsFile,
  1758. 'Workerman version:' . static::VERSION . " PHP version:" . \PHP_VERSION . "\n", \FILE_APPEND);
  1759. \file_put_contents(static::$_statisticsFile, 'start time:' . \date('Y-m-d H:i:s',
  1760. static::$_globalStatistics['start_timestamp']) . ' run ' . \floor((\time() - static::$_globalStatistics['start_timestamp']) / (24 * 60 * 60)) . ' days ' . \floor(((\time() - static::$_globalStatistics['start_timestamp']) % (24 * 60 * 60)) / (60 * 60)) . " hours \n",
  1761. FILE_APPEND);
  1762. $load_str = 'load average: ' . \implode(", ", $loadavg);
  1763. \file_put_contents(static::$_statisticsFile,
  1764. \str_pad($load_str, 33) . 'event-loop:' . static::getEventLoopName() . "\n", \FILE_APPEND);
  1765. \file_put_contents(static::$_statisticsFile,
  1766. \count(static::$_pidMap) . ' workers ' . \count(static::getAllWorkerPids()) . " processes\n",
  1767. \FILE_APPEND);
  1768. \file_put_contents(static::$_statisticsFile,
  1769. \str_pad('worker_name', static::$_maxWorkerNameLength) . " exit_status exit_count\n", \FILE_APPEND);
  1770. foreach (static::$_pidMap as $worker_id => $worker_pid_array) {
  1771. $worker = static::$_workers[$worker_id];
  1772. if (isset(static::$_globalStatistics['worker_exit_info'][$worker_id])) {
  1773. foreach (static::$_globalStatistics['worker_exit_info'][$worker_id] as $worker_exit_status => $worker_exit_count) {
  1774. \file_put_contents(static::$_statisticsFile,
  1775. \str_pad($worker->name, static::$_maxWorkerNameLength) . " " . \str_pad($worker_exit_status,
  1776. 16) . " $worker_exit_count\n", \FILE_APPEND);
  1777. }
  1778. } else {
  1779. \file_put_contents(static::$_statisticsFile,
  1780. \str_pad($worker->name, static::$_maxWorkerNameLength) . " " . \str_pad(0, 16) . " 0\n",
  1781. \FILE_APPEND);
  1782. }
  1783. }
  1784. \file_put_contents(static::$_statisticsFile,
  1785. "----------------------------------------------PROCESS STATUS---------------------------------------------------\n",
  1786. \FILE_APPEND);
  1787. \file_put_contents(static::$_statisticsFile,
  1788. "pid\tmemory " . \str_pad('listening', static::$_maxSocketNameLength) . " " . \str_pad('worker_name',
  1789. static::$_maxWorkerNameLength) . " connections " . \str_pad('send_fail', 9) . " "
  1790. . \str_pad('timers', 8) . \str_pad('total_request', 13) ." qps status\n", \FILE_APPEND);
  1791. \chmod(static::$_statisticsFile, 0722);
  1792. foreach (static::getAllWorkerPids() as $worker_pid) {
  1793. \posix_kill($worker_pid, \SIGUSR2);
  1794. }
  1795. return;
  1796. }
  1797. // For child processes.
  1798. \reset(static::$_workers);
  1799. /** @var \Workerman\Worker $worker */
  1800. $worker = current(static::$_workers);
  1801. $worker_status_str = \posix_getpid() . "\t" . \str_pad(round(memory_get_usage(true) / (1024 * 1024), 2) . "M", 7)
  1802. . " " . \str_pad($worker->getSocketName(), static::$_maxSocketNameLength) . " "
  1803. . \str_pad(($worker->name === $worker->getSocketName() ? 'none' : $worker->name), static::$_maxWorkerNameLength)
  1804. . " ";
  1805. $worker_status_str .= \str_pad(ConnectionInterface::$statistics['connection_count'], 11)
  1806. . " " . \str_pad(ConnectionInterface::$statistics['send_fail'], 9)
  1807. . " " . \str_pad(static::$globalEvent->getTimerCount(), 7)
  1808. . " " . \str_pad(ConnectionInterface::$statistics['total_request'], 13) . "\n";
  1809. \file_put_contents(static::$_statisticsFile, $worker_status_str, \FILE_APPEND);
  1810. }
  1811. /**
  1812. * Write statistics data to disk.
  1813. *
  1814. * @return void
  1815. */
  1816. protected static function writeConnectionsStatisticsToStatusFile()
  1817. {
  1818. // For master process.
  1819. if (static::$_masterPid === \posix_getpid()) {
  1820. \file_put_contents(static::$_statisticsFile, "--------------------------------------------------------------------- WORKERMAN CONNECTION STATUS --------------------------------------------------------------------------------\n", \FILE_APPEND);
  1821. \file_put_contents(static::$_statisticsFile, "PID Worker CID Trans Protocol ipv4 ipv6 Recv-Q Send-Q Bytes-R Bytes-W Status Local Address Foreign Address\n", \FILE_APPEND);
  1822. \chmod(static::$_statisticsFile, 0722);
  1823. foreach (static::getAllWorkerPids() as $worker_pid) {
  1824. \posix_kill($worker_pid, \SIGIO);
  1825. }
  1826. return;
  1827. }
  1828. // For child processes.
  1829. $bytes_format = function($bytes)
  1830. {
  1831. if($bytes > 1024*1024*1024*1024) {
  1832. return round($bytes/(1024*1024*1024*1024), 1)."TB";
  1833. }
  1834. if($bytes > 1024*1024*1024) {
  1835. return round($bytes/(1024*1024*1024), 1)."GB";
  1836. }
  1837. if($bytes > 1024*1024) {
  1838. return round($bytes/(1024*1024), 1)."MB";
  1839. }
  1840. if($bytes > 1024) {
  1841. return round($bytes/(1024), 1)."KB";
  1842. }
  1843. return $bytes."B";
  1844. };
  1845. $pid = \posix_getpid();
  1846. $str = '';
  1847. \reset(static::$_workers);
  1848. $current_worker = current(static::$_workers);
  1849. $default_worker_name = $current_worker->name;
  1850. /** @var \Workerman\Worker $worker */
  1851. foreach(TcpConnection::$connections as $connection) {
  1852. /** @var \Workerman\Connection\TcpConnection $connection */
  1853. $transport = $connection->transport;
  1854. $ipv4 = $connection->isIpV4() ? ' 1' : ' 0';
  1855. $ipv6 = $connection->isIpV6() ? ' 1' : ' 0';
  1856. $recv_q = $bytes_format($connection->getRecvBufferQueueSize());
  1857. $send_q = $bytes_format($connection->getSendBufferQueueSize());
  1858. $local_address = \trim($connection->getLocalAddress());
  1859. $remote_address = \trim($connection->getRemoteAddress());
  1860. $state = $connection->getStatus(false);
  1861. $bytes_read = $bytes_format($connection->bytesRead);
  1862. $bytes_written = $bytes_format($connection->bytesWritten);
  1863. $id = $connection->id;
  1864. $protocol = $connection->protocol ? $connection->protocol : $connection->transport;
  1865. $pos = \strrpos($protocol, '\\');
  1866. if ($pos) {
  1867. $protocol = \substr($protocol, $pos+1);
  1868. }
  1869. if (\strlen($protocol) > 15) {
  1870. $protocol = \substr($protocol, 0, 13) . '..';
  1871. }
  1872. $worker_name = isset($connection->worker) ? $connection->worker->name : $default_worker_name;
  1873. if (\strlen($worker_name) > 14) {
  1874. $worker_name = \substr($worker_name, 0, 12) . '..';
  1875. }
  1876. $str .= \str_pad($pid, 9) . \str_pad($worker_name, 16) . \str_pad($id, 10) . \str_pad($transport, 8)
  1877. . \str_pad($protocol, 16) . \str_pad($ipv4, 7) . \str_pad($ipv6, 7) . \str_pad($recv_q, 13)
  1878. . \str_pad($send_q, 13) . \str_pad($bytes_read, 13) . \str_pad($bytes_written, 13) . ' '
  1879. . \str_pad($state, 14) . ' ' . \str_pad($local_address, 22) . ' ' . \str_pad($remote_address, 22) ."\n";
  1880. }
  1881. if ($str) {
  1882. \file_put_contents(static::$_statisticsFile, $str, \FILE_APPEND);
  1883. }
  1884. }
  1885. /**
  1886. * Check errors when current process exited.
  1887. *
  1888. * @return void
  1889. */
  1890. public static function checkErrors()
  1891. {
  1892. if (static::STATUS_SHUTDOWN !== static::$_status) {
  1893. $error_msg = static::$_OS === \OS_TYPE_LINUX ? 'Worker['. \posix_getpid() .'] process terminated' : 'Worker process terminated';
  1894. $errors = error_get_last();
  1895. if ($errors && ($errors['type'] === \E_ERROR ||
  1896. $errors['type'] === \E_PARSE ||
  1897. $errors['type'] === \E_CORE_ERROR ||
  1898. $errors['type'] === \E_COMPILE_ERROR ||
  1899. $errors['type'] === \E_RECOVERABLE_ERROR)
  1900. ) {
  1901. $error_msg .= ' with ERROR: ' . static::getErrorType($errors['type']) . " \"{$errors['message']} in {$errors['file']} on line {$errors['line']}\"";
  1902. }
  1903. static::log($error_msg);
  1904. }
  1905. }
  1906. /**
  1907. * Get error message by error code.
  1908. *
  1909. * @param integer $type
  1910. * @return string
  1911. */
  1912. protected static function getErrorType($type)
  1913. {
  1914. if(isset(self::$_errorType[$type])) {
  1915. return self::$_errorType[$type];
  1916. }
  1917. return '';
  1918. }
  1919. /**
  1920. * Log.
  1921. *
  1922. * @param string $msg
  1923. * @return void
  1924. */
  1925. public static function log($msg)
  1926. {
  1927. $msg = $msg . "\n";
  1928. if (!static::$daemonize) {
  1929. static::safeEcho($msg);
  1930. }
  1931. \file_put_contents((string)static::$logFile, \date('Y-m-d H:i:s') . ' ' . 'pid:'
  1932. . (static::$_OS === \OS_TYPE_LINUX ? \posix_getpid() : 1) . ' ' . $msg, \FILE_APPEND | \LOCK_EX);
  1933. }
  1934. /**
  1935. * Safe Echo.
  1936. * @param string $msg
  1937. * @param bool $decorated
  1938. * @return bool
  1939. */
  1940. public static function safeEcho($msg, $decorated = false)
  1941. {
  1942. $stream = static::outputStream();
  1943. if (!$stream) {
  1944. return false;
  1945. }
  1946. if (!$decorated) {
  1947. $line = $white = $green = $end = '';
  1948. if (static::$_outputDecorated) {
  1949. $line = "\033[1A\n\033[K";
  1950. $white = "\033[47;30m";
  1951. $green = "\033[32;40m";
  1952. $end = "\033[0m";
  1953. }
  1954. $msg = \str_replace(array('<n>', '<w>', '<g>'), array($line, $white, $green), $msg);
  1955. $msg = \str_replace(array('</n>', '</w>', '</g>'), $end, $msg);
  1956. } elseif (!static::$_outputDecorated) {
  1957. return false;
  1958. }
  1959. \fwrite($stream, $msg);
  1960. \fflush($stream);
  1961. return true;
  1962. }
  1963. /**
  1964. * @param null $stream
  1965. * @return bool|resource
  1966. */
  1967. private static function outputStream($stream = null)
  1968. {
  1969. if (!$stream) {
  1970. $stream = static::$_outputStream ? static::$_outputStream : \STDOUT;
  1971. }
  1972. if (!$stream || !\is_resource($stream) || 'stream' !== \get_resource_type($stream)) {
  1973. return false;
  1974. }
  1975. $stat = \fstat($stream);
  1976. if (!$stat) {
  1977. return false;
  1978. }
  1979. if (($stat['mode'] & 0170000) === 0100000) {
  1980. // file
  1981. static::$_outputDecorated = false;
  1982. } else {
  1983. static::$_outputDecorated =
  1984. static::$_OS === \OS_TYPE_LINUX &&
  1985. \function_exists('posix_isatty') &&
  1986. \posix_isatty($stream);
  1987. }
  1988. return static::$_outputStream = $stream;
  1989. }
  1990. /**
  1991. * Construct.
  1992. *
  1993. * @param string $socket_name
  1994. * @param array $context_option
  1995. */
  1996. public function __construct($socket_name = '', array $context_option = array())
  1997. {
  1998. // Save all worker instances.
  1999. $this->workerId = \spl_object_hash($this);
  2000. static::$_workers[$this->workerId] = $this;
  2001. static::$_pidMap[$this->workerId] = array();
  2002. // Get autoload root path.
  2003. $backtrace = \debug_backtrace();
  2004. $this->_autoloadRootPath = \dirname($backtrace[0]['file']);
  2005. Autoloader::setRootPath($this->_autoloadRootPath);
  2006. // Context for socket.
  2007. if ($socket_name) {
  2008. $this->_socketName = $socket_name;
  2009. if (!isset($context_option['socket']['backlog'])) {
  2010. $context_option['socket']['backlog'] = static::DEFAULT_BACKLOG;
  2011. }
  2012. $this->_context = \stream_context_create($context_option);
  2013. }
  2014. // Turn reusePort on.
  2015. if (static::$_OS === \OS_TYPE_LINUX // if linux
  2016. && \version_compare(\PHP_VERSION,'7.0.0', 'ge') // if php >= 7.0.0
  2017. && \strtolower(\php_uname('s')) !== 'darwin' // if not Mac OS
  2018. && $this->transport !== 'unix') { // if not unix socket
  2019. $this->reusePort = true;
  2020. }
  2021. }
  2022. /**
  2023. * Listen.
  2024. *
  2025. * @throws Exception
  2026. */
  2027. public function listen()
  2028. {
  2029. if (!$this->_socketName) {
  2030. return;
  2031. }
  2032. // Autoload.
  2033. Autoloader::setRootPath($this->_autoloadRootPath);
  2034. if (!$this->_mainSocket) {
  2035. $local_socket = $this->parseSocketAddress();
  2036. // Flag.
  2037. $flags = $this->transport === 'udp' ? \STREAM_SERVER_BIND : \STREAM_SERVER_BIND | \STREAM_SERVER_LISTEN;
  2038. $errno = 0;
  2039. $errmsg = '';
  2040. // SO_REUSEPORT.
  2041. if ($this->reusePort) {
  2042. \stream_context_set_option($this->_context, 'socket', 'so_reuseport', 1);
  2043. }
  2044. // Create an Internet or Unix domain server socket.
  2045. $this->_mainSocket = \stream_socket_server($local_socket, $errno, $errmsg, $flags, $this->_context);
  2046. if (!$this->_mainSocket) {
  2047. throw new Exception($errmsg);
  2048. }
  2049. if ($this->transport === 'ssl') {
  2050. \stream_socket_enable_crypto($this->_mainSocket, false);
  2051. } elseif ($this->transport === 'unix') {
  2052. $socket_file = \substr($local_socket, 7);
  2053. if ($this->user) {
  2054. \chown($socket_file, $this->user);
  2055. }
  2056. if ($this->group) {
  2057. \chgrp($socket_file, $this->group);
  2058. }
  2059. }
  2060. // Try to open keepalive for tcp and disable Nagle algorithm.
  2061. if (\function_exists('socket_import_stream') && static::$_builtinTransports[$this->transport] === 'tcp') {
  2062. \set_error_handler(function(){});
  2063. $socket = \socket_import_stream($this->_mainSocket);
  2064. \socket_set_option($socket, \SOL_SOCKET, \SO_KEEPALIVE, 1);
  2065. \socket_set_option($socket, \SOL_TCP, \TCP_NODELAY, 1);
  2066. \restore_error_handler();
  2067. }
  2068. // Non blocking.
  2069. \stream_set_blocking($this->_mainSocket, false);
  2070. }
  2071. $this->resumeAccept();
  2072. }
  2073. /**
  2074. * Unlisten.
  2075. *
  2076. * @return void
  2077. */
  2078. public function unlisten() {
  2079. $this->pauseAccept();
  2080. if ($this->_mainSocket) {
  2081. \set_error_handler(function(){});
  2082. \fclose($this->_mainSocket);
  2083. \restore_error_handler();
  2084. $this->_mainSocket = null;
  2085. }
  2086. }
  2087. /**
  2088. * Parse local socket address.
  2089. *
  2090. * @throws Exception
  2091. */
  2092. protected function parseSocketAddress() {
  2093. if (!$this->_socketName) {
  2094. return;
  2095. }
  2096. // Get the application layer communication protocol and listening address.
  2097. list($scheme, $address) = \explode(':', $this->_socketName, 2);
  2098. // Check application layer protocol class.
  2099. if (!isset(static::$_builtinTransports[$scheme])) {
  2100. $scheme = \ucfirst($scheme);
  2101. $this->protocol = \substr($scheme,0,1)==='\\' ? $scheme : 'Protocols\\' . $scheme;
  2102. if (!\class_exists($this->protocol)) {
  2103. $this->protocol = "Workerman\\Protocols\\$scheme";
  2104. if (!\class_exists($this->protocol)) {
  2105. throw new Exception("class \\Protocols\\$scheme not exist");
  2106. }
  2107. }
  2108. if (!isset(static::$_builtinTransports[$this->transport])) {
  2109. throw new Exception('Bad worker->transport ' . \var_export($this->transport, true));
  2110. }
  2111. } else {
  2112. $this->transport = $scheme;
  2113. }
  2114. //local socket
  2115. return static::$_builtinTransports[$this->transport] . ":" . $address;
  2116. }
  2117. /**
  2118. * Pause accept new connections.
  2119. *
  2120. * @return void
  2121. */
  2122. public function pauseAccept()
  2123. {
  2124. if (static::$globalEvent && false === $this->_pauseAccept && $this->_mainSocket) {
  2125. static::$globalEvent->del($this->_mainSocket, EventInterface::EV_READ);
  2126. $this->_pauseAccept = true;
  2127. }
  2128. }
  2129. /**
  2130. * Resume accept new connections.
  2131. *
  2132. * @return void
  2133. */
  2134. public function resumeAccept()
  2135. {
  2136. // Register a listener to be notified when server socket is ready to read.
  2137. if (static::$globalEvent && true === $this->_pauseAccept && $this->_mainSocket) {
  2138. if ($this->transport !== 'udp') {
  2139. static::$globalEvent->add($this->_mainSocket, EventInterface::EV_READ, array($this, 'acceptConnection'));
  2140. } else {
  2141. static::$globalEvent->add($this->_mainSocket, EventInterface::EV_READ, array($this, 'acceptUdpConnection'));
  2142. }
  2143. $this->_pauseAccept = false;
  2144. }
  2145. }
  2146. /**
  2147. * Get socket name.
  2148. *
  2149. * @return string
  2150. */
  2151. public function getSocketName()
  2152. {
  2153. return $this->_socketName ? \lcfirst($this->_socketName) : 'none';
  2154. }
  2155. /**
  2156. * Run worker instance.
  2157. *
  2158. * @return void
  2159. */
  2160. public function run()
  2161. {
  2162. //Update process state.
  2163. static::$_status = static::STATUS_RUNNING;
  2164. // Register shutdown function for checking errors.
  2165. \register_shutdown_function(array("\\Workerman\\Worker", 'checkErrors'));
  2166. // Set autoload root path.
  2167. Autoloader::setRootPath($this->_autoloadRootPath);
  2168. // Create a global event loop.
  2169. if (!static::$globalEvent) {
  2170. $event_loop_class = static::getEventLoopName();
  2171. static::$globalEvent = new $event_loop_class;
  2172. $this->resumeAccept();
  2173. }
  2174. // Reinstall signal.
  2175. static::reinstallSignal();
  2176. // Init Timer.
  2177. Timer::init(static::$globalEvent);
  2178. // Set an empty onMessage callback.
  2179. if (empty($this->onMessage)) {
  2180. $this->onMessage = function () {};
  2181. }
  2182. \restore_error_handler();
  2183. // Try to emit onWorkerStart callback.
  2184. if ($this->onWorkerStart) {
  2185. try {
  2186. \call_user_func($this->onWorkerStart, $this);
  2187. } catch (\Exception $e) {
  2188. static::log($e);
  2189. // Avoid rapid infinite loop exit.
  2190. sleep(1);
  2191. exit(250);
  2192. } catch (\Error $e) {
  2193. static::log($e);
  2194. // Avoid rapid infinite loop exit.
  2195. sleep(1);
  2196. exit(250);
  2197. }
  2198. }
  2199. // Main loop.
  2200. static::$globalEvent->loop();
  2201. }
  2202. /**
  2203. * Stop current worker instance.
  2204. *
  2205. * @return void
  2206. */
  2207. public function stop()
  2208. {
  2209. // Try to emit onWorkerStop callback.
  2210. if ($this->onWorkerStop) {
  2211. try {
  2212. \call_user_func($this->onWorkerStop, $this);
  2213. } catch (\Exception $e) {
  2214. static::log($e);
  2215. exit(250);
  2216. } catch (\Error $e) {
  2217. static::log($e);
  2218. exit(250);
  2219. }
  2220. }
  2221. // Remove listener for server socket.
  2222. $this->unlisten();
  2223. // Close all connections for the worker.
  2224. if (!static::$_gracefulStop) {
  2225. foreach ($this->connections as $connection) {
  2226. $connection->close();
  2227. }
  2228. }
  2229. // Clear callback.
  2230. $this->onMessage = $this->onClose = $this->onError = $this->onBufferDrain = $this->onBufferFull = null;
  2231. }
  2232. /**
  2233. * Accept a connection.
  2234. *
  2235. * @param resource $socket
  2236. * @return void
  2237. */
  2238. public function acceptConnection($socket)
  2239. {
  2240. // Accept a connection on server socket.
  2241. \set_error_handler(function(){});
  2242. $new_socket = \stream_socket_accept($socket, 0, $remote_address);
  2243. \restore_error_handler();
  2244. // Thundering herd.
  2245. if (!$new_socket) {
  2246. return;
  2247. }
  2248. // TcpConnection.
  2249. $connection = new TcpConnection($new_socket, $remote_address);
  2250. $this->connections[$connection->id] = $connection;
  2251. $connection->worker = $this;
  2252. $connection->protocol = $this->protocol;
  2253. $connection->transport = $this->transport;
  2254. $connection->onMessage = $this->onMessage;
  2255. $connection->onClose = $this->onClose;
  2256. $connection->onError = $this->onError;
  2257. $connection->onBufferDrain = $this->onBufferDrain;
  2258. $connection->onBufferFull = $this->onBufferFull;
  2259. // Try to emit onConnect callback.
  2260. if ($this->onConnect) {
  2261. try {
  2262. \call_user_func($this->onConnect, $connection);
  2263. } catch (\Exception $e) {
  2264. static::log($e);
  2265. exit(250);
  2266. } catch (\Error $e) {
  2267. static::log($e);
  2268. exit(250);
  2269. }
  2270. }
  2271. }
  2272. /**
  2273. * For udp package.
  2274. *
  2275. * @param resource $socket
  2276. * @return bool
  2277. */
  2278. public function acceptUdpConnection($socket)
  2279. {
  2280. \set_error_handler(function(){});
  2281. $recv_buffer = \stream_socket_recvfrom($socket, static::MAX_UDP_PACKAGE_SIZE, 0, $remote_address);
  2282. \restore_error_handler();
  2283. if (false === $recv_buffer || empty($remote_address)) {
  2284. return false;
  2285. }
  2286. // UdpConnection.
  2287. $connection = new UdpConnection($socket, $remote_address);
  2288. $connection->protocol = $this->protocol;
  2289. if ($this->onMessage) {
  2290. try {
  2291. if ($this->protocol !== null) {
  2292. /** @var \Workerman\Protocols\ProtocolInterface $parser */
  2293. $parser = $this->protocol;
  2294. if(\method_exists($parser,'input')){
  2295. while($recv_buffer !== ''){
  2296. $len = $parser::input($recv_buffer, $connection);
  2297. if($len === 0)
  2298. return true;
  2299. $package = \substr($recv_buffer,0,$len);
  2300. $recv_buffer = \substr($recv_buffer,$len);
  2301. $data = $parser::decode($package,$connection);
  2302. if ($data === false)
  2303. continue;
  2304. \call_user_func($this->onMessage, $connection, $data);
  2305. }
  2306. }else{
  2307. $data = $parser::decode($recv_buffer, $connection);
  2308. // Discard bad packets.
  2309. if ($data === false)
  2310. return true;
  2311. \call_user_func($this->onMessage, $connection, $data);
  2312. }
  2313. }else{
  2314. \call_user_func($this->onMessage, $connection, $recv_buffer);
  2315. }
  2316. ++ConnectionInterface::$statistics['total_request'];
  2317. } catch (\Exception $e) {
  2318. static::log($e);
  2319. exit(250);
  2320. } catch (\Error $e) {
  2321. static::log($e);
  2322. exit(250);
  2323. }
  2324. }
  2325. return true;
  2326. }
  2327. }