dmemcache.inc 20.9 KB
Newer Older
1 2 3 4 5 6 7 8 9 10
<?php

/*
 * Core dmemcache functions required by:
 *   memcache.inc
 *   memcache.db.inc
 *   session-memcache.inc
 *   session-memcache.db.inc
 */

11 12
global $_dmemcache_stats;
$_dmemcache_stats = array('all' => array(), 'ops' => array());
13 14 15 16 17 18 19 20

/*
 * A memcache API for Drupal.
 */

/**
 *  Place an item into memcache
 *
21
 * @param $key The string with which you will retrieve this item later.
22
 * @param $value The item to be stored.
23 24 25 26 27 28 29 30 31
 * @param $exp Parameter expire is expiration time in seconds. If it's 0, the
 *   item never expires (but memcached server doesn't guarantee this item to be
 *   stored all the time, it could be deleted from the cache to make place for
 *   other items).
 * @param $bin The name of the Drupal subsystem that is making this call.
 *   Examples could be 'cache', 'alias', 'taxonomy term' etc. It is possible to
 *   map different $bin values to different memcache servers.
 * @param $mc Optionally pass in the memcache object.  Normally this value is
 *   determined automatically based on the bin the object is being stored to.
32 33 34
 *
 * @return bool
 */
35
function dmemcache_set($key, $value, $exp = 0, $bin = 'cache', $mc = NULL) {
36 37
  $collect_stats = dmemcache_stats_init();

38
  $full_key = dmemcache_key($key, $bin);
39 40

  $rc = FALSE;
41
  if ($mc || ($mc = dmemcache_object($bin))) {
42
    if ($mc instanceof Memcached) {
43
      $rc = $mc->set($full_key, $value, $exp);
44 45
    }
    else {
46
      $rc = $mc->set($full_key, $value, MEMCACHE_COMPRESSED, $exp);
47 48
    }
  }
49 50 51 52 53 54

  if ($collect_stats) {
    dmemcache_stats_write('set', $bin, array($full_key => $rc));
  }

  return $rc;
55 56
}

57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
/**
 *  Add an item into memcache
 *
 * @param $key The string with which you will retrieve this item later.
 * @param $value The item to be stored.
 * @param $exp Parameter expire is expiration time in seconds. If it's 0, the
 *   item never expires (but memcached server doesn't guarantee this item to be
 *   stored all the time, it could be deleted from the cache to make place for
 *   other items).
 * @param $bin The name of the Drupal subsystem that is making this call.
 *   Examples could be 'cache', 'alias', 'taxonomy term' etc. It is possible
 *   to map different $bin values to different memcache servers.
 * @param $mc Optionally pass in the memcache object.  Normally this value is
 *   determined automatically based on the bin the object is being stored to.
 * @param $flag If using the older memcache PECL extension as opposed to the
 *   newer memcached PECL extension, the MEMCACHE_COMPRESSED flag can be set
 *   to use zlib to store a compressed copy of the item.  This flag option is
 *   completely ignored when using the newer memcached PECL extension.
 *
 * @return bool
 */
78
function dmemcache_add($key, $value, $exp = 0, $bin = 'cache', $mc = NULL, $flag = FALSE) {
79 80
  $collect_stats = dmemcache_stats_init();

81
  $full_key = dmemcache_key($key, $bin);
82 83

  $rc = FALSE;
84
  if ($mc || ($mc = dmemcache_object($bin))) {
85
    if ($mc instanceof Memcached) {
86
      $rc = $mc->add($full_key, $value, $exp);
87 88
    }
    else {
89
      $rc = $mc->add($full_key, $value, $flag, $exp);
90 91
    }
  }
92 93 94 95 96 97

  if ($collect_stats) {
    dmemcache_stats_write('add', $bin, array($full_key => $rc));
  }

  return $rc;
98 99
}

100 101 102 103 104 105 106 107
/**
 * Retrieve a value from the cache.
 *
 * @param $key The key with which the item was stored.
 * @param $bin The bin in which the item was stored.
 *
 * @return The item which was originally saved or FALSE
 */
