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