<?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\Database\DBA;
use Friendica\DI;
-use Friendica\Model\Process;
use Friendica\Util\DateTimeFormat;
-use Friendica\Util\Network;
/**
- * @file src/Core/Worker.php
- *
- * @brief Contains the class for the worker background job processing
- */
-
-/**
- * @brief Worker methods
+ * Contains the class for the worker background job processing
*/
class Worker
{
const STATE_REFETCH = 3; // Worker had refetched jobs in the execution loop.
const STATE_SHORT_LOOP = 4; // Worker is processing preassigned jobs, thus saving much time.
- const FAST_COMMANDS = ['APDelivery', 'Delivery', 'CreateShadowEntry'];
+ const FAST_COMMANDS = ['APDelivery', 'Delivery'];
+ const LOCK_PROCESS = 'worker_process';
+ const LOCK_WORKER = 'worker';
private static $up_start;
private static $db_duration = 0;
private static $state;
/**
- * @brief Processes the tasks that are in the workerqueue table
+ * Processes the tasks that are in the workerqueue table
*
* @param boolean $run_cron Should the cron processes be executed?
* @return void
// 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::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.
- self::startProcess();
+ DI::process()->start();
// 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;
}
self::runCron();
}
- $starttime = time();
+ $last_check = $starttime = time();
self::$state = self::STATE_STARTUP;
// We fetch the next queue entry that is about to be executed
while ($r = self::workerProcess()) {
- $refetched = false;
+ // Don't refetch when a worker fetches tasks for multiple workers
+ $refetched = DI::config()->get('system', 'worker_multiple_fetch');
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::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 {
}
// To avoid the quitting of multiple workers only one worker at a time will execute the check
- if (!self::getWaitingJobForPID()) {
+ if ((time() > $last_check + 5) && !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::notice('Memory limit reached, quitting.');
+ DI::lock()->release(self::LOCK_WORKER);
return;
}
- DI::lock()->release('worker');
+ DI::lock()->release(self::LOCK_WORKER);
}
+ $last_check = time();
}
// 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::unclaimProcess();
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::notice('Memory limit reached, quitting.');
+ return false;
+ }
+
+ // Possibly there are too much database connections
+ if (self::maxConnectionsReached()) {
+ Logger::notice('Maximum connections reached, quitting.');
+ return false;
+ }
+
+ // Possibly there are too much database processes that block the system
+ if (DI::process()->isMaxProcessesReached()) {
+ Logger::notice('Maximum processes reached, quitting.');
+ return false;
+ }
+
+ return true;
}
/**
- * @brief Check if non executed tasks do exist in the worker queue
+ * Check if non executed tasks do exist in the worker queue
*
* @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()]);
}
/**
- * @brief Returns the number of deferred entries in the worker queue
+ * Returns the number of deferred entries in the worker queue
*
* @return integer Number of deferred entries in the worker queue
* @throws \Exception
}
/**
- * @brief Returns the number of non executed entries in the worker queue
+ * Returns the number of non executed entries in the worker queue
*
* @return integer Number of non executed entries in the worker queue
* @throws \Exception
}
/**
- * @brief Returns the highest priority in the worker queue that isn't executed
+ * Returns the highest priority in the worker queue that isn't executed
*
* @return integer Number of active worker processes
* @throws \Exception
}
/**
- * @brief Returns if a process with the given priority is running
+ * Returns if a process with the given priority is running
*
* @param integer $priority The priority that should be checked
*
}
/**
- * @brief Execute a worker entry
+ * Execute a worker entry
*
* @param array $queue Workerqueue entry
*
$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::notice("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::notice("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::notice("Max connection reached for process", ['pid' => $mypid]);
return false;
}
- $argv = json_decode($queue["parameter"], true);
+ $argv = json_decode($queue['parameter'], true);
+ if (!empty($queue['command'])) {
+ array_unshift($argv, $queue['command']);
+ }
+
+ if (empty($argv)) {
+ Logger::warning('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);
}
if (!validate_include($include)) {
- Logger::log("Include file ".$argv[0]." is not valid!");
+ Logger::warning("Include file is not valid", ['file' => $argv[0]]);
$stamp = (float)microtime(true);
DBA::delete('workerqueue', ['id' => $queue["id"]]);
self::$db_duration = (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);
} else {
- Logger::log("Function ".$funcname." does not exist");
+ Logger::warning("Function does not exist", ['function' => $funcname]);
$stamp = (float)microtime(true);
DBA::delete('workerqueue', ['id' => $queue["id"]]);
self::$db_duration = (microtime(true) - $stamp);
}
/**
- * @brief Execute a function from the queue
+ * Execute a function from the queue
*
* @param array $queue Workerqueue entry
* @param string $funcname name of the function
{
$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]);
}
/**
- * @brief Checks if the number of database connections has reached a critical limit.
+ * Checks if the number of database connections has reached a critical limit.
*
* @return bool Are more than 3/4 of the maximum connections used?
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
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 ($level >= $maxlevel) {
- Logger::log("Maximum level (".$maxlevel."%) of user connections reached: ".$used."/".$max);
+ Logger::notice("Maximum level (".$maxlevel."%) of user connections reached: ".$used."/".$max);
return true;
}
}
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;
if ($level < $maxlevel) {
return false;
}
- Logger::log("Maximum level (".$level."%) of system connections reached: ".$used."/".$max);
+ Logger::notice("Maximum level (".$level."%) of system connections reached: ".$used."/".$max);
return true;
}
/**
- * @brief fix the queue entry if the worker process died
+ * fix the queue entry if the worker process died
+ *
* @return void
* @throws \Exception
*/
$stamp = (float)microtime(true);
$entries = DBA::select(
'workerqueue',
- ['id', 'pid', 'executed', 'priority', 'parameter'],
+ ['id', 'pid', 'executed', 'priority', 'command', 'parameter'],
['NOT `done` AND `pid` != 0'],
- ['order' => ['priority', 'created']]
+ ['order' => ['priority', 'retrial', 'created']]
);
self::$db_duration += (microtime(true) - $stamp);
$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"], true);
- $argv[0] = basename($argv[0]);
+ $argv = json_decode($entry['parameter'], true);
+ if (!empty($entry['command'])) {
+ $command = $entry['command'];
+ } elseif (!empty($argv)) {
+ $command = array_shift($argv);
+ } else {
+ return;
+ }
+
+ $command = basename($command);
// How long is the process already running?
$duration = (time() - strtotime($entry["executed"])) / 60;
if ($duration > $max_duration) {
- Logger::log("Worker process ".$entry["pid"]." (".substr(json_encode($argv), 0, 50).") took more than ".$max_duration." minutes. It will be killed now.");
+ Logger::notice('Worker process took too much time - killed', ['duration' => number_format($duration, 3), 'max' => $max_duration, 'id' => $entry["id"], 'pid' => $entry["pid"], 'command' => $command]);
posix_kill($entry["pid"], SIGTERM);
// We killed the stale process.
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', ['duration' => number_format($duration, 3), 'max' => $max_duration, 'id' => $entry["id"], 'pid' => $entry["pid"], 'command' => $command]);
}
}
}
+ DBA::close($entries);
}
/**
- * @brief Checks if the number of active workers exceeds the given limits
+ * Checks if the number of active workers exceeds the given limits
*
* @return bool Are there too much workers running?
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
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);
}
}
/**
- * @brief Returns the number of active worker processes
+ * Returns the number of active worker processes
*
* @return integer Number of active worker processes
* @throws \Exception
$stamp = (float)microtime(true);
$count = DBA::count('process', ['command' => 'Worker.php']);
self::$db_duration += (microtime(true) - $stamp);
+ self::$db_duration_count += (microtime(true) - $stamp);
return $count;
}
/**
- * @brief Returns waiting jobs for the current process id
+ * Returns the number of active worker processes
+ *
+ * @return array List of worker process ids
+ * @throws \Exception
+ */
+ private static function getWorkerPIDList()
+ {
+ $ids = [];
+ $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`
+ GROUP BY `process`.`pid`");
+ while ($queue = DBA::fetch($queues)) {
+ $ids[$queue['pid']] = $queue['entries'];
+ }
+ DBA::close($queues);
+
+ self::$db_duration += (microtime(true) - $stamp);
+ self::$db_duration_count += (microtime(true) - $stamp);
+ return $ids;
+ }
+
+ /**
+ * Returns waiting jobs for the current process id
*
* @return array waiting workerqueue jobs
* @throws \Exception
}
/**
- * @brief Returns the next jobs that should be executed
- *
+ * Returns the next jobs that should be executed
+ * @param int $limit
* @return array array with next jobs
* @throws \Exception
*/
- private static function nextProcess()
+ private static function nextProcess(int $limit)
{
$priority = self::nextPriority();
if (empty($priority)) {
return [];
}
- $limit = Config::get('system', 'worker_fetch_limit', 1);
-
$ids = [];
$stamp = (float)microtime(true);
$condition = ["`priority` = ? AND `pid` = 0 AND NOT `done` AND `next_try` < ?", $priority, DateTimeFormat::utcNow()];
- $tasks = DBA::select('workerqueue', ['id', 'parameter'], $condition, ['limit' => $limit, 'order' => ['created']]);
+ $tasks = DBA::select('workerqueue', ['id', 'command', 'parameter'], $condition, ['limit' => $limit, 'order' => ['retrial', 'created']]);
self::$db_duration += (microtime(true) - $stamp);
while ($task = DBA::fetch($tasks)) {
$ids[] = $task['id'];
// Only continue that loop while we are storing commands that can be processed quickly
- $command = json_decode($task['parameter'])[0];
+ if (!empty($task['command'])) {
+ $command = $task['command'];
+ } else {
+ $command = json_decode($task['parameter'])[0];
+ }
+
if (!in_array($command, self::FAST_COMMANDS)) {
break;
}
}
/**
- * @brief Returns the priority of the next workerqueue job
+ * Returns the priority of the next workerqueue job
*
* @return string priority
* @throws \Exception
$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'];
}
/**
- * @brief Find and claim the next worker process for us
+ * Find and claim the next worker process for us
*
* @return boolean Have we found something?
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
private static function findWorkerProcesses()
{
- $mypid = getmypid();
+ $fetch_limit = DI::config()->get('system', 'worker_fetch_limit', 1);
- $ids = self::nextProcess();
+ if (DI::config()->get('system', 'worker_multiple_fetch')) {
+ $pids = [];
+ foreach (self::getWorkerPIDList() as $pid => $count) {
+ if ($count <= $fetch_limit) {
+ $pids[] = $pid;
+ }
+ }
+ if (empty($pids)) {
+ return;
+ }
+ $limit = $fetch_limit * count($pids);
+ } else {
+ $pids = [getmypid()];
+ $limit = $fetch_limit;
+ }
- // If there is no result we check without priority limit
- if (empty($ids)) {
- $limit = Config::get('system', 'worker_fetch_limit', 1);
+ $ids = self::nextProcess($limit);
+ $limit -= count($ids);
+ // If there is not enough results we check without priority limit
+ if ($limit > 0) {
$stamp = (float)microtime(true);
$condition = ["`pid` = 0 AND NOT `done` AND `next_try` < ?", DateTimeFormat::utcNow()];
- $tasks = DBA::select('workerqueue', ['id', 'parameter'], $condition, ['limit' => $limit, 'order' => ['priority', 'created']]);
+ $tasks = DBA::select('workerqueue', ['id', 'command', 'parameter'], $condition, ['limit' => $limit, 'order' => ['priority', 'retrial', 'created']]);
self::$db_duration += (microtime(true) - $stamp);
while ($task = DBA::fetch($tasks)) {
$ids[] = $task['id'];
// Only continue that loop while we are storing commands that can be processed quickly
- $command = json_decode($task['parameter'])[0];
+ if (!empty($task['command'])) {
+ $command = $task['command'];
+ } else {
+ $command = json_decode($task['parameter'])[0];
+ }
if (!in_array($command, self::FAST_COMMANDS)) {
break;
}
DBA::close($tasks);
}
- if (!empty($ids)) {
- $stamp = (float)microtime(true);
- $condition = ['id' => $ids, 'done' => false, 'pid' => 0];
- DBA::update('workerqueue', ['executed' => DateTimeFormat::utcNow(), 'pid' => $mypid], $condition);
- self::$db_duration += (microtime(true) - $stamp);
- self::$db_duration_write += (microtime(true) - $stamp);
+ if (empty($ids)) {
+ return;
}
- return !empty($ids);
+ // Assign the task ids to the workers
+ $worker = [];
+ foreach (array_unique($ids) as $id) {
+ $pid = next($pids);
+ if (!$pid) {
+ $pid = reset($pids);
+ }
+ $worker[$pid][] = $id;
+ }
+
+ $stamp = (float)microtime(true);
+ foreach ($worker as $worker_pid => $worker_ids) {
+ Logger::info('Set queue entry', ['pid' => $worker_pid, 'ids' => $worker_ids]);
+ DBA::update('workerqueue', ['executed' => DateTimeFormat::utcNow(), 'pid' => $worker_pid],
+ ['id' => $worker_ids, 'done' => false, 'pid' => 0]);
+ }
+ self::$db_duration += (microtime(true) - $stamp);
+ self::$db_duration_write += (microtime(true) - $stamp);
}
/**
- * @brief Returns the next worker process
+ * 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();
+ self::findWorkerProcesses();
- DI::lock()->release('worker_process');
+ DI::lock()->release(self::LOCK_PROCESS);
- if ($found) {
- $stamp = (float)microtime(true);
- $r = DBA::select('workerqueue', [], ['pid' => getmypid(), 'done' => false]);
- self::$db_duration += (microtime(true) - $stamp);
- return DBA::toArray($r);
- }
- return false;
+ return self::getWaitingJobForPID();
}
/**
- * @brief Removes a workerqueue entry from the current process
+ * Removes a workerqueue entry from the current process
+ *
* @return void
* @throws \Exception
*/
}
/**
- * @brief Call the front end worker
+ * 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, 1);
}
/**
- * @brief Call the front end worker if there aren't any active
+ * 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")) {
+ self::checkDaemonState();
+
+ 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()) {
// Cleaning dead processes
self::killStaleWorkers();
- Process::deleteInactive();
+ DI::modelProcess()->deleteInactive();
return;
}
self::runCron();
- Logger::log('Call worker', Logger::DEBUG);
+ Logger::info('Call worker');
self::spawnWorker();
return;
}
}
/**
- * @brief Removes long running worker processes
+ * 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);
}
/**
- * @brief Runs the cron processes
+ * 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');
}
/**
- * @brief Spawns a new worker
+ * Spawns a new worker
+ *
* @param bool $do_cron
* @return void
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
$args = ['no_cron' => !$do_cron];
$a = DI::app();
- $process = new Core\Process(DI::logger(), DI::mode(), DI::config(), $a->getBasePath());
+ $process = new Core\Process(DI::logger(), DI::mode(), DI::config(), DI::modelProcess(), $a->getBasePath(), getmypid());
$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);
}
}
/**
- * @brief Adds tasks to the worker queue
+ * Adds tasks to the worker queue
*
* @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), "CreateShadowEntry", $post_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
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
$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();
+ $delayed = DBA::NULL_DATETIME;
$force_priority = false;
$run_parameter = array_shift($args);
if (is_int($run_parameter)) {
$priority = $run_parameter;
} elseif (is_array($run_parameter)) {
+ if (isset($run_parameter['delayed'])) {
+ $delayed = $run_parameter['delayed'];
+ }
if (isset($run_parameter['priority'])) {
$priority = $run_parameter['priority'];
}
}
}
+ $command = array_shift($args);
$parameters = json_encode($args);
- $found = DBA::exists('workerqueue', ['parameter' => $parameters, 'done' => false]);
+ $found = DBA::exists('workerqueue', ['command' => $command, 'parameter' => $parameters, 'done' => false]);
$added = false;
// Quit if there was a database error - a precaution for the update process to 3.5.3
}
if (!$found) {
- $added = DBA::insert('workerqueue', ['parameter' => $parameters, 'created' => $created, 'priority' => $priority]);
+ $added = DBA::insert('workerqueue', ['command' => $command, 'parameter' => $parameters, 'created' => $created,
+ 'priority' => $priority, 'next_try' => $delayed]);
if (!$added) {
return false;
}
} elseif ($force_priority) {
- DBA::update('workerqueue', ['priority' => $priority], ['parameter' => $parameters, 'done' => false, 'pid' => 0]);
+ DBA::update('workerqueue', ['priority' => $priority], ['command' => $command, 'parameter' => $parameters, 'done' => false, 'pid' => 0]);
}
+ // Set the IPC flag to ensure an immediate process execution via daemon
+ if (DI::config()->get('system', 'worker_daemon_mode', false)) {
+ self::IPCSetJobState(true);
+ }
+
+ self::checkDaemonState();
+
// Should we quit and wait for the worker to be called as a cronjob?
if ($dont_fork) {
return $added;
}
// 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)) {
- // We don't have to set the IPC flag - this is done in "tooMuchWorkers"
+ // Quit on daemon mode
+ if (DI::config()->get('system', 'worker_daemon_mode', false)) {
return $added;
}
return $added;
}
+ public static function countWorkersByCommand(string $command)
+ {
+ return DBA::count('workerqueue', ['done' => false, 'pid' => 0, 'command' => $command]);
+ }
+
/**
* Returns the next retrial level for worker jobs.
* This function will skip levels when jobs are older.
/**
* 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);
return true;
}
- /**
- * 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
- * @throws \Exception
- */
- 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?
* @throws \Exception
*/
/**
* Checks if some worker job waits to be executed
*
- * @brief Checks if some worker job waits to be executed
* @return bool
* @throws \Exception
*/
return (bool)$row['jobs'];
}
+
+ /**
+ * Test if the daemon is running. If not, it will be started
+ *
+ * @return void
+ */
+ private static function checkDaemonState()
+ {
+ if (!DI::config()->get('system', 'daemon_watchdog', false)) {
+ return;
+ }
+
+ if (!DI::mode()->isNormal()) {
+ return;
+ }
+
+ // Check every minute if the daemon is running
+ if (DI::config()->get('system', 'last_daemon_check', 0) + 60 > time()) {
+ return;
+ }
+
+ DI::config()->set('system', 'last_daemon_check', time());
+
+ $pidfile = DI::config()->get('system', 'pidfile');
+ if (empty($pidfile)) {
+ // No pid file, no daemon
+ return;
+ }
+
+ if (!is_readable($pidfile)) {
+ // No pid file. We assume that the daemon had been intentionally stopped.
+ return;
+ }
+
+ $pid = intval(file_get_contents($pidfile));
+ if (posix_kill($pid, 0)) {
+ Logger::info('Daemon process is running', ['pid' => $pid]);
+ return;
+ }
+
+ Logger::warning('Daemon process is not running', ['pid' => $pid]);
+
+ self::spawnDaemon();
+ }
+
+ /**
+ * Spawn a new daemon process
+ *
+ * @return void
+ */
+ private static function spawnDaemon()
+ {
+ Logger::info('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']);
+ Logger::info('New daemon process started');
+ }
+
+ /**
+ * Check if the system is inside the defined maintenance window
+ *
+ * @return boolean
+ */
+ public static function isInMaintenanceWindow(bool $check_last_execution = false)
+ {
+ // Calculate the seconds of the start end end of the maintenance window
+ $start = strtotime(DI::config()->get('system', 'maintenance_start')) % 86400;
+ $end = strtotime(DI::config()->get('system', 'maintenance_end')) % 86400;
+
+ Logger::info('Maintenance window', ['start' => date('H:i:s', $start), 'end' => date('H:i:s', $end)]);
+
+ if ($check_last_execution) {
+ // Calculate the window duration
+ $duration = max($start, $end) - min($start, $end);
+
+ // Quit when the last cron execution had been after the previous window
+ $last_cron = DI::config()->get('system', 'last_cron_daily');
+ if ($last_cron + $duration > time()) {
+ Logger::info('The Daily cron had been executed recently', ['last' => date(DateTimeFormat::MYSQL, $last_cron), 'start' => date('H:i:s', $start), 'end' => date('H:i:s', $end)]);
+ return false;
+ }
+ }
+
+ $current = time() % 86400;
+
+ if ($start < $end) {
+ // Execute if we are inside the window
+ $execute = ($current >= $start) && ($current <= $end);
+ } else {
+ // Don't execute if we are outside the window
+ $execute = !(($current > $end) && ($current < $start));
+ }
+
+ if ($execute) {
+ Logger::info('We are inside the maintenance window', ['current' => date('H:i:s', $current), 'start' => date('H:i:s', $start), 'end' => date('H:i:s', $end)]);
+ } 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;
+ }
}
projects / friendica.git / blobdiff