X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FCore%2FWorker.php;h=d43d8c7281008198beac9b812ee9bd160fbf9d56;hb=d5373c583bc12d2104659aaf6386d2b9e28ec68d;hp=559ae6837034acdd6ae592f914f541c5fc6a94e2;hpb=74d7d7e164364c09b7fdfbf64e15168ccd56508a;p=friendica.git diff --git a/src/Core/Worker.php b/src/Core/Worker.php index 559ae68370..d43d8c7281 100644 --- a/src/Core/Worker.php +++ b/src/Core/Worker.php @@ -1,6 +1,6 @@ isMaxLoadReached()) { + if (DI::system()->isMaxLoadReached()) { Logger::notice('Pre check: maximum load reached, quitting.'); return; } // We now start the process. This is done after the load check since this could increase the load. - DI::process()->start(); + self::$process = $process; // Kill stale processes every 5 minutes $last_cleanup = DI::config()->get('system', 'worker_last_cleaned', 0); @@ -97,6 +98,10 @@ class Worker // We fetch the next queue entry that is about to be executed while ($r = self::workerProcess()) { + if (self::IPCJobsExists(getmypid())) { + self::IPCDeleteJobState(getmypid()); + } + // Don't refetch when a worker fetches tasks for multiple workers $refetched = DI::config()->get('system', 'worker_multiple_fetch'); foreach ($r as $entry) { @@ -133,7 +138,7 @@ class Worker } // Check free memory - if (DI::process()->isMinMemoryReached()) { + if (DI::system()->isMinMemoryReached()) { Logger::warning('Memory limit reached, quitting.'); DI::lock()->release(self::LOCK_WORKER); return; @@ -146,7 +151,7 @@ class Worker // Quit the worker once every cron interval if (time() > ($starttime + (DI::config()->get('system', 'cron_interval') * 60))) { Logger::info('Process lifetime reached, respawning.'); - self::unclaimProcess(); + self::unclaimProcess($process); if (self::isDaemonMode()) { self::IPCSetJobState(true); } else { @@ -179,7 +184,7 @@ class Worker } // Do we have too few memory? - if (DI::process()->isMinMemoryReached()) { + if (DI::system()->isMinMemoryReached()) { Logger::warning('Memory limit reached, quitting.'); return false; } @@ -191,7 +196,7 @@ class Worker } // Possibly there are too much database processes that block the system - if (DI::process()->isMaxProcessesReached()) { + if (DI::system()->isMaxProcessesReached()) { Logger::warning('Maximum processes reached, quitting.'); return false; } @@ -276,6 +281,44 @@ class Worker return DBA::exists('workerqueue', $condition); } + /** + * Checks if the given file is valid to be included + * + * @param mixed $file + * @return bool + */ + private static function validateInclude(&$file) + { + $orig_file = $file; + + $file = realpath($file); + + if (strpos($file, getcwd()) !== 0) { + return false; + } + + $file = str_replace(getcwd() . "/", "", $file, $count); + if ($count != 1) { + return false; + } + + if ($orig_file !== $file) { + return false; + } + + $valid = false; + if (strpos($file, "include/") === 0) { + $valid = true; + } + + if (strpos($file, "addon/") === 0) { + $valid = true; + } + + // Simply return flag + return $valid; + } + /** * Execute a worker entry * @@ -295,7 +338,7 @@ class Worker } // Constantly check the number of parallel database processes - if (DI::process()->isMaxProcessesReached()) { + if (DI::system()->isMaxProcessesReached()) { Logger::warning("Max processes reached for process", ['pid' => $mypid]); return false; } @@ -307,6 +350,10 @@ class Worker } $argv = json_decode($queue['parameter'], true); + if (!is_array($argv)) { + $argv = []; + } + if (!empty($queue['command'])) { array_unshift($argv, $queue['command']); } @@ -355,7 +402,7 @@ class Worker $include = "include/".$include.".php"; } - if (!validate_include($include)) { + if (!self::validateInclude($include)) { Logger::warning("Include file is not valid", ['file' => $argv[0]]); $stamp = (float)microtime(true); DBA::delete('workerqueue', ['id' => $queue["id"]]); @@ -438,7 +485,7 @@ class Worker $queue['priority'] = PRIORITY_MEDIUM; } - $a->queue = $queue; + $a->setQueue($queue); $up_duration = microtime(true) - self::$up_start; @@ -454,7 +501,7 @@ class Worker Logger::disableWorker(); - unset($a->queue); + $a->setQueue([]); $duration = (microtime(true) - $stamp); @@ -707,13 +754,10 @@ class Worker } $stamp = (float)microtime(true); - $jobs = DBA::p("SELECT COUNT(*) AS `jobs` FROM `workerqueue` WHERE `done` AND `executed` > UTC_TIMESTAMP() - INTERVAL ? MINUTE", $interval); + $jobs = DBA::count('workerqueue', ["`done` AND `executed` > ?", DateTimeFormat::utc('now - ' . $interval . ' minute')]); self::$db_duration += (microtime(true) - $stamp); self::$db_duration_stat += (microtime(true) - $stamp); - if ($job = DBA::fetch($jobs)) { - $jobs_per_minute[$interval] = number_format($job['jobs'] / $interval, 0); - } - DBA::close($jobs); + $jobs_per_minute[$interval] = number_format($jobs / $interval, 0); } $processlist = ' - jpm: '.implode('/', $jobs_per_minute); } @@ -734,15 +778,12 @@ class Worker self::$db_duration_stat += (microtime(true) - $stamp); while ($entry = DBA::fetch($jobs)) { $stamp = (float)microtime(true); - $processes = DBA::p("SELECT COUNT(*) AS `running` FROM `workerqueue-view` WHERE `priority` = ?", $entry["priority"]); + $running = DBA::count('workerqueue-view', ['priority' => $entry["priority"]]); self::$db_duration += (microtime(true) - $stamp); self::$db_duration_stat += (microtime(true) - $stamp); - if ($process = DBA::fetch($processes)) { - $idle_workers -= $process["running"]; - $waiting_processes += $entry["entries"]; - $listitem[$entry["priority"]] = $entry["priority"].":".$process["running"]."/".$entry["entries"]; - } - DBA::close($processes); + $idle_workers -= $running; + $waiting_processes += $entry["entries"]; + $listitem[$entry["priority"]] = $entry["priority"] . ":" . $running . "/" . $entry["entries"]; } DBA::close($jobs); } else { @@ -805,7 +846,7 @@ class Worker private static function activeWorkers() { $stamp = (float)microtime(true); - $count = DBA::count('process', ['command' => 'Worker.php']); + $count = DI::process()->countCommand('Worker.php'); self::$db_duration += (microtime(true) - $stamp); self::$db_duration_count += (microtime(true) - $stamp); return $count; @@ -823,7 +864,7 @@ class Worker $stamp = (float)microtime(true); $queues = DBA::p("SELECT `process`.`pid`, COUNT(`workerqueue`.`pid`) AS `entries` FROM `process` - LEFT JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid` AND NOT `workerqueue`.`done` + LEFT JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid` AND NOT `workerqueue`.`done` GROUP BY `process`.`pid`"); while ($queue = DBA::fetch($queues)) { $ids[$queue['pid']] = $queue['entries']; @@ -1068,108 +1109,19 @@ class Worker /** * Removes a workerqueue entry from the current process * + * @param Process $process the process behind the workerqueue + * * @return void * @throws \Exception */ - public static function unclaimProcess() + public static function unclaimProcess(Process $process) { - $mypid = getmypid(); - $stamp = (float)microtime(true); - DBA::update('workerqueue', ['executed' => DBA::NULL_DATETIME, 'pid' => 0], ['pid' => $mypid, 'done' => false]); + DBA::update('workerqueue', ['executed' => DBA::NULL_DATETIME, 'pid' => 0], ['pid' => $process->pid, 'done' => false]); self::$db_duration += (microtime(true) - $stamp); self::$db_duration_write += (microtime(true) - $stamp); } - /** - * Call the front end worker - * - * @return void - * @throws \Friendica\Network\HTTPException\InternalServerErrorException - */ - public static function callWorker() - { - if (!DI::config()->get("system", "frontend_worker")) { - return; - } - - $url = DI::baseUrl() . '/worker'; - DI::httpRequest()->fetch($url, 1); - } - - /** - * Call the front end worker if there aren't any active - * - * @return void - * @throws \Friendica\Network\HTTPException\InternalServerErrorException - */ - public static function executeIfIdle() - { - self::checkDaemonState(); - - if (!DI::config()->get("system", "frontend_worker")) { - return; - } - - // Do we have "proc_open"? Then we can fork the worker - if (function_exists("proc_open")) { - // When was the last time that we called the worker? - // Less than one minute? Then we quit - if ((time() - DI::config()->get("system", "worker_started")) < 60) { - return; - } - - DI::config()->set("system", "worker_started", time()); - - // Do we have enough running workers? Then we quit here. - if (self::tooMuchWorkers()) { - // Cleaning dead processes - self::killStaleWorkers(); - DI::modelProcess()->deleteInactive(); - - return; - } - - self::runCron(); - - Logger::info('Call worker'); - self::spawnWorker(); - return; - } - - // We cannot execute background processes. - // We now run the processes from the frontend. - // This won't work with long running processes. - self::runCron(); - - self::clearProcesses(); - - $workers = self::activeWorkers(); - - if ($workers == 0) { - self::callWorker(); - } - } - - /** - * Removes long running worker processes - * - * @return void - * @throws \Friendica\Network\HTTPException\InternalServerErrorException - */ - public static function clearProcesses() - { - $timeout = DI::config()->get("system", "frontend_worker_timeout", 10); - - /// @todo We should clean up the corresponding workerqueue entries as well - $stamp = (float)microtime(true); - $condition = ["`created` < ? AND `command` = 'worker.php'", - DateTimeFormat::utc("now - ".$timeout." minutes")]; - DBA::delete('process', $condition); - self::$db_duration = (microtime(true) - $stamp); - self::$db_duration_write += (microtime(true) - $stamp); - } - /** * Runs the cron processes * @@ -1198,7 +1150,7 @@ class Worker */ private static function forkProcess(bool $do_cron) { - if (DI::process()->isMinMemoryReached()) { + if (DI::system()->isMinMemoryReached()) { Logger::warning('Memory limit reached - quitting'); return; } @@ -1214,33 +1166,39 @@ class Worker } elseif ($pid) { // The parent process continues here DBA::connect(); - Logger::info('Spawned new worker', ['cron' => $do_cron, 'pid' => $pid]); + + self::IPCSetJobState(true, $pid); + Logger::info('Spawned new worker', ['pid' => $pid]); + + $cycles = 0; + while (self::IPCJobsExists($pid) && (++$cycles < 100)) { + usleep(10000); + } + + Logger::info('Spawned worker is ready', ['pid' => $pid, 'wait_cycles' => $cycles]); return; } // We now are in the new worker DBA::connect(); - Logger::info('Worker spawned', ['cron' => $do_cron, 'pid' => getmypid()]); - DI::process()->start(); + DI::flushLogger(); + $process = DI::process()->create(getmypid(), basename(__FILE__)); - self::processQueue($do_cron); + $cycles = 0; + while (!self::IPCJobsExists($process->pid) && (++$cycles < 100)) { + usleep(10000); + } - self::unclaimProcess(); + Logger::info('Worker spawned', ['pid' => $process->pid, 'wait_cycles' => $cycles]); - DI::process()->end(); - Logger::info('Worker ended', ['cron' => $do_cron, 'pid' => getmypid()]); + self::processQueue($do_cron, $process); - DBA::disconnect(); -/* - $php = '/usr/bin/php'; - $param = ['bin/worker.php']; - if ($do_cron) { - $param[] = 'no_cron'; - } - pcntl_exec($php, $param); - Logger::warning('Error calling worker', ['cron' => $do_cron, 'pid' => getmypid()]); -*/ + self::unclaimProcess($process); + + self::IPCSetJobState(false, $process->pid); + DI::process()->delete($process); + Logger::info('Worker ended', ['pid' => $process->pid]); exit(); } @@ -1253,13 +1211,13 @@ class Worker */ public static function spawnWorker($do_cron = false) { - if (self::isDaemonMode()) { + if (self::isDaemonMode() && DI::config()->get('system', 'worker_fork')) { self::forkProcess($do_cron); - self::IPCSetJobState(false); } else { - $process = new Core\Process(DI::logger(), DI::mode(), DI::config(), - DI::modelProcess(), DI::app()->getBasePath(), getmypid()); - $process->run('bin/worker.php', ['no_cron' => !$do_cron]); + DI::system()->run('bin/worker.php', ['no_cron' => !$do_cron]); + } + if (self::isDaemonMode()) { + self::IPCSetJobState(false); } } @@ -1272,7 +1230,7 @@ class Worker * or: Worker::add(PRIORITY_HIGH, "Notifier", Delivery::DELETION, $drop_id); * or: Worker::add(array('priority' => PRIORITY_HIGH, 'dont_fork' => true), "Delivery", $post_id); * - * @return boolean "false" if worker queue entry already existed or there had been an error + * @return int "0" if worker queue entry already existed or there had been an error, otherwise the ID of the worker task * @throws \Friendica\Network\HTTPException\InternalServerErrorException * @note $cmd and string args are surrounded with "" * @@ -1280,19 +1238,17 @@ class Worker * array $arr * */ - public static function add($cmd) + public static function add(...$args) { - $args = func_get_args(); - if (!count($args)) { - return false; + return 0; } $arr = ['args' => $args, 'run_cmd' => true]; Hook::callAll("proc_run", $arr); if (!$arr['run_cmd'] || !count($args)) { - return true; + return 1; } $priority = PRIORITY_MEDIUM; @@ -1322,12 +1278,14 @@ class Worker if (isset($run_parameter['force_priority'])) { $force_priority = $run_parameter['force_priority']; } + } else { + throw new \InvalidArgumentException('Priority number or task parameter array expected as first argument'); } $command = array_shift($args); $parameters = json_encode($args); $found = DBA::exists('workerqueue', ['command' => $command, 'parameter' => $parameters, 'done' => false]); - $added = false; + $added = 0; if (!in_array($priority, PRIORITIES)) { Logger::warning('Invalid priority', ['priority' => $priority, 'command' => $command, 'callstack' => System::callstack(20)]); @@ -1336,15 +1294,15 @@ class Worker // Quit if there was a database error - a precaution for the update process to 3.5.3 if (DBA::errorNo() != 0) { - return false; + return 0; } if (!$found) { - $added = DBA::insert('workerqueue', ['command' => $command, 'parameter' => $parameters, 'created' => $created, - 'priority' => $priority, 'next_try' => $delayed]); - if (!$added) { - return false; + if (!DBA::insert('workerqueue', ['command' => $command, 'parameter' => $parameters, 'created' => $created, + 'priority' => $priority, 'next_try' => $delayed])) { + return 0; } + $added = DBA::lastInsertId(); } elseif ($force_priority) { DBA::update('workerqueue', ['priority' => $priority], ['command' => $command, 'parameter' => $parameters, 'done' => false, 'pid' => 0]); } @@ -1423,12 +1381,12 @@ class Worker */ public static function defer() { - if (empty(DI::app()->queue)) { + $queue = DI::app()->getQueue(); + + if (empty($queue)) { return false; } - $queue = DI::app()->queue; - $retrial = $queue['retrial']; $id = $queue['id']; $priority = $queue['priority']; @@ -1469,12 +1427,27 @@ class Worker * Set the flag if some job is waiting * * @param boolean $jobs Is there a waiting job? + * @param int $key Key number * @throws \Exception */ - public static function IPCSetJobState($jobs) + public static function IPCSetJobState(bool $jobs, int $key = 0) { $stamp = (float)microtime(true); - DBA::update('worker-ipc', ['jobs' => $jobs], ['key' => 1], true); + DBA::replace('worker-ipc', ['jobs' => $jobs, 'key' => $key]); + self::$db_duration += (microtime(true) - $stamp); + self::$db_duration_write += (microtime(true) - $stamp); + } + + /** + * Delete a key entry + * + * @param int $key Key number + * @throws \Exception + */ + public static function IPCDeleteJobState(int $key) + { + $stamp = (float)microtime(true); + DBA::delete('worker-ipc', ['key' => $key]); self::$db_duration += (microtime(true) - $stamp); self::$db_duration_write += (microtime(true) - $stamp); } @@ -1482,13 +1455,14 @@ class Worker /** * Checks if some worker job waits to be executed * + * @param int $key Key number * @return bool * @throws \Exception */ - public static function IPCJobsExists() + public static function IPCJobsExists(int $key = 0) { $stamp = (float)microtime(true); - $row = DBA::selectFirst('worker-ipc', ['jobs'], ['key' => 1]); + $row = DBA::selectFirst('worker-ipc', ['jobs'], ['key' => $key]); self::$db_duration += (microtime(true) - $stamp); // When we don't have a row, no job is running @@ -1598,8 +1572,7 @@ class Worker Logger::notice('Starting new daemon process'); $command = 'bin/daemon.php'; $a = DI::app(); - $process = new Core\Process(DI::logger(), DI::mode(), DI::config(), DI::modelProcess(), $a->getBasePath(), getmypid()); - $process->run($command, ['start']); + DI::system()->run($command, ['start']); Logger::notice('New daemon process started'); } @@ -1643,7 +1616,7 @@ class Worker } else { Logger::info('We are outside the maintenance window', ['current' => date('H:i:s', $current), 'start' => date('H:i:s', $start), 'end' => date('H:i:s', $end)]); } - + return $execute; } }