nntp: reduce syscalls for ARTICLE and BODY

Chances are we already have extra buffer space following the
expensive LF => CRLF conversion that we can safely append an
extra CRLF in those places without incurring a copy of the
full string buffer.

While we're at it, document where our pain points are in terms
of memory usage, since tracking/controlling memory use isn't
exactly obvious in high-level languages.

Perhaps we should start storing messages in git as CRLF...

mbox: split header and body processing

When dealing with ~30MB messages, we can save another ~30MB by
splitting the header and body processing and not appending the
body string back to the header.

We'll rely on buffering in gzip or kernel (via MSG_MORE)
to prevent silly packet sizes.

mbox: use Email::Simple->new to do in-place modifications

Email::Simple->new will split the head from the body in-place,
and we can avoid using Email::Simple::body.  This saves us from
holding an extra copy of the message in memory, and saves us
around ~30MB when operating on ~30MB messages.

nntp: rework and simplify art_lookup response

We don't need some of the array elements returned from
art_lookup, anymore (and haven't used them in years).

We can also shorten the lifetime of the Email::Simple object by
relying on the fact Email::Simple->new will modify it's arg if
given a SCALARREF and allow us to avoid Email::Simple::body
calls.

Unfortunately, this doesn't seem to provide any noticeable
improvement in memory usage when dealing with a 30+ MB test
message, since our previous use of ->body_set('') was saving
some memory, but forcing a LF-only body to be CRLF was making
Perl allocate extra space for s///sg.

certs/create-certs: create certs in 'certs/' directory

If running in our top-level source tree, use the 'certs/'
directory as  the prefix so we can just invoke `./certs/create-certs.perl'
instead of `(cd certs && ./create-certs.perl)'

ds: cleanup poll test and avoid clobbering imports

On Linux systems with epoll support, we don't want to be
clobbering defined subs in the t/ds-poll.t test; so use
OO ->method dispatch instead and require users to explicitly
import subs via EXPORT_OK.

Merge remote-tracking branch 'origin/nntp-tls'

* origin/nntp-tls: (59 commits)
  ds: ->write must not clobber empty wbuf array
  Makefile: skip DSKQXS in global syntax check
  ds: reduce overhead of tempfile creation
  Revert "ci: require IO::KQueue on FreeBSD, for now"
  ds: reimplement IO::Poll support to look like epoll
  ds: split out IO::KQueue-specific code
  daemon: use FreeBSD accept filters on non-NNTP
  daemon: set TCP_DEFER_ACCEPT on everything but NNTP
  nntp: send greeting immediately for plain sockets
  ci: require IO::KQueue on FreeBSD, for now
  nntp: lazily allocate and stash rbuf
  ds: flush_write runs ->write callbacks even if closed
  nntp: simplify long response logic and fix nesting
  ds: always use EV_ADD with EV_SET
  nntp: reduce allocations for greeting
  ds: allow ->write callbacks to syswrite directly
  daemon: use SSL_MODE_RELEASE_BUFFERS
  t/nntpd-tls: slow client connection test
  nntp: call SSL_shutdown in normal cases
  ds|nntp: use CORE::close on socket
  ...

searchview: avoid displaying full paths on errors

Displaying full path names of installed modules could expose
unnecessary information about user home directory names or other
potentially sensitive information.  However, displaying a module
name could still be useful for diagnosing problems, so map full
paths to the relevant part of the path name which is relevant to
the package name.

Reported-by: Ali Alnubani <alialnu@mellanox.com>
  https://public-inbox.org/meta/20190611193815.c4uovtlp574bid6x@dcvr/

msgmap: mid_insert: use plain "INSERT" to detect duplicates

"INSERT OR IGNORE" still bumps the auto-increment counter in
SQLite, which causes gaps to appear in NNTP article numbering.

This bug appeared in v2 repos where V2Writable may call ->add
repeatedly on the same message.  This bug is apparent with
public-inbox-watch and work-in-progress IMAP watchers which may
rescan and (attempt to) reinsert the same message on mailbox
changes.

Most uses of public-inbox-mda were not affected, unless the
same message is actually delivered multiple times to the mda.
v1 is not affected, either, since deduplication is only based
on Message-ID and msgmap never sees the duplicate.

Reported-by: "Eric W. Biederman" <ebiederm@xmission.com>

ds: ->write must not clobber empty wbuf array

We need to account for ->write(CODE) calls doing ->write(SCALARREF),
otherwise flush_write may see the wrong ->{wbuf} field.

Makefile: skip DSKQXS in global syntax check

IO::KQueue isn't easily installable on Linux systems.

ds: reduce overhead of tempfile creation

We end up buffering giant things to the FS sometimes, and open()
is not a cheap syscall; so being forced to do it twice to get a
file description with O_APPEND is gross when we can just use
O_EXCL ourselves and loop on EEXIST.

Revert "ci: require IO::KQueue on FreeBSD, for now"

Now that we support IO::Poll once again, we can remove
the IO::KQueue requirement.

ds: reimplement IO::Poll support to look like epoll

At least the subset of epoll we use.  EPOLLET might be
difficult to emulate if we end up using it.

ds: split out IO::KQueue-specific code

We don't need to code multiple event loops or have branches in
watch() if we can easily make the IO::KQueue-based interface
look like our lower-level epoll_* API.

daemon: use FreeBSD accept filters on non-NNTP

Similar to TCP_DEFER_ACCEPT on Linux, FreeBSD has a 'dataready'
accept filter which we can use to reduce wakeups when doing
TLS negotiation or plain HTTP.  There's also a 'httpready'
which we can use for plain HTTP connections.

daemon: set TCP_DEFER_ACCEPT on everything but NNTP

This Linux-specific option can save us some wakeups during
the TLS negotiation phase, and it can help with ordinary HTTP,
too.

Plain NNTP (and in the future, POP3) are the only things which
require the server send messages, first.

nntp: send greeting immediately for plain sockets

A tiny write() for the greeting on a just accept()-ed TCP socket
won't fail with EAGAIN, so we can avoid the extra epoll syscall
traffic with plain sockets.

ci: require IO::KQueue on FreeBSD, for now

We'll likely replace IO::KQueue (at least on FreeBSD) using
a pure-Perl syscall()-based version since syscall numbers are
consistent across architectures on FreeBSD and easy to maintain.

IO::KQueue->EV_SET is also shockingly inefficient in that it
calls kqueue() as much as epoll_ctl.

nntp: lazily allocate and stash rbuf

Allocating a per-client buffer up front is unnecessary and
wastes a hash slot.  For the majority of (non-malicious)
clients, we won't need to store rbuf in a long-lived object
associated with a client socket at all.

This saves around 10M on 64-bit with 20K connected-but-idle
clients.

ds: flush_write runs ->write callbacks even if closed

We may need to rely on cleanup code running in enqueued
callbacks, so ensure we call it when flush_write happens.

nntp: simplify long response logic and fix nesting

We can get rid of the {long_res} field and reuse the write
buffer ordering logic to prevent nesting of responses from
requeue.

On FreeBSD, this fixes a problem of callbacks firing twice
because kqueue as event_step is now our only callback entry
point.

There's a slight change in the stdout "logging" format, in
that we can no longer distinguish between writes blocked
due to slow clients or deferred long responses.  Not sure
if this affects anybody parsing logs or not, but preserving
the old format could prove expensive and not worth the
effort.

ds: always use EV_ADD with EV_SET

kqueue EV_ONESHOT semantics are different than epoll
EPOLLONESHOT.  epoll only disables watches for that event while
keeping the item in the rbtree for future EPOLL_CTL_MOD.  kqueue
removes the watch from the filter set entirely, necessitating
the use of EV_ADD for future modifications.

nntp: reduce allocations for greeting

No need to allocate a new PerlIO::scalar filehandle for every
client, instead we can now pass the same CODE reference which
calls DS->write on a reused string reference.

ds: allow ->write callbacks to syswrite directly

We can bypass buffering when wbuf is empty when it's called
from a CODE reference passed to ->write.

daemon: use SSL_MODE_RELEASE_BUFFERS

34K per idle connection adds up to large amounts of memory;
especially with the speed of malloc nowadays compared to the
cost of cache misses or worse, swapping.

t/nntpd-tls: slow client connection test

We need to ensure slowly negotiating TLS clients don't block
the event loop.  This is why I added the size check of
{wbuf} before and after calling the CODE ref in DS::flush_write.

nntp: call SSL_shutdown in normal cases

This is in accordance with TLS standards and will be needed
to support session caching/reuse in the future.  However, we
don't issue shutdown(2) since we know not to inadvertantly
share our sockets with other processes.

ds|nntp: use CORE::close on socket

IO::Socket::SSL will try to re-bless back to the original class
on TLS negotiation failure.  Unfortunately, the original class
is 'GLOB', and re-blessing to 'GLOB' takes away all the IO::Handle
methods, because Filehandle/IO are a special case in Perl5.
Anyways, since we already use syswrite() and sysread() as functions
on our socket, we might as well use CORE::close(), as well (and
it plays nicely with tied classes).

daemon: map inherited sockets to well-known schemes

I don't want to specify "--listen" in my systemd .service files,
so map 563 to NNTPS automatically (and 443 to HTTPS, but HTTPS
support doesn't work, yet).

certs/create-certs.perl: fix cert validity on 32-bit

If I'm still alive, I won't be coding after 2038 :<

nntp: NNTPS and NNTP+STARTTLS working

It kinda, barely works, and I'm most happy I got it working
without any modifications to the main NNTP::event_step callback
thanks to the DS->write(CODE) support we inherited from
Danga::Socket.

nntp: wait for writability before sending greeting

This will be needed for NNTPS support, since we need
to negotiate the TLS connection before writing the
greeting and we can reuse the existing buffer layer
to enqueue writes.

ds: deal better with FS-related errors IO buffers

Instead of ENOMEM (or fragmentation/swap storms), using tempfile
buffers opens us up to filesystem and storage-related errors
(e.g. ENOSPC, EFBIG, EIO, EROFS).  Log these errors, drop the
particular client, and try to limp by with whateve we have left.

allow use of PerlIO layers for filesystem writes

It may make sense to use PerlIO::mmap or PerlIO::scalar for
DS write buffering with IO::Socket::SSL or similar (since we can't
use MSG_MORE), so that means we need to go through buffering
in userspace for the common case; while still being easily
compatible with slow clients.

And it also simplifies GitHTTPBackend slightly.

Maybe it can make sense for HTTP input buffering, too...

nntp: simplify re-arming/requeue logic

We can be smarter about requeuing clients to run and avoid
excessive epoll_ctl calls since we can trust event_step to do
the right thing depending on the state of the client.

ds: hoist out do_read from NNTP and HTTP

Both NNTP and HTTP have common needs and we can factor
out some common code to make dealing with IO::Socket::SSL
easier.

http|nntp: be explicit about bytes::length on rbuf

It should not matter because our rbuf is always from
a socket without encoding layers, but this makes things
easier to follow.

ds: remove pointless exit calls

They're never called; the only way to break out of that loop
is the PostEventLoop callback.

evcleanup: replace _run_asap with `event_step' callback

No point in keeping a one-line wrapper sub around.

ds: pass $self to code references

We can reduce the amount of short-lived anonymous subs we
create by passing $self to code references.

http: don't pass extra args to PublicInbox::DS::close

YAGNI

Followup-to: commit 30ab5cf82b9d47242640f748a0f9a088ca783e32
("ds: reduce Errno imports and drop ->close reason")

ds: favor `delete' over assigning fields to `undef'

This is cleaner in most cases and may allow Perl to reuse memory
from unused fields.

We can do this now that we no longer support Perl 5.8; since
Danga::Socket was written with struct-like pseudo-hash support
in mind, and Perl 5.9+ dropped support for pseudo-hashes over
a decade ago.

http|nntp: favor "$! == EFOO" over $!{EFOO} checks

Integer comparisions of "$!" are faster than hash lookups.

See commit 6fa2b29fcd0477d126ebb7db7f97b334f74bbcbc
("ds: cleanup Errno imports and favor constant comparisons")
for benchmarks.

qspawn: describe where `$rpipe' come from

It wasn't immediately obvious to me after several months of
not looking at this code.

spawn: remove `Blocking' flag handling

Instead, the O_NONBLOCK flag is set by PublicInbox::HTTPD::Async;
and we won't be setting it elsewhere.

httpd/async: remove EINTR check

This pipe is always non-blocking when run under public-inbox-httpd
and it won't fail with EINTR in that case

ds: get rid of event_watch field

We don't need to keep track of that field since we always
know what events we're interested in when using one-shot
wakeups.

ds: remove IO::Poll support (for now)

It may be reinstated at a later time if there's interest; but I
want to be able to use one-shot notifications for certain events
while retaining level-triggered notifications others.

OTOH, I intend to fully support kqueue; via IO::KQueue for now,
but via syscall() eventually to take advantage of the syscall
reduction kevent(2) can provide over (current) epoll APIs.

ds: share watch_chg between watch_read/watch_write

There was much duplicate logic between watch_read and
watch_write.  Share that logic, and give us room to enable
edge-triggered or one-shot notifications in the future.

ds: import IO::KQueue namespace

Make the rest of our IO::KQueue-using code less verbose and
closer to the C equivalent.

ds: set event flags directly at initialization

We can avoid the EPOLL_CTL_ADD && EPOLL_CTL_MOD sequence with
a single EPOLL_CTL_ADD.

syscall: get rid of unnecessary uname local vars

We don't need to keep information from uname(2) around outside
of startup.

syscall: get rid of unused EPOLL* constants

EPOLLRDBAND is used for DECnet; and I'm pretty sure I won't be
updating any of our code to work with DECnet.

I've never found use for EPOLLHUP or EPOLLERR, either; so
disable those for now and add comments for things I might
actually use: EPOLLET and EPOLLONESHOT.

ds: get rid of redundant and unnecessary POLL* constants

EPOLL* constants already match their POLL* counterparts and
there's no way Linux can ever diverge or change the values
of those constants.  So we'll favor the EPOLL* ones since we
use EPOLLEXCLUSIVE, already.

For weird stuff like kqueue, we'd need to keep maintaining
the mapping, anyways.

ds: switch write buffering to use a tempfile

Data which can't fit into a generously-sized socket buffer,
has no business being stored in heap.

ds: share send(..., MSG_MORE) logic

No sense in having similar Linux-specific functionality in
both our NNTP.pm and HTTP.pm

http: favor DS->write(strref) when reasonable

This can avoid large memory copies when strings can't be
copy-on-write and saves us the trouble of creating new
refs in the code.

ds: remove support for DS->write(undef)

We call ->flush_write directly, now; so we can eliminate a
needless check.

ds: don't pass `events' arg to EPOLL_CTL_DEL

There's no point in passing a mask of interesting events
when removing an item from the epoll watch set.

ds: lazy-initialize wbuf

We don't need write buffering unless we encounter slow clients
requesting large responses.  So don't waste a hash slot or
(empty) arrayref for it.

ds: split out from ->flush_write and ->write

Get rid of the confusing $need_queue variable and all
the associated documentation for it.  Instead, make it
obvious that we're either skipping the write buffer or
flushing the write buffer by splitting the sub in two.

ds: lazy initialize wbuf_off

Since Perl 5.10+, "fields" makes a restricted hash; not a
compile-time-defined array (struct) with fixed offsets as
it did in Perl <= 5.8.

Thus in-use fields cost memory, and since the write buffer
offset is rarely needed; stop relying on it.

ds: get rid of on_incomplete_write wrapper

Wrong place to be wrapping this method.

AddTimer: avoid clock_gettime for the '0' case

We rely on immediate timers often, so we can avoid the overhead
of an extra subroutine call to retrieve the monotonic time (and
a sometimes-system call on some platforms).

ds: use and export monotonic now()

All of our internal timing code should use monotonic clocks
for consistency against system clock adjustments.

This can be shared by our Daemon and NNTP packages.

ds: get rid of more unused debug instance methods

Over a decade of using Danga::Socket and I never found the
built-in debug functionality useful.

ds: get rid of {closed} field

Merely checking the presence of the {sock} field is
enough, and having multiple sources of truth increases
confusion and the likelyhood of bugs.

manifest: v2 epoch descriptions based on inbox->description

The default $GIT_DIR/description (provided by git.git templates)
isn't very useful for v2 epochs, so use the inbox description
and suffix it with the epoch number if it's otherwise unnamed.

Requested-by: Konstantin Ryabitsev <konstantin@linuxfoundation.org>
  https://public-inbox.org/meta/20190620190017.GA27175@chatter.i7.local/

t/httpd-corner: ensure chunk payload read doesn't overreach

It never has, AFAIK, but I'm making some changes to this code in
another branch and nearly introduced a bug where it would be
overreading and discarding the pipelined request.

t/httpd-corner.t: fix braino :x

Plack is for Perl, Rack is for Ruby; this a Perl project :x

ds: stop distinguishing event read and write callbacks

Having separate read/write callbacks in every class is too
confusing to my easily-confused mind.  Instead, give every class
an "event_step" callback which is easier to wrap my head around.

This will make future code to support IO::Socket::SSL-wrapped
sockets easier-to-digest, since SSL_write() can require waiting
on POLLIN events, and SSL_read() can require waiting on POLLOUT
events.

t/replace.t: fix SKIP label for testing w/o Xapian

xcpdb: don't warn on --jobs != --reshard

It's slightly confusing since we dedicate one job
to dealing with fast-import + SQLite indexing; and
it's not worth complaining about when it happens.

Merge remote-tracking branch 'origin/newspeak' into xcpdb

* origin/newspeak:
  comments: replace "partition" with "shard"
  t/xcpdb-reshard: use 'shard' term in local variables
  xapcmd: favor 'shard' over 'part' in local variables
  search: use "shard" for local variable
  v2writable: use "epoch" consistently when referring to git repos
  adminedit: "part" => "shard" for local variables
  v2writable: rename local vars to match Xapian terminology
  v2writable: avoid "part" in internal subs and fields
  search*: rename {partition} => {shard}
  xapcmd: update comments referencing "partitions"
  v2: rename SearchIdxPart => SearchIdxShard
  inboxwritable: s/partitions/shards/ in local var
  tests: change messages to use "shard" instead of partition
  v2writable: rename {partitions} field to {shards}
  v2writable: count_partitions => count_shards
  searchidxpart: start using "shard" in user-visible places
  rename reference to git epochs as "partitions"
  admin|xapcmd: user-facing messages say "shard"
  v2writable: update comments regarding xcpdb --reshard
  doc: rename our Xapian "partitions" to "shards"

t/psgi_search.t: use higher-level APIs

No point in using lower-level APIs for a PSGI test.

searchview: add link at bottom to reverse results

I could not find a place to put the link the top without
making navigation too cluttered.  Putting it at the bottom
of the page seems reasonable...

searchview: support negative offsets to reverse ordering

Taking a hint from Perl array access, we'll allow negative
offsets for the 'o' parameter and to reverse the sort order.

Merge remote-tracking branch 'origin/ds'

* origin/ds:
  ds: stop caring about event flags set by epoll/poll/kqueue
  ds: do not distinguish between POLLHUP and POLLERR
  ds: remove read method, here, too
  nntp: use sysread to append to existing buffer
  ds: remove steal_socket method
  ds: remove {fd} field
  ds: reduce Errno imports and drop ->close reason
  ds: cleanup Errno imports and favor constant comparisons
  ds: simplify write buffer accounting

t/git-http-backend: explain purpose of test

I found myself tempted to switch to HTTP::Tiny, here, since
it's distributed with Perl since 5.14, unlike Net::HTTP
(which AFAIK was never a part of Perl proper).

But we really want to use Net::HTTP, here, since it's
lower-level and allows us to trigger server-side buffering
by not reading the entity body.

comments: replace "partition" with "shard"

Now that the code matches Xapian terminology, ensure
our comments match, too.

t/xcpdb-reshard: use 'shard' term in local variables

Another step in maintaining consistency with Xapian docs.

xapcmd: favor 'shard' over 'part' in local variables

Yet another step to keeping our naming consistent with Xapian
terminology.

search: use "shard" for local variable

Another small step towards terminology consistency with Xapian.

v2writable: use "epoch" consistently when referring to git repos

Be consistent with our own terminology and use "epoch" for
[0-9]+\.git repos.  The term "partition" is going away entirely.

adminedit: "part" => "shard" for local variables

v2writable: rename local vars to match Xapian terminology

v2writable: avoid "part" in internal subs and fields

We'll be using the term "shard" from now on to be consistent
with Xapian terminology.

search*: rename {partition} => {shard}

Another step towards keeping our internal data structures
consistent with Xapian naming.

xapcmd: update comments referencing "partitions"

Don't confuse future readers of our code.

v2: rename SearchIdxPart => SearchIdxShard

Another step towards keeping our file and package names
consistent with Xapian terminology.

inboxwritable: s/partitions/shards/ in local var

More work towards being consistent with Xapian's own terminology

tests: change messages to use "shard" instead of partition

Another potentially user-facing piece made consistent with
Xapian terminology.

v2writable: rename {partitions} field to {shards}

Our internal data structure should be consistent with Xapian
terminology.

v2writable: count_partitions => count_shards

Another step towards becoming consistent with Xapian terminology

searchidxpart: start using "shard" in user-visible places

We'll name our process title with "shard" instead, and
update a few error messages and comments to match.

rename reference to git epochs as "partitions"

Try to remain consistent with our own documentation regarding
v2 git "epochs", first.

admin|xapcmd: user-facing messages say "shard"

We're slowly getting rid of the word "partition" when it
comes to remain consistent with Xapian docs.

v2writable: update comments regarding xcpdb --reshard

Using compact to change shard count was abandoned during
the v2 development phase.

doc: rename our Xapian "partitions" to "shards"

For consistency with Xapian documentation (in the "master"
branch).