Perl pipe reading overhaul : data size header
[OpenSRF.git] / src / perl / lib / OpenSRF / Server.pm
1 # ----------------------------------------------------------------
2 # Copyright (C) 2010 Equinox Software, Inc.
3 # Bill Erickson <erickson@esilibrary.com>
4 #
5 # This program is free software; you can redistribute it and/or
6 # modify it under the terms of the GNU General Public License
7 # as published by the Free Software Foundation; either version 2
8 # of the License, or (at your option) any later version.
9 #
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 # GNU General Public License for more details.
14 # ----------------------------------------------------------------
15 package OpenSRF::Server;
16 use strict;
17 use warnings;
18 use OpenSRF::Transport;
19 use OpenSRF::Application;
20 use OpenSRF::Utils::Config;
21 use OpenSRF::Transport::PeerHandle;
22 use OpenSRF::Utils::SettingsClient;
23 use OpenSRF::Utils::Logger qw($logger);
24 use OpenSRF::Transport::SlimJabber::Client;
25 use Encode;
26 use POSIX qw/:sys_wait_h :errno_h/;
27 use Fcntl qw(F_GETFL F_SETFL O_NONBLOCK);
28 use Time::HiRes qw/usleep/;
29 use IO::Select;
30 use Socket;
31 our $chatty = 1; # disable for production
32
33 use constant STATUS_PIPE_DATA_SIZE => 12;
34 use constant WRITE_PIPE_DATA_SIZE  => 12;
35
36 sub new {
37     my($class, $service, %args) = @_;
38     my $self = bless(\%args, $class);
39
40     $self->{service}        = $service; # service name
41     $self->{num_children}   = 0; # number of child processes
42     $self->{osrf_handle}    = undef; # xmpp handle
43     $self->{routers}        = []; # list of registered routers
44     $self->{active_list}    = []; # list of active children
45     $self->{idle_list}      = []; # list of idle children
46     $self->{pid_map}        = {}; # map of child pid to child for cleaner access
47     $self->{sig_pipe}       = 0;  # true if last syswrite failed
48
49     $self->{stderr_log} = $self->{stderr_log_path} . "/${service}_stderr.log" 
50         if $self->{stderr_log_path};
51
52     $self->{min_spare_children} ||= 0;
53
54     $self->{max_spare_children} = $self->{min_spare_children} + 1 if
55         $self->{max_spare_children} and
56         $self->{max_spare_children} <= $self->{min_spare_children};
57
58     return $self;
59 }
60
61 # ----------------------------------------------------------------
62 # Disconnects from routers and waits for child processes to exit.
63 # ----------------------------------------------------------------
64 sub cleanup {
65     my $self = shift;
66     my $no_exit = shift;
67
68     $logger->info("server: shutting down and cleaning up...");
69
70     # don't get sidetracked by signals while we're cleaning up.
71     # it could result in unexpected behavior with list traversal
72     $SIG{CHLD} = 'IGNORE';
73
74     # terminate the child processes
75     $self->kill_child($_) for
76         (@{$self->{idle_list}}, @{$self->{active_list}});
77
78     # de-register routers
79     $self->unregister_routers;
80
81     $self->{osrf_handle}->disconnect;
82
83     # clean up our dead children
84     $self->reap_children(1);
85
86     exit(0) unless $no_exit;
87 }
88
89 # ----------------------------------------------------------------
90 # Waits on the jabber socket for inbound data from the router.
91 # Each new message is passed off to a child process for handling.
92 # At regular intervals, wake up for min/max spare child maintenance
93 # ----------------------------------------------------------------
94 sub run {
95     my $self = shift;
96
97         $logger->set_service($self->{service});
98
99     $SIG{$_} = sub { $self->cleanup; } for (qw/INT TERM QUIT/);
100     $SIG{CHLD} = sub { $self->reap_children(); };
101
102     $self->spawn_children;
103     $self->build_osrf_handle;
104     $self->register_routers;
105     my $wait_time = 1;
106
107     # main server loop
108     while(1) {
109
110         $self->check_status;
111         $self->{child_died} = 0;
112
113         my $msg = $self->{osrf_handle}->process($wait_time);
114
115         # we woke up for any reason, reset the wait time to allow
116         # for idle maintenance as necessary
117         $wait_time = 1;
118
119         if($msg) {
120
121             if(my $child = pop(@{$self->{idle_list}})) {
122
123                 # we have an idle child to handle the request
124                 $chatty and $logger->internal("server: passing request to idle child $child");
125                 push(@{$self->{active_list}}, $child);
126                 $self->write_child($child, $msg);
127
128             } elsif($self->{num_children} < $self->{max_children}) {
129
130                 # spawning a child to handle the request
131                 $chatty and $logger->internal("server: spawning child to handle request");
132                 $self->write_child($self->spawn_child(1), $msg);
133
134             } else {
135                 $logger->warn("server: no children available, waiting... consider increasing " .
136                     "max_children for this application higher than $self->{max_children} ".
137                     "in the OpenSRF configuration if this message occurs frequently");
138                 $self->check_status(1); # block until child is available
139
140                 my $child = pop(@{$self->{idle_list}});
141                 push(@{$self->{active_list}}, $child);
142                 $self->write_child($child, $msg);
143             }
144
145         } else {
146
147             # don't perform idle maint immediately when woken by SIGCHLD
148             unless($self->{child_died}) {
149
150                 # when we hit equilibrium, there's no need for regular
151                 # maintenance, so set wait_time to 'forever'
152                 $wait_time = -1 if 
153                     !$self->perform_idle_maintenance and # no maintenance performed this time
154                     @{$self->{active_list}} == 0; # no active children 
155             }
156         }
157     }
158 }
159
160 # ----------------------------------------------------------------
161 # Launch a new spare child or kill an extra spare child.  To
162 # prevent large-scale spawning or die-offs, spawn or kill only
163 # 1 process per idle maintenance loop.
164 # Returns true if any idle maintenance occurred, 0 otherwise
165 # ----------------------------------------------------------------
166 sub perform_idle_maintenance {
167     my $self = shift;
168
169     $chatty and $logger->internal(
170         sprintf(
171             "server: %d idle, %d active, %d min_spare, %d max_spare in idle maintenance",
172             scalar(@{$self->{idle_list}}), 
173             scalar(@{$self->{active_list}}),
174             $self->{min_spare_children},
175             $self->{max_spare_children}
176         )
177     );
178
179     # spawn 1 spare child per maintenance loop if necessary
180     if( $self->{min_spare_children} and
181         $self->{num_children} < $self->{max_children} and
182         scalar(@{$self->{idle_list}}) < $self->{min_spare_children} ) {
183
184         $chatty and $logger->internal("server: spawning spare child");
185         $self->spawn_child;
186         return 1;
187
188     # kill 1 excess spare child per maintenance loop if necessary
189     } elsif($self->{max_spare_children} and
190             $self->{num_children} > $self->{min_children} and
191             scalar(@{$self->{idle_list}}) > $self->{max_spare_children} ) {
192
193         $chatty and $logger->internal("server: killing spare child");
194         $self->kill_child;
195         return 1;
196     }
197
198     return 0;
199 }
200
201 sub kill_child {
202     my $self = shift;
203     my $child = shift || pop(@{$self->{idle_list}}) or return;
204     $chatty and $logger->internal("server: killing child $child");
205     kill('TERM', $child->{pid});
206 }
207
208 # ----------------------------------------------------------------
209 # Jabber connection inbound message arrive on.
210 # ----------------------------------------------------------------
211 sub build_osrf_handle {
212     my $self = shift;
213
214     my $conf = OpenSRF::Utils::Config->current;
215     my $username = $conf->bootstrap->username;
216     my $password = $conf->bootstrap->passwd;
217     my $domain = $conf->bootstrap->domain;
218     my $port = $conf->bootstrap->port;
219     my $resource = $self->{service} . '_listener_' . $conf->env->hostname;
220
221     $logger->debug("server: inbound connecting as $username\@$domain/$resource on port $port");
222
223     $self->{osrf_handle} =
224         OpenSRF::Transport::SlimJabber::Client->new(
225             username => $username,
226             resource => $resource,
227             password => $password,
228             host => $domain,
229             port => $port,
230         );
231
232     $self->{osrf_handle}->initialize;
233 }
234
235
236 # ----------------------------------------------------------------
237 # Sends request data to a child process
238 # ----------------------------------------------------------------
239 sub write_child {
240     my($self, $child, $msg) = @_;
241     my $xml = encode_utf8(decode_utf8($msg->to_xml));
242
243     # tell the child how much data to expect, minus the header
244     my $write_size;
245     {use bytes; $write_size = length($xml)}
246     $write_size = sprintf("%*s", WRITE_PIPE_DATA_SIZE, $write_size);
247
248     for (0..2) {
249
250         $self->{sig_pipe} = 0;
251         local $SIG{'PIPE'} = sub { $self->{sig_pipe} = 1; };
252
253         # send message to child data pipe
254         syswrite($child->{pipe_to_child}, $write_size . $xml);
255
256         last unless $self->{sig_pipe};
257         $logger->error("server: got SIGPIPE writing to $child, retrying...");
258         usleep(50000); # 50 msec
259     }
260
261     $logger->error("server: unable to send request message to child $child") if $self->{sig_pipe};
262 }
263
264 # ----------------------------------------------------------------
265 # Checks to see if any child process has reported its availability
266 # In blocking mode, blocks until a child has reported.
267 # ----------------------------------------------------------------
268 sub check_status {
269     my($self, $block) = @_;
270
271     return unless @{$self->{active_list}};
272
273     my $read_set = IO::Select->new;
274     $read_set->add($_->{pipe_to_child}) for @{$self->{active_list}};
275
276     my @pids;
277
278     while (1) {
279
280         # if can_read or sysread is interrupted while bloking, go back and 
281         # wait again until we have at least 1 free child
282
283         if(my @handles = $read_set->can_read(($block) ? undef : 0)) {
284             my $pid = '';
285             for my $pipe (@handles) {
286                 sysread($pipe, $pid, STATUS_PIPE_DATA_SIZE) or next;
287                 push(@pids, int($pid));
288             }
289         }
290
291         last unless $block and !@pids;
292     }
293
294     return unless @pids;
295
296     $chatty and $logger->internal("server: ".scalar(@pids)." children reporting for duty: (@pids)");
297
298     my $child;
299     my @new_actives;
300
301     # move the children from the active list to the idle list
302     for my $proc (@{$self->{active_list}}) {
303         if(grep { $_ == $proc->{pid} } @pids) {
304             push(@{$self->{idle_list}}, $proc);
305         } else {
306             push(@new_actives, $proc);
307         }
308     }
309
310     $self->{active_list} = [@new_actives];
311
312     $chatty and $logger->internal(sprintf(
313         "server: %d idle and %d active children after status update",
314             scalar(@{$self->{idle_list}}), scalar(@{$self->{active_list}})));
315 }
316
317 # ----------------------------------------------------------------
318 # Cleans up any child processes that have exited.
319 # In shutdown mode, block until all children have washed ashore
320 # ----------------------------------------------------------------
321 sub reap_children {
322     my($self, $shutdown) = @_;
323     $self->{child_died} = 1;
324
325     while(1) {
326
327         my $pid = waitpid(-1, ($shutdown) ? 0 : WNOHANG);
328         last if $pid <= 0;
329
330         $chatty and $logger->internal("server: reaping child $pid");
331
332         my $child = $self->{pid_map}->{$pid};
333
334         close($child->{pipe_to_parent});
335         close($child->{pipe_to_child});
336
337         $self->{active_list} = [ grep { $_->{pid} != $pid } @{$self->{active_list}} ];
338         $self->{idle_list} = [ grep { $_->{pid} != $pid } @{$self->{idle_list}} ];
339
340         $self->{num_children}--;
341         delete $self->{pid_map}->{$pid};
342         delete $child->{$_} for keys %$child; # destroy with a vengeance
343     }
344
345     $self->spawn_children unless $shutdown;
346
347     $chatty and $logger->internal(sprintf(
348         "server: %d idle and %d active children after reap_children",
349             scalar(@{$self->{idle_list}}), scalar(@{$self->{active_list}})));
350
351 }
352
353 # ----------------------------------------------------------------
354 # Spawn up to max_children processes
355 # ----------------------------------------------------------------
356 sub spawn_children {
357     my $self = shift;
358     $self->spawn_child while $self->{num_children} < $self->{min_children};
359 }
360
361 # ----------------------------------------------------------------
362 # Spawns a new child.  If $active is set, the child goes directly
363 # into the active_list.
364 # ----------------------------------------------------------------
365 sub spawn_child {
366     my($self, $active) = @_;
367
368     my $child = OpenSRF::Server::Child->new($self);
369
370     # socket for sending message data to the child
371     if(!socketpair(
372         $child->{pipe_to_child},
373         $child->{pipe_to_parent},
374         AF_UNIX, SOCK_STREAM, PF_UNSPEC)) {
375             $logger->error("server: error creating data socketpair: $!");
376             return undef;
377     }
378
379     $child->{pipe_to_child}->autoflush(1);
380     $child->{pipe_to_parent}->autoflush(1);
381
382     $child->{pid} = fork();
383
384     if($child->{pid}) { # parent process
385         $self->{num_children}++;
386         $self->{pid_map}->{$child->{pid}} = $child;
387
388         if($active) {
389             push(@{$self->{active_list}}, $child);
390         } else {
391             push(@{$self->{idle_list}}, $child);
392         }
393
394         $chatty and $logger->internal("server: server spawned child $child with ".$self->{num_children}." total children");
395
396         return $child;
397
398     } else { # child process
399
400         $SIG{$_} = 'DEFAULT' for (qw/INT TERM QUIT HUP/);
401
402         if($self->{stderr_log}) {
403
404             $chatty and $logger->internal("server: redirecting STDERR to " . $self->{stderr_log});
405
406             close STDERR;
407             unless( open(STDERR, '>>' . $self->{stderr_log}) ) {
408                 $logger->error("server: unable to open STDERR log file: " . $self->{stderr_log} . " : $@");
409                 open STDERR, '>/dev/null'; # send it back to /dev/null
410             }
411         }
412
413         $child->{pid} = $$;
414         eval {
415             $child->init;
416             $child->run;
417             OpenSRF::Transport::PeerHandle->retrieve->disconnect;
418         };
419         $logger->error("server: child process died: $@") if $@;
420         exit(0);
421     }
422 }
423
424 # ----------------------------------------------------------------
425 # Sends the register command to the configured routers
426 # ----------------------------------------------------------------
427 sub register_routers {
428     my $self = shift;
429
430     my $conf = OpenSRF::Utils::Config->current;
431     my $routers = $conf->bootstrap->routers;
432     my $router_name = $conf->bootstrap->router_name;
433     my @targets;
434
435     for my $router (@$routers) {
436         if(ref $router) {
437
438             if( !$router->{services} ||
439                 !$router->{services}->{service} ||
440                 (
441                     ref($router->{services}->{service}) eq 'ARRAY' and
442                     grep { $_ eq $self->{service} } @{$router->{services}->{service}}
443                 )  || $router->{services}->{service} eq $self->{service}) {
444
445                 my $name = $router->{name};
446                 my $domain = $router->{domain};
447                 push(@targets, "$name\@$domain/router");
448             }
449
450         } else {
451             push(@targets, "$router_name\@$router/router");
452         }
453     }
454
455     foreach (@targets) {
456         $logger->info("server: registering with router $_");
457         $self->{osrf_handle}->send(
458             to => $_,
459             body => 'registering',
460             router_command => 'register',
461             router_class => $self->{service}
462         );
463     }
464
465     $self->{routers} = \@targets;
466 }
467
468 # ----------------------------------------------------------------
469 # Sends the unregister command to any routers we have registered
470 # with.
471 # ----------------------------------------------------------------
472 sub unregister_routers {
473     my $self = shift;
474     return unless $self->{osrf_handle}->tcp_connected;
475
476         for my $router (@{$self->{routers}}) {
477         $logger->info("server: disconnecting from router $router");
478         $self->{osrf_handle}->send(
479             to => $router,
480             body => "unregistering",
481             router_command => "unregister",
482             router_class => $self->{service}
483         );
484     }
485 }
486
487
488 package OpenSRF::Server::Child;
489 use strict;
490 use warnings;
491 use OpenSRF::Transport;
492 use OpenSRF::Application;
493 use OpenSRF::Transport::PeerHandle;
494 use OpenSRF::Transport::SlimJabber::XMPPMessage;
495 use OpenSRF::Utils::Logger qw($logger);
496 use OpenSRF::DomainObject::oilsResponse qw/:status/;
497 use Fcntl qw(F_GETFL F_SETFL O_NONBLOCK);
498 use Time::HiRes qw(time usleep);
499 use POSIX qw/:sys_wait_h :errno_h/;
500
501 use overload '""' => sub { return '[' . shift()->{pid} . ']'; };
502
503 sub new {
504     my($class, $parent) = @_;
505     my $self = bless({}, $class);
506     $self->{pid} = 0; # my process ID
507     $self->{parent} = $parent; # Controller parent process
508     $self->{num_requests} = 0; # total serviced requests
509     $self->{sig_pipe} = 0;  # true if last syswrite failed
510     return $self;
511 }
512
513 sub set_nonblock {
514     my($self, $fh) = @_;
515     my  $flags = fcntl($fh, F_GETFL, 0);
516     fcntl($fh, F_SETFL, $flags | O_NONBLOCK);
517 }
518
519 sub set_block {
520     my($self, $fh) = @_;
521     my  $flags = fcntl($fh, F_GETFL, 0);
522     $flags &= ~O_NONBLOCK;
523     fcntl($fh, F_SETFL, $flags);
524 }
525
526 # ----------------------------------------------------------------
527 # Connects to Jabber and runs the application child_init
528 # ----------------------------------------------------------------
529 sub init {
530     my $self = shift;
531     my $service = $self->{parent}->{service};
532     $0 = "OpenSRF Drone [$service]";
533     OpenSRF::Transport::PeerHandle->construct($service);
534         OpenSRF::Application->application_implementation->child_init
535                 if (OpenSRF::Application->application_implementation->can('child_init'));
536 }
537
538 # ----------------------------------------------------------------
539 # Waits for messages from the parent process, handles the message,
540 # then goes into the keepalive loop if this is a stateful session.
541 # When max_requests is hit, the process exits.
542 # ----------------------------------------------------------------
543 sub run {
544     my $self = shift;
545     my $network = OpenSRF::Transport::PeerHandle->retrieve;
546
547     # main child run loop.  Ends when this child hits max requests.
548     while(1) {
549
550         my $data = $self->wait_for_request or next;
551
552         # Update process name to show activity
553         my $orig_name = $0;
554         $0 = "$0*";
555
556         # Discard extraneous data from the jabber socket
557         if(!$network->flush_socket()) {
558             $logger->error("server: network disconnected!  child dropping request and exiting: $data");
559             exit;
560         }
561
562         my $session = OpenSRF::Transport->handler(
563             $self->{parent}->{service},
564             OpenSRF::Transport::SlimJabber::XMPPMessage->new(xml => $data)
565         );
566
567         $self->keepalive_loop($session);
568
569         last if ++$self->{num_requests} == $self->{parent}->{max_requests};
570
571         # Tell the parent process we are available to process requests
572         $self->send_status;
573
574         # Repair process name
575         $0 = $orig_name;
576     }
577
578     $chatty and $logger->internal("server: child process shutting down after reaching max_requests");
579
580         OpenSRF::Application->application_implementation->child_exit
581                 if (OpenSRF::Application->application_implementation->can('child_exit'));
582 }
583
584 # ----------------------------------------------------------------
585 # waits for a request data on the parent pipe and returns it.
586 # ----------------------------------------------------------------
587 sub wait_for_request {
588     my $self = shift;
589
590     my $data = '';
591     my $buf_size = 4096;
592     my $nonblock = 0;
593     my $read_pipe = $self->{pipe_to_parent};
594     my $data_size;
595     my $total_read;
596     my $first_read = 1;
597
598     while (1) {
599
600         # wait for some data to start arriving
601         my $read_set = IO::Select->new;
602         $read_set->add($read_pipe);
603     
604         while (1) {
605             # if can_read is interrupted while blocking, 
606             # go back and wait again until it succeeds.
607             last if $read_set->can_read;
608         }
609
610         # parent started writing, let's start reading
611         $self->set_nonblock($read_pipe);
612
613         while (1) {
614             # pull as much data from the pipe as possible
615
616             my $buf = '';
617             my $bytes_read = sysread($self->{pipe_to_parent}, $buf, $buf_size);
618
619             unless(defined $bytes_read) {
620                 $logger->error("server: error reading data pipe: $!") unless EAGAIN == $!;
621                 last;
622             }
623
624             last if $bytes_read <= 0; # no more data available for reading
625
626             $total_read += $bytes_read;
627             $data .= $buf;
628         }
629
630         # we've read all the data currently available on the pipe.
631         # let's see if we're done.
632
633         if ($first_read) {
634             # extract the data size and remove the size header
635             my $wps_size = OpenSRF::Server::WRITE_PIPE_DATA_SIZE;
636             $data_size = int(substr($data, 0, $wps_size)) + $wps_size;
637             $data = substr($data, $wps_size);
638             $first_read = 0;
639         }
640
641         $self->set_block($self->{pipe_to_parent});
642
643         if ($total_read == $data_size) {
644             # we've read all the data. Nothing left to do
645             last;
646         }
647     }
648
649     return $data;
650 }
651
652
653 # ----------------------------------------------------------------
654 # If this is a stateful opensrf session, wait up to $keepalive
655 # seconds for subsequent requests from the client
656 # ----------------------------------------------------------------
657 sub keepalive_loop {
658     my($self, $session) = @_;
659     my $keepalive = $self->{parent}->{keepalive};
660
661     while($session->state and $session->state == $session->CONNECTED) {
662
663         unless( $session->queue_wait($keepalive) ) {
664
665             # client failed to disconnect before timeout
666             $logger->info("server: no request was received in $keepalive seconds, exiting stateful session");
667
668             my $res = OpenSRF::DomainObject::oilsConnectStatus->new(
669                 status => "Disconnected on timeout",
670                 statusCode => STATUS_TIMEOUT
671             );
672
673             $session->status($res);
674             $session->state($session->DISCONNECTED);
675             last;
676         }
677     }
678
679     $chatty and $logger->internal("server: child done with request(s)");
680     $session->kill_me;
681 }
682
683 # ----------------------------------------------------------------
684 # Report our availability to our parent process
685 # ----------------------------------------------------------------
686 sub send_status {
687     my $self = shift;
688
689     for (0..2) {
690
691         $self->{sig_pipe} = 0;
692         local $SIG{'PIPE'} = sub { $self->{sig_pipe} = 1; };
693
694         syswrite(
695             $self->{pipe_to_parent},
696             sprintf("%*s", OpenSRF::Server::STATUS_PIPE_DATA_SIZE, $self->{pid})
697         );
698
699         last unless $self->{sig_pipe};
700         $logger->error("server: $self got SIGPIPE writing status to parent, retrying...");
701         usleep(50000); # 50 msec
702     }
703
704     $logger->error("server: $self unable to send status to parent") if $self->{sig_pipe};
705 }
706
707
708 1;