]> Sergey Matveev's repositories - public-inbox.git/blob - lib/PublicInbox/NNTPdeflate.pm
Merge remote-tracking branch 'origin/nntp-compress'
[public-inbox.git] / lib / PublicInbox / NNTPdeflate.pm
1 # Copyright (C) 2019 all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
3
4 # RFC 8054 NNTP COMPRESS DEFLATE implementation
5 #
6 # RSS usage for 10K idle-but-did-something NNTP clients on 64-bit:
7 #   TLS + DEFLATE[a] :  1.8 GB  (MemLevel=9, 1.2 GB with MemLevel=8)
8 #   TLS + DEFLATE[b] :  ~300MB
9 #   TLS only         :  <200MB
10 #   plain            :   <50MB
11 #
12 # [a] - initial implementation using per-client Deflate contexts and buffer
13 #
14 # [b] - memory-optimized implementation using a global deflate context.
15 #       It's less efficient in terms of compression, but way more
16 #       efficient in terms of server memory usage.
17 package PublicInbox::NNTPdeflate;
18 use strict;
19 use warnings;
20 use 5.010_001;
21 use base qw(PublicInbox::NNTP);
22 use Compress::Raw::Zlib;
23 use Hash::Util qw(unlock_hash); # dependency of fields for perl 5.10+, anyways
24
25 my %IN_OPT = (
26         -Bufsize => PublicInbox::NNTP::LINE_MAX,
27         -WindowBits => -15, # RFC 1951
28         -AppendOutput => 1,
29 );
30
31 # global deflate context and buffer
32 my $zbuf = \(my $buf = '');
33 my $zout;
34 {
35         my $err;
36         ($zout, $err) = Compress::Raw::Zlib::Deflate->new(
37                 # nnrpd (INN) and Compress::Raw::Zlib favor MemLevel=9,
38                 # the zlib C library and git use MemLevel=8 as the default
39                 # -MemLevel => 9,
40                 -Bufsize => 65536, # same as nnrpd
41                 -WindowBits => -15, # RFC 1951
42                 -AppendOutput => 1,
43         );
44         $err == Z_OK or die "Failed to initialize zlib deflate stream: $err";
45 }
46
47
48 sub enable {
49         my ($class, $self) = @_;
50         my ($in, $err) = Compress::Raw::Zlib::Inflate->new(%IN_OPT);
51         if ($err != Z_OK) {
52                 $self->err("Inflate->new failed: $err");
53                 $self->res('403 Unable to activate compression');
54                 return;
55         }
56         unlock_hash(%$self);
57         $self->res('206 Compression active');
58         bless $self, $class;
59         $self->{zin} = [ $in, '' ];
60 }
61
62 # overrides PublicInbox::NNTP::compressed
63 sub compressed { 1 }
64
65 # SUPER is PublicInbox::DS::do_read, so $_[1] may be a reference or not
66 sub do_read ($$$$) {
67         my ($self, $rbuf, $len, $off) = @_;
68
69         my $zin = $self->{zin} or return; # closed
70         my $deflated = \($zin->[1]);
71         my $r = $self->SUPER::do_read($deflated, $len) or return;
72
73         # assert(length($$rbuf) == $off) as far as NNTP.pm is concerned
74         # -ConsumeInput is true, so $deflated is automatically emptied
75         my $err = $zin->[0]->inflate($deflated, $rbuf);
76         if ($err == Z_OK) {
77                 $r = length($$rbuf) and return $r;
78                 # nothing ready, yet, get more, later
79                 $self->requeue;
80         } else {
81                 delete $self->{zin};
82                 $self->close;
83         }
84         0;
85 }
86
87 # override PublicInbox::DS::msg_more
88 sub msg_more ($$) {
89         my $self = $_[0];
90
91         # $_[1] may be a reference or not for ->deflate
92         my $err = $zout->deflate($_[1], $zbuf);
93         $err == Z_OK or die "->deflate failed $err";
94         1;
95 }
96
97 sub zflush ($) {
98         my ($self) = @_;
99
100         my $deflated = $zbuf;
101         $zbuf = \(my $next = '');
102
103         my $err = $zout->flush($deflated, Z_FULL_FLUSH);
104         $err == Z_OK or die "->flush failed $err";
105
106         # We can still let the lower socket layer do buffering:
107         PublicInbox::DS::msg_more($self, $$deflated);
108 }
109
110 # compatible with PublicInbox::DS::write, so $_[1] may be a reference or not
111 sub write ($$) {
112         my $self = $_[0];
113         return PublicInbox::DS::write($self, $_[1]) if ref($_[1]) eq 'CODE';
114
115         my $deflated = $zbuf;
116         $zbuf = \(my $next = '');
117
118         # $_[1] may be a reference or not for ->deflate
119         my $err = $zout->deflate($_[1], $deflated);
120         $err == Z_OK or die "->deflate failed $err";
121         $err = $zout->flush($deflated, Z_FULL_FLUSH);
122         $err == Z_OK or die "->flush failed $err";
123
124         # We can still let the socket layer do buffering:
125         PublicInbox::DS::write($self, $deflated);
126 }
127
128 1;