← 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: 2008-04-07 07:52:50 UTC
  • mfrom: (3340.1.1 208418-1.4)
  • Revision ID: pqm@pqm.ubuntu.com-20080407075250-phs53xnslo8boaeo
Return the correct knit serialisation method in _StreamAccess.
        (Andrew Bennetts, Martin Pool, Robert Collins)

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., 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
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
 
132
99
        """A tuned version of gzip._write_gzip_header
133
100
 
134
101
        We have some extra constrains that plain Gzip does not.
135
 
        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 
136
103
           calls to fileobj.write().
137
104
        2) We never have a filename
138
105
        3) We don't care about the time
154
121
 
155
122
    def _read(self, size=1024):
156
123
        # various optimisations:
157
 
        # reduces lsprof count from 2500 to
 
124
        # reduces lsprof count from 2500 to 
158
125
        # 8337 calls in 1272, 365 internal
159
126
        if self.fileobj is None:
160
127
            raise EOFError, "Reached EOF"
182
149
 
183
150
        if buf == "":
184
151
            self._add_read_data(self.decompress.flush())
185
 
            if len(self.decompress.unused_data) < 8:
186
 
                raise AssertionError("what does flush do?")
 
152
            assert len(self.decompress.unused_data) >= 8, "what does flush do?"
187
153
            self._gzip_tail = self.decompress.unused_data[0:8]
188
154
            self._read_eof()
189
155
            # tell the driving read() call we have stuffed all the data
209
175
                self._gzip_tail = self.decompress.unused_data[0:8]
210
176
            elif seek_length < 0:
211
177
                # we haven't read enough to check the checksum.
212
 
                if not (-8 < seek_length):
213
 
                    raise AssertionError("too great a seek")
 
178
                assert -8 < seek_length, "too great a seek."
214
179
                buf = self.fileobj.read(-seek_length)
215
180
                self._gzip_tail = self.decompress.unused_data + buf
216
181
            else:
225
190
        """tuned to reduce function calls and eliminate file seeking:
226
191
        pass 1:
227
192
        reduces lsprof count from 800 to 288
228
 
        4168 in 296
 
193
        4168 in 296 
229
194
        avoid U32 call by using struct format L
230
195
        4168 in 200
231
196
        """
232
 
        # We've read to the end of the file, so we should have 8 bytes of
 
197
        # We've read to the end of the file, so we should have 8 bytes of 
233
198
        # unused data in the decompressor. If we don't, there is a corrupt file.
234
199
        # We use these 8 bytes to calculate the CRC and the recorded file size.
235
200
        # We then check the that the computed CRC and size of the
236
201
        # uncompressed data matches the stored values.  Note that the size
237
202
        # 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.")
 
203
        assert len(self._gzip_tail) == 8, "gzip trailer is incorrect length."
240
204
        crc32, isize = struct.unpack("<LL", self._gzip_tail)
241
205
        # note that isize is unsigned - it can exceed 2GB
242
206
        if crc32 != U32(self.crc):
246
210
 
247
211
    def _read_gzip_header(self, bytes=None):
248
212
        """Supply bytes if the minimum header size is already read.
249
 
 
 
213
        
250
214
        :param bytes: 10 bytes of header data.
251
215
        """
252
216
        """starting cost: 300 in 3998
289
253
 
290
254
    def readline(self, size=-1):
291
255
        """Tuned to remove buffer length calls in _unread and...
292
 
 
 
256
        
293
257
        also removes multiple len(c) calls, inlines _unread,
294
258
        total savings - lsprof 5800 to 5300
295
259
        phase 2:
299
263
        leading to a drop to:
300
264
        4168 calls in 1977
301
265
        4168 call to read() in 1646
302
 
        - i.e. just reduced the function call overhead. May be worth
 
266
        - i.e. just reduced the function call overhead. May be worth 
303
267
          keeping.
304
268
        """
305
269
        if size < 0: size = sys.maxint
347
311
        # to :
348
312
        # 4168 calls in 417.
349
313
        # Negative numbers result in reading all the lines
350
 
 
 
314
        
351
315
        # python's gzip routine uses sizehint. This is a more efficient way
352
316
        # than python uses to honor it. But it is even more efficient to
353
317
        # just read the entire thing and use cStringIO to split into lines.
360
324
 
361
325
    def _unread(self, buf, len_buf=None):
362
326
        """tuned to remove unneeded len calls.
363
 
 
 
327
        
364
328
        because this is such an inner routine in readline, and readline is
365
329
        in many inner loops, this has been inlined into readline().
366
330
 
367
331
        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 -
 
332
        the lsprof ms count for this routine on my test data from 800 to 200 - 
369
333
        a 75% saving.
370
334
        """
371
335
        if len_buf is None:
389
353
            self.offset += data_len
390
354
 
391
355
    def writelines(self, lines):
392
 
        # profiling indicated a significant overhead
 
356
        # profiling indicated a significant overhead 
393
357
        # calling write for each line.
394
358
        # this batch call is a lot faster :).
395
359
        # (4 seconds to 1 seconds for the sample upgrades I was testing).