/usr/lib/x86_64-linux-gnu/perl5/5.26/MongoDB/_Topology.pm is in libmongodb-perl 1.8.1-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 | #
# Copyright 2014 MongoDB, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
use strict;
use warnings;
package MongoDB::_Topology;
use version;
our $VERSION = 'v1.8.1';
use Moo;
use MongoDB::BSON;
use MongoDB::Error;
use MongoDB::Op::_Command;
use MongoDB::_Platform;
use MongoDB::ReadPreference;
use MongoDB::_Constants;
use MongoDB::_Link;
use MongoDB::_Types qw(
BSONCodec
Document
NonNegNum
TopologyType
to_IxHash
);
use Types::Standard qw(
Bool
HashRef
InstanceOf
Num
Str
Maybe
);
use MongoDB::_Server;
use Config;
use List::Util qw/first max/;
use Safe::Isa;
use Time::HiRes qw/time usleep/;
use Try::Tiny;
use namespace::clean;
#--------------------------------------------------------------------------#
# attributes
#--------------------------------------------------------------------------#
has uri => (
is => 'ro',
required => 1,
isa => InstanceOf['MongoDB::_URI'],
);
has max_wire_version => (
is => 'ro',
required => 1,
isa => Num,
);
has min_wire_version => (
is => 'ro',
required => 1,
isa => Num,
);
has credential => (
is => 'ro',
required => 1,
isa => InstanceOf['MongoDB::_Credential'],
);
has type => (
is => 'ro',
writer => '_set_type',
default => 'Unknown',
isa => TopologyType,
);
has app_name => (
is => 'ro',
default => '',
isa => Str,
);
has replica_set_name => (
is => 'ro',
default => '',
writer => '_set_replica_set_name', # :-)
isa => Str,
);
has heartbeat_frequency_sec => (
is => 'ro',
default => 60,
isa => NonNegNum,
);
has last_scan_time => (
is => 'ro',
default => EPOCH,
writer => '_set_last_scan_time',
isa => Num,
);
has local_threshold_sec => (
is => 'ro',
default => 0.015,
isa => Num,
);
has next_scan_time => (
is => 'ro',
default => sub { time() },
writer => '_set_next_scan_time',
isa => Num,
);
has socket_check_interval_sec => (
is => 'ro',
default => 5,
isa => Num,
);
has server_selection_timeout_sec => (
is => 'ro',
default => 60,
isa => Num,
);
has server_selection_try_once => (
is => 'ro',
default => 1,
isa => Bool,
);
has ewma_alpha => (
is => 'ro',
default => 0.2,
isa => Num,
);
has link_options => (
is => 'ro',
default => sub { {} },
isa => HashRef,
);
has bson_codec => (
is => 'ro',
default => sub { MongoDB::BSON->new },
isa => BSONCodec,
);
has number_of_seeds => (
is => 'lazy',
builder => '_build_number_of_seeds',
isa => Num,
);
has max_election_id => (
is => 'rw',
writer => '_set_max_election_id',
);
has max_set_version => (
is => 'rw',
isa => Maybe [Num],
writer => '_set_max_set_version',
);
# generated only once per _Topology, for performance
has handshake_document => (
is => 'lazy',
isa => Document,
builder => '_build_handshake_document',
);
# compatible wire protocol
has is_compatible => (
is => 'ro',
writer => '_set_is_compatible',
isa => Bool,
);
has wire_version_floor => (
is => 'ro',
writer => '_set_wire_version_floor',
default => 0,
);
has current_primary => (
is => 'rwp',
clearer => '_clear_current_primary',
init_arg => undef,
);
has stale => (
is => 'rwp',
init_arg => undef,
default => 1,
);
# servers, links and rtt_ewma_sec are all hashes on server address
has servers => (
is => 'ro',
default => sub { {} },
isa => HashRef[InstanceOf['MongoDB::_Server']],
);
has links => (
is => 'ro',
default => sub { {} },
isa => HashRef[InstanceOf['MongoDB::_Link']],
);
has rtt_ewma_sec => (
is => 'ro',
default => sub { {} },
isa => HashRef[Num],
);
#--------------------------------------------------------------------------#
# builders
#--------------------------------------------------------------------------#
sub _build_number_of_seeds {
my ($self) = @_;
return scalar @{ $self->uri->hostids };
}
sub _truncate_for_handshake {
my $str = shift;
return substr( $str, 0, 64 );
}
sub _build_handshake_document {
my ($self) = @_;
my $driver_version_without_leading_v = substr( $VERSION, 1 );
return to_IxHash(
[
( length( $self->app_name ) ? ( application => { name => $self->app_name } ) : () ),
driver => to_IxHash(
[
name => "MongoDB Perl Driver",
version => $driver_version_without_leading_v,
]
),
os => { type => _truncate_for_handshake(MongoDB::_Platform::os_type) },
platform => _truncate_for_handshake(MongoDB::_Platform::platform_details)
]
);
}
sub BUILD {
my ($self) = @_;
my $type = $self->type;
my @addresses = @{ $self->uri->hostids };
# clone bson codec to disable dt_type
$self->{bson_codec} = $self->bson_codec->clone( dt_type => undef );
if ( my $set_name = $self->replica_set_name ) {
if ( $type eq 'Single' || $type eq 'ReplicaSetNoPrimary' ) {
# these are valid, so nothing to do here
}
elsif ( $type eq 'Unknown' ) {
$self->_set_type('ReplicaSetNoPrimary');
}
else {
MongoDB::InternalError->throw(
"deployment with set name '$set_name' may not be initialized as type '$type'");
}
}
if ( $type eq 'Single' && @addresses > 1 ) {
MongoDB::InternalError->throw(
"topology type 'Single' cannot be used with multiple addresses: @addresses");
}
$self->_add_address_as_unknown($_) for @addresses;
return;
}
#--------------------------------------------------------------------------#
# public methods
#--------------------------------------------------------------------------#
sub all_servers { return values %{ $_[0]->servers } }
sub check_address {
my ( $self, $address ) = @_;
my $link = $self->links->{$address};
if ( $link && $link->is_connected ) {
$self->_update_topology_from_link( $link, with_handshake => 0 );
}
else {
# initialize_link will call update_topology_from_link
$self->_initialize_link($address);
}
return;
}
sub close_all_links {
my ($self) = @_;
delete $self->links->{ $_->address } for $self->all_servers;
return;
}
sub get_readable_link {
my ( $self, $read_pref ) = @_;
my $mode = $read_pref ? lc $read_pref->mode : 'primary';
my $method =
$self->type eq "Single" ? '_find_available_server'
: $self->type eq "Sharded" ? '_find_readable_mongos_server'
: "_find_${mode}_server";
if ( $mode eq 'primary' && $self->current_primary && $self->next_scan_time > time() )
{
my $link = $self->_get_server_link( $self->current_primary, $method );
return $link if $link;
}
while ( my $server = $self->_selection_timeout( $method, $read_pref ) ) {
my $link = $self->_get_server_link( $server, $method, $read_pref );
if ($link) {
$self->_set_current_primary($server)
if $mode eq 'primary'
&& ( $self->type eq "ReplicaSetWithPrimary"
|| 1 == keys %{ $self->servers } );
return $link;
}
}
my $rp = $read_pref ? $read_pref->as_string : 'primary';
MongoDB::SelectionError->throw(
"No readable server available for matching read preference $rp. MongoDB server status:\n"
. $self->_status_string );
}
sub get_specific_link {
my ( $self, $address ) = @_;
my $server = $self->servers->{$address};
if ( $server && ( my $link = $self->_get_server_link($server) ) ) {
return $link;
}
else {
MongoDB::SelectionError->throw("Server $address is no longer available");
}
}
sub get_writable_link {
my ($self) = @_;
my $method =
( $self->type eq "Single" || $self->type eq "Sharded" )
? '_find_available_server'
: "_find_primary_server";
if ( $self->current_primary && $self->next_scan_time > time() ) {
my $link = $self->_get_server_link( $self->current_primary, $method );
return $link if $link;
}
while ( my $server = $self->_selection_timeout($method) ) {
my $link = $self->_get_server_link( $server, $method );
if ($link) {
$self->_set_current_primary($server)
if $self->type eq "ReplicaSetWithPrimary"
|| 1 == keys %{ $self->servers };
return $link;
}
}
MongoDB::SelectionError->throw(
"No writable server available. MongoDB server status:\n" . $self->_status_string );
}
sub mark_server_unknown {
my ( $self, $server, $error ) = @_;
$self->_reset_address_to_unknown( $server->address, $error );
return;
}
sub mark_stale {
my ($self) = @_;
$self->_set_stale(1);
return;
}
sub scan_all_servers {
my ($self) = @_;
my ( $next, @ordinary, @to_check );
my $start_time = time;
my $cooldown_time = $start_time - COOLDOWN_SECS;
# anything not updated since scan start is eligible for a check; when all servers
# are updated, the loop terminates; Unknown servers aren't checked if
# they are in the cooldown window since we don't want to wait the connect
# timeout each attempt when they are unlikely to have changed status
while (1) {
@to_check =
grep {
$_->type eq 'Unknown'
? !$_->updated_since($cooldown_time)
: !$_->updated_since($start_time)
} $self->all_servers;
last unless @to_check;
if ( $next = first { $_->type eq 'RSPrimary' } @to_check ) {
$self->check_address( $next->address );
}
elsif ( $next = first { $_->type eq 'PossiblePrimary' } @to_check ) {
$self->check_address( $next->address );
}
elsif ( @ordinary = grep { $_->type ne 'Unknown' && $_->type ne 'RSGhost' } @to_check ) {
$self->_check_oldest_server(@ordinary);
}
else {
$self->_check_oldest_server(@to_check);
}
}
my $now = time();
$self->_set_last_scan_time( $now );
$self->_set_next_scan_time( $now + $self->heartbeat_frequency_sec );
$self->_set_stale( 0 );
$self->_check_wire_versions;
return;
}
sub status_struct {
my ($self) = @_;
my $status = { topology_type => $self->type, };
$status->{replica_set_name} = $self->replica_set_name if $self->replica_set_name;
# convert from [sec, microsec] array to floating point
$status->{last_scan_time} = $self->last_scan_time;
my $rtt_hash = $self->rtt_ewma_sec;
my $ss = $status->{servers} = [];
for my $server ( $self->all_servers ) {
my $addr = $server->address;
my $server_struct = $server->status_struct;
if ( defined $rtt_hash->{$addr} ) {
$server_struct->{ewma_rtt_sec} = $rtt_hash->{$addr};
}
push @$ss, $server_struct;
}
return $status;
}
#--------------------------------------------------------------------------#
# private methods
#--------------------------------------------------------------------------#
sub _add_address_as_unknown {
my ( $self, $address, $last_update, $error ) = @_;
$error = $error ? "$error" : "";
$error =~ s/ at \S+ line \d+.*//ms;
return $self->servers->{$address} = MongoDB::_Server->new(
address => $address,
last_update_time => $last_update || EPOCH,
error => $error,
);
}
sub _check_for_primary {
my ($self) = @_;
if ( 0 == $self->_primaries ) {
$self->_set_type('ReplicaSetNoPrimary');
$self->_clear_current_primary;
return 0;
}
return 1;
}
sub _check_oldest_server {
my ( $self, @to_check ) = @_;
my @ordered =
map { $_->[0] }
sort { $a->[1] <=> $b->[1] || rand() <=> rand() } # random if equal
map { [ $_, $_->last_update_time ] } # ignore partial secs
@to_check;
$self->check_address( $ordered[0]->address );
return;
}
my $max_int32 = 2147483647;
sub _check_wire_versions {
my ($self) = @_;
my $compat = 1;
my $min_seen = $max_int32;
for my $server ( grep { $_->is_available } $self->all_servers ) {
my ( $server_min_wire_version, $server_max_wire_version ) =
@{ $server->is_master }{qw/minWireVersion maxWireVersion/};
$server_max_wire_version = 0 unless defined $server_max_wire_version;
$server_min_wire_version = 0 unless defined $server_min_wire_version;
$compat = 0
if $server_min_wire_version > $self->max_wire_version
|| $server_max_wire_version < $self->min_wire_version;
$min_seen = $server_max_wire_version if $server_max_wire_version < $min_seen;
}
$self->_set_is_compatible($compat);
$self->_set_wire_version_floor($min_seen);
return;
}
sub _check_staleness_compatibility {
my ($self, $read_pref) = @_;
my $max_staleness_sec = $read_pref ? $read_pref->max_staleness_seconds : -1;
if ( $max_staleness_sec > 0 ) {
if ( $self->wire_version_floor < 5 ) {
MongoDB::ProtocolError->throw(
"Incompatible wire protocol version. You tried to use max_staleness_seconds with one or more servers that don't support it."
);
}
if (
( $self->type eq "ReplicaSetWithPrimary" || $self->type eq "ReplicaSetNoPrimary" )
&& $max_staleness_sec < max( SMALLEST_MAX_STALENESS_SEC,
$self->heartbeat_frequency_sec + IDLE_WRITE_PERIOD_SEC
)
)
{
MongoDB::UsageError->throw(
"max_staleness_seconds must be at least 90 seconds and at least heartbeat_frequency (in secs) + 10 secs"
);
}
}
return;
}
sub _dump {
my ($self) = @_;
print $self->_status_string . "\n";
}
sub _eligible {
my ( $self, $read_pref, @candidates ) = @_;
# must filter on max staleness first, so that the remaining servers
# are checked against the list of tag_sets
if ( $read_pref->max_staleness_seconds > 0 ) {
@candidates = $self->_filter_fresh_servers($read_pref, @candidates );
return unless @candidates;
};
# given a tag set list, if a tag set matches at least one
# candidate, then all candidates matching that tag set are eligible
if ( ! $read_pref->has_empty_tag_sets ) {
for my $ts ( @{ $read_pref->tag_sets } ) {
if ( my @ts_candidates = grep { $_->matches_tag_set($ts) } @candidates ) {
return @ts_candidates;
}
}
return;
}
return @candidates;
}
sub _filter_fresh_servers {
my ($self, $read_pref, @candidates) = @_;
# all values should be floating point seconds
my $max_staleness_sec = $read_pref->max_staleness_seconds;
my $heartbeat_frequency_sec = $self->heartbeat_frequency_sec;
if ( $self->type eq 'ReplicaSetWithPrimary' ) {
my ($primary) = $self->_primaries;
# all values should be floating point seconds
my $p_last_write_date = $primary->last_write_date;
my $p_last_update_time = $primary->last_update_time;
return map { $_->[0] }
grep { $_->[1] <= $max_staleness_sec }
map {
[
$_,
$p_last_write_date
+ ( $_->last_update_time - $p_last_update_time )
- $_->last_write_date
+ $heartbeat_frequency_sec
]
} @candidates;
}
else {
my ($smax) = map { $_->[0] }
sort { $b->[1] <=> $a->[1] }
map { [ $_, $_->last_write_date ] } $self->_secondaries;
my $smax_last_write_date = $smax->last_write_date;
return map { $_->[0] }
grep { $_->[1] <= $max_staleness_sec }
map {
[ $_, $smax_last_write_date - $_->last_write_date + $heartbeat_frequency_sec ]
} @candidates;
}
}
# This works for reads and writes; for writes, $read_pref will be undef
sub _find_available_server {
my ( $self, $read_pref, @candidates ) = @_;
$self->_check_staleness_compatibility($read_pref) if $read_pref;
push @candidates, $self->all_servers unless @candidates;
return $self->_get_server_in_latency_window(
[ grep { $_->is_available } @candidates ] );
}
# This uses read preference to check for max staleness compatibility in
# mongos, but otherwise read preference is ignored (mongos will pass it on)
sub _find_readable_mongos_server {
my ( $self, $read_pref, @candidates ) = @_;
$self->_check_staleness_compatibility($read_pref);
push @candidates, $self->all_servers unless @candidates;
return $self->_get_server_in_latency_window(
[ grep { $_->is_available } @candidates ] );
}
sub _find_nearest_server {
my ( $self, $read_pref, @candidates ) = @_;
$self->_check_staleness_compatibility($read_pref);
push @candidates, ( $self->_primaries, $self->_secondaries ) unless @candidates;
my @suitable = $self->_eligible( $read_pref, @candidates );
return $self->_get_server_in_latency_window( \@suitable );
}
sub _find_primary_server {
my ( $self, undef, @candidates ) = @_;
return $self->current_primary
if $self->current_primary;
push @candidates, $self->all_servers unless @candidates;
return first { $_->is_writable } @candidates;
}
sub _find_primarypreferred_server {
my ( $self, $read_pref, @candidates ) = @_;
$self->_check_staleness_compatibility($read_pref);
return $self->_find_primary_server(@candidates)
|| $self->_find_secondary_server( $read_pref, @candidates );
}
sub _find_secondary_server {
my ( $self, $read_pref, @candidates ) = @_;
$self->_check_staleness_compatibility($read_pref);
push @candidates, $self->_secondaries unless @candidates;
my @suitable = $self->_eligible( $read_pref, @candidates );
return $self->_get_server_in_latency_window( \@suitable );
}
sub _find_secondarypreferred_server {
my ( $self, $read_pref, @candidates ) = @_;
$self->_check_staleness_compatibility($read_pref);
return $self->_find_secondary_server( $read_pref, @candidates )
|| $self->_find_primary_server(@candidates);
}
sub _get_server_in_latency_window {
my ( $self, $servers ) = @_;
return unless @$servers;
return $servers->[0] if @$servers == 1;
# order servers by RTT EWMA
my $rtt_hash = $self->rtt_ewma_sec;
my @sorted =
sort { $a->{rtt} <=> $b->{rtt} }
map { { server => $_, rtt => $rtt_hash->{ $_->address } } } @$servers;
# lowest RTT is always in the windows
my @in_window = shift @sorted;
# add any other servers in window and return a random one
my $max_rtt = $in_window[0]->{rtt} + $self->local_threshold_sec;
push @in_window, grep { $_->{rtt} <= $max_rtt } @sorted;
return $in_window[ int( rand(@in_window) ) ]->{server};
}
sub _get_server_link {
my ( $self, $server, $method, $read_pref ) = @_;
my $address = $server->address;
my $link = $self->links->{$address};
# if no link, make a new connection or give up
$link = $self->_initialize_link($address) unless $link && $link->connected;
return unless $link;
# for idle links, refresh the server and verify validity
if ( time - $link->last_used > $self->socket_check_interval_sec ) {
$self->check_address($address);
# topology might have dropped the server
$server = $self->servers->{$address}
or return;
my $fresh_link = $self->links->{$address};
return $fresh_link if !$method;
# verify selection criteria
return $self->$method( $read_pref, $server ) ? $fresh_link : undef;
}
return $link;
}
sub _initialize_link {
my ( $self, $address ) = @_;
my $link = try {
MongoDB::_Link->new( %{$self->link_options}, address => $address )->connect;
}
catch {
# if connection failed, update topology with Unknown description
$self->_reset_address_to_unknown( $address, $_ );
return;
};
return unless $link;
# connection succeeded, so register link and get a server description
$self->links->{$address} = $link;
$self->_update_topology_from_link( $link, with_handshake => 1 );
# after update, server might or might not exist in the topology;
# if not, return nothing
return unless my $server = $self->servers->{$address};
# we have a link and the server is a valid member, so
# try to authenticate; if authentication fails, all
# servers are considered invalid and we throw an error
if ( $self->type eq 'Single' || first { $_ eq $server->type } qw/Standalone Mongos RSPrimary RSSecondary/ ) {
try {
$self->credential->authenticate($link, $self->bson_codec);
}
catch {
my $err = $_;
$self->_reset_address_to_unknown( $_->address, $err ) for $self->all_servers;
MongoDB::AuthError->throw("Authentication to $address failed: $err");
};
}
return $link;
}
sub _primaries {
return grep { $_->type eq 'RSPrimary' } $_[0]->all_servers;
}
sub _remove_address {
my ( $self, $address ) = @_;
if ( $self->current_primary && $self->current_primary->address eq $address ) {
$self->_clear_current_primary;
}
delete $self->$_->{$address} for qw/servers links rtt_ewma_sec/;
return;
}
sub _remove_server {
my ( $self, $server ) = @_;
$self->_remove_address( $server->address );
return;
}
sub _reset_address_to_unknown {
my ( $self, $address, $error, $update_time ) = @_;
$update_time ||= time;
$self->_remove_address($address);
my $desc = $self->_add_address_as_unknown( $address, $update_time, $error );
$self->_update_topology_from_server_desc($address, $desc);
return;
}
sub _secondaries {
return grep { $_->type eq 'RSSecondary' } $_[0]->all_servers;
}
sub _status_string {
my ($self) = @_;
my $status = '';
if ( $self->type =~ /^Replica/ ) {
$status .= sprintf( "Topology type: %s; Set name: %s, Member status:\n",
$self->type, $self->replica_set_name );
}
else {
$status .= sprintf( "Topology type: %s; Member status:\n", $self->type );
}
$status .= join( "\n", map { " $_" } map { $_->status_string } $self->all_servers ) . "\n";
return $status;
}
# this implements the server selection timeout around whatever actual method
# is used for returning a link
sub _selection_timeout {
my ( $self, $method, $read_pref ) = @_;
my $start_time = my $loop_end_time = time();
my $max_time = $start_time + $self->server_selection_timeout_sec;
if ( $self->next_scan_time < $start_time ) {
$self->_set_stale(1);
}
while (1) {
if ( $self->stale ) {
my $scan_ready_time = $self->last_scan_time + MIN_HEARTBEAT_FREQUENCY_SEC;
# if not enough time left to wait to check; then caller throws error
return if !$self->server_selection_try_once && $scan_ready_time > $max_time;
# loop_end_time is a proxy for time() to avoid overhead
my $sleep_time = $scan_ready_time - $loop_end_time;
usleep( 1e6 * $sleep_time ) if $sleep_time > 0;
$self->scan_all_servers;
}
unless ( $self->is_compatible ) {
$self->_set_stale(1);
MongoDB::ProtocolError->throw(
"Incompatible wire protocol version. This version of the MongoDB driver is not compatible with the server. You probably need to upgrade this library."
);
}
my $server = $self->$method($read_pref);
return $server if $server;
$self->_set_stale(1);
$loop_end_time = time();
if ( $self->server_selection_try_once ) {
# if already tried once; then caller throws error
return if $self->last_scan_time > $start_time;
}
else {
# if selection timed out; then caller throws error
return if $loop_end_time > $max_time;
}
}
}
my $PRIMARY = MongoDB::ReadPreference->new;
sub _generate_ismaster_request {
my ($self, $should_perform_handshake) = @_;
return [
ismaster => 1,
($should_perform_handshake ? (client => $self->handshake_document) : ()),
];
}
sub _update_topology_from_link {
my ( $self, $link, %opts ) = @_;
my $start_time = time;
my $is_master = eval {
my $op = MongoDB::Op::_Command->_new(
db_name => 'admin',
query => $self->_generate_ismaster_request( $opts{with_handshake} ),
query_flags => {},
bson_codec => $self->bson_codec,
read_preference => $PRIMARY,
);
# just for this command, use connect timeout as socket timeout;
# this violates encapsulation, but requires less API modification
# to support this specific exception to the socket timeout
local $link->{socket_timeout} = $link->{connect_timeout};
$op->execute( $link )->output;
};
if ( $@ ) {
local $_ = $@;
warn "During MongoDB topology update for @{[$link->address]}: $_"
if WITH_ASSERTS;
$self->_reset_address_to_unknown( $link->address, $_ );
# retry a network error if server was previously known to us
if ( $_->$_isa("MongoDB::NetworkError")
and $link->server
and $link->server->type ne 'Unknown'
and $link->server->type ne 'PossiblePrimary' )
{
# the earlier reset to unknown avoids us reaching this branch again
# and recursing forever
$self->check_address( $link->address );
}
return;
};
return unless $is_master;
my $end_time = time;
my $rtt_sec = $end_time - $start_time;
my $new_server = MongoDB::_Server->new(
address => $link->address,
last_update_time => $end_time,
rtt_sec => $rtt_sec,
is_master => $is_master,
);
$self->_update_topology_from_server_desc( $link->address, $new_server );
return;
}
sub _update_topology_from_server_desc {
my ( $self, $address, $new_server ) = @_;
# ignore spurious result not in the set; this isn't strictly necessary
# for single-threaded operation, but spec tests expect it and if we
# have async monitoring in the future, late responses could come back
# after a server has been removed
return unless $self->servers->{$address};
$self->_update_ewma( $address, $new_server );
# must come after ewma update
$self->servers->{$address} = $new_server;
my $method = "_update_" . $self->type;
$self->$method( $address, $new_server );
# if link is still around, tag it with server specifics
$self->_update_link_metadata( $address, $new_server );
return $new_server;
}
sub _update_ewma {
my ( $self, $address, $new_server ) = @_;
if ( $new_server->type eq 'Unknown' ) {
delete $self->rtt_ewma_sec->{$address};
}
else {
my $old_avg = $self->rtt_ewma_sec->{$address};
my $alpha = $self->ewma_alpha;
my $rtt_sec = $new_server->rtt_sec;
$self->rtt_ewma_sec->{$address} =
defined($old_avg) ? ( $alpha * $rtt_sec + ( 1 - $alpha ) * $old_avg ) : $rtt_sec;
}
return;
}
sub _update_link_metadata {
my ( $self, $address, $server ) = @_;
# if the link didn't get dropped from the topology during the update, we
# attach the server so the link knows where it came from
if ( $self->links->{$address} ) {
$self->links->{$address}->set_metadata($server);
}
return;
}
sub _update_rs_with_primary_from_member {
my ( $self, $new_server ) = @_;
if ( !$self->servers->{ $new_server->address }
|| $self->replica_set_name ne $new_server->set_name )
{
$self->_remove_server($new_server);
}
# require 'me' that matches expected address
if ( $new_server->me && $new_server->me ne $new_server->address ) {
$self->_remove_server($new_server);
$self->_check_for_primary;
return;
}
if ( ! $self->_check_for_primary ) {
# flag possible primary to amend scanning order
my $primary = $new_server->primary;
if ( length($primary)
&& $self->servers->{$primary}
&& $self->servers->{$primary}->type eq 'Unknown' )
{
$self->servers->{$primary}->_set_type('PossiblePrimary');
}
}
return;
}
sub _update_rs_with_primary_from_primary {
my ( $self, $new_server ) = @_;
if ( !length $self->replica_set_name ) {
$self->_set_replica_set_name( $new_server->set_name );
}
elsif ( $self->replica_set_name ne $new_server->set_name ) {
# We found a primary but it doesn't have the setName
# provided by the user or previously discovered
$self->_remove_server($new_server);
return;
}
my $election_id = $new_server->is_master->{electionId};
my $set_version = $new_server->is_master->{setVersion};
my $max_election_id = $self->max_election_id;
my $max_set_version = $self->max_set_version;
if ( defined $set_version && defined $election_id ) {
if (
defined $max_election_id
&& defined $max_set_version
&& (
$max_set_version > $set_version
|| ( $max_set_version == $set_version
&& "$max_election_id" gt "$election_id" )
)
)
{
# stale primary
$self->_remove_address( $new_server->address );
$self->_add_address_as_unknown( $new_server->address );
$self->_check_for_primary;
return;
}
$self->_set_max_election_id( $election_id );
}
if ( defined $set_version
&& ( !defined $max_set_version || $set_version > $max_set_version ) )
{
$self->_set_max_set_version($set_version);
}
# possibly invalidate an old primary (even if more than one!)
for my $old_primary ( $self->_primaries ) {
if ( $old_primary->address ne $new_server->address ) {
$self->_reset_address_to_unknown(
$old_primary->address,
"no longer primary; update needed",
$old_primary->last_update_time
);
}
}
# unknown set members need to be added to the topology
my %set_members =
map { $_ => undef } map { @{ $new_server->$_ } } qw/hosts passives arbiters/;
$self->_add_address_as_unknown($_)
for grep { !exists $self->servers->{$_} } keys %set_members;
# topology servers no longer in the set need to be removed
$self->_remove_address($_)
for grep { !exists $set_members{$_} } keys %{ $self->servers };
return;
}
sub _update_rs_without_primary {
my ( $self, $new_server ) = @_;
if ( !length $self->replica_set_name ) {
$self->_set_replica_set_name( $new_server->set_name );
}
elsif ( $self->replica_set_name ne $new_server->set_name ) {
$self->_remove_server($new_server);
return;
}
# unknown set members need to be added to the topology
my %set_members =
map { $_ => undef } map { @{ $new_server->$_ } } qw/hosts passives arbiters/;
$self->_add_address_as_unknown($_)
for grep { !exists $self->servers->{$_} } keys %set_members;
# require 'me' that matches expected address
if ( $new_server->me && $new_server->me ne $new_server->address ) {
$self->_remove_server($new_server);
return;
}
# flag possible primary to amend scanning order
my $primary = $new_server->primary;
if ( length($primary)
&& $self->servers->{$primary}
&& $self->servers->{$primary}->type eq 'Unknown' )
{
$self->servers->{$primary}->_set_type('PossiblePrimary');
}
return;
}
#--------------------------------------------------------------------------#
# update methods by topology types: behavior in each depends on new server
# type received
#--------------------------------------------------------------------------#
sub _update_ReplicaSetNoPrimary {
my ( $self, $address, $new_server ) = @_;
my $server_type = $new_server->type;
if ( $server_type eq 'RSPrimary' ) {
$self->_set_type('ReplicaSetWithPrimary');
$self->_update_rs_with_primary_from_primary($new_server);
# topology changes might have removed all primaries
$self->_check_for_primary;
}
elsif ( grep { $server_type eq $_ } qw/RSSecondary RSArbiter RSOther/ ) {
$self->_update_rs_without_primary($new_server);
}
elsif ( grep { $server_type eq $_ } qw/Standalone Mongos/ ) {
$self->_remove_server($new_server);
}
else {
# Unknown or RSGhost are no-ops
}
return;
}
sub _update_ReplicaSetWithPrimary {
my ( $self, $address, $new_server ) = @_;
my $server_type = $new_server->type;
if ( $server_type eq 'RSPrimary' ) {
$self->_update_rs_with_primary_from_primary($new_server);
}
elsif ( grep { $server_type eq $_ } qw/RSSecondary RSArbiter RSOther/ ) {
$self->_update_rs_with_primary_from_member($new_server);
}
elsif ( grep { $server_type eq $_ } qw/Unknown Standalone Mongos/ ) {
$self->_remove_server($new_server)
unless $server_type eq 'Unknown';
}
else {
# RSGhost is no-op
}
# topology changes might have removed all primaries
$self->_check_for_primary;
return;
}
sub _update_Sharded {
my ( $self, $address, $new_server ) = @_;
my $server_type = $new_server->type;
if ( grep { $server_type eq $_ } qw/Unknown Mongos/ ) {
# no-op
}
else {
$self->_remove_server($new_server);
}
return;
}
sub _update_Single {
my ( $self, $address, $new_server ) = @_;
# Per the spec, TopologyType Single never changes type or membership
return;
}
sub _update_Unknown {
my ( $self, $address, $new_server ) = @_;
my $server_type = $new_server->type;
if ( $server_type eq 'Standalone' ) {
if ( $self->number_of_seeds == 1 ) {
$self->_set_type('Single');
}
else {
# a standalone server with multiple seeds is a replica set member
# in maintenance mode; we drop it and may pick it up later if it
# rejoins the replica set.
$self->_remove_address($address);
}
}
elsif ( $server_type eq 'Mongos' ) {
$self->_set_type('Sharded');
}
elsif ( $server_type eq 'RSPrimary' ) {
$self->_set_type('ReplicaSetWithPrimary');
$self->_update_rs_with_primary_from_primary($new_server);
# topology changes might have removed all primaries
$self->_check_for_primary;
}
elsif ( grep { $server_type eq $_ } qw/RSSecondary RSArbiter RSOther/ ) {
$self->_set_type('ReplicaSetNoPrimary');
$self->_update_rs_without_primary($new_server);
}
else {
# Unknown or RSGhost are no-ops
}
return;
}
1;
# vim: ts=4 sts=4 sw=4 et:
|