Worker.php 41 KB

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