lib/spawningdaemon.php

   1 <?php
   2 /*
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2010, StatusNet, Inc.
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU Affero General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU Affero General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Affero General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 /**
  21  * Base class for daemon that can launch one or more processing threads,
  22  * respawning them if they exit.
  23  *
  24  * This is mainly intended for indefinite workloads such as monitoring
  25  * a queue or maintaining an IM channel.
  26  *
  27  * Child classes should implement the
  28  *
  29  * We can then pass individual items through the QueueHandler subclasses
  30  * they belong to. We additionally can handle queues for multiple sites.
  31  *
  32  * @package QueueHandler
  33  * @author Brion Vibber <brion@status.net>
  34  */
  35 abstract class SpawningDaemon extends Daemon
  36 {
  37     protected $threads=1;
  38
  39     const EXIT_OK = 0;
  40     const EXIT_ERR = 1;
  41     const EXIT_SHUTDOWN = 100;
  42     const EXIT_RESTART = 101;
  43
  44     function __construct($id=null, $daemonize=true, $threads=1)
  45     {
  46         parent::__construct($daemonize);
  47
  48         if ($id) {
  49             $this->set_id($id);
  50         }
  51         $this->threads = $threads;
  52     }
  53
  54     /**
  55      * Perform some actual work!
  56      *
  57      * @return int exit code; use self::EXIT_SHUTDOWN to request not to respawn.
  58      */
  59     public abstract function runThread();
  60
  61     /**
  62      * Spawn one or more background processes and let them start running.
  63      * Each individual process will execute whatever's in the runThread()
  64      * method, which should be overridden.
  65      *
  66      * Child processes will be automatically respawned when they exit.
  67      *
  68      * @todo possibly allow for not respawning on "normal" exits...
  69      *       though ParallelizingDaemon is probably better for workloads
  70      *       that have forseeable endpoints.
  71      */
  72     function run()
  73     {
  74         $children = array();
  75         for ($i = 1; $i <= $this->threads; $i++) {
  76             $pid = pcntl_fork();
  77             if ($pid < 0) {
  78                 $this->log(LOG_ERROR, "Couldn't fork for thread $i; aborting\n");
  79                 exit(1);
  80             } else if ($pid == 0) {
  81                 $this->initAndRunChild($i);
  82             } else {
  83                 $this->log(LOG_INFO, "Spawned thread $i as pid $pid");
  84                 $children[$i] = $pid;
  85             }
  86         }
  87
  88         $this->log(LOG_INFO, "Waiting for children to complete.");
  89         while (count($children) > 0) {
  90             $status = null;
  91             $pid = pcntl_wait($status);
  92             if ($pid > 0 && pcntl_wifexited($status)) {
  93                 $exitCode = pcntl_wexitstatus($status);
  94
  95                 $i = array_search($pid, $children);
  96                 if ($i === false) {
  97                     $this->log(LOG_ERR, "Unrecognized child pid $pid exited with status $exitCode");
  98                     continue;
  99                 }
 100                 unset($children[$i]);
 101
 102                 if ($this->shouldRespawn($exitCode)) {
 103                     $this->log(LOG_INFO, "Thread $i pid $pid exited with status $exitCode; respawing.");
 104
 105                     $pid = pcntl_fork();
 106                     if ($pid < 0) {
 107                         $this->log(LOG_ERROR, "Couldn't fork to respawn thread $i; aborting thread.\n");
 108                     } else if ($pid == 0) {
 109                         $this->initAndRunChild($i);
 110                     } else {
 111                         $this->log(LOG_INFO, "Respawned thread $i as pid $pid");
 112                         $children[$i] = $pid;
 113                     }
 114                 } else {
 115                     $this->log(LOG_INFO, "Thread $i pid $pid exited with status $exitCode; closing out thread.");
 116                 }
 117             }
 118         }
 119         $this->log(LOG_INFO, "All child processes complete.");
 120         return true;
 121     }
 122
 123     /**
 124      * Determine whether to respawn an exited subprocess based on its exit code.
 125      * Otherwise we'll respawn all exits by default.
 126      *
 127      * @param int $exitCode
 128      * @return boolean true to respawn
 129      */
 130     protected function shouldRespawn($exitCode)
 131     {
 132         if ($exitCode == self::EXIT_SHUTDOWN) {
 133             // Thread requested a clean shutdown.
 134             return false;
 135         } else {
 136             // Otherwise we should always respawn!
 137             return true;
 138         }
 139     }
 140
 141     /**
 142      * Initialize things for a fresh thread, call runThread(), and
 143      * exit at completion with appropriate return value.
 144      */
 145     protected function initAndRunChild($thread)
 146     {
 147         $this->set_id($this->get_id() . "." . $thread);
 148         $this->resetDb();
 149         $exitCode = $this->runThread();
 150         exit($exitCode);
 151     }
 152
 153     /**
 154      * Reconnect to the database for each child process,
 155      * or they'll get very confused trying to use the
 156      * same socket.
 157      */
 158     protected function resetDb()
 159     {
 160         // @fixme do we need to explicitly open the db too
 161         // or is this implied?
 162         global $_DB_DATAOBJECT;
 163         unset($_DB_DATAOBJECT['CONNECTIONS']);
 164
 165         // Reconnect main memcached, or threads will stomp on
 166         // each other and corrupt their requests.
 167         $cache = common_memcache();
 168         if ($cache) {
 169             $cache->reconnect();
 170         }
 171
 172         // Also reconnect memcached for status_network table.
 173         if (!empty(Status_network::$cache)) {
 174             Status_network::$cache->close();
 175             Status_network::$cache = null;
 176         }
 177     }
 178
 179     function log($level, $msg)
 180     {
 181         common_log($level, get_class($this) . ' ('. $this->get_id() .'): '.$msg);
 182     }
 183
 184     function name()
 185     {
 186         return strtolower(get_class($this).'.'.$this->get_id());
 187     }
 188 }
 189