]> git.mxchange.org Git - friendica.git/blobdiff - src/Core/Worker.php
Merge pull request #10557 from annando/delayed
[friendica.git] / src / Core / Worker.php
index a0e444642f29021d5f33a06ec5ae995572814054..307451c05205eb7f811bccf4bcab7f160776dda9 100644 (file)
@@ -1,6 +1,6 @@
 <?php
 /**
- * @copyright Copyright (C) 2020, Friendica
+ * @copyright Copyright (C) 2010-2021, the Friendica project
  *
  * @license GNU AGPL version 3 or any later version
  *
@@ -50,6 +50,7 @@ class Worker
        private static $lock_duration = 0;
        private static $last_update;
        private static $state;
+       private static $daemon_mode = null;
 
        /**
         * Processes the tasks that are in the workerqueue table
@@ -96,6 +97,10 @@ class Worker
 
                // We fetch the next queue entry that is about to be executed
                while ($r = self::workerProcess()) {
+                       if (self::IPCJobsExists(getmypid())) {
+                               self::IPCDeleteJobState(getmypid());
+                       }
+
                        // Don't refetch when a worker fetches tasks for multiple workers
                        $refetched = DI::config()->get('system', 'worker_multiple_fetch');
                        foreach ($r as $entry) {
@@ -146,13 +151,17 @@ class Worker
                        if (time() > ($starttime + (DI::config()->get('system', 'cron_interval') * 60))) {
                                Logger::info('Process lifetime reached, respawning.');
                                self::unclaimProcess();
-                               self::spawnWorker();
+                               if (self::isDaemonMode()) {
+                                       self::IPCSetJobState(true);
+                               } else {
+                                       self::spawnWorker();
+                               }
                                return;
                        }
                }
 
                // Cleaning up. Possibly not needed, but it doesn't harm anything.
-               if (DI::config()->get('system', 'worker_daemon_mode', false)) {
+               if (self::isDaemonMode()) {
                        self::IPCSetJobState(false);
                }
                Logger::info("Couldn't select a workerqueue entry, quitting process", ['pid' => getmypid()]);
@@ -190,7 +199,7 @@ class Worker
                        Logger::warning('Maximum processes reached, quitting.');
                        return false;
                }
-               
+
                return true;
        }
 
@@ -302,6 +311,10 @@ class Worker
                }
 
                $argv = json_decode($queue['parameter'], true);
+               if (!is_array($argv)) {
+                       $argv = [];
+               }
+
                if (!empty($queue['command'])) {
                        array_unshift($argv, $queue['command']);
                }
@@ -412,6 +425,12 @@ class Worker
        {
                $a = DI::app();
 
+               $cooldown = DI::config()->get("system", "worker_cooldown", 0);
+               if ($cooldown > 0) {
+                       Logger::info('Pre execution cooldown.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'cooldown' => $cooldown]);
+                       sleep($cooldown);
+               }
+
                Logger::enableWorker($funcname);
 
                Logger::info("Process start.", ['priority' => $queue["priority"], 'id' => $queue["id"]]);
@@ -427,7 +446,7 @@ class Worker
                        $queue['priority'] = PRIORITY_MEDIUM;
                }
 
-               $a->queue = $queue;
+               $a->setQueue($queue);
 
                $up_duration = microtime(true) - self::$up_start;
 
@@ -443,7 +462,7 @@ class Worker
 
                Logger::disableWorker();
 
-               unset($a->queue);
+               $a->setQueue([]);
 
                $duration = (microtime(true) - $stamp);
 
@@ -484,10 +503,8 @@ class Worker
 
                DI::profiler()->saveLog(DI::logger(), "ID " . $queue["id"] . ": " . $funcname);
 
-               $cooldown = DI::config()->get("system", "worker_cooldown", 0);
-
                if ($cooldown > 0) {
-                       Logger::info('Cooldown.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'cooldown' => $cooldown]);
+                       Logger::info('Post execution cooldown.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'cooldown' => $cooldown]);
                        sleep($cooldown);
                }
        }
@@ -771,7 +788,7 @@ class Worker
                        // Are there fewer workers running as possible? Then fork a new one.
                        if (!DI::config()->get("system", "worker_dont_fork", false) && ($queues > ($active + 1)) && self::entriesExists()) {
                                Logger::info("There are fewer workers as possible, fork a new worker.", ['active' => $active, 'queues' => $queues]);
-                               if (DI::config()->get('system', 'worker_daemon_mode', false)) {
+                               if (self::isDaemonMode()) {
                                        self::IPCSetJobState(true);
                                } else {
                                        self::spawnWorker();
@@ -780,7 +797,7 @@ class Worker
                }
 
                // if there are too much worker, we don't spawn a new one.
-               if (DI::config()->get('system', 'worker_daemon_mode', false) && ($active > $queues)) {
+               if (self::isDaemonMode() && ($active > $queues)) {
                        self::IPCSetJobState(false);
                }
 
@@ -814,7 +831,7 @@ class Worker
                $stamp = (float)microtime(true);
 
                $queues = DBA::p("SELECT `process`.`pid`, COUNT(`workerqueue`.`pid`) AS `entries` FROM `process`
-                       LEFT JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid` AND NOT `workerqueue`.`done` 
+                       LEFT JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid` AND NOT `workerqueue`.`done`
                        GROUP BY `process`.`pid`");
                while ($queue = DBA::fetch($queues)) {
                        $ids[$queue['pid']] = $queue['entries'];
@@ -1100,6 +1117,11 @@ class Worker
         */
        private static function forkProcess(bool $do_cron)
        {
+               if (DI::process()->isMinMemoryReached()) {
+                       Logger::warning('Memory limit reached - quitting');
+                       return;
+               }
+
                // Children inherit their parent's database connection.
                // To avoid problems we disconnect and connect both parent and child
                DBA::disconnect();
@@ -1111,22 +1133,40 @@ class Worker
                } elseif ($pid) {
                        // The parent process continues here
                        DBA::connect();
-                       Logger::info('Spawned new worker', ['cron' => $do_cron, 'pid' => $pid]);
+
+                       self::IPCSetJobState(true, $pid);
+                       Logger::info('Spawned new worker', ['pid' => $pid]);
+
+                       $cycles = 0;
+                       while (self::IPCJobsExists($pid) && (++$cycles < 100)) {
+                               usleep(10000);
+                       }
+
+                       Logger::info('Spawned worker is ready', ['pid' => $pid, 'wait_cycles' => $cycles]);
                        return;
                }
