4 use Friendica\Core\Config;
5 use Friendica\Util\Lock;
7 if (!file_exists("boot.php") AND (sizeof($_SERVER["argv"]) != 0)) {
8 $directory = dirname($_SERVER["argv"][0]);
10 if (substr($directory, 0, 1) != "/")
11 $directory = $_SERVER["PWD"]."/".$directory;
13 $directory = realpath($directory."/..");
18 require_once("boot.php");
20 function poller_run($argv, $argc){
23 $a = new App(dirname(__DIR__));
25 @include(".htconfig.php");
26 require_once("include/dba.php");
27 $db = new dba($db_host, $db_user, $db_pass, $db_data);
28 unset($db_host, $db_user, $db_pass, $db_data);
32 // Quit when in maintenance
33 if (Config::get('system', 'maintenance', true)) {
37 $a->set_baseurl(Config::get('system', 'url'));
41 if (($argc <= 1) OR ($argv[1] != "no_cron")) {
47 if ($a->min_memory_reached()) {
48 logger('Pre check: Memory limit reached, quitting.', LOGGER_DEBUG);
52 if (poller_max_connections_reached()) {
53 logger('Pre check: maximum connections reached, quitting.', LOGGER_DEBUG);
57 if ($a->maxload_reached()) {
58 logger('Pre check: maximum load reached, quitting.', LOGGER_DEBUG);
62 if ($a->max_processes_reached()) {
63 logger('Pre check: maximum processes reached, quitting.', LOGGER_DEBUG);
67 // Checking the number of workers
68 if (poller_too_much_workers()) {
69 poller_kill_stale_workers();
70 logger('Pre check: Active worker limit reached, quitting.', LOGGER_DEBUG);
76 while ($r = poller_worker_process()) {
78 if (!poller_claim_process($r[0])) {
83 if ($a->min_memory_reached()) {
84 logger('Memory limit reached, quitting.', LOGGER_DEBUG);
88 if (!Lock::set('poller_worker')) {
89 logger('Cannot get a lock, retrying.', LOGGER_DEBUG);
90 poller_unclaim_process();
94 // Count active workers and compare them with a maximum value that depends on the load
95 if (poller_too_much_workers()) {
96 logger('Active worker limit reached, quitting.', LOGGER_DEBUG);
100 Lock::remove('poller_worker');
102 if (!poller_execute($r[0])) {
103 logger('Process execution failed, quitting.', LOGGER_DEBUG);
107 // Quit the poller once every hour
108 if (time() > ($starttime + 360)) {
109 logger('Process lifetime reachted, quitting.', LOGGER_DEBUG);
113 logger("Couldn't select a workerqueue entry, quitting.", LOGGER_DEBUG);
117 * @brief Execute a worker entry
119 * @param array $queue Workerqueue entry
121 * @return boolean "true" if further processing should be stopped
123 function poller_execute($queue) {
129 // Quit when in maintenance
130 if (Config::get('system', 'maintenance', true)) {
131 logger("Maintenance mode - quit process ".$mypid, LOGGER_DEBUG);
135 // Constantly check the number of parallel database processes
136 if ($a->max_processes_reached()) {
137 logger("Max processes reached for process ".$mypid, LOGGER_DEBUG);
141 // Constantly check the number of available database connections to let the frontend be accessible at any time
142 if (poller_max_connections_reached()) {
143 logger("Max connection reached for process ".$mypid, LOGGER_DEBUG);
147 $argv = json_decode($queue["parameter"]);
149 // Check for existance and validity of the include file
152 if (!validate_include($include)) {
153 logger("Include file ".$argv[0]." is not valid!");
154 dba::delete('workerqueue', array('id' => $queue["id"]));
158 require_once($include);
160 $funcname = str_replace(".php", "", basename($argv[0]))."_run";
162 if (function_exists($funcname)) {
164 poller_exec_function($queue, $funcname, $argv);
165 dba::delete('workerqueue', array('id' => $queue["id"]));
167 logger("Function ".$funcname." does not exist");
174 * @brief Execute a function from the queue
176 * @param array $queue Workerqueue entry
177 * @param string $funcname name of the function
178 * @param array $argv Array of values to be passed to the function
180 function poller_exec_function($queue, $funcname, $argv) {
186 $argc = count($argv);
188 logger("Process ".$mypid." - Prio ".$queue["priority"]." - ID ".$queue["id"].": ".$funcname." ".$queue["parameter"]);
190 $stamp = (float)microtime(true);
192 // We use the callstack here to analyze the performance of executed worker entries.
193 // For this reason the variables have to be initialized.
194 if (Config::get("system", "profiler")) {
195 $a->performance["start"] = microtime(true);
196 $a->performance["database"] = 0;
197 $a->performance["database_write"] = 0;
198 $a->performance["network"] = 0;
199 $a->performance["file"] = 0;
200 $a->performance["rendering"] = 0;
201 $a->performance["parser"] = 0;
202 $a->performance["marktime"] = 0;
203 $a->performance["markstart"] = microtime(true);
204 $a->callstack = array();
207 // For better logging create a new process id for every worker call
208 // But preserve the old one for the worker
209 $old_process_id = $a->process_id;
210 $a->process_id = uniqid("wrk", true);
212 $funcname($argv, $argc);
214 $a->process_id = $old_process_id;
216 $duration = number_format(microtime(true) - $stamp, 3);
218 if ($duration > 3600) {
219 logger("Prio ".$queue["priority"].": ".$queue["parameter"]." - longer than 1 hour (".round($duration/60, 3).")", LOGGER_DEBUG);
220 } elseif ($duration > 600) {
221 logger("Prio ".$queue["priority"].": ".$queue["parameter"]." - longer than 10 minutes (".round($duration/60, 3).")", LOGGER_DEBUG);
222 } elseif ($duration > 300) {
223 logger("Prio ".$queue["priority"].": ".$queue["parameter"]." - longer than 5 minutes (".round($duration/60, 3).")", LOGGER_DEBUG);
224 } elseif ($duration > 120) {
225 logger("Prio ".$queue["priority"].": ".$queue["parameter"]." - longer than 2 minutes (".round($duration/60, 3).")", LOGGER_DEBUG);
228 logger("Process ".$mypid." - Prio ".$queue["priority"]." - ID ".$queue["id"].": ".$funcname." - done in ".$duration." seconds.");
230 // Write down the performance values into the log
231 if (Config::get("system", "profiler")) {
232 $duration = microtime(true)-$a->performance["start"];
234 if (Config::get("rendertime", "callstack")) {
235 if (isset($a->callstack["database"])) {
236 $o = "\nDatabase Read:\n";
237 foreach ($a->callstack["database"] AS $func => $time) {
238 $time = round($time, 3);
240 $o .= $func.": ".$time."\n";
243 if (isset($a->callstack["database_write"])) {
244 $o .= "\nDatabase Write:\n";
245 foreach ($a->callstack["database_write"] AS $func => $time) {
246 $time = round($time, 3);
248 $o .= $func.": ".$time."\n";
251 if (isset($a->callstack["network"])) {
252 $o .= "\nNetwork:\n";
253 foreach ($a->callstack["network"] AS $func => $time) {
254 $time = round($time, 3);
256 $o .= $func.": ".$time."\n";
263 logger("ID ".$queue["id"].": ".$funcname.": ".sprintf("DB: %s/%s, Net: %s, I/O: %s, Other: %s, Total: %s".$o,
264 number_format($a->performance["database"] - $a->performance["database_write"], 2),
265 number_format($a->performance["database_write"], 2),
266 number_format($a->performance["network"], 2),
267 number_format($a->performance["file"], 2),
268 number_format($duration - ($a->performance["database"] + $a->performance["network"] + $a->performance["file"]), 2),
269 number_format($duration, 2)),
273 $cooldown = Config::get("system", "worker_cooldown", 0);
276 logger("Process ".$mypid." - Prio ".$queue["priority"]." - ID ".$queue["id"].": ".$funcname." - in cooldown for ".$cooldown." seconds");
282 * @brief Checks if the number of database connections has reached a critical limit.
284 * @return bool Are more than 3/4 of the maximum connections used?
286 function poller_max_connections_reached() {
288 // Fetch the max value from the config. This is needed when the system cannot detect the correct value by itself.
289 $max = Config::get("system", "max_connections");
291 // Fetch the percentage level where the poller will get active
292 $maxlevel = Config::get("system", "max_connections_level", 75);
295 // the maximum number of possible user connections can be a system variable
296 $r = q("SHOW VARIABLES WHERE `variable_name` = 'max_user_connections'");
298 $max = $r[0]["Value"];
300 // Or it can be granted. This overrides the system variable
301 $r = q("SHOW GRANTS");
303 foreach ($r AS $grants) {
304 $grant = array_pop($grants);
305 if (stristr($grant, "GRANT USAGE ON"))
306 if (preg_match("/WITH MAX_USER_CONNECTIONS (\d*)/", $grant, $match))
311 // If $max is set we will use the processlist to determine the current number of connections
312 // The processlist only shows entries of the current user
314 $r = q("SHOW PROCESSLIST");
315 if (!dbm::is_result($r))
320 logger("Connection usage (user values): ".$used."/".$max, LOGGER_DEBUG);
322 $level = ($used / $max) * 100;
324 if ($level >= $maxlevel) {
325 logger("Maximum level (".$maxlevel."%) of user connections reached: ".$used."/".$max);
330 // We will now check for the system values.
331 // This limit could be reached although the user limits are fine.
332 $r = q("SHOW VARIABLES WHERE `variable_name` = 'max_connections'");
336 $max = intval($r[0]["Value"]);
340 $r = q("SHOW STATUS WHERE `variable_name` = 'Threads_connected'");
344 $used = intval($r[0]["Value"]);
348 logger("Connection usage (system values): ".$used."/".$max, LOGGER_DEBUG);
350 $level = $used / $max * 100;
352 if ($level < $maxlevel)
355 logger("Maximum level (".$level."%) of system connections reached: ".$used."/".$max);
360 * @brief fix the queue entry if the worker process died
363 function poller_kill_stale_workers() {
364 $r = q("SELECT `pid`, `executed`, `priority`, `parameter` FROM `workerqueue` WHERE `executed` > '%s'", dbesc(NULL_DATE));
366 if (!dbm::is_result($r)) {
367 // No processing here needed
371 foreach ($r AS $pid) {
372 if (!posix_kill($pid["pid"], 0)) {
373 dba::update('workerqueue', array('executed' => NULL_DATE, 'pid' => 0),
374 array('pid' => $pid["pid"]));
376 // Kill long running processes
378 // Check if the priority is in a valid range
379 if (!in_array($pid["priority"], array(PRIORITY_CRITICAL, PRIORITY_HIGH, PRIORITY_MEDIUM, PRIORITY_LOW, PRIORITY_NEGLIGIBLE)))
380 $pid["priority"] = PRIORITY_MEDIUM;
382 // Define the maximum durations
383 $max_duration_defaults = array(PRIORITY_CRITICAL => 360, PRIORITY_HIGH => 10, PRIORITY_MEDIUM => 60, PRIORITY_LOW => 180, PRIORITY_NEGLIGIBLE => 360);
384 $max_duration = $max_duration_defaults[$pid["priority"]];
386 $argv = json_decode($pid["parameter"]);
387 $argv[0] = basename($argv[0]);
389 // How long is the process already running?
390 $duration = (time() - strtotime($pid["executed"])) / 60;
391 if ($duration > $max_duration) {
392 logger("Worker process ".$pid["pid"]." (".implode(" ", $argv).") took more than ".$max_duration." minutes. It will be killed now.");
393 posix_kill($pid["pid"], SIGTERM);
395 // We killed the stale process.
396 // To avoid a blocking situation we reschedule the process at the beginning of the queue.
397 // Additionally we are lowering the priority.
398 dba::update('workerqueue',
399 array('executed' => NULL_DATE, 'created' => datetime_convert(), 'priority' => PRIORITY_NEGLIGIBLE, 'pid' => 0),
400 array('pid' => $pid["pid"]));
402 logger("Worker process ".$pid["pid"]." (".implode(" ", $argv).") now runs for ".round($duration)." of ".$max_duration." allowed minutes. That's okay.", LOGGER_DEBUG);
409 * @brief Checks if the number of active workers exceeds the given limits
411 * @return bool Are there too much workers running?
413 function poller_too_much_workers() {
414 $queues = Config::get("system", "worker_queues", 4);
416 $maxqueues = $queues;
418 $active = poller_active_workers();
420 // Decrease the number of workers at higher load
421 $load = current_load();
423 $maxsysload = intval(Config::get("system", "maxloadavg", 50));
425 $maxworkers = $queues;
427 // Some magical mathemathics to reduce the workers
429 $slope = $maxworkers / pow($maxsysload, $exponent);
430 $queues = ceil($slope * pow(max(0, $maxsysload - $load), $exponent));
432 // Create a list of queue entries grouped by their priority
435 // Adding all processes with no workerqueue entry
436 $processes = dba::p("SELECT COUNT(*) AS `running` FROM `process` WHERE NOT EXISTS (SELECT id FROM `workerqueue` WHERE `workerqueue`.`pid` = `process`.`pid`)");
437 if ($process = dba::fetch($processes)) {
438 $listitem[0] = "0:".$process["running"];
440 dba::close($processes);
442 // Now adding all processes with workerqueue entries
443 $entries = dba::p("SELECT COUNT(*) AS `entries`, `priority` FROM `workerqueue` GROUP BY `priority`");
444 while ($entry = dba::fetch($entries)) {
445 $processes = dba::p("SELECT COUNT(*) AS `running` FROM `process` INNER JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid` WHERE `priority` = ?", $entry["priority"]);
446 if ($process = dba::fetch($processes)) {
447 $listitem[$entry["priority"]] = $entry["priority"].":".$process["running"]."/".$entry["entries"];
449 dba::close($processes);
451 dba::close($entries);
453 $processlist = implode(', ', $listitem);
455 $s = q("SELECT COUNT(*) AS `total` FROM `workerqueue` WHERE `executed` <= '%s'", dbesc(NULL_DATE));
456 $entries = $s[0]["total"];
458 if (Config::get("system", "worker_fastlane", false) AND ($queues > 0) AND ($entries > 0) AND ($active >= $queues)) {
459 $s = q("SELECT `priority` FROM `workerqueue` WHERE `executed` <= '%s' ORDER BY `priority` LIMIT 1", dbesc(NULL_DATE));
460 $top_priority = $s[0]["priority"];
462 $s = q("SELECT `id` FROM `workerqueue` WHERE `priority` <= %d AND `executed` > '%s' LIMIT 1",
463 intval($top_priority), dbesc(NULL_DATE));
464 $high_running = dbm::is_result($s);
466 if (!$high_running AND ($top_priority > PRIORITY_UNDEFINED) AND ($top_priority < PRIORITY_NEGLIGIBLE)) {
467 logger("There are jobs with priority ".$top_priority." waiting but none is executed. Open a fastlane.", LOGGER_DEBUG);
468 $queues = $active + 1;
472 logger("Load: ".$load."/".$maxsysload." - processes: ".$active."/".$entries." (".$processlist.") - maximum: ".$queues."/".$maxqueues, LOGGER_DEBUG);
474 // Are there fewer workers running as possible? Then fork a new one.
475 if (!Config::get("system", "worker_dont_fork") AND ($queues > ($active + 1)) AND ($entries > 1)) {
476 logger("Active workers: ".$active."/".$queues." Fork a new worker.", LOGGER_DEBUG);
477 $args = array("include/poller.php", "no_cron");
483 return($active >= $queues);
487 * @brief Returns the number of active poller processes
489 * @return integer Number of active poller processes
491 function poller_active_workers() {
492 $workers = q("SELECT COUNT(*) AS `processes` FROM `process` WHERE `command` = 'poller.php'");
494 return($workers[0]["processes"]);
498 * @brief Check if we should pass some slow processes
500 * When the active processes of the highest priority are using more than 2/3
501 * of all processes, we let pass slower processes.
503 * @param string $highest_priority Returns the currently highest priority
504 * @return bool We let pass a slower process than $highest_priority
506 function poller_passing_slow(&$highest_priority) {
508 $highest_priority = 0;
510 $r = q("SELECT `priority`
512 INNER JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid`");
514 // No active processes at all? Fine
515 if (!dbm::is_result($r))
518 $priorities = array();
519 foreach ($r AS $line)
520 $priorities[] = $line["priority"];
523 if (count($priorities) == 0)
526 $highest_priority = min($priorities);
528 // The highest process is already the slowest one?
530 if ($highest_priority == PRIORITY_NEGLIGIBLE)
534 foreach ($priorities AS $priority)
535 if ($priority == $highest_priority)
538 logger("Highest priority: ".$highest_priority." Total processes: ".count($priorities)." Count high priority processes: ".$high, LOGGER_DEBUG);
539 $passing_slow = (($high/count($priorities)) > (2/3));
542 logger("Passing slower processes than priority ".$highest_priority, LOGGER_DEBUG);
544 return($passing_slow);
548 * @brief Returns the next worker process
550 * @return string SQL statement
552 function poller_worker_process() {
554 // Check if we should pass some low priority process
555 $highest_priority = 0;
557 if (poller_passing_slow($highest_priority)) {
558 dba::p('LOCK TABLES `workerqueue` WRITE');
560 // Are there waiting processes with a higher priority than the currently highest?
561 $r = q("SELECT * FROM `workerqueue`
562 WHERE `executed` <= '%s' AND `priority` < %d
563 ORDER BY `priority`, `created` LIMIT 1",
565 intval($highest_priority));
566 if (dbm::is_result($r)) {
569 // Give slower processes some processing time
570 $r = q("SELECT * FROM `workerqueue`
571 WHERE `executed` <= '%s' AND `priority` > %d
572 ORDER BY `priority`, `created` LIMIT 1",
574 intval($highest_priority));
576 if (dbm::is_result($r)) {
580 dba::p('LOCK TABLES `workerqueue` WRITE');
583 // If there is no result (or we shouldn't pass lower processes) we check without priority limit
584 if (!dbm::is_result($r)) {
585 $r = q("SELECT * FROM `workerqueue` WHERE `executed` <= '%s' ORDER BY `priority`, `created` LIMIT 1", dbesc(NULL_DATE));
588 // We only unlock the tables here, when we got no data
589 if (!dbm::is_result($r)) {
590 dba::p('UNLOCK TABLES');
597 * @brief Assigns a workerqueue entry to the current process
599 * When we are sure that the table locks are working correctly, we can remove the checks from here
601 * @param array $queue Workerqueue entry
603 * @return boolean "true" if the claiming was successful
605 function poller_claim_process($queue) {
608 $success = dba::update('workerqueue', array('executed' => datetime_convert(), 'pid' => $mypid),
609 array('id' => $queue["id"], 'pid' => 0));
610 dba::p('UNLOCK TABLES');
613 logger("Couldn't update queue entry ".$queue["id"]." - skip this execution", LOGGER_DEBUG);
617 // Assure that there are no tasks executed twice
618 $id = q("SELECT `pid`, `executed` FROM `workerqueue` WHERE `id` = %d", intval($queue["id"]));
620 logger("Queue item ".$queue["id"]." vanished - skip this execution", LOGGER_DEBUG);
622 } elseif ((strtotime($id[0]["executed"]) <= 0) OR ($id[0]["pid"] == 0)) {
623 logger("Entry for queue item ".$queue["id"]." wasn't stored - skip this execution", LOGGER_DEBUG);
625 } elseif ($id[0]["pid"] != $mypid) {
626 logger("Queue item ".$queue["id"]." is to be executed by process ".$id[0]["pid"]." and not by me (".$mypid.") - skip this execution", LOGGER_DEBUG);
633 * @brief Removes a workerqueue entry from the current process
635 function poller_unclaim_process() {
638 dba::update('workerqueue', array('executed' => NULL_DATE, 'pid' => 0), array('pid' => $mypid));
642 * @brief Call the front end worker
644 function call_worker() {
645 if (!Config::get("system", "frontend_worker")) {
649 $url = App::get_baseurl()."/worker";
650 fetch_url($url, false, $redirects, 1);
654 * @brief Call the front end worker if there aren't any active
656 function call_worker_if_idle() {
657 if (!Config::get("system", "frontend_worker")) {
661 // Do we have "proc_open"? Then we can fork the poller
662 if (function_exists("proc_open")) {
663 // When was the last time that we called the worker?
664 // Less than one minute? Then we quit
665 if ((time() - Config::get("system", "worker_started")) < 60) {
669 set_config("system", "worker_started", time());
671 // Do we have enough running workers? Then we quit here.
672 if (poller_too_much_workers()) {
673 // Cleaning dead processes
674 poller_kill_stale_workers();
675 get_app()->remove_inactive_processes();
682 logger('Call poller', LOGGER_DEBUG);
684 $args = array("include/poller.php", "no_cron");
690 // We cannot execute background processes.
691 // We now run the processes from the frontend.
692 // This won't work with long running processes.
695 clear_worker_processes();
697 $workers = q("SELECT COUNT(*) AS `processes` FROM `process` WHERE `command` = 'worker.php'");
699 if ($workers[0]["processes"] == 0) {
705 * @brief Removes long running worker processes
707 function clear_worker_processes() {
708 $timeout = Config::get("system", "frontend_worker_timeout", 10);
710 /// @todo We should clean up the corresponding workerqueue entries as well
711 q("DELETE FROM `process` WHERE `created` < '%s' AND `command` = 'worker.php'",
712 dbesc(datetime_convert('UTC','UTC',"now - ".$timeout." minutes")));
716 * @brief Runs the cron processes
718 function poller_run_cron() {
719 logger('Add cron entries', LOGGER_DEBUG);
721 // Check for spooled items
722 proc_run(PRIORITY_HIGH, "include/spool_post.php");
724 // Run the cron job that calls all other jobs
725 proc_run(PRIORITY_MEDIUM, "include/cron.php");
727 // Run the cronhooks job separately from cron for being able to use a different timing
728 proc_run(PRIORITY_MEDIUM, "include/cronhooks.php");
730 // Cleaning dead processes
731 poller_kill_stale_workers();
734 if (array_search(__file__,get_included_files())===0){
735 poller_run($_SERVER["argv"],$_SERVER["argc"]);
737 Lock::remove('poller_worker');
739 poller_unclaim_process();
741 get_app()->end_process();