3 * @file src/Core/Worker.php
5 namespace Friendica\Core;
7 use Friendica\BaseObject;
8 use Friendica\Core\Logger;
9 use Friendica\Database\DBA;
10 use Friendica\Model\Process;
11 use Friendica\Util\DateTimeFormat;
12 use Friendica\Util\Network;
14 require_once 'include/dba.php';
17 * @file src/Core/Worker.php
19 * @brief Contains the class for the worker background job processing
23 * @brief Worker methods
27 private static $up_start;
28 private static $db_duration;
29 private static $last_update;
30 private static $lock_duration;
33 * @brief Processes the tasks that are in the workerqueue table
35 * @param boolean $run_cron Should the cron processes be executed?
38 public static function processQueue($run_cron = true)
42 self::$up_start = microtime(true);
44 // At first check the maximum load. We shouldn't continue with a high load
45 if ($a->isMaxLoadReached()) {
46 Logger::log('Pre check: maximum load reached, quitting.', LOGGER_DEBUG);
50 // We now start the process. This is done after the load check since this could increase the load.
53 // Kill stale processes every 5 minutes
54 $last_cleanup = Config::get('system', 'worker_last_cleaned', 0);
55 if (time() > ($last_cleanup + 300)) {
56 Config::set('system', 'worker_last_cleaned', time());
57 self::killStaleWorkers();
60 // Count active workers and compare them with a maximum value that depends on the load
61 if (self::tooMuchWorkers()) {
62 Logger::log('Pre check: Active worker limit reached, quitting.', LOGGER_DEBUG);
66 // Do we have too few memory?
67 if ($a->isMinMemoryReached()) {
68 Logger::log('Pre check: Memory limit reached, quitting.', LOGGER_DEBUG);
72 // Possibly there are too much database connections
73 if (self::maxConnectionsReached()) {
74 Logger::log('Pre check: maximum connections reached, quitting.', LOGGER_DEBUG);
78 // Possibly there are too much database processes that block the system
79 if ($a->isMaxProcessesReached()) {
80 Logger::log('Pre check: maximum processes reached, quitting.', LOGGER_DEBUG);
84 // Now we start additional cron processes if we should do so
91 // We fetch the next queue entry that is about to be executed
92 while ($r = self::workerProcess($passing_slow)) {
93 // When we are processing jobs with a lower priority, we don't refetch new jobs
94 // Otherwise fast jobs could wait behind slow ones and could be blocked.
95 $refetched = $passing_slow;
97 foreach ($r as $entry) {
98 // Assure that the priority is an integer value
99 $entry['priority'] = (int)$entry['priority'];
101 // The work will be done
102 if (!self::execute($entry)) {
103 Logger::log('Process execution failed, quitting.', LOGGER_DEBUG);
107 // If possible we will fetch new jobs for this worker
108 if (!$refetched && Lock::acquire('worker_process', 0)) {
109 $stamp = (float)microtime(true);
110 $refetched = self::findWorkerProcesses($passing_slow);
111 self::$db_duration += (microtime(true) - $stamp);
112 Lock::release('worker_process');
116 // To avoid the quitting of multiple workers only one worker at a time will execute the check
117 if (Lock::acquire('worker', 0)) {
118 $stamp = (float)microtime(true);
119 // Count active workers and compare them with a maximum value that depends on the load
120 if (self::tooMuchWorkers()) {
121 Logger::log('Active worker limit reached, quitting.', LOGGER_DEBUG);
122 Lock::release('worker');
127 if ($a->isMinMemoryReached()) {
128 Logger::log('Memory limit reached, quitting.', LOGGER_DEBUG);
129 Lock::release('worker');
132 Lock::release('worker');
133 self::$db_duration += (microtime(true) - $stamp);
136 // Quit the worker once every 5 minutes
137 if (time() > ($starttime + 300)) {
138 Logger::log('Process lifetime reached, quitting.', LOGGER_DEBUG);
143 // Cleaning up. Possibly not needed, but it doesn't harm anything.
144 if (Config::get('system', 'worker_daemon_mode', false)) {
145 self::IPCSetJobState(false);
147 Logger::log("Couldn't select a workerqueue entry, quitting process " . getmypid() . ".", LOGGER_DEBUG);
151 * @brief Returns the number of deferred entries in the worker queue
153 * @return integer Number of deferred entries in the worker queue
155 private static function deferredEntries()
157 return DBA::count('workerqueue', ["`executed` <= ? AND NOT `done` AND `next_try` > ?",
158 DBA::NULL_DATETIME, DateTimeFormat::utcNow()]);
162 * @brief Returns the number of non executed entries in the worker queue
164 * @return integer Number of non executed entries in the worker queue
166 private static function totalEntries()
168 return DBA::count('workerqueue', ["`executed` <= ? AND NOT `done` AND `next_try` < ?",
169 DBA::NULL_DATETIME, DateTimeFormat::utcNow()]);
173 * @brief Returns the highest priority in the worker queue that isn't executed
175 * @return integer Number of active worker processes
177 private static function highestPriority()
179 $condition = ["`executed` <= ? AND NOT `done` AND `next_try` < ?", DBA::NULL_DATETIME, DateTimeFormat::utcNow()];
180 $workerqueue = DBA::selectFirst('workerqueue', ['priority'], $condition, ['order' => ['priority']]);
181 if (DBA::isResult($workerqueue)) {
182 return $workerqueue["priority"];
189 * @brief Returns if a process with the given priority is running
191 * @param integer $priority The priority that should be checked
193 * @return integer Is there a process running with that priority?
195 private static function processWithPriorityActive($priority)
197 $condition = ["`priority` <= ? AND `executed` > ? AND NOT `done` AND `next_try` < ?",
198 $priority, DBA::NULL_DATETIME, DateTimeFormat::utcNow()];
199 return DBA::exists('workerqueue', $condition);
203 * @brief Execute a worker entry
205 * @param array $queue Workerqueue entry
207 * @return boolean "true" if further processing should be stopped
209 public static function execute($queue)
215 // Quit when in maintenance
216 if (Config::get('system', 'maintenance', false, true)) {
217 Logger::log("Maintenance mode - quit process ".$mypid, LOGGER_DEBUG);
221 // Constantly check the number of parallel database processes
222 if ($a->isMaxProcessesReached()) {
223 Logger::log("Max processes reached for process ".$mypid, LOGGER_DEBUG);
227 // Constantly check the number of available database connections to let the frontend be accessible at any time
228 if (self::maxConnectionsReached()) {
229 Logger::log("Max connection reached for process ".$mypid, LOGGER_DEBUG);
233 $argv = json_decode($queue["parameter"], true);
235 // Check for existance and validity of the include file
238 if (method_exists(sprintf('Friendica\Worker\%s', $include), 'execute')) {
239 // We constantly update the "executed" date every minute to avoid being killed too soon
240 if (!isset(self::$last_update)) {
241 self::$last_update = strtotime($queue["executed"]);
244 $age = (time() - self::$last_update) / 60;
245 self::$last_update = time();
248 $stamp = (float)microtime(true);
249 DBA::update('workerqueue', ['executed' => DateTimeFormat::utcNow()], ['pid' => $mypid, 'done' => false]);
250 self::$db_duration += (microtime(true) - $stamp);
255 self::execFunction($queue, $include, $argv, true);
257 $stamp = (float)microtime(true);
259 $condition = ["`id` = ? AND `next_try` < ?", $queue['id'], DateTimeFormat::utcNow()];
260 if (DBA::update('workerqueue', ['done' => true], $condition)) {
261 Config::set('system', 'last_worker_execution', DateTimeFormat::utcNow());
263 self::$db_duration = (microtime(true) - $stamp);
268 // The script could be provided as full path or only with the function name
269 if ($include == basename($include)) {
270 $include = "include/".$include.".php";
273 if (!validate_include($include)) {
274 Logger::log("Include file ".$argv[0]." is not valid!");
275 DBA::delete('workerqueue', ['id' => $queue["id"]]);
279 require_once $include;
281 $funcname = str_replace(".php", "", basename($argv[0]))."_run";
283 if (function_exists($funcname)) {
284 // We constantly update the "executed" date every minute to avoid being killed too soon
285 if (!isset(self::$last_update)) {
286 self::$last_update = strtotime($queue["executed"]);
289 $age = (time() - self::$last_update) / 60;
290 self::$last_update = time();
293 $stamp = (float)microtime(true);
294 DBA::update('workerqueue', ['executed' => DateTimeFormat::utcNow()], ['pid' => $mypid, 'done' => false]);
295 self::$db_duration += (microtime(true) - $stamp);
298 self::execFunction($queue, $funcname, $argv, false);
300 $stamp = (float)microtime(true);
301 if (DBA::update('workerqueue', ['done' => true], ['id' => $queue["id"]])) {
302 Config::set('system', 'last_worker_execution', DateTimeFormat::utcNow());
304 self::$db_duration = (microtime(true) - $stamp);
306 Logger::log("Function ".$funcname." does not exist");
307 DBA::delete('workerqueue', ['id' => $queue["id"]]);
314 * @brief Execute a function from the queue
316 * @param array $queue Workerqueue entry
317 * @param string $funcname name of the function
318 * @param array $argv Array of values to be passed to the function
319 * @param boolean $method_call boolean
322 private static function execFunction($queue, $funcname, $argv, $method_call)
328 $argc = count($argv);
330 $new_process_id = System::processID("wrk");
332 Logger::log("Process ".$mypid." - Prio ".$queue["priority"]." - ID ".$queue["id"].": ".$funcname." ".$queue["parameter"]." - Process PID: ".$new_process_id);
334 $stamp = (float)microtime(true);
336 // We use the callstack here to analyze the performance of executed worker entries.
337 // For this reason the variables have to be initialized.
338 if (Config::get("system", "profiler")) {
339 $a->performance["start"] = microtime(true);
340 $a->performance["database"] = 0;
341 $a->performance["database_write"] = 0;
342 $a->performance["cache"] = 0;
343 $a->performance["cache_write"] = 0;
344 $a->performance["network"] = 0;
345 $a->performance["file"] = 0;
346 $a->performance["rendering"] = 0;
347 $a->performance["parser"] = 0;
348 $a->performance["marktime"] = 0;
349 $a->performance["markstart"] = microtime(true);
353 // For better logging create a new process id for every worker call
354 // But preserve the old one for the worker
355 $old_process_id = $a->process_id;
356 $a->process_id = $new_process_id;
359 $up_duration = number_format(microtime(true) - self::$up_start, 3);
361 // Reset global data to avoid interferences
365 call_user_func_array(sprintf('Friendica\Worker\%s::execute', $funcname), $argv);
367 $funcname($argv, $argc);
370 $a->process_id = $old_process_id;
373 $duration = (microtime(true) - $stamp);
375 self::$up_start = microtime(true);
377 /* With these values we can analyze how effective the worker is.
378 * The database and rest time should be low since this is the unproductive time.
379 * The execution time is the productive time.
380 * By changing parameters like the maximum number of workers we can check the effectivness.
383 'DB: '.number_format(self::$db_duration, 2).
384 ' - Lock: '.number_format(self::$lock_duration, 2).
385 ' - Rest: '.number_format($up_duration - self::$db_duration - self::$lock_duration, 2).
386 ' - Execution: '.number_format($duration, 2),
390 self::$lock_duration = 0;
392 if ($duration > 3600) {
393 Logger::log("Prio ".$queue["priority"].": ".$queue["parameter"]." - longer than 1 hour (".round($duration/60, 3).")", LOGGER_DEBUG);
394 } elseif ($duration > 600) {
395 Logger::log("Prio ".$queue["priority"].": ".$queue["parameter"]." - longer than 10 minutes (".round($duration/60, 3).")", LOGGER_DEBUG);
396 } elseif ($duration > 300) {
397 Logger::log("Prio ".$queue["priority"].": ".$queue["parameter"]." - longer than 5 minutes (".round($duration/60, 3).")", LOGGER_DEBUG);
398 } elseif ($duration > 120) {
399 Logger::log("Prio ".$queue["priority"].": ".$queue["parameter"]." - longer than 2 minutes (".round($duration/60, 3).")", LOGGER_DEBUG);
402 Logger::log("Process ".$mypid." - Prio ".$queue["priority"]." - ID ".$queue["id"].": ".$funcname." - done in ".$duration." seconds. Process PID: ".$new_process_id);
404 // Write down the performance values into the log
405 if (Config::get("system", "profiler")) {
406 $duration = microtime(true)-$a->performance["start"];
409 if (Config::get("rendertime", "callstack")) {
410 if (isset($a->callstack["database"])) {
411 $o .= "\nDatabase Read:\n";
412 foreach ($a->callstack["database"] as $func => $time) {
413 $time = round($time, 3);
415 $o .= $func.": ".$time."\n";
419 if (isset($a->callstack["database_write"])) {
420 $o .= "\nDatabase Write:\n";
421 foreach ($a->callstack["database_write"] as $func => $time) {
422 $time = round($time, 3);
424 $o .= $func.": ".$time."\n";
428 if (isset($a->callstack["dache"])) {
429 $o .= "\nCache Read:\n";
430 foreach ($a->callstack["dache"] as $func => $time) {
431 $time = round($time, 3);
433 $o .= $func.": ".$time."\n";
437 if (isset($a->callstack["dache_write"])) {
438 $o .= "\nCache Write:\n";
439 foreach ($a->callstack["dache_write"] as $func => $time) {
440 $time = round($time, 3);
442 $o .= $func.": ".$time."\n";
446 if (isset($a->callstack["network"])) {
447 $o .= "\nNetwork:\n";
448 foreach ($a->callstack["network"] as $func => $time) {
449 $time = round($time, 3);
451 $o .= $func.": ".$time."\n";
458 "ID ".$queue["id"].": ".$funcname.": ".sprintf(
459 "DB: %s/%s, Cache: %s/%s, Net: %s, I/O: %s, Other: %s, Total: %s".$o,
460 number_format($a->performance["database"] - $a->performance["database_write"], 2),
461 number_format($a->performance["database_write"], 2),
462 number_format($a->performance["cache"], 2),
463 number_format($a->performance["cache_write"], 2),
464 number_format($a->performance["network"], 2),
465 number_format($a->performance["file"], 2),
466 number_format($duration - ($a->performance["database"]
467 + $a->performance["cache"] + $a->performance["cache_write"]
468 + $a->performance["network"] + $a->performance["file"]), 2),
469 number_format($duration, 2)
475 $cooldown = Config::get("system", "worker_cooldown", 0);
478 Logger::log("Process ".$mypid." - Prio ".$queue["priority"]." - ID ".$queue["id"].": ".$funcname." - in cooldown for ".$cooldown." seconds");
484 * @brief 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?
488 private static function maxConnectionsReached()
490 // Fetch the max value from the config. This is needed when the system cannot detect the correct value by itself.
491 $max = Config::get("system", "max_connections");
493 // Fetch the percentage level where the worker will get active
494 $maxlevel = Config::get("system", "max_connections_level", 75);
497 // the maximum number of possible user connections can be a system variable
498 $r = DBA::fetchFirst("SHOW VARIABLES WHERE `variable_name` = 'max_user_connections'");
499 if (DBA::isResult($r)) {
502 // Or it can be granted. This overrides the system variable
503 $r = DBA::p('SHOW GRANTS');
504 while ($grants = DBA::fetch($r)) {
505 $grant = array_pop($grants);
506 if (stristr($grant, "GRANT USAGE ON")) {
507 if (preg_match("/WITH MAX_USER_CONNECTIONS (\d*)/", $grant, $match)) {
515 // If $max is set we will use the processlist to determine the current number of connections
516 // The processlist only shows entries of the current user
518 $r = DBA::p('SHOW PROCESSLIST');
519 $used = DBA::numRows($r);
522 Logger::log("Connection usage (user values): ".$used."/".$max, LOGGER_DEBUG);
524 $level = ($used / $max) * 100;
526 if ($level >= $maxlevel) {
527 Logger::log("Maximum level (".$maxlevel."%) of user connections reached: ".$used."/".$max);
532 // We will now check for the system values.
533 // This limit could be reached although the user limits are fine.
534 $r = DBA::fetchFirst("SHOW VARIABLES WHERE `variable_name` = 'max_connections'");
535 if (!DBA::isResult($r)) {
538 $max = intval($r["Value"]);
542 $r = DBA::fetchFirst("SHOW STATUS WHERE `variable_name` = 'Threads_connected'");
543 if (!DBA::isResult($r)) {
546 $used = intval($r["Value"]);
550 Logger::log("Connection usage (system values): ".$used."/".$max, LOGGER_DEBUG);
552 $level = $used / $max * 100;
554 if ($level < $maxlevel) {
557 Logger::log("Maximum level (".$level."%) of system connections reached: ".$used."/".$max);
562 * @brief fix the queue entry if the worker process died
565 private static function killStaleWorkers()
567 $entries = DBA::select(
569 ['id', 'pid', 'executed', 'priority', 'parameter'],
570 ['`executed` > ? AND NOT `done` AND `pid` != 0', DBA::NULL_DATETIME],
571 ['order' => ['priority', 'created']]
574 while ($entry = DBA::fetch($entries)) {
575 if (!posix_kill($entry["pid"], 0)) {
578 ['executed' => DBA::NULL_DATETIME, 'pid' => 0],
579 ['id' => $entry["id"]]
582 // Kill long running processes
583 // Check if the priority is in a valid range
584 if (!in_array($entry["priority"], [PRIORITY_CRITICAL, PRIORITY_HIGH, PRIORITY_MEDIUM, PRIORITY_LOW, PRIORITY_NEGLIGIBLE])) {
585 $entry["priority"] = PRIORITY_MEDIUM;
588 // Define the maximum durations
589 $max_duration_defaults = [PRIORITY_CRITICAL => 720, PRIORITY_HIGH => 10, PRIORITY_MEDIUM => 60, PRIORITY_LOW => 180, PRIORITY_NEGLIGIBLE => 720];
590 $max_duration = $max_duration_defaults[$entry["priority"]];
592 $argv = json_decode($entry["parameter"], true);
593 $argv[0] = basename($argv[0]);
595 // How long is the process already running?
596 $duration = (time() - strtotime($entry["executed"])) / 60;
597 if ($duration > $max_duration) {
598 Logger::log("Worker process ".$entry["pid"]." (".substr(json_encode($argv), 0, 50).") took more than ".$max_duration." minutes. It will be killed now.");
599 posix_kill($entry["pid"], SIGTERM);
601 // We killed the stale process.
602 // To avoid a blocking situation we reschedule the process at the beginning of the queue.
603 // Additionally we are lowering the priority. (But not PRIORITY_CRITICAL)
604 $new_priority = $entry["priority"];
605 if ($entry["priority"] == PRIORITY_HIGH) {
606 $new_priority = PRIORITY_MEDIUM;
607 } elseif ($entry["priority"] == PRIORITY_MEDIUM) {
608 $new_priority = PRIORITY_LOW;
609 } elseif ($entry["priority"] != PRIORITY_CRITICAL) {
610 $new_priority = PRIORITY_NEGLIGIBLE;
614 ['executed' => DBA::NULL_DATETIME, 'created' => DateTimeFormat::utcNow(), 'priority' => $new_priority, 'pid' => 0],
615 ['id' => $entry["id"]]
618 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);
625 * @brief Checks if the number of active workers exceeds the given limits
627 * @return bool Are there too much workers running?
629 public static function tooMuchWorkers()
631 $queues = Config::get("system", "worker_queues", 4);
633 $maxqueues = $queues;
635 $active = self::activeWorkers();
637 // Decrease the number of workers at higher load
638 $load = System::currentLoad();
640 $maxsysload = intval(Config::get("system", "maxloadavg", 50));
642 /* Default exponent 3 causes queues to rapidly decrease as load increases.
643 * If you have 20 max queues at idle, then you get only 5 queues at 37.1% of $maxsysload.
644 * For some environments, this rapid decrease is not needed.
645 * With exponent 1, you could have 20 max queues at idle and 13 at 37% of $maxsysload.
647 $exponent = intval(Config::get('system', 'worker_load_exponent', 3));
648 $slope = pow(max(0, $maxsysload - $load) / $maxsysload, $exponent);
649 $queues = intval(ceil($slope * $maxqueues));
653 if (Config::get('system', 'worker_debug')) {
654 // Create a list of queue entries grouped by their priority
657 // Adding all processes with no workerqueue entry
659 "SELECT COUNT(*) AS `running` FROM `process` WHERE NOT EXISTS
660 (SELECT id FROM `workerqueue`
661 WHERE `workerqueue`.`pid` = `process`.`pid` AND NOT `done` AND `pid` != ?)",
665 if ($process = DBA::fetch($processes)) {
666 $listitem[0] = "0:".$process["running"];
668 DBA::close($processes);
670 // Now adding all processes with workerqueue entries
671 $entries = DBA::p("SELECT COUNT(*) AS `entries`, `priority` FROM `workerqueue` WHERE NOT `done` GROUP BY `priority`");
672 while ($entry = DBA::fetch($entries)) {
673 $processes = DBA::p("SELECT COUNT(*) AS `running` FROM `process` INNER JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid` AND NOT `done` WHERE `priority` = ?", $entry["priority"]);
674 if ($process = DBA::fetch($processes)) {
675 $listitem[$entry["priority"]] = $entry["priority"].":".$process["running"]."/".$entry["entries"];
677 DBA::close($processes);
679 DBA::close($entries);
681 $intervals = [1, 10, 60];
682 $jobs_per_minute = [];
683 foreach ($intervals as $interval) {
684 $jobs = DBA::p("SELECT COUNT(*) AS `jobs` FROM `workerqueue` WHERE `done` AND `executed` > UTC_TIMESTAMP() - INTERVAL ".intval($interval)." MINUTE");
685 if ($job = DBA::fetch($jobs)) {
686 $jobs_per_minute[$interval] = number_format($job['jobs'] / $interval, 0);
690 $processlist = ' - jpm: '.implode('/', $jobs_per_minute).' ('.implode(', ', $listitem).')';
693 $entries = self::totalEntries();
694 $deferred = self::deferredEntries();
696 if (Config::get("system", "worker_fastlane", false) && ($queues > 0) && ($entries > 0) && ($active >= $queues)) {
697 $top_priority = self::highestPriority();
698 $high_running = self::processWithPriorityActive($top_priority);
700 if (!$high_running && ($top_priority > PRIORITY_UNDEFINED) && ($top_priority < PRIORITY_NEGLIGIBLE)) {
701 Logger::log("There are jobs with priority ".$top_priority." waiting but none is executed. Open a fastlane.", LOGGER_DEBUG);
702 $queues = $active + 1;
706 Logger::log("Load: " . $load ."/" . $maxsysload . " - processes: " . $deferred . "/" . $active . "/" . $entries . $processlist . " - maximum: " . $queues . "/" . $maxqueues, LOGGER_DEBUG);
708 // Are there fewer workers running as possible? Then fork a new one.
709 if (!Config::get("system", "worker_dont_fork", false) && ($queues > ($active + 1)) && ($entries > 1)) {
710 Logger::log("Active workers: ".$active."/".$queues." Fork a new worker.", LOGGER_DEBUG);
711 if (Config::get('system', 'worker_daemon_mode', false)) {
712 self::IPCSetJobState(true);
719 // if there are too much worker, we don't spawn a new one.
720 if (Config::get('system', 'worker_daemon_mode', false) && ($active > $queues)) {
721 self::IPCSetJobState(false);
724 return $active > $queues;
728 * @brief Returns the number of active worker processes
730 * @return integer Number of active worker processes
732 private static function activeWorkers()
734 return DBA::count('process', ['command' => 'Worker.php']);
738 * @brief Check if we should pass some slow processes
740 * When the active processes of the highest priority are using more than 2/3
741 * of all processes, we let pass slower processes.
743 * @param string $highest_priority Returns the currently highest priority
744 * @return bool We let pass a slower process than $highest_priority
746 private static function passingSlow(&$highest_priority)
748 $highest_priority = 0;
753 INNER JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid` AND NOT `done`"
756 // No active processes at all? Fine
757 if (!DBA::isResult($r)) {
761 while ($line = DBA::fetch($r)) {
762 $priorities[] = $line["priority"];
767 if (count($priorities) == 0) {
770 $highest_priority = min($priorities);
772 // The highest process is already the slowest one?
774 if ($highest_priority == PRIORITY_NEGLIGIBLE) {
778 foreach ($priorities as $priority) {
779 if ($priority == $highest_priority) {
783 Logger::log("Highest priority: ".$highest_priority." Total processes: ".count($priorities)." Count high priority processes: ".$high, LOGGER_DEBUG);
784 $passing_slow = (($high/count($priorities)) > (2/3));
787 Logger::log("Passing slower processes than priority ".$highest_priority, LOGGER_DEBUG);
789 return $passing_slow;
793 * @brief Find and claim the next worker process for us
795 * @param boolean $passing_slow Returns if we had passed low priority processes
796 * @return boolean Have we found something?
798 private static function findWorkerProcesses(&$passing_slow)
802 // Check if we should pass some low priority process
803 $highest_priority = 0;
805 $passing_slow = false;
807 // The higher the number of parallel workers, the more we prefetch to prevent concurring access
808 // We decrease the limit with the number of entries left in the queue
809 $worker_queues = Config::get("system", "worker_queues", 4);
810 $queue_length = Config::get('system', 'worker_fetch_limit', 1);
811 $lower_job_limit = $worker_queues * $queue_length * 2;
812 $jobs = self::totalEntries();
813 $deferred = self::deferredEntries();
817 $slope = $queue_length / pow($lower_job_limit, $exponent);
818 $limit = min($queue_length, ceil($slope * pow($jobs, $exponent)));
820 Logger::log('Deferred: ' . $deferred . ' - Total: ' . $jobs . ' - Maximum: ' . $queue_length . ' - jobs per queue: ' . $limit, LOGGER_DEBUG);
822 if (self::passingSlow($highest_priority)) {
823 // Are there waiting processes with a higher priority than the currently highest?
824 $result = DBA::select(
827 ["`executed` <= ? AND `priority` < ? AND NOT `done` AND `next_try` < ?",
828 DBA::NULL_DATETIME, $highest_priority, DateTimeFormat::utcNow()],
829 ['limit' => $limit, 'order' => ['priority', 'created']]
832 while ($id = DBA::fetch($result)) {
837 $found = (count($ids) > 0);
840 // Give slower processes some processing time
841 $result = DBA::select(
844 ["`executed` <= ? AND `priority` > ? AND NOT `done` AND `next_try` < ?",
845 DBA::NULL_DATETIME, $highest_priority, DateTimeFormat::utcNow()],
846 ['limit' => $limit, 'order' => ['priority', 'created']]
849 while ($id = DBA::fetch($result)) {
854 $found = (count($ids) > 0);
855 $passing_slow = $found;
859 // If there is no result (or we shouldn't pass lower processes) we check without priority limit
861 $result = DBA::select(
864 ["`executed` <= ? AND NOT `done` AND `next_try` < ?",
865 DBA::NULL_DATETIME, DateTimeFormat::utcNow()],
866 ['limit' => $limit, 'order' => ['priority', 'created']]
869 while ($id = DBA::fetch($result)) {
874 $found = (count($ids) > 0);
878 $condition = "`id` IN (".substr(str_repeat("?, ", count($ids)), 0, -2).") AND `pid` = 0 AND NOT `done`";
879 array_unshift($ids, $condition);
880 DBA::update('workerqueue', ['executed' => DateTimeFormat::utcNow(), 'pid' => $mypid], $ids);
887 * @brief Returns the next worker process
889 * @param boolean $passing_slow Returns if we had passed low priority processes
890 * @return string SQL statement
892 public static function workerProcess(&$passing_slow)
894 $stamp = (float)microtime(true);
896 // There can already be jobs for us in the queue.
897 $r = DBA::select('workerqueue', [], ['pid' => getmypid(), 'done' => false]);
898 if (DBA::isResult($r)) {
899 self::$db_duration += (microtime(true) - $stamp);
900 return DBA::toArray($r);
904 $stamp = (float)microtime(true);
905 if (!Lock::acquire('worker_process')) {
908 self::$lock_duration = (microtime(true) - $stamp);
910 $stamp = (float)microtime(true);
911 $found = self::findWorkerProcesses($passing_slow);
912 self::$db_duration += (microtime(true) - $stamp);
914 Lock::release('worker_process');
917 $r = DBA::select('workerqueue', [], ['pid' => getmypid(), 'done' => false]);
918 return DBA::toArray($r);
924 * @brief Removes a workerqueue entry from the current process
927 public static function unclaimProcess()
931 DBA::update('workerqueue', ['executed' => DBA::NULL_DATETIME, 'pid' => 0], ['pid' => $mypid, 'done' => false]);
935 * @brief Call the front end worker
938 public static function callWorker()
940 if (!Config::get("system", "frontend_worker")) {
944 $url = System::baseUrl()."/worker";
945 Network::fetchUrl($url, false, $redirects, 1);
949 * @brief Call the front end worker if there aren't any active
952 public static function executeIfIdle()
954 if (!Config::get("system", "frontend_worker")) {
958 // Do we have "proc_open"? Then we can fork the worker
959 if (function_exists("proc_open")) {
960 // When was the last time that we called the worker?
961 // Less than one minute? Then we quit
962 if ((time() - Config::get("system", "worker_started")) < 60) {
966 Config::set("system", "worker_started", time());
968 // Do we have enough running workers? Then we quit here.
969 if (self::tooMuchWorkers()) {
970 // Cleaning dead processes
971 self::killStaleWorkers();
972 Process::deleteInactive();
979 Logger::log('Call worker', LOGGER_DEBUG);
984 // We cannot execute background processes.
985 // We now run the processes from the frontend.
986 // This won't work with long running processes.
989 self::clearProcesses();
991 $workers = self::activeWorkers();
999 * @brief Removes long running worker processes
1002 public static function clearProcesses()
1004 $timeout = Config::get("system", "frontend_worker_timeout", 10);
1006 /// @todo We should clean up the corresponding workerqueue entries as well
1007 $condition = ["`created` < ? AND `command` = 'worker.php'",
1008 DateTimeFormat::utc("now - ".$timeout." minutes")];
1009 DBA::delete('process', $condition);
1013 * @brief Runs the cron processes
1016 private static function runCron()
1018 Logger::log('Add cron entries', LOGGER_DEBUG);
1020 // Check for spooled items
1021 self::add(PRIORITY_HIGH, "SpoolPost");
1023 // Run the cron job that calls all other jobs
1024 self::add(PRIORITY_MEDIUM, "Cron");
1026 // Cleaning dead processes
1027 self::killStaleWorkers();
1031 * @brief Spawns a new worker
1034 public static function spawnWorker($do_cron = false)
1036 $command = 'bin/worker.php';
1038 $args = ['no_cron' => !$do_cron];
1040 get_app()->proc_run($command, $args);
1042 // after spawning we have to remove the flag.
1043 if (Config::get('system', 'worker_daemon_mode', false)) {
1044 self::IPCSetJobState(false);
1049 * @brief Adds tasks to the worker queue
1051 * @param (integer|array) priority or parameter array, strings are deprecated and are ignored
1053 * next args are passed as $cmd command line
1054 * or: Worker::add(PRIORITY_HIGH, "Notifier", "drop", $drop_id);
1055 * or: Worker::add(array('priority' => PRIORITY_HIGH, 'dont_fork' => true), "CreateShadowEntry", $post_id);
1057 * @note $cmd and string args are surrounded with ""
1062 * @return boolean "false" if proc_run couldn't be executed
1064 public static function add($cmd)
1066 $args = func_get_args();
1068 if (!count($args)) {
1072 $arr = ['args' => $args, 'run_cmd' => true];
1074 Addon::callHooks("proc_run", $arr);
1075 if (!$arr['run_cmd'] || !count($args)) {
1079 $priority = PRIORITY_MEDIUM;
1080 $dont_fork = Config::get("system", "worker_dont_fork", false);
1081 $created = DateTimeFormat::utcNow();
1083 $run_parameter = array_shift($args);
1085 if (is_int($run_parameter)) {
1086 $priority = $run_parameter;
1087 } elseif (is_array($run_parameter)) {
1088 if (isset($run_parameter['priority'])) {
1089 $priority = $run_parameter['priority'];
1091 if (isset($run_parameter['created'])) {
1092 $created = $run_parameter['created'];
1094 if (isset($run_parameter['dont_fork'])) {
1095 $dont_fork = $run_parameter['dont_fork'];
1099 $parameters = json_encode($args);
1100 $found = DBA::exists('workerqueue', ['parameter' => $parameters, 'done' => false]);
1102 // Quit if there was a database error - a precaution for the update process to 3.5.3
1103 if (DBA::errorNo() != 0) {
1108 DBA::insert('workerqueue', ['parameter' => $parameters, 'created' => $created, 'priority' => $priority]);
1111 // Should we quit and wait for the worker to be called as a cronjob?
1116 // If there is a lock then we don't have to check for too much worker
1117 if (!Lock::acquire('worker', 0)) {
1121 // If there are already enough workers running, don't fork another one
1122 $quit = self::tooMuchWorkers();
1123 Lock::release('worker');
1129 // We tell the daemon that a new job entry exists
1130 if (Config::get('system', 'worker_daemon_mode', false)) {
1131 // We don't have to set the IPC flag - this is done in "tooMuchWorkers"
1135 // Now call the worker to execute the jobs that we just added to the queue
1136 self::spawnWorker();
1142 * Defers the current worker entry
1144 public static function defer()
1146 if (empty(BaseObject::getApp()->queue)) {
1150 $queue = BaseObject::getApp()->queue;
1152 $retrial = $queue['retrial'];
1155 if ($retrial > 14) {
1156 Logger::log('Id ' . $id . ' had been tried 14 times. We stop now.', LOGGER_DEBUG);
1160 // Calculate the delay until the next trial
1161 $delay = (($retrial + 3) ** 4) + (rand(1, 30) * ($retrial + 1));
1162 $next = DateTimeFormat::utc('now + ' . $delay . ' seconds');
1164 Logger::log('Defer execution ' . $retrial . ' of id ' . $id . ' to ' . $next, LOGGER_DEBUG);
1166 $fields = ['retrial' => $retrial + 1, 'next_try' => $next, 'executed' => DBA::NULL_DATETIME, 'pid' => 0];
1167 DBA::update('workerqueue', $fields, ['id' => $id]);
1171 * Log active processes into the "process" table
1173 * @brief Log active processes into the "process" table
1175 public static function startProcess()
1177 $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 1);
1179 $command = basename($trace[0]['file']);
1181 Process::deleteInactive();
1183 Process::insert($command);
1187 * Remove the active process from the "process" table
1189 * @brief Remove the active process from the "process" table
1192 public static function endProcess()
1194 return Process::deleteByPid();
1198 * Set the flag if some job is waiting
1200 * @brief Set the flag if some job is waiting
1201 * @param boolean $jobs Is there a waiting job?
1203 public static function IPCSetJobState($jobs)
1205 DBA::update('worker-ipc', ['jobs' => $jobs], ['key' => 1], true);
1209 * Checks if some worker job waits to be executed
1211 * @brief Checks if some worker job waits to be executed
1214 public static function IPCJobsExists()
1216 $row = DBA::selectFirst('worker-ipc', ['jobs'], ['key' => 1]);
1218 // When we don't have a row, no job is running
1219 if (!DBA::isResult($row)) {
1223 return (bool)$row['jobs'];