← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tuned_gzip.py

  • Committer: John Arbash Meinel
  • Date: 2013-05-19 14:29:37 UTC
  • mfrom: (6437.63.9 2.5)
  • mto: (6437.63.10 2.5)
  • mto: This revision was merged to the branch mainline in revision 6575.
  • Revision ID: john@arbash-meinel.com-20130519142937-21ykz2n2y2f22za9
Merge in the actual 2.5 branch. It seems I failed before

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tuned_gzip.py
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
 
1
# Copyright (C) 2006-2011 Canonical Ltd
2
2
# Written by Robert Collins <robert.collins@canonical.com>
3
3
#
4
4
# This program is free software; you can redistribute it and/or modify
13
13
#
14
14
# You should have received a copy of the GNU General Public License
15
15
# along with this program; if not, write to the Free Software
16
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
17
 
18
18
"""Bzrlib specific gzip tunings. We plan to feed these to the upstream gzip."""
19
19
 
 
20
from __future__ import absolute_import
 
21
 
20
22
from cStringIO import StringIO
21
23
 
22
24
# make GzipFile faster:
23
25
import gzip
24
 
from gzip import U32, LOWU32, FEXTRA, FCOMMENT, FNAME, FHCRC
 
26
from gzip import FEXTRA, FCOMMENT, FNAME, FHCRC
25
27
import sys
26
28
import struct
27
29
import zlib
28
30
 
29
31
# we want a \n preserved, break on \n only splitlines.
30
 
import bzrlib
31
 
 
32
 
__all__ = ["GzipFile"]
 
32
from bzrlib import symbol_versioning
 
33
 
 
34
__all__ = ["GzipFile", "bytes_to_gzip"]
 
35
 
 
36
 
 
37
def U32(i):
 
38
    """Return i as an unsigned integer, assuming it fits in 32 bits.
 
39
 
 
40
    If it's >= 2GB when viewed as a 32-bit unsigned int, return a long.
 
41
    """
 
42
    if i < 0:
 
43
        i += 1L << 32
 
44
    return i
 
45
 
 
46
 
 
47
def LOWU32(i):
 
48
    """Return the low-order 32 bits of an int, as a non-negative int."""
 
49
    return i & 0xFFFFFFFFL
 
50
 
 
51
 
 
52
def bytes_to_gzip(bytes, factory=zlib.compressobj,
 
53
    level=zlib.Z_DEFAULT_COMPRESSION, method=zlib.DEFLATED,
 
54
    width=-zlib.MAX_WBITS, mem=zlib.DEF_MEM_LEVEL,
 
55
    crc32=zlib.crc32):
 
56
    """Create a gzip file containing bytes and return its content."""
 
57
    return chunks_to_gzip([bytes])
 
58
 
 
59
 
 
60
def chunks_to_gzip(chunks, factory=zlib.compressobj,
 
61
    level=zlib.Z_DEFAULT_COMPRESSION, method=zlib.DEFLATED,
 
62
    width=-zlib.MAX_WBITS, mem=zlib.DEF_MEM_LEVEL,
 
63
    crc32=zlib.crc32):
 
64
    """Create a gzip file containing chunks and return its content.
 
65
 
 
66
    :param chunks: An iterable of strings. Each string can have arbitrary
 
67
        layout.
 
68
    """
 
69
    result = [
 
70
        '\037\213'  # self.fileobj.write('\037\213')  # magic header
 
71
        '\010'      # self.fileobj.write('\010')      # compression method
 
72
                    # fname = self.filename[:-3]
 
73
                    # flags = 0
 
74
                    # if fname:
 
75
                    #     flags = FNAME
 
76
        '\x00'      # self.fileobj.write(chr(flags))
 
77
        '\0\0\0\0'  # write32u(self.fileobj, long(time.time()))
 
78
        '\002'      # self.fileobj.write('\002')
 
79
        '\377'      # self.fileobj.write('\377')
 
80
                    # if fname:
 
81
        ''          #     self.fileobj.write(fname + '\000')
 
82
        ]
 
83
    # using a compressobj avoids a small header and trailer that the compress()
 
84
    # utility function adds.
 
85
    compress = factory(level, method, width, mem, 0)
 
86
    crc = 0
 
87
    total_len = 0
 
88
    for chunk in chunks:
 
89
        crc = crc32(chunk, crc)
 
90
        total_len += len(chunk)
 
91
        zbytes = compress.compress(chunk)
 
92
        if zbytes:
 
93
            result.append(zbytes)
 
94
    result.append(compress.flush())
 
95
    # size may exceed 2GB, or even 4GB
 
96
    result.append(struct.pack("<LL", LOWU32(crc), LOWU32(total_len)))
 
97
    return ''.join(result)
33
98
 
34
99
 
35
100
class GzipFile(gzip.GzipFile):
55
120
    Yes, its only 1.6 seconds, but they add up.
56
121
    """
57
122
 
 
123
    def __init__(self, *args, **kwargs):
 
124
        symbol_versioning.warn(
 
125
            symbol_versioning.deprecated_in((2, 3, 0))
 
126
            % 'bzrlib.tuned_gzip.GzipFile',
 
127
            DeprecationWarning, stacklevel=2)
 
128
        gzip.GzipFile.__init__(self, *args, **kwargs)
 
129
 
58
130
    def _add_read_data(self, data):
59
131
        # 4169 calls in 183
60
132
        # temp var for len(data) and switch to +='s.
69
141
        """A tuned version of gzip._write_gzip_header
