2 if (!file_exists("boot.php") AND (sizeof($_SERVER["argv"]) != 0)) {
3 $directory = dirname($_SERVER["argv"][0]);
5 if (substr($directory, 0, 1) != "/")
6 $directory = $_SERVER["PWD"]."/".$directory;
8 $directory = realpath($directory."/..");
13 use \Friendica\Core\Config;
14 use \Friendica\Core\PConfig;
16 require_once("boot.php");
18 function poller_run($argv, $argc){
26 @include(".htconfig.php");
27 require_once("include/dba.php");
28 $db = new dba($db_host, $db_user, $db_pass, $db_data);
29 unset($db_host, $db_user, $db_pass, $db_data);
32 // Quit when in maintenance
33 if (Config::get('system', 'maintenance', true)) {
39 if (poller_max_connections_reached()) {
43 if ($a->maxload_reached()) {
47 if(($argc <= 1) OR ($argv[1] != "no_cron")) {
51 if ($a->max_processes_reached()) {
55 // Checking the number of workers
56 if (poller_too_much_workers()) {
57 poller_kill_stale_workers();
63 while ($r = poller_worker_process()) {
65 // Count active workers and compare them with a maximum value that depends on the load
66 if (poller_too_much_workers()) {
70 if (!poller_execute($r[0])) {
74 // Quit the poller once every hour
75 if (time() > ($starttime + 3600))
82 * @brief Execute a worker entry
84 * @param array $queue Workerqueue entry
86 * @return boolean "true" if further processing should be stopped
88 function poller_execute($queue) {
94 // Quit when in maintenance
95 if (Config::get('system', 'maintenance', true)) {
99 // Constantly check the number of parallel database processes
100 if ($a->max_processes_reached()) {
104 // Constantly check the number of available database connections to let the frontend be accessible at any time
105 if (poller_max_connections_reached()) {
109 $upd = q("UPDATE `workerqueue` SET `executed` = '%s', `pid` = %d WHERE `id` = %d AND `pid` = 0",
110 dbesc(datetime_convert()),
112 intval($queue["id"]));
115 logger("Couldn't update queue entry ".$queue["id"]." - skip this execution", LOGGER_DEBUG);
120 // Assure that there are no tasks executed twice
121 $id = q("SELECT `pid`, `executed` FROM `workerqueue` WHERE `id` = %d", intval($queue["id"]));
123 logger("Queue item ".$queue["id"]." vanished - skip this execution", LOGGER_DEBUG);
126 } elseif ((strtotime($id[0]["executed"]) <= 0) OR ($id[0]["pid"] == 0)) {
127 logger("Entry for queue item ".$queue["id"]." wasn't stored - skip this execution", LOGGER_DEBUG);
130 } elseif ($id[0]["pid"] != $mypid) {
131 logger("Queue item ".$queue["id"]." is to be executed by process ".$id[0]["pid"]." and not by me (".$mypid.") - skip this execution", LOGGER_DEBUG);
137 $argv = json_decode($queue["parameter"]);
139 // Check for existance and validity of the include file
142 if (!validate_include($include)) {
143 logger("Include file ".$argv[0]." is not valid!");
144 q("DELETE FROM `workerqueue` WHERE `id` = %d", intval($queue["id"]));
148 require_once($include);
150 $funcname = str_replace(".php", "", basename($argv[0]))."_run";
152 if (function_exists($funcname)) {
154 poller_exec_function($queue, $funcname, $argv);
156 q("DELETE FROM `workerqueue` WHERE `id` = %d", intval($queue["id"]));
158 logger("Function ".$funcname." does not exist");
165 * @brief Execute a function from the queue
167 * @param array $queue Workerqueue entry
168 * @param string $funcname name of the function
169 * @param array $argv Array of values to be passed to the function
171 function poller_exec_function($queue, $funcname, $argv) {
177 $argc = count($argv);
179 logger("Process ".$mypid." - Prio ".$queue["priority"]." - ID ".$queue["id"].": ".$funcname." ".$queue["parameter"]);
181 $stamp = (float)microtime(true);
183 // We use the callstack here to analyze the performance of executed worker entries.
184 // For this reason the variables have to be initialized.
185 if (Config::get("system", "profiler")) {
186 $a->performance["start"] = microtime(true);
187 $a->performance["database"] = 0;
188 $a->performance["database_write"] = 0;
189 $a->performance["network"] = 0;
190 $a->performance["file"] = 0;
191 $a->performance["rendering"] = 0;
192 $a->performance["parser"] = 0;
193 $a->performance["marktime"] = 0;
194 $a->performance["markstart"] = microtime(true);
195 $a->callstack = array();
198 // For better logging create a new process id for every worker call
199 // But preserve the old one for the worker
200 $old_process_id = $a->process_id;
201 $a->process_id = uniqid("wrk", true);
203 $funcname($argv, $argc);
205 $a->process_id = $old_process_id;
207 $duration = number_format(microtime(true) - $stamp, 3);
209 logger("Process ".$mypid." - Prio ".$queue["priority"]." - ID ".$queue["id"].": ".$funcname." - done in ".$duration." seconds.");
211 // Write down the performance values into the log
212 if (Config::get("system", "profiler")) {
213 $duration = microtime(true)-$a->performance["start"];
215 if (Config::get("rendertime", "callstack")) {
216 if (isset($a->callstack["database"])) {
217 $o = "\nDatabase Read:\n";
218 foreach ($a->callstack["database"] AS $func => $time) {
219 $time = round($time, 3);
221 $o .= $func.": ".$time."\n";
224 if (isset($a->callstack["database_write"])) {
225 $o .= "\nDatabase Write:\n";
226 foreach ($a->callstack["database_write"] AS $func => $time) {
227 $time = round($time, 3);
229 $o .= $func.": ".$time."\n";
232 if (isset($a->callstack["network"])) {
233 $o .= "\nNetwork:\n";
234 foreach ($a->callstack["network"] AS $func => $time) {
235 $time = round($time, 3);
237 $o .= $func.": ".$time."\n";
244 logger("ID ".$queue["id"].": ".$funcname.": ".sprintf("DB: %s/%s, Net: %s, I/O: %s, Other: %s, Total: %s".$o,
245 number_format($a->performance["database"] - $a->performance["database_write"], 2),
246 number_format($a->performance["database_write"], 2),
247 number_format($a->performance["network"], 2),
248 number_format($a->performance["file"], 2),
249 number_format($duration - ($a->performance["database"] + $a->performance["network"] + $a->performance["file"]), 2),
250 number_format($duration, 2)),
254 $cooldown = Config::get("system", "worker_cooldown", 0);
257 logger("Process ".$mypid." - Prio ".$queue["priority"]." - ID ".$queue["id"].": ".$funcname." - in cooldown for ".$cooldown." seconds");
263 * @brief Checks if the number of database connections has reached a critical limit.
265 * @return bool Are more than 3/4 of the maximum connections used?
267 function poller_max_connections_reached() {
269 // Fetch the max value from the config. This is needed when the system cannot detect the correct value by itself.
270 $max = Config::get("system", "max_connections");
272 // Fetch the percentage level where the poller will get active
273 $maxlevel = Config::get("system", "max_connections_level", 75);
276 // the maximum number of possible user connections can be a system variable
277 $r = q("SHOW VARIABLES WHERE `variable_name` = 'max_user_connections'");
279 $max = $r[0]["Value"];
281 // Or it can be granted. This overrides the system variable
282 $r = q("SHOW GRANTS");
284 foreach ($r AS $grants) {
285 $grant = array_pop($grants);
286 if (stristr($grant, "GRANT USAGE ON"))
287 if (preg_match("/WITH MAX_USER_CONNECTIONS (\d*)/", $grant, $match))
292 // If $max is set we will use the processlist to determine the current number of connections
293 // The processlist only shows entries of the current user
295 $r = q("SHOW PROCESSLIST");
296 if (!dbm::is_result($r))
301 logger("Connection usage (user values): ".$used."/".$max, LOGGER_DEBUG);
303 $level = ($used / $max) * 100;
305 if ($level >= $maxlevel) {
306 logger("Maximum level (".$maxlevel."%) of user connections reached: ".$used."/".$max);
311 // We will now check for the system values.
312 // This limit could be reached although the user limits are fine.
313 $r = q("SHOW VARIABLES WHERE `variable_name` = 'max_connections'");
317 $max = intval($r[0]["Value"]);
321 $r = q("SHOW STATUS WHERE `variable_name` = 'Threads_connected'");
325 $used = intval($r[0]["Value"]);
329 logger("Connection usage (system values): ".$used."/".$max, LOGGER_DEBUG);
331 $level = $used / $max * 100;
333 if ($level < $maxlevel)
336 logger("Maximum level (".$level."%) of system connections reached: ".$used."/".$max);
341 * @brief fix the queue entry if the worker process died
344 function poller_kill_stale_workers() {
345 $r = q("SELECT `pid`, `executed`, `priority`, `parameter` FROM `workerqueue` WHERE `executed` != '0000-00-00 00:00:00'");
347 if (!dbm::is_result($r)) {
348 // No processing here needed
353 if (!posix_kill($pid["pid"], 0))
354 q("UPDATE `workerqueue` SET `executed` = '0000-00-00 00:00:00', `pid` = 0 WHERE `pid` = %d",
355 intval($pid["pid"]));
357 // Kill long running processes
359 // Check if the priority is in a valid range
360 if (!in_array($pid["priority"], array(PRIORITY_CRITICAL, PRIORITY_HIGH, PRIORITY_MEDIUM, PRIORITY_LOW, PRIORITY_NEGLIGIBLE)))
361 $pid["priority"] = PRIORITY_MEDIUM;
363 // Define the maximum durations
364 $max_duration_defaults = array(PRIORITY_CRITICAL => 360, PRIORITY_HIGH => 10, PRIORITY_MEDIUM => 60, PRIORITY_LOW => 180, PRIORITY_NEGLIGIBLE => 360);
365 $max_duration = $max_duration_defaults[$pid["priority"]];
367 $argv = json_decode($pid["parameter"]);
368 $argv[0] = basename($argv[0]);
370 // How long is the process already running?
371 $duration = (time() - strtotime($pid["executed"])) / 60;
372 if ($duration > $max_duration) {
373 logger("Worker process ".$pid["pid"]." (".implode(" ", $argv).") took more than ".$max_duration." minutes. It will be killed now.");
374 posix_kill($pid["pid"], SIGTERM);
376 // We killed the stale process.
377 // To avoid a blocking situation we reschedule the process at the beginning of the queue.
378 // Additionally we are lowering the priority.
379 q("UPDATE `workerqueue` SET `executed` = '0000-00-00 00:00:00', `created` = '%s',
380 `priority` = %d, `pid` = 0 WHERE `pid` = %d",
381 dbesc(datetime_convert()),
382 intval(PRIORITY_NEGLIGIBLE),
383 intval($pid["pid"]));
385 logger("Worker process ".$pid["pid"]." (".implode(" ", $argv).") now runs for ".round($duration)." of ".$max_duration." allowed minutes. That's okay.", LOGGER_DEBUG);
390 * @brief Checks if the number of active workers exceeds the given limits
392 * @return bool Are there too much workers running?
394 function poller_too_much_workers() {
395 $queues = Config::get("system", "worker_queues", 4);
397 $maxqueues = $queues;
399 $active = poller_active_workers();
401 // Decrease the number of workers at higher load
402 $load = current_load();
404 $maxsysload = intval(Config::get("system", "maxloadavg", 50));
406 $maxworkers = $queues;
408 // Some magical mathemathics to reduce the workers
410 $slope = $maxworkers / pow($maxsysload, $exponent);
411 $queues = ceil($slope * pow(max(0, $maxsysload - $load), $exponent));
413 $s = q("SELECT COUNT(*) AS `total` FROM `workerqueue` WHERE `executed` = '0000-00-00 00:00:00'");
414 $entries = $s[0]["total"];
416 if (Config::get("system", "worker_fastlane", false) AND ($queues > 0) AND ($entries > 0) AND ($active >= $queues)) {
417 $s = q("SELECT `priority` FROM `workerqueue` WHERE `executed` = '0000-00-00 00:00:00' ORDER BY `priority` LIMIT 1");
418 $top_priority = $s[0]["priority"];
420 $s = q("SELECT `id` FROM `workerqueue` WHERE `priority` <= %d AND `executed` != '0000-00-00 00:00:00' LIMIT 1",
421 intval($top_priority));
422 $high_running = dbm::is_result($s);
424 if (!$high_running AND ($top_priority > PRIORITY_UNDEFINED) AND ($top_priority < PRIORITY_NEGLIGIBLE)) {
425 logger("There are jobs with priority ".$top_priority." waiting but none is executed. Open a fastlane.", LOGGER_DEBUG);
426 $queues = $active + 1;
430 // Create a list of queue entries grouped by their priority
431 $running = array(PRIORITY_CRITICAL => 0,
433 PRIORITY_MEDIUM => 0,
435 PRIORITY_NEGLIGIBLE => 0);
437 $r = q("SELECT COUNT(*) AS `running`, `priority` FROM `process` INNER JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid` GROUP BY `priority`");
438 if (dbm::is_result($r))
439 foreach ($r AS $process)
440 $running[$process["priority"]] = $process["running"];
443 $r = q("SELECT COUNT(*) AS `entries`, `priority` FROM `workerqueue` GROUP BY `priority`");
444 if (dbm::is_result($r))
445 foreach ($r as $entry) {
446 if ($processlist != "")
447 $processlist .= ", ";
448 $processlist .= $entry["priority"].":".$running[$entry["priority"]]."/".$entry["entries"];
451 logger("Load: ".$load."/".$maxsysload." - processes: ".$active."/".$entries." (".$processlist.") - maximum: ".$queues."/".$maxqueues, LOGGER_DEBUG);
453 // Are there fewer workers running as possible? Then fork a new one.
454 if (!Config::get("system", "worker_dont_fork") AND ($queues > ($active + 1)) AND ($entries > 1)) {
455 logger("Active workers: ".$active."/".$queues." Fork a new worker.", LOGGER_DEBUG);
456 $args = array("php", "include/poller.php", "no_cron");
462 return($active >= $queues);
466 * @brief Returns the number of active poller processes
468 * @return integer Number of active poller processes
470 function poller_active_workers() {
471 $workers = q("SELECT COUNT(*) AS `processes` FROM `process` WHERE `command` = 'poller.php'");
473 return($workers[0]["processes"]);
477 * @brief Check if we should pass some slow processes
479 * When the active processes of the highest priority are using more than 2/3
480 * of all processes, we let pass slower processes.
482 * @param string $highest_priority Returns the currently highest priority
483 * @return bool We let pass a slower process than $highest_priority
485 function poller_passing_slow(&$highest_priority) {
487 $highest_priority = 0;
489 $r = q("SELECT `priority`
491 INNER JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid`");
493 // No active processes at all? Fine
494 if (!dbm::is_result($r))
497 $priorities = array();
498 foreach ($r AS $line)
499 $priorities[] = $line["priority"];
502 if (count($priorities) == 0)
505 $highest_priority = min($priorities);
507 // The highest process is already the slowest one?
509 if ($highest_priority == PRIORITY_NEGLIGIBLE)
513 foreach ($priorities AS $priority)
514 if ($priority == $highest_priority)
517 logger("Highest priority: ".$highest_priority." Total processes: ".count($priorities)." Count high priority processes: ".$high, LOGGER_DEBUG);
518 $passing_slow = (($high/count($priorities)) > (2/3));
521 logger("Passing slower processes than priority ".$highest_priority, LOGGER_DEBUG);
523 return($passing_slow);
527 * @brief Returns the next worker process
529 * @return string SQL statement
531 function poller_worker_process() {
533 q("START TRANSACTION;");
535 // Check if we should pass some low priority process
536 $highest_priority = 0;
538 if (poller_passing_slow($highest_priority)) {
539 // Are there waiting processes with a higher priority than the currently highest?
540 $r = q("SELECT * FROM `workerqueue`
541 WHERE `executed` = '0000-00-00 00:00:00' AND `priority` < %d
542 ORDER BY `priority`, `created` LIMIT 1", dbesc($highest_priority));
543 if (dbm::is_result($r))
546 // Give slower processes some processing time
547 $r = q("SELECT * FROM `workerqueue`
548 WHERE `executed` = '0000-00-00 00:00:00' AND `priority` > %d
549 ORDER BY `priority`, `created` LIMIT 1", dbesc($highest_priority));
552 // If there is no result (or we shouldn't pass lower processes) we check without priority limit
553 if (($highest_priority == 0) OR !dbm::is_result($r))
554 $r = q("SELECT * FROM `workerqueue` WHERE `executed` = '0000-00-00 00:00:00' ORDER BY `priority`, `created` LIMIT 1");
560 * @brief Call the front end worker
562 function call_worker() {
563 if (!Config::get("system", "frontend_worker") OR !Config::get("system", "worker")) {
567 $url = App::get_baseurl()."/worker";
568 fetch_url($url, false, $redirects, 1);
572 * @brief Call the front end worker if there aren't any active
574 function call_worker_if_idle() {
575 if (!Config::get("system", "frontend_worker") OR !Config::get("system", "worker")) {
579 // Do we have "proc_open"? Then we can fork the poller
580 if (function_exists("proc_open")) {
581 // When was the last time that we called the worker?
582 // Less than one minute? Then we quit
583 if ((time() - Config::get("system", "worker_started")) < 60) {
587 set_config("system", "worker_started", time());
589 // Do we have enough running workers? Then we quit here.
590 if (poller_too_much_workers()) {
591 // Cleaning dead processes
592 poller_kill_stale_workers();
593 get_app()->remove_inactive_processes();
600 logger('Call poller', LOGGER_DEBUG);
602 $args = array("php", "include/poller.php", "no_cron");
608 // We cannot execute background processes.
609 // We now run the processes from the frontend.
610 // This won't work with long running processes.
613 clear_worker_processes();
615 $workers = q("SELECT COUNT(*) AS `processes` FROM `process` WHERE `command` = 'worker.php'");
617 if ($workers[0]["processes"] == 0) {
623 * @brief Removes long running worker processes
625 function clear_worker_processes() {
626 $timeout = Config::get("system", "frontend_worker_timeout", 10);
628 /// @todo We should clean up the corresponding workerqueue entries as well
629 q("DELETE FROM `process` WHERE `created` < '%s' AND `command` = 'worker.php'",
630 dbesc(datetime_convert('UTC','UTC',"now - ".$timeout." minutes")));
634 * @brief Runs the cron processes
636 function poller_run_cron() {
637 logger('Add cron entries', LOGGER_DEBUG);
639 // Check for spooled items
640 proc_run(PRIORITY_HIGH, "include/spool_post.php");
642 // Run the cron job that calls all other jobs
643 proc_run(PRIORITY_MEDIUM, "include/cron.php");
645 // Run the cronhooks job separately from cron for being able to use a different timing
646 proc_run(PRIORITY_MEDIUM, "include/cronhooks.php");
648 // Cleaning dead processes
649 poller_kill_stale_workers();
652 if (array_search(__file__,get_included_files())===0){
653 poller_run($_SERVER["argv"],$_SERVER["argc"]);
655 get_app()->end_process();