← 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: 2008-09-09 15:09:12 UTC
  • mto: This revision was merged to the branch mainline in revision 3699.
  • Revision ID: john@arbash-meinel.com-20080909150912-wyttm8he1zsls2ck
Use the right timing function on win32

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tuned_gzip.py
1
 
# Copyright (C) 2006-2011 Canonical Ltd
 
1
# Copyright (C) 2005, 2006 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17
17
 
18
18
"""Bzrlib specific gzip tunings. We plan to feed these to the upstream gzip."""
19
19
 
21
21
 
22
22
# make GzipFile faster:
23
23
import gzip
24
 
from gzip import FEXTRA, FCOMMENT, FNAME, FHCRC
 
24
from gzip import U32, LOWU32, FEXTRA, FCOMMENT, FNAME, FHCRC
25
25
import sys
26
26
import struct
27
27
import zlib
28
28
 
29
29
# we want a \n preserved, break on \n only splitlines.
30
 
from bzrlib import symbol_versioning
 
30
import bzrlib
31
31
 
32
32
__all__ = ["GzipFile", "bytes_to_gzip"]
33
33
 
34
34
 
35
 
def U32(i):
36
 
    """Return i as an unsigned integer, assuming it fits in 32 bits.
37
 
 
38
 
    If it's >= 2GB when viewed as a 32-bit unsigned int, return a long.
39
 
    """
40
 
    if i < 0:
41
 
        i += 1L << 32
42
 
    return i
43
 
 
44
 
 
45
 
def LOWU32(i):
46
 
    """Return the low-order 32 bits of an int, as a non-negative int."""
47
 
    return i & 0xFFFFFFFFL
48
 
 
49
 
 
50
35
def bytes_to_gzip(bytes, factory=zlib.compressobj,
51
36
    level=zlib.Z_DEFAULT_COMPRESSION, method=zlib.DEFLATED,
52
37
    width=-zlib.MAX_WBITS, mem=zlib.DEF_MEM_LEVEL,
53
38
    crc32=zlib.crc32):
54
39
    """Create a gzip file containing bytes and return its content."""
55
 
    return chunks_to_gzip([bytes])
56
 
 
57
 
 
58
 
def chunks_to_gzip(chunks, factory=zlib.compressobj,
59
 
    level=zlib.Z_DEFAULT_COMPRESSION, method=zlib.DEFLATED,
60
 
    width=-zlib.MAX_WBITS, mem=zlib.DEF_MEM_LEVEL,
61
 
    crc32=zlib.crc32):
62
 
    """Create a gzip file containing chunks and return its content.
63
 
 
64
 
    :param chunks: An iterable of strings. Each string can have arbitrary
65
 
        layout.
66
 
    """
67
40
    result = [
68
41
        '\037\213'  # self.fileobj.write('\037\213')  # magic header
69
42
        '\010'      # self.fileobj.write('\010')      # compression method
81
54
    # using a compressobj avoids a small header and trailer that the compress()
82
55
    # utility function adds.
83
56
    compress = factory(level, method, width, mem, 0)
84
 
    crc = 0
85
 
    total_len = 0
86
 
    for chunk in chunks:
87
 
        crc = crc32(chunk, crc)
88
 
        total_len += len(chunk)
89
 
        zbytes = compress.compress(chunk)
90
 
        if zbytes:
91
 
            result.append(zbytes)
 
57
    result.append(compress.compress(bytes))
92
58
    result.append(compress.flush())
 
59
    result.append(struct.pack("<L", LOWU32(crc32(bytes))))
93
60
    # size may exceed 2GB, or even 4GB
94
 
    result.append(struct.pack("<LL", LOWU32(crc), LOWU32(total_len)))
 
61
    result.append(struct.pack("<L", LOWU32(len(bytes))))
95
62
    return ''.join(result)
96
63
 
97
64
 
118
85
    Yes, its only 1.6 seconds, but they add up.
119
86
    """
120
87
 
121
 
    def __init__(self, *args, **kwargs):
122
 
        symbol_versioning.warn(
123
 
            symbol_versioning.deprecated_in((2, 3, 0))
124
 
            % 'bzrlib.tuned_gzip.GzipFile',
125
 
            DeprecationWarning, stacklevel=2)
126
 
        gzip.GzipFile.__init__(self, *args, **kwargs)
127
 
 
128
88
    def _add_read_data(self, data):
129
89
        # 4169 calls in 183
130
90
        # temp var for len(data) and switch to +='s.
139
99
        """A tuned version of gzip._write_gzip_header
140
100
 
141
101
        We have some extra constrains that plain Gzip does not.
142
 
        1) We want to write the whole blob at once. rather than multiple
 
102
        1) We want to write the whole blob at once. rather than multiple 
143
103
           calls to fileobj.write().
144
104
        2) We never have a filename
145
105
        3) We don't care about the time
161
121
 
162
122
    def _read(self, size=1024):
163
123
        # various optimisations:
164
 
        # reduces lsprof count from 2500 to
 
124
        # reduces lsprof count from 2500 to 
165
125
        # 8337 calls in 1272, 365 internal
166
126
        if self.fileobj is None:
167
127
            raise EOFError, "Reached EOF"
232
192
        """tuned to reduce function calls and eliminate file seeking:
233
193
        pass 1:
234
194
        reduces lsprof count from 800 to 288
235
 
        4168 in 296
 
195
        4168 in 296 
236
196
        avoid U32 call by using struct format L
237
197
        4168 in 200
238
198
        """
239
 
        # We've read to the end of the file, so we should have 8 bytes of
 
199
        # We've read to the end of the file, so we should have 8 bytes of 
240
200
        # unused data in the decompressor. If we don't, there is a corrupt file.
241
201
        # We use these 8 bytes to calculate the CRC and the recorded file size.
242
202
        # We then check the that the computed CRC and size of the
253
213
 
254
214
    def _read_gzip_header(self, bytes=None):
255
215
        """Supply bytes if the minimum header size is already read.
256
 
 
 
216
        
257
217
        :param bytes: 10 bytes of header data.
258
218
        """
259
219
        """starting cost: 300 in 3998
296
256
 
297
257
    def readline(self, size=-1):
298
258
        """Tuned to remove buffer length calls in _unread and...
299
 
 
 
259
        
300
260
        also removes multiple len(c) calls, inlines _unread,
301
261
        total savings - lsprof 5800 to 5300
302
262
        phase 2:
306
266
        leading to a drop to:
307
267
        4168 calls in 1977
308
268
        4168 call to read() in 1646
309
 
        - i.e. just reduced the function call overhead. May be worth
 
269
        - i.e. just reduced the function call overhead. May be worth 
310
270
          keeping.
311
271
        """
312
272
        if size < 0: size = sys.maxint
354
314
        # to :
355
315
        # 4168 calls in 417.
356
316
        # Negative numbers result in reading all the lines
357
 
 
 
317
        
358
318
        # python's gzip routine uses sizehint. This is a more efficient way
359
319
        # than python uses to honor it. But it is even more efficient to
360
320
        # just read the entire thing and use cStringIO to split into lines.
367
327
 
368
328
    def _unread(self, buf, len_buf=None):
369
329
        """tuned to remove unneeded len calls.
370
 
 
 
330
        
371
331
        because this is such an inner routine in readline, and readline is
372
332
        in many inner loops, this has been inlined into readline().
373
333
 
374
334
        The len_buf parameter combined with the reduction in len calls dropped
375
 
        the lsprof ms count for this routine on my test data from 800 to 200 -
 
335
        the lsprof ms count for this routine on my test data from 800 to 200 - 
376
336
        a 75% saving.
377
337
        """
378
338
        if len_buf is None:
396
356
            self.offset += data_len
397
357
 
398
358
    def writelines(self, lines):
399
 
        # profiling indicated a significant overhead
 
359
        # profiling indicated a significant overhead 
400
360
        # calling write for each line.
401
361
        # this batch call is a lot faster :).
402
362
        # (4 seconds to 1 seconds for the sample upgrades I was testing).
403
363
        self.write(''.join(lines))
404
364
 
405
 
    if sys.version_info > (2, 7):
406
 
        # As of Python 2.7 the crc32 must be positive when close is called
407
 
        def close(self):
408
 
            if self.fileobj is None:
409
 
                return
410
 
            if self.mode == gzip.WRITE:
411
 
                self.crc &= 0xFFFFFFFFL
412
 
            gzip.GzipFile.close(self)
413
365