*/
class Worker
{
+ /**
+ * @name Priority
+ *
+ * Process priority for the worker
+ * @{
+ */
+ const PRIORITY_UNDEFINED = 0;
+ const PRIORITY_CRITICAL = 10;
+ const PRIORITY_HIGH = 20;
+ const PRIORITY_MEDIUM = 30;
+ const PRIORITY_LOW = 40;
+ const PRIORITY_NEGLIGIBLE = 50;
+ const PRIORITIES = [self::PRIORITY_CRITICAL, self::PRIORITY_HIGH, self::PRIORITY_MEDIUM, self::PRIORITY_LOW, self::PRIORITY_NEGLIGIBLE];
+ /* @}*/
+
const STATE_STARTUP = 1; // Worker is in startup. This takes most time.
const STATE_LONG_LOOP = 2; // Worker is processing the whole - long - loop.
const STATE_REFETCH = 3; // Worker had refetched jobs in the execution loop.
}
// Quit the worker once every cron interval
- if (time() > ($starttime + (DI::config()->get('system', 'cron_interval') * 60))) {
+ if (time() > ($starttime + (DI::config()->get('system', 'cron_interval') * 60)) && !self::systemLimitReached()) {
Logger::info('Process lifetime reached, respawning.');
self::unclaimProcess($process);
if (Worker\Daemon::isMode()) {
return false;
}
- $file = str_replace(getcwd() . "/", "", $file, $count);
+ $file = str_replace(getcwd() . '/', '', $file, $count);
if ($count != 1) {
return false;
}
return false;
}
- $valid = false;
- if (strpos($file, "include/") === 0) {
- $valid = true;
- }
-
- if (strpos($file, "addon/") === 0) {
- $valid = true;
- }
-
- // Simply return flag
- return $valid;
+ return (strpos($file, 'addon/') === 0);
}
/**
// Quit when in maintenance
if (DI::config()->get('system', 'maintenance', false, true)) {
- Logger::notice("Maintenance mode - quit process", ['pid' => $mypid]);
+ Logger::notice('Maintenance mode - quit process', ['pid' => $mypid]);
return false;
}
// Constantly check the number of parallel database processes
if (DI::system()->isMaxProcessesReached()) {
- Logger::warning("Max processes reached for process", ['pid' => $mypid]);
+ Logger::warning('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::warning("Max connection reached for process", ['pid' => $mypid]);
+ Logger::warning('Max connection reached for process', ['pid' => $mypid]);
return false;
}
if (method_exists(sprintf('Friendica\Worker\%s', $include), 'execute')) {
// 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"]);
+ self::$last_update = strtotime($queue['executed']);
}
$age = (time() - self::$last_update) / 60;
return true;
}
- // The script could be provided as full path or only with the function name
- if ($include == basename($include)) {
- $include = "include/".$include.".php";
- }
-
if (!self::validateInclude($include)) {
- Logger::warning("Include file is not valid", ['file' => $argv[0]]);
+ Logger::warning('Include file is not valid', ['file' => $argv[0]]);
$stamp = (float)microtime(true);
- DBA::delete('workerqueue', ['id' => $queue["id"]]);
+ DBA::delete('workerqueue', ['id' => $queue['id']]);
self::$db_duration = (microtime(true) - $stamp);
self::$db_duration_write += (microtime(true) - $stamp);
return true;
require_once $include;
- $funcname = str_replace(".php", "", basename($argv[0]))."_run";
+ $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"]);
+ self::$last_update = strtotime($queue['executed']);
}
$age = (time() - self::$last_update) / 60;
self::execFunction($queue, $funcname, $argv, false);
$stamp = (float)microtime(true);
- if (DBA::update('workerqueue', ['done' => true], ['id' => $queue["id"]])) {
+ if (DBA::update('workerqueue', ['done' => true], ['id' => $queue['id']])) {
DI::config()->set('system', 'last_worker_execution', DateTimeFormat::utcNow());
}
self::$db_duration = (microtime(true) - $stamp);
self::$db_duration_write += (microtime(true) - $stamp);
} else {
- Logger::warning("Function does not exist", ['function' => $funcname]);
+ Logger::warning('Function does not exist', ['function' => $funcname]);
$stamp = (float)microtime(true);
- DBA::delete('workerqueue', ['id' => $queue["id"]]);
+ DBA::delete('workerqueue', ['id' => $queue['id']]);
self::$db_duration = (microtime(true) - $stamp);
self::$db_duration_write += (microtime(true) - $stamp);
}
return true;
}
+ /**
+ * Checks if system limits are reached.
+ *
+ * @return boolean
+ */
+ private static function systemLimitReached(): bool
+ {
+ $load_cooldown = DI::config()->get('system', 'worker_load_cooldown');
+ $processes_cooldown = DI::config()->get('system', 'worker_processes_cooldown');
+
+ if ($load_cooldown == 0) {
+ $load_cooldown = DI::config()->get('system', 'maxloadavg');
+ }
+
+ if (($load_cooldown == 0) && ($processes_cooldown == 0)) {
+ return false;
+ }
+
+ $load = System::getLoadAvg();
+ if (empty($load)) {
+ return false;
+ }
+
+ if (($load_cooldown > 0) && ($load['average1'] > $load_cooldown)) {
+ return true;
+ }
+
+ if (($processes_cooldown > 0) && ($load['scheduled'] > $processes_cooldown)) {
+ return true;
+ }
+
+ return false;
+ }
+
+ /**
+ * Slow the execution down if the system load is too high
+ *
+ * @return void
+ */
+ public static function coolDown()
+ {
+ $cooldown = DI::config()->get('system', 'worker_cooldown', 0);
+ if ($cooldown > 0) {
+ Logger::debug('Wait for cooldown.', ['cooldown' => $cooldown]);
+ if ($cooldown < 1) {
+ usleep($cooldown * 1000000);
+ } else {
+ sleep($cooldown);
+ }
+ }
+
+ $load_cooldown = DI::config()->get('system', 'worker_load_cooldown');
+ $processes_cooldown = DI::config()->get('system', 'worker_processes_cooldown');
+
+ if ($load_cooldown == 0) {
+ $load_cooldown = DI::config()->get('system', 'maxloadavg');
+ }
+
+ if (($load_cooldown == 0) && ($processes_cooldown == 0)) {
+ return;
+ }
+
+ $sleeping = false;
+
+ while ($load = System::getLoadAvg()) {
+ if (($load_cooldown > 0) && ($load['average1'] > $load_cooldown)) {
+ if (!$sleeping) {
+ Logger::notice('Load induced pre execution cooldown.', ['max' => $load_cooldown, 'load' => $load, 'called-by' => System::callstack(1)]);
+ $sleeping = true;
+ }
+ sleep(1);
+ continue;
+ }
+ if (($processes_cooldown > 0) && ($load['scheduled'] > $processes_cooldown)) {
+ if (!$sleeping) {
+ Logger::notice('Process induced pre execution cooldown.', ['max' => $processes_cooldown, 'load' => $load, 'called-by' => System::callstack(1)]);
+ $sleeping = true;
+ }
+ sleep(1);
+ continue;
+ }
+ break;
+ }
+
+ if ($sleeping) {
+ Logger::notice('Cooldown ended.', ['max-load' => $load_cooldown, 'max-processes' => $processes_cooldown, 'load' => $load, 'called-by' => System::callstack(1)]);
+ }
+ }
+
/**
* Execute a function from the queue
*
{
$a = DI::app();
- $cooldown = DI::config()->get("system", "worker_cooldown", 0);
- if ($cooldown > 0) {
- Logger::info('Pre execution cooldown.', ['priority' => $queue['priority'], 'id' => $queue["id"], 'cooldown' => $cooldown]);
- sleep($cooldown);
- }
+ self::coolDown();
Logger::enableWorker($funcname);
- Logger::info("Process start.", ['priority' => $queue['priority'], 'id' => $queue["id"]]);
+ Logger::info('Process start.', ['priority' => $queue['priority'], 'id' => $queue['id']]);
$stamp = (float)microtime(true);
Logger::info('Performance:', ['state' => self::$state, 'count' => $dbcount, 'stat' => $dbstat, 'write' => $dbwrite, 'lock' => $dblock, 'total' => $dbtotal, 'rest' => $rest, 'exec' => $exec]);
+ self::coolDown();
+
self::$up_start = microtime(true);
self::$db_duration = 0;
self::$db_duration_count = 0;
self::$lock_duration = 0;
if ($duration > 3600) {
- Logger::info('Longer than 1 hour.', ['priority' => $queue['priority'], 'id' => $queue["id"], 'duration' => round($duration/60, 3)]);
+ Logger::info('Longer than 1 hour.', ['priority' => $queue['priority'], 'id' => $queue['id'], 'duration' => round($duration/60, 3)]);
} elseif ($duration > 600) {
- Logger::info('Longer than 10 minutes.', ['priority' => $queue['priority'], 'id' => $queue["id"], 'duration' => round($duration/60, 3)]);
+ Logger::info('Longer than 10 minutes.', ['priority' => $queue['priority'], 'id' => $queue['id'], 'duration' => round($duration/60, 3)]);
} elseif ($duration > 300) {
- Logger::info('Longer than 5 minutes.', ['priority' => $queue['priority'], 'id' => $queue["id"], 'duration' => round($duration/60, 3)]);
+ Logger::info('Longer than 5 minutes.', ['priority' => $queue['priority'], 'id' => $queue['id'], 'duration' => round($duration/60, 3)]);
} elseif ($duration > 120) {
- Logger::info('Longer than 2 minutes.', ['priority' => $queue['priority'], 'id' => $queue["id"], 'duration' => round($duration/60, 3)]);
+ Logger::info('Longer than 2 minutes.', ['priority' => $queue['priority'], 'id' => $queue['id'], 'duration' => round($duration/60, 3)]);
}
- Logger::info('Process done.', ['priority' => $queue['priority'], 'id' => $queue["id"], 'duration' => round($duration, 3)]);
-
- DI::profiler()->saveLog(DI::logger(), "ID " . $queue["id"] . ": " . $funcname);
+ Logger::info('Process done.', ['priority' => $queue['priority'], 'id' => $queue['id'], 'duration' => round($duration, 3)]);
- if ($cooldown > 0) {
- Logger::info('Post execution cooldown.', ['priority' => $queue['priority'], 'id' => $queue["id"], 'cooldown' => $cooldown]);
- sleep($cooldown);
- }
+ DI::profiler()->saveLog(DI::logger(), 'ID ' . $queue['id'] . ': ' . $funcname);
}
/**
private static function maxConnectionsReached(): bool
{
// Fetch the max value from the config. This is needed when the system cannot detect the correct value by itself.
- $max = DI::config()->get("system", "max_connections");
+ $max = DI::config()->get('system', 'max_connections');
// Fetch the percentage level where the worker will get active
- $maxlevel = DI::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
$r = DBA::fetchFirst("SHOW VARIABLES WHERE `variable_name` = 'max_user_connections'");
if (DBA::isResult($r)) {
- $max = $r["Value"];
+ $max = $r['Value'];
}
// Or it can be granted. This overrides the system variable
$stamp = (float)microtime(true);
$used = DBA::numRows($r);
DBA::close($r);
- Logger::info("Connection usage (user values)", ['usage' => $used, 'max' => $max]);
+ Logger::info('Connection usage (user values)', ['usage' => $used, 'max' => $max]);
$level = ($used / $max) * 100;
if ($level >= $maxlevel) {
- Logger::warning("Maximum level (".$maxlevel."%) of user connections reached: ".$used."/".$max);
+ Logger::warning('Maximum level (' . $maxlevel . '%) of user connections reached: ' . $used .'/' . $max);
return true;
}
}
if (!DBA::isResult($r)) {
return false;
}
- $max = intval($r["Value"]);
+ $max = intval($r['Value']);
if ($max == 0) {
return false;
}
if (!DBA::isResult($r)) {
return false;
}
- $used = intval($r["Value"]);
+ $used = intval($r['Value']);
if ($used == 0) {
return false;
}
- Logger::info("Connection usage (system values)", ['used' => $used, 'max' => $max]);
+ Logger::info('Connection usage (system values)', ['used' => $used, 'max' => $max]);
$level = $used / $max * 100;
if ($level < $maxlevel) {
return false;
}
- Logger::warning("Maximum level (".$level."%) of system connections reached: ".$used."/".$max);
+ Logger::warning('Maximum level (' . $level . '%) of system connections reached: ' . $used . '/' . $max);
return true;
}
*/
private static function tooMuchWorkers(): bool
{
- $queues = DI::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(DI::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.
self::$db_duration += (microtime(true) - $stamp);
self::$db_duration_stat += (microtime(true) - $stamp);
$idle_workers -= $running;
- $waiting_processes += $entry["entries"];
- $listitem[$entry['priority']] = $entry['priority'] . ":" . $running . "/" . $entry["entries"];
+ $waiting_processes += $entry['entries'];
+ $listitem[$entry['priority']] = $entry['priority'] . ':' . $running . '/' . $entry['entries'];
}
DBA::close($jobs);
} else {
self::$db_duration_stat += (microtime(true) - $stamp);
while ($entry = DBA::fetch($jobs)) {
- $idle_workers -= $entry["running"];
- $listitem[$entry['priority']] = $entry['priority'].":".$entry["running"];
+ $idle_workers -= $entry['running'];
+ $listitem[$entry['priority']] = $entry['priority'] . ':' . $entry['running'];
}
DBA::close($jobs);
}
$waiting_processes -= $deferred;
- $listitem[0] = "0:" . max(0, $idle_workers);
+ $listitem[0] = '0:' . max(0, $idle_workers);
$processlist .= ' ('.implode(', ', $listitem).')';
- if (DI::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::info("Jobs with a higher priority are waiting but none is executed. Open a fastlane.", ['priority' => $top_priority]);
+ if (!$high_running && ($top_priority > self::PRIORITY_UNDEFINED) && ($top_priority < self::PRIORITY_NEGLIGIBLE)) {
+ Logger::info('Jobs with a higher priority are waiting but none is executed. Open a fastlane.', ['priority' => $top_priority]);
$queues = $active + 1;
}
}
- Logger::notice("Load: " . $load ."/" . $maxsysload . " - processes: " . $deferred . "/" . $active . "/" . $waiting_processes . $processlist . " - maximum: " . $queues . "/" . $maxqueues);
+ 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 (!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_dont_fork', false) && ($queues > ($active + 1)) && self::entriesExists() && !self::systemLimitReached()) {
+ Logger::info('There are fewer workers as possible, fork a new worker.', ['active' => $active, 'queues' => $queues]);
if (Worker\Daemon::isMode()) {
Worker\IPC::SetJobState(true);
} else {
private static function nextPriority()
{
$waiting = [];
- $priorities = [PRIORITY_CRITICAL, PRIORITY_HIGH, PRIORITY_MEDIUM, PRIORITY_LOW, PRIORITY_NEGLIGIBLE];
+ $priorities = [self::PRIORITY_CRITICAL, self::PRIORITY_HIGH, self::PRIORITY_MEDIUM, self::PRIORITY_LOW, self::PRIORITY_NEGLIGIBLE];
foreach ($priorities as $priority) {
$stamp = (float)microtime(true);
if (DBA::exists('workerqueue', ["`priority` = ? AND `pid` = 0 AND NOT `done` AND `next_try` < ?", $priority, DateTimeFormat::utcNow()])) {
self::$db_duration += (microtime(true) - $stamp);
}
- if (!empty($waiting[PRIORITY_CRITICAL])) {
- return PRIORITY_CRITICAL;
+ if (!empty($waiting[self::PRIORITY_CRITICAL])) {
+ return self::PRIORITY_CRITICAL;
}
$running = [];
* @param (integer|array) priority or parameter array, strings are deprecated and are ignored
*
* next args are passed as $cmd command line
- * or: Worker::add(PRIORITY_HIGH, "Notifier", Delivery::DELETION, $drop_id);
- * or: Worker::add(array('priority' => PRIORITY_HIGH, 'dont_fork' => true), "Delivery", $post_id);
+ * or: Worker::add(Worker::PRIORITY_HIGH, 'Notifier', Delivery::DELETION, $drop_id);
+ * or: Worker::add(array('priority' => Worker::PRIORITY_HIGH, 'dont_fork' => true), 'Delivery', $post_id);
*
- * @return int "0" if worker queue entry already existed or there had been an error, otherwise the ID of the worker task
+ * @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 ""
+ * @note $cmd and string args are surrounded with ''
*
* @hooks 'proc_run'
* array $arr
$arr = ['args' => $args, 'run_cmd' => true];
- Hook::callAll("proc_run", $arr);
+ Hook::callAll('proc_run', $arr);
if (!$arr['run_cmd'] || !count($args)) {
return 1;
}
- $priority = PRIORITY_MEDIUM;
+ $priority = self::PRIORITY_MEDIUM;
// Don't fork from frontend tasks by default
- $dont_fork = DI::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();
$delayed = DBA::NULL_DATETIME;
$force_priority = false;
$found = DBA::exists('workerqueue', ['command' => $command, 'parameter' => $parameters, 'done' => false]);
$added = 0;
- if (!is_int($priority) || !in_array($priority, PRIORITIES)) {
+ if (!is_int($priority) || !in_array($priority, self::PRIORITIES)) {
Logger::warning('Invalid priority', ['priority' => $priority, 'command' => $command, 'callstack' => System::callstack(20)]);
- $priority = PRIORITY_MEDIUM;
+ $priority = self::PRIORITY_MEDIUM;
}
// Quit if there was a database error - a precaution for the update process to 3.5.3
Worker\Daemon::checkState();
// Should we quit and wait for the worker to be called as a cronjob?
- if ($dont_fork) {
+ if ($dont_fork || self::systemLimitReached()) {
return $added;
}
$delay = (($new_retrial + 2) ** 4) + (rand(1, 30) * ($new_retrial));
$next = DateTimeFormat::utc('now + ' . $delay . ' seconds');
- if (($priority < PRIORITY_MEDIUM) && ($new_retrial > 3)) {
- $priority = PRIORITY_MEDIUM;
- } elseif (($priority < PRIORITY_LOW) && ($new_retrial > 6)) {
- $priority = PRIORITY_LOW;
- } elseif (($priority < PRIORITY_NEGLIGIBLE) && ($new_retrial > 8)) {
- $priority = PRIORITY_NEGLIGIBLE;
+ if (($priority < self::PRIORITY_MEDIUM) && ($new_retrial > 3)) {
+ $priority = self::PRIORITY_MEDIUM;
+ } elseif (($priority < self::PRIORITY_LOW) && ($new_retrial > 6)) {
+ $priority = self::PRIORITY_LOW;
+ } elseif (($priority < self::PRIORITY_NEGLIGIBLE) && ($new_retrial > 8)) {
+ $priority = self::PRIORITY_NEGLIGIBLE;
}
Logger::info('Deferred task', ['id' => $id, 'retrial' => $new_retrial, 'created' => $queue['created'], 'next_execution' => $next, 'old_prio' => $queue['priority'], 'new_prio' => $priority]);