1
# Copyright (C) 2008 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
"""Pyrex extensions to btree node parsing."""
20
cdef extern from "stdlib.h":
21
ctypedef unsigned size_t
23
cdef extern from "Python.h":
24
ctypedef int Py_ssize_t # Required for older pyrex versions
25
ctypedef struct PyObject:
27
int PyList_Append(object lst, object item) except -1
29
char *PyString_AsString(object p) except NULL
30
object PyString_FromStringAndSize(char *, Py_ssize_t)
31
int PyString_CheckExact(object s)
32
int PyString_CheckExact_ptr "PyString_CheckExact" (PyObject *)
33
Py_ssize_t PyString_Size(object p)
34
Py_ssize_t PyString_GET_SIZE_ptr "PyString_GET_SIZE" (PyObject *)
35
char * PyString_AS_STRING_ptr "PyString_AS_STRING" (PyObject *)
36
int PyString_AsStringAndSize_ptr(PyObject *, char **buf, Py_ssize_t *len)
37
int PyTuple_CheckExact(object t)
38
Py_ssize_t PyTuple_GET_SIZE(object t)
39
PyObject *PyTuple_GET_ITEM_ptr_object "PyTuple_GET_ITEM" (object tpl, int index)
41
cdef extern from "string.h":
42
void *memcpy(void *dest, void *src, size_t n)
43
void *memchr(void *s, int c, size_t n)
45
# void *memrchr(void *s, int c, size_t n)
46
int strncmp(char *s1, char *s2, size_t n)
49
# TODO: Find some way to import this from _dirstate_helpers
50
cdef void* _my_memrchr(void *s, int c, size_t n):
51
# memrchr seems to be a GNU extension, so we have to implement it ourselves
52
# It is not present in any win32 standard library
64
# TODO: Import this from _dirstate_helpers when it is merged
65
cdef object safe_string_from_size(char *s, Py_ssize_t size):
68
'tried to create a string with an invalid size: %d @0x%x'
70
return PyString_FromStringAndSize(s, size)
73
cdef class BTreeLeafParser:
74
"""Parse the leaf nodes of a BTree index.
76
:ivar bytes: The PyString object containing the uncompressed text for the
78
:ivar key_length: An integer describing how many pieces the keys have for
80
:ivar ref_list_length: An integer describing how many references this index
82
:ivar keys: A PyList of keys found in this node.
84
:ivar _cur_str: A pointer to the start of the next line to parse
85
:ivar _end_str: A pointer to the end of bytes
86
:ivar _start: Pointer to the location within the current line while
88
:ivar _header_found: True when we have parsed the header for this node
93
cdef int ref_list_length
98
# The current start point for parsing
101
cdef int _header_found
103
def __init__(self, bytes, key_length, ref_list_length):
105
self.key_length = key_length
106
self.ref_list_length = ref_list_length
110
self._header_found = 0
112
cdef extract_key(self, char * last):
115
:param last: points at the byte after the last byte permitted for the
119
cdef int loop_counter
123
while loop_counter < self.key_length:
124
loop_counter = loop_counter + 1
126
temp_ptr = <char*>memchr(self._start, c'\0', last - self._start)
128
if loop_counter == self.key_length:
133
failure_string = ("invalid key, wanted segment from " +
134
repr(safe_string_from_size(self._start,
135
last - self._start)))
136
raise AssertionError(failure_string)
137
# capture the key string
138
# TODO: Consider using PyIntern_FromString, the only caveat is that
139
# it assumes a NULL-terminated string, so we have to check if
140
# temp_ptr[0] == c'\0' or some other char.
141
key_element = safe_string_from_size(self._start,
142
temp_ptr - self._start)
143
# advance our pointer
144
self._start = temp_ptr + 1
145
PyList_Append(key_segments, key_element)
146
return tuple(key_segments)
148
cdef int process_line(self) except -1:
149
"""Process a line in the bytes."""
153
cdef char *next_start
154
cdef int loop_counter
156
self._start = self._cur_str
157
# Find the next newline
158
last = <char*>memchr(self._start, c'\n', self._end_str - self._start)
160
# Process until the end of the file
162
self._cur_str = self._end_str
164
# And the next string is right after it
165
self._cur_str = last + 1
166
# The last character is right before the '\n'
169
if last == self._start:
172
if last < self._start:
173
# Unexpected error condition - fail
175
if 0 == self._header_found:
176
# The first line in a leaf node is the header "type=leaf\n"
177
if strncmp("type=leaf", self._start, last - self._start) == 0:
178
self._header_found = 1
181
raise AssertionError('Node did not start with "type=leaf": %r'
182
% (safe_string_from_size(self._start, last - self._start)))
185
key = self.extract_key(last)
186
# find the value area
187
temp_ptr = <char*>_my_memrchr(self._start, c'\0', last - self._start)
192
# capture the value string
193
value = safe_string_from_size(temp_ptr + 1, last - temp_ptr - 1)
194
# shrink the references end point
196
if self.ref_list_length:
199
while loop_counter < self.ref_list_length:
201
# extract a reference list
202
loop_counter = loop_counter + 1
203
if last < self._start:
205
# find the next reference list end point:
206
temp_ptr = <char*>memchr(self._start, c'\t', last - self._start)
208
# Only valid for the last list
209
if loop_counter != self.ref_list_length:
212
raise AssertionError("invalid key")
214
# scan to the end of the ref list area
218
# scan to the end of this ref list
220
next_start = temp_ptr + 1
221
# Now, there may be multiple keys in the ref list.
222
while self._start < ref_ptr:
223
# loop finding keys and extracting them
224
temp_ptr = <char*>memchr(self._start, c'\r',
225
ref_ptr - self._start)
227
# key runs to the end
229
PyList_Append(ref_list, self.extract_key(temp_ptr))
230
PyList_Append(ref_lists, tuple(ref_list))
231
# prepare for the next reference list
232
self._start = next_start
233
ref_lists = tuple(ref_lists)
234
node_value = (value, ref_lists)
236
if last != self._start:
237
# unexpected reference data present
239
node_value = (value, ())
240
PyList_Append(self.keys, (key, node_value))
244
cdef Py_ssize_t byte_count
245
if not PyString_CheckExact(self.bytes):
246
raise AssertionError('self.bytes is not a string.')
247
byte_count = PyString_Size(self.bytes)
248
self._cur_str = PyString_AsString(self.bytes)
249
# This points to the last character in the string
250
self._end_str = self._cur_str + byte_count
251
while self._cur_str < self._end_str:
256
def _parse_leaf_lines(bytes, key_length, ref_list_length):
257
parser = BTreeLeafParser(bytes, key_length, ref_list_length)
258
return parser.parse()
261
def _flatten_node(node, reference_lists):
262
"""Convert a node into the serialized form.
264
:param node: A tuple representing a node:
265
(index, key_tuple, value, references)
266
:param reference_lists: Does this index have reference lists?
267
:return: (string_key, flattened)
268
string_key The serialized key for referencing this node
269
flattened A string with the serialized form for the contents
271
cdef int have_reference_lists
272
cdef Py_ssize_t flat_len
273
cdef Py_ssize_t key_len
274
cdef Py_ssize_t node_len
277
cdef Py_ssize_t value_len
279
cdef Py_ssize_t refs_len
280
cdef Py_ssize_t next_len
281
cdef int first_ref_list
282
cdef int first_reference
284
cdef PyObject *ref_bit
285
cdef Py_ssize_t ref_bit_len
287
if not PyTuple_CheckExact(node):
288
raise TypeError('We expected a tuple() for node not: %s'
290
node_len = PyTuple_GET_SIZE(node)
291
have_reference_lists = reference_lists
292
if have_reference_lists:
294
raise ValueError('With ref_lists, we expected 4 entries not: %s'
297
raise ValueError('Without ref_lists, we need at least 3 entries not: %s'
299
# I don't expect that we can do faster than string.join()
300
string_key = '\0'.join(<object>PyTuple_GET_ITEM_ptr_object(node, 1))
302
# TODO: instead of using string joins, precompute the final string length,
303
# and then malloc a single string and copy everything in.
305
# TODO: We probably want to use PySequenceFast, because we have lists and
306
# tuples, but we aren't sure which we will get.
308
# line := string_key NULL flat_refs NULL value LF
309
# string_key := BYTES (NULL BYTES)*
310
# flat_refs := ref_list (TAB ref_list)*
311
# ref_list := ref (CR ref)*
312
# ref := BYTES (NULL BYTES)*
315
if have_reference_lists:
316
# Figure out how many bytes it will take to store the references
317
ref_lists = <object>PyTuple_GET_ITEM_ptr_object(node, 3)
318
next_len = len(ref_lists) # TODO: use a Py function
320
# If there are no nodes, we don't need to do any work
321
# Otherwise we will need (len - 1) '\t' characters to separate
322
# the reference lists
323
refs_len = refs_len + (next_len - 1)
324
for ref_list in ref_lists:
325
next_len = len(ref_list)
327
# We will need (len - 1) '\r' characters to separate the
329
refs_len = refs_len + (next_len - 1)
330
for reference in ref_list:
331
if not PyTuple_CheckExact(reference):
333
'We expect references to be tuples not: %s'
335
next_len = PyTuple_GET_SIZE(reference)
337
# We will need (len - 1) '\x00' characters to
338
# separate the reference key
339
refs_len = refs_len + (next_len - 1)
340
for i from 0 <= i < next_len:
341
ref_bit = PyTuple_GET_ITEM_ptr_object(reference, i)
342
if not PyString_CheckExact_ptr(ref_bit):
343
raise TypeError('We expect reference bits'
344
' to be strings not: %s'
345
% type(<object>ref_bit))
346
refs_len = refs_len + PyString_GET_SIZE_ptr(ref_bit)
348
# So we have the (key NULL refs NULL value LF)
349
key_len = PyString_Size(string_key)
350
val = PyTuple_GET_ITEM_ptr_object(node, 2)
351
if not PyString_CheckExact_ptr(val):
352
raise TypeError('Expected a plain str for value not: %s'
354
value = PyString_AS_STRING_ptr(val)
355
value_len = PyString_GET_SIZE_ptr(val)
356
flat_len = (key_len + 1 + refs_len + 1 + value_len + 1)
357
line = PyString_FromStringAndSize(NULL, flat_len)
358
# Get a pointer to the new buffer
359
out = PyString_AsString(line)
360
memcpy(out, PyString_AsString(string_key), key_len)
366
for ref_list in ref_lists:
367
if first_ref_list == 0:
372
for reference in ref_list:
373
if first_reference == 0:
377
next_len = PyTuple_GET_SIZE(reference)
378
for i from 0 <= i < next_len:
382
ref_bit = PyTuple_GET_ITEM_ptr_object(reference, i)
383
ref_bit_len = PyString_GET_SIZE_ptr(ref_bit)
384
memcpy(out, PyString_AS_STRING_ptr(ref_bit), ref_bit_len)
385
out = out + ref_bit_len
388
memcpy(out, value, value_len)
389
out = out + value_len
391
return string_key, line
added
removed
bzrlib/_btree_serializer_c.pyx
