Worker.php 40 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245
  1. <?php
  2. namespace Workerman;
  3. use \Workerman\Events\Libevent;
  4. use \Workerman\Events\Select;
  5. use \Workerman\Events\EventInterface;
  6. use \Workerman\Connection\ConnectionInterface;
  7. use \Workerman\Connection\TcpConnection;
  8. use \Workerman\Connection\UdpConnection;
  9. use \Workerman\Lib\Timer;
  10. use \Workerman\Autoloader;
  11. use \Exception;
  12. /**
  13. *
  14. * @author walkor<walkor@workerman.net>
  15. */
  16. class Worker
  17. {
  18. /**
  19. * 版本号
  20. * @var string
  21. */
  22. const VERSION = '3.0.3';
  23. /**
  24. * 状态 启动中
  25. * @var int
  26. */
  27. const STATUS_STARTING = 1;
  28. /**
  29. * 状态 运行中
  30. * @var int
  31. */
  32. const STATUS_RUNNING = 2;
  33. /**
  34. * 状态 停止
  35. * @var int
  36. */
  37. const STATUS_SHUTDOWN = 4;
  38. /**
  39. * 状态 平滑重启中
  40. * @var int
  41. */
  42. const STATUS_RELOADING = 8;
  43. /**
  44. * 给子进程发送重启命令 KILL_WORKER_TIMER_TIME 秒后
  45. * 如果对应进程仍然未重启则强行杀死
  46. * @var int
  47. */
  48. const KILL_WORKER_TIMER_TIME = 1;
  49. /**
  50. * 默认的backlog,即内核中用于存放未被进程认领(accept)的连接队列长度
  51. * @var int
  52. */
  53. const DEFAUL_BACKLOG = 1024;
  54. /**
  55. * udp最大包长
  56. * @var int
  57. */
  58. const MAX_UDP_PACKEG_SIZE = 65535;
  59. /**
  60. * worker的名称,用于在运行status命令时标记进程
  61. * @var string
  62. */
  63. public $name = 'none';
  64. /**
  65. * 设置当前worker实例的进程数
  66. * @var int
  67. */
  68. public $count = 1;
  69. /**
  70. * 设置当前worker进程的运行用户,启动时需要root超级权限
  71. * @var string
  72. */
  73. public $user = '';
  74. /**
  75. * 当前worker进程是否可以平滑重启
  76. * @var bool
  77. */
  78. public $reloadable = true;
  79. /**
  80. * 当worker进程启动时,如果设置了$onWorkerStart回调函数,则运行
  81. * 此钩子函数一般用于进程启动后初始化工作
  82. * @var callback
  83. */
  84. public $onWorkerStart = null;
  85. /**
  86. * 当有客户端连接时,如果设置了$onConnect回调函数,则运行
  87. * @var callback
  88. */
  89. public $onConnect = null;
  90. /**
  91. * 当客户端连接上发来数据时,如果设置了$onMessage回调,则运行
  92. * @var callback
  93. */
  94. public $onMessage = null;
  95. /**
  96. * 当客户端的连接关闭时,如果设置了$onClose回调,则运行
  97. * @var callback
  98. */
  99. public $onClose = null;
  100. /**
  101. * 当客户端的连接发生错误时,如果设置了$onError回调,则运行
  102. * 错误一般为客户端断开连接导致数据发送失败、服务端的发送缓冲区满导致发送失败等
  103. * 具体错误码及错误详情会以参数的形式传递给回调,参见手册
  104. * @var callback
  105. */
  106. public $onError = null;
  107. /**
  108. * 当前进程退出时(由于平滑重启或者服务停止导致),如果设置了此回调,则运行
  109. * @var callback
  110. */
  111. public $onWorkerStop = null;
  112. /**
  113. * 传输层协议
  114. * @var string
  115. */
  116. public $transport = 'tcp';
  117. /**
  118. * 应用层协议,由初始化worker时指定
  119. * 例如 new worker('http://0.0.0.0:8080');指定使用http协议
  120. * @var string
  121. */
  122. protected $_protocol = '';
  123. /**
  124. * 当前worker实例初始化目录位置,用于设置应用自动加载的根目录
  125. * @var string
  126. */
  127. protected $_appInitPath = '';
  128. /**
  129. * 是否以守护进程的方式运行。运行start时加上-d参数会自动以守护进程方式运行
  130. * 例如 php start.php start -d
  131. * @var bool
  132. */
  133. public static $daemonize = false;
  134. /**
  135. * 重定向标准输出,即将所有echo、var_dump等终端输出写到对应文件中
  136. * 注意 此参数只有在以守护进程方式运行时有效
  137. * @var string
  138. */
  139. public static $stdoutFile = '/dev/null';
  140. /**
  141. * pid文件的路径及名称
  142. * 例如 Worker::$pidFile = '/tmp/workerman.pid';
  143. * 注意 此属性一般不必手动设置,默认会放到php临时目录中
  144. * @var string
  145. */
  146. public static $pidFile = '';
  147. /**
  148. * 日志目录,默认在workerman根目录下,与Applications同级
  149. * 可以手动设置
  150. * 例如 Worker::$logFile = '/tmp/workerman.log';
  151. * @var unknown_type
  152. */
  153. public static $logFile = '';
  154. /**
  155. * 全局事件轮询库,用于监听所有资源的可读可写事件
  156. * @var Select/Libevent
  157. */
  158. public static $globalEvent = null;
  159. /**
  160. * 主进程pid
  161. * @var int
  162. */
  163. protected static $_masterPid = 0;
  164. /**
  165. * 监听的socket
  166. * @var stream
  167. */
  168. protected $_mainSocket = null;
  169. /**
  170. * socket名称,包括应用层协议+ip+端口号,在初始化worker时设置
  171. * 值类似 http://0.0.0.0:80
  172. * @var string
  173. */
  174. protected $_socketName = '';
  175. /**
  176. * socket的上下文,具体选项设置可以在初始化worker时传递
  177. * @var context
  178. */
  179. protected $_context = null;
  180. /**
  181. * 所有的worker实例
  182. * @var array
  183. */
  184. protected static $_workers = array();
  185. /**
  186. * 所有worker进程的pid
  187. * 格式为 [worker_id=>[pid=>pid, pid=>pid, ..], ..]
  188. * @var array
  189. */
  190. protected static $_pidMap = array();
  191. /**
  192. * 所有需要重启的进程pid
  193. * 格式为 [pid=>pid, pid=>pid]
  194. * @var array
  195. */
  196. protected static $_pidsToRestart = array();
  197. /**
  198. * 当前worker状态
  199. * @var int
  200. */
  201. protected static $_status = self::STATUS_STARTING;
  202. /**
  203. * 所有worke名称(name属性)中的最大长度,用于在运行 status 命令时格式化输出
  204. * @var int
  205. */
  206. protected static $_maxWorkerNameLength = 12;
  207. /**
  208. * 所有socket名称(_socketName属性)中的最大长度,用于在运行 status 命令时格式化输出
  209. * @var int
  210. */
  211. protected static $_maxSocketNameLength = 12;
  212. /**
  213. * 所有user名称(user属性)中的最大长度,用于在运行 status 命令时格式化输出
  214. * @var int
  215. */
  216. protected static $_maxUserNameLength = 12;
  217. /**
  218. * 运行 status 命令时用于保存结果的文件名
  219. * @var string
  220. */
  221. protected static $_statisticsFile = '';
  222. /**
  223. * 启动的全局入口文件
  224. * 例如 php start.php start ,则入口文件为start.php
  225. * @var string
  226. */
  227. protected static $_startFile = '';
  228. /**
  229. * 全局统计数据,用于在运行 status 命令时展示
  230. * 统计的内容包括 workerman启动的时间戳及每组worker进程的退出次数及退出状态码
  231. * @var array
  232. */
  233. protected static $_globalStatistics = array(
  234. 'start_timestamp' => 0,
  235. 'worker_exit_info' => array()
  236. );
  237. /**
  238. * 运行所有worker实例
  239. * @return void
  240. */
  241. public static function runAll()
  242. {
  243. // 初始化环境变量
  244. self::init();
  245. // 解析命令
  246. self::parseCommand();
  247. // 尝试以守护进程模式运行
  248. self::daemonize();
  249. // 初始化所有worker实例,主要是监听端口
  250. self::initWorkers();
  251. // 初始化所有信号处理函数
  252. self::installSignal();
  253. // 展示启动界面
  254. self::displayUI();
  255. // 尝试重定向标准输入输出
  256. self::resetStd();
  257. // 保存主进程pid
  258. self::saveMasterPid();
  259. // 创建子进程(worker进程)并运行
  260. self::forkWorkers();
  261. // 监控所有子进程(worker进程)
  262. self::monitorWorkers();
  263. }
  264. /**
  265. * 初始化一些环境变量
  266. * @return void
  267. */
  268. public static function init()
  269. {
  270. // 关闭opcache
  271. ini_set('opcache.enable', false);
  272. // 如果没设置$pidFile,则生成默认值
  273. if(empty(self::$pidFile))
  274. {
  275. $backtrace = debug_backtrace();
  276. self::$_startFile = $backtrace[count($backtrace)-1]['file'];
  277. self::$pidFile = sys_get_temp_dir()."/workerman.".str_replace('/', '_', self::$_startFile).".pid";
  278. }
  279. // 没有设置日志文件,则生成一个默认值
  280. if(empty(self::$logFile))
  281. {
  282. self::$logFile = __DIR__ . '/../workerman.log';
  283. }
  284. // 标记状态为启动中
  285. self::$_status = self::STATUS_STARTING;
  286. // 启动时间戳
  287. self::$_globalStatistics['start_timestamp'] = time();
  288. // 设置status文件位置
  289. self::$_statisticsFile = sys_get_temp_dir().'/workerman.status';
  290. // 尝试设置进程名称(需要php>=5.5或者安装了proctitle扩展)
  291. self::setProcessTitle('WorkerMan: master process start_file=' . self::$_startFile);
  292. // 初始化定时器
  293. Timer::init();
  294. }
  295. /**
  296. * 初始化所有的worker实例,主要工作为获得格式化所需数据及监听端口
  297. * @return void
  298. */
  299. protected static function initWorkers()
  300. {
  301. foreach(self::$_workers as $worker)
  302. {
  303. // 没有设置worker名称,则使用none代替
  304. if(empty($worker->name))
  305. {
  306. $worker->name = 'none';
  307. }
  308. // 获得所有worker名称中最大长度
  309. $worker_name_length = strlen($worker->name);
  310. if(self::$_maxWorkerNameLength < $worker_name_length)
  311. {
  312. self::$_maxWorkerNameLength = $worker_name_length;
  313. }
  314. // 获得所有_socketName中最大长度
  315. $socket_name_length = strlen($worker->getSocketName());
  316. if(self::$_maxSocketNameLength < $socket_name_length)
  317. {
  318. self::$_maxSocketNameLength = $socket_name_length;
  319. }
  320. // 获得运行用户名的最大长度
  321. if(empty($worker->user) || posix_getuid() !== 0)
  322. {
  323. $worker->user = self::getCurrentUser();
  324. }
  325. $user_name_length = strlen($worker->user);
  326. if(self::$_maxUserNameLength < $user_name_length)
  327. {
  328. self::$_maxUserNameLength = $user_name_length;
  329. }
  330. // 监听端口
  331. $worker->listen();
  332. }
  333. }
  334. /**
  335. * 获得运行当前进程的用户名
  336. * @return string
  337. */
  338. protected static function getCurrentUser()
  339. {
  340. $user_info = posix_getpwuid(posix_getuid());
  341. return $user_info['name'];
  342. }
  343. /**
  344. * 展示启动界面
  345. * @return void
  346. */
  347. protected static function displayUI()
  348. {
  349. echo "\033[1A\n\033[K-----------------------\033[47;30m WORKERMAN \033[0m-----------------------------\n\033[0m";
  350. echo 'Workerman version:' . Worker::VERSION . " PHP version:".PHP_VERSION."\n";
  351. echo "------------------------\033[47;30m WORKERS \033[0m-------------------------------\n";
  352. echo "\033[47;30muser\033[0m",str_pad('', self::$_maxUserNameLength+2-strlen('user')), "\033[47;30mworker\033[0m",str_pad('', self::$_maxWorkerNameLength+2-strlen('worker')), "\033[47;30mlisten\033[0m",str_pad('', self::$_maxSocketNameLength+2-strlen('listen')), "\033[47;30mprocesses\033[0m \033[47;30m","status\033[0m\n";
  353. foreach(self::$_workers as $worker)
  354. {
  355. echo str_pad($worker->user, self::$_maxUserNameLength+2),str_pad($worker->name, self::$_maxWorkerNameLength+2),str_pad($worker->getSocketName(), self::$_maxSocketNameLength+2), str_pad(' '.$worker->count, 9), " \033[32;40m [OK] \033[0m\n";;
  356. }
  357. echo "----------------------------------------------------------------\n";
  358. }
  359. /**
  360. * 解析运行命令
  361. * php yourfile.php start | stop | restart | reload | status
  362. * @return void
  363. */
  364. public static function parseCommand()
  365. {
  366. // 检查运行命令的参数
  367. global $argv;
  368. $start_file = $argv[0];
  369. if(!isset($argv[1]))
  370. {
  371. exit("Usage: php yourfile.php {start|stop|restart|reload|status}\n");
  372. }
  373. // 命令
  374. $command = trim($argv[1]);
  375. // 子命令,目前只支持-d
  376. $command2 = isset($argv[2]) ? $argv[2] : '';
  377. // 记录日志
  378. self::log("Workerman[$start_file] $command");
  379. // 检查主进程是否在运行
  380. $master_pid = @file_get_contents(self::$pidFile);
  381. $master_is_alive = $master_pid && @posix_kill($master_pid, 0);
  382. if($master_is_alive)
  383. {
  384. if($command === 'start')
  385. {
  386. self::log("Workerman[$start_file] is running");
  387. }
  388. }
  389. elseif($command !== 'start' && $command !== 'restart')
  390. {
  391. self::log("Workerman[$start_file] not run");
  392. }
  393. // 根据命令做相应处理
  394. switch($command)
  395. {
  396. // 启动 workerman
  397. case 'start':
  398. if($command2 == '-d')
  399. {
  400. Worker::$daemonize = true;
  401. }
  402. break;
  403. // 显示 workerman 运行状态
  404. case 'status':
  405. // 尝试删除统计文件,避免脏数据
  406. if(is_file(self::$_statisticsFile))
  407. {
  408. @unlink(self::$_statisticsFile);
  409. }
  410. // 向主进程发送 SIGUSR2 信号 ,然后主进程会向所有子进程发送 SIGUSR2 信号
  411. // 所有进程收到 SIGUSR2 信号后会向 $_statisticsFile 写入自己的状态
  412. posix_kill($master_pid, SIGUSR2);
  413. // 睡眠100毫秒,等待子进程将自己的状态写入$_statisticsFile指定的文件
  414. usleep(100000);
  415. // 展示状态
  416. readfile(self::$_statisticsFile);
  417. exit(0);
  418. // 重启 workerman
  419. case 'restart':
  420. // 停止 workeran
  421. case 'stop':
  422. self::log("Workerman[$start_file] is stoping ...");
  423. // 想主进程发送SIGINT信号,主进程会向所有子进程发送SIGINT信号
  424. $master_pid && posix_kill($master_pid, SIGINT);
  425. // 如果 $timeout 秒后主进程没有退出则展示失败界面
  426. $timeout = 5;
  427. $start_time = time();
  428. while(1)
  429. {
  430. // 检查主进程是否存活
  431. $master_is_alive = $master_pid && posix_kill($master_pid, 0);
  432. if($master_is_alive)
  433. {
  434. // 检查是否超过$timeout时间
  435. if(time() - $start_time >= $timeout)
  436. {
  437. self::log("Workerman[$start_file] stop fail");
  438. exit;
  439. }
  440. usleep(10000);
  441. continue;
  442. }
  443. self::log("Workerman[$start_file] stop success");
  444. // 是restart命令
  445. if($command === 'stop')
  446. {
  447. exit(0);
  448. }
  449. // -d 说明是以守护进程的方式启动
  450. if($command2 == '-d')
  451. {
  452. Worker::$daemonize = true;
  453. }
  454. break;
  455. }
  456. break;
  457. // 平滑重启 workerman
  458. case 'reload':
  459. posix_kill($master_pid, SIGUSR1);
  460. self::log("Workerman[$start_file] reload");
  461. exit;
  462. // 未知命令
  463. default :
  464. exit("Usage: php yourfile.php {start|stop|restart|reload|status}\n");
  465. }
  466. }
  467. /**
  468. * 安装信号处理函数
  469. * @return void
  470. */
  471. protected static function installSignal()
  472. {
  473. // stop
  474. pcntl_signal(SIGINT, array('\Workerman\Worker', 'signalHandler'), false);
  475. // reload
  476. pcntl_signal(SIGUSR1, array('\Workerman\Worker', 'signalHandler'), false);
  477. // status
  478. pcntl_signal(SIGUSR2, array('\Workerman\Worker', 'signalHandler'), false);
  479. // ignore
  480. pcntl_signal(SIGPIPE, SIG_IGN, false);
  481. }
  482. /**
  483. * 为子进程重新安装信号处理函数,使用全局事件轮询监听信号
  484. * @return void
  485. */
  486. protected static function reinstallSignal()
  487. {
  488. // uninstall stop signal handler
  489. pcntl_signal(SIGINT, SIG_IGN, false);
  490. // uninstall reload signal handler
  491. pcntl_signal(SIGUSR1, SIG_IGN, false);
  492. // uninstall status signal handler
  493. pcntl_signal(SIGUSR2, SIG_IGN, false);
  494. // reinstall stop signal handler
  495. self::$globalEvent->add(SIGINT, EventInterface::EV_SIGNAL, array('\Workerman\Worker', 'signalHandler'));
  496. // uninstall reload signal handler
  497. self::$globalEvent->add(SIGUSR1, EventInterface::EV_SIGNAL,array('\Workerman\Worker', 'signalHandler'));
  498. // uninstall status signal handler
  499. self::$globalEvent->add(SIGUSR2, EventInterface::EV_SIGNAL, array('\Workerman\Worker', 'signalHandler'));
  500. }
  501. /**
  502. * 信号处理函数
  503. * @param int $signal
  504. */
  505. public static function signalHandler($signal)
  506. {
  507. switch($signal)
  508. {
  509. // stop
  510. case SIGINT:
  511. self::stopAll();
  512. break;
  513. // reload
  514. case SIGUSR1:
  515. self::$_pidsToRestart = self::getAllWorkerPids();;
  516. self::reload();
  517. break;
  518. // show status
  519. case SIGUSR2:
  520. self::writeStatisticsToStatusFile();
  521. break;
  522. }
  523. }
  524. /**
  525. * 尝试以守护进程的方式运行
  526. * @throws Exception
  527. */
  528. protected static function daemonize()
  529. {
  530. if(!self::$daemonize)
  531. {
  532. return;
  533. }
  534. umask(0);
  535. $pid = pcntl_fork();
  536. if(-1 == $pid)
  537. {
  538. throw new Exception('fork fail');
  539. }
  540. elseif($pid > 0)
  541. {
  542. exit(0);
  543. }
  544. if(-1 == posix_setsid())
  545. {
  546. throw new Exception("setsid fail");
  547. }
  548. // fork again avoid SVR4 system regain the control of terminal
  549. $pid = pcntl_fork();
  550. if(-1 == $pid)
  551. {
  552. throw new Exception("fork fail");
  553. }
  554. elseif(0 !== $pid)
  555. {
  556. exit(0);
  557. }
  558. }
  559. /**
  560. * 重定向标准输入输出
  561. * @throws Exception
  562. */
  563. protected static function resetStd()
  564. {
  565. if(!self::$daemonize)
  566. {
  567. return;
  568. }
  569. global $STDOUT, $STDERR;
  570. $handle = fopen(self::$stdoutFile,"a");
  571. if($handle)
  572. {
  573. unset($handle);
  574. @fclose(STDOUT);
  575. @fclose(STDERR);
  576. $STDOUT = fopen(self::$stdoutFile,"a");
  577. $STDERR = fopen(self::$stdoutFile,"a");
  578. }
  579. else
  580. {
  581. throw new Exception('can not open stdoutFile ' . self::$stdoutFile);
  582. }
  583. }
  584. /**
  585. * 保存pid到文件中,方便运行命令时查找主进程pid
  586. * @throws Exception
  587. */
  588. protected static function saveMasterPid()
  589. {
  590. self::$_masterPid = posix_getpid();
  591. if(false === @file_put_contents(self::$pidFile, self::$_masterPid))
  592. {
  593. throw new Exception('can not save pid to ' . self::$pidFile);
  594. }
  595. }
  596. /**
  597. * 获得所有子进程的pid
  598. * @return array
  599. */
  600. protected static function getAllWorkerPids()
  601. {
  602. $pid_array = array();
  603. foreach(self::$_pidMap as $worker_pid_array)
  604. {
  605. foreach($worker_pid_array as $worker_pid)
  606. {
  607. $pid_array[$worker_pid] = $worker_pid;
  608. }
  609. }
  610. return $pid_array;
  611. }
  612. /**
  613. * 创建子进程
  614. * @return void
  615. */
  616. protected static function forkWorkers()
  617. {
  618. foreach(self::$_workers as $worker)
  619. {
  620. // 启动过程中需要得到运行用户名的最大长度,在status时格式化展示
  621. if(self::$_status === self::STATUS_STARTING)
  622. {
  623. if(empty($worker->name))
  624. {
  625. $worker->name = $worker->getSocketName();
  626. }
  627. $worker_name_length = strlen($worker->name);
  628. if(self::$_maxWorkerNameLength < $worker_name_length)
  629. {
  630. self::$_maxWorkerNameLength = $worker_name_length;
  631. }
  632. }
  633. // 创建子进程
  634. while(count(self::$_pidMap[$worker->workerId]) < $worker->count)
  635. {
  636. self::forkOneWorker($worker);
  637. }
  638. }
  639. }
  640. /**
  641. * 创建一个子进程
  642. * @param Worker $worker
  643. * @throws Exception
  644. */
  645. protected static function forkOneWorker($worker)
  646. {
  647. $pid = pcntl_fork();
  648. // 主进程记录子进程pid
  649. if($pid > 0)
  650. {
  651. self::$_pidMap[$worker->workerId][$pid] = $pid;
  652. }
  653. // 子进程运行
  654. elseif(0 === $pid)
  655. {
  656. self::$_pidMap = array();
  657. self::$_workers = array($worker->workerId => $worker);
  658. Timer::delAll();
  659. self::setProcessTitle('WorkerMan: worker process ' . $worker->name . ' ' . $worker->getSocketName());
  660. self::setProcessUser($worker->user);
  661. $worker->run();
  662. exit(250);
  663. }
  664. else
  665. {
  666. throw new Exception("forkOneWorker fail");
  667. }
  668. }
  669. /**
  670. * 尝试设置运行当前进程的用户
  671. * @return void
  672. */
  673. protected static function setProcessUser($user_name)
  674. {
  675. if(empty($user_name) || posix_getuid() !== 0)
  676. {
  677. return;
  678. }
  679. $user_info = posix_getpwnam($user_name);
  680. if($user_info['uid'] != posix_getuid() || $user_info['gid'] != posix_getgid())
  681. {
  682. if(!posix_setgid($user_info['gid']) || !posix_setuid($user_info['uid']))
  683. {
  684. self::log( 'Notice : Can not run woker as '.$user_name." , You shuld be root\n", true);
  685. }
  686. }
  687. }
  688. /**
  689. * 设置当前进程的名称,在ps aux命令中有用
  690. * 注意 需要php>=5.5或者安装了protitle扩展
  691. * @param string $title
  692. * @return void
  693. */
  694. protected static function setProcessTitle($title)
  695. {
  696. // >=php 5.5
  697. if (function_exists('cli_set_process_title'))
  698. {
  699. @cli_set_process_title($title);
  700. }
  701. // 需要扩展
  702. elseif(extension_loaded('proctitle') && function_exists('setproctitle'))
  703. {
  704. @setproctitle($title);
  705. }
  706. }
  707. /**
  708. * 监控所有子进程的退出事件及退出码
  709. * @return void
  710. */
  711. protected static function monitorWorkers()
  712. {
  713. self::$_status = self::STATUS_RUNNING;
  714. while(1)
  715. {
  716. // 如果有信号到来,尝试触发信号处理函数
  717. pcntl_signal_dispatch();
  718. // 挂起进程,直到有子进程退出或者被信号打断
  719. $status = 0;
  720. $pid = pcntl_wait($status, WUNTRACED);
  721. // 有子进程退出
  722. if($pid > 0)
  723. {
  724. // 查找是哪个进程组的,然后再启动新的进程补上
  725. foreach(self::$_pidMap as $worker_id => $worker_pid_array)
  726. {
  727. if(isset($worker_pid_array[$pid]))
  728. {
  729. $worker = self::$_workers[$worker_id];
  730. // 检查退出状态
  731. if($status !== 0)
  732. {
  733. self::log("worker[".$worker->name.":$pid] exit with status $status");
  734. }
  735. // 统计,运行status命令时使用
  736. if(!isset(self::$_globalStatistics['worker_exit_info'][$worker_id][$status]))
  737. {
  738. self::$_globalStatistics['worker_exit_info'][$worker_id][$status] = 0;
  739. }
  740. self::$_globalStatistics['worker_exit_info'][$worker_id][$status]++;
  741. // 清除子进程信息
  742. unset(self::$_pidMap[$worker_id][$pid]);
  743. break;
  744. }
  745. }
  746. // 如果不是关闭状态,则补充新的进程
  747. if(self::$_status !== self::STATUS_SHUTDOWN)
  748. {
  749. self::forkWorkers();
  750. // 如果该进程是因为运行reload命令退出,则继续执行reload流程
  751. if(isset(self::$_pidsToRestart[$pid]))
  752. {
  753. unset(self::$_pidsToRestart[$pid]);
  754. self::reload();
  755. }
  756. }
  757. else
  758. {
  759. // 如果是关闭状态,并且所有进程退出完毕,则主进程退出
  760. if(!self::getAllWorkerPids())
  761. {
  762. self::exitAndClearAll();
  763. }
  764. }
  765. }
  766. else
  767. {
  768. // 如果是关闭状态,并且所有进程退出完毕,则主进程退出
  769. if(self::$_status === self::STATUS_SHUTDOWN && !self::getAllWorkerPids())
  770. {
  771. self::exitAndClearAll();
  772. }
  773. }
  774. }
  775. }
  776. /**
  777. * 退出当前进程
  778. * @return void
  779. */
  780. protected static function exitAndClearAll()
  781. {
  782. @unlink(self::$pidFile);
  783. self::log("Workerman[".basename(self::$_startFile)."] has been stopped");
  784. exit(0);
  785. }
  786. /**
  787. * 执行平滑重启流程
  788. * @return void
  789. */
  790. protected static function reload()
  791. {
  792. // 主进程部分
  793. if(self::$_masterPid === posix_getpid())
  794. {
  795. // 设置为平滑重启状态
  796. if(self::$_status !== self::STATUS_RELOADING && self::$_status !== self::STATUS_SHUTDOWN)
  797. {
  798. self::log("Workerman[".basename(self::$_startFile)."] reloading");
  799. self::$_status = self::STATUS_RELOADING;
  800. }
  801. // 如果有worker设置了reloadable=false,则过滤掉
  802. $reloadable_pid_array = array();
  803. foreach(self::$_pidMap as $worker_id =>$worker_pid_array)
  804. {
  805. $worker = self::$_workers[$worker_id];
  806. if($worker->reloadable)
  807. {
  808. foreach($worker_pid_array as $pid)
  809. {
  810. $reloadable_pid_array[$pid] = $pid;
  811. }
  812. }
  813. }
  814. // 得到所有可以重启的进程
  815. self::$_pidsToRestart = array_intersect(self::$_pidsToRestart , $reloadable_pid_array);
  816. // 平滑重启完毕
  817. if(empty(self::$_pidsToRestart))
  818. {
  819. if(self::$_status !== self::STATUS_SHUTDOWN)
  820. {
  821. self::$_status = self::STATUS_RUNNING;
  822. }
  823. return;
  824. }
  825. // 继续执行平滑重启流程
  826. $one_worker_pid = current(self::$_pidsToRestart );
  827. // 给子进程发送平滑重启信号
  828. posix_kill($one_worker_pid, SIGUSR1);
  829. // 定时器,如果子进程在KILL_WORKER_TIMER_TIME秒后没有退出,则强行杀死
  830. Timer::add(self::KILL_WORKER_TIMER_TIME, 'posix_kill', array($one_worker_pid, SIGKILL), false);
  831. }
  832. // 子进程部分
  833. else
  834. {
  835. // 如果当前worker的reloadable属性为真,则执行退出
  836. $worker = current(self::$_workers);
  837. if($worker->reloadable)
  838. {
  839. self::stopAll();
  840. }
  841. }
  842. }
  843. /**
  844. * 执行关闭流程
  845. * @return void
  846. */
  847. public static function stopAll()
  848. {
  849. self::$_status = self::STATUS_SHUTDOWN;
  850. // 主进程部分
  851. if(self::$_masterPid === posix_getpid())
  852. {
  853. self::log("Workerman[".basename(self::$_startFile)."] Stopping ...");
  854. $worker_pid_array = self::getAllWorkerPids();
  855. // 向所有子进程发送SIGINT信号,表明关闭服务
  856. foreach($worker_pid_array as $worker_pid)
  857. {
  858. posix_kill($worker_pid, SIGINT);
  859. Timer::add(self::KILL_WORKER_TIMER_TIME, 'posix_kill', array($worker_pid, SIGKILL),false);
  860. }
  861. }
  862. // 子进程部分
  863. else
  864. {
  865. // 执行stop逻辑
  866. foreach(self::$_workers as $worker)
  867. {
  868. $worker->stop();
  869. }
  870. exit(0);
  871. }
  872. }
  873. /**
  874. * 将当前进程的统计信息写入到统计文件
  875. * @return void
  876. */
  877. protected static function writeStatisticsToStatusFile()
  878. {
  879. // 主进程部分
  880. if(self::$_masterPid === posix_getpid())
  881. {
  882. $loadavg = sys_getloadavg();
  883. file_put_contents(self::$_statisticsFile, "---------------------------------------GLOBAL STATUS--------------------------------------------\n");
  884. file_put_contents(self::$_statisticsFile, 'Workerman version:' . Worker::VERSION . " PHP version:".PHP_VERSION."\n", FILE_APPEND);
  885. file_put_contents(self::$_statisticsFile, 'start time:'. date('Y-m-d H:i:s', self::$_globalStatistics['start_timestamp']).' run ' . floor((time()-self::$_globalStatistics['start_timestamp'])/(24*60*60)). ' days ' . floor(((time()-self::$_globalStatistics['start_timestamp'])%(24*60*60))/(60*60)) . " hours \n", FILE_APPEND);
  886. file_put_contents(self::$_statisticsFile, 'load average: ' . implode(", ", $loadavg) . "\n", FILE_APPEND);
  887. file_put_contents(self::$_statisticsFile, count(self::$_pidMap) . ' workers ' . count(self::getAllWorkerPids())." processes\n", FILE_APPEND);
  888. file_put_contents(self::$_statisticsFile, str_pad('worker_name', self::$_maxWorkerNameLength) . " exit_status exit_count\n", FILE_APPEND);
  889. foreach(self::$_pidMap as $worker_id =>$worker_pid_array)
  890. {
  891. $worker = self::$_workers[$worker_id];
  892. if(isset(self::$_globalStatistics['worker_exit_info'][$worker_id]))
  893. {
  894. foreach(self::$_globalStatistics['worker_exit_info'][$worker_id] as $worker_exit_status=>$worker_exit_count)
  895. {
  896. file_put_contents(self::$_statisticsFile, str_pad($worker->name, self::$_maxWorkerNameLength) . " " . str_pad($worker_exit_status, 16). " $worker_exit_count\n", FILE_APPEND);
  897. }
  898. }
  899. else
  900. {
  901. file_put_contents(self::$_statisticsFile, str_pad($worker->name, self::$_maxWorkerNameLength) . " " . str_pad(0, 16). " 0\n", FILE_APPEND);
  902. }
  903. }
  904. file_put_contents(self::$_statisticsFile, "---------------------------------------PROCESS STATUS-------------------------------------------\n", FILE_APPEND);
  905. file_put_contents(self::$_statisticsFile, "pid\tmemory ".str_pad('listening', self::$_maxSocketNameLength)." ".str_pad('worker_name', self::$_maxWorkerNameLength)." connections ".str_pad('total_request', 13)." ".str_pad('send_fail', 9)." ".str_pad('throw_exception', 15)."\n", FILE_APPEND);
  906. chmod(self::$_statisticsFile, 0722);
  907. foreach(self::getAllWorkerPids() as $worker_pid)
  908. {
  909. posix_kill($worker_pid, SIGUSR2);
  910. }
  911. return;
  912. }
  913. // 子进程部分
  914. $worker = current(self::$_workers);
  915. $wrker_status_str = posix_getpid()."\t".str_pad(round(memory_get_usage()/(1024*1024),2)."M", 7)." " .str_pad($worker->getSocketName(), self::$_maxSocketNameLength) ." ".str_pad(($worker->name == $worker->getSocketName() ? 'none' : $worker->name), self::$_maxWorkerNameLength)." ";
  916. $wrker_status_str .= str_pad(ConnectionInterface::$statistics['connection_count'], 11)." ".str_pad(ConnectionInterface::$statistics['total_request'], 14)." ".str_pad(ConnectionInterface::$statistics['send_fail'],9)." ".str_pad(ConnectionInterface::$statistics['throw_exception'],15)."\n";
  917. file_put_contents(self::$_statisticsFile, $wrker_status_str, FILE_APPEND);
  918. }
  919. /**
  920. * 记录日志
  921. * @param string $msg
  922. * @return void
  923. */
  924. protected static function log($msg)
  925. {
  926. $msg = $msg."\n";
  927. if(self::$_status === self::STATUS_STARTING || !self::$daemonize)
  928. {
  929. echo $msg;
  930. }
  931. file_put_contents(self::$logFile, date('Y-m-d H:i:s') . " " . $msg, FILE_APPEND | LOCK_EX);
  932. }
  933. /**
  934. * worker构造函数
  935. * @param string $socket_name
  936. * @return void
  937. */
  938. public function __construct($socket_name = '', $context_option = array())
  939. {
  940. // 保存worker实例
  941. $this->workerId = spl_object_hash($this);
  942. self::$_workers[$this->workerId] = $this;
  943. self::$_pidMap[$this->workerId] = array();
  944. // 获得实例化文件路径,用于自动加载设置根目录
  945. $backrace = debug_backtrace();
  946. $this->_appInitPath = dirname($backrace[0]['file']);
  947. // 设置socket上下文
  948. if($socket_name)
  949. {
  950. $this->_socketName = $socket_name;
  951. if(!isset($context_option['socket']['backlog']))
  952. {
  953. $context_option['socket']['backlog'] = self::DEFAUL_BACKLOG;
  954. }
  955. $this->_context = stream_context_create($context_option);
  956. }
  957. }
  958. /**
  959. * 监听端口
  960. * @throws Exception
  961. */
  962. public function listen()
  963. {
  964. if(!$this->_socketName)
  965. {
  966. return;
  967. }
  968. // 获得应用层通讯协议以及监听的地址
  969. list($scheme, $address) = explode(':', $this->_socketName, 2);
  970. // 如果有指定应用层协议,则检查对应的协议类是否存在
  971. if($scheme != 'tcp' && $scheme != 'udp')
  972. {
  973. $scheme = ucfirst($scheme);
  974. $this->_protocol = '\\Protocols\\'.$scheme;
  975. if(!class_exists($this->_protocol))
  976. {
  977. $this->_protocol = "\\Workerman\\Protocols\\$scheme";
  978. if(!class_exists($this->_protocol))
  979. {
  980. throw new Exception("class \\Protocols\\$scheme not exist");
  981. }
  982. }
  983. }
  984. elseif($scheme === 'udp')
  985. {
  986. $this->transport = 'udp';
  987. }
  988. // flag
  989. $flags = $this->transport === 'udp' ? STREAM_SERVER_BIND : STREAM_SERVER_BIND | STREAM_SERVER_LISTEN;
  990. $this->_mainSocket = stream_socket_server($this->transport.":".$address, $errno, $errmsg, $flags, $this->_context);
  991. if(!$this->_mainSocket)
  992. {
  993. throw new Exception($errmsg);
  994. }
  995. // 尝试打开tcp的keepalive,关闭TCP Nagle算法
  996. if(function_exists('socket_import_stream'))
  997. {
  998. $socket = socket_import_stream($this->_mainSocket );
  999. socket_set_option($socket, SOL_SOCKET, SO_KEEPALIVE, 1);
  1000. socket_set_option($socket, SOL_SOCKET, TCP_NODELAY, 1);
  1001. }
  1002. // 设置非阻塞
  1003. stream_set_blocking($this->_mainSocket, 0);
  1004. // 放到全局事件轮询中监听_mainSocket可读事件(客户端连接事件)
  1005. if(self::$globalEvent)
  1006. {
  1007. if($this->transport !== 'udp')
  1008. {
  1009. self::$globalEvent->add($this->_mainSocket, EventInterface::EV_READ, array($this, 'acceptConnection'));
  1010. }
  1011. else
  1012. {
  1013. self::$globalEvent->add($this->_mainSocket, EventInterface::EV_READ, array($this, 'acceptUdpConnection'));
  1014. }
  1015. }
  1016. }
  1017. /**
  1018. * 获得 socket name
  1019. * @return string
  1020. */
  1021. public function getSocketName()
  1022. {
  1023. return $this->_socketName ? $this->_socketName : 'none';
  1024. }
  1025. /**
  1026. * 运行worker实例
  1027. */
  1028. public function run()
  1029. {
  1030. // 如果没有全局事件轮询,则创建一个
  1031. if(!self::$globalEvent)
  1032. {
  1033. if(extension_loaded('libevent'))
  1034. {
  1035. self::$globalEvent = new Libevent();
  1036. }
  1037. else
  1038. {
  1039. self::$globalEvent = new Select();
  1040. }
  1041. // 监听_mainSocket上的可读事件(客户端连接事件)
  1042. if($this->_socketName)
  1043. {
  1044. if($this->transport !== 'udp')
  1045. {
  1046. self::$globalEvent->add($this->_mainSocket, EventInterface::EV_READ, array($this, 'acceptConnection'));
  1047. }
  1048. else
  1049. {
  1050. self::$globalEvent->add($this->_mainSocket, EventInterface::EV_READ, array($this, 'acceptUdpConnection'));
  1051. }
  1052. }
  1053. }
  1054. // 重新安装事件处理函数,使用全局事件轮询监听信号事件
  1055. self::reinstallSignal();
  1056. // 用全局事件轮询初始化定时器
  1057. Timer::init(self::$globalEvent);
  1058. // 设置自动加载根目录
  1059. Autoloader::setRootPath($this->_appInitPath);
  1060. // 如果有设置进程启动回调,则执行
  1061. if($this->onWorkerStart)
  1062. {
  1063. call_user_func($this->onWorkerStart, $this);
  1064. }
  1065. // 子进程主循环
  1066. self::$globalEvent->loop();
  1067. }
  1068. /**
  1069. * 停止当前worker实例
  1070. * @return void
  1071. */
  1072. public function stop()
  1073. {
  1074. // 如果有设置进程终止回调,则执行
  1075. if($this->onWorkerStop)
  1076. {
  1077. call_user_func($this->onWorkerStop, $this);
  1078. }
  1079. // 删除相关监听事件,关闭_mainSocket
  1080. self::$globalEvent->del($this->_mainSocket, EventInterface::EV_READ);
  1081. @fclose($this->_mainSocket);
  1082. }
  1083. /**
  1084. * 接收一个客户端连接
  1085. * @param resources $socket
  1086. * @return void
  1087. */
  1088. public function acceptConnection($socket)
  1089. {
  1090. // 获得客户端连接
  1091. $new_socket = @stream_socket_accept($socket, 0);
  1092. // 惊群现象,忽略
  1093. if(false === $new_socket)
  1094. {
  1095. return;
  1096. }
  1097. // 统计数据
  1098. ConnectionInterface::$statistics['connection_count']++;
  1099. // 初始化连接对象
  1100. $connection = new TcpConnection($new_socket);
  1101. $connection->protocol = $this->_protocol;
  1102. $connection->onMessage = $this->onMessage;
  1103. $connection->onClose = $this->onClose;
  1104. $connection->onError = $this->onError;
  1105. // 如果有设置连接回调,则执行
  1106. if($this->onConnect)
  1107. {
  1108. try
  1109. {
  1110. call_user_func($this->onConnect, $connection);
  1111. }
  1112. catch(Exception $e)
  1113. {
  1114. ConnectionInterface::$statistics['throw_exception']++;
  1115. self::log($e);
  1116. }
  1117. }
  1118. }
  1119. /**
  1120. * 处理udp连接(udp其实是无连接的,这里为保证和tcp连接接口一致)
  1121. * @param resource $socket
  1122. */
  1123. public function acceptUdpConnection($socket)
  1124. {
  1125. $recv_buffer = stream_socket_recvfrom($socket , self::MAX_UDP_PACKEG_SIZE, 0, $remote_address);
  1126. if(false === $recv_buffer || empty($remote_address))
  1127. {
  1128. return false;
  1129. }
  1130. $connection = new UdpConnection($socket, $remote_address);
  1131. if($this->onMessage)
  1132. {
  1133. $parser = $this->_protocol;
  1134. try
  1135. {
  1136. ConnectionInterface::$statistics['total_request']++;
  1137. call_user_func($this->onMessage, $connection, $parser::decode($recv_buffer, $connection));
  1138. }
  1139. catch(Exception $e)
  1140. {
  1141. ConnectionInterface::$statistics['throw_exception']++;
  1142. }
  1143. }
  1144. }
  1145. }