108
function dmemcache_get($key, $bin = 'cache', $mc = NULL) {
109 110
  $collect_stats = dmemcache_stats_init();

111
  $result = FALSE;
112

113 114
  $full_key = dmemcache_key($key, $bin);
  $success = '0';
115 116 117 118 119 120 121 122 123
  if ($mc || $mc = dmemcache_object($bin)) {
    $track_errors = ini_set('track_errors', '1');
    $php_errormsg = '';

    $result = @$mc->get($full_key);

    if (!empty($php_errormsg)) {
      register_shutdown_function('watchdog', 'memcache', 'Exception caught in dmemcache_get: !msg', array('!msg' => $php_errormsg), WATCHDOG_WARNING);
      $php_errormsg = '';
124
    }
125
    ini_set('track_errors', $track_errors);
126
  }
127

128 129 130 131
  if ($collect_stats) {
    dmemcache_stats_write('get', $bin, array($full_key => (bool) $result));
  }

132
  return $result;
133 134 135 136 137 138 139 140 141 142 143
}

/**
 * Retrieve multiple values from the cache.
 *
 * @param $keys The keys with which the items were stored.
 * @param $bin The bin in which the item was stored.
 *
 * @return The item which was originally saved or FALSE
 */
function dmemcache_get_multi($keys, $bin = 'cache', $mc = NULL) {
144 145 146
  $collect_stats = dmemcache_stats_init();
  $multi_stats = array();

147
  $full_keys = array();
148

149 150
  foreach ($keys as $key => $cid) {
    $full_key = dmemcache_key($cid, $bin);
151
    $full_keys[$cid] = $full_key;
152 153 154 155

    if ($collect_stats) {
      $multi_stats[$full_key] = FALSE;
    }
156
  }
157

158 159
  $results = array();
  if ($mc || ($mc = dmemcache_object($bin))) {
160
    if ($mc instanceof Memcached) {
161 162
      $results = $mc->getMulti($full_keys);
    }
163
    elseif ($mc instanceof Memcache) {
164 165 166 167 168 169 170 171 172 173
      $track_errors = ini_set('track_errors', '1');
      $php_errormsg = '';

      $results = @$mc->get($full_keys);

      if (!empty($php_errormsg)) {
        register_shutdown_function('watchdog', 'memcache', 'Exception caught in dmemcache_get_multi: !msg', array('!msg' => $php_errormsg), WATCHDOG_WARNING);
        $php_errormsg = '';
      }
      ini_set('track_errors', $track_errors);
174 175
    }
  }
176 177 178 179
  // If $results is FALSE, convert it to an empty array.
  if (!$results) {
    $results = array();
  }
180

181 182 183 184 185 186
  if ($collect_stats) {
    foreach ($multi_stats as $key => $value) {
      $multi_stats[$key] = isset($results[$key]) ? TRUE : FALSE;
    }
  }

187 188
  // Convert the full keys back to the cid.
  $cid_results = array();
189 190 191
  $cid_lookup = array_flip($full_keys);
  foreach ($results as $key => $value) {
    $cid_results[$cid_lookup[$key]] = $value;
192
  }
193 194 195 196 197

  if ($collect_stats) {
    dmemcache_stats_write('getMulti', $bin, $multi_stats);
  }

198
  return $cid_results;
199 200 201 202 203 204 205 206 207 208
}

/**
 * Deletes an item from the cache.
 *
 * @param $key The key with which the item was stored.
 * @param $bin The bin in which the item was stored.
 *
 * @return Returns TRUE on success or FALSE on failure.
 */
209
function dmemcache_delete($key, $bin = 'cache', $mc = NULL) {
210 211
  $collect_stats = dmemcache_stats_init();

212
  $full_key = dmemcache_key($key, $bin);
213 214

  $rc = FALSE;
215
  if ($mc || ($mc = dmemcache_object($bin))) {
216
    $rc = $mc->delete($full_key, 0);
217
  }
218 219 220 221 222 223

  if ($collect_stats) {
    dmemcache_stats_write('delete', $bin, array($full_key => $rc));
  }

  return $rc;
224 225 226 227 228 229 230 231 232 233 234 235
}

