3 * @copyright Copyright (C) 2020, Friendica
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Core;
25 use Friendica\Core\Process as ProcessAlias;
26 use Friendica\Database\DBA;
28 use Friendica\Model\Process;
29 use Friendica\Util\DateTimeFormat;
32 * Contains the class for the worker background job processing
36 const STATE_STARTUP = 1; // Worker is in startup. This takes most time.
37 const STATE_LONG_LOOP = 2; // Worker is processing the whole - long - loop.
38 const STATE_REFETCH = 3; // Worker had refetched jobs in the execution loop.
39 const STATE_SHORT_LOOP = 4; // Worker is processing preassigned jobs, thus saving much time.
41 const FAST_COMMANDS = ['APDelivery', 'Delivery', 'CreateShadowEntry'];
43 const LOCK_PROCESS = 'worker_process';
44 const LOCK_WORKER = 'worker';
46 private static $up_start;
47 private static $db_duration = 0;
48 private static $db_duration_count = 0;
49 private static $db_duration_write = 0;
50 private static $db_duration_stat = 0;
51 private static $lock_duration = 0;
52 private static $last_update;
53 private static $state;
56 * Processes the tasks that are in the workerqueue table
58 * @param boolean $run_cron Should the cron processes be executed?
60 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
62 public static function processQueue($run_cron = true)
64 // Ensure that all "strtotime" operations do run timezone independent
65 date_default_timezone_set('UTC');
67 self::$up_start = microtime(true);
69 // At first check the maximum load. We shouldn't continue with a high load
70 if (DI::process()->isMaxLoadReached()) {
71 Logger::notice('Pre check: maximum load reached, quitting.');
75 // We now start the process. This is done after the load check since this could increase the load.
76 DI::process()->start();
78 // Kill stale processes every 5 minutes
79 $last_cleanup = DI::config()->get('system', 'worker_last_cleaned', 0);
80 if (time() > ($last_cleanup + 300)) {
81 DI::config()->set('system', 'worker_last_cleaned', time());
82 self::killStaleWorkers();
85 // Check if the system is ready
86 if (!self::isReady()) {
90 // Now we start additional cron processes if we should do so
95 $last_check = $starttime = time();
96 self::$state = self::STATE_STARTUP;
98 // We fetch the next queue entry that is about to be executed
99 while ($r = self::workerProcess()) {
100 // Don't refetch when a worker fetches tasks for multiple workers
101 $refetched = DI::config()->get('system', 'worker_multiple_fetch');
102 foreach ($r as $entry) {
103 // Assure that the priority is an integer value
104 $entry['priority'] = (int)$entry['priority'];
106 // The work will be done
107 if (!self::execute($entry)) {
108 Logger::info('Process execution failed, quitting.');
112 // Trying to fetch new processes - but only once when successful
113 if (!$refetched && DI::lock()->acquire(self::LOCK_PROCESS, 0)) {
114 self::findWorkerProcesses();
115 DI::lock()->release(self::LOCK_PROCESS);
116 self::$state = self::STATE_REFETCH;
119 self::$state = self::STATE_SHORT_LOOP;
123 // To avoid the quitting of multiple workers only one worker at a time will execute the check
124 if ((time() > $last_check + 5) && !self::getWaitingJobForPID()) {
125 self::$state = self::STATE_LONG_LOOP;
127 if (DI::lock()->acquire(self::LOCK_WORKER, 0)) {
128 // Count active workers and compare them with a maximum value that depends on the load
129 if (self::tooMuchWorkers()) {
130 Logger::info('Active worker limit reached, quitting.');
131 DI::lock()->release(self::LOCK_WORKER);
136 if (DI::process()->isMinMemoryReached()) {
137 Logger::notice('Memory limit reached, quitting.');
138 DI::lock()->release(self::LOCK_WORKER);
141 DI::lock()->release(self::LOCK_WORKER);
143 $last_check = time();
146 // Quit the worker once every cron interval
147 if (time() > ($starttime + (DI::config()->get('system', 'cron_interval') * 60))) {
148 Logger::info('Process lifetime reached, respawning.');
149 self::unclaimProcess();
155 // Cleaning up. Possibly not needed, but it doesn't harm anything.
156 if (DI::config()->get('system', 'worker_daemon_mode', false)) {
157 self::IPCSetJobState(false);
159 Logger::info("Couldn't select a workerqueue entry, quitting process", ['pid' => getmypid()]);
163 * Checks if the system is ready.
165 * Several system parameters like memory, connections and processes are checked.
169 public static function isReady()
171 // Count active workers and compare them with a maximum value that depends on the load
172 if (self::tooMuchWorkers()) {
173 Logger::info('Active worker limit reached, quitting.');
177 // Do we have too few memory?
178 if (DI::process()->isMinMemoryReached()) {
179 Logger::notice('Memory limit reached, quitting.');
183 // Possibly there are too much database connections
184 if (self::maxConnectionsReached()) {
185 Logger::notice('Maximum connections reached, quitting.');
189 // Possibly there are too much database processes that block the system
190 if (DI::process()->isMaxProcessesReached()) {
191 Logger::notice('Maximum processes reached, quitting.');
199 * Check if non executed tasks do exist in the worker queue
201 * @return boolean Returns "true" if tasks are existing
204 public static function entriesExists()
206 $stamp = (float)microtime(true);
207 $exists = DBA::exists('workerqueue', ["NOT `done` AND `pid` = 0 AND `next_try` < ?", DateTimeFormat::utcNow()]);
208 self::$db_duration += (microtime(true) - $stamp);
213 * Returns the number of deferred entries in the worker queue
215 * @return integer Number of deferred entries in the worker queue
218 private static function deferredEntries()
220 $stamp = (float)microtime(true);
221 $count = DBA::count('workerqueue', ["NOT `done` AND `pid` = 0 AND `retrial` > ?", 0]);
222 self::$db_duration += (microtime(true) - $stamp);
223 self::$db_duration_count += (microtime(true) - $stamp);
228 * Returns the number of non executed entries in the worker queue
230 * @return integer Number of non executed entries in the worker queue
233 private static function totalEntries()
235 $stamp = (float)microtime(true);
236 $count = DBA::count('workerqueue', ['done' => false, 'pid' => 0]);
237 self::$db_duration += (microtime(true) - $stamp);
238 self::$db_duration_count += (microtime(true) - $stamp);
243 * Returns the highest priority in the worker queue that isn't executed
245 * @return integer Number of active worker processes
248 private static function highestPriority()
250 $stamp = (float)microtime(true);
251 $condition = ["`pid` = 0 AND NOT `done` AND `next_try` < ?", DateTimeFormat::utcNow()];
252 $workerqueue = DBA::selectFirst('workerqueue', ['priority'], $condition, ['order' => ['priority']]);
253 self::$db_duration += (microtime(true) - $stamp);
254 if (DBA::isResult($workerqueue)) {
255 return $workerqueue["priority"];
262 * Returns if a process with the given priority is running
264 * @param integer $priority The priority that should be checked
266 * @return integer Is there a process running with that priority?
269 private static function processWithPriorityActive($priority)
271 $condition = ["`priority` <= ? AND `pid` != 0 AND NOT `done`", $priority];
272 return DBA::exists('workerqueue', $condition);
276 * Execute a worker entry
278 * @param array $queue Workerqueue entry
280 * @return boolean "true" if further processing should be stopped
281 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
283 public static function execute($queue)
287 // Quit when in maintenance
288 if (DI::config()->get('system', 'maintenance', false, true)) {
289 Logger::notice("Maintenance mode - quit process", ['pid' => $mypid]);
293 // Constantly check the number of parallel database processes
294 if (DI::process()->isMaxProcessesReached()) {
295 Logger::notice("Max processes reached for process", ['pid' => $mypid]);
299 // Constantly check the number of available database connections to let the frontend be accessible at any time
300 if (self::maxConnectionsReached()) {
301 Logger::notice("Max connection reached for process", ['pid' => $mypid]);
305 $argv = json_decode($queue["parameter"], true);
307 Logger::warning('Parameter is empty', ['queue' => $queue]);
311 // Check for existance and validity of the include file
314 if (method_exists(sprintf('Friendica\Worker\%s', $include), 'execute')) {
315 // We constantly update the "executed" date every minute to avoid being killed too soon
316 if (!isset(self::$last_update)) {
317 self::$last_update = strtotime($queue["executed"]);
320 $age = (time() - self::$last_update) / 60;
321 self::$last_update = time();
324 $stamp = (float)microtime(true);
325 DBA::update('workerqueue', ['executed' => DateTimeFormat::utcNow()], ['pid' => $mypid, 'done' => false]);
326 self::$db_duration += (microtime(true) - $stamp);
327 self::$db_duration_write += (microtime(true) - $stamp);
332 self::execFunction($queue, $include, $argv, true);
334 $stamp = (float)microtime(true);
335 $condition = ["`id` = ? AND `next_try` < ?", $queue['id'], DateTimeFormat::utcNow()];
336 if (DBA::update('workerqueue', ['done' => true], $condition)) {
337 DI::config()->set('system', 'last_worker_execution', DateTimeFormat::utcNow());
339 self::$db_duration = (microtime(true) - $stamp);
340 self::$db_duration_write += (microtime(true) - $stamp);
345 // The script could be provided as full path or only with the function name
346 if ($include == basename($include)) {
347 $include = "include/".$include.".php";
350 if (!validate_include($include)) {
351 Logger::warning("Include file is not valid", ['file' => $argv[0]]);
352 $stamp = (float)microtime(true);
353 DBA::delete('workerqueue', ['id' => $queue["id"]]);
354 self::$db_duration = (microtime(true) - $stamp);
355 self::$db_duration_write += (microtime(true) - $stamp);
359 require_once $include;
361 $funcname = str_replace(".php", "", basename($argv[0]))."_run";
363 if (function_exists($funcname)) {
364 // We constantly update the "executed" date every minute to avoid being killed too soon
365 if (!isset(self::$last_update)) {
366 self::$last_update = strtotime($queue["executed"]);
369 $age = (time() - self::$last_update) / 60;
370 self::$last_update = time();
373 $stamp = (float)microtime(true);
374 DBA::update('workerqueue', ['executed' => DateTimeFormat::utcNow()], ['pid' => $mypid, 'done' => false]);
375 self::$db_duration += (microtime(true) - $stamp);
376 self::$db_duration_write += (microtime(true) - $stamp);
379 self::execFunction($queue, $funcname, $argv, false);
381 $stamp = (float)microtime(true);
382 if (DBA::update('workerqueue', ['done' => true], ['id' => $queue["id"]])) {
383 DI::config()->set('system', 'last_worker_execution', DateTimeFormat::utcNow());
385 self::$db_duration = (microtime(true) - $stamp);
386 self::$db_duration_write += (microtime(true) - $stamp);
388 Logger::warning("Function does not exist", ['function' => $funcname]);
389 $stamp = (float)microtime(true);
390 DBA::delete('workerqueue', ['id' => $queue["id"]]);
391 self::$db_duration = (microtime(true) - $stamp);
392 self::$db_duration_write += (microtime(true) - $stamp);
399 * Execute a function from the queue
401 * @param array $queue Workerqueue entry
402 * @param string $funcname name of the function
403 * @param array $argv Array of values to be passed to the function
404 * @param boolean $method_call boolean
406 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
408 private static function execFunction($queue, $funcname, $argv, $method_call)
412 Logger::enableWorker($funcname);
414 Logger::info("Process start.", ['priority' => $queue["priority"], 'id' => $queue["id"]]);
416 $stamp = (float)microtime(true);
418 // We use the callstack here to analyze the performance of executed worker entries.
419 // For this reason the variables have to be initialized.
420 DI::profiler()->reset();
424 $up_duration = microtime(true) - self::$up_start;
426 // Reset global data to avoid interferences
429 // Set the workerLogger as new default logger
431 call_user_func_array(sprintf('Friendica\Worker\%s::execute', $funcname), $argv);
433 $funcname($argv, count($argv));
436 Logger::disableWorker();
440 $duration = (microtime(true) - $stamp);
442 /* With these values we can analyze how effective the worker is.
443 * The database and rest time should be low since this is the unproductive time.
444 * The execution time is the productive time.
445 * By changing parameters like the maximum number of workers we can check the effectivness.
447 $dbtotal = round(self::$db_duration, 2);
448 $dbread = round(self::$db_duration - (self::$db_duration_count + self::$db_duration_write + self::$db_duration_stat), 2);
449 $dbcount = round(self::$db_duration_count, 2);
450 $dbstat = round(self::$db_duration_stat, 2);
451 $dbwrite = round(self::$db_duration_write, 2);
452 $dblock = round(self::$lock_duration, 2);
453 $rest = round(max(0, $up_duration - (self::$db_duration + self::$lock_duration)), 2);
454 $exec = round($duration, 2);
456 Logger::info('Performance:', ['state' => self::$state, 'count' => $dbcount, 'stat' => $dbstat, 'write' => $dbwrite, 'lock' => $dblock, 'total' => $dbtotal, 'rest' => $rest, 'exec' => $exec]);
458 self::$up_start = microtime(true);
459 self::$db_duration = 0;
460 self::$db_duration_count = 0;
461 self::$db_duration_stat = 0;
462 self::$db_duration_write = 0;
463 self::$lock_duration = 0;
465 if ($duration > 3600) {
466 Logger::info('Longer than 1 hour.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'duration' => round($duration/60, 3)]);
467 } elseif ($duration > 600) {
468 Logger::info('Longer than 10 minutes.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'duration' => round($duration/60, 3)]);
469 } elseif ($duration > 300) {
470 Logger::info('Longer than 5 minutes.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'duration' => round($duration/60, 3)]);
471 } elseif ($duration > 120) {
472 Logger::info('Longer than 2 minutes.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'duration' => round($duration/60, 3)]);
475 Logger::info('Process done.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'duration' => round($duration, 3)]);
477 DI::profiler()->saveLog(DI::logger(), "ID " . $queue["id"] . ": " . $funcname);
479 $cooldown = DI::config()->get("system", "worker_cooldown", 0);
482 Logger::info('Cooldown.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'cooldown' => $cooldown]);
488 * Checks if the number of database connections has reached a critical limit.
490 * @return bool Are more than 3/4 of the maximum connections used?
491 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
493 private static function maxConnectionsReached()
495 // Fetch the max value from the config. This is needed when the system cannot detect the correct value by itself.
496 $max = DI::config()->get("system", "max_connections");
498 // Fetch the percentage level where the worker will get active
499 $maxlevel = DI::config()->get("system", "max_connections_level", 75);
502 // the maximum number of possible user connections can be a system variable
503 $r = DBA::fetchFirst("SHOW VARIABLES WHERE `variable_name` = 'max_user_connections'");
504 if (DBA::isResult($r)) {
507 // Or it can be granted. This overrides the system variable
508 $stamp = (float)microtime(true);
509 $r = DBA::p('SHOW GRANTS');
510 self::$db_duration += (microtime(true) - $stamp);
511 while ($grants = DBA::fetch($r)) {
512 $grant = array_pop($grants);
513 if (stristr($grant, "GRANT USAGE ON")) {
514 if (preg_match("/WITH MAX_USER_CONNECTIONS (\d*)/", $grant, $match)) {
522 // If $max is set we will use the processlist to determine the current number of connections
523 // The processlist only shows entries of the current user
525 $stamp = (float)microtime(true);
526 $r = DBA::p('SHOW PROCESSLIST');
527 self::$db_duration += (microtime(true) - $stamp);
528 $used = DBA::numRows($r);
531 Logger::info("Connection usage (user values)", ['usage' => $used, 'max' => $max]);
533 $level = ($used / $max) * 100;
535 if ($level >= $maxlevel) {
536 Logger::notice("Maximum level (".$maxlevel."%) of user connections reached: ".$used."/".$max);
541 // We will now check for the system values.
542 // This limit could be reached although the user limits are fine.
543 $r = DBA::fetchFirst("SHOW VARIABLES WHERE `variable_name` = 'max_connections'");
544 if (!DBA::isResult($r)) {
547 $max = intval($r["Value"]);
551 $r = DBA::fetchFirst("SHOW STATUS WHERE `variable_name` = 'Threads_connected'");
552 if (!DBA::isResult($r)) {
555 $used = intval($r["Value"]);
559 Logger::info("Connection usage (system values)", ['used' => $used, 'max' => $max]);
561 $level = $used / $max * 100;
563 if ($level < $maxlevel) {
566 Logger::notice("Maximum level (".$level."%) of system connections reached: ".$used."/".$max);
571 * fix the queue entry if the worker process died
576 private static function killStaleWorkers()
578 $stamp = (float)microtime(true);
579 $entries = DBA::select(
581 ['id', 'pid', 'executed', 'priority', 'parameter'],
582 ['NOT `done` AND `pid` != 0'],
583 ['order' => ['priority', 'created']]
585 self::$db_duration += (microtime(true) - $stamp);
587 while ($entry = DBA::fetch($entries)) {
588 if (!posix_kill($entry["pid"], 0)) {
589 $stamp = (float)microtime(true);
592 ['executed' => DBA::NULL_DATETIME, 'pid' => 0],
593 ['id' => $entry["id"]]
595 self::$db_duration += (microtime(true) - $stamp);
596 self::$db_duration_write += (microtime(true) - $stamp);
598 // Kill long running processes
599 // Check if the priority is in a valid range
600 if (!in_array($entry["priority"], [PRIORITY_CRITICAL, PRIORITY_HIGH, PRIORITY_MEDIUM, PRIORITY_LOW, PRIORITY_NEGLIGIBLE])) {
601 $entry["priority"] = PRIORITY_MEDIUM;
604 // Define the maximum durations
605 $max_duration_defaults = [PRIORITY_CRITICAL => 720, PRIORITY_HIGH => 10, PRIORITY_MEDIUM => 60, PRIORITY_LOW => 180, PRIORITY_NEGLIGIBLE => 720];
606 $max_duration = $max_duration_defaults[$entry["priority"]];
608 $argv = json_decode($entry["parameter"], true);
613 $argv[0] = basename($argv[0]);
615 // How long is the process already running?
616 $duration = (time() - strtotime($entry["executed"])) / 60;
617 if ($duration > $max_duration) {
618 Logger::notice("Worker process ".$entry["pid"]." (".substr(json_encode($argv), 0, 50).") took more than ".$max_duration." minutes. It will be killed now.");
619 posix_kill($entry["pid"], SIGTERM);
621 // We killed the stale process.
622 // To avoid a blocking situation we reschedule the process at the beginning of the queue.
623 // Additionally we are lowering the priority. (But not PRIORITY_CRITICAL)
624 $new_priority = $entry["priority"];
625 if ($entry["priority"] == PRIORITY_HIGH) {
626 $new_priority = PRIORITY_MEDIUM;
627 } elseif ($entry["priority"] == PRIORITY_MEDIUM) {
628 $new_priority = PRIORITY_LOW;
629 } elseif ($entry["priority"] != PRIORITY_CRITICAL) {
630 $new_priority = PRIORITY_NEGLIGIBLE;
632 $stamp = (float)microtime(true);
635 ['executed' => DBA::NULL_DATETIME, 'created' => DateTimeFormat::utcNow(), 'priority' => $new_priority, 'pid' => 0],
636 ['id' => $entry["id"]]
638 self::$db_duration += (microtime(true) - $stamp);
639 self::$db_duration_write += (microtime(true) - $stamp);
641 Logger::info('Process runtime is okay', ['pid' => $entry["pid"], 'duration' => $duration, 'max' => $max_duration, 'command' => substr(json_encode($argv), 0, 50)]);
645 DBA::close($entries);
649 * Checks if the number of active workers exceeds the given limits
651 * @return bool Are there too much workers running?
652 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
654 private static function tooMuchWorkers()
656 $queues = DI::config()->get("system", "worker_queues", 10);
658 $maxqueues = $queues;
660 $active = self::activeWorkers();
662 // Decrease the number of workers at higher load
663 $load = System::currentLoad();
665 $maxsysload = intval(DI::config()->get("system", "maxloadavg", 20));
667 /* Default exponent 3 causes queues to rapidly decrease as load increases.
668 * If you have 20 max queues at idle, then you get only 5 queues at 37.1% of $maxsysload.
669 * For some environments, this rapid decrease is not needed.
670 * With exponent 1, you could have 20 max queues at idle and 13 at 37% of $maxsysload.
672 $exponent = intval(DI::config()->get('system', 'worker_load_exponent', 3));
673 $slope = pow(max(0, $maxsysload - $load) / $maxsysload, $exponent);
674 $queues = intval(ceil($slope * $maxqueues));
678 if (DI::config()->get('system', 'worker_jpm')) {
679 $intervals = explode(',', DI::config()->get('system', 'worker_jpm_range'));
680 $jobs_per_minute = [];
681 foreach ($intervals as $interval) {
682 if ($interval == 0) {
685 $interval = (int)$interval;
688 $stamp = (float)microtime(true);
689 $jobs = DBA::p("SELECT COUNT(*) AS `jobs` FROM `workerqueue` WHERE `done` AND `executed` > UTC_TIMESTAMP() - INTERVAL ? MINUTE", $interval);
690 self::$db_duration += (microtime(true) - $stamp);
691 self::$db_duration_stat += (microtime(true) - $stamp);
692 if ($job = DBA::fetch($jobs)) {
693 $jobs_per_minute[$interval] = number_format($job['jobs'] / $interval, 0);
697 $processlist = ' - jpm: '.implode('/', $jobs_per_minute);
700 // Create a list of queue entries grouped by their priority
701 $listitem = [0 => ''];
703 $idle_workers = $active;
705 $deferred = self::deferredEntries();
707 if (DI::config()->get('system', 'worker_debug')) {
708 $waiting_processes = 0;
709 // Now adding all processes with workerqueue entries
710 $stamp = (float)microtime(true);
711 $jobs = DBA::p("SELECT COUNT(*) AS `entries`, `priority` FROM `workerqueue` WHERE NOT `done` GROUP BY `priority`");
712 self::$db_duration += (microtime(true) - $stamp);
713 self::$db_duration_stat += (microtime(true) - $stamp);
714 while ($entry = DBA::fetch($jobs)) {
715 $stamp = (float)microtime(true);
716 $processes = DBA::p("SELECT COUNT(*) AS `running` FROM `workerqueue-view` WHERE `priority` = ?", $entry["priority"]);
717 self::$db_duration += (microtime(true) - $stamp);
718 self::$db_duration_stat += (microtime(true) - $stamp);
719 if ($process = DBA::fetch($processes)) {
720 $idle_workers -= $process["running"];
721 $waiting_processes += $entry["entries"];
722 $listitem[$entry["priority"]] = $entry["priority"].":".$process["running"]."/".$entry["entries"];
724 DBA::close($processes);
728 $waiting_processes = self::totalEntries();
729 $stamp = (float)microtime(true);
730 $jobs = DBA::p("SELECT COUNT(*) AS `running`, `priority` FROM `workerqueue-view` GROUP BY `priority` ORDER BY `priority`");
731 self::$db_duration += (microtime(true) - $stamp);
732 self::$db_duration_stat += (microtime(true) - $stamp);
734 while ($entry = DBA::fetch($jobs)) {
735 $idle_workers -= $entry["running"];
736 $listitem[$entry["priority"]] = $entry["priority"].":".$entry["running"];
741 $waiting_processes -= $deferred;
743 $listitem[0] = "0:" . max(0, $idle_workers);
745 $processlist .= ' ('.implode(', ', $listitem).')';
747 if (DI::config()->get("system", "worker_fastlane", false) && ($queues > 0) && ($active >= $queues) && self::entriesExists()) {
748 $top_priority = self::highestPriority();
749 $high_running = self::processWithPriorityActive($top_priority);
751 if (!$high_running && ($top_priority > PRIORITY_UNDEFINED) && ($top_priority < PRIORITY_NEGLIGIBLE)) {
752 Logger::info("Jobs with a higher priority are waiting but none is executed. Open a fastlane.", ['priority' => $top_priority]);
753 $queues = $active + 1;
757 Logger::notice("Load: " . $load ."/" . $maxsysload . " - processes: " . $deferred . "/" . $active . "/" . $waiting_processes . $processlist . " - maximum: " . $queues . "/" . $maxqueues);
759 // Are there fewer workers running as possible? Then fork a new one.
760 if (!DI::config()->get("system", "worker_dont_fork", false) && ($queues > ($active + 1)) && self::entriesExists()) {
761 Logger::info("There are fewer workers as possible, fork a new worker.", ['active' => $active, 'queues' => $queues]);
762 if (DI::config()->get('system', 'worker_daemon_mode', false)) {
763 self::IPCSetJobState(true);
770 // if there are too much worker, we don't spawn a new one.
771 if (DI::config()->get('system', 'worker_daemon_mode', false) && ($active > $queues)) {
772 self::IPCSetJobState(false);
775 return $active > $queues;
779 * Returns the number of active worker processes
781 * @return integer Number of active worker processes
784 private static function activeWorkers()
786 $stamp = (float)microtime(true);
787 $count = DBA::count('process', ['command' => 'Worker.php']);
788 self::$db_duration += (microtime(true) - $stamp);
789 self::$db_duration_count += (microtime(true) - $stamp);
794 * Returns the number of active worker processes
796 * @return array List of worker process ids
799 private static function getWorkerPIDList()
802 $stamp = (float)microtime(true);
804 $queues = DBA::p("SELECT `process`.`pid`, COUNT(`workerqueue`.`pid`) AS `entries` FROM `process`
805 LEFT JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid` AND NOT `workerqueue`.`done`
806 GROUP BY `process`.`pid`");
807 while ($queue = DBA::fetch($queues)) {
808 $ids[$queue['pid']] = $queue['entries'];
812 self::$db_duration += (microtime(true) - $stamp);
813 self::$db_duration_count += (microtime(true) - $stamp);
818 * Returns waiting jobs for the current process id
820 * @return array waiting workerqueue jobs
823 private static function getWaitingJobForPID()
825 $stamp = (float)microtime(true);
826 $r = DBA::select('workerqueue', [], ['pid' => getmypid(), 'done' => false]);
827 self::$db_duration += (microtime(true) - $stamp);
828 if (DBA::isResult($r)) {
829 return DBA::toArray($r);
837 * Returns the next jobs that should be executed
839 * @return array array with next jobs
842 private static function nextProcess(int $limit)
844 $priority = self::nextPriority();
845 if (empty($priority)) {
846 Logger::info('No tasks found');
851 $stamp = (float)microtime(true);
852 $condition = ["`priority` = ? AND `pid` = 0 AND NOT `done` AND `next_try` < ?", $priority, DateTimeFormat::utcNow()];
853 $tasks = DBA::select('workerqueue', ['id', 'parameter'], $condition, ['limit' => $limit, 'order' => ['created']]);
854 self::$db_duration += (microtime(true) - $stamp);
855 while ($task = DBA::fetch($tasks)) {
856 $ids[] = $task['id'];
857 // Only continue that loop while we are storing commands that can be processed quickly
858 $command = json_decode($task['parameter'])[0];
859 if (!in_array($command, self::FAST_COMMANDS)) {
865 Logger::info('Found:', ['priority' => $priority, 'id' => $ids]);
870 * Returns the priority of the next workerqueue job
872 * @return string priority
875 private static function nextPriority()
878 $priorities = [PRIORITY_CRITICAL, PRIORITY_HIGH, PRIORITY_MEDIUM, PRIORITY_LOW, PRIORITY_NEGLIGIBLE];
879 foreach ($priorities as $priority) {
880 $stamp = (float)microtime(true);
881 if (DBA::exists('workerqueue', ["`priority` = ? AND `pid` = 0 AND NOT `done` AND `next_try` < ?", $priority, DateTimeFormat::utcNow()])) {
882 $waiting[$priority] = true;
884 self::$db_duration += (microtime(true) - $stamp);
887 if (!empty($waiting[PRIORITY_CRITICAL])) {
888 return PRIORITY_CRITICAL;
893 $stamp = (float)microtime(true);
894 $processes = DBA::p("SELECT COUNT(DISTINCT(`pid`)) AS `running`, `priority` FROM `workerqueue-view` GROUP BY `priority`");
895 self::$db_duration += (microtime(true) - $stamp);
896 while ($process = DBA::fetch($processes)) {
897 $running[$process['priority']] = $process['running'];
898 $running_total += $process['running'];
900 DBA::close($processes);
902 foreach ($priorities as $priority) {
903 if (!empty($waiting[$priority]) && empty($running[$priority])) {
904 Logger::info('No running worker found with priority {priority} - assigning it.', ['priority' => $priority]);
909 $active = max(self::activeWorkers(), $running_total);
910 $priorities = max(count($waiting), count($running));
914 for ($i = 1; $i <= $priorities; ++$i) {
915 $total += pow($i, $exponent);
919 for ($i = 1; $i <= $priorities; ++$i) {
920 $limit[$priorities - $i] = max(1, round($active * (pow($i, $exponent) / $total)));
924 foreach ($running as $priority => $workers) {
925 if ($workers < $limit[$i++]) {
926 Logger::info('Priority {priority} has got {workers} workers out of a limit of {limit}', ['priority' => $priority, 'workers' => $workers, 'limit' => $limit[$i - 1]]);
931 if (!empty($waiting)) {
932 $priority = array_keys($waiting)[0];
933 Logger::info('No underassigned priority found, now taking the highest priority.', ['priority' => $priority]);
941 * Find and claim the next worker process for us
943 * @return boolean Have we found something?
944 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
946 private static function findWorkerProcesses()
948 $fetch_limit = DI::config()->get('system', 'worker_fetch_limit', 1);
950 if (DI::config()->get('system', 'worker_multiple_fetch')) {
952 foreach (self::getWorkerPIDList() as $pid => $count) {
953 if ($count <= $fetch_limit) {
960 $limit = $fetch_limit * count($pids);
962 $pids = [getmypid()];
963 $limit = $fetch_limit;
966 $ids = self::nextProcess($limit);
967 $limit -= count($ids);
969 // If there is not enough results we check without priority limit
971 $stamp = (float)microtime(true);
972 $condition = ["`pid` = 0 AND NOT `done` AND `next_try` < ?", DateTimeFormat::utcNow()];
973 $tasks = DBA::select('workerqueue', ['id', 'parameter'], $condition, ['limit' => $limit, 'order' => ['priority', 'created']]);
974 self::$db_duration += (microtime(true) - $stamp);
976 while ($task = DBA::fetch($tasks)) {
977 $ids[] = $task['id'];
978 // Only continue that loop while we are storing commands that can be processed quickly
979 $command = json_decode($task['parameter'])[0];
980 if (!in_array($command, self::FAST_COMMANDS)) {
991 // Assign the task ids to the workers
993 foreach (array_unique($ids) as $id) {
998 $worker[$pid][] = $id;
1001 $stamp = (float)microtime(true);
1002 foreach ($worker as $worker_pid => $worker_ids) {
1003 Logger::info('Set queue entry', ['pid' => $worker_pid, 'ids' => $worker_ids]);
1004 DBA::update('workerqueue', ['executed' => DateTimeFormat::utcNow(), 'pid' => $worker_pid],
1005 ['id' => $worker_ids, 'done' => false, 'pid' => 0]);
1007 self::$db_duration += (microtime(true) - $stamp);
1008 self::$db_duration_write += (microtime(true) - $stamp);
1012 * Returns the next worker process
1014 * @return array worker processes
1015 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1017 public static function workerProcess()
1019 // There can already be jobs for us in the queue.
1020 $waiting = self::getWaitingJobForPID();
1021 if (!empty($waiting)) {
1025 $stamp = (float)microtime(true);
1026 if (!DI::lock()->acquire(self::LOCK_PROCESS)) {
1029 self::$lock_duration += (microtime(true) - $stamp);
1031 self::findWorkerProcesses();
1033 DI::lock()->release(self::LOCK_PROCESS);
1035 return self::getWaitingJobForPID();
1039 * Removes a workerqueue entry from the current process
1042 * @throws \Exception
1044 public static function unclaimProcess()
1046 $mypid = getmypid();
1048 $stamp = (float)microtime(true);
1049 DBA::update('workerqueue', ['executed' => DBA::NULL_DATETIME, 'pid' => 0], ['pid' => $mypid, 'done' => false]);
1050 self::$db_duration += (microtime(true) - $stamp);
1051 self::$db_duration_write += (microtime(true) - $stamp);
1055 * Call the front end worker
1058 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1060 public static function callWorker()
1062 if (!DI::config()->get("system", "frontend_worker")) {
1066 $url = DI::baseUrl() . '/worker';
1067 DI::httpRequest()->fetch($url, false, 1);
1071 * Call the front end worker if there aren't any active
1074 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1076 public static function executeIfIdle()
1078 if (!DI::config()->get("system", "frontend_worker")) {
1082 // Do we have "proc_open"? Then we can fork the worker
1083 if (function_exists("proc_open")) {
1084 // When was the last time that we called the worker?
1085 // Less than one minute? Then we quit
1086 if ((time() - DI::config()->get("system", "worker_started")) < 60) {
1090 DI::config()->set("system", "worker_started", time());
1092 // Do we have enough running workers? Then we quit here.
1093 if (self::tooMuchWorkers()) {
1094 // Cleaning dead processes
1095 self::killStaleWorkers();
1096 DI::modelProcess()->deleteInactive();
1103 Logger::info('Call worker');
1104 self::spawnWorker();
1108 // We cannot execute background processes.
1109 // We now run the processes from the frontend.
1110 // This won't work with long running processes.
1113 self::clearProcesses();
1115 $workers = self::activeWorkers();
1117 if ($workers == 0) {
1123 * Removes long running worker processes
1126 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1128 public static function clearProcesses()
1130 $timeout = DI::config()->get("system", "frontend_worker_timeout", 10);
1132 /// @todo We should clean up the corresponding workerqueue entries as well
1133 $stamp = (float)microtime(true);
1134 $condition = ["`created` < ? AND `command` = 'worker.php'",
1135 DateTimeFormat::utc("now - ".$timeout." minutes")];
1136 DBA::delete('process', $condition);
1137 self::$db_duration = (microtime(true) - $stamp);
1138 self::$db_duration_write += (microtime(true) - $stamp);
1142 * Runs the cron processes
1145 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1147 private static function runCron()
1149 Logger::info('Add cron entries');
1151 // Check for spooled items
1152 self::add(['priority' => PRIORITY_HIGH, 'force_priority' => true], 'SpoolPost');
1154 // Run the cron job that calls all other jobs
1155 self::add(['priority' => PRIORITY_MEDIUM, 'force_priority' => true], 'Cron');
1157 // Cleaning dead processes
1158 self::killStaleWorkers();
1162 * Spawns a new worker
1164 * @param bool $do_cron
1166 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1168 public static function spawnWorker($do_cron = false)
1170 $command = 'bin/worker.php';
1172 $args = ['no_cron' => !$do_cron];
1175 $process = new Core\Process(DI::logger(), DI::mode(), DI::config(), DI::modelProcess(), $a->getBasePath(), getmypid());
1176 $process->run($command, $args);
1178 // after spawning we have to remove the flag.
1179 if (DI::config()->get('system', 'worker_daemon_mode', false)) {
1180 self::IPCSetJobState(false);
1185 * Adds tasks to the worker queue
1187 * @param (integer|array) priority or parameter array, strings are deprecated and are ignored
1189 * next args are passed as $cmd command line
1190 * or: Worker::add(PRIORITY_HIGH, "Notifier", Delivery::DELETION, $drop_id);
1191 * or: Worker::add(array('priority' => PRIORITY_HIGH, 'dont_fork' => true), "CreateShadowEntry", $post_id);
1193 * @return boolean "false" if worker queue entry already existed or there had been an error
1194 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1195 * @note $cmd and string args are surrounded with ""
1201 public static function add($cmd)
1203 $args = func_get_args();
1205 if (!count($args)) {
1209 $arr = ['args' => $args, 'run_cmd' => true];
1211 Hook::callAll("proc_run", $arr);
1212 if (!$arr['run_cmd'] || !count($args)) {
1216 $priority = PRIORITY_MEDIUM;
1217 // Don't fork from frontend tasks by default
1218 $dont_fork = DI::config()->get("system", "worker_dont_fork", false) || !DI::mode()->isBackend();
1219 $created = DateTimeFormat::utcNow();
1220 $force_priority = false;
1222 $run_parameter = array_shift($args);
1224 if (is_int($run_parameter)) {
1225 $priority = $run_parameter;
1226 } elseif (is_array($run_parameter)) {
1227 if (isset($run_parameter['priority'])) {
1228 $priority = $run_parameter['priority'];
1230 if (isset($run_parameter['created'])) {
1231 $created = $run_parameter['created'];
1233 if (isset($run_parameter['dont_fork'])) {
1234 $dont_fork = $run_parameter['dont_fork'];
1236 if (isset($run_parameter['force_priority'])) {
1237 $force_priority = $run_parameter['force_priority'];
1241 $parameters = json_encode($args);
1242 $found = DBA::exists('workerqueue', ['parameter' => $parameters, 'done' => false]);
1245 // Quit if there was a database error - a precaution for the update process to 3.5.3
1246 if (DBA::errorNo() != 0) {
1251 $added = DBA::insert('workerqueue', ['parameter' => $parameters, 'created' => $created, 'priority' => $priority]);
1255 } elseif ($force_priority) {
1256 DBA::update('workerqueue', ['priority' => $priority], ['parameter' => $parameters, 'done' => false, 'pid' => 0]);
1259 // Should we quit and wait for the worker to be called as a cronjob?
1264 // If there is a lock then we don't have to check for too much worker
1265 if (!DI::lock()->acquire(self::LOCK_WORKER, 0)) {
1269 // If there are already enough workers running, don't fork another one
1270 $quit = self::tooMuchWorkers();
1271 DI::lock()->release(self::LOCK_WORKER);
1277 // We tell the daemon that a new job entry exists
1278 if (DI::config()->get('system', 'worker_daemon_mode', false)) {
1279 // We don't have to set the IPC flag - this is done in "tooMuchWorkers"
1283 // Now call the worker to execute the jobs that we just added to the queue
1284 self::spawnWorker();
1290 * Returns the next retrial level for worker jobs.
1291 * This function will skip levels when jobs are older.
1293 * @param array $queue Worker queue entry
1294 * @param integer $max_level maximum retrial level
1295 * @return integer the next retrial level value
1297 private static function getNextRetrial($queue, $max_level)
1299 $created = strtotime($queue['created']);
1300 $retrial_time = time() - $created;
1302 $new_retrial = $queue['retrial'] + 1;
1304 for ($retrial = 0; $retrial <= $max_level + 1; ++$retrial) {
1305 $delay = (($retrial + 3) ** 4) + (rand(1, 30) * ($retrial + 1));
1307 if (($total < $retrial_time) && ($retrial > $queue['retrial'])) {
1308 $new_retrial = $retrial;
1311 Logger::info('New retrial for task', ['id' => $queue['id'], 'created' => $queue['created'], 'old' => $queue['retrial'], 'new' => $new_retrial]);
1312 return $new_retrial;
1316 * Defers the current worker entry
1318 * @return boolean had the entry been deferred?
1320 public static function defer()
1322 if (empty(DI::app()->queue)) {
1326 $queue = DI::app()->queue;
1328 $retrial = $queue['retrial'];
1330 $priority = $queue['priority'];
1332 $max_level = DI::config()->get('system', 'worker_defer_limit');
1334 $new_retrial = self::getNextRetrial($queue, $max_level);
1336 if ($new_retrial > $max_level) {
1337 Logger::info('The task exceeded the maximum retry count', ['id' => $id, 'created' => $queue['created'], 'old_prio' => $queue['priority'], 'old_retrial' => $queue['retrial'], 'max_level' => $max_level, 'retrial' => $new_retrial]);
1341 // Calculate the delay until the next trial
1342 $delay = (($new_retrial + 2) ** 4) + (rand(1, 30) * ($new_retrial));
1343 $next = DateTimeFormat::utc('now + ' . $delay . ' seconds');
1345 if (($priority < PRIORITY_MEDIUM) && ($new_retrial > 3)) {
1346 $priority = PRIORITY_MEDIUM;
1347 } elseif (($priority < PRIORITY_LOW) && ($new_retrial > 6)) {
1348 $priority = PRIORITY_LOW;
1349 } elseif (($priority < PRIORITY_NEGLIGIBLE) && ($new_retrial > 8)) {
1350 $priority = PRIORITY_NEGLIGIBLE;
1353 Logger::info('Deferred task', ['id' => $id, 'retrial' => $new_retrial, 'created' => $queue['created'], 'next_execution' => $next, 'old_prio' => $queue['priority'], 'new_prio' => $priority]);
1355 $stamp = (float)microtime(true);
1356 $fields = ['retrial' => $new_retrial, 'next_try' => $next, 'executed' => DBA::NULL_DATETIME, 'pid' => 0, 'priority' => $priority];
1357 DBA::update('workerqueue', $fields, ['id' => $id]);
1358 self::$db_duration += (microtime(true) - $stamp);
1359 self::$db_duration_write += (microtime(true) - $stamp);
1365 * Set the flag if some job is waiting
1367 * @param boolean $jobs Is there a waiting job?
1368 * @throws \Exception
1370 public static function IPCSetJobState($jobs)
1372 $stamp = (float)microtime(true);
1373 DBA::update('worker-ipc', ['jobs' => $jobs], ['key' => 1], true);
1374 self::$db_duration += (microtime(true) - $stamp);
1375 self::$db_duration_write += (microtime(true) - $stamp);
1379 * Checks if some worker job waits to be executed
1382 * @throws \Exception
1384 public static function IPCJobsExists()
1386 $stamp = (float)microtime(true);
1387 $row = DBA::selectFirst('worker-ipc', ['jobs'], ['key' => 1]);
1388 self::$db_duration += (microtime(true) - $stamp);
1390 // When we don't have a row, no job is running
1391 if (!DBA::isResult($row)) {
1395 return (bool)$row['jobs'];