3 * @file src/Core/Worker.php
5 namespace Friendica\Core;
8 use Friendica\Database\DBA;
10 use Friendica\Model\Process;
11 use Friendica\Util\DateTimeFormat;
12 use Friendica\Util\Network;
15 * @file src/Core/Worker.php
17 * @brief Contains the class for the worker background job processing
21 * @brief Worker methods
25 const STATE_STARTUP = 1; // Worker is in startup. This takes most time.
26 const STATE_LONG_LOOP = 2; // Worker is processing the whole - long - loop.
27 const STATE_REFETCH = 3; // Worker had refetched jobs in the execution loop.
28 const STATE_SHORT_LOOP = 4; // Worker is processing preassigned jobs, thus saving much time.
30 const FAST_COMMANDS = ['APDelivery', 'Delivery', 'CreateShadowEntry'];
33 private static $up_start;
34 private static $db_duration = 0;
35 private static $db_duration_count = 0;
36 private static $db_duration_write = 0;
37 private static $db_duration_stat = 0;
38 private static $lock_duration = 0;
39 private static $last_update;
40 private static $state;
43 * @brief Processes the tasks that are in the workerqueue table
45 * @param boolean $run_cron Should the cron processes be executed?
47 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
49 public static function processQueue($run_cron = true)
53 // Ensure that all "strtotime" operations do run timezone independent
54 date_default_timezone_set('UTC');
56 self::$up_start = microtime(true);
58 // At first check the maximum load. We shouldn't continue with a high load
59 if ($a->isMaxLoadReached()) {
60 Logger::log('Pre check: maximum load reached, quitting.', Logger::DEBUG);
64 // We now start the process. This is done after the load check since this could increase the load.
67 // Kill stale processes every 5 minutes
68 $last_cleanup = Config::get('system', 'worker_last_cleaned', 0);
69 if (time() > ($last_cleanup + 300)) {
70 Config::set('system', 'worker_last_cleaned', time());
71 self::killStaleWorkers();
74 // Count active workers and compare them with a maximum value that depends on the load
75 if (self::tooMuchWorkers()) {
76 Logger::log('Pre check: Active worker limit reached, quitting.', Logger::DEBUG);
80 // Do we have too few memory?
81 if ($a->isMinMemoryReached()) {
82 Logger::log('Pre check: Memory limit reached, quitting.', Logger::DEBUG);
86 // Possibly there are too much database connections
87 if (self::maxConnectionsReached()) {
88 Logger::log('Pre check: maximum connections reached, quitting.', Logger::DEBUG);
92 // Possibly there are too much database processes that block the system
93 if ($a->isMaxProcessesReached()) {
94 Logger::log('Pre check: maximum processes reached, quitting.', Logger::DEBUG);
98 // Now we start additional cron processes if we should do so
104 self::$state = self::STATE_STARTUP;
106 // We fetch the next queue entry that is about to be executed
107 while ($r = self::workerProcess()) {
109 foreach ($r as $entry) {
110 // Assure that the priority is an integer value
111 $entry['priority'] = (int)$entry['priority'];
113 // The work will be done
114 if (!self::execute($entry)) {
115 Logger::log('Process execution failed, quitting.', Logger::DEBUG);
119 // Trying to fetch new processes - but only once when successful
120 if (!$refetched && Lock::acquire('worker_process', 0)) {
121 self::findWorkerProcesses();
122 Lock::release('worker_process');
123 self::$state = self::STATE_REFETCH;
126 self::$state = self::STATE_SHORT_LOOP;
130 // To avoid the quitting of multiple workers only one worker at a time will execute the check
131 if (!self::getWaitingJobForPID()) {
132 self::$state = self::STATE_LONG_LOOP;
134 if (Lock::acquire('worker', 0)) {
135 // Count active workers and compare them with a maximum value that depends on the load
136 if (self::tooMuchWorkers()) {
137 Logger::log('Active worker limit reached, quitting.', Logger::DEBUG);
138 Lock::release('worker');
143 if ($a->isMinMemoryReached()) {
144 Logger::log('Memory limit reached, quitting.', Logger::DEBUG);
145 Lock::release('worker');
148 Lock::release('worker');
152 // Quit the worker once every cron interval
153 if (time() > ($starttime + (Config::get('system', 'cron_interval') * 60))) {
154 Logger::info('Process lifetime reached, respawning.');
160 // Cleaning up. Possibly not needed, but it doesn't harm anything.
161 if (Config::get('system', 'worker_daemon_mode', false)) {
162 self::IPCSetJobState(false);
164 Logger::log("Couldn't select a workerqueue entry, quitting process " . getmypid() . ".", Logger::DEBUG);
168 * @brief Check if non executed tasks do exist in the worker queue
170 * @return boolean Returns "true" if tasks are existing
173 private static function entriesExists()
175 $stamp = (float)microtime(true);
176 $exists = DBA::exists('workerqueue', ["NOT `done` AND `pid` = 0 AND `next_try` < ?", DateTimeFormat::utcNow()]);
177 self::$db_duration += (microtime(true) - $stamp);
182 * @brief Returns the number of deferred entries in the worker queue
184 * @return integer Number of deferred entries in the worker queue
187 private static function deferredEntries()
189 $stamp = (float)microtime(true);
190 $count = DBA::count('workerqueue', ["NOT `done` AND `pid` = 0 AND `retrial` > ?", 0]);
191 self::$db_duration += (microtime(true) - $stamp);
192 self::$db_duration_count += (microtime(true) - $stamp);
197 * @brief Returns the number of non executed entries in the worker queue
199 * @return integer Number of non executed entries in the worker queue
202 private static function totalEntries()
204 $stamp = (float)microtime(true);
205 $count = DBA::count('workerqueue', ['done' => false, 'pid' => 0]);
206 self::$db_duration += (microtime(true) - $stamp);
207 self::$db_duration_count += (microtime(true) - $stamp);
212 * @brief Returns the highest priority in the worker queue that isn't executed
214 * @return integer Number of active worker processes
217 private static function highestPriority()
219 $stamp = (float)microtime(true);
220 $condition = ["`pid` = 0 AND NOT `done` AND `next_try` < ?", DateTimeFormat::utcNow()];
221 $workerqueue = DBA::selectFirst('workerqueue', ['priority'], $condition, ['order' => ['priority']]);
222 self::$db_duration += (microtime(true) - $stamp);
223 if (DBA::isResult($workerqueue)) {
224 return $workerqueue["priority"];
231 * @brief Returns if a process with the given priority is running
233 * @param integer $priority The priority that should be checked
235 * @return integer Is there a process running with that priority?
238 private static function processWithPriorityActive($priority)
240 $condition = ["`priority` <= ? AND `pid` != 0 AND NOT `done`", $priority];
241 return DBA::exists('workerqueue', $condition);
245 * @brief Execute a worker entry
247 * @param array $queue Workerqueue entry
249 * @return boolean "true" if further processing should be stopped
250 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
252 public static function execute($queue)
258 // Quit when in maintenance
259 if (Config::get('system', 'maintenance', false, true)) {
260 Logger::log("Maintenance mode - quit process ".$mypid, Logger::DEBUG);
264 // Constantly check the number of parallel database processes
265 if ($a->isMaxProcessesReached()) {
266 Logger::log("Max processes reached for process ".$mypid, Logger::DEBUG);
270 // Constantly check the number of available database connections to let the frontend be accessible at any time
271 if (self::maxConnectionsReached()) {
272 Logger::log("Max connection reached for process ".$mypid, Logger::DEBUG);
276 $argv = json_decode($queue["parameter"], true);
278 // Check for existance and validity of the include file
281 if (method_exists(sprintf('Friendica\Worker\%s', $include), 'execute')) {
282 // We constantly update the "executed" date every minute to avoid being killed too soon
283 if (!isset(self::$last_update)) {
284 self::$last_update = strtotime($queue["executed"]);
287 $age = (time() - self::$last_update) / 60;
288 self::$last_update = time();
291 $stamp = (float)microtime(true);
292 DBA::update('workerqueue', ['executed' => DateTimeFormat::utcNow()], ['pid' => $mypid, 'done' => false]);
293 self::$db_duration += (microtime(true) - $stamp);
294 self::$db_duration_write += (microtime(true) - $stamp);
299 self::execFunction($queue, $include, $argv, true);
301 $stamp = (float)microtime(true);
302 $condition = ["`id` = ? AND `next_try` < ?", $queue['id'], DateTimeFormat::utcNow()];
303 if (DBA::update('workerqueue', ['done' => true], $condition)) {
304 Config::set('system', 'last_worker_execution', DateTimeFormat::utcNow());
306 self::$db_duration = (microtime(true) - $stamp);
307 self::$db_duration_write += (microtime(true) - $stamp);
312 // The script could be provided as full path or only with the function name
313 if ($include == basename($include)) {
314 $include = "include/".$include.".php";
317 if (!validate_include($include)) {
318 Logger::log("Include file ".$argv[0]." is not valid!");
319 $stamp = (float)microtime(true);
320 DBA::delete('workerqueue', ['id' => $queue["id"]]);
321 self::$db_duration = (microtime(true) - $stamp);
322 self::$db_duration_write += (microtime(true) - $stamp);
326 require_once $include;
328 $funcname = str_replace(".php", "", basename($argv[0]))."_run";
330 if (function_exists($funcname)) {
331 // We constantly update the "executed" date every minute to avoid being killed too soon
332 if (!isset(self::$last_update)) {
333 self::$last_update = strtotime($queue["executed"]);
336 $age = (time() - self::$last_update) / 60;
337 self::$last_update = time();
340 $stamp = (float)microtime(true);
341 DBA::update('workerqueue', ['executed' => DateTimeFormat::utcNow()], ['pid' => $mypid, 'done' => false]);
342 self::$db_duration += (microtime(true) - $stamp);
343 self::$db_duration_write += (microtime(true) - $stamp);
346 self::execFunction($queue, $funcname, $argv, false);
348 $stamp = (float)microtime(true);
349 if (DBA::update('workerqueue', ['done' => true], ['id' => $queue["id"]])) {
350 Config::set('system', 'last_worker_execution', DateTimeFormat::utcNow());
352 self::$db_duration = (microtime(true) - $stamp);
353 self::$db_duration_write += (microtime(true) - $stamp);
355 Logger::log("Function ".$funcname." does not exist");
356 $stamp = (float)microtime(true);
357 DBA::delete('workerqueue', ['id' => $queue["id"]]);
358 self::$db_duration = (microtime(true) - $stamp);
359 self::$db_duration_write += (microtime(true) - $stamp);
366 * @brief Execute a function from the queue
368 * @param array $queue Workerqueue entry
369 * @param string $funcname name of the function
370 * @param array $argv Array of values to be passed to the function
371 * @param boolean $method_call boolean
373 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
375 private static function execFunction($queue, $funcname, $argv, $method_call)
379 $argc = count($argv);
381 Logger::enableWorker($funcname);
383 Logger::info("Process start.", ['priority' => $queue["priority"], 'id' => $queue["id"]]);
385 $stamp = (float)microtime(true);
387 // We use the callstack here to analyze the performance of executed worker entries.
388 // For this reason the variables have to be initialized.
389 DI::profiler()->reset();
393 $up_duration = microtime(true) - self::$up_start;
395 // Reset global data to avoid interferences
398 // Set the workerLogger as new default logger
400 call_user_func_array(sprintf('Friendica\Worker\%s::execute', $funcname), $argv);
402 $funcname($argv, $argc);
405 Logger::disableWorker();
409 $duration = (microtime(true) - $stamp);
411 /* With these values we can analyze how effective the worker is.
412 * The database and rest time should be low since this is the unproductive time.
413 * The execution time is the productive time.
414 * By changing parameters like the maximum number of workers we can check the effectivness.
416 $dbtotal = round(self::$db_duration, 2);
417 $dbread = round(self::$db_duration - (self::$db_duration_count + self::$db_duration_write + self::$db_duration_stat), 2);
418 $dbcount = round(self::$db_duration_count, 2);
419 $dbstat = round(self::$db_duration_stat, 2);
420 $dbwrite = round(self::$db_duration_write, 2);
421 $dblock = round(self::$lock_duration, 2);
422 $rest = round(max(0, $up_duration - (self::$db_duration + self::$lock_duration)), 2);
423 $exec = round($duration, 2);
425 Logger::info('Performance:', ['state' => self::$state, 'count' => $dbcount, 'stat' => $dbstat, 'write' => $dbwrite, 'lock' => $dblock, 'total' => $dbtotal, 'rest' => $rest, 'exec' => $exec]);
427 self::$up_start = microtime(true);
428 self::$db_duration = 0;
429 self::$db_duration_count = 0;
430 self::$db_duration_stat = 0;
431 self::$db_duration_write = 0;
432 self::$lock_duration = 0;
434 if ($duration > 3600) {
435 Logger::info('Longer than 1 hour.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'duration' => round($duration/60, 3)]);
436 } elseif ($duration > 600) {
437 Logger::info('Longer than 10 minutes.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'duration' => round($duration/60, 3)]);
438 } elseif ($duration > 300) {
439 Logger::info('Longer than 5 minutes.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'duration' => round($duration/60, 3)]);
440 } elseif ($duration > 120) {
441 Logger::info('Longer than 2 minutes.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'duration' => round($duration/60, 3)]);
444 Logger::info('Process done.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'duration' => round($duration, 3)]);
446 DI::profiler()->saveLog(DI::logger(), "ID " . $queue["id"] . ": " . $funcname);
448 $cooldown = Config::get("system", "worker_cooldown", 0);
451 Logger::info('Cooldown.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'cooldown' => $cooldown]);
457 * @brief Checks if the number of database connections has reached a critical limit.
459 * @return bool Are more than 3/4 of the maximum connections used?
460 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
462 private static function maxConnectionsReached()
464 // Fetch the max value from the config. This is needed when the system cannot detect the correct value by itself.
465 $max = Config::get("system", "max_connections");
467 // Fetch the percentage level where the worker will get active
468 $maxlevel = Config::get("system", "max_connections_level", 75);
471 // the maximum number of possible user connections can be a system variable
472 $r = DBA::fetchFirst("SHOW VARIABLES WHERE `variable_name` = 'max_user_connections'");
473 if (DBA::isResult($r)) {
476 // Or it can be granted. This overrides the system variable
477 $stamp = (float)microtime(true);
478 $r = DBA::p('SHOW GRANTS');
479 self::$db_duration += (microtime(true) - $stamp);
480 while ($grants = DBA::fetch($r)) {
481 $grant = array_pop($grants);
482 if (stristr($grant, "GRANT USAGE ON")) {
483 if (preg_match("/WITH MAX_USER_CONNECTIONS (\d*)/", $grant, $match)) {
491 // If $max is set we will use the processlist to determine the current number of connections
492 // The processlist only shows entries of the current user
494 $stamp = (float)microtime(true);
495 $r = DBA::p('SHOW PROCESSLIST');
496 self::$db_duration += (microtime(true) - $stamp);
497 $used = DBA::numRows($r);
500 Logger::log("Connection usage (user values): ".$used."/".$max, Logger::DEBUG);
502 $level = ($used / $max) * 100;
504 if ($level >= $maxlevel) {
505 Logger::log("Maximum level (".$maxlevel."%) of user connections reached: ".$used."/".$max);
510 // We will now check for the system values.
511 // This limit could be reached although the user limits are fine.
512 $r = DBA::fetchFirst("SHOW VARIABLES WHERE `variable_name` = 'max_connections'");
513 if (!DBA::isResult($r)) {
516 $max = intval($r["Value"]);
520 $r = DBA::fetchFirst("SHOW STATUS WHERE `variable_name` = 'Threads_connected'");
521 if (!DBA::isResult($r)) {
524 $used = intval($r["Value"]);
528 Logger::log("Connection usage (system values): ".$used."/".$max, Logger::DEBUG);
530 $level = $used / $max * 100;
532 if ($level < $maxlevel) {
535 Logger::log("Maximum level (".$level."%) of system connections reached: ".$used."/".$max);
540 * @brief fix the queue entry if the worker process died
544 private static function killStaleWorkers()
546 $stamp = (float)microtime(true);
547 $entries = DBA::select(
549 ['id', 'pid', 'executed', 'priority', 'parameter'],
550 ['NOT `done` AND `pid` != 0'],
551 ['order' => ['priority', 'created']]
553 self::$db_duration += (microtime(true) - $stamp);
555 while ($entry = DBA::fetch($entries)) {
556 if (!posix_kill($entry["pid"], 0)) {
557 $stamp = (float)microtime(true);
560 ['executed' => DBA::NULL_DATETIME, 'pid' => 0],
561 ['id' => $entry["id"]]
563 self::$db_duration += (microtime(true) - $stamp);
564 self::$db_duration_write += (microtime(true) - $stamp);
566 // Kill long running processes
567 // Check if the priority is in a valid range
568 if (!in_array($entry["priority"], [PRIORITY_CRITICAL, PRIORITY_HIGH, PRIORITY_MEDIUM, PRIORITY_LOW, PRIORITY_NEGLIGIBLE])) {
569 $entry["priority"] = PRIORITY_MEDIUM;
572 // Define the maximum durations
573 $max_duration_defaults = [PRIORITY_CRITICAL => 720, PRIORITY_HIGH => 10, PRIORITY_MEDIUM => 60, PRIORITY_LOW => 180, PRIORITY_NEGLIGIBLE => 720];
574 $max_duration = $max_duration_defaults[$entry["priority"]];
576 $argv = json_decode($entry["parameter"], true);
577 $argv[0] = basename($argv[0]);
579 // How long is the process already running?
580 $duration = (time() - strtotime($entry["executed"])) / 60;
581 if ($duration > $max_duration) {
582 Logger::log("Worker process ".$entry["pid"]." (".substr(json_encode($argv), 0, 50).") took more than ".$max_duration." minutes. It will be killed now.");
583 posix_kill($entry["pid"], SIGTERM);
585 // We killed the stale process.
586 // To avoid a blocking situation we reschedule the process at the beginning of the queue.
587 // Additionally we are lowering the priority. (But not PRIORITY_CRITICAL)
588 $new_priority = $entry["priority"];
589 if ($entry["priority"] == PRIORITY_HIGH) {
590 $new_priority = PRIORITY_MEDIUM;
591 } elseif ($entry["priority"] == PRIORITY_MEDIUM) {
592 $new_priority = PRIORITY_LOW;
593 } elseif ($entry["priority"] != PRIORITY_CRITICAL) {
594 $new_priority = PRIORITY_NEGLIGIBLE;
596 $stamp = (float)microtime(true);
599 ['executed' => DBA::NULL_DATETIME, 'created' => DateTimeFormat::utcNow(), 'priority' => $new_priority, 'pid' => 0],
600 ['id' => $entry["id"]]
602 self::$db_duration += (microtime(true) - $stamp);
603 self::$db_duration_write += (microtime(true) - $stamp);
605 Logger::log("Worker process ".$entry["pid"]." (".substr(json_encode($argv), 0, 50).") now runs for ".round($duration)." of ".$max_duration." allowed minutes. That's okay.", Logger::DEBUG);
612 * @brief Checks if the number of active workers exceeds the given limits
614 * @return bool Are there too much workers running?
615 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
617 private static function tooMuchWorkers()
619 $queues = Config::get("system", "worker_queues", 10);
621 $maxqueues = $queues;
623 $active = self::activeWorkers();
625 // Decrease the number of workers at higher load
626 $load = System::currentLoad();
628 $maxsysload = intval(Config::get("system", "maxloadavg", 20));
630 /* Default exponent 3 causes queues to rapidly decrease as load increases.
631 * If you have 20 max queues at idle, then you get only 5 queues at 37.1% of $maxsysload.
632 * For some environments, this rapid decrease is not needed.
633 * With exponent 1, you could have 20 max queues at idle and 13 at 37% of $maxsysload.
635 $exponent = intval(Config::get('system', 'worker_load_exponent', 3));
636 $slope = pow(max(0, $maxsysload - $load) / $maxsysload, $exponent);
637 $queues = intval(ceil($slope * $maxqueues));
641 if (Config::get('system', 'worker_jpm')) {
642 $intervals = explode(',', Config::get('system', 'worker_jpm_range'));
643 $jobs_per_minute = [];
644 foreach ($intervals as $interval) {
645 if ($interval == 0) {
648 $interval = (int)$interval;
651 $stamp = (float)microtime(true);
652 $jobs = DBA::p("SELECT COUNT(*) AS `jobs` FROM `workerqueue` WHERE `done` AND `executed` > UTC_TIMESTAMP() - INTERVAL ? MINUTE", $interval);
653 self::$db_duration += (microtime(true) - $stamp);
654 self::$db_duration_stat += (microtime(true) - $stamp);
655 if ($job = DBA::fetch($jobs)) {
656 $jobs_per_minute[$interval] = number_format($job['jobs'] / $interval, 0);
660 $processlist = ' - jpm: '.implode('/', $jobs_per_minute);
663 // Create a list of queue entries grouped by their priority
664 $listitem = [0 => ''];
666 $idle_workers = $active;
668 $deferred = self::deferredEntries();
670 if (Config::get('system', 'worker_debug')) {
671 $waiting_processes = 0;
672 // Now adding all processes with workerqueue entries
673 $stamp = (float)microtime(true);
674 $jobs = DBA::p("SELECT COUNT(*) AS `entries`, `priority` FROM `workerqueue` WHERE NOT `done` GROUP BY `priority`");
675 self::$db_duration += (microtime(true) - $stamp);
676 self::$db_duration_stat += (microtime(true) - $stamp);
677 while ($entry = DBA::fetch($jobs)) {
678 $stamp = (float)microtime(true);
679 $processes = DBA::p("SELECT COUNT(*) AS `running` FROM `process` INNER JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid` WHERE NOT `done` AND `priority` = ?", $entry["priority"]);
680 self::$db_duration += (microtime(true) - $stamp);
681 self::$db_duration_stat += (microtime(true) - $stamp);
682 if ($process = DBA::fetch($processes)) {
683 $idle_workers -= $process["running"];
684 $waiting_processes += $entry["entries"];
685 $listitem[$entry["priority"]] = $entry["priority"].":".$process["running"]."/".$entry["entries"];
687 DBA::close($processes);
691 $waiting_processes = self::totalEntries();
692 $stamp = (float)microtime(true);
693 $jobs = DBA::p("SELECT COUNT(*) AS `running`, `priority` FROM `process` INNER JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid` AND NOT `done` GROUP BY `priority` ORDER BY `priority`");
694 self::$db_duration += (microtime(true) - $stamp);
695 self::$db_duration_stat += (microtime(true) - $stamp);
697 while ($entry = DBA::fetch($jobs)) {
698 $idle_workers -= $entry["running"];
699 $listitem[$entry["priority"]] = $entry["priority"].":".$entry["running"];
704 $waiting_processes -= $deferred;
706 $listitem[0] = "0:" . max(0, $idle_workers);
708 $processlist .= ' ('.implode(', ', $listitem).')';
710 if (Config::get("system", "worker_fastlane", false) && ($queues > 0) && ($active >= $queues) && self::entriesExists()) {
711 $top_priority = self::highestPriority();
712 $high_running = self::processWithPriorityActive($top_priority);
714 if (!$high_running && ($top_priority > PRIORITY_UNDEFINED) && ($top_priority < PRIORITY_NEGLIGIBLE)) {
715 Logger::log("There are jobs with priority ".$top_priority." waiting but none is executed. Open a fastlane.", Logger::DEBUG);
716 $queues = $active + 1;
720 Logger::log("Load: " . $load ."/" . $maxsysload . " - processes: " . $deferred . "/" . $active . "/" . $waiting_processes . $processlist . " - maximum: " . $queues . "/" . $maxqueues, Logger::DEBUG);
722 // Are there fewer workers running as possible? Then fork a new one.
723 if (!Config::get("system", "worker_dont_fork", false) && ($queues > ($active + 1)) && self::entriesExists()) {
724 Logger::log("Active workers: ".$active."/".$queues." Fork a new worker.", Logger::DEBUG);
725 if (Config::get('system', 'worker_daemon_mode', false)) {
726 self::IPCSetJobState(true);
733 // if there are too much worker, we don't spawn a new one.
734 if (Config::get('system', 'worker_daemon_mode', false) && ($active > $queues)) {
735 self::IPCSetJobState(false);
738 return $active > $queues;
742 * @brief Returns the number of active worker processes
744 * @return integer Number of active worker processes
747 private static function activeWorkers()
749 $stamp = (float)microtime(true);
750 $count = DBA::count('process', ['command' => 'Worker.php']);
751 self::$db_duration += (microtime(true) - $stamp);
756 * @brief Returns waiting jobs for the current process id
758 * @return array waiting workerqueue jobs
761 private static function getWaitingJobForPID()
763 $stamp = (float)microtime(true);
764 $r = DBA::select('workerqueue', [], ['pid' => getmypid(), 'done' => false]);
765 self::$db_duration += (microtime(true) - $stamp);
766 if (DBA::isResult($r)) {
767 return DBA::toArray($r);
775 * @brief Returns the next jobs that should be executed
777 * @return array array with next jobs
780 private static function nextProcess()
782 $priority = self::nextPriority();
783 if (empty($priority)) {
784 Logger::info('No tasks found');
788 $limit = Config::get('system', 'worker_fetch_limit', 1);
791 $stamp = (float)microtime(true);
792 $condition = ["`priority` = ? AND `pid` = 0 AND NOT `done` AND `next_try` < ?", $priority, DateTimeFormat::utcNow()];
793 $tasks = DBA::select('workerqueue', ['id', 'parameter'], $condition, ['limit' => $limit, 'order' => ['created']]);
794 self::$db_duration += (microtime(true) - $stamp);
795 while ($task = DBA::fetch($tasks)) {
796 $ids[] = $task['id'];
797 // Only continue that loop while we are storing commands that can be processed quickly
798 $command = json_decode($task['parameter'])[0];
799 if (!in_array($command, self::FAST_COMMANDS)) {
805 Logger::info('Found:', ['priority' => $priority, 'id' => $ids]);
810 * @brief Returns the priority of the next workerqueue job
812 * @return string priority
815 private static function nextPriority()
818 $priorities = [PRIORITY_CRITICAL, PRIORITY_HIGH, PRIORITY_MEDIUM, PRIORITY_LOW, PRIORITY_NEGLIGIBLE];
819 foreach ($priorities as $priority) {
820 $stamp = (float)microtime(true);
821 if (DBA::exists('workerqueue', ["`priority` = ? AND `pid` = 0 AND NOT `done` AND `next_try` < ?", $priority, DateTimeFormat::utcNow()])) {
822 $waiting[$priority] = true;
824 self::$db_duration += (microtime(true) - $stamp);
827 if (!empty($waiting[PRIORITY_CRITICAL])) {
828 return PRIORITY_CRITICAL;
833 $stamp = (float)microtime(true);
834 $processes = DBA::p("SELECT COUNT(DISTINCT(`process`.`pid`)) AS `running`, `priority` FROM `process`
835 INNER JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid`
836 WHERE NOT `done` GROUP BY `priority`");
837 self::$db_duration += (microtime(true) - $stamp);
838 while ($process = DBA::fetch($processes)) {
839 $running[$process['priority']] = $process['running'];
840 $running_total += $process['running'];
842 DBA::close($processes);
844 foreach ($priorities as $priority) {
845 if (!empty($waiting[$priority]) && empty($running[$priority])) {
846 Logger::info('No running worker found with priority {priority} - assigning it.', ['priority' => $priority]);
851 $active = max(self::activeWorkers(), $running_total);
852 $priorities = max(count($waiting), count($running));
856 for ($i = 1; $i <= $priorities; ++$i) {
857 $total += pow($i, $exponent);
861 for ($i = 1; $i <= $priorities; ++$i) {
862 $limit[$priorities - $i] = max(1, round($active * (pow($i, $exponent) / $total)));
866 foreach ($running as $priority => $workers) {
867 if ($workers < $limit[$i++]) {
868 Logger::info('Priority {priority} has got {workers} workers out of a limit of {limit}', ['priority' => $priority, 'workers' => $workers, 'limit' => $limit[$i - 1]]);
873 if (!empty($waiting)) {
874 $priority = array_keys($waiting)[0];
875 Logger::info('No underassigned priority found, now taking the highest priority.', ['priority' => $priority]);
883 * @brief Find and claim the next worker process for us
885 * @return boolean Have we found something?
886 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
888 private static function findWorkerProcesses()
892 $ids = self::nextProcess();
894 // If there is no result we check without priority limit
896 $limit = Config::get('system', 'worker_fetch_limit', 1);
898 $stamp = (float)microtime(true);
899 $condition = ["`pid` = 0 AND NOT `done` AND `next_try` < ?", DateTimeFormat::utcNow()];
900 $tasks = DBA::select('workerqueue', ['id', 'parameter'], $condition, ['limit' => $limit, 'order' => ['priority', 'created']]);
901 self::$db_duration += (microtime(true) - $stamp);
903 while ($task = DBA::fetch($tasks)) {
904 $ids[] = $task['id'];
905 // Only continue that loop while we are storing commands that can be processed quickly
906 $command = json_decode($task['parameter'])[0];
907 if (!in_array($command, self::FAST_COMMANDS)) {
915 $stamp = (float)microtime(true);
916 $condition = ['id' => $ids, 'done' => false, 'pid' => 0];
917 DBA::update('workerqueue', ['executed' => DateTimeFormat::utcNow(), 'pid' => $mypid], $condition);
918 self::$db_duration += (microtime(true) - $stamp);
919 self::$db_duration_write += (microtime(true) - $stamp);
926 * @brief Returns the next worker process
928 * @return string SQL statement
929 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
931 public static function workerProcess()
933 // There can already be jobs for us in the queue.
934 $waiting = self::getWaitingJobForPID();
935 if (!empty($waiting)) {
939 $stamp = (float)microtime(true);
940 if (!Lock::acquire('worker_process')) {
943 self::$lock_duration += (microtime(true) - $stamp);
945 $found = self::findWorkerProcesses();
947 Lock::release('worker_process');
950 $stamp = (float)microtime(true);
951 $r = DBA::select('workerqueue', [], ['pid' => getmypid(), 'done' => false]);
952 self::$db_duration += (microtime(true) - $stamp);
953 return DBA::toArray($r);
959 * @brief Removes a workerqueue entry from the current process
963 public static function unclaimProcess()
967 $stamp = (float)microtime(true);
968 DBA::update('workerqueue', ['executed' => DBA::NULL_DATETIME, 'pid' => 0], ['pid' => $mypid, 'done' => false]);
969 self::$db_duration += (microtime(true) - $stamp);
970 self::$db_duration_write += (microtime(true) - $stamp);
974 * @brief Call the front end worker
976 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
978 public static function callWorker()
980 if (!Config::get("system", "frontend_worker")) {
984 $url = System::baseUrl()."/worker";
985 Network::fetchUrl($url, false, 1);
989 * @brief Call the front end worker if there aren't any active
991 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
993 public static function executeIfIdle()
995 if (!Config::get("system", "frontend_worker")) {
999 // Do we have "proc_open"? Then we can fork the worker
1000 if (function_exists("proc_open")) {
1001 // When was the last time that we called the worker?
1002 // Less than one minute? Then we quit
1003 if ((time() - Config::get("system", "worker_started")) < 60) {
1007 Config::set("system", "worker_started", time());
1009 // Do we have enough running workers? Then we quit here.
1010 if (self::tooMuchWorkers()) {
1011 // Cleaning dead processes
1012 self::killStaleWorkers();
1013 Process::deleteInactive();
1020 Logger::log('Call worker', Logger::DEBUG);
1021 self::spawnWorker();
1025 // We cannot execute background processes.
1026 // We now run the processes from the frontend.
1027 // This won't work with long running processes.
1030 self::clearProcesses();
1032 $workers = self::activeWorkers();
1034 if ($workers == 0) {
1040 * @brief Removes long running worker processes
1042 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1044 public static function clearProcesses()
1046 $timeout = Config::get("system", "frontend_worker_timeout", 10);
1048 /// @todo We should clean up the corresponding workerqueue entries as well
1049 $stamp = (float)microtime(true);
1050 $condition = ["`created` < ? AND `command` = 'worker.php'",
1051 DateTimeFormat::utc("now - ".$timeout." minutes")];
1052 DBA::delete('process', $condition);
1053 self::$db_duration = (microtime(true) - $stamp);
1054 self::$db_duration_write += (microtime(true) - $stamp);
1058 * @brief Runs the cron processes
1060 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1062 private static function runCron()
1064 Logger::log('Add cron entries', Logger::DEBUG);
1066 // Check for spooled items
1067 self::add(['priority' => PRIORITY_HIGH, 'force_priority' => true], 'SpoolPost');
1069 // Run the cron job that calls all other jobs
1070 self::add(['priority' => PRIORITY_MEDIUM, 'force_priority' => true], 'Cron');
1072 // Cleaning dead processes
1073 self::killStaleWorkers();
1077 * @brief Spawns a new worker
1078 * @param bool $do_cron
1080 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1082 public static function spawnWorker($do_cron = false)
1084 $command = 'bin/worker.php';
1086 $args = ['no_cron' => !$do_cron];
1089 $process = new Core\Process(DI::logger(), DI::mode(), DI::config(), $a->getBasePath());
1090 $process->run($command, $args);
1092 // after spawning we have to remove the flag.
1093 if (Config::get('system', 'worker_daemon_mode', false)) {
1094 self::IPCSetJobState(false);
1099 * @brief Adds tasks to the worker queue
1101 * @param (integer|array) priority or parameter array, strings are deprecated and are ignored
1103 * next args are passed as $cmd command line
1104 * or: Worker::add(PRIORITY_HIGH, "Notifier", Delivery::DELETION, $drop_id);
1105 * or: Worker::add(array('priority' => PRIORITY_HIGH, 'dont_fork' => true), "CreateShadowEntry", $post_id);
1107 * @return boolean "false" if worker queue entry already existed or there had been an error
1108 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1109 * @note $cmd and string args are surrounded with ""
1115 public static function add($cmd)
1117 $args = func_get_args();
1119 if (!count($args)) {
1123 $arr = ['args' => $args, 'run_cmd' => true];
1125 Hook::callAll("proc_run", $arr);
1126 if (!$arr['run_cmd'] || !count($args)) {
1130 $priority = PRIORITY_MEDIUM;
1131 // Don't fork from frontend tasks by default
1132 $dont_fork = Config::get("system", "worker_dont_fork", false) || !DI::mode()->isBackend();
1133 $created = DateTimeFormat::utcNow();
1134 $force_priority = false;
1136 $run_parameter = array_shift($args);
1138 if (is_int($run_parameter)) {
1139 $priority = $run_parameter;
1140 } elseif (is_array($run_parameter)) {
1141 if (isset($run_parameter['priority'])) {
1142 $priority = $run_parameter['priority'];
1144 if (isset($run_parameter['created'])) {
1145 $created = $run_parameter['created'];
1147 if (isset($run_parameter['dont_fork'])) {
1148 $dont_fork = $run_parameter['dont_fork'];
1150 if (isset($run_parameter['force_priority'])) {
1151 $force_priority = $run_parameter['force_priority'];
1155 $parameters = json_encode($args);
1156 $found = DBA::exists('workerqueue', ['parameter' => $parameters, 'done' => false]);
1159 // Quit if there was a database error - a precaution for the update process to 3.5.3
1160 if (DBA::errorNo() != 0) {
1165 $added = DBA::insert('workerqueue', ['parameter' => $parameters, 'created' => $created, 'priority' => $priority]);
1169 } elseif ($force_priority) {
1170 DBA::update('workerqueue', ['priority' => $priority], ['parameter' => $parameters, 'done' => false, 'pid' => 0]);
1173 // Should we quit and wait for the worker to be called as a cronjob?
1178 // If there is a lock then we don't have to check for too much worker
1179 if (!Lock::acquire('worker', 0)) {
1183 // If there are already enough workers running, don't fork another one
1184 $quit = self::tooMuchWorkers();
1185 Lock::release('worker');
1191 // We tell the daemon that a new job entry exists
1192 if (Config::get('system', 'worker_daemon_mode', false)) {
1193 // We don't have to set the IPC flag - this is done in "tooMuchWorkers"
1197 // Now call the worker to execute the jobs that we just added to the queue
1198 self::spawnWorker();
1204 * Returns the next retrial level for worker jobs.
1205 * This function will skip levels when jobs are older.
1207 * @param array $queue Worker queue entry
1208 * @param integer $max_level maximum retrial level
1209 * @return integer the next retrial level value
1211 private static function getNextRetrial($queue, $max_level)
1213 $created = strtotime($queue['created']);
1214 $retrial_time = time() - $created;
1216 $new_retrial = $queue['retrial'] + 1;
1218 for ($retrial = 0; $retrial <= $max_level + 1; ++$retrial) {
1219 $delay = (($retrial + 3) ** 4) + (rand(1, 30) * ($retrial + 1));
1221 if (($total < $retrial_time) && ($retrial > $queue['retrial'])) {
1222 $new_retrial = $retrial;
1225 Logger::info('New retrial for task', ['id' => $queue['id'], 'created' => $queue['created'], 'old' => $queue['retrial'], 'new' => $new_retrial]);
1226 return $new_retrial;
1230 * Defers the current worker entry
1231 * @return boolean had the entry been deferred?
1233 public static function defer()
1235 if (empty(DI::app()->queue)) {
1239 $queue = DI::app()->queue;
1241 $retrial = $queue['retrial'];
1243 $priority = $queue['priority'];
1245 $max_level = Config::get('system', 'worker_defer_limit');
1247 $new_retrial = self::getNextRetrial($queue, $max_level);
1249 if ($new_retrial > $max_level) {
1250 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]);
1254 // Calculate the delay until the next trial
1255 $delay = (($new_retrial + 2) ** 4) + (rand(1, 30) * ($new_retrial));
1256 $next = DateTimeFormat::utc('now + ' . $delay . ' seconds');
1258 if (($priority < PRIORITY_MEDIUM) && ($new_retrial > 3)) {
1259 $priority = PRIORITY_MEDIUM;
1260 } elseif (($priority < PRIORITY_LOW) && ($new_retrial > 6)) {
1261 $priority = PRIORITY_LOW;
1262 } elseif (($priority < PRIORITY_NEGLIGIBLE) && ($new_retrial > 8)) {
1263 $priority = PRIORITY_NEGLIGIBLE;
1266 Logger::info('Deferred task', ['id' => $id, 'retrial' => $new_retrial, 'created' => $queue['created'], 'next_execution' => $next, 'old_prio' => $queue['priority'], 'new_prio' => $priority]);
1268 $stamp = (float)microtime(true);
1269 $fields = ['retrial' => $new_retrial, 'next_try' => $next, 'executed' => DBA::NULL_DATETIME, 'pid' => 0, 'priority' => $priority];
1270 DBA::update('workerqueue', $fields, ['id' => $id]);
1271 self::$db_duration += (microtime(true) - $stamp);
1272 self::$db_duration_write += (microtime(true) - $stamp);
1278 * Log active processes into the "process" table
1280 * @brief Log active processes into the "process" table
1282 public static function startProcess()
1284 $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 1);
1286 $command = basename($trace[0]['file']);
1288 Process::deleteInactive();
1290 Process::insert($command);
1294 * Remove the active process from the "process" table
1296 * @brief Remove the active process from the "process" table
1298 * @throws \Exception
1300 public static function endProcess()
1302 return Process::deleteByPid();
1306 * Set the flag if some job is waiting
1308 * @brief Set the flag if some job is waiting
1309 * @param boolean $jobs Is there a waiting job?
1310 * @throws \Exception
1312 public static function IPCSetJobState($jobs)
1314 $stamp = (float)microtime(true);
1315 DBA::update('worker-ipc', ['jobs' => $jobs], ['key' => 1], true);
1316 self::$db_duration += (microtime(true) - $stamp);
1317 self::$db_duration_write += (microtime(true) - $stamp);
1321 * Checks if some worker job waits to be executed
1323 * @brief Checks if some worker job waits to be executed
1325 * @throws \Exception
1327 public static function IPCJobsExists()
1329 $stamp = (float)microtime(true);
1330 $row = DBA::selectFirst('worker-ipc', ['jobs'], ['key' => 1]);
1331 self::$db_duration += (microtime(true) - $stamp);
1333 // When we don't have a row, no job is running
1334 if (!DBA::isResult($row)) {
1338 return (bool)$row['jobs'];