]> git.mxchange.org Git - friendica.git/blobdiff - src/Core/Worker.php
Merge remote-tracking branch 'upstream/2019.03-RC' into worker2
[friendica.git] / src / Core / Worker.php
index 4007a7923cae2dda94ec8f3af051ebc1551b4e27..b0b9fc2cf2d9f3d00a509e17b269cc6befa53797 100644 (file)
@@ -8,6 +8,7 @@ use Friendica\BaseObject;
 use Friendica\Database\DBA;
 use Friendica\Model\Process;
 use Friendica\Util\DateTimeFormat;
+use Friendica\Util\Logger\WorkerLogger;
 use Friendica\Util\Network;
 
 /**
@@ -28,6 +29,7 @@ class Worker
        private static $db_duration_stat = 0;
        private static $lock_duration = 0;
        private static $last_update;
+       private static $mode = 0;
 
        /**
         * @brief Processes the tasks that are in the workerqueue table
@@ -91,16 +93,10 @@ class Worker
                }
 
                $starttime = time();
-
-               $entries = 0;
-               $deferred = 0;
+               self::$mode = 1;
 
                // We fetch the next queue entry that is about to be executed
-               while ($r = self::workerProcess($passing_slow, $entries, $deferred)) {
-                       // When we are processing jobs with a lower priority, we don't refetch new jobs
-                       // Otherwise fast jobs could wait behind slow ones and could be blocked.
-                       $refetched = $passing_slow;
-
+               while ($r = self::workerProcess()) {
                        foreach ($r as $entry) {
                                // Assure that the priority is an integer value
                                $entry['priority'] = (int)$entry['priority'];
@@ -112,20 +108,25 @@ class Worker
                                }
 
                                // If possible we will fetch new jobs for this worker
-                               if (!$refetched) {
-                                       $entries = self::totalEntries();
-                                       $deferred = self::deferredEntries();
-                                       if (Lock::acquire('worker_process', 0)) {
-                                               $refetched = self::findWorkerProcesses($passing_slow, $entries, $deferred);
-                                               Lock::release('worker_process');
-                                       }
+                               if (!self::getWaitingJobForPID() && Lock::acquire('worker_process', 0)) {
+                                       self::findWorkerProcesses();
+                                       Lock::release('worker_process');
+                                       self::$mode = 3;
                                }
                        }
 
+                       self::$mode = 4;
+
+                       // Quit the worker once every cron interval
+                       if (time() > ($starttime + Config::get('system', 'cron_interval'))) {
+                               Logger::log('Process lifetime reached, quitting.', Logger::DEBUG);
+                               return;
+                       }
+
                        // To avoid the quitting of multiple workers only one worker at a time will execute the check
                        if (Lock::acquire('worker', 0)) {
                                // Count active workers and compare them with a maximum value that depends on the load
-                               if (self::tooMuchWorkers($entries, $deferred)) {
+                               if (self::tooMuchWorkers()) {
                                        Logger::log('Active worker limit reached, quitting.', Logger::DEBUG);
                                        Lock::release('worker');
                                        return;
@@ -139,12 +140,6 @@ class Worker
                                }
                                Lock::release('worker');
                        }
-
-                       // Quit the worker once every 5 minutes
-                       if (time() > ($starttime + 300)) {
-                               Logger::log('Process lifetime reached, quitting.', Logger::DEBUG);
-                               return;
-                       }
                }
 
                // Cleaning up. Possibly not needed, but it doesn't harm anything.
@@ -366,15 +361,12 @@ class Worker
        {
                $a = \get_app();
 
-               $mypid = getmypid();
-
                $argc = count($argv);
 
-               // Currently deactivated, since the new logger doesn't support this
-               //$new_process_id = System::processID("wrk");
-               $new_process_id = '';
+               $logger = $a->getLogger();
+               $workerLogger = new WorkerLogger($logger, $funcname);
 
-               Logger::log("Process ".$mypid." - Prio ".$queue["priority"]." - ID ".$queue["id"].": ".$funcname." ".$queue["parameter"]." - Process PID: ".$new_process_id);
+               $workerLogger ->info("Process start.", ['priority' => $queue["priority"], 'id' => $queue["id"]]);
 
                $stamp = (float)microtime(true);
 
@@ -382,10 +374,6 @@ class Worker
                // For this reason the variables have to be initialized.
                $a->getProfiler()->reset();
 
-               // For better logging create a new process id for every worker call
-               // But preserve the old one for the worker
-               $old_process_id = $a->process_id;
-               $a->process_id = $new_process_id;
                $a->queue = $queue;
 
                $up_duration = microtime(true) - self::$up_start;
@@ -393,13 +381,15 @@ class Worker
                // Reset global data to avoid interferences
                unset($_SESSION);
 
+               // Set the workerLogger as new default logger
+               Logger::init($workerLogger);
                if ($method_call) {
                        call_user_func_array(sprintf('Friendica\Worker\%s::execute', $funcname), $argv);
                } else {
                        $funcname($argv, $argc);
                }
+               Logger::init($logger);
 
-               $a->process_id = $old_process_id;
                unset($a->queue);
 
                $duration = (microtime(true) - $stamp);
@@ -409,16 +399,16 @@ class Worker
                 * The execution time is the productive time.
                 * By changing parameters like the maximum number of workers we can check the effectivness.
                */
