/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to shamap.py

Cache trees rather than inventories.

Show diffs side-by-side

added added

removed removed

Lines of Context:
shamap.py
 
1
# Copyright (C) 2009 Jelmer Vernooij <jelmer@samba.org>
 
2
#
 
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.
 
7
#
 
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.
 
12
#
 
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
 
16
 
 
17
"""Map from Git sha's to Bazaar objects."""
 
18
 
 
19
from dulwich.objects import (
 
20
    sha_to_hex,
 
21
    hex_to_sha,
 
22
    )
 
23
import os
 
24
import threading
 
25
 
 
26
import bzrlib
 
27
from bzrlib import (
 
28
    registry,
 
29
    trace,
 
30
    )
 
31
from bzrlib.transport import (
 
32
    get_transport,
 
33
    )
 
34
 
 
35
 
 
36
def get_cache_dir():
 
37
    try:
 
38
        from xdg.BaseDirectory import xdg_cache_home
 
39
    except ImportError:
 
40
        from bzrlib.config import config_dir
 
41
        ret = os.path.join(config_dir(), "git")
 
42
    else:
 
43
        ret = os.path.join(xdg_cache_home, "bazaar", "git")
 
44
    if not os.path.isdir(ret):
 
45
        os.makedirs(ret)
 
46
    return ret
 
47
 
 
48
 
 
49
def get_remote_cache_transport():
 
50
    return get_transport(get_cache_dir())
 
51
 
 
52
 
 
53
def check_pysqlite_version(sqlite3):
 
54
    """Check that sqlite library is compatible.
 
55
 
 
56
    """
 
57
    if (sqlite3.sqlite_version_info[0] < 3 or
 
58
            (sqlite3.sqlite_version_info[0] == 3 and
 
59
             sqlite3.sqlite_version_info[1] < 3)):
 
60
        trace.warning('Needs at least sqlite 3.3.x')
 
61
        raise bzrlib.errors.BzrError("incompatible sqlite library")
 
62
 
 
63
try:
 
64
    try:
 
65
        import sqlite3
 
66
        check_pysqlite_version(sqlite3)
 
67
    except (ImportError, bzrlib.errors.BzrError), e:
 
68
        from pysqlite2 import dbapi2 as sqlite3
 
69
        check_pysqlite_version(sqlite3)
 
70
except:
 
71
    trace.warning('Needs at least Python2.5 or Python2.4 with the pysqlite2 '
 
72
            'module')
 
73
    raise bzrlib.errors.BzrError("missing sqlite library")
 
74
 
 
75
 
 
76
_mapdbs = threading.local()
 
77
def mapdbs():
 
78
    """Get a cache for this thread's db connections."""
 
79
    try:
 
80
        return _mapdbs.cache
 
81
    except AttributeError:
 
82
        _mapdbs.cache = {}
 
83
        return _mapdbs.cache
 
84
 
 
85
 
 
86
class GitShaMap(object):
 
87
    """Git<->Bzr revision id mapping database."""
 
88
 
 
89
    def lookup_git_sha(self, sha):
 
90
        """Lookup a Git sha in the database.
 
91
        :param sha: Git object sha
 
92
        :return: (type, type_data) with type_data:
 
93
            revision: revid, tree sha
 
94
        """
 
95
        raise NotImplementedError(self.lookup_git_sha)
 
96
 
 
97
    def lookup_blob_id(self, file_id, revision):
 
98
        """Retrieve a Git blob SHA by file id.
 
99
 
 
100
        :param file_id: File id of the file/symlink
 
101
        :param revision: revision in which the file was last changed.
 
102
        """
 
103
        raise NotImplementedError(self.lookup_blob_id)
 
104
 
 
105
    def lookup_tree_id(self, file_id, revision):
 
106
        """Retrieve a Git tree SHA by file id.
 
107
        """
 
108
        raise NotImplementedError(self.lookup_tree_id)
 
109
 
 
110
    def revids(self):
 
111
        """List the revision ids known."""
 
112
        raise NotImplementedError(self.revids)
 
113
 
 
114
    def missing_revisions(self, revids):
 
115
        """Return set of all the revisions that are not present."""
 
116
        present_revids = set(self.revids())
 
117
        if not isinstance(revids, set):
 
118
            revids = set(revids)
 
119
        return revids - present_revids
 
120
 
 
121
    def sha1s(self):
 
122
        """List the SHA1s."""
 
123
        raise NotImplementedError(self.sha1s)
 
124
 
 
125
    def start_write_group(self):
 
126
        """Start writing changes."""
 
