4 use Friendica\Core\Config;
6 if (!file_exists("boot.php") AND (sizeof($_SERVER["argv"]) != 0)) {
7 $directory = dirname($_SERVER["argv"][0]);
9 if (substr($directory, 0, 1) != "/")
10 $directory = $_SERVER["PWD"]."/".$directory;
12 $directory = realpath($directory."/..");
17 require_once("boot.php");
19 function poller_run($argv, $argc){
27 @include(".htconfig.php");
28 require_once("include/dba.php");
29 $db = new dba($db_host, $db_user, $db_pass, $db_data);
30 unset($db_host, $db_user, $db_pass, $db_data);
35 // Quit when in maintenance
36 if (Config::get('system', 'maintenance', true)) {
40 $a->set_baseurl(Config::get('system', 'url'));
46 if ($a->min_memory_reached()) {
50 if (poller_max_connections_reached()) {
54 if ($a->maxload_reached()) {
58 if(($argc <= 1) OR ($argv[1] != "no_cron")) {
62 if ($a->max_processes_reached()) {
66 // Checking the number of workers
67 if (poller_too_much_workers()) {
68 poller_kill_stale_workers();
74 while ($r = poller_worker_process()) {
77 if ($a->min_memory_reached()) {
81 // Count active workers and compare them with a maximum value that depends on the load
82 if (poller_too_much_workers()) {
86 if (!poller_execute($r[0])) {
90 // Quit the poller once every hour
91 if (time() > ($starttime + 3600))
98 * @brief Execute a worker entry
100 * @param array $queue Workerqueue entry
102 * @return boolean "true" if further processing should be stopped
104 function poller_execute($queue) {
110 // Quit when in maintenance
111 if (Config::get('system', 'maintenance', true)) {
115 // Constantly check the number of parallel database processes
116 if ($a->max_processes_reached()) {
120 // Constantly check the number of available database connections to let the frontend be accessible at any time
121 if (poller_max_connections_reached()) {
125 $upd = q("UPDATE `workerqueue` SET `executed` = '%s', `pid` = %d WHERE `id` = %d AND `pid` = 0",
126 dbesc(datetime_convert()),
128 intval($queue["id"]));
131 logger("Couldn't update queue entry ".$queue["id"]." - skip this execution", LOGGER_DEBUG);
136 // Assure that there are no tasks executed twice
137 $id = q("SELECT `pid`, `executed` FROM `workerqueue` WHERE `id` = %d", intval($queue["id"]));
139 logger("Queue item ".$queue["id"]." vanished - skip this execution", LOGGER_DEBUG);
142 } elseif ((strtotime($id[0]["executed"]) <= 0) OR ($id[0]["pid"] == 0)) {
143 logger("Entry for queue item ".$queue["id"]." wasn't stored - skip this execution", LOGGER_DEBUG);
146 } elseif ($id[0]["pid"] != $mypid) {
147 logger("Queue item ".$queue["id"]." is to be executed by process ".$id[0]["pid"]." and not by me (".$mypid.") - skip this execution", LOGGER_DEBUG);
153 $argv = json_decode($queue["parameter"]);
155 // Check for existance and validity of the include file
158 if (!validate_include($include)) {
159 logger("Include file ".$argv[0]." is not valid!");
160 q("DELETE FROM `workerqueue` WHERE `id` = %d", intval($queue["id"]));
164 require_once($include);
166 $funcname = str_replace(".php", "", basename($argv[0]))."_run";
168 if (function_exists($funcname)) {
170 poller_exec_function($queue, $funcname, $argv);
172 q("DELETE FROM `workerqueue` WHERE `id` = %d", intval($queue["id"]));
174 logger("Function ".$funcname." does not exist");
181 * @brief Execute a function from the queue
183 * @param array $queue Workerqueue entry
184 * @param string $funcname name of the function
185 * @param array $argv Array of values to be passed to the function
187 function poller_exec_function($queue, $funcname, $argv) {
193 $argc = count($argv);
195 logger("Process ".$mypid." - Prio ".$queue["priority"]." - ID ".$queue["id"].": ".$funcname." ".$queue["parameter"]);
197 $stamp = (float)microtime(true);
199 // We use the callstack here to analyze the performance of executed worker entries.
200 // For this reason the variables have to be initialized.
201 if (Config::get("system", "profiler")) {
202 $a->performance["start"] = microtime(true);
203 $a->performance["database"] = 0;
204 $a->performance["database_write"] = 0;
205 $a->performance["network"] = 0;
206 $a->performance["file"] = 0;
207 $a->performance["rendering"] = 0;
208 $a->performance["parser"] = 0;
209 $a->performance["marktime"] = 0;
210 $a->performance["markstart"] = microtime(true);
211 $a->callstack = array();
214 // For better logging create a new process id for every worker call
215 // But preserve the old one for the worker
216 $old_process_id = $a->process_id;
217 $a->process_id = uniqid("wrk", true);
219 $funcname($argv, $argc);
221 $a->process_id = $old_process_id;
223 $duration = number_format(microtime(true) - $stamp, 3);
225 if ($duration > 3600) {
226 logger("Prio ".$queue["priority"].": ".$queue["parameter"]." - longer than 1 hour (".round($duration/60, 3).")", LOGGER_DEBUG);
227 } elseif ($duration > 600) {
228 logger("Prio ".$queue["priority"].": ".$queue["parameter"]." - longer than 10 minutes (".round($duration/60, 3).")", LOGGER_DEBUG);
229 } elseif ($duration > 300) {
230 logger("Prio ".$queue["priority"].": ".$queue["parameter"]." - longer than 5 minutes (".round($duration/60, 3).")", LOGGER_DEBUG);
231 } elseif ($duration > 120) {
232 logger("Prio ".$queue["priority"].": ".$queue["parameter"]." - longer than 2 minutes (".round($duration/60, 3).")", LOGGER_DEBUG);
235 logger("Process ".$mypid." - Prio ".$queue["priority"]." - ID ".$queue["id"].": ".$funcname." - done in ".$duration." seconds.");
237 // Write down the performance values into the log
238 if (Config::get("system", "profiler")) {
239 $duration = microtime(true)-$a->performance["start"];
241 if (Config::get("rendertime", "callstack")) {
242 if (isset($a->callstack["database"])) {
243 $o = "\nDatabase Read:\n";
244 foreach ($a->callstack["database"] AS $func => $time) {
245 $time = round($time, 3);
247 $o .= $func.": ".$time."\n";
250 if (isset($a->callstack["database_write"])) {
251 $o .= "\nDatabase Write:\n";
252 foreach ($a->callstack["database_write"] AS $func => $time) {
253 $time = round($time, 3);
255 $o .= $func.": ".$time."\n";
258 if (isset($a->callstack["network"])) {
259 $o .= "\nNetwork:\n";
260 foreach ($a->callstack["network"] AS $func => $time) {
261 $time = round($time, 3);
263 $o .= $func.": ".$time."\n";
270 logger("ID ".$queue["id"].": ".$funcname.": ".sprintf("DB: %s/%s, Net: %s, I/O: %s, Other: %s, Total: %s".$o,
271 number_format($a->performance["database"] - $a->performance["database_write"], 2),
272 number_format($a->performance["database_write"], 2),
273 number_format($a->performance["network"], 2),
274 number_format($a->performance["file"], 2),
275 number_format($duration - ($a->performance["database"] + $a->performance["network"] + $a->performance["file"]), 2),
276 number_format($duration, 2)),
280 $cooldown = Config::get("system", "worker_cooldown", 0);
283 logger("Process ".$mypid." - Prio ".$queue["priority"]." - ID ".$queue["id"].": ".$funcname." - in cooldown for ".$cooldown." seconds");
289 * @brief Checks if the number of database connections has reached a critical limit.
291 * @return bool Are more than 3/4 of the maximum connections used?
293 function poller_max_connections_reached() {
295 // Fetch the max value from the config. This is needed when the system cannot detect the correct value by itself.
296 $max = Config::get("system", "max_connections");
298 // Fetch the percentage level where the poller will get active
299 $maxlevel = Config::get("system", "max_connections_level", 75);
302 // the maximum number of possible user connections can be a system variable
303 $r = q("SHOW VARIABLES WHERE `variable_name` = 'max_user_connections'");
305 $max = $r[0]["Value"];
307 // Or it can be granted. This overrides the system variable
308 $r = q("SHOW GRANTS");
310 foreach ($r AS $grants) {
311 $grant = array_pop($grants);
312 if (stristr($grant, "GRANT USAGE ON"))
313 if (preg_match("/WITH MAX_USER_CONNECTIONS (\d*)/", $grant, $match))
318 // If $max is set we will use the processlist to determine the current number of connections
319 // The processlist only shows entries of the current user
321 $r = q("SHOW PROCESSLIST");
322 if (!dbm::is_result($r))
327 logger("Connection usage (user values): ".$used."/".$max, LOGGER_DEBUG);
329 $level = ($used / $max) * 100;
331 if ($level >= $maxlevel) {
332 logger("Maximum level (".$maxlevel."%) of user connections reached: ".$used."/".$max);
337 // We will now check for the system values.
338 // This limit could be reached although the user limits are fine.
339 $r = q("SHOW VARIABLES WHERE `variable_name` = 'max_connections'");
343 $max = intval($r[0]["Value"]);
347 $r = q("SHOW STATUS WHERE `variable_name` = 'Threads_connected'");
351 $used = intval($r[0]["Value"]);
355 logger("Connection usage (system values): ".$used."/".$max, LOGGER_DEBUG);
357 $level = $used / $max * 100;
359 if ($level < $maxlevel)
362 logger("Maximum level (".$level."%) of system connections reached: ".$used."/".$max);
367 * @brief fix the queue entry if the worker process died
370 function poller_kill_stale_workers() {
371 $r = q("SELECT `pid`, `executed`, `priority`, `parameter` FROM `workerqueue` WHERE `executed` > '%s'", dbesc(NULL_DATE));
373 if (!dbm::is_result($r)) {
374 // No processing here needed
378 foreach ($r AS $pid) {
379 if (!posix_kill($pid["pid"], 0)) {
380 q("UPDATE `workerqueue` SET `executed` = '%s', `pid` = 0 WHERE `pid` = %d",
381 dbesc(NULL_DATE), intval($pid["pid"]));
383 // Kill long running processes
385 // Check if the priority is in a valid range
386 if (!in_array($pid["priority"], array(PRIORITY_CRITICAL, PRIORITY_HIGH, PRIORITY_MEDIUM, PRIORITY_LOW, PRIORITY_NEGLIGIBLE)))
387 $pid["priority"] = PRIORITY_MEDIUM;
389 // Define the maximum durations
390 $max_duration_defaults = array(PRIORITY_CRITICAL => 360, PRIORITY_HIGH => 10, PRIORITY_MEDIUM => 60, PRIORITY_LOW => 180, PRIORITY_NEGLIGIBLE => 360);
391 $max_duration = $max_duration_defaults[$pid["priority"]];
393 $argv = json_decode($pid["parameter"]);
394 $argv[0] = basename($argv[0]);
396 // How long is the process already running?
397 $duration = (time() - strtotime($pid["executed"])) / 60;
398 if ($duration > $max_duration) {
399 logger("Worker process ".$pid["pid"]." (".implode(" ", $argv).") took more than ".$max_duration." minutes. It will be killed now.");
400 posix_kill($pid["pid"], SIGTERM);
402 // We killed the stale process.
403 // To avoid a blocking situation we reschedule the process at the beginning of the queue.
404 // Additionally we are lowering the priority.
405 q("UPDATE `workerqueue` SET `executed` = '%s', `created` = '%s',
406 `priority` = %d, `pid` = 0 WHERE `pid` = %d",
408 dbesc(datetime_convert()),
409 intval(PRIORITY_NEGLIGIBLE),
410 intval($pid["pid"]));
412 logger("Worker process ".$pid["pid"]." (".implode(" ", $argv).") now runs for ".round($duration)." of ".$max_duration." allowed minutes. That's okay.", LOGGER_DEBUG);
419 * @brief Checks if the number of active workers exceeds the given limits
421 * @return bool Are there too much workers running?
423 function poller_too_much_workers() {
424 $queues = Config::get("system", "worker_queues", 4);
426 $maxqueues = $queues;
428 $active = poller_active_workers();
430 // Decrease the number of workers at higher load
431 $load = current_load();
433 $maxsysload = intval(Config::get("system", "maxloadavg", 50));
435 $maxworkers = $queues;
437 // Some magical mathemathics to reduce the workers
439 $slope = $maxworkers / pow($maxsysload, $exponent);
440 $queues = ceil($slope * pow(max(0, $maxsysload - $load), $exponent));
442 $s = q("SELECT COUNT(*) AS `total` FROM `workerqueue` WHERE `executed` <= '%s'", dbesc(NULL_DATE));
443 $entries = $s[0]["total"];
445 if (Config::get("system", "worker_fastlane", false) AND ($queues > 0) AND ($entries > 0) AND ($active >= $queues)) {
446 $s = q("SELECT `priority` FROM `workerqueue` WHERE `executed` <= '%s' ORDER BY `priority` LIMIT 1", dbesc(NULL_DATE));
447 $top_priority = $s[0]["priority"];
449 $s = q("SELECT `id` FROM `workerqueue` WHERE `priority` <= %d AND `executed` > '%s' LIMIT 1",
450 intval($top_priority), dbesc(NULL_DATE));
451 $high_running = dbm::is_result($s);
453 if (!$high_running AND ($top_priority > PRIORITY_UNDEFINED) AND ($top_priority < PRIORITY_NEGLIGIBLE)) {
454 logger("There are jobs with priority ".$top_priority." waiting but none is executed. Open a fastlane.", LOGGER_DEBUG);
455 $queues = $active + 1;
459 // Create a list of queue entries grouped by their priority
460 $running = array(PRIORITY_CRITICAL => 0,
462 PRIORITY_MEDIUM => 0,
464 PRIORITY_NEGLIGIBLE => 0);
466 $r = q("SELECT COUNT(*) AS `running`, `priority` FROM `process` INNER JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid` GROUP BY `priority`");
467 if (dbm::is_result($r))
468 foreach ($r AS $process)
469 $running[$process["priority"]] = $process["running"];
472 $r = q("SELECT COUNT(*) AS `entries`, `priority` FROM `workerqueue` GROUP BY `priority`");
473 if (dbm::is_result($r))
474 foreach ($r as $entry) {
475 if ($processlist != "")
476 $processlist .= ", ";
477 $processlist .= $entry["priority"].":".$running[$entry["priority"]]."/".$entry["entries"];
480 logger("Load: ".$load."/".$maxsysload." - processes: ".$active."/".$entries." (".$processlist.") - maximum: ".$queues."/".$maxqueues, LOGGER_DEBUG);
482 // Are there fewer workers running as possible? Then fork a new one.
483 if (!Config::get("system", "worker_dont_fork") AND ($queues > ($active + 1)) AND ($entries > 1)) {
484 logger("Active workers: ".$active."/".$queues." Fork a new worker.", LOGGER_DEBUG);
485 $args = array("include/poller.php", "no_cron");
491 return($active >= $queues);
495 * @brief Returns the number of active poller processes
497 * @return integer Number of active poller processes
499 function poller_active_workers() {
500 $workers = q("SELECT COUNT(*) AS `processes` FROM `process` WHERE `command` = 'poller.php'");
502 return($workers[0]["processes"]);
506 * @brief Check if we should pass some slow processes
508 * When the active processes of the highest priority are using more than 2/3
509 * of all processes, we let pass slower processes.
511 * @param string $highest_priority Returns the currently highest priority
512 * @return bool We let pass a slower process than $highest_priority
514 function poller_passing_slow(&$highest_priority) {
516 $highest_priority = 0;
518 $r = q("SELECT `priority`
520 INNER JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid`");
522 // No active processes at all? Fine
523 if (!dbm::is_result($r))
526 $priorities = array();
527 foreach ($r AS $line)
528 $priorities[] = $line["priority"];
531 if (count($priorities) == 0)
534 $highest_priority = min($priorities);
536 // The highest process is already the slowest one?
538 if ($highest_priority == PRIORITY_NEGLIGIBLE)
542 foreach ($priorities AS $priority)
543 if ($priority == $highest_priority)
546 logger("Highest priority: ".$highest_priority." Total processes: ".count($priorities)." Count high priority processes: ".$high, LOGGER_DEBUG);
547 $passing_slow = (($high/count($priorities)) > (2/3));
550 logger("Passing slower processes than priority ".$highest_priority, LOGGER_DEBUG);
552 return($passing_slow);
556 * @brief Returns the next worker process
558 * @return string SQL statement
560 function poller_worker_process() {
562 q("START TRANSACTION;");
564 // Check if we should pass some low priority process
565 $highest_priority = 0;
567 if (poller_passing_slow($highest_priority)) {
568 // Are there waiting processes with a higher priority than the currently highest?
569 $r = q("SELECT * FROM `workerqueue`
570 WHERE `executed` <= '%s' AND `priority` < %d
571 ORDER BY `priority`, `created` LIMIT 1",
573 intval($highest_priority));
574 if (dbm::is_result($r)) {
577 // Give slower processes some processing time
578 $r = q("SELECT * FROM `workerqueue`
579 WHERE `executed` <= '%s' AND `priority` > %d
580 ORDER BY `priority`, `created` LIMIT 1",
582 intval($highest_priority));
585 // If there is no result (or we shouldn't pass lower processes) we check without priority limit
586 if (($highest_priority == 0) OR !dbm::is_result($r)) {
587 $r = q("SELECT * FROM `workerqueue` WHERE `executed` <= '%s' ORDER BY `priority`, `created` LIMIT 1", dbesc(NULL_DATE));
593 * @brief Call the front end worker
595 function call_worker() {
596 if (!Config::get("system", "frontend_worker")) {
600 $url = App::get_baseurl()."/worker";
601 fetch_url($url, false, $redirects, 1);
605 * @brief Call the front end worker if there aren't any active
607 function call_worker_if_idle() {
608 if (!Config::get("system", "frontend_worker")) {
612 // Do we have "proc_open"? Then we can fork the poller
613 if (function_exists("proc_open")) {
614 // When was the last time that we called the worker?
615 // Less than one minute? Then we quit
616 if ((time() - Config::get("system", "worker_started")) < 60) {
620 set_config("system", "worker_started", time());
622 // Do we have enough running workers? Then we quit here.
623 if (poller_too_much_workers()) {
624 // Cleaning dead processes
625 poller_kill_stale_workers();
626 get_app()->remove_inactive_processes();
633 logger('Call poller', LOGGER_DEBUG);
635 $args = array("include/poller.php", "no_cron");
641 // We cannot execute background processes.
642 // We now run the processes from the frontend.
643 // This won't work with long running processes.
646 clear_worker_processes();
648 $workers = q("SELECT COUNT(*) AS `processes` FROM `process` WHERE `command` = 'worker.php'");
650 if ($workers[0]["processes"] == 0) {
656 * @brief Removes long running worker processes
658 function clear_worker_processes() {
659 $timeout = Config::get("system", "frontend_worker_timeout", 10);
661 /// @todo We should clean up the corresponding workerqueue entries as well
662 q("DELETE FROM `process` WHERE `created` < '%s' AND `command` = 'worker.php'",
663 dbesc(datetime_convert('UTC','UTC',"now - ".$timeout." minutes")));
667 * @brief Runs the cron processes
669 function poller_run_cron() {
670 logger('Add cron entries', LOGGER_DEBUG);
672 // Check for spooled items
673 proc_run(PRIORITY_HIGH, "include/spool_post.php");
675 // Run the cron job that calls all other jobs
676 proc_run(PRIORITY_MEDIUM, "include/cron.php");
678 // Run the cronhooks job separately from cron for being able to use a different timing
679 proc_run(PRIORITY_MEDIUM, "include/cronhooks.php");
681 // Cleaning dead processes
682 poller_kill_stale_workers();
685 if (array_search(__file__,get_included_files())===0){
686 poller_run($_SERVER["argv"],$_SERVER["argc"]);
688 get_app()->end_process();