/usr/share/perl5/Gearman/Server.pm is in gearman-server 1.11-2.
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 | package Gearman::Server;
=head1 NAME
Gearman::Server - function call "router" and load balancer
=head1 DESCRIPTION
You run a Gearman server (or more likely, many of them for both
high-availability and load balancing), then have workers (using
L<Gearman::Worker> from the Gearman module, or libraries for other
languages) register their ability to do certain functions to all of
them, and then clients (using L<Gearman::Client>,
L<Gearman::Client::Async>, etc) request work to be done from one of
the Gearman servers.
The servers connect them, routing function call requests to the
appropriate workers, multiplexing responses to duplicate requests as
requested, etc.
More than likely, you want to use the provided L<gearmand> wrapper
script, and not use Gearman::Server directly.
=cut
use strict;
use Gearman::Server::Client;
use Gearman::Server::Listener;
use Gearman::Server::Job;
use Socket qw(IPPROTO_TCP SOL_SOCKET SOCK_STREAM AF_UNIX SOCK_STREAM PF_UNSPEC);
use Carp qw(croak);
use Sys::Hostname ();
use IO::Handle ();
use fields (
'client_map', # fd -> Client
'sleepers', # func -> { "Client=HASH(0xdeadbeef)" => Client }
'sleepers_list', # func -> [ Client, ... ], ...
'job_queue', # job_name -> [Job, Job*] (key only exists if non-empty)
'job_of_handle', # handle -> Job
'max_queue', # func -> configured max jobqueue size
'job_of_uniq', # func -> uniq -> Job
'handle_ct', # atomic counter
'handle_base', # atomic counter
'listeners', # arrayref of listener objects
'wakeup', # number of workers to wake
'wakeup_delay', # seconds to wait before waking more workers
'wakeup_timers', # func -> timer, timer to be canceled or adjusted when job grab/inject is called
);
our $VERSION = "1.11";
=head1 METHODS
=head2 new
$server_object = Gearman::Server->new( %options )
Creates and returns a new Gearman::Server object, which attaches itself to the Danga::Socket event loop. The server will begin operating when the Danga::Socket runloop is started. This means you need to start up the runloop before anything will happen.
Options:
=over
=item port
Specify a port which you would like the Gearman::Server to listen on for TCP connections (not necessary, but useful)
=back
=cut
sub new {
my ($class, %opts) = @_;
my $self = ref $class ? $class : fields::new($class);
$self->{client_map} = {};
$self->{sleepers} = {};
$self->{sleepers_list} = {};
$self->{job_queue} = {};
$self->{job_of_handle} = {};
$self->{max_queue} = {};
$self->{job_of_uniq} = {};
$self->{listeners} = [];
$self->{wakeup} = 3;
$self->{wakeup_delay} = .1;
$self->{wakeup_timers} = {};
$self->{handle_ct} = 0;
$self->{handle_base} = "H:" . Sys::Hostname::hostname() . ":";
my $port = delete $opts{port};
my $wakeup = delete $opts{wakeup};
if (defined $wakeup) {
die "Invalid value passed in wakeup option"
if $wakeup < 0 && $wakeup != -1;
$self->{wakeup} = $wakeup;
}
my $wakeup_delay = delete $opts{wakeup_delay};
if (defined $wakeup_delay) {
die "Invalid value passed in wakeup_delay option"
if $wakeup_delay < 0 && $wakeup_delay != -1;
$self->{wakeup_delay} = $wakeup_delay;
}
croak("Unknown options") if %opts;
$self->create_listening_sock($port);
return $self;
}
sub debug {
my ($self, $msg) = @_;
#warn "$msg\n";
}
=head2 create_listening_sock
$server_object->create_listening_sock( $portnum )
Add a TCP port listener for incoming Gearman worker and client connections.
=cut
sub create_listening_sock {
my ($self, $portnum, %opts) = @_;
my $accept_per_loop = delete $opts{accept_per_loop};
warn "Extra options passed into create_listening_sock: " . join(', ', keys %opts) . "\n"
if keys %opts;
my $ssock = IO::Socket::INET->new(LocalPort => $portnum,
Type => SOCK_STREAM,
Proto => IPPROTO_TCP,
Blocking => 0,
Reuse => 1,
Listen => 1024 )
or die "Error creating socket: $@\n";
my $listeners = $self->{listeners};
push @$listeners, Gearman::Server::Listener->new($ssock, $self, accept_per_loop => $accept_per_loop);
return $ssock;
}
sub new_client {
my ($self, $sock) = @_;
my $client = Gearman::Server::Client->new($sock, $self);
$client->watch_read(1);
$self->{client_map}{$client->{fd}} = $client;
}
sub note_disconnected_client {
my ($self, $client) = @_;
delete $self->{client_map}{$client->{fd}};
}
sub clients {
my $self = shift;
return values %{ $self->{client_map} };
}
# Returns a socket that is connected to the server, we can then use this
# socket with a Gearman::Client::Async object to run clients and servers in the
# same thread.
sub to_inprocess_server {
my $self = shift;
my ($psock, $csock);
socketpair($csock, $psock, AF_UNIX, SOCK_STREAM, PF_UNSPEC)
or die "socketpair: $!";
$csock->autoflush(1);
$psock->autoflush(1);
IO::Handle::blocking($csock, 0);
IO::Handle::blocking($psock, 0);
my $client = Gearman::Server::Client->new($csock, $self);
my ($package, $file, $line) = caller;
$client->{peer_ip} = "[$package|$file|$line]";
$client->watch_read(1);
$self->{client_map}{$client->{fd}} = $client;
return $psock;
}
=head2 start_worker
$pid = $server_object->start_worker( $prog )
($pid, $client) = $server_object->start_worker( $prog )
Fork and start a worker process named by C<$prog> and returns the pid (or pid and client object).
=cut
sub start_worker {
my ($self, $prog) = @_;
my ($psock, $csock);
socketpair($csock, $psock, AF_UNIX, SOCK_STREAM, PF_UNSPEC)
or die "socketpair: $!";
$csock->autoflush(1);
$psock->autoflush(1);
my $pid = fork;
unless (defined $pid) {
warn "fork failed: $!\n";
return undef;
}
# child process
unless ($pid) {
local $ENV{'GEARMAN_WORKER_USE_STDIO'} = 1;
close(STDIN);
close(STDOUT);
open(STDIN, '<&', $psock) or die "Unable to dup socketpair to STDIN: $!";
open(STDOUT, '>&', $psock) or die "Unable to dup socketpair to STDOUT: $!";
if (UNIVERSAL::isa($prog, "CODE")) {
$prog->();
exit 0; # shouldn't get here. subref should exec.
}
exec $prog;
die "Exec failed: $!";
}
close($psock);
IO::Handle::blocking($csock, 0);
my $sock = $csock;
my $client = Gearman::Server::Client->new($sock, $self);
$client->{peer_ip} = "[gearman_child]";
$client->watch_read(1);
$self->{client_map}{$client->{fd}} = $client;
return wantarray ? ($pid, $client) : $pid;
}
sub enqueue_job {
my ($self, $job, $highpri) = @_;
my $jq = ($self->{job_queue}{$job->{func}} ||= []);
if (defined (my $max_queue_size = $self->{max_queue}{$job->{func}})) {
$max_queue_size--; # Subtract one, because we're about to add one more below.
while (@$jq > $max_queue_size) {
my $delete_job = pop @$jq;
my $msg = Gearman::Util::pack_res_command("work_fail", $delete_job->handle);
$delete_job->relay_to_listeners($msg);
$delete_job->note_finished;
}
}
if ($highpri) {
unshift @$jq, $job;
} else {
push @$jq, $job;
}
$self->{job_of_handle}{$job->{'handle'}} = $job;
}
sub wake_up_sleepers {
my ($self, $func) = @_;
if (my $existing_timer = delete($self->{wakeup_timers}->{$func})) {
$existing_timer->cancel();
}
return unless $self->_wake_up_some($func);
my $delay = $self->{wakeup_delay};
# -1 means don't setup a timer. 0 actually means go as fast as we can, cooperatively.
return if $delay == -1;
# If we're only going to wakeup 0 workers anyways, don't set up a timer.
return if $self->{wakeup} == 0;
my $timer = Danga::Socket->AddTimer($delay, sub {
# Be sure to not wake up more sleepers if we have no jobs in the queue.
# I know the object definition above says I can trust the func element to determine
# if there are items in the list, but I'm just gonna be safe, rather than sorry.
return unless @{$self->{job_queue}{$func} || []};
$self->wake_up_sleepers($func)
});
$self->{wakeup_timers}->{$func} = $timer;
}
# Returns true when there are still more workers to wake up
# False if there are no sleepers
sub _wake_up_some {
my ($self, $func) = @_;
my $sleepmap = $self->{sleepers}{$func} or return;
my $sleeporder = $self->{sleepers_list}{$func} or return;
# TODO SYNC UP STATE HERE IN CASE TWO LISTS END UP OUT OF SYNC
my $max = $self->{wakeup};
while (@$sleeporder) {
my Gearman::Server::Client $c = shift @$sleeporder;
next if $c->{closed} || ! $c->{sleeping};
if ($max-- <= 0) {
unshift @$sleeporder, $c;
return 1;
}
delete $sleepmap->{"$c"};
$c->res_packet("noop");
$c->{sleeping} = 0;
}
delete $self->{sleepers}{$func};
delete $self->{sleepers_list}{$func};
return;
}
sub on_client_sleep {
my $self = shift;
my Gearman::Server::Client $cl = shift;
foreach my $cd (@{$cl->{can_do_list}}) {
# immediately wake the sleeper up if there are things to be done
if ($self->{job_queue}{$cd}) {
$cl->res_packet("noop");
$cl->{sleeping} = 0;
return;
}
my $sleepmap = ($self->{sleepers}{$cd} ||= {});
my $count = $sleepmap->{"$cl"}++;
next if $count >= 2;
my $sleeporder = ($self->{sleepers_list}{$cd} ||= []);
# The idea here is to keep workers at the head of the list if they are doing work, hopefully
# this will allow extra workers that aren't needed to actually go 'idle' safely.
my $jobs_done = $cl->{jobs_done_since_sleep};
if ($jobs_done) {
unshift @$sleeporder, $cl;
} else {
push @$sleeporder, $cl;
}
$cl->{jobs_done_since_sleep} = 0;
}
}
sub jobs_outstanding {
my Gearman::Server $self = shift;
return scalar keys %{ $self->{job_queue} };
}
sub jobs {
my Gearman::Server $self = shift;
return values %{ $self->{job_of_handle} };
}
sub job_by_handle {
my ($self, $handle) = @_;
return $self->{job_of_handle}{$handle};
}
sub note_job_finished {
my Gearman::Server $self = shift;
my Gearman::Server::Job $job = shift;
if (my Gearman::Server::Client $worker = $job->worker) {
$worker->{jobs_done_since_sleep}++;
}
if (length($job->{uniq})) {
delete $self->{job_of_uniq}{$job->{func}}{$job->{uniq}};
}
delete $self->{job_of_handle}{$job->{handle}};
}
# <0/undef/"" to reset. else integer max depth.
sub set_max_queue {
my ($self, $func, $max) = @_;
if (defined $max && length $max && $max >= 0) {
$self->{max_queue}{$func} = int($max);
} else {
delete $self->{max_queue}{$func};
}
}
sub new_job_handle {
my $self = shift;
return $self->{handle_base} . (++$self->{handle_ct});
}
sub job_of_unique {
my ($self, $func, $uniq) = @_;
return undef unless $self->{job_of_uniq}{$func};
return $self->{job_of_uniq}{$func}{$uniq};
}
sub set_unique_job {
my ($self, $func, $uniq, $job) = @_;
$self->{job_of_uniq}{$func} ||= {};
$self->{job_of_uniq}{$func}{$uniq} = $job;
}
sub grab_job {
my ($self, $func) = @_;
return undef unless $self->{job_queue}{$func};
my $empty = sub {
delete $self->{job_queue}{$func};
return undef;
};
my Gearman::Server::Job $job;
while (1) {
$job = shift @{$self->{job_queue}{$func}};
return $empty->() unless $job;
return $job unless $job->require_listener;
foreach my Gearman::Server::Client $c (@{$job->{listeners}}) {
return $job if $c && ! $c->{closed};
}
$job->note_finished(0);
}
}
1;
__END__
=head1 SEE ALSO
L<gearmand>
=cut
|