-       
+
                // We now are in the new worker
+               $pid = getmypid();
+
                DBA::connect();
-               Logger::info('Worker spawned', ['cron' => $do_cron, 'pid' => getmypid()]);
+               /// @todo Reinitialize the logger to set a new process_id and uid
+               DI::process()->setPid($pid);
 
-               DI::process()->start();
+               $cycles = 0;
+               while (!self::IPCJobsExists($pid) && (++$cycles < 100)) {
+                       usleep(10000);
+               }
+
+               Logger::info('Worker spawned', ['pid' => $pid, 'wait_cycles' => $cycles]);
 
                self::processQueue($do_cron);
 
                self::unclaimProcess();
 
+               self::IPCSetJobState(false, $pid);
                DI::process()->end();
-               Logger::info('Worker ended', ['cron' => $do_cron, 'pid' => getmypid()]);
+               Logger::info('Worker ended', ['pid' => $pid]);
                exit();
        }
 
@@ -1139,18 +1179,14 @@ class Worker
         */
        public static function spawnWorker($do_cron = false)
        {
-               // Worker and daemon are started from the command line.
-               // This means that this is executed by a PHP interpreter without runtime limitations
-               if (function_exists('pcntl_fork') && in_array(DI::mode()->getExecutor(), [Mode::DAEMON, Mode::WORKER])) {
+               if (self::isDaemonMode() && DI::config()->get('system', 'worker_fork')) {
                        self::forkProcess($do_cron);
                } else {
                        $process = new Core\Process(DI::logger(), DI::mode(), DI::config(),
                                DI::modelProcess(), DI::app()->getBasePath(), getmypid());
                        $process->run('bin/worker.php', ['no_cron' => !$do_cron]);
                }
-
-               // after spawning we have to remove the flag.
-               if (DI::config()->get('system', 'worker_daemon_mode', false)) {
+               if (self::isDaemonMode()) {
                        self::IPCSetJobState(false);
                }
        }
@@ -1164,7 +1200,7 @@ class Worker
         * or: Worker::add(PRIORITY_HIGH, "Notifier", Delivery::DELETION, $drop_id);
         * or: Worker::add(array('priority' => PRIORITY_HIGH, 'dont_fork' => true), "Delivery", $post_id);
         *
-        * @return boolean "false" if worker queue entry already existed or there had been an error
+        * @return int "0" if worker queue entry already existed or there had been an error, otherwise the ID of the worker task
         * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         * @note $cmd and string args are surrounded with ""
         *
@@ -1177,14 +1213,14 @@ class Worker
                $args = func_get_args();
 
                if (!count($args)) {
-                       return false;
+                       return 0;
                }
 
                $arr = ['args' => $args, 'run_cmd' => true];
 
                Hook::callAll("proc_run", $arr);
                if (!$arr['run_cmd'] || !count($args)) {
-                       return true;
+                       return 1;
                }
 
                $priority = PRIORITY_MEDIUM;
@@ -1219,7 +1255,7 @@ class Worker
                $command = array_shift($args);
                $parameters = json_encode($args);
                $found = DBA::exists('workerqueue', ['command' => $command, 'parameter' => $parameters, 'done' => false]);
-               $added = false;
+               $added = 0;
 
                if (!in_array($priority, PRIORITIES)) {
                        Logger::warning('Invalid priority', ['priority' => $priority, 'command' => $command, 'callstack' => System::callstack(20)]);
@@ -1228,21 +1264,21 @@ class Worker
 
                // Quit if there was a database error - a precaution for the update process to 3.5.3
                if (DBA::errorNo() != 0) {
-                       return false;
+                       return 0;
                }
 
                if (!$found) {
-                       $added = DBA::insert('workerqueue', ['command' => $command, 'parameter' => $parameters, 'created' => $created,
-                               'priority' => $priority, 'next_try' => $delayed]);
-                       if (!$added) {
-                               return false;
+                       if (!DBA::insert('workerqueue', ['command' => $command, 'parameter' => $parameters, 'created' => $created,
+                               'priority' => $priority, 'next_try' => $delayed])) {
+                               return 0;
                        }
+                       $added = DBA::lastInsertId();
                } elseif ($force_priority) {
                        DBA::update('workerqueue', ['priority' => $priority], ['command' => $command, 'parameter' => $parameters, 'done' => false, 'pid' => 0]);
                }
 
                // Set the IPC flag to ensure an immediate process execution via daemon
-               if (DI::config()->get('system', 'worker_daemon_mode', false)) {
+               if (self::isDaemonMode()) {
                        self::IPCSetJobState(true);
                }
 
@@ -1267,7 +1303,7 @@ class Worker
                }
 
                // Quit on daemon mode
-               if (DI::config()->get('system', 'worker_daemon_mode', false)) {
+               if (self::isDaemonMode()) {
                        return $added;
                }
 
@@ -1315,12 +1351,12 @@ class Worker
         */
        public static function defer()
        {
-               if (empty(DI::app()->queue)) {
+               $queue = DI::app()->getQueue();
+
+               if (empty($queue)) {
                        return false;
                }
 
-               $queue = DI::app()->queue;
-
                $retrial = $queue['retrial'];
                $id = $queue['id'];
                $priority = $queue['priority'];
@@ -1361,12 +1397,27 @@ class Worker
         * Set the flag if some job is waiting
         *
         * @param boolean $jobs Is there a waiting job?
+        * @param int $key Key number
         * @throws \Exception
         */
-       public static function IPCSetJobState($jobs)
+       public static function IPCSetJobState(bool $jobs, int $key = 0)
        {
                $stamp = (float)microtime(true);
-               DBA::update('worker-ipc', ['jobs' => $jobs], ['key' => 1], true);
+               DBA::replace('worker-ipc', ['jobs' => $jobs, 'key' => $key]);
+               self::$db_duration += (microtime(true) - $stamp);
+               self::$db_duration_write += (microtime(true) - $stamp);
+       }
+
+       /**
+        * Delete a key entry
+        *
+        * @param int $key Key number
+        * @throws \Exception
+        */
+       public static function IPCDeleteJobState(int $key)
+       {
+               $stamp = (float)microtime(true);
+               DBA::delete('worker-ipc', ['key' => $key]);
                self::$db_duration += (microtime(true) - $stamp);
                self::$db_duration_write += (microtime(true) - $stamp);
        }
@@ -1374,13 +1425,14 @@ class Worker
        /**
         * Checks if some worker job waits to be executed
         *
+        * @param int $key Key number
         * @return bool
         * @throws \Exception
         */
-       public static function IPCJobsExists()
+       public static function IPCJobsExists(int $key = 0)
        {
                $stamp = (float)microtime(true);
-               $row = DBA::selectFirst('worker-ipc', ['jobs'], ['key' => 1]);
+               $row = DBA::selectFirst('worker-ipc', ['jobs'], ['key' => $key]);
                self::$db_duration += (microtime(true) - $stamp);
 
                // When we don't have a row, no job is running
@@ -1391,6 +1443,51 @@ class Worker
                return (bool)$row['jobs'];
        }
 
+       /**
+        * Checks if the worker is running in the daemon mode.
+        *
+        * @return boolean
+        */
+       public static function isDaemonMode()
+       {
+               if (!is_null(self::$daemon_mode)) {
+                       return self::$daemon_mode;
+               }
+
+               if (DI::mode()->getExecutor() == Mode::DAEMON) {
+                       return true;
+               }
+
+               $daemon_mode = DI::config()->get('system', 'worker_daemon_mode', false, true);
+               if ($daemon_mode) {
+                       return $daemon_mode;
+               }
+
+               if (!function_exists('pcntl_fork')) {
+                       self::$daemon_mode = false;
+                       return false;
+               }
+
+               $pidfile = DI::config()->get('system', 'pidfile');
+               if (empty($pidfile)) {
+                       // No pid file, no daemon
+                       self::$daemon_mode = false;
+                       return false;
+               }
+
+               if (!is_readable($pidfile)) {
+                       // No pid file. We assume that the daemon had been intentionally stopped.
+                       self::$daemon_mode = false;
+                       return false;
+               }
+
+               $pid = intval(file_get_contents($pidfile));
+               $running = posix_kill($pid, 0);
+
+               self::$daemon_mode = $running;
+               return $running;
+       }
+
        /**
         * Test if the daemon is running. If not, it will be started
         *
@@ -1490,7 +1587,7 @@ class Worker
                } else {
                        Logger::info('We are outside the maintenance window', ['current' => date('H:i:s', $current), 'start' => date('H:i:s', $start), 'end' => date('H:i:s', $end)]);
                }
-               
+
                return $execute;
        }
 }