/**
 * Immediately invalidates all existing items. dmemcache_flush doesn't actually free any
 * resources, it only marks all the items as expired, so occupied memory will be overwritten by
 * new items.
 *
 * @param $bin The bin to flush. Note that this will flush all bins mapped to the same server
 *   as $bin. There is no way at this time to empty just one bin.
 *
 * @return Returns TRUE on success or FALSE on failure.
 */
236
function dmemcache_flush($bin = 'cache', $mc = NULL) {
237 238 239
  $collect_stats = dmemcache_stats_init();

  $rc = FALSE;
240 241 242
  if (dmemcache_collect_stats()) {
    $_memcache_statistics[] = array('flush', $bin, '', '');
  }
243
  if ($mc || ($mc = dmemcache_object($bin))) {
244 245 246 247 248
    $rc = memcache_flush($mc);
  }

  if ($collect_stats) {
    dmemcache_stats_write('flush', $bin, array('' => $rc));
249
  }
250 251

  return $rc;
252 253
}

254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
function dmemcache_stats($stats_bin = 'cache', $stats_type = 'default', $aggregate = FALSE) {
  $memcache_bins = variable_get('memcache_bins', array('cache' => 'default'));
  // The stats_type can be over-loaded with an integer slab id, if doing a
  // cachedump.  We know we're doing a cachedump if $slab is non-zero.
  $slab = (int)$stats_type;

  foreach ($memcache_bins as $bin => $target) {
    if ($stats_bin == $bin) {
      if ($mc = dmemcache_object($bin)) {
        if ($mc instanceof Memcached) {
          $stats[$bin] = $mc->getStats();
        }
        // The PHP Memcache extension 3.x version throws an error if the stats
        // type is NULL or not in {reset, malloc, slabs, cachedump, items,
        // sizes}. If $stats_type is 'default', then no parameter should be
        // passed to the Memcache memcache_get_extended_stats() function.
        else if ($mc instanceof Memcache) {
          if ($stats_type == 'default' || $stats_type == '') {
            $stats[$bin] = $mc->getExtendedStats();
          }
          // If $slab isn't zero, then we are dumping the contents of a
          // specific cache slab.
          else if (!empty($slab))  {
            $stats[$bin] = $mc->getStats('cachedump', $slab);
          }
          else {
            $stats[$bin] = $mc->getExtendedStats($stats_type);
          }
        }
      }
284
    }
285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
  }
  // Optionally calculate a sum-total for all servers in the current bin.
  if ($aggregate) {
    // Some variables don't logically aggregate.
    $no_aggregate = array('pid', 'time', 'version', 'pointer_size', 'accepting_conns', 'listen_disabled_num');
    foreach($stats as $bin => $servers) {
      if (is_array($servers)) {
        foreach ($servers as $server) {
          if (is_array($server)) {
            foreach ($server as $key => $value) {
              if (!in_array($key, $no_aggregate)) {
                if (isset($stats[$bin]['total'][$key])) {
                  $stats[$bin]['total'][$key] += $value;
                }
                else {
                  $stats[$bin]['total'][$key] = $value;
                }
              }
            }
          }
        }
      }
307
    }
308
  }
309
  return $stats;
310 311 312
}

/**
313
 * Determine which memcache extension to use: memcache or memcached.
314
 *
315 316
 * By default prefer the 'Memcache' PHP extension, though the default can be
 * overridden by setting memcache_extension in settings.php.
317
 */
318 319 320
function dmemcache_extension() {
  static $extension = NULL;
  if ($extension === NULL) {
321 322 323
    // If an extension is specified in settings.php, use that when available.
    $preferred = variable_get('memcache_extension', NULL);
    if (isset($preferred) && class_exists($preferred)) {
324
      $extension = ucfirst(strtolower($preferred));
325 326 327 328 329 330 331 332
    }
    // If no extension is set, default to Memcache.
    elseif (class_exists('Memcache')) {
      $extension = 'Memcache';
    }
    elseif (class_exists('Memcached')) {
      $extension = 'Memcached';
    }
333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
    else {
      $extension = FALSE;
    }
  }
  return $extension;
}

