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;
15 require_once("boot.php");
17 function poller_run($argv, $argc){
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);
33 // Quit when in maintenance
34 if (Config::get('system', 'maintenance', true)) {
40 if (poller_max_connections_reached()) {
44 if ($a->maxload_reached()) {
48 if(($argc <= 1) OR ($argv[1] != "no_cron")) {
52 if ($a->max_processes_reached()) {
56 // Checking the number of workers
57 if (poller_too_much_workers()) {
58 poller_kill_stale_workers();
64 while ($r = poller_worker_process()) {
66 // Count active workers and compare them with a maximum value that depends on the load
67 if (poller_too_much_workers()) {
71 if (!poller_execute($r[0])) {
75 // Quit the poller once every hour
76 if (time() > ($starttime + 3600))
83 * @brief Execute a worker entry
85 * @param array $queue Workerqueue entry
87 * @return boolean "true" if further processing should be stopped
89 function poller_execute($queue) {
95 // Quit when in maintenance
96 if (Config::get('system', 'maintenance', true)) {
100 // Constantly check the number of parallel database processes
101 if ($a->max_processes_reached()) {
105 // Constantly check the number of available database connections to let the frontend be accessible at any time
106 if (poller_max_connections_reached()) {
110 $upd = q("UPDATE `workerqueue` SET `executed` = '%s', `pid` = %d WHERE `id` = %d AND `pid` = 0",
111 dbesc(datetime_convert()),
113 intval($queue["id"]));
116 logger("Couldn't update queue entry ".$queue["id"]." - skip this execution", LOGGER_DEBUG);
121 // Assure that there are no tasks executed twice
122 $id = q("SELECT `pid`, `executed` FROM `workerqueue` WHERE `id` = %d", intval($queue["id"]));
124 logger("Queue item ".$queue["id"]." vanished - skip this execution", LOGGER_DEBUG);
127 } elseif ((strtotime($id[0]["executed"]) <= 0) OR ($id[0]["pid"] == 0)) {
128 logger("Entry for queue item ".$queue["id"]." wasn't stored - skip this execution", LOGGER_DEBUG);
131 } elseif ($id[0]["pid"] != $mypid) {
132 logger("Queue item ".$queue["id"]." is to be executed by process ".$id[0]["pid"]." and not by me (".$mypid.") - skip this execution", LOGGER_DEBUG);
138 $argv = json_decode($queue["parameter"]);
140 // Check for existance and validity of the include file
143 if (!validate_include($include)) {
144 logger("Include file ".$argv[0]." is not valid!");
145 q("DELETE FROM `workerqueue` WHERE `id` = %d", intval($queue["id"]));
149 require_once($include);
151 $funcname = str_replace(".php", "", basename($argv[0]))."_run";
153 if (function_exists($funcname)) {
155 poller_exec_function($queue, $funcname, $argv);
157 q("DELETE FROM `workerqueue` WHERE `id` = %d", intval($queue["id"]));
159 logger("Function ".$funcname." does not exist");
166 * @brief Execute a function from the queue
168 * @param array $queue Workerqueue entry
169 * @param string $funcname name of the function
170 * @param array $argv Array of values to be passed to the function
172 function poller_exec_function($queue, $funcname, $argv) {
178 $argc = count($argv);
180 logger("Process ".$mypid." - Prio ".$queue["priority"]." - ID ".$queue["id"].": ".$funcname." ".$queue["parameter"]);
182 $stamp = (float)microtime(true);
184 // We use the callstack here to analyze the performance of executed worker entries.
185 // For this reason the variables have to be initialized.
186 if (Config::get("system", "profiler")) {
187 $a->performance["start"] = microtime(true);
188 $a->performance["database"] = 0;
189 $a->performance["database_write"] = 0;
190 $a->performance["network"] = 0;
191 $a->performance["file"] = 0;
192 $a->performance["rendering"] = 0;
193 $a->performance["parser"] = 0;
194 $a->performance["marktime"] = 0;
195 $a->performance["markstart"] = microtime(true);
196 $a->callstack = array();
199 // For better logging create a new process id for every worker call
200 // But preserve the old one for the worker
201 $old_process_id = $a->process_id;
202 $a->process_id = uniqid("wrk", true);
204 $funcname($argv, $argc);
206 $a->process_id = $old_process_id;
208 $duration = number_format(microtime(true) - $stamp, 3);
210 if ($duration > 3600) {
211 logger("Prio ".$queue["priority"].": ".$queue["parameter"]." - longer than 1 hour (".round($duration/60, 3).")", LOGGER_DEBUG);
212 } elseif ($duration > 600) {
213 logger("Prio ".$queue["priority"].": ".$queue["parameter"]." - longer than 10 minutes (".round($duration/60, 3).")", LOGGER_DEBUG);
214 } elseif ($duration > 300) {
215 logger("Prio ".$queue["priority"].": ".$queue["parameter"]." - longer than 5 minutes (".round($duration/60, 3).")", LOGGER_DEBUG);
216 } elseif ($duration > 120) {
217 logger("Prio ".$queue["priority"].": ".$queue["parameter"]." - longer than 2 minutes (".round($duration/60, 3).")", LOGGER_DEBUG);
220 logger("Process ".$mypid." - Prio ".$queue["priority"]." - ID ".$queue["id"].": ".$funcname." - done in ".$duration." seconds.");
222 // Write down the performance values into the log
223 if (Config::get("system", "profiler")) {
224 $duration = microtime(true)-$a->performance["start"];
226 if (Config::get("rendertime", "callstack")) {
227 if (isset($a->callstack["database"])) {
228 $o = "\nDatabase Read:\n";
229 foreach ($a->callstack["database"] AS $func => $time) {
230 $time = round($time, 3);
232 $o .= $func.": ".$time."\n";
235 if (isset($a->callstack["database_write"])) {
236 $o .= "\nDatabase Write:\n";
237 foreach ($a->callstack["database_write"] AS $func => $time) {
238 $time = round($time, 3);
240 $o .= $func.": ".$time."\n";
243 if (isset($a->callstack["network"])) {
244 $o .= "\nNetwork:\n";
245 foreach ($a->callstack["network"] AS $func => $time) {
246 $time = round($time, 3);
248 $o .= $func.": ".$time."\n";
255 logger("ID ".$queue["id"].": ".$funcname.": ".sprintf("DB: %s/%s, Net: %s, I/O: %s, Other: %s, Total: %s".$o,
256 number_format($a->performance["database"] - $a->performance["database_write"], 2),
257 number_format($a->performance["database_write"], 2),
258 number_format($a->performance["network"], 2),
259 number_format($a->performance["file"], 2),
260 number_format($duration - ($a->performance["database"] + $a->performance["network"] + $a->performance["file"]), 2),
261 number_format($duration, 2)),
265 $cooldown = Config::get("system", "worker_cooldown", 0);
268 logger("Process ".$mypid." - Prio ".$queue["priority"]." - ID ".$queue["id"].": ".$funcname." - in cooldown for ".$cooldown." seconds");
274 * @brief Checks if the number of database connections has reached a critical limit.
276 * @return bool Are more than 3/4 of the maximum connections used?
278 function poller_max_connections_reached() {
280 // Fetch the max value from the config. This is needed when the system cannot detect the correct value by itself.
281 $max = Config::get("system", "max_connections");
283 // Fetch the percentage level where the poller will get active
284 $maxlevel = Config::get("system", "max_connections_level", 75);
287 // the maximum number of possible user connections can be a system variable
288 $r = q("SHOW VARIABLES WHERE `variable_name` = 'max_user_connections'");
290 $max = $r[0]["Value"];
292 // Or it can be granted. This overrides the system variable
293 $r = q("SHOW GRANTS");
295 foreach ($r AS $grants) {
296 $grant = array_pop($grants);
297 if (stristr($grant, "GRANT USAGE ON"))
298 if (preg_match("/WITH MAX_USER_CONNECTIONS (\d*)/", $grant, $match))
303 // If $max is set we will use the processlist to determine the current number of connections
304 // The processlist only shows entries of the current user
306 $r = q("SHOW PROCESSLIST");
307 if (!dbm::is_result($r))
312 logger("Connection usage (user values): ".$used."/".$max, LOGGER_DEBUG);
314 $level = ($used / $max) * 100;
316 if ($level >= $maxlevel) {
317 logger("Maximum level (".$maxlevel."%) of user connections reached: ".$used."/".$max);
322 // We will now check for the system values.
323 // This limit could be reached although the user limits are fine.
324 $r = q("SHOW VARIABLES WHERE `variable_name` = 'max_connections'");
328 $max = intval($r[0]["Value"]);
332 $r = q("SHOW STATUS WHERE `variable_name` = 'Threads_connected'");
336 $used = intval($r[0]["Value"]);
340 logger("Connection usage (system values): ".$used."/".$max, LOGGER_DEBUG);
342 $level = $used / $max * 100;
344 if ($level < $maxlevel)
347 logger("Maximum level (".$level."%) of system connections reached: ".$used."/".$max);
352 * @brief fix the queue entry if the worker process died
355 function poller_kill_stale_workers() {
356 $r = q("SELECT `pid`, `executed`, `priority`, `parameter` FROM `workerqueue` WHERE `executed` != '0000-00-00 00:00:00'");
358 if (!dbm::is_result($r)) {
359 // No processing here needed
364 if (!posix_kill($pid["pid"], 0))
365 q("UPDATE `workerqueue` SET `executed` = '0000-00-00 00:00:00', `pid` = 0 WHERE `pid` = %d",
366 intval($pid["pid"]));
368 // Kill long running processes
370 // Check if the priority is in a valid range
371 if (!in_array($pid["priority"], array(PRIORITY_CRITICAL, PRIORITY_HIGH, PRIORITY_MEDIUM, PRIORITY_LOW, PRIORITY_NEGLIGIBLE)))
372 $pid["priority"] = PRIORITY_MEDIUM;
374 // Define the maximum durations
375 $max_duration_defaults = array(PRIORITY_CRITICAL => 360, PRIORITY_HIGH => 10, PRIORITY_MEDIUM => 60, PRIORITY_LOW => 180, PRIORITY_NEGLIGIBLE => 360);
376 $max_duration = $max_duration_defaults[$pid["priority"]];
378 $argv = json_decode($pid["parameter"]);
379 $argv[0] = basename($argv[0]);
381 // How long is the process already running?
382 $duration = (time() - strtotime($pid["executed"])) / 60;
383 if ($duration > $max_duration) {
384 logger("Worker process ".$pid["pid"]." (".implode(" ", $argv).") took more than ".$max_duration." minutes. It will be killed now.");
385 posix_kill($pid["pid"], SIGTERM);
387 // We killed the stale process.
388 // To avoid a blocking situation we reschedule the process at the beginning of the queue.
389 // Additionally we are lowering the priority.
390 q("UPDATE `workerqueue` SET `executed` = '0000-00-00 00:00:00', `created` = '%s',
391 `priority` = %d, `pid` = 0 WHERE `pid` = %d",
392 dbesc(datetime_convert()),
393 intval(PRIORITY_NEGLIGIBLE),
394 intval($pid["pid"]));
396 logger("Worker process ".$pid["pid"]." (".implode(" ", $argv).") now runs for ".round($duration)." of ".$max_duration." allowed minutes. That's okay.", LOGGER_DEBUG);
401 * @brief Checks if the number of active workers exceeds the given limits
403 * @return bool Are there too much workers running?
405 function poller_too_much_workers() {
406 $queues = Config::get("system", "worker_queues", 4);
408 $maxqueues = $queues;
410 $active = poller_active_workers();
412 // Decrease the number of workers at higher load
413 $load = current_load();
415 $maxsysload = intval(Config::get("system", "maxloadavg", 50));
417 $maxworkers = $queues;
419 // Some magical mathemathics to reduce the workers
421 $slope = $maxworkers / pow($maxsysload, $exponent);
422 $queues = ceil($slope * pow(max(0, $maxsysload - $load), $exponent));
424 $s = q("SELECT COUNT(*) AS `total` FROM `workerqueue` WHERE `executed` = '0000-00-00 00:00:00'");
425 $entries = $s[0]["total"];
427 if (Config::get("system", "worker_fastlane", false) AND ($queues > 0) AND ($entries > 0) AND ($active >= $queues)) {
428 $s = q("SELECT `priority` FROM `workerqueue` WHERE `executed` = '0000-00-00 00:00:00' ORDER BY `priority` LIMIT 1");
429 $top_priority = $s[0]["priority"];
431 $s = q("SELECT `id` FROM `workerqueue` WHERE `priority` <= %d AND `executed` != '0000-00-00 00:00:00' LIMIT 1",
432 intval($top_priority));
433 $high_running = dbm::is_result($s);
435 if (!$high_running AND ($top_priority > PRIORITY_UNDEFINED) AND ($top_priority < PRIORITY_NEGLIGIBLE)) {
436 logger("There are jobs with priority ".$top_priority." waiting but none is executed. Open a fastlane.", LOGGER_DEBUG);
437 $queues = $active + 1;
441 // Create a list of queue entries grouped by their priority
442 $running = array(PRIORITY_CRITICAL => 0,
444 PRIORITY_MEDIUM => 0,
446 PRIORITY_NEGLIGIBLE => 0);
448 $r = q("SELECT COUNT(*) AS `running`, `priority` FROM `process` INNER JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid` GROUP BY `priority`");
449 if (dbm::is_result($r))
450 foreach ($r AS $process)
451 $running[$process["priority"]] = $process["running"];
454 $r = q("SELECT COUNT(*) AS `entries`, `priority` FROM `workerqueue` GROUP BY `priority`");
455 if (dbm::is_result($r))
456 foreach ($r as $entry) {
457 if ($processlist != "")
458 $processlist .= ", ";
459 $processlist .= $entry["priority"].":".$running[$entry["priority"]]."/".$entry["entries"];
462 logger("Load: ".$load."/".$maxsysload." - processes: ".$active."/".$entries." (".$processlist.") - maximum: ".$queues."/".$maxqueues, LOGGER_DEBUG);
464 // Are there fewer workers running as possible? Then fork a new one.
465 if (!Config::get("system", "worker_dont_fork") AND ($queues > ($active + 1)) AND ($entries > 1)) {
466 logger("Active workers: ".$active."/".$queues." Fork a new worker.", LOGGER_DEBUG);
467 $args = array("php", "include/poller.php", "no_cron");
473 return($active >= $queues);
477 * @brief Returns the number of active poller processes
479 * @return integer Number of active poller processes
481 function poller_active_workers() {
482 $workers = q("SELECT COUNT(*) AS `processes` FROM `process` WHERE `command` = 'poller.php'");
484 return($workers[0]["processes"]);
488 * @brief Check if we should pass some slow processes
490 * When the active processes of the highest priority are using more than 2/3
491 * of all processes, we let pass slower processes.
493 * @param string $highest_priority Returns the currently highest priority
494 * @return bool We let pass a slower process than $highest_priority
496 function poller_passing_slow(&$highest_priority) {
498 $highest_priority = 0;
500 $r = q("SELECT `priority`
502 INNER JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid`");
504 // No active processes at all? Fine
505 if (!dbm::is_result($r))
508 $priorities = array();
509 foreach ($r AS $line)
510 $priorities[] = $line["priority"];
513 if (count($priorities) == 0)
516 $highest_priority = min($priorities);
518 // The highest process is already the slowest one?
520 if ($highest_priority == PRIORITY_NEGLIGIBLE)
524 foreach ($priorities AS $priority)
525 if ($priority == $highest_priority)
528 logger("Highest priority: ".$highest_priority." Total processes: ".count($priorities)." Count high priority processes: ".$high, LOGGER_DEBUG);
529 $passing_slow = (($high/count($priorities)) > (2/3));
532 logger("Passing slower processes than priority ".$highest_priority, LOGGER_DEBUG);
534 return($passing_slow);
538 * @brief Returns the next worker process
540 * @return string SQL statement
542 function poller_worker_process() {
544 q("START TRANSACTION;");
546 // Check if we should pass some low priority process
547 $highest_priority = 0;
549 if (poller_passing_slow($highest_priority)) {
550 // Are there waiting processes with a higher priority than the currently highest?
551 $r = q("SELECT * FROM `workerqueue`
552 WHERE `executed` = '0000-00-00 00:00:00' AND `priority` < %d
553 ORDER BY `priority`, `created` LIMIT 1", dbesc($highest_priority));
554 if (dbm::is_result($r))
557 // Give slower processes some processing time
558 $r = q("SELECT * FROM `workerqueue`
559 WHERE `executed` = '0000-00-00 00:00:00' AND `priority` > %d
560 ORDER BY `priority`, `created` LIMIT 1", dbesc($highest_priority));
563 // If there is no result (or we shouldn't pass lower processes) we check without priority limit
564 if (($highest_priority == 0) OR !dbm::is_result($r))
565 $r = q("SELECT * FROM `workerqueue` WHERE `executed` = '0000-00-00 00:00:00' ORDER BY `priority`, `created` LIMIT 1");
571 * @brief Call the front end worker
573 function call_worker() {
574 if (!Config::get("system", "frontend_worker") OR !Config::get("system", "worker")) {
578 $url = App::get_baseurl()."/worker";
579 fetch_url($url, false, $redirects, 1);
583 * @brief Call the front end worker if there aren't any active
585 function call_worker_if_idle() {
586 if (!Config::get("system", "frontend_worker") OR !Config::get("system", "worker")) {
590 // Do we have "proc_open"? Then we can fork the poller
591 if (function_exists("proc_open")) {
592 // When was the last time that we called the worker?
593 // Less than one minute? Then we quit
594 if ((time() - Config::get("system", "worker_started")) < 60) {
598 set_config("system", "worker_started", time());
600 // Do we have enough running workers? Then we quit here.
601 if (poller_too_much_workers()) {
602 // Cleaning dead processes
603 poller_kill_stale_workers();
604 get_app()->remove_inactive_processes();
611 logger('Call poller', LOGGER_DEBUG);
613 $args = array("php", "include/poller.php", "no_cron");
619 // We cannot execute background processes.
620 // We now run the processes from the frontend.
621 // This won't work with long running processes.
624 clear_worker_processes();
626 $workers = q("SELECT COUNT(*) AS `processes` FROM `process` WHERE `command` = 'worker.php'");
628 if ($workers[0]["processes"] == 0) {
634 * @brief Removes long running worker processes
636 function clear_worker_processes() {
637 $timeout = Config::get("system", "frontend_worker_timeout", 10);
639 /// @todo We should clean up the corresponding workerqueue entries as well
640 q("DELETE FROM `process` WHERE `created` < '%s' AND `command` = 'worker.php'",
641 dbesc(datetime_convert('UTC','UTC',"now - ".$timeout." minutes")));
645 * @brief Runs the cron processes
647 function poller_run_cron() {
648 logger('Add cron entries', LOGGER_DEBUG);
650 // Check for spooled items
651 proc_run(PRIORITY_HIGH, "include/spool_post.php");
653 // Run the cron job that calls all other jobs
654 proc_run(PRIORITY_MEDIUM, "include/cron.php");
656 // Run the cronhooks job separately from cron for being able to use a different timing
657 proc_run(PRIORITY_MEDIUM, "include/cronhooks.php");
659 // Cleaning dead processes
660 poller_kill_stale_workers();
663 if (array_search(__file__,get_included_files())===0){
664 poller_run($_SERVER["argv"],$_SERVER["argc"]);
666 get_app()->end_process();