]> git.mxchange.org Git - friendica.git/blob - include/poller.php
Merge branch 'master' into develop
[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->start_process();
39
40         if (poller_max_connections_reached()) {
41                 return;
42         }
43
44         if ($a->maxload_reached()) {
45                 return;
46         }
47
48         if(($argc <= 1) OR ($argv[1] != "no_cron")) {
49                 poller_run_cron();
50         }
51
52         if ($a->max_processes_reached()) {
53                 return;
54         }
55
56         // Checking the number of workers
57         if (poller_too_much_workers()) {
58                 poller_kill_stale_workers();
59                 return;
60         }
61
62         $starttime = time();
63
64         while ($r = poller_worker_process()) {
65
66                 // Count active workers and compare them with a maximum value that depends on the load
67                 if (poller_too_much_workers()) {
68                         return;
69                 }
70
71                 if (!poller_execute($r[0])) {
72                         return;
73                 }
74
75                 // Quit the poller once every hour
76                 if (time() > ($starttime + 3600))
77                         return;
78         }
79
80 }
81
82 /**
83  * @brief Execute a worker entry
84  *
85  * @param array $queue Workerqueue entry
86  *
87  * @return boolean "true" if further processing should be stopped
88  */
89 function poller_execute($queue) {
90
91         $a = get_app();
92
93         $mypid = getmypid();
94
95         // Quit when in maintenance
96         if (Config::get('system', 'maintenance', true)) {
97                 return false;
98         }
99
100         // Constantly check the number of parallel database processes
101         if ($a->max_processes_reached()) {
102                 return false;
103         }
104
105         // Constantly check the number of available database connections to let the frontend be accessible at any time
106         if (poller_max_connections_reached()) {
107                 return false;
108         }
109
110         $upd = q("UPDATE `workerqueue` SET `executed` = '%s', `pid` = %d WHERE `id` = %d AND `pid` = 0",
111                 dbesc(datetime_convert()),
112                 intval($mypid),
113                 intval($queue["id"]));
114
115         if (!$upd) {
116                 logger("Couldn't update queue entry ".$queue["id"]." - skip this execution", LOGGER_DEBUG);
117                 q("COMMIT");
118                 return true;
119         }
120
121         // Assure that there are no tasks executed twice
122         $id = q("SELECT `pid`, `executed` FROM `workerqueue` WHERE `id` = %d", intval($queue["id"]));
123         if (!$id) {
124                 logger("Queue item ".$queue["id"]." vanished - skip this execution", LOGGER_DEBUG);
125                 q("COMMIT");
126                 return true;
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);
129                 q("COMMIT");
130                 return true;
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);
133                 q("COMMIT");
134                 return true;
135         }
136         q("COMMIT");
137
138         $argv = json_decode($queue["parameter"]);
139
140         // Check for existance and validity of the include file
141         $include = $argv[0];
142
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"]));
146                 return true;
147         }
148
149         require_once($include);
150
151         $funcname = str_replace(".php", "", basename($argv[0]))."_run";
152
153         if (function_exists($funcname)) {
154
155                 poller_exec_function($queue, $funcname, $argv);
156
157                 q("DELETE FROM `workerqueue` WHERE `id` = %d", intval($queue["id"]));
158         } else {
159                 logger("Function ".$funcname." does not exist");
160         }
161
162         return true;
163 }
164
165 /**
166  * @brief Execute a function from the queue
167  *
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
171  */
172 function poller_exec_function($queue, $funcname, $argv) {
173
174         $a = get_app();
175
176         $mypid = getmypid();
177
178         $argc = count($argv);
179
180         logger("Process ".$mypid." - Prio ".$queue["priority"]." - ID ".$queue["id"].": ".$funcname." ".$queue["parameter"]);
181
182         $stamp = (float)microtime(true);
183
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();
197         }
198
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);
203
204         $funcname($argv, $argc);
205
206         $a->process_id = $old_process_id;
207
208         $duration = number_format(microtime(true) - $stamp, 3);
209
210         logger("Process ".$mypid." - Prio ".$queue["priority"]." - ID ".$queue["id"].": ".$funcname." - done in ".$duration." seconds.");
211
212         // Write down the performance values into the log
213         if (Config::get("system", "profiler")) {
214                 $duration = microtime(true)-$a->performance["start"];
215
216                 if (Config::get("rendertime", "callstack")) {
217                         if (isset($a->callstack["database"])) {
218                                 $o = "\nDatabase Read:\n";
219                                 foreach ($a->callstack["database"] AS $func => $time) {
220                                         $time = round($time, 3);
221                                         if ($time > 0)
222                                                 $o .= $func.": ".$time."\n";
223                                 }
224                         }
225                         if (isset($a->callstack["database_write"])) {
226                                 $o .= "\nDatabase Write:\n";
227                                 foreach ($a->callstack["database_write"] AS $func => $time) {
228                                         $time = round($time, 3);
229                                         if ($time > 0)
230                                                 $o .= $func.": ".$time."\n";
231                                 }
232                         }
233                         if (isset($a->callstack["network"])) {
234                                 $o .= "\nNetwork:\n";
235                                 foreach ($a->callstack["network"] AS $func => $time) {
236                                         $time = round($time, 3);
237                                         if ($time > 0)
238                                                 $o .= $func.": ".$time."\n";
239                                 }
240                         }
241                 } else {
242                         $o = '';
243                 }
244
245                 logger("ID ".$queue["id"].": ".$funcname.": ".sprintf("DB: %s/%s, Net: %s, I/O: %s, Other: %s, Total: %s".$o,
246                         number_format($a->performance["database"] - $a->performance["database_write"], 2),
247                         number_format($a->performance["database_write"], 2),
248                         number_format($a->performance["network"], 2),
249                         number_format($a->performance["file"], 2),
250                         number_format($duration - ($a->performance["database"] + $a->performance["network"] + $a->performance["file"]), 2),
251                         number_format($duration, 2)),
252                         LOGGER_DEBUG);
253         }
254
255         $cooldown = Config::get("system", "worker_cooldown", 0);
256
257         if ($cooldown > 0) {
258                 logger("Process ".$mypid." - Prio ".$queue["priority"]." - ID ".$queue["id"].": ".$funcname." - in cooldown for ".$cooldown." seconds");
259                 sleep($cooldown);
260         }
261 }
262
263 /**
264  * @brief Checks if the number of database connections has reached a critical limit.
265  *
266  * @return bool Are more than 3/4 of the maximum connections used?
267  */
268 function poller_max_connections_reached() {
269
270         // Fetch the max value from the config. This is needed when the system cannot detect the correct value by itself.
271         $max = Config::get("system", "max_connections");
272
273         // Fetch the percentage level where the poller will get active
274         $maxlevel = Config::get("system", "max_connections_level", 75);
275
276         if ($max == 0) {
277                 // the maximum number of possible user connections can be a system variable
278                 $r = q("SHOW VARIABLES WHERE `variable_name` = 'max_user_connections'");
279                 if ($r)
280                         $max = $r[0]["Value"];
281
282                 // Or it can be granted. This overrides the system variable
283                 $r = q("SHOW GRANTS");
284                 if ($r)
285                         foreach ($r AS $grants) {
286                                 $grant = array_pop($grants);
287                                 if (stristr($grant, "GRANT USAGE ON"))
288                                         if (preg_match("/WITH MAX_USER_CONNECTIONS (\d*)/", $grant, $match))
289                                                 $max = $match[1];
290                         }
291         }
292
293         // If $max is set we will use the processlist to determine the current number of connections
294         // The processlist only shows entries of the current user
295         if ($max != 0) {
296                 $r = q("SHOW PROCESSLIST");
297                 if (!dbm::is_result($r))
298                         return false;
299
300                 $used = count($r);
301
302                 logger("Connection usage (user values): ".$used."/".$max, LOGGER_DEBUG);
303
304                 $level = ($used / $max) * 100;
305
306                 if ($level >= $maxlevel) {
307                         logger("Maximum level (".$maxlevel."%) of user connections reached: ".$used."/".$max);
308                         return true;
309                 }
310         }
311
312         // We will now check for the system values.
313         // This limit could be reached although the user limits are fine.
314         $r = q("SHOW VARIABLES WHERE `variable_name` = 'max_connections'");
315         if (!$r)
316                 return false;
317
318         $max = intval($r[0]["Value"]);
319         if ($max == 0)
320                 return false;
321
322         $r = q("SHOW STATUS WHERE `variable_name` = 'Threads_connected'");
323         if (!$r)
324                 return false;
325
326         $used = intval($r[0]["Value"]);
327         if ($used == 0)
328                 return false;
329
330         logger("Connection usage (system values): ".$used."/".$max, LOGGER_DEBUG);
331
332         $level = $used / $max * 100;
333
334         if ($level < $maxlevel)
335                 return false;
336
337         logger("Maximum level (".$level."%) of system connections reached: ".$used."/".$max);
338         return true;
339 }
340
341 /**
342  * @brief fix the queue entry if the worker process died
343  *
344  */
345 function poller_kill_stale_workers() {
346         $r = q("SELECT `pid`, `executed`, `priority`, `parameter` FROM `workerqueue` WHERE `executed` != '0000-00-00 00:00:00'");
347
348         if (!dbm::is_result($r)) {
349                 // No processing here needed
350                 return;
351         }
352
353         foreach($r AS $pid)
354                 if (!posix_kill($pid["pid"], 0))
355                         q("UPDATE `workerqueue` SET `executed` = '0000-00-00 00:00:00', `pid` = 0 WHERE `pid` = %d",
356                                 intval($pid["pid"]));
357                 else {
358                         // Kill long running processes
359
360                         // Check if the priority is in a valid range
361                         if (!in_array($pid["priority"], array(PRIORITY_CRITICAL, PRIORITY_HIGH, PRIORITY_MEDIUM, PRIORITY_LOW, PRIORITY_NEGLIGIBLE)))
362                                 $pid["priority"] = PRIORITY_MEDIUM;
363
364                         // Define the maximum durations
365                         $max_duration_defaults = array(PRIORITY_CRITICAL => 360, PRIORITY_HIGH => 10, PRIORITY_MEDIUM => 60, PRIORITY_LOW => 180, PRIORITY_NEGLIGIBLE => 360);
366                         $max_duration = $max_duration_defaults[$pid["priority"]];
367
368                         $argv = json_decode($pid["parameter"]);
369                         $argv[0] = basename($argv[0]);
370
371                         // How long is the process already running?
372                         $duration = (time() - strtotime($pid["executed"])) / 60;
373                         if ($duration > $max_duration) {
374                                 logger("Worker process ".$pid["pid"]." (".implode(" ", $argv).") took more than ".$max_duration." minutes. It will be killed now.");
375                                 posix_kill($pid["pid"], SIGTERM);
376
377                                 // We killed the stale process.
378                                 // To avoid a blocking situation we reschedule the process at the beginning of the queue.
379                                 // Additionally we are lowering the priority.
380                                 q("UPDATE `workerqueue` SET `executed` = '0000-00-00 00:00:00', `created` = '%s',
381                                                         `priority` = %d, `pid` = 0 WHERE `pid` = %d",
382                                         dbesc(datetime_convert()),
383                                         intval(PRIORITY_NEGLIGIBLE),
384                                         intval($pid["pid"]));
385                         } else
386                                 logger("Worker process ".$pid["pid"]." (".implode(" ", $argv).") now runs for ".round($duration)." of ".$max_duration." allowed minutes. That's okay.", LOGGER_DEBUG);
387                 }
388 }
389
390 /**
391  * @brief Checks if the number of active workers exceeds the given limits
392  *
393  * @return bool Are there too much workers running?
394  */
395 function poller_too_much_workers() {
396         $queues = Config::get("system", "worker_queues", 4);
397
398         $maxqueues = $queues;
399
400         $active = poller_active_workers();
401
402         // Decrease the number of workers at higher load
403         $load = current_load();
404         if($load) {
405                 $maxsysload = intval(Config::get("system", "maxloadavg", 50));
406
407                 $maxworkers = $queues;
408
409                 // Some magical mathemathics to reduce the workers
410                 $exponent = 3;
411                 $slope = $maxworkers / pow($maxsysload, $exponent);
412                 $queues = ceil($slope * pow(max(0, $maxsysload - $load), $exponent));
413
414                 $s = q("SELECT COUNT(*) AS `total` FROM `workerqueue` WHERE `executed` = '0000-00-00 00:00:00'");
415                 $entries = $s[0]["total"];
416
417                 if (Config::get("system", "worker_fastlane", false) AND ($queues > 0) AND ($entries > 0) AND ($active >= $queues)) {
418                         $s = q("SELECT `priority` FROM `workerqueue` WHERE `executed` = '0000-00-00 00:00:00' ORDER BY `priority` LIMIT 1");
419                         $top_priority = $s[0]["priority"];
420
421                         $s = q("SELECT `id` FROM `workerqueue` WHERE `priority` <= %d AND `executed` != '0000-00-00 00:00:00' LIMIT 1",
422                                 intval($top_priority));
423                         $high_running = dbm::is_result($s);
424
425                         if (!$high_running AND ($top_priority > PRIORITY_UNDEFINED) AND ($top_priority < PRIORITY_NEGLIGIBLE)) {
426                                 logger("There are jobs with priority ".$top_priority." waiting but none is executed. Open a fastlane.", LOGGER_DEBUG);
427                                 $queues = $active + 1;
428                         }
429                 }
430
431                 // Create a list of queue entries grouped by their priority
432                 $running = array(PRIORITY_CRITICAL => 0,
433                                 PRIORITY_HIGH => 0,
434                                 PRIORITY_MEDIUM => 0,
435                                 PRIORITY_LOW => 0,
436                                 PRIORITY_NEGLIGIBLE => 0);
437
438                 $r = q("SELECT COUNT(*) AS `running`, `priority` FROM `process` INNER JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid` GROUP BY `priority`");
439                 if (dbm::is_result($r))
440                         foreach ($r AS $process)
441                                 $running[$process["priority"]] = $process["running"];
442
443                 $processlist = "";
444                 $r = q("SELECT COUNT(*) AS `entries`, `priority` FROM `workerqueue` GROUP BY `priority`");
445                 if (dbm::is_result($r))
446                         foreach ($r as $entry) {
447                                 if ($processlist != "")
448                                         $processlist .= ", ";
449                                 $processlist .= $entry["priority"].":".$running[$entry["priority"]]."/".$entry["entries"];
450                         }
451
452                 logger("Load: ".$load."/".$maxsysload." - processes: ".$active."/".$entries." (".$processlist.") - maximum: ".$queues."/".$maxqueues, LOGGER_DEBUG);
453
454                 // Are there fewer workers running as possible? Then fork a new one.
455                 if (!Config::get("system", "worker_dont_fork") AND ($queues > ($active + 1)) AND ($entries > 1)) {
456                         logger("Active workers: ".$active."/".$queues." Fork a new worker.", LOGGER_DEBUG);
457                         $args = array("php", "include/poller.php", "no_cron");
458                         $a = get_app();
459                         $a->proc_run($args);
460                 }
461         }
462
463         return($active >= $queues);
464 }
465
466 /**
467  * @brief Returns the number of active poller processes
468  *
469  * @return integer Number of active poller processes
470  */
471 function poller_active_workers() {
472         $workers = q("SELECT COUNT(*) AS `processes` FROM `process` WHERE `command` = 'poller.php'");
473
474         return($workers[0]["processes"]);
475 }
476
477 /**
478  * @brief Check if we should pass some slow processes
479  *
480  * When the active processes of the highest priority are using more than 2/3
481  * of all processes, we let pass slower processes.
482  *
483  * @param string $highest_priority Returns the currently highest priority
484  * @return bool We let pass a slower process than $highest_priority
485  */
486 function poller_passing_slow(&$highest_priority) {
487
488         $highest_priority = 0;
489
490         $r = q("SELECT `priority`
491                 FROM `process`
492                 INNER JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid`");
493
494         // No active processes at all? Fine
495         if (!dbm::is_result($r))
496                 return(false);
497
498         $priorities = array();
499         foreach ($r AS $line)
500                 $priorities[] = $line["priority"];
501
502         // Should not happen
503         if (count($priorities) == 0)
504                 return(false);
505
506         $highest_priority = min($priorities);
507
508         // The highest process is already the slowest one?
509         // Then we quit
510         if ($highest_priority == PRIORITY_NEGLIGIBLE)
511                 return(false);
512
513         $high = 0;
514         foreach ($priorities AS $priority)
515                 if ($priority == $highest_priority)
516                         ++$high;
517
518         logger("Highest priority: ".$highest_priority." Total processes: ".count($priorities)." Count high priority processes: ".$high, LOGGER_DEBUG);
519         $passing_slow = (($high/count($priorities)) > (2/3));
520
521         if ($passing_slow)
522                 logger("Passing slower processes than priority ".$highest_priority, LOGGER_DEBUG);
523
524         return($passing_slow);
525 }
526
527 /**
528  * @brief Returns the next worker process
529  *
530  * @return string SQL statement
531  */
532 function poller_worker_process() {
533
534         q("START TRANSACTION;");
535
536         // Check if we should pass some low priority process
537         $highest_priority = 0;
538
539         if (poller_passing_slow($highest_priority)) {
540                 // Are there waiting processes with a higher priority than the currently highest?
541                 $r = q("SELECT * FROM `workerqueue`
542                                 WHERE `executed` = '0000-00-00 00:00:00' AND `priority` < %d
543                                 ORDER BY `priority`, `created` LIMIT 1", dbesc($highest_priority));
544                 if (dbm::is_result($r))
545                         return $r;
546
547                 // Give slower processes some processing time
548                 $r = q("SELECT * FROM `workerqueue`
549                                 WHERE `executed` = '0000-00-00 00:00:00' AND `priority` > %d
550                                 ORDER BY `priority`, `created` LIMIT 1", dbesc($highest_priority));
551         }
552
553         // If there is no result (or we shouldn't pass lower processes) we check without priority limit
554         if (($highest_priority == 0) OR !dbm::is_result($r))
555                 $r = q("SELECT * FROM `workerqueue` WHERE `executed` = '0000-00-00 00:00:00' ORDER BY `priority`, `created` LIMIT 1");
556
557         return $r;
558 }
559
560 /**
561  * @brief Call the front end worker
562  */
563 function call_worker() {
564         if (!Config::get("system", "frontend_worker") OR !Config::get("system", "worker")) {
565                 return;
566         }
567
568         $url = App::get_baseurl()."/worker";
569         fetch_url($url, false, $redirects, 1);
570 }
571
572 /**
573  * @brief Call the front end worker if there aren't any active
574  */
575 function call_worker_if_idle() {
576         if (!Config::get("system", "frontend_worker") OR !Config::get("system", "worker")) {
577                 return;
578         }
579
580         // Do we have "proc_open"? Then we can fork the poller
581         if (function_exists("proc_open")) {
582                 // When was the last time that we called the worker?
583                 // Less than one minute? Then we quit
584                 if ((time() - Config::get("system", "worker_started")) < 60) {
585                         return;
586                 }
587
588                 set_config("system", "worker_started", time());
589
590                 // Do we have enough running workers? Then we quit here.
591                 if (poller_too_much_workers()) {
592                         // Cleaning dead processes
593                         poller_kill_stale_workers();
594                         get_app()->remove_inactive_processes();
595
596                         return;
597                 }
598
599                 poller_run_cron();
600
601                 logger('Call poller', LOGGER_DEBUG);
602
603                 $args = array("php", "include/poller.php", "no_cron");
604                 $a = get_app();
605                 $a->proc_run($args);
606                 return;
607         }
608
609         // We cannot execute background processes.
610         // We now run the processes from the frontend.
611         // This won't work with long running processes.
612         poller_run_cron();
613
614         clear_worker_processes();
615
616         $workers = q("SELECT COUNT(*) AS `processes` FROM `process` WHERE `command` = 'worker.php'");
617
618         if ($workers[0]["processes"] == 0) {
619                 call_worker();
620         }
621 }
622
623 /**
624  * @brief Removes long running worker processes
625  */
626 function clear_worker_processes() {
627         $timeout = Config::get("system", "frontend_worker_timeout", 10);
628
629         /// @todo We should clean up the corresponding workerqueue entries as well
630         q("DELETE FROM `process` WHERE `created` < '%s' AND `command` = 'worker.php'",
631                 dbesc(datetime_convert('UTC','UTC',"now - ".$timeout." minutes")));
632 }
633
634 /**
635  * @brief Runs the cron processes
636  */
637 function poller_run_cron() {
638         logger('Add cron entries', LOGGER_DEBUG);
639
640         // Check for spooled items
641         proc_run(PRIORITY_HIGH, "include/spool_post.php");
642
643         // Run the cron job that calls all other jobs
644         proc_run(PRIORITY_MEDIUM, "include/cron.php");
645
646         // Run the cronhooks job separately from cron for being able to use a different timing
647         proc_run(PRIORITY_MEDIUM, "include/cronhooks.php");
648
649         // Cleaning dead processes
650         poller_kill_stale_workers();
651 }
652
653 if (array_search(__file__,get_included_files())===0){
654         poller_run($_SERVER["argv"],$_SERVER["argc"]);
655
656         get_app()->end_process();
657
658         killme();
659 }
660 ?>