Worker.php 43 KB

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