| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665 |
- <?php
- /**
- * This file is part of workerman.
- *
- * Licensed under The MIT License
- * For full copyright and license information, please see the MIT-LICENSE.txt
- * Redistributions of files must retain the above copyright notice.
- *
- * @author walkor<walkor@workerman.net>
- * @copyright walkor<walkor@workerman.net>
- * @link http://www.workerman.net/
- * @license http://www.opensource.org/licenses/mit-license.php MIT License
- */
- declare(strict_types=1);
- namespace Workerman;
- use AllowDynamicProperties;
- use Exception;
- use Revolt\EventLoop;
- use RuntimeException;
- use stdClass;
- use Stringable;
- use Throwable;
- use Workerman\Connection\ConnectionInterface;
- use Workerman\Connection\TcpConnection;
- use Workerman\Connection\UdpConnection;
- use Workerman\Events\Event;
- use Workerman\Events\EventInterface;
- use Workerman\Events\Revolt;
- use Workerman\Events\Select;
- use Workerman\Protocols\ProtocolInterface;
- use function defined;
- use function function_exists;
- use function is_resource;
- use function method_exists;
- use function restore_error_handler;
- use function set_error_handler;
- use function stream_socket_accept;
- use function stream_socket_recvfrom;
- use function substr;
- use function array_walk;
- use function get_class;
- use const DIRECTORY_SEPARATOR;
- use const PHP_SAPI;
- use const PHP_VERSION;
- use const STDOUT;
- /**
- * Worker class
- * A container for listening ports
- */
- #[AllowDynamicProperties]
- class Worker
- {
- /**
- * Version.
- *
- * @var string
- */
- final public const VERSION = '5.0.0-RC3';
- /**
- * Status starting.
- *
- * @var int
- */
- public const STATUS_STARTING = 1;
- /**
- * Status running.
- *
- * @var int
- */
- public const STATUS_RUNNING = 2;
- /**
- * Status shutdown.
- *
- * @var int
- */
- public const STATUS_SHUTDOWN = 4;
- /**
- * Status reloading.
- *
- * @var int
- */
- public const STATUS_RELOADING = 8;
- /**
- * Default backlog. Backlog is the maximum length of the queue of pending connections.
- *
- * @var int
- */
- public const DEFAULT_BACKLOG = 102400;
- /**
- * The safe distance for columns adjacent
- *
- * @var int
- */
- public const UI_SAFE_LENGTH = 4;
- /**
- * Worker id.
- *
- * @var int
- */
- public int $id = 0;
- /**
- * Name of the worker processes.
- *
- * @var string
- */
- public string $name = 'none';
- /**
- * Number of worker processes.
- *
- * @var int
- */
- public int $count = 1;
- /**
- * Unix user of processes, needs appropriate privileges (usually root).
- *
- * @var string
- */
- public string $user = '';
- /**
- * Unix group of processes, needs appropriate privileges (usually root).
- *
- * @var string
- */
- public string $group = '';
- /**
- * reloadable.
- *
- * @var bool
- */
- public bool $reloadable = true;
- /**
- * reuse port.
- *
- * @var bool
- */
- public bool $reusePort = false;
- /**
- * Emitted when worker processes is starting.
- *
- * @var ?callable
- */
- public $onWorkerStart = null;
- /**
- * Emitted when a socket connection is successfully established.
- *
- * @var ?callable
- */
- public $onConnect = null;
- /**
- * Emitted before websocket handshake (Only works when protocol is ws).
- *
- * @var ?callable
- */
- public $onWebSocketConnect = null;
- /**
- * Emitted after websocket handshake (Only works when protocol is ws).
- *
- * @var ?callable
- */
- public $onWebSocketConnected = null;
- /**
- * Emitted when data is received.
- *
- * @var ?callable
- */
- public $onMessage = null;
- /**
- * Emitted when the other end of the socket sends a FIN packet.
- *
- * @var ?callable
- */
- public $onClose = null;
- /**
- * Emitted when an error occurs with connection.
- *
- * @var ?callable
- */
- public $onError = null;
- /**
- * Emitted when the send buffer becomes full.
- *
- * @var ?callable
- */
- public $onBufferFull = null;
- /**
- * Emitted when the send buffer becomes empty.
- *
- * @var ?callable
- */
- public $onBufferDrain = null;
- /**
- * Emitted when worker processes has stopped.
- *
- * @var ?callable
- */
- public $onWorkerStop = null;
- /**
- * Emitted when worker processes receives reload signal.
- *
- * @var ?callable
- */
- public $onWorkerReload = null;
- /**
- * Transport layer protocol.
- *
- * @var string
- */
- public string $transport = 'tcp';
- /**
- * Store all connections of clients.
- *
- * @var TcpConnection[]
- */
- public array $connections = [];
- /**
- * Application layer protocol.
- *
- * @var ?string
- */
- public ?string $protocol = null;
- /**
- * Pause accept new connections or not.
- *
- * @var bool
- */
- protected bool $pauseAccept = true;
- /**
- * Is worker stopping ?
- *
- * @var bool
- */
- public bool $stopping = false;
- /**
- * EventLoop class.
- *
- * @var ?string
- */
- public ?string $eventLoop = null;
- /**
- * Daemonize.
- *
- * @var bool
- */
- public static bool $daemonize = false;
- /**
- * Standard output stream
- *
- * @var resource
- */
- public static $outputStream;
- /**
- * Stdout file.
- *
- * @var string
- */
- public static string $stdoutFile = '/dev/null';
- /**
- * The file to store master process PID.
- *
- * @var string
- */
- public static string $pidFile;
- /**
- * The file used to store the master process status.
- *
- * @var string
- */
- public static string $statusFile;
- /**
- * Log file.
- *
- * @var string
- */
- public static string $logFile;
- /**
- * Global event loop.
- *
- * @var ?EventInterface
- */
- public static ?EventInterface $globalEvent = null;
- /**
- * Emitted when the master process get reload signal.
- *
- * @var ?callable
- */
- public static $onMasterReload = null;
- /**
- * Emitted when the master process terminated.
- *
- * @var ?callable
- */
- public static $onMasterStop = null;
- /**
- * Emitted when worker processes exited.
- *
- * @var ?callable
- */
- public static $onWorkerExit = null;
- /**
- * EventLoopClass
- *
- * @var class-string<EventInterface>
- */
- public static string $eventLoopClass;
- /**
- * After sending the stop command to the child process stopTimeout seconds,
- * if the process is still living then forced to kill.
- *
- * @var int
- */
- public static int $stopTimeout = 2;
- /**
- * Command
- *
- * @var string
- */
- public static string $command = '';
- /**
- * The PID of master process.
- *
- * @var int
- */
- protected static int $masterPid = 0;
- /**
- * Listening socket.
- *
- * @var ?resource
- */
- protected $mainSocket = null;
- /**
- * Socket name. The format is like this http://0.0.0.0:80 .
- *
- * @var string
- */
- protected string $socketName = '';
- /**
- * Context of socket.
- *
- * @var resource
- */
- protected $socketContext = null;
- /**
- * @var stdClass
- */
- protected stdClass $context;
- /**
- * All worker instances.
- *
- * @var Worker[]
- */
- protected static array $workers = [];
- /**
- * All worker processes pid.
- * The format is like this [worker_id=>[pid=>pid, pid=>pid, ..], ..]
- *
- * @var array
- */
- protected static array $pidMap = [];
- /**
- * All worker processes waiting for restart.
- * The format is like this [pid=>pid, pid=>pid].
- *
- * @var array
- */
- protected static array $pidsToRestart = [];
- /**
- * Mapping from PID to worker process ID.
- * The format is like this [worker_id=>[0=>$pid, 1=>$pid, ..], ..].
- *
- * @var array
- */
- protected static array $idMap = [];
- /**
- * Current status.
- *
- * @var int
- */
- protected static int $status = self::STATUS_STARTING;
- /**
- * UI data.
- *
- * @var array|int[]
- */
- protected static array $uiLengthData = [];
- /**
- * The file to store status info of current worker process.
- *
- * @var string
- */
- protected static string $statisticsFile;
- /**
- * The file to store status info of connections.
- *
- * @var string
- */
- protected static string $connectionsFile;
- /**
- * Start file.
- *
- * @var string
- */
- protected static string $startFile;
- /**
- * Processes for windows.
- *
- * @var array
- */
- protected static array $processForWindows = [];
- /**
- * Status info of current worker process.
- *
- * @var array
- */
- protected static array $globalStatistics = [
- 'start_timestamp' => 0,
- 'worker_exit_info' => []
- ];
- /**
- * PHP built-in protocols.
- *
- * @var array<string, string>
- */
- public const BUILD_IN_TRANSPORTS = [
- 'tcp' => 'tcp',
- 'udp' => 'udp',
- 'unix' => 'unix',
- 'ssl' => 'tcp'
- ];
- /**
- * PHP built-in error types.
- *
- * @var array<int, string>
- */
- public const ERROR_TYPE = [
- E_ERROR => 'E_ERROR',
- E_WARNING => 'E_WARNING',
- E_PARSE => 'E_PARSE',
- E_NOTICE => 'E_NOTICE',
- E_CORE_ERROR => 'E_CORE_ERROR',
- E_CORE_WARNING => 'E_CORE_WARNING',
- E_COMPILE_ERROR => 'E_COMPILE_ERROR',
- E_COMPILE_WARNING => 'E_COMPILE_WARNING',
- E_USER_ERROR => 'E_USER_ERROR',
- E_USER_WARNING => 'E_USER_WARNING',
- E_USER_NOTICE => 'E_USER_NOTICE',
- E_RECOVERABLE_ERROR => 'E_RECOVERABLE_ERROR',
- E_DEPRECATED => 'E_DEPRECATED',
- E_USER_DEPRECATED => 'E_USER_DEPRECATED'
- ];
- /**
- * Graceful stop or not.
- *
- * @var bool
- */
- protected static bool $gracefulStop = false;
- /**
- * If $outputStream support decorated
- *
- * @var bool
- */
- protected static bool $outputDecorated;
- /**
- * Worker object's hash id(unique identifier).
- *
- * @var ?string
- */
- protected ?string $workerId = null;
- /**
- * Constructor.
- *
- * @param string|null $socketName
- * @param array $socketContext
- */
- public function __construct(?string $socketName = null, array $socketContext = [])
- {
- // Save all worker instances.
- $this->workerId = spl_object_hash($this);
- $this->context = new stdClass();
- static::$workers[$this->workerId] = $this;
- static::$pidMap[$this->workerId] = [];
- // Context for socket.
- if ($socketName) {
- $this->socketName = $socketName;
- $socketContext['socket']['backlog'] ??= static::DEFAULT_BACKLOG;
- $this->socketContext = stream_context_create($socketContext);
- }
- // Set an empty onMessage callback.
- $this->onMessage = function () {
- // Empty.
- };
- }
- /**
- * Run all worker instances.
- *
- * @return void
- */
- public static function runAll(): void
- {
- try {
- static::checkSapiEnv();
- static::initStdOut();
- static::init();
- static::parseCommand();
- static::checkPortAvailable();
- static::lock();
- static::daemonize();
- static::initWorkers();
- static::installSignal();
- static::saveMasterPid();
- static::lock(LOCK_UN);
- static::displayUI();
- static::forkWorkers();
- static::resetStd();
- static::monitorWorkers();
- } catch (Throwable $e) {
- static::log($e);
- }
- }
- /**
- * Check sapi.
- *
- * @return void
- */
- protected static function checkSapiEnv(): void
- {
- // Only for cli and micro.
- if (!in_array(PHP_SAPI, ['cli', 'micro'])) {
- exit("Only run in command line mode" . PHP_EOL);
- }
- // Check pcntl and posix extension for unix.
- if (DIRECTORY_SEPARATOR === '/') {
- foreach (['pcntl', 'posix'] as $name) {
- if (!extension_loaded($name)) {
- exit("Please install $name extension" . PHP_EOL);
- }
- }
- }
- // Check disable functions.
- $disabledFunctions = explode(',', ini_get('disable_functions'));
- $disabledFunctions = array_map('trim', $disabledFunctions);
- $functionsToCheck = [
- 'stream_socket_server',
- 'stream_socket_accept',
- 'stream_socket_client',
- 'pcntl_signal_dispatch',
- 'pcntl_signal',
- 'pcntl_alarm',
- 'pcntl_fork',
- 'pcntl_wait',
- 'posix_getuid',
- 'posix_getpwuid',
- 'posix_kill',
- 'posix_setsid',
- 'posix_getpid',
- 'posix_getpwnam',
- 'posix_getgrnam',
- 'posix_getgid',
- 'posix_setgid',
- 'posix_initgroups',
- 'posix_setuid',
- 'posix_isatty',
- 'proc_open',
- 'proc_get_status',
- 'proc_close',
- 'shell_exec',
- 'exec',
- 'putenv',
- 'getenv',
- ];
- $disabled = array_intersect($functionsToCheck, $disabledFunctions);
- if (!empty($disabled)) {
- $iniFilePath = (string)php_ini_loaded_file();
- exit('Notice: '. implode(',', $disabled) . " are disabled by disable_functions. " . PHP_EOL
- . "Please remove them from disable_functions in $iniFilePath" . PHP_EOL);
- }
- }
- /**
- * Init stdout.
- *
- * @return void
- */
- protected static function initStdOut(): void
- {
- $defaultStream = fn () => defined('STDOUT') ? STDOUT : (@fopen('php://stdout', 'w') ?: fopen('php://output', 'w'));
- static::$outputStream ??= $defaultStream(); //@phpstan-ignore-line
- if (!is_resource(self::$outputStream) || get_resource_type(self::$outputStream) !== 'stream') {
- $type = get_debug_type(self::$outputStream);
- static::$outputStream = $defaultStream();
- throw new RuntimeException(sprintf('The $outputStream must to be a stream, %s given', $type));
- }
- static::$outputDecorated ??= self::hasColorSupport();
- }
- /**
- * Borrowed from the symfony console
- * @link https://github.com/symfony/console/blob/0d14a9f6d04d4ac38a8cea1171f4554e325dae92/Output/StreamOutput.php#L92
- */
- private static function hasColorSupport(): bool
- {
- // Follow https://no-color.org/
- if (getenv('NO_COLOR') !== false) {
- return false;
- }
- if (getenv('TERM_PROGRAM') === 'Hyper') {
- return true;
- }
- if (DIRECTORY_SEPARATOR === '\\') {
- return (function_exists('sapi_windows_vt100_support') && @sapi_windows_vt100_support(self::$outputStream))
- || getenv('ANSICON') !== false
- || getenv('ConEmuANSI') === 'ON'
- || getenv('TERM') === 'xterm';
- }
- return stream_isatty(self::$outputStream);
- }
- /**
- * Init.
- *
- * @return void
- */
- protected static function init(): void
- {
- set_error_handler(static function (int $code, string $msg, string $file, int $line): bool {
- static::safeEcho(sprintf("%s \"%s\" in file %s on line %d\n", static::getErrorType($code), $msg, $file, $line));
- return true;
- });
- // $_SERVER.
- $_SERVER['SERVER_SOFTWARE'] = 'Workerman/' . static::VERSION;
- // Start file.
- $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
- static::$startFile ??= end($backtrace)['file'];
- $startFilePrefix = hash('xxh64', static::$startFile);
- // Pid file.
- static::$pidFile ??= sprintf('%s/workerman.%s.pid', dirname(__DIR__), $startFilePrefix);
- // Status file.
- static::$statusFile ??= sprintf('%s/workerman.%s.status', dirname(__DIR__), $startFilePrefix);
- static::$statisticsFile ??= static::$statusFile;
- static::$connectionsFile ??= static::$statusFile . '.connection';
- // Log file.
- static::$logFile ??= sprintf('%s/workerman.log', dirname(__DIR__, 2));
- if (static::$logFile !== '/dev/null' && !is_file(static::$logFile)) {
- // if /runtime/logs default folder not exists
- if (!is_dir(dirname(static::$logFile))) {
- @mkdir(dirname(static::$logFile), 0777, true);
- }
- touch(static::$logFile);
- chmod(static::$logFile, 0644);
- }
- // State.
- static::$status = static::STATUS_STARTING;
- // Init global event.
- static::initGlobalEvent();
- // For statistics.
- static::$globalStatistics['start_timestamp'] = time();
- // Process title.
- static::setProcessTitle('WorkerMan: master process start_file=' . static::$startFile);
- // Init data for worker id.
- static::initId();
- // Timer init.
- Timer::init();
- }
- /**
- * Init global event.
- *
- * @return void
- */
- protected static function initGlobalEvent(): void
- {
- if (static::$globalEvent !== null) {
- static::$eventLoopClass = get_class(static::$globalEvent);
- static::$globalEvent = null;
- return;
- }
- if (!empty(static::$eventLoopClass)) {
- if (!is_subclass_of(static::$eventLoopClass, EventInterface::class)) {
- throw new RuntimeException(sprintf('%s::$eventLoopClass must implement %s', static::class, EventInterface::class));
- }
- return;
- }
- static::$eventLoopClass = match (true) {
- class_exists(EventLoop::class) => Revolt::class,
- extension_loaded('event') => Event::class,
- default => Select::class,
- };
- }
- /**
- * Lock.
- *
- * @param int $flag
- * @return void
- */
- protected static function lock(int $flag = LOCK_EX): void
- {
- static $fd;
- if (DIRECTORY_SEPARATOR !== '/') {
- return;
- }
- $lockFile = static::$pidFile . '.lock';
- $fd = $fd ?: fopen($lockFile, 'a+');
- if ($fd) {
- flock($fd, $flag);
- if ($flag === LOCK_UN) {
- fclose($fd);
- $fd = null;
- clearstatcache();
- if (is_file($lockFile)) {
- unlink($lockFile);
- }
- }
- }
- }
- /**
- * Init All worker instances.
- *
- * @return void
- */
- protected static function initWorkers(): void
- {
- if (DIRECTORY_SEPARATOR !== '/') {
- return;
- }
- foreach (static::$workers as $worker) {
- // Worker name.
- if (empty($worker->name)) {
- $worker->name = 'none';
- }
- // Get unix user of the worker process.
- if (empty($worker->user)) {
- $worker->user = static::getCurrentUser();
- } else {
- if (posix_getuid() !== 0 && $worker->user !== static::getCurrentUser()) {
- static::log('Warning: You must have the root privileges to change uid and gid.');
- }
- }
- // Socket name.
- $worker->context->statusSocket = $worker->getSocketName();
- // Event-loop name.
- $eventLoopName = $worker->eventLoop ?: static::$eventLoopClass;
- $worker->context->eventLoopName = str_starts_with($eventLoopName, 'Workerman\\Events\\') ? strtolower(substr($eventLoopName, 17)) : $eventLoopName;
- // Status name.
- $worker->context->statusState = '<g> [OK] </g>';
- // Get column mapping for UI
- foreach (static::getUiColumns() as $columnName => $prop) {
- !isset($worker->$prop) && !isset($worker->context->$prop) && $worker->context->$prop = 'NNNN';
- $propLength = strlen((string)($worker->$prop ?? $worker->context->$prop));
- $key = 'max' . ucfirst(strtolower($columnName)) . 'NameLength';
- static::$uiLengthData[$key] = max(static::$uiLengthData[$key] ?? 2 * static::UI_SAFE_LENGTH, $propLength);
- }
- // Listen.
- if (!$worker->reusePort) {
- $worker->listen();
- }
- }
- }
- /**
- * Get all worker instances.
- *
- * @return Worker[]
- */
- public static function getAllWorkers(): array
- {
- return static::$workers;
- }
- /**
- * Get global event-loop instance.
- *
- * @return EventInterface
- */
- public static function getEventLoop(): EventInterface
- {
- return static::$globalEvent;
- }
- /**
- * Get main socket resource
- *
- * @return resource
- */
- public function getMainSocket(): mixed
- {
- return $this->mainSocket;
- }
- /**
- * Init idMap.
- *
- * @return void
- */
- protected static function initId(): void
- {
- foreach (static::$workers as $workerId => $worker) {
- $newIdMap = [];
- $worker->count = max($worker->count, 1);
- for ($key = 0; $key < $worker->count; $key++) {
- $newIdMap[$key] = static::$idMap[$workerId][$key] ?? 0;
- }
- static::$idMap[$workerId] = $newIdMap;
- }
- }
- /**
- * Get unix user of current process.
- *
- * @return string
- */
- protected static function getCurrentUser(): string
- {
- $userInfo = posix_getpwuid(posix_getuid());
- return $userInfo['name'] ?? 'unknown';
- }
- /**
- * Display staring UI.
- *
- * @return void
- */
- protected static function displayUI(): void
- {
- $tmpArgv = static::getArgv();
- if (in_array('-q', $tmpArgv)) {
- return;
- }
- $lineVersion = static::getVersionLine();
- // For windows
- if (DIRECTORY_SEPARATOR !== '/') {
- static::safeEcho("---------------------------------------------- WORKERMAN -----------------------------------------------\r\n");
- static::safeEcho($lineVersion);
- static::safeEcho("----------------------------------------------- WORKERS ------------------------------------------------\r\n");
- static::safeEcho("worker listen processes status\r\n");
- return;
- }
- // For unix
- !defined('LINE_VERSION_LENGTH') && define('LINE_VERSION_LENGTH', strlen($lineVersion));
- $totalLength = static::getSingleLineTotalLength();
- $lineOne = '<n>' . str_pad('<w> WORKERMAN </w>', $totalLength + strlen('<w></w>'), '-', STR_PAD_BOTH) . '</n>' . PHP_EOL;
- $lineTwo = str_pad('<w> WORKERS </w>', $totalLength + strlen('<w></w>'), '-', STR_PAD_BOTH) . PHP_EOL;
- static::safeEcho($lineOne . $lineVersion . $lineTwo);
- //Show title
- $title = '';
- foreach (static::getUiColumns() as $columnName => $prop) {
- $key = 'max' . ucfirst(strtolower($columnName)) . 'NameLength';
- //just keep compatible with listen name
- $columnName === 'socket' && $columnName = 'listen';
- $title .= "<w>$columnName</w>" . str_pad('', static::getUiColumnLength($key) + static::UI_SAFE_LENGTH - strlen($columnName));
- }
- $title && static::safeEcho($title . PHP_EOL);
- //Show content
- foreach (static::$workers as $worker) {
- $content = '';
- foreach (static::getUiColumns() as $columnName => $prop) {
- $propValue = (string)($worker->$prop ?? $worker->context->$prop);
- $key = 'max' . ucfirst(strtolower($columnName)) . 'NameLength';
- preg_match_all("/(<n>|<\/n>|<w>|<\/w>|<g>|<\/g>)/i", $propValue, $matches);
- $placeHolderLength = !empty($matches[0]) ? strlen(implode('', $matches[0])) : 0;
- $content .= str_pad($propValue, static::getUiColumnLength($key) + static::UI_SAFE_LENGTH + $placeHolderLength);
- }
- $content && static::safeEcho($content . PHP_EOL);
- }
- //Show last line
- $lineLast = str_pad('', static::getSingleLineTotalLength(), '-') . PHP_EOL;
- !empty($content) && static::safeEcho($lineLast);
- if (static::$daemonize) {
- static::safeEcho('Input "php ' . basename(static::$startFile) . ' stop" to stop. Start success.' . "\n\n");
- } else if (!empty(static::$command)) {
- static::safeEcho("Start success.\n"); // Workerman used as library
- } else {
- static::safeEcho("Press Ctrl+C to stop. Start success.\n");
- }
- }
- /**
- * @return string
- */
- protected static function getVersionLine(): string
- {
- //Show version
- $jitStatus = function_exists('opcache_get_status') && (opcache_get_status()['jit']['on'] ?? false) === true ? 'on' : 'off';
- $version = str_pad('Workerman/' . static::VERSION, 24);
- $version .= str_pad('PHP/' . PHP_VERSION . ' (Jit ' . $jitStatus . ')', 30);
- $version .= php_uname('s') . '/' . php_uname('r') . PHP_EOL;
- return $version;
- }
- /**
- * Get UI columns to be shown in terminal
- *
- * 1. $columnMap: ['ui_column_name' => 'clas_property_name']
- * 2. Consider move into configuration in future
- *
- * @return array
- */
- public static function getUiColumns(): array
- {
- return [
- 'event' => 'eventLoopName',
- 'proto' => 'transport',
- 'user' => 'user',
- 'worker' => 'name',
- 'socket' => 'statusSocket',
- 'count' => 'count',
- 'state' => 'statusState',
- ];
- }
- /**
- * Get single line total length for ui
- *
- * @return int
- */
- public static function getSingleLineTotalLength(): int
- {
- $totalLength = 0;
- foreach (static::getUiColumns() as $columnName => $prop) {
- $key = 'max' . ucfirst(strtolower($columnName)) . 'NameLength';
- $totalLength += static::getUiColumnLength($key) + static::UI_SAFE_LENGTH;
- }
- //Keep beauty when show less columns
- !defined('LINE_VERSION_LENGTH') && define('LINE_VERSION_LENGTH', 0);
- $totalLength <= LINE_VERSION_LENGTH && $totalLength = LINE_VERSION_LENGTH;
- return $totalLength;
- }
- /**
- * Parse command.
- *
- * @return void
- */
- protected static function parseCommand(): void
- {
- if (DIRECTORY_SEPARATOR !== '/') {
- return;
- }
- // Check argv;
- $startFile = basename(static::$startFile);
- $usage = "Usage: php yourfile <command> [mode]\nCommands: \nstart\t\tStart worker in USER mode.\n\t\tUse mode -d to start in DAEMON mode.\nstop\t\tStop worker.\n\t\tUse mode -g to stop gracefully.\nrestart\t\tRestart workers.\n\t\tUse mode -d to start in DAEMON mode.\n\t\tUse mode -g to stop gracefully.\nreload\t\tReload codes.\n\t\tUse mode -g to reload gracefully.\nstatus\t\tGet worker status.\n\t\tUse mode -d to show live status.\nconnections\tGet worker connections.\n";
- $availableCommands = [
- 'start',
- 'stop',
- 'restart',
- 'reload',
- 'status',
- 'connections',
- ];
- $availableMode = [
- '-d',
- '-g'
- ];
- $command = $mode = '';
- foreach (static::getArgv() as $value) {
- if (!$command && in_array($value, $availableCommands)) {
- $command = $value;
- }
- if (!$mode && in_array($value, $availableMode)) {
- $mode = $value;
- }
- }
- if (!$command) {
- exit($usage);
- }
- // Start command.
- $modeStr = '';
- if ($command === 'start') {
- if ($mode === '-d' || static::$daemonize) {
- $modeStr = 'in DAEMON mode';
- } else {
- $modeStr = 'in USER mode';
- }
- }
- static::log("Workerman[$startFile] $command $modeStr");
- // Get master process PID.
- $masterPid = is_file(static::$pidFile) ? (int)file_get_contents(static::$pidFile) : 0;
- // Master is still alive?
- if (static::checkMasterIsAlive($masterPid)) {
- if ($command === 'start') {
- static::log("Workerman[$startFile] already running");
- exit;
- }
- } elseif ($command !== 'start' && $command !== 'restart') {
- static::log("Workerman[$startFile] not run");
- exit;
- }
- // execute command.
- switch ($command) {
- case 'start':
- if ($mode === '-d') {
- static::$daemonize = true;
- }
- break;
- case 'status':
- // Delete status file on shutdown
- register_shutdown_function(unlink(...), static::$statisticsFile);
- while (1) {
- // Master process will send SIGIOT signal to all child processes.
- posix_kill($masterPid, SIGIOT);
- // Waiting a moment.
- sleep(1);
- // Clear terminal.
- if ($mode === '-d') {
- static::safeEcho("\33[H\33[2J\33(B\33[m", true);
- }
- // Echo status data.
- static::safeEcho(static::formatProcessStatusData());
- if ($mode !== '-d') {
- exit(0);
- }
- static::safeEcho("\nPress Ctrl+C to quit.\n\n");
- }
- case 'connections':
- // Delete status file on shutdown
- register_shutdown_function(unlink(...), static::$connectionsFile);
- // Master process will send SIGIO signal to all child processes.
- posix_kill($masterPid, SIGIO);
- // Waiting a moment.
- usleep(500000);
- // Display statistics data from a disk file.
- static::safeEcho(static::formatConnectionStatusData());
- exit(0);
- case 'restart':
- case 'stop':
- if ($mode === '-g') {
- static::$gracefulStop = true;
- $sig = SIGQUIT;
- static::log("Workerman[$startFile] is gracefully stopping ...");
- } else {
- static::$gracefulStop = false;
- $sig = SIGINT;
- static::log("Workerman[$startFile] is stopping ...");
- }
- // Send stop signal to master process.
- $masterPid && posix_kill($masterPid, $sig);
- // Timeout.
- $timeout = static::$stopTimeout + 3;
- $startTime = time();
- // Check master process is still alive?
- while (1) {
- $masterIsAlive = $masterPid && posix_kill($masterPid, 0);
- if ($masterIsAlive) {
- // Timeout?
- if (!static::getGracefulStop() && time() - $startTime >= $timeout) {
- static::log("Workerman[$startFile] stop fail");
- exit;
- }
- // Waiting a moment.
- usleep(10000);
- continue;
- }
- // Stop success.
- static::log("Workerman[$startFile] stop success");
- if ($command === 'stop') {
- exit(0);
- }
- if ($mode === '-d') {
- static::$daemonize = true;
- }
- break;
- }
- break;
- case 'reload':
- if ($mode === '-g') {
- $sig = SIGUSR2;
- } else {
- $sig = SIGUSR1;
- }
- posix_kill($masterPid, $sig);
- exit;
- default :
- static::safeEcho('Unknown command: ' . $command . "\n");
- exit($usage);
- }
- }
- /**
- * Get argv.
- *
- * @return array
- */
- public static function getArgv(): array
- {
- global $argv;
- return static::$command ? [...$argv, ...explode(' ', static::$command)] : $argv;
- }
- /**
- * Format status data.
- *
- * @return string
- */
- protected static function formatProcessStatusData(): string
- {
- static $totalRequestCache = [];
- if (!is_readable(static::$statisticsFile)) {
- return '';
- }
- $info = file(static::$statisticsFile, FILE_IGNORE_NEW_LINES);
- if (!$info) {
- return '';
- }
- $statusStr = '';
- $currentTotalRequest = [];
- $workerInfo = [];
- try {
- $workerInfo = unserialize($info[0], ['allowed_classes' => false]);
- } catch (Throwable) {
- // do nothing
- }
- if (!is_array($workerInfo)) {
- $workerInfo = [];
- }
- ksort($workerInfo, SORT_NUMERIC);
- unset($info[0]);
- $dataWaitingSort = [];
- $readProcessStatus = false;
- $totalRequests = 0;
- $totalQps = 0;
- $totalConnections = 0;
- $totalFails = 0;
- $totalMemory = 0;
- $totalTimers = 0;
- $maxLen1 = max(static::getUiColumnLength('maxSocketNameLength'), 2 * static::UI_SAFE_LENGTH);
- $maxLen2 = max(static::getUiColumnLength('maxWorkerNameLength'), 2 * static::UI_SAFE_LENGTH);
- foreach ($info as $value) {
- if (!$readProcessStatus) {
- $statusStr .= $value . "\n";
- if (preg_match('/^pid.*?memory.*?listening/', $value)) {
- $readProcessStatus = true;
- }
- continue;
- }
- if (preg_match('/^[0-9]+/', $value, $pidMath)) {
- $pid = $pidMath[0];
- $dataWaitingSort[$pid] = $value;
- if (preg_match('/^\S+?\s+?(\S+?)\s+?(\S+?)\s+?(\S+?)\s+?(\S+?)\s+?(\S+?)\s+?(\S+?)\s+?(\S+?)\s+?/', $value, $match)) {
- $totalMemory += (float)str_ireplace('M', '', $match[1]);
- $maxLen1 = max($maxLen1, strlen($match[2]));
- $maxLen2 = max($maxLen2, strlen($match[3]));
- $totalConnections += (int)$match[4];
- $totalFails += (int)$match[5];
- $totalTimers += (int)$match[6];
- $currentTotalRequest[$pid] = $match[7];
- $totalRequests += (int)$match[7];
- }
- }
- }
- foreach ($workerInfo as $pid => $info) {
- if (!isset($dataWaitingSort[$pid])) {
- $statusStr .= "$pid\t" . str_pad('N/A', 7) . " "
- . str_pad($info['listen'], $maxLen1) . " "
- . str_pad((string)$info['name'], $maxLen2) . " "
- . str_pad('N/A', 11) . " " . str_pad('N/A', 9) . " "
- . str_pad('N/A', 7) . " " . str_pad('N/A', 13) . " N/A [busy] \n";
- continue;
- }
- //$qps = isset($totalRequestCache[$pid]) ? $currentTotalRequest[$pid]
- if (!isset($totalRequestCache[$pid], $currentTotalRequest[$pid])) {
- $qps = 0;
- } else {
- $qps = $currentTotalRequest[$pid] - $totalRequestCache[$pid];
- $totalQps += $qps;
- }
- $statusStr .= $dataWaitingSort[$pid] . " " . str_pad((string)$qps, 6) . " [idle]\n";
- }
- $totalRequestCache = $currentTotalRequest;
- $statusStr .= "---------------------------------------------------PROCESS STATUS--------------------------------------------------------\n";
- $statusStr .= "Summary\t" . str_pad($totalMemory . 'M', 7) . " "
- . str_pad('-', $maxLen1) . " "
- . str_pad('-', $maxLen2) . " "
- . str_pad((string)$totalConnections, 11) . " " . str_pad((string)$totalFails, 9) . " "
- . str_pad((string)$totalTimers, 7) . " " . str_pad((string)$totalRequests, 13) . " "
- . str_pad((string)$totalQps, 6) . " [Summary] \n";
- return $statusStr;
- }
- protected static function formatConnectionStatusData(): string
- {
- return file_get_contents(static::$connectionsFile);
- }
- /**
- * Install signal handler.
- *
- * @return void
- */
- protected static function installSignal(): void
- {
- if (DIRECTORY_SEPARATOR !== '/') {
- return;
- }
- $signals = [SIGINT, SIGTERM, SIGHUP, SIGTSTP, SIGQUIT, SIGUSR1, SIGUSR2, SIGIOT, SIGIO];
- foreach ($signals as $signal) {
- pcntl_signal($signal, static::signalHandler(...), false);
- }
- // ignore
- pcntl_signal(SIGPIPE, SIG_IGN, false);
- }
- /**
- * Reinstall signal handler.
- *
- * @return void
- */
- protected static function reinstallSignal(): void
- {
- if (DIRECTORY_SEPARATOR !== '/') {
- return;
- }
- $signals = [SIGINT, SIGTERM, SIGHUP, SIGTSTP, SIGQUIT, SIGUSR1, SIGUSR2, SIGIOT, SIGIO];
- foreach ($signals as $signal) {
- // Rewrite master process signal.
- static::$globalEvent->onSignal($signal, static::signalHandler(...));
- }
- }
- /**
- * Signal handler.
- *
- * @param int $signal
- */
- protected static function signalHandler(int $signal): void
- {
- switch ($signal) {
- // Stop.
- case SIGINT:
- case SIGTERM:
- case SIGHUP:
- case SIGTSTP:
- static::$gracefulStop = false;
- static::stopAll(0, "received signal $signal");
- break;
- // Graceful stop.
- case SIGQUIT:
- static::$gracefulStop = true;
- static::stopAll(0, "received signal $signal");
- break;
- // Reload.
- case SIGUSR2:
- case SIGUSR1:
- if (static::$status === static::STATUS_RELOADING || static::$status === static::STATUS_SHUTDOWN) {
- return;
- }
- static::$gracefulStop = $signal === SIGUSR2;
- static::$pidsToRestart = static::getAllWorkerPids();
- static::reload();
- break;
- // Show status.
- case SIGIOT:
- static::writeStatisticsToStatusFile();
- break;
- // Show connection status.
- case SIGIO:
- static::writeConnectionsStatisticsToStatusFile();
- break;
- }
- }
- /**
- * Run as daemon mode.
- */
- protected static function daemonize(): void
- {
- if (!static::$daemonize || DIRECTORY_SEPARATOR !== '/') {
- return;
- }
- umask(0);
- $pid = pcntl_fork();
- if (-1 === $pid) {
- throw new RuntimeException('Fork fail');
- } elseif ($pid > 0) {
- exit(0);
- }
- if (-1 === posix_setsid()) {
- throw new RuntimeException("Setsid fail");
- }
- // Fork again avoid SVR4 system regain the control of terminal.
- $pid = pcntl_fork();
- if (-1 === $pid) {
- throw new RuntimeException("Fork fail");
- } elseif (0 !== $pid) {
- exit(0);
- }
- }
- /**
- * Redirect standard output to stdoutFile.
- *
- * @return void
- */
- public static function resetStd(): void
- {
- if (!static::$daemonize || DIRECTORY_SEPARATOR !== '/') {
- return;
- }
- if (is_resource(STDOUT)) {
- fclose(STDOUT);
- }
- if (is_resource(STDERR)) {
- fclose(STDERR);
- }
- if (is_resource(static::$outputStream)) {
- fclose(static::$outputStream);
- }
- set_error_handler(static fn (): bool => true);
- $stdOutStream = fopen(static::$stdoutFile, 'a');
- restore_error_handler();
- if ($stdOutStream === false) {
- return;
- }
- static::$outputStream = $stdOutStream;
- // Fix standard output cannot redirect of PHP 8.1.8's bug
- if (function_exists('posix_isatty') && posix_isatty(2)) {
- ob_start(function (string $string) {
- file_put_contents(static::$stdoutFile, $string, FILE_APPEND);
- }, 1);
- }
- }
- /**
- * Save pid.
- */
- protected static function saveMasterPid(): void
- {
- if (DIRECTORY_SEPARATOR !== '/') {
- return;
- }
- static::$masterPid = posix_getpid();
- if (false === file_put_contents(static::$pidFile, static::$masterPid)) {
- throw new RuntimeException('can not save pid to ' . static::$pidFile);
- }
- }
- /**
- * Get all pids of worker processes.
- *
- * @return array
- */
- protected static function getAllWorkerPids(): array
- {
- $pidArray = [];
- foreach (static::$pidMap as $workerPidArray) {
- foreach ($workerPidArray as $workerPid) {
- $pidArray[$workerPid] = $workerPid;
- }
- }
- return $pidArray;
- }
- /**
- * Fork some worker processes.
- *
- * @return void
- */
- protected static function forkWorkers(): void
- {
- if (DIRECTORY_SEPARATOR === '/') {
- static::forkWorkersForLinux();
- } else {
- static::forkWorkersForWindows();
- }
- }
- /**
- * Fork some worker processes.
- *
- * @return void
- */
- protected static function forkWorkersForLinux(): void
- {
- foreach (static::$workers as $worker) {
- if (static::$status === static::STATUS_STARTING) {
- if (empty($worker->name)) {
- $worker->name = $worker->getSocketName();
- }
- }
- while (count(static::$pidMap[$worker->workerId]) < $worker->count) {
- static::forkOneWorkerForLinux($worker);
- }
- }
- }
- /**
- * Fork some worker processes.
- *
- * @return void
- */
- protected static function forkWorkersForWindows(): void
- {
- $files = static::getStartFilesForWindows();
- if (count($files) === 1 || in_array('-q', static::getArgv())) {
- if (count(static::$workers) > 1) {
- static::safeEcho("@@@ Error: multi workers init in one php file are not support @@@\r\n");
- static::safeEcho("@@@ See https://www.workerman.net/doc/workerman/faq/multi-woker-for-windows.html @@@\r\n");
- } elseif (count(static::$workers) <= 0) {
- exit("@@@no worker inited@@@\r\n\r\n");
- }
- reset(static::$workers);
- /** @var Worker $worker */
- $worker = current(static::$workers);
- Timer::delAll();
- //Update process state.
- static::$status = static::STATUS_RUNNING;
- // Register shutdown function for checking errors.
- register_shutdown_function(static::checkErrors(...));
- // Create a global event loop.
- if (static::$globalEvent === null) {
- $eventLoopClass = $worker->eventLoop ?: static::$eventLoopClass;
- static::$globalEvent = new $eventLoopClass();
- static::$globalEvent->setErrorHandler(function ($exception) {
- static::stopAll(250, $exception);
- });
- }
- // Reinstall signal.
- static::reinstallSignal();
- // Init Timer.
- Timer::init(static::$globalEvent);
- restore_error_handler();
- // Add an empty timer to prevent the event-loop from exiting.
- Timer::add(1000000, function (){});
- // Display UI.
- static::safeEcho(str_pad($worker->name, 48) . str_pad($worker->getSocketName(), 36) . str_pad('1', 10) . " [ok]\n");
- $worker->listen();
- $worker->run();
- static::$globalEvent->run();
- if (static::$status !== self::STATUS_SHUTDOWN) {
- $err = new RuntimeException('event-loop exited');
- static::log($err);
- exit(250);
- }
- exit(0);
- }
- static::$globalEvent = new Select();
- static::$globalEvent->setErrorHandler(function ($exception) {
- static::stopAll(250, $exception);
- });
- Timer::init(static::$globalEvent);
- foreach ($files as $startFile) {
- static::forkOneWorkerForWindows($startFile);
- }
- }
- /**
- * Get start files for windows.
- *
- * @return array
- */
- public static function getStartFilesForWindows(): array
- {
- $files = [];
- foreach (static::getArgv() as $file) {
- if (is_file($file)) {
- $files[$file] = $file;
- }
- }
- return $files;
- }
- /**
- * Fork one worker process.
- *
- * @param string $startFile
- */
- public static function forkOneWorkerForWindows(string $startFile): void
- {
- $startFile = realpath($startFile);
- $descriptorSpec = [STDIN, STDOUT, STDOUT];
- $pipes = [];
- $process = proc_open('"' . PHP_BINARY . '" ' . " \"$startFile\" -q", $descriptorSpec, $pipes, null, null, ['bypass_shell' => true]);
- if (static::$globalEvent === null) {
- static::$globalEvent = new Select();
- static::$globalEvent->setErrorHandler(function ($exception) {
- static::stopAll(250, $exception);
- });
- Timer::init(static::$globalEvent);
- }
- // 保存子进程句柄
- static::$processForWindows[$startFile] = [$process, $startFile];
- }
- /**
- * check worker status for windows.
- *
- * @return void
- */
- protected static function checkWorkerStatusForWindows(): void
- {
- foreach (static::$processForWindows as $processData) {
- $process = $processData[0];
- $startFile = $processData[1];
- $status = proc_get_status($process);
- if (!$status['running']) {
- static::safeEcho("process $startFile terminated and try to restart\n");
- proc_close($process);
- static::forkOneWorkerForWindows($startFile);
- }
- }
- }
- /**
- * Fork one worker process.
- *
- * @param self $worker
- */
- protected static function forkOneWorkerForLinux(self $worker): void
- {
- // Get available worker id.
- $id = static::getId($worker->workerId, 0);
- $pid = pcntl_fork();
- // For master process.
- if ($pid > 0) {
- static::$pidMap[$worker->workerId][$pid] = $pid;
- static::$idMap[$worker->workerId][$id] = $pid;
- } // For child processes.
- elseif (0 === $pid) {
- srand();
- mt_srand();
- static::$gracefulStop = false;
- if (static::$status === static::STATUS_STARTING) {
- static::resetStd();
- }
- static::$pidsToRestart = static::$pidMap = [];
- // Remove other listener.
- foreach (static::$workers as $key => $oneWorker) {
- if ($oneWorker->workerId !== $worker->workerId) {
- $oneWorker->unlisten();
- unset(static::$workers[$key]);
- }
- }
- Timer::delAll();
- //Update process state.
- static::$status = static::STATUS_RUNNING;
- // Register shutdown function for checking errors.
- register_shutdown_function(static::checkErrors(...));
- // Create a global event loop.
- if (static::$globalEvent === null) {
- $eventLoopClass = $worker->eventLoop ?: static::$eventLoopClass;
- static::$globalEvent = new $eventLoopClass();
- static::$globalEvent->setErrorHandler(function ($exception) {
- static::stopAll(250, $exception);
- });
- }
- // Reinstall signal.
- static::reinstallSignal();
- // Init Timer.
- Timer::init(static::$globalEvent);
- restore_error_handler();
- static::setProcessTitle('WorkerMan: worker process ' . $worker->name . ' ' . $worker->getSocketName());
- $worker->setUserAndGroup();
- $worker->id = $id;
- $worker->run();
- // Main loop.
- static::$globalEvent->run();
- if (static::$status !== self::STATUS_SHUTDOWN) {
- $err = new Exception('event-loop exited');
- static::log($err);
- exit(250);
- }
- exit(0);
- } else {
- throw new RuntimeException("forkOneWorker fail");
- }
- }
- /**
- * Get worker id.
- *
- * @param string $workerId
- * @param int $pid
- * @return false|int|string
- */
- protected static function getId(string $workerId, int $pid): false|int|string
- {
- return array_search($pid, static::$idMap[$workerId]);
- }
- /**
- * Set unix user and group for current process.
- *
- * @return void
- */
- public function setUserAndGroup(): void
- {
- // Get uid.
- $userInfo = posix_getpwnam($this->user);
- if (!$userInfo) {
- static::log("Warning: User $this->user not exists");
- return;
- }
- $uid = $userInfo['uid'];
- // Get gid.
- if ($this->group) {
- $groupInfo = posix_getgrnam($this->group);
- if (!$groupInfo) {
- static::log("Warning: Group $this->group not exists");
- return;
- }
- $gid = $groupInfo['gid'];
- } else {
- $gid = $userInfo['gid'];
- }
- // Set uid and gid.
- if ($uid !== posix_getuid() || $gid !== posix_getgid()) {
- if (!posix_setgid($gid) || !posix_initgroups($userInfo['name'], $gid) || !posix_setuid($uid)) {
- static::log("Warning: change gid or uid fail.");
- }
- }
- }
- /**
- * Set process name.
- *
- * @param string $title
- * @return void
- */
- protected static function setProcessTitle(string $title): void
- {
- set_error_handler(static fn (): bool => true);
- cli_set_process_title($title);
- restore_error_handler();
- }
- /**
- * Monitor all child processes.
- *
- * @return void
- * @throws Throwable
- */
- protected static function monitorWorkers(): void
- {
- if (DIRECTORY_SEPARATOR === '/') {
- static::monitorWorkersForLinux();
- } else {
- static::monitorWorkersForWindows();
- }
- }
- /**
- * Monitor all child processes.
- *
- * @return void
- */
- protected static function monitorWorkersForLinux(): void
- {
- static::$status = static::STATUS_RUNNING;
- // @phpstan-ignore-next-line While loop condition is always true.
- while (1) {
- // Calls signal handlers for pending signals.
- pcntl_signal_dispatch();
- // Suspends execution of the current process until a child has exited, or until a signal is delivered
- $status = 0;
- $pid = pcntl_wait($status, WUNTRACED);
- // Calls signal handlers for pending signals again.
- pcntl_signal_dispatch();
- // If a child has already exited.
- if ($pid > 0) {
- // Find out which worker process exited.
- foreach (static::$pidMap as $workerId => $workerPidArray) {
- if (isset($workerPidArray[$pid])) {
- $worker = static::$workers[$workerId];
- // Fix exit with status 2 for php8.2
- if ($status === SIGINT && static::$status === static::STATUS_SHUTDOWN) {
- $status = 0;
- }
- // Exit status.
- if ($status !== 0) {
- static::log("worker[$worker->name:$pid] exit with status $status");
- }
- // onWorkerExit
- if (static::$onWorkerExit) {
- try {
- (static::$onWorkerExit)($worker, $status, $pid);
- } catch (Throwable $exception) {
- static::log("worker[$worker->name] onWorkerExit $exception");
- }
- }
- // For Statistics.
- static::$globalStatistics['worker_exit_info'][$workerId][$status] ??= 0;
- static::$globalStatistics['worker_exit_info'][$workerId][$status]++;
- // Clear process data.
- unset(static::$pidMap[$workerId][$pid]);
- // Mark id is available.
- $id = static::getId($workerId, $pid);
- static::$idMap[$workerId][$id] = 0;
- break;
- }
- }
- // Is still running state then fork a new worker process.
- if (static::$status !== static::STATUS_SHUTDOWN) {
- static::forkWorkers();
- // If reloading continue.
- if (isset(static::$pidsToRestart[$pid])) {
- unset(static::$pidsToRestart[$pid]);
- static::reload();
- }
- }
- }
- // If shutdown state and all child processes exited, then master process exit.
- if (static::$status === static::STATUS_SHUTDOWN && empty(static::getAllWorkerPids())) {
- static::exitAndClearAll();
- }
- }
- }
- /**
- * Monitor all child processes.
- *
- * @return void
- */
- protected static function monitorWorkersForWindows(): void
- {
- Timer::add(1, static::checkWorkerStatusForWindows(...));
- static::$globalEvent->run();
- }
- /**
- * Exit current process.
- */
- protected static function exitAndClearAll(): void
- {
- foreach (static::$workers as $worker) {
- $socketName = $worker->getSocketName();
- if ($worker->transport === 'unix' && $socketName) {
- [, $address] = explode(':', $socketName, 2);
- $address = substr($address, strpos($address, '/') + 2);
- @unlink($address);
- }
- }
- @unlink(static::$pidFile);
- static::log("Workerman[" . basename(static::$startFile) . "] has been stopped");
- if (static::$onMasterStop) {
- (static::$onMasterStop)();
- }
- exit(0);
- }
- /**
- * Execute reload.
- *
- * @return void
- */
- protected static function reload(): void
- {
- // For master process.
- if (static::$masterPid === posix_getpid()) {
- $sig = static::getGracefulStop() ? SIGUSR2 : SIGUSR1;
- // Set reloading state.
- if (static::$status === static::STATUS_RUNNING) {
- static::log("Workerman[" . basename(static::$startFile) . "] reloading");
- static::$status = static::STATUS_RELOADING;
- static::resetStd();
- // Try to emit onMasterReload callback.
- if (static::$onMasterReload) {
- try {
- (static::$onMasterReload)();
- } catch (Throwable $e) {
- static::stopAll(250, $e);
- }
- static::initId();
- }
- // Send reload signal to all child processes.
- $reloadablePidArray = [];
- foreach (static::$pidMap as $workerId => $workerPidArray) {
- $worker = static::$workers[$workerId];
- if ($worker->reloadable) {
- $reloadablePidArray += $workerPidArray;
- continue;
- }
- // Send reload signal to a worker process which reloadable is false.
- array_walk($workerPidArray, static fn ($pid) => posix_kill($pid, $sig));
- }
- // Get all pids that are waiting reload.
- static::$pidsToRestart = array_intersect(static::$pidsToRestart, $reloadablePidArray);
- }
- // Reload complete.
- if (empty(static::$pidsToRestart)) {
- if (static::$status !== static::STATUS_SHUTDOWN) {
- static::$status = static::STATUS_RUNNING;
- }
- return;
- }
- // Continue reload.
- $oneWorkerPid = current(static::$pidsToRestart);
- // Send reload signal to a worker process.
- posix_kill($oneWorkerPid, $sig);
- // If the process does not exit after stopTimeout seconds try to kill it.
- if (!static::getGracefulStop()) {
- Timer::add(static::$stopTimeout, posix_kill(...), [$oneWorkerPid, SIGKILL], false);
- }
- } // For child processes.
- else {
- reset(static::$workers);
- $worker = current(static::$workers);
- // Try to emit onWorkerReload callback.
- if ($worker->onWorkerReload) {
- try {
- ($worker->onWorkerReload)($worker);
- } catch (Throwable $e) {
- static::stopAll(250, $e);
- }
- }
- if ($worker->reloadable) {
- static::stopAll();
- } else {
- static::resetStd();
- }
- }
- }
- /**
- * Stop all.
- *
- * @param int $code
- * @param mixed $log
- */
- public static function stopAll(int $code = 0, mixed $log = ''): void
- {
- static::$status = static::STATUS_SHUTDOWN;
- // For master process.
- if (DIRECTORY_SEPARATOR === '/' && static::$masterPid === posix_getpid()) {
- if ($log) {
- static::log("Workerman[" . basename(static::$startFile) . "] $log");
- }
- static::log("Workerman[" . basename(static::$startFile) . "] stopping" . ($code ? ", code [$code]" : ''));
- $workerPidArray = static::getAllWorkerPids();
- // Send stop signal to all child processes.
- $sig = static::getGracefulStop() ? SIGQUIT : SIGINT;
- foreach ($workerPidArray as $workerPid) {
- // Fix exit with status 2 for php8.2
- if ($sig === SIGINT && !static::$daemonize) {
- Timer::add(1, posix_kill(...), [$workerPid, SIGINT], false);
- } else {
- posix_kill($workerPid, $sig);
- }
- if (!static::getGracefulStop()) {
- Timer::add(ceil(static::$stopTimeout), posix_kill(...), [$workerPid, SIGKILL], false);
- }
- }
- Timer::add(1, static::checkIfChildRunning(...));
- } // For child processes.
- else {
- if ($code && $log) {
- static::log($log);
- }
- // Execute exit.
- $workers = array_reverse(static::$workers);
- array_walk($workers, static fn (Worker $worker) => $worker->stop());
- if (!static::getGracefulStop() || ConnectionInterface::$statistics['connection_count'] <= 0) {
- static::$globalEvent?->stop();
- try {
- // Ignore Swoole ExitException: Swoole exit.
- exit($code);
- /** @phpstan-ignore-next-line */
- } catch (Throwable) {
- // do nothing
- }
- }
- }
- }
- /**
- * check if child processes is really running
- */
- protected static function checkIfChildRunning(): void
- {
- foreach (static::$pidMap as $workerId => $workerPidArray) {
- foreach ($workerPidArray as $pid => $workerPid) {
- if (!posix_kill($pid, 0)) {
- unset(static::$pidMap[$workerId][$pid]);
- }
- }
- }
- }
- /**
- * Get process status.
- *
- * @return int
- */
- public static function getStatus(): int
- {
- return static::$status;
- }
- /**
- * If stop gracefully.
- *
- * @return bool
- */
- public static function getGracefulStop(): bool
- {
- return static::$gracefulStop;
- }
- /**
- *
- * Write statistics data to disk.
- *
- * @return void
- */
- protected static function writeStatisticsToStatusFile(): void
- {
- // For master process.
- if (static::$masterPid === posix_getpid()) {
- $allWorkerInfo = [];
- foreach (static::$pidMap as $workerId => $pidArray) {
- $worker = static::$workers[$workerId];
- foreach ($pidArray as $pid) {
- $allWorkerInfo[$pid] = ['name' => $worker->name, 'listen' => $worker->getSocketName()];
- }
- }
- file_put_contents(static::$statisticsFile, '');
- chmod(static::$statisticsFile, 0722);
- file_put_contents(static::$statisticsFile, serialize($allWorkerInfo) . "\n", FILE_APPEND);
- $loadavg = function_exists('sys_getloadavg') ? array_map(round(...), sys_getloadavg(), [2, 2, 2]) : ['-', '-', '-'];
- file_put_contents(static::$statisticsFile,
- (static::$daemonize ? "Start worker in DAEMON mode." : "Start worker in DEBUG mode.") . "\n", FILE_APPEND);
- file_put_contents(static::$statisticsFile,
- "---------------------------------------------------GLOBAL STATUS---------------------------------------------------------\n", FILE_APPEND);
- file_put_contents(static::$statisticsFile, static::getVersionLine(), FILE_APPEND);
- file_put_contents(static::$statisticsFile, 'start time:' . date('Y-m-d H:i:s',
- static::$globalStatistics['start_timestamp'])
- . ' run ' . floor((time() - static::$globalStatistics['start_timestamp']) / (24 * 60 * 60))
- . ' days ' . floor(((time() - static::$globalStatistics['start_timestamp']) % (24 * 60 * 60)) / (60 * 60))
- . " hours " . 'load average: ' . implode(", ", $loadavg) . "\n", FILE_APPEND);
- file_put_contents(static::$statisticsFile,
- count(static::$pidMap) . ' workers ' . count(static::getAllWorkerPids()) . " processes\n",
- FILE_APPEND);
- file_put_contents(static::$statisticsFile,
- str_pad('name', static::getUiColumnLength('maxWorkerNameLength')) . " event exit_status exit_count\n", FILE_APPEND);
- foreach (static::$pidMap as $workerId => $workerPidArray) {
- $worker = static::$workers[$workerId];
- if (isset(static::$globalStatistics['worker_exit_info'][$workerId])) {
- foreach (static::$globalStatistics['worker_exit_info'][$workerId] as $workerExitStatus => $workerExitCount) {
- file_put_contents(static::$statisticsFile,
- str_pad($worker->name, static::getUiColumnLength('maxWorkerNameLength')) . " " .
- str_pad($worker->context->eventLoopName, 12) . " " .
- str_pad((string)$workerExitStatus, 16) . str_pad((string)$workerExitCount, 16) . "\n", FILE_APPEND);
- }
- } else {
- file_put_contents(static::$statisticsFile,
- str_pad($worker->name, static::getUiColumnLength('maxWorkerNameLength')) . " " .
- str_pad($worker->context->eventLoopName, 12) . " " .
- str_pad('0', 16) . str_pad('0', 16) . "\n", FILE_APPEND);
- }
- }
- file_put_contents(static::$statisticsFile,
- "---------------------------------------------------PROCESS STATUS--------------------------------------------------------\n",
- FILE_APPEND);
- file_put_contents(static::$statisticsFile,
- "pid\tmemory " . str_pad('listening', static::getUiColumnLength('maxSocketNameLength')) . " " . str_pad('name',
- static::getUiColumnLength('maxWorkerNameLength')) . " connections " . str_pad('send_fail', 9) . " "
- . str_pad('timers', 8) . str_pad('total_request', 13) . " qps status\n", FILE_APPEND);
- foreach (static::getAllWorkerPids() as $workerPid) {
- posix_kill($workerPid, SIGIOT);
- }
- return;
- }
- // For child processes.
- gc_collect_cycles();
- gc_mem_caches();
- reset(static::$workers);
- /** @var static $worker */
- $worker = current(static::$workers);
- $workerStatusStr = posix_getpid() . "\t" . str_pad(round(memory_get_usage() / (1024 * 1024), 2) . "M", 7)
- . " " . str_pad($worker->getSocketName(), static::getUiColumnLength('maxSocketNameLength')) . " "
- . str_pad(($worker->name === $worker->getSocketName() ? 'none' : $worker->name), static::getUiColumnLength('maxWorkerNameLength'))
- . " ";
- $workerStatusStr .= str_pad((string)ConnectionInterface::$statistics['connection_count'], 11)
- . " " . str_pad((string)ConnectionInterface::$statistics['send_fail'], 9)
- . " " . str_pad((string)static::$globalEvent->getTimerCount(), 7)
- . " " . str_pad((string)ConnectionInterface::$statistics['total_request'], 13) . "\n";
- file_put_contents(static::$statisticsFile, $workerStatusStr, FILE_APPEND);
- }
- /**
- * Get UI column length
- *
- * @param $name
- * @return int
- */
- protected static function getUiColumnLength($name): int
- {
- return static::$uiLengthData[$name] ?? 0;
- }
- /**
- * Write statistics data to disk.
- *
- * @return void
- */
- protected static function writeConnectionsStatisticsToStatusFile(): void
- {
- // For master process.
- if (static::$masterPid === posix_getpid()) {
- file_put_contents(static::$connectionsFile, '');
- chmod(static::$connectionsFile, 0722);
- file_put_contents(static::$connectionsFile, "--------------------------------------------------------------------- WORKERMAN CONNECTION STATUS --------------------------------------------------------------------------------\n", FILE_APPEND);
- file_put_contents(static::$connectionsFile, "PID Worker CID Trans Protocol ipv4 ipv6 Recv-Q Send-Q Bytes-R Bytes-W Status Local Address Foreign Address\n", FILE_APPEND);
- foreach (static::getAllWorkerPids() as $workerPid) {
- posix_kill($workerPid, SIGIO);
- }
- return;
- }
- // For child processes.
- $bytesFormat = function ($bytes) {
- if ($bytes > 1024 * 1024 * 1024 * 1024) {
- return round($bytes / (1024 * 1024 * 1024 * 1024), 1) . "TB";
- }
- if ($bytes > 1024 * 1024 * 1024) {
- return round($bytes / (1024 * 1024 * 1024), 1) . "GB";
- }
- if ($bytes > 1024 * 1024) {
- return round($bytes / (1024 * 1024), 1) . "MB";
- }
- if ($bytes > 1024) {
- return round($bytes / (1024), 1) . "KB";
- }
- return $bytes . "B";
- };
- $pid = posix_getpid();
- $str = '';
- reset(static::$workers);
- $currentWorker = current(static::$workers);
- $defaultWorkerName = $currentWorker->name;
- foreach (TcpConnection::$connections as $connection) {
- /** @var TcpConnection $connection */
- $transport = $connection->transport;
- $ipv4 = $connection->isIpV4() ? ' 1' : ' 0';
- $ipv6 = $connection->isIpV6() ? ' 1' : ' 0';
- $recvQ = $bytesFormat($connection->getRecvBufferQueueSize());
- $sendQ = $bytesFormat($connection->getSendBufferQueueSize());
- $localAddress = trim($connection->getLocalAddress());
- $remoteAddress = trim($connection->getRemoteAddress());
- $state = $connection->getStatus(false);
- $bytesRead = $bytesFormat($connection->bytesRead);
- $bytesWritten = $bytesFormat($connection->bytesWritten);
- $id = $connection->id;
- $protocol = $connection->protocol ?: $connection->transport;
- $pos = strrpos($protocol, '\\');
- if ($pos) {
- $protocol = substr($protocol, $pos + 1);
- }
- if (strlen($protocol) > 15) {
- $protocol = substr($protocol, 0, 13) . '..';
- }
- $workerName = isset($connection->worker) ? $connection->worker->name : $defaultWorkerName;
- if (strlen($workerName) > 14) {
- $workerName = substr($workerName, 0, 12) . '..';
- }
- $str .= str_pad((string)$pid, 9) . str_pad($workerName, 16) . str_pad((string)$id, 10) . str_pad($transport, 8)
- . str_pad($protocol, 16) . str_pad($ipv4, 7) . str_pad($ipv6, 7) . str_pad($recvQ, 13)
- . str_pad($sendQ, 13) . str_pad($bytesRead, 13) . str_pad($bytesWritten, 13) . ' '
- . str_pad($state, 14) . ' ' . str_pad($localAddress, 22) . ' ' . str_pad($remoteAddress, 22) . "\n";
- }
- if ($str) {
- file_put_contents(static::$connectionsFile, $str, FILE_APPEND);
- }
- }
- /**
- * Check errors when current process exited.
- *
- * @return void
- */
- protected static function checkErrors(): void
- {
- if (static::STATUS_SHUTDOWN !== static::$status) {
- $errorMsg = DIRECTORY_SEPARATOR === '/' ? 'Worker[' . posix_getpid() . '] process terminated' : 'Worker process terminated';
- $errors = error_get_last();
- if ($errors && ($errors['type'] === E_ERROR ||
- $errors['type'] === E_PARSE ||
- $errors['type'] === E_CORE_ERROR ||
- $errors['type'] === E_COMPILE_ERROR ||
- $errors['type'] === E_RECOVERABLE_ERROR)
- ) {
- $errorMsg .= ' with ERROR: ' . static::getErrorType($errors['type']) . " \"{$errors['message']} in {$errors['file']} on line {$errors['line']}\"";
- }
- static::log($errorMsg);
- }
- }
- /**
- * Get error message by error code.
- *
- * @param int $type
- * @return string
- */
- protected static function getErrorType(int $type): string
- {
- return self::ERROR_TYPE[$type] ?? '';
- }
- /**
- * Log.
- *
- * @param Stringable|string $msg
- * @param bool $decorated
- * @return void
- */
- public static function log(Stringable|string $msg, bool $decorated = false): void
- {
- $msg = trim((string)$msg);
- if (!static::$daemonize) {
- static::safeEcho("$msg\n", $decorated);
- }
- if (isset(static::$logFile)) {
- $pid = DIRECTORY_SEPARATOR === '/' ? posix_getpid() : 1;
- file_put_contents(static::$logFile, sprintf("%s pid:%d %s\n", date('Y-m-d H:i:s'), $pid, $msg), FILE_APPEND | LOCK_EX);
- }
- }
- /**
- * Safe Echo.
- *
- * @param string $msg
- * @param bool $decorated
- * @return void
- */
- public static function safeEcho(string $msg, bool $decorated = false): void
- {
- if ((static::$outputDecorated ?? false) && $decorated) {
- $line = "\033[1A\n\033[K";
- $white = "\033[47;30m";
- $green = "\033[32;40m";
- $end = "\033[0m";
- } else {
- $line = '';
- $white = '';
- $green = '';
- $end = '';
- }
- $msg = str_replace(['<n>', '<w>', '<g>'], [$line, $white, $green], $msg);
- $msg = str_replace(['</n>', '</w>', '</g>'], $end, $msg);
- set_error_handler(static fn (): bool => true);
- if (!feof(self::$outputStream)) {
- fwrite(self::$outputStream, $msg);
- fflush(self::$outputStream);
- }
- restore_error_handler();
- }
- /**
- * Listen.
- */
- public function listen(): void
- {
- if (!$this->socketName) {
- return;
- }
- if (!$this->mainSocket) {
- $localSocket = $this->parseSocketAddress();
- // Flag.
- $flags = $this->transport === 'udp' ? STREAM_SERVER_BIND : STREAM_SERVER_BIND | STREAM_SERVER_LISTEN;
- $errNo = 0;
- $errMsg = '';
- // SO_REUSEPORT.
- if ($this->reusePort) {
- stream_context_set_option($this->socketContext, 'socket', 'so_reuseport', 1);
- }
- // Create an Internet or Unix domain server socket.
- $this->mainSocket = stream_socket_server($localSocket, $errNo, $errMsg, $flags, $this->socketContext);
- if (!$this->mainSocket) {
- throw new RuntimeException($errMsg);
- }
- if ($this->transport === 'ssl') {
- stream_socket_enable_crypto($this->mainSocket, false);
- } elseif ($this->transport === 'unix') {
- $socketFile = substr($localSocket, 7);
- if ($this->user) {
- chown($socketFile, $this->user);
- }
- if ($this->group) {
- chgrp($socketFile, $this->group);
- }
- }
- // Try to open keepalive for tcp and disable Nagle algorithm.
- if (function_exists('socket_import_stream') && self::BUILD_IN_TRANSPORTS[$this->transport] === 'tcp') {
- set_error_handler(static fn (): bool => true);
- $socket = socket_import_stream($this->mainSocket);
- socket_set_option($socket, SOL_SOCKET, SO_KEEPALIVE, 1);
- socket_set_option($socket, SOL_TCP, TCP_NODELAY, 1);
- if (defined('TCP_KEEPIDLE')) {
- socket_set_option($socket, SOL_TCP, TCP_KEEPIDLE, TcpConnection::TCP_KEEPALIVE_INTERVAL);
- socket_set_option($socket, SOL_TCP, TCP_KEEPINTVL, TcpConnection::TCP_KEEPALIVE_INTERVAL);
- socket_set_option($socket, SOL_TCP, TCP_KEEPCNT, 1);
- }
- restore_error_handler();
- }
- // Non blocking.
- stream_set_blocking($this->mainSocket, false);
- }
- $this->resumeAccept();
- }
- /**
- * Unlisten.
- *
- * @return void
- */
- public function unlisten(): void
- {
- $this->pauseAccept();
- if ($this->mainSocket) {
- set_error_handler(static fn (): bool => true);
- fclose($this->mainSocket);
- restore_error_handler();
- $this->mainSocket = null;
- }
- }
- /**
- * Check port available.
- *
- * @return void
- */
- protected static function checkPortAvailable(): void
- {
- foreach (static::$workers as $worker) {
- $socketName = $worker->getSocketName();
- if (DIRECTORY_SEPARATOR === '/' // if linux
- && static::$status === static::STATUS_STARTING // only for starting status
- && $worker->transport === 'tcp' // if tcp socket
- && !str_starts_with($socketName, 'unix') // if not unix socket
- && !str_starts_with($socketName, 'udp')) { // if not udp socket
- $address = parse_url($socketName);
- if (isset($address['host']) && isset($address['port'])) {
- $address = "tcp://{$address['host']}:{$address['port']}";
- $server = null;
- set_error_handler(function ($code, $msg) {
- throw new RuntimeException($msg);
- });
- $server = stream_socket_server($address, $code, $msg);
- if ($server) {
- fclose($server);
- }
- restore_error_handler();
- }
- }
- }
- }
- /**
- * Parse local socket address.
- */
- protected function parseSocketAddress(): ?string
- {
- if (!$this->socketName) {
- return null;
- }
- // Get the application layer communication protocol and listening address.
- [$scheme, $address] = explode(':', $this->socketName, 2);
- // Check application layer protocol class.
- if (!isset(self::BUILD_IN_TRANSPORTS[$scheme])) {
- $scheme = ucfirst($scheme);
- $this->protocol = $scheme[0] === '\\' ? $scheme : 'Protocols\\' . $scheme;
- if (!class_exists($this->protocol)) {
- $this->protocol = "Workerman\\Protocols\\$scheme";
- if (!class_exists($this->protocol)) {
- throw new RuntimeException("class \\Protocols\\$scheme not exist");
- }
- }
- if (!isset(self::BUILD_IN_TRANSPORTS[$this->transport])) {
- throw new RuntimeException('Bad worker->transport ' . var_export($this->transport, true));
- }
- } else if ($this->transport === 'tcp') {
- $this->transport = $scheme;
- }
- //local socket
- return self::BUILD_IN_TRANSPORTS[$this->transport] . ":" . $address;
- }
- /**
- * Pause accept new connections.
- *
- * @return void
- */
- public function pauseAccept(): void
- {
- if (static::$globalEvent !== null && $this->pauseAccept === false && $this->mainSocket !== null) {
- static::$globalEvent->offReadable($this->mainSocket);
- $this->pauseAccept = true;
- }
- }
- /**
- * Resume accept new connections.
- *
- * @return void
- */
- public function resumeAccept(): void
- {
- // Register a listener to be notified when server socket is ready to read.
- if (static::$globalEvent !== null && $this->pauseAccept === true && $this->mainSocket !== null) {
- if ($this->transport !== 'udp') {
- static::$globalEvent->onReadable($this->mainSocket, $this->acceptTcpConnection(...));
- } else {
- static::$globalEvent->onReadable($this->mainSocket, $this->acceptUdpConnection(...));
- }
- $this->pauseAccept = false;
- }
- }
- /**
- * Get socket name.
- *
- * @return string
- */
- public function getSocketName(): string
- {
- return $this->socketName ? lcfirst($this->socketName) : 'none';
- }
- /**
- * Run worker instance.
- *
- * @return void
- */
- public function run(): void
- {
- $this->listen();
- // Try to emit onWorkerStart callback.
- if ($this->onWorkerStart) {
- try {
- ($this->onWorkerStart)($this);
- } catch (Throwable $e) {
- // Avoid rapid infinite loop exit.
- sleep(1);
- static::stopAll(250, $e);
- }
- }
- }
- /**
- * Stop current worker instance.
- *
- * @return void
- */
- public function stop(): void
- {
- if ($this->stopping === true) {
- return;
- }
- // Try to emit onWorkerStop callback.
- if ($this->onWorkerStop) {
- try {
- ($this->onWorkerStop)($this);
- } catch (Throwable $e) {
- static::log($e);
- }
- }
- // Remove listener for server socket.
- $this->unlisten();
- // Close all connections for the worker.
- if (!static::getGracefulStop()) {
- foreach ($this->connections as $connection) {
- $connection->close();
- }
- }
- // Clear callback.
- $this->onMessage = $this->onClose = $this->onError = $this->onBufferDrain = $this->onBufferFull = null;
- $this->stopping = true;
- }
- /**
- * Accept a connection.
- *
- * @param resource $socket
- * @return void
- */
- protected function acceptTcpConnection(mixed $socket): void
- {
- // Accept a connection on server socket.
- set_error_handler(static fn (): bool => true);
- $newSocket = stream_socket_accept($socket, 0, $remoteAddress);
- restore_error_handler();
- // Thundering herd.
- if (!$newSocket) {
- return;
- }
- // TcpConnection.
- $connection = new TcpConnection(static::$globalEvent, $newSocket, $remoteAddress);
- $this->connections[$connection->id] = $connection;
- $connection->worker = $this;
- $connection->protocol = $this->protocol;
- $connection->transport = $this->transport;
- $connection->onMessage = $this->onMessage;
- $connection->onClose = $this->onClose;
- $connection->onError = $this->onError;
- $connection->onBufferDrain = $this->onBufferDrain;
- $connection->onBufferFull = $this->onBufferFull;
- // Try to emit onConnect callback.
- if ($this->onConnect) {
- try {
- ($this->onConnect)($connection);
- } catch (Throwable $e) {
- static::stopAll(250, $e);
- }
- }
- }
- /**
- * For udp package.
- *
- * @param resource $socket
- * @return void
- */
- protected function acceptUdpConnection(mixed $socket): void
- {
- set_error_handler(static fn (): bool => true);
- $recvBuffer = stream_socket_recvfrom($socket, UdpConnection::MAX_UDP_PACKAGE_SIZE, 0, $remoteAddress);
- restore_error_handler();
- if (false === $recvBuffer || empty($remoteAddress)) {
- return;
- }
- // UdpConnection.
- $connection = new UdpConnection($socket, $remoteAddress);
- $connection->protocol = $this->protocol;
- $messageCallback = $this->onMessage;
- if ($messageCallback) {
- try {
- if ($this->protocol !== null) {
- $parser = $this->protocol;
- if ($parser && method_exists($parser, 'input')) {
- while ($recvBuffer !== '') {
- $len = $parser::input($recvBuffer, $connection);
- if ($len === 0) {
- return;
- }
- $package = substr($recvBuffer, 0, $len);
- $recvBuffer = substr($recvBuffer, $len);
- $data = $parser::decode($package, $connection);
- if ($data === false) {
- continue;
- }
- $messageCallback($connection, $data);
- }
- } else {
- $data = $parser::decode($recvBuffer, $connection);
- // Discard bad packets.
- if ($data === false) {
- return;
- }
- $messageCallback($connection, $data);
- }
- } else {
- $messageCallback($connection, $recvBuffer);
- }
- ConnectionInterface::$statistics['total_request']++;
- } catch (Throwable $e) {
- static::stopAll(250, $e);
- }
- }
- }
- /**
- * Check master process is alive
- *
- * @param int $masterPid
- * @return bool
- */
- protected static function checkMasterIsAlive(int $masterPid): bool
- {
- if (empty($masterPid)) {
- return false;
- }
- $masterIsAlive = posix_kill($masterPid, 0) && posix_getpid() !== $masterPid;
- if (!$masterIsAlive) {
- static::log("Master pid:$masterPid is not alive");
- return false;
- }
- $cmdline = "/proc/$masterPid/cmdline";
- if (!is_readable($cmdline)) {
- return true;
- }
- $content = file_get_contents($cmdline);
- if (empty($content)) {
- return true;
- }
- return str_contains($content, 'WorkerMan') || str_contains($content, 'php');
- }
- }
|