/usr/share/perl5/Cache/Memcached.pm is in libcache-memcached-perl 1.30-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 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 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 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 390 391 392 393 394 395 396 397 398 399 400 401 402 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 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 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 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 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 | # $Id$
#
# Copyright (c) 2003, 2004 Brad Fitzpatrick <brad@danga.com>
#
# See COPYRIGHT section in pod text below for usage and distribution rights.
#
package Cache::Memcached;
use strict;
use warnings;
no strict 'refs';
use Storable ();
use Socket qw( MSG_NOSIGNAL PF_INET PF_UNIX IPPROTO_TCP SOCK_STREAM );
use IO::Handle ();
use Time::HiRes ();
use String::CRC32;
use Errno qw( EINPROGRESS EWOULDBLOCK EISCONN );
use Cache::Memcached::GetParser;
use Encode ();
use fields qw{
debug no_rehash stats compress_threshold compress_enable stat_callback
readonly select_timeout namespace namespace_len servers active buckets
pref_ip
bucketcount _single_sock _stime
connect_timeout cb_connect_fail
parser_class
buck2sock buck2sock_generation
};
# flag definitions
use constant F_STORABLE => 1;
use constant F_COMPRESS => 2;
# size savings required before saving compressed value
use constant COMPRESS_SAVINGS => 0.20; # percent
use vars qw($VERSION $HAVE_ZLIB $FLAG_NOSIGNAL $HAVE_SOCKET6);
$VERSION = "1.30";
BEGIN {
$HAVE_ZLIB = eval "use Compress::Zlib (); 1;";
$HAVE_SOCKET6 = eval "use Socket6 qw(AF_INET6 PF_INET6); 1;";
}
my $HAVE_XS = eval "use Cache::Memcached::GetParserXS; 1;";
$HAVE_XS = 0 if $ENV{NO_XS};
my $parser_class = $HAVE_XS ? "Cache::Memcached::GetParserXS" : "Cache::Memcached::GetParser";
if ($ENV{XS_DEBUG}) {
print "using parser: $parser_class\n";
}
$FLAG_NOSIGNAL = 0;
eval { $FLAG_NOSIGNAL = MSG_NOSIGNAL; };
my %host_dead; # host -> unixtime marked dead until
my %cache_sock; # host -> socket
my $socket_cache_generation = 1; # Set to 1 here because below the buck2sock_generation is set to 0, keep them in order.
my $PROTO_TCP;
our $SOCK_TIMEOUT = 2.6; # default timeout in seconds
sub new {
my Cache::Memcached $self = shift;
$self = fields::new( $self ) unless ref $self;
my $args = (@_ == 1) ? shift : { @_ }; # hashref-ify args
$self->{'buck2sock'}= [];
$self->{'buck2sock_generation'} = 0;
$self->set_servers($args->{'servers'});
$self->{'debug'} = $args->{'debug'} || 0;
$self->{'no_rehash'} = $args->{'no_rehash'};
$self->{'stats'} = {};
$self->{'pref_ip'} = $args->{'pref_ip'} || {};
$self->{'compress_threshold'} = $args->{'compress_threshold'};
$self->{'compress_enable'} = 1;
$self->{'stat_callback'} = $args->{'stat_callback'} || undef;
$self->{'readonly'} = $args->{'readonly'};
$self->{'parser_class'} = $args->{'parser_class'} || $parser_class;
# TODO: undocumented
$self->{'connect_timeout'} = $args->{'connect_timeout'} || 0.25;
$self->{'select_timeout'} = $args->{'select_timeout'} || 1.0;
$self->{namespace} = $args->{namespace} || '';
$self->{namespace_len} = length $self->{namespace};
return $self;
}
sub set_pref_ip {
my Cache::Memcached $self = shift;
$self->{'pref_ip'} = shift;
}
sub set_servers {
my Cache::Memcached $self = shift;
my ($list) = @_;
$self->{'servers'} = $list || [];
$self->{'active'} = scalar @{$self->{'servers'}};
$self->{'buckets'} = undef;
$self->{'bucketcount'} = 0;
$self->init_buckets;
# We didn't close any sockets, so we reset the buck2sock generation, not increment the global socket cache generation.
$self->{'buck2sock_generation'} = 0;
$self->{'_single_sock'} = undef;
if (@{$self->{'servers'}} == 1) {
$self->{'_single_sock'} = $self->{'servers'}[0];
}
return $self;
}
sub set_cb_connect_fail {
my Cache::Memcached $self = shift;
$self->{'cb_connect_fail'} = shift;
}
sub set_connect_timeout {
my Cache::Memcached $self = shift;
$self->{'connect_timeout'} = shift;
}
sub set_debug {
my Cache::Memcached $self = shift;
my ($dbg) = @_;
$self->{'debug'} = $dbg || 0;
}
sub set_readonly {
my Cache::Memcached $self = shift;
my ($ro) = @_;
$self->{'readonly'} = $ro;
}
sub set_norehash {
my Cache::Memcached $self = shift;
my ($val) = @_;
$self->{'no_rehash'} = $val;
}
sub set_compress_threshold {
my Cache::Memcached $self = shift;
my ($thresh) = @_;
$self->{'compress_threshold'} = $thresh;
}
sub enable_compress {
my Cache::Memcached $self = shift;
my ($enable) = @_;
$self->{'compress_enable'} = $enable;
}
sub forget_dead_hosts {
my Cache::Memcached $self = shift;
%host_dead = ();
# We need to globally recalculate our buck2sock in all objects, so we increment the global generation.
$socket_cache_generation++;
return 1;
}
sub set_stat_callback {
my Cache::Memcached $self = shift;
my ($stat_callback) = @_;
$self->{'stat_callback'} = $stat_callback;
}
my %sock_map; # stringified-$sock -> "$ip:$port"
sub _dead_sock {
my ($self, $sock, $ret, $dead_for) = @_;
if (my $ipport = $sock_map{$sock}) {
my $now = time();
$host_dead{$ipport} = $now + $dead_for
if $dead_for;
delete $cache_sock{$ipport};
delete $sock_map{$sock};
}
# We need to globally recalculate our buck2sock in all objects, so we increment the global generation.
$socket_cache_generation++;
return $ret; # 0 or undef, probably, depending on what caller wants
}
sub _close_sock {
my ($self, $sock) = @_;
if (my $ipport = $sock_map{$sock}) {
close $sock;
delete $cache_sock{$ipport};
delete $sock_map{$sock};
}
# We need to globally recalculate our buck2sock in all objects, so we increment the global generation.
$socket_cache_generation++;
return 1;
}
sub _connect_sock { # sock, sin, timeout
my ($sock, $sin, $timeout) = @_;
$timeout = 0.25 if not defined $timeout;
# make the socket non-blocking from now on,
# except if someone wants 0 timeout, meaning
# a blocking connect, but even then turn it
# non-blocking at the end of this function
if ($timeout) {
IO::Handle::blocking($sock, 0);
} else {
IO::Handle::blocking($sock, 1);
}
my $ret = connect($sock, $sin);
if (!$ret && $timeout && $!==EINPROGRESS) {
my $win='';
vec($win, fileno($sock), 1) = 1;
if (select(undef, $win, undef, $timeout) > 0) {
$ret = connect($sock, $sin);
# EISCONN means connected & won't re-connect, so success
$ret = 1 if !$ret && $!==EISCONN;
}
}
unless ($timeout) { # socket was temporarily blocking, now revert
IO::Handle::blocking($sock, 0);
}
# from here on, we use non-blocking (async) IO for the duration
# of the socket's life
return $ret;
}
sub sock_to_host { # (host) #why is this public? I wouldn't have to worry about undef $self if it weren't.
my Cache::Memcached $self = ref $_[0] ? shift : undef;
my $host = $_[0];
return $cache_sock{$host} if $cache_sock{$host};
my $now = time();
my ($ip, $port) = $host =~ /(.*):(\d+)$/;
if (defined($ip)) {
$ip =~ s/[\[\]]//g; # get rid of optional IPv6 brackets
}
return undef if
$host_dead{$host} && $host_dead{$host} > $now;
my $sock;
my $connected = 0;
my $sin;
my $proto = $PROTO_TCP ||= getprotobyname('tcp');
if ( index($host, '/') != 0 )
{
# if a preferred IP is known, try that first.
if ($self && $self->{pref_ip}{$ip}) {
my $prefip = $self->{pref_ip}{$ip};
if ($HAVE_SOCKET6 && index($prefip, ':') != -1) {
no strict 'subs'; # for PF_INET6 and AF_INET6, weirdly imported
socket($sock, PF_INET6, SOCK_STREAM, $proto);
$sock_map{$sock} = $host;
$sin = Socket6::pack_sockaddr_in6($port,
Socket6::inet_pton(AF_INET6, $prefip));
} else {
socket($sock, PF_INET, SOCK_STREAM, $proto);
$sock_map{$sock} = $host;
$sin = Socket::sockaddr_in($port, Socket::inet_aton($prefip));
}
if (_connect_sock($sock,$sin,$self->{connect_timeout})) {
$connected = 1;
} else {
if (my $cb = $self->{cb_connect_fail}) {
$cb->($prefip);
}
close $sock;
}
}
# normal path, or fallback path if preferred IP failed
unless ($connected) {
if ($HAVE_SOCKET6 && index($ip, ':') != -1) {
no strict 'subs'; # for PF_INET6 and AF_INET6, weirdly imported
socket($sock, PF_INET6, SOCK_STREAM, $proto);
$sock_map{$sock} = $host;
$sin = Socket6::pack_sockaddr_in6($port,
Socket6::inet_pton(AF_INET6, $ip));
} else {
socket($sock, PF_INET, SOCK_STREAM, $proto);
$sock_map{$sock} = $host;
$sin = Socket::sockaddr_in($port, Socket::inet_aton($ip));
}
my $timeout = $self ? $self->{connect_timeout} : 0.25;
unless (_connect_sock($sock, $sin, $timeout)) {
my $cb = $self ? $self->{cb_connect_fail} : undef;
$cb->($ip) if $cb;
return _dead_sock($self, $sock, undef, 20 + int(rand(10)));
}
}
} else { # it's a unix domain/local socket
socket($sock, PF_UNIX, SOCK_STREAM, 0);
$sock_map{$sock} = $host;
$sin = Socket::sockaddr_un($host);
my $timeout = $self ? $self->{connect_timeout} : 0.25;
unless (_connect_sock($sock,$sin,$timeout)) {
my $cb = $self ? $self->{cb_connect_fail} : undef;
$cb->($host) if $cb;
return _dead_sock($self, $sock, undef, 20 + int(rand(10)));
}
}
# make the new socket not buffer writes.
my $old = select($sock);
$| = 1;
select($old);
$cache_sock{$host} = $sock;
return $sock;
}
sub get_sock { # (key)
my Cache::Memcached $self = $_[0];
my $key = $_[1];
return $self->sock_to_host($self->{'_single_sock'}) if $self->{'_single_sock'};
return undef unless $self->{'active'};
my $hv = ref $key ? int($key->[0]) : _hashfunc($key);
my $real_key = ref $key ? $key->[1] : $key;
my $tries = 0;
while ($tries++ < 20) {
my $host = $self->{'buckets'}->[$hv % $self->{'bucketcount'}];
my $sock = $self->sock_to_host($host);
return $sock if $sock;
return undef if $self->{'no_rehash'};
$hv += _hashfunc($tries . $real_key); # stupid, but works
}
return undef;
}
sub init_buckets {
my Cache::Memcached $self = shift;
return if $self->{'buckets'};
my $bu = $self->{'buckets'} = [];
foreach my $v (@{$self->{'servers'}}) {
if (ref $v eq "ARRAY") {
for (1..$v->[1]) { push @$bu, $v->[0]; }
} else {
push @$bu, $v;
}
}
$self->{'bucketcount'} = scalar @{$self->{'buckets'}};
}
sub disconnect_all {
my Cache::Memcached $self = shift;
my $sock;
foreach $sock (values %cache_sock) {
close $sock;
}
%cache_sock = ();
# We need to globally recalculate our buck2sock in all objects, so we increment the global generation.
$socket_cache_generation++;
}
# writes a line, then reads result. by default stops reading after a
# single line, but caller can override the $check_complete subref,
# which gets passed a scalarref of buffer read thus far.
sub _write_and_read {
my Cache::Memcached $self = shift;
my ($sock, $line, $check_complete) = @_;
my $res;
my ($ret, $offset) = (undef, 0);
$check_complete ||= sub {
return (rindex($ret, "\r\n") + 2 == length($ret));
};
# state: 0 - writing, 1 - reading, 2 - done
my $state = 0;
# the bitsets for select
my ($rin, $rout, $win, $wout);
my $nfound;
my $copy_state = -1;
local $SIG{'PIPE'} = "IGNORE" unless $FLAG_NOSIGNAL;
# the select loop
while(1) {
if ($copy_state!=$state) {
last if $state==2;
($rin, $win) = ('', '');
vec($rin, fileno($sock), 1) = 1 if $state==1;
vec($win, fileno($sock), 1) = 1 if $state==0;
$copy_state = $state;
}
$nfound = select($rout=$rin, $wout=$win, undef,
$self->{'select_timeout'});
last unless $nfound;
if (vec($wout, fileno($sock), 1)) {
$res = send($sock, $line, $FLAG_NOSIGNAL);
next
if not defined $res and $!==EWOULDBLOCK;
unless ($res > 0) {
$self->_close_sock($sock);
return undef;
}
if ($res == length($line)) { # all sent
$state = 1;
} else { # we only succeeded in sending some of it
substr($line, 0, $res, ''); # delete the part we sent
}
}
if (vec($rout, fileno($sock), 1)) {
$res = sysread($sock, $ret, 255, $offset);
next
if !defined($res) and $!==EWOULDBLOCK;
if ($res == 0) { # catches 0=conn closed or undef=error
$self->_close_sock($sock);
return undef;
}
$offset += $res;
$state = 2 if $check_complete->(\$ret);
}
}
unless ($state == 2) {
$self->_dead_sock($sock); # improperly finished
return undef;
}
return $ret;
}
sub delete {
my Cache::Memcached $self = shift;
my ($key, $time) = @_;
return 0 if ! $self->{'active'} || $self->{'readonly'};
my $stime = Time::HiRes::time() if $self->{'stat_callback'};
my $sock = $self->get_sock($key);
return 0 unless $sock;
$self->{'stats'}->{"delete"}++;
$key = ref $key ? $key->[1] : $key;
$time = $time ? " $time" : "";
my $cmd = "delete $self->{namespace}$key$time\r\n";
my $res = _write_and_read($self, $sock, $cmd);
if ($self->{'stat_callback'}) {
my $etime = Time::HiRes::time();
$self->{'stat_callback'}->($stime, $etime, $sock, 'delete');
}
return defined $res && $res eq "DELETED\r\n";
}
*remove = \&delete;
sub add {
_set("add", @_);
}
sub replace {
_set("replace", @_);
}
sub set {
_set("set", @_);
}
sub append {
_set("append", @_);
}
sub prepend {
_set("prepend", @_);
}
sub _set {
my $cmdname = shift;
my Cache::Memcached $self = shift;
my ($key, $val, $exptime) = @_;
return 0 if ! $self->{'active'} || $self->{'readonly'};
my $stime = Time::HiRes::time() if $self->{'stat_callback'};
my $sock = $self->get_sock($key);
return 0 unless $sock;
use bytes; # return bytes from length()
my $app_or_prep = $cmdname eq 'append' || $cmdname eq 'prepend' ? 1 : 0;
$self->{'stats'}->{$cmdname}++;
my $flags = 0;
$key = ref $key ? $key->[1] : $key;
if (ref $val) {
die "append or prepend cannot take a reference" if $app_or_prep;
local $Carp::CarpLevel = 2;
$val = Storable::nfreeze($val);
$flags |= F_STORABLE;
}
warn "value for memkey:$key is not defined" unless defined $val;
my $len = length($val);
if ($self->{'compress_threshold'} && $HAVE_ZLIB && $self->{'compress_enable'} &&
$len >= $self->{'compress_threshold'} && !$app_or_prep) {
my $c_val = Compress::Zlib::memGzip($val);
my $c_len = length($c_val);
# do we want to keep it?
if ($c_len < $len*(1 - COMPRESS_SAVINGS)) {
$val = $c_val;
$len = $c_len;
$flags |= F_COMPRESS;
}
}
$exptime = int($exptime || 0);
local $SIG{'PIPE'} = "IGNORE" unless $FLAG_NOSIGNAL;
my $line = "$cmdname $self->{namespace}$key $flags $exptime $len\r\n$val\r\n";
my $res = _write_and_read($self, $sock, $line);
if ($self->{'debug'} && $line) {
chop $line; chop $line;
print STDERR "Cache::Memcache: $cmdname $self->{namespace}$key = $val ($line)\n";
}
if ($self->{'stat_callback'}) {
my $etime = Time::HiRes::time();
$self->{'stat_callback'}->($stime, $etime, $sock, $cmdname);
}
return defined $res && $res eq "STORED\r\n";
}
sub incr {
_incrdecr("incr", @_);
}
sub decr {
_incrdecr("decr", @_);
}
sub _incrdecr {
my $cmdname = shift;
my Cache::Memcached $self = shift;
my ($key, $value) = @_;
return undef if ! $self->{'active'} || $self->{'readonly'};
my $stime = Time::HiRes::time() if $self->{'stat_callback'};
my $sock = $self->get_sock($key);
return undef unless $sock;
$key = $key->[1] if ref $key;
$self->{'stats'}->{$cmdname}++;
$value = 1 unless defined $value;
my $line = "$cmdname $self->{namespace}$key $value\r\n";
my $res = _write_and_read($self, $sock, $line);
if ($self->{'stat_callback'}) {
my $etime = Time::HiRes::time();
$self->{'stat_callback'}->($stime, $etime, $sock, $cmdname);
}
return undef unless defined $res && $res =~ /^(\d+)/;
return $1;
}
sub get {
my Cache::Memcached $self = $_[0];
my $key = $_[1];
# TODO: make a fast path for this? or just keep using get_multi?
my $r = $self->get_multi($key);
my $kval = ref $key ? $key->[1] : $key;
# key reconstituted from server won't have utf8 on, so turn it off on input
# scalar to allow hash lookup to succeed
Encode::_utf8_off($kval) if Encode::is_utf8($kval);
return $r->{$kval};
}
sub get_multi {
my Cache::Memcached $self = shift;
return {} unless $self->{'active'};
$self->{'_stime'} = Time::HiRes::time() if $self->{'stat_callback'};
$self->{'stats'}->{"get_multi"}++;
my %val; # what we'll be returning a reference to (realkey -> value)
my %sock_keys; # sockref_as_scalar -> [ realkeys ]
my $sock;
if ($self->{'_single_sock'}) {
$sock = $self->sock_to_host($self->{'_single_sock'});
unless ($sock) {
return {};
}
foreach my $key (@_) {
my $kval = ref $key ? $key->[1] : $key;
push @{$sock_keys{$sock}}, $kval;
}
} else {
my $bcount = $self->{'bucketcount'};
my $sock;
if ($self->{'buck2sock_generation'} != $socket_cache_generation) {
$self->{'buck2sock_generation'} = $socket_cache_generation;
$self->{'buck2sock'} = [];
}
KEY:
foreach my $key (@_) {
my ($hv, $real_key) = ref $key ?
(int($key->[0]), $key->[1]) :
((crc32($key) >> 16) & 0x7fff, $key);
my $tries;
while (1) {
my $bucket = $hv % $bcount;
# this segfaults perl 5.8.4 (and others?) if sock_to_host returns undef... wtf?
#$sock = $buck2sock[$bucket] ||= $self->sock_to_host($self->{buckets}[ $bucket ])
# and last;
# but this variant doesn't crash:
$sock = $self->{'buck2sock'}->[$bucket] || $self->sock_to_host($self->{buckets}[ $bucket ]);
if ($sock) {
$self->{'buck2sock'}->[$bucket] = $sock;
last;
}
next KEY if $tries++ >= 20;
$hv += _hashfunc($tries . $real_key);
}
push @{$sock_keys{$sock}}, $real_key;
}
}
$self->{'stats'}->{"get_keys"} += @_;
$self->{'stats'}->{"get_socks"} += keys %sock_keys;
local $SIG{'PIPE'} = "IGNORE" unless $FLAG_NOSIGNAL;
_load_multi($self, \%sock_keys, \%val);
if ($self->{'debug'}) {
while (my ($k, $v) = each %val) {
print STDERR "MemCache: got $k = $v\n";
}
}
return \%val;
}
sub _load_multi {
use bytes; # return bytes from length()
my Cache::Memcached $self;
my ($sock_keys, $ret);
($self, $sock_keys, $ret) = @_;
# all keyed by $sockstr:
my %reading; # $sockstr -> $sock. bool, whether we're reading from this socket
my %writing; # $sockstr -> $sock. bool, whether we're writing to this socket
my %buf; # buffers, for writing
my %parser; # $sockstr -> Cache::Memcached::GetParser
my $active_changed = 1; # force rebuilding of select sets
my $dead = sub {
my $sock = shift;
print STDERR "killing socket $sock\n" if $self->{'debug'} >= 2;
delete $reading{$sock};
delete $writing{$sock};
if (my $p = $parser{$sock}) {
my $key = $p->current_key;
delete $ret->{$key} if $key;
}
if ($self->{'stat_callback'}) {
my $etime = Time::HiRes::time();
$self->{'stat_callback'}->($self->{'_stime'}, $etime, $sock, 'get_multi');
}
close $sock;
$self->_dead_sock($sock);
};
# $finalize->($key, $flags)
# $finalize->({ $key => $flags, $key => $flags });
my $finalize = sub {
my $map = $_[0];
$map = {@_} unless ref $map;
while (my ($k, $flags) = each %$map) {
# remove trailing \r\n
chop $ret->{$k}; chop $ret->{$k};
$ret->{$k} = Compress::Zlib::memGunzip($ret->{$k})
if $HAVE_ZLIB && $flags & F_COMPRESS;
if ($flags & F_STORABLE) {
# wrapped in eval in case a perl 5.6 Storable tries to
# unthaw data from a perl 5.8 Storable. (5.6 is stupid
# and dies if the version number changes at all. in 5.8
# they made it only die if it unencounters a new feature)
eval {
$ret->{$k} = Storable::thaw($ret->{$k});
};
# so if there was a problem, just treat it as a cache miss.
if ($@) {
delete $ret->{$k};
}
}
}
};
foreach (keys %$sock_keys) {
my $ipport = $sock_map{$_} or die "No map found matching for $_";
my $sock = $cache_sock{$ipport} or die "No sock found for $ipport";
print STDERR "processing socket $_\n" if $self->{'debug'} >= 2;
$writing{$_} = $sock;
if ($self->{namespace}) {
$buf{$_} = join(" ", 'get', (map { "$self->{namespace}$_" } @{$sock_keys->{$_}}), "\r\n");
} else {
$buf{$_} = join(" ", 'get', @{$sock_keys->{$_}}, "\r\n");
}
$parser{$_} = $self->{parser_class}->new($ret, $self->{namespace_len}, $finalize);
}
my $read = sub {
my $sockstr = "$_[0]"; # $sock is $_[0];
my $p = $parser{$sockstr} or die;
my $rv = $p->parse_from_sock($_[0]);
if ($rv > 0) {
# okay, finished with this socket
delete $reading{$sockstr};
} elsif ($rv < 0) {
$dead->($_[0]);
}
return $rv;
};
# returns 1 when it's done, for success or error. 0 if still working.
my $write = sub {
my ($sock, $sockstr) = ($_[0], "$_[0]");
my $res;
$res = send($sock, $buf{$sockstr}, $FLAG_NOSIGNAL);
return 0
if not defined $res and $!==EWOULDBLOCK;
unless ($res > 0) {
$dead->($sock);
return 1;
}
if ($res == length($buf{$sockstr})) { # all sent
$buf{$sockstr} = "";
# switch the socket from writing to reading
delete $writing{$sockstr};
$reading{$sockstr} = $sock;
return 1;
} else { # we only succeeded in sending some of it
substr($buf{$sockstr}, 0, $res, ''); # delete the part we sent
}
return 0;
};
# the bitsets for select
my ($rin, $rout, $win, $wout);
my $nfound;
# the big select loop
while(1) {
if ($active_changed) {
last unless %reading or %writing; # no sockets left?
($rin, $win) = ('', '');
foreach (values %reading) {
vec($rin, fileno($_), 1) = 1;
}
foreach (values %writing) {
vec($win, fileno($_), 1) = 1;
}
$active_changed = 0;
}
# TODO: more intelligent cumulative timeout?
# TODO: select is interruptible w/ ptrace attach, signal, etc. should note that.
$nfound = select($rout=$rin, $wout=$win, undef,
$self->{'select_timeout'});
last unless $nfound;
# TODO: possible robustness improvement: we could select
# writing sockets for reading also, and raise hell if they're
# ready (input unread from last time, etc.)
# maybe do that on the first loop only?
foreach (values %writing) {
if (vec($wout, fileno($_), 1)) {
$active_changed = 1 if $write->($_);
}
}
foreach (values %reading) {
if (vec($rout, fileno($_), 1)) {
$active_changed = 1 if $read->($_);
}
}
}
# if there're active sockets left, they need to die
foreach (values %writing) {
$dead->($_);
}
foreach (values %reading) {
$dead->($_);
}
return;
}
sub _hashfunc {
return (crc32($_[0]) >> 16) & 0x7fff;
}
sub flush_all {
my Cache::Memcached $self = shift;
my $success = 1;
my @hosts = @{$self->{'buckets'}};
foreach my $host (@hosts) {
my $sock = $self->sock_to_host($host);
my @res = $self->run_command($sock, "flush_all\r\n");
$success = 0 unless (scalar @res == 1 && (($res[0] || "") eq "OK\r\n"));
}
return $success;
}
# returns array of lines, or () on failure.
sub run_command {
my Cache::Memcached $self = shift;
my ($sock, $cmd) = @_;
return () unless $sock;
my $ret;
my $line = $cmd;
while (my $res = _write_and_read($self, $sock, $line)) {
undef $line;
$ret .= $res;
last if $ret =~ /(?:OK|END|ERROR)\r\n$/;
}
chop $ret; chop $ret;
return map { "$_\r\n" } split(/\r\n/, $ret);
}
sub stats {
my Cache::Memcached $self = shift;
my ($types) = @_;
return 0 unless $self->{'active'};
return 0 unless !ref($types) || ref($types) eq 'ARRAY';
if (!ref($types)) {
if (!$types) {
# I don't much care what the default is, it should just
# be something reasonable. Obviously "reset" should not
# be on the list :) but other types that might go in here
# include maps, cachedump, slabs, or items. Note that
# this does NOT include 'sizes' anymore, as that can freeze
# bug servers for a couple seconds.
$types = [ qw( misc malloc self ) ];
} else {
$types = [ $types ];
}
}
my $stats_hr = { };
# The "self" stat type is special, it only applies to this very
# object.
if (grep /^self$/, @$types) {
$stats_hr->{'self'} = \%{ $self->{'stats'} };
}
my %misc_keys = map { $_ => 1 }
qw/ bytes bytes_read bytes_written
cmd_get cmd_set connection_structures curr_items
get_hits get_misses
total_connections total_items
/;
# Now handle the other types, passing each type to each host server.
my @hosts = @{$self->{'buckets'}};
HOST: foreach my $host (@hosts) {
my $sock = $self->sock_to_host($host);
next HOST unless $sock;
TYPE: foreach my $typename (grep !/^self$/, @$types) {
my $type = $typename eq 'misc' ? "" : " $typename";
my $lines = _write_and_read($self, $sock, "stats$type\r\n", sub {
my $bref = shift;
return $$bref =~ /^(?:END|ERROR)\r?\n/m;
});
unless ($lines) {
$self->_dead_sock($sock);
next HOST;
}
$lines =~ s/\0//g; # 'stats sizes' starts with NULL?
# And, most lines end in \r\n but 'stats maps' (as of
# July 2003 at least) ends in \n. ??
my @lines = split(/\r?\n/, $lines);
# Some stats are key-value, some are not. malloc,
# sizes, and the empty string are key-value.
# ("self" was handled separately above.)
if ($typename =~ /^(malloc|sizes|misc)$/) {
# This stat is key-value.
foreach my $line (@lines) {
my ($key, $value) = $line =~ /^(?:STAT )?(\w+)\s(.*)/;
if ($key) {
$stats_hr->{'hosts'}{$host}{$typename}{$key} = $value;
}
$stats_hr->{'total'}{$key} += $value
if $typename eq 'misc' && $key && $misc_keys{$key};
$stats_hr->{'total'}{"malloc_$key"} += $value
if $typename eq 'malloc' && $key;
}
} else {
# This stat is not key-value so just pull it
# all out in one blob.
$lines =~ s/^END\r?\n//m;
$stats_hr->{'hosts'}{$host}{$typename} ||= "";
$stats_hr->{'hosts'}{$host}{$typename} .= "$lines";
}
}
}
return $stats_hr;
}
sub stats_reset {
my Cache::Memcached $self = shift;
my ($types) = @_;
return 0 unless $self->{'active'};
HOST: foreach my $host (@{$self->{'buckets'}}) {
my $sock = $self->sock_to_host($host);
next HOST unless $sock;
my $ok = _write_and_read($self, $sock, "stats reset");
unless (defined $ok && $ok eq "RESET\r\n") {
$self->_dead_sock($sock);
}
}
return 1;
}
1;
__END__
=head1 NAME
Cache::Memcached - client library for memcached (memory cache daemon)
=head1 SYNOPSIS
use Cache::Memcached;
$memd = new Cache::Memcached {
'servers' => [ "10.0.0.15:11211", "10.0.0.15:11212", "/var/sock/memcached",
"10.0.0.17:11211", [ "10.0.0.17:11211", 3 ] ],
'debug' => 0,
'compress_threshold' => 10_000,
};
$memd->set_servers($array_ref);
$memd->set_compress_threshold(10_000);
$memd->enable_compress(0);
$memd->set("my_key", "Some value");
$memd->set("object_key", { 'complex' => [ "object", 2, 4 ]});
$val = $memd->get("my_key");
$val = $memd->get("object_key");
if ($val) { print $val->{'complex'}->[2]; }
$memd->incr("key");
$memd->decr("key");
$memd->incr("key", 2);
=head1 DESCRIPTION
This is the Perl API for memcached, a distributed memory cache daemon.
More information is available at:
http://www.danga.com/memcached/
=head1 CONSTRUCTOR
=over 4
=item C<new>
Takes one parameter, a hashref of options. The most important key is
C<servers>, but that can also be set later with the C<set_servers>
method. The servers must be an arrayref of hosts, each of which is
either a scalar of the form C<10.0.0.10:11211> or an arrayref of the
former and an integer weight value. (The default weight if
unspecified is 1.) It's recommended that weight values be kept as low
as possible, as this module currently allocates memory for bucket
distribution proportional to the total host weights.
Use C<compress_threshold> to set a compression threshold, in bytes.
Values larger than this threshold will be compressed by C<set> and
decompressed by C<get>.
Use C<no_rehash> to disable finding a new memcached server when one
goes down. Your application may or may not need this, depending on
your expirations and key usage.
Use C<readonly> to disable writes to backend memcached servers. Only
get and get_multi will work. This is useful in bizarre debug and
profiling cases only.
Use C<namespace> to prefix all keys with the provided namespace value.
That is, if you set namespace to "app1:" and later do a set of "foo"
to "bar", memcached is actually seeing you set "app1:foo" to "bar".
Use C<connect_timeout> and C<select_timeout> to set connection and
polling timeouts. The C<connect_timeout> defaults to .25 second, and
the C<select_timeout> defaults to 1 second.
The other useful key is C<debug>, which when set to true will produce
diagnostics on STDERR.
=back
=head1 METHODS
=over 4
=item C<set_servers>
Sets the server list this module distributes key gets and sets between.
The format is an arrayref of identical form as described in the C<new>
constructor.
=item C<set_debug>
Sets the C<debug> flag. See C<new> constructor for more information.
=item C<set_readonly>
Sets the C<readonly> flag. See C<new> constructor for more information.
=item C<set_norehash>
Sets the C<no_rehash> flag. See C<new> constructor for more information.
=item C<set_compress_threshold>
Sets the compression threshold. See C<new> constructor for more information.
=item C<set_connect_timeout>
Sets the connect timeout. See C<new> constructor for more information.
=item C<set_select_timeout>
Sets the select timeout. See C<new> constructor for more information.
=item C<enable_compress>
Temporarily enable or disable compression. Has no effect if C<compress_threshold>
isn't set, but has an overriding effect if it is.
=item C<get>
my $val = $memd->get($key);
Retrieves a key from the memcache. Returns the value (automatically
thawed with Storable, if necessary) or undef.
The $key can optionally be an arrayref, with the first element being the
hash value, if you want to avoid making this module calculate a hash
value. You may prefer, for example, to keep all of a given user's
objects on the same memcache server, so you could use the user's
unique id as the hash value.
=item C<get_multi>
my $hashref = $memd->get_multi(@keys);
Retrieves multiple keys from the memcache doing just one query.
Returns a hashref of key/value pairs that were available.
This method is recommended over regular 'get' as it lowers the number
of total packets flying around your network, reducing total latency,
since your app doesn't have to wait for each round-trip of 'get'
before sending the next one.
=item C<set>
$memd->set($key, $value[, $exptime]);
Unconditionally sets a key to a given value in the memcache. Returns true
if it was stored successfully.
The $key can optionally be an arrayref, with the first element being the
hash value, as described above.
The $exptime (expiration time) defaults to "never" if unspecified. If
you want the key to expire in memcached, pass an integer $exptime. If
value is less than 60*60*24*30 (30 days), time is assumed to be relative
from the present. If larger, it's considered an absolute Unix time.
=item C<add>
$memd->add($key, $value[, $exptime]);
Like C<set>, but only stores in memcache if the key doesn't already exist.
=item C<replace>
$memd->replace($key, $value[, $exptime]);
Like C<set>, but only stores in memcache if the key already exists. The
opposite of C<add>.
=item C<delete>
$memd->delete($key[, $time]);
Deletes a key. You may optionally provide an integer time value (in seconds) to
tell the memcached server to block new writes to this key for that many seconds.
(Sometimes useful as a hacky means to prevent races.) Returns true if key
was found and deleted, and false otherwise.
You may also use the alternate method name B<remove>, so
Cache::Memcached looks like the L<Cache::Cache> API.
=item C<incr>
$memd->incr($key[, $value]);
Sends a command to the server to atomically increment the value for
$key by $value, or by 1 if $value is undefined. Returns undef if $key
doesn't exist on server, otherwise it returns the new value after
incrementing. Value should be zero or greater. Overflow on server
is not checked. Be aware of values approaching 2**32. See decr.
=item C<decr>
$memd->decr($key[, $value]);
Like incr, but decrements. Unlike incr, underflow is checked and new
values are capped at 0. If server value is 1, a decrement of 2
returns 0, not -1.
=item C<stats>
$memd->stats([$keys]);
Returns a hashref of statistical data regarding the memcache server(s),
the $memd object, or both. $keys can be an arrayref of keys wanted, a
single key wanted, or absent (in which case the default value is malloc,
sizes, self, and the empty string). These keys are the values passed
to the 'stats' command issued to the memcached server(s), except for
'self' which is internal to the $memd object. Allowed values are:
=over 4
=item C<misc>
The stats returned by a 'stats' command: pid, uptime, version,
bytes, get_hits, etc.
=item C<malloc>
The stats returned by a 'stats malloc': total_alloc, arena_size, etc.
=item C<sizes>
The stats returned by a 'stats sizes'.
=item C<self>
The stats for the $memd object itself (a copy of $memd->{'stats'}).
=item C<maps>
The stats returned by a 'stats maps'.
=item C<cachedump>
The stats returned by a 'stats cachedump'.
=item C<slabs>
The stats returned by a 'stats slabs'.
=item C<items>
The stats returned by a 'stats items'.
=back
=item C<disconnect_all>
$memd->disconnect_all;
Closes all cached sockets to all memcached servers. You must do this
if your program forks and the parent has used this module at all.
Otherwise the children will try to use cached sockets and they'll fight
(as children do) and garble the client/server protocol.
=item C<flush_all>
$memd->flush_all;
Runs the memcached "flush_all" command on all configured hosts,
emptying all their caches. (or rather, invalidating all items
in the caches in an O(1) operation...) Running stats will still
show the item existing, they're just be non-existent and lazily
destroyed next time you try to detch any of them.
=back
=head1 BUGS
When a server goes down, this module does detect it, and re-hashes the
request to the remaining servers, but the way it does it isn't very
clean. The result may be that it gives up during its rehashing and
refuses to get/set something it could've, had it been done right.
=head1 COPYRIGHT
This module is Copyright (c) 2003 Brad Fitzpatrick.
All rights reserved.
You may distribute under the terms of either the GNU General Public
License or the Artistic License, as specified in the Perl README file.
=head1 WARRANTY
This is free software. IT COMES WITHOUT WARRANTY OF ANY KIND.
=head1 FAQ
See the memcached website:
http://www.danga.com/memcached/
=head1 AUTHORS
Brad Fitzpatrick <brad@danga.com>
Anatoly Vorobey <mellon@pobox.com>
Brad Whitaker <whitaker@danga.com>
Jamie McCarthy <jamie@mccarthy.vg>
|