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\Model\Process;
28 use Friendica\Util\DateTimeFormat;
31 * Contains the class for the worker background job processing
35 const STATE_STARTUP = 1; // Worker is in startup. This takes most time.
36 const STATE_LONG_LOOP = 2; // Worker is processing the whole - long - loop.
37 const STATE_REFETCH = 3; // Worker had refetched jobs in the execution loop.
38 const STATE_SHORT_LOOP = 4; // Worker is processing preassigned jobs, thus saving much time.
40 const FAST_COMMANDS = ['APDelivery', 'Delivery', 'CreateShadowEntry'];
42 const LOCK_PROCESS = 'worker_process';
43 const LOCK_WORKER = 'worker';
45 private static $up_start;
46 private static $db_duration = 0;
47 private static $db_duration_count = 0;
48 private static $db_duration_write = 0;
49 private static $db_duration_stat = 0;
50 private static $lock_duration = 0;
51 private static $last_update;
52 private static $state;
55 * Processes the tasks that are in the workerqueue table
57 * @param boolean $run_cron Should the cron processes be executed?
59 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
61 public static function processQueue($run_cron = true)
63 // Ensure that all "strtotime" operations do run timezone independent
64 date_default_timezone_set('UTC');
66 self::$up_start = microtime(true);
68 // At first check the maximum load. We shouldn't continue with a high load
69 if (DI::process()->isMaxLoadReached()) {
70 Logger::info('Pre check: maximum load reached, quitting.');
74 // We now start the process. This is done after the load check since this could increase the load.
77 // Kill stale processes every 5 minutes
78 $last_cleanup = DI::config()->get('system', 'worker_last_cleaned', 0);
79 if (time() > ($last_cleanup + 300)) {
80 DI::config()->set('system', 'worker_last_cleaned', time());
81 self::killStaleWorkers();
84 // Check if the system is ready
85 if (!self::isReady()) {
89 // Now we start additional cron processes if we should do so
95 self::$state = self::STATE_STARTUP;
97 // We fetch the next queue entry that is about to be executed
98 while ($r = self::workerProcess()) {
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 (!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::info('Memory limit reached, quitting.');
136 DI::lock()->release(self::LOCK_WORKER);
139 DI::lock()->release(self::LOCK_WORKER);
143 // Quit the worker once every cron interval
144 if (time() > ($starttime + (DI::config()->get('system', 'cron_interval') * 60))) {
145 Logger::info('Process lifetime reached, respawning.');
151 // Cleaning up. Possibly not needed, but it doesn't harm anything.
152 if (DI::config()->get('system', 'worker_daemon_mode', false)) {
153 self::IPCSetJobState(false);
155 Logger::info("Couldn't select a workerqueue entry, quitting process", ['pid' => getmypid()]);
159 * Checks if the system is ready.
161 * Several system parameters like memory, connections and processes are checked.
165 public static function isReady()
167 // Count active workers and compare them with a maximum value that depends on the load
168 if (self::tooMuchWorkers()) {
169 Logger::info('Active worker limit reached, quitting.');
173 // Do we have too few memory?
174 if (DI::process()->isMinMemoryReached()) {
175 Logger::info('Memory limit reached, quitting.');
179 // Possibly there are too much database connections
180 if (self::maxConnectionsReached()) {
181 Logger::info('Maximum connections reached, quitting.');
185 // Possibly there are too much database processes that block the system
186 if (DI::process()->isMaxProcessesReached()) {
187 Logger::info('Maximum processes reached, quitting.');
195 * Check if non executed tasks do exist in the worker queue
197 * @return boolean Returns "true" if tasks are existing
200 public static function entriesExists()
202 $stamp = (float)microtime(true);
203 $exists = DBA::exists('workerqueue', ["NOT `done` AND `pid` = 0 AND `next_try` < ?", DateTimeFormat::utcNow()]);
204 self::$db_duration += (microtime(true) - $stamp);
209 * Returns the number of deferred entries in the worker queue
211 * @return integer Number of deferred entries in the worker queue
214 private static function deferredEntries()
216 $stamp = (float)microtime(true);
217 $count = DBA::count('workerqueue', ["NOT `done` AND `pid` = 0 AND `retrial` > ?", 0]);
218 self::$db_duration += (microtime(true) - $stamp);
219 self::$db_duration_count += (microtime(true) - $stamp);
224 * Returns the number of non executed entries in the worker queue
226 * @return integer Number of non executed entries in the worker queue
229 private static function totalEntries()
231 $stamp = (float)microtime(true);
232 $count = DBA::count('workerqueue', ['done' => false, 'pid' => 0]);
233 self::$db_duration += (microtime(true) - $stamp);
234 self::$db_duration_count += (microtime(true) - $stamp);
239 * Returns the highest priority in the worker queue that isn't executed
241 * @return integer Number of active worker processes
244 private static function highestPriority()
246 $stamp = (float)microtime(true);
247 $condition = ["`pid` = 0 AND NOT `done` AND `next_try` < ?", DateTimeFormat::utcNow()];
248 $workerqueue = DBA::selectFirst('workerqueue', ['priority'], $condition, ['order' => ['priority']]);
249 self::$db_duration += (microtime(true) - $stamp);
250 if (DBA::isResult($workerqueue)) {
251 return $workerqueue["priority"];
258 * Returns if a process with the given priority is running
260 * @param integer $priority The priority that should be checked
262 * @return integer Is there a process running with that priority?
265 private static function processWithPriorityActive($priority)
267 $condition = ["`priority` <= ? AND `pid` != 0 AND NOT `done`", $priority];
268 return DBA::exists('workerqueue', $condition);
272 * Execute a worker entry
274 * @param array $queue Workerqueue entry
276 * @return boolean "true" if further processing should be stopped
277 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
279 public static function execute($queue)
283 // Quit when in maintenance
284 if (DI::config()->get('system', 'maintenance', false, true)) {
285 Logger::info("Maintenance mode - quit process", ['pid' => $mypid]);
289 // Constantly check the number of parallel database processes
290 if (DI::process()->isMaxProcessesReached()) {
291 Logger::info("Max processes reached for process", ['pid' => $mypid]);
295 // Constantly check the number of available database connections to let the frontend be accessible at any time
296 if (self::maxConnectionsReached()) {
297 Logger::info("Max connection reached for process", ['pid' => $mypid]);
301 $argv = json_decode($queue["parameter"], true);
303 Logger::error('Parameter is empty', ['queue' => $queue]);
307 // Check for existance and validity of the include file
310 if (method_exists(sprintf('Friendica\Worker\%s', $include), 'execute')) {
311 // We constantly update the "executed" date every minute to avoid being killed too soon
312 if (!isset(self::$last_update)) {
313 self::$last_update = strtotime($queue["executed"]);
316 $age = (time() - self::$last_update) / 60;
317 self::$last_update = time();
320 $stamp = (float)microtime(true);
321 DBA::update('workerqueue', ['executed' => DateTimeFormat::utcNow()], ['pid' => $mypid, 'done' => false]);
322 self::$db_duration += (microtime(true) - $stamp);
323 self::$db_duration_write += (microtime(true) - $stamp);
328 self::execFunction($queue, $include, $argv, true);
330 $stamp = (float)microtime(true);
331 $condition = ["`id` = ? AND `next_try` < ?", $queue['id'], DateTimeFormat::utcNow()];
332 if (DBA::update('workerqueue', ['done' => true], $condition)) {
333 DI::config()->set('system', 'last_worker_execution', DateTimeFormat::utcNow());
335 self::$db_duration = (microtime(true) - $stamp);
336 self::$db_duration_write += (microtime(true) - $stamp);
341 // The script could be provided as full path or only with the function name
342 if ($include == basename($include)) {
343 $include = "include/".$include.".php";
346 if (!validate_include($include)) {
347 Logger::log("Include file ".$argv[0]." is not valid!");
348 $stamp = (float)microtime(true);
349 DBA::delete('workerqueue', ['id' => $queue["id"]]);
350 self::$db_duration = (microtime(true) - $stamp);
351 self::$db_duration_write += (microtime(true) - $stamp);
355 require_once $include;
357 $funcname = str_replace(".php", "", basename($argv[0]))."_run";
359 if (function_exists($funcname)) {
360 // We constantly update the "executed" date every minute to avoid being killed too soon
361 if (!isset(self::$last_update)) {
362 self::$last_update = strtotime($queue["executed"]);
365 $age = (time() - self::$last_update) / 60;
366 self::$last_update = time();
369 $stamp = (float)microtime(true);
370 DBA::update('workerqueue', ['executed' => DateTimeFormat::utcNow()], ['pid' => $mypid, 'done' => false]);
371 self::$db_duration += (microtime(true) - $stamp);
372 self::$db_duration_write += (microtime(true) - $stamp);
375 self::execFunction($queue, $funcname, $argv, false);
377 $stamp = (float)microtime(true);
378 if (DBA::update('workerqueue', ['done' => true], ['id' => $queue["id"]])) {
379 DI::config()->set('system', 'last_worker_execution', DateTimeFormat::utcNow());
381 self::$db_duration = (microtime(true) - $stamp);
382 self::$db_duration_write += (microtime(true) - $stamp);
384 Logger::log("Function ".$funcname." does not exist");
385 $stamp = (float)microtime(true);
386 DBA::delete('workerqueue', ['id' => $queue["id"]]);
387 self::$db_duration = (microtime(true) - $stamp);
388 self::$db_duration_write += (microtime(true) - $stamp);
395 * Execute a function from the queue
397 * @param array $queue Workerqueue entry
398 * @param string $funcname name of the function
399 * @param array $argv Array of values to be passed to the function
400 * @param boolean $method_call boolean
402 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
404 private static function execFunction($queue, $funcname, $argv, $method_call)
408 Logger::enableWorker($funcname);
410 Logger::info("Process start.", ['priority' => $queue["priority"], 'id' => $queue["id"]]);
412 $stamp = (float)microtime(true);
414 // We use the callstack here to analyze the performance of executed worker entries.
415 // For this reason the variables have to be initialized.
416 DI::profiler()->reset();
420 $up_duration = microtime(true) - self::$up_start;
422 // Reset global data to avoid interferences
425 // Set the workerLogger as new default logger
427 call_user_func_array(sprintf('Friendica\Worker\%s::execute', $funcname), $argv);
429 $funcname($argv, count($argv));
432 Logger::disableWorker();
436 $duration = (microtime(true) - $stamp);
438 /* With these values we can analyze how effective the worker is.
439 * The database and rest time should be low since this is the unproductive time.
440 * The execution time is the productive time.
441 * By changing parameters like the maximum number of workers we can check the effectivness.
443 $dbtotal = round(self::$db_duration, 2);
444 $dbread = round(self::$db_duration - (self::$db_duration_count + self::$db_duration_write + self::$db_duration_stat), 2);
445 $dbcount = round(self::$db_duration_count, 2);
446 $dbstat = round(self::$db_duration_stat, 2);
447 $dbwrite = round(self::$db_duration_write, 2);
448 $dblock = round(self::$lock_duration, 2);
449 $rest = round(max(0, $up_duration - (self::$db_duration + self::$lock_duration)), 2);
450 $exec = round($duration, 2);
452 Logger::info('Performance:', ['state' => self::$state, 'count' => $dbcount, 'stat' => $dbstat, 'write' => $dbwrite, 'lock' => $dblock, 'total' => $dbtotal, 'rest' => $rest, 'exec' => $exec]);
454 self::$up_start = microtime(true);
455 self::$db_duration = 0;
456 self::$db_duration_count = 0;
457 self::$db_duration_stat = 0;
458 self::$db_duration_write = 0;
459 self::$lock_duration = 0;
461 if ($duration > 3600) {
462 Logger::info('Longer than 1 hour.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'duration' => round($duration/60, 3)]);
463 } elseif ($duration > 600) {
464 Logger::info('Longer than 10 minutes.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'duration' => round($duration/60, 3)]);
465 } elseif ($duration > 300) {
466 Logger::info('Longer than 5 minutes.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'duration' => round($duration/60, 3)]);
467 } elseif ($duration > 120) {
468 Logger::info('Longer than 2 minutes.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'duration' => round($duration/60, 3)]);
471 Logger::info('Process done.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'duration' => round($duration, 3)]);
473 DI::profiler()->saveLog(DI::logger(), "ID " . $queue["id"] . ": " . $funcname);
475 $cooldown = DI::config()->get("system", "worker_cooldown", 0);
478 Logger::info('Cooldown.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'cooldown' => $cooldown]);
484 * Checks if the number of database connections has reached a critical limit.
486 * @return bool Are more than 3/4 of the maximum connections used?
487 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
489 private static function maxConnectionsReached()
491 // Fetch the max value from the config. This is needed when the system cannot detect the correct value by itself.
492 $max = DI::config()->get("system", "max_connections");
494 // Fetch the percentage level where the worker will get active
495 $maxlevel = DI::config()->get("system", "max_connections_level", 75);
498 // the maximum number of possible user connections can be a system variable
499 $r = DBA::fetchFirst("SHOW VARIABLES WHERE `variable_name` = 'max_user_connections'");
500 if (DBA::isResult($r)) {
503 // Or it can be granted. This overrides the system variable
504 $stamp = (float)microtime(true);
505 $r = DBA::p('SHOW GRANTS');
506 self::$db_duration += (microtime(true) - $stamp);
507 while ($grants = DBA::fetch($r)) {
508 $grant = array_pop($grants);
509 if (stristr($grant, "GRANT USAGE ON")) {
510 if (preg_match("/WITH MAX_USER_CONNECTIONS (\d*)/", $grant, $match)) {
518 // If $max is set we will use the processlist to determine the current number of connections
519 // The processlist only shows entries of the current user
521 $stamp = (float)microtime(true);
522 $r = DBA::p('SHOW PROCESSLIST');
523 self::$db_duration += (microtime(true) - $stamp);
524 $used = DBA::numRows($r);
527 Logger::info("Connection usage (user values)", ['usage' => $used, 'max' => $max]);
529 $level = ($used / $max) * 100;
531 if ($level >= $maxlevel) {
532 Logger::log("Maximum level (".$maxlevel."%) of user connections reached: ".$used."/".$max);
537 // We will now check for the system values.
538 // This limit could be reached although the user limits are fine.
539 $r = DBA::fetchFirst("SHOW VARIABLES WHERE `variable_name` = 'max_connections'");
540 if (!DBA::isResult($r)) {
543 $max = intval($r["Value"]);
547 $r = DBA::fetchFirst("SHOW STATUS WHERE `variable_name` = 'Threads_connected'");
548 if (!DBA::isResult($r)) {
551 $used = intval($r["Value"]);
555 Logger::info("Connection usage (system values)", ['used' => $used, 'max' => $max]);
557 $level = $used / $max * 100;
559 if ($level < $maxlevel) {
562 Logger::log("Maximum level (".$level."%) of system connections reached: ".$used."/".$max);
567 * fix the queue entry if the worker process died
572 private static function killStaleWorkers()
574 $stamp = (float)microtime(true);
575 $entries = DBA::select(
577 ['id', 'pid', 'executed', 'priority', 'parameter'],
578 ['NOT `done` AND `pid` != 0'],
579 ['order' => ['priority', 'created']]
581 self::$db_duration += (microtime(true) - $stamp);
583 while ($entry = DBA::fetch($entries)) {
584 if (!posix_kill($entry["pid"], 0)) {
585 $stamp = (float)microtime(true);
588 ['executed' => DBA::NULL_DATETIME, 'pid' => 0],
589 ['id' => $entry["id"]]
591 self::$db_duration += (microtime(true) - $stamp);
592 self::$db_duration_write += (microtime(true) - $stamp);
594 // Kill long running processes
595 // Check if the priority is in a valid range
596 if (!in_array($entry["priority"], [PRIORITY_CRITICAL, PRIORITY_HIGH, PRIORITY_MEDIUM, PRIORITY_LOW, PRIORITY_NEGLIGIBLE])) {
597 $entry["priority"] = PRIORITY_MEDIUM;
600 // Define the maximum durations
601 $max_duration_defaults = [PRIORITY_CRITICAL => 720, PRIORITY_HIGH => 10, PRIORITY_MEDIUM => 60, PRIORITY_LOW => 180, PRIORITY_NEGLIGIBLE => 720];
602 $max_duration = $max_duration_defaults[$entry["priority"]];
604 $argv = json_decode($entry["parameter"], true);
609 $argv[0] = basename($argv[0]);
611 // How long is the process already running?
612 $duration = (time() - strtotime($entry["executed"])) / 60;
613 if ($duration > $max_duration) {
614 Logger::log("Worker process ".$entry["pid"]." (".substr(json_encode($argv), 0, 50).") took more than ".$max_duration." minutes. It will be killed now.");
615 posix_kill($entry["pid"], SIGTERM);
617 // We killed the stale process.
618 // To avoid a blocking situation we reschedule the process at the beginning of the queue.
619 // Additionally we are lowering the priority. (But not PRIORITY_CRITICAL)
620 $new_priority = $entry["priority"];
621 if ($entry["priority"] == PRIORITY_HIGH) {
622 $new_priority = PRIORITY_MEDIUM;
623 } elseif ($entry["priority"] == PRIORITY_MEDIUM) {
624 $new_priority = PRIORITY_LOW;
625 } elseif ($entry["priority"] != PRIORITY_CRITICAL) {
626 $new_priority = PRIORITY_NEGLIGIBLE;
628 $stamp = (float)microtime(true);
631 ['executed' => DBA::NULL_DATETIME, 'created' => DateTimeFormat::utcNow(), 'priority' => $new_priority, 'pid' => 0],
632 ['id' => $entry["id"]]
634 self::$db_duration += (microtime(true) - $stamp);
635 self::$db_duration_write += (microtime(true) - $stamp);
637 Logger::info('Process runtime is okay', ['pid' => $entry["pid"], 'duration' => $duration, 'max' => $max_duration, 'command' => substr(json_encode($argv), 0, 50)]);
641 DBA::close($entries);
645 * Checks if the number of active workers exceeds the given limits
647 * @return bool Are there too much workers running?
648 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
650 private static function tooMuchWorkers()
652 $queues = DI::config()->get("system", "worker_queues", 10);
654 $maxqueues = $queues;
656 $active = self::activeWorkers();
658 // Decrease the number of workers at higher load
659 $load = System::currentLoad();
661 $maxsysload = intval(DI::config()->get("system", "maxloadavg", 20));
663 /* Default exponent 3 causes queues to rapidly decrease as load increases.
664 * If you have 20 max queues at idle, then you get only 5 queues at 37.1% of $maxsysload.
665 * For some environments, this rapid decrease is not needed.
666 * With exponent 1, you could have 20 max queues at idle and 13 at 37% of $maxsysload.
668 $exponent = intval(DI::config()->get('system', 'worker_load_exponent', 3));
669 $slope = pow(max(0, $maxsysload - $load) / $maxsysload, $exponent);
670 $queues = intval(ceil($slope * $maxqueues));
674 if (DI::config()->get('system', 'worker_jpm')) {
675 $intervals = explode(',', DI::config()->get('system', 'worker_jpm_range'));
676 $jobs_per_minute = [];
677 foreach ($intervals as $interval) {
678 if ($interval == 0) {
681 $interval = (int)$interval;
684 $stamp = (float)microtime(true);
685 $jobs = DBA::p("SELECT COUNT(*) AS `jobs` FROM `workerqueue` WHERE `done` AND `executed` > UTC_TIMESTAMP() - INTERVAL ? MINUTE", $interval);
686 self::$db_duration += (microtime(true) - $stamp);
687 self::$db_duration_stat += (microtime(true) - $stamp);
688 if ($job = DBA::fetch($jobs)) {
689 $jobs_per_minute[$interval] = number_format($job['jobs'] / $interval, 0);
693 $processlist = ' - jpm: '.implode('/', $jobs_per_minute);
696 // Create a list of queue entries grouped by their priority
697 $listitem = [0 => ''];
699 $idle_workers = $active;
701 $deferred = self::deferredEntries();
703 if (DI::config()->get('system', 'worker_debug')) {
704 $waiting_processes = 0;
705 // Now adding all processes with workerqueue entries
706 $stamp = (float)microtime(true);
707 $jobs = DBA::p("SELECT COUNT(*) AS `entries`, `priority` FROM `workerqueue` WHERE NOT `done` GROUP BY `priority`");
708 self::$db_duration += (microtime(true) - $stamp);
709 self::$db_duration_stat += (microtime(true) - $stamp);
710 while ($entry = DBA::fetch($jobs)) {
711 $stamp = (float)microtime(true);
712 $processes = DBA::p("SELECT COUNT(*) AS `running` FROM `workerqueue-view` WHERE `priority` = ?", $entry["priority"]);
713 self::$db_duration += (microtime(true) - $stamp);
714 self::$db_duration_stat += (microtime(true) - $stamp);
715 if ($process = DBA::fetch($processes)) {
716 $idle_workers -= $process["running"];
717 $waiting_processes += $entry["entries"];
718 $listitem[$entry["priority"]] = $entry["priority"].":".$process["running"]."/".$entry["entries"];
720 DBA::close($processes);
724 $waiting_processes = self::totalEntries();
725 $stamp = (float)microtime(true);
726 $jobs = DBA::p("SELECT COUNT(*) AS `running`, `priority` FROM `workerqueue-view` GROUP BY `priority` ORDER BY `priority`");
727 self::$db_duration += (microtime(true) - $stamp);
728 self::$db_duration_stat += (microtime(true) - $stamp);
730 while ($entry = DBA::fetch($jobs)) {
731 $idle_workers -= $entry["running"];
732 $listitem[$entry["priority"]] = $entry["priority"].":".$entry["running"];
737 $waiting_processes -= $deferred;
739 $listitem[0] = "0:" . max(0, $idle_workers);
741 $processlist .= ' ('.implode(', ', $listitem).')';
743 if (DI::config()->get("system", "worker_fastlane", false) && ($queues > 0) && ($active >= $queues) && self::entriesExists()) {
744 $top_priority = self::highestPriority();
745 $high_running = self::processWithPriorityActive($top_priority);
747 if (!$high_running && ($top_priority > PRIORITY_UNDEFINED) && ($top_priority < PRIORITY_NEGLIGIBLE)) {
748 Logger::info("Jobs with a higher priority are waiting but none is executed. Open a fastlane.", ['priority' => $top_priority]);
749 $queues = $active + 1;
753 Logger::notice("Load: " . $load ."/" . $maxsysload . " - processes: " . $deferred . "/" . $active . "/" . $waiting_processes . $processlist . " - maximum: " . $queues . "/" . $maxqueues);
755 // Are there fewer workers running as possible? Then fork a new one.
756 if (!DI::config()->get("system", "worker_dont_fork", false) && ($queues > ($active + 1)) && self::entriesExists()) {
757 Logger::info("There are fewer workers as possible, fork a new worker.", ['active' => $active, 'queues' => $queues]);
758 if (DI::config()->get('system', 'worker_daemon_mode', false)) {
759 self::IPCSetJobState(true);
766 // if there are too much worker, we don't spawn a new one.
767 if (DI::config()->get('system', 'worker_daemon_mode', false) && ($active > $queues)) {
768 self::IPCSetJobState(false);
771 return $active > $queues;
775 * Returns the number of active worker processes
777 * @return integer Number of active worker processes
780 private static function activeWorkers()
782 $stamp = (float)microtime(true);
783 $count = DBA::count('process', ['command' => 'Worker.php']);
784 self::$db_duration += (microtime(true) - $stamp);
789 * Returns the number of active worker processes
791 * @return array List of worker process ids
794 private static function getWorkerPIDList()
797 $stamp = (float)microtime(true);
799 $queues = DBA::p("SELECT `process`.`pid`, COUNT(`workerqueue`.`pid`) AS `entries` FROM `process`
800 LEFT JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid` AND NOT `workerqueue`.`done`
801 GROUP BY `process`.`pid`");
802 while ($queue = DBA::fetch($queues)) {
803 $ids[$queue['pid']] = $queue['entries'];
807 self::$db_duration += (microtime(true) - $stamp);
812 * Returns waiting jobs for the current process id
814 * @return array waiting workerqueue jobs
817 private static function getWaitingJobForPID()
819 $stamp = (float)microtime(true);
820 $r = DBA::select('workerqueue', [], ['pid' => getmypid(), 'done' => false]);
821 self::$db_duration += (microtime(true) - $stamp);
822 if (DBA::isResult($r)) {
823 return DBA::toArray($r);
831 * Returns the next jobs that should be executed
833 * @return array array with next jobs
836 private static function nextProcess(int $limit)
838 $priority = self::nextPriority();
839 if (empty($priority)) {
840 Logger::info('No tasks found');
845 $stamp = (float)microtime(true);
846 $condition = ["`priority` = ? AND `pid` = 0 AND NOT `done` AND `next_try` < ?", $priority, DateTimeFormat::utcNow()];
847 $tasks = DBA::select('workerqueue', ['id', 'parameter'], $condition, ['limit' => $limit, 'order' => ['created']]);
848 self::$db_duration += (microtime(true) - $stamp);
849 while ($task = DBA::fetch($tasks)) {
850 $ids[] = $task['id'];
851 // Only continue that loop while we are storing commands that can be processed quickly
852 $command = json_decode($task['parameter'])[0];
853 if (!in_array($command, self::FAST_COMMANDS)) {
859 Logger::info('Found:', ['priority' => $priority, 'id' => $ids]);
864 * Returns the priority of the next workerqueue job
866 * @return string priority
869 private static function nextPriority()
872 $priorities = [PRIORITY_CRITICAL, PRIORITY_HIGH, PRIORITY_MEDIUM, PRIORITY_LOW, PRIORITY_NEGLIGIBLE];
873 foreach ($priorities as $priority) {
874 $stamp = (float)microtime(true);
875 if (DBA::exists('workerqueue', ["`priority` = ? AND `pid` = 0 AND NOT `done` AND `next_try` < ?", $priority, DateTimeFormat::utcNow()])) {
876 $waiting[$priority] = true;
878 self::$db_duration += (microtime(true) - $stamp);
881 if (!empty($waiting[PRIORITY_CRITICAL])) {
882 return PRIORITY_CRITICAL;
887 $stamp = (float)microtime(true);
888 $processes = DBA::p("SELECT COUNT(DISTINCT(`pid`)) AS `running`, `priority` FROM `workerqueue-view` GROUP BY `priority`");
889 self::$db_duration += (microtime(true) - $stamp);
890 while ($process = DBA::fetch($processes)) {
891 $running[$process['priority']] = $process['running'];
892 $running_total += $process['running'];
894 DBA::close($processes);
896 foreach ($priorities as $priority) {
897 if (!empty($waiting[$priority]) && empty($running[$priority])) {
898 Logger::info('No running worker found with priority {priority} - assigning it.', ['priority' => $priority]);
903 $active = max(self::activeWorkers(), $running_total);
904 $priorities = max(count($waiting), count($running));
908 for ($i = 1; $i <= $priorities; ++$i) {
909 $total += pow($i, $exponent);
913 for ($i = 1; $i <= $priorities; ++$i) {
914 $limit[$priorities - $i] = max(1, round($active * (pow($i, $exponent) / $total)));
918 foreach ($running as $priority => $workers) {
919 if ($workers < $limit[$i++]) {
920 Logger::info('Priority {priority} has got {workers} workers out of a limit of {limit}', ['priority' => $priority, 'workers' => $workers, 'limit' => $limit[$i - 1]]);
925 if (!empty($waiting)) {
926 $priority = array_keys($waiting)[0];
927 Logger::info('No underassigned priority found, now taking the highest priority.', ['priority' => $priority]);
935 * Find and claim the next worker process for us
937 * @return boolean Have we found something?
938 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
940 private static function findWorkerProcesses()
942 $fetch_limit = DI::config()->get('system', 'worker_fetch_limit', 1);
944 if (DI::config()->get('system', 'worker_multiple_fetch')) {
946 $worker_pids = self::getWorkerPIDList();
947 foreach ($worker_pids as $pid => $count) {
948 if ($count <= $fetch_limit) {
955 $limit = $fetch_limit * count($pids);
957 $pids = [getmypid()];
958 $limit = $fetch_limit;
961 $ids = self::nextProcess($limit);
962 $limit -= count($ids);
964 // If there is not enough results we check without priority limit
966 $stamp = (float)microtime(true);
967 $condition = ["`pid` = 0 AND NOT `done` AND `next_try` < ?", DateTimeFormat::utcNow()];
968 $tasks = DBA::select('workerqueue', ['id', 'parameter'], $condition, ['limit' => $limit, 'order' => ['priority', 'created']]);
969 self::$db_duration += (microtime(true) - $stamp);
971 while ($task = DBA::fetch($tasks)) {
972 $ids[] = $task['id'];
973 // Only continue that loop while we are storing commands that can be processed quickly
974 $command = json_decode($task['parameter'])[0];
975 if (!in_array($command, self::FAST_COMMANDS)) {
984 foreach (array_unique($ids) as $id) {
989 $worker[$pid][] = $id;
992 $stamp = (float)microtime(true);
993 foreach ($worker as $worker_pid => $worker_ids) {
994 Logger::info('Set queue entry', ['pid' => $worker_pid, 'ids' => $worker_ids]);
995 DBA::update('workerqueue', ['executed' => DateTimeFormat::utcNow(), 'pid' => $worker_pid],
996 ['id' => $worker_ids, 'done' => false, 'pid' => 0]);
998 self::$db_duration += (microtime(true) - $stamp);
999 self::$db_duration_write += (microtime(true) - $stamp);
1002 return !empty($ids);
1006 * Returns the next worker process
1008 * @return array worker processes
1009 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1011 public static function workerProcess()
1013 // There can already be jobs for us in the queue.
1014 $waiting = self::getWaitingJobForPID();
1015 if (!empty($waiting)) {
1019 $stamp = (float)microtime(true);
1020 if (!DI::lock()->acquire(self::LOCK_PROCESS)) {
1023 self::$lock_duration += (microtime(true) - $stamp);
1025 $found = self::findWorkerProcesses();
1027 DI::lock()->release(self::LOCK_PROCESS);
1030 $stamp = (float)microtime(true);
1031 $r = DBA::select('workerqueue', [], ['pid' => getmypid(), 'done' => false]);
1032 self::$db_duration += (microtime(true) - $stamp);
1033 return DBA::toArray($r);
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 Process::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(), $a->getBasePath());
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 * Log active processes into the "process" table
1367 public static function startProcess()
1369 $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 1);
1371 $command = basename($trace[0]['file']);
1373 Process::deleteInactive();
1375 Process::insert($command);
1379 * Remove the active process from the "process" table
1382 * @throws \Exception
1384 public static function endProcess()
1386 return Process::deleteByPid();
1390 * Set the flag if some job is waiting
1392 * @param boolean $jobs Is there a waiting job?
1393 * @throws \Exception
1395 public static function IPCSetJobState($jobs)
1397 $stamp = (float)microtime(true);
1398 DBA::update('worker-ipc', ['jobs' => $jobs], ['key' => 1], true);
1399 self::$db_duration += (microtime(true) - $stamp);
1400 self::$db_duration_write += (microtime(true) - $stamp);
1404 * Checks if some worker job waits to be executed
1407 * @throws \Exception
1409 public static function IPCJobsExists()
1411 $stamp = (float)microtime(true);
1412 $row = DBA::selectFirst('worker-ipc', ['jobs'], ['key' => 1]);
1413 self::$db_duration += (microtime(true) - $stamp);
1415 // When we don't have a row, no job is running
1416 if (!DBA::isResult($row)) {
1420 return (bool)$row['jobs'];