127
 
 
128
    def commit_write_group(self):
 
129
        """Commit any pending changes."""
 
130
 
 
131
    def abort_write_group(self):
 
132
        """Abort any pending changes."""
 
133
 
 
134
 
 
135
class ContentCache(object):
 
136
    """Object that can cache Git objects."""
 
137
 
 
138
    def __getitem__(self, sha):
 
139
        """Retrieve an item, by SHA."""
 
140
        raise NotImplementedError(self.__getitem__)
 
141
 
 
142
 
 
143
class BzrGitCacheFormat(object):
 
144
 
 
145
    def get_format_string(self):
 
146
        raise NotImplementedError(self.get_format_string)
 
147
 
 
148
    def open(self, transport):
 
149
        raise NotImplementedError(self.open)
 
150
 
 
151
    def initialize(self, transport):
 
152
        transport.put_bytes('format', self.get_format_string())
 
153
 
 
154
    @classmethod
 
155
    def from_repository(self, repository):
 
156
        repo_transport = getattr(repository, "_transport", None)
 
157
        if repo_transport is not None:
 
158
            try:
 
159
                repo_transport.mkdir('git')
 
160
            except bzrlib.errors.FileExists:
 
161
                pass
 
162
            transport = repo_transport.clone('git')
 
163
        else:
 
164
            transport = get_remote_cache_transport()
 
165
        try:
 
166
            format_name = transport.get_bytes('format')
 
167
            format = formats.get(format_name)
 
168
        except bzrlib.errors.NoSuchFile:
 
169
            format = formats.get('default')
 
170
            format.initialize(transport)
 
171
        return format.open(transport)
 
172
 
 
173
 
 
174
class CacheUpdater(object):
 
175
 
 
176
    def add_object(self, obj, ie):
 
177
        raise NotImplementedError(self.add_object)
 
178
 
 
179
    def finish(self):
 
180
        raise NotImplementedError(self.finish)
 
181
 
 
182
 
 
183
class BzrGitCache(object):
 
184
    """Caching backend."""
 
185
 
 
186
    def __init__(self, idmap, content_cache, cache_updater_klass):
 
187
        self.idmap = idmap
 
188
        self.content_cache = content_cache
 
189
        self._cache_updater_klass = cache_updater_klass
 
190
 
 
191
    def get_updater(self, rev):
 
192
        return self._cache_updater_klass(self, rev)
 
193
 
 
194
 
 
195
DictBzrGitCache = lambda: BzrGitCache(DictGitShaMap(), None, DictCacheUpdater)
 
196
 
 
197
 
 
198
class DictCacheUpdater(CacheUpdater):
 
199
 
 
200
    def __init__(self, cache, rev):
 
201
        self.cache = cache
 
202
        self.revid = rev.revision_id
 
203
        self.parent_revids = rev.parent_ids
 
204
        self._commit = None
 
205
        self._entries = []
 
206
 
 
207
    def add_object(self, obj, ie):
 
208
        if obj.type_name == "commit":
 
209
            self._commit = obj
 
210
            assert ie is None
 
211
            type_data = (self.revid, self._commit.tree)
 
212
        elif obj.type_name in ("blob", "tree"):
 
213
            if obj.type_name == "blob":
 
214
                revision = ie.revision
 
215
            else:
 
216
                revision = self.revid
 
217
            type_data = (ie.file_id, revision)
 
218
            self.cache.idmap._by_fileid.setdefault(type_data[1], {})[type_data[0]] = obj.id
 
219
        else:
 
220
            raise AssertionError
 
221
        self.cache.idmap._by_sha[obj.id] = (obj.type_name, type_data)
 
222
 
 
223
    def finish(self):
 
224
        if self._commit is None:
 
225
            raise AssertionError("No commit object added")
 
226
        return self._commit
 
227
 
 
228
 
 
229
class DictGitShaMap(GitShaMap):
 
230
 
 
231
    def __init__(self):
 
232
        self._by_sha = {}
 
233
        self._by_fileid = {}
 
234
 
 
235
    def lookup_blob_id(self, fileid, revision):
 
236
        return self._by_fileid[revision][fileid]
 
237
 
 
238
    def lookup_git_sha(self, sha):
 
239
        return self._by_sha[sha]
 
240
 
 
241
    def lookup_tree_id(self, fileid, revision):
 
242
        return self._base._by_fileid[revision][fileid]
 
243
 
 
244
    def revids(self):
 
245
        for key, (type, type_data) in self._by_sha.iteritems():
 
246
            if type == "commit":
 
247
                yield type_data[0]
 
