Worker.php 79 KB

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