chiark / gitweb /
3eb9a27e2e466b64ae12db6988121297980a1994
[chiark-utils.git] / perl / Prefork.pm
1
2 package Proc::Prefork;
3 require Exporter;
4 our @ISA = qw(Exporter);
5 our @EXPORT = qw(initialisation_complete);
6
7 use Carp;
8 use Fcntl qw(F_GETFL F_SETFL O_NONBLOCK);
9 use POSIX qw(_exit setsid);
10 use Sys::Syslog;
11
12 our $logger;
13
14 our $env_name = 'PREFORK_INTERP';
15
16 our @call_fds;
17 our $socket_path;
18
19 sub fail_log ($) {
20   my ($m) = @_;
21   syslog(LOG_ERROR, "$0: prefork [$$]: error: $m");
22   _exit 127;
23 }
24
25 sub server_quit ($) {
26   my ($m) = @_;
27   syslog(LOG_INFO, "$0 prefork [$$]: $m, quitting");
28   _exit(0);
29 }
30
31 # Returns in the executor process
32 sub become_monitor () {
33   my $child = fork // fail("fork executor: $!");
34   if (!$child) {
35     #---- executor ----
36     open ::STDIN , "<& $call_fds[0]" or fail_log("dup for fd0");
37     open ::STDOUT, ">& $call_fds[1]" or fail_log("dup for fd1");
38     open ::STDERR, ">& $call_fds[2]" or fail_log("dup for fd2");
39     POSIX::close($_) foreach @call_fds;
40     close CALL;
41     return;
42   }
43
44   #---- monitor [2] ----
45   my $got = waitpid $child, 0 // fail_log("wait for executor: $!");
46   $got == $child or fail_log("wait for esecutor gave $got, expected $child");
47
48   protocol_write(pack "L", $?);
49   _exit(0);
50 }
51
52 sub protocol_write ($) {
53   my ($d) = @_;
54   return if (print CALL $d and flush CALL);
55   _exit(0) if $!==EPIPE || $!==ECONNRESET;
56   fail_log("protocol write: $!");
57 }
58
59 sub eintr_retry ($) {
60   my ($f) = @_;
61   for (;;) {
62     my $r = $f->();
63     return $r if defined $r;
64     next if $!==EINTR;
65     return $r;
66   }
67 }
68
69 sub protocol_read_fail ($) {
70   my ($what) = @_;
71   _exit(0) if $!==ECONNRESET;
72   fail_log("recv $what: $!");
73 }
74
75 sub protocol_exchange () {
76   protocol_write('\n');
77
78   @call_fds = map {
79     my $r;
80     for (;;) {
81       $! = 0;
82       $r = IO::FDPass::recv(fileno(CALL));
83       last if $r >= 0;
84       _exit(0) if $!==0;
85       protocol_read_fail("fd $_");
86     }
87     $r;
88   } 0..2;
89
90   my $len;
91   $r = read(CALL, $len, 4) // protocol_read_fail("message length");
92   $r == 4 or _exit(0);
93
94   $len = unpack "L", $len;
95   my $data;
96   $r = read(CALL, $data, $len) // protocol_read_fail("message data ($len)");
97   $r == $len or _exit(0);
98
99   @ARGV = split /\0/, $data;
100   @ARGV >= 2 or fail_log("message data has too few strings");
101   length(pop(@ARGV)) and fail_log("message data missing trailing nul");
102   %ENV = ();
103   while (my $s = shift @ARGV) {
104     last if !length $s;
105     $s =~ m/=/ or fail_log("message data env var missing equals");
106     $ENV{$`} = $';
107   }
108 }
109
110 sub initialisation_complete {
111   my %opts = @_;
112
113   # if env var not set, we're not running under prefork-interp
114   my @env_params = split /,/, ($ENV{$env_name} // return), 5;
115   croak "$env_name has too few entries" unless @env_params == 5;
116
117   $num_servers = $opts{max_servers} // 4;
118
119   #---- setup (pm) [1] ----
120
121   $socket_path = pop @env_params;
122   foreach (@env_params) {
123     $_ eq ($_+0) or croak "$env_name contains $_, not a number";
124   }
125   open LISTEN, "+>&=$env_params[0]" or croak "listen fd: $!";
126   open CALL,   "+>&=$env_params[1]" or croak "listen fd: $!";
127   @call_fds = ($env_params[2], $env_params[3], 2);
128
129   if (!$opts{no_openlog}) {
130     openlog("prefork-interp $0", 'ndelay,nofatal,pid',
131             $opts{log_facility} // 'log_user');
132   }
133
134   open NULL, "+>/dev/null" or croak "open /dev/null: $!";
135
136   #---- fork for server ----
137
138   my $child = fork // croak "first fork failed: $!";
139   if ($child) {
140     #---- setup (pm) [2], exits ----
141     _exit(0);
142   }
143
144   #---- server(pm) [1] ----
145
146   $child = fork // croak "second fork failed: $!";
147   if (!$child) {
148     # we are the child, i.e. the one fa-monitor
149     return become_monitor();
150   }
151
152   our %children;
153   $children{$child} = 1;
154   
155   # --- server(pm) [2] ----
156
157   setsid() > 0 or fail_log("setsid: $!");
158   open STDIN, "<&NULL" or fail_log("dup null onto stdin: $!");
159   open STDOUT, ">&NULL" or fail_log("dup null onto stdout: $!");
160   open STDERR, ">&NULL" or fail_log("dup null onto stderr: $!");
161   close NULL;
162
163   POSIX::close($_) foreach @call_fds;
164   close CALL;
165
166   my $flags = fcntl(LISTEN, F_GETFL, 0)
167     or fail_log("F_GETFL listen socket: $!");
168   $flags |= O_NONBLOCK;
169   fcntl(LISTEN, F_SETFL, $flags)
170     or fail_log("F_SETFL listen socket: $!");
171
172   my $errcount = 0;
173
174   for (;;) {
175     # reap children
176     if (%children) {
177       my $full = %children >= $num_servers;
178       my $got = waitpid -1, ($full ? 0 : WNOHANG);
179       if ($?) {
180         syslog(LOG_WARNING,
181  "$0 prefork [$$]: monitor process [$got] failed with wait status $?");
182       }
183       if (!exists $children{$got}) {
184         syslog(LOG_WARNING,
185  "$0 prefork [$$]: monitor process [$got] wasn't one of ours?!");
186       }
187       delete $children{$got};
188       next;
189     }
190
191     # select for accepting or housekeeping timeout
192     my $rbits = '';
193     vec($rbits, fileno(LISTEN), 1) = 1;
194     my $ebits = $rbits;
195     my $nfound = select($rbits, '', $ebits, ($opts{check_interval} // 86400));
196
197     if ($nfound) {
198       if (accept(CALL, LISTEN)) {
199         $child = fork // fail_log("fork for accepted call failed: $!");
200         if (!$child) {
201           #---- monitor [1] ----
202           close LISTEN;
203           protocol_exchange();
204           return become_monitor();
205         }
206         close(CALL);
207         $errcount = 0;
208         $children{$child} = 1;
209       } elsif ($! == EINTR || $! == EAGAIN || $! == EWOULDBLOCK) {
210       } else {
211         syslog(LOG_WARNING, "$0 prefork [$$]: accept failed: $!");
212         if ($errcount > ($opts{max_errors} // 100)) {
213           syslog(LOG_ERR,
214                  "$0 prefork [$$]: too many accept failures, quitting");
215           _exit(16);
216         }
217       }
218       next;
219     }
220
221     # are we still live?
222     my @st_listen = stat(LISTEN) // fail_log("fstat listening socket: $!");
223     my @st_socket = stat($socket_path) // do {
224       if ($! == ENOENT) { server_quit("socket $socket is ENOENT"); }
225       fail_log("stat socket $socket: $!");
226     };
227     if ("@st_listen[0..2]" ne "@st_socket[0..2]") {
228       server_quit("socket $socket is no longer ours");
229     }
230   }
231 }
232
233 1;
234
235 __END__