248
 
 
249
    def sha1s(self):
 
250
        return self._by_sha.iterkeys()
 
251
 
 
252
 
 
253
class SqliteCacheUpdater(CacheUpdater):
 
254
 
 
255
    def __init__(self, cache, rev):
 
256
        self.cache = cache
 
257
        self.db = self.cache.idmap.db
 
258
        self.revid = rev.revision_id
 
259
        self._commit = None
 
260
        self._trees = []
 
261
        self._blobs = []
 
262
 
 
263
    def add_object(self, obj, ie):
 
264
        if obj.type_name == "commit":
 
265
            self._commit = obj
 
266
            assert ie is None
 
267
        elif obj.type_name == "tree":
 
268
            self._trees.append((obj.id, ie.file_id, self.revid))
 
269
        elif obj.type_name == "blob":
 
270
            self._blobs.append((obj.id, ie.file_id, ie.revision))
 
271
        else:
 
272
            raise AssertionError
 
273
 
 
274
    def finish(self):
 
275
        if self._commit is None:
 
276
            raise AssertionError("No commit object added")
 
277
        self.db.executemany(
 
278
            "replace into trees (sha1, fileid, revid) values (?, ?, ?)",
 
279
            self._trees)
 
280
        self.db.executemany(
 
281
            "replace into blobs (sha1, fileid, revid) values (?, ?, ?)",
 
282
            self._blobs)
 
283
        self.db.execute(
 
284
            "replace into commits (sha1, revid, tree_sha) values (?, ?, ?)",
 
285
            (self._commit.id, self.revid, self._commit.tree))
 
286
        return self._commit
 
287
 
 
288
 
 
289
SqliteBzrGitCache = lambda p: BzrGitCache(SqliteGitShaMap(p), None, SqliteCacheUpdater)
 
290
 
 
291
 
 
292
class SqliteGitCacheFormat(BzrGitCacheFormat):
 
293
 
 
294
    def get_format_string(self):
 
295
        return 'bzr-git sha map version 1 using sqlite\n'
 
296
 
 
297
    def open(self, transport):
 
298
        try:
 
299
            basepath = transport.local_abspath(".")
 
300
        except bzrlib.errors.NotLocalUrl:
 
301
            basepath = get_cache_dir()
 
302
        return SqliteBzrGitCache(os.path.join(basepath, "idmap.db"))
 
303
 
 
304
 
 
305
class SqliteGitShaMap(GitShaMap):
 
306
 
 
307
    def __init__(self, path=None):
 
308
        self.path = path
 
309
        if path is None:
 
310
            self.db = sqlite3.connect(":memory:")
 
311
        else:
 
312
            if not mapdbs().has_key(path):
 
313
                mapdbs()[path] = sqlite3.connect(path)
 
314
            self.db = mapdbs()[path]
 
315
        self.db.text_factory = str
 
316
        self.db.executescript("""
 
317
        create table if not exists commits(
 
318
            sha1 text not null check(length(sha1) == 40),
 
319
            revid text not null,
 
320
            tree_sha text not null check(length(tree_sha) == 40)
 
321
        );
 
322
        create index if not exists commit_sha1 on commits(sha1);
 
323
        create unique index if not exists commit_revid on commits(revid);
 
324
        create table if not exists blobs(
 
325
            sha1 text not null check(length(sha1) == 40),
 
326
            fileid text not null,
 
327
            revid text not null
 
328
        );
 
329
        create index if not exists blobs_sha1 on blobs(sha1);
 
330
        create unique index if not exists blobs_fileid_revid on blobs(fileid, revid);
 
331
        create table if not exists trees(
 
332
            sha1 text unique not null check(length(sha1) == 40),
 
333
            fileid text not null,
 
334
            revid text not null
 
335
        );
 
336
        create unique index if not exists trees_sha1 on trees(sha1);
 
337
        create unique index if not exists trees_fileid_revid on trees(fileid, revid);
 
338
""")
 
339
 
 
340
    def __repr__(self):
 
341
        return "%s(%r)" % (self.__class__.__name__, self.path)
 
342
    
 
343
    def lookup_commit(self, revid):
 
344
        row = self.db.execute("select sha1 from commits where revid = ?", (revid,)).fetchone()
 
345
        if row is not None:
 
346
            return row[0]
 
347
        raise KeyError
 
348
 
 
349
    def commit_write_group(self):
 
350
        self.db.commit()
 
351
 
 
352
    def lookup_blob_id(self, fileid, revision):
 
353
        row = self.db.execute("select sha1 from blobs where fileid = ? and revid = ?", (fileid, revision)).fetchone()
 