/**
 * Return a new memcache instance.
 */
function dmemcache_instance() {
  static $error = FALSE;
  $extension = dmemcache_extension();
  if ($extension == 'Memcache') {
    return new Memcache;
  }
  elseif ($extension == 'Memcached') {
    $memcache = new Memcached;
    $default_opts = array(
      Memcached::OPT_COMPRESSION => FALSE,
      Memcached::OPT_DISTRIBUTION => Memcached::DISTRIBUTION_CONSISTENT,
    );
    foreach ($default_opts as $key => $value) {
      $memcache->setOption($key, $value);
    }
    // See README.txt for setting custom Memcache options when using the
    // memcached PECL extension.
    $memconf = variable_get('memcache_options', array());
    foreach ($memconf as $key => $value) {
      $memcache->setOption($key, $value);
    }
    return $memcache;
  }
  else {
    if (!$error) {
      register_shutdown_function('watchdog', 'memcache', 'You must enable the PHP <a href="http://php.net/manual/en/book.memcache.php">memcache</a> (recommended) or <a href="http://php.net/manual/en/book.memcached.php">memcached</a> extension to use memcache.inc.', array(), WATCHDOG_ERROR);
      $error = TRUE;
    }
  }
  return FALSE;
}

/**
 * Initiate a connection to memcache.
 *
 * @param $memcache A memcache instance obtained through dmemcache_instance.
 *
 * @param $server A server string of the format "localhost:11211" or
 *   "unix:///path/to/socket".
 *
 * @connection TRUE or FALSE, whether the $memcache instance already has at
 *   least one open connection.
 *
 * @return TRUE or FALSE if connection was successful.
 */
function dmemcache_connect($memcache, $server, $connection) {
  static $memcache_persistent = NULL;
390

391 392 393 394 395 396 397 398 399
  $extension = dmemcache_extension();

  list($host, $port) = explode(':', $server);

  if ($extension == 'Memcache') {
    // Allow persistent connection via Memcache extension -- note that this
    // module currently doesn't support persistent connections with the
    // Memcached extension. See http://drupal.org/node/822316#comment-4427676
    // for details.
400 401 402
    if (!isset($memcache_persistent)) {
      $memcache_persistent = variable_get('memcache_persistent', FALSE);
    }
403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459

    // Support unix sockets of the format 'unix:///path/to/socket'.
    if ($host == 'unix') {
      // Use full protocol and path as expected by Memcache extension.
      $host = $server;
      $port = 0;
    }

    // When using the PECL memcache extension, we must use ->(p)connect
    // for the first connection.
    if (!$connection) {
      $track_errors = ini_set('track_errors', '1');
      $php_errormsg = '';

      // The Memcache extension requires us to use (p)connect for the first
      // server we connect to.
      if ($memcache_persistent) {
        $rc = @$memcache->pconnect($host, $port);
      }
      else {
        $rc = @$memcache->connect($host, $port);
      }
      if (!empty($php_errormsg)) {
        register_shutdown_function('watchdog', 'memcache', 'Exception caught in dmemcache_object: !msg', array('!msg' => $php_errormsg), WATCHDOG_WARNING);
        $php_errormsg = '';
      }
      ini_set('track_errors', $track_errors);
    }
    else {
      $rc = $memcache->addServer($host, $port, $memcache_persistent);
    }
  }
  else if ($extension == 'Memcached') {
    // Support unix sockets of the format 'unix:///path/to/socket'.
    if ($host == 'unix') {
      // Strip 'unix://' as expected by Memcached extension.
      $host = substr($server, 7);
      $port = 0;
    }
    $rc = $memcache->addServer($host, $port);
  }
  else {
    $rc = FALSE;
  }
  return $rc;
}

