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)) {
38 $a->set_baseurl(Config::get('system', 'url'));
44 if (poller_max_connections_reached()) {
48 if ($a->maxload_reached()) {
52 if(($argc <= 1) OR ($argv[1] != "no_cron")) {
56 if ($a->max_processes_reached()) {
60 // Checking the number of workers
61 if (poller_too_much_workers()) {
62 poller_kill_stale_workers();
68 while ($r = poller_worker_process()) {
70 // Count active workers and compare them with a maximum value that depends on the load
71 if (poller_too_much_workers()) {
75 if (!poller_execute($r[0])) {
79 // Quit the poller once every hour
80 if (time() > ($starttime + 3600))
87 * @brief Execute a worker entry
89 * @param array $queue Workerqueue entry
91 * @return boolean "true" if further processing should be stopped
93 function poller_execute($queue) {
99 // Quit when in maintenance
100 if (Config::get('system', 'maintenance', true)) {
104 // Constantly check the number of parallel database processes
105 if ($a->max_processes_reached()) {
109 // Constantly check the number of available database connections to let the frontend be accessible at any time
110 if (poller_max_connections_reached()) {
114 $upd = q("UPDATE `workerqueue` SET `executed` = '%s', `pid` = %d WHERE `id` = %d AND `pid` = 0",
115 dbesc(datetime_convert()),
117 intval($queue["id"]));
120 logger("Couldn't update queue entry ".$queue["id"]." - skip this execution", LOGGER_DEBUG);
125 // Assure that there are no tasks executed twice
126 $id = q("SELECT `pid`, `executed` FROM `workerqueue` WHERE `id` = %d", intval($queue["id"]));
128 logger("Queue item ".$queue["id"]." vanished - skip this execution", LOGGER_DEBUG);
131 } elseif ((strtotime($id[0]["executed"]) <= 0) OR ($id[0]["pid"] == 0)) {
132 logger("Entry for queue item ".$queue["id"]." wasn't stored - skip this execution", LOGGER_DEBUG);
135 } elseif ($id[0]["pid"] != $mypid) {
136 logger("Queue item ".$queue["id"]." is to be executed by process ".$id[0]["pid"]." and not by me (".$mypid.") - skip this execution", LOGGER_DEBUG);
142 $argv = json_decode($queue["parameter"]);
144 // Check for existance and validity of the include file
147 if (!validate_include($include)) {
148 logger("Include file ".$argv[0]." is not valid!");
149 q("DELETE FROM `workerqueue` WHERE `id` = %d", intval($queue["id"]));
153 require_once($include);
155 $funcname = str_replace(".php", "", basename($argv[0]))."_run";
157 if (function_exists($funcname)) {
159 poller_exec_function($queue, $funcname, $argv);
161 q("DELETE FROM `workerqueue` WHERE `id` = %d", intval($queue["id"]));
163 logger("Function ".$funcname." does not exist");
170 * @brief Execute a function from the queue
172 * @param array $queue Workerqueue entry
173 * @param string $funcname name of the function
174 * @param array $argv Array of values to be passed to the function
176 function poller_exec_function($queue, $funcname, $argv) {
182 $argc = count($argv);
184 logger("Process ".$mypid." - Prio ".$queue["priority"]." - ID ".$queue["id"].": ".$funcname." ".$queue["parameter"]);
186 $stamp = (float)microtime(true);
188 // We use the callstack here to analyze the performance of executed worker entries.
189 // For this reason the variables have to be initialized.
190 if (Config::get("system", "profiler")) {
191 $a->performance["start"] = microtime(true);
192 $a->performance["database"] = 0;
193 $a->performance["database_write"] = 0;
194 $a->performance["network"] = 0;
195 $a->performance["file"] = 0;
196 $a->performance["rendering"] = 0;
197 $a->performance["parser"] = 0;
198 $a->performance["marktime"] = 0;
199 $a->performance["markstart"] = microtime(true);
200 $a->callstack = array();
203 // For better logging create a new process id for every worker call
204 // But preserve the old one for the worker
205 $old_process_id = $a->process_id;
206 $a->process_id = uniqid("wrk", true);
208 $funcname($argv, $argc);
210 $a->process_id = $old_process_id;
212 $duration = number_format(microtime(true) - $stamp, 3);
214 logger("Process ".$mypid." - Prio ".$queue["priority"]." - ID ".$queue["id"].": ".$funcname." - done in ".$duration." seconds.");
216 // Write down the performance values into the log
217 if (Config::get("system", "profiler")) {
218 $duration = microtime(true)-$a->performance["start"];
220 if (Config::get("rendertime", "callstack")) {
221 if (isset($a->callstack["database"])) {
222 $o = "\nDatabase Read:\n";
223 foreach ($a->callstack["database"] AS $func => $time) {
224 $time = round($time, 3);
226 $o .= $func.": ".$time."\n";
229 if (isset($a->callstack["database_write"])) {
230 $o .= "\nDatabase Write:\n";
231 foreach ($a->callstack["database_write"] AS $func => $time) {
232 $time = round($time, 3);
234 $o .= $func.": ".$time."\n";
237 if (isset($a->callstack["network"])) {
238 $o .= "\nNetwork:\n";
239 foreach ($a->callstack["network"] AS $func => $time) {
240 $time = round($time, 3);
242 $o .= $func.": ".$time."\n";
249 logger("ID ".$queue["id"].": ".$funcname.": ".sprintf("DB: %s/%s, Net: %s, I/O: %s, Other: %s, Total: %s".$o,
250 number_format($a->performance["database"] - $a->performance["database_write"], 2),
251 number_format($a->performance["database_write"], 2),
252 number_format($a->performance["network"], 2),
253 number_format($a->performance["file"], 2),
254 number_format($duration - ($a->performance["database"] + $a->performance["network"] + $a->performance["file"]), 2),
255 number_format($duration, 2)),
259 $cooldown = Config::get("system", "worker_cooldown", 0);
262 logger("Process ".$mypid." - Prio ".$queue["priority"]." - ID ".$queue["id"].": ".$funcname." - in cooldown for ".$cooldown." seconds");
268 * @brief Checks if the number of database connections has reached a critical limit.
270 * @return bool Are more than 3/4 of the maximum connections used?
272 function poller_max_connections_reached() {
274 // Fetch the max value from the config. This is needed when the system cannot detect the correct value by itself.
275 $max = Config::get("system", "max_connections");
277 // Fetch the percentage level where the poller will get active
278 $maxlevel = Config::get("system", "max_connections_level", 75);
281 // the maximum number of possible user connections can be a system variable
282 $r = q("SHOW VARIABLES WHERE `variable_name` = 'max_user_connections'");
284 $max = $r[0]["Value"];
286 // Or it can be granted. This overrides the system variable
287 $r = q("SHOW GRANTS");
289 foreach ($r AS $grants) {
290 $grant = array_pop($grants);
291 if (stristr($grant, "GRANT USAGE ON"))
292 if (preg_match("/WITH MAX_USER_CONNECTIONS (\d*)/", $grant, $match))
297 // If $max is set we will use the processlist to determine the current number of connections
298 // The processlist only shows entries of the current user
300 $r = q("SHOW PROCESSLIST");
301 if (!dbm::is_result($r))
306 logger("Connection usage (user values): ".$used."/".$max, LOGGER_DEBUG);
308 $level = ($used / $max) * 100;
310 if ($level >= $maxlevel) {
311 logger("Maximum level (".$maxlevel."%) of user connections reached: ".$used."/".$max);
316 // We will now check for the system values.
317 // This limit could be reached although the user limits are fine.
318 $r = q("SHOW VARIABLES WHERE `variable_name` = 'max_connections'");
322 $max = intval($r[0]["Value"]);
326 $r = q("SHOW STATUS WHERE `variable_name` = 'Threads_connected'");
330 $used = intval($r[0]["Value"]);
334 logger("Connection usage (system values): ".$used."/".$max, LOGGER_DEBUG);
336 $level = $used / $max * 100;
338 if ($level < $maxlevel)
341 logger("Maximum level (".$level."%) of system connections reached: ".$used."/".$max);
346 * @brief fix the queue entry if the worker process died
349 function poller_kill_stale_workers() {
350 $r = q("SELECT `pid`, `executed`, `priority`, `parameter` FROM `workerqueue` WHERE `executed` != '0000-00-00 00:00:00'");
352 if (!dbm::is_result($r)) {
353 // No processing here needed
358 if (!posix_kill($pid["pid"], 0))
359 q("UPDATE `workerqueue` SET `executed` = '0000-00-00 00:00:00', `pid` = 0 WHERE `pid` = %d",
360 intval($pid["pid"]));
362 // Kill long running processes
364 // Check if the priority is in a valid range
365 if (!in_array($pid["priority"], array(PRIORITY_CRITICAL, PRIORITY_HIGH, PRIORITY_MEDIUM, PRIORITY_LOW, PRIORITY_NEGLIGIBLE)))
366 $pid["priority"] = PRIORITY_MEDIUM;
368 // Define the maximum durations
369 $max_duration_defaults = array(PRIORITY_CRITICAL => 360, PRIORITY_HIGH => 10, PRIORITY_MEDIUM => 60, PRIORITY_LOW => 180, PRIORITY_NEGLIGIBLE => 360);
370 $max_duration = $max_duration_defaults[$pid["priority"]];
372 $argv = json_decode($pid["parameter"]);
373 $argv[0] = basename($argv[0]);
375 // How long is the process already running?
376 $duration = (time() - strtotime($pid["executed"])) / 60;
377 if ($duration > $max_duration) {
378 logger("Worker process ".$pid["pid"]." (".implode(" ", $argv).") took more than ".$max_duration." minutes. It will be killed now.");
379 posix_kill($pid["pid"], SIGTERM);
381 // We killed the stale process.
382 // To avoid a blocking situation we reschedule the process at the beginning of the queue.
383 // Additionally we are lowering the priority.
384 q("UPDATE `workerqueue` SET `executed` = '0000-00-00 00:00:00', `created` = '%s',
385 `priority` = %d, `pid` = 0 WHERE `pid` = %d",
386 dbesc(datetime_convert()),
387 intval(PRIORITY_NEGLIGIBLE),
388 intval($pid["pid"]));
390 logger("Worker process ".$pid["pid"]." (".implode(" ", $argv).") now runs for ".round($duration)." of ".$max_duration." allowed minutes. That's okay.", LOGGER_DEBUG);
395 * @brief Checks if the number of active workers exceeds the given limits
397 * @return bool Are there too much workers running?
399 function poller_too_much_workers() {
400 $queues = Config::get("system", "worker_queues", 4);
402 $maxqueues = $queues;
404 $active = poller_active_workers();
406 // Decrease the number of workers at higher load
407 $load = current_load();
409 $maxsysload = intval(Config::get("system", "maxloadavg", 50));
411 $maxworkers = $queues;
413 // Some magical mathemathics to reduce the workers
415 $slope = $maxworkers / pow($maxsysload, $exponent);
416 $queues = ceil($slope * pow(max(0, $maxsysload - $load), $exponent));
418 $s = q("SELECT COUNT(*) AS `total` FROM `workerqueue` WHERE `executed` = '0000-00-00 00:00:00'");
419 $entries = $s[0]["total"];
421 if (Config::get("system", "worker_fastlane", false) AND ($queues > 0) AND ($entries > 0) AND ($active >= $queues)) {
422 $s = q("SELECT `priority` FROM `workerqueue` WHERE `executed` = '0000-00-00 00:00:00' ORDER BY `priority` LIMIT 1");
423 $top_priority = $s[0]["priority"];
425 $s = q("SELECT `id` FROM `workerqueue` WHERE `priority` <= %d AND `executed` != '0000-00-00 00:00:00' LIMIT 1",
426 intval($top_priority));
427 $high_running = dbm::is_result($s);
429 if (!$high_running AND ($top_priority > PRIORITY_UNDEFINED) AND ($top_priority < PRIORITY_NEGLIGIBLE)) {
430 logger("There are jobs with priority ".$top_priority." waiting but none is executed. Open a fastlane.", LOGGER_DEBUG);
431 $queues = $active + 1;
435 // Create a list of queue entries grouped by their priority
436 $running = array(PRIORITY_CRITICAL => 0,
438 PRIORITY_MEDIUM => 0,
440 PRIORITY_NEGLIGIBLE => 0);
442 $r = q("SELECT COUNT(*) AS `running`, `priority` FROM `process` INNER JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid` GROUP BY `priority`");
443 if (dbm::is_result($r))
444 foreach ($r AS $process)
445 $running[$process["priority"]] = $process["running"];
448 $r = q("SELECT COUNT(*) AS `entries`, `priority` FROM `workerqueue` GROUP BY `priority`");
449 if (dbm::is_result($r))
450 foreach ($r as $entry) {
451 if ($processlist != "")
452 $processlist .= ", ";
453 $processlist .= $entry["priority"].":".$running[$entry["priority"]]."/".$entry["entries"];
456 logger("Load: ".$load."/".$maxsysload." - processes: ".$active."/".$entries." (".$processlist.") - maximum: ".$queues."/".$maxqueues, LOGGER_DEBUG);
458 // Are there fewer workers running as possible? Then fork a new one.
459 if (!Config::get("system", "worker_dont_fork") AND ($queues > ($active + 1)) AND ($entries > 1)) {
460 logger("Active workers: ".$active."/".$queues." Fork a new worker.", LOGGER_DEBUG);
461 $args = array("include/poller.php", "no_cron");
467 return($active >= $queues);
471 * @brief Returns the number of active poller processes
473 * @return integer Number of active poller processes
475 function poller_active_workers() {
476 $workers = q("SELECT COUNT(*) AS `processes` FROM `process` WHERE `command` = 'poller.php'");
478 return($workers[0]["processes"]);
482 * @brief Check if we should pass some slow processes
484 * When the active processes of the highest priority are using more than 2/3
485 * of all processes, we let pass slower processes.
487 * @param string $highest_priority Returns the currently highest priority
488 * @return bool We let pass a slower process than $highest_priority
490 function poller_passing_slow(&$highest_priority) {
492 $highest_priority = 0;
494 $r = q("SELECT `priority`
496 INNER JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid`");
498 // No active processes at all? Fine
499 if (!dbm::is_result($r))
502 $priorities = array();
503 foreach ($r AS $line)
504 $priorities[] = $line["priority"];
507 if (count($priorities) == 0)
510 $highest_priority = min($priorities);
512 // The highest process is already the slowest one?
514 if ($highest_priority == PRIORITY_NEGLIGIBLE)
518 foreach ($priorities AS $priority)
519 if ($priority == $highest_priority)
522 logger("Highest priority: ".$highest_priority." Total processes: ".count($priorities)." Count high priority processes: ".$high, LOGGER_DEBUG);
523 $passing_slow = (($high/count($priorities)) > (2/3));
526 logger("Passing slower processes than priority ".$highest_priority, LOGGER_DEBUG);
528 return($passing_slow);
532 * @brief Returns the next worker process
534 * @return string SQL statement
536 function poller_worker_process() {
538 q("START TRANSACTION;");
540 // Check if we should pass some low priority process
541 $highest_priority = 0;
543 if (poller_passing_slow($highest_priority)) {
544 // Are there waiting processes with a higher priority than the currently highest?
545 $r = q("SELECT * FROM `workerqueue`
546 WHERE `executed` = '0000-00-00 00:00:00' AND `priority` < %d
547 ORDER BY `priority`, `created` LIMIT 1", dbesc($highest_priority));
548 if (dbm::is_result($r))
551 // Give slower processes some processing time
552 $r = q("SELECT * FROM `workerqueue`
553 WHERE `executed` = '0000-00-00 00:00:00' AND `priority` > %d
554 ORDER BY `priority`, `created` LIMIT 1", dbesc($highest_priority));
557 // If there is no result (or we shouldn't pass lower processes) we check without priority limit
558 if (($highest_priority == 0) OR !dbm::is_result($r))
559 $r = q("SELECT * FROM `workerqueue` WHERE `executed` = '0000-00-00 00:00:00' ORDER BY `priority`, `created` LIMIT 1");
565 * @brief Call the front end worker
567 function call_worker() {
568 if (!Config::get("system", "frontend_worker")) {
572 $url = App::get_baseurl()."/worker";
573 fetch_url($url, false, $redirects, 1);
577 * @brief Call the front end worker if there aren't any active
579 function call_worker_if_idle() {
580 if (!Config::get("system", "frontend_worker")) {
584 // Do we have "proc_open"? Then we can fork the poller
585 if (function_exists("proc_open")) {
586 // When was the last time that we called the worker?
587 // Less than one minute? Then we quit
588 if ((time() - Config::get("system", "worker_started")) < 60) {
592 set_config("system", "worker_started", time());
594 // Do we have enough running workers? Then we quit here.
595 if (poller_too_much_workers()) {
596 // Cleaning dead processes
597 poller_kill_stale_workers();
598 get_app()->remove_inactive_processes();
605 logger('Call poller', LOGGER_DEBUG);
607 $args = array("include/poller.php", "no_cron");
613 // We cannot execute background processes.
614 // We now run the processes from the frontend.
615 // This won't work with long running processes.
618 clear_worker_processes();
620 $workers = q("SELECT COUNT(*) AS `processes` FROM `process` WHERE `command` = 'worker.php'");
622 if ($workers[0]["processes"] == 0) {
628 * @brief Removes long running worker processes
630 function clear_worker_processes() {
631 $timeout = Config::get("system", "frontend_worker_timeout", 10);
633 /// @todo We should clean up the corresponding workerqueue entries as well
634 q("DELETE FROM `process` WHERE `created` < '%s' AND `command` = 'worker.php'",
635 dbesc(datetime_convert('UTC','UTC',"now - ".$timeout." minutes")));
639 * @brief Runs the cron processes
641 function poller_run_cron() {
642 logger('Add cron entries', LOGGER_DEBUG);
644 // Check for spooled items
645 proc_run(PRIORITY_HIGH, "include/spool_post.php");
647 // Run the cron job that calls all other jobs
648 proc_run(PRIORITY_MEDIUM, "include/cron.php");
650 // Run the cronhooks job separately from cron for being able to use a different timing
651 proc_run(PRIORITY_MEDIUM, "include/cronhooks.php");
653 // Cleaning dead processes
654 poller_kill_stale_workers();
657 if (array_search(__file__,get_included_files())===0){
658 poller_run($_SERVER["argv"],$_SERVER["argc"]);
660 get_app()->end_process();