<?php
/**
- * @file src/Core/Worker.php
+ * @copyright Copyright (C) 2020, Friendica
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
*/
+
namespace Friendica\Core;
use Friendica\Core;
use Friendica\DI;
use Friendica\Model\Process;
use Friendica\Util\DateTimeFormat;
-use Friendica\Util\Network;
/**
- * @file src/Core/Worker.php
- *
* Contains the class for the worker background job processing
*/
-
-/**
- * Worker methods
- */
class Worker
{
const STATE_STARTUP = 1; // Worker is in startup. This takes most time.
const FAST_COMMANDS = ['APDelivery', 'Delivery', 'CreateShadowEntry'];
+ const LOCK_PROCESS = 'worker_process';
+ const LOCK_WORKER = 'worker';
private static $up_start;
private static $db_duration = 0;
// At first check the maximum load. We shouldn't continue with a high load
if (DI::process()->isMaxLoadReached()) {
- Logger::log('Pre check: maximum load reached, quitting.', Logger::DEBUG);
+ Logger::info('Pre check: maximum load reached, quitting.');
return;
}
self::startProcess();
// Kill stale processes every 5 minutes
- $last_cleanup = Config::get('system', 'worker_last_cleaned', 0);
+ $last_cleanup = DI::config()->get('system', 'worker_last_cleaned', 0);
if (time() > ($last_cleanup + 300)) {
- Config::set('system', 'worker_last_cleaned', time());
+ DI::config()->set('system', 'worker_last_cleaned', time());
self::killStaleWorkers();
}
- // Count active workers and compare them with a maximum value that depends on the load
- if (self::tooMuchWorkers()) {
- Logger::log('Pre check: Active worker limit reached, quitting.', Logger::DEBUG);
- return;
- }
-
- // Do we have too few memory?
- if (DI::process()->isMinMemoryReached()) {
- Logger::log('Pre check: Memory limit reached, quitting.', Logger::DEBUG);
- return;
- }
-
- // Possibly there are too much database connections
- if (self::maxConnectionsReached()) {
- Logger::log('Pre check: maximum connections reached, quitting.', Logger::DEBUG);
- return;
- }
-
- // Possibly there are too much database processes that block the system
- if (DI::process()->isMaxProcessesReached()) {
- Logger::log('Pre check: maximum processes reached, quitting.', Logger::DEBUG);
+ // Check if the system is ready
+ if (!self::isReady()) {
return;
}
// The work will be done
if (!self::execute($entry)) {
- Logger::log('Process execution failed, quitting.', Logger::DEBUG);
+ Logger::info('Process execution failed, quitting.');
return;
}
// Trying to fetch new processes - but only once when successful
- if (!$refetched && DI::lock()->acquire('worker_process', 0)) {
+ if (!$refetched && DI::lock()->acquire(self::LOCK_PROCESS, 0)) {
self::findWorkerProcesses();
- DI::lock()->release('worker_process');
+ DI::lock()->release(self::LOCK_PROCESS);
self::$state = self::STATE_REFETCH;
$refetched = true;
} else {
if (!self::getWaitingJobForPID()) {
self::$state = self::STATE_LONG_LOOP;
- if (DI::lock()->acquire('worker', 0)) {
+ if (DI::lock()->acquire(self::LOCK_WORKER, 0)) {
// Count active workers and compare them with a maximum value that depends on the load
if (self::tooMuchWorkers()) {
- Logger::log('Active worker limit reached, quitting.', Logger::DEBUG);
- DI::lock()->release('worker');
+ Logger::info('Active worker limit reached, quitting.');
+ DI::lock()->release(self::LOCK_WORKER);
return;
}
// Check free memory
if (DI::process()->isMinMemoryReached()) {
- Logger::log('Memory limit reached, quitting.', Logger::DEBUG);
- DI::lock()->release('worker');
+ Logger::info('Memory limit reached, quitting.');
+ DI::lock()->release(self::LOCK_WORKER);
return;
}
- DI::lock()->release('worker');
+ DI::lock()->release(self::LOCK_WORKER);
}
}
// Quit the worker once every cron interval
- if (time() > ($starttime + (Config::get('system', 'cron_interval') * 60))) {
+ if (time() > ($starttime + (DI::config()->get('system', 'cron_interval') * 60))) {
Logger::info('Process lifetime reached, respawning.');
self::spawnWorker();
return;
}
// Cleaning up. Possibly not needed, but it doesn't harm anything.
- if (Config::get('system', 'worker_daemon_mode', false)) {
+ if (DI::config()->get('system', 'worker_daemon_mode', false)) {
self::IPCSetJobState(false);
}
- Logger::log("Couldn't select a workerqueue entry, quitting process " . getmypid() . ".", Logger::DEBUG);
+ Logger::info("Couldn't select a workerqueue entry, quitting process", ['pid' => getmypid()]);
+ }
+
+ /**
+ * Checks if the system is ready.
+ *
+ * Several system parameters like memory, connections and processes are checked.
+ *
+ * @return boolean
+ */
+ public static function isReady()
+ {
+ // Count active workers and compare them with a maximum value that depends on the load
+ if (self::tooMuchWorkers()) {
+ Logger::info('Active worker limit reached, quitting.');
+ return false;
+ }
+
+ // Do we have too few memory?
+ if (DI::process()->isMinMemoryReached()) {
+ Logger::info('Memory limit reached, quitting.');
+ return false;
+ }
+
+ // Possibly there are too much database connections
+ if (self::maxConnectionsReached()) {
+ Logger::info('Maximum connections reached, quitting.');
+ return false;
+ }
+
+ // Possibly there are too much database processes that block the system
+ if (DI::process()->isMaxProcessesReached()) {
+ Logger::info('Maximum processes reached, quitting.');
+ return false;
+ }
+
+ return true;
}
/**
* @return boolean Returns "true" if tasks are existing
* @throws \Exception
*/
- private static function entriesExists()
+ public static function entriesExists()
{
$stamp = (float)microtime(true);
$exists = DBA::exists('workerqueue', ["NOT `done` AND `pid` = 0 AND `next_try` < ?", DateTimeFormat::utcNow()]);
$mypid = getmypid();
// Quit when in maintenance
- if (Config::get('system', 'maintenance', false, true)) {
- Logger::log("Maintenance mode - quit process ".$mypid, Logger::DEBUG);
+ if (DI::config()->get('system', 'maintenance', false, true)) {
+ Logger::info("Maintenance mode - quit process", ['pid' => $mypid]);
return false;
}
// Constantly check the number of parallel database processes
if (DI::process()->isMaxProcessesReached()) {
- Logger::log("Max processes reached for process ".$mypid, Logger::DEBUG);
+ Logger::info("Max processes reached for process", ['pid' => $mypid]);
return false;
}
// Constantly check the number of available database connections to let the frontend be accessible at any time
if (self::maxConnectionsReached()) {
- Logger::log("Max connection reached for process ".$mypid, Logger::DEBUG);
+ Logger::info("Max connection reached for process", ['pid' => $mypid]);
return false;
}
$argv = json_decode($queue["parameter"], true);
+ if (empty($argv)) {
+ Logger::error('Parameter is empty', ['queue' => $queue]);
+ return false;
+ }
// Check for existance and validity of the include file
$include = $argv[0];
$stamp = (float)microtime(true);
$condition = ["`id` = ? AND `next_try` < ?", $queue['id'], DateTimeFormat::utcNow()];
if (DBA::update('workerqueue', ['done' => true], $condition)) {
- Config::set('system', 'last_worker_execution', DateTimeFormat::utcNow());
+ DI::config()->set('system', 'last_worker_execution', DateTimeFormat::utcNow());
}
self::$db_duration = (microtime(true) - $stamp);
self::$db_duration_write += (microtime(true) - $stamp);
$stamp = (float)microtime(true);
if (DBA::update('workerqueue', ['done' => true], ['id' => $queue["id"]])) {
- Config::set('system', 'last_worker_execution', DateTimeFormat::utcNow());
+ DI::config()->set('system', 'last_worker_execution', DateTimeFormat::utcNow());
}
self::$db_duration = (microtime(true) - $stamp);
self::$db_duration_write += (microtime(true) - $stamp);
{
$a = DI::app();
- $argc = count($argv);
-
Logger::enableWorker($funcname);
Logger::info("Process start.", ['priority' => $queue["priority"], 'id' => $queue["id"]]);
if ($method_call) {
call_user_func_array(sprintf('Friendica\Worker\%s::execute', $funcname), $argv);
} else {
- $funcname($argv, $argc);
+ $funcname($argv, count($argv));
}
Logger::disableWorker();
DI::profiler()->saveLog(DI::logger(), "ID " . $queue["id"] . ": " . $funcname);
- $cooldown = Config::get("system", "worker_cooldown", 0);
+ $cooldown = DI::config()->get("system", "worker_cooldown", 0);
if ($cooldown > 0) {
Logger::info('Cooldown.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'cooldown' => $cooldown]);
private static function maxConnectionsReached()
{
// Fetch the max value from the config. This is needed when the system cannot detect the correct value by itself.
- $max = Config::get("system", "max_connections");
+ $max = DI::config()->get("system", "max_connections");
// Fetch the percentage level where the worker will get active
- $maxlevel = Config::get("system", "max_connections_level", 75);
+ $maxlevel = DI::config()->get("system", "max_connections_level", 75);
if ($max == 0) {
// the maximum number of possible user connections can be a system variable
$used = DBA::numRows($r);
DBA::close($r);
- Logger::log("Connection usage (user values): ".$used."/".$max, Logger::DEBUG);
+ Logger::info("Connection usage (user values)", ['usage' => $used, 'max' => $max]);
$level = ($used / $max) * 100;
if ($used == 0) {
return false;
}
- Logger::log("Connection usage (system values): ".$used."/".$max, Logger::DEBUG);
+ Logger::info("Connection usage (system values)", ['used' => $used, 'max' => $max]);
$level = $used / $max * 100;
/**
* fix the queue entry if the worker process died
+ *
* @return void
* @throws \Exception
*/
$max_duration = $max_duration_defaults[$entry["priority"]];
$argv = json_decode($entry["parameter"], true);
+ if (empty($argv)) {
+ return;
+ }
+
$argv[0] = basename($argv[0]);
// How long is the process already running?
self::$db_duration += (microtime(true) - $stamp);
self::$db_duration_write += (microtime(true) - $stamp);
} else {
- Logger::log("Worker process ".$entry["pid"]." (".substr(json_encode($argv), 0, 50).") now runs for ".round($duration)." of ".$max_duration." allowed minutes. That's okay.", Logger::DEBUG);
+ Logger::info('Process runtime is okay', ['pid' => $entry["pid"], 'duration' => $duration, 'max' => $max_duration, 'command' => substr(json_encode($argv), 0, 50)]);
}
}
}
+ DBA::close($entries);
}
/**
*/
private static function tooMuchWorkers()
{
- $queues = Config::get("system", "worker_queues", 10);
+ $queues = DI::config()->get("system", "worker_queues", 10);
$maxqueues = $queues;
// Decrease the number of workers at higher load
$load = System::currentLoad();
if ($load) {
- $maxsysload = intval(Config::get("system", "maxloadavg", 20));
+ $maxsysload = intval(DI::config()->get("system", "maxloadavg", 20));
/* Default exponent 3 causes queues to rapidly decrease as load increases.
* If you have 20 max queues at idle, then you get only 5 queues at 37.1% of $maxsysload.
* For some environments, this rapid decrease is not needed.
* With exponent 1, you could have 20 max queues at idle and 13 at 37% of $maxsysload.
*/
- $exponent = intval(Config::get('system', 'worker_load_exponent', 3));
+ $exponent = intval(DI::config()->get('system', 'worker_load_exponent', 3));
$slope = pow(max(0, $maxsysload - $load) / $maxsysload, $exponent);
$queues = intval(ceil($slope * $maxqueues));
$processlist = '';
- if (Config::get('system', 'worker_jpm')) {
- $intervals = explode(',', Config::get('system', 'worker_jpm_range'));
+ if (DI::config()->get('system', 'worker_jpm')) {
+ $intervals = explode(',', DI::config()->get('system', 'worker_jpm_range'));
$jobs_per_minute = [];
foreach ($intervals as $interval) {
if ($interval == 0) {
$deferred = self::deferredEntries();
- if (Config::get('system', 'worker_debug')) {
+ if (DI::config()->get('system', 'worker_debug')) {
$waiting_processes = 0;
// Now adding all processes with workerqueue entries
$stamp = (float)microtime(true);
self::$db_duration_stat += (microtime(true) - $stamp);
while ($entry = DBA::fetch($jobs)) {
$stamp = (float)microtime(true);
- $processes = DBA::p("SELECT COUNT(*) AS `running` FROM `process` INNER JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid` WHERE NOT `done` AND `priority` = ?", $entry["priority"]);
+ $processes = DBA::p("SELECT COUNT(*) AS `running` FROM `workerqueue-view` WHERE `priority` = ?", $entry["priority"]);
self::$db_duration += (microtime(true) - $stamp);
self::$db_duration_stat += (microtime(true) - $stamp);
if ($process = DBA::fetch($processes)) {
} else {
$waiting_processes = self::totalEntries();
$stamp = (float)microtime(true);
- $jobs = DBA::p("SELECT COUNT(*) AS `running`, `priority` FROM `process` INNER JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid` AND NOT `done` GROUP BY `priority` ORDER BY `priority`");
+ $jobs = DBA::p("SELECT COUNT(*) AS `running`, `priority` FROM `workerqueue-view` GROUP BY `priority` ORDER BY `priority`");
self::$db_duration += (microtime(true) - $stamp);
self::$db_duration_stat += (microtime(true) - $stamp);
$processlist .= ' ('.implode(', ', $listitem).')';
- if (Config::get("system", "worker_fastlane", false) && ($queues > 0) && ($active >= $queues) && self::entriesExists()) {
+ if (DI::config()->get("system", "worker_fastlane", false) && ($queues > 0) && ($active >= $queues) && self::entriesExists()) {
$top_priority = self::highestPriority();
$high_running = self::processWithPriorityActive($top_priority);
if (!$high_running && ($top_priority > PRIORITY_UNDEFINED) && ($top_priority < PRIORITY_NEGLIGIBLE)) {
- Logger::log("There are jobs with priority ".$top_priority." waiting but none is executed. Open a fastlane.", Logger::DEBUG);
+ Logger::info("Jobs with a higher priority are waiting but none is executed. Open a fastlane.", ['priority' => $top_priority]);
$queues = $active + 1;
}
}
- Logger::log("Load: " . $load ."/" . $maxsysload . " - processes: " . $deferred . "/" . $active . "/" . $waiting_processes . $processlist . " - maximum: " . $queues . "/" . $maxqueues, Logger::DEBUG);
+ Logger::notice("Load: " . $load ."/" . $maxsysload . " - processes: " . $deferred . "/" . $active . "/" . $waiting_processes . $processlist . " - maximum: " . $queues . "/" . $maxqueues);
// Are there fewer workers running as possible? Then fork a new one.
- if (!Config::get("system", "worker_dont_fork", false) && ($queues > ($active + 1)) && self::entriesExists()) {
- Logger::log("Active workers: ".$active."/".$queues." Fork a new worker.", Logger::DEBUG);
- if (Config::get('system', 'worker_daemon_mode', false)) {
+ if (!DI::config()->get("system", "worker_dont_fork", false) && ($queues > ($active + 1)) && self::entriesExists()) {
+ Logger::info("There are fewer workers as possible, fork a new worker.", ['active' => $active, 'queues' => $queues]);
+ if (DI::config()->get('system', 'worker_daemon_mode', false)) {
self::IPCSetJobState(true);
} else {
self::spawnWorker();
}
// if there are too much worker, we don't spawn a new one.
- if (Config::get('system', 'worker_daemon_mode', false) && ($active > $queues)) {
+ if (DI::config()->get('system', 'worker_daemon_mode', false) && ($active > $queues)) {
self::IPCSetJobState(false);
}
return [];
}
- $limit = Config::get('system', 'worker_fetch_limit', 1);
+ $limit = DI::config()->get('system', 'worker_fetch_limit', 1);
$ids = [];
$stamp = (float)microtime(true);
$running = [];
$running_total = 0;
$stamp = (float)microtime(true);
- $processes = DBA::p("SELECT COUNT(DISTINCT(`process`.`pid`)) AS `running`, `priority` FROM `process`
- INNER JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid`
- WHERE NOT `done` GROUP BY `priority`");
+ $processes = DBA::p("SELECT COUNT(DISTINCT(`pid`)) AS `running`, `priority` FROM `workerqueue-view` GROUP BY `priority`");
self::$db_duration += (microtime(true) - $stamp);
while ($process = DBA::fetch($processes)) {
$running[$process['priority']] = $process['running'];
// If there is no result we check without priority limit
if (empty($ids)) {
- $limit = Config::get('system', 'worker_fetch_limit', 1);
+ $limit = DI::config()->get('system', 'worker_fetch_limit', 1);
$stamp = (float)microtime(true);
$condition = ["`pid` = 0 AND NOT `done` AND `next_try` < ?", DateTimeFormat::utcNow()];
/**
* Returns the next worker process
*
- * @return string SQL statement
+ * @return array worker processes
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
public static function workerProcess()
}
$stamp = (float)microtime(true);
- if (!DI::lock()->acquire('worker_process')) {
+ if (!DI::lock()->acquire(self::LOCK_PROCESS)) {
return false;
}
self::$lock_duration += (microtime(true) - $stamp);
$found = self::findWorkerProcesses();
- DI::lock()->release('worker_process');
+ DI::lock()->release(self::LOCK_PROCESS);
if ($found) {
$stamp = (float)microtime(true);
/**
* Removes a workerqueue entry from the current process
+ *
* @return void
* @throws \Exception
*/
/**
* Call the front end worker
+ *
* @return void
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
public static function callWorker()
{
- if (!Config::get("system", "frontend_worker")) {
+ if (!DI::config()->get("system", "frontend_worker")) {
return;
}
$url = DI::baseUrl() . '/worker';
- Network::fetchUrl($url, false, 1);
+ DI::httpRequest()->fetch($url, false, 1);
}
/**
* Call the front end worker if there aren't any active
+ *
* @return void
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
public static function executeIfIdle()
{
- if (!Config::get("system", "frontend_worker")) {
+ if (!DI::config()->get("system", "frontend_worker")) {
return;
}
if (function_exists("proc_open")) {
// When was the last time that we called the worker?
// Less than one minute? Then we quit
- if ((time() - Config::get("system", "worker_started")) < 60) {
+ if ((time() - DI::config()->get("system", "worker_started")) < 60) {
return;
}
- Config::set("system", "worker_started", time());
+ DI::config()->set("system", "worker_started", time());
// Do we have enough running workers? Then we quit here.
if (self::tooMuchWorkers()) {
self::runCron();
- Logger::log('Call worker', Logger::DEBUG);
+ Logger::info('Call worker');
self::spawnWorker();
return;
}
/**
* Removes long running worker processes
+ *
* @return void
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
public static function clearProcesses()
{
- $timeout = Config::get("system", "frontend_worker_timeout", 10);
+ $timeout = DI::config()->get("system", "frontend_worker_timeout", 10);
/// @todo We should clean up the corresponding workerqueue entries as well
$stamp = (float)microtime(true);
/**
* Runs the cron processes
+ *
* @return void
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
private static function runCron()
{
- Logger::log('Add cron entries', Logger::DEBUG);
+ Logger::info('Add cron entries');
// Check for spooled items
self::add(['priority' => PRIORITY_HIGH, 'force_priority' => true], 'SpoolPost');
/**
* Spawns a new worker
+ *
* @param bool $do_cron
* @return void
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
$process->run($command, $args);
// after spawning we have to remove the flag.
- if (Config::get('system', 'worker_daemon_mode', false)) {
+ if (DI::config()->get('system', 'worker_daemon_mode', false)) {
self::IPCSetJobState(false);
}
}
$priority = PRIORITY_MEDIUM;
// Don't fork from frontend tasks by default
- $dont_fork = Config::get("system", "worker_dont_fork", false) || !DI::mode()->isBackend();
+ $dont_fork = DI::config()->get("system", "worker_dont_fork", false) || !DI::mode()->isBackend();
$created = DateTimeFormat::utcNow();
$force_priority = false;
}
// If there is a lock then we don't have to check for too much worker
- if (!DI::lock()->acquire('worker', 0)) {
+ if (!DI::lock()->acquire(self::LOCK_WORKER, 0)) {
return $added;
}
// If there are already enough workers running, don't fork another one
$quit = self::tooMuchWorkers();
- DI::lock()->release('worker');
+ DI::lock()->release(self::LOCK_WORKER);
if ($quit) {
return $added;
}
// We tell the daemon that a new job entry exists
- if (Config::get('system', 'worker_daemon_mode', false)) {
+ if (DI::config()->get('system', 'worker_daemon_mode', false)) {
// We don't have to set the IPC flag - this is done in "tooMuchWorkers"
return $added;
}
/**
* Defers the current worker entry
+ *
* @return boolean had the entry been deferred?
*/
public static function defer()
$id = $queue['id'];
$priority = $queue['priority'];
- $max_level = Config::get('system', 'worker_defer_limit');
+ $max_level = DI::config()->get('system', 'worker_defer_limit');
$new_retrial = self::getNextRetrial($queue, $max_level);
projects / friendica.git / blobdiff