-               Logger::log(
-                       'DB: '.number_format(self::$db_duration - (self::$db_duration_count + self::$db_duration_write + self::$db_duration_stat), 4).
-                       ' - DB-Count: '.number_format(self::$db_duration_count, 4).
-                       ' - DB-Stat: '.number_format(self::$db_duration_stat, 4).
-                       ' - DB-Write: '.number_format(self::$db_duration_write, 4).
-                       ' - Lock: '.number_format(self::$lock_duration, 4).
-                       ' - Rest: '.number_format(max(0, $up_duration - (self::$db_duration + self::$lock_duration)), 4).
-                       ' - Execution: '.number_format($duration, 4),
-                       Logger::DEBUG
-               );
+               $dbtotal = round(self::$db_duration, 2);
+               $dbread  = round(self::$db_duration - (self::$db_duration_count + self::$db_duration_write + self::$db_duration_stat), 2);
+               $dbcount = round(self::$db_duration_count, 2);
+               $dbstat  = round(self::$db_duration_stat, 2);
+               $dbwrite = round(self::$db_duration_write, 2);
+               $dblock  = round(self::$lock_duration, 2);
+               $rest    = round(max(0, $up_duration - (self::$db_duration + self::$lock_duration)), 2);
+               $exec    = round($duration, 2);
+
+               $logger->info('Performance log.', ['mode' => self::$mode, 'count' => $dbcount, 'stat' => $dbstat, 'write' => $dbwrite, 'lock' => $dblock, 'total' => $dbtotal, 'rest' => $rest, 'exec' => $exec]);
 
                self::$up_start = microtime(true);
                self::$db_duration = 0;
@@ -426,25 +416,26 @@ class Worker
                self::$db_duration_stat = 0;
                self::$db_duration_write = 0;
                self::$lock_duration = 0;
