1
# Copyright (C) 2005, 2006 Canonical Ltd
2
# Written by Robert Collins <robert.collins@canonical.com>
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
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
18
"""Bzrlib specific gzip tunings. We plan to feed these to the upstream gzip."""
20
from cStringIO import StringIO
22
# make GzipFile faster:
24
from gzip import FEXTRA, FCOMMENT, FNAME, FHCRC
29
# we want a \n preserved, break on \n only splitlines.
32
__all__ = ["GzipFile", "bytes_to_gzip"]
36
"""Return i as an unsigned integer, assuming it fits in 32 bits.
38
If it's >= 2GB when viewed as a 32-bit unsigned int, return a long.
46
"""Return the low-order 32 bits of an int, as a non-negative int."""
47
return i & 0xFFFFFFFFL
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,
54
"""Create a gzip file containing bytes and return its content."""
55
return chunks_to_gzip([bytes])
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,
62
"""Create a gzip file containing chunks and return its content.
64
:param chunks: An iterable of strings. Each string can have arbitrary
68
'\037\213' # self.fileobj.write('\037\213') # magic header
69
'\010' # self.fileobj.write('\010') # compression method
70
# fname = self.filename[:-3]
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')
79
'' # self.fileobj.write(fname + '\000')
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)
87
crc = crc32(chunk, crc)
88
total_len += len(chunk)
89
zbytes = compress.compress(chunk)
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)
98
class GzipFile(gzip.GzipFile):
99
"""Knit tuned version of GzipFile.
101
This is based on the following lsprof stats:
102
python 2.4 stock GzipFile write:
103
58971 0 5644.3090 2721.4730 gzip:193(write)
104
+58971 0 1159.5530 1159.5530 +<built-in method compress>
105
+176913 0 987.0320 987.0320 +<len>
106
+58971 0 423.1450 423.1450 +<zlib.crc32>
107
+58971 0 353.1060 353.1060 +<method 'write' of 'cStringIO.
109
tuned GzipFile write:
110
58971 0 4477.2590 2103.1120 bzrlib.knit:1250(write)
111
+58971 0 1297.7620 1297.7620 +<built-in method compress>
112
+58971 0 406.2160 406.2160 +<zlib.crc32>
113
+58971 0 341.9020 341.9020 +<method 'write' of 'cStringIO.
115
+58971 0 328.2670 328.2670 +<len>
118
Yes, its only 1.6 seconds, but they add up.
121
def _add_read_data(self, data):
123
# temp var for len(data) and switch to +='s.
126
self.crc = zlib.crc32(data, self.crc)
127
self.extrabuf += data
128
self.extrasize += len_data
129
self.size += len_data
131
def _write_gzip_header(self):
132
"""A tuned version of gzip._write_gzip_header
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
141
'\037\213' # self.fileobj.write('\037\213') # magic header
142
'\010' # self.fileobj.write('\010') # compression method
143
# fname = self.filename[:-3]
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')
152
'' # self.fileobj.write(fname + '\000')
155
def _read(self, size=1024):
156
# various optimisations:
157
# reduces lsprof count from 2500 to
158
# 8337 calls in 1272, 365 internal
159
if self.fileobj is None:
160
raise EOFError, "Reached EOF"
163
# If the _new_member flag is set, we have to
164
# jump to the next member, if there is one.
166
# First, check if we're at the end of the file;
167
# if so, it's time to stop; no more members to read.
168
next_header_bytes = self.fileobj.read(10)
169
if next_header_bytes == '':
170
raise EOFError, "Reached EOF"
173
self._read_gzip_header(next_header_bytes)
174
self.decompress = zlib.decompressobj(-zlib.MAX_WBITS)
175
self._new_member = False
177
# Read a chunk of data from the file
178
buf = self.fileobj.read(size)
180
# If the EOF has been reached, flush the decompression object
181
# and mark this object as finished.
184
self._add_read_data(self.decompress.flush())
185
if len(self.decompress.unused_data) < 8:
186
raise AssertionError("what does flush do?")
187
self._gzip_tail = self.decompress.unused_data[0:8]
189
# tell the driving read() call we have stuffed all the data
191
raise EOFError, 'Reached EOF'
193
self._add_read_data(self.decompress.decompress(buf))
195
if self.decompress.unused_data != "":
196
# Ending case: we've come to the end of a member in the file,
197
# so seek back to the start of the data for the next member which
198
# is the length of the decompress objects unused data - the first
199
# 8 bytes for the end crc and size records.
201
# so seek back to the start of the unused data, finish up
202
# this member, and read a new gzip header.
203
# (The number of bytes to seek back is the length of the unused
204
# data, minus 8 because those 8 bytes are part of this member.
205
seek_length = len (self.decompress.unused_data) - 8
207
# we read too much data
208
self.fileobj.seek(-seek_length, 1)
209
self._gzip_tail = self.decompress.unused_data[0:8]
210
elif seek_length < 0:
211
# we haven't read enough to check the checksum.
212
if not (-8 < seek_length):
213
raise AssertionError("too great a seek")
214
buf = self.fileobj.read(-seek_length)
215
self._gzip_tail = self.decompress.unused_data + buf
217
self._gzip_tail = self.decompress.unused_data
219
# Check the CRC and file size, and set the flag so we read
220
# a new member on the next call
222
self._new_member = True
225
"""tuned to reduce function calls and eliminate file seeking:
227
reduces lsprof count from 800 to 288
229
avoid U32 call by using struct format L
232
# We've read to the end of the file, so we should have 8 bytes of
233
# unused data in the decompressor. If we don't, there is a corrupt file.
234
# We use these 8 bytes to calculate the CRC and the recorded file size.
235
# We then check the that the computed CRC and size of the
236
# uncompressed data matches the stored values. Note that the size
237
# 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.")
240
crc32, isize = struct.unpack("<LL", self._gzip_tail)
241
# note that isize is unsigned - it can exceed 2GB
242
if crc32 != U32(self.crc):
243
raise IOError, "CRC check failed %d %d" % (crc32, U32(self.crc))
244
elif isize != LOWU32(self.size):
245
raise IOError, "Incorrect length of data produced"
247
def _read_gzip_header(self, bytes=None):
248
"""Supply bytes if the minimum header size is already read.
250
:param bytes: 10 bytes of header data.
252
"""starting cost: 300 in 3998
253
15998 reads from 3998 calls
257
bytes = self.fileobj.read(10)
259
if magic != '\037\213':
260
raise IOError, 'Not a gzipped file'
261
method = ord(bytes[2:3])
263
raise IOError, 'Unknown compression method'
264
flag = ord(bytes[3:4])
265
# modtime = self.fileobj.read(4) (bytes [4:8])
266
# extraflag = self.fileobj.read(1) (bytes[8:9])
267
# os = self.fileobj.read(1) (bytes[9:10])
268
# self.fileobj.read(6)
271
# Read & discard the extra field, if present
272
xlen = ord(self.fileobj.read(1))
273
xlen = xlen + 256*ord(self.fileobj.read(1))
274
self.fileobj.read(xlen)
276
# Read and discard a null-terminated string containing the filename
278
s = self.fileobj.read(1)
279
if not s or s=='\000':
282
# Read and discard a null-terminated string containing a comment
284
s = self.fileobj.read(1)
285
if not s or s=='\000':
288
self.fileobj.read(2) # Read & discard the 16-bit header CRC
290
def readline(self, size=-1):
291
"""Tuned to remove buffer length calls in _unread and...
293
also removes multiple len(c) calls, inlines _unread,
294
total savings - lsprof 5800 to 5300
297
8176 calls to read() in 1684
298
changing the min chunk size to 200 halved all the cache misses
299
leading to a drop to:
301
4168 call to read() in 1646
302
- i.e. just reduced the function call overhead. May be worth
305
if size < 0: size = sys.maxint
307
readsize = min(200, size) # Read from the file in small chunks
310
return "".join(bufs) # Return resulting line
313
c = self.read(readsize)
314
# number of bytes read
318
# We set i=size to break out of the loop under two
319
# conditions: 1) there's no newline, and the chunk is
320
# larger than size, or 2) there is a newline, but the
321
# resulting line would be longer than 'size'.
322
if i==-1 and len_c > size: i=size-1
323
elif size <= i: i = size -1
325
if i >= 0 or c == '':
326
# if i>= 0 we have a newline or have triggered the above
327
# if size is not None condition.
328
# if c == '' its EOF.
329
bufs.append(c[:i+1]) # Add portion of last chunk
330
# -- inlined self._unread --
331
## self._unread(c[i+1:], len_c - i) # Push back rest of chunk
332
self.extrabuf = c[i+1:] + self.extrabuf
333
self.extrasize = len_c - i + self.extrasize
334
self.offset -= len_c - i
335
# -- end inlined self._unread --
336
return ''.join(bufs) # Return resulting line
338
# Append chunk to list, decrease 'size',
341
readsize = min(size, readsize * 2)
343
def readlines(self, sizehint=0):
344
# optimise to avoid all the buffer manipulation
345
# lsprof changed from:
346
# 4168 calls in 5472 with 32000 calls to readline()
349
# Negative numbers result in reading all the lines
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.
356
# content = self.read(sizehint)
357
# return bzrlib.osutils.split_lines(content)
358
content = StringIO(self.read(-1))
359
return content.readlines()
361
def _unread(self, buf, len_buf=None):
362
"""tuned to remove unneeded len calls.
364
because this is such an inner routine in readline, and readline is
365
in many inner loops, this has been inlined into readline().
367
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 -
373
self.extrabuf = buf + self.extrabuf
374
self.extrasize = len_buf + self.extrasize
375
self.offset -= len_buf
377
def write(self, data):
378
if self.mode != gzip.WRITE:
380
raise IOError(errno.EBADF, "write() on read-only GzipFile object")
382
if self.fileobj is None:
383
raise ValueError, "write() on closed GzipFile object"
386
self.size = self.size + data_len
387
self.crc = zlib.crc32(data, self.crc)
388
self.fileobj.write( self.compress.compress(data) )
389
self.offset += data_len
391
def writelines(self, lines):
392
# profiling indicated a significant overhead
393
# calling write for each line.
394
# this batch call is a lot faster :).
395
# (4 seconds to 1 seconds for the sample upgrades I was testing).
396
self.write(''.join(lines))
398
if sys.version_info > (2, 7):
399
# As of Python 2.7 the crc32 must be positive when close is called
401
if self.fileobj is None:
403
if self.mode == gzip.WRITE:
404
self.crc &= 0xFFFFFFFFL
405
gzip.GzipFile.close(self)
added
removed
bzrlib/tuned_gzip.py
