← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tuned_gzip.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-03-11 13:47:06 UTC
  • mfrom: (5051.3.16 use-branch-open)
  • Revision ID: pqm@pqm.ubuntu.com-20100311134706-kaerqhx3lf7xn6rh
(Jelmer) Pass colocated branch names further down the call stack.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tuned_gzip.py
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
 
21
21
 
22
22
# make GzipFile faster:
23
23
import gzip
24
 
from gzip import U32, LOWU32, FEXTRA, FCOMMENT, FNAME, FHCRC
 
24
from gzip import FEXTRA, FCOMMENT, FNAME, FHCRC
25
25
import sys
26
26
import struct
27
27
import zlib
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
 
35
50
def bytes_to_gzip(bytes, factory=zlib.compressobj,
36
51
    level=zlib.Z_DEFAULT_COMPRESSION, method=zlib.DEFLATED,
37
52
    width=-zlib.MAX_WBITS, mem=zlib.DEF_MEM_LEVEL,
38
53
    crc32=zlib.crc32):
39
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
    """
40
67
    result = [
41
68
        '\037\213'  # self.fileobj.write('\037\213')  # magic header
42
69
        '\010'      # self.fileobj.write('\010')      # compression method
54
81
    # using a compressobj avoids a small header and trailer that the compress()
55
82
    # utility function adds.
56
83
    compress = factory(level, method, width, mem, 0)
57
 
    result.append(compress.compress(bytes))
 
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)
58
92
    result.append(compress.flush())
59
 
    result.append(struct.pack("<L", LOWU32(crc32(bytes))))
60
93
    # size may exceed 2GB, or even 4GB
61
 
    result.append(struct.pack("<L", LOWU32(len(bytes))))
 
94
    result.append(struct.pack("<LL", LOWU32(crc), LOWU32(total_len)))
62
95
    return ''.join(result)
63
96
 
64
97
 
99
132
        """A tuned version of gzip._write_gzip_header
100
133
 
101
134
        We have some extra constrains that plain Gzip does not.
102
 
        1) We want to write the whole blob at once. rather than multiple 
 
135
        1) We want to write the whole blob at once. rather than multiple
103
136
           calls to fileobj.write().
104
137
        2) We never have a filename
105
138
        3) We don't care about the time
121
154
 
122
155
    def _read(self, size=1024):
123
156
        # various optimisations:
124
 
        # reduces lsprof count from 2500 to 
 
157
        # reduces lsprof count from 2500 to
125
158
        # 8337 calls in 1272, 365 internal
126
159
        if self.fileobj is None:
127
160
            raise EOFError, "Reached EOF"
192
225
        """tuned to reduce function calls and eliminate file seeking:
193
226
        pass 1:
194
227
        reduces lsprof count from 800 to 288
195
 
        4168 in 296 
 
228
        4168 in 296
196
229
        avoid U32 call by using struct format L
197
230
        4168 in 200
198
231
        """
199
 
        # We've read to the end of the file, so we should have 8 bytes of 
 
232
        # We've read to the end of the file, so we should have 8 bytes of
200
233
        # unused data in the decompressor. If we don't, there is a corrupt file.
201
234
        # We use these 8 bytes to calculate the CRC and the recorded file size.
202
235
        # We then check the that the computed CRC and size of the
213
246
 
214
247
    def _read_gzip_header(self, bytes=None):
215
248
        """Supply bytes if the minimum header size is already read.
216
 
        
 
249
 
217
250
        :param bytes: 10 bytes of header data.
218
251
        """
219
252
        """starting cost: 300 in 3998
256
289
 
257
290
    def readline(self, size=-1):
258
291
        """Tuned to remove buffer length calls in _unread and...
259
 
        
 
292
 
260
293
        also removes multiple len(c) calls, inlines _unread,
261
294
        total savings - lsprof 5800 to 5300
262
295
        phase 2:
266
299
        leading to a drop to:
267
300
        4168 calls in 1977
268
301
        4168 call to read() in 1646
269
 
        - i.e. just reduced the function call overhead. May be worth 
 
302
        - i.e. just reduced the function call overhead. May be worth
270
303
          keeping.
271
304
        """
272
305
        if size < 0: size = sys.maxint
314
347
        # to :
315
348
        # 4168 calls in 417.
316
349
        # Negative numbers result in reading all the lines
317
 
        
 
350
 
318
351
        # python's gzip routine uses sizehint. This is a more efficient way
319
352
        # than python uses to honor it. But it is even more efficient to
320
353
        # just read the entire thing and use cStringIO to split into lines.
327
360
 
328
361
    def _unread(self, buf, len_buf=None):
329
362
        """tuned to remove unneeded len calls.
330
 
        
 
363
 
331
364
        because this is such an inner routine in readline, and readline is
332
365
        in many inner loops, this has been inlined into readline().
333
366
 
334
367
        The len_buf parameter combined with the reduction in len calls dropped
335
 
        the lsprof ms count for this routine on my test data from 800 to 200 - 
 
368
        the lsprof ms count for this routine on my test data from 800 to 200 -
336
369
        a 75% saving.
337
370
        """
338
371
        if len_buf is None:
356
389
            self.offset += data_len
357
390
 
358
391
    def writelines(self, lines):
359
 
        # profiling indicated a significant overhead 
 
392
        # profiling indicated a significant overhead
360
393
        # calling write for each line.
361
394
        # this batch call is a lot faster :).
362
395
        # (4 seconds to 1 seconds for the sample upgrades I was testing).