354
        if row is not None:
 
355
            return row[0]
 
356
        raise KeyError(fileid)
 
357
 
 
358
    def lookup_tree_id(self, fileid, revision):
 
359
        row = self.db.execute("select sha1 from trees where fileid = ? and revid = ?", (fileid, self.revid)).fetchone()
 
360
        if row is not None:
 
361
            return row[0]
 
362
        raise KeyError(fileid)
 
363
 
 
364
    def lookup_git_sha(self, sha):
 
365
        """Lookup a Git sha in the database.
 
366
 
 
367
        :param sha: Git object sha
 
368
        :return: (type, type_data) with type_data:
 
369
            revision: revid, tree sha
 
370
        """
 
371
        row = self.db.execute("select revid, tree_sha from commits where sha1 = ?", (sha,)).fetchone()
 
372
        if row is not None:
 
373
            return ("commit", row)
 
374
        row = self.db.execute("select fileid, revid from blobs where sha1 = ?", (sha,)).fetchone()
 
375
        if row is not None:
 
376
            return ("blob", row)
 
377
        row = self.db.execute("select fileid, revid from trees where sha1 = ?", (sha,)).fetchone()
 
378
        if row is not None:
 
379
            return ("tree", row)
 
380
        raise KeyError(sha)
 
381
 
 
382
    def revids(self):
 
383
        """List the revision ids known."""
 
384
        return (row for (row,) in self.db.execute("select revid from commits"))
 
385
 
 
386
    def sha1s(self):
 
387
        """List the SHA1s."""
 
388
        for table in ("blobs", "commits", "trees"):
 
389
            for (sha,) in self.db.execute("select sha1 from %s" % table):
 
390
                yield sha
 
391
 
 
392
 
 
393
class TdbCacheUpdater(CacheUpdater):
 
394
 
 
395
    def __init__(self, cache, rev):
 
396
        self.cache = cache
 
397
        self.db = cache.idmap.db
 
398
        self.revid = rev.revision_id
 
399
        self.parent_revids = rev.parent_ids
 
400
        self._commit = None
 
401
        self._entries = []
 
402
 
 
403
    def add_object(self, obj, ie):
 
404
        sha = obj.sha().digest()
 
405
        if obj.type_name == "commit":
 
406
            self.db["commit\0" + self.revid] = "\0".join((obj.id, obj.tree))
 
407
            type_data = (self.revid, obj.tree)
 
408
            self._commit = obj
 
409
            assert ie is None
 
410
        elif obj.type_name == "blob":
 
411
            self.db["\0".join(("blob", ie.file_id, ie.revision))] = sha
 
412
            type_data = (ie.file_id, ie.revision)
 
413
        elif obj.type_name == "tree":
 
414
            type_data = (ie.file_id, self.revid)
 
415
        else:
 
416
            raise AssertionError
 
417
        self.db["git\0" + sha] = "\0".join((obj.type_name,
 
418
            type_data[0], type_data[1]))
 
419
 
 
420
    def finish(self):
 
421
        if self._commit is None:
 
422
            raise AssertionError("No commit object added")
 
423
        return self._commit
 
424
 
 
425
 
 
426
TdbBzrGitCache = lambda p: BzrGitCache(TdbGitShaMap(p), None, TdbCacheUpdater)
 
427
 
 
428
class TdbGitCacheFormat(BzrGitCacheFormat):
 
429
 
 
430
    def get_format_string(self):
 
431
        return 'bzr-git sha map version 3 using tdb\n'
 
432
 
 
433
    def open(self, transport):
 
434
        try:
 
435
            basepath = transport.local_abspath(".")
 
436
        except bzrlib.errors.NotLocalUrl:
 
437
            basepath = get_cache_dir()
 
438
        try:
 
439
            return TdbBzrGitCache(os.path.join(basepath, "idmap.tdb"))
 
440
        except ImportError:
 
441
            raise ImportError(
 
442
                "Unable to open existing bzr-git cache because 'tdb' is not "
 
443
                "installed.")
 
444
 
 
445
 
 
446
class TdbGitShaMap(GitShaMap):
 
447
    """SHA Map that uses a TDB database.
 
448
 
 
449
    Entries:
 
450
 
 
451
    "git <sha1>" -> "<type> <type-data1> <type-data2>"
 
452
    "commit revid" -> "<sha1> <tree-id>"
 
453
    "tree fileid revid" -> "<sha1>"
 
454
    "blob fileid revid" -> "<sha1>"
 
455
    """
 
456
 
 
457
    TDB_MAP_VERSION = 3
 
