File: lzo.hpp

package info (click to toggle)
openvpn3-client 25%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 19,276 kB
  • sloc: cpp: 190,085; python: 7,218; ansic: 1,866; sh: 1,361; java: 402; lisp: 81; makefile: 17
file content (165 lines) | stat: -rw-r--r-- 4,386 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
//    OpenVPN -- An application to securely tunnel IP networks
//               over a single port, with support for SSL/TLS-based
//               session authentication and key exchange,
//               packet encryption, packet authentication, and
//               packet compression.
//
//    Copyright (C) 2012- OpenVPN Inc.
//
//    SPDX-License-Identifier: MPL-2.0 OR AGPL-3.0-only WITH openvpn3-openssl-exception
//

#ifndef OPENVPN_COMPRESS_LZO_H
#define OPENVPN_COMPRESS_LZO_H

// Implement LZO compression.
// Should only be included by lzoselect.hpp

#include "lzo/lzoutil.h"
#include "lzo/lzo1x.h"

namespace openvpn {

class CompressLZO : public Compress
{
  public:
    // magic number for LZO compression
    enum
    {
        LZO_COMPRESS = 0x66,
        LZO_COMPRESS_SWAP = 0x67,
    };

    OPENVPN_SIMPLE_EXCEPTION(lzo_init_failed);

    CompressLZO(const Frame::Ptr &frame,
                const SessionStats::Ptr &stats,
                const bool support_swap_arg,
                const bool asym_arg)
        : Compress(frame, stats),
          support_swap(support_swap_arg),
          asym(asym_arg)
    {
        OVPN_LOG_INFO("LZO init swap=" << support_swap_arg << " asym=" << asym_arg);
        lzo_workspace.init(LZO1X_1_15_MEM_COMPRESS, BufAllocFlags::ARRAY);
    }

    static void init_static()
    {
        if (::lzo_init() != LZO_E_OK)
            throw lzo_init_failed();
    }

    const char *name() const override
    {
        return "lzo";
    }

    void decompress_work(BufferAllocated &buf)
    {
        // initialize work buffer
        lzo_uint zlen = frame->prepare(Frame::DECOMPRESS_WORK, work);

        // do uncompress
        const int err = lzo1x_decompress_safe(buf.c_data(), buf.size(), work.data(), &zlen, lzo_workspace.data());
        if (err != LZO_E_OK)
        {
            error(buf);
            return;
        }
        OVPN_LOG_VERBOSE("LZO uncompress " << buf.size() << " -> " << zlen);
        work.set_size(zlen);
        buf.swap(work);
    }

    void compress(BufferAllocated &buf, const bool hint) override
    {
        // skip null packets
        if (!buf.size())
            return;

        if (hint && !asym)
        {
            // initialize work buffer
            frame->prepare(Frame::COMPRESS_WORK, work);

            // verify that input data length is not too large
            if (lzo_extra_buffer(buf.size()) > work.max_size())
            {
                error(buf);
                return;
            }

            // do compress
            lzo_uint zlen = 0;
            const int err = ::lzo1x_1_15_compress(buf.c_data(), buf.size(), work.data(), &zlen, lzo_workspace.data());

            // check for errors
            if (err != LZO_E_OK)
            {
                error(buf);
                return;
            }

            // did compression actually reduce data length?
            if (zlen < buf.size())
            {
                OVPN_LOG_VERBOSE("LZO compress " << buf.size() << " -> " << zlen);
                work.set_size(zlen);
                if (support_swap)
                    do_swap(work, LZO_COMPRESS_SWAP);
                else
                    work.push_front(LZO_COMPRESS);
                buf.swap(work);
                return;
            }
        }

        // indicate that we didn't compress
        if (support_swap)
            do_swap(buf, NO_COMPRESS_SWAP);
        else
            buf.push_front(NO_COMPRESS);
    }

    void decompress(BufferAllocated &buf) override
    {
        // skip null packets
        if (!buf.size())
            return;

        const unsigned char c = buf.pop_front();
        switch (c)
        {
        case NO_COMPRESS_SWAP:
            do_unswap(buf);
            [[fallthrough]];
        case NO_COMPRESS:
            break;
        case LZO_COMPRESS_SWAP:
            do_unswap(buf);
            [[fallthrough]];
        case LZO_COMPRESS:
            decompress_work(buf);
            break;
        default:
            error(buf); // unknown op
        }
    }

  private:
    // worst case size expansion on compress
    size_t lzo_extra_buffer(const size_t len)
    {
        return len + len / 8 + 128 + 3;
    }

    const bool support_swap;
    const bool asym;
    BufferAllocated work;
    BufferAllocated lzo_workspace;
};

} // namespace openvpn

#endif // OPENVPN_COMPRESS_LZO_H