#
# This is a fork of the (for now) unmaintained Danga::Socket 1.61.
# Unused features will be removed, and updates will be made to take
-# advantage of newer kernels
-
+# advantage of newer kernels.
+#
+# API changes to diverge from Danga::Socket will happen to better
+# accomodate new features and improve scalability. Do not expect
+# this to be a stable API like Danga::Socket.
+# Bugs encountered (and likely fixed) are reported to
+# bug-Danga-Socket@rt.cpan.org and visible at:
+# https://rt.cpan.org/Public/Dist/Display.html?Name=Danga-Socket
package PublicInbox::DS;
use strict;
use bytes;
use POSIX ();
use Time::HiRes ();
-
-use vars qw{$VERSION};
-$VERSION = "1.61";
+use IO::Handle qw();
+use Fcntl qw(FD_CLOEXEC F_SETFD F_GETFD);
use warnings;
-no warnings qw(deprecated);
use PublicInbox::Syscall qw(:epoll);
'write_set_watch', # bool: true if we internally set watch_write rather than by a subclass
'closed', # bool: socket is closed
'event_watch', # bitmask of events the client is interested in (POLLIN,OUT,etc.)
- 'writer_func', # subref which does writing. must return bytes written (or undef) and set $! on errors
);
use Errno qw(EINPROGRESS EWOULDBLOCK EISCONN ENOTSOCK
EPIPE EAGAIN EBADF ECONNRESET ENOPROTOOPT);
-use Socket qw(IPPROTO_TCP);
use Carp qw(croak confess);
use constant DebugLevel => 0;
$HaveKQueue,
%DescriptorMap, # fd (num) -> PublicInbox::DS object
$Epoll, # Global epoll fd (for epoll mode only)
- $KQueue, # Global kqueue fd (for kqueue mode only)
+ $KQueue, # Global kqueue fd ref (for kqueue mode only)
+ $_io, # IO::Handle for Epoll
@ToClose, # sockets to close when event loop is done
- %OtherFds, # A hash of "other" (non-PublicInbox::DS) file
- # descriptors for the event loop to track.
$PostLoopCallback, # subref to call at the end of each loop, if defined (global)
%PLCMap, # fd (num) -> PostLoopCallback (per-object)
sub Reset {
%DescriptorMap = ();
@ToClose = ();
- %OtherFds = ();
$LoopTimeout = -1; # no timeout by default
@Timers = ();
%PLCMap = ();
$DoneInit = 0;
- POSIX::close($Epoll) if defined $Epoll && $Epoll >= 0;
- POSIX::close($KQueue) if defined $KQueue && $KQueue >= 0;
-
- *EventLoop = *FirstTimeEventLoop;
-}
-
-=head2 C<< CLASS->HaveEpoll() >>
-
-Returns a true value if this class will use IO::Epoll for async IO.
-
-=cut
-sub HaveEpoll {
- _InitPoller();
- return $HaveEpoll;
-}
-
-=head2 C<< CLASS->WatchedSockets() >>
-
-Returns the number of file descriptors which are registered with the global
-poll object.
-
-=cut
-sub WatchedSockets {
- return scalar keys %DescriptorMap;
-}
-*watched_sockets = *WatchedSockets;
-
-=head2 C<< CLASS->ToClose() >>
-
-Return the list of sockets that are awaiting close() at the end of the
-current event loop.
-
-=cut
-sub ToClose { return @ToClose; }
-
-=head2 C<< CLASS->OtherFds( [%fdmap] ) >>
-
-Get/set the hash of file descriptors that need processing in parallel with
-the registered PublicInbox::DS objects.
-
-=cut
-sub OtherFds {
- my $class = shift;
- if ( @_ ) { %OtherFds = @_ }
- return wantarray ? %OtherFds : \%OtherFds;
-}
+ # NOTE kqueue is close-on-fork, and we don't account for it, yet
+ # OTOH, we (public-inbox) don't need this sub outside of tests...
+ POSIX::close($$KQueue) if !$_io && $KQueue && $$KQueue >= 0;
+ $KQueue = undef;
-=head2 C<< CLASS->AddOtherFds( [%fdmap] ) >>
+ $_io = undef; # close $Epoll
+ $Epoll = undef;
-Add fds to the OtherFds hash for processing.
-
-=cut
-sub AddOtherFds {
- my $class = shift;
- %OtherFds = ( %OtherFds, @_ ); # FIXME investigate what happens on dupe fds
- return wantarray ? %OtherFds : \%OtherFds;
+ *EventLoop = *FirstTimeEventLoop;
}
=head2 C<< CLASS->SetLoopTimeout( $timeout ) >>
die "Shouldn't get here.";
}
-=head2 C<< CLASS->DescriptorMap() >>
+# keeping this around in case we support other FD types for now,
+# epoll_create1(EPOLL_CLOEXEC) requires Linux 2.6.27+...
+sub set_cloexec ($) {
+ my ($fd) = @_;
-Get the hash of PublicInbox::DS objects keyed by the file descriptor (fileno) they
-are wrapping.
-
-Returns a hash in list context or a hashref in scalar context.
-
-=cut
-sub DescriptorMap {
- return wantarray ? %DescriptorMap : \%DescriptorMap;
+ $_io = IO::Handle->new_from_fd($fd, 'r+') or return;
+ defined(my $fl = fcntl($_io, F_GETFD, 0)) or return;
+ fcntl($_io, F_SETFD, $fl | FD_CLOEXEC);
}
-*descriptor_map = *DescriptorMap;
-*get_sock_ref = *DescriptorMap;
sub _InitPoller
{
if ($HAVE_KQUEUE) {
$KQueue = IO::KQueue->new();
- $HaveKQueue = $KQueue >= 0;
+ $HaveKQueue = defined $KQueue;
if ($HaveKQueue) {
*EventLoop = *KQueueEventLoop;
}
$Epoll = eval { epoll_create(1024); };
$HaveEpoll = defined $Epoll && $Epoll >= 0;
if ($HaveEpoll) {
+ set_cloexec($Epoll);
*EventLoop = *EpollEventLoop;
}
}
sub EpollEventLoop {
my $class = shift;
- foreach my $fd ( keys %OtherFds ) {
- if (epoll_ctl($Epoll, EPOLL_CTL_ADD, $fd, EPOLLIN) == -1) {
- warn "epoll_ctl(): failure adding fd=$fd; $! (", $!+0, ")\n";
- }
- }
-
while (1) {
my @events;
my $i;
# if we didn't find a Perlbal::Socket subclass for that fd, try other
# pseudo-registered (above) fds.
if (! $pob) {
- if (my $code = $OtherFds{$ev->[0]}) {
- $code->($state);
- } else {
- my $fd = $ev->[0];
- warn "epoll() returned fd $fd w/ state $state for which we have no mapping. removing.\n";
- POSIX::close($fd);
- epoll_ctl($Epoll, EPOLL_CTL_DEL, $fd, 0);
- }
+ my $fd = $ev->[0];
+ warn "epoll() returned fd $fd w/ state $state for which we have no mapping. removing.\n";
+ epoll_ctl($Epoll, EPOLL_CTL_DEL, $fd, 0);
+ POSIX::close($fd);
next;
}
# modifies the array in place with the even elements being
# replaced with the event masks that occured.
my @poll;
- foreach my $fd ( keys %OtherFds ) {
- push @poll, $fd, POLLIN;
- }
while ( my ($fd, $sock) = each %DescriptorMap ) {
push @poll, $fd, $sock->{event_watch};
}
}
my $count = IO::Poll::_poll($timeout, @poll);
- unless ($count) {
+ unless ($count >= 0) {
return unless PostEventLoop();
next;
}
$pob = $DescriptorMap{$fd};
if (!$pob) {
- if (my $code = $OtherFds{$fd}) {
- $code->($state);
- }
next;
}
sub KQueueEventLoop {
my $class = shift;
- foreach my $fd (keys %OtherFds) {
- $KQueue->EV_SET($fd, IO::KQueue::EVFILT_READ(), IO::KQueue::EV_ADD());
- }
-
while (1) {
my $timeout = RunTimers();
my @ret = eval { $KQueue->kevent($timeout) };
my ($fd, $filter, $flags, $fflags) = @$kev;
my PublicInbox::DS $pob = $DescriptorMap{$fd};
if (!$pob) {
- if (my $code = $OtherFds{$fd}) {
- $code->($filter);
- } else {
- warn "kevent() returned fd $fd for which we have no mapping. removing.\n";
- POSIX::close($fd); # close deletes the kevent entry
- }
+ warn "kevent() returned fd $fd for which we have no mapping. removing.\n";
+ POSIX::close($fd); # close deletes the kevent entry
next;
}
Return 1 (or any true value) from the sub to make the loop continue, 0 or false
and it will exit.
-The callback function will be passed two parameters: \%DescriptorMap, \%OtherFds.
+The callback function will be passed two parameters: \%DescriptorMap
=cut
sub SetPostLoopCallback {
# per-object post-loop-callbacks
for my $plc (values %PLCMap) {
- $keep_running &&= $plc->(\%DescriptorMap, \%OtherFds);
+ $keep_running &&= $plc->(\%DescriptorMap);
}
# now we're at the very end, call callback if defined
if (defined $PostLoopCallback) {
- $keep_running &&= $PostLoopCallback->(\%DescriptorMap, \%OtherFds);
+ $keep_running &&= $PostLoopCallback->(\%DescriptorMap);
}
return $keep_running;
return $self->{sock};
}
-=head2 C<< $obj->set_writer_func( CODEREF ) >>
-
-Sets a function to use instead of C<syswrite()> when writing data to the socket.
-
-=cut
-sub set_writer_func {
- my PublicInbox::DS $self = shift;
- my $wtr = shift;
- Carp::croak("Not a subref") unless !defined $wtr || UNIVERSAL::isa($wtr, "CODE");
- $self->{writer_func} = $wtr;
-}
-
=head2 C<< $obj->write( $data ) >>
Write the specified data to the underlying handle. I<data> may be scalar,
}
my $to_write = $len - $self->{write_buf_offset};
- my $written;
- if (my $wtr = $self->{writer_func}) {
- $written = $wtr->($bref, $to_write, $self->{write_buf_offset});
- } else {
- $written = syswrite($self->{sock}, $$bref, $to_write, $self->{write_buf_offset});
- }
+ my $written = syswrite($self->{sock}, $$bref, $to_write,
+ $self->{write_buf_offset});
if (! defined $written) {
if ($! == EPIPE) {
return $ret;
}
-sub _undef {
- return undef unless $ENV{DS_DEBUG};
- my $msg = shift || "";
- warn "PublicInbox::DS: $msg\n";
- return undef;
-}
-
package PublicInbox::DS::Timer;
# [$abs_float_firetime, $coderef];
sub cancel {