includes/db/LBFactory_Multi.php

   1 <?php
   2 /**
   3  * Advanced generator of database load balancing objects for wiki farms
   4  *
   5  * @file
   6  * @ingroup Database
   7  */
   8
   9
  10 /**
  11  * A multi-wiki, multi-master factory for Wikimedia and similar installations.
  12  * Ignores the old configuration globals
  13  *
  14  * Configuration:
  15  *     sectionsByDB                A map of database names to section names
  16  *
  17  *     sectionLoads                A 2-d map. For each section, gives a map of server names to load ratios.
  18  *                                 For example: array( 'section1' => array( 'db1' => 100, 'db2' => 100 ) )
  19  *
  20  *     serverTemplate              A server info associative array as documented for $wgDBservers. The host,
  21  *                                 hostName and load entries will be overridden.
  22  *
  23  *     groupLoadsBySection         A 3-d map giving server load ratios for each section and group. For example:
  24  *                                 array( 'section1' => array( 'group1' => array( 'db1' => 100, 'db2' => 100 ) ) )
  25  *
  26  *     groupLoadsByDB              A 3-d map giving server load ratios by DB name.
  27  *
  28  *     hostsByName                 A map of hostname to IP address.
  29  *
  30  *     externalLoads               A map of external storage cluster name to server load map
  31  *
  32  *     externalTemplateOverrides   A set of server info keys overriding serverTemplate for external storage
  33  *
  34  *     templateOverridesByServer   A 2-d map overriding serverTemplate and externalTemplateOverrides on a
  35  *                                 server-by-server basis. Applies to both core and external storage.
  36  *
  37  *     templateOverridesByCluster  A 2-d map overriding the server info by external storage cluster
  38  *
  39  *     masterTemplateOverrides     An override array for all master servers.
  40  *
  41  *     readOnlyBySection           A map of section name to read-only message. Missing or false for read/write.
  42  *
  43  * @ingroup Database
  44  */
  45 class LBFactory_Multi extends LBFactory {
  46         // Required settings
  47         var $sectionsByDB, $sectionLoads, $serverTemplate;
  48         // Optional settings
  49         var $groupLoadsBySection = array(), $groupLoadsByDB = array(), $hostsByName = array();
  50         var $externalLoads = array(), $externalTemplateOverrides, $templateOverridesByServer;
  51         var $templateOverridesByCluster, $masterTemplateOverrides, $readOnlyBySection = array();
  52         // Other stuff
  53         var $conf, $mainLBs = array(), $extLBs = array();
  54         var $lastWiki, $lastSection;
  55
  56         function __construct( $conf ) {
  57                 $this->chronProt = new ChronologyProtector;
  58                 $this->conf = $conf;
  59                 $required = array( 'sectionsByDB', 'sectionLoads', 'serverTemplate' );
  60                 $optional = array( 'groupLoadsBySection', 'groupLoadsByDB', 'hostsByName',
  61                         'externalLoads', 'externalTemplateOverrides', 'templateOverridesByServer',
  62                         'templateOverridesByCluster', 'masterTemplateOverrides',
  63                         'readOnlyBySection' );
  64
  65                 foreach ( $required as $key ) {
  66                         if ( !isset( $conf[$key] ) ) {
  67                                 throw new MWException( __CLASS__.": $key is required in configuration" );
  68                         }
  69                         $this->$key = $conf[$key];
  70                 }
  71
  72                 foreach ( $optional as $key ) {
  73                         if ( isset( $conf[$key] ) ) {
  74                                 $this->$key = $conf[$key];
  75                         }
  76                 }
  77
  78                 // Check for read-only mode
  79                 $section = $this->getSectionForWiki();
  80                 if ( !empty( $this->readOnlyBySection[$section] ) ) {
  81                         global $wgReadOnly;
  82                         $wgReadOnly = $this->readOnlyBySection[$section];
  83                 }
  84         }
  85
  86         function getSectionForWiki( $wiki = false ) {
  87                 if ( $this->lastWiki === $wiki ) {
  88                         return $this->lastSection;
  89                 }
  90                 list( $dbName, ) = $this->getDBNameAndPrefix( $wiki );
  91                 if ( isset( $this->sectionsByDB[$dbName] ) ) {
  92                         $section = $this->sectionsByDB[$dbName];
  93                 } else {
  94                         $section = 'DEFAULT';
  95                 }
  96                 $this->lastSection = $section;
  97                 $this->lastWiki = $wiki;
  98                 return $section;
  99         }
 100
 101         /**
 102          * @param $wiki string
 103          * @return LoadBalancer
 104          */
 105         function newMainLB( $wiki = false ) {
 106                 list( $dbName, ) = $this->getDBNameAndPrefix( $wiki );
 107                 $section = $this->getSectionForWiki( $wiki );
 108                 $groupLoads = array();
 109                 if ( isset( $this->groupLoadsByDB[$dbName] ) ) {
 110                         $groupLoads = $this->groupLoadsByDB[$dbName];
 111                 }
 112                 if ( isset( $this->groupLoadsBySection[$section] ) ) {
 113                         $groupLoads = array_merge_recursive( $groupLoads, $this->groupLoadsBySection[$section] );
 114                 }
 115                 return $this->newLoadBalancer( $this->serverTemplate, $this->sectionLoads[$section], $groupLoads );
 116         }
 117
 118         /**
 119          * @param $wiki
 120          * @return LoadBalancer
 121          */
 122         function getMainLB( $wiki = false ) {
 123                 $section = $this->getSectionForWiki( $wiki );
 124                 if ( !isset( $this->mainLBs[$section] ) ) {
 125                         $lb = $this->newMainLB( $wiki, $section );
 126                         $this->chronProt->initLB( $lb );
 127                         $lb->parentInfo( array( 'id' => "main-$section" ) );
 128                         $this->mainLBs[$section] = $lb;
 129                 }
 130                 return $this->mainLBs[$section];
 131         }
 132
 133         /**
 134          * @param $cluster
 135          * @param $wiki
 136          * @return LoadBalancer
 137          */
 138         function newExternalLB( $cluster, $wiki = false ) {
 139                 if ( !isset( $this->externalLoads[$cluster] ) ) {
 140                         throw new MWException( __METHOD__.": Unknown cluster \"$cluster\"" );
 141                 }
 142                 $template = $this->serverTemplate;
 143                 if ( isset( $this->externalTemplateOverrides ) ) {
 144                         $template = $this->externalTemplateOverrides + $template;
 145                 }
 146                 if ( isset( $this->templateOverridesByCluster[$cluster] ) ) {
 147                         $template = $this->templateOverridesByCluster[$cluster] + $template;
 148                 }
 149                 return $this->newLoadBalancer( $template, $this->externalLoads[$cluster], array() );
 150         }
 151
 152         /**
 153          * @param $cluster
 154          * @param $wiki
 155          * @return LoadBalancer
 156          */
 157         function &getExternalLB( $cluster, $wiki = false ) {
 158                 if ( !isset( $this->extLBs[$cluster] ) ) {
 159                         $this->extLBs[$cluster] = $this->newExternalLB( $cluster, $wiki );
 160                         $this->extLBs[$cluster]->parentInfo( array( 'id' => "ext-$cluster" ) );
 161                 }
 162                 return $this->extLBs[$cluster];
 163         }
 164
 165         /**
 166          * Make a new load balancer object based on template and load array
 167          *
 168          * @return LoadBalancer
 169          */
 170         function newLoadBalancer( $template, $loads, $groupLoads ) {
 171                 global $wgMasterWaitTimeout;
 172                 $servers = $this->makeServerArray( $template, $loads, $groupLoads );
 173                 $lb = new LoadBalancer( array(
 174                         'servers' => $servers,
 175                         'masterWaitTimeout' => $wgMasterWaitTimeout
 176                 ));
 177                 return $lb;
 178         }
 179
 180         /**
 181          * Make a server array as expected by LoadBalancer::__construct, using a template and load array
 182          *
 183          * @return array
 184          */
 185         function makeServerArray( $template, $loads, $groupLoads ) {
 186                 $servers = array();
 187                 $master = true;
 188                 $groupLoadsByServer = $this->reindexGroupLoads( $groupLoads );
 189                 foreach ( $groupLoadsByServer as $server => $stuff ) {
 190                         if ( !isset( $loads[$server] ) ) {
 191                                 $loads[$server] = 0;
 192                         }
 193                 }
 194                 foreach ( $loads as $serverName => $load ) {
 195                         $serverInfo = $template;
 196                         if ( $master ) {
 197                                 $serverInfo['master'] = true;
 198                                 if ( isset( $this->masterTemplateOverrides ) ) {
 199                                         $serverInfo = $this->masterTemplateOverrides + $serverInfo;
 200                                 }
 201                                 $master = false;
 202                         }
 203                         if ( isset( $this->templateOverridesByServer[$serverName] ) ) {
 204                                 $serverInfo = $this->templateOverridesByServer[$serverName] + $serverInfo;
 205                         }
 206                         if ( isset( $groupLoadsByServer[$serverName] ) ) {
 207                                 $serverInfo['groupLoads'] = $groupLoadsByServer[$serverName];
 208                         }
 209                         if ( isset( $this->hostsByName[$serverName] ) ) {
 210                                 $serverInfo['host'] = $this->hostsByName[$serverName];
 211                         } else {
 212                                 $serverInfo['host'] = $serverName;
 213                         }
 214                         $serverInfo['hostName'] = $serverName;
 215                         $serverInfo['load'] = $load;
 216                         $servers[] = $serverInfo;
 217                 }
 218                 return $servers;
 219         }
 220
 221         /**
 222          * Take a group load array indexed by group then server, and reindex it by server then group
 223          */
 224         function reindexGroupLoads( $groupLoads ) {
 225                 $reindexed = array();
 226                 foreach ( $groupLoads as $group => $loads ) {
 227                         foreach ( $loads as $server => $load ) {
 228                                 $reindexed[$server][$group] = $load;
 229                         }
 230                 }
 231                 return $reindexed;
 232         }
 233
 234         /**
 235          * Get the database name and prefix based on the wiki ID
 236          */
 237         function getDBNameAndPrefix( $wiki = false ) {
 238                 if ( $wiki === false ) {
 239                         global $wgDBname, $wgDBprefix;
 240                         return array( $wgDBname, $wgDBprefix );
 241                 } else {
 242                         return wfSplitWikiID( $wiki );
 243                 }
 244         }
 245
 246         /**
 247          * Execute a function for each tracked load balancer
 248          * The callback is called with the load balancer as the first parameter,
 249          * and $params passed as the subsequent parameters.
 250          */
 251         function forEachLB( $callback, $params = array() ) {
 252                 foreach ( $this->mainLBs as $lb ) {
 253                         call_user_func_array( $callback, array_merge( array( $lb ), $params ) );
 254                 }
 255                 foreach ( $this->extLBs as $lb ) {
 256                         call_user_func_array( $callback, array_merge( array( $lb ), $params ) );
 257                 }
 258         }
 259
 260         function shutdown() {
 261                 foreach ( $this->mainLBs as $lb ) {
 262                         $this->chronProt->shutdownLB( $lb );
 263                 }
 264                 $this->chronProt->shutdown();
 265                 $this->commitMasterChanges();
 266         }
 267 }