3 * @file src/Core/Worker.php
5 namespace Friendica\Core;
7 use Friendica\Core\Addon;
8 use Friendica\Core\Config;
9 use Friendica\Core\System;
10 use Friendica\Database\DBM;
11 use Friendica\Model\Process;
12 use Friendica\Util\DateTimeFormat;
13 use Friendica\Util\Lock;
14 use Friendica\Util\Network;
17 require_once 'include/dba.php';
20 * @file src/Core/Worker.php
22 * @brief Contains the class for the worker background job processing
26 * @brief Worker methods
30 private static $up_start;
31 private static $db_duration;
32 private static $last_update;
33 private static $lock_duration;
36 * @brief Processes the tasks that are in the workerqueue table
38 * @param boolean $run_cron Should the cron processes be executed?
41 public static function processQueue($run_cron = true)
45 self::$up_start = microtime(true);
47 // At first check the maximum load. We shouldn't continue with a high load
48 if ($a->maxload_reached()) {
49 logger('Pre check: maximum load reached, quitting.', LOGGER_DEBUG);
53 // We now start the process. This is done after the load check since this could increase the load.
56 // Kill stale processes every 5 minutes
57 $last_cleanup = Config::get('system', 'worker_last_cleaned', 0);
58 if (time() > ($last_cleanup + 300)) {
59 Config::set('system', 'worker_last_cleaned', time());
60 self::killStaleWorkers();
63 // Count active workers and compare them with a maximum value that depends on the load
64 if (self::tooMuchWorkers()) {
65 logger('Pre check: Active worker limit reached, quitting.', LOGGER_DEBUG);
69 // Do we have too few memory?
70 if ($a->min_memory_reached()) {
71 logger('Pre check: Memory limit reached, quitting.', LOGGER_DEBUG);
75 // Possibly there are too much database connections
76 if (self::maxConnectionsReached()) {
77 logger('Pre check: maximum connections reached, quitting.', LOGGER_DEBUG);
81 // Possibly there are too much database processes that block the system
82 if ($a->max_processes_reached()) {
83 logger('Pre check: maximum processes reached, quitting.', LOGGER_DEBUG);
87 // Now we start additional cron processes if we should do so
94 // We fetch the next queue entry that is about to be executed
95 while ($r = self::workerProcess($passing_slow)) {
96 // When we are processing jobs with a lower priority, we don't refetch new jobs
97 // Otherwise fast jobs could wait behind slow ones and could be blocked.
98 $refetched = $passing_slow;
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('Process execution failed, quitting.', LOGGER_DEBUG);
110 // If possible we will fetch new jobs for this worker
111 if (!$refetched && Lock::set('worker_process', 0)) {
112 $stamp = (float)microtime(true);
113 $refetched = self::findWorkerProcesses($passing_slow);
114 self::$db_duration += (microtime(true) - $stamp);
115 Lock::remove('worker_process');
119 // To avoid the quitting of multiple workers only one worker at a time will execute the check
120 if (Lock::set('worker', 0)) {
121 $stamp = (float)microtime(true);
122 // Count active workers and compare them with a maximum value that depends on the load
123 if (self::tooMuchWorkers()) {
124 logger('Active worker limit reached, quitting.', LOGGER_DEBUG);
129 if ($a->min_memory_reached()) {
130 logger('Memory limit reached, quitting.', LOGGER_DEBUG);
133 Lock::remove('worker');
134 self::$db_duration += (microtime(true) - $stamp);
137 // Quit the worker once every 5 minutes
138 if (time() > ($starttime + 300)) {
139 logger('Process lifetime reached, quitting.', LOGGER_DEBUG);
144 // Cleaning up. Possibly not needed, but it doesn't harm anything.
145 if (Config::get('system', 'worker_daemon_mode', false)) {
146 self::IPCSetJobState(false);
148 logger("Couldn't select a workerqueue entry, quitting.", LOGGER_DEBUG);
152 * @brief Returns the number of non executed entries in the worker queue
154 * @return integer Number of non executed entries in the worker queue
156 private static function totalEntries()
158 $s = dba::fetch_first("SELECT COUNT(*) AS `total` FROM `workerqueue` WHERE `executed` <= ? AND NOT `done`", NULL_DATE);
159 if (DBM::is_result($s)) {
167 * @brief Returns the highest priority in the worker queue that isn't executed
169 * @return integer Number of active worker processes
171 private static function highestPriority()
173 $condition = ["`executed` <= ? AND NOT `done`", NULL_DATE];
174 $workerqueue = dba::selectFirst('workerqueue', ['priority'], $condition, ['order' => ['priority']]);
175 if (DBM::is_result($workerqueue)) {
176 return $workerqueue["priority"];
183 * @brief Returns if a process with the given priority is running
185 * @param integer $priority The priority that should be checked
187 * @return integer Is there a process running with that priority?
189 private static function processWithPriorityActive($priority)
191 $condition = ["`priority` <= ? AND `executed` > ? AND NOT `done`", $priority, NULL_DATE];
192 return dba::exists('workerqueue', $condition);
196 * @brief Execute a worker entry
198 * @param array $queue Workerqueue entry
200 * @return boolean "true" if further processing should be stopped
202 public static function execute($queue)
208 // Quit when in maintenance
209 if (Config::get('system', 'maintenance', false, true)) {
210 logger("Maintenance mode - quit process ".$mypid, LOGGER_DEBUG);
214 // Constantly check the number of parallel database processes
215 if ($a->max_processes_reached()) {
216 logger("Max processes reached for process ".$mypid, LOGGER_DEBUG);
220 // Constantly check the number of available database connections to let the frontend be accessible at any time
221 if (self::maxConnectionsReached()) {
222 logger("Max connection reached for process ".$mypid, LOGGER_DEBUG);
226 $argv = json_decode($queue["parameter"], true);
228 // Check for existance and validity of the include file
231 if (method_exists(sprintf('Friendica\Worker\%s', $include), 'execute')) {
232 // We constantly update the "executed" date every minute to avoid being killed too soon
233 if (!isset(self::$last_update)) {
234 self::$last_update = strtotime($queue["executed"]);
237 $age = (time() - self::$last_update) / 60;
238 self::$last_update = time();
241 $stamp = (float)microtime(true);
242 dba::update('workerqueue', ['executed' => DateTimeFormat::utcNow()], ['pid' => $mypid, 'done' => false]);
243 self::$db_duration += (microtime(true) - $stamp);
248 self::execFunction($queue, $include, $argv, true);
250 $stamp = (float)microtime(true);
251 if (dba::update('workerqueue', ['done' => true], ['id' => $queue["id"]])) {
252 Config::set('system', 'last_worker_execution', DateTimeFormat::utcNow());
254 self::$db_duration = (microtime(true) - $stamp);
259 // The script could be provided as full path or only with the function name
260 if ($include == basename($include)) {
261 $include = "include/".$include.".php";
264 if (!validate_include($include)) {
265 logger("Include file ".$argv[0]." is not valid!");
266 dba::delete('workerqueue', ['id' => $queue["id"]]);
270 require_once $include;
272 $funcname = str_replace(".php", "", basename($argv[0]))."_run";
274 if (function_exists($funcname)) {
275 // We constantly update the "executed" date every minute to avoid being killed too soon
276 if (!isset(self::$last_update)) {
277 self::$last_update = strtotime($queue["executed"]);
280 $age = (time() - self::$last_update) / 60;
281 self::$last_update = time();
284 $stamp = (float)microtime(true);
285 dba::update('workerqueue', ['executed' => DateTimeFormat::utcNow()], ['pid' => $mypid, 'done' => false]);
286 self::$db_duration += (microtime(true) - $stamp);
289 self::execFunction($queue, $funcname, $argv, false);
291 $stamp = (float)microtime(true);
292 if (dba::update('workerqueue', ['done' => true], ['id' => $queue["id"]])) {
293 Config::set('system', 'last_worker_execution', DateTimeFormat::utcNow());
295 self::$db_duration = (microtime(true) - $stamp);
297 logger("Function ".$funcname." does not exist");
298 dba::delete('workerqueue', ['id' => $queue["id"]]);
305 * @brief Execute a function from the queue
307 * @param array $queue Workerqueue entry
308 * @param string $funcname name of the function
309 * @param array $argv Array of values to be passed to the function
310 * @param boolean $method_call boolean
313 private static function execFunction($queue, $funcname, $argv, $method_call)
319 $argc = count($argv);
321 $new_process_id = uniqid("wrk", true);
323 logger("Process ".$mypid." - Prio ".$queue["priority"]." - ID ".$queue["id"].": ".$funcname." ".$queue["parameter"]." - Process PID: ".$new_process_id);
325 $stamp = (float)microtime(true);
327 // We use the callstack here to analyze the performance of executed worker entries.
328 // For this reason the variables have to be initialized.
329 if (Config::get("system", "profiler")) {
330 $a->performance["start"] = microtime(true);
331 $a->performance["database"] = 0;
332 $a->performance["database_write"] = 0;
333 $a->performance["cache"] = 0;
334 $a->performance["cache_write"] = 0;
335 $a->performance["network"] = 0;
336 $a->performance["file"] = 0;
337 $a->performance["rendering"] = 0;
338 $a->performance["parser"] = 0;
339 $a->performance["marktime"] = 0;
340 $a->performance["markstart"] = microtime(true);
344 // For better logging create a new process id for every worker call
345 // But preserve the old one for the worker
346 $old_process_id = $a->process_id;
347 $a->process_id = $new_process_id;
350 $up_duration = number_format(microtime(true) - self::$up_start, 3);
352 // Reset global data to avoid interferences
356 call_user_func_array(sprintf('Friendica\Worker\%s::execute', $funcname), $argv);
358 $funcname($argv, $argc);
361 $a->process_id = $old_process_id;
364 $duration = number_format(microtime(true) - $stamp, 3);
366 self::$up_start = microtime(true);
368 /* With these values we can analyze how effective the worker is.
369 * The database and rest time should be low since this is the unproductive time.
370 * The execution time is the productive time.
371 * By changing parameters like the maximum number of workers we can check the effectivness.
374 'DB: '.number_format(self::$db_duration, 2).
375 ' - Lock: '.number_format(self::$lock_duration, 2).
376 ' - Rest: '.number_format($up_duration - self::$db_duration - self::$lock_duration, 2).
377 ' - Execution: '.number_format($duration, 2),
381 self::$lock_duration = 0;
383 if ($duration > 3600) {
384 logger("Prio ".$queue["priority"].": ".$queue["parameter"]." - longer than 1 hour (".round($duration/60, 3).")", LOGGER_DEBUG);
385 } elseif ($duration > 600) {
386 logger("Prio ".$queue["priority"].": ".$queue["parameter"]." - longer than 10 minutes (".round($duration/60, 3).")", LOGGER_DEBUG);
387 } elseif ($duration > 300) {
388 logger("Prio ".$queue["priority"].": ".$queue["parameter"]." - longer than 5 minutes (".round($duration/60, 3).")", LOGGER_DEBUG);
389 } elseif ($duration > 120) {
390 logger("Prio ".$queue["priority"].": ".$queue["parameter"]." - longer than 2 minutes (".round($duration/60, 3).")", LOGGER_DEBUG);
393 logger("Process ".$mypid." - Prio ".$queue["priority"]." - ID ".$queue["id"].": ".$funcname." - done in ".$duration." seconds. Process PID: ".$new_process_id);
395 // Write down the performance values into the log
396 if (Config::get("system", "profiler")) {
397 $duration = microtime(true)-$a->performance["start"];
400 if (Config::get("rendertime", "callstack")) {
401 if (isset($a->callstack["database"])) {
402 $o .= "\nDatabase Read:\n";
403 foreach ($a->callstack["database"] as $func => $time) {
404 $time = round($time, 3);
406 $o .= $func.": ".$time."\n";
410 if (isset($a->callstack["database_write"])) {
411 $o .= "\nDatabase Write:\n";
412 foreach ($a->callstack["database_write"] as $func => $time) {
413 $time = round($time, 3);
415 $o .= $func.": ".$time."\n";
419 if (isset($a->callstack["dache"])) {
420 $o .= "\nCache Read:\n";
421 foreach ($a->callstack["dache"] as $func => $time) {
422 $time = round($time, 3);
424 $o .= $func.": ".$time."\n";
428 if (isset($a->callstack["dache_write"])) {
429 $o .= "\nCache Write:\n";
430 foreach ($a->callstack["dache_write"] as $func => $time) {
431 $time = round($time, 3);
433 $o .= $func.": ".$time."\n";
437 if (isset($a->callstack["network"])) {
438 $o .= "\nNetwork:\n";
439 foreach ($a->callstack["network"] as $func => $time) {
440 $time = round($time, 3);
442 $o .= $func.": ".$time."\n";
449 "ID ".$queue["id"].": ".$funcname.": ".sprintf(
450 "DB: %s/%s, Cache: %s/%s, Net: %s, I/O: %s, Other: %s, Total: %s".$o,
451 number_format($a->performance["database"] - $a->performance["database_write"], 2),
452 number_format($a->performance["database_write"], 2),
453 number_format($a->performance["cache"], 2),
454 number_format($a->performance["cache_write"], 2),
455 number_format($a->performance["network"], 2),
456 number_format($a->performance["file"], 2),
457 number_format($duration - ($a->performance["database"]
458 + $a->performance["cache"] + $a->performance["cache_write"]
459 + $a->performance["network"] + $a->performance["file"]), 2),
460 number_format($duration, 2)
466 $cooldown = Config::get("system", "worker_cooldown", 0);
469 logger("Process ".$mypid." - Prio ".$queue["priority"]." - ID ".$queue["id"].": ".$funcname." - in cooldown for ".$cooldown." seconds");
475 * @brief Checks if the number of database connections has reached a critical limit.
477 * @return bool Are more than 3/4 of the maximum connections used?
479 private static function maxConnectionsReached()
481 // Fetch the max value from the config. This is needed when the system cannot detect the correct value by itself.
482 $max = Config::get("system", "max_connections");
484 // Fetch the percentage level where the worker will get active
485 $maxlevel = Config::get("system", "max_connections_level", 75);
488 // the maximum number of possible user connections can be a system variable
489 $r = dba::fetch_first("SHOW VARIABLES WHERE `variable_name` = 'max_user_connections'");
490 if (DBM::is_result($r)) {
493 // Or it can be granted. This overrides the system variable
494 $r = dba::p('SHOW GRANTS');
495 while ($grants = dba::fetch($r)) {
496 $grant = array_pop($grants);
497 if (stristr($grant, "GRANT USAGE ON")) {
498 if (preg_match("/WITH MAX_USER_CONNECTIONS (\d*)/", $grant, $match)) {
506 // If $max is set we will use the processlist to determine the current number of connections
507 // The processlist only shows entries of the current user
509 $r = dba::p('SHOW PROCESSLIST');
510 $used = dba::num_rows($r);
513 logger("Connection usage (user values): ".$used."/".$max, LOGGER_DEBUG);
515 $level = ($used / $max) * 100;
517 if ($level >= $maxlevel) {
518 logger("Maximum level (".$maxlevel."%) of user connections reached: ".$used."/".$max);
523 // We will now check for the system values.
524 // This limit could be reached although the user limits are fine.
525 $r = dba::fetch_first("SHOW VARIABLES WHERE `variable_name` = 'max_connections'");
526 if (!DBM::is_result($r)) {
529 $max = intval($r["Value"]);
533 $r = dba::fetch_first("SHOW STATUS WHERE `variable_name` = 'Threads_connected'");
534 if (!DBM::is_result($r)) {
537 $used = intval($r["Value"]);
541 logger("Connection usage (system values): ".$used."/".$max, LOGGER_DEBUG);
543 $level = $used / $max * 100;
545 if ($level < $maxlevel) {
548 logger("Maximum level (".$level."%) of system connections reached: ".$used."/".$max);
553 * @brief fix the queue entry if the worker process died
556 private static function killStaleWorkers()
558 $entries = dba::select(
560 ['id', 'pid', 'executed', 'priority', 'parameter'],
561 ['`executed` > ? AND NOT `done` AND `pid` != 0', NULL_DATE],
562 ['order' => ['priority', 'created']]
565 while ($entry = dba::fetch($entries)) {
566 if (!posix_kill($entry["pid"], 0)) {
569 ['executed' => NULL_DATE, 'pid' => 0],
570 ['id' => $entry["id"]]
573 // Kill long running processes
574 // Check if the priority is in a valid range
575 if (!in_array($entry["priority"], [PRIORITY_CRITICAL, PRIORITY_HIGH, PRIORITY_MEDIUM, PRIORITY_LOW, PRIORITY_NEGLIGIBLE])) {
576 $entry["priority"] = PRIORITY_MEDIUM;
579 // Define the maximum durations
580 $max_duration_defaults = [PRIORITY_CRITICAL => 720, PRIORITY_HIGH => 10, PRIORITY_MEDIUM => 60, PRIORITY_LOW => 180, PRIORITY_NEGLIGIBLE => 720];
581 $max_duration = $max_duration_defaults[$entry["priority"]];
583 $argv = json_decode($entry["parameter"], true);
584 $argv[0] = basename($argv[0]);
586 // How long is the process already running?
587 $duration = (time() - strtotime($entry["executed"])) / 60;
588 if ($duration > $max_duration) {
589 logger("Worker process ".$entry["pid"]." (".implode(" ", $argv).") took more than ".$max_duration." minutes. It will be killed now.");
590 posix_kill($entry["pid"], SIGTERM);
592 // We killed the stale process.
593 // To avoid a blocking situation we reschedule the process at the beginning of the queue.
594 // Additionally we are lowering the priority. (But not PRIORITY_CRITICAL)
595 $new_priority = $entry["priority"];
596 if ($entry["priority"] == PRIORITY_HIGH) {
597 $new_priority = PRIORITY_MEDIUM;
598 } elseif ($entry["priority"] == PRIORITY_MEDIUM) {
599 $new_priority = PRIORITY_LOW;
600 } elseif ($entry["priority"] != PRIORITY_CRITICAL) {
601 $new_priority = PRIORITY_NEGLIGIBLE;
605 ['executed' => NULL_DATE, 'created' => DateTimeFormat::utcNow(), 'priority' => $new_priority, 'pid' => 0],
606 ['id' => $entry["id"]]
609 logger("Worker process ".$entry["pid"]." (".implode(" ", $argv).") now runs for ".round($duration)." of ".$max_duration." allowed minutes. That's okay.", LOGGER_DEBUG);
616 * @brief Checks if the number of active workers exceeds the given limits
618 * @return bool Are there too much workers running?
620 public static function tooMuchWorkers()
622 $queues = Config::get("system", "worker_queues", 4);
624 $maxqueues = $queues;
626 $active = self::activeWorkers();
628 // Decrease the number of workers at higher load
629 $load = current_load();
631 $maxsysload = intval(Config::get("system", "maxloadavg", 50));
633 $maxworkers = $queues;
635 // Some magical mathemathics to reduce the workers
637 $slope = $maxworkers / pow($maxsysload, $exponent);
638 $queues = ceil($slope * pow(max(0, $maxsysload - $load), $exponent));
641 if (Config::get('system', 'worker_debug')) {
642 // Create a list of queue entries grouped by their priority
645 // Adding all processes with no workerqueue entry
647 "SELECT COUNT(*) AS `running` FROM `process` WHERE NOT EXISTS
648 (SELECT id FROM `workerqueue`
649 WHERE `workerqueue`.`pid` = `process`.`pid` AND NOT `done` AND `pid` != ?)",
653 if ($process = dba::fetch($processes)) {
654 $listitem[0] = "0:".$process["running"];
656 dba::close($processes);
658 // Now adding all processes with workerqueue entries
659 $entries = dba::p("SELECT COUNT(*) AS `entries`, `priority` FROM `workerqueue` WHERE NOT `done` GROUP BY `priority`");
660 while ($entry = dba::fetch($entries)) {
661 $processes = dba::p("SELECT COUNT(*) AS `running` FROM `process` INNER JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid` AND NOT `done` WHERE `priority` = ?", $entry["priority"]);
662 if ($process = dba::fetch($processes)) {
663 $listitem[$entry["priority"]] = $entry["priority"].":".$process["running"]."/".$entry["entries"];
665 dba::close($processes);
667 dba::close($entries);
669 $intervals = [1, 10, 60];
670 $jobs_per_minute = [];
671 foreach ($intervals as $interval) {
672 $jobs = dba::p("SELECT COUNT(*) AS `jobs` FROM `workerqueue` WHERE `done` AND `executed` > UTC_TIMESTAMP() - INTERVAL ".intval($interval)." MINUTE");
673 if ($job = dba::fetch($jobs)) {
674 $jobs_per_minute[$interval] = number_format($job['jobs'] / $interval, 0);
678 $processlist = ' - jpm: '.implode('/', $jobs_per_minute).' ('.implode(', ', $listitem).')';
681 $entries = self::totalEntries();
683 if (Config::get("system", "worker_fastlane", false) && ($queues > 0) && ($entries > 0) && ($active >= $queues)) {
684 $top_priority = self::highestPriority();
685 $high_running = self::processWithPriorityActive($top_priority);
687 if (!$high_running && ($top_priority > PRIORITY_UNDEFINED) && ($top_priority < PRIORITY_NEGLIGIBLE)) {
688 logger("There are jobs with priority ".$top_priority." waiting but none is executed. Open a fastlane.", LOGGER_DEBUG);
689 $queues = $active + 1;
693 logger("Load: ".$load."/".$maxsysload." - processes: ".$active."/".$entries.$processlist." - maximum: ".$queues."/".$maxqueues, LOGGER_DEBUG);
695 // Are there fewer workers running as possible? Then fork a new one.
696 if (!Config::get("system", "worker_dont_fork", false) && ($queues > ($active + 1)) && ($entries > 1)) {
697 logger("Active workers: ".$active."/".$queues." Fork a new worker.", LOGGER_DEBUG);
698 if (Config::get('system', 'worker_daemon_mode', false)) {
699 self::IPCSetJobState(true);
706 // if there are too much worker, we down't spawn a new one.
707 if (Config::get('system', 'worker_daemon_mode', false) && ($active >= $queues)) {
708 self::IPCSetJobState(false);
711 return $active >= $queues;
715 * @brief Returns the number of active worker processes
717 * @return integer Number of active worker processes
719 private static function activeWorkers()
721 $workers = dba::fetch_first("SELECT COUNT(*) AS `processes` FROM `process` WHERE `command` = 'Worker.php'");
723 return $workers["processes"];
727 * @brief Check if we should pass some slow processes
729 * When the active processes of the highest priority are using more than 2/3
730 * of all processes, we let pass slower processes.
732 * @param string $highest_priority Returns the currently highest priority
733 * @return bool We let pass a slower process than $highest_priority
735 private static function passingSlow(&$highest_priority)
737 $highest_priority = 0;
742 INNER JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid` AND NOT `done`"
745 // No active processes at all? Fine
746 if (!DBM::is_result($r)) {
750 while ($line = dba::fetch($r)) {
751 $priorities[] = $line["priority"];
756 if (count($priorities) == 0) {
759 $highest_priority = min($priorities);
761 // The highest process is already the slowest one?
763 if ($highest_priority == PRIORITY_NEGLIGIBLE) {
767 foreach ($priorities as $priority) {
768 if ($priority == $highest_priority) {
772 logger("Highest priority: ".$highest_priority." Total processes: ".count($priorities)." Count high priority processes: ".$high, LOGGER_DEBUG);
773 $passing_slow = (($high/count($priorities)) > (2/3));
776 logger("Passing slower processes than priority ".$highest_priority, LOGGER_DEBUG);
778 return $passing_slow;
782 * @brief Find and claim the next worker process for us
784 * @param boolean $passing_slow Returns if we had passed low priority processes
785 * @return boolean Have we found something?
787 private static function findWorkerProcesses(&$passing_slow)
791 // Check if we should pass some low priority process
792 $highest_priority = 0;
794 $passing_slow = false;
796 // The higher the number of parallel workers, the more we prefetch to prevent concurring access
797 // We decrease the limit with the number of entries left in the queue
798 $worker_queues = Config::get("system", "worker_queues", 4);
799 $queue_length = Config::get('system', 'worker_fetch_limit', 1);
800 $lower_job_limit = $worker_queues * $queue_length * 2;
801 $jobs = self::totalEntries();
805 $slope = $queue_length / pow($lower_job_limit, $exponent);
806 $limit = min($queue_length, ceil($slope * pow($jobs, $exponent)));
808 logger('Total: '.$jobs.' - Maximum: '.$queue_length.' - jobs per queue: '.$limit, LOGGER_DEBUG);
810 if (self::passingSlow($highest_priority)) {
811 // Are there waiting processes with a higher priority than the currently highest?
812 $result = dba::select(
815 ["`executed` <= ? AND `priority` < ? AND NOT `done`", NULL_DATE, $highest_priority],
816 ['limit' => $limit, 'order' => ['priority', 'created']]
819 while ($id = dba::fetch($result)) {
824 $found = (count($ids) > 0);
827 // Give slower processes some processing time
828 $result = dba::select(
831 ["`executed` <= ? AND `priority` > ? AND NOT `done`", NULL_DATE, $highest_priority],
832 ['limit' => $limit, 'order' => ['priority', 'created']]
835 while ($id = dba::fetch($result)) {
840 $found = (count($ids) > 0);
841 $passing_slow = $found;
845 // If there is no result (or we shouldn't pass lower processes) we check without priority limit
847 $result = dba::select(
850 ["`executed` <= ? AND NOT `done`", NULL_DATE],
851 ['limit' => $limit, 'order' => ['priority', 'created']]
854 while ($id = dba::fetch($result)) {
859 $found = (count($ids) > 0);
863 $condition = "`id` IN (".substr(str_repeat("?, ", count($ids)), 0, -2).") AND `pid` = 0 AND NOT `done`";
864 array_unshift($ids, $condition);
865 dba::update('workerqueue', ['executed' => DateTimeFormat::utcNow(), 'pid' => $mypid], $ids);
872 * @brief Returns the next worker process
874 * @param boolean $passing_slow Returns if we had passed low priority processes
875 * @return string SQL statement
877 public static function workerProcess(&$passing_slow)
879 $stamp = (float)microtime(true);
881 // There can already be jobs for us in the queue.
882 $r = dba::select('workerqueue', [], ['pid' => getmypid(), 'done' => false]);
883 if (DBM::is_result($r)) {
884 self::$db_duration += (microtime(true) - $stamp);
885 return dba::inArray($r);
889 $stamp = (float)microtime(true);
890 if (!Lock::set('worker_process')) {
893 self::$lock_duration = (microtime(true) - $stamp);
895 $stamp = (float)microtime(true);
896 $found = self::findWorkerProcesses($passing_slow);
897 self::$db_duration += (microtime(true) - $stamp);
899 Lock::remove('worker_process');
902 $r = dba::select('workerqueue', [], ['pid' => getmypid(), 'done' => false]);
903 return dba::inArray($r);
909 * @brief Removes a workerqueue entry from the current process
912 public static function unclaimProcess()
916 dba::update('workerqueue', ['executed' => NULL_DATE, 'pid' => 0], ['pid' => $mypid, 'done' => false]);
920 * @brief Call the front end worker
923 public static function callWorker()
925 if (!Config::get("system", "frontend_worker")) {
929 $url = System::baseUrl()."/worker";
930 Network::fetchUrl($url, false, $redirects, 1);
934 * @brief Call the front end worker if there aren't any active
937 public static function executeIfIdle()
939 if (!Config::get("system", "frontend_worker")) {
943 // Do we have "proc_open"? Then we can fork the worker
944 if (function_exists("proc_open")) {
945 // When was the last time that we called the worker?
946 // Less than one minute? Then we quit
947 if ((time() - Config::get("system", "worker_started")) < 60) {
951 Config::set("system", "worker_started", time());
953 // Do we have enough running workers? Then we quit here.
954 if (self::tooMuchWorkers()) {
955 // Cleaning dead processes
956 self::killStaleWorkers();
957 Process::deleteInactive();
964 logger('Call worker', LOGGER_DEBUG);
969 // We cannot execute background processes.
970 // We now run the processes from the frontend.
971 // This won't work with long running processes.
974 self::clearProcesses();
976 $workers = dba::fetch_first("SELECT COUNT(*) AS `processes` FROM `process` WHERE `command` = 'worker.php'");
978 if ($workers["processes"] == 0) {
984 * @brief Removes long running worker processes
987 public static function clearProcesses()
989 $timeout = Config::get("system", "frontend_worker_timeout", 10);
991 /// @todo We should clean up the corresponding workerqueue entries as well
992 $condition = ["`created` < ? AND `command` = 'worker.php'",
993 DateTimeFormat::utc("now - ".$timeout." minutes")];
994 dba::delete('process', $condition);
998 * @brief Runs the cron processes
1001 private static function runCron()
1003 logger('Add cron entries', LOGGER_DEBUG);
1005 // Check for spooled items
1006 self::add(PRIORITY_HIGH, "SpoolPost");
1008 // Run the cron job that calls all other jobs
1009 self::add(PRIORITY_MEDIUM, "Cron");
1011 // Cleaning dead processes
1012 self::killStaleWorkers();
1016 * @brief Spawns a new worker
1019 public static function spawnWorker($do_cron = false)
1021 $args = ["bin/worker.php"];
1024 $args[] = "no_cron";
1027 get_app()->proc_run($args);
1029 // after spawning we have to remove the flag.
1030 if (Config::get('system', 'worker_daemon_mode', false)) {
1031 self::IPCSetJobState(false);
1036 * @brief Adds tasks to the worker queue
1038 * @param (integer|array) priority or parameter array, strings are deprecated and are ignored
1040 * next args are passed as $cmd command line
1041 * or: Worker::add(PRIORITY_HIGH, "Notifier", "drop", $drop_id);
1042 * or: Worker::add(array('priority' => PRIORITY_HIGH, 'dont_fork' => true), "CreateShadowEntry", $post_id);
1044 * @note $cmd and string args are surrounded with ""
1049 * @return boolean "false" if proc_run couldn't be executed
1051 public static function add($cmd)
1053 $args = func_get_args();
1055 if (!count($args)) {
1059 $arr = ['args' => $args, 'run_cmd' => true];
1061 Addon::callHooks("proc_run", $arr);
1062 if (!$arr['run_cmd'] || !count($args)) {
1066 $priority = PRIORITY_MEDIUM;
1067 $dont_fork = Config::get("system", "worker_dont_fork", false);
1068 $created = DateTimeFormat::utcNow();
1070 $run_parameter = array_shift($args);
1072 if (is_int($run_parameter)) {
1073 $priority = $run_parameter;
1074 } elseif (is_array($run_parameter)) {
1075 if (isset($run_parameter['priority'])) {
1076 $priority = $run_parameter['priority'];
1078 if (isset($run_parameter['created'])) {
1079 $created = $run_parameter['created'];
1081 if (isset($run_parameter['dont_fork'])) {
1082 $dont_fork = $run_parameter['dont_fork'];
1086 $parameters = json_encode($args);
1087 $found = dba::exists('workerqueue', ['parameter' => $parameters, 'done' => false]);
1089 // Quit if there was a database error - a precaution for the update process to 3.5.3
1090 if (dba::errorNo() != 0) {
1095 dba::insert('workerqueue', ['parameter' => $parameters, 'created' => $created, 'priority' => $priority]);
1098 // Should we quit and wait for the worker to be called as a cronjob?
1103 // If there is a lock then we don't have to check for too much worker
1104 if (!Lock::set('worker', 0)) {
1108 // If there are already enough workers running, don't fork another one
1109 $quit = self::tooMuchWorkers();
1110 Lock::remove('worker');
1116 // We tell the daemon that a new job entry exists
1117 if (Config::get('system', 'worker_daemon_mode', false)) {
1118 // We don't have to set the IPC flag - this is done in "tooMuchWorkers"
1122 // Now call the worker to execute the jobs that we just added to the queue
1123 self::spawnWorker();
1129 * Log active processes into the "process" table
1131 * @brief Log active processes into the "process" table
1133 public static function startProcess()
1135 $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 1);
1137 $command = basename($trace[0]['file']);
1139 Process::deleteInactive();
1141 Process::insert($command);
1145 * Remove the active process from the "process" table
1147 * @brief Remove the active process from the "process" table
1150 public static function endProcess()
1152 return Process::deleteByPid();
1156 * Set the flag if some job is waiting
1158 * @brief Set the flag if some job is waiting
1159 * @param boolean $jobs Is there a waiting job?
1161 public static function IPCSetJobState($jobs)
1163 dba::update('worker-ipc', ['jobs' => $jobs], ['key' => 1], true);
1167 * Checks if some worker job waits to be executed
1169 * @brief Checks if some worker job waits to be executed
1172 public static function IPCJobsExists()
1174 $row = dba::selectFirst('worker-ipc', ['jobs'], ['key' => 1]);
1176 // When we don't have a row, no job is running
1177 if (!DBM::is_result($row)) {
1181 return (bool)$row['jobs'];