X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FCore%2FWorker.php;h=f3736d2573f7e10fbe4f934b42d434577380e7e3;hb=5a3991d4f7bc929c1087d9275716fc1c8cc299a6;hp=e949ff2da81d0c1bb1415a6d808a8f0f0e96086b;hpb=cabfcfc904ed782f09c91ed35da6b2ad65ce0f09;p=friendica.git diff --git a/src/Core/Worker.php b/src/Core/Worker.php index e949ff2da8..f3736d2573 100644 --- a/src/Core/Worker.php +++ b/src/Core/Worker.php @@ -1,14 +1,17 @@ maxload_reached()) { - logger('Pre check: maximum load reached, quitting.', LOGGER_DEBUG); + if ($a->isMaxLoadReached()) { + Logger::log('Pre check: maximum load reached, quitting.', Logger::DEBUG); return; } // We now start the process. This is done after the load check since this could increase the load. - $a->start_process(); + self::startProcess(); // Kill stale processes every 5 minutes - $last_cleanup = Config::get('system', 'poller_last_cleaned', 0); + $last_cleanup = Config::get('system', 'worker_last_cleaned', 0); if (time() > ($last_cleanup + 300)) { - Config::set('system', 'poller_last_cleaned', time()); + 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('Pre check: Active worker limit reached, quitting.', LOGGER_DEBUG); + Logger::log('Pre check: Active worker limit reached, quitting.', Logger::DEBUG); return; } // Do we have too few memory? - if ($a->min_memory_reached()) { - logger('Pre check: Memory limit reached, quitting.', LOGGER_DEBUG); + if ($a->isMinMemoryReached()) { + Logger::log('Pre check: Memory limit reached, quitting.', Logger::DEBUG); return; } // Possibly there are too much database connections if (self::maxConnectionsReached()) { - logger('Pre check: maximum connections reached, quitting.', LOGGER_DEBUG); + Logger::log('Pre check: maximum connections reached, quitting.', Logger::DEBUG); return; } // Possibly there are too much database processes that block the system - if ($a->max_processes_reached()) { - logger('Pre check: maximum processes reached, quitting.', LOGGER_DEBUG); + if ($a->isMaxProcessesReached()) { + Logger::log('Pre check: maximum processes reached, quitting.', Logger::DEBUG); return; } @@ -84,55 +90,72 @@ class Worker { // We fetch the next queue entry that is about to be executed while ($r = self::workerProcess($passing_slow)) { - // When we are processing jobs with a lower priority, we don't refetch new jobs // Otherwise fast jobs could wait behind slow ones and could be blocked. $refetched = $passing_slow; - foreach ($r AS $entry) { + foreach ($r as $entry) { // Assure that the priority is an integer value $entry['priority'] = (int)$entry['priority']; // The work will be done if (!self::execute($entry)) { - logger('Process execution failed, quitting.', LOGGER_DEBUG); + Logger::log('Process execution failed, quitting.', Logger::DEBUG); return; } // If possible we will fetch new jobs for this worker - if (!$refetched && Lock::set('poller_worker_process', 0)) { + if (!$refetched && Lock::acquire('worker_process', 0)) { $stamp = (float)microtime(true); $refetched = self::findWorkerProcesses($passing_slow); self::$db_duration += (microtime(true) - $stamp); - Lock::remove('poller_worker_process'); + Lock::release('worker_process'); } } - // To avoid the quitting of multiple pollers only one poller at a time will execute the check - if (Lock::set('poller_worker', 0)) { + // To avoid the quitting of multiple workers only one worker at a time will execute the check + if (Lock::acquire('worker', 0)) { $stamp = (float)microtime(true); // Count active workers and compare them with a maximum value that depends on the load if (self::tooMuchWorkers()) { - logger('Active worker limit reached, quitting.', LOGGER_DEBUG); + Logger::log('Active worker limit reached, quitting.', Logger::DEBUG); + Lock::release('worker'); return; } // Check free memory - if ($a->min_memory_reached()) { - logger('Memory limit reached, quitting.', LOGGER_DEBUG); + if ($a->isMinMemoryReached()) { + Logger::log('Memory limit reached, quitting.', Logger::DEBUG); + Lock::release('worker'); return; } - Lock::remove('poller_worker'); + Lock::release('worker'); self::$db_duration += (microtime(true) - $stamp); } - // Quit the poller once every 5 minutes + // Quit the worker once every 5 minutes if (time() > ($starttime + 300)) { - logger('Process lifetime reached, quitting.', LOGGER_DEBUG); + Logger::log('Process lifetime reached, quitting.', Logger::DEBUG); return; } } - logger("Couldn't select a workerqueue entry, quitting.", LOGGER_DEBUG); + + // Cleaning up. Possibly not needed, but it doesn't harm anything. + if (Config::get('system', 'worker_daemon_mode', false)) { + self::IPCSetJobState(false); + } + Logger::log("Couldn't select a workerqueue entry, quitting process " . getmypid() . ".", Logger::DEBUG); + } + + /** + * @brief Returns the number of deferred entries in the worker queue + * + * @return integer Number of deferred entries in the worker queue + */ + private static function deferredEntries() + { + return DBA::count('workerqueue', ["`executed` <= ? AND NOT `done` AND `next_try` > ?", + DBA::NULL_DATETIME, DateTimeFormat::utcNow()]); } /** @@ -140,25 +163,23 @@ class Worker { * * @return integer Number of non executed entries in the worker queue */ - private static function totalEntries() { - $s = dba::fetch_first("SELECT COUNT(*) AS `total` FROM `workerqueue` WHERE `executed` <= ? AND NOT `done`", NULL_DATE); - if (DBM::is_result($s)) { - return $s["total"]; - } else { - return 0; - } + private static function totalEntries() + { + return DBA::count('workerqueue', ["`executed` <= ? AND NOT `done` AND `next_try` < ?", + DBA::NULL_DATETIME, DateTimeFormat::utcNow()]); } /** * @brief Returns the highest priority in the worker queue that isn't executed * - * @return integer Number of active poller processes + * @return integer Number of active worker processes */ - private static function highestPriority() { - $condition = array("`executed` <= ? AND NOT `done`", NULL_DATE); - $s = dba::select('workerqueue', array('priority'), $condition, array('limit' => 1, 'order' => array('priority'))); - if (DBM::is_result($s)) { - return $s["priority"]; + private static function highestPriority() + { + $condition = ["`executed` <= ? AND NOT `done` AND `next_try` < ?", DBA::NULL_DATETIME, DateTimeFormat::utcNow()]; + $workerqueue = DBA::selectFirst('workerqueue', ['priority'], $condition, ['order' => ['priority']]); + if (DBA::isResult($workerqueue)) { + return $workerqueue["priority"]; } else { return 0; } @@ -171,9 +192,11 @@ class Worker { * * @return integer Is there a process running with that priority? */ - private static function processWithPriorityActive($priority) { - $condition = array("`priority` <= ? AND `executed` > ? AND NOT `done`", $priority, NULL_DATE); - return dba::exists('workerqueue', $condition); + private static function processWithPriorityActive($priority) + { + $condition = ["`priority` <= ? AND `executed` > ? AND NOT `done` AND `next_try` < ?", + $priority, DBA::NULL_DATETIME, DateTimeFormat::utcNow()]; + return DBA::exists('workerqueue', $condition); } /** @@ -183,30 +206,31 @@ class Worker { * * @return boolean "true" if further processing should be stopped */ - public static function execute($queue) { + public static function execute($queue) + { $a = get_app(); $mypid = getmypid(); // Quit when in maintenance - if (Config::get('system', 'maintenance', true)) { - logger("Maintenance mode - quit process ".$mypid, LOGGER_DEBUG); + if (Config::get('system', 'maintenance', false, true)) { + Logger::log("Maintenance mode - quit process ".$mypid, Logger::DEBUG); return false; } // Constantly check the number of parallel database processes - if ($a->max_processes_reached()) { - logger("Max processes reached for process ".$mypid, LOGGER_DEBUG); + if ($a->isMaxProcessesReached()) { + Logger::log("Max processes reached for process ".$mypid, Logger::DEBUG); return false; } // Constantly check the number of available database connections to let the frontend be accessible at any time if (self::maxConnectionsReached()) { - logger("Max connection reached for process ".$mypid, LOGGER_DEBUG); + Logger::log("Max connection reached for process ".$mypid, Logger::DEBUG); return false; } - $argv = json_decode($queue["parameter"]); + $argv = json_decode($queue["parameter"], true); // Check for existance and validity of the include file $include = $argv[0]; @@ -222,7 +246,7 @@ class Worker { if ($age > 1) { $stamp = (float)microtime(true); - dba::update('workerqueue', array('executed' => datetime_convert()), array('pid' => $mypid, 'done' => false)); + DBA::update('workerqueue', ['executed' => DateTimeFormat::utcNow()], ['pid' => $mypid, 'done' => false]); self::$db_duration += (microtime(true) - $stamp); } @@ -231,8 +255,10 @@ class Worker { self::execFunction($queue, $include, $argv, true); $stamp = (float)microtime(true); - if (dba::update('workerqueue', array('done' => true), array('id' => $queue["id"]))) { - Config::set('system', 'last_poller_execution', datetime_convert()); + + $condition = ["`id` = ? AND `next_try` < ?", $queue['id'], DateTimeFormat::utcNow()]; + if (DBA::update('workerqueue', ['done' => true], $condition)) { + Config::set('system', 'last_worker_execution', DateTimeFormat::utcNow()); } self::$db_duration = (microtime(true) - $stamp); @@ -245,17 +271,16 @@ class Worker { } if (!validate_include($include)) { - logger("Include file ".$argv[0]." is not valid!"); - dba::delete('workerqueue', array('id' => $queue["id"])); + Logger::log("Include file ".$argv[0]." is not valid!"); + DBA::delete('workerqueue', ['id' => $queue["id"]]); return true; } - require_once($include); + require_once $include; $funcname = str_replace(".php", "", basename($argv[0]))."_run"; if (function_exists($funcname)) { - // We constantly update the "executed" date every minute to avoid being killed too soon if (!isset(self::$last_update)) { self::$last_update = strtotime($queue["executed"]); @@ -266,20 +291,20 @@ class Worker { if ($age > 1) { $stamp = (float)microtime(true); - dba::update('workerqueue', array('executed' => datetime_convert()), array('pid' => $mypid, 'done' => false)); + DBA::update('workerqueue', ['executed' => DateTimeFormat::utcNow()], ['pid' => $mypid, 'done' => false]); self::$db_duration += (microtime(true) - $stamp); } self::execFunction($queue, $funcname, $argv, false); $stamp = (float)microtime(true); - if (dba::update('workerqueue', array('done' => true), array('id' => $queue["id"]))) { - Config::set('system', 'last_poller_execution', datetime_convert()); + if (DBA::update('workerqueue', ['done' => true], ['id' => $queue["id"]])) { + Config::set('system', 'last_worker_execution', DateTimeFormat::utcNow()); } self::$db_duration = (microtime(true) - $stamp); } else { - logger("Function ".$funcname." does not exist"); - dba::delete('workerqueue', array('id' => $queue["id"])); + Logger::log("Function ".$funcname." does not exist"); + DBA::delete('workerqueue', ['id' => $queue["id"]]); } return true; @@ -288,20 +313,23 @@ class Worker { /** * @brief Execute a function from the queue * - * @param array $queue Workerqueue entry - * @param string $funcname name of the function - * @param array $argv Array of values to be passed to the function + * @param array $queue Workerqueue entry + * @param string $funcname name of the function + * @param array $argv Array of values to be passed to the function + * @param boolean $method_call boolean + * @return void */ - private static function execFunction($queue, $funcname, $argv, $method_call) { + private static function execFunction($queue, $funcname, $argv, $method_call) + { $a = get_app(); $mypid = getmypid(); $argc = count($argv); - $new_process_id = uniqid("wrk", true); + $new_process_id = System::processID("wrk"); - logger("Process ".$mypid." - Prio ".$queue["priority"]." - ID ".$queue["id"].": ".$funcname." ".$queue["parameter"]." - Process PID: ".$new_process_id); + Logger::log("Process ".$mypid." - Prio ".$queue["priority"]." - ID ".$queue["id"].": ".$funcname." ".$queue["parameter"]." - Process PID: ".$new_process_id); $stamp = (float)microtime(true); @@ -311,13 +339,15 @@ class Worker { $a->performance["start"] = microtime(true); $a->performance["database"] = 0; $a->performance["database_write"] = 0; + $a->performance["cache"] = 0; + $a->performance["cache_write"] = 0; $a->performance["network"] = 0; $a->performance["file"] = 0; $a->performance["rendering"] = 0; $a->performance["parser"] = 0; $a->performance["marktime"] = 0; $a->performance["markstart"] = microtime(true); - $a->callstack = array(); + $a->callstack = []; } // For better logging create a new process id for every worker call @@ -340,7 +370,7 @@ class Worker { $a->process_id = $old_process_id; unset($a->queue); - $duration = number_format(microtime(true) - $stamp, 3); + $duration = (microtime(true) - $stamp); self::$up_start = microtime(true); @@ -349,32 +379,37 @@ class Worker { * The execution time is the productive time. * By changing parameters like the maximum number of workers we can check the effectivness. */ - logger('DB: '.number_format(self::$db_duration, 2). + Logger::log( + 'DB: '.number_format(self::$db_duration, 2). ' - Lock: '.number_format(self::$lock_duration, 2). ' - Rest: '.number_format($up_duration - self::$db_duration - self::$lock_duration, 2). - ' - Execution: '.number_format($duration, 2), LOGGER_DEBUG); + ' - Execution: '.number_format($duration, 2), + Logger::DEBUG + ); + self::$lock_duration = 0; if ($duration > 3600) { - logger("Prio ".$queue["priority"].": ".$queue["parameter"]." - longer than 1 hour (".round($duration/60, 3).")", LOGGER_DEBUG); + Logger::log("Prio ".$queue["priority"].": ".$queue["parameter"]." - longer than 1 hour (".round($duration/60, 3).")", Logger::DEBUG); } elseif ($duration > 600) { - logger("Prio ".$queue["priority"].": ".$queue["parameter"]." - longer than 10 minutes (".round($duration/60, 3).")", LOGGER_DEBUG); + Logger::log("Prio ".$queue["priority"].": ".$queue["parameter"]." - longer than 10 minutes (".round($duration/60, 3).")", Logger::DEBUG); } elseif ($duration > 300) { - logger("Prio ".$queue["priority"].": ".$queue["parameter"]." - longer than 5 minutes (".round($duration/60, 3).")", LOGGER_DEBUG); + Logger::log("Prio ".$queue["priority"].": ".$queue["parameter"]." - longer than 5 minutes (".round($duration/60, 3).")", Logger::DEBUG); } elseif ($duration > 120) { - logger("Prio ".$queue["priority"].": ".$queue["parameter"]." - longer than 2 minutes (".round($duration/60, 3).")", LOGGER_DEBUG); + Logger::log("Prio ".$queue["priority"].": ".$queue["parameter"]." - longer than 2 minutes (".round($duration/60, 3).")", Logger::DEBUG); } - logger("Process ".$mypid." - Prio ".$queue["priority"]." - ID ".$queue["id"].": ".$funcname." - done in ".$duration." seconds. Process PID: ".$new_process_id); + Logger::log("Process ".$mypid." - Prio ".$queue["priority"]." - ID ".$queue["id"].": ".$funcname." - done in ".$duration." seconds. Process PID: ".$new_process_id); // Write down the performance values into the log if (Config::get("system", "profiler")) { $duration = microtime(true)-$a->performance["start"]; + $o = ''; if (Config::get("rendertime", "callstack")) { if (isset($a->callstack["database"])) { - $o = "\nDatabase Read:\n"; - foreach ($a->callstack["database"] AS $func => $time) { + $o .= "\nDatabase Read:\n"; + foreach ($a->callstack["database"] as $func => $time) { $time = round($time, 3); if ($time > 0) { $o .= $func.": ".$time."\n"; @@ -383,7 +418,25 @@ class Worker { } if (isset($a->callstack["database_write"])) { $o .= "\nDatabase Write:\n"; - foreach ($a->callstack["database_write"] AS $func => $time) { + foreach ($a->callstack["database_write"] as $func => $time) { + $time = round($time, 3); + if ($time > 0) { + $o .= $func.": ".$time."\n"; + } + } + } + if (isset($a->callstack["dache"])) { + $o .= "\nCache Read:\n"; + foreach ($a->callstack["dache"] as $func => $time) { + $time = round($time, 3); + if ($time > 0) { + $o .= $func.": ".$time."\n"; + } + } + } + if (isset($a->callstack["dache_write"])) { + $o .= "\nCache Write:\n"; + foreach ($a->callstack["dache_write"] as $func => $time) { $time = round($time, 3); if ($time > 0) { $o .= $func.": ".$time."\n"; @@ -392,31 +445,37 @@ class Worker { } if (isset($a->callstack["network"])) { $o .= "\nNetwork:\n"; - foreach ($a->callstack["network"] AS $func => $time) { + foreach ($a->callstack["network"] as $func => $time) { $time = round($time, 3); if ($time > 0) { $o .= $func.": ".$time."\n"; } } } - } else { - $o = ''; } - logger("ID ".$queue["id"].": ".$funcname.": ".sprintf("DB: %s/%s, Net: %s, I/O: %s, Other: %s, Total: %s".$o, - number_format($a->performance["database"] - $a->performance["database_write"], 2), - number_format($a->performance["database_write"], 2), - number_format($a->performance["network"], 2), - number_format($a->performance["file"], 2), - number_format($duration - ($a->performance["database"] + $a->performance["network"] + $a->performance["file"]), 2), - number_format($duration, 2)), - LOGGER_DEBUG); + Logger::log( + "ID ".$queue["id"].": ".$funcname.": ".sprintf( + "DB: %s/%s, Cache: %s/%s, Net: %s, I/O: %s, Other: %s, Total: %s".$o, + number_format($a->performance["database"] - $a->performance["database_write"], 2), + number_format($a->performance["database_write"], 2), + number_format($a->performance["cache"], 2), + number_format($a->performance["cache_write"], 2), + number_format($a->performance["network"], 2), + number_format($a->performance["file"], 2), + number_format($duration - ($a->performance["database"] + + $a->performance["cache"] + $a->performance["cache_write"] + + $a->performance["network"] + $a->performance["file"]), 2), + number_format($duration, 2) + ), + Logger::DEBUG + ); } $cooldown = Config::get("system", "worker_cooldown", 0); if ($cooldown > 0) { - logger("Process ".$mypid." - Prio ".$queue["priority"]." - ID ".$queue["id"].": ".$funcname." - in cooldown for ".$cooldown." seconds"); + Logger::log("Process ".$mypid." - Prio ".$queue["priority"]." - ID ".$queue["id"].": ".$funcname." - in cooldown for ".$cooldown." seconds"); sleep($cooldown); } } @@ -426,23 +485,23 @@ class Worker { * * @return bool Are more than 3/4 of the maximum connections used? */ - private static function maxConnectionsReached() { - + 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"); - // Fetch the percentage level where the poller will get active + // Fetch the percentage level where the worker will get active $maxlevel = Config::get("system", "max_connections_level", 75); if ($max == 0) { // the maximum number of possible user connections can be a system variable - $r = dba::fetch_first("SHOW VARIABLES WHERE `variable_name` = 'max_user_connections'"); - if (DBM::is_result($r)) { + $r = DBA::fetchFirst("SHOW VARIABLES WHERE `variable_name` = 'max_user_connections'"); + if (DBA::isResult($r)) { $max = $r["Value"]; } // Or it can be granted. This overrides the system variable - $r = dba::p('SHOW GRANTS'); - while ($grants = dba::fetch($r)) { + $r = DBA::p('SHOW GRANTS'); + while ($grants = DBA::fetch($r)) { $grant = array_pop($grants); if (stristr($grant, "GRANT USAGE ON")) { if (preg_match("/WITH MAX_USER_CONNECTIONS (\d*)/", $grant, $match)) { @@ -450,90 +509,99 @@ class Worker { } } } - dba::close($r); + DBA::close($r); } // If $max is set we will use the processlist to determine the current number of connections // The processlist only shows entries of the current user if ($max != 0) { - $r = dba::p('SHOW PROCESSLIST'); - $used = dba::num_rows($r); - dba::close($r); + $r = DBA::p('SHOW PROCESSLIST'); + $used = DBA::numRows($r); + DBA::close($r); - logger("Connection usage (user values): ".$used."/".$max, LOGGER_DEBUG); + Logger::log("Connection usage (user values): ".$used."/".$max, Logger::DEBUG); $level = ($used / $max) * 100; if ($level >= $maxlevel) { - logger("Maximum level (".$maxlevel."%) of user connections reached: ".$used."/".$max); + Logger::log("Maximum level (".$maxlevel."%) of user connections reached: ".$used."/".$max); return true; } } // We will now check for the system values. // This limit could be reached although the user limits are fine. - $r = dba::fetch_first("SHOW VARIABLES WHERE `variable_name` = 'max_connections'"); - if (!DBM::is_result($r)) { + $r = DBA::fetchFirst("SHOW VARIABLES WHERE `variable_name` = 'max_connections'"); + if (!DBA::isResult($r)) { return false; } $max = intval($r["Value"]); if ($max == 0) { return false; } - $r = dba::fetch_first("SHOW STATUS WHERE `variable_name` = 'Threads_connected'"); - if (!DBM::is_result($r)) { + $r = DBA::fetchFirst("SHOW STATUS WHERE `variable_name` = 'Threads_connected'"); + if (!DBA::isResult($r)) { return false; } $used = intval($r["Value"]); if ($used == 0) { return false; } - logger("Connection usage (system values): ".$used."/".$max, LOGGER_DEBUG); + Logger::log("Connection usage (system values): ".$used."/".$max, Logger::DEBUG); $level = $used / $max * 100; if ($level < $maxlevel) { return false; } - logger("Maximum level (".$level."%) of system connections reached: ".$used."/".$max); + Logger::log("Maximum level (".$level."%) of system connections reached: ".$used."/".$max); return true; } /** * @brief fix the queue entry if the worker process died - * + * @return void */ - private static function killStaleWorkers() { - $entries = dba::select('workerqueue', array('id', 'pid', 'executed', 'priority', 'parameter'), - array('`executed` > ? AND NOT `done` AND `pid` != 0', NULL_DATE), - array('order' => array('priority', 'created'))); - while ($entry = dba::fetch($entries)) { + private static function killStaleWorkers() + { + $entries = DBA::select( + 'workerqueue', + ['id', 'pid', 'executed', 'priority', 'parameter'], + ['`executed` > ? AND NOT `done` AND `pid` != 0', DBA::NULL_DATETIME], + ['order' => ['priority', 'created']] + ); + + while ($entry = DBA::fetch($entries)) { if (!posix_kill($entry["pid"], 0)) { - dba::update('workerqueue', array('executed' => NULL_DATE, 'pid' => 0), - array('id' => $entry["id"])); + DBA::update( + 'workerqueue', + ['executed' => DBA::NULL_DATETIME, 'pid' => 0], + ['id' => $entry["id"]] + ); } else { // Kill long running processes // Check if the priority is in a valid range - if (!in_array($entry["priority"], array(PRIORITY_CRITICAL, PRIORITY_HIGH, PRIORITY_MEDIUM, PRIORITY_LOW, PRIORITY_NEGLIGIBLE))) { + if (!in_array($entry["priority"], [PRIORITY_CRITICAL, PRIORITY_HIGH, PRIORITY_MEDIUM, PRIORITY_LOW, PRIORITY_NEGLIGIBLE])) { $entry["priority"] = PRIORITY_MEDIUM; } // Define the maximum durations - $max_duration_defaults = array(PRIORITY_CRITICAL => 720, PRIORITY_HIGH => 10, PRIORITY_MEDIUM => 60, PRIORITY_LOW => 180, PRIORITY_NEGLIGIBLE => 720); + $max_duration_defaults = [PRIORITY_CRITICAL => 720, PRIORITY_HIGH => 10, PRIORITY_MEDIUM => 60, PRIORITY_LOW => 180, PRIORITY_NEGLIGIBLE => 720]; $max_duration = $max_duration_defaults[$entry["priority"]]; - $argv = json_decode($entry["parameter"]); + $argv = json_decode($entry["parameter"], true); $argv[0] = basename($argv[0]); // How long is the process already running? $duration = (time() - strtotime($entry["executed"])) / 60; if ($duration > $max_duration) { - logger("Worker process ".$entry["pid"]." (".implode(" ", $argv).") took more than ".$max_duration." minutes. It will be killed now."); + Logger::log("Worker process ".$entry["pid"]." (".substr(json_encode($argv), 0, 50).") took more than ".$max_duration." minutes. It will be killed now."); posix_kill($entry["pid"], SIGTERM); // We killed the stale process. // To avoid a blocking situation we reschedule the process at the beginning of the queue. // Additionally we are lowering the priority. (But not PRIORITY_CRITICAL) + $new_priority = $entry["priority"]; if ($entry["priority"] == PRIORITY_HIGH) { $new_priority = PRIORITY_MEDIUM; } elseif ($entry["priority"] == PRIORITY_MEDIUM) { @@ -541,11 +609,13 @@ class Worker { } elseif ($entry["priority"] != PRIORITY_CRITICAL) { $new_priority = PRIORITY_NEGLIGIBLE; } - dba::update('workerqueue', - array('executed' => NULL_DATE, 'created' => datetime_convert(), 'priority' => $new_priority, 'pid' => 0), - array('id' => $entry["id"])); + DBA::update( + 'workerqueue', + ['executed' => DBA::NULL_DATETIME, 'created' => DateTimeFormat::utcNow(), 'priority' => $new_priority, 'pid' => 0], + ['id' => $entry["id"]] + ); } else { - logger("Worker process ".$entry["pid"]." (".implode(" ", $argv).") now runs for ".round($duration)." of ".$max_duration." allowed minutes. That's okay.", LOGGER_DEBUG); + 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); } } } @@ -556,7 +626,8 @@ class Worker { * * @return bool Are there too much workers running? */ - public static function tooMuchWorkers() { + public static function tooMuchWorkers() + { $queues = Config::get("system", "worker_queues", 4); $maxqueues = $queues; @@ -564,86 +635,104 @@ class Worker { $active = self::activeWorkers(); // Decrease the number of workers at higher load - $load = current_load(); + $load = System::currentLoad(); if ($load) { $maxsysload = intval(Config::get("system", "maxloadavg", 50)); - $maxworkers = $queues; + /* 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)); + $slope = pow(max(0, $maxsysload - $load) / $maxsysload, $exponent); + $queues = intval(ceil($slope * $maxqueues)); - // Some magical mathemathics to reduce the workers - $exponent = 3; - $slope = $maxworkers / pow($maxsysload, $exponent); - $queues = ceil($slope * pow(max(0, $maxsysload - $load), $exponent)); + $processlist = ''; if (Config::get('system', 'worker_debug')) { // Create a list of queue entries grouped by their priority - $listitem = array(); + $listitem = []; // Adding all processes with no workerqueue entry - $processes = dba::p("SELECT COUNT(*) AS `running` FROM `process` WHERE NOT EXISTS + $processes = DBA::p( + "SELECT COUNT(*) AS `running` FROM `process` WHERE NOT EXISTS (SELECT id FROM `workerqueue` - WHERE `workerqueue`.`pid` = `process`.`pid` AND NOT `done` AND `pid` != ?)", getmypid()); - if ($process = dba::fetch($processes)) { + WHERE `workerqueue`.`pid` = `process`.`pid` AND NOT `done` AND `pid` != ?)", + getmypid() + ); + + if ($process = DBA::fetch($processes)) { $listitem[0] = "0:".$process["running"]; } - dba::close($processes); + DBA::close($processes); // Now adding all processes with workerqueue entries - $entries = dba::p("SELECT COUNT(*) AS `entries`, `priority` FROM `workerqueue` WHERE NOT `done` GROUP BY `priority`"); - while ($entry = dba::fetch($entries)) { - $processes = dba::p("SELECT COUNT(*) AS `running` FROM `process` INNER JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid` AND NOT `done` WHERE `priority` = ?", $entry["priority"]); - if ($process = dba::fetch($processes)) { + $entries = DBA::p("SELECT COUNT(*) AS `entries`, `priority` FROM `workerqueue` WHERE NOT `done` AND `next_try` < ? GROUP BY `priority`", DateTimeFormat::utcNow()); + while ($entry = DBA::fetch($entries)) { + $processes = DBA::p("SELECT COUNT(*) AS `running` FROM `process` INNER JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid` WHERE NOT `done` AND `next_try` < ? AND `priority` = ?", + DateTimeFormat::utcNow(), $entry["priority"]); + if ($process = DBA::fetch($processes)) { $listitem[$entry["priority"]] = $entry["priority"].":".$process["running"]."/".$entry["entries"]; } - dba::close($processes); + DBA::close($processes); } - dba::close($entries); + DBA::close($entries); - $intervals = array(1, 10, 60); - $jobs_per_minute = array(); - foreach ($intervals AS $interval) { - $jobs = dba::p("SELECT COUNT(*) AS `jobs` FROM `workerqueue` WHERE `done` AND `executed` > UTC_TIMESTAMP() - INTERVAL ".intval($interval)." MINUTE"); - if ($job = dba::fetch($jobs)) { + $intervals = [1, 10, 60]; + $jobs_per_minute = []; + foreach ($intervals as $interval) { + $jobs = DBA::p("SELECT COUNT(*) AS `jobs` FROM `workerqueue` WHERE `done` AND `executed` > UTC_TIMESTAMP() - INTERVAL ".intval($interval)." MINUTE"); + if ($job = DBA::fetch($jobs)) { $jobs_per_minute[$interval] = number_format($job['jobs'] / $interval, 0); } - dba::close($jobs); + DBA::close($jobs); } $processlist = ' - jpm: '.implode('/', $jobs_per_minute).' ('.implode(', ', $listitem).')'; } $entries = self::totalEntries(); + $deferred = self::deferredEntries(); if (Config::get("system", "worker_fastlane", false) && ($queues > 0) && ($entries > 0) && ($active >= $queues)) { $top_priority = self::highestPriority(); $high_running = self::processWithPriorityActive($top_priority); if (!$high_running && ($top_priority > PRIORITY_UNDEFINED) && ($top_priority < PRIORITY_NEGLIGIBLE)) { - logger("There are jobs with priority ".$top_priority." waiting but none is executed. Open a fastlane.", LOGGER_DEBUG); + Logger::log("There are jobs with priority ".$top_priority." waiting but none is executed. Open a fastlane.", Logger::DEBUG); $queues = $active + 1; } } - logger("Load: ".$load."/".$maxsysload." - processes: ".$active."/".$entries.$processlist." - maximum: ".$queues."/".$maxqueues, LOGGER_DEBUG); + Logger::log("Load: " . $load ."/" . $maxsysload . " - processes: " . $deferred . "/" . $active . "/" . $entries . $processlist . " - maximum: " . $queues . "/" . $maxqueues, Logger::DEBUG); // Are there fewer workers running as possible? Then fork a new one. - if (!Config::get("system", "worker_dont_fork") && ($queues > ($active + 1)) && ($entries > 1)) { - logger("Active workers: ".$active."/".$queues." Fork a new worker.", LOGGER_DEBUG); - self::spawnWorker(); + if (!Config::get("system", "worker_dont_fork", false) && ($queues > ($active + 1)) && ($entries > 1)) { + Logger::log("Active workers: ".$active."/".$queues." Fork a new worker.", Logger::DEBUG); + if (Config::get('system', 'worker_daemon_mode', false)) { + self::IPCSetJobState(true); + } else { + self::spawnWorker(); + } } } - return $active >= $queues; + // if there are too much worker, we don't spawn a new one. + if (Config::get('system', 'worker_daemon_mode', false) && ($active > $queues)) { + self::IPCSetJobState(false); + } + + return $active > $queues; } /** - * @brief Returns the number of active poller processes + * @brief Returns the number of active worker processes * - * @return integer Number of active poller processes + * @return integer Number of active worker processes */ - private static function activeWorkers() { - $workers = dba::fetch_first("SELECT COUNT(*) AS `processes` FROM `process` WHERE `command` = 'Worker.php'"); - - return $workers["processes"]; + private static function activeWorkers() + { + return DBA::count('process', ['command' => 'Worker.php']); } /** @@ -655,22 +744,25 @@ class Worker { * @param string $highest_priority Returns the currently highest priority * @return bool We let pass a slower process than $highest_priority */ - private static function passingSlow(&$highest_priority) { + private static function passingSlow(&$highest_priority) + { $highest_priority = 0; - $r = dba::p("SELECT `priority` + $r = DBA::p( + "SELECT `priority` FROM `process` - INNER JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid` AND NOT `done`"); + INNER JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid` AND NOT `done`" + ); // No active processes at all? Fine - if (!DBM::is_result($r)) { + if (!DBA::isResult($r)) { return false; } - $priorities = array(); - while ($line = dba::fetch($r)) { + $priorities = []; + while ($line = DBA::fetch($r)) { $priorities[] = $line["priority"]; } - dba::close($r); + DBA::close($r); // Should not happen if (count($priorities) == 0) { @@ -684,16 +776,16 @@ class Worker { return false; } $high = 0; - foreach ($priorities AS $priority) { + foreach ($priorities as $priority) { if ($priority == $highest_priority) { ++$high; } } - logger("Highest priority: ".$highest_priority." Total processes: ".count($priorities)." Count high priority processes: ".$high, LOGGER_DEBUG); + Logger::log("Highest priority: ".$highest_priority." Total processes: ".count($priorities)." Count high priority processes: ".$high, Logger::DEBUG); $passing_slow = (($high/count($priorities)) > (2/3)); if ($passing_slow) { - logger("Passing slower processes than priority ".$highest_priority, LOGGER_DEBUG); + Logger::log("Passing slower processes than priority ".$highest_priority, Logger::DEBUG); } return $passing_slow; } @@ -704,7 +796,8 @@ class Worker { * @param boolean $passing_slow Returns if we had passed low priority processes * @return boolean Have we found something? */ - private static function findWorkerProcesses(&$passing_slow) { + private static function findWorkerProcesses(&$passing_slow) + { $mypid = getmypid(); // Check if we should pass some low priority process @@ -718,35 +811,46 @@ class Worker { $queue_length = Config::get('system', 'worker_fetch_limit', 1); $lower_job_limit = $worker_queues * $queue_length * 2; $jobs = self::totalEntries(); + $deferred = self::deferredEntries(); // Now do some magic $exponent = 2; $slope = $queue_length / pow($lower_job_limit, $exponent); $limit = min($queue_length, ceil($slope * pow($jobs, $exponent))); - logger('Total: '.$jobs.' - Maximum: '.$queue_length.' - jobs per queue: '.$limit, LOGGER_DEBUG); - + Logger::log('Deferred: ' . $deferred . ' - Total: ' . $jobs . ' - Maximum: ' . $queue_length . ' - jobs per queue: ' . $limit, Logger::DEBUG); + $ids = []; if (self::passingSlow($highest_priority)) { // Are there waiting processes with a higher priority than the currently highest? - $result = dba::select('workerqueue', array('id'), array("`executed` <= ? AND `priority` < ? AND NOT `done`", NULL_DATE, $highest_priority), - array('limit' => $limit, 'order' => array('priority', 'created'), 'only_query' => true)); - - while ($id = dba::fetch($result)) { + $result = DBA::select( + 'workerqueue', + ['id'], + ["`executed` <= ? AND `priority` < ? AND NOT `done` AND `next_try` < ?", + DBA::NULL_DATETIME, $highest_priority, DateTimeFormat::utcNow()], + ['limit' => $limit, 'order' => ['priority', 'created']] + ); + + while ($id = DBA::fetch($result)) { $ids[] = $id["id"]; } - dba::close($result); + DBA::close($result); $found = (count($ids) > 0); if (!$found) { // Give slower processes some processing time - $result = dba::select('workerqueue', array('id'), array("`executed` <= ? AND `priority` > ? AND NOT `done`", NULL_DATE, $highest_priority), - array('limit' => $limit, 'order' => array('priority', 'created'), 'only_query' => true)); - - while ($id = dba::fetch($result)) { + $result = DBA::select( + 'workerqueue', + ['id'], + ["`executed` <= ? AND `priority` > ? AND NOT `done` AND `next_try` < ?", + DBA::NULL_DATETIME, $highest_priority, DateTimeFormat::utcNow()], + ['limit' => $limit, 'order' => ['priority', 'created']] + ); + + while ($id = DBA::fetch($result)) { $ids[] = $id["id"]; } - dba::close($result); + DBA::close($result); $found = (count($ids) > 0); $passing_slow = $found; @@ -755,13 +859,18 @@ class Worker { // If there is no result (or we shouldn't pass lower processes) we check without priority limit if (!$found) { - $result = dba::select('workerqueue', array('id'), array("`executed` <= ? AND NOT `done`", NULL_DATE), - array('limit' => $limit, 'order' => array('priority', 'created'), 'only_query' => true)); - - while ($id = dba::fetch($result)) { + $result = DBA::select( + 'workerqueue', + ['id'], + ["`executed` <= ? AND NOT `done` AND `next_try` < ?", + DBA::NULL_DATETIME, DateTimeFormat::utcNow()], + ['limit' => $limit, 'order' => ['priority', 'created']] + ); + + while ($id = DBA::fetch($result)) { $ids[] = $id["id"]; } - dba::close($result); + DBA::close($result); $found = (count($ids) > 0); } @@ -769,7 +878,7 @@ class Worker { if ($found) { $condition = "`id` IN (".substr(str_repeat("?, ", count($ids)), 0, -2).") AND `pid` = 0 AND NOT `done`"; array_unshift($ids, $condition); - dba::update('workerqueue', array('executed' => datetime_convert(), 'pid' => $mypid), $ids); + DBA::update('workerqueue', ['executed' => DateTimeFormat::utcNow(), 'pid' => $mypid], $ids); } return $found; @@ -781,19 +890,20 @@ class Worker { * @param boolean $passing_slow Returns if we had passed low priority processes * @return string SQL statement */ - public static function workerProcess(&$passing_slow) { + public static function workerProcess(&$passing_slow) + { $stamp = (float)microtime(true); // There can already be jobs for us in the queue. - $r = dba::select('workerqueue', array(), array('pid' => getmypid(), 'done' => false)); - if (DBM::is_result($r)) { + $r = DBA::select('workerqueue', [], ['pid' => getmypid(), 'done' => false]); + if (DBA::isResult($r)) { self::$db_duration += (microtime(true) - $stamp); - return dba::inArray($r); + return DBA::toArray($r); } - dba::close($r); + DBA::close($r); $stamp = (float)microtime(true); - if (!Lock::set('poller_worker_process')) { + if (!Lock::acquire('worker_process')) { return false; } self::$lock_duration = (microtime(true) - $stamp); @@ -802,45 +912,51 @@ class Worker { $found = self::findWorkerProcesses($passing_slow); self::$db_duration += (microtime(true) - $stamp); - Lock::remove('poller_worker_process'); + Lock::release('worker_process'); if ($found) { - $r = dba::select('workerqueue', array(), array('pid' => getmypid(), 'done' => false)); - return dba::inArray($r); + $r = DBA::select('workerqueue', [], ['pid' => getmypid(), 'done' => false]); + return DBA::toArray($r); } return false; } /** * @brief Removes a workerqueue entry from the current process + * @return void */ - public static function unclaimProcess() { + public static function unclaimProcess() + { $mypid = getmypid(); - dba::update('workerqueue', array('executed' => NULL_DATE, 'pid' => 0), array('pid' => $mypid, 'done' => false)); + DBA::update('workerqueue', ['executed' => DBA::NULL_DATETIME, 'pid' => 0], ['pid' => $mypid, 'done' => false]); } /** * @brief Call the front end worker + * @return void */ - public static function callWorker() { + public static function callWorker() + { if (!Config::get("system", "frontend_worker")) { return; } $url = System::baseUrl()."/worker"; - fetch_url($url, false, $redirects, 1); + Network::fetchUrl($url, false, $redirects, 1); } /** * @brief Call the front end worker if there aren't any active + * @return void */ - public static function executeIfIdle() { + public static function executeIfIdle() + { if (!Config::get("system", "frontend_worker")) { return; } - // Do we have "proc_open"? Then we can fork the poller + // 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 @@ -854,14 +970,14 @@ class Worker { if (self::tooMuchWorkers()) { // Cleaning dead processes self::killStaleWorkers(); - get_app()->remove_inactive_processes(); + Process::deleteInactive(); return; } self::runCron(); - logger('Call poller', LOGGER_DEBUG); + Logger::log('Call worker', Logger::DEBUG); self::spawnWorker(); return; } @@ -873,30 +989,34 @@ class Worker { self::clearProcesses(); - $workers = dba::fetch_first("SELECT COUNT(*) AS `processes` FROM `process` WHERE `command` = 'worker.php'"); + $workers = self::activeWorkers(); - if ($workers["processes"] == 0) { + if ($workers == 0) { self::callWorker(); } } /** * @brief Removes long running worker processes + * @return void */ - public static function clearProcesses() { + public static function clearProcesses() + { $timeout = Config::get("system", "frontend_worker_timeout", 10); /// @todo We should clean up the corresponding workerqueue entries as well - $condition = array("`created` < ? AND `command` = 'worker.php'", - datetime_convert('UTC','UTC',"now - ".$timeout." minutes")); - dba::delete('process', $condition); + $condition = ["`created` < ? AND `command` = 'worker.php'", + DateTimeFormat::utc("now - ".$timeout." minutes")]; + DBA::delete('process', $condition); } /** * @brief Runs the cron processes + * @return void */ - private static function runCron() { - logger('Add cron entries', LOGGER_DEBUG); + private static function runCron() + { + Logger::log('Add cron entries', Logger::DEBUG); // Check for spooled items self::add(PRIORITY_HIGH, "SpoolPost"); @@ -904,16 +1024,26 @@ class Worker { // Run the cron job that calls all other jobs self::add(PRIORITY_MEDIUM, "Cron"); - // Run the cronhooks job separately from cron for being able to use a different timing - self::add(PRIORITY_MEDIUM, "CronHooks"); - // Cleaning dead processes self::killStaleWorkers(); } - public static function spawnWorker() { - $args = array("scripts/worker.php", "no_cron"); - get_app()->proc_run($args); + /** + * @brief Spawns a new worker + * @return void + */ + public static function spawnWorker($do_cron = false) + { + $command = 'bin/worker.php'; + + $args = ['no_cron' => !$do_cron]; + + get_app()->proc_run($command, $args); + + // after spawning we have to remove the flag. + if (Config::get('system', 'worker_daemon_mode', false)) { + self::IPCSetJobState(false); + } } /** @@ -932,43 +1062,26 @@ class Worker { * * @return boolean "false" if proc_run couldn't be executed */ - public static function add($cmd) { - $proc_args = func_get_args(); + public static function add($cmd) + { + $args = func_get_args(); - $args = array(); - if (!count($proc_args)) { + if (!count($args)) { return false; } - // Preserve the first parameter - // It could contain a command, the priority or an parameter array - // If we use the parameter array we have to protect it from the following function - $run_parameter = array_shift($proc_args); + $arr = ['args' => $args, 'run_cmd' => true]; - // expand any arrays - foreach ($proc_args as $arg) { - if (is_array($arg)) { - foreach ($arg as $n) { - $args[] = $n; - } - } else { - $args[] = $arg; - } - } - - // Now we add the run parameters back to the array - array_unshift($args, $run_parameter); - - $arr = array('args' => $args, 'run_cmd' => true); - - call_hooks("proc_run", $arr); + Addon::callHooks("proc_run", $arr); if (!$arr['run_cmd'] || !count($args)) { return true; } $priority = PRIORITY_MEDIUM; - $dont_fork = Config::get("system", "worker_dont_fork"); - $created = datetime_convert(); + $dont_fork = Config::get("system", "worker_dont_fork", false); + $created = DateTimeFormat::utcNow(); + + $run_parameter = array_shift($args); if (is_int($run_parameter)) { $priority = $run_parameter; @@ -984,42 +1097,130 @@ class Worker { } } - $argv = $args; - array_shift($argv); - - $parameters = json_encode($argv); - $found = dba::exists('workerqueue', array('parameter' => $parameters, 'done' => false)); + $parameters = json_encode($args); + $found = DBA::exists('workerqueue', ['parameter' => $parameters, 'done' => false]); // Quit if there was a database error - a precaution for the update process to 3.5.3 - if (dba::errorNo() != 0) { + if (DBA::errorNo() != 0) { return false; } if (!$found) { - dba::insert('workerqueue', array('parameter' => $parameters, 'created' => $created, 'priority' => $priority)); + DBA::insert('workerqueue', ['parameter' => $parameters, 'created' => $created, 'priority' => $priority]); } - // Should we quit and wait for the poller to be called as a cronjob? + // Should we quit and wait for the worker to be called as a cronjob? if ($dont_fork) { return true; } // If there is a lock then we don't have to check for too much worker - if (!Lock::set('poller_worker', 0)) { + if (!Lock::acquire('worker', 0)) { return true; } // If there are already enough workers running, don't fork another one $quit = self::tooMuchWorkers(); - Lock::remove('poller_worker'); + Lock::release('worker'); if ($quit) { return true; } - // Now call the poller to execute the jobs that we just added to the queue + // We tell the daemon that a new job entry exists + if (Config::get('system', 'worker_daemon_mode', false)) { + // We don't have to set the IPC flag - this is done in "tooMuchWorkers" + return true; + } + + // Now call the worker to execute the jobs that we just added to the queue self::spawnWorker(); return true; } + + /** + * Defers the current worker entry + */ + public static function defer() + { + if (empty(BaseObject::getApp()->queue)) { + return; + } + + $queue = BaseObject::getApp()->queue; + + $retrial = $queue['retrial']; + $id = $queue['id']; + + if ($retrial > 14) { + Logger::log('Id ' . $id . ' had been tried 14 times. We stop now.', Logger::DEBUG); + return; + } + + // Calculate the delay until the next trial + $delay = (($retrial + 3) ** 4) + (rand(1, 30) * ($retrial + 1)); + $next = DateTimeFormat::utc('now + ' . $delay . ' seconds'); + + Logger::log('Defer execution ' . $retrial . ' of id ' . $id . ' to ' . $next, Logger::DEBUG); + + $fields = ['retrial' => $retrial + 1, 'next_try' => $next, 'executed' => DBA::NULL_DATETIME, 'pid' => 0]; + DBA::update('workerqueue', $fields, ['id' => $id]); + } + + /** + * Log active processes into the "process" table + * + * @brief Log active processes into the "process" table + */ + public static function startProcess() + { + $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 1); + + $command = basename($trace[0]['file']); + + Process::deleteInactive(); + + Process::insert($command); + } + + /** + * Remove the active process from the "process" table + * + * @brief Remove the active process from the "process" table + * @return bool + */ + public static function endProcess() + { + return Process::deleteByPid(); + } + + /** + * Set the flag if some job is waiting + * + * @brief Set the flag if some job is waiting + * @param boolean $jobs Is there a waiting job? + */ + public static function IPCSetJobState($jobs) + { + DBA::update('worker-ipc', ['jobs' => $jobs], ['key' => 1], true); + } + + /** + * Checks if some worker job waits to be executed + * + * @brief Checks if some worker job waits to be executed + * @return bool + */ + public static function IPCJobsExists() + { + $row = DBA::selectFirst('worker-ipc', ['jobs'], ['key' => 1]); + + // When we don't have a row, no job is running + if (!DBA::isResult($row)) { + return false; + } + + return (bool)$row['jobs']; + } }