Worker.php 74 KB

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