lib/iomaster.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * I/O manager to wrap around socket-reading and polling queue & connection managers.
   6  *
   7  * PHP version 5
   8  *
   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.
  13  *
  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.
  18  *
  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/>.
  21  *
  22  * @category  QueueManager
  23  * @package   StatusNet
  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/
  28  */
  29
  30 abstract class IoMaster
  31 {
  32     public $id;
  33
  34     protected $multiSite = false;
  35     protected $managers = array();
  36     protected $singletons = array();
  37
  38     protected $pollTimeouts = array();
  39     protected $lastPoll = array();
  40
  41     /**
  42      * @param string $id process ID to use in logging/monitoring
  43      */
  44     public function __construct($id)
  45     {
  46         $this->id = $id;
  47         $this->monitor = new QueueMonitor();
  48     }
  49
  50     public function init($multiSite=null)
  51     {
  52         if ($multiSite !== null) {
  53             $this->multiSite = $multiSite;
  54         }
  55         if ($this->multiSite) {
  56             $this->sites = $this->findAllSites();
  57         } else {
  58             $this->sites = array(common_config('site', 'server'));
  59         }
  60
  61         if (empty($this->sites)) {
  62             throw new Exception("Empty status_network table, cannot init");
  63         }
  64
  65         foreach ($this->sites as $site) {
  66             if ($site != common_config('site', 'server')) {
  67                 StatusNet::init($site);
  68             }
  69             $this->initManagers();
  70         }
  71     }
  72
  73     /**
  74      * Initialize IoManagers for the currently configured site
  75      * which are appropriate to this instance.
  76      *
  77      * Pass class names into $this->instantiate()
  78      */
  79     abstract function initManagers();
  80
  81     /**
  82      * Pull all local sites from status_network table.
  83      * @return array of hostnames
  84      */
  85     protected function findAllSites()
  86     {
  87         $hosts = array();
  88         $sn = new Status_network();
  89         $sn->find();
  90         while ($sn->fetch()) {
  91             $hosts[] = $sn->hostname;
  92         }
  93         return $hosts;
  94     }
  95
  96     /**
  97      * Instantiate an i/o manager class for the current site.
  98      * If a multi-site capable handler is already present,
  99      * we don't need to build a new one.
 100      *
 101      * @param string $class
 102      */
 103     protected function instantiate($class)
 104     {
 105         if (is_string($class) && isset($this->singletons[$class])) {
 106             // Already instantiated a multi-site-capable handler.
 107             // Just let it know it should listen to this site too!
 108             $this->singletons[$class]->addSite(common_config('site', 'server'));
 109             return;
 110         }
 111
 112         $manager = $this->getManager($class);
 113
 114         if ($this->multiSite) {
 115             $caps = $manager->multiSite();
 116             if ($caps == IoManager::SINGLE_ONLY) {
 117                 throw new Exception("$class can't run with --all; aborting.");
 118             }
 119             if ($caps == IoManager::INSTANCE_PER_PROCESS) {
 120                 // Save this guy for later!
 121                 // We'll only need the one to cover multiple sites.
 122                 $this->singletons[$class] = $manager;
 123                 $manager->addSite(common_config('site', 'server'));
 124             }
 125         }
 126
 127         $this->managers[] = $manager;
 128     }
 129
 130     protected function getManager($class)
 131     {
 132         if(is_object($class)){
 133             return $class;
 134         } else {
 135             return call_user_func(array($class, 'get'));
 136         }
 137     }
 138
 139     /**
 140      * Basic run loop...
 141      *
 142      * Initialize all io managers, then sit around waiting for input.
 143      * Between events or timeouts, pass control back to idle() method
 144      * to allow for any additional background processing.
 145      */
 146     function service()
 147     {
 148         $this->logState('init');
 149         $this->start();
 150
 151         while (true) {
 152             $timeouts = array_values($this->pollTimeouts);
 153             $timeouts[] = 60; // default max timeout
 154
 155             // Wait for something on one of our sockets
 156             $sockets = array();
 157             $managers = array();
 158             foreach ($this->managers as $manager) {
 159                 foreach ($manager->getSockets() as $socket) {
 160                     $sockets[] = $socket;
 161                     $managers[] = $manager;
 162                 }
 163                 $timeouts[] = intval($manager->timeout());
 164             }
 165
 166             $timeout = min($timeouts);
 167             if ($sockets) {
 168                 $read = $sockets;
 169                 $write = array();
 170                 $except = array();
 171                 $this->logState('listening');
 172                 common_log(LOG_DEBUG, "Waiting up to $timeout seconds for socket data...");
 173                 $ready = stream_select($read, $write, $except, $timeout, 0);
 174
 175                 if ($ready === false) {
 176                     common_log(LOG_ERR, "Error selecting on sockets");
 177                 } else if ($ready > 0) {
 178                     foreach ($read as $socket) {
 179                         $index = array_search($socket, $sockets, true);
 180                         if ($index !== false) {
 181                             $this->logState('queue');
 182                             $managers[$index]->handleInput($socket);
 183                         } else {
 184                             common_log(LOG_ERR, "Saw input on a socket we didn't listen to");
 185                         }
 186                     }
 187                 }
 188             }
 189
 190             if ($timeout > 0 && empty($sockets)) {
 191                 // If we had no listeners, sleep until the pollers' next requested wakeup.
 192                 common_log(LOG_DEBUG, "Sleeping $timeout seconds until next poll cycle...");
 193                 $this->logState('sleep');
 194                 sleep($timeout);
 195             }
 196
 197             $this->logState('poll');
 198             $this->poll();
 199
 200             $this->logState('idle');
 201             $this->idle();
 202
 203             $memoryLimit = $this->softMemoryLimit();
 204             if ($memoryLimit > 0) {
 205                 $usage = memory_get_usage();
 206                 if ($usage > $memoryLimit) {
 207                     common_log(LOG_INFO, "Queue thread hit soft memory limit ($usage > $memoryLimit); gracefully restarting.");
 208                     break;
 209                 } else if (common_config('queue', 'debug_memory')) {
 210                     common_log(LOG_DEBUG, "Memory usage $usage");
 211                 }
 212             }
 213         }
 214
 215         $this->logState('shutdown');
 216         $this->finish();
 217     }
 218
 219     /**
 220      * Return fully-parsed soft memory limit in bytes.
 221      * @return intval 0 or -1 if not set
 222      */
 223     function softMemoryLimit()
 224     {
 225         $softLimit = trim(common_config('queue', 'softlimit'));
 226         if (substr($softLimit, -1) == '%') {
 227             $limit = $this->parseMemoryLimit(ini_get('memory_limit'));
 228             if ($limit > 0) {
 229                 return intval(substr($softLimit, 0, -1) * $limit / 100);
 230             } else {
 231                 return -1;
 232             }
 233         } else {
 234             return $this->parseMemoryLimit($softLimit);
 235         }
 236         return $softLimit;
 237     }
 238
 239     /**
 240      * Interpret PHP shorthand for memory_limit and friends.
 241      * Why don't they just expose the actual numeric value? :P
 242      * @param string $mem
 243      * @return int
 244      */
 245     public function parseMemoryLimit($mem)
 246     {
 247         // http://www.php.net/manual/en/faq.using.php#faq.using.shorthandbytes
 248         $mem = strtolower(trim($mem));
 249         $size = array('k' => 1024,
 250                       'm' => 1024*1024,
 251                       'g' => 1024*1024*1024);
 252         if (empty($mem)) {
 253             return 0;
 254         } else if (is_numeric($mem)) {
 255             return intval($mem);
 256         } else {
 257             $mult = substr($mem, -1);
 258             if (isset($size[$mult])) {
 259                 return substr($mem, 0, -1) * $size[$mult];
 260             } else {
 261                 return intval($mem);
 262             }
 263         }
 264     }
 265
 266     function start()
 267     {
 268         foreach ($this->managers as $index => $manager) {
 269             $manager->start($this);
 270             // @fixme error check
 271             if ($manager->pollInterval()) {
 272                 // We'll want to check for input on the first pass
 273                 $this->pollTimeouts[$index] = 0;
 274                 $this->lastPoll[$index] = 0;
 275             }
 276         }
 277     }
 278
 279     function finish()
 280     {
 281         foreach ($this->managers as $manager) {
 282             $manager->finish();
 283             // @fixme error check
 284         }
 285     }
 286
 287     /**
 288      * Called during the idle portion of the runloop to see which handlers
 289      */
 290     function poll()
 291     {
 292         foreach ($this->managers as $index => $manager) {
 293             $interval = $manager->pollInterval();
 294             if ($interval <= 0) {
 295                 // Not a polling manager.
 296                 continue;
 297             }
 298
 299             if (isset($this->pollTimeouts[$index])) {
 300                 $timeout = $this->pollTimeouts[$index];
 301                 if (time() - $this->lastPoll[$index] < $timeout) {
 302                     // Not time to poll yet.
 303                     continue;
 304                 }
 305             } else {
 306                 $timeout = 0;
 307             }
 308             $hit = $manager->poll();
 309
 310             $this->lastPoll[$index] = time();
 311             if ($hit) {
 312                 // Do the next poll quickly, there may be more input!
 313                 $this->pollTimeouts[$index] = 0;
 314             } else {
 315                 // Empty queue. Exponential backoff up to the maximum poll interval.
 316                 if ($timeout > 0) {
 317                     $timeout = min($timeout * 2, $interval);
 318                 } else {
 319                     $timeout = 1;
 320                 }
 321                 $this->pollTimeouts[$index] = $timeout;
 322             }
 323         }
 324     }
 325
 326     /**
 327      * Called after each handled item or empty polling cycle.
 328      * This is a good time to e.g. service your XMPP connection.
 329      */
 330     function idle()
 331     {
 332         foreach ($this->managers as $manager) {
 333             $manager->idle();
 334         }
 335     }
 336
 337     /**
 338      * Send thread state update to the monitoring server, if configured.
 339      *
 340      * @param string $state ('init', 'queue', 'shutdown' etc)
 341      * @param string $substate (optional, eg queue name 'omb' 'sms' etc)
 342      */
 343     protected function logState($state, $substate='')
 344     {
 345         $this->monitor->logState($this->id, $state, $substate);
 346     }
 347
 348     /**
 349      * Send thread stats.
 350      * Thread ID will be implicit; other owners can be listed as well
 351      * for per-queue and per-site records.
 352      *
 353      * @param string $key counter name
 354      * @param array $owners list of owner keys like 'queue:xmpp' or 'site:stat01'
 355      */
 356     public function stats($key, $owners=array())
 357     {
 358         $owners[] = "thread:" . $this->id;
 359         $this->monitor->stats($key, $owners);
 360     }
 361 }
 362