]> git.mxchange.org Git - friendica.git/blob - include/poller.php
Removed some more unneeded stuff
[friendica.git] / include / poller.php
1 <?php
2 if (!file_exists("boot.php") AND (sizeof($_SERVER["argv"]) != 0)) {
3         $directory = dirname($_SERVER["argv"][0]);
4
5         if (substr($directory, 0, 1) != "/")
6                 $directory = $_SERVER["PWD"]."/".$directory;
7
8         $directory = realpath($directory."/..");
9
10         chdir($directory);
11 }
12
13 use \Friendica\Core\Config;
14
15 require_once("boot.php");
16
17 function poller_run($argv, $argc){
18         global $a, $db;
19
20         if(is_null($a)) {
21                 $a = new App;
22         }
23
24         if(is_null($db)) {
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);
29         };
30
31         Config::load();
32
33         // Quit when in maintenance
34         if (Config::get('system', 'maintenance', true)) {
35                 return;
36         }
37
38         $a->set_baseurl(Config::get('system', 'url'));
39
40         load_hooks();
41
42         $a->start_process();
43
44         if (poller_max_connections_reached()) {
45                 return;
46         }
47
48         if ($a->maxload_reached()) {
49                 return;
50         }
51
52         if(($argc <= 1) OR ($argv[1] != "no_cron")) {
53                 poller_run_cron();
54         }
55
56         if ($a->max_processes_reached()) {
57                 return;
58         }
59
60         // Checking the number of workers
61         if (poller_too_much_workers()) {
62                 poller_kill_stale_workers();
63                 return;
64         }
65
66         $starttime = time();
67
68         while ($r = poller_worker_process()) {
69
70                 // Count active workers and compare them with a maximum value that depends on the load
71                 if (poller_too_much_workers()) {
72                         return;
73                 }
74
75                 if (!poller_execute($r[0])) {
76                         return;
77                 }
78
79                 // Quit the poller once every hour
80                 if (time() > ($starttime + 3600))
81                         return;
82         }
83
84 }
85
86 /**
87  * @brief Execute a worker entry
88  *
89  * @param array $queue Workerqueue entry
90  *
91  * @return boolean "true" if further processing should be stopped
92  */
93 function poller_execute($queue) {
94
95         $a = get_app();
96
97         $mypid = getmypid();
98
99         // Quit when in maintenance
100         if (Config::get('system', 'maintenance', true)) {
101                 return false;
102         }
103
104         // Constantly check the number of parallel database processes
105         if ($a->max_processes_reached()) {
106                 return false;
107         }
108
109         // Constantly check the number of available database connections to let the frontend be accessible at any time
110         if (poller_max_connections_reached()) {
111                 return false;
112         }
113
114         $upd = q("UPDATE `workerqueue` SET `executed` = '%s', `pid` = %d WHERE `id` = %d AND `pid` = 0",
115                 dbesc(datetime_convert()),
116                 intval($mypid),
117                 intval($queue["id"]));
118
119         if (!$upd) {
120                 logger("Couldn't update queue entry ".$queue["id"]." - skip this execution", LOGGER_DEBUG);
121                 q("COMMIT");
122                 return true;
123         }
124
125         // Assure that there are no tasks executed twice
126         $id = q("SELECT `pid`, `executed` FROM `workerqueue` WHERE `id` = %d", intval($queue["id"]));
127         if (!$id) {
128                 logger("Queue item ".$queue["id"]." vanished - skip this execution", LOGGER_DEBUG);
129                 q("COMMIT");
130                 return true;
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);
133                 q("COMMIT");
134                 return true;
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);
137                 q("COMMIT");
138                 return true;
139         }
140         q("COMMIT");
141
142         $argv = json_decode($queue["parameter"]);
143
144         // Check for existance and validity of the include file
145         $include = $argv[0];
146
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"]));
150                 return true;
151         }
152
153         require_once($include);
154
155         $funcname = str_replace(".php", "", basename($argv[0]))."_run";
156
157         if (function_exists($funcname)) {
158
159                 poller_exec_function($queue, $funcname, $argv);
160
161                 q("DELETE FROM `workerqueue` WHERE `id` = %d", intval($queue["id"]));
162         } else {
163                 logger("Function ".$funcname." does not exist");
164         }
165
166         return true;
167 }
168
169 /**
170  * @brief Execute a function from the queue
171  *
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
175  */
176 function poller_exec_function($queue, $funcname, $argv) {
177
178         $a = get_app();
179
180         $mypid = getmypid();
181
182         $argc = count($argv);
183
184         logger("Process ".$mypid." - Prio ".$queue["priority"]." - ID ".$queue["id"].": ".$funcname." ".$queue["parameter"]);
185
186         $stamp = (float)microtime(true);
187
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();
201         }
202
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);
207
208         $funcname($argv, $argc);
209
210         $a->process_id = $old_process_id;
211
212         $duration = number_format(microtime(true) - $stamp, 3);
213
214         logger("Process ".$mypid." - Prio ".$queue["priority"]." - ID ".$queue["id"].": ".$funcname." - done in ".$duration." seconds.");
215
216         // Write down the performance values into the log
217         if (Config::get("system", "profiler")) {
218                 $duration = microtime(true)-$a->performance["start"];
219
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);
225                                         if ($time > 0)
226                                                 $o .= $func.": ".$time."\n";
227                                 }
228                         }
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);
233                                         if ($time > 0)
234                                                 $o .= $func.": ".$time."\n";
235                                 }
236                         }
237                         if (isset($a->callstack["network"])) {
238                                 $o .= "\nNetwork:\n";
239                                 foreach ($a->callstack["network"] AS $func => $time) {
240                                         $time = round($time, 3);
241                                         if ($time > 0)
242                                                 $o .= $func.": ".$time."\n";
243                                 }
244                         }
245                 } else {
246                         $o = '';
247                 }
248
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)),
256                         LOGGER_DEBUG);
257         }
258
259         $cooldown = Config::get("system", "worker_cooldown", 0);
260
261         if ($cooldown > 0) {
262                 logger("Process ".$mypid." - Prio ".$queue["priority"]." - ID ".$queue["id"].": ".$funcname." - in cooldown for ".$cooldown." seconds");
263                 sleep($cooldown);
264         }
265 }
266
267 /**
268  * @brief Checks if the number of database connections has reached a critical limit.
269  *
270  * @return bool Are more than 3/4 of the maximum connections used?
271  */
272 function poller_max_connections_reached() {
273
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");
276
277         // Fetch the percentage level where the poller will get active
278         $maxlevel = Config::get("system", "max_connections_level", 75);
279
280         if ($max == 0) {
281                 // the maximum number of possible user connections can be a system variable
282                 $r = q("SHOW VARIABLES WHERE `variable_name` = 'max_user_connections'");
283                 if ($r)
284                         $max = $r[0]["Value"];
285
286                 // Or it can be granted. This overrides the system variable
287                 $r = q("SHOW GRANTS");
288                 if ($r)
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))
293                                                 $max = $match[1];
294                         }
295         }
296
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
299         if ($max != 0) {
300                 $r = q("SHOW PROCESSLIST");
301                 if (!dbm::is_result($r))
302                         return false;
303
304                 $used = count($r);
305
306                 logger("Connection usage (user values): ".$used."/".$max, LOGGER_DEBUG);
307
308                 $level = ($used / $max) * 100;
309
310                 if ($level >= $maxlevel) {
311                         logger("Maximum level (".$maxlevel."%) of user connections reached: ".$used."/".$max);
312                         return true;
313                 }
314         }
315
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'");
319         if (!$r)
320                 return false;
321
322         $max = intval($r[0]["Value"]);
323         if ($max == 0)
324                 return false;
325
326         $r = q("SHOW STATUS WHERE `variable_name` = 'Threads_connected'");
327         if (!$r)
328                 return false;
329
330         $used = intval($r[0]["Value"]);
331         if ($used == 0)
332                 return false;
333
334         logger("Connection usage (system values): ".$used."/".$max, LOGGER_DEBUG);
335
336         $level = $used / $max * 100;
337
338         if ($level < $maxlevel)
339                 return false;
340
341         logger("Maximum level (".$level."%) of system connections reached: ".$used."/".$max);
342         return true;
343 }
344
345 /**
346  * @brief fix the queue entry if the worker process died
347  *
348  */
349 function poller_kill_stale_workers() {
350         $r = q("SELECT `pid`, `executed`, `priority`, `parameter` FROM `workerqueue` WHERE `executed` != '0000-00-00 00:00:00'");
351
352         if (!dbm::is_result($r)) {
353                 // No processing here needed
354                 return;
355         }
356
357         foreach($r AS $pid)
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"]));
361                 else {
362                         // Kill long running processes
363
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;
367
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"]];
371
372                         $argv = json_decode($pid["parameter"]);
373                         $argv[0] = basename($argv[0]);
374
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);
380
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"]));
389                         } else
390                                 logger("Worker process ".$pid["pid"]." (".implode(" ", $argv).") now runs for ".round($duration)." of ".$max_duration." allowed minutes. That's okay.", LOGGER_DEBUG);
391                 }
392 }
393
394 /**
395  * @brief Checks if the number of active workers exceeds the given limits
396  *
397  * @return bool Are there too much workers running?
398  */
399 function poller_too_much_workers() {
400         $queues = Config::get("system", "worker_queues", 4);
401
402         $maxqueues = $queues;
403
404         $active = poller_active_workers();
405
406         // Decrease the number of workers at higher load
407         $load = current_load();
408         if($load) {
409                 $maxsysload = intval(Config::get("system", "maxloadavg", 50));
410
411                 $maxworkers = $queues;
412
413                 // Some magical mathemathics to reduce the workers
414                 $exponent = 3;
415                 $slope = $maxworkers / pow($maxsysload, $exponent);
416                 $queues = ceil($slope * pow(max(0, $maxsysload - $load), $exponent));
417
418                 $s = q("SELECT COUNT(*) AS `total` FROM `workerqueue` WHERE `executed` = '0000-00-00 00:00:00'");
419                 $entries = $s[0]["total"];
420
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"];
424
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);
428
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;
432                         }
433                 }
434
435                 // Create a list of queue entries grouped by their priority
436                 $running = array(PRIORITY_CRITICAL => 0,
437                                 PRIORITY_HIGH => 0,
438                                 PRIORITY_MEDIUM => 0,
439                                 PRIORITY_LOW => 0,
440                                 PRIORITY_NEGLIGIBLE => 0);
441
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"];
446
447                 $processlist = "";
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"];
454                         }
455
456                 logger("Load: ".$load."/".$maxsysload." - processes: ".$active."/".$entries." (".$processlist.") - maximum: ".$queues."/".$maxqueues, LOGGER_DEBUG);
457
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");
462                         $a = get_app();
463                         $a->proc_run($args);
464                 }
465         }
466
467         return($active >= $queues);
468 }
469
470 /**
471  * @brief Returns the number of active poller processes
472  *
473  * @return integer Number of active poller processes
474  */
475 function poller_active_workers() {
476         $workers = q("SELECT COUNT(*) AS `processes` FROM `process` WHERE `command` = 'poller.php'");
477
478         return($workers[0]["processes"]);
479 }
480
481 /**
482  * @brief Check if we should pass some slow processes
483  *
484  * When the active processes of the highest priority are using more than 2/3
485  * of all processes, we let pass slower processes.
486  *
487  * @param string $highest_priority Returns the currently highest priority
488  * @return bool We let pass a slower process than $highest_priority
489  */
490 function poller_passing_slow(&$highest_priority) {
491
492         $highest_priority = 0;
493
494         $r = q("SELECT `priority`
495                 FROM `process`
496                 INNER JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid`");
497
498         // No active processes at all? Fine
499         if (!dbm::is_result($r))
500                 return(false);
501
502         $priorities = array();
503         foreach ($r AS $line)
504                 $priorities[] = $line["priority"];
505
506         // Should not happen
507         if (count($priorities) == 0)
508                 return(false);
509
510         $highest_priority = min($priorities);
511
512         // The highest process is already the slowest one?
513         // Then we quit
514         if ($highest_priority == PRIORITY_NEGLIGIBLE)
515                 return(false);
516
517         $high = 0;
518         foreach ($priorities AS $priority)
519                 if ($priority == $highest_priority)
520                         ++$high;
521
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));
524
525         if ($passing_slow)
526                 logger("Passing slower processes than priority ".$highest_priority, LOGGER_DEBUG);
527
528         return($passing_slow);
529 }
530
531 /**
532  * @brief Returns the next worker process
533  *
534  * @return string SQL statement
535  */
536 function poller_worker_process() {
537
538         q("START TRANSACTION;");
539
540         // Check if we should pass some low priority process
541         $highest_priority = 0;
542
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))
549                         return $r;
550
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));
555         }
556
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");
560
561         return $r;
562 }
563
564 /**
565  * @brief Call the front end worker
566  */
567 function call_worker() {
568         if (!Config::get("system", "frontend_worker")) {
569                 return;
570         }
571
572         $url = App::get_baseurl()."/worker";
573         fetch_url($url, false, $redirects, 1);
574 }
575
576 /**
577  * @brief Call the front end worker if there aren't any active
578  */
579 function call_worker_if_idle() {
580         if (!Config::get("system", "frontend_worker")) {
581                 return;
582         }
583
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) {
589                         return;
590                 }
591
592                 set_config("system", "worker_started", time());
593
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();
599
600                         return;
601                 }
602
603                 poller_run_cron();
604
605                 logger('Call poller', LOGGER_DEBUG);
606
607                 $args = array("include/poller.php", "no_cron");
608                 $a = get_app();
609                 $a->proc_run($args);
610                 return;
611         }
612
613         // We cannot execute background processes.
614         // We now run the processes from the frontend.
615         // This won't work with long running processes.
616         poller_run_cron();
617
618         clear_worker_processes();
619
620         $workers = q("SELECT COUNT(*) AS `processes` FROM `process` WHERE `command` = 'worker.php'");
621
622         if ($workers[0]["processes"] == 0) {
623                 call_worker();
624         }
625 }
626
627 /**
628  * @brief Removes long running worker processes
629  */
630 function clear_worker_processes() {
631         $timeout = Config::get("system", "frontend_worker_timeout", 10);
632
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")));
636 }
637
638 /**
639  * @brief Runs the cron processes
640  */
641 function poller_run_cron() {
642         logger('Add cron entries', LOGGER_DEBUG);
643
644         // Check for spooled items
645         proc_run(PRIORITY_HIGH, "include/spool_post.php");
646
647         // Run the cron job that calls all other jobs
648         proc_run(PRIORITY_MEDIUM, "include/cron.php");
649
650         // Run the cronhooks job separately from cron for being able to use a different timing
651         proc_run(PRIORITY_MEDIUM, "include/cronhooks.php");
652
653         // Cleaning dead processes
654         poller_kill_stale_workers();
655 }
656
657 if (array_search(__file__,get_included_files())===0){
658         poller_run($_SERVER["argv"],$_SERVER["argc"]);
659
660         get_app()->end_process();
661
662         killme();
663 }
664 ?>