458
    TDB_HASH_SIZE = 50000
 
459
 
 
460
    def __init__(self, path=None):
 
461
        import tdb
 
462
        self.path = path
 
463
        if path is None:
 
464
            self.db = {}
 
465
        else:
 
466
            if not mapdbs().has_key(path):
 
467
                mapdbs()[path] = tdb.Tdb(path, self.TDB_HASH_SIZE, tdb.DEFAULT,
 
468
                                          os.O_RDWR|os.O_CREAT)
 
469
            self.db = mapdbs()[path]
 
470
        try:
 
471
            if int(self.db["version"]) not in (2, 3):
 
472
                trace.warning("SHA Map is incompatible (%s -> %d), rebuilding database.",
 
473
                              self.db["version"], self.TDB_MAP_VERSION)
 
474
                self.db.clear()
 
475
        except KeyError:
 
476
            pass
 
477
        self.db["version"] = str(self.TDB_MAP_VERSION)
 
478
 
 
479
    def start_write_group(self):
 
480
        """Start writing changes."""
 
481
        self.db.transaction_start()
 
482
 
 
483
    def commit_write_group(self):
 
484
        """Commit any pending changes."""
 
485
        self.db.transaction_commit()
 
486
 
 
487
    def abort_write_group(self):
 
488
        """Abort any pending changes."""
 
489
        self.db.transaction_cancel()
 
490
 
 
491
    def __repr__(self):
 
492
        return "%s(%r)" % (self.__class__.__name__, self.path)
 
493
 
 
494
    def lookup_commit(self, revid):
 
495
        return sha_to_hex(self.db["commit\0" + revid][:20])
 
496
 
 
497
    def lookup_blob_id(self, fileid, revision):
 
498
        return sha_to_hex(self.db["\0".join(("blob", fileid, revision))])
 
499
                
 
500
    def lookup_git_sha(self, sha):
 
501
        """Lookup a Git sha in the database.
 
502
 
 
503
        :param sha: Git object sha
 
504
        :return: (type, type_data) with type_data:
 
505
            revision: revid, tree sha
 
506
        """
 
507
        if len(sha) == 40:
 
508
            sha = hex_to_sha(sha)
 
509
        data = self.db["git\0" + sha].split("\0")
 
510
        return (data[0], (data[1], data[2]))
 
511
 
 
512
    def missing_revisions(self, revids):
 
513
        ret = set()
 
514
        for revid in revids:
 
515
            if self.db.get("commit\0" + revid) is None:
 
516
                ret.add(revid)
 
517
        return ret
 
518
 
 
519
    def revids(self):
 
520
        """List the revision ids known."""
 
521
        for key in self.db.iterkeys():
 
522
            if key.startswith("commit\0"):
 
523
                yield key[7:]
 
524
 
 
525
    def sha1s(self):
 
526
        """List the SHA1s."""
 
527
        for key in self.db.iterkeys():
 
528
            if key.startswith("git\0"):
 
529
                yield sha_to_hex(key[4:])
 
530
 
 
531
 
 
532
formats = registry.Registry()
 
533
formats.register(TdbGitCacheFormat().get_format_string(),
 
534
    TdbGitCacheFormat())
 
535
formats.register(SqliteGitCacheFormat().get_format_string(),
 
536
    SqliteGitCacheFormat())
 
537
try:
 
538
    import tdb
 
539
except ImportError:
 
540
    formats.register('default', SqliteGitCacheFormat())
 
541
else:
 
542
    formats.register('default', TdbGitCacheFormat())
 
543
 
 
544
 
 
545
def migrate_ancient_formats(repo_transport):
 
546
    if repo_transport.has("git.tdb"):
 
547
        TdbGitCacheFormat().initialize(repo_transport.clone("git"))
 
548
        repo_transport.rename("git.tdb", "git/idmap.tdb")
 
549
    elif repo_transport.has("git.db"):
 
550
        SqliteGitCacheFormat().initialize(repo_transport.clone("git"))
 
551
        repo_transport.rename("git.db", "git/idmap.db")
 
552
 
 
553
 
 
554
def from_repository(repository):
 
555
    repo_transport = getattr(repository, "_transport", None)
 
556
    if repo_transport is not None:
 
557
        # Migrate older cache formats
 
558
        try:
 
559
            repo_transport.mkdir("git")
 
560
        except bzrlib.errors.FileExists:
 
561
            pass
 
562
        else:
 
563
            migrate_ancient_formats(repo_transport)
 
564
    return BzrGitCacheFormat.from_repository(repository)