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\Database\DBA;
27 use Friendica\Util\DateTimeFormat;
30 * Contains the class for the worker background job processing
34 const STATE_STARTUP = 1; // Worker is in startup. This takes most time.
35 const STATE_LONG_LOOP = 2; // Worker is processing the whole - long - loop.
36 const STATE_REFETCH = 3; // Worker had refetched jobs in the execution loop.
37 const STATE_SHORT_LOOP = 4; // Worker is processing preassigned jobs, thus saving much time.
39 const FAST_COMMANDS = ['APDelivery', 'Delivery'];
41 const LOCK_PROCESS = 'worker_process';
42 const LOCK_WORKER = 'worker';
44 private static $up_start;
45 private static $db_duration = 0;
46 private static $db_duration_count = 0;
47 private static $db_duration_write = 0;
48 private static $db_duration_stat = 0;
49 private static $lock_duration = 0;
50 private static $last_update;
51 private static $state;
54 * Processes the tasks that are in the workerqueue table
56 * @param boolean $run_cron Should the cron processes be executed?
58 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
60 public static function processQueue($run_cron = true)
62 // Ensure that all "strtotime" operations do run timezone independent
63 date_default_timezone_set('UTC');
65 self::$up_start = microtime(true);
67 // At first check the maximum load. We shouldn't continue with a high load
68 if (DI::process()->isMaxLoadReached()) {
69 Logger::notice('Pre check: maximum load reached, quitting.');
73 // We now start the process. This is done after the load check since this could increase the load.
74 DI::process()->start();
76 // Kill stale processes every 5 minutes
77 $last_cleanup = DI::config()->get('system', 'worker_last_cleaned', 0);
78 if (time() > ($last_cleanup + 300)) {
79 DI::config()->set('system', 'worker_last_cleaned', time());
80 self::killStaleWorkers();
83 // Check if the system is ready
84 if (!self::isReady()) {
88 // Now we start additional cron processes if we should do so
93 $last_check = $starttime = time();
94 self::$state = self::STATE_STARTUP;
96 // We fetch the next queue entry that is about to be executed
97 while ($r = self::workerProcess()) {
98 // Don't refetch when a worker fetches tasks for multiple workers
99 $refetched = DI::config()->get('system', 'worker_multiple_fetch');
100 foreach ($r as $entry) {
101 // Assure that the priority is an integer value
102 $entry['priority'] = (int)$entry['priority'];
104 // The work will be done
105 if (!self::execute($entry)) {
106 Logger::info('Process execution failed, quitting.');
110 // Trying to fetch new processes - but only once when successful
111 if (!$refetched && DI::lock()->acquire(self::LOCK_PROCESS, 0)) {
112 self::findWorkerProcesses();
113 DI::lock()->release(self::LOCK_PROCESS);
114 self::$state = self::STATE_REFETCH;
117 self::$state = self::STATE_SHORT_LOOP;
121 // To avoid the quitting of multiple workers only one worker at a time will execute the check
122 if ((time() > $last_check + 5) && !self::getWaitingJobForPID()) {
123 self::$state = self::STATE_LONG_LOOP;
125 if (DI::lock()->acquire(self::LOCK_WORKER, 0)) {
126 // Count active workers and compare them with a maximum value that depends on the load
127 if (self::tooMuchWorkers()) {
128 Logger::info('Active worker limit reached, quitting.');
129 DI::lock()->release(self::LOCK_WORKER);
134 if (DI::process()->isMinMemoryReached()) {
135 Logger::notice('Memory limit reached, quitting.');
136 DI::lock()->release(self::LOCK_WORKER);
139 DI::lock()->release(self::LOCK_WORKER);
141 $last_check = time();
144 // Quit the worker once every cron interval
145 if (time() > ($starttime + (DI::config()->get('system', 'cron_interval') * 60))) {
146 Logger::info('Process lifetime reached, respawning.');
147 self::unclaimProcess();
153 // Cleaning up. Possibly not needed, but it doesn't harm anything.
154 if (DI::config()->get('system', 'worker_daemon_mode', false)) {
155 self::IPCSetJobState(false);
157 Logger::info("Couldn't select a workerqueue entry, quitting process", ['pid' => getmypid()]);
161 * Checks if the system is ready.
163 * Several system parameters like memory, connections and processes are checked.
167 public static function isReady()
169 // Count active workers and compare them with a maximum value that depends on the load
170 if (self::tooMuchWorkers()) {
171 Logger::info('Active worker limit reached, quitting.');
175 // Do we have too few memory?
176 if (DI::process()->isMinMemoryReached()) {
177 Logger::notice('Memory limit reached, quitting.');
181 // Possibly there are too much database connections
182 if (self::maxConnectionsReached()) {
183 Logger::notice('Maximum connections reached, quitting.');
187 // Possibly there are too much database processes that block the system
188 if (DI::process()->isMaxProcessesReached()) {
189 Logger::notice('Maximum processes reached, quitting.');
197 * Check if non executed tasks do exist in the worker queue
199 * @return boolean Returns "true" if tasks are existing
202 public static function entriesExists()
204 $stamp = (float)microtime(true);
205 $exists = DBA::exists('workerqueue', ["NOT `done` AND `pid` = 0 AND `next_try` < ?", DateTimeFormat::utcNow()]);
206 self::$db_duration += (microtime(true) - $stamp);
211 * Returns the number of deferred entries in the worker queue
213 * @return integer Number of deferred entries in the worker queue
216 private static function deferredEntries()
218 $stamp = (float)microtime(true);
219 $count = DBA::count('workerqueue', ["NOT `done` AND `pid` = 0 AND `retrial` > ?", 0]);
220 self::$db_duration += (microtime(true) - $stamp);
221 self::$db_duration_count += (microtime(true) - $stamp);
226 * Returns the number of non executed entries in the worker queue
228 * @return integer Number of non executed entries in the worker queue
231 private static function totalEntries()
233 $stamp = (float)microtime(true);
234 $count = DBA::count('workerqueue', ['done' => false, 'pid' => 0]);
235 self::$db_duration += (microtime(true) - $stamp);
236 self::$db_duration_count += (microtime(true) - $stamp);
241 * Returns the highest priority in the worker queue that isn't executed
243 * @return integer Number of active worker processes
246 private static function highestPriority()
248 $stamp = (float)microtime(true);
249 $condition = ["`pid` = 0 AND NOT `done` AND `next_try` < ?", DateTimeFormat::utcNow()];
250 $workerqueue = DBA::selectFirst('workerqueue', ['priority'], $condition, ['order' => ['priority']]);
251 self::$db_duration += (microtime(true) - $stamp);
252 if (DBA::isResult($workerqueue)) {
253 return $workerqueue["priority"];
260 * Returns if a process with the given priority is running
262 * @param integer $priority The priority that should be checked
264 * @return integer Is there a process running with that priority?
267 private static function processWithPriorityActive($priority)
269 $condition = ["`priority` <= ? AND `pid` != 0 AND NOT `done`", $priority];
270 return DBA::exists('workerqueue', $condition);
274 * Execute a worker entry
276 * @param array $queue Workerqueue entry
278 * @return boolean "true" if further processing should be stopped
279 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
281 public static function execute($queue)
285 // Quit when in maintenance
286 if (DI::config()->get('system', 'maintenance', false, true)) {
287 Logger::notice("Maintenance mode - quit process", ['pid' => $mypid]);
291 // Constantly check the number of parallel database processes
292 if (DI::process()->isMaxProcessesReached()) {
293 Logger::notice("Max processes reached for process", ['pid' => $mypid]);
297 // Constantly check the number of available database connections to let the frontend be accessible at any time
298 if (self::maxConnectionsReached()) {
299 Logger::notice("Max connection reached for process", ['pid' => $mypid]);
303 $argv = json_decode($queue["parameter"], true);
305 Logger::warning('Parameter is empty', ['queue' => $queue]);
309 // Check for existance and validity of the include file
312 if (method_exists(sprintf('Friendica\Worker\%s', $include), 'execute')) {
313 // We constantly update the "executed" date every minute to avoid being killed too soon
314 if (!isset(self::$last_update)) {
315 self::$last_update = strtotime($queue["executed"]);
318 $age = (time() - self::$last_update) / 60;
319 self::$last_update = time();
322 $stamp = (float)microtime(true);
323 DBA::update('workerqueue', ['executed' => DateTimeFormat::utcNow()], ['pid' => $mypid, 'done' => false]);
324 self::$db_duration += (microtime(true) - $stamp);
325 self::$db_duration_write += (microtime(true) - $stamp);
330 self::execFunction($queue, $include, $argv, true);
332 $stamp = (float)microtime(true);
333 $condition = ["`id` = ? AND `next_try` < ?", $queue['id'], DateTimeFormat::utcNow()];
334 if (DBA::update('workerqueue', ['done' => true], $condition)) {
335 DI::config()->set('system', 'last_worker_execution', DateTimeFormat::utcNow());
337 self::$db_duration = (microtime(true) - $stamp);
338 self::$db_duration_write += (microtime(true) - $stamp);
343 // The script could be provided as full path or only with the function name
344 if ($include == basename($include)) {
345 $include = "include/".$include.".php";
348 if (!validate_include($include)) {
349 Logger::warning("Include file is not valid", ['file' => $argv[0]]);
350 $stamp = (float)microtime(true);
351 DBA::delete('workerqueue', ['id' => $queue["id"]]);
352 self::$db_duration = (microtime(true) - $stamp);
353 self::$db_duration_write += (microtime(true) - $stamp);
357 require_once $include;
359 $funcname = str_replace(".php", "", basename($argv[0]))."_run";
361 if (function_exists($funcname)) {
362 // We constantly update the "executed" date every minute to avoid being killed too soon
363 if (!isset(self::$last_update)) {
364 self::$last_update = strtotime($queue["executed"]);
367 $age = (time() - self::$last_update) / 60;
368 self::$last_update = time();
371 $stamp = (float)microtime(true);
372 DBA::update('workerqueue', ['executed' => DateTimeFormat::utcNow()], ['pid' => $mypid, 'done' => false]);
373 self::$db_duration += (microtime(true) - $stamp);
374 self::$db_duration_write += (microtime(true) - $stamp);
377 self::execFunction($queue, $funcname, $argv, false);
379 $stamp = (float)microtime(true);
380 if (DBA::update('workerqueue', ['done' => true], ['id' => $queue["id"]])) {
381 DI::config()->set('system', 'last_worker_execution', DateTimeFormat::utcNow());
383 self::$db_duration = (microtime(true) - $stamp);
384 self::$db_duration_write += (microtime(true) - $stamp);
386 Logger::warning("Function does not exist", ['function' => $funcname]);
387 $stamp = (float)microtime(true);
388 DBA::delete('workerqueue', ['id' => $queue["id"]]);
389 self::$db_duration = (microtime(true) - $stamp);
390 self::$db_duration_write += (microtime(true) - $stamp);
397 * Execute a function from the queue
399 * @param array $queue Workerqueue entry
400 * @param string $funcname name of the function
401 * @param array $argv Array of values to be passed to the function
402 * @param boolean $method_call boolean
404 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
406 private static function execFunction($queue, $funcname, $argv, $method_call)
410 Logger::enableWorker($funcname);
412 Logger::info("Process start.", ['priority' => $queue["priority"], 'id' => $queue["id"]]);
414 $stamp = (float)microtime(true);
416 // We use the callstack here to analyze the performance of executed worker entries.
417 // For this reason the variables have to be initialized.
418 DI::profiler()->reset();
422 $up_duration = microtime(true) - self::$up_start;
424 // Reset global data to avoid interferences
427 // Set the workerLogger as new default logger
429 call_user_func_array(sprintf('Friendica\Worker\%s::execute', $funcname), $argv);
431 $funcname($argv, count($argv));
434 Logger::disableWorker();
438 $duration = (microtime(true) - $stamp);
440 /* With these values we can analyze how effective the worker is.
441 * The database and rest time should be low since this is the unproductive time.
442 * The execution time is the productive time.
443 * By changing parameters like the maximum number of workers we can check the effectivness.
445 $dbtotal = round(self::$db_duration, 2);
446 $dbread = round(self::$db_duration - (self::$db_duration_count + self::$db_duration_write + self::$db_duration_stat), 2);
447 $dbcount = round(self::$db_duration_count, 2);
448 $dbstat = round(self::$db_duration_stat, 2);
449 $dbwrite = round(self::$db_duration_write, 2);
450 $dblock = round(self::$lock_duration, 2);
451 $rest = round(max(0, $up_duration - (self::$db_duration + self::$lock_duration)), 2);
452 $exec = round($duration, 2);
454 Logger::info('Performance:', ['state' => self::$state, 'count' => $dbcount, 'stat' => $dbstat, 'write' => $dbwrite, 'lock' => $dblock, 'total' => $dbtotal, 'rest' => $rest, 'exec' => $exec]);
456 self::$up_start = microtime(true);
457 self::$db_duration = 0;
458 self::$db_duration_count = 0;
459 self::$db_duration_stat = 0;
460 self::$db_duration_write = 0;
461 self::$lock_duration = 0;
463 if ($duration > 3600) {
464 Logger::info('Longer than 1 hour.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'duration' => round($duration/60, 3)]);
465 } elseif ($duration > 600) {
466 Logger::info('Longer than 10 minutes.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'duration' => round($duration/60, 3)]);
467 } elseif ($duration > 300) {
468 Logger::info('Longer than 5 minutes.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'duration' => round($duration/60, 3)]);
469 } elseif ($duration > 120) {
470 Logger::info('Longer than 2 minutes.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'duration' => round($duration/60, 3)]);
473 Logger::info('Process done.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'duration' => round($duration, 3)]);
475 DI::profiler()->saveLog(DI::logger(), "ID " . $queue["id"] . ": " . $funcname);
477 $cooldown = DI::config()->get("system", "worker_cooldown", 0);
480 Logger::info('Cooldown.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'cooldown' => $cooldown]);
486 * Checks if the number of database connections has reached a critical limit.
488 * @return bool Are more than 3/4 of the maximum connections used?
489 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
491 private static function maxConnectionsReached()
493 // Fetch the max value from the config. This is needed when the system cannot detect the correct value by itself.
494 $max = DI::config()->get("system", "max_connections");
496 // Fetch the percentage level where the worker will get active
497 $maxlevel = DI::config()->get("system", "max_connections_level", 75);
500 // the maximum number of possible user connections can be a system variable
501 $r = DBA::fetchFirst("SHOW VARIABLES WHERE `variable_name` = 'max_user_connections'");
502 if (DBA::isResult($r)) {
505 // Or it can be granted. This overrides the system variable
506 $stamp = (float)microtime(true);
507 $r = DBA::p('SHOW GRANTS');
508 self::$db_duration += (microtime(true) - $stamp);
509 while ($grants = DBA::fetch($r)) {
510 $grant = array_pop($grants);
511 if (stristr($grant, "GRANT USAGE ON")) {
512 if (preg_match("/WITH MAX_USER_CONNECTIONS (\d*)/", $grant, $match)) {
520 // If $max is set we will use the processlist to determine the current number of connections
521 // The processlist only shows entries of the current user
523 $stamp = (float)microtime(true);
524 $r = DBA::p('SHOW PROCESSLIST');
525 self::$db_duration += (microtime(true) - $stamp);
526 $used = DBA::numRows($r);
529 Logger::info("Connection usage (user values)", ['usage' => $used, 'max' => $max]);
531 $level = ($used / $max) * 100;
533 if ($level >= $maxlevel) {
534 Logger::notice("Maximum level (".$maxlevel."%) of user connections reached: ".$used."/".$max);
539 // We will now check for the system values.
540 // This limit could be reached although the user limits are fine.
541 $r = DBA::fetchFirst("SHOW VARIABLES WHERE `variable_name` = 'max_connections'");
542 if (!DBA::isResult($r)) {
545 $max = intval($r["Value"]);
549 $r = DBA::fetchFirst("SHOW STATUS WHERE `variable_name` = 'Threads_connected'");
550 if (!DBA::isResult($r)) {
553 $used = intval($r["Value"]);
557 Logger::info("Connection usage (system values)", ['used' => $used, 'max' => $max]);
559 $level = $used / $max * 100;
561 if ($level < $maxlevel) {
564 Logger::notice("Maximum level (".$level."%) of system connections reached: ".$used."/".$max);
569 * fix the queue entry if the worker process died
574 private static function killStaleWorkers()
576 $stamp = (float)microtime(true);
577 $entries = DBA::select(
579 ['id', 'pid', 'executed', 'priority', 'parameter'],
580 ['NOT `done` AND `pid` != 0'],
581 ['order' => ['priority', 'retrial', 'created']]
583 self::$db_duration += (microtime(true) - $stamp);
585 while ($entry = DBA::fetch($entries)) {
586 if (!posix_kill($entry["pid"], 0)) {
587 $stamp = (float)microtime(true);
590 ['executed' => DBA::NULL_DATETIME, 'pid' => 0],
591 ['id' => $entry["id"]]
593 self::$db_duration += (microtime(true) - $stamp);
594 self::$db_duration_write += (microtime(true) - $stamp);
596 // Kill long running processes
597 // Check if the priority is in a valid range
598 if (!in_array($entry["priority"], [PRIORITY_CRITICAL, PRIORITY_HIGH, PRIORITY_MEDIUM, PRIORITY_LOW, PRIORITY_NEGLIGIBLE])) {
599 $entry["priority"] = PRIORITY_MEDIUM;
602 // Define the maximum durations
603 $max_duration_defaults = [PRIORITY_CRITICAL => 720, PRIORITY_HIGH => 10, PRIORITY_MEDIUM => 60, PRIORITY_LOW => 180, PRIORITY_NEGLIGIBLE => 720];
604 $max_duration = $max_duration_defaults[$entry["priority"]];
606 $argv = json_decode($entry["parameter"], true);
611 $argv[0] = basename($argv[0]);
613 // How long is the process already running?
614 $duration = (time() - strtotime($entry["executed"])) / 60;
615 if ($duration > $max_duration) {
616 Logger::notice("Worker process ".$entry["pid"]." (".substr(json_encode($argv), 0, 50).") took more than ".$max_duration." minutes. It will be killed now.");
617 posix_kill($entry["pid"], SIGTERM);
619 // We killed the stale process.
620 // To avoid a blocking situation we reschedule the process at the beginning of the queue.
621 // Additionally we are lowering the priority. (But not PRIORITY_CRITICAL)
622 $new_priority = $entry["priority"];
623 if ($entry["priority"] == PRIORITY_HIGH) {
624 $new_priority = PRIORITY_MEDIUM;
625 } elseif ($entry["priority"] == PRIORITY_MEDIUM) {
626 $new_priority = PRIORITY_LOW;
627 } elseif ($entry["priority"] != PRIORITY_CRITICAL) {
628 $new_priority = PRIORITY_NEGLIGIBLE;
630 $stamp = (float)microtime(true);
633 ['executed' => DBA::NULL_DATETIME, 'created' => DateTimeFormat::utcNow(), 'priority' => $new_priority, 'pid' => 0],
634 ['id' => $entry["id"]]
636 self::$db_duration += (microtime(true) - $stamp);
637 self::$db_duration_write += (microtime(true) - $stamp);
639 Logger::info('Process runtime is okay', ['pid' => $entry["pid"], 'duration' => $duration, 'max' => $max_duration, 'command' => substr(json_encode($argv), 0, 50)]);
643 DBA::close($entries);
647 * Checks if the number of active workers exceeds the given limits
649 * @return bool Are there too much workers running?
650 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
652 private static function tooMuchWorkers()
654 $queues = DI::config()->get("system", "worker_queues", 10);
656 $maxqueues = $queues;
658 $active = self::activeWorkers();
660 // Decrease the number of workers at higher load
661 $load = System::currentLoad();
663 $maxsysload = intval(DI::config()->get("system", "maxloadavg", 20));
665 /* Default exponent 3 causes queues to rapidly decrease as load increases.
666 * If you have 20 max queues at idle, then you get only 5 queues at 37.1% of $maxsysload.
667 * For some environments, this rapid decrease is not needed.
668 * With exponent 1, you could have 20 max queues at idle and 13 at 37% of $maxsysload.
670 $exponent = intval(DI::config()->get('system', 'worker_load_exponent', 3));
671 $slope = pow(max(0, $maxsysload - $load) / $maxsysload, $exponent);
672 $queues = intval(ceil($slope * $maxqueues));
676 if (DI::config()->get('system', 'worker_jpm')) {
677 $intervals = explode(',', DI::config()->get('system', 'worker_jpm_range'));
678 $jobs_per_minute = [];
679 foreach ($intervals as $interval) {
680 if ($interval == 0) {
683 $interval = (int)$interval;
686 $stamp = (float)microtime(true);
687 $jobs = DBA::p("SELECT COUNT(*) AS `jobs` FROM `workerqueue` WHERE `done` AND `executed` > UTC_TIMESTAMP() - INTERVAL ? MINUTE", $interval);
688 self::$db_duration += (microtime(true) - $stamp);
689 self::$db_duration_stat += (microtime(true) - $stamp);
690 if ($job = DBA::fetch($jobs)) {
691 $jobs_per_minute[$interval] = number_format($job['jobs'] / $interval, 0);
695 $processlist = ' - jpm: '.implode('/', $jobs_per_minute);
698 // Create a list of queue entries grouped by their priority
699 $listitem = [0 => ''];
701 $idle_workers = $active;
703 $deferred = self::deferredEntries();
705 if (DI::config()->get('system', 'worker_debug')) {
706 $waiting_processes = 0;
707 // Now adding all processes with workerqueue entries
708 $stamp = (float)microtime(true);
709 $jobs = DBA::p("SELECT COUNT(*) AS `entries`, `priority` FROM `workerqueue` WHERE NOT `done` GROUP BY `priority`");
710 self::$db_duration += (microtime(true) - $stamp);
711 self::$db_duration_stat += (microtime(true) - $stamp);
712 while ($entry = DBA::fetch($jobs)) {
713 $stamp = (float)microtime(true);
714 $processes = DBA::p("SELECT COUNT(*) AS `running` FROM `workerqueue-view` WHERE `priority` = ?", $entry["priority"]);
715 self::$db_duration += (microtime(true) - $stamp);
716 self::$db_duration_stat += (microtime(true) - $stamp);
717 if ($process = DBA::fetch($processes)) {
718 $idle_workers -= $process["running"];
719 $waiting_processes += $entry["entries"];
720 $listitem[$entry["priority"]] = $entry["priority"].":".$process["running"]."/".$entry["entries"];
722 DBA::close($processes);
726 $waiting_processes = self::totalEntries();
727 $stamp = (float)microtime(true);
728 $jobs = DBA::p("SELECT COUNT(*) AS `running`, `priority` FROM `workerqueue-view` GROUP BY `priority` ORDER BY `priority`");
729 self::$db_duration += (microtime(true) - $stamp);
730 self::$db_duration_stat += (microtime(true) - $stamp);
732 while ($entry = DBA::fetch($jobs)) {
733 $idle_workers -= $entry["running"];
734 $listitem[$entry["priority"]] = $entry["priority"].":".$entry["running"];
739 $waiting_processes -= $deferred;
741 $listitem[0] = "0:" . max(0, $idle_workers);
743 $processlist .= ' ('.implode(', ', $listitem).')';
745 if (DI::config()->get("system", "worker_fastlane", false) && ($queues > 0) && ($active >= $queues) && self::entriesExists()) {
746 $top_priority = self::highestPriority();
747 $high_running = self::processWithPriorityActive($top_priority);
749 if (!$high_running && ($top_priority > PRIORITY_UNDEFINED) && ($top_priority < PRIORITY_NEGLIGIBLE)) {
750 Logger::info("Jobs with a higher priority are waiting but none is executed. Open a fastlane.", ['priority' => $top_priority]);
751 $queues = $active + 1;
755 Logger::notice("Load: " . $load ."/" . $maxsysload . " - processes: " . $deferred . "/" . $active . "/" . $waiting_processes . $processlist . " - maximum: " . $queues . "/" . $maxqueues);
757 // Are there fewer workers running as possible? Then fork a new one.
758 if (!DI::config()->get("system", "worker_dont_fork", false) && ($queues > ($active + 1)) && self::entriesExists()) {
759 Logger::info("There are fewer workers as possible, fork a new worker.", ['active' => $active, 'queues' => $queues]);
760 if (DI::config()->get('system', 'worker_daemon_mode', false)) {
761 self::IPCSetJobState(true);
768 // if there are too much worker, we don't spawn a new one.
769 if (DI::config()->get('system', 'worker_daemon_mode', false) && ($active > $queues)) {
770 self::IPCSetJobState(false);
773 return $active > $queues;
777 * Returns the number of active worker processes
779 * @return integer Number of active worker processes
782 private static function activeWorkers()
784 $stamp = (float)microtime(true);
785 $count = DBA::count('process', ['command' => 'Worker.php']);
786 self::$db_duration += (microtime(true) - $stamp);
787 self::$db_duration_count += (microtime(true) - $stamp);
792 * Returns the number of active worker processes
794 * @return array List of worker process ids
797 private static function getWorkerPIDList()
800 $stamp = (float)microtime(true);
802 $queues = DBA::p("SELECT `process`.`pid`, COUNT(`workerqueue`.`pid`) AS `entries` FROM `process`
803 LEFT JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid` AND NOT `workerqueue`.`done`
804 GROUP BY `process`.`pid`");
805 while ($queue = DBA::fetch($queues)) {
806 $ids[$queue['pid']] = $queue['entries'];
810 self::$db_duration += (microtime(true) - $stamp);
811 self::$db_duration_count += (microtime(true) - $stamp);
816 * Returns waiting jobs for the current process id
818 * @return array waiting workerqueue jobs
821 private static function getWaitingJobForPID()
823 $stamp = (float)microtime(true);
824 $r = DBA::select('workerqueue', [], ['pid' => getmypid(), 'done' => false]);
825 self::$db_duration += (microtime(true) - $stamp);
826 if (DBA::isResult($r)) {
827 return DBA::toArray($r);
835 * Returns the next jobs that should be executed
837 * @return array array with next jobs
840 private static function nextProcess(int $limit)
842 $priority = self::nextPriority();
843 if (empty($priority)) {
844 Logger::info('No tasks found');
849 $stamp = (float)microtime(true);
850 $condition = ["`priority` = ? AND `pid` = 0 AND NOT `done` AND `next_try` < ?", $priority, DateTimeFormat::utcNow()];
851 $tasks = DBA::select('workerqueue', ['id', 'parameter'], $condition, ['limit' => $limit, 'order' => ['retrial', 'created']]);
852 self::$db_duration += (microtime(true) - $stamp);
853 while ($task = DBA::fetch($tasks)) {
854 $ids[] = $task['id'];
855 // Only continue that loop while we are storing commands that can be processed quickly
856 $command = json_decode($task['parameter'])[0];
857 if (!in_array($command, self::FAST_COMMANDS)) {
863 Logger::info('Found:', ['priority' => $priority, 'id' => $ids]);
868 * Returns the priority of the next workerqueue job
870 * @return string priority
873 private static function nextPriority()
876 $priorities = [PRIORITY_CRITICAL, PRIORITY_HIGH, PRIORITY_MEDIUM, PRIORITY_LOW, PRIORITY_NEGLIGIBLE];
877 foreach ($priorities as $priority) {
878 $stamp = (float)microtime(true);
879 if (DBA::exists('workerqueue', ["`priority` = ? AND `pid` = 0 AND NOT `done` AND `next_try` < ?", $priority, DateTimeFormat::utcNow()])) {
880 $waiting[$priority] = true;
882 self::$db_duration += (microtime(true) - $stamp);
885 if (!empty($waiting[PRIORITY_CRITICAL])) {
886 return PRIORITY_CRITICAL;
891 $stamp = (float)microtime(true);
892 $processes = DBA::p("SELECT COUNT(DISTINCT(`pid`)) AS `running`, `priority` FROM `workerqueue-view` GROUP BY `priority`");
893 self::$db_duration += (microtime(true) - $stamp);
894 while ($process = DBA::fetch($processes)) {
895 $running[$process['priority']] = $process['running'];
896 $running_total += $process['running'];
898 DBA::close($processes);
900 foreach ($priorities as $priority) {
901 if (!empty($waiting[$priority]) && empty($running[$priority])) {
902 Logger::info('No running worker found with priority {priority} - assigning it.', ['priority' => $priority]);
907 $active = max(self::activeWorkers(), $running_total);
908 $priorities = max(count($waiting), count($running));
912 for ($i = 1; $i <= $priorities; ++$i) {
913 $total += pow($i, $exponent);
917 for ($i = 1; $i <= $priorities; ++$i) {
918 $limit[$priorities - $i] = max(1, round($active * (pow($i, $exponent) / $total)));
922 foreach ($running as $priority => $workers) {
923 if ($workers < $limit[$i++]) {
924 Logger::info('Priority {priority} has got {workers} workers out of a limit of {limit}', ['priority' => $priority, 'workers' => $workers, 'limit' => $limit[$i - 1]]);
929 if (!empty($waiting)) {
930 $priority = array_keys($waiting)[0];
931 Logger::info('No underassigned priority found, now taking the highest priority.', ['priority' => $priority]);
939 * Find and claim the next worker process for us
941 * @return boolean Have we found something?
942 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
944 private static function findWorkerProcesses()
946 $fetch_limit = DI::config()->get('system', 'worker_fetch_limit', 1);
948 if (DI::config()->get('system', 'worker_multiple_fetch')) {
950 foreach (self::getWorkerPIDList() as $pid => $count) {
951 if ($count <= $fetch_limit) {
958 $limit = $fetch_limit * count($pids);
960 $pids = [getmypid()];
961 $limit = $fetch_limit;
964 $ids = self::nextProcess($limit);
965 $limit -= count($ids);
967 // If there is not enough results we check without priority limit
969 $stamp = (float)microtime(true);
970 $condition = ["`pid` = 0 AND NOT `done` AND `next_try` < ?", DateTimeFormat::utcNow()];
971 $tasks = DBA::select('workerqueue', ['id', 'parameter'], $condition, ['limit' => $limit, 'order' => ['priority', 'retrial', 'created']]);
972 self::$db_duration += (microtime(true) - $stamp);
974 while ($task = DBA::fetch($tasks)) {
975 $ids[] = $task['id'];
976 // Only continue that loop while we are storing commands that can be processed quickly
977 $command = json_decode($task['parameter'])[0];
978 if (!in_array($command, self::FAST_COMMANDS)) {
989 // Assign the task ids to the workers
991 foreach (array_unique($ids) as $id) {
996 $worker[$pid][] = $id;
999 $stamp = (float)microtime(true);
1000 foreach ($worker as $worker_pid => $worker_ids) {
1001 Logger::info('Set queue entry', ['pid' => $worker_pid, 'ids' => $worker_ids]);
1002 DBA::update('workerqueue', ['executed' => DateTimeFormat::utcNow(), 'pid' => $worker_pid],
1003 ['id' => $worker_ids, 'done' => false, 'pid' => 0]);
1005 self::$db_duration += (microtime(true) - $stamp);
1006 self::$db_duration_write += (microtime(true) - $stamp);
1010 * Returns the next worker process
1012 * @return array worker processes
1013 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1015 public static function workerProcess()
1017 // There can already be jobs for us in the queue.
1018 $waiting = self::getWaitingJobForPID();
1019 if (!empty($waiting)) {
1023 $stamp = (float)microtime(true);
1024 if (!DI::lock()->acquire(self::LOCK_PROCESS)) {
1027 self::$lock_duration += (microtime(true) - $stamp);
1029 self::findWorkerProcesses();
1031 DI::lock()->release(self::LOCK_PROCESS);
1033 return self::getWaitingJobForPID();
1037 * Removes a workerqueue entry from the current process
1040 * @throws \Exception
1042 public static function unclaimProcess()
1044 $mypid = getmypid();
1046 $stamp = (float)microtime(true);
1047 DBA::update('workerqueue', ['executed' => DBA::NULL_DATETIME, 'pid' => 0], ['pid' => $mypid, 'done' => false]);
1048 self::$db_duration += (microtime(true) - $stamp);
1049 self::$db_duration_write += (microtime(true) - $stamp);
1053 * Call the front end worker
1056 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1058 public static function callWorker()
1060 if (!DI::config()->get("system", "frontend_worker")) {
1064 $url = DI::baseUrl() . '/worker';
1065 DI::httpRequest()->fetch($url, 1);
1069 * Call the front end worker if there aren't any active
1072 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1074 public static function executeIfIdle()
1076 if (!DI::config()->get("system", "frontend_worker")) {
1080 // Do we have "proc_open"? Then we can fork the worker
1081 if (function_exists("proc_open")) {
1082 // When was the last time that we called the worker?
1083 // Less than one minute? Then we quit
1084 if ((time() - DI::config()->get("system", "worker_started")) < 60) {
1088 DI::config()->set("system", "worker_started", time());
1090 // Do we have enough running workers? Then we quit here.
1091 if (self::tooMuchWorkers()) {
1092 // Cleaning dead processes
1093 self::killStaleWorkers();
1094 DI::modelProcess()->deleteInactive();
1101 Logger::info('Call worker');
1102 self::spawnWorker();
1106 // We cannot execute background processes.
1107 // We now run the processes from the frontend.
1108 // This won't work with long running processes.
1111 self::clearProcesses();
1113 $workers = self::activeWorkers();
1115 if ($workers == 0) {
1121 * Removes long running worker processes
1124 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1126 public static function clearProcesses()
1128 $timeout = DI::config()->get("system", "frontend_worker_timeout", 10);
1130 /// @todo We should clean up the corresponding workerqueue entries as well
1131 $stamp = (float)microtime(true);
1132 $condition = ["`created` < ? AND `command` = 'worker.php'",
1133 DateTimeFormat::utc("now - ".$timeout." minutes")];
1134 DBA::delete('process', $condition);
1135 self::$db_duration = (microtime(true) - $stamp);
1136 self::$db_duration_write += (microtime(true) - $stamp);
1140 * Runs the cron processes
1143 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1145 private static function runCron()
1147 Logger::info('Add cron entries');
1149 // Check for spooled items
1150 self::add(['priority' => PRIORITY_HIGH, 'force_priority' => true], 'SpoolPost');
1152 // Run the cron job that calls all other jobs
1153 self::add(['priority' => PRIORITY_MEDIUM, 'force_priority' => true], 'Cron');
1155 // Cleaning dead processes
1156 self::killStaleWorkers();
1160 * Spawns a new worker
1162 * @param bool $do_cron
1164 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1166 public static function spawnWorker($do_cron = false)
1168 $command = 'bin/worker.php';
1170 $args = ['no_cron' => !$do_cron];
1173 $process = new Core\Process(DI::logger(), DI::mode(), DI::config(), DI::modelProcess(), $a->getBasePath(), getmypid());
1174 $process->run($command, $args);
1176 // after spawning we have to remove the flag.
1177 if (DI::config()->get('system', 'worker_daemon_mode', false)) {
1178 self::IPCSetJobState(false);
1183 * Adds tasks to the worker queue
1185 * @param (integer|array) priority or parameter array, strings are deprecated and are ignored
1187 * next args are passed as $cmd command line
1188 * or: Worker::add(PRIORITY_HIGH, "Notifier", Delivery::DELETION, $drop_id);
1189 * or: Worker::add(array('priority' => PRIORITY_HIGH, 'dont_fork' => true), "Delivery", $post_id);
1191 * @return boolean "false" if worker queue entry already existed or there had been an error
1192 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1193 * @note $cmd and string args are surrounded with ""
1199 public static function add($cmd)
1201 $args = func_get_args();
1203 if (!count($args)) {
1207 $arr = ['args' => $args, 'run_cmd' => true];
1209 Hook::callAll("proc_run", $arr);
1210 if (!$arr['run_cmd'] || !count($args)) {
1214 $priority = PRIORITY_MEDIUM;
1215 // Don't fork from frontend tasks by default
1216 $dont_fork = DI::config()->get("system", "worker_dont_fork", false) || !DI::mode()->isBackend();
1217 $created = DateTimeFormat::utcNow();
1218 $force_priority = false;
1220 $run_parameter = array_shift($args);
1222 if (is_int($run_parameter)) {
1223 $priority = $run_parameter;
1224 } elseif (is_array($run_parameter)) {
1225 if (isset($run_parameter['priority'])) {
1226 $priority = $run_parameter['priority'];
1228 if (isset($run_parameter['created'])) {
1229 $created = $run_parameter['created'];
1231 if (isset($run_parameter['dont_fork'])) {
1232 $dont_fork = $run_parameter['dont_fork'];
1234 if (isset($run_parameter['force_priority'])) {
1235 $force_priority = $run_parameter['force_priority'];
1239 $parameters = json_encode($args);
1240 $found = DBA::exists('workerqueue', ['parameter' => $parameters, 'done' => false]);
1243 // Quit if there was a database error - a precaution for the update process to 3.5.3
1244 if (DBA::errorNo() != 0) {
1249 $added = DBA::insert('workerqueue', ['parameter' => $parameters, 'created' => $created, 'priority' => $priority]);
1253 } elseif ($force_priority) {
1254 DBA::update('workerqueue', ['priority' => $priority], ['parameter' => $parameters, 'done' => false, 'pid' => 0]);
1257 // Set the IPC flag to ensure an immediate process execution via daemon
1258 if (DI::config()->get('system', 'worker_daemon_mode', false)) {
1259 self::IPCSetJobState(true);
1262 // Should we quit and wait for the worker to be called as a cronjob?
1267 // If there is a lock then we don't have to check for too much worker
1268 if (!DI::lock()->acquire(self::LOCK_WORKER, 0)) {
1272 // If there are already enough workers running, don't fork another one
1273 $quit = self::tooMuchWorkers();
1274 DI::lock()->release(self::LOCK_WORKER);
1280 // Quit on daemon mode
1281 if (DI::config()->get('system', 'worker_daemon_mode', false)) {
1285 // Now call the worker to execute the jobs that we just added to the queue
1286 self::spawnWorker();
1292 * Returns the next retrial level for worker jobs.
1293 * This function will skip levels when jobs are older.
1295 * @param array $queue Worker queue entry
1296 * @param integer $max_level maximum retrial level
1297 * @return integer the next retrial level value
1299 private static function getNextRetrial($queue, $max_level)
1301 $created = strtotime($queue['created']);
1302 $retrial_time = time() - $created;
1304 $new_retrial = $queue['retrial'] + 1;
1306 for ($retrial = 0; $retrial <= $max_level + 1; ++$retrial) {
1307 $delay = (($retrial + 3) ** 4) + (rand(1, 30) * ($retrial + 1));
1309 if (($total < $retrial_time) && ($retrial > $queue['retrial'])) {
1310 $new_retrial = $retrial;
1313 Logger::info('New retrial for task', ['id' => $queue['id'], 'created' => $queue['created'], 'old' => $queue['retrial'], 'new' => $new_retrial]);
1314 return $new_retrial;
1318 * Defers the current worker entry
1320 * @return boolean had the entry been deferred?
1322 public static function defer()
1324 if (empty(DI::app()->queue)) {
1328 $queue = DI::app()->queue;
1330 $retrial = $queue['retrial'];
1332 $priority = $queue['priority'];
1334 $max_level = DI::config()->get('system', 'worker_defer_limit');
1336 $new_retrial = self::getNextRetrial($queue, $max_level);
1338 if ($new_retrial > $max_level) {
1339 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]);
1343 // Calculate the delay until the next trial
1344 $delay = (($new_retrial + 2) ** 4) + (rand(1, 30) * ($new_retrial));
1345 $next = DateTimeFormat::utc('now + ' . $delay . ' seconds');
1347 if (($priority < PRIORITY_MEDIUM) && ($new_retrial > 3)) {
1348 $priority = PRIORITY_MEDIUM;
1349 } elseif (($priority < PRIORITY_LOW) && ($new_retrial > 6)) {
1350 $priority = PRIORITY_LOW;
1351 } elseif (($priority < PRIORITY_NEGLIGIBLE) && ($new_retrial > 8)) {
1352 $priority = PRIORITY_NEGLIGIBLE;
1355 Logger::info('Deferred task', ['id' => $id, 'retrial' => $new_retrial, 'created' => $queue['created'], 'next_execution' => $next, 'old_prio' => $queue['priority'], 'new_prio' => $priority]);
1357 $stamp = (float)microtime(true);
1358 $fields = ['retrial' => $new_retrial, 'next_try' => $next, 'executed' => DBA::NULL_DATETIME, 'pid' => 0, 'priority' => $priority];
1359 DBA::update('workerqueue', $fields, ['id' => $id]);
1360 self::$db_duration += (microtime(true) - $stamp);
1361 self::$db_duration_write += (microtime(true) - $stamp);
1367 * Set the flag if some job is waiting
1369 * @param boolean $jobs Is there a waiting job?
1370 * @throws \Exception
1372 public static function IPCSetJobState($jobs)
1374 $stamp = (float)microtime(true);
1375 DBA::update('worker-ipc', ['jobs' => $jobs], ['key' => 1], true);
1376 self::$db_duration += (microtime(true) - $stamp);
1377 self::$db_duration_write += (microtime(true) - $stamp);
1381 * Checks if some worker job waits to be executed
1384 * @throws \Exception
1386 public static function IPCJobsExists()
1388 $stamp = (float)microtime(true);
1389 $row = DBA::selectFirst('worker-ipc', ['jobs'], ['key' => 1]);
1390 self::$db_duration += (microtime(true) - $stamp);
1392 // When we don't have a row, no job is running
1393 if (!DBA::isResult($row)) {
1397 return (bool)$row['jobs'];
1401 * Check if the system is inside the defined maintenance window
1405 public static function isInMaintenanceWindow(bool $check_last_execution = false)
1407 // Calculate the seconds of the start end end of the maintenance window
1408 $start = strtotime(DI::config()->get('system', 'maintenance_start')) % 86400;
1409 $end = strtotime(DI::config()->get('system', 'maintenance_end')) % 86400;
1411 Logger::info('Maintenance window', ['start' => date('H:i:s', $start), 'end' => date('H:i:s', $end)]);
1413 if ($check_last_execution) {
1414 // Calculate the window duration
1415 $duration = max($start, $end) - min($start, $end);
1417 // Quit when the last cron execution had been after the previous window
1418 $last_cron = DI::config()->get('system', 'last_cron_daily');
1419 if ($last_cron + $duration > time()) {
1420 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)]);
1425 $current = time() % 86400;
1427 if ($start < $end) {
1428 // Execute if we are inside the window
1429 $execute = ($current >= $start) && ($current <= $end);
1431 // Don't execute if we are outside the window
1432 $execute = !(($current > $end) && ($current < $start));
1436 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)]);
1438 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)]);