<?php
/**
- * @copyright Copyright (C) 2020, Friendica
+ * @copyright Copyright (C) 2010-2021, the Friendica project
*
* @license GNU AGPL version 3 or any later version
*
namespace Friendica\Core;
+use Friendica\App\Mode;
use Friendica\Core;
+use Friendica\Core\Worker\Entity\Process;
use Friendica\Database\DBA;
use Friendica\DI;
use Friendica\Util\DateTimeFormat;
private static $lock_duration = 0;
private static $last_update;
private static $state;
+ private static $daemon_mode = null;
+ /** @var Process */
+ private static $process;
/**
* Processes the tasks that are in the workerqueue table
*
* @param boolean $run_cron Should the cron processes be executed?
+ * @param Process $process The current running process
* @return void
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
- public static function processQueue($run_cron = true)
+ public static function processQueue($run_cron, Process $process)
{
- // Ensure that all "strtotime" operations do run timezone independent
- date_default_timezone_set('UTC');
-
self::$up_start = microtime(true);
// At first check the maximum load. We shouldn't continue with a high load
- if (DI::process()->isMaxLoadReached()) {
+ if (DI::system()->isMaxLoadReached()) {
Logger::notice('Pre check: maximum load reached, quitting.');
return;
}
// We now start the process. This is done after the load check since this could increase the load.
- DI::process()->start();
+ self::$process = $process;
// Kill stale processes every 5 minutes
$last_cleanup = DI::config()->get('system', 'worker_last_cleaned', 0);
// 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) {
}
// Check free memory
- if (DI::process()->isMinMemoryReached()) {
+ if (DI::system()->isMinMemoryReached()) {
Logger::warning('Memory limit reached, quitting.');
DI::lock()->release(self::LOCK_WORKER);
return;
// Quit the worker once every cron interval
if (time() > ($starttime + (DI::config()->get('system', 'cron_interval') * 60))) {
Logger::info('Process lifetime reached, respawning.');
- self::unclaimProcess();
- self::spawnWorker();
+ self::unclaimProcess($process);
+ 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()]);
}
// Do we have too few memory?
- if (DI::process()->isMinMemoryReached()) {
+ if (DI::system()->isMinMemoryReached()) {
Logger::warning('Memory limit reached, quitting.');
return false;
}
}
// Possibly there are too much database processes that block the system
- if (DI::process()->isMaxProcessesReached()) {
+ if (DI::system()->isMaxProcessesReached()) {
Logger::warning('Maximum processes reached, quitting.');
return false;
}
-
+
return true;
}
return DBA::exists('workerqueue', $condition);
}
+ /**
+ * Checks if the given file is valid to be included
+ *
+ * @param mixed $file
+ * @return bool
+ */
+ private static function validateInclude(&$file)
+ {
+ $orig_file = $file;
+
+ $file = realpath($file);
+
+ if (strpos($file, getcwd()) !== 0) {
+ return false;
+ }
+
+ $file = str_replace(getcwd() . "/", "", $file, $count);
+ if ($count != 1) {
+ return false;
+ }
+
+ if ($orig_file !== $file) {
+ return false;
+ }
+
+ $valid = false;
+ if (strpos($file, "include/") === 0) {
+ $valid = true;
+ }
+
+ if (strpos($file, "addon/") === 0) {
+ $valid = true;
+ }
+
+ // Simply return flag
+ return $valid;
+ }
+
/**
* Execute a worker entry
*
}
// Constantly check the number of parallel database processes
- if (DI::process()->isMaxProcessesReached()) {
+ if (DI::system()->isMaxProcessesReached()) {
Logger::warning("Max processes reached for process", ['pid' => $mypid]);
return false;
}
}
$argv = json_decode($queue['parameter'], true);
+ if (!is_array($argv)) {
+ $argv = [];
+ }
+
if (!empty($queue['command'])) {
array_unshift($argv, $queue['command']);
}
$include = "include/".$include.".php";
}
- if (!validate_include($include)) {
+ if (!self::validateInclude($include)) {
Logger::warning("Include file is not valid", ['file' => $argv[0]]);
$stamp = (float)microtime(true);
DBA::delete('workerqueue', ['id' => $queue["id"]]);
$queue['priority'] = PRIORITY_MEDIUM;
}
- $a->queue = $queue;
+ $a->setQueue($queue);
$up_duration = microtime(true) - self::$up_start;
Logger::disableWorker();
- unset($a->queue);
+ $a->setQueue([]);
$duration = (microtime(true) - $stamp);
}
$stamp = (float)microtime(true);
- $jobs = DBA::p("SELECT COUNT(*) AS `jobs` FROM `workerqueue` WHERE `done` AND `executed` > UTC_TIMESTAMP() - INTERVAL ? MINUTE", $interval);
+ $jobs = DBA::count('workerqueue', ["`done` AND `executed` > UTC_TIMESTAMP() - INTERVAL ? MINUTE", $interval]);
self::$db_duration += (microtime(true) - $stamp);
self::$db_duration_stat += (microtime(true) - $stamp);
- if ($job = DBA::fetch($jobs)) {
- $jobs_per_minute[$interval] = number_format($job['jobs'] / $interval, 0);
- }
- DBA::close($jobs);
+ $jobs_per_minute[$interval] = number_format($jobs / $interval, 0);
}
$processlist = ' - jpm: '.implode('/', $jobs_per_minute);
}
self::$db_duration_stat += (microtime(true) - $stamp);
while ($entry = DBA::fetch($jobs)) {
$stamp = (float)microtime(true);
- $processes = DBA::p("SELECT COUNT(*) AS `running` FROM `workerqueue-view` WHERE `priority` = ?", $entry["priority"]);
+ $running = DBA::count('workerqueue-view', ['priority' => $entry["priority"]]);
self::$db_duration += (microtime(true) - $stamp);
self::$db_duration_stat += (microtime(true) - $stamp);
- if ($process = DBA::fetch($processes)) {
- $idle_workers -= $process["running"];
- $waiting_processes += $entry["entries"];
- $listitem[$entry["priority"]] = $entry["priority"].":".$process["running"]."/".$entry["entries"];
- }
- DBA::close($processes);
+ $idle_workers -= $running;
+ $waiting_processes += $entry["entries"];
+ $listitem[$entry["priority"]] = $entry["priority"] . ":" . $running . "/" . $entry["entries"];
}
DBA::close($jobs);
} else {
// 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();
}
// 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);
}
private static function activeWorkers()
{
$stamp = (float)microtime(true);
- $count = DBA::count('process', ['command' => 'Worker.php']);
+ $count = DI::process()->countCommand('Worker.php');
self::$db_duration += (microtime(true) - $stamp);
self::$db_duration_count += (microtime(true) - $stamp);
return $count;
$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'];
/**
* Removes a workerqueue entry from the current process
*
+ * @param Process $process the process behind the workerqueue
+ *
* @return void
* @throws \Exception
*/
- public static function unclaimProcess()
+ public static function unclaimProcess(Process $process)
{
- $mypid = getmypid();
-
$stamp = (float)microtime(true);
- DBA::update('workerqueue', ['executed' => DBA::NULL_DATETIME, 'pid' => 0], ['pid' => $mypid, 'done' => false]);
+ DBA::update('workerqueue', ['executed' => DBA::NULL_DATETIME, 'pid' => 0], ['pid' => $process->pid, 'done' => false]);
self::$db_duration += (microtime(true) - $stamp);
self::$db_duration_write += (microtime(true) - $stamp);
}
/**
- * Call the front end worker
+ * Runs the cron processes
*
* @return void
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
- public static function callWorker()
+ private static function runCron()
{
- if (!DI::config()->get("system", "frontend_worker")) {
- return;
- }
+ Logger::info('Add cron entries');
+
+ // Check for spooled items
+ self::add(['priority' => PRIORITY_HIGH, 'force_priority' => true], 'SpoolPost');
+
+ // Run the cron job that calls all other jobs
+ self::add(['priority' => PRIORITY_MEDIUM, 'force_priority' => true], 'Cron');
- $url = DI::baseUrl() . '/worker';
- DI::httpRequest()->fetch($url, 1);
+ // Cleaning dead processes
+ self::killStaleWorkers();
}
/**
- * Call the front end worker if there aren't any active
+ * Fork a child process
*
+ * @param boolean $do_cron
* @return void
- * @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
- public static function executeIfIdle()
+ private static function forkProcess(bool $do_cron)
{
- self::checkDaemonState();
-
- if (!DI::config()->get("system", "frontend_worker")) {
+ if (DI::system()->isMinMemoryReached()) {
+ Logger::warning('Memory limit reached - quitting');
return;
}
- // Do we have "proc_open"? Then we can fork the worker
- if (function_exists("proc_open")) {
- // When was the last time that we called the worker?
- // Less than one minute? Then we quit
- if ((time() - DI::config()->get("system", "worker_started")) < 60) {
- return;
- }
-
- DI::config()->set("system", "worker_started", time());
+ // Children inherit their parent's database connection.
+ // To avoid problems we disconnect and connect both parent and child
+ DBA::disconnect();
+ $pid = pcntl_fork();
+ if ($pid == -1) {
+ DBA::connect();
+ Logger::warning('Could not spawn worker');
+ return;
+ } elseif ($pid) {
+ // The parent process continues here
+ DBA::connect();
- // Do we have enough running workers? Then we quit here.
- if (self::tooMuchWorkers()) {
- // Cleaning dead processes
- self::killStaleWorkers();
- DI::modelProcess()->deleteInactive();
+ self::IPCSetJobState(true, $pid);
+ Logger::info('Spawned new worker', ['pid' => $pid]);
- return;
+ $cycles = 0;
+ while (self::IPCJobsExists($pid) && (++$cycles < 100)) {
+ usleep(10000);
}
- self::runCron();
-
- Logger::info('Call worker');
- self::spawnWorker();
+ Logger::info('Spawned worker is ready', ['pid' => $pid, 'wait_cycles' => $cycles]);
return;
}
- // We cannot execute background processes.
- // We now run the processes from the frontend.
- // This won't work with long running processes.
- self::runCron();
+ // We now are in the new worker
+ DBA::connect();
- self::clearProcesses();
+ DI::flushLogger();
+ $process = DI::process()->create(getmypid(), basename(__FILE__));
- $workers = self::activeWorkers();
-
- if ($workers == 0) {
- self::callWorker();
+ $cycles = 0;
+ while (!self::IPCJobsExists($process->pid) && (++$cycles < 100)) {
+ usleep(10000);
}
- }
-
- /**
- * Removes long running worker processes
- *
- * @return void
- * @throws \Friendica\Network\HTTPException\InternalServerErrorException
- */
- public static function clearProcesses()
- {
- $timeout = DI::config()->get("system", "frontend_worker_timeout", 10);
- /// @todo We should clean up the corresponding workerqueue entries as well
- $stamp = (float)microtime(true);
- $condition = ["`created` < ? AND `command` = 'worker.php'",
- DateTimeFormat::utc("now - ".$timeout." minutes")];
- DBA::delete('process', $condition);
- self::$db_duration = (microtime(true) - $stamp);
- self::$db_duration_write += (microtime(true) - $stamp);
- }
-
- /**
- * Runs the cron processes
- *
- * @return void
- * @throws \Friendica\Network\HTTPException\InternalServerErrorException
- */
- private static function runCron()
- {
- Logger::info('Add cron entries');
+ Logger::info('Worker spawned', ['pid' => $process->pid, 'wait_cycles' => $cycles]);
- // Check for spooled items
- self::add(['priority' => PRIORITY_HIGH, 'force_priority' => true], 'SpoolPost');
+ self::processQueue($do_cron, $process);
- // Run the cron job that calls all other jobs
- self::add(['priority' => PRIORITY_MEDIUM, 'force_priority' => true], 'Cron');
+ self::unclaimProcess($process);
- // Cleaning dead processes
- self::killStaleWorkers();
+ self::IPCSetJobState(false, $process->pid);
+ DI::process()->delete($process);
+ Logger::info('Worker ended', ['pid' => $process->pid]);
+ exit();
}
/**
*/
public static function spawnWorker($do_cron = false)
{
- $command = 'bin/worker.php';
-
- $args = ['no_cron' => !$do_cron];
-
- $a = DI::app();
- $process = new Core\Process(DI::logger(), DI::mode(), DI::config(), DI::modelProcess(), $a->getBasePath(), getmypid());
- $process->run($command, $args);
-
- // after spawning we have to remove the flag.
- if (DI::config()->get('system', 'worker_daemon_mode', false)) {
+ if (self::isDaemonMode() && DI::config()->get('system', 'worker_fork')) {
+ self::forkProcess($do_cron);
+ } else {
+ DI::system()->run('bin/worker.php', ['no_cron' => !$do_cron]);
+ }
+ if (self::isDaemonMode()) {
self::IPCSetJobState(false);
}
}
* 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 ""
*
* array $arr
*
*/
- public static function add($cmd)
+ public static function add(...$args)
{
- $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;
if (isset($run_parameter['force_priority'])) {
$force_priority = $run_parameter['force_priority'];
}
+ } else {
+ throw new \InvalidArgumentException('Priority number or task parameter array expected as first argument');
}
$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)]);
// 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);
}
}
// Quit on daemon mode
- if (DI::config()->get('system', 'worker_daemon_mode', false)) {
+ if (self::isDaemonMode()) {
return $added;
}
*/
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'];
* 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(bool $jobs, int $key = 0)
+ {
+ $stamp = (float)microtime(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 IPCSetJobState($jobs)
+ public static function IPCDeleteJobState(int $key)
{
$stamp = (float)microtime(true);
- DBA::update('worker-ipc', ['jobs' => $jobs], ['key' => 1], true);
+ DBA::delete('worker-ipc', ['key' => $key]);
self::$db_duration += (microtime(true) - $stamp);
self::$db_duration_write += (microtime(true) - $stamp);
}
/**
* 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
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
*
Logger::notice('Starting new daemon process');
$command = 'bin/daemon.php';
$a = DI::app();
- $process = new Core\Process(DI::logger(), DI::mode(), DI::config(), DI::modelProcess(), $a->getBasePath(), getmypid());
- $process->run($command, ['start']);
+ DI::system()->run($command, ['start']);
Logger::notice('New daemon process started');
}
} 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;
}
}
projects / friendica.git / blobdiff