1 # This library is free software; you can redistribute it and/or modify
2 # it under the same terms as Perl itself.
4 # This license differs from the rest of public-inbox
6 # This is a fork of the unmaintained Danga::Socket (1.61) with
7 # significant changes. See Documentation/technical/ds.txt in our
10 # Do not expect this to be a stable API like Danga::Socket,
11 # but it will evolve to suite our needs and to take advantage of
12 # newer Linux and *BSD features.
13 # Bugs encountered were reported to bug-Danga-Socket@rt.cpan.org,
14 # fixed in Danga::Socket 1.62 and visible at:
15 # https://rt.cpan.org/Public/Dist/Display.html?Name=Danga-Socket
16 package PublicInbox::DS;
19 use POSIX qw(WNOHANG);
21 use Fcntl qw(SEEK_SET :DEFAULT);
22 use Time::HiRes qw(clock_gettime CLOCK_MONOTONIC);
23 use parent qw(Exporter);
24 our @EXPORT_OK = qw(now msg_more);
27 use Scalar::Util qw(blessed);
29 use PublicInbox::Syscall qw(:epoll);
30 use PublicInbox::Tmpfile;
32 use fields ('sock', # underlying socket
33 'rbuf', # scalarref, usually undef
34 'wbuf', # arrayref of coderefs or GLOB refs (autovivified)
35 'wbuf_off', # offset into first element of wbuf to start writing at
38 use Errno qw(EAGAIN EINVAL);
39 use Carp qw(confess carp);
41 my $nextq; # queue for next_tick
42 my $wait_pids; # list of [ pid, callback, callback_arg ]
43 my $later_queue; # list of callbacks to run at some later interval
44 my $EXPMAP; # fd -> [ idle_time, $self ]
45 our $EXPTIME = 180; # 3 minutes
46 my ($later_timer, $reap_timer, $exp_timer);
47 my $ToClose; # sockets to close when event loop is done
49 %DescriptorMap, # fd (num) -> PublicInbox::DS object
50 $Epoll, # Global epoll fd (or DSKQXS ref)
51 $_io, # IO::Handle for Epoll
53 $PostLoopCallback, # subref to call at the end of each loop, if defined (global)
55 $LoopTimeout, # timeout of event loop in milliseconds
56 $DoneInit, # if we've done the one-time module init yet
63 #####################################################################
64 ### C L A S S M E T H O D S
65 #####################################################################
67 =head2 C<< CLASS->Reset() >>
74 $wait_pids = $later_queue = undef;
76 $nextq = $ToClose = $reap_timer = $later_timer = $exp_timer = undef;
77 $LoopTimeout = -1; # no timeout by default
80 $PostLoopCallback = undef;
83 $_io = undef; # closes real $Epoll FD
84 $Epoll = undef; # may call DSKQXS::DESTROY
86 *EventLoop = *FirstTimeEventLoop;
89 =head2 C<< CLASS->SetLoopTimeout( $timeout ) >>
91 Set the loop timeout for the event loop to some value in milliseconds.
93 A timeout of 0 (zero) means poll forever. A timeout of -1 means poll and return
98 return $LoopTimeout = $_[1] + 0;
101 =head2 C<< PublicInbox::DS::add_timer( $seconds, $coderef ) >>
103 Add a timer to occur $seconds from now. $seconds may be fractional, but timers
104 are not guaranteed to fire at the exact time you ask for.
108 my ($secs, $coderef) = @_;
110 my $fire_time = now() + $secs;
112 my $timer = [$fire_time, $coderef];
114 if (!@Timers || $fire_time >= $Timers[-1][0]) {
115 push @Timers, $timer;
119 # Now, where do we insert? (NOTE: this appears slow, algorithm-wise,
120 # but it was compared against calendar queues, heaps, naive push/sort,
121 # and a bunch of other versions, and found to be fastest with a large
122 # variety of datasets.)
123 for (my $i = 0; $i < @Timers; $i++) {
124 if ($Timers[$i][0] > $fire_time) {
125 splice(@Timers, $i, 0, $timer);
130 die "Shouldn't get here.";
133 # keeping this around in case we support other FD types for now,
134 # epoll_create1(EPOLL_CLOEXEC) requires Linux 2.6.27+...
135 sub set_cloexec ($) {
138 $_io = IO::Handle->new_from_fd($fd, 'r+') or return;
139 defined(my $fl = fcntl($_io, F_GETFD, 0)) or return;
140 fcntl($_io, F_SETFD, $fl | FD_CLOEXEC);
148 if (PublicInbox::Syscall::epoll_defined()) {
149 $Epoll = epoll_create();
150 set_cloexec($Epoll) if (defined($Epoll) && $Epoll >= 0);
153 for (qw(DSKQXS DSPoll)) {
154 $cls = "PublicInbox::$_";
155 last if eval "require $cls";
157 $cls->import(qw(epoll_ctl epoll_wait));
160 *EventLoop = *EpollEventLoop;
163 =head2 C<< CLASS->EventLoop() >>
165 Start processing IO events. In most daemon programs this never exits. See
166 C<PostLoopCallback> below for how to exit the loop.
169 sub FirstTimeEventLoop {
177 sub now () { clock_gettime(CLOCK_MONOTONIC) }
180 my $q = $nextq or return;
183 # we avoid "ref" on blessed refs to workaround a Perl 5.16.3 leak:
184 # https://rt.perl.org/Public/Bug/Display.html?id=114340
193 # runs timers and returns milliseconds for next one, or next event loop
197 return (($nextq || $ToClose) ? 0 : $LoopTimeout) unless @Timers;
202 while (@Timers && $Timers[0][0] <= $now) {
203 my $to_run = shift(@Timers);
204 $to_run->[1]->($now) if $to_run->[1];
207 # timers may enqueue into nextq:
208 return 0 if ($nextq || $ToClose);
210 return $LoopTimeout unless @Timers;
212 # convert time to an even number of milliseconds, adding 1
213 # extra, otherwise floating point fun can occur and we'll
214 # call RunTimers like 20-30 times, each returning a timeout
215 # of 0.0000212 seconds
216 my $timeout = int(($Timers[0][0] - $now) * 1000) + 1;
218 # -1 is an infinite timeout, so prefer a real timeout
219 return $timeout if $LoopTimeout == -1;
221 # otherwise pick the lower of our regular timeout and time until
223 return $LoopTimeout if $LoopTimeout < $timeout;
227 # We can't use waitpid(-1) safely here since it can hit ``, system(),
228 # and other things. So we scan the $wait_pids list, which is hopefully
229 # not too big. We keep $wait_pids small by not calling dwaitpid()
230 # until we've hit EOF when reading the stdout of the child.
232 my $tmp = $wait_pids or return;
233 $wait_pids = $reap_timer = undef;
234 foreach my $ary (@$tmp) {
235 my ($pid, $cb, $arg) = @$ary;
236 my $ret = waitpid($pid, WNOHANG);
238 push @$wait_pids, $ary; # autovivifies @$wait_pids
240 eval { $cb->($arg, $pid) };
243 # we may not be done, yet, and could've missed/masked a SIGCHLD:
244 $reap_timer = add_timer(1, \&reap_pids) if $wait_pids;
247 # reentrant SIGCHLD handler (since reap_pids is not reentrant)
248 sub enqueue_reap ($) { push @$nextq, \&reap_pids }; # autovivifies
250 sub in_loop () { $in_loop }
252 # Internal function: run the post-event callback, send read events
253 # for pushed-back data, and close pending connections. returns 1
254 # if event loop should continue, or 0 to shut it all down.
255 sub PostEventLoop () {
256 # now we can close sockets that wanted to close during our event
257 # processing. (we didn't want to close them during the loop, as we
258 # didn't want fd numbers being reused and confused during the event
260 if (my $close_now = $ToClose) {
261 $ToClose = undef; # will be autovivified on push
262 # ->DESTROY methods may populate ToClose
263 delete($DescriptorMap{fileno($_)}) for @$close_now;
264 # let refcounting drop everything in $close_now at once
267 # by default we keep running, unless a postloop callback cancels it
268 $PostLoopCallback ? $PostLoopCallback->(\%DescriptorMap) : 1;
276 my $timeout = RunTimers();
278 # get up to 1000 events
279 my $evcount = epoll_wait($Epoll, 1000, $timeout, \@events);
280 for ($i=0; $i<$evcount; $i++) {
281 # it's possible epoll_wait returned many events, including some at the end
282 # that ones in the front triggered unregister-interest actions. if we
283 # can't find the %sock entry, it's because we're no longer interested
285 $DescriptorMap{$events[$i]->[0]}->event_step;
287 } while (PostEventLoop());
291 =head2 C<< CLASS->SetPostLoopCallback( CODEREF ) >>
293 Sets post loop callback function. Pass a subref and it will be
294 called every time the event loop finishes.
296 Return 1 (or any true value) from the sub to make the loop continue, 0 or false
299 The callback function will be passed two parameters: \%DescriptorMap
302 sub SetPostLoopCallback {
303 my ($class, $ref) = @_;
306 $PostLoopCallback = (defined $ref && ref $ref eq 'CODE') ? $ref : undef;
309 #####################################################################
310 ### PublicInbox::DS-the-object code
311 #####################################################################
313 =head2 OBJECT METHODS
315 =head2 C<< CLASS->new( $socket ) >>
317 Create a new PublicInbox::DS subclass object for the given I<socket> which will
318 react to events on it during the C<EventLoop>.
320 This is normally (always?) called from your subclass via:
322 $class->SUPER::new($socket);
326 my ($self, $sock, $ev) = @_;
327 $self = fields::new($self) unless ref $self;
329 $self->{sock} = $sock;
330 my $fd = fileno($sock);
334 if (epoll_ctl($Epoll, EPOLL_CTL_ADD, $fd, $ev)) {
335 if ($! == EINVAL && ($ev & EPOLLEXCLUSIVE)) {
336 $ev &= ~EPOLLEXCLUSIVE;
339 die "couldn't add epoll watch for $fd: $!\n";
341 confess("DescriptorMap{$fd} defined ($DescriptorMap{$fd})")
342 if defined($DescriptorMap{$fd});
344 $DescriptorMap{$fd} = $self;
348 #####################################################################
349 ### I N S T A N C E M E T H O D S
350 #####################################################################
352 sub requeue ($) { push @$nextq, $_[0] } # autovivifies
354 =head2 C<< $obj->close >>
361 my $sock = delete $self->{sock} or return;
363 # we need to flush our write buffer, as there may
364 # be self-referential closures (sub { $client->close })
365 # preventing the object from being destroyed
366 delete $self->{wbuf};
368 # if we're using epoll, we have to remove this from our epoll fd so we stop getting
369 # notifications about it
370 my $fd = fileno($sock);
371 epoll_ctl($Epoll, EPOLL_CTL_DEL, $fd, 0) and
372 confess("EPOLL_CTL_DEL: $!");
374 # we explicitly don't delete from DescriptorMap here until we
375 # actually close the socket, as we might be in the middle of
376 # processing an epoll_wait/etc that returned hundreds of fds, one
377 # of which is not yet processed and is what we're closing. if we
378 # keep it in DescriptorMap, then the event harnesses can just
379 # looked at $pob->{sock} == undef and ignore it. but if it's an
380 # un-accounted for fd, then it (understandably) freak out a bit
381 # and emit warnings, thinking their state got off.
383 # defer closing the actual socket until the event loop is done
384 # processing this round of events. (otherwise we might reuse fds)
385 push @$ToClose, $sock; # autovivifies $ToClose
390 # portable, non-thread-safe sendfile emulation (no pread, yet)
391 sub psendfile ($$$) {
392 my ($sock, $fh, $off) = @_;
394 seek($fh, $$off, SEEK_SET) or return;
395 defined(my $to_write = read($fh, my $buf, 16384)) or return;
397 while ($to_write > 0) {
398 if (defined(my $w = syswrite($sock, $buf, $to_write, $written))) {
402 return if $written == 0;
410 sub epbit ($$) { # (sock, default)
411 ref($_[0]) eq 'IO::Socket::SSL' ? PublicInbox::TLS::epollbit() : $_[1];
414 # returns 1 if done, 0 if incomplete
415 sub flush_write ($) {
417 my $wbuf = $self->{wbuf} or return 1;
418 my $sock = $self->{sock};
421 while (my $bref = $wbuf->[0]) {
422 if (ref($bref) ne 'CODE') {
423 my $off = delete($self->{wbuf_off}) // 0;
425 my $w = psendfile($sock, $bref, \$off);
431 } elsif ($! == EAGAIN) {
432 epwait($sock, epbit($sock, EPOLLOUT) | EPOLLONESHOT);
433 $self->{wbuf_off} = $off;
439 } else { #($ref eq 'CODE') {
441 my $before = scalar(@$wbuf);
444 # bref may be enqueueing more CODE to call (see accept_tls_step)
445 return 0 if (scalar(@$wbuf) > $before);
449 delete $self->{wbuf};
454 my ($self, $rbuf) = @_;
455 if ($$rbuf eq '') { # who knows how long till we can read again
456 delete $self->{rbuf};
458 $self->{rbuf} = $rbuf;
462 sub do_read ($$$;$) {
463 my ($self, $rbuf, $len, $off) = @_;
464 my $r = sysread(my $sock = $self->{sock}, $$rbuf, $len, $off // 0);
465 return ($r == 0 ? $self->close : $r) if defined $r;
466 # common for clients to break connections without warning,
467 # would be too noisy to log here:
469 epwait($sock, epbit($sock, EPOLLIN) | EPOLLONESHOT);
470 rbuf_idle($self, $rbuf);
477 # drop the socket if we hit unrecoverable errors on our system which
478 # require BOFH attention: ENOSPC, EFBIG, EIO, EMFILE, ENFILE...
485 # n.b.: use ->write/->read for this buffer to allow compatibility with
486 # PerlIO::mmap or PerlIO::scalar if needed
488 my ($self, $bref, $off) = @_;
489 my $fh = tmpfile('wbuf', $self->{sock}, 1) or
490 return drop($self, "tmpfile $!");
492 my $len = bytes::length($$bref) - $off;
493 $fh->write($$bref, $len, $off) or return drop($self, "write ($len): $!");
497 =head2 C<< $obj->write( $data ) >>
499 Write the specified data to the underlying handle. I<data> may be scalar,
500 scalar ref, code ref (to run when there).
501 Returns 1 if writes all went through, or 0 if there are writes in queue. If
502 it returns 1, caller should stop waiting for 'writable' events)
506 my ($self, $data) = @_;
508 # nobody should be writing to closed sockets, but caller code can
509 # do two writes within an event, have the first fail and
510 # disconnect the other side (whose destructor then closes the
511 # calling object, but it's still in a method), and then the
512 # now-dead object does its second write. that is this case. we
513 # just lie and say it worked. it'll be dead soon and won't be
515 my $sock = $self->{sock} or return 1;
517 my $bref = $ref ? $data : \$data;
518 my $wbuf = $self->{wbuf};
519 if ($wbuf && scalar(@$wbuf)) { # already buffering, can't write more...
520 if ($ref eq 'CODE') {
523 my $last = $wbuf->[-1];
524 if (ref($last) eq 'GLOB') { # append to tmp file buffer
525 $last->print($$bref) or return drop($self, "print: $!");
527 my $tmpio = tmpio($self, $bref, 0) or return 0;
532 } elsif ($ref eq 'CODE') {
536 my $to_write = bytes::length($$bref);
537 my $written = syswrite($sock, $$bref, $to_write);
539 if (defined $written) {
540 return 1 if $written == $to_write;
541 requeue($self); # runs: event_step -> flush_write
542 } elsif ($! == EAGAIN) {
543 epwait($sock, epbit($sock, EPOLLOUT) | EPOLLONESHOT);
549 # deal with EAGAIN or partial write:
550 my $tmpio = tmpio($self, $bref, $written) or return 0;
552 # wbuf may be an empty array if we're being called inside
553 # ->flush_write via CODE bref:
554 push @{$self->{wbuf}}, $tmpio; # autovivifies
559 use constant MSG_MORE => ($^O eq 'linux') ? 0x8000 : 0;
563 my $sock = $self->{sock} or return 1;
564 my $wbuf = $self->{wbuf};
566 if (MSG_MORE && (!defined($wbuf) || !scalar(@$wbuf)) &&
567 ref($sock) ne 'IO::Socket::SSL') {
568 my $n = send($sock, $_[1], MSG_MORE);
570 my $nlen = bytes::length($_[1]) - $n;
571 return 1 if $nlen == 0; # all done!
572 # queue up the unwritten substring:
573 my $tmpio = tmpio($self, \($_[1]), $n) or return 0;
574 push @{$self->{wbuf}}, $tmpio; # autovivifies
575 epwait($sock, EPOLLOUT|EPOLLONESHOT);
580 # don't redispatch into NNTPdeflate::write
581 PublicInbox::DS::write($self, \($_[1]));
585 my ($sock, $ev) = @_;
586 epoll_ctl($Epoll, EPOLL_CTL_MOD, fileno($sock), $ev) and
587 confess("EPOLL_CTL_MOD $!");
590 # return true if complete, false if incomplete (or failure)
591 sub accept_tls_step ($) {
593 my $sock = $self->{sock} or return;
594 return 1 if $sock->accept_SSL;
595 return $self->close if $! != EAGAIN;
596 epwait($sock, PublicInbox::TLS::epollbit() | EPOLLONESHOT);
597 unshift(@{$self->{wbuf}}, \&accept_tls_step); # autovivifies
601 # return true if complete, false if incomplete (or failure)
602 sub shutdn_tls_step ($) {
604 my $sock = $self->{sock} or return;
605 return $self->close if $sock->stop_SSL(SSL_fast_shutdown => 1);
606 return $self->close if $! != EAGAIN;
607 epwait($sock, PublicInbox::TLS::epollbit() | EPOLLONESHOT);
608 unshift(@{$self->{wbuf}}, \&shutdn_tls_step); # autovivifies
612 # don't bother with shutdown($sock, 2), we don't fork+exec w/o CLOEXEC
613 # or fork w/o exec, so no inadvertant socket sharing
616 my $sock = $self->{sock} or return;
617 if (ref($sock) eq 'IO::Socket::SSL') {
618 shutdn_tls_step($self);
624 # must be called with eval, PublicInbox::DS may not be loaded (see t/qspawn.t)
626 die "Not in EventLoop\n" unless $in_loop;
627 push @$wait_pids, [ @_ ]; # [ $pid, $cb, $arg ]
629 # We could've just missed our SIGCHLD, cover it, here:
630 requeue(\&reap_pids);
634 my $run = $later_queue or return;
635 $later_timer = $later_queue = undef;
640 push @$later_queue, $_[0]; # autovivifies @$later_queue
641 $later_timer //= add_timer(60, \&_run_later);
647 my $old = $now - $exp;
649 while (my ($fd, $v) = each %$EXPMAP) {
650 my ($idle_time, $ds_obj) = @$v;
651 if ($idle_time < $old) {
652 if (!$ds_obj->shutdn) {
660 $exp_timer = scalar(keys %new) ? later(\&expire_old) : undef;
663 sub update_idle_time {
665 my $sock = $self->{sock} or return;
666 $EXPMAP->{fileno($sock)} = [ now(), $self ];
667 $exp_timer //= later(\&expire_old);
671 my ($self, $now) = @_;
672 my $sock = $self->{sock} or return;
673 my $ary = $EXPMAP->{fileno($sock)} or return;
674 my $exp_at = $ary->[0] + $EXPTIME;
680 =head1 AUTHORS (Danga::Socket)
682 Brad Fitzpatrick <brad@danga.com> - author
684 Michael Granger <ged@danga.com> - docs, testing
686 Mark Smith <junior@danga.com> - contributor, heavy user, testing
688 Matt Sergeant <matt@sergeant.org> - kqueue support, docs, timers, other bits