/**
 * Close the connection to the memcache instance.
 */
function dmemcache_close($memcache) {
  $extension = dmemcache_extension();
  if ($extension == 'Memcache' && $memcache instanceof Memcache) {
    $rc = @$memcache->close;
  }
  else if ($extension == 'Memcached' && $memcache instanceof Memcached) {
    $rc = @$memcache->quit;
460
  }
461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485
  else {
    $rc = FALSE;
  }
  return $rc;
}

/**
 * Return a Memcache object for the specified bin.
 *
 * Note that there is nothing preventing developers from calling this function
 * directly to get the Memcache object. Do this if you need functionality not
 * provided by this API or if you need to use legacy code. Otherwise, use the
 * dmemcache (get, set, delete, flush) API functions provided here.
 *
 * @param $bin The bin which is to be used.
 *
 * @param $flush Rebuild the bin/server/cache mapping.
 *
 * @return a Memcache object or FALSE.
 */
function dmemcache_object($bin = NULL, $flush = FALSE) {
  static $memcacheCache = array();
  static $memcache_servers = array();
  static $memcache_bins = array();
  static $failed_connections = array();
486 487 488

  if ($flush) {
    foreach ($memcacheCache as $cluster) {
489
      memcache_close($cluster);
490 491 492 493
    }
    $memcacheCache = array();
  }

494 495
  $extension = dmemcache_extension();

496 497
  if (empty($memcacheCache) || empty($memcacheCache[$bin])) {
    if (empty($memcache_servers)) {
498
      // Load the variables from settings.php if set.
499
      $memcache_servers = variable_get('memcache_servers', array('127.0.0.1:11211' => 'default'));
500
      $memcache_bins = variable_get('memcache_bins', array('cache' => 'default'));
501 502
    }

503
    // If not manually set, default this cluster to 'default'.
504 505
    $cluster = empty($memcache_bins[$bin]) ? 'default' : $memcache_bins[$bin];

506 507
    // If not manually set, map this bin to 'cache' which maps to the 'default'
    // cluster.
508 509 510 511
    if (empty($memcache_bins[$bin]) && !empty($memcacheCache['cache'])) {
      $memcacheCache[$bin] = &$memcacheCache['cache'];
    }
    else {
512 513
      // Create a new memcache object for each cluster.
      $memcache = dmemcache_instance();
514

515 516
      // Track whether or not we've opened any memcache connections.
      $connection = FALSE;
517

518 519 520 521 522 523 524
      // Link all the servers to this cluster.
      foreach ($memcache_servers as $server => $c) {
        if ($c == $cluster && !isset($failed_connections[$server])) {
          $rc = dmemcache_connect($memcache, $server, $connection);
          if ($rc !== FALSE) {
            // We've made at least one successful connection.
            $connection = TRUE;
525
          }
526
          else {
527 528 529 530 531 532
            // Memcache connection failure. We can't log to watchdog directly
            // because we're in an early Drupal bootstrap phase where watchdog
            // is non-functional. Instead, register a shutdown handler so it
            // gets recorded at the end of the page load.
            register_shutdown_function('watchdog', 'memcache', 'Failed to connect to memcache server: !server', array('!server' => $server), WATCHDOG_ERROR);
            $failed_connections[$server] = FALSE;
533
          }
534 535
        }
      }
536
      if ($connection) {
537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555
        // Map the current bin with the new Memcache object.
        $memcacheCache[$bin] = $memcache;

        // Now that all the servers have been mapped to this cluster, look for
        // other bins that belong to the cluster and map them too.
        foreach ($memcache_bins as $b => $c) {
          if ($c == $cluster && $b != $bin) {
            // Map this bin and cluster by reference.
            $memcacheCache[$b] = &$memcacheCache[$bin];
          }
        }
      }
    }
  }

  return empty($memcacheCache[$bin]) ? FALSE : $memcacheCache[$bin];
}

