3 * StatusNet, the distributed open-source microblogging tool
5 * I/O manager to wrap around socket-reading and polling queue & connection managers.
9 * LICENCE: This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU Affero General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Affero General Public License for more details.
19 * You should have received a copy of the GNU Affero General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
22 * @category QueueManager
24 * @author Brion Vibber <brion@status.net>
25 * @copyright 2009 StatusNet, Inc.
26 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
27 * @link http://status.net/
34 protected $multiSite = false;
35 protected $managers = array();
36 protected $singletons = array();
38 protected $pollTimeouts = array();
39 protected $lastPoll = array();
42 * @param string $id process ID to use in logging/monitoring
44 public function __construct($id)
47 $this->monitor = new QueueMonitor();
50 public function init($multiSite=null)
52 if ($multiSite !== null) {
53 $this->multiSite = $multiSite;
55 if ($this->multiSite) {
56 $this->sites = $this->findAllSites();
58 $this->sites = array(common_config('site', 'server'));
61 if (empty($this->sites)) {
62 throw new Exception("Empty status_network table, cannot init");
65 foreach ($this->sites as $site) {
66 if ($site != common_config('site', 'server')) {
67 StatusNet::init($site);
71 if (Event::handle('StartIoManagerClasses', array(&$classes))) {
72 $classes[] = 'QueueManager';
73 if (common_config('xmpp', 'enabled') && !defined('XMPP_EMERGENCY_FLAG')) {
74 $classes[] = 'XmppManager'; // handles pings/reconnects
75 $classes[] = 'XmppConfirmManager'; // polls for outgoing confirmations
78 Event::handle('EndIoManagerClasses', array(&$classes));
80 foreach ($classes as $class) {
81 $this->instantiate($class);
87 * Pull all local sites from status_network table.
88 * @return array of hostnames
90 protected function findAllSites()
93 $sn = new Status_network();
95 while ($sn->fetch()) {
96 $hosts[] = $sn->hostname;
102 * Instantiate an i/o manager class for the current site.
103 * If a multi-site capable handler is already present,
104 * we don't need to build a new one.
106 * @param string $class
108 protected function instantiate($class)
110 if (isset($this->singletons[$class])) {
111 // Already instantiated a multi-site-capable handler.
112 // Just let it know it should listen to this site too!
113 $this->singletons[$class]->addSite(common_config('site', 'server'));
117 $manager = $this->getManager($class);
119 if ($this->multiSite) {
120 $caps = $manager->multiSite();
121 if ($caps == IoManager::SINGLE_ONLY) {
122 throw new Exception("$class can't run with --all; aborting.");
124 if ($caps == IoManager::INSTANCE_PER_PROCESS) {
125 // Save this guy for later!
126 // We'll only need the one to cover multiple sites.
127 $this->singletons[$class] = $manager;
128 $manager->addSite(common_config('site', 'server'));
132 $this->managers[] = $manager;
135 protected function getManager($class)
137 return call_user_func(array($class, 'get'));
143 * Initialize all io managers, then sit around waiting for input.
144 * Between events or timeouts, pass control back to idle() method
145 * to allow for any additional background processing.
149 $this->logState('init');
153 $timeouts = array_values($this->pollTimeouts);
154 $timeouts[] = 60; // default max timeout
156 // Wait for something on one of our sockets
159 foreach ($this->managers as $manager) {
160 foreach ($manager->getSockets() as $socket) {
161 $sockets[] = $socket;
162 $managers[] = $manager;
164 $timeouts[] = intval($manager->timeout());
167 $timeout = min($timeouts);
172 $this->logState('listening');
173 common_log(LOG_INFO, "Waiting up to $timeout seconds for socket data...");
174 $ready = stream_select($read, $write, $except, $timeout, 0);
176 if ($ready === false) {
177 common_log(LOG_ERR, "Error selecting on sockets");
178 } else if ($ready > 0) {
179 foreach ($read as $socket) {
180 $index = array_search($socket, $sockets, true);
181 if ($index !== false) {
182 $this->logState('queue');
183 $managers[$index]->handleInput($socket);
185 common_log(LOG_ERR, "Saw input on a socket we didn't listen to");
191 if ($timeout > 0 && empty($sockets)) {
192 // If we had no listeners, sleep until the pollers' next requested wakeup.
193 common_log(LOG_INFO, "Sleeping $timeout seconds until next poll cycle...");
194 $this->logState('sleep');
198 $this->logState('poll');
201 $this->logState('idle');
204 $memoryLimit = $this->softMemoryLimit();
205 if ($memoryLimit > 0) {
206 $usage = memory_get_usage();
207 if ($usage > $memoryLimit) {
208 common_log(LOG_INFO, "Queue thread hit soft memory limit ($usage > $memoryLimit); gracefully restarting.");
214 $this->logState('shutdown');
219 * Return fully-parsed soft memory limit in bytes.
220 * @return intval 0 or -1 if not set
222 function softMemoryLimit()
224 $softLimit = trim(common_config('queue', 'softlimit'));
225 if (substr($softLimit, -1) == '%') {
226 $limit = trim(ini_get('memory_limit'));
227 $limit = $this->parseMemoryLimit($limit);
229 return intval(substr($softLimit, 0, -1) * $limit / 100);
234 return $this->parseMemoryLimit($softLimit);
240 * Interpret PHP shorthand for memory_limit and friends.
241 * Why don't they just expose the actual numeric value? :P
245 protected function parseMemoryLimit($mem)
247 // http://www.php.net/manual/en/faq.using.php#faq.using.shorthandbytes
248 $size = array('k' => 1024,
250 'g' => 1024*1024*1024);
253 } else if (is_numeric($mem)) {
256 $mult = strtolower(substr($mem, -1));
257 if (isset($size[$mult])) {
258 return substr($mem, 0, -1) * $size[$mult];
267 foreach ($this->managers as $index => $manager) {
268 $manager->start($this);
269 // @fixme error check
270 if ($manager->pollInterval()) {
271 // We'll want to check for input on the first pass
272 $this->pollTimeouts[$index] = 0;
273 $this->lastPoll[$index] = 0;
280 foreach ($this->managers as $manager) {
282 // @fixme error check
287 * Called during the idle portion of the runloop to see which handlers
291 foreach ($this->managers as $index => $manager) {
292 $interval = $manager->pollInterval();
293 if ($interval <= 0) {
294 // Not a polling manager.
298 if (isset($this->pollTimeouts[$index])) {
299 $timeout = $this->pollTimeouts[$index];
300 if (time() - $this->lastPoll[$index] < $timeout) {
301 // Not time to poll yet.
307 $hit = $manager->poll();
309 $this->lastPoll[$index] = time();
311 // Do the next poll quickly, there may be more input!
312 $this->pollTimeouts[$index] = 0;
314 // Empty queue. Exponential backoff up to the maximum poll interval.
316 $timeout = min($timeout * 2, $interval);
320 $this->pollTimeouts[$index] = $timeout;
326 * Called after each handled item or empty polling cycle.
327 * This is a good time to e.g. service your XMPP connection.
331 foreach ($this->managers as $manager) {
337 * Send thread state update to the monitoring server, if configured.
339 * @param string $state ('init', 'queue', 'shutdown' etc)
340 * @param string $substate (optional, eg queue name 'omb' 'sms' etc)
342 protected function logState($state, $substate='')
344 $this->monitor->logState($this->id, $state, $substate);
349 * Thread ID will be implicit; other owners can be listed as well
350 * for per-queue and per-site records.
352 * @param string $key counter name
353 * @param array $owners list of owner keys like 'queue:jabber' or 'site:stat01'
355 public function stats($key, $owners=array())
357 $owners[] = "thread:" . $this->id;
358 $this->monitor->stats($key, $owners);