Worker.php 41 KB

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