+               self::$mode = 2;
 
                if ($duration > 3600) {
-                       Logger::log("Prio ".$queue["priority"].": ".$queue["parameter"]." - longer than 1 hour (".round($duration/60, 3).")", Logger::DEBUG);
+                       $logger->info('Longer than 1 hour.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'duration' =>   round($duration/60, 3)]);
                } elseif ($duration > 600) {
-                       Logger::log("Prio ".$queue["priority"].": ".$queue["parameter"]." - longer than 10 minutes (".round($duration/60, 3).")", Logger::DEBUG);
+                       $logger->info('Longer than 10 minutes.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'duration' =>   round($duration/60, 3)]);
                } elseif ($duration > 300) {
-                       Logger::log("Prio ".$queue["priority"].": ".$queue["parameter"]." - longer than 5 minutes (".round($duration/60, 3).")", Logger::DEBUG);
+                       $logger->info('Longer than 5 minutes.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'duration' =>   round($duration/60, 3)]);
                } elseif ($duration > 120) {
-                       Logger::log("Prio ".$queue["priority"].": ".$queue["parameter"]." - longer than 2 minutes (".round($duration/60, 3).")", Logger::DEBUG);
+                       $logger->info('Longer than 2 minutes.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'duration' =>   round($duration/60, 3)]);
                }
 
-               Logger::log("Process ".$mypid." - Prio ".$queue["priority"]." - ID ".$queue["id"].": ".$funcname." - done in ".number_format($duration, 4)." seconds. Process PID: ".$new_process_id);
+               $workerLogger->info('Process done. ', ['priority' => $queue["priority"], 'id' => $queue["id"], 'duration' =>   number_format($duration, 4)]);
 
                $a->getProfiler()->saveLog($a->getLogger(), "ID " . $queue["id"] . ": " . $funcname);
 
                $cooldown = Config::get("system", "worker_cooldown", 0);
 
                if ($cooldown > 0) {
-                       Logger::log("Process ".$mypid." - Prio ".$queue["priority"]." - ID ".$queue["id"].": ".$funcname." - in cooldown for ".$cooldown." seconds");
+                       $logger->info('Cooldown.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'cooldown' => $cooldown]);
                        sleep($cooldown);
                }
        }
@@ -607,13 +598,10 @@ class Worker
        /**
         * @brief Checks if the number of active workers exceeds the given limits
         *
-        * @param integer $entries Total number of queue entries
-        * @param integer $deferred Number of deferred queue entries
-        *
         * @return bool Are there too much workers running?
         * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
-       public static function tooMuchWorkers($entries = 0, $deferred = 0)
+       private static function tooMuchWorkers()
        {
                $queues = Config::get("system", "worker_queues", 4);
 
@@ -664,12 +652,7 @@ class Worker
 
                        $idle_workers = $active;
 
-                       if (empty($deferred) && empty($entries)) {
-                               $deferred = self::deferredEntries();
-                               $entries = max(self::totalEntries() - $deferred, 0);
-                       }
-
-                       $waiting_processes = max(0, $entries - $deferred);
+                       $deferred = self::deferredEntries();
 
                        if (Config::get('system', 'worker_debug')) {
                                $waiting_processes = 0;
@@ -691,10 +674,14 @@ class Worker
                                        DBA::close($processes);
                                }
                                DBA::close($jobs);
+                               $entries = $deferred + $waiting_processes;
                        } else {
+                               $entries = self::totalEntries();
+                               $waiting_processes = max(0, $entries - $deferred);
                                $stamp = (float)microtime(true);
                                $jobs = DBA::p("SELECT COUNT(*) AS `running`, `priority` FROM `process` INNER JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid` AND NOT `done` GROUP BY `priority` ORDER BY `priority`");
                                self::$db_duration += (microtime(true) - $stamp);
+                               self::$db_duration_stat += (microtime(true) - $stamp);
 
                                while ($entry = DBA::fetch($jobs)) {
                                        $idle_workers -= $entry["running"];
@@ -753,212 +740,180 @@ class Worker
        }
 
        /**
-        * @brief Check if we should pass some slow processes
-        *
-        * When the active processes of the highest priority are using more than 2/3
-        * of all processes, we let pass slower processes.
+        * @brief Returns waiting jobs for the current process id
         *
-        * @param string $highest_priority Returns the currently highest priority
-        * @return bool We let pass a slower process than $highest_priority
+        * @return array waiting workerqueue jobs
         * @throws \Exception
         */
-       private static function passingSlow(&$highest_priority)
+       private static function getWaitingJobForPID()
        {
-               $highest_priority = 0;
-
                $stamp = (float)microtime(true);
-               $r = DBA::p(
-                       "SELECT `priority`
-                               FROM `process`
-                               INNER JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid` AND NOT `done`"
-               );
+               $r = DBA::select('workerqueue', [], ['pid' => getmypid(), 'done' => false]);
                self::$db_duration += (microtime(true) - $stamp);
-
-               // No active processes at all? Fine
-               if (!DBA::isResult($r)) {
-                       return false;
-               }
-               $priorities = [];
-               while ($line = DBA::fetch($r)) {
-                       $priorities[] = $line["priority"];
+               if (DBA::isResult($r)) {
+                       return DBA::toArray($r);
                }
                DBA::close($r);
 
-               // Should not happen
-               if (count($priorities) == 0) {
-                       return false;
-               }
-               $highest_priority = min($priorities);
+               return false;
+       }
 
-               // The highest process is already the slowest one?
-               // Then we quit
-               if ($highest_priority == PRIORITY_NEGLIGIBLE) {
-                       return false;
+       /**
+        * @brief Returns the next jobs that should be executed
+        *
+        * @return array array with next jobs
+        * @throws \Exception
+        */
+       private static function nextProcess()
+       {
+               $priority = self::nextPriority();
+               if (empty($priority)) {
+                       Logger::info('No tasks found');
+                       return [];
                }
-               $high = 0;
-               foreach ($priorities as $priority) {
-                       if ($priority == $highest_priority) {
-                               ++$high;
-                       }
+
+               if ($priority <= PRIORITY_MEDIUM) {
+                       $limit = Config::get('system', 'worker_fetch_limit', 1);
+               } else {
+                       $limit = 1;
                }
-               Logger::log("Highest priority: ".$highest_priority." Total processes: ".count($priorities)." Count high priority processes: ".$high, Logger::DEBUG);
-               $passing_slow = (($high/count($priorities)) > (2/3));
 
-               if ($passing_slow) {
-                       Logger::log("Passing slower processes than priority ".$highest_priority, Logger::DEBUG);
+               $ids = [];
+               $stamp = (float)microtime(true);
+               $condition = ["`priority` = ? AND `pid` = 0 AND NOT `done` AND `next_try` < ?", $priority, DateTimeFormat::utcNow()];
+               $tasks = DBA::select('workerqueue', ['id'], $condition, ['limit' => $limit, 'order' => ['created']]);
+               self::$db_duration += (microtime(true) - $stamp);
+               while ($task = DBA::fetch($tasks)) {
+                       $ids[] = $task['id'];
                }
-               return $passing_slow;
+               DBA::close($tasks);
+
+               Logger::info('Found:', ['id' => $ids, 'priority' => $priority]);
+               return $ids;
        }
 
        /**
-        * @brief Find and claim the next worker process for us
+        * @brief Returns the priority of the next workerqueue job
         *
-        * @param boolean $passing_slow Returns if we had passed low priority processes
-        * @param integer $entries Total number of queue entries
-        * @param integer $deferred Number of deferred queue entries
-        * @return boolean Have we found something?
-        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        * @return string priority
+        * @throws \Exception
         */
-       private static function findWorkerProcesses(&$passing_slow, $entries, $deferred)
+       private static function nextPriority()
        {
-               $mypid = getmypid();
-
-               // Check if we should pass some low priority process
-               $highest_priority = 0;
-               $found = false;
-               $passing_slow = false;
-
-               // The higher the number of parallel workers, the more we prefetch to prevent concurring access
-               // We decrease the limit with the number of entries left in the queue
-               $worker_queues = Config::get("system", "worker_queues", 4);
-               $queue_length = Config::get('system', 'worker_fetch_limit', 1);
-               $lower_job_limit = $worker_queues * $queue_length * 2;
-               $entries = max($entries - $deferred, 0);
-
-               // Now do some magic
-               $exponent = 2;
-               $slope = $queue_length / pow($lower_job_limit, $exponent);
-               $limit = min($queue_length, ceil($slope * pow($entries, $exponent)));
-
-               Logger::log('Deferred: ' . $deferred . ' - Total: ' . $entries . ' - Maximum: ' . $queue_length . ' - jobs per queue: ' . $limit, Logger::DEBUG);
-               $ids = [];
-               if (self::passingSlow($highest_priority)) {
-                       // Are there waiting processes with a higher priority than the currently highest?
+               $waiting = [];
+               $priorities = [PRIORITY_CRITICAL, PRIORITY_HIGH, PRIORITY_MEDIUM, PRIORITY_LOW, PRIORITY_NEGLIGIBLE];
+               foreach ($priorities as $priority) {
                        $stamp = (float)microtime(true);
-                       $result = DBA::select(
-                               'workerqueue',
-                               ['id'],
-                               ["`pid` = 0 AND `priority` < ? AND NOT `done` AND `next_try` < ?",
-                               $highest_priority, DateTimeFormat::utcNow()],
-                               ['limit' => 1, 'order' => ['priority', 'created']]
-                       );
+                       if (DBA::exists('workerqueue', ["`priority` = ? AND `pid` = 0 AND NOT `done` AND `next_try` < ?", $priority, DateTimeFormat::utcNow()])) {
+                               $waiting[$priority] = true;
+                       }
                        self::$db_duration += (microtime(true) - $stamp);
+               }
 
-                       while ($id = DBA::fetch($result)) {
-                               $ids[] = $id["id"];
-                       }
-                       DBA::close($result);
+               if (!empty($waiting[PRIORITY_CRITICAL])) {
+                       return PRIORITY_CRITICAL;
+               }
 
-                       $found = (count($ids) > 0);
+               $running = [];
+               $running_total = 0;
+               $stamp = (float)microtime(true);
+               $processes = DBA::p("SELECT COUNT(DISTINCT(`process`.`pid`)) AS `running`, `priority` FROM `process`
+                       INNER JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid`
+                       WHERE NOT `done` GROUP BY `priority`");
+               self::$db_duration += (microtime(true) - $stamp);
+               while ($process = DBA::fetch($processes)) {
+                       $running[$process['priority']] = $process['running'];
+                       $running_total += $process['running'];
+               }
+               DBA::close($processes);
 
-                       if (!$found) {
-                               // Give slower processes some processing time
-                               $stamp = (float)microtime(true);
-                               $result = DBA::select(
-                                       'workerqueue',
-                                       ['id'],
-                                       ["`pid` = 0 AND `priority` > ? AND NOT `done` AND `next_try` < ?",
-                                       $highest_priority, DateTimeFormat::utcNow()],
-                                       ['limit' => 1, 'order' => ['priority', 'created']]
-                               );
-                               self::$db_duration += (microtime(true) - $stamp);
+               foreach ($priorities as $priority) {
+                       if (!empty($waiting[$priority]) && empty($running[$priority])) {
+                               Logger::info('No running worker found with priority {priority} - assigning it.', ['priority' => $priority]);
+                               return $priority;
+                       }
+               }
 
-                               while ($id = DBA::fetch($result)) {
-                                       $ids[] = $id["id"];
-                               }
-                               DBA::close($result);
+               $active = max(self::activeWorkers(), $running_total);
+               $priorities = max(count($waiting), count($running));
+               $exponent = 2;
 
-                               $found = (count($ids) > 0);
-                               $passing_slow = $found;
-                       }
+               $total = 0;
+               for ($i = 1; $i <= $priorities; ++$i) {
+                       $total += pow($i, $exponent);
                }
 
-               // At first try to fetch a bunch of high or medium tasks
-               if (!$found && ($limit > 1)) {
-                       $stamp = (float)microtime(true);
-                       $result = DBA::select(
-                               'workerqueue',
-                               ['id'],
-                               ["`pid` = 0 AND NOT `done` AND `priority` <= ? AND `next_try` < ? AND `retrial` = 0",
-                               PRIORITY_MEDIUM, DateTimeFormat::utcNow()],
-                               ['limit' => $limit, 'order' => ['created']]
-                       );
-                       self::$db_duration += (microtime(true) - $stamp);
+               $limit = [];
+               for ($i = 1; $i <= $priorities; ++$i) {
+                       $limit[$priorities - $i] = max(1, round($active * (pow($i, $exponent) / $total)));
+               }
 
-                       while ($id = DBA::fetch($result)) {
-                               $ids[] = $id["id"];
+               $i = 0;
+               foreach ($running as $priority => $workers) {
+                       if ($workers < $limit[$i++]) {
+                               Logger::info('Priority {priority} has got {workers} workers out of a limit of {limit}', ['priority' => $priority, 'workers' => $workers, 'limit' => $limit[$i - 1]]);
+                               return $priority;
                        }
-                       DBA::close($result);
+               }
 
-                       $found = (count($ids) > 0);
+               if (!empty($waiting)) {
+                       $priority = array_keys($waiting)[0];
+                       Logger::info('No underassigned priority found, now taking the highest priority.', ['priority' => $priority]);
+                       return $priority;
                }
 
-               // If there is no result (or we shouldn't pass lower processes) we check without priority limit
-               if (!$found) {
+               return false;
+       }
+
+       /**
+        * @brief Find and claim the next worker process for us
+        *
+        * @return boolean Have we found something?
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        */
+       private static function findWorkerProcesses()
+       {
+               $mypid = getmypid();
+
+               $ids = self::nextProcess();
+
+               // If there is no result we check without priority limit
+               if (empty($ids)) {
                        $stamp = (float)microtime(true);
-                       $result = DBA::select(
-                               'workerqueue',
-                               ['id'],
-                               ["`pid` = 0 AND NOT `done` AND `next_try` < ?",
-                               DateTimeFormat::utcNow()],
-                               ['limit' => 1, 'order' => ['priority', 'created']]
-                       );
+                       $condition = ["`pid` = 0 AND NOT `done` AND `next_try` < ?", DateTimeFormat::utcNow()];
+                       $result = DBA::select('workerqueue', ['id'], $condition, ['limit' => 1, 'order' => ['priority', 'created']]);
                        self::$db_duration += (microtime(true) - $stamp);
 
                        while ($id = DBA::fetch($result)) {
                                $ids[] = $id["id"];
                        }
                        DBA::close($result);
-
-                       $found = (count($ids) > 0);
                }
 
-               if ($found) {
+               if (!empty($ids)) {
                        $stamp = (float)microtime(true);
-                       $condition = "`id` IN (".substr(str_repeat("?, ", count($ids)), 0, -2).") AND `pid` = 0 AND NOT `done`";
-                       array_unshift($ids, $condition);
-                       DBA::update('workerqueue', ['executed' => DateTimeFormat::utcNow(), 'pid' => $mypid], $ids);
+                       $condition = ['id' => $ids, 'done' => false, 'pid' => 0];
+                       DBA::update('workerqueue', ['executed' => DateTimeFormat::utcNow(), 'pid' => $mypid], $condition);
                        self::$db_duration += (microtime(true) - $stamp);
                        self::$db_duration_write += (microtime(true) - $stamp);
                }
 
-               return $found;
+               return !empty($ids);
        }
 
        /**
         * @brief Returns the next worker process
         *
-        * @param boolean $passing_slow Returns if we had passed low priority processes
-        * @param integer $entries Returns total number of queue entries
-        * @param integer $deferred Returns number of deferred queue entries
-        *
         * @return string SQL statement
         * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
-       public static function workerProcess(&$passing_slow, &$entries, &$deferred)
+       public static function workerProcess()
        {
                // There can already be jobs for us in the queue.
-               $stamp = (float)microtime(true);
-               $r = DBA::select('workerqueue', [], ['pid' => getmypid(), 'done' => false]);
-               self::$db_duration += (microtime(true) - $stamp);
-               if (DBA::isResult($r)) {
-                       return DBA::toArray($r);
+               $waiting = self::getWaitingJobForPID();
+               if (!empty($waiting)) {
+                       return $waiting;
                }
-               DBA::close($r);
-
-               // Counting the rows outside the lock reduces the lock time
-               $entries = self::totalEntries();
-               $deferred = self::deferredEntries();
 
                $stamp = (float)microtime(true);
                if (!Lock::acquire('worker_process')) {
@@ -966,7 +921,7 @@ class Worker
                }
                self::$lock_duration += (microtime(true) - $stamp);
 
-               $found = self::findWorkerProcesses($passing_slow, $entries, $deferred);
+               $found = self::findWorkerProcesses();
 
                Lock::release('worker_process');