70
142
 
71
143
        We have some extra constrains that plain Gzip does not.
72
 
        1) We want to write the whole blob at once. rather than multiple 
 
144
        1) We want to write the whole blob at once. rather than multiple
73
145
           calls to fileobj.write().
74
146
        2) We never have a filename
75
147
        3) We don't care about the time
91
163
 
92
164
    def _read(self, size=1024):
93
165
        # various optimisations:
94
 
        # reduces lsprof count from 2500 to 
 
166
        # reduces lsprof count from 2500 to
95
167
        # 8337 calls in 1272, 365 internal
96
168
        if self.fileobj is None:
97
169
            raise EOFError, "Reached EOF"
119
191
 
120
192
        if buf == "":
121
193
            self._add_read_data(self.decompress.flush())
122
 
            assert len(self.decompress.unused_data) >= 8, "what does flush do?"
 
194
            if len(self.decompress.unused_data) < 8:
 
195
                raise AssertionError("what does flush do?")
123
196
            self._gzip_tail = self.decompress.unused_data[0:8]
124
197
            self._read_eof()
125
198
            # tell the driving read() call we have stuffed all the data
145
218
                self._gzip_tail = self.decompress.unused_data[0:8]
146
219
            elif seek_length < 0:
147
220
                # we haven't read enough to check the checksum.
148
 
                assert -8 < seek_length, "too great a seek."
 
221
                if not (-8 < seek_length):
 
222
                    raise AssertionError("too great a seek")
149
223
                buf = self.fileobj.read(-seek_length)
150
224
                self._gzip_tail = self.decompress.unused_data + buf
151
225
            else:
160
234
        """tuned to reduce function calls and eliminate file seeking:
161
235
        pass 1:
162
236
        reduces lsprof count from 800 to 288
163
 
        4168 in 296 
 
237
        4168 in 296
164
238
        avoid U32 call by using struct format L
165
239
        4168 in 200
166
240
        """
167
 
        # We've read to the end of the file, so we should have 8 bytes of 
 
241
        # We've read to the end of the file, so we should have 8 bytes of
168
242
        # unused data in the decompressor. If we don't, there is a corrupt file.
169
243
        # We use these 8 bytes to calculate the CRC and the recorded file size.
170
244
        # We then check the that the computed CRC and size of the
171
245
        # uncompressed data matches the stored values.  Note that the size
172
246
        # stored is the true file size mod 2**32.
173
 
        assert len(self._gzip_tail) == 8, "gzip trailer is incorrect length."
 
247
        if not (len(self._gzip_tail) == 8):
 
248
            raise AssertionError("gzip trailer is incorrect length.")
174
249
        crc32, isize = struct.unpack("<LL", self._gzip_tail)
175
250
        # note that isize is unsigned - it can exceed 2GB
176
251
        if crc32 != U32(self.crc):
180
255
 
181
256
    def _read_gzip_header(self, bytes=None):
182
257
        """Supply bytes if the minimum header size is already read.
183
 
        
 
258
 
184
259
        :param bytes: 10 bytes of header data.
185
260
        """
186
261
        """starting cost: 300 in 3998
223
298
 
224
299
    def readline(self, size=-1):
225
300
        """Tuned to remove buffer length calls in _unread and...
226
 
        
 
301
 
227
302
        also removes multiple len(c) calls, inlines _unread,
228
303
        total savings - lsprof 5800 to 5300
229
304
        phase 2:
233
308
        leading to a drop to:
234
309
        4168 calls in 1977
235
310
        4168 call to read() in 1646
236
 
        - i.e. just reduced the function call overhead. May be worth 
 
311
        - i.e. just reduced the function call overhead. May be worth
237
312
          keeping.
238
313
        """
239
314
        if size < 0: size = sys.maxint
281
356
        # to :
282
357
        # 4168 calls in 417.
283
358
        # Negative numbers result in reading all the lines
284
 
        
 
359
 
285
360
        # python's gzip routine uses sizehint. This is a more efficient way
286
361
        # than python uses to honor it. But it is even more efficient to
287
362
        # just read the entire thing and use cStringIO to split into lines.
294
369
 
295
370
    def _unread(self, buf, len_buf=None):
296
371
        """tuned to remove unneeded len calls.
297
 
        
 
372
 
298
373
        because this is such an inner routine in readline, and readline is
299
374
        in many inner loops, this has been inlined into readline().
300
375
 
301
376
        The len_buf parameter combined with the reduction in len calls dropped
302
 
        the lsprof ms count for this routine on my test data from 800 to 200 - 
 
377
        the lsprof ms count for this routine on my test data from 800 to 200 -
303
378
        a 75% saving.
304
379
        """
305
380
        if len_buf is None:
323
398
            self.offset += data_len
324
399
 
325
400
    def writelines(self, lines):
326
 
        # profiling indicated a significant overhead 
 
401
        # profiling indicated a significant overhead
327
402
        # calling write for each line.
328
403
        # this batch call is a lot faster :).
329
404
        # (4 seconds to 1 seconds for the sample upgrades I was testing).
330
405
        self.write(''.join(lines))
331
406
 
 
407
    if sys.version_info > (2, 7):
 
408
        # As of Python 2.7 the crc32 must be positive when close is called
 
409
        def close(self):
 
410
            if self.fileobj is None:
 
411
                return
 
412
            if self.mode == gzip.WRITE:
 
413
                self.crc &= 0xFFFFFFFFL
 
414
            gzip.GzipFile.close(self)
332
415