1 /*
2 * Copyright (C) 2012, Google Inc.
3 * and other copyright owners as documented in the project's IP log.
4 *
5 * This program and the accompanying materials are made available
6 * under the terms of the Eclipse Distribution License v1.0 which
7 * accompanies this distribution, is reproduced below, and is
8 * available at http://www.eclipse.org/org/documents/edl-v10.php
9 *
10 * All rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or
13 * without modification, are permitted provided that the following
14 * conditions are met:
15 *
16 * - Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 *
19 * - Redistributions in binary form must reproduce the above
20 * copyright notice, this list of conditions and the following
21 * disclaimer in the documentation and/or other materials provided
22 * with the distribution.
23 *
24 * - Neither the name of the Eclipse Foundation, Inc. nor the
25 * names of its contributors may be used to endorse or promote
26 * products derived from this software without specific prior
27 * written permission.
28 *
29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
30 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
31 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
34 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
36 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
37 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
38 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 */
43
44 package org.eclipse.jgit.internal.storage.file;
45
46 import org.eclipse.jgit.lib.AnyObjectId;
47 import org.eclipse.jgit.lib.ObjectIdOwnerMap;
48
49 import com.googlecode.javaewah.EWAHCompressedBitmap;
50
51 /**
52 * Base implementation of the PackBitmapIndex.
53 */
54 abstract class BasePackBitmapIndex extends PackBitmapIndex {
55 private final ObjectIdOwnerMap<StoredBitmap> bitmaps;
56
57 BasePackBitmapIndex(ObjectIdOwnerMap<StoredBitmap> bitmaps) {
58 this.bitmaps = bitmaps;
59 }
60
61 /** {@inheritDoc} */
62 @Override
63 public EWAHCompressedBitmap getBitmap(AnyObjectId objectId) {
64 StoredBitmap sb = bitmaps.get(objectId);
65 return sb != null ? sb.getBitmap() : null;
66 }
67
68 ObjectIdOwnerMap<StoredBitmap> getBitmaps() {
69 return bitmaps;
70 }
71
72 /**
73 * Data representation of the bitmap entry restored from a pack index. The
74 * commit of the bitmap is the map key.
75 */
76 static final class StoredBitmap extends ObjectIdOwnerMap.Entry {
77 private volatile Object bitmapContainer;
78 private final int flags;
79
80 StoredBitmap(AnyObjectId objectId, EWAHCompressedBitmap bitmap,
81 StoredBitmap xorBitmap, int flags) {
82 super(objectId);
83 this.bitmapContainer = xorBitmap == null
84 ? bitmap
85 : new XorCompressedBitmap(bitmap, xorBitmap);
86 this.flags = flags;
87 }
88
89 /**
90 * Computes and returns the full bitmap.
91 *
92 * @return the full bitmap
93 */
94 EWAHCompressedBitmap getBitmap() {
95 // Fast path to immediately return the expanded result.
96 Object r = bitmapContainer;
97 if (r instanceof EWAHCompressedBitmap)
98 return (EWAHCompressedBitmap) r;
99
100 // Expand the bitmap and cache the result.
101 XorCompressedBitmap xb = (XorCompressedBitmap) r;
102 EWAHCompressedBitmap out = xb.bitmap;
103 for (;;) {
104 r = xb.xorBitmap.bitmapContainer;
105 if (r instanceof EWAHCompressedBitmap) {
106 out = out.xor((EWAHCompressedBitmap) r);
107 out.trim();
108 bitmapContainer = out;
109 return out;
110 }
111 xb = (XorCompressedBitmap) r;
112 out = out.xor(xb.bitmap);
113 }
114 }
115
116 /** @return the flags associated with the bitmap */
117 int getFlags() {
118 return flags;
119 }
120 }
121
122 private static final class XorCompressedBitmap {
123 final EWAHCompressedBitmap bitmap;
124 final StoredBitmap xorBitmap;
125
126 XorCompressedBitmap(EWAHCompressedBitmap b, StoredBitmap xb) {
127 bitmap = b;
128 xorBitmap = xb;
129 }
130 }
131 }