<?php
+/**
+ * @file src/Core/Worker.php
+ */
namespace Friendica\Core;
use Friendica\App;
use dba;
+require_once 'include/dba.php';
+
/**
* @file src/Core/Worker.php
*
/**
* @brief Worker methods
*/
-class Worker {
+class Worker
+{
private static $up_start;
private static $db_duration;
private static $last_update;
* @brief Processes the tasks that are in the workerqueue table
*
* @param boolean $run_cron Should the cron processes be executed?
+ * @return void
*/
- public static function processQueue($run_cron = true) {
+ public static function processQueue($run_cron = true)
+ {
$a = get_app();
self::$up_start = microtime(true);
// We fetch the next queue entry that is about to be executed
while ($r = self::workerProcess($passing_slow)) {
-
// 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;
- foreach ($r AS $entry) {
+ foreach ($r as $entry) {
// Assure that the priority is an integer value
$entry['priority'] = (int)$entry['priority'];
}
}
- // To avoid the quitting of multiple pollers only one poller at a time will execute the check
+ // To avoid the quitting of multiple workers only one worker at a time will execute the check
if (Lock::set('poller_worker', 0)) {
$stamp = (float)microtime(true);
// Count active workers and compare them with a maximum value that depends on the load
self::$db_duration += (microtime(true) - $stamp);
}
- // Quit the poller once every 5 minutes
+ // Quit the worker once every 5 minutes
if (time() > ($starttime + 300)) {
logger('Process lifetime reached, quitting.', LOGGER_DEBUG);
return;
*
* @return integer Number of non executed entries in the worker queue
*/
- private static function totalEntries() {
+ private static function totalEntries()
+ {
$s = dba::fetch_first("SELECT COUNT(*) AS `total` FROM `workerqueue` WHERE `executed` <= ? AND NOT `done`", NULL_DATE);
if (DBM::is_result($s)) {
return $s["total"];
/**
* @brief Returns the highest priority in the worker queue that isn't executed
*
- * @return integer Number of active poller processes
+ * @return integer Number of active worker processes
*/
- private static function highestPriority() {
- $condition = array("`executed` <= ? AND NOT `done`", NULL_DATE);
- $s = dba::select('workerqueue', array('priority'), $condition, array('limit' => 1, 'order' => array('priority')));
- if (DBM::is_result($s)) {
- return $s["priority"];
+ private static function highestPriority()
+ {
+ $condition = ["`executed` <= ? AND NOT `done`", NULL_DATE];
+ $workerqueue = dba::selectFirst('workerqueue', ['priority'], $condition, ['order' => ['priority']]);
+ if (DBM::is_result($workerqueue)) {
+ return $workerqueue["priority"];
} else {
return 0;
}
*
* @return integer Is there a process running with that priority?
*/
- private static function processWithPriorityActive($priority) {
- $condition = array("`priority` <= ? AND `executed` > ? AND NOT `done`", $priority, NULL_DATE);
+ private static function processWithPriorityActive($priority)
+ {
+ $condition = ["`priority` <= ? AND `executed` > ? AND NOT `done`", $priority, NULL_DATE];
return dba::exists('workerqueue', $condition);
}
*
* @return boolean "true" if further processing should be stopped
*/
- public static function execute($queue) {
+ public static function execute($queue)
+ {
$a = get_app();
$mypid = getmypid();
if ($age > 1) {
$stamp = (float)microtime(true);
- dba::update('workerqueue', array('executed' => datetime_convert()), array('pid' => $mypid, 'done' => false));
+ dba::update('workerqueue', ['executed' => datetime_convert()], ['pid' => $mypid, 'done' => false]);
self::$db_duration += (microtime(true) - $stamp);
}
self::execFunction($queue, $include, $argv, true);
$stamp = (float)microtime(true);
- if (dba::update('workerqueue', array('done' => true), array('id' => $queue["id"]))) {
+ if (dba::update('workerqueue', ['done' => true], ['id' => $queue["id"]])) {
Config::set('system', 'last_poller_execution', datetime_convert());
}
self::$db_duration = (microtime(true) - $stamp);
if (!validate_include($include)) {
logger("Include file ".$argv[0]." is not valid!");
- dba::delete('workerqueue', array('id' => $queue["id"]));
+ dba::delete('workerqueue', ['id' => $queue["id"]]);
return true;
}
- require_once($include);
+ require_once $include;
$funcname = str_replace(".php", "", basename($argv[0]))."_run";
if (function_exists($funcname)) {
-
// We constantly update the "executed" date every minute to avoid being killed too soon
if (!isset(self::$last_update)) {
self::$last_update = strtotime($queue["executed"]);
if ($age > 1) {
$stamp = (float)microtime(true);
- dba::update('workerqueue', array('executed' => datetime_convert()), array('pid' => $mypid, 'done' => false));
+ dba::update('workerqueue', ['executed' => datetime_convert()], ['pid' => $mypid, 'done' => false]);
self::$db_duration += (microtime(true) - $stamp);
}
self::execFunction($queue, $funcname, $argv, false);
$stamp = (float)microtime(true);
- if (dba::update('workerqueue', array('done' => true), array('id' => $queue["id"]))) {
+ if (dba::update('workerqueue', ['done' => true], ['id' => $queue["id"]])) {
Config::set('system', 'last_poller_execution', datetime_convert());
}
self::$db_duration = (microtime(true) - $stamp);
} else {
logger("Function ".$funcname." does not exist");
- dba::delete('workerqueue', array('id' => $queue["id"]));
+ dba::delete('workerqueue', ['id' => $queue["id"]]);
}
return true;
/**
* @brief Execute a function from the queue
*
- * @param array $queue Workerqueue entry
- * @param string $funcname name of the function
- * @param array $argv Array of values to be passed to the function
+ * @param array $queue Workerqueue entry
+ * @param string $funcname name of the function
+ * @param array $argv Array of values to be passed to the function
+ * @param boolean $method_call boolean
+ * @return void
*/
- private static function execFunction($queue, $funcname, $argv, $method_call) {
+ private static function execFunction($queue, $funcname, $argv, $method_call)
+ {
$a = get_app();
$mypid = getmypid();
$a->performance["parser"] = 0;
$a->performance["marktime"] = 0;
$a->performance["markstart"] = microtime(true);
- $a->callstack = array();
+ $a->callstack = [];
}
// For better logging create a new process id for every worker call
* The execution time is the productive time.
* By changing parameters like the maximum number of workers we can check the effectivness.
*/
- logger('DB: '.number_format(self::$db_duration, 2).
+ logger(
+ 'DB: '.number_format(self::$db_duration, 2).
' - Lock: '.number_format(self::$lock_duration, 2).
' - Rest: '.number_format($up_duration - self::$db_duration - self::$lock_duration, 2).
- ' - Execution: '.number_format($duration, 2), LOGGER_DEBUG);
+ ' - Execution: '.number_format($duration, 2),
+ LOGGER_DEBUG
+ );
+
self::$lock_duration = 0;
if ($duration > 3600) {
if (Config::get("rendertime", "callstack")) {
if (isset($a->callstack["database"])) {
$o = "\nDatabase Read:\n";
- foreach ($a->callstack["database"] AS $func => $time) {
+ foreach ($a->callstack["database"] as $func => $time) {
$time = round($time, 3);
if ($time > 0) {
$o .= $func.": ".$time."\n";
}
if (isset($a->callstack["database_write"])) {
$o .= "\nDatabase Write:\n";
- foreach ($a->callstack["database_write"] AS $func => $time) {
+ foreach ($a->callstack["database_write"] as $func => $time) {
$time = round($time, 3);
if ($time > 0) {
$o .= $func.": ".$time."\n";
}
if (isset($a->callstack["network"])) {
$o .= "\nNetwork:\n";
- foreach ($a->callstack["network"] AS $func => $time) {
+ foreach ($a->callstack["network"] as $func => $time) {
$time = round($time, 3);
if ($time > 0) {
$o .= $func.": ".$time."\n";
$o = '';
}
- logger("ID ".$queue["id"].": ".$funcname.": ".sprintf("DB: %s/%s, Net: %s, I/O: %s, Other: %s, Total: %s".$o,
- number_format($a->performance["database"] - $a->performance["database_write"], 2),
- number_format($a->performance["database_write"], 2),
- number_format($a->performance["network"], 2),
- number_format($a->performance["file"], 2),
- number_format($duration - ($a->performance["database"] + $a->performance["network"] + $a->performance["file"]), 2),
- number_format($duration, 2)),
- LOGGER_DEBUG);
+ logger(
+ "ID ".$queue["id"].": ".$funcname.": ".sprintf(
+ "DB: %s/%s, Net: %s, I/O: %s, Other: %s, Total: %s".$o,
+ number_format($a->performance["database"] - $a->performance["database_write"], 2),
+ number_format($a->performance["database_write"], 2),
+ number_format($a->performance["network"], 2),
+ number_format($a->performance["file"], 2),
+ number_format($duration - ($a->performance["database"] + $a->performance["network"] + $a->performance["file"]), 2),
+ number_format($duration, 2)
+ ),
+ LOGGER_DEBUG
+ );
}
$cooldown = Config::get("system", "worker_cooldown", 0);
*
* @return bool Are more than 3/4 of the maximum connections used?
*/
- private static function maxConnectionsReached() {
-
+ private static function maxConnectionsReached()
+ {
// Fetch the max value from the config. This is needed when the system cannot detect the correct value by itself.
$max = Config::get("system", "max_connections");
- // Fetch the percentage level where the poller will get active
+ // Fetch the percentage level where the worker will get active
$maxlevel = Config::get("system", "max_connections_level", 75);
if ($max == 0) {
/**
* @brief fix the queue entry if the worker process died
- *
+ * @return void
*/
- private static function killStaleWorkers() {
- $entries = dba::select('workerqueue', array('id', 'pid', 'executed', 'priority', 'parameter'),
- array('`executed` > ? AND NOT `done` AND `pid` != 0', NULL_DATE),
- array('order' => array('priority', 'created')));
+ private static function killStaleWorkers()
+ {
+ $entries = dba::select(
+ 'workerqueue',
+ ['id', 'pid', 'executed', 'priority', 'parameter'],
+ ['`executed` > ? AND NOT `done` AND `pid` != 0', NULL_DATE],
+ ['order' => ['priority', 'created']]
+ );
+
while ($entry = dba::fetch($entries)) {
if (!posix_kill($entry["pid"], 0)) {
- dba::update('workerqueue', array('executed' => NULL_DATE, 'pid' => 0),
- array('id' => $entry["id"]));
+ dba::update(
+ 'workerqueue',
+ ['executed' => NULL_DATE, 'pid' => 0],
+ ['id' => $entry["id"]]
+ );
} else {
// Kill long running processes
// Check if the priority is in a valid range
- if (!in_array($entry["priority"], array(PRIORITY_CRITICAL, PRIORITY_HIGH, PRIORITY_MEDIUM, PRIORITY_LOW, PRIORITY_NEGLIGIBLE))) {
+ if (!in_array($entry["priority"], [PRIORITY_CRITICAL, PRIORITY_HIGH, PRIORITY_MEDIUM, PRIORITY_LOW, PRIORITY_NEGLIGIBLE])) {
$entry["priority"] = PRIORITY_MEDIUM;
}
// Define the maximum durations
- $max_duration_defaults = array(PRIORITY_CRITICAL => 720, PRIORITY_HIGH => 10, PRIORITY_MEDIUM => 60, PRIORITY_LOW => 180, PRIORITY_NEGLIGIBLE => 720);
+ $max_duration_defaults = [PRIORITY_CRITICAL => 720, PRIORITY_HIGH => 10, PRIORITY_MEDIUM => 60, PRIORITY_LOW => 180, PRIORITY_NEGLIGIBLE => 720];
$max_duration = $max_duration_defaults[$entry["priority"]];
$argv = json_decode($entry["parameter"]);
} elseif ($entry["priority"] != PRIORITY_CRITICAL) {
$new_priority = PRIORITY_NEGLIGIBLE;
}
- dba::update('workerqueue',
- array('executed' => NULL_DATE, 'created' => datetime_convert(), 'priority' => $new_priority, 'pid' => 0),
- array('id' => $entry["id"]));
+ dba::update(
+ 'workerqueue',
+ ['executed' => NULL_DATE, 'created' => datetime_convert(), 'priority' => $new_priority, 'pid' => 0],
+ ['id' => $entry["id"]]
+ );
} else {
logger("Worker process ".$entry["pid"]." (".implode(" ", $argv).") now runs for ".round($duration)." of ".$max_duration." allowed minutes. That's okay.", LOGGER_DEBUG);
}
*
* @return bool Are there too much workers running?
*/
- public static function tooMuchWorkers() {
+ public static function tooMuchWorkers()
+ {
$queues = Config::get("system", "worker_queues", 4);
$maxqueues = $queues;
$exponent = 3;
$slope = $maxworkers / pow($maxsysload, $exponent);
$queues = ceil($slope * pow(max(0, $maxsysload - $load), $exponent));
+ $processlist = '';
if (Config::get('system', 'worker_debug')) {
// Create a list of queue entries grouped by their priority
- $listitem = array();
+ $listitem = [];
// Adding all processes with no workerqueue entry
- $processes = dba::p("SELECT COUNT(*) AS `running` FROM `process` WHERE NOT EXISTS
+ $processes = dba::p(
+ "SELECT COUNT(*) AS `running` FROM `process` WHERE NOT EXISTS
(SELECT id FROM `workerqueue`
- WHERE `workerqueue`.`pid` = `process`.`pid` AND NOT `done` AND `pid` != ?)", getmypid());
+ WHERE `workerqueue`.`pid` = `process`.`pid` AND NOT `done` AND `pid` != ?)",
+ getmypid()
+ );
+
if ($process = dba::fetch($processes)) {
$listitem[0] = "0:".$process["running"];
}
}
dba::close($entries);
- $intervals = array(1, 10, 60);
- $jobs_per_minute = array();
- foreach ($intervals AS $interval) {
+ $intervals = [1, 10, 60];
+ $jobs_per_minute = [];
+ foreach ($intervals as $interval) {
$jobs = dba::p("SELECT COUNT(*) AS `jobs` FROM `workerqueue` WHERE `done` AND `executed` > UTC_TIMESTAMP() - INTERVAL ".intval($interval)." MINUTE");
if ($job = dba::fetch($jobs)) {
$jobs_per_minute[$interval] = number_format($job['jobs'] / $interval, 0);
}
/**
- * @brief Returns the number of active poller processes
+ * @brief Returns the number of active worker processes
*
- * @return integer Number of active poller processes
+ * @return integer Number of active worker processes
*/
- private static function activeWorkers() {
+ private static function activeWorkers()
+ {
$workers = dba::fetch_first("SELECT COUNT(*) AS `processes` FROM `process` WHERE `command` = 'Worker.php'");
return $workers["processes"];
* @param string $highest_priority Returns the currently highest priority
* @return bool We let pass a slower process than $highest_priority
*/
- private static function passingSlow(&$highest_priority) {
+ private static function passingSlow(&$highest_priority)
+ {
$highest_priority = 0;
- $r = dba::p("SELECT `priority`
+ $r = dba::p(
+ "SELECT `priority`
FROM `process`
- INNER JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid` AND NOT `done`");
+ INNER JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid` AND NOT `done`"
+ );
// No active processes at all? Fine
if (!DBM::is_result($r)) {
return false;
}
- $priorities = array();
+ $priorities = [];
while ($line = dba::fetch($r)) {
$priorities[] = $line["priority"];
}
return false;
}
$high = 0;
- foreach ($priorities AS $priority) {
+ foreach ($priorities as $priority) {
if ($priority == $highest_priority) {
++$high;
}
* @param boolean $passing_slow Returns if we had passed low priority processes
* @return boolean Have we found something?
*/
- private static function findWorkerProcesses(&$passing_slow) {
+ private static function findWorkerProcesses(&$passing_slow)
+ {
$mypid = getmypid();
// Check if we should pass some low priority process
if (self::passingSlow($highest_priority)) {
// Are there waiting processes with a higher priority than the currently highest?
- $result = dba::select('workerqueue', array('id'), array("`executed` <= ? AND `priority` < ? AND NOT `done`", NULL_DATE, $highest_priority),
- array('limit' => $limit, 'order' => array('priority', 'created'), 'only_query' => true));
+ $result = dba::select(
+ 'workerqueue',
+ ['id'],
+ ["`executed` <= ? AND `priority` < ? AND NOT `done`", NULL_DATE, $highest_priority],
+ ['limit' => $limit, 'order' => ['priority', 'created']]
+ );
while ($id = dba::fetch($result)) {
$ids[] = $id["id"];
if (!$found) {
// Give slower processes some processing time
- $result = dba::select('workerqueue', array('id'), array("`executed` <= ? AND `priority` > ? AND NOT `done`", NULL_DATE, $highest_priority),
- array('limit' => $limit, 'order' => array('priority', 'created'), 'only_query' => true));
+ $result = dba::select(
+ 'workerqueue',
+ ['id'],
+ ["`executed` <= ? AND `priority` > ? AND NOT `done`", NULL_DATE, $highest_priority],
+ ['limit' => $limit, 'order' => ['priority', 'created']]
+ );
while ($id = dba::fetch($result)) {
$ids[] = $id["id"];
// If there is no result (or we shouldn't pass lower processes) we check without priority limit
if (!$found) {
- $result = dba::select('workerqueue', array('id'), array("`executed` <= ? AND NOT `done`", NULL_DATE),
- array('limit' => $limit, 'order' => array('priority', 'created'), 'only_query' => true));
+ $result = dba::select(
+ 'workerqueue',
+ ['id'],
+ ["`executed` <= ? AND NOT `done`", NULL_DATE],
+ ['limit' => $limit, 'order' => ['priority', 'created']]
+ );
while ($id = dba::fetch($result)) {
$ids[] = $id["id"];
if ($found) {
$condition = "`id` IN (".substr(str_repeat("?, ", count($ids)), 0, -2).") AND `pid` = 0 AND NOT `done`";
array_unshift($ids, $condition);
- dba::update('workerqueue', array('executed' => datetime_convert(), 'pid' => $mypid), $ids);
+ dba::update('workerqueue', ['executed' => datetime_convert(), 'pid' => $mypid], $ids);
}
return $found;
* @param boolean $passing_slow Returns if we had passed low priority processes
* @return string SQL statement
*/
- public static function workerProcess(&$passing_slow) {
+ public static function workerProcess(&$passing_slow)
+ {
$stamp = (float)microtime(true);
// There can already be jobs for us in the queue.
- $r = dba::select('workerqueue', array(), array('pid' => getmypid(), 'done' => false));
+ $r = dba::select('workerqueue', [], ['pid' => getmypid(), 'done' => false]);
if (DBM::is_result($r)) {
self::$db_duration += (microtime(true) - $stamp);
return dba::inArray($r);
Lock::remove('poller_worker_process');
if ($found) {
- $r = dba::select('workerqueue', array(), array('pid' => getmypid(), 'done' => false));
+ $r = dba::select('workerqueue', [], ['pid' => getmypid(), 'done' => false]);
return dba::inArray($r);
}
return false;
/**
* @brief Removes a workerqueue entry from the current process
+ * @return void
*/
- public static function unclaimProcess() {
+ public static function unclaimProcess()
+ {
$mypid = getmypid();
- dba::update('workerqueue', array('executed' => NULL_DATE, 'pid' => 0), array('pid' => $mypid, 'done' => false));
+ dba::update('workerqueue', ['executed' => NULL_DATE, 'pid' => 0], ['pid' => $mypid, 'done' => false]);
}
/**
* @brief Call the front end worker
+ * @return void
*/
- public static function callWorker() {
+ public static function callWorker()
+ {
if (!Config::get("system", "frontend_worker")) {
return;
}
/**
* @brief Call the front end worker if there aren't any active
+ * @return void
*/
- public static function executeIfIdle() {
+ public static function executeIfIdle()
+ {
if (!Config::get("system", "frontend_worker")) {
return;
}
- // Do we have "proc_open"? Then we can fork the poller
+ // 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
self::runCron();
- logger('Call poller', LOGGER_DEBUG);
+ logger('Call worker', LOGGER_DEBUG);
self::spawnWorker();
return;
}
/**
* @brief Removes long running worker processes
+ * @return void
*/
- public static function clearProcesses() {
+ public static function clearProcesses()
+ {
$timeout = Config::get("system", "frontend_worker_timeout", 10);
/// @todo We should clean up the corresponding workerqueue entries as well
- $condition = array("`created` < ? AND `command` = 'worker.php'",
- datetime_convert('UTC','UTC',"now - ".$timeout." minutes"));
+ $condition = ["`created` < ? AND `command` = 'worker.php'",
+ datetime_convert('UTC', 'UTC', "now - ".$timeout." minutes")];
dba::delete('process', $condition);
}
/**
* @brief Runs the cron processes
+ * @return void
*/
- private static function runCron() {
+ private static function runCron()
+ {
logger('Add cron entries', LOGGER_DEBUG);
// Check for spooled items
- self::add(PRIORITY_HIGH, "spool_post");
+ self::add(PRIORITY_HIGH, "SpoolPost");
// Run the cron job that calls all other jobs
- self::add(PRIORITY_MEDIUM, "cron");
+ self::add(PRIORITY_MEDIUM, "Cron");
// Run the cronhooks job separately from cron for being able to use a different timing
self::add(PRIORITY_MEDIUM, "CronHooks");
self::killStaleWorkers();
}
- public static function spawnWorker() {
- $args = array("include/poller.php", "no_cron");
+ /**
+ * @return void
+ */
+ public static function spawnWorker()
+ {
+ $args = ["scripts/worker.php", "no_cron"];
get_app()->proc_run($args);
}
* @param (integer|array) priority or parameter array, strings are deprecated and are ignored
*
* next args are passed as $cmd command line
- * or: Worker::add(PRIORITY_HIGH, "notifier", "drop", $drop_id);
- * or: Worker::add(array('priority' => PRIORITY_HIGH, 'dont_fork' => true), "create_shadowentry", $post_id);
+ * or: Worker::add(PRIORITY_HIGH, "Notifier", "drop", $drop_id);
+ * or: Worker::add(array('priority' => PRIORITY_HIGH, 'dont_fork' => true), "CreateShadowEntry", $post_id);
*
* @note $cmd and string args are surrounded with ""
*
*
* @return boolean "false" if proc_run couldn't be executed
*/
- public static function add($cmd) {
+ public static function add($cmd)
+ {
$proc_args = func_get_args();
- $args = array();
+ $args = [];
if (!count($proc_args)) {
return false;
}
// Now we add the run parameters back to the array
array_unshift($args, $run_parameter);
- $arr = array('args' => $args, 'run_cmd' => true);
+ $arr = ['args' => $args, 'run_cmd' => true];
call_hooks("proc_run", $arr);
if (!$arr['run_cmd'] || !count($args)) {
array_shift($argv);
$parameters = json_encode($argv);
- $found = dba::exists('workerqueue', array('parameter' => $parameters, 'done' => false));
+ $found = dba::exists('workerqueue', ['parameter' => $parameters, 'done' => false]);
// Quit if there was a database error - a precaution for the update process to 3.5.3
if (dba::errorNo() != 0) {
}
if (!$found) {
- dba::insert('workerqueue', array('parameter' => $parameters, 'created' => $created, 'priority' => $priority));
+ dba::insert('workerqueue', ['parameter' => $parameters, 'created' => $created, 'priority' => $priority]);
}
- // Should we quit and wait for the poller to be called as a cronjob?
+ // Should we quit and wait for the worker to be called as a cronjob?
if ($dont_fork) {
return true;
}
return true;
}
- // Now call the poller to execute the jobs that we just added to the queue
+ // Now call the worker to execute the jobs that we just added to the queue
self::spawnWorker();
return true;