function dmemcache_key($key, $bin = 'cache') {
556 557 558 559 560 561 562 563
  $prefix = '';
  if ($prefix = variable_get('memcache_key_prefix', '')) {
    $prefix .= '-';
  }
  // When simpletest is running, emulate the simpletest database prefix here
  // to avoid the child site setting cache entries in the parent site.
  if (isset($GLOBALS['drupal_test_info']['test_run_id'])) {
    $prefix .= $GLOBALS['drupal_test_info']['test_run_id'];
564 565 566 567
  }
  $full_key = urlencode($prefix . $bin . '-' . $key);

  // Memcache only supports key lengths up to 250 bytes.  If we have generated
568 569 570
  // a longer key, we shrink it to an acceptible length with a configurable
  // hashing algorithm. Sha1 was selected as the default as it performs
  // quickly with minimal collisions.
571
  if (strlen($full_key) > 250) {
572
    $full_key = urlencode(hash(variable_get('memcache_key_hash_algorithm', 'sha1'), $prefix . $bin . '-' . $key));
573
  }
574

575
  return $full_key;
576
}
577 578

/**
579 580 581 582 583 584
 * Collect statistics if enabled.
 *
 * Optimized function to determine whether or not we should be collecting statistics. Also starts a
 * timer to track how long individual memcache operations take.
 *
 * @return TRUE or FALSE if statistics should be collected.
585
 */
586
function dmemcache_stats_init() {
587
  static $drupal_static_fast;
588

589 590 591 592 593 594 595
  if (!isset($drupal_static_fast)) {
    $drupal_static_fast = &drupal_static(__FUNCTION__, array('variable_checked' => NULL, 'user_access_checked' => NULL));
  }
  $variable_checked = &$drupal_static_fast['variable_checked'];
  $user_access_checked  = &$drupal_static_fast['user_access_checked'];

  // Confirm DRUPAL_BOOTSTRAP_VARIABLES has been reached. We don't use
596 597 598
  // drupal_get_bootstrap_phase() as it's buggy. We can use variable_get() here because
  // _drupal_bootstrap_variables() includes module.inc immediately after it calls
  // variable_initialize().
599 600 601 602
  if (!isset($variable_checked) && function_exists('module_list')) {
    $variable_checked = variable_get('show_memcache_statistics', FALSE);
  }
  // If statistics are enabled we need to check user access.
603
  if (!empty($variable_checked) && !isset($user_access_checked) && !empty($GLOBALS['user']) && function_exists('user_access')) {
604 605 606 607 608
    // Statistics are enabled and the $user object has been populated, so check
    // that the user has access to view them.
    $user_access_checked = user_access('access memcache statistics');
  }
  // Return whether or not statistics are enabled and the user can access them.
609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639
  if ((!isset($variable_checked) || $variable_checked) && (!isset($user_access_checked) || $user_access_checked)) {
    timer_start('dmemcache');
    return TRUE;
  }
  else {
    return FALSE;
  }
}

/**
 * Save memcache statistics to be displayed at end of page generation.
 *
 * @param $action The action being performed (get, set, etc...).
 * @param $bin The memcache bin the action is being performed in.
 * @param $keys The key the action is being performed on, and whether or not it was a success.
 */
function dmemcache_stats_write($action, $bin, $keys) {
  global $_dmemcache_stats, $timers;
  // Determine how much time elapsed to execute this action.
  $time = timer_read('dmemcache');
  // Build the 'all' and 'ops' arrays displayed by memcache_admin.module.
  foreach ($keys as $key => $success) {
    $_dmemcache_stats['all'][] = array(number_format($time, 2), $action, $bin, $key, $success ? 'hit' : 'miss');
    if (!isset($_dmemcache_stats['ops'][$action])) {
      $_dmemcache_stats['ops'][$action] = array($action, 0, 0, 0);
    }
    $_dmemcache_stats['ops'][$action][1] += $time;
    $success ? $_dmemcache_stats['ops'][$action][2]++ : $_dmemcache_stats['ops'][$action][3]++;
  }
  // Reset the dmemcache timer for timing the next memcache operation.
  unset($timers['dmemcache']);
640
}