← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tuned_gzip.py

  • Committer: Alexander Belchenko
  • Date: 2006-07-30 16:43:12 UTC
  • mto: (1711.2.111 jam-integration)
  • mto: This revision was merged to the branch mainline in revision 1906.
  • Revision ID: bialix@ukr.net-20060730164312-b025fd3ff0cee59e
rename  gpl.txt => COPYING.txt

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) 2005, 2006 by 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
 
20
 
from cStringIO import StringIO
21
 
 
22
20
# make GzipFile faster:
23
21
import gzip
24
 
from gzip import FEXTRA, FCOMMENT, FNAME, FHCRC
 
22
from gzip import U32, LOWU32, FEXTRA, FCOMMENT, FNAME, FHCRC
25
23
import sys
26
24
import struct
27
25
import zlib
29
27
# we want a \n preserved, break on \n only splitlines.
30
28
import bzrlib
31
29
 
32
 
__all__ = ["GzipFile", "bytes_to_gzip"]
33
 
 
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
 
def bytes_to_gzip(bytes, factory=zlib.compressobj,
51
 
    level=zlib.Z_DEFAULT_COMPRESSION, method=zlib.DEFLATED,
52
 
    width=-zlib.MAX_WBITS, mem=zlib.DEF_MEM_LEVEL,
53
 
    crc32=zlib.crc32):
54
 
    """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
 
    result = [
68
 
        '\037\213'  # self.fileobj.write('\037\213')  # magic header
69
 
        '\010'      # self.fileobj.write('\010')      # compression method
70
 
                    # fname = self.filename[:-3]
71
 
                    # flags = 0
72
 
                    # if fname:
73
 
                    #     flags = FNAME
74
 
        '\x00'      # self.fileobj.write(chr(flags))
75
 
        '\0\0\0\0'  # write32u(self.fileobj, long(time.time()))
76
 
        '\002'      # self.fileobj.write('\002')
77
 
        '\377'      # self.fileobj.write('\377')
78
 
                    # if fname:
79
 
        ''          #     self.fileobj.write(fname + '\000')
80
 
        ]
81
 
    # using a compressobj avoids a small header and trailer that the compress()
82
 
    # utility function adds.
83
 
    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)
92
 
    result.append(compress.flush())
93
 
    # size may exceed 2GB, or even 4GB
94
 
    result.append(struct.pack("<LL", LOWU32(crc), LOWU32(total_len)))
95
 
    return ''.join(result)
 
30
__all__ = ["GzipFile"]
96
31
 
97
32
 
98
33
class GzipFile(gzip.GzipFile):
128
63
        self.extrasize += len_data
129
64
        self.size += len_data
130
65
 
131
 
    def _write_gzip_header(self):
132
 
        """A tuned version of gzip._write_gzip_header
133
 
 
134
 
        We have some extra constrains that plain Gzip does not.
135
 
        1) We want to write the whole blob at once. rather than multiple
136
 
           calls to fileobj.write().
137
 
        2) We never have a filename
138
 
        3) We don't care about the time
139
 
        """
140
 
        self.fileobj.write(
141
 
           '\037\213'   # self.fileobj.write('\037\213')  # magic header
142
 
            '\010'      # self.fileobj.write('\010')      # compression method
143
 
                        # fname = self.filename[:-3]
144
 
                        # flags = 0
145
 
                        # if fname:
146
 
                        #     flags = FNAME
147
 
            '\x00'      # self.fileobj.write(chr(flags))
148
 
            '\0\0\0\0'  # write32u(self.fileobj, long(time.time()))
149
 
            '\002'      # self.fileobj.write('\002')
150
 
            '\377'      # self.fileobj.write('\377')
151
 
                        # if fname:
152
 
            ''          #     self.fileobj.write(fname + '\000')
153
 
            )
154
 
 
155
66
    def _read(self, size=1024):
156
67
        # various optimisations:
157
 
        # reduces lsprof count from 2500 to
 
68
        # reduces lsprof count from 2500 to 
158
69
        # 8337 calls in 1272, 365 internal
159
70
        if self.fileobj is None:
160
71
            raise EOFError, "Reached EOF"
182
93
 
183
94
        if buf == "":
184
95
            self._add_read_data(self.decompress.flush())
185
 
            if len(self.decompress.unused_data) < 8:
186
 
                raise AssertionError("what does flush do?")
 
96
            assert len(self.decompress.unused_data) >= 8, "what does flush do?"
187
97
            self._gzip_tail = self.decompress.unused_data[0:8]
188
98
            self._read_eof()
189
99
            # tell the driving read() call we have stuffed all the data
209
119
                self._gzip_tail = self.decompress.unused_data[0:8]
210
120
            elif seek_length < 0:
211
121
                # we haven't read enough to check the checksum.
212
 
                if not (-8 < seek_length):
213
 
                    raise AssertionError("too great a seek")
 
122
                assert -8 < seek_length, "too great a seek."
214
123
                buf = self.fileobj.read(-seek_length)
215
124
                self._gzip_tail = self.decompress.unused_data + buf
216
125
            else:
225
134
        """tuned to reduce function calls and eliminate file seeking:
226
135
        pass 1:
227
136
        reduces lsprof count from 800 to 288
228
 
        4168 in 296
 
137
        4168 in 296 
229
138
        avoid U32 call by using struct format L
230
139
        4168 in 200
231
140
        """
232
 
        # We've read to the end of the file, so we should have 8 bytes of
 
141
        # We've read to the end of the file, so we should have 8 bytes of 
233
142
        # unused data in the decompressor. If we don't, there is a corrupt file.
234
143
        # We use these 8 bytes to calculate the CRC and the recorded file size.
235
144
        # We then check the that the computed CRC and size of the
236
145
        # uncompressed data matches the stored values.  Note that the size
237
146
        # stored is the true file size mod 2**32.
238
 
        if not (len(self._gzip_tail) == 8):
239
 
            raise AssertionError("gzip trailer is incorrect length.")
 
147
        assert len(self._gzip_tail) == 8, "gzip trailer is incorrect length."
240
148
        crc32, isize = struct.unpack("<LL", self._gzip_tail)
241
149
        # note that isize is unsigned - it can exceed 2GB
242
150
        if crc32 != U32(self.crc):
246
154
 
247
155
    def _read_gzip_header(self, bytes=None):
248
156
        """Supply bytes if the minimum header size is already read.
249
 
 
 
157
        
250
158
        :param bytes: 10 bytes of header data.
251
159
        """
252
160
        """starting cost: 300 in 3998
289
197
 
290
198
    def readline(self, size=-1):
291
199
        """Tuned to remove buffer length calls in _unread and...
292
 
 
 
200
        
293
201
        also removes multiple len(c) calls, inlines _unread,
294
202
        total savings - lsprof 5800 to 5300
295
203
        phase 2:
299
207
        leading to a drop to:
300
208
        4168 calls in 1977
301
209
        4168 call to read() in 1646
302
 
        - i.e. just reduced the function call overhead. May be worth
 
210
        - i.e. just reduced the function call overhead. May be worth 
303
211
          keeping.
304
212
        """
305
213
        if size < 0: size = sys.maxint
347
255
        # to :
348
256
        # 4168 calls in 417.
349
257
        # Negative numbers result in reading all the lines
350
 
 
351
 
        # python's gzip routine uses sizehint. This is a more efficient way
352
 
        # than python uses to honor it. But it is even more efficient to
353
 
        # just read the entire thing and use cStringIO to split into lines.
354
 
        # if sizehint <= 0:
355
 
        #     sizehint = -1
356
 
        # content = self.read(sizehint)
357
 
        # return bzrlib.osutils.split_lines(content)
358
 
        content = StringIO(self.read(-1))
359
 
        return content.readlines()
 
258
        if sizehint <= 0:
 
259
            sizehint = -1
 
260
        content = self.read(sizehint)
 
261
        return bzrlib.osutils.split_lines(content)
360
262
 
361
263
    def _unread(self, buf, len_buf=None):
362
264
        """tuned to remove unneeded len calls.
363
 
 
 
265
        
364
266
        because this is such an inner routine in readline, and readline is
365
267
        in many inner loops, this has been inlined into readline().
366
268
 
367
269
        The len_buf parameter combined with the reduction in len calls dropped
368
 
        the lsprof ms count for this routine on my test data from 800 to 200 -
 
270
        the lsprof ms count for this routine on my test data from 800 to 200 - 
369
271
        a 75% saving.
370
272
        """
371
273
        if len_buf is None:
389
291
            self.offset += data_len
390
292
 
391
293
    def writelines(self, lines):
392
 
        # profiling indicated a significant overhead
 
294
        # profiling indicated a significant overhead 
393
295
        # calling write for each line.
394
296
        # this batch call is a lot faster :).
395
297
        # (4 seconds to 1 seconds for the sample upgrades I was testing).