← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tuned_gzip.py

  • Committer: Danny van Heumen
  • Date: 2010-03-09 21:42:11 UTC
  • mto: (4634.139.5 2.0)
  • mto: This revision was merged to the branch mainline in revision 5160.
  • Revision ID: danny@dannyvanheumen.nl-20100309214211-iqh42x6qcikgd9p3
Reverted now-useless TODO list.

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
29
29
# we want a \n preserved, break on \n only splitlines.
30
30
import bzrlib
31
31
 
32
 
__all__ = ["GzipFile"]
 
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)
33
96
 
34
97
 
35
98
class GzipFile(gzip.GzipFile):
69
132
        """A tuned version of gzip._write_gzip_header
70
133
 
71
134
        We have some extra constrains that plain Gzip does not.
72
 
        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
73
136
           calls to fileobj.write().
74
137
        2) We never have a filename
75
138
        3) We don't care about the time
91
154
 
92
155
    def _read(self, size=1024):
93
156
        # various optimisations:
94
 
        # reduces lsprof count from 2500 to 
 
157
        # reduces lsprof count from 2500 to
95
158
        # 8337 calls in 1272, 365 internal
96
159
        if self.fileobj is None:
97
160
            raise EOFError, "Reached EOF"
119
182
 
120
183
        if buf == "":
121
184
            self._add_read_data(self.decompress.flush())
122
 
            assert len(self.decompress.unused_data) >= 8, "what does flush do?"
 
185
            if len(self.decompress.unused_data) < 8:
 
186
                raise AssertionError("what does flush do?")
123
187
            self._gzip_tail = self.decompress.unused_data[0:8]
124
188
            self._read_eof()
125
189
            # tell the driving read() call we have stuffed all the data
145
209
                self._gzip_tail = self.decompress.unused_data[0:8]
146
210
            elif seek_length < 0:
147
211
                # we haven't read enough to check the checksum.
148
 
                assert -8 < seek_length, "too great a seek."
 
212
                if not (-8 < seek_length):
 
213
                    raise AssertionError("too great a seek")
149
214
                buf = self.fileobj.read(-seek_length)
150
215
                self._gzip_tail = self.decompress.unused_data + buf
151
216
            else:
160
225
        """tuned to reduce function calls and eliminate file seeking:
161
226
        pass 1:
162
227
        reduces lsprof count from 800 to 288
163
 
        4168 in 296 
 
228
        4168 in 296
164
229
        avoid U32 call by using struct format L
165
230
        4168 in 200
166
231
        """
167
 
        # 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
168
233
        # unused data in the decompressor. If we don't, there is a corrupt file.
169
234
        # We use these 8 bytes to calculate the CRC and the recorded file size.
170
235
        # We then check the that the computed CRC and size of the
171
236
        # uncompressed data matches the stored values.  Note that the size
172
237
        # stored is the true file size mod 2**32.
173
 
        assert len(self._gzip_tail) == 8, "gzip trailer is incorrect length."
 
238
        if not (len(self._gzip_tail) == 8):
 
239
            raise AssertionError("gzip trailer is incorrect length.")
174
240
        crc32, isize = struct.unpack("<LL", self._gzip_tail)
175
241
        # note that isize is unsigned - it can exceed 2GB
176
242
        if crc32 != U32(self.crc):
180
246
 
181
247
    def _read_gzip_header(self, bytes=None):
182
248
        """Supply bytes if the minimum header size is already read.
183
 
        
 
249
 
184
250
        :param bytes: 10 bytes of header data.
185
251
        """
186
252
        """starting cost: 300 in 3998
223
289
 
224
290
    def readline(self, size=-1):
225
291
        """Tuned to remove buffer length calls in _unread and...
226
 
        
 
292
 
227
293
        also removes multiple len(c) calls, inlines _unread,
228
294
        total savings - lsprof 5800 to 5300
229
295
        phase 2:
233
299
        leading to a drop to:
234
300
        4168 calls in 1977
235
301
        4168 call to read() in 1646
236
 
        - i.e. just reduced the function call overhead. May be worth 
 
302
        - i.e. just reduced the function call overhead. May be worth
237
303
          keeping.
238
304
        """
239
305
        if size < 0: size = sys.maxint
281
347
        # to :
282
348
        # 4168 calls in 417.
283
349
        # Negative numbers result in reading all the lines
284
 
        
 
350
 
285
351
        # python's gzip routine uses sizehint. This is a more efficient way
286
352
        # than python uses to honor it. But it is even more efficient to
287
353
        # just read the entire thing and use cStringIO to split into lines.
294
360
 
295
361
    def _unread(self, buf, len_buf=None):
296
362
        """tuned to remove unneeded len calls.
297
 
        
 
363
 
298
364
        because this is such an inner routine in readline, and readline is
299
365
        in many inner loops, this has been inlined into readline().
300
366
 
301
367
        The len_buf parameter combined with the reduction in len calls dropped
302
 
        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 -
303
369
        a 75% saving.
304
370
        """
305
371
        if len_buf is None:
323
389
            self.offset += data_len
324
390
 
325
391
    def writelines(self, lines):
326
 
        # profiling indicated a significant overhead 
 
392
        # profiling indicated a significant overhead
327
393
        # calling write for each line.
328
394
        # this batch call is a lot faster :).
329
395
        # (4 seconds to 1 seconds for